Client configurations

Introduction to client configurations in ConSol CM

Client configurations can be used to configure the user interface of CM/Track and customer-specific REST clients. This manual describes the configuration of CM/Track.

Client configurations consists of several files where settings for CM/Track are made. There are two versions of CM/Track with a different handling regarding the configuration. The following table describes the differences and where to find further information.

Question	CM/Track V2	CM/Track V3
Where do I edit the configuration?	The configuration is created and maintained on the Client configurations page.	The configuration is created and maintained on the Portal configurations page. It is shown on the on the Client configurations page for reference only.
Which files are available?	config.json localization.json public.json	components_localization.json config.json custom.css localization.json public.json theme.css
Does the configuration need to be complete?	No, the settings override the default configuration of CM/Track. It is sufficient to configure the deviations from the default configuration.	Yes, the configuration must contain all required settings. Otherwise, CM/Track might not work correctly.
How are updates handled?	When you update ConSol CM to a newer version, the files of existing configurations are left as is. This means that new configuration options and localizations are not added automatically. You need to add them manually based on the template files, which are always displayed in the latest version.	When you update ConSol CM to a newer version, the configuration is updated automatically. New options are added, and options which are not used anymore are removed. Existing configurations are left untouched if they differ from the default configuration, e.g. if you changed labels. If you want to take over changes to customized items, you can compare your configuration with the template files, which are always displayed in the latest version.
Where can I find details about configuring CM/Track?	See the manual for ConSol CM version 6.16.	See Portal configurations and Global portal settings.

Basic tasks

Working with client configurations

Each client configuration has its own tab. At the bottom of the page, you can find the actions which apply to the whole configuration. Each file within a configuration has its own editor. The actions below the editor refer to the respective file.

You can perform the following actions on client configurations:

• Create a new client configuration
  Click the New configuration button, enter a name for the configuration and select a template if you want to automatically create the required files.
• Edit a client configuration
  Click the Edit configuration button. You can modify the name of the configuration.
• Delete a client configuration
  Click the Delete configuration button. The configuration is deleted upon confirming the warning message.
• Add a file to a client configuration
  Click the Add file button. If you select a file from a template, the file name is populated automatically. Otherwise you have to enter a name for the file.
• Edit the name of a file
  Click the Edit icon next to the file name to modify the name of this file.
• Delete a file from a configuration
  Click the Delete file button below the editor of the file to remove this file from the configuration.
• Edit the content of a file
  You can edit the content of the file in the editor displayed below the file name. Click the Save changes button below the editor to save your changes. If you modify several files you can also use the Save all files button at the bottom of the page. Click the Discard changes button below the editor to revert your changes to the respective file. See Using the JSON editor features for details about the capabilities of the editor.

Advanced tasks

Using the JSON editor features

The JSON editor has the following features:

• Syntax highlighting
  The editor uses syntax highlighting for JSON.

• Keyboard shortcuts
  There are keyboard shortcuts for common operations. Examples:

  • Undo: CTRL + Z
  • Find: CTRL + F
  • Find next: CTRL + G
  • Replace: Shift + CTRL + F
  • Replace all: Shift + CTRL + R

• Text highlighting
  You can double-click a word or mark some text to highlight all its occurrences within the file.