Category Scheme Map¶
A Category Scheme Map (SDMX 3.0) maps the categories of a source Category Scheme to the categories of a target
Category Scheme. Documents start ref: "CategorySchemeMap=AGENCY:ID(1.0)".
The four SDMX 3.0 item scheme maps share one layout, described on this page:
| Artifact | ref class |
Maps items of |
|---|---|---|
| Category Scheme Map | CategorySchemeMap |
Category Schemes |
| Concept Scheme Map | ConceptSchemeMap |
Concept Schemes |
| Organisation Scheme Map | OrganisationSchemeMap |
organisation schemes, e.g. Data Provider, Data Consumer or Organisation Unit Schemes |
| Reporting Taxonomy Map | ReportingTaxonomyMap |
Reporting Taxonomies |
Simple form¶
The document starts with the common header. The body gives the source and target item schemes and the list of item mappings:
format: "fusion-yaml(1.0.0)"
ref: "CategorySchemeMap=AGENCY:MAP(1.0)"
name: "TEST"
source: "CategoryScheme=AGENCY1:CAT_S1(1.0)"
target: "CategoryScheme=AGENCY2:CAT_S2(1.0)"
mappedItems:
- source: "FREQENCY"
target: "FRQ"
- source: "INDICATOR"
target: "IND"
sourceandtargetare the mapped item schemes in canonical form (Class=AGENCY:ID(version), see references).mappedItemslists the item mappings, each pairing a source item id with a target item id. Mappings are written in the order held by the map; they are not sorted.
Complex form¶
A mapping gains extra fields when it maps only part of the source id, uses a regular expression, or is valid for a limited period:
mappedItems:
- source: "FREQENCY"
target: "FRQ"
startIdx: 100
endIdx: 200
validity: "1959-01-01T00:00:00Z/2029-12-31T23:59:59Z"
- source: "^A(.*)"
target: "\\1"
pattern: "^A(.*)"
startIdxandendIdx(numbers) take a substring of the source id before it is matched.patternis written when the source is a regular expression. Its value is the same expression assource; it acts as the regular expression flag.validityis written when the mapping has a validity period; either end may be open.annotationsis written last when the mapping has annotations.
Field reference¶
| Field | Value | Written when |
|---|---|---|
source |
canonical reference to the source item scheme | the source is set |
target |
canonical reference to the target item scheme | the target is set |
mappedItems |
array of item mappings | there is at least one mapping |
mappedItems[]
| Field | Value | Written when |
|---|---|---|
source |
source item id (or regular expression) | always |
target |
target item id | always |
startIdx |
number, substring start index | set |
endIdx |
number, substring end index | set |
pattern |
the source regular expression | the source is a regular expression |
validity |
validity period | the mapping has a validity period |
annotations |
array, see annotations | the mapping has annotations |
Reading notes¶
- The value of
patternis not used: its presence sets the regular expression flag, and the expression is taken fromsource. - A missing
validityis read as no validity period.
The SDMX 2.1 equivalents held inside a Structure Set (categorySchemeMaps, conceptSchemeMaps,
organisationSchemeMaps) use a different layout, described on that page.