dendi-wang/thingsboard
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update notification templates help pages

Browse Source
This commit is contained in:
ViacheslavKlimov 2023-03-27 14:37:47 +03:00
parent 408eb0bc02
commit 9a34218d1c
8 changed files with 23 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
ui-ngx/src/assets/help/en_US/notification/alarm.md
View File

@ -21,7 +21,7 @@ Available template parameters:
* *alarmOriginatorId* - the alarm originator entity id as uuid string; * *alarmOriginatorId* - the alarm originator entity id as uuid string;
Parameter names must be wrapped using `${...}`. For example: `${action}`. Parameter names must be wrapped using `${...}`. For example: `${action}`.
You may also modify the value of the parameter with one of the sufixes: 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}`
@ -55,7 +55,7 @@ ${alarmOriginatorEntityType:capitalize} '${alarmOriginatorName}'
will be transformed to: will be transformed to:
```text ```text
DEVICE - Sensor A Device - Sensor A
{:copy-code} {:copy-code}
``` ```

5
ui-ngx/src/assets/help/en_US/notification/alarm_assignment.md
View File

@ -22,10 +22,13 @@ Available template parameters:
* *assigneeFirstName* - first name of the assignee; * *assigneeFirstName* - first name of the assignee;
* *assigneeLastName* - last name of the assignee; * *assigneeLastName* - last name of the assignee;
* *assigneeId* - the id of the assignee as uuid string; * *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'; * *action* - one of: 'assigned', 'unassigned';
Parameter names must be wrapped using `${...}`. For example: `${action}`. Parameter names must be wrapped using `${...}`. For example: `${action}`.
You may also modify the value of the parameter with one of the sufixes: 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}`

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

@ -19,11 +19,13 @@ Available template parameters:
* *alarmOriginatorName* - the name of the alarm originator, e.g. 'Sensor T1'; * *alarmOriginatorName* - the name of the alarm originator, e.g. 'Sensor T1';
* *alarmOriginatorId* - the alarm originator entity id as uuid string; * *alarmOriginatorId* - the alarm originator entity id as uuid string;
* *comment* - text of the comment; * *comment* - text of the comment;
* *userName* - name of the user who made the comment;
* *action* - one of: 'added', 'updated'; * *action* - one of: 'added', 'updated';
* *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;
Parameter names must be wrapped using `${...}`. For example: `${action}`. Parameter names must be wrapped using `${...}`. For example: `${action}`.
You may also modify the value of the parameter with one of the sufixes: 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}`

4
ui-ngx/src/assets/help/en_US/notification/device_inactivity.md
View File

@ -15,10 +15,10 @@ Available template parameters:
* *deviceName* - the device name; * *deviceName* - the device name;
* *deviceLabel* - the device label; * *deviceLabel* - the device label;
* *deviceType* - the device type; * *deviceType* - the device type;
* *actionType* - one of: 'inactive', 'active'; * *actionType* - one of: 'inactive', 'active'; // TODO: fix and rename the type
Parameter names must be wrapped using `${...}`. For example: `${recipientFirstName}`. Parameter names must be wrapped using `${...}`. For example: `${recipientFirstName}`.
You may also modify the value of the parameter with one of the sufixes: 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}`

4
ui-ngx/src/assets/help/en_US/notification/entities_limit.md
View File

@ -15,9 +15,11 @@ Available template parameters:
* *currentCount* - the current count of entities; * *currentCount* - the current count of entities;
* *limit* - the limit on number of entities; * *limit* - the limit on number of entities;
* *percents* - the percent from the notification rule configuration; * *percents* - the percent from the notification rule configuration;
* *tenantId* - id of the tenant;
* *tenantName* - name of the tenant;
Parameter names must be wrapped using `${...}`. For example: `${recipientFirstName}`. Parameter names must be wrapped using `${...}`. For example: `${recipientFirstName}`.
You may also modify the value of the parameter with one of the sufixes: 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}`

8
ui-ngx/src/assets/help/en_US/notification/entity_action.md
View File

@ -15,11 +15,13 @@ Available template parameters:
* *entityId* - the entity id as uuid string; * *entityId* - the entity id as uuid string;
* *entityName* - the name of the entity; * *entityName* - the name of the entity;
* *actionType* - one of: 'added', 'updated', 'deleted'; * *actionType* - one of: 'added', 'updated', 'deleted';
* *originatorUserId* - the user who made the action; * *userId* - id of the user who made the action;
* *originatorUserName* - the user who made the action; // WHY no EMAIL, first, last, entityLabel (if applicable) * *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;
Parameter names must be wrapped using `${...}`. For example: `${recipientFirstName}`. Parameter names must be wrapped using `${...}`. For example: `${recipientFirstName}`.
You may also modify the value of the parameter with one of the sufixes: 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}`

2
ui-ngx/src/assets/help/en_US/notification/general.md
View File

@ -13,7 +13,7 @@ Available template parameters:
* *recipientLastName* - last name of the recipient; * *recipientLastName* - last name of the recipient;
Parameter names must be wrapped using `${...}`. For example: `${recipientFirstName}`. Parameter names must be wrapped using `${...}`. For example: `${recipientFirstName}`.
You may also modify the value of the parameter with one of the sufixes: 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}`

4
ui-ngx/src/assets/help/en_US/notification/rule_engine_lifecycle_event.md
View File

@ -11,7 +11,7 @@ Available template parameters:
* *recipientEmail* - email of the recipient; * *recipientEmail* - email of the recipient;
* *recipientFirstName* - first name of the recipient; * *recipientFirstName* - first name of the recipient;
* *recipientLastName* - last name of the recipient; * *recipientLastName* - last name of the recipient;
* *componentType* - one of: 'rule chain', 'rule node'; * *componentType* - one of: 'Rule chain', 'Rule node';
* *componentId* - the component id as uuid string; * *componentId* - the component id as uuid string;
* *componentName* - the rule chain or rule node name; * *componentName* - the rule chain or rule node name;
* *ruleChainId* - the rule chain id as uuid string; * *ruleChainId* - the rule chain id as uuid string;
@ -21,7 +21,7 @@ Available template parameters:
* *error* - the error text; * *error* - the error text;
Parameter names must be wrapped using `${...}`. For example: `${recipientFirstName}`. Parameter names must be wrapped using `${...}`. For example: `${recipientFirstName}`.
You may also modify the value of the parameter with one of the sufixes: 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}`