.Stat Suite documentation

SDMX annotations supported by the .Stat Suite

This page lists all the types of SDMX artefact annotations supported by the .Stat Suite.

Definition and purpose

The Annotation is a construct that contains user or organisation-specific metadata. The Annotation construct in SDMX is available to most of the SDMX structural metadata artefacts.
The main advantage of the Annotation is its flexibility as all properties can be tailor-made and there is no limit to their number. This can prove very useful for specific applications, such as dissemination tools.
sdmx.org/new-guideline-on-using-sdmx-annotations

User-managed annotations

Annotation type Use case(s) Where to attach Annotation text? Annotation title?
LAYOUT_ROW Dimensions to be presented in rows of a DE table (concepts on y-axis)
full specs
- Dataflow, DSD
- Dimension
  - Attached to Dataflow or DSD: <dimension Id>,<dimension Id >,…
- Attached to Dimension: <blank>
LAYOUT_COLUMN Dimensions to be presented in columns of a DE table (concepts on x-axis)
full specs
- Dataflow, DSD
- Dimension
  - Attached to Dataflow or DSD: <dimension Id>,<dimension Id >,…
- Attached to Dimension: <blank>
LAYOUT_ROW_SECTION Dimensions to be presented at the row section level of a DE table
full specs
- Dataflow, DSD
- Dimension
  - Attached to Dataflow or DSD: <dimension Id>,<dimension Id >,…
- Attached to Dimension: <blank>
MAX_TABLE_DATA Increase the maximum preview table size above the DE default maximum limits for the number of observations retrieved from the SDMX web service and for the number of table cells
full specs
Dataflow   <integer>
example:
15000
DEFAULT Indication that an Item in an Item Scheme is to be selected by default in the DE visualisation filter, or is pre-selected when queried
full specs
- Item in an Item Scheme (e.g. code in a codelist)
- Dataflow, DSD
  - Attached to Item in Item scheme: <blank>
- Attached to Dataflow or DSD: <concept>=<code>+<code>+…,<concept>=<code>+<code>+…
example:
FREQ=A+Q,TIME_PERIOD_START=20-13-01,TIME_PERIOD_END=2018-12
NOT_DISPLAYED Indication that a component and/or its value (dimension, dimension value, attribute, attribute value) is hidden in a presentation
full specs
- Item in an Item Scheme (e.g. code in a codelist)
- Dataflow, DSD
  - Attached to Item in Item scheme: <blank>
- Attached to Dataflow or DSD: <concept Id>,<concept Id>... or <concept>=<code>+<code>+…
ORDER Explicit indication of localised order of items in items schemes
generic full specs
DE search facets specs
Item in an Item Scheme (e.g. code in a codelist) <language>:<integer>,...
example:
"en": "5","fr": "7"
 
EXT_RESOURCE Indication of a localised link to an external resource associated to the annotated Dataflow
full specs
Dataflow <language>:<HTML containing URL to the resource>,…
example:
"en":"<a href='http://www.ilo.org/_EN.xlsx'>Explanatory information</a>","fr":"<a href='http://www.ilo.org/_FR.xlsx'>Informations explicatives</a>"
 
MAXTEXTATTRIBUTELENGTH Increase the maximum length for textual attribute values
full specs
DSD   <integer>
example:
500
METADATA Indication that referential metadata can be uploaded to a related DSD where the METADATA annotation is defined
full specs
DSD   <URN of the related Metadata Structure Definition (MSD)>
example:
urn:sdmx:org.sdmx.infomodel.
metadatastructure.MetadataStructure=
AGENCY:MSD_ID(1.0)
SEARCH_WEIGHT Indication of localised boosted dataflows in the DE search results when ordered by relevance
full specs
Dataflow optional
<language>:<integer>,...
example:
"en":"3","es":"4","fr":"5"
<integer>
example:
10
LAYOUT_FLAG Indication that an attribute and its atribute value can be presented as a flag
full specs
Dataflow   <concept Id>,<concept Id>,...
example:
OBS_STATUS,CONF_STATUS
LAYOUT_NOTE Indication that an attribute and its attribute value can be presented as a note
full specs
Dataflow   <concept Id>,<concept Id>,...
example:
OBS_STATUS,CONF_STATUS
UNIT_MEASURE_CONCEPTS List of dimensions (concept IDs) that are used to define the full unit of measure
full specs
Dataflow, DSD   <concept Id>,<concept Id>,...
example:
UNIT_MEASURE,UNIT_MULT,BASE_PER
DRILLDOWN_CONCEPTS List of dimensions (concept IDs) to be displayed in a drilldown presentation
full specs
Dataflow, DSD   <concept Id>,<concept Id>,...
example:
DONOR,RECIPIENT,YEAR,PROJECT_ID,
OBS_VALUE,DESCRIPTION
DRILLDOWN Denotes the concept that specifies if observations are at the drilldown level (instead of aggregate level)
full specs
Dataflow, DSD   <concept Id>
example:
MD_DIM
Note that this "special" drilldown MD_DIM dimension is hidden in the data representation
SUPPORT_DATETIME Indication that a DSD can support data with values for a frequency higher than daily (e.g. hours, minutes, seconds)
full specs
DSD    

Automatically generated annotations

Annotation type Use case(s) Where to attach Annotation text? Annotation title?
sdmx_metrics - if ID="obs_count" then current number of observations per dataflow
- if ID="series_count" then number of time series series per dataflow
full specs
Actual Content Constraint for Dataflow <integer>

example:
123456