SPOOL-FILES

File 36
Op-Sys z/OS, BS2000
Statement FIND / PROCESS
Task z/OS: Returns a list of all spool files relating to a specific job.

We also recommend to use this view to determine which fields exist for a job before using the READ-SPOOL view.

BS2000: Displays information concerning a print job.

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 for z/OS.
JOB-NUMBER N7   D Required for BS2000 if JOB-ID is not supplied.
COPIES N3   D  
FORM A8   D  
CHARS A16   D  
DSNAME A54   D  
CLASS A4   D  

Additional fields Supported for z/OS

Dictionary Field Name F/L Mu DE Remarks
TYPE A2   D  
DESTINATION-NODE N5   D  
DESTINATION-REMOTE N5   D  
RECORD-COUNT N7   D  
FCB A4   D  
WRITER A8   D  
FLASH A4   D  
PROCNAME A8   D  
STEPNAME A8   D  
DDNAME A8   D  
DATA-SET N5   D  
HOLD A3   D  
ACTION A20   D  
NEW-CLASS A1   D Relevant with FUNCTION=CHANGE, RELEASE.
GROUP-ID A20   D Valid for JES2 only.
FUNCTION A8   D  
RECFM A3   D  
LRECL N3   D  
TRC A3   D  
DATA-SET-KEY N11   D  
NEW-DESTINATION A8   D Relevant with FUNCTION=CHANGE.
NEW-FORM A8   D Relevant with FUNCTION=CHANGE.
NEW-WRITER A8   D Relevant with FUNCTION=CHANGE.
OUTDISP A6   D Valid for JES2 only.
IDENTIFIER A44   D  
NEW-USERID A8   D Relevant with FUNCTION=CHANGE.
BURST A3   D  
COMPACT A8   D  
LINECT N3   D  
UCS A4   D  
PRINT-MODE A4   D  
PAGEDEF A6   D  
FORMDEF A6   D  

Additional fields Supported for BS2000

Dictionary Field Name F/L Mu DE Remarks
CONTROL-OPTION A16      
DESTINATION A8      
DEVICE A8      
FORM-OVERLAY-BUFFER A8      
FORM-OVERLAY-BUFFER-SIZE N3      
NUMBER-OF-PRINTED-LINES N6      
NUMBER-OF-PRINTED-PAGES N6      
ORIGINATOR-JOB-ID A8      
ORIGINATOR-TSN N5      
PRINT-ELEMENT A64      
PRINT-ELEMENT-TYPE A8      
PRINT-ELEMENT-VERSION A24      
PRINT-ERROR-MESSAGE A10      
PRIORITY N3      
ROTATION A8      
SIZE A6      
STATUS A9      
TYPE-NUMBER N1      
USER A8      
DIA A2      
JOB-ID A8   D Required if JOB-NUMBER is not supplied.

Relevant Error Codes

Code Text z/OS BS2000
670 Error in subsystem request X  
671 Invalid NEW-CLASS 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.  X  
722 Dataset not found X  
724 Requested job not found X X
728 You are not allowed to see this job X X
778 Not APF authorized X  
781 Unable to obtain storage for work area extension. X  
799 Entire System Server internal error   X
820 Unknown command X  
830 JES interface not active X  
833 You are not allowed to alter this job X  
876 No NEW-field for CHANGE request. X  
988 Invalid task type detected   X

Field Descriptions

Field Name Type/Length Operating System
ACTION (A20) z/OS

If the FUNCTION field value was DELETE, CHANGE or RELEASE, the result of the command is returned in this field. If only one dataset is processed, the result is also returned in the field ERROR-TEXT.

Field Name Type/Length Operating System
BURST A3 z/OS

Possible values:

  • YES: Printed output is to be burst into separate sheets.

  • NO:  Printed output is to be in a continuous fanfold.

Field Name Type/Length Operating System
COMPACT A8 z/OS

The symbolic name of a compaction table.

Field Name Type/Length Operating System
CHARS (A16) z/OS, BS2000

Four groups of four bytes each taken from JCL: (CHARS=AAAA,BBBB,CCCC,DDDD).

Field Name Type/Length Operating System
CLASS (A4) z/OS, BS2000

Output class. For valid classes, ask your system programmer.

Field Name Type/Length Operating System
CONTROL-OPTION (A16) BS2000

CONTROL parameter of spool-out job.

Field Name Type/Length Operating System
COPIES (N3) z/OS, BS2000

Number of copies.

Field Name Type/Length Operating System
DATA-SET (N5) z/OS

Dataset number.

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

Dataset key.

Field Name Type/Length Operating System
DDNAME (A8) z/OS

DDname of this dataset given in the JCL.

Field Name Type/Length Operating System
DESTINATION (A8) BS2000

Name of device pool.

Field Name Type/Length Operating System
DESTINATION-NODE (N5) z/OS

Node number of the destination JES system.

Field Name Type/Length Operating System
DESTINATION-REMOTE (N5) z/OS

Destination ID on the destination node.

Field Name Type/Length Operating System
DEVICE (A8) BS2000

Output device.

Field Name Type/Length Operating System
DIA (A2) BS2000

Name of slide for laser printer.

Field Name Type/Length Operating System
DSNAME (A54) z/OS, BS2000

Name of spool output dataset. In BS2000: name of printed file.

Field Name Type/Length Operating System
FCB (A4) z/OS

Forms control buffer.

Field Name Type/Length Operating System
FLASH (A4) z/OS

Flash for 3800.

Field Name Type/Length Operating System
FORM (A8 z/OS, BS2000

Form of the dataset to be printed.

Field Name Type/Length Operating System
FORMDEF A6 z/OS

Name of library member containing statements to specify forms properties for Print Services Facility (PSF).

Field Name Type/Length Operating System
FORM-OVERLAY-BUFFER (A8 BS2000

Name of form overlay buffer.

Field Name Type/Length Operating System
FORM-OVERLAY-BUFFER-SIZE (N3) BS2000

Size of form overlay buffer.

Field Name Type/Length Operating System
FUNCTION (A8) z/OS

Function to be performed on the spool file(s). Only JES SYSOUT data sets (TYPE SM or SO) can be deleted, changed or released. Spool data sets of TYPE JL or SI are not SYSOUT data sets and can only be displayed.

Possible options:

Option Explanation
blank  Display information.
DELETE  Delete file(s).
CHANGE  Change output class.
RELEASE  Release from HOLD and, if NEW-CLASS is specified, also change output class (only possible for files in HOLD).
Field Name Type/Length Operating System
GROUP-ID (A20) z/OS

Output group id for SYSOUT data set (returned for JES2 only).

Field Name Type/Length Operating System
HOLD (A3) z/OS

Possible values:

Value Explanation
NO  Dataset is not held.
YES  Dataset is held.

 

Field Name Type/Length Operating System
IDENTIFIER (A44) z/OS

Unique identifier for the specified dataset.

Field Name Type/Length Operating System
JOB-ID (A8) BS2000

TSN of job.

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

Name of job from job card.

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

Job number assigned by the spooling system.

Field Name Type/Length Operating System
LINECT N3 z/OS

The maximum number of lines JES2 is to print on each page.

Field Name Type/Length Operating System
LRECL (N3) z/OS

Record length of the spool file.

Field Name Type/Length Operating System
NEW-CLASS (A1) z/OS

New class specified with the CHANGE or RELEASE function.

Field Name Type/Length Operating System
NEW-DESTINATION (A8) z/OS

New destination for a SYSOUT dataset. Relevant with FUNCTION=CHANGE.

Field Name Type/Length Operating System
NEW-FORM (A8) z/OS

New form for SYSOUT dataset. Relevant with FUNCTION=CHANGE.

Field Name Type/Length Operating System
NEW-USERID A8 z/OS

New user ID for SYSOUT dataset. Relevant with FUNCTION=CHANGE.

Field Name Type/Length Operating System
NEW-WRITER (A8) z/OS

New writer program name for SYSOUT dataset. Relevant with FUNCTION=CHANGE.

Field Name Type/Length Operating System
NUMBER-OF-PRINTED-LINES (N6) BS2000

 Number of printed lines.

Field Name Type/Length Operating System
NUMBER-OF-PRINTED-PAGES (N6) BS2000

 Number of printed pages.

Field Name Type/Length Operating System
ORIGINATOR-JOB-ID (A8) BS2000

TSN of originator task.

Field Name Type/Length Operating System
ORIGINATOR-TSN (N5) BS2000

TSN of originator task.

Field Name Type/Length Operating System
OUTDISP (A8) z/OS

Output disposition for SYSOUT data set (returned for JES2 only). Possible values are WRITE, HOLD, KEEP, LEAVE and PURGE.

Field Name Type/Length Operating System
PAGEDEF A6 z/OS

Name of library member containing statements to specify page properties for Print Services Facility (PSF).

Field Name Type/Length Operating System
PRINT-ELEMENT (A64) BS2000

Name of printed element.

Field Name Type/Length Operating System
PRINT-ELEMENT-TYPE (A8) BS2000

Type of printed element.

Field Name Type/Length Operating System
PRINT-ELEMENT-VERSION (A24) BS2000

Version of printed element.

Field Name Type/Length Operating System
PRINT-ERROR-MESSAGE (A10) BS2000

Error message issued during PRINT. Only relevant for task type 7.

Field Name Type/Length Operating System
PRINT-MODE A4 z/OS

Possible values:

  • LINE

  • PAGE

: 

: 

Field Name Type/Length Operating System
PRIORITY (N3) BS2000

Task scheduling priority.

Field Name Type/Length Operating System
PROCNAME (A8) z/OS

Name of procedure invoked.

Field Name Type/Length Operating System
RECFM (A3) z/OS

The record format of the spool file.

Field Name Type/Length Operating System
RECORD-COUNT (N7) z/OS

Number of records in this dataset.

Field Name Type/Length Operating System
ROTATION (A8) BS2000

Used page rotation.

Field Name Type/Length Operating System
SIZE (A6) BS2000

Size of SPOOLOUT file.

Field Name Type/Length Operating System
STATUS (A9) BS2000

Task status (category).

Field Name Type/Length Operating System
STEPNAME (A8) z/OS

Name of step invoked.

Field Name Type/Length Operating System
TRC (A3) z/OS

YES means byte 2 in record is used for CHARS (3800). (DCB=OPTCD=J is specified).

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

Spool file type. Possible options:

Option Explanation
CC  Summary of job steps and completion codes.
JL  Input JCL.
SI  SYSIN data.
SM  System messages.
SO  SYSOUT data.
Field Name Type/Length Operating System
TYPE-NUMBER (N1) BS2000

Task type.

Field Name Type/Length Operating System
UCS A4 z/OS

The universal character set (UCS) image JES is to use in printing the sysout dataset.

Field Name Type/Length Operating System
USER (A8) BS2000

User ID.

Field Name Type/Length Operating System
WRITER (A8) z/OS

External writer program which gets control if the dataset is printed.

Example 1:

This little program displays a list of spool files for the job WKKC: 

  FIND SPOOL-FILES WITH JOB-NAME = 'WKKC'
  DISPLAY TYPE DATA-SET-KEY DDNAME STEPNAME WRITER FCB RECFM LRECL TRC
  END

Output from the above program: 

  TYPE DATA-SET-KEY  DDNAME     STEPNAME   WRITER  FCB  RECFM LRECL  TRC
  ---- ------------  -------    --------  -------  ---  ----- -----  ---

  JL           1      $JCL                         ****   F      80   NO
  SM           2      $JES2LOG  JES2               ****   UA    133   NO
  SM           3      $JCLIMG   JES2               ****   F     132   NO
  SM           4      $SYSMSGS  JES2               ****   VA    133   NO
  SI         101      SYSIN     COPY               ****   F      80   NO
  SO         102      SYSPRINT  COPY               ****   FBA   121   NO

Example 2:

The following program deletes from HOLD class system message file number 1 (dataset key 2), and displays the message returned. 

  PROCESS SPOOL-FILES USING JOB-NAME     =  'WKKASM'
                         '  DATA-SET-KEY =  2
                         '  FUNCTION     = 'DELETE'
  DISPLAY ACTION
  END

Output from the above program: 

          Action
  ---------------------------
  DELETE    OK