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,117 +124,157 @@ 124 124 125 125 == General and Display-related Annotation types == 126 126 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 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 + 135 135 SDMX >=3.0:+URL 136 -(% style="background-color:transparent" %)Blue is optional(%%)** 139 + 140 +Blue is optional 137 137 ))) 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>,… 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 + 141 141 //Example~:// 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" %)((( 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| |((( 145 145 <component Id to replace name>:<component Id to use name> 154 + 146 146 //Example~:// 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" %)((( 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| |((( 150 150 <component Id to replace content>:<component Id to use content> 161 + 151 151 //Example~:// 152 -(% style="background-color:transparent" %)REF_AREA:M49_CODE 153 -)))|(% style="width:203px" %) 154 -|COMPLEMENT|(% style="width:524px" %)((( 163 + 164 +REF_AREA:M49_CODE 165 +)))| 166 +|COMPLEMENT|((( 155 155 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>,… 161 161 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 + 162 162 //Example~:// 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" %)((( 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.)|((( 166 166 Either: 167 167 168 168 * an artefact, or; 169 169 * an item in an Item Scheme 170 -)))|( % style="width:237px" %)(((171 -<language>:<content>, <language>:<content>,…186 +)))|((( 187 +<language>:<content>, 172 172 189 +<language>:<content>,… 190 + 173 173 //Example~:// 174 -(% style="background-color:transparent" %)en:10,es:20 175 -)))|(% style="width:320px" %)<content>|(% style="width:203px" %) 176 -|TOTAL|(% style="width:524px" %)((( 192 + 193 +en:10,es:20 194 +)))|((( 195 +<content> 196 + 197 + 198 +)))| 199 +|TOTAL|((( 177 177 Code Item that represents a total value. If the attachment is: 178 178 179 179 * to a Code, the Annotation Text is optional and may contain an explanatory text; 180 -* to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total 181 -)))|(% style="width:198px" %)((( 203 + 204 +to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total 205 +)))|((( 182 182 Either: 183 183 184 184 * a Code Item that represents a total value, or; 185 185 * a Codelist to specify the code(s) with the total 186 -)))|(% style="width:237px" %)((( 187 -<language>:<explanatory text>, 188 -(% style="background-color:transparent" %)<language>:<explanatory text>,… 189 -)))|(% style="width:320px" %)((( 210 +)))|((( 211 +<language>:<explanatory text>, 212 + 213 +<language>:<explanatory text>,… 214 +)))|((( 190 190 Attached to Code Item: <blank> 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" %)((( 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.|((( 194 194 Either: 195 195 196 196 * A Dataflow or DSD 197 -)))| (%style="width:237px" %)|(% style="width:320px" %)(((223 +)))| |((( 198 198 <concept Id> 225 + 199 199 //Example~:// 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" %)((( 227 + 228 +DD_DIM (this concept should be hidden using the NOT_DISPLAYED Annotation below) 229 +)))| 230 +|DEPRECATED|((( 203 203 Indication that an Item in an Item Scheme or an artefact is deprecated. 232 + 204 204 For an item scheme item, the annotation value provides a replacement name for the code name. 234 + 205 205 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 + 206 206 Suggestion to use a controlled vocabulary 238 + 207 207 url: <[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/CURRENT>>url:http://publications.europa.eu/resource/authority/concept-status/CURRENT]]> 208 208 url: <[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/DEPRECATED>>url:http://publications.europa.eu/resource/authority/concept-status/DEPRECATED]]> 209 -or 210 -(% style="background-color:transparent" %)TITLE: true (false) 211 -)))|(% style="width:198px" %)((( 241 + 242 +or 243 + 244 +TITLE: true (false) 245 +)))|((( 212 212 Either: 213 213 214 214 * an artefact, or; 215 215 * an item in an Item Scheme 216 -)))|( % style="width:237px" %)(((250 +)))|((( 217 217 For item scheme item: 218 218 219 -<language>:<content>, <language>:<content>,…253 +<language>:<content>, 220 220 255 +<language>:<content>,… 256 + 221 221 //Example~:// 222 -(% style="background-color:transparent" %)en:deprecated,fr:obsolète 223 -)))|(% style="width:320px" %)<content>|(% style="width:203px" %)((( 258 + 259 +en:deprecated,fr:obsolète 260 +)))|<content>|((( 224 224 For artefact: 262 + 225 225 <see section URL value defaults and specific locale values> 264 + 265 + 226 226 ))) 227 -|DEFAULT|( % style="width:524px" %)(((267 +|DEFAULT|((( 228 228 Indication that an item in an Item Scheme or artefacts is to be selected by default. 229 229 230 230 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 231 -)))|( % style="width:198px" %)(((271 +)))|((( 232 232 * Item in ItemScheme, or; 233 233 * DSD, or; 234 234 * a Dataflow 235 235 236 236 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. 237 -)))| (%style="width:237px" %)|(% style="width:320px" %)(((277 +)))| |((( 238 238 Attached to: 239 239 240 240 - DSD or Dataflow: ... ... @@ -241,13 +241,13 @@ 241 241 **<concept>=<code>+<code>+…,<concept>=<code>+<code>+…** 242 242 243 243 //Example~:// FREQ=A+Q,TIME_PERIOD_START=2013-01,TIME_PERIOD_END=2018-12 244 -)))| (%style="width:203px" %)245 -|IMAGE| (% style="width:524px" %)A visual identity to associate to Item Scheme Items or artefacts|(% style="width:198px" %)(((284 +)))| 285 +|IMAGE|A visual identity to associate to Item Scheme Items or artefacts|((( 246 246 Either: 247 247 248 248 * an artefact, or; 249 249 * an item in an item scheme 250 -)))|( % style="width:237px" %)(((290 +)))|((( 251 251 For localised content in SDMX 2.1 252 252 253 253 <language>:<HTML containing URL to the resource>, ... ... @@ -257,26 +257,28 @@ 257 257 //Example~:// 258 258 259 259 en:<a href=”https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg”> 260 -)))| (%style="width:320px" %)|(% style="width:203px" %)(((300 +)))| |((( 261 261 See section URL value defaults and specific locale values. 262 262 263 263 //Example~:// 264 264 265 265 https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg 306 + 307 + 266 266 ))) 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" %)(((309 +|DRILLDOWN_CONCEPTS|Concepts to be displayed in a drilldown operation|Dataflow or DSD| |((( 268 268 <concept Id>,<concept Id>,… 269 269 270 270 Example : 271 271 272 -DONOR,RECIPIENT,YEAR,PROJECT_ID, OBS_VALUE,DESCRIPTION,OWNER273 -)))| (%style="width:203px" %)274 -|NOT_DISPLAYED| (% style="width:524px" %)Used to hide components or their values in the presentation|(% style="width:198px" %)(((314 +DONOR,RECIPIENT,YEAR,PROJECT_ID,OBS_VALUE,DESCRIPTION,OWNER 315 +)))| 316 +|NOT_DISPLAYED|Used to hide components or their values in the presentation|((( 275 275 Either: 276 276 277 277 * a Dataflow or DSD, or; 278 278 * an Item in an Item Scheme 279 -)))| (%style="width:237px" %)|(% style="width:320px" %)(((321 +)))| |((( 280 280 Attached to Item in Item Scheme: <blank> 281 281 282 282 Attached to Dataflow or DSD: ... ... @@ -286,13 +286,13 @@ 286 286 Example : 287 287 288 288 DD_DIM (to hide drilldown control concept) 289 -)))| (%style="width:203px" %)290 -|LAYOUT_ROW| (% style="width:524px" %)Dimensions to be presented in rows (concepts on y-axis)|(% style="width:198px" %)(((331 +)))| 332 +|LAYOUT_ROW|Dimensions to be presented in rows (concepts on y-axis)|((( 291 291 Either: 292 292 293 293 * an artefact, or; 294 294 * a Dimension 295 -)))| (%style="width:237px" %)|(% style="width:320px" %)(((337 +)))| |((( 296 296 Attached to Dimension: <blank> 297 297 298 298 Attached to Dataflow or DSD: <dimension Id>,<dimension Id >,… ... ... @@ -300,14 +300,13 @@ 300 300 //Example~:// 301 301 302 302 REF_AREA,MEASURE 303 -)))| (%style="width:203px" %)304 -|LAYOUT_COLUMN| (% style="width:524px" %)Dimensions to be presented in columns (concepts on x-axis)|(% style="width:198px" %)(((345 +)))| 346 +|LAYOUT_COLUMN|Dimensions to be presented in columns (concepts on x-axis)|((( 305 305 Either: 306 306 307 307 * an artefact, or; 308 - 309 -a Dimension 310 -)))|(% style="width:237px" %) |(% style="width:320px" %)((( 350 +* a Dimension 351 +)))| |((( 311 311 Attached to Dimension: <blank> 312 312 313 313 Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,… ... ... @@ -315,30 +315,33 @@ 315 315 //Example~:// 316 316 317 317 TIME_PERIOD 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" %)(((359 +)))| 360 +|LAYOUT_FLAG|Indication that an attribute and its attribute value should be presented as a flag|Dataflow| |((( 320 320 <concept Id>,<concept Id>,... 321 321 322 322 //Example~:// 323 323 324 324 OBS_STATUS,CONF_STATUS 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" %)(((366 +)))| 367 +|LAYOUT_NOTE|Indication that an attribute and its attribute value should be presented as a note|Dataflow| |((( 327 327 <concept Id>,<concept Id>,... 328 328 329 329 //Example~:// 330 330 331 331 OBS_STATUS,CONF_STATUS 332 -)))| (%style="width:203px" %)373 +)))| 333 333 |((( 334 334 METADATA 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" %)((( 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.|((( 337 337 Either: 338 338 339 339 * an artefact, or; 340 -* a Dimension 341 -)))|(% style="width:237px" %) |(% style="width:320px" %)((( 383 + 384 +a Dimension 385 +)))| |((( 342 342 Attached to Dimension: <blank> 343 343 344 344 Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,… ... ... @@ -346,12 +346,12 @@ 346 346 //Example~:// 347 347 348 348 SEX 349 -)))| (%style="width:203px" %)350 -|EXT_RESOURCE|( % style="width:524px" %)(((393 +)))| 394 +|EXT_RESOURCE|((( 351 351 A localised link to an external resource associated to the annotated artefact. For example, an ontology item 352 352 353 353 //a methodology// en:<a href:"[[https:~~/~~/ec.europa.eu/eurostat/web/waste/methodology>>url:https://ec.europa.eu/eurostat/web/waste/methodology]]"> 354 -)))| (% style="width:198px" %)Any SDMX object|(% style="width:237px" %)(((398 +)))|Any SDMX object|((( 355 355 For localised content in SDMX 2.1 356 356 357 357 <language>:<HTML containing URL to the resource>, ... ... @@ -361,7 +361,7 @@ 361 361 //Example~:// 362 362 363 363 en:<a href=”[[http:~~/~~/rdf-vocabulary.ddialliance.org/xkos#depth>>url:http://rdf-vocabulary.ddialliance.org/xkos#depth]]”> 364 -)))| (%style="width:320px" %)|(% style="width:203px" %)(((408 +)))| |((( 365 365 See section URL value defaults and specific locale values. 366 366 367 367 //Example~:// ... ... @@ -368,40 +368,378 @@ 368 368 369 369 http:~/~/rdf-vocabulary.ddialliance.org/xkos#depth 370 370 ))) 371 -|COMBINED_CONCEPTS|( % style="width:524px" %)(((415 +|COMBINED_CONCEPTS|((( 372 372 Comma-separated list of concept IDs to show as a concatenated label. 373 373 374 374 The listed concepts’ item contents may be concatenated to generate the target concept. 375 375 376 376 Multiple target concept combinations can be defined by separating the target concepts by ; 377 -)))| (% style="width:198px" %)Dataflow or DSD|(% style="width:237px" %)(((421 +)))|Dataflow or DSD|((( 378 378 <language>:<display name>, 423 + 379 379 <language>:<display name> 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" %) 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 + 387 387 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~:// 388 388 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 + 389 389 == Codelist and Statistical Classification-specific Annotations == 390 390 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 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]]. 392 392 534 +|Annotation Type|Use Case|Where to attach|((( 535 ++Text 393 393 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 + 394 394 = Concept Scheme SDMX:CS_ANNOT = 395 395 396 396 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. 397 397 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, EXCLUDES400 -|**Name**| (% style="width:309px" %)Concept Name|(% style="width:1173px" %)Short description of the standard Annotation derived from the “Use case” column401 -|**Representation**| (% style="width:309px" %)Concept Core Representation|(% style="width:1173px" %)Allowable type or format for the Annotation402 -|**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 AnnotationTitle403 -|**Artefact(s)**| (% style="width:309px" %)Annotation Type: Artefact(s)|(% style="width:1173px" %)The information in the “Where to attach” column404 -|**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 405 405 406 406 == Example of a Concept == 407 407 ... ... @@ -411,6 +411,8 @@ 411 411 |**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 412 412 |**Concept: Annotation: Type: Artefact(s)**|Either a Dataflow or DSD, or an item in an item scheme 413 413 796 +=== === 797 + 414 414 === SDMX-ML of the Example === 415 415 416 416 <str:Concept id="NOT_DISPLAYED"> ... ... @@ -438,4 +438,8 @@ 438 438 439 439 ---- 440 440 441 -{{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