Export
This article is currently under review. Some content may be incomplete or inaccurate.
Category: Processing
The Export activity produces output files from the finished transaction: searchable PDFs, JSON data, and other formats. Output is organized into export profiles, each defining a scope, format, and any preprocessing.
Configuration
| Setting | Description | Default |
|---|---|---|
| Profiles | The export profiles to run. Each defines scope, format, and preprocessing. | (none) |
| Run in parallel | Execute independent profiles concurrently. | Off |
JSON output options
A JSON profile exports the transaction's extracted data as structured JSON. By default it includes field values with their confidence, reasoning, and confirmation state, per-field bounding boxes, a per-page block, and the transaction's metadata. Optional settings add the page OCR text and word-level OCR layout, and several settings let you trim the output.
Two things are always included and have no toggle: the per-page block (how each page maps to its source file, plus the image-transform frame that maps coordinates back onto the original page) and the transaction metadata (the key-value pairs supplied when the transaction was created, plus created-at, source, and review summary).
| Option | Description | Default |
|---|---|---|
| Field Filter | Which fields to export. All fields, Include only a listed set, or Exclude a listed set. Fields are named by their display path, using / for nested fields: Supplier/Name for a field inside the Supplier group, Line Items/Description for a column of the Line Items repeating group. Naming a group alone includes or excludes all of its children. This same Field Filter works identically in every format (JSON, XML, CSV, Excel). | All fields |
| Include Field Details | When on, keeps each field's confidence, reasoning, confirmation state, and bounding boxes alongside its value. When off, keeps just the extracted value, the smallest output. | On |
| Include Page Full Text | The full OCR text of each page. | Off |
| Include Page OCR Data | Word-level OCR layout per page (every word with its bounding box, in rasterized page-image pixel coordinates). Can be large. | Off |
| Pretty Print | Format the JSON with indentation and line breaks. Turn off for a compact, single-line file. | On |
| Exclude JSON Paths (advanced) | Remove specific branches from the finished file by path, one per line, with * as a wildcard, to reduce size. For example documents.*.fields.*.reasoning drops every field's reasoning. Unmatched paths are ignored. | (none) |
For the full JSON structure, the coordinate system, and how to map OCR content back onto the original page, see Export to JSON.
XML output options
An XML profile exports the same structured document as a JSON profile, serialized as XML. It carries identical content and offers every JSON option (field filter, field details, page text/OCR, pretty print, exclude paths), plus one XML-only setting:
| Option | Description | Default |
|---|---|---|
| Root Element | The name of the XML document's root element. | document |
All the other options behave exactly as they do for JSON (see the JSON output options above). For the XML structure and the rules that map the JSON shape onto elements, see Export to XML.
JPG output (page images)
A JPG profile exports one JPEG image per page: the exact page image the platform ran OCR on.
By default the image is exported verbatim, so every bounding box in a JSON export (field boxes and word-level OCR boxes) lands on it with no conversion. This is the supported way to obtain the page images for a custom review interface. Pair a JPG profile with a JSON profile: the JSON carries the data and coordinates, the JPG carries the matching page image.
Files are named after the profile's filename template with a page suffix, for example "invoice_page_1.jpg", "invoice_page_2.jpg". The number is the transaction page number, which matches each bounding box's page_index in the JSON export.
Options
| Option | What it does | Default |
|---|---|---|
| Resolution | Downscales each page image toward a chosen resolution (300 / 200 / 150 / 100 / 72 DPI) to shrink file size. Pages already at or below the target keep their resolution, and pages are never upscaled. | Original |
| Compression | Re-compresses each page as a new JPEG at a quality you set (1 to 100). Leave it off to keep the stored image unchanged. | Off |
Compression does not change pixel dimensions, so bounding-box coordinates still line up.
Changing the resolution rescales the exported page images. Bounding-box coordinates in a JSON export, both field boxes and OCR word boxes, are recorded in the original pixel space and will no longer line up with these images. Keep the resolution at Original if you overlay a JSON export on the page images.
See Accessing OCR & Field Data for how to combine the two exports in your own client.
CSV output options
A CSV profile flattens the extracted field values into one comma-separated table, one row per document. Standalone and group fields each become a column (Supplier/Name); a repeating group's columns are flattened too, with the instance values for a column joined into a single cell (Widget | Gadget). Only field values are exported (no confidence, boxes, or reasoning). When a transaction mixes document types, the table holds the union of their columns.
| Option | Description | Default |
|---|---|---|
| Delimiter | Column separator: comma, semicolon, tab, or pipe. | Comma |
| Include Header Row | Write a header row of column labels. | On |
| Field Filter | Same as JSON: All fields, Include only, or Exclude, by display path (Supplier/Name). | All fields |
Excel (XLSX) output options
An Excel profile writes the extracted field values into a workbook. Only field values are exported. Field order and labels follow the Data Panel (Group/Child).
| Option | Description | Default |
|---|---|---|
| Layout | Table (multi-document; standalone/group fields as columns on a main sheet, each repeating group on its own sheet) or Form (key/value, one document per sheet). | Table |
| Sheet Grouping | Table: one sheet set per document type, or per document. Form: one sheet per document, or all on a single sheet. | Per type / per document |
| Metadata | Which document-metadata columns (transaction id, document id, type, source filename, page count, created-at) to include: all, only a listed set, or all except a listed set. | All |
| Field Filter | Same as JSON: All fields, Include only, or Exclude, by display path (Supplier/Name). | All fields |
| Auto-size Columns | Fit column widths to their content. | On |
| Freeze Header Row | Keep the header row visible when scrolling. | Off |
PDF output options
| Option | Description | Default |
|---|---|---|
| Searchable PDF (OCR layer) | Overlays invisible OCR text so the PDF can be searched and copied from. | Off |
| Page Size | Original, Letter, or A4. | Original |
| Orientation | Auto, portrait, or landscape. | Auto |
| Archival profile (PDF/A) | Produces an ISO 19005-3 archival PDF: PDF/A-3b (basic conformance), PDF/A-3u (adds guaranteed Unicode text mapping), or PDF/A-3a (adds an accessible tagged structure built from the OCR text, in reading order). PDF/A-3a always includes the OCR layer. | None |
| Document language | PDF/A-3a only: the document language recorded in the archive file, as a BCP-47 tag (for example "en", "de", "pt-BR"). When left empty, the OCR-detected language is used where available, otherwise English. | Auto |
| Embed extracted data | Embeds the extracted data as a file attachment inside the PDF, so one self-contained file carries both the page images and the machine-readable data. Cannot be combined with redaction. | Off |
| Embedded data format | Serialization of the embedded data file, JSON or XML. Both carry the identical content. Shown only when Embed extracted data is on. | JSON |
Notes
- Pair Export with a Notification step to tell an external system where to download the results.