IoT Extension includes a rule engine to analyze data in realtime and to perform actions based on data. These rules are specified in a scripting language and are managed in the Administration application.
To easily create rules, the Cockpit application includes a Smart Rules builder which allows you to create rules from templates (so-called smart rule templates).
Smart Rules are only visible, if the environment is subscribed to the Smart Rule application. To manage "Smart Rules", the user has to have INVENTORY CREATE permission and either SMART RULE permission or CEP MANAGEMENT permission.
Smart Rules are parameterized. There are two sources for parameters:
Rule Parameters are provided by the user when creating a Smart Rule from a template. Examples are email addresses and alarm texts.
Object Parameters are stored in the group or device. These parameters can be edited after the Smart Rule has been created. An example includes min and max values for thresholds.
Smart Rules can be seen
- in the Info tab of a device or group,
- in the Smart Rules page accessible from the Configuration menu.
There are two different kinds of Smart Rules:
- Local: Smart Rules created in either a group or a device. They are visible to everyone with access to the group/device.
- Global: These Smart Rules are created in a global context (Smart Rules page, alarms, data explorer, etc...). They are only visible to users with the relevant permissions.
In the Smart Rules page, only the global smart rules are shown.
In a local context (group or device) and without the relevant permissions, only the local Smart Rules are shown. If the user has the relevant permissions, both local and global Smart Rules are shown. The permissions required in order to see the global Smart Rules are:
- Smart rule READ
- Smart rule ADMIN
- CEP management ADMIN
Creating Smart Rules¶
"Smart Rules" can be created either in the "Smart Rules" page, accessible from the "Configuration" menu in the navigator, or in the Info tab of a group or a device.
To create a "Smart Rule", follow these steps:
- Click "Add Smart Rule" in the top menu bar.
- Select a "Smart Rule" template from the list.
- In the upcoming window, use the slider to select if the rule will be enabled or disabled.
- Next, configure the rule parameters. The parameters differ from rule to rule, for details see individual rule descriptions below.
- In the target asset or devices field, you can optionally activate the current "Smart Rule" for specific devices or assets.
- Click "Create" to create the "Smart Rule".
A list of "Smart Rules" is shown below. Note that this list might differ based on your installation.
If the new rule was set to "enabled" and was not activated for specific objects, the rule will be active for all devices and groups. See next section on how to deactivate a smart rule for specific objects.
To avoid confusion, disabled "Smart Rules" are not displayed in group menus or device menus.
Smart Rules can be instantiated multiple times.
Activating or deactivating Smart Rules¶
A "Smart Rule" can be activated (switched on) and deactivated (switched off) for a single object (group or device). For example, if a device is generating too many threshold alarms, you can deactivate the rule for this single object. The rule is still active for all other objects.
To deactivate or activate a "Smart Rule" for a group or device, navigate to the Info tab of the group or device and enable/disable the respective rule using the slider.
Editing Smart Rules¶
To edit a "Smart Rule", just click the respective row or click the menu icon at the end of the row and from the context menu select "Edit".
Duplicating Smart Rules¶
To duplicate a "Smart Rule", click the menu icon at the end of the row and from the context menu select "Clone". Modify at least the name and click "Save & close" to save the "Smart Rule" and return to the "Smart Rule" list.
Removing Smart Rules¶
To remove a "Smart Rule", click the menu icon at the end of the row and from the context menu select "Remove".
Debugging Smart Rules¶
For easier debugging, there is a direct link from a "Smart Rule" to the corresponding event processing module. Click the menu icon at the end of the row and from the context menu select "Inspect" to use this link.
Example: Defining explicit thresholds¶
To define a threshold rule follow these steps:
- In the navigator, select the desired group or device to apply a threshold to.
- Switch to the "Data explorer" tab.
- If the data point that should raise the threshold is not visible by default, select "Add data point" and add a data point.
Click the menu icon at the end of the row of the respective data point and select "Create Smart Rule".
Select the Smart Rule "On measurement explicit threshold create alarm".
Fill in the red range minimum and red range maximum value. When the measurement value enters or leaves the RED range, an alarm is created or respectively cleared. For details, see the description of the rule "On measurement explicit threshold create alarm" in the Smart rules collection.
- Under "Create Alarm" you can optionally edit the alarm type and the alarm text.
- Under "Target assets" or devices you can select the object this rule will be applied to.
- Click "Create" to create the Smart Rule.
The rule will automatically be set to active and alarms appear if they arise.
Chain rule execution¶
Smart Rules can create a new data item on the platform. For example, the threshold rule creates new alarms. This new data can be handled further by selected "Smart Rules", for example, by an "On alarm send e-mail" rule.
Using this mechanism, it is possible to create a chain of smart rules.
If you create a rule chain keep in mind how much data will be created to avoid overload or excessive amount of data.