Versions Compared

Key

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

Anchor
#Top
#Top

Contents

Tables

Table of Contents
minLevel1
maxLevel4minLevel1
include
outlinefalse
indent
excludeContentsTables
typelist
class
printabletrueclass

Alarm Summary

The following table provides detail on each element of an

Alarm Summary

object:

Item

Description

Active Alarms

Displays the currently triggered alarms.

Shelved Alarms

Displays the shelved alarms.

Historical Alarms

Documents every alarm status change.

Label Filter

Allows users to decide which alarms they want to view based on labels.

Check All

Selects all alarm messages in a specific tab.

Active

Checking and unchecking this box will display or hide the active alarms.

Cleared

Checking and unchecking this box will display or hide the cleared alarms.

Active, Ack.

Checking and unchecking this box will display or hide the acknowledged-active alarms.

Cleared, Ack.

Checking and unchecking this box will display or hide the acknowledged-cleared alarms.

Acknowledge

Sets an active or cleared alarm to “Active, Ack” or “Clear, Ack”.

Shelve

Suppresses an alarm.

Unshelve

Removes the suppression of an alarm.

Time Dropdown

Displays the alarm statuses for the time chosen (i.e., 10 min would display the last 10 minutes of the alarm statuses).

Delete

Removes an alarm status from the Alarm Summary.

Properties

The following sections include tables with detailed information on the Properties' windows for an Alarm Summary object: Basic Properties, Appearance, Transform, and Actions.

Basic Properties

This table shows the elements of the

Basic Properties

pane to change displayed content and formatting.

Item

Description

Image Removed
Image Added

Expand all

Expands each section within the Alarm Summary pane.

Image Removed
Image Added

Collapse all

Collapses each section within the Alarm Summary pane.

Name

Allows the user to decide which name they want for the Alarm Summary.

Initial Tab

Controls the starting tab on the initialization of the project. The default is the “Active Alarms” tab.

 

 

 

 

 

 

Active Tab

Image Modified

 

 

 

 

 

 

Shelved Tab

Image Modified

 

 

 

 

 

 

Historical Tab

Image Modified

Visibility

Controls whether the tab is visible or not. A tag may be bound to this property to control the status in runtime.

Image Added

Delete

TBD

Content

Controls which type of data is shown in the column.

Name

Assigns a name to the header of the column.

Width

Assigns the default horizontal distance for the column. This can be changed while in runtime.

Format

Selects the string style of the data type.

Precision

Selects the number of decimal places to follow a value.

Add Column

Allows the user additional columns for their Alarm Summary.

This table shows the elements of the Appearance pane to enable the use of colors and selections to alter visible characteristics.

Item

Description

Visibility

Controls whether the Alarm Summary is displayed or hidden. A tag may be bound to this property to control the status in runtime.

Opacity

Controls the transparency of the Alarm Summary. A tag may be bound to this property to control the status in runtime.

Blinking

Controls whether the Alarm Summary blinks. A tag may be bound to this property to control the status in runtime.

Blink Interval (ms):

Controls how often the Alarm Summary blinks. A tag may be bound to this property to control the status in runtime.

Background Color

Controls the color of the cells within the Alarm Summary. A tag may be bound to this property to control the status in runtime.

Active Color

Controls the color in which active alarms are displayed. A tag may be bound to this property to control the status in runtime.

Active Acknowledged Color

Controls the color in which active acknowledged alarms are displayed. A tag may be bound to this property to control the status in runtime.

Cleared Color

Controls the color in which cleared alarms are displayed. A tag may be bound to this property to control the status in runtime.

Cleared Acknowledged Color

Controls the color in which cleared acknowledged alarms are displayed. A tag may be bound to this property to control the status in runtime.

Font Name

Controls the font style of the displayed alarm text.

Display Header

Controls whether the header of each column is shown or not. A tag may be bound to this property to control the status in runtime.

Display Grid Lines

Controls whether the borders between cells are shown or not. A tag may be bound to this property to control the status in runtime.

Display User Controls

Controls whether control buttons are shown or not. A tag may be bound to this property to control the status in runtime.

Show Active Acknowledged

Controls the initial selection of whether Active Acknowledged alarms are displayed or hidden. A tag may be bound to this property to control the status in runtime.

Show Active Unacknowledged

Controls the initial selection of whether Active Unacknowledged alarms are displayed or hidden. A tag may be bound to this property to control the status in runtime.

Show Cleared Acknowledged

Controls the initial selection of whether Cleared Acknowledged alarms are displayed or hidden. A tag may be bound to this property to control the status in runtime.

Show Cleared Unacknowledged

Controls the initial selection of whether Cleared Unacknowledged alarms are displayed or hidden. A tag may be bound to this property to control the status in runtime.

This table shows the elements of the Transform pane to provide adjustable properties that reshape or move the object.

Item

Description

X

Controls the horizontal placement of an object. A tag may be bound to this property to control the status in runtime.

Y

Controls the vertical placement of an object. A tag may be bound to this property to control the status in runtime.

Z index

Controls the layering of objects. Objects with a lower Z-index will lay on top of objects with a higher Z-index. The lowest Z-index is 0.

Width

Controls the horizontal distance of an object. A tag may be bound to this property to control the status in runtime.

Height

Controls the vertical distance of an object. A tag may be bound to this property to control the status in runtime.

Rotation

Controls the rotational orientation of an object. A tag may be bound to this property to control the status in runtime.

Use Percentage:

TBD

Rotation Center X

TBD

Rotation Center Y

TBD

Actions

Alarm Summary Filtering

Active Alarm

Item

Description

Shelved Alarm

Item

Description

Historical Alarm

Item

Description