Alarm attributes

<Attribute>.Acked

Used to specify whether an alarm has been acknowledged. This attribute is updated when the AckMsg attribute is set. This attribute is always set to FALSE when a new alarm condition is detected (when the InAlarm attribute changes from FALSE to TRUE).

<Attribute>.AckMsg

The operator comment at the time the alarm is acknowledged. Any received text is stored, and the Acked attribute is set to TRUE. Also, the TimeAlarmAcked attribute is set to the current time. The maximum length is 256 characters.

<Attribute>.AlarmMode

The current alarm mode setting. Valid values are: Enable, Disable, Silence.

<Attribute>.AlarmModeCmd

The command to set the alarm mode. Valid values are: Enable, Disable, Silence.

<Attribute>.Category

The category of the alarm. The label of each alarm category is fixed.

<Attribute>.DescAttrName

The description of the alarm. The description must be of type String or InternationalizedString, with a maximum length of 329 characters. The DescAttrName attribute can contain a static alarm description or a reference to another string attribute within the same object containing the alarm description. The reference must be in the form: "me.AttrName". If the reference is invalid, the actual reference string is used for the description. If nothing is supplied for the DescAttrName attribute, the object’s ShortDesc attribute is used at runtime.

<Attribute>.InAlarm

The alarm state. This is exactly the same as the attribute in the host primitive that represents the alarm condition, except when the alarm state is disabled, in which case, InAlarm is set to Off, regardless of the actual condition state.

The quality is set during execute to the quality of the attribute, except when the alarm is disabled, in which case the quality is always GOOD.

<Attribute>.Inhibit

If true, the alarm is disabled. This attribute is intended to be written to by a script, a user, or an input feature. Only the individual alarm is disabled. No other alarms are disabled in the same object or in any objects that are assigned to or contained by this object.

<Attribute>.Priority

The value for the urgency of the alarm. Valid values are 1 through 999, with 1 being the most urgent.

<Attribute>.TimeAlarmAcked

The timestamp indicating the last time this alarm was acknowledged. The date format reflects the current locale setting for the operating system.

<Attribute>.TimeAlarmOff

The timestamp indicating the last time this alarm (as represented by the InAlarm attribute) went off. The date format reflects the current locale setting for the operating system.

<Attribute>.TimeAlarmOn

The timestamp indicating the last time this alarm (as represented by the InAlarm attribute) went on. The date format reflects the current locale setting for the operating system.