String

Use to filter alarms by alarm state. This is equivalent to using the State combo box on the Filter window.

The states by which you can filter alarms are:

Acknowledged, Cleared, Unacknowledged, Uncleared, and UnacknowledgedUncleared. You can only specify up to one AlarmState clause and value per alarm filter string. Whenever the AlarmState attribute is omitted from an alarm filter string, ClearSCADA includes each alarm that meets all of the other filter criteria, regardless of alarm state.

String

Use to filter alarms by Area of Interest. This is equivalent to using the Area of Interest section on the Filter window.

This attribute only applies if the Area of Interest feature is enabled on your system (see Restrict Alarm and Event Access to Specific Areas of Interest in the ClearSCADA Guide to Core Configuration).

On systems on which multiple Area of Interest levels exist, use a dot separator (.) to indicate each hierarchical level.

You can specify single or multiple Areas of Interest. Include a separate AOI clause for each Area of Interest that you want to specify.

Boolean

Use to filter alarms to those that are assigned to the current user or ViewX workstation. This is equivalent to using the Only Show Alarms Assigned to Current User check box on the Filter window.

When TRUE, alarms are restricted to those that are assigned to the current user or ViewX workstation. When this attribute is omitted from the Alarm Filter String, ClearSCADA assumes the attribute to be FALSE.

String

Use to filter alarms by alarm category (or type of alarm). This is equivalent to using the Categories section on the Filter window.

You can specify single or multiple categories. To specify multiple categories use either of these methods:

• Use a semi-colon (;) to separate each additional category in a single Categories clause. Ensure no spaces are included either side of the semi-colon. Only include spaces where they exist in the category name.
• Specify each filter value as a separate Categories clause, in the same way as you would other alarm filter attributes.

You can ascertain the category names that exist on your system from, for example, the Category column on an Alarms List or the Alarm Banner, or from the Filter window.

Use to specify the minimum priority of the alarms that are to be included in alarm displays. This is equivalent to using the Minimum combo boxes on the Filter window.

With the Filter window, you specify the priority by selecting the severity Description that is assigned to that level of alarm. With the Alarm Filter String, you specify the Priority level. You can ascertain the Priority level that applies to each severity Description on your system by looking at the Severities section of the ClearSCADA Server Configuration Tool.

You can use the Alarm Filter String to specify up to four minimum severities. Include a separate MinSeverity clause for each priority range to which you want to restrict the alarm entries. With multiple MinSeverity clauses, follow each clause with a MaxSeverity clause (see below).

With a single MinSeverity clause, inclusion of a MaxSeverity clause is optional. (If it is excluded from the Alarm Filter String, ClearSCADA assumes the MaxSeverity attribute’s value to be that of the maximum priority level configured on your system.)

For an example that demonstrates the syntax used for defining the MinSeverity attribute, see the MaxSeverity entry below.

Integer

Use to specify the maximum priority of the alarms that are to be included in alarm displays. This is equivalent to using the Maximum combo boxes on the Filter window.

As with the MinSeverity attribute (see above), when including this attribute in the Alarm Filter String, you use it to specify the Priority level. You can ascertain the Priority levels on your system by looking at the Severities section of the ClearSCADA Server Configuration Tool.

You can use the Alarm Filter String to specify up to four maximum severities. Include a separate MaxSeverity clause for each priority range to which you want to restrict the alarm entries. With multiple MaxSeverity clauses, precede each clause with a MinSeverity clause (see below).

With a single MaxSeverity clause, inclusion of a MinSeverity clause is optional. (If it is excluded from the Alarm Filter String, ClearSCADA assumes the MinSeverity attribute’s value to be that of the minimum priority level configured on your system.)

Source

String

Use to filter alarms by alarm source (the Group(s), Group Instance(s), or individual item(s) with which the alarms are associated). This is equivalent to using the Sources section on the Filter window.

Each source needs to include the full path within the specific ClearSCADA database. Use a dot separator (.) to indicate each hierarchical level within the database. With the Source attribute, you can optionally include Filter Wildcards to define the values by which ClearSCADA is to filter the alarms.

You can specify single or multiple sources. Include a separate Source clause for each source that you want to specify.

Use to filter alarms by one or more geographic regions (see Geographic Regions).

You need to specify the full database path to each region. Use a dot separator (.) to indicate each hierarchical level within the database.

You can specify single or multiple regions. Include a separate Region clause for each region that you want to specify.

The alarm filtering in this case will be an OR operation. That is, the filter will include alarms within either of the specified regions.