Advanced conversion parameters
KFXConverter uses the following order to fetch the configuration values for document conversion:
-
If any of the KFXConverter parameters are modified (that is, non-default) in KC Plug-In destination configuration, Kofax Import Connector uses these values.
-
If default values are not altered in KC Plug-In destination configuration, Kofax Import Connector uses the values configured in the KFXConverter.ini file.
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.
-
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.
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 parameters values.
Parameter | Description | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ANY2PDF | |||||||||||||||||||||||
FallBackToPDF |
If set to True, the output format for any unsuccessful PDF/A normalization/conversion will be set to PDF. Default: False |
||||||||||||||||||||||
DOC2HTML | |||||||||||||||||||||||
EmbedFonts |
If set to True, enables KFXConverter to embed font resources into HTML. Default: False |
||||||||||||||||||||||
EmbedImages | If set to True, enables KFXConverter to embed image resources into HTML. Default: False | ||||||||||||||||||||||
OriginalImageUrls |
If set to True, enables KFXConverter to keep external Image URLs intact and not send images in the email, but lets the application load them from the external web server. Default: False |
||||||||||||||||||||||
DOC2PDF
The "MakeHiddenTextBold", "ItalicizeHiddenText", and "UnderlineHiddenText" parameters are enabled only if
the "ExtractHiddenText" parameter is set to true.
|
|||||||||||||||||||||||
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 |
||||||||||||||||||||||
ExtractHiddenText |
If set to True, KFXConverter extracts the hidden text in the document. Default: False |
||||||||||||||||||||||
MakeHiddenTextBold |
If set to True, the hidden text in the document is highlighted. Default: False |
||||||||||||||||||||||
ItalicizeHiddenText |
If set to True, the hidden text in the document is italicized. Default: False |
||||||||||||||||||||||
UnderlineHiddenText |
If set to True, the hidden text in the document is underlined. Default: False |
||||||||||||||||||||||
EML2PDF | |||||||||||||||||||||||
BottomMargin |
Bottom margin of page (in centimeters). Default: 2.54 |
||||||||||||||||||||||
DateFormat |
Defines the date format. If empty, the default date format is used. Examples:
Depending on the regional settings of your operating system, certain separators are not available. For example, a forward slash might be replaced with a hyphen as a date separator. |
||||||||||||||||||||||
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 If this parameter is set to true, all the text in the converted PDF file will be of same font size.
|
||||||||||||||||||||||
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. |
||||||||||||||||||||||
EnableMargin |
KFXConverter will consider the margin parameters and the PgNmDistFromHeader parameter only if this value is set to True. Default: False |
||||||||||||||||||||||
FitTablesToWindow |
If set to True, the preferred table width is set to 100%. Default: false |
||||||||||||||||||||||
FitTableWidthToPage |
Resize the table width in an output PDF file when converting EML files (including a body with a 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 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 |
||||||||||||||||||||||
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 |
||||||||||||||||||||||
LeftMargin |
Left margin of page (in centimeters). Default: 3.175 |
||||||||||||||||||||||
PaperOrientation |
Defines the paper orientation. Default: -1 Values: for Landscape 0, for Portrait 1. |
||||||||||||||||||||||
PgNmDistFromHeader |
Page number distance from header (in centimeters). Default: 1.3 |
||||||||||||||||||||||
PreserveOriginalDate |
If set to True, retains the original date format (as displayed in the source file) in the output file. Default = False. |
||||||||||||||||||||||
RemoveRedundantObjects |
If set to True, removes the redundant nested and empty canvases. Additionally, neighboring glyphs with similar formatting are concatenated. Default: False |
||||||||||||||||||||||
ResizeLargeImages |
Resize the images that are larger in size. The following options are available:
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 |
||||||||||||||||||||||
EXCEL2PDF | |||||||||||||||||||||||
BottomMargin |
Bottom margin of page (in centimeters). Default: 1 |
||||||||||||||||||||||
ConvertSheets |
KFXConverter will convert the pages according to the values specified in this field, such as All, Active, 1, 2, 3. Specify the values as comma separated values. Default: All For example: ConvertSheets=Active,1 This will convert the first page and the active page. ConvertSheets=All This is will convert all the pages. 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. |
||||||||||||||||||||||
EnableAutoFitColumns |
If set to True, the 'AutoFit Column Width' setting of Excel is applied on the file before conversion. |
||||||||||||||||||||||
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 Values: for Landscape 0, for Portrait 1. |
||||||||||||||||||||||
PaperSize |
If set to default, disables the papersize setting. Default: Default |
||||||||||||||||||||||
PrintArea |
Identifies the printing area in an excel file. Possible values are:
|
||||||||||||||||||||||
RightMargin | Right margin of page (in centimeters). Default: 1 | ||||||||||||||||||||||
TopMargin | Top margin of page (in centimeters). Default: 1 | ||||||||||||||||||||||
IncludeSheetName | If the value is set to True, the Excel sheet names are included as page headers in the converted document. Default: False | ||||||||||||||||||||||
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. |
||||||||||||||||||||||
FLATTENXFA | |||||||||||||||||||||||
RemovePDFSecurity |
If set to true, the input XFA PDF documents with edit password are decrypted before the document conversion. Default: False |
||||||||||||||||||||||
TryFlatteningXFAWithoutALC |
If set to True, 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 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. |
||||||||||||||||||||||
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 |
||||||||||||||||||||||
RemoveBlankPages | If set to True, the blank pages are removed from the following file types during conversion: DOCM, DOCX, DOT, DOTM, DOTX, EML, HTML, LOG, MHT, MHTML, MSG, PDF, POT, POTM, POTX, PPS, PPT, PPSM, PPTM, PPSX, PPTX, ODT, RTF, TXT, XLS, XLSB, XLSM, XLSX, XLT, and XLTM. Default: False | ||||||||||||||||||||||
HTML2PDF | |||||||||||||||||||||||
BottomMargin |
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 |
||||||||||||||||||||||
EnableTableLayout |
If set to False, the Aspose API UpdateTableLayout is not used. Default: True |
||||||||||||||||||||||
FitTablesToWindow |
If set to True, sets the preferred width for the tables to 100%. 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 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. |
||||||||||||||||||||||
ProcessHTMLTable |
If set to True, sets the width of all the table cells to be equal. This setting only applies to HTML files that contain tables with <hr> tags. Default: False |
||||||||||||||||||||||
LeftMargin |
Left margin of page (in centimeters). Default: 0.3528 |
||||||||||||||||||||||
RemoveRedundantObjects |
If set to True, removes the redundant nested and empty canvases. Additionally, neighboring glyphs with similar formatting are concatenated. Default: false |
||||||||||||||||||||||
ResizeLargeImages |
Resize the images that are larger in size. Default: 2 The following options are available:
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 | |||||||||||||||||||||||
BottomMargin |
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 |
||||||||||||||||||||||
FitTablesToWindow |
If set to True, sets the preferred width for the tables to 100%. Default: false |
||||||||||||||||||||||
LeftMargin |
Left margin of page (in centimeters). Default: 3.175 |
||||||||||||||||||||||
RemoveRedundantObjects |
If set to True, removes the redundant nested and empty canvases. Additionally, neighboring glyphs with similar formatting are concatenated. Default: false |
||||||||||||||||||||||
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.
See Handle PDF/A normalization errors using AllowedErrors parameter. For example,
|
||||||||||||||||||||||
PDFCONCATENATION
These parameters are only applicable if the "Concatenate multiple PDF files" option on the "Advanced
conversion and import" tab in "Destination configuration" is set to "Import concatenated PDF only" or "Import concatenated and
individual PDF files".
|
|||||||||||||||||||||||
EnableBookMarks |
If set to True, the first page of each PDF in the PDF batch is added as a bookmark in the concatenated PDF. Default: False Additionally, the existing bookmarks if any in each PDF file are retained in the concatenated PDF. |
||||||||||||||||||||||
EnablePageNumber |
If set to True, the pages are numbered in the concatenated PDF. Default: False The page number is displayed as "current page of total pages", For example, "4 of 20". Additionally, all the PDF files in the batch are numbered individually. For example, if 4 PDFs are concatenated, each PDF file in the combined (concatenated) PDF is numbered individually: If the first PDF file contains 40 pages, the pages are numbered as "25 of 40", and for the second PDF file with 100 pages, the page number starts a fresh, such as "20 of 100". |
||||||||||||||||||||||
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 | |||||||||||||||||||||||
BottomMargin | Bottom margin of page (in centimeters). Default: 2.5 | ||||||||||||||||||||||
EnableLegacyConversion |
By default, the new conversion method is used; to revert to the old method, set the flag to True. Default: False |
||||||||||||||||||||||
FontSize | Font size in points. Default: 9 | ||||||||||||||||||||||
FontType |
Specify the font type for the generated PDF. The font must be installed on the computer on which KFXConverter is used. Default:
|
||||||||||||||||||||||
LeftMargin | Left margin of page (in centimeters). Default: 3.2 | ||||||||||||||||||||||
LineSpacing | Space between each line in a paragraph in points. Default: 8 | ||||||||||||||||||||||
Pagesize | Page size. Default: 4 (A4) | ||||||||||||||||||||||
RightMargin | Right margin of page (in centimeters). Default: 3.0 | ||||||||||||||||||||||
TopMargin | Top margin of page (in centimeters). Default: 2.5 |