Changes for page SDMX 3.0 Standards. Summary of Major Changes and New Functionality
Last modified by Helena on 2025/09/10 11:19
Summary
-
Page properties (4 modified, 0 added, 0 removed)
-
Objects (0 modified, 1 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 - 1Overview1 +SDMX STANDARDS - Parent
-
... ... @@ -1,0 +1,1 @@ 1 +Methodology.WebHome - Content
-
... ... @@ -65,7 +65,7 @@ 65 65 66 66 Version 3.0 introduces breaking changes into the web services API, transmission formats and information model. A summary is given in the table below. 67 67 68 -== //2.1 Web Services API//==68 +== 2.1 Web Services API == 69 69 70 70 (% style="width:948.039px" %) 71 71 |**REST API**|(% style="width:818px" %)((( ... ... @@ -86,7 +86,7 @@ 86 86 ))) 87 87 |**SOAP API**|(% style="width:818px" %)The SOAP API has been deprecated. 88 88 89 -== //2.2 Transmission Formats//==89 +== 2.2 Transmission Formats == 90 90 91 91 ((( 92 92 (% style="width:952.039px" %) ... ... @@ -122,7 +122,7 @@ 122 122 |(% style="width:130px" %)**SDMX-CSV**|(% style="width:820px" %)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. 123 123 ))) 124 124 125 -== //2.3 Information Model//==125 +== 2.3 Information Model == 126 126 127 127 ((( 128 128 (% style="width:955.039px" %) ... ... @@ -177,7 +177,7 @@ 177 177 178 178 = 3 Information Model = 179 179 180 -== //3.1 Version 3.0 Information Model//==180 +== 3.1 Version 3.0 Information Model == 181 181 182 182 [[image:SDMX 3-0-0 Major Changes FINAL-1.0_en_6fc573fe.png||height="404" width="718"]] 183 183 ... ... @@ -187,7 +187,7 @@ 187 187 188 188 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. 189 189 190 -== //3.2 Key Changes from Version 2.1//==190 +== 3.2 Key Changes from Version 2.1 == 191 191 192 192 New Maintainable Artefacts 193 193 ... ... @@ -215,7 +215,8 @@ 215 215 Removed Maintainable Artefacts 216 216 217 217 * Structure Set – replaced by Structure Map and the four item scheme maps 218 -* Hierarchical Codelist – replaced by Hierarchy and Hierarchy Association • Constraint – replaced by Data Constraint and Metadata Constraint 218 +* Hierarchical Codelist – replaced by Hierarchy and Hierarchy Association 219 +* Constraint – replaced by Data Constraint and Metadata Constraint 219 219 220 220 Changed Maintainable Artefacts 221 221 ... ... @@ -229,7 +229,7 @@ 229 229 230 230 * GeospatialInformation – a string type where the value is an expression defining a set of geographical features using a purpose-designed syntax 231 231 232 -== //3.3 Areas Unchanged from Version 2.1//==233 +== 3.3 Areas Unchanged from Version 2.1 == 233 233 234 234 The following areas of the information model are unchanged from version 2.1: 235 235 ... ... @@ -242,12 +242,12 @@ 242 242 * Reporting taxonomy 243 243 * Process 244 244 245 -== //3.4 Reference Metadata//==246 +== 3.4 Reference Metadata == 246 246 247 247 Reference metadata has been substantially re-designed for version 3.0 to simplify the model and better support practical use cases. 248 248 249 -= ==SimplifyMetadataStructureDefinition===250 - 250 +(% class="wikigeneratedid" id="HSimplifyMetadataStructureDefinition" %) 251 +**Simplify Metadata Structure Definition** 251 251 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. 252 252 253 253 [[image:SDMX 3-0-0 Major Changes FINAL-1.0_en_ad5f5c97.png||height="346" width="494"]] ... ... @@ -258,8 +258,8 @@ 258 258 259 259 //Figure 3 the simplified version 3.0 MSD// 260 260 261 -= ==Changetoreferencemetadatareportedagainstdata===262 - 262 +(% class="wikigeneratedid" id="HChangetoreferencemetadatareportedagainstdata" %) 263 +**Change to reference metadata reported against data** 263 263 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. 264 264 265 265 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. ... ... @@ -270,158 +270,96 @@ 270 270 * TITLE – a multi-lingual data attribute 271 271 * SOURCE_AGENCY – a multi-value data attribute 272 272 273 -<Obs xsi:type="dsd:ObsType" OBS_VALUE="112" OBS_STAUS=”A” TIME_PERIOD="2010-09"> 274 +> <Obs xsi:type="dsd:ObsType" OBS_VALUE="112" OBS_STAUS=”A” TIME_PERIOD="2010-09"> 275 +> <!—- complex multi-value and multi-lingual data attributes ~-~-> 276 +> <Comp id="TITLE" xsi:type="ns1:TITLE_ATTRIBUTE"> 277 +> <Value> 278 +> <common:Text xml:lang="en">Some English Text</common:Text> 279 +> <common:Text xml:lang="fr">Quelques textes en anglais</common:Text> 280 +> </Value> 281 +> </Comp> 282 +> <Comp id="SOURCE_AGENCY" xsi:type="ns1:SOURCE_AGENCY_ATTRIBUTE"> 283 +> <Value>4F0</Value> 284 +> <Value>4D0</Value> 285 +> <Value>CZ2</Value> 286 +> </Comp> 287 +> <!—- metadata attributes are reported like in metadata messages ~-~-> 288 +> <Metadata> 289 +> <Attribute id="COLLECTION"> 290 +> <Attribute id="METHOD"> 291 +> <Text lang="en">AAA</Text> 292 +> </Attribute> 293 +> </Attribute> 294 +> <Attribute id="CONTACT"> 295 +> <Value>CONTACT 1</Value> 296 +> <Attribute id="NAME"> 297 +> <Value>Contact 1 Name 1</Value> 298 +> </Attribute> 299 +> <Attribute id="NAME"> 300 +> <Value>Contact 1 Name 2</Value> 301 +> </Attribute> 302 +> </Attribute> 303 +> <Attribute id="CONTACT"> 304 +> <Value>CONTACT 2</Value> 305 +> <Attribute id="NAME"> 306 +> <Value>Contact 2 Name 1</Value> 307 +> </Attribute> 308 +> <Attribute id="NAME"> 309 +> <Value>Contact 2 Name 2</Value> 310 +> </Attribute> 311 +> </Attribute> 312 +> </Metadata> 313 +> </Obs> 274 274 275 -<!—- complex multi-value and multi-lingual data attributes ~-~-> 276 - 277 -<Comp id="TITLE" xsi:type="ns1:TITLE_ATTRIBUTE"> 278 - 279 -<Value> 280 - 281 -<common:Text xml:lang="en">Some English Text</common:Text> 282 - 283 -<common:Text xml:lang="fr">Quelques textes en anglais</common:Text> 284 - 285 -</Value> 286 - 287 -</Comp> 288 - 289 -<Comp id="SOURCE_AGENCY" xsi:type="ns1:SOURCE_AGENCY_ATTRIBUTE"> 290 - 291 -<Value>4F0</Value> 292 - 293 -<Value>4D0</Value> 294 - 295 -<Value>CZ2</Value> 296 - 297 -</Comp> 298 - 299 -<!—- metadata attributes are reported like in metadata messages ~-~-> 300 - 301 -<Metadata> 302 - 303 -<Attribute id="COLLECTION"> 304 - 305 -<Attribute id="METHOD"> 306 - 307 -<Text lang="en">AAA</Text> 308 - 309 -</Attribute> 310 - 311 -</Attribute> 312 - 313 -<Attribute id="CONTACT"> 314 - 315 -<Value>CONTACT 1</Value> 316 - 317 -<Attribute id="NAME"> 318 - 319 -<Value>Contact 1 Name 1</Value> 320 - 321 -</Attribute> 322 - 323 -<Attribute id="NAME"> 324 - 325 -<Value>Contact 1 Name 2</Value> 326 - 327 -</Attribute> 328 - 329 -</Attribute> 330 - 331 -<Attribute id="CONTACT"> 332 - 333 -<Value>CONTACT 2</Value> 334 - 335 -<Attribute id="NAME"> 336 - 337 -<Value>Contact 2 Name 1</Value> 338 - 339 -</Attribute> 340 - 341 -<Attribute id="NAME"> 342 - 343 -<Value>Contact 2 Name 2</Value> 344 - 345 -</Attribute> 346 - 347 -</Attribute> 348 - 349 -</Metadata> 350 - 351 -</Obs> 352 - 353 -=== New - Metadata Provision Agreement === 354 - 315 +(% class="wikigeneratedid" id="HNew-MetadataProvisionAgreement" %) 316 +**New - Metadata Provision Agreement** 355 355 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. 356 356 357 -= ==MovetargettoMetadataflowandMetadataProvisionAgreement===358 - 319 +(% class="wikigeneratedid" id="HMovetargettoMetadataflowandMetadataProvisionAgreement" %) 320 +**Move target to Metadataflow and Metadata Provision Agreement** 359 359 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. 360 360 361 -= ==Addmaintainablepropertiestoreferencemetadata===362 - 323 +(% class="wikigeneratedid" id="HAddmaintainablepropertiestoreferencemetadata" %) 324 +**Add maintainable properties to reference metadata** 363 363 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. 364 364 365 -== //3.5 Microdata Exchange//==327 +== 3.5 Microdata Exchange == 366 366 367 367 Several changes have been made the Data Structure Definition to support microdata use cases in addition to aggregated time series. 368 368 369 -=== Multiple measures === 331 +(% class="wikigeneratedid" id="HMultiplemeasures" %) 332 +**Multiple measures** 333 +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 Data Structure Definition, and can be either mandatory or conditional. Creating a measure with the “MEASURE” concept role applied emulates the version 2.1 MeasureDimension behaviour as illustrated in the SDMX-ML example below: 370 370 371 -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 335 +> <str:MeasureList id=”MeasureDescriptor”> 336 +> <str:Measure id=”OBS_VALUE” minOccurs=”1” maxOccurs=”1” usage=”mandatory” > <str:ConceptIdentity> 337 +> <Ref id=”OBS_VALUE” maintainableParentID=”CONCEPTS” agencyID=”SDMX” maintainableParentVersion=”1.0.0” /> 338 +> </str:ConceptIdentity> 339 +> <str:LocalRepresentation> 340 +> <str:TextFormat textType=”String” isMultiLingual=”true” /> 341 +> </str:LocalRepresentation> 342 +> <str:ConceptRole> 343 +> <Ref id=”MEASURE” maintainableParentID=”SDMX_CONCEPT_ROLES” agencyID=”SDMX” maintainableParentVersion=”1.0.0” /> 344 +> </str:ConceptRole> 345 +> </str:Measure> 346 +> ... 347 +> <str:Measure> 348 +> </str:MeasureList> 372 372 373 -Data Structure Definition, and can be either mandatory or conditional. Creating a measure with the “MEASURE” concept role applied emulates the version 2.1 350 +(% class="wikigeneratedid" id="HMulti-valuemeasuresandattributes" %) 351 +**Multi-value measures and attributes** 352 +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 //mandatory// or optional. In the SDMX-ML measure example above, the properties //minOccurs=”1” maxOccurs=”1” usage=”mandatory”// specify that OBS_VALUE must be 198 reported, and can only consist of a single value. 374 374 375 -MeasureDimension behaviour as illustrated in the SDMX-ML example below: 376 - 377 -<str:MeasureList id=”MeasureDescriptor”> 378 - 379 -<str:Measure id=”OBS_VALUE” minOccurs=”1” maxOccurs=”1” usage=”mandatory” > <str:ConceptIdentity> 380 - 381 -<Ref id=”OBS_VALUE” maintainableParentID=”CONCEPTS” agencyID=”SDMX” maintainableParentVersion=”1.0.0” /> 382 - 383 -</str:ConceptIdentity> 384 - 385 -<str:LocalRepresentation> 386 - 387 -<str:TextFormat textType=”String” isMultiLingual=”true” /> 388 - 389 -</str:LocalRepresentation> 390 - 391 -<str:ConceptRole> 392 - 393 -<Ref id=”MEASURE” maintainableParentID=”SDMX_CONCEPT_ROLES” agencyID=”SDMX” maintainableParentVersion=”1.0.0” /> 394 - 395 -</str:ConceptRole> 396 - 397 -</str:Measure> 398 - 399 -... 400 - 401 -<str:Measure> 402 - 403 -</str:MeasureList> 404 - 405 -=== Multi-value measures and attributes === 406 - 407 -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 408 - 409 -//mandatory// or optional. In the SDMX-ML measure example above, the properties 410 - 411 -//minOccurs=”1” maxOccurs=”1” usage=”mandatory”// specify that OBS_VALUE must be 198 reported, and can only consist of a single value. 412 - 413 -=== Attributes relationship to measures === 414 - 354 +(% class="wikigeneratedid" id="HAttributesrelationshiptomeasures" %) 355 +**Attributes relationship to measures** 415 415 In addition to attaching attributes to a specific level within the dataset, their relationship 202 to measures can also be defined. 416 416 417 -=== Value lists === 358 +(% class="wikigeneratedid" id="HValuelists" %) 359 +**Value lists** 360 +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. That allows ValueItems (the equivalent to Code) to contain symbols like ‘¥’ and ‘€’, but also means they are not identifiable. 418 418 419 - Valuelistshelp in modelling microdata byprovidingan enumeration similar to codelists206 butallowing any string valueswithout beingrestrictedto the rules of SDMX identifiers.362 +== 3.6 Geospatial Data Exchange == 420 420 421 -That allows ValueItems (the equivalent to Code) to contain symbols like ‘¥’ and ‘€’, but 208 also means they are not identifiable. 422 - 423 -== //3.6 Geospatial Data Exchange// == 424 - 425 425 The version 3.0 model has been extended to provide explicit support for geospatial data. 426 426 427 427 === GeospatialInformation type === ... ... @@ -435,14 +435,14 @@ 435 435 * 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. 436 436 * 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. 437 437 438 -== =//3.7 Structure Mapping//===377 +== 3.7 Structure Mapping == 439 439 440 440 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. 441 441 442 442 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. 443 443 444 -= ===Many-to-manysourceandtargetcomponents====445 - 383 +(% class="wikigeneratedid" id="HMany-to-manysourceandtargetcomponents" %) 384 +**Many-to-many source and target components** 446 446 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: 447 447 448 448 Set the output component INDICATOR=”DE_A” if the input components are FREQ=”A” and REF_AREA=”DE”. ... ... @@ -452,22 +452,21 @@ 452 452 Set the output components FREQ=”A”, REF_AREA=”DE” if the input component INDICATOR=”DE_A”. 453 453 454 454 **Fixed source and target** 455 - 456 456 The Structure Map may now define input or output components which have a fixed value. 457 457 458 -= ===Timerepresentationsmapping====459 - 396 +(% class="wikigeneratedid" id="HTimerepresentationsmapping" %) 397 +**Time representations mapping** 460 460 Non SDMX time representations may now be described in a Structure Map, allowing them to be mapped into SDMX time formats. 461 461 462 -= ===Regularexpressionandsubstringmappings====463 - 400 +(% class="wikigeneratedid" id="HRegularexpressionandsubstringmappings" %) 401 +**Regular expression and substring mappings** 464 464 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. 465 465 466 -= ===Itemmapsvalidityperiod====467 - 404 +(% class="wikigeneratedid" id="HItemmapsvalidityperiod" %) 405 +**Item maps validity period** 468 468 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. 469 469 470 -== =//3.8 Constraints//===408 +== 3.8 Constraints == 471 471 472 472 Constraints in version 3.0 are modelled using two separate artefacts which replace the version 2.1 content constraint: 473 473 ... ... @@ -482,17 +482,17 @@ 482 482 483 483 Attachment constraints have been deprecated due to a lack of use cases. 484 484 485 -== =//3.9 Code List Extension//===423 +== 3.9 Code List Extension == 486 486 487 487 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. 488 488 489 489 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. 490 490 491 -== =//3.10 Discriminated Union of Code Lists//===429 +== 3.10 Discriminated Union of Code Lists == 492 492 493 493 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. 494 494 495 -== =//3.11 Code Hierarchies//===433 +== 3.11 Code Hierarchies == 496 496 497 497 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). 498 498 ... ... @@ -540,7 +540,7 @@ 540 540 541 541 = 5 REST Web Services API = 542 542 543 -== //5.1 Simplified list of resources//==481 +== 5.1 Simplified list of resources == 544 544 545 545 The version 3.0 REST API has just five main resources: 546 546 ... ... @@ -554,7 +554,7 @@ 554 554 555 555 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. 556 556 557 -== //5.2 Improved data queries//==495 +== 5.2 Improved data queries == 558 558 559 559 Data queries have been changed to provide more granular selections from contexts wider than just a Dataflow. 560 560 ... ... @@ -593,7 +593,7 @@ 593 593 594 594 /data/dataflow/ESTAT/ICP/1.0.0/M…A.ANR,M…A.INX,M…B.CTG 595 595 596 -== //5.3 Improved reference metadata queries//==534 +== 5.3 Improved reference metadata queries == 597 597 598 598 Reference metadata queries have been improved with a number of new options to retrieve metadata reports. 599 599 ... ... @@ -609,7 +609,7 @@ 609 609 610 610 /metadata/structure/datastructure/BIS/BIS_CBS/1.0 611 611 612 -== //5.4 Structural metadata maintenance//==550 +== 5.4 Structural metadata maintenance == 613 613 614 614 Support has been added for maintenance of structural metadata. 615 615 ... ... @@ -617,7 +617,7 @@ 617 617 618 618 = 6 XML, JSON, CSV and EDI Transmission formats = 619 619 620 -== //6.1 SDMX-ML//==558 +== 6.1 SDMX-ML == 621 621 622 622 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. 623 623 ... ... @@ -703,7 +703,7 @@ 703 703 704 704 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. 705 705 706 -== //6.2 SDMX-JSON//==644 +== 6.2 SDMX-JSON == 707 707 708 708 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. 709 709 ... ... @@ -723,7 +723,7 @@ 723 723 724 724 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. 725 725 726 -== //6.3 SDMX-CSV//==664 +== 6.3 SDMX-CSV == 727 727 728 728 CSV in SDMX is used transmission of data and reference metadata only. 729 729 ... ... @@ -741,7 +741,7 @@ 741 741 742 742 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. 743 743 744 -=== //6.4 EDI deprecation//===682 +=== 6.4 EDI deprecation === 745 745 746 746 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. 747 747
- SUZ.Methodology.Code.MethodologyClass[0]
-