Skip to main content

DMS

The DMS module provides components for managing and displaying document management system data such as communications, notifications, worklogs, attachments, comments and more. Components are organized into layout components and data components.

Layout Components​

Emails SLA​

The component is used to display the email communication thread.

  • Selector: tsm-communication-sla
  • Type: Layout Component
  • Properties:
    • dateAsTooltipOnly (boolean = false): This input determines if the date should be displayed as a tooltip only.
    • slaData (CommunicationSla): This input provides the SLA data necessary for the component's logic.
{
  "type": "layout",
  "widget": {
    "type": "tsm-communication-sla"
  }
}

Email Communication Panel​

Panel for managing and displaying email communications.

  • Selector: tsm-communication-widget
  • Type: Layout Component
  • Properties:
    • parentPriv (string = Tick.Ticket): Used for setting parent privileges.
    • readonly (boolean): Determines if the component is in read-only mode.
    • hashtagOption ('tickets' | 'script' = 'tickets'): Specifies the hashtag option.
    • suggestionScriptCode (string): Code for suggestion script.
    • suggestionScriptData (any): Data for suggestion script.
    • clickScriptCode (string): Code for click script.
    • clickScriptData (any): Data for click script.
    • reviewRegisterValue (any): Value for review registration.
    • signatureRegisterCode (string): Code for signature registration.
    • moreSelector (string): Selector for additional options.
    • moreInputs (any = ): Additional inputs for the component.
    • contactEmail (string): Email address for contact purposes.
{
  "type": "layout",
  "widget": {
    "type": "tsm-communication-widget"
  }
}

Notification List​

List of notifications in a tabular view with filtering and editing options.

{
  "type": "layout",
  "title": "Notification List",
  "widget": {
    "type": "tsm-notification-tab"
  }
}

Worklog List​

List of worklogs in a tabular view with filtering and editing options.

  • Selector: tsm-worklog-list
  • Type: Layout Component
  • Properties:
    • parentPriv (string = 'Dms.Worklogs'): Base privilege for worklogs.
    • pageMode (boolean = false): Determines if the component is in page mode.
    • defaultViewMode (DataViewModeEnum = DataViewModeEnum.TABLE): Default view mode for the component.
    • ownerId (string): ID of the owner entity.
    • ownerType (string): Type of the owner entity.
    • useCurrentUser (boolean = false): If true, filters worklogs by the current user.
    • showStartWorkButton (boolean = false): Determines if the start work button is shown.
    • worklogTypeCodes (string[]): Array of worklog type codes.
    • defaultWorklogType (string): Default worklog type code.
    • worklogTypeAllowEmpty (boolean = true): Allows worklog type to be empty.
    • context (ContextFrom): Context for the component.
    • listingTypeCode (string = 'tsm-worklog-list'): Code for the listing type.
{
  "type": "layout",
  "title": "Worklog List",
  "widget": {
    "type": "tsm-worklog-list"
  }
}

Comments Bookmark​

Simple list of comments in a tabular view.

  • Selector: dtl-comments-widget
  • Type: Layout Component
  • Properties:
    • hiddenTableFilter (boolean = false): Matches with the editor form control.
    • hiddenTableMenu (boolean = false): Matches with the editor form control.
    • hiddenTableProfile (boolean = false): Matches with the editor form control.
    • context (any = null): Matches with the editor form control.
    • ownerId (string = null): Matches with the editor form control.
    • ownerType (string = null): Matches with the editor form control.
    • parentPriv (string = null): Matches with the editor form control.
    • commentTypeCodes (string[] = null): Matches with the editor form control.
    • defaultCommentType (string = null): Matches with the editor form control.
    • commentTypeAllowEmpty (boolean = true): Matches with the editor form control.
    • showFoldControls (boolean = true): Matches with the editor form control.
    • listingId (string = null): Matches with the editor form control.
    • listingTypeCode (string = null): Matches with the editor form control.
    • profileId (string = null): Matches with the editor form control.
{
  "type": "layout",
  "title": "Comments Bookmark",
  "widget": {
    "type": "dtl-comments-widget"
  }
}

Worklogs Bookmark​

Simple list of worklogs in a tabular view.

  • Selector: dtl-worklogs-widget
  • Type: Layout Component
  • Properties:
    • hiddenTableFilter (boolean = false): Configured as a checkbox in the editor.
    • hiddenTableMenu (boolean = false): Configured as a checkbox in the editor.
    • hiddenTableProfile (boolean = false): Configured as a checkbox in the editor.
    • context (any = null): Configured as a JSON object in the editor.
    • ownerId (string = null): Configured with an expression editor.
    • ownerType (string = null): Configured with a LOV.
    • worklogTypeCodes (string[] = null): Configured with a data tags component.
    • defaultWorklogType (string = null): Configured with a LOV.
    • worklogTypeAllowEmpty (boolean = true): Configured as a checkbox.
    • listingTypeCode (string = null): Configured with a LOV.
    • profileId (string = null): Configured with a LOV.
{
  "type": "layout",
  "title": "",
  "widget": {
    "type": "dtl-worklogs-widget"
  }
}

Attachments Bookmark​

Simple list of attachments in a tabular view.

  • Selector: dtl-attachments-widget
  • Type: Layout Component
  • Properties:
    • ownerId (string): Configured in the editor component with a form control.
    • ownerType (string): Configured in the editor component with a form control.
    • hiddenFileType (boolean = false): Configured in the editor component with a form control.
    • hiddenSizeUnit (boolean = false): Configured in the editor component with a form control.
    • hiddenWhenInserted (boolean = false): Configured in the editor component with a form control.
    • hiddenWhoInserted (boolean = false): Configured in the editor component with a form control.
    • hiddenAttachmentTypeName (boolean = false): Configured in the editor component with a form control.
    • hiddenTableDropFile (boolean = false): Configured in the editor component with a form control.
    • hiddenTableFilter (boolean = false): Configured in the editor component with a form control.
    • hiddenTableMenu (boolean = false): Configured in the editor component with a form control.
    • hiddenTableProfile (boolean = false): Configured in the editor component with a form control.
    • hiddenDeleteAttachment (boolean = false): Not present in the editor form model.
    • parentPriv (string): Not configurable via the editor.
    • attachmentTypeCodes (string[]): Configured in the editor component.
    • attachmentTypeAllowEmpty (boolean = true): Configured in the editor component.
    • profileId (string): Configured in the editor component.
{
  "type": "layout",
  "title": "Attachments Bookmark",
  "widget": {
    "type": "dtl-attachments-widget"
  }
}

Awareness​

Displays awareness information for collaboration.

  • Selector: dtl-awareness-users
  • Type: Layout Component
  • Properties:
    • ownerType (string = null): Configured in the editor component with a form control.
    • ownerId (string = null): Configured in the editor component with a form control.
    • currentUserId (string = null): Optional input, not present in the editor form model.
    • hideCurrentUser (boolean = false): Default value is set in the component.
    • emitOnlyChangeCollaborateUsers (boolean = false): Default value is set in the component.
{
  "type": "layout",
  "title": "Awareness",
  "widget": {
    "type": "dtl-awareness-users"
  }
}

Data Components​

Session emails​

Selection of session emails.

  • Selector: tsm-communication-session
  • Type: Select Component
  • Properties:
    • placeholder (string): Optional input inherited from ParentWidgetAccessorComponent.
    • localizationData (LocalizationVersionData): Used for localization purposes.
{
  "type": "string",
  "widget": {
    "type": "tsm-communication-session"
  }
}

Comment Type Select​

Selection of a comment type from a dropdown list.

  • Selector: tsm-comment-type-lov
  • Type: Select Component
  • Properties:
    • filterable (boolean = true): Controls whether the dropdown is filterable.
    • title (string): Title of the component (not directly used in the template).
    • readonly (boolean = false): If true, the component is displayed in a read-only mode.
    • ignoreCommentTypeLovPrivileges (boolean = false): If true, ignores privilege checks for comment types.
    • defaultCommentType (string): Specifies a default comment type to be selected.
    • filterByCodes (string[] = []): Filters the comment types by specified codes.
{
  "type": "object",
  "title": "Select a Comment Type",
  "widget": {
    "type": "tsm-comment-type-lov"
  },
  "config": {}
}

Notification Template Select​

Selection of a notification template from a dropdown list.

  • Selector: tsm-notification-template-lov
  • Type: Select Component
  • Properties:
    • resultEmptyType (boolean = false): If true, returns a fake code when codes are empty.
    • codes (string[]): Array of codes used for filtering.
{
  "type": "string",
  "title": "Select a Notification Template",
  "widget": {
    "type": "tsm-notification-template-lov"
  },
  "config": {
    "selectProperty": "id"
  }
}

Formatter Doc. Template Select​

Selection of a document template for formatting from a dropdown list.

  • Selector: tsm-formatter-document-template-lov
  • Type: Select Component
  • Properties:
    • value (any): Represents the current value of the component.
    • readonly (boolean): Determines if the component is in read-only mode.
{
  "type": "string",
  "title": "Select a Document Template",
  "widget": {
    "type": "tsm-formatter-document-template-lov"
  },
  "config": {
    "selectProperty": "id"
  }
}