Attributes for the protocol object class

z/OS Infoprint Server Operation and Administration

Attributes for the protocol object class

z/OS Infoprint Server Operation and Administration
SA38-0693-00

Attributes for the protocol object class

This section lists attributes that are valid when you create Protocol components, which are in object class protocol. These attributes are also valid for the printer object class.

Required attributes

Table 43 summarizes the attributes that are required and optional when you create a printer definition. The required and optional attributes depend on the value you select for the protocol-type attribute. You can specify attributes either in the printer definition or in an included Protocol component.

Note:

When you create a Protocol component, no attributes are required. When you create a default IP PrintWay™ printer definition, no attributes are required.

Table 43. Required protocol attributes
Value of protocol-type attribute	Required attributes	Optional attributes
direct-sockets	printer-ip-address, port-number	description, operator-security-profile, page-accounting, page-restart
ipp	printer-uri	description, operator-security-profile
lpr	printer-ip-address, print-queue-name	description, lpr-xxxxx, operator-security-profile, owner, server-user-options
vtam	printer-luname	description, operator-security-profile, printer-logmode, vtam-checkpoint-pages, vtam-send-as-transparent
email	mail-to-addresses	description, mail-bcc-addresses, mail-cc-addresses, mail-embedded-headers, mail-inline-text, mail-inline-message, mail-from-name, mail-reply-address

description

This single-valued attribute specifies a description for the component. The description can help you select the correct component from a list.

ISPF field name

Description

Allowed values

Any combination of 1-256 letters (a-z, A-Z), numbers (0-9), blanks, and special characters (such as # $ @ ! = / -). If the value contains blanks or special characters, enclose it in single or double quotation marks.

Default value

None.

lpr-banner-class

This single-valued attribute specifies the class name that IP PrintWay passes to the remote LPD for printing on a banner page, a page the LPD can print before the document.

ISPF field name

Banner class

Allowed values

A combination of 1-31 letters (a-z, A-Z), numbers (0-9), blanks, and special characters (such as @ $ # , * - /). If the value contains blanks or special characters, enclose it in single or double quotation marks.

Default value

IP PrintWay passes the name of the z/OS system to the LPD.

Usage guidelines

The implementation and configuration of the remote LPD determine how this value is used.
IP PrintWay uses this value only when it uses the LPR transmission protocol and lpr-print-banner=yes.

lpr-banner-job-name

This single-valued attribute specifies the job name that IP PrintWay passes to the remote LPD for printing on a banner page, a page the LPD can print before the document.

ISPF field name

Banner job name

Allowed values

A combination of 1-99 letters (a-z, A-Z), numbers (0-9), blanks, and special characters (such as @ $ # , * - /). If the value contains blanks or special characters, enclose it in single or double quotation marks.

Specify %sysout-job-name to pass the z/OS® job name instead of the z/OS fully qualified data set name to the LPD. (See Default value for information about when IP PrintWay passes the fully qualified data set name to the LPD.) For example:

lpr-banner-job-name="%sysout-job-name"

Default value

IP PrintWay passes one of these values to the LPD:

The value specified in the sysout-dataset-name job attribute.
One of these values:
- IP PrintWay extended mode: The file name of documents submitted from remote systems, with the AOPPRINT JCL procedure, or with the lp command.
- IP PrintWay extended mode: The VTAM® LU name of the application that submitted the print request to NetSpool.
- IP PrintWay basic mode and extended modes: The z/OS fully qualified data set name in this format:
  system_name.user_ID.job_name.job_ID.dset_ID.short_dset_name

Usage guidelines

The implementation and configuration of the remote LPD determine how this value is used.
IP PrintWay uses this value only if it uses the LPR transmission protocol and lpr-print-banner=yes.

lpr-filename

This single-valued attribute specifies the file name that IP PrintWay passes to the remote LPD.

ISPF field name

Filename

Allowed values

Default value

One of these values:

IP PrintWay extended mode: The file name of documents submitted from remote systems, with the AOPPRINT JCL procedure, or with the lp command.
IP PrintWay extended mode: The VTAM LU name of the application that submitted the print request to NetSpool.
IP PrintWay basic mode and extended modes: The z/OS fully qualified data set name in this format:
system_name.user_ID.job_name.job_ID.dset_ID.short_dset_name

Usage guidelines

The implementation and configuration of the remote LPD determine how this value is used.
IP PrintWay uses this value only if it uses the LPR transmission protocol.
IP PrintWay passes this value to the LPD only if lpr-print-function=p.

lpr-indent

This single-valued attribute specifies the number of columns that the remote LPD indents the output it generates.

ISPF field name

Indent

Allowed values

An integer from 1-2147483646.

Default value

IP PrintWay does not pass a value to the LPD, so output is not indented.

Usage guidelines

The implementation and configuration of the remote LPD determine how this value is used.
IP PrintWay uses this value only if it uses the LPR transmission protocol.

lpr-mode

This single-valued attribute specifies the mode that IP PrintWay uses when transmitting data to a remote LPD.

ISPF field name

Mode

Allowed values

You can enter one of these fixed values:

control-file-first

IP PrintWay transmits the control file before the data file. Not all LPDs support this mode. However, this mode lets some LPDs print data as it is received and print larger files.

control-file-last

IP PrintWay transmits the control file after the data file. All LPDs that adhere to RFC 1179 support this mode.

streaming

IP PrintWay transmits the control file before the data file. The remote LPD must support the RECEIVE CONTROL FILE FIRST and RECEIVE DATA FILE WITH UNSPECIFIED LENGTH commands. Specify this value if the target system is an IBM® network station.

to-remote-psf

IP PrintWay transmits files to Ricoh InfoPrint Manager or to Ricoh ProcessDirector. IP PrintWay:

Adds a record length field to each record.
Creates -o parameters in the control file. -o parameters contain AFP values specified by the job submitter, such as duplex option.
Does not format or translate the data file to ASCII. (IP PrintWay ignores the printway-formatting attribute.)
Transmits the control file after the data file.

Default value

IP PrintWay transmits the control file after the data file.

lpr-optimize-copies

This single-valued attribute indicates how IP PrintWay is to transmit documents when the job submitter requests multiple copies.

ISPF field name

Optimize copies

Allowed values

You can enter one of these fixed values:

yes: IP PrintWay transmits the document to the LPD only one time. IP PrintWay tells the LPD how many copies to print in the LPD control file.
no: IP PrintWay transmits the document to the LPD multiple times, one time for each copy.

Default value

IP PrintWay does not optimize the transmission of copies.

Usage guidelines

Select this field to improve performance, but only if the printer's LPD supports printing multiple copies of one file.
When lpr-mode=to-remote-psf, IP PrintWay ignores this attribute and transmits documents only one time because PSF supports printing multiple copies of one file.
IP PrintWay uses this value only if it uses the LPR transmission protocol.

lpr-print-banner

This single-valued attribute indicates whether the remote LPD is to print a banner page. When lpr-print-banner=yes, IP PrintWay sends information for printing on the banner page to the LPD. A banner page is a page the LPD can print before the document.

ISPF field name

Print banner page

Allowed values

You can enter one of these fixed values:

yes: The LPD prints a banner page.
no: The LPD does not print a banner page.

Default value

The LPD prints a banner page.

Usage guidelines

The implementation and configuration of the remote LPD determine how this value is used.
IP PrintWay uses this value only if it uses the LPR transmission protocol.

lpr-print-function

This single-valued attribute specifies a code that tells the remote LPD what type of data formatting to do.

ISPF field name

Print function

Allowed values

An upper or lowercase letter. These codes usually mean:

Code: Meaning
f: Print as a sequence of lines.
l: Print leaving control characters.
p: Print with pagination.
r: Print interpreting the first column as FORTRAN (ANSI) carriage control characters. Supported characters are 1, 0, +, -, and blank.

Default value

IP PrintWay passes code f to the remote LPD.

Usage guidelines

Some LPDs require that you specify code l for data that is not to be formatted or that includes transparent data.
The implementation and configuration of the remote LPD determine how this value is used.
IP PrintWay uses this value only if it uses the LPR transmission protocol.

lpr-restrict-ports

This single-valued attribute indicates whether IP PrintWay must use a z/OS port in the range of 721 to 731 when communicating with the remote LPD. Specify restrict-ports=yes when the remote LPD enforces this port restriction.

ISPF field name

Restrict ports

Allowed values

You can enter one of these fixed values:

yes: The z/OS port must be in the range of 721 to 731.
no: Any z/OS port can be used.

Default value

IP PrintWay uses any z/OS port.

Usage guidelines

When restrict-ports=no, IP PrintWay can use any free port. This increases the probability of finding an available port.
IP PrintWay uses this value only if it uses the LPR transmission protocol.

lpr-title

This single-valued attribute specifies a document title that IP PrintWay passes to the remote LPD.

ISPF field name

Title

Allowed values

A combination of 1-79 letters (a-z, A-Z), numbers (0-9), blanks, and special characters (such as @ $ # , * - /). If the value contains blanks or special characters, enclose it in single or double quotation marks.

Default value

A title specified by the job submitter.
One of these values:
- IP PrintWay extended mode: The file name of documents submitted from remote systems, with the AOPPRINT JCL procedure, or with the lp command.
- IP PrintWay extended mode: The VTAM LU name of the application that submitted the print request to NetSpool.
- IP PrintWay basic mode and extended modes: The z/OS fully qualified data set name in this format:
  system_name.user_ID.job_name.job_ID.dset_ID.short_dset_name

Usage guidelines

The implementation and configuration of the remote LPD determine how this value is used.
IP PrintWay uses this value only if it uses the LPR transmission protocol.
A title specified by the job submitter overrides the value specified in this attribute.

lpr-width

This single-valued attribute specifies the maximum number of columns that the remote LPD puts on a line.

ISPF field name

Width

Allowed values

An integer from 1-2147483646.

Default value

IP PrintWay does not pass a width value to the LPD.

Usage guidelines

The implementation and configuration of the remote LPD determine how this value is used.
IP PrintWay uses this value only if it uses the LPR transmission protocol.

mail-bcc-addresses

This multi-valued attribute specifies the email addresses of the “blind copy (bcc)” recipients of an email. A bcc means that other recipients of the email do not see the bcc recipient listed. You can also specify one or more alias names that are defined to z/OS UNIX sendmail. An alias name represents one or more real email addresses. This attribute pertains only to printer definitions with protocol-type=email. It is optional for these printer definitions.

ISPF field name

BCC addresses

Allowed values

You can specify 1-32 email addresses. If you specify more than one value, separate the values with spaces and enclose the list of values in braces {}. Each email address can be 1-60 characters. Blanks are not allowed in an email address. If the email address contains special characters (such as @ $ & ( ) > < | ' " #), enclose the entire email address in single or double quotation marks. If the email address contains the special character @, enclose the value in braces even if there is only one value. If the email address contains double quotation marks, enclose the entire address in single quotation marks. Each address or alias name should be in this format:

username[@domainname]

username: The name of the recipient or an alias name that is defined to z/OS UNIX sendmail.
@domainname: The domain name of the target system. If you omit @domainname, sendmail uses the name of the system on which sendmail is running. If you specify an alias, omit @domainname.

For example:

mail-bcc-addresses = {"user2@xyz.com" dept01list}
mail-bcc-addresses = {"user2@xyz.com"}

Default value

None.

Usage guidelines

Infoprint Server does not verify that the value is in the correct format.
An address that the job submitter specifies overrides this value.

mail-cc-addresses

This multi-valued attribute specifies the email addresses of the “copy (cc)” recipients of an email. A cc means that other recipients of the email can see the cc recipient listed. You can also specify one or more alias names that are defined to z/OS UNIX sendmail. An alias name represents one or more real email addresses. This attribute pertains only to printer definitions with protocol-type=email. It is optional for these printer definitions.

ISPF field name

CC addresses

Allowed values

username[@domainname]

username: The name of the recipient or an alias name that is defined to z/OS UNIX sendmail.
@domainname: The domain name of the target system. If you omit @domainname, sendmail uses the name of the system on which sendmail is running. If you specify an alias, omit @domainname.

For example:

mail-cc-addresses = {"user3@xyz.com" dept02list}
mail-cc-addresses = {"user3@xyz.com"}

Default value

None.

Usage guidelines

Infoprint Server does not verify that the value is in the correct format.
An address that the job submitter specifies overrides this value.

mail-embedded-headers

This single-valued attribute indicates whether line-data documents can contain email headers. This attribute pertains only to printer definitions with protocol-type=email. It is optional for these printer definitions.

ISPF field name

Embedded headers

Allowed values

You can enter one of these fixed values:

yes: IP PrintWay extended mode looks for an email header in the first 32 records of all line-data documents. If a header is found, it sends the email to the addresses in the header and with the subject specified in the header. If no header is found, it sends the email to the addresses specified on the OUTPUT JCL statement, in job attributes, or in the printer definition.
no: IP PrintWay extended mode does not look for email headers.

Default value

IP PrintWay does not look for an email headers.

Usage guidelines

IP PrintWay extended mode does not look for email headers in documents with other formats (such as, text, PCL, and PDF).
If you print VTAM application data that contains email headers, specify netspool-formatting=convert-to-line (default).
An address or subject in the email header overrides the address and title specified on the OUTPUT JCL statement, in job attributes, and in the printer definition.
For the format of email headers, see z/OS Infoprint Server User’s Guide.
IP PrintWay basic mode ignores this attribute. It does not look for email headers in line-data documents.

mail-from-name

This single-valued attribute specifies the descriptive name or other identifier of the sender of an email. This attribute pertains only to printer definitions with protocol-type=email. It is optional for these printer definitions.

ISPF field name

From name

Allowed values

A combination of 1-60 letters (a-z, A-Z), numbers (0-9), blanks, and special characters (such as @ $ & ( ) > < | ' " #). If the name contains blanks or special characters, enclose the entire name in single or double quotation marks. If the name contains double quotation marks, enclose the entire name in single quotation marks.

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.

For example, this specification:

mail-from-name = "John Q. Sender"

Puts this information in the email:

From: John Q. Sender <JOHN@SYSTEM1>

Tip:

To specify the email address that recipients of an email can reply to, use the mail-reply-address attribute.

Default value

None.

Usage guidelines

Infoprint Server does not verify that the value is in the correct format.
A name that the job submitter specifies overrides this value.

mail-inline-message

This single-valued attribute specifies data that IP PrintWay extended mode includes inline at the beginning of each email. For example, you can specify a standard greeting and text. This attribute pertains only to printer definitions with protocol-type=email. It is optional for these printer definitions.

ISPF field name

Inline message

Allowed values

Up to 292 letters, numbers, blanks, and special characters. If the message contains blanks or special characters, enclose the entire message in single or double quotation marks. You can include control values, such as:

Value: Description
<LF>: New line
<SP>: Blank character

Email programs can interpret control values in different ways.

Tip: Infoprint Server converts each blank in the message to <SP>. If the message exceeds 292 characters, it is truncated.

Examples

"Greetings:<LF><LF>The monthly sales report is attached.<LF>"

"Greetings:<LF><LF>The<SP>monthly<SP>sales<SP>report<SP>is<SP>attached.<LF>"

This is the message in the email:

Greetings:

The monthly sales report is attached.
[If you include a document in the body of the email, text starts here.]

Default value

No inline message is included in the body of the email.

Usage guidelines

IP PrintWay basic mode ignores this attribute.

mail-inline-text

This single-valued attribute indicates whether data in text and line-data documents is included inline in the body of the email. This attribute pertains only to printer definitions with protocol-type=email. It is optional for these printer definitions.

ISPF field name

Inline text and line data

Allowed values

You can enter one of these fixed values:

yes: Text and line data is included inline.
no: Text and line data is not included inline. All documents are sent as attachments.

Default value

Text and line data is not included inline. All documents are sent as attachments.

Usage guidelines

Documents in a format other than line data or text (such as, AFP and PDF documents) are always sent as attachments.
Line data documents transformed to another format (such as, PDF) are always sent as attachments.
If you print VTAM application data and want to include data inline, specify netspool-formatting=line (default).
You can separate data from more than one document in an email with a blank line or other text. For a blank line, specify <LF> in the document-trailer attribute.
IP PrintWay basic mode ignores this attribute. It sends text and line data documents as attachments.

mail-reply-address

This single-valued attribute specifies the email address that recipients of an email can reply to. You can also specify an alias name that is defined to z/OS UNIX sendmail. An alias name represents one or more real email addresses. This attribute pertains only to printer definitions with protocol-type=email. It is optional for these printer definitions.

ISPF field name

Reply address

Allowed values

A combination of 1-60 letters (a-z, A-Z), numbers (0-9), and special characters (such as @ $ & ( ) > < | ' " #). Blanks are not allowed in an email address. If the email address contains special characters, enclose the entire name in single or double quotation marks. If the name contains double quotation marks, enclose the entire name in single quotation marks. If the email address contains the special character @, enclose the value in braces. The name should be in this format:

username[@domainname]

username: The name portion of the address, or an alias name that is defined to z/OS UNIX sendmail.
@domainname: The domain portion of the target system. If you omit @domainname, sendmail uses the name of the system on which sendmail is running.

For example:

mail-reply-address = {"mysecretary@xyz.com"}

Default value

None. However, 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.

Usage guidelines

Infoprint Server does not verify that the value is in the correct format.
An address that the job submitter specifies overrides this value.

mail-to-addresses

This multi-valued attribute specifies the email addresses of the recipients of an email. You can also specify one or more alias names that are defined to z/OS UNIX sendmail. An alias name represents one or more real email addresses. This attribute pertains only to printer definitions with protocol-type=email. It is required for these printer definitions. The job submitter can override the email addresses during job submission. You can set up just one printer definition for the email protocol because the job submitter can specify the email addresses. You must specify a default email address in this printer definition.

ISPF field name

Email addresses

Allowed values

Each email address or alias name should be in this format:

username[@domainname]

username: The name of the recipient or an alias name that is defined to z/OS UNIX sendmail.
@domainname: The domain name of the target system. If you omit @domainname, sendmail uses the name of the system on which sendmail is running. If you specify an alias, omit @domainname.

For example:

mail-to-addresses = {"user1@xyz.com" dept03list}
mail-to-addresses = {"user1@xyz.com"}

Default value

None.

Usage guidelines

Infoprint Server does not verify that the value is in the correct format.
An address that the job submitter specifies overrides this value.

name

This single-valued attribute specifies the name of the component.

Note:

This is a non-settable attribute. Do not specify the name attribute on the PIDU create, force-create, or modify command. Instead, specify the name as an operand on the command. However, you can specify the name attribute when you construct a condition for the where predicate on the list and export commands.

ISPF field name

Component Name

Allowed values

Any combination of 1-17 letters (a-z, A-Z), numbers (0-9), and special characters (such as $ # @ . - = /). Blanks are not allowed.

Default value

None.

operator-security-profile

This single-valued attribute specifies the name of the RACF® resource profile in the PRINTSRV class that controls who can work with this printer using Infoprint Central. This attribute applies only to IP PrintWay extended mode.

ISPF field name

Operator security profile

Allowed values

A combination of letters, numbers, and special characters except for commas, semicolons, parentheses, and blanks. If the value contains special characters, enclose it in single or double quotation marks. Lowercase letters are converted to uppercase. Do not start names with AOP. For example:

operator-security-profile = "DENVER.001"

Default value

None.

Usage guidelines

To authorize users to a group of printers, specify the same profile name in the IP PrintWay printer definitions and PSF FSA definitions for all printers in the group.
If more than one printer definition exists for a printer, specify the same profile name in each printer definition.
If the profile name is not defined to RACF, or if you omit this attribute, anyone can work with this printer.
This attribute does not apply to IP PrintWay basic mode or when you select the email protocol.
For information about the PRINTSRV class, see z/OS Infoprint Server Customization.

owner

This single-valued attribute specifies the owner name that IP PrintWay passes to the remote LPD for printing on the banner page, a page printed before the document.

ISPF field name

Owner

Allowed values

A combination of 1-31 letters (a-z, A-Z), numbers (0-9), blanks, and special characters (such as: @ $ # , * - /). If the value contains blanks or special characters, enclose it in single or double quotation marks.

Default value

IP PrintWay passes the user ID for the print job to the LPD.

Usage guidelines

The implementation and configuration of the remote LPD determine how this value is used.
IP PrintWay uses this value only if it uses the LPR transmission protocol and lpr-print-banner=yes.

page-accounting

This single-valued attribute indicates whether IP PrintWay extended mode records the number of printed pages in the SMF type 6 accounting record (in field SMF6PGE) for each document.

ISPF field name

Record pages printed for accounting

Allowed values

You can enter one of these fixed values:

yes: IP PrintWay extended mode records the number of printed pages in the SMF record.
no: IP PrintWay extended mode does not record the number of printed pages in the SMF record.

Default value

IP PrintWay does not record the number of printed pages.

Usage guidelines

Specify yes only if the printer supports HP's Printer Job Language (PJL).
Specify this attribute if the printer supports PJL so that you get more accurate accounting information.
If you specify this attribute or the page-restart=yes attribute, IP PrintWay extended mode also supports the cancel function from the printer's console.
IP PrintWay extended mode uses this attribute only if protocol-type=direct-sockets. For other protocols, it ignores this attribute and does not record the number of printed pages in the SMF record.
IP PrintWay basic mode always ignores this attribute. It does not record the number of printed pages in the SMF record.
Documents cannot contain PJL JOB commands. If you use a transform, you might need to customize the transform so that it does not add PJL commands. For information, see z/OS Infoprint Server Customization.

page-restart

This single-valued attribute indicates where IP PrintWay extended mode tells the printer to start printing again after an error occurs. It can tell the printer to start printing from the beginning of the print job or after the last page that the printer reported printed successfully.

ISPF field name

Restart printing after last successful page

Allowed values

You can enter one of these fixed values:

yes: IP PrintWay extended mode tells the printer to start printing after the last page that the printer reported printed successfully.
no: IP PrintWay extended mode tells the printer to start printing from the beginning of the print job.

Default value

IP PrintWay extended mode tells the printer to start printing from the beginning of the print job.

Usage guidelines

Specify yes only if the printer supports HP's Printer Job Language (PJL).
Specify yes if you send large documents to the printer. This can save paper and printing costs.
To prevent duplicate pages, set a high value in the response-timeout attribute to give the operator time to add paper or fix a jam.
If you specify this attribute or the page-accounting=yes attribute, IP PrintWay extended mode also supports the cancel function from the printer's console.
IP PrintWay extended mode uses this attribute only if protocol-type=direct-sockets. For other protocols, it ignores this attribute and always restarts printing from the beginning of the print job.
IP PrintWay basic mode ignores this attribute. Printing always restarts from the beginning of the print job.
Documents cannot contain PJL JOB commands. If you use a transform, you might need to customize it to not add PJL commands. For information, see z/OS Infoprint Server Customization.

port-number

This single-valued attribute specifies the port number of the remote printer or print server.

ISPF field name

Port number

Allowed values

Specify the port number (1–65545) that is configured in the printer.

Default value

None.

Usage guidelines

This attribute is required if you create a printer definition and protocol-type=direct-sockets. For other protocol types, IP PrintWay ignores this attribute.
A port number specified by the job submitter overrides this attribute.
To determine the correct port number, see the documentation for the network interface card or printer. Some typical port numbers are:
- Port 9100 is used by some Ricoh printers, most HP printers, and most Lexmark printers.
- Port 2501 is used by some Ricoh printers.
In the IP PrintWay default printer definition named DFLTNTRY, omit this attribute because IP PrintWay uses the port number specified on the OUTPUT JCL statement.

print-queue-name

This single-valued attribute specifies the name of the print queue in the remote printer or print server. Specify this attribute if you specify the LPR protocol in the protocol-type attribute.

ISPF field name

Print queue name

Allowed values

A combination of 1-255 letters (a-z, A-Z), numbers (0-9), and special characters (such as # $ @ ! = / -). Blanks are not allowed. The print queue name is case-sensitive on some remote systems, so be sure to use the correct uppercase and lowercase letters. Examples of print queue names are:

print-queue-name = TEXT
print-queue-name = PASS
print-queue-name = RAW

Default value

None.

Usage guidelines

This attribute is required if you create a printer definition and protocol-type=lpr. For other protocol types, IP PrintWay ignores this attribute.
A print queue name specified by the job submitter overrides this value.
To determine the print queue name, see the documentation for the network interface card, the printer, or the print server. Some common queue names are:
- TEXT and RAW are used for some Ricoh printers, most HP printers, and most Lexmark printers. Specify the RAW queue for formatted text data, PCL data, and PostScript data.
- TEXT and PASS are used for some Ricoh printers. Specify the PASS queue for text data that contains a carriage return at the end of each line, PCL data, and PostScript data.
- If you specify the PASS or RAW queues and you run IP PrintWay basic mode, also specify 0D25 in the Line termination field. 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.
In the IP PrintWay default printer definition named DFLTNTRY, omit this attribute because IP PrintWay uses the print queue name specified on the OUTPUT JCL statement.

printer-ip-address

This single-valued attribute specifies the Internet Protocol (IP) address or host name of the remote printer or print server.

ISPF field name

Printer IP address

Allowed values

Specify a valid IP address or host name. You can specify the IP address in dotted-decimal or colon-hexadecimal format. Blanks are not allowed. If the value contains special characters, enclose it in quotation marks. Examples of printer IP addresses are:

printer-ip-address = 9.99.176.133
printer-ip-address = prt009.net.xyz.com
printer-ip-address = PRT009
printer-ip-address = 2001:0db8:85a3:0000:0000:8a2e:0370:7334

Default value

None.

Usage guidelines

If you specify a colon-hexadecimal IP address:
- IP PrintWay extended mode is required.
- 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.
If you run IP PrintWay extended mode and specify a host name, define the host name in the domain name server (DNS) before you save the printer definition. If the DNS entry is created after you save the printer definition, Infoprint Central cannot display the printer for this printer definition until someone submits a print job to the printer definition or until you modify an attribute in the printer definition.
An IP address specified by the job submitter overrides this attribute.
If another printer definition refers to this printer, use the same uppercase and lowercase letters when you type the host name.
This attribute is required when you create a printer definition and specify either lpr or direct-sockets in the protocol-type attribute. For other protocol types, IP PrintWay ignores this attribute.
In the IP PrintWay default printer definition named DFLTNTRY, you can omit this attribute because the job submitter must specify an IP address.

printer-logmode

This single-valued attribute specifies the name of an entry in the VTAM logon-mode table, which defines the session parameters for a printer.

ISPF field name

Printer logmode

Allowed values

You can enter a valid combination of 1–8 letters, numbers, and special characters (# $ @). The first character cannot be numeric. Blanks and other special characters are not allowed. If a value contains special characters, enclose the value in quotation marks. Lowercase letters are converted to uppercase.

Default value

The name specified in the DLOGMOD parameter of the VTAM resource definition statement for the printer.

Usage guidelines

IP PrintWay uses this value only if protocol-type=vtam.

printer-luname

This single-valued attribute specifies the VTAM network name of the printer. This name must match the name of the VTAM resource definition for the printer. For example, the VTAM LU or LOCAL definition. LU type 0 (DSC/DSE), LU type 1 (SCS) and LU type 3 (DSC/DSE) printers are supported.

ISPF field name

Printer luname

Allowed values

Default value

None.

Usage guidelines

This attribute is required if you create a printer definition and protocol-type=vtam. For other protocol types, IP PrintWay ignores this attribute.

printer-uri

This single-valued attribute specifies the Uniform Resource Identifier (URI) of the remote Internet Printing Protocol (IPP) server running either in a printer or host system. This attribute is required if you create a printer definition and protocol-type=ipp.

ISPF field name

URL

Allowed values

A combination of letters, numbers, and special characters, as defined by RFC 2396. Blanks are not allowed. If the value contains special characters, enclose it in quotation marks. Examples of URIs are:

printer-uri="ipp://myprinter.xyz.com"
printer-uri="http://myprinter.xyz.com:631"

Default value

None.

Usage guidelines

For URIs prefixed with ipp, the default port is 631.
For IP PrintWay basic mode: If you specify this URI in another printer definition, use the same uppercase and lowercase letters in each printer definition.

protocol-type

This single-valued attribute specifies the transmission protocol you want IP PrintWay to use to transmit data sets to the remote system.

ISPF field name

Protocol

Allowed values

You can enter one of these fixed values:

direct-sockets: TCP/IP socket to socket protocol.
email: TCP/IP Simple Mail Transfer Protocol (SMTP).
ipp: Internet Printing Protocol (IPP). An IPP server must be running in the remote printer or server.
lpr: TCP/IP line printer (LPR) to line printer daemon (LPD) protocol. An LPD must be running in the remote printer or print server and listening at port 515.
vtam: Virtual Telecommunications Access Method (VTAM). The printer must be a VTAM LU type 0 (DSC/DSE), LU type 1 (SCS), or LU type 3 (DSC/DSE).

Default value

lpr

Usage guidelines

If you specify direct-sockets, also specify the printer-ip-address and port-number attributes.
If you specify email, also specify the mail-to-addresses attribute.
If you specify ipp, also specify the printer-uri attribute.
If you specify lpr, also specify the printer-ip-address and print-queue-name attributes.
If you specify vtam, also specify the printer-luname attribute.

server-user-options

This single-valued attribute specifies information that IP PrintWay sends to the remote LPD. You can specify options that the remote LPD supports but that IP PrintWay does not automatically generate.

ISPF field name

User options

Allowed values

A combination of 1-255 letters (a-z, A-Z), numbers (0-9), blanks, and special characters (such as @ $ # , * - /). If the value contains blanks or special characters, enclose it in single or double quotation marks.

Default value

None.

Usage guidelines

Most LPD servers require each -o option to end with a line-feed character (ASCII X'0A'). IP PrintWay automatically adds a line-feed character to the end of the value that you specify for this attribute. However, to specify more than one -o option using this attribute, you must separate them with a line-feed character. Because IP PrintWay converts the entire attribute value from EBCDIC to ASCII, you must specify an EBCDIC line-feed character (X'25'). For example: server-user-options="-oformdef=F1STND01\x25-oti=TitleInfo". You must use a PIDU command to specify this value because it contains a hexadecimal character. You cannot use the ISPF panels to specify a hexadecimal character for this attribute. The ISPF panels display this hexadecimal character as an unprintable character (dot).
IP PrintWay ignores this attribute when it uses the direct sockets, IPP, or VTAM transmission protocol.

vtam-checkpoint-pages

This single-valued attribute specifies the number of pages between data-set checkpoints. IP PrintWay requests a definitive response from the printer after the specified number of pages. If a printer error or printer intervention situation occurs, IP PrintWay resends all pages that were sent after the last definitive response from the printer. This makes sure that no data is lost. However, duplicate pages, up to the number specified in this attribute, might be printed.

If a printer error or intervention situation persists after IP PrintWay resends pages from the last data-set checkpoint, IP PrintWay resends all data from the beginning (without using the checkpoint) if retries are requested. In this case, more duplicate pages might be printed.

ISPF field name

Checkpoint pages

Allowed values

An integer from 0 - 25.

Default value

IP PrintWay uses 5.

Usage guidelines

0 means that IP PrintWay takes no checkpoints. If 0 is specified and an error occurs, IP PrintWay retransmits the entire data set if you requested retries in the printer definition. For information about how to specify retries, see the retry-limit and retry-time attributes.
This attribute is used only if protocol-type=vtam. For other protocol types, IP PrintWay ignores this attribute.
If you request too frequent checkpoints, printer performance can be adversely affected.
If you request infrequent checkpoints, more duplicate pages might be printed.

vtam-send-as-transparent

This single-valued attribute indicates that IP PrintWay sends output data to the printer as transparent data. IP PrintWay precedes data with transparent data controls but does not convert data to SCS or DSC/DSE format.

Allowed values

You can enter one of these fixed values:

yes: IP PrintWay transmits data as transparent data.
no: IP PrintWay does not transmit data as transparent data.

Default value

IP PrintWay does not transmit data as transparent data.

Usage guidelines

IP PrintWay uses this attribute only if protocol-type=vtam. For other protocols, IP PrintWay ignores this attribute.
Specify vtam-send-as-transparent=yes if data is already in a format that the printer accepts and if the SNA gateway requires that data be sent as transparent data.
You can specify the character that IP PrintWay uses in the transparent data controls in the transparent-data-character attribute.
IP PrintWay does not transmit these types of data as transparent data:
- Data specified in the document-header and document-trailer attributes
- Data added by the IP PrintWay Begin Data Set and End Data Set exits
When vtam-send-as-transparent=yes, IP PrintWay ignores the printway-formatting attribute and processes data as if printway-formatting=none.

Notices | Terms of use | Support | Contact z/OS | zFavorites