Reserved keywords for column names (Summary)

The unique string identifiers listed in the following table are used to refer to columns in the Alarm and Event Summary and Alarm and Event Banner. These column identifiers are used in the FilterDefinition property, SortOrder property, or GetColumnValue method.
Column Identifier
Column Name
Description
AckTime
Acknowledge Time
The time when the alarm became acknowledged. Filtering by AckTime is not supported.
AlarmClass
Alarm Class
The alarm class associated with the alarm.
AlarmCount
Alarm Count
The number of times the alarm has been in alarm.
AlarmName
Alarm Name
The name of the alarm.
AlarmShortName
Alarm Short Name
The short name of the alarm. For example, MixingTank1.
AlarmState
Alarm State
The state of the alarm:
  • In Alarm Unacknowledged (1)
  • In Alarm Acknowledged (2)
  • Normal Unacknowledged (3)
  • Normal Acknowledged (4)
  • Quality Not Good (5)
  • Disabled
    Even though the Alarm and Event Summary supports displaying the Disabled state, filtering by this state is not supported.
TIP: The enumerations in the parentheses are used to specify the alarm state for the FilterDefinition property or GetColumnValue method.
Area
Area
The FactoryTalk Directory path to the area in which the event occurred, in the format, /Area1/SubArea1/... . For example, /Line1/MixingTank.
ConditionName
Condition Name
A name that describes the alarm condition. Condition names vary by event category. For example,
  • Level
     (available to Logix analog instruction alarms, Logix tag-based alarms, analog alarms by a Tag Alarm and Event Server, OPC UA alarms): LO, LOLO, HI, HIHI
  • Discrete
     (available to Logix tag-based alarms, discrete alarms, and OPC UA alarms): TRIP, TRIP_L, S_TRIP
  • Deviation
     (available to Logix tag-based alarms, deviation alarms served by a Tag Alarm and Event Server, and OPC UA alarms): DEV_LO, DEV_HI
  • Event
     (available to server-based event conditions): EVENT, EVENT_L
  • System
    : STATUS, SHORTCUT
  • Configured
     (also known as Logix tag-based alarms): TRIP, HIHI, LOLO, HI, LO, ROC_POS, ROC_NEG, DEV_HI, DEV_LO, TRIP_L, HIHI_L, LOLO_L, HI_L, LO_L, ROC_POS_L, ROC_NEG_L, DEV_HI_L, DEV_LO_L
  • Rate of Change
     (available to Logix analog instruction alarms, Logix tag-based alarms, and OPC UA alarms): ROC, ROC_POS, ROC_NEG
  • OPC UA
     (specific to OP UA alarms): AC, DISCREPANCY, DISCRETE, S_TRIP, TRIP, IDIAG, SDIAG, CERTIFICATE, LIMIT, LIMIT_HIHI, LIMIT_HI, LIMIT_LO, LIMIT_LOLO, HIHI, HI, LOLO, LO, DEV_HIHI, DEV_HI, DEV_LOLO, DEV_LO, ROC_POS, ROC_NEG, UDT
CurrentValue
Current Value
The value of the tag that is being monitored for alarms when the alarm condition changed state.
EventCategory
Event Category
The category, defined by the alarm server, to which the event belongs. For FactoryTalk alarms, the categories are:
  • Level (6)
  • Discrete (8)
  • Deviation (7)
  • Event (13)
  • System (11)
  • Configured (12)
  • Rate of Change (9)
  • OPC UA (15)
TIP: The enumerations in the parentheses are used to specify the event category for the FilterDefinition property or GetColumnValue method.
EventSource
Event Source
A reference to the object which generated the event notification. For FactoryTalk Alarms and Events the event source is the name of the alarm. Filtering by EventSource is not supported.
EventTime
Event Time
The time at which the alarm entered the alarm state.
Filtering by EventTime is not supported.
Group
Group
The group name associated with the alarm. For example, Group1:Subgroup1.
InAlarmTime
In Alarm Time
The time at which the alarm condition changed into the In Alarm state. Filtering by InAlarmTime is not supported.
LimitValue
Limit Value Exceeded
Applies to alarms whose event category is Level, Deviation or Rate of Change only. The value which, when the tag exceeds it, triggers an alarm.
LiveDataValue
Live Data Value
The FactoryTalk Live Data tags' value that is updating in real time.
Note
: Live Data Value doesn't support OPC UA alarms.
Message
Message
The text that describes the event.
OutOfAlarmTime
Out of Alarm Time
The time at which the alarm condition changed into the Normal state. Filtering by OutOfAlarmTime is not supported.
Priority
Priority
The priority of the event:
  • Low (1)
  • Medium (2)
  • High (4)
  • Urgent (8)
  • Event (16)
TIP: The enumerations in the parentheses are used to specify the priority for the FilterDefinition property or GetColumnValue method.
ServerName
Server Name
The name of the server that generated the event. For example, Packaging Server.
Severity
Severity
The severity of the event. This is a value in the range of 1 (lowest severity) to 1000 (highest severity).
Tag1Value
Tag 1
The value of the associated tag parameter 1.
Tag2Value
Tag 2
The value of the associated tag parameter 2.
Tag3Value
Tag 3
The value of the associated tag parameter 3.
Tag4Value
Tag 4
The value of the associated tag parameter 4.
The unique string identifiers listed in the following table are used to refer to parameters that are not shown but used by the Alarm and Event Summary.
String Identifier
Description
AcknowledgeComment
The comment that is entered when acknowledging an alarm.
AcknowledgeUsername
The name of the user that acknowledges an alarm.
ConditionQuality
The quality of the tags or input on which the condition is based.
EventType
There are three types of events:
  • Condition-related (4). An event associated with a change in the state of an alarm. For example, an alarm condition becoming active, acknowledged, inactive (returning to normal) or disabled.
  • Tracking-related (2). An event associated with monitoring or auditing changes to the system. For example, an event describing the modification of a tag value by an operator.
  • Simple (1). Any event describing a simple occurrence in the system. For example, failure in accessing a computer or device. Simple events are not currently supported.
TIP: The enumerations in the parentheses are used to specify the event type for the FilterDefinition property or GetColumnValue method.
SubconditionName
The name of the sub-condition associated with the alarm condition.
Suppress
A value indicating whether or not the alarm source is suppressed. For example, True=1, False=0.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal