Alarms and Events Subscriptions

Hyper Alarm Server can be subscribed to via the AlarmWorX™64 Viewer and through other GENESIS64™ clients as either data points or Alarm and Event Subscriptions. The following shows the alarms and events hierarchical descriptions defined in the subsequent table.

  • BaseEventType and BaseConditionType with their related fields, get defined by the FrameWorX™ server.

  • AlmsBaseType contains all statically-defined fields.

  • AlmsCommonType contains all Hyper Alarm Server user-defined custom fields from all the alarm Types defined in Workbench. User-defined custom fields get merged using Culture-Invariant case-insensitive comparison.

Standard fields processed by Hyper Alarm Server

Hyper Alarm Server exposes all event fields as real-time points.

Type

Field Name

Data Type

Functional Description

BaseEventType

 

 

 

 

 

 

 

EventId

Byte Array

Uniquely identifies the event notification.

EventTypeName

String

Always AlmsCommonType

EventClass

UInt32

Always 2

SourceName

String

Identifies the Alarm source. For example, "/Area1.Source1"

Time

DateTime

The time of the event notification.

Message

String

Alarm message

Severity

UInt16

Alarm severity
TimeZone

String

Time zone.

The time zone field is automatically defined for alarms through AssetWorX integration; otherwise the field is empty.

BaseConditionType

 

 

 

 

 

 

 

AckRequired

Boolean

Setting is True when an alarm requires acknowledgement.

ActiveTime

DateTime

The time when the alarm occurred. Any transitions between sub-states does not set a new time, as long as the alarm remains active.

ActorId

String

The operator who acknowledges the alarm.

ConditionName

String

The alarm type name associated with the alarm source.

NewState

UInt32

The following bit pattern is used to determine the alarm activity:

  • Basic fields are:
    0 - Enabled
    1 - Active
    2 - Acknowledged
  • Extra fields are:

    4 - Shelved
    5 - Suppressed by Design
    6 - Out-of-Service
    7 - Latched
    8 - Audible

StatusCode

StatusCode

Quality of the value that triggered the alarm.

SubConditionName

String

The condition name as configured on the alarm type Conditions tab.

ChangeMask

UInt32
  • ActiveState (0x0001) - The condition’s active state has changed.
  • AcknowledgeState (0x0002) - The condition’s acknowledgment state has changed.
  • EnableState (0x0004) - The condition’s enabled state has changed.
  • Quality (0x0008) - The Condition quality (input value(s) status) has changed.
  • Severity (0x0010) - The severity level has changed.
  • Subcondition (0x0020) - The alarm active condition has transitioned into a new sub-condition.
  • Message (0x0040) - The event message has changed (compared to prior event notifications related to this condition).
  • Attribute (0x0080) - One or more event attributes/fields have changed (compared to prior event notifications related to this condition).
  • Shelved (0x0200) - alarm’s shelved state has been set/un-set.
  • OutOfService (0x0800) – alarm’s out of service state has been set/unset.
  • Latch (0x1000) – alarm’s latch has been set/unset (latch must be enabled).

AlmsBaseType

 

 

 

 

 

 

 

 

 

 

 

 

AckComment

String

Comment for the acknowledged alarm operation.

AckTime

DateTime

The time related to the acknowledged alarm operation.

SilActorId

String

The operator who silenced the audible alarm.

SilComment

String

The comment string related to silencing the audible alarm.

SilTime

DateTime

The time when the audible alarm is silenced.

SupActorId

String

The operator who suppressed or unsuppressed the alarm.

SupComment

String

Comment related to the suppress or unsuppress alarm operation.

SupTime

DateTime

The time related to the suppress or unsuppress alarm operation.

SupOffTime

DateTime

Time of the automatic unsuppress operation, or empty.

ResActorId

String

The operator that reset the alarm from the latch state.

ResComment

String

Comment related to the latch reset operation.

ResTime

DateTime

Time of the latch reset operation.

Area

String array

The alarm areas list assigned to the alarm source, such as "/Area1.Source1"