Configuration from Low-code

The configuration definition is available in the Application Eximee Designer.

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

By going to the application's window in the left panel there is a tab available Configuration, and on the right the window Configuration Editor:

Illustration 1. Configuration from Eximee Designer - configuration tab

Configuration format

Configurations are defined in the format: key = value

Setting the environment

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

Such a setting will by default 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 with a suffix matching the current environment, values without a suffix are used.

Comments

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

Definition of roles authorized to edit in Eximee Dashboard

You should remember that besides specifying roles in Eximee Designer that authorize editing a specific configuration in Eximee Dashboard, the Eximee Dashboard user must be assigned a role that has the permission feature_config_edit, which gives access to the "Application Configuration" tab.

Along with the configuration in Eximee Designer you can define roles that will allow editing the runtime in Eximee Dashboard. If no roles are defined in the Eximee Designer application configuration, 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 parameter AUTH_ROLE_STRIP_PREFIX defined then the given role prefix should be omitted in the list elements. 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 specify "config-editor-role".

Modifying configuration in Eximee Dashboard: Modification (runtime) of business configurations

Illustration 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

The config server will return 4 configurations for such settings (without suffix):

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

Editing configuration

Editing the configuration locks the application's artifact, and for this reason you cannot add new artifacts to it, e.g.: a process, a form. However, an attempt to add such an artifact will create it in the repository, but it will not be attached to the application's artifact.

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

Illustration 3. Error when saving invalid application configuration

The user will remain in edit mode and will be able to correct 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 API for fetching configurations: Api:

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

example script using the Api:

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

*The Api also works for script calls in the data model.

The editor also offers suggestions:

Illustration 4. Example of suggestions while typing code

Using configuration values in a script task

Sample script task:

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

usage in a process:

Illustration 5. Example of using configuration values in a process

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

Business configuration in Eximee: Business Application Configuration