Rules¶
Rules determine condition states based on an input signal. Conditional rule state changes trigger an event status which is recorded to the event log, notifications are sent out, and the signal and asset statuses are updated in the application.
Rules offer the ability to run logic against a signal to determine a current condition of a signal. Signals may have multiple rules associated with them to look for different types of conditions and overall, the rule states provide the current conditions for an asset.
When a rule detects a new state, a state change event is recorded to the asset log, the rule state changes, and any associated notification subscriptions are triggered.
Rule States¶
Rules generate status events which are logged in the Asset Log and affect the connected Signals status and the overall Asset Status. In the application, Critical status (shown as red) takes preference over Warning status (yellow), which takes preference over OK status (green).
| Event Status | General Description |
|---|---|
Ok | Condition state associated as being normal or good. |
Warning | Condition State used by some rules for noting that a condition is not normal or close too bad. This should be monitored appropriately or preemptive action taken. |
Critical | Condition State used by some rules for noting that a condition is bad and action should be taken immediately. |
Informational | Condition State used by some rules to provide information but is not associated as good or bad. |
Error | (Not Supported in the UI) There is an issue with the signal or rule that prevents the rule from actually determining the current state. Action is recommended. |
Timeout | The signal for a rule has not updated past a given timeout period meaning the rule can not appropriately provide a condition state. |
Notifications Messages¶
Rule status events are recorded to an Asset's event log. In addition, notifications are sent out based on a user's notification preferences set up in their profile.
Rules may support additional custom messages that can be included in notifications. Each rule function supports this individually. The text entered in these fields is included in the notification messages sent out to users.
Standard Rules¶
Threshold (Numeric type)¶
Allows user to configure the following thresholds for an input signal. If the value of the signal goes above / below these thresholds, the status changes (critical take preference over warning) and an event is created in the Asset log.
Overall Parameters¶
| Parameter | Description |
|---|---|
| Name | The rule name used in the asset modify view. |
| Extra details for when value does not match | Prefix text that is applied to Event messages (Log, Notifications) when there are no threshold parameters that are true. |
Parameters for each Contains Match¶
| Parameter | Required? | Description |
|---|---|---|
| Operation | Required | The logical operator used in the threshold calculation |
| A value to compare to | Required | The numeric threshold for the operation to compare to |
| Duration Type | Required | See below for Duration options. Default is 'Sustained Duration'. |
| Extra details for when value does match | Optional | Prefix text that is applied to Event messages (Log, Notifications) when this specific value has a match. |
Duration Options¶
| Duration Option | Description |
|---|---|
| Once | When selected the function will only evaluate the last signal value with the operator and threshold value. |
| Sustained Duration | [Default] When selected the function will evaluate based on a time Duration and Duration Units. The signal value threshold operation comparison must stay true for this time duration for a state change. |
| Repeated | When selected the threshold operator function will evaluate based on the number of continuous (Count) times the threshold operator is true in a row. If this count condition is met, it will cause a state change. |
| Repeated Over Time | When selected, both a Count (number of times) and Duration (time period) are used. The function will look for the specified matching threshold operator count within the given duration for a state change. |
Contains (String type)¶
A String signal type rule that will perform a substring search for the specified string value inside of the actual signal's last value.
Note that this Rule function supports multiple match conditions, each with it's own event level.
Overall Parameters¶
| Parameter | Description |
|---|---|
| Name | The rule name used in the asset modify view. |
| Extra Notification Message text when no value matches | Prefix text that is applied to Event messages (Log, Notifications) when there are no matches for the contains values. |
Parameters for each Contains Match¶
| Parameter | Required? | Description |
|---|---|---|
| The substring value to look for | Required | |
| Alert level for a matching value | Required | |
| Duration Type | Required | See below for Duration options. Default is 'Once'. |
| Prefix Notification Message text when a match is found | Optional | Prefix text that is applied to Event messages (Log, Notifications) when this specific value has a match. |
Duration Options¶
| Duration Option | Description |
|---|---|
| Once | Default Duration option. When selected the function will only evaluate the last signal value for a matching comparison. |
| Sustained Duration | When selected the function will evaluate based on a time Duration. The signal value matching comparison must stay the same for this long for a state change. |
| Repeated | When selected the function will evaluate based on the number of continuous (Count) times a matching comparison has been made. If this count condition is met, it will cause a state change. |
| Repeated Over Time | When selected, both a Count (number of times) and Duration (time period) are used. The function will look for the specified matching comparisons count within the given duration for a state change. |
Boolean (Boolean type)¶
Evaluates a Boolean signal type and allows setting a status for true and for false values.
Parameters
| Parameter | Required? | Description |
|---|---|---|
| The Alert Level for True | Required | The severity level of the event status state change created when the signal value is true. |
| The Alert Level for False | Required | The severity level of the event status state change created when the signal value is false. |
| Duration Type | Required | See below for Duration options. Default is 'Once'. |
| Prefix Notification Message text when equal | Optional | Pre-fix text that is applied to Event messages (Log, Notifications) when the value is true. |
| Prefix Notification Message text when not equal | Optional | Pre-fix text that is applied to Event messages (Log, Notifications) when the value is false. |
Duration Options¶
| Duration Option | Description |
|---|---|
| Once | Default Duration Option. When selected the function will only evaluate the last signal value for a comparison. |
| Sustained Duration | When selected the function will evaluate based on a time Duration. The signal value must stay the same for this long for a state change to occur. |
| Repeated | When selected the function will evaluate based on the number of continuous (Count) times the same value has been sent. If this count condition is met, it will cause a state change. |
| Repeated Over Time | When selected, both a Count (number of times) and Duration (time period) are used. The function will look for the specified count of the same value within the given duration for a state change. |
Is Equal To (Numeric type)¶
Allows a user to set a value to compare a numeric value against. If any match it will set the status to whichever status value was set for that comparison.
Parameters:
| Parameter | Required? | Description |
|---|---|---|
| Value to compare to | Required | The value the rule will compare to the current signal value. |
| The number of decimal places to check | Required | The function will compare the signal value to this many decimal places. Default is 1. |
| The alert when equal | Required | The severity level of the event status state change created when there is an equal comparison. |
| Duration Type | Required | See below for Duration options. Default is 'Once'. |
| Prefix Notification Message text when equal | Optional | Pre-fix text that is applied to Event messages (Log, Notifications) when the comparison is true. |
| Prefix Notification Message text when not equal | Optional | Pre-fix text that is applied to Event messages (Log, Notifications) when the comparison is false. |
Duration Options¶
| Duration Option | Description |
|---|---|
| Once | Default Duration Option. When selected the function will only evaluate the last signal value for a comparison. |
| Sustained Duration | When selected the function will evaluate based on a time Duration. The signal value must stay the same for this long for a state change. |
| Repeated | When selected the function will evaluate based on the number of continuous (Count) times the same value has been sent. If this count condition is met, it will cause a state change. |
| Repeated Over Time | When selected, both a Count (number of times) and Duration (time period) are used. The function will look for the specified count within the given duration for a state change. |
