Setting environment variables for IP PrintWay (extended mode)

You can specify these environment variables in the aopstart EXEC or envar file:

_BPXK_SETIBMOPT_TRANSPORT

The job name that is associated with the z/OS® UNIX TCP/IP stack. For example, if the job name for the z/OS UNIX stack is TCPIPOE, specify _BPXK_SETIBMOPT_TRANSPORT=TCPIPOE. If you have only one TCP/IP stack in your installation, you do not need to specify this variable.

Tip for migrating from IP PrintWay basic: The name that you specify in the _BPXK_SETIBMOPT_TRANSPORT environment variable might not match the TCP/IP job name that is specified in the IP PrintWay basic mode FSS definition in the Printer Inventory or in the TCPIP.DATA data set. This is because IP PrintWay basic mode can run on any TCP/IP stack, while IP PrintWay extended mode must use the z/OS UNIX stack.

STEPLIB

The names of step libraries that are not in the system LNKLST. Separate library names with a colon. Specify:

• The library that contains optional IP PrintWay exits
• SYS1.IMAGELIB if you want IP PrintWay to use FCBs to format data with carriage controls
• Language Environment® runtime libraries (hlq.SCEERUN and hlq.SCEERUN2) and C++ runtime library (hlq.SCLBDLL)

Rule: Specify these step libraries in the file that is specified by the STEPLIBLIST statement in the BPXPRMxx PARMLIB member. See Updating the BPXPRMxx member of SYS1.PARMLIB (extended mode).

Default: None

Example: STEPLIB=SYS1.IMAGELIB:PW.EXITLIB

If dynamic configuration is not enabled, you can specify these variables in the aopstart EXEC:

AOP_ALLOW_ALL_CHARACTERS_IN_LINE_DATA

Determines how Infoprint Server detects the data format of documents that contain line data. Valid line data contains carriage control characters, table reference characters, binary zeroes, and printable characters. However, some applications might create line data that contains unprintable characters.

If this environment variable is set to YES, if line data contains unprintable characters, Infoprint Server detects the data format as "line data".

If this environment variable is not set, if line data contains unprintable characters, Infoprint Server detects the data format as "other". Line data that Infoprint Server detects as "other" might not print correctly because Infoprint Server does not convert it to the printer's code page.

Tips:

1. Job submitters can specify the data format in the document-format job attribute. For example, job submitters can specify document-format=line in the PRTATTRS parameter on the OUTPUT JCL statement. If the document-format job attribute is specified, Infoprint Server ignores this environment variable because it does not detect the data format.
2. Set this environment variable to YES if Infoprint Server does not detect the line data format and job submitters cannot specify the document-format=line job attribute.
3. This environment variable does not affect how NetSpool checks SCS and 3270 data streams for validity. The input SCS and 3270 data streams must contain only valid characters.

Rules:

1. If dynamic configuration is enabled, specify the equivalent allow-all-characters-in-line-data attribute in the system configuration definition.
2. If dynamic configuration is not enabled, specify this environment variable in the aopstart EXEC.

Default: The environment variable is not set.

Example: AOP_ALLOW_ALL_CHARACTERS_IN_LINE_DATA=YES

AOP_APPLID

The application program ID that IP PrintWay extended mode uses to establish a VTAM® session with printers. This ID must match the name of the APPL statement that is defined to VTAM in the SYS1.VTAMLST data set. This environment variable is required to use IP PrintWay extended mode to print on VTAM controlled printers.

Rules:

1. If you run IP PrintWay extended mode and dynamic configuration is enabled, specify the equivalent applid attribute in the system configuration definition.
2. If you run IP PrintWay extended mode and dynamic configuration is not enabled, specify this environment variable in the aopstart EXEC.
3. This environment variable does not apply to IP PrintWay basic mode.

Default: The environment variable is not set.

Example: AOP_APPLID=PWAPPL

AOP_BLANK_TRUNCATION_CLASSES

The list of JES output classes for which IP PrintWay extended mode removes blanks from the end of records or lines. 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. If this environment variable is not set, IP PrintWay does not remove any blank characters.

Value: One or more letters or numbers. Specify multiple letters and numbers with no separation. An asterisk (*) indicates all JES output classes. Lowercase letters are converted to uppercase.

Tips:

1. Specify this environment variable only if line or text data prints with extra blank characters at the end of lines.
2. This environment variable can slow performance and cause IP PrintWay to use more system resources.
3. Before JES gives data to IP PrintWay extended mode, JES always restores blanks that it truncated from data sets to save space on the JES spool. JES restores blanks regardless of how you set the JES2 BLNKTRNC and JES3 TRUNC parameters. Therefore, if you specify either BLNKTRNC=YES (JES2) or TRUNC=YES (JES3), you might need to specify this environment variable if your printed output contains unwanted blank characters. For example, if you specify BLNKTRNC=YES for output classes C and D, you can specify AOP_BLANK_TRUNCATION_CLASSES=CD to request that IP PrintWay extended mode remove trailing blank characters for output classes C and D. (BLNKTRNC=YES and TRUNC=YES are the JES defaults.)
   For information about specifying JES blank truncation, see one of these:

   • z/OS JES2 Initialization and Tuning Guide
   • z/OS JES3 Initialization and Tuning Guide

Rules:

1. If you run IP PrintWay extended mode and dynamic configuration is enabled, specify the equivalent blank-truncation-classes attribute in the system configuration definition.
2. If you run IP PrintWay extended mode and dynamic configuration is not enabled, specify this environment variable in the aopstart EXEC.
3. This environment variable does not apply to IP PrintWay basic mode.

Default: The environment variable is not set.

Example: AOP_BLANK_TRUNCATION_CLASSES=ABC123

AOP_IGNORE_DCF_ROUTING_ERRORS

If this environment variable is set to YES, IP PrintWay extended mode does not write an error message (AOP3201E) when it cannot find a printer definition in the Printer Inventory that matches the DEST, CLASS, and FORMS parameters that are specified on the OUTPUT (or DD) JCL statement for a print job. Also, it does not save information about the print job in the Printer Inventory.

If this environment variable is not set, IP PrintWay extended mode writes an error message (AOP3201I) when it cannot find a printer definition that matches the DEST, CLASS, and FORMS parameters. Also, it saves information about the print job in the Printer Inventory so that Infoprint Central can display the print job and the associated AOP3201E message.

Tips:

1. Set this environment variable to YES if your IP PrintWay job-selection rules cause IP PrintWay to select many jobs whose DEST, CLASS, and FORMS parameters do not match printer definitions in the Printer Inventory. (In this situation, message AOP3201E occurs numerous times in the common message log.) Setting this environment variable to YES can conserve storage and processing resources.
2. If you set this environment variable to YES, it might be difficult to determine that IP PrintWay did not process a print job because its CLASS, DEST, and FORMS parameters do not match a printer definition.
3. The text of message AOP3201E is:

   AOP3201E The DEST, CLASS, and FORMS JCL keywords do not match a
            printer definition in the Printer Inventory.

Rules:

1. If you run IP PrintWay extended mode and dynamic configuration is enabled, specify the equivalent ignore-dcf-routing-errors attribute in the system configuration definition.
2. If you run IP PrintWay extended mode and dynamic configuration is not enabled, specify this environment variable in the aopstart EXEC.
3. This environment variable does not apply to IP PrintWay basic mode.

Default: The environment variable is not set.

Example: AOP_IGNORE_DCF_ROUTING_ERRORS=YES

AOP_MAIL_DO_NOT_ADD_SUFFIX

If this environment variable is set to YES, IP PrintWay does not append a suffix to any file names specified in the MAILFILE JCL parameter or the mail-file-name job attribute.

If this environment variable is not set, IP PrintWay appends one of these suffixes for the data formats it recognizes: afp, jpg, pcl, pdf, ps, sap, tif, txt, or octet-stream (for unrecognized data formats).

Tip: If the AOP_MAIL_DO_NOT_ADD_SUFFIX environment variable is set to YES, IP PrintWay ignores the AOP_MAIL_PRESERVE_SUFFIXES environment variable.

Rules:

1. If you run IP PrintWay extended mode and dynamic configuration is enabled, specify the equivalent mail-do-not-add-suffixes attribute in the system configuration definition.
2. If you run IP PrintWay extended mode and dynamic configuration is not enabled, specify this environment variable in the aopstart EXEC.
3. If you run IP PrintWay basic mode, specify this environment variable in the IP PrintWay basic mode startup procedure.

Default: The environment variable is not set.

Example: AOP_MAIL_DO_NOT_ADD_SUFFIX=YES

AOP_MAIL_PRESERVE_SUFFIXES

The list of suffixes that IP PrintWay preserves in file names that are specified in the MAILFILE JCL parameter or in the mail-file-name job attribute. If the file name ends with one of the suffixes in this list, IP PrintWay does not append another suffix to the file name.

If no file name is specified in MAILFILE or mail-file-name, or if the suffix of the file name does not match a suffix in this environment variable, IP PrintWay appends one of these suffixes for the data formats it recognizes: afp, jpg, pcl, pdf, ps, sap, tif, txt, or octet-stream (for unrecognized data formats).

Tips:

1. Specify the suffixes that users might specify in file names. For example, you might specify the .doc suffix for Microsoft Word documents.
2. If the AOP_MAIL_DO_NOT_ADD_SUFFIX environment variable is set to YES, IP PrintWay ignores the AOP_MAIL_PRESERVE_SUFFIXES environment variable.

Rules:

1. Begin each suffix with a period.
2. To specify more than one suffix, separate the suffixes with a blank. Do not enclose the list of suffixes in single or double quotation marks.
3. If you run IP PrintWay extended mode and dynamic configuration is enabled, specify the equivalent mail-preserve-suffixes attribute in the system configuration definition.
4. If you run IP PrintWay extended mode and dynamic configuration is not enabled, specify this environment variable in the aopstart EXEC.
5. If you run IP PrintWay basic mode, specify this environment variable in the IP PrintWay startup procedure.

Default: The environment variable is not set.

Example: c

AOP_MAIL_USE_FIRST_ADDRESS

Specifies the email addresses that IP PrintWay extended mode uses when a print job (output group) contains more than one document (data set).

Values:

YES

IP PrintWay sends each document to the email address or addresses that are specified for the first document in the print job.

NO

IP PrintWay sends each document to the email address or addresses that are specified for the document.

Tips:

1. AOP_MAIL_USE_FIRST_ADDRESS has no effect if the Concatenate job option is selected in the Dataset grouping field in the printer definition, or if the Automatic dataset grouping field is selected in the printer definition. When either concatenation option is selected, IP PrintWay extended mode sends all documents in a print job in one email to the email address or addresses that are specified for the first document in the print job.
2. IP PrintWay basic mode ignores this environment variable. IP PrintWay basic mode always sends each document to the email address or addresses that are specified for the document unless the Concatenate job option is selected in the Dataset grouping field in the printer definition.

Rules:

1. If you run IP PrintWay extended mode and dynamic configuration is enabled, specify the equivalent mail-use-first-address attribute in the system configuration definition.
2. If you run IP PrintWay extended mode and dynamic configuration is not enabled, specify this environment variable in the aopstart EXEC.
3. This environment variable does not apply to IP PrintWay basic mode.

Default: YES

Example: AOP_MAIL_USE_FIRST_ADDRESS=NO

AOP_SELECT_WORK_FROM_HOLD_QUEUE

Indicates whether IP PrintWay extended mode selects new held output groups from the JES spool.

Values:

YES

IP PrintWay extended mode selects new held output groups from the JES spool. You can use Infoprint Central to move the held output groups to different IP PrintWay printers before you release them.

NO

IP PrintWay extended mode does not select new held output groups from the JES spool. You can use JES or SDSF commands to release individual data sets in an output group for printing.

Rules:

1. If you run IP PrintWay extended mode and dynamic configuration is enabled, specify the equivalent select-work-from-hold-queue attribute in the system configuration definition.
2. If you run IP PrintWay extended mode and dynamic configuration is not enabled, specify this environment variable in the aopstart EXEC.
3. This environment variable does not apply to IP PrintWay basic mode.

Default: YES

Example: AOP_SELECT_WORK_FROM_HOLD_QUEUE = NO

AOP_SUPPRESS_POST_UNIX_FILTER_FORMATTING

Indicates whether IP PrintWay extended mode formats line or text data after a UNIX filter processes it. If this environment variable is set to any value, IP PrintWay extended mode does not format data when all these conditions are met:

• The data set to be processed contains either line data or text data.
• A UNIX filter is specified in the printer definition for the data format.
• The PAGEDEF or FORMDEF parameter is specified on the OUTPUT JCL statement for the data set. (A page or form definition that is specified in the printer definition does not meet this criterion.)

If this environment variable is not set, IP PrintWay extended mode always formats line or 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.

Tips:

1. Specify this environment variable if you use a UNIX filter that calls an AFP transform to convert line data to PCL, PDF, or PostScript format.
2. This environment variable does not affect how IP PrintWay extended mode processes data when you specify a DLL filter in the printer definition. IP PrintWay extended mode does not modify data that is returned by DLL filters.

Rules:

1. If you run IP PrintWay extended mode and dynamic configuration is enabled, specify the equivalent suppress-post-unix-filter-formatting attribute in the system configuration definition.
2. If you run IP PrintWay extended mode and dynamic configuration is not enabled, specify this environment variable in the aopstart EXEC.
3. This environment variable does not apply to IP PrintWay basic mode.

Default: IP PrintWay extended mode formats line or text data after a UNIX filter processes it.

Example:

AOP_SUPPRESS_POST_UNIX_FILTER_FORMATTING=YES

AOPMAILER

The full path name of the z/OS UNIX sendmail command that IP PrintWay uses to send output to email destinations. This environment variable is optional. However, you must set it if you did not install the sendmail executable file in the default /bin directory.

Rules:

1. Start the path name with a slash (/).
2. If you run IP PrintWay extended mode and dynamic configuration is enabled, specify the equivalent mailer-path-name attribute in the system configuration definition.
3. If you run IP PrintWay extended mode and dynamic configuration is not enabled, specify this environment variable in the aopstart EXEC.
4. If you run IP PrintWay basic mode, specify this environment variable in the IP PrintWay basic mode startup procedure.

Default: /bin/sendmail

Example: AOPMAILER=/mydirectory/sendmail

AOPMAILER_OPTIONS

Options for the z/OS UNIX sendmail command. IP PrintWay specifies these options in addition to the -i option when it sends emails. You can specify this environment variable regardless of whether you specify the AOPMAILER environment variable. This environment variable is optional.

Rules:

1. If you run IP PrintWay extended mode and dynamic configuration is enabled, specify the equivalent mailer-options attribute in the system configuration definition.
2. If you run IP PrintWay extended mode and dynamic configuration is not enabled, specify this environment variable in the aopstart EXEC.
3. If you run IP PrintWay basic mode, specify this environment variable in the IP PrintWay basic mode startup procedure.

Default: The environment variable is not set.

Example: AOPMAILER_OPTIONS=-Am

IP PrintWay extended mode also uses the LANG, LIBPATH, NLSPATH, and PATH environment variables.

/*-------------------------------------------------------------------
/* The following environment variables are examples of other variable
/* which may need to be set for your installation.                   
/*-------------------------------------------------------------------
n=n+1;env.n='STEPLIB=SYS1.IMAGELIB:hlq.EXITLIB'