Table

The alert summary table provides an easy way to display current and unacknowledged alerts, and to provide acknowledgement functionality for your alerts.

Alert Styles

Active and Unacked Foreground 1

Scripting name	activeAndUnackedForeground1
Data type	Color

Active and Unacked Background 1

Scripting name	activeAndUnackedBackground1
Data type	Color

Active and Unacked Foreground 2

Scripting name	activeAndUnackedForeground2
Data type	Color

Active and Unacked Background 2

Scripting name	activeAndUnackedBackground2
Data type	Color

Active and Unacked Blink?

Scripting name	activeAndUnackedBlink
Data type	boolean

Active and Unacked Font

Scripting name	activeAndUnackedFont
Data type	Font

Active and Acked Foreground 1

Scripting name	activeAndAckedForeground1
Data type	Color

Active and Acked Background 1

Scripting name	activeAndAckedBackground1
Data type	Color

Active and Acked Foreground 2

Scripting name	activeAndAckedForeground2
Data type	Color

Active and Acked Background 2

Scripting name	activeAndAckedBackground2
Data type	Color

Active and Acked Blink?

Scripting name	activeAndAckedBlink
Data type	boolean

Active and Acked Font

Scripting name	activeAndAckedFont
Data type	Font

Clear and Unacked Foreground 1

Scripting name	clearAndUnackedForeground1
Data type	Color

Clear and Unacked Background 1

Scripting name	clearAndUnackedBackground1
Data type	Color

Clear and Unacked Foreground 2

Scripting name	clearAndUnackedForeground2
Data type	Color

Clear and Unacked Background 2

Scripting name	clearAndUnackedBackground2
Data type	Color

Clear and Unacked Blink?

Scripting name	clearAndUnackedBlink
Data type	boolean

Clear and Unacked Font

Scripting name	clearAndUnackedFont
Data type	Font

Clear and Acked Foreground 1

Scripting name	clearAndAckedForeground1
Data type	Color

Clear and Acked Background 1

Scripting name	clearAndAckedBackground1
Data type	Color

Clear and Acked Foreground 2

Scripting name	clearAndAckedForeground2
Data type	Color

Clear and Acked Background 2

Scripting name	clearAndAckedBackground2
Data type	Color

Clear and Acked Blink?

Scripting name	clearAndAckedBlink
Data type	boolean

Clear and Acked Font

Scripting name	clearAndAckedFont
Data type	Font

Appearance

Header Visible?

Should the alert table have a header row?

Scripting name	headerVisible
Data type	boolean

Table Background

The background color for the empty space in the table

Scripting name	tableBackground
Data type	Color

Table Border

The border around the table itself, not including the controls.

Scripting name	scrollPaneBorder
Data type	Border

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

Row Height

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

Scripting name	rowHeight
Data type	int

Blink On-Time

The amount of time (in millis) to display the "blink-on" state.

Scripting name	blinkOnTime
Data type	int

Blink Off-Time

The amount of time (in millis) to display the "blink-off" state.

Scripting name	blinkOffTime
Data type	int

Date Format

A date format pattern used to format dates in the table.

Scripting name	dateFormat
Data type	String

Number Format

A number format pattern used to format alert values.

Scripting name	numberFormat
Data type	String

Ack Buttons Location

The location of the acknowledgement button panel

Scripting name

ackButtonLocation

Data type

int

Values

1	North
3	East
5	South
7	West
-1	Hidden

Ack Button Text

The text for the acknowledgement button.

Scripting name	ackText
Data type	String

Ack All Button Text

The text for the acknowledge-all button.

Scripting name	ackAllText
Data type	String

Ack Button Font

The font for the acknowledgement buttons

Scripting name	ackButtonFont
Data type	Font

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

Behavior

Refresh Rate

The rate at which this table will poll for new alerts.

Scripting name	refreshRate
Data type	long

Flatten Alerts

If true, only one alert state will be shown for any alert. The most recent and severe alert state will be chosen.

Scripting name	flatten
Data type	boolean
Flags	expert

Auto-Resize Mode

Determines how the table resizes the columns

Scripting name

autoResizeMode

Data type

int

Values

4	All Columns
3	Last Column
1	Next Column
0	Off
2	Subsequent Columns

Columns

Column Timestamp Visible?

Scripting name	showTimestamp
Data type	boolean

Column Value Visible?

Scripting name	showValue
Data type	boolean

Column System Visible?

Scripting name	showSystem
Data type	boolean

Column ItemPath Visible?

Scripting name	showItemPath
Data type	boolean

Column Path Visible?

Scripting name	showPath
Data type	boolean

Column State Visible?

Scripting name	showState
Data type	boolean

Column Severity Visible?

Scripting name	showSeverity
Data type	boolean

Column Cleared Visible?

Scripting name	showCleared
Data type	boolean

Column Clear Value Visible?

Scripting name	showClearValue
Data type	boolean

Column Acked Visible?

Scripting name	showAcked
Data type	boolean

Column Acked By Visible?

Scripting name	showAckedBy
Data type	boolean

Column Timestamp Width

Scripting name	columnTimestampWidth
Data type	int

Column Value Width

Scripting name	columnValueWidth
Data type	int

Column System Width

Scripting name	columnSystemWidth
Data type	int

Column ItemPath Width

Scripting name	columnItemPathWidth
Data type	int

Column Path Width

Scripting name	columnPathWidth
Data type	int

Column State Width

Scripting name	columnStateWidth
Data type	int

Column Severity Width

Scripting name	columnSeverityWidth
Data type	int

Column Cleared Width

Scripting name	columnClearedWidth
Data type	int

Column Clear Value Width

Scripting name	columnClearValueWidth
Data type	int

Column Acked Width

Scripting name	columnAckedWidth
Data type	int

Column Acked By Width

Scripting name	columnAckedByWidth
Data type	int

Column Timestamp Header

Scripting name	columnTimestampText
Data type	String

Column Value Header

Scripting name	columnValueText
Data type	String

Column System Header

Scripting name	columnSystemText
Data type	String

Column ItemPath Header

Scripting name	columnItemPathText
Data type	String

Column Path Header

Scripting name	columnPathText
Data type	String

Column State Header

Scripting name	columnStateText
Data type	String

Column Severity Header

Scripting name	columnSeverityText
Data type	String

Column Cleared Header

Scripting name	columnClearedText
Data type	String

Column Clear Value Header

Scripting name	columnClearValueText
Data type	String

Column Acked Header

Scripting name	columnAckedText
Data type	String

Column Acked By Header

Scripting name	columnAckedByText
Data type	String

Column Timestamp Position

Scripting name	columnTimestampPosition
Data type	int
Flags	expert

Column Value Position

Scripting name	columnValuePosition
Data type	int
Flags	expert

Column System Position

Scripting name	columnSystemPosition
Data type	int
Flags	expert

Column ItemPath Position

Scripting name	columnItemPathPosition
Data type	int
Flags	expert

Column Path Position

Scripting name	columnPathPosition
Data type	int
Flags	expert

Column State Position

Scripting name	columnStatePosition
Data type	int
Flags	expert

Column Severity Position

Scripting name	columnSeverityPosition
Data type	int
Flags	expert

Column Cleared Position

Scripting name	columnClearedPosition
Data type	int
Flags	expert

Column Clear Value Position

Scripting name	columnClearValuePosition
Data type	int
Flags	expert

Column Acked Position

Scripting name	columnAckedPosition
Data type	int
Flags	expert

Column Acked By Position

Scripting name	columnAckedByPosition
Data type	int
Flags	expert

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

Border

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

Scripting name	border
Data type	Border

Data

Selected Row

The currently selected row

Scripting name	selectedRow
Data type	int
Flags	bindable \| expert

Alerts

A dataset holding the alerts that the table is currently displaying. Read-only.

Scripting name	alerts
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 Filter

Filter alerts to a specific system. Use * and ? to match any characters or one character, respectively.

Scripting name	systemFilter
Data type	String

Item Path Filter

Filter alerts by item path. Use * and ? to match any characters or one character, respectively.

Scripting name	itemPathFilter
Data type	String
Flags	expert

Path Filter

Filter alerts by display path, or item path if no display path is set. Use * and ? to match any characters or one character, respectively.

Scripting name	pathFilter
Data type	String

Min Severity

The minimum severity to display

Scripting name

severityFilter

Data type

int

Values

0	Low
1	Medium Low
2	Medium
3	Medium High
4	High

Show Active and Unacked

If true, alerts that are active and unacknowledged will be displayed.

Scripting name	activeAndUnacked
Data type	boolean

Show Active and Acked

If true, alerts that are active and acknowledged will be displayed.

Scripting name	activeAndAcked
Data type	boolean

Show Clear and Unacked

If true, alerts that are cleared and unacknowledged will be displayed.

Scripting name	clearAndUnacked
Data type	boolean

Show Clear and Acked

If true, alerts that are cleared and acknowledged will be displayed.

Scripting name	clearAndAcked
Data type	boolean

Sort Order

Sort by Active

Sort priority for sorting by the alert's active state.

Scripting name	sortByActive
Data type	int

Sort by Acked

Sort priority for sorting by the alert's acknowledgement state.

Scripting name	sortByAcked
Data type	int

Sort by Active Time

Sort priority for sorting by the alert's active timestamp.

Scripting name	sortByActiveTime
Data type	int

Sort by Severity

Sort priority for sorting by the alert's severity.

Scripting name	sortBySeverity
Data type	int

Sort by System

Sort priority for sorting by the alert's originating system.

Scripting name	sortBySystem
Data type	int

Sort by Path

Sort priority for sorting by the alert's display path.

Scripting name	sortByPath
Data type	int

Sort by State Name

Sort priority for sorting by the alert's state name.

Scripting name	sortByStateName
Data type	int

Sort by Clear Time

Sort priority for sorting by the alert's cleared timestamp.

Scripting name	sortByClearTime
Data type	int

Sort by Acked Time

Sort priority for sorting by the alert's acknowledgement timestamp.

Scripting name	sortByAckedTime
Data type	int

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