AlmAck

Description: Acknowledges an alarm by specifying its location in one of the four alarm lists.

Returns: Nothing

Usage: Script or Steady State

Format: AlmAck(List, N, Ack, LowLevel, HighLevel, LowCategory, HighCategory)

Parameters: List { numeric } { required } { no default: }

Any numeric expression specifying the list to search for the alarm. The valid list numbers are:

List	Meaning
0	Logged alarm list
1	Active alarm list
2	Unacknowledged alarm list
3	Current alarm list

You may add any of the following numbers to the specified list number to filter the selected list.

List	Attributes
4	Use combined alarm list
8	Don't include alarm occurrences in list
16	Don't include alarm clears in list
32	Don't include alarm acknowledges in list
64	Don't include alarm enables in list
128	Don't include alarm disables in list

N { numeric } { required } { no default: }

Any numeric expression giving the number of the entry in the list, excluding any entries that do not fall within the bounds specified by the remaining parameters below.

Ack { numeric } { required } { no default: }

Any numeric expression indicating whether the alarm entry has been acknowledged. The transition of this parameter from false ("0") to true ("1") causes the alarm to be acknowledged.

LowLevel { numeric } { required } { no default: }

Any numeric expression giving the lower limit for the alarm priority level. If the alarm level is strictly below this value, the alarm is not included in the count specified by the N parameter.

HighLevel { numeric } { required } { no default: }

Any numeric expression giving the upper limit for the alarm priority level. If the alarm level is strictly above this value, the alarm is not included in the count specified by the N parameter.

LowCategory { numeric } { required } { no default: }

Any numeric expression giving the lower limit for the alarm category. If the alarm category is strictly below this value, the alarm is not included in the count specified by the N parameter.

HighCategory { numeric } { required } { no default: }

Any numeric expression giving the upper limit for the alarm category. If the alarm category is strictly above this value, the alarm is not included in the count specified by the N parameter.

Comments: If the alarm is already acknowledged when the Ack parameter changes from false to true (i.e. from "0" to "1"), the AlmAck statement has no effect. If an alarm occurs while the Ack parameter is true, it is not acknowledged - the Ack parameter must change from false to true after the alarm occurs for the alarm to be acknowledged.

AlmAck may be used to acknowledge an alarm from a graphic list. To do so, make the priority and category limits identical to those in the AlmList statement, and use a Step function to transform the YLoc screen coordinates to a list entry.

Example:

AlmAck(2 { Use list of unacknowledged alarms },

1 { Acknowledge first alarm in list },

MatchKeys(2, "A") { Acknowledge by pressing letter A },

0 { Lowest priority level },

15 { Highest priority level },

0 { Lowest category },

255 { Highest category });

The example displayed above acknowledges the first alarm in the list of all unacknowledged alarms when the "A" key is pressed on the keyboard. Since alarms are maintained in chronological order, the alarm acknowledged will be the oldest unacknowledged alarm.