Wiki source code of Guidelines on Using SDMX Annotations
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
1.1 | 1 | {{box title="**Contents**"}} |
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| 5 | = DOCUMENT HISTORY = | ||
| 6 | |||
| 7 | |**Version**|**Date**|**Comment** | ||
| 8 | |1.0|01/03/2021|Initial version. | ||
| 9 | |2.0|24/04/2025|Adapted to SDMX 3.0. Extensions to controlled vocabulary. Clarified text. | ||
| 10 | |||
| 11 | = Introduction = | ||
| 12 | |||
| 13 | According to the SDMX documentation, 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. This facility is essentially a flexible extension mechanism allowing metadata to be added to an SDMX structural artefact. Annotations are often used to store metadata in artefacts when there is no specific place for that information in the SDMX information model. Presentation metadata is a prime example, such as a default presentation for a dataflow. | ||
| 14 | |||
| 15 | Note that whilst the SDMX Annotation has a specific structure (Title, Type, URL, Text) individual organisations are free to use these in any way and any combination they wish. However, an Annotation can only be processed in a meaningful way (i.e. other than viewing it) by systems that understand its semantics. | ||
| 16 | |||
| 17 | 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. The main drawback is poor interoperability as Annotations convey no semantics and are not standardised. This means that organisations that want to exchange Annotations and process them automatically must agree upon, at least, a common naming syntax. | ||
| 18 | |||
| 19 | The aim of this guideline is to improve machine interactions by proposing a controlled vocabulary for the Type property of the SDMX Annotation construct and a recommended usage for the other properties that will greatly improve the interoperability of Annotations between SDMX-compliant organisations. | ||
| 20 | |||
| 21 | The Controlled Vocabulary referred to above will be maintained as a SDMX Concept Scheme stored in the SDMX Global Repository. | ||
| 22 | |||
| 23 | = SDMX Information Model for the Annotation construct = | ||
| 24 | |||
| 25 | === SDMX 2.1 === | ||
| 26 | |||
| 27 | [[image:1768507168026-558.png]] | ||
| 28 | |||
| 29 | All classes derived from the abstract class AnnotableArtefact may have Annotations. The Annotation is used to convey extra information to describe SDMX constructs. This information may be in the form of a URL reference, a non-localised text, and/or multiple localised texts (represented by the one-to-many relationship to LocalisedString). | ||
| 30 | |||
| 31 | === SDMX 3.0 === | ||
| 32 | |||
| 33 | [[image:1768507168030-780.png]] | ||
| 34 | |||
| 35 | 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. | ||
| 36 | |||
| 37 | = Properties of the Annotation construct = | ||
| 38 | |||
| 39 | 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]]. | ||
| 40 | |||
| |
1.2 | 41 | |**Property**|(% style="width:823px" %)**Description**|(% style="width:710px" %)**Controlled vocabulary context** |
| 42 | |**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 | ||
| 43 | |**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. | ||
| 44 | |**type**|(% style="width:823px" %)((( | ||
| |
1.1 | 45 | Specifies how the Annotation is to be processed. |
| |
1.3 | 46 | 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. |
| |
1.2 | 47 | )))|(% 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. |
| 48 | |**url**|(% style="width:823px" %)((( | ||
| |
1.1 | 49 | A link to external descriptive text. |
| 50 | 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. | ||
| |
1.2 | 51 | )))|(% style="width:710px" %)A non-localised URL reference to an external resource. Used when localisation is irrelevant. |
| 52 | |**+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. | ||
| 53 | |**+text**|(% style="width:823px" %)((( | ||
| |
1.1 | 54 | An International String that provides the multilingual text content of the Annotation. |
| 55 | |||
| 56 | **Text** holds a language-specific string containing the text of the Annotation. | ||
| |
1.2 | 57 | )))|(% style="width:710px" %)A localised value for the annotation. |
| |
1.1 | 58 | |
| 59 | = Introducing Standard Annotations = | ||
| 60 | |||
| 61 | As stated earlier, a major drawback of the Annotation construct is the fact that they are not standardised for reuse when exchanging structural metadata. Annotations are containers for additional information relating to the object to which they are attached. This means that for an Annotation to be interpreted in the same way by exchange partners, a reference is needed that defines some standard behaviour and implementation. | ||
| 62 | |||
| 63 | This guideline proposes an Annotation controlled vocabulary and guidelines on their (re)use for SDMX implementers. | ||
| 64 | |||
| 65 | A standard Annotation can be defined as an Annotation that has an agreed definition in the SDMX community. Some of them, especially the general and display-related annotations also have a described behaviour. They allow diverse systems to parse the information and perform a specific action in response. | ||
| 66 | |||
| 67 | = How to Identify Standard Annotations? = | ||
| 68 | |||
| 69 | In order to be able to configure their applications to implement actions based upon standard Annotations, systems must know how to identify such Annotations. This is done by setting the Annotation **id** property to “@SDMX” which indicates that the Annotation is part of the controlled vocabulary described in the section List of Standard Annotations, and avoids using “@SDMX” for other usage contexts. For example, ORDER could be the order of codes (as described in this controlled vocabulary) or some kind of order number (a different usage). | ||
| 70 | |||
| 71 | The additional mandatory information to be provided is the **type** property that specifies the type of action to be implemented. There may be other mandatory property values depending on the type of the standard Annotation. | ||
| 72 | |||
| 73 | == Examples == | ||
| 74 | |||
| 75 | 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”. | ||
| 76 | |||
| |
1.2 | 77 | |**id***|**@SDMX**|(% style="width:249px" %)**@SDMX**|(% style="width:209px" %)**@SDMX**|(% style="width:888px" %)((( |
| |
1.1 | 78 | **Not @SDMX** |
| 79 | |||
| 80 | This is a “customer order no.” which is a different use case than the ORDER standard Annotation which is a list order | ||
| 81 | ))) | ||
| |
1.2 | 82 | |**title**| |(% style="width:249px" %) |(% style="width:209px" %) |(% style="width:888px" %)1934245 |
| 83 | |**type***|NOT_DISPLAYED|(% style="width:249px" %)EXCLUDES|(% style="width:209px" %)ORDER|(% style="width:888px" %)ORDER | ||
| 84 | |(% rowspan="2" %)**+text**|(% rowspan="2" %) |(% rowspan="2" style="width:249px" %) |(% style="width:209px" %)en :10|(% rowspan="2" style="width:888px" %) | ||
| 85 | |(% style="width:209px" %)fr :20 | ||
| |
1.1 | 86 | |
| 87 | ~* denotes a mandatory information for standard Annotations | ||
| 88 | |||
| 89 | = The Business value of Standard Annotations = | ||
| 90 | |||
| 91 | The following diagram explains the business value and decision process when deciding whether to use a standard Annotation. As can be seen, if they are used then a maximum reuse is made of the Annotation itself, tools and processes. If they are not used then bespoke Annotations, agreements, tools and processing are required to understand and make use of the information in the Annotation, and it (plus supporting tools, processes, etc.) is harder to reuse. | ||
| 92 | |||
| 93 | [[image:1768507168033-962.png]] | ||
| 94 | |||
| 95 | = List of Standard Annotations = | ||
| 96 | |||
| 97 | This section lists the standard Annotations with their typical usage contexts. This list will be expanded over time as new implementations and needs arise. When references to external standards are made (e.g. skos or xkos specifications), the reader is invited to consult the “References” section for more information. | ||
| 98 | |||
| 99 | The list of standard Annotations will be available from the SDMX Registry as artefact: SDMX:CS_ANNOT(*.*.*). Link: [[https:~~/~~/registry.sdmx.org/ws/public/sdmxapi/rest/conceptscheme/SDMX/CS_ANNOT/latest/?format=sdmx-2.1&detail=full&references=none>>url:https://registry.sdmx.org/ws/public/sdmxapi/rest/conceptscheme/SDMX/CS_ANNOT/latest/?format=sdmx-2.1&detail=full&references=none]] | ||
| 100 | |||
| 101 | **Note:** There are several Annotations that are types of name or label, e.g. FULL_NAME, SHORT_LABEL, ORIGINAL_LABEL. These Annotations have specific use cases that are described in the tables below and should not be used to replace an artefact’s or item scheme item’s Name and Description property. | ||
| 102 | |||
| 103 | == Relationships between Annotation properties == | ||
| 104 | |||
| |
1.2 | 105 | === Text value defaults and specific locale values === |
| |
1.1 | 106 | |
| 107 | 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. | ||
| 108 | |||
| 109 | 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. | ||
| 110 | |||
| |
1.2 | 111 | === URL value defaults and specific locale values === |
| |
1.1 | 112 | |
| 113 | ===== SDMX 2.1 and earlier ===== | ||
| 114 | |||
| 115 | In SDMX 2.1, the Annotation’s URL property is a single, non-localised value. There may be cases where different URLs are required for certain locales. In this case, it is recommended to use the Annotation text property and state the language and URL in an HTML fragment, for example: | ||
| 116 | |||
| 117 | fr:<a href=”https:~/~/someLink”> | ||
| 118 | |||
| 119 | When both a URL and text property for the locale exists, the text property overrides (is used instead of) the URL property. | ||
| 120 | |||
| 121 | ===== SDMX 3.0 and later ===== | ||
| 122 | |||
| 123 | 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. | ||
| 124 | |||
| 125 | == General and Display-related Annotation types == | ||
| 126 | |||
| |
1.3 | 127 | |(% style="width:152px" %)Annotation Type|(% style="width:559px" %)Use Case|Where to attach|((( |
| |
1.1 | 128 | +Text |
| 129 | |||
| 130 | Blue is optional | ||
| 131 | )))|((( | ||
| 132 | Title | ||
| 133 | Blue is optional | ||
| 134 | )))|((( | ||
| 135 | SDMX 2.1:URL | ||
| 136 | SDMX >=3.0:+URL | ||
| 137 | Blue is optional | ||
| 138 | ))) | ||
| |
1.3 | 139 | |(% 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 |
| 140 | en: A0123 Growing of citrus fruits|(% style="width:20px" %)Item in an Item Scheme|(% style="width:506px" %)((( | ||
| |
1.1 | 141 | <language>:<content>, |
| 142 | |||
| 143 | <language>:<content>,… | ||
| 144 | |||
| 145 | //Example~:// | ||
| 146 | |||
| 147 | en:Labour force (Employment) | ||
| |
1.3 | 148 | )))|(% style="width:178px" %)<content>|(% style="width:866px" %) |
| 149 | |(% 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" %)((( | ||
| |
1.1 | 150 | <component Id to replace name>:<component Id to use name> |
| 151 | |||
| 152 | //Example~:// | ||
| 153 | |||
| 154 | CUST_BREAKDOWN:CUST_BREAKDOWN_LB | ||
| |
1.3 | 155 | )))|(% style="width:866px" %) |
| 156 | |(% 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" %)((( | ||
| |
1.1 | 157 | <component Id to replace content>:<component Id to use content> |
| 158 | |||
| 159 | //Example~:// | ||
| 160 | |||
| 161 | REF_AREA:M49_CODE | ||
| |
1.3 | 162 | )))|(% style="width:866px" %) |
| 163 | |(% style="width:152px" %)COMPLEMENT|(% style="width:559px" %)((( | ||
| |
1.1 | 164 | Additional fixed text to be displayed in parenthesis after the code name. |
| 165 | |||
| 166 | E.g. Representation of Non-hazardous (NHAZW), hazardous waste (HAZW) in the European List of Wastes | ||
| 167 | en: 01 03 04* acid-generating tailings from processing of sulphide ore (HAZW) | ||
| 168 | en: 01 03 99 wastes not otherwise specified (NHAZW) | ||
| |
1.3 | 169 | )))|(% style="width:20px" %)Item in an Item Scheme|(% style="width:506px" %)((( |
| |
1.1 | 170 | <language>:<content>, |
| 171 | |||
| 172 | <language>:<content>,… | ||
| 173 | |||
| 174 | //Example~:// | ||
| 175 | |||
| 176 | en:See reference metadata | ||
| |
1.3 | 177 | )))|(% style="width:178px" %)<content>|(% style="width:866px" %) |
| 178 | |(% 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" %)((( | ||
| |
1.1 | 179 | Either: |
| 180 | |||
| 181 | * an artefact, or; | ||
| 182 | * an item in an Item Scheme | ||
| |
1.3 | 183 | )))|(% style="width:506px" %)((( |
| |
1.1 | 184 | <language>:<content>, |
| 185 | |||
| 186 | <language>:<content>,… | ||
| 187 | |||
| 188 | //Example~:// | ||
| 189 | |||
| 190 | en:10,es:20 | ||
| |
1.3 | 191 | )))|(% style="width:178px" %)((( |
| |
1.1 | 192 | <content> |
| 193 | |||
| 194 | |||
| |
1.3 | 195 | )))|(% style="width:866px" %) |
| 196 | |(% style="width:152px" %)TOTAL|(% style="width:559px" %)((( | ||
| |
1.1 | 197 | Code Item that represents a total value. If the attachment is: |
| 198 | |||
| 199 | * to a Code, the Annotation Text is optional and may contain an explanatory text; | ||
| |
1.3 | 200 | * to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total |
| 201 | )))|(% style="width:20px" %)((( | ||
| |
1.1 | 202 | Either: |
| 203 | |||
| 204 | * a Code Item that represents a total value, or; | ||
| 205 | * a Codelist to specify the code(s) with the total | ||
| |
1.3 | 206 | )))|(% style="width:506px" %)((( |
| |
1.1 | 207 | <language>:<explanatory text>, |
| 208 | |||
| 209 | <language>:<explanatory text>,… | ||
| |
1.3 | 210 | )))|(% style="width:178px" %)((( |
| |
1.1 | 211 | Attached to Code Item: <blank> |
| 212 | |||
| 213 | Attached to Codelist: <code>,<code>,… | ||
| |
1.3 | 214 | )))|(% style="width:866px" %) |
| 215 | |(% 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" %)((( | ||
| |
1.1 | 216 | Either: |
| 217 | |||
| 218 | * A Dataflow or DSD | ||
| |
1.3 | 219 | )))|(% style="width:506px" %) |(% style="width:178px" %)((( |
| |
1.1 | 220 | <concept Id> |
| 221 | |||
| 222 | //Example~:// | ||
| 223 | |||
| 224 | DD_DIM (this concept should be hidden using the NOT_DISPLAYED Annotation below) | ||
| |
1.3 | 225 | )))|(% style="width:866px" %) |
| 226 | |(% style="width:152px" %)DEPRECATED|(% style="width:559px" %)((( | ||
| |
1.1 | 227 | Indication that an Item in an Item Scheme or an artefact is deprecated. |
| 228 | |||
| 229 | For an item scheme item, the annotation value provides a replacement name for the code name. | ||
| 230 | |||
| 231 | 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. | ||
| 232 | |||
| 233 | Suggestion to use a controlled vocabulary | ||
| 234 | |||
| 235 | url: <[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/CURRENT>>url:http://publications.europa.eu/resource/authority/concept-status/CURRENT]]> | ||
| 236 | url: <[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/DEPRECATED>>url:http://publications.europa.eu/resource/authority/concept-status/DEPRECATED]]> | ||
| 237 | |||
| 238 | or | ||
| 239 | |||
| 240 | TITLE: true (false) | ||
| |
1.3 | 241 | )))|(% style="width:20px" %)((( |
| |
1.1 | 242 | Either: |
| 243 | |||
| 244 | * an artefact, or; | ||
| 245 | * an item in an Item Scheme | ||
| |
1.3 | 246 | )))|(% style="width:506px" %)((( |
| |
1.1 | 247 | For item scheme item: |
| 248 | |||
| 249 | <language>:<content>, | ||
| 250 | |||
| 251 | <language>:<content>,… | ||
| 252 | |||
| 253 | //Example~:// | ||
| 254 | |||
| 255 | en:deprecated,fr:obsolète | ||
| |
1.3 | 256 | )))|(% style="width:178px" %)<content>|(% style="width:866px" %)((( |
| |
1.1 | 257 | For artefact: |
| 258 | |||
| 259 | <see section URL value defaults and specific locale values> | ||
| 260 | |||
| 261 | |||
| 262 | ))) | ||
| |
1.3 | 263 | |(% style="width:152px" %)DEFAULT|(% style="width:559px" %)((( |
| |
1.1 | 264 | Indication that an item in an Item Scheme or artefacts is to be selected by default. |
| 265 | |||
| 266 | 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 | ||
| |
1.3 | 267 | )))|(% style="width:20px" %)((( |
| |
1.1 | 268 | * Item in ItemScheme, or; |
| 269 | * DSD, or; | ||
| 270 | * a Dataflow | ||
| 271 | |||
| 272 | 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. | ||
| |
1.3 | 273 | )))|(% style="width:506px" %) |(% style="width:178px" %)((( |
| |
1.1 | 274 | Attached to: |
| 275 | |||
| 276 | - DSD or Dataflow: | ||
| |
1.2 | 277 | **<concept>=<code>+<code>+…,<concept>=<code>+<code>+…** |
| |
1.1 | 278 | |
| 279 | //Example~:// FREQ=A+Q,TIME_PERIOD_START=2013-01,TIME_PERIOD_END=2018-12 | ||
| |
1.3 | 280 | )))|(% style="width:866px" %) |
| 281 | |(% style="width:152px" %)IMAGE|(% style="width:559px" %)A visual identity to associate to Item Scheme Items or artefacts|(% style="width:20px" %)((( | ||
| |
1.1 | 282 | Either: |
| 283 | |||
| 284 | * an artefact, or; | ||
| 285 | * an item in an item scheme | ||
| |
1.3 | 286 | )))|(% style="width:506px" %)((( |
| |
1.1 | 287 | For localised content in SDMX 2.1 |
| 288 | |||
| 289 | <language>:<HTML containing URL to the resource>, | ||
| 290 | |||
| 291 | <language>:<HTML containing URL to the resource>,… | ||
| 292 | |||
| 293 | //Example~:// | ||
| 294 | |||
| 295 | en:<a href=”https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg”> | ||
| |
1.3 | 296 | )))|(% style="width:178px" %) |(% style="width:866px" %)((( |
| |
1.1 | 297 | See section URL value defaults and specific locale values. |
| 298 | |||
| 299 | //Example~:// | ||
| 300 | |||
| 301 | https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg | ||
| 302 | |||
| 303 | |||
| 304 | ))) | ||
| |
1.3 | 305 | |(% 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" %)((( |
| |
1.1 | 306 | <concept Id>,<concept Id>,… |
| 307 | |||
| 308 | Example : | ||
| 309 | |||
| 310 | DONOR,RECIPIENT,YEAR,PROJECT_ID,OBS_VALUE,DESCRIPTION,OWNER | ||
| |
1.3 | 311 | )))|(% style="width:866px" %) |
| 312 | |(% style="width:152px" %)NOT_DISPLAYED|(% style="width:559px" %)Used to hide components or their values in the presentation|(% style="width:20px" %)((( | ||
| |
1.1 | 313 | Either: |
| 314 | |||
| 315 | * a Dataflow or DSD, or; | ||
| 316 | * an Item in an Item Scheme | ||
| |
1.3 | 317 | )))|(% style="width:506px" %) |(% style="width:178px" %)((( |
| |
1.1 | 318 | Attached to Item in Item Scheme: <blank> |
| 319 | |||
| 320 | Attached to Dataflow or DSD: | ||
| 321 | |||
| 322 | <concept Id>,<concept Id>,… | ||
| 323 | |||
| 324 | Example : | ||
| 325 | |||
| 326 | DD_DIM (to hide drilldown control concept) | ||
| |
1.3 | 327 | )))|(% style="width:866px" %) |
| 328 | |(% style="width:152px" %)LAYOUT_ROW|(% style="width:559px" %)Dimensions to be presented in rows (concepts on y-axis)|(% style="width:20px" %)((( | ||
| |
1.1 | 329 | Either: |
| 330 | |||
| 331 | * an artefact, or; | ||
| 332 | * a Dimension | ||
| |
1.3 | 333 | )))|(% style="width:506px" %) |(% style="width:178px" %)((( |
| |
1.1 | 334 | Attached to Dimension: <blank> |
| 335 | |||
| 336 | Attached to Dataflow or DSD: <dimension Id>,<dimension Id >,… | ||
| 337 | |||
| 338 | //Example~:// | ||
| 339 | |||
| 340 | REF_AREA,MEASURE | ||
| |
1.3 | 341 | )))|(% style="width:866px" %) |
| 342 | |(% style="width:152px" %)LAYOUT_COLUMN|(% style="width:559px" %)Dimensions to be presented in columns (concepts on x-axis)|(% style="width:20px" %)((( | ||
| |
1.1 | 343 | Either: |
| 344 | |||
| 345 | * an artefact, or; | ||
| 346 | * a Dimension | ||
| |
1.3 | 347 | )))|(% style="width:506px" %) |(% style="width:178px" %)((( |
| |
1.1 | 348 | Attached to Dimension: <blank> |
| 349 | |||
| 350 | Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,… | ||
| 351 | |||
| 352 | //Example~:// | ||
| 353 | |||
| 354 | TIME_PERIOD | ||
| |
1.3 | 355 | )))|(% style="width:866px" %) |
| 356 | |(% 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" %)((( | ||
| |
1.1 | 357 | <concept Id>,<concept Id>,... |
| 358 | |||
| 359 | //Example~:// | ||
| 360 | |||
| 361 | OBS_STATUS,CONF_STATUS | ||
| |
1.3 | 362 | )))|(% style="width:866px" %) |
| 363 | |(% 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" %)((( | ||
| |
1.1 | 364 | <concept Id>,<concept Id>,... |
| 365 | |||
| 366 | //Example~:// | ||
| 367 | |||
| 368 | OBS_STATUS,CONF_STATUS | ||
| |
1.3 | 369 | )))|(% style="width:866px" %) |
| 370 | |(% style="width:152px" %)((( | ||
| |
1.1 | 371 | METADATA |
| 372 | |||
| 373 | |||
| |
1.3 | 374 | )))|(% 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" %) |
| 375 | |(% 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" %)((( | ||
| |
1.1 | 376 | Either: |
| 377 | |||
| 378 | * an artefact, or; | ||
| 379 | |||
| 380 | a Dimension | ||
| |
1.3 | 381 | )))|(% style="width:506px" %) |(% style="width:178px" %)((( |
| |
1.1 | 382 | Attached to Dimension: <blank> |
| 383 | |||
| 384 | Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,… | ||
| 385 | |||
| 386 | //Example~:// | ||
| 387 | |||
| 388 | SEX | ||
| |
1.3 | 389 | )))|(% style="width:866px" %) |
| 390 | |(% style="width:152px" %)EXT_RESOURCE|(% style="width:559px" %)((( | ||
| |
1.1 | 391 | A localised link to an external resource associated to the annotated artefact. For example, an ontology item |
| 392 | |||
| 393 | //a methodology// en:<a href:"[[https:~~/~~/ec.europa.eu/eurostat/web/waste/methodology>>url:https://ec.europa.eu/eurostat/web/waste/methodology]]"> | ||
| |
1.3 | 394 | )))|(% style="width:20px" %)Any SDMX object|(% style="width:506px" %)((( |
| |
1.1 | 395 | For localised content in SDMX 2.1 |
| 396 | |||
| 397 | <language>:<HTML containing URL to the resource>, | ||
| 398 | |||
| 399 | <language>:<HTML containing URL to the resource>,… | ||
| 400 | |||
| 401 | //Example~:// | ||
| 402 | |||
| 403 | en:<a href=”[[http:~~/~~/rdf-vocabulary.ddialliance.org/xkos#depth>>url:http://rdf-vocabulary.ddialliance.org/xkos#depth]]”> | ||
| |
1.3 | 404 | )))|(% style="width:178px" %) |(% style="width:866px" %)((( |
| |
1.1 | 405 | See section URL value defaults and specific locale values. |
| 406 | |||
| 407 | //Example~:// | ||
| 408 | |||
| 409 | http:~/~/rdf-vocabulary.ddialliance.org/xkos#depth | ||
| 410 | ))) | ||
| |
1.3 | 411 | |(% style="width:152px" %)COMBINED_CONCEPTS|(% style="width:559px" %)((( |
| |
1.1 | 412 | Comma-separated list of concept IDs to show as a concatenated label. |
| 413 | |||
| 414 | The listed concepts’ item contents may be concatenated to generate the target concept. | ||
| 415 | |||
| 416 | Multiple target concept combinations can be defined by separating the target concepts by ; | ||
| |
1.3 | 417 | )))|(% style="width:20px" %)Dataflow or DSD|(% style="width:506px" %)((( |
| |
1.1 | 418 | <language>:<display name>, |
| 419 | |||
| 420 | <language>:<display name> | ||
| 421 | |||
| 422 | 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} | ||
| |
1.3 | 423 | )))|(% style="width:178px" %) |(% style="width:866px" %) |
| 424 | |(% style="width:152px" %)(deprecated) UNIT_MEASURE_CONCEPTS|(% style="width:559px" %)((( | ||
| |
1.1 | 425 | Comma-separated list of concept IDs that is used to define the full unit of measure. The concepts must be in the DSD. |
| 426 | |||
| 427 | The listed concepts’ item contents may be concatenated to generate the unit of measure label (unless the UNIT_MEASURE_LABEL annotation is present). | ||
| |
1.3 | 428 | )))|(% style="width:20px" %)Dataflow or DSD|(% style="width:506px" %) |(% style="width:178px" %)((( |
| |
1.1 | 429 | <concept Id>,<concept Id>,… |
| 430 | |||
| 431 | //Example~:// UNIT_MEASURE,UNIT_MULT,TRANSFORMATION [could generate a value of Australian Dollar, Thousands, Non-transformed] | ||
| |
1.3 | 432 | )))|(% style="width:866px" %) |
| 433 | |(% style="width:152px" %)(deprecated) UNIT_MEASURE_LABEL|(% style="width:559px" %)((( | ||
| |
1.1 | 434 | Indicates the concept that enumerates the full unit of measure labels. |
| 435 | |||
| 436 | The concept must be in the DSD. UNIT_MEASURE_LABEL overrides the UNIT_MEASURE_CONCEPTS if both are provided. | ||
| 437 | |||
| 438 | Also can be attached to items in item scheme, e.g. | ||
| 439 | |||
| 440 | Text en:Gram | ||
| 441 | fr: Gramme | ||
| 442 | url:** **[[**http:~~/~~/data.europa.eu/gzn/su/G**>>url:http://data.europa.eu/gzn/su/G]] | ||
| |
1.3 | 443 | )))|(% style="width:20px" %)Dataflow or DSD, Item in an Item Scheme|(% style="width:506px" %)((( |
| |
1.1 | 444 | This is optional, used if a freetext label is required. |
| 445 | |||
| 446 | <language>:<content>, | ||
| 447 | |||
| 448 | <language>:<content>,… | ||
| 449 | |||
| 450 | //Example~:// | ||
| 451 | |||
| 452 | en:USD, thousands | ||
| 453 | |||
| 454 | fr:USD, milliers | ||
| |
1.3 | 455 | )))|(% style="width:178px" %)((( |
| |
1.1 | 456 | This is optional, used if an enumerated list is required. |
| 457 | |||
| 458 | <concept Id> | ||
| 459 | |||
| 460 | //Example~:// | ||
| 461 | |||
| 462 | UOM_ATTRIBUTE [This concept may contain the following items as units of measure: | ||
| 463 | |||
| 464 | * National Currency, thousands | ||
| 465 | * USD, thousands | ||
| 466 | |||
| 467 | Index, based on National Currency] | ||
| |
1.3 | 468 | )))|(% style="width:866px" %) |
| 469 | |(% style="width:152px" %)((( | ||
| |
1.1 | 470 | LAYOUT_TIME_PERIOD_DESC |
| 471 | |||
| 472 | |||
| |
1.3 | 473 | )))|(% 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" %)((( |
| |
1.1 | 474 | //Example~:// |
| 475 | |||
| 476 | LAYOUT_TIME_PERIOD_DESC | ||
| |
1.3 | 477 | )))|(% style="width:866px" %) |
| 478 | |(% style="width:152px" %)((( | ||
| |
1.1 | 479 | LAYOUT_CELL_ALIGN |
| 480 | |||
| 481 | |||
| |
1.3 | 482 | )))|(% 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" %)((( |
| |
1.1 | 483 | <language>:<content>, |
| 484 | |||
| 485 | <language>:<content>,… | ||
| 486 | |||
| 487 | |||
| 488 | <content> values:RIGHT or LEFT | ||
| |
1.3 | 489 | )))|(% style="width:178px" %)Content values:RIGHT or LEFT|(% style="width:866px" %) |
| 490 | |(% style="width:152px" %)((( | ||
| |
1.1 | 491 | MAX_TABLE_DATA |
| 492 | |||
| 493 | |||
| |
1.3 | 494 | )))|(% 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" %)((( |
| |
1.1 | 495 | <integer> |
| 496 | |||
| 497 | //Example~:// | ||
| 498 | |||
| 499 | 15000 | ||
| |
1.3 | 500 | )))|(% style="width:866px" %) |
| 501 | |(% style="width:152px" %)((( | ||
| |
1.1 | 502 | MAXTEXTATTRIBUTELENGTH |
| 503 | |||
| 504 | |||
| |
1.3 | 505 | )))|(% style="width:559px" %)Increase the maximum length for textual attribute values|(% style="width:20px" %)DSD|(% style="width:506px" %) |(% style="width:178px" %)((( |
| |
1.1 | 506 | <integer> |
| 507 | |||
| 508 | //Example~:// | ||
| 509 | |||
| 510 | 500 | ||
| |
1.3 | 511 | )))|(% style="width:866px" %) |
| 512 | |(% 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" %)((( | ||
| |
1.1 | 513 | <language>:<integer>,... |
| 514 | |||
| 515 | //Example~:// | ||
| 516 | |||
| 517 | "en":"3","es":"4","fr":"5" | ||
| |
1.3 | 518 | )))|(% style="width:178px" %)((( |
| |
1.1 | 519 | <integer> |
| 520 | |||
| 521 | //Example~:// | ||
| 522 | |||
| 523 | 10 | ||
| |
1.3 | 524 | )))|(% style="width:866px" %) |
| |
1.1 | 525 | |
| 526 | == Codelist and Statistical Classification-specific Annotations == | ||
| 527 | |||
| |
1.3 | 528 | 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}}. |
| |
1.1 | 529 | |
| 530 | |||
| |
1.5 | 531 | |**Annotation Type**|(% style="width:524px" %)**Use Case**|(% style="width:198px" %)**Where to attach**|(% style="width:237px" %)((( |
| |
1.4 | 532 | **+Text |
| 533 | (% style="background-color:transparent" %)Blue is optional(%%)** | ||
| |
1.5 | 534 | )))|(% style="width:465px" %)((( |
| |
1.4 | 535 | **Title |
| 536 | (% style="background-color:transparent" %)Blue is optional(%%)** | ||
| |
1.3 | 537 | )))|((( |
| |
1.4 | 538 | **SDMX 2.1:URL |
| |
1.3 | 539 | SDMX >=3.0:+URL |
| |
1.4 | 540 | (% style="background-color:transparent" %)Blue is optional(%%)** |
| |
1.3 | 541 | ))) |
| |
1.5 | 542 | |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 |
| 543 | en: A0123 Growing of citrus fruits|(% style="width:198px" %)Item in an Item Scheme|(% style="width:237px" %)((( | ||
| 544 | <language>:<content>,<language>:<content>,… | ||
| 545 | //Example~:// | ||
| 546 | (% style="background-color:transparent" %)en:Labour force (Employment) | ||
| 547 | )))|(% style="width:465px" %)<content>| | ||
| 548 | |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:465px" %)((( | ||
| 549 | <component Id to replace name>:<component Id to use name> | ||
| 550 | //Example~:// | ||
| 551 | (% style="background-color:transparent" %)CUST_BREAKDOWN:CUST_BREAKDOWN_LB | ||
| 552 | )))| | ||
| 553 | |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:465px" %)((( | ||
| 554 | <component Id to replace content>:<component Id to use content> | ||
| 555 | //Example~:// | ||
| 556 | (% style="background-color:transparent" %)REF_AREA:M49_CODE | ||
| 557 | )))| | ||
| |
1.6 | 558 | |COMPLEMENT|(% style="width:524px" %)((( |
| 559 | Additional fixed text to be displayed in parenthesis after the code name. | ||
| 560 | (% style="background-color:transparent" %)E.g. Representation of Non-hazardous (NHAZW), hazardous waste (HAZW) in the European List of Wastes(%%) | ||
| 561 | (% style="background-color:transparent" %)en: 01 03 04* acid-generating tailings from processing of sulphide ore (HAZW)(%%) | ||
| 562 | (% style="background-color:transparent" %)en: 01 03 99 wastes not otherwise specified (NHAZW) | ||
| 563 | )))|(% style="width:198px" %)Item in an Item Scheme|(% style="width:237px" %)((( | ||
| 564 | <language>:<content>,<language>:<content>,… | ||
| 565 | |||
| 566 | //Example~:// | ||
| 567 | (% style="background-color:transparent" %)en:See reference metadata | ||
| 568 | )))|(% style="width:465px" %)<content>| | ||
| 569 | |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" %)((( | ||
| 570 | Either: | ||
| 571 | |||
| 572 | * an artefact, or; | ||
| 573 | * an item in an Item Scheme | ||
| 574 | )))|(% style="width:237px" %)((( | ||
| 575 | <language>:<content>,<language>:<content>,… | ||
| 576 | |||
| 577 | //Example~:// | ||
| 578 | (% style="background-color:transparent" %)en:10,es:20 | ||
| 579 | )))|(% style="width:465px" %)<content>| | ||
| 580 | |TOTAL|(% style="width:524px" %)((( | ||
| 581 | Code Item that represents a total value. If the attachment is: | ||
| 582 | |||
| 583 | * to a Code, the Annotation Text is optional and may contain an explanatory text; | ||
| 584 | * to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total | ||
| 585 | )))|(% style="width:198px" %)((( | ||
| 586 | Either: | ||
| 587 | |||
| 588 | * a Code Item that represents a total value, or; | ||
| 589 | * a Codelist to specify the code(s) with the total | ||
| 590 | )))|(% style="width:237px" %)((( | ||
| 591 | <language>:<explanatory text>, | ||
| 592 | (% style="background-color:transparent" %)<language>:<explanatory text>,… | ||
| 593 | )))|(% style="width:465px" %)((( | ||
| 594 | Attached to Code Item: <blank> | ||
| 595 | (% style="background-color:transparent" %)Attached to Codelist: <code>,<code>,… | ||
| 596 | )))| | ||
| 597 | |DRILLDOWN|(% style="width:524px" %)Denotes the concept that specifies whether observations are at the aggregate level or a drilldown.|(% style="width:198px" %)((( | ||
| 598 | Either: | ||
| 599 | |||
| 600 | * A Dataflow or DSD | ||
| 601 | )))|(% style="width:237px" %) |(% style="width:465px" %)((( | ||
| 602 | <concept Id> | ||
| 603 | //Example~:// | ||
| 604 | (% style="background-color:transparent" %)DD_DIM (this concept should be hidden using the NOT_DISPLAYED Annotation below) | ||
| 605 | )))| | ||
| |
1.5 | 606 | | |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:465px" %) | |
| 607 | | |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:465px" %) | | ||
| 608 | | |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:465px" %) | | ||
| 609 | | |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:465px" %) | | ||
| 610 | | |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:465px" %) | | ||
| 611 | | |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:465px" %) | | ||
| 612 | | |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:465px" %) | | ||
| 613 | | |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:465px" %) | | ||
| 614 | | |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:465px" %) | | ||
| 615 | | |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:465px" %) | | ||
| 616 | | |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:465px" %) | | ||
| 617 | | |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:465px" %) | | ||
| |
1.1 | 618 | |
| 619 | |||
| |
1.3 | 620 | |
| 621 | |FULL_NAME|(% style="width:350px" %)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 | ||
| 622 | en: A0123 Growing of citrus fruits|Item in an Item Scheme|(% style="width:288px" %)((( | ||
| 623 | <language>:<content>, | ||
| 624 | <language>:<content>,… | ||
| 625 | //Example~:// | ||
| 626 | en:Labour force (Employment) | ||
| 627 | )))|(% style="width:1427px" %)<content>| | ||
| 628 | |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:288px" %) |(% style="width:1427px" %)((( | ||
| 629 | <component Id to replace name>:<component Id to use name> | ||
| 630 | |||
| 631 | //Example~:// | ||
| 632 | |||
| 633 | CUST_BREAKDOWN:CUST_BREAKDOWN_LB | ||
| 634 | )))| | ||
| 635 | |REPLACE_CONTENT|(% style="width:350px" %)Replace the content in a component by the value of another component in an observation or series|(% style="width:250px" %)A Dataflow or DSD|(% style="width:288px" %) |(% style="width:1427px" %)((( | ||
| 636 | <component Id to replace content>:<component Id to use content> | ||
| 637 | |||
| 638 | //Example~:// | ||
| 639 | |||
| 640 | REF_AREA:M49_CODE | ||
| 641 | )))| | ||
| 642 | |(% style="width:199px" %)COMPLEMENT|(% style="width:350px" %)((( | ||
| 643 | Additional fixed text to be displayed in parenthesis after the code name. | ||
| 644 | |||
| 645 | E.g. Representation of Non-hazardous (NHAZW), hazardous waste (HAZW) in the European List of Wastes | ||
| 646 | en: 01 03 04* acid-generating tailings from processing of sulphide ore (HAZW) | ||
| 647 | en: 01 03 99 wastes not otherwise specified (NHAZW) | ||
| 648 | )))|(% style="width:250px" %)Item in an Item Scheme|(% style="width:288px" %)((( | ||
| 649 | <language>:<content>, | ||
| 650 | |||
| 651 | <language>:<content>,… | ||
| 652 | |||
| 653 | //Example~:// | ||
| 654 | |||
| 655 | en:See reference metadata | ||
| 656 | )))|(% style="width:1427px" %)<content>| | ||
| 657 | |(% style="width:199px" %)ORDER|(% style="width:350px" %)Explicit indication of a localised order of items in Items Schemes or artefacts (e.g. Codelist, Concept Scheme, Category Scheme, Dataflow, etc.)|(% style="width:250px" %)((( | ||
| 658 | Either: | ||
| 659 | |||
| 660 | * an artefact, or; | ||
| 661 | * an item in an Item Scheme | ||
| 662 | )))|(% style="width:288px" %)((( | ||
| 663 | <language>:<content>, | ||
| 664 | |||
| 665 | <language>:<content>,… | ||
| 666 | |||
| 667 | //Example~:// | ||
| 668 | |||
| 669 | en:10,es:20 | ||
| 670 | )))|(% style="width:1427px" %)((( | ||
| 671 | <content> | ||
| 672 | |||
| 673 | |||
| 674 | )))| | ||
| 675 | |(% style="width:199px" %)TOTAL|(% style="width:350px" %)((( | ||
| 676 | Code Item that represents a total value. If the attachment is: | ||
| 677 | |||
| 678 | * to a Code, the Annotation Text is optional and may contain an explanatory text; | ||
| 679 | |||
| 680 | to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total | ||
| 681 | )))|(% style="width:250px" %)((( | ||
| 682 | Either: | ||
| 683 | |||
| 684 | * a Code Item that represents a total value, or; | ||
| 685 | * a Codelist to specify the code(s) with the total | ||
| 686 | )))|(% style="width:288px" %)((( | ||
| 687 | <language>:<explanatory text>, | ||
| 688 | |||
| 689 | <language>:<explanatory text>,… | ||
| 690 | )))|(% style="width:1427px" %)((( | ||
| 691 | Attached to Code Item: <blank> | ||
| 692 | |||
| 693 | Attached to Codelist: <code>,<code>,… | ||
| 694 | )))| | ||
| 695 | |(% style="width:199px" %)DRILLDOWN|(% style="width:350px" %)Denotes the concept that specifies whether observations are at the aggregate level or a drilldown.|(% style="width:250px" %)((( | ||
| 696 | Either: | ||
| 697 | |||
| 698 | * A Dataflow or DSD | ||
| 699 | )))|(% style="width:288px" %) |(% style="width:1427px" %)((( | ||
| 700 | <concept Id> | ||
| 701 | |||
| 702 | //Example~:// | ||
| 703 | |||
| 704 | DD_DIM (this concept should be hidden using the NOT_DISPLAYED Annotation below) | ||
| 705 | )))| | ||
| 706 | |(% style="width:199px" %)DEPRECATED|(% style="width:350px" %)((( | ||
| 707 | Indication that an Item in an Item Scheme or an artefact is deprecated. | ||
| 708 | |||
| 709 | For an item scheme item, the annotation value provides a replacement name for the code name. | ||
| 710 | |||
| 711 | 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. | ||
| 712 | |||
| 713 | Suggestion to use a controlled vocabulary | ||
| 714 | |||
| 715 | url: <[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/CURRENT>>url:http://publications.europa.eu/resource/authority/concept-status/CURRENT]]> | ||
| 716 | url: <[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/DEPRECATED>>url:http://publications.europa.eu/resource/authority/concept-status/DEPRECATED]]> | ||
| 717 | |||
| 718 | or | ||
| 719 | |||
| 720 | TITLE: true (false) | ||
| 721 | )))|(% style="width:250px" %)((( | ||
| 722 | Either: | ||
| 723 | |||
| 724 | * an artefact, or; | ||
| 725 | * an item in an Item Scheme | ||
| 726 | )))|(% style="width:288px" %)((( | ||
| 727 | For item scheme item: | ||
| 728 | |||
| 729 | <language>:<content>, | ||
| 730 | |||
| 731 | <language>:<content>,… | ||
| 732 | |||
| 733 | //Example~:// | ||
| 734 | |||
| 735 | en:deprecated,fr:obsolète | ||
| 736 | )))|(% style="width:1427px" %)<content>|((( | ||
| 737 | For artefact: | ||
| 738 | |||
| 739 | <see section URL value defaults and specific locale values> | ||
| 740 | |||
| 741 | |||
| 742 | ))) | ||
| 743 | |(% style="width:199px" %)DEFAULT|(% style="width:350px" %)((( | ||
| 744 | Indication that an item in an Item Scheme or artefacts is to be selected by default. | ||
| 745 | |||
| 746 | 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 | ||
| 747 | )))|(% style="width:250px" %)((( | ||
| 748 | * Item in ItemScheme, or; | ||
| 749 | * DSD, or; | ||
| 750 | * a Dataflow | ||
| 751 | |||
| 752 | 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. | ||
| 753 | )))|(% style="width:288px" %) |(% style="width:1427px" %)((( | ||
| 754 | Attached to: | ||
| 755 | |||
| 756 | - DSD or Dataflow: | ||
| 757 | **<concept>=<code>+<code>+…,<concept>=<code>+<code>+…** | ||
| 758 | |||
| 759 | //Example~:// FREQ=A+Q,TIME_PERIOD_START=2013-01,TIME_PERIOD_END=2018-12 | ||
| 760 | )))| | ||
| 761 | |(% style="width:199px" %)IMAGE|(% style="width:350px" %)A visual identity to associate to Item Scheme Items or artefacts|(% style="width:250px" %)((( | ||
| 762 | Either: | ||
| 763 | |||
| 764 | * an artefact, or; | ||
| 765 | * an item in an item scheme | ||
| 766 | )))|(% style="width:288px" %)((( | ||
| 767 | For localised content in SDMX 2.1 | ||
| 768 | |||
| 769 | <language>:<HTML containing URL to the resource>, | ||
| 770 | |||
| 771 | <language>:<HTML containing URL to the resource>,… | ||
| 772 | |||
| 773 | //Example~:// | ||
| 774 | |||
| 775 | en:<a href=”https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg”> | ||
| 776 | )))|(% style="width:1427px" %) |((( | ||
| 777 | See section URL value defaults and specific locale values. | ||
| 778 | |||
| 779 | //Example~:// | ||
| 780 | |||
| 781 | https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg | ||
| 782 | |||
| 783 | |||
| 784 | ))) | ||
| 785 | |(% style="width:199px" %)DRILLDOWN_CONCEPTS|(% style="width:350px" %)Concepts to be displayed in a drilldown operation|(% style="width:250px" %)Dataflow or DSD|(% style="width:288px" %) |(% style="width:1427px" %)((( | ||
| 786 | <concept Id>,<concept Id>,… | ||
| 787 | |||
| 788 | Example : | ||
| 789 | |||
| 790 | DONOR,RECIPIENT,YEAR,PROJECT_ID,OBS_VALUE,DESCRIPTION,OWNER | ||
| 791 | )))| | ||
| 792 | |(% style="width:199px" %)NOT_DISPLAYED|(% style="width:350px" %)Used to hide components or their values in the presentation|(% style="width:250px" %)((( | ||
| 793 | Either: | ||
| 794 | |||
| 795 | * a Dataflow or DSD, or; | ||
| 796 | * an Item in an Item Scheme | ||
| 797 | )))|(% style="width:288px" %) |(% style="width:1427px" %)((( | ||
| 798 | Attached to Item in Item Scheme: <blank> | ||
| 799 | |||
| 800 | Attached to Dataflow or DSD: | ||
| 801 | |||
| 802 | <concept Id>,<concept Id>,… | ||
| 803 | |||
| 804 | Example : | ||
| 805 | |||
| 806 | DD_DIM (to hide drilldown control concept) | ||
| 807 | )))| | ||
| 808 | |(% style="width:199px" %)LAYOUT_ROW|(% style="width:350px" %)Dimensions to be presented in rows (concepts on y-axis)|(% style="width:250px" %)((( | ||
| 809 | Either: | ||
| 810 | |||
| 811 | * an artefact, or; | ||
| 812 | * a Dimension | ||
| 813 | )))|(% style="width:288px" %) |(% style="width:1427px" %)((( | ||
| 814 | Attached to Dimension: <blank> | ||
| 815 | |||
| 816 | Attached to Dataflow or DSD: <dimension Id>,<dimension Id >,… | ||
| 817 | |||
| 818 | //Example~:// | ||
| 819 | |||
| 820 | REF_AREA,MEASURE | ||
| 821 | )))| | ||
| 822 | |(% style="width:199px" %)LAYOUT_COLUMN|(% style="width:350px" %)Dimensions to be presented in columns (concepts on x-axis)|(% style="width:250px" %)((( | ||
| 823 | Either: | ||
| 824 | |||
| 825 | * an artefact, or; | ||
| 826 | * a Dimension | ||
| 827 | )))|(% style="width:288px" %) |(% style="width:1427px" %)((( | ||
| 828 | Attached to Dimension: <blank> | ||
| 829 | |||
| 830 | Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,… | ||
| 831 | |||
| 832 | //Example~:// | ||
| 833 | |||
| 834 | TIME_PERIOD | ||
| 835 | )))| | ||
| 836 | |(% style="width:199px" %)LAYOUT_FLAG|(% style="width:350px" %)Indication that an attribute and its attribute value should be presented as a flag|(% style="width:250px" %)Dataflow|(% style="width:288px" %) |(% style="width:1427px" %)((( | ||
| 837 | <concept Id>,<concept Id>,... | ||
| 838 | |||
| 839 | //Example~:// | ||
| 840 | |||
| 841 | OBS_STATUS,CONF_STATUS | ||
| 842 | )))| | ||
| 843 | |(% style="width:199px" %)LAYOUT_NOTE|(% style="width:350px" %)Indication that an attribute and its attribute value should be presented as a note|(% style="width:250px" %)Dataflow|(% style="width:288px" %) |(% style="width:1427px" %)((( | ||
| 844 | <concept Id>,<concept Id>,... | ||
| 845 | |||
| 846 | //Example~:// | ||
| 847 | |||
| 848 | OBS_STATUS,CONF_STATUS | ||
| 849 | )))| | ||
| 850 | |(% style="width:199px" %)((( | ||
| 851 | METADATA | ||
| 852 | |||
| 853 | |||
| 854 | )))|(% style="width:350px" %)Links an MSD directly to a DSD. Can be used to overcome the complexities of reference metadata linkage|(% style="width:250px" %)DSD|(% style="width:288px" %) |(% style="width:1427px" %)MSD URI, e.g. urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataStructure=OECD:MSD_REF_METADATA(1.0)| | ||
| 855 | |(% style="width:199px" %)LAYOUT_ROW_SECTION|(% style="width:350px" %)Dimension to be presented as a break-down concept at a third hierarchical level above columns and rows.|(% style="width:250px" %)((( | ||
| 856 | Either: | ||
| 857 | |||
| 858 | * an artefact, or; | ||
| 859 | |||
| 860 | a Dimension | ||
| 861 | )))|(% style="width:288px" %) |(% style="width:1427px" %)((( | ||
| 862 | Attached to Dimension: <blank> | ||
| 863 | |||
| 864 | Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,… | ||
| 865 | |||
| 866 | //Example~:// | ||
| 867 | |||
| 868 | SEX | ||
| 869 | )))| | ||
| 870 | |(% style="width:199px" %)EXT_RESOURCE|(% style="width:350px" %)((( | ||
| 871 | A localised link to an external resource associated to the annotated artefact. For example, an ontology item | ||
| 872 | |||
| 873 | //a methodology// en:<a href:"[[https:~~/~~/ec.europa.eu/eurostat/web/waste/methodology>>url:https://ec.europa.eu/eurostat/web/waste/methodology]]"> | ||
| 874 | )))|(% style="width:250px" %)Any SDMX object|(% style="width:288px" %)((( | ||
| 875 | For localised content in SDMX 2.1 | ||
| 876 | |||
| 877 | <language>:<HTML containing URL to the resource>, | ||
| 878 | |||
| 879 | <language>:<HTML containing URL to the resource>,… | ||
| 880 | |||
| 881 | //Example~:// | ||
| 882 | |||
| 883 | en:<a href=”[[http:~~/~~/rdf-vocabulary.ddialliance.org/xkos#depth>>url:http://rdf-vocabulary.ddialliance.org/xkos#depth]]”> | ||
| 884 | )))|(% style="width:1427px" %) |((( | ||
| 885 | See section URL value defaults and specific locale values. | ||
| 886 | |||
| 887 | //Example~:// | ||
| 888 | |||
| 889 | http:~/~/rdf-vocabulary.ddialliance.org/xkos#depth | ||
| 890 | ))) | ||
| 891 | |(% style="width:199px" %)COMBINED_CONCEPTS|(% style="width:350px" %)((( | ||
| 892 | Comma-separated list of concept IDs to show as a concatenated label. | ||
| 893 | |||
| 894 | The listed concepts’ item contents may be concatenated to generate the target concept. | ||
| 895 | |||
| 896 | Multiple target concept combinations can be defined by separating the target concepts by ; | ||
| 897 | )))|(% style="width:250px" %)Dataflow or DSD|(% style="width:288px" %)((( | ||
| 898 | <language>:<display name>, | ||
| 899 | |||
| 900 | <language>:<display name> | ||
| 901 | |||
| 902 | 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} | ||
| 903 | )))|(% style="width:1427px" %) | | ||
| 904 | |(% style="width:199px" %)(deprecated) UNIT_MEASURE_CONCEPTS|(% style="width:350px" %)((( | ||
| 905 | Comma-separated list of concept IDs that is used to define the full unit of measure. The concepts must be in the DSD. | ||
| 906 | |||
| 907 | The listed concepts’ item contents may be concatenated to generate the unit of measure label (unless the UNIT_MEASURE_LABEL annotation is present). | ||
| 908 | )))|(% style="width:250px" %)Dataflow or DSD|(% style="width:288px" %) |(% style="width:1427px" %)((( | ||
| 909 | <concept Id>,<concept Id>,… | ||
| 910 | |||
| 911 | //Example~:// UNIT_MEASURE,UNIT_MULT,TRANSFORMATION [could generate a value of Australian Dollar, Thousands, Non-transformed] | ||
| 912 | )))| | ||
| 913 | |(% style="width:199px" %)(deprecated) UNIT_MEASURE_LABEL|(% style="width:350px" %)((( | ||
| 914 | Indicates the concept that enumerates the full unit of measure labels. | ||
| 915 | |||
| 916 | The concept must be in the DSD. UNIT_MEASURE_LABEL overrides the UNIT_MEASURE_CONCEPTS if both are provided. | ||
| 917 | |||
| 918 | Also can be attached to items in item scheme, e.g. | ||
| 919 | |||
| 920 | Text en:Gram | ||
| 921 | fr: Gramme | ||
| 922 | url:** **[[**http:~~/~~/data.europa.eu/gzn/su/G**>>url:http://data.europa.eu/gzn/su/G]] | ||
| 923 | )))|(% style="width:250px" %)Dataflow or DSD, Item in an Item Scheme|(% style="width:288px" %)((( | ||
| 924 | This is optional, used if a freetext label is required. | ||
| 925 | |||
| 926 | <language>:<content>, | ||
| 927 | |||
| 928 | <language>:<content>,… | ||
| 929 | |||
| 930 | //Example~:// | ||
| 931 | |||
| 932 | en:USD, thousands | ||
| 933 | |||
| 934 | fr:USD, milliers | ||
| 935 | )))|(% style="width:1427px" %)((( | ||
| 936 | This is optional, used if an enumerated list is required. | ||
| 937 | |||
| 938 | <concept Id> | ||
| 939 | |||
| 940 | //Example~:// | ||
| 941 | |||
| 942 | UOM_ATTRIBUTE [This concept may contain the following items as units of measure: | ||
| 943 | |||
| 944 | * National Currency, thousands | ||
| 945 | * USD, thousands | ||
| 946 | |||
| 947 | Index, based on National Currency] | ||
| 948 | )))| | ||
| 949 | |(% style="width:199px" %)((( | ||
| 950 | LAYOUT_TIME_PERIOD_DESC | ||
| 951 | |||
| 952 | |||
| 953 | )))|(% style="width:350px" %)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:250px" %)Dataflow, DSD|(% style="width:288px" %) |(% style="width:1427px" %)((( | ||
| 954 | //Example~:// | ||
| 955 | |||
| 956 | LAYOUT_TIME_PERIOD_DESC | ||
| 957 | )))| | ||
| 958 | |(% style="width:199px" %)((( | ||
| 959 | LAYOUT_CELL_ALIGN | ||
| 960 | |||
| 961 | |||
| 962 | )))|(% style="width:350px" %)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:250px" %)Dataflow, DSD, Dimension|(% style="width:288px" %)((( | ||
| 963 | <language>:<content>, | ||
| 964 | |||
| 965 | <language>:<content>,… | ||
| 966 | |||
| 967 | |||
| 968 | <content> values:RIGHT or LEFT | ||
| 969 | )))|(% style="width:1427px" %)Content values:RIGHT or LEFT| | ||
| 970 | |(% style="width:199px" %)((( | ||
| 971 | MAX_TABLE_DATA | ||
| 972 | |||
| 973 | |||
| 974 | )))|(% style="width:350px" %)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:250px" %)Dataflow|(% style="width:288px" %) |(% style="width:1427px" %)((( | ||
| 975 | <integer> | ||
| 976 | |||
| 977 | //Example~:// | ||
| 978 | |||
| 979 | 15000 | ||
| 980 | )))| | ||
| 981 | |(% style="width:199px" %)((( | ||
| 982 | MAXTEXTATTRIBUTELENGTH | ||
| 983 | |||
| 984 | |||
| 985 | )))|(% style="width:350px" %)Increase the maximum length for textual attribute values|(% style="width:250px" %)DSD|(% style="width:288px" %) |(% style="width:1427px" %)((( | ||
| 986 | <integer> | ||
| 987 | |||
| 988 | //Example~:// | ||
| 989 | |||
| 990 | 500 | ||
| 991 | )))| | ||
| 992 | |(% style="width:199px" %)SEARCH_WEIGHT|(% style="width:350px" %)Indication of localised boosted dataflows in the search results when ordered by relevance|(% style="width:250px" %)Dataflow|(% style="width:288px" %)((( | ||
| 993 | <language>:<integer>,... | ||
| 994 | |||
| 995 | //Example~:// | ||
| 996 | |||
| 997 | "en":"3","es":"4","fr":"5" | ||
| 998 | )))|(% style="width:1427px" %)((( | ||
| 999 | <integer> | ||
| 1000 | |||
| 1001 | //Example~:// | ||
| 1002 | |||
| 1003 | 10 | ||
| 1004 | )))| | ||
| 1005 | |||
| |
1.1 | 1006 | = Concept Scheme SDMX:CS_ANNOT = |
| 1007 | |||
| 1008 | 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. | ||
| 1009 | |||
| |
1.3 | 1010 | |**Property**|(% style="width:309px" %)**Representation in Concept**|(% style="width:1173px" %)**Description** |
| 1011 | |**Code**|(% style="width:309px" %)Concept Id|(% style="width:1173px" %)The Annotation Type column, e.g. NOT_DISPLAYED, EXCLUDES | ||
| 1012 | |**Name**|(% style="width:309px" %)Concept Name|(% style="width:1173px" %)Short description of the standard Annotation derived from the “Use case” column | ||
| 1013 | |**Representation**|(% style="width:309px" %)Concept Core Representation|(% style="width:1173px" %)Allowable type or format for the Annotation | ||
| 1014 | |**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 | ||
| 1015 | |**Artefact(s)**|(% style="width:309px" %)Annotation Type: Artefact(s)|(% style="width:1173px" %)The information in the “Where to attach” column | ||
| 1016 | |**URL**|(% style="width:309px" %)Annotation Type: URL|(% style="width:1173px" %)The Annotation URL column. The value is in URL | ||
| |
1.1 | 1017 | |
| 1018 | == Example of a Concept == | ||
| 1019 | |||
| 1020 | |**Concept Id**|NOT_DISPLAYED | ||
| 1021 | |**Concept Name**|Used to hide components or their values in the presentation | ||
| 1022 | |**Concept Core Representation**|/TextFormat@textType="String" | ||
| 1023 | |**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 | ||
| 1024 | |**Concept: Annotation: Type: Artefact(s)**|Either a Dataflow or DSD, or an item in an item scheme | ||
| 1025 | |||
| 1026 | === SDMX-ML of the Example === | ||
| 1027 | |||
| 1028 | <str:Concept id="NOT_DISPLAYED"> | ||
| 1029 | <com:Annotations> | ||
| 1030 | <com:Annotation> | ||
| 1031 | <com:AnnotationTitle>Either a Dataflow or DSD, or an item in an item scheme</com:AnnotationTitle> | ||
| 1032 | <com:AnnotationType>Artefact(s)</com:AnnotationType> | ||
| 1033 | </com:Annotation> | ||
| 1034 | </com:Annotations> | ||
| 1035 | <com:Name xml:lang="en">Used to hide components or their values in the presentation</com:Name> | ||
| 1036 | <com:Description xml:lang="en">To hide dimensions and attributes in a display (e.g. a table). For example, if they have only one allowed, available or selected value</com:Description> | ||
| 1037 | <str:CoreRepresentation> | ||
| 1038 | <str:TextFormat textType="String"/> | ||
| 1039 | </str:CoreRepresentation> | ||
| 1040 | </str:Concept> | ||
| 1041 | |||
| 1042 | = References = | ||
| 1043 | |||
| 1044 | * [[Formalization of the Structure and Content of Statistical Classifications>>url:https://urldefense.com/v3/__https:/eur02.safelinks.protection.outlook.com/?url=https*3A*2F*2Furldefense.com*2Fv3*2F__https*3A*2Feur02.safelinks.protection.outlook.com*2F*3Furl*3Dhttps*3A*2F*2Fec.europa.eu*2Feurostat*2Framon*2Fmiscellaneous*2Fgen_intro_classif_files*2FStructure_and_content_of_classifications_version_1_0_October_2019.docx*26data*3D02*7C01*7CDavid.BARRACLOUGH*40oecd.org*7Cf9cb429291334e5170cb08d80c883aeb*7Cac41c7d41f61460db0f4fc925a2b471c*7C0*7C1*7C637273126543303645*26sdata*3Dl01*2BEX3SNWREH*2FElV3r9Ld*2BG49l7ouvFi7pqAGYg2Ss*3D*26reserved*3D0__*3BJSUlJSUlJSUlJSUlJSUlJSUlJSU!!DOxrgLBm!Q_cL04DGMBYhHfuPQVRMMCKao1C3QuaoJxBTxO4_mSKNMGfLjmV2UTCtAhTDvbMAZtNzrTZ3*24&data=02*7C01*7CDavid.BARRACLOUGH*40oecd.org*7Ca70a73c696814b06406408d80d1d9336*7Cac41c7d41f61460db0f4fc925a2b471c*7C0*7C1*7C637273768055440921&sdata=r4CVvCdYBIU39XMN0qNmt*2FC9FIS7AnXrzYcjuzDe0Dc*3D&reserved=0__;JSUlJSUlJSUlJSoqKioqKioqJSUqKioqKioqKiUlKioqKiUlJSUlJSUlJSUlJSUl!!DOxrgLBm!RCGOp-FMBfmiP7CvEwdSAhL4XCil-vey-z32n6uxoCDXVTN7rXWXG442IZgqwpmM4wKQq908$]] | ||
| 1045 | * [[SDMX Global Registry>>url:https://registry.sdmx.org/overview.html]] | ||
| 1046 | * [[SDMX Glossary 2.1>>url:https://sdmx.org/wp-content/uploads/SDMX_Glossary_version_2_1-Final-2.docx]] | ||
| 1047 | * SDMX Standards, “[[Information Model: UML Conceptual Design>>url:https://sdmx.org/wp-content/uploads/SDMX_2_0_SECTION_02_InformationModel.pdf]]”, version 2.1 | ||
| 1048 | * [[SKOS Specification>>url:https://www.w3.org/TR/2009/REC-skos-reference-20090818/]] | ||
| 1049 | * [[XKOS Specification>>url:https://ddialliance.org/Specification/XKOS/1.2/OWL/xkos.html]] | ||
| 1050 | |||
| 1051 | ---- | ||
| 1052 | |||
| |
1.3 | 1053 | {{putFootnotes/}} |