Metadata Format

An Export Format that generates an output file containing metadata extracted from a Grooper document.

Remarks

Metadata Formats are used to export document-level metadata—such as index fields, extracted data, or custom properties—into a structured file for integration, reporting, or downstream processing.

Overview

• A Metadata Format defines how metadata from a Batch Folder or document is packaged and written to an output file (such as XML, JSON, or CSV).
• This format is document-centric: it operates at the Batch Folder or document level, not on individual Batch Pages.
• Used in export activities to deliver structured data alongside or instead of document images.

Configuration Guidance

• Select a Metadata Format that matches the requirements of your target system or workflow.
• This format cannot be used to export metadata for individual Batch Pages; it is intended for document-level export only.

Extensibility

• Developers can create new metadata formats in an Object Library by inheriting from MetadataFormat and implementing the required export logic.
• Built-in formats are available for common metadata structures, but custom formats can be added to support unique business needs.

Derived Types

There are 4 implementations of Metadata Format.

Delimited Metadata	Exports document metadata as a delimited text file, such as CSV or TSV.
JSON Metadata	Exports document-level metadata in JSON format for integration, reporting, or downstream processing.
Simple Metadata	Exports document-level metadata as key-value pairs in a plain text file.
XML Metadata	Exports document-level metadata in XML format for integration, reporting, or downstream processing.