Changes for page SDMX 3.1 Standards. Section 1. Framework

Last modified by Artur on 2025/09/30 12:30

From 12.4 to 12.5 From 13.4 to 14.1

From version 12.5

edited by Helena
on 2025/06/06 17:15

Change comment: There is no comment for this version

To version 13.4

edited by Helena
on 2025/06/06 17:22

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -98,7 +98,7 @@
  (% class="wikigeneratedid" id="HVersioningofStructuralMetadataArtefacts" %)
  **Versioning of Structural Metadata Artefacts**
--• Adoption of the three-number semantic versioning standard for [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] ([[__https:~~/~~/semver.org__>>https://https:semver.org]])
++Adoption of the three-number semantic versioning standard for [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] ([[__https:~~/~~/semver.org__>>https://https:semver.org]])
  (% class="wikigeneratedid" id="HRESTWebServicesApplicationProgrammingInterface28API29" %)
  **REST Web Services Application Programming Interface (API)**
@@ -108,8 +108,49 @@
  * Improvements to [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] queries
  * Support for [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] maintenance using HTTP PUT, POST and DELETE verbs
++(% class="wikigeneratedid" id="HSOAPWebServicesAPI" %)
++**SOAP Web Services API**
++* The SOAP web services API has been deprecated with (% style="color:#e74c3c" %)version(%%) 3.0 standardising on REST
++(% class="wikigeneratedid" id="HXML2CJSON2CCSVandEDITransmissionformats" %)
++**XML, JSON, CSV and EDI Transmission formats**
++
++The [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]], [[SDMX-JSON>>doc:sdmx:Glossary.SDMX-JSON.WebHome]] and [[SDMX>>doc:sdmx: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:sdmx:Glossary.Reference metadata.WebHome]] and microdata Obsolete [[SDMX-ML>>doc:sdmx: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 The [[SDMX-EDI>>doc:sdmx:Glossary.SDMX-EDI.WebHome]] transmission format for structures and data has been deprecated The organisation of structures into ‘collections’ in [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] and [[SDMX-JSON>>doc:sdmx:Glossary.SDMX-JSON.WebHome]] structure messages has been flattened and simplified The option to reference structures in [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] and [[SDMX-JSON>>doc:sdmx:Glossary.SDMX-JSON.WebHome]] messages using Agency, ID and (% style="color:#e74c3c" %)Version(%%) has been deprecated with URN now exclusively used for all non-local referencing purpose
++
++Several of the changes are ‘breaking’ meaning that, in specific cases, the (% style="color:#e74c3c" %)version(%%) 3.0 specification is not backwardly compatible with earlier (% style="color:#e74c3c" %)versions(%%) of the Standard.
++
++The principle breaking changes are:
++
++* REST API – The REST API is not backwardly compatible due to modifications to the URLs and query parameters resulting in breaking changes in four of the five main resources.
++* SOAP API – Deprecation of the SOAP API means that existing systems designed to use SOAP will not work with (% style="color:#e74c3c" %)version(%%) 3.0 registries.
++* [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] – [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 2.1 and earlier structure, data and metadata XML messages are not valid in (% style="color:#e74c3c" %)version(%%) 3.0. Specifically: legacy data messages including Generic, Compact and Utility are no longer supported. The remaining Structure Specific data message has been changed to support new features such as reporting of [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] as part of the [[dataset>>doc:sdmx:Glossary.Data set.WebHome]], Structure messages have a number of breaking changes, principally modification to the information model, removal of the agency-(% style="color:#e74c3c" %)version(%%)-id option for referencing [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] and changes to the way the structures are organised into ‘collections’ within the message.
++* [[SDMX-JSON>>doc:sdmx:Glossary.SDMX-JSON.WebHome]] – [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 2.1 structure, data and metadata JSON messages are not valid in (% style="color:#e74c3c" %)version(%%) 3.0. The data message has been changed to support the improved REST data queries, in particular the ability to retrieve in one operation data from multiple [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] with potentially different [[Data Structure Definitions>>doc:sdmx:Glossary.Data structure definition.WebHome]]. Breaking changes similar to those for the [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] transmission format have been made to the structure message.
++* [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-CSV - The CSV data and [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] messages are not backwardly compatible with those under (% style="color:#e74c3c" %)version(%%) 2.1 due to changes to the structure of the messages needed to support new features such as the improved REST API data queries.
++* [[SDMX-EDI>>doc:sdmx:Glossary.SDMX-EDI.WebHome]] – Deprecation of the EDI transmission format means that existing systems designed to send or receive structures or data in EDI will not work with (% style="color:#e74c3c" %)version(%%) 3.0 registries.
++* Information Model – Several structures have been changed in the (% style="color:#e74c3c" %)version(%%) 3.0 model and three removed. For these reasons the (% style="color:#e74c3c" %)version(%%) 3.0 model is not directly compatible with (% style="color:#e74c3c" %)version(%%) 2.1 or earlier, although conversion of specific [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] is possible under some circumstances. Loss of information during the conversion process however means that in cases like structure mapping, the conversion is not reversible i.e. it is not possible to recreate the 2.1 structure once it has been converted to the 3.0 model.
++
++The [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 Major Changes document provides more information including an analysis of the breaking changes.
++
++== 2.4 Major Changes from 3.0 to 3.1 ==
++
++(% class="wikigeneratedid" id="HInformationModel-1" %)
++**Information Model**
++
++* Addition of [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (% style="color:#e74c3c" %)Constraint(%%) property to a Dataflow
++* Addition of evolving structure property to a Data Structure Definition
++* Remove (% style="color:#e74c3c" %)version(%%) property on Categorisation
++* Simplification of (% style="color:#e74c3c" %)Constraints
++** Removal of Advanced Release Calendar
++** Removal of Role, Data (% style="color:#e74c3c" %)Constraints(%%) only restrict data that can be reported
++** Restrict (% style="color:#e74c3c" %)constraint(%%) targets to Identifiable structures (not URLs)
++** Addition of Availability (% style="color:#e74c3c" %)Constraint(%%) to define actual data
++
++(% class="wikigeneratedid" id="HDocumentation" %)
++**Documentation**
++
++* Registering [[Reference Metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] removed from documentation, to align with XML Registration object which is unable to reference a Metadata Provision, and REST API which is unable to query for registered [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] sources.
++
  The [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] standards specified here are designed to support the requirements of all of these automation processes and technologies.
  == 3.3 Statistical Data and Metadata ==
@@ -150,13 +150,6 @@
  //Batch Exchange of Data and Metadata~:// The transmission of whole or partial databases between counterparties, including incremental updating. //Provision of Data and Metadata on the Internet~:// Internet technology - including its use in private or semi-private TCP/IP networks - is extremely common. This technology includes XML, JSON and REST web services as primary mechanisms for automating data and metadata provision, as well as the more traditional static HTML and database-driven publishing. //Generic Processes~:// While many applications and processes are specific to some set of data and metadata, other types of automated services and processes are designed to handle any type of statistical data and metadata whatsoever. This is particularly true in cases where portal sites and data feeds are made available on the Internet. //Presentation and Transformation of Data~:// In order to make data and metadata useful to consumers, they must support automated processes that transform them into application-specific processing formats, other standard formats, and presentational formats. Although not strictly an aspect of exchange, this type of automated processing represents a set of requirements that must be supported if the information exchange between counterparties is itself to be supported.
--o Removal of Role, Data (% style="color:#e74c3c" %)Constraints(%%) only restrict data that can be reported// //o Restrict (% style="color:#e74c3c" %)constraint(%%) targets to Identifiable structures (not URLs) o Addition of Availability (% style="color:#e74c3c" %)Constraint(%%) to define actual data
--
--(% class="wikigeneratedid" id="HDocumentation" %)
--**Documentation**
--
--• Registering [[Reference Metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] removed from documentation, to align with XML Registration object which is unable to reference a Metadata Provision, and REST API which is unable to query for registered [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] sources.
--
  = 3 Processes and Business Scope =
  == 3.1 Process Patterns ==
@@ -165,31 +165,7 @@
  //Bilateral exchange~:// All aspects of the exchange process are agreed between counterparties, including the mechanism for exchange of data and metadata, the formats, the frequency or schedule, and the mode used for communications regarding the exchange. This is perhaps the most common process pattern. //Gateway exchange~:// Gateway exchanges are an organized set of bilateral exchanges, in which several data and metadata collecting organizations or individuals agree to exchange the collected information with each other in a single, known format, and according to a single, known process. This pattern has the effect of reducing the burden of managing multiple bilateral exchanges (in data and metadata collection) across the sharing organizations/individuals. This is also a very common process pattern in the statistical area, where communities of institutions agree on ways to gain efficiencies within the scope of their collective responsibilities. //Data-sharing exchange~:// Open, freely available data formats and process patterns are known and standard. Thus, any organization or individual can use any counterparty’s data and metadata (assuming they are permitted access to it). This model requires no bilateral agreement, but only requires that data and metadata providers and consumers adhere to the standards.
--The [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 Major Changes document provides more information including an analysis of the breaking changes.
--== 2.4 Major Changes from 3.0 to 3.1 ==
--
--(% class="wikigeneratedid" id="HInformationModel-1" %)
--**Information Model**
--
--Addition of [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (% style="color:#e74c3c" %)Constraint(%%) property to a Dataflow Addition of evolving structure property to a Data Structure Definition Remove (% style="color:#e74c3c" %)version(%%) property on Categorisation Simplification of (% style="color:#e74c3c" %)Constraints(%%) o Removal of Advanced Release Calendar
--
--Several of the changes are ‘breaking’ meaning that, in specific cases, the (% style="color:#e74c3c" %)version(%%) 3.0 specification is not backwardly compatible with earlier (% style="color:#e74c3c" %)versions(%%) of the Standard.
--
--The principle breaking changes are:
--
--REST API – The REST API is not backwardly compatible due to modifications to the URLs and query parameters resulting in breaking changes in four of the five main resources. SOAP API – Deprecation of the SOAP API means that existing systems designed to use SOAP will not work with (% style="color:#e74c3c" %)version(%%) 3.0 registries. [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] – [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 2.1 and earlier structure, data and metadata XML messages are not valid in (% style="color:#e74c3c" %)version(%%) 3.0. Specifically: legacy data messages including Generic, Compact and Utility are no longer supported. The remaining Structure Specific data message has been changed to support new features such as reporting of [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] as part of the [[dataset>>doc:sdmx:Glossary.Data set.WebHome]], Structure messages have a number of breaking changes, principally modification to the information model, removal of the agency-(% style="color:#e74c3c" %)version(%%)-id option for referencing [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] and changes to the way the structures are organised into ‘collections’ within the message. [[SDMX-JSON>>doc:sdmx:Glossary.SDMX-JSON.WebHome]] – [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 2.1 structure, data and metadata JSON messages are not valid in (% style="color:#e74c3c" %)version(%%) 3.0. The data message has been changed to support the improved REST data queries, in particular the ability to retrieve in one operation data from multiple [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] with potentially different [[Data Structure Definitions>>doc:sdmx:Glossary.Data structure definition.WebHome]]. Breaking changes similar to those for the [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] transmission format have been made to the structure message. [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-CSV - The CSV data and [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] messages are not backwardly compatible with those under (% style="color:#e74c3c" %)version(%%) 2.1 due to changes to the structure of the messages needed to support new features such as the improved REST API data queries. [[SDMX-EDI>>doc:sdmx:Glossary.SDMX-EDI.WebHome]] – Deprecation of the EDI transmission format means that existing systems designed to send or receive structures or data in EDI will not work with (% style="color:#e74c3c" %)version(%%) 3.0 registries. Information Model – Several structures have been changed in the (% style="color:#e74c3c" %)version(%%) 3.0 model and three removed. For these reasons the (% style="color:#e74c3c" %)version(%%) 3.0 model is not directly compatible with (% style="color:#e74c3c" %)version(%%) 2.1 or earlier, although conversion of specific [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] is possible under some circumstances. Loss of information during the conversion process however means that in cases like structure mapping, the conversion is not reversible i.e. it is not possible to recreate the 2.1 structure once it has been converted to the 3.0 model.
--
--(% class="wikigeneratedid" id="HSOAPWebServicesAPI" %)
--**SOAP Web Services API**
--
--• The SOAP web services API has been deprecated with (% style="color:#e74c3c" %)version(%%) 3.0 standardising on REST
--
--(% class="wikigeneratedid" id="HXML2CJSON2CCSVandEDITransmissionformats" %)
--**XML, JSON, CSV and EDI Transmission formats**
--
--The [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]], [[SDMX-JSON>>doc:sdmx:Glossary.SDMX-JSON.WebHome]] and [[SDMX>>doc:sdmx: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:sdmx:Glossary.Reference metadata.WebHome]] and microdata Obsolete [[SDMX-ML>>doc:sdmx: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 The [[SDMX-EDI>>doc:sdmx:Glossary.SDMX-EDI.WebHome]] transmission format for structures and data has been deprecated The organisation of structures into ‘collections’ in [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] and [[SDMX-JSON>>doc:sdmx:Glossary.SDMX-JSON.WebHome]] structure messages has been flattened and simplified The option to reference structures in [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] and [[SDMX-JSON>>doc:sdmx:Glossary.SDMX-JSON.WebHome]] messages using Agency, ID and (% style="color:#e74c3c" %)Version(%%) has been deprecated with URN now exclusively used for all non-local referencing purpose
--
  [[image:SDMX 3.1 Section 1.png]]
  **Figure 1: High Level Schematic of Major Artefacts in the SDMX 3.0 Information Model**
@@ -302,7 +302,7 @@
 . //Generic Metadata~:// For the exchange of [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] sets. ‘Generic’ means the XML elements and XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] are the same regardless of the metadata set.
 . //Registry~:// All of the possible interactions with the [[SDMX registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] services are supported using [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] interfaces and REST API calls. Submission of [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] content, data registrations and [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] is performed by a synchronous exchange of documents – a “request” message answered by a “response” message.
--== 5.2 SDMX-JSON ==
++== 5.2 SDMX-JSON ==
  [[SDMX-JSON>>doc:sdmx:Glossary.SDMX-JSON.WebHome]] is the JSON transmission format specification for exchanging [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]], data and [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]]. It provides an alternative to [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] and is most suited to applications like web data dissemination.