List of settings for fields

This page describes all settings for fields grouped by area of usage:

Case list

Grouping criterion for case list

• Annotation name: groupable
• Name: Grouping criterion for case list
• Description: Enables grouping of the case list and detail search results in grid view by this data field of the type enum. See Settings for the case list.
• Area: Case list
• Values:

  • true: The data field is available as grouping criterion.

  • false: Removes the setting to disable grouping by this field.

• Available for: Cases

Height in case list

• Annotation name: ticket-list-rowspan
• Name: Height in case list
• Description: Defines how many rows are occupied by the field in the case list entries.
• Area: Case list
• Values:
  • <number>: Number of rows
• Available for: Cases

This annotation only works if the annotation ticket-list-position is also set for the field.

Position in the case list

• Annotation name: ticket-list-position
• Name: Position in the case list
• Description: Defines the position of the field in the case list entries.
• Area: Case list
• Values:
  • <row>;<column>: Values define the row and column, the numbering starts at 0;0.
• Available for: Cases

Sorting criterion for case list

• Annotation name: sortable
• Name: Sorting criterion for case list
• Description: Enables sorting of the case list by this data field of the type enum or date. See Settings for the case list.
• Area: Case list
• Values:

  • true: The data field is available as sorting criterion for the case list.

  • false: Removes the setting to disable sorting by this field.

• Available for: Cases

Width in case list

• Annotation name: ticket-list-colspan
• Name: Width in case list
• Description: Defines how many columns are occupied by the field in the case list entries.
• Area: Case list
• Values:
  • <number>: Number of columns
• Available for: Cases

This annotation only works if the annotation ticket-list-position is also set for the field.

CM/Phone

Phone number

• Annotation name: dialable
• Name: Phone number
• Description: Defines a data field of the type string which contains a phone number. The number can be clicked to initiate an outgoing phone call using CM/Phone.
• Area: CM/Phone
• Values:
  • true: Phone number is dialable.
  • false: Phone number is displayed as regular text.

CM/Track

Availability via REST

• Annotation name: customer exposure
• Name: Availability via REST
• Description: Indicates whether a data field should be available to customers using the REST API, e.g. in CM/Track.
• Area: CM/Track
• Values:
  • Full access (full): The data field is available for reading and writing.
  • Read-only access (read): The data field is available for reading only.
  • No access (none): The data field is not available (default).

• Available for: Cases

• Since: 6.10.5.4

LDAP ID for CM/Track

• Annotation name: ldapid
• Name: LDAP ID for CM/Track
• Description: Indicates that the value of the data field of the type string in the contact object will be used as an LDAP ID for authentication in CM/Track.
• Area: CM/Track
• Values:
  • true: The data field contains the LDAP ID.
  • false: The data field does not contain the LDAP ID.
• Available for: Contacts
• Since: 6.9.3.0

Password for CM/Track

• Annotation name: password

• Name: Password for CM/Track

• Description: Indicates that the value of the data field of the type string in the contact object will be used as a password for authentication in CM/Track.

  After removing this setting or setting it to “false”, the users cannot log in to CM/Track anymore.

• Area: CM/Track

• Values:

  • true: The data field contains the password.

  • false: The data field does not contain the password.

• Available for: Contacts

• Since: 6.3.0

User name for CM/Track

• Annotation name: username

• Name: User name for CM/Track

• Description: Indicates that the value of the data field of the type string in the contact object will be used as a user name for authentication in CM/Track.

  After removing this setting or setting it to “false”, the users cannot log in to CM/Track anymore.

• Area: CM/Track

• Values:

  • true: The data field contains the user name.

  • false: The data field does not contain the user name.

• Available for: Contacts

• Since: 6.3.0

Display

Boolean display

• Annotation name: boolean-type
• Name: Boolean display
• Description: Determines how to display data fields of the type boolean.
• Area: Display
• Values:

  • Checkboxes (checkbox): Field that can be checked (true) or unchecked (false)

  • Radio buttons (radio): Two radio buttons, where only one can be active

  • List (select): A drop-down field with the values Yes and No

Date accuracy

• Annotation name: accuracy
• Name: Date accuracy
• Description: Determines which information is displayed for data fields of the type date.
• Area: Display
• Values:

  • Date and time (date-time): Show date with time.

  • Only date (date): Show date without time (default).

  • Only time (only-time): Show only time, no date.

• Since: 6.1.3

Date format

• Annotation name: format
• Name: Date format
• Description: Determines the format for validating data fields of the type date. If the format includes hours and minutes, you might need to increase the field width using the colspan annotation.
• Area: Display
• Values:
  • <date format>: Pattern for the date based on SimpleDateFormat, e.g. dd.MM.yyyy
    

• Since: 6.2.5

This annotation is applied to date fields both in the Web Client and in CM/Track. If it is not set, the standard date format of the browser locale is used in the Web Client, and the German standard date format (dd.MM.yyyy) is used in CM/Track.

Display trailing zeros

• Annotation name: leave-trailing-zeros
• Name: Display trailing zeros
• Description: Determines if trailing zeros in the fractional part of data fields of the type fixed-point number are displayed.
• Area: Display
• Values:
  • true: Trailing zeros are displayed.
  • false: Trailing zeros are cut off.
• Since: 6.4.0

Enum display

• Annotation name: enum-type
• Name: Enum display
• Description: Determines how to display data fields of the type Enum.
• Area: Display
• Values:

  • List (select): Drop-down list

  • Autocomplete list (autocomplete): Drop-down list with an input field used to filter the list

  • Radio buttons (radio): Set of radio buttons where only one option can be active

List modification options

• Annotation name: list-type
• Name: List modification options
• Description: Determines whether the options to add or delete rows are available for data fields of types list or struct.
• Area: Display
• Values:

  • Rows can be added (non-shrinkable): It is not possible to delete rows.

  • Rows can be deleted (non-growable): It is not possible to add rows.

  • Rows cannot be modified (fixed-size): It is not possible to add or delete rows.

• Since: 6.6.0

Rich text display in view mode

• Annotation name: string-content-type
• Name: Rich text display in view mode
• Description: Configures a data field of the type long string as a rich text field. In the edit mode the field is displayed with an editor. In the view mode, the display depends on the annotation value.
• Area: Display
• Values:

  • Inline (html-inline): The content of the rich text field is displayed directly on the GUI.

  • Link (html-link): The content of the rich text field is displayed in a pop-up window which the user can access by clicking the Show content link.

• Since: 6.11.2.2

Text display

• Annotation name: text-type
• Name: Text display
• Description: Defines the purpose and display of data fields of the type string.
• Area: Display
• Values:
  • Text (text): Single-line input field (default)
  • Textarea (textarea): Multi-line input field
  • Password (password): Input field for passwords. Passwords are displayed as asterisks.
  • Label (label): Label without input field.
  • Title (title): Label styled as a headline without input field.
  • Autocomplete (autocomplete): Autocomplete list (deprecated, see Scripts of the type Text autocomplete).
  • URL (url): The input is displayed as a hyperlink in view mode. If no protocol is provided, http:// is added automatically in front of the entered string. If a protocol, e.g. http, https, mailto, file, or ftp is used, the URL is rendered as is. The display text for the URL can be entered after a whitespace, e.g. http://consol.de ConSol
  • File URL (file-url): The input is displayed as a link to a file on the file system. The link is also displayed as tooltip.

    The URL must start with file: followed by regular slashes:

    • three slashes “///” for files on the same computer as the browser (alternatively “//localhost/”) or
    • two slashes followed by the server name followed by another slash for files on file servers accessible from the computer running the browser.

    These are followed by the full path to the file ending with the file name. The path on Microsoft Windows systems is also written with forward slashes instead of backslashes.

    The drive letter of a local path on Microsoft Windows systems is noted as usual, for example C:. Paths with spaces and special characters like “{, }, ^, #, ?” need to be percent encoded, e.g. “%20” for a space for Microsoft Windows systems.

    Example URLs:

    • file://file-server/path/to/my/file.ext
    • file:///linux/local/file.pdf
    • file:///C:/Users/myuser/localfile.doc

    The web browser has to support and allow such links.

DWH

Field value omitted from DWH history

• Annotation name: dwh-no-history-field
• Name: Field value omitted from DWH history
• Description: Defines whether the field will not be historicized in the data warehouse.
• Area: DWH
• Values:
  • true: The field will not be historicized.
  • false: The field will be historicized.
• Since: 6.10.2.0

Transfer to DWH

• Annotation name: reportable
• Name: Transfer to DWH
• Description: Determines if the data field is transferred to the data warehouse.
• Area: DWH
• Values:
  • true: The field is transferred to the data warehouse.
  • false: The field is not transferred to the data warehouse.
  • stopped: The field is not transferred to the data warehouse anymore, but it is not deleted from the data warehouse neither.

• Since: 6.1.3

Features

Allow absolute position

• Annotation name: visualize-allow-absolute-position
• Name: Allow absolute position
• Description: Used to indicate whether the field visualization content can be displayed outside the data field grid. Only relevant if the setting Field visualization script is set and the field visualization script displays content with position: absolute.
• Area: Features
• Values:
  • true: The field visualization can be positioned outside the grid which contains the case, contact or resource fields. The field label is always hidden.
  • false: The position of the field visualization is always relative to the grid. It depends on the value of Show label in view mode if the field label is displayed.

• Since: 6.13.0.5

Autocomplete script

• Annotation name: autocomplete-script
• Name: Autocomplete script
• Description: Specifies the script (type Text autocomplete) used for the scripted autocomplete field (annotated with text-type = autocomplete).
• Area: Features
• Values: <name of the script>
• Since: 6.10.5.3, deprecated in 6.11.1.1

This way of configuring autocomplete fields is deprecated. See Scripts of the type Text autocomplete) for the new configuration.

Color of resource icon

• Annotation name: resource-color
• Name: Color of resource icon
• Description: Defines the background color for the resource icon. Can be assigned to a data field of the type enum, which must have colors set for its list values.
• Area: Features
• Values:
  • true: The color of the selected list value in the field is used for the resource icon.
  • false: The field is not relevant for the color of the resource icon.
• Available for: Resources
• Since: 6.10.4.0

Color of the case icon

• Annotation name: enum field with ticket color
• Name: Color of the case icon
• Description: Defines the background color for the case icon. Can be assigned to a data field of the type enum, which must have colors set for its list values.
• Area: Features
• Values:

  • true: The color of the selected list value in the field is used for the case icon.

  • false: Removes the setting to disable the use of the color for the case icon.

• Available for: Cases

Contains contacts

• Annotation name: contains contacts

• Name: Contains contacts

• Description: Indicates that a data field of the type list holds references to units annotated as contacts. Starting with ConSol CM version 6.11, the field will not produce history entries. This decreases the loading time for cases which contain a great number of contacts.

  Only one instance of this annotation is allowed in one data model.

• Area: Features

• Values:

  • true: The list is shown with the contact.

  • false: The list is shown with the case.

Field visualization script

• Annotation name: visualization
• Name: Field visualization script
• Description: Specifies the script (type Field visualization) used to render the content of the data field, see Scripts of the type Field visualization.
• Area: Features
• Values: <name of the script>

• Since: 6.11.0.6

Personal data

• Annotation name: personal-data
• Name: Personal data
• Description: Determines if the field holds personal data. Contact fields with this annotation will be deleted when the contact is anonymized. Case fields with this annotation will be deleted when the main contact of the case is anonymized.
• Area: Features
• Values:
  • true: The field contains personal data.
  • false: The field does not contain personal data.
• Available for: Cases, contacts
• Since: 6.11.1.7

Read-only

• Annotation name: readonly
• Name: Read-only
• Description: Determines if the value of a field is rendered in read-only mode, so it cannot be modified by the users.
• Area: Features
• Values:

  • Always (all): The field is always read-only.

  • On create or edit (edit): The field is read-only when creating or editing a case, contact or resource. It can be edited in forms.

  • In forms (form): The field is read-only in forms. It can be edited when creating or editing a case, contact or resource.

  • No (unset): The field is always editable (default).

• Since: 6.1.3

Render field visualization for empty field

• Annotation name: visualize-when-empty
• Name: Render field visualization for empty field
• Description: Determines if the visualization script of a data field with the setting Field visualization script should be executed even if the field is empty.
• Area: Features
• Values:
  • true: The field visualization script is executed even if the field is empty.
  • false: The field visualization script is only executed if the field has a value (default behavior).

• Since: 6.11.1.6

This annotation is applied for scripted field visualizations both in the Web Client and CM/Track.

History

Field value omitted from history

• Annotation name: no-history-field
• Name: Field value omitted from history
• Description: Indicates that the data field will not be historicized. Overwrites the group annotation no-history.
• Area: History
• Values:
  • true: The data field will not be historicized.
  • false: The data field will be historicized.
• Since: 6.6.0

You can use the annotation visibility configuration, if you need the history of the field but do not want to display it in the case history.

Visibility in case history

• Annotation name: visibility configuration
• Name: Visibility in case history
• Description: Defines the visibility of this field in the case history.
• Area: History
• Values:

  • On every level (on every level): Field is shown on every level.

  • On second and third level (2nd level and 3rd level): Field is shown only on the Extended and Detail level.

  • On third level (only 3rd level): Field is shown only on the Detail level.

• Available for: Cases
• Since: 6.3.0

Layout

Field size

• Annotation name: fieldsize
• Name: Field size
• Description: Displayed field size. For regular string fields and number fields, this is the number of characters. For enum fields without autocomplete feature, this is the number of values visible in the drop-down. For text areas (string fields with text-type = textarea) and rich text fields (string fields with string-content-type = html-inline), this is the height and width.
• Area: Layout
• Values:

  • <rows>;<columns>: Displayed field size for text areas and rich text fields
    

  • <number>: Displayed field size for strings, numbers and enums

This is only a layout configuration, use maxlength for validation.

Grouped under label

• Annotation name: label-group

• Name: Grouped under label

• Description: Allows to group fields under a label in the view mode. The annotation is ignored in the edit mode. Both the label and the fields must have the annotation label-group with the same value assigned. The label must be a data field of the type string annotated as text-type = label. The label is only shown if at least one data field from the group has a value set.

  The grouping only affects the label. The fields must be positioned next to each other to be displayed together.

• Area: Layout

• Values:

  • <string>: Reference to the group

Height

• Annotation name: rowspan
• Name: Height
• Description: Defines how many rows are occupied by the field.
• Area: Layout
• Values:
  • <number>: Number of rows.

This annotation only works if the annotation position is also set for the field.

This annotation does not work from version 6.13.0.0 to 6.14.0.0.

Position

• Annotation name: position
• Name: Position
• Description: Defines the position of a field within the grid layout or defines the position of a field within a table. The first position is 0;0. If not set, the fields take the next free position according to their order within the field group.
• Area: Layout
• Values:
  • <row>;<column>: Row and column in the grid where a regular data field is displayed.
  • 0;<column>: Table column in the table where a data field belonging to a struct is displayed.

Show label in edit mode

• Annotation name: show-label-in-edit
• Name: Show label in edit mode
• Description: Determines whether the data field should have a label in the edit mode.
• Area: Layout
• Values:
  • true: The data field is displayed with label (default).
  • false: The data field is displayed without label.

• Since: 6.9.4

Show label in view mode

• Annotation name: show-label-in-view
• Name: Show label in view mode
• Description: Determines whether the data field should have a label in the view mode.
• Area: Layout
• Values:
  • true: The data field is displayed with label (default).
  • false: The data field is displayed without label.

• Since: 6.9.4

Show tooltip

• Annotation name: show-tooltip
• Name: Show tooltip
• Description: Determines whether the data field should be displayed with tooltip.
• Area: Layout
• Values:
  • true: The data field is displayed with tooltip.
  • false: The data fields is displayed without tooltip (default).
• Since: 6.9.4

Show watermark

• Annotation name: show-watermark
• Name: Show watermark
• Description: Determines whether the data field should be displayed with watermark.
• Area: Layout
• Values:
  • true: The data fields is displayed with watermark.
  • false: The data fields is displayed without watermark (default).
• Since: 6.9.4

Visibility

• Annotation name: visibility
• Name: Visibility
• Description: Defines when the field is visible.
• Area: Layout
• Values:

  • Always: The field is always displayed.

  • On view (view): The field is displayed in the view mode.

  • On edit (edit): The field is displayed in the edit mode.

  • Never (none): The field is never displayed.

• Since: 6.4.0

Width

• Annotation name: colspan
• Name: Width
• Description: Defines how many columns are occupied by the field.
• Area: Layout
• Values:
  • <number>: Number of columns.

This annotation only works if the annotation position is also set for the field.

Search

Column position in detail search results

• Annotation name: order-in-result

• Name: Column position in detail search results

• Description: Determines whether a field is displayed as a column in the result table of a detail search. If an integer number is provided, the column is sorted accordingly. Use the value 0 to fully hide a field from the result table.

  If a user reconfigures the result table, the user’s configuration overrides this setting.

• Area: Search

• Values:

  • <number>: Position of the column.

Indexed for search

• Annotation name: field indexed
• Name: Indexed for search
• Description: Indicates that a database index will be created for this field. This is needed if the field should be used to search for entities or to sort entries in a table.
• Area: Search
• Values:
  • True (locale): An index is created for the field, so the case, contact or resource can be searched by this field. Only the case, contact or resource is found.
  • True (company + persons) (unit): Only for contacts. An index is created for the field, so the contact can be searched by this field. For persons, only the person itself is found. For companies, the persons of the company are found as well.

  • True (company + persons + cases) (transitive): Only for contacts. An index is created for the field, so the contact can be searched by this field. For persons, the cases of the person are also found. For companies, the cases of the company, the persons of the company and the cases of the persons of the company are found as well.

  • False: No index is created for the field, so it cannot be searched.

Multiselect in search enabled

• Annotation name: enum-in-search-type
• Name: Multiselect in search enabled
• Description: Defines whether several values can be selected when using an enum field as a search criterion.
• Area: Search
• Values:
  • false (single): Selecting multiple values for search is not possible (default).
  • true (multiple): Selecting multiple values for search is possible.

Phonetic search

• Annotation name: phonetic
• Name: Phonetic search
• Description: Determines if the phonetic search is possible for this field of the type string.
• Area: Search
• Values: 
  • true: Phonetic search is available.
  • false: Phonetic search is not available.

Validation

Contains email address

• Annotation name: email
• Name: Contains email address
• Description: Determines whether a data field of the type string should contain an email address. If assigned, the field value is validated for the correct format, i.e. <name>@<domain>.
• Area: Validation
• Values:

  • true: The field contains an email address.

  • false: Removes the setting to disable the validation.

Label for the validation message

• Annotation name: matches-validation-message-key
• Name: Label for the validation message
• Description: Determines the validation message which is displayed in the Web Client or CM/Track when the field content does not match the regular expression defined in the annotation matches. Enter the key of the validation message. For the Web Client, a label with the corresponding key must be created in the Labels section. For CM/Track, an attribute with the corresponding key must be created in the localization_de.json and localization_en.json files of the client configuration.
• Area: Validation
• Values:
  • <string>: Key of the validation message

Maximum length

• Annotation name: maxLength
• Name: Maximum length
• Description: Defines the maximum length of the input for data fields of the type string.
• Area: Validation
• Values:
  • <number>: Number of characters

Maximum value

• Annotation name: maxValue
• Name: Maximum value
• Description: Defines the maximum value of the input for data fields of the types number and fixed-point number.
• Area: Validation
• Values:
  • <number>: value

Minimum length

• Annotation name: minLength
• Name: Minimum length
• Description: Defines the minimum length of the input for data fields of the type string.
• Area: Validation
• Values:
  • <number>: Number of characters

Minimum value

• Annotation name: minValue
• Name: Minimum value
• Description: Defines the minimum value of the input for data fields of the types number and fixed-point number.
• Area: Validation
• Values:
  • <number>: value

Regex to validate the value

• Annotation name: matches
• Name: Regex to validate the value
• Description: Checks if the input of a string data field matches the given regular expression. The validation message, which is displayed if the field content does not match the value of this annotation, can be customized using the annotation matches-validation-message-key.
• Area: Validation
• Values:
  • <string>: Regular expression

Required

• Annotation name: required
• Name: Required
• Description: Determines whether the data field is required, i.e. whether the user must enter a value to save the object. Required fields are marked by a red asterisk in the Web Client and CM/Track.
• Area: Validation
• Values:
  • true: The field is required.
  • false: The field is not required (default).

Unique

• Annotation name: unique
• Name: Unique
• Description: Indicates that the value of the data field of the type Text, Text (short) or Text (long) must be unique in the selected scope. The scope can be either global, meaning all entities of the type, or the domain, meaning all entities of the queue, customer group or resource type.
• Area: Validation
• Values:

  • in all queues, in all customer groups, in all resource types: The value must be unique in all queues (for case fields), customer groups (for contact fields) or resource types (for resource fields)

  • in one queue, in one customer group, in one resource type: The value must be unique in one queue (for case fields), customer group (for contact fields) or resource type (for resource fields)