Preferences

Configuration entries of type Preference are not triggered by users or rules, but simply provide configuration data to system components. 

Introduction

Some server modules that possess configuration files of types ServerAction and AutoExecute, have additional configuration files of type Preference, usually because the configuration parameters are very extensive or dynamic.

Overview - UI preferences

1. Standard header of all configuration entries with the internal name of the module, a description and a comment field, that can be used to keep track of the changes.

2. Preferences contain a general setup section to define the rules and restriction of the manual triggering preconditions. The options are:

   • Server name: if empty, the configuration is made available to all ApplicationServers, otherwise it can be restricted to a specific server.

   • Enabled: this flag toggles the overall availability of the configuration.

   • Version: this is a unique version number of the module. It is copied into the customized version, to ease the process of reviewing customization files after a system upgrade.

   • Permissions only for defined roles: restricts this configuration to users belonging to the selected roles. If empty, it applies to all roles.

   • Permissions only for defined client types: restricts this configuration to the selected censhare clients. If empty, it applies to all clients.

   • Permissions only for defined permission keys: restricts this configuration to those users, that contain the permission key in their privilege settings. The permission key can be any of the default keys or a custom key.

   • Shortcut: Preferences that configure a feature that is built into the clients might be bound to keyboard shortcuts. Refer to the tooltip of this option for details.

   All restrictions are summed up: a user is only affected by the configuration if he is fullfilling all criteria!

3. The final section in each configuration dialog finally contains the individual parameters for the functional configuration of that specific module.

Overview - XML configuration

1. Standard header of all configuration entries with the internal name of the module, a description and a comment field, that can be used to keep track of the changes.

2. Preferences contain a general setup section to define the rules and restriction of the manual triggering preconditions. The options are:

   • Server name: if empty, the configuration is made available to all ApplicationServers, otherwise it can be restricted to a specific server.

   • Enabled: this flag toggles the overall availability of the configuration.

   • Version: this is a unique version number of the module. It is copied into the customized version, to ease the process of reviewing customization files after a system upgrade.

   • Permissions only for defined roles: restricts this configuration to users belonging to the selected roles. If empty, it applies to all roles.

   All restrictions are summed up: a user is only affected by the configuration if he is fullfilling all criteria!

3. The Edit XML-File button opens a comfortable XML editor (with line-numbering, syntax-coloring, search and export features), that gives access to the raw text of the configuration file.