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 Insert > Alarm Summary or click the icon 
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.
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.
Property Editor
| Anchor | ||||
|---|---|---|---|---|
|
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 to the right:
Properties
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
Item
Description
Expands each section within the Property Editor pane.
Collapses each section within the Property Editor pane.
Name
Allows the user to decide which name they want for the Alarm Summary.
Appearance
Visible
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
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
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
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
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
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
Visible
Controls whether the “Active Alarms” 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.
Shelved Tab
Visible
Controls whether the Shelved Alarms 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.
Historical Tab
Visible
Controls whether the “Historical Alarms” tab is visible or not. A tag may be bound to this property to control the status in runtime.
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 pictured to the right:
Back to Top of Alarm Summary
Appearance
The Appearance pane enables the use of colors and selections to alter visible characteristics.
Transform
The Transform tab provides adjustable properties that reshape or move the object.
Actions
There are currently no applicable actions for the Alarm Summary object. This is intended, and there are no plans to add this capability.
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.
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.
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.
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.
