Decommission

(Alarm Manager module)

Description:	Decommission an alarm by name.
Returns:	Nothing
Usage:	Script Only.
Function Groups:	Alarm
Related to:	Commission
Format:	\AlarmManager\Decommission(AlarmName)
Parameters:

AlarmName

Required text. The alarm name. Typically, the unique id of the alarm tag, or the tag containing built-in alarms.

Comments:

An alarm tag that is deleted without being decommissioned is referred to as an orphaned alarm. VTScada will removed orphaned alarms automatically, but it is better practice to specifically decommission the alarm

Example:

The following would typically be found in a tag's Refresh state.

IfElse(Valid(Name), Execute(
                      { ... Alarm commissioning code ... }
                    );
       { Else }
       IfThen(Valid(Parm[#Name]),
               \AlarmManager\Decommission(Root\UniqueID);
             );
);