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


Attributes for the configuration object class

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

Attributes for the configuration object class

This section lists the attributes that are valid in the system configuration definition, which is in object class configuration.

Infoprint Server automatically creates the system configuration definition in the configuration class. You cannot create or delete it. If dynamic configuration is enabled, you can use the PIDU modify command to modify attributes in the system configuration definition.

The name of the system configuration definition is always aopd.conf. You cannot rename it.

If you add or modify an attribute in the system configuration definition, with a few exceptions, the new value takes effect immediately or when Infoprint Server processes the next print job; you do not need to restart Infoprint Server. For information about whether you need to restart any Infoprint Server daemons, see the description of each attribute.

For information about how to enable dynamic configuration, see z/OS Infoprint Server Customization.

Required attributes

The configuration-version attribute is the only required attribute.

allow-all-characters-in-line-data

This single-valued attribute indicates whether Infoprint Server considers all characters in data, including unprintable characters, to be line data.

Note:
ISPF field name

Allow all characters in line data

Allowed values

You can specify one of these fixed values:

yes
Infoprint Server accepts all characters in data, including unprintable characters, as line data.
no
If line data contains unprintable characters, Infoprint Server does not consider the data to be line data.
Default value

no

Usage guidelines
  • If a job submitter specifies the data format with the document-format attribute, Infoprint Server ignores this field.
  • If you change this attribute, you do not need to restart Infoprint Server.
  • This attribute does not apply to IP PrintWay basic mode.

aophinvd-max-thread-tasks

This single-valued attribute specifies the MAXTHREADTASKS limit for the Historical Inventory daemon, aophinvd. The MAXTHREADTASKS limit is the maximum number of MVS tasks that a single process (daemon) can have concurrently active.

Note:
ISPF field name

Other

Allowed values

A number from 0 to 65535.

Default value

200

Usage guidelines

If you change this attribute, stop all Infoprint Server daemons and restart Infoprint Server.

aopippd-max-thread-tasks

This single-valued attribute specifies the MAXTHREADTASKS limit for the Internet Printing Protocol (IPP) daemon, aopippdxp. The MAXTHREADTASKS limit is the maximum number of MVS tasks that a single process (daemon) can have concurrently active.

Note:
ISPF field name

Other

Allowed values

A number from 0 to 65535.

Default value

200

Usage guidelines

If you change this attribute, stop aopippdxp and restart Infoprint Server.

aoplpd-max-thread-tasks

This single-valued attribute specifies the MAXTHREADTASKS limit for the Infoprint Server LPD, aoplpd. The MAXTHREADTASKS limit is the maximum number of MVS tasks that a single process (daemon) can have concurrently active.

Note:
ISPF field name

Other

Allowed values

A number from 0 to 65535.

Default value

200

Usage guidelines

If you change this attribute, stop aoplpd and restart Infoprint Server.

aopnetd-max-thread-tasks

This single-valued attribute specifies the MAXTHREADTASKS limit for the NetSpool daemon, aopnetd. The MAXTHREADTASKS limit is the maximum number of MVS tasks that a single process (daemon) can have concurrently active.

Note:
ISPF field name

Other

Allowed values

A number from 0 to 65535.

Default value

200

Usage guidelines

If you change this attribute, stop aopnetd and restart Infoprint Server.

aopoutd-max-thread-tasks

This single-valued attribute specifies the MAXTHREADTASKS limit for the IP PrintWay extended mode daemon aopoutd. The MAXTHREADTASKS limit is the maximum number of MVS tasks that a single process (daemon) can have concurrently active.

Note:
ISPF field name

Other

Allowed values

A number from 0 to 65535.

Default value

200

Usage guidelines

If you change this attribute, stop aopoutd and restart Infoprint Server.

aopsdbd-max-thread-tasks

This single-valued attribute specifies the MAXTHREADTASKS limit for the search database daemon, aopsdbd. The MAXTHREADTASKS limit is the maximum number of MVS tasks that a single process (daemon) can have concurrently active.

Note:
ISPF field name

Other

Allowed values

A number from 0 to 65535.

Default value

200

Usage guidelines

If you change this attribute, stop all Infoprint Server daemons and restart Infoprint Server.

aopsubd-max-thread-tasks

This single-valued attribute specifies the MAXTHREADTASKS limit for the Print Interface subsystem daemon, aopsubd. The MAXTHREADTASKS limit is the maximum number of MVS tasks that a single process (daemon) can have concurrently active.

Note:
ISPF field name

Other

Allowed values

A number from 0 to 65535.

Default value

200

Usage guidelines

If you change this attribute, stop aopsubd and restart Infoprint Server.

aopssid-max-thread-tasks

This single-valued attribute specifies the MAXTHREADTASKS limit for the Infoprint Central daemon, aopssid. The MAXTHREADTASKS limit is the maximum number of MVS tasks that a single process (daemon) can have concurrently active.

Note:
ISPF field name

Other

Allowed values

A number from 0 to 65535.

Default value

200

Usage guidelines

If you change this attribute, stop aopssid and restart Infoprint Server.

aopwsmd-max-thread-tasks

This single-valued attribute specifies the MAXTHREADTASKS limit for the IP PrintWay extended mode daemon aopwsmd. The MAXTHREADTASKS limit is the maximum number of MVS tasks that a single process (daemon) can have concurrently active.

Note:
ISPF field name

Other

Allowed values

A number from 0 to 65535.

Default value

200

Usage guidelines

If you change this attribute, stop aopwsmd and restart Infoprint Server.

applid

This single-valued attribute specifies the name of the application program that IP PrintWay extended mode uses to establish a VTAM session with VTAM-controlled printers.

Note:
ISPF field name

APPL ID

Allowed values

This name must match the name of the APPL statement defined to VTAM in the SYS1.VTAMLST data set.

Default value

None.

Usage guidelines
  • If you change this attribute, you do not need to restart Infoprint Server.
  • This attribute does not apply to IP PrintWay basic mode. If you run IP PrintWay basic mode, specify the equivalent APPLID environment variable in the IP PrintWay basic mode startup procedure.

ascii-codepage

This single-valued attribute specifies the name of the Infoprint Server default ASCII code page. You can specify an IBM-supplied or custom ASCII code page.

Note:
ISPF field name

ASCII

Allowed values

A combination of 1-16 letters, numbers, and special characters. Blanks are not allowed.

Default value

ISO8859-1

Usage guidelines

If you change this attribute, you do not need to restart Infoprint Server.

blank-truncation-classes

This single-valued attribute specifies the JES output classes for which IP PrintWay extended mode removes trailing blank characters. If a data set is allocated in one of the listed classes, and the data set contains either line data or text data, IP PrintWay removes any blank characters that occur at the end of each record or line.

Note:
ISPF field name

Blank truncation classes

Allowed values

One to 36 one-character letters or numbers, or an asterisk (*) which indicates all JES output classes. Lowercase letters are converted to uppercase. For example:

blank-truncation-classes = ABC123
Default value

None.

Usage guidelines
  • This attribute can slow performance and cause IP PrintWay to use more system resources.
  • If you change this attribute, you do not need to restart Infoprint Server.

configuration-version

This single-valued attribute is the version number of the system configuration definition.

ISPF field name

This attribute is not displayed on the ISPF panel.

Allowed values

The only allowed value is v1.

Default value

None.

Usage guidelines

When Infoprint Server creates the system configuration definition, it sets this attribute to the correct version level. Do not specify this attribute.

console-name

This single-valued attribute specifies the name of the extended multiple console support (MCS) console that Infoprint Central uses to send commands to the z/OS® system.

Note:
ISPF field name

Extended MCS console name

Allowed values

A combination of 2-8 letters, numbers, and national characters ($, #, and @). The first character cannot be numeric, and blanks are not allowed.

Default value

The default console name is the Printer Inventory name followed by the last four characters of the system name. For example:

AOP1DEVI
Usage guidelines
  • Do not use the reserved names: HC, INSTREAM, INTERNAL, OPERLOG, SYSIOSRS, SYSLOG, UNKNOWN.
  • If the start-daemons = ssid attribute is specified in the Infoprint Server configuration file (aopd.conf), the console name must be unique among all active and inactive console names on all systems in a sysplex. To display all consoles, use this MVS™ command: DISPLAY EMCS,ST=L
  • If you change the console name while the Infoprint Central daemon (aopssid) is running, stop the aopssid daemon and restart Infoprint Server.

ebcdic-codepage

This single-valued attribute specifies the name of the Infoprint Server default EBCDIC code page. You can specify an IBM-supplied or custom EBCDIC code page.

Note:
ISPF field name

EBCDIC

Allowed values

A combination of 1-16 letters, numbers, and special characters. Blanks are not allowed.

Default value

IBM-1047

Usage guidelines

If you change this attribute, you do not need to restart Infoprint Server.

hardcopy-messages

This single-valued attribute specifies the additional messages that you want Infoprint Server to send to the hardcopy log.

Note:
ISPF field name

Send messages to hardcopy log

Allowed values

You can specify one of these fixed values:

all
Send all eligible messages to the hardcopy log.
list
Send only the additional messages listed in the hardcopy-message-list attribute to the hardcopy log.
none
Send no additional messages, except console messages, to the hardcopy log.
Default value

none

Usage guidelines

If you change this attribute, you do not need to restart Infoprint Server.

hardcopy-message-list

This multi-valued, list attribute specifies the messages to send to the hardcopy log when the hardcopy-messages = list attribute is specified.

Note:
ISPF field name

Message list for hardcopy log

Allowed values

You can specify 1-72 message IDs. Each message ID can be a combination of 7-8 letters (a-z, A-Z) and numbers (0-9); the last character must be the severity code (E, I, S, T, or W). You can use uppercase characters, lowercase characters, or both. If you specify more than one message ID, separate them with spaces and enclose the list in braces. For example:

hardcopy-message-list = {AOP3614I AOP3803E}
Default value

None.

Usage guidelines
  • You do not need to specify messages that Infoprint Server sends to the console, such as those with the API prefix, because they are automatically sent to the hardcopy log.
  • If your installation uses the MPFLSTxx PARMLIB member for message automation, you might want to specify the same message IDs in MPFLSTxx.
  • If you change this attribute, you do not need to restart Infoprint Server.

ignore-dcf-routing-errors

This single-valued attribute indicates whether IP PrintWay extended mode writes an error message when it cannot find a printer definition in the Printer Inventory that matches the specified DEST, CLASS, and FORMS JCL parameters.

Note:
ISPF field name

Ignore DEST, CLASS, FORMS routing errors

Allowed values

You can specify one of these fixed values:

yes
IP PrintWay ignores CLASS, DEST, and FORM routing errors and does not write an error message.
no
IP PrintWay writes error message AOP3201E when it cannot find a printer definition that matches the DEST, CLASS, and FORMS parameters. IP PrintWay also saves information about the print job in the Printer Inventory.
Default value

no

Usage guidelines
  • Specify yes to conserve storage and processing resources if IP PrintWay writes message AOP3201E numerous times in the common message log. Keep in mind that without the message, it might be difficult to determine why IP PrintWay did not process a print job.
  • If you change this attribute, you do not need to restart Infoprint Server.
  • This attribute does not apply to IP PrintWay basic mode.

ipp-port-number

This single-valued attribute specifies the number of the port at which the Infoprint Server Internet Printing Protocol (IPP) Server waits for print requests.

Note:
ISPF field name

IPP port number

Allowed values

A number from 1 to 65535.

Default value

631, a well-known port for communication between IPP clients and servers.

Usage guidelines
  • Make sure that the port is not used by any other service on the same TCP/IP stack.
  • If you change this attribute, you do not need to restart Infoprint Server.

job-prefix

This single-valued attribute specifies the prefix of the job IDs for output data sets that Infoprint Server creates on the JES spool. For example, if the prefix is PS, the job ID might be PS001234.

Note:
ISPF field name

Job ID prefix

Allowed values

A combination of two letters, numbers, and national characters ($, #, and @). The first character cannot be numeric.

Default value

PS

Usage guidelines

If you change this attribute, you do not need to restart Infoprint Server.

log-retention

This single-valued attribute specifies the number of days worth of messages that Infoprint Central displays for print jobs and printers, and the number of days for which Infoprint Central displays print jobs after they are removed from the JES spool.

In addition, if you do not use the MVS system logger (logstream-name attribute is not specified), the value in this attribute is the number of days worth of messages that Infoprint Server retains in the common message log. If you use the MVS system logger, the retention period for the system logger log stream is used instead.

Note:
ISPF field name

Log retention period (days)

Allowed values

A number from 0 to 59.

Default value

1

Usage guidelines
  • Specify a value greater than 0, or use the default value of 1 day, if either of these conditions apply:
    • You do not use the MVS system logger for Infoprint Server messages
    • You use Infoprint Central to work with print jobs and printers
  • Make sure that the file system mounted at the /var or /var/Printsrv mount point has enough space to contain information about print jobs for the number of days specified in this attribute. If you do not use the MVS system logger, also make sure that there is enough space for messages.
  • If you change this attribute, you do not need to restart Infoprint Server.
  • If PSF for z/OS, V4R4, writes messages in the common message log and you change the number of days to 0 or from 0, you must restart the PSF functional subsystem (FSS) for the change to take effect.

logstream-name

This single-valued attribute specifies the name of a log stream that is defined to the MVS system logger for Infoprint Server messages.

Note:
ISPF field name

Log stream name

Allowed values

A 1-26 character log stream name consisting of one or more qualifiers. Each qualifier can contain a combination of 1-8 letters (a-z, A-Z), numbers (0-9), and national characters ($, #, and @). The first character of each qualifier cannot be a number. Each qualifier must be separated by a period. Lowercase letters are converted to uppercase. For example:

logstream-name = AOP.MSG
Default value

If this attribute is not specified, Infoprint Server does not use the system logger for messages. It writes messages in the /var/Printsrv file system instead.

Usage guidelines
  • To view messages that Infoprint Server writes either in the specified log stream or in a z/OS file system, use the aoplogu command. For information, see Viewing messages in the common message log.
  • If you change this attribute, you do not need to restart Infoprint Server.

lpd-port-number

This single-valued attribute specifies the number of the port at which the Infoprint Server line printer daemon (LPD) waits for print requests.

Note:
ISPF field name

LPD port number

Allowed values

A number from 1 to 65535.

Default value

515, a well-known port for communication between LPDs and line printer requesters (LPRs).

Usage guidelines
  • Make sure that the port is not used by any other service on the same TCP/IP stack.
  • The port number must not be reserved in the hlq.PROFILE.TCPIP data set.
  • If you specify a port other than 515, some limitations exist.
  • Users specify this port number when they configure the Infoprint Port Monitor for Windows.
  • If you change this attribute, you do not need to restart Infoprint Server.

mail-do-not-add-suffixes

This single-valued attribute indicates whether IP PrintWay extended mode appends a suffix to file names specified in the MAILFILE JCL parameter or the mail-file-name job attribute.

Note:
ISPF field name

Do not add suffixes to files

Allowed values

You can specify one of these fixed values:

yes
IP PrintWay does not append suffixes to the file names.
no
IP PrintWay appends one of these suffixes to file names for the data formats it recognizes: afp, jpg, pcl, pdf, ps, sap, tif, txt, or octet-stream (for unrecognized data formats).
Default value

no

Usage guidelines
  • If mail-do-not-add-suffixes=yes, IP PrintWay ignores the mail-preserve-suffixes attribute.
  • If you change this attribute, you do not need to restart Infoprint Server.
  • This attribute does not apply to IP PrintWay basic mode. If you run basic mode, specify the equivalent AOP_DO_NOT_ADD_SUFFIX environment variable in the IP PrintWay basic mode startup procedure.

mail-preserve-suffixes

This single-valued attribute specifies the suffixes that IP PrintWay extended mode preserves in file names specified in the MAILFILE JCL parameter or in the mail-file-name job attribute. IP PrintWay does not append another suffix to file names with preserved suffixes.

Note:
ISPF field name

Preserve suffixes

Allowed values

A list of 1-50 suffixes. Each suffix can contain 1-10 characters and must start with a period. If you specify more than one suffix, separate the suffixes with spaces and enclose the entire value in single or double quotation marks. For example:

mail-preserve-suffixes = ".123 .xls .doc"
Default value

None.

Usage guidelines
  • If mail-do-not-add-suffixes=yes, IP PrintWay ignores the mail-preserve-suffixes attribute.
  • If you change this attribute, you do not need to restart Infoprint Server.
  • This attribute does not apply to IP PrintWay basic mode. If you run basic mode, specify the equivalent AOP_MAIL_PRESERVE_SUFFIXES environment variable in the IP PrintWay basic mode startup procedure.

mail-use-first-address

This single-valued attribute indicates whether IP PrintWay extended mode sends each document to the email address or addresses specified for the first document in the print job. This attribute applies only when the print job contains more than one document.

Note:
ISPF field name

Send email to address of first document

Allowed values

You can specify one of these fixed values:

yes
IP PrintWay sends each document to the email addresses specified for the first document in the print job. This is the default.
no
IP PrintWay sends each document to the email addresses specified for that document.
Default value

yes

Usage guidelines
  • When the printer definition specifies a concatenation option, IP PrintWay always uses one email to send all documents in a print job to the email address or addresses that are specified for the first document in the print job whether or not this attribute is specified.
  • If you change this attribute, you do not need to restart Infoprint Server.
  • This attribute does not apply to IP PrintWay basic mode.

mailer-options

This single-valued attribute specifies options for the z/OS UNIX sendmail command. IP PrintWay extended mode specifies these options in addition to the -i option when it sends emails.

Note:
ISPF field name

Application options

Allowed values

Valid sendmail options. If you specify more than one option, separate the options with spaces and enclose the entire value in single or double quotation marks. For example:

mailer-options = -Am
Default value

None.

Usage guidelines
  • If you change this attribute, you do not need to restart Infoprint Server.
  • This attribute does not apply to IP PrintWay basic mode. If you run IP PrintWay basic mode, specify the equivalent AOPMAILER_OPTIONS environment variable in the IP PrintWay basic mode startup procedure.

mailer-path-name

This single-valued attribute specifies the full path name of the z/OS UNIX sendmail command that IP PrintWay extended mode uses to send output to email destinations. The path name is case-sensitive.

Note:
ISPF field name

Application path

Allowed values

A valid path name. The path name must start with a slash (/).

Default value

/bin/sendmail

Usage guidelines
  • If you change this attribute, you do not need to restart Infoprint Server.
  • This attribute does not apply to IP PrintWay basic mode. If you run IP PrintWay basic mode, specify the equivalent AOPMAILER environment variable in the IP PrintWay basic mode startup procedure.

max-historical-inventory-size

This single-valued attribute specifies the maximum size in megabytes (MBs) of the Historical Inventory in the /var/Printsrv/hinv directory. The Historical Inventory contains information about print jobs and documents that are no longer on the JES spool. When the maximum size is reached, Infoprint Server overwrites the oldest historical information.

Note:
ISPF field name

Maximum Historical Inventory size

Allowed values

A number from 0 to 99999. A value of 0 means that Infoprint Server does not limit the size of the Historical Inventory. However, the number of days specified in the log-retention attribute limits the amount of information in the Historical Inventory.

Default value

10

Usage guidelines

If you change this attribute, you do not need to restart Infoprint Server.

max-thread-tasks

This single-valued attribute specifies the MAXTHREADTASKS limit for these Infoprint Server daemons: aophinvd, aopippdxpd, aopnetd, aopoutd, aopsdbd, aopssid, aopsubd, and aopwsmd. The MAXTHREADTASKS limit is the maximum number of MVS tasks that a single process (daemon) can have concurrently active.

Note:
ISPF field name

Other

Allowed values

A number from 0 to 65535.

Default value

200

Usage guidelines

If you change this attribute, stop all Infoprint Server daemons and restart Infoprint Server.

name

This single-valued attribute specifies the name of the system configuration definition. The name of the system configuration definition is always aopd.conf. You cannot change it.

Note:
This is a non-settable attribute. Do not specify the name attribute on the PIDU 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

This attribute is not displayed on the ISPF panel.

Allowed values

aopd.conf

Default value

None.

netspool-use-fixed-jobid

This single-valued attribute whether NetSpool assigns the same job ID to all output data sets that it creates on the JES spool.

Note:
ISPF field name

Other

Allowed values

You can specify one of these fixed values:

yes
NetSpool assigns the same job ID to all output data sets. The job ID is the value specified in the job-prefix attribute, which defaults to PS, followed by 000000. For example, PS000000.
no
NetSpool assigns a unique job ID to each data set.
Default value

no

Usage guidelines

If you change this attribute while NetSpool is running, stop the NetSpool daemon (aopnetd) and restart Infoprint Server.

netspool-use-unaltered-jobid

This single-valued attribute indicates whether NetSpool assigns a job ID to output data sets that it creates on the JES spool.

Note:
ISPF field name

Other

Allowed values

You can specify one of these fixed values:

yes
NetSpool does not assign a job ID to the output data sets. The job ID for each data set is the same as the job ID of the aopnetd daemon.
no
NetSpool assigns a job ID to each data set.
Default value

no

Usage guidelines

If you change this attribute while NetSpool is running, stop the NetSpool daemon (aopnetd) and restart Infoprint Server.

select-work-from-hold-queue

This single-valued attribute indicates whether IP PrintWay extended mode selects new held output groups from the JES spool.

Note:
ISPF field name

Select work from hold queue

Allowed values

You can specify one of these fixed values:

yes
IP PrintWay selects new held output groups from the JES spool. This lets you use Infoprint Central to move the held output groups to different IP PrintWay printers before releasing them.
no
IP PrintWay does not select new held output groups from the JES spool. This lets you use JES or SDSF commands to release individual data sets in an output group for printing.
Default value

yes

Usage guidelines
  • If you change this attribute while IP PrintWay is running, stop the IP PrintWay daemons (aopoutd and aopwsmd) and restart Infoprint Server.
  • This attribute does not apply to IP PrintWay basic mode.

smf-recording

This single-valued attribute indicates whether IP PrintWay™ extended mode writes System Management Facilities (SMF) type 6 records for data sets that it sends to a printer or email destination. SMF type 6 records contain accounting information.

Note:
ISPF field name

Write SMF records

Allowed values

You can specify one of these fixed values:

yes
IP PrintWay writes SMF type 6 records.
no
IP PrintWay does not write SMF type 6 records.
Default value

yes

Usage guidelines
  • If you change this attribute, you do not need to restart Infoprint Server.
  • This attribute does not apply to IP PrintWay basic mode.

snmp-community

This single-valued attribute specifies the name assigned to the Simple Network Management Protocol (SNMP) community for making SNMP requests to the z/OS system.

Note:
ISPF field name

Community name

Allowed values

A combination of 1-32 uppercase or lowercase letters, numbers, and special characters. This value is case-sensitive.

Default value

public

Usage guidelines
  • This name must exactly match the community name provided to the z/OS SNMP agent and also the community name defined to the SNMP manager.
  • The z/OS agent and the SNMP manager might restrict the length of the community name or the allowed characters.
  • This attribute applies only if you use the Infoprint Server SNMP subagent.
  • If you change this attribute while the Infoprint Server SNMP subagent daemon (aopsnmpd) is running, stop aopsnmpd and restart Infoprint Server.

suppress-post-unix-filter-formatting

This single-valued attribute indicates whether IP PrintWay extended mode formats line and text data after a UNIX filter processes it

Note:
ISPF field name

Suppress formatting after UNIX filter

Allowed values

You can specify one of these fixed values:

yes
IP PrintWay does not format line and text data after a UNIX filter processes it.
no
IP PrintWay always formats line and text data after a UNIX filter processes it. For example, IP PrintWay processes carriage control characters and transparent data characters, and converts the data from the document code page to the printer code page.
Default value

no

Usage guidelines
  • Specify yes if you use a UNIX filter that calls an AFP transform to convert line data to PCL, PDF, or PostScript format.
  • If you change this attribute, you do not need to restart Infoprint Server.
  • This attribute does not apply to IP PrintWay basic mode.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014