Skip to content
MirrorFirm

How should a pilot delivery be packaged so it loads into our environment?

Agree a directory layout with a manifest, schemas, state, cases, grading, policies, validators and licence files, plus a versioning rule that keeps case IDs stable.

Agree the packaging of a pilot delivery up front so it loads without rework. A workable layout is one directory per release with these parts.

- **manifest.json** listing every file with its path, format, row count, checksum and schema version. Row counts describe the delivered files only. - **schemas/** holding one schema file per table and per case file, with field types, nullability, key definitions and enumerations such as status values and cause classes. - **state/** holding record tables as Parquet or JSONL, partitioned by snapshot_ref so each snapshot can be loaded independently. - **cases/** holding cases.jsonl with agent-visible fields only. - **grading/** holding cause labels, predicates, reference trajectories and rationale text, kept apart so they cannot be loaded into agent state by accident. - **policies/** holding the rule table and a plain-language rendering for agents that read documents. - **validators/** holding consistency checks to run before loading: key resolution, date order, balance totals and snapshot completeness. - **LICENCE and NOTICE** files stating the agreed terms and that the content is generated.

Versioning needs a rule. If a later revision changes a schema, bump the schema version and keep case IDs stable, so your stored run results still refer to the same cases. Ask that any case whose content changes gets a new revision field, not a silent edit.

Finally, ask whether a small loader example in your language of choice can be included. It acts as a living description of the format and is a faster check than reading the schema.

Agreeing the layout and versioning rule up front means a pilot loads without rework and stored run results stay comparable across revisions.

Audience:
Environment builders
Content type:
Integration
Buyer question:
Scope and getting started

Content release: r-a220eb6e099b243b

More on Reconciliation mismatch