SNA NRJE User/Programmer Reference Manual (30292-90006)

Appendix A 221
Parsing Algoithms and User Exit Procedures
Banner Decode Exit Procedure Specification
text from the output data set. If
DataLine
contains a
PDIR,
RecordType
is set to one.
Jobnum
An output byte array (of 4 bytes). This array’s size is
from zero through three ASCII characters.
Jobnum
is
initialized to ASCII blanks prior to each call of the exit
procedure. If successful in decoding the host banner,
the exit procedure is to return the job number in ASCII,
left-justified, padded with blanks if necessary. If the
exit procedure detects a banner indicating the output is
from a “Started Task” (denoted by “STC” in the banner)
or a “Timesharing User” (denoted by “TSU”), the
procedure should indicate a job number consisting of
these ASCII characters: minus, one, blank, and blank.
This indicates that the banner decoding was successful,
but NRJE should not check the Job Log for output
routing information. This is because all “TSU” and
“STC” jobs are unsolicited, and valid output routing
information cannot be found in the Job Log for this job.
Filenum
Output integer parameter (passed by reference).
Used only if the procedure will open the output file for
NRJE rather than return a job number. (If
Jobnum
is
returned as non-blank and
Filenum
is returned as
non-zero,
Jobnum
is ignored and output is routed to
Filenum
.)
Filenum
is initialized to zero by NRJE prior
to each call to the exit procedure.
Action
Output integer.
Action
is initialized to zero by NRJE
prior to each call to the exit procedure. It is read only if
the exit procedure sets a value for
Jobnum
or
Filenum
.
If zero is returned, NRJE writes the saved banner to
the output file. If
Action
is set to any other value,
NRJE will not write the saved banner.
Description
The exit procedure name is specified in the NMMGR Writer Data
screen. A different procedure can be accessed by each logical writer.
Note that the banner decode exit procedure is optional, and need not be
specified unless NRJE’s internal banner decode algorithm and output
routing mechanism are not sufficient.
Refer to “Banner Decode Parsing Algorithms,” earlier in this chapter,
for additional information.
The exit procedure can implement any one of three functions:
1. Provide the host job number by decoding the data set banner. This
enables NRJE to check the Job Log for output disposition
information for the job.