IF Commons GitHub

contract

What a dataset promises, when the promises hold, and the proof that they are kept

Applies to: Meaning and contracts. What a value and its absence mean, and the promises a dataset makes: contracts, periods, controls and consent.

Written in commons/data/models/contract/mod.ts:156. Requires nothing. 7 concepts, 4 code lists.

contract control contract_field dataContract control_run control
How the concepts of contract relate
Diagram source
flowchart LR
  contract_field -->|contract| dataContract
  control_run -->|control| control

Concepts

ConceptDefinitionAttributesWritten in
canaryTokenA made-up value planted in a dataset or an environment that no honest process has a use for, so that its appearance elsewhere shows a leak4commons/data/models/contract/mod.ts:147
consentA subject's consent to a purpose between two dates, and whether it was taken back: what makes a use of their data allowed or not6commons/data/models/contract/mod.ts:131
contractFieldOne field a data contract promises: its name, its datatype, whether it may be missing and how it is classified5commons/data/models/contract/mod.ts:73
controlA control: what must hold, who answers for it, how often it is checked and the test or evidence that checks it, one row of the control matrix6commons/data/models/contract/mod.ts:106
controlRunWhat one run of a control found and when, with the evidence of it: a row of the history of a control, only added to4commons/data/models/contract/mod.ts:122
dataContractWhat a dataset promises to those who read it, in one version: its owner, its status and the dates between which the version holds; its fields are the fields of the contract7commons/data/models/contract/mod.ts:56
periodA span of time of one scope (a month of a ledger, a reporting quarter) that takes changes while it is open and is closed when its figures are final8commons/data/models/contract/mod.ts:88

Code lists

Code listDefinitionCodes
consentStatusWhether a consent is in force2
contractStatusWhere a data contract is in its life4
controlResultWhat a run of a control found4
periodStatusWhether a period still takes changes3

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