Overview
The Alarm Item is the core object of the Alarms Module, it is a tag monitored by the Alarms Module. It contains information such as the tag name and the alarm condition. You can group them into Alarm Groups, simplifying the management of similar or related alarms.
On this page :
Configuring Alarm Items
To configure a new or existing Alarm Item, follow the steps below:
Access Alarms > Items.
To create a new Alarm Item, double-click an empty Tag Name field and enter the name of the tag to be monitored.
- Enter a condition to trigger the alarm in the Condition field.
- Enter the treshold value in the Limit field.
- In the Group field, choose which Alarm Group this Item will belong.
In the example image above, we created an Alarm Item monitoring the tag "ExampleTag". When its value exceeds or is equal to 50, it will trigger an alarm in the "Warning" Alarm Group. - Press Enter to save the Alarm Item.
To modify an existing Alarm Item, double-click and modify the desired field. Note that any changes made to the Alarm Item will take effect immediately, and the new or modified Alarm Item will be evaluated against the tag values in real-time.
For more details about each available property field, see the section below.
Alarm Item Properties
When configuring an Alarm Item, the essential properties to define are the Tag Name and Condition. These two elements form the core of the configuration, dictating when and how alarms are triggered. Additionally, you can set up other properties based on the specific use of the alarm. The following is a table describing each available property field for the Alarm Item:
Property | Description |
ID | The unique identifier for the alarm item. |
Version ID | The version identifier associated with the alarm item. |
TagName | The name of the tag being monitored for alarm events. |
Condition | Defines the condition that triggers the alarm. The next section of this page describes in more detail the different options for this property. |
Limit | Defines the predefined threshold for the alarm. |
Limit1 | Secondary threshold value. |
Limit2 | Tertiary threshold value. |
Disable | Option to enable/disable the alarm. |
Deadband | Range in which changes are ignored. |
Setpoint | Desired target value. |
SetpointDeadband | Range around setpoint where changes are ignored. |
Group | Group to which the alarm item belongs. |
Area | Area designation for alarm management. |
Priority | Priority level of the alarm. |
AuxValue | Auxiliary value associated with the alarm. |
AuxValue2 | Secondary auxiliary value. |
AuxValue3 | Tertiary auxiliary value. |
TemplateID | Template identifier linked with the alarm. |
LockState | Current lock status of the alarm item. |
LockOwner | User or system that locked the item. |
DateModified | Date the alarm item was last modified. |
DateCreated | Date the alarm item was created. |
XRefInfo | Cross-reference information for the alarm. |
Comment | Comments or notes related to the alarm item. |
Message | Alarm message displayed upon triggering. It enables that a message to appear to the user when an alarm is triggered. |
Alarm Condition Options | |
|---|---|
Field | Description |
Hi | Tag >= limit |
HiHi | Tag >= limit (when acknowledged, a Hi alarm is automatically acknowledged for the same Tag) |
Lo | Tag <= limit |
LoLo | Tag <= limit (when acknowledged, a Lo alarm is automatically acknowledged for the same Tag) |
RateOfChange | Tag rate of change >= limit |
DeviationMinor | Absolute value (tag - Setpoint) > limit |
DeviationMajor | Absolute value (tag - Setpoint) > limit |
Equal | Tag = limit |
GreaterThan | Tag > limit |
GreaterEqual | Tag >= limit |
LessThan | Tag < limit |
LessEqual | Tag <= limit |
Changed | Tag value changed |
ChangedUp | Tag value increased |
ChangedDown | Tag value decreased |
NotEqual | Tag different from limit |
Adding And Editing AlarmItem
The AlarmItem is the core object of the Alarms module, which represents a condition that triggers an alarm event when a certain criterion is met. Here we will discuss how to add new AlarmItem or modify the existing ones.
To add a new alarm item, follow these steps:
Open the AlarmItem configuration page by selecting Alarms > AlarmItem in the Solution Browser.
Click the 'New Level...' button at the bottom of the AlarmItem list.
In 'Alarms > Items', enter the required fields, which include Tag Name, Condition, and Alarm Group.
You can also configure optional fields such as Limit, Deadband, Setpoint, Setpoint Deadband, Group, Area, Priority, Message, and Priority Order.
Click OK to save the new Alarm Item.
To modify an existing Alarm Item, follow these steps:
Open the 'Alarms > Items' configuration page by selecting Alarms > AlarmItem in the Solution Browser.
Select the Alarm Item you want to modify from the list.
Modify the fields as required.
Click OK to save the changes.
It is important to note that any changes made to the AlarmItem will take effect immediately, and the new or modified AlarmItem will be evaluated against the tag values in real-time.
In this section: