Data Trigger Documentation

Version: 2.2.1

Retrieved: 2025-10-09 15:15:50

Data Trigger

The module collects messages and creates an output based on a defined list of trigger definition conditions. When a trigger is fired an output message is sent. Triggers can be evaluated on momentary values or when a condition has been true for a specified time. The trigger will only be triggered again if the conditions evaluate to false and then back to true again.

Settings

The Trigger definitions can be specified in a resource file. The resource file must contain a list of trigger definitions as defined below. In combination with this, manually added triggers can be added through the input table Additional Trigger Definitions, with the format described below. The Trigger definitions can also be stored in a JSON file locally on the node at Trigger definitions path. If set, the module will load the definitions when the flow is started. The definitions can also be updated through an input message to the module. The module will update the local file when updates are received. The trigger definitions list must be a list of objects with the following properties.

Trigger definitions

Condition object

Updating Trigger definitions during flow execution

If Trigger definitions path is set and Trigger Definitions (Resource) is not set, a message can be sent to the module when the flow is running. The module will then update the internal Trigger definitions representation and store the whole set at Trigger definitions path if set. The input message must contain the property triggerDefinitions property that must be an array of trigger definitions, as described above.

Setting the deleted flag will make the module remove the flagged trigger from it's set of triggers. Any new triggers will be added and updated will replace the old one. When an existing trigger is updated, it's state will be cleared so any pending triggers will be removed and the trigger will be evaluated the first time next time a message is received that may fire the trigger.

Any error in the input message will trigger an output message with an error message for the invalid configuration. That specific trigger causing the error will not be updated or removed.

Input

The input must be an object or a list of objects. The Timestamp Property may be part of the object or each object in the list. If not, the timestamp will be taken from the top level of the incoming message. If that is not set, the current UTC time will be used. Note that if several values of a property is sent in the array, only one of the values will be used if they don't have an individual timestamp.

The latest known value of a property will be stored together with the timestamp of the object. This will be cleared on flow restart.

Output

An output will be sent when a trigger:

• Is active
• The evaluation of the condition changes from false to true
• The duration (if any) is fulfilled

Format of output message:

Examples

Example 1 Value is set on property with a single condition

# Settings:

Source Property = data
Timestamp Property = timestamp
Name Property =
Value Property =
Keep Properties = false
Convert values with best effort = false
Trigger Definitions (Resource) =
Trigger definitions path = /data/triggerdefinitions.json
Target Property = data
Additional Trigger Definitions = []

# Data trigger definition (placed at /data/triggerdefinitions.json on the node):
[
	{
		"id": "14f84789-8bc4-487d-8363-b5dcf5320ab8",
		"name": "Trigger1",
		"isActive": true,
		"edge": "Leading",
		"logicOperation": "And",
		"conditions": [
			{
				"sourceProperty": "temperature",
				"condition": "LessThan",
				"value": 20,
				"durationInSeconds": 0
			}
		],
		"metadata": {
			"additionalNumber": 23
		}
	}
]

# Input message:
{
	"data": [
		{
			"temperature": 15,
			"timestamp": "2023-10-01T14:00:00.000Z"
		}
	]
}

# Output message:
The first element in the message will trigger an output as:
{
	"data": {
		"id": "14f84789-8bc4-487d-8363-b5dcf5320ab8",
		"name": "Trigger1",
		"timestamp": "2023-10-01T17:00:00.000Z",
		"triggerTimestamp": "2023-10-01T14:00:00.000Z",
		"metadata": {
			"additionalNumber": 23
		}
	}
}

Example 2 Value is set from template property with several conditions and duration

This example illustrates that several conditions can be combined. It gives an idea how the duration mechanism works as a condition is only fulfilled when it's value has the desired value for a certain time.

# Settings:

Source Property = data
Timestamp Property = timestamp
Name Property = name
Value Property = value
Keep Properties = false
Convert values with best effort = false
Trigger Definitions (Resource) =
Trigger definitions path = /data/triggerdefinitions.json
Additional Trigger Definitions = []
Target Property = data

# Data trigger definition (placed at /data/triggerdefinitions.json on the node):
[
	{
		"id": "14f84789-8bc4-487d-8363-b5dcf5320ab8",
		"name": "Trigger1",
		"isActive": true,
		"edge": "Leading",
		"logicOperation": "And",
		"conditions": [
			{
				"sourceProperty": "temperature",
				"condition": "LessThan",
				"value": 10,
				"durationInSeconds": 10
			},
			{
				"sourceProperty": "temperature",
				"condition": "LessThan",
				"value": "{maxValue}",
				"durationInSeconds": 0
			}
		],
		"metadata": {
			"additionalNumber": 23
		}
	}
]

# Input message:
{
	"data": [
		{
			"name": "temperature",
			"value": 15,
			"maxValue": 20,
			"timestamp": "2023-10-01T14:00:00.000Z"
		},
		{
			"name": "temperature",
			"value": 5,
			"timestamp": "2023-10-01T14:01:00.000Z"
		},
		{
			"name": "temperature",
			"value": 50,
			"timestamp": "2023-10-01T14:01:11.000Z"
		}
	]
}

# Output message:
The first element in the message will not trigger an output as all conditions are not fulfilled. The second element will neither trigger an output as the duration the condition should have been fulfilled is not reached. The third element in the message will however trigger an output as both conditions have been fulfilled the required time, although the value sent does not fulfill the conditions at that point:
{
	"data": {
		"id": "14f84789-8bc4-487d-8363-b5dcf5320ab8",
		"name": "Trigger1",
		"timestamp": "2023-10-01T17:00:00.000Z",
		"triggerTimestamp": "2023-10-01T14:01:11.000Z",
		"metadata": {
			"additionalNumber": 23
		}
	}
}