SPOOL-FILES

File 36
Statement FIND / PROCESS
Task 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.


Fields

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.
JOB-NUMBER N7   D  
COPIES N3   D  
FORM A8   D  
CHARS A16   D  
DSNAME A54   D  
CLASS A4   D  
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  

Relevant Error Codes

Code Text
670 Error in subsystem request
671 Invalid NEW-CLASS
711 Logical Error occurred in Common JES Interface.
712 Request to Common JES Interface failed.
713 Jobname and Job ID missing. One of them required.
715 Duplicate jobnames found. Please specify Job ID.
719 Unable to :1: SYSOUT dataset.
720 Invalid TYPE.
722 Dataset not found
724 Requested job not found
728 You are not allowed to see this job
778 Not APF authorized
781 Unable to obtain storage for work area extension.
820 Unknown command
830 JES interface not active
833 You are not allowed to alter this job
876 No NEW-field for CHANGE request.

Field Descriptions

Field Name Type/Length
ACTION (A20)

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
BURST A3

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
COMPACT A8

The symbolic name of a compaction table.

Field Name Type/Length
CHARS (A16)

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

Field Name Type/Length
CLASS (A4)

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

Field Name Type/Length
COPIES (N3)

Number of copies.

Field Name Type/Length
DATA-SET (N5)

Dataset number.

Field Name Type/Length
DATA-SET-KEY (N11)

Dataset key.

Field Name Type/Length
DDNAME (A8)

DDname of this dataset given in the JCL.

Field Name Type/Length
DESTINATION-NODE (N5)

Node number of the destination JES system.

Field Name Type/Length
DESTINATION-REMOTE (N5)

Destination ID on the destination node.

Name of spool output dataset.

Field Name Type/Length
FCB (A4)

Forms control buffer.

Field Name Type/Length
FLASH (A4)

Flash for 3800.

Field Name Type/Length
FORM (A8

Form of the dataset to be printed.

Field Name Type/Length
FORMDEF A6

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

Field Name Type/Length
FUNCTION (A8)

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
GROUP-ID (A20)

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

Field Name Type/Length
HOLD (A3)

Possible values:

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

 

Field Name Type/Length
IDENTIFIER (A44)

Unique identifier for the specified dataset.

Field Name Type/Length
JOB-NAME (A8)

Name of job from job card.

Field Name Type/Length
JOB-NUMBER (N7)

Job number assigned by the spooling system.

Field Name Type/Length
LINECT N3

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

Field Name Type/Length
LRECL (N3)

Record length of the spool file.

Field Name Type/Length
NEW-CLASS (A1)

New class specified with the CHANGE or RELEASE function.

Field Name Type/Length
NEW-DESTINATION (A8)

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

Field Name Type/Length
NEW-FORM (A8)

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

Field Name Type/Length
NEW-USERID A8

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

Field Name Type/Length
NEW-WRITER (A8)

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

Field Name Type/Length
OUTDISP (A8)

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

Field Name Type/Length
PAGEDEF A6

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

Field Name Type/Length
PRINT-MODE A4

Possible values:

  • LINE

  • PAGE

Field Name Type/Length
PROCNAME (A8)

Name of procedure invoked.

Field Name Type/Length
RECFM (A3)

The record format of the spool file.

Field Name Type/Length
RECORD-COUNT (N7)

Number of records in this dataset.

Field Name Type/Length
STEPNAME (A8)

Name of step invoked.

Field Name Type/Length
TRC (A3)

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

Field Name Type/Length
TYPE (A2)

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
UCS A4

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

Field Name Type/Length
WRITER (A8)

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

On this page