Modify parameters for print job
Component: | SPOOL |
Functional area: | Controlling spoolout jobs |
Domain: | SPOOL-PRINT-ADMINISTRATION |
Privileges: | STD-PROCESSING |
Function
The MODIFY-PRINT-JOB-ATTRIBUTES command modifies the parameters of the PRINT-DOCUMENT command for a print job after the command has been accepted. The effect of this command is the same as issuing a new PRINT-DOCUMENT command with modified operands. However, some operands of the PRINT-DOCUMENT command cannot be modified. This depends on the status of the print job. For details see section "Notes".
If the default value *UNCHANGED is specified then no changes are made to the initial value of the parameter in question.
Note that print jobs that have the status PREPROCESSING or ACTIVE cannot be modified. There are also constraints on other statuses (see the section "Notes").
Privileged functions
RSO device administrators and spool and cluster administrators can modify the attributes of any print job scheduled for printing on any device that they manage. For more information on these user groups see the manuals “RSO” [32], “SPOOL” [43] and “Dprint” [10].
Format
MODIFY-PRINT-JOB-ATTRIBUTES | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Operands
JOB-IDENTIFICATION = *TSN(...) / *MONJV(...) / *SERVER-TSN(...) / *CLIENT-TSN(...)
Specifies how the job is identified.
JOB-IDENTIFICATION = *TSN(...)
The print job is identified by its local task sequence number (TSN).
TSN = <alphanum-name 1..4>
TSN of the job to be modified.
CLUSTER-NAME = *LOCAL-CLUSTER / <name 1..8>
Name of the cluster in which the print job is processed. If you specify a cluster name, the specified TSN is the TSN on the gateway host in the specified remote cluster. Only BS2000 clusters can be specified.
JOB-IDENTIFICATION = *MONJV(...)
The print job is identified by its monitoring job variable.
MONJV = <filename 1..54 without-gen-vers>
This operand allows a print job to be addressed by means of its MONJV, provided the specified MONJV is accessible on the host at which the command is issued. Only print jobs in the local cluster can be addressed in this way.
JOB-IDENTIFICATION = *SERVER-TSN(...)
The print job is identified by its TSN (task sequence number) on the server. Only print jobs in the local cluster can be addressed in this way.
TSN = <alphanum-name 1..4>
Task sequence number of the job to be modified on the server.
SERVER-NAME = *HOME / <alphanum-name 1..8>
Name of the server on which the print job is being processed.
JOB-IDENTIFICATION = *CLIENT-TSN(...)
Only for the cluster administrator. The print job is identified by its TSN on the client. Only print jobs in the local cluster can be addressed in this way.
TSN = <alphanum-name 1..4>
Task sequence number of the job to be modified on the client.
CLIENT-HOST = <alphanum-name 1..8>
Name of the client on which the print job is being processed.
DOCUMENT-PART = *UNCHANGED / *PARAMETERS(...)
Allows you to limit processing of the print file to only a part of it and thus change what was specified in the PRINT-DOCUMENT command.
The file to be printed (the input file) consists of a sequence of records, each of which can be identified by SPOOL by means of its record number or a string it contains. SPOOL also allows you to structure the print file by using strings as file marks. These file marks divide the file up into sections. SPOOL takes into account all the options set by the user and converts the input file into a file edited for printing (an output file). This file consists of logical lines and pages. The delimitation of part or parts of a file can apply to either the input file or the output file. The following alternatives for defining parts of a file are available in the substructures of this operand:
INPUT-SECTION: the input file can be subdivided into sections on the basis of a specified string, or the whole file can be processed.
INPUT-PART: only a certain number of the input file’s records are processed. You can specify the first and last record by means of a record number, a section number or a string.
RECORD-PART: of the records selected by means of the above operands, only a specified part of each record is processed.
OUTPUT-PART: the whole input file is edited for printing, but output is limited to a subset of all logical print pages.
DOCUMENT-PART = *PARAMETERS(...)
The part of the file to be processed can be specified in the following substructure.
INPUT-SECTION = *UNCHANGED / *WHOLE-FILE / *PARAMETERS(...)
Specifies whether the file is to be structured by means of file marks, and thus allows you to change what was specified in PRINT-DOCUMENT.
INPUT-SECTION = *WHOLE-FILE
The file is not structured. The whole input file is a single logical section.
INPUT-SECTION = *PARAMETERS(...)
The file is structured by means of file marks that can be specified in the following substructure. You use the INPUT-PART operand to specify which sections of the structured print file are to be output.
SECTION-IDENTIFIER = *UNCHANGED / <c-string 1..60 with-low> / <x-string 1..120>
Specifies the file marks by means of which the input file is to be structured. Any strings in the records can be used as file marks. These strings can be either in SECTION records, which are not printed, or in the print file’s normal records, which are printed. A string can be specified in the form of printable characters or hexadecimal characters. You use the INPUT-PART operand to specify which sections of the structured print file are to be output. The search for the start of the section to be printed is executed in a separate “pseudo controller” task. Neither the user task nor the printer is locked while this is being done. A pseudo controller writes the address of the first record in the section to the SPOOL control block; the spoolout job can then be processed (PREPROCESSING). If the desired section is not found in the file, an error message appears on the trailer page (for the layout of this page see the “SPOOL” manual [43]).
POSITION = *UNCHANGED / *STD / <integer 1..2047>
Specifies the position at which the specified string begins in the SECTION record.
POSITION = *STD
The relevant string begins by default at the start of the record, i.e.:
in a SAM file: at the first byte after the record length field
in an ISAM file with KEY-POS=5: at the first byte after the key
in an ISAM file with KEY-POS > 5: at the first byte after the record length field.
POSITION = <integer 1..2047>
The relevant string begins at the specified byte (after the record length field).
INPUT-PART = *UNCHANGED / *ALL / *PARAMETERS(...)
Specifies whether only a certain number of the input file’s records are to be processed, and thus allows you to change what was specified in PRINT-DOCUMENT. You can specify the first and last record by means of a record number, a section number or a string.
INPUT-PART = *ALL
All the file’s records are to be processed.
INPUT-PART = *PARAMETERS(...)
Only a certain number of the input file’s records are to be processed. You can specify the first and last records.
FIRST-RECORD = *UNCHANGED / *BEGIN-OF-FILE / <integer 1..2147483647> /*BY-STRING-ID(...)
Specifies the record as of which the file is to be processed. You can specify the first record in the file, the number of a record or file mark, or a string in a record.
FIRST-RECORD = *BEGIN-OF-FILE
Output begins with the file’s first record, even if SECTION records are specified.
FIRST-RECORD = <integer 1..2147483647>
Number of the SECTION record or normal record as of which a section of the file is to be output.
FIRST-RECORD = *BY-STRING-ID(...)
The record in which a specified string occurs is the first record to be output.
STRING = *UNCHANGED / <c-string 1..60 with-low> / <x-string 1..120>
Output begins with the record in which the specified string of printable or hexadecimal characters is found at a specific position.
POSITION = *UNCHANGED / STD / <integer 1..2047>
Position within the record at which the specified string of hexadecimal characters begins. By default (STD), the FIRST-RECORD string begins at the start of the record, i.e.:
in a SAM file: at the first byte after the record length field
in an ISAM file with KEY-POS=5: at the first byte after the key
in an ISAM file with KEY-POS > 5: at the first byte after the record length field.
OCCURRENCE = *UNCHANGED / <integer 1..32767>
Specifies the record (containing the FIRST-RECORD string) as of which output is to start.
LAST-RECORD = *UNCHANGED / *END-OF-FILE / <integer 1..2147483647> /*BY-STRING-ID(...)
Specifies the last record in the part of the file to be output. You can specify the last record in the file, the number of a record or file mark, or any string in a record.
Note
If the LAST-RECORD record is found before the FIRST-RECORD record, the PRINT-DOCUMENT command aborts.
LAST-RECORD = *END-OF-FILE
Output continues until the end of the file, even if SECTION records are specified.
LAST-RECORD = <integer 1..2147483647>
Number of the last record (SECTION record or normal record) in the part of the file to be output.
LAST-RECORD = *BY-STRING-ID(...)
Specifies that the last record is to contain a specified string.
STRING = *UNCHANGED / <c-string 1..60 with-low> / <x-string 1..120>
Output ends with the record in which the specified string of printable or hexadecimal characters is found at a specific position in the file.
POSITION = *UNCHANGED / STD / <integer 1..2047>
Position within the record at which the specified string of hexadecimal characters begins. By default (STD), the LAST-RECORD string begins at the start of the record, i.e.:
in a SAM file: at the first byte after the record length field
in an ISAM file with KEY-POS=5: at the first byte after the key
in an ISAM file with KEY-POS > 5: at the first byte after the record length field.
OCCURRENCE = *UNCHANGED / <integer 1..32767>
Specifies the occurrence of the record containing the LAST-RECORD string at which output is to stop.
RECORD-PART = *UNCHANGED / *ALL / *PARAMETERS(...)
Specifies whether only a specific part of each of the records selected by means of the above operands is to be processed.
RECORD-PART = *ALL
All of each selected record is to be processed.
RECORD-PART = *PARAMETERS(...)
Only a specific part of each record is to be processed.
FIRST-CHARACTER = *UNCHANGED / <integer 2..32767>
Allows a byte number (record column) to be specified indicating the point as of which the records of a file are to be output. (The bytes of a record are numbered consecutively from left to right starting with 1; ISAM keys and control characters are components of a record.) What happens depends on whether one of the values *BY-EBCDIC-CONTROL, *BY-IBM-CONTROL or *BY-ASA-CONTROL is specified in the LINE-SPACING operand.
If one of these values is specified:
Output starts with the data byte following the specified byte number. The feed control character is interpreted irrespective of the entry for FIRST-CHARACTER, provided the value for FIRST-CHARACTER is less than the length of the record. If the specified value is greater than the length of the record, it is ignored (i.e. printing does not take place, nor does line feed).
If none of these values is specified:
Output starts with the data byte corresponding to the specified byte number.
If the records are longer than the form definition allows, printing continues on the next line. If CONTROL-MODE=*PAGE-MODE is specified, an entry for FIRST-CHARACTER is problematical because SPOOL takes no account of the number of control characters in a record.
LAST-CHARACTER = *UNCHANGED / *STD / <integer 1..32767>
Specifies the byte indicating the point at which printing of each record is to stop. What happens depends on whether one of the values *BY-EBCDIC-CONTROL, *BY-IBM-CONTROL or *BY-ASA-CONTROL is specified in the LINE-SPACING operand.
If one of these values is specified:
Output ends with the data byte following the specified byte number (unless FIRST-CHARACTER is specified for an ISAM file with KEY-POSITION=5, in which case output ends with the data byte corresponding to the specified byte number).
If none of these values is specified:
Output ends with the data byte corresponding to the specified byte number.
If the records are longer than the form definition allows, printing continues on the next line. If CONTROL-MODE=*PHYSICAL is specified, an entry for LAST-CHARACTER is problematical because SPOOL takes no account of the number of control characters in a record.
Default (*STD):
end of print line (136)
2048 for an EAM file, SYSLST or SYSOUT.
OUTPUT-PART = *UNCHANGED / *ALL / *RANGE(...) / *LAST(...)
Specifies that the whole input file is to be edited for printing but that output is to be limited to a subset of all logical print pages and thus allows you to change what was specified in PRINT-DOCUMENT.
OUTPUT-PART = *ALL
All logical print pages of the edited file are to be output.
OUTPUT-PART = *RANGE(...)
Part of the file is to be output.
FROM = *UNCHANGED / *BEGIN-OF-FILE / <integer 1..2147483647>
Allows a page or line number in the print file to be specified as of which output is to start, as specified by the DIMENSION operand. By default, output commences at the beginning of the file. The pages in a print file are defined as described for the LINE-PER-PAGE operand (unless a control character produces a premature page feed).
TO = *UNCHANGED / *END-OF-FILE / <integer 1..2147483647>
Allows a page or line number in the print file to be specified at which output is to end, as specified by the DIMENSION operand.
By default, output terminates at the end of the file. Pages in a print file
are defined by the LINE-PER-PAGE operand (unless a control character produces a premature page feed). The value specified here must be greater than that specified in the FROM operand.
DIMENSION = *UNCHANGED / *PAGES / *LINES
Specifies whether the values in the FROM and TO operands are to be interpreted as page or line numbers.
OUTPUT-PART = *LAST(...)
Only the last so many pages or lines of the print file are to be output.
LAST = *UNCHANGED / <integer 1..2147483647>
Number of pages or lines to be output, calculated from the end of the file. The DIMENSION operand indicates whether the value is to be interpreted as a page or line number. Pages in a print file are defined by the LINE-PER-PAGE operand (unless a control character produces a premature page feed).
DIMENSION = *UNCHANGED / *PAGES / *LINES
Specifies whether the value in the LAST operand is to be interpreted as a page or line number.
Example of SECTION processing:
The following sections of an ISAM file are to be output.
01000000 | Line 0 | |
02000000 | *SECTION0001 | |
03000000 | Line 1 | |
04000000 | *SECTION0002 | |
05000000 | Line 2 | |
06000000 | *SECTION0003 | |
07000000 | Line 4 | |
Case: SECTION records in default positions.
PRINT-DOCUMENT datei, DOCUMENT-PART=*PAR(INPUT-SECTION = -
*PAR(SECT-ID=C’*SECTION’,POS=*STD), INPUT-PART= *PAR( -
FIRST-RECORD=1, LAST-RECORD=3))
The following part of the file is printed:
e table below specifies how
03000000 | Line 1 |
05000000 | Line 2 |
DOCUMENT-FORMAT = *UNCHANGED / *TEXT(...) / *PAGE-FORMAT(...) / *SPECIAL-FORMAT(...)
Specifies the type of the document contents, i.e. the format of the file to be printed as regards the interpretation of feed control characters, printer control characters, font identifiers, RENO commands and/or VTSU codes. You can specify the following operands and the corresponding substructures here:
*TEXT: the file has no printer-specific control characters except for feed control characters.
*PAGE-FORMAT: the file has laser printer-specific control characters.
*SPECIAL-FORMAT: the file has special printer-specific control characters.
DOCUMENT-FORMAT = *TEXT(...)
Except for feed control characters, the file has no printer-specific control characters. The position of the feed control character in the record can be specified in the substructure of the LINE-SPACING operand.
The data is sent to the printer unchanged. Since only the data to be printed is sent to the printer, records can be truncated.
The following applies to RSO:
Records of type A-1 or A-2 are to be printed (no control characters in the data stream); in other words, except for feed control characters in the first column of the records, no control characters are interpreted. This is also the reason why a font change is not possible. The form’s default font or the first font specified for CHARACTER-SETS, if specified, is used. Nonprinting characters, i.e. characters with a hexadecimal value less than X'40', are output as blanks. If the record length exceeds the maximum line length, the record is truncated in the printout. The maximum line length depends on the character spacing, which is defined by means of the font used (see the CHARACTER-SETS operand).
Note
RSO printer: The command evaluates only the first element of the font list if DOCUMENT-FORMAT=*TEXT has an associated font list (operand: CHARACTER-SETS=...).
LINE-PER-PAGE = *UNCHANGED / *STD / <integer 1..32767>
Specifies how many lines (including header and blank lines) are to be printed on a page.
LINE-PER-PAGE = *STD
If the operand is omitted, the number of lines per print page is calculated using the following formula, regardless of what has been specified for the HEADER-LINE operand: Number of lines = P * L - N - 6
The name sections have the following meanings:
P = paper size in inches
L = line density
N = number of line before the first channel 1
Printers with a loadable vertical format buffer
The vertical tab “channel 1” controls the line on which printing is to start. Unless otherwise specified, 2 blank lines are set before printing starts; i.e. channel 1 (CHANNEL 01) is in the third line of the loop.
If the value specified for the LINE-PER-PAGE operand is greater than the specified number of lines in the loop, the value in the loop is used.
A value specified here must be at least three times as large as the line feed specified for LINE-SPACING=1/2/3 if the LINE-PER-PAGE operand is specified together with the HEADER-LINE and LINE-SPACING operands.
LINE-SPACING = *UNCHANGED / 1 / 2 / 3 / *BY-EBCDIC-CONTROL(...) / *BY-IBM-CONTROL(...) /
*BY-ASA-CONTROL(...)
Specifies the number of line feeds and the way in which control characters are interpreted.
LINE-SPACING = 1 / 2 / 3
The records are to be printed out with 1-, 2- or 3-line spacing.
LINE-SPACING = *BY-EBCDIC-CONTROL(...)
The contents of the first byte of each record are to be interpreted as an EBCIDC feed control character.
CONTROL-CHAR-POS = *UNCHANGED / *STD / <integer 1..2040>
Number of the data byte in which SPOOL finds the feed control character. In the case of records of variable length, the fields containing the length information are not counted as data.
LINE-SPACING = *BY-IBM-CONTROL(...)
The contents of the first byte of each record are to be interpreted as an IBM feed control character.
CONTROL-CHAR-POS = *UNCHANGED / *STD / <integer 1..2040>
Number of the data byte in which SPOOL finds the feed control character. In the case of records of variable length, the fields containing the length information are not counted as data.
LINE-SPACING = *BY-ASA-CONTROL(...)
The contents of the first byte of each record are to be interpreted as an ASA feed control character.
CONTROL-CHAR-POS = *UNCHANGED / *STD / <integer 1..2040>
Number of the data byte in which SPOOL finds the feed control character. In the case of records of variable length, the fields containing the length information are not counted as data.
HEADER-LINE = *UNCHANGED / *NO / *STD /list-poss(3): *DATE / *FIRST-RECORD / *PAGE-NUMBER
Specifies whether a header line is to be printed on every page (except the header and trailer pages).
HEADER-LINE = *NO
No header line is printed.
HEADER-LINE = *STD
The header has the following format:
Header | DATE yyyy-mm-dd | userid | nnnn | PAGE nnnn |
|---|---|---|---|---|
Column | 1 | 41(11,11) | 60(21,67) | 124 (77) |
The first value in parentheses applies in the case of a form definition with a line length < 132 and >= 80 characters (with differing values). The second value in parentheses applies in the case of a form definition with a line length < 80 and >= 70 characters (with differing values).
jjjj-mm-tt | Year-Month-Day |
userid | user ID |
datei | file name |
nnnn | Page number |
Unless otherwise specified, the header line is followed by a blank line. The header is shifted in accordance with the LEFT-MARGIN operand, but the header line will be truncated at column 132.
DATE and PAGE are only present in the header line if the line size >= 032.
HEADER-LINE = list-poss(3): *DATE / *FIRST-RECORD / *PAGE-NUMBER
The header has the following format:
HEADER-LINE= | DATE | FIRST-RECORD | PAGE-NUMBER |
|---|---|---|---|
Header | DATE yyyy-mm-dd | First record | PAGE nnnn |
Column | 1 | 21 | 124 (77.67) |
*DATE:
The value in parentheses applies in the case of a form definition with a line length < 132 and >= 70 characters (with differing values). *PAGE-NUMBER: The first value in parentheses applies in the case of a form definition with a line length < 132 and >= 80 characters (with differing values). The second value in parentheses applies in the case of a form definition with a line length < 80 and >= 70 characters (with differing values).
yyyy-mm-dd | Year-Month-Day |
First record | First logical record of the file |
nnnn | Page number |
If *DATE, *FIRST-RECORD or *PAGE-NUMBER is omitted, the appropriate section is filled with blanks.
Unless otherwise specified, the header line is followed by a blank line.
The header is shifted in accordance with the LEFT-MARGIN operand, but the header line will be truncated at column 132.
*DATE and *PAGE are only present in the header line if the line size >= 032.
If *FIRST-RECORD is specified, the first record is regarded as not belonging to the date.
OUTPUT-FORMAT = *UNCHANGED / *CHARACTER / *HEXADECIMAL
Indicates whether the output format is character format only or character format and hexadecimal format.
OUTPUT-FORMAT = *CHARACTER
Outputs in character format only. Records which exceed the length of a print line are truncated.
OUTPUT-FORMAT = *HEXADECIMAL
Outputs the data records in character format and in hexadecimal format.
Output format
Each output line starts with an 8-byte prefix followed by data 50 bytes in length. Each output line is first printed using the appropriate font and then repeated in hexadecimal format.
Format of the output line
Column | Contents |
|---|---|
1-4 | Column number from which the data of the output record should begin |
5-8 | blank |
From 9 | Characters of the input record according to font; the individual characters are separated by a blank. The characters are repeated in hexadecimal format in the next line. |
DOCUMENT-FORMAT = *PAGE-FORMAT(...)
The file contains specific control characters for laser printers, and thus changes what was originally specified in PRINT-DOCUMENT.
FORMAT-NAME = *UNCHANGED / *STD / <c-string 1..63 with-low>
Name of the format in which the output data is transferred to the printer. If no value was entered for FORMAT-NAME, a default value is automatically deducted from the value of the CONTROL-MODE operand. This leads to the following results:
CONTROL-MODE = *PAGE-MODE(...) | FORMAT-NAME = *HP |
CONTROL-MODE = *APA(...) | FORMAT-NAME = *SPDS |
CONTROL-MODE = *LOGICAL / *PHYSICAL / *LINEMODE | FORMAT-NAME = *STD |
The value FORMAT-NAME = *STD means that the contents of the file to be printed out is irrelevant.
CONTROL-MODE = *UNCHANGED / *PAGE-MODE(...) / *LINE-MODE / *LOGICAL(...) /
*PHYSICAL(...) / *APA(...)
Specifies how the control characters are to be interpreted.
CONTROL-MODE = *PAGE-MODE(...)
The control characters are suitable for processing on page printers.
PAGE-CONTROL-CHAR = *UNCHANGED / *YES / *NO
Specifies whether the control character list must be at the beginning of each page (i.e. always after branching to the vertical tab “channel 1” in the loop).
PAGE-CONTROL-CHAR = *YES
The control character list must be there.
PAGE-CONTROL-CHAR = *NO
No control character list at the beginning of the page. However, this means that the following functions cannot be controlled in the case of output to HP printers:
Film overlays on individual pages in the file; specified in the MODIFY-PRINT-JOB-ATTRIBUTES command, a film overlay is used on each page of the print file of the spoolout job.
Page copies for individual pages in the file; all the pages of the print file are output with as many copies as specified in the MODIFY-PRINT-JOB-ATTRIBUTES command.
Column-oriented indentation on individual pages; the value specified in the MODIFY-PRINT-JOB-ATTRIBUTES command is valid for all the pages in the print file.
FOB data overlay on individual pages in the file; specified in the MODIFY-PRINT-JOB-ATTRIBUTES command, an FOB data overlay is used on each page in the print file of the spoolout job.
A copy reference number cannot be specified.
Page rotation control for individual pages in the print file; all the pages are output in either portrait or landscape format, as specified in the MODIFY-PRINT-JOB-ATTRIBUTES command.
CONTROL-TYPE = *UNCHANGED / *HP / *COMPATIBLE
Specifies whether the control characters are suitable for processing on HP or HP90 printers or whether they have to be converted.
CONTROL-TYPE = *HP
The file contains HP or HP90 printer-specific control characters that can only be processed by these printers.
CONTROL-TYPE = *COMPATIBLE
The file does not contain HP or HP90 printer-specific control characters.SPOOL must convert the control characters.
LINE-SPACING = *UNCHANGED / *BY-EBCDIC-CONTROL / *BY-IBM-CONTROL / *BY-ASA-CONTROL
Specifies the number of line feeds and the way in which control characters are interpreted.
LINE-SPACING = *BY-EBCDIC-CONTROL
The contents of the first byte of each record are to be interpreted as an EBCIDC feed control character.
LINE-SPACING = *BY-IBM-CONTROL
The contents of the first byte of each record are to be interpreted as an IBM feed control character.
LINE-SPACING = *BY-ASA-CONTROL
The contents of the first byte of each record are to be interpreted as an ASA feed control character.
CONTROL-MODE = *LINE-MODE
Only for RSO.
Records of type C (see the “SPOOL” manual [43]) are printed out. The records may contain data mixed with LINE-MODE control characters. LINE-MODE control characters are (in any combination):
printer control characters (i.e. physical control character beginning with X'27' or X'3C')
RENO commands
VTSU codes
Control over record and file formats (including page and line feed with LINE-MODE control characters) rests solely with the user. With the 9025/9026 RENO page printer, users must also ensure that the printer is set to the correct start position on the paper. A loop is not interpreted. Nonprinting characters, i.e. characters with a hexadecimal value less than X'40', are output as blanks.
The spoolout job is executed with the default font of the form used until you change the font in the file with the aid of LINE-MODE control characters.
CONTROL-MODE = *LOGICAL(...)
Only for RSO printers.
Specifies that records of type B-1 or B-2 are to be printed out, i.e. records which, in addition to a feed control character in the first byte, may contain data mixed with font identifiers, printer control characters, RENO commands, and VTSU codes (see the “RSO” manual [32], record type B-1/B-2).
With the exception of the VTSU codes VPA, NP, VT, NL and CR, which are output as blanks, the above-mentioned control characters are interpreted. A font identifier, a VTSU code or a RENO command remains valid until a new control character is specified.
If the font identifier is omitted, the default font for the form is used.
Since page feed is implemented via a loop or constant line feed when CONTROL-MODE=LOGICAL is specified, the file should not contain the RENO commands \LF, \FF and \CR. Setting the form height is likewise not permitted.
LINE-PER-PAGE = *UNCHANGED / *STD / <integer 1..32767>
Specifies how many lines (including header and blank lines) are to be printed on a page.
LINE-PER-PAGE = *STD
If no value is specified, the number of lines per print page is calculated according to the following formula, regardless of the value in the HEADER-LINE operand:
Number of lines = P * L - N - 6
The name sections have the following meanings:
P = paper size in inches
L = line density
N = number of line before the first channel 1
If the value specified for the LINE-PER-PAGE operand is greater than the specified number of lines in the loop, the value in the loop is used. A value specified here must be at least three times as large as the line feed specified for LINE-SPACING=1/2/3 if the LINE-PER-PAGE operand is specified together with the HEADER-LINE and LINE-SPACING operands.
LINE-SPACING = *UNCHANGED / 1 / 2 / 3 / *BY-EBCDIC-CONTROL / *BY-IBM-CONTROL /
*BY-ASA-CONTROL
Specifies the number of line feeds and the way in which control characters are interpreted.
LINE-SPACING = 1 / 2 / 3
The records are to be printed out with 1-, 2- or 3-line spacing.
LINE-SPACING = *BY-EBCDIC-CONTROL(...)
The contents of the first byte of each record are to be interpreted as an EBCIDC feed control character.
CONTROL-CHAR-POS = *UNCHANGED / *STD / <integer 1..2040>
Number of the data byte in which SPOOL finds the feed control character. In the case of records of variable length, the fields containing the length information are not counted as data.
LINE-SPACING = *BY-IBM-CONTROL(...)
The contents of the first byte of each record are to be interpreted as an IBM feed control character.
CONTROL-CHAR-POS = *UNCHANGED / *STD / <integer 1..2040>
Number of the data byte in which SPOOL finds the feed control character. In the case of records of variable length, the fields containing the length information are not counted as data.
LINE-SPACING = *BY-ASA-CONTROL(...)
The contents of the first byte of each record are to be interpreted as an ASA feed control character.
CONTROL-CHAR-POS = *UNCHANGED / *STD / <integer 1..2040>
Number of the data byte in which SPOOL finds the feed control character. In the case of records of variable length, the fields containing the length information are not counted as data.
CONTROL-MODE = *PHYSICAL(...)
Only for RSO.
Specifies that contrary to an original definition in the PRINT-DOCUMENT command
laser printer-specific control characters (local SPOOL) or
records of type D-1 / D-2 (RSO) - i.e. data mixed with VTSU codes, printer control characters and RENO commands - are to be interpreted.
Control characters contained in the print data are interpreted. In the case of HP printers, a record for a 13.6-inch form may be up to 700 bytes long (including control characters and the escape character X'FF'). If the number of characters to be printed per record exceeds the physical capacity of the laser printer, the spoolout job is terminated abnormally. The maximum line length depends on the character pitch (see table of valid character spacings). The interpretation of control characters must be activated in the first record of each print page.
Output to local SPOOL devices:
When CONTROL-MODE = *PAGE-MODE and CONTROL-TYPE = *COMPATIBLE are specified, the X'FF' characters are converted to X'1F'. Laser printer-specific control characters in the records are interpreted. The first character in each record is interpreted as a feed control character. For ISAM files the key must be at the start of each record.
The file can be printed out using more than one font. The appropriate control characters can occur in any position in the text. The LEFT-MARGIN, PAGE-COPIES and LINE-PER-PAGE operands are ignored if they are specified together with CONTROL-MODE=*PHYSICAL.
Output to RSO devices:
LINE-SPACING=*NO is set automatically, which means that you must implement page and line feeds with LINE-MODE control characters (i.e. VTSU codes, printer control characters and RENO commands) in the file itself. If you specify LINE-SPACING=*BY-EBCDIC-CONTROL for records of type D-2, the feed control character in the first byte is interpreted as a line or page feed control character. Nonprinting characters are also transferred to the printer (in contrast to CONTROL-MODE=*LINE-MODE). The user is responsible for inserting the correct control characters in the file (including line spacing characters).
LINE-SPACING = *UNCHANGED / *NO / 1 / 2 / 3 / *BY-EBCDIC-CONTROL / *BY-IBM-CONTROL /
*BY-ASA-CONTROL
Specifies the number of line feeds and the way in which control characters are interpreted.
LINE-SPACING = *NO
The contents of the first byte of each record are not interpreted as a control character.
LINE-SPACING = 1 / 2 / 3
Permitted only for RSO.
The records are to be printed out with 1-, 2- or 3-line spacing.
LINE-SPACING = *BY-EBCDIC-CONTROL
The contents of the first byte of each record are to be interpreted as an EBCIDC feed control character.
LINE-SPACING = *BY-IBM-CONTROL
The contents of the first byte of each record are to be interpreted as an IBM feed control character.
LINE-SPACING = *BY-ASA-CONTROL
The contents of the first byte of each record are to be interpreted as an ASA feed control character.
CONTROL-MODE = *APA(...)
Specifies that the file to be printed contains APA printer control characters that are to be interpreted, and thus changes what was specified in PRINT-DOCUMENT.
LINE-SPACING = *UNCHANGED / *BY-EBCDIC-CONTROL / *BY-IBM-CONTROL /
*BY-ASA-CONTROL
Specifies the type of the printer control characters (E, I or A).
DOCUMENT-FORMAT = *SPECIAL-FORMAT(...)
Specifies that a printer-specific language is to be used in the document, and thus changes what was specified in PRINT-DOCUMENT. In this case, the SPOOL subsystem provides transparent control for the document. In other words, the file is transferred without interpretation.
FORMAT-NAME = *UNCHANGED / *NONE / *PCL / <c-string 1..63 with-low>
Specification of the format to be processed. The document is processed in transparent mode.
FORMAT-NAME = *NONE
The document is either processed by RSO in transparent mode or it is transferred to UNIX-based system without a specific format.
Data records of the types E-1 or E-2 are printed out by RSO (see the “RSO” manual [32]). With the exception of VTSU codes for RSO, the data records can contain optional characters. All characters of a data record are transferred by RSO to the printer without interpretation, with the exception of the line spacing control character in the first byte of the type E-2 data record.
The user is responsible for inserting the correct control characters in the file (including line spacing characters). If the LINE-SPACING operand is not specified, the default setting LINE-SPACING=*NO applies and you have to include page feeds and line feeds in the file yourself using LINE-MODE control characters. If LINE-SPACING=*BY-EBCDIC-CONTROL is specified for type E-2 data records, the feed control character in the first byte is interpreted as a line feed or a page feed control character. If the LEFT-MARGIN operand is specified at the same time, blanks are included at the beginning of each data record and these indent the text by the desired number of columns when it is printed.
FORMAT-NAME = *PCL
This value is only still available for reasons of compatibility.
FORMAT-NAME = <c-string 1..63 with-low>
This operand specifies that the contents of the document to be processed are of a specific type (e.g. HP LASERJET).
In the case of jobs which are directed to a cluster, the operand value is determined by the document format attribute which is transferred to the cluster. It is interpreted by Xprint or the foreign print system as the “content type” attribute of the print job (xpadd -job -ct...). This document content type fulfills part of the relevant requirements of ISO DPA class 1, which is required for interoperability between the BS2000 Spool & Print subsystems and foreign spool and print subsystems.
Jobs to RSO are printed by an RSO printer if it supports the format name specified or if a filter is available which will convert the format name into a format name supported by the printer.
If the value of CLUSTER-NAME refers to a BS2000 cluster or if none was specified, the length of the format name may not exceed 8 characters. If the FORMAT-NAME value is longer, the command is rejected. The file is printed by a printer that supports the specified format name.
In all cases, the printer must have been defined together with the format name in the SPOOL parameter file.
LINE-SPACING = *UNCHANGED / *NO / 1 / 2 / 3 / *BY-EBCDIC-CONTROL / *BY-IBM-CONTROL /
*BY-ASA-CONTROL
Specifies the number of line feeds and the way in which control characters are interpreted.
LINE-SPACING = *NO
The contents of the first byte of each record are not interpreted as a control character.
LINE-SPACING = 1 / 2 / 3
Permitted only for RSO.
The records are to be printed out with 1-, 2- or 3-line spacing.
LINE-SPACING = *BY-EBCDIC-CONTROL
Only for RSO.
The contents of the first byte of each record are to be interpreted as an EBCIDC feed control character.
LINE-SPACING = *BY-IBM-CONTROL
Only for RSO.
The contents of the first byte of each record are to be interpreted as an IBM feed control character.
LINE-SPACING = *BY-ASA-CONTROL
Only for RSO.
The contents of the first byte of each record are to be interpreted as an ASA feed control character.
PRINT-JOB-CONTROL = *UNCHANGED / *PARAMETERS(...)
Determines whether parameters for controlling print job management which were originally assigned for this print job in the PRINT-DOCUMENT command are to be modified.
PRINT-JOB-CONTROL = *PARAMETERS(...)
CHECKPOINT = *UNCHANGED / *ON-PAGES / *ON-SECTION-RECORDS
This operand is only still available for reasons of compatibility.
PRINT-JOB-NAME = *UNCHANGED / <alphanum-name 1..8> / <c-string 1..8 with-low>
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 special character string period and hyphen (.-) may only be specified in quotes.
The job name is printed on the header page in the third uppercase line and also appears in the output of the SHOW-PRINT-JOB-STATUS command. If this operand is omitted the job name from the SET-LOGON-PARAMETERS command is used instead.
PRINT-JOB-NAME = <alphanum-name 1..8> / <c-string 1..8 with-low>
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).
PRINT-JOB-PRIORITY = *UNCHANGED / <integer 30..255>
Defines the urgency with which this spoolout job is started relative to other spoolout jobs.
PRINT-JOB-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 priority is entered (or no priority at all), the spoolout job is given the same priority as the job issuing the command.
PRINT-JOB-CLASS =
Defines the job class for the spoolout job.
PRINT-JOB-CLASS = *UNCHANGED
The value for the print job class is retained.
PRINT-JOB-CLASS = <integer 1..255>
Only the SPOOL administrator is allowed to select this value.
The specified job class is assigned to the spoolout job.
FAILURE-PROCESSING = *UNCHANGED / *PARAMETERS(...)
Specifies whether a specific message page is to be created when an error occurs during current processing on an APA printer.
FAILURE-PROCESSING = *PARAMETERS(...)
Specifies what happens in the event of an error.
#MSG-PAGE = *UNCHANGED / *YES / *NO
Specifies whether the APA message page is to be printed. The APA message page contains error messages and warnings. If an APA printer is not being used, this parameter is ignored.
SCHEDULING-TIME = *UNCHANGED / *STD / *EARLIEST(...)
Determines the scheduling time, i.e. the start time of the print job. When *STD is specified, the print job is started on the basis of printer availability and the processing rules for print jobs.
SCHEDULING-TIME = *EARLIEST(...)
The job is started at the earliest at the specified time on the specified date.
DATE = *UNCHANGED / *TODAY / <date with-compl>
Day on which the print job is started.
TIME = *UNCHANGED / <time>
Time at which the print job is started.
ENCRYPTION = *UNCHANGED / *YES / *NO
Specifies whether the print file is to be encrypted.
LAYOUT-CONTROL = *UNCHANGED / *PARAMETERS(...)
Contrary to original declarations, defines all parameters for describing the page layout in the PRINT-DOCUMENT command.
LAYOUT-CONTROL = *PARAMETERS(...)
PAGE-COPIES = *UNCHANGED / *STD / <integer 0..255>
In local SPOOL mode, only for the printer types HP, HP90 and LP65.
Number of page copies.
This specifies how many times each individual page is to be repeated. The ADDITIONAL-COPIES operand allows additional printouts of the whole file to be requested.
A PRINT-DOCUMENT command with the PAGE-COPIES operand is rejected if the line number specified in the LINE-PER-PAGE operand is greater than the number of lines in the loop record minus the number of lines before the line on which the vertical tab “channel 1” is defined.
On an HP or HP90 printer, a maximum of 255 copies of a page can be printed in succession. PAGE-COPIES=255 has the same effect as PAGE-COPIES=254: one original and 254 copies are printed.
PAGE-COPIES = *STD
For LP65 printers:
the number of page copies is as specified in the PCL file. For all other printer types:
PAGE-COPIES=0.
LEFT-MARGIN = *UNCHANGED / *STD / <integer 0..31>
Number of columns by which output is to be indented.
LEFT-MARGIN = *STD
For all printers with the exception of RSO printers: The output text is to be indented by the specified number of columns.
For all RSO printers:
the output text is to be indented by the specified number * 1/10 inch. The default value can be displayed by means of the SHOW-SPOOL-PARAMETERS command or SPSERVE statement; the information is given in the PRINT-CMD-DEFAULTS:...LEFT-MARGIN = ... output field. The LEFT-MARGIN operand is ignored if the operand CONTROL-MODE=*PHYSICAL is specified at the same time.
TWO-SIDED = *UNCHANGED / *STD / *NO / *YES / *TUMBLE
Specifies whether the LP65 printer is to print the paper on one side or two.
TWO-SIDED = *STD
The paper is printed on one side (simplex mode) or two (duplex mode), as defined in the PCL file.
TWO-SIDED = *NO
The paper is printed on one side (simplex mode).
TWO-SIDED = *YES
The paper is printed on two sides (duplex mode).
TWO-SIDED = *TUMBLE
The paper is printed on two sides (duplex mode), and the pages are turned over from top to bottom rather than left to right.
Note
The TWO-SIDED, ELECTRONIC-OVERLAY and PAGE-COPIES functions are linked and part of the same printer command. If only one of the operands is defined, default values will be generated for the others.
ROTATION = *UNCHANGED / *NO / *BY-CONTROL-CODES /list-poss(2): 0 / 90 / 180 / 270 / 0-180 / 180-0 / 90-270 / 270-90
Specifies whether the pages to be printed from the spoolout job are to be rotated and if so by how many degrees. The print page set up in the printer is rotated (clockwise) by a certain number of degrees and printed on the form; for example, paper inserted in the printer in portrait format can be printed in landscape format. A separate loop is needed for pages rotated through 900/2700 (see the LOOP-NAME operand). Unless ROTATION=NO is specified, output is directed (automatically) to HP and HP90 printers. SHOW-SPOOL-PARAMETERS indicates whether an HP or HP90 printer with a page rotation module is available in the current SPOOL configuration: output field DEVICE-TYPE:..., ROT=YES/NO.
Spoolout jobs with page rotation are displayed in the outputs for the commands SHOW-USER-STATUS and SHOW-PRINT-JOB-STATUS JOB-ID=*TSN(TSN=...).
The feed for rotated pages is always controlled via a separate loop (ROTATION-LOOP). If you have specified neither a ROTATION-LOOP for PRINT-DOCUMENT nor a form with a defined ROTATION-LOOP (see ADD-SPOOL-FORM), the default rotation loop R06 in the default form takes on feed control for the rotated pages. Header and trailer pages are not printed out in rotated format.
ROTATION = *NO
Page rotation is not performed. Any control characters for page rotation in the file are not interpreted.
ROTATION = *BY-CONTROL-CODES
Control characters for page rotation in the file are interpreted.
ROTATION = 0 / 90 / 180 / 270
Each print page is rotated by 900 / 1800 / 2700 (clockwise) and printed out. Control characters for page rotation contained in the file are not interpreted. A separate loop is needed for pages rotated through 900 / 2700. You must check that output with the specified loop does not lead to errors. If an error occurs, the job is rejected.
ROTATION = 0-180 / 180-0 / 90-270 / 270-90
The odd pages (number before the hyphen) and even pages (number after the hyphen) are to be printed at different angles.
COVER-PAGES = *UNCHANGED / *PARAMETERS(...)
Parameters for system exit routines relating to the printing of header and trailer pages.
HEADER-PAGE-TEXT = *UNCHANGED / *NONE / <c-string 1..32>
The specified information (maximum of 32 characters) is stored in the SCB for processing the system exits. The first 8 characters are printed on the header page as an uppercase line under the mailing box. Only alpha characters, digits and a number of special characters are printed on the header page (in outsize type). All other character codes are automatically replaced by the printable character '?'.
Format of the header page:
- User ID in outsize letters (10 lines + 2 blank lines)
- Account number in outsize letters (10 lines + 2 blank lines)
- Job name in outsize letters (10 lines + 2 blank lines)
- Mailing box (address and identification field: 12 lines + 2 blank lines)
- 'text' in outsize letters (10 lines + 2 blank lines)
- User ID in outsize letters (10 lines + 2 blank lines)
Priority sequence:
- Mailing box (address and identification field: 12 lines + 2 blank lines)
- 'text' in outsize letters (10 lines + 2 blank lines)
- Mailing box (address and identification field: 12 lines + 2 blank lines)
HEADER-EXIT-NUMBER = *UNCHANGED / *NO / <integer 1..2147483639>
Number of header pages required.
The precise significance of this operand depends on the definitions made for the computer center. The default value is NO = 0.
TRAILER-EXIT-NUMBER = *UNCHANGED / *NO / <integer 1..2147483639>
Number of trailer pages required.
The precise significance of this operand depends on the definitions made for the computer center. The default value is NO = 0.
Note
The layout of the trailer page for local SPOOL is illustrated in the “SPOOL” manual [43].
TABLE-REFERENCE-CHAR = *UNCHANGED / *NO / *YES
Specifies whether users select fonts for print page layout by means of control characters in the text. The selection can be made with the aid of TRCs (table reference characters), which reference a list of fonts from within the records. The list can either be part of the page definition (PAGEDEF) or can be declared by means of the CHARACTER-SETS operand. For a detailed explanation of how to use the TRC, see the “SPOOL” manual [43].
TABLE-REFERENCE-CHAR = *NO
No font selection control characters (TRCs) are stored in the print file, or these characters are not to be evaluated.
TABLE-REFERENCE-CHAR = *YES
The print file contains font selection control characters (TRCs) that are to be evaluated by SPS. Each TRC value represents a specific font that is to be used to print out the relevant record. The individual values (from X'00' to X'0F') must either be linked to the entries in the font list in PAGE-DEFINITION, in the order in which they occur, or must be explicitly linked to the fonts specified in the CHARACTER-SETS operand in the order in which they occur. Regardless of the number of different TRC values in the file, up to four fonts, specified in the form of a list, can be used to print the records. TRC values greater than X‘03’ (corresponding to the fourth value in the list) automatically reference the first font in the list.
LANGUAGE-EXTENSION = *UNCHANGED / *NONE /*PARAMETERS(...)
This operand is only still available for reasons of compatibility.
INPUT-TRAY-NUMBER = *UNCHANGED / *STD / *IGNORE / <integer 1..99> / *BY-FORMAT(...)
Defines the paper input tray for the printer type LP65 or for the RSO printers 2030-PCL, 4011, 4812, 4813, 4818-PCL, 4821-PCL, 4822-PCL, 4824-PCL, 4825-PCL, 9000-EPLQ, 9000-EPSQ, 9000-PCL, 9004, 9011, 9012, 9013, 9014, 9015, 9021, 9022, 9022-200, 9025, 9026-PCL, 9026-RENO, 9097 and DJET. In the case of LP65 printers, the tray numbers 1 to 3 can be specified, whereas for RSO printers the tray numbers 1 to 99 can be specified.
Only for LP65 printers:
The paper input tray is to be selected by means of a PCL file or an entry at the printer control console. The PCL file can in turn select an input tray.
The order of priority for selecting an input tray is as follows:
the number of the input tray specified in PRINT-DOCUMENT
any selection via the PCL file specified in the PRINT-DOCUMENT command
any selection via the PCL file specified in the form definition in the SPOOL parameter file
the default values defined in the device record.
The following applies to all printers listed above:
If a paper input tray is specified here, but is not applicable for the particular printer, the result is a printer error on most printer types.
The PRINT-DOCUMENT command is rejected if the selected paper size is not available on the particular printer or if the paper size in the standard forms entries is larger than that for the selected paper.
Printer resources such as prolog, epilog, DIA, member and font character files are sent before the paper input tray is selected.
INPUT-TRAY-NUMBER = *STD
Paper is taken from the input tray defined in the device record of the printer in the SPOOL parameter file (DEFAULT-TRAY-NUMBER operand of the ADD-SPOOL-DEVICE statement. It is not possible to specify the paper size in this statement operand). The input tray selection is valid for the entire spoolout process, i.e. including processing of the header and trailer pages. If a standard paper size is specified, the printer selects the first input tray that contains this paper size. If this paper is not available, the printer switches to offline and the operator is prompted in the printer channel to insert the selected paper.
INPUT-TRAY-NUMBER = *IGNORE
Only for RSO printers: Once this operand value is specified, RSO sends no further commands for input tray selection to the printer. The default setting of the printer is used.
INPUT-TRAY-NUMBER = <integer 1..99>
Number of the input tray from which the paper is taken for printing the file itself as well as the header page (HEADER-PAGE) and trailer page (TRAILER-PAGE). RSO does not check the specified value. Possible values: 1...99.
The following table shows the printer types and the corresponding maximum number of input trays (column headed “max.”).
printer | Max. | printer | Max. | printer | Max. | printer | Max. |
|---|---|---|---|---|---|---|---|
2030-PCL | 2 | 9000 | 0 | 9002 | 0 | 9022 | 2 |
4011 | 2 | 9000-PCL | 2 | 9003 | 0 | 9022-200 | 2 |
4812 | 2 | 9000-PRO | 0 | 9004 | 3 | 9025 | 2 |
4813 | 2 | 9000-PS | 0 | 9011 | 2 | 9026-PCL | 4 |
4818-PCL | 2 | 9000-EPFX | 0 | 9012 | 2 | 9026-RENO | 4 |
4821-PCL | 2 | 9000-EPLQ | 2 | 9013 | 3 | 9045-ANSI | 0 |
4822-PCL | 3 | 9000-EPSQ | 2 | 9014 | 3 | 9046 | 0 |
4824-PCL | 2 | 9001 | 0 | 9015 | 2 | 9645 | 0 |
4825-PCL | 3 | 9001-31 | 0 | 9021 | 2 | DJET | 1 |
8121 | 0 | ||||||
The table below specifies how RSO processes specific operand values depending on the device definition:
INPUT-TRAY-NUMBER operand of the PRINT-DOCUMENT command specified
Device definition of the ADD-SPOOL-DEVICE statement with the operand FORM-FEED = *SINGLE-SHEET(DEFAULT-TRAY-NUMBER = ... )
Default in the device definition | Value of the INPUT-TRAY-NUMBER operand | ||
|---|---|---|---|
*STD | 1..99 | *IGNORE | |
1..99 | Sets default value (1) or value *LISTING (2) | Sets value (1) or value *LISTING (2) | Last tray specified is used |
*IGNORE | Last tray specified is used | Sets value (1) or value *LISTING (2) | Last tray specified is used |
(1) | on single-sheet printers and printer type 9015 (list printer) |
(2) | on list printers other than printer type 9015 |
INPUT-TRAY-NUMBER = *BY-FORMAT(...)
Defines the input tray by specifying the paper format.
INPUT-TRAY-FORMAT = *UNCHANGED / *A3 / *A4 / *A5 / *B4 / *B5 / *FOLIO / *INVOICE / *EXEC / *LEGAL / *LETTER / *DOUBLE-LETTER / *MONARCH / *COMMERCIAL-10 / *DL / *C5 / *MANUAL /
*A3-UNCUT / *A4-UNCUT / *LEDGER
Apart from *MANUAL, each operand value corresponds to a paper format. To ensure that the values for PAGE-SIZE and LINE-SIZE specified in the FORM operand do not exceed the permissible maximum values for the selected paper format, the values of the FORM operand are compared with the permissible maximum values for the paper format. The table below contains the maximum permissible values for PAGE-SIZE and LINE-SIZE for each paper format and indicates which printers support the paper format. With all paper formats the sheets are taken from the first input tray which contains sheets in the given format.
paper format | max. | max. | applicable to printers of the type |
|---|---|---|---|
A3 | 165 | 116 | 9026-PCL und 9026-RENO |
A4 | 116 | 82 | 9021, 9000-PCL, 9026-PCL, 9026-RENO, 2030-PCL, 4818-PCL, 4821-PCL, 4822-PCL, 4824-PCL and 4825-PCL |
A5 | 82 | 58 | 4818-PCL, 4822-PCL, 4825-PCL, 9026-PCL and 9026-RENO |
B4 | 143 | 101 | 2030-PCL, 4818-PCL, 4821-PCL, 4822-PCL, 4825-PCL, 9000-PCL, 9026-RENO |
B5 | 101 | 71 | 9026-PCL and 9026-RENO |
FOLIO | 129 | 85 | 9026-RENO |
INVOICE | 85 | 55 | 9026-PCL and 9026-RENO |
EXEC | 105 | 72 | 9021, 9000-PCL, 9026-PCL, 2030-PCL, 4821-PCL, 4822-PCL, 4824-PCL and 4825-PCL |
LEGAL | 140 | 85 | 9021, 9000-PCL, 9026-PCL, 9026-RENO, 2030-PCL, 4821-PCL, 4822-PCL, 4824-PCL and 4825-PCL |
LETTER | 110 | 85 | 9021, 9000-PCL, 9026-PCL, 9026-RENO, 2030-PCL, 4821-PCL, 4822-PCL, 4824-PCL and 4825-PCL |
DOUBLE-LETTER | 150 | 117 | 9026-RENO |
MONARCH | 75 | 38 | 9021, 9000-PCL, 2030-PCL, 4821-PCL, 4822-PCL, 4824-PCL und 4825-PCL |
COMMERCIAL-10 | 95 | 41 | 9021, 9000-PCL, 2030-PCL, 4821-PCL, 4822-PCL, 4824-PCL and 4825-PCL |
DL | 86 | 43 | 9021, 9000-PCL, 2030-PCL, 4821-PCL, 4822-PCL, 4824-PCL and4825-PCL |
C5 | 90 | 63 | 9021, 9000-PCL, 2030-PCL, 4821-PCL, 4822-PCL, 4824-PCL and 4825-PCL |
INPUT-TRAY-FORMAT = *MANUAL
Form feed is manual. You should, therefore, insert a new sheet each time a new page is to be printed or the printer prompts you to do so.
The following printers support manual feed: 9004, 9014, 9015, 9021, 9022, 9022-200, 9026-Reno, 9026-PCL, 2030-PCL, 4812, DJET, 4814-PCL, 4818-PCL, 4821-PCL, 4822-PCL, 4824-PCL, 4825-PCL and 9000-PCL.
OUTPUT-TRAY-NUMBER = *UNCHANGED / *STD / *IGNORE / *SORTER(...) / <integer 1..99>
Specifies the paper output tray for LP65 printers and for the RSO printers 2030-PCL, 4818-PCL, 4821-PCL, 4822-PCL, 4824-PCL, 4825-PCL, 9000-PCL, 9014, 9015, 9026-PCL and 9026-RENO.
OUTPUT-TRAY-NUMBER = *STD
Paper is output to the default tray defined in the device record (SPOOL parameter file). The output tray selection is valid for the entire spoolout process, i.e. including processing of header and trailer pages.
Only for LP65 printers:
Selection of the output tray by BS2000 can be prevented by a PCL file or by making an appropriate entry at the printer control console. In these cases, the entries for OUTPUT-TRAY-NUMBER have no effect. An output tray can also be defined in the PCL file.
The order of priority for selecting an output tray is as follows:
the output tray number specified in PRINT-DOCUMENT, provided this is not prevented by a PCL file or an entry at the printer console.
any selection via the PCL file specified in the PRINT-DOCUMENT command.
any selection via the PCL file specified in the form definition in the SPOOL parameter file.
the default values defined in the device record.any selection via the PCL file specified in the PRINT-DOCUMENT command.
OUTPUT-TRAY-NUMBER = *IGNORE
Only for RSO printers.
If this value is specified, the printer controller does not send an output tray selection code to the printer. This allows you to define the output tray in the prolog file.
OUTPUT-TRAY-NUMBER = <integer 1..99>
Specifies the output tray to be used for the current job. Only the values 1..3 are valid for LP65 printers.
RSO printer types | Output tray number | Output tray selection |
|---|---|---|
2030-PCL, 4818-PCL, 4821-PCL, 4822-PCL, 4824-PCL, 4825-PCL, 9000-PCL | 1 | Top output tray |
2 | Bottom output tray | |
9014 | 1 | Stacker |
2 | Front output tray | |
9015 | 1 | Uncut in rear output tray |
2 | Cut in rear output tray | |
3 | Uncut in front output tray | |
4 | Cut in front output tray | |
9026-RENO | 1..20 | Appropriate output tray of the sort mechanism |
OUTPUT-TRAY-NUMBER = *SORTER(...)
Only for RSO printers:
Specifies that the sort mechanism is to be used for the current job. OUTPUT-TRAY-NUMBER = *SORTER(...) is permissible for 9026-RENO, 4822-PCL and 4825-PCL printers. This sort mechanism can be used for up to 20 output trays. It cannot be controlled by the default values defined in the device record.
SORT-MODE = *UNCHANGED
The sorting mechanism is left unchanged.
SORT-MODE = *NO
All pages in the document are output to the sort trays from bottom to top. Exception 9026-RENO: here the pages are output to an output tray to provide optimum access.
SORT-MODE = *GROUP
Each copy of a particular page - if multiple copies are specified in PAGE-COPIES - is output to a separate sort tray. The printer does not return to the first sort tray until it is ready to start outputting the next page in sequence. When the print job is completed, each sort tray used contains a complete copy of the printed document.
Example
There are three pages in the file, and PAGE-COPIES=1 is specified:
Page 3 | Page 3 | |
Tray 1 | Tray 2 | Tray 3 |
SORT-MODE = *COLLATE
All copies of a page - is multiple copies are specified in PAGE-COPIES - are collected in one sort tray. The copies of the next page are placed in the next sort tray. The sort trays are used from bottom to top.
Example
There are three pages in the file, and PAGE-COPIES=2 is specified:
Page 1 | Page 2 | Page 3 |
Tray 1 | Tray 2 | Tray 3 |
SORT-MODE = *STACKER
Cannot be used for the 9026 Printer.
All printed pages are output to the stacker of the sort mechanism, to a maximum of 500 pages. This mode is suitable if a single copy of a very long document is to be printed.
SORT-MODE = *AUTOMATIC
Applicable to the 9026 only. The sort mode is selected automatically depending on the number of copies per page requested in PAGE-COPIES and the number of sort trays available. The printed pages are output unsorted, as with *NO, if the number of copies specified in PAGE-COPIES is the same as the number of sort trays; they are grouped by document, as with *GROUP, if the number of copies specified in PAGE-COPIES is less than the number of sort trays; and they are collected a page at a time, as with *COLLATE, if the number of copies specified in PAGE-COPIES is greater than the number of sort trays.
Note
Header and trailer pages are printer resources such as prolog, epilog, DIA, member and font character file are sent before output tray selection and are therefore not included in sorting.
TOP-OFFSET = *UNCHANGED / *IGNORE / <integer -255..255>
Defines in millimeters the margin between the top of the physical sheet and the top of the print page. First the print page is positioned on the paper and only then is the lettering within the page rotated and positioned. This means that when the print page is moved with respect to the paper page the orientation of the text within the print page is ignored.
This operand is permissible only for 4818-PCL, 4821-PCL, 4822-PCL, 4824-PCL, 4825-PCL, 9000-PCL, 9021, 9022-200 and 2030-PCL printers.
Note
Only TOP-OFFSET=*IGNORE can be specified in conjunction with DOCUMENT-FORMAT=*SPECIAL-FORMAT.
TOP-OFFSET = *IGNORE
The printer controller does not set a margin between the first line and the top edge of the sheet. The preset printer value or the setting in the prolog file defines the margin that is effective when the document is printed.
TOP-OFFSET = <integer -255..255>
The permissible range of values is -255 to +255. Positive values move the first line down. Negative values move it up.
LEFT-OFFSET = *UNCHANGED / *IGNORE / <integer -255..255>
Defines in millimeters the margin between the left edge of the physical sheet and the left edge of the print page. First the print page is positioned on the paper and only then is the lettering within the page rotated and positioned. This means that when the print page is moved with respect to the paper page the orientation of the text within the print page is ignored.
This operand is permissible only for 4818-PCL, 4821-PCL, 4822-PCL, 4824-PCL, 4825-PCL, 9000-PCL, 9021, 9022-200, 9026-PCL and 2030-PCL printers.
Note
Only LEFT-OFFSET=*IGNORE can be specified in conjunction with DOCUMENT-FORMAT=*SPECIAL-FORMAT.
LEFT-OFFSET = *IGNORE
The printer controller does not set a margin between the print page and the left edge of the sheet. The preset printer value or the setting in the prolog file defines the margin that is effective when the document is printed.
LEFT-OFFSET = <integer -255..255>
The permissible range of values is -255 to +255. Positive values move the print page to the right. Negative values move it to the left.
RESOURCE-DESCRIPTION = *UNCHANGED / *PARAMETERS(...)
Contrary to original declarations, defines all print resources to be used for the printout in the PRINT-DOCUMENT command.
RESOURCE-DESCRIPTION = *PARAMETERS(...)
FORM-NAME = *UNCHANGED / *STD / <alphanum-name 1..6>
Specifies the paper (form) to be used for output (e.g. STD, STDSF1, STDWA4). Default forms must be defined in the SPOOL parameter file for all printer types. With SHOW-SPOOL-FORMS you can output the entries to SYSOUT. The SPOOL parameter file also specifies whether header and trailer pages are to be printed.
FORM-NAME = *STD
Default form.
FORM-NAME = <alphanum-name 1..6>
Name of the form with which the spoolout job is to be processed. A loop (or a page and format definition for APA printers) is implicitly named when the form is specified. The associated loop (or the PAGEDEF and FORMATDEF) must be in a particular printer control file. The following table shows which printer control file must contain this loop (or the PAGEDEF and FORMDEF) for the relevant printer type:
Output device | Printer control file with loop for specified form |
|---|---|
Printers 3337, 3338, 3339, 3348, 3349, 3365, LP-EMULATED | $SYSSPOOL.PRFILE |
Printers: 3351, 3353, 2090, 2140, 2240 | $SYSSPOOL.PRFILE or the PRFILE user specified in the USER-RESOURCES-FILE operand |
APA printer | $SYSSPOOL.SYSPRT.SPS.<version> or the SPSLIB user specified in the USER-RESOURCES-FILE operand |
The loop named implicitly via the FORM-NAME operand is ignored if the LOOP-NAME operand is specified at the same time. If the FORM-NAME and LOOP-NAME operands are omitted, the file is printed out using the default form entered for the printer type.
A loop explicitly specified in the LOOP-NAME operand must have the same length as the loop record assigned to the form used.
No loops can be specified for APA printers. If page and format specifications are made in the FORM-NAME operand, these are used for printing header, trailer and message pages, even if the PAGE-DEFINITION and FORM-DEFINITION operands are explicitly assigned.
LOOP-NAME = *UNCHANGED / *STD / <alphanum-name 1..3>
Name of the loop to be loaded into the feed information buffer (VFB/FCB). The loop name must not include the characters '$', '&' or '@'.
LOOP-NAME = *STD
Feed control for the spoolout job is to be implemented with the default loop of the form used.
LOOP-NAME = <alphanum-name 1..3>
Name of the loop which is to control line feed. The length of the specified loop must match the length of the default loop of the form used.
A loop for feed control is needed for the HP and HP90 printers (3351, 3353, 2090, 2140) and printers of types 3337, 3338, 3339, 3348, 3349 and 3365. Loops are stored in the PRFILE resource library. If no loop is specified, the implicit entries in the FORM-NAME operand are used. If the FORM-NAME or LOOP-NAME operand is omitted, default values apply.
ROTATION-LOOP-NAME = *UNCHANGED / *STD / <alphanum-name 1..3>
Only for HP and HP90 printers with a page rotation module.
Specifies the loop to control output in landscape format.
The loop name must not include the characters '$', '&' or '@'.
ROTATION-LOOP-NAME = *STD
Output of rotated pages is to be controlled by the default rotation loop of the specified form or the default rotation loop R06 of the default form (if no form was specified in the PRINT-DOCUMENT command).
ROTATION-LOOP-NAME = <alphanum-name 1..3>
Name of the loop with which line feed for the rotated pages is to be controlled.
CHARACTER-SETS = *UNCHANGED / *STD / *POOL(...) / *BY-EXTENDED-NAME(...) /
list-poss(16): <alphanum-name 1..3>
Names of the fonts or font pools (only for HP and HP90 printers) to be used for output. Up to 4 fonts may be specified in the list for local SPOOL, up to 16 for RSO. For local SPOOL, the fonts must be contained in the $SYSSPOOL.PRFILE resource library or in a user PRFILE (specified by means of the USER-RESOURCES-FILE operand).
If more than four fonts are to be used, a font pool must be specified.
If more than one font is to be used in a spoolout job, CONTROL-MODE=*PAGE-MODE must be specified. For DOCUMENT-FORMAT=*TEXT, only the first specified font is used for printing the (entire) file. The name of the first font and the number of specified fonts are shown in the output for the command SHOW-PRINT-JOB-STATUS JOB-IDENTIFICATION=TSN(TSN=...).
If the HEADER-LINE operand is specified, the first font specified or the font pool specified with an index for CHARACTER-SETS=*POOL is used for the header line. The default value for CHARACTER-SETS for the form used can be displayed using SHOW-SPOOL-FORMS; the information is given in the C-S output field. With HP printers the following must be borne in mind: Systems support can specify whether the header page is printed with the default font or with the font specified in CHARACTER-SETS. This default value can be displayed by means of the command or SPSERVE statement SHOW-SPOOL-PARAMETERS; the information is given in the HEADER-PAGE: CHARACTER-SET=... output field.
CHARACTER-SETS = *STD
The default font is selected for this printer type from the desired form. It can be displayed by means of SHOW-SPOOL-FORMS.
CHARACTER-SETS = *POOL(...)
Only PRFILEs may contain descriptions of font pools. If a font pool is specified, the spoolout job will be processed on an HP or HP90 printer.
POOL-NAME = *UNCHANGED / <alphanum-name 1..4>
Specifies a font pool (with a maximum of 64 fonts for an HP printer or 46 fonts for an HP90 printer) from which one or more fonts are to be used for output. All the fonts of this font pool are loaded into the font buffer when the spoolout job is executed.
POOL-INDEX = *UNCHANGED / <integer 0..64>
Number of the font from the font pool with which the spoolout job is to be processed. The number of the font is determined by its position in the definition of the font pool. The specified font is used if POOL-INDEX is specified together with CONTROL-MODE= *PAGE-MODE.
CHARACTER-SETS = *BY-EXTENDED-NAME(...)
Specifies the fonts to be interpreted by SPS when the TABLE-REFERENCE-CHAR operand is used.
NAME = *UNCHANGED / <alphanum-name 1..8>
Names of the fonts to be linked with the TRC value in the print file (each TRC value represents a specific font). Regardless of the number of different TRC values in the file, up to four fonts, specified in the form of a list, can be used to print the records. TRC values greater than X‘03’ (corresponding to the fourth value in the list) automatically reference the first font in the list.
CHARACTER-SETS = list-poss(16): <alphanum-name 1..3>
Names of the fonts with which the spoolout job is to be processed. For DOCUMENT-FORMAT=*TEXT (default), only the first specified font is used for printing.
For laser printers in local SPOOL mode, a maximum of four fonts may be specified. The printer control characters for changing fonts are only interpreted if CONTROL-MODE=*PAGE-MODE is also specified. In the case of RSO printers, a maximum of 16 fonts may be specified. Font identifiers (CSIs) in the text are only interpreted if CONTROL-MODE=*LOGICAL is specified at the same time. The command is rejected if a list of fonts is specified in conjunction with DOCUMENT-FORMAT=*TEXT.
CHAR-SET-ATTRIBUTES = *UNCHANGED / *ALL / *RESTRICTED
Only for RSO.
Specifies whether all or only selected font attributes are supported for the spoolout job. Such attributes are, for instance, character type, near letter quality (NLQ), color, etc. (see command or SPSERVE statement SHOW-SPOOL-CHARACTER-SETS). This operand does not apply to header and trailer pages.
CHAR-SET-ATTRIBUTES = *ALL
All the attributes of the fonts used for printout are supported for the current spoolout job.
CHAR-SET-ATTRIBUTES = *RESTRICTED
Only the following three attributes are supported:
- character type
- language
- NLQ (NEAR-LETTER-QUALITY)
OVERLAY-RESOURCES = *UNCHANGED / *PARAMETERS(...)
Specifies whether a film overlay - in the case of HP90 and 3365 printers an EFO data overlay - or an FOB data overlay is to be used for processing a spoolout job.
ELECTRONIC-OVERLAY = *UNCHANGED / *NONE / <alphanum-name 2..2>
Specifies whether a film overlay - in the case of HP90 and 3365 printers an EFO data overlay - is to be used for processing a spoolout job.
ELECTRONIC-OVERLAY = *NONE
No film overlay (HP90 and 3365: no EFO data overlay) is used for output.
ELECTRONIC-OVERLAY = <alphanum-name 2..2>
Name of the film overlay (HP90 and 3365: EFO data overlay) to be used for processing the spoolout job (the name must be agreed with systems support).
OVERLAY = *UNCHANGED / *STD / *NONE / *PARAMETERS(...)
Specifies for LP65 printers whether EFO data overlays are to be used on the recto and/or verso.
They must be stored in the printer memory. The OVERLAY, TWO-SIDED and PAGE-COPIES operands are part of one and the same LP65 printer command and are consequently linked to one another. If only the OVERLAY operand is specified, SPOOL will generate default values for the other two operands. These default values are overwritten by each value specified in a PCL file or at the printer control console.
For a summary of the possible combinations of these three linked functions, see the description of the LP65 printer type in the “SPOOL” manual [43].
OVERLAY = *STD
The EFO data overlays defined in the PCL file are used.
OVERLAY = *NONE
No EFO data overlays are used for output.
OVERLAY = *PARAMETERS(...)
The specified EFO data overlays are used for output.
FACE-SIDE = *UNCHANGED / *NONE / <integer 1..127>
Identification number of the overlay to be used on the recto.
REVERSE-SIDE = *UNCHANGED / *NONE / <integer 1..127>
Identification number of the overlay to be used on the verso.
FORMS-OVERLAY-BUFFER = *UNCHANGED / *NONE / <alphanum-name 1..4>
Specifies whether an FOB data overlay is to be used for processing the spoolout job (see the “SPOOL” manual [43] for a description of an overlay).
FORMS-OVERLAY-BUFFER = *NONE
o FOB data overlay is used for output.
FORMS-OVERLAY-BUFFER = <alphanum-name 1..4>
Name of the overlay to be used for processing the spoolout job.
If an overlay is specified, the file is printed out on an HP or HP90 printer.
Use of an overlay for the spoolout job is indicated in the output of the command SHOW-PRINT-JOB-STATUS JOB-IDENTIFICATION=TSN(TSN=...).
PAGE-DEFINITION = *UNCHANGED / *STD / <integer 1..50000> / <alphanum-name 1..8>
Specifies which page definition is to be used for output on LP65 or APA printers.
PAGE-DEFINITION = *STD
The standard definition specified in the SPSLIB is to be used (see the table of SPSLIB standard definitions in the “SPOOL” [43] manual).
PAGE-DEFINITION = <integer 1..50000>
Only for LP65 printers:
Number of the PCL file with which the print file is to be output.
PAGE-DEFINITION = <alphanum-name 1..8>
The page definition with the specified name is to be used. This must be in the SPSLIB.
FORM-DEFINITION = *UNCHANGED / *STD / <alphanum-name 1..8>
Specifies which format definition is to be used for output on APA printers.
FORM-DEFINITION = *STD
The default definition specified in the SPSLIB is to be used.
FORM-DEFINITION = <alphanum-name 1..8>
The format definition with the specified name is to be used. This must be in the SPSLIB.
USER-RESOURCES-FILE = *UNCHANGED / *STD / <filename 1..44 without-gen-vers>
Specifies a user file containing all the resources required for output on different printer types: user-defined loops, fonts, overlays, font pools, code translation tables, and SPS data stream definitions. The following can be specified:
a user PRFILE containing loops, fonts, overlay entries (FORMS-OVERLAY-BUFFER operand) and font pool entries (CHARACTER-SETS operand)
a user SPSLIB containing the PAGEDEFs (PAGE-DEFINITION operand), FORMDEFs (FORM-DEFINITION operand), fonts, page segments, overlays and raster image data
a user RSOFILE (only for RSO) containing loops
USER-RESOURCES-FILE = *STD
If no user PRFILE, SPSLIB or RSOFILE is specified, the information is taken from the following files: $SYSSPOOL.PRFILE, $SYSSPOOL.SYSPRT.SPS.<version> or $SYSSPOOL.RSOFILE, respectively.
The required resources are taken from $SYSSPOOL.PRFILE, $SYSSPOOL.SYSPRT.SPS.<version> or $SYSSPOOL.RSOFILE.
USER-RESOURCES-FILE = <filename 1..44 without-gen-vers>
Name of a user PRFILE, SPSLIB or RSOFILE, which may contain a catalog ID and a user ID. SPOOL uses this file name with the suffix .PRFILE, .SPSLIB or .RSOFILE. The string can contain up to 28 characters without the catalog ID and user ID, to ensure that this user file can be called from any ID.
If the file name is specified without a user ID, the file is searched for under the user ID of the caller first, then under SYSSPOOL. If it is not found, the command is rejected. If a user ID is specified, the file is searched for under this ID only.
Example 1
PRINT-DOCUMENT DATEI,USER-RESOURCES-FILE=$XX.XX
A search is carried out for the $XX.XX.PRFILE file. If the file is not found, the command is rejected.
Example 2
If the catalog ID is specified, the search is limited to the specified pubset:
PRINT-DOCUMENT DATEI, USER-RESOURCES-FILE=:A:XXXXX
The file :A:$userid.XXXXX.PRFILE is searched for. If the relevant file is not found, the search for the file :A:$SYSSPOOL.XXXXX.PRFILE is continued. If this file is not found, the command is rejected.
Example 3
PRINT-DOCUMENT DATEI, USER-RESOURCES-FILE=:A:$XX.XXXXX
The file :A:$XX.XXXXX.PRFILE is searched for. If it is not found, the command is rejected.
If the file is on an exported PVS (EXPORT-PUBSET command), all spoolout jobs that require this PVS are placed in the KEEP queue. When the PVS becomes available again (IMPORT-PUBSET command), the spoolout jobs are restarted.
TRANSLATION-TABLE = *UNCHANGED / *NONE / *PARAMETERS(...)
Specifies whether a code translation table is to be used for processing the spoolout job. The code translation table is necessary if the default escape character 'FF' is to be replaced by a random character.
TRANSLATION-TABLE = *NONE
No code translation table is used.
TRANSLATION-TABLE = *PARAMETERS(...)
A code translation table is used.
NAME = *UNCHANGED / <alphanum-name 1..8>
Name of the code translation table to be used for processing the spoolout job.
FILE = *UNCHANGED / *SYSTEM / <filename 1..44 without-gen-vers>
The specified code translation table is by default taken from the $SYSSPOOL.PRFILE (*SYSTEM) file; for RSO printers a user RSOFILE can also be specified.
RESOURCES-LOCATION = *UNCHANGED / *STD / *HOME / *SERVER
Only for Dprint. Specifies, when the optional Distributed Print Services subsystem (Dprint) is used, whether the resources of the client or those of the server are to be used for printing the document.
RESOURCES-LOCATION = *STD
The value from the GEN record of the SPOOL parameter file is to be used.
RESOURCES-LOCATION = *HOME
The print job is to be executed using the print resources defined on the client system. In this case, an extract containing all the required print resources is taken from the resource file (i.e. a print resources container is created) and transferred to the selected server.
RESOURCES-LOCATION = *SERVER
The print job is to be executed using the print resources defined on the server system. In this case, no print resources container is created and transferred.
TO-PRINTER = *UNCHANGED / *PARAMETERS(...)
Modifying the original declarations specifies the requested target devices for the print output in the PRINT-DOCUMENT command.
TO-PRINTER = *PARAMETERS(...)
PRINTER-NAME = *UNCHANGED / *STD / <alphanum-name 1..8> / *IPP(...)
Specifies the requested target printer of the print job. You can specify a distributed local printer pool, a nondistributed local printer pool, an RSO printer pool or an RSO printer.
If you specify a printer pool:
The job is output on any printer in the specified device pool. The pool must be defined in the SPOOL parameter file and can contain up to 16 RSO devices or 16 local SPOOL devices, but not both at the same time.
Device pools are managed by means of the SPSERVE statements ADD-, MODIFY-, REMOVE-, and SHOW-PRINTER-POOL (see the “SPSERVE” manual [44]).
The spoolout job is rejected if:
no printer type from the device pool is assigned in the PRINT-DOCUMENT command (see the SHOW-SPOOL-FORMS command or SPSERVE statement)
the ELECTRONIC-OVERLAY operand is specified.
Please bear in mind that the pool can contain various types of devices: if the file to be printed contains control characters that are only interpreted by a certain printer type, a printer of this type should be specified (implicitly) in the MODIFY-PRINT-JOB-ATTRIBUTES command.
PRINTER-NAME = *STD
The spoolout job is to be processed on the default device type specified in the SPOOL parameters (PRINT-CMD-DEFAULTS).
PRINTER-NAME = <alphanum-name 1..8>
Only for RSO.
Symbolic name of the RSO device on which the spoolout job is to be processed.
PRINTER-NAME = *IPP(...)
Only for RSO.
The spoolout job is to be processed on an IPP printer.
URL = *UNCHANGED / <c-string 1..1023 with-low>
Specifies the Web address of the IPP printer.
FQDN = *UNCHANGED / *NONE / <c-string 1..1023 with-low>
Fully-qualified name of the domain to which the IPP printer is assigned.
PRINTER-TYPE = *UNCHANGED / *ANY / *HP-PRINTER / *LP65-PRINTER / *APA-PRINTER
Specifies which printer type is to process the print job. Only local printer types may be specified.
PRINTER-TYPE = *ANY
A specific printer type is not requested. In this case, the SPOOL subsystem automatically determines the permitted printer types that can process the user request. *ANY must be specified for output on RSO printers.
PRINTER-TYPE = *HP-PRINTER
The spoolout job is to be processed on an HP or HP90 printer.
*HP-PRINTER includes the following printer types: 2090/2140/2240(HP90). The control characters for HP and HP90 laser printers are identical; a spoolout job for an HP printer can be processed on an HP90 printer and vice versa.
Selection of the printer type is affected by whether the CONTROL-MODE operand is specified at the same time:
Printer selection | CONTROL-MODE = *PAGE-MODE | CONTROL-MODE =*PAGE-MODE |
|---|---|---|
PRINTER-TYPE = *ANY | Output can take place to all printer types | Output can take place to HP or HP90 printers. |
The following also applies for HP-/HP90 printers: | ||
PRINTER-TYPE = *HP-PRINTER | Output can only be processed on HP and HP90 printers. The OVERPRINT function is converted to the LINE-MERGE function. | |
Restrictions for PRFILE: | Support of the HP-specific control characters. | |
Note for HP/HP90 printers
If the entries in MODIFY-PRINT-JOB-ATTRIBUTES specify output to an HP or HP90 laser printer, a PRFILE must be available. If they are not, the command is rejected. If there is no HP/HP90 available in an installation, or only devices with insufficient configurations (not enough fonts, no graphics buffer for FOBs or no page rotation module, for example), the jobs can only be output to replay tape. Systems support can run the SHOW-SPOOL-JOB-STATUS command to obtain information on these jobs.
PRINTER-TYPE = *LP65-PRINTER
The spoolout job is to be processed on an LP65 printer.
PRINTER-TYPE = *APA-PRINTER
The spoolout job is to be processed on a 2050-APA-PRINTER, 2090-APA-PRINTER or 2090-TWIN-PRINTER.
REDIRECTION-ALLOWED = *UNCHANGED / *STD / *YES / *NO
Specifies whether a device administrator can redirect the spoolout job to a different printer. This does not affect the redirection of jobs by the user or by systems support.
REDIRECTION-ALLOWED = *STD
Means YES for RSO print jobs. SPOOL print jobs are ignored.
REDIRECTION-ALLOWED = *YES / *NO
Can only be specified for RSO print jobs, not for SPOOL print jobs.
CLUSTER-NAME = *UNCHANGED / <alphanum-name 1..8>
Specifies the cluster to which the print job is to be transferred.
Only for Dprint: To transfer the print job to a UNIX-based system, a cluster name defined in the Dprint configuration file must be specified. The remote clusters defined in the Dprint configuration file can be displayed by means of the SHOW-DPRINT-REMOTE-CLUSTERS command (for a detailed explanation, see the “Dprint” manual [10]).
Use of the CLUSTER-NAME operand is restricted to one print job from the local cluster or from the local SPOOL to a remote cluster. As soon as the remote cluster has accepted the print job, the resources of the remote cluster become effective. From this time the CLUSTER-NAME operand can no longer be applied to the redirected print job.
OUTPUT-FORMAT = *UNCHANGED / *NONE / <c-string 1..63 with-low>
Specifies which printer language is to be used for the print job.
OUTPUT-FORMAT = *NONE
No output format was specified. The format of the document is compatible with the printer language of the printer selected. If a cluster was specified in the CLUSTER-NAME operand, the value of the DOCUMENT-FORMAT operand is forwarded to the UNIX-based system.
OUTPUT-FORMAT = <c-string 1..63 with-low>
Specifies a specific content type (e.g. HP_LASERJET) for the document to be printed. The document format is incompatible with the format which is supported by the printer. Only when a cluster is supported in the CLUSTER-NAME operand is it permissible to specify OUTPUT-FORMAT=<c-string 1..63 with-low>. In this case the value of the OUTPUT-FORMAT operand is transferred to the UNIX-based system.
VIRTUAL-PRINTER = *UNCHANGED / *STD / *ALLOWED / *NOT-ALLOWED / MUST(...)
This operand enables the print job to be forwarded for processing to an application via a virtual printer.
VIRTUAL-PRINTER = *STD
The virtual printer which is to receive the print job is determined through the SPOOL parameter file.
Assignment of the print job to a virtual printer is given precedence. If no virtual printer is active when the print job is added to the list of print jobs, the print job is assigned to a real printer.
VIRTUAL-PRINTER = *ALLOWED
This print job may be forwarded to an application program via a virtual printer. What virtual printer receives the print job is only determined when the job is assigned. Assignment of the print job to a virtual printer is given precedence. If no virtual printer is active when the print job is added to the list of print jobs, the print job is assigned to a real printer.
VIRTUAL-PRINTER = *NOT-ALLOWED
This print job should not be transferred to an application program via a virtual device.
VIRTUAL-PRINTER = *MUST(...)
This print job is transferred to the virtual printer specified by the parameters in the brackets. If the printer’s supervisor task is inactive, the print job waits.
NAME = <alphanum-name 1..8>
Specifies the device name which is linked to the supervisor. This device name appears in the device entry of the SPOOL parameter file.
STRING = *NONE / <c-string 1..32>
Passes a character string on to the application program.
ADDITIONAL-COPIES = *UNCHANGED / <integer 0..255>
Specifies how many additional times the file is to be printed.
The entry can also be made in parentheses. Each additional printout has its own header page. Default: 0 (no additional printouts).
LOCK-FILE = *UNCHANGED / *YES / *NO
Specifies whether the file is to be protected as long as the spoolout job is in the wait state (TYPE 4, see output of the SHOW-PRINT-JOB-STATUS command). During this time the file can only be read. As a rule, tape files are never locked. During processing of the spoolout job (TYPE 5, see output of the SHOW-PRINT-JOB-STATUS command), the file is protected irrespective of the setting of this operand.
A spoolout job is created even if the file to be output is reserved by a SECURE-RESOURCE-ALLOCATION command. This reservation must, however, be canceled by the time the spoolout job is processed; otherwise, the job is not executed. The file to be output is locked until the end of the session if the LOCK-FILE=*YES operand is specified in the PRINT-DOCUMENT command and the job cannot be executed owing to reservation.
LOCK-FILE = *YES
The file is protected while the spoolout job is in the wait state. LOCK-FILE=*YES is ignored if one of the values *OMF, *SYSLST or *SYSOUT is specified for the operand at the same time. A PRINT-DOCUMENT command for a library element with LOCK=*YES is rejected. File protection offered by LOCK-FILE=*YES remains in force even if the spoolout job is not processed until the next system run.
LOCK-FILE = *NO
The file is not protected while the spoolout job is in the wait state. The file can be deleted or modified before processing of the spoolout job commences.
LOCK-FILE=*NO is ignored for temporary files.
DELETE-AFTER-PRINT = *UNCHANGED / *NO / *YES(...) / *DESTROY(...)
Specifies whether the file is to be deleted after output has terminated and, if so, whether its catalog entry and the data are to be overwritten with X'00..0'. 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 the FROM-FILE operand), the DELETE-AFTER-PRINT operand is ignored. If a spoolout job is used to print several elements of a PLAM library with INPUT-SECTION(...), the DELETE-AFTER-PRINT operand is set to *NO (i.e. suppressed). This operand may not be specified in conjunction with *SYSLST, SYSLSTnn or *SYSOUT.
DELETE-AFTER-PRINT = *NO
The file is not to be deleted after printing (unless it is an EAM or system file).
DELETE-AFTER-PRINT = *YES(...)
The file is to be deleted as soon as output has been completed.
LINE-TRUNCATION = *UNCHANGED / *STD / *DELETE-FILE / *KEEP-FILE
Specifies what happens if lines are truncated.
LINE-TRUNCATION = *STD
The default value from the SPOOL parameter is valid. You can display this value by means of the SHOW-SPOOL-PARAMETERS command or SPSERVE statement (field: ERROR-PR=(TRUNC=)).
LINE-TRUNCATION = *DELETE-FILE
Processing of the spoolout job continues (i.e. DELETE-AFTER-PRINT=*YES is executed). An appropriate warning is printed on the trailer page.
LINE-TRUNCATION = *KEEP-FILE
Processing of the spoolout job is continued, but the file is not subsequently deleted.
DELETE-AFTER-PRINT = *DESTROY(...)
Not for EAM and cataloged system files.
Specifies that once the file has been printed both its catalog entry and the data itself are to be overwritten with binary zeros.
LINE-TRUNCATION = *UNCHANGED / *STD / *DELETE-FILE / *KEEP-FILE
Specifies what happens if lines are truncated.
LINE-TRUNCATION = *STD
The default value from the SPOOL parameter is valid. You can display this value by means of the SHOW-SPOOL-PARAMETERS command or SPSERVE statement (field: ERROR-PR=(TRUNC=)).
LINE-TRUNCATION = *DELETE-FILE
Processing of the spoolout job continues (i.e. DELETE-AFTER-PRINT=*DESTROY is executed). An appropriate warning is printed on the trailer page.
LINE-TRUNCATION = *KEEP-FILE
Processing of the spoolout job is continued, but neither the catalog entry nor the data of the file itself is overwritten with binary zeros.
Return codes
(SC2) | SC1 | Maincode | Meaning/Guaranteed messages |
|---|---|---|---|
0 | CMD0001 | No error | |
2 | 0 | SCP0897 | TSN not found |
2 | 0 | SCP0930 | PRFILE not available |
2 | 0 | SCP1000 | JV processing error. MONJV ignored |
2 | 0 | SCP1056 | Error releasing the file |
2 | 0 | SCP1058 | DELETE-FILE entry not permitted |
2 | 0 | SCP1061 | Error during server access |
2 | 0 | SCP1069 | Output restart from the beginning |
2 | 0 | SCP1070 | Job cannot be released |
2 | 0 | SCP1076 | No information available on this job |
2 | 0 | SPS0455 | JVS error in SPOOL MONJV |
2 | 0 | SPS0469 | JV is already being used or has been destroyed |
2 | 0 | SPS0464 | JV subsystem not loaded |
2 | 0 | SPS0870 | SLOT/SCB inconsistency |
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 | SCP0896 | DPRINTCL not loaded | |
128 | SCP0996 | JV subsystem not available | |
128 | SCP1049 | RSO not loaded | |
128 | SPS0266 | SPOOL subsystem in the wait state |
Notes
If a value of an operand originally specified in the PRINT-DOCUMENT command is modified, this modification has an effect not only on the operand itself but also on the structures which are subordinate to this operand: All suboperands within the structure are preset with default values.
Jobs which were issued in an earlier SPOOL run < V3.0 and were taken over by means of a replay tape or warm startup, and print jobs which were initiated by the WRITE-SPOOL-TAPE command cannot be modified.
In the event of a command error (syntax, semantics or inadmissible modifications), the requested modifications are ignored.
The table below shows which operand modifications can be performed depending on the status of the print job, where the symbols used have the following meaning:
x
Modification permitted for the operand and all suboperands (operands which are included in substructures).
-
Modification not permitted
(*)
If the job is active on a synchronous virtual device, the application running under control of this virtual device can modify the job.
Operands of MOD-PRINT-JOB-ATTR
Print job statuses
WFT
FT
WP
PRE
WT
ACT
KP
DOCUMENT-FORMAT
x
x
x
-
x
(*)
x
PRINT-JOB-CONTROL
x
x
x
-
x
(*)
x
LAYOUT-CONTROL
x
x
x
-
x
(*)
x
RESOURCE-DESCRIPTION
x
x
x
-
x
(*)
x
TO-PRINTER
x
x
x
-
x
(*)
x
Table 70: Changes with MODIFY-PRINT-JOB-ATTRIBUTES contingent upon the job statusThe file attributes must remain unchanged between acceptance of the print job (PRINT-DOCUMENT command) and termination of the output (actual output on the device). The MODIFY-PRINT-JOB-ATTRIBUTES command consequently ignores any change to the file attributes.
When at least one member of the FAMILY is active in the case of FAMILY processing, any modification of the print job is rejected.
Print jobs in the KEEP status remain in the KEEP status after being modified even if they have been redirected to another server by means of automatic server selection.
When a document has been partially printed and the corresponding print job is interrupted, any modification which includes a modification to the layout results in the print job being repeated from the start of the document.
Please refer to the “Dprint” manual [10] for Dprint-specific information for Dprint jobs.