READ-SPOOL

File 12
Op-Sys z/OS, z/VSE
Statement FIND
Task Read SYSOUT from spool. This view retrieves records from JES (z/OS) or POWER (z/VSE ). Use the SPOOL-FILES view to retrieve a list of spool files relating to the specified job before executing READ-SPOOL.

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  
JOB-NAME A8   D Required if JOB-NUMBER is blank.
JOB-NUMBER N7   D Required if JOB-NAME is blank
JOB-ID A8   D Required if JOB-NAME and JOB-NUMBER are blank.
RECORD-NUMBER N7   D  
TYPE A2   D Required.
RECORD-LENGTH N5   D  
RECORD A253   D  
POSITION B1   D  
DATA-SET-KEY N11   D  
SCAN A3   D  
SCAN-LIMIT N7   D  
SCAN-TYPE A1   D  
SCAN-LENGTH N3   D Only relevant if SCAN-TYPE=A.
SCAN-COLUMN-FROM N3   D Only relevant if SCAN-TYPE=A.
SCAN-COLUMN-TO N3   D Only relevant if SCAN-TYPE=A.
TIME-LIMIT N5   D  

Additional Fields Supported for z/OS

Dictionary Field Name F/L Mu DE Remarks
DATA-SET N5   D  
SEGMENT-NUMBER N3   D  
SEGMENT-LENGTH N3   D  

Additional Fields Supported for z/VSE

Dictionary Field Name F/L Mu DE Remarks
CONTROL-RECORDS A3   D  
RECORD-TYPE B1   D This field is only relevant if CONTROL-RECORDS=YES.
INTERNAL-RECORD-NUMBER N7   D  
SEGMENT-NUMBER N3   D  

Relevant Error Codes

Code Text z/OS z/VSE
533 Requested number of records scanned. X X
537 Time limit reached. X X
680 Job/Output is protected.   X
681 Job/Output is active.   X
682 Job/Output not dispatchable.   X
699 GETVIS storage request has failed.   X
711 Logical Error occurred in Common JES Interface. X  
712 Request to Common JES Interface failed. X  
713 Jobname and Job ID missing. One of them required. X  
715 Duplicate jobnames found. Please specify job ID. X  
719 Unable to :1: SYSOUT dataset. X  
720 Invalid type. Must be CC/RD/LS/PU/XM.   X
722 Requested dataset not found. X  
723 Requested job in input queue. X  
724 Requested job not found. X X
728 You are not allowed to see this job. X  
731 Error occurred during spool get. X  
781 Unable to obtain storage for work area extension. X  
830 JES interface is not active. X  
830 POWER interface is not active.   X

Field Descriptions

Field Name Type/Length Operating System
CONTROL-RECORDS (A3) z/VSE

Specifies whether control records are to be returned. Possible options:

Option Explanation
NO Control records are not returned.
YES Default. Control records are returned.
Field Name Type/Length Operating System
DATA-SET (N5) z/OS

Requested dataset number (see also the DATA-SET-KEY field).

Field Name Type/Length Operating System
DATA-SET-KEY (N11) z/OS, z/VSE

Unique dataset identification. This offers much faster access than the dataset number. The dataset key can be obtained using the SPOOL-FILES view.

Field Name Type/Length Operating System
INTERNAL-RECORD-NUMBER (N7) z/VSE

Internal record number as returned by POWER.

Field Name Type/Length Operating System
JOB-NAME (A8) z/OS, z/VSE

Name of job. If you do not specify a job name, you must specify the JOB-NUMBER field.

Field Name Type/Length Operating System
JOB-ID (A8) z/OS, z/VSE

Job number in alphanumeric format.

Field Name Type/Length Operating System
JOB-NUMBER (N7) z/OS, z/VSE

Job number assigned by the spooling system. If you do not specify a job number, you must specify the JOB-NAME field.

Field Name Type/Length Operating System
POSITION (B1) z/OS, z/VSE

Offset in spool record (the RECORD field contains spool record starting at this offset).

Field Name Type/Length Operating System
RECORD (A253) z/OS, z/VSE

Spool record to be searched (see also the POSITION field).

Field Name Type/Length Operating System
RECORD-LENGTH (N5) z/OS, z/VSE

Length of entire spool record (not the segment length).

Field Name Type/Length Operating System
RECORD-NUMBER (N7) z/OS, z/VSE

Relative record number from start of dataset.

Field Name Type/Length Operating System
RECORD-TYPE (B1) z/VSE

Record type of spool record. This field is relevant if CONTROL-RECORDS=YES. This field contains the type of record returned. Possible values:

Option Explanation
X'00'  Normal data record.
X'05'  Control command record.
Field Name Type/Length Operating System
SCAN (A3) z/OS, z/VSE

If you specify YES, the first record which meets the selection criteria and all subsequent records are returned.

Field Name Type/Length Operating System
SCAN-COLUMN-FROM (N3) z/OS, z/VSE

Specifies the column number where the scan is to start. Default is column 1.

Note:
Only relevant if SCAN-TYPE=A.

Field Name Type/Length Operating System
SCAN-COLUMN-TO (N3) z/OS, z/VSE

Specifies the column number where the scan is to end. Default is the end of the record. Only relevant if SCAN-TYPE=A.

Field Name Type/Length Operating System
SCAN-LENGTH (N3) z/OS, z/VSE

Specifies how much of the string in the RECORD field is to be scanned. Only relevant if SCAN-TYPE=A.

Field Name Type/Length Operating System
SCAN-LIMIT (N7) z/OS, z/VSE

Maximum number of records to be scanned before a record is found that matches the search criteria. If this limit is reached and no matching record is found, ERROR-CODE 533 with the appropriate text is returned.

Field Name Type/Length Operating System
SCAN-TYPE (A1) z/OS, z/VSE

Specify A for an absolute search. Note that wildcard symbols (* and _) are then treated as normal characters.

Field Name Type/Length Operating System
SEGMENT-LENGTH (N3) z/OS

Length of segment of spool record. If this field is not specified or zero, only the first segment will be returned, even if the spool record is longer than the RECORD area.

Field Name Type/Length Operating System
SEGMENT-NUMBER (N3) z/OS, z/VSE

Segment number of spool record to be retrieved, if the output is segmented.

z/OS: Segment number within record.

z/VSE: Segment number of spool record to be retrieved, if the output is segmented.

Field Name Type/Length Operating System
TIME-LIMIT (N5) z/OS, z/VSE

Specifies the maximum number of seconds that a record can be scanned. If this limit is exceeded and no match is found, ERROR-CODE 537 is returned.

Field Name Type/Length Operating System
TYPE (A2) z/OS, z/VSE

Spool dataset type. Possible values:

z/OS
AL Read all SM/SO files as one file.
CC Summary of job steps and completion codes.
JL Input JCL.
SI SYSIN data.
SM System messages.
SO SYSOUT data.
z/VSE
CC Summary of job steps and completion codes.
LS List queue.
PU Punch queue.
RD Reader queue.
XM Transmit queue.

Default Order of Data Returned

Records are returned in order from the start of the SYSOUT data set.