Versions Compared

Key

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

The alarm summary object allows the user to monitor the desired alarms in a single object. The object displays detailed information about the alarm and displays up to 500 alarm messages.

Settings

Click this icon or click Insert > Alarm Summary and click on the page to bring up the configuration window as shown below:

 

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 the user 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, respectively, the active alarms.

Cleared

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

Active, Ack.

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

Cleared, Ack.

Checking and unchecking this box will display or hide, respectively, 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. This button is located in the Shelved Alarms tab.

Time Dropdown

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

Delete

Removes an alarm status from the Alarm Summary.

Properties

Provides ways to customize the user’s Alarm Summary.

To ensure the property windows are enabled, click View > Properties > Basic Properties, Appearance, Transform, Actions and check the checkboxes.

Image Removed

Basic Properties

The Basic Properties pane will show up as the object’s name as shown below:

Image Added

Item

Description

(blue star)
Image Added

Expands each section within the

Property Editor

Alarm Summary pane.

(blue star)
Image Added

Collapses each section within the

Property Editor

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. Default is the “Active Alarms” tab.

 

 

 

 

 

 

Active Tab

Image Added

 

 

 

 

 

 

Shelved Tab

Image Added

 

 

 

 

 

 

Historical Tab

Image Added

Visibility

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

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.

Appearance

Image Added

Item

Image Removed

Description

Visible

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

.

 

 

Location

Image Removed

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.

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.

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.

 

 

 

 

Actions

Image Removed

Touch

Controls whether the object responds to touch or not. A tag may be bound to this property to control the status in runtime.

On Press - Delay (ms)

Assigns how long, in ms, after touching an object that action occurs.

On Press - Action

Assigns a specific function to occur when an object is touched.

On Release - Delay (ms)

Assigns how long, in ms, after releasing touch on an object that action occurs.

On Release - Action

Assigns a specific function to occur when an object is released from being touched.

On Double Click - Interval (ms)

Assigns how long, in ms, the interval between two clicks constitutes a double click.

On Double Click - Action

Assigns a specific function to occur when an object is double-clicked.

Permissions

Assigns accessibility parameters for touching the object.

 

Display Configuration

Image Removed

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

Outlines

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.

 

Filters

Image Removed

Show Active Acknowledged

Feature TBD. A tag may be bound to this property to control the status in runtime.

Show Active Unacknowledged

Feature TBD. A tag may be bound to this property to control the status in runtime.

Show Cleared Acknowledged

Feature TBD. A tag may be bound to this property to control the status in runtime.

Show Cleared Unacknowledged

Feature TBD. A tag may be bound to this property to control the status in runtime.

Initial Tab

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

 

 

 

 

 

 

Active Tab

Image Removed

Visible

Controls whether the “Active Alarms” tab is visible or not

Transform

Image Added

Item

Description

X

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

Content

Y

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

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

Format

Z index

Selects

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

 

 

 

 

 

 

Shelved Tab

Image Removed

Visible

Controls whether the Shelved Alarms tab is visible or not

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.

Content

Height

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

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

Format

Rotation

Selects

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

 

 

 

 

 

 

Historical Tab

Image Removed

Visible

Controls whether the “Historical Alarms” tab is visible or not

Add Column

Allows the user additional columns for their Alarm Summary.

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

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.

Use Percentage:

TBD

Rotation Center X

TBD

Rotation Center Y

TBD

Actions

There are currently no applicable actions for Alarm Summary.

Image Added