Skip to content

Categorisation

A Categorisation links a Category to the structure it classifies. The categorised structure can be any identifiable structure: a maintainable (e.g. a Dataflow), an item (e.g. a Code or another Category), a component (e.g. a Dimension) or a custom structure. Documents start ref: "Categorisation=AGENCY:ID(1.0)".

Simple form

A Categorisation has no optional body fields, so the simple form is also the complete form.

format: "fusion-yaml(1.0.0)"
ref: "Categorisation=ACY:EXCHANGE_RATES2DF_EXR(1.0.0)"
name: "TEST"
category: "TEST:CS(1.0).EXCHANGE_RATES"
structure: "Dataflow=TEST:DF_EXR(1.0)"
Source: categorisation/testMaintainableCategorisation.yaml

The document starts with the common header. The body is:

  • category: the Category, written as a reference keyed by its lower case class, so the value is the short URN of the category (AGENCY:SCHEME(VERSION).CATEGORY).
  • structure: the categorised structure, written as a canonical value (Class=short URN). The class is included because the structure can be of any type.

Examples by structure type

The structure field always uses the same key, whatever the type of the categorised structure; only the class prefix of the value changes.

Categorised structure structure value Source
Dataflow (maintainable) "Dataflow=TEST:DF_EXR(1.0)" testMaintainableCategorisation.yaml
Code (item) "Code=TEST:CL_FREQ(1.0).A" testCodeCategorisation.yaml
Dimension (component) "Dimension=TEST:EXR(1.0).REF_AREA" testDimensionCategorisation.yaml
Category "Category=TEST:OTHER_CS(1.0).FINANCE" testCategoryCategorisation.yaml
Custom maintainable "custom.imf.PivotTable=OECD:POP(1.0.0)" testCustomMaintainableCategorisation.yaml
Custom item scheme "customscheme.imf.Glossary=ECB:STAT_GLOSSARY(1.0.0)" testCustomItemSchemeCategorisation.yaml
Custom item "customscheme.imf.GlossaryTerm=ECB:STAT_GLOSSARY(1.0.0).GDP" testCustomItemCategorisation.yaml

When a category is categorised by another category, the two references are told apart by their keys: the classifying category is under category, the categorised one under structure.

format: "fusion-yaml(1.0.0)"
ref: "Categorisation=ACY:ECONOMY2OTHER_CS_FINANCE(1.0.0)"
name: "TEST"
category: "TEST:CS(1.0).ECONOMY"
structure: "Category=TEST:OTHER_CS(1.0).FINANCE"
Source: categorisation/testCategoryCategorisation.yaml

For custom structures the class in the canonical value is prefixed by the custom package, e.g. custom.imf.PivotTable, as described in References.

Field reference

Field Value Written when
category Short URN of the Category The categorisation has a category reference (always, for a complete categorisation).
structure Canonical value of the categorised structure The categorisation has a structure reference (always, for a complete categorisation).

Reading notes

The reader takes the structure type of structure from the class prefix of its value, so no resolver is needed.