ALARM

See alsoExample

Test or force the state of an alarm.

WebVue support - Yes.

Mode	Mnemonic	Syntax
1	ACK	1, 5
2	MASK	1
3	UNMASK	1
4	VALUE	1
5	ACKALL	2
6	ACKLAST	2
7	ACKTAG	3
9	ACKOLDEST	2
11	ACKDOMNAT	4
12	ACKPRIO	6
13	SETMAINTENANCE	1, 5
14	RESETMAINTENANCE	1, 5
15	GETMAINTENANCE	1
16	SETALARMLEVEL	7
17	RESTOREALARMLEVEL	1, 5
18	ALARMON	8
19	RESETANDSETALARM	1
20	GETACKLEVEL	1
21	GETMASKLEVEL	1
22	GETMAINTENANCELEVEL	1

Arguments common to more than one mode

Argument	Meaning
AlarmName	Name of the alarm variable. Type STR. Both direct and relative variable referencing are supported.
Flag	Forces logging of the action as an action of the current user, as opposed to a background action not attributed to the current user. Type INTEGER. 1 - Enable - The alarm action is logged as performed by the current user 0 - Disable

Syntax 1

IntVal = ALARM(Mode, AlarmName);

Return type: INTEGER.

Execution

Mode	Mnemonic	Action
1	ACK	Acknowledge the alarm AlarmName. Return: 1 if successful, else 0.
2	MASK	Mask the alarm AlarmName. Return: 1 if successful, else 0.
3	UNMASK	Unmask the alarm AlarmName. Return: 1 if successful, else 0.
4	VALUE	Test the state of the alarm AlarmName.
		Return: 0 Off. 1 On, not acknowledged. 2 Off, not acknowledged. 3 On, acknowledged. 4 Invalid (Masked).
13	SETMAINTENANCE	Force the alarm AlarmName to maintenance mode. Return: 1 if successful, else 0.
14	RESETMAINTENANCE	Clear maintenance mode for the alarm AlarmName. Return: 1 if successful, else 0.
15	GETMAINTENANCE	Check the maintenance status of the alarm AlarmName.
		Return: 0 The alarm does not exist. 1 Alarm in maintenance mode. 2 Alarm not in maintenance mode.
17	RESTOREALARMLEVEL	Restore the priority level of the alarm AlarmName. Return: 1 if successful, else 0.
19	RESETANDSETALARM	Toggles (resets and set) the alarm AlarmName that is on. It has no effect if the alarm is off. Return: 1 if successful, else 0.
20	GETACKLEVEL	Return the acknowledged level of the alarm AlarmName.
21	GETMASKLEVEL	Return the mask level of the alarm AlarmName.
22	GETMAINTENANCELEVEL	Return the maintenance level of the alarm AlarmName.

Syntax 2

IntVal = ALARM(Mode [, Flag]);

Return type: INTEGER.

Execution

Mode	Mnemonic	Action
5	ACKALL	Acknowledge all alarms.
		Return: 1 if successful, else 0.
6	ACKLAST	Acknowledge latest alarm.
		Return: 1 if successful, else 0.
9	ACKOLDEST	Acknowledge oldest alarm.
		Return: 1 if successful, else 0.

Syntax 3

IntVal = ALARM(Mode, AlarmName [, Flag]);

Return type: INTEGER.

Execution

Mode	Mnemonic	Action
7	ACKTAG	Acknowledge the alarm AlarmName. AlarmName can be retrieved using ALARMDISPLAY(Mode 18).
		Return: 1 if successful, else 0.

Syntax 4

IntVal = ALARM(Mode, Domain, Nature[, Flag]);

Return type: INTEGER.

Execution

Mode	Mnemonic	Action
11	ACKDOMNAT	Acknowledge all alarms with the specified Nature and Domain.
		Return: 1 if successful, else 0.

Syntax 5

IntVal = ALARM(Mode, AlarmName[, Flag]);

Return type: INTEGER.

Execution

Mode	Mnemonic	Action
1	ACK	Acknowledge the alarm AlarmName.
13	SETMAINTENANCE	Force the alarm AlarmName to maintenance mode.
14	RESETMAINTENANCE	Clear maintenance mode for the alarm AlarmName.
17	RESTOREALARMLEVEL	Restore the priority level of the alarm AlarmName.

Return: 1 if successful, else 0.

Syntax 6

IntVal = ALARM(Mode, Priority[, Flag]);

Return type: INTEGER.

Argument	Action
Priority	An alarm priority. Type INTEGER.

Execution

Mode	Mnemonic	Action
12	ACKPRIO	Acknowledge all alarms with specified priority.
		Return: 1 if successful, else 0.

Syntax 7

IntVal = ALARM(Mode, AlarmName, Level);

Return type: INTEGER.

Argument	Action
Level	Priority level of alarms (between 0 and 29).

Execution

Mode	Mnemonic	Action
16	SETALARMLEVEL	Change the priority level of the alarm AlarmName.
		Return: 1 if successful, else 0.

Syntax 8

IntVal = ALARM(Mode, AlarmName, Transition);

Return type: INTEGER.

Argument	Action
Transition	The transition that turns on the alarm. 0 or 1

Execution

Mode	Mnemonic	Action
18	ALARMON	Dynamically modify the transition that turns on the alarm AlarmName. If Transition is 0 then the alarm is turned on with a 1 to 0 transition. If Transition is 1 then the alarm is turned on with a 0 to 1 transition.
		Return: 1 if successful, else 0.