Perspective - Alarm Status Table

Description

The Perspective Alarm Status Table displays the current state of the alarm system. It can be configured to show active, unacknowledged, cleared, and acknowledged alarm states. The Alarm Status Table allows you to view currently active alarm events in the system, providing an easy way to inspect the alarm details, shelve alarms, and acknowledge them.

Acknowledgement is handled by selecting (checking) alarms and pressing the "Acknowledge" button. If any of the selected alarms require acknowledge notes, then a popup window will be presented in which the operator must add notes to the acknowledgement.

The Alarm Status Table provides a host of filtering properties that allow you to filter on various parts of alarms and view the details. All the alarm states are visible by clicking the Filter button on the table. There is also a search bar where you can enter text to further refine your filter criteria so you have less alarm events to scroll through.

Shelving is supported by pressing the "Shelve" button when an alarm is selected and choosing a time duration. This temporarily removes the alarm from the entire alarm system (not just the local client) while you are working to resolve the issue. When the duration time is up, if the alarm is still active, it will pop back into the alarm system. The duration times shown to the user are customizable by editing the values inside the "shelvingTimes" property in the Property Editor. The alarms that have been shelved can be un-shelved by pressing the Unshelve Selected Alarms button at the bottom of the table or the modal in the row of the unshelved alarm.

You can change the columns that are displayed and the column width in Preview Mode and in a Perspective Session. Right-click on the table header to show/hide columns. Click and drag the margins of the columns to resize their width. You can also sort table columns in ascending or descending order by simply clicking the up or down arrows next to each column header. Sorting on alarm State and Priority in the Alarm Status Table sorts in descending order. All the other columns the sort order is alphanumerical.

For information on how to configure the Vision Alarm Status Table refer to Alarming in Perspective.

Properties

Most Properties have binding options. For more information on Bindings, see Types of Bindings in Perspective.
This section only documents the Props Category of properties. The other Categories are described on the Perspective Component Properties page.

Name

Description

Property Type

enableHeader

Enable table header. Default is true.

value: boolean

enableDetails

Enable active events table details action. Default is true.

value: boolean

enableAcknowledge

Enable acknowledge action. Default is true.

value: boolean

enableShelve

Enable shelve action. Default is true.

value: boolean

enableUnshelve

Enable unshelve action. Default is true.

value: boolean

toolbar

The following feature is new in Ignition version 8.0.8
Click here to check out the other new features

Settings for the toolbar.

Click to see toolbar properties

Name	Description	Property Type
enabled	Enables the visibility of the table toolbar. Default is true.	value: boolean
enableActiveTab	Enables the visibility of the Active Events tab.	value: boolean
enableShelvedTab	Enables the visibility of the Shelved Events tab.	value: boolean
enableFilter	Enables the visibility of the text filter toggle. Default is true.	value: boolean
enableFilterResults	Enables the visibility of the filters results count message. Default is true.	value: boolean
enablePreFilters	Enables the visibility of the pre-filter toggle. Default is true.	value: boolean
enableConfiguration	Enables the visibility of the configuration toggle. Default is true.	value: boolean

object

shelvingTimes

Available alarming shelving times in seconds. Shelving times are customizable by editing values for this property in the Property Editor.

array

responsive

The following feature is new in Ignition version 8.0.8
Click here to check out the other new features

Responsive layout configuration. Rows are converted to cards. While in responsive layout, disables or removes certain table features that are no longer applicable.

Name	Description	Property Type
enabled	Enables responsive layout. Default is false.	value: boolean
breakpoint	Width in pixels that triggers change in responsive layout.	value: numeric

object

filters

This is where you configure filtering properties for displaying alarm data in the Alarm Status Table.

Click to see the filter properties

Name

Description

Property Type

active

Settings for active alarms.

Name

Description

Property Type

text

The active alarm events filter text.

value: string

states

Pre-filters for filter active alarm events:

Click to see states properties

Name	Description	Property Type
activeUnacked	Active and unacknowledged. Default is true.	value: boolean
activeAcked	Active and acknowledged. Default is true.	value: boolean
clearUnacked	Cleared and unacknowledged. Default is true.	value: boolean
clearAcked	Active and acknowledged. Default is false.	value: boolean

object

priorities

The following feature is new in Ignition version 8.0.8
Click here to check out the other new features

Alarm state priority pre-filters.

Click to see priority pre-filters

Name	Description	Property Type
diagnostic	Whether to display alarms with diagnostic priority. Default is false.	value: boolean
low	Whether to display alarms with low priority. Default is true.	value: boolean
medium	Whether to display alarms with medium priority. Default is true.	value: boolean
high	Whether to display alarms with high priority. Default is true.	value: boolean
critical	Whether to display alarms with critical priority. Default is true.	value: boolean

object

conditions

Gateway side alarm query conditions.

Click to see condition properties

Name	Description	Property Type
source	Filter alarms by alarm source path. Specify multiple paths by separating them with commas. Supports the wildcard *.	value: string
displayPath	Filters alarms by display path, falling back to the source path if a custom display path isn't set. Specify multiple paths by separating them with commas. Supports the wildcard *.	value: string
provider	Filter alarms by alarm provider.	value: string

object

results

Active alarm filtering results configuration and data.

Click to see results properties

Name	Description	Property Type
enabled	Enable filter results to be written back to props. Warning: Doing so may cause performance decline. Default is false.	value: boolean
data	An array of objects representing the current filtered data if enabled and active.	array

object

shelved

Temporarily silence an alarm for a fixed period of time while the alarm event issue is worked on.

Click to see shelved properties

Name

Description

Property Type

text

The filter text for shelved alarms.

value: string

results

Shelved alarm filtering results configuration and data.

Click to see results properties

Name	Description	Property Type
enabled	Enable filter results to be written back to props. Warning: Doing so may cause performance decline. Default is false.	value: boolean
data	An array of objects representing the current filtered data if enabled and active.	array

object

rowStyles

Styles to apply to rows given their alarm state and designated priority.

Click here to expand...

Name

Description

Property Type

activeUnacked

Style settings for rows with activeUnacked alarms.

Click here to expand...

Name

Description

Property Type

base

Base style settings for activeUnacked alarms. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class.

object

priorities

Style settings for the alarm row based on priority.

Click here to expand...

Name	Description	Property Type
diagnostic	Style for activeUnacked alarms with diagnostic priority. Full menu of style options is available. You can also specify a style class.	object
low	Style for activeUnacked alarms with low priority. Full menu of style options is available. You can also specify a style class.	object
medium	Style for activeUnacked alarms with medium priority. Full menu of style options is available. You can also specify a style class.	object
high	Style for activeUnacked alarms with high priority. Full menu of style options is available. You can also specify a style class.	object
critical	Style for activeUnacked alarms with critical priority. Full menu of style options is available. You can also specify a style class.	object

object

activeAcked

Style settings for rows with activeAcked alarms.

Click here to expand...

Name

Description

Property Type

base

Base style settings for activeAcked alarms. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class.

object

priorities

Style settings for the alarm row based on priority.

Click here to expand...

Name	Description	Property Type
diagnostic	Style for activeAcked alarms with diagnostic priority. Full menu of style options is available. You can also specify a style class.	object
low	Style for activeAcked alarms with low priority. Full menu of style options is available. You can also specify a style class.	object
medium	Style for activeAcked alarms with medium priority. Full menu of style options is available. You can also specify a style class.	object
high	Style for activeAcked alarms with high priority. Full menu of style options is available. You can also specify a style class.	object
critical	Style for activeAcked alarms with critical priority. Full menu of style options is available. You can also specify a style class.	object

object

clearUnacked

Style settings for rows with clearUnacked alarms.

Click here to expand...

Name

Description

Property Type

base

Base style settings for clearUnacked alarms. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class.

object

priorities

Style settings for the alarm row based on priority.

Click here to expand...

Name	Description	Property Type
diagnostic	Style for clearUnacked alarms with diagnostic priority. Full menu of style options is available. You can also specify a style class.	object
low	Style for clearUnacked alarms with low priority. Full menu of style options is available. You can also specify a style class.	object
medium	Style for clearUnacked alarms with medium priority. Full menu of style options is available. You can also specify a style class.	object
high	Style for clearUnacked alarms with high priority. Full menu of style options is available. You can also specify a style class.	object
critical	Style for clearUnacked alarms with critical priority. Full menu of style options is available. You can also specify a style class.	object

object

clearAcked

Style settings for rows with clearAcked alarms.

Click here to expand...

Name

Description

Property Type

base

Base style settings for clearAcked alarms. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class.

object

priorities

Style settings for the alarm row based on priority.

Click here to expand...

Name	Description	Property Type
diagnostic	Style for clearAcked alarms with diagnostic priority. Full menu of style options is available. You can also specify a style class.	object
low	Style for clearAcked alarms with low priority. Full menu of style options is available. You can also specify a style class.	object
medium	Style for clearAcked alarms with medium priority. Full menu of style options is available. You can also specify a style class.	object
high	Style for clearUnacked alarms with high priority. Full menu of style options is available. You can also specify a style class.	object
critical	Style for clearAcked alarms with critical priority. Full menu of style options is available. You can also specify a style class.	object

object

dateFormat

A date format string to be applied against dates.

value: dropdown string

object

columns

Used only for determining what columns to show on load.

Name

Description

Property Type

active

Active alarm even columns to display on load

Click to see column properties

Name

Description

Property Type

activeTime

Settings for the activeTime column.

Expand to see eventTime properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static.	value: numeric
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string dropdown

object

displayPath

Settings for the displayPath column.

Expand to see displayPath properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static.	value: numeric
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string dropdown

object

priority

Settings for the priority column.

Expand to see priority properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static.	value: numeric
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string dropdown

object

state

Settings for the state column.

Expand to see state properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static.	value: numeric
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string dropdown

object

source

Settings for the source column.

Expand to see source properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static.	value: numeric
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string dropdown

object

label

Settings for the label column.

Expand to see label properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static.	value: numeric
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string dropdown

object

name

Settings for the name column.

Expand to see name properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static.	value: numeric
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string dropdown

object

eventId

Settings for the eventId column.

Expand to see eventId properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static.	value: numeric
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string dropdown

object

eventValue

Settings for the eventValue column.

Expand to see eventValue properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static.	value: numeric
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string dropdown

object

notes

Settings for the notes column.

Expand to see notes properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static.	value: numeric
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string dropdown

object

isActive

Settings for the isActive column.

Expand to see isActive properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static.	value: numeric
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string dropdown

object

isAcked

Settings for the isAcked column.

Expand to see isAcked properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static.	value: numeric
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string dropdown

object

isClear

Settings for the isClear column.

Expand to see isClear properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static.	value: numeric
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string dropdown

object

ackTime

Settings for the ackTime column.

Expand to see ackTime properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static.	value: numeric
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string dropdown

object

ackUser

Settings for the ackUser column.

Expand to see ackUser properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static.	value: numeric
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string dropdown

object

ackNotes

Settings for the ackNotes column.

Expand to see ackNotes properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static.	value: numeric
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string dropdown

object

ackPipeline

Settings for the ackPipeline column.

Expand to see ackPipeline properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static.	value: numeric
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string dropdown

object

activePipeline

Settings for the activePipeline column.

Expand to see activePipeline properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static.	value: numeric
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string dropdown

object

clearTime

Settings for the clearTime column.

Expand to see clearTime properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static.	value: numeric
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string dropdown

object

clearPipeline

Settings for the clearPipeline column.

Expand to see clearPipeline properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static.	value: numeric
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string dropdown

object

deadband

Settings for the deadband column.

Expand to see deadband properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static.	value: numeric
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string dropdown

object

shelved

Shelved alarm columns to display on load.

Name

Description

Property Type

expires

Settings for the expires column.

Expand to see expires properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static.	value: numeric
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string dropdown

shelvedBy

Settings for the shelvedBy column.

Expand to see shelvedBy properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static.	value: numeric
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string dropdown

sourcePath

Settings for the sourcePath expires column.

Expand to see shelvedBy properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The column's width, which when not strict represents a proportion of the available space, i.e., flex grow. If strictWidth is enabled, the column will be fixed and static.	value: numeric
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string dropdown

object

pager

Settings for the pager.

Expand to see shelvedBy properties

Name	Description	Property Type
enabled	Enables the pager to be displayed. Default is true.	value: boolean
hide	Visually hides the pager from view. Useful when pager is manipulated in a controlled fashion via the activePage property. Default is false.	value: boolean
options	Rows to show per pager option.	array
initialOption	The initial option to use when the table first loads. It must exist as an available option.	value: numeric
activePage	Represents the current active page and corresponds to the value of the page jump input field.	value: numeric

object

activeSortOrder

The following feature is new in Ignition version 8.0.11
Click here to check out the other new features

The default weighted order in which columns and their contents are sorted relative to other columns and their contents. Used when the component loads. Active event columns need to have sort configured in order for this to work.

array

shelvedSortOrder

The following feature is new in Ignition version 8.0.11
Click here to check out the other new features

The default weighted order in which columns and their contents are sorted relative to other columns and their contents. Used when the component loads. Shelved event columns need to have sort configured in order for this to work.

array

style

Sets a style that applies to the component. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class.

object

Perspective Component Events

The Perspective Event Types Reference page describes all the possible component event types for Perspective components. Not all component events support each Perspective component. The Component Events and Actions page shows how to configure events and actions on a Perspective component. Component scripting is handled separately and can be accessed from the Component menubar or by right clicking on the component.

Examples

Example 1

In a Perspective Session, click on the Filter button to filter on alarm states and/or use the Search Bar to target more specific alarm events. Select from the Configuration Settings to change the column headers to display the alarm event data you're interested in.

This example uses the Search Bar to find any text with 'High Wind Speed' in the Active,Unacknowledge alarm state.

Example 2 Alarm Status Table Row Styles

In the Designer, you can change row styles to be different colors for the different priorities for each alarm state. In this example, the rowStyle for the Critical priority for the activeAcked alarm state was changed to green.

OTHER USER MANUAL VERSIONS

GETTING STARTED

MODULES AND PLATFORM

APPENDIX

TUTORIALS & HELPFUL TRICKS

PARTNER LINKS

RESOURCES

Employees