Guide

The appconfig service allows the management of Platform 6 application configuration.

Configurations can be packaged into applications and it is recommended to mark them as readonly. Therefore the only way to define a custom value is by overriding the default value. Overrides will persist even when application are uninstalled.

To see the Configuration menu entry on the Portal, the appconfig=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 appconfig=* permission, you can have access to all the functions mentioned below.

Tip

Since 6.10.14 The computed value is displayed and is computed according that order:

the environment value for the current environment from the override
the default environment value from the override
the environment value for the current environment
the default value

List and view configurations¶

To list and display all configurations, the appconfig=read permission is required.

List application configurations

Edit a configuration¶

To create, update, rename or duplicate an configuration, the appconfig=edit permission is required.

A user should not be able to edit or delete a bundled configuration. For that reason, we recommend not to set the content mode to EDIT when selecting for inclusion in an application.

A user, according to his permission, can create configurations that are not bundled.

Double-click on a row or click on the pen icon to edit an configuration under development.

Edit application configuration

Warning

The configuration’s name and the English description are mandatory and cannot be empty.

Environment values¶

New Feature

Since 6.10.14

Definition: Environment

An environment is used to define the level of maturity of an instance. Usually STAGING → PROD. An extra level can be added for development environments DEV → STAGING → PROD. When defined (or override if needed) it will be available on the application config screens.

You can define environment values in advance. They are part of the service item and will be used to compute the value.

Note

The list of environments is defined in the p6.environment.list (default to list: STAGING and PROD) and can be customized. To perform the promotion, the destination environment (p6.environment.name - default to 'PROD) must be part of the list

Override a configuration¶

You can override the value of a bundled configuration by clicking the update action button in the value column. This value will override the default one from the application. Also, this value will persist in database even if the application is uninstalled.

Configurations that are not bundled cannot be overriden and have to be edited to be updated.

Override application configuration

Note

You can define an empty value for a configuration entry. But if you want to delete an override, click the delete button.

Environment values¶

New Feature

Since 6.10.14

You can define environment values overrides. The same way as before, you can define an empty value for a configuration entry.

Note

The list of environments is defined in the p6.environment.list.

Import and install a configuration¶

The appconfig=edit permission is required to import, install or uninstall a configuration.

Schema validation¶

New feature

Since 6.10.15

In addition to Json Object type you can define a Json Schema for your configuration.

Json Schema application configuration

A schema is a powerful way to define the structure of your configuration and to validate the content. This way, users won’t be able to save or promote a configuration that doesn’t match the schema.

When a schema is defined, the content is validated against it when editing or overriding a configuration.

Schema must follow the JSON Schema specification (draft-07 or later) and the allowed types are listed here: https://ajv.js.org/packages/ajv-formats.html