WRITE-SPOOL

#### Search Results

Search

# WRITE-SPOOL

File | 203
Statement | `PROCESS`
Task | This view makes it possible to write data directly to spool queues (JES). See also WRITE-SPOOL Programming Notes at the bottom of this view description.

## Fields

Dictionary Field Name | F/L | Mu | DE | Remarks
--- | --- | --- | --- | ---
`ERROR-CODE` | N3 |  |  |
`ERROR-TEXT` | A58 |  |  |
`NODE` | N5 |  | D |
`NODE-NAME` | A16 |  | D |
`SYSTEM-MESSAGE-CODE` | A10 |  |  |
`CONTROL` | A1 |  | D |
`COPIES` | B1 |  | D |
`DESTINATION` | A127 |  | D |
`FORM` | A8 |  | D |
`FUNCTION` | A8 |  | D | Required on last request.
`RECORD` | A253 |  | D | Required.
`RECORD-LENGTH` | N3 |  | D | Required.
`CHARS` | A64 |  | D |
`CLASS` | A1 |  | D |
`DATA-SET-ID` | A54 |  |  |
`DDNAME` | A8 |  |  |
`FCB` | A4 |  | D |
`FLASH` | A4 |  | D |
`FSSDATA` | A127 |  | D |
`HOLD` | A8 |  | D |
`IDENTIFIER` | A8 |  | D | Required if multiple update views are executing in parallel.
`JOB-ID` | A8 |  | D |
`JOB-NUMBER` | N7 |  | D |
`PORTNO` | N5 |  | D |
`PROGRAM` | A8 |  | D |
`PRTOPTNS` | A16 |  | D |
`PRTQUEUE` | A127 |  | D |
`REMOTE-USERID` | A8 |  | D |
`TRC` | A3 |  | D |

## Relevant Error Codes

Code | Text
--- | ---
556 | File is in use.
699 | GETVIS failed.
870 | `RECORD` field not in search buffer.
872 | RECFM not supported.
873 | Record length missing.
874 | `RECORD-LENGTH` > `LRECL`.
883 | Dataset is full.
889 | Permanent I/O error while writing dataset.
900 | Dynamic sysout allocation failed.
901 | Dynamic internal read alloc failed.
991 | Unknown product.
993 | Open error.
998 | Member not found.

## Field Descriptions

Field Name | Type/Length
--- | ---
`CHARS` | (A64)

Four groups of four bytes each, taken from the JCL

    '(CHARS=(AAAA,BBBB,CCCC,DDDD)'

Sixteen groups of four bytes can be specified for RSO printers (maximum 64 bytes).

Field Name | Type/Length
--- | ---
`CLASS` | (A1)

`SYSOUT` class. If omitted, the default class of the Entire System Server node is used.

Field Name | Type/Length
--- | ---
`CONTROL` | (A1)

Carriage control mode:

Value | Explanation
--- | ---
`A` | Position 1 is ASA code.
`I` | `SPACE=I`
`M` | Position 1 is machine code.

Field Name | Type/Length
--- | ---
`COPIES` | (B1)

Number of `SYSOUT` copies.

Field Name | Type/Length
--- | ---
`DATA-SET-ID` | (A54)

Internal dataset name of the `SYSOUT` file (returned after the `CLOSE` function).

Field Name | Type/Length
--- | ---
`DDNAME` | (A8)

The `DDNAME` of the spool file.

Field Name | Type/Length
--- | ---
`DESTINATION` | (A127)

- Remote destination of this dataset.

  May also be specified in the form `'IP:ipaddr'` which may be used by a functional subsystem that can perform Internet Protocol (IP) transmission (for example, IP PrintWay).

Field Name | Type/Length
--- | ---
`FCB` | (A4)

FCB name.

Field Name | Type/Length
--- | ---
`FLASH` | (A4)

Flash for 3800.

Field Name | Type/Length
--- | ---
FORM | (A8)

`SYSOUT` form.

Field Name | Type/Length
--- | ---
`FSSDATA` | (A127)

Specifies data to pass to a functional subsystem (FSS) that controls printing (for example, IP PrintWay). See the documentation for the particular subsystem for additional information.

Field Name | Type/Length
--- | ---
`FUNCTION` | (A8)

Function to be performed. Possible options:

Option | Explanation
--- | ---
blank | Write a record.
`CLOSE` | All records have been written. Specify this on the last request.

Field Name | Type/Length
--- | ---
`HOLD` | (A8)

Possible values:

Value | Explanation
--- | ---
`NO` | The `SYSOUT` dataset is not to be held.
`YES` | The `SYSOUT` dataset is to be held.

Field Name | Type/Length
--- | ---
`IDENTIFIER` | (A8)

Required if multiple update views are executing in parallel, all requests for the same process must have the same identifier.

Field Name | Type/Length
--- | ---
`JOB-ID` | (A8)

Returned for `FUNCTION=CLOSE`.

Job number in alphanumeric format.

Field Name | Type/Length
--- | ---
`JOB-NUMBER` | (N7)

Returned for `FUNCTION=CLOSE`.

Job number.

Field Name | Type/Length
--- | ---
`PORTNO` | (N5)

Specifies the TCP/IP port number at which a functional subsystem (for example, IP Printway) connects to the printer. See the documentation for the particular subsystem for additional information.

Field Name | Type/Length
--- | ---
`PROGRAM` | (A8)

Name of writer program to process this dataset.

Field Name | Type/Length
--- | ---
`PRTOPTNS` | (A16)

Specifies additional print options a functional subsystem can use when printing a `DEST='IP:ipaddr'` routed dataset. See the documentation of the particular subsystem for additional information.

Field Name | Type/Length
--- | ---
`PRTQUEUE` | (A127)

Specifies the name of the target print queue on a remote host system. The `PRTQUEUE` field applies only to datasets processed by a functional subsystem that can perform Internet Protocol (IP) transmission (for example, IP Printway). See the documentation of the particular subsystem for additional information.

Field Name | Type/Length
--- | ---
`RECORD` | (A253)

Record to be written.

Field Name | Type/Length
--- | ---
`RECORD-LENGTH` | (N3)

Length of record.

Field Name | Type/Length
--- | ---
`REMOTE-USERID` | (A8)

User ID for printing at remote destinations.

Field Name | Type/Length
--- | ---
`TRC` | (A3)

Value | Explanation
--- | ---
`YES` | Byte 2 in record used for `CHARS` (3800) (`DCB=OPTCB=J` specified).

User information.

## WRITE-SPOOL Programming Notes

`WRITE-SPOOL` is an `UPDATE` view, that is, data is transmitted from the Natural program (client side) to ESY (server side).

The Entire System Server view `WRITE-SPOOL` returns codes and messages that describe whether the requested operation has been executed successfully or not.

Therefore, the `DEFINE DATA` section of the Natural program should only contain the fields shown in this example:

    1 WRITE-SPOOL VIEW OF WRITE-SPOOL
      2 ERROR-CODE
      2 ERROR-TEXT
      2 SYSTEM-MESSAGE-CODE
      2 SYSTEM-CODE

These fields in `DEFINE DATA` statement are the fields returned from the `WRITE-SPOOL` view in Entire System Server to the calling Natural program.

Defining other fields in DDM is not critical, but the access to these fields may lead to unpredictible results.

### On this page

- Fields
- Relevant Error Codes
- Field Descriptions
- WRITE-SPOOL Programming Notes