Alarm Array
All alarm information queried from the alarm source at runtime is stored in the alarm array (one-dimensional array). The array has a fixed number of elements. Each element in the array represents a specific alarm value or property, such as the alarm id, alarm message, priority, state, etc. In the HMI application, the access to the array elements and their values is done by binding the symbol parameters of an HMI Symbol List of source type 'AlarmView' to the array field elements (see the following figure and also the HMI alarming example).
Parameters of HMI Symbol List bound to elements of the alarm array
Mapping of alarm array field to alarm property
The following table shows the alarm array fields, their array data types, and their mapping to the alarm properties as configured in the 'Alarm Server | Alarms' PLANT editor and the alarm data received at runtime (for a description of the alarm properties see the topic "Alarming").
| Alarm array field | Data type | Alarm property ('Alarm Server | Alarms' column) | Alarm data at runtime |
|---|---|---|---|
| AlarmID | ANY_STRING | Alarm ID | - |
| ConditionVariableName | STRING | Port / Variable Name | - |
| State | BOOL | - | Alarm state. Possible values:Normal, Abnormal, Acknowledged, Unconfirmed, Confirmed, RtnUnacknowledged, RtnUnconfirmed, OverallSuppressed |
| ActiveState | BOOL | - | If true, then the monitored value is in an abnormal state (alarm is currently active) |
| ActiveStateChanged | ANY_DATE | - | Timestamp (date and time) of when the ActiveState last changed |
| Description | ANY_STRING | Description | - |
| Priority | ANY_NUM | Priority | - |
| AlarmType | ANY_STRING | Alarm Type | - |
| SourceName | ANY_STRING | Source Name | - |
| Group | ANY_STRING | Group | - |
| Message | ANY_STRING | Message | - |
| Condition | ANY_STRING | - | Alarm condition. Possible values:Normal, BitPatternMatch, BooleanMatch, MaxHighHigh, MinLowLow, OutOfRangeLowLow, OutOfRangeLow, OutOfRangeHigh, OutOfRangeHighHigh |
| ConditionValue | ANY_STRING | - | Value of the monitored variable/port when the alarm became active |
| AckedState | BOOL | - | True if the alarm has been acknowledged |
| AckedStateChanged | ANY_DATE | - | Timestamp (date and time) of when the AckedState last changed |
| AcknowledgeRequired | BOOL | Access Rights: Acknowledge Required | - |
| ConfirmedState | BOOL | - | True if the alarm has been confirmed |
| ConfirmedStateChanged | ANY_DATE | - | Timestamp (date and time) of when the ConfirmedState last changed |
| ConfirmRequired | BOOL | Access Rights: Confirm Required | - |
| SuppressedState | BOOL | - | If true, then the alarm is suppressed and will not be presented in the HMI’s list of active alarms |
| SuppressedStateChanged | ANY_DATE | - | Timestamp (date and time) of when the SuppressedState last changed |
| SuppressVariableName | ANY_STRING | Suppress Condition Variable Name | - |
| SuppressedAlllowed | BOOL | Access Rights: Suppression Allowed | - |
| User | ANY_STRING | - | User name of the operator that last confirmed/acknowledged the alarm, or IP address of the station that was used to perform the confirm/acknowledge |