Versions Compared

Version Old Version 23 New Version Current
Changes made by

Richard Mendoza

Richard Mendoza

Saved on

Key

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

Anchor
Top
Top

Contents

Tables

tocminLevel1maxLevel4includeoutlinefalseindentexcludeContentstypelistclassprintabletrue

Configuration

Alarm Editor

The table to the right provides detail on each icon in the Alarm Editor window:

Alarm Editor

Item

Description

Image Removed
Image Added

Add Alarm

Adds an alarm.

Image Removed
Image Added

Delete Alarm

Deletes the selected alarm.

Image Removed
Image Added

Edit Alarm

Edits the selected alarm.

Image Removed
Image Added

Copy Alarm

Saves the selected alarm’s content in the clipboard.

Image Removed
Image Added

Paste Alarm

Pastes the alarm’s content in an Alarm Editor’s window,

Microsoft Excel

Spreadsheet, or Notepad.

Image Removed
Image Added

Cut Alarm

Deletes the selected alarm’s content and saves it in the clipboard.

Persist Alarm Status

Controls whether alarm data is retained through closure of project runtime or not.

Labels

Opens up the Label Editor window.

OK

Accepts the pending changes within the Alarms

Closes the Alarm Editor window.

Edit Alarm

Item

Description

Alarm Settings

Opens the Alarm

The table to the right provides detail on the configuration options within the Edit Alarm window:

Settings tab.

Labels

Opens the Labels tab.

Descriptions

Opens the Descriptions tab.

OK

Closes the Edit Alarm window.

Cancel

Closes the Edit Alarm window and discards any entered information.


Alarm Settings

Item

Description

Image Added

Expand All

Shows all dropdown content within the Alarm Settings tab.

Image Added

Collapse All

Hides all dropdown content within the Alarm Settings tab.

Alarm Name

Assigns a

title

name to the user’s alarm.

Trigger

Assigns a tag or expression to be responsible for initiating the alarm.

Comparison

Declares the parameter/threshold in which the alarm triggers.

Value 1

Primary parameter for single-sided comparisons (i.e., X > Value 1).

Value 2

Secondary parameter for two-sided comparisons (i.e., Value 1 > X > Value 2).

ON Action

Assigns

an action

a command or script that occurs when the alarm is triggered.

OFF Action

Assigns

an action

a command or script that occurs when the alarm

settles

is cleared.

Acknowledge Action

Assigns

an action

a command or script that occurs when the alarm is acknowledged

.

Non-Runtime Functionalities

Alarm Labels

The following table provides detail on the additional icons in the Labels tab of the Edit Alarm window:

Item

Description

Image Removed

.

Recipient Group (To)

Assigns an email, a user, or a group of users to send an email to.

Info

SMTP properties must be configured with a valid email address, and users must have an email assigned in Identity and Access Management to have an email sent. An error will appear at the bottom of the screen if an email is attempted to be sent to an invalid or no email.

Recipient Group (Cc)

Assigns an email, a user, or a group of users to carbon copy on a sent email.

Info

SMTP properties must be configured with a valid email address, and users must have an email assigned in Identity and Access Management to have an email sent. An error will appear at the bottom of the screen if an email is attempted to be sent to an invalid or no email.

Send When ON

Controls whether or not an alarm email will be sent when the alarm is triggered.

ON Message Description

Assigns a created description to be added to the on alarm email.

Send When OFF

Controls whether or not an alarm email will be sent when the alarm is cleared.

OFF Message Description

Assigns a created description to be added to the off alarm email.

Send When Acknowledged

Controls whether or not an alarm email will be sent when the alarm is acknowledged.

Ack. Message Description

Assigns a created description to be added to the acknowledged alarm email.

Comparisons

Item

Description

<

Triggers the alarm if the Trigger value is less than the set Value.

<=

Triggers the alarm if the Trigger value is less than or equal to the set Value.

>

Triggers the alarm if the Trigger value is greater than the set Value.

>=

Triggers the alarm if the Trigger value is greater than or equal to the set Value.

==

Triggers the alarm if the Trigger value is equal to the set Value.

!=

Triggers the alarm if the Trigger value is not equal to the set Value.

Between

Triggers the alarm if the Trigger value falls in the range of Value 1 to Value 2.

Not Between

Triggers the alarm if the Trigger value falls outside the range of Value 1 to Value 2.

Bad Quality

Triggers the alarm if the bound Tag does not have active communication.

Is True

Triggers the alarm if the bound Tag’s value is not 0.

Labels

Item

Description

Image Added

Edit Labels

Opens the Edit Labels window so that labels may be added/changed/removed.

Image Removed
Image Added

Expand All

Shows all dropdown content within the Labels tab.

Image Added

Collapse All

Hides all

Expands each section within the Edit Alarm window.

Image Removed

Collapse all

Collapses each section within the Edit Alarm window

dropdown content within the Labels tab.

Edit Labels

Item

Description

Image Added

Add Label

Drops down with a menu to add a new label or scope.

Image Added

Expand All

Shows all dropdown content within the Edit Labels tab.

Image Added

Collapse All

Hides all dropdown content within the Edit Labels tab.

Create New Label/Edit Label

Item

Description

Name

Assigns a name to the user’s label.

ON Action

Assigns a command or script that occurs when any alarm under the label is triggered.

OFF Action

Assigns a command or script that occurs when any alarm under the label is cleared.

Ack. Action

Assigns a command or script that occurs when any alarm under the label is acknowledged.

Color

Assigns a color to the user’s label with presets or custom HSB, RGB, or hex color code. This is applied to the Label filter window and notifications if enabled.

Scope

Assigns a scope to the user’s label.

Notify

Controls whether screen notifications will be sent when any alarms under the label are triggered.

Descriptions

Item

Description

New Description

Creates a new description at the next available index.

Description

Assigns a name to the user’s description.

Tag Expression

Assigns a string to be used as the displayed description.

No. #

Displays the description index number starting at 0.

Image Added

Move Up

Swaps the description indices of current and above descriptions.

Image Added

Move Down

Swaps the description indices of current and below descriptions.

Image Added

Delete

Deletes the selected description.

Back to Top of Alarm Information