Email Descriptors: Literals

Date literal options

The following table describes various date and time patterns and provides their displaying examples.

The format options imply the content of the date literal such as how and whether to show the date, month, year and time with or without seconds.

The date and time format may vary based on the locale settings and impact the separation signs used in the date (slash or hyphen), as well as 12-hour or 24-hour clock.

Date format legend

• dddd: full name of the day
• d: the day of the month as a number from 1 through 31
• dd: the day of the month as a number from 01 through 31
• M: month number without leading zero (e.g. 6)
• MM Month number with leading zero
• MMM: abbreviated month name (e.g. Aug)
• MMMM: full month name (August)
• y: year, no leading zero (e.g. 2019 would be 19)
• yyyy: year, (e.g. 2019)
• h 12-hour clock hour (e.g. 3)
• HH 24-hour clock hour, with a leading 0 (e.g. 22)
• mm: minutes with a leading zero
• ss: seconds with leading zero
• tt:  AM / PM (e.g. AM or PM)

The date and time format is defined by the Locale of the default E-mail Language selected by the user in the Profile settings:

The time zone used in the e-mail is defined by the user's Location settings:

Model

Model section defines the data source for the generated link, link text and text to display if the link cannot be generated: 

• Object Id: identifier of the referenced in the link data object. Select data model property of a GuId type. 
• Configuration Item:  this option is used when there is more than one source of the referenced data objects and the type (Configuration Item) of the Object ID cannot be defined automatically (e.g. manually created property or ambiguous Configuration Item type). For example, selected Object ID is used in different types of tickets such as Problem, Change Request, Incident, etc. If the e-mail template is created specifically for an incident, explicitly set the Configuration Item of an incident.
  • not set: the System will try to recognize the type according to the data from the Object ID field.
  • set: the link will be generated for the specified type of object. 
• Value Label: allows overwriting the text of the link. 
  • not set: text for the link is automatically detected from the referenced resource (e.g. based on the "Display expression" property of the explicitly stated Configuration Item or from the automatically detected Configuration Item the specified Object ID belongs to). See also: Configuration Item settings.
  • set manually: the specified text is always rendered for a link (e.g. localizable text in English is set to Click here to open the Incident in your web browser). Value label data sources: data model property, localizable value or static value.
• Link Text: text which is displayed instead of the link, when the System does not recognize the referenced resource (e.g. Id of the Object is not set, no longer exists or was not found). 
  • not set: the link is not shown in the e-mail if the Object ID was not found; 
  • set:  if the link cannot be generated, the system retrieves to the e-mail the Link Text from one of the following data sources: data model property, localizable value or static value.

Appearance

Appearance section defines the optional caption, preceding the link, and the link displaying conditions in the sent e-mail. All types of e-mail literals have generic appearance settings.

• Label: the control can be displayed with a caption. This property defines the text for the label.
• Label Position: relevant only if the Label is set. Regulates the position of the label and its positioning in the email relatively to the link (before the link or on top of the link.
• Label Width: fixed placeholder for the link text.
• Visibility: allows dynamically show/hide a control depending on some dynamic data.

Navigation

All settings, except for the Custom URL, are relevant for the new user interface of the Matrix42 platform also referred to as UUX.

• Navigate To: specifies the kind of Application resource the anchor in the email should navigate to. The System supports the following types:
  • Search Page: direct the user to the specified Management area (Dataset View). On picking this option, the Email Designer requests to provide the reference to Navigation Item which needs to open on click;
  • Object Preview (default): opens Preview of the specified Object. If this option is selected, the Id of the Object needs to be set to property "Object Id". To solve the ambiguity, when the Preview for defined Object is available in multiple UUX applications,  the Navigation Item can be specified where the preview needs to be opened;
  • Object Dialog directly opens the edit dialog for a specified object. Depends on the "Object Id" field value.
• Navigation Item: select a Navigation Item from the list of available in the system items. Specified Navigation Item also defines the Application where the generated link will be opened: Incidents (Service Desk).
• Application: 
  • not set: by default, the system will try to generate the e-mail link for the Self Service Portal application.
  • set: select an application name from the suggested dropdown-list. In case of conflicting settings for the Application and a Navigation Item, the Navigation Item overrides the manually set Application.
• Run Action: reference to the Action which needs to be initiated on opening the link. The action is started in the context of the opened page. E.g. if the link follows to object Preview, then the action is activated for the specified object.
• Custom Url (legacy): specify a relative URL path to the Matrix42 platform with the legacy user interface. The specified URL path should not include the scheme (e.g. http / https) and the hostname (e.g. yourdomain.com) as they will be added automatically to the generated in the e-mail link. Optional parameter. Defines custom URL leading to the legacy portal. You may use variables in curly braces which will be replaced with actual values. Defined variables:
  • {id} object ID
  • {typeId} Configuration Item ID
  • {ci} Configuration Item Name.
  • Also, you can use data model path in curly braces. Example: {Parameters.SVCApprovalTaskType.ID} 

       Custom Url example with variables in the relative path:

      /Portal/Pages/Workspace.aspx?ObjectID={id}&query_parameter=value&param={Parameters.SVCApprovalTaskType.ID}