Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Alarm Event properties provide a lot of information regarding an alarm event and fall into several categories: General Alarm properties, Event Alarm properties, and Runtime Event properties. General Alarm properties are automatically configured with default settings when the module is first installed. Event Alarm properties are properties that occur when an event happens. Runtime Properties are properties that are only present while the alarm event is in memory. 

Alarm Event properties are described below. If you are looking for information on the properties associated with configuring an alarm, please see the Tag Properties page. 

Gateway General Alarm Properties

General alarm properties are configured during intial setup.

  1. Go to the Configure section of the Gateway webpage, and choose Alarming > General from the menu on the left. The General Alarms Settings page will appear. 
  2. Set the general alarm properties shown in the following table: 

On_this_page


Alarm Evaluation
Live Event LimitDefault is 5. The number of "live" events (active or unacknowledged) that can exist for a single alarm at a given time. When surpassed, older events will be acknowledged automatically by the system. This means as an alarm cycles on and off, Ignition will keep track of the last five times the alarm event happened until the user acknowledges them. This does not store history for those events.
Event Suppression 
Continuous Event Detection Window (min)Default is 10. The amount of time to store events before shutdown to prevent new duplicate events from being created on startup. This setting prevents unacknowledged active events from being generated due to reboot. If set to 0, will not be used.
Notify Initial EventsDefault is false. If false, active alarms caused by the "initial state" (that is, the first value checked after being created, or after the enabled state changes) won't be sent to the notification system. This means if you add an alarm to a Tag, a notification won't be immediately sent when the new state is created.




Alarm Event Properties

An alarm event is an instance of an alarm that was witnessed by the alarming system. For example, when the value on a tag meets the criteria for an alarm on the same tag, an alarm event is created. That same event is then used to compile information about the event, such as when it transitions from an active state to a cleared state. 

When writing scripts that reference properties on an alarm event, the Binding/Scripting Key is case insensitive, meaning capitalization does not matter. 

Note_friendly

The value of properties on Alarm Events represent the value at the time the event was created. Thus, changing the value on an alarm property after one or more events were created will not retroactively change the property value on prior events. 

Alarm Event Configuration Properties

The table below represents properties on an alarm event that are derived by the configuration of the alarm. 

Event PropertiesBinding/Scripting Key DescriptionDatatype
NamenameThe name of the Alarm.String
EnabledenabledSpecifies whether or not this alarm is evaluated by the system. Set to False to turn off the alarm state and all associated actions.Boolean
Prioritypriority

The priority (or severity) of the alarm. Used for sorting/filtering. Numerical values are associated with each priority to make comparison easier. This property can also be referenced as a string with the following priority names.

Expand
titleClick here to see Alarm Priorities
ValuePriority
0Diagnostic
1Low
2Medium
3High
4Critical
Integer or String
Display PathdisplayPathAn optional path (separated by "/" characters) that is used for display and browsing purposes. Defaults to an empty string. String
Active PipelineactivePipelineThe pipeline (if any) that will be used to process active events generated by the alarm.String
Clear PipelineclearPipelineThe pipeline (if any) that will be used to clear events generated by the alarm. Used when the alarm goes into the Clear State.String
Active DelaytimeOnDelaySecondsThe amount of consecutive seconds that the alarm state must be True before the Tag enters this alarm state.Double
Clear DelaytimeOffDelaySecondsThe amount of consecutive seconds that the alarm state must be False before the Tag exits this alarm state.Double
NotesnotesA string that can act as documentation about the alarm.String
Ack NotesackNotesNotes added by user that acknowledged the alarm when it went active.String
Associated Data*The key is a string literal that matched the name of the Associated Data. 

Alarm Associated Data can also represented on alarm event. 

String

Alarm Runtime Properties

The table below represents properties that represent the that are provided to the event 

Runtime PropertyBinding/Scripting KeyDescriptionDatatype
Is Initial Event?IsInitialEvent Set to "true" when the event is caused by the initial state of the alarm.Boolean
System AcknowledgementSystemAckSet to "true" when the alarm has been acknowledged by the system, due to an overflow of the "live event queue". Live events are alarm events that are active or not acknowledged, and are limited for each alarm by the general alarm settings.Boolean
Shelf ExpirationShelfExpirationWhen the shelf will expire for this event.Integer
Is ShelvedIsShelvedA boolean value that reports if the alarm is currently shelved. Boolean
Event CanceledEventCanceledIf set, the event will drop out as soon as possible from the pipelines.Boolean
Event IdEventIdThe Unique ID (UUID) of this alarm event. Each event gets a completely unique id.String
SourceSourceThe qualified path to the item that generated this event. Includes the Tag Provider, Tag Path, and the name of the alarm. Example: prov:tagProviderName:/tag:folder/tagName:/alm:alarmNameString
Display Path Or SourceDisplayPathOrSourceGets the display path if defined, otherwise, returns the source.String
StateState

The current overall state of the alarm.

Expand
titleClick here to see Alarm States
ValueState
0Clear and Unacked
1Clear and Acked
2Active and Unacked
3Active and Acked
Integer
EventState EventState 

The transitional state that caused the current event.

Expand
titleClick here to see Event States
ValueState
0Active
1Clear
2Acknowledged
Integer
Event ValueEventValueThe value associated with the current event.Integer
Acknowledgement UserAckUserThe user who acknowledged this event.String
Is Acknowledged?IsAcked"True" if the event has been acknowledged.Boolean
Is Active?IsActive"True" if the event is still active.Boolean
Is Clear?IsClear"True" if the event is not active.Boolean
Active TimeActiveTimeA datetime representing when the event became Active. datetime
Clear TimeClearTimeA datetime representing when the event became Cleared. 
Acknowledgement TimeAckTimeA datetime representing when the event became Acknowledged. 
Pipeline Transition CountPipelineTransitionCountHow many transitions the event has made inside of the pipelines.Integer


The AlarmEvent Object

Some system functions, such as system.alarm.queryStatus, return an AlarmEvent object which contains many methods to retrieve additional information about the individual alarm. This section details the various methods on an AlarmEvent Object.

Note, many of the functions below return some complex object, as opposed to just a standard Python datatype. In these cases, normal Python type-casting can be used to turn the object into a native Python type. For example, getDisplayPath() returns a StringPath object, which can easily be converted to a Python string with the str() function. 

FunctionDescriptionReturned Object
getDisplayPathReturns the Display Path of the alarm.StringPath
getDisplayPathOrSourceIf the Display Path for the alarm in an empty string, then returns the Source Path, otherwise, returns the Display Path.Python Unicode
getIdReturns the UUID of the alarm event.java.util.UUID
getLabel()The label of the alarm event.Python Unicode
getLastEventState

Returns the last state of the alarm. Possible return values are Active, Acknowledged, or Cleared.

The last event is always returned, so if you're looking to see if an alarm is has been both Acknowledged and Cleared, use getState() instead.

AlarmStateTransition
getNameReturns the name of the alarm.Python Unicode
getNotesReturns the value of the Notes property. Returns a None-type object if a Note has not been configured on the Alarm.Python Unicode or None
getPriorityReturns an AlarmPriority object representing the the Priority of the alarm. Can easily be converted to a String with str()an Integer with .intValue. Default is String.AlarmPriority
getSourceReturns the Source path of the alarm.QualifiedPath
getStateReturns the current state of the alarm: i.e., Active, Unacknowledged.AlarmState
isAckedReturns a boolean flag indicating that the alarm has been Acknowledged.Python Boolean
isClearedReturns a boolean flag indicating that the alarm has been Cleared. Python Boolean
isShelvedReturns a boolean flag indicating that the alarm has been Shelved. Python Boolean