Difference between revisions of "Rule"
| Line 1: | Line 1: | ||
| − | As introduced in [[Concepts#Rule,_Alert|general concepts]], a Rule is a tool that you can use to monitor your assets and be notified of abnormal situations or events. | + | As introduced in [[Concepts#Rule,_Alert|general concepts]], a Rule is a tool that you can use to monitor your assets and be notified of abnormal situations or events. |
A '''rule''' in Senfi comprises of: | A '''rule''' in Senfi comprises of: | ||
| Line 34: | Line 34: | ||
== Actions == | == Actions == | ||
| − | Whenever '''Output''' changes (from true to false and vice versa), '''Actions''' may be executed. | + | Whenever '''Output''' changes (from true to false and vice versa), '''Actions''' may be executed. '''Actions''' includes sending an email, sms, request to a webhook or triggering an alert in the dashboard. |
=== Content of Actions & Description === | === Content of Actions & Description === | ||
| − | You can embed the value of an '''Input''' in the | + | Depending on the '''Action''', different content options is available. Some examples is the title & body of an email, message text for sms, and the body content for webhook request. You will be able to describe the event or situation that has happened to the recipient of the notification. |
| + | |||
| + | To further aid you in describing the event, you can embed the value of an '''Input''' in the content of an '''Action'''. | ||
== Misc == | == Misc == | ||
Revision as of 18:20, 18 September 2019
As introduced in general concepts, a Rule is a tool that you can use to monitor your assets and be notified of abnormal situations or events.
A rule in Senfi comprises of:
- Inputs
- Conditions
- Output
- Actions
- Rule execution options
Inputs are evaluated by Conditions to generate a single boolean Output. When value of Output changes, Actions, such as email and dashboard alerts, are executed. Rule execution options allows you to configure how the Rule should execute. e.g: how often the Rule is evaluated, when to execute Actions etc.
Inputs --> Conditions --> Output
Output Changed --> Actions
Contents
Example
- Input: iot_weighingscale_v1.battery_level
- Condition: < 20
- Action: Email reminder to replace battery
- Rule execution option: Immediately (means evaluate this rule whenever there is any incoming measurement)
Rule execution options
By setting Evaluate Type to Immediate or Polling, you can choose to execute a Rule when new values are received for any Input Measurements, or periodically, regardless of whether any Input Measurements have changed.
If Rule is set to run periodically (Polling), you must specify how often a Rule is executed by setting Intervals in seconds.
Inputs, Conditions and Output
Before adding a Rule, you should already have an event or situation that you wish to be notified about. The event or situation should be one that can be detected by monitoring data received by Senfi.
Select, as Inputs, the Metrics and Measurements from which the event or situation can be detected from. Then, construct the set of Conditions that will evaluate to true when event or situation occurs. The result of said Conditions is the Output of the Rule.
Actions
Whenever Output changes (from true to false and vice versa), Actions may be executed. Actions includes sending an email, sms, request to a webhook or triggering an alert in the dashboard.
Content of Actions & Description
Depending on the Action, different content options is available. Some examples is the title & body of an email, message text for sms, and the body content for webhook request. You will be able to describe the event or situation that has happened to the recipient of the notification.
To further aid you in describing the event, you can embed the value of an Input in the content of an Action.