Configure Rule Chain

Overview

Step-by-step create a rule chain

1. Make sure you are in the configuration of the desired rule chain. -> Open the configuration of an existing rule chain.

2. Select Trigger Decide whether the rule should be triggered event-based or cycle-based and configure the asset or the time interval. -> Trigger

3. Add building blocks Drag and drop the required building blocks onto the workspace [L]. -> Add building blocks

4. Configure building blocks Click on the gear icon in the building block to make specific settings such as asset, attribute, or conditions. -> Configure a building block

5. Connect building blocks Connect the building blocks by dragging a line from an output pin to an input pin (note the same colors). -> Connect building blocks

6. Check for errors Use the error window to locate and fix errors. -> Errors

7. Set order Determine the execution order of the building blocks in "Set order" mode. -> Set order

8. Save changes

   Don't forget to save your changes [H]

Trigger

Under Trigger [B], you can choose whether the rule chain should be triggered event-based or cycle-based:

• Event-based: In this case, an asset and its attribute must be selected in [C]. Every time new data is written to this attribute, the rule chain is triggered automatically.

  
• Cycle-based: If the rule chain is to be triggered cyclically, you can set the number of seconds in [C] after which the rule chain is executed at regular intervals.

  

Code View

In the code view, you can view and edit the created JSON code of your rule chain. To activate the code view, click on [D]. As soon as this is activated, the JSON code of the rule chain is displayed, which contains the configuration and sequence of the nodes and conditions. You have the option to change the code directly to make specific adjustments instead of using the visual user interface.

Errors

When you click on Errors [E], a window opens that displays all existing errors in detail.

By clicking on the localization icon , you can jump directly to the element that caused the error in the linking field [L].

Set Order

Click on Set Order [F] to set the execution order of the nodes in the rule chain.

• As soon as this mode is activated, you can click on the nodes in the linking field [L] one after the other to determine the order of their execution.

• The sequence number is automatically incremented and appears in the top right of each node. This way, you can see directly in which order the nodes are executed.

Add Building Blocks

To create a rule, the desired building blocks can be dragged and dropped from the right-hand bar onto the [L] field. Each building block represents a specific function that can be used in the rule chain.

Configure a Building Block

To configure a building block, click on the gear icon in the top right of the building block. This opens a window in which the individual settings of the building block can be adjusted, e.g., the number of input and output pins, the asset to be used, the attributes, or the conditions.

Connect Building Blocks

Building blocks are connected to each other by dragging a line from an output pin to an input pin of another building block. Make sure that the output and input pins have the same color:

• Red stands for numerical values.

• Blue stands for boolean values (true/false).

Only pins with the same color can be connected to each other to ensure correct data transfer.

Dynamic Pin Expansion

If all existing pins of a building block are already occupied, a new pin appears when you hover over an occupied pin. This can be used to establish a connection to another input. As soon as the connection has been created, the new pin is automatically activated and permanently added.

Visualize Values after Execution

After a rule chain has been saved and executed at least once, the current values on the input and output pins of the building blocks become visible in purple. These values indicate which data is flowing through the rule chain and enable a direct check of the logic.

The Building Blocks

Building blocks are the basic elements of a rule chain. Each building block performs a specific function, e.g., retrieving data, setting conditions, or executing actions such as sending alarms or emails.

Building blocks can be connected to each other to control complex processes. The data flow is regulated via input and output pins, whereby only compatible pins can be connected to each other.

A note can also be stored in the configuration of a building block. This serves to document important information or explanations directly in the building block and facilitates the understanding of the rule chain.

Nodes

Get Data

Function: This building block reads heap data from a specific asset and its attribute.

Configurable settings:

• Output pins**: You can configure multiple output pins to send the data to various other building blocks.

• Asset and attribute**: The specific asset and the associated attribute whose data should be queried.

Write Data

Function: Sends data to a defined asset and writes the specified value to a specific attribute.

Configurable settings:

• Input pins:

  • Trigger pin: Triggers the writing of the value.

  • Value pin (optional): If this pin is used, the value from the connected source is adopted. Otherwise, the value can be entered manually.

• Asset, attribute: Selection of the asset and the associated attribute to which the data should be written.

• Value: If no value pin is used, a fixed value can be defined here.

Alarm

Function: Triggers an alarm for a specific asset when certain conditions are met.

Configurable settings:

• Asset**: The asset for which the alarm is triggered.

• Priority**: The urgency of the alarm (e.g., high, medium, low).

• Acknowledgment**: It can be specified whether the alarm must be acknowledged manually.

Ticket

Function: Creates a ticket for tracking problems or tasks that are connected to an asset.

Configurable settings:

• Asset: Selection of the asset to which the ticket refers.

• Priority: Determination of the urgency of the ticket (e.g., low, medium, high).

• Assigned person: Selection of the recipient who is responsible for processing the ticket.

• Reason: Selection of the reason for the ticket from predefined categories.

• Title: Entry of a meaningful title for the ticket.

• Description: Detailed description of the problem or task.

Send Email

Function: Sends an email notification to a specific person or group.

Configurable settings:

• Subject**: The subject of the email.

• To**: The email address(es) of the recipient.

• Text**: The actual content of the email.

Script

Function: The Script building block enables the execution of a script from the -> Script Engine within the rule chain. The execution is controlled by a boolean input value.

Configurable settings:

• Script: Selection of the script to be executed from the Script Engine.

Conditions

Condition

Function: Represents a condition that is checked before the rule chain continues and outputs the boolean value of the check. This can perform numerical comparisons between inputs.

Configurable settings:

• Number of input and output pins**: You can configure the number of pins to link multiple conditions.

• Comparison operations**: Choose from "equal," "greater than," "less than," "greater than or equal to," "less than or equal to."

• Value**: If only one input pin is used, a fixed value can be entered with which to compare. If multiple input pins are used, the inputs are compared with each other.

Time

Function: Inserts delays into the rule chain to either execute events with a time delay or cancel them.

Configurable settings:

• Number of input and output pins**: Determine how many delays can be set up.

• Condition**: TON (turn-on delay) and TOFF (turn-off delay).

• Delay time**: The delay in seconds that should be applied.

Schedule

Function: The Schedule building block allows a rule chain to be triggered based on a defined schedule. Within the set time window, the building block outputs a "true" signal; outside this period, the output remains on "false".

Configurable settings:

• Schedule type: Selection of the schedule, e.g.,

  • Time Schedule – Control based on a defined time.

  • Days Schedule – Control based on specific days of the week.

• Begin time: Start time of the active period (hh:mm) (only for Time Schedule).

• End time: End time of the active period (hh:mm) (only for Time Schedule).

• Active days: Selection of the weekdays on which the rule should be active (only for Days Schedule).

Operation

Or

Function: Checks whether one of the input conditions is true or false and outputs the boolean value of this check.

Configurable settings:

• Number of input and output pins**: Determine the number of conditions to be checked.

And

Function: Checks whether all input conditions are true and outputs the boolean value of this check.

Configurable settings:

• Number of input and output pins**: Determine the number of conditions that must be true at the same time.

Arithmetic

Function: Performs mathematical calculations with the input parameters to generate a new value.

Configurable settings:

• Number of input pins**: Determine how many values are included in the calculation.

• Operation**: Choose between addition, subtraction, multiplication, and division.

• Value**: An optional fixed value that is included in the calculation.

Others

Note

Function: The Note building block serves as a pure information element within the rule chain. It allows you to add notes or comments to improve the clarity of the rule chain.

Configurable settings:

• Text field: Enter any note or description.