Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

Apps, Widgets, and Controls

Show current alarms or recent alarms and events

  • Last UpdatedJul 18, 2024
  • 2 minute read

You can set the Alarm Control to show either of the following:

  • Current alarms

  • Recent alarms and events

You use the ClientMode Property integer property in scripting to switch the Alarm Control to show current alarms or recent alarms and events at run time.

You can also configure a comment to use when alarms are acknowledged at run time. Use the AckComment.UseDefault Property Boolean property and AckComment.DefaultValue Property string property in scripting to use a default acknowledgement comment at run time.

Note: When the Alarm Client Control is in the Recent Alarms and Events mode, the displayed alarms cannot be acknowledged.

To show current alarms

  1. Double-click the Alarm Control on the canvas. The Edit Animations dialog box appears.

    AlarmMode_CurrentAlarms

  2. If necessary, click Alarm Mode. The Alarm Mode page appears.

  3. In the Client Mode list, click Current Alarms.

  4. In the Alarm Query box, type the alarm query. To create a new line in the Alarm Query box, press Ctrl + Enter. For more information on the valid syntax, see Alarm queries.

  5. If you want to use a default acknowledgement comment, select the Use Default Ack Comment check box and type a comment in the text box.

  6. Click OK.

To show recent alarms and events

  1. Double-click Alarm Control on the canvas. The Edit Animations dialog box appears.

  2. Click Alarm Mode. The Alarm Mode page appears.

  3. In the Client Mode list, click Recent Alarms and Events.

    ClientModeDialogBox.

  4. In the Alarm Query box, type the alarm query. To create a new line in the Alarm Query box, press Ctrl + Enter.

    The alarm query must follow one of the following syntax:

    • \\node\provider!group

    • \provider!group

    • HotBackupName

    For example:

    \galaxy!Area_001

    For Alarm Controls hosted by Automation Object templates or instances, you can specify one of the following alarm queries:

    • \galaxy!<myArea.Tagname> to retrieve alarms and events from the Area object hosting the Automation Object template or instance.

    • \galaxy!<me.Area>!<me.Tagname>.* to retrieve alarms and events from the Automation Object template or instance.

    For more information on alarm queries, see Alarm queries.

  5. If you want to use a default acknowledgement comment, select the Use Default Ack Comment check box and type a comment in the text box.

  6. Click OK.

    TitleResults for “How to create a CRG?”Also Available in