Last modified by Helena on 2025/09/10 11:19

From version 7.8
edited by Helena
on 2025/05/14 13:38
Change comment: There is no comment for this version
To version 13.1
edited by Helena
on 2025/05/14 14:53
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -1 Overview
1 +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" %)
... ... @@ -151,10 +151,7 @@
151 151  
152 152  //Conversion guidance for implementors//
153 153  
154 -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
155 -)))
156 -|(% style="width:132px" %) |(% style="width:819px" %)(((
157 -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.
154 +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 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.
158 158  
159 159  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.
160 160  )))
... ... @@ -180,7 +180,7 @@
180 180  
181 181  = 3 Information Model =
182 182  
183 -== //3.1 Version 3.0 Information Model// ==
180 +== 3.1 Version 3.0 Information Model ==
184 184  
185 185  [[image:SDMX 3-0-0 Major Changes FINAL-1.0_en_6fc573fe.png||height="404" width="718"]]
186 186  
... ... @@ -190,7 +190,7 @@
190 190  
191 191  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.
192 192  
193 -== //3.2 Key Changes from Version 2.1// ==
190 +== 3.2 Key Changes from Version 2.1 ==
194 194  
195 195  New Maintainable Artefacts
196 196  
... ... @@ -218,7 +218,8 @@
218 218  Removed Maintainable Artefacts
219 219  
220 220  * Structure Set – replaced by Structure Map and the four item scheme maps
221 -* 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
222 222  
223 223  Changed Maintainable Artefacts
224 224  
... ... @@ -232,7 +232,7 @@
232 232  
233 233  * GeospatialInformation – a string type where the value is an expression defining a set of geographical features using a purpose-designed syntax
234 234  
235 -== //3.3 Areas Unchanged from Version 2.1// ==
233 +== 3.3 Areas Unchanged from Version 2.1 ==
236 236  
237 237  The following areas of the information model are unchanged from version 2.1:
238 238  
... ... @@ -245,7 +245,7 @@
245 245  * Reporting taxonomy
246 246  * Process
247 247  
248 -== //3.4 Reference Metadata// ==
246 +== 3.4 Reference Metadata ==
249 249  
250 250  Reference metadata has been substantially re-designed for version 3.0 to simplify the model and better support practical use cases.
251 251  
... ... @@ -274,83 +274,45 @@
274 274  * SOURCE_AGENCY – a multi-value data attribute
275 275  
276 276  <Obs xsi:type="dsd:ObsType" OBS_VALUE="112" OBS_STAUS=”A” TIME_PERIOD="2010-09">
277 -
278 278  <!—- complex multi-value and multi-lingual data attributes ~-~->
279 -
280 280  <Comp id="TITLE" xsi:type="ns1:TITLE_ATTRIBUTE">
281 -
282 282  <Value>
283 -
284 284  <common:Text xml:lang="en">Some English Text</common:Text>
285 -
286 286  <common:Text xml:lang="fr">Quelques textes en anglais</common:Text>
287 -
288 288  </Value>
289 -
290 290  </Comp>
291 291  
292 292  <Comp id="SOURCE_AGENCY" xsi:type="ns1:SOURCE_AGENCY_ATTRIBUTE">
293 -
294 294  <Value>4F0</Value>
295 -
296 296  <Value>4D0</Value>
297 -
298 298  <Value>CZ2</Value>
299 -
300 300  </Comp>
301 -
302 302  <!—- metadata attributes are reported like in metadata messages ~-~->
303 -
304 304  <Metadata>
305 -
306 306  <Attribute id="COLLECTION">
307 -
308 308  <Attribute id="METHOD">
309 -
310 310  <Text lang="en">AAA</Text>
311 -
312 312  </Attribute>
313 -
314 314  </Attribute>
315 -
316 316  <Attribute id="CONTACT">
317 -
318 318  <Value>CONTACT 1</Value>
319 -
320 320  <Attribute id="NAME">
321 -
322 322  <Value>Contact 1 Name 1</Value>
323 -
324 324  </Attribute>
325 -
326 326  <Attribute id="NAME">
327 -
328 328  <Value>Contact 1 Name 2</Value>
329 -
330 330  </Attribute>
331 -
332 332  </Attribute>
333 -
334 334  <Attribute id="CONTACT">
335 -
336 336  <Value>CONTACT 2</Value>
337 -
338 338  <Attribute id="NAME">
339 -
340 340  <Value>Contact 2 Name 1</Value>
341 -
342 342  </Attribute>
343 -
344 344  <Attribute id="NAME">
345 -
346 346  <Value>Contact 2 Name 2</Value>
347 -
348 348  </Attribute>
349 -
350 350  </Attribute>
351 -
352 352  </Metadata>
353 -
354 354  </Obs>
355 355  
356 356  === New - Metadata Provision Agreement ===
... ... @@ -365,7 +365,7 @@
365 365  
366 366  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.
367 367  
368 -== //3.5 Microdata Exchange// ==
328 +== 3.5 Microdata Exchange ==
369 369  
370 370  Several changes have been made the Data Structure Definition to support microdata use cases in addition to aggregated time series.
371 371  
... ... @@ -378,31 +378,18 @@
378 378  MeasureDimension behaviour as illustrated in the SDMX-ML example below:
379 379  
380 380  <str:MeasureList id=”MeasureDescriptor”>
381 -
382 382  <str:Measure id=”OBS_VALUE” minOccurs=”1” maxOccurs=”1” usage=”mandatory” > <str:ConceptIdentity>
383 -
384 384  <Ref id=”OBS_VALUE” maintainableParentID=”CONCEPTS” agencyID=”SDMX” maintainableParentVersion=”1.0.0” />
385 -
386 386  </str:ConceptIdentity>
387 -
388 388  <str:LocalRepresentation>
389 -
390 390  <str:TextFormat textType=”String” isMultiLingual=”true” />
391 -
392 392  </str:LocalRepresentation>
393 -
394 394  <str:ConceptRole>
395 -
396 396  <Ref id=”MEASURE” maintainableParentID=”SDMX_CONCEPT_ROLES” agencyID=”SDMX” maintainableParentVersion=”1.0.0” />
397 -
398 398  </str:ConceptRole>
399 -
400 400  </str:Measure>
401 -
402 402  ...
403 -
404 404  <str:Measure>
405 -
406 406  </str:MeasureList>
407 407  
408 408  === Multi-value measures and attributes ===
... ... @@ -423,7 +423,7 @@
423 423  
424 424  That allows ValueItems (the equivalent to Code) to contain symbols like ‘¥’ and ‘€’, but 208 also means they are not identifiable.
425 425  
426 -== //3.6 Geospatial Data Exchange// ==
373 +== 3.6 Geospatial Data Exchange ==
427 427  
428 428  The version 3.0 model has been extended to provide explicit support for geospatial data.
429 429  
... ... @@ -438,13 +438,13 @@
438 438  * 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.
439 439  * 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.
440 440  
441 -=== //3.7 Structure Mapping// ===
388 +== 3.7 Structure Mapping ==
442 442  
443 443  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.
444 444  
445 445  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.
446 446  
447 -==== Many-to-many source and target components ====
394 +=== Many-to-many source and target components ===
448 448  
449 449  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:
450 450  
... ... @@ -458,19 +458,19 @@
458 458  
459 459  The Structure Map may now define input or output components which have a fixed value.
460 460  
461 -==== Time representations mapping ====
408 +=== Time representations mapping ===
462 462  
463 463  Non SDMX time representations may now be described in a Structure Map, allowing them to be mapped into SDMX time formats.
464 464  
465 -==== Regular expression and substring mappings ====
412 +=== Regular expression and substring mappings ===
466 466  
467 467  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.
468 468  
469 -==== Item maps validity period ====
416 +=== Item maps validity period ===
470 470  
471 471  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.
472 472  
473 -=== //3.8 Constraints// ===
420 +== 3.8 Constraints ==
474 474  
475 475  Constraints in version 3.0 are modelled using two separate artefacts which replace the version 2.1 content constraint:
476 476  
... ... @@ -485,17 +485,17 @@
485 485  
486 486  Attachment constraints have been deprecated due to a lack of use cases.
487 487  
488 -=== //3.9 Code List Extension// ===
435 +== 3.9 Code List Extension ==
489 489  
490 490  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.
491 491  
492 492  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.
493 493  
494 -=== //3.10 Discriminated Union of Code Lists// ===
441 +== 3.10 Discriminated Union of Code Lists ==
495 495  
496 496  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.
497 497  
498 -=== //3.11 Code Hierarchies// ===
445 +== 3.11 Code Hierarchies ==
499 499  
500 500  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).
501 501  
... ... @@ -543,7 +543,7 @@
543 543  
544 544  = 5 REST Web Services API =
545 545  
546 -== //5.1 Simplified list of resources// ==
493 +== 5.1 Simplified list of resources ==
547 547  
548 548  The version 3.0 REST API has just five main resources:
549 549  
... ... @@ -557,7 +557,7 @@
557 557  
558 558  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.
559 559  
560 -== //5.2 Improved data queries// ==
507 +== 5.2 Improved data queries ==
561 561  
562 562  Data queries have been changed to provide more granular selections from contexts wider than just a Dataflow.
563 563  
... ... @@ -596,7 +596,7 @@
596 596  
597 597  /data/dataflow/ESTAT/ICP/1.0.0/M…A.ANR,M…A.INX,M…B.CTG
598 598  
599 -== //5.3 Improved reference metadata queries// ==
546 +== 5.3 Improved reference metadata queries ==
600 600  
601 601  Reference metadata queries have been improved with a number of new options to retrieve metadata reports.
602 602  
... ... @@ -612,7 +612,7 @@
612 612  
613 613  /metadata/structure/datastructure/BIS/BIS_CBS/1.0
614 614  
615 -== //5.4 Structural metadata maintenance// ==
562 +== 5.4 Structural metadata maintenance ==
616 616  
617 617  Support has been added for maintenance of structural metadata.
618 618  
... ... @@ -620,7 +620,7 @@
620 620  
621 621  = 6 XML, JSON, CSV and EDI Transmission formats =
622 622  
623 -== //6.1 SDMX-ML// ==
570 +== 6.1 SDMX-ML ==
624 624  
625 625  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.
626 626  
... ... @@ -706,7 +706,7 @@
706 706  
707 707  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.
708 708  
709 -== //6.2 SDMX-JSON// ==
656 +== 6.2 SDMX-JSON ==
710 710  
711 711  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.
712 712  
... ... @@ -726,7 +726,7 @@
726 726  
727 727  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.
728 728  
729 -== //6.3 SDMX-CSV// ==
676 +== 6.3 SDMX-CSV ==
730 730  
731 731  CSV in SDMX is used transmission of data and reference metadata only.
732 732  
... ... @@ -744,7 +744,7 @@
744 744  
745 745  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.
746 746  
747 -=== //6.4 EDI deprecation// ===
694 +=== 6.4 EDI deprecation ===
748 748  
749 749  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.
750 750  
SUZ.Methodology.Code.MethodologyClass[0]