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

From version 16.5
edited by Helena
on 2025/05/16 13:20
Change comment: There is no comment for this version
To version 19.2
edited by Helena
on 2025/05/16 15:50
Change comment: There is no comment for this version

Summary

Details

Page properties
Tags
... ... @@ -1,0 +1,1 @@
1 +Artefact|Code|Code list|Hierarchy|Reference metadata|SDMX-EDI|SDMX-JSON|SDMX-ML|Statistical data and metadata exchange|Structural metadata
Content
... ... @@ -11,55 +11,55 @@
11 11  
12 12  = 1 Overview =
13 13  
14 -SDMX version 3.0 introduces new features, improvements and changes to the Standard in the following key areas:
14 +[[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] (% style="color:#2ecc71" %)version(%%) 3.0 introduces new features, improvements and changes to the Standard in the following key areas:
15 15  
16 16  **Information Model**
17 17  
18 -* Simplification and improvement of the reference metadata model
18 +* Simplification and improvement of the [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] model
19 19  * Support for microdata
20 20  * Support for geospatial data
21 -* Support for code list extension and discriminated union of code lists
21 +* Support for [[code list>>doc:xwiki:Glossary.Code list.WebHome]] extension and discriminated union of [[code>>doc:xwiki:Glossary.Code.WebHome]] lists
22 22  * Improvements to structure mapping
23 -* Improvements to code hierarchies for data discovery
23 +* Improvements to [[code>>doc:xwiki:Glossary.Code.WebHome]] [[hierarchies>>doc:xwiki:Glossary.Hierarchy.WebHome]] for data discovery
24 24  * Improvements to constraints
25 25  
26 26  **Versioning of Structural Metadata Artefacts**
27 27  
28 -* Adoption of the three-number semantic versioning standard for structural metadata artefacts ([[https:~~/~~/semver.org/>>https://semver.org/||rel="noopener noreferrer" target="_blank"]])
28 +* Adoption of the three-number semantic versioning standard for [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] ([[https:~~/~~/semver.org/>>https://semver.org/||rel="noopener noreferrer" target="_blank"]])
29 29  
30 30  **REST Web Services Application Programming Interface (API)**
31 31  
32 32  * Change to a single ‘structure’ resource for structure queries simplifying the REST API specification by reducing the number of resources to five
33 33  * Improvements to data queries
34 -* Improvements to reference metadata queries
35 -* Support for structural metadata maintenance using HTTP PUT, POST and DELETE verbs
34 +* Improvements to [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] queries
35 +* Support for [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] maintenance using HTTP PUT, POST and DELETE verbs
36 36  
37 37  **SOAP Web Services API**
38 38  
39 -* The SOAP web services API has been deprecated with version 3.0 standardising on REST**;**
39 +* The SOAP web services API has been deprecated with (% style="color:#2ecc71" %)version(%%) 3.0 standardising on REST**;**
40 40  
41 41  **XML, JSON, CSV and EDI Transmission formats**
42 42  
43 -* The SDMX-ML, SDMX-JSON and SDMX-CSV specifications have been extended and modified where needed to support the new features and changes such as reference metadata and microdata
44 -* Obsolete SDMX-ML data message variants including Generic, Compact, Utility and Cross-sectional have been deprecated standardising on Structure Specific Data as the sole XML format for data exchange
45 -* The SDMX-EDI transmission format for structures and data has been deprecated
46 -* The organisation of structures into ‘collections’ in SDMX-ML and SDMX-JSON structure messages has been flattened and simplified
47 -* The option to reference structures in SDMX-ML and SDMX-JSON messages using Agency, ID and Version has been deprecated with URN now exclusively used for all non-local referencing purpose
43 +* The [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]], [[SDMX-JSON>>doc:xwiki:Glossary.SDMX-JSON.WebHome]] and [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]]-CSV specifications have been extended and modified where needed to support the new features and changes such as [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] and microdata
44 +* Obsolete [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] data message variants including Generic, Compact, Utility and Cross-sectional have been deprecated standardising on Structure Specific Data as the sole XML format for data exchange
45 +* The [[SDMX-EDI>>doc:xwiki:Glossary.SDMX-EDI.WebHome]] transmission format for structures and data has been deprecated
46 +* The organisation of structures into ‘collections’ in [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] and [[SDMX-JSON>>doc:xwiki:Glossary.SDMX-JSON.WebHome]] structure messages has been flattened and simplified
47 +* The option to reference structures in [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] and [[SDMX-JSON>>doc:xwiki:Glossary.SDMX-JSON.WebHome]] messages using Agency, ID and (% style="color:#2ecc71" %)Version(%%) has been deprecated with URN now exclusively used for all non-local referencing purpose
48 48  
49 49  **Breaking Changes**
50 50  
51 -Many of the changes made are ‘breaking’ meaning that, while conversion between versions may be possible in certain circumstances, the 3.0 specification is not directly backwardly compatible with earlier versions of the Standard.
51 +Many of the changes made are ‘breaking’ meaning that, while conversion between (% style="color:#2ecc71" %)versions(%%) may be possible in certain circumstances, the 3.0 specification is not directly backwardly compatible with earlier (% style="color:#2ecc71" %)versions(%%) of the Standard.
52 52  
53 53  A summary of the main breaking changes is given in chapter 2.
54 54  
55 55  **Content of the Document**
56 56  
57 -The remainder of the document provides a summary of the main changes. More detailed information can be found the SDMX 3.0 Technical Specifications, in particular:
57 +The remainder of the document provides a summary of the main changes. More detailed information can be found the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 Technical Specifications, in particular:
58 58  
59 59  * Section 2 – Information Model
60 60  * Section 5 – Registry Specification
61 61  * Section 6 – Technical Notes
62 -* SDMX-TWG GitHub for the REST API and the XML, JSON and CSV formats
62 +* [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]]-TWG GitHub for the REST API and the XML, JSON and CSV formats
63 63  
64 64  = 2 Summary of Breaking Changes in 3.0 =
65 65  
... ... @@ -94,13 +94,10 @@
94 94  The following legacy XML data messages have been deprecated:
95 95  
96 96  SDMX-ML 1.0/2.0 Generic (time-series) data message
97 -
98 98  SDMX-ML 1.0/2.0 Compact (time-series) data message
99 -
100 100  SDMX-ML 1.0/2.0 Utility (time-series) data message
99 +SDMX-ML 1.0/2.0 Cross-Sectional data message SDMX-ML 2.1 Generic data messages (for observations, time-series and cross-sectional data)
101 101  
102 -SDMX-ML 1.0/2.0 Cross-Sectional data message SDMX-ML 2.1 Generic data messages (for observations, time-series and cross-sectional data)
103 -
104 104  Structure Specific is the only data message option in version 3.0 but is not backwardly compatible with version 2.1 due to several changes including deprecation of the option to reference structures like the DSD, Dataflow and Provision Agreement using their Agency, ID and Version. The time series variant of the message has also been deprecated.
105 105  
106 106  The SDMX-ML structure message is not backwardly compatible primarily due to:
... ... @@ -492,8 +492,8 @@
492 492  
493 493  Data queries have been changed to provide more granular selections from contexts wider than just a Dataflow.
494 494  
495 -=== Extend the context of data retrieval ===
496 -
492 +(% class="wikigeneratedid" id="HExtendthecontextofdataretrieval" %)
493 +**Extend the context of data retrieval**
497 497  Version 2.1 data queries always retrieved data from a single specific Dataflow. In version 3.0, the query context may be specified as:
498 498  
499 499  * Dataflow;
... ... @@ -502,18 +502,20 @@
502 502  
503 503  Data queries may also search across datasets, for instance “retrieve all data about a country”.
504 504  
505 -=== Component-based filters ===
506 -
502 +(% class="wikigeneratedid" id="HComponent-basedfilters" %)
503 +**Component-based filters**
507 507  Expressions filtering on individual components can now be included as part of the data query URL.
508 508  
509 509  /data/dataflow/ESTAT/ICP?c[REF_AREA]=CH&c[CONF_STATUS]=F
510 510  
511 -=== Support for operators ===
512 -
508 +(% class="wikigeneratedid" id="HSupportforoperators" %)
509 +**Support for operators**
513 513  Filter expressions can also include operators.
514 514  
515 -/data/dataflow/ESTAT/ICP?c[REF_AREA]=DE&c[ICP_ITEM]=sw:01&c[TIME_PERIOD]=ge:2015 Operators include:
512 +/data/dataflow/ESTAT/ICP?c[REF_AREA]=DE&c[ICP_ITEM]=sw:01&c[TIME_PERIOD]=ge:2015
516 516  
514 +Operators include:
515 +
517 517  (% style="width:531.039px" %)
518 518  |(% style="width:151px" %)eq|(% style="width:378px" %)Equals
519 519  |(% style="width:151px" %)ne|(% style="width:378px" %)Not equal to
... ... @@ -521,10 +521,11 @@
521 521  |(% style="width:151px" %)ge|(% style="width:378px" %)Greater than or equal to
522 522  |(% style="width:151px" %)sw|(% style="width:378px" %)Starts with
523 523  
524 -=== Support for multiple keys ===
525 -
523 +(% class="wikigeneratedid" id="HSupportformultiplekeys" %)
524 +**Support for multiple keys**
526 526  Queries can now specify multiple series keys.
527 527  
527 +(% class="wikigeneratedid" %)
528 528  /data/dataflow/ESTAT/ICP/1.0.0/M…A.ANR,M…A.INX,M…B.CTG
529 529  
530 530  == 5.3 Improved reference metadata queries ==
... ... @@ -555,8 +555,8 @@
555 555  
556 556  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.
557 557  
558 -=== Structure message ===
559 -
558 +(% class="wikigeneratedid" id="HStructuremessage" %)
559 +**Structure message**
560 560  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.
561 561  
562 562  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:
... ... @@ -607,8 +607,8 @@
607 607  
608 608  From version 3.0, collections can appear in any order within a structure message.
609 609  
610 -=== Data messages ===
611 -
610 +(% class="wikigeneratedid" id="HDatamessages" %)
611 +**Data messages**
612 612  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.
613 613  
614 614  Specifically, the following data messages are not supported in version 3.0:
... ... @@ -625,16 +625,16 @@
625 625  
626 626  The time series variant of the Structure Specific Data message is no longer used.
627 627  
628 -=== Reference metadata message ===
629 -
628 +(% class="wikigeneratedid" id="HReferencemetadatamessage" %)
629 +**Reference metadata message**
630 630  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.
631 631  
632 -=== Registry structural metadataquerymessages ===
633 -
632 +(% class="wikigeneratedid" id="HRegistrystructuralmetadata2018query2019messages" %)
633 +**Registry structural metadata ‘query’ messages**
634 634  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.
635 635  
636 -=== Structure referencing ===
637 -
636 +(% class="wikigeneratedid" id="HStructurereferencing" %)
637 +**Structure referencing**
638 638  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.
639 639  
640 640  == 6.2 SDMX-JSON ==
... ... @@ -641,20 +641,20 @@
641 641  
642 642  Like SDMX-ML, the SDMX-JSON messages have been significantly modified and updated for version 3.0. They are not backwardly compatible with version 2.1.
643 643  
644 -=== Structure message ===
645 -
644 +(% class="wikigeneratedid" id="HStructuremessage-1" %)
645 +**Structure message**
646 646  The SDMX-JSON structure message closely replicates the SDMX-ML equivalent. Like that of SDMX-ML it has been updated to align it with the version 3.0 information model with addition, deletion and modification of artefacts as required. The organisation of the structure collections has also been revised as detailed in paragraph 6.1.
647 647  
648 -=== Data message ===
649 -
648 +(% class="wikigeneratedid" id="HDatamessage" %)
649 +**Data message**
650 650  The SDMX-JSON data message has similarly be updated. Additional changes have been made to allow a single message to carry data from multiple datasets with potentially different Data Structure Definitions to support REST data queries of the form “retrieve all data about a country”. For this reason, the version 3.0 SDMX-JSON is not backwardly compatible with version 2.1 data messages. Support has been added for the transmission of microdata and reporting of reference metadata on data as an integral part of the dataset.
651 651  
652 -=== Reference metadata message ===
653 -
652 +(% class="wikigeneratedid" id="HReferencemetadatamessage-1" %)
653 +**Reference metadata message**
654 654  The SDMX-JSON metadata message has also been updated to support the version 3.0 reference metadata and Metadataset specifications.
655 655  
656 -=== Structure referencing ===
657 -
656 +(% class="wikigeneratedid" id="HStructurereferencing-1" %)
657 +**Structure referencing**
658 658  As for SDMX-ML, the option to reference structures using Agency, ID and Version has been removed with URN used for all non-local referencing purposes.
659 659  
660 660  == 6.3 SDMX-CSV ==
... ... @@ -661,8 +661,8 @@
661 661  
662 662  CSV in SDMX is used transmission of data and reference metadata only.
663 663  
664 -=== Data message ===
665 -
664 +(% class="wikigeneratedid" id="HDatamessage-1" %)
665 +**Data message**
666 666  The SDMX-CSV data message has been modified to align with the version 3.0 information model, support the enhanced REST API and ensure that data can be freely converted to and from the XML and JSON formats without loss. These changes include:
667 667  
668 668  * An additional column identifying the type if the artefact defining the structure of the data: “dataflow”, “datastructure” or “dataprovision”; • A column for the structure artefact’s identification of the form
... ... @@ -671,11 +671,11 @@
671 671  
672 672  * A column for the dataset action: information, append, replace or delete, which is consistent with both the the SDMX-ML and SDMX-JSON data messages.
673 673  
674 -=== Reference metadata message ===
675 -
674 +(% class="wikigeneratedid" id="HReferencemetadatamessage-2" %)
675 +**Reference metadata message**
676 676  The SDMX-CSV metadata message is new for version 3.0 and, like the SDMX-ML and SDMX-JSON equivalents, is used for the transmission reference metadata sets.
677 677  
678 -=== 6.4 EDI deprecation ===
678 +== 6.4 EDI deprecation ==
679 679  
680 680  The EDI format for transmission of both structures and data has been deprecated. Version 3.0 is therefore not backwardly compatible with legacy EDI messages.
681 681