Changes for page 4 General Notes for Implementers
Last modified by Artur on 2025/09/10 11:19
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -514,15 +514,13 @@ 514 514 515 515 ‘1.0’. 516 516 517 -=== 4. 2.14Non-versioned artefacts ===517 +=== 4.3.1 Non-versioned artefacts === 518 518 519 519 Indeed, some use cases do not need or are incompatible with versioning for some or all their structural artefacts, such as the Agency, Data Providers, Metadata Providers and Data Consumer Schemes. These artefacts follow the legacy versioning, with a fixed version set to ‘1.0’. 520 520 521 521 Many existing organisation’s data management systems work with version-less structures and apply ad-hoc structural metadata governance processes. The new nonversioned artefacts will allow supporting those numerous situations, where organisations do not manage version numbers. 522 522 523 -1. 524 -11. 525 -111. Semantically versioned artefacts 523 +=== 4.3.2 Semantically versioned artefacts === 526 526 527 527 Since the purpose of SDMX versioning is to allow communicating the structural artefact changes to data exchange partners and connected systems, SDMX 3.0 offers Semantic Versioning (aka SemVer) with a clear and unambiguous syntax to all semantically versioned SDMX 3.0 structural artefacts. Semantic versioning will thus better respond to situations where the SDMX standard itself is the only structural contract between data providers and data consumers and where changes in structures can only be communicated through the version number increases. 528 528 ... ... @@ -546,17 +546,13 @@ 546 546 547 547 The production versions of identifiable artefacts are assumed stable, i.e., they do not have an EXTENSION. This is because once in production, an artefact cannot change in any way, or it must change the version. For cases where an artefact is not static, like during the drafting, the version must indicate this by including an EXTENSION. Draft artefacts should not be used outside of a specific system designed to accommodate them. For most purposes, all artefacts should become stable before being used in production. 548 548 549 -1. 550 -11. 551 -111. Legacy-versioned artefacts 547 +=== 4.3.3 Legacy-versioned artefacts === 552 552 553 553 Organisations wishing to keep a maximum of backwards compatibility with existing implementations can continue using the previous 2-digit convention for version numbers (MAJOR.MINOR) as in the past, such as '2.3', but without the ‘isFinal’ property. The new SDMX 3.0 standard does not add any strict rules or guarantees about changes in those artefacts, since the legacy versioning rules were rather loose and non-binding, including the meaning of the ‘isFinal’ property, and their implementations were varying. 554 554 555 555 In order to make artefacts immutable or changes truly predictable, a move to the new semantic versioning syntax is required. 556 556 557 -1. 558 -11. 559 -111. Dependency management and references 553 +=== 4.3.4 Dependency management and references === 560 560 561 561 New flexible dependency specifications with wildcarding allow for easier data model maintenance and enhancements for semantically versioned SDMX artefacts. This allows implementing a smart referencing mechanism, whereby an artefact may reference: 562 562 ... ... @@ -585,8 +585,7 @@ 585 585 586 586 Full details can be found in the SDMX RESTful web services specification. 587 587 588 -1. 589 -11. Structural Metadata Querying Best Practices 582 +== 4.4 Structural Metadata Querying Best Practices == 590 590 591 591 When querying for structural metadata, the ability to state how references should be resolved is quite powerful. However, this mechanism is not always necessary and can create an undue burden on the systems processing the queries if it is not used properly. 592 592 ... ... @@ -594,7 +594,6 @@ 594 594 595 595 When the referenced object is not known, then the reference resolution mechanism could be used. For example, suppose one wanted to find all category schemes and the related categorisations for a given maintenance agency. In this case, one could query for the category scheme by the maintenance agency and specify that parent and sibling references should be resolved. This would result in the categorisations which reference the categories in the matched schemes to be returned, as well as the object which they categorise. 596 596 597 - 598 598 ---- 599 599 600 600 [[~[1~]>>path:#_ftnref1]] Regular expressions, as specified in [[W3C XML Schema Definition Language (XSD)>>url:https://www.w3.org/TR/xmlschema11-2/]][[ >>url:https://www.w3.org/TR/xmlschema11-2/]][[1.1 Part 2: Datatypes>>url:https://www.w3.org/TR/xmlschema11-2/]][[.>>url:https://www.w3.org/TR/xmlschema11-2/]]