Alarm and Event functions

Use FactoryTalk alarm and event functions to retrieve information about a group of FactoryTalk alarms that have similar names, or about an individual alarm. These functions are available wherever expressions are supported in a FactoryTalk View SE application.
TIP:
The information returned by the FactoryTalk alarm and event functions includes
InAlarm
suppressed alarms, but does not include the other suppressed alarms.
Using a large number of alarm functions can affect the performance of the system, therefore it is recommended that the total number of unique function calls accessed in displays on a FactoryTalk View SE client, should be no more than 500. Reusing the identical alarm function call does not affect performance.
For complete information about using FactoryTalk alarms and events, see
FactoryTalk Alarms and Events Help
. For an example that uses alarm expressions to animate the color of a box when the state of an alarm changes, see
FactoryTalk Alarms and Events System Configuration Guide
.
The following table lists Alarm and Event functions:
This function
Returns this value
AE_ActiveEvents
(
EventName
)
A long integer from 0 to the number of server-based events that are active.
AE_ActiveHighAlarms
(
AlarmName
)
A long integer from 0 to the number of FactoryTalk active, high-priority alarms that are
In Alarm
and
Acknowledged
or
In Alarm
and
Unacknowledged
.
AE_ActiveHighUnackedAlarms
(
AlarmName
)
A long integer from o to the number of FactoryTalk active, high-priority alarms that are
In Alarm
 and
Unacknowledge
.
AE_ActiveLowAlarms
(
AlarmName
)
A long integer from 0 to the number of FactoryTalk active, low-priority alarms that are
In Alarm
and
Acknowledged
or
In Alarm
and
Unacknowledged
.
AE_ActiveLowUnackedAlarms
(
AlarmName
)
A long integer from 0 to the number of FactoryTalk active, low-priority alarms that are
In Alarm
 and
Unacknowledged
.
AE_ActiveMediumAlarms
(
AlarmName
)
A long integer from 0 to the number of FactoryTalk active, medium-priority alarms that are
In Alarm
and
Acknowledged
or
In Alarm
and
Unacknowledged
.
AE_ActiveMediumUnackedAlarms
(
AlarmName
)
A long integer from 0 to the number of FactoryTalk active, medium-priority alarms that are
In Alarms
 and
Unacknowledged
.
AE_ActiveUrgentAlarms
(
AlarmName
)
A long integer from 0 to the number of FactoryTalk active, urgent-priority alarms that are
In Alarm
and
Acknowledged
or
In Alarm
and
Unacknowledged
.
AE_ActiveUrgentUnackedAlarms
(
AlarmName
)
A long integer from 0 to the number of FactoryTalk active, urgent-priority alarms that are
In Alarm
and
Unacknowledged
.
AE_DisabledCount
(
AlarmName
)
A long integer from 0 to the number of FactoryTalk alarms that are disabled.
AE_FaultedAlarmsExist
(
AlarmIngly
)
A Boolean representing whether any alarm exists in the
Faulted
 state with the specified alarms, area path, or group path.
Returns 0 if no alarm exists and 1 if one or more alarms exist.
AE_HighPriorityActive
(
AlarmName
)
An integer from 1 to 4 representing the highest priority value associated with the specified alarms, whose states are
In Alarm
.
  • 1: Low
  • 2: Medium
  • 3: High
  • 4: Urgent
If 0 is returned, it means that none of the specified alarms were
In Alarm
.
AE_HighSeverityAcked
(
AlarmName
)
An integer from 1 to 1000 representing the highest severity value associated with the specified alarms, whose states are
In Alarm
 and
Acknowledged
.
If 0 is returned, it means that none of the specified alarms were both
In Alarm
and
Acknowledged
.
AE_HighSeverityUnacked
(
AlarmName
)
An integer from 1 to 1000 representing the highest severity value associated with the specified alarms, whose states are
In Alarm
and
Unacknowledged
.
If 0 is returned, it means that none of the specified alarms were both
In Alarm
and
Unacknowledged
.
AE_HistoryStatus
(
ServerName
)
An integer from 0 to 8 representing the connection status of the alarm history database.
  • 0: Initializing the connection to the database
  • 1: Connected to the database
  • 2: Disconnected to the database
  • 3: Started logging to the database
  • 4: Database definition deleted
  • 5: Failed to log to the database
  • 6: Stopping logging to the database
  • 7: Stopped logging to the database
  • 8: Alarm history not configured
AE_InAlmAckedCount
(
AlarmName
)
A long integer from 0 to the number of FactoryTalk alarms that are
In Alarm
and
Acknowledged
.
AE_InAlmShelvedCount
(
AlarmName
)
A long integer from 0 to the number of FactoryTalk alarms that are
In Alarm
 and
Shelved
.
AE_InAlmSuppressedCount
(
AlarmName
)
A long integer from 0 to the number of FactoryTalk alarms that are
In Alarm
 and
Suppressed
.
AE_InAlmUnackedCount
(
AlarmName
)
A long integer from 0 to the number of FactoryTalk alarms that are
In Alarm
and
Unacknowledged
.
AE_NormalShelvedCount
(
AlarmName
)
A long integer from 0 to the number of FactoryTalk alarms that are
Normal
and
Shelved
.
AE_NormalSuppressedCount
(
AlarmName
)
A long integer from 0 to the number of FactoryTalk alarms that are
Normal
 and
Suppressed
.
AE_NormalUnackedCount
(
AlarmName
)
A long integer from 0 to the number of FactoryTalk alarms that are
Normal
and
Unacknowledged
.
AE_ShelvedAlarmsExist
(
AlarmName
)
A Boolean representing whether any alarm exists in the
Shelved
 state with the specified alarms, area path, or group path.
Returns 0 if no alarm exists and 1 if one or more alarms exist.
AE_UnackedAlarmsExist
(
AlarmName
)
A Boolean representing whether any alarm exists in
In Alarm
and
Unacknowledged
 state with the specified alarms, area path, or group path.
Returns 0 if no alarm exists and 1 if one or more alarms exist.
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal