The afp2pdf transform configuration file
afp2pdf.cfg
. For Linux, the file is located in /opt/infoprint/itm/xforms/afp2pdf/
. For Windows, the file is located in install_path\afp2pdf
.The syntax of the configuration file is exactly the same as the command line syntax with these additional rules:
- Blank lines are ignored.
- The information after a pound sign (#) is considered a comment and is ignored. The pound sign can occur anywhere on a line.
- To include a pound sign in parameter data, it must be escaped; that is, it must be preceded by a backwards slash.
- White space before and after parameter data is removed.
- Parameter data on successive lines is concatenated with a single space between them.
- Parameters can span lines as long as they follow rules 1 through 5.
- Note:
- Options specified on the command line override options in the configuration file.
The parameters for the afp2pdf transform options are:
- AFM_PATH=<path>
- This parameter specifies the path location of the Adobe Font Metrics (AFM) files that
the transform uses. An AFM stores font metric data for a Type 1 PostScript font. It
contains the master design of a specific font, which defines the way each character
of the font looks. If a path is not specified, the default path is:
- For Linux
/opt/infoprint/itm/xforms/afp2pdf/font/AFM
- For Windows
install_path\afp2pdf\font\AFM
There is no command line flag associated with the AFM_PATH parameter.
- CNV_PATH=<path>
- This parameter specifies the path location of the CNV files that the ICU library uses
to convert text from one code page to Unicode and vice versa. If a path is not specified,
the default path is:
- For Linux
/opt/infoprint/itm/xforms/afp2pdf/cnv
- For Windows
install_path\afp2pdf\cnv
There is no command line flag associated with the CNV_PATH parameter.
- DEFAULT_CPID=<intValue>
- This parameter specifies a default Code Page Identifier (CPID) to be used when transforming AFP or SCS files.
- If a DEFAULT_CPID is not specified when transforming AFP files, a default value based on the
cpdef
file will be used. - If a DEFAULT_CPID is not specified when transforming SCS files, CPID 500 will be used as the default.
- There is no command line flag associated with the DEFAULT_CPID parameter.
- DEFAULT_FGID=<intValue>
- This parameter specifies a default Font Global Identifier (FGID) to be used when transforming AFP or SCS files.
- If a DEFAULT_FGID is not specified when transforming AFP files, a default value based on the
csdef
file will be used. - If a DEFAULT_FGID is not specified when transforming SCS files, FGID 11 (Courier) will be used as the default.
- There is no command line flag associated with the DEFAULT_FGID parameter.
- DISABLE_MEMSREAM=(TRUE|FALSE)
- When this parameter is set to TRUE, it specifies that during the transformation, the content of the PDF document will
be written in temporary files created on disk, no matter the size of the AFP document.
This parameter is useful if the output PDF document is too large to be kept in memory
until the transformation is completed. By default, the PDF document content is kept
in memory for an AFP document smaller than 10 MB; otherwise, temporary files are used.
There is no command line flag associated with the DISABLE_MEMSTREAM parameter.
- ENABLE_AUTO_FONT_IMAGE=(TRUE|FALSE)
- When this parameter is set to TRUE, it specifies that the output PDF document will contain an image for each character
that was written with a raster font in the AFP document. By default, the raster fonts
will be replaced with another font, and all characters will be written as text in
the PDF document. However, some of the characters might look different from their
raster form.
There is no command line flag associated with the ENABLE_AUTO_FONT_IMAGE parameter.
- FOCA_FONT_PATH=<path>
- This parameter specifies the path where the AFP FOCA fonts are installed. The default
path is:
- For Linux
/opt/infoprint/itm/xforms/afp2pdf/font/foca
- For Windows
install_path\afp2pdf\reslib
- There is no command line flag associated with the FOCA_FONT_PATH parameter.
- FONT_PATH=<path>
- This parameter specifies the path location of the font files that the transform uses
when writing the PDF document. If a path is not specified, the default path is:
- For Linux
/opt/infoprint/itm/xforms/afp2pdf/font
- For Windows
install_path\afp2pdf\font
There is no command line flag associated with the FONT_PATH parameter.
- MAX_OBJECTS=<number>
- This parameter specifies the maximum objects that can be listed in the PDF cross-reference
table (XREF). If the AFP file contains more objects than this, the additional ones
are ignored. This setting is provided for use with the MAX_PAGES setting. For example, if MAX_PAGES is set to a number greater than 1000, the value assigned to MAX_OBJECTS might need to be set to a number greater than 50000.
By default, MAX_OBJECTS and MAX_PAGES are commented out, which does not limit the number of objects or pages.
There is no command line flag associated with the MAX_OBJECTS parameter.
- MAX_PAGES=<number>
- This parameter specifies the maximum pages to be converted. You can use this parameter
to limit the number of pages generated by the transform. For example, if the number
of pages in an AFP document is not known and you want to limit disk space usage, you
might want to set a limit on the number of pages generated by the transform. Limiting
the number of pages can also improve transform performance.
By default, MAX_PAGES and MAX_OBJECTS are commented out, which does not limit the number of pages or objects.
There is no command line flag associated with the MAX_PAGES parameter.
- OUTPUTFILE=<path+filename>
- This parameter specifies the path and filename of the output PDF file. By default, the output PDF file is placed in the same directory
as the input file, and it has the same file name as the input file with the extension
changed from
.afp
to.pdf
. For example, when the PDF is generated from an AFP file namedafpdoc.afp
, an output file namedafpdoc.pdf
is created.- Note:
- If AFP is not used as the extension, a
.pdf
extension is still added to the output PDF file.
- If AFP is not used as the extension, a
- OVERLAYEXT=<ListOfExtenstions>
- PAGESEGEXT=<ListOfExtenstions>
- FORMDEFEXT=<ListOfExtenstions>
- JFIFext=<ListOfExtenstions>
- GIFEXT=<ListOfExtenstions>
- TIFFEXT=<ListOfExtenstions>
- These parameters specify the accepted extension for a resource type. The possible extension are separated by a comma (,). For each extension, a * (asterisk) will be replaced with the name of the searched resource. Therefore, specifying an * (asterisk) means no extension.
- When searching by name in the RESOURCE_DATA_PATH, the transform first tries the name with no extension. If it does not succeed, it tries with every extension from the list until the resource is found.
- By default, the extension list is an * (asterisk).
- There is no command line flag associated with these parameters.
- PDF_FONT_MAP_FILE = <path>
- This parameter specifies the path location of the
fontmap.lst
file that maps the Type 1 Fonts. When specified, it means that the user wants to embed Type 1 Fonts into the PDF document. If a path is not specified, the default path is:- For Linux
/opt/infoprint/itm/xforms/afp2pdf/font/fontmap.lst
- For Windows
install_path\afp2pdf\font\fontmap.lst
There is no command line flag associated with the PDF_FONT_MAP_FILE parameter.
- PFMPFB_DIRECTORY=<path>
- This parameter specifies the path location of the Adobe Type 1 outline font files
that the transform uses when embedding fonts inside of the PDF document. When simple
font substitution is not acceptable in the PDF output, it is possible to embed a custom
Type 1 font inside the PDF for better results. If a path is not specified, the default
path is:
- For Linux
/opt/infoprint/itm/xforms/afp2pdf/font/type1
- For Windows
install_path\afp2pdf\font\type1
- Note:
- Placing Type 1 font files in this directory does not mean that they are automatically placed inside of the PDF file. For a font to be embedded, it must be mapped using the transform font definition files. See Embedding Type 1 Fonts for more information.
There is no command line flag associated with the PFMPFB_DIRECTORY parameter.
- PRAGMA_FDEF= <filename>
- This parameter specifies the file name of the form definition (FORMDEF) resource to be used when transforming the AFP file. If an inline form definition is associated with the AFP document, then both the FDEF from the configuration file and the command line are ignored. If FDEF is not included in the configuration file or specified on the command line, the F1A10110 default form definition is used.
- PRAGMA_ALIGNTEXT=<angle>
- This parameter specifies the rotation value to use when transforming the file. Valid values are 0, 90, 180, or 270 (clockwise). Some AFP files might have already been formatted with a rotated orientation. If this occurs, text is aligned with the vertical axis of the paper rather than the horizontal axis. To correct this, you must use this parameter to align the text as desired.
- RESOURCE_DATA_PATH =<path>
- This parameter specifies the path location of the resource library. For all the external
resources used by the AFP document (formdef, overlay, page segment, jfif, gif, IOCA
image), the transform looks for them in this specified path. If a path is not specified,
the default path is:
- For Linux
/opt/infoprint/itm/xforms/afp2pdf/reslib
- For Windows
install_path\afp2pdf\reslib
There is no command line flag associated with the RESOURCE_DATA_PATH parameter.
- TT_FONT_PATH=<path>
- This parameter specifies the location of the TrueType font or the TrueType Collection
used. If a path is not specified, the default path is:
- For Linux
/opt/infoprint/itm/xforms/afp2pdf/font/truetype
- For Windows
install_path\afp2pdf\font\truetype
- USE_AFP_METADATA=<YES|YES_PAGE|YES_DOCUMENT|NO>
- This parameter specifies if the metadata is added to the PDF file and if it is on page level or on document level. When the parameter is set to YES and YES_PAGE, the same metadata is placed on every page. When the parameter is set to YES_DOCUMENT, the metadata is placed only once for the entire document. The default value is YES.
- VERBOSE
- This parameter specifies verbose information will be generated to
stderr
.