Difference between revisions of "Adding a rule"

From Senfi Docs
Jump to: navigation, search
Line 18: Line 18:
  
 
<!--T:5-->
 
<!--T:5-->
# Login to the [https://ems.senfi.io/cms CMS]
+
# Login to the [https://ems.senfi.io/cms CMS].
# Go to the '''Rule''' tab
+
# Go to the '''Rule''' tab.
 
# Click the '''+''' button to add a new rule.
 
# Click the '''+''' button to add a new rule.
 
# Give the rule a descriptive name. This will be shown to users of the dashboard.
 
# Give the rule a descriptive name. This will be shown to users of the dashboard.
Line 25: Line 25:
 
# Select [[Rule#Rule_execution_options|Evaluate Type]] of the rule.
 
# 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.
 
# (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. [[Rule#Constructing_Condition|Constructing the Condition]] for more details.
 
# Construct the '''Conditions''' using the editor. [[Rule#Constructing_Condition|Constructing the Condition]] for more details.
# Save when done
+
# Save when done.
 
# (Optional) Send records to simulate event to test the rule.
 
# (Optional) Send records to simulate event to test the rule.
  

Revision as of 11:53, 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

  1. Login to the CMS.
  2. Go to the Rule tab.
  3. Click the + button to add a new rule.
  4. Give the rule a descriptive name. This will be shown to users of the dashboard.
  5. Select the Severity of the rule.
  6. Select Evaluate Type of the rule.
  7. (Optional) Select the Access Group that would be able to view and modify the rule. Defaults to all users in your organization.
  8. Give the rule a descriptive Description. The Description would be the default content for any Action.
  9. Construct the Conditions using the editor. Constructing the Condition for more details.
  10. Save when done.
  11. (Optional) Send records to simulate event to test the rule.