Changes for page 4 General Notes for Implementers

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

From 6.5 to 7.1 From 9.1 to 10.1

From version 7.1

edited by Artur
on 2025/05/21 10:49

Change comment: There is no comment for this version

To version 9.1

edited by Artur
on 2025/05/22 14:46

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Objects (1 modified, 0 added, 0 removed)
- SUZ.Methodology.Code.MethodologyClass[0]

Details

Page properties

Content

@@ -77,7 +77,7 @@
  === {{id name="_Toc291505"/}}4.1.1 Data Types ===
--XML and JSON schemas support a variety of data types that, although rich, are not (% style="color:#2ecc71" %)mapped(%%) one-to-one in all cases. This section provides an explanation of the mapping performed in [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] 3.0, between such cases.
++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:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] 3.0, between such cases.
  For identifiers, text fields and [[Codes>>doc:xwiki: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.
@@ -98,7 +98,7 @@
  >   "pattern": "^[A-Za-z0-9_@$-]+$"
  > }
--There are also cases, though, that data types cannot be (% style="color:#2ecc71" %)mapped(%%) like above. One such case is the array data type, which was introduced in [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 as a new [[representation>>doc:xwiki: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:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] specific definition (i.e., specific element/[[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] names for [[SDMX>>doc:xwiki: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.
++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:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 as a new [[representation>>doc:xwiki: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:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] specific definition (i.e., specific element/[[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] names for [[SDMX>>doc:xwiki: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.
  Further to the above, the mapping between the non-native data types is presented in the table below:
@@ -278,7 +278,7 @@
  A specialized [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] (reporting year start day) exists for the purpose of communicating the reporting year start day. This [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] has a fixed identifier
--(REPORTING_YEAR_START_DAY) and a fixed [[representation>>doc:xwiki:Glossary.Representation.WebHome]] (xs:gMonthDay) so that it can always be easily identified and processed in a data message. Although this [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] exists in specialized sub-class, it functions the same as any other [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] outside of its identification and [[representation>>doc:xwiki:Glossary.Representation.WebHome]]. It must takes its identity from a (% style="color:#2ecc71" %)concept(%%) and state its relationship with other [[components>>doc:xwiki:Glossary.Component.WebHome]] of the [[data structure definition>>doc:xwiki:Glossary.Data structure definition.WebHome]]. The ability to state this relationship allows this reporting year start day [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] to exist at the appropriate (% style="color:#2ecc71" %)levels(%%) of a data message. In the absence of this [[attribute>>doc:xwiki: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:xwiki:Glossary.Attribute.WebHome]] is not necessary.
++(REPORTING_YEAR_START_DAY) and a fixed [[representation>>doc:xwiki:Glossary.Representation.WebHome]] (xs:gMonthDay) so that it can always be easily identified and processed in a data message. Although this [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] exists in specialized sub-class, it functions the same as any other [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] outside of its identification and [[representation>>doc:xwiki:Glossary.Representation.WebHome]]. It must takes its identity from a (% style="color:#e74c3c" %)concept(%%) and state its relationship with other [[components>>doc:xwiki:Glossary.Component.WebHome]] of the [[data structure definition>>doc:xwiki:Glossary.Data structure definition.WebHome]]. The ability to state this relationship allows this reporting year start day [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] to exist at the appropriate (% style="color:#e74c3c" %)levels(%%) of a data message. In the absence of this [[attribute>>doc:xwiki: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:xwiki:Glossary.Attribute.WebHome]] is not necessary.
  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]):
@@ -355,7 +355,7 @@
  === {{id name="_Toc291514"/}}4.2.8 Time Format ===
--In (% style="color:#2ecc71" %)version(%%) 2.0 of [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] there is a recommendation to use the [[time format>>doc:xwiki:Glossary.Time format.WebHome]] [[attribute>>doc:xwiki: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:xwiki:Glossary.Time format.WebHome]] [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] in [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]].
++In (% style="color:#e74c3c" %)version(%%) 2.0 of [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] there is a recommendation to use the [[time format>>doc:xwiki:Glossary.Time format.WebHome]] [[attribute>>doc:xwiki: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:xwiki:Glossary.Time format.WebHome]] [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] in [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]].
  (% style="width:771.294px" %)
  |**Code**|(% style="width:659px" %)**Format**
@@ -400,7 +400,7 @@
  * Reporting Day: 2006-D156**-05:00**
  * Reporting Year Start Day: 07-01**-05:00**
--According to ISO 8601, a date without a time-zone is considered "local time". [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] assumes that local time is that of the sender of the message. In this (% style="color:#2ecc71" %)version(%%) of [[SDMX>>doc:xwiki: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.
++According to ISO 8601, a date without a time-zone is considered "local time". [[SDMX>>doc:xwiki: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:xwiki: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.
  === {{id name="_Toc291516"/}}4.2.10 Representing Time Spans Elsewhere ===
@@ -418,7 +418,7 @@
  === {{id name="_Toc291518"/}}4.2.12 Effect on Time Ranges ===
--All [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] data messages are capable of functioning in a manner similar to SDMXEDI if the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] at the observation (% style="color:#2ecc71" %)level(%%) is time: the [[time period>>doc:xwiki: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.
++All [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] data messages are capable of functioning in a manner similar to SDMXEDI if the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) is time: the [[time period>>doc:xwiki: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.
  === 4.2.13 Time in Query Messages ===
@@ -475,15 +475,15 @@
  == 4.3 Versioning ==
--Versioning operates at the (% style="color:#2ecc71" %)level(%%) of versionable and maintainable objects in the [[SDMX information model>>doc:xwiki:Glossary.SDMX Information Model.WebHome]]. Within the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Structure and MetadataSet messages, there is a well-defined pattern for [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] versioning and referencing. The [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] identifiers are qualified by their (% style="color:#2ecc71" %)version(%%) numbers – that is, an object with an Agency of "A", and ID of "X" and a (% style="color:#2ecc71" %)version(%%) of "1.0.0" is a different object than one with an Agency of "A", an ID of "X", and a (% style="color:#2ecc71" %)version(%%) of "1.1.0".
++Versioning operates at the (% style="color:#e74c3c" %)level(%%) of versionable and maintainable objects in the [[SDMX information model>>doc:xwiki:Glossary.SDMX Information Model.WebHome]]. Within the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Structure and MetadataSet messages, there is a well-defined pattern for [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] versioning and referencing. The [[artefact>>doc:xwiki: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".
--As of [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] 3.0, the versioning rules are extended to allow for truly versioned [[artefacts>>doc:xwiki: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:xwiki:Glossary.Artefact.WebHome]] defined without a (% style="color:#2ecc71" %)version(%%) is equivalent to following the legacy versioning, thus having (% style="color:#2ecc71" %)version(%%) ‘1.0’.
++As of [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] 3.0, the versioning rules are extended to allow for truly versioned [[artefacts>>doc:xwiki: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:xwiki: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’.
  === 4.3.1 Non-versioned artefacts ===
--Indeed, some use cases do not need or are incompatible with versioning for some or all their structural [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]], such as the Agency, [[Data Providers>>doc:xwiki:Glossary.Data provider.WebHome]], Metadata Providers and [[Data Consumer Schemes>>doc:xwiki:Glossary.Data consumer scheme.WebHome]]. These [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] follow the legacy versioning, with a fixed (% style="color:#2ecc71" %)version(%%) set to ‘1.0’.
++Indeed, some use cases do not need or are incompatible with versioning for some or all their structural [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]], such as the Agency, [[Data Providers>>doc:xwiki:Glossary.Data provider.WebHome]], Metadata Providers and [[Data Consumer Schemes>>doc:xwiki:Glossary.Data consumer scheme.WebHome]]. These [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] follow the legacy versioning, with a fixed (% style="color:#e74c3c" %)version(%%) set to ‘1.0’.
--Many existing organisation’s data management systems work with (% style="color:#2ecc71" %)version(%%)-less structures and apply ad-hoc [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] governance processes. The new nonversioned [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] will allow supporting those numerous situations, where organisations do not manage (% style="color:#2ecc71" %)version(%%) numbers.
++Many existing organisation’s data management systems work with (% style="color:#e74c3c" %)version(%%)-less structures and apply ad-hoc [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] governance processes. The new nonversioned [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] will allow supporting those numerous situations, where organisations do not manage (% style="color:#e74c3c" %)version(%%) numbers.
 -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.
@@ -491,31 +491,31 @@
  === 4.3.2 Semantically versioned artefacts ===
--Since the purpose of [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] versioning is to allow communicating the structural [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] changes to data exchange partners and connected systems, [[SDMX>>doc:xwiki: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:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 structural [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]]. Semantic versioning will thus better respond to situations where the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] standard itself is the only structural contract between [[data providers>>doc:xwiki:Glossary.Data provider.WebHome]] and [[data consumers>>doc:xwiki:Glossary.Data consumer.WebHome]] and where changes in structures can only be communicated through the (% style="color:#2ecc71" %)version(%%) number increases.
++Since the purpose of [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] versioning is to allow communicating the structural [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] changes to data exchange partners and connected systems, [[SDMX>>doc:xwiki: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:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 structural [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]]. Semantic versioning will thus better respond to situations where the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] standard itself is the only structural contract between [[data providers>>doc:xwiki:Glossary.Data provider.WebHome]] and [[data consumers>>doc:xwiki:Glossary.Data consumer.WebHome]] and where changes in structures can only be communicated through the (% style="color:#e74c3c" %)version(%%) number increases.
--The semantic (% style="color:#2ecc71" %)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:#2ecc71" %)versions(%%) are ordered.
++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.
  The detailed rules for semantic versioning are listed in chapter 14 in the annex for “Semantic Versioning”. In short, they define:
--Given a (% style="color:#2ecc71" %)version(%%) number MAJOR.MINOR.PATCH (without EXTENSION), when making changes to that semantically versioned [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]], then one must increment the:
++Given a (% style="color:#e74c3c" %)version(%%) number MAJOR.MINOR.PATCH (without EXTENSION), when making changes to that semantically versioned [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]], then one must increment the:
--1. MAJOR (% style="color:#2ecc71" %)version(%%) when backwards incompatible [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] changes are made,
--1. MINOR (% style="color:#2ecc71" %)version(%%) when [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] elements are added in a backwards compatible manner, or
--1. PATCH (% style="color:#2ecc71" %)version(%%) when backwards compatible [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] property changes are made.
++1. MAJOR (% style="color:#e74c3c" %)version(%%) when backwards incompatible [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] changes are made,
++1. MINOR (% style="color:#e74c3c" %)version(%%) when [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] elements are added in a backwards compatible manner, or
++1. PATCH (% style="color:#e74c3c" %)version(%%) when backwards compatible [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] property changes are made.
--When incrementing a (% style="color:#2ecc71" %)version(%%) part, the right-hand side parts are 0-ed (reset to ‘0’).
++When incrementing a (% style="color:#e74c3c" %)version(%%) part, the right-hand side parts are 0-ed (reset to ‘0’).
  Extensions can be added, changed or dropped.
--iven an extended (% style="color:#2ecc71" %)version(%%) number MAJOR.MINOR.PATCH-EXTENSION, when making changes to that versioned [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]], then one is not required to increment the (% style="color:#2ecc71" %)version(%%) if those changes are within the allowed scope of the (% style="color:#2ecc71" %)version(%%) increment from the previous (% style="color:#2ecc71" %)version(%%) (if that existed); otherwise, the above (% style="color:#2ecc71" %)version(%%) increment rules apply. EXTENSIONs can be used e.g., for drafting or a pre-release.
++iven an extended (% style="color:#e74c3c" %)version(%%) number MAJOR.MINOR.PATCH-EXTENSION, when making changes to that versioned [[artefact>>doc:xwiki: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.
--Semantically versioned [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] will thus be safe to use. Specific (% style="color:#2ecc71" %)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:#2ecc71" %)version(%%) must be created first. Furthermore, the impact of the further change is communicated using a clear (% style="color:#2ecc71" %)version(%%) increment. The built-in (% style="color:#2ecc71" %)version(%%) extension facility allows for eased drafting of new [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] (% style="color:#2ecc71" %)versions(%%).
++Semantically versioned [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] [[artefacts>>doc:xwiki: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:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] (% style="color:#e74c3c" %)versions(%%).
--The production (% style="color:#2ecc71" %)versions(%%) of [[identifiable artefacts>>doc:xwiki:Glossary.Identifiable artefact.WebHome]] are assumed stable, i.e., they do not have an EXTENSION. This is because once in production, an [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] cannot change in any way, or it must change the (% style="color:#2ecc71" %)version(%%). For cases where an [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] is not static, like during the drafting, the (% style="color:#2ecc71" %)version(%%) must indicate this by including an EXTENSION. Draft [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] should not be used outside of a specific system designed to accommodate them. For most purposes, all [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] should become stable before being used in production.
++The production (% style="color:#e74c3c" %)versions(%%) of [[identifiable artefacts>>doc:xwiki:Glossary.Identifiable artefact.WebHome]] are assumed stable, i.e., they do not have an EXTENSION. This is because once in production, an [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] cannot change in any way, or it must change the (% style="color:#e74c3c" %)version(%%). For cases where an [[artefact>>doc:xwiki: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:xwiki:Glossary.Artefact.WebHome]] should not be used outside of a specific system designed to accommodate them. For most purposes, all [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] should become stable before being used in production.
  === 4.3.3 Legacy-versioned artefacts ===
--Organisations wishing to keep a maximum of backwards compatibility with existing implementations can continue using the previous 2-digit convention for (% style="color:#2ecc71" %)version(%%) numbers (MAJOR.MINOR) as in the past, such as '2.3', but without the ‘isFinal’ property. The new [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 standard does not add any strict rules or guarantees about changes in those [[artefacts>>doc:xwiki: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.
++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:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 standard does not add any strict rules or guarantees about changes in those [[artefacts>>doc:xwiki: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.
  In order to make [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] immutable or changes truly predictable, a move to the new semantic versioning syntax is required.
@@ -523,28 +523,28 @@
  New flexible dependency specifications with wildcarding allow for easier data model maintenance and enhancements for semantically versioned [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]]. This allows implementing a smart referencing mechanism, whereby an [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] may reference:
--* a fixed (% style="color:#2ecc71" %)version(%%) of another [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]]
--* the **latest available** (% style="color:#2ecc71" %)version(%%) of another [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]]
--* the **latest backward compatible** (% style="color:#2ecc71" %)version(%%) of another [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]], or the **latest backward and forward** **compatible** (% style="color:#2ecc71" %)version(%%) of another [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]].
++* a fixed (% style="color:#e74c3c" %)version(%%) of another [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]]
++* the **latest available** (% style="color:#e74c3c" %)version(%%) of another [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]]
++* the **latest backward compatible** (% style="color:#e74c3c" %)version(%%) of another [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]], or the **latest backward and forward** **compatible** (% style="color:#e74c3c" %)version(%%) of another [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]].
--References not representing a strict [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] dependency, such as the target [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] defined in a MetadataProvisionAgreement allow for linking to **all currently available** (% style="color:#2ecc71" %)versions(%%) of another [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]]. Another illustrative case for such loose referencing is that of (% style="color:#2ecc71" %)Constraints(%%) and flows. A (% style="color:#2ecc71" %)Constraint(%%) may reference many [[Dataflows>>doc:xwiki:Glossary.Dataflow.WebHome]] or [[Metadataflows>>doc:xwiki:Glossary.Metadataflow.WebHome]], the addition of more references to flow objects does not (% style="color:#2ecc71" %)version(%%) the (% style="color:#2ecc71" %)Constraint(%%). This is because the (% style="color:#2ecc71" %)Constraints(%%) are not properties of the flows – they merely make references to them.
++References not representing a strict [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] dependency, such as the target [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] defined in a MetadataProvisionAgreement allow for linking to **all currently available** (% style="color:#e74c3c" %)versions(%%) of another [[artefact>>doc:xwiki: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:xwiki:Glossary.Dataflow.WebHome]] or [[Metadataflows>>doc:xwiki: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.
--Semantically versioned [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] must only reference other semantically versioned [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]], which may include extended (% style="color:#2ecc71" %)versions(%%). Non-versioned and legacy-versioned [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] can reference any other non-versioned or versioned (whether semantic or legacy) [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]]. The scope of wildcards in references adapts correspondingly.
++Semantically versioned [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] must only reference other semantically versioned [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]], which may include extended (% style="color:#e74c3c" %)versions(%%). Non-versioned and legacy-versioned [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] can reference any other non-versioned or versioned (whether semantic or legacy) [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]]. The scope of wildcards in references adapts correspondingly.
  The mechanism named "early binding" refers to a dependency on a stable versioned [[artefact>>doc:xwiki: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:xwiki:Glossary.Artefact.WebHome]] at runtime.
--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:xwiki:Glossary.Statistical data and metadata exchange.WebHome]], it is useful to have a scheme for external referencing. This is done at the (% style="color:#2ecc71" %)level(%%) of maintainable objects (DSDs, Codelists, [[Concept Schemes>>doc:xwiki:Glossary.Concept scheme.WebHome]], etc.) In an [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Structure Message, whenever an [[isExternalReference>>doc:xwiki:Glossary.isExternalReference.WebHome]] [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is set to true, then the application must resolve the address provided in the associated "uri" [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] and use the [[SDMX>>doc:xwiki: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:xwiki:Glossary.Attribute.WebHome]] has been provided, the registry can be used to supply the full details of the object.
++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:xwiki: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:xwiki:Glossary.Concept scheme.WebHome]], etc.) In an [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Structure Message, whenever an [[isExternalReference>>doc:xwiki:Glossary.isExternalReference.WebHome]] [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is set to true, then the application must resolve the address provided in the associated "uri" [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] and use the [[SDMX>>doc:xwiki: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:xwiki:Glossary.Attribute.WebHome]] has been provided, the registry can be used to supply the full details of the object.
  The detailed rules for dependency management and references are listed in chapter 14 in the annex for “Semantic Versioning”.
--In order to allow resolving the described new forms of dependencies, the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 Rest API supports retrievals legacy-versioned, wildcarded and extended [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] (% style="color:#2ecc71" %)versions(%%):
++In order to allow resolving the described new forms of dependencies, the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 Rest API supports retrievals legacy-versioned, wildcarded and extended [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] (% style="color:#e74c3c" %)versions(%%):
--* [[Artefact>>doc:xwiki:Glossary.Artefact.WebHome]] queries for a **specific** (% style="color:#2ecc71" %)version(%%) (X.Y, X.Y.Z or X.Y.Z-EXT).
--* [[Artefact>>doc:xwiki:Glossary.Artefact.WebHome]] queries for **latest available** semantic (% style="color:#2ecc71" %)versions(%%) within the wildcard scope (X+.Y.Z, X.Y+.Z or X.Y.Z+).
++* [[Artefact>>doc:xwiki:Glossary.Artefact.WebHome]] queries for a **specific** (% style="color:#e74c3c" %)version(%%) (X.Y, X.Y.Z or X.Y.Z-EXT).
++* [[Artefact>>doc:xwiki: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+).
  * Queries for **non-versioned** [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]].
--* [[Artefact>>doc:xwiki:Glossary.Artefact.WebHome]] queries for **all available** semantic (% style="color:#2ecc71" %)versions(%%) within the wildcard scope (*, X.* or X.Y.*), where only the first form is required for resolving wildcarded loose references.
++* [[Artefact>>doc:xwiki: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.
--The combination of wildcarded queries with a specific (% style="color:#2ecc71" %)version(%%) extension is not permitted.
++The combination of wildcarded queries with a specific (% style="color:#e74c3c" %)version(%%) extension is not permitted.
  Full details can be found in the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web services specification.

SUZ.Methodology.Code.MethodologyClass[0]

index

...	...	@@ -1,0 +1,1 @@
	1	+4