2023-03-27 14:37:47 +03:00

2.2 KiB

Alarm assignment notification templatization


Notification subject and message fields support templatization. The list of available templatization parameters depends on the template type. See the available types and parameters below:

Available template parameters:

  • recipientEmail - email of the recipient;
  • recipientFirstName - first name of the recipient;
  • recipientLastName - last name of the recipient;
  • alarmType - alarm type;
  • alarmId - the alarm id as uuid string;
  • alarmSeverity - alarm severity (lower case);
  • alarmStatus - the alarm status;
  • alarmOriginatorEntityType - the entity type of the alarm originator, e.g. 'Device';
  • alarmOriginatorName - the name of the alarm originator, e.g. 'Sensor T1';
  • alarmOriginatorId - the alarm originator entity id as uuid string;
  • assigneeEmail - email of the assignee;
  • assigneeFirstName - first name of the assignee;
  • assigneeLastName - last name of the assignee;
  • assigneeId - the id of the assignee as uuid string;
  • userEmail - email of the user who made the action;
  • userFirstName - first name of the user who made the action;
  • userLastName - last name of the user who made the action;
  • action - one of: 'assigned', 'unassigned';

Parameter names must be wrapped using ${...}. For example: ${action}. You may also modify the value of the parameter with one of the suffixes:

  • upperCase, for example - ${recipientFirstName:upperCase}
  • lowerCase, for example - ${recipientFirstName:lowerCase}
  • capitalize, for example - ${recipientFirstName:capitalize}
Examples
  • Let's assume the notification about alarm with type 'High Temperature' for device 'Sensor A' was assigned to user 'John Doe'. The following template:
Alarm '${alarmType}' - ${action:upperCase}
{:copy-code}

will be transformed to:

Alarm 'High Temperature' - ASSIGNED
{:copy-code}

The following template:

Alarm '${alarmType}' (${alarmSeverity:capitalize}) was assigned to user
{:copy-code}

will be transformed to:

Alarm 'High Temperature' (Critical) was assigned to user
{:copy-code}