# hp Reliable Transaction Router
System Manager's Manual

Previous | Contents | Index

# DEFINE /KEY

> The DEFINE /KEY command assigns a string to a keyboard function key.

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

## Format

> DEFINE /KEY key-name "equivalence-string"

Command Qualifiers | Defaults
--- | ---
/[NO]ECHO | /ECHO
/IF_STATE | /NOIF_STATE
/LOCK_STATE | /NOLOCK_STATE
/LOG | /NOLOG
/SET_STATE=state-name | /NOSET_STATE
/TERMINATE | /NOTERMINATE

## Description

> This command lets you assign a string to a function key, possibly overriding any predefined function that was bound to that key. When you then press the key, the RTR Utility enters the currently associated string into your command line. The RTR DEFINE /KEY command is similar to the `OpenVMS DCL DEFINE /KEY` command.

> A key definition remains in effect until you redefine the key or exit from the RTR Utility. You can include key definitions in command procedures, for example in the RTR Utility initialization file.

> The /IF_STATE qualifier lets you increase the number of key definitions available on your terminal. The same key can be assigned any number as long as each definition is associated with a different state.

> By default, the current key state is the `DEFAULT` state. The current state can be changed by pressing a key that causes a state change (that is, a key that was defined with the DEFINE /KEY /STATE command).

## Parameters

> ### key-name

> Specifies a function key to be assigned a string. Table 8-21 describes the valid key names.

> Table 8-21 Key Names
> Key-name | LK201 | VT100-type
> --- | --- | ---
> PF1 | PF1 | PF1
> PF2 | PF2 | PF2
> PF3 | PF3 | PF3
> PF4 | PF4 | PF4
> KP0, KP1 ..KP9 | Keypad 0 .. 9 | Keypad 0 .. 9
> PERIOD | Keypad period (.) | Keypad period (.)
> COMMA | Keypad comma (,) | Keypad comma (,)
> MINUS | Keypad minus (-) | Keypad minus (-)
> ENTER | ENTER | ENTER
> E1 | Find |
> E2 | Insert Here |
> E3 | Remove |
> E4 | Select |
> E5 | Prev Screen |
> E6 | Next Screen |
> HELP | Help |
> DO | Do |
> F6, F7, .. F20 | F6, F7, .. F20 |

> ### equivalence-string

> Specifies the string to be processed when the specified key is pressed. Typically, this is all or part of an RTR command.

> If the string contains spaces or non-alphanumeric characters, it must be enclosed in quotation marks.

## Qualifiers

> ### /ECHO (D)

> ### /NOECHO

> Controls whether the command line is displayed after the key has been pressed. Do not use /ECHO with /NOTERMINATE.

> ### /IF_STATE=state-name

> ### /NOIF_STATE (D)

> Specifies the name of a state to which a key definition applies. /IF_STATE assigns the key definitions to the specified states. A state name can be any appropriate alphanumeric string. /NOIF_STATE (the default) assigns the key definition to the DEFAULT state.

> ### /LOCK_STATE

> ### /NOLOCK_STATE (D)

> Controls how long the state set by /SET_STATE remains in effect after the specified key is pressed. /LOCK_STATE causes the state to remain in effect until it is changed explicitly by another function key being pressed that has the /SET_STATE attribute. /NOLOCK_STATE (the default) causes the state to remain in effect only until the next terminator character is typed, or until the next define function key is pressed.

> ### /LOG

> ### /NOLOG (D)

> Controls whether a message is displayed indicating that the key definition has been successfully created.

> ### /SET_STATE=state-name

> ### /NOSETSTATE (D)

> Controls whether pressing the key changes the current key state. /SET_STATE changes the current state to `state-name` when you press the key. /NOSET_STATE (the default) causes the current state to remain in effect.

> ### /TERMINATE

> ### /NOTERMINATE (D)

> Controls whether the specified string is to be terminated (processed) when the key is pressed. /TERMINATE causes the string to be terminated when the key is pressed. /NOTERMINATE (the default) allows you to press other keys before terminating the string by pressing the ``[RETURN]`` key.

### Related commands

- SHOW KEY

##

### Examples

#1
     RTR> DEFINE /KEY PF3 "SHOW RTR" /TERMINATE
     DEFAULT PF3 key has been defined as "SHOW RTR"
     RTR> [PF3]

     RTR running on node BE1

> The DEFINE /KEY command defines the `[PF3]` key on the keypad to perform a SHOW RTR command. DEFAULT refers to the default state.

#2
     RTR> DEFINE /KEY PF1 "HELP " /SET_STATE=GOLD /NOTERMINATE /ECHO
     DEFAULT PF1 key has been defined as "HELP "
     RTR> DEFINE /KEY PF1 " CREATE" /TERMINATE /IF_STATE=GOLD /ECHO
     GOLD PF1 key has been defined as "CREATE"
     RTR> [PF1]
     RTR> HELP [PF1]
     RTR> HELP CREATE
     The "CREATE FACILITY" command is used to ...

> The first DEFINE /KEY command defines the `[PF1]` key to be the string HELP. The state is set to GOLD for the subsequent key. The /NOTERMINATE qualifier instructs the system to remain in command input mode when the key is pressed. The second DEFINE /KEY command defines the use of the `[PF1]` key when the keypad is in the GOLD state. When the keypad is in the GOLD state, pressing `[PF1]` will cause the current read to be terminated.

> If you press `[PF1]` twice, the system displays and processes the HELP CREATE command.

> The word DEFAULT in the second line of the example refers to the fact that `[PF1]` has been defined in the default state. Note the space before the word CREATE in the second DEFINE /KEY command. If the space is omitted, the system fails to recognize CREATE as the keyword for the HELP command.

# DELETE FACILITY

> The DELETE FACILITY command deletes an RTR facility.

## Format

> DELETE FACILITY facility_name

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

## Description

> The DELETE FACILITY command removes the specified facility on the node where the command is issued. After issuing this command, applications are no longer able to use the facility. Any outstanding transactions using the facility are aborted.

## Parameters

> ### facility_name

> The name of the facility to delete.

> The parameter `facility_name` must be supplied.

## 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

- CREATE FACILITY
- SHOW FACILITY

##

### Examples

> See Chapter 2, Starting and Setting Up RTR, for examples of how to use the DELETE FACILITY command.

# DELETE JOURNAL

> The DELETE JOURNAL command deletes an RTR journal.

## Format

> DELETE JOURNAL

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

## Description

> The DELETE JOURNAL command deletes a previously created RTR journal on the node where the command is issued.

> The DELETE JOURNAL command will fail if a journal does not exist, or if a journal has been created but is currently in use. The command causes the previous contents of the journal, if any, to be destroyed.

## 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

- CREATE JOURNAL
- MODIFY JOURNAL
- SHOW JOURNAL

# DELETE PARTITION

> The DELETE PARTITION command deletes an RTR PARTITION.

## Format

> DELETE PARTITION partition_name

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

## Description

> The DELETE PARTITION command removes the specified partition on the node where the command is issued.

## Parameters

> ### PARTITION_name

> The name of the partition to delete.

> The parameter `partition_name` must be supplied. It may be specified as `partition_name` or as `facility_name:partition_name` .

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

> ### /FACILITY

> Specifies the name of the facility from which the partition is being deleted.

> ### /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

- CREATE PARTITION
- SHOW PARTITION

# DISPLAY BAR

> The DISPLAY BAR command displays a bar graph in a monitor picture.

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

## Format

> DISPLAY BAR expression

Command Qualifiers | Defaults
--- | ---
/AVERAGE=(keyword,...) | None
/BELL[=Boolean-expression] | /NOBELL
/BLANK[=Boolean-expression] | /NOBLANK
/BLINK[=Boolean-expression] | /NOBLINK
/BOLD[=Boolean-expression] | /NOBOLD
/CHARACTER=char | /CHARACTER="a"
/COLSPAN=n | /COLSPAN=1
/DAMPING=damping-factor | /NODAMPING
/DESCRIPTION="text-string" | None
/DISPLAY=NOHTML | /DISPLAY=TEXT
/DISPLAY=NOTEXT | /DISPLAY=HTML
/HEADER | /NOHEADER
/LABEL=text | /NOLABEL
/LENGTH=nr-chars | /LENGTH=50
/MAXIMUM=max-value | /MAXIMUM=10
/MINIMUM=min-value | /MINIMUM=0
/PARAGRAPH | None
/RATE=interval | /NORATE
/REVERSE[=Boolean-expression] | /NOREVERSE
/ROWS=nr-rows | /ROWS=1
/SELECT[=Boolean-expression] | /NOSELECT
/SEPARATE=(keyword,...) | None
/[NO]TABLE | None
/TOTALIZE=(keyword,...) | None
/UNDERLINE[=Boolean-expression] | /NOUNDERLINE
/VALUE=[value-type] | /VALUE=CURRENT
/X[=column] | Column of previous item
/Y[=row] | Next free row

## Description

> The DISPLAY BAR command displays the `expression` as a bar graph 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. Chapter 7 and Appendix A contain more information on monitor pictures and monitor files.

## Parameters

> ### expression

> Specifies the quantity to be displayed. `Expression` can be either the name of a single data item or an expression combining several items using simple arithmetic operations and constants. In the latter case, `expression` must be in quotes.

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

> ### /BLINK[=Boolean-expression]

> ### /NOBLINK (D)

> Specifies that the displayed value blinks 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).

> ### /BOLD[=Boolean-expression]

> ### /NOBOLD (D)

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

> ### /CHARACTER[=char]

> ### /NOCHARACTER

> ### /CHARACTER="a" (D)

> Specifies the character used to draw bar charts. The line drawing character set is used to display them. By default, the character "a" is used, which corresponds to a rectangular block in the character set. If /NOCHARACTER is given, no characters are displayed and the bar is visible only if attributes have been specified. This can be used to draw a scale behind the bar chart.

> ### /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.

> ### /DAMPING[=damping-factor]

> ### /NODAMPING (D)

> Specifies that the value displayed is to fluctuate more slowly than the raw measured value. The default for `damping-factor` is one. Damping is only relevant if `/VALUE=CURRENT` .

> ### /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.

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

> ### /LENGTH[=nr-chars]

> ### /LENGTH=50 (D)

> Specifies the number of characters in a bar chart representing the maximum value. The default is 50.

> ### /MAXIMUM[=max-value]

> ### /MAXIMUM=10 (D)

> Specifies the maximum value represented on a bar chart. The default is 10.

> ### /MINIMUM[=min-value]

> ### /MINIMUM=0 (D)

> Specifies the minimum value represented on a bar chart. The default is zero.

> ### /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.

> ### /RATE[=interval]

> ### /NORATE (D)

> Specifies that the rate of change of the `expression` is to be displayed rather than the absolute value. When `/RATE` is used, `interval` specifies the time interval in seconds used to calculate the rate of change. This has no effect on the sampling; it simply allows the rate to be displayed in another unit. For example, displaying the start transaction counter with `/RATE=60` results in transactions per minute being displayed instead of per second.

> ### /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

> ### /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.

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

> ### /VALUE[=value-type]

> ### /VALUE=CURRENT (D)

> Specifies how the value is processed before being displayed. `Value-type` can be one of the following keywords:

> CURRENT | (default) Displays the current value of `expression`
> AVERAGE | Displays the average value of `expression` since the MONITOR command was issued
> MINIMUM | Displays the minimum value of `expression` since the MONITOR command was issued
> MAXIMUM | Displays the maximum value of `expression` since the MONITOR command was issued

> Previous | Next | Contents | Index