Property Name | Binding/Scripting Name | Description | Datatype | Applicable Tag Type |
---|
Main |
---|
Name | name | Each alarm has it's own name. For example, if the Tag is representing a level, the alarm name might be High Level. | String | OPC, Query, Expression, Derived, Memory |
Enabled | enabled | This boolean determines whether or not the alarm will be evaluated. A disabled alarm's condition will not be evaluated, and thus will not generate any alarm events. | Boolean | OPC, Query, Expression, Derived, Memory
|
Priority | priority | An alarm's priority can affect how is appears in an Alarm Status table, or can affect how it is escalated through a pipeline. The priorities, which can be referenced by their integer equivalent in scripts and expressions, are: Diagnostic [0], Low [1], Medium [2], High [3], Critical [4]. | String | OPC, Query, Expression, Derived, Memory
|
Timestamp Source | timestampSource | Chooses where the timestamp for the alarm event should come from: the system time of when the event was generated, or the timestamp of the value that tripped the event. | Integer Click here to see valid values Timestamp Source | Integer Value |
---|
System | 0 | Value | 1 |
| OPC, Query, Expression, Derived, Memory |
Label | label |
The following feature is new in Ignition version 7.9.8
Click here to check out the other new features
An optional name that will be used for display purposes. Provides a dynamic alternative to the static name property. If left blank, the name will be used. | String | OPC, Query, Expression, Derived, Memory |
Display Path | displayPath | This is a string value that will be used to display the alarm to operators. If this is blank, the operator will see the path to the Tag instead. Please use the forward-slash character to separate hierarchy levels in this path, for example: East Area/Boilers/Boiler5 | String | OPC, Query, Expression, Derived, Memory
|
Ack Mode | ackMode | Dictates how acknowledgement works for the alarm. - Unused - Acknowledgement will not be used for this Tag, and any alarm that is generated will automatically be marked as acknowledged.
- Auto - The alarm is acknowledged automatically when the alarm becomes cleared.
- Manual - The alarm is never set to be acknowledged by the system, and it is up to the user to manually acknowledge alarms.
| String | OPC, Query, Expression, Derived, Memory
|
Notes | notes | A place for any free-form documentation about the alarm that can be displayed to operators. | String | OPC, Query, Expression, Derived, Memory
|
Ack Notes Required | ackNotesReqd | If this setting is true, the operators will be unable to acknowledge this alarm without entering some notes. | Boolean | OPC, Query, Expression, Derived, Memory
|
Shelving Allowed | shelvingAllowed | If this setting is true, the shelving feature will be unavailable for this alarm. | Boolean | OPC, Query, Expression, Derived, Memory
|
Alarm Mode Settings |
---|
Mode | mode | This setting controls what condition this alarm is evaluating. The available modes are as follows: - Equal - Active when the Tag's value equals the alarm's setpoint.
- Not Equal - Active when the Tag's value does not equal the alarm's setpoint.
- Above Setpoint - Active when the Tag's value is above the alarm's setpoint.
- Below Setpoint - Active when the Tag's value is below the alarm's setpoint.
- Between Setpoints - Active when the Tag's value is between the low and high setpoints. If any change is true, an event will be generated for each value change between the setpoints.
- Outside Setpoints - Active when the Tag's value falls outside the low and high setpoints. If any change is true, an event will be generated for each value change outside the setpoints.
- Out of Range - The same as Outside Setpoints, but uses the Tag's Engineering High and Engineering Low as the high and low setpoints.
- Bad Quality - Active if the Tag value becomes a bad quality, for example, on communication loss.
- Any Change - An alarm event is generated every time the Tag value changes. Note that this alarm will never be "active" because each active event is paired with a matching clear event, instantly.
- Bit State - This alarm mode is used to alarm when a specific bit out of an integer Tag becomes high. You must specify which bit position to use, with zero being the least significant bit. The On Zero property is used to invert the logic and alarm when the bit is low.
- On Condition - This free-form alarm mode is used for when you want to specify the condition using an expression or another Tag. To do this, bind the "Is Active" property to an appropriate expression or Tag.
| String | OPC, Query, Expression, Derived, Memory
|
Setpoint / Low Setpoint | setpointA | The value used to initiate an alarm. If the alarm mode calls for two setpoints, this is the low value. | Double | OPC, Query, Expression, Derived, Memory
|
Inclusive / Low Inclusive
| inclusiveA | If true, the Setpoint or Low Setpoint value is used inclusively for the condition to alarm. | Boolean | OPC, Query, Expression, Derived, Memory
|
High Setpoint | setpointB | The high value used to initiate an alarm when the alarm mode calls for two setpoints. Available for modes: Between Setpoint, Outside Setpoints. | Double | OPC, Query, Expression, Derived, Memory
|
High Inclusive | inclusiveB | If true, the High Setpoint value is used inclusively for the condition to alarm. Available for modes: Between Setpoint, Outside Setpoints. | Boolean | OPC, Query, Expression, Derived, Memory
|
Any Change | anyChange | If true, will alarm on each value change given the alarm mode conditions are met. Note that this alarm will NEVER be "active" because each active event is paired with a matching clear event, instantly. Available for modes: Above Setpoint, Below Setpoint, Between Setpoints, and Outside Setpoints. | Boolean | OPC, Query, Expression, Derived, Memory
|
On Zero | bitOnZero | If true, will alarm when the specified bit is not high (when the bit is 0). Available for modes: Bit State. | Boolean | OPC, Query, Expression, Derived, Memory |
Bit Position | bitPosition | The position of the bit, starting at 0 that will be watched. Available for modes: Bit State. | Integer | OPC, Query, Expression, Derived, Memory |
Is Active | activeCondition | When this property is active, the alarm will be active. Typically has a binding of some sort that will be used to determine when the alarm goes active. If the expression evaluates to True, the alarm is active. If the expression evaluates to False, the alarm is not active. Available for mode: On Condition. | Boolean | OPC, Query, Expression, Derived, Memory |
Deadbands and Time Delays |
---|
Deadband | deadband | The value for the deadband, interpreted according to the Deadband mode. Note that all alarms are only evaluated after the Tag's value changes, which means that the Tag's own deadband will be considered first. When the deadband is positive, an active alarm condition needs to clear its setpoint(s) by the amount of the deadband for the alarm to clear. For example, suppose you had a Between Setpoints alarm with a low setpoint of 50 and a high setpoint of 70, and with a deadband of 2. The alarm will go active if the value is between 50 and 70, but will only clear if the value falls below 48 or rises above 72. | Double | OPC, Query, Expression, Derived, Memory
|
Deadband Mode | deadbandMode | Defines how the deadband value is used. - Absolute - The deadband setting is considered to be an absolute value.
- Percent - The actual deadband is calculated as a percent of the Tag's engineering unit span.
| Integer Click here to see valid values Alarming Deadband Mode | Integer Value |
---|
Absolute | 0 | Percent | 1 |
| OPC, Query, Expression, Derived, Memory
|
Active Delay | timeOnDelaySeconds | The time, in seconds, before the alarm will be considered active after the alarm's condition becomes true. Also known as a "rising edge time deadband." | Double | OPC, Query, Expression, Derived, Memory |
Clear Delay | timeOffDelaySeconds | The time, in seconds, before an active alarm will be considered clear after the alarm's condition becomes false. Also known as a "falling edge time deadband." | Double | OPC, Query, Expression, Derived, Memory |
Notification |
---|
Active Pipeline | activePipeline | The name of an alarm notification pipeline to put this alarm into when it becomes active in order to send out active alarm messages. Many alarms may share a single pipeline. | String | OPC, Query, Expression, Derived, Memory |
Clear Pipeline | clearPipeline | The name of an alarm notification pipeline to put this alarm into when it becomes cleared in order to send out cleared messages. | String | OPC, Query, Expression, Derived, Memory
|
Ack Pipeline | ackPipeline | The name of the alarm notification pipeline to put this alarm into when the alarm has been acknowledged. | String | OPC, Query, Expression, Derived, Memory |
Email Notification Properties |
---|
Custom Subject | CustomEmailSubject | A string that will be used as the subject line of an email notification message. If blank, the message settings defined on the notification block that sent the email out will be used instead. | String | OPC, Query, Expression, Derived, Memory |
Custom Message | CustomEmailMessage | A string that will be used as the body of this alarm's email notification message. If blank, the message settings defined on the notification block that sent the email out will be used instead. | String | OPC, Query, Expression, Derived, Memory |
SMS Notification Properties |
---|
Custom Message | CustomMessage | If specified, will be used for the SMS message. If blank, the message defined in the notification block will be used. | String | OPC, Query, Expression, Derived, Memory |
Associated Data |
---|
User Defined Data |
| Associated Data are custom alarm properties that can be added to any alarm. These properties will often be bound to other Tags that represent associated contextual data that may be related to the alarm. A snapshot of the values of these properties will be taken when the alarm becomes active. These values will be attached to the alarm event as it moves through the rest of the alarming system, meaning that the values will be available from the alarm status system, the alarm journal system, and in the alarm notification system. | String | OPC, Query, Expression, Derived, Memory
|