OUTDES statement syntax
The syntax of the OUTDES statement follows. Definitions of the operands and keyword operands follow the syntax diagram.
OUTDES | |
ADDRESS('address'...) |
|
BUILDING('building') |
|
BURST |
Default: NOBURST |
CHARS(charname,...) |
|
CKPTLINE(nnnnn) | |
CKPTPAGE(nnnnn) | |
CKPTSEC(nnnnn) | |
CLASS(output-class) | |
COMPACT(compaction-table-name) | |
CONTROL(PROGRAM) |
Default: PROGRAM |
COPIES(nnn,(group value,...) | |
DATACK(BLKCHAR) |
|
DEFAULT |
|
DEPT('dept') |
|
DEST(destination) |
|
DPAGELBL |
|
FCB(fcb-name) | |
FLASH(overlay,count) | |
FORMDEF(member-name) | |
FORMS(forms-name) | |
GROUPID(output-group-name) | |
INDEX(nn) | |
LINDEX(nn) | |
LINECT(nn) | |
MODIFY(module-name) |
|
NAME('name') |
|
NOTIFY(node.userid) |
|
OUTDISP(normal-output-disp,abnormal-output-disp) | |
PAGEDEF(member-name) | |
PIMSG(YES,nnn) |
|
PRMODE(process-mode) | |
PRTY(nnn) | |
ROOM('room') |
|
SYSAREA |
|
THRESHLD(nnnnnnnn) | |
TITLE('title') |
|
TRC |
Default: NOTRC |
UCS(ucs-name) | |
USERDATA(userdata1) |
|
USERLIB(dsname) |
|
WRITER(external-writer-name) | |
The elements of the syntax are described as follows:
- ADDRESS('address'...)
- ADDRESS(address...)
- ADDRESS('address1','address2',...,'address4')
- ADDRESS(address1,address2,...,address4)
- specifies a delivery address for system output. Enter one to
four address values. To skip an address value, enter a comma without
specifying an address, for example, ADDRESS(,'addr2',addr4). One to
60 EBCDIC text characters may be specified for each sub-address specified.
For example, if you specify ADDRESS(address1,address2), address1
and address2 may each be 60 characters. See Rules for parsing data with and without quotation marks for
the values that may be used with and without quotation marks.
Minimum abbreviation: 4
- BUILDING('building')
- BUILDING(building)
- specifies a location to be used for delivery of system output.
One to 60 EBCDIC text characters may be specified. See Rules for parsing data with and without quotation marks for the values that may be used with and
without quotation marks.
Minimum abbreviation: 5
- BURST
- NOBURST
- BURST specifies that 3800 output is to be burst into separate
sheets.
Minimum abbreviation: 3
NOBURST specifies that the printed 3800 output is to be in continuous fanfold pages. NOBURST is the default.
Minimum abbreviation: 5
- CHARS(charname,...)
- CHARS(charname1,charname2,...,charname4)
- specifies one or more font (character arrangement) tables for
printing the SYSOUT data set on a 3800 printer. You can specify up
to four table names. Specify from 1 to 4 characters (alphabetic, numeric,
or @, #, or $) for the character name.
Minimum abbreviation: 3
- CKPTLINE(nnnnn)
- specifies the maximum number of lines contained in a logical page.
Specify a value from 1 through 32767. The system uses this value either
for job entry subsystem (JES) checkpointing of printed output or for
Systems Network Architecture (SNA) transmission checkpoints. Use CKPTLINE
in combination with the CKPTPAGE operand.
If you do not specify CKPTLINE, JES2 uses an installation default specified at initialization.
Minimum abbreviation: 5
- CKPTPAGE(nnnnn)
- specifies the maximum number of pages to be printed or transmitted
before the next SYSOUT data set checkpoint occurs. Specify a value
from 1 through 32767. This value represents the number of pages to
be transmitted as a single SNA chain when data is transmitted to a
SNA workstation. Use CKPTPAGE in combination with the CKPTLINE operand.
If you do not specify CKPTPAGE, JES2 uses the installation default specified at initialization. The default may also indicate whether checkpoints are to be based on page count or time.
Minimum abbreviation: 5
- CKPTSEC(nnnnn)
- specifies the number of seconds that are to elapse between checkpoints
of the SYSOUT data set that is printing. Specify a value from 1 through
32767.
If you do not specify CKPTSEC, JES2 uses the installation default specified at initialization. The default may also indicate whether checkpoints are to be based on page count or time.
Minimum abbreviation: 5
- CLASS(output-class)
- specifies the output class JES is to use for processing the specified
SYSOUT data set. Valid output classes are characters A-Z or 0-9. The
default output class is A.
Minimum abbreviation: 3
- COMPACT(compaction-table-name)
- specifies the name of the compaction table to be used when the
data set is transmitted to a workstation. Specify a 1- to 8-character
alphabetic or numeric symbolic name.
If you do not specify COMPACT, compaction is suppressed for the data set.
Minimum abbreviation: 3
- CONTROL(PROGRAM)
- CONTROL(SINGLE)
- CONTROL(DOUBLE)
- CONTROL(TRIPLE)
- specifies the type of forms control to be used.
PROGRAM indicates that the carriage control character of each data record is to control line spacing on the form. PROGRAM is the default.
SINGLE indicates forced single spacing.
DOUBLE indicates forced double spacing.
TRIPLE indicates forced triple spacing.
Minimum abbreviation: 3
- COPIES(nnn,(group-value,))
- specifies the number of copies to be printed for the data set.
The number of copies, nnn, can range from 1 to 255, subject
to an installation limit. The default is 1.
If you use COPIES on a referenced FORMDEF operand, the system ignores the COPIES value.
If you specify group values, the system ignores the individual value, nnn, for the 3800 printer. The group values describe how the printed copies are to be grouped (3800 printer only). Each group value specifies the number of copies of each page that are to be grouped together. You can specify up to eight group values. For example, a group value of 3 causes the first page of a data set to be printed three times before printing is started for the second page, which will also be printed three times, and so forth.
Minimum abbreviation: 3
- DATACK(BLKCHAR)
- DATACK(BLKPOS)
- DATACK(BLOCK)
- DATACK(UNBLOCK)
- specifies whether “print positioning” and “invalid character”
data check errors are to be blocked or unblocked for printers accessing
through the Print Services Facility™ (PSF).
BLKCHAR specifies character errors that are not valid are to be blocked. The errors are not reported to PSF. Print positioning errors are reported normally.
BLKPOS specifies print positioning errors are to be blocked, and not reported to PSF.
BLOCK specifies neither print positioning errors nor character errors are reported to PSF.
UNBLOCK specifies both print positioning errors and character errors are reported to PSF.
If you do not specify DATACK, the DATACK specification from the PSF PRINTDEV statement is used. If it is not specified in the PRINTDEV statement, the default is BLOCK.
Minimum abbreviation: 6
- DEFAULT
- NODEFAULT
- DEFAULT specifies that any SYSOUT data sets that do not explicitly
refer to an output descriptor (as allocated by the ALLOCATE command)
should use default output characteristics when printing the data set.
Minimum abbreviation: 3
NODEFAULT specifies that to use a specified set of output characteristics, an explicit reference to the output descriptor needs to be made on the ALLOCATE command when allocating a SYSOUT data set.
Minimum abbreviation: 5
- DEPT('dept')
- DEPT(dept)
- specifies a department identifier that is to be associated with
system output. The identifier is used to aid in the distribution
of output. One to 60 EBCDIC text characters may be specified. See Rules for parsing data with and without quotation marks for the values that may be used with and
without quotation marks.
Minimum abbreviation: 4
- DEST(destination)
- DEST(destination.userid)
- specifies a remote workstation or a user at a specific remote
workstation to which the output is routed for processing. You can
specify from 1 to 8 characters for either destination or userid.
Minimum abbreviation: 3
- DPAGELBL
- NODPAGELBL
- DPAGELBL specifies that the system is to print a security-related
character string on each page of output. The character string is
associated with a security label (usually the security label of the
user's current session). Your installation determines the character
string used.
Minimum abbreviation: 6
NODPAGELBL specifies that the system-generated security character string is to be suppressed on the pages of output. You must have the appropriate RACF® access authority to override page labeling. If you need to override DPAGELBL but are unable to, check your installation security procedures or see your RACF security administrator.
Minimum abbreviation: 8
- FCB(fcb-name)
- specifies the name of the forms control buffer (FCB) or image
to be used for the 3211, 3203-5, or 3800 printers. The name of the
FCB is a 1- to 4-alphabetic or numeric string consisting of the last
1 to 4 characters of the following:
- FCB2xxxx member for the 3211 or 3203-5 printer or printers supported by System Network Architecture (SNA)
- FCB3xxxx member for the 3800 printer.
Minimum abbreviation: 3
- FLASH(overlay,count)
- specifies the name of the forms overlay to be used on the 3800.
The overlay is “flashed” on a form or other printed information over
each page of output. The overlay name must be 1 to 4 characters (alphabetic,
numeric, or @, #, or $).
FLASH also allows you to specify the number of copies (count) on which the overlay is to be printed. The count can range from 0 to 255. To flash no copies, specify a count of zero.
Minimum abbreviation: 3
- FORMDEF(member-name)
- specifies the member name of a partitioned data set containing
information that the Advanced Function Printer (AFP 3800-3 or 3800-8)
uses to print a data set. The member can contain the following information:
- The overlays that are to be invoked during output processing
- The location on the page where the overlays are to be placed
- The suppressions that can be activated for specified page formats.
The member name contains a maximum of 6 characters, of which the first two are predefined by your installation. For the last four characters, specify alphabetic or numeric characters, or the characters @, #, or $.
Minimum abbreviation: 5
- FORMS(forms-name)
- specifies the name of the form on which the output is to be printed.
Specify 1 to 8 characters (alphabetic, numeric or @, #, or $) for
the forms name.
If you do not specify FORMS, JES uses the installation default specified at initialization.
Minimum abbreviation: 5
- GROUPID(output-group-name)
- specifies the name to be used by JES2 to identify which of a job's
SYSOUT data sets are to form an output group. The output group name
consists of 1 to 8 alphabetic or numeric characters and is selected
by the system programmer to define an output group for the job.
Minimum abbreviation: 3
- INDEX(nn)
- specifies a value indicating the data set indexing print offset
(to the right) for the 3211 printer with the indexing feature. The
width of the print line is reduced by the value of INDEX. Specify
a value from 1 through 31. The value 1 indicates flush left. The values
2 through 31 indent the print line by nn-1 positions.
The default is 1, which indicates flush left.
Minimum abbreviation: 3
- LINDEX(nn)
- specifies a value indicating the data set indexing print offset
(to the left) for the 3211 printer with the indexing feature. The
width of the print line is reduced by the value of LINDEX. Specify
a value from 1 through 31. The value 1 indicates flush right. The
values 2 through 31 move the right margin over by nn-1 positions.
The default is 1, which indicates flush right. LINDEX is ignored on printers other than the 3211 printer.
Minimum abbreviation: 4
- LINECT(nnn)
- specifies the number of lines that are to be printed before overflow
processing. Specify a value from 0 through 255. If you specify zero,
no overflow processing is done. If you do not specify LINECT, JES2 obtains the value from one of the following:
- The linect field of the accounting information parameter on the JCL JOB statement.
- The installation default specified at JES2 initialization.
Minimum abbreviation: 4
- MODIFY(module-name,trc)
- specifies the name of a copy modification module, which is loaded
into the 3800 printing subsystem. This module contains predefined
data such as legends, column headings, or blanks. The module specifies
where and on which copies the data is to be printed. The module is
in the SYS1.IMAGELIB system data set. Specify 1 to 4 characters (alphabetic,
numeric, or @, #, or $) for the module name.
The table reference character (TRC), which is optional, corresponds to the character set or sets specified on the CHARS operand. Values are 1 to 4 characters (alphabetic, numeric, or @, #, or $).
Minimum abbreviation: 3
- NAME('name')
- NAME(name)
- specifies a name that is to be associated with system output.
The name is used by your installation to help in the distribution
of output. One to 60 EBCDIC text characters may be specified. See Rules for parsing data with and without quotation marks for the values that may be used with and
without quotation marks.
Minimum abbreviation: 4
- NOTIFY(node.userid)
- NOTIFY (node1.userid1, node2.userid2,...,node4.userid4)
- specifies the node and userid for the recipients of the print
complete messages that are issued when a data set completes printing.
The message indicates whether the job completed successfully and identifies
the output that has completed printing. Node may be omitted from any
destination. If node is not specified, it is assumed to be the node
where the job was submitted. You may specify up to four recipients
of print complete messages.
If you do not specify NOTIFY, no print complete message is issued.
Minimum abbreviation: 3
- OUTDISP(normal-output-disp,abnormal-output-disp)
- specifies the disposition of a SYSOUT data set. Possible dispositions
include the various combinations of holding the data set before or
after writing it to a printer or an external writer. Normal-output-disp
is the disposition for the data set if the job completes normally.
Abnormal-output-disp is the disposition for the data set if the job
completes abnormally. Both normal-output-disp and abnormal-output-disp
are optional, but one should be specified.
Minimum abbreviation: 5
The following table lists the valid values for normal-output-disp and abnormal-output-disp.Table 1. Values for Normal- and Abnormal-Output-Disp Value Description WRITE System output is to be processed and deleted. HOLD System output is to be held until released by the user or operator. When the system output is released, its disposition is changed to WRITE. KEEP System output is to be processed, and upon completion of processing, its disposition is to be changed to LEAVE LEAVE System output is to be held until it is released by the user or operator. When the system output is released, its disposition is changed to KEEP. PURGE System output is deleted without processing. - PAGEDEF(member-name)
- specifies the member of a partitioned data set containing information
that the Advanced Function Printer uses to print the data set. The
member can contain the following information:
- Logical page size and width
- Fonts
- Page segments
- Multiple page types or formats
- Lines within a page; for example, line origin, carriage controls, and spacing
- Multiple logical pages on a physical page.
The member name contains a maximum of 6 characters, of which the first two are predefined by your installation. For the last four characters, specify alphabetic or numeric characters, or the characters @, #, or $.
Minimum abbreviation: 3
- PIMSG(YES,nnn)
- PIMSG(NO,nnn)
- specifies whether messages are to be printed. Values are 0 through
999. The value specifies that the system is to cancel the printing
of the current data set after the specified number of errors have
been either:
- Detected by the functional subsystem (FSS)
- Reported to FSS by the printer.
PIMSG(YES) specifies that messages generated by FSS are to be printed. PIMSG(YES,16) is the default.
PIMSG(NO) specifies that messages are to be suppressed.
If you specify nnn as zero, the system does not cancel the printing of the current data set.
Minimum abbreviation: 3
- PRMODE(process-mode)
- specifies the process mode to be used to schedule output data
sets either to output devices running under a functional subsystem
(FSS) or to an output device managed by JES. For a list of valid process
modes, contact your system programmer. If you do not specify PRMODE,
JES might determine the process mode based upon the content of the
data. Specify 1 to 8 alphabetic or numeric characters for the process
mode.
Use PRMODE to indicate the type of processing you want for a data set. You can use it to direct JES scheduling of this data set to a particular output FSS or JES writer. You can also use PRMODE to request specific processing of a Network Job Entry (NJE) transmitted data set at the destination node without knowing the device name or a SYSOUT class.
Minimum abbreviation: 3
- PRTY(nnn)
- specifies the initial selection priority for the data set. Specify
a value from 0 through 255, where 0 is the lowest output processing
priority and 255 is the highest output processing priority.
Minimum abbreviation: 4
- ROOM('room')
- ROOM(room)
- specifies a room identifier that is to be associated with system
output. The room is used by your installation to help in the distribution
of output. One to 60 EBCDIC text characters may be specified. See Rules for parsing data with and without quotation marks for the values that may be used with and
without quotation marks.
Minimum abbreviation: 4
- SYSAREA
- NOSYSAREA
- SYSAREA specifies that the system printable area is to be reserved
for printing a character string associated with a security label.
SYSAREA is the default.
Minimum abbreviation: 7
NOSYSAREA specifies that you want to print on the entire page of output (including the system printable area) for the current printing. In this case, the system area is not reserved for printing a security character string. You must have the appropriate RACF access authority to override page labeling. If you need to override the system area but are unable to, check your installation security procedures or see your RACF security administrator.
Minimum abbreviation: 9
- THRESHLD(nnnnnnnn)
- specifies a maximum size print work unit or lines for SYSOUT data
sets on a job level, step level, or SYSOUT data set level. Specify
a value between 1 to 99999999. When this size is exceeded, a new unit
of work is created for print scheduling.
Units of work are established on data set boundaries. These boundaries allow multiple printers to print different data sets of a job at the same time. If the number specified on THRESHLD is exceeded, any excess data sets are queued as a separate unit of work. THRESHLD assumes that the data set size is the number of records in the data set multiplied by the number of copies.
If you do not specify THRESHLD, JES3 uses the installation default specified at initialization.
Minimum abbreviation: 3
- TITLE('title')
- TITLE(title)
- specifies a report title or description that is to be included
on the separator pages of system output. The title is used by your
installation to help in the distribution of output. One to 60 EBCDIC
text characters may be specified. See Rules for parsing data with and without quotation marks for
the values that may be used with and without quotation marks.
Minimum abbreviation: 5
- TRC
- NOTRC
- TRC specifies whether the data records contain table reference
character (TRC) codes. The codes identify the font to be used to print
each record.
A TRC code immediately follows the carriage control character, if any. Its value corresponds to either one of the four fonts specified by CHARS or one of the fonts in the PAGEDEF font list. PAGEDEF allows more than four fonts to be specified.
Minimum abbreviation: 3
NOTRC specifies that the data set does not contain TRC codes. NOTRC is the default.
Minimum abbreviation: 5
- UCS(ucs-name)
- specifies the name for the universal character set. Specify up
to 4 alphabetic or numeric characters, or the characters @, #, or
$. If you process the print data set through PSF and do not specify
CHARS, the system uses the UCS as the font name.
Minimum abbreviation: 3
- USERDATA('userdata1','userdata2',...,'userdata16')
- USERDATA(userdata1)
- specifies the installation-defined values for the installation's
prescribed processing. Refer to your installation's definition on
the intent and use of this keyword operand.
USERDATA(value,...)
You can code up to 16 installation-defined values. Each value may be from 1 to 60 EBCDIC text characters. Null positions in the USERDATA parameter are not allowed. For example, you cannot code USERDATA(,value) or USERDATA(value,,value). Each value may be enclosed in apostrophes; however, apostrophes around each value are not required.- Valid characters in enclosing apostrophes:
- A USERDATA parameter value enclosed in apostrophes can contain any EBCDIC text character.
- Enclose a value that contains a blank in apostrophes.
- To code an apostrophe as part of the parameter value, code 2 apostrophes,
and enclose the entire value in single apostrophes. For example:
OUTDES name NEW USERDATA ('USERKEY1=User''s value')
- Valid characters without enclosing apostrophes:
- It can contain any character other than a blank, comma, tab, or semicolon.
- Valid characters in enclosing apostrophes:
- USERLIB(dsname)
- USERLIB(dsname1, dsname2,...,dsname8)
- specifies the data set name of a library containing AFP resources.
The data set must be a fully-qualified cataloged data set. The resources
in the library specify how the SYSOUT data set is to be printed and
include the following:
- Fonts
- Page segments
- Overlays
- Pagedefs
- Formdefs
You may specify up to eight libraries.
A valid data set name is 1 to 44 characters (alphabetic, numeric, or @, #, $). You may specify up to 22 levels separated by periods. The first character of each level must be alphabetic or @, #, or $.
Each data set containing a library is concatenated to the system resource libraries. These data sets specified with USERLIB are checked first for requested resources.
If you do not specify USERLIB, the system and installation print resources are used.
Minimum abbreviation: 3
- WRITER(external-writer-name)
- specifies the member name of an installation-written program in
the system library that is to write the SYSOUT data set, instead of
JES2 or JES3. If you specify the external writer name, the output
data set is written under the control of that external writer rather
than the control of JES2 or JES3. The writer name can contain 1 to
8 characters (alphabetic, numeric or @, #, or $).
Minimum abbreviation: 3