SUBMIT

#### Search Results

Search

# SUBMIT

File | 200
Op-Sys | z/OS, z/VSE, BS2000 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 | `PROCESS`
Task | This view allows you or a program to submit a job to the operating system. The job to be submitted can reside on disk or in storage. For BS2000, the job can also be a library element (LMS). It is also possible to pass the job's JCL to the Entire System Server on a card-by-card basis. See also SUBMIT Programming Notes at the bottom of this view description.

## 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 |
`SYSTEM-MESSAGE-CODE` | A10 |  |  |
`CARD` | A80 |  | D | Required if no `DSNAME` / `MEMBER` is given.
`JOB-NUMBER` | N7 |  | D |
`JOB-ID` | A8 |  | D |
`DSNAME` | A54 |  | D | Required if no `CARD` is given.
`PASSWORD` | A8 |  | D | Not for z/VSE
`FUNCTION` | A8 |  | D | Required for the last submit request.
`IDENTIFIER` | A8 |  | D | Required with multiple parallel submit calls.
`JOB-NAME` | A8 |  | D |

## Additional Fields Supported for z/OS

Dictionary Field Name | F/L | Mu | DE | Remarks
--- | --- | --- | --- | ---
`FROM-NODE` | N5 |  | D |
`FROM-USERID` | A8 |  | D |
`FROM-USER-PASSWORD` | A32 |  | D |
`MEMBER` | A10 |  | D | Required
`GENERATION` | N9 |  | D |
`VOLSER` | A6 |  | D | Required only if dataset is not cataloged.
`PRODUCT` | A1 |  | D |
`OPTIONS` | A8 |  | D |

## Additional Fields Supported for z/VSE

Dictionary Field Name | F/L | Mu | DE | Remarks
--- | --- | --- | --- | ---
`JOB-NAME` | A8 |  | D |
`FROM-NODE` | N3 |  | D |
`MEMBER` | A10 |  | D | Required.
`VOLSER` | A6 |  | D | Required only if file not known to Entire System Server.
`LIBRARY` | A8 |  | D | Required.
`SUB-LIBRARY` | A8 |  | D | Required.
`MEMBER-TYPE` | A8 |  | D | Required.
`TARGET-NODE-NAME` | A8 |  | D |
`TARGET-USER-REMOTE-ID` | A8 |  | D |
`VSAM-CATALOG` | A8 |  | D | Required if VSAM-controlled Librarian file.

## Additional Fields Supported for BS2000

Dictionary Field Name | F/L | Mu | DE | Remarks
--- | --- | --- | --- | ---
`SYSTEM-CODE` | B2 |  |  |
`PRODUCT` | A1 |  | D |
`ELEMENT` | A64 |  | D |
`ELEMENT-PASSWORD` | A8 |  | D |
`USERID` | A8 |  | D |
`ACCOUNT-NUMBER` | A8 |  | D |
`TIME` | A5 |  | D |
`ERASE-AFTER-RUN` | A3 |  | D |
`MONITOR-JOB-VARIABLE` | A54 |  | D |
`JOB-VARIABLE-PASSWORD` | A4 |  | D |
`USER-PASSWORD` | A32 |  | D |
`JOB-CLASS` | A8 |  | D |
`JOB-PRIORITY` | A3 |  | D |
`RUN-PRIORITY` | A3 |  | D |
`START-OPTION` | A17 |  | D |
`START-DATE` | A8 |  | D |
`START-TIME` | A5 |  | D |
`START-DATX` | D |  | D |
`START-TIMX` | T |  | D |
`REPEAT-OPTION` | A17 |  | D |
`REPEAT-TIME` | A5 |  | D |

## Relevant Error Codes

Code | Text | z/OS | z/VSE | BS2000
--- | --- | --- | --- | ---
500 | VSAM error. | X |  |
530 | Access denied by Security Facility. |  |  | X
531 | Password missing or incorrect. |  |  | X
556 | File is in use. |  |  | X
565 | Syntax error in dataset name. |  |  | X
692 | You are not permitted to access member. |  |  | X
699 | GETVIS failed. | X | X |
701 | `DSNAME` missing. |  |  | X
732 | Account number missing. |  |  | X
733 | User ID does not exist. |  |  | X
756 | Job variable name missing or invalid. |  |  | X
758 | User ID is missing. |  |  | X
772 | Requested dataset not found. |  |  | X
798 | Task was not started under TSOS. |  |  | X
799 | Entire System Server internal error. |  |  | X
856 | Operator unable to mount volume. |  |  | X
883 | Dataset is full. |  |  | X
889 | Permanent I/O error while writing dataset. |  |  | X
899 | I/O error during read. | X |  |
901 | Alloc of reader failed. | X | X |
902 | Dynamic alloc failed. | X | X |
903 | Dynamic allocation failed for temporary dataset. |  |  | X
909 | Syntax error in JCL command. |  |  | X
991 | Unknown product. |  |  | X
992 | Requested job variable not found. |  |  | X
993 | `OPEN` error. | X | X | X
998 | Member not found. |  |  | X

## Field Descriptions

Field Name | Type/Length | Operating System
--- | --- | ---
`ACCOUNT-NUMBER` | (A8) | BS2000

Account number for the job.

Field Name | Type/Length | Operating System
--- | --- | ---
`CARD` | (A80) | z/OS, z/VSE, BS2000

JCL record to be sent from Natural to the internal reader.

Field Name | Type/Length | Operating System
--- | --- | ---
`DSNAME` | (A54) | z/OS, z/VSE, BS2000

Fully qualified dataset or file name containing the JCL to be submitted. To perform the submit, a second `SUBMIT` request with `FUNCTION=CLOSE` is required.

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

Element from which cards are to be submitted.

Field Name | Type/Length | Operating System
--- | --- | ---
`ELEMENT-PASSWORD` | (A8) | BS2000

Password for protected LMS element (LMS V2 or above).

Field Name | Type/Length | Operating System
--- | --- | ---
`ERASE-AFTER-RUN` | (A3) | BS2000

Value | Explanation
--- | ---
`NO` | Do not erase Enter file after run.
`YES` | Erase Enter file after run.

Field Name | Type/Length | Operating System
--- | --- | ---
`FROM-NODE` | (N5) | z/OS, z/VSE

Entire System Server node on which the JCL for the job is to be read. Ignored if it matches the `USING` node or the node where the user is already logged in.

Field Name | Type/Length | Operating System
--- | --- | ---
`FROM-USERID` | (A8) | z/OS

User ID in the `FROM-NODE`.

Field Name | Type/Length | Operating System
--- | --- | ---
`FROM-USER-PASSWORD` | (A32) | z/OS

User password in the `FROM-NODE`.

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

Function to be performed. Possible options:

Option | Explanation
--- | ---
blank | Default. Pass a JCL card or the name of the dataset or member/element to be submitted to the Entire System Server.
`CLOSE` | All cards have been processed - perform the submit. You must specify this function for the last `SUBMIT` request.

Field Name | Type/Length | Operating System
--- | --- | ---
`GENERATION` | (N9) | z/OS

Generation number of member (only valid for PDSE version 2 with MAXGENS > 0).

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

Required if multiple submit calls are executing in parallel, as requests for the same job to be submitted must have the same identifier.

Field Name | Type/Length | Operating System
--- | --- | ---
`JOB-CLASS` | (A8) | BS2000

Name of the job class where the job is to run.

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

Same as `JOB-NUMBER`, only in alpha format.

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

Name of job to be submitted.

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

This field is returned after a call with `FUNCTION=CLOSE`.

z/OS & z/VSE: | Job number assigned by the JES (z/OS) or POWER (z/VSE ). If `JOB-NUMBER=0`, no valid job card was sent.
BS2000: | This field contains the TSN of the submitted job, if the TSN is numeric. In case of error, the field contains 0.

Field Name | Type/Length | Operating System
--- | --- | ---
`JOB-PRIORITY` | (A3) | BS2000

Scheduling priority for a job. Possible values are between `9` and the maximum of the job class, or `STD`. `STD` is the default.

Field Name | Type/Length | Operating System
--- | --- | ---
`JOB-VARIABLE-PASSWORD` | (A4) | BS2000

Password for protected monitoring job variable.

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

Name of library.

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

Name of member that contains the JCL to be submitted.

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

Member type.

Field Name | Type/Length | Operating System
--- | --- | ---
`MONITOR-JOB-VARIABLE` | (A54) | BS2000

Specifies the name of a monitoring job variable that always contains the job status:

Job Status | Explanation
--- | ---
`$A` | Job abended.
`$R` | Job is running.
`$S` | Job is in input queue.
`$T` | Job terminated normally.

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

Specify `X` to expand all `++INCLUDE` statements.

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

Password for protected dataset.

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

Access method for dataset containing the JCL. Possible options:

Option | Explanation
--- | ---
`L` | CA-Librarian
`M` | LMS (BS2000)
`P` | CA-Panvalet

Field Name | Type/Length | Operating System
--- | --- | ---
`REPEAT-OPTION` | (A17) | BS2000

Specifies repeated job runs. Possible options:

Option | Explanation
--- | ---
`AT-STREAM-STARTUP` | Job is repeated at every scheduler startup.
`DAILY` | Job runs daily.
`NO` | Job is not repeated.
`PERIOD` | Specifies time interval for repeat runs.
`STD` | Default. Take the job class default.
`WEEKLY` | Job runs weekly.

Time given in `REPEAT-TIME`.

Field Name | Type/Length | Operating System
--- | --- | ---
`REPEAT-TIME` | (A5) | BS2000

Specifies time for repeat runs (see `REPEAT-OPTION`).

Field Name | Type/Length | Operating System
--- | --- | ---
`RUN-PRIORITY` | (A3) | BS2000

Priority during job execution. The value can be between job class maximum and `255`, or `STD`. `STD` is the default and is also used if the `RUN-PRIORITY` value is invalid.

Field Name | Type/Length | Operating System
--- | --- | ---
`START-DATE` | (A8) | BS2000

Start date value in format `YY-MM-DD`.

Field Name | Type/Length | Operating System
--- | --- | ---
`START-DATX` | (D) | BS2000

Start date in Natural format.

Field Name | Type/Length | Operating System
--- | --- | ---
`START-OPTION` | (A17) | BS2000

Specifies start of job. Possible options:

Option | Explanation
--- | ---
`AT` | Start at given time and/or date.
`AT-STREAM-STARTUP` | Start job at the start of the scheduler.
`EARLIEST` | Do not start before this date and/or time.
`IMMEDIATELY` | Start now.
`LATEST` | Do not start after this date and/or time.
`SOON` | As soon as possible.
`STD` | Default. Use job class default.
`WITHIN` | Specifies a time range.

The starting date and/or time are given in the fields `START-DATE` and `START-TIME`.

Field Name | Type/Length | Operating System
--- | --- | ---
`START-TIME` | (A5) | BS2000

Start time value in format `HH`:`MM`.

Field Name | Type/Length | Operating System
--- | --- | ---
`START-TIMX` | (T) | BS2000

Start time in Natural format.

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

Name of sublibrary.

Field Name | Type/Length | Operating System
--- | --- | ---
`TARGET-NODE-NAME` | (A8) | z/VSE

Name of the node to which the POWER output is to be spooled.

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

Name of the user/remote to which the POWER output is to be spooled.

Field Name | Type/Length | Operating System
--- | --- | ---
`TIME` | (A5) | BS2000

Maximum CPU time the job may consume. Possible values:

Value | Explanation
--- | ---
`t` | Time value in seconds
`NTL` | No Time Limit
`STD` | Default. As defined in the job class.

Field Name | Type/Length | Operating System
--- | --- | ---
`USERID` | (A8) | BS2000

User ID under which the job is to be submitted.

Field Name | Type/Length | Operating System
--- | --- | ---
`USER-PASSWORD` | (A32) | BS2000

Password belonging to the user ID under which the job is to be started.

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

Volume serial number. Required only if the dataset is not cataloged.

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

Name of VSAM catalog where the library is kept.

## SUBMIT Programming Notes

`SUBMIT` is an `UPDATE` view, i.e., data is transmitted from the Natural program (client side) to ESY (server side).

The Entire System Server view `SUBMIT` returns codes and messages that describe whether the requested operation has been executed successfully or not, and the `JOB-NUMBER` of a submitted job.

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

    1 SUBMIT VIEW OF SUBMIT

      2 ERROR-CODE
      2 ERROR-TEXT
      2 SYSTEM-MESSAGE-CODE

      2 SYSTEM-CODE
      2 JOB-NUMBER

These fields in `DEFINE DATA` are the fields returned from the `SUBMIT` view in Entire System Server to the calling Natural program.

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

#### BS2000

If system is configured to work with encrypted passwords (class 2 system parameter `ENCRYPT`), the Entire System Server requires startup parameter `JOBENT=YES` to submit jobs for password protected users. Class 2 system parameter `SVC79` must be enabled also.

### On this page

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