IsUnacked

(Alarm Manager module)

Description	Will indicate if an alarm is unacknowledged. It can be used either as a subroutine or as a function.
Returns	Numeric
Usage	Script or steady state.
Function Groups	Alarm
Related to:	GetAlarmStatus \| IsActive \| IsDisabled \| IsShelved
Format:	\AlarmManager.IsUnacked(AlarmName[, IncShelving]);
Parameters

AlarmName

Required.

Unique name for the alarm. Typically the unique ID, which can be obtained using GetAlarmName.
If there are multiple built-in alarms in a tag, the convention is to concatenate the UniqueID with a separator and a unique integer or string per alarm. For example, Concat(Root\UniqueID, \AlarmSeparatorString, 0).

InclShelving

Optional Boolean. If TRUE, a shelved alarm will be reported here as non-acknowledged, regardless of its status. Defaults to TRUE.

Comments

The IsUnacked subroutine returns a 1 if the alarm is unacknowledged and returns a 0 otherwise.

In most cases, shelving an alarm is considered the same as masking the IsUnacked status to FALSE. (Makes it look like not unacknowledged, regardless of what it actually is.)

For the rare use cases where shelving is to be ignored, the IncludeShelving parameter can be set to FALSE

Example:

Within a custom tag...

  UnackedStatus = \AlarmManager.IsUnacked(\GetAlarmName(\Root, "Low"));