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.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.
Clicking theicon or right clicking on a column heading will open the Configuration menu, which determines which columns show appear on the component.
Clicking on theicon 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.
Clicking theicon opens the Filters menu, allowing you to select event states and priorities to filter on.
|Pages||A 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.|
Hovering 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 Display||Determines how many rows are shown per page.|
Clicking theicon will cause a search bar to appear, allowing the user to type in search terms.
In addition, selecting a row within the table show a some additional options that allow the table to search for similar events.
Alarm will cause the table to show all events for a single alarm instance: meaning the active event, the clearing event, and the acknowledging event if there is one
Source Path will cause the table to show all events that match the same source path as the selected event, respecting the selected date range.
The name of the alarm journal to query. Default is "Journal".
The rate at which the table will poll for updates in milliseconds.
|enableHeader||Enables the table header. Default is true.||value: boolean|
Enables the details action. Default is true.
Settings for the toolbar.
Click to see the Toolbar properties
A 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".
Responsive layout configuration. Rows are converted to cards. While in responsive layout, disables or removes certain table features that are no longer applicable.
Settings for date range state.
Styles to apply to rows given their alarm event and designated priority.
Expand to see rowStyles properties
When enabled, users may drag column headers to reorder columns in the table.
Used for determining what column properties to display on the Alarm Journal Table.
Click to see column properties
A list of columns used to retrieve and display alarm associated data.
Expand to see columnsAssociated properties
The 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.
Settings for the pager.
|style||Sets a style that applies to the component. Full menu of style options is available. You can also specify a style class.||object|
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.
Refreshes the data on the Alarm Journal Table.
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.
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'.
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.
With the built-in alarmEvent 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.
You could also condense the code example above by using something like the following: