Changes for page Guidelines on Using SDMX Annotations

Last modified by Artur K. on 2026/05/29 14:28

From 1.8 to 1.9

From version 1.1

edited by Helena K.
on 2026/01/15 23:00

Change comment: There is no comment for this version

To version 1.8

edited by Helena K.
on 2026/01/15 23:25

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -30,13 +30,6 @@
  === SDMX 3.0 ===
--
--|(((
--|(((
--
--)))
--)))
--
  [[image:1768507168030-780.png]]
  The URL can be localised which gives the advantage of linking to different resources depending on the language. It also removes the complexity of having to use AnnotationText in SDMX 2.1 to do this.
@@ -45,25 +45,23 @@
  The properties of the Annotation construct are listed below. This information is taken from the [[SDMX official technical documentation>>url:https://sdmx.org/?page_id=5008]].
--|**Property**|**Description**|**Controlled vocabulary context**
--|**id**|Identifier for the Annotation. It can be used to disambiguate one Annotation from another where there are several Annotations for the same annotated object.|Id is set to @SDMX to identify it as part of the controlled vocabulary
--|**title**|A title used to identify an Annotation.|A non-localised value for the annotation. Used when localisation is irrelevant.
--|**type**|(((
++|**Property**|(% style="width:823px" %)**Description**|(% style="width:710px" %)**Controlled vocabulary context**
++|**id**|(% style="width:823px" %)Identifier for the Annotation. It can be used to disambiguate one Annotation from another where there are several Annotations for the same annotated object.|(% style="width:710px" %)Id is set to @SDMX to identify it as part of the controlled vocabulary
++|**title**|(% style="width:823px" %)A title used to identify an Annotation.|(% style="width:710px" %)A non-localised value for the annotation. Used when localisation is irrelevant.
++|**type**|(% style="width:823px" %)(((
  Specifies how the Annotation is to be processed.
--
--The **type** is often used as the usage context of the Annotation. The types are not enumerated[[~[1~]>>path:#_ftn1]], as these can be specified by the Annotation creator. The definitions and use of Annotation types should be documented by their creator.
--)))|Identifies the usage (e.g. images are type IMAGE) of the annotation. The type values are enumerated in the controlled vocabulary table.
--|**url**|(((
++The **type** is often used as the usage context of the Annotation. The types are not enumerated{{footnote}}The technical standard does not enumerate the annotation types, however this guideline provides a recommended enumeration or controlled vocabulary{{/footnote}}, as these can be specified by the Annotation creator. The definitions and use of Annotation types should be documented by their creator.
++)))|(% style="width:710px" %)Identifies the usage (e.g. images are type IMAGE) of the annotation. The type values are enumerated in the controlled vocabulary table.
++|**url**|(% style="width:823px" %)(((
  A link to external descriptive text.
--
  The **url** is a URI - typically a URL - which points to a resource. If a specific behaviour is desired, an Annotation type should be defined which specifies the use of this field more exactly.
--)))|A non-localised URL reference to an external resource. Used when localisation is irrelevant.
--|**+url**|**SDMX 3.0 and later**. An annotation may have several localised URLs|A localised URL reference to an external resource.
--|**+text**|(((
++)))|(% style="width:710px" %)A non-localised URL reference to an external resource. Used when localisation is irrelevant.
++|**+url**|(% style="width:823px" %)**SDMX 3.0 and later**. An annotation may have several localised URLs|(% style="width:710px" %)A localised URL reference to an external resource.
++|**+text**|(% style="width:823px" %)(((
  An International String that provides the multilingual text content of the Annotation.
  **Text** holds a language-specific string containing the text of the Annotation.
--)))|A localised value for the annotation.
++)))|(% style="width:710px" %)A localised value for the annotation.
  = Introducing Standard Annotations =
@@ -83,15 +83,15 @@
  The green columns in the table below show example usages of standard Annotations. The orange “ORDER” column is not a standard Annotation because the usage context is not the same as the standard Annotation “ORDER”, therefore the **id** should not be “@SDMX”.
--|**id***|**@SDMX**|**@SDMX**|**@SDMX**|(((
++|**id***|**@SDMX**|(% style="width:249px" %)**@SDMX**|(% style="width:209px" %)**@SDMX**|(% style="width:888px" %)(((
  **Not @SDMX**
  This is a “customer order no.” which is a different use case than the ORDER standard Annotation which is a list order
  )))
--|**title**| | | |1934245
--|**type***|NOT_DISPLAYED|EXCLUDES|ORDER|ORDER
--|(% rowspan="2" %)**+text**|(% rowspan="2" %) |(% rowspan="2" %) |en :10|(% rowspan="2" %)
--|fr :20
++|**title**| |(% style="width:249px" %) |(% style="width:209px" %) |(% style="width:888px" %)1934245
++|**type***|NOT_DISPLAYED|(% style="width:249px" %)EXCLUDES|(% style="width:209px" %)ORDER|(% style="width:888px" %)ORDER
++|(% rowspan="2" %)**+text**|(% rowspan="2" %) |(% rowspan="2" style="width:249px" %) |(% style="width:209px" %)en :10|(% rowspan="2" style="width:888px" %)
++|(% style="width:209px" %)fr :20
  ~* denotes a mandatory information for standard Annotations
@@ -111,13 +111,13 @@
  == Relationships between Annotation properties ==
--==== Text value defaults and specific locale values ====
++=== Text value defaults and specific locale values ===
  Some use cases may benefit from having a single, default value for all locales/languages but also to set the value for certain locales. An example is ORDER where there may be a default list order for all locales but two locales have a specific order which is different from the default. In order to avoid having to state an order for every locale, the Annotation Title property may be used to state the default value, whereas the text property is used for the localised values.
  Consider this annotation //Example~:// An ORDER annotation type that is attached to a code item ACME. If both the Annotation Text and Annotation Title have values, then the Annotation Text value (e.g. en:10,es:20) is used for the localized values instead of the Annotation Title (e.g. 30) which would only be taken if the locale in the context is not found among the specified ones.
--==== URL value defaults and specific locale values ====
++=== URL value defaults and specific locale values ===
  ===== SDMX 2.1 and earlier =====
@@ -131,26 +131,22 @@
  Multiple URL localised properties were introduced in SDMX 3.0. Therefore, the URL work-around in the above paragraph is not recommended. The URL property should be used as shown in the table.
--
  == General and Display-related Annotation types ==
--|Annotation Type|Use Case|Where to attach|(((
++|(% style="width:152px" %)Annotation Type|(% style="width:559px" %)Use Case|Where to attach|(((
  +Text
  Blue is optional
  )))|(((
  Title
--
  Blue is optional
  )))|(((
  SDMX 2.1:URL
--
  SDMX >=3.0:+URL
--
  Blue is optional
  )))
--|FULL_NAME|Alternative name to be displayed for items in Item Schemes (e.g. Codelists, Concept Schemes, Category Schemes) whenever the item is displayed without its parent. For example, if a code list that has a hierarchy is displayed as a flat list, then this annotation may be used to provide sufficient context for the code. Concatenation of code + heading in NACE Rev.2.1
--en: A0123 Growing of citrus fruits|Item in an Item Scheme|(((
++|(% style="width:152px" %)FULL_NAME|(% style="width:559px" %)Alternative name to be displayed for items in Item Schemes (e.g. Codelists, Concept Schemes, Category Schemes) whenever the item is displayed without its parent. For example, if a code list that has a hierarchy is displayed as a flat list, then this annotation may be used to provide sufficient context for the code. Concatenation of code + heading in NACE Rev.2.1
++en: A0123 Growing of citrus fruits|(% style="width:20px" %)Item in an Item Scheme|(% style="width:506px" %)(((
  <language>:<content>,
  <language>:<content>,…
@@ -158,28 +158,28 @@
  //Example~://
  en:Labour force (Employment)
--)))|<content>|
--|REPLACE_NAME|Replace each code name in a component by the value of another component in an observation or series|A Dataflow or DSD| |(((
++)))|(% style="width:178px" %)<content>|(% style="width:866px" %)
++|(% style="width:152px" %)REPLACE_NAME|(% style="width:559px" %)Replace each code name in a component by the value of another component in an observation or series|(% style="width:20px" %)A Dataflow or DSD|(% style="width:506px" %) |(% style="width:178px" %)(((
  <component Id to replace name>:<component Id to use name>
  //Example~://
  CUST_BREAKDOWN:CUST_BREAKDOWN_LB
--)))|
--|REPLACE_CONTENT|Replace the content in a component by the value of another component in an observation or series|A Dataflow or DSD| |(((
++)))|(% style="width:866px" %)
++|(% style="width:152px" %)REPLACE_CONTENT|(% style="width:559px" %)Replace the content in a component by the value of another component in an observation or series|(% style="width:20px" %)A Dataflow or DSD|(% style="width:506px" %) |(% style="width:178px" %)(((
  <component Id to replace content>:<component Id to use content>
  //Example~://
  REF_AREA:M49_CODE
--)))|
--|COMPLEMENT|(((
++)))|(% style="width:866px" %)
++|(% style="width:152px" %)COMPLEMENT|(% style="width:559px" %)(((
  Additional fixed text to be displayed in parenthesis after the code name.
  E.g. Representation of Non-hazardous (NHAZW), hazardous waste (HAZW) in the European List of Wastes
  en: 01 03 04* acid-generating tailings from processing of sulphide ore (HAZW)
  en: 01 03 99 wastes not otherwise specified (NHAZW)
--)))|Item in an Item Scheme|(((
++)))|(% style="width:20px" %)Item in an Item Scheme|(% style="width:506px" %)(((
  <language>:<content>,
  <language>:<content>,…
@@ -187,13 +187,13 @@
  //Example~://
  en:See reference metadata
--)))|<content>|
--|ORDER|Explicit indication of a localised order of items in Items Schemes or artefacts (e.g. Codelist, Concept Scheme, Category Scheme, Dataflow, etc.)|(((
++)))|(% style="width:178px" %)<content>|(% style="width:866px" %)
++|(% style="width:152px" %)ORDER|(% style="width:559px" %)Explicit indication of a localised order of items in Items Schemes or artefacts (e.g. Codelist, Concept Scheme, Category Scheme, Dataflow, etc.)|(% style="width:20px" %)(((
  Either:
  * an artefact, or;
  * an item in an Item Scheme
--)))|(((
++)))|(% style="width:506px" %)(((
  <language>:<content>,
  <language>:<content>,…
@@ -201,43 +201,42 @@
  //Example~://
  en:10,es:20
--)))|(((
++)))|(% style="width:178px" %)(((
  <content>
--)))|
--|TOTAL|(((
++)))|(% style="width:866px" %)
++|(% style="width:152px" %)TOTAL|(% style="width:559px" %)(((
  Code Item that represents a total value. If the attachment is:
  * to a Code, the Annotation Text is optional and may contain an explanatory text;
--
--to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total
--)))|(((
++* to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total
++)))|(% style="width:20px" %)(((
  Either:
  * a Code Item that represents a total value, or;
  * a Codelist to specify the code(s) with the total
--)))|(((
++)))|(% style="width:506px" %)(((
  <language>:<explanatory text>,
  <language>:<explanatory text>,…
--)))|(((
++)))|(% style="width:178px" %)(((
  Attached to Code Item: <blank>
  Attached to Codelist: <code>,<code>,…
--)))|
--|DRILLDOWN|Denotes the concept that specifies whether observations are at the aggregate level or a drilldown.|(((
++)))|(% style="width:866px" %)
++|(% style="width:152px" %)DRILLDOWN|(% style="width:559px" %)Denotes the concept that specifies whether observations are at the aggregate level or a drilldown.|(% style="width:20px" %)(((
  Either:
  * A Dataflow or DSD
--)))| |(((
++)))|(% style="width:506px" %) |(% style="width:178px" %)(((
  <concept Id>
  //Example~://
  DD_DIM (this concept should be hidden using the NOT_DISPLAYED Annotation below)
--)))|
--|DEPRECATED|(((
++)))|(% style="width:866px" %)
++|(% style="width:152px" %)DEPRECATED|(% style="width:559px" %)(((
  Indication that an Item in an Item Scheme or an artefact is deprecated.
  For an item scheme item, the annotation value provides a replacement name for the code name.
@@ -252,12 +252,12 @@
  or
  TITLE: true (false)
--)))|(((
++)))|(% style="width:20px" %)(((
  Either:
  * an artefact, or;
  * an item in an Item Scheme
--)))|(((
++)))|(% style="width:506px" %)(((
  For item scheme item:
  <language>:<content>,
@@ -267,7 +267,7 @@
  //Example~://
  en:deprecated,fr:obsolète
--)))|<content>|(((
++)))|(% style="width:178px" %)<content>|(% style="width:866px" %)(((
  For artefact:
  <see section URL value defaults and specific locale values>
@@ -274,30 +274,30 @@
  )))
--|DEFAULT|(((
++|(% style="width:152px" %)DEFAULT|(% style="width:559px" %)(((
  Indication that an item in an Item Scheme or artefacts is to be selected by default.
  The Annotation defines a selection so that a pre-defined default subset of data can be processed (e.g. visualised, extracted) instead of the entire dataset
--)))|(((
++)))|(% style="width:20px" %)(((
  * Item in ItemScheme, or;
  * DSD, or;
  * a Dataflow
  Note: A DEFAULT Annotation attached to a later level in this list supersedes that attached to an earlier level. E.g., a DEFAULT Annotation attached to individual Codes in Codelists is only to be used when there is no DEFAULT Annotation attached to the Dataflow nor to the DSD, and those of DSDs are only to be used when there is no DEFAULT Annotation attached to the Dataflow.
--)))| |(((
++)))|(% style="width:506px" %) |(% style="width:178px" %)(((
  Attached to:
  - DSD or Dataflow:
-- **<concept>=<code>+<code>+…,<concept>=<code>+<code>+…**
++**<concept>=<code>+<code>+…,<concept>=<code>+<code>+…**
  //Example~:// FREQ=A+Q,TIME_PERIOD_START=2013-01,TIME_PERIOD_END=2018-12
--)))|
--|IMAGE|A visual identity to associate to Item Scheme Items or artefacts|(((
++)))|(% style="width:866px" %)
++|(% style="width:152px" %)IMAGE|(% style="width:559px" %)A visual identity to associate to Item Scheme Items or artefacts|(% style="width:20px" %)(((
  Either:
  * an artefact, or;
  * an item in an item scheme
--)))|(((
++)))|(% style="width:506px" %)(((
  For localised content in SDMX 2.1
  <language>:<HTML containing URL to the resource>,
@@ -307,7 +307,7 @@
  //Example~://
  en:<a href=”https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg”>
--)))| |(((
++)))|(% style="width:178px" %) |(% style="width:866px" %)(((
  See section URL value defaults and specific locale values.
  //Example~://
@@ -316,19 +316,19 @@
  )))
--|DRILLDOWN_CONCEPTS|Concepts to be displayed in a drilldown operation|Dataflow or DSD| |(((
++|(% style="width:152px" %)DRILLDOWN_CONCEPTS|(% style="width:559px" %)Concepts to be displayed in a drilldown operation|(% style="width:20px" %)Dataflow or DSD|(% style="width:506px" %) |(% style="width:178px" %)(((
  <concept Id>,<concept Id>,…
  Example :
  DONOR,RECIPIENT,YEAR,PROJECT_ID,OBS_VALUE,DESCRIPTION,OWNER
--)))|
--|NOT_DISPLAYED|Used to hide components or their values in the presentation|(((
++)))|(% style="width:866px" %)
++|(% style="width:152px" %)NOT_DISPLAYED|(% style="width:559px" %)Used to hide components or their values in the presentation|(% style="width:20px" %)(((
  Either:
  * a Dataflow or DSD, or;
  * an Item in an Item Scheme
--)))| |(((
++)))|(% style="width:506px" %) |(% style="width:178px" %)(((
  Attached to Item in Item Scheme: <blank>
  Attached to Dataflow or DSD:
@@ -338,13 +338,13 @@
  Example :
  DD_DIM (to hide drilldown control concept)
--)))|
--|LAYOUT_ROW|Dimensions to be presented in rows (concepts on y-axis)|(((
++)))|(% style="width:866px" %)
++|(% style="width:152px" %)LAYOUT_ROW|(% style="width:559px" %)Dimensions to be presented in rows (concepts on y-axis)|(% style="width:20px" %)(((
  Either:
  * an artefact, or;
  * a Dimension
--)))| |(((
++)))|(% style="width:506px" %) |(% style="width:178px" %)(((
  Attached to Dimension: <blank>
  Attached to Dataflow or DSD: <dimension Id>,<dimension Id >,…
@@ -352,13 +352,13 @@
  //Example~://
  REF_AREA,MEASURE
--)))|
--|LAYOUT_COLUMN|Dimensions to be presented in columns (concepts on x-axis)|(((
++)))|(% style="width:866px" %)
++|(% style="width:152px" %)LAYOUT_COLUMN|(% style="width:559px" %)Dimensions to be presented in columns (concepts on x-axis)|(% style="width:20px" %)(((
  Either:
  * an artefact, or;
  * a Dimension
--)))| |(((
++)))|(% style="width:506px" %) |(% style="width:178px" %)(((
  Attached to Dimension: <blank>
  Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,…
@@ -366,33 +366,33 @@
  //Example~://
  TIME_PERIOD
--)))|
--|LAYOUT_FLAG|Indication that an attribute and its attribute value should be presented as a flag|Dataflow| |(((
++)))|(% style="width:866px" %)
++|(% style="width:152px" %)LAYOUT_FLAG|(% style="width:559px" %)Indication that an attribute and its attribute value should be presented as a flag|(% style="width:20px" %)Dataflow|(% style="width:506px" %) |(% style="width:178px" %)(((
  <concept Id>,<concept Id>,...
  //Example~://
  OBS_STATUS,CONF_STATUS
--)))|
--|LAYOUT_NOTE|Indication that an attribute and its attribute value should  be presented as a note|Dataflow| |(((
++)))|(% style="width:866px" %)
++|(% style="width:152px" %)LAYOUT_NOTE|(% style="width:559px" %)Indication that an attribute and its attribute value should  be presented as a note|(% style="width:20px" %)Dataflow|(% style="width:506px" %) |(% style="width:178px" %)(((
  <concept Id>,<concept Id>,...
  //Example~://
  OBS_STATUS,CONF_STATUS
--)))|
--|(((
++)))|(% style="width:866px" %)
++|(% style="width:152px" %)(((
  METADATA
--)))|Links an MSD directly to a DSD. Can be used to overcome the complexities of reference metadata linkage|DSD| |MSD URI, e.g. urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataStructure=OECD:MSD_REF_METADATA(1.0)|
--|LAYOUT_ROW_SECTION|Dimension to be presented as a break-down concept at a third hierarchical level above columns and rows.|(((
++)))|(% style="width:559px" %)Links an MSD directly to a DSD. Can be used to overcome the complexities of reference metadata linkage|(% style="width:20px" %)DSD|(% style="width:506px" %) |(% style="width:178px" %)MSD URI, e.g. urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataStructure=OECD:MSD_REF_METADATA(1.0)|(% style="width:866px" %)
++|(% style="width:152px" %)LAYOUT_ROW_SECTION|(% style="width:559px" %)Dimension to be presented as a break-down concept at a third hierarchical level above columns and rows.|(% style="width:20px" %)(((
  Either:
  * an artefact, or;
  a Dimension
--)))| |(((
++)))|(% style="width:506px" %) |(% style="width:178px" %)(((
  Attached to Dimension: <blank>
  Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,…
@@ -400,12 +400,12 @@
  //Example~://
  SEX
--)))|
--|EXT_RESOURCE|(((
++)))|(% style="width:866px" %)
++|(% style="width:152px" %)EXT_RESOURCE|(% style="width:559px" %)(((
  A localised link to an external resource associated to the annotated artefact. For example, an ontology item
  //a methodology// en:<a href:"[[https:~~/~~/ec.europa.eu/eurostat/web/waste/methodology>>url:https://ec.europa.eu/eurostat/web/waste/methodology]]">
--)))|Any SDMX object|(((
++)))|(% style="width:20px" %)Any SDMX object|(% style="width:506px" %)(((
  For localised content in SDMX 2.1
   <language>:<HTML containing URL to the resource>,
@@ -415,7 +415,7 @@
  //Example~://
  en:<a href=”[[http:~~/~~/rdf-vocabulary.ddialliance.org/xkos#depth>>url:http://rdf-vocabulary.ddialliance.org/xkos#depth]]”>
--)))| |(((
++)))|(% style="width:178px" %) |(% style="width:866px" %)(((
  See section URL value defaults and specific locale values.
  //Example~://
@@ -422,29 +422,29 @@
  http:~/~/rdf-vocabulary.ddialliance.org/xkos#depth
  )))
--|COMBINED_CONCEPTS|(((
++|(% style="width:152px" %)COMBINED_CONCEPTS|(% style="width:559px" %)(((
  Comma-separated list of concept IDs to show as a concatenated label.
  The listed concepts’ item contents may be concatenated to generate the target concept.
  Multiple target concept combinations can be defined by separating the target concepts by ;
--)))|Dataflow or DSD|(((
++)))|(% style="width:20px" %)Dataflow or DSD|(% style="width:506px" %)(((
  <language>:<display name>,
  <language>:<display name>
  e.g. COMBINED_UNIT_MEASURE:PRICE_BASE,UNIT_MEASURE;COMBINED_MEASURE:MEASURE,REF_SECTOR{(en):Combined unit of measure;Combined measure}{(fr):Unité de mesure combinée;Mesure combinée}
--)))| |
--|(deprecated) UNIT_MEASURE_CONCEPTS|(((
++)))|(% style="width:178px" %) |(% style="width:866px" %)
++|(% style="width:152px" %)(deprecated) UNIT_MEASURE_CONCEPTS|(% style="width:559px" %)(((
  Comma-separated list of concept IDs that is used to define the full unit of measure. The concepts must be in the DSD.
  The listed concepts’ item contents may be concatenated to generate the unit of measure label (unless the UNIT_MEASURE_LABEL annotation is present).
--)))|Dataflow or DSD| |(((
++)))|(% style="width:20px" %)Dataflow or DSD|(% style="width:506px" %) |(% style="width:178px" %)(((
  <concept Id>,<concept Id>,…
  //Example~:// UNIT_MEASURE,UNIT_MULT,TRANSFORMATION [could generate a value of Australian Dollar, Thousands, Non-transformed]
--)))|
--|(deprecated) UNIT_MEASURE_LABEL|(((
++)))|(% style="width:866px" %)
++|(% style="width:152px" %)(deprecated) UNIT_MEASURE_LABEL|(% style="width:559px" %)(((
  Indicates the concept that enumerates the full unit of measure labels.
  The concept must be in the DSD. UNIT_MEASURE_LABEL overrides the UNIT_MEASURE_CONCEPTS if both are provided.
@@ -454,7 +454,7 @@
  Text     en:Gram
             fr: Gramme
  url:** **[[**http:~~/~~/data.europa.eu/gzn/su/G**>>url:http://data.europa.eu/gzn/su/G]]
--)))|Dataflow or DSD, Item in an Item Scheme|(((
++)))|(% style="width:20px" %)Dataflow or DSD, Item in an Item Scheme|(% style="width:506px" %)(((
  This is optional, used if a freetext label is required.
  <language>:<content>,
@@ -466,7 +466,7 @@
  en:USD, thousands
  fr:USD, milliers
--)))|(((
++)))|(% style="width:178px" %)(((
  This is optional, used if an enumerated list is required.
  <concept Id>
@@ -479,21 +479,21 @@
  * USD, thousands
  Index, based on National Currency]
--)))|
--|(((
++)))|(% style="width:866px" %)
++|(% style="width:152px" %)(((
  LAYOUT_TIME_PERIOD_DESC
--)))|Indication that the display of the TIME_PERIOD dimension for a dataflow, or all dataflows of the same DSD, is to be done in descending sort order.|Dataflow, DSD| |(((
++)))|(% style="width:559px" %)Indication that the display of the TIME_PERIOD dimension for a dataflow, or all dataflows of the same DSD, is to be done in descending sort order.|(% style="width:20px" %)Dataflow, DSD|(% style="width:506px" %) |(% style="width:178px" %)(((
  //Example~://
  LAYOUT_TIME_PERIOD_DESC
--)))|
--|(((
++)))|(% style="width:866px" %)
++|(% style="width:152px" %)(((
  LAYOUT_CELL_ALIGN
--)))|Indication to force the data cell alignment to the left or to the right. This can be defined generically for all locales or per locale.|Dataflow, DSD, Dimension|(((
++)))|(% style="width:559px" %)Indication to force the data cell alignment to the left or to the right. This can be defined generically for all locales or per locale.|(% style="width:20px" %)Dataflow, DSD, Dimension|(% style="width:506px" %)(((
  <language>:<content>,
  <language>:<content>,…
@@ -500,300 +500,171 @@
  <content> values:RIGHT or LEFT
--)))|Content values:RIGHT or LEFT|
--|(((
++)))|(% style="width:178px" %)Content values:RIGHT or LEFT|(% style="width:866px" %)
++|(% style="width:152px" %)(((
  MAX_TABLE_DATA
--)))|Increase the maximum preview table size above default maximum limits for the number of observations retrieved from the SDMX web service and for the number of table cells|Dataflow| |(((
++)))|(% style="width:559px" %)Increase the maximum preview table size above default maximum limits for the number of observations retrieved from the SDMX web service and for the number of table cells|(% style="width:20px" %)Dataflow|(% style="width:506px" %) |(% style="width:178px" %)(((
  <integer>
  //Example~://
--)))|
--|(((
++)))|(% style="width:866px" %)
++|(% style="width:152px" %)(((
  MAXTEXTATTRIBUTELENGTH
--)))|Increase the maximum length for textual attribute values|DSD| |(((
++)))|(% style="width:559px" %)Increase the maximum length for textual attribute values|(% style="width:20px" %)DSD|(% style="width:506px" %) |(% style="width:178px" %)(((
  <integer>
  //Example~://
--)))|
--|SEARCH_WEIGHT|Indication of localised boosted dataflows in the search results when ordered by relevance|Dataflow|(((
++)))|(% style="width:866px" %)
++|(% style="width:152px" %)SEARCH_WEIGHT|(% style="width:559px" %)Indication of localised boosted dataflows in the search results when ordered by relevance|(% style="width:20px" %)Dataflow|(% style="width:506px" %)(((
  <language>:<integer>,...
  //Example~://
  "en":"3","es":"4","fr":"5"
--)))|(((
++)))|(% style="width:178px" %)(((
  <integer>
  //Example~://
--)))|
++)))|(% style="width:866px" %)
  == Codelist and Statistical Classification-specific Annotations ==
--The categories below are used widely, for example by the European Statistical System (ESS), and the United Nations Statistics Division for its central framework classifications ISIC4[[~[2~]>>path:#_ftn2]] and CPC[[~[3~]>>path:#_ftn3]].
++The categories below are used widely, for example by the European Statistical System (ESS), and the United Nations Statistics Division for its central framework classifications ISIC4{{footnote}}International Standard Industrial Classification of All Economic Activities{{/footnote}} and CPC{{footnote}}Central Product Classification{{/footnote}}.
--|Annotation Type|Use Case|Where to attach|(((
--+Text
--Blue is optional
--)))|(((
--Title
--
--Blue is optional
--)))|(((
--SDMX 2.1:URL
--
++|**Annotation Type**|(% style="width:524px" %)**Use Case**|(% style="width:198px" %)**Where to attach**|(% style="width:237px" %)(((
++**+Text
++(% style="background-color:transparent" %)Blue is optional(%%)**
++)))|(% style="width:320px" %)(((
++**Title
++(% style="background-color:transparent" %)Blue is optional(%%)**
++)))|(% style="width:203px" %)(((
++**SDMX 2.1:URL
  SDMX >=3.0:+URL
--
--Blue is optional
++(% style="background-color:transparent" %)Blue is optional(%%)**
  )))
--|ORIGINAL_CODE|Code as displayed in other representations, such as official or original documentation (i.e. possibly containing dots, spaces, etc.). Reference to external standard: skos:notation|Item in an Item Scheme| |(((
--<original code>
--
--//Examples~://
--
--* 0105.13 [Harmonized System]
--* 11.2.0.9 [COICOP classification]
--)))|
--|HIER_CONTEXT|(((
--In SDMX 2.1, a reference between a usage context and a hierarchy (that may be contained in a Hierarchical Codelist (HCL)).
--
--In SDMX 3.0, use the HierarchyAssociation artefact
--)))|DSD or Dataflow| |(((
--<component Id>:<HCL Id>.<hierarchy Id>
--
++|FULL_NAME|(% style="width:524px" %)Alternative name to be displayed for items in Item Schemes (e.g. Codelists, Concept Schemes, Category Schemes) whenever the item is displayed without its parent. For example, if a code list that has a hierarchy is displayed as a flat list, then this annotation may be used to provide sufficient context for the code. Concatenation of code + heading in NACE Rev.2.1
++en: A0123 Growing of citrus fruits|(% style="width:198px" %)Item in an Item Scheme|(% style="width:237px" %)(((
++<language>:<content>,<language>:<content>,…
  //Example~://
--
--REF_AREA:OECD.EDU:HCL_REF_AREA(1.0).REF_AREA provides the link to the  reference area hierarchy for OECD education data
--)))|
--|HIER_LEVEL|(((
--Explicit specification of the hierarchical level of a code item
--
--Reference to external standard: xkos:ClassificationLevel - property: xkos:xdepth url: [[http:~~/~~/data.europa.eu/ux2/nace2.1/sections>>url:http://data.europa.eu/ux2/nace2.1/sections]]
--
--text en:sections
--)))|Code item| |(((
--<hierarchical level>
--
++(% style="background-color:transparent" %)en:Labour force (Employment)
++)))|(% style="width:320px" %)<content>|(% style="width:203px" %)
++|REPLACE_NAME|(% style="width:524px" %)Replace each code name in a component by the value of another component in an observation or series|(% style="width:198px" %)A Dataflow or DSD|(% style="width:237px" %) |(% style="width:320px" %)(((
++<component Id to replace name>:<component Id to use name>
  //Example~://
--
--1
--)))|
--|SHORT_LABEL|A short label, typically for dissemination purposes where long labels are sometimes not appropriate for presentation in tables where space is an important parameter (generally less than 40 or 50 characters)|Artefact, or Concept, or Item in an Item Scheme|(((
--<language>:<content>,
--
--<language>:<content>,…
--)))|(((
++(% style="background-color:transparent" %)CUST_BREAKDOWN:CUST_BREAKDOWN_LB
++)))|(% style="width:203px" %)
++|REPLACE_CONTENT|(% style="width:524px" %)Replace the content in a component by the value of another component in an observation or series|(% style="width:198px" %)A Dataflow or DSD|(% style="width:237px" %) |(% style="width:320px" %)(((
++<component Id to replace content>:<component Id to use content>
  //Example~://
++(% style="background-color:transparent" %)REF_AREA:M49_CODE
++)))|(% style="width:203px" %)
++|COMPLEMENT|(% style="width:524px" %)(((
++Additional fixed text to be displayed in parenthesis after the code name.
++(% style="background-color:transparent" %)E.g. Representation of Non-hazardous (NHAZW), hazardous waste (HAZW) in the European List of Wastes(%%)
++(% style="background-color:transparent" %)en: 01 03 04* acid-generating tailings from processing of sulphide ore (HAZW)(%%)
++(% style="background-color:transparent" %)en: 01 03 99 wastes not otherwise specified (NHAZW)
++)))|(% style="width:198px" %)Item in an Item Scheme|(% style="width:237px" %)(((
++<language>:<content>,<language>:<content>,…
--[Official French label “Transformation et conservation de la viande de boucherie” is shortened to] fr:Transf. & conserv. viande de boucherie
--
--
--In Codelist=IMF:CL_AREA(1.13)
--Code 4J837 European Union Intellectual Property Office has a Short_Label
--
--EN:EUIPO
--)))|
--|EXPLAN_LABEL|An explanatory text that specifies “other” and similar categories. An example is the Combined Nomenclature classification where the many codes labelled “other” are complemented by a verbose text describing in detail the content of the code item|Item in an Item Scheme, mapping to Representation Maps|(((
--<language>:<content>,
--
--<language>:<content>,…
--)))|(((
  //Example~://
++(% style="background-color:transparent" %)en:See reference metadata
++)))|(% style="width:320px" %)<content>|(% style="width:203px" %)
++|ORDER|(% style="width:524px" %)Explicit indication of a localised order of items in Items Schemes or artefacts (e.g. Codelist, Concept Scheme, Category Scheme, Dataflow, etc.)|(% style="width:198px" %)(((
++Either:
--[EU Combined Nomenclature official label for code 3824 99 57 reads “Other”, which is not very informative for the user; instead the EXPLAN_LABEL reads] en:Cartridges and refills, filled, for electronic cigarettes, and preparations for use in the cartridges and refills, not containing nicotine or its salts, ethers, esters or other derivatives thereof
--)))|
--|EXPLAN_CONSOL|Explanatory notes. An explanatory text to be used when objects included in and excluded from a classification position are consolidated, i.e. are presented together. Reference to external standard: skos:scopeNote|Item in an Item Scheme, mapping to Representation Maps|(((
--<language>:<content>,
++* an artefact, or;
++* an item in an Item Scheme
++)))|(% style="width:237px" %)(((
++<language>:<content>,<language>:<content>,…
--<language>:<content>,…
--)))|(((
--Example (from the US NAICS classification):
--
--en:Industries in the Food Manufacturing subsector transform livestock and agricultural products into products for intermediate or final consumption. […] The food products manufactured in these establishments are typically sold to wholesalers or retailers for distribution to consumers, but establishments primarily engaged in retailing bakery and candy products made on the premises not for immediate consumption are included. Establishments primarily engaged in manufacturing beverages are classified in Subsector 312, Beverage and Tobacco Product Manufacturing.
--)))|
--|EXPLAN_INCLUDES|Explanatory notes. Description of those things known specifically to be included in the concept. Synonyms Typical labels for such explanatory notes: "This class includes", "This category includes", "This position includes", "Includes", etc. Reference to external standard: xkos:inclusionNote or xkos:coreContentNote (if  EXPLAN_INCLUDES_ALSO available)|Item in an Item Scheme, mapping to Representation Maps|(((
--<language>:<content>,
--
--<language>:<content>,…
--)))|(((
--Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition):
--
--en: This class includes:
--
--* manufacture of heavy weapons (artillery, mobile guns, rocket launchers, torpedo tubes, heavy machine guns)
--* manufacture of small arms (revolvers, shotguns, light machine guns)
--* manufacture of air or gas guns and pistols
--* manufacture of war ammunition
--)))|
--|EXPLAN_CASELAW|Explanatory notes. Indication that a decision on the classification has been made by the ad hoc Committee (concept generally described as “ruling”, “classification opinion”, classification decision; caselaw). : Reference to external standardxkos:caseLaw. The difference between caselaws and traditional explanatory notes is that caselaws are adopted during the time period between two official versions of a specific classification and have thus a slightly different status (e.g. from a legal viewpoint)|Item in an Item Scheme|(((
--<language>:<content>,
--
--<language>:<content>,…
--
--Example (from NACE Rev. 2 caselaw to code 01.62):
--
--en:Automated egg hatching for poultry - Operation of livestock management systems]
--)))| |
--|EXPLAN_INCLUDES_ALSO|Explanatory notes. Description of those things which can be considered as borderline cases and are generally based on consensus rather than strict methodological principles (e.g. classifying wooden shoes as handicraft rather than shoes). Typical labels for such explanatory notes: "This class includes also", "This category includes also", "This position includes also ", "Includes also", etc. Reference to external standard: xkos:additionalContentNote|Item in an Item Scheme|(((
--<language>:<content>,
--
--<language>:<content>,…
--)))|(((
--Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition):
--
--en:This class also includes:
--
--* manufacture of hunting, sporting or protective firearms and ammunition
--* manufacture of explosive devices such as bombs, mines and torpedoes
--)))|
--|EXPLAN_EXCLUDES|Explanatory notes. Description of those things which are explicitly excluded from a category. Typical labels for such explanatory notes: "This class excludes", "This category excludes", "This position excludes", "Excludes", etc. Reference to external standards: xkos:exclusionNote|(((
--Item in an Item Scheme
--
--
--)))|(((
--<language>:<content>,
--
--<language>:<content>,…
--)))|(((
--Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition):
--
--en:This class excludes:
--
--* manufacture of percussion caps, detonators or signalling flares, see 2029
--* manufacture of cutlasses, swords, bayonets etc., see 2593
--)))|
--|MAP_REFER|A reference to a classification mapping or transformation, e.g. an SDMX Structure Map. Reference to external standard: skos:mappingRelation (skos:broadMatch, skos:narrowMatch, skos:closeMatch, skos:exactMatch or skos:relatedMatch)|Codelist, Concept Scheme, or another Item Scheme| |Id of an ItemSchemeMap returned by the Annotation URL|(((
--See section URL value defaults and specific locale values.
--
--
--)))
--|COMP_RULE|Code item composition rule. For example, for code A the composition rule may be “A1+A2” where A1 and A2 are other codes in the same Codelist|An Item in an Item Scheme| |(((
--<content>
--
  //Example~://
++(% style="background-color:transparent" %)en:10,es:20
++)))|(% style="width:320px" %)<content>|(% style="width:203px" %)
++|TOTAL|(% style="width:524px" %)(((
++Code Item that represents a total value. If the attachment is:
--A1+A2
--)))|
--|FOLLOWS|(((
--A reference used to express the succession in time of Item Schemes.
++* to a Code, the Annotation Text is optional and may contain an explanatory text;
++* to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total
++)))|(% style="width:198px" %)(((
++Either:
--For example, NACE Rev. 2 is the successor of NACE Rev. 1.1
++* a Code Item that represents a total value, or;
++* a Codelist to specify the code(s) with the total
++)))|(% style="width:237px" %)(((
++<language>:<explanatory text>,
++(% style="background-color:transparent" %)<language>:<explanatory text>,…
++)))|(% style="width:320px" %)(((
++Attached to Code Item: <blank>
++(% style="background-color:transparent" %)Attached to Codelist: <code>,<code>,…
++)))|(% style="width:203px" %)
++|DRILLDOWN|(% style="width:524px" %)Denotes the concept that specifies whether observations are at the aggregate level or a drilldown.|(% style="width:198px" %)(((
++Either:
--Reference to external standard: skos:ConceptScheme - property: xkos:follows
--)))|Codelist or Item Scheme| | |(((
--See section URL value defaults and specific locale values.
--
++* A Dataflow or DSD
++)))|(% style="width:237px" %) |(% style="width:320px" %)(((
++<concept Id>
  //Example~://
++(% style="background-color:transparent" %)DD_DIM (this concept should be hidden using the NOT_DISPLAYED Annotation below)
++)))|(% style="width:203px" %)
++|DEPRECATED|(% style="width:524px" %)(((
++Indication that an Item in an Item Scheme or an artefact is deprecated.
++For an item scheme item, the annotation value provides a replacement name for the code name.
++For an artefact, the URL points to the replacement artefact. May be used in conjunction with SUPERSEED where the replacement artefact references the replaced artefact.
++Suggestion to use a controlled vocabulary
++url: <[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/CURRENT>>url:http://publications.europa.eu/resource/authority/concept-status/CURRENT]]>
++url: <[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/DEPRECATED>>url:http://publications.europa.eu/resource/authority/concept-status/DEPRECATED]]>
++or
++(% style="background-color:transparent" %)TITLE: true (false)
++)))|(% style="width:198px" %)(((
++Either:
--(CL_REGIONAL 3.1.1 follows CL_REGIONAL 3.1):
++* an artefact, or;
++* an item in an Item Scheme
++)))|(% style="width:237px" %)(((
++For item scheme item:
--[[https:~~/~~/registry.sdmx.org/ws/public/sdmxapi/rest/codelist/ESTAT/CL_REGIONAL/3.1>>url:https://registry.sdmx.org/ws/public/sdmxapi/rest/codelist/ESTAT/CL_REGIONAL/3.1]]
--)))
--|HAS_VARIANT|(((
--A reference used to express the relation between an Item Scheme and its variant(s).
++<language>:<content>,<language>:<content>,…
--Reference to external standard: skos:ConceptScheme - property: xkos:variant
--
--
--For //Example~:// CL_AREA has a variant CL_GEO
--)))|Codelist or Item Scheme| | |(((
--See section URL value defaults and specific locale values.
--
--
--)))
--|SUPERSEED|(((
--A reference to a previous version, if the current version obsoleted the previous one.
--
--May be used in conjunction with DEPRECATED.
--
--Reference to external standard: skos:ConceptScheme - property: xkos:supersedes
--)))|Codelist or Item Scheme, or an artefact| | |(((
--See section URL value defaults and specific locale values.
--
--
--)))
--|FAMILY_LABEL|(((
--Label of the Classification Family (e.g. NACE, ISIC)
--
--Reference to external standard: skos:ConceptScheme - property: xkos:belongsTo
--
--label of the classification
--)))|Codelist or Item Scheme|(((
--<language>:<content>,
--
--<language>:<content>,…
--
  //Example~://
--
--en:NACE
--)))| |(((
--See section URL value defaults and specific locale values.
--
--
++(% style="background-color:transparent" %)en:deprecated,fr:obsolète
++)))|(% style="width:320px" %)<content>|(% style="width:203px" %)(((
++For artefact:
++<see section URL value defaults and specific locale values>
  )))
--|COVERAGE_LABEL|(((
--Label(s) of the item scheme’s coverage (e.g. National Accounts, Products, Activities, Occupations)
++| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
++| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
++| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
++| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
++| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
++| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
++| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
++| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
++| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
++| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
++| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %)
--Reference to external standard: skos:ConceptScheme - property: xkos:covers
--
--//Examples~://
--
--URL <http:~/~/eurovoc.europa.eu/56> (National accounts)
--
--URL <http:~/~/publications.europa.eu/resource/authority/data-theme/REGI> (Regions and Cities)
--)))|Codelist or Item Scheme|(((
--<language>:<content>,
--
--<language>:<content>,…
--
--//Example~://
--
--En:national accounts
--)))| |(((
--See section URL value defaults and specific locale values.
--
--
--)))
--|GEO_FEATURE_SET|(((
--In Codelists, transmits GeoFeature values.
--
--Example for  NUTS ID BE23
--url:[[http:~~/~~/data.europa.eu/nuts/geometry/2xr1qiv9>>url:http://data.europa.eu/nuts/geometry/2xr1qiv9]]
--)))|Code in a Codelist. The Codelist must have an annotation attached with AnnotationType=GEO_TYPE_GEOGRAPHIC| |A set of points defining a feature following the 1363 ISO/IEC 13249-3:2016 standard to conform Well-known Text (WKT) for the 1364 representation of geometries. See SDMX STANDARDS: SECTION 6 for further information on the format.|
--|GEO_TYPE_GEOGRAPHIC|Indicates that a codelist contains GeoFeature values via the GEO_FEATURE_SET annotation.|Codelist| | |
--|LEGAL_BASIS|(((
--Indicates that the Legislation on which the codelist/nomenclature is based.
--
--Example for NACE Rev.2.1
--
--url: [[http:~~/~~/data.europa.eu/eli/reg_del/2023/137/oj>>url:http://data.europa.eu/eli/reg_del/2023/137/oj]]
--)))|Codelist| | |http:~/~/data.europa.eu/eli/reg_del/2023/137/oj
--
--
--
--
--
  = Concept Scheme SDMX:CS_ANNOT =
  The Concept Scheme for standard Annotations will have the Maintenance Agency SDMX and will describe the following properties for each Annotation. For the information represented by Annotations, the value is in AnnotationTitle apart from the URL property where it is in AnnotationURL.
--|**Property**|**Representation in Concept**|**Description**
--|**Code**|Concept Id|The Annotation Type column, e.g. NOT_DISPLAYED, EXCLUDES
--|**Name**|Concept Name|Short description of the standard Annotation derived from the “Use case” column
--|**Representation**|Concept Core Representation|Allowable type or format for the Annotation
--|**Description**|Concept Description|The information in the “Use case” column. Possible to add more contextual information. Specific details can be described here, such as if the value should be in AnnotationText or AnnotationTitle
--|**Artefact(s)**|Annotation Type: Artefact(s)|The information in the “Where to attach” column
--|**URL**|Annotation Type: URL|The Annotation URL column. The value is in URL
++|**Property**|(% style="width:309px" %)**Representation in Concept**|(% style="width:1173px" %)**Description**
++|**Code**|(% style="width:309px" %)Concept Id|(% style="width:1173px" %)The Annotation Type column, e.g. NOT_DISPLAYED, EXCLUDES
++|**Name**|(% style="width:309px" %)Concept Name|(% style="width:1173px" %)Short description of the standard Annotation derived from the “Use case” column
++|**Representation**|(% style="width:309px" %)Concept Core Representation|(% style="width:1173px" %)Allowable type or format for the Annotation
++|**Description**|(% style="width:309px" %)Concept Description|(% style="width:1173px" %)The information in the “Use case” column. Possible to add more contextual information. Specific details can be described here, such as if the value should be in AnnotationText or AnnotationTitle
++|**Artefact(s)**|(% style="width:309px" %)Annotation Type: Artefact(s)|(% style="width:1173px" %)The information in the “Where to attach” column
++|**URL**|(% style="width:309px" %)Annotation Type: URL|(% style="width:1173px" %)The Annotation URL column. The value is in URL
  == Example of a Concept ==
@@ -803,8 +803,6 @@
  |**Concept Description**|To hide dimensions and attributes in a display (e.g. a table). For example, if they have only one allowed, available or selected value
  |**Concept: Annotation: Type: Artefact(s)**|Either a Dataflow or DSD, or an item in an item scheme
--===   ===
--
  === SDMX-ML of the Example ===
  <str:Concept id="NOT_DISPLAYED">
@@ -832,8 +832,4 @@
  ----
--[[~[1~]>>path:#_ftnref1]] The technical standard does not enumerate the annotation types, however this guideline provides a recommended enumeration or controlled vocabulary
--
--[[~[2~]>>path:#_ftnref2]] International Standard Industrial Classification of All Economic Activities
--
--[[~[3~]>>path:#_ftnref3]] Central Product Classification
++{{putFootnotes/}}