# Alarm Summary

The Alarm Summary operation changes the state of the alarm selected in the alarm summary.

Note:

For information on the naming convention and script keywords, refer to the following.
Naming Conventions

##### Block

##### Text

acknowledgeAlarmsInAlarmSummary(ALARMSUMMARY);

2 1

When selecting the [SetHideFlag] operation.

##### Block

##### Text

setHideFlagForAlarmsInAlarmSummary(ALARMSUMMARY, $Enums.SelectionType.Selected,
2 1 3
[$Enums.AlarmState.Any], $Enums.ShowAlarmMode.Manual);

4 5

1: Alarm summary object

2: Operation

3: Selection type

4: Alarm state

5: It should appear again when

### Operations

[Acknowledge] | ##### Block [Acknowledge] ##### Text acknowledgeAlarmsInAlarmSummary($GraphicObject.AlarmSummary1); | Acknowledges the selected alarm in the alarm summary.
[Delete] | ##### Block [Delete] ##### Text deleteAlarmsInAlarmSummary($GraphicObject.AlarmSummary1); | Deletes the selected alarms in the alarm summary from the alarm database.
[SetHideFlag] | ##### Block [SetHideFlag] ##### Text setHideFlagForAlarmsInAlarmSummary($GraphicObject.AlarmSummary1, $Enums.SelectionType.Selected, [$Enums.AlarmState.Any], $Enums.ShowAlarmMode.Manual); | Hides the selected alarms in the alarm summary and sets the hide flag. Sets how alarms are selected and how alarms behave after being hidden. ### How to Select Alarms Combine the Selection type and Alarm state options to define which alarms to hide. #### Selection type
[Selected] | ##### Block [Selected] ##### Text '$Enums.SelectionType.Selected' | Applies to the selected alarms.
[All] | ##### Block [All] ##### Text '$Enums.SelectionType.All' | Applies to all the alarms.
#### Alarm state
[Any] | ##### Block [Any] ##### Text '$Enums.AlarmState.Any' | Applies to all the alarm states.
[Return] | ##### Block [Return] ##### Text '$Enums.AlarmState.Return' | Applies to Return-to-Normal alarms.
#### Behavior
Selection type | Alarm state | Expected Behavior
Selected | Any | Hides all the selected alarms regardless of their state.
Selected | Return | Hides only the alarms returned to normal among the selected alarms.
All | Return | Hides all the returned to normal alarms regardless of the selection.
### Alarm behavior after hiding Alarm behavior after hiding depends on the alarm summary object's alarm mode setting. [Active] When an alarm occurs again, select whether to display a new alarm with the [It should appear again when] option.
[Manual] | ##### Block [Manual] ##### Text '$Enums.ShowAlarmMode.Manual' | Unless the hide flag is deleted, the alarm will not display even if the alarm occurs again. You can delete the hide flag using [ResetHideFlag] in an alarm group operation.
[Next Alarm] | ##### Block [Next Alarm] ##### Text '$Enums.ShowAlarmMode.NextAlarm' | When an alarm occurs again, the hide flag is deleted and the new alarm is displayed.
In both cases, alarms do not display due to changes in alarm status, other than the occurrence of an alarm. [Historical] When an alarm occurs again, the hide flag is deleted and a new alarm is displayed. Alarms do not display due to changes in alarm status, other than the occurrence of an alarm. [It should appear again when] option is ignored. [Log] A new alarm is displayed every time the alarm status changes. [It should appear again when] option is ignored.