Versions Compared

Key

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

Anchor
Top
Top
Feature Description

The Alarm Summary object

allows users to monitor the desired alarms in a single object. The object displays detailed information about the alarm and displays up to 500 alarm messages. AnchorTable-Of-ContentsTable-Of-ContentsSettings

lets users track and manage alarms in one tool. It can display times, names, values, and current statuses. Alarms are filterable by using Group and Level labels. Shelving alarms can also help declutter the Alarm Summary object’s Active Alarm tab. Each Alarm Summary object has Basic Properties, Appearance, and Transform options. This allows users to customize the content, look, and characteristics. For in-depth descriptions of elements and design options, visit Alarm Summary Information.

Settings

Designer Functionalities

The Canvas Simulator can operate a project with an Alarm Summary object that displays up to 150 alarms reliably. Likewise, a physical Xpanel can reliably do the same with up to 1,000 alarms. The operating speeds of both the Simulator and a physical Xpanel will depreciate with the creation of more alarms. Click Insert > Alarm Summary,or the Insert Alarm Summary icon in the toolbar, and click and drag on the page to bring up the Alarm Summary object as shown

below

to the right:

Image Removed
Image Added

Provides ways to customize the user’s Alarm Summary.

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

Back to Contents

Basic Properties

The Basic Properties

window allows changing the displayed content and formatting within the object. The object’s name will show up in place of Basic Properties, as

displayed below
Back to Contents

Appearance

Image Removed

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

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.

Back to Contents

Transform

Image Removed

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

Back to Contents

Actions

There are currently no applicable actions for the Alarm Summary object.

Image RemovedBack to Contents

pictured to the right:

Image Removed

Item

Description

Image Removed

Expands each section within the Alarm Summary pane.

Image Removed

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 Removed

 

 

 

 

 

 

Shelved Tab

Image Removed

 

 

 

 

 

 

Historical Tab

Image Removed

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.

Image Added

The Appearance pane enables the use of colors and selections to alter visible characteristics.

Image Added

Transform

The Transform tab provides adjustable properties that reshape or move the object.

Image Added

Actions

There are currently no applicable actions for the Alarm Summary object. This is intended, and there are no plans to add this capability.

Image Added

Runtime Functionalities

Filtering

When running the program, the user can select the Label Filter option in the Alarm Summary to display the alarms with a specific label. One or multiple labels may be applied at once. All active, cleared, and acknowledged alarms with the selected labels will be displayed in the Active Alarm tab of the Alarm Summary. If an active alarm has more than one label, it will be displayed when any of its labels are selected. The same can be done in the historical tab with active, cleared, acknowledged, and shelved alarms.

Image Added

Acknowledging

The user can acknowledge alarms to confirm they have been seen and trigger Acknowledge actions. If a cleared alarm is acknowledged, it will move from Active Alarm to Historical Alarm. Otherwise, any alarm will stay on the page until deleted. Users can check or uncheck the boxes for Active, Cleared, Active, Ack., and Cleared, Ack to show or hide certain statuses.

Image Added

Shelving

The user can shelve alarms to temporarily hide them from the Active Alarm tab. Shelve acts like a snooze button for a specified time interval that the user sets. After the interval, the alarm will unshelve and reappear in the Active Alarm tab. The user can bypass the set timer by clicking the Unshelve button in the Shelved Alarm tab.

Image Added
Image Added

Historical

The Historical Alarm tab creates a new record whenever an alarm status changes. The user can check a past alarm along with the status it was changed to, the time it was changed, and the value it had when it was changed. The logged alarms are filterable and deletable for better organization.

Image Added