Skip to main content
Version: 8.1

Perspective - Alarm Status Table

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.

New in 8.1.14
Columns can be reordered in Preview Mode and in a Perspective Session by clicking and dragging when the dragOrderable property is enabled.

New in 8.1.12
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.

User Interface‚Äč

InterationDescription
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 SettingsClicking the icon or right clicking on a column heading will open the Configuration menu, which determines which columns show appear on the component.
FiltersClicking 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 ModalHovering over a row in the table will cause the Popup Modal icon to appear. Clicking this icon shows more information about the alarm.
Rows to DisplayDetermines how many rows are shown per page.
SearchClicking the icon cause a search bar to appear, allowing the user to type in search terms.
Shelved AlarmsShows 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
New in 8.1.0
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
toolbarSettings for the toolbar. Click to see toolbar properties.object
shelvingTimesAvailable alarming shelving times in seconds. Shelving times are customizable by editing values for this property in the Property Editor.array
responsiveResponsive layout configuration. Rows are converted to cards. While in responsive layout, disables or removes certain table features that are no longer applicable.
  • enabled: Enables responsive layout. Default is false. Value is boolean
  • breakpoint: Width in pixels that triggers change in responsive layout. Value is numeric.
  • object
    filtersThis is where you configure filtering properties for displaying alarm data in the Alarm Status Table. Click to see the filter properties.object
    selection
    New in 8.1.4
    Currently selected alarms and alarm selection configuration.
  • active: Active alarm selection configuration and read-only list of currently selected active alarms.
  • mode: Active alarm selection configuration. Options are multiple, single, or none. Value is string.
  • data: A read-only list of currently selected active alarms. Value is array.
  • shelved: Shelved alarm configuration and read-only list of currently selected shelved alarms.
  • mode: Shelved alarm selection configuration. Options are multiple, single, or none. Value is string
  • data: A read-only list of currently selected active alarms. Value is array.
  • object
    rowStylesStyles to apply to rows given their alarm state and designated priority. Click to see the rowStyles properties.object
    activeSortOrderThe 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
    shelvedSortOrderThe 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
    dragOrderable
    New in 8.1.14
    When enabled, users may drag column headers to reorder columns in the table.
    value: boolean
    columnsUsed only for determining what columns to show on load. Click to see columns propertiesobject
    columnsAssociated
    New in 8.1.14
    A list of columns used to retrieve and display alarm associated data. Click to see columnAssociated properties
    object
    pagerSettings for the pager. Click to see pager propertiesobject
    styleSets a style that applies to the component. The Style menu contains all the tools for modifying text, background, margins, and borders. You can also specify a style class.object

    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
    toggleableFilter
    New in 8.1.18
    If false, the text filter will not require user interaction to open, and instead will remain open. 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

    filter Properties‚Äč

    active‚Äč

    Settings for active alarms.

    NameDescriptionProperty Type
    textThe alarm events filter text.value: string
    statesPre-filters for filter active alarm events. All of the following properties are boolean values.
  • activeUnacked: Active and unacknowledged. Default is true.
  • activeAcked: Active and acknowledged. Default is true.
  • clearUnacked: Cleared and unacknowledged. Default is true.
  • clearAcked: Active and acknowledged. Default is false.
  • object
    prioritiesAlarm event priority pre-filters. All of the following properties are boolean values.
  • diagnostic: Whether to display alarms with diagnostic priority. Default is false.
  • low: Whether to display alarms with low priority. Default is true.
  • medium: Whether to display alarms with medium priority. Default is true.
  • high: Whether to display alarms with high priority. Default is true.
  • critical: Whether to display alarms with critical priority. Default is true.
  • object
    conditionsGateway side alarm query conditions. All of the following properties are string values.
  • source: Filter alarms by alarm source path. Specify multiple paths by separating them with commas. Supports the wildcard *.
  • displayPath: Filter alarms by display path, falling back to the source path if a custom display path in not set. Specify multiple paths by separating them with commas. Supports the wildcard *.
  • provider: Filter alarms by provider.
  • object
    resultsAlarm event filtering results configuration and data.
  • enabled: Enable filtering results to be written back to props. Value is a boolean. Note: Enabling this property may cause a performance decline.
  • data: An array of objects representing the current filtered data, if enabled and active.
  • object

    shelved‚Äč

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

    NameDescriptionProperty Type
    textThe alarm events filter text.value: string
    resultsShelved alarm filtering results configuration and data.
  • enabled: Enable filter results to be written back to props. Caution: Doing so may cause performance decline. Default is false. Value is boolean.
  • data: An array of objects representing the current filtered data if enabled and active. Value is array.
  • object

    rowStyles Properties‚Äč

    NameDescriptionProperty Type
    activeUnackedStyle settings for rows with activeUnacked alarms.object
    activeAckedStyle settings for rows with activeAcked alarms.object
    clearUnackedStyle settings for rows with clearUnacked alarms.object
    clearAckedStyle settings for rows with clearAcked alarms. object
    dateFormatA date format string to be applied against dates.value: string

    rowStyles Child Properties‚Äč

    Each rowStyles property except dateFormat has the following child properties. For each, a full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class

    NameDescriptionProperty Type
    baseBase style settings for alarms.object
    prioritiesStyle settings for the alarm row based on priority.
  • diagnostic: Style for acked alarms with diagnostic priority.
  • low: Style for acked alarms with low priority.
  • medium: Style for acked alarms with medium priority.
  • high: Style for acked alarms with high priority.
  • critical: Style for acked alarms with critical priority.
  • object

    columns Properties‚Äč

    active‚Äč

    Active alarm event columns to display on load

    NameDescriptionProperty Type
    activeTimeSettings for the activeTime column.object
    displayPathSettings for the displayPath column.object
    prioritySettings for the priority column.object
    stateSettings for the state column.object
    sourceSettings for the source column.object
    labelSettings for the label column.object
    nameSettings for the name column.object
    eventIdSettings for the eventId column.object
    eventValueSettings for the eventValue column.object
    notesSettings for the notes column.object
    isActiveSettings for the isActive column.object
    isAckedSettings for the isAcked column.object
    isClearSettings for the isClear column.object
    ackTimeSettings for the ackTime column.object
    ackUserSettings for the ackUser column.object
    ackNotesSettings for the ackNotes column.object
    ackPipelineSettings for the ackPipeline column.object
    activePipelineSettings for the activePipeline column.object
    clearTimeSettings for the clearTime column.object
    clearPipelineSettings for the clearPipeline column.object
    deadbandSettings for the deadband column.object

    shelved‚Äč

    NameDescriptionProperty Type
    expiresSettings for the expires column.object
    shelvedBySettings for the shelvedBy column.object
    sourcePathSettings for the sourcePath expires column.object

    column active and shelved Child Properties‚Äč

    Each column type property has the following child 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

    columnsAssociated active Properties‚Äč

    Active alarm event associated data columns to display on load.

    NameDescriptionProperty Type
    fieldMaps to the associated data value represented by the column.value: string
    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
    orderOrder to display this column in the table.value: numeric

    pager 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

    Scripting‚Äč

    See the Perspective - Alarm Status Table Scripting page for the full list of scripting functions available for this 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.