Configure Kofax Converter

By default, each document conversion profile uses the default KFXConverter settings for document conversion.

You can modify the Kofax Converter (KFXConverter) settings for each document conversion profile in the TotalAgility Designer. You can undo any changes to the default values by clicking the Reset button.

You cannot modify the default parameters in KFXConverter.ini in an Azure environment.

The KFXConverter settings for document conversion are grouped under the following headings:

GENERAL

Parameter name

Default value

Description

Original document folder

If document conversion fails and path is valid, original file is saved at this path.

Encoding type

UTF-8

If encoding type is defined in the input files, KFXConverter uses the same for converting the documents; otherwise, the default encoding type or the value specified for the EncodingType parameter is used.

The encoding type is only applicable for HTML, MHT and EML file formats.

Enable page header

Selected

If selected, KFXConverter enables the page number displayed on top of each page.

Enable attachment list

Selected

If clear, KFXConverter removes the attachment list from the header of the converted file. Default: True

Debug log

Clear

If selected, KFXConverter logs additional trace statements in the KFXConverter.log file in case of errors or exceptions.

EML2PDF

Parameter name

Default value

Description

Enable margin

Clear

If selected, KfxConverter considers the margin parameters and the parameter PgNmDist from header.

Left margin

3.175 cm

Left margin of page (in centimeters).

Right margin

3.175 cm

Right margin of page (in centimeters).

Top margin

2.54 cm

Top margin of page (in centimeters).

Bottom margin

2.54 cm

Bottom margin of page (in centimeters).

PgNmDist from header

1.3 cm

Page number distance from header (in centimeters).

Resize large images

Resize image based on ratio

Resize the images that are larger in size. Available options are:

  • No image resize: Image is not resized.

    If Resize large images is set to "No image resize" when the input file contains large size images, file conversion may result in data loss.

  • Resize images based on section size: The image size is compared with the section size of the document. If the image size is larger than the section size, image is resized to fit the section.

  • Resize image based on ratio: Free space is calculated based on whether an image is inline or floating. The image resize ratio to fit the page size is calculated as per the longer side of the image, and then the image is resized.

Fit table width to page

Selected

KFXConverter resizes the table width based on the page size in output PDF files when converting EML files (including body with message header).

Fixed column widths

Clear

Resizes the table column width in the output PDF file as per the content in the input HTML file tables.

When column width in an input file table is large, file conversion may result in data loss. To prevent data loss, select this option.

Enable table layout

Selected

If clear, the Aspose API UpdateTableLayout is not used.

Paper orientation

Portrait

The paper orientation.

  • Landscape

  • Portrait

Enable font size

Clear

If selected, KfxConverter considers the "Font size" parameter, and all the converted PDF files will be of the same font size.

Font size

12

Font size in points.

Date format

Blank

Date format. If empty, the default date format is used. Examples:

  • DateFormat="dd-MMM-yy"
  • DateFormat="yyyy-MM-dd"

For more information, refer to the description 'Custom date and time format strings' on Microsoft website.

Depending on the regional settings of your operating system, certain separators are not available. For example, a forward slash configured in the ini file might be replaced with a hyphen as date separator.

Disable VML support

Clear

If selected, KFXConverter disables Aspose API to parse conditional comments in the input document.

PDF2PDF

Parameter name

Default value

Description

ALC web service timeout

1200 sec

Adobe Experience Manager web service timeout in seconds.

TEXT2PDF

Parameter name

Default value

Description

Font type

Arial Unicode MS

Specifies the font type for the generated PDF. The font must be installed on the computer on which KFXConverter is used.

EXCEL2PDF

Parameter name

Default value

Description

Fit all columns to one page

Selected

If selected, all the columns are set to one page.

Paper orientation

Portrait

The paper orientation.

  • Landscape

  • Portrait

Paper size

Default

Disables the Paper size setting.

Convert sheets

All

KFXConverter converts the pages according to the values specified in field. Possible values are: All, Active, 1, 2, 3 and so on. Specify the values as comma separated values.

For example, ConvertSheets=Active,1 converts the first page and the active page, whereas ConvertSheets=All converts all the pages.

If a blank page is selected for conversion and no printable area is selected in excel, KFXConverter ignores this page at the time of conversion. But, if a blank page with defined printable area is selected for conversion, KFXConverter converts this page into PDF.

Enable margin

Clear

If selected, KFXConverter considers the margin parameters.

Left margin

1

Left margin of page (in centimeters).

Right margin

1

Right margin of page (in centimeters).

Top margin

1

Top margin of page (in centimeters).

Bottom margin

1

Bottom margin of page (in centimeters).

Print area

Identifies the printing area in an excel file. Possible values are:

  • Inherit (Default): Inherits the print area from the Excel Worksheet. If a print area is defined in the Worksheet, it will be considered when rendering the document.

  • Disable: Disable the print area. If a print area is defined in the Worksheet, it will be ignored.

HTML2PDF

Parameter name

Default value

Description

Enable margin

Clear

If selected, KFXConverter considers the margin parameters.

Left margin

0.3528 cm

Left margin of page (in centimeters).

Right margin

0.3528 cm

Right margin of page (in centimeters).

Top margin

2.54 cm

Top margin of page (in centimeters).

Bottom margin

2.54 cm

Bottom margin of page (in centimeters).

Resize large images

No image resize

Resize the images that are larger in size. Available options are:

  • No image resize: Image is not resized.

    If set to this option and when the input file contains large size images, file conversion may result in data loss.

  • Resize images based on section size: The image size is compared with the section size of the document. If the image size is larger than the section size, image is resized to fit the section.

  • Resize image based on ratio: Free space is calculated based on whether an image is inline or floating. The image resize ratio to fit the page size is calculated as per the longer side of the image, and then the image is resized.

Resize scale factor percent 100

Apply the scale factor percentage to identify the ratio for resizing large images.

Possible values are from 1 to 100.

Fixed column widths

Clear

Resizes the table column width in the output PDF file as per the content in the input HTML file tables.

When column width in an input file table is large, file conversion may result in data loss. Using this option prevents data loss.

Fit table width to page

Selected

KFXConverter resizes the table width based on the page size in output PDF files when converting EML files (including body with message header).

MHT2PDF

Parameter name

Default value

Description

Enable margin

Clear

If selected, KFXConverter considers the margin parameters.

Left margin

3.175 cm

Left margin of page (in centimeters).

Right margin

3.175 cm

Right margin of page (in centimeters).

Top margin

2.54 cm

Top margin of page (in centimeters).

Bottom margin

2.54 cm

Bottom margin of page (in centimeters).

EXTERNALRESOURCELOADING

Parameter name

Default value

Description

Load external resources

Selected

If clear, when converting EML or MSG documents, KFXConverter does not download any externally linked resource, such as, an image from an internet hyperlink.

PDF2PDFA

Parameter name

Default value

Description

Allowed errors

128

If the Standard option is selected in the PDF to PDF/A conversion engine field in Document Converter, the KFXConverter allows the document conversion with the specific conversion errors.

To ignore one or more conversion errors and allow conversion, set the value of Allowed errors to one error code or to a combination of error codes.

If Allowed errors=0, no error is allowed. All the error codes and all possible values generating from an OR operation of the error codes can be used to ignore one or more document conversion errors.

The following table lists the error codes and description.

Error code Description

4

Visual differences

8

Name collisions of colorants

16

Removing optional content groups (layers)

32

Removing transparency

64

Removing embedded files

128

Removing non-convertible XMP metadata

512

Removing of signatures while normalizing the signed document

4096

Normalizing corrupt input document

16384

Similar font substitution

32768

Removing interactive elements such as actions or annotations

Examples:

  • If Allowed errors = 4, visual differences in the output file do not cause a document conversion error.
  • If Allowed errors = 132, that is, combination of error code 4 and error code128, conversion is done even if there are visual differences in the output file, or non-convertible XMP metadata is removed.

DOC2HTML

Parameter name

Default value

Description

Embed fonts

Clear

If selected, enables KfxConverter to embed font resources into the HTML.

Embed images

Clear

If selected, enables KfxConverter to embed Image data into the HTML.

Original image urls

Clear

If selected, enables KfxConverter to keep external Image URLs intact and not send images in the email, but let the application to load it from external web server.

DOC2PDF

Parameter name

Default value

Description

Accept all revisions

Clear

If selected, KFXConverter accepts all revisions in the document.

Remove comments

Clear

If selected, KFXConverter removes all the comments in the document.

FLATTENXFA

Parameter name

Default value

Description

Try flattening XFA without ALC

Clear

If selected, enables flattening of XFA forms when Adobe Experience Manager is not available. Make sure the Legacy option is selected in the PDF to PDF/A conversion engine field in the Message Connector Configuration.

Kofax recommends that you use Adobe Experience Manager for flattening of XFA forms; use of any other tool may result in an unpredictable output.

SKIPCONVERSION

Parameter name

Default value

Description

Input PDF has attachments

Clear

If selected, the conversion of an input PDF file is skipped if it contains attachments.

Input PDF has unknown fonts

Clear

If selected, the conversion of an input PDF file is skipped if it contains unknown fonts.

Input PDF is a valid PDFA

Clear

If selected, the conversion of an input PDF file is skipped if it is a valid PDF/A document.

Input PDF is signed

Clear

If selected, the conversion of an input PDF file is skipped if it is signed.