Documents Activities

Version: 1.4.5  ·  ID: zoan-packages-documents  ·  Author: Zoan Software

The Documents package connects the playbook to Zoan Cloud’s documents: where extracted documents, their pages and their review status live. It is what makes the validation station and the classification station possible.

Most of the time you don’t need it

IDP — Extract already stores the document and its extraction on its own. This package is for specific cases: uploading a document and its pages by hand, or the bundle classification flow (files with several documents).

How this package works

• It needs Zoan Cloud: all three activities talk to Zoan Cloud with the run’s identity. They work in Zoan Cloud runs and in Designer tests with your session open; without that context they fail with a message that says what is missing.
• Pages count toward the plan’s quota: every page stored counts toward the monthly page quota. A document that does not fit is rejected from the first page, with the figures, and is never left half uploaded.
• Idempotent by reference: uploading again with the same reference replaces the document.

Activities

Activity	Type	Output	What it does
Documents — Upload	documents-upload	object	Uploads a document with its pages and extraction, for review.
Documents — Send Bundle to Classification	documents-classify-bundle	object	Sends a multi-document file whose split is uncertain to the classification station.
Documents — Take Confirmed Bundles	documents-take-classified	List<object>	Takes the bundles whose split a person already confirmed, to extract each segment.

The classification cycle

When a file holds several documents and the automatic split is unsure, it enters a cycle with human review:

IDP — Classify (splitNeedsReview)
   └─ Documents — Send Bundle to Classification ──→ [Classification station]  (a person confirms)
                                                          │
                                                          ▼
                          Documents — Take Confirmed Bundles ──→ IDP — Extract per segment

See the full flow in the extraction project tutorial.