Notification subject and message fields support templatization. The list of available templatization parameters depends on the template type.
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:
See the available types and parameters below:
Available template parameters:
Available template parameters:
* *recipientEmail* - email of the recipient;
* `alarmType` - alarm type;
* *recipientFirstName* - first name of the recipient;
* `alarmId` - the alarm id as uuid string;
* *recipientLastName* - last name of the recipient;
* `alarmSeverity` - alarm severity (lower case);
* *alarmType* - alarm type;
* `alarmStatus` - the alarm status;
* *alarmId* - the alarm id as uuid string;
* `alarmOriginatorEntityType` - the entity type of the alarm originator, e.g. 'Device';
* *alarmSeverity* - alarm severity (lower case);
* `alarmOriginatorName` - the name of the alarm originator, e.g. 'Sensor T1';
* *alarmStatus* - the alarm status;
* `alarmOriginatorId` - the alarm originator entity id as uuid string;
* *alarmOriginatorEntityType* - the entity type of the alarm originator, e.g. 'Device';
* `assigneeTitle` - title of the assignee;
* *alarmOriginatorName* - the name of the alarm originator, e.g. 'Sensor T1';
* `assigneeEmail` - email of the assignee;
* *alarmOriginatorId* - the alarm originator entity id as uuid string;
* `assigneeFirstName` - first name of the assignee;
* *assigneeEmail* - email of the assignee;
* `assigneeLastName` - last name of the assignee;
* *assigneeFirstName* - first name of the assignee;
* `assigneeId` - the id of the assignee as uuid string;
* *assigneeLastName* - last name of the assignee;
* `userTitle` - title of the user who made the action;
* *assigneeId* - the id of the assignee as uuid string;
* `userEmail` - email 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;
* *userFirstName* - first name of the user who made the action;
* `userLastName` - last name of the user who made the action;
* *userLastName* - last name of the user who made the action;
* `action` - one of: 'assigned', 'unassigned';
* *action* - one of: 'assigned', 'unassigned';
* `recipientTitle` - title of the recipient (first and last name if specified, email otherwise);
* `recipientEmail` - email of the recipient;
Parameter names must be wrapped using `${...}`. For example: `${action}`.
* `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:
You may also modify the value of the parameter with one of the suffixes:
* `upperCase`, for example - `${recipientFirstName:upperCase}`
* `upperCase`, for example - `${recipientFirstName:upperCase}`
* `lowerCase`, for example - `${recipientFirstName:lowerCase}`
* `lowerCase`, for example - `${recipientFirstName:lowerCase}`
* `capitalize`, for example - `${recipientFirstName:capitalize}`
* `capitalize`, for example - `${recipientFirstName:capitalize}`
<divclass="divider"></div>
<divclass="divider"></div>
##### Examples
##### 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:
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
```text
Alarm '${alarmType}' - ${action:upperCase}
Alarm '${alarmType}' - ${action:upperCase}
@ -49,9 +54,10 @@ will be transformed to:
```text
```text
Alarm 'High Temperature' - ASSIGNED
Alarm 'High Temperature' - ASSIGNED
{:copy-code}
```
```
<br/>
The following template:
The following template:
```text
```text
@ -63,7 +69,6 @@ will be transformed to:
```text
```text
Alarm 'High Temperature' (Critical) was assigned to user
Alarm 'High Temperature' (Critical) was assigned to user
* *recipientLastName* - last name of the recipient;
* `status` - one of: 'enabled', 'warning', 'disabled';
* *feature* - API feature for which the limit is applied; one of: 'Device API', 'Telemetry persistence', 'Rule Engine execution', 'JavaScript functions execution', 'Email messages', 'SMS messages', 'Alarms';
* `unitLabel` - name of the limited unit; one of: 'message', 'data point', 'Rule Engine execution',
* *status* - one of: 'enabled', 'warning', 'disabled';
* *unitLabel* - name of the limited unit; one of: 'message', 'data point', 'Rule Engine execution', 'JavaScript execution', 'email message', 'SMS message', 'alarm';
* `limit` - the limit on used feature units;
* *limit* - the limit on used feature units;
* `currentValue` - current number of used units;
* *currentValue* - current number of used units;
* `tenantId` - id of the tenant;
* *tenantId* - id of the tenant;
* `tenantName` - name of the tenant;
* *tenantName* - name of the tenant;
* `recipientTitle` - title of the recipient (first and last name if specified, email otherwise);
* `recipientEmail` - email of the recipient;
Parameter names must be wrapped using `${...}`. For example: `${recipientFirstName}`.
* `recipientFirstName` - first name of the recipient;
* `recipientLastName` - last name of the recipient;
Parameter names must be wrapped using `${...}`. For example: `${recipientFirstName}`.
You may also modify the value of the parameter with one of the suffixes:
You may also modify the value of the parameter with one of the suffixes:
* `upperCase`, for example - `${recipientFirstName:upperCase}`
* `upperCase`, for example - `${recipientFirstName:upperCase}`
* `lowerCase`, for example - `${recipientFirstName:lowerCase}`
* `lowerCase`, for example - `${recipientFirstName:lowerCase}`
* `capitalize`, for example - `${recipientFirstName:capitalize}`
* `capitalize`, for example - `${recipientFirstName:capitalize}`
<divclass="divider"></div>
<divclass="divider"></div>
##### Examples
##### Examples
Let's assume tenant's devices pushed 8K messages with the max allowed number of 10K and warn threshold in tenant profile set to 0.8 (80%). The following template:
Let's assume tenant's devices pushed 8K messages with the max allowed number of 10K
and warn threshold in tenant profile set to 0.8 (80%). The following template:
```text
```text
${feature} feature - ${status:upperCase} (usage: ${currentValue} out of ${limit} ${unitLabel}s)
${feature} feature - ${status:upperCase} (usage: ${currentValue} out of ${limit} ${unitLabel}s)
@ -41,7 +46,6 @@ will be transformed to:
```text
```text
Device API feature - WARNING (usage: 8000 out of 10000 messages)
Device API feature - WARNING (usage: 8000 out of 10000 messages)
Seraphym-Tuhai
3 years ago