Difference between revisions of "Adding a rule"

Latest revision as of 14:18, 5 November 2019

Pre-requisites

A rule requires design and logical programing in order for it to work correctly. If this is your first time creating a rule, please read this guide first.

You should also be familiar with the basic measurements and its concepts. Please read this section if you require a refresher.

You should

Know what event the Rule should detect.
Know what you would like Senfi to do (Action) when the event is detected
Have already created the Input measurement & metrics.
Know the thresholds or values which indicates occurrence of event.
Be able to send records to Input measurement & metric.
(Optional) Be able to send simulated records to Input measurement & metric (to simulate occurrence of event or situation)

Adding a New Rule

Login to the CMS.
Go to the Rule tab.
Click the + button to add a new rule.
Give the rule a descriptive name. This will be shown to users of the dashboard.
Select the Severity of the rule.
Select Evaluate Type of the rule.
(Optional) Select the Access Group that would be able to view and modify the rule. Defaults to all users in your organization.
Give the rule a descriptive Description. The Description would be the default content for any Action.
Construct the Conditions using the editor. Read section on "Constructing Condition" for more details.
Save when done.
(Optional) Test the rule by sending records to simulate event.

Next: Adding a computed measurement

@@ Line 1: / Line 1: @@
-=== Pre-requisites ===
+<translate>
+=== Pre-requisites === <!--T:1-->
 A rule requires design and logical programing in order for it to work correctly. If this is your first time creating a rule, please read [[Rule|this guide]] first.
-You should also be similar with the basic [[Measurement|measurements]] and its concepts. Please read [[Concepts#Measurement.2C_Metric.2C_Tag|this section]] if you require a refresher.
+<!--T:2-->
+You should also be familiar with the basic [[Measurement|measurements]] and its concepts. Please read [[Concepts#Measurement.2C_Metric.2C_Tag|this section]] if you require a refresher.
+<!--T:3-->
 You should
 * Know what event the Rule should detect.
@@ Line 12: / Line 15: @@
 * (Optional) Be able to send simulated records to '''Input''' measurement & metric (to simulate occurrence of event or situation)
-=== Adding a New Rule ===
+=== Adding a New Rule === <!--T:4-->
-# Login to the [https://ems.senfi.io/cms CMS]
+<!--T:5-->
-# Go to the '''Rule''' tab
+# Login to the [https://ems.senfi.io/cms CMS].
+# Go to the '''Rule''' tab.
 # Click the '''+''' button to add a new rule.
 # Give the rule a descriptive name. This will be shown to users of the dashboard.
 # Select the Severity of the rule.
-# Select Evaluate Type of the rule. Read [[Rule#Rule_execution_options|what is Evaluate Type]]
+# Select [[Rule#Rule_execution_options|Evaluate Type]] of the rule.
 # (Optional) Select the Access Group that would be able to view and modify the rule. Defaults to all users in your organization.
-# Give the rule a descriptive '''Description'''. The '''Description''' would be the default content for any '''Action'''
+# Give the rule a descriptive '''Description'''. The '''Description''' would be the default content for any '''Action'''.
-# Construct the '''Conditions''' using the editor. [[#Constructing_Condition|Constructing the Condition]] for more details.
+# Construct the '''Conditions''' using the editor. Read section on [[Rule#Constructing_Condition|"Constructing Condition"]] for more details.
-# Save when done
+# Save when done.
-# (Optional) Send records to simulate event to test the rule.
+# (Optional) Test the rule by sending records to simulate event.
-=== Constructing Condition ===
-This section will guide you to construct a condition using the Editor when adding/editing a Rule in the CMS. The objective here is to tell Senfi how to detect the event or situation that you wish to be notified of.
-[[File:rule_editor.png|thumb|Rule Editor]]
-The Rule Editor is a graph based "Drag and Drop" editor. Each node in the Editor represents either an '''Input''', Data Transformation, Logic, or an '''Action'''. Arrows are used to link the nodes and control the flow of data between nodes.
-[[File:rule_editor_input_output_arrows.png|thumb|Input & Output of a node]]
-'''Arrows coming into the left of a node indicates the node's input, <br>and arrows going out the right of a node indicates the node's output'''.
-The graph must always start from '''Input''' nodes and ends in the '''Output''' or '''Action''' nodes (Data originates from '''Input''' nodes, is transformed by Data Transformation, Logic nodes, and is consumed by '''Output''' & '''Action''' nodes).
+<!--T:6-->
+<div class="right">[[Adding_a_computed_measurement|Next: Adding a computed measurement]]</div>
-;'''Input''' nodes
+</translate>
-:'''Constant''' - outputs a constant value. e.g: 0, 1, true, false
-:'''Metric''' - outputs the latest value of a metric
-;'''Input''' modifier nodes
-:'''Range''' - modifies output of "Metric" node from latest to historical values
-;Logic Nodes
-:'''Operator''' - comparison operators. e.g. <, >=, ==, !=
-:'''Logic''' - perform "AND" or "OR" between 2 or more boolean values
-;Data Transformation nodes
-:'''Filter''' - to be used with "Range" node. Filters input values to output a subset number of values.
-:'''Aggregate''' - to be used with "Range" node. Aggregates input values into a single value. E.g. sum, average, median.
-:'''Function''' - value-wise transformation. Transform each value, e.g ABS, Floor, Round etc. Can be used directly with a "Metric" node, or with "Range" node. Outputs the same number of values as its input.
-;Output node
-:'''Output''' - '''Output''' node. Must have 1 and only 1 node. Specifies the '''Output''' of a '''Rule'''
-;Action nodes
-:'''Action''' - '''Action''' node. Input must always be from the "Output" node. Can have 0 or more "Action" nodes. Instructs Senfi to do something when '''Output''' changes.
-==== Basic Steps ====
-# Drag a node above working area into the working area to create a node.
-# Create "Metric" nodes, one for each '''Input''' metric.
-# Select the correct measurement and metric for each "Metric" node. Read: [[#Configuring_Nodes|how to configure a node]]
-# (Optional) If you need to compare metric value against a constant value, use the "Constant" node.
-# Create "Operator" and "Logic" nodes to construct necessary logic
-#* logic graph should output a single boolean (true or false) value
-#* output from "Metric" node must go to input of a "Operator" node.
-#* "Operator" and "Logic" nodes can be nested.
-#* You can attach more than 2 inputs to a "Logic" node
-# Create a "Output" node and attach output of logic graph as its input
-# Create "Action" nodes, one for each desired '''Action''' and attach output of "Output" node as its input
-# Save when done
-==== Example ====
-[[File:rule_editor_example.png|center|Example 1|thumb|700px]]
-Example 1: A simple Rule detecting when a Lift has tripped (safetyTrip == 1).
-[[File:rule_editor_example2.png|center|Example 2|thumb|700px]]
-Example 2: Detects when a Lift tripped (safetyTrip == 1), AND passengers are trapped in the Lift (load > 0)
-==== Working with historical values ====
-When historical values is required to detect an event, the "Range", "Filter" and "Aggregate" nodes is needed.
-By default, a "Metric" node will output the Last Known value of the metric. To obtain historical values of a metric, attach the output of "Metric" node to the input of a "Range" node. The output of the "Range" node will be historical values from the metric.
-The configuration options of the "Range" node allows you to change the range of historical values to output. You can configure it to output metric values from 1 hour ago till now, or the last 10 received metric values.
-After obtaining the list of historical values, you can:
-* Filter the list using the "Filter" node.
-* Transform each value in the list using the "Function" node.
-The "Filter" and "Function" nodes can be nested.
-Finally, the list of historical values must be aggregated using the "Aggregate" node before its output can be used by a "Logic" or "Operator" node.
-==== Example using historical values ====
-[[File:rule_editor_example_historical.png|center|Historical Example 1|thumb|700px]]
-The example above detects when a Lift is stopped at Level 2 for over a minute.
-==== Configuring Nodes ====
-Each node contains attributes & options which you can modify. To modify the attributes of a node, move your mouse over the node and click on the "Gear" button that appears near the top right corner of the node (Beside the "X" button). A window will popup to allow you to configure the node.
-===== Aggregate node =====
-This section explains what each of the options for "Aggregate" node does.
-;sum
-:the sum of all input values
-;count
-:the number of input values
-;average
-:the average of input values
-;median
-:the median value of input values
-;max
-:the largest value
-;min
-:the smallest value
-;mode
-:the value that appears most often
-;range
-:the difference between the largest and smallest value (max - min)
-;stddev
-:[https://en.wikipedia.org/wiki/Standard_deviation standard deviation]
-;percentile
-:[https://en.wikipedia.org/wiki/Percentile percentile]. This option accepts an additional "Percentile Value" parameter.
-;every
-:outputs true if every value fulfills the condition. This option accepts an addition "Condition" parameter.
-;any
-:outputs true if at least 1 value fulfills the condition. This option accepts an addition "Condition" parameter.
-===== Function node =====
-This section explains what each of the options in "Function" node does.
-;abs
-:absolute value
-;round
-:round to nearest integer
-;ceil
-:round up
-;floor
-:round down
-;map
-:This option accepts an additional "function" parameter. Using the custom "function" parameter, transforms each input value