Output files to tape
Component: | SPOOL |
Functional area: | Controlling spoolout job |
Domain: | SPOOL-PRINT-ADMINISTRATION |
Privileges: | STD-PROCESSING |
Routing code: | $ |
Function
The system creates a separate spoolout job which runs independently of the job issuing the command (own TSN). A SAM tape file with standard labels is generated as the output file and is assigned the following name:
{ S.tsn. / S.pname. } { [hhmmss.]filename / EAMno }
where:
S.tsn. | tsn is the task sequence number of the SPOOL job |
S.pname. | job name if the SPOOLOUT-NAME operand is specified |
filename | name of the cataloged input file |
hhmmss. | time of day if several files are output under the same job and file names |
EAMno | EAM file number if SYSLST or SYSOUT has been specified as the input file. |
SPOOL creates an MF set (multifile tape) if
a tape containing more than one file
file generations
partially qualified file names
are to be output. This tape file can be output to a printer by means of PRINT-DOCUMENT; it cannot be output to tape.
Format
WRITE-SPOOL-TAPE | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Operands
FILE-NAME = *LIBRARY-ELEMENT(...) / list-poss(16): *SYSLST-NUMBER(...) / *OMF / *SYSLST / *SYSOUT / <filename 1..54 with-wild(80)> / <integer 1..65535>
Names of the files to be output.
FILE-NAME = *LIBRARY-ELEMENT(...)
The specified element is to be output from a PLAM library. An element is fully defined by its name, its type and its version.
Notes
Access to the directory of the library is executed via command validation, i.e. you must have access authorization for the library at this time; otherwise, the command is rejected.
The library which contains the elements to be output cannot be locked until the spoolout job is executed.
A global setting LOCK-FILE = *YES in the SPOOL parameter file (MODIFY-SPOOL-PARAMETERS) is ignored.- PAM elements of element type X cannot be processed.
LIBRARY = <filename 1..54 without-gen>
The name of the PLAM library from which an element is to be output.
ELEMENT = <composed-name 1..64 with-under with-wild(80)
The name of the element which is to be output from the specified PLAM library.
VERSION = *HIGHEST-EXISTING / *UPPER-LIMIT / <composed-name 1..24 with-under with-wild(40)>
The version of the element which is to be output. Default is *HIGHEST-EXISTING, i.e. the last element in alphabetical order.
If the version is specified in wildcard format, and if there are library elements with the same names to which the wildcard specification applies, then all of these library elements are output.
TYPE = <alphanum-name 1..8 with-wild(12)>
The type of the library element to be output.
CREATION-DATE =
The creation date with which elements are selected for output.
CREATION-DATE = *LATEST
By default, the last library element created is output.
CREATION-DATE = *RANGE(...)
Library elements created within the specified time range are to be output.
FROM = *FIRST / <date>
Specifies the first day of the possible creation period for the library element.
By default, FIRST is assumed, i.e. the creation date of the library element which was created first.
TO = *LAST / <date>
Specifies the last day of the possible creation period for the library element.
By default, LAST is assumed, i.e. the creation date of the library element which was created last.
Note
If the two digits for the century are not specified, the following defaults are used:
- 19 if the last two digits of the year number lie between 50 and 99;
20 in all other cases.
FROM = *FIRST / <time> CREATION-DATE = <date>(...)
The date on which the desired library elements were created.
The earliest time of day at which elements in the specified library must have been created in order to be printed.
The default is FIRST, i.e. 00:00:00 hours.
TO = *LAST / <time>
The latest time of day at which elements in the specified library must have been created in order to be output.
The default is LAST, i.e. 23:59:59 hours.
FILE-NAME = *OMF
Specifies the temporary EAM object module file of the current job. The following defaults apply to this job:
OMF is not locked (LOCK-FILE=*NO)
OMF is deleted after execution of the output (DELETE-FILE=*YES).
The temporary EAM object module file *OMF may be combined in any manner with the system files SYSLST and SYSOUT in one WRITE-SPOOL-TAPE command, for example, WRITE-SPOOL-TAPE (*OMF,*SYSLST,*SYSOUT). It must not, however, be combined with an EAM file number or a cataloged file.
FILE-NAME = *SYSLST
Outputs the SYSLST system file. Unless otherwise specified, the following points apply to output:
SYSLST is not locked (LOCK-FILE=*NO)
SYSLST is deleted at the end of output (DELETE-FILE=*YES).
System file SYSLST may be combined in any sequence with the temporary EAM object module file *OMF and system file SYSOUT in a WRITE-SPOOL-TAPE command, e.g. WRITE-SPOOL-TAPE (*OMF,*SYSLST,*SYSOUT). It must not, however, be combined with an EAM file number or a cataloged file.
FILE-NAME = *SYSLST-NUMBER(...)
Specifies system file SYSLST-nn.
SYSLST-NUMBER = <integer 1..99>
Two-digit number nn to be used to form the SYSLSTnn file name. A maximum of 11 different SYSLSTnn system files can be specified in a list (in parentheses and separated by commas). All the specified operand values then apply to each of these system files.
FILE-NAME = *SYSOUT
Outputs system file SYSOUT.
System file SYSOUT may be combined in any sequence with the temporary EAM object module file *OMF and system file SYSLST in the same WRITE-SPOOL-TAPE command, e.g. WRITE-SPOOL-TAPE (*OMF,*SYSLST,*SYSOUT).
It must not, however, be combined with an EAM file number or a cataloged file.
FILE-NAME = <filename 1..54 with wild(80)>
Name of the file to be output to tape.
PAM files must not be specified in batch mode.
The WRITE-SPOOL-TAPE command is rejected if the specified file
is a newly cataloged file to which no data has yet been written
has already been opened in output mode
If the file does not belong to the user's own user ID, read access must be allowed (see the SHOW-FILE-ATTRIBUTES command).
The following points should be noted in connection with the output of cataloged files:
A spoolout job is generated even if the file to be output is reserved by a SECURE-RESOURCE-ALLOCATION command. However, this reservation must be canceled before the spoolout job is processed, otherwise, the job cannot be executed. The file to be output is locked until the end of the session the operand LOCK-FILE=*YES was specified in the WRITE-SPOOL-TAPE command and the job could not be executed because of the reservation.
The *OMF, *SYSLST and *SYSOUT files cannot be specified together with a cataloged file in a spoolout job.
FILE-NAME = <integer 1..65535>
Number of the EAM file to be output. See also the PRINT-DOCUMENT command.
START-SPOOL =
Determines when the *SYSLST file is to be output before the end of the job.
START-SPOOL = *IMMEDIATE
The spoolout job is to be generated and processed immediately after the command is entered.
START-SPOOL = *CLOSE
The spoolout job is to be processed immediately after the system file is closed. A system file is closed:
for a primary assignment: by an EXIT-JOB (or LOGOFF) command or by CANCEL-JOB (from another ID), i.e. at the end of the job
- if assigned to a cataloged file:
- by an EXIT-JOB (or LOGOFF) command or by CANCEL-JOB (from another ID), i.e. at the end of the job
by another ASSIGN-SYSFILE command (change of assignment) issued for the same system file
in a procedure run after procedure level 0 has been reached.
START-SPOOL = *NO
Any previously defined CLOSE option is canceled. Any other operands are rejected.
MONJV =
Specifies the job variable in which information on job processing is to be stored. See also the PRINT-DOCUMENT command.
MONJV = *NONE
No job variable is to be linked to the job.
MONJV = *STD
The job variable will be given the name of the file to be printed (without catalog ID and without user ID). It is created under the user ID and catalog ID of the caller.
MONJV = <filename 1..49 without-gen-vers>
The job variable should contain the specified name. If the job contains several files, the following suffix is added to the name of the job variable:
a consecutive number <1..9999> if FAMILY=*YES is also specified;
the TSN of the spoolout job if FAMILY=*NO or START-SPOOL=<integer 1..2147483639> is also specified.
JV-PASSWORD = *NONE / <c-string 1..4> / <x-string 1..8> / *SECRET
Specifies the password with which the job variable is protected.
See also the PRINT-DOCUMENT command.
LOCK-FILE = *STD / *YES / *NO
Locks the files so that changes cannot be made until the end of output. This protection remains in force while the spoolout job is in the job queue (T4); the file is automatically protected during output (T5) (even if LOCK-FILE=*NO is specified).
LOCK-FILE = *STD
The value defined in the SPOOL parameter file (*YES or *NO).
DELETE-FILE =
Specifies whether the file is to be deleted at the end of output and if so, whether its data are to be overwritten with X'00'.
Default: the file is not deleted after printing and not overwritten with binary zeros. The user must have write access to the file.
If the file to be output belongs to a file generation group (see FILE-NAME operand), the DELETE-FILE operand is ignored. This operand must not be specified in conjunction with *SYSLST, *SYSLSTnn or *SYSOUT.
DELETE-FILE = *NO
The file is not to be deleted after printing (unless it is an EAM or system file).
DELETE-FILE = *YES
The file is to be deleted as soon as output has been completed.
DELETE-FILE = *DESTROY
Specifies that once the file has been printed its data are to be overwritten with binary zeros. This operand value is invalid for EAM and cataloged system files.
SPOOLOUT-NAME = *STD / <alphanum-name 1..8> / <c-string 1..8>
Job name for the spoolout job.
The job name can be formed from a maximum of 8 characters from the set (A,...,Z,0,...9,@,#,$,.,-) but must not start with a hyphen or end with a period. It may only start with a period if this is followed by an alpha character; in this case, the period itself as part of the job name is not printed on the header page.
The job name is printed on the header page in the third outsize line and also appears in the output of the SHOW-JOB-STATUS command. If this operand is omitted the job name from the SET-LOGON-PARAMETERS command is used instead.
SPOOLOUT-NAME = *STD
No separate job name for the spoolout job. If a job name has been assigned to the job issuing the command (in the SET-LOGON-PARAMETERS command) this name is printed in the third outsize line on the header page.
SPOOLOUT-NAME = <alphanum-name 1..8>
Job name which is to be assigned to the spoolout job (and which will overwrite any job name already assigned to the job issuing the command).
SPOOLOUT-PRIORITY =
Specifies the priority (urgency) with which this spoolout job is started relative to other spoolout jobs.
SPOOLOUT-PRIORITY = *JOB-PRIORITY
The spoolout job is to have the same priority as the job issuing the command; default value.
SPOOLOUT-PRIORITY = <integer 30..255>
Priority to be assigned to the spoolout job.
The highest priority you can assign is defined in the user catalog and can be displayed by means of the SHOW-USER-ATTRIBUTES command.
If an invalid operand is specified (or if the operand is omitted), the spoolout job is assigned the same priority as the job issuing the command.
DEVICE-TYPE = *ANY / <alphanum-name 1..8>
Device type to which the required tapes are assigned.
DEVICE-TYPE = *ANY
Any device type. The highest available recording density is used for output.
VOLUME = *ANY / list-poss(4): <alphanum-name 1..6>
Volume labels of the required tapes.
VOLUME = *ANY
Scratch tapes supplied by the operator are used for output.
RETENTION-PERIOD = *STD / <integer 0..999>
Specifies the period in days during which the output file cannot be updated or deleted.
Return codes
(SC2) | SC1 | Maincode | Meaning |
|---|---|---|---|
0 | CMD0001 | No error | |
2 | 0 | SCP0829 | Command registered |
2 | 0 | SCP0862 | Not file owner. DELETE-FILE ignored |
2 | 0 | SCP0863 | FGG file. DELETE-FILE ignored |
2 | 0 | SCP0864 | File protected by read access. DELETE-FILE ignored |
2 | 0 | SCP0865 | File protected by write access. DELETE-FILE ignored |
2 | 0 | SCP0866 | File protected by EXPIRATION-DATE. DELETE-FILE ignored |
2 | 0 | SCP0930 | HP/SPOOLFILE not available |
2 | 0 | SCP0971 | RECORD-CLASS 164 not accessible (PLAM) |
2 | 0 | SCP1000 | JV access error. MONJV ignored |
1 | CMD0202 | Syntax error | |
1 | SCP0973 | Semantic error | |
32 | SCP0974 | System error. Command rejected | |
64 | SCP0975 | No authorization for command | |
64 | SCP0976 | Invalid operand value | |
128 | SPS0266 | SPOOL administrator task not available | |
128 | SCP0896 | Subsystem not loaded/ready | |
128 | SCP0996 | JV subsystem not loaded/ready |