Skip to main content
Version: 8.1

Vision - Alarm Journal Table

Component Palette Icon

The alarm journal table provides a built-in view to explore alarm history that has been stored in an alarm journal. If you only have one alarm journal specified on your Gateway, then you do not need to specify the journal name. If you have more than one specified, then you need to provide the name of the journal you'd like to query.

The journal table shows the alarm history that is found between the Start Date and End Date properties. When you first put an alarm journal table on a window, these properties will be set to show the most recent few hours of journal history. Note that without further configuration, the journal table will always show the few hours before it was created. To properly configure an alarm journal table, bind its start and end date properties to something what will update, such as the Date Range component or expressions involving the now expression function. This way, you can configure it so that operators can choose the time to display, or have dates will be update automatically to have it poll.

Interface Elements

ElementDescription
Selecting an EventClick on any event (row) in the table to select it. Some of the other interactions, such as the Inspect Toggle, require that an event is first selected.
HeaderEvents in the Alarm Journal Table can be sorted by each column. Simply click on the desired column header to sort by that column.
Columns can be reordered in the Vision Client by simply dragging and dropping them.
In addition, right-clicking on the header will bring up a list of available columns to show or hide.
Event CountA count representing the number of events available in the table, accounting for filters applied to the table.
Focus ButtonClicking this button while an event is selected will open a popup with the following to two selections:
Target Alarm Source: Displays only alarms that match the selected alarm's Source Path.
Target Event Id: Clears all alarms from the table, except those that have a matching value for the Event Id column. This is commonly used to show only the active, acknowledgement, and clear events for a single alarm, effectively allowing you to see the lifecycle of that alarm instance.
Clicking on the Focus Button a second time will end focus filtering.
Inspect ToggleClicking this button while an event is selected will open a popup that shows all alarm properties for the selected event.
Filter ButtonClicking this button will call the Filter panel, allowing you to filter the results in the table based on event type, priority, or search string.

Properties

NameDescriptionProperty TypeScriptingCategory
Acked EventsShow acked events.boolean.includeAckedEventsFilters
Active EventsShow active events.boolean.includeActiveEventsFilters
BorderThe border surrounding this component. Options are No border, Etched (Lowered), Etched (Raised), Bevel (Lowered), Bevel (Raised), Bevel (Double), and Field Border.
Note: The border is unaffected by rotation.

Changed in 8.1.21
As of 8.1.21, the "Button Border" and "Other Border" options are removed.
Border.borderCommon
Cleared EventsShow cleared events.boolean.includeClearedEventsFilters
Date FormatA date format pattern used to format dates in the table. If blank, the default format for the locale is used.String.dateFormatAppearance
Data QualityThe data quality code for any Tag bindings on this component.int.dataQualityDeprecated
Disabled Events
New in 8.1.8
If enabled, will show events created by alarms being disabled.
boolean.includeDisabledEventsFilters
Display Path FilterFilter alarms by alarm display path, falling back to the source path if display path isn't set. Specify multiple paths by separating them with commas. Supports the wildcard "*".String.displayPathFilterFilters
EnabledIf disabled, a component cannot be used.boolean.componentEnabledCommon
Enabled Events
New in 8.1.8
If enabled, will show events created by alarms being enabled.
boolean.includeEnabledEventsFilters
End DateThe ending date for the displayed history range. If left blank, will default to the current time when the component was loaded.Date.endDateBehavior
Is FilteredTrue if the results are filtered. (Read-only)boolean.isFilteredBehavior
Journal NameThe name of the alarm journal to query.String.journalNameBehavior
Max PriorityThe maximum priority to display.int.maximumPriorityFilters
Min PriorityThe minimum priority to display.int.minimumPriorityFilters
NameThe name of this component.String.nameCommon
Notes Area BorderThe border surrounding the notes area.Border.notesAreaBorderAppearance
Notes Area FontThe font for the notes area.Font.notesAreaFontAppearance
Notes Area LocationThe location of the notes display area.int.notesAreaLocationAppearance
Notes Area SizeThe size of the notes area, in pixels.int.notesAreaSizeAppearance
Number FormatA number format string to control the format of the value column.String.numberFormatAppearance
QualityThe data quality code for any Tag bindings on this component.QualityCode.qualityData
Read TimeoutThe timeout, in milliseconds, for running the alarm history query.int.readTimeoutBehavior
Row HeightThe height, in pixels, for each row of the table.int.rowHeightAppearance
Row StylesA dataset containing the different styles configured for different alarm states.Dataset.rowStylesAppearance
Search StringFilter alarms by searching for a string in both source path and display path.String.searchStringFilters
Selected AlarmsA dataset containing each selected alarm. (Read-only)Dataset.selectedAlarmsData
Selection ColorThe color of the selection border. Can be chosen from color wheel, chosen from color palette, or entered as RGB or HSL value. See Color Selector.Color.selectionColorAppearance
Selection ThicknessThe size of the selection border.int.selectionThicknessAppearance
Show Table HeaderToggles visibility of the table's header.boolean.showTableHeaderAppearance
Source FilterFilter alarms by alarm source path. Specify multiple paths by separating them with commas. Supports the wildcard "*".String.sourceFilterFilters
Start DateThe starting date for the displayed history range. If left blank, will default to 8 hours prior to when the component was loaded.Date.startDateBehavior
System EventsShow system events such as startup and shutdown.boolean.includeSystemEventsFilters
Table BackgroundThe background of the alarm table. See Color Selector.Color.tableBackgroundAppearance
Table FontThe font for the Alarm Journal's rows.Font.fontAppearance
Table Header Font
New in 8.1.14
The font for the table header rows.
Font.tableHeaderFontAppearance
Table Header Alignment
New in 8.1.14
The alignment for each column in the table header.
int.headerAlignmentAppearance
Touchscreen ModeControls when this input component responds if touchscreen mode is enabled.int.touchscreenModeBehavior
VisibleIf disabled, the component will be hidden.boolean.visibleCommon

Scripting

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

Event Handlers

Event handlers allow you to run a script based off specific triggers. See the full list of available event handlers on the Component Events page

Customizers