Rule Chain templates

What Is an Edge Rule Chain Template?

An Edge Rule Chain template is a predefined Rule Chain in ThingsBoard, designed specifically for use with ThingsBoard Edge. The Rule Chain template does not run on the Server. Instead, it serves merely as a template.

For the older versions of ThingsBoard Edge, the Rule chain has to be assigned to an Edge instance before use. Only then will it work and process data from devices according to its configuration.

Starting with Edge version 4.0, the Rule chain can be created and edited right on the Edge instance.

Creating Rule Chain Template on the Edge

• Sign in to your ThingsBoard Edge PE instance and go to the Rule chains section. To add a new Rule chain, click the ”+” button in the top right corner, and choose the “Create new rule chain” option.

• In the pop-up window, enter a name for the new rule chain and click the “Add” button to continue configuring the rule chain.

• The rule chain is now listed, usually at the top. Click it to begin editing.

• Configure your rule nodes and flow. Once the configuration is complete, click the “Apply changes” button.

Creating Rule Chain Template on the Server

• Sign in to your ThingsBoard PE instance and go to the Edge Management > Rule chain templates section. To add a new Rule chain, click the ”+” button in the top right corner and choose the “Create new rule chain” option.

• Enter a name for your rule chain, such as “Remote Farm”. Click the “Add” button to continue configuring the rule chain.

• The rule chain template is now listed, usually at the top. Click it to begin editing.

• Within the template, configure your rule nodes and flow. Once the configuration is complete, click the “Apply changes” button. Note: This step does not activate the rule chain on the server, it simply prepares it for deployment to an Edge.

Assigning the Rule Chain Template to the Edge

• Go to the Edge management > Instances section and lick the “Manage rule chains” button.

• To assign the Rule chain template to the Edge, click the ”+” button.

• In the pop-up window, select the rule chain from the drop-down menu and click the “Assign” button.

• The assigned rule chain template now appears at the top of the list. Assigning the rule chain template to the Edge instance enables the rule chain to process data from Edge devices according to the template configurations.

Verify Assigned Rule Chain on the Edge

• Sign in to your ThingsBoard Edge PE instance and go to the Rule chains section. To view the Rule chain configuration, click on the rule chain.

• Verify that all settings and configurations are accurately reflected.

Next Steps

• Getting started guide - Provide quick overview of main ThingsBoard Edge features. Designed to be completed in 15-30 minutes:

• Installation guides - Learn how to setup ThingsBoard Edge on various available operating systems and connect to ThingsBoard Server.

• Edge Rule Engine:

  • Provision Rule Chains from cloud to edge - Learn how to provision edge rule chains from cloud to edge.
• Security:
  • gRPC over SSL/TLS - Learn how to configure gRPC over SSL/TLS for communication between edge and cloud.

• Features:

  • Edge Status - Learn about Edge Status page on ThingsBoard Edge.

  • Cloud Events - Learn about Cloud Events page on ThingsBoard Edge.

• Use cases:

  • Manage alarms and RPC requests on edge devices - This guide will show how to generate local alarms on the edge and send RPC requests to devices connected to edge:

  • Data filtering and traffic reduce - This guide will show how to send to cloud from edge only filterd amount of device data:

• Roadmap - ThingsBoard Edge roadmap.