Changes for page 4 General Notes for Implementers
Last modified by Helena K. on 2026/06/09 20:04
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -241,7 +241,7 @@ 241 241 a) **If the [PERIOD_INDICATOR] is W:** 242 242 243 243 **~1. If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday:** 244 -Add[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[4~]^^>>path:#_ftn4]](%%) (P3D, P2D, or P1D respectively) to the 244 +Add[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[4~]^^>>path:#_ftn4]](%%) (P3D, P2D, or P1D respectively) to the 245 245 [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE]. 246 246 247 247 2. **If [REPORTING_YEAR_START_DATE] is a Monday, Tuesday, Wednesday, or Thursday:** ... ... @@ -328,10 +328,10 @@ 328 328 329 329 === 4.2.8 Time Format === 330 330 331 -In (% style="color:#e74c3c" %)version(%%)2.0 of [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] there is a recommendation to use the [[time format>>doc:sdmx:Glossary 2\.1.Time format.WebHome]] [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] to gives additional information on the way time is represented in the message. Following an appraisal of its usefulness this is no longer required. However, it is still possible, if required , to include the [[time format>>doc:sdmx:Glossary 2\.1.Time format.WebHome]] [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] in [[SDMX-ML>>doc:sdmx:Glossary 2\.1.SDMX-ML.WebHome]].331 +In version 2.0 of [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] there is a recommendation to use the [[time format>>doc:sdmx:Glossary 2\.1.Time format.WebHome]] [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] to gives additional information on the way time is represented in the message. Following an appraisal of its usefulness this is no longer required. However, it is still possible, if required , to include the [[time format>>doc:sdmx:Glossary 2\.1.Time format.WebHome]] [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] in [[SDMX-ML>>doc:sdmx:Glossary 2\.1.SDMX-ML.WebHome]]. 332 332 333 333 (% style="width:890.835px" %) 334 -|(% style="width:95px" %)** [[Code>>doc:sdmx:Glossary 2\.1.Code.WebHome]]**|(% style="width:793px" %)**Format**334 +|(% style="width:95px" %)**Code**|(% style="width:793px" %)**Format** 335 335 |(% style="width:95px" %)OTP|(% style="width:793px" %)Observational [[Time Period>>doc:sdmx:Glossary 2\.1.Time period.WebHome]]: Superset of all [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] [[time formats>>doc:sdmx:Glossary 2\.1.Time format.WebHome]] (Gregorian [[Time Period>>doc:sdmx:Glossary 2\.1.Time period.WebHome]], Reporting [[Time Period>>doc:sdmx:Glossary 2\.1.Time period.WebHome]], and Time Range) 336 336 |(% style="width:95px" %)STP|(% style="width:793px" %)Standard [[Time Period>>doc:sdmx:Glossary 2\.1.Time period.WebHome]]: Superset of Gregorian and Reporting [[Time Periods>>doc:sdmx:Glossary 2\.1.Time period.WebHome]] 337 337 |(% style="width:95px" %)GTP|(% style="width:793px" %)Superset of all Gregorian [[Time Periods>>doc:sdmx:Glossary 2\.1.Time period.WebHome]] and date-time ... ... @@ -352,7 +352,7 @@ 352 352 |(% style="width:95px" %)RD|(% style="width:793px" %)Reporting Day (YYYY-Dddd) 353 353 354 354 (% class="wikigeneratedid" id="HTable1:SDMX-MLTimeFormatCodes" %) 355 -**Table 1: [[SDMX-ML>>doc:sdmx:Glossary2\.1.SDMX-ML.WebHome]] [[Time Format>>doc:sdmx:Glossary2\.1.Time format.WebHome]] [[Codes>>doc:sdmx:Glossary 2\.1.Code.WebHome]]**355 +**Table 1: SDMX-ML Time Format Codes** 356 356 357 357 === 4.2.9 Time Zones === 358 358 ... ... @@ -373,7 +373,7 @@ 373 373 * Reporting Day: 2006-D156**-05:00** 374 374 * Reporting Year Start Day: 07-01**-05:00** 375 375 376 -According to ISO 8601, a date without a time-zone is considered "local time". [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] assumes that local time is that of the sender of the message. In this (% style="color:#e74c3c" %)version(%%)of [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]], an optional field is added to the sender definition in the header for specifying a time zone. This field has a default value of 'Z' (UTC). This determination of local time applies for all dates in a message.376 +According to ISO 8601, a date without a time-zone is considered "local time". [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] assumes that local time is that of the sender of the message. In this version of [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]], an optional field is added to the sender definition in the header for specifying a time zone. This field has a default value of 'Z' (UTC). This determination of local time applies for all dates in a message. 377 377 378 378 === 4.2.10 Representing Time Spans Elsewhere === 379 379 ... ... @@ -391,7 +391,7 @@ 391 391 392 392 === 4.2.12 Effect on Time Ranges === 393 393 394 -All [[SDMX-ML>>doc:sdmx:Glossary 2\.1.SDMX-ML.WebHome]] data messages are capable of functioning in a manner similar to SDMXEDI if the [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%)is time: the [[time period>>doc:sdmx:Glossary 2\.1.Time period.WebHome]] for the first observation can be stated and the rest of the observations can omit the time value as it can be derived from the start time and the frequency. Since the frequency can be determined based on the actual format of the time value for everything but distinct points in time and time ranges, this makes is even simpler to process as the interval between time ranges is known directly from the time value.394 +All [[SDMX-ML>>doc:sdmx:Glossary 2\.1.SDMX-ML.WebHome]] data messages are capable of functioning in a manner similar to SDMXEDI if the [[Dimension>>doc:sdmx:Glossary 2\.1.Dimension.WebHome]] at the observation level is time: the [[time period>>doc:sdmx:Glossary 2\.1.Time period.WebHome]] for the first observation can be stated and the rest of the observations can omit the time value as it can be derived from the start time and the frequency. Since the frequency can be determined based on the actual format of the time value for everything but distinct points in time and time ranges, this makes is even simpler to process as the interval between time ranges is known directly from the time value. 395 395 396 396 === 4.2.13 Time in Query Messages === 397 397 ... ... @@ -441,50 +441,50 @@ 441 441 * 2010-T3 (any reporting year start day) 442 442 * 2010-Q3 or later (any reporting year start day) 443 443 * 2010-M07 or later (any reporting year start day) 444 -* 2010-W27 or later (reporting year start day ~-~-01-01){{footnote}}2010-Q3 (with a reporting year start day of --01-01) starts on 2010-07-01. This is day 4 of week 26, therefore the first week matched is week 27.{{/footnote}}444 +* 2010-W27 or later (reporting year start day ~-~-01-01){{footnote}}2010-Q3 (with a reporting year start day of 01-01) starts on 2010-07-01. This is day 4 of week 26, therefore the first week matched is week 27.{{/footnote}} 445 445 * 2010-D182 or later (reporting year start day ~-~-01-01) 446 -* 2010-W28 or later (reporting year start day ~-~-07-01){{footnote}}2010-Q3 (with a reporting year start day of --07-01) starts on 2011-01-01. This is day 6 of week 27, therefore the first week matched is week 28.{{/footnote}}446 +* 2010-W28 or later (reporting year start day ~-~-07-01){{footnote}}2010-Q3 (with a reporting year start day of 07-01) starts on 2011-01-01. This is day 6 of week 27, therefore the first week matched is week 28.{{/footnote}} 447 447 * 2010-D185 or later (reporting year start day ~-~-07-01) 448 448 449 449 == 4.3 Versioning == 450 450 451 -Versioning operates at the (% style="color:#e74c3c" %)level(%%)of versionable and maintainable objects in the [[SDMX information model>>doc:sdmx:Glossary 2\.1.SDMX Information Model.WebHome]]. Within the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] Structure and MetadataSet messages, there is a well-defined pattern for [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] versioning and referencing. The [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] identifiers are qualified by their(% style="color:#e74c3c"%)version(%%)numbers – that is, an object with an Agency of "A", and ID of "X" and a(% style="color:#e74c3c"%)version(%%)of "1.0.0" is a different object than one with an Agency of "A", an ID of "X", and a(% style="color:#e74c3c"%)version(%%)of "1.1.0".451 +Versioning operates at the level of versionable and maintainable objects in the [[SDMX information model>>doc:sdmx:Glossary 2\.1.SDMX Information Model.WebHome]]. Within the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] Structure and MetadataSet messages, there is a well-defined pattern for [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] versioning and referencing. The [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] identifiers are qualified by their [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] numbers – that is, an object with an Agency of "A", and ID of "X" and a [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] of "1.0.0" is a different object than one with an Agency of "A", an ID of "X", and a [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] of "1.1.0". 452 452 453 -As of [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] 3.0, the versioning rules are extended to allow for truly versioned [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] through the implementation of the rules of the well-known practice called "Semantic Versioning" ([[http:~~/~~/semver.org>>https://http:semver.org]]), in addition to the legacy non-restrictive versioning scheme. In addition, the "isFinal" property is removed from //MaintainableArtefact//. According to the legacy versioning, any [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] defined without a (% style="color:#e74c3c"%)version(%%)is equivalent to following the legacy versioning, thus having(% style="color:#e74c3c"%)version(%%)‘1.0’.453 +As of [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] 3.0, the versioning rules are extended to allow for truly versioned [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] through the implementation of the rules of the well-known practice called "Semantic Versioning" ([[http:~~/~~/semver.org>>https://http:semver.org]]), in addition to the legacy non-restrictive versioning scheme. In addition, the "isFinal" property is removed from //MaintainableArtefact//. According to the legacy versioning, any [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] defined without a [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] is equivalent to following the legacy versioning, thus having [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] ‘1.0’. 454 454 455 455 === 4.3.1 Non-versioned artefacts === 456 456 457 -Indeed, some use cases do not need or are incompatible with versioning for some or all their structural [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]], such as the Agency, [[Data Providers>>doc:sdmx:Glossary 2\.1.Data provider.WebHome]], Metadata Providers and [[Data Consumer Schemes>>doc:sdmx:Glossary 2\.1.Data consumer scheme.WebHome]]. These [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] follow the legacy versioning, with a fixed (% style="color:#e74c3c"%)version(%%)set to ‘1.0’.457 +Indeed, some use cases do not need or are incompatible with versioning for some or all their structural [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]], such as the Agency, [[Data Providers>>doc:sdmx:Glossary 2\.1.Data provider.WebHome]], Metadata Providers and [[Data Consumer Schemes>>doc:sdmx:Glossary 2\.1.Data consumer scheme.WebHome]]. These [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] follow the legacy versioning, with a fixed [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] set to ‘1.0’. 458 458 459 -Many existing organisation’s data management systems work with (% style="color:#e74c3c"%)version(%%)-less structures and apply ad-hoc [[structural metadata>>doc:sdmx:Glossary 2\.1.Structural metadata.WebHome]] governance processes. The new nonversioned [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] will allow supporting those numerous situations, where organisations do not manage(% style="color:#e74c3c"%)version(%%)numbers.459 +Many existing organisation’s data management systems work with [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]]-less structures and apply ad-hoc [[structural metadata>>doc:sdmx:Glossary 2\.1.Structural metadata.WebHome]] governance processes. The new nonversioned [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] will allow supporting those numerous situations, where organisations do not manage [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] numbers. 460 460 461 461 === 4.3.2 Semantically versioned artefacts === 462 462 463 -Since the purpose of [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] versioning is to allow communicating the structural [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] changes to [[data exchange>>doc:sdmx:Glossary 2\.1.Data exchange.WebHome]] partners and connected systems, [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] 3.0 offers Semantic Versioning (aka SemVer) with a clear and unambiguous syntax to all semantically versioned [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] 3.0 structural [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]]. Semantic versioning will thus better respond to situations where the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] standard itself is the only structural contract between [[data providers>>doc:sdmx:Glossary 2\.1.Data provider.WebHome]] and [[data consumers>>doc:sdmx:Glossary 2\.1.Data consumer.WebHome]] and where changes in structures can only be communicated through the (% style="color:#e74c3c"%)version(%%)number increases.463 +Since the purpose of [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] versioning is to allow communicating the structural [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] changes to [[data exchange>>doc:sdmx:Glossary 2\.1.Data exchange.WebHome]] partners and connected systems, [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] 3.0 offers Semantic Versioning (aka SemVer) with a clear and unambiguous syntax to all semantically versioned [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] 3.0 structural [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]]. Semantic versioning will thus better respond to situations where the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] standard itself is the only structural contract between [[data providers>>doc:sdmx:Glossary 2\.1.Data provider.WebHome]] and [[data consumers>>doc:sdmx:Glossary 2\.1.Data consumer.WebHome]] and where changes in structures can only be communicated through the [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] number increases. 464 464 465 -The semantic (% style="color:#e74c3c"%)version(%%)number consists of four parts: MAJOR, MINOR, PATCH and EXTENSION, the first three parts being separated by a dot (.), the last two parts being separated by a hyphen : MAJOR.MINOR.PATCH-EXTENSION. All(% style="color:#e74c3c"%)versions(%%)are ordered.465 +The semantic [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] number consists of four parts: MAJOR, MINOR, PATCH and EXTENSION, the first three parts being separated by a dot (.), the last two parts being separated by a hyphen : MAJOR.MINOR.PATCH-EXTENSION. All [[versions>>doc:sdmx:Glossary 2\.1.Version.WebHome]] are ordered. 466 466 467 467 The detailed rules for semantic versioning are listed in chapter 14 in the annex for “Semantic Versioning”. In short, they define: 468 468 469 -Given a (% style="color:#e74c3c"%)version(%%)number MAJOR.MINOR.PATCH (without EXTENSION), when making changes to that semantically versioned [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]], then one must increment the:469 +Given a [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] number MAJOR.MINOR.PATCH (without EXTENSION), when making changes to that semantically versioned [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]], then one must increment the: 470 470 471 -1. MAJOR (% style="color:#e74c3c"%)version(%%)when backwards incompatible [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] changes are made,472 -1. MINOR (% style="color:#e74c3c"%)version(%%)when [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] elements are added in a backwards compatible manner, or473 -1. PATCH (% style="color:#e74c3c"%)version(%%)when backwards compatible [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] property changes are made.471 +1. MAJOR [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] when backwards incompatible [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] changes are made, 472 +1. MINOR [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] when [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] elements are added in a backwards compatible manner, or 473 +1. PATCH [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] when backwards compatible [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] property changes are made. 474 474 475 -When incrementing a (% style="color:#e74c3c"%)version(%%)part, the right-hand side parts are 0-ed (reset to ‘0’).475 +When incrementing a [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] part, the right-hand side parts are 0-ed (reset to ‘0’). 476 476 477 477 Extensions can be added, changed or dropped. 478 478 479 -Given an extended (% style="color:#e74c3c"%)version(%%)number MAJOR.MINOR.PATCH-EXTENSION, when making changes to that versioned [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]], then one is not required to increment the(% style="color:#e74c3c"%)version(%%)if those changes are within the allowed scope of the(% style="color:#e74c3c"%)version(%%)increment from the previous(% style="color:#e74c3c"%)version(%%)(if that existed); otherwise, the above(% style="color:#e74c3c"%)version(%%)increment rules apply. EXTENSIONs can be used e.g., for drafting or a pre-release.479 +Given an extended [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] number MAJOR.MINOR.PATCH-EXTENSION, when making changes to that versioned [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]], then one is not required to increment the [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] if those changes are within the allowed scope of the [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] increment from the previous [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] (if that existed); otherwise, the above [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] increment rules apply. EXTENSIONs can be used e.g., for drafting or a pre-release. 480 480 481 -Semantically versioned [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] will thus be safe to use. Specific (% style="color:#e74c3c"%)version(%%)patterns allow them to become either immutable, i.e., the maintainer commits to never change their content, or changeable only within a well-defined scope. If any further change is required, a new(% style="color:#e74c3c"%)version(%%)must be created first. Furthermore, the impact of the further change is communicated using a clear(% style="color:#e74c3c"%)version(%%)increment. The built-in(% style="color:#e74c3c"%)version(%%)extension facility allows for eased drafting of new [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]](% style="color:#e74c3c"%)versions(%%).481 +Semantically versioned [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] will thus be safe to use. Specific [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] patterns allow them to become either immutable, i.e., the maintainer commits to never change their content, or changeable only within a well-defined scope. If any further change is required, a new [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] must be created first. Furthermore, the impact of the further change is communicated using a clear [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] increment. The built-in [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] extension facility allows for eased drafting of new [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] [[versions>>doc:sdmx:Glossary 2\.1.Version.WebHome]]. 482 482 483 -The production (% style="color:#e74c3c"%)versions(%%)of [[identifiable artefacts>>doc:sdmx:Glossary 2\.1.Identifiable artefact.WebHome]] are assumed stable, i.e., they do not have an EXTENSION. This is because once in production, an [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] cannot change in any way, or it must change the(% style="color:#e74c3c"%)version(%%). For cases where an [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] is not static, like during the drafting, the(% style="color:#e74c3c"%)version(%%)must indicate this by including an EXTENSION. Draft [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] should not be used outside of a specific system designed to accommodate them. For most purposes, all [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] should become stable before being used in production.483 +The production [[versions>>doc:sdmx:Glossary 2\.1.Version.WebHome]] of [[identifiable artefacts>>doc:sdmx:Glossary 2\.1.Identifiable artefact.WebHome]] are assumed stable, i.e., they do not have an EXTENSION. This is because once in production, an [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] cannot change in any way, or it must change the [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]]. For cases where an [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] is not static, like during the drafting, the [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] must indicate this by including an EXTENSION. Draft [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] should not be used outside of a specific system designed to accommodate them. For most purposes, all [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] should become stable before being used in production. 484 484 485 485 === 4.3.3 Legacy-versioned artefacts === 486 486 487 -Organisations wishing to keep a maximum of backwards compatibility with existing implementations can continue using the previous 2-digit convention for (% style="color:#e74c3c"%)version(%%)numbers (MAJOR.MINOR) as in the past, such as '2.3', but without the ‘isFinal’ property. The new [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] 3.0 standard does not add any strict rules or guarantees about changes in those [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]], since the legacy versioning rules were rather loose and non-binding, including the meaning of the ‘isFinal’ property, and their implementations were varying.487 +Organisations wishing to keep a maximum of backwards compatibility with existing implementations can continue using the previous 2-digit convention for [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] numbers (MAJOR.MINOR) as in the past, such as '2.3', but without the ‘isFinal’ property. The new [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] 3.0 standard does not add any strict rules or guarantees about changes in those [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]], since the legacy versioning rules were rather loose and non-binding, including the meaning of the ‘isFinal’ property, and their implementations were varying. 488 488 489 489 In order to make [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] immutable or changes truly predictable, a move to the new semantic versioning syntax is required. 490 490 ... ... @@ -492,28 +492,28 @@ 492 492 493 493 New flexible dependency specifications with wildcarding allow for easier data model maintenance and enhancements for semantically versioned [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]]. This allows implementing a smart referencing mechanism, whereby an [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] may reference: 494 494 495 -* a fixed (% style="color:#e74c3c"%)version(%%)of another [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]]496 -* the **latest available** (% style="color:#e74c3c"%)version(%%)of another [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]]497 -* the **latest backward compatible** (% style="color:#e74c3c"%)version(%%)of another [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]], or the **latest backward and forward** **compatible**(% style="color:#e74c3c"%)version(%%)of another [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]].495 +* a fixed [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] of another [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] 496 +* the **latest available** [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] of another [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] 497 +* the **latest backward compatible** [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] of another [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]], or the **latest backward and forward** **compatible** [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] of another [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]]. 498 498 499 -References not representing a strict [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] dependency, such as the target [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] defined in a MetadataProvisionAgreement allow for linking to **all currently available** (% style="color:#e74c3c"%)versions(%%)of another [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]]. Another illustrative case for such loose referencing is that of(%style="color:#e74c3c"%)Constraints(%%)and flows. A(%style="color:#e74c3c"%)Constraint(%%)may reference many [[Dataflows>>doc:sdmx:Glossary 2\.1.Dataflow.WebHome]] or [[Metadataflows>>doc:sdmx:Glossary 2\.1.Metadataflow.WebHome]], the addition of more references to flow objects does not(% style="color:#e74c3c"%)version(%%)the(%style="color:#e74c3c"%)Constraint(%%). This is because the(%style="color:#e74c3c"%)Constraints(%%)are not properties of the flows – they merely make references to them.499 +References not representing a strict [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] dependency, such as the target [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] defined in a MetadataProvisionAgreement allow for linking to **all currently available** [[versions>>doc:sdmx:Glossary 2\.1.Version.WebHome]] of another [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]]. Another illustrative case for such loose referencing is that of [[Constraints>>doc:sdmx:Glossary 2\.1.Constraint.WebHome]] and flows. A [[Constraint>>doc:sdmx:Glossary 2\.1.Constraint.WebHome]] may reference many [[Dataflows>>doc:sdmx:Glossary 2\.1.Dataflow.WebHome]] or [[Metadataflows>>doc:sdmx:Glossary 2\.1.Metadataflow.WebHome]], the addition of more references to flow objects does not [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] the [[Constraint>>doc:sdmx:Glossary 2\.1.Constraint.WebHome]]. This is because the [[Constraints>>doc:sdmx:Glossary 2\.1.Constraint.WebHome]] are not properties of the flows – they merely make references to them. 500 500 501 -Semantically versioned [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] must only reference other semantically versioned [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]], which may include extended (% style="color:#e74c3c"%)versions(%%). Non-versioned and legacy-versioned [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] can reference any other non-versioned or versioned (whether semantic or legacy) [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]]. The scope of wildcards in references adapts correspondingly.501 +Semantically versioned [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] must only reference other semantically versioned [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]], which may include extended [[versions>>doc:sdmx:Glossary 2\.1.Version.WebHome]]. Non-versioned and legacy-versioned [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] can reference any other non-versioned or versioned (whether semantic or legacy) [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]]. The scope of wildcards in references adapts correspondingly. 502 502 503 503 The mechanism named "early binding" refers to a dependency on a stable versioned [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] – everything with a stable versioned identity is a known quantity and will not change. The "late binding" mechanism is based on a wildcarded reference, and it resolves that reference and determines the currently related [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] at runtime. 504 504 505 -One area which is much impacted by this versioning scheme is the ability to reference external objects. With the many dependencies within the various structural objects in [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]], it is useful to have a scheme for external referencing. This is done at the (% style="color:#e74c3c" %)level(%%)of maintainable objects (DSDs, [[Codelists>>doc:sdmx:Glossary 2\.1.Code list.WebHome]], [[Concept Schemes>>doc:sdmx:Glossary 2\.1.Concept scheme.WebHome]], etc.) In an [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] Structure Message, whenever an "[[isExternalReference>>doc:sdmx:Glossary 2\.1.isExternalReference.WebHome]]" [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] is set to true, then the application must resolve the address provided in the associated "uri" [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] and use the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] Structure Message stored at that location for the full definition of the object in question. Alternately, if a registry "urn" [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] has been provided, the registry can be used to supply the full details of the object.505 +One area which is much impacted by this versioning scheme is the ability to reference external objects. With the many dependencies within the various structural objects in [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]], it is useful to have a scheme for external referencing. This is done at the level of maintainable objects (DSDs, [[Codelists>>doc:sdmx:Glossary 2\.1.Code list.WebHome]], [[Concept Schemes>>doc:sdmx:Glossary 2\.1.Concept scheme.WebHome]], etc.) In an [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] Structure Message, whenever an "[[isExternalReference>>doc:sdmx:Glossary 2\.1.isExternalReference.WebHome]]" [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] is set to true, then the application must resolve the address provided in the associated "uri" [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] and use the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] Structure Message stored at that location for the full definition of the object in question. Alternately, if a registry "urn" [[attribute>>doc:sdmx:Glossary 2\.1.Attribute.WebHome]] has been provided, the registry can be used to supply the full details of the object. 506 506 507 507 The detailed rules for dependency management and references are listed in chapter 14 in the annex for “Semantic Versioning”. 508 508 509 -In order to allow resolving the described new forms of dependencies, the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] 3.0 Rest API supports retrievals legacy-versioned, wildcarded and extended [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] (% style="color:#e74c3c"%)versions(%%):509 +In order to allow resolving the described new forms of dependencies, the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] 3.0 Rest API supports retrievals legacy-versioned, wildcarded and extended [[artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] [[versions>>doc:sdmx:Glossary 2\.1.Version.WebHome]]: 510 510 511 -* [[Artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] queries for a **specific** (% style="color:#e74c3c"%)version(%%)(X.Y, X.Y.Z or X.Y.Z-EXT).512 -* [[Artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] queries for **latest available** semantic (% style="color:#e74c3c"%)versions(%%)within the wildcard scope (X+.Y.Z, X.Y+.Z or X.Y.Z+).511 +* [[Artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] queries for a **specific** [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] (X.Y, X.Y.Z or X.Y.Z-EXT). 512 +* [[Artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] queries for **latest available** semantic [[versions>>doc:sdmx:Glossary 2\.1.Version.WebHome]] within the wildcard scope (X+.Y.Z, X.Y+.Z or X.Y.Z+). 513 513 * Queries for **non-versioned** [[artefacts>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]]. 514 -* [[Artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] queries for **all available** semantic (% style="color:#e74c3c"%)versions(%%)within the wildcard scope (*, X.* or X.Y.*), where only the first form is required for resolving wildcarded loose references.514 +* [[Artefact>>doc:sdmx:Glossary 2\.1.Artefact.WebHome]] queries for **all available** semantic [[versions>>doc:sdmx:Glossary 2\.1.Version.WebHome]] within the wildcard scope (*, X.* or X.Y.*), where only the first form is required for resolving wildcarded loose references. 515 515 516 -The combination of wildcarded queries with a specific (% style="color:#e74c3c"%)version(%%)extension is not permitted.516 +The combination of wildcarded queries with a specific [[version>>doc:sdmx:Glossary 2\.1.Version.WebHome]] extension is not permitted. 517 517 518 518 Full details can be found in the [[SDMX>>doc:sdmx:Glossary 2\.1.Statistical data and metadata exchange.WebHome]] RESTful web services specification. 519 519