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,157 +124,117 @@ 124 124 125 125 == General and Display-related Annotation types == 126 126 127 -|Annotation Type|Use Case|Where to attach|((( 128 -+Text 129 - 130 -Blue is optional 131 -)))|((( 132 -Title 133 - 134 -Blue is optional 135 -)))|((( 136 -SDMX 2.1:URL 137 - 127 +|**Annotation Type**|(% style="width:524px" %)**Use Case**|(% style="width:198px" %)**Where to attach**|(% style="width:237px" %)((( 128 +**+Text 129 +(% style="background-color:transparent" %)Blue is optional(%%)** 130 +)))|(% style="width:320px" %)((( 131 +**Title 132 +(% style="background-color:transparent" %)Blue is optional(%%)** 133 +)))|(% style="width:203px" %)((( 134 +**SDMX 2.1:URL 138 138 SDMX >=3.0:+URL 139 - 140 -Blue is optional 136 +(% style="background-color:transparent" %)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|((( 144 -<language>:<content>, 145 - 146 -<language>:<content>,… 147 - 138 +|FULL_NAME|(% style="width:524px" %)Alternative name to be displayed for items in Item Schemes (e.g. Codelists, Concept Schemes, Category Schemes) whenever the item is displayed without its parent. For example, if a code list that has a hierarchy is displayed as a flat list, then this annotation may be used to provide sufficient context for the code. Concatenation of code + heading in NACE Rev.2.1 139 +en: A0123 Growing of citrus fruits|(% style="width:198px" %)Item in an Item Scheme|(% style="width:237px" %)((( 140 +<language>:<content>,<language>:<content>,… 148 148 //Example~:// 149 - 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| |((( 142 +(% style="background-color:transparent" %)en:Labour force (Employment) 143 +)))|(% style="width:320px" %)<content>|(% style="width:203px" %) 144 +|REPLACE_NAME|(% style="width:524px" %)Replace each code name in a component by the value of another component in an observation or series|(% style="width:198px" %)A Dataflow or DSD|(% style="width:237px" %) |(% style="width:320px" %)((( 153 153 <component Id to replace name>:<component Id to use name> 154 - 155 155 //Example~:// 156 - 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| |((( 147 +(% style="background-color:transparent" %)CUST_BREAKDOWN:CUST_BREAKDOWN_LB 148 +)))|(% style="width:203px" %) 149 +|REPLACE_CONTENT|(% style="width:524px" %)Replace the content in a component by the value of another component in an observation or series|(% style="width:198px" %)A Dataflow or DSD|(% style="width:237px" %) |(% style="width:320px" %)((( 160 160 <component Id to replace content>:<component Id to use content> 161 - 162 162 //Example~:// 163 - 164 -REF_AREA:M49_CODE 165 -)))| 166 -|COMPLEMENT|((( 152 +(% style="background-color:transparent" %)REF_AREA:M49_CODE 153 +)))|(% style="width:203px" %) 154 +|COMPLEMENT|(% style="width:524px" %)((( 167 167 Additional fixed text to be displayed in parenthesis after the code name. 156 +(% style="background-color:transparent" %)E.g. Representation of Non-hazardous (NHAZW), hazardous waste (HAZW) in the European List of Wastes(%%) 157 +(% style="background-color:transparent" %)en: 01 03 04* acid-generating tailings from processing of sulphide ore (HAZW)(%%) 158 +(% style="background-color:transparent" %)en: 01 03 99 wastes not otherwise specified (NHAZW) 159 +)))|(% style="width:198px" %)Item in an Item Scheme|(% style="width:237px" %)((( 160 +<language>:<content>,<language>:<content>,… 168 168 169 -E.g. Representation of Non-hazardous (NHAZW), hazardous waste (HAZW) in the European List of Wastes 170 -en: 01 03 04* acid-generating tailings from processing of sulphide ore (HAZW) 171 -en: 01 03 99 wastes not otherwise specified (NHAZW) 172 -)))|Item in an Item Scheme|((( 173 -<language>:<content>, 174 - 175 -<language>:<content>,… 176 - 177 177 //Example~:// 178 - 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.)|((( 163 +(% style="background-color:transparent" %)en:See reference metadata 164 +)))|(% style="width:320px" %)<content>|(% style="width:203px" %) 165 +|ORDER|(% style="width:524px" %)Explicit indication of a localised order of items in Items Schemes or artefacts (e.g. Codelist, Concept Scheme, Category Scheme, Dataflow, etc.)|(% style="width:198px" %)((( 182 182 Either: 183 183 184 184 * an artefact, or; 185 185 * an item in an Item Scheme 186 -)))|((( 187 -<language>:<content>, 170 +)))|(% style="width:237px" %)((( 171 +<language>:<content>,<language>:<content>,… 188 188 189 -<language>:<content>,… 190 - 191 191 //Example~:// 192 - 193 -en:10,es:20 194 -)))|((( 195 -<content> 196 - 197 - 198 -)))| 199 -|TOTAL|((( 174 +(% style="background-color:transparent" %)en:10,es:20 175 +)))|(% style="width:320px" %)<content>|(% style="width:203px" %) 176 +|TOTAL|(% style="width:524px" %)((( 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 -)))|((( 180 +* to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total 181 +)))|(% style="width:198px" %)((( 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 -)))|((( 211 -<language>:<explanatory text>, 212 - 213 -<language>:<explanatory text>,… 214 -)))|((( 186 +)))|(% style="width:237px" %)((( 187 +<language>:<explanatory text>, 188 +(% style="background-color:transparent" %)<language>:<explanatory text>,… 189 +)))|(% style="width:320px" %)((( 215 215 Attached to Code Item: <blank> 216 - 217 -Attached to Codelist: <code>,<code>,… 218 -)))| 219 -|DRILLDOWN|Denotes the concept that specifies whether observations are at the aggregate level or a drilldown.|((( 191 +(% style="background-color:transparent" %)Attached to Codelist: <code>,<code>,… 192 +)))|(% style="width:203px" %) 193 +|DRILLDOWN|(% style="width:524px" %)Denotes the concept that specifies whether observations are at the aggregate level or a drilldown.|(% style="width:198px" %)((( 220 220 Either: 221 221 222 222 * A Dataflow or DSD 223 -)))| |((( 197 +)))|(% style="width:237px" %) |(% style="width:320px" %)((( 224 224 <concept Id> 225 - 226 226 //Example~:// 227 - 228 -DD_DIM (this concept should be hidden using the NOT_DISPLAYED Annotation below) 229 -)))| 230 -|DEPRECATED|((( 200 +(% style="background-color:transparent" %)DD_DIM (this concept should be hidden using the NOT_DISPLAYED Annotation below) 201 +)))|(% style="width:203px" %) 202 +|DEPRECATED|(% style="width:524px" %)((( 231 231 Indication that an Item in an Item Scheme or an artefact is deprecated. 232 - 233 233 For an item scheme item, the annotation value provides a replacement name for the code name. 234 - 235 235 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. 236 - 237 237 Suggestion to use a controlled vocabulary 238 - 239 239 url: <[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/CURRENT>>url:http://publications.europa.eu/resource/authority/concept-status/CURRENT]]> 240 240 url: <[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/DEPRECATED>>url:http://publications.europa.eu/resource/authority/concept-status/DEPRECATED]]> 241 - 242 -or 243 - 244 -TITLE: true (false) 245 -)))|((( 209 +or 210 +(% style="background-color:transparent" %)TITLE: true (false) 211 +)))|(% style="width:198px" %)((( 246 246 Either: 247 247 248 248 * an artefact, or; 249 249 * an item in an Item Scheme 250 -)))|((( 216 +)))|(% style="width:237px" %)((( 251 251 For item scheme item: 252 252 253 -<language>:<content>, 219 +<language>:<content>,<language>:<content>,… 254 254 255 -<language>:<content>,… 256 - 257 257 //Example~:// 258 - 259 -en:deprecated,fr:obsolète 260 -)))|<content>|((( 222 +(% style="background-color:transparent" %)en:deprecated,fr:obsolète 223 +)))|(% style="width:320px" %)<content>|(% style="width:203px" %)((( 261 261 For artefact: 262 - 263 263 <see section URL value defaults and specific locale values> 264 - 265 - 266 266 ))) 267 -|DEFAULT|((( 227 +|DEFAULT|(% style="width:524px" %)((( 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 -)))|((( 231 +)))|(% style="width:198px" %)((( 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 -)))| |((( 237 +)))|(% style="width:237px" %) |(% style="width:320px" %)((( 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|((( 244 +)))|(% style="width:203px" %) 245 +|IMAGE|(% style="width:524px" %)A visual identity to associate to Item Scheme Items or artefacts|(% style="width:198px" %)((( 286 286 Either: 287 287 288 288 * an artefact, or; 289 289 * an item in an item scheme 290 -)))|((( 250 +)))|(% style="width:237px" %)((( 291 291 For localised content in SDMX 2.1 292 292 293 293 <language>:<HTML containing URL to the resource>, ... ... @@ -297,28 +297,26 @@ 297 297 //Example~:// 298 298 299 299 en:<a href=”https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg”> 300 -)))| |((( 260 +)))|(% style="width:320px" %) |(% style="width:203px" %)((( 301 301 See section URL value defaults and specific locale values. 302 302 303 303 //Example~:// 304 304 305 305 https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg 306 - 307 - 308 308 ))) 309 -|DRILLDOWN_CONCEPTS|Concepts to be displayed in a drilldown operation|Dataflow or DSD| |((( 267 +|DRILLDOWN_CONCEPTS|(% style="width:524px" %)Concepts to be displayed in a drilldown operation|(% style="width:198px" %)Dataflow or DSD|(% style="width:237px" %) |(% style="width:320px" %)((( 310 310 <concept Id>,<concept Id>,… 311 311 312 312 Example : 313 313 314 -DONOR,RECIPIENT,YEAR,PROJECT_ID,OBS_VALUE,DESCRIPTION,OWNER 315 -)))| 316 -|NOT_DISPLAYED|Used to hide components or their values in the presentation|((( 272 +DONOR,RECIPIENT,YEAR,PROJECT_ID, OBS_VALUE,DESCRIPTION,OWNER 273 +)))|(% style="width:203px" %) 274 +|NOT_DISPLAYED|(% style="width:524px" %)Used to hide components or their values in the presentation|(% style="width:198px" %)((( 317 317 Either: 318 318 319 319 * a Dataflow or DSD, or; 320 320 * an Item in an Item Scheme 321 -)))| |((( 279 +)))|(% style="width:237px" %) |(% style="width:320px" %)((( 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)|((( 289 +)))|(% style="width:203px" %) 290 +|LAYOUT_ROW|(% style="width:524px" %)Dimensions to be presented in rows (concepts on y-axis)|(% style="width:198px" %)((( 333 333 Either: 334 334 335 335 * an artefact, or; 336 336 * a Dimension 337 -)))| |((( 295 +)))|(% style="width:237px" %) |(% style="width:320px" %)((( 338 338 Attached to Dimension: <blank> 339 339 340 340 Attached to Dataflow or DSD: <dimension Id>,<dimension Id >,… ... ... @@ -342,13 +342,14 @@ 342 342 //Example~:// 343 343 344 344 REF_AREA,MEASURE 345 -)))| 346 -|LAYOUT_COLUMN|Dimensions to be presented in columns (concepts on x-axis)|((( 303 +)))|(% style="width:203px" %) 304 +|LAYOUT_COLUMN|(% style="width:524px" %)Dimensions to be presented in columns (concepts on x-axis)|(% style="width:198px" %)((( 347 347 Either: 348 348 349 349 * an artefact, or; 350 -* a Dimension 351 -)))| |((( 308 + 309 +a Dimension 310 +)))|(% style="width:237px" %) |(% style="width:320px" %)((( 352 352 Attached to Dimension: <blank> 353 353 354 354 Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,… ... ... @@ -356,33 +356,30 @@ 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| |((( 318 +)))|(% style="width:203px" %) 319 +|LAYOUT_FLAG|(% style="width:524px" %)Indication that an attribute and its attribute value should be presented as a flag|(% style="width:198px" %)Dataflow|(% style="width:237px" %) |(% style="width:320px" %)((( 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| |((( 325 +)))|(% style="width:203px" %) 326 +|LAYOUT_NOTE|(% style="width:524px" %)Indication that an attribute and its attribute value should be presented as a note|(% style="width:198px" %)Dataflow|(% style="width:237px" %) |(% style="width:320px" %)((( 368 368 <concept Id>,<concept Id>,... 369 369 370 370 //Example~:// 371 371 372 372 OBS_STATUS,CONF_STATUS 373 -)))| 332 +)))|(% style="width:203px" %) 374 374 |((( 375 375 METADATA 376 - 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.|((( 335 +)))|(% style="width:524px" %)Links an MSD directly to a DSD. Can be used to overcome the complexities of reference metadata linkage|(% style="width:198px" %)DSD|(% style="width:237px" %) |(% style="width:320px" %)MSD URI, e.g. urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataStructure =OECD:MSD_REF_METADATA(1.0)|(% style="width:203px" %) 336 +|LAYOUT_ROW_SECTION|(% style="width:524px" %)Dimension to be presented as a break-down concept at a third hierarchical level above columns and rows.|(% style="width:198px" %)((( 380 380 Either: 381 381 382 382 * an artefact, or; 383 - 384 -a Dimension 385 -)))| |((( 340 +* a Dimension 341 +)))|(% style="width:237px" %) |(% style="width:320px" %)((( 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|((( 349 +)))|(% style="width:203px" %) 350 +|EXT_RESOURCE|(% style="width:524px" %)((( 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|((( 354 +)))|(% style="width:198px" %)Any SDMX object|(% style="width:237px" %)((( 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 -)))| |((( 364 +)))|(% style="width:320px" %) |(% style="width:203px" %)((( 409 409 See section URL value defaults and specific locale values. 410 410 411 411 //Example~:// ... ... @@ -412,378 +412,40 @@ 412 412 413 413 http:~/~/rdf-vocabulary.ddialliance.org/xkos#depth 414 414 ))) 415 -|COMBINED_CONCEPTS|((( 371 +|COMBINED_CONCEPTS|(% style="width:524px" %)((( 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|((( 377 +)))|(% style="width:198px" %)Dataflow or DSD|(% style="width:237px" %)((( 422 422 <language>:<display name>, 423 - 424 424 <language>:<display name> 425 - 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|((( 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 - 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| |((( 433 -<concept Id>,<concept Id>,… 434 - 435 -//Example~:// UNIT_MEASURE,UNIT_MULT,TRANSFORMATION [could generate a value of Australian Dollar, Thousands, Non-transformed] 436 -)))| 437 -|(deprecated) UNIT_MEASURE_LABEL|((( 438 -Indicates the concept that enumerates the full unit of measure labels. 439 - 440 -The concept must be in the DSD. UNIT_MEASURE_LABEL overrides the UNIT_MEASURE_CONCEPTS if both are provided. 441 - 442 -Also can be attached to items in item scheme, e.g. 443 - 444 -Text en:Gram 445 - fr: Gramme 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|((( 448 -This is optional, used if a freetext label is required. 449 - 450 -<language>:<content>, 451 - 452 -<language>:<content>,… 453 - 454 -//Example~:// 455 - 456 -en:USD, thousands 457 - 458 -fr:USD, milliers 459 -)))|((( 460 -This is optional, used if an enumerated list is required. 461 - 462 -<concept Id> 463 - 464 -//Example~:// 465 - 466 -UOM_ATTRIBUTE [This concept may contain the following items as units of measure: 467 - 468 -* National Currency, thousands 469 -* USD, thousands 470 - 471 -Index, based on National Currency] 472 -)))| 473 -|((( 474 -LAYOUT_TIME_PERIOD_DESC 475 - 380 +(% style="background-color:transparent" %)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} 381 +)))|(% style="width:320px" %) |(% style="width:203px" %) 382 +| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 383 +| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 384 +| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 385 +| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 386 +| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 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| |((( 478 -//Example~:// 479 479 480 -LAYOUT_TIME_PERIOD_DESC 481 -)))| 482 -|((( 483 -LAYOUT_CELL_ALIGN 484 - 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|((( 487 -<language>:<content>, 488 - 489 -<language>:<content>,… 490 - 491 - 492 -<content> values:RIGHT or LEFT 493 -)))|Content values:RIGHT or LEFT| 494 -|((( 495 -MAX_TABLE_DATA 496 - 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| |((( 499 -<integer> 500 - 501 -//Example~:// 502 - 503 -15000 504 -)))| 505 -|((( 506 -MAXTEXTATTRIBUTELENGTH 507 - 508 - 509 -)))|Increase the maximum length for textual attribute values|DSD| |((( 510 -<integer> 511 - 512 -//Example~:// 513 - 514 -500 515 -)))| 516 -|SEARCH_WEIGHT|Indication of localised boosted dataflows in the search results when ordered by relevance|Dataflow|((( 517 -<language>:<integer>,... 518 - 519 -//Example~:// 520 - 521 -"en":"3","es":"4","fr":"5" 522 -)))|((( 523 -<integer> 524 - 525 -//Example~:// 526 - 527 -10 528 -)))| 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]].391 +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|((( 535 -+Text 536 536 537 -Blue is optional 538 -)))|((( 539 -Title 540 - 541 -Blue is optional 542 -)))|((( 543 -SDMX 2.1:URL 544 - 545 -SDMX >=3.0:+URL 546 - 547 -Blue is optional 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| |((( 550 -<original code> 551 - 552 -//Examples~:// 553 - 554 -* 0105.13 [Harmonized System] 555 -* 11.2.0.9 [COICOP classification] 556 -)))| 557 -|HIER_CONTEXT|((( 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 -In SDMX 3.0, use the HierarchyAssociation artefact 561 -)))|DSD or Dataflow| |((( 562 -<component Id>:<HCL Id>.<hierarchy Id> 563 - 564 -//Example~:// 565 - 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|((( 569 -Explicit specification of the hierarchical level of a code item 570 - 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 - 573 -text en:sections 574 -)))|Code item| |((( 575 -<hierarchical level> 576 - 577 -//Example~:// 578 - 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 -)))|((( 586 -//Example~:// 587 - 588 -[Official French label “Transformation et conservation de la viande de boucherie” is shortened to] fr:Transf. & conserv. viande de boucherie 589 - 590 - 591 -In Codelist=IMF:CL_AREA(1.13) 592 -Code 4J837 European Union Intellectual Property Office has a Short_Label 593 - 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 -)))|((( 601 -//Example~:// 602 - 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|((( 606 -<language>:<content>, 607 - 608 -<language>:<content>,… 609 -)))|((( 610 -Example (from the US NAICS classification): 611 - 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|((( 615 -<language>:<content>, 616 - 617 -<language>:<content>,… 618 -)))|((( 619 -Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition): 620 - 621 -en: This class includes: 622 - 623 -* manufacture of heavy weapons (artillery, mobile guns, rocket launchers, torpedo tubes, heavy machine guns) 624 -* manufacture of small arms (revolvers, shotguns, light machine guns) 625 -* manufacture of air or gas guns and pistols 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|((( 629 -<language>:<content>, 630 - 631 -<language>:<content>,… 632 - 633 -Example (from NACE Rev. 2 caselaw to code 01.62): 634 - 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|((( 638 -<language>:<content>, 639 - 640 -<language>:<content>,… 641 -)))|((( 642 -Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition): 643 - 644 -en:This class also includes: 645 - 646 -* manufacture of hunting, sporting or protective firearms and ammunition 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|((( 650 -Item in an Item Scheme 651 - 652 - 653 -)))|((( 654 -<language>:<content>, 655 - 656 -<language>:<content>,… 657 -)))|((( 658 -Example (from ISIC Rev. 4 explanatory notes to code 2520 - Manufacture of weapons and ammunition): 659 - 660 -en:This class excludes: 661 - 662 -* manufacture of percussion caps, detonators or signalling flares, see 2029 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|((( 666 -See section URL value defaults and specific locale values. 667 - 668 - 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| |((( 671 -<content> 672 - 673 -//Example~:// 674 - 675 -A1+A2 676 -)))| 677 -|FOLLOWS|((( 678 -A reference used to express the succession in time of Item Schemes. 679 - 680 -For example, NACE Rev. 2 is the successor of NACE Rev. 1.1 681 - 682 -Reference to external standard: skos:ConceptScheme - property: xkos:follows 683 -)))|Codelist or Item Scheme| | |((( 684 -See section URL value defaults and specific locale values. 685 - 686 -//Example~:// 687 - 688 -(CL_REGIONAL 3.1.1 follows CL_REGIONAL 3.1): 689 - 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 -))) 692 -|HAS_VARIANT|((( 693 -A reference used to express the relation between an Item Scheme and its variant(s). 694 - 695 -Reference to external standard: skos:ConceptScheme - property: xkos:variant 696 - 697 - 698 -For //Example~:// CL_AREA has a variant CL_GEO 699 -)))|Codelist or Item Scheme| | |((( 700 -See section URL value defaults and specific locale values. 701 - 702 - 703 -))) 704 -|SUPERSEED|((( 705 -A reference to a previous version, if the current version obsoleted the previous one. 706 - 707 -May be used in conjunction with DEPRECATED. 708 - 709 -Reference to external standard: skos:ConceptScheme - property: xkos:supersedes 710 -)))|Codelist or Item Scheme, or an artefact| | |((( 711 -See section URL value defaults and specific locale values. 712 - 713 - 714 -))) 715 -|FAMILY_LABEL|((( 716 -Label of the Classification Family (e.g. NACE, ISIC) 717 - 718 -Reference to external standard: skos:ConceptScheme - property: xkos:belongsTo 719 - 720 -label of the classification 721 -)))|Codelist or Item Scheme|((( 722 -<language>:<content>, 723 - 724 -<language>:<content>,… 725 - 726 -//Example~:// 727 - 728 -en:NACE 729 -)))| |((( 730 -See section URL value defaults and specific locale values. 731 - 732 - 733 -))) 734 -|COVERAGE_LABEL|((( 735 -Label(s) of the item scheme’s coverage (e.g. National Accounts, Products, Activities, Occupations) 736 - 737 -Reference to external standard: skos:ConceptScheme - property: xkos:covers 738 - 739 -//Examples~:// 740 - 741 -URL <http:~/~/eurovoc.europa.eu/56> (National accounts) 742 - 743 -URL <http:~/~/publications.europa.eu/resource/authority/data-theme/REGI> (Regions and Cities) 744 -)))|Codelist or Item Scheme|((( 745 -<language>:<content>, 746 - 747 -<language>:<content>,… 748 - 749 -//Example~:// 750 - 751 -En:national accounts 752 -)))| |((( 753 -See section URL value defaults and specific locale values. 754 - 755 - 756 -))) 757 -|GEO_FEATURE_SET|((( 758 -In Codelists, transmits GeoFeature values. 759 - 760 -Example for NUTS ID BE23 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|((( 765 -Indicates that the Legislation on which the codelist/nomenclature is based. 766 - 767 -Example for NACE Rev.2.1 768 - 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 771 - 772 - 773 - 774 - 775 - 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 398 +|**Property**|(% style="width:309px" %)**Representation in Concept**|(% style="width:1173px" %)**Description** 399 +|**Code**|(% style="width:309px" %)Concept Id|(% style="width:1173px" %)The Annotation Type column, e.g. NOT_DISPLAYED, EXCLUDES 400 +|**Name**|(% style="width:309px" %)Concept Name|(% style="width:1173px" %)Short description of the standard Annotation derived from the “Use case” column 401 +|**Representation**|(% style="width:309px" %)Concept Core Representation|(% style="width:1173px" %)Allowable type or format for the Annotation 402 +|**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 403 +|**Artefact(s)**|(% style="width:309px" %)Annotation Type: Artefact(s)|(% style="width:1173px" %)The information in the “Where to attach” column 404 +|**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 441 +{{putFootnotes/}}