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
-
... ... @@ -43,7 +43,7 @@ 43 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 44 |**type**|(% style="width:823px" %)((( 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 [[~[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.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 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 48 |**url**|(% style="width:823px" %)((( 49 49 A link to external descriptive text. ... ... @@ -124,23 +124,20 @@ 124 124 125 125 == General and Display-related Annotation types == 126 126 127 -|Annotation Type|Use Case|Where to attach|((( 127 +|(% style="width:152px" %)Annotation Type|(% style="width:559px" %)Use Case|Where to attach|((( 128 128 +Text 129 129 130 130 Blue is optional 131 131 )))|((( 132 132 Title 133 - 134 134 Blue is optional 135 135 )))|((( 136 136 SDMX 2.1:URL 137 - 138 138 SDMX >=3.0:+URL 139 - 140 140 Blue is optional 141 141 ))) 142 -|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 143 -en: A0123 Growing of citrus fruits|Item in an Item Scheme|((( 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" %)((( 144 144 <language>:<content>, 145 145 146 146 <language>:<content>,… ... ... @@ -148,28 +148,28 @@ 148 148 //Example~:// 149 149 150 150 en:Labour force (Employment) 151 -)))|<content>| 152 -|REPLACE_NAME|Replace each code name in a component by the value of another component in an observation or series|A Dataflow or DSD| |((( 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" %)((( 153 153 <component Id to replace name>:<component Id to use name> 154 154 155 155 //Example~:// 156 156 157 157 CUST_BREAKDOWN:CUST_BREAKDOWN_LB 158 -)))| 159 -|REPLACE_CONTENT|Replace the content in a component by the value of another component in an observation or series|A Dataflow or DSD| |((( 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" %)((( 160 160 <component Id to replace content>:<component Id to use content> 161 161 162 162 //Example~:// 163 163 164 164 REF_AREA:M49_CODE 165 -)))| 166 -|COMPLEMENT|((( 162 +)))|(% style="width:866px" %) 163 +|(% style="width:152px" %)COMPLEMENT|(% style="width:559px" %)((( 167 167 Additional fixed text to be displayed in parenthesis after the code name. 168 168 169 169 E.g. Representation of Non-hazardous (NHAZW), hazardous waste (HAZW) in the European List of Wastes 170 170 en: 01 03 04* acid-generating tailings from processing of sulphide ore (HAZW) 171 171 en: 01 03 99 wastes not otherwise specified (NHAZW) 172 -)))|Item in an Item Scheme|((( 169 +)))|(% style="width:20px" %)Item in an Item Scheme|(% style="width:506px" %)((( 173 173 <language>:<content>, 174 174 175 175 <language>:<content>,… ... ... @@ -177,13 +177,13 @@ 177 177 //Example~:// 178 178 179 179 en:See reference metadata 180 -)))|<content>| 181 -|ORDER|Explicit indication of a localised order of items in Items Schemes or artefacts (e.g. Codelist, Concept Scheme, Category Scheme, Dataflow, etc.)|((( 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" %)((( 182 182 Either: 183 183 184 184 * an artefact, or; 185 185 * an item in an Item Scheme 186 -)))|((( 183 +)))|(% style="width:506px" %)((( 187 187 <language>:<content>, 188 188 189 189 <language>:<content>,… ... ... @@ -191,43 +191,42 @@ 191 191 //Example~:// 192 192 193 193 en:10,es:20 194 -)))|((( 191 +)))|(% style="width:178px" %)((( 195 195 <content> 196 196 197 197 198 -)))| 199 -|TOTAL|((( 195 +)))|(% style="width:866px" %) 196 +|(% style="width:152px" %)TOTAL|(% style="width:559px" %)((( 200 200 Code Item that represents a total value. If the attachment is: 201 201 202 202 * to a Code, the Annotation Text is optional and may contain an explanatory text; 203 - 204 -to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total 205 -)))|((( 200 +* to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total 201 +)))|(% style="width:20px" %)((( 206 206 Either: 207 207 208 208 * a Code Item that represents a total value, or; 209 209 * a Codelist to specify the code(s) with the total 210 -)))|((( 206 +)))|(% style="width:506px" %)((( 211 211 <language>:<explanatory text>, 212 212 213 213 <language>:<explanatory text>,… 214 -)))|((( 210 +)))|(% style="width:178px" %)((( 215 215 Attached to Code Item: <blank> 216 216 217 217 Attached to Codelist: <code>,<code>,… 218 -)))| 219 -|DRILLDOWN|Denotes the concept that specifies whether observations are at the aggregate level or a drilldown.|((( 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" %)((( 220 220 Either: 221 221 222 222 * A Dataflow or DSD 223 -)))| |((( 219 +)))|(% style="width:506px" %) |(% style="width:178px" %)((( 224 224 <concept Id> 225 225 226 226 //Example~:// 227 227 228 228 DD_DIM (this concept should be hidden using the NOT_DISPLAYED Annotation below) 229 -)))| 230 -|DEPRECATED|((( 225 +)))|(% style="width:866px" %) 226 +|(% style="width:152px" %)DEPRECATED|(% style="width:559px" %)((( 231 231 Indication that an Item in an Item Scheme or an artefact is deprecated. 232 232 233 233 For an item scheme item, the annotation value provides a replacement name for the code name. ... ... @@ -242,12 +242,12 @@ 242 242 or 243 243 244 244 TITLE: true (false) 245 -)))|((( 241 +)))|(% style="width:20px" %)((( 246 246 Either: 247 247 248 248 * an artefact, or; 249 249 * an item in an Item Scheme 250 -)))|((( 246 +)))|(% style="width:506px" %)((( 251 251 For item scheme item: 252 252 253 253 <language>:<content>, ... ... @@ -257,7 +257,7 @@ 257 257 //Example~:// 258 258 259 259 en:deprecated,fr:obsolète 260 -)))|<content>|((( 256 +)))|(% style="width:178px" %)<content>|(% style="width:866px" %)((( 261 261 For artefact: 262 262 263 263 <see section URL value defaults and specific locale values> ... ... @@ -264,17 +264,17 @@ 264 264 265 265 266 266 ))) 267 -|DEFAULT|((( 263 +|(% style="width:152px" %)DEFAULT|(% style="width:559px" %)((( 268 268 Indication that an item in an Item Scheme or artefacts is to be selected by default. 269 269 270 270 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 271 -)))|((( 267 +)))|(% style="width:20px" %)((( 272 272 * Item in ItemScheme, or; 273 273 * DSD, or; 274 274 * a Dataflow 275 275 276 276 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. 277 -)))| |((( 273 +)))|(% style="width:506px" %) |(% style="width:178px" %)((( 278 278 Attached to: 279 279 280 280 - DSD or Dataflow: ... ... @@ -281,13 +281,13 @@ 281 281 **<concept>=<code>+<code>+…,<concept>=<code>+<code>+…** 282 282 283 283 //Example~:// FREQ=A+Q,TIME_PERIOD_START=2013-01,TIME_PERIOD_END=2018-12 284 -)))| 285 -|IMAGE|A visual identity to associate to Item Scheme Items or artefacts|((( 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" %)((( 286 286 Either: 287 287 288 288 * an artefact, or; 289 289 * an item in an item scheme 290 -)))|((( 286 +)))|(% style="width:506px" %)((( 291 291 For localised content in SDMX 2.1 292 292 293 293 <language>:<HTML containing URL to the resource>, ... ... @@ -297,7 +297,7 @@ 297 297 //Example~:// 298 298 299 299 en:<a href=”https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg”> 300 -)))| |((( 296 +)))|(% style="width:178px" %) |(% style="width:866px" %)((( 301 301 See section URL value defaults and specific locale values. 302 302 303 303 //Example~:// ... ... @@ -306,19 +306,19 @@ 306 306 307 307 308 308 ))) 309 -|DRILLDOWN_CONCEPTS|Concepts to be displayed in a drilldown operation|Dataflow or DSD| |((( 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" %)((( 310 310 <concept Id>,<concept Id>,… 311 311 312 312 Example : 313 313 314 314 DONOR,RECIPIENT,YEAR,PROJECT_ID,OBS_VALUE,DESCRIPTION,OWNER 315 -)))| 316 -|NOT_DISPLAYED|Used to hide components or their values in the presentation|((( 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" %)((( 317 317 Either: 318 318 319 319 * a Dataflow or DSD, or; 320 320 * an Item in an Item Scheme 321 -)))| |((( 317 +)))|(% style="width:506px" %) |(% style="width:178px" %)((( 322 322 Attached to Item in Item Scheme: <blank> 323 323 324 324 Attached to Dataflow or DSD: ... ... @@ -328,13 +328,13 @@ 328 328 Example : 329 329 330 330 DD_DIM (to hide drilldown control concept) 331 -)))| 332 -|LAYOUT_ROW|Dimensions to be presented in rows (concepts on y-axis)|((( 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" %)((( 333 333 Either: 334 334 335 335 * an artefact, or; 336 336 * a Dimension 337 -)))| |((( 333 +)))|(% style="width:506px" %) |(% style="width:178px" %)((( 338 338 Attached to Dimension: <blank> 339 339 340 340 Attached to Dataflow or DSD: <dimension Id>,<dimension Id >,… ... ... @@ -342,13 +342,13 @@ 342 342 //Example~:// 343 343 344 344 REF_AREA,MEASURE 345 -)))| 346 -|LAYOUT_COLUMN|Dimensions to be presented in columns (concepts on x-axis)|((( 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" %)((( 347 347 Either: 348 348 349 349 * an artefact, or; 350 350 * a Dimension 351 -)))| |((( 347 +)))|(% style="width:506px" %) |(% style="width:178px" %)((( 352 352 Attached to Dimension: <blank> 353 353 354 354 Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,… ... ... @@ -356,33 +356,33 @@ 356 356 //Example~:// 357 357 358 358 TIME_PERIOD 359 -)))| 360 -|LAYOUT_FLAG|Indication that an attribute and its attribute value should be presented as a flag|Dataflow| |((( 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" %)((( 361 361 <concept Id>,<concept Id>,... 362 362 363 363 //Example~:// 364 364 365 365 OBS_STATUS,CONF_STATUS 366 -)))| 367 -|LAYOUT_NOTE|Indication that an attribute and its attribute value should be presented as a note|Dataflow| |((( 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" %)((( 368 368 <concept Id>,<concept Id>,... 369 369 370 370 //Example~:// 371 371 372 372 OBS_STATUS,CONF_STATUS 373 -)))| 374 -|((( 369 +)))|(% style="width:866px" %) 370 +|(% style="width:152px" %)((( 375 375 METADATA 376 376 377 377 378 -)))|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)| 379 -|LAYOUT_ROW_SECTION|Dimension to be presented as a break-down concept at a third hierarchical level above columns and rows.|((( 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" %)((( 380 380 Either: 381 381 382 382 * an artefact, or; 383 383 384 384 a Dimension 385 -)))| |((( 381 +)))|(% style="width:506px" %) |(% style="width:178px" %)((( 386 386 Attached to Dimension: <blank> 387 387 388 388 Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,… ... ... @@ -390,12 +390,12 @@ 390 390 //Example~:// 391 391 392 392 SEX 393 -)))| 394 -|EXT_RESOURCE|((( 389 +)))|(% style="width:866px" %) 390 +|(% style="width:152px" %)EXT_RESOURCE|(% style="width:559px" %)((( 395 395 A localised link to an external resource associated to the annotated artefact. For example, an ontology item 396 396 397 397 //a methodology// en:<a href:"[[https:~~/~~/ec.europa.eu/eurostat/web/waste/methodology>>url:https://ec.europa.eu/eurostat/web/waste/methodology]]"> 398 -)))|Any SDMX object|((( 394 +)))|(% style="width:20px" %)Any SDMX object|(% style="width:506px" %)((( 399 399 For localised content in SDMX 2.1 400 400 401 401 <language>:<HTML containing URL to the resource>, ... ... @@ -405,7 +405,7 @@ 405 405 //Example~:// 406 406 407 407 en:<a href=”[[http:~~/~~/rdf-vocabulary.ddialliance.org/xkos#depth>>url:http://rdf-vocabulary.ddialliance.org/xkos#depth]]”> 408 -)))| |((( 404 +)))|(% style="width:178px" %) |(% style="width:866px" %)((( 409 409 See section URL value defaults and specific locale values. 410 410 411 411 //Example~:// ... ... @@ -412,29 +412,29 @@ 412 412 413 413 http:~/~/rdf-vocabulary.ddialliance.org/xkos#depth 414 414 ))) 415 -|COMBINED_CONCEPTS|((( 411 +|(% style="width:152px" %)COMBINED_CONCEPTS|(% style="width:559px" %)((( 416 416 Comma-separated list of concept IDs to show as a concatenated label. 417 417 418 418 The listed concepts’ item contents may be concatenated to generate the target concept. 419 419 420 420 Multiple target concept combinations can be defined by separating the target concepts by ; 421 -)))|Dataflow or DSD|((( 417 +)))|(% style="width:20px" %)Dataflow or DSD|(% style="width:506px" %)((( 422 422 <language>:<display name>, 423 423 424 424 <language>:<display name> 425 425 426 426 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} 427 -)))| | 428 -|(deprecated) UNIT_MEASURE_CONCEPTS|((( 423 +)))|(% style="width:178px" %) |(% style="width:866px" %) 424 +|(% style="width:152px" %)(deprecated) UNIT_MEASURE_CONCEPTS|(% style="width:559px" %)((( 429 429 Comma-separated list of concept IDs that is used to define the full unit of measure. The concepts must be in the DSD. 430 430 431 431 The listed concepts’ item contents may be concatenated to generate the unit of measure label (unless the UNIT_MEASURE_LABEL annotation is present). 432 -)))|Dataflow or DSD| |((( 428 +)))|(% style="width:20px" %)Dataflow or DSD|(% style="width:506px" %) |(% style="width:178px" %)((( 433 433 <concept Id>,<concept Id>,… 434 434 435 435 //Example~:// UNIT_MEASURE,UNIT_MULT,TRANSFORMATION [could generate a value of Australian Dollar, Thousands, Non-transformed] 436 -)))| 437 -|(deprecated) UNIT_MEASURE_LABEL|((( 432 +)))|(% style="width:866px" %) 433 +|(% style="width:152px" %)(deprecated) UNIT_MEASURE_LABEL|(% style="width:559px" %)((( 438 438 Indicates the concept that enumerates the full unit of measure labels. 439 439 440 440 The concept must be in the DSD. UNIT_MEASURE_LABEL overrides the UNIT_MEASURE_CONCEPTS if both are provided. ... ... @@ -444,7 +444,7 @@ 444 444 Text en:Gram 445 445 fr: Gramme 446 446 url:** **[[**http:~~/~~/data.europa.eu/gzn/su/G**>>url:http://data.europa.eu/gzn/su/G]] 447 -)))|Dataflow or DSD, Item in an Item Scheme|((( 443 +)))|(% style="width:20px" %)Dataflow or DSD, Item in an Item Scheme|(% style="width:506px" %)((( 448 448 This is optional, used if a freetext label is required. 449 449 450 450 <language>:<content>, ... ... @@ -456,7 +456,7 @@ 456 456 en:USD, thousands 457 457 458 458 fr:USD, milliers 459 -)))|((( 455 +)))|(% style="width:178px" %)((( 460 460 This is optional, used if an enumerated list is required. 461 461 462 462 <concept Id> ... ... @@ -469,21 +469,21 @@ 469 469 * USD, thousands 470 470 471 471 Index, based on National Currency] 472 -)))| 473 -|((( 468 +)))|(% style="width:866px" %) 469 +|(% style="width:152px" %)((( 474 474 LAYOUT_TIME_PERIOD_DESC 475 475 476 476 477 -)))|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| |((( 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" %)((( 478 478 //Example~:// 479 479 480 480 LAYOUT_TIME_PERIOD_DESC 481 -)))| 482 -|((( 477 +)))|(% style="width:866px" %) 478 +|(% style="width:152px" %)((( 483 483 LAYOUT_CELL_ALIGN 484 484 485 485 486 -)))|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|((( 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" %)((( 487 487 <language>:<content>, 488 488 489 489 <language>:<content>,… ... ... @@ -490,56 +490,54 @@ 490 490 491 491 492 492 <content> values:RIGHT or LEFT 493 -)))|Content values:RIGHT or LEFT| 494 -|((( 489 +)))|(% style="width:178px" %)Content values:RIGHT or LEFT|(% style="width:866px" %) 490 +|(% style="width:152px" %)((( 495 495 MAX_TABLE_DATA 496 496 497 497 498 -)))|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| |((( 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" %)((( 499 499 <integer> 500 500 501 501 //Example~:// 502 502 503 503 15000 504 -)))| 505 -|((( 500 +)))|(% style="width:866px" %) 501 +|(% style="width:152px" %)((( 506 506 MAXTEXTATTRIBUTELENGTH 507 507 508 508 509 -)))|Increase the maximum length for textual attribute values|DSD| |((( 505 +)))|(% style="width:559px" %)Increase the maximum length for textual attribute values|(% style="width:20px" %)DSD|(% style="width:506px" %) |(% style="width:178px" %)((( 510 510 <integer> 511 511 512 512 //Example~:// 513 513 514 514 500 515 -)))| 516 -|SEARCH_WEIGHT|Indication of localised boosted dataflows in the search results when ordered by relevance|Dataflow|((( 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" %)((( 517 517 <language>:<integer>,... 518 518 519 519 //Example~:// 520 520 521 521 "en":"3","es":"4","fr":"5" 522 -)))|((( 518 +)))|(% style="width:178px" %)((( 523 523 <integer> 524 524 525 525 //Example~:// 526 526 527 527 10 528 -)))| 524 +)))|(% style="width:866px" %) 529 529 530 530 == Codelist and Statistical Classification-specific Annotations == 531 531 532 -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]].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}}. 533 533 534 -|Annotation Type|Use Case|Where to attach|((( 530 +|(% style="width:170px" %)Annotation Type|(% style="width:451px" %)Use Case|(% style="width:203px" %)Where to attach|(% style="width:254px" %)((( 535 535 +Text 536 - 537 537 Blue is optional 538 -)))|((( 533 +)))|(% style="width:556.217px" %)((( 539 539 Title 540 - 541 541 Blue is optional 542 -)))|((( 536 +)))|(% style="width:460px" %)((( 543 543 SDMX 2.1:URL 544 544 545 545 SDMX >=3.0:+URL ... ... @@ -546,7 +546,7 @@ 546 546 547 547 Blue is optional 548 548 ))) 549 -|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| |((( 543 +|(% style="width:170px" %)ORIGINAL_CODE|(% style="width:451px" %)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|(% style="width:203px" %)Item in an Item Scheme|(% style="width:254px" %) |(% style="width:556.217px" %)((( 550 550 <original code> 551 551 552 552 //Examples~:// ... ... @@ -553,69 +553,62 @@ 553 553 554 554 * 0105.13 [Harmonized System] 555 555 * 11.2.0.9 [COICOP classification] 556 -)))| 557 -|HIER_CONTEXT|((( 550 +)))|(% style="width:460px" %) 551 +|(% style="width:170px" %)HIER_CONTEXT|(% style="width:451px" %)((( 558 558 In SDMX 2.1, a reference between a usage context and a hierarchy (that may be contained in a Hierarchical Codelist (HCL)). 559 - 560 560 In SDMX 3.0, use the HierarchyAssociation artefact 561 -)))|DSD or Dataflow| |((( 554 +)))|(% style="width:203px" %)DSD or Dataflow|(% style="width:254px" %) |(% style="width:556.217px" %)((( 562 562 <component Id>:<HCL Id>.<hierarchy Id> 563 563 564 564 //Example~:// 565 565 566 566 REF_AREA:OECD.EDU:HCL_REF_AREA(1.0).REF_AREA provides the link to the reference area hierarchy for OECD education data 567 -)))| 568 -|HIER_LEVEL|((( 560 +)))|(% style="width:460px" %) 561 +|(% style="width:170px" %)HIER_LEVEL|(% style="width:451px" %)((( 569 569 Explicit specification of the hierarchical level of a code item 570 - 571 571 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]] 572 572 573 573 text en:sections 574 -)))|Code item| |((( 566 +)))|(% style="width:203px" %)Code item|(% style="width:254px" %) |(% style="width:556.217px" %)((( 575 575 <hierarchical level> 576 576 577 577 //Example~:// 578 578 579 579 1 580 -)))| 581 -|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|((( 582 -<language>:<content>, 583 - 584 -<language>:<content>,… 585 -)))|((( 572 +)))|(% style="width:460px" %) 573 +|(% style="width:170px" %)SHORT_LABEL|(% style="width:451px" %)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)|(% style="width:203px" %)Artefact, or Concept, or Item in an Item Scheme|(% style="width:254px" %)((( 574 +<language>:<content>, <language>:<content>,… 575 +)))|(% style="width:556.217px" %)((( 586 586 //Example~:// 587 587 588 588 [Official French label “Transformation et conservation de la viande de boucherie” is shortened to] fr:Transf. & conserv. viande de boucherie 589 589 590 - 591 591 In Codelist=IMF:CL_AREA(1.13) 592 592 Code 4J837 European Union Intellectual Property Office has a Short_Label 593 593 594 594 EN:EUIPO 595 -)))| 596 -|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|((( 597 -<language>:<content>, 598 - 599 -<language>:<content>,… 600 -)))|((( 584 +)))|(% style="width:460px" %) 585 +|(% style="width:170px" %)EXPLAN_LABEL|(% style="width:451px" %)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|(% style="width:203px" %)Item in an Item Scheme, mapping to Representation Maps|(% style="width:254px" %)((( 586 +<language>:<content>, <language>:<content>,… 587 +)))|(% style="width:556.217px" %)((( 601 601 //Example~:// 602 602 603 603 [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 604 -)))| 605 -|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|((( 591 +)))|(% style="width:460px" %) 592 +|(% style="width:170px" %)EXPLAN_CONSOL|(% style="width:451px" %)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|(% style="width:203px" %)Item in an Item Scheme, mapping to Representation Maps|(% style="width:254px" %)((( 606 606 <language>:<content>, 607 607 608 608 <language>:<content>,… 609 -)))|((( 596 +)))|(% style="width:556.217px" %)((( 610 610 Example (from the US NAICS classification): 611 611 612 612 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. 613 -)))| 614 -|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|((( 600 +)))|(% style="width:460px" %) 601 +|(% style="width:170px" %)EXPLAN_INCLUDES|(% style="width:451px" %)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)|(% style="width:203px" %)Item in an Item Scheme, mapping to Representation Maps|(% style="width:254px" %)((( 615 615 <language>:<content>, 616 616 617 617 <language>:<content>,… 618 -)))|((( 605 +)))|(% style="width:556.217px" %)((( 619 619 Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition): 620 620 621 621 en: This class includes: ... ... @@ -624,8 +624,8 @@ 624 624 * manufacture of small arms (revolvers, shotguns, light machine guns) 625 625 * manufacture of air or gas guns and pistols 626 626 * manufacture of war ammunition 627 -)))| 628 -|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|((( 614 +)))|(% style="width:460px" %) 615 +|(% style="width:170px" %)EXPLAN_CASELAW|(% style="width:451px" %)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)|(% style="width:203px" %)Item in an Item Scheme|(% style="width:254px" %)((( 629 629 <language>:<content>, 630 630 631 631 <language>:<content>,… ... ... @@ -633,12 +633,12 @@ 633 633 Example (from NACE Rev. 2 caselaw to code 01.62): 634 634 635 635 en:Automated egg hatching for poultry - Operation of livestock management systems] 636 -)))| | 637 -|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|((( 623 +)))|(% style="width:556.217px" %) |(% style="width:460px" %) 624 +|(% style="width:170px" %)EXPLAN_INCLUDES_ALSO|(% style="width:451px" %)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|(% style="width:203px" %)Item in an Item Scheme|(% style="width:254px" %)((( 638 638 <language>:<content>, 639 639 640 640 <language>:<content>,… 641 -)))|((( 628 +)))|(% style="width:556.217px" %)((( 642 642 Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition): 643 643 644 644 en:This class also includes: ... ... @@ -645,16 +645,16 @@ 645 645 646 646 * manufacture of hunting, sporting or protective firearms and ammunition 647 647 * manufacture of explosive devices such as bombs, mines and torpedoes 648 -)))| 649 -|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|((( 635 +)))|(% style="width:460px" %) 636 +|(% style="width:170px" %)EXPLAN_EXCLUDES|(% style="width:451px" %)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|(% style="width:203px" %)((( 650 650 Item in an Item Scheme 651 651 652 652 653 -)))|((( 640 +)))|(% style="width:254px" %)((( 654 654 <language>:<content>, 655 655 656 656 <language>:<content>,… 657 -)))|((( 644 +)))|(% style="width:556.217px" %)((( 658 658 Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition): 659 659 660 660 en:This class excludes: ... ... @@ -661,26 +661,24 @@ 661 661 662 662 * manufacture of percussion caps, detonators or signalling flares, see 2029 663 663 * manufacture of cutlasses, swords, bayonets etc., see 2593 664 -)))| 665 -|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|((( 651 +)))|(% style="width:460px" %) 652 +|(% style="width:170px" %)MAP_REFER|(% style="width:451px" %)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)|(% style="width:203px" %)Codelist, Concept Scheme, or another Item Scheme|(% style="width:254px" %) |(% style="width:556.217px" %)Id of an ItemSchemeMap returned by the Annotation URL|(% style="width:460px" %)((( 666 666 See section URL value defaults and specific locale values. 667 667 668 668 669 669 ))) 670 -|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| |((( 657 +|(% style="width:170px" %)COMP_RULE|(% style="width:451px" %)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|(% style="width:203px" %)An Item in an Item Scheme|(% style="width:254px" %) |(% style="width:556.217px" %)((( 671 671 <content> 672 672 673 673 //Example~:// 674 674 675 675 A1+A2 676 -)))| 677 -|FOLLOWS|((( 663 +)))|(% style="width:460px" %) 664 +|(% style="width:170px" %)FOLLOWS|(% style="width:451px" %)((( 678 678 A reference used to express the succession in time of Item Schemes. 679 - 680 680 For example, NACE Rev. 2 is the successor of NACE Rev. 1.1 681 - 682 682 Reference to external standard: skos:ConceptScheme - property: xkos:follows 683 -)))|Codelist or Item Scheme| | |((( 668 +)))|(% style="width:203px" %)Codelist or Item Scheme|(% style="width:254px" %) |(% style="width:556.217px" %) |(% style="width:460px" %)((( 684 684 See section URL value defaults and specific locale values. 685 685 686 686 //Example~:// ... ... @@ -689,36 +689,31 @@ 689 689 690 690 [[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]] 691 691 ))) 692 -|HAS_VARIANT|((( 677 +|(% style="width:170px" %)HAS_VARIANT|(% style="width:451px" %)((( 693 693 A reference used to express the relation between an Item Scheme and its variant(s). 694 - 695 695 Reference to external standard: skos:ConceptScheme - property: xkos:variant 696 - 697 - 698 698 For //Example~:// CL_AREA has a variant CL_GEO 699 -)))|Codelist or Item Scheme| | |((( 681 +)))|(% style="width:203px" %)Codelist or Item Scheme|(% style="width:254px" %) |(% style="width:556.217px" %) |(% style="width:460px" %)((( 700 700 See section URL value defaults and specific locale values. 701 701 702 702 703 703 ))) 704 -|SUPERSEED|((( 686 +|(% style="width:170px" %)SUPERSEED|(% style="width:451px" %)((( 705 705 A reference to a previous version, if the current version obsoleted the previous one. 706 - 707 707 May be used in conjunction with DEPRECATED. 708 - 709 709 Reference to external standard: skos:ConceptScheme - property: xkos:supersedes 710 -)))|Codelist or Item Scheme, or an artefact| | |((( 690 +)))|(% style="width:203px" %)Codelist or Item Scheme, or an artefact|(% style="width:254px" %) |(% style="width:556.217px" %) |(% style="width:460px" %)((( 711 711 See section URL value defaults and specific locale values. 712 712 713 713 714 714 ))) 715 -|FAMILY_LABEL|((( 695 +|(% style="width:170px" %)FAMILY_LABEL|(% style="width:451px" %)((( 716 716 Label of the Classification Family (e.g. NACE, ISIC) 717 717 718 -Reference to external standard: skos:ConceptScheme - property: xkos:belongsTo719 - 698 +Reference to external standard: 699 +skos:ConceptScheme - property: xkos:belongsTo 720 720 label of the classification 721 -)))|Codelist or Item Scheme|((( 701 +)))|(% style="width:203px" %)Codelist or Item Scheme|(% style="width:254px" %)((( 722 722 <language>:<content>, 723 723 724 724 <language>:<content>,… ... ... @@ -726,12 +726,12 @@ 726 726 //Example~:// 727 727 728 728 en:NACE 729 -)))| |((( 709 +)))|(% style="width:556.217px" %) |(% style="width:460px" %)((( 730 730 See section URL value defaults and specific locale values. 731 731 732 732 733 733 ))) 734 -|COVERAGE_LABEL|((( 714 +|(% style="width:170px" %)COVERAGE_LABEL|(% style="width:451px" %)((( 735 735 Label(s) of the item scheme’s coverage (e.g. National Accounts, Products, Activities, Occupations) 736 736 737 737 Reference to external standard: skos:ConceptScheme - property: xkos:covers ... ... @@ -741,7 +741,7 @@ 741 741 URL <http:~/~/eurovoc.europa.eu/56> (National accounts) 742 742 743 743 URL <http:~/~/publications.europa.eu/resource/authority/data-theme/REGI> (Regions and Cities) 744 -)))|Codelist or Item Scheme|((( 724 +)))|(% style="width:203px" %)Codelist or Item Scheme|(% style="width:254px" %)((( 745 745 <language>:<content>, 746 746 747 747 <language>:<content>,… ... ... @@ -749,41 +749,465 @@ 749 749 //Example~:// 750 750 751 751 En:national accounts 752 -)))| |((( 732 +)))|(% style="width:556.217px" %) |(% style="width:460px" %)((( 753 753 See section URL value defaults and specific locale values. 754 754 755 755 756 756 ))) 757 -|GEO_FEATURE_SET|((( 737 +|(% style="width:170px" %)GEO_FEATURE_SET|(% style="width:451px" %)((( 758 758 In Codelists, transmits GeoFeature values. 759 759 760 760 Example for NUTS ID BE23 761 761 url:[[http:~~/~~/data.europa.eu/nuts/geometry/2xr1qiv9>>url:http://data.europa.eu/nuts/geometry/2xr1qiv9]] 762 -)))|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.| 763 -|GEO_TYPE_GEOGRAPHIC|Indicates that a codelist contains GeoFeature values via the GEO_FEATURE_SET annotation.|Codelist| | | 764 -|LEGAL_BASIS|((( 742 +)))|(% style="width:203px" %)Code in a Codelist. The Codelist must have an annotation attached with AnnotationType=GEO_TYPE_GEOGRAPHIC|(% style="width:254px" %) |(% style="width:556.217px" %)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.|(% style="width:460px" %) 743 +|(% style="width:170px" %)GEO_TYPE_GEOGRAPHIC|(% style="width:451px" %)Indicates that a codelist contains GeoFeature values via the GEO_FEATURE_SET annotation.|(% style="width:203px" %)Codelist|(% style="width:254px" %) |(% style="width:556.217px" %) |(% style="width:460px" %) 744 +|(% style="width:170px" %)LEGAL_BASIS|(% style="width:451px" %)((( 765 765 Indicates that the Legislation on which the codelist/nomenclature is based. 766 766 767 767 Example for NACE Rev.2.1 768 768 769 769 url: [[http:~~/~~/data.europa.eu/eli/reg_del/2023/137/oj>>url:http://data.europa.eu/eli/reg_del/2023/137/oj]] 770 -)))|Codelist| | |http:~/~/data.europa.eu/eli/reg_del/2023/137/oj 750 +)))|(% style="width:203px" %)Codelist|(% style="width:254px" %) |(% style="width:556.217px" %) |(% style="width:460px" %)http:~/~/data.europa.eu/eli/reg_del/2023/137/oj 771 771 772 772 773 773 754 +|Annotation Type|Use Case|Where to attach|((( 755 ++Text 756 +(% style="background-color:transparent" %)Blue is optional 757 +)))|((( 758 +Title 759 +(% style="background-color:transparent" %)Blue is optional 760 +)))|((( 761 +SDMX 2.1:URL 762 +SDMX >=3.0:+URL 763 +(% style="background-color:transparent" %)Blue is optional 764 +))) 765 +| | | | | | 766 +| | | | | | 767 +| | | | | | 768 +| | | | | | 769 +| | | | | | 770 +| | | | | | 771 +| | | | | | 772 +| | | | | | 773 +| | | | | | 774 +| | | | | | 775 +| | | | | | 776 +| | | | | | 777 +| | | | | | 778 +| | | | | | 779 +| | | | | | 780 +| | | | | | 781 +| | | | | | 782 +| | | | | | 783 +| | | | | | 774 774 775 775 786 + 787 + 788 +|Annotation Type|Use Case|Where to attach|(% style="width:288px" %)((( 789 ++TextBlue is optional 790 +)))|(% style="width:1427px" %)((( 791 +TitleBlue is optional 792 +)))|((( 793 +SDMX 2.1:URLSDMX >=3.0:+URLBlue is optional 794 +))) 795 +|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 796 +en: A0123 Growing of citrus fruits|Item in an Item Scheme|(% style="width:288px" %)((( 797 +<language>:<content>, 798 +<language>:<content>,… 799 +//Example~:// 800 +en:Labour force (Employment) 801 +)))|(% style="width:1427px" %)<content>| 802 +|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" %)((( 803 +<component Id to replace name>:<component Id to use name> 804 + 805 +//Example~:// 806 + 807 +CUST_BREAKDOWN:CUST_BREAKDOWN_LB 808 +)))| 809 +|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" %)((( 810 +<component Id to replace content>:<component Id to use content> 811 + 812 +//Example~:// 813 + 814 +REF_AREA:M49_CODE 815 +)))| 816 +|(% style="width:199px" %)COMPLEMENT|(% style="width:350px" %)((( 817 +Additional fixed text to be displayed in parenthesis after the code name. 818 + 819 +E.g. Representation of Non-hazardous (NHAZW), hazardous waste (HAZW) in the European List of Wastes 820 +en: 01 03 04* acid-generating tailings from processing of sulphide ore (HAZW) 821 +en: 01 03 99 wastes not otherwise specified (NHAZW) 822 +)))|(% style="width:250px" %)Item in an Item Scheme|(% style="width:288px" %)((( 823 +<language>:<content>, 824 + 825 +<language>:<content>,… 826 + 827 +//Example~:// 828 + 829 +en:See reference metadata 830 +)))|(% style="width:1427px" %)<content>| 831 +|(% 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" %)((( 832 +Either: 833 + 834 +* an artefact, or; 835 +* an item in an Item Scheme 836 +)))|(% style="width:288px" %)((( 837 +<language>:<content>, 838 + 839 +<language>:<content>,… 840 + 841 +//Example~:// 842 + 843 +en:10,es:20 844 +)))|(% style="width:1427px" %)((( 845 +<content> 846 + 847 + 848 +)))| 849 +|(% style="width:199px" %)TOTAL|(% style="width:350px" %)((( 850 +Code Item that represents a total value. If the attachment is: 851 + 852 +* to a Code, the Annotation Text is optional and may contain an explanatory text; 853 + 854 +to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total 855 +)))|(% style="width:250px" %)((( 856 +Either: 857 + 858 +* a Code Item that represents a total value, or; 859 +* a Codelist to specify the code(s) with the total 860 +)))|(% style="width:288px" %)((( 861 +<language>:<explanatory text>, 862 + 863 +<language>:<explanatory text>,… 864 +)))|(% style="width:1427px" %)((( 865 +Attached to Code Item: <blank> 866 + 867 +Attached to Codelist: <code>,<code>,… 868 +)))| 869 +|(% 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" %)((( 870 +Either: 871 + 872 +* A Dataflow or DSD 873 +)))|(% style="width:288px" %) |(% style="width:1427px" %)((( 874 +<concept Id> 875 + 876 +//Example~:// 877 + 878 +DD_DIM (this concept should be hidden using the NOT_DISPLAYED Annotation below) 879 +)))| 880 +|(% style="width:199px" %)DEPRECATED|(% style="width:350px" %)((( 881 +Indication that an Item in an Item Scheme or an artefact is deprecated. 882 + 883 +For an item scheme item, the annotation value provides a replacement name for the code name. 884 + 885 +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. 886 + 887 +Suggestion to use a controlled vocabulary 888 + 889 +url: <[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/CURRENT>>url:http://publications.europa.eu/resource/authority/concept-status/CURRENT]]> 890 +url: <[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/DEPRECATED>>url:http://publications.europa.eu/resource/authority/concept-status/DEPRECATED]]> 891 + 892 +or 893 + 894 +TITLE: true (false) 895 +)))|(% style="width:250px" %)((( 896 +Either: 897 + 898 +* an artefact, or; 899 +* an item in an Item Scheme 900 +)))|(% style="width:288px" %)((( 901 +For item scheme item: 902 + 903 +<language>:<content>, 904 + 905 +<language>:<content>,… 906 + 907 +//Example~:// 908 + 909 +en:deprecated,fr:obsolète 910 +)))|(% style="width:1427px" %)<content>|((( 911 +For artefact: 912 + 913 +<see section URL value defaults and specific locale values> 914 + 915 + 916 +))) 917 +|(% style="width:199px" %)DEFAULT|(% style="width:350px" %)((( 918 +Indication that an item in an Item Scheme or artefacts is to be selected by default. 919 + 920 +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 921 +)))|(% style="width:250px" %)((( 922 +* Item in ItemScheme, or; 923 +* DSD, or; 924 +* a Dataflow 925 + 926 +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. 927 +)))|(% style="width:288px" %) |(% style="width:1427px" %)((( 928 +Attached to: 929 + 930 +- DSD or Dataflow: 931 +**<concept>=<code>+<code>+…,<concept>=<code>+<code>+…** 932 + 933 +//Example~:// FREQ=A+Q,TIME_PERIOD_START=2013-01,TIME_PERIOD_END=2018-12 934 +)))| 935 +|(% style="width:199px" %)IMAGE|(% style="width:350px" %)A visual identity to associate to Item Scheme Items or artefacts|(% style="width:250px" %)((( 936 +Either: 937 + 938 +* an artefact, or; 939 +* an item in an item scheme 940 +)))|(% style="width:288px" %)((( 941 +For localised content in SDMX 2.1 942 + 943 +<language>:<HTML containing URL to the resource>, 944 + 945 +<language>:<HTML containing URL to the resource>,… 946 + 947 +//Example~:// 948 + 949 +en:<a href=”https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg”> 950 +)))|(% style="width:1427px" %) |((( 951 +See section URL value defaults and specific locale values. 952 + 953 +//Example~:// 954 + 955 +https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg 956 + 957 + 958 +))) 959 +|(% 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" %)((( 960 +<concept Id>,<concept Id>,… 961 + 962 +Example : 963 + 964 +DONOR,RECIPIENT,YEAR,PROJECT_ID,OBS_VALUE,DESCRIPTION,OWNER 965 +)))| 966 +|(% style="width:199px" %)NOT_DISPLAYED|(% style="width:350px" %)Used to hide components or their values in the presentation|(% style="width:250px" %)((( 967 +Either: 968 + 969 +* a Dataflow or DSD, or; 970 +* an Item in an Item Scheme 971 +)))|(% style="width:288px" %) |(% style="width:1427px" %)((( 972 +Attached to Item in Item Scheme: <blank> 973 + 974 +Attached to Dataflow or DSD: 975 + 976 +<concept Id>,<concept Id>,… 977 + 978 +Example : 979 + 980 +DD_DIM (to hide drilldown control concept) 981 +)))| 982 +|(% style="width:199px" %)LAYOUT_ROW|(% style="width:350px" %)Dimensions to be presented in rows (concepts on y-axis)|(% style="width:250px" %)((( 983 +Either: 984 + 985 +* an artefact, or; 986 +* a Dimension 987 +)))|(% style="width:288px" %) |(% style="width:1427px" %)((( 988 +Attached to Dimension: <blank> 989 + 990 +Attached to Dataflow or DSD: <dimension Id>,<dimension Id >,… 991 + 992 +//Example~:// 993 + 994 +REF_AREA,MEASURE 995 +)))| 996 +|(% style="width:199px" %)LAYOUT_COLUMN|(% style="width:350px" %)Dimensions to be presented in columns (concepts on x-axis)|(% style="width:250px" %)((( 997 +Either: 998 + 999 +* an artefact, or; 1000 +* a Dimension 1001 +)))|(% style="width:288px" %) |(% style="width:1427px" %)((( 1002 +Attached to Dimension: <blank> 1003 + 1004 +Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,… 1005 + 1006 +//Example~:// 1007 + 1008 +TIME_PERIOD 1009 +)))| 1010 +|(% 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" %)((( 1011 +<concept Id>,<concept Id>,... 1012 + 1013 +//Example~:// 1014 + 1015 +OBS_STATUS,CONF_STATUS 1016 +)))| 1017 +|(% 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" %)((( 1018 +<concept Id>,<concept Id>,... 1019 + 1020 +//Example~:// 1021 + 1022 +OBS_STATUS,CONF_STATUS 1023 +)))| 1024 +|(% style="width:199px" %)((( 1025 +METADATA 1026 + 1027 + 1028 +)))|(% 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)| 1029 +|(% 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" %)((( 1030 +Either: 1031 + 1032 +* an artefact, or; 1033 + 1034 +a Dimension 1035 +)))|(% style="width:288px" %) |(% style="width:1427px" %)((( 1036 +Attached to Dimension: <blank> 1037 + 1038 +Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,… 1039 + 1040 +//Example~:// 1041 + 1042 +SEX 1043 +)))| 1044 +|(% style="width:199px" %)EXT_RESOURCE|(% style="width:350px" %)((( 1045 +A localised link to an external resource associated to the annotated artefact. For example, an ontology item 1046 + 1047 +//a methodology// en:<a href:"[[https:~~/~~/ec.europa.eu/eurostat/web/waste/methodology>>url:https://ec.europa.eu/eurostat/web/waste/methodology]]"> 1048 +)))|(% style="width:250px" %)Any SDMX object|(% style="width:288px" %)((( 1049 +For localised content in SDMX 2.1 1050 + 1051 + <language>:<HTML containing URL to the resource>, 1052 + 1053 +<language>:<HTML containing URL to the resource>,… 1054 + 1055 +//Example~:// 1056 + 1057 +en:<a href=”[[http:~~/~~/rdf-vocabulary.ddialliance.org/xkos#depth>>url:http://rdf-vocabulary.ddialliance.org/xkos#depth]]”> 1058 +)))|(% style="width:1427px" %) |((( 1059 +See section URL value defaults and specific locale values. 1060 + 1061 +//Example~:// 1062 + 1063 +http:~/~/rdf-vocabulary.ddialliance.org/xkos#depth 1064 +))) 1065 +|(% style="width:199px" %)COMBINED_CONCEPTS|(% style="width:350px" %)((( 1066 +Comma-separated list of concept IDs to show as a concatenated label. 1067 + 1068 +The listed concepts’ item contents may be concatenated to generate the target concept. 1069 + 1070 +Multiple target concept combinations can be defined by separating the target concepts by ; 1071 +)))|(% style="width:250px" %)Dataflow or DSD|(% style="width:288px" %)((( 1072 +<language>:<display name>, 1073 + 1074 +<language>:<display name> 1075 + 1076 +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} 1077 +)))|(% style="width:1427px" %) | 1078 +|(% style="width:199px" %)(deprecated) UNIT_MEASURE_CONCEPTS|(% style="width:350px" %)((( 1079 +Comma-separated list of concept IDs that is used to define the full unit of measure. The concepts must be in the DSD. 1080 + 1081 +The listed concepts’ item contents may be concatenated to generate the unit of measure label (unless the UNIT_MEASURE_LABEL annotation is present). 1082 +)))|(% style="width:250px" %)Dataflow or DSD|(% style="width:288px" %) |(% style="width:1427px" %)((( 1083 +<concept Id>,<concept Id>,… 1084 + 1085 +//Example~:// UNIT_MEASURE,UNIT_MULT,TRANSFORMATION [could generate a value of Australian Dollar, Thousands, Non-transformed] 1086 +)))| 1087 +|(% style="width:199px" %)(deprecated) UNIT_MEASURE_LABEL|(% style="width:350px" %)((( 1088 +Indicates the concept that enumerates the full unit of measure labels. 1089 + 1090 +The concept must be in the DSD. UNIT_MEASURE_LABEL overrides the UNIT_MEASURE_CONCEPTS if both are provided. 1091 + 1092 +Also can be attached to items in item scheme, e.g. 1093 + 1094 +Text en:Gram 1095 + fr: Gramme 1096 +url:** **[[**http:~~/~~/data.europa.eu/gzn/su/G**>>url:http://data.europa.eu/gzn/su/G]] 1097 +)))|(% style="width:250px" %)Dataflow or DSD, Item in an Item Scheme|(% style="width:288px" %)((( 1098 +This is optional, used if a freetext label is required. 1099 + 1100 +<language>:<content>, 1101 + 1102 +<language>:<content>,… 1103 + 1104 +//Example~:// 1105 + 1106 +en:USD, thousands 1107 + 1108 +fr:USD, milliers 1109 +)))|(% style="width:1427px" %)((( 1110 +This is optional, used if an enumerated list is required. 1111 + 1112 +<concept Id> 1113 + 1114 +//Example~:// 1115 + 1116 +UOM_ATTRIBUTE [This concept may contain the following items as units of measure: 1117 + 1118 +* National Currency, thousands 1119 +* USD, thousands 1120 + 1121 +Index, based on National Currency] 1122 +)))| 1123 +|(% style="width:199px" %)((( 1124 +LAYOUT_TIME_PERIOD_DESC 1125 + 1126 + 1127 +)))|(% 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" %)((( 1128 +//Example~:// 1129 + 1130 +LAYOUT_TIME_PERIOD_DESC 1131 +)))| 1132 +|(% style="width:199px" %)((( 1133 +LAYOUT_CELL_ALIGN 1134 + 1135 + 1136 +)))|(% 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" %)((( 1137 +<language>:<content>, 1138 + 1139 +<language>:<content>,… 1140 + 1141 + 1142 +<content> values:RIGHT or LEFT 1143 +)))|(% style="width:1427px" %)Content values:RIGHT or LEFT| 1144 +|(% style="width:199px" %)((( 1145 +MAX_TABLE_DATA 1146 + 1147 + 1148 +)))|(% 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" %)((( 1149 +<integer> 1150 + 1151 +//Example~:// 1152 + 1153 +15000 1154 +)))| 1155 +|(% style="width:199px" %)((( 1156 +MAXTEXTATTRIBUTELENGTH 1157 + 1158 + 1159 +)))|(% style="width:350px" %)Increase the maximum length for textual attribute values|(% style="width:250px" %)DSD|(% style="width:288px" %) |(% style="width:1427px" %)((( 1160 +<integer> 1161 + 1162 +//Example~:// 1163 + 1164 +500 1165 +)))| 1166 +|(% 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" %)((( 1167 +<language>:<integer>,... 1168 + 1169 +//Example~:// 1170 + 1171 +"en":"3","es":"4","fr":"5" 1172 +)))|(% style="width:1427px" %)((( 1173 +<integer> 1174 + 1175 +//Example~:// 1176 + 1177 +10 1178 +)))| 1179 + 776 776 = Concept Scheme SDMX:CS_ANNOT = 777 777 778 778 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. 779 779 780 -|**Property**|**Representation in Concept**|**Description** 781 -|**Code**|Concept Id|The Annotation Type column, e.g. NOT_DISPLAYED, EXCLUDES 782 -|**Name**|Concept Name|Short description of the standard Annotation derived from the “Use case” column 783 -|**Representation**|Concept Core Representation|Allowable type or format for the Annotation 784 -|**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 785 -|**Artefact(s)**|Annotation Type: Artefact(s)|The information in the “Where to attach” column 786 -|**URL**|Annotation Type: URL|The Annotation URL column. The value is in URL 1184 +|**Property**|(% style="width:309px" %)**Representation in Concept**|(% style="width:1173px" %)**Description** 1185 +|**Code**|(% style="width:309px" %)Concept Id|(% style="width:1173px" %)The Annotation Type column, e.g. NOT_DISPLAYED, EXCLUDES 1186 +|**Name**|(% style="width:309px" %)Concept Name|(% style="width:1173px" %)Short description of the standard Annotation derived from the “Use case” column 1187 +|**Representation**|(% style="width:309px" %)Concept Core Representation|(% style="width:1173px" %)Allowable type or format for the Annotation 1188 +|**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 1189 +|**Artefact(s)**|(% style="width:309px" %)Annotation Type: Artefact(s)|(% style="width:1173px" %)The information in the “Where to attach” column 1190 +|**URL**|(% style="width:309px" %)Annotation Type: URL|(% style="width:1173px" %)The Annotation URL column. The value is in URL 787 787 788 788 == Example of a Concept == 789 789 ... ... @@ -793,8 +793,6 @@ 793 793 |**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 794 794 |**Concept: Annotation: Type: Artefact(s)**|Either a Dataflow or DSD, or an item in an item scheme 795 795 796 -=== === 797 - 798 798 === SDMX-ML of the Example === 799 799 800 800 <str:Concept id="NOT_DISPLAYED"> ... ... @@ -822,8 +822,4 @@ 822 822 823 823 ---- 824 824 825 -[[~[1~]>>path:#_ftnref1]] The technical standard does not enumerate the annotation types, however this guideline provides a recommended enumeration or controlled vocabulary 826 - 827 -[[~[2~]>>path:#_ftnref2]] International Standard Industrial Classification of All Economic Activities 828 - 829 -[[~[3~]>>path:#_ftnref3]] Central Product Classification 1227 +{{putFootnotes/}}