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,6 +124,8 @@ 124 124 125 125 == General and Display-related Annotation types == 126 126 127 +== == 128 + 127 127 |**Annotation Type**|(% style="width:524px" %)**Use Case**|(% style="width:198px" %)**Where to attach**|(% style="width:237px" %)((( 128 128 **+Text 129 129 (% style="background-color:transparent" %)Blue is optional(%%)** ... ... @@ -224,167 +224,17 @@ 224 224 For artefact: 225 225 <see section URL value defaults and specific locale values> 226 226 ))) 227 -|DEFAULT|(% style="width:524px" %)((( 228 -Indication that an item in an Item Scheme or artefacts is to be selected by default. 229 - 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" %)((( 232 -* Item in ItemScheme, or; 233 -* DSD, or; 234 -* a Dataflow 235 - 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" %)((( 238 -Attached to: 239 - 240 -- DSD or Dataflow: 241 -**<concept>=<code>+<code>+…,<concept>=<code>+<code>+…** 242 - 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" %)((( 246 -Either: 247 - 248 -* an artefact, or; 249 -* an item in an item scheme 250 -)))|(% style="width:237px" %)((( 251 -For localised content in SDMX 2.1 252 - 253 -<language>:<HTML containing URL to the resource>, 254 - 255 -<language>:<HTML containing URL to the resource>,… 256 - 257 -//Example~:// 258 - 259 -en:<a href=”https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg”> 260 -)))|(% style="width:320px" %) |(% style="width:203px" %)((( 261 -See section URL value defaults and specific locale values. 262 - 263 -//Example~:// 264 - 265 -https:~/~/sdmx.org/wp-content/uploads/SDMX_map_small-220x220.jpg 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" %)((( 268 -<concept Id>,<concept Id>,… 269 - 270 -Example : 271 - 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" %)((( 275 -Either: 276 - 277 -* a Dataflow or DSD, or; 278 -* an Item in an Item Scheme 279 -)))|(% style="width:237px" %) |(% style="width:320px" %)((( 280 -Attached to Item in Item Scheme: <blank> 281 - 282 -Attached to Dataflow or DSD: 283 - 284 -<concept Id>,<concept Id>,… 285 - 286 -Example : 287 - 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" %)((( 291 -Either: 292 - 293 -* an artefact, or; 294 -* a Dimension 295 -)))|(% style="width:237px" %) |(% style="width:320px" %)((( 296 -Attached to Dimension: <blank> 297 - 298 -Attached to Dataflow or DSD: <dimension Id>,<dimension Id >,… 299 - 300 -//Example~:// 301 - 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" %)((( 305 -Either: 306 - 307 -* an artefact, or; 308 - 309 -a Dimension 310 -)))|(% style="width:237px" %) |(% style="width:320px" %)((( 311 -Attached to Dimension: <blank> 312 - 313 -Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,… 314 - 315 -//Example~:// 316 - 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" %)((( 320 -<concept Id>,<concept Id>,... 321 - 322 -//Example~:// 323 - 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" %)((( 327 -<concept Id>,<concept Id>,... 328 - 329 -//Example~:// 330 - 331 -OBS_STATUS,CONF_STATUS 332 -)))|(% style="width:203px" %) 333 -|((( 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" %)((( 337 -Either: 338 - 339 -* an artefact, or; 340 -* a Dimension 341 -)))|(% style="width:237px" %) |(% style="width:320px" %)((( 342 -Attached to Dimension: <blank> 343 - 344 -Attached to Dataflow or DSD: <dimension Id>,<dimension Id>,… 345 - 346 -//Example~:// 347 - 348 -SEX 349 -)))|(% style="width:203px" %) 350 -|EXT_RESOURCE|(% style="width:524px" %)((( 351 -A localised link to an external resource associated to the annotated artefact. For example, an ontology item 352 - 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" %)((( 355 -For localised content in SDMX 2.1 356 - 357 - <language>:<HTML containing URL to the resource>, 358 - 359 -<language>:<HTML containing URL to the resource>,… 360 - 361 -//Example~:// 362 - 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" %)((( 365 -See section URL value defaults and specific locale values. 366 - 367 -//Example~:// 368 - 369 -http:~/~/rdf-vocabulary.ddialliance.org/xkos#depth 370 -))) 371 -|COMBINED_CONCEPTS|(% style="width:524px" %)((( 372 -Comma-separated list of concept IDs to show as a concatenated label. 373 - 374 -The listed concepts’ item contents may be concatenated to generate the target concept. 375 - 376 -Multiple target concept combinations can be defined by separating the target concepts by ; 377 -)))|(% style="width:198px" %)Dataflow or DSD|(% style="width:237px" %)((( 378 -<language>:<display name>, 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 382 | |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 383 383 | |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 384 384 | |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 385 385 | |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 386 386 | |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 387 - 234 +| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 235 +| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 236 +| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 237 +| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 238 +| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 239 +| |(% style="width:524px" %) |(% style="width:198px" %) |(% style="width:237px" %) |(% style="width:320px" %) |(% style="width:203px" %) 388 388 389 389 == Codelist and Statistical Classification-specific Annotations == 390 390