Configure Alarm on a Tag
Alarming is a core feature of the Ignition platform. Alarms are conditions that are evaluated with respect to a specific numeric data point. Most commonly, alarms are configured on a Tag.
To configure an alarm on a tag
-
Double-click on the tag to edit it.
The Tag Editor window is displayed. -
Click on Alarming, click the green plus sign + to add a New Alarm to the tag.
-
Enter a Name for the Alarm and set any other settings you wish.
-
In the Alarm Mode Settings choose the appropriate logic that determines if the alarm is active or not.
-
Click Apply or OK to commit the new alarm.
Ignition will start monitoring the alarm immediately.
Alarm Attributes
All alarm states have a list of properties that you can edit or bind when creating or editing a tag. Here is the list of attributes paired with their scripting names. This is useful when using the system.tag.add() and system.tag.edit() functions.
If the attribute you want to reference is not listed, you can simply change the attribute on your tag, export it to XML, and view the reference to the alarm attribute.
|
Group |
Property Name |
Scripting Name |
Description |
|
Main |
|||
|
|
Priority |
priority |
The priority (or "severity") of this alarm. Diagnostic (0), Low (1), Medium (2), High (3), Critical (4) |
|
|
Timestamp Source |
timestampSource |
Dictates whether the timestamp used on the alarm comes from the system or the value. System (0), Value (1) |
|
|
Display Path |
displayPath |
An optional path (separated by "/") that will be used for display and browsing purposes. |
|
|
Ack Mode |
ackMode |
How acknowledgement works for the alarm: Auto (1) - Alarm is acknowledged when cleared. Manual (2) - Alarm acknowledged by user. Unused (0) - Alarm is always marked as 'acknowledged'. |
|
|
Notes |
notes |
Documentation about the alarm. |
|
|
Ack Notes Required |
ackNotesReqd |
Select this option to require operators to provide some explanation when the alarm is acknowledged. true or false |
|
|
Shelving Allowed |
shelvingAllowed |
true or false |
|
Alarm Mode Settings |
|||
|
|
Mode |
mode |
The alarm mode. Equal (0), Not Equal (1), Above Setpoint (2), Below Setpoint (3), Between Setpoints (4), Outside Setpoints (5), Out of Range (6), Bad Quality (7), Any Change (8), Bit State (9), On Condition (10) |
|
|
Setpoint / Low Setpoint |
setpointA |
|
|
|
Inclusive / Low Inclusive |
inclusiveA |
|
|
|
High Setpoint |
setpointB |
|
|
|
High Inclusive |
inclusiveB |
|
|
|
Any Change |
anyChange |
|
|
|
Bit Position |
bitPosition |
The position of the bit, starting at 0, that will be watched. |
|
|
On Zero |
bitOnZero |
If true, will alarm when the specified bit is not high, or "0". |
|
Deadbands and Time Delays |
|||
|
|
Deadband |
deadband |
A numeric deadband of the alarm condition. The interpretation of this value depends on the deadband mode. Note that his deadband is separate from, and evaluated after, the tag's deadband. |
|
|
Deadband Mode |
deadbandMode |
Defines how the deadband value is used. If percent, the value (0-100) will be compared against the Eng. limits defined for the value. Absolute (0), Percent (1) |
|
|
Active Delay |
timeOnDelaySeconds |
The time, in seconds, before the alarm will be considered truly active after the active condition becomes true. Also known as a "rising edge time deadband". |
|
|
Clear Delay |
timeOffDelaySeconds |
The time, in seconds, before the alarm will be considered truly clear after the clear condition becomes true. Also know as a "falling edge time deadband". |
|
|
|
|
|
|
Notifications |
|||
|
|
Active Pipeline |
activePipeline |
The pipeline that will be used to process active events generated by this alarm. |
|
|
Clear Pipeline |
clearPipeline |
The pipeline that will be used to process clear events generated by this alarm. |
|
|
Ack Pipeline |
ackPipeline |
The pipeline that will be notified when the alarm has been acknowledged. |
|
Email Notification Settings |
|||
|
|
Custom Subject |
CustomEmailSubject |
If specified, will be used for the email subject. If blank, the subject defined in the notification block to be used. |
|
|
Custom Email |
CustomEmailMessage |
If specified, will be used for email message. If blank,. the message defined in the notification block will be used. |
|
SMS Notification Settings |
|||
|
|
Custom Message |
CustomSmsMessage |
If specified, will be used for the SMS message. If blank, the message defined in the notification block will be used. |
|
Associated Data |
|||
|
|
yourAssociatedData |
yourAssociatedData |
|