When you use the Add Filter window to filter an Alarm Summary, you use the top combo box on the window to specify the database field to which you want to apply a filter (see Add a Filter to a List).
You can filter an Alarm Summary by various database fields, including:
- Ack Comment—Use to filter the Alarm Summary to those alarms that are associated with a specific acknowledgment comment.
- Ack Time—Use to filter the Alarm Summary to those alarms that are associated with a specific acknowledgment time, or range of acknowledgment times.
- Ack User—Use to filter the Alarm Summary to those alarms that are associated with a specific name of the user who acknowledged the alarm.
- Active Time—Use to filter the Alarm Summary to those alarms that are associated with a specific active time, or range of active times.
- Aggregate Name—Use to filter the Alarm Summary according to the aggregate with which the alarms are associated. Aggregates typically appear as tabs on configuration Forms (for example, the Control aggregate appears as the Control tab).
- Area of Interest—Only displayed if the Area of Interest feature is enabled on your system. Use this field to filter the Alarm Summary to those alarms that are associated with specific Area(s) of Interest. When using the Reference browse window to specify an Area of Interest, you will be offered those Area(s) of Interest to which your User Account has access. For more information, see Restrict Alarm and Event Access to Specific Areas of Interest in the ClearSCADA Guide to Core Configuration.
- Alarm Message (EncodedMessage)—ClearSCADA stores alarm messages internally in raw encoded format. Each message is decoded for display in the Alarm Summary and Alarms List. You can use this field for diagnostic purposes. For example, to ascertain which alarms contain particular message elements, or how message elements conveying variable data are passed between server and client.
- Alarm Source (EncodedSourceMessage)—ClearSCADA stores alarm source information internally in raw encoded format. Each source message is decoded for display in the Alarm Summary and Alarms List. You can use this field for diagnostic purposes. For example, to ascertain which alarms are associated with a particular source, or how source data is passed between server and client.
- Cached—Use to filter the Alarm Summary by cached (True) or historic (False) data. The Alarm Summary combines alarm data
- Condition Name—Use to filter the Alarm Summary according to alarm condition. The alarm condition identifies the particular occurrence that triggered an alarm, for example, a ‘Point State’ condition name indicates that a change in point state has caused an alarm to be raised.
- Deleted—Use to filter the Alarm Summary to those alarms that are associated with database items that have been deleted since the alarm was logged.
- Disabled By (DisabledByDesc)—Use to filter the Alarm Summary by the type of source (database item) that triggered the disable action. To filter by this field, you enter the required source type. This can be one of the following (the strings are case-sensitive):
- User
- Logic
- Schedule
- Method Call.
- Disabled By (DisabledByValue)—Use to filter the Alarm Summary by the type of source (database item) that caused the associated alarms to be disabled. To filter by this field, you enter the value of the source.
- For 'User' enter 1
- For 'Logic' enter 2
- For 'Schedule' enter 3
- For 'Method Call' enter 4.
(When filtering the Alarm Summary programmatically, enter the raw bit mask: 0x01 for 'User', 0x02 for 'Logic', 0x04 for 'Schedule', or 0x08 for 'Method Call'. You can also specify multiple sources, such as 0x03 (to filter the Alarm Summary to show only alarms that have been disabled by 'User' AND 'Logic'), or 0x0F (for alarms that have been disabled by all four sources).)
- Disabled End Time—Use to filter the Alarm Summary by the time (or range of times) that indicate when disabling of the associated alarm ended.
- Disabled Time—Use to filter the Alarm Summary by the time (or range of times) that indicate when the associated alarm was disabled
- File Id—Alarm Summary messages are stored in a series of files. Each file has a unique File Id. Use the File Id field for diagnostic purposes, to filter the Alarm Summary to those alarms that are stored in particular Alarm Summary file(s). The File Id is a string value.
- File Offset—Alarm Summary messages are stored in a series of files, with each message being assigned a unique offset in each file. Use the File Offset field for diagnostic purposes, to filter the Alarm Summary to those alarms that are stored in a particular location within specific Alarm Summary file(s). The File Offset is a whole number.
- Inactive Time—Use to filter the Alarm Summary to those alarms that became inactive at a specific time or within a defined time range.
- Location—Use to filter the Alarm Summary by the location of records, either online or from a mounted archive.
- Message (Message)—Use to filter the Alarm Summary according to its message values. Each alarm has a message value that describes what happened to cause the alarm to be logged. For example, if a user performs an Override action on a point, the message indicates that an Override action was performed and the value of the override. The Message is a string value.
- Receipt Time—Use to filter the Alarm Summary to those alarms that were received by the server at a specific time or within a defined time range.
- Severity (SeverityDesc)—Use to filter the Alarm Summary according to severity description. Each alarm has a severity description that indicates the importance of the alarm. The default descriptions are Critical, High, Medium, and Low, where, for example, an alarm with a Low severity would not be as important as an alarm with a severity description of High or Critical. The default severity descriptions and levels may have been replaced by a custom range of severities on your system.
- Severity (SeverityValue)—Use to filter the Alarm Summary according to the severity of the alarms. Each alarm has a severity value that indicates the importance of the alarm. Use this field to filter the Alarm Summary to those alarms that have a specific severity value, or have a severity value within a defined range. The default ranges are Low 1-333, Medium 334-666, High 667-999, and Critical 1000. Unlike the Severity (SeverityDesc) field, you use the Severity (SeverityValue) field to filter alarms by severity number, rather than severity description. Be aware that the number ranges and corresponding severity descriptions on your system may differ from those above.
- Source (Id)—Each item in the database has a unique ID number that is used internally to identify that item. Use the Source (Id) field to filter the Alarm Summary to those alarms that are associated with a source that has a particular ID number. When you select this field, use the browse button adjacent to the filter value field to select the name of the database item for which you want to filter the alarms. Alternatively, use the >> button adjacent to the filter condition field, and specify more than one source.
Although the name of each database item is displayed in the simplified form of the filter, the SQL behind the filter filters the List by Id rather than by source name (as can be seen by selecting the Advanced button on the Filter Columns window, to view the WHERE Clause that is used for the filter).
- Source (Source)—Use to filter the Alarm Summary according to alarm source. Each alarm is associated with a specific ‘source’, which is typically an item in the database. This item is the source of the alarm. As with the Source (Id) field, you use the browse button adjacent to the filter value field to select the name of the database item for which you want to filter the alarms, or use the >> button adjacent to the filter condition field to expand the window and specify more than one source.
- Source Message—This field only applies to text alarms (for which the source is not directly related to an item in the database). Use this field to filter the Alarm Summary according to the source message to which any text alarms relate.
- State (State)—Use to filter the Alarm Summary according to alarm state. To filter by this field you specify the value that identifies the alarm state (for example, 4 (for Unacknowledged Uncleared)). Refer to the CAlarm table in the Database Schema for the list of enumeration values associated with this field.
- State (StateDesc)—Use to filter the Alarm Summary according to alarm state. To filter by this field you specify the description of the alarm state (for example, Unacknowledged Uncleared).
- Subcondition Name—Use to filter the Alarm Summary according to alarm subcondition. The alarm subcondition is the particular class of alarm condition that caused an alarm to be triggered. For example, an analog point's value exceeding the High limit.
- Time (Time)—This field is only retained for backwards compatibility, and is an alias for the RecordTime field. We suggest you filter alarms by Time (RecordTime) rather than by this field. (‘Time’ is a reserved word in SQL and as such cannot be used by some third-party applications.)
- UnAck Time—Use the filter the Alarm Summary to those alarms that were unacknowledged at a specific time, or within a defined time range.
- User Location (ClientAddress)—Use to filter the Alarm Summary to those alarms that were logged as a result of the actions of a user who was logged on to a specified client. When using this field, you need to specify the IP address of the client you require. Specify the IP address as a 32-bit integer.
This field is primarily for use by applications that are searching the Alarm Summary for specific alarms. (It is more efficient than searching by ClientAddressDesc).
- User Location (ClientAddressDesc)—Use to filter the Alarm Summary to those alarms that were logged as a result of the actions of a user who was logged on to a specified client. When using this field, you need to specify the IP address of the client you require. Specify the IP address in standard dot-decimal notation, for example, 10.1.5.30.
- Visible Time—Use to filter the Alarm Summary to those alarms for which the alarm subcondition became active at a specific time, or within a defined time range. You can also use this field to filter the Alarm Summary to those alarms for which the alarm became visible at a specific time, or within a defined time range, after being suppressed or disabled.
Some other fields perform special functions and are not used for filtering. These include:
- Record ID—This field enables ClearSCADA to retrieve ‘dynasets’ of data. Retrieving dynasets of data minimizes the loading on both the server and client, particularly when requesting large quantities of data.
- Sequence Number—This field is used to sort alarms that have the same time stamp into the correct order. The Sequence Number is included in the Alarm Summary’s ORDER BY clause (as can be ascertained by using the Sort option to display the Sort Order window).
Further Information