Configure KFXConverter
By default, each document conversion profile uses the default KFXConverter settings for document conversion.
You can modify the 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 the path is valid, the 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. |
|
Remove blank pages |
False |
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. |
ANY2PDF
|
Parameter name |
Default value |
Description |
|---|---|---|
|
Fall back to PDF |
False |
If set to True, fall backs the PDF conversion when PDFA conversion fails. This option can be used for any input file type. |
EML2PDF
|
Parameter name |
Default value |
Description |
|---|---|---|
|
Bottom margin |
2.54 cm |
The bottom margin of the page (in centimeters). |
|
Date format |
Blank |
Date format. If empty, the default date format is used. Examples:
For more information, refer to the description "Custom date and time format strings" on the 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 a date separator. |
|
Disable VML support |
Clear |
If selected, KFXConverter disables the Aspose API to parse conditional comments in the input document. |
| Conversion engine | Default |
Defines the conversion engine used. Values:
This parameter is supported by
Tungsten TotalAgility
8.1 and higher.
|
|
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. |
|
Enable font type |
False |
If set to True, KfxConverter considers the "Font type" parameter, and all the converted PDF files will be in the same font type. |
|
Enable margin |
Clear |
If selected, KfxConverter considers the margin parameters and the pgNmDist parameter from the header. |
|
Enable table layout |
Selected |
If clear, the Aspose API UpdateTableLayout is not used. |
|
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. |
| Fit tables to window | False | If set to True, sets the preferred width of the table to 100%. |
|
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 the body with the message header). |
|
Font size |
12 |
Font size in points. |
|
Font type |
Arial Unicode MS | The font type defined is used when the "Enable font type" parameter is set to True. |
|
Left margin |
3.175 cm |
The left margin of the page (in centimeters). |
| Page size | Default | Defines the page size of the output file.
Values:
|
| Page orientation | Default | Sets the orientation of the output file
page.
Values:
|
|
PgNmDist from header |
1.3 cm |
Page number distance from the header (in centimeters). |
| Remove redundant objects | False | If set to True, the redundant nested canvases and empty canvases are removed, and the adjacent glyphs with the same formatting are concatenated. |
|
Resize large images |
Resize image based on ratio |
Resize the images that are larger in size. Available options are:
|
| Preserve original date | False | Preserves the original date of the message. |
|
Right margin |
3.175 cm |
The right margin of the page (in centimeters). |
|
Top margin |
2.54 cm |
The top margin of the page (in centimeters). |
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 |
|---|---|---|
|
Bottom margin |
1 |
The bottom margin of the page (in centimeters). |
|
Convert sheets |
All |
KFXConverter converts the pages according to the values specified in the 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 the defined printable area is selected for conversion, KFXConverter converts this page into a PDF. |
| Enable auto fit columns | False | If set to True, the "Auto Fit Column Width" setting is applied. |
|
Enable margin |
Clear |
If selected, KFXConverter considers the margin parameters. |
|
Fit all columns to one page |
Selected |
If selected, all the columns are set to one page. |
| Include sheet name | False | If set to True, the current sheet name is included as a page header in the output document. |
| Page orientation | Default | Sets the orientation of the output file
page.
Values:
|
|
Paper size |
Default |
Disables the Paper size setting. |
|
Print area |
The bottom margin of the page (in centimeters) Identifies the printing area in an excel file. Possible values are:
|
|
|
Left margin |
1 |
The left margin of the page (in centimeters). |
| Recalculate on open | False | If set to True, re-calculates all the formulas in the worksheet. |
|
Right margin |
1 |
The right margin of the page (in centimeters). |
|
Top margin |
1 |
The top margin of the page (in centimeters). |
HTML2PDF
|
Parameter name |
Default value |
Description |
|---|---|---|
|
Bottom margin |
2.54 cm |
The bottom margin of the page (in centimeters). |
|
Enable margin |
Clear |
If selected, KFXConverter considers the margin parameters. |
| Enable table layout | True | Updates the table layout. |
|
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 the body with the message header). |
| Fit tables to window | False | If set to True, sets the preferred width of the table to 100%. |
| Conversion engine | Default |
Defines the conversion engine used. Values:
This parameter is supported by
Tungsten TotalAgility
8.1 and higher.
|
|
Left margin |
0.3528 cm |
The left margin of the page (in centimeters). |
| Left margin for HTML engine | 2.25 | Defines the left margin of the output.
This parameter is applicable only when the EMLConversionEngine parameter is set to 2. |
| Page orientation | Default | Sets the orientation of the output file
page.
Values:
|
| Page size | Default | Defines the page size of the output file.
Values:
|
| Process HTML table | False | If set to True, the HTML file is processed to keep the width of all table cells equal. |
| Remove redundant objects | False | If set to True, the redundant nested canvases and empty canvases are removed, and the adjacent glyphs with the same formatting are concatenated. |
|
Resize large images |
No image resize |
Resize the images that are larger in size. Available options are:
|
| 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. |
|
Right margin |
0.3528 cm |
The right margin of the page (in centimeters). |
| Right margin for HTML engine | 2.25 | Defines the right margin of the output.
This parameter is applicable only when the EMLConversionEngine parameter is set to 2. |
|
Top margin |
2.54 cm |
The top margin of the page (in centimeters). |
MHT2PDF
|
Parameter name |
Default value |
Description |
|---|---|---|
|
Bottom margin |
2.54 cm |
The bottom margin of the page (in centimeters). |
|
Enable margin |
Clear |
If selected, KFXConverter considers the margin parameters. |
| Fit tables to window | False | If set to True, sets the preferred width of the table to 100%. |
|
Left margin |
3.175 cm |
The left margin of the page (in centimeters). |
| Conversion engine | Default |
Defines the conversion engine used. Values:
This parameter is supported by
Tungsten TotalAgility
8.1 and higher.
|
| Page size | Default | Defines the page size of the output file.
Values:
|
| Remove redundant objects | False | If set to True, the redundant nested canvases and empty canvases are removed, and the adjacent glyphs with the same formatting are concatenated. |
|
Right margin |
3.175 cm |
The right margin of the page (in centimeters). |
|
Top margin |
2.54 cm |
The top margin of the page (in centimeters). |
EXTERNALRESOURCELOADING
|
Parameter name |
Default value |
Description |
|---|---|---|
|
Load external resources |
Selected |
When converting EML or MSG documents, KFXConverter downloads any externally liked 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 document conversion with specific conversion errors. To ignore one or more conversion errors and allow conversion, set the value of Allowed errors to one error code or a combination of error codes. The following table lists the error codes and their descriptions.
Examples:
If no error is allowed (the “Allowed errors” field is empty), all the error codes and all possible values generated from an OR operation of the error codes can be used to ignore one or more document conversion errors. |
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 lets the application load it from the external web server. |
DOC2PDF
|
Parameter name |
Default value |
Description |
|---|---|---|
|
Accept all revisions |
Clear |
If selected, KFXConverter accepts all revisions in the document. |
|
Extract hidden text |
Clear |
If selected, KFXConverter extracts the hidden text in the document. |
| Italicize hidden text | False | If set to True, the hidden text is italicized. |
| Make hidden text bold | False | If set to True, the hidden text is made bold. |
|
Remove comments |
Clear |
If selected, KFXConverter removes all the comments in the document. |
| Underline hidden text | False | If set to True, the hidden text is underlined. |
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. Tungsten Automation recommends that you use Adobe Experience Manager for flattening XFA forms; using any other tool may result in an unpredictable output. |
| Remove PDF security | False | If set to True, removes the security feature of the XFA files that fail to convert. |
| Retain PDF form state | False | If set to True, retains the form state of the PDF during PDF flattening. |
PDFCONCATENATION
|
Parameter name |
Default value |
Description |
|---|---|---|
| Enable bookmarks | Clear |
If set to True, the first page of each PDF in the PDF batch is added as a bookmark in the concatenated PDF. Additionally, the existing bookmarks if any in each PDF file are retained under the newly created bookmarks in the concatenated PDF. |
| Enable page number | Clear |
If set to True, the pages are numbered in the concatenated PDF. The page number is displayed on the bottom of the page 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
|
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 PDF/A |
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. |