Notification templates (Configuration)

Notification templates provide the possibility to configure all types of notifications that are sent to users by the system.

The tab is available for users with the permission to manage system configuration.
editor light
editor dark

You can set up the option notification_buffering_period in the section Server of the server configuration file. If this period is set, the server will not send notifications immediately. Instead, it will hold them and send in batch at the end of the specified period.

Templates for the group notifications are customized individually.

When SMS-notifications are used, text of a single event passes to the script as the 5th argument, text of a grouped event passes as the 7th one.

Templates editor

You can define each template in the templates editor. Each template can be customized individually. You can select a template to edit in the list on the left. To add a new template, press the button above the template list.

Template editor is separated into two parts. Field on the left is field where you edit a template, panel on the right is a preview of what the message with the edited template would look like.

editor sms light
editor sms dark

Template editor header contains the following controls:

  • The button opens the hint window with the list of all the possible variables, which are available for the selected notification type.

  • The Notification pack slider allows to switch between templates for single and group notifications:

    • Yes – the template for the group notification is in the editor;

    • No – the template for the single notification is in the editor.

  • The Default template button cancels all changes and returns the default template.

    The template is reset immediately after the confirmation in the modal window. You don’t need to press the Save button.

Template editor for Email notification also has an editor for the email’s subject. It is located above the template editor:

editor email light
editor email dark
Notification pack toggle and default template button are independent for each editor. For example, you can reset the email subject template without resetting email text template.

To delete a template, press the Remove button. In the opened modal window you can either define a new template for all triggers that used deleted template or delete them.

You can delete state change templates (SMS, Email, Telegram), but you cannot delete registration templates.
delete light
delete dark

Basic variables

These variables can be used in any type of notifications:

  • entityName – element name;

  • entityId – element ID;

  • entityType – element type (object / link);

  • entityUrl – element URL;

  • stateName – name of the state;

  • stateData – information about the state;

  • changedStateText – state transition text ("has passed to");

    • "has passed to" for objects;

    • "has passed to" for links;

  • hasRootCause – indicates that transition is caused by a child element;

    • returns true, if the new state has been inherited from a child object;

    • returns false, if the state has been changed because of other reason;

  • rootCauseEntityName – name of the child root-cause element;

  • rootCauseEntityUrl – URL of the child root-cause element;

  • rootCauseEntityId – ID of the child root-cause element;

  • condition – information about the triggered state change condition;

  • conditionDescription – description of the triggered condition;

  • eventTime – the time when the event occurred;

  • breadcrumbs – the path to the element which the notification comes about.

These variables also can be used within the variable breadcrumbs:

Parameters of the variable breadcrumbs (each parameter by default is equal to 0):

  • multi-break – whether to stop on a multi-parent (0 – no, 1 – yes);

  • depth – amount of displayed levels (0 – no limit);

  • length – the largest number of symbols (0 – no limit).

Variables for group notifications

In addition to the basic variables there are some special ones which can be used in group notifications:

  • eventsCount – quantity of the events;

  • uniqueCount – quantity of the unique events;

  • fromTime – timestamp of the first event in the group;

  • toTime – timestamp of the least event in the group.

Additional variables for email-notifications

There are some additional variables for email-notifications:

  • stateLabel – the coloured label of the state;

  • entityLink – name-URL to the element;

  • rootCauseEntityLink – name-URL to the child root-cause element;

  • goToObjectButton – button to open the element.

Notification language

The notification templates related to user registration or restoring access:

  • Forgot password,

  • Forgot password subject,

  • Registration,

  • Registration subject,

  • Registration with password,

  • Registration with password subject,

can contain information in different languages. Users will receive notifications in their language, depending on selected user language.

It can be set using the variable lang.

In case there is no template in user’s language, the template in English is used.

Examples

General using

To use SomeVar variable its name must be written in double braces:

{{SomeVar}}

If-else operator

It is also possible to use if-else operators:

if:
{{#SomeVar}}
      ...
    {{/SomeVar}}
else:
{{^SomeVar}}
      ...
    {{/SomeVar}}

Loop

Loops are defined in a similar way:

for-loop:
{{#SomeVar}}
      ...
    {{/SomeVar}}

Lang

Multiple languages are available for using with this variable:

  • en – English,

  • it – Italian,

{{#lang=it}}
Creare un account.
{{/lang=it}}

{{#lang=en}}
Account creation
{{/lang=en}}

Breadcrumbs

html

{{#breadcrumbs multi-break=1 depth=3 length=30}}<a href='{{entityUrl}}'>/{{entityName}} (ID {{entityId}})</a>{{/breadcrumbs}}

markdown

{{#breadcrumbs multi-break=1 depth=3 length=20}}/[{{entityName}} {{entityId}}]({{entityUrl}}){{/breadcrumbs}}