Skip to Content
Last modified by Helena on 2025/09/10 11:19
From version 21.2
edited by Helena
on 2025/05/19 13:42
Change comment: Update document after refactoring.
To version 19.3
edited by Helena
on 2025/05/16 15:54
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -SDMX STANDARDS. SUMMARY OF MAJOR CHANGES AND NEW FUNCTIONALITY Version 3.0
1 +SDMX STANDARDS
Parent
... ... @@ -1,1 +1,1 @@
1 -WebHome
1 +Methodology.WebHome
Content
... ... @@ -327,10 +327,11 @@
327 327  
328 328  == 3.5 Microdata Exchange ==
329 329  
330 -Several changes have been made the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] to support microdata use cases in addition to aggregated time series.
330 +Several changes have been made the Data Structure Definition to support microdata use cases in addition to aggregated time series.
331 331  
332 332  (% class="wikigeneratedid" id="HMultiplemeasures" %)
333 -**Multiple measures**Multiple [[measures>>doc:xwiki:Glossary.Measure.WebHome]] 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>>doc:xwiki:Glossary.Measure.WebHome]]. [[Measures>>doc:xwiki:Glossary.Measure.WebHome]] now act like any other [[component>>doc:xwiki:Glossary.Component.WebHome]] in that they use (% style="color:#2ecc71" %)concepts(%%), can have their own local coded or uncoded [[representation>>doc:xwiki:Glossary.Representation.WebHome]] defined within the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]], and can be either mandatory or conditional. Creating a [[measure>>doc:xwiki:Glossary.Measure.WebHome]] with the “[[MEASURE>>doc:xwiki:Glossary.Measure.WebHome]]” (% style="color:#2ecc71" %)concept(%%) role applied emulates the (% style="color:#2ecc71" %)version(%%) 2.1 MeasureDimension behaviour as illustrated in the [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] example below:
333 +**Multiple measures**
334 +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:
334 334  
335 335  > <str:MeasureList id=”MeasureDescriptor”>
336 336  > <str:Measure id=”OBS_VALUE” minOccurs=”1” maxOccurs=”1” usage=”mandatory” > <str:ConceptIdentity>
... ... @@ -349,98 +349,96 @@
349 349  
350 350  (% class="wikigeneratedid" id="HMulti-valuemeasuresandattributes" %)
351 351  **Multi-value measures and attributes**
352 -Both [[measures>>doc:xwiki:Glossary.Measure.WebHome]] and [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]] 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>>doc:xwiki:Glossary.Measure.WebHome]] or [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is //mandatory// or optional. In the [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] [[measure>>doc:xwiki:Glossary.Measure.WebHome]] 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.
353 +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.
353 353  
354 354  (% class="wikigeneratedid" id="HAttributesrelationshiptomeasures" %)
355 355  **Attributes relationship to measures**
356 -In addition to attaching [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]] to a specific (% style="color:#2ecc71" %)level(%%) within the [[dataset>>doc:xwiki:Glossary.Data set.WebHome]], their relationship 202 to [[measures>>doc:xwiki:Glossary.Measure.WebHome]] can also be defined.
357 +In addition to attaching attributes to a specific level within the dataset, their relationship 202 to measures can also be defined.
357 357  
358 358  (% class="wikigeneratedid" id="HValuelists" %)
359 359  **Value lists**
360 -Value lists help in modelling microdata by providing an enumeration similar to [[code lists>>doc:xwiki:Glossary.Code list.WebHome]] 206 but allowing any string values without being restricted to the rules of [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] identifiers. That allows ValueItems (the equivalent to [[Code>>doc:xwiki:Glossary.Code.WebHome]]) to contain symbols like ‘¥’ and ‘€’, but also means they are not identifiable.
361 +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.
361 361  
362 362  == 3.6 Geospatial Data Exchange ==
363 363  
364 -The (% style="color:#2ecc71" %)version(%%) 3.0 model has been extended to provide explicit support for geospatial data.
365 +The version 3.0 model has been extended to provide explicit support for geospatial data.
365 365  
366 366  (% class="wikigeneratedid" id="HGeospatialInformationtype" %)
367 367  **GeospatialInformation type**
368 -A new GeospatialInformation string type has been added which can be used as the [[representation>>doc:xwiki:Glossary.Representation.WebHome]] for any [[dimension>>doc:xwiki:Glossary.Dimension.WebHome]], [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] or measure [[component>>doc:xwiki:Glossary.Component.WebHome]]. The value which is a string expression conforming to the syntax defined in Section 6 of the technical specifications precisely defines a ‘Geo Feature Set’ – a collection of geographical features like points, lines or polygons. Its use is recommended in conjunction with the “GEO_FEATURE_SET” (% style="color:#2ecc71" %)concept(%%) role.
369 +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.
369 369  
370 370  (% class="wikigeneratedid" id="HGeospatialcodelists" %)
371 371  **Geospatial code lists**
373 +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:
372 372  
373 -(% class="wikigeneratedid" id="HGeospatialcodelists" %)
374 -Two new specialised types of [[code list>>doc:xwiki:Glossary.Code list.WebHome]] have been added where the definition of each [[code>>doc:xwiki:Glossary.Code.WebHome]] includes additional geospatial information in addition to the standard ID, name and description:
375 -
376 376  * 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.
377 -* GeoGridCodelist – A [[code list>>doc:xwiki:Glossary.Code list.WebHome]] defining a geographical grid composed of cells representing regular squared portions of the Earth. Each item references a cell within the grid.
376 +* 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.
378 378  
379 379  == 3.7 Structure Mapping ==
380 380  
381 -The [[Structure Set>>doc:xwiki:Glossary.Structure set.WebHome]] in (% style="color:#2ecc71" %)version(%%) 2.1 is a container for many mapping structures including Data Structure (% style="color:#2ecc71" %)Map(%%), Codelist (% style="color:#2ecc71" %)Map(%%) and (% style="color:#2ecc71" %)Concept(%%) (% style="color:#2ecc71" %)Map(%%). For (% style="color:#2ecc71" %)version(%%) 3.0 the [[Structure Set>>doc:xwiki:Glossary.Structure set.WebHome]] [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] has been deprecated and replaced with a number of new maintainables giving better flexibility and reusability, specifically: Structure (% style="color:#2ecc71" %)Map(%%), [[Concept Scheme>>doc:xwiki:Glossary.Concept scheme.WebHome]] (% style="color:#2ecc71" %)Map(%%), [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] (% style="color:#2ecc71" %)Map(%%), [[Reporting Taxonomy>>doc:xwiki:Glossary.Reporting taxonomy.WebHome]] (% style="color:#2ecc71" %)Map(%%), [[Category Scheme>>doc:xwiki:Glossary.Category scheme.WebHome]] (% style="color:#2ecc71" %)Map(%%) and Organisation Scheme (% style="color:#2ecc71" %)Map(%%).
380 +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.
382 382  
383 -The (% style="color:#2ecc71" %)version(%%) 2.1 Codelist (% style="color:#2ecc71" %)Map(%%) been replaced with [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] (% style="color:#2ecc71" %)Map(%%) which allows mappings to be defined between any combination of [[Code Lists>>doc:xwiki:Glossary.Code list.WebHome]], Value Lists and noncoded [[representations>>doc:xwiki:Glossary.Representation.WebHome]] such as text strings and numbers.
382 +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.
384 384  
385 385  (% class="wikigeneratedid" id="HMany-to-manysourceandtargetcomponents" %)
386 386  **Many-to-many source and target components**
387 -Structure mapping rules may be defined with both multiple source [[components>>doc:xwiki:Glossary.Component.WebHome]] and multiple target [[components>>doc:xwiki:Glossary.Component.WebHome]] in contrast to (% style="color:#2ecc71" %)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>>doc:xwiki:Glossary.Component.WebHome]]. For instance:
386 +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:
388 388  
389 -Set the output [[component>>doc:xwiki:Glossary.Component.WebHome]] INDICATOR=”DE_A” if the input [[components>>doc:xwiki:Glossary.Component.WebHome]] are FREQ=”A” and REF_AREA=”DE”.
388 +Set the output component INDICATOR=”DE_A” if the input components are FREQ=”A” and REF_AREA=”DE”.
390 390  
391 -Similarly, an n-n rule may also set the values of any number of output [[components>>doc:xwiki:Glossary.Component.WebHome]]:
390 +Similarly, an n-n rule may also set the values of any number of output components:
392 392  
393 -Set the output [[components>>doc:xwiki:Glossary.Component.WebHome]] FREQ=”A”, REF_AREA=”DE” if the input [[component>>doc:xwiki:Glossary.Component.WebHome]] INDICATOR=”DE_A”.
392 +Set the output components FREQ=”A”, REF_AREA=”DE” if the input component INDICATOR=”DE_A”.
394 394  
395 395  **Fixed source and target**
396 -The Structure (% style="color:#2ecc71" %)Map(%%) may now define input or output [[components>>doc:xwiki:Glossary.Component.WebHome]] which have a fixed value.
395 +The Structure Map may now define input or output components which have a fixed value.
397 397  
398 398  (% class="wikigeneratedid" id="HTimerepresentationsmapping" %)
399 399  **Time representations mapping**
400 -Non [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] time [[representations>>doc:xwiki:Glossary.Representation.WebHome]] may now be described in a Structure (% style="color:#2ecc71" %)Map(%%), allowing them to be (% style="color:#2ecc71" %)mapped(%%) into [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] [[time formats>>doc:xwiki:Glossary.Time format.WebHome]].
399 +Non SDMX time representations may now be described in a Structure Map, allowing them to be mapped into SDMX time formats.
401 401  
402 402  (% class="wikigeneratedid" id="HRegularexpressionandsubstringmappings" %)
403 403  **Regular expression and substring mappings**
404 -All item (% style="color:#2ecc71" %)maps(%%) allow the use of regular expressions and substrings to match source values, specifically: [[Concept Scheme>>doc:xwiki:Glossary.Concept scheme.WebHome]] (% style="color:#2ecc71" %)Map(%%), [[Reporting Taxonomy>>doc:xwiki:Glossary.Reporting taxonomy.WebHome]] (% style="color:#2ecc71" %)Map(%%), [[Category Scheme>>doc:xwiki:Glossary.Category scheme.WebHome]] (% style="color:#2ecc71" %)Map(%%) and Organisation Scheme (% style="color:#2ecc71" %)Map(%%).
403 +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.
405 405  
406 406  (% class="wikigeneratedid" id="HItemmapsvalidityperiod" %)
407 407  **Item maps validity period**
408 -Item (% style="color:#2ecc71" %)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 (% style="color:#2ecc71" %)mapped(%%) is within the period.
407 +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.
409 409  
410 410  == 3.8 Constraints ==
411 411  
412 -(% style="color:#2ecc71" %)Constraints(%%) in (% style="color:#2ecc71" %)version(%%) 3.0 are modelled using two separate [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] which replace the (% style="color:#2ecc71" %)version(%%) 2.1 content (% style="color:#2ecc71" %)constraint(%%):
411 +Constraints in version 3.0 are modelled using two separate artefacts which replace the version 2.1 content constraint:
413 413  
414 -* data (% style="color:#2ecc71" %)constraint(%%) for data; and
415 -* metadata (% style="color:#2ecc71" %)constraint(%%) for [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]].
413 +* data constraint for data; and
414 +* metadata constraint for reference metadata.
416 416  
417 -Metadata (% style="color:#2ecc71" %)constraint(%%) differs from its data counterpart in having a simplified cube region model better suited to [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] reporting use cases and not carrying details of the constrained targets – that information instead being defined directly within the [[metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]] and Metadata [[Provision Agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]]. Thus, metadata related (% style="color:#2ecc71" %)constraints(%%) only specify (% style="color:#2ecc71" %)constraints(%%) to the values of metadata attributes.
416 +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.
418 418  
419 -The ‘%’ wildcard character can now be used when defining cube region (% style="color:#2ecc71" %)constraints(%%) to match multiple [[codes>>doc:xwiki:Glossary.Code.WebHome]] with a single expression, for instance for [[economic activity>>doc:xwiki:Glossary.Economic activity.WebHome]], ISIC4_% matches all [[codes>>doc:xwiki:Glossary.Code.WebHome]] beginning with ‘ISIC4_’ avoiding the need to maintain an explicit list.
418 +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.
420 420  
421 -The validity period definition has been moved from the (% style="color:#2ecc71" %)constraint(%%) to the individual constraining terms, specifically CubeRegion, DataKeySet and MetadataTargetRegion providing more granular control.
420 +The validity period definition has been moved from the constraint to the individual constraining terms, specifically CubeRegion, DataKeySet and MetadataTargetRegion providing more granular control.
422 422  
423 -Attachment (% style="color:#2ecc71" %)constraints(%%) have been deprecated due to a lack of use cases.
422 +Attachment constraints have been deprecated due to a lack of use cases.
424 424  
425 425  == 3.9 Code List Extension ==
426 426  
427 -In addition to the two new specialised geospatial forms, the option has been added to define a [[code list>>doc:xwiki:Glossary.Code list.WebHome]] as an extension of, or by inheriting [[codes>>doc:xwiki:Glossary.Code.WebHome]] from, other lists. An optional prefix can be added to inherited [[codes>>doc:xwiki:Glossary.Code.WebHome]] to disambiguate duplicates.
426 +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.
428 428  
429 -This feature allows new [[code lists>>doc:xwiki:Glossary.Code list.WebHome]] to be easily derived from existing lists without the need to make and manually maintain copies. When querying for extended [[code list>>doc:xwiki:Glossary.Code list.WebHome]] structures using the REST API, the option has been added to retrieve either the definition or the materialised list. Traditional literal lists of [[codes>>doc:xwiki:Glossary.Code.WebHome]] continue to be supported.
428 +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.
430 430  
431 431  == 3.10 Discriminated Union of Code Lists ==
432 432  
433 -Combining [[code list>>doc:xwiki:Glossary.Code list.WebHome]] extension with wildcarded (% style="color:#2ecc71" %)constraints(%%) solves the discriminated union of [[code lists>>doc:xwiki:Glossary.Code list.WebHome]] problem where a classification or breakdown has multiple “variants” which are all valid but mutually exclusive. A common example is [[economic activity>>doc:xwiki:Glossary.Economic activity.WebHome]] where several alternative classification schemes are in use including ISIC revisions 1 to 4 and NACE as used in the European Community.
432 +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.
434 434  
435 435  == 3.11 Code Hierarchies ==
436 436  
437 -[[Code>>doc:xwiki:Glossary.Code.WebHome]] [[hierarchies>>doc:xwiki:Glossary.Hierarchy.WebHome]] allow the definition of complex [[hierarchies>>doc:xwiki:Glossary.Hierarchy.WebHome]] of [[codes>>doc:xwiki:Glossary.Code.WebHome]] from potentially multiple lists for data discovery purposes. Hierarchical Codelist has been deprecated and replaced by two new [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]]: [[Hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] – the actual [[hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] of [[codes>>doc:xwiki:Glossary.Code.WebHome]], and [[Hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] Association links [[hierarchies>>doc:xwiki:Glossary.Hierarchy.WebHome]] directly to any other identifiable object, a capability missing from the (% style="color:#2ecc71" %)version(%%) 2.1 model. Further, the linkage can be within a particular context, for instance linking a [[hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] to a [[dimension>>doc:xwiki:Glossary.Dimension.WebHome]] within the context of a specific [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] ([[dimension>>doc:xwiki:Glossary.Dimension.WebHome]] REF_AREA in the context of the ECB:EXR [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]]).
436 +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).
438 438  
439 439  = 4 Versioning of Structural Metadata Artefacts =
440 440  
441 -(% style="color:#2ecc71" %)Version(%%) 3.0 adopts semantic versioning principles for versioning of metadata [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] following the rules set out at __[[https:~~/~~/semver.org>>https://semver.org]] __However, this is not mandatory, and organisations may continue to use the pre-existing two-digit versioning strategy, or not to (% style="color:#2ecc71" %)version(%%) [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] by omitting the (% style="color:#2ecc71" %)//version//(%%) property. The (% style="color:#2ecc71" %)version(%%) number no longer defaults to 1.0 if not explicitly set.
440 +Version 3.0 adopts semantic versioning principles for versioning of metadata artefacts following the rules set out at __[[https:~~/~~/semver.org>>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.
442 442  
443 -Semantic (% style="color:#2ecc71" %)version(%%) numbers are three digits:
442 +Semantic version numbers are three digits:
444 444  
445 445  MAJOR.MINOR.PATCH
446 446  
... ... @@ -459,26 +459,26 @@
459 459  
460 460  Additional constructs are possible for dependency management when referencing structures. For instance:
461 461  
462 -2.3+.1  Means the currently latest available (% style="color:#2ecc71" %)version(%%) >= “2.3.1” and < “3.0.0” (all backwards compatible (% style="color:#2ecc71" %)versions(%%) >= “2.3.1”).
463 -2+.3.1  Means the currently latest available (% style="color:#2ecc71" %)version(%%) >= “2.3.1” (even if not backwards compatible).
461 +2.3+.1  Means the currently latest available version >= “2.3.1” and < “3.0.0” (all backwards compatible versions >= “2.3.1”).
462 +2+.3.1  Means the currently latest available version >= “2.3.1” (even if not backwards compatible).
464 464  
465 465  == Draft structures ==
466 466  
467 -A key principle is that semantically versioned structures are immutable and must not be changed without a corresponding change to the (% style="color:#2ecc71" %)version(%%) number, except where explicitly marked as draft using extensions to the (% style="color:#2ecc71" %)version(%%) number.
466 +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.
468 468  
469 469  MAJOR.MINOR.PATCH-EXTENSION
470 470  
471 -1.10.0-draft  Means that (% style="color:#2ecc71" %)version(%%) 1.10.0 is still being modified and may change – equivalent to setting isFinal=false in [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] 2.1.
470 +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.
472 472  1.10.0-unstable  Alternative to -draft.
473 473  1.10.0-notfinal  Alternative to -draft.
474 474  
475 -The [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] 2.1 isFinal property is deprecated in 3.0.
474 +The SDMX 2.1 isFinal property is deprecated in 3.0.
476 476  
477 477  = 5 REST Web Services API =
478 478  
479 479  == 5.1 Simplified list of resources ==
480 480  
481 -The (% style="color:#2ecc71" %)version(%%) 3.0 REST API has just five main resources:
480 +The version 3.0 REST API has just five main resources:
482 482  
483 483  * structure
484 484  * data
... ... @@ -486,27 +486,27 @@
486 486  * availability
487 487  * metadata
488 488  
489 -All structure and item queries have been organised under the structure resource in contrast to the (% style="color:#2ecc71" %)version(%%) 2.1 API which specified a separate resource for each structure.
488 +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.
490 490  
491 -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 (% style="color:#2ecc71" %)version(%%) 3.0 API is not backwardly compatible.
490 +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.
492 492  
493 493  == 5.2 Improved data queries ==
494 494  
495 -Data queries have been changed to provide more granular selections from contexts wider than just a [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]].
494 +Data queries have been changed to provide more granular selections from contexts wider than just a Dataflow.
496 496  
497 497  (% class="wikigeneratedid" id="HExtendthecontextofdataretrieval" %)
498 498  **Extend the context of data retrieval**
499 -(% style="color:#2ecc71" %)Version(%%) 2.1 data queries always retrieved data from a single specific [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]]. In (% style="color:#2ecc71" %)version(%%) 3.0, the query context may be specified as:
498 +Version 2.1 data queries always retrieved data from a single specific Dataflow. In version 3.0, the query context may be specified as:
500 500  
501 -* [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]];
502 -* Data Structure Definition – i.e., all [[Dataflows>>doc:xwiki:Glossary.Dataflow.WebHome]] that use it; or
503 -* Provision Agreement – i.e., all [[Dataflows>>doc:xwiki:Glossary.Dataflow.WebHome]] associated with it.
500 +* Dataflow;
501 +* Data Structure Definition – i.e., all Dataflows that use it; or
502 +* Provision Agreement – i.e., all Dataflows associated with it.
504 504  
505 -Data queries may also search across [[datasets>>doc:xwiki:Glossary.Data set.WebHome]], for instance “retrieve all data about a country”.
504 +Data queries may also search across datasets, for instance “retrieve all data about a country”.
506 506  
507 507  (% class="wikigeneratedid" id="HComponent-basedfilters" %)
508 508  **Component-based filters**
509 -Expressions filtering on individual [[components>>doc:xwiki:Glossary.Component.WebHome]] can now be included as part of the data query URL.
508 +Expressions filtering on individual components can now be included as part of the data query URL.
510 510  
511 511  /data/dataflow/ESTAT/ICP?c[REF_AREA]=CH&c[CONF_STATUS]=F
512 512  
... ... @@ -527,7 +527,7 @@
527 527  
528 528  (% class="wikigeneratedid" id="HSupportformultiplekeys" %)
529 529  **Support for multiple keys**
530 -Queries can now specify multiple [[series keys>>doc:xwiki:Glossary.Series key.WebHome]].
529 +Queries can now specify multiple series keys.
531 531  
532 532  (% class="wikigeneratedid" %)
533 533  /data/dataflow/ESTAT/ICP/1.0.0/M…A.ANR,M…A.INX,M…B.CTG
... ... @@ -534,7 +534,7 @@
534 534  
535 535  == 5.3 Improved reference metadata queries ==
536 536  
537 -[[Reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] queries have been improved with a number of new options to retrieve metadata reports.
536 +Reference metadata queries have been improved with a number of new options to retrieve metadata reports.
538 538  
539 539  **Get metadata reports by ID**
540 540  
... ... @@ -550,21 +550,21 @@
550 550  
551 551  == 5.4 Structural metadata maintenance ==
552 552  
553 -Support has been added for maintenance of [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]].
552 +Support has been added for maintenance of structural metadata.
554 554  
555 -HTTP verbs PUT, POST and DELETE may be used to submit [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] or [[SDMX-JSON>>doc:xwiki:Glossary.SDMX-JSON.WebHome]] structure messages to an [[SDMX registry>>doc:xwiki:Glossary.SDMX Registry.WebHome]] for the purposes of adding, updating or deleting [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]].
554 +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.
556 556  
557 557  = 6 XML, JSON, CSV and EDI Transmission formats =
558 558  
559 559  == 6.1 SDMX-ML ==
560 560  
561 -The [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] XML messages have been modified and updated for (% style="color:#2ecc71" %)version(%%) 3.0. While they broadly follow the same principles, there have been significant changes which break backward compatibility.
560 +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.
562 562  
563 563  (% class="wikigeneratedid" id="HStructuremessage" %)
564 564  **Structure message**
565 -The [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] structure message is used for transmission of [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]]. It closely reflects the [[SDMX information model>>doc:xwiki:Glossary.SDMX Information Model.WebHome]] and has therefore been significantly updated for (% style="color:#2ecc71" %)version(%%) 3.0 with the addition of new structures, modifications where structures have changed, and removal of deprecated structures like Structure Set.
564 +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.
566 566  
567 -Additionally, the way the individual [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] are organised into ‘collections’ within the message has been significantly revised with a simpler flat structure adopted as set out in the following table:
566 +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:
568 568  
569 569  (% style="width:1102.04px" %)
570 570  |(% style="width:321px" %)**Artefact type**|(% style="width:351px" %)**Version 2.1 Collection**|(% style="width:426px" %)**Version 3.0 Collection**
... ... @@ -593,7 +593,7 @@
593 593  |(% style="width:321px" %)TransformationScheme|(% style="width:351px" %)Transformations|(% style="width:426px" %)TransformationSchemes
594 594  |(% style="width:321px" %)UserDefinedOperatorScheme|(% style="width:351px" %)UserDefinedOperators|(% style="width:426px" %)UserDefinedOperatorSchemes
595 595  
596 -No changes have been made to the way the following [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] are organised in the structure message:
595 +No changes have been made to the way the following artefacts are organised in the structure message:
597 597  
598 598  (% style="width:1106.04px" %)
599 599  |(% style="width:326px" %)**Artefact type**|(% style="width:776px" %)**Collection**
... ... @@ -610,82 +610,79 @@
610 610  |(% style="width:326px" %)Process|(% style="width:776px" %)Processes
611 611  |(% style="width:326px" %)ProvisionAgreement|(% style="width:776px" %)ProvisionAgreements
612 612  
613 -From (% style="color:#2ecc71" %)version(%%) 3.0, collections can appear in any order within a structure message.
612 +From version 3.0, collections can appear in any order within a structure message.
614 614  
615 615  (% class="wikigeneratedid" id="HDatamessages" %)
616 616  **Data messages**
616 +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.
617 617  
618 -(% class="wikigeneratedid" id="HDatamessages" %)
619 -All legacy [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] data messages have been deprecated with the exception of Structure Specific Data which becomes the sole standard format for transmission of [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] data in XML in (% style="color:#2ecc71" %)version(%%) 3.0.
618 +Specifically, the following data messages are not supported in version 3.0:
620 620  
621 -Specifically, the following data messages are not supported in (% style="color:#2ecc71" %)version(%%) 3.0:
620 +* SDMX-ML 1.0/2.0 Generic (time-series) data message
621 +* SDMX-ML 1.0/2.0 Compact (time-series) data message
622 +* SDMX-ML 1.0/2.0 Utility (time-series) data message
623 +* SDMX-ML 1.0/2.0 Cross-Sectional data message
624 +* SDMX-ML 2.1 Generic data messages (for observations, time-series and crosssectional data)
622 622  
623 -* [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] 1.0/2.0 Generic (time-series) data message
624 -* [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] 1.0/2.0 Compact (time-series) data message
625 -* [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] 1.0/2.0 Utility (time-series) data message
626 -* [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] 1.0/2.0 Cross-Sectional data message
627 -* [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] 2.1 Generic data messages (for observations, time-series and crosssectional data)
626 +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.
628 628  
629 -The Structure Specific Data message has been extended to support the transmission of microdata sets, in particular those with multiple [[measures>>doc:xwiki:Glossary.Measure.WebHome]] and array values for [[measures>>doc:xwiki:Glossary.Measure.WebHome]] and [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]].
628 +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.
630 630  
631 -As detailed in paragraph 3.4, the message now additionally allows data’s [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] to be reported as an integral part of the [[dataset>>doc:xwiki:Glossary.Data set.WebHome]]. Like data [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]], these metadata [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]] are included in the data message at the [[dataset>>doc:xwiki:Glossary.Data set.WebHome]], series or observation (% style="color:#2ecc71" %)level(%%) as appropriate.
632 -
633 633  The time series variant of the Structure Specific Data message is no longer used.
634 634  
635 635  (% class="wikigeneratedid" id="HReferencemetadatamessage" %)
636 636  **Reference metadata message**
637 -The Generic Metadata message remains the standard format for transmission of [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] sets in XML but has been modified to support the revised (% style="color:#2ecc71" %)version(%%) 3.0 [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] model.
634 +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.
638 638  
639 639  (% class="wikigeneratedid" id="HRegistrystructuralmetadata2018query2019messages" %)
640 640  **Registry structural metadata ‘query’ messages**
641 -As a consequence of the deprecation of the SOAP API and standardisation on REST, the [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] ‘query’ messages have all been removed. In (% style="color:#2ecc71" %)version(%%) 3.0, querying an [[SDMX Registry>>doc:xwiki:Glossary.SDMX Registry.WebHome]] for [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] is performed solely using REST GET.
638 +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.
642 642  
643 643  (% class="wikigeneratedid" id="HStructurereferencing" %)
644 644  **Structure referencing**
645 -The option to reference structures using Agency, ID and (% style="color:#2ecc71" %)Version(%%) has been removed. From [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] (% style="color:#2ecc71" %)version(%%) 3.0 URN is used for all referencing purposes with the exception of local references such as where groups reference [[dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] within a [[DSD>>doc:xwiki:Glossary.Data structure definition.WebHome]].
642 +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.
646 646  
647 647  == 6.2 SDMX-JSON ==
648 648  
649 -Like [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]], the [[SDMX-JSON>>doc:xwiki:Glossary.SDMX-JSON.WebHome]] messages have been significantly modified and updated for (% style="color:#2ecc71" %)version(%%) 3.0. They are not backwardly compatible with (% style="color:#2ecc71" %)version(%%) 2.1.
646 +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.
650 650  
651 651  (% class="wikigeneratedid" id="HStructuremessage-1" %)
652 652  **Structure message**
653 -The [[SDMX-JSON>>doc:xwiki:Glossary.SDMX-JSON.WebHome]] structure message closely replicates the [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] equivalent. Like that of [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] it has been updated to align it with the (% style="color:#2ecc71" %)version(%%) 3.0 information model with addition, deletion and modification of [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] as required. The organisation of the structure collections has also been revised as detailed in paragraph 6.1.
650 +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.
654 654  
655 655  (% class="wikigeneratedid" id="HDatamessage" %)
656 656  **Data message**
657 -The [[SDMX-JSON>>doc:xwiki:Glossary.SDMX-JSON.WebHome]] data message has similarly be updated. Additional changes have been made to allow a single message to carry data from multiple [[datasets>>doc:xwiki:Glossary.Data set.WebHome]] with potentially different [[Data Structure Definitions>>doc:xwiki:Glossary.Data structure definition.WebHome]] to support REST data queries of the form “retrieve all data about a country”. For this reason, the (% style="color:#2ecc71" %)version(%%) 3.0 [[SDMX-JSON>>doc:xwiki:Glossary.SDMX-JSON.WebHome]] is not backwardly compatible with (% style="color:#2ecc71" %)version(%%) 2.1 data messages. Support has been added for the transmission of microdata and reporting of [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] on data as an integral part of the dataset.
654 +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.
658 658  
659 659  (% class="wikigeneratedid" id="HReferencemetadatamessage-1" %)
660 660  **Reference metadata message**
661 -The [[SDMX-JSON>>doc:xwiki:Glossary.SDMX-JSON.WebHome]] metadata message has also been updated to support the (% style="color:#2ecc71" %)version(%%) 3.0 [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] and Metadataset specifications.
658 +The SDMX-JSON metadata message has also been updated to support the version 3.0 reference metadata and Metadataset specifications.
662 662  
663 663  (% class="wikigeneratedid" id="HStructurereferencing-1" %)
664 664  **Structure referencing**
665 -As for [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]], the option to reference structures using Agency, ID and (% style="color:#2ecc71" %)Version(%%) has been removed with URN used for all non-local referencing purposes.
662 +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.
666 666  
667 667  == 6.3 SDMX-CSV ==
668 668  
669 -CSV in [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] is used transmission of data and [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] only.
666 +CSV in SDMX is used transmission of data and reference metadata only.
670 670  
671 671  (% class="wikigeneratedid" id="HDatamessage-1" %)
672 672  **Data message**
673 -The [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]]-CSV data message has been modified to align with the (% style="color:#2ecc71" %)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:
670 +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:
674 674  
675 -* An additional column identifying the type if the [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] defining the structure of the data: “[[dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]]”, “datastructure” or “dataprovision”;
676 -* A column for the structure [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]]’s identification of the form
672 +* 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
677 677  
678 -ESTAT:NA_MAIN(1.6.0) which replaces the [[dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] identifier in (% style="color:#2ecc71" %)version(%%) 2.1; and
674 +ESTAT:NA_MAIN(1.6.0) which replaces the dataflow identifier in version 2.1; and
679 679  
680 -* A column for the [[dataset>>doc:xwiki:Glossary.Data set.WebHome]] action: information, append, replace or delete, which is consistent with both the the [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] and [[SDMX-JSON>>doc:xwiki:Glossary.SDMX-JSON.WebHome]] data messages.
676 +* 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.
681 681  
682 682  (% class="wikigeneratedid" id="HReferencemetadatamessage-2" %)
683 683  **Reference metadata message**
684 -The [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]]-CSV metadata message is new for (% style="color:#2ecc71" %)version(%%) 3.0 and, like the [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] and [[SDMX-JSON>>doc:xwiki:Glossary.SDMX-JSON.WebHome]] equivalents, is used for the transmission [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] sets.
680 +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.
685 685  
686 686  == 6.4 EDI deprecation ==
687 687  
688 -The EDI format for transmission of both structures and data has been deprecated. (% style="color:#2ecc71" %)Version(%%) 3.0 is therefore not backwardly compatible with legacy EDI messages.
684 +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.
689 689  
690 690  = Appendix A – Version 2.1 Information Model =
691 691