Wiki source code of SDMX 3.1 Standards. Section 1. Summary of Major Changes and New Functionality
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
| |
1.1 | 1 | {{box title="**Contents**"}} |
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| 5 | **Revision History** | ||
| 6 | |||
| 7 | (% style="width:991.835px" %) | ||
| 8 | |(% style="width:154px" %)**Revision ** |(% style="width:249px" %)**Date ** |(% style="width:586px" %)**Contents ** | ||
| 9 | |(% style="width:154px" %)DRAFT 1.0|(% style="width:249px" %)December 2024|(% style="width:586px" %)Draft release updated for SDMX 3.1 for public consultation | ||
| 10 | |(% style="width:154px" %)1.0|(% style="width:249px" %)May 2025|(% style="width:586px" %)Public release for SDMX 3.1 | ||
| 11 | |||
| |
1.2 | 12 | = 1. Overview = |
| 13 | |||
| |
1.7 | 14 | [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.1 is a minor revision to the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 Standard which introduces a limited set of changes, which cover the following: |
| |
1.2 | 15 | |
| |
1.5 | 16 | **Information Model** |
| |
1.2 | 17 | |
| |
1.7 | 18 | * Support for [[Dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]] to reference a subset of [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] from a [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] |
| |
3.2 | 19 | * Simplification to Data (% style="color:#e74c3c" %)[[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]] |
| 20 | * Addition of Availability (% style="color:#e74c3c" %)[[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]] | ||
| |
1.2 | 21 | |
| |
1.5 | 22 | **Documentation** |
| |
1.2 | 23 | |
| |
1.7 | 24 | 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. |
| |
1.2 | 25 | |
| |
1.5 | 26 | **Breaking Changes** |
| |
1.2 | 27 | |
| |
3.2 | 28 | * Remove (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) property on Categorisation |
| |
1.7 | 29 | * Removal of Advanced [[Release Calendar>>doc:sdmx:Glossary.Release policy - release calendar.WebHome]] |
| |
1.2 | 30 | |
| |
1.5 | 31 | **Content of the Document** |
| |
1.2 | 32 | |
| |
1.7 | 33 | The remainder of this document contains a summary of the changes. More detailed information can be found in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.1 Technical Specifications, in particular: |
| |
1.2 | 34 | |
| 35 | Section 2 – Information Model | ||
| 36 | |||
| 37 | Section 5 – Registry Specification | ||
| 38 | |||
| 39 | Section 6 – Technical Notes | ||
| 40 | |||
| |
1.7 | 41 | [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] TWG GitHub for the REST API and the XML and JSON formats |
| |
1.2 | 42 | |
| 43 | = 2. Summary of Breaking Changes in 3.1 = | ||
| 44 | |||
| |
3.2 | 45 | Version 3.1 introduces breaking changes, in the model in the following areas: |
| |
1.2 | 46 | |
| 47 | == 2.1 Removal of Advanced Release Calendar == | ||
| 48 | |||
| |
3.2 | 49 | The Data (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) was simplified to become a cohesive structural [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] focussed solely on the restriction of values that can be reported. As part of this remodelling the Advanced [[Release Calendar>>doc:sdmx:Glossary.Release policy - release calendar.WebHome]] was removed as it does not play a restrictive role. |
| |
1.2 | 50 | |
| 51 | //Guidance for Implementors// | ||
| |
1.7 | 52 | [[Reference Metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] reported against a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] and / or [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] can be used as an alternative to the Advanced [[Release Calendar>>doc:sdmx:Glossary.Release policy - release calendar.WebHome]]. |
| |
1.2 | 53 | |
| |
1.3 | 54 | == 2.2 Removal of Version on Categorisation == |
| |
1.2 | 55 | |
| |
3.2 | 56 | The Categorisation structural [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] has no use case for undergoing (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) changes, the (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) was therefore removed. |
| |
1.2 | 57 | |
| |
1.6 | 58 | //Guidance for Implementors// |
| |
3.2 | 59 | If multiple (% style="color:#e74c3c" %)[[versions>>doc:sdmx:Glossary.Version.WebHome]](%%) of a Categorisation exist where the source or target differs, these Categorisations should be given a unique ID. |
| |
1.2 | 60 | |
| |
1.3 | 61 | = 3. Information Model = |
| |
1.2 | 62 | |
| 63 | The changes to the information model support two distinct use cases: | ||
| 64 | |||
| |
1.7 | 65 | 1. Horizontally complex [[Data Structure Definitions>>doc:sdmx:Glossary.Data structure definition.WebHome]] (DSDs) |
| |
3.2 | 66 | 1. Additional cohesion to the Data (% style="color:#e74c3c" %)[[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]](%%) model |
| |
1.2 | 67 | |
| 68 | These changes are described in below. | ||
| 69 | |||
| |
1.4 | 70 | == 3.1 Horizontally Complex Data Structure Definitions == |
| |
1.2 | 71 | |
| |
3.2 | 72 | An explanation of this use case, with additional details can be found under Section 6 - Technical Notes, under heading ‘10.3 [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%)’. |
| |
1.2 | 73 | |
| 74 | The following changes to the model have been made to satisfy this use case. | ||
| 75 | |||
| |
1.9 | 76 | **Data Structure Definition** |
| |
1.2 | 77 | |
| |
3.2 | 78 | The [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] has a new ‘evolving structure’ property, this is a Boolean property, when set to ‘true’ it indicates to the users of the [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] that new [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] may be added without the [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] undergoing a change to its major (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) number. |
| |
1.2 | 79 | |
| |
1.9 | 80 | **Dataflow** |
| |
1.2 | 81 | |
| |
3.2 | 82 | The [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] has a new [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) property, which is used to reference a subset of [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] which it uses from the referenced [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]]. |
| |
1.2 | 83 | |
| |
3.2 | 84 | The [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) fixes the [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] of the [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] enabling the referenced [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] to have new [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] added without the need to change the major (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) number. |
| |
1.2 | 85 | |
| |
3.2 | 86 | The [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) property is only required if the [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] sets the evolving structure property to true. |
| |
1.2 | 87 | |
| |
1.4 | 88 | == 3.2 Constraint Cohesion == |
| |
1.2 | 89 | |
| |
3.2 | 90 | The (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) model in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.1 has been made more cohesive by separating the Data (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) into two distinct structures; the Data (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) which describes reporting restrictions, and the Availability (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%), which describes data content from a [[data source>>doc:sdmx:Glossary.Data source.WebHome]]. In [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 these distinctions were made using the ‘type’ property on a Data (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%). |
| |
1.2 | 91 | |
| |
3.2 | 92 | **Data [[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]]** |
| |
1.2 | 93 | |
| |
3.2 | 94 | The Data (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) has had the ‘type’ property removed; the Data (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.1 is always used to describe restrictions on content for data reporting purposes. |
| |
1.2 | 95 | |
| |
3.2 | 96 | The attachment of the Data (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 included [[Data Sources>>doc:sdmx:Glossary.Data source.WebHome]], in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.1 these attachments have been removed as these are not relevant for restricting reported data. |
| |
1.2 | 97 | |
| |
3.2 | 98 | **Availability [[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]]** |
| |
1.2 | 99 | |
| |
3.2 | 100 | The Availability (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) is a new Structure introduced to describe data that exists, it is generated in the response to the Availability REST API. It is not a maintained structure, and as such has no [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]], identity or (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]] |