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
-
... ... @@ -124,8 +124,401 @@ 124 124 125 125 == General and Display-related Annotation types == 126 126 127 -== == 127 +|(% style="width:152px" %)Annotation Type|(% style="width:559px" %)Use Case|Where to attach|((( 128 ++Text 128 128 130 +Blue is optional 131 +)))|((( 132 +Title 133 +Blue is optional 134 +)))|((( 135 +SDMX 2.1:URL 136 +SDMX >=3.0:+URL 137 +Blue is optional 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.1 140 +en: A0123 Growing of citrus fruits|(% style="width:20px" %)Item in an Item Scheme|(% style="width:506px" %)((( 141 +<language>:<content>, 142 +<language>:<content>,… 143 +//Example~:// 144 +en:Labour force (Employment) 145 +)))|(% style="width:178px" %)<content>|(% style="width:866px" %) 146 +|(% 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" %)((( 147 +<component Id to replace name>:<component Id to use name> 148 + 149 +//Example~:// 150 +CUST_BREAKDOWN:CUST_BREAKDOWN_LB 151 +)))|(% style="width:866px" %) 152 +|(% 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" %)((( 153 +<component Id to replace content>:<component Id to use content> 154 + 155 +//Example~:// 156 + 157 +REF_AREA:M49_CODE 158 +)))|(% style="width:866px" %) 159 +|(% style="width:152px" %)COMPLEMENT|(% style="width:559px" %)((( 160 +Additional fixed text to be displayed in parenthesis after the code name. 161 + 162 +E.g. Representation of Non-hazardous (NHAZW), hazardous waste (HAZW) in the European List of Wastes 163 +en: 01 03 04* acid-generating tailings from processing of sulphide ore (HAZW) 164 +en: 01 03 99 wastes not otherwise specified (NHAZW) 165 +)))|(% style="width:20px" %)Item in an Item Scheme|(% style="width:506px" %)((( 166 +<language>:<content>, 167 + 168 +<language>:<content>,… 169 + 170 +//Example~:// 171 + 172 +en:See reference metadata 173 +)))|(% style="width:178px" %)<content>|(% style="width:866px" %) 174 +|(% 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" %)((( 175 +Either: 176 + 177 +* an artefact, or; 178 +* an item in an Item Scheme 179 +)))|(% style="width:506px" %)((( 180 +<language>:<content>, 181 + 182 +<language>:<content>,… 183 + 184 +//Example~:// 185 + 186 +en:10,es:20 187 +)))|(% style="width:178px" %)((( 188 +<content> 189 + 190 + 191 +)))|(% style="width:866px" %) 192 +|(% style="width:152px" %)TOTAL|(% style="width:559px" %)((( 193 +Code Item that represents a total value. If the attachment is: 194 + 195 +* to a Code, the Annotation Text is optional and may contain an explanatory text; 196 +* to a Codelist, the Annotation Title is mandatory and includes the code(s) that represent a total 197 +)))|(% style="width:20px" %)((( 198 +Either: 199 + 200 +* a Code Item that represents a total value, or; 201 +* a Codelist to specify the code(s) with the total 202 +)))|(% style="width:506px" %)((( 203 +<language>:<explanatory text>, 204 + 205 +<language>:<explanatory text>,… 206 +)))|(% style="width:178px" %)((( 207 +Attached to Code Item: <blank> 208 + 209 +Attached to Codelist: <code>,<code>,… 210 +)))|(% style="width:866px" %) 211 +|(% 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" %)((( 212 +Either: 213 + 214 +* A Dataflow or DSD 215 +)))|(% style="width:506px" %) |(% style="width:178px" %)((( 216 +<concept Id> 217 + 218 +//Example~:// 219 + 220 +DD_DIM (this concept should be hidden using the NOT_DISPLAYED Annotation below) 221 +)))|(% style="width:866px" %) 222 +|(% style="width:152px" %)DEPRECATED|(% style="width:559px" %)((( 223 +Indication that an Item in an Item Scheme or an artefact is deprecated. 224 + 225 +For an item scheme item, the annotation value provides a replacement name for the code name. 226 + 227 +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. 228 + 229 +Suggestion to use a controlled vocabulary 230 + 231 +url: <[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/CURRENT>>url:http://publications.europa.eu/resource/authority/concept-status/CURRENT]]> 232 +url: <[[http:~~/~~/publications.europa.eu/resource/authority/concept-status/DEPRECATED>>url:http://publications.europa.eu/resource/authority/concept-status/DEPRECATED]]> 233 + 234 +or 235 + 236 +TITLE: true (false) 237 +)))|(% style="width:20px" %)((( 238 +Either: 239 + 240 +* an artefact, or; 241 +* an item in an Item Scheme 242 +)))|(% style="width:506px" %)((( 243 +For item scheme item: 244 + 245 +<language>:<content>, 246 + 247 +<language>:<content>,… 248 + 249 +//Example~:// 250 + 251 +en:deprecated,fr:obsolète 252 +)))|(% style="width:178px" %)<content>|(% style="width:866px" %)((( 253 +For artefact: 254 + 255 +<see section URL value defaults and specific locale values> 256 + 257 + 258 +))) 259 +|(% style="width:152px" %)DEFAULT|(% style="width:559px" %)((( 260 +Indication that an item in an Item Scheme or artefacts is to be selected by default. 261 + 262 +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 263 +)))|(% style="width:20px" %)((( 264 +* Item in ItemScheme, or; 265 +* DSD, or; 266 +* a Dataflow 267 + 268 +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. 269 +)))|(% style="width:506px" %) |(% style="width:178px" %)((( 270 +Attached to: 271 + 272 +- DSD or Dataflow: 273 +**<concept>=<code>+<code>+…,<concept>=<code>+<code>+…** 274 + 275 +//Example~:// FREQ=A+Q,TIME_PERIOD_START=2013-01,TIME_PERIOD_END=2018-12 276 +)))|(% style="width:866px" %) 277 +|(% style="width:152px" %)IMAGE|(% style="width:559px" %)A visual identity to associate to Item Scheme Items or artefacts|(% style="width:20px" %)((( 278 +Either: 279 + 280 +* an artefact, or; 281 +* an item in an item scheme 282 +)))|(% style="width:506px" %)((( 283 +For localised content in SDMX 2.1 284 + 285 +<language>:<HTML containing URL to the resource>, 286 + 287 +<language>:<HTML containing URL to the resource>,… 288 + 289 +//Example~:// 290 + 291 +en:<a href=”https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg”> 292 +)))|(% style="width:178px" %) |(% style="width:866px" %)((( 293 +See section URL value defaults and specific locale values. 294 + 295 +//Example~:// 296 +https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg 297 + 298 +))) 299 +|(% 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" %)((( 300 +<concept Id>,<concept Id>,… 301 + 302 +Example : 303 + 304 +DONOR,RECIPIENT,YEAR,PROJECT_ID,OBS_VALUE,DESCRIPTION,OWNER 305 +)))|(% style="width:866px" %) 306 +|(% style="width:152px" %)NOT_DISPLAYED|(% style="width:559px" %)Used to hide components or their values in the presentation|(% style="width:20px" %)((( 307 +Either: 308 + 309 +* a Dataflow or DSD, or; 310 +* an Item in an Item Scheme 311 +)))|(% style="width:506px" %) |(% style="width:178px" %)((( 312 +Attached to Item in Item Scheme: <blank> 313 + 314 +Attached to Dataflow or DSD: 315 + 316 +<concept Id>,<concept Id>,… 317 + 318 +Example : 319 + 320 +DD_DIM (to hide drilldown control concept) 321 +)))|(% style="width:866px" %) 322 +|(% style="width:152px" %)LAYOUT_ROW|(% style="width:559px" %)Dimensions to be presented in rows (concepts on y-axis)|(% style="width:20px" %)((( 323 +Either: 324 + 325 +* an artefact, or; 326 +* a Dimension 327 +)))|(% style="width:506px" %) |(% style="width:178px" %)((( 328 +Attached to Dimension: <blank> 329 + 330 +Attached to Dataflow or DSD: <dimension Id>,<dimension Id >,… 331 + 332 +//Example~:// 333 + 334 +REF_AREA,MEASURE 335 +)))|(% style="width:866px" %) 336 +|(% style="width:152px" %)LAYOUT_COLUMN|(% style="width:559px" %)Dimensions to be presented in columns (concepts on x-axis)|(% style="width:20px" %)((( 337 +Either: 338 + 339 +* an artefact, or; 340 +* a Dimension 341 +)))|(% style="width:506px" %) |(% style="width:178px" %)((( 342 +Attached to Dimension: <blank> 343 + 344 +Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,… 345 + 346 +//Example~:// 347 + 348 +TIME_PERIOD 349 +)))|(% style="width:866px" %) 350 +|(% 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" %)((( 351 +<concept Id>,<concept Id>,... 352 + 353 +//Example~:// 354 + 355 +OBS_STATUS,CONF_STATUS 356 +)))|(% style="width:866px" %) 357 +|(% 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" %)((( 358 +<concept Id>,<concept Id>,... 359 + 360 +//Example~:// 361 + 362 +OBS_STATUS,CONF_STATUS 363 +)))|(% style="width:866px" %) 364 +|(% style="width:152px" %)((( 365 +METADATA 366 + 367 + 368 +)))|(% 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" %) 369 +|(% 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" %)((( 370 +Either: 371 + 372 +* an artefact, or; 373 + 374 +a Dimension 375 +)))|(% style="width:506px" %) |(% style="width:178px" %)((( 376 +Attached to Dimension: <blank> 377 + 378 +Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,… 379 + 380 +//Example~:// 381 + 382 +SEX 383 +)))|(% style="width:866px" %) 384 +|(% style="width:152px" %)EXT_RESOURCE|(% style="width:559px" %)((( 385 +A localised link to an external resource associated to the annotated artefact. For example, an ontology item 386 + 387 +//a methodology// en:<a href:"[[https:~~/~~/ec.europa.eu/eurostat/web/waste/methodology>>url:https://ec.europa.eu/eurostat/web/waste/methodology]]"> 388 +)))|(% style="width:20px" %)Any SDMX object|(% style="width:506px" %)((( 389 +For localised content in SDMX 2.1 390 + 391 + <language>:<HTML containing URL to the resource>, 392 + 393 +<language>:<HTML containing URL to the resource>,… 394 + 395 +//Example~:// 396 + 397 +en:<a href=”[[http:~~/~~/rdf-vocabulary.ddialliance.org/xkos#depth>>url:http://rdf-vocabulary.ddialliance.org/xkos#depth]]”> 398 +)))|(% style="width:178px" %) |(% style="width:866px" %)((( 399 +See section URL value defaults and specific locale values. 400 + 401 +//Example~:// 402 + 403 +http:~/~/rdf-vocabulary.ddialliance.org/xkos#depth 404 +))) 405 +|(% style="width:152px" %)COMBINED_CONCEPTS|(% style="width:559px" %)((( 406 +Comma-separated list of concept IDs to show as a concatenated label. 407 + 408 +The listed concepts’ item contents may be concatenated to generate the target concept. 409 + 410 +Multiple target concept combinations can be defined by separating the target concepts by ; 411 +)))|(% style="width:20px" %)Dataflow or DSD|(% style="width:506px" %)((( 412 +<language>:<display name>, 413 + 414 +<language>:<display name> 415 + 416 +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} 417 +)))|(% style="width:178px" %) |(% style="width:866px" %) 418 +|(% style="width:152px" %)(deprecated) UNIT_MEASURE_CONCEPTS|(% style="width:559px" %)((( 419 +Comma-separated list of concept IDs that is used to define the full unit of measure. The concepts must be in the DSD. 420 + 421 +The listed concepts’ item contents may be concatenated to generate the unit of measure label (unless the UNIT_MEASURE_LABEL annotation is present). 422 +)))|(% style="width:20px" %)Dataflow or DSD|(% style="width:506px" %) |(% style="width:178px" %)((( 423 +<concept Id>,<concept Id>,… 424 + 425 +//Example~:// UNIT_MEASURE,UNIT_MULT,TRANSFORMATION [could generate a value of Australian Dollar, Thousands, Non-transformed] 426 +)))|(% style="width:866px" %) 427 +|(% style="width:152px" %)(deprecated) UNIT_MEASURE_LABEL|(% style="width:559px" %)((( 428 +Indicates the concept that enumerates the full unit of measure labels. 429 + 430 +The concept must be in the DSD. UNIT_MEASURE_LABEL overrides the UNIT_MEASURE_CONCEPTS if both are provided. 431 + 432 +Also can be attached to items in item scheme, e.g. 433 + 434 +Text en:Gram 435 + fr: Gramme 436 +url:** **[[**http:~~/~~/data.europa.eu/gzn/su/G**>>url:http://data.europa.eu/gzn/su/G]] 437 +)))|(% style="width:20px" %)Dataflow or DSD, Item in an Item Scheme|(% style="width:506px" %)((( 438 +This is optional, used if a freetext label is required. 439 + 440 +<language>:<content>, 441 + 442 +<language>:<content>,… 443 + 444 +//Example~:// 445 + 446 +en:USD, thousands 447 + 448 +fr:USD, milliers 449 +)))|(% style="width:178px" %)((( 450 +This is optional, used if an enumerated list is required. 451 + 452 +<concept Id> 453 + 454 +//Example~:// 455 + 456 +UOM_ATTRIBUTE [This concept may contain the following items as units of measure: 457 + 458 +* National Currency, thousands 459 +* USD, thousands 460 + 461 +Index, based on National Currency] 462 +)))|(% style="width:866px" %) 463 +|(% style="width:152px" %)((( 464 +LAYOUT_TIME_PERIOD_DESC 465 + 466 + 467 +)))|(% 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" %)((( 468 +//Example~:// 469 + 470 +LAYOUT_TIME_PERIOD_DESC 471 +)))|(% style="width:866px" %) 472 +|(% style="width:152px" %)((( 473 +LAYOUT_CELL_ALIGN 474 + 475 + 476 +)))|(% 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" %)((( 477 +<language>:<content>, 478 + 479 +<language>:<content>,… 480 + 481 + 482 +<content> values:RIGHT or LEFT 483 +)))|(% style="width:178px" %)Content values:RIGHT or LEFT|(% style="width:866px" %) 484 +|(% style="width:152px" %)((( 485 +MAX_TABLE_DATA 486 + 487 + 488 +)))|(% 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" %)((( 489 +<integer> 490 + 491 +//Example~:// 492 + 493 +15000 494 +)))|(% style="width:866px" %) 495 +|(% style="width:152px" %)((( 496 +MAXTEXTATTRIBUTELENGTH 497 + 498 + 499 +)))|(% style="width:559px" %)Increase the maximum length for textual attribute values|(% style="width:20px" %)DSD|(% style="width:506px" %) |(% style="width:178px" %)((( 500 +<integer> 501 + 502 +//Example~:// 503 + 504 +500 505 +)))|(% style="width:866px" %) 506 +|(% 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" %)((( 507 +<language>:<integer>,... 508 +//Example~:// 509 +"en":"3","es":"4","fr":"5" 510 +)))|(% style="width:178px" %)((( 511 +<integer> 512 + 513 +//Example~:// 514 + 515 +10 516 +)))|(% style="width:866px" %) 517 + 518 +== Codelist and Statistical Classification-specific Annotations == 519 + 520 +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}}. 521 + 129 129 |**Annotation Type**|(% style="width:524px" %)**Use Case**|(% style="width:198px" %)**Where to attach**|(% style="width:237px" %)((( 130 130 **+Text 131 131 (% style="background-color:transparent" %)Blue is optional(%%)** ... ... @@ -238,11 +238,6 @@ 238 238 | |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 239 239 | |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 240 240 241 -== Codelist and Statistical Classification-specific Annotations == 242 - 243 -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}}. 244 - 245 - 246 246 = Concept Scheme SDMX:CS_ANNOT = 247 247 248 248 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.