CONSOLE

File 35
Statement FIND, PROCESS
Task Read operator console or issue console commands.

Relevant Error Codes

Code Text
530 Access denied by Security Facility.
537 Time limit reached.
600 Unknown function.
630 Console not defined or inactive.
750 Invalid operand within operand list.
799 Entire Systems Management Adapter internal error.
809 Subsystem not active.
986 No or not enough space for COMMAND IN MP.

Field Descriptions

Dictionary Field Name Format/

Length/

Desc/

Mu

Description

FUNCTION (A8) Required. Function to be performed.
  D Possible values:
    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.
JOB-ID (A8) Relevant with FUNCTION=DISPLAY, DIS-WTOR.
  D Job number (TSN) of job for which the message was created.
JOB-NAME (A8) Relevant with FUNCTION=WTOR.
  D Only relevant for the function DIS-WTOR or DISPLAY. The job for which the console message was created if the job is still active.
JOB-TYPE (A6) Relevant with FUNCTION=DISPLAY, DIS-WTOR.
  D Only relevant for function DISPLAY and DIS-WTOR. Type of job for which message was created, if this job is still active.
NETTO-TEXT (A253) Relevant with FUNCTION=DISPLAY, DIS-WTOR.
  D 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.
NETTO-TEXT-PART2 (A3) Bytes 254 - 256 of the NETTO-TEXT.
  D  
READ-DIRECTION (A1) Relevant with FUNCTION=DISPLAY.
  D Only relevant for function DISPLAY. Direction for reading console messages. Possible values:
    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.
RECORD-NUMBER (N9) Relevant with FUNCTION=DISPLAY.
  D The number of the console message is returned in this field. If used as input (descriptor), a start position can be given. Possible values:
    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.
REPLY (A80) Relevant with FUNCTION=DIS-WTOR.
  D Only relevant for function WTOR: the operator reply.
REPLY-FLAG (A1) Relevant with FUNCTION=DISPLAY, DIS-WTOR.
    Possible values:
    N Message requires no reply.
    Y Message requires a reply.
REPLY-ID (A8) Relevant with FUNCTION=DIS-WTOR.
  D Only relevant for function DIS-WTOR. The identifier which must be used to reply to a write-to-operator-with-reply.
TEXT (A253) Relevant for function OP-CMD, default length: 80 characters. The command to be entered for function OP-CMD (operator command), default length = 80 characters.
  D  
TEXT-PART2 (A3) Bytes 254 - 256 of the text line.
  D  
TEXT-LENGTH (N3) Relevant for function OP-CMD, maximum value = 120.
  D 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.
     
TIME-STAMP (A8) Time stamp of the console message in format HH:MM:SS.
  D  
TIMX (T) Relevant with FUNCTION=DISPLAY.
  D Time stamp in Natural internal format.
WAIT-TIME (B4) 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.
  D  

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

The functions DISPLAY, DIS-WTOR and OP-CMD require that the UCON interface task of the Entire Systems Management Adapter is active.

Default Order of Data Returned

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