Configuration#

Administration.Configuration

The Configuration provides a central hierarchical application registry that is used to provide application wide settings. Each configuration entry consists of:

• A unique path
• A data type
• A value

The set of entries can be extended, but there is a set of standard system configuration entries which need to be defined for the application to work properly.

The description of these system entries can be found in the System Configuration Entries of the Operations Guide.

Browsing Configuration Entries#

To browse the configuration entries, a navigation panel is available on the left side of the page that allows you to browse through the configuration tree, as can be seen in the example below:

Selecting All Entries will display all the entries regardless of where they are located within the configuration tree.

There is also a filter on the right side panel, above the list of entries, that allows you to display only System configuration entries or include custom User entries as well. Furthermore, the list can be sorted and filtered using a dropdown selection with all the possible configuration entry types where you can specify the Type to filter. Alternatively, for pure text search there is a textbox that can be used for Name filtering.

Selecting an entry will display information about that particular entry at the top of the right side panel.

Creating New Configuration Entries#

Configuration.Edit

To create a new configuration entry:

1. Navigate to the node in the configuration tree where the new entry should be placed.
2. Select the Create button on the ribbon.

3. In the wizard that shows up on screen, select:

   • Name
   • Type
   • Value
   • Confidential - if enabled, this configuration will only be available for Administrators.

4. Select Create and the new entry will be created.

Editing Configuration Entries#

Configuration.Edit

To edit an existing configuration entry:

1. Navigate to the node in the configuration tree where the entry is located or select All Entries in the left navigation panel and select the desired configuration entry in the right panel.
2. Select the Edit button on the ribbon.
3. Change the type and/or value as needed.
4. Select Save and the entry will be updated.

Removing Configuration Entries#

Configuration.Edit

To remove an existing configuration entry:

1. Navigate to the node in the configuration tree where the entry is located or select All Entries in the left navigation panel and select the desired configuration entry in the right panel.
2. Select the Remove button on the ribbon.
3. Select Remove in the wizard and the entry will be removed.