Skip to main content
Version: 5.2.0.0

Customer-Specific Configuration for Orchestra

When Orchestra is delivered to a customer, the system settings are initialized with default values defined by the environment variables. In certain situations, it may be necessary to apply customer-specific default settings to every newly installed Orchestra instance. To minimize manual configuration efforts, customer-specific settings can be defined as XML files that override the default settings. Orchestra supports autoconfiguration of the security and environment settings.

During the startup of Orchestra, the system scans for configuration files in a folder defined in the environment_settings.xml file. The relevant parameter is:

<parameter name="external.config.dir" value="{basepath}/installation" />

By default, the configuration folder named "installation" is located in the base directory of Orchestra. If necessary, this folder can be changed to a user-specific directory on the Orchestra machine.

All security-related settings can be defined in files that follow the naming pattern <filename>_security.xml. The content of the file can be illustrated with the following example:

<securitySetup>

<lockUser userName="UserToLock"/>

<deleteUser userName="UserToDelete"/>

</securitySetup>
  • The lockUser element specifies that the runtime user with the specified name must be locked.
  • The deleteUser element specifies that the runtime user with the specified name must be removed from the Orchestra user list.

All environment-specific settings can be defined in files that follow one of the following patterns:

  • <filename>_environment.xml
  • <filename>_environment_<databasename>.xml
    (<databasename> is the lowercase name of the Orchestra runtime database)

Use the first file pattern if you wish to specify general settings that are independent of the runtime database type. The second file pattern should be used for database-specific settings.

The content of the file can be illustrated with the following example:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<environmentSettingGroups>

<group name="Housekeeping">

<setting name="ProcessCleanup.SUCCESS.limit" value="2499"/>

</group>

</environmentSettingGroups>

Note: You can generate the file by downloading the environment parameters from the Orchestra monitor.