Creating Alarm Rule    

i. Define State

ii. Select the Alarm Trigger

iii. Set the Condition Builder

iv. Configure the Alarm Message

v. Customize the Alarm Actions

Creating Alarm Rule from Setup Page  (End Application) 

1. Click the Setup icon in the End Application. The Setup page is displayed.

 

Creating Alarm Rule from List View Page (End Application)

 

1. Select the rule trigger type whether Realtime Datapoint or Scheduled KPI Datapoint.

1. In Realtime Datapoint, the alarm rule is constructed based on the realtime datapoint value received from the device.
   
2. In Scheduled KPI Datapoint, the alarm rule is constructed based on the calculated KPI datapoint values of stored data.  

Note: Scheduled KPI Datapoint option alone is available for the Location models. As the location does not have any realtime datapoints.

2. For Alarm Rule, select the model and the instance.

3. Enter the name and description of the alarm rule in the respective textboxes.

     Note: Rules cannot be created for peripheral devices as there are no datapoints.

4. Select the alarm category to group the alarm rules for easy access. Else, click on Create New Category to create a new category if it is not already available.

5. Configure the schedule for the alarm rule by choosing the Run This Rule: Always or Custom Time option.

1. Always - The alarm rule is always running and will be executed whenever the conditions are met.
   
2. Custom Time - The alarm rule runs at scheduled time. You can choose the days of the week and the time at which the alarm rule is to be run. This enables the alarm rule to not validate the incoming data always, i.e. 24*7. Not including working hours helps to avoid unwanted alarms and the actions getting executed.

6. Select the Status whether On/Off.

On - The rule will be executed whenever the conditions match.

Off - The rule will not be executed even when the conditions are matched. The rules will be created for the respective instances, but they will be in an inactive state.

7. Click Next to add Alarm State.

Creating Alarm Rule States

 I. Define State   

The following screen is displayed when adding the State for the first time. Click "Do not show this screen again" if you do not want to view this screen on consequent Alarm State addition.

 

7. Click Get Started.

8. Provide the State name and the corresponding severity as given in the sample table above.

 

9. Click Next to move to the Select Trigger screen of the Alarm Rule builder.

 

 II. Configuring an Alarm Trigger 

1. The Trigger configuration provides instructions on when to execute the Alarm Rule.

1. Select Realtime Datapoint if you want to create a rule condition based on the incoming datapoint value from the device.
   

          (or)

1. Select Device Notification Alarm if you want to create a rule where the device sends the notification based on the device level code.
   

 

2. Click Next to move to the Set Condition screen of the Alarm Rule builder.

 III. Providing the Alarm Condition 

The alarm conditions, such as the primary condition for the alarm, occurrence condition, and noise reduction criteria, are configured in this step.

 

1. Configure Primary Condition

The primary condition denotes criteria that need to be verified and passed for the rule to be executed. You can configure multiple criteria and define a criteria pattern to prioritize the conditions. The condition setting options for Realtime Datapoint trigger and Device Notification are provided below:

a. With Realtime Datapoint trigger option:

 

The structure of the primary condition consists of the datapoint or field, the operator, and the desired value as given below.

 

 

Image: Set Conditions configuration for Realtime Datapoint trigger option

i. Datapoint or Field Selection

Note: Ensure that the required datapoint has been created for the model you have selected.

  

ii. Operator Selection

The operator selection will be based on the type of the value, whether
String, Numeric, or Boolean.

iii. Value Selection

The value selection can be any of the following:

 

Constant: Input your own value.

Datapoint: Aquire value from another datapoint.

Field: Acquire data from a field in the details page.   

 

Use the + icon to add multiple primary conditions. And configure the Criteria Pattern to define the execution order in the case of multiple primary conditions.

b. With Device Notification trigger option:

 

The structure of the primary condition consists of the datapoint or field, the operator, and the desired value as given below.

Image: Set Conditions configuration for Device Notification trigger option

 

i. Device Alert Message Parsing Key

Note: Device Alert Message Parsing Key is the key from the incoming device event JSON that uniquely identifies the message and helps in defining the alarm. The different ways to identify the key and its value are simple and static way, or dynamic or complex for the complex device event JSON.

  

*When device is selected as the Model for the Alarm Rule, only two parsing key options i.e. Direct Parsing String and findValue() will be available.

 

Direct Parsing String

 

{Edge Key}

 

findValue()

 

      

ii. Operator Selection

 

The operator selection will be based on the type of the value, whether String, Numeric, or Boolean.

 

iii. Value Selection

 

The value selection can be any of the following:

 

Constant: Input your own value.

Field: Acquire data from a field in the details page.

 

 

Example Primary Condition Entry

 

 

Use the + icon to add multiple primary conditions.

Configure the Criteria Pattern to define the execution order in the case of multiple primary conditions.

 

 

2. Set Occurrence Condition 

 

This option lets you denote the number of times the condition needs to be repeatedly met for the alarm to be created.

3. Noise Reduction 

 

This option enables you to stop the existing alarm & trigger action from getting updated if the same state condition is matched back-to-back.

 

4. Click Next to move to the Configure Message screen of the Alarm Rule builder.

 

 IV.  Configuring the Alarm Message 

 

1. The message to be attached to the alarm being generated is provided in the Message textbox.

Note: Typing # inside the textbox will display the list of placeholders that you can include in the message.

2. Click Next to move to the Configure Actions screen of the Alarm Rule builder.

 

 V. Configuring Alarm Actions 

1. Select Everytime Action - The actions will be executed whenever the alarm is created/updated.

2. Click Add Action and choose to perform any of the below operations everytime the conditions are met.

Email Notification

Custom Function

Webhook

Execute Command

(or)

1. Select State Transition Action - Execute the set of actions based on the previous state condition.

2. Click Add Transition Condition and provide the corresponding action to be performed.

 

 

3. Click Finish to complete the Alarm State addition.

Every Alarm State should have a Clear State and a non-Clear State to be saved.

4. Continue the steps to create a non-Clear State.

5. Click Save to save the Alarm Rule State.

Refer to Understanding Actions documents to learn more about the actions that can be configured in the application. The actions can be configured directly from the features such as Alarm Rules, Notification Profiles, and Workflow Rules or created as separate actions and assigned to features by using the category option in the respective forms.

Editing Alarm Rules    

1. Navigate to the End Application.

2. Select Alarms > Alarm Rules in the left pane. All the Alarm Rule already configured are displayed on the page.

3. Click on the name of the alarm rule whose details you want to modify.

You can view the details and edit from the Basic view as given below.

   

4. Click the Edit icon next to the State name and severity to modify the State Name or Severity.

5. Click the Edit icon inside the Trigger details section to modify the Trigger info, Condition, or Actions configured for the Alarm Rule.

Editing Alarm Rules Info    

1. Navigate to the End Application.

2. Select Alarms > Alarm Rules in the left pane. All the Alarm Rule already configured are displayed on the page.

3. Select the checkbox next to the name of the alarm rule whose Status you want to modify.

4. Click on the Edit Rule Info text link on the top of the screen next to the Alarm Rule name.

 

5. Modify the Status if required and click on the Update button to save the changes.

Deactivating An Alarm Rule    

1. Navigate to the End Application.

2. Select Alarms > Alarm Rules in the left pane. All the Alarm Rules already configured are displayed on the page.

3. Click on the name of the alarm rule whose details you want to view. You can view the details in two formats: Basic and Detailed view.

4. Click on the Deactivate button at the top right corner of the screen to deactivate the alarm rule.

Note: In the case of a deactivated Alarm Rule, the Activate button will be displayed instead of the Deactivate button. You can click Activate to activate the alarm.

Deleting Alarm Rules    

1. Select the Automate tab on the top of the screen in the Developer Application.

2. Select Alarm Rules in the left pane. All the Alarm Rule already configured are displayed on the page.

3. In the Alarm Rule list view, click on the name of the alarm rule whose details you want to delete.

 

4. Click the Delete button on the top of the list view to delete.

5. The dependencies if any are checked and the alarm rule is deleted if there are no associations.

6. Click Delete in the confirmation dialogue to delete the alarm rule.