Skip to end of banner Go to start of banner

Alarm Summary

Skip to end of metadata

Created by Richard Mendoza , last modified on Aug 03, 2023

Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

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.

Settings
- Properties

Settings

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:

Back to Contents

Properties

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 object’s name will show up in place of Basic Properties, as displayed below:

Item	Description
	Expands each section within the Alarm Summary pane.
	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
Shelved Tab
Historical Tab
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.

Back to Contents

Appearance

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

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.

Back to Contents

No labels