Alarm

Overview

The Alarm feature lets you configure monitoring rules for Data Source tags on the Dashboard. When a tag's value reaches or matches a condition you define, the Alarm Display widget raises an alarm, and every triggered event is recorded in Alarm History for later review and auditing. This helps you detect system issues promptly instead of letting them go unnoticed.

Who This Is For

Intended for operations staff and managers who monitor production lines or equipment status and need to track issues through to resolution.

Prerequisites

• The tags you want to monitor must already exist on the Data Source page before you can select them in an alarm rule.
• Creating, editing, or deleting alarm rules requires Domain Superuser permission, or Dashboard management permission on the Subdomain the HMI belongs to. Users without this permission can only view alarm rules and Alarm History.

Setting Alarm Rules

1. Select the HMI

   At the top of the page, choose the HMI you want to configure alarm rules for.

2. Add Alarm Rule

   Click the [+ Add Rule] button to start monitoring a Data Source tag.

3. Configure Conditions

   Based on the tag's data type, choose the appropriate operator and operand:

   • Data Type: Int & Float

     Operator	Operand	Trigger Example	Normal
     >	1	2	1
     >=	1	1	0
     <	2	3	2
     <=	2	3	1
     ==	2	2	1
     !=	2	3	2

     When the operator is == or !=, you can additionally set a Tolerance, allowing the value to still be considered a match (or non-match) within an acceptable margin, which prevents false triggers caused by minor fluctuations.

   • Data Type: String

     Operator	Operand	Trigger Example	Normal
     is	hello	hello	abc
     contains	hello	helloworld	abc
     doesn't contain	hello	abc	helloworld
     is empty			any word
     is not empty		any word

     Except for is empty/is not empty, all other comparisons support a Case sensitive option.

   • Data Type: Boolean

     Operator	Operand	Trigger Example	Normal
     ON		TRUE	FALSE
     OFF		FALSE	TRUE
     ON→OFF		Previous value TRUE, next FALSE	TRUE
     OFF→ON		Previous value FALSE, next TRUE	FALSE

4. Set the Alarm Name

   Must be 2 to 64 characters, and unique within the same HMI.

5. Set Severity

   Choose one of four levels: Low, Medium, High, or Critical.

6. Set Category

   Create custom categories to organize alarms. Up to 5 categories can be assigned per alarm rule. The category name must be 2 to 64 characters.

7. Set the Message

   Customize the content displayed when an alarm is triggered, using the following built-in parameters:

   • {{.AlarmRuleName}}: The alarm name
   • {{.TriggeredValue}}: The triggered value
   • {{.TriggeredAt}}: The trigger time
   • {{.TagName}}: The tag name
   • {{.TagType}}: The tag's data type
   • {{.HWKey}}: The Hardware Key

Rule Limitations

• Each HMI can have up to 100 alarm rules.
• Alarm names must be 2 to 64 characters and unique.
• Up to 5 categories can be assigned per alarm rule.

Alarm History

On the Alarm History page, you can view, filter, and track past alarm events.

Summary and Filters

• Summary tiles at the top of the page show counts by Critical, High, Medium, Low, and Acknowledged/Unacknowledged status, giving you an overview at a glance.
• Facet filters let you narrow results by Tag, Alarm Name, Category, Severity, and Status, each showing a live match count.
• The queryable date range is limited to 3 months.
• Columns can be shown, hidden, and resized; the HMI you last selected is remembered when you navigate away and back.

Column Contents

1. Trigger Time: When the event occurred; helps identify whether certain time periods are more prone to issues.
2. Recovered Time: When the system detected the state returning to normal; helps evaluate recovery speed and efficiency (hidden by default — enable it to display).
3. Message: The detailed content shown when the alarm was triggered, for quick problem identification.
4. Status: Shows whether the alarm is Active, Recovered, or Disconnected. If the HMI or tag disconnects after the alarm is triggered, the record stays in the Disconnected status and will no longer show as recovered.
5. Alarm / Tag: Combines the alarm name, tag name, and tag data type in a single column, identifying which rule and tag triggered the alarm.
6. Trigger Value: The actual value at the time of triggering, for analyzing the specific data involved.
7. Recovery Value: The value when the alarm recovered, for checking whether the recovery condition was met.
8. Severity: Categorizes the importance of the alarm, to help prioritize high-severity issues.
9. Category: Used to organize alarms for easier searching and management (hidden by default — enable it to display).
10. Ack By: The user who manually acknowledged the alarm. Not available as a toggleable column — it only appears in the alarm detail view and in exported files.

Acknowledging Alarms

You can acknowledge alarms in any of the following ways:

• Select the alarms in the table and click the [Acknowledge] button in the toolbar to acknowledge them in bulk.
• Acknowledge a single alarm directly from its Status cell.
• Open the alarm detail view and click the Acknowledge button inside it.

Alarm Detail

Clicking an alarm entry opens its detail view, showing a full timeline of Trigger, Acknowledge, and Recovery, with navigation to the previous or next alarm event.

Export and Delete

• The full page or selected rows of Alarm History can be exported to CSV.
• Selected records can be deleted in bulk, or all history can be cleared. Deleted history cannot be recovered — confirm whether you still need the records before deleting.

FAQ

• After an alarm is triggered and the device or tag disconnects, why does the history never show as recovered?

  Disconnected is itself a status. Once the HMI or tag enters the Disconnected status after an alarm is triggered, that record stays in the Disconnected status; check the actual connection separately to determine whether it has recovered.

• Why can't I find "Ack By" in the column settings?

  Ack By is not available as a toggleable table column — it only appears in the alarm detail view and in the exported CSV file.

Related Documentation

For the Alarm Display widget, see Alarm Display Widget.