Alarm Analysis Properties

Use the following tabs to configure the Alarm Analysis object. Click on each tab name for property descriptions.

Alarm Analysis: General Tab

The Alarm Analysis object appears as a grid. You can change the grid's appearance with the following properties.

Alarm Analysis Object Properties: General Tab 

Property

Description

Values

Name

Specifies a name for the Alarm Analysis object that will identify the object when its parameters are linked to another object.

Any text or numbers.

Display Title
check box

Indicates whether to show the Alarm Analysis object's title.

Selected – shows the title.

Cleared – hides the title. (Default)

Display Title

Specifies the Alarm Analysis object's title. This field is available only when the Display Title check box is selected.

Any ASCII printable character.

Justification

Specifies the location of the title in the Alarm Analysis object. This field is available only when the Display Title check box is selected.

  • Top - Left Justified

  • Top - Center Justified

  • Top - Right Justified

  • Bottom - Left Justified

  • Bottom - Center Justified

  • Bottom - Right Justified

Title Text
button

Specifies the color of the Alarm Analysis object's title text.

Select a color from the color palette.

Modifiable

Indicates whether users can change the Alarm Analysis object's configuration from the run-time environment.

Selected – users can change the configuration.

Cleared – users cannot change the configuration. (Default)

Autosize
Column Widths

Indicates whether to resize each column automatically based on the data received.

Selected – column widths autosize. (Default)

Cleared – column widths are static.

Show Grid
Lines

Indicates whether to show the Alarm Analysis object's lines.

Selected – grid lines are visible. (Default)

Cleared – grid lines are hidden.

Autosize to fit
Number of Rows

Indicates whether to limit the number of rows displayed. The valid range is 1 to 1000.

Selected – the number of rows shown in the grid is limited to the number entered. If more rows are returned than is specified, the user will have to use the scroll bars or pagination to see them.

Cleared – the number of rows shown in the grid depends on the data and the default size of the grid object. (Default)

Enable Auto
Refresh

Indicates whether to enable an automatic refresh of the data every 1 or more seconds.

Selected – data is refreshed automatically every 1 or more seconds (as you specify).

Cleared – data is not refreshed when the display is opened. (Default)

Show Column
Headers

Indicates whether to show the headings of each column.

Selected – shows the headers. (Default)

Cleared – hides the headers.

Show Row
Numbers

Indicates whether to number the rows.

Selected – shows the row numbers.

Cleared – hides the row numbers. (Default)

Column Header
Click Sorting

Allows the user to click the column header to sort the data by that column.

Selected – during run-time, the user can click a column header to sort the data by that column.

Cleared – the user cannot sort the data by clicking on a column header. (Default)

Show Status
Bar

Indicates whether to show the status bar that displays the number of rows received and the Refresh button.

Selected – status bar is shown. (Default)

Cleared – status bar is hidden.

Selection Mode

Sets the default selection mode; that is, when the user can select a row, cell, or column on the grid.

Row Selection

Column Selection

Cell Selection

Display Mode
option buttons

Specifies how to navigate through the Alarm Analysis object at run-time.

Scrolling – navigate using the Alarm Analysis object's scroll bar.

Pagination – display pagination controls.   (Default)

These controls include:

  • Previous and Next page buttons to browse forward and backward through the grid one page at a time.

  • First and Last buttons to quickly move to the start or end of the grid.

  • Page Number field to jump to a specific page of data in the grid.

Column/Row
Header Color
buttons

Specifies the color settings for the Alarm Analysis object's headers.

Text – the color of the text in the headers.

Background – the background color of the row and column headers.

Select a color from the color palette.

Alarm Analysis: Data Tab

Use the Data Tab to set the data source for the Alarm Analysis object.

Alarm Analysis Object Properties: Data Tab 

Property

Description

Values

Data Source

Specifies the data source you want to use to populate the Alarm Analysis object.

Configure Data Source button - displays the Data Source Browser.

Alarm Analysis: Sort Tab

Use the Sort tab to specify how the data in the Alarm Analysis object will be sorted.

Alarm Analysis Object Properties: Sort Tab 

Property

Description

Values

Available Columns

Provides a list of the columns that are available for sorting.

N/A

Sort Keys

Provides a list of the columns that are used for sorting. The first column is the primary sort key, the second column is the secondary sort key, and so forth.

Empty by default (until you add columns). Shows the sort order of each column (Ascending or Descending).

Add/Remove buttons

Allows you to add columns from the Available Columns list to the Sort Keys list or to remove columns from the Sort Keys list. Select the column you want to move and click the Add or Remove button.

N/A

Add All/
Remove All
buttons

Allows you to add all columns from the Available Columns list to the Sort Keys list, or to remove all columns from the Sort Keys list.

N/A

Up/Down buttons

Allows you to change the column order in the Sort Keys list. For example, if you have two columns and you want the second column to be used as the primary sort key, select the second column and click the Up button.

N/A

Toggle Sort
Order button

Allows you to change the sort order of one or more columns in the Sort Keys list to Ascending or Descending.

Ascending

Descending

Alarm Analysis: Filter Tab

Use the Filter tab to specify filters for the columns. Filters allow you to target specific alarms data, or to configure parameters for interaction with other objects.

Alarm Analysis Object Properties: Filter Tab 

Property

Description

Values

Columns

Displays the columns you have selected from the alarms data source.

Alarms columns

Add Filter Condition

Allows you to add a filter condition. The filter condition you add will appear at the end of the Display Alarms Where list.

A dialog box appears that allows you to enter the operator and parameter or operator and value. The dialog box is specific to the type of column you select.

Insert Filter Condition

Allows you to insert a filter condition into the Display Alarms Where list. Click the filter condition that is below the position where you want to insert the new filter condition.

A dialog box appears that allows you to enter the operator and parameter or operator and value. The dialog box is specific to the type of column you select.

Edit Default Parameters

Allows you to define default parameter values.

The Edit Parameter Defaults dialog box appears that allows you to enter default values for any of the parameters.

Display Alarms Where

Displays filter conditions and allows you to modify, remove, or add/change operators.

N/A

Modify

Allows you to make changes to the selected filter condition's operator/value/parameter. Select the condition in the Display Alarms Where list and click the Modify button.

A dialog box appears that allows you to make changes to the filter condition. The dialog box is specific to the type of column the filter has been set for.

Remove

Allows you to remove a filter condition. Select the condition in the Display Alarms Where list and click the Remove button.

N/A

Operators

Allows you to add, change, or remove operators that combine multiple filter conditions. Click the filter condition in the Display Alarms Where list and click the button for the operator you want to add, change, or remove

AND – specifies an AND condition (i.e., display alarms data where both conditions exist).

OR – specifies an OR condition (i.e., display alarms data where one condition or the other condition exists).

NOT – specifies a NOT condition (i.e., display alarms data where a condition does not exist).

( – opening parenthesis. Use for grouping conditions.

) – closing parenthesis. Use for grouping conditions.

X( – remove opening parenthesis.

X) – remove closing parenthesis.

Load

Allows you to load a pre-configured filter.

Load Alarm Analysis Filter Condition dialog box.

Save

Allows you to save changes made to a filter.

Save Alarm Analysis Filter Condition dialog box.

Save As

Allows you to save a filter with a new name.

Save Alarm Analysis Filter Condition dialog box.

Alarm Analysis: Color Tab

Use the Color tab to load an Alarm Analysis threshold table or to make changes to a threshold table. The threshold table for the Alarm Analysis object allows you to define colors for specific alarm statuses and alarm priorities.

Alarm Analysis Object Properties: Color Tab 

Property

Description

Values

Enable Threshold

Specifies whether to apply the threshold colors to the values/cells in the Alarm Analysis grid.

Selected – Enables the threshold.

Cleared – Disables the threshold.

Alarm Status:
Color

Specifies the color that is applied to the text of the entire row of data that corresponds to the alarm status the color is set for. Click the ellipsis button to change the color.

Select a color from the color palette.

Alarm Priority:
Color

Specifies the color that is applied to the background (not text) of the entire row of data that corresponds to the alarm priority the color is set for. Click the ellipsis button to change the color.

Select a color from the color palette.

Load

Allows you to load a pre-configured Alarm Analysis threshold table.

Load Threshold Table dialog box.

Save

Allows you to save changes made to an Alarm Analysis threshold table.

Save Threshold Table dialog box.

Save As

Allows you to save changes made to an Alarm Analysis threshold table as a new threshold table.

Save Threshold Table dialog box.

Reset

Loads the default Alarm Analysis threshold table. Changes you have made will be lost.

NOTE: The default Alarm Analysis threshold table is set on the Component Preferences dialog box/Alarm Analysis tab.

N/A

Alarm Analysis: Printing Tab

Use the Printing tab to set expansion options that will be applied when the display is printed.

Alarm Analysis Object Properties: Printing Tab 

Property

Description

Values

No Expansions

Indicates that the grid will print as it appears in the display. Any hidden columns or rows will not be printed.

N/A

Vertical Expansion
Only

Indicates that the grid width will print as it appears in the display, but the entire length of the grid will print on multiple pages.

N/A

Vertical and
Horizontal
Expansion

Indicates that the entire grid will be printed; that is, all the data retrieved is printed (both columns and rows).

N/A

Fit to

Allows you to specify the number of pages that the grid's width will span. The grid will be scaled accordingly.

Valid values - 1 to 10.