Search

User Manual

GETTING STARTED


MODULES AND PLATFORM


APPENDIX


TUTORIALS & HELPFUL TRICKS


GLOSSARY


STRATEGIC PARTNER LINKS

Sepasoft - MES Modules
Cirrus Link - MQTT Modules

RESOURCES

Inductive University
Ignition Demo Project
Knowledge Base Articles
Forum
IA Support
SDK Documentation
SDK Examples

ALL MANUAL VERSIONS

Ignition 8
Ignition 7.9
Ignition 7.8

Deprecated Pages

Skip to end of metadata
Go to start of metadata


General

Component Palette Icon:



IULocgo


Alarm Journal Table

Description

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 time now(). 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.

To change the columns that are displayed, the order of the columns, and/or the column width, put the Designer into preview mode. Then right-click on the table header to show/hide columns. Click and drag to re-order columns, and drag the margins of the columns to resize their width. No further action is necessary - the column configuration will remain in place after the window is saved.

Additional examples of configuring the Alarm Journal Table can be found on the Alarm Journal Table Component page.

Properties
NameDescriptionProperty TypeScriptingCategory
Acked EventsShow acked events.boolean.includeAckedEventsFilters
Active EventsShow active events.boolean.includeActiveEventsFilters
Border

The border surrounding this component. Options are: No border, Etched (Lowered), Etched (Raised), Bevel (Lowered), Bevel (Raised), Bevel (Double), Button Border, Field Border, Line Border, and Other Border.

The border is unaffected by rotation.

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
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
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
Touchscreen ModeControls when this input component responds if touchscreen mode is enabled.int.touchscreenModeBehavior
VisibleIf disabled, the component will be hidden.boolean.visibleCommon
Deprecated Properties
Data QualityThe data quality code for any Tag bindings on this component.int.dataQualityDeprecated
Scripting
Scripting Functions
 .print(fitWidth, headerFormat, footerFormat, showDialog, landscape)
  • Description

This specialized print function will paginate the table onto multiple pages.This function accepts keyword-style invocation.

  • Keyword Args

boolean fitWidth - If true, the table's width will be stretched to fit across one page's width. Rows will still paginate normally. If false, the table will paginate columns onto extra pages. (default = true) [optional]

String headerFormat - A string to use as the table's page header. The substring "{0}" will be replaced with the current page number. (default = None) [optional]

String footerFormat - A string to use as the table's page footer. The substring "{0}" will be replaced with the current page number. (default = "Page {0}") [optional]

boolean showDialog - Whether or not the print dialog should be shown to the user. Default is true. [optional]

boolean landscape - Used to specify portrait (0) or landscape (1) mode. Default is portrait (0). [optional]

  • Return

boolean - True if the print job was successful.

  • Scope

Client

 .getAlarms()
  • Description

Returns a dataset of the alarms currently displayed in the Alarm Journal Table component. The columns will be: EventId, Source, DisplayPath, EventTime, State, Priority and IsSystemEvent

  • Keyword Args

None

  • Return

Dataset - A dataset of alarms.

  • Scope

Client

Extension Functions
 createPopupMenu
  • Description

Returns a popup menu that will be displayed when the user triggers a popup menu (right click) in the table. Use system.gui.createPopupMenu() to create the popup menu.

  • Parameters

Component self - A reference to the component that is invoking this function.

List selectedAlarmEvents - The alarm events selected on the Alarm Status Table. For an individual alarmEvent, call alarmEvent.get('propertyName') to inspect. Common properties: 'name', 'source', 'priority'.

  • Return

JPopupMenu - A popup menu that was created with system.gui.createPopupMenu()

  • Scope

Client

 filterAlarm
  • Description

Called for each event loaded into the alarm status table. Return false to hide this event from the table. This code is executed in a background thread.

  • Parameters

Component self - A reference to the component that is invoking this function.

Alarm Event alarmEvent - The alarm event itself. Call alarmEvent.get('propertyName') to inspect. Common properties: 'name', 'source', 'priority'.

  • Return

Boolean

  • Scope

Client

 onDoubleClicked
  •  Description

Called when an alarm is double-clicked on to provide custom functionality. Does not return a value.

  • Parameters

Component self - A reference to the component that is invoking this function.

Alarm Event alarmEvent - The alarm event itself. Call alarmEvent.get('propertyName') to inspect. Common properties: 'name', 'source', 'priority'.

  • Return

Nothing

  • Scope

Client

Event Handlers
 focus
 focusGained

This event occurs when a component that can receive input, such as a text box, receives the input focus. This usually occurs when a user clicks on the component or tabs over to it.

.source

The component that fired this event.

.oppositeComponent

The other component involved in this focus change. That is, the component that lost focus in order for this one to gain it, or vise versa.       

 focusLost

This event occurs when a component that had the input focus lost it to another component.

.sourceThe component that fired this event
.oppositeComponentThe other component involved in this focus change. That is, the component that lost focus in order for this one to gain it, or vise versa.       
 key
 keyPressed

An integer that indicates whether the state was changed to "Selected" (on) or "Deselected" (off). Compare this to the event object's constants to determine what the new state is.

.source

The component that fired this event.       

.keyCode

The key code for this event. Used with the keyPressed and keyReleased events. See below for the key code constants.       

.keyCharThe character that was typed. Used with the keyTyped event.       
.keyLocation

Returns the location of the key that originated this key event. Some keys occur more than once on a keyboard, e.g. the left and right shift keys. Additionally, some keys occur on the numeric keypad. This provides a way of distinguishing such keys. See the KEY_LOCATION constants, the keyTyped event always has a location of KEY_LOCATION_UNKNOWN.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.    

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.  

 keyReleased

Fires when a key is released and the source component has the input focus. Works for all characters, including non-printable ones, such as SHIFT and F3.

.source

The component that fired this event.       

.keyCode

The key code for this event. Used with the keyPressed and keyReleased events. See below for the key code constants.       

.keyCharThe character that was typed. Used with the keyTyped event.       
.keyLocation

Returns the location of the key that originated this key event. Some keys occur more than once on a keyboard, e.g. the left and right shift keys. Additionally, some keys occur on the numeric keypad. This provides a way of distinguishing such keys. See the KEY_LOCATION constants in the documentation, the keyTyped event always has a location of KEY_LOCATION_UNKNOWN.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.    

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.  

 keyTyped

Fires when a key is pressed and then released when source component has the input focus. Only works for characters that can be printed on the screen.

.source

The component that fired this event.       

.keyCode

The key code for this event. Used with the keyPressed and keyReleased events. See below for the key code constants.       

.keyCharThe character that was typed. Used with the keyTyped event.       
.keyLocation

Returns the location of the key that originated this key event. Some keys occur more than once on a keyboard, e.g. the left and right shift keys. Additionally, some keys occur on the numeric keypad. This provides a way of distinguishing such keys. See the KEY_LOCATION constants in the documentation, the keyTyped event always has a location of KEY_LOCATION_UNKNOWN.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.    

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.  

 mouse
 mouseClicked

This event signifies a mouse click on the source component. A mouse click the combination of a mouse press and a mouse release, both of which must have occurred over the source component. Note that this event fires after the pressed and released events have fired.

.source

The component that fired this event.       

.button

The code for the button that caused this event to fire.       

.clickCount

The number of mouse clicks associated with this event.       

.x

The x-coordinate (with respect to the source component) of this mouse event.       

.y

The y-coordinate (with respect to the source component) of this mouse event.       

.popupTrigger

Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.       

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.       

 mouseEntered

This event fires when the mouse enters the space over the source component.

.source

The component that fired this event.       

.button

The code for the button that caused this event to fire.       

.clickCount

The number of mouse clicks associated with this event.       

.x

The x-coordinate (with respect to the source component) of this mouse event.       

.y

The y-coordinate (with respect to the source component) of this mouse event.       

.popupTrigger

Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.       

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.       

 mouseExited

  This event fires when the mouse leaves the space over the source component.

.source

The component that fired this event.       

.button

The code for the button that caused this event to fire.       

.clickCount

The number of mouse clicks associated with this event.       

.x

The x-coordinate (with respect to the source component) of this mouse event.       

.y

The y-coordinate (with respect to the source component) of this mouse event.       

.popupTrigger

Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.       

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.       

 mousePressed

  This event fires when a mouse button is pressed down on the source component.

.source

The component that fired this event.       

.button

The code for the button that caused this event to fire.       

.clickCount

The number of mouse clicks associated with this event.       

.x

The x-coordinate (with respect to the source component) of this mouse event.       

.y

The y-coordinate (with respect to the source component) of this mouse event.       

.popupTrigger

Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.       

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.       

 mouseReleased

This event fires when a mouse button is released, if that mouse button's press happened over this component.

.source

The component that fired this event.       

.button

The code for the button that caused this event to fire.       

.clickCount

The number of mouse clicks associated with this event.       

.x

The x-coordinate (with respect to the source component) of this mouse event.       

.y

The y-coordinate (with respect to the source component) of this mouse event.       

.popupTrigger

Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.       

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.       

 mouseMotion
 mouseDragged

Fires when the mouse moves over a component after a button has been pushed.

.source

The component that fired this event.       

.button

The code for the button that caused this event to fire.       

.clickCount

The number of mouse clicks associated with this event.       

.x

The x-coordinate (with respect to the source component) of this mouse event.       

.y

The y-coordinate (with respect to the source component) of this mouse event.       

.popupTrigger

Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.       

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.       

 mouseMoved

Fires when the mouse moves over a component, but no buttons are pushed.

 

.source

The component that fired this event.       

.button

The code for the button that caused this event to fire.       

.clickCount

The number of mouse clicks associated with this event.       

.x

The x-coordinate (with respect to the source component) of this mouse event.       

.y

The y-coordinate (with respect to the source component) of this mouse event.       

.popupTrigger

Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.       

.altDown

True (1) if the Alt key was held down during this event, false (0) otherwise.       

.controlDown

True (1) if the Control key was held down during this event, false (0) otherwise.       

.shiftDown

True (1) if the Shift key was held down during this event, false (0) otherwise.       

 propertyChange
 propertyChange

Fires whenever a bindable property of the source component changes. This works for standard and custom (dynamic) properties.

.sourceThe component that fired this event.  
.newValueThe new value that this property changed to.
.oldValueThe value that this property was before it changed.
.propertyName

The name of the property that changed.

Remember to always filter out these events for the property that you are looking for! Components often have many properties that change.

Customizers

The Alarm Row Styles Customizer manages the way the Alarm Journal renders each alarm.

Examples

There are no examples associated with this component.

  • No labels