(Alarm Manager module)
| Description: | Removes an alarm from the specified list in an Alarm Database, usually a custom list. |
| Returns: | Nothing |
Usage:  |
Script Only. |
| Function Groups: | Alarm Functions |
| Related to: | AddToList | Commission | EvaluateAlarm |
| Format: |
\AlarmManager.RemoveFromList(AlarmName, ListName, Action[, TimeStamp, AccountID, Device, RecordGUID, HookName, MachineID, Custom, NoteRequired, NoteMinLength, FromPLC, Description]) |
| Parameters: |
| Alarm Name |
| Required text. A unique name for the alarm. Typically, the unique ID 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). |
| ListName |
| Required. The name of the list to remove from, e.g. “Active”. |
| Action |
|
A string or PhraseID that identifies the reason for the transaction. For default options, see Alarm Action Codes in Alarm API Structure Definitions |
| Timestamp |
| Optional. UTC timestamp of the value. Defaults to the current time. |
| AccountID |
| Optional. AccountID of operator |
| Device |
| Optional. Name of client device. |
| RecordGUID |
| GUID of the specific record to remove from the list. If Invalid, all records for the specified AlarmName will be removed. |
| HookName |
| Advanced Option. Name of the hook module to call before logging this transaction. |
| MachineID |
| Optional. Workstation MachineID. Defaults to local. |
| Custom |
| Optional. Structure of custom fields to be logged with the event. |
| NoteRequired |
| Optional. TRUE to prompt for a note before the transaction. |
| NoteMinLength |
| Minimum length of note (Defaults to 1.) |
| FromPLC |
| Advanced Option. Set to FALSE. |
| Description |
| Optional. Customized description, used if it differs from the description given to Commission. |
| Comments: |
Advanced users only. RemoveFromList can be used Remove an alarm from a custom list. The custom list can be displayed by specifying it in a <ListFormats><Format> section of AlarmListsFormats.XML as defined in Customize Columns in Alarm Displays To remove an alarm from the Active of Unacked lists, Ackand EvaluateAlarm may be more practical. |
Example:
To remove an alarm from a custom "Deferred" list:
\AlarmManager.RemoveFromList(AlarmName, “Deferred”, “UndeferLabel”);
