Top  | Previous | Next

Alarm Journal Table

alarming_AlarmJournalTable

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, please 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.

 

Properties

Appearance

Show Table Header

Toggles visibility of the table's header.

Scripting name

showTableHeader

Data type

boolean

Selection Color

The color of the selection border

Scripting name

selectionColor

Data type

Color

Selection Thickness

The size of the selection border

Scripting name

selectionThickness

Data type

int

Table Background

The background of the alarm table.

Scripting name

tableBackground

Data type

Color

Row Height

The height, in pixels, for each row of the table.

Scripting name

rowHeight

Data type

int

Row Styles

A dataset containing the different styles configured for different alarm states.

Scripting name

rowStyles

Data type

Dataset

Flags

bindable | expert

Notes Area Location

The location of the notes display area

Scripting name

notesAreaLocation

Data type

int

Values

1

North

3

East

5

South

7

West

-1

Hidden

Notes Area Size

The size of the notes area, in pixels.

Scripting name

notesAreaSize

Data type

int

Notes Area Border

The border surrounding the notes area.

Scripting name

notesAreaBorder

Data type

Border

Notes Area Font

The font for the notes area.

Scripting name

notesAreaFont

Data type

Font

Number Format

A number format string to control the format of the value column.

Scripting name

numberFormat

Data type

String

Date Format

A date format pattern used to format dates in the table. If blank, the default format for the locale is used.

Scripting name

dateFormat

Data type

String

Antialias

Draw with antialias on? Makes text smoother

Scripting name

antialias

Data type

boolean

Flags

expert

Behavior

Journal Name

The name of the alarm journal to query

Scripting name

journalName

Data type

String

Flags

bindable

Start Date

The starting date for the displayed history range

Scripting name

startDate

Data type

Date

Flags

bindable

End Date

The ending date for the displayed history range

Scripting name

endDate

Data type

Date

Flags

bindable

Read Timeout

The timeout, in milliseconds, for running the alarm history query.

Scripting name

readTimeout

Data type

int

Flags

expert

Is Filtered

True if the results are filtered. (Read-only)

Scripting name

isFiltered

Data type

boolean

Flags

bindable | read-only

Touchscreen Mode

Controls when this input component responds if touchscreen mode is enabled.

Scripting name

touchscreenMode

Data type

int

Flags

expert

Values

0

None

1

Single-Click

2

Double-Click

Common

Name

The name of this component.

Scripting name

name

Data type

String

Flags

bindable

Enabled

If disabled, a component cannot be used.

Scripting name

componentEnabled

Data type

boolean

Visible

If disabled, the component will be hidden.

Scripting name

visible

Data type

boolean

Flags

bindable

Border

The border surrounding this component. NOTE that the border is unaffected by rotation.

Scripting name

border

Data type

Border

Data

Selected Alarms

A dataset containing each selected alarm. (Read-only)

Scripting name

selectedAlarms

Data type

Dataset

Flags

bindable | expert

Data Quality

The data quality code for any tag bindings on this component.

Scripting name

dataQuality

Data type

int

Flags

bindable | expert

Filters

System Events

Show system events such as startup and shutdown

Scripting name

includeSystemEvents

Data type

boolean

Flags

bindable

Active Events

Show active events

Scripting name

includeActiveEvents

Data type

boolean

Flags

bindable

Cleared Events

Show cleared events

Scripting name

includeClearedEvents

Data type

boolean

Flags

bindable

Acked Events

Show acked events

Scripting name

includeAckedEvents

Data type

boolean

Flags

bindable

Source Filter

Filter alarms by alarm source path. Specify multiple paths by separating them with commas. Supports the wildcard "*".

Scripting name

sourceFilter

Data type

String

Flags

bindable

Provider Filter

Filter alarms by tag provider. Specify multiple providers by separating them with commas. A value of "." denotes the default tag provider.

Scripting name

providerFilter

Data type

String

Flags

bindable

Display Path Filter

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

Scripting name

displayPathFilter

Data type

String

Flags

bindable

Search String

Filter alarms by searching for a string in both source path and display path.

Scripting name

searchString

Data type

String

Flags

bindable

Min Priority

The minimum priority to display.

Scripting name

minimumPriority

Data type

int

Flags

bindable

Values

0

Diagnostic

1

Low

2

Medium

3

High

4

Critical

Max Priority

The maximum priority to display.

Scripting name

maximumPriority

Data type

int

Flags

bindable

Values

0

Diagnostic

1

Low

2

Medium

3

High

4

Critical

Scripting

Events

The following event sets are fired by this component. See Component Event Handlers to learn more.

•mouse
•mouseMotion
•focus
•propertyChange
•key

 

Scripting Functions

print()

 

This specialized print function will paginate the table onto multiple pages.

This function accepts keyword-style invocation.

Keyword Args

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]

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]

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]

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

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

Returns

boolean - True if the print job was successful.

Extension Functions

The alarm journal table has the following extension functions. See each function's doc string for usage details.

•createPopupMenu()
•filterAlarm()
•onDoubleClicked()