Sheaf
Expected document lists
The definition of a complete case: what documents and fields it must contain, who sees them and who may add them.
An expected document list says what a complete case contains. It is the thing every document is filed against, and the reason Sheaf can name what is missing instead of only reporting what arrived.
Lists are built under Classify in the app.
Families and versions
A list has an id (expectedDocListId, the slug of its name) and numbered versions.
| Status | Meaning |
|---|---|
| Draft | Editable. Cannot be used to start a case. |
| Active | Frozen. Can start cases. Editing it is refused; make a new version instead. |
To change an active list, create a new version from it, edit the draft, and activate it.
What a list contains
- Sections, each with an owner and two rules per role: who sees it, and who may add to it.
- Expected documents inside sections. Each is either a document someone uploads, with accepted file formats, or a group of fields someone fills in.
- Set documents: an expected document that occurs several times, such as one bank statement per account. The list declares what identifies an instance; the case supplies the actual instances.
Saved sections and document bundles are reusable pieces. Inserting one copies it into the list, so later changes to the piece do not reach lists already built.
How a case uses a list
A case pins a full copy of the list version it started on. When a newer version is activated, the case can be upgraded to it. An upgrade only adds; it never removes a line a document is already filed against.
Over the API
GET /expected-doc-lists lists your lists and versions. A call names a list as expectedDocListId, for its active version, or family/3 for a specific one. The list itself never travels with a request. See run a workflow.