ContextQMD
Back to Thingsboard

Alarm Comment

ui-ngx/src/assets/help/en_US/notification/alarm_comment.md

4.3.1.12.2 KB
Original Source

Alarm comment notification templatization

<div class="divider"></div>

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:

  • 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';
  • alarmOriginatorLabel - the label of the alarm originator, e.g. 'Sensor T1';
  • alarmOriginatorId - the alarm originator entity id as uuid string;
  • comment - text of the comment;
  • action - one of: 'added', 'updated';
  • userTitle - title of the user who made the action;
  • 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;
  • recipientTitle - title of the recipient (first and last name if specified, email otherwise);
  • recipientEmail - email of the recipient;
  • recipientFirstName - first name of the recipient;
  • recipientLastName - last name of the recipient;

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}
<div class="divider"></div>
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:

text
Alarm '${alarmType}' - comment ${action}
{:copy-code}

will be transformed to:

text
Alarm 'High Temperature' - comment added

The following template:

text
Alarm '${alarmType}' (${alarmSeverity:capitalize}) was commented
{:copy-code}

will be transformed to:

text
Alarm 'High Temperature' (Critical) was commented