Skip to end of metadata
Go to start of metadata
General


Component Palette Icon:



Description

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. 

Shelving is supported by pressing the "Shelve" button when an alarm is selected and choosing a time duration. 

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.

The following feature is new in Ignition version 8.1.12
Click here to check out the other new features
The Alarm Status Table utilizes a shared polling engine to cache and share polling tasks across concurrent sessions. The cache persists for a period of time that matches the configured poll rate. This optimization allows multiple components to poll the alarm system with a reduced impact on overall performance.


Interactions


InteractionDescription
Active Alarm EventsShows the number of active alarms in the system. When viewing the shelved alarms view, clicking on the bell icon will switch the component back to the realtime view. 
Config Settings

Clicking the  icon or right clicking on a column heading will open the Configuration menu, which determines which columns show appear on the component. 

Filters

Clicking the  icon opens the Filters menu, allowing you to select event states and priorities to filter on. 

PagesA listing of pages. Long lists of alarm events are spread across multiple pages to improve performance. Clicking on a number will switch which page is shown.
Popup Modal

Hovering over a row in the table will cause the Popup Modalicon to appear. Clicking this icon shows more information about the alarm. 

Rows to DisplayDetermines how many rows are shown per page. 
Search

Clicking the  icon cause a search bar to appear, allowing the user to type in search terms. 

Shelved Alarms

Shows the number of shelved alarms. When viewing the realtime view, clicking on the Shelved Alarms display will switch to the shelved alarms view. 

While the table is showing shelved alarms, shelved alarms can be selected from the table and unshelved. 


In addition, selecting a row within the table shows some additional interaction options. 

The Shelve button allows you to shelve the selected alarms.

The Acknowledge button allows you to mark the selected alarms as "acknowledged". 

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.

NameDescriptionProperty Type
refreshRate

The following feature is new in Ignition version 8.1.0
Click here to check out the other new features
The rate at which the table will poll for updates in milliseconds. 

value: numeric
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

Settings for the toolbar.

 Click 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



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.

 Click 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:

 Click 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

Alarm state priority pre-filters.

 Click 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.

 Click 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.

 Click 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.

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

Shelved alarm filtering results configuration and data.

 Click 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
selection

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

Currently selected alarms and alarm selection configuration.


NameDescriptionProperty Type
active

Active alarm selection configuration and read-only list of currently selected active alarms.

NameDescriptionProperty Type
modeActive alarm selection configuration. Options are multiple, single, or none.value: string
dataA read-only list of currently selected active alarms.value: array
object
shelved

Shelved alarm configuration and read-only list of currently selected shelved alarms

NameDescriptionProperty Type
modeShelved alarm selection configuration. Options are multiple, single, or none.value: string
dataA read-only list of currently selected active alarms.value: array
object
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

baseBase style settings for activeUnacked alarms. Full menu of style options is available. You can also specify a style classobject
priorities

Style settings for the alarm row based on priority.

 Click here to 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.

 Click here to expand...

Name

Description

Property Type

baseBase style settings for activeAcked alarms. Full menu of style options is available. You can also specify a style classobject
priorities

Style settings for the alarm row based on priority.

 Click here to 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 class  object
object
object
clearUnacked

Style settings for rows with clearUnacked alarms.

 Click here to expand...

Name

Description

Property Type

baseBase style settings for clearUnacked alarms. Full menu of style options is available. You can also specify a style classobject
priorities

Style settings for the alarm row based on priority.

 Click here to 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.

 Click here to expand...

Name

Description

Property Type

baseBase style settings for clearAcked alarms. Full menu of style options is available. You can also specify a style classobject
priorities

Style settings for the alarm row based on priority.

 Click here to 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: string
object

activeSortOrder

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 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
columns

Used only for determining what columns to show on load.

NameDescriptionProperty Type
active

Active alarm even columns to display on load

 Click to see column properties
NameDescriptionProperty Type
activeTime

Settings for the activeTime column.

 Expand 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
object
displayPath

Settings for the displayPath column.

 Expand 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 
object
priority

Settings for the priority column.

 Expand 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
object
state

Settings for the state column.

 Expand 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
object
source

Settings for the source column.

 Expand 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
object
label

Settings for the label column.

 Expand 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
object
name

Settings for the name column.

 Expand 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
object
eventId

Settings for the eventId column.

 Expand 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
object
eventValue

Settings for the eventValue column.

 Expand 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
object
notes

Settings for the notes column.

 Expand 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
object
isActive

Settings for the isActive column.

 Expand 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
object
isAcked

Settings for the isAcked column.

 Expand 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
object
isClear

Settings for the isClear column.

 Expand 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
object
ackTime

Settings for the ackTime column.

 Expand 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
object
ackUser

Settings for the ackUser column.

 Expand 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
object
ackNotes

Settings for the ackNotes column.

 Expand 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
object
ackPipeline

Settings for the ackPipeline column.

 Expand 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
object
activePipeline

Settings for the activePipeline column.

 Expand 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
object
clearTime

Settings for the clearTime column.

 Expand 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
object
clearPipeline

Settings for the clearPipeline column.

 Expand 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
object
deadband

Settings for the deadband column.

 Expand 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
object
object
shelved

Shelved alarm columns to display on load.

NameDescriptionProperty Type
expires

Settings for the expires column.

 Expand 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

shelvedBy

Settings for the shelvedBy column.

 Expand 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

sourcePath

Settings for the sourcePath expires column.

 Expand 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

object
object
pager

Settings for the pager.

 Expand 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
shelvedPageRepresents the current shelved page and corresponds to the value of the page jump input field.value: numeric
object
styleSets a style that applies to the component. Full menu of style options is available. You can also specify a style classobject

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.

Extension Functions

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

 filterAlarm
  • Description

Called for each event before it is displayed in the table, allowing you to hide or show each alarm event (row) in the table. Provides an opportunity to write a more complex filter than what's normally provided to the component.  Return False to exclude an alarm event from the table. 

  • Parameters

ComponentModelScriptWrapper.SafetyWrapper self- A reference to the component that is invoking this function.

PyAlarmEvent alarmEvent - The alarm event itself. Call alarmEvent.get('propertyName') to inspect properties on the event. Common properties: 'name', 'source', 'priority'.

  • Return

Boolean - The function must return either a True or False for every alarm event in the table. True will show the alarm. False will hide the alarm.

Examples

With the built-in PyAlarmEvent object all alarm event properties are accessible to this function, and can be used to help determine if any given event should appear on the table. Furthermore, Associated Data (also known as custom alarm properties) can be examined from the same event. 

# Replace Property Name below with a the name of the property you wish to filter on. 
if alarmEvent.get('Property Name'):
    return True
# It's important that you return a False value for the events you don't want to see in the table. 
else:
	return False


You could also condense the code example above by using something like the following:


return "Low"== str(alarmEvent.get('priority'))


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

 filterShelvedAlarm
  • Description

Called for each event before it is displayed in the shelved tab of the table, allowing you to hide or show each alarm event (row) in the table. Return False to exclude a shelved alarm event from the table. 

  • Parameters

ComponentModelScriptWrapper.SafetyWrapper self- A reference to the component that is invoking this function.

PyAlarmEvent shelvedAlarmEvent - The shelved alarm event. Call shelvedAlarmEvent.get('propertyName') to inspect properties on the event. Properties: 'sourcePath', 'shelvedBy', 'expires'.

  • Return

Boolean - The function must return either a True or False for every alarm event in the table. True will show the alarm. False will hide the alarm.

Examples

Unlike the alarmEvent object, the shelvedAlarmEvent object may only inspect shelved alarm event properties. 

# display only shelved alarms from a specific sourcePath:

source = shelvedAlarmEvent.get('sourcePath')
if source == 'prov:default:/tag:myTag/Mode:/alm:myAlarm':
	return True
return False
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.


  • No labels