Skip to main content
Version: 8.1

Perspective - Alarm Journal Table

Component Palette Icon:

Description‚Äč

The Perspective Alarm Journal Table displays the history of the alarm system. It can be configured to show active, cleared, and acknowledged events.

Before the Alarm Journal Table can retrieve alarm data, an Alarm Journal must first be configured.

The Perspective Alarm Journal Table has a number of configuration options that can be used to filter on realtime and historical alarm data, and change how the component displays those alarms. When you first drag the Alarm Journal Table into the Designer, by default, the table will show you the last 8 hours of alarm journal data. You can interface with the journal table in the Designer, in Preview Mode of the Designer, and in a Perspective Session.

The Alarm Journal 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. The Alarm Journal Table can filter for alarm events in either Realtime or Historical using the Date Range feature.

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.

New in 8.1.12
The Alarm Journal Table utilizes a shared polling engine when in realtime date range mode 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‚Äč

The following table describes the user interface available for the Alarm Journal Table.

InteractionDescription
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.
Date RangeClicking on the  icon will open the Date Range window, allowing the user to determine a range of time to filter on. Alarm events with an Event Time that matches the selected range will appear on the table.
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 will cause a search bar to appear, allowing the user to type in search terms.

Additional interface options become available when selecting a row within the table, which allow the table to search for similar events.

  • Alarm: Shows all events for a single alarm instance, meaning the active event, the clearing event, and the acknowledging event (if present).
  • Source Path: Shows all events that match the same source path as the selected event, respecting the selected date range.

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
nameThe name of the alarm journal to query. Default is "Journal".

Note: In Gateway Network configurations, set this to an empty string OR use the name of the Remote Alarm Journal. On Edge Gateways, set this to an empty string value to have the component use the Edge Alarm Journal.
value: string
refreshRate
New in 8.1.0
The rate at which the table will poll for updates in milliseconds.
value: numeric
enableHeaderEnables the table header. Default is true.value: boolean
enableDetailsEnables the details action. Default is true.value: boolean
toolbarSettings for the toolbar. Click to see the toolbar propertiesobject
dateFormatA date format string to be applied against dates. Options are none, date in the format "10/15/2018", time in format "3:59:00 PM", or date time in format "10/15/208 15:59:00".value: string
responsiveResponsive layout configuration. Rows are converted to cards. While in responsive layout, disables or removes certain table features that are no longer applicable. Click to see the responsive propertiesobject
dateRangeSettings for date range state. Click to see the dateRange propertiesobject
filterFilter settings. Click to see the filter propertiesobject
rowStylesStyles to apply to rows given their alarm event and designated priority. Click to see rowStyles propertiesobject
dragOrderable
New in 8.1.14
When enabled, users may drag column headers to reorder columns in the table.
value: boolean
columnsUsed for determining what column properties to display on the Alarm Journal Table. 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 columnsAssociated properties.
object
sortOrderThe default weighted order in which columns and their contents are sorted relative to other columns and their contents. Only works if used when the component loads. Columns need to have sort configured in order for this to work.array
pagerSettings for the pager. Click to see pager properties.object
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
enableDateRangeEnables the visibility of the date range toggle. Default is true.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 prefilter toggle. Default is true.value: boolean
enableConfigurationEnables the visibility of the configuration toggle. Default is true.value: boolean

responsive Properties‚Äč

NameDescriptionProperty Type
enabledEnables responsive layout. Default is false.value: boolean
breakpointWidth in pixels that triggers change in responsive layout.value: numeric

dateRange Properties‚Äč

NameDescriptionProperty Type
modeThe current date range mode: realtime or historical.value: string
realtimeWhen mode is set to realtime, this property will appear with the following sub properties available:
  • interval: The realtime interval as an integer, value is numeric.
  • unit: The realtime interval unit: seconds, minutes, hours, days, months and years, value is a string.
  • object
    historicalWhen mode is set to historical, this property will appear with the following sub properties available:
  • startDate: The start date to use, in milliseconds.¬†Value is numeric
  • endDate: The end date to use, in milliseconds. Value is numeric.
  • object

    filter Properties‚Äč

    NameDescriptionProperty Type
    textThe alarm events filter text.value: string
    eventsAlarm event types. All of the following properties are boolean values.
  • active: Whether to display alarm events with active states. Default is true.
  • acked: Whether to display alarm events with acked states. Default is true.
  • cleared: Whether to display alarm events with cleared states. Default is true.
  • enabled: Whether to display alarm events that were generated by enabling an alarm.
  • disabled: Whether to display alarm events that were generated by disabling an alarm.
  • system: Whether to display alarm event with system states. 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, array property type.
  • object

    rowStyles Properties‚Äč

    NameDescriptionProperty Type
    activeStyle settings for rows with active alarms.object
    ackedStyle settings for rows with acked alarms.object
    clearedStyle settings for rows with cleared alarms.object
    systemStyle settings for rows with system alarms. object

    rowStyles Child Properties‚Äč

    Each rowStyles property 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‚Äč

    NameDescriptionProperty Type
    eventTimeSettings for the eventTime column. object
    eventIdSettings for the eventId column. object
    nameSettings for the name column.object
    sourceSettings for the source column. object
    eventStateSettings for the eventState column. object
    prioritySettings for the priority column. object
    stateSettings for the state column. object
    displayPathSettings for the displayPath column. object
    labelSettings for the label column. object
    eventValueSettings for the eventValue column. object
    isSystemEventSettings for the isSystemEvent column. object
    ackUserSettings for the ackUser column. object
    ackNotesSettings for the ackNotes column.object

    column 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 Properties‚Äč

    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

    Scripting‚Äč

    See the Perspective - Alarm Journal Table Scripting page for the full list of scripting functions available for this component.