Action Nodes execute various actions based on incoming Message.

Create Alarm Node
Clear Alarm Node
Delay Node
Generator Node
Log Node
RPC Call Reply Node
RPC Call Request Node
Save Attributes Node
Save Timeseries Node
Save to Custom Table
Assign To Customer Node
Unassign From Customer Node
Create Relation Node
Delete Relation Node
GPS Geofencing Events Node
Push to cloud
Push to edge

Create Alarm Node

*Since TB Version 2.0*

This Node tries to load latest Alarm with configured Alarm Type for Message Originator. If Uncleared Alarm exist, then this Alarm will be updated, otherwise a new Alarm will be created.

Node Configuration:

Alarm Details Builder script
Alarm Type - any string that represents Alarm Type
Alarm Severity - {CRITICAL | MAJOR | MINOR | WARNING | INDETERMINATE}
is Propagate - whether Alarm should be propagated to all parent related entities.

Note: Since TB Version 2.3.0 the rule node has the ability to:

read alarm config from message:
get alarm type using pattern with fields from message metadata:

Note: Since TB Version 2.4.3 the rule node has the ability to:

filter propagation to parent entities by relation types:

Alarm Details Builder script used for generating Alarm Details JsonNode. It is useful for storing additional parameters inside Alarm. For example you can save attribute name/value pair from Original Message payload or Metadata.

Alarm Details Builder script should return details object.

Message payload can be accessed via msg property. For example msg.temperature
Message metadata can be accessed via metadata property. For example metadata.customerName
Message type can be accessed via msgType property. For example msgType

Optional: previous Alarm Details can be accessed via metadata.prevAlarmDetails. If previous Alarm does not exist, this field will not be present in Metadata. Note that metadata.prevAlarmDetails is a raw String field and it needs to be converted into object using this construction:

var details = {};
if (metadata.prevAlarmDetails) {
    details = JSON.parse(metadata.prevAlarmDetails);
}

Alarm Details Builder script function can be verified using Test JavaScript function.

Example of Details Builder Function

This function takes count property from previous Alarm and increment it. Also put temperature attribute from inbound Message payload into Alarm details.

var details = {temperature: msg.temperature, count: 1};

if (metadata.prevAlarmDetails) {
    var prevDetails = JSON.parse(metadata.prevAlarmDetails);
    if(prevDetails.count) {
        details.count = prevDetails.count + 1;
    }
}

return details;

Alarm created/updated with those properties:

Alarm details - object returned from Alarm Details Builder script
Alarm status - if new alarm -> ACTIVE_UNACK. If existing Alarm -> does not changed
Severity - value from Node Configuration
Propagation - value from Node Configuration
Alarm type - value from Node Configuration
Alarm start time - if new alarm -> current system time. If existing Alarm -> does not changed
Alarm end time - current system time

Outbound message will have the following structure:

Message Type - ALARM
Originator - the same originator from inbound Message
Payload - JSON representation of new Alarm that was created/updated
Metadata - all fields from original Message Metadata

After new Alarm created, Outbound message will contain additional property inside Metadata - isNewAlarm with true value. Message will be passed via Created chain.

After existing Alarm updated, Outbound message will contain additional property inside Metadata - isExistingAlarm with true value. Message will be passed via Updated chain.

Here is an example of Outbound Message payload

{
  "tenantId": {
    "entityType": "TENANT",
    "id": "22cd8888-5dac-11e8-bbab-ad47060c9bbb"
  },
  "type": "High Temperature Alarm",
  "originator": {
    "entityType": "DEVICE",
    "id": "11cd8777-5dac-11e8-bbab-ad55560c9ccc"
  },
  "severity": "CRITICAL",
  "status": "ACTIVE_UNACK",
  "startTs": 1526985698000,
  "endTs": 1526985698000,
  "ackTs": 0,
  "clearTs": 0,
  "details": {
    "temperature": 70,
    "ts": 1526985696000
  },
  "propagate": true,
  "id": "33cd8999-5dac-11e8-bbab-ad47060c9431",
  "createdTime": 1526985698000,
  "name": "High Temperature Alarm"
}

More details about Alarms in the IoT Hub can be found in this tutorial

You can see the real life example, where this node is used, in the next tutorial:

Create and Clear Alarms

Clear Alarm Node

*Since TB Version 2.0*

This Node loads the latest Alarm with configured Alarm Type for Message Originator and Clear the Alarm if it exist.

Node Configuration:

Alarm Details Builder script
Alarm Type - any string that represents Alarm Type

Note: Since TB Version 2.3.0 the rule node has the ability to get alarm type using pattern with fields from message metadata:

Alarm Details Builder script used for updating Alarm Details JsonNode. It is useful for storing additional parameters inside Alarm. For example you can save attribute name/value pair from Original Message payload or Metadata.

Alarm Details Builder script should return details object.

Message payload can be accessed via msg property. For example msg.temperature
Message metadata can be accessed via metadata property. For example metadata.customerName
Message type can be accessed via msgType property. For example msgType
Current Alarm Details can be accessed via metadata.prevAlarmDetails.

Note that metadata.prevAlarmDetails is a raw String field and it needs to be converted into object using this construction:

var details = {};
if (metadata.prevAlarmDetails) {
    details = JSON.parse(metadata.prevAlarmDetails);
}

Alarm Details Builder script function can be verified using Test JavaScript function.

Example of Details Builder Function

This function takes count property from previous Alarm and increment it. Also put temperature attribute from inbound Message payload into Alarm details.

var details = {temperature: msg.temperature, count: 1};

if (metadata.prevAlarmDetails) {
    var prevDetails = JSON.parse(metadata.prevAlarmDetails);
    if(prevDetails.count) {
        details.count = prevDetails.count + 1;
    }
}

return details;

This Node updates Current Alarm:

change alarm status to CLEARED_ACK if it was already acknowledged, otherwise to CLEARED_UNACK
set clear time to current system time
update Alarm details with new object returned from Alarm Details Builder script

In case when Alarm does not exist or it is already Cleared Alarm, original Message will be passed to the next nodes via False chain.

Otherwise new Message will be passed via Cleared chain.

Outbound message will have the following structure:

Message Type - ALARM
Originator - the same originator from inbound Message
Payload - JSON representation of Alarm that was cleared
Metadata - all fields from original Message Metadata. Also additional property inside Metadata will be added -> isClearedAlarm with true value.

Here is an example of Outbound Message payload

{
  "tenantId": {
    "entityType": "TENANT",
    "id": "22cd8888-5dac-11e8-bbab-ad47060c9bbb"
  },
  "type": "High Temperature Alarm",
  "originator": {
    "entityType": "DEVICE",
    "id": "11cd8777-5dac-11e8-bbab-ad55560c9ccc"
  },
  "severity": "CRITICAL",
  "status": "CLEARED_UNACK",
  "startTs": 1526985698000,
  "endTs": 1526985698000,
  "ackTs": 0,
  "clearTs": 1526985712000,
  "details": {
    "temperature": 70,
    "ts": 1526985696000
  },
  "propagate": true,
  "id": "33cd8999-5dac-11e8-bbab-ad47060c9431",
  "createdTime": 1526985698000,
  "name": "High Temperature Alarm"
}

More details about Alarms in the IoT Hub can be found in this tutorial

You can see the real life example, where this node is used, in the next tutorial:

Create and Clear Alarms

Delay Node

*Since TB Version 2.1*

Delays incoming messages for configurable period.

Configuration:

Period in seconds - specifies the value of the period during which incoming message should be suspended
Maximum pending messages - specifies the amount of maximum allowed pending messages (queue of suspended messages)

When delay period for particular incoming message will be reached it will be removed from pending queue and routed to the next nodes via Success chain.

Each next message will be routed via Failure chain if the maximum pending messages limit will be reached.

Generator Node

*Since TB Version 2.0*

Generates Messages with configurable period. JavaScript function is used for message generation.

Node Configuration:

Message generation frequency in seconds
Message originator
JavaScript function that will generate the actual message.

JavaScript function receive 3 input parameters:

prevMsg - is a previously generated Message payload.
prevMetadata - is a previously generated Message metadata.
prevMsgType - is a previously generated Message type.

Script should return the following structure:

{   
    msg: new payload,
    metadata: new metadata,
    msgType: new msgType 
}

All fields in resulting object are optional and will be taken from previously generated Message if not specified.

Outbound Message from this Node will be new Message that was constructed using configured JavaScript function.

JavaScript generator function can be verified using Test JavaScript function.

This node can be used for Rule Chain debugging purposes.

Log Node

*Since TB Version 2.0*

Transform incoming Message with configured JavaScript function to String and log final value into the IoT Hub log file.

INFO log level is used for logging.

JavaScript function receive 3 input parameters

metadata - is a Message metadata.
msg - is a Message payload.
msgType - is a Message type.

Script should return String value.

JavaScript transform function can be verified using Test JavaScript function.

You can see the real life example, where this node is used, in the next tutorial:

Reply to RPC Calls

RPC Call Reply Node

*Since TB Version 2.0*

Sends response to the RPC Call originator. All incoming RPC requests are passed through Rule Chain as Messages. Also all RPC requests have request ID field. It is used for mapping requests and responses. Message Originator must be a Device entity because RPC response is initiated to the Message Originator.

Node configuration has special request ID field mapping. If the mapping is not specified, requestId metadata field is used by default.

RPC request can be received via different transports:

MQTT
HTTP
CoAP

Message payload example:

{
  "method": "setGpio",
  "params": {
    "pin": "23",
    "value": 1
  }
}

Message will be routed via Failure chain in the following cases:

Inbound Message originator is not a Device entity
Request id is not present in the Message metadata
Inbound Message payload is empty

For more details how RPC works in the IoT Hub, please read RPC capabilities Article.

You can see the real life example, where this node is used, in the next tutorial:

Reply to RPC Calls

RPC Call Request Node

*Since TB Version 2.0*

Sends RPC requests to the Device and routing response to the next Rule nodes. Message Originator must be a Device entity as RPC request can be initiated only to device.

Node configuration has Timeout field used to specify timeout waiting for response from device.

Message payload must have correct format for RPC request. It must contains method and params fields. Example:

{
  "method": "setGpio",
  "params": {
    "pin": "23",
    "value": 1
  }
}

If Message Payload contains requestId field, its value used to identify RPC request to the Device. Otherwise random requestId will be generated.

Outbound Message will have same originator and metadata as in inbound Message. Response from the Device will be added into Message payload.

Message will be routed via Failure chain in the following cases:

Inbound Message originator is not a Device entity
Inbound Message has missed method or params fields
If Node will not receive a response during configured timeout

Otherwise Message will be routed via Success chain.

For more details how RPC works in the IoT Hub, please read RPC capabilities article.

Save Attributes Node

*Since TB Version 2.0*

Stores attributes from incoming Message payload to the database and associate them to the Entity, that is identified by the Message Originator. Configured scope is used to identify attributes scope.

Supported scope types:

Client attributes
Shared attributes
Server attributes

Expects messages with POST_ATTRIBUTES_REQUEST message type. If message Type is not POST_ATTRIBUTES_REQUEST, Message will be routed via Failure chain.

When attributes are uploaded over existing API (HTTP / MQTT / CoAP / etc.) Message with correct payload and type will be passed into Input node of the Root Rule Chain.

In cases when it is required to trigger attributes saving inside Rule Chain, the Rule Chain should be configured to transform Message payload to the expected format and set message type to POST_ATTRIBUTES_REQUEST. It could be done using Script Transformation Node.

Expected Message Payload example:

{
  "firmware_version": "1.0.1",
  "serial_number": "SN-001"
}

After successful attributes saving, original Message will be passed to the next nodes via Success chain, otherwise Failure chain is used.

Save Timeseries Node

*Since TB Version 2.0*

Stores Timeseries data from incoming Message payload to the database and associate them to the Entity, that is identified by the Message Originator. Configured TTL seconds is used for timeseries data expiration. 0 value means that data will never expire.

Expects messages with POST_TELEMETRY_REQUEST message type. If message Type is not POST_TELEMETRY_REQUEST, Message will be routed via Failure chain.

When timeseries data is published over existing API (HTTP / MQTT / CoAP / etc.) Message with correct payload and type will be passed into Input node of the Root Rule Chain.

In cases when it is required to trigger timeseries data saving inside Rule Chain, the Rule Chain should be configured to transform Message payload
to the expected format and set message type to POST_TELEMETRY_REQUEST. It could be done using Script Transformation Node.

Message Metadata must contain ts field. This field identifies timestamp in milliseconds of published telemetry.

Also, if Message Metadata contains TTL field, its value is used for timeseries data expiration, otherwise TTL from Node Configuration is used.

Expected Message Payload example:

{  
  "values": {
    "key1": "value1",
    "key2": "value2"
  }
}

After successful timeseries data saving, original Message will be passed to the next nodes via Success chain, otherwise Failure chain is used.

Save to Custom Table

*Since TB Version 2.3.1*

Node stores data from incoming Message payload to the Cassandra database into the predefined custom table that should have cs_tb_ prefix, to avoid the data insertion to the common TB tables.

Please note, that rule node can be used only for Cassandra DB.

Configuration:

Administrator should set the custom table name without prefix: cs_tb_.

Administrator can configure the mapping between the Message field names and Table columns name. If the mapping key is entityId, that is identified by the Message Originator, then to the appropriate column name(mapping value) will be write the message originator id.

If specified message field does not exist or is not a JSON Primitive, the outbound message will be routed via Failure chain, otherwise, the message will be routed via Success chain.

Assign To Customer Node

*Since TB Version 2.2*

Assign Message Originator Entity to Customer.

Following Message Originator types are allowed: Asset, Device, Entity View, Dashboard.

Finds target Customer by customer name pattern and then assign Originator Entity to this customer.

Will create new Customer if it doesn’t exists and Create new Customer if not exists is set to true.

Configuration:

Customer name pattern - can be set direct customer name or pattern can be used, that will be resolved to the real customer name using Message metadata.
Create new customer if not exists - if checked will create new customer if it doesn’t exist.
Customers cache expiration time - specifies maximum time interval is seconds allowed to store found customers records. 0 value means that records will never expire.

Message will be routed via Failure chain in the following cases:

When Originator entity type is not supported.
Target customer doesn’t exist and Create customer if not exists is unchecked.

In other cases Message will be routed via Success chain.

Unassign From Customer Node

*Since TB Version 2.2*

Unassign Message Originator Entity from Customer.

Following Message Originator types are allowed: Asset, Device, Entity View, Dashboard.

Finds target Customer by customer name pattern and then unassign Originator Entity from this customer.

Configuration:

Customer name pattern - can be set direct customer name or pattern can be used, that will be resolved to the real customer name using Message metadata.
Customers cache expiration time - specifies maximum time interval is seconds allowed to store found customers records. 0 value means that records will never expire.

Message will be routed via Failure chain in the following cases:

When Originator entity type is not supported.
Target customer doesn’t exist.

In other cases Message will be routed via Success chain.

Create Relation Node

*Since TB Version 2.2.1*

Create the relation from the selected entity to originator of the message by type and direction.

Following Message Originator types are allowed: Asset, Device, Entity View, Customer, Tenant, Dashboard.

Finds target Entity by metadata key patterns and then create a relation between Originator Entity and the target entity.

If selected entity type Asset, Device or Customer rule node will create new Entity if it doesn’t exist and selected checkbox: Create new Entity if not exists.

Note: if selected entity type Asset or Device you need to set two patterns:

entity name pattern;
entity type pattern.

Otherwise, only name pattern should be set.

Configuration:

Direction - following types are allowed: From, To.
Relation type - type of directed connections to message originator entity. Default types Contains and Manages can be selected from the drop-down list.
Name pattern and Type pattern - can be set direct entity name/type or pattern can be used, that will be resolved to the real entity name/type using Message metadata.
Entities cache expiration time - specifies maximum time interval is seconds allowed to store found target entity records. 0 value means that records will never expire.

Message will be routed via Failure chain in the following cases:

When Originator entity type is not supported.
Target entity doesn’t exist.

In other cases Message will be routed via Success chain.

Note: Since TB Version 2.3 the rule node has the ability to:

remove current relations from the originator of the incoming message based on direction and type:
change the originator of the incoming message to the selected entity and process outboud messages as messages from another entity:

Delete Relation Node

*Since TB Version 2.2.1*

Delete the relation from the selected entity to originator of the message by type and direction.

Following Message Originator types are allowed: Asset, Device, Entity View, Customer, Tenant, Dashboard.

Finds target Entity by entity name pattern and then delete a relation between Originator Entity and this entity.

Configuration:

Direction - following types are allowed: From, To.
Relation type - type of directed connections to message originator entity. Default types Contains and Manages can be selected from the drop-down list.
Name pattern - can be set direct entity name or pattern can be used, that will be resolved to the real entity name using Message metadata.
Entities cache expiration time - specifies maximum time interval is seconds allowed to store found target entity records. 0 value means that records will never expire.

Message will be routed via Failure chain in the following cases:

When Originator entity type is not supported.
Target entity doesn’t exist.

In other cases Message will be routed via Success chain.

Note: Since TB Version 2.3 the rule node has the ability to deletes relation from the originator of the incoming message to the specified entity or to the list of entities based on direction and type by disabling the following checkbox in the rule node configuration:

GPS Geofencing Events Node

*Since TB Version 2.3.1*

Produces incoming messages by GPS based parameters. Extracts latitude and longitude from incoming message data or metadata and returns different events based on configuration parameters (geo fence).

The rule node fetches perimeter information from message metadata by default. If Fetch perimeter information from message metadata is unchecked, additional information should be configured.

Fetch perimeter information from message metadata

There are two options of area definition based on the perimeter type:

Polygon

Metadata of the incoming message must include key with name perimeter and following data structure:

[[lat1,lon1],[lat2,lon2], ... ,[latN,lonN]]

Circle

"centerLatitude": "value1", "centerLongitude": "value2", "range": "value3"

All values for these keys are in double-precision floating-point data type.

The "rangeUnit" key requires specific value from a list of METER, KILOMETER, FOOT, MILE, NAUTICAL_MILE (capital letters obligatory).

Fetch perimeter information from node configuration

There are two options of area definition based on the perimeter type:

Polygon

Circle

Event Types

There are 4 types of events managed by geofencing rule node:

Entered — is reporting whenever latitude and longitude from the incoming message to belong the required perimeter area for the first time;
Left — is reporting whenever latitude and longitude from the incoming message not belong the required perimeter area for the first time;
Inside and Outside events are used to report current status.

Administrator can configure duration time threshold for reporting inside or outside event. For example, whenever minimal inside time is set to 1 minute the message originator is considered as being inside the perimeter 60 seconds after entering the area. Minimal outside time defines whenever message originator is considered as out of the perimeter as well.

Failure chain will to be used when:

incoming message has no configured latitude or longitude key in data or metadata.
missing perimeter definition;

Push to cloud

*Since TB Version 3.3*

Push messages from edge to cloud. This node used only on edge to push messages from edge to cloud. Once message arrived into this node it’s going to be converted into cloud event and saved to the local database. Node doesn’t push messages directly to cloud, but stores event(s) in the cloud queue. Supports next originator types:

DEVICE
ASSET
ENTITY_VIEW
DASHBOARD
TENANT
CUSTOMER
EDGE

As well node supports next message types:

POST_TELEMETRY_REQUEST
POST_ATTRIBUTES_REQUEST
ATTRIBUTES_UPDATED
ATTRIBUTES_DELETED
ALARM

In case successful storage edge event to database message will be routed via Success route.

Message will be routed via Failure chain in the following cases:

Node was not able to save edge event to database
Unsupported originator type arrived
Unsupported message type arrived

Push to edge

*Since TB Version 3.3*

Push messages from cloud to edge. Message originator must be assigned to particular edge or message originator is EDGE entity itself. This node used only on cloud instances to push messages from cloud to edge. Once message arrived into this node it’s going to be converted into edge event and saved to the database. Node doesn’t push messages directly to edge, but stores event(s) in the edge queue. Supports next originator types:

DEVICE
ASSET
ENTITY_VIEW
DASHBOARD
TENANT
CUSTOMER
EDGE

As well node supports next message types:

POST_TELEMETRY_REQUEST
POST_ATTRIBUTES_REQUEST
ATTRIBUTES_UPDATED
ATTRIBUTES_DELETED
ALARM

In case successful storage edge event to database message will be routed via Success route.

Message will be routed via Failure chain in the following cases:

Node was not able to save edge event to database
Unsupported originator type arrived
Unsupported message type arrived

On this page

Action Nodes

Create Alarm Node

Clear Alarm Node

Delay Node

Generator Node

Log Node

RPC Call Reply Node

RPC Call Request Node

Save Attributes Node

Save Timeseries Node

Save to Custom Table

Assign To Customer Node

Unassign From Customer Node

Create Relation Node

Delete Relation Node

GPS Geofencing Events Node

Fetch perimeter information from message metadata

Fetch perimeter information from node configuration

Event Types

Push to cloud

Push to edge