Skip to Content
Last modified by Helena on 2025/09/10 11:19
From version 19.7
edited by Helena
on 2025/05/16 16:02
Change comment: There is no comment for this version
To version 19.6
edited by Helena
on 2025/05/16 15:58
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -409,38 +409,38 @@
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(%%):
412 +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]].
414 +* data constraint for data; and
415 +* 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.
417 +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.
419 +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.
421 +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.
423 +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.
427 +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.
429 +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.
433 +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]]).
437 +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.
441 +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:
443 +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).
462 +2.3+.1  Means the currently latest available version >= “2.3.1” and < “3.0.0” (all backwards compatible versions >= “2.3.1”).
463 +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.
467 +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.
471 +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.
475 +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:
481 +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.
489 +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.
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 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]].
495 +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:
499 +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.
501 +* Dataflow;
502 +* Data Structure Definition – i.e., all Dataflows that use it; or
503 +* 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”.
505 +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.
509 +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]].
530 +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