Alarm Object Properties
The following table describes the alarm object's common properties. These properties are available in the wizard when you select the Get Alarm Property or Set Alarm Property functions. Not all alarms and events servers follow the naming convention in the following table. In this instance, Historian will map the Historian Alarms and Events properties to the properties given by the alarms and events server.
Alarm Property | Description |
---|---|
Acked | Acknowledgement status of the alarm. |
AckTime | If the alarm has been acknowledged, this property will store the timestamp of the acknowledgement. |
Actor | If the alarm has been acknowledged, or is a tracking event, the operator involved in the change of state will be recorded here. |
AlarmType | Records the type of alarm or event as an integer. The integers map to the following values:
|
ConditionName | Records the alarm's condition. |
DataSourceName | Records the data source name of the alarm or event. |
Enabled | Reserved for future use. |
EndTime | Records the end time of the alarm. |
EventCategory | Records the event category. |
Message | Records the event's message. |
Quality | Records the event's severity. |
Severity | Records the event's severity. |
Source | Record the event's source. |
StartTime | Records the start time of the alarm or event. |
SubConditionName | If the alarm contains a subcondition, it will be recorded in this property. |
Tag | The data tag this alarm is associated with. |
Timestamp | The timestamp of this specific event. |
VendorAttribute | Additional vendor attributes. Additional attributes can be found by selecting the If you are entering your calculation function manually, you can use the GetVendorAttribute method to retrieve a vendor attribute. Refer to Alarm Methods and Functions for more information. |