Last modified by Helena on 2025/09/10 11:19

From version 15.3
edited by Helena
on 2025/05/16 13:14
Change comment: There is no comment for this version
To version 16.8
edited by Helena
on 2025/05/16 13:24
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -247,8 +247,8 @@
247 247  
248 248  Reference metadata has been substantially re-designed for version 3.0 to simplify the model and better support practical use cases.
249 249  
250 -=== Simplify Metadata Structure Definition ===
251 -
250 +(% class="wikigeneratedid" id="HSimplifyMetadataStructureDefinition" %)
251 +**Simplify Metadata Structure Definition**
252 252  The Metadata Structure Definition (MSD) has been simplified to remove target information, and the support of multiple report structures. The MSD now only contains Metadata Attributes which are used to define the structure of a report.
253 253  
254 254  [[image:SDMX 3-0-0 Major Changes FINAL-1.0_en_ad5f5c97.png||height="346" width="494"]]
... ... @@ -259,8 +259,8 @@
259 259  
260 260  //Figure 3 the simplified version 3.0 MSD//
261 261  
262 -=== Change to reference metadata reported against data ===
263 -
262 +(% class="wikigeneratedid" id="HChangetoreferencemetadatareportedagainstdata" %)
263 +**Change to reference metadata reported against data**
264 264  Reference metadata associated with datasets, data series or observations are now reported with the data. The dataset’s DSD must reference an MSD to define the structure of its reference metadata. In practice reference metadata for data are transmitted as part of the data message. The metadata attributes are treated in a similar way to the data attributes appearing in the message at the dataset, data series or individual observation level as appropriate. In contrast to simple data attributes, metadata attributes defined by an MSD can be organised into a hierarchical structure as illustrated in Figure 3 above. For this reason, metadata attributes appear in data messages structured in the same way as metadata messages.
265 265  
266 266  The SDMX-ML example below is an excerpt from a structure specific data message illustrating reporting of reference metadata with a hierarchical structure at the observation level.
... ... @@ -312,16 +312,16 @@
312 312  > </Metadata>
313 313  > </Obs>
314 314  
315 -=== New - Metadata Provision Agreement ===
316 -
315 +(% class="wikigeneratedid" id="HNew-MetadataProvisionAgreement" %)
316 +**New - Metadata Provision Agreement**
317 317  In version 2.1 a Provision Agreement could be used to report information against a Dataflow or Metadataflow. From version 3.0 this is managed by two separate structures, the Data Provision Agreement and the Metadata Provision Agreement.
318 318  
319 -=== Move target to Metadataflow and Metadata Provision Agreement ===
320 -
319 +(% class="wikigeneratedid" id="HMovetargettoMetadataflowandMetadataProvisionAgreement" %)
320 +**Move target to Metadataflow and Metadata Provision Agreement**
321 321  For reference metadata that is reported against structures, the allowable targets information which is used to specify what structures the reference metadata can be reported against, has moved to the Metadataflow and can be further refined in the Metadata Provision Agreement.
322 322  
323 -=== Add maintainable properties to reference metadata ===
324 -
323 +(% class="wikigeneratedid" id="HAddmaintainablepropertiestoreferencemetadata" %)
324 +**Add maintainable properties to reference metadata**
325 325  A Metadataset now has mandatory identification information, (owner id, id, version) enabling metadata providers to uniquely identify their reports for create, update or delete maintenance operations.
326 326  
327 327  == 3.5 Microdata Exchange ==
... ... @@ -328,14 +328,10 @@
328 328  
329 329  Several changes have been made the Data Structure Definition to support microdata use cases in addition to aggregated time series.
330 330  
331 -=== Multiple measures ===
331 +(% class="wikigeneratedid" id="HMultiplemeasures" %)
332 +**Multiple measures**
333 +Multiple measures are a common characteristic of microdatasets. To support this use case, the MeasureDimension has been deprecated and replaced with the option to define zero or more measures. Measures now act like any other component in that they use concepts, can have their own local coded or uncoded representation defined within the Data Structure Definition, and can be either mandatory or conditional. Creating a measure with the “MEASURE” concept role applied emulates the version 2.1 MeasureDimension behaviour as illustrated in the SDMX-ML example below:
332 332  
333 -Multiple measures are a common characteristic of microdatasets. To support this use case, the MeasureDimension has been deprecated and replaced with the option to define zero or more measures. Measures now act like any other component in that they use concepts, can have their own local coded or uncoded representation defined within the
334 -
335 -Data Structure Definition, and can be either mandatory or conditional. Creating a measure with the “MEASURE” concept role applied emulates the version 2.1
336 -
337 -MeasureDimension behaviour as illustrated in the SDMX-ML example below:
338 -
339 339  > <str:MeasureList id=”MeasureDescriptor”>
340 340  > <str:Measure id=”OBS_VALUE” minOccurs=”1” maxOccurs=”1” usage=”mandatory” > <str:ConceptIdentity>
341 341  > <Ref id=”OBS_VALUE” maintainableParentID=”CONCEPTS” agencyID=”SDMX” maintainableParentVersion=”1.0.0” />
... ... @@ -351,30 +351,28 @@
351 351  > <str:Measure>
352 352  > </str:MeasureList>
353 353  
354 -=== Multi-value measures and attributes ===
355 -
350 +(% class="wikigeneratedid" id="HMulti-valuemeasuresandattributes" %)
351 +**Multi-value measures and attributes**
356 356  Both measures and attributes have been extended with the option to take ‘arrays’ of 193 multiple coded or uncoded values. This supports use cases like multiple observation 194 status flags. New //minOccurs// and //maxOccurs// properties define the valid number of 195 values. The //usage// property separately defines whether the measure or attribute is //mandatory// or optional. In the SDMX-ML measure example above, the properties //minOccurs=”1” maxOccurs=”1” usage=”mandatory”// specify that OBS_VALUE must be 198 reported, and can only consist of a single value.
357 357  
358 -=== Attributes relationship to measures ===
359 -
354 +(% class="wikigeneratedid" id="HAttributesrelationshiptomeasures" %)
355 +**Attributes relationship to measures**
360 360  In addition to attaching attributes to a specific level within the dataset, their relationship 202 to measures can also be defined.
361 361  
362 -=== Value lists ===
358 +(% class="wikigeneratedid" id="HValuelists" %)
359 +**Value lists**
360 +Value lists help in modelling microdata by providing an enumeration similar to code lists 206 but allowing any string values without being restricted to the rules of SDMX identifiers. That allows ValueItems (the equivalent to Code) to contain symbols like ‘¥’ and ‘€’, but also means they are not identifiable.
363 363  
364 -Value lists help in modelling microdata by providing an enumeration similar to code lists 206 but allowing any string values without being restricted to the rules of SDMX identifiers.
365 -
366 -That allows ValueItems (the equivalent to Code) to contain symbols like ‘¥’ and ‘€’, but 208 also means they are not identifiable.
367 -
368 368  == 3.6 Geospatial Data Exchange ==
369 369  
370 370  The version 3.0 model has been extended to provide explicit support for geospatial data.
371 371  
372 -=== GeospatialInformation type ===
373 -
366 +(% class="wikigeneratedid" id="HGeospatialInformationtype" %)
367 +**GeospatialInformation type**
374 374  A new GeospatialInformation string type has been added which can be used as the 214 representation for any dimension, attribute or measure component. The value which is a 215 string expression conforming to the syntax defined in Section 6 of the technical 216 specifications precisely defines a ‘Geo Feature Set’ – a collection of geographical 217 features like points, lines or polygons. Its use is recommended in conjunction with the “GEO_FEATURE_SET” concept role.
375 375  
376 -=== Geospatial code lists ===
377 -
370 +(% class="wikigeneratedid" id="HGeospatialcodelists" %)
371 +**Geospatial code lists**
378 378  Two new specialised types of code list have been added where the definition of each code includes additional geospatial information in addition to the standard ID, name and description:
379 379  
380 380  * GeographicCodelist – each item includes an element to represent a specific Geo Feature Set which is described using the same expression syntax as for GeospatialInformation type.
... ... @@ -457,7 +457,6 @@
457 457  Examples:
458 458  
459 459  SDMX:CL_AREA(1.0.0)
460 -
461 461  SDMX:CL_AREA(2.3.2)
462 462  
463 463  == Dependency management ==
... ... @@ -464,10 +464,9 @@
464 464  
465 465  Additional constructs are possible for dependency management when referencing structures. For instance:
466 466  
467 -2.3+.1 Means the currently latest available version >= “2.3.1” and < “3.0.0” (all backwards compatible versions >= “2.3.1”).
460 +2.3+.1  Means the currently latest available version >= “2.3.1” and < “3.0.0” (all backwards compatible versions >= “2.3.1”).
461 +2+.3.1  Means the currently latest available version >= “2.3.1” (even if not backwards compatible).
468 468  
469 -2+.3.1 Means the currently latest available version >= “2.3.1” (even if not backwards compatible).
470 -
471 471  == Draft structures ==
472 472  
473 473  A key principle is that semantically versioned structures are immutable and must not be changed without a corresponding change to the version number, except where explicitly marked as draft using extensions to the version number.
... ... @@ -474,12 +474,10 @@
474 474  
475 475  MAJOR.MINOR.PATCH-EXTENSION
476 476  
477 -1.10.0-draft Means that version 1.10.0 is still being modified and may change – equivalent to setting isFinal=false in SDMX 2.1.
469 +1.10.0-draft  Means that version 1.10.0 is still being modified and may change – equivalent to setting isFinal=false in SDMX 2.1.
470 +1.10.0-unstable  Alternative to -draft.
471 +1.10.0-notfinal  Alternative to -draft.
478 478  
479 -1.10.0-unstable Alternative to -draft.
480 -
481 -1.10.0-notfinal Alternative to -draft.
482 -
483 483  The SDMX 2.1 isFinal property is deprecated in 3.0.
484 484  
485 485  = 5 REST Web Services API =
... ... @@ -502,8 +502,8 @@
502 502  
503 503  Data queries have been changed to provide more granular selections from contexts wider than just a Dataflow.
504 504  
505 -=== Extend the context of data retrieval ===
506 -
495 +(% class="wikigeneratedid" id="HExtendthecontextofdataretrieval" %)
496 +**Extend the context of data retrieval**
507 507  Version 2.1 data queries always retrieved data from a single specific Dataflow. In version 3.0, the query context may be specified as:
508 508  
509 509  * Dataflow;
... ... @@ -512,18 +512,20 @@
512 512  
513 513  Data queries may also search across datasets, for instance “retrieve all data about a country”.
514 514  
515 -=== Component-based filters ===
516 -
505 +(% class="wikigeneratedid" id="HComponent-basedfilters" %)
506 +**Component-based filters**
517 517  Expressions filtering on individual components can now be included as part of the data query URL.
518 518  
519 519  /data/dataflow/ESTAT/ICP?c[REF_AREA]=CH&c[CONF_STATUS]=F
520 520  
521 -=== Support for operators ===
522 -
511 +(% class="wikigeneratedid" id="HSupportforoperators" %)
512 +**Support for operators**
523 523  Filter expressions can also include operators.
524 524  
525 -/data/dataflow/ESTAT/ICP?c[REF_AREA]=DE&c[ICP_ITEM]=sw:01&c[TIME_PERIOD]=ge:2015 Operators include:
515 +/data/dataflow/ESTAT/ICP?c[REF_AREA]=DE&c[ICP_ITEM]=sw:01&c[TIME_PERIOD]=ge:2015
526 526  
517 +Operators include:
518 +
527 527  (% style="width:531.039px" %)
528 528  |(% style="width:151px" %)eq|(% style="width:378px" %)Equals
529 529  |(% style="width:151px" %)ne|(% style="width:378px" %)Not equal to
... ... @@ -531,10 +531,11 @@
531 531  |(% style="width:151px" %)ge|(% style="width:378px" %)Greater than or equal to
532 532  |(% style="width:151px" %)sw|(% style="width:378px" %)Starts with
533 533  
534 -=== Support for multiple keys ===
535 -
526 +(% class="wikigeneratedid" id="HSupportformultiplekeys" %)
527 +**Support for multiple keys**
536 536  Queries can now specify multiple series keys.
537 537  
530 +(% class="wikigeneratedid" %)
538 538  /data/dataflow/ESTAT/ICP/1.0.0/M…A.ANR,M…A.INX,M…B.CTG
539 539  
540 540  == 5.3 Improved reference metadata queries ==
... ... @@ -565,8 +565,8 @@
565 565  
566 566  The SDMX-ML XML messages have been modified and updated for version 3.0. While they broadly follow the same principles, there have been significant changes which break backward compatibility.
567 567  
568 -=== Structure message ===
569 -
561 +(% class="wikigeneratedid" id="HStructuremessage" %)
562 +**Structure message**
570 570  The SDMX-ML structure message is used for transmission of structural metadata. It closely reflects the SDMX information model and has therefore been significantly updated for version 3.0 with the addition of new structures, modifications where structures have changed, and removal of deprecated structures like Structure Set.
571 571  
572 572  Additionally, the way the individual artefacts are organised into ‘collections’ within the message has been significantly revised with a simpler flat structure adopted as set out in the following table:
... ... @@ -617,8 +617,8 @@
617 617  
618 618  From version 3.0, collections can appear in any order within a structure message.
619 619  
620 -=== Data messages ===
621 -
613 +(% class="wikigeneratedid" id="HDatamessages" %)
614 +**Data messages**
622 622  All legacy SDMX-ML data messages have been deprecated with the exception of Structure Specific Data which becomes the sole standard format for transmission of SDMX data in XML in version 3.0.
623 623  
624 624  Specifically, the following data messages are not supported in version 3.0:
... ... @@ -635,16 +635,16 @@
635 635  
636 636  The time series variant of the Structure Specific Data message is no longer used.
637 637  
638 -=== Reference metadata message ===
639 -
631 +(% class="wikigeneratedid" id="HReferencemetadatamessage" %)
632 +**Reference metadata message**
640 640  The Generic Metadata message remains the standard format for transmission of reference metadata sets in XML but has been modified to support the revised version 3.0 reference metadata model.
641 641  
642 -=== Registry structural metadataquerymessages ===
643 -
635 +(% class="wikigeneratedid" id="HRegistrystructuralmetadata2018query2019messages" %)
636 +**Registry structural metadata ‘query’ messages**
644 644  As a consequence of the deprecation of the SOAP API and standardisation on REST, the structural metadata ‘query’ messages have all been removed. In version 3.0, querying an SDMX Registry for structural metadata is performed solely using REST GET.
645 645  
646 -=== Structure referencing ===
647 -
639 +(% class="wikigeneratedid" id="HStructurereferencing" %)
640 +**Structure referencing**
648 648  The option to reference structures using Agency, ID and Version has been removed. From SDMX version 3.0 URN is used for all referencing purposes with the exception of local references such as where groups reference dimensions within a DSD.
649 649  
650 650  == 6.2 SDMX-JSON ==