Changes for page Guidelines on Using SDMX Annotations
Last modified by Artur K. on 2026/05/29 14:28
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -30,6 +30,13 @@ 30 30 31 31 === SDMX 3.0 === 32 32 33 + 34 +|((( 35 +|((( 36 + 37 +))) 38 +))) 39 + 33 33 [[image:1768507168030-780.png]] 34 34 35 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. ... ... @@ -38,23 +38,25 @@ 38 38 39 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 40 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 vocabulary43 -|**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" %)(((48 +|**Property**|**Description**|**Controlled vocabulary context** 49 +|**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 50 +|**title**|A title used to identify an Annotation.|A non-localised value for the annotation. Used when localisation is irrelevant. 51 +|**type**|((( 45 45 Specifies how the Annotation is to be processed. 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. 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" %)((( 53 + 54 +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. 55 +)))|Identifies the usage (e.g. images are type IMAGE) of the annotation. The type values are enumerated in the controlled vocabulary table. 56 +|**url**|((( 49 49 A link to external descriptive text. 58 + 50 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. 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" %)(((60 +)))|A non-localised URL reference to an external resource. Used when localisation is irrelevant. 61 +|**+url**|**SDMX 3.0 and later**. An annotation may have several localised URLs|A localised URL reference to an external resource. 62 +|**+text**|((( 54 54 An International String that provides the multilingual text content of the Annotation. 55 55 56 56 **Text** holds a language-specific string containing the text of the Annotation. 57 -)))| (% style="width:710px" %)A localised value for the annotation.66 +)))|A localised value for the annotation. 58 58 59 59 = Introducing Standard Annotations = 60 60 ... ... @@ -74,15 +74,15 @@ 74 74 75 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 76 77 -|**id***|**@SDMX**| (% style="width:249px" %)**@SDMX**|(% style="width:209px" %)**@SDMX**|(% style="width:888px" %)(((86 +|**id***|**@SDMX**|**@SDMX**|**@SDMX**|((( 78 78 **Not @SDMX** 79 79 80 80 This is a “customer order no.” which is a different use case than the ORDER standard Annotation which is a list order 81 81 ))) 82 -|**title**| | (%style="width:249px" %)|(%style="width:209px" %)|(% style="width:888px" %)193424583 -|**type***|NOT_DISPLAYED| (% style="width:249px" %)EXCLUDES|(% style="width:209px" %)ORDER|(% style="width:888px" %)ORDER84 -|(% 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 :2091 +|**title**| | | |1934245 92 +|**type***|NOT_DISPLAYED|EXCLUDES|ORDER|ORDER 93 +|(% rowspan="2" %)**+text**|(% rowspan="2" %) |(% rowspan="2" %) |en :10|(% rowspan="2" %) 94 +|fr :20 86 86 87 87 ~* denotes a mandatory information for standard Annotations 88 88 ... ... @@ -102,13 +102,13 @@ 102 102 103 103 == Relationships between Annotation properties == 104 104 105 -=== Text value defaults and specific locale values === 114 +==== Text value defaults and specific locale values ==== 106 106 107 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 108 109 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 110 111 -=== URL value defaults and specific locale values === 120 +==== URL value defaults and specific locale values ==== 112 112 113 113 ===== SDMX 2.1 and earlier ===== 114 114 ... ... @@ -122,22 +122,26 @@ 122 122 123 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 124 134 + 125 125 == General and Display-related Annotation types == 126 126 127 -| (% style="width:152px" %)Annotation Type|(% style="width:559px" %)Use Case|Where to attach|(((137 +|Annotation Type|Use Case|Where to attach|((( 128 128 +Text 129 129 130 130 Blue is optional 131 131 )))|((( 132 132 Title 143 + 133 133 Blue is optional 134 134 )))|((( 135 135 SDMX 2.1:URL 147 + 136 136 SDMX >=3.0:+URL 149 + 137 137 Blue is optional 138 138 ))) 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.1140 -en: A0123 Growing of citrus fruits| (% style="width:20px" %)Item in an Item Scheme|(% style="width:506px" %)(((152 +|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 153 +en: A0123 Growing of citrus fruits|Item in an Item Scheme|((( 141 141 <language>:<content>, 142 142 143 143 <language>:<content>,… ... ... @@ -145,28 +145,28 @@ 145 145 //Example~:// 146 146 147 147 en:Labour force (Employment) 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" %)(((161 +)))|<content>| 162 +|REPLACE_NAME|Replace each code name in a component by the value of another component in an observation or series|A Dataflow or DSD| |((( 150 150 <component Id to replace name>:<component Id to use name> 151 151 152 152 //Example~:// 153 153 154 154 CUST_BREAKDOWN:CUST_BREAKDOWN_LB 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" %)(((168 +)))| 169 +|REPLACE_CONTENT|Replace the content in a component by the value of another component in an observation or series|A Dataflow or DSD| |((( 157 157 <component Id to replace content>:<component Id to use content> 158 158 159 159 //Example~:// 160 160 161 161 REF_AREA:M49_CODE 162 -)))| (%style="width:866px" %)163 -| (% style="width:152px" %)COMPLEMENT|(% style="width:559px" %)(((175 +)))| 176 +|COMPLEMENT|((( 164 164 Additional fixed text to be displayed in parenthesis after the code name. 165 165 166 166 E.g. Representation of Non-hazardous (NHAZW), hazardous waste (HAZW) in the European List of Wastes 167 167 en: 01 03 04* acid-generating tailings from processing of sulphide ore (HAZW) 168 168 en: 01 03 99 wastes not otherwise specified (NHAZW) 169 -)))| (% style="width:20px" %)Item in an Item Scheme|(% style="width:506px" %)(((182 +)))|Item in an Item Scheme|((( 170 170 <language>:<content>, 171 171 172 172 <language>:<content>,… ... ... @@ -174,13 +174,13 @@ 174 174 //Example~:// 175 175 176 176 en:See reference metadata 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" %)(((190 +)))|<content>| 191 +|ORDER|Explicit indication of a localised order of items in Items Schemes or artefacts (e.g. Codelist, Concept Scheme, Category Scheme, Dataflow, etc.)|((( 179 179 Either: 180 180 181 181 * an artefact, or; 182 182 * an item in an Item Scheme 183 -)))|( % style="width:506px" %)(((196 +)))|((( 184 184 <language>:<content>, 185 185 186 186 <language>:<content>,… ... ... @@ -188,42 +188,43 @@ 188 188 //Example~:// 189 189 190 190 en:10,es:20 191 -)))|( % style="width:178px" %)(((204 +)))|((( 192 192 <content> 193 193 194 194 195 -)))| (%style="width:866px" %)196 -| (% style="width:152px" %)TOTAL|(% style="width:559px" %)(((208 +)))| 209 +|TOTAL|((( 197 197 Code Item that represents a total value. If the attachment is: 198 198 199 199 * to a Code, the Annotation Text is optional and may contain an explanatory text; 200 -* to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total 201 -)))|(% style="width:20px" %)((( 213 + 214 +to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total 215 +)))|((( 202 202 Either: 203 203 204 204 * a Code Item that represents a total value, or; 205 205 * a Codelist to specify the code(s) with the total 206 -)))|( % style="width:506px" %)(((220 +)))|((( 207 207 <language>:<explanatory text>, 208 208 209 209 <language>:<explanatory text>,… 210 -)))|( % style="width:178px" %)(((224 +)))|((( 211 211 Attached to Code Item: <blank> 212 212 213 213 Attached to Codelist: <code>,<code>,… 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" %)(((228 +)))| 229 +|DRILLDOWN|Denotes the concept that specifies whether observations are at the aggregate level or a drilldown.|((( 216 216 Either: 217 217 218 218 * A Dataflow or DSD 219 -)))| (%style="width:506px" %)|(% style="width:178px" %)(((233 +)))| |((( 220 220 <concept Id> 221 221 222 222 //Example~:// 223 223 224 224 DD_DIM (this concept should be hidden using the NOT_DISPLAYED Annotation below) 225 -)))| (%style="width:866px" %)226 -| (% style="width:152px" %)DEPRECATED|(% style="width:559px" %)(((239 +)))| 240 +|DEPRECATED|((( 227 227 Indication that an Item in an Item Scheme or an artefact is deprecated. 228 228 229 229 For an item scheme item, the annotation value provides a replacement name for the code name. ... ... @@ -238,12 +238,12 @@ 238 238 or 239 239 240 240 TITLE: true (false) 241 -)))|( % style="width:20px" %)(((255 +)))|((( 242 242 Either: 243 243 244 244 * an artefact, or; 245 245 * an item in an Item Scheme 246 -)))|( % style="width:506px" %)(((260 +)))|((( 247 247 For item scheme item: 248 248 249 249 <language>:<content>, ... ... @@ -253,7 +253,7 @@ 253 253 //Example~:// 254 254 255 255 en:deprecated,fr:obsolète 256 -)))| (% style="width:178px" %)<content>|(% style="width:866px" %)(((270 +)))|<content>|((( 257 257 For artefact: 258 258 259 259 <see section URL value defaults and specific locale values> ... ... @@ -260,30 +260,30 @@ 260 260 261 261 262 262 ))) 263 -| (% style="width:152px" %)DEFAULT|(% style="width:559px" %)(((277 +|DEFAULT|((( 264 264 Indication that an item in an Item Scheme or artefacts is to be selected by default. 265 265 266 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 267 -)))|( % style="width:20px" %)(((281 +)))|((( 268 268 * Item in ItemScheme, or; 269 269 * DSD, or; 270 270 * a Dataflow 271 271 272 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. 273 -)))| (%style="width:506px" %)|(% style="width:178px" %)(((287 +)))| |((( 274 274 Attached to: 275 275 276 276 - DSD or Dataflow: 277 -**<concept>=<code>+<code>+…,<concept>=<code>+<code>+…** 291 + **<concept>=<code>+<code>+…,<concept>=<code>+<code>+…** 278 278 279 279 //Example~:// FREQ=A+Q,TIME_PERIOD_START=2013-01,TIME_PERIOD_END=2018-12 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" %)(((294 +)))| 295 +|IMAGE|A visual identity to associate to Item Scheme Items or artefacts|((( 282 282 Either: 283 283 284 284 * an artefact, or; 285 285 * an item in an item scheme 286 -)))|( % style="width:506px" %)(((300 +)))|((( 287 287 For localised content in SDMX 2.1 288 288 289 289 <language>:<HTML containing URL to the resource>, ... ... @@ -293,7 +293,7 @@ 293 293 //Example~:// 294 294 295 295 en:<a href=”https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg”> 296 -)))| (%style="width:178px" %)|(% style="width:866px" %)(((310 +)))| |((( 297 297 See section URL value defaults and specific locale values. 298 298 299 299 //Example~:// ... ... @@ -302,19 +302,19 @@ 302 302 303 303 304 304 ))) 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" %)(((319 +|DRILLDOWN_CONCEPTS|Concepts to be displayed in a drilldown operation|Dataflow or DSD| |((( 306 306 <concept Id>,<concept Id>,… 307 307 308 308 Example : 309 309 310 310 DONOR,RECIPIENT,YEAR,PROJECT_ID,OBS_VALUE,DESCRIPTION,OWNER 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" %)(((325 +)))| 326 +|NOT_DISPLAYED|Used to hide components or their values in the presentation|((( 313 313 Either: 314 314 315 315 * a Dataflow or DSD, or; 316 316 * an Item in an Item Scheme 317 -)))| (%style="width:506px" %)|(% style="width:178px" %)(((331 +)))| |((( 318 318 Attached to Item in Item Scheme: <blank> 319 319 320 320 Attached to Dataflow or DSD: ... ... @@ -324,13 +324,13 @@ 324 324 Example : 325 325 326 326 DD_DIM (to hide drilldown control concept) 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" %)(((341 +)))| 342 +|LAYOUT_ROW|Dimensions to be presented in rows (concepts on y-axis)|((( 329 329 Either: 330 330 331 331 * an artefact, or; 332 332 * a Dimension 333 -)))| (%style="width:506px" %)|(% style="width:178px" %)(((347 +)))| |((( 334 334 Attached to Dimension: <blank> 335 335 336 336 Attached to Dataflow or DSD: <dimension Id>,<dimension Id >,… ... ... @@ -338,13 +338,13 @@ 338 338 //Example~:// 339 339 340 340 REF_AREA,MEASURE 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" %)(((355 +)))| 356 +|LAYOUT_COLUMN|Dimensions to be presented in columns (concepts on x-axis)|((( 343 343 Either: 344 344 345 345 * an artefact, or; 346 346 * a Dimension 347 -)))| (%style="width:506px" %)|(% style="width:178px" %)(((361 +)))| |((( 348 348 Attached to Dimension: <blank> 349 349 350 350 Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,… ... ... @@ -352,33 +352,33 @@ 352 352 //Example~:// 353 353 354 354 TIME_PERIOD 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" %)(((369 +)))| 370 +|LAYOUT_FLAG|Indication that an attribute and its attribute value should be presented as a flag|Dataflow| |((( 357 357 <concept Id>,<concept Id>,... 358 358 359 359 //Example~:// 360 360 361 361 OBS_STATUS,CONF_STATUS 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" %)(((376 +)))| 377 +|LAYOUT_NOTE|Indication that an attribute and its attribute value should be presented as a note|Dataflow| |((( 364 364 <concept Id>,<concept Id>,... 365 365 366 366 //Example~:// 367 367 368 368 OBS_STATUS,CONF_STATUS 369 -)))| (%style="width:866px" %)370 -|( % style="width:152px" %)(((383 +)))| 384 +|((( 371 371 METADATA 372 372 373 373 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" %)(((388 +)))|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)| 389 +|LAYOUT_ROW_SECTION|Dimension to be presented as a break-down concept at a third hierarchical level above columns and rows.|((( 376 376 Either: 377 377 378 378 * an artefact, or; 379 379 380 380 a Dimension 381 -)))| (%style="width:506px" %)|(% style="width:178px" %)(((395 +)))| |((( 382 382 Attached to Dimension: <blank> 383 383 384 384 Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,… ... ... @@ -386,12 +386,12 @@ 386 386 //Example~:// 387 387 388 388 SEX 389 -)))| (%style="width:866px" %)390 -| (% style="width:152px" %)EXT_RESOURCE|(% style="width:559px" %)(((403 +)))| 404 +|EXT_RESOURCE|((( 391 391 A localised link to an external resource associated to the annotated artefact. For example, an ontology item 392 392 393 393 //a methodology// en:<a href:"[[https:~~/~~/ec.europa.eu/eurostat/web/waste/methodology>>url:https://ec.europa.eu/eurostat/web/waste/methodology]]"> 394 -)))| (% style="width:20px" %)Any SDMX object|(% style="width:506px" %)(((408 +)))|Any SDMX object|((( 395 395 For localised content in SDMX 2.1 396 396 397 397 <language>:<HTML containing URL to the resource>, ... ... @@ -401,7 +401,7 @@ 401 401 //Example~:// 402 402 403 403 en:<a href=”[[http:~~/~~/rdf-vocabulary.ddialliance.org/xkos#depth>>url:http://rdf-vocabulary.ddialliance.org/xkos#depth]]”> 404 -)))| (%style="width:178px" %)|(% style="width:866px" %)(((418 +)))| |((( 405 405 See section URL value defaults and specific locale values. 406 406 407 407 //Example~:// ... ... @@ -408,29 +408,29 @@ 408 408 409 409 http:~/~/rdf-vocabulary.ddialliance.org/xkos#depth 410 410 ))) 411 -| (% style="width:152px" %)COMBINED_CONCEPTS|(% style="width:559px" %)(((425 +|COMBINED_CONCEPTS|((( 412 412 Comma-separated list of concept IDs to show as a concatenated label. 413 413 414 414 The listed concepts’ item contents may be concatenated to generate the target concept. 415 415 416 416 Multiple target concept combinations can be defined by separating the target concepts by ; 417 -)))| (% style="width:20px" %)Dataflow or DSD|(% style="width:506px" %)(((431 +)))|Dataflow or DSD|((( 418 418 <language>:<display name>, 419 419 420 420 <language>:<display name> 421 421 422 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} 423 -)))| (%style="width:178px" %)|(%style="width:866px" %)424 -|( % style="width:152px" %)(deprecated) UNIT_MEASURE_CONCEPTS|(% style="width:559px" %)(((437 +)))| | 438 +|(deprecated) UNIT_MEASURE_CONCEPTS|((( 425 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 426 427 427 The listed concepts’ item contents may be concatenated to generate the unit of measure label (unless the UNIT_MEASURE_LABEL annotation is present). 428 -)))| (% style="width:20px" %)Dataflow or DSD|(%style="width:506px" %)|(% style="width:178px" %)(((442 +)))|Dataflow or DSD| |((( 429 429 <concept Id>,<concept Id>,… 430 430 431 431 //Example~:// UNIT_MEASURE,UNIT_MULT,TRANSFORMATION [could generate a value of Australian Dollar, Thousands, Non-transformed] 432 -)))| (%style="width:866px" %)433 -|( % style="width:152px" %)(deprecated) UNIT_MEASURE_LABEL|(% style="width:559px" %)(((446 +)))| 447 +|(deprecated) UNIT_MEASURE_LABEL|((( 434 434 Indicates the concept that enumerates the full unit of measure labels. 435 435 436 436 The concept must be in the DSD. UNIT_MEASURE_LABEL overrides the UNIT_MEASURE_CONCEPTS if both are provided. ... ... @@ -440,7 +440,7 @@ 440 440 Text en:Gram 441 441 fr: Gramme 442 442 url:** **[[**http:~~/~~/data.europa.eu/gzn/su/G**>>url:http://data.europa.eu/gzn/su/G]] 443 -)))| (% style="width:20px" %)Dataflow or DSD, Item in an Item Scheme|(% style="width:506px" %)(((457 +)))|Dataflow or DSD, Item in an Item Scheme|((( 444 444 This is optional, used if a freetext label is required. 445 445 446 446 <language>:<content>, ... ... @@ -452,7 +452,7 @@ 452 452 en:USD, thousands 453 453 454 454 fr:USD, milliers 455 -)))|( % style="width:178px" %)(((469 +)))|((( 456 456 This is optional, used if an enumerated list is required. 457 457 458 458 <concept Id> ... ... @@ -465,21 +465,21 @@ 465 465 * USD, thousands 466 466 467 467 Index, based on National Currency] 468 -)))| (%style="width:866px" %)469 -|( % style="width:152px" %)(((482 +)))| 483 +|((( 470 470 LAYOUT_TIME_PERIOD_DESC 471 471 472 472 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" %)(((487 +)))|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| |((( 474 474 //Example~:// 475 475 476 476 LAYOUT_TIME_PERIOD_DESC 477 -)))| (%style="width:866px" %)478 -|( % style="width:152px" %)(((491 +)))| 492 +|((( 479 479 LAYOUT_CELL_ALIGN 480 480 481 481 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" %)(((496 +)))|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|((( 483 483 <language>:<content>, 484 484 485 485 <language>:<content>,… ... ... @@ -486,467 +486,235 @@ 486 486 487 487 488 488 <content> values:RIGHT or LEFT 489 -)))| (% style="width:178px" %)Content values:RIGHT or LEFT|(%style="width:866px" %)490 -|( % style="width:152px" %)(((503 +)))|Content values:RIGHT or LEFT| 504 +|((( 491 491 MAX_TABLE_DATA 492 492 493 493 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" %)(((508 +)))|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| |((( 495 495 <integer> 496 496 497 497 //Example~:// 498 498 499 499 15000 500 -)))| (%style="width:866px" %)501 -|( % style="width:152px" %)(((514 +)))| 515 +|((( 502 502 MAXTEXTATTRIBUTELENGTH 503 503 504 504 505 -)))| (% style="width:559px" %)Increase the maximum length for textual attribute values|(% style="width:20px" %)DSD|(%style="width:506px" %)|(% style="width:178px" %)(((519 +)))|Increase the maximum length for textual attribute values|DSD| |((( 506 506 <integer> 507 507 508 508 //Example~:// 509 509 510 510 500 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" %)(((525 +)))| 526 +|SEARCH_WEIGHT|Indication of localised boosted dataflows in the search results when ordered by relevance|Dataflow|((( 513 513 <language>:<integer>,... 514 514 515 515 //Example~:// 516 516 517 517 "en":"3","es":"4","fr":"5" 518 -)))|( % style="width:178px" %)(((532 +)))|((( 519 519 <integer> 520 520 521 521 //Example~:// 522 522 523 523 10 524 -)))| (%style="width:866px" %)538 +)))| 525 525 526 526 == Codelist and Statistical Classification-specific Annotations == 527 527 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 Classificationof All Economic Activities{{/footnote}}and CPC{{footnote}}Central ProductClassification{{/footnote}}.542 +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]]. 529 529 544 +|Annotation Type|Use Case|Where to attach|((( 545 ++Text 530 530 531 -|**Annotation Type**|(% style="width:524px" %)**Use Case**|(% style="width:198px" %)**Where to attach**|(% style="width:237px" %)((( 532 -**+Text 533 -(% style="background-color:transparent" %)Blue is optional(%%)** 534 -)))|(% style="width:320px" %)((( 535 -**Title 536 -(% style="background-color:transparent" %)Blue is optional(%%)** 537 -)))|(% style="width:203px" %)((( 538 -**SDMX 2.1:URL 539 -SDMX >=3.0:+URL 540 -(% style="background-color:transparent" %)Blue is optional(%%)** 541 -))) 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:320px" %)<content>|(% style="width:203px" %) 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:320px" %)((( 549 -<component Id to replace name>:<component Id to use name> 550 -//Example~:// 551 -(% style="background-color:transparent" %)CUST_BREAKDOWN:CUST_BREAKDOWN_LB 552 -)))|(% style="width:203px" %) 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:320px" %)((( 554 -<component Id to replace content>:<component Id to use content> 555 -//Example~:// 556 -(% style="background-color:transparent" %)REF_AREA:M49_CODE 557 -)))|(% style="width:203px" %) 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>,… 547 +Blue is optional 548 +)))|((( 549 +Title 565 565 566 -//Example~:// 567 -(% style="background-color:transparent" %)en:See reference metadata 568 -)))|(% style="width:320px" %)<content>|(% style="width:203px" %) 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: 551 +Blue is optional 552 +)))|((( 553 +SDMX 2.1:URL 571 571 572 -* an artefact, or; 573 -* an item in an Item Scheme 574 -)))|(% style="width:237px" %)((( 575 -<language>:<content>,<language>:<content>,… 555 +SDMX >=3.0:+URL 576 576 577 -//Example~:// 578 -(% style="background-color:transparent" %)en:10,es:20 579 -)))|(% style="width:320px" %)<content>|(% style="width:203px" %) 580 -|TOTAL|(% style="width:524px" %)((( 581 -Code Item that represents a total value. If the attachment is: 557 +Blue is optional 558 +))) 559 +|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| |((( 560 +<original code> 582 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: 562 +//Examples~:// 587 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:320px" %)((( 594 -Attached to Code Item: <blank> 595 -(% style="background-color:transparent" %)Attached to Codelist: <code>,<code>,… 596 -)))|(% style="width:203px" %) 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: 564 +* 0105.13 [Harmonized System] 565 +* 11.2.0.9 [COICOP classification] 566 +)))| 567 +|HIER_CONTEXT|((( 568 +In SDMX 2.1, a reference between a usage context and a hierarchy (that may be contained in a Hierarchical Codelist (HCL)). 599 599 600 -* A Dataflow or DSD 601 -)))|(% style="width:237px" %) |(% style="width:320px" %)((( 602 -<concept Id> 570 +In SDMX 3.0, use the HierarchyAssociation artefact 571 +)))|DSD or Dataflow| |((( 572 +<component Id>:<HCL Id>.<hierarchy Id> 573 + 603 603 //Example~:// 604 -(% style="background-color:transparent" %)DD_DIM (this concept should be hidden using the NOT_DISPLAYED Annotation below) 605 -)))|(% style="width:203px" %) 606 -|DEPRECATED|(% style="width:524px" %)((( 607 -Indication that an Item in an Item Scheme or an artefact is deprecated. 608 -For an item scheme item, the annotation value provides a replacement name for the code name. 609 -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. 610 -Suggestion to use a controlled vocabulary 611 -url: <[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/CURRENT>>url:http://publications.europa.eu/resource/authority/concept-status/CURRENT]]> 612 -url: <[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/DEPRECATED>>url:http://publications.europa.eu/resource/authority/concept-status/DEPRECATED]]> 613 -or 614 -(% style="background-color:transparent" %)TITLE: true (false) 615 -)))|(% style="width:198px" %)((( 616 -Either: 617 617 618 - *anartefact,or;619 - *an item in an Item Scheme620 - )))|(% style="width:237px" %)(((621 - Foritemscheme item:576 +REF_AREA:OECD.EDU:HCL_REF_AREA(1.0).REF_AREA provides the link to the reference area hierarchy for OECD education data 577 +)))| 578 +|HIER_LEVEL|((( 579 +Explicit specification of the hierarchical level of a code item 622 622 623 - <language>:<content>,<language>:<content>,…581 +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]] 624 624 583 +text en:sections 584 +)))|Code item| |((( 585 +<hierarchical level> 586 + 625 625 //Example~:// 626 -(% style="background-color:transparent" %)en:deprecated,fr:obsolète 627 -)))|(% style="width:320px" %)<content>|(% style="width:203px" %)((( 628 -For artefact: 629 -<see section URL value defaults and specific locale values> 630 -))) 631 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 632 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 633 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 634 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 635 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 636 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 637 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 638 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 639 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 640 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 641 -| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 642 642 643 - 644 - 645 -|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 646 -en: A0123 Growing of citrus fruits|Item in an Item Scheme|(% style="width:288px" %)((( 589 +1 590 +)))| 591 +|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|((( 647 647 <language>:<content>, 593 + 648 648 <language>:<content>,… 595 +)))|((( 649 649 //Example~:// 650 -en:Labour force (Employment) 651 -)))|(% style="width:1427px" %)<content>| 652 -|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" %)((( 653 -<component Id to replace name>:<component Id to use name> 654 654 655 - //Example~://598 +[Official French label “Transformation et conservation de la viande de boucherie” is shortened to] fr:Transf. & conserv. viande de boucherie 656 656 657 -CUST_BREAKDOWN:CUST_BREAKDOWN_LB 658 -)))| 659 -|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" %)((( 660 -<component Id to replace content>:<component Id to use content> 661 661 662 -//Example~:// 601 +In Codelist=IMF:CL_AREA(1.13) 602 +Code 4J837 European Union Intellectual Property Office has a Short_Label 663 663 664 - REF_AREA:M49_CODE604 +EN:EUIPO 665 665 )))| 666 -|(% style="width:199px" %)COMPLEMENT|(% style="width:350px" %)((( 667 -Additional fixed text to be displayed in parenthesis after the code name. 668 - 669 -E.g. Representation of Non-hazardous (NHAZW), hazardous waste (HAZW) in the European List of Wastes 670 -en: 01 03 04* acid-generating tailings from processing of sulphide ore (HAZW) 671 -en: 01 03 99 wastes not otherwise specified (NHAZW) 672 -)))|(% style="width:250px" %)Item in an Item Scheme|(% style="width:288px" %)((( 606 +|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|((( 673 673 <language>:<content>, 674 674 675 675 <language>:<content>,… 676 - 610 +)))|((( 677 677 //Example~:// 678 678 679 -en:See reference metadata 680 -)))|(% style="width:1427px" %)<content>| 681 -|(% 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" %)((( 682 -Either: 683 - 684 -* an artefact, or; 685 -* an item in an Item Scheme 686 -)))|(% style="width:288px" %)((( 613 +[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 614 +)))| 615 +|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|((( 687 687 <language>:<content>, 688 688 689 689 <language>:<content>,… 619 +)))|((( 620 +Example (from the US NAICS classification): 690 690 691 -//Example~:// 692 - 693 -en:10,es:20 694 -)))|(% style="width:1427px" %)((( 695 -<content> 696 - 697 - 622 +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. 698 698 )))| 699 -| (%style="width:199px"%)TOTAL|(%style="width:350px"%)(((700 - Code Item that representsatotal value. If the attachmentis:624 +|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|((( 625 +<language>:<content>, 701 701 702 -* to a Code, the Annotation Text is optional and may contain an explanatory text; 627 +<language>:<content>,… 628 +)))|((( 629 +Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition): 703 703 704 -to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total 705 -)))|(% style="width:250px" %)((( 706 -Either: 631 +en: This class includes: 707 707 708 -* a Code Item that represents a total value, or; 709 -* a Codelist to specify the code(s) with the total 710 -)))|(% style="width:288px" %)((( 711 -<language>:<explanatory text>, 712 - 713 -<language>:<explanatory text>,… 714 -)))|(% style="width:1427px" %)((( 715 -Attached to Code Item: <blank> 716 - 717 -Attached to Codelist: <code>,<code>,… 633 +* manufacture of heavy weapons (artillery, mobile guns, rocket launchers, torpedo tubes, heavy machine guns) 634 +* manufacture of small arms (revolvers, shotguns, light machine guns) 635 +* manufacture of air or gas guns and pistols 636 +* manufacture of war ammunition 718 718 )))| 719 -| (% style="width:199px"%)DRILLDOWN|(%style="width:350px"%)Denotesthe conceptthatspecifies whether observations are at theaggregate leveloradrilldown.|(%style="width:250px" %)(((720 - Either:638 +|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|((( 639 +<language>:<content>, 721 721 722 -* A Dataflow or DSD 723 -)))|(% style="width:288px" %) |(% style="width:1427px" %)((( 724 -<concept Id> 641 +<language>:<content>,… 725 725 726 - //Example~://643 +Example (from NACE Rev. 2 caselaw to code 01.62): 727 727 728 -DD_DIM (this concept should be hidden using the NOT_DISPLAYED Annotation below) 729 -)))| 730 -|(% style="width:199px" %)DEPRECATED|(% style="width:350px" %)((( 731 -Indication that an Item in an Item Scheme or an artefact is deprecated. 732 - 733 -For an item scheme item, the annotation value provides a replacement name for the code name. 734 - 735 -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. 736 - 737 -Suggestion to use a controlled vocabulary 738 - 739 -url: <[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/CURRENT>>url:http://publications.europa.eu/resource/authority/concept-status/CURRENT]]> 740 -url: <[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/DEPRECATED>>url:http://publications.europa.eu/resource/authority/concept-status/DEPRECATED]]> 741 - 742 -or 743 - 744 -TITLE: true (false) 745 -)))|(% style="width:250px" %)((( 746 -Either: 747 - 748 -* an artefact, or; 749 -* an item in an Item Scheme 750 -)))|(% style="width:288px" %)((( 751 -For item scheme item: 752 - 645 +en:Automated egg hatching for poultry - Operation of livestock management systems] 646 +)))| | 647 +|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|((( 753 753 <language>:<content>, 754 754 755 755 <language>:<content>,… 651 +)))|((( 652 +Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition): 756 756 757 - //Example~://654 +en:This class also includes: 758 758 759 -en:deprecated,fr:obsolète 760 -)))|(% style="width:1427px" %)<content>|((( 761 -For artefact: 656 +* manufacture of hunting, sporting or protective firearms and ammunition 657 +* manufacture of explosive devices such as bombs, mines and torpedoes 658 +)))| 659 +|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|((( 660 +Item in an Item Scheme 762 762 763 -<see section URL value defaults and specific locale values> 764 - 765 765 766 -))) 767 -|(% style="width:199px" %)DEFAULT|(% style="width:350px" %)((( 768 -Indication that an item in an Item Scheme or artefacts is to be selected by default. 663 +)))|((( 664 +<language>:<content>, 769 769 770 -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 771 -)))|(% style="width:250px" %)((( 772 -* Item in ItemScheme, or; 773 -* DSD, or; 774 -* a Dataflow 666 +<language>:<content>,… 667 +)))|((( 668 +Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition): 775 775 776 -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. 777 -)))|(% style="width:288px" %) |(% style="width:1427px" %)((( 778 -Attached to: 670 +en:This class excludes: 779 779 780 -- DSD or Dataflow: 781 -**<concept>=<code>+<code>+…,<concept>=<code>+<code>+…** 782 - 783 -//Example~:// FREQ=A+Q,TIME_PERIOD_START=2013-01,TIME_PERIOD_END=2018-12 672 +* manufacture of percussion caps, detonators or signalling flares, see 2029 673 +* manufacture of cutlasses, swords, bayonets etc., see 2593 784 784 )))| 785 -|(% style="width:199px" %)IMAGE|(% style="width:350px" %)A visual identity to associate to Item Scheme Items or artefacts|(% style="width:250px" %)((( 786 -Either: 787 - 788 -* an artefact, or; 789 -* an item in an item scheme 790 -)))|(% style="width:288px" %)((( 791 -For localised content in SDMX 2.1 792 - 793 -<language>:<HTML containing URL to the resource>, 794 - 795 -<language>:<HTML containing URL to the resource>,… 796 - 797 -//Example~:// 798 - 799 -en:<a href=”https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg”> 800 -)))|(% style="width:1427px" %) |((( 675 +|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|((( 801 801 See section URL value defaults and specific locale values. 802 802 803 -//Example~:// 804 - 805 -https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg 806 - 807 807 808 808 ))) 809 -| (% style="width:199px" %)DRILLDOWN_CONCEPTS|(% style="width:350px"%)Conceptstobedisplayedinadrilldown operation|(%style="width:250px"%)DatafloworDSD|(% style="width:288px"%)|(%style="width:1427px"%)(((810 -<con ceptId>,<conceptId>,…680 +|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| |((( 681 +<content> 811 811 812 -Example : 813 - 814 -DONOR,RECIPIENT,YEAR,PROJECT_ID,OBS_VALUE,DESCRIPTION,OWNER 815 -)))| 816 -|(% style="width:199px" %)NOT_DISPLAYED|(% style="width:350px" %)Used to hide components or their values in the presentation|(% style="width:250px" %)((( 817 -Either: 818 - 819 -* a Dataflow or DSD, or; 820 -* an Item in an Item Scheme 821 -)))|(% style="width:288px" %) |(% style="width:1427px" %)((( 822 -Attached to Item in Item Scheme: <blank> 823 - 824 -Attached to Dataflow or DSD: 825 - 826 -<concept Id>,<concept Id>,… 827 - 828 -Example : 829 - 830 -DD_DIM (to hide drilldown control concept) 831 -)))| 832 -|(% style="width:199px" %)LAYOUT_ROW|(% style="width:350px" %)Dimensions to be presented in rows (concepts on y-axis)|(% style="width:250px" %)((( 833 -Either: 834 - 835 -* an artefact, or; 836 -* a Dimension 837 -)))|(% style="width:288px" %) |(% style="width:1427px" %)((( 838 -Attached to Dimension: <blank> 839 - 840 -Attached to Dataflow or DSD: <dimension Id>,<dimension Id >,… 841 - 842 842 //Example~:// 843 843 844 - REF_AREA,MEASURE685 +A1+A2 845 845 )))| 846 -| (% style="width:199px" %)LAYOUT_COLUMN|(% style="width:350px" %)Dimensions to be presented in columns(concepts on x-axis)|(% style="width:250px" %)(((847 - Either:687 +|FOLLOWS|((( 688 +A reference used to express the succession in time of Item Schemes. 848 848 849 -* an artefact, or; 850 -* a Dimension 851 -)))|(% style="width:288px" %) |(% style="width:1427px" %)((( 852 -Attached to Dimension: <blank> 690 +For example, NACE Rev. 2 is the successor of NACE Rev. 1.1 853 853 854 -Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,… 692 +Reference to external standard: skos:ConceptScheme - property: xkos:follows 693 +)))|Codelist or Item Scheme| | |((( 694 +See section URL value defaults and specific locale values. 855 855 856 856 //Example~:// 857 857 858 -TIME_PERIOD 859 -)))| 860 -|(% 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" %)((( 861 -<concept Id>,<concept Id>,... 698 +(CL_REGIONAL 3.1.1 follows CL_REGIONAL 3.1): 862 862 863 -//Example~:// 700 +[[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]] 701 +))) 702 +|HAS_VARIANT|((( 703 +A reference used to express the relation between an Item Scheme and its variant(s). 864 864 865 -OBS_STATUS,CONF_STATUS 866 -)))| 867 -|(% 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" %)((( 868 -<concept Id>,<concept Id>,... 705 +Reference to external standard: skos:ConceptScheme - property: xkos:variant 869 869 870 -//Example~:// 871 871 872 -OBS_STATUS,CONF_STATUS 873 -)))| 874 -|(% style="width:199px" %)((( 875 -METADATA 708 +For //Example~:// CL_AREA has a variant CL_GEO 709 +)))|Codelist or Item Scheme| | |((( 710 +See section URL value defaults and specific locale values. 876 876 877 877 878 -))) |(% 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)|879 -| (% 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" %)(((880 - Either:713 +))) 714 +|SUPERSEED|((( 715 +A reference to a previous version, if the current version obsoleted the previous one. 881 881 882 - *anartefact,or;717 +May be used in conjunction with DEPRECATED. 883 883 884 -a Dimension 885 -)))|(% style="width:288px" %) |(% style="width:1427px" %)((( 886 -Attached to Dimension: <blank> 887 - 888 -Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,… 889 - 890 -//Example~:// 891 - 892 -SEX 893 -)))| 894 -|(% style="width:199px" %)EXT_RESOURCE|(% style="width:350px" %)((( 895 -A localised link to an external resource associated to the annotated artefact. For example, an ontology item 896 - 897 -//a methodology// en:<a href:"[[https:~~/~~/ec.europa.eu/eurostat/web/waste/methodology>>url:https://ec.europa.eu/eurostat/web/waste/methodology]]"> 898 -)))|(% style="width:250px" %)Any SDMX object|(% style="width:288px" %)((( 899 -For localised content in SDMX 2.1 900 - 901 - <language>:<HTML containing URL to the resource>, 902 - 903 -<language>:<HTML containing URL to the resource>,… 904 - 905 -//Example~:// 906 - 907 -en:<a href=”[[http:~~/~~/rdf-vocabulary.ddialliance.org/xkos#depth>>url:http://rdf-vocabulary.ddialliance.org/xkos#depth]]”> 908 -)))|(% style="width:1427px" %) |((( 719 +Reference to external standard: skos:ConceptScheme - property: xkos:supersedes 720 +)))|Codelist or Item Scheme, or an artefact| | |((( 909 909 See section URL value defaults and specific locale values. 910 910 911 -//Example~:// 912 - 913 -http:~/~/rdf-vocabulary.ddialliance.org/xkos#depth 723 + 914 914 ))) 915 -| (% style="width:199px" %)COMBINED_CONCEPTS|(% style="width:350px" %)(((916 - Comma-separatedlistofconceptIDs to showasaconcatenatedlabel.725 +|FAMILY_LABEL|((( 726 +Label of the Classification Family (e.g. NACE, ISIC) 917 917 918 - Thelisted concepts’item contents may beconcatenatedtogenerate thetargetconcept.728 +Reference to external standard: skos:ConceptScheme - property: xkos:belongsTo 919 919 920 -Multiple target concept combinations can be defined by separating the target concepts by ; 921 -)))|(% style="width:250px" %)Dataflow or DSD|(% style="width:288px" %)((( 922 -<language>:<display name>, 923 - 924 -<language>:<display name> 925 - 926 -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} 927 -)))|(% style="width:1427px" %) | 928 -|(% style="width:199px" %)(deprecated) UNIT_MEASURE_CONCEPTS|(% style="width:350px" %)((( 929 -Comma-separated list of concept IDs that is used to define the full unit of measure. The concepts must be in the DSD. 930 - 931 -The listed concepts’ item contents may be concatenated to generate the unit of measure label (unless the UNIT_MEASURE_LABEL annotation is present). 932 -)))|(% style="width:250px" %)Dataflow or DSD|(% style="width:288px" %) |(% style="width:1427px" %)((( 933 -<concept Id>,<concept Id>,… 934 - 935 -//Example~:// UNIT_MEASURE,UNIT_MULT,TRANSFORMATION [could generate a value of Australian Dollar, Thousands, Non-transformed] 936 -)))| 937 -|(% style="width:199px" %)(deprecated) UNIT_MEASURE_LABEL|(% style="width:350px" %)((( 938 -Indicates the concept that enumerates the full unit of measure labels. 939 - 940 -The concept must be in the DSD. UNIT_MEASURE_LABEL overrides the UNIT_MEASURE_CONCEPTS if both are provided. 941 - 942 -Also can be attached to items in item scheme, e.g. 943 - 944 -Text en:Gram 945 - fr: Gramme 946 -url:** **[[**http:~~/~~/data.europa.eu/gzn/su/G**>>url:http://data.europa.eu/gzn/su/G]] 947 -)))|(% style="width:250px" %)Dataflow or DSD, Item in an Item Scheme|(% style="width:288px" %)((( 948 -This is optional, used if a freetext label is required. 949 - 730 +label of the classification 731 +)))|Codelist or Item Scheme|((( 950 950 <language>:<content>, 951 951 952 952 <language>:<content>,… ... ... @@ -953,91 +953,65 @@ 953 953 954 954 //Example~:// 955 955 956 -en:USD, thousands 738 +en:NACE 739 +)))| |((( 740 +See section URL value defaults and specific locale values. 957 957 958 -fr:USD, milliers 959 -)))|(% style="width:1427px" %)((( 960 -This is optional, used if an enumerated list is required. 742 + 743 +))) 744 +|COVERAGE_LABEL|((( 745 +Label(s) of the item scheme’s coverage (e.g. National Accounts, Products, Activities, Occupations) 961 961 962 - <conceptId>747 +Reference to external standard: skos:ConceptScheme - property: xkos:covers 963 963 964 -//Example~:// 749 +//Examples~:// 965 965 966 -U OM_ATTRIBUTE[This concept maycontainthe following itemsasunitsof measure:751 +URL <http:~/~/eurovoc.europa.eu/56> (National accounts) 967 967 968 -* National Currency, thousands 969 -* USD, thousands 970 - 971 -Index, based on National Currency] 972 -)))| 973 -|(% style="width:199px" %)((( 974 -LAYOUT_TIME_PERIOD_DESC 975 - 976 - 977 -)))|(% 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" %)((( 978 -//Example~:// 979 - 980 -LAYOUT_TIME_PERIOD_DESC 981 -)))| 982 -|(% style="width:199px" %)((( 983 -LAYOUT_CELL_ALIGN 984 - 985 - 986 -)))|(% 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" %)((( 753 +URL <http:~/~/publications.europa.eu/resource/authority/data-theme/REGI> (Regions and Cities) 754 +)))|Codelist or Item Scheme|((( 987 987 <language>:<content>, 988 988 989 989 <language>:<content>,… 990 990 991 - 992 -<content> values:RIGHT or LEFT 993 -)))|(% style="width:1427px" %)Content values:RIGHT or LEFT| 994 -|(% style="width:199px" %)((( 995 -MAX_TABLE_DATA 996 - 997 - 998 -)))|(% 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" %)((( 999 -<integer> 1000 - 1001 1001 //Example~:// 1002 1002 1003 -15000 1004 -)))| 1005 -|(% style="width:199px" %)((( 1006 -MAXTEXTATTRIBUTELENGTH 761 +En:national accounts 762 +)))| |((( 763 +See section URL value defaults and specific locale values. 1007 1007 1008 1008 1009 -)))|(% style="width:350px" %)Increase the maximum length for textual attribute values|(% style="width:250px" %)DSD|(% style="width:288px" %) |(% style="width:1427px" %)((( 1010 -<integer> 766 +))) 767 +|GEO_FEATURE_SET|((( 768 +In Codelists, transmits GeoFeature values. 1011 1011 1012 -//Example~:// 770 +Example for NUTS ID BE23 771 +url:[[http:~~/~~/data.europa.eu/nuts/geometry/2xr1qiv9>>url:http://data.europa.eu/nuts/geometry/2xr1qiv9]] 772 +)))|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.| 773 +|GEO_TYPE_GEOGRAPHIC|Indicates that a codelist contains GeoFeature values via the GEO_FEATURE_SET annotation.|Codelist| | | 774 +|LEGAL_BASIS|((( 775 +Indicates that the Legislation on which the codelist/nomenclature is based. 1013 1013 1014 -500 1015 -)))| 1016 -|(% 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" %)((( 1017 -<language>:<integer>,... 777 +Example for NACE Rev.2.1 1018 1018 1019 -//Example~:// 779 +url: [[http:~~/~~/data.europa.eu/eli/reg_del/2023/137/oj>>url:http://data.europa.eu/eli/reg_del/2023/137/oj]] 780 +)))|Codelist| | |http:~/~/data.europa.eu/eli/reg_del/2023/137/oj 1020 1020 1021 -"en":"3","es":"4","fr":"5" 1022 -)))|(% style="width:1427px" %)((( 1023 -<integer> 1024 1024 1025 -//Example~:// 1026 1026 1027 -10 1028 -)))| 1029 1029 785 + 1030 1030 = Concept Scheme SDMX:CS_ANNOT = 1031 1031 1032 1032 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. 1033 1033 1034 -|**Property**| (% style="width:309px" %)**Representation in Concept**|(% style="width:1173px" %)**Description**1035 -|**Code**| (% style="width:309px" %)Concept Id|(% style="width:1173px" %)The Annotation Type column, e.g. NOT_DISPLAYED, EXCLUDES1036 -|**Name**| (% style="width:309px" %)Concept Name|(% style="width:1173px" %)Short description of the standard Annotation derived from the “Use case” column1037 -|**Representation**| (% style="width:309px" %)Concept Core Representation|(% style="width:1173px" %)Allowable type or format for the Annotation1038 -|**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 AnnotationTitle1039 -|**Artefact(s)**| (% style="width:309px" %)Annotation Type: Artefact(s)|(% style="width:1173px" %)The information in the “Where to attach” column1040 -|**URL**| (% style="width:309px" %)Annotation Type: URL|(% style="width:1173px" %)The Annotation URL column. The value is in URL790 +|**Property**|**Representation in Concept**|**Description** 791 +|**Code**|Concept Id|The Annotation Type column, e.g. NOT_DISPLAYED, EXCLUDES 792 +|**Name**|Concept Name|Short description of the standard Annotation derived from the “Use case” column 793 +|**Representation**|Concept Core Representation|Allowable type or format for the Annotation 794 +|**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 795 +|**Artefact(s)**|Annotation Type: Artefact(s)|The information in the “Where to attach” column 796 +|**URL**|Annotation Type: URL|The Annotation URL column. The value is in URL 1041 1041 1042 1042 == Example of a Concept == 1043 1043 ... ... @@ -1047,6 +1047,8 @@ 1047 1047 |**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 1048 1048 |**Concept: Annotation: Type: Artefact(s)**|Either a Dataflow or DSD, or an item in an item scheme 1049 1049 806 +=== === 807 + 1050 1050 === SDMX-ML of the Example === 1051 1051 1052 1052 <str:Concept id="NOT_DISPLAYED"> ... ... @@ -1074,4 +1074,8 @@ 1074 1074 1075 1075 ---- 1076 1076 1077 -{{putFootnotes/}} 835 +[[~[1~]>>path:#_ftnref1]] The technical standard does not enumerate the annotation types, however this guideline provides a recommended enumeration or controlled vocabulary 836 + 837 +[[~[2~]>>path:#_ftnref2]] International Standard Industrial Classification of All Economic Activities 838 + 839 +[[~[3~]>>path:#_ftnref3]] Central Product Classification