Configuration from the Low-code level

The configuration definition is available in the module Application Eximee Designer.

Applications that use the configuration server to fetch configuration must have configured Data model and a start point set.

When going to the window of a given application, the left panel contains the tab Configuration, and on the right the window Configuration Editor:

Figure 1. Configuration from Eximee Designer - Configuration tab

Configuration format

Configurations are defined in the format: key = value

Environment determination

Additionally, it is possible to specify the environment for which a given setting will be available by adding a suffix to the key |${environment_key} e.g.

application.login|prod=keyValue

By default, such a setting will be available only for the environment marked as "prod".

We can specify the environment using an ENV - CONFIG_SERVER_ENVIRONMENT_NAME in the configuration server application.

If there is no key suffix with the current environment, the values without a specified suffix are used.

Comments

In the configuration editing window, it is possible to add comments in the configuration content. Comments should start with a new line, and the comment content should be preceded by the symbol hash (#).

Definition of roles authorized to edit in Eximee Dashboard

Please note that in addition to defining roles in Eximee Designer authorized to edit a specific configuration in Eximee Dashoard, the Eximee Dashboard user must be assigned a role with the permission feature_config_edit, which grants access to the "Application Configuration" tab.

Along with the configuration in Eximee Designer, you can define roles that will allow editing of the runtime configuration in Eximee Dashboard. If no roles are defined in the application configuration in Eximee Designer, editing the application configuration from Eximee Dashboard will not be available to any user.

Role definitions can be specified in the "Roles authorized to edit in Eximee Dashboard" field above the configuration editor in Eximee Designer.

If the configuration server application has the AUTH_ROLE_STRIP_PREFIX parameter defined, then the given role prefix should be omitted in list items. So if AUTH_ROLE_STRIP_PREFIX = "PDC000000001-" and the role is named "PDC000000001-config-editor-role", then in the list in Eximee Designer you should indicate "config-editor-role".

Configuration modification in Eximee Dashboard: Modification of business configurations (runtime)

Figure 2. Configuration from Eximee Dashboard - "Application Configuration" tab

Configuration example

CONFIG_SERVER_ENVIRONMENT_NAME = dev

Configuration content:

#url links to test environment
test.url|dev=urlDev
test.url=urlDefault
 
test.password=passwordBasic
test.password|prod=passwordProd
test.password|dev=passwordDev
 
 
test.login|prod=loginProd
test.login=loginDefault
 
 
test.enabled=true

For such settings, the config server will return 4 configurations (without suffix):

test.url=urlDev
 
test.password=passwordDev
 
test.login=loginDefault
 
test.enabled=true

Editing configuration

Editing configuration blocks the application artifact, therefore new artifacts cannot be added to it, e.g.: a process, a form. However, attempting to add such an artifact will create it in the repository, but it will not be attached to the application artifact.

In the case of syntax errors in the configuration (e.g.: for a configuration of type PROPERTIES an invalid unicode was provided), an error will occur when saving the configuration, which will have the general form of errors occurring when saving an artifact:

Figure 3. Error when saving an invalid application configuration

The user will remain in edit mode and will be able to fix any syntax errors and try saving the configuration again.

Using configuration values in ScriptCode

In ScriptCode, we can retrieve a value from the configuration using the configuration retrieval api: Api:

interface Api {
    config: {
        v1: {
          get(key: string): string;
          getOrDefault(key: string, defaultValue: string): string;
        }
    }
}

sample script using the Api:

function callService(context) {
    let value1
    try {
        value1 = api.config.v1.get("dummy.url2");
    } catch(e) {
        value1 = "default"
    }
 
    const value2 = api.config.v1.getOrDefault("not_existing_key", "defaultValue")
  
    return [{'value1': value1, 'value2': value2}];
}

Api also works for script calls in the data model.

The editor also offers suggestions:

Figure 4. Example of a suggestion while typing code

Using configuration values in a script task

Example script task:

function handle(task, context) {
    // Retrieve variables from the configuration
    const skipTask = api.config.v1.get("script.task.skip.task")
    const titleName = api.config.v1.getOrDefault("script.task.title.name", "Default title")
     
    // Finish the task and pass variables (skipTask, titleName) to the process
    context.complete({'skipTask': skipTask, 'titleName': titleName});
}

use in the process:

Figure 5. Example of using configuration values in a process

As a result, the configuration values will be passed to the process and saved under the keys: skipTask and titleName.

Business configuration in Eximee: Business Application Configuration