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 alarm and event servers follow the naming convention in the following table. In this instance, Historian will map the Historian alarm and event properties to the properties given by the alarm and event server.

Alarm PropertyDescription
AckedAcknowledgement status of the alarm.
AckTimeIf the alarm has been acknowledged, this property will store the timestamp of the acknowledgement.
ActorIf the alarm has been acknowledged, or is a tracking event, the operator involved in the change of state will be recorded here.
AlarmTypeRecords the type of alarm or event as an integer. The integers map to the following values:
  • 1 = Simple
  • 2 = Condition
  • 4 = Tracking
ConditionNameRecords the alarm's condition.
DataSourceNameRecords the data source name of the alarm or event.
EnabledReserved for future use.
EndTimeRecords the end time of the alarm.
EventCategoryRecords the event category.
MessageRecords the event's message.
QualityRecords the event's severity.
SeverityRecords the event's severity.
SourceRecord the event's source.
StartTimeRecords the start time of the alarm or event.
SubConditionNameIf the alarm contains a subcondition, it will be recorded in this property.
TagThe data tag this alarm is associated with.
TimestampThe timestamp of this specific event.
VendorAttributeAdditional vendor attributes.

Additional attributes can be found by selecting the VendorAttribute property, which will cause the Attribute list box to appear.

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.