z/OS Infoprint Server Operation and Administration
Previous topic | Next topic | Contents | Index | Contact z/OS | Library | PDF


Attributes for the printer object class

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

Attributes for the printer object class

This section lists the attributes that are valid when you create printer definitions, which are in object class printer. In addition to these attributes, you can also specify attributes that are valid for the object classes listed in Table 42. Some object classes listed in the table are valid only for certain printer types, as defined by the printer-type attribute.

Table 42. Object classes whose attributes are valid for printer object class
Object classValid for printer typeSee topic
allocationAll typesAttributes for the allocation object class
netspool-eof-rulesAll typesAttributes for the netspool-eof-rules object class
netspool-optionsAll typesAttributes for the netspool-options object class
printway-optionsgeneral, ip-printwayAttributes for the printway-options object class
processingAll typesAttributes for the processing object class
protocolip-printwayAttributes for the protocol object class

Required attributes

For Infoprint Server to display the correct ISPF panels for a printer definition, you must specify the printer-type attribute.

NetSpool requires the luname attribute.

Also, see the list of attributes for the other object classes whose attributes are valid for the printer object class. Table 42 summarizes these object classes. These object classes identify other required attributes.

dcf-routing

This single-valued attribute specifies whether job submitters can use the DEST, CLASS, and FORMS JCL parameters to select this printer definition. For more information, see Using DEST, CLASS, and FORMS to select a printer definition.

ISPF field name

Use DEST, CLASS, and FORMS for IP PrintWay™ printer selection

Allowed values

You can enter one of these fixed values:

yes
The DEST, CLASS, and FORMS parameters can be used to select this printer definition.
no
The DEST, CLASS, and FORMS cannot be used to select this printer definition.
Default value

IP PrintWay does not let job submitters select this printer using the DEST, CLASS, and FORMS parameters.

Usage guidelines
  • This attribute applies only for IP PrintWay printer definitions (printer-type =ip-printway).
  • If you select yes, you must also specify a value for one or more of these attributes: output-class, destination, or forms. If you omit one of these attributes, IP PrintWay does not use the corresponding JCL parameter for printer selection. The values for the output-class, destination, and forms attributes must, together, be unique in all printer definitions with dcf-routing = yes.
  • Set this attribute to yes if you are migrating IP PrintWay routing entries and want to continue to use DEST, CLASS, and FORMS as selection criteria.
  • Regardless of the value of this attribute, a job submitter can specify a printer name on an OUTPUT JCL statement to select this printer definition (in the FSSDATA parameter).

description

This single-valued attribute specifies a description for the printer definition. The description can help users select a printer definition.

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.

general-spooling-mode

This single-valued attribute indicates how Print Interface writes the input data to the output data set on the JES spool when printer-type=general. Select a value that is suitable for the printer. spooling-mode is an alias for this attribute.

ISPF field name

Spooling mode

Allowed values

You can enter one of these fixed values:

line
Print Interface writes the data in records. This value is suitable for JES and AFP printers.
stream
Print Interface writes the data as a data stream, with control characters to indicate the end of lines. This value is suitable for ASCII printers.
Default value

line

Usage guidelines

This attribute applies only for General printer definitions (printer-type=general). It is ignored if printer-type=psf-mvs or printer-type=ip-printway.

include-allocation

This single-valued attribute specifies the name of the Allocation component to be included in this printer definition. An Allocation component is an object in object-class allocation.

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. If the value contains special characters, enclose it in single or double quotation marks.

Default value

No Allocation component is included in the printer definition.

Usage guidelines

All attributes specified in this component apply to the printer definition. To override an attribute from the component, specify the attribute on the create or modify command for the printer definition.

include-netspool-eof-rules

This single-valued attribute specifies the name of a NetSpool End-of-File component to be included in this printer definition. A NetSpool End-of-File component is an object in object-class netspool-eof-rules.

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. If the value contains special characters, enclose it in single or double quotation marks.

Default value

No NetSpool End-of-File component is included in the printer definition.

Usage guidelines

All attributes specified in this component apply to the printer definition. To override an attribute from the component, specify the attribute on the create or modify command for the printer definition.

include-netspool-options

This single-valued attribute specifies the name of a NetSpool Options component to be included in this printer definition. A NetSpool Options component is an object in object-class netspool-options.

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. If the value contains special characters, enclose it in single or double quotation marks.

Default value

No NetSpool Options component is included in the printer definition.

Usage guidelines

All attributes specified in this component apply to the printer definition. To override an attribute from the component, specify the attribute on the create or modify command for the printer definition.

include-printway-options

This single-valued attribute specifies the name of an IP PrintWay Options component to be included in this printer definition. An IP PrintWay Options component is an object in object-class printway-options.

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. If the value contains special characters, enclose it in single or double quotation marks.

Default value

No IP PrintWay Options component is included in the printer definition.

Usage guidelines
  • All attributes specified in this component apply to the printer definition. To override an attribute from the component, specify the attribute on the create or modify command for the printer definition.
  • This attribute applies only to IP PrintWay and General printer definitions (printer-type=ip-printway and printer-type=general).

include-processing

This single-valued attribute specifies the name of a Processing component to be included in this printer definition. A Processing component is an object in object-class processing.

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. If the value contains special characters, enclose it in single or double quotation marks.

Default value

No Processing component is included in the printer definition.

Usage guidelines

All attributes specified in this component apply to the printer definition. To override an attribute from the component, specify the attribute on the create or modify command for the printer definition.

include-protocol

This single-valued attribute specifies the name of a Protocol component to be included in this printer definition. A Protocol component is an object in object-class protocol.

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. If the value contains special characters, enclose it in single or double quotation marks.

Default value

No Protocol component is included in the printer definition.

Usage guidelines
  • All attributes specified in this component apply to the printer definition. To override an attribute from the component, specify the attribute on the create or modify command for the printer definition.
  • This attribute applies only to IP PrintWay printer definitions (printer-type=ip-printway).

location

This single-valued attribute lets you specify the location of the printer. The location can help users select and find printers.

ISPF field name

Location

Allowed values

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

Default value

None.

Usage guidelines
  • If you use the same format to specify the location in all printer definitions (for example: Bldg 3/Col 2), you can find all printer definitions with similar locations, such as all printers in Bldg 3.
  • If more than one printer definition exists for the same IP PrintWay printer, specify the same location in all printer definitions for the printer so Infoprint Central can find the printer.

lu-classes

This multi-valued, list attribute identifies from one to sixty-four logical-unit (LU) classes for this NetSpool LU. If you specify more than one class, the NetSpool LU is assigned to all of the specified classes.

ISPF field name

LU classes

Allowed values

An integer from 1 to 64. You can specify a list of up to 64 classes. If you specify more than one LU class, separate the LU classes by spaces and surround the list of LU classes with braces. For example:

lu-classes={1 4 64}
Default value

{1}

Usage guidelines

When NetSpool starts, it starts LUs according to LU class. Therefore, specify the same LU class for all NetSpool LUs that you want to start at the same time.

luname

This single-valued attribute specifies the logical unit (LU) name that NetSpool uses to identify this printer. This name must be a unique LU name in the Printer Inventory.

ISPF field name

NetSpool LU name

Allowed values

A combination of 1-8 letters (a-z, A-Z), numbers (0-9), and special characters (# $ @). The first character cannot be numeric. Blanks and other special characters are not allowed. If the value contains special characters, enclose it in single or double quotation marks. Lowercase letters are converted to uppercase.

Default value

None.

Usage guidelines
  • This attribute is required for NetSpool to start a session with this printer.
  • The name must match the LU name specified in the ACBNAME field of the VTAM® APPL definition statement.

name

This single-valued attribute specifies the name of the printer definition.

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

Printer Definition Name

Allowed values

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

Default value

None.

printer-type

This single-valued attribute specifies the type of printer definition.

ISPF field name

None.

Allowed values

You can enter one of these fixed values:

general
A printer definition for printers that are neither IP PrintWay nor PSF types.
ip-printway
A printer definition for remote printers in your TCP/IP or SNA network to which IP PrintWay transmits data.
psf-mvs
A printer definition for AFP printers controlled by PSF.
Default value

The Infoprint Server ISPF panels display the printer definition as a General printer definition. Print Interface writes data to the output data set on the JES spool in records (general-spooling-mode=line).

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014