Processing Options¶

Name

Description

Applies To

ARCHIVE_IGNORE_CHECKSUM

Enable or disable checksum validation for extracted archive files.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

BMP_IGNORE_MEMORY_LIMITS

Enable or disable enforced memory limits when processing large images.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

BW_MODE

Set the value of Black-and-White Algorithm. [-1 .. 7]

Type: string

Default: -1

document

CAD_PAGE_HEIGHT

Set the default page height in points for CAD documents with unknown page information.

Type: number:pixel

Default: 0

canvas

CLIP_ENUMERATE

Enable or disable enumeration of attachments when processing Microsoft Clipboard files.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

CODEPAGE

Specify the default character set for documents with unspecified encoding.

Type: number

Default: 0

document

CONTAINERS_LIST_DIR

Enable or disable the rendering of container directories when rendering to hi-def.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

CSV_COLLAPSE_ROWS

Set how repeating rows may be collapsed when generating CSV output. Can be boolean value, or number.

Type: string

document

CSV_MAX_REPEATING_CELLS

Set the maximum number of repeating empty cells to include in CSV output.

Type: number

Default: 512

document

CSV_TRIM_EMPTY_CELLS

Enable or disable trimming of empty trailing cells in CSV output.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

document

DBF_TABLE_VIEW

Set the output type when processing dBase database files. 1 flattens memo fields into a single output; 1 treats memos as sub-files.

Type: number

Default: 1

document

DEFAULT_LCID

Set the value of locale used for date conversion.

Type: number

Default: 0

document

DETECT_MACROS

Enable or disable reporting macro presence as meta data.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

DETECT_MACROS_ALWAYS_REPORT

Enable or disable reporting of macro detection as metadata. When enabled, macro detection is always reported, even if no macros are found. When disabled, macros are reported only when present.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

DICOM_SHOW_OFFSET

Enable or disable the display of byte offsets for DICOM elements in the extracted metadata output.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

DICOM_SHOW_SIZES

Enable or disable the inclusion of data sizes for DICOM elements in the extracted metadata output.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

DICOM_SHOW_TAGS

Enable or disable the display of DICOM tags in the extracted metadata output.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

DICOM_SHOW_TYPE

Enable or disable the inclusion of DICOM element types in the extracted metadata output.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

DOCUMENT_FOOTERS

Enable or disable adding page footers to hi-def output

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

document

DOCUMENT_HEADERS

Enable or disable adding page headers to hi-def output.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

document

EMAILMODE

Set which email headers to include in the output when processing email files (EML, MSG, PST).

Type: string:enum

Default: VisibleHeaders

Possible Values: ['VisibleHeaders', 'AllHeaders', 'MapiHeaders']

document

EMAIL_ATTACHMENT_LINKS

[ClassicHTML] When set, this replaces the "Attachments:" value in the HTML body of an email. For each attachment, the subfile-id will be placed where "$$$" or "$$!" is found in the template and the result will be put in the "HREF" attribute of an "A" tag. Using $$$ will put double quotes around the subfile-id.

Type: string

document

EMAIL_DATE_FORMAT

Specify the output format when processing date fields in email messages. The following values will be substituted:

Code	Description
d	day
dd	day (padded)
ddd	day name (abbr)
dddd	day name
ddddd	short day/time
dddddd	long day/time
m	month
mm	month (padded)
mmm	month name (abbr)
mmmm	month name
yy	year (2-digit)
yyyy	year (4-digit)
h	hour
hh	hour (padded)
n	minute
nn	minute (padded)
s	second
ss	second (padded)
z	millisecond
zzz	millisecond (padded)
t	short day/time
tt	long day/time
tz	timezone
am/p	am or pm
a/	am or pm
ampm	am or pm
/	date separator
:	time separator
'xx'/"xx"	literal string

Type: string

Default: ddd, d mmm yyyy h:nn:ss ampm tz

document

EMAIL_DATE_TIMEZONE_OFFSET

Specify a timezone offset for email date fields. Accepts LOCAL, UTC, GMT, or values in +hhmm/-hhmm format.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

EMAIL_FONT_FAMILY_OVERRIDE

Set the value of font family to change the default font used when rendering email messages.

Type: string

document

EMAIL_FONT_SIZE_OVERRIDE

Changes the default font size used when rendering email messages.

Type: number

Default: 0

document

EMAIL_OUTPUT_HEADER

Enable or disable the injected header of email messages.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

document

ENCODING_DETECTION

Enable or disable automatic detection of text encoding in documents.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

document

ENCODING_DETECTION_BUFFER

Specify the buffer size (in bytes) used for encoding detection. Larger buffers improve accuracy but may impact performance.

Type: number

Default: 1024

document

ENCODING_DETECTION_CONFIDENCE

Set the confidence threshold (0-100) for automatic encoding detection. Higher values reduce false positives but may miss some encodings.

Type: number

Default: 0

document

ENUMERATE_IMAGES

Enable or disable image enumeration as subfiles.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

ENUMERATE_IMAGES_PDF_TYPE

Set the value of image type to output when processing PDF with ENUMERATE_IMAGES on.

Type: string:enum

Default: AUTO

Possible Values: ['JPG', 'PNG', 'PPM', 'AUTO']

document

EXCELMODE

Set the value of output mode for spreadsheet file processing.

Type: string:enum

Default: TEXT

Possible Values: ['TEXT', 'CSV', 'TSV', 'CST']

document

EXCELMODE_TEXT_FALLBACK

Enable or disable string-only extraction on a document that cannot be converted to CSV.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

EXCEL_PAGEBREAK_BETWEEN_SHEETS

Enable or disable page-break markers between sheets when exporting to CSV

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

EXTRACT_EMBEDDED_NAME

Enable or disable extraction of embedded file names when sub-enumerating attachments in MS Office files.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

FIRST_PAGE

Set the first page to process from.

Type: number

Default: 0

document

GIF_DECODE_ALL_FRAMES

Enable or disable decoding of all frames of a GIF.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

GIF_INTERLACED

Enable or disable interlaced GIF creation.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

canvas

GRAPHICS_ANTIALIAS

Enable or disable anti-aliasing support for hi-def output.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

document, canvas

GRAPHICS_AUTOHINT

Enable or disable auto-hinting on the canvas

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document, canvas

GRAPHICS_DITHER

Enable or disable dithering for lower color output types.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document, canvas

GRAPHICS_TEXTEMBEDDEDBITMAP

Enable or disable embedded text bitmap support in hi-def output.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document, canvas

GRAPHICS_TEXTKERNING

Enable or disable text kerning support for hi-def output.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

document, canvas

GRAPHICS_TEXTLCD

Enable or disable text LCD support for hi-def output.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document, canvas

GRAPHICS_TEXTLINEAR

Enable or disable linear text support in hi-def output.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

document, canvas

GRAPHICS_TEXTSUBPIXEL

Enable or disable sub-pixel placement of text in hi-def output.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document, canvas

GRAPHIC_BMP_DPI

Enable or disable using BMP source image DPI for full page images.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

GRAPHIC_DESATURATE

Enable or disable converting images to grayscale.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

GRAPHIC_DESKEW

Enable or disable deskew of slightly rotated images with scanned text.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

GRAPHIC_DESPECKLE

Enable or disable noise reduction using a median filter.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

GRAPHIC_DPI

Set the dots per inch value for output images. Use AUTO to preserve original DPI.

Type: number

Default: 96

document, canvas

GRAPHIC_DPI_MAX

Set the maximum dots per inch for auto-adjusted graphics when GRAPHIC_DPI=Auto

Type: number

Default: 0

document

GRAPHIC_DPI_MIN

Set the maximum dots per inch for Auto mode graphic when GRAPHIC_DPI=Auto

Type: number

Default: 0

document

GRAPHIC_EFFECT

Set the value of graphic effects applied to image output.

Type: string:enum

Possible Values: ['GRAYSCALE,', 'DESATURATE']

canvas

GRAPHIC_HAIRLINE_SUBPIXEL

Enable or disable sub-pixel rendering.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

canvas

GRAPHIC_HEIGHT

Set the height of the generated page in pixels. The width will be determined by the aspect ratio if not specified.

Type: number:pixel

Default: -1

document, canvas

GRAPHIC_MAX_WIDTH

Set the maximum image size for rasterized vector formats like PDF and AutoCAD.

Type: number:pixel

Default: 3000

document, canvas

GRAPHIC_OUTPUT_WITH_ALPHA

Enable or disable inclusion of alpha channel in hi-def output images.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

canvas

GRAPHIC_PNG_JPEG_DPI

Enable or disable using PNG and JPEG source image DPI for full page images.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

GRAPHIC_ROTATE

Set the value of page rotation angle.

Type: string:enum

Default: 0

Possible Values: ['0', '90', '180', '270']

document, canvas

GRAPHIC_WIDTH

Set the width of the generated page in pixels. If height is not specified, it will be calculated based on the input document's aspect ratio.

Type: number:pixel

Default: -1

document, canvas

HDHTML_ACCESSIBILITY

Enable or disable the inclusion of accessibility information in HTML output.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

canvas

HDHTML_IMAGE_FORMAT

Set the value of image format for embedded images in HTML5 output.

Type: string:enum

Possible Values: ['png', 'jpg', 'jpeg', 'gif', 'auto']

canvas

HDHTML_INCLUDE_TAB_LEADER

Enable or disable the inclusion injected tab leaders as separate words with a data-tableader attribute.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

canvas

HDHTML_INCLUDE_WORD_INDEXES

Enable or disable the inclusion word coordinates in HTML output.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

canvas

HDHTML_OUTPUT_BOILERPLATE

Enable or disable generation of HTML boilerplate.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

document

HDHTML_OUTPUT_INJECT_FOOTER

Set the value of HTML content to inject in the footer section of generated html output.

If the value begins with an '@' symbol and points to a file on disk located in a "safe directory", the contents of that file will be injected. A safe directory is one specified by the environment variable ISYS_HDHTML_OUTPUT_INJECT_SAFE_PATHS or within the ISYS11df.ini file under the "HDHTML_OUTPUT_INJECT_SAFE_PATHS" section. For raw HTML input, ensure the content is wrapped in double quotes, with single quotes used within the HTML itself.

Type: string

canvas

HDHTML_OUTPUT_INJECT_HEAD

Set the value of HTML content to inject in the HEAD section of generated html output.

If the value begins with an '@' symbol and points to a file on disk located in a "safe directory", the contents of that file will be injected. A safe directory is one specified by the environment variable ISYS_HDHTML_OUTPUT_INJECT_SAFE_PATHS or within the ISYS11df.ini file under the "HDHTML_OUTPUT_INJECT_SAFE_PATHS" section. For raw HTML input, ensure the content is wrapped in double quotes, with single quotes used within the HTML itself.

Type: string

canvas

HDHTML_OUTPUT_STYLES

Enable or disable generation of style sections for HD-HTML output.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

document

HDHTML_TITLE

Set the value of HTML title for generated HDHTML.

Type: string

canvas

HDHTML_WORD_RUNS

Enable or disable feature that merges similar styled words into a single run.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

canvas

HOCR

Enable or disable inclusion of HOCR attributes when producing HTML or XML files in hi-def modes.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

HTML_CHARSET

Specify the character encoding to use when processing HTML content.

Type: string

document

HTML_DECODE_ENTITIES

Enable or disable decoding of HTML entities when extracting text.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

HTML_IMAGES_SCALE_TO_FIT

Enable or disable forced downscaling of images attached to emails and messages.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

HTML_INLINE_IMAGES

Enable or disable embedding inline image handling in HTML output.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

canvas

HTML_MAX_FILESIZE

Set the maximum size, in bytes, of a HTML document for error-free processing. Larger documents may result in errors when processed.

Type: number

Default: 20971520

document

HTML_MAX_NESTED_TABLES

Set the value of the maximum number of nested tables allowed before an error is raised.

Type: number

Default: 150

document

HTML_RASTER_TEXT

Enable or disable the rasterization of text from HTML files into flat images when processing.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document, canvas

HTML_SCRIPT

[ClassicHTML] Used in conjunction with EMAIL_ATTACHMENT_LINKS to inject text into the output HTML to provide supporting code for the attachment link handling.

Type: string

document

HTML_TEXT_OVERLAY

Enable or disable text overlays when creating hi-def HTML output.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

document, canvas

HTML_TITLE_AS_META

Enable or disable treating the HTML title as metadata during extraction.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

document

HTML_TITLE_SUPPRESS

Enable or disable suppression of the HTML title from extracted output.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

HTTP_EXTERNAL_IMAGES

Enable or disable image downloading for HTML documents in hi-def mode.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

HTTP_PROXY

Set the value of HTTP proxy server to use for downloading images in HTML documents when external images are allowed.

Type: string

document

HTTP_PROXY_BYPASS

Set the value of bypassed proxy servers that should not use the proxy setting.

Type: string

document

ICS_MODE

Set the output type when processing ICS calendar items.

Type: string:enum

Possible Values: ['', 'JSON']

document

IMAGEURL

Set the value of image filename prefix.

Type: string

canvas

IMAGE_PROCESSOR

Set the value of image processor to control how embedded images are processed.

Type: string:enum

Default: builtin

Possible Values: ['builtin', 'gdi', 'gdiplus', 'gdi+']

document

IMNET_CHAR_SPACING

Set the inter-character spacing for IMNET overlays to a specific point value.

Type: number:point

Default: 0

document

IMNET_LINE_HEIGHT

Set the height of each line for IMNET overlays in points.

Type: number:point

Default: 0

document

IMNET_OFFSET_X

Set the horizontal offset for IMNET overlays in points.

Type: number:point

Default: 0

document

IMNET_OFFSET_Y

Set the vertical offset for IMNET overlays in points.

Type: number:point

Default: 0

document

IMNET_OVERLAY_DIR

Set the directory where IMNET overlays are searched for.

Type: string

document

IMNET_OVERLAY_EXTS

Set the value of IMNET overlay extensions to search for, delimited by comma.

Type: string

document

IMNET_OVERLAY_FILE

Set the value of overlay image.

Type: string

document

ISOBMFF

Set the output type when processing ISOBMFF based file types.

Type: string:enum

Possible Values: ['', 'JSON']

document

ISYS_SOURCE

Set the original file path and filename of the source document for enhanced file type identification. The file does not need to be accessible from this location.

Type: string

document

JPEG_ENCODER

Set the value of image encoder to use for JPEG files, applicable on Windows with WIC.

Type: string:enum

Default: NATIVE

Possible Values: ['NATIVE', 'WIC']

canvas

JPEG_QUALITY

Set the quality of generated JPEG images to an integer from 1 to 100. A higher value produces a more detailed image.

Type: number

Default: 100

canvas

JPEG_REORIENT_PAGES

Enable or disable reorienting JPEG images to display top-down, left-to-right.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

JSON_CLEAN_CONTENT

Set the value of unordered list of cleaning functions to apply to each element's text when generating simplified JSON output.

Type: string:enum

Possible Values: ['', 'clean_non_ascii_chars', 'normalize_quotes']

canvas

JSON_FORMAT_OUTPUT

Enable or disable adding new lines and indentation to JSON output.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

canvas

JSON_IMAGE_FORMAT

Set the value of image format for embedded images in JSON output.

Type: string:enum

Default: PNG

Possible Values: ['PNG']

canvas

JSON_IMAGE_QUALITY

Set the image compression quality for embedded images in JSON output.

Type: number

Default: 90

canvas

JSON_INCLUDE_BOOKMARKS

Controls if bookmarks should be included in JSON output.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

canvas

JSON_INCLUDE_BOUNDS

Enable or disable inclusion of element bounds information in JSON output.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

canvas

JSON_INCLUDE_DOC_METADATA_PER_ELEMENT

Enable or disable the inclusion of document-level metadata for each element of simplified JSON output.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

canvas

JSON_INCLUDE_ELEMENT_ID

Enable or disable the inclusion of an element id when generating simplified JSON output.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

canvas

JSON_INCLUDE_FORMS

Enable or disable inclusion of page form information in JSON output.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

canvas

JSON_INCLUDE_IMAGES

Enable or disable including image elements in JSON output.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

canvas

JSON_INCLUDE_IMAGE_DATA

Enable or disable including image data in JSON output.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

canvas

JSON_INCLUDE_METADATA

Enable or disable inclusion of document metadata in JSON output.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

canvas

JSON_INCLUDE_STYLES

Enable or disable inclusion of element style information in JSON output.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

canvas

JSON_INCLUDE_WHITESPACE

Enable or disable inclusion of whitespace words in JSON output.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

canvas

JSON_INCLUDE_WORDS

Enable or disable inclusion of word-level information in JSON output.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

canvas

JSON_OUTPUT_SCHEMA

Set the output schema type to use when generating JSON.

Type: string:enum

Default: FULL

Possible Values: ['FULL', 'PIPELINE', 'UNSTRUCTURED']

canvas

JSON_SKIP_EMPTY_PARAGRAPHS

Enable or disable inclusion of empty paragraphs in JSON output.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

canvas

LAYOUT_LOCALE

Set the value of locale used for document processing.

Type: string

document

LIMITS_PAGE_COUNT

Set the maximum number of pages to process. Any excess pages will result in an error.

Type: number

Default: 1000

document

LIMIT_PAGES

Set the maximum number of pages to process, ideal for generating thumbnails.

Type: number

Default: -1

document

LOCALTIME_CONVERSION

Enable or disable the conversion of local times to UTC when no timezone is provided.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

document

MARKDOWN_CLEAN_CONTENT

Set the value of unordered list of cleaning functions to apply to the text of each block, paragraph, or element when generating Markdown.

Type: string:enum

Possible Values: ['', 'clean_non_ascii_chars', 'normalize_quotes']

canvas

MARKDOWN_COMPLEX_TABLE_STYLE

Set the style for rendering complex tables in Markdown format.

Type: string:enum

Default: HTML

Possible Values: ['PIPE', 'GRID', 'HTML', 'PIPE_WITH_HTML']

canvas

MARKDOWN_FLAVOR

Set the value of Markdown flavor.

Type: string:enum

Default: gfm

Possible Values: ['GFM', 'GPT']

canvas

MARKDOWN_HEADERS_STYLE

Set the style of Markdown headers.

Type: string:enum

Default: ATX

Possible Values: ['ATX', 'SETEXT']

canvas

MARKDOWN_HR_BETWEEN_PAGES

Enable or disable inclusion of a horizontal rule between pages in Markdown output

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

canvas

MARKDOWN_INCLUDE_BOOKMARKS

Enable or disable inclusion of bookmarks in Markdown output.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

canvas

MARKDOWN_INCLUDE_FIELDS

Enable or disable inclusion of text marked as fields in generated Markdown.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

canvas

MARKDOWN_INCLUDE_FOOTERS

Enable or disable inclusion of text marked as a page footer when generating Markdown.

Type: string:enum

Default: OFF

Possible Values: ['ON', 'OFF', 'FIRST']

canvas

MARKDOWN_INCLUDE_FORMATTING

Enable or disable inclusion of text formatting in Markdown output.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

canvas

MARKDOWN_INCLUDE_HEADERS

Enable or disable inclusion of text marked as a page headers when generating Markdown.

Type: string:enum

Default: OFF

Possible Values: ['ON', 'OFF', 'FIRST']

canvas

MARKDOWN_INCLUDE_IMAGES

Enable or disable inclusion of image elements when generating Markdown.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

canvas

MARKDOWN_INCLUDE_LINKS

Enable or disable inclusion of links in Markdown output.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

canvas

MARKDOWN_INCLUDE_METADATA

Enable or disable inclusion of document metadata in Markdown output.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

canvas

MARKDOWN_LF_AFTER_BLOCK

Enable or disable new lines after each HTML block element when generating Markdown.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

canvas

MARKDOWN_METADATA_FORMAT

Set the value of Markdown format for metadata inclusion.

Type: string:enum

Default: COMMENTS

Possible Values: ['YAML', 'TOML', 'JSON', 'COMMENTS']

canvas

MARKDOWN_PREFERRED_LINE_LENGTH

Set the preferred line length for wrapping in Markdown.

Type: number

Default: 80

canvas

MARKDOWN_SIMPLE_TABLE_STYLE

Set the rendering style for simple tables in Markdown.

Type: string:enum

Default: PIPE

Possible Values: ['PIPE', 'GRID', 'HTML', 'PIPE_WITH_HTML']

canvas

MARKDOWN_TABLE_PADDING

Enable or disable inclusion of padding on pipe style tables in Markdown output.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

canvas

MARKUP_OPTIONS

Set the value of track-changes markup types. Must be combined with SHOWHIDDEN. [INS,DEL]

Type: string

Default: DE

document

METADATA_NAME_HYPHENATE

Enable or disable the hyphenation of metadata names for HTML output.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

METADATA_VALUE_SEPARATOR

Set the string used to separate a metadata name from its value in text-mode output.

Type: string

Default: :

document

METADATA_WHEN_ENCRYPTED

Enable or disable metadata extraction from encrypted files. When disabled, the document will fail to open with error code IGR_E_PASSWORD.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

MHT_HEADERS

Enable or disable extraction of MHTML email headers in the output.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

MSACCESS_SHOW_SYSTEMTABLES

Enable or disable the inclusion of Microsoft Access system tables in extracted output.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

MSPROJECT_FONT

Set the value of font to use when converting MS Project.

Type: string

Default: Arial

document

MSPROJECT_FONTSIZE

Set the font size used during MS Project conversion.

Type: number:point

Default: 8

document

MSPROJECT_PAGE_HEIGHT

Set the value of page height in points.

Type: number:point

Default: 612

document

MSPROJECT_PAGE_WIDTH

Set the value of page width in points.

Type: number:point

Default: 792

document

MSPROJECT_ZOOM

Set the value of zoom to use when converting MS Project.

Type: string

Default: auto

document

OCR

Enable or disable OCR processing of images.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

OCR_CACHE

Set the location of OCR cache storage.

Type: string

document

OCR_ENGINE

Set the value of OCR engine to use.

Type: string

Default: TESSERACT

document

OCR_LANGUAGE

Set the value of language for Optical Character Recognition (OCR) processing.

Type: string

Default: Eng

document

OCR_MIN_WIDTH

Set the value of image minimum width for OCR processing.

Type: number

Default: 1000

document

OCR_REORIENT_PAGES

Enable or disable re-orientation of pages based on orientation detection for OCR.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

ODF_USERMETA

Enable or disable adding user-defined fields as metadata.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

ODSMODE

Set the output format when processing Open Document Spreadsheet (ODS) files.

Type: string:enum

Possible Values: ['', 'JSON']

document

OFFICE_COMMENT_PAGE

Set the value of the page where comments are extracted to when using IGR_Get_Page_Annotations.

Type: string:enum

Default: first

Possible Values: ['first', 'last']

document

OLM_DATE_FIELD

Set the value of ordered list of XML properties containing document date.

Type: string:enum

Possible Values: ['', 'OPFMessageCopyModDate', 'OPFMessageCopyReceivedTime', 'OPFMessageCopySentTime']

document

PAGENUMBERS

Enable or disable the extraction of page numbers when processing presentation type documents in text-mode.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

PAGE_NUMBERS

Enable or disable this inclusion of injected page numbers in hi-def output.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

document

PAGE_TEXT_SYMBOLS_TO_UNICODE

Enable or disable mapping of symbol fonts (such as Wingdings) to a similar Unicode font.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

PBM_MODE

Set the format of saved PBM files to ASCII or BINARY.

Type: string:enum

Default: ASCII

Possible Values: ['ASCII', 'BINARY']

canvas

PDF_ANNOTATIONS

Set the value of PDF annotations to draw, excluding specific types by prefixing with an exclamation point (!)

Type: string

document

PDF_BOOKMARKS

Enable or disable whether to include bookmarks in the output.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document, canvas

PDF_COMPRESSION

Set the value of compression type for generated PDF output.

Type: string:enum

Default: AUTO

Possible Values: ['AUTO']

canvas

PDF_DEFAULTDPI

Set the DPI for bitmap scaling.

Type: number

Default: 96

document

PDF_DEHYPHENATE

Enable or disable removing hyphens from word endings to express contractions as single words.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

PDF_ENCRYPT

Enable or disable to apply encryption to the generated PDF.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

canvas

PDF_ENCRYPT_PERMISSIONS

Set the value of PDF permissions (see PDF Reference 1.7, Table 3.20)

Type: string

canvas

PDF_IMAGE_QUALITY

Set the image quality for PDF output, with higher values indicating higher quality.

Type: number

Default: 90

document

PDF_LAYOUT_DETECTION

Enable or disable layout detection for PDF files.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

PDF_LAYOUT_DETECTION_DIAGNOSTICS_MARKUP

Enable or disable the drawing of PDF layout detection areas on output.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

PDF_LINEARIZE

Enable or disable PDF output linearization for Fast Web View.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

canvas

PDF_LIST_DETECTION

Enable or disable list detection in PDF files.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

PDF_MARKDOWN_UNWRAP_TEXT

Enable or disable unwrapping of text when processing PDF to Markdown output.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

PDF_MAX_CHARS_PER_PAGE

Set maximum number of characters processed for each page of PDF input.

Type: number

Default: 50000

document

PDF_MAX_IMAGE_WIDTH

Set the maximum width of output images to this pixel value.

Type: number:pixel

Default: 3200

document

PDF_META

Enable or disable whether metadata is included with PDF documents.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

document

PDF_MIN_WORD_BREAK_SPACE

Specify the minimum space between characters that constitutes a word-break.

Type: number

Default: 0.1

document

PDF_OWNERPASSWORD

Set the value of owner password used to decrypt PDF documents.

Type: string

document

PDF_PAGE_NUMBERS

Enable or disable including page numbers on PDF text-only output.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

document

PDF_PHYSLAYOUT

Enable or disable whether to maintain the document's physical layout in the output.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

PDF_PRESERVE_ORIGINAL

Enable or disable preserving original page data when converting PDF to PDF.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

canvas

PDF_PRESERVE_PAGE_SIZE

Enable or disable whether to maintain the page size when converting from an image to PDF.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

PDF_RASTER_TEXT

Enable or disable rendering text from PDF files as raster images. This controls the handling of text in PDFs.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

canvas

PDF_SET_OWNER_PASSWORD

Set the value of master password controlling document edits.

Type: string

canvas

PDF_SET_USER_PASSWORD

Set the value of default view password.

Type: string

canvas

PDF_TABLE_DETECTION

Enable or disable table detection.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

PDF_TABLE_EDGE_MIN_LENGTH

Set the value of minimum edge length considered when detecting table edges in PDF files.

Type: number

Default: 11

document

PDF_TABLE_HORZ_STRATEGY

Set the value of horizontal table detection strategy for detecting tables in PDF files.

Type: string:enum

Default: LINES

Possible Values: ['LINES']

document

PDF_TABLE_INTERSECTION_TOLERANCE

Set the tolerance value to determine edge combination into cells. This value helps control the precision of cell formation when detecting tables in PDF files.

Type: number

Default: 3

document

PDF_TABLE_INTERSECTION_X_TOLERANCE

Set the value of edge intersection tolerance along the x-axis. This determines how close edges must be to be considered intersecting when detecting tables in PDF files.

Type: number

Default: 3

document

PDF_TABLE_INTERSECTION_Y_TOLERANCE

Set the value of Y-axis tolerance for edge intersection when detecting tables in PDF files.

Type: number

Default: 3

document

PDF_TABLE_JOIN_TOLERANCE

Set the value of tolerance for joining line segments when detecting tables in PDF files.

Type: number

Default: 3

document

PDF_TABLE_JOIN_X_TOLERANCE

Set the value of x-axis tolerance for joining line segments, controlling how close line ends can be before being considered a single segment when detecting tables in PDF files.

Type: number

Default: 3

document

PDF_TABLE_JOIN_Y_TOLERANCE

Set the value of y-axis tolerance for joining line segments, controlling how close line ends can be before being considered a single segment when detecting tables in PDF files.

Type: number

Default: 3

document

PDF_TABLE_MIN_CELL_HEIGHT

Set the minimum cell height for table detection when detecting tables in PDF files.

Type: number

Default: 8

document

PDF_TABLE_MIN_CELL_WIDTH

Set the minimum cell width for table detection when detecting tables in PDF files.

Type: number

Default: 8

document

PDF_TABLE_MIN_COLS

Set the minimum number of columns required for table detection in PDF files.

Type: number

Default: 2

document

PDF_TABLE_MIN_ROWS

Set the minimum number of rows required for table detection in PDF files.

Type: number

Default: 1

document

PDF_TABLE_SNAP_TOLERANCE

Set the value of line tolerance to control parallel line snapping for detecting tables in PDF files.

Type: number

Default: 3

document

PDF_TABLE_SNAP_X_TOLERANCE

Set the value of x-axis tolerance for snapping parallel lines when detecting tables in PDF files.

Type: number

Default: 3

document

PDF_TABLE_SNAP_Y_TOLERANCE

Set the value of y-axis tolerance for snapping parallel lines when detecting tables in PDF files.

Type: number

Default: 3

document

PDF_TABLE_VERT_STRATEGY

Set the value of horizontal vertical detection strategy for detecting tables in PDF files.

Type: string:enum

Default: LINES

Possible Values: ['LINES']

document

PDF_TAGGED

Enable or disable the creation of PDF with accessibility information.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

canvas

PDF_TRANSPARENT_BACKGROUND

Enable or disable transparent background rendering for the PDF.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

PDF_USERPASSWORD

Set the value of password for decrypting PDF documents.

Type: string

document

PDF_VERSION

Set the value of the compliance level of generated PDF files. Note: Image transparency is lost when generating PDFA-1.

Type: string:enum

Default: 1.7

Possible Values: ['1.7', 'A1', 'A1A', 'A1B', 'A2', 'A2U', 'PDF1.7', 'PDFA', 'PDFA1', 'PDFA1A', 'PDFA1B', 'PDFA2', 'PDFA2U']

canvas

PDF_WORD_ORDER

Set the value of word order to "Reading" to extract text as if read, or "Document" to match original document structure.

Type: string:enum

Default: READING

Possible Values: ['READING', 'DOCUMENT']

document

PDF_XFA_ENABLED

Enable or disable XFA rendering

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

PDF_XFA_ERROR

Enable or disable detection of dynamic XFA content.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

PDF_XMPMETA

Enable or disable whether to include XMP metadata in the output, requiring an opening document with a metadata flag enabled.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

document

PGM_MODE

Set the mode for PGM file saving to ASCII or binary.

Type: string:enum

Default: ASCII

Possible Values: ['ASCII', 'BINARY']

canvas

PLIST_FORMAT

Set the output format for extracted PLIST data (JSON or Plain Text).

Type: string:enum

Possible Values: ['', 'JSON']

document

PNG_BITSPERPIXEL

Set the value of bits-per-pixel when generating PNG.

Type: string:enum

Default: SOURCE

Possible Values: ['SOURCE', 'AUTO', '1', '8', '16', '24', '32']

canvas

PNG_ENCODER

Set the value of image encoder for JPEG files on Windows using WIC.

Type: string:enum

Default: NATIVE

Possible Values: ['NATIVE', 'WIC']

canvas

PPM_MODE

Set the mode for PPM file saving to ASCII or binary.

Type: string:enum

Default: ASCII

Possible Values: ['ASCII', 'BINARY']

canvas

PROCESS_TIMEOUT

Set the time limit for processing documents, in milliseconds.

Type: number

Default: 0

document

PSTMESSAGETYPE

Set whether to extract embedded messages from PST/OST archives in MSG format or EML format.

Type: string:enum

Default: MSG

Possible Values: ['MSG', 'EML']

document

RASTER_DRAWINGS

Enable or disable the conversion of embedded drawings to bitmap in vector formats.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

canvas

REDACT

Set the value of redacting words on nominated pages.

Type: string

document

RESAMPLE_IMAGES

Enable or disable image resampling for vector-based output.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

SCALE

Set the scale that the page is rendered.

Type: number

Default: 1

document

SHOWHIDDEN

Enable or disable showing normally invisible page elements.

Type: unknown

Default: "off"

document

SHOWHIDDEN_EXCEL_REFS

Enable or disable the inclusion of hidden Excel references.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

SLIDE_COMMENTS

Enable or disable showing slide comments in presentations.

Type: string:enum

Possible Values: ['OFF', 'ON', 'APPEND']

document

SLIDE_NOTES

Enable or disable showing note pages in presentations.

Type: string:enum

Possible Values: ['OFF', 'ON', 'APPEND']

document

SLIDE_NOTES_FORMATTING

Enable or disable slide note formatting.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

SPREADSHEET_COLLAPSE_ROWS

Enable or disable collapsing of spreadsheet rows with duplicates. Set to 'OFF', 'NO', or less than 1 to disable.

Type: number

Default: "100"

document

SPREADSHEET_PAGEDIRECTION

Set the value of page direction to determine how pages are ordered when a sheet does not fit on one page.

Type: string:enum

Default: OverThenDown

Possible Values: ['OverThenDown', 'DownThenOver']

document

SPREADSHEET_SHEETS

Set to the sheets to render. Set to ALL or a comma-separated list of numbers or ranges. For example, 1,2,5..7

Type: string

Default: ALL

document

SVG_COALESCE_RUNS

Enable or disable combining similar text styles into a single run when rendering SVG elements.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

canvas

SVG_FLATTEN_TEXT

Enable or disable rendering of outputs text as paths instead of text elements.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

canvas

SVG_INCLUDE_CHAR_OFFSET

Enable or disable inclusion of character offsets.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

canvas

SVG_INLINE_IMAGES

Enable or disable embedded images as inline elements in SVG.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

canvas

TEXT_DEFAULT_FONT

Set the value of default font to use for non-HD image rendering.

Type: string

Default: Courier New

document

TEXT_DEFAULT_FONT_SIZE

Set the default font size for non-HD images rendering.

Type: number:point

Default: 10

document

TEXT_EXTENSION

Specify the default file extension for extracted text output.

Type: string

Default: .txt

document

TEXT_FALLBACK

Enable or disable text fallback rendering for documents that do not directly support hi-def processing.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

document

TEXT_FALLBACK_MODE

Set the value of text fallback mode to specify how to handle metadata for non-HD formats.

Type: string:enum

Possible Values: ['', 'BODYONLY']

document

TEXT_INLINE_LINKS

Enable or disable the writing of links in text mode inline or separately.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

TEXT_MARGIN_BOTTOM

Set the bottom margin to use for formats without page or margin info, measured in points.

Type: number:point

Default: 36

document

TEXT_MARGIN_LEFT

Set the value of left margin to use for formats without page or margin information, in points.

Type: number:point

Default: 36

document

TEXT_MARGIN_RIGHT

Set the value of right margin to use for formats without page or margin information, in points.

Type: number:point

Default: 36

document

TEXT_MARGIN_TOP

Set the value of top margin to use for formats without page or margin information, in points.

Type: number:point

Default: 36

document

TEXT_METADATA

Enable or disable the extraction of metadata as plain text when processing documents.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

TEXT_PAGE_CHARS_PER_LINE

Set the character limit for text-only lines.

Type: number

Default: 0

document

TEXT_PAGE_FOOTER

Enable or disable inclusion of the footer when rendering text pages.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

document

TEXT_PAGE_HEIGHT

Set the page height to a specified number of points. This value determines the page width for formats without page information.

Type: number:point

Default: 792

document

TEXT_PAGE_LINES_PER_PAGE

Set the line count per page for formats without layout details.

Type: number

Default: 0

document

TEXT_PAGE_ORIENTATION

Set the page orientation to portrait or landscape.

Type: string:enum

Default: PORTRAIT

Possible Values: ['PORTRAIT', 'LANDSCAPE']

document

TEXT_PAGE_SIZE

Set the value of output page size using ISO standard or metric page sizes. Cannot be used with TEXT_PAGE_WIDTH or TEXT_PAGE_HEIGHT.

Type: string:enum

Possible Values: ['', 'LETTER', 'LEGAL', 'TABLOID', 'LEDGER', 'A0', 'A1', 'A2', 'A3', 'A4', 'A5', 'A6', 'A7', 'A8', 'A9', 'A10', 'B0', 'B1', 'B2', 'B3', 'B4', 'B5', 'B6', 'B7', 'B8', 'B9', 'B10', 'C0', 'C1', 'C2', 'C3', 'C4', 'C5', 'C6', 'C7', 'C8', 'C9', 'C10']

document

TEXT_PAGE_WIDTH

Set the page width to a specified number of points. This value determines the page width for formats without page information.

Type: number:point

Default: 612

document

TEXT_PAGE_WORD_WRAP

Enable or disable word wrap for formats without layout information.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

document

TIFF_BITSPERPIXEL

Set the value of bit depth to specify the number of bits per pixel in the TIFF output.

Type: string:enum

Possible Values: ['0', '1', '2', '4', '8', '24']

canvas

TIFF_BYTEORDER

Set the byte order of the generated TIFF image.

Type: string:enum

Default: NATIVE

Possible Values: ['NATIVE', 'LE', 'BE']

canvas

TIFF_COMPRESSION

Set the value of compression type for the generated TIFF image.

Type: string:enum

Default: LZW

Possible Values: ['NONE', 'PACKED', 'JPEG', 'LZW', 'GROUP3', 'GROUP4', 'GROUP6']

canvas

TIFF_IGNORE_DECODE_ERR

Enable or disable feature to control error handling for TIFF image decoding.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

TIFF_IGNORE_MEMORY_LIMITS

Enable or disable enforced memory limits when processing large TIFF images.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

TIFF_PHOTOMETRIC_MINISBLACK

Enable or disable feature for controlling black and white TIFF output representation.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

canvas

TIFF_REORIENT_PAGES

Enable or disable the reorientation of TIFF images for top-down, left-to-right display.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

document

TIFF_SUSPECT_DPI_RATIO_ERROR

Enable or disable suspect DPI checks when processing TIFF files.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

document

USE_MAPPED_FONTS

Enable or disable use of actual fonts instead of stored fonts. This affects how fonts are displayed in generated output.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

canvas

VISIO_FOOTER

Enable or disable injected footer on Visio documents

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

document

VISIO_RASTER_TEXT

Enable or disable rendering Visio text in HTML mode as raster images with transparent text overlays.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

document

WATERMARK

Set the watermark text to apply to pages when rendering to hi-def image formats.

Type: string

canvas

WATERMARK_COLOR

Set the value of watermark text color.

Type: string

Default: #000000

canvas

WATERMARK_DIRECTION

Set the direction of watermark text when rendering to HD image formats.

Type: string:enum

Default: LBRT

Possible Values: ['LBRT', 'LTRB', 'LR']

canvas

WATERMARK_FONT

Set the value of font used for watermark rendering.

Type: string

Default: Aria

canvas

WATERMARK_OPACITY

Set the transparency level of watermark text as a value between 0 and 1.

Type: number

Default: 0.1

canvas

XML_FORMATTED

Enable or disable formatting XML input to show only text content.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

XML_FORMATTED_WITH_ATTRIBUTES

Enable or disable the inclusion of attribute names and values in formatted XML.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

XML_FORMATTED_WITH_NODENAMES

Enable or disable including node names in formatted XML.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

document

XML_HEADINGS_ONLY

Enable or disable feature extracting headings from structured XML.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

canvas

XML_IMAGES

Enable or disable inclusion of image data in structured XML outputs. Images will be output inline, base-64 encoded.

Type: bool

Default: ON

Possible Values: ['ON', 'OFF']

canvas

XML_INCLUDE_FORMS

Enable or disable including form elements in structured XML output.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

canvas

XML_SUPPRESS_EMPTY_PARA

Enable or disable suppression of empty paragraphs in XML output.

Type: bool

Default: OFF

Possible Values: ['ON', 'OFF']

canvas