Code converted to a number
Preserve the exact code and test loading does not remove leading zeros.
In-depth practical guides
Build a usable data dictionary
Describe row grain, columns, types, units, missing values and keys before calculations or joins.
Updated :
Reports and charts on a data review desk. Illustrative scene with no real data.
Build a usable data dictionary — method
A column heading is insufficient to understand a file. A dictionary connects fields to definitions, value domains and schema versions. Distinguish the dataset from distributions such as CSV and API.
Define a row
State object, geography and period: a company-year differs from an establishment-month. Specify the expected unique key and relationships with other tables.
Describe every field
For each column record exact name, definition, logical type, format, unit, code list, nullability and origin. Preserve leading-zero identifiers as text.
Test and version
Test uniqueness, domains and required fields on the real file. Empty string, not applicable and zero differ. Date changes to definitions, codes or types.
Situations and decisions
Typical situations for preparing a check. They do not describe completed assignments or actual observations.
Amount without unit
Identify currency, scale and period before summing; do not infer units from magnitude.
Record to retain
- Row object and expected key.
- Definitions, types, units, codes and missing-value rules.
- Schema version, checked file and detected anomalies.
Official references
Related source profiles
Related protocols
Checks before reaching a conclusion
- Preserve the exact code and test loading does not remove leading zeros.
- Identify currency, scale and period before summing; do not infer units from magnitude.
Frequently asked questions
Are examples enough?
No: an example illustrates one value; a definition specifies all admissible values.
Is a version needed for each format?
Document the common schema and distribution differences: names, formats and null rules.
TOOLS / REGISTERS
Write a record
Test uniqueness, domains and required fields on the real file. Empty string, not applicable and zero differ. Date changes to definitions, codes or types.
- Access date and time zone
- Exact URL
- Version / revision
- Object of one row
- Exact column name
- Logical type and format
- Method / definition
- Unit / calculation basis
- Value domain and code list
- Missing values and nullability
- Expected key and uniqueness
- Producer / publisher
- Decision / next action
- Review owner
- Next review