Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

The Alarm Items AlarmItems represent individual tags or expressions monitored within the solution. The Alarm Item AlarmItem triggers an alarm event when a defined condition occurs, notifying users about it. To define an Alarm Item AlarmItem on your solution, the user goes to Alarms/ Items and sets must a tag name, the condition that triggers the alarm (e.g., Hi, Lo, Rate of Change), and the threshold value (Limit). Alarms/Items list the specified tags along with their Conditions and Limits. The software platform offers optional properties for customization, including priority, auxiliary values, and the alarm message.

On this page: 

Table of Contents
stylenone

Tip
titleSolution Example

Alarms Examples



Image Added


AlarmItem Configuration

To configure a new or existing AlarmItem, follow the steps below:

  1. Access Alarms Items.

  2. 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.

  3. Enter the condition to trigger the alarm in the Condition field and configure the treshold threshold value in the Limit field.
  4. In the Group field, choose which Alarm Group this Item will belong toAlarmGroup object that defines the behavior for this AlarmItem.
  5. Once finished, press Enter on your keyboard press Enter  to save the Alarm ItemAlarmItem.


Info

To modify an existing Alarm ItemAlarmItem, 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 AlarmItem will be evaluated against the tag values in real-time.


The image below illustrates the process described above. In it, we created an Alarm Item AlarmItem monitoring the tag "ExampleTag" and when its value exceeds or is equal to 50, it will trigger an alarm in the "Warning" Alarm GroupAlarmGroup.

For more details about each available property field, see the section below.

Alarms Usage at Runtime

Using a configured Alarm Items in the Alarm Modules at runtime is straightforward. Add a AlarmViewer to a display and configure it by defining the List by selecting the source of alarms to display in the viewer. To use it, navigate to Displays/Draw, select the Module category, choose AlarmViewer, and place it on the Drawing area by clicking or dragging and dropping. Double-click the object to configure it.

Refer to AlarmsViewer Control for more details.


Properties Reference

Alarm Item

properties

Properties

When configuring an Alarm ItemAlarmItem, 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:

Info

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

alarm

item.

Version ID

VersionID

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

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.

Setpoint Deadband

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.

Aux Value

AuxValue

It provides additional information about the alarm, such as the responsible team to be associated with an Alarm Area. Read more on the

Alarm

Alarms Areas page.

Aux Value 2

AuxValue2

A secondary auxiliary value.

Aux Value 3

AuxValue3

A tertiary auxiliary value.

TemplateID

LockState

The

template identifier linked with the alarm.

Lock State

The

current lock status of the alarm item.

Lock Owner

LockOwner

The user or system that locked the item.

Date Modified

DateModified

The date the alarm item was last modified.

DateCreated

The date the alarm item was created

.

X Ref Info

A cross reference of information for the alarm

.

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

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).

Rate Of Change

RateOfChange

The tag's rate of change >= Limit.

Deviation Minor

DeviationMinor

Absolute value: (Tag - Setpoint) > Limit.

Deviation Major

DeviationMajor

Absolute value: (Tag - Setpoint) > Limit.

Equal

Tag = Limit.

Greater Than

GreaterThan

Tag > Limit.

Greater Equal

GreaterEqual

Tag >= Limit.

Less Than

LessThan

Tag < Limit.

Less Equal

LessEqual

Tag <= Limit.

Changed

Tag value changed.

Changed Up

ChangedUp

Tag value increased.

Changed Down

ChangedDown

Tag value decreased.

Not Equal

NotEqual

Tag different from limit.



In this section:

Page Tree
root@parent
spacesV10