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

From version 4.2
edited by Helena
on 2025/06/11 00:24
Change comment: There is no comment for this version
To version 5.3
edited by Elena
on 2025/06/26 21:41
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.helena
1 +xwiki:XWiki.elenasemanticproorg
Content
... ... @@ -78,7 +78,7 @@
78 78  
79 79  === 4.1.1 Data Types ===
80 80  
81 -XML and JSON schemas support a variety of data types that, although rich, are not (% style="color:#e74c3c" %)mapped(%%) one-to-one in all cases. This section provides an explanation of the mapping performed in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0, between such cases.
81 +XML and JSON schemas support a variety of data types that, although rich, are not mapped one-to-one in all cases. This section provides an explanation of the mapping performed in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0, between such cases.
82 82  
83 83  For identifiers, text fields and [[Codes>>doc:sdmx:Glossary.Code.WebHome]] there are no restriction from either side, since a generic type (e.g., that of string) accompanied by the proper regular expression works equally well for both XML and JSON.
84 84  
... ... @@ -99,7 +99,7 @@
99 99  > "pattern": "^[A-Za-z0-9_@$-]+$"
100 100  > }
101 101  
102 -There are also cases, though, that data types cannot be (% style="color:#e74c3c" %)mapped(%%) like above. One such case is the array data type, which was introduced in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 as a new [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. In JSON schema an array is already natively foreseen, while in the XML schema, this has to be defined as a complex type, with an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] specific definition (i.e., specific element/[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] names for [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]). Beyond that, the minimum and/or maximum number of items within an array is possible in both cases.
102 +There are also cases, though, that data types cannot be mapped like above. One such case is the array data type, which was introduced in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 as a new [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. In JSON schema an array is already natively foreseen, while in the XML schema, this has to be defined as a complex type, with an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] specific definition (i.e., specific element/[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] names for [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]). Beyond that, the minimum and/or maximum number of items within an array is possible in both cases.
103 103  
104 104  Further to the above, the mapping between the non-native data types is presented in the table below:
105 105  
... ... @@ -229,7 +229,7 @@
229 229  [[Representation>>doc:sdmx:Glossary.Representation.WebHome]]: common:ReportingDayType (YYYY-Dddd, e.g. 2000-D366) Notes: There are either 365 or 366 days in a reporting year, depending on whether the reporting year includes leap day (February 29). The reporting day is always represented as three digits, therefore 1-99 are 0 padded (e.g. 001). This allows the values to be sorted chronologically using textual sorting methods.
230 230  The meaning of a reporting year is always based on the start day of the year and requires that the reporting year is expressed as the year at the start of the period. This start day is always the same for a reporting year, and is expressed as a day and a month (e.g. July 1). Therefore, the reporting year 2000 with a start day of July 1 begins on July 1, 2000.
231 231  
232 -A specialized [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] (reporting year start day) exists for the purpose of communicating the reporting year start day. This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] has a fixed identifier (REPORTING_YEAR_START_DAY) and a fixed [[representation>>doc:sdmx:Glossary.Representation.WebHome]] (xs:gMonthDay) so that it can always be easily identified and processed in a data message. Although this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] exists in specialized sub-class, it functions the same as any other [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] outside of its identification and [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. It must takes its identity from a (% style="color:#e74c3c" %)concept(%%) and state its relationship with other [[components>>doc:sdmx:Glossary.Component.WebHome]] of the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. The ability to state this relationship allows this reporting year start day [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] to exist at the appropriate (% style="color:#e74c3c" %)levels(%%) of a data message. In the absence of this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], the reporting year start date is assumed to be January 1; therefore if the reporting year coincides with the calendar year, this [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not necessary.
232 +A specialized [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] (reporting year start day) exists for the purpose of communicating the reporting year start day. This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] has a fixed identifier (REPORTING_YEAR_START_DAY) and a fixed [[representation>>doc:sdmx:Glossary.Representation.WebHome]] (xs:gMonthDay) so that it can always be easily identified and processed in a data message. Although this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] exists in specialized sub-class, it functions the same as any other [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] outside of its identification and [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. It must takes its identity from a [[concept >>doc:Glossary.Concept.WebHome]]and state its relationship with other [[components>>doc:sdmx:Glossary.Component.WebHome]] of the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. The ability to state this relationship allows this reporting year start day [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] to exist at the appropriate levels of a data message. In the absence of this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], the reporting year start date is assumed to be January 1; therefore if the reporting year coincides with the calendar year, this [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not necessary.
233 233  
234 234  Since the duration and the reporting year start day are known for any reporting period, it is possible to relate any reporting period to a distinct calendar period. The actual Gregorian calendar period covered by the reporting period can be computed as follows (based on the standard format of [REPROTING_YEAR]-[PERIOD_INDICATOR][PERIOD_VALUE] and the reporting year start day as [REPORTING_YEAR_START_DAY]):
235 235  
... ... @@ -240,7 +240,7 @@
240 240  a) **If the [PERIOD_INDICATOR] is W:**
241 241  
242 242  **~1. If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday:**
243 -Add[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[4~]^^>>path:#_ftn4]](%%) (P3D, P2D, or P1D respectively) to the 
243 +Add[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[4~]^^>>path:#_ftn4]](%%) (P3D, P2D, or P1D respectively) to the 
244 244  [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE].
245 245  
246 246  2. **If [REPORTING_YEAR_START_DATE] is a Monday, Tuesday, Wednesday, or Thursday:**
... ... @@ -327,7 +327,7 @@
327 327  
328 328  === 4.2.8 Time Format ===
329 329  
330 -In (% style="color:#e74c3c" %)version(%%) 2.0 of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] there is a recommendation to use the [[time format>>doc:sdmx:Glossary.Time format.WebHome]] [[attribute>>doc:sdmx:Glossary.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.Time format.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] in [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]].
330 +In version 2.0 of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] there is a recommendation to use the [[time format>>doc:sdmx:Glossary.Time format.WebHome]] [[attribute>>doc:sdmx:Glossary.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.Time format.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] in [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]].
331 331  
332 332  (% style="width:890.835px" %)
333 333  |(% style="width:95px" %)**Code**|(% style="width:793px" %)**Format**
... ... @@ -372,7 +372,7 @@
372 372  * Reporting Day: 2006-D156**-05:00**
373 373  * Reporting Year Start Day: 07-01**-05:00**
374 374  
375 -According to ISO 8601, a date without a time-zone is considered "local time". [[SDMX>>doc:sdmx:Glossary.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.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.
375 +According to ISO 8601, a date without a time-zone is considered "local time". [[SDMX>>doc:sdmx:Glossary.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.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 376  
377 377  === 4.2.10 Representing Time Spans Elsewhere ===
378 378  
... ... @@ -390,7 +390,7 @@
390 390  
391 391  === 4.2.12 Effect on Time Ranges ===
392 392  
393 -All [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] data messages are capable of functioning in a manner similar to SDMXEDI if the [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) is time: the [[time period>>doc:sdmx:Glossary.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.
393 +All [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] data messages are capable of functioning in a manner similar to SDMXEDI if the [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation level is time: the [[time period>>doc:sdmx:Glossary.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 394  
395 395  === 4.2.13 Time in Query Messages ===
396 396  
... ... @@ -447,43 +447,43 @@
447 447  
448 448  == 4.3 Versioning ==
449 449  
450 -Versioning operates at the (% style="color:#e74c3c" %)level(%%) of versionable and maintainable objects in the [[SDMX information model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]. Within the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Structure and MetadataSet messages, there is a well-defined pattern for [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] versioning and referencing. The [[artefact>>doc:sdmx:Glossary.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".
450 +Versioning operates at the level of versionable and maintainable objects in the [[SDMX information model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]. Within the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Structure and MetadataSet messages, there is a well-defined pattern for [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] versioning and referencing. The [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] identifiers are qualified by their (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) numbers – that is, an object with an Agency of "A", and ID of "X" and a (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) 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>>doc:sdmx:Glossary.Version.WebHome]](%%) of "1.1.0".
451 451  
452 -As of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0, the versioning rules are extended to allow for truly versioned [[artefacts>>doc:sdmx:Glossary.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.Artefact.WebHome]] defined without a (% style="color:#e74c3c" %)version(%%) is equivalent to following the legacy versioning, thus having (% style="color:#e74c3c" %)version(%%) ‘1.0’.
452 +As of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0, the versioning rules are extended to allow for truly versioned [[artefacts>>doc:sdmx:Glossary.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.Artefact.WebHome]] defined without a (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) is equivalent to following the legacy versioning, thus having (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) ‘1.0’.
453 453  
454 454  === 4.3.1 Non-versioned artefacts ===
455 455  
456 -Indeed, some use cases do not need or are incompatible with versioning for some or all their structural [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]], such as the Agency, [[Data Providers>>doc:sdmx:Glossary.Data provider.WebHome]], Metadata Providers and [[Data Consumer Schemes>>doc:sdmx:Glossary.Data consumer scheme.WebHome]]. These [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] follow the legacy versioning, with a fixed (% style="color:#e74c3c" %)version(%%) set to ‘1.0’.
456 +Indeed, some use cases do not need or are incompatible with versioning for some or all their structural [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]], such as the Agency, [[Data Providers>>doc:sdmx:Glossary.Data provider.WebHome]], Metadata Providers and [[Data Consumer Schemes>>doc:sdmx:Glossary.Data consumer scheme.WebHome]]. These [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] follow the legacy versioning, with a fixed (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) set to ‘1.0’.
457 457  
458 -Many existing organisation’s data management systems work with (% style="color:#e74c3c" %)version(%%)-less structures and apply ad-hoc [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] governance processes. The new nonversioned [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] will allow supporting those numerous situations, where organisations do not manage (% style="color:#e74c3c" %)version(%%) numbers.
458 +Many existing organisation’s data management systems work with (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%)-less structures and apply ad-hoc [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] governance processes. The new nonversioned [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] will allow supporting those numerous situations, where organisations do not manage (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) numbers.
459 459  
460 460  === 4.3.2 Semantically versioned artefacts ===
461 461  
462 -Since the purpose of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] versioning is to allow communicating the structural [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] changes to data exchange partners and connected systems, [[SDMX>>doc:sdmx:Glossary.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.Statistical data and metadata exchange.WebHome]] 3.0 structural [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]. Semantic versioning will thus better respond to situations where the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] standard itself is the only structural contract between [[data providers>>doc:sdmx:Glossary.Data provider.WebHome]] and [[data consumers>>doc:sdmx:Glossary.Data consumer.WebHome]] and where changes in structures can only be communicated through the (% style="color:#e74c3c" %)version(%%) number increases.
462 +Since the purpose of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] versioning is to allow communicating the structural [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] changes to data exchange partners and connected systems, [[SDMX>>doc:sdmx:Glossary.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.Statistical data and metadata exchange.WebHome]] 3.0 structural [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]. Semantic versioning will thus better respond to situations where the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] standard itself is the only structural contract between [[data providers>>doc:sdmx:Glossary.Data provider.WebHome]] and [[data consumers>>doc:sdmx:Glossary.Data consumer.WebHome]] and where changes in structures can only be communicated through the (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) number increases.
463 463  
464 -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.
464 +The semantic (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.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 (% style="color:#e74c3c" %)[[versions>>doc:sdmx:Glossary.Version.WebHome]](%%) are ordered.
465 465  
466 466  The detailed rules for semantic versioning are listed in chapter 14 in the annex for “Semantic Versioning”. In short, they define:
467 467  
468 -Given a (% style="color:#e74c3c" %)version(%%) number MAJOR.MINOR.PATCH (without EXTENSION), when making changes to that semantically versioned [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]], then one must increment the:
468 +Given a (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) number MAJOR.MINOR.PATCH (without EXTENSION), when making changes to that semantically versioned [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]], then one must increment the:
469 469  
470 -1. MAJOR (% style="color:#e74c3c" %)version(%%) when backwards incompatible [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] changes are made,
471 -1. MINOR (% style="color:#e74c3c" %)version(%%) when [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] elements are added in a backwards compatible manner, or
472 -1. PATCH (% style="color:#e74c3c" %)version(%%) when backwards compatible [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] property changes are made.
470 +1. MAJOR (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) when backwards incompatible [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] changes are made,
471 +1. MINOR (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) when [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] elements are added in a backwards compatible manner, or
472 +1. PATCH (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) when backwards compatible [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] property changes are made.
473 473  
474 -When incrementing a (% style="color:#e74c3c" %)version(%%) part, the right-hand side parts are 0-ed (reset to ‘0’).
474 +When incrementing a (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) part, the right-hand side parts are 0-ed (reset to ‘0’).
475 475  
476 476  Extensions can be added, changed or dropped.
477 477  
478 -Given an extended (% style="color:#e74c3c" %)version(%%) number MAJOR.MINOR.PATCH-EXTENSION, when making changes to that versioned [[artefact>>doc:sdmx:Glossary.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.
478 +Given an extended (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) number MAJOR.MINOR.PATCH-EXTENSION, when making changes to that versioned [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]], then one is not required to increment the (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) if those changes are within the allowed scope of the (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) increment from the previous (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) (if that existed); otherwise, the above (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) increment rules apply. EXTENSIONs can be used e.g., for drafting or a pre-release.
479 479  
480 -Semantically versioned [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[artefacts>>doc:sdmx:Glossary.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.Statistical data and metadata exchange.WebHome]] [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] (% style="color:#e74c3c" %)versions(%%).
480 +Semantically versioned [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] will thus be safe to use. Specific (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.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 (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) must be created first. Furthermore, the impact of the further change is communicated using a clear (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) increment. The built-in (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) extension facility allows for eased drafting of new [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] (% style="color:#e74c3c" %)[[versions>>doc:sdmx:Glossary.Version.WebHome]](%%).
481 481  
482 -The production (% style="color:#e74c3c" %)versions(%%) of [[identifiable artefacts>>doc:sdmx:Glossary.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.Artefact.WebHome]] cannot change in any way, or it must change the (% style="color:#e74c3c" %)version(%%). For cases where an [[artefact>>doc:sdmx:Glossary.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.Artefact.WebHome]] should not be used outside of a specific system designed to accommodate them. For most purposes, all [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] should become stable before being used in production.
482 +The production (% style="color:#e74c3c" %)[[versions>>doc:sdmx:Glossary.Version.WebHome]](%%) of [[identifiable artefacts>>doc:sdmx:Glossary.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.Artefact.WebHome]] cannot change in any way, or it must change the (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%). For cases where an [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is not static, like during the drafting, the (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) must indicate this by including an EXTENSION. Draft [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] should not be used outside of a specific system designed to accommodate them. For most purposes, all [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] should become stable before being used in production.
483 483  
484 484  === 4.3.3 Legacy-versioned artefacts ===
485 485  
486 -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.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.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.
486 +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>>doc:sdmx:Glossary.Version.WebHome]](%%) numbers (MAJOR.MINOR) as in the past, such as '2.3', but without the ‘isFinal’ property. The new [[SDMX>>doc:sdmx:Glossary.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.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 487  
488 488  In order to make [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] immutable or changes truly predictable, a move to the new semantic versioning syntax is required.
489 489  
... ... @@ -491,28 +491,28 @@
491 491  
492 492  New flexible dependency specifications with wildcarding allow for easier data model maintenance and enhancements for semantically versioned [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]. This allows implementing a smart referencing mechanism, whereby an [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] may reference:
493 493  
494 -* a fixed (% style="color:#e74c3c" %)version(%%) of another [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]]
495 -* the **latest available** (% style="color:#e74c3c" %)version(%%) of another [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]]
496 -* the **latest backward compatible** (% style="color:#e74c3c" %)version(%%) of another [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]], or the **latest backward and forward** **compatible** (% style="color:#e74c3c" %)version(%%) of another [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]].
494 +* a fixed (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) of another [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]]
495 +* the **latest available** (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) of another [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]]
496 +* the **latest backward compatible** (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) of another [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]], or the **latest backward and forward** **compatible** (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) of another [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]].
497 497  
498 -References not representing a strict [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] dependency, such as the target [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] defined in a MetadataProvisionAgreement allow for linking to **all currently available** (% style="color:#e74c3c" %)versions(%%) of another [[artefact>>doc:sdmx:Glossary.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.Dataflow.WebHome]] or [[Metadataflows>>doc:sdmx:Glossary.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.
498 +References not representing a strict [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] dependency, such as the target [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] defined in a MetadataProvisionAgreement allow for linking to **all currently available** (% style="color:#e74c3c" %)[[versions>>doc:sdmx:Glossary.Version.WebHome]](%%) of another [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]]. Another illustrative case for such loose referencing is that of (% style="color:#e74c3c" %)[[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]](%%) and flows. A (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) may reference many [[Dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]] or [[Metadataflows>>doc:sdmx:Glossary.Metadataflow.WebHome]], the addition of more references to flow objects does not (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) the (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%). This is because the (% style="color:#e74c3c" %)[[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]](%%) are not properties of the flows – they merely make references to them.
499 499  
500 -Semantically versioned [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] must only reference other semantically versioned [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]], which may include extended (% style="color:#e74c3c" %)versions(%%). Non-versioned and legacy-versioned [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] can reference any other non-versioned or versioned (whether semantic or legacy) [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]. The scope of wildcards in references adapts correspondingly.
500 +Semantically versioned [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] must only reference other semantically versioned [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]], which may include extended (% style="color:#e74c3c" %)[[versions>>doc:sdmx:Glossary.Version.WebHome]](%%). Non-versioned and legacy-versioned [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] can reference any other non-versioned or versioned (whether semantic or legacy) [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]. The scope of wildcards in references adapts correspondingly.
501 501  
502 502  The mechanism named "early binding" refers to a dependency on a stable versioned [[artefact>>doc:sdmx:Glossary.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.Artefact.WebHome]] at runtime.
503 503  
504 -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.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, [[Concept Schemes>>doc:sdmx:Glossary.Concept scheme.WebHome]], etc.) In an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Structure Message, whenever an "[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]" [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is set to true, then the application must resolve the address provided in the associated "uri" [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] and use the [[SDMX>>doc:sdmx:Glossary.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.Attribute.WebHome]] has been provided, the registry can be used to supply the full details of the object.
504 +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.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 ([[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]]s, [[Codelists>>doc:sdmx:Glossary.Code list.WebHome]], [[Concept Schemes>>doc:sdmx:Glossary.Concept scheme.WebHome]], etc.) In an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Structure Message, whenever an "[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]" [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is set to true, then the application must resolve the address provided in the associated "uri" [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] and use the [[SDMX>>doc:sdmx:Glossary.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.Attribute.WebHome]] has been provided, the registry can be used to supply the full details of the object.
505 505  
506 506  The detailed rules for dependency management and references are listed in chapter 14 in the annex for “Semantic Versioning”.
507 507  
508 -In order to allow resolving the described new forms of dependencies, the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 Rest API supports retrievals legacy-versioned, wildcarded and extended [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] (% style="color:#e74c3c" %)versions(%%):
508 +In order to allow resolving the described new forms of dependencies, the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 Rest API supports retrievals legacy-versioned, wildcarded and extended [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] (% style="color:#e74c3c" %)[[versions>>doc:sdmx:Glossary.Version.WebHome]](%%):
509 509  
510 -* [[Artefact>>doc:sdmx:Glossary.Artefact.WebHome]] queries for a **specific** (% style="color:#e74c3c" %)version(%%) (X.Y, X.Y.Z or X.Y.Z-EXT).
511 -* [[Artefact>>doc:sdmx:Glossary.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+).
510 +* [[Artefact>>doc:sdmx:Glossary.Artefact.WebHome]] queries for a **specific** (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) (X.Y, X.Y.Z or X.Y.Z-EXT).
511 +* [[Artefact>>doc:sdmx:Glossary.Artefact.WebHome]] queries for **latest available** semantic (% style="color:#e74c3c" %)[[versions>>doc:sdmx:Glossary.Version.WebHome]](%%) within the wildcard scope (X+.Y.Z, X.Y+.Z or X.Y.Z+).
512 512  * Queries for **non-versioned** [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]].
513 -* [[Artefact>>doc:sdmx:Glossary.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.
513 +* [[Artefact>>doc:sdmx:Glossary.Artefact.WebHome]] queries for **all available** semantic (% style="color:#e74c3c" %)[[versions>>doc:sdmx:Glossary.Version.WebHome]](%%) within the wildcard scope (*, X.* or X.Y.*), where only the first form is required for resolving wildcarded loose references.
514 514  
515 -The combination of wildcarded queries with a specific (% style="color:#e74c3c" %)version(%%) extension is not permitted.
515 +The combination of wildcarded queries with a specific (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) extension is not permitted.
516 516  
517 517  Full details can be found in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web services specification.
518 518