NRJE2Submit [ SNA NRJE User/Programmer Reference Manual ] MPE/iX 5.0 Documentation
SNA NRJE User/Programmer Reference Manual
NRJE2Submit
Creates a job input stream on the transmission queue to send to a host
system, and allows the user to specify output destinations for data sets
returning from the job submitted to the host. If you are connected to a
VSE/POWER host system, the output routing capabilities are not available.
Syntax
_________________________________________________________________________
| |
| |
| BA I BA IA IA BA |
| NRJE2Submit (Wsid, NumFiles, FileList, FileLens, SubCode, Name, |
| I I BA BA BA I IA I |
| Pri, Direct, PR, PU, FO, MaxJobs, SpoolList, NumJobs,|
| IA |
| Result ) |
| |
_________________________________________________________________________
Parameters
Wsid An eight-character input byte array. The Wsid parameter identifies
your workstation. It must contain a left-justified alphanumeric name
beginning with a letter. If the workstation identifier is less than
eight characters long, it must be followed by blanks.
NumFiles An integer input variable, from 1 through 40 (required). The
NumFiles parameter indicates the following:
* The number of file names that are in FileList.
* The number of elements in FileLens.
* The number of elements in SubCode.
FileList An input byte array (required). The FileList array contains actual
file designators, formal file designators, or file references for
each file, in sequence, that goes into your job stream. The contents
of the files named in FileList are broken into spool files, with one
host job per spool file.
The format of the FileList is a continuous string of actual or formal
file designators without any delimiters between entries; the length
of each substring is in the FileLens array.
The file designators $NULL, $STDLIST, and $NEWPASS are not allowed in
the FileList.
You must provide sufficient elements for this array. The maximum
length for this array is 3440 bytes (40 files * 86 character maximum
per file reference). The format of a file reference is as follows:
Infile[/LockWord][.GrpName[.AcctName[:Envid]]]
The meanings of the parameters used in this reference are described
in Chapter 3, in the SUBMIT command description.
FileLens An input integer array (required). Each element of the FileLens
array specifies the length in bytes of its corresponding file
identifier in the FileList array; FileLens[i] is from 0 through 86.
The maximum length of the FileLens array is 40 elements, to
accommodate the MPE stacksize for the NRJE intrinsics.
SubCode An input integer array. Each element of the SubCode array
corresponds to a file name in the FileList array. Each SubCode
element must contain one of these values:
* 0 = NRJE should translate the file from ASCII to EBCDIC.
* 2 = NRJE should not translate the file to EBCDIC.
You must use SubCode(i)=0 with Direct=1. Table 5-4, in the
NRJESubmit intrinsic description, shows how the SubCode and Direct
parameters relate to each other.
Name An eight-character input byte array. The Name array provides an
identification for each spool file created (one per host job in your
submitted stream).
The identification in Name must begin with a letter, contain
alphanumeric characters, and be left-justified and blank-filled.
If a blank name is supplied, the spool file is named with the jobname
from your JCL JOB card.
Pri An integer input parameter. The Pri parameter specifies your job
input priority, from 0 through 14; 14 is the highest priority. If
you set Pri=0, the MPE-configured default is used.
Direct An input integer. The Direct parameter, together with the SubCode
element for each FileList entry, indicates translation and
compression.
The settings for Direct are as follows:
* An odd number: your job file is written directly to the MPE
Spooler. Any translation or compression is done during
transmission of the job file to the host.
* An even number: any required translation or compression is done
while copying the files you specified in FileList to the spool
file of your job.
Table 5-4, in the NRJESubmit intrinsic description, shows how the
Direct and SubCode parameters relate to each other.
The three parameters described below (PR, PU, and FO) cannot be used
if you are connected to a VSE/POWER host system.
PR An input byte array of up to eighty-eight characters, left-justified
and blank-filled, with no embedded blanks.
The PR array is used to control standard forms output to the printer
and contains one of these:
* A backreferenced formal file designator preceded by an asterisk
(*fileid).
* The ldev of an MPE output device (a numeric entry).
* An MPE device class name, enclosed in double quotation marks
("DevClass").
* An actual file designator. The file must be built before the job
is submitted.
* An alternate form name used as a key into the Lookup Table. This
designation can be up to eight characters long and must be
delimited by single quotes ('formid').
PU An input byte array of up to eighty-eight characters, left-justified
and blank-filled, with no embedded blanks. The PU array is used to
control standard forms output to the punch stream. It is the same
form as the PR array.
FO An input byte array of up to eighty-eight characters, left-justified
and blank-filled, with no embedded blanks. The FO array is used to
control special forms output for both the printer and punch stream.
It is the same form as the PR array.
MaxJobs An input integer. The MaxJobs parameter specifies the maximum number
of elements to be returned in the SpoolList array.
SpoolList An output integer array. The first NumJobs or MaxJobs (whichever is
less) elements of the SpoolList array contain the MPE spool file
identification numbers of the host jobs (one per spool file)
successfully submitted.
When NRJE2Submit is not successful in submitting a job, the
corresponding element of SpoolList is set to 0 and control is
returned to the caller. The elements before that element in
SpoolList are valid spool file IDs, and elements following it are
undefined. The contents of the Result array more fully describe the
error that occurred.
NumJobs An output integer. The NumJobs parameter specifies the total number
of jobs submitted to the host.
If insufficient room exists in SpoolList to return job numbers of
jobs submitted to the host, then NumJobs is greater than MaxJobs.
Result An eight-element integer output array (required). The Result array
contains error codes that occurred during execution of this
intrinsic.
The first element of the Result array is set to zero if no errors
took place. The structure of the Result array is described in
"Parameters Common to NRJE Intrinsics" in the introduction to this
chapter.
Always test the first element of Result immediately after you call
this intrinsic. If the first element of Result is not zero, test the
other elements of Result to determine the nature of the problem that
has occurred.
Description
Use PR, PU, and FO to specify destinations for data sets returning from
the jobs submitted to the host.
The host jobs contained in the submitted Infiles (and any included ##FD
files) are broken into separate spool files. A list of the spool file
IDs of the jobs is returned to the user.
Console commands can be embedded in the submitted input files, provided
the console commands precede the first JCL JOB card in an input stream.
If the submitter has NM capability, or an embedded command is one of
those allowed to all users (specified in the NMMGR Workstation Data
screen), the console command is passed on as part of the job. Otherwise,
the command is stripped out and an error message is written to $STDLIST
(the remainder of the job is submitted). Console commands embedded
between jobs supplied on a single input stream are not supported.
SIGNOFF card images are stripped from the input stream and a warning
message is written to $STDLIST.
See the SUBMIT command explanation in Chapter 3 for additional
information.
MPE/iX 5.0 Documentation