Object: Alarm Class

An alarm class defines the basic properties of an alarm. Afterwards, an alarm is typed.

Priority

Specification of the priority of the alarm class (0–255).

The prioritization of alarms should make sure that all alarms can be structured accordingly.

Archiving

: Alarms of this class are archived.

An alarm of this class is archived when it is triggered at runtime and is displayed in the alarm table.

Note: In order for archiving to happen, the Alarm Storage object must exist and be configured below the alarm configuration.

Table 125. Acknowledgement

Acknowledgement method	The visualization user must acknowledge the alarm in order for the alarm to be removed from the alarm list. Tip When you move the mouse pointer over the possible acknowledgment methods in the expanded list box in the editor, the respective state transition chart is displayed on the right side.
Acknowledgement method: `ACK`	The alarm becomes inactive after acknowledgement. This is the acknowledgment method for Events. State transition chart: State transition chart when the Acknowledge instead of confirm option is selected:
Acknowledgement method: `REP`	The alarm is inactive after the cause is resolved. State transition chart:
Acknowledgement method: `REP_ACK`	The alarm is inactive after the cause has been resolved and acknowledgement. State transition chart: State transition chart when the Acknowledge instead of confirm option is selected:
Acknowledgement method: `ACK_REP`	The alarm is inactive after acknowledgement and the cause has been resolved. State transition chart: State transition chart when the Acknowledge instead of confirm option is selected:
Acknowledgement method: `ACK_REP_ACK`	The alarm is active. After the optional acknowledgement that the alarm has been received, the alarm becomes inactive. The cause must then be resolved and the end of the alarm event acknowledged. State transition chart: State transition chart when the Acknowledge instead of confirm option is selected:
State transition chart	Alarm states Normal: No alarm situation exists. No alarm has been triggered (normal state). `Active` Active: An alarm situation has occurred. `Waiting for confirm.` The alarm is inactive, but the acknowledgement with "Confirm" (for resolving the cause of the alarm event) has not yet been given. The system is still waiting for it. `Inactive, Unacknowledged` Waiting for confirmation: An alarm no longer exists; a confirmation has not been received yet. Inactive, not acknowledged The alarm has been triggered and exists. The acknowledgement (for ending the alarm) has already been given. State transitions `activate` The alarm event occurs and triggers an alarm. The alarm is active ("alarm coming"). `deactivate` An alarm is ending ("alarm going"). `confirm` The acknowledgement is given that the cause of the alarm event has been resolved for an alarm that is already inactive. `ACK` The acknowledgement is given that an alarm should be ended. `Re-Alarm` The alarm is reactivated. The alarm event has not been resolved (and its resolution has not been acknowledged).

Acknowledge separately	: In runtime mode, the visualization user cannot acknowledge the alarm together with other alarms, but must acknowledge it separately. This prevents the visualization user from accidentally acknowledging an alarm together with other alarms.
Reset digital alarms automatically	: Boolean variables which have triggered an alarm (of observation type "Digital") are automatically reset upon acknowledgement.
Acknowledge instead of confirm	: Compliant with OPC UA (without "confirm")
Re-Alarm time	Time literal which specifies the length of time after which an acknowledged alarm is reactivated if the alarm event is still active. For acknowledgement methods `ACK_REP` and `ACJ_REP_ACK`. The typical duration for this is 30 minutes. Example: `t#30m`

Table 126. Notification Actions

List of notification actions Hint: When you select an action in the list, details are displayed in a separate window below this list. The details vary depending on the type of action.
Action	The configured action is executed on transition from one state to the other. Hint: To select one of the following action types, double-click in the column.
Action: Variable	The Variable action is done during the state transition. The variable is set to the configured value. This allows you to react programmatically to the state transition.
Action: Execute	The Execute action is done during the state transition. The specified program is executed.
Action: Call	The Call action is done during the state transition. The specified function block instance is called.
State transition: Activate	: The action is executed with "`Activate`" when the transition to the "`Active`" state is done. The available state transitions depend on the selected Acknowledgement method. At least one alarm state transition must be selected.
State transition: Deactivate	: The action is done with "`Deactivate`" when switching to the"`Normal`" state.
State transition: Confirm	: The action is executed with "`Confirm`" when the transition to the "`Normal`" state is done.
State transition: ACK	: The action is executed with "`ACK`" when the transition to the "`Active, Acknowledged`" state is done.
Details	Displays a summary of the action definition. The definition itself is displayed below the table. Edit the action there.
Variable for Deactivation	Variable via which an application can deactivate the action.

Table 127. Action type: Variable

Requirement: An action with type Variable is selected. The details vary depending on the action type of the action selected in the Acknowledgement actions window as follows.
Variable	Variable (IEC application variable) Serves as a control variable (flag) to call an action code programmatically
Right field	Literal, variable, or expression You can select the variables via the Input Assistant. In the case of Boolean variables you can use the placeholder `ALARM`, in the case of integer variables the placeholder `STATE`. In the case of string variables, you can specify any IEC string literal (example: `'too high!'`).
Placeholder: `ALARM`	State (`TRUE` or `FALSE`) of the alarm of this alarm class which was last activated/deactivated
Placeholder: `STATE`	The placeholder contains the currently reached alarm state of this alarm class (when the application is running). `0: Normal` `2: Active` `3: WaitingForConfirmation` `4: ActiveAcknowledged`

Table 128. Action type: Execute

Requirement: An action with type Execute is selected.

The details vary depending on the action type of the action selected in the Acknowledgement actions window as follows.

Executable file

Path and file name of the executable file on the controller.

Parameter

One or more parameters that you add to the call. You separate multiple parameters by a space.

Table 129. Action type: Call

Requirement: An action with type Call is selected.

The details vary depending on the action type of the action selected in the Acknowledgement actions window as follows.

Function block instance

Function block that is called.

The function block must implement the IAlarmNotifiable interface (AlarmManager.library). The desired action on a change of state is implemented in the Execute method.

Additional parameter structure

If the function block requires an additional parameter structure, the structure members are listed on this table and can be filled here. An additional parameter structure is defined in the function block with the attribute AlarmManagerAdditionalData.

Example: The function block has the following attribute.

{attribute 'AlarmManagerAdditionalData' := 'StructEmailParams'}

The structure employed must consist of scalar components or components of the type POINTER TO.

Note: The ARRAY OF data types or custom data types are not supported.

Note: Using the {attribute 'AlarmManagerMandatoryParameter'} attribute you can identify structure members as required parameters.

Table 130. Display Options for Alarm Table/Alarm Banner

Configures how the different states of an alarm are displayed in the alarm visualization element (alarm table or alarm banner).
State	Alarm state whose display is configured The available states depend on the selected Acknowledgement method.
Font	The default dialog for the selection of a font or color is opened with the button.
Background color	Background color for the alarm state
Bitmap	Icon for the alarm state You can add a bitmap by entering the bitmap ID. If no image file is assigned to this ID yet, the standard file search dialog opens. After having selected a file, the bitmap definition of the image pool GlobalImagePool is added.
Transparent	: The bitmap is displayed with a transparent color.
Transparent color	Color that is to be displayed transparently. Relevant only if the Transparent option is activated.