Top  | Previous | Next

Alarm Status Table

alarming_AlarmStatusTable

Description

The alarm status table displays the current state of the alarm system. It can be configured to show active, unacknowledged, cleared, and acknowledged alarms. By default it shows all non-cleared/non-ack'ed alarms.

 

Acknowledgement is handled by selecting (checking) alarms and pressing the "Acknowledge" button. If any of the selected alarms require acknowledge notes, then a small text area will be presented in which the operator must add notes to the acknowledgement.

 

Shelving is supported by pressing the "Shelve" button when an alarm is selected. This will temporarily remove the alarm from the entire alarm system (not just the local client). When the time is up, if the alarm is still active, it will pop back into the alarm system. The times shown to the user are customizable by editing the values inside the "Shelving Times" dataset property. The alarms that have been shelved can be un-shelved by pushing the shelf management button in the lower right-hand side of the component.

 

If a more simplified alarm status table is needed, many of the features of the status table can be removed, for example, the header, footer, and multi-selection checkboxes. If a very short alarm status table is needed, turn on the "Marquee Mode" option, which will automatically scroll through any alarms if there is not enough vertical space to show all of them at once.

 

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.

 

For alarms that originate from tags that have tag history turned on, users can see an automatic ad-hoc chart for the value of the source tag by pressing the chart button.

 

Properties

Appearance

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

Table Background

The background of the alarm table.

Scripting name

tableBackground

Data type

Color

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

Flash Interval

The time interval to use for flashing row styles.

Scripting name

flashInterval

Data type

int

Show Table Header

Toggles visibility of the table's header.

Scripting name

showTableHeader

Data type

boolean

Show Header Popup

Toggles the table header's built-in column selection popup menu.

Scripting name

showTableHeaderPopup

Data type

boolean

Table Header Font

The font for the table header.

Scripting name

tableHeaderFont

Data type

Font

Row Height

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

Scripting name

rowHeight

Data type

int

Show Footer

Show a footer with acknowledge and shelf functions below the alarms.

Scripting name

showFooterPanel

Data type

boolean

Show Ack Button

Show the acknowledge button on the footer panel.

Scripting name

showAck

Data type

boolean

Show Shelve Button

Show the shelve button on the footer panel.

Scripting name

showShelve

Data type

boolean

Show Details Button

Show the view details button on the footer panel.

Scripting name

showDetails

Data type

boolean

Show Chart Button

Show the chart button on the footer panel.

Scripting name

showChart

Data type

boolean

Show Manage Shelf Button

Show the manage shelf button on the footer panel.

Scripting name

showManageShelf

Data type

boolean

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

Antialias

Draw with antialias on? Makes text smoother

Scripting name

antialias

Data type

boolean

Flags

expert

Behavior

Refresh Rate

The rate at which this table will poll changes to the alarm status.

Scripting name

refreshRate

Data type

long

Flags

bindable

Sort Order

The default sort order for alarms in the status table.

Scripting name

sortOrder

Data type

int

Values

0

State_Time

1

State_Priority_Time

2

Priority_State_Time

3

Time

Sort Oldest First

Sort times by oldest first.

Scripting name

sortOldestFirst

Data type

boolean

Multi Select

Allow multi select. Will show/hide the checkbox column.

Scripting name

multiSelect

Data type

boolean

Marquee Mode

Turn the table into a scrolling marquee

Scripting name

marqueeMode

Data type

boolean

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

Scroll Delay

The time (in mSec) to wait between performing each step in a scroll

Scripting name

scrollDelay

Data type

int

Stay Delay

The time (in mSec) to wait between scrolls

Scripting name

stayDelay

Data type

int

Chart Resolution

The resolution for the ad-hoc tag historian chart.

Scripting name

chartResolution

Data type

int

Journal Name

The name of the alarm journal to query for the chart's annotations. Leave this blank to automatically pick the journal if there is only one.

Scripting name

alarmJournalName

Data type

String

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

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

Shelving Times

This dataset holds the times that are suggested when shelving an alarm. Allowable units are "second", "minute", or "hour".

Scripting name

shelvingTimes

Data type

Dataset

Data Quality

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

Scripting name

dataQuality

Data type

int

Flags

bindable | expert

Filters

Min Priority

The minimum priority alarm to be displayed by this table.

Scripting name

minPriority

Data type

int

Values

0

Diagnostic

1

Low

2

Medium

3

High

4

Critical

Show Active and Unacked

Show alarms that are active and unacknowledged.

Scripting name

activeAndUnacked

Data type

boolean

Show Active and Acked

Show alarms that are active and acknowledged.

Scripting name

activeAndAcked

Data type

boolean

Show Clear and Unacked

Show alarms that are cleared and unacknowledged.

Scripting name

clearAndUnacked

Data type

boolean

Show Clear and Acked

Show alarms that are cleared and acknowledged.

Scripting name

clearAndAcked

Data type

boolean

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

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

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

Scripting

Events

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

•propertyChange

 

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 status table has the following extension functions. See each function's doc string for usage details.

•createPopupMenu()
•filterAlarm()
•isAcknowledgeEnabled()
•isShelveEnabled()
•onDoubleClicked()