The DISPLAY STRING displays a string in a monitor picture.

Format

DISPLAY STRING expression

Description

The DISPLAY STRING command displays the specified expression as an alphanumeric in a monitor picture. It can be used within a monitor file or issued at the RTR prompt when interactively defining a monitor picture for use in a subsequent MONITOR command.

Note that the introduction of the /SEPARATE, /TOTALIZE and /AVERAGE qualifiers has superseded the qualifiers /FACILITY, /LINK, /PARTITION, /NODE and /PROCESS. These superseded qualifiers are no longer described here, however they are still supported.

Parameters

expression

The string you want to display; enclose it in quotation marks. Expression can be the name of a single RTR data item.

Qualifiers

/AVERAGE=(keyword,...)

/NOAVERAGE

Specifies that the items being monitored relating to keyword are displayed as an average. This allows a number of items to be averaged in one qualifier.

The keyword can be one of the following:

Keyword	Meaning
NODE	Node data items
LINK	Link data items
FACILITY	Facility data items
PROCESS	Process data items
PARTITION	Partition data items
FE_TRANSACTION	Frontend transaction data items
TR_TRANSACTION	Router transaction data items
BE_TRANSACTION	Backend transaction data items

/BELL[=Boolean-expression]

/NOBELL (D)

Sends a bell character to the terminal if Boolean-expression evaluates to True (non-zero).

/BLANK[=Boolean-expression]

/NOBLANK (D)

Specifies that the displayed value is replaced by blanks if Boolean-expression evaluates to True (non-zero).

/BLINK[=Boolean-expression]

/NOBLINK (D)

Specifies that the displayed value blinks if Boolean-expression evaluates to True (non-zero).

/BOLD[=Boolean-expression]

/NOBOLD (D)

Specifies that the item is displayed in high intensity if Boolean-expression evaluates to True (non-zero).

/COLSPAN=n

/COLSPAN=1 (D)

Specifies the number of columns the item is to span in the HTML table where it is displayed. The default is one column.

/DESCRIPTION="text-string"

Provides a descriptive text for the item being displayed. Column headers are often cryptic as little room is available. The browser will display the descriptive text in a popup window (currently, Internet Explorer only).

/DISPLAY

Specifies that text formatting is to be suppressed if the /NOTEXT qualifer is chosen, so that HTML output is easier to read. Use the /NOHTML qualifier if you only want text as output. By default, items are displayed in both text and HTML views.

/HEADER

/NOHEADER (D)

Indicates the item is part of a table header. This qualifier should be attached to the first item of a new row.

/JUSTIFY=keyword

/JUSTIFY=LEFT (D)

Specifies whether justification is left, right or centered in the available width. (The keyword may be LEFT, RIGHT or CENTERED.) The /WIDTH qualifier must be greater than zero for /JUSTIFY to operate. If the available width is smaller than the string, truncation will occur.

/LABEL=text

/NOLABEL (D)

Specifies the text used to label the value being displayed. Symbols are substituted at display time. (See Section A.2, Substitution Symbols).

/PARAGRAPH

Causes a display item to be formatted as the first item of a new paragraph in the HTML output. This qualifier is effective only while in text mode, after the /NOTABLE qualifier has been used.

/REVERSE[=Boolean-expression]

/NOREVERSE (D)

Specifies that the item is displayed with the foreground and background visual attributes swapped if Boolean-expression evaluates to True (non-zero).

/ROWS[=nr-rows]

/ROWS=1 (D)

Specifies how many rows are used to display the item. This is only meaningful if /SEPARATE is also specified. The default number of rows is one.

/SELECT[=Boolean-expression]

/NOSELECT (D)

Displays the item if Boolean-expression evaluates to True (non-zero).

/SEPARATE=(keyword,...)

/NOSEPARATE

Specifies that the items being monitored relating to keyword are separated from each other and displayed as a list. This allows a number of items to be separated in one qualifier.

The keyword can be one of the following:

Keyword	Meaning
NODE	Node data items
LINK	Link data items
FACILITY	Facility data items
PROCESS	Process data items
PARTITION	Partition data items
FE_TRANSACTION	Frontend transaction data items
TR_TRANSACTION	Router transaction data items
BE_TRANSACTION	Backend transaction data items

/[NO]TABLE

Indicates the start of a new table in the monitor output. This qualifier should be attached to the first item of a new row. Specifying /NOTABLE causes any current table to be closed and a new text section to be started in the HTML output.

/TOTALIZE=(keyword,...)

/NOTOTALIZE

Specifies that the items being monitored relating to keyword are added together and displayed as a total.

The keyword can be any of the following:

Keyword	Meaning
NODE	Node data items
LINK	Link data items
FACILITY	Facility data items
PROCESS	Process data items
PARTITION	Partition data items
FE_TRANSACTION	Frontend transaction data items
TR_TRANSACTION	Router transaction data items
BE_TRANSACTION	Backend transaction data items

/UNDERLINE[=Boolean-expression]

/NOUNDERLINE (D)

Specifies that the displayed value is underlined if Boolean-expression evaluates to True (non-zero).

/WIDTH[=field-width]

/WIDTH=0 (D)

Specifies the width (in number of characters) to display the string. If /WIDTH=0 is specified (the default), the string is displayed as entered. If the width is greater than zero, the /JUSTIFY qualifier is activated.

/X[=column]

/X=previous-column (D)

Specifies the screen column where the item is displayed (the left-most column is 1). By default, items are displayed in the same column as defined by the previous DISPLAY command.

/Y[=row]

/Y=next-free-row (D)

Specifies the screen row where the item is displayed (top row is 1). By default, items are displayed on the next free row after the item defined by the previous DISPLAY command.

Related commands

• MONITOR
• SHOW DISPLAY
• CLEAR
• DISPLAY BAR
• DISPLAY SYMBOLIC
• DISPLAY TEXT

The DISPLAY SYMBOLIC command displays a text in a monitor picture depending on the result of an expression evaluation.

Format

DISPLAY SYMBOLIC expression "text-string" [,"text-string"]...

Description

The DISPLAY SYMBOLIC command displays one of the text strings depending on the value of expression . The first string is output if the expression's value is zero (0), the second string is output if the expression's value is 1, and so on. If the expression has a value for which there is no corresponding entry in the list of texts, the value itself is printed. Because there is a limit of 255 characters on the size of one command to RTR, large numbers of long strings should be avoided.

The command can be used within a monitor file or issued at the RTR prompt when interactively defining a monitor picture for use in a subsequent MONITOR command.

Parameters

expression

The expression to be evaluated. Expression can either be the name of a single data item, or an expression combining several data items using simple arithmetic operations and constants. In the latter case, the data items must all be of the same type and expression must be enclosed in quotation marks.

Qualifiers

/BELL[=Boolean-expression]

/NOBELL (D)

Sends a bell character to the terminal if Boolean-expression evaluates to True (non-zero).

/BLANK[=Boolean-expression]

/NOBLANK (D)

Specifies that the displayed value is replaced by blanks if Boolean-expression evaluates to True (non-zero).

/BLINK[=Boolean-expression]

/NOBLINK (D)

Specifies that the displayed value blinks if Boolean-expression evaluates to True (non-zero).

/BOLD[=Boolean-expression]

/NOBOLD (D)

Specifies that the item is displayed in high intensity if Boolean-expression evaluates to True (non-zero).

/COLSPAN=n

/COLSPAN=1 (D)

Specifies the number of columns the item is to span in the HTML table where it is displayed. The default is one column.

/DESCRIPTION="text-string"

Provides a descriptive text for the item being displayed. Column headers are often cryptic as little room is available. The browser will display the descriptive text in a popup window (currently, Internet Explorer only).

/DISPLAY

Specifies that text formatting is to be suppressed if the /NOTEXT qualifer is chosen, so that HTML output is easier to read. Use the /NOHTML qualifier if you only want text as output. By default, items are displayed in both text and HTML views.

/HEADER

/NOHEADER (D)

Indicates the item is part of a table header. This qualifier should be attached to the first item of a new row.

/PARAGRAPH

Causes a display item to be formatted as the first item of a new paragraph in the HTML output. This qualifier is effective only while in text mode, after the /NOTABLE qualifier has been used.

/REVERSE[=Boolean-expression]

/NOREVERSE (D)

Specifies that the item is displayed with the foreground and background visual attributes swapped if Boolean-expression evaluates to True (non-zero).

/[NO]TABLE

Indicates the start of a new table in the monitor output. This qualifier should be attached to the first item of a new row. Specifying /NOTABLE causes any current table to be closed and a new text section to be started in the HTML output.

/UNDERLINE[=Boolean-expression]

/NOUNDERLINE (D)

Specifies that the displayed value is underlined if Boolean-expression evaluates to True (non-zero).

/X[=column]

/X=previous-column (D)

Specifies the screen column where the item is displayed (the left-most column is 1). By default, items are displayed in the same column as defined by the previous DISPLAY command.

/Y[=row]

/Y=next-free-row (D)

Specifies the screen row where the item is displayed (top row is 1). By default, items are displayed on the next free row after the item defined by the previous DISPLAY command.

Related commands

• MONITOR
• SHOW DISPLAY
• CLEAR
• DISPLAY BAR
• DISPLAY NUMERIC
• DISPLAY TEXT

Examples

See Section A.1 for examples of how to use the DISPLAY SYMBOLIC command.

The DISPLAY TEXT command displays text in a monitor picture.

Format

DISPLAY TEXT text

Description

The DISPLAY TEXT command displays the specified text in a monitor picture. It can be used within a monitor file or issued at the RTR prompt when interactively defining a monitor picture for use in a subsequent MONITOR command.

Parameters

text

Specifies the text to be displayed. This text may contain any of the substitution symbols. See Section A.2, Substitution Symbols.

Qualifiers

/BELL[=Boolean-expression]

/NOBELL (D)

Sends a bell character to the terminal if Boolean-expression evaluates to True (non-zero).

/BLANK[=Boolean-expression]

/NOBLANK (D)

Specifies that the displayed value is replaced by blanks if Boolean-expression evaluates to True (non-zero).

/BLINK[=Boolean-expression]

/NOBLINK (D)

Specifies that the displayed value blinks if Boolean-expression evaluates to True (non-zero).

/BOLD[=Boolean-expression]

/NOBOLD (D)

Specifies that the item is displayed in high intensity if Boolean-expression evaluates to True (non-zero).

/COLSPAN=n

/COLSPAN=1 (D)

Specifies the number of columns the item is to span in the HTML table where it is displayed. The default is one column.

/DESCRIPTION="text-string"

Provides a descriptive text for the item being displayed. Column headers are often cryptic as little room is available. The browser will display the descriptive text in a popup window (currently, Internet Explorer only).

/DISPLAY

Specifies that text formatting is to be suppressed if the /NOTEXT qualifer is chosen, so that HTML output is easier to read. Use the /NOHTML qualifier if you only want text as output. By default, items are displayed in both text and HTML views.

/FACILITY

/NOFACILITY (D)

Specifies that the symbol substitution in the text is carried out as if a facility data item were being displayed. This means that the link name symbol ($LINK_NAME) and the process-related symbols ($PROCESS_ID, $PROCESS_NAME, $IMAGE_NAME, $FULL_IMAGE_NAME) are always replaced by the text "-ALL-".

The facility name symbol ($FACILITY_NAME) will be replaced by the text "-ALL-" unless MONITOR/FACILITY=facility-name is used; in this case $FACILITY_NAME is replaced by facility-name .

/HEADER

/NOHEADER (D)

Indicates the item is part of a table header. This qualifier should be attached to the first item of a new row.

/LINK

/NOLINK (D)

Specifies that symbol substitution in the text is carried out as if a link data item were being displayed. This means that the facility name symbol ($FACILITY_NAME) and the process related symbols ($PROCESS_ID, $PROCESS_NAME, $IMAGE_NAME, $FULL_IMAGE_NAME) are always replaced by the text "-ALL-". The link name symbol ($LINK_NAME) is replaced by the text "-ALL-" unless MONITOR/LINK=node-name is used, in which case $LINK_NAME is replaced by node-name .

/MONITOR-HYPERLINK=[monitor-name]

Specifies a monitor picture name. The first occurrence of the string in the text item being displayed will act as a hyperlink to the monitor screen.

/NODE

/NONODE

Specifies that symbol substitution in the text is carried out as if a node data item were being displayed. This means that the facility name symbol ($FACILITY_NAME), the link name symbol ($LINK_NAME) and the process-related symbols ($PROCESS_ID, $PROCESS_NAME, $IMAGE_NAME, $FULL_IMAGE_NAME) are always replaced by the text "-ALL-".

/PARAGRAPH

Causes a display item to be formatted as the first item of a new paragraph in the HTML output. This qualifier is effective only while in text mode, after the /NOTABLE qualifier has been used.

/PROCESS

/NOPROCESS (D)

Specifies that symbol substitution in the text is carried out as if a process data item were being displayed. This means that the facility name symbol ($FACILITY_NAME) and the link name symbol ($LINK_NAME) are always replaced by the text "-ALL-".

The process-related symbols ($PROCESS_ID, $PROCESS_NAME, $IMAGE_NAME, $FULL_IMAGE_NAME) are replaced by the text "-ALL-" unless MONITOR/IDENTIFICATION=process-id is used. In this case they are replaced by the appropriate strings for the process specified by process-id .

/REVERSE[=Boolean-expression]

/NOREVERSE (D)

Specifies that the item is displayed with the foreground and background visual attributes swapped if Boolean-expression evaluates to True (non-zero).

/SELECT[=Boolean-expression]

/NOSELECT (D)

Displays the item if Boolean-expression evaluates to True (non-zero).

/[NO]TABLE

Indicates the start of a new table in the monitor output. This qualifier should be attached to the first item of a new row. Specifying /NOTABLE causes any current table to be closed and a new text section to be started in the HTML output.

/UNDERLINE[=Boolean-expression]

/NOUNDERLINE (D)

Specifies that the displayed value is underlined if Boolean-expression evaluates to True (non-zero).

/X[=column]

/X=previous-column (D)

Specifies the screen column where the item is displayed (the left-most column is 1). By default, items are displayed in the same column as defined by the previous DISPLAY command.

/Y[=row]

/Y=next-free-row (D)

Specifies the screen row where the item is displayed (top row is 1). By default, items are displayed on the next free row after the item defined by the previous DISPLAY command.

Related commands

• MONITOR
• SHOW DISPLAY
• CLEAR
• DISPLAY NUMERIC
• DISPLAY BAR
• DISPLAY SYMBOLIC

Examples

See Section A.1, Interactive Definition of a Monitor Picture, for examples of how to use the DISPLAY TEXT command.