Text units
You can specify the same SYSOUT processing options that are available through an OUTPUT JCL keyword by using one or more dynamic output text units. Each text unit provides the same SYSOUT processing options as one or more subparameters of a particular OUTPUT JCL keyword.
To see how a particular OUTPUT JCL keyword corresponds to a dynamic
output text unit, refer to the following columns in Table 1.
- Table Column 1 — JCL Keyword Parameter
- Use this column to locate the keyword that you would like to specify as a dynamic output text unit. For most keywords, you can use a single text unit to specify all the SYSOUT processing options available through the keyword. For these keywords, the keyword and its corresponding text unit are shown in a single row in the table. Some keywords, however, have more than one corresponding text unit. For these keywords, the atomic subparameters corresponding to a single text unit are shown in a single row of the table. For example, the COPIES data set count subparameter is specified by text unit key X'0009' and is shown in a single table row. The COPIES group values subparameter is specified by text unit key X'000A' and is shown in another separate table row.
- Table Column 2 — Symbolic Key from IEFDOKEY Macro
- Use this column to find the symbolic key that identifies the text unit.
- Table Column 3 — Key in Hex
- Use this column to find the text unit's hexadecimal key. This key serves as the text unit's unique identifier, and is equivalent to the value of the symbolic key in column 2.
Columns 4, 5 and 6 define the length/value pairs for each text
unit. Within a text unit, each length/value pair corresponds to an
atomic subparameter of the text unit's corresponding OUTPUT JCL keyword.
The length/value pair specifies the same SYSOUT processing option
as its corresponding atomic subparameter. Figure 1 shows
an example of a keyword with two corresponding text units. In this
example the COPIES keyword corresponds to the data set count and group
values text units. The data set count text unit has one length/value
pair, while the group values text unit has two length value pairs.
Note that there is one length/value pair for each atomic subparameter.
Figure 1. COPIES Keyword and its Dynamic Output
Text Units
- Table column 4 — Maximum number of value fields
- Use this column to determine the maximum number of length/value pairs that you can code for a text unit. When a text unit can have more than one length/value pair, the length/value pairs must be in the same order as their corresponding atomic subparameters. For example, in Figure 1, the first through fourth subparameters of the CHARS keyword correspond, respectively, to the first through fourth length/value pairs of the text unit with key X'0002'.
- Table column 5 — Length of Value Field
- Use this column to determine the length of the value field in
a text unit's length/value pair. If the value field contains character
data, you can use any length within the minimum and maximum lengths
defined. If, however, the value field does not contain character data,
the length field must be equal to the length of the value field.
Alternatively, you can have a zero length pair to act as a place holder. A zero length is allowed whenever the length value pair's corresponding atomic subparameter may be specified as null. Using a length of zero indicates a null value for the length/value pair and is equivalent to having a null atomic subparameter in JCL. For example, in ADDRESS=(ZOBRE,,POK) the second subparameter is null.
- Table column 6 — Value field
- Use this column to determine what types of values (for example, EBCDIC text or binary numbers) are allowed for the value field of a length/value pair. The value field of a length/value pair has the same syntax as its corresponding atomic subparameter. However, the value field does not use JCL delimiters, such as commas and delimiting apostrophes, which are not part of the actual atomic subparameter. Also, for most atomic subparameters whose values are a choice of character string constants (for example, YES or NO), the corresponding text unit value field uses a 1-byte hexadecimal number instead of a character string constant. For example, in Figure 1, BURST=YES is specified by a text unit with key X'0001' and a value field X'02'. This column defines value fields that use hexadecimal numbers in place of character string constants and describes any other deviations that might exist between a value field's syntax and the syntax of its corresponding atomic subparameter.
| JCL Keyword Parameter | Symbolic key from IEFDOKEY Macro | Key in Hex | Maximum number of value fields | Length of value field | Value field | Function |
|---|---|---|---|---|---|---|
| ADDRESS | DOADDRES | 0027 | 4 | 0-60 | EBCDIC text characters | Specifies the delivery address for the SYSOUT data set. |
| AFPPARMS | DOAFPPRM | 0051 | 1 | 1-54 | Cataloged data set name | Identifies a data set containing control parameters for the AFP Print Distributor feature of PSF. |
| AFPSTATS | DOAFPST | 0048 | 1 | 1 | X‘40’ for YES |
Specifies to Print Services Facility (PSF) that an AFP Statistics report is to be generated while printing this SYSOUT data set. |
| BUILDING | DOBUILD | 0028 | 1 | 1-60 | EBCDIC text characters | Specifies the building location associated with the SYSOUT data set. |
| BURST | DOBURST | 0001 | 1 | 1 | X‘02’ for YES |
Directs output to a stacker on a 3800 Printing Subsystem. |
| CHARS | DOCHARS | 0002 | 4 | 1-4 (see note 1) | Alphanumeric or national (@, $, #) characters | Names character-arrangement tables for printing on a 3800 Printing Subsystem. |
| CKPTLINE | DOCKPTLI | 0003 | 1 | 2 | binary number from 0 to 32767 decimal | Specifies the maximum lines in a logical page. |
| CKPTPAGE | DOCKPTPA | 0004 | 1 | 2 | binary number from 1 to 32767 decimal | Specifies the number of logical pages to be printed or transmitted before JES takes a checkpoint. |
| CKPTSEC | DOCKPTSE | 0005 | 1 | 2 | binary number from 1 to 32767 decimal | Specifies how many seconds of printing are to elapse between each checkpoint of this SYSOUT data set. |
| CLASS | DOCLASS | 0006 | 1 | 1 | alphanumeric character or * | Assigns the system data set to an output class. |
| COLORMAP | DOCOLORM | 003A | 1 | 1-8 | alphanumeric or national (@,$,#) characters | Specifies the AFP resource (object) for the data set that contains color translation information. |
| COMPACT | DOCOMPAC | 0007 | 1 | 1-8 | alphanumeric characters | Specifies a compaction table for sending this SYSOUT data set to a SNA remote terminal. |
| COMSETUP | DOCOMSET | 0032 | 1 | 1-8 | alphanumeric characters, $, #, @ | Specifies the name of a microfile setup resource. |
| CONTROL | DOCONTRO | 0008 | 1 | 1 | X‘80’ for SINGLE |
Specifies that all the data records begin with carriage control characters or specifies line spacing. |
| COPIES (dataset count) | DOCOPIE9 | 0009 | 1 | 1 |
|
Specifies number of copies printed. |
| COPIES (group values) | DOCOPIEA | 000A | 8 | 1 |
|
Specifies number of copies printed before next page. |
| COPYCNT | DOCOPYCN | 0052 | 1 | 4 | 0 to 2147483647 | Specifies number of copies printed. |
| DATACK | DODATACK | 2022 | 1 | 1 | X‘00’ for BLOCK |
Specifies how errors in printers accessed through the functional subsystem Print Services Facility™ (PSF) are to be reported. |
| DEFAULT | DODEFAUL | 000B | 1 | 1 | X‘40’ for YES |
Specifies that this is a default output descriptor. |
| DEPT | DODEPT | 0029 | 1 | 1-60 | EBCDIC text characters | Specifies the department identification associated with the SYSOUT data set. |
| DEST | DODEST | 000C | 1 | 1-127 | See z/OS MVS JCL Reference. | Sends a SYSOUT data set to the specified destination. |
| DPAGELBL | DODPAGEL | 0023 | 1 | 1 | X‘40’ for YES |
Indicates whether the system should place a security label on each output page. YES means the system should place a label on each page. NO means the system should not place a label on each page. |
| DUPLEX | DODUPLEX | 003D | 1 | 1 | X‘80’ for NO |
Specifies whether the job is to be printed on one or both sides of the paper. Overrides comparable FORMDEF specification. |
| FCB | DOFCB | 000D | 1 | 1-4 | alphanumeric or national (@, $, #) characters | Specifies FCB image, carriage control tape for 1403 Printer, or data-protection image for 3525 Card Punch. |
| FLASH (overlay name) | DOFLASE | 000E | 1 | 1-4 | alphanumeric or national (@, $, #) characters | For printing on a 3800 Printing Subsystem, indicates that the data set is to be printed with forms overlay. |
| FLASH (count) | DOFLASF | 000F | 1 | 1 | binary number from 0 to 255 decimal | For printing on a 3800 Printing Subsystem, specifies how many copies are to be printed with forms overlay. |
| FORMDEF | DOFORMD | 001D | 1 | 1-6 | alphanumeric or national (@, $, #) characters | Names a library member that PSF uses in printing the SYSOUT data set on a 3800 Printing Subsystem Model 3. |
| FORMLEN | DOFORMLN | 003B | 1 | 1-10 | See z/OS MVS JCL Reference. | Specifies the form length to be used for a print data set when it is not specified in the DORMDEF parameter. |
| FORMS | DOFORMS | 0010 | 1 | 1-8 | alphanumeric or national (@, $, #) characters | Identifies forms on which the SYSOUT data set is to be printed or punched. |
| FSSDATA | DOFSSDAT | 0047 | 1 | 1-127 | EBCDIC text characters | Data that JES ignores but passes to a functional subsystem application. |
| GROUPID | DOGROUPI | 0011 | 1 | 1-8 | alphanumeric characters | Specifies that this SYSOUT data set belongs to a user-named output group. (JES2 only) |
| INDEX | DOINDEX | 0012 | 1 | 1 | binary number from 1 to 31 decimal. | Specifies how many print positions the left margin is to be indented for a SYSOUT data set printed on a 3211 Printer with the indexing feature. (JES2 only) |
| INTRAY | DOINTRAY | 003E | 1 | 1-3 | binary number from 1 to 255 decimal | Specifies the printer input tray from which to take paper for the print job. Overrides comparable FORMDEF specification. |
| LINDEX | DOLINDEX | 0014 | 1 | 1 | binary number from 1 to 31 decimal. | Specifies how many print positions the right margin is to be moved in from the full page width for a SYSOUT data set printed on a 3211 Printer with the indexing feature. (JES2 only) |
| LINECT | DOLINECT | 0015 | 1 | 1 | binary number from 0 to 255 decimal | Specifies the maximum lines JES2 is to print on each page. (JES2 only) |
| MAILBCC | DOMAILBC | 0049 | 32 | 1-60 | EBCDIC text characters | Specifies one or more e-mail addresses of the recipients on the blind copy list. |
| MAILCC | DOMAILCC | 004A | 32 | 1-60 | EBCDIC text characters | Specifies one or more e-mail addresses of the recipients on the copy list. |
| MAILFILE | DOMAILFI | 004B | 1 | 1-60 | EBCDIC text characters | Specifies the file name of the attachment to an e-mail. |
| MAILFROM | DOMAILFR | 004C | 1 | 1-60 | EBCDIC text characters | Specifies the descriptive name or other identifier of the sender of an e-mail. |
| MAILTO | DOMAILTO | 004D | 32 | 1-60 | EBCDIC text characters | Specifies one or more e-mail addresses of the e-mail recipients. |
| MODIFY (module name) | DOMODIF6 | 0016 | 1 | 1-4 | alphanumeric or national (@, $, #) characters | Specifies a copy-modification module in SYS1.IMAGELIB to be used by JES to print the data set on a 3800 Printing Subsystem. |
| MODIFY (trc) | DOMODIF7 | 0017 | 1 | 1 | binary number from 0 to 3 | Specifies which character arrangement table is to be used. Related to the CHARS key. |
| NAME | DONAME | 002D | 1 | 1-60 | EBCDIC text characters | Specifies the preferred name of the owner of the SYSOUT data set. |
| NOTIFY | DONOTIFY | 002F | 4 | 1-17 | node (optional) and userid | Sends a print complete message to the specified destination. |
| OFFSETXB | DOXOFSTB | 0043 | 1-10 | 1-13 | See z/OS MVS JCL Reference. | Specifies the X offset of the logical page origin from the physical page origin for the back side of each page. Overrides comparable FORMDEF specification. |
| OFFSETXF | DOXOFSTF | 0041 | 1-10 | 1-13 | See z/OS MVS JCL Reference. | Specifies the X offset of the logical page origin from the physical page origin for the front side of each page. Overrides comparable FORMDEF specification. |
| OFFSETYB | DOYOFSTB | 0044 | 1-10 | 1-13 | See z/OS MVS JCL Reference. | Specifies the Y offset of the logical page origin from the physical page origin for the back side of each page. Overrides comparable FORMDEF specification. |
| OFFSETYF | DOYOFSTF | 0042 | 1-10 | 1-13 | See z/OS MVS JCL Reference. | Specifies the Y offset of the logical page origin file the front side of each page. Overrides comparable FORMDEF specification. |
| OUTBIN | DOOUTBIN | 2023 | 1 | 4 | binary number from 1 to 65535 decimal | Specifies the printer output bin ID. |
| OUTDISP (normal job completion) | DOOUTDB | 002B | 1 | 1 | X'80' for WRITE |
Specifies the SYSOUT data set disposition for normal job completion. |
| OUTDISP (abnormal job completion) | DOOUTDC | 002C | 1 | 1 | X'80' for WRITE |
Specifies the SYSOUT data set disposition for abnormal job completion. |
| OVERLAYB | DOOVRLYB | 0040 | 1 | 1-8 | alphanumeric or national ($, #, @) characters | Specifies that the named medium overlay is to
be placed on the back side of each sheet to be printed. The overlay is printed in addition to overlays specified in the FORMDEF. |
| OVERLAYF | DOOVRLYF | 003F | 1 | 1-8 | alphanumeric or national ($, #, @) characters | Specifies that the named medium overlay is to
be placed on the front side of each sheet to be printed. The overlay is printed in addition to overlays specified in the FORMDEF. |
| OVFL | DOOVFL | 0033 | 1 | 1 | X'80' for ON |
Specifies whether or not JES3 should test for page overflow on an output printer. (JES3 only) |
| PAGEDEF | DOPAGEDE | 001F | 1 | 1-6 | alphanumeric or national (@, $, #) characters | Names a library member that PSF uses in printing the SYSOUT data set on a 3800 Printing Subsystem Model 3. |
| PIMSG | DOPIMSG | 0021 | 2 | 1 | X‘80’ for NO The second value field is a two-byte number from 0 through 999 decimal, having a length field of 2. |
Indicates that messages from a functional subsystem should or should not be printed in the listing following the SYSOUT data set. Printing terminates if the number of printing errors exceeds the second value field. |
| PORTNO | DOPORTNO | 0045 | 1 | 2 | binary number from 1 to 65535 decimal | Specifies the TCP port number at which the FSS (for example, Infoprint Server) connects to the printer rather than connecting to LPD on the printer. Specify either PORTNO or PRTQUEUE, but not both. PRTQUEUE indicates the queue used when connecting to LPD on the printer. |
| PRMODE | DOPRMODE | 0018 | 1 | 1-8 | alphanumeric characters | Identifies the process mode required to print the SYSOUT data set. |
| PRTATTRS | DOPRTATT | 0050 | 1 | 1-127 | EBCDIC text characters | Specifies an Infoprint Server job attribute. The z/OS Infoprint Server User's Guide documents job attribute names and syntax for acceptable values. |
| PRTOPTNS | DOPROPTN | 0039 | 1 | 1-16 | see z/OS MVS JCL Reference. | Named entity that can specify additional print options for FSS use. |
| PRTERROR | DOPRTERR | 003C | 1 | 1 | X'80' for QUIT |
Specifies the action to be taken on a SYSOUT data set while being printed by PSF/MVS for a terminating error. |
| PRTQUEUE | DOPRTQUE | 0038 | 1 | 1-127 | see z/OS MVS JCL Reference. | Identifies the target print queue for use by the FSS. |
| PRTY | DOPRTY | 0019 | 1 | 1 | binary number from 0 to 255 decimal | Specifies initial priority at which the SYSOUT data set enters the output queue. |
| REPLYTO | DOREPLYT | 004E | 1 | 1-60 | EBCDIC text characters | Specifies the e-mail address to which recipients of the e-mail can respond. |
| RESFMT | DORESFMT | 0046 | 1 | 1 | X'80' for P249 |
Specifies the resolution used to format the print data set. |
| RETAINF | DORETANF | 0037 | 1 | 1-10 | see z/OS MVS JCL Reference. | Specifies the failed transmission retain time for use by the FSS. |
| RETAINS | DORETANS | 0036 | 1 | 1-10 | see z/OS MVS JCL Reference. | Specifies the successful transmission retain time for use by the FSS. |
| RETRYL | DORETRYL | 0035 | 1 | 1-3 | see z/OS MVS JCL Reference. | Specifies the maximum number of transmission retries used by the FSS. |
| RETRYT | DORETRYT | 0034 | 1 | 1-8 | see z/OS MVS JCL Reference. | Specifies the length of time that the FSS will wait between retries. |
| ROOM | DOROOM | 0026 | 1 | 1-60 | EBCDIC text characters | Specifies the room identification to be associated with the SYSOUT data set. |
| SYSAREA | DOSYSARE | 0024 | 1 | 1 | X‘40’ for YES |
Indicates whether you want to use the system printable area of each output page. YES means you want to use the area. NO means you do not want to use the area. |
| THRESHLD | DOTHRESH | 0022 | 1 | 4 | binary number from 1 to 99999999 decimal | Specifies the maximum size for a sysout data set. Use it to obtain simultaneous printing of large data sets or many data sets from one job. (JES3 only) |
| TITLE | DOTITLE | 002A | 1 | 1-60 | EBCDIC text characters | Specifies a title for the SYSOUT data set to be placed on the separator pages. |
| TRC | DOTRC | 001A | 1 | 1 | X‘80’ for NO |
Specifies whether or not the SYSOUT data set's records contain table reference codes (TRC) as the second character. |
| UCS | DOUCS | 001B | 1 | 1-4 | alphanumeric or national (@, $, #) characters | Specifies universal character set, print train, or character arrangement table for a 3800 Printing Subsystem. |
| USERDATA | DOUSERDA | 0031 | 16 | 1-60 | EBCDIC text |
User-oriented information as defined by the installation. |
| USERLIB | DOUSERLI | 002E | 8 | 44 | cataloged data set name | Specifies the names of libraries containing AFP resources. |
| USERPATH | DOUSERPAT | 004F | 8 | 1–255 | SPECIAL text. See z/OS MVS JCL Reference. | Specifies up to eight z/OS® UNIX file paths containing resources to be used by PSF when processing SYSOUT data sets. |
| WRITER | DOWRITER | 001C | 1 | 1-8 | alphanumeric or national (@, $, #) characters | Names an external writer to process the SYSOUT data set rather than JES. |
Note:
- A "length of value field" greater than 4 characters is acceptable
without error provided you supply no more than 4 significant characters
in that field. In the following example, a length of X'13' is
allowed when the 4–character string "CHAR" is coded; the 5–character
string "CHARS" will be flagged as an error.
0002 0001 0013 CL19'CHAR' is acceptable 0002 0001 0013 CL19'CHARS' is not acceptable