Skip to Content
Last modified by Helena on 2025/09/10 11:19
From version 23.1
edited by Artur
on 2025/05/22 14:49
Change comment: There is no comment for this version
To version 25.1
edited by Helena
on 2025/05/23 12:16
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.arturkryazhev
1 +xwiki:XWiki.helena
Content
... ... @@ -77,11 +77,9 @@
77 77  * Availability queries
78 78  
79 79  Schema queries are backwardly compatible.
80 -
81 81  //Guidance for implementors//
82 82  
83 83  REST API implementors may provide partial backward compatibility by using web server URL rewriting rules to translate (% style="color:#e74c3c" %)version(%%) 2.1 structure queries to the 3.0 equivalent.
84 -
85 85  Implementors are also recommended to (% style="color:#e74c3c" %)version(%%) their API services providing users with an explicit choice of which (% style="color:#e74c3c" %)version(%%) to use.
86 86  )))
87 87  |**SOAP API**|(% style="width:818px" %)The SOAP API has been deprecated.
... ... @@ -96,10 +96,8 @@
96 96  [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]] 1.0/2.0 Generic (time-series) data message
97 97  [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]] 1.0/2.0 Compact (time-series) data message
98 98  [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]] 1.0/2.0 Utility (time-series) data message
99 -[[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]] 1.0/2.0 Cross-Sectional data message [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]] 2.1 Generic data messages (for observations, time-series and cross-sectional data)
100 -
97 +[[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]] 1.0/2.0 Cross-Sectional data message [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]] 2.1 Generic data messages (for observations, time-series and cross-sectional data)
101 101  Structure Specific is the only data message option in (% style="color:#e74c3c" %)version(%%) 3.0 but is not backwardly compatible with (% style="color:#e74c3c" %)version(%%) 2.1 due to several changes including deprecation of the option to reference structures like the [[DSD>>doc:Glossary.Data structure definition.WebHome]], [[Dataflow>>doc:Glossary.Dataflow.WebHome]] and [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]] using their Agency, ID and (% style="color:#e74c3c" %)Version(%%). The time series variant of the message has also been deprecated.
102 -
103 103  The [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]] structure message is not backwardly compatible primarily due to:
104 104  
105 105  * Changes to the information model
... ... @@ -108,7 +108,6 @@
108 108  )))
109 109  |(% style="width:130px" %)**SDMX-JSON**|(% style="width:820px" %)(((
110 110  The JSON data message is not backwardly compatible with (% style="color:#e74c3c" %)version(%%) 2.1 primarily due to changes needed to support the improved REST API data queries, in particular the ability to retrieve in one operation data from multiple [[datasets>>doc:Glossary.Data set.WebHome]] with potentially different Data Structure Definitions.
111 -
112 112  The JSON structure message is not backwardly compatible primarily due to:
113 113  
114 114  * Changes to the information model
... ... @@ -129,7 +129,6 @@
129 129  //Conversion guidance for implementors//
130 130  
131 131  (% style="color:#e74c3c" %)Version(%%) 2.1 DSDs can be converted to the 3.0 model by creating a [[measure>>doc:Glossary.Measure.WebHome]] with the “[[MEASURE>>doc:Glossary.Measure.WebHome]]” (% style="color:#e74c3c" %)concept(%%) role applied as described in paragraph 3.5.
132 -
133 133  (% style="color:#e74c3c" %)Version(%%) 3.0 DSDs cannot be reliably converted to the 2.1 model due to the introduction of new features such as multiple [[measures>>doc:Glossary.Measure.WebHome]] and value arrays for [[measures>>doc:Glossary.Measure.WebHome]] and [[attributes>>doc:Glossary.Attribute.WebHome]].
134 134  )))
135 135  |(% style="width:132px" %)**Structure mapping model**|(% style="width:819px" %)(((
... ... @@ -138,7 +138,6 @@
138 138  //Conversion guidance for implementors//
139 139  
140 140  (% style="color:#e74c3c" %)Version(%%) 2.1 [[structure sets>>doc:Glossary.Structure set.WebHome]] can be practically converted to the (% style="color:#e74c3c" %)version(%%) 3.0 structure mapping model.
141 -
142 142  Conversion from the (% style="color:#e74c3c" %)version(%%) 3.0 structure mapping model to 2.1 is generally possible. However, when attempting to convert mapping rules from 2.1 to 3.0 and back to 2.1, the resulting [[Structure Set>>doc:Glossary.Structure set.WebHome]] will not be precisely the same as the original. In converting to (% style="color:#e74c3c" %)version(%%) 3.0, the system must generate IDs for each of the new [[maintainable artefacts>>doc:Glossary.Maintainable artefact.WebHome]], but details of the original [[Structure Set>>doc:Glossary.Structure set.WebHome]] [[artefacts>>doc:Glossary.Artefact.WebHome]] are lost.
143 143  )))
144 144  |(% style="width:132px" %)**Reference metadata model**|(% style="width:819px" %)(((
... ... @@ -149,7 +149,6 @@
149 149  //Conversion guidance for implementors//
150 150  
151 151  A (% style="color:#e74c3c" %)version(%%) 2.1 [[Metadata Structure Definition>>doc:Glossary.Metadata structure definition.WebHome]] can be converted to the (% style="color:#e74c3c" %)version(%%) 3.0 model under some circumstances, but target information is either lost or has to be translated into a [[metadataflow>>doc:Glossary.Metadataflow.WebHome]]. Further, conversion of a [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]] for collecting [[reference metadata>>doc:Glossary.Reference metadata.WebHome]] against a [[dataset>>doc:Glossary.Data set.WebHome]] would need to make changes to the [[dataset>>doc:Glossary.Data set.WebHome]]’s [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]]. As the [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]] may not actually be specified, judgement would need to be taken, perhaps determining the most likely candidate by examining which already have metadata reported against their [[datasets>>doc:Glossary.Data set.WebHome]]. A 2.1 metadata report could be converted to a (% style="color:#e74c3c" %)version(%%) 3.0 Metadataset if it is attached to a structure, but requires a Metadata [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]] which would need to be created if not already in existence.
152 -
153 153  Conversion from the (% style="color:#e74c3c" %)version(%%) 3.0 model to (% style="color:#e74c3c" %)version(%%) 2.1 cannot be performed reliably. The process would need target information to be derived from analysis of the [[Metadataflows>>doc:Glossary.Metadataflow.WebHome]] and Metadata [[Provision Agreements>>doc:Glossary.Provision agreement.WebHome]]. Depending on the complexity it may not be possible to express that information in a (% style="color:#e74c3c" %)version(%%) 2.1 [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]].
154 154  )))
155 155  |(% style="width:132px" %)**Constraint model**|(% style="width:819px" %)(((
... ... @@ -158,7 +158,6 @@
158 158  //Conversion guidance for implementors//
159 159  
160 160  2.1 Content (% style="color:#e74c3c" %)Constraints(%%) can be converted without loss to the equivalent (% style="color:#e74c3c" %)version(%%) 3.0 Data (% style="color:#e74c3c" %)Constraint(%%) model.
161 -
162 162  Conversion from 3.0 to 2.1 presents challenges where wildcards have been used, in those cases requiring expansion of the wildcard into explicit values.
163 163  )))
164 164  |(% style="width:132px" %)**Hierarchical codelist structures**|(% style="width:819px" %)(((
... ... @@ -167,7 +167,6 @@
167 167  //Conversion guidance for implementors//
168 168  
169 169  (% style="color:#e74c3c" %)Version(%%) 2.1 Hierarchical Codelists can be successfully converted to the (% style="color:#e74c3c" %)version(%%) 3.0 [[hierarchy>>doc:Glossary.Hierarchy.WebHome]] model. Information on which [[artefacts>>doc:Glossary.Artefact.WebHome]] to link the [[hierarchies>>doc:Glossary.Hierarchy.WebHome]] to on what context would need to be added as a separate procedure.
170 -
171 171  Conversion from the (% style="color:#e74c3c" %)version(%%) 3.0 model to (% style="color:#e74c3c" %)version(%%) 2.1 is possible, but with loss of the linking information
172 172  )))
173 173  )))
... ... @@ -180,7 +180,7 @@
180 180  
181 181  //Figure 1 Version 3.0 simplified Information Model UML class diagram with ‘heat map’ illustrating the areas with most change//
182 182  
183 -The schematic above is a simplified UML class diagram of the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 information model illustrating the major areas of change as a ‘heat (% style="color:#e74c3c" %)map(%%)’. Darker colours indicate where new structures have been added in (% style="color:#e74c3c" %)version(%%) 3.0 or where structures have been significantly changed.
173 +The schematic above is a simplified UML class diagram of the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 information model illustrating the major areas of change as a ‘heat map’. Darker colours indicate where new structures have been added in (% style="color:#e74c3c" %)version(%%) 3.0 or where structures have been significantly changed.
184 184  
185 185  A number of ancillary structures including organisation schemes, process and [[reporting taxonomy>>doc:Glossary.Reporting taxonomy.WebHome]] are unchanged and have not been shown. Similarly, Organisation Scheme (% style="color:#e74c3c" %)Map(%%) and [[Reporting Taxonomy>>doc:Glossary.Reporting taxonomy.WebHome]] (% style="color:#e74c3c" %)Map(%%) have been omitted for simplicity. A schematic of the 2.1 model is given in Appendix A for comparison purposes.
186 186  
... ... @@ -455,7 +455,8 @@
455 455  SDMX:CL_AREA(1.0.0)
456 456  SDMX:CL_AREA(2.3.2)
457 457  
458 -== Dependency management ==
448 +(% class="wikigeneratedid" id="HDependencymanagement" %)
449 +**Dependency management**
459 459  
460 460  Additional constructs are possible for dependency management when referencing structures. For instance:
461 461  
... ... @@ -462,7 +462,8 @@
462 462  2.3+.1  Means the currently latest available (% style="color:#e74c3c" %)version(%%) >= “2.3.1” and < “3.0.0” (all backwards compatible (% style="color:#e74c3c" %)versions(%%) >= “2.3.1”).
463 463  2+.3.1  Means the currently latest available (% style="color:#e74c3c" %)version(%%) >= “2.3.1” (even if not backwards compatible).
464 464  
465 -== Draft structures ==
456 +(% class="wikigeneratedid" id="HDraftstructures" %)
457 +**Draft structures**
466 466  
467 467  A key principle is that semantically versioned structures are immutable and must not be changed without a corresponding change to the (% style="color:#e74c3c" %)version(%%) number, except where explicitly marked as draft using extensions to the (% style="color:#e74c3c" %)version(%%) number.
468 468