Wiki source code of 1 Overview
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
7.2 | 1 | {{box title="**Contents**"}} |
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| |
2.1 | 5 | **Revision History** |
| 6 | |||
| 7 | |Revision|Date|Contents | ||
| 8 | |DRAFT 1.0|May 2021|Draft release updated for SDMX 3.0 for public consultation | ||
| 9 | |1.0|October 2021|Public Release for SDMX 3.0 | ||
| 10 | |||
| 11 | = 1 Overview = | ||
| 12 | |||
| 13 | SDMX version 3.0 introduces new features, improvements and changes to the Standard in the following key areas: | ||
| 14 | |||
| 15 | **Information Model** | ||
| 16 | |||
| 17 | * Simplification and improvement of the reference metadata model | ||
| 18 | * Support for microdata | ||
| 19 | * Support for geospatial data | ||
| 20 | * Support for code list extension and discriminated union of code lists | ||
| 21 | * Improvements to structure mapping | ||
| 22 | * Improvements to code hierarchies for data discovery | ||
| 23 | * Improvements to constraints | ||
| 24 | |||
| 25 | **Versioning of Structural Metadata Artefacts** | ||
| 26 | |||
| 27 | • Adoption of the three-number semantic versioning standard for structural metadata artefacts [[(>>url:https://semver.org/]][[__https:~~/~~/semver.org__>>url:https://semver.org/]][[)>>url:https://semver.org/]] | ||
| 28 | |||
| 29 | **REST Web Services Application Programming Interface (API)** | ||
| 30 | |||
| 31 | * Change to a single ‘structure’ resource for structure queries simplifying the REST API specification by reducing the number of resources to five | ||
| 32 | * Improvements to data queries | ||
| 33 | * Improvements to reference metadata queries | ||
| 34 | * Support for structural metadata maintenance using HTTP PUT, POST and DELETE verbs | ||
| 35 | |||
| 36 | **SOAP Web Services API** | ||
| 37 | |||
| 38 | • The SOAP web services API has been deprecated with version 3.0 standardising on REST** ** | ||
| 39 | |||
| 40 | **XML, JSON, CSV and EDI Transmission formats** | ||
| 41 | |||
| 42 | * 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 | ||
| 43 | * 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 | ||
| 44 | * The SDMX-EDI transmission format for structures and data has been deprecated | ||
| 45 | * The organisation of structures into ‘collections’ in SDMX-ML and SDMX-JSON structure messages has been flattened and simplified | ||
| 46 | * 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 | ||
| 47 | |||
| 48 | **Breaking Changes** | ||
| 49 | |||
| 50 | 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 | |||
| 52 | A summary of the main breaking changes is given in chapter 2. | ||
| 53 | |||
| 54 | **Content of the Document** | ||
| 55 | |||
| 56 | 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 | |||
| 58 | * Section 2 – Information Model | ||
| 59 | * Section 5 – Registry Specification | ||
| 60 | * Section 6 – Technical Notes | ||
| 61 | * SDMX-TWG GitHub for the REST API and the XML, JSON and CSV formats | ||
| 62 | |||
| 63 | = 2 Summary of Breaking Changes in 3.0 = | ||
| 64 | |||
| 65 | Version 3.0 introduces breaking changes into the web services API, transmission formats and information model. A summary is given in the table below. | ||
| 66 | |||
| 67 | == //2.1 Web Services API// == | ||
| 68 | |||
| 69 | |**REST API**|((( | ||
| 70 | 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: | ||
| 71 | |||
| 72 | * Structure queries | ||
| 73 | * Data queries | ||
| 74 | * Metadata queries | ||
| 75 | * Availability queries | ||
| 76 | |||
| 77 | Schema queries are backwardly compatible. | ||
| 78 | |||
| 79 | //Guidance for implementors// | ||
| 80 | |||
| 81 | REST API implementors may provide partial backward compatibility by using web server URL rewriting rules to translate version 2.1 structure queries to the 3.0 equivalent. | ||
| 82 | |||
| 83 | Implementors are also recommended to version their API services providing users with an explicit choice of which version to use. | ||
| 84 | ))) | ||
| 85 | |**SOAP API**|The SOAP API has been deprecated. | ||
| 86 | |||
| 87 | == //2.2 Transmission Formats// == | ||
| 88 | |||
| |
7.1 | 89 | : |
| |
2.1 | 90 | |
| 91 | ((( | ||
| 92 | |**SDMX-ML**|((( | ||
| 93 | The following legacy XML data messages have been deprecated: | ||
| 94 | |||
| 95 | SDMX-ML 1.0/2.0 Generic (time-series) data message | ||
| 96 | |||
| 97 | SDMX-ML 1.0/2.0 Compact (time-series) data message | ||
| 98 | |||
| 99 | SDMX-ML 1.0/2.0 Utility (time-series) data message | ||
| 100 | |||
| 101 | 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) | ||
| 102 | |||
| 103 | 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. | ||
| 104 | |||
| 105 | The SDMX-ML structure message is not backwardly compatible primarily due to: | ||
| 106 | |||
| 107 | * Changes to the information model | ||
| 108 | * Changes to the way the structures are organised into | ||
| 109 | |||
| 110 | ‘collections’ within the message | ||
| 111 | |||
| 112 | * Deprecation of the Agency, ID, Version option for referencing of structures in messages | ||
| 113 | ))) | ||
| 114 | |**SDMX-JSON**|((( | ||
| 115 | The JSON data message is not backwardly compatible with 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 with potentially different Data Structure Definitions. | ||
| 116 | |||
| 117 | The JSON structure message is not backwardly compatible primarily due to: | ||
| 118 | |||
| 119 | * Changes to the information model | ||
| 120 | * Changes to the way the structures are organised into | ||
| 121 | |||
| 122 | ‘collections’ within the message | ||
| 123 | |||
| 124 | * Deprecation of the Agency, ID, Version option for referencing of structures in messages | ||
| 125 | ))) | ||
| 126 | |**SDMX-EDI**|The EDI format for both structures and data has been deprecated. | ||
| |
7.1 | 127 | |**SDMX-CSV**|The CSV data and reference metadata messages are not backwardly compatible with those under 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.** ** |
| |
2.1 | 128 | ))) |
| 129 | |||
| 130 | == //2.3 Information Model// == | ||
| 131 | |||
| |
7.1 | 132 | : |
| |
2.1 | 133 | |
| 134 | ((( | ||
| 135 | |**Data Structure Definition**|((( | ||
| 136 | The version 3.0 Data Structure Definition (DSD) model is not directly backwardly compatible with 2.1 primarily due to the deprecation of the special MeasureDimension. | ||
| 137 | |||
| 138 | //Conversion guidance for implementors// | ||
| 139 | |||
| 140 | Version 2.1 DSDs can be converted to the 3.0 model by creating a measure with the “MEASURE” concept role applied as described in paragraph 3.5. | ||
| 141 | |||
| 142 | Version 3.0 DSDs cannot be reliably converted to the 2.1 model due to the introduction of new features such as multiple measures and value arrays for measures and attributes. | ||
| 143 | ))) | ||
| 144 | |**Structure mapping model**|((( | ||
| 145 | The structure mapping model has changed significantly in version 3.0 with deprecation of the Structure Set maintainable artefact and introduction of five new ones: Representation Map and four variants of item scheme map. | ||
| 146 | |||
| 147 | //Conversion guidance for implementors// | ||
| 148 | |||
| 149 | Version 2.1 structure sets can be practically converted to the version 3.0 structure mapping model. | ||
| 150 | |||
| 151 | Conversion from the 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 will not be precisely the same as the original. In converting to version 3.0, the system must generate IDs for each of the new maintainable artefacts, but details of the original Structure Set artefacts are lost. | ||
| 152 | ))) | ||
| 153 | |**Reference metadata model**|((( | ||
| 154 | The reference metadata model has changed in version 3.0 with modifications to the role of the Data Structure Definition, Metadata Structure Definition and Metadataflow artefacts. Metadata Provision Agreement and Metadata Provider Scheme have been added. Metadatasets are now identifiable. | ||
| 155 | |||
| 156 | Version 2.1 reference metadata models are not valid in version 3.0. | ||
| 157 | |||
| 158 | //Conversion guidance for implementors// | ||
| 159 | |||
| 160 | A version 2.1 Metadata Structure Definition can be converted to the version 3.0 model under some circumstances, but target information is either lost or has to be translated into a metadataflow. Further, conversion of a Data Structure Definition for collecting reference metadata against a dataset would need to make changes to the dataset’s Data Structure Definition. As the Data Structure Definition may not actually be specified, judgement would need to be taken, perhaps determining the most likely candidate by examining which | ||
| 161 | ))) | ||
| |
7.1 | 162 | | |((( |
| |
2.1 | 163 | already have metadata reported against their datasets. A 2.1 metadata report could be converted to a version 3.0 Metadataset if it is attached to a structure, but requires a Metadata Provision Agreement which would need to be created if not already in existence. |
| 164 | |||
| 165 | Conversion from the version 3.0 model to version 2.1 cannot be performed reliably. The process would need target information to be derived from analysis of the Metadataflows and Metadata Provision Agreements. Depending on the complexity it may not be possible to express that information in a version 2.1 Data Structure Definition. | ||
| 166 | ))) | ||
| 167 | |**Constraint model**|((( | ||
| 168 | The version 2.1 Content Constraint artefact has been deprecated in version 3.0 and replaced by the Data Constraint for data, and the Metadata Constraint for reference metadata. | ||
| 169 | |||
| 170 | //Conversion guidance for implementors// | ||
| 171 | |||
| 172 | 2.1 Content Constraints can be converted without loss to the equivalent version 3.0 Data Constraint model. | ||
| 173 | |||
| 174 | 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. | ||
| 175 | ))) | ||
| 176 | |**Hierarchical codelist structures**|((( | ||
| 177 | The version 2.1 Hierarchical Codelist artefact has been deprecated in version 3.0 and replaced by two new artefacts, Hierarchy and Hierarchy Association. | ||
| 178 | |||
| 179 | //Conversion guidance for implementors// | ||
| 180 | |||
| 181 | Version 2.1 Hierarchical Codelists can be successfully converted to the version 3.0 hierarchy model. Information on which artefacts to link the hierarchies to on what context would need to be added as a separate procedure. | ||
| 182 | |||
| 183 | Conversion from the version 3.0 model to version 2.1 is possible, but with loss of the linking information | ||
| 184 | ))) | ||
| 185 | ))) | ||
| 186 | |||
| 187 | = 3 Information Model = | ||
| 188 | |||
| 189 | == //3.1 Version 3.0 Information Model// == | ||
| 190 | |||
| 191 | [[image:SDMX 3-0-0 Major Changes FINAL-1.0_en_6fc573fe.png||height="404" width="718"]] | ||
| 192 | |||
| 193 | //Figure 1 Version 3.0 simplified Information Model UML class diagram with ‘heat map’ illustrating the areas with most change// | ||
| 194 | |||
| 195 | The schematic above is a simplified UML class diagram of the SDMX 3.0 information model illustrating the major areas of change as a ‘heat map’. Darker colours indicate where new structures have been added in version 3.0 or where structures have been significantly changed. | ||
| 196 | |||
| 197 | A number of ancillary structures including organisation schemes, process and reporting taxonomy are unchanged and have not been shown. Similarly, Organisation Scheme Map and Reporting Taxonomy Map have been omitted for simplicity. A schematic of the 2.1 model is given in Appendix A for comparison purposes. | ||
| 198 | |||
| 199 | == //3.2 Key Changes from Version 2.1// == | ||
| 200 | |||
| 201 | New Maintainable Artefacts | ||
| 202 | |||
| 203 | * Structure Map | ||
| 204 | * Representation Map | ||
| 205 | * Organisation Scheme Map | ||
| 206 | * Concept Scheme Map | ||
| 207 | * Category Scheme Map | ||
| 208 | * Reporting Taxonomy Map | ||
| 209 | * Value List | ||
| 210 | * Hierarchy | ||
| 211 | * Hierarchy Association | ||
| 212 | * Metadata Constraint | ||
| 213 | * Data Constraint | ||
| 214 | * Metadata Provision Agreement | ||
| 215 | * Metadata Provider Scheme | ||
| 216 | * Metadataset | ||
| 217 | |||
| 218 | New Identifiable Artefacts | ||
| 219 | |||
| 220 | * GeoFeatureSetCode | ||
| 221 | * GeoGridCode | ||
| 222 | * Metadata Provider | ||
| 223 | |||
| 224 | Removed Maintainable Artefacts | ||
| 225 | |||
| 226 | * Structure Set – replaced by Structure Map and the four item scheme maps | ||
| 227 | * Hierarchical Codelist – replaced by Hierarchy and Hierarchy Association • Constraint – replaced by Data Constraint and Metadata Constraint | ||
| 228 | |||
| 229 | Changed Maintainable Artefacts | ||
| 230 | |||
| 231 | * Data Structure Definition – support for microdatasets and reference metadata linked to data | ||
| 232 | * Metadataflow – simplifies exchange of reference metadata, in particular those linked to structures | ||
| 233 | * Metadata Structure Definition – simplified model for reference metadata | ||
| 234 | * Codelist – support for codelist extension and geospatial specialised codelists (GeographicCodelist, GeoGridCodelist) | ||
| 235 | * VTL Mapping Scheme – VTL Concept Mapping Scheme removed to align the VTL / SDMX interface with the 3.0 model | ||
| 236 | |||
| 237 | New Component Representation Types | ||
| 238 | |||
| 239 | * GeospatialInformation – a string type where the value is an expression defining a set of geographical features using a purpose-designed syntax | ||
| 240 | |||
| 241 | == //3.3 Areas Unchanged from Version 2.1// == | ||
| 242 | |||
| 243 | The following areas of the information model are unchanged from version 2.1: | ||
| 244 | |||
| 245 | * Categories | ||
| 246 | * Concepts | ||
| 247 | * Data providers | ||
| 248 | * Agencies | ||
| 249 | * Data consumers | ||
| 250 | * VTL transformation and expressions – with the exception of VTL mapping scheme as already noted | ||
| 251 | * Reporting taxonomy | ||
| 252 | * Process | ||
| 253 | |||
| 254 | == //3.4 Reference Metadata// == | ||
| 255 | |||
| 256 | Reference metadata has been substantially re-designed for version 3.0 to simplify the model and better support practical use cases. | ||
| 257 | |||
| 258 | === Simplify Metadata Structure Definition === | ||
| 259 | |||
| 260 | 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. | ||
| 261 | |||
| 262 | [[image:SDMX 3-0-0 Major Changes FINAL-1.0_en_ad5f5c97.png||height="346" width="494"]] | ||
| 263 | |||
| 264 | //Figure 2 version 2.1 Metadata Structure Definition (MSD)// | ||
| 265 | |||
| 266 | [[image:SDMX 3-0-0 Major Changes FINAL-1.0_en_f2695ed5.png||height="172" width="374"]] | ||
| 267 | |||
| 268 | //Figure 3 the simplified version 3.0 MSD// | ||
| 269 | |||
| 270 | === Change to reference metadata reported against data === | ||
| 271 | |||
| 272 | 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. | ||
| 273 | |||
| 274 | 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. | ||
| 275 | |||
| 276 | For completeness, the excerpt also shows: | ||
| 277 | |||
| 278 | * OBS_STATUS – a simple observation-level data attribute | ||
| 279 | * TITLE – a multi-lingual data attribute | ||
| 280 | * SOURCE_AGENCY – a multi-value data attribute | ||
| 281 | |||
| 282 | <Obs xsi:type="dsd:ObsType" OBS_VALUE="112" OBS_STAUS=”A” TIME_PERIOD="2010-09"> | ||
| 283 | |||
| 284 | <!—- complex multi-value and multi-lingual data attributes ~-~-> | ||
| 285 | |||
| 286 | <Comp id="TITLE" xsi:type="ns1:TITLE_ATTRIBUTE"> | ||
| 287 | |||
| 288 | <Value> | ||
| 289 | |||
| 290 | <common:Text xml:lang="en">Some English Text</common:Text> | ||
| 291 | |||
| 292 | <common:Text xml:lang="fr">Quelques textes en anglais</common:Text> | ||
| 293 | |||
| 294 | </Value> | ||
| 295 | |||
| 296 | </Comp> | ||
| 297 | |||
| 298 | <Comp id="SOURCE_AGENCY" xsi:type="ns1:SOURCE_AGENCY_ATTRIBUTE"> | ||
| 299 | |||
| 300 | <Value>4F0</Value> | ||
| 301 | |||
| 302 | <Value>4D0</Value> | ||
| 303 | |||
| 304 | <Value>CZ2</Value> | ||
| 305 | |||
| 306 | </Comp> | ||
| 307 | |||
| 308 | <!—- metadata attributes are reported like in metadata messages ~-~-> | ||
| 309 | |||
| 310 | <Metadata> | ||
| 311 | |||
| 312 | <Attribute id="COLLECTION"> | ||
| 313 | |||
| 314 | <Attribute id="METHOD"> | ||
| 315 | |||
| 316 | <Text lang="en">AAA</Text> | ||
| 317 | |||
| 318 | </Attribute> | ||
| 319 | |||
| 320 | </Attribute> | ||
| 321 | |||
| 322 | <Attribute id="CONTACT"> | ||
| 323 | |||
| 324 | <Value>CONTACT 1</Value> | ||
| 325 | |||
| 326 | <Attribute id="NAME"> | ||
| 327 | |||
| 328 | <Value>Contact 1 Name 1</Value> | ||
| 329 | |||
| 330 | </Attribute> | ||
| 331 | |||
| 332 | <Attribute id="NAME"> | ||
| 333 | |||
| 334 | <Value>Contact 1 Name 2</Value> | ||
| 335 | |||
| 336 | </Attribute> | ||
| 337 | |||
| 338 | </Attribute> | ||
| 339 | |||
| 340 | <Attribute id="CONTACT"> | ||
| 341 | |||
| 342 | <Value>CONTACT 2</Value> | ||
| 343 | |||
| 344 | <Attribute id="NAME"> | ||
| 345 | |||
| 346 | <Value>Contact 2 Name 1</Value> | ||
| 347 | |||
| 348 | </Attribute> | ||
| 349 | |||
| 350 | <Attribute id="NAME"> | ||
| 351 | |||
| 352 | <Value>Contact 2 Name 2</Value> | ||
| 353 | |||
| 354 | </Attribute> | ||
| 355 | |||
| 356 | </Attribute> | ||
| 357 | |||
| 358 | </Metadata> | ||
| 359 | |||
| 360 | </Obs> | ||
| 361 | |||
| 362 | === New - Metadata Provision Agreement === | ||
| 363 | |||
| 364 | 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. | ||
| 365 | |||
| 366 | === Move target to Metadataflow and Metadata Provision Agreement === | ||
| 367 | |||
| 368 | 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. | ||
| 369 | |||
| 370 | === Add maintainable properties to reference metadata === | ||
| 371 | |||
| 372 | 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. | ||
| 373 | |||
| 374 | == //3.5 Microdata Exchange// == | ||
| 375 | |||
| 376 | Several changes have been made the Data Structure Definition to support microdata use cases in addition to aggregated time series. | ||
| 377 | |||
| 378 | === Multiple measures === | ||
| 379 | |||
| 380 | 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 | ||
| 381 | |||
| 382 | Data Structure Definition, and can be either mandatory or conditional. Creating a measure with the “MEASURE” concept role applied emulates the version 2.1 | ||
| 383 | |||
| 384 | MeasureDimension behaviour as illustrated in the SDMX-ML example below: | ||
| 385 | |||
| 386 | <str:MeasureList id=”MeasureDescriptor”> | ||
| 387 | |||
| 388 | <str:Measure id=”OBS_VALUE” minOccurs=”1” maxOccurs=”1” usage=”mandatory” > <str:ConceptIdentity> | ||
| 389 | |||
| 390 | <Ref id=”OBS_VALUE” maintainableParentID=”CONCEPTS” agencyID=”SDMX” maintainableParentVersion=”1.0.0” /> | ||
| 391 | |||
| 392 | </str:ConceptIdentity> | ||
| 393 | |||
| 394 | <str:LocalRepresentation> | ||
| 395 | |||
| 396 | <str:TextFormat textType=”String” isMultiLingual=”true” /> | ||
| 397 | |||
| 398 | </str:LocalRepresentation> | ||
| 399 | |||
| 400 | <str:ConceptRole> | ||
| 401 | |||
| 402 | <Ref id=”MEASURE” maintainableParentID=”SDMX_CONCEPT_ROLES” agencyID=”SDMX” maintainableParentVersion=”1.0.0” /> | ||
| 403 | |||
| 404 | </str:ConceptRole> | ||
| 405 | |||
| 406 | </str:Measure> | ||
| 407 | |||
| 408 | ... | ||
| 409 | |||
| 410 | <str:Measure> | ||
| 411 | |||
| 412 | </str:MeasureList> | ||
| 413 | |||
| 414 | === Multi-value measures and attributes === | ||
| 415 | |||
| 416 | 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 | ||
| 417 | |||
| 418 | //mandatory// or optional. In the SDMX-ML measure example above, the properties | ||
| 419 | |||
| 420 | //minOccurs=”1” maxOccurs=”1” usage=”mandatory”// specify that OBS_VALUE must be 198 reported, and can only consist of a single value. | ||
| 421 | |||
| 422 | === Attributes relationship to measures === | ||
| 423 | |||
| 424 | In addition to attaching attributes to a specific level within the dataset, their relationship 202 to measures can also be defined. | ||
| 425 | |||
| 426 | === Value lists === | ||
| 427 | |||
| 428 | 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. | ||
| 429 | |||
| 430 | That allows ValueItems (the equivalent to Code) to contain symbols like ‘¥’ and ‘€’, but 208 also means they are not identifiable. | ||
| 431 | |||
| 432 | == //3.6 Geospatial Data Exchange// == | ||
| 433 | |||
| 434 | The version 3.0 model has been extended to provide explicit support for geospatial data. | ||
| 435 | |||
| 436 | === GeospatialInformation type === | ||
| 437 | |||
| 438 | 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. | ||
| 439 | |||
| 440 | === Geospatial code lists === | ||
| 441 | |||
| 442 | 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: | ||
| 443 | |||
| 444 | * 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. | ||
| 445 | * GeoGridCodelist – A code list defining a geographical grid composed of cells representing regular squared portions of the Earth. Each item references a cell within the grid. | ||
| 446 | |||
| 447 | === //3.7 Structure Mapping// === | ||
| 448 | |||
| 449 | The Structure Set in version 2.1 is a container for many mapping structures including Data Structure Map, Codelist Map and Concept Map. For version 3.0 the Structure Set artefact has been deprecated and replaced with a number of new maintainables giving better flexibility and reusability, specifically: Structure Map, Concept Scheme Map, Representation Map, Reporting Taxonomy Map, Category Scheme Map and Organisation Scheme Map. | ||
| 450 | |||
| 451 | The version 2.1 Codelist Map been replaced with Representation Map which allows mappings to be defined between any combination of Code Lists, Value Lists and noncoded representations such as text strings and numbers. | ||
| 452 | |||
| 453 | ==== Many-to-many source and target components ==== | ||
| 454 | |||
| 455 | Structure mapping rules may be defined with both multiple source components and multiple target components in contrast to version 2.1 where only one source and target was allowed. That supports many-to-many (n-n) mapping use cases where the output of a mapping rule may be dependent on the combination of a number of input components. For instance: | ||
| 456 | |||
| 457 | Set the output component INDICATOR=”DE_A” if the input components are FREQ=”A” and REF_AREA=”DE”. | ||
| 458 | |||
| 459 | Similarly, an n-n rule may also set the values of any number of output components: | ||
| 460 | |||
| 461 | Set the output components FREQ=”A”, REF_AREA=”DE” if the input component INDICATOR=”DE_A”. | ||
| 462 | |||
| 463 | **Fixed source and target** | ||
| 464 | |||
| 465 | The Structure Map may now define input or output components which have a fixed value. | ||
| 466 | |||
| 467 | ==== Time representations mapping ==== | ||
| 468 | |||
| 469 | Non SDMX time representations may now be described in a Structure Map, allowing them to be mapped into SDMX time formats. | ||
| 470 | |||
| 471 | ==== Regular expression and substring mappings ==== | ||
| 472 | |||
| 473 | All item maps allow the use of regular expressions and substrings to match source values, specifically: Concept Scheme Map, Reporting Taxonomy Map, Category Scheme Map and Organisation Scheme Map. | ||
| 474 | |||
| 475 | ==== Item maps validity period ==== | ||
| 476 | |||
| 477 | Item maps may further define the period for which the mapping is valid, meaning the mapping rule will only be applied if the row of information being mapped is within the period. | ||
| 478 | |||
| 479 | === //3.8 Constraints// === | ||
| 480 | |||
| 481 | Constraints in version 3.0 are modelled using two separate artefacts which replace the version 2.1 content constraint: | ||
| 482 | |||
| 483 | * data constraint for data; and | ||
| 484 | * metadata constraint for reference metadata. | ||
| 485 | |||
| 486 | Metadata constraint differs from its data counterpart in having a simplified cube region model better suited to reference metadata reporting use cases and not carrying details of the constrained targets – that information instead being defined directly within the metadataflow and Metadata Provision Agreement. Thus, metadata related constraints only specify constraints to the values of metadata attributes. | ||
| 487 | |||
| 488 | The ‘%’ wildcard character can now be used when defining cube region constraints to match multiple codes with a single expression, for instance for economic activity, ISIC4_% matches all codes beginning with ‘ISIC4_’ avoiding the need to maintain an explicit list. | ||
| 489 | |||
| 490 | The validity period definition has been moved from the constraint to the individual constraining terms, specifically CubeRegion, DataKeySet and MetadataTargetRegion providing more granular control. | ||
| 491 | |||
| 492 | Attachment constraints have been deprecated due to a lack of use cases. | ||
| 493 | |||
| 494 | === //3.9 Code List Extension// === | ||
| 495 | |||
| 496 | In addition to the two new specialised geospatial forms, the option has been added to define a code list as an extension of, or by inheriting codes from, other lists. An optional prefix can be added to inherited codes to disambiguate duplicates. | ||
| 497 | |||
| 498 | This feature allows new code lists to be easily derived from existing lists without the need to make and manually maintain copies. When querying for extended code list structures using the REST API, the option has been added to retrieve either the definition or the materialised list. Traditional literal lists of codes continue to be supported. | ||
| 499 | |||
| 500 | === //3.10 Discriminated Union of Code Lists// === | ||
| 501 | |||
| 502 | Combining code list extension with wildcarded constraints solves the discriminated union of code lists problem where a classification or breakdown has multiple “variants” which are all valid but mutually exclusive. A common example is economic activity where several alternative classification schemes are in use including ISIC revisions 1 to 4 and NACE as used in the European Community. | ||
| 503 | |||
| 504 | === //3.11 Code Hierarchies// === | ||
| 505 | |||
| 506 | Code hierarchies allow the definition of complex hierarchies of codes from potentially multiple lists for data discovery purposes. Hierarchical Codelist has been deprecated and replaced by two new artefacts: Hierarchy – the actual hierarchy of codes, and Hierarchy Association links hierarchies directly to any other identifiable object, a capability missing 312 from the version 2.1 model. Further, the linkage can be within a particular context, for instance linking a hierarchy to a dimension within the context of a specific Dataflow (dimension REF_AREA in the context of the ECB:EXR Dataflow). | ||
| 507 | |||
| 508 | = 4 Versioning of Structural Metadata Artefacts = | ||
| 509 | |||
| 510 | Version 3.0 adopts semantic versioning principles for versioning of metadata artefacts following the rules set out at [[__https:~~/~~/semver.org__>>url:https://semver.org/]][[.>>url:https://semver.org/]] However, this is not mandatory, and organisations may continue to use the pre-existing two-digit versioning strategy, or not to version artefacts by omitting the //version// property. The version number no longer defaults to 1.0 if not explicitly set. | ||
| 511 | |||
| 512 | Semantic version numbers are three digits: | ||
| 513 | |||
| 514 | MAJOR.MINOR.PATCH | ||
| 515 | |||
| 516 | Where | ||
| 517 | |||
| 518 | * The first digit (major) indicates that changes (either new features or bug fixes) are not backward compatible. | ||
| 519 | * The second digit (minor) indicates that features have been added in a backward compatible manner. | ||
| 520 | * The third digit (patch) indicates that bugs have been fixed in a backward compatible manner. | ||
| 521 | |||
| 522 | Examples: | ||
| 523 | |||
| 524 | SDMX:CL_AREA(1.0.0) | ||
| 525 | |||
| 526 | SDMX:CL_AREA(2.3.2) | ||
| 527 | |||
| 528 | == Dependency management == | ||
| 529 | |||
| 530 | Additional constructs are possible for dependency management when referencing structures. For instance: | ||
| 531 | |||
| 532 | 2.3+.1 Means the currently latest available version >= “2.3.1” and < “3.0.0” (all backwards compatible versions >= “2.3.1”). | ||
| 533 | |||
| 534 | 2+.3.1 Means the currently latest available version >= “2.3.1” (even if not backwards compatible). | ||
| 535 | |||
| 536 | == Draft structures == | ||
| 537 | |||
| 538 | 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. | ||
| 539 | |||
| 540 | MAJOR.MINOR.PATCH-EXTENSION | ||
| 541 | |||
| 542 | 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. | ||
| 543 | |||
| 544 | 1.10.0-unstable Alternative to -draft. | ||
| 545 | |||
| 546 | 1.10.0-notfinal Alternative to -draft. | ||
| 547 | |||
| 548 | The SDMX 2.1 isFinal property is deprecated in 3.0. | ||
| 549 | |||
| 550 | = 5 REST Web Services API = | ||
| 551 | |||
| 552 | == //5.1 Simplified list of resources// == | ||
| 553 | |||
| 554 | The version 3.0 REST API has just five main resources: | ||
| 555 | |||
| 556 | * structure | ||
| 557 | * data | ||
| 558 | * schema | ||
| 559 | * availability | ||
| 560 | * metadata | ||
| 561 | |||
| 562 | All structure and item queries have been organised under the structure resource in contrast to the version 2.1 API which specified a separate resource for each structure. | ||
| 563 | |||
| 564 | This and changes in the URLs and query parameters on the data, availability and metadata resources means that, with the exception of schema queries, the version 3.0 API is not backwardly compatible. | ||
| 565 | |||
| 566 | == //5.2 Improved data queries// == | ||
| 567 | |||
| 568 | Data queries have been changed to provide more granular selections from contexts wider than just a Dataflow. | ||
| 569 | |||
| 570 | === Extend the context of data retrieval === | ||
| 571 | |||
| 572 | Version 2.1 data queries always retrieved data from a single specific Dataflow. In version 3.0, the query context may be specified as: | ||
| 573 | |||
| 574 | * Dataflow; | ||
| 575 | * Data Structure Definition – i.e., all Dataflows that use it; or | ||
| 576 | * Provision Agreement – i.e., all Dataflows associated with it. | ||
| 577 | |||
| 578 | Data queries may also search across datasets, for instance “retrieve all data about a country”. | ||
| 579 | |||
| 580 | === Component-based filters === | ||
| 581 | |||
| 582 | Expressions filtering on individual components can now be included as part of the data query URL. | ||
| 583 | |||
| 584 | /data/dataflow/ESTAT/ICP?c[REF_AREA]=CH&c[CONF_STATUS]=F | ||
| 585 | |||
| 586 | === Support for operators === | ||
| 587 | |||
| 588 | Filter expressions can also include operators. | ||
| 589 | |||
| 590 | /data/dataflow/ESTAT/ICP?c[REF_AREA]=DE&c[ICP_ITEM]=sw:01&c[TIME_PERIOD]=ge:2015 Operators include: | ||
| 591 | |||
| 592 | |eq|Equals | ||
| 593 | |ne|Not equal to | ||
| 594 | |le|Less than | ||
| 595 | |ge|Greater than or equal to | ||
| 596 | |sw|Starts with | ||
| 597 | |||
| 598 | === Support for multiple keys === | ||
| 599 | |||
| 600 | Queries can now specify multiple series keys. | ||
| 601 | |||
| 602 | /data/dataflow/ESTAT/ICP/1.0.0/M…A.ANR,M…A.INX,M…B.CTG | ||
| 603 | |||
| 604 | == //5.3 Improved reference metadata queries// == | ||
| 605 | |||
| 606 | Reference metadata queries have been improved with a number of new options to retrieve metadata reports. | ||
| 607 | |||
| 608 | **Get metadata reports by ID** | ||
| 609 | |||
| 610 | /metadata/metadataset/ESTAT/QUALITY_REPORT/1.0.0 | ||
| 611 | |||
| 612 | **Get metadata reports by Dataflow** | ||
| 613 | |||
| 614 | /metadata/metadataflow/ECB/METHODOLOGY/*/FR2 | ||
| 615 | |||
| 616 | **Get metadata reports about a Data Structure Definition** | ||
| 617 | |||
| 618 | /metadata/structure/datastructure/BIS/BIS_CBS/1.0 | ||
| 619 | |||
| 620 | == //5.4 Structural metadata maintenance// == | ||
| 621 | |||
| 622 | Support has been added for maintenance of structural metadata. | ||
| 623 | |||
| 624 | HTTP verbs PUT, POST and DELETE may be used to submit SDMX-ML or SDMX-JSON structure messages to an SDMX registry for the purposes of adding, updating or deleting structural metadata artefacts. | ||
| 625 | |||
| 626 | = 6 XML, JSON, CSV and EDI Transmission formats = | ||
| 627 | |||
| 628 | == //6.1 SDMX-ML// == | ||
| 629 | |||
| 630 | 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. | ||
| 631 | |||
| 632 | === Structure message === | ||
| 633 | |||
| 634 | 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. | ||
| 635 | |||
| 636 | 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: | ||
| 637 | |||
| 638 | |**Artefact type**|**Version 2.1 Collection**|**Version 3.0 Collection** | ||
| 639 | |AgencyScheme|OrganisationSchemes|AgencySchemes | ||
| 640 | |DataConsumerScheme|OrganisationSchemes|DataConsumerSchemes | ||
| 641 | |DataProviderScheme|OrganisationSchemes|DataProviderSchemes | ||
| 642 | |MetadataProviderScheme|OrganisationSchemes|MetadataProviderSchemes | ||
| 643 | |OrganisationUnitScheme|OrganisationSchemes|OrganisationUnitSchemes | ||
| 644 | |GeographicCodelist|Codelists|GeographicCodelists | ||
| 645 | |GeoGridCodelist|Codelists|GeoGridCodelists | ||
| 646 | |ConceptScheme|Concepts|ConceptSchemes | ||
| 647 | |ValueList|Codelists|ValueLists | ||
| 648 | |StructureMap|StructureMappings|StructureMaps | ||
| 649 | |RepresentationMap|StructureMappings|RepresentationMaps | ||
| 650 | |ConceptSchemeMap|StructureMappings|ConceptSchemeMaps | ||
| 651 | |CategorySchemeMap|StructureMappings|CategorySchemeMaps | ||
| 652 | |OrganisationSchemeMap|StructureMappings|OrganisationSchemeMaps | ||
| 653 | |ReportingTaxonomyMap|StructureMappings|ReportingTaxonomyMaps | ||
| 654 | |DataConstraint|Constraints|DataConstraints | ||
| 655 | |MetadataConstraint|Constraints|MetadataConstraints | ||
| 656 | |MetadataProvisionAgreement|ProvisionAgreement|MetadataProvisionAgreements | ||
| 657 | |CustomTypeScheme|CustomTypes|CustomTypeSchemes | ||
| 658 | |VtlMappingScheme|VtlMappings|VtlMappingSchemes | ||
| 659 | |NamePersonalisationScheme|NamePersonalisations|NamePersonalisationSchemes | ||
| 660 | |RulesetScheme|Rulesets|RulesetSchemes | ||
| 661 | |TransformationScheme|Transformations|TransformationSchemes | ||
| 662 | |UserDefinedOperatorScheme|UserDefinedOperators|UserDefinedOperatorSchemes | ||
| 663 | |||
| 664 | No changes have been made to the way the following artefacts are organised in the structure message: | ||
| 665 | |||
| 666 | |**Artefact type**|**Collection** | ||
| 667 | |Dataflow|Dataflows | ||
| 668 | |Metadataflow|Metadataflows | ||
| 669 | |CategoryScheme|CategorySchemes | ||
| 670 | |Categorisation|Categorisations | ||
| 671 | |Codelist|Codelists | ||
| 672 | |Hierarchy|Hierarchies | ||
| 673 | |HierarchyAssociation|HierarchyAssociations | ||
| 674 | |MetadataStructure|MetadataStructures | ||
| 675 | |DataStructure|DataStructures | ||
| 676 | |ReportingTaxonomy|ReportingTaxonomies | ||
| 677 | |Process|Processes | ||
| 678 | |ProvisionAgreement|ProvisionAgreements | ||
| 679 | |||
| 680 | From version 3.0, collections can appear in any order within a structure message. | ||
| 681 | |||
| 682 | === Data messages === | ||
| 683 | |||
| 684 | 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. | ||
| 685 | |||
| 686 | Specifically, the following data messages are not supported in version 3.0: | ||
| 687 | |||
| 688 | * SDMX-ML 1.0/2.0 Generic (time-series) data message | ||
| 689 | * SDMX-ML 1.0/2.0 Compact (time-series) data message | ||
| 690 | * SDMX-ML 1.0/2.0 Utility (time-series) data message | ||
| 691 | * SDMX-ML 1.0/2.0 Cross-Sectional data message | ||
| 692 | * SDMX-ML 2.1 Generic data messages (for observations, time-series and crosssectional data) | ||
| 693 | |||
| 694 | The Structure Specific Data message has been extended to support the transmission of microdata sets, in particular those with multiple measures and array values for measures and attributes. | ||
| 695 | |||
| 696 | As detailed in paragraph 3.4, the message now additionally allows data’s reference metadata to be reported as an integral part of the dataset. Like data attributes, these metadata attributes are included in the data message at the dataset, series or observation level as appropriate. | ||
| 697 | |||
| 698 | The time series variant of the Structure Specific Data message is no longer used. | ||
| 699 | |||
| 700 | === Reference metadata message === | ||
| 701 | |||
| 702 | 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. | ||
| 703 | |||
| 704 | === Registry structural metadata ‘query’ messages === | ||
| 705 | |||
| 706 | 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. | ||
| 707 | |||
| 708 | === Structure referencing === | ||
| 709 | |||
| 710 | 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. | ||
| 711 | |||
| 712 | == //6.2 SDMX-JSON// == | ||
| 713 | |||
| 714 | 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. | ||
| 715 | |||
| 716 | === Structure message === | ||
| 717 | |||
| 718 | 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. | ||
| 719 | |||
| 720 | === Data message === | ||
| 721 | |||
| 722 | 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. | ||
| 723 | |||
| 724 | === Reference metadata message === | ||
| 725 | |||
| 726 | The SDMX-JSON metadata message has also been updated to support the version 3.0 reference metadata and Metadataset specifications. | ||
| 727 | |||
| 728 | === Structure referencing === | ||
| 729 | |||
| 730 | 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. | ||
| 731 | |||
| 732 | == //6.3 SDMX-CSV// == | ||
| 733 | |||
| 734 | CSV in SDMX is used transmission of data and reference metadata only. | ||
| 735 | |||
| 736 | === Data message === | ||
| 737 | |||
| 738 | 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: | ||
| 739 | |||
| 740 | * 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 | ||
| 741 | |||
| 742 | ESTAT:NA_MAIN(1.6.0) which replaces the dataflow identifier in version 2.1; and | ||
| 743 | |||
| 744 | * 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. | ||
| 745 | |||
| 746 | === Reference metadata message === | ||
| 747 | |||
| 748 | 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. | ||
| 749 | |||
| 750 | === //6.4 EDI deprecation// === | ||
| 751 | |||
| 752 | 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. | ||
| 753 | |||
| 754 | = Appendix A – Version 2.1 Information Model = | ||
| 755 | |||
| 756 | [[image:SDMX 3-0-0 Major Changes FINAL-1.0_en_5f21cdf9.png||height="319" width="718"]] |