entities_limit.md 1.52 KB

Entity count limit 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:

  • entityType - one of: 'Device', 'Asset', 'User', etc.;
  • currentCount - the current count of entities;
  • limit - the limit on number of entities;
  • percents - the percent from the notification rule configuration;
  • tenantId - id 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;
  • 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:

  • upperCase, for example - ${recipientFirstName:upperCase}
  • lowerCase, for example - ${recipientFirstName:lowerCase}
  • capitalize, for example - ${recipientFirstName:capitalize}
Examples

Let's assume the tenant created 400 devices with the max allowed number is 500 and rule threshold 0.8 (80%). The following template:

${entityType:capitalize}s usage: ${currentCount}/${limit} (${percents}%)
{:copy-code}

will be transformed to:

Devices usage: 400/500 (80%)