Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Notification templates are a very useful and flexible tool for modeling the appearance of notifications for different tasks and cases.
Create a template
To create a notification template, complete the steps below:
- Navigate to the System Notification → Notification Templates.
- Click New and fill in the fields.
- Click Save or Save and exit to apply the changes.
Notification Template form fields
| Field | Mandatory | Description | ||
|---|---|---|---|---|
| Name | Y | Specify a notification template name. | ||
| Table | Y | Specify a table to which the template is applicable. | ||
| Subject | Y | Specify the notification template subject. Notification variables and placeholders are supported. | ||
| Message Text | N | Specify the notification template in plain text format. Notification variables and placeholders are supported. | ||
| Message HTML | N | Specify the notification template in rich-text format. This field supports HTML tags, placeholders, and notification variables.
|
Notification variables
Specify a notification variable using the following syntax:
${variable-name.variable-parameters}
Notification variables
| Variable | Description | Example | ||
|---|---|---|---|---|
| ${current} | This variable refers to the current record in the specified table. | ${current.caller} – for example, if this variable is used in a notification rule in the Other recipients field of the Who Will Receive tab, the notification is sent to the caller (the originator of the issue). | ||
| ${event} | This variable refers to the specified event context if some event triggers the notification. You can get the values of the fields within the Event (sys_event) table related to this event. | ${event.param_1} | ||
| ${script} | This variable runs the specified notification script.
| ${script:add_an_attachment} | ||
| ${template} | This variable is used to link the Notification Template (sys_notification_template) and the Notification Rule (sys_notification_rule) tables. When using it, you can transfer the template field value to the relevant notification rule fields. | ${template.template_name} – for example, if this variable is used in the Subject field of the notification rule, the subject line stored in the template is applied to a relevant field. | ||
| Variables that display links to the current record | ||||
${URI} | The link text is the non-clickable link to the record. | ${URI} Source: View the task: ${URI} ${URI} Output: View the task: https://instance.example.com/record/task/160525805616015648 | ||
| ${URI_REF} | The link text is the display value of the record. | ${URI_REF} Source: View the task: ${URI_REF} ${URI_REF} Output: View the task: TSK0005555 | ||