Overview
The AlarmItems represent individual tags or expressions monitored within the solution. The AlarmItem triggers an alarm event when a defined condition occurs, notifying users about it. To define an AlarmItem on your solution, the user must a tag name, the condition that triggers the alarm (e.g., Hi, Lo, Rate of Change), and the threshold value (Limit). The software platform offers optional properties for customization, including priority, auxiliary values, and the alarm message.
On this page:
AlarmItem Configuration
To configure a new or existing AlarmItem, follow the steps below:
Access Alarms → Items.
On the Tag Name column, type the Tag name or select from the available list. Alternatively, copy and paste the Tag's name from Unified Namespace → Tags.
- Enter the condition to trigger the alarm in the Condition field and configure the threshold value in the Limit field.
- In the Group field, choose which AlarmGroup object that defines the behavior for this AlarmItem.
- Once finished, press Enter on your keyboard to save the AlarmItem.
To modify an existing AlarmItem, double-click and modify the desired field. Note that any changes made to the Item will take effect immediately, and the new or modified AlarmItem will be evaluated against the tag values in real-time.
The image below illustrates the process described above. In it, we created an AlarmItem monitoring the tag "ExampleTag" and when its value exceeds or is equal to 50, it will trigger an alarm in the "Warning" AlarmGroup.
For more details about each available property field, see the section below.
Properties Reference
Alarm Item Properties
When configuring an AlarmItem, 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:
If a property column is not visible on the grid, enable it by right-clicking the grid header and selecting it from the list.
Property | Description |
|---|---|
ID | The unique identifier for the item. |
VersionID | The version identifier associated with the 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 | A secondary threshold value. You should use this property in conjunction with the Limits by Shift functionality. Learn more on the Alarm Limits page. |
Limit2 | A tertiary threshold value. Learn more on the Alarm Limits page. |
Disable | Enables or Disables the alarm. |
Deadband | Defines a range in which changes are ignored. |
Setpoint | The desired target value. |
SetpointDeadband | A range around setpoints where changes are ignored. |
Group | The group to which the alarm item belongs. |
Area | The area designation for alarm management. |
Priority | Defines the priority level of the alarm. |
AuxValue | It provides additional information about the alarm, such as the responsible team to be associated with an Alarm Area. Read more on the Alarms Areas page. |
AuxValue2 | A secondary auxiliary value. |
AuxValue3 | A tertiary auxiliary value. |
LockState | The current lock status of the alarm item. |
LockOwner | The user or system that locked the item. |
DateModified | The date the alarm item was last modified. |
DateCreated | The date the alarm item was created. |
Comment | The comments or notes related to the alarm item. |
Message | This is the alarm message displayed to the user upon triggering the alarm. |
Alarm Condition Options
The Condition property defines the trigger for the alarm using the Limit property as the threshold value. It offers a wide range of options and the table below describes them in more detail:
Condition | 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 | The tag's 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. |
In this section: