SPOOL-UPDATE

#### Search Results

Search

# SPOOL-UPDATE

File | 13
Op-Sys | z/OS, z/VSE 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 | Alter the status of a specified spool job, for example, change job class, change destination, delete spool job entry.

## 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-NUMBER` | N5 |  | D | z/OS: Required if no `JOB-NAME` or `JOB-ID` is specified. z/VSE: Either `JOB-NUMBER` or `JOB-ID` may be Required if more than one queue entry for `JOB-NAME` exists.
`JOB-ID` | A8 |  | D | z/OS: Required if no `JOB-NAME` or `JOB-NUMBER` is specified. z/VSE: Either `JOB-NUMBER` or `JOB-ID` may be Required if more than one queue entry for `JOB-NAME` exists.
`FUNCTION` | A8 |  | D | Required
`JOB-NAME` | A8 |  | D | z/OS: Required if no `JOB-NUMBER` or `JOB-ID` is specified. z/VSE: Required.
`GROUP-ID` | A20 |  | D |
`CLASS` | A8 |  | D |

## Additional Field Supported for z/OS

Dictionary Field Name | F/L | Mu | DE | Remarks
--- | --- | --- | --- | ---
`JES3-CLASS` | A1 |  |  | Valid for JES3 only.
`JES3-QUEUE` | A4 |  |  | Valid for JES3 only.
`NEW-DESTINATION` | A8 |  | D | Valid only if `FUNCTION=CHANGE`.

## Additional Fields Supported for z/VSE

Dictionary Field Name | F/L | Mu | DE | Remarks
--- | --- | --- | --- | ---
`QUEUE` | A3 |  | D | Required.
`SEGMENT-NUMBER` | N3 |  | D |
`COPIES` | N3 |  | D |
`DISP` | A1 |  | D |
`PRIORITY` | N1 |  | D |
`USER` | A8 |  | D |

## Relevant Error Codes

Code | Text | z/OS | z/VSE
--- | --- | --- | ---
669 | Invalid specification for keyword :1: |  | X
671 | Class missing or invalid. | X |
672 | Segment option requires `JOBNAME/JOBNUMBER`. |  | X
711 | Logical Error occurred in Common JES Interface. | X |
712 | Request to Common JES Interface failed. | X |
714 | Jobname and Job ID missing. One of them required. | X |
715 | Duplicate jobnames found. Please specify Job ID. | X |
723 | Job not in output service. | X |
724 | Requested job not found. | X | X
730 | Unknown error during alter. | X |
778 | Not APF authorized. | X |
820 | Unknown command. | X | X
821 | Job no longer active. | X |
830 | JES interface not active. | X |
830 | POWER interface not active. |  | X
833 | You are not allowed to alter this job. | X |
834 | Command failed, MGCRE RC =:1:. | X |

## Field Descriptions

Field Name | Type/Length | Operating System
--- | --- | ---
`CLASS` | (A1) | z/OS, z/VSE

New job class or output class to be assigned when `FUNCTION=CHANGE` or `RELEASE`.

Field Name | Type/Length | Operating System
--- | --- | ---
`COPIES` | (N3) | z/VSE

Number of copies needed (1 - 255). Valid only if `FUNCTION=CHANGE`.

Field Name | Type/Length | Operating System
--- | --- | ---
`DISP` | (A1) | z/VSE

Disposition needed. Valid only if `FUNCTION=CHANGE`.

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

Command to be executed. Possible options:

Option | Explanation
--- | ---
`CANCEL` | Cancel job.
`CHANGE` | Change one or more spool-queue attributes. For z/OS: `CLASS`, `NEW-DESTINATION`. For z/VSE : `CLASS`, `COPIES`, `DISP`, `NEW-DESTINATION`, `PRIORITY`, `USER`.
`HOLD` | Set job in `HOLD` status.
`RELEASE` | Release job.

Field Name | Type/Length | Operating System
--- | --- | ---
GROUP-ID | (A20) | z/OS, z/VSE

Identification of JES `SYSOUT` group.

Field Name | Type/Length | Operating System
--- | --- | ---
`JES3-CLASS` | (A1) | z/OS

Valid for JES3 only. Specifies the output class of the `SYSOUT` data sets that should be modified.

Field Name | Type/Length | Operating System
--- | --- | ---
`JES3-QUEUE` | (A4) | z/OS

Valid for JES3 only. Specifies the output queue of the `SYSOUT` data sets that should be modified. Possible values are `HOLD` and `WTR`.

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-NAME` | (A8) | z/OS, z/VSE

Name of job.

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

Job number assigned by JES (z/OS) or POWER (z/VSE ).

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

New destination for a given `GROUP-ID`. This `GROUP-ID` may be read using the view `SPOOL-QUEUE`. Valid only if `FUNCTION=CHANGE`.

Field Name | Type/Length | Operating System
--- | --- | ---
`PRIORITY` | (N1) | z/VSE

New priority needed (`0` - `9`). Valid only if `FUNCTION=CHANGE`.

Field Name | Type/Length | Operating System
--- | --- | ---
`QUEUE` | (A3) | z/VSE

Queue in which the job resides. Possible values:

Value | Explanation
--- | ---
`LST` | List queue.
`PUN` | Punch queue.
`RDR` | Reader queue.
`XMT` | Transmit queue.

Field Name | Type/Length | Operating System
--- | --- | ---
`SEGMENT-NUMBER` | (N3) | z/VSE

Segment number of output to be deleted.

Field Name | Type/Length | Operating System
--- | --- | ---
`USER` | (A8) | z/VSE

New user needed. Valid only if `FUNCTION=CHANGE`.

### On this page

- Common Fields for all Operating Systems
- Additional Field Supported for z/OS
- Additional Fields Supported for z/VSE
- Relevant Error Codes
- Field Descriptions