Page History

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

Version	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

Interaction	Description
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.
Date Range	Clicking 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.
Filters	Clicking the icon 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.
Popup Modal	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.
Search	Clicking the icon 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.

Properties

Perspective_property

Name

Description

Property Type

name

The name of the alarm journal to query. Default is "Journal".

Note_friendly
On Edge gateways, set this to an empty string value to have the component use the Edge Alarm Journal.

value: string

refreshRate

New_in

Version	8.1.0

The rate at which the table will poll for updates in milliseconds.

value: numeric

enableHeader

Enables the table header. Default is true.

value: boolean

enableDetails

Enables the details action. Default is true.

value: boolean

toolbar

Settings for the toolbar.

Expand

title	Click to see the Toolbar properties

Name

Description

Property Type

enabled

Enables the visibility of the table toolbar. Default is true.

value: boolean

enableDateRange

Enables the visibility of the date range toggle. Default is true.

value: boolean

enableFilter

Enables the visibility of the text filter toggle. Default is true.

value: boolean

toggleableFilter

New_in

Version	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

enableFilterResults

Enables the visibility of the filters results count message. Default is true.

value: boolean

enablePreFilters

Enables the visibility of the prefilter toggle. Default is true.

value: boolean

enableConfiguration

Enables the visibility of the configuration toggle. Default is true.

value: boolean

object

dateFormat

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

value: string

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
enabled	Enables responsive layout. Default is false.	value: boolean
breakpoint	Width in pixels that triggers change in responsive layout.	value: numeric

object

dateRange

Settings for date range state.

Name

Description

Property Type

mode

The current date range mode: realtime or historical.

value: string

realtime

When mode is set to realtime, this property will appear with the following sub properties available:

Name	Description	Property Type
interval	The realtime interval as an integer	value: numeric
unit	The realtime interval unit: hours, days, months and years.	value: string

object

historical

When mode is set to historical, this property will appear with the following sub properties available:

Name	Description	Property Type
startDate	The start date to use, in milliseconds.	value: numeric
endDate	The end date to use, in milliseconds.

object

filter

Filter settings.

Name

Description

Property Type

text

The alarm events filter text.

value: string

events

Alarm event types.

Name	Description	Property Type
active	Whether to display alarm events with active states. Default is true.	value: boolean
acked	Whether to display alarm events with acked states. Default is true.	value: boolean
cleared	Whether to display alarm events with cleared states. Default is true.	value: boolean
enabled	Whether to display alarm events that were generated by enabling an alarm.	value: boolean
disabled	Whether to display alarm events that were generated by disabling an alarm.	value: boolean
system	Whether to display alarm event with system states. Default is false.	value: boolean

object

priorities

Alarm event priority pre-filters.

Name	Description	Property 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
critical	Whether to display alarms with critical priority. Default is true.	value: boolean

object

conditions

Gateway side alarm query conditions.

Name	Description	Property Type
source	Filter alarms by alarm source path. Specify multiple paths by separating them with commas. Supports the wildcard *.	value: string
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 *.	value: string
provider	Filter alarms by provider.	value: string

object

results

Alarm event filtering results configuration and data.

Name

Description

Property Type

enabled

Enable filtering results to be written back to props.

Caution_friendly
Enabling this property may cause a performance decline.

value: boolean

data

An array of objects representing the current filtered data, if enabled and active.

array

object

rowStyles

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

Expand

title	Expand to see rowStyles properties

Name

Description

Property Type

active

Style settings for rows with active alarms.

Expand

title	Expand to see the active properties

Name

Description

Property Type

base

Base style settings for active alarms. 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

priorities

Style settings for the alarm row based on priority.

Expand

title	Expand to see priorities settings

Name	Description	Property Type
diagnostic	Style for active alarms with diagnostic priority. Full menu of style options is available. You can also specify a style class	object
low	Style for active alarms with low priority. Full menu of style options is available. You can also specify a style class.	object
medium	Style for active alarms with medium priority. Full menu of style options is available. You can also specify a style class.	object
high	Style for active alarms with high priority. Full menu of style options is available. You can also specify a style class.	object
critical	Style for active alarms with critical priority. Full menu of style options is available. You can also specify a style class.	object

object

acked

Style settings for rows with acked alarms.

Expand

title	Expand to see the acked properties

Name

Description

Property Type

base

Base style settings for acked alarms.

object

priorities

Style settings for the alarm row based on priority.

Expand

title	Expand to see priorities settings

Name	Description	Property Type
diagnostic	Style for acked alarms with diagnostic priority. Full menu of style options is available. You can also specify a style class .	object
low	Style for acked alarms with low priority. Full menu of style options is available. You can also specify a style class.	object
medium	Style for acked alarms with medium priority. Full menu of style options is available. You can also specify a style class.	object
high	Style for acked alarms with high priority. Full menu of style options is available. You can also specify a style class.	object
critical	Style for acked alarms with critical priority. Full menu of style options is available. You can also specify a style class.	object

object

cleared

Style settings for rows with cleared alarms.

Expand

title	Expand to see the cleared properties

Name

Description

Property Type

base

Base style settings for cleared alarms. 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

priorities

Style settings for the alarm row based on priority.

Expand

title	Expand to see priorities settings

Name	Description	Property Type
diagnostic	Style for cleared alarms with diagnostic priority. Full menu of style options is available. You can also specify a style class.	object
low	Style for cleared alarms with low priority. Full menu of style options is available. You can also specify a style class.	object
medium	Style for cleared alarms with medium priority. Full menu of style options is available. You can also specify a style class.	object
high	Style for cleared alarms with high priority. Full menu of style options is available. You can also specify a style class.	object
critical	Style for cleared alarms with critical priority. Full menu of style options is available. You can also specify a style class.	object

object

system

Style settings for rows with system alarms.

Expand

title	Expand to see the system properties

Name

Description

Property Type

base

Base style settings for system alarms. 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

priorities

Style settings for the alarm row based on priority.

Expand

title	Expand to see priorities settings

Name	Description	Property Type
diagnostic	Style for system alarms with diagnostic priority. Full menu of style options is available. You can also specify a style class.	object
low	Style for system alarms with low priority. Full menu of style options is available. You can also specify a style class.	object
medium	Style for system alarms with medium priority. Full menu of style options is available. You can also specify a style class.	object
high	Style for system alarms with high priority. Full menu of style options is available. You can also specify a style class.	object
critical	Style for system alarms with critical priority. Full menu of style options is available. You can also specify a style class.	object

object

dragOrderable

New_in

Version	8.1.14

When enabled, users may drag column headers to reorder columns in the table.

value: boolean

columns

Used for determining what column properties to display on the Alarm Journal Table.

Expand

title	Click to see column properties

Name

Description

Property Type

eventTime

Settings for the eventTime column.

Expand

title	Expand to see eventTime properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The 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
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string

object

eventId

Settings for the eventId column.

Expand

title	Expand to see eventId properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The 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
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string

object

name

Settings for the name column.

Expand

title	Expand to see name properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The 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
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string

object

source

Settings for the source column.

Expand

title	Expand to see source properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The 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
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string

object

eventState

Settings for the eventState column.

Expand

title	Expand to see eventState properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The 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
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string

object

priority

Settings for the priority column.

Expand

title	Expand to see priority properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The 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
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string

object

state

Settings for the state column.

Expand

title	Expand to see state properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The 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
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string

object

displayPath

Settings for the displayPath column.

Expand

title	Expand to see displayPath properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The 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
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string

object

label

Settings for the label column.

Expand

title	Expand to see label properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The 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
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string

object

eventValue

Settings for the eventValue column.

Expand

title	Expand to see eventValue properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The 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
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string

object

isSystemEvent

Settings for the isSystemEvent column.

Expand

title	Expand to see isSystemEvent properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The 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
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string

object

ackUser

Settings for the ackUser column.

Expand

title	Expand to see ackUser properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The 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
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string

object

ackNotes

Settings for the ackNotes column.

Expand

title	Expand to see ackNotes properties

Name	Description	Property Type
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The 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
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string

object

columnsAssociated

New_in

Version	8.1.14

A list of columns used to retrieve and display alarm associated data.

Expand

title	Expand to see columnsAssociated properties

Name	Description	Property Type
field	Maps to the associated data value represented by the column.	value: string
enabled	Whether the column is enabled. Default is true.	value: boolean
width	The 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
strictWidth	If enabled, the width of the column (set with the width property) becomes static. Default is false.	value: boolean
sort	Default sort order of the column. Options are none, ascending, or descending.	value: string
order	Order to display this column in the table.	value: numeric

object

sortOrder

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.

array

pager

Settings for the pager.

Name	Description	Property Type
enabled	Enables the pager to be displayed. Default is true.	value: boolean
hide	Visually hides the pager from view. Useful when pager is manipulated in a controlled fashion via the activePage property. Default is false.	value: boolean
options	Rows to show per pager option.	array
initialOption	The initial option to use when the table first loads. It must exist as an available option.	value: numeric
activePage	Represents the current active page and corresponds to the value of the page jump input field.	value: numeric

object

style

Sets a style that applies to the component. Full menu of style options is available. You can also specify a style class.

object

Component Events

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.

Component Functions

Expand

title	.refreshData()

New_in

Version	8.1.18

Description

Refreshes the data on the Alarm Journal Table.

Parameters

None

Return

Nothing

Extension Functions

New_in

Version	8.1.0

Expand

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

Code Block

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

Code Block

language	py

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

OTHER USER MANUAL VERSIONS

GETTING STARTED

OTHER EDITIONS

LAUNCHERS

MODULES

PLATFORM

APPENDIX

TUTORIALS & HELPFUL TRICKS

PARTNER LINKS

RESOURCES

OTHER USER MANUALS

Offline Ignition Manual

Employees

Versions Compared

Old Version 38

New Version Current

Key

User Interface

Properties

Component Events

Component Functions

Extension Functions

Examples