Labels

Introduction to labels in ConSol CM

Labels are used to modify text displayed on the graphical user interface of the Web Client.

Concepts, terms and definitions

Concept	Other terms	Definition
label		Piece of text displayed in a specific location of the Web Client or in a certain situation.

Purpose and usage

Labels enable the administrator to modify text which is displayed on the graphical user interface of the Web Client. There are predefined labels which allow to change the wording used for important objects in ConSol CM, e.g. cases, contacts and resources. In addition, the administrator can create custom labels which can be referenced in scripts and used in different situations. The text of a label is defined for each configured language.

Available settings for labels

Default labels vs. custom labels

There are two kinds of labels: the labels which are predefined in ConSol CM and the labels which are defined by the administrator during the configuration of the ConSol CM system.

• System labels:
  Default labels are displayed in specific places of the Web Client. Every label has a default value. You can set your own value to modify the GUI text according to your needs. You can find the default values in System labels.

• Custom labels:
  Custom labels are created by the administrator for use in specific situations. The administrator can define additional labels during the configuration of the ConSol CM system. These labels provide a convenient way to store the text used for messages in several languages and reuse it in different places. Common use cases for custom labels are information and error messages, and text used in widgets or field visualizations.

Fields

The following fields are available for labels:

• Key:
  Mandatory. This is the identifier used to reference the label in source code. The key needs to be unique.

• System:
  Read-only. Determines if the label is a system label or a custom label. You cannot edit this setting. Labels which are created on setup or update of ConSol CM have this checkbox selected. The checkbox is disabled for all the labels which are created by the administrator.

• Value:
  The text of the label in the configured languages. The value for the default language is mandatory.

Basic tasks

Finding a label

The list of labels is displayed directly after accessing the Labels page of the Web Admin Suite. You can filter the list to locate a label more easily:

• Text search: Perform a free text search.

  Enter a text in the Search field to filter by key or localized value.

• Label type: Choose to display only predefined labels or custom-defined labels.

  Select System labels or Custom labels from the All labels drop-down list.

Managing labels

You can perform the following actions on labels:

• Create a new label
  Click the New label button above the list of labels and enter the required values.

  If the new label is similar to an existing label, you can prefill the Clone label screen with the data of an existing label by clicking the Duplicate icon in this label’s row.

• Edit a label
  Click the Edit icon in the label’s row and update the desired data in the edit panel on the right.

• Delete a label
  You can delete custom labels by clicking the Delete icon. To delete several labels at once, select them and click the Delete icon at the top of the table. System labels cannot be deleted and are ignored if you try to delete them together with custom labels.

Advanced tasks

Using labels in scripts

You can use labels to store texts which should be displayed on the user interface. Labels can be referenced in scripts and provide an easy way of localizing messages.

The following method retrieves the value of a label:

messageProviderService.getMessage("<key>", locale)

If you want to use labels for messages which are displayed after executing actions in the Web Client, you can use the client methods to show a message based on a label, see Displaying messages in the Web Client. The method automatically uses the value for the language in which the current user navigates.

client.showMessage("<key>")