JSON Metadata

Specifies the file extension (such as .json) used for the exported metadata file.

• By default, this is set to .json.
• You may change this if your workflow or target system requires a different extension.

> Tip:
> Ensure the extension matches the expectations of downstream consumers or systems.

Can be one of the following values:

The JsonLayout enumeration determines how much information is included in the exported JSON file when using the JSON Metadata format.

• Use Full to include detailed extraction results, such as value locations, confidence scores, and additional metadata for each value.
• Use Simple to export only the extracted values, resulting in a more compact and streamlined JSON structure.

> Important:
> The JSON Data Mapping behavior only affects the output when the layout is set to Simple.
> When Full is selected, all data from the Data Model is exported regardless of the mapping.

Choose the layout that best fits the requirements of your integration, reporting, or downstream processing scenario.

Controls the formatting of the exported JSON:

• If true, the JSON will be minified (compact, no extra whitespace).
• If false, the JSON will be indented for readability.

Use minified output for system-to-system integrations where file size matters, or indented output for easier human review.

The 'Filename' property allows you to define a dynamic Path Expression to control the name of the file produced by this Export Format. If no expression is provided, a default filename based on the item's display name and file extension will be used.

Purpose and Usage

• Use this property to generate filenames that incorporate document metadata, extracted field values, dates, or other variables.
• The expression can reference any field or property available in the export context, enabling highly customized and meaningful filenames.
• Supports Visual Basic string interpolation, composite formatting, and helper functions such as CleanFileName() to ensure valid filenames.

Example Expressions

Example 1: Use the document type and date

$"Invoice_{CurrentDocument.ContentTypeName}_{Now:yyyyMMdd}.pdf"
' Output: Invoice_InvoiceType_20250831.pdf

Example 2: Use an extracted field

$"Claim_{ClaimNumber}_{Date:yyyy-MM-dd}.pdf"
' Output: Claim_12345_2025-08-31.pdf

Example 3: Use folder name and a custom suffix

$"{CurrentDocument.Name}_Final.pdf"
' Output: MyDocument_Final.pdf

Example 4: Sanitize a field for use in a filename

$"Invoice_{CleanFileName(InvoiceNumber)}.pdf"
' Output: Invoice_123-ABC.pdf

Configuration Guidance

• If the expression is left blank or evaluates to an empty string, the default filename will be used.
• Ensure the resulting filename does not contain invalid path characters. Use CleanFileName() as needed.
• Only the filename portion is used; directory paths in the expression will be ignored for file naming purposes.