Inactivate - method of object PmaAlarmGroup

Description:

Alarm item inactivation (inactivation of the PmAlarmItem object).

Syntax:

Empty Inactivate(String sId, [Date tTimeOff])

Calling:

oAl.Inactivate sId, tTimeOff

Parameters:

sId	(String) The unique text identifier of the alarm item. See "Identifier" configurator.
tTimeOff	[optional] (Date) Inactivation time. If not set, then the computer current time is used.

Note:

Calling the Inactivate method over the inactive alarm has no effect. An active alarm is inactivated. The behaviour of the alarm during the inactivation is specified by the "Inactivate type" configurator.

If there are several instances of the alarm item with the same identifier (caused by states of alarm items inactive unacknowledged (blue)), then the last, the latest old alarm item is inactivated.

After the attempt to inactivate non-existing alarm item (wrong parameter sId), an error occurs in the INFO system only if in the corresponding PmaAlarmGroup object there is no alarm item with the set Template for dynamically created items (i.e. all alarm items of the PmaAlarmGroup object are statically configured).

The method is synchronous, i.e. it is processed immediately by the alarm subsystem. Nevertheless writing the history to disk is asynchronous, it means that this method passes the request for writing to the history to the alarm subsystem, it is placed into the queue of requests and it is processed later by the alarm subsystem.