Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Notification templates are beneficial to pattern the notification process, being a very useful and flexible tool . They provide a possibility to develop templates for modeling the appearance of notifications for different tasks and cases.

Create a template


To create a notification template, please 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 this the following syntax:

${variable-name.variable-parameters}

Notification variables

VariableDescriptionExample
${current}This variable refers to the current record in the specified table
specified
.${current.caller}
 –
for example, if this variable
was
is used in
the Notification Rule
a notification rule in the Other
field in
recipients field of the Who
will receive tab, then
Will Receive section, the notification
will be
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

was triggered by some event

.

So, as you have got this context, you

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 by using the Notification Scripts functionality

notification script.

Tip

The name of the called script

name

should not contain spaces

. They are not allowed to use within the structure like shown in the example

.


${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

stuff

transfer the template

fields

field value to the relevant notification rule fields.

${template.template_name}
– for
– for example, if this variable
was
is used in the Subject field of the notification rule,
then
the subject line stored in the template
will be
is applied to
the
a relevant field.
Variables that
allow displaying
display links to the current record

${URI}


The link text is the
unclickable
non-clickable link to the record.

${URI} Source:

Click here to view

View the task: ${URI}

${URI} Output:

Click here to view

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:

Click here to view

View the task: ${URI_REF}

${URI_REF}

Source: Click here to view

Output: View the task: TSK0005555