Events

ID

GUID

Unique identifier for the event

EventTime

DateTime2

Time of the event, returned by default in the local time for the Historian server.

Note: EventTime is modified by wwTimeZone criteria in the query, similar to the way DateTime is in the History table.

EventTimeUtc

DateTime2

UTC time stamp showing when the event occurred.

EventTimeUTCOffsetMIns

Integer

Offset, in minutes, between the Historian server time and UTC time.

Type

String

Main categorization of the event: Alarm.Set, Alarm.Clear, Alarm.Acknowledged, Alarm.Silenced.Set, Alarm.Silenced.Clear, Alarm.Suppressed.Set, Alarm.Suppressed.Clear, Alarm.Disabled.Set, Alarm.Disabled.Clear, User.Write, User.Write.Secured, User.Write.Verified, System.Deploy, System.Undeploy, Engine.Start, Engine.Stop, Engine.OnScan, Engine.OffScan, Engine.Active, Engine.Standby, or Engine.Terminated.

Priority

Int32

Event importance. Values range from 1 to 999, with lower numbers indicating higher importance.

Severity

Int32

Urgency categorization of alarms or events: 1=Critical, 2=High, 3=Medium, 4=Low.

IsAlarm

Bool

Indicator telling whether the message is an alarm type message.

Source_ProcessVariable

String

Process variable to which the event is related. For example, if "TI101" has a field attribute "PV" and this is a "Hi" alarm, this is TI101.PV". This will normally match the name of the associated Historian tagname.

In a User.Write or similar event, this is the attribute being written to. Also see the Source_ConditionVariable column.

Source_Units

String

Engineering units used for process variable. For example: feet, pounds, or N/m^2.

Alarm_Acknowledged

Boolean

Indicates whether the alarm was acknowledged (true or false).

Alarm_Class

String

(Legacy) InTouch alarm class..

Alarm_Condition

String

Condition being alarmed. It should be one of these predefined values, if appropriate:

Limit.HiHi, Limit.Hi, Limit.Lo, Limit.LoLo, ROC.Hi, ROC.Lo, System, Discrete.True, Discrete.False, Deviation.Minor, Deviation.Major, SPC, Batch, Process, Software, System.

Alarm_DurationMs

Int32

Time, in milliseconds, between when the alarm is raised and when it is cleared.

Alarm_ID

String

Unique identifier for an instance of an alarm. This is used to link different alarm events together from the time the alarm is raised until the time it is no longered considered an alarm.

Alarm_InAlarm

Boolean

State of the alarm after the transition (true or false).

Alarm_IsShelved

Boolean

Indicator showing whether alarm was shelved (true or false).

Alarm_IsSilenced

Boolean

Indicator showing whether alarm is silenced (true or false).

Alarm_LimitString

String

Limit being alarmed.

Alarm_OriginationTime

DateTime2

Date/Time stamp for when the initial alarm condition originated.

Alarm_ShelveDurationMs

Int32

The duration, in milliseconds, for which the alarm was shelved. Used only if alarm is currently shelved.

Alarm_ShelveReason

String

Reason for shelving. Used only if alarm is currently shelved.

Alarm_ShelveStartTime

DateTime2

Date/time stamp showing scheduled start of shelve time, if the alarm is shelved. Returned by default in local time for the Historian server. Used only if alarm is currently shelved.

Alarm_State

String

State of the alarm (UNACK_ALM, UNACK_RTN, ACK_ALM, or ACK_RTN).

Alarm_TagType

String

Types of tags associated with the alarm (S, I, or F).

Alarm_Type

String

(Legacy) InTouch alarm type.

Alarm_UnAckDurationMs

Int32

Time, in milliseconds, between when the alarm is raised and when it is acknowledged. This property should not be included for an alarm until it is acknowledged.

Comment

String

Additional comments or descriptions for the event.

IntouchType

String

Legacy InTouch event type. Valid values are: ALM, RTN, ACK, and SYS.

Provider_ApplicationName

String

Name of the application that generated the event. For Application Server, this is the galaxy name. For InTouch, this is the InTouch application name.

Provider_InstanceName

String

Provider-specific string that uniquely identifies the instance on a given node name for the given application.

Provider_NodeName

String

Name of the node that generated the event. For example, "AOS-N-01".

Provider_System

String

Software system that generated the event. For example, Application Server, InTouch, or InBatch.

Provider_SystemVersion

String

Software version for the component identified by Provider_ApplicationName.

ReceivedTime

DateTime2

Time at which the the Historian server received the event. Returned by default in the local time for the Historian server.

Source_Area

String

Non-hierarchical area name. For example, "Area_001".

Source_ConditionVariable

String

Related condition variable.

For example, if "TI101" has a field attribute "PV" and this is a "Hi" alarm, this value would be "TI101.PV.Hi". Also see the Source_ProcessVariable column.

Source_Engine

String

Non-hierarchical engine name. For example, "AppEngine_001".

Source_HierarchicalArea

String

Hierarchical area name. For example, "Plant_001.Building_002.Area_001".

Source_HierarchicalObject

String

Hierarchical name of source object. For example, For example, "Reactor_001.TIC".

Source_Object

String

Non-hierarchical name of source object. For example, "TIC101".

Source_Platform

String

Non-hierarchical platform name. For example, "WinPlatform_001".

User_Account

String

Login name for the operator for the specified application. Depending on the security model being used, this can be <Domain>\<Alias>, email address, or user profile name.

For Application Server/GalaxySecurity Model: User Profile Name

For Application Server/OS Model:
OperatorDoman\Login

For InTouch: Operator Login

For Windows Live Login: TBD

User_Agent

String

Name of the application that the user was running when the event was generated.

User_Email

String

User email address.

Note: This property is not currently in the OData metadata for events, but may be added in the future.

User_Name

String

Complete first name and last name. For example, "Chris Walton".

User_NodeName

String

Computer name from which the user performed the action. For example, "ww112.baytown.amci.com".

User_Phone

String

User's phone number. For example, "1-800-555-1212".

Note: This property is not currently in the OData metadata for events, but may be added in the future.

ValueString

String

The value that triggered the alarm, represented as a string. The maximum length of this string is 329 characters.

Note: We recommend that you do not use this property except for legacy purposes, as extensive use of this property can negatively affect performance.

Verifier_Account

String

Login name for the verifier. Depending on the security model being used, this can be <Domain>\<Alias>, email address, or user profile name.

For Application Server/GalaxySecurity Model: User Profile Name

For Application Server/OS Model:
OperatorDoman\Login

For InTouch: Operator Login

For Windows Live Login: TBD

Verifier _Agent

String

Name of the application that the verifier was running.

Verifier _Email

String

Verifier email address.

Note: This property is not currently in the OData metadata for events, but may be added in the future.

Verifier _Name

String

Complete first name and last name

Verifier _NodeName

String

Computer name from where the verification occurred. For example, "ww112.baytown.amci.com".

Verifier _Phone

String

Verifier's phone number. For example, "1-800-555-1212".

Note: This property is not currently in the OData metadata for events, but may be added in the future.

wwTimeZone

String

Specifies the time zone for this record.