IF Commons GitHub

models/flow/mod

Written to: 5 requirements: 5 proved, 0 partly, 0 failing, 0 with no test recorded. 0060-flow-ledger FR-001, 0060-flow-ledger FR-002, 0060-flow-ledger FR-003, 0060-flow-ledger FR-004, 0060-flow-ledger FR-005

The flow model (commons data 0060-flow-ledger): what it takes to say, for any message or batch that was accepted, how far it got and why it stopped. It is the stage-contract ledger of the book "Accepted Is Not Correct" (chapter 1) with its load IDs, the idempotent intake of chapter 6 (a delivery is first, a duplicate or a conflict) and the reconciliation of chapter 11 (a manifest, the counts at each stage and the reason-coded losses, so that nothing is unexplained). It names no domain: a message, a batch and an entity are what a pipeline moves. It requires nothing, so a project takes it alone or with others.

Source: commons/data/models/flow/mod.ts

2 of 17 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

stageconst
const stage: CodeList<string, string>

The stages a message passes, each in its own terms of success.

Imported by 2 tests of the run (2 passed, 0 failed): the library's results

outcomeconstno test imports it
const outcome: CodeList<string, string>

What a stage says of one thing.

grainconstno test imports it
const grain: CodeList<string, string>

How much a ledger row stands for.

loadTypeconstno test imports it
const loadType: CodeList<string, string>

Why a load was made.

dispositionconstno test imports it
const disposition: CodeList<string, string>

What an intake found.

conflictStatusconstno test imports it
const conflictStatus: CodeList<string, string>

Where a conflict is.

producerconstno test imports it
const producer: CodeList<string, string>

Who produces a reason code.

reasonconstno test imports it
const reason: AnyConcept

A reason a stage stopped something: a code, whose meaning is data.

loadconst
const load: AnyConcept

A load: what is given an id at the first stage and carried on every later row and effect.

Imported by 218 tests of the run (218 passed, 0 failed): the library's results

stageContractconstno test imports it
const stageContract: AnyConcept

The contract of a stage: what it guarantees in and out, and how its failure is found.

ledgerEntryconstno test imports it
const ledgerEntry: AnyConcept

A row of the ledger: what one stage confirmed of one thing. Only ever added.

deliveryconstno test imports it
const delivery: AnyConcept

The idempotent intake of a delivery: the first time a message was seen, and how many times since.

deliveryConflictconstno test imports it
const deliveryConflict: AnyConcept

A delivery with the same id and other content: never overwritten, kept to be decided.

manifestconstno test imports it
const manifest: AnyConcept

What a sender says it sent.

batchStageconstno test imports it
const batchStage: AnyConcept

How many entities of a batch were at a stage.

lossconstno test imports it
const loss: AnyConcept

Entities lost between two stages, with the reason.

flowModuleconstno test imports it
const flowModule: Module

The flow model: loads, the stage ledger, intake and its conflicts, and the manifest with its funnel.

Titles, headings, exports, tables, columns and requirements. Esc closes.