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 {{footnote}}The technical standard does not enumerate the annotation types, however this guideline providesarecommended 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.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. 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,20 +124,23 @@ 124 124 125 125 == General and Display-related Annotation types == 126 126 127 -| (% style="width:152px" %)Annotation Type|(% style="width:559px" %)Use Case|Where to attach|(((127 +|Annotation Type|Use Case|Where to attach|((( 128 128 +Text 129 129 130 130 Blue is optional 131 131 )))|((( 132 132 Title 133 + 133 133 Blue is optional 134 134 )))|((( 135 135 SDMX 2.1:URL 137 + 136 136 SDMX >=3.0:+URL 139 + 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" %)(((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|((( 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" %)(((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| |((( 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" %)(((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| |((( 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" %)(((165 +)))| 166 +|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" %)(((172 +)))|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" %)(((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.)|((( 179 179 Either: 180 180 181 181 * an artefact, or; 182 182 * an item in an Item Scheme 183 -)))|( % style="width:506px" %)(((186 +)))|((( 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" %)(((194 +)))|((( 192 192 <content> 193 193 194 194 195 -)))| (%style="width:866px" %)196 -| (% style="width:152px" %)TOTAL|(% style="width:559px" %)(((198 +)))| 199 +|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" %)((( 203 + 204 +to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total 205 +)))|((( 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" %)(((210 +)))|((( 207 207 <language>:<explanatory text>, 208 208 209 209 <language>:<explanatory text>,… 210 -)))|( % style="width:178px" %)(((214 +)))|((( 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" %)(((218 +)))| 219 +|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" %)(((223 +)))| |((( 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" %)(((229 +)))| 230 +|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" %)(((245 +)))|((( 242 242 Either: 243 243 244 244 * an artefact, or; 245 245 * an item in an Item Scheme 246 -)))|( % style="width:506px" %)(((250 +)))|((( 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" %)(((260 +)))|<content>|((( 257 257 For artefact: 258 258 259 259 <see section URL value defaults and specific locale values> ... ... @@ -260,17 +260,17 @@ 260 260 261 261 262 262 ))) 263 -| (% style="width:152px" %)DEFAULT|(% style="width:559px" %)(((267 +|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" %)(((271 +)))|((( 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" %)(((277 +)))| |((( 274 274 Attached to: 275 275 276 276 - DSD or Dataflow: ... ... @@ -277,13 +277,13 @@ 277 277 **<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" %)(((284 +)))| 285 +|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" %)(((290 +)))|((( 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" %)(((300 +)))| |((( 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" %)(((309 +|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" %)(((315 +)))| 316 +|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" %)(((321 +)))| |((( 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" %)(((331 +)))| 332 +|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" %)(((337 +)))| |((( 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" %)(((345 +)))| 346 +|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" %)(((351 +)))| |((( 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" %)(((359 +)))| 360 +|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" %)(((366 +)))| 367 +|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" %)(((373 +)))| 374 +|((( 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" %)(((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.|((( 376 376 Either: 377 377 378 378 * an artefact, or; 379 379 380 380 a Dimension 381 -)))| (%style="width:506px" %)|(% style="width:178px" %)(((385 +)))| |((( 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" %)(((393 +)))| 394 +|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" %)(((398 +)))|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" %)(((408 +)))| |((( 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" %)(((415 +|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" %)(((421 +)))|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" %)(((427 +)))| | 428 +|(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" %)(((432 +)))|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" %)(((436 +)))| 437 +|(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" %)(((447 +)))|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" %)(((459 +)))|((( 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" %)(((472 +)))| 473 +|((( 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" %)(((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| |((( 474 474 //Example~:// 475 475 476 476 LAYOUT_TIME_PERIOD_DESC 477 -)))| (%style="width:866px" %)478 -|( % style="width:152px" %)(((481 +)))| 482 +|((( 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" %)(((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|((( 483 483 <language>:<content>, 484 484 485 485 <language>:<content>,… ... ... @@ -486,54 +486,56 @@ 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" %)(((493 +)))|Content values:RIGHT or LEFT| 494 +|((( 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" %)(((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| |((( 495 495 <integer> 496 496 497 497 //Example~:// 498 498 499 499 15000 500 -)))| (%style="width:866px" %)501 -|( % style="width:152px" %)(((504 +)))| 505 +|((( 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" %)(((509 +)))|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" %)(((515 +)))| 516 +|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" %)(((522 +)))|((( 519 519 <integer> 520 520 521 521 //Example~:// 522 522 523 523 10 524 -)))| (%style="width:866px" %)528 +)))| 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}}.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]]. 529 529 530 -| (% style="width:170px" %)Annotation Type|(% style="width:451px" %)Use Case|(% style="width:203px" %)Where to attach|(% style="width:254px" %)(((534 +|Annotation Type|Use Case|Where to attach|((( 531 531 +Text 536 + 532 532 Blue is optional 533 -)))|( % style="width:556.217px" %)(((538 +)))|((( 534 534 Title 540 + 535 535 Blue is optional 536 -)))|( % style="width:460px" %)(((542 +)))|((( 537 537 SDMX 2.1:URL 538 538 539 539 SDMX >=3.0:+URL ... ... @@ -540,7 +540,7 @@ 540 540 541 541 Blue is optional 542 542 ))) 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" %)(((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| |((( 544 544 <original code> 545 545 546 546 //Examples~:// ... ... @@ -547,62 +547,69 @@ 547 547 548 548 * 0105.13 [Harmonized System] 549 549 * 11.2.0.9 [COICOP classification] 550 -)))| (%style="width:460px" %)551 -| (% style="width:170px" %)HIER_CONTEXT|(% style="width:451px" %)(((556 +)))| 557 +|HIER_CONTEXT|((( 552 552 In SDMX 2.1, a reference between a usage context and a hierarchy (that may be contained in a Hierarchical Codelist (HCL)). 559 + 553 553 In SDMX 3.0, use the HierarchyAssociation artefact 554 -)))| (% style="width:203px" %)DSD or Dataflow|(%style="width:254px" %)|(% style="width:556.217px" %)(((561 +)))|DSD or Dataflow| |((( 555 555 <component Id>:<HCL Id>.<hierarchy Id> 556 556 557 557 //Example~:// 558 558 559 559 REF_AREA:OECD.EDU:HCL_REF_AREA(1.0).REF_AREA provides the link to the reference area hierarchy for OECD education data 560 -)))| (%style="width:460px" %)561 -| (% style="width:170px" %)HIER_LEVEL|(% style="width:451px" %)(((567 +)))| 568 +|HIER_LEVEL|((( 562 562 Explicit specification of the hierarchical level of a code item 570 + 563 563 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]] 564 564 565 565 text en:sections 566 -)))| (% style="width:203px" %)Code item|(%style="width:254px" %)|(% style="width:556.217px" %)(((574 +)))|Code item| |((( 567 567 <hierarchical level> 568 568 569 569 //Example~:// 570 570 571 571 1 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" %)((( 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 +)))|((( 576 576 //Example~:// 577 577 578 578 [Official French label “Transformation et conservation de la viande de boucherie” is shortened to] fr:Transf. & conserv. viande de boucherie 579 579 590 + 580 580 In Codelist=IMF:CL_AREA(1.13) 581 581 Code 4J837 European Union Intellectual Property Office has a Short_Label 582 582 583 583 EN:EUIPO 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" %)((( 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 +)))|((( 588 588 //Example~:// 589 589 590 590 [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 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" %)(((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|((( 593 593 <language>:<content>, 594 594 595 595 <language>:<content>,… 596 -)))|( % style="width:556.217px" %)(((609 +)))|((( 597 597 Example (from the US NAICS classification): 598 598 599 599 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. 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" %)(((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|((( 602 602 <language>:<content>, 603 603 604 604 <language>:<content>,… 605 -)))|( % style="width:556.217px" %)(((618 +)))|((( 606 606 Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition): 607 607 608 608 en: This class includes: ... ... @@ -611,8 +611,8 @@ 611 611 * manufacture of small arms (revolvers, shotguns, light machine guns) 612 612 * manufacture of air or gas guns and pistols 613 613 * manufacture of war ammunition 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" %)(((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|((( 616 616 <language>:<content>, 617 617 618 618 <language>:<content>,… ... ... @@ -620,12 +620,12 @@ 620 620 Example (from NACE Rev. 2 caselaw to code 01.62): 621 621 622 622 en:Automated egg hatching for poultry - Operation of livestock management systems] 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" %)(((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|((( 625 625 <language>:<content>, 626 626 627 627 <language>:<content>,… 628 -)))|( % style="width:556.217px" %)(((641 +)))|((( 629 629 Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition): 630 630 631 631 en:This class also includes: ... ... @@ -632,16 +632,16 @@ 632 632 633 633 * manufacture of hunting, sporting or protective firearms and ammunition 634 634 * manufacture of explosive devices such as bombs, mines and torpedoes 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" %)(((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|((( 637 637 Item in an Item Scheme 638 638 639 639 640 -)))|( % style="width:254px" %)(((653 +)))|((( 641 641 <language>:<content>, 642 642 643 643 <language>:<content>,… 644 -)))|( % style="width:556.217px" %)(((657 +)))|((( 645 645 Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition): 646 646 647 647 en:This class excludes: ... ... @@ -648,24 +648,26 @@ 648 648 649 649 * manufacture of percussion caps, detonators or signalling flares, see 2029 650 650 * manufacture of cutlasses, swords, bayonets etc., see 2593 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" %)(((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|((( 653 653 See section URL value defaults and specific locale values. 654 654 655 655 656 656 ))) 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" %)(((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| |((( 658 658 <content> 659 659 660 660 //Example~:// 661 661 662 662 A1+A2 663 -)))| (%style="width:460px" %)664 -| (% style="width:170px" %)FOLLOWS|(% style="width:451px" %)(((676 +)))| 677 +|FOLLOWS|((( 665 665 A reference used to express the succession in time of Item Schemes. 679 + 666 666 For example, NACE Rev. 2 is the successor of NACE Rev. 1.1 681 + 667 667 Reference to external standard: skos:ConceptScheme - property: xkos:follows 668 -)))| (% style="width:203px" %)Codelist or Item Scheme|(%style="width:254px" %)|(%style="width:556.217px" %)|(% style="width:460px" %)(((683 +)))|Codelist or Item Scheme| | |((( 669 669 See section URL value defaults and specific locale values. 670 670 671 671 //Example~:// ... ... @@ -674,31 +674,36 @@ 674 674 675 675 [[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]] 676 676 ))) 677 -| (% style="width:170px" %)HAS_VARIANT|(% style="width:451px" %)(((692 +|HAS_VARIANT|((( 678 678 A reference used to express the relation between an Item Scheme and its variant(s). 694 + 679 679 Reference to external standard: skos:ConceptScheme - property: xkos:variant 696 + 697 + 680 680 For //Example~:// CL_AREA has a variant CL_GEO 681 -)))| (% style="width:203px" %)Codelist or Item Scheme|(%style="width:254px" %)|(%style="width:556.217px" %)|(% style="width:460px" %)(((699 +)))|Codelist or Item Scheme| | |((( 682 682 See section URL value defaults and specific locale values. 683 683 684 684 685 685 ))) 686 -| (% style="width:170px" %)SUPERSEED|(% style="width:451px" %)(((704 +|SUPERSEED|((( 687 687 A reference to a previous version, if the current version obsoleted the previous one. 706 + 688 688 May be used in conjunction with DEPRECATED. 708 + 689 689 Reference to external standard: skos:ConceptScheme - property: xkos:supersedes 690 -)))| (% style="width:203px" %)Codelist or Item Scheme, or an artefact|(%style="width:254px" %)|(%style="width:556.217px" %)|(% style="width:460px" %)(((710 +)))|Codelist or Item Scheme, or an artefact| | |((( 691 691 See section URL value defaults and specific locale values. 692 692 693 693 694 694 ))) 695 -| (% style="width:170px" %)FAMILY_LABEL|(% style="width:451px" %)(((715 +|FAMILY_LABEL|((( 696 696 Label of the Classification Family (e.g. NACE, ISIC) 697 697 698 -Reference to external standard: 699 - skos:ConceptScheme - property: xkos:belongsTo718 +Reference to external standard: skos:ConceptScheme - property: xkos:belongsTo 719 + 700 700 label of the classification 701 -)))| (% style="width:203px" %)Codelist or Item Scheme|(% style="width:254px" %)(((721 +)))|Codelist or Item Scheme|((( 702 702 <language>:<content>, 703 703 704 704 <language>:<content>,… ... ... @@ -706,12 +706,12 @@ 706 706 //Example~:// 707 707 708 708 en:NACE 709 -)))| (%style="width:556.217px" %)|(% style="width:460px" %)(((729 +)))| |((( 710 710 See section URL value defaults and specific locale values. 711 711 712 712 713 713 ))) 714 -| (% style="width:170px" %)COVERAGE_LABEL|(% style="width:451px" %)(((734 +|COVERAGE_LABEL|((( 715 715 Label(s) of the item scheme’s coverage (e.g. National Accounts, Products, Activities, Occupations) 716 716 717 717 Reference to external standard: skos:ConceptScheme - property: xkos:covers ... ... @@ -721,7 +721,7 @@ 721 721 URL <http:~/~/eurovoc.europa.eu/56> (National accounts) 722 722 723 723 URL <http:~/~/publications.europa.eu/resource/authority/data-theme/REGI> (Regions and Cities) 724 -)))| (% style="width:203px" %)Codelist or Item Scheme|(% style="width:254px" %)(((744 +)))|Codelist or Item Scheme|((( 725 725 <language>:<content>, 726 726 727 727 <language>:<content>,… ... ... @@ -729,465 +729,41 @@ 729 729 //Example~:// 730 730 731 731 En:national accounts 732 -)))| (%style="width:556.217px" %)|(% style="width:460px" %)(((752 +)))| |((( 733 733 See section URL value defaults and specific locale values. 734 734 735 735 736 736 ))) 737 -| (% style="width:170px" %)GEO_FEATURE_SET|(% style="width:451px" %)(((757 +|GEO_FEATURE_SET|((( 738 738 In Codelists, transmits GeoFeature values. 739 739 740 740 Example for NUTS ID BE23 741 741 url:[[http:~~/~~/data.europa.eu/nuts/geometry/2xr1qiv9>>url:http://data.europa.eu/nuts/geometry/2xr1qiv9]] 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" %)(((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|((( 745 745 Indicates that the Legislation on which the codelist/nomenclature is based. 746 746 747 747 Example for NACE Rev.2.1 748 748 749 749 url: [[http:~~/~~/data.europa.eu/eli/reg_del/2023/137/oj>>url: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/oj770 +)))|Codelist| | |http:~/~/data.europa.eu/eli/reg_del/2023/137/oj 751 751 752 752 753 753 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 -| | | | | | 784 784 785 785 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 - 1180 1180 = Concept Scheme SDMX:CS_ANNOT = 1181 1181 1182 1182 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. 1183 1183 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, EXCLUDES1186 -|**Name**| (% style="width:309px" %)Concept Name|(% style="width:1173px" %)Short description of the standard Annotation derived from the “Use case” column1187 -|**Representation**| (% style="width:309px" %)Concept Core Representation|(% style="width:1173px" %)Allowable type or format for the Annotation1188 -|**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 AnnotationTitle1189 -|**Artefact(s)**| (% style="width:309px" %)Annotation Type: Artefact(s)|(% style="width:1173px" %)The information in the “Where to attach” column1190 -|**URL**| (% style="width:309px" %)Annotation Type: URL|(% style="width:1173px" %)The Annotation URL column. The value is in URL780 +|**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 1191 1191 1192 1192 == Example of a Concept == 1193 1193 ... ... @@ -1197,6 +1197,8 @@ 1197 1197 |**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 1198 1198 |**Concept: Annotation: Type: Artefact(s)**|Either a Dataflow or DSD, or an item in an item scheme 1199 1199 796 +=== === 797 + 1200 1200 === SDMX-ML of the Example === 1201 1201 1202 1202 <str:Concept id="NOT_DISPLAYED"> ... ... @@ -1224,4 +1224,8 @@ 1224 1224 1225 1225 ---- 1226 1226 1227 -{{putFootnotes/}} 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