JCL parameters for printing with IP PrintWay

This section describes JCL parameters that IP PrintWay™ uses when it sends a data set to a printer or to an email destination. You can specify some of these JCL parameters on either the DD or OUTPUT JCL statement. If you specify the same parameter on both JCL statements, the parameter on the DD statement is used.

CLASS=class

Specifies the 1-character alphanumeric output class of the data set. If the Print Interface subsystem does not process the data set, IP PrintWay can use this parameter, in combination with the destination name and form name, to select a printer definition in the Printer Inventory to format and print the data set. Ask your administrator which class to specify.

Default:

• If the Print Interface subsystem processes the data set, the class in the printer definition is used. If none is specified, JES determines the default class.
• If the Print Interface subsystem does not process the data set, JES determines the default class.

Tips:

1. You can also specify the class in the SYSOUT parameter of a DD JCL statement.
2. If you specify more than one parameter that can be used to find a printer or email destination, IP PrintWay uses these priorities:
   1. The printer's host name or address specified by the DEST=IP: parameter, or the email address specified in the MAILTO parameter
   2. The printer's address or the email address in the printer definition specified in the SUBSYS parameter
   3. The printer's address or the email address in the printer definition specified in the FSSDATA parameter
   4. The printer's address or the email address specified in the printer definition that matches the values of any combination of the DEST=destination_name, CLASS, and FORMS parameters

Examples:

In this example, IP PrintWay uses the printer definition associated with CLASS P and DEST MYPRINT to process the data set:

//OUTDS  OUTPUT CLASS=P,DEST=MYPRINT
//DD1    DD SYSOUT=(,),OUTPUT=(*.OUTDS)

In this example, the Print Interface subsystem and IP PrintWay use the printer definition named myprinter to process the data set. CLASS=P does not affect which printer definition is used. However, the Print Interface subsystem allocates the data set on the JES spool in JES output class P and with destination name MYPRINT.

//OUTDS  OUTPUT CLASS=P,DEST=MYPRINT
//DD1    DD SUBSYS=(AOP1,'myprinter'),OUTPUT=(*.OUTDS)

COPIES=nnn

Specifies the number of copies you want to print, from 1 to 255.

Tips:

1. Only one copy prints when you print on VTAM-controlled printers (IP PrintWay basic mode only) or on Internet Printing Protocol (IPP) printers that do not support the copies IPP job attribute. This parameter is supported for VTAM-controlled printers when you use IP PrintWay extended mode.

   To print copies in these cases, specify multiple OUTPUT statements and refer to them in the OUTPUT parameter of the DD statement. For example:

   //OUTDS1 OUTPUT FSSDATA='printer=myprinter'
   //OUTDS2 OUTPUT FSSDATA='printer=myprinter'
   //DD1    DD SYSOUT=P,OUTPUT=(*.OUTDS1,*.OUTDS2)

   This work-around creates multiple output data sets on the JES spool. However, this work-around cannot be used if the Print Interface subsystem processes the data set because the subsystem ignores all but the first reference to an OUTPUT statement.

2. Group values that you specify on this parameter are ignored.
3. This parameter is ignored when you send data to an email destination.
4. The administrator can limit the number of copies that you can specify. If you request more than the allowed number of copies, the data set does not print.
5. If you use the Print Interface subsystem to process the data set, you can specify up to 32640 copies in the copies job attribute. Specify the copies job attribute in the SUBSYS parameter on the DD JCL statement.

Default:

• If the Print Interface subsystem processes the data set, the number of copies in the printer definition is used. If none is specified, JES determines the default number of copies.
• If the Print Interface subsystem does not process the data set, JES determines the default number of copies.

Examples:

//DD1    DD     COPIES=14

//OUTDS  OUTPUT COPIES=14

DEST={[node.]destination_name | '[node.]IP:host'}

Specifies either the destination name or the IP address of the printer's host system.

DEST=[node.]destination_name

Specifies the node name and destination name of the printer's host system.

node

Specifies the 1 to 8 character node name of the printer's host system. The node name is optional. If you specify the node name in the DEST parameter on a DD JCL statement, use this format: DEST=(node,name).

Default:

• If the Print Interface subsystem processes the data set, the JES node in the printer definition is used. If none is specified, JES determines the default node.
• If the Print Interface subsystem does not process the data set, JES determines the default node.

destination_name

Specifies the destination name of the printer. The name must consist of 1 to 8 alphanumeric or national ($,#,@) characters. If the Print Interface subsystem does not process the data set, IP PrintWay can use this parameter, in combination with the class and form name, to select a printer definition to format and print the data set. Ask your administrator which destination name to specify.

Note:

If you use the Print Interface subsystem, specify the DEST parameter on the OUTPUT JCL statement. The subsystem ignores the DEST parameter on the DD statement.

Examples: In these examples, IP PrintWay uses the printer definition associated with CLASS P and DEST PRT003 to process the data set:

//DD1   DD     SYSOUT=P,DEST=PRT003
 

or

//OUTDS OUTPUT DEST=BOULDER.PRT003
//DD1   DD     SYSOUT=P,OUTPUT=(*.OUTDS)
 

DEST='[node.]IP:host'

Specifies the node name and the IP address of the printer's host system.

node

Specifies the 1 to 8 character node name of the printer's host system. The node name is optional.

Default:

• If the Print Interface subsystem processes the data set, the JES node in the printer definition is used. If none is specified, JES determines the default node.
• If the Print Interface subsystem does not process the data set, JES determines the default node.

host

Specifies the 1 to 115 character IP address of the printer's host system in either of these formats (always enclose the IP keyword and value in single quotation marks):

Dotted-decimal

A series of integers in the range of 0 to 255, separated by periods (decimal address). For example:

9.99.12.85

Host name

A series of domain names that can contain alphanumeric characters and dashes (–), separated by periods (.). The first character must be alphabetic or numeric. For example:

leo.boulder.xyz.com

Colon-hexadecimal

An IPv6 address in colon-hexadecimal format. These rules apply:

• You can omit leading zeroes in each hexadecimal value.
• You can omit one sequence of repeat zero values
• You can specify the last two hexadecimal values in dotted-decimal notation.

For example:

2001:0db8:85a3:0000:0000:8a2e:0370:7334

If you run IP PrintWay basic mode, do not specify a colon-hexadecimal address because IP PrintWay basic mode does not support IPv6.

Default: The printer's IP address or host name in the printer definition is used.

Examples:

//OUTDS  OUTPUT DEST='IP:99.153.123.232'

//OUTDS  OUTPUT DEST='IP:XYZ.COM' 

//OUTDS  OUTPUT DEST='NODE01.IP:XYZ.COM'

//OUTDS  OUTPUT DEST='IP:2001:0db8:85a3:0000:0000:8a2e:0370:7334'

Tips:

1. If you specify more than one parameter that can be used to find the printer or email destination, IP PrintWay uses these priorities:
   1. The printer's host name or address specified by the DEST=IP: parameter, or the email address specified in the MAILTO parameter
   2. The printer's address or the email address in the printer definition specified in the SUBSYS parameter
   3. The printer's address or the email address in the printer definition specified in the FSSDATA parameter
   4. The printer's address or the email address in the printer definition that matches the values of any combination of the DEST=name, CLASS, and FORMS parameters
2. If you specify a printer definition name in the FSSDATA or SUBSYS parameter and the printer definition does not specify the LPR or direct sockets printing protocol, IP PrintWay ignores the DEST=IP: parameter.
3. Use the same method to identify the host system, either the host name or the IP address, in all references to the host system. Also, use the same lower and uppercase characters. This ensures that data sets transmitted to the same printer are transmitted in the correct order.
4. IP PrintWay basic mode: If the resubmit for filtering function is used, do not specify the DEST=IP: parameter because IP PrintWay ignores it and instead uses the IP address in the printer definition.
5. IP PrintWay extended mode: If your job creates multiple output data sets, see JCL considerations for IP PrintWay extended mode.

DSNAME=&&dataset_name

Specifies the data set name to assign to the sysout data set. The z/OS® system generates a qualified name for the sysout data set and uses the value you specify in the DSNAME parameter as the last qualifier in the name.

Begin the name with two ampersands (&&). Follow the ampersands with 1 to 8 alphanumeric or national ($,#,@) characters, a hyphen, or a character X'C0'. The first character after the ampersands must be alphabetic or national ($,#,@).

Guidelines: Specify a DSNAME parameter so that you can identify printed output more easily:

• The fully qualified data set name can be printed on page headers and on separator pages. Therefore, if you specify the DSNAME parameter, you can identify your output more easily. Whether a header or separator page prints depends on the IP PrintWay options your administrator has selected in the printer definition and how your administrator has configured the printer's separator page.
• IP PrintWay basic mode: If the resubmit for filtering function is used, the value you specify in the DSNAME parameter is also the last qualifier of the data set name of the second data set that Infoprint Server dynamically allocates on the JES spool while processing the data. Therefore, if you specify the DSNAME parameter, you can find this second data set on the JES spool more easily.

Default: The last qualifier of the fully qualified data set name is a question mark (?).

Example:

 //DD1 DD SYSOUT=P,DSNAME=&&FEBSALES 

The z/OS system generates a data set name such as:

userid.jobname.jobid.Ddsnumber.FEBSALES

FEBSALES

is the last qualifier of the fully qualified name of the second data set that Print Interface allocates on the JES spool when the resubmit for filtering function (IP PrintWay basic mode) is used. For email, FEBSALES is the name of the email attachment if the MAILFILE parameter is not specified.

DUPLEX={NO | NORMAL | TUMBLE}

Specifies whether the data set is printed on one or both sides of each sheet.

This parameter only applies to documents printed on an AFP printer or transformed to another format using a transform from AFP.

NO

The data set is printed only on the front side of each sheet.

NORMAL

The data set is printed on both sides of the sheet so that the top of side 1 is the top of side 2 (for side binding).

TUMBLE

The data set is printed on both sides of the sheet so that the top of side 1 is the bottom of side 2 (for top binding).

Default:

• IP PrintWay basic mode: NORMAL
• IP PrintWay extended mode: the duplex value in the printer definition is used

Example:

//OUTDS OUTPUT DUPLEX=NORMAL 

FCB=fcb_name

Specifies the 1 to 4 character name of the forms control buffer (FCB) member of the SYS1.IMAGELIB library.

IP PrintWay searches the library first for FCB4fcb_name, then FCB2fcb_name, then FCB3fcb_name unless you are printing to a VTAM-controlled printer. In this case, IP PrintWay searches the SYS1.IMAGELIB library only for FCB2fcb_name.

IP PrintWay extended mode always uses the FCB to format the data if the FCB parameter is specified. However, IP PrintWay basic mode uses the FCB only if the administrator selects the IP PrintWay Use FCB formatting option in the printer definition.

Default:

• If the Print Interface subsystem processes the data set, the FCB in the printer definition is used. If none is specified:
  • If IP PrintWay extended mode processes the data set, there is no default FCB.
  • If IP PrintWay basic mode processes the data set, JES can provide a default FCB.
• If the Print Interface subsystem does not process the data set:
  • If IP PrintWay extended mode processes the data set, the FCB in the printer definition is used.
  • If IP PrintWay basic mode processes the data set, JES can provide a default FCB. If JES does not provide a default FCB and the resubmit for filtering function is used, the FCB in the printer definition is used.

Examples:

//DD1    DD     FCB=STD2
 

//OUTDS  OUTPUT FCB=STD2

FORMS=form_name

Specifies the 1 to 8 character form name. If the Print Interface subsystem does not process the data set, IP PrintWay can use this parameter, in combination with the class and destination name, to select a printer definition to format and print the data set. Ask your administrator which form name to specify.

Tips:

1. You can also specify the form name in the SYSOUT parameter of a DD JCL statement.
2. If you specify more than one parameter that can be used to find a printer or email destination, IP PrintWay uses these priorities:
   1. The printer's host name or address specified by the DEST=IP: parameter, or the email address specified in the MAILTO parameter
   2. The printer's address or the email address in the printer definition specified in the SUBSYS parameter
   3. The printer's address or the email address in the printer definition specified in the FSSDATA parameter
   4. The printer's address or the email address in the printer definition that matches the values of any combination of the DEST=name, CLASS, and FORMS parameters
3. The administrator can limit the values that you can specify in this parameter. If you specify a value that is not allowed, the data set might not print.

Default:

• If the Print Interface subsystem processes the data set, the form name in the printer definition in the Printer Inventory is used. If none is specified, JES provides a default form name.
• If the Print Interface subsystem does not process the data set, JES provides a default form name.

Example:

//OUTDS  OUTPUT FORMS=WIDE

FSSDATA='printer=printer_definition_name'

Specifies the 1 to 17 character name of the printer definition in the Printer Inventory.

Rules:

• Enter the printer subparameter in lowercase.
• Enter the printer definition name with exactly the same uppercase and lowercase letters used in the printer definition. The printer definition name is case-sensitive.

If you specify more than one parameter that can be used to find a printer or email destination, IP PrintWay uses these priorities:

1. The printer's host name or address specified by the DEST=IP: parameter, or the email address specified in the MAILTO parameter
2. The printer's address or the email address in the printer definition specified in the SUBSYS parameter
3. The printer's address or the email address in the printer definition specified in the FSSDATA parameter
4. The printer's address or email address in the printer definition that matches the values of any combination of the DEST=name, CLASS, and FORMS parameters

IP PrintWay extended mode: If your job creates multiple output data sets, see JCL considerations for IP PrintWay extended mode.

Default:

• If the Print Interface subsystem processes the data set and no printer definition is named in the SUBSYS parameter, the Infoprint Server default printer definition is used.
• If the Print Interface subsystem does not process the data set:
  • If the DEST=IP: parameter is specified, the IP PrintWay default printer definition is used.
  • If the DEST=IP: parameter is not specified, the printer definition that matches the class, destination, and forms name is used.

Example:

//OUTDS  OUTPUT FSSDATA='printer=Printer5'

MAILBCC=('username[@domainname]'[,...])

Specifies the email addresses for the blind copy (bcc) recipients of an email. A bcc means that other recipients of the email do not see the bcc recipient listed.

username

Specifies the name of the recipient, or an alias name that is defined in z/OS UNIX sendmail. For example, user1.

@domainname

Specifies the domain of the recipient. For example, @xyz.com. The default is the host name that sendmail is running on. If you specify an alias name, omit @domainname.

Rules:

• You can specify 1-32 email addresses.
• Each email address can be 1-60 characters.
• You can specify any characters, including blanks.
• If the email address contains special characters or lowercase letters, enclose the entire email address in apostrophes.
• If you specify only one email address, you can omit the parentheses.
• You cannot specify null values. For example, you cannot specify MAILBCC=(,username) or MAILBCC=(username,,username).

IP PrintWay extended mode: If your job creates multiple output data sets, see JCL considerations for IP PrintWay extended mode.

Default: IP PrintWay sends the email to any bcc recipients specified in the printer definition.

Example: In this example, user1@xyz.com receives the email, and user2@xyz.com and all the recipients defined in the sendmail alias named “dept01list” receive a bcc of the email:

//OUTDS  OUTPUT MAILTO='user1@xyz.com',MAILBCC=('user2@xyz.com',dept01list)

MAILCC=('username[@domainname]'[,...])

Specifies the email addresses for the copy (cc) recipients of an email. A cc means that other recipients of the email can see the cc recipient listed.

username

Specifies the name for the recipient, or an alias name that is defined in z/OS UNIX sendmail. For example, user1.

@domainname

Specifies the domain for the recipient. For example, @xyz.com. The default is the host name that sendmail is running on. If you specify an alias name, omit @domainname.

Rules:

• You can specify 1-32 email addresses.
• Each email address can be 1-60 characters.
• You can specify any characters, including blanks.
• If the email address contains special characters or lowercase letters, enclose the entire email address in apostrophes.
• If you specify only one email address, you can omit the parentheses.
• You cannot specify null values. For example, you cannot specify MAILCC=(,username) or MAILCC=(username,,username).

IP PrintWay extended mode: If your job creates multiple output data sets, see JCL considerations for IP PrintWay extended mode.

Default: IP PrintWay sends the email to any cc recipients specified in the printer definition.

Example: In this example, user1@xyz.com receives the email, and user2@xyz.com and all the recipients defined in the sendmail alias named “dept01list” receive a cc of the email:

//OUTDS  OUTPUT MAILTO='user1@xyz.com',MAILCC=('user2@xyz.com',dept01list)

MAILFILE='filename'

Specifies the file name of the attachment to an email.

Rules:

• The name can be 1-60 characters.
• You can specify any characters, including blanks.
• If the name contains special characters, blanks, or lowercase letters, enclose the entire name in apostrophes.

Default: IP PrintWay uses the last qualifier of the data set name or file name as the name of the email attachment. You can specify the last qualifier in the DSNAME parameter of the DD statement. However, the DSNAME parameter lets you specify only 8 characters (see the description of the DSNAME parameter). If you do not specify the DSNAME parameter, IP PrintWay uses the job name.

Tip:

If you specify a file name (in the mail-file-name job attribute) with a suffix that indicates the type of data in the file, ask your administrator to request that Infoprint Server not add another suffix. For example, if the file name is myfile.doc, ask your administrator to request that Infoprint Server not add suffixes for file names that contain the .doc suffix. For information, see the section about customizing IP PrintWay in z/OS Infoprint Server Customization.

Example: In this example, the email attachment is February 2004 sales report.txt and the attachment is in text format unless a transform is specified in the mail printer definition:

//OUTDS  OUTPUT MAILFILE='February 2004 sales report'

MAILFROM='sendername'

Specifies the descriptive name or other identifier of the sender of an email.

Rules:

• The name can be 1-60 characters.
• You can specify any characters, including blanks.
• If the name contains special characters, blanks, or lowercase letters, enclose the entire name in apostrophes.

IP PrintWay always includes userid@domainname to identify the sender. The user ID of the job submitter is userid. The domain name where Infoprint Server is running is domainname. For example: JOHN@SYSTEM1.

IP PrintWay extended mode: If your job creates multiple output data sets, see JCL considerations for IP PrintWay extended mode.

Default: IP PrintWay uses the value specified in the printer definition.

Tip: To specify the email address that recipients of an email can reply to, use the REPLYTO parameter.

Example:

This specification:

//OUTDS  OUTPUT MAILFROM='John Q. Sender'

Puts this information in the email:

From: John Q. Sender <JOHN@SYSTEM1>

MAILTO=('username[@domainname]'[,...])

Specifies the email addresses for the recipients of an email.

username

Specifies the name for the recipient, or an alias name that is defined in z/OS UNIX sendmail. For example, user1.

@domainname

Specifies the domain of the recipient. For example, @xyz.com. The default is the host name that sendmail is running on. If you specify an alias name, omit @domainname.

Rules:

• You can specify 1-32 email addresses.
• Each email address can be 1-60 characters.
• You can specify any characters, including blanks.
• If the email address contains special characters or lowercase letters, enclose the entire email address in apostrophes.
• If you specify only one email address, you can omit the parentheses.
• You cannot specify null values. For example, you cannot specify MAILTO=(,username) or MAILTO=(username,,username).

IP PrintWay extended mode: If your job creates multiple output data sets, see JCL considerations for IP PrintWay extended mode.

Default: IP PrintWay sends the email to the email recipients specified in the printer definition.

Example: In this example, user1@xyz.com, user2@xyz.com, and all the recipients defined in the sendmail alias named “dept01list” receive the email:

//OUTDS  OUTPUT MAILTO=('user1@xyz.com','user2@xyz.com',dept01list)

NOTIFY=([node.]userid,...)

Specifies up to 4 user IDs that IP PrintWay notifies when the data set has been successfully or unsuccessfully transmitted. Separate the user IDs with commas.

node

Specifies a 1 to 8 character node name. The node name is optional.

userid

Specifies a 1 to 8 character user ID.

Default:

• IP PrintWay basic mode: If either the Print Interface subsystem processes the data set or the resubmit for filtering function is used, the notify values in the printer definition apply. Otherwise, no users are notified.
• IP PrintWay extended mode: The notify values in the printer definition are used.

Example:

//OUTDS  OUTPUT NOTIFY=(SEATTLE.JOE,SEATTLE.MARY)

PORTNO=port_number

Specifies the number of the port to use for a direct socket printing connection. The valid range is 100 to 65535.

Tips:

1. Do not code both PORTNO and PRTQUEUE.
2. If you code DEST=IP: but do not specify a printer definition name in either the FSSDATA or SUBSYS parameter, also code either PRTQUEUE or PORTNO.
3. If the printer definition does not specify the direct sockets printing protocol, IP PrintWay ignores this parameter.
4. If you code DEST=IP: and PORTNO but do not specify a printer definition name in either the FSSDATA or SUBSYS parameter, IP PrintWay uses the direct sockets printing protocol to transmit the data to the specified port number.
5. If the resubmit for filtering function is used (IP PrintWay basic mode), do not code PORTNO because IP PrintWay ignores it and instead uses the port number specified in the printer definition.

Default: The printer's port number in the printer definition is used.

Example:

//OUTDS  OUTPUT PORTNO=2501

PRTATTRS='attribute=value ...'

Specifies one or more Infoprint Server job attributes that you want IP PrintWay extended mode to use.

This parameter lets you specify job attributes that do not have corresponding JCL parameters, such as document-codepage or document-format. You can specify any job attribute, but IP PrintWay ignores these: sysout-job-id, sysout-job-name. For a list of valid job attributes, see Using job attributes.

Rules:

• The list of job attributes can be 1-127 characters.
• Attribute names and values are case-sensitive. All attribute names are lowercase.
• Enclose the entire list of job attributes in single quotation marks.
• Separate job attributes with one or more spaces.
• If an attribute value contains blanks, lowercase letters, or special characters, enclose that attribute value in double quotation marks.
• You can store attributes and values in a UNIX file (for example, a zFS file) or in an MVS™ data set. Use the job attribute called attributes to specify the UNIX file name of the DD name for the MVS data set that contains the attributes. (See "Examples".)

Default: The first value found for each job attribute, using this order:

1. The SUBSYS JCL parameter
2. The PRTATTRS JCL parameter
3. The JCL parameter that corresponds to the job attribute (for example, the FORMDEF JCL parameter corresponds to the form-definition job attribute)
4. If the Print Interface subsystem is used, the printer attribute in the printer definition that corresponds to the job attribute (for example, the form-definition printer attribute corresponds to the form-definition job attribute)

Examples:

//OUTDS  OUTPUT PRTATTRS='document-codepage="IBM-1147"'
//OUTDS  OUTPUT PRTATTRS='hold=yes document-codepage="IBM-1147"'
//OUTDS  OUTPUT PRTATTRS='attributes=bigjob.att'
//OUTDS  OUTPUT PRTATTRS='attributes=//DD:MYATTR'

PRTOPTNS='component_name'

Specifies the 1 to 16 character name of one or more components that contain printing options you want IP PrintWay to use. Ask your administrator for the name of components suitable for your data set. The component name is case-sensitive. Enter it exactly as the components are defined in the Printer Inventory. If the name contains special characters (such as a dash) or lowercase letters, enclose the name in single quotation marks.

A component is an entity in the Printer Inventory. IP PrintWay uses printing options specified in these three types of components: Processing, IP PrintWay Options, and Protocol. If more than one type of component exists with the specified name, IP PrintWay uses options specified in all of the components with the specified name. If a component of one of the three types does not exist, IP PrintWay uses default values for the printing options that can be specified in the missing component.

IP PrintWay uses only a subset of all options that can be specified in these components. IP PrintWay ignores other options specified in these components and instead uses the options specified in the printer definition. For more information about which options IP PrintWay uses from components and about how to define components for use with the PRTOPTNS parameter, see z/OS Infoprint Server Operation and Administration.

Note:

If the resubmit for filtering function is used (IP PrintWay basic mode), do not specify the PRTOPTNS parameter. IP PrintWay ignores it and instead uses options specified in the printer definition.

Default: IP PrintWay determines the default printing options:

1. The options specified in the printer definition are used.
2. For options not specified in the printer definition, IP PrintWay uses hard-coded default values.

Example:

//OUTDS  OUTPUT PRTOPTNS='PostScript'

PRTQUEUE='print_queue'

Specifies the 1 to 127 character alphanumeric name of the target print queue.

This parameter might be case-sensitive. For example, on UNIX systems, lp0 and LP0 refer to different print queues. If the name contains special characters (such as a dash) or lowercase letters, enclose the name in single quotation marks.

Tips:

1. Do not code both PORTNO and PRTQUEUE.
2. If you code DEST=IP: but do not specify a printer definition name in either the FSSDATA or SUBSYS parameter, also code either PRTQUEUE or PORTNO.
3. If the printer definition does not specify the LPR printing protocol, IP PrintWay ignores this parameter.
4. If you code DEST=IP: and PRTQUEUE parameter, but do not specify a printer definition name in either the FSSDATA or SUBSYS parameter, IP PrintWay uses the LPR printing protocol to transmit the data to the specified print queue.
5. If the resubmit for filtering function is used (IP PrintWay basic mode), do not code PRTQUEUE because IP PrintWay ignores it and instead uses the print queue name specified in the printer definition.
6. TEXT and RAW are queue names on some IBM® printers, most HP printers, and most Lexmark printers. Specify the RAW queue for data that contains a carriage return at the end of each line, PCL data, and PostScript data.
7. TEXT and PASS are used for some IBM printers. Specify the PASS queue for text data that contains a carriage return at the end of each line, PCL data, and PostScript data.
8. If you specify the PASS or RAW queue and you run IP PrintWay basic mode, your administrator must also specify 0D25 in the Line termination field in the printer definition. This causes IP PrintWay basic mode to add a carriage return at the end of each line when it converts line data to text data. IP PrintWay extended mode adds a carriage return at the end of each line by default.

Default: The print queue name in the printer definition is used.

Example:

//OUTDS  OUTPUT PRTQUEUE='RAW'

REPLYTO='username[@domainname]'

Specifies the email address that recipients of an email can reply to.

username

Specifies the name portion of the address, or an alias name that is defined in z/OS UNIX sendmail. For example, user1.

@domainname

Specifies the domain portion of the address. For example, @xyz.com. The default is the host name that sendmail is running on.

Rules:

• The name can be 1-60 characters.
• You can specify any characters, including blanks.
• If the name contains special characters or lowercase letters, enclose the entire name in apostrophes.

IP PrintWay extended mode: If your job creates multiple output data sets, see JCL considerations for IP PrintWay extended mode.

Default: IP PrintWay uses the value specified in the printer definition. If none is specified in the printer definition, most email programs use the sender's email address. The default is userid@domainname. The user ID of the job submitter is userid. The domain name where Infoprint Server is running is domainname.

Example:

//OUTDS  OUTPUT REPLYTO='user1@xyz.com'

RETAINF={'hhhh:mm:ss' | FOREVER }

Specifies the period of time for which IP PrintWay retains the data set on the JES spool after a transmission fails and all requested retries have been attempted.

Specify the time in the format hhhh:mm:ss:

hhhh

is the number of hours (range 0 to 9999)

mm

is the number of minutes (range 0 to 59)

ss

is the number of seconds (range 0 to 59)

You can omit zeroes and colons to the left of the significant portion of the time value. Enclose the entire value in single quotation marks. To retain data sets forever, specify FOREVER. In this case, IP PrintWay does not automatically delete the failed data set from the JES spool.

IP PrintWay extended mode: If your job creates multiple output data sets, see JCL considerations for IP PrintWay extended mode.

Default: IP PrintWay determines the default value:

1. The retain value in the printer definition is used.
2. No retention.

Table 5 explains the state of retained data sets.

Table 5. State of retained data sets for RETAINF

When IP PrintWay retains a data set in this mode:	In JES2, IP PrintWay treats the data set this way:	In JES3, IP PrintWay treats the data set this way:
Basic mode	Keeps the acquired data set	Keeps the acquired data set
Extended mode	Releases the data set Puts the data set in the HELD state	Releases the data set Puts the data set in the KEEP state

Examples:

• This OUTPUT statement specifies that IP PrintWay should retain the data set on the JES spool for 48 hours:

  //OUTDS  OUTPUT RETAINF='48:00:00'

• This OUTPUT statement specifies that IP PrintWay should retain the data set on the JES spool until the administrator deletes it or retransmits it:

  //OUTDS  OUTPUT RETAINF=FOREVER

RETAINS={'hhhh:mm:ss' | FOREVER}

Specifies the period of time for which IP PrintWay retains the data set on the JES spool after a successful transmission.

Specify the time in the format hhhh:mm:ss:

hhhh

is the number of hours (range 0 to 9999)

mm

is the number of minutes (range 0 to 59)

ss

is the number of seconds (range 0 to 59)

You can omit zeroes and colons to the left of the significant portion of the time value. Enclose the entire value in single quotation marks. To retain data sets forever, specify FOREVER. In this case, IP PrintWay does not automatically delete the data set from the JES spool. The operator can delete a retained data set from the JES spool, print it again on the same printer, or move it to another IP PrintWay printer.

IP PrintWay extended mode: If your job creates multiple output data sets, see JCL considerations for IP PrintWay extended mode.

Default: IP PrintWay determines the default value:

1. The retain value in the printer definition is used.
2. No retention.

Table 6 explains the state of retained data sets.

Table 6. State of retained data sets for RETAINS

When IP PrintWay retains a data set in this mode:	In JES2, IP PrintWay treats the data set this way:	In JES3, IP PrintWay treats the data set this way:
Basic mode	Keeps the acquired data set	Keeps the acquired data set
Extended mode	Releases the data set Puts the data set in the HELD state	Releases the data set Puts the data set in the KEEP state

Examples:

• This OUTPUT statement specifies that IP PrintWay should retain the data set on the JES spool for 4 hours:

  //OUTDS  OUTPUT RETAINS='04:00:00'

• This OUTPUT statement specifies that IP PrintWay should not retain the data set on the JES spool:

  //OUTDS  OUTPUT RETAINS='0'

RETRYL=nnnnn

Specifies the maximum number of times that IP PrintWay is to retry an unsuccessful transmission. Specify a number from 0 to 32767.

IP PrintWay extended mode: If your job creates multiple output data sets, see JCL considerations for IP PrintWay extended mode.

Guidelines:

• When you send the output data set to an email destination, omit both the RETRYL and RETRYT parameters.
• Do not specify this parameter so that the value your administrator specifies in the printer definition is used. The value you specify can affect IP PrintWay performance.

Default: The retry value in the printer definition is used. If none is specified, see Table 7.

Example:

//OUTDS  OUTPUT RETRYL=10

Table 7. How retry limit and retry time work together

Retry limit	Retry time	IP PrintWay action
0 or blank	Any value	IP PrintWay does not retry the transmission.
>0	0 or blank	IP PrintWay retries the transmission automatically one time right after the original transmission fails. Then IP PrintWay retries for the specified number of times at the specified interval. If retry time is blank, IP PrintWay retries approximately every second.

RETRYT='hhhh:mm:ss'

Specifies the time interval between attempts to retransmit an unsuccessful transmission.

Specify the retry time in the format hhhh:mm:ss:

hhhh

is the number of hours (range 0 to 9999)

mm

is the number of minutes (range 0 to 59)

ss

is the number of seconds (range 0 to 59)

You can omit zeroes and colons to the left of the significant portion of the time value. Enclose the retry time in single quotation marks.

IP PrintWay extended mode: If your job creates multiple output data sets, see JCL considerations for IP PrintWay extended mode.

Guidelines:

• When you send the output data set to an email destination, omit both the RETRYL and RETRYT parameters.
• Do not specify this parameter so that the value your administrator specifies in the printer definition is used. The value you specify can affect IP PrintWay performance.

Default: The retry value in the printer definition is used. If none is specified, see Table 7.

Examples: These examples both specify that IP PrintWay should retry one time immediately, then wait 1 minute between subsequent retries:

//OUTDS  OUTPUT RETRYT='0000:01:00'
 

or

//OUTDS  OUTPUT RETRYT=1:00

SYSOUT=(class,,form_name)

Specifies the class and the form name.

class

Specifies a 1 character alphanumeric class.

form_name

Specifies a 1 to 4 character form name.

You can also specify the output class and the form name in the CLASS parameter and FORMS parameter of an OUTPUT statement. To specify a form name longer than 4 characters, you must use the FORMS parameter of an OUTPUT statement.

Note:

You must code either the SYSOUT or SUBSYS parameter, but do not code both parameters.

Example:

//DD1  DD SYSOUT=(P,,WIDE)

TITLE='description of output'

Describes the output. This value can be printed on an IP PrintWay separator page or on a separator page (banner page) written by the printer's LPD. Whether this value prints on a separator page depends on how your administrator has configured the separator page or how the LPD is implemented. If the output data set is sent to an email destination, this value is the subject of the email.

Specify 1 to 60 characters. If the description contains spaces, special characters, or lowercase characters, enclose the value in quotation marks.

IP PrintWay basic mode: If you want to send multiple output data sets in the same job step in the same email, specify the TITLE parameter with exactly the same value for all output data sets.

Default:

• For IP PrintWay extended mode, the title value in the printer definition is used.
• For a separator page that an IP PrintWay exit created:
  • If the resubmit for filtering function (IP PrintWay basic mode) is used, the default value is the fully qualified data set name (to enable the resubmitted and original data sets to be correlated).
  • If the Print Interface subsystem processes the data set, the default value is the title specified in the Allocation section of the printer definition in the Printer Inventory. If no title is specified in the Allocation section, there is no default value.
  • Otherwise, there is no default value.
• For the LPD's separator page:
  • If the resubmit for filtering function (IP PrintWay basic mode) is used, the default value is the fully qualified data set name (to enable the resubmitted and original data sets to be correlated).
  • If the Print Interface subsystem processes the data set, the default value is the title specified in the Allocation section of the printer definition in the Printer Inventory. If no title is specified in the Allocation section, the default value is the title or filename your administrator specified in the Protocol section of the printer definition. If none is specified, the default value is the fully qualified data set name.
  • Otherwise, the default value is the title or filename your administrator specified in the Protocol section of the printer definition. If none is specified, the default value is the fully qualified data set name.
• For the subject of an email:
  • If the resubmit for filtering function (IP PrintWay basic mode) is used, the default value is the fully qualified data set name (to enable the resubmitted and original data sets to be correlated).
  • If the Print Interface subsystem processes the data set, the default value is the title specified in the Allocation section of the printer definition in the Printer Inventory. If no title is specified in the Allocation section, the default value is the job name.
  • Otherwise, the default value is the job name.

Example:

//OUTDS  OUTPUT TITLE='Annual Report'

JCL considerations for IP PrintWay extended mode

You can use the same JCL for IP PrintWay extended mode as you do for IP PrintWay basic mode with these exceptions:

• IP PrintWay basic mode can print data sets in the same JES output group on different printers. However, IP PrintWay extended mode prints all data sets in the same JES output group on the same printer. Also, IP PrintWay extended mode uses the same retry times, and retention values for all data sets in the output group.

  If your job creates more than one output data set and you specify different values in the DEST=IP:, FSSDATA, MAILBCC, MAILCC, MAILFROM, MAILTO, REPLYTO, RETAINF, RETAINS, RETRYL, or RETRYT parameter for each data set, make sure that JES places each output data set in a different output group. To do this, specify one of these JCL parameters with a different value for each data set: ADDRESS, BUILDING, BURST, CLASS, DEPT, DEST, FCB, FLASH, FORMS, GROUPID (JES2), NAME, OUTDISP (JES2), PRMODE, ROOM, TITLE, or WRITER.

  Examples:

  • IP PrintWay extended mode prints both output data sets on the same printer (printer1) because JES places both data sets in the same JES output group:

    //OUTDS1   OUTPUT DEST='IP:printer1',PRTQUEUE='RAW'
    //OUTDS2   OUTPUT DEST='IP:printer2',PRTQUEUE='RAW
    //DD1      DD SYSOUT=P,OUTPUT=(*.OUTDS1)
    //DD2      DD SYSOUT=P,OUTPUT=(*.OUTDS2)

  • JES2: IP PrintWay extended mode prints the output data sets on different printers (printer1 and printer2) because JES2 places each data set in a separate output group:

    //OUTDS1   OUTPUT DEST='IP:printer1',PRTQUEUE='RAW',GROUPID=GROUP1
    //OUTDS2   OUTPUT DEST='IP:printer2',PRTQUEUE='RAW',GROUPID=GROUP2
    //DD1      DD SYSOUT=P,OUTPUT=*.OUTDS1
    //DD2      DD SYSOUT=P,OUTPUT=*.OUTDS2

  • JES2 or JES3: IP PrintWay extended mode prints the output data sets on different printers (printer1 and printer2) because JES places each data set in a separate output group:

    //OUTDS1   OUTPUT DEST='IP:printer1',PRTQUEUE='RAW',TITLE=TITLE1
    //OUTDS2   OUTPUT DEST='IP:printer2',PRTQUEUE='RAW',TITLE=TITLE2
    //DD1      DD SYSOUT=P,OUTPUT=*.OUTDS1
    //DD2      DD SYSOUT=P,OUTPUT=*.OUTDS2

• IP PrintWay basic mode sends each data set that is in the same JES output group to the email addresses specified for the data set. However, IP PrintWay extended mode, by default, sends all data sets that are in the same JES output group to the email addresses specified for the first data set in the output group. The administrator can set the AOP_MAIL_USE_FIRST_ADDRESS=NO environment variable or the mail-use-first-address=no configuration attribute so that IP PrintWay extended mode sends each data set that is in the same output group to the email addresses specified for the data set.
• The PRTATTRS JCL parameter only works with IP PrintWay extended mode. IP PrintWay basic mode ignores it.
• For these JCL parameters, IP PrintWay extended mode uses the values in the printer definition as the default: ADDRESS, BUILDING, DEPT, DUPLEX, FCB, FORMDEF, NAME, PAGEDEF, ROOM, TITLE.
• JES3: If you specify the HOLD=YES parameter on the DD statement, the operator cannot use Infoprint Central to release or delete the data set, or change any characteristics of the data set. To hold an output data set, IBM suggests that you instead specify a held output class on the DD or OUTPUT statement. This suggestion applies whether you print on IP PrintWay extended mode printers or on PSF printers.