Stop the war

Stand with Ukraine flag

Support Ukraine

Try it now Pricing
Cloud
Community Edition Professional Edition Cloud Edge PE Edge IoT Gateway License Server Trendz Analytics Mobile Application PE Mobile Application MQTT Broker
Documentation > Rule engine > Templatization
Getting Started
Devices Library Guides API FAQ
On this page

Templatization

Templatization is the process of using predefined templates to dynamically insert or substitute values into text. These templates serve as placeholders for variables that can be filled in later with actual data.

In the context of rule engine, templates are used to extract data from incoming messages during runtime. This is particularly helpful in the rule node configuration, where templatization allows for dynamic configuration by replacing static values in the configuration fields with real-time values from the incoming messages. This enables more flexible and automated handling of data, making it easier to perform conditional operations based on varying inputs.

Syntax

Templates start with a dollar sign ($), followed by brackets with a key name inside. Square brackets ([]) are used for message keys, while curly brackets ({}) are used for message metadata keys. For example:

  • $[messageKey] - will extract value of messageKey from incoming message.
  • ${metadataKey} - will extract value of metadataKey from incoming message metadata.

In the example above, messageKey and metadataKey represent any key name that may exist within the message or its metadata.

Example

Let’s review an example. First JSON is message, second is message metadata:

1
2
3
4
5
6
7
{
  "temperature": 26.5,
  "humidity": 75.2,
  "soilMoisture": 28.9,
  "windSpeed": 26.2,
  "location": "riverside"
}
1
2
3
4
5
{
  "deviceType": "weather_sensor",
  "deviceName": "weather1",
  "ts": "1685379440000"
}

Assume, we detected an unusually high wind speed and want to send this telemetry reading to some external REST API. Every reading needs to be associated with specific device and location - this information is available only in real-time. We can use templates extract necessary data and to construct URL for sending data:

example-base-url.com/report-reading?location=$[location]&deviceName=${deviceName}

This template will be resolved to:

example-base-url.com/report-reading?location=riverside&deviceName=weather1

Templates are ideal for scenarios where the specific values aren’t known at the time of configuration but will become available at runtime.

Notes

  • Templates can be combined with regular text. For example: “Fuel tanks are filled to $[fuelLevel]%”.
  • You can access nested keys in JSON object using dot notation: $[object.key].
  • If specified key is missing or value associated with that key is an object or an array, then template string will be returned unchanged.

To illustrate written above let’s review an example. Here’s content of a message:

1
2
3
4
5
6
7
8
9
10
{
    "number": 123.45,
    "string": "text",
    "boolean": true,
    "array": [1, 2, 3],
    "object": {
        "property": "propertyValue"
    },
    "null": null
}

Here’s a table with comparison between templates and extracted values:

Template Extracted value
$[number] 123.45
$[string] text
$[boolean] true
$[array] $[array]
$[object] $[object]
$[object.property] propertyValue
$[null] null
$[doesNotExist] $[doesNotExist]