Skip to main content

Search

Welcome to ISS Support

How to Get Started with the Alarm Client Control in InTouch

APPLIES TO:

  • Application Server 3.1 and newer
  • InTouch 10.1 and newer

SUMMARY

The Alarm Client is a .NET control used for visualizing and monitoring alarms. It allows operators to see the state of alarms and events and has functionality for sorting, acknowledging, and handling alarms. It is available in all modern and managed InTouch applications as well as in a Standalone + Symbols application in InTouch 2020 and newer. This article is to help users get started with the implementation of this graphic.

NOTE: Industrial Graphics were formerly known as ArchestrA Graphics.

PROCEDURE

  1. Create a new Industrial Graphic by right-clicking on the desired Graphic Toolset (folder) and select New Graphic.

     

  2. When the new symbol is created it is automatically in rename mode. Rename the graphic if you please. 

  3. To get started on graphical editing, right-click on the new symbol and select Open or double-click on the symbol.

     

  4. The Symbol Editor editor will open. From the Tools pane select the Alarm Client element.

  5. Click on the canvas to place the Alarm Client.

  6. You can rename the element if you wish from Properties - > Graphic -> Name on the right or click on the name under Elements.

  7. Double-click or right-click on the new graphic and select Edit Animations. 

  8. The Edit Animations window opens. The first configuration option to configure is the Alarm Mode. By selecting a Client Mode, you can choose whether to display real-time or historical alarms. By default, the Client Mode is set as Current Alarms. You can configure your alarm query with the syntax \InTouch!AlarmGroup for standalone InTouch alarms, or \Galaxy!AreaName for galaxy alarms. The default is \InTouch!$System which will query the InTouch application's $System alarm group.

  9. Below is an example of looking at historically logged alarms and/or events. This will require you to specify a database location with valid connection credentials. 
  • Current Alarms: Shows currently activate alarms from the Alarm Manager.
  • Recent Alarms and Events: Shows historical alarms and events stored in Alarm Manager.
  • Historical Alarms: Shows only alarms stored in the Alarm database.
  • Historical Events: Shows only events stored in the Alarm database.

  • Historical Alarms and Events: Shows both alarms and events stored in the Alarm database.

  1. Once you have chosen an Alarm Mode, you can configure a variety of other settings such as the Colors, Column Details, Run-Time Behavior, and more options listed in the Configuration. 
  • Colors: Set the color for different types of alarm records in order to more easily identify types of alarms, as well as configure the background, grid, and heading colors.
  • Column Details: Set what columns you want to display at runtime in the Alarm Client, as well as the order, name, size, and sorting criteria for the columns.
  • Queries and Filters: Current and historical alarms can be filtered. A query filter is a collection of filter criteria in a logical construct, such as only showing alarms with priorities larger than 500 but smaller than 750.
  • Time Settings: Set the time zone and time format. By default, the time zone is set to the client computer's current time zone.
  • Run-Time Behavior: Configures the behavior and appearance of the Alarm Client at runtime, such as showing or hiding parts of the Alarm Client, restricting operator access, and customizing the runtime shortcut menu.
  • Data Binding: Binds the properties of an Alarm Client to attributes or element references.

  • Event: Configure scripts that are executed when an Alarm Client event occurs.

  1. Once you have finished configuring the Alarm Client Animations, you can click OK to close the Edit Animations window. 

  2. Once finished making any other desired changes in the Symbol Editor, select the Save and Close button to save your changes and exit Symbol Editor.

  3. The symbol will needed to be embedded in a window in order to display the Alarm Client at runtime. You can either right-click on the canvas, select Embed Industrial Graphic, and select the appropriate symbol or select the graphic from Industrial Graphics and drag onto the canvas.

  4. Below is an image of the new Alarm Client in runtime.

All Industrial Software Solutions Tech Notes are provided "as is" without warranty of any kind.