SetSuppressed

(Alarm Manager module)

Description:	AlarmManager subroutine that handles the suppressing and unsuppressing of alarms.
Returns:	Nothing
Usage:	Script Only.
Function Groups:	Alarm Manager
Related to:	Commission \| EvaluateAlarm
Format:	\AlarmManager.SetSuppressed(AlarmName, Suppress[, Timestamp, Custom, FromPLC, Description])
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).

Suppress

Required. Boolean that indicates whether to suppress (TRUE) or unsuppress (FALSE) the alarm.

Timestamp

Optional numeric. The UTC timestamp of this event. Defaults to now.

Custom

Optional structure. A structure of custom fields to log.

FromPLC

Optional Boolean. Used only with the PLCAlarm tag. True if unsuppress events happened in the PLC.

Description

Optional. If used, it supersedes the Description that is typically retrieved from the config struct (CfgStructure) of Commission.

Comments: