Define an Alarm Filter String for an Embedded Alarms List Manually
You can define an alarm filter by entering the expression for the alarm filter string manually. The clauses you can use to define the string are:
MinSeverity="<Lower Severity Limit>"
MaxSeverity="<Upper Severity Limit>"
AlarmState="<Every Alarm State or a Specific State>"
Assigned="<True or False>"
Source="<Data Source>"
AOI="<Name of Area of Interest>"
Categories="<Name of one or more Categories>"
Region="<Region Name>"
Do not include the angle brackets < >.
For example, the following string filters an alarms list so that when it is first displayed, it only shows outstation communications alarms that are in the unacknowledged state, assigned to the current user, in a Group named 'CM' or one of its children, and in an Area of Interest named 'AFKI':
AOI="AFKI"&Source="CM.*"&Categories="Outstation Comms"&AlarmState="Unacknowledged"&Assigned="TRUE"
When you define an alarm filter string manually, you may need to define values for some of the clauses in your string. If you do not include certain clauses in your string, ClearSCADA will use the default values for those clauses.
Clause | Value used by ClearSCADA for clause if clause is not included in filter string |
---|---|
MinSeverity |
Low |
MaxSeverity |
Critical |
AlarmState |
All States |
Assigned |
FALSE |
Source |
All Sources |
AOI |
All Areas of Interest |
Categories |
All Categories |
Region | All Regions |
Blank clauses in an Alarms List filter string cannot take precedence over defined clauses in the User account filter string. For more information, see Making an Embedded Alarms List’s Default Filter Settings Take Precedence.
To define the filter string for an embedded Alarms List manually:
- Display the Embedded Alarms List String dialog box (see Filter an Embedded Alarms List)
- On the Edit Embedded Alarms List String dialog box, enter the string for your filter in the Alarm Filter String text entry field. For more information on constructing an alarm filter string, see Alarm Filter String Syntax in the ClearSCADA Guide to Alarms.
- When you have entered an appropriate string for the filter you require, select the OK button to confirm. This closes the Edit Embedded Alarms List String dialog box.
- Close the Edit Embedded List Properties window.
The filter you have defined is applied to the list. You have now filtered the embedded Alarms List.