CONSOLE

#### Search Results

Search

# CONSOLE

File | 35
Op-Sys | z/OS, z/VSE, BS2000 Note Support for z/VSE is deprecated. Support for BS2000 is also deprecated, except in conjunction with the ESM adapter. Features that are z/VSE and BS2000 specific will be removed from future releases.
Statement | `FIND`, `PROCESS`
Task | Read operator console or issue console commands.

Note for BS2000: `CONSOLE` cannot be used in single-user mode.

## Common Fields for all Operating Systems

Dictionary Field Name | F/L | Mu | DE | Remarks
--- | --- | --- | --- | ---
`ERROR-CODE` | N3 |  |  |
`ERROR-TEXT` | A58 |  |  |
`NODE` | N5 |  | D |
`NODE-NAME` | A16 |  | D |
`SYSTEM-MESSAGE-CODE` | A10 |  |  |
`FUNCTION` | A8 |  | D | Required.
`JOB-ID` | A8 |  | D | Relevant with `FUNCTION=DISPLAY`, `DIS-WTOR`.
`JOB-NAME` | A8 |  | D | Relevant with `FUNCTION=WTOR`. In BS2000, also for `DISPLAY`, `DIS-WTOR` (not for z/VSE).
`JOB-TYPE` | A6 |  | D | Relevant with `FUNCTION=DISPLAY`, `DIS-WTOR`.
`NETTO-TEXT` | A253 |  | D | Relevant with `FUNCTION=DISPLAY`, `DIS-WTOR`.
`READ-DIRECTION` | A1 |  | D | Relevant with `FUNCTION=DISPLAY`.
`RECORD-NUMBER` | N9 |  | D | Relevant with `FUNCTION=DISPLAY`.
`REPLY-FLAG` | A1 |  |  | Relevant with `FUNCTION=DISPLAY`, `DIS-WTOR`.
`REPLY-ID` | A8 |  | D | Relevant with `FUNCTION=DIS-WTOR`.
`TEXT` | A253 |  | D | Relevant for function `OP-CMD`, default length: 80 characters.
`TEXT-LENGTH` | N3 |  | D | Relevant for funciton `OP-CMD`, maximum value = 120
`TIMX` | T |  | D |
`WAIT-TIME` | B4 |  | D | Relevant with `FUNCTION=DISPLAY`.

## Additional Fields Supported for z/OS

Dictionary Field Name | F/L | Mu | DE | Remarks
--- | --- | --- | --- | ---
`CONSOLE-ID` | B1 |  | D | Relevant with `FUNCTION=DISPLAY`.
`REPLY` | A80 |  |  | Relevant with `FUNCTION=WTOR`.
`RESPONSE-FLAG` | A1 |  |  |
`HOLD-FLAG` | A1 |  |  |
`DESCR-CODE-STRING` | A16 |  | D |
`ROUTE-CODE-STRING` | A28 |  | D |
`SEQUENCE-NUMBER` | A8 |  |  |
`TEXT-FLAG` | A1 |  |  |
`TIME-STAMP` | A8 |  | D | Relevant with `FUNCTION=DIS-WTOR`.

## Additional Fields Supported for z/VSE

Dictionary Field Name | F/L | Mu | DE | Remarks
--- | --- | --- | --- | ---
`RESPONSE-FLAG` | A1 |  |  |
`SEQUENCE-NUMBER` | A8 |  |  |
`TEXT-FLAG` | A1 |  |  |

## Additional Fields Supported for BS2000

Dictionary Field Name | F/L | Mu | DE | Remarks
--- | --- | --- | --- | ---
`SYSTEM-CODE` | B2 |  |  |
`REPLY` | A80 |  |  | Relevant with `FUNCTION=WTOR`.
`TIME-STAMP` | A8 |  | D | Relevant with `FUNCTION=DIS-WTOR`.

## Relevant Error Codes

Code | Text | z/OS | z/VSE | BS2000
--- | --- | --- | --- | ---
530 | Access denied by Security Facility. | X |  | X
537 | Time limit reached. |  |  | X
600 | Unknown function. | X | X | X
630 | Console not defined or inactive. | X |  | X
688 | Return code xx HCF function xxxxxxxx. |  | X |
699 | GETVIS failed. | X | X |
750 | Invalid operand within operand list. |  |  | X
778 | Not APF authorized. | X |  |
799 | Entire System Server internal error. |  |  | X
809 | Subsystem not active. |  |  | X
986 | No or not enough space for `COMMAND IN MP`. |  |  | X

## Field Descriptions

Field Name | Format/Length | Operating System
--- | --- | ---
`CONSOLE-ID` | (B1) | z/OS

Only relevant for the `DISPLAY` function. The identifier of the console to be displayed. If the identifier is omitted, the master console is displayed. The field is ignored in BS2000.

Field Name | Format/Length | Operating System
--- | --- | ---
`DESCR-CODE-STRING` | (A16) | z/OS, z/VSE

Descriptor codes for the console message. Each byte of the string corresponds to one of the descriptor codes 1-16. A byte contains `1` if the corresponding descriptor code is assigned, or `0` if it is not assigned.

Field Name | Format/Length | Operating System
--- | --- | ---
`FUNCTION` | (A8) | z/OS, z/VSE, BS2000

The function to be performed. Possible values are:

Value | Explanation
--- | ---
`DISPLAY` | Display console screen image.
`DIS-WTOR` | Display pending operator replies.
`OP-CMD` | Issue operator command.
`WTO` | Write to operator.
`WTOR` | Write to operator with reply (not for z/VSE).

The default length of a command line is 80 characters. However, it can be expanded up to 120 characters if field `TEXT-LENGTH` is accordingly specified as displayed in the following sample code for function `OP-CMD`:

    PROCESS CONSOLE USING NODE = #NODE
    , FUNCTION = 'OP-CMD'
    , TEXT = #COMMAND-LINE
    , TEXT-LENGTH = 120
    GIVING ERROR-CODE ERROR-TEXT

In BS2000, the functions `DISPLAY`, `DIS-WTOR` and `OP-CMD` require that the `UCON` interface task of the Entire System Server is active.

Field Name | Format/Length | Operating System
--- | --- | ---
`HOLD-FLAG` | (A1) | z/OS, z/VSE

Indicates if message is held by the system (has descriptor codes `1`, `2`, `3` or `11`). Possible values:

Value | Explanation
--- | ---
`N` | No
`Y` | Yes

Field Name | Format/Length | Operating System
--- | --- | ---
`JOB-ID` | (A8) | z/OS, z/VSE, BS2000

Only relevant for function `DISPLAY` and `DIS-WTOR`. Job number (TSN) of job for which the message was created.

Field Name | Format/Length | Operating System
--- | --- | ---
`JOB-NAME` | (A8) | z/OS, z/VSE, BS2000

z/OS/z/VSE | BS2000
--- | ---
Only relevant for function `DIS-WTOR`. The job that issued the `WTOR`. | Only relevant for the function `DIS-WTOR` or `DISPLAY`. The job for which the console message was created if the job is still active.

Field Name | Format/Length | Operating System
--- | --- | ---
`JOB-TYPE` | (A6) | z/OS, z/VSE, BS2000

Only relevant for function `DISPLAY` and `DIS-WTOR`. Type of job for which message was created, if this job is still active.

Field Name | Format/Length | Operating System
--- | --- | ---
`NETTO-TEXT` | (A253) | z/OS, z/VSE, BS2000

Only relevant for function `DISPLAY` and `DIS-WTOR`. Message text without the additional information added by the operating system at the creation of the console message.

Field Name | Format/Length | Operating System
--- | --- | ---
`READ-DIRECTION` | (A1) | z/OS, z/VSE, BS2000

Only relevant for function `DISPLAY`. Direction for reading console messages. Possible values:

Value | Explanation
--- | ---
`B` | Default. Backwards (that is, towards oldest message).
`F` | Forwards (that is, towards message last received).

The starting position of `READ-DIRECTION` can be specified in the `RECORD-NUMBER` field.

Field Name | Format/Length | Operating System
--- | --- | ---
`RECORD-NUMBER` | (N9) | z/OS, z/VSE, BS2000

Only relevant for function `DISPLAY`. The number of the console message is returned in this field. If used as input (descriptor), a start position can be given. Possible values:

Value | Explanation
--- | ---
`0:` | Start with latest record.
`n:` | Start with record n.
`-n:` | Start with latest record minus n records.

If the last record + 1 is selected and the value of the field `WAIT-TIME` is greater than `0`, the system waits for the next message.

If the specified start position lies before the oldest available record, the oldest record is taken as the start position.

Field Name | Format/Length | Operating System
--- | --- | ---
`REPLY` | (A80) | z/OS, BS2000

Only relevant for function `WTOR`: the operator reply.

Field Name | Format/Length | Operating System
--- | --- | ---
`REPLY-FLAG` | (A1) | z/OS, z/VSE, BS2000

Only relevant for function `DISPLAY` and `DIS-WTOR`. Possible values:

Value | Explanation
--- | ---
`N` | Message requires no reply.
`Y` | Message requires a reply.

Field Name | Format/Length | Operating System
--- | --- | ---
`REPLY-ID` | (A8) | z/OS, z/VSE, BS2000

Only relevant for function `DIS-WTOR`. The identifier which must be used to reply to a write-to-operator-with-reply.

Field Name | Format/Length | Operating System
--- | --- | ---
`RESPONSE-FLAG` | (A1) | z/OS, z/VSE

Indicates whether message text is the response to a command. Possible values:

Value | Explanation
--- | ---
N | No
Y | Yes

Field Name | Format/Length | Operating System
--- | --- | ---
`ROUTE-CODE-STRING` | (A28) | z/OS, z/VSE

Routing codes for the console message. Each byte of the string corresponds to one of the routing codes 1 - 28. A byte contains `1` if the corresponding routing code is assigned, or `0` if it is not assigned.

Field Name | Format/Length | Operating System
--- | --- | ---
`SEQUENCE-NUMBER` | (A8) | z/OS, z/VSE

Sequence number of the message since the last IPL.

Field Name | Format/Length | Operating System
--- | --- | ---
`TEXT` | (A253) | z/OS, z/VSE, BS2000

The command to be entered for function `OP-CMD` (operator command), default length = 80 characters.

Field Name | Format/Length | Operating System
--- | --- | ---
`TEXT-FLAG` | (A1) | z/OS, z/VSE

Describes the type of message text. Possible values:

Value | Explanation
--- | ---
`C` | Control text (multi-line)
`D` | Data text ( " " )
`E` | End text ( " " )
`L` | Label text ( " " )
`M` | First line ( " " )
`N` | Normal text (single line)

Field Name | Format/Length | Operating System
--- | --- | ---
`TEXT-LENGTH` | (N3) | z/OS, z/VSE, BS2000

Length of field `TEXT`, maximum value = 120 characters. Note that using this field an operator command can exceed the default lenght (80 characters) up to a maximum length of 120 characters.

Field Name | Format/Length | Operating System
--- | --- | ---
`TIME-STAMP` | (A8) | z/OS, BS2000

Only relevant for function `DIS-WTOR` (z/OS). Time stamp of the console message in format `HH:MM:SS`.

Field Name | Format/Length | Operating System
--- | --- | ---
`TIMX` | (T) | z/OS, z/VSE, BS2000

Time stamp in Natural internal format.

Field Name | Format/Length | Operating System
--- | --- | ---
`WAIT-TIME` | (B4) | z/OS, z/VSE, BS2000

Only relevant for function `DISPLAY`. Time in seconds to wait for the next message (see also the field `RECORD-NUMBER`). If no message arrives within the specified time, `ERROR-CODE 537` is issued.

Up to ten delimiter characters to be used for tokenizing the record.

Field Name | Format/Length | Operating System
--- | --- | ---
`TEXT-PART2` | (A3) | BS2000

Bytes 254 - 256 of the text line.

Field Name | Format/Length | Operating System
--- | --- | ---
`NETTO-TEXT-PART2` | (A3) | BS2000

Bytes 254 - 256 of the NETTO-TEXT.

## Default Order of Data Returned

Messages are returned in timestamp order (oldest to newest).

### On this page

- Common Fields for all Operating Systems
- Additional Fields Supported for z/OS
- Additional Fields Supported for z/VSE
- Additional Fields Supported for BS2000
- Relevant Error Codes
- Field Descriptions
- Default Order of Data Returned