Specifying transform options

You must create at least one transform entry in the Infoprint Server transform configuration file (aopxfd.conf) for the AFP to PDF transform. In the transform entry, you can specify:

• Environment variables that control the transform
• Attributes that control how the Infoprint Server Transform Manager manages the transform

For information about how to create and edit the Infoprint Server transform configuration file, see "Creating the transform configuration file (aopxfd.conf)" in z/OS Infoprint Server Customization. After you update the transform configuration file, you must restart the Infoprint Server Transform Manager.

Transform classes

If you want to specify different sets of transform options for different uses, you can create different classes of the AFP to PDF transform. For example, you might create a separate class for documents that require encryption.

For each transform class, you must create a separate transform entry. You select a name for the transform class in the transform entry (see the transform attribute).

To use a transform class, job submitters must specify the class name as an option (-c) on the afpxpdf transform command or in the filter-options job attribute, and administrators must specify the class name as a filter option (-c) in the printer definition. For example, these z/OS® UNIX commands use the "encrypt" transform class:

afpxpdf -c encrypt -o myfile.pdf myfile.afp
lp -d myprinter -o "filter-options='-c encrypt'" myfile.afp

Font-mapping options

The AFP to PDF transform can use 300-pel raster fonts (single-byte or double-byte) and AFP outline fonts (single-byte only). In addition, the transform can map single-byte 240-pel or 300-pel raster fonts to equivalent type 1 outline fonts. Outline fonts provide superior viewing and printing. Double-byte outline fonts are not supported. See Mapping raster fonts to outline fonts for information on mapping fonts.

Use these environment variables to control font-mapping in the transform configuration file:

• AOP_FONTMAP_TABLE:

  Specifies the full path name of a UNIX file that contains a font-mapping table that maps raster fonts to outline fonts.

  Notes:

  1. The font-mapping table must be a UNIX file.
  2. The presence of a valid font-mapping table in the specified file implies that font mapping is performed for any fonts found in the table.
• AOP_OUTLINES:
  • The yes option (default) causes the transform to include outline fonts in the output data. Base 14 fonts are never included because they are installed with Adobe Acrobat.
  • The builtin option causes the transform to include only the names of outline fonts in the PDF document.
    Tip:

    Select the builtin if you want to reduce the size of your PDF documents. However, if the outline font is not available to the PDF viewer, errors might be issued and the document might not view correctly.

Enhanced PDF options

The AFP to PDF transform lets you select options that enhance viewing and navigation in PDF documents. To select these options, use these environment variables:

• AOP_ANNOTATIONS: Creates annotations in the PDF document.
• AOP_INDEX: Creates bookmarks in PDF documents for improved navigation.
• AOP_INDEX_LANG: Specifies the code page for the language for converting text in bookmarks.
• AOP_LINEARIZE: Optimizes PDF documents for fast viewing from the web.
• AOP_LINKS: Creates links in PDF documents for improved navigation.
• AOP_ROTATE_PDF: Specifies how to rotate PDF documents for easier viewing.

PDF encryption options

The AFP to PDF transform can encrypt PDF documents. For an overview of encryption, see Encrypting PDF documents.

Use these environment variables to specify encryption options in the transform configuration file:

• AOP_ENCRYPT: Enables encryption.

  When you enable encryption, the transform encrypts documents if any of these conditions are met:

  • The job submitter specifies a user or owner identifier in a job attribute, or submits a print job to a printer definition that specifies a user or owner identifier.
  • The AOP_PROTECT environment variable is specified in the AFP to PDF transform class.
  • If neither AOP_PROTECT is specified nor a user or owner password is provided, the transform will use 40 bit encryption for the document with no protect options.
• AOP_PASSWORD_EXIT: The name of your Password exit and optional arguments. The transform calls this exit to obtain PDF owner and user passwords when an owner or user identifier is specified.

  This environment variable is used if encryption is enabled and a user or owner identifier is specified. Otherwise it is ignored.

• AOP_PROTECT: The actions to be restricted in all PDF documents when no identifiers are specified. You can restrict copying, printing, and updating PDF documents.

  This environment variable is ignored if either a user or owner identifier is specified.

Default AFP resources

AFP resources are collections of data and control information that the transforms use to create PDF documents. You can specify default AFP resources (such as a default font, form definition, and page definition) in the transform configuration file and in printer definitions. AFP resources specified in a printer definition override default resources specified in the transform entry. If only a few printers use different default AFP resources, you might want to specify these default AFP resources in the printer definitions.

In most situations, you should specify the same default AFP resources that your AFP printers use. These default resources are specified either in the PSF startup procedures (in the PRINTDEV statements) or, if PSF is configured to obtain PRINTDEV values from the Printer Inventory, in the PSF FSA definitions in the Printer Inventory.

Use these environment variables to specify default AFP resources in the transform configuration file:

• AOP_CHARS: The default font used for transform error messages and for line data and AFP data that does not specify another font.
• AOP_FORMDEF: The default form definition used when no other form definition is specified.
• AOP_PAGEDEF: The default page definition used when no other page definition is specified.

Search hierarchy for form definitions

The transform uses this hierarchy to select the name of the form definition:

1. The form definition specified in the form-definition job attribute or FORMDEF JCL parameter.
2. The form definition specified in the Form definition field in the printer definition.
3. The first inline form definition.
4. The form definition specified in the AOP_FORMDEF environment variable in the transform configuration file.
5. Form definition F1CP0111. This default is coded in the transform.

Search hierarchy for page definitions

The transform uses this hierarchy to select the name of the page definition:

1. The page definition specified in the page-definition job attribute or the PAGEDEF or FCB JCL parameter. (The PAGEDEF parameter overrides the FCB parameter.)
2. The default page definition supplied by JES to IP PrintWay™ basic mode. (See Tips.)
3. The page definition specified in the Page definition field in the printer definition.
4. The first inline page definition.
5. The page definition specified in the AOP_PAGEDEF environment variable in the transform configuration file.
6. Page definition P1P08682. This default is coded in the transform.

Search hierarchy for the default font

The transform uses this hierarchy to select a font for line data and AFP data that does not specify a font:

1. The font named in the page definition.
2. The font specified in the chars job attribute or the CHARS or UCS JCL parameter. (The CHARS JCL parameter overrides the UCS parameter.)
3. The default font supplied by JES to IP PrintWay basic mode. (See Tip.)
4. The font specified in the Character set field in the printer definition.
5. The font specified in the AOP_CHARS environment variable in the transform configuration file. The transform prefixes X0 to the font named in the variable if you do not specify a prefix.
6. Font X060D9. This default is coded in the transform.

Search hierarchy for the message font

The transform uses this hierarchy to select a font used for transform error messages:

1. The font named in the page definition specified in the AOP_MSGPAGEDEF environment variable.
2. The font specified in the AOP_CHARS environment variable in the transform configuration file. The transform prefixes X0 to the font named in the variable if you do not specify a prefix.
3. Font X060D9. This default is coded in the transform.

AFP system resource libraries

In the transform entry, you can specify from 1 to 8 AFP system resource libraries for fonts, page definitions, form definitions, page segments, and overlays. You can specify from 1 to 8 AFP user resource libraries in printer definitions.

In most situations, you should specify the same AFP system resource libraries in the transform configuration file as you currently specify in your PSF startup procedures. If only a few printers require different resource libraries, you can specify those libraries in the printer definitions for the printers.

Use these environment variables to specify system resource libraries in the transform configuration file:

• AOP_FONTLIB: The names of 1 to 8 system font libraries
• AOP_FORMDEFLIB: The names of 1 to 8 system form definition libraries
• AOP_OVERLAYLIB: The names of 1 to 8 system overlay libraries
• AOP_PAGEDEFLIB: The names of 1 to 8 system page definition libraries
• AOP_PAGESEGLIB: The names of 1 to 8 system page segment libraries

AFP user resource libraries can be specified in job attributes, JCL parameters, environment variables, and in the printer definition.

The transforms use this hierarchy when searching AFP resource libraries:

1. User resource libraries specified in the resource-library job attribute or USERLIB JCL parameter.
2. Default user resource libraries specified in the Resource library field in the printer definition. These libraries are searched only when the job submitter does not specify any user resource libraries (see step 1).
3. System resource libraries specified in environment variables in the transform configuration file.
4. Default system resource libraries that are hard-coded in the transform. These libraries are searched only if no system resource libraries are specified in the transform configuration file (see step 3).

AFP system resource directories

In the transform entry, you can specify from one to eight UNIX file resource path directories that contain TrueType, OpenType, and WorldType fonts. The directory path can be up to 255 characters. 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. You can also specify the resource directories in printer definitions.

In most situations, you should specify the same AFP resource directories in the transform configuration file as you currently specify in your PSF startup procedures. If only a few printers require different resource directories, you can specify those libraries in the printer definitions for the printers.

Use the AOP_FONTPATH environment variable to specify the resource directories in the transform configuration file:

AFP user resource directories can be specified in job attributes, JCL parameters, environment variables, and in the printer definition.

The transform uses this hierarchy when searching AFP resource directories:

1. User resource directories specified in the resource-directories job attribute or USERPATH JCL parameter.
2. Default user resource directories specified in the Resource directories field in the printer definition. These directories are searched only when the job submitter does not specify any user resource directories (see step 1).
3. Resource directories specified in the AOP_FONTPATH environment variable in the transform configuration file.
4. Default resource directory that is hard-coded in the transform (/usr/lpp/fonts/worldtype/V8.0). This directory is searched only if no resource directories are specified in the transform configuration file (see step 3).

Format of an AFP to PDF transform entry

The format of an AFP to PDF transform entry in the transform configuration file (aopxfd.conf) is:

transform afpxpdf[_transformclass]
    start-command = afpxpdfd
    [ environment = {name –> value [ name –> value]... } ]
    [ maximum-active = number ]
    [ maximum-idle-time = seconds ]
    [ minimum-active = number ]
   ;

transform afpxpdf[_transformclass]

This statement indicates the beginning of a transform entry.

afpxpdf

The name of the transform.

transformclass

The name of an optional transform class. Specify from 1 to 55 characters, including letters, numbers, or special characters. The name of the transform class is case-sensitive.

Default:

No transform class.

Example:

transform afpxpdf_encrypt

start-command = afpxpdfd

The name of the transform daemon. If the transform daemon is not in a directory identified in the PATH environment variable specified in the aopstart EXEC, specify the full directory path name of the daemon. (The afpxpdfd daemon is installed in /usr/lpp/Printsrv/bin.) This attribute is required.

Default:

None.

Example:

start-command=/usr/lpp/Printsrv/bin/afpxpdfd

environment = {name –> value [name –> value]... }

Environment variables that specify transform options. Enclose the entire set of environment variables in braces. The values in these environment variables override environment variables with the same name that are set in the aopstart EXEC. If a value contains special characters or spaces, enclose the value in single or double quotation marks

For information about the environment variables you can specify, see Environment variables for the AFP to PDF transform.

Default:

None.

Example:

environment={AOP_ENCRYPT –> yes}

maximum-active = number

The maximum number of transform daemons that the Transform Manager activates concurrently. Specify a number greater than 0 and greater than or equal to the number specified in the minimum-active attribute. For more information, see "Format of a transform entry" in z/OS Infoprint Server Customization.

Default:

No maximum number. Transform daemons are started when needed.

maximum-idle-time = seconds

The number of seconds before the Transform Manager shuts down an idle transform daemon and system resources are freed. Specify a number greater than 0. For more information, see "Format of a transform entry" in z/OS Infoprint Server Customization.

Default:

Idle transform daemons are not shut down.

minimum-active = number

The minimum number of transform daemons that the Transform Manager activates concurrently. Specify a number less than or equal to the number specified in the maximum-active attribute. For more information, see "Format of a transform entry" in z/OS Infoprint Server Customization.

Default:

minimum-active = 0

Environment variables for the AFP to PDF transform

You can specify environment variables to:

• Specify default AFP resources, such as the default form definition and page definition.
• Specify AFP system resource libraries.
• Select transform functions, such as whether to enable encryption.
• Name the paper sizes in AFP input trays.

You can optionally specify these environment variables:

__AOPXFORM_DAEMON_DEBUG

Note:

There are two underscores at the beginning of this environment variable.

Indicates whether the transform front-end dll code is traced.

The front-end dll code is responsible for parsing environment variables and options. No other options are needed for this trace.

This trace includes information about the transform configuration and job data that is processed and errors that occur.

The output for this trace is always directed to the transform stderr file and cannot be redirected. For more information about the stderr file, see Finding the transform stderr file.

Valid values are:

yes

The transform front-end dll code is traced.

no

The transform front-end dll code is not traced.

Default:

__AOPXFORM_DAEMON_DEBUG –> no

Example:

environment={ __AOPXFORM_DAEMON_DEBUG -> yes}

Note:

For another method to trace front-end dll code, see Trace options.

_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 –> afpxpdfD}

AOP_ANNOTATIONS

Indicates whether the transform is to produce annotations in the PDF document. The transform can create an annotation on each page. The annotation contains only printing instructions such as "Normal duplex Front side". The printing instructions are derived from the form definition used to transform the document. For more information about annotations, see the online help provided with Adobe Reader. Valid values are:

yes

The transform produces annotations.

no

The transform does not produce annotations.

Default:

AOP_ANNOTATIONS –> yes

Example:

environment={AOP_ANNOTATIONS –> no}

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 transform uses 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 format the document and (2) AFP data when no other font is specified in the AFP data stream.

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

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_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 description of 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 9 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_ENCRYPT

Indicates whether you want the transform to encrypt documents.

yes

The transform encrypts documents.

no

The transform does not encrypt documents. Transform requests that specify user or owner identifiers fail.

Tip:

If AOP_ENCRYPT is set to yes and neither AOP_PROTECT is specified nor a user or owner password is provided, the transform uses a 40 bit encryption key with no protect option.

Default:

AOP_ENCRYPT –> no

Example:

environment={AOP_ENCRYPT –> yes}

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_FLATE

Indicates whether the transform is to use the Adobe Flate compression algorithm to compress the output. Valid values are:

yes

The transform produces compressed output.

no

The transform does not produce compressed output. However, throughput is higher.

Default:

AOP_FLATE –> yes

Example:

environment={AOP_FLATE –> no}

AOP_FONTLIB

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

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

• Specify AFP 240-pel or 300-pel raster font libraries if either (1) AOP_CHARS specifies a raster font 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.fontoln"

Examples:

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

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

AOP_FONTMAP_TABLE

The full path name of a UNIX file that contains a font-mapping table that maps raster fonts to outline fonts.

Default:

No file path.

Example:

environment={AOP_FONTMAP_TABLE -> /usr/lpp/Printsrv/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/v8.0"

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 this 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 and create PDF output. 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 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_INDEX

Indicates whether the transform is to create PDF bookmarks in the PDF document when the input AFP document contains Tag Logical Elements (TLE) structured fields. For example, a table of contents in an AFP document can be converted to a set of PDF bookmarks. Adobe Reader displays PDF bookmarks in its navigation pane. For more information about bookmarks, see the online help provided with Adobe Reader. Valid values are:

yes

The transform creates bookmarks in the PDF document.

no

The transform does not create bookmarks in the PDF document.

Default:

AOP_INDEX –> no

Example:

environment={AOP_INDEX –> yes}

AOP_INDEX_LANG

The default code page the transform uses to translate text in the PDF bookmarks (TLE structured fields). This code page is used for line-data documents and overrides the AFP Begin Document (BDT) structured field in an AFP document. If the BDT contains a document language that is to be used, specify NONE for AOP_INDEX_LANG. If the BDT does not contain a document language and AOP_INDEX_LANG is NONE, code page 37 will be used. Valid values are:

Code page

Description

037

USA, Canada, Australia, New Zealand

273

Austria, Germany

274

Belgium

275

Brazil

277

Denmark, Norway

278

Finland, Sweden

280

Italy

281

Japan Latin

282

Portugal

284

Spain, Latin America

285

UK

297

France

500

International

871

Iceland

Default:

AOP_INDEX_LANG –> 037

Example:

environment={AOP_INDEX_LANG->500}

AOP_LINEARIZE

Indicates whether the transform is to linearize PDF documents so that they can be viewed faster from the web. This function is especially important for large PDF documents that can take a long time to download. In Adobe Reader online help, this function is called optimization and Fast Web View. Adobe Reader displays the first page of a linearized PDF document before the entire document has been loaded from a website. For more information about optimization, see the online help provided with Adobe Reader. Valid values are:

yes

The transform optimizes the PDF document for fast viewing from the web.

no

The transform does not optimize the PDF document for fast viewing from the web.

Tip:

When you select linearization, the transform uses additional memory because the entire PDF document is kept in memory while it is being linearized.

Default:

AOP_LINEARIZE –> no

Example:

environment={AOP_LINEARIZE –> yes}

AOP_LINKS

Indicates whether the transform is to create links in the PDF document when the input AFP document contains Link Logical Elements (LLE) structured fields. If the Object Classification Triplet in the LLE indicates an executable program link, the transform creates a Uniform Resource Locator (URL) in the PDF document. Valid values are:

yes

The transform creates links in the PDF document.

no

The transform does not create links in the PDF document.

Default:

AOP_LINKS –> no

Example:

environment={AOP_LINKS –> yes}

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_OUTLINES

The type of processing the transform does for outline fonts. Valid values are:

builtin

The transform includes only the names of outline fonts in the PDF output. Outline fonts themselves are not included in the output. When the PDF output is viewed or printed, the PDF driver (for example, Adobe Reader or a PDF printer) maps the requested typeface to an equivalent typeface. This option produces smaller output files than when fonts are included in the output. However, differences in output appearance can result due to the mapping done by the PDF driver. For example, font spacing might be different, and if you use special characters or if you use characters or glyphs that are unknown to the PDF driver, these characters will not be visible

yes

The transform includes outline fonts in the PDF output. This option provides better output fidelity than the builtin option. However, each typeface increases the size of the PDF output file by approximately 110 KB.

Default:

AOP_OUTLINES –> yes

Example:

environment={AOP_OUTLINES –> builtin}

AOP_OVERLAYLIB

The AFP system resource libraries that contain overlays. Specify from 1 to 8 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 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 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 PDF output for the paper in the first 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

292.25 x 413.25 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 this 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_PASSWORD_EXIT

The name of the Password exit and optional arguments. The transform calls the Password exit to obtain PDF owner and user passwords for encryption when a user identifier or owner identifier is specified.

Specify the full path name of the Password exit unless it is in a directory named in the LIBPATH environment variable. Also, specify any optional arguments that your Password exit accepts.

A sample Password exit is provided in /usr/lpp/Printsrv/lib/aokpdfexit.dll. This sample exit accepts the name of the password database as an optional argument (if none is specified, the sample exit uses /etc/Printsrv/aokpdfexit.db). For information about the sample Password exit, see Writing a Password exit.

Default:

AOP_PASSWORD_EXIT –> "/usr/lpp/Printsrv/lib/aokpdfexit.dll"

Example:

In this example, the argument is the name of the sample password database that the transform provides. The backslash indicates that the text within the quotation marks continues on the next line.

environment={AOP_PASSWORD_EXIT –> "/usr/lpp/Printsrv/lib/aokpdfexit.dll \
/usr/lpp/Printsrv/samples/aokpdfexit.db"}

AOP_PROTECT

The actions the transform is to restrict in all PDF documents when the transform job does not specify either a user or owner identifier.

The transform encrypts the PDF documents and restricts the specified actions. However, the encrypted PDF documents do not have user passwords. This means that anyone can read them without a password. The transform uses a low level of encryption (a 40-bit encryption key).

If a transform job specifies a user or owner identifier, the transform ignores this variable and encrypts the PDF document using the passwords associated with the identifiers. It restricts the actions specified in the pdf-protect job attribute or in the printer definition.

Valid values are:

Table 11. AOP_PROTECT values

Value:	Actions users cannot do:
select	Copy or extract content to another document Extract content for accessibility
print	Print at low resolution (150 dpi) Print at high resolution
modify	Change the document Assemble the document (insert, delete, rotate pages) Create template pages

Default:

None.

Example:

environment={AOP_PROTECT –> "select print modify"}

AOP_ROTATE_PDF

Indicates how the transform is to rotate PDF documents. For example, some pages (such as those that contain tables) might require the PDF document to be turned sideways to be read. Valid values are:

no

The rotation in the form definition is used (PRESENT keyword).

auto

The rotation on each page is the same as the direction of the majority of the characters on the page.

0

The PDF document is not rotated.

90

The entire PDF document is rotated 90 degrees counterclockwise.

180

The entire PDF document is rotated 180 degrees counterclockwise.

270

The entire PDF document is rotated 270 degrees counterclockwise.

Tip:

Rotating PDF documents can change the way the PDF documents print. If PDF documents do not print correctly using the no value, try the 0 value.

Default:

AOP_ROTATE_PDF –> no

Example:

environment={AOP_ROTATE_PDF –> auto}

AOP_TRAILER_ERROR_PAGE

Specifies whether the transform writes messages for transform informational 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 informational 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

Indicates whether an AFP tray number is valid. The position (1 - 9) of each value corresponds to the AFP tray number. The 10th position corresponds to all AFP input tray numbers greater than 9. Valid values are:

1

The AFP tray number is valid.

0

The AFP tray number is not valid. If the AFP document requests this tray in position 2-10, the transform writes an error message and uses the tray ID in position 1. If the AFP document requests this tray in position 1, the transform changes the value to a 1, as it is used as the default value.

Tip:

To avoid transform error messages, either omit this variable or specify the default value.

Default:

AOP_TRAYID –> "1 1 1 1 1 1 1 1 1 1"

Example:

environment={AOP_TRAYID –> "1 1 1 1 1 1 1 1 1 1"}

Examples -- Transform configuration file entries for the AFP to PDF transform

These examples show sample transform entries in the Infoprint Server transform configuration file (aopxfd.conf) for the AFP to PDF transform.

Enhance viewing of PDF documents

This transform entry enables transform options that enhance viewing of PDF documents. The environment variables to enable these functions are shown in bold text. For more information about these environment variables, see Enhanced PDF options.

transform afpxpdf
 start-command = afpxpdfd
 minimum-active = 1   
 maximum-active = 2
 maximum-idle-time = 300 # 5 minutes
 environment = {
   _BPX_JOBNAME -> afpxpdfD                                    
   AOP_CHARS -> 60D9 
   AOP_CUTSHEET -> yes
   AOP_ENCRYPT -> no
   AOP_FLATE -> yes                                                
   AOP_FONTLIB -> "sys1.font300 sys1.fontoln"         
   AOP_FORMDEF -> F1CP0110 
   AOP_FORMDEFLIB -> "sys1.fdeflib"                   
   AOP_INDEX -> yes
   AOP_INDEX_LANG -> 037                              
   AOP_MSGFORMDEF -> F1CP0110                                          
   AOP_MSGPAGEDEF -> P1P08682    
   AOP_OVERLAYLIB -> "sys1.overlib" 
   AOP_PAGEDEF -> P1P08682                                             
   AOP_PAPER -> 
    "letter letter letter letter letter letter letter letter letter letter"
   AOP_ROTATE_PDF -> auto
   AOP_TRAYID -> "1 1 1 1 1 1 1 1 1 1"                                 
  }                                                                      
 ;                                                                                                                

Encrypt PDF documents

This transform entry enables encryption and also restricts actions in all PDF documents. The environment variables used for encryption are shown in bold text. For more information about these environment variables, see PDF encryption options.

This transform entry creates transform class "encrypt". To use this transform class, specify the class in the -c transform option as shown in these two examples:

• afpxpdf -c encrypt -o myfile.pdf myfile.afp
          lp -o "filter-options='-c encrypt'" -d myprinter myfile.afp

• transform afpxpdf_encrypt
   start-command = afpxpdfd
   minimum-active = 1   
   maximum-active = 2
   maximum-idle-time = 300 # 5 minutes
   environment = {                                                
     _BPX_JOBNAME -> afpxpdfD   
     AOP_CHARS -> 60D9                                               
     AOP_CUTSHEET -> no
     AOP_ENCRYPT -> yes
     AOP_FLATE -> yes                                                
     AOP_FONTLIB -> "sys1.font300 sys1.fontoln"         
     AOP_FORMDEF -> F1CP0110                                         
     AOP_FORMDEFLIB -> "sys1.fdeflib"                   
     AOP_INDEX -> yes
     AOP_INDEX_LANG -> 037
     AOP_MSGFORMDEF -> F1CP0110                                      
     AOP_MSGPAGEDEF -> P1P08682
     AOP_OVERLAYLIB -> "sys1.overlib"
     AOP_PAGEDEF -> P1P08682                                             
     AOP_PAGEDEFLIB -> "sys1.pdeflib"                       
     AOP_PAGESEGLIB -> "sys1.pseglib"     
     AOP_PAPER -> 
      "letter letter letter letter letter letter letter letter letter letter"
     AOP_PASSWORD_EXIT –> "/usr/lpp/Printsrv/lib/aokpdfexit.dll"
     AOP_PROTECT -> "modify print select"
     AOP_ROTATE_PDF -> no
     AOP_TRAYID -> "1 1 1 1 1 1 1 1 1 1"                                 
    }                                                                      
  ;