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 notification process. They provide an ability to develop templates appearance of notifications for different tasks and cases.

Create a template


To create a notification template, complete the steps below:

  1. Navigate to the System Notification → Notification Templates.
  2. Click New and fill in the fields.
  3. Click Save or Save and Exitexit to apply the changes.

Notification Template form fields

FieldMandatoryDescription
NameYSpecify a notification template name.
TableYSpecify a table to which the template is applicable.
SubjectY

Specify the notification template subject. Notification variables and placeholders are supported.

Message TextNSpecify the notification template in plain text format. Notification variables and placeholders are supported.
Message HTMLN

Specify the notification template in rich-text format. This field supports HTML tags, placeholders, and notification variables.

Tip

You can also use the ${URI} and ${URI_REF} notification variables. Their usage is described below.


Notification variables


Specify a notification variable using the following syntax:

${variable-name.variable-parameters}

Notification variables

VariableDescriptionExample
${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 recepientsrecipients field of the Who will receive tabWill Receive section, the notification is sent to the caller (the originator of the issue).
${event}

This variable refers to the specified event context in case if some event triggers the notification is triggered by some event.

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 script developed with the Notification Scripts functionality notification script.

Tip

The name of the called script should not contain spaces.


${script:add_an_attachment}

${template}

This variable is used to link the notification template table Notification Template (sys_notification_template) and the notification rule table the Notification Rule (sys_notification_rule) tables. When using it, you can transfer the template fields 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} SourceOutput: View the task: TSK0005555