Export Format

Defines a format for exporting the content of Grooper documents, enabling integration with external systems and downstream processes.

Remarks

Export formats control how Batch Folders, Batch Pages, and their associated content are transformed and written to files or streams during export operations.

Overview

• An Export Format determines the structure, encoding, and file type of exported content, such as PDF, TIFF, text, XML, or custom formats.
• Export formats are used by export activities and commands to generate output files for documents, folders, or pages in a batch.
• Each export format encapsulates logic for rendering, packaging, and naming exported files, supporting a wide range of integration scenarios.

Usage Scenarios

• Document Delivery:
  Export processed documents to standardized formats for delivery to clients, partners, or downstream systems.
• System Integration:
  Integrate Grooper with content management systems, archives, or line-of-business applications by exporting in required formats.
• Custom Workflows:
  Implement custom export logic by extending Export Format to support proprietary or specialized output requirements.

Extensibility

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

Derived Types

There are 10 implementations of Export Format.

Attached File	Exports an item's attachment or a specific named file from a Batch Folder or Batch Page.
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.
PDF Format	Exports a Grooper document or folder as a PDF file, supporting advanced options for searchability, compression, compliance, and viewer preferences.
Simple Metadata	Exports document-level metadata as key-value pairs in a plain text file.
Text Format	Exports a text version of a Batch Folder or Batch Page, generated from OCR data or native text attachments.
TIF Format	Exports a Batch Folder or Batch Page as a multi-page TIFF (TIF) file, supporting PDF rendering and image merging.
XML Format	Generates an XML document using the data stored on a Grooper document.
XML Metadata	Exports document-level metadata in XML format for integration, reporting, or downstream processing.
ZIP Format	Exports a Batch Folder as a ZIP archive containing all file attachments and images from descendant objects.

Used By

File ExportFTP ExportSFTP ExportSend MailCMIS Export