When an alarm is raised by a device, the alarm is tested against a set of conditions contained in one or more alarm rules. These rules are executed in a defined order to determine what action should be taken for this particular alarm. Each rule contains one or more conditions that need to be met to determine if the rule itself is a match. Each rule is associated with a workflow and may be associated with a callout list. Where a rule is matched with an alarm the associated workflow is initiated for example to notify of the alarm via email or SMS. The recipient of the escalation could be a fixed email address or mobile number or may be selected from the associated callout list to provide an escalation path if the notification is not acknowledged. The members of the callout list may be rotated on a regular basis.
Rules List
Accessing Rules is via the Availability > Management > Alarm Rules menu.
A list of rules will be presented as shown below.
- Matching Order - This is the order in which the rules will be tested. This is especially important when the rule is configured to stop on a match as subsequent rules will not be executed.
- Rule Name - A text name for the rule. Ideally a concise, relevant name is best.
- Callout List - The Callout Group or List that should be applied to this rule if required.
- List Type - Whether the Callout List is a list or a group.
- Workflow Name - The Workflow that will be initiated if the rule is successfully matched.
- Stop on Match - A trigger may be tested against a number of rules sequentially based on rank order. When Stop Processing on Match is 'On', no further rules will be processed if all conditions are met for this rule. When 'Off' the workflow associated with this rule will be initiated however checking of subsequent rules will continue and additional workflows may also be initiated.
The list may be filtered by entering text into the text boxes below the column headers. The list will be filtered automatically as you type. To clear all filters and display the complete list, click the Clear Filters button at the bottom of the page.
Managing Rules
Buttons across the bottom of the page provide the ability create a new rule, test rules or enable creating of rules to specifically target existing alarms that don't currently have a rule that could be matched to it.
Create Rule
The Create Rule button opens the create rule window in which a new rule can be created.
Test Rules
Test Alarm Rules is a utility used to confirm your rules you have created respond as you expect. The test can be run using unresolved alarms that already exist in the system simply by selecting the alarm from the available list. Where you are writing rules for alarms that have not yet occurred, you can set the individual alarm variables. These are available either in a drop down list which limits you to the correct location and equipment settings relevant to your current access level based on you login as well free form where appropriate and check boxes for Boolean parameters.
Unmatched Alarms
Unmatched Alarms opens the Current Unmatched Alarms window which lists all that current unresolved alarms that do not match any existing rules.
Clear Filters
The Clear Filters button will remove all defined filters and display the complete list of alarm rules.
Export
The Export option will write the alarm rules to a file of the selected file type and than make the file available for download.
Modifying Rules
Edit Rule
Editing the rule enables you to modify all aspects of the rule including the conditions that will determine if the rule is matched or not. When creating or editing a rule, a new workflow or new callout group or list may be created if desired. This will generate a place holder for these items after which you will need to complete their configuration via the appropriate management utility once the rule is complete.
An Alarm Rule Builder will enable you to create a list of conditions that will build up the list of conditions that will determine if the rule is matched or not. See the additional information below for detail on using the Edit Rule page.
Clone Rule
Right clicking a rule and selecting Clone Rule will make a copy of the selected rule and add it to the end of the rules list.
The rule editor will automatically open with the cloned rule already loaded ready to be modified. Once you have completed the required changes select the Update button or select Cancel. Selecting Cancel only cancels any changes being made to the cloned rule. It does not remove the cloned rule from the list. If this is required you must return to the list and delete it manually.
The order or the rules may not be correct after cloning a rule given it was appended to the end of the rules list. To reorder the rules, click the Matching Order field of the rule to be changed. Change the order number to represent the rules correct place in the list. The other rules will be re-numbered automatically so all rules are in the desired order.
Delete
To delete a rule, right click on the rule to be removed and select the Delete menu option.
Edit Callout
Right clicking on a rule and selecting Edit Callout will open the Support Call Out List manager. See the Call Out List Manager for more information.
Edit Workflow
Right clicking on a rule and selecting Edit Workflow will open the Workflow editor in a separate tab. See the Workflow Designer for additional information.