Alarm integration

Alarm integration helps show different types of alarm counts on TGML graphics. You can have Active Alarms Count, UnAcknowledged Alarms Count and Total Alarm Count with GroupBy for different equipment or clusters rendered on the TGML graphics. It is also possible to group these counts based on priority, type of alarm, and incidents.

Designing an Alarm TGML

To design an Alarm TGML:

  1. In the Graphics Editor, create a TGML file with some text boxes to display alarm counts with specific labels. For example, Active Alarms Count, or Total Alarm Count with GroupBy.

  2. Create binds for counts that should be displayed on the TGML. Binds can be for overall counts or specific to equipment.


    NOTE: Make sure that the name of the Alarms bind starts with ~ALM: and the specific type of alarm count. For example, ~ALM:Active Alarms Count or ~ALM:Total Alarm Count with GroupBy. You can do the bind manually or select the bind from the binding window.

    Example:

  1. Save the TGML file.
  2. Confirm the Alarm TGML in Diagrams.

Alarm count grouping

The custom property GroupBy is used to filter alarm counts for specific equipment or all components.

You can modify the custom property: GroupBy for the following attributes:

  • Priority
  • Alarm Type (Type)
  • IncidentID

Each parameter must be separated by an ampersand (&) and the value must be followed by '='.

Use Case 1:

If you want the information on total alarms count with Priority set to Low, then you can use the custom property: GroupBy as shown below, but the bind remains same as ~ALM:TotalAlarmsCount.

Use Case 2:

If you want the information on total alarms count with Priority set to Low and Type set to ALM_COMMLOSS, then you can use the custom property: GroupBy as shown below, but the bind remains same as ~ALM:TotalAlarmsCount.

Use Case 3:

If you want the information on alarms count by equipment name with Priority set to Low, Type set to ALM_COMMLOSS, and IncidentID set to IN_OVER_VOLTAGE_1234, then you can use the custom property: GroupBy as shown below, and the bind looks like PLSDCluster.High_Voltage.Generators.GEN1.~ALM: TotalAlarmsCount.

NOTE: If the component binds with the equipment name, it summarizes the counts based on equipment name accordingly.

For more information, see the Binding and filtering alarm counts workflow.