Skip to end of metadata
Go to start of metadata


General



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.

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. 


Note: The  Alarm Journal  must first be set up with a valid  database  connection for the  Alarm Journal  Table to see  alarm  history from the  database .

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
name

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

value: string
refreshRate

This 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
enableHeaderEnables the table header. Default is true.value: boolean
enableDetails

Enables the details action. Default is true.

value: boolean
toolbar

Settings for the toolbar.

 Click to see the 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
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
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.

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

Settings for date range state.

NameDescriptionProperty Type
modeThe current mode: realtime or historical.value: string
realtime

Realtime mode state settings.

NameDescriptionProperty Type
intervalThe realtime interval as an integervalue: numeric
unitThe realtime interval unit: hours, days, months and years.value: string
object
object
filter

Filter settings.

NameDescriptionProperty Type
textThe alarm events filter text.value: string
events

Alarm event types.

NameDescriptionProperty Type
activeWhether to display alarms with active events. Default is true.value: boolean
ackedWhether to display alarms with acked events. Default is true.value: boolean
clearedWhether to display alarms with cleared events. Default is true.value: boolean
systemWhether to display alarms with system events. Default is false.value: boolean
object
priorities

Alarm event priority pre-filters.

NameDescriptionProperty Type
diagnosticWhether to display alarms with diagnostic priority. Default is false.value: boolean
lowWhether to display alarms with low priority. Default is true.value: boolean
mediumWhether to display alarms with medium priority. Default is true.value: boolean
highWhether 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.

NameDescriptionProperty Type
sourceFilter alarms by alarm source path. Specify multiple paths by separating them with commas. Supports the wildcard *.value: string
displayPathFilter 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
providerFilter alarms by provider.value: string
object
results

Alarm event filtering results configuration and data.

NameDescriptionProperty Type
enabled

Enable filtering results to be written back to props.

Caution: Enabling this property may cause a performance decline.

value: boolean
dataAn array of objects representing the current filtered data, if enabled and active.array
object
object
rowStyles

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

 Expand to see rowStyles properties
NameDescriptionProperty Type
active

Style settings for rows with active alarms.

 Expand to see the active properties
NameDescriptionProperty Type
baseBase 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 to see priorities settings
NameDescriptionProperty Type
diagnosticStyle for active alarms with diagnostic priority. Full menu of  style options  is available. You can also specify a  style class  object
lowStyle for active alarms with low priority.  Full menu of style options is available. You can also specify a style classobject
mediumStyle for active alarms with medium priority.  Full menu of style options is available. You can also specify a style classobject
highStyle for active alarms with high priority.  Full menu of style options is available. You can also specify a style classobject
criticalStyle for active alarms with critical priority.  Full menu of style options is available. You can also specify a style classobject
object
object
acked

Style settings for rows with acked alarms.


 Expand to see the acked properties
NameDescriptionProperty Type
baseBase style settings for acked alarms. object
priorities

Style settings for the alarm row based on priority.

 Expand to see priorities settings
NameDescriptionProperty Type
diagnosticStyle for acked alarms with diagnostic priority. Full menu of  style options  is available. You can also specify a  style class object
lowStyle for acked alarms with low priority.  Full menu of style options is available. You can also specify a style classobject
mediumStyle for acked alarms with medium priority.  Full menu of style options is available. You can also specify a style classobject
highStyle for acked alarms with high priority.  Full menu of style options is available. You can also specify a style classobject
criticalStyle for acked alarms with critical priority.  Full menu of style options is available. You can also specify a style classobject
object
object
cleared

Style settings for rows with cleared alarms.

 Expand to see the cleared properties
NameDescriptionProperty Type
baseBase 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 classobject
priorities

Style settings for the alarm row based on priority.

 Expand to see priorities settings
NameDescriptionProperty Type
diagnosticStyle for cleared alarms with diagnostic priority. Full menu of style options is available. You can also specify a style classobject
lowStyle for cleared alarms with low priority. Full menu of style options is available. You can also specify a style classobject
mediumStyle for cleared alarms with medium priority. Full menu of style options is available. You can also specify a style classobject
highStyle for cleared alarms with high priority. Full menu of style options is available. You can also specify a style classobject
criticalStyle for cleared alarms with critical priority. Full menu of style options is available. You can also specify a style classobject
object
object
system

Style settings for rows with system alarms.


 Expand to see the system properties
NameDescriptionProperty Type
baseBase 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 to see priorities settings
NameDescriptionProperty Type
diagnosticStyle for system alarms with diagnostic priority. Full menu of style options is available. You can also specify a style classobject
lowStyle for system alarms with low priority. Full menu of style options is available. You can also specify a style classobject
mediumStyle for system alarms with medium priority. Full menu of style options is available. You can also specify a style classobject
highStyle for system alarms with high priority. Full menu of style options is available. You can also specify a style classobject
criticalStyle for system alarms with critical priority. Full menu of style options is available. You can also specify a style classobject
object
object
object
columns

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

 Click to see column properties
NameDescriptionProperty Type
eventTime

Settings for the eventTime 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
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
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
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
eventState

Settings for the eventState column.

 Expand to see eventState 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
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
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
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
isSystemEvent

Settings for the isSystemEvent column.

 Expand to see isSystemEvent 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
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.

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

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

  • Scope

Session

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. 

# 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'))

Examples

For examples and additional information on usage of the Alarm Journal Table, see Alarming in Perspective.


  • No labels