NRJESubmit [ SNA NRJE User/Programmer Reference Manual ] MPE/iX 5.0 Documentation
SNA NRJE User/Programmer Reference Manual
NRJESubmit
Prepares a batch input job stream for transmission to a host system.
NOTE The NRJESubmit intrinsic is documented to provide backward
compatibility with releases of the SNA NRJE product prior to
version A.52.00. Use of the NRJE2Submit intrinsic, available on
version A.52.00 or later, is the preferred method because of the
enhanced capabilities available with that intrinsic.
Syntax
___________________________________________________________________________
| |
| |
| BA I BA IA IA BA I |
| NRJESubmit ( Wsid, NumFiles, FileList, FileLens, SubCode, Name, Pri,|
| I I IA |
| Direct, SpoolNumber, 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
or formal file designators 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
designators without any delimiters between entries. Instead of using
delimiters between substrings, 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). The FileLens array contains the
length in bytes of each file identifier in the FileList array.
Each element of FileLens specifies the length, in bytes, of its
corresponding file identifier in FileList, where 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 with 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 attempt to translate the file from ASCII to
EBCDIC.
You must use SubCode[i]=0 with Direct=1. Table 5-4, in this
intrinsic's 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).
The identification in Name must begin with a letter, contain
alphanumeric characters, and be left-justified with trailing blanks.
See table 5-3, "Use of Name," in the NRJEJobInfo intrinsic
description.
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
entry for each FileList entry, indicates translation and compression.
The settings for Direct are as follows:
* An odd number means your job file is written directly. Any
translation and compression will be done during transmission of
the job file to the host.
* An even number means that 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 this intrinsic's description, shows how the Direct and
SubCode parameters relate to each other.
SpoolNumber An output integer variable. The SpoolNumber variable contains an MPE
spool file identification number of the first host job successfully
submitted with a given NRJESubmit.
When NRJESubmit is not successful in submitting any host job, the
contents of SpoolNumber are undefined.
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
The NRJESubmit intrinsic calls the NRJE2Submit intrinsic to accomplish
the submit process. The call is made with the PR, PU, and FO parameters
blank because NRJESubmit cannot handle output routing. NRJE2Submit
breaks the input stream into spool files on the basis of host jobs (one
spool file per host job), and returns a list of the MPE spool file IDs to
NRJESubmit. NRJESubmit then returns the first spool file ID in that
list.
Console commands may be embedded in the submitted input files. 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 a warning message is written to $STDLIST.
(The remainder of the job is submitted.)
This intrinsic does not transmit your job to the host. Job transmission
takes place after communication is established with the host. See
NRJECONTROL START in the SNA NRJE Node Manager's Guide.
Use the Wsid parameter to identify your workstation. The NumFiles
parameter must specify the number of files that comprise your job input
stream. The FileList, FileLens, and SubCode parameter arrays contain an
entry for each file that goes into the job stream.
You can affect a job stream file you create with NRJESubmit parameters in
these ways:
* Identify your job stream with the Name parameter. Use Name later to
retrieve information about your job stream. If you don't specify a
Name, the host job name as detected by NRJE2Submit is used.
* Specify your job priority in the Pri parameter. The higher the Pri,
the more urgent your job stream. When you use Pri=0 you are
specifying the NRJE configuration default for the workstation.
* Use Direct and the SubCode array together to specify (1) when
translation and compression are to take place: either (a) during
transmission of the job stream spool file to the host, or (b) during
job stream creation, when each of your files is copied to the spool
file; and (2) what type of translation and compression are to take
place.
For example, you would omit translating a file that contains packed
decimal data. Specify that the file has already been translated by
setting its SubCode[i]=2, and setting Direct=0.
Table 5-4. SubCode - Direct Relationship
------------------------------------------------------------------------------------------
| |
| Direct=0 Direct=1 |
| |
| SubCode[i]=0 Translation and No translation and compression take |
| compression take place place when FileList[i] is submitted. |
| when FileList[i] is Translation and compression take place |
| submitted. when a job stream is transmitted. |
| |
| SubCode[i]=2 Compression takes place This combination is illegal for any |
| when FileList[i] is FileList entry. |
| submitted. |
| |
------------------------------------------------------------------------------------------
Test Result to learn the effects of your call to this intrinsic.
Retain the contents of SpoolNumber for use as an input parameter in other
intrinsics, such as NRJEJobInfo.
Text Reference
See the SUBMIT command in Chapter 3, "User Commands."
MPE/iX 5.0 Documentation