Rule Chain Templates

• What Is an Edge Rule Chain Template?
• Creating Rule Chain Template on the Edge
• Creating Rule Chain Template on the Server
• Assigning the Rule Chain Template to the Edge
• Verify Assigned Rule Chain on the Edge
• Common Use Cases
  • Data Filtering
  • Local Alarms
  • Data Aggregation
  • Protocol Conversion
• Best Practices

What Is an Edge Rule Chain Template?

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

For older versions of IndustryOS 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

1. Sign in to your IndustryOS Edge 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.
2. In the pop-up window, enter a name for the new rule chain and click the “Add” button to continue configuring the rule chain.
3. The rule chain is now listed, usually at the top. Click it to begin editing.
4. Configure your rule nodes and flow. Once the configuration is complete, click the “Apply changes” button.

Creating Rule Chain Template on the Server

1. Sign in to your IndustryOS 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.
2. Enter a name for your rule chain, such as “Remote Farm”. Click “Add” to confirm the creation of your new rule chain template.
3. The rule chain template is now listed, usually at the top. Click it to begin editing.
4. 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

1. Go to the Edge management > Instances section and click the “Manage edge rule chains” button.
2. To assign the Rule chain template to the Edge, click the “+” button.
3. In the pop-up window, select the rule chain from the drop-down menu and click the “Assign” button.
4. 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

1. Sign in to your IndustryOS Edge instance and go to the Rule chains section. To view the Rule chain configuration, click on the rule chain.
2. Verify that all settings and configurations are accurately reflected.

Common Use Cases

Data Filtering

Create templates that filter telemetry data before sending to cloud, reducing bandwidth and costs.

Local Alarms

Implement templates that create and manage alarms locally on the edge without cloud dependency.

Data Aggregation

Aggregate telemetry data locally before pushing summarised information to the cloud.

Protocol Conversion

Convert between different protocols or data formats at the edge before cloud transmission.

Best Practices

1. Reusability: Design templates that can be used across multiple edge instances
2. Documentation: Add clear node descriptions for maintainability
3. Error Handling: Include proper error handling nodes
4. Testing: Test templates thoroughly before deployment
5. Versioning: Keep track of template versions and changes
6. Monitoring: Include debug nodes during development
7. Performance: Optimise rule chains for edge device capabilities