Advanced conversion parameters

KFXConverter uses the following order to fetch the configuration values for document conversion:

  1. If any of the KFXConverter parameters are modified (that is, non-default) in KC Plug-In destination configuration, Kofax Import Connector uses these values.

  2. If default values are not altered in KC Plug-In destination configuration, Kofax Import Connector uses the values configured in the KFXConverter.ini file.

    Note To configure the same KFXConverter setting across all destinations, modify the necessary parameters in the KFXConverter.ini file and do not configure values in KC Plug-In destination configuration.

  3. If the KFXConverter.ini file is not available, Kofax Import Connector uses the values configured in KFXConverter_default.ini file.

Configure the Kofax Converter (KFXConverter) parameters by editing the following parameters.

Note When you upgrade Kofax Import Connector from version 2.7.0.3 or lower, any modified parameters values does not change. Any values changed here will override the existing the existing parameters values.

Parameter Description
DOC2HTML
EmbedFonts If set to True, enables KFXConverter to embed font resources into the HTML. Default: False
EmbedImages If set to True, enables KFXConverter to embed image resources into the HTML. Default: False
OriginalImageUrls

If set to True, 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. Default: False

DOC2PDF
AcceptAllRevisions

If set to True, KFXConverter accepts all revisions in the document. Default: False

RemoveComments

If set to True, KFXConverter removes all the comments in the document. Default: False

EML2PDF
BottomMargin

Bottom margin of page (in centimeters). Default: 2.54

DisableVMLSupport If set to True, KFXConverter disables Aspose API to parse conditional comments in the input document. Default: False
EnableFontSize

KFXConverter will consider "FontSize" parameter only if this value is set to true. Default: False

Note If this parameter is set to true, all the text in the converted PDF file will be of same font size.

EnableMargin

KFXConverter will consider the margin parameters and the parameter PgNmDistFromHeader only if this value is set to True. Default: False

EnableTableLayout

If set to False, the Aspose API UpdateTableLayout is not used. Default: True

FitTableWidthToPage

Resize the table width in an output PDF file when converting EML files (including body with message header). Default: True

If set to true, KFXConverter sets the table width based on the page size in output PDF files.

FixedColumnWidths

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

Note When column width in an input file table is large, file conversion may result in data loss. To prevent data loss, set FixedColumnWidths to True.

FontSize

Font size in points. Default: 12

LeftMargin

Left margin of page (in centimeters). Default: 3.175

PaperOrientation

Defines the paper orientation. Default: -1

For Landscape 0, for Portrait 1.

PgNmDistFromHeader

Page number distance from header (in centimeters). Default: 1.3

ResizeLargeImages

Resize the images that are larger in size. The following options are available:

  • 0 - Image is not resized.

  • 1 - 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.

  • 2 - 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.

Note When the input file contains large size images and if ResizeLargeImages is set to 0, file conversion may result in data loss.

RightMargin

Right margin of page (in centimeters). Default: 3.175

TopMargin

Top margin of page (in centimeters). Default: 2.54

EnableFontType

If EnableFontType is set to True, the specified FontType is applied to both email body and header at the time of conversion. Default: false

By default, the FontType is not applied to the email body and header.

FontType

Specify the output font type for the email body and header. The specified font must be installed on the computer where KFXConverter is used. Default: Arial Unicode MS

EXCEL2PDF
BottomMargin

Bottom margin of page (in centimeters). Default: 1

ConvertSheets

KFXConverter will convert the pages according to the values specified in field. Possible values are All, Active, 1, 2, 3 an so forth. Specify the values as comma separated values. Default: All

For example:

ConvertSheets=Active,1

This is will convert the first page and the active page.

ConvertSheets=All

This is will convert all the pages.

Note If a blank page is selected for conversion and no printable area is selected in excel, this page will be ignored at the time of conversion. But, if a blank page with defined printable area is selected for conversion, KFXConverter will convert this page into PDF.
EnableMargin

KFXConverter will consider the margin parameters only if this value is set to true. Default: False

FitAllColumnsToOnePage

All the columns are set to one page if this value is set to true. Default: True

LeftMargin

Left margin of page (in centimeters). Default: 1

PaperOrientation

Defines the paper orientation. Default: -1

For Landscape 0, for Portrait 1.

PaperSize

If set to default, this will disable the papersize setting. Default: Default

PrintArea

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.

RightMargin Right margin of page (in centimeters). Default: 1
TopMargin Top margin of page (in centimeters). Default: 1
EXTERNALRESOURCELOADING
LoadExternalResources

If set to False, when converting EML or MSG documents, KFXConverter does not download any externally linked resource. Default: True

For example, if LoadExternalResources = false, KFXConverter will not download an image from an internet hyperlink.

GENERAL
DebugLog

If set to True, KFXConverter logs additional trace statements in the KFXConverter.log file in case of errors or exceptions. Default: False

To manage KFXConverter log files, see Log files.

EnableAttachmentList

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

EnablePageHeader

If EnablePageHeader=false, it will disable the page number displayed on top of each page. Default: True

EncodingType

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. Default: UTF-8

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

OriginalDocumentFolder

If document conversion is failed and path is valid, original file is saved at this path. Default: True

HTML2PDF
BottonMargin

Bottom margin of page (in centimeters). Default: 2.54

EnableMargin

KFXConverter will consider the margin parameters only if this value is set to true. Default: False

FitTableWidthToPage Fits the table to page width. Default: True
FixedColumnWidths

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

Note When column width in an input file table is large, file conversion may result in data loss. To prevent data loss, set FixedColumnWidths to true.

LeftMargin Left margin of page (in centimeters). Default: 0.3528
ResizeLargeImages

Resize the images that are larger in size. Default: 2

The following options are available:

  • 0 - Image is not resized.

  • 1 - 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.

  • 2 - 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.

Note When the input file contains large size images and if ResizeLargeImages is set to 0, file conversion may result in data loss.
ResizeScaleFactorPercent

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

Possible values 1 to 100.

RightMargin

Right margin of page (in centimeters). Default: 0.3528

TopMargin

Top margin of page (in centimeters). Default: 2.54

MHT2PDF
BottonMargin

Bottom margin of page (in centimeters). Default: 2.54

EnableMargin

KFXConverter will consider the margin parameters only if this value is set to true. Default: False

LeftMargin

Left margin of page (in centimeters). Default: 3.175

RightMargin

Right margin of page (in centimeters). Default: 3.175

TopMargin

Top margin of page (in centimeters). Default: 2.54

PDF2PDF
ALCWebServiceTimeout

Adobe Experience Manager web service timeout in seconds. Default: 1200

PDF2PDFA
AllowDowngrade If the input PDF file format is not compatible to be converted to the required output format, the actual output format will be downgraded. Default: True
AllowedErrors

If Standard is selected in PDF to PDF/A conversion engine in Message Connector, then KFXConverter allows the document conversion with the specific conversion errors. To allow one or more conversion errors at the time of conversion, set the value of AllowedErrors to one error code or a combination of error codes. If AllowedErrors=0, no error is allowed at the time of document conversion. Default: 128

All the error codes and all possible values generating from an OR operation of the following error codes can be used to ignore one or more document conversion errors.

Error code

Description

4

Allows visual differences in output file

8

Allows resolving name collisions of colorants (PDF/A-2 and PDF/A-3 only)

16

Allows removing optional content groups (layers). For PDF/A-1 only.

32

Allows removing transparency. For PDF/A-1 only.

64

Allows removing embedded files

128

Allows removing non-convertible XMP metadata

512

Allows removing all signatures while normalizing the signed document. The conversion of a file to PDF/A invalidates all signatures of the input file.

4096

Allows normalizing corrupt input document

16384

Allows substituting similar font when the same font is not available for embedding.

32768

Allows removing interactive elements such as actions or annotations

See Handle PDF/A normalization errors using AllowedErrors parameter.

For example,

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

If set to True, the conversion of an input PDF file is skipped if it has attachments. Default: False

InputPDFhasUnknownFonts

If set to True, the conversion of an input PDF file is skipped if it contains unknown fonts. Default: False

InputPDFisaValidPDFA

If set to True, the conversion of an input PDF file is skipped if it is a valid PDF/A document. Default: False

InputPDFisSigned

If set to True, the conversion of an input PDF file is skipped if it is signed. Default: False

TEXT2PDF
FontType

Specify the font type for the generated PDF. The font must be installed on the computer on which KFXConverter is used. Default: Arial Unicode MS