Alarm Information
Alarm Tables
Alarm Editor
| Item | Description |
|---|---|
 Add Alarm | Adds an alarm. |
 Delete Alarm | Deletes the selected alarm. |
 Edit Alarm | Edits the selected alarm. |
 Copy Alarm | Saves the selected alarm’s content in the clipboard. |
 Paste Alarm | Pastes the alarm’s content in an Alarm Editor’s window, Spreadsheet, or Notepad. |
 Cut Alarm | Deletes the selected alarm’s content and saves it in the clipboard. |
| Alarm Banner | Opens the Alarm Banner Properties window. |
| Persist Alarm Status | Controls whether alarm data is retained through closure of project runtime or not. |
| Labels | Opens the Label Editor window. |
| OK | Closes the Alarm Editor window. |
Alarm Banner Properties
| Item | Description |
|---|---|
| Enable Banner | Controls whether or not the Alarm Banner will be displayed when an assigned alarm is active. |
| Background Color | Controls the color of the Alarm Banner’s background. |
| Time Format | Sets the format of time that is displayed inside of the Alarm Banner. |
| Go to page | Sets a page to open when tapping on the Alarm Banner. |
| Text Color | Controls the color of the Alarm Banner’s text. |
| Display Order | Controls whether the Newest or Oldest active alarms are displayed first. |
| Font Name | Changes the style of text. |
| Font Size | Changes the size of the text. |
| Position | Changes the location of the alarm banner, from Bottom, Top, or Offset. |
| Y Position (px) | Changes the Offset amount in pixels. |
| Smooth Scrolling | Controls whether the names and times of active alarms are displayed concurrently and scrolled rather than cycling. |
| Scroll Direction | Controls the direction at which the names and times of active alarms scroll. |
| Scroll Speed | Controls the speed at which the names and times of active alarms scroll. |
Edit Alarm
| Item | Description |
|---|---|
| Alarm Settings | Opens the Alarm 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 |
|---|---|
 Expand All | Shows all dropdown content within the Alarm Settings tab. |
 Collapse All | Hides all dropdown content within the Alarm Settings tab. |
| Alarm Name | Assigns a 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). |
| Display in Banner | Controls whether or not the current alarm will be displayed in the Alarm Banner when active. |
| ON Action | Assigns a command or script that occurs when the alarm is triggered. |
| OFF Action | Assigns a command or script that occurs when the alarm is cleared. |
| Acknowledge Action | Assigns a command or script that occurs when the alarm is acknowledged. |
| Recipient Group (To) | Assigns an email, a user, or a group of users to send an email to. 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. 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 Messsage 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 |
|---|---|
| Edit Labels | Opens the Edit Labels window so that labels may be added/changed/removed. |
| Expand All | Shows all dropdown content within the Labels tab. |
| Collapse All | Hides all dropdown content within the Labels tab. |
Edit Labels
| Item | Description |
|---|---|
 Add Label | Drops down with a menu to add a new label or scope. |
| Expand All | Shows all dropdown content within the Edit Labels tab. |
| 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. |
| Display in Banner | Controls whether the alarms assigned to the current label will be displayed in the Alarm Banner when active. |
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. |
 Move Up | Swaps the description indices of current and above descriptions. |
 Move Down | Swaps the description indices of current and below descriptions. |
| Delete | Deletes the selected description. |