Versions Compared

Key

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



Panel
titleGeneral


Component Palette Icon:







Panel
borderStylesolid
titleDescription

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 , the order of the columns, and /or 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.

Info

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



Panel
titleProperties
Perspective_property




NameDescriptionProperty Type
enableHeaderEnable table header. Default is true.value: boolean
enableDetailsEnable active events table details action. Default is true.value: boolean
enableAcknowledgeEnable acknowledge action. Default is true.value: boolean
enableShelveEnable shelve action. Default is true.value: boolean
enableUnshelveEnable unshelve action. Default is true.value: boolean

toolbar

New_in
Version8.0.8



Settings for the toolbar.

Expand
titleClick to see toolbar properties
NameDescriptionProperty Type
enabledEnables the visibility of the table toolbar. Default is true.value: boolean
enableActiveTabEnables the visibility of the Active Events tab.value: boolean
enableShelvedTabEnables the visibility of the Shelved Events tab.value: boolean
enableFilterEnables the visibility of the text filter toggle. Default is true.value: boolean
enableFilterResultsEnables the visibility of the filters results count message. Default is true.value: boolean
enablePreFiltersEnables the visibility of the pre-filter toggle. Default is true.value: boolean
enableConfigurationEnables the visibility of the configuration toggle. Default is true.value: boolean
object
shelvingTimesAvailable alarming shelving times in seconds. Shelving times are customizable by editing values for this property in the Property Editor.array

responsive

New_in
Version8.0.8


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

enabledEnables responsive layout. Default is false.value: boolean
breakpointWidth 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.

Expand
titleClick to see the filter properties
NameDescriptionProperty Type
active

Settings for active alarms.

NameDescriptionProperty Type
textThe active alarm events filter text.value: string
states

Pre-filters for filter active alarm events:

Expand
titleClick to see states properties
NameDescriptionProperty 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

New_in
Version8.0.8


Alarm state priority pre-filters.

Expand
titleClick to see priority pre-filters
NameDescriptionProperty 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
criticalWhether to display alarms with critical priority. Default is true.value: boolean
object
conditions

Gateway side alarm query conditions.

Expand
titleClick to see condition properties
NameDescriptionProperty Type
sourceFilter alarms by alarm source path. Specify multiple paths by separating them with commas. Supports the wildcard *.

value:
string

displayPathFilters 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

providerFilter alarms by alarm provider.value:
string
object
results

Active alarm filtering results configuration and data.

Expand
titleClick to see results properties
NameDescriptionProperty Type
enabledEnable filter results to be written back to props. Warning: Doing so may cause performance decline. Default is false.value:
boolean
dataAn array of objects representing the current filtered data if enabled and active.array
object
object
shelved

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

Expand
titleClick to see shelved properties
NameDescriptionProperty Type
textThe filter text for shelved alarms.value: string
results

Shelved alarm filtering results configuration and data.

Expand
titleClick to see results properties
NameDescriptionProperty Type
enabledEnable filter results to be written back to props. Warning: Doing so may cause performance decline. Default is false.value:
boolean
dataAn array of objects representing the current filtered data if enabled and active.array
object
object
object
rowStyles

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

Expand

Name

Description

Property Type

activeUnacked

Style settings for rows with activeUnacked alarms.

Expand

Name

Description

Property Type

baseBase 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 classobject
priorities

Style settings for the alarm row based on priority.

Expand

Name

Description

Property Type

diagnosticStyle for activeUnacked alarms with diagnostic priority. Full menu of style options is available. You can also specify a style classobject
lowStyle for activeUnacked alarms with low priority. Full menu of style options is available. You can also specify a style classobject
mediumStyle for activeUnacked alarms with medium priority. Full menu of style options is available. You can also specify a style classobject
highStyle for activeUnacked alarms with high priority. Full menu of style options is available. You can also specify a style classobject
criticalStyle for activeUnacked alarms with critical priority. Full menu of style options is available. You can also specify a style classobject
object
object
activeAcked

Style settings for rows with activeAcked alarms.

Expand

Name

Description

Property Type

baseBase 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 classobject
priorities

Style settings for the alarm row based on priority.

Expand

Name

Description

Property Type

diagnosticStyle for activeAcked alarms with diagnostic priority. Full menu of style options is available. You can also specify a style classobject
lowStyle for activeAcked alarms with low priority. Full menu of style options is available. You can also specify a style classobject
mediumStyle for activeAcked alarms with medium priority. Full menu of style options is available. You can also specify a style classobject
highStyle for activeAcked alarms with high priority. Full menu of style options is available. You can also specify a style classobject
criticalStyle for activeAcked alarms with critical priority. Full menu of style options is available. You can also specify a style classobject
object
object
clearUnacked

Style settings for rows with clearUnacked alarms.

Expand

Name

Description

Property Type

baseBase 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 classobject
priorities

Style settings for the alarm row based on priority.

Expand

Name

Description

Property Type

diagnosticStyle for clearUnacked alarms with diagnostic priority. Full menu of style options is available. You can also specify a style classobject
lowStyle for clearUnacked alarms with low priority. Full menu of style options is available. You can also specify a style classobject
mediumStyle for clearUnacked alarms with medium priority. Full menu of style options is available. You can also specify a style classobject
highStyle for clearUnacked alarms with high priority. Full menu of style options is available. You can also specify a style classobject
criticalStyle for clearUnacked alarms with critical priority. Full menu of style options is available. You can also specify a style classobject
object
object
clearAcked

Style settings for rows with clearAcked alarms.

Expand

Name

Description

Property Type

baseBase 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 classobject
priorities

Style settings for the alarm row based on priority.

Expand

Name

Description

Property Type

diagnosticStyle for clearAcked alarms with diagnostic priority. Full menu of style options is available. You can also specify a style classobject
lowStyle for clearAcked alarms with low priority. Full menu of style options is available. You can also specify a style classobject
mediumStyle for clearAcked alarms with medium priority. Full menu of style options is available. You can also specify a style classobject
highStyle for clearUnacked alarms with high priority. Full menu of style options is available. You can also specify a style classobject
criticalStyle for clearAcked alarms with critical priority. Full menu of style options is available. You can also specify a style classobject
object
object
dateFormatA date format string to be applied against dates.value: dropdown string
object
columns

Used only for determining what columns to show on load.

NameDescriptionProperty Type
active

Active alarm even columns to display on load

Expand
titleClick to see column properties
NameDescriptionProperty Type
activeTime

Settings for the activeTime column.

Expand
titleExpand to see eventTime properties
NameDescriptionProperty Type
enabledWhether the column is enabled. Default is true.value: boolean
widthThe 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
strictWidthIf enabled, the width of the column (set with the width property) becomes static. Default is false.value: boolean
sortDefault sort order of the column. Options are none, ascending, or descending.value: string dropdown
object
displayPath

Settings for the displayPath column.

Expand
titleExpand to see displayPath properties
NameDescriptionProperty Type
enabledWhether the column is enabled. Default is true.value: boolean
widthThe 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
strictWidthIf enabled, the width of the column (set with the width property) becomes static. Default is false.value: boolean
sortDefault sort order of the column. Options are none, ascending, or descending.value: string dropdown
object
priority

Settings for the priority column.

Expand
titleExpand to see priority properties
NameDescriptionProperty Type
enabledWhether the column is enabled. Default is true.value: boolean
widthThe 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
strictWidthIf enabled, the width of the column (set with the width property) becomes static. Default is false.value: boolean
sortDefault sort order of the column. Options are none, ascending, or descending.value: string dropdown
object
state

Settings for the state column.

Expand
titleExpand to see state properties
NameDescriptionProperty Type
enabledWhether the column is enabled. Default is true.value: boolean
widthThe 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
strictWidthIf enabled, the width of the column (set with the width property) becomes static. Default is false.value: boolean
sortDefault sort order of the column. Options are none, ascending, or descending.value: string dropdown
object
source

Settings for the source column.

Expand
titleExpand to see source properties
NameDescriptionProperty Type
enabledWhether the column is enabled. Default is true.value: boolean
widthThe 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
strictWidthIf enabled, the width of the column (set with the width property) becomes static. Default is false.value: boolean
sortDefault sort order of the column. Options are none, ascending, or descending.value: string dropdown
object
label

Settings for the label column.

Expand
titleExpand to see label properties
NameDescriptionProperty Type
enabledWhether the column is enabled. Default is true.value: boolean
widthThe 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
strictWidthIf enabled, the width of the column (set with the width property) becomes static. Default is false.value: boolean
sortDefault sort order of the column. Options are none, ascending, or descending.value: string dropdown
object
name

Settings for the name column.

Expand
titleExpand to see name properties
NameDescriptionProperty Type
enabledWhether the column is enabled. Default is true.value: boolean
widthThe 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
strictWidthIf enabled, the width of the column (set with the width property) becomes static. Default is false.value: boolean
sortDefault sort order of the column. Options are none, ascending, or descending.value: string dropdown
object
eventId

Settings for the eventId column.

Expand
titleExpand to see eventId properties
NameDescriptionProperty Type
enabledWhether the column is enabled. Default is true.value: boolean
widthThe 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
strictWidthIf enabled, the width of the column (set with the width property) becomes static. Default is false.value: boolean
sortDefault sort order of the column. Options are none, ascending, or descending.value: string dropdown
object
eventValue

Settings for the eventValue column.

Expand
titleExpand to see eventValue properties
NameDescriptionProperty Type
enabledWhether the column is enabled. Default is true.value: boolean
widthThe 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
strictWidthIf enabled, the width of the column (set with the width property) becomes static. Default is false.value: boolean
sortDefault sort order of the column. Options are none, ascending, or descending.value: string dropdown
object
notes

Settings for the notes column.

Expand
titleExpand to see notes properties
NameDescriptionProperty Type
enabledWhether the column is enabled. Default is true.value: boolean
widthThe 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
strictWidthIf enabled, the width of the column (set with the width property) becomes static. Default is false.value: boolean
sortDefault sort order of the column. Options are none, ascending, or descending.value: string dropdown
object
isActive

Settings for the isActive column.

Expand
titleExpand to see isActive properties
NameDescriptionProperty Type
enabledWhether the column is enabled. Default is true.value: boolean
widthThe 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
strictWidthIf enabled, the width of the column (set with the width property) becomes static. Default is false.value: boolean
sortDefault sort order of the column. Options are none, ascending, or descending.value: string dropdown
object
isAcked

Settings for the isAcked column.

Expand
titleExpand to see isAcked properties
NameDescriptionProperty Type
enabledWhether the column is enabled. Default is true.value: boolean
widthThe 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
strictWidthIf enabled, the width of the column (set with the width property) becomes static. Default is false.value: boolean
sortDefault sort order of the column. Options are none, ascending, or descending.value: string dropdown
object
isClear

Settings for the isClear column.

Expand
titleExpand to see isClear properties
NameDescriptionProperty Type
enabledWhether the column is enabled. Default is true.value: boolean
widthThe 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
strictWidthIf enabled, the width of the column (set with the width property) becomes static. Default is false.value: boolean
sortDefault sort order of the column. Options are none, ascending, or descending.value: string dropdown
object
ackTime

Settings for the ackTime column.

Expand
titleExpand to see ackTime properties
NameDescriptionProperty Type
enabledWhether the column is enabled. Default is true.value: boolean
widthThe 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
strictWidthIf enabled, the width of the column (set with the width property) becomes static. Default is false.value: boolean
sortDefault sort order of the column. Options are none, ascending, or descending.value: string dropdown
object
ackUser

Settings for the ackUser column.

Expand
titleExpand to see ackUser properties
NameDescriptionProperty Type
enabledWhether the column is enabled. Default is true.value: boolean
widthThe 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
strictWidthIf enabled, the width of the column (set with the width property) becomes static. Default is false.value: boolean
sortDefault sort order of the column. Options are none, ascending, or descending.value: string dropdown
object
ackNotes

Settings for the ackNotes column.

Expand
titleExpand to see ackNotes properties
NameDescriptionProperty Type
enabledWhether the column is enabled. Default is true.value: boolean
widthThe 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
strictWidthIf enabled, the width of the column (set with the width property) becomes static. Default is false.value: boolean
sortDefault sort order of the column. Options are none, ascending, or descending.value: string dropdown
object
ackPipeline

Settings for the ackPipeline column.

Expand
titleExpand to see ackPipeline properties
NameDescriptionProperty Type
enabledWhether the column is enabled. Default is true.value: boolean
widthThe 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
strictWidthIf enabled, the width of the column (set with the width property) becomes static. Default is false.value: boolean
sortDefault sort order of the column. Options are none, ascending, or descending.value: string dropdown
object
activePipeline

Settings for the activePipeline column.

Expand
titleExpand to see activePipeline properties
NameDescriptionProperty Type
enabledWhether the column is enabled. Default is true.value: boolean
widthThe 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
strictWidthIf enabled, the width of the column (set with the width property) becomes static. Default is false.value: boolean
sortDefault sort order of the column. Options are none, ascending, or descending.value: string dropdown
object
clearTime

Settings for the clearTime column.

Expand
titleExpand to see clearTime properties
NameDescriptionProperty Type
enabledWhether the column is enabled. Default is true.value: boolean
widthThe 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
strictWidthIf enabled, the width of the column (set with the width property) becomes static. Default is false.value: boolean
sortDefault sort order of the column. Options are none, ascending, or descending.value: string dropdown
object
clearPipeline

Settings for the clearPipeline column.

Expand
titleExpand to see clearPipeline properties
NameDescriptionProperty Type
enabledWhether the column is enabled. Default is true.value: boolean
widthThe 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
strictWidthIf enabled, the width of the column (set with the width property) becomes static. Default is false.value: boolean
sortDefault sort order of the column. Options are none, ascending, or descending.value: string dropdown
object
deadband

Settings for the deadband column.

Expand
titleExpand to see deadband properties
NameDescriptionProperty Type
enabledWhether the column is enabled. Default is true.value: boolean
widthThe 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
strictWidthIf enabled, the width of the column (set with the width property) becomes static. Default is false.value: boolean
sortDefault sort order of the column. Options are none, ascending, or descending.value: string dropdown
object
object
shelved

Shelved alarm columns to display on load.

NameDescriptionProperty Type
expires

Settings for the expires column.

Expand
titleExpand to see expires properties
NameDescriptionProperty Type
enabledWhether the column is enabled. Default is true.value: boolean
widthThe 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
strictWidthIf enabled, the width of the column (set with the width property) becomes static. Default is false.value: boolean
sortDefault sort order of the column. Options are none, ascending, or descending.value: string dropdown

shelvedBy

Settings for the shelvedBy column.

Expand
titleExpand to see shelvedBy properties
NameDescriptionProperty Type
enabledWhether the column is enabled. Default is true.value: boolean
widthThe 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
strictWidthIf enabled, the width of the column (set with the width property) becomes static. Default is false.value: boolean
sortDefault sort order of the column. Options are none, ascending, or descending.value: string dropdown

sourcePath

Settings for the sourcePath expires column.

Expand
titleExpand to see shelvedBy properties
NameDescriptionProperty Type
enabledWhether the column is enabled. Default is true.value: boolean
widthThe 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
strictWidthIf enabled, the width of the column (set with the width property) becomes static. Default is false.value: boolean
sortDefault sort order of the column. Options are none, ascending, or descending.value: string dropdown

object

pager

Settings for the pager.

Expand
titleExpand to see shelvedBy properties
NameDescriptionProperty Type
enabledEnables the pager to be displayed. Default is true.value: boolean
hideVisually hides the pager from view. Useful when pager is manipulated in a controlled fashion via the activePage property. Default is false.

value: boolean

optionsRows to show per pager option.array
initialOptionThe initial option to use when the table first loads. It must exist as an available option.value: numeric
activePageRepresents the current active page and corresponds to the value of the page jump input field.value: numeric
object


activeSortOrder


New_in
Version8.0.11


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
New_in
Version8.0.11


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
styleSets 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
Info
iconfalse
titlePerspective 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.

Panel
titleExamples
Panel
titleExample 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.


Panel
titleExample 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.