# hp Reliable Transaction Router
System Manager's Manual

Previous | Contents | Index

# DISPLAY SYMBOLIC

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

> Note This command is not available in the RTR web browser interface.

## Format

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

Command Qualifiers | Defaults
--- | ---
/BELL[=Boolean-expression] | /NOBELL
/BLANK[=Boolean-expression] | /NOBLANK
/BLINK[=Boolean-expression] | /NOBLINK
/BOLD[=Boolean-expression] | /NOBOLD
/COLSPAN=n | /COLSPAN=1
/DESCRIPTION="text-string" | None
/DISPLAY=NOHTML | /DISPLAY=TEXT
/DISPLAY=NOTEXT | /DISPLAY=HTML
/HEADER | /NOHEADER
/PARAGRAPH | None
/REVERSE[=Boolean-expression] | /NOREVERSE
/[NO]TABLE | None
/UNDERLINE[=Boolean-expression] | /NOUNDERLINE
/X[=column] | Column of previous item
/Y[=row] | Next free row

## 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 qualifier 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).

> ### /TABLE

> ### /NOTABLE

> 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

- CLEAR
- DISPLAY BAR
- DISPLAY NUMERIC
- DISPLAY TEXT
- MONITOR
- SHOW DISPLAY

##

### Examples

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

# DISPLAY TEXT

> The DISPLAY TEXT command displays text in a monitor picture.

> Note This command is not available in the RTR web browser interface.

## Format

> DISPLAY TEXT text

Command Qualifiers | Defaults
--- | ---
/BELL[=Boolean-expression] | /NOBELL
/BLANK[=Boolean-expression] | /NOBLANK
/BLINK[=Boolean-expression] | /NOBLINK
/BOLD[=Boolean-expression] | /NOBOLD
/COLSPAN=n | /COLSPAN=1
/DESCRIPTION="text-string" | None
/DISPLAY=NOHTML | /DISPLAY=TEXT
/DISPLAY=NOTEXT | /DISPLAY=HTML
/FACILITY | /NOFACILITY
/HEADER | /NOHEADER
/LINK | /NOLINK
/MONITOR-HYPERLINK | None
/NODE | /NODE
/PARAGRAPH | None
/PROCESS | /NOPROCESS
/REVERSE[=Boolean-expression] | /NOREVERSE
/SELECT[=Boolean-expression] | /NOSELECT
/[NO]TABLE | None
/UNDERLINE[=Boolean-expression] | /NOUNDERLINE
/X[=column] | Column of previous item
/Y[=row] | Next free row

## 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 qualifier 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).

> ### /TABLE

> ### /NOTABLE

> 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

- CLEAR
- DISPLAY NUMERIC
- DISPLAY BAR
- DISPLAY SYMBOLIC
- MONITOR
- SHOW DISPLAY

##

### Examples

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

# DO

> The DO command executes an operating system command.

> Note This command is not available in the RTR web browser interface.

## Format

> DO [operating-system-command]

Command Qualifiers | Defaults
--- | ---
/CLUSTER | /NOCLUSTER
/NODE[=node-list] | /NODE=default-node
/OUTPUT[=filespec] | /OUTPUT=stdout

## Description

> The DO command enables an operating system command to be executed from RTR. By using the /NODE and /CLUSTER qualifiers, the command can be executed on one or more remote nodes. (Note that the SPAWN command does not have this ability).

> The DO command is only suitable for commands producing line-oriented output; use SPAWN to execute a local operating system command that produces screen-oriented output (for example, the OpenVMS MONITOR SYSTEM command, or screen mode editors).

## Parameters

> ### operating-system command

> The operating system command that you want to execute.

## Qualifiers

> ### /CLUSTER

> ### /NOCLUSTER (D)

> Specifies that the command is executed on all the nodes in the cluster.

> If neither /NODE nor /CLUSTER is specified, the command is executed on the nodes specified by the latest SET ENVIRONMENT command. If no SET ENVIRONMENT command has been entered, the command is executed only on the node where the command was issued.

> Note In environments that do not support remote command capability, the /CLUSTER qualifier causes the relevant command to be executed on the local node only. See Section 1.4 for more information.

> ### /NODE[=node-list]

> ### /NODE=default-node (D)

> Specifies that the command is executed on all nodes specified in `node-list` . If `node-list` is omitted, the command is executed only on the node where the command was issued.

> ### /OUTPUT[=filespec]

> ### /OUTPUT=stdout (D)

> Specifies that the resulting information is written to the file `filespec` . If /OUTPUT or `filespec` is omitted, the standard or default output is used.

### Related commands

- SPAWN

## Examples

#1
     RTR> DO/CLUSTER SHOW TIME

> This command shows the time on all nodes in a OpenVMS cluster.

#2
     RTR> DO/NODE=(TR2,TR1) SHOW LOGICAL MYLOGICAL

> This command examines the logical name MYLOGICAL on nodes TR2 and TR1.

#3
     RTR> SET ENVIRONMENT/NODE=(TR2,TR1)
     RTR> DO SHOW TIME
     RTR> DO SHOW LOGICAL MYLOGICAL

> Use the SET ENVIRONMENT command if a series of DCL commands are to be issued on the same nodes.

#4
     RTR> DO/NODE=(TR2,TR1) "ps"

> This command displays the processes running on Tru64 UNIX nodes TR2 and TR1.

# DUMP JOURNAL

> The DUMP JOURNAL command displays information from the current RTR journal.

## Format

> DUMP JOURNAL

Command Qualifiers | Defaults
--- | ---
/BEFORE[=date] | Today
/COMMIT_SEQUENCE_NUMBER | all CSNs
=csn |
/FACILITY[=facility-name] | /FACILITY="*"
/FINAL_STATE=final-state | None
/FULL | /NOFULL
/LOCK | /NOLOCK
/MESSAGE_NUMBER=msg_nbr | All messages
/NODE[=node-list] | /NODE=default-node
/OUTPUT[=filespec] | /OUTPUT=stdout
/PARTITION=partition | None
/RAW_DATA=filename | None
/RECORD_CLASS=record-class-type | None
/SINCE[=date] | Today
/STATISTICS | None
/TID=tid | All TIDs
/USER=username | All users

## Description

> The DUMP JOURNAL command dumps (that is, displays or sends to a file) the contents of an RTR journal file.

> The command can display transaction messages that were written in text format, up to 256 bytes.

## Qualifiers

> ### /BEFORE[=date]

> Selects only those transactions whose timestamp is before the specified date. Default is the current date.

> ### /COMMIT_SEQUENCE_NUMBER=CSNs

> The Commit Sequence Number (CSN) is used in the RTR mechanism controlling transaction sequencing across multiple servers. The CSNs for transactions are displayed by the DUMP JOURNAL command. When this qualifier is used, only those transactions that have the specified CSN number are selected.

> ### /FACILITY[=facility-name]

> ### all facilities (D)

> Selects only those transactions belonging to the specified facility. `Facility-name` can contain wildcards (*, % and ?), in which case all matching facilities are displayed.
> If /FACILITY is not specified, journal information for all facilities is displayed.

> ### /FINAL_STATE=final_state

> Selects transactions whose final state matches that specified. Final state can be one of:

> > VOTED
> > COMMIT
> > ABORT
> > SEND
> > EXCEPTION
> > PREPARE
> > PRI_DONE
> > PRI_FORGET
> > PRI_START
> > PARTITION
> > SEC_DONE
> > DONE

> ### /FULL

> ### /NOFULL (D)

> Specifies that the command dumps detailed information (in logged sequence) about each journal record including the record header and each individual state of the transaction. At the end, the command also dumps the final state of each transaction followed by statistics.
> If /FULL is not specified, only brief information is displayed.

> ### /LOCK

> ### /NOLOCK (D)

> Lock the journal while dumping it. Locking the journal ensures that the data displayed is accurate and up-to-date; the contents of the journal cannot change while the DUMP JOURNAL command is executing.

> Locking the journal may interfere with RTR during a standby recovery operation if a standby node tries to acquire the journal lock while the dump is in progress. If this occurs, the standby failover operation is delayed until the DUMP JOURNAL command completes and the standby node can acquire the lock.

> ### /MESSAGE_NUMBER=message_number

> This qualifier is only valid when used in conjunction with the /TID and /RAW_DATA qualifiers. Message data is not output unless a raw data file has been specified. `Message_number` can contain wildcards (*, % and ?), in which case all matching facilities are displayed.

> For each selected transaction, message data for each specified message is collected and output to the file specified by the /RAW_DATA qualifier.

> If no message is specified, the default is that all messages for each qualifying transaction are selected.

> ### /NODE[=node-list]

> ### /NODE=default-node (D)

> Specifies that the command is executed on all nodes specified in `node-list` . If `node-list` is omitted, the command is executed only on the node where the command was issued.

> ### /OUTPUT[=filespec]

> ### /OUTPUT=stdout (D)

> Specifies that the resulting information is written to the file `filespec` . If /OUTPUT or `filespec` is omitted, the standard or default output is used.

> ### /PARTITION=partition_name

> Selects only those transactions contained in the specified partition.

> ### /RAW_DATA=filename

> Writes the unedited content of each selected message for each selected transaction to the specified file. Message data contained in this file is application specific, and is not interpreted in any way by RTR. It is the responsibility of the application programmer to develop any necessary tools for viewing the contents of this file.

> This qualifier is valid only when used in conjunction with the /MESSAGE_NUMBER qualifier.

> For each message, the raw data file contains a message header, a variable-length string representing the transaction identifier, and finally the message data. The message header is defined in the `rtr.h` include file, and is specified as follows:

>     typedef struct rtr_raw_data_header_t
>     {
>             rtr_uns_32_t message_number;
>             rtr_uns_32_t message_length;
>             rtr_uns_32_t tid_length;
>             rtr_uns_8_t   reserved[256];
>     };

> Reading of the raw data file can be done as follows:

> 1. Read the header ( `sizeof rtr_raw_data_header_t` ).
> 2. Read the transaction identifier ( `tid_length` bytes) followed by reading the message data ( `message_length` bytes), which positions the file offset to the beginning of the next record, or
> 3. Read the rest of the record by reading in `tid_length` + `message_length` bytes, which again positions the file offset to the beginning of the next record, or
> 4. Skip this message and position directly ( `lseek` ) to the header of the next message at current offset + `tid_length` + `message_length` bytes.

> ### /RECORD_CLASS=record_class_type

> Selects transactions which match the specified journal-record-class type.

> `record_class_type` may be one of the following:

> > VOTED
> > COMMIT
> > ABORT
> > INFO
> > SEND
> > EXCEPTION
> > PREPARE
> > PRI_DONE
> > PRI_FORGET
> > PRI_START
> > PARTITION
> > SEC_DONE
> > DONE

> ### /SINCE[=date]

> Selects only those transactions whose timestamp is after the specified date. Default is the current date.

> ### /STATISTICS

> Displays a brief summary of the journal contents, and the number of transactions that may be used for restart and shadow recovery.

> ### /TID=tid

> ### All TIDs (D)

> Specifies that the command displays only the information pertaining to this particular transaction ID ( `tid` ). `tid` is the seven-field numeric identifier used by RTR to uniquely identify a transaction.

>     DUMP JOURNAL /TID ="3bd01f10,0,0,0,0,1f4c,2d740001"

> The quotes enclosing the `tid` are required. Substituting an asterisk for any one or more of the seven numeric components is permitted as wildcard selection.

> If /TID is not specified, log information for all TIDs is displayed.

> ### /USER[=user-id]

> ### /all users (D)

> Specifies that the command displays only the information transactions initiated by this particular `user-id` . `User-id` may contain wildcards (*, %, and ?), in which case all matching user IDs will be displayed.
> If /USER is not specified, log information for all users is displayed.

### Related commands

- CREATE JOURNAL
- DELETE JOURNAL
- SHOW JOURNAL
- MONITOR JOURNAL

##

### Examples

> The following examples show brief and full output of the DUMP JOURNAL command.

> Example 8-1 DUMP JOURNAL Brief Output

>     RTR>DUMP JOURNAL
>     %RTR-W-JOUINUSE, journal is locked by another user

>         Final Tx States
>      ===================================

>         TX  #1
>             facility name   =  test_facility
>             txid            =  3bd01f10,0,0,0,0,1f4c,2d740001
>             partition names =  test_partition
>             tx start        =  Mon Oct 14 20:52:54 2002
>             fe user         =  user.28924
>             final tx state  =  rtr_tx_jnl_sending
>             number of enqs  =  1
>             num of records  =  3
>             commit_seq_nr   =  1

>        Journal Record Statistics
>      ===================================
>       total records processed   =  3
>        send       =  1
>        prepare    =  0
>        prepared   =  0
>        vote       =  1
>        commit     =  0
>        abort      =  0
>        pri_done   =  0
>        sec_done   =  0
>        pri_forget =  0
>        sec_down   =  0
>        pri_start  =  0
>        dtx_info   =  0
>        partition  =  0
>        exception  =  1
>        others     =  0

>      restart recovery txns   =  0
>      shadow recovery txns    =  0

> Previous | Next | Contents | Index