List of Field Annotations

This chapter describes the following field annotations grouped by annotation type:

anonymize (type)

personal-data

• Type: anonymize
• Description: Can be assigned to ticket and contact fields. Determines that the field holds personal data. Contact fields with this annotation will be deleted when the contact is anonymized. Ticket fields with this annotation will be deleted when the main customer of the ticket is anonymized. See Example 8: Removing Customer Data for information about how to anonymize a contact.
• Values:
  • true / false: Set true if the field contains personal data.

cmweb-common (type)

groupable

• Type: cmweb-common
• Description: Enables grouping of the ticket list by this field. Please see section Grouping for a detailed explanation.
• Values:
  • true: Used only with enum data fields. Remove the annotation if you want to disable grouping.

sortable

• Type: cmweb-common
• Description: Used to enable sorting of the ticket list by this field. Please see also the detailed explanation in section List of Field Annotations
• Values:
  • true: Used for data fields of type date or of type enum. Remove the annotation if you want to disable sorting.
    For enum fields: Works only if order index is set for all values of the enum field.

common (type)

autocomplete-script

• Type: common
• Description: Specifies the script (type Text autocomplete) used for the scripted autocomplete field.
• Values: <name of the script>

leave-trailing-zeros

• Type: common
• Description: Used for the display of fixed point numbers.
• Values:
  • true / false: Trailing zeros in the fractional part are not cut off when value is true.

readonly

• Type: common
• Description: Used to indicate that the ticket field cannot be modified.
• Values:
  • all: The field is always read-only.
  • edit: The field is read-only when creating or editing a ticket, customer or resource. It can be edited in forms.
  • form: The field is read-only in forms. It can be edited when creating or editing a ticket, customer or resource.
  • unset: The field is always editable. This is the default behavior if the annotation is not assigned.

string-content-type

• Type: common
• Description: Specifies the type of display for a rich text field in view mode.
• Values:
  • html-inline: The content of the rich text field is displayed directly on the GUI.
  • 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.

visibility

• Type: common
• Description: Defines when the field is visible.
• Values:
  • edit: Field will be displayed in edit mode.
  • view: Field will be displayed in view mode.
  • none: Field is not visible.
  • If any other, or no value, is set then the field will always be visible.

visualization

• Type: common
• Description: Specifies the script (type Field visualization) used to render the content of the data field. For a detailed explanation, please refer to the section Scripts of Type Field Visualization .
• Values: <name of the script>

visualize-when-empty

• Type: common
• Description: Determines if the visualization script of a data field with the annotation visualization should be executed even if the field is empty. By default, the visualization script is only executed if the field contains a value.
• Values:
  • true / false: Set true if the field visualization script should be executed even if the field is empty.

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

component type (type)

boolean-type

• Type: component-type
• Description: Definition of the layout of a boolean field.
• Values:
  • checkbox (default): Field that can be checked (set to false by default).
  • radio: 2 radio buttons (yes/no) for selection (only one can be active).
  • select: Drop-down field with 2 values (yes/no).

enum-in-search-type

• Type: component-type
• Description: Defines whether an enum field used in a search accepts searching over multiple values.
• Values:
  • single (default) / multiple: Accepts searching over multiple values if value multiple is set.

enum-type

• Type: component-type
• Description: Layout definition of list display
• Values:
  • select (default): Drop-down list for selection.
  • radio: List of radio buttons to select (only one option can be active).
  • autocomplete: Drop-down list for selections where the field is an input field used to filter the list.

list-type

• Type: component-type
• Description: Disables the add and/or delete options for data fields of type list or struct.
• Values:
  • fixed-size: It is not possible to add or delete fields/rows.
  • non-shrinkable: It is not possible to delete fields/rows.
  • non-growable: It is not possible to add fields/rows.

text-type

• Type: component-type
• Description: Defines the possible types of a string field.
• Values:
  • text (default): Single-line input field
  • textarea: Multi-line input field
  • password: Input field for passwords.
    Password will be displayed as ******* in view mode.
  • label: Read-only label, no input is possible.
  • title: Read-only label styled as a headline, no input is possible.
  • autocomplete: The field will be used as autocomplete list. Please see the detailed explanation in section Scripts of Type Text Autocomplete.
  • url: The input will be 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.
    Example: http://consol.de ConSol
  • file-url: Input will be displayed as a link to a file on the file system. The web browser has to allow/support those links! See section Using Annotations to Fine-Tune Data Fields on how to achieve this. The link will also be displayed as tooltip.

    The URL is correctly formed if the following conditions are met:

    It starts 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 (“%20” for a space for example) 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

    See also the explanation in the section Using Annotations to Fine-Tune Data Fields.

contact authentication (type)

ldapid

• Type: contact authentication
• Description: Used in a customer field group of type contact, for the customer field which contains the LDAP ID for CM/Track authentication.
• Values: Indicates that this field will be used as an LDAP ID in the authentication process. Data type string is required.
  Since the definition is made at the customer group level, the LDAP authentication can be run in mixed mode. I.e., use LDAP for some customer groups and regular authentication for other customer groups.

password

• Type: contact authentication
• Description: Indicates that this field will be used as a password in the authentication process.
• Values:
  • <string>: Used for CM/Track.

username

• Type: contact authentification
• Description: Indicates that this field will be used as a login name in the authentication process.
• Values:
  • true / false: Used for CM/Track.

dwh (type)

dwh-no-history-field

• Type: dwh
• Description: Annotation used to indicate that field will not be historized in DWH
• Values:
  • true / false: Since version 6.10.2.0.

reportable

• Type: dwh
• Description: Indicates that the field is reportable and that it should be transferred to the DWH.
• Values:
  • true / false: Field is reportable if value is set to true.

indexing (type)

field indexed

• Type: indexing
• Description: Indicates that a database index will be created for this field. This is necessary if the field should be used to search for entities or to sort entries in a table.
• Values:
  • transitive: Only relevant for customers. An index is created for the field, so the customer can be searched by this field. For contacts, the tickets of the contact are also found. For companies, the tickets of the company and the contacts of the company are found as well.
  • unit: Only relevant for customers. An index is created for the field, so the customer can be searched by this field. For contact, only the contact itself is found. For companies, the contacts of the company are found as well. This is the default value for customers.
  • local: An index is created for the field, so the object (ticket, customer or resource) can be searched by this field. Only the object itself is found. This is the default value for tickets and resources.
  • <annotation not set>: No index is created for the field, so it it cannot be searched.

phonetic

• Type: indexing
• Description: activates the phonetic search for this field. Can only be used for data fields of type String (also long or short string).
• Values: true/false. Will automatically set to true when the annotation is added.

layout (type)

colspan

• Type: layout
• Description: Defines how many columns are reserved for the field in the layout.
• Values:
  • <number>: Number of columns.

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

field-group

• Type: layout
• Description: Allows grouping of fields in view mode. Annotation is ignored in edit mode.
• Values:
  • <string>: To group fields the same string value has to be set in the annotation of each field. Two or more data fields are bound when they share the same value for this annotation. The group of coupled data fields is shown only if all of them have values set.
• Removed in ConSol CM version 6.11.0.1.

fieldsize

• Type: layout
• Description: Displayed field size within the ticket layout.
• Values:

  • <rows>;<cols>: Displayed field size for textareas

    For string fields with text-type = textarea: rows;cols (corresponds to <textarea rows="" cols="">).
    

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

    For string fields with text-type other than textarea and number fields: n indicates the number of characters in the fields; for string fields this is the number of monospaced capital M characters.

    For enum data fields: Defines how many values are directly visible in the list box. Used only for layout purposes. This annotation is not relevant for ENUM autocomplete fields.

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

label-group

• Type: layout
• Description: Indicates a group of fields along with its descriptive label in view mode. Annotation is ignored in edit mode.
• Values:
  • <string>: Indicates a group of data fields along with its descriptive label. The annotation is used in view mode, ignored in edit mode. The group can have exactly one label (a data field of type string with assigned additional annotation text-type with value label). The label is shown when at least one data field from its group has a value set. All fields with the same label value are grouped and displayed under this label.
    The annotation label-group has to be assigned to the label, too.

label-in-view

• Type: layout
• Description: Shows data field value as a label in view mode. Annotation is ignored in edit mode.
• Values:
  • true: Remove the annotation if the label should not be visible in view mode.

order-in-result

• Type: layout
• Description: Shows field as a column at given position in the search result list.
• Values:
  • <number>: The columns are sorted in ascending order.
    Since CM version 6.0.1. Please see detailed explanation in info box in section Search Configuration, order-in-result.

position

• Type: layout
• Description: Defines the position of a field within a grid layout or defines the position of a field within a list (struct).
• Values:
  • <number>;<number>: Values define row and column (row;column), numbering starts at 0;0. If no values are set, the data field will take the next free grid cell.
  • 0;<number>: Only the column value is used, the row value is ignored.

rowspan

• Type: layout
• Description: Indicates how many rows within the layout are occupied by this field.
• Values:
  • <number>: Number of rows.

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

This annotation does not work in version 6.13.0 and higher.

show-label-in-edit

• Type: layout
• Description: Whether the data field should be displayed in edit mode with label.
• Values:
  • true / false: Since version 6.9.4

show-label-in-view

• Type: layout
• Description: Whether the data field should be displayed in view mode with label.
• Values:
  • true / false: Since version 6.9.4

show-tooltip

• Type: layout
• Description: Whether the data field should be displayed with tooltip.
• Values:
  • true / false: Since version 6.9.4

show-watermark

• Type: layout
• Description: Whether the data field should be displayed with watermark.
• Values:
  • true / false: Since version 6.9.4

ticket-list-colspan

• Type: layout
• Description: Defines how many columns are occupied by the field in the ticket list box.
• Values:
  • <number>: Number of columns.

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

ticket-list-position

• Type: layout
• Description: Defines the position of the field in the ticket list box.
• Values:
  • <number>;<number>: Values define row and column (row;column), numbering starts at 0;0.

ticket-list-rowspan

• Type: layout
• Description: Defines how many rows are occupied by the field in the ticket list box.
• Values:
  • <number>: Number of rows.

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

performance (type)

no-history-field

• Type: performance
• Description: Indicates that a single data field should not be historicized. Overwrites the group annotation no-history.
• Values:
  • true / false: Annotation is active if value is set to true. For fields that should be stored but not be visible in history use annotation visibility configuration.
    In CM versions up to 6.10.2, the DWH transfer of a field history is also controlled by this annotation.
    Starting with CM version 6.10.2, use the annotation dwh-no-history-field for this.

phone commander (type)

dialable

• Type: phone commander (CM/Phone)
• Description: Defines a field with a phone number.
• Values:
  • true: Used with CM/Phone only. Marks a phone number as automatically dialable for outgoing calls for the CTI system.

resource (type)

resource-color

• Type: resource
• Description:
• Values:
  • true / false: Should be assigned to a color enum. Color of selected enum value should be applied to a resource icon's background.

restapi (type)

customer exposure

• Type: restapi
• Description: Indicates whether a data field should be available to customers using the REST API, e.g. in CM/Track.
• Values:
  • full (default): The data field is available for reading and writing.
  • read: The data field is available for reading only.
  • none: The data field is not available. This value can be helpful, for example, when an entire ticket field group has been configured with customer exposure group = full |read and dedicated single fields should not be available in CM/Track (or over the REST API in general).

search result (type)

contact search result column

• Type: search result
• Description: Identifies whether the field should be presented in the search result by default. Deprecated! Do not use! Removed in ConSol CM version 6.11.
• Values:
  • true:
    Remove the annotation if the field should not be visible by default.
    Since CM version 6.1.3.
    (Replaced by order-in-result! contact search result column is obsolete!)

ticket contact relation type (type)

contains contacts

• Type: ticket contact relation type
• Description: Only one instance of this annotation is allowed in one data model! Used only for list field definition, indicates that it can hold unit references to units annotated as contacts. Starting with ConSol CM version 6.11, the field annotated with contains contact will not produce history entries. This decreases the loading time for tickets which contain a great number of customers.
• Values:
  • true/false: Value type is boolean. Specifies whether the list is shown with the contact (true) or with the ticket (false).

ticket display (type)

enum field with ticket color

• Type: ticket display
• Description: Defines the background color of the ticket icon for ticket list and ticket.
• Values:
  • true / false: The field has to exist within Enum Administration where lists, values, and colors are defined.

validation (type)

accuracy

• Type: validation
• Description: For ticket, customer and resource fields of type date. To define the level of detail displayed
• Values:
  • date (default): Show date without time.
  • date-time: Show date with time.
  • only-time: Show only time, no date.

email

• Type: validation
• Description: Used for email addresses to validate that the format is correct, i.e., that it matches <name>@<domain>.
• Values:
  • true: May be used with string data fields. Remove the annotation if the format should not be validated.

format

• Type: validation
• Description: Used for validating the format of date fields.
• Values:
  • <date format>: The pattern for the date is based on SimpleDateFormat, e.g., dd.MM.yyyy.
    Remember to set the proper colspan when including hours/minutes in the format. See http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html for the format reference.

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.

matches

• Type: validation
• Description: Checks if input of string data fields matches the given RegEx.
• Values:
  • <string>: May be used with string data fields.

maxLength

• Type: validation
• Description: Defines the maximum length of input for string data fields.
• Values:
  • <number>: May be used with string data fields.

maxValue

• Type: validation
• Description: Defines the maximum value for number data fields.
• Values:
  • <number>: May be used with number data fields, i.e., number and fixed-point number.

minLength

• Type: validation
• Description: Defines the minimum length of input for string data fields.
• Values:
  • <number>: May be used with string data fields.

minValue

• Type: validation
• Description: Defines the minimum value for number data fields.
• Values:
  • <number>: May be used with number data fields, i.e., number and fixed-point number.

required

• Type: validation
• Description: Indicates that this is a required field.
• Values:
  • true / false: Field is required if value is set to true. The user cannot save the ticket without having entered a value in a required field. In the Web Client, required fields are marked by a red asterisk.

visibility (type)

visibility configuration

• Type: visibility
• Description: Indicates the visibility of this field in history.
• Values:
  • on every level: Field is shown on every level of history.
  • 2nd level and 3rd level: Field is shown only on the 2nd and the 3rd level of history.
  • only 3rd level: Field is shown only on the 3rd level of history.