Skip to main content

cmApplicationCustomization

This type contains attributes which affect the Web Client in a general way.

Attributes:

  • activityKeyBindingEnabled: Determines whether shortcuts can be used to execute activities and actions. Default: true.

  • autoSideBarFoldEnabled: Determines whether the sidebars (case list on the left and activities / workspace / favorites on the right) are folded automatically once the current screen resolution is lower than a defined threshold. Default: true.

  • autoSideBarFoldOrder: Determines which sidebar is folded first: right (case list) or left (activities / workspace / favorites). Default: right.

  • formsRenderingType: Determines whether activity and action forms are shown as modal windows (modal) or sections at the top of the page (section). Default: modal.

  • globalDateEditFormat: Determines how dates are displayed when editing them, e.g. in date fields. The default format is dd.MM.yy for German, and M/d/yy for English and other languages. This results in dates being edited in the format 24.04.23 for German and 4/24/23 for English.

  • globalDateViewFormat: Determines how dates are displayed when viewing them, e.g. in a case. The default format is dd.MMM yyyy for both English and German. This results in dates displayed like 24. Apr 2023.

  • globalRichTextFont: Determines the font for all rich text editors, i.e. both the comment and email editor, and the editors of rich text fields. Can be overridden for the comment and email editor using the attribute font in cmRichTextEditor.

  • globalRichTextFontSize: Determines the font size for all rich text editors, i.e. both the comment and email editor, and the editors of rich text fields. Can be overridden for the comment and email editor using the attribute fontSizeValue in cmRichTextEditor.

  • globalSearchFocusKeyBindingEnabled: Determines whether the shortcut F can be used to jump to the quick search field. Default: true.

  • submitACFOnEnterEnabled: Determines whether is it possible to submit an activity form by pressing the Enter key. Default: true.

  • systemNotificationTitle: Sets the title of the notification in the Windows system notifications area. Use the following syntax:

    de: 'Benachrichtigung von {sender}', en: 'Notification from {sender}

  • textAttachmentsPreviewThreshold: Defines the maximum size for showing a preview of text files when hovering the attachment name. For text files which exceed the defined limit, no preview will be shown. The default value is 5 MB.

  • timeBookingOverviewEnabled: Defines whether the Time booking link to access the Time booking page is shown in the user menu when clicking the user avatar. The default value is true.

  • timeToShowWarningMessage: Sets the time (in seconds) when a warning message is displayed before a session timeout occurs. The user can click the Yes, extend my session button in the message to avoid being logged out. The default value is 180. The message can be disabled by setting the value to 0.

  • updateTimeServerSessionActivity: Sets time in seconds to automatically update the session if there is activity. Default 900.

  • updateTimeServerSessionActivityEnabled: Determines whether the automatic update of the session if there is activity is active. Default: true. When set to false, the session renewal is not active.

Changing the global date format​

You can change the format for each language independently, e.g. {"de":"dd.MM.yyyy","en":"M/d/yy"}. You can use else to indicate the format which should be used for all languages which are not configured explicitly.

The global date format can be overwritten for data fields by setting Date format to the desired format for individual date fields.

Configuring the session timeout​

The attributes updateTimeServerSessionActivity and updateTimeServerSessionActivityEnabled are used to configure the session timeout for users in the Web Client. If updateTimeServerSessionActivityEnabled is set to true, the session is automatically extended by the time set in updateTimeServerSessionActivity, in order to prevent the session from terminating while a user edits an object (the entered data would be lost when the session expired).

In the following example, updateTimeServerSessionActivity is set to 900.

SessionTimeouts_EN.png

The following actions underlie the control of the updateTimeServerSession:

  • Creating a case, contact, or resource
  • Creating a comment or an email in a case
  • Creating a comment for a contact or resource
  • Editing data fields of a case, contact, or resource
  • Editing data field groups
  • Filling an activity form