Guide
The applications
service allows managing Platform 6 applications:
- packaging apps
- installing packaged apps
- uninstalling packaged apps
To see the Applications menu entry on the Portal, the applications=view
permission is required.
For a summary of permission names and uses related to this service, please refer to this section.
Note
If you have the applications=*
permission, you can have access to all the functions mentioned below.
List and view applications¶
To list and display all applications, the applications=read
permission is required.
Edit an application¶
To create, update, rename or duplicate an application (in the ‘Application under development’ section), the applications=edit
permission is required.
Double-click on a row of the table display of the ‘Applications under development’ section or click on the pen icon to edit an application under development.
Warning
The application’s name and the English description are mandatory and cannot be empty.
Package an application¶
Once you have entered or updated all the app header fields (Name, Version, Status,…) and selected all the service items you want to include in your app, you can save it.
And once saved, you can package it easily - just hit the blue button in the ‘Actions’ column.
Please read the Package a P6 App section for additional information.
Import and install an application¶
The applications=edit
permission is required to import, install or uninstall an application.
Note
Since 6.10.7 A new configuration p6.service.application.verified-only
(default to false
) restricts the applications than can be imported.
If that configuration entry is set to true
then only the verified applications will be allowed.
Since 6.10.8 A new configuration p6.service.application.repository.enabled
(default to false
) indicates if the repository store is enable.
If that configuration entry is set to true
then importing from the repository will be available from the Import drop down menu.
Configuration verification¶
Since 6.10.14
When installing an application, JsonObject
configurations overrides are verified against the according schema.
Tip
If the schema is not defined, the configuration is considered valid.
If the validation fails, an error message is displayed and the installation is canceled. You will need to fix the configuration before being able to install the application. To do so, click on the Configuration gear icon in the Actions column of the application row, select the configurations to remove and click on the Delete button.
When done, you can try to install the application again.
Automatic process¶
When installing an application, the indexes creation job for the View
and TableData
items will be launched automatically.
When uninstalling an application, those indexes will be dropped automatically.
Please read the View and View Index
sections.
Application configuration¶
Since 6.10.14
Imported applications¶
When an application is imported, you have access to the gear icon in the Actions column. When clicked on, it will open the application configuration overrides page.
The application configuration overrides can be removed from this screen using the delete button.
Note
Only the overrides are displayed, not the computed values.
Installed applications¶
When an application is installed, you have access to the gear icon in the Actions column. When clicked on, it will open the application configuration page.
The application configurations are paginated and can be filtered.
Note
The displayed value corresponds to the computed value of the configuration.
Export¶
You can export the application configuration by clicking on the Export button. This will download a JSON file containing the configuration data.
Inside are stored:
- the source instance
- the source environment
- the source application
- the configuration overrides
- the checksum of the file
Warning
This file contains a checksum to prevent any alteration of the file.
Import¶
Once you’ve exported the configuration, you can import it back by clicking on the Import button.
The import will ask you to select the file to import and display a summary of the configuration to be imported.