List of settings for field groups

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

CM/Track

Availability via REST

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

DWH

Field values omitted from DWH history

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

Transfer to DWH

• Annotation name: reportable group
• Name: Transfer to DWH
• Description: Determines if the data fields belonging to this group are transferred to the data warehouse.
• Area: DWH
• Values:
  • true: The fields are transferred to the data warehouse.
  • false: The fields are not transferred to the data warehouse.
• Since: 6.1.3, changed in 6.8.0

Features

Field values omitted from history

• Annotation name: no-history
• Name: Field values omitted from history
• Description: Indicates that all data fields belonging to this group will not be historicized. Can be combined with the annotation no-history-field on field level, if not all fields of a group should be omitted.
• Area: Features
• Values:
  • true: Data fields belonging to this group will not be historicized.
  • false: Data fields belonging to this group will be historicized.
• Since: 6.6.0, changed in 6.10.2

Resource mode

• Annotation name: resource-custom-fields-group-mode
• Name: Resource mode
• Description: Determines if the fields in the resource field group can be edited using the Web Client.
• Area: Features
• Values:
  • internal: The fields of the resource field group can be edited in the Web Client.
  • external: The fields of the resource field group cannot be edited in the Web Client.
    
• Available for: Resources
• Since: 6.10.5.0

Show contact in case list

• Annotation name: show-contact-in-ticket-list
• Name: Show contact in case list
• Description: Indicates whether the contact should be shown in the case list. Replaced by the page customization attribute mainCustomerDescriptionVisible in accordionTicketList.
• Area: Features
• Values: true / false
• Removed in: 6.9.0

Unit is a contact

• Annotation name: unit-is-a-contact
• Name: Unit is a contact
• Description: Indicates whether a unit definition describes a contact object.
• Area: Features
• Values: true / false
• Available for: Contacts
• Removed in: 6.9.0

Layout

Display in details section

• Annotation name: show-in-group-section
• Name: Display in details section
• Description: Defines whether a data field group is displayed in the details section.
• Area: Layout
• Values:
  • true: The data field group is shown in the details section.
  • false: The data field group is shown in the header section (default).

Display labels in edit mode

• Annotation name: show-labels-in-edit
• Name: Display labels in edit mode
• Description: Determines whether the data fields in this group should be displayed with labels in the edit mode.
• Area: Layout
• Values:
  • true: Data fields are displayed with labels (default).
  • false: Data fields are displayed without labels.
• Since: 6.9.4

Display labels in view mode

• Annotation name: show-labels-in-view
• Name: Display labels in view mode
• Description: Determines whether the data fields in this group should be displayed with labels in the view mode.
• Area: Layout
• Values:
  • true: Data fields are displayed with labels (default).
  • false: Data fields are displayed without labels.
• Since: 6.9.4

Display tooltips

• Annotation name: show-tooltips
• Name: Display tooltips
• Description: Determines whether the data fields in this group should be displayed with tooltips.
• Area: Layout
• Values:
  • true: Data fields are displayed with tooltips.
  • false: Data fields are displayed without tooltips (default).
• Since: 6.9.4

Display watermarks

• Annotation name: show-watermarks
• Name: Display watermarks
• Description: Determines whether the data fields in this group should be displayed with watermarks.
• Area: Layout
• Values:
  • true: Data fields are displayed with watermarks.
  • false: Data fields are displayed without watermarks (default).
• Since: 6.9.4

No group headline in pill mode

• Annotation name: hide-group-headline
• Name: No group headline in pill mode
• Description: Determines whether the field group in the Details section has a header. Only relevant for cases and if the annotation show-in-group-section is set to true and the pill mode is used (see customFieldGroupsSection).
• Area: Layout
• Values:
  • true: The case fields are displayed without a header. There is no separation between fields belonging to different groups.
  • false: The name of the case field group is displayed as a header for the fields of this group (default value).
• Available for: Cases

Open group automatically

• Annotation name: auto-open-group
• Name: Open group automatically
• Description: Determines in which situations the group will be opened initially. You can enter more than one value as a comma- or semicolon-separated list. For cases, only relevant for the pill mode, see customFieldGroupsSection and if show-in-groups-section is set to true.
• Area: Layout
• Values:

  • On create (ticket:create, customer:create, resource:create): Group is opened initially when a new object is created.

  • On edit and view (ticket:view, customer:view, resource:view): Group is opened initially when the page is opened.

  • Always (ticket:create, customer:create, resource:create, ticket:view, customer:view, resource:view): Group is always opened initially.

Open on case creation

• Annotation name: open-at-create
• Name: Open on case creation
• Description: Allows to have a group visible during case creation even if the group is hidden. Replaced by auto-open-group.
• Area: Layout
• Values: true / false
• Available for: Cases
• Removed in: 6.9.0

Visible

• Annotation name: group-visibility
• Name: Visible
• Description: Defines the default visibility of a data field group.
• Area: Layout
• Values:
  • true : The field group is visible.
  • false: The field group is not visible.