Environment variables for the AFP to PostScript transform

You can optionally specify the following environment variables.

_BPX_JOBNAME

The job name for this transform. When you assign a different job name to each class of transform, the operator can manage the transform daemons more effectively. Specify a job name of 1 to 8 alphanumeric characters. Incorrect job names are ignored. For more information about the _BPX_JOBNAME variable, see z/OS UNIX System Services Planning.

Default: The job name is AOPXFD.

Example: environment={_BPX_JOBNAME –> afpxpsD}

AOP_ASSUME_RIDIC_UNPAD

Indicates whether all G4 MMR (Modified Modified READ (ITU-TSS T.6 Group 4 two-dimensional coding standard for facsimile)) images are unpadded RIDIC. In some IOCA images the RECID incorrectly states that the encoding is RIDIC when it is actually unpadded RIDIC. If the RECID for the G4 MMR image specifies RIDIC, but the width of the image is not padded with zeros, set AOP_ASSUME_RIDIC_UNPAD-> yes.

Valid values are:

yes

Ignore the G4 MMR RECID setting and process all G4 MMR images as unpadded.

no

Decode G4 MMR images as specified in the RECID.

Default: AOP_ASSUME_RIDIC_UNPAD –> no

Example: environment={AOP_ASSUME_RIDIC_UNPAD –> yes}

AOP_CHARS

The default coded font. The transforms use this font to format error messages unless the page definition specified in the AOP_MSGPAGEDEF variable names a font. The transforms also use this font for (1) line data when no other font is specified in the page definition used to print the document and (2) AFP data when no other font is specified in the AFP data stream.

If this environment variable is not specified, the default font is X060D9. The default font you specify, or font X060D9, must exist in one of the AFP font libraries so that the transform can write error messages in the output.

Specify the 1 to 4 character coded font name. You can specify the X0 or XZ prefix of the coded font name. If you do not specify a prefix, the transform adds an X0 prefix. Some coded fonts have 6-character names, not counting the X0 or XZ prefix. For these fonts, use the 4-character alternate coded font name. For font names and alternate font names, see z/OS Font Collection.

Rules:

1. Specify only one default coded font in this environment variable.
2. The font you specify, or default font X060D9, must exist in one of the AFP font libraries so that the transform can write error messages in the output. The coded font member for a raster font, for example X060D9, must exist in an AFP font library specified to the transform.
3. The code page associated with this coded font must be an EBCDIC code page.

Tips:

1. You might want to specify the same font as the resident font in the AFP printer to which output is typically printed.
2. Specify an outline font because outline fonts provide higher quality output for printing and viewing.

Default: AOP_CHARS –> 60d9 (This is font X060D9 because the transform adds prefix X0.)

Example: environment={AOP_CHARS –> 60d8}

AOP_COLOR

Indicates whether the transform is to produce color output. The transform supports the MO:DCA OCA color commands. Specify yes if the printer supports color. Valid values are:

yes

The transform produces color output.

no

The transform does color simulation.

Default: AOP_COLOR –> no

Example: environment={AOP_COLOR –> yes}

AOP_CUTSHEET

Indicates whether the transform is to prepare the output for printing on a cutsheet printer. Valid values are:

yes

The output is to be printed on a cutsheet printer. Therefore, the transform uses the cutsheet and N_UP specifications in the form definition to determine whether to send medium orientation information to the printer. For more information, see the CUTSHEET and N_UP commands in Page Printer Formatting Aid: User's Guide.

Tip: Select this option if your output is incorrectly printing in the down direction on a cutsheet printer.

no

The output is not to be printed on a cutsheet printer. Therefore, the transform always sends medium orientation information to the printer.

Table 1 shows how the value of the AOP_CUTSHEET environment variable and values set in the form definition determine the orientation of the output. The shaded row is the only scenario where the orientation specified in the form definition results in a different output orientation.

Default: AOP_CUTSHEET –> no

Example: environment={AOP_CUTSHEET –> yes}

AOP_EMBED_OUTLINES

Indicates whether the transform includes outline fonts in the PostScript output. Valid values are:

yes

The transform includes outline fonts in the PostScript output. This option provides improved output fidelity; however, each typeface increases the size of the PostScript output file by approximately 175 KB.

no

The transform converts outline fonts to equivalent raster fonts and includes them in the PostScript data stream. This option produces smaller output files than when outline fonts are included in the PostScript output.

Default: AOP_EMBED_OUTLINES –> yes

Example: environment={AOP_EMBED_OUTLINES –> no}

AOP_FAIL_ON_ERROR

Specifies whether the transform stops processing when a warning or data stream error occurs during the transform. Warnings can indicate degraded output.

Valid values are:

error

The transform fails when a data stream error occurs and does not create an output document. However, the transform continues if warnings occur. This is the default.

no

The transform attempts to continue processing and create an output document when a warning or data stream error occurs.

warning

The transform fails when a warning or data stream error occurs and does not create an output document.

Tips:

1. The fail-on-transform-error job attribute and the Fail on error field in the printer definition override this value.
2. You can specify the value using lowercase or uppercase letters (for example, no or NO).
3. The Fail on error printer definition attribute can also be set using the ISPF panel in the processing section.

Default: AOP_FAIL_ON_ERROR –> error

Example: environment={AOP_FAIL_ON_ERROR –> no}

AOP_FAIL_ON_IMAGE_ERROR

Indicates whether the transform continues to process the document when the transform cannot decode an IOCA image because of certain compression padding errors. Some compression algorithms cause unpadded RIDIC images to be read as padded RIDIC by the transform.

Valid values are:

yes

If the transform cannot decode an IOCA image, it issues a message and stops processing the document.

no

If the transform cannot decode an IOCA image, it issues a message, stops processing the image, and continues with the next MO:DCA statement.

retrycont

If the transform cannot decode a G4 MMR (Modified Modified READ (ITU-TSS T.6 Group 4 two-dimensional coding standard for facsimile)) image, it proceeds one of two ways:

• If the RECID indicates RIDIC and the transform fails to decode it as RIDIC, it tries to decode it again as unpadded RIDIC.
• If the RECID indicates unpadded RIDIC, and the transform fails to decode the image that way, it tries to decode it again as RIDIC.

If the transform still cannot decode the G4 MMR image, or if the image is not a G4 MMR image, the transform issues an error message, stops processing the image, and continues with the next MO:DCA statement.

retryfail

If the transform cannot decode a G4 MMR (Modified Modified READ (ITU-TSS T.6 Group 4 two-dimensional coding standard for facsimile)) image, it proceeds one of two ways:

• If the RECID indicates RIDIC and the transform fails to decode it as RIDIC, it tries to decode it again as unpadded RIDIC.
• If the RECID indicates unpadded RIDIC, and the transform fails to decode the image that way, it tries to decode it again as RIDIC.

If the transform still cannot decode the G4 MMR image, or if the image is not a G4 MMR image, the transform issues a message and stops processing the document.

Default: AOP_FAIL_ON_IMAGE_ERROR –> yes

Example: environment={AOP_FAIL_ON_IMAGE_ERROR –> no}

AOP_FONTLIB

The AFP system resource libraries that contain fonts. Specify 1 to 8 or more data set names. Separate each name with a space. Libraries are searched in the order that they are listed.

Specify the AFP 240-pel or300-pel raster and outline font libraries used by your installation:

• Specify AFP 240-pel or300-pel raster font libraries if either (1) you specify a raster font in the AOP_CHARS environment variable or (2) documents to be transformed reference raster fonts.
• Specify AFP outline font libraries if data to be transformed references outline fonts.

Default: AOP_FONTLIB –> "sys1.font300 SYS1.SFNTILIB"

Examples:

1. environment={AOP_FONTLIB –> "sys1.font300"}
2. The backslash in the example indicates that the text within the quotation marks continues on the next line:

   environment={AOP_FONTLIB –> "sys1.font300 \
     SYS1.SFNTILIB inst.font300"}

AOP_FONTMAP_TABLE

The full path name of a UNIX file that contains a font-mapping table.

Default: No file path.

Example:

environment={AOP_FONTMAP_TABLE -> /usr/lpp/IBM/PrintXform/V1R2/samples/aokfontmap.samp}

AOP_FONTPATH

The directories that contain TrueType, OpenType, and WorldType fonts that the transform uses to process data sets. The directory path can be up to 255 characters and you can specify from one to eight UNIX file resource path directories. The transform searches for fonts in the directories in the order they are specified. The fonts must be installed in each directory with a resource installer that builds a resource access table (RAT) to describe the fonts in that directory. To find out how to install fonts, see Using TrueType, OpenType, and WoldType fonts.

Default: AOP_FONTPATH –> "/usr/lpp/fonts/worldtype”

Examples:

1. Single directory specified:

   environment={AOP_FONTPATH –> "/usr/lpp/fonts/collections"}

2. Multiple directories specified with a blank between the paths:

   environment={AOP_FONTPATH –> "/usr/lpp/fonts/myfonts /jdoe/fonts/truetype"}

   Tip: Separate directory paths with a space. Spaces are not allowed within the directory path name.
3. The backslash in the example indicates that the text within the quotation marks continues on the next line:

   environment={AOP_FONTPATH –> "/usr/lpp/fonts/collections \
   /usr/lpp/fonts/wt_ttf"} 

AOP_FORMDEF

The default form definition used to format the input data stream. Specify the 1 to 8 character form definition name, with or without the F1 prefix. If you omit the F1 prefix, the transform adds it.

The transform uses this form definition only if no other form definition is specified.

Default: AOP_FORMDEF –> F1CP0110

Example: environment={AOP_FORMDEF –> F1CP0111}

AOP_FORMDEFLIB

The AFP system resource libraries that contain form definitions. Specify from 1 to 8 or more data set names. Separate each name with a space. Libraries are searched in the order listed.

Default: AOP_FORMDEFLIB –> "sys1.fdeflib"

Example: environment={AOP_FORMDEFLIB –> "sys1.fdeflib inst.fdeflib"}

AOP_JPEGQUALITY

Indicates the JPEG image quality that is used in the transformed output as a percentage of the original image quality. A higher number results in a better quality image, yet a larger output file size. For smaller images, a small value such as 5 or 10 might not result in poor image output quality. Adjusting the value can help reduce the size of the resulting output files that contains images.

Valid values are:

100

Keep the original image quality as is.

1-100

Specify the JPEG image quality to be used in the transformed output as a percentage of the original image quality.

Tip: To reduce the image quality to that percentage of the original image quality, specify a value less than 100.

Default: AOP_JPEGQUALITY –> 100

Example: environment={AOP_JPEGQUALITY –> 10}

AOP_MAXIMAGERESOLUTION

Specifies the maximum resolution to be used to print images in the document. If you specify a resolution, the transform scales all images in the document to the specified resolution. Adjusting the maximum resolution value can help reduce the size of the output files that contain the images. This environment variable has minimal impact for AFP to PostScript transform, unless it is set to a value less than 300.

Valid values are:

0

Keep the input image resolution unchanged.

150-600

Specify the maximum resolution to use to print images in the document. Typically you want to choose 300 or 600 DPI.

Default: AOP_MAXIMAGERESOLUTION –> "0"

Example: environment={AOP_MAXIMAGERESOLUTION –> "300"}

Tip: Choose a value between 150 to 600 DPI as an image resolution in the output document. Typically choose 300 or 600 DPI.

AOP_MAX_RECORD_LENGTH

This value is used internally for data transfer. If transforming output to an MVS™ data set, specify a value that represents the smallest record length for MVS data sets that will be used for transform output. A larger value will result in better transform throughput and performance. Specify MAX if not transforming output to MVS data sets.

Valid values are:

696 - 32756

Specify the record length of the MVS data set used to receive transform output.

MAX

The maximum record length of 32756 will be used.

Tips:

1. A record length of 32756 for the MVS data set is recommended.
2. If 32756 is specified, use MAX for this environment variable.

Default: AOP_MAX_RECORD_LENGTH ->1024

Example: environment={AOP_MAX_RECORD_LENGTH–> MAX}

AOP_MSGFORMDEF

The form definition used to format transform error messages. Specify the 1 to 8 character form definition name, with or without the F1 prefix. If you omit the F1 prefix, the transform adds it. This form definition must be located in one of the libraries specified in the AOP_FORMDEFLIB variable.

Default: AOP_MSGFORMDEF –> F1CP0110

Example: environment={AOP_MSGFORMDEF –> F1CP0111}

AOP_MSGPAGEDEF

The page definition used to format transform error messages. Specify the 1 to 8 character page definition name, with or without the P1 prefix. If you omit the P1 prefix, the transform adds it. This page definition must be located in one of the libraries specified in the AOP_PAGEDEFLIB variable. The transform formats messages for the first paper size defined in the AOP_PAPER variable.

Recommendation: Use page definition P1P08682 for letter size paper, and page definition P1Q09182 for A4 paper.

Default: AOP_MSGPAGEDEF –> P1P08682

Example: environment={AOP_MSGPAGEDEF –> P1P06362}

AOP_OFFSET_JOGGING

Indicates how the transform supports offset stacking (also called jogging). Offset stacking is requested in the form definition (medium map). If the form definition requests offset stacking, the transform can offset, shift, or rotate each subset in the output depending on the printer support. The printer must support PJL commands.

Valid values are:

no

The transform ignores offset stacking requested in the form definition.

rotate

The transform rotates the output by creating a new printer job for each subset and specifying the PJL DEFAULT JOBOFFSET=ROTATE command for the job. Printers that support this PJL command include some Ricoh printers.

shift

The transform shifts the output by creating a new printer job for each subset and specifying the PJL DEFAULT JOBOFFSET=SHIFT command for the job. Printers that support this PJL command include some Ricoh printers.

yes | on

The transform offsets the output by creating a new printer job for each subset and specifying the PJL DEFAULT JOBOFFSET=ON command for the job. (Value "yes" is the same as "on".)

Rule: If you specify rotate, shift, yes, or on, the printer must support PJL commands. In addition, you must specify the AOP_PJL -> yes environment variable.

If you specify AOP_PJL -> yes and use the IP PrintWay extended mode Direct Sockets protocol to send documents to the printer, do not select the Record pages printed for accounting and Restart printing after last successful page options in the printer definition for the printer. This is because a PJL JOB command in the document can conflict with the PJL JOB command that IP PrintWay adds to the document to track the number of pages that print successfully.

Default: AOP_OFFSET_JOGGING –> no

Example: environment={AOP_OFFSET_JOGGING –> yes}

Note: If you specify rotate, shift, yes, or on, fonts are sent to the printer again for each new printer job, which can adversely affect performance. In addition, other documents might print between the printer jobs.

AOP_OVERLAYLIB

The AFP system resource libraries that contain overlays. Specify from 1 to 8 or more data set names. Separate each name with a space. Libraries are searched in the order listed.

Default: AOP_OVERLAYLIB –> "sys1.overlib"

Example: environment={AOP_OVERLAYLIB –> "sys1.overlib inst.overlib"}

AOP_PAGEDEF

The default page definition used to format line data. Specify the 1 to 8 character page definition name, with or without the P1 prefix. If you omit the P1 prefix, the transform adds it. The transform uses this page definition only if no other page definition is specified.

Recommendation: Use page definition P1P08682 for letter size paper, and page definition P1Q09182 for A4 paper.

Default: AOP_PAGEDEF –> P1P08682

Example: environment={AOP_PAGEDEF –> P1Q09182}

AOP_PAGEDEFLIB

The AFP system resource libraries that contain page definitions. Specify from 1 to 8 or more data set names. Separate each name with a space. Libraries are searched in the order listed.

Default: AOP_PAGEDEFLIB –> "sys1.pdeflib"

Example: environment={AOP_PAGEDEFLIB –> "sys1.pdeflib inst.pdeflib"}

AOP_PAGESEGLIB

The AFP system resource libraries that contain page segments. Specify from 1 to 8 or more data set names. Separate each name with a space.

Default: AOP_PAGESEGLIB –> "sys1.pseglib"

Example: environment={AOP_PAGESEGLIB –> "sys1.pseglib inst.pseglib"}

AOP_PAPER

The name of the paper that is typically installed in each AFP input tray. The transform formats the PostScript output for the paper in the AFP input tray ID the document selects.

The position (1 through 9) of each paper name represents the number of the AFP input tray. The 10th position represents any AFP input tray number greater than 9.

You can specify from 1 to 10 paper names. Separate each name with a space. If you specify fewer than 10 paper names, the transform uses the paper name in position 1.

For more information about the paper names you can specify, see Paper names.

Valid paper names and their sizes (width x height) are:

Paper Name

Size

auto

The transform uses the page size in the Page Descriptor (PGD) structured field.

a3

297 x 420 mm

a4

210 x 297 mm

a5

148.3 x 210 mm

b4

250 x 353 mm

b5

176 x 250 mm

c5

162 x 229 mm (6.48 x 9.16 in.)

com10

4.125 x 9.5 in. (104.8 x 241.3 mm)

dl

110 x 220 mm (4.4 x 8.8 in)

executive

7.25 x 10.5 in (185 x 267 mm)

ledger

11 x 17 in (279 x 432 mm)

legal

8.5 x 14.0 in (216 x 356 mm)

letter

8.5 x 11.0 in (216 x 279 mm)

monarch

3.875 x 7.5 in. (98.4 x 190.5 mm)

Default: AOP_PAPER –> "letter letter letter letter letter letter letter letter letter letter"

Example: The backslash in the example indicates that the text within the quotation marks continues on the next line:

environment={AOP_PAPER –> "letter legal letter letter \
letter letter letter letter letter letter"}

In this example, if the document to be transformed specifies:

• AFP input tray 1, the transform formats the output for letter size paper.
• AFP input tray 2, the transform formats the output for legal size paper.
• AFP input tray greater than 9, the transform formats the output for letter size paper.

AOP_PJL

Indicates whether the printer accepts all PCL 5 commands, including PJL commands. All printers that support PCL 5 support PJL commands. Some printers that support only PCL 4 do not support PJL commands. Sometimes, a printer that does not support PJL commands prints a smiley face where a PJL command occurs in the data stream or prints the PJL command on the first page. Valid values are:

yes

The printer accepts PJL commands.

no

The printer does not accept PJL commands. Therefore, the AFP to PostScript transform does not create PJL commands.

Default: AOP_PJL –> no

Example: environment={AOP_PJL –> yes}

Tip: If you use IP PrintWay extended mode, specify AOP_PJL -> no because a PJL JOB command in the document can conflict with the PJL JOB command that IP PrintWay adds to the document to track the number of pages that print successfully.

AOP_PSPRINTERPOLICY

Specify the PostScript policy settings string to be inserted as is into the resulting PostScript output by the AFP to PS transform instead of the default policy settings. Valid values are:

none

The transform does not insert any PostScript policy settings.

string

A PostScript policy string that is inserted as is in the PostScript output. A maximum of 127 characters are allowed for this string.

Default: By default, the transform inserts the following PostScript policy settings: <</PolicyNotFound 1 /PageSize 2 /ManualFeed 2 /DeferredMediaSelection 1>>

Example: environment={"<</PolicyNotFound 1 /PageSize 2 /ManualFeed 1 /DeferredMediaSelection 1>>"}

Note: The default policy settings are appropriate for most PostScript printers. However, if customization is required for a specific printer make and model, see PostScript Language Reference from Adobe and any printer-specific documentation for policy handling from the printer vendor. The transform does not perform any validation of the custom policy string supplied.

AOP_RESOURCE_CACHE

Specifies how the transform caches resources during execution, which can be in memory or in a UNIX directory. The AOP_RESOURCE_CACHE environment variable applies when the input data contains one or more of the following embedded AFP resources:

• Overlays
• Page Segments
• Objects (such as graphics and images)
• Fonts

Valid values are:

memory

By default, this transform caches all resource in memory.

base

This transform caches resources in the directory named <base-directory>/xfd/transform[_class].#.d. The base-directory is /var/Printsrv.

Default: AOP_RESOURCE_CACHE -> memory

Example: environment={AOP_RESOURCE_CACHE -> base}

AOP_TRAILER_ERROR_PAGE

Specifies whether the transform writes messages for transform warnings and data stream errors to a trailer error page. The trailer error page is the last page in the output document. Warnings can indicate degraded output.

Valid values are:

error

The transform writes error messages, but not warning messages, to a trailer error page. This option does not apply when AOP_FAIL_ON_ERROR–> error or AOP_FAIL_ON_ERROR–>warning because no output document is created when an error occurs.

no

No trailer error page is produced.

warning

The transform writes warning and error messages to a trailer error page. This option does not apply when AOP_FAIL_ON_ERROR–>warning because no output document is created when an error or warning occurs. This is the default.

Tips:

1. The trailer-transform-error-page job attribute and the Trailer error page field in the printer definition override this value.
2. You can specify the value using lowercase or uppercase letters (for example, no or NO).
3. The Trailer error page printer definition attribute can also be set using the ISPF panel in the processing section.

Default: AOP_TRAILER_ERROR_PAGE –> warning

Example: environment={AOP_TRAILER_ERROR_PAGE –> error}

AOP_TRAYID

A mapping of AFP input tray numbers to PostScript tray IDs. The position (1 - 9) of each PostScript tray ID corresponds to the AFP tray number. The 10th position corresponds to all AFP input tray numbers greater than 9.

Specify 1 to 10 PostScript tray numbers, separating each number with a space. Number 0 (zero) indicates that an input tray is not installed in the printer. A value of M indicates the manual input tray. If the input document requests an input tray that is not installed, the transform writes an error message in the output file and uses the tray ID in position 1.

Tip: Specify the ID used by the PostScript printer to select each tray. This value, minus 1, corresponds to an entry in the Priority array in the InputAttributes dictionary for the PostScript printer. Printer-specific values are described in the PostScript PPD file for the printer.

Default: AOP_TRAYID –> "1 2 0 0 0 0 0 0 0 M"

Example: environment={AOP_TRAYID –> "1 4 1 1 1 1 1 1 1 M"}

In this example, if the AFP document specifies:

• AFP input tray 1, the transform uses PostScript tray 1.
• AFP input tray 2, the transform uses PostScript tray 4.
• AFP input tray 3 through 9, the transform uses PostScript tray ID 1.
• AFP input tray greater than 9, the transform uses the manual input tray.