Changes for page 4 General Notes for Implementers

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

From 9.1 to 8.1 From 13.1 to 12.1

From version 12.1

edited by Artur
on 2025/05/27 15:50

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)

Details

Page properties

Content

@@ -2,13 +2,13 @@
  {{toc/}}
  {{/box}}
--This section discusses a number of topics other than the exchange of [[data sets>>doc:Glossary.Data set.WebHome]] in [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] formats. Supported only in [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]] (and some in [[SDMX-JSON>>doc:Glossary.SDMX-JSON.WebHome]]), these topics include the use of the [[reference metadata>>doc:Glossary.Reference metadata.WebHome]] mechanism in [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]], the use of [[Structure Sets>>doc:Glossary.Structure set.WebHome]] and [[Reporting Taxonomies>>doc:Glossary.Reporting taxonomy.WebHome]], the use of Processes, a discussion of time and datatyping, and the conventional mechanisms within the [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]] Structure message regarding versioning and referencing.
++This section discusses a number of topics other than the exchange of [[data sets>>doc:xwiki:Glossary.Data set.WebHome]] in [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] formats. Supported only in [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] (and some in [[SDMX-JSON>>doc:xwiki:Glossary.SDMX-JSON.WebHome]]), these topics include the use of the [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] mechanism in [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]], the use of [[Structure Sets>>doc:xwiki:Glossary.Structure set.WebHome]] and [[Reporting Taxonomies>>doc:xwiki:Glossary.Reporting taxonomy.WebHome]], the use of Processes, a discussion of time and datatyping, and the conventional mechanisms within the [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] Structure message regarding versioning and referencing.
  == {{id name="_Toc291504"/}}4.1 Representations ==
  This section does not go into great detail on these topics but provides a useful overview of these features to assist implementors in further use of the parts of the specification which are relevant to them.
--There are several different [[representations>>doc:Glossary.Representation.WebHome]] in [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]], taken from XML Schemas and common programming languages. The table below describes the various [[representations>>doc:Glossary.Representation.WebHome]], which are found in [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]], and their equivalents.
++There are several different [[representations>>doc:xwiki:Glossary.Representation.WebHome]] in [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]], taken from XML Schemas and common programming languages. The table below describes the various [[representations>>doc:xwiki:Glossary.Representation.WebHome]], which are found in [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]], and their equivalents.
  (% style="width:1185.29px" %)
  |(% style="width:250px" %)**SDMX-ML Data Type**|(% style="width:285px" %)**XML Schema Data Type**|(% style="width:271px" %)**.NET Framework Type**|(% style="width:354px" %)**Java Data Type**
@@ -30,7 +30,7 @@
  |(% style="width:250px" %)Day, MonthDay, Month|(% style="width:285px" %)xsd:g*|(% style="width:271px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
  |(% style="width:250px" %)Duration|(% style="width:285px" %)xsd:duration|(% style="width:271px" %)System.TimeSpan|(% style="width:354px" %)javax.xml.datatype.Dura tion
--There are also a number of [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]] data types which do not have these direct correspondences, often because they are composite [[representations>>doc:Glossary.Representation.WebHome]] or restrictions of a broader data type. For most of these, there are simple types which can be referenced from the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] schemas, for others a derived simple type will be necessary:
++There are also a number of [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] data types which do not have these direct correspondences, often because they are composite [[representations>>doc:xwiki:Glossary.Representation.WebHome]] or restrictions of a broader data type. For most of these, there are simple types which can be referenced from the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] schemas, for others a derived simple type will be necessary:
  * AlphaNumeric (common:AlphaNumericType, string which only allows A-z and 0-9)
  * Alpha (common:AlphaType, string which only allows A-z)
@@ -37,7 +37,7 @@
  * Numeric (common:NumericType, string which only allows 0-9, but is not numeric so that is can having leading zeros)
  * Count (xs:integer, a sequence with an interval of "1")
  * InclusiveValueRange (xs:decimal with the minValue and maxValue facets supplying the bounds)
--* ExclusiveValueRange (xs:decimal with the minValue and maxValue [[facets>>doc:Glossary.Facet.WebHome]] supplying the bounds)
++* ExclusiveValueRange (xs:decimal with the minValue and maxValue [[facets>>doc:xwiki:Glossary.Facet.WebHome]] supplying the bounds)
  * Incremental (xs:decimal with a specified interval; the interval is typically enforced outside of the XML validation)
  * TimeRange (common:TimeRangeType, startDateTime + Duration)
  * ObservationalTimePeriod (common:ObservationalTimePeriodType, a union of StandardTimePeriod and TimeRange).
@@ -57,29 +57,29 @@
  * IdentifiableReference (types for each IdentifiableObject)
  * GeospatialInformation (a geo feature set, according to the pattern in section 7.2)
--Data types also have a set of [[facets>>doc:Glossary.Facet.WebHome]]:
++Data types also have a set of [[facets>>doc:xwiki:Glossary.Facet.WebHome]]:
  * isSequence = true | false (indicates a sequentially increasing value)
  * minLength = positive integer (# of characters/digits)
  * maxLength = positive integer (# of characters/digits)
--* startValue = [[decimal>>doc:Glossary.Decimals.WebHome]] (for numeric sequence)
--* endValue = [[decimal>>doc:Glossary.Decimals.WebHome]] (for numeric sequence)
--* interval = [[decimal>>doc:Glossary.Decimals.WebHome]] (for numeric sequence)
++* startValue = [[decimal>>doc:xwiki:Glossary.Decimals.WebHome]] (for numeric sequence)
++* endValue = [[decimal>>doc:xwiki:Glossary.Decimals.WebHome]] (for numeric sequence)
++* interval = [[decimal>>doc:xwiki:Glossary.Decimals.WebHome]] (for numeric sequence)
  * timeInterval = duration
  * startTime = BasicTimePeriod (for time range) endTime = BasicTimePeriod (for time range)
--* minValue = [[decimal>>doc:Glossary.Decimals.WebHome]] (for numeric range)
--* maxValue = [[decimal>>doc:Glossary.Decimals.WebHome]] (for numeric range)
--* [[decimal>>doc:Glossary.Decimals.WebHome]] = Integer (# of digits to right of [[decimal>>doc:Glossary.Decimals.WebHome]] point)
++* minValue = [[decimal>>doc:xwiki:Glossary.Decimals.WebHome]] (for numeric range)
++* maxValue = [[decimal>>doc:xwiki:Glossary.Decimals.WebHome]] (for numeric range)
++* [[decimal>>doc:xwiki:Glossary.Decimals.WebHome]] = Integer (# of digits to right of [[decimal>>doc:xwiki:Glossary.Decimals.WebHome]] point)
  * pattern = (a regular expression, as per W3C XML Schema)
  * isMultiLingual = boolean (for specifying text can occur in more than one language)
--Note that [[code lists>>doc:Glossary.Code list.WebHome]] may also have textual [[representations>>doc:Glossary.Representation.WebHome]] assigned to them, in addition to their enumeration of [[codes>>doc:Glossary.Code.WebHome]].
++Note that [[code lists>>doc:xwiki:Glossary.Code list.WebHome]] may also have textual [[representations>>doc:xwiki:Glossary.Representation.WebHome]] assigned to them, in addition to their enumeration of [[codes>>doc:xwiki:Glossary.Code.WebHome]].
  === {{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:#e74c3c" %)mapped(%%) one-to-one in all cases. This section provides an explanation of the mapping performed in [[SDMX>>doc: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: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.
++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.
  For example, for the id type, this is the XML schema definition:
@@ -98,7 +98,7 @@
  >   "pattern": "^[A-Za-z0-9_@$-]+$"
  > }
--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:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 as a new [[representation>>doc: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:Glossary.Statistical data and metadata exchange.WebHome]] specific definition (i.e., specific element/[[attribute>>doc:Glossary.Attribute.WebHome]] names for [[SDMX>>doc: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:
@@ -132,11 +132,11 @@
  === {{id name="_Toc291507"/}}4.2.1 Introduction ===
--First, it is important to recognize that most observation times are a period. [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] specifies precisely how Time is handled.
++First, it is important to recognize that most observation times are a period. [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] specifies precisely how Time is handled.
--The [[representation>>doc:Glossary.Representation.WebHome]] of time is broken into a hierarchical collection of [[representations>>doc:Glossary.Representation.WebHome]]. A [[data structure definition>>doc:Glossary.Data structure definition.WebHome]] can use of any of the [[representations>>doc:Glossary.Representation.WebHome]] in the [[hierarchy>>doc:Glossary.Hierarchy.WebHome]] as the [[representation>>doc:Glossary.Representation.WebHome]] of time. This allows for the time [[dimension>>doc:Glossary.Dimension.WebHome]] of a particular [[data structure definition>>doc:Glossary.Data structure definition.WebHome]] allow for only a subset of the default [[representation>>doc:Glossary.Representation.WebHome]].
++The [[representation>>doc:xwiki:Glossary.Representation.WebHome]] of time is broken into a hierarchical collection of [[representations>>doc:xwiki:Glossary.Representation.WebHome]]. A [[data structure definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] can use of any of the [[representations>>doc:xwiki:Glossary.Representation.WebHome]] in the [[hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] as the [[representation>>doc:xwiki:Glossary.Representation.WebHome]] of time. This allows for the time [[dimension>>doc:xwiki:Glossary.Dimension.WebHome]] of a particular [[data structure definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] allow for only a subset of the default [[representation>>doc:xwiki:Glossary.Representation.WebHome]].
--The [[hierarchy>>doc:Glossary.Hierarchy.WebHome]] of [[time formats>>doc:Glossary.Time format.WebHome]] is as follows (**bold** indicates a [[category>>doc:Glossary.Category.WebHome]] which is made up of multiple formats, //italic// indicates a distinct format):
++The [[hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] of [[time formats>>doc:xwiki:Glossary.Time format.WebHome]] is as follows (**bold** indicates a [[category>>doc:xwiki:Glossary.Category.WebHome]] which is made up of multiple formats, //italic// indicates a distinct format):
  * **Observational Time Period**
  ** **Standard Time Period**
@@ -146,43 +146,43 @@
  *** **Reporting Time Period**
  ** **//Time Range//**
--The details of these [[time period>>doc:Glossary.Time period.WebHome]] [[categories>>doc:Glossary.Category.WebHome]] and of the distinct formats which make them up are detailed in the sections to follow.
++The details of these [[time period>>doc:xwiki:Glossary.Time period.WebHome]] [[categories>>doc:xwiki:Glossary.Category.WebHome]] and of the distinct formats which make them up are detailed in the sections to follow.
  === {{id name="_Toc291508"/}}4.2.2 Observational Time Period ===
--This is the superset of all time [[representations>>doc:Glossary.Representation.WebHome]] in [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]. This allows for time to be expressed as any of the allowable formats.
++This is the superset of all time [[representations>>doc:xwiki:Glossary.Representation.WebHome]] in [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]]. This allows for time to be expressed as any of the allowable formats.
  === {{id name="_Toc291509"/}}4.2.3 Standard Time Period ===
--This is the superset of any predefined [[time period>>doc:Glossary.Time period.WebHome]] or a distinct point in time. A [[time period>>doc:Glossary.Time period.WebHome]] consists of a distinct start and end point. If the start and end of a period are expressed as date instead of a complete date time, then it is implied that the start of the period is the beginning of the start day (i.e. 00:00:00) and the end of the period is the end of the end day (i.e. 23:59:59).
++This is the superset of any predefined [[time period>>doc:xwiki:Glossary.Time period.WebHome]] or a distinct point in time. A [[time period>>doc:xwiki:Glossary.Time period.WebHome]] consists of a distinct start and end point. If the start and end of a period are expressed as date instead of a complete date time, then it is implied that the start of the period is the beginning of the start day (i.e. 00:00:00) and the end of the period is the end of the end day (i.e. 23:59:59).
  === {{id name="_Toc291510"/}}4.2.4 Gregorian Time Period ===
--A Gregorian [[time period>>doc:Glossary.Time period.WebHome]] is always represented by a Gregorian year, year-month, or day. These are all based on ISO 8601 dates. The [[representation>>doc:Glossary.Representation.WebHome]] in [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]] messages and the period covered by each of the Gregorian [[time periods>>doc:Glossary.Time period.WebHome]] are as follows:
++A Gregorian [[time period>>doc:xwiki:Glossary.Time period.WebHome]] is always represented by a Gregorian year, year-month, or day. These are all based on ISO 8601 dates. The [[representation>>doc:xwiki:Glossary.Representation.WebHome]] in [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] messages and the period covered by each of the Gregorian [[time periods>>doc:xwiki:Glossary.Time period.WebHome]] are as follows:
  **Gregorian Year:**
--[[Representation>>doc:Glossary.Representation.WebHome]]: xs:gYear (YYYY)
++[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: xs:gYear (YYYY)
  Period: the start of January 1 to the end of December 31
  **Gregorian Year Month**:
--[[Representation>>doc:Glossary.Representation.WebHome]]: xs:gYearMonth (YYYY-MM)
++[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: xs:gYearMonth (YYYY-MM)
  Period: the start of the first day of the month to end of the last day of the month
  **Gregorian Day**:
--[[Representation>>doc:Glossary.Representation.WebHome]]: xs:date (YYYY-MM-DD)
++[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: xs:date (YYYY-MM-DD)
  Period: the start of the day (00:00:00) to the end of the day (23:59:59)
  === {{id name="_Toc291511"/}}4.2.5 Date Time ===
--This is used to unambiguously state that a date-time represents an observation at a single point in time. Therefore, if one wants to use [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] for data which is measured at a distinct point in time rather than being reported over a period, the date-time [[representation>>doc:Glossary.Representation.WebHome]] can be used.
++This is used to unambiguously state that a date-time represents an observation at a single point in time. Therefore, if one wants to use [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] for data which is measured at a distinct point in time rather than being reported over a period, the date-time [[representation>>doc:xwiki:Glossary.Representation.WebHome]] can be used.
--[[Representation>>doc:Glossary.Representation.WebHome]]: xs:dateTime (YYYY-MM-DDThh:mm:ss){{footnote}}The seconds can be reported fractionally{{/footnote}}
++[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: xs:dateTime (YYYY-MM-DDThh:mm:ss){{footnote}}The seconds can be reported fractionally{{/footnote}}
  === {{id name="_Toc291512"/}}4.2.6 Standard Reporting Period ===
@@ -196,61 +196,89 @@
  PERIOD_VALUE indicates the actual period within the year
--The following section details each of the standard reporting periods defined in [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]:
++The following section details each of the standard reporting periods defined in [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]]:
  **Reporting Year**:
++
  Period Indicator: A
++
  Period Duration: P1Y (one year)
++
  Limit per year: 1
--[[Representation>>doc:Glossary.Representation.WebHome]]: common:ReportingYearType (YYYY-A1, e.g. 2000-A1)
++[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: common:ReportingYearType (YYYY-A1, e.g. 2000-A1)
++
  **Reporting Semester:**
++
  Period Indicator: S
++
  Period Duration: P6M (six months)
++
  Limit per year: 2
--[[Representation>>doc:Glossary.Representation.WebHome]]: common:ReportingSemesterType (YYYY-Ss, e.g. 2000-S2)
++[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: common:ReportingSemesterType (YYYY-Ss, e.g. 2000-S2)
++
  **Reporting Trimester:**
++
  Period Indicator: T
++
  Period Duration: P4M (four months)
++
  Limit per year: 3
--[[Representation>>doc:Glossary.Representation.WebHome]]: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3)
++[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3)
++
  **Reporting Quarter:**
++
  Period Indicator: Q
++
  Period Duration: P3M (three months)
++
  Limit per year: 4
--[[Representation>>doc:Glossary.Representation.WebHome]]: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4)
++[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4)
++
  **Reporting Month**:
++
  Period Indicator: M
++
  Period Duration: P1M (one month)
++
  Limit per year: 1
--[[Representation>>doc:Glossary.Representation.WebHome]]: common:ReportingMonthType (YYYY-Mmm, e.g. 2000-M12)
++[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: common:ReportingMonthType (YYYY-Mmm, e.g. 2000-M12)
++
  Notes: The reporting month is always represented as two digits, therefore 1-9 are 0 padded (e.g. 01). This allows the values to be sorted chronologically using textual sorting methods.
  **Reporting Week**:
++
  Period Indicator: W
++
  Period Duration: P7D (seven days)
++
  Limit per year: 53
--[[Representation>>doc:Glossary.Representation.WebHome]]: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53)
++[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53)
++
  Notes: There are either 52 or 53 weeks in a reporting year. This is based on the ISO 8601 definition of a week (Monday - Saturday), where the first week of a reporting year is defined as the week with the first Thursday on or after the reporting year start day.{{footnote}}ISO 8601 defines alternative definitions for the first week, all of which produce equivalent results. Any of these definitions could be substituted so long as they are in relation to the reporting year start day.{{/footnote}} The reporting week is always represented as two digits, therefore 1-9 are 0 padded (e.g. 01). This allows the values to be sorted chronologically using textual sorting methods.
  **Reporting Day**:
++
  Period Indicator: D
++
  Period Duration: P1D (one day)
++
  Limit per year: 366
--[[Representation>>doc:Glossary.Representation.WebHome]]: common:ReportingDayType (YYYY-Dddd, e.g. 2000-D366)
++[[Representation>>doc:xwiki: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.
  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.
--A specialized [[attribute>>doc:Glossary.Attribute.WebHome]] (reporting year start day) exists for the purpose of communicating the reporting year start day. This [[attribute>>doc:Glossary.Attribute.WebHome]] has a fixed identifier
++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:Glossary.Representation.WebHome]] (xs:gMonthDay) so that it can always be easily identified and processed in a data message. Although this [[attribute>>doc:Glossary.Attribute.WebHome]] exists in specialized sub-class, it functions the same as any other [[attribute>>doc:Glossary.Attribute.WebHome]] outside of its identification and [[representation>>doc:Glossary.Representation.WebHome]]. It must takes its identity from a (% style="color:#e74c3c" %)concept(%%) and state its relationship with other [[components>>doc:Glossary.Component.WebHome]] of the [[data structure definition>>doc:Glossary.Data structure definition.WebHome]]. The ability to state this relationship allows this reporting year start day [[attribute>>doc:Glossary.Attribute.WebHome]] to exist at the appropriate (% style="color:#e74c3c" %)levels(%%) of a data message. In the absence of this [[attribute>>doc: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: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]):
@@ -263,6 +263,7 @@
        ~1. **If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday**:
         Add{{footnote}}The rules for adding durations to a date time are described in the W3C XML Schema specification. See http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes for further details.{{/footnote}} (P3D, P2D, or P1D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE].
++
  **~      2. If [REPORTING_YEAR_START_DATE] is a Monday, Tuesday, Wednesday, or Thursday:**
        Add^^4^^ (P0D, -P1D, -P2D, or -P3D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE].
@@ -277,12 +277,12 @@
  e) If the [PERIOD_INDICATOR] is M, the [PERIOD_DURATION] is P1M.
  f) If the [PERIOD_INDICATOR] is W, the [PERIOD_DURATION] is P7D.
  g) If the [PERIOD_INDICATOR] is D, the [PERIOD_DURATION] is P1D.
--
--
  **3. Determine [PERIOD_START]:**
++
  Subtract one from the [PERIOD_VALUE] and multiply this by the [PERIOD_DURATION]. Add{{footnote}}The rules for adding durations to a date time are described in the W3C XML Schema specification. See http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes for further details.{{/footnote}} this to the [REPORTING_YEAR_BASE]. The result is the [PERIOD_START].
  **4. Determine the [PERIOD_END]:**
++
  Multiply the [PERIOD_VALUE] by the [PERIOD_DURATION]. Add{{footnote}}The rules for adding durations to a date time are described in the W3C XML Schema specification. See http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes for further details.{{/footnote}} this to the [REPORTING_YEAR_BASE] add{{footnote}}The rules for adding durations to a date time are described in the W3C XML Schema specification. See http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes for further details.{{/footnote}} -P1D. The result is the [PERIOD_END].
  For all of these ranges, the bounds include the beginning of the [PERIOD_START] (i.e. 00:00:00) and the end of the [PERIOD_END] (i.e. 23:59:59).
@@ -326,14 +326,14 @@
  === {{id name="_Toc291514"/}}4.2.8 Time Format ===
--In (% style="color:#e74c3c" %)version(%%) 2.0 of [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] there is a recommendation to use the [[time format>>doc:Glossary.Time format.WebHome]] [[attribute>>doc: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:Glossary.Time format.WebHome]] [[attribute>>doc:Glossary.Attribute.WebHome]] in [[SDMX-ML>>doc: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**
--|OTP|(% style="width:659px" %)Observational [[Time Period>>doc:Glossary.Time period.WebHome]]: Superset of all [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] [[time formats>>doc:Glossary.Time format.WebHome]] (Gregorian [[Time Period>>doc:Glossary.Time period.WebHome]], Reporting [[Time Period>>doc:Glossary.Time period.WebHome]], and Time Range)
--|STP|(% style="width:659px" %)Standard [[Time Period>>doc:Glossary.Time period.WebHome]]: Superset of Gregorian and Reporting [[Time Periods>>doc:Glossary.Time period.WebHome]]
--|GTP|(% style="width:659px" %)Superset of all Gregorian [[Time Periods>>doc:Glossary.Time period.WebHome]] and date-time
--|RTP|(% style="width:659px" %)Superset of all Reporting [[Time Periods>>doc:Glossary.Time period.WebHome]]
++|OTP|(% style="width:659px" %)Observational [[Time Period>>doc:xwiki:Glossary.Time period.WebHome]]: Superset of all [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] [[time formats>>doc:xwiki:Glossary.Time format.WebHome]] (Gregorian [[Time Period>>doc:xwiki:Glossary.Time period.WebHome]], Reporting [[Time Period>>doc:xwiki:Glossary.Time period.WebHome]], and Time Range)
++|STP|(% style="width:659px" %)Standard [[Time Period>>doc:xwiki:Glossary.Time period.WebHome]]: Superset of Gregorian and Reporting [[Time Periods>>doc:xwiki:Glossary.Time period.WebHome]]
++|GTP|(% style="width:659px" %)Superset of all Gregorian [[Time Periods>>doc:xwiki:Glossary.Time period.WebHome]] and date-time
++|RTP|(% style="width:659px" %)Superset of all Reporting [[Time Periods>>doc:xwiki:Glossary.Time period.WebHome]]
  |TR|(% style="width:659px" %)(((
  Time Range: Start time and duration (YYYY-MM-DD(Thh:mm:ss)?/)
  )))
@@ -354,7 +354,7 @@
  === {{id name="_Toc291515"/}}4.2.9 Time Zones ===
--In alignment with ISO 8601, [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] allows the specification of a time zone on all [[time periods>>doc:Glossary.Time period.WebHome]] and on the reporting year start day. If a time zone is provided on a reporting year start day, then the same time zone (or none) should be reported for each reporting [[time period>>doc:Glossary.Time period.WebHome]]. If the reporting year start day and the reporting period time zone differ, the time zone of the reporting period will take precedence. Examples of each format with time zones are as follows (time zone indicated in bold):
++In alignment with ISO 8601, [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] allows the specification of a time zone on all [[time periods>>doc:xwiki:Glossary.Time period.WebHome]] and on the reporting year start day. If a time zone is provided on a reporting year start day, then the same time zone (or none) should be reported for each reporting [[time period>>doc:xwiki:Glossary.Time period.WebHome]]. If the reporting year start day and the reporting period time zone differ, the time zone of the reporting period will take precedence. Examples of each format with time zones are as follows (time zone indicated in bold):
  * Time Range (start date): 2006-06-05**-05:00**/P5D
  * Time Range (start date-time): 2006-06-05T00:00:00**-05:00**/P5D
@@ -371,11 +371,11 @@
  * 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: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: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 ===
--It has been possible since [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] 2.0 for a [[Component>>doc:Glossary.Component.WebHome]] to specify a [[representation>>doc:Glossary.Representation.WebHome]] of a time span. Depending on the format of the data message, this resulted in either an element with 2 XML [[attributes>>doc:Glossary.Attribute.WebHome]] for holding the start time and the duration or two separate XML [[attributes>>doc:Glossary.Attribute.WebHome]] based on the underlying [[Component>>doc:Glossary.Component.WebHome]] identifier. For example, if REF_PERIOD were given a [[representation>>doc:Glossary.Representation.WebHome]] of time span, then in the Compact data format, it would be represented by two XML [[attributes>>doc:Glossary.Attribute.WebHome]]; REF_PERIODStartTime (holding the start) and REF_PERIOD (holding the duration). If a new simple type is introduced in the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] schemas that can hold ISO 8601 time intervals, then this will no longer be necessary. What was represented as this:
++It has been possible since [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] 2.0 for a [[Component>>doc:xwiki:Glossary.Component.WebHome]] to specify a [[representation>>doc:xwiki:Glossary.Representation.WebHome]] of a time span. Depending on the format of the data message, this resulted in either an element with 2 XML [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]] for holding the start time and the duration or two separate XML [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]] based on the underlying [[Component>>doc:xwiki:Glossary.Component.WebHome]] identifier. For example, if REF_PERIOD were given a [[representation>>doc:xwiki:Glossary.Representation.WebHome]] of time span, then in the Compact data format, it would be represented by two XML [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]]; REF_PERIODStartTime (holding the start) and REF_PERIOD (holding the duration). If a new simple type is introduced in the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] schemas that can hold ISO 8601 time intervals, then this will no longer be necessary. What was represented as this:
  > <Series REF_PERIODStartTime="2000-01-01T00:00:00" REF_PERIOD="P2M"/>
@@ -385,17 +385,17 @@
  === {{id name="_Toc291517"/}}4.2.11 Notes on Formats ===
--There is no ambiguity in these formats so that for any given value of time, the [[category>>doc:Glossary.Category.WebHome]] of the period (and thus the intended [[time period>>doc:Glossary.Time period.WebHome]] range) is always clear. It should also be noted that by utilizing the ISO 8601 format, and a format loosely based on it for the report periods, the values of time can easily be sorted chronologically without additional parsing.
++There is no ambiguity in these formats so that for any given value of time, the [[category>>doc:xwiki:Glossary.Category.WebHome]] of the period (and thus the intended [[time period>>doc:xwiki:Glossary.Time period.WebHome]] range) is always clear. It should also be noted that by utilizing the ISO 8601 format, and a format loosely based on it for the report periods, the values of time can easily be sorted chronologically without additional parsing.
  === {{id name="_Toc291518"/}}4.2.12 Effect on Time Ranges ===
--All [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]] data messages are capable of functioning in a manner similar to SDMXEDI if the [[Dimension>>doc:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) is time: the [[time period>>doc: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 ===
--When querying for time values, the value of a time parameter can be provided as any of the Observational [[Time Period>>doc:Glossary.Time period.WebHome]] formats and must be paired with an operator. This section will detail how systems processing query messages should interpret these parameters.
++When querying for time values, the value of a time parameter can be provided as any of the Observational [[Time Period>>doc:xwiki:Glossary.Time period.WebHome]] formats and must be paired with an operator. This section will detail how systems processing query messages should interpret these parameters.
--Fundamental to processing a time value parameter in a query message is understanding that all [[time periods>>doc:Glossary.Time period.WebHome]] should be handled as a distinct range of time. Since the time parameter in the query is paired with an operator, this also effectively represents a distinct range of time. Therefore, a system processing the query must simply match the data where the [[time period>>doc:Glossary.Time period.WebHome]] for requested parameter is encompassed by the [[time period>>doc:Glossary.Time period.WebHome]] resulting from value of the query parameter. The following table details how the operators should be interpreted for any [[time period>>doc:Glossary.Time period.WebHome]] provided as a parameter.
++Fundamental to processing a time value parameter in a query message is understanding that all [[time periods>>doc:xwiki:Glossary.Time period.WebHome]] should be handled as a distinct range of time. Since the time parameter in the query is paired with an operator, this also effectively represents a distinct range of time. Therefore, a system processing the query must simply match the data where the [[time period>>doc:xwiki:Glossary.Time period.WebHome]] for requested parameter is encompassed by the [[time period>>doc:xwiki:Glossary.Time period.WebHome]] resulting from value of the query parameter. The following table details how the operators should be interpreted for any [[time period>>doc:xwiki:Glossary.Time period.WebHome]] provided as a parameter.
  (% style="width:1020.29px" %)
  |(% style="width:236px" %)**Operator**|(% style="width:781px" %)**Rule**
@@ -405,7 +405,7 @@
  |(% style="width:236px" %)Less Than or Equal To|(% style="width:781px" %)Any data on or before the last moment of the period
  |(% style="width:236px" %)Equal To|(% style="width:781px" %)Any data which falls on or after the first moment of the period and before or on the last moment of the period
--Reporting [[Time Periods>>doc:Glossary.Time period.WebHome]] as query parameters are handled like this: any data within the bounds of the reporting period for the year is matched, regardless of the actual start day of the reporting year. In addition, data reported against a normal calendar period is matched if it falls within the bounds of the time parameter based on a reporting year start day of January 1. When determining whether another reporting period falls within the bounds of a report period query parameter, one will have to take into account the actual [[time period>>doc:Glossary.Time period.WebHome]] to compare weeks and days to higher order report periods. This will be demonstrated in the examples to follow.
++Reporting [[Time Periods>>doc:xwiki:Glossary.Time period.WebHome]] as query parameters are handled like this: any data within the bounds of the reporting period for the year is matched, regardless of the actual start day of the reporting year. In addition, data reported against a normal calendar period is matched if it falls within the bounds of the time parameter based on a reporting year start day of January 1. When determining whether another reporting period falls within the bounds of a report period query parameter, one will have to take into account the actual [[time period>>doc:xwiki:Glossary.Time period.WebHome]] to compare weeks and days to higher order report periods. This will be demonstrated in the examples to follow.
  **Examples:**
@@ -446,84 +446,85 @@
  == 4.3 Versioning ==
--Versioning operates at the (% style="color:#e74c3c" %)level(%%) of versionable and maintainable objects in the [[SDMX information model>>doc:Glossary.SDMX Information Model.WebHome]]. Within the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Structure and MetadataSet messages, there is a well-defined pattern for [[artefact>>doc:Glossary.Artefact.WebHome]] versioning and referencing. The [[artefact>>doc: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".
++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:Glossary.Statistical data and metadata exchange.WebHome]] 3.0, the versioning rules are extended to allow for truly versioned [[artefacts>>doc: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: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’.
++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:Glossary.Artefact.WebHome]], such as the Agency, [[Data Providers>>doc:Glossary.Data provider.WebHome]], Metadata Providers and [[Data Consumer Schemes>>doc:Glossary.Data consumer scheme.WebHome]]. These [[artefacts>>doc:Glossary.Artefact.WebHome]] follow the legacy versioning, with a fixed (% style="color:#e74c3c" %)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:#e74c3c" %)version(%%)-less structures and apply ad-hoc [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] governance processes. The new nonversioned [[artefacts>>doc:Glossary.Artefact.WebHome]] will allow supporting those numerous situations, where organisations do not manage (% style="color:#e74c3c" %)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.
++
 -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.
  === 4.3.2 Semantically versioned artefacts ===
--Since the purpose of [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] versioning is to allow communicating the structural [[artefact>>doc:Glossary.Artefact.WebHome]] changes to data exchange partners and connected systems, [[SDMX>>doc: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:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 structural [[artefacts>>doc:Glossary.Artefact.WebHome]]. Semantic versioning will thus better respond to situations where the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] standard itself is the only structural contract between [[data providers>>doc:Glossary.Data provider.WebHome]] and [[data consumers>>doc:Glossary.Data consumer.WebHome]] and where changes in structures can only be communicated through the (% style="color:#e74c3c" %)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:#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:#e74c3c" %)version(%%) number MAJOR.MINOR.PATCH (without EXTENSION), when making changes to that semantically versioned [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] [[artefact>>doc: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:#e74c3c" %)version(%%) when backwards incompatible [[artefact>>doc:Glossary.Artefact.WebHome]] changes are made,
--1. MINOR (% style="color:#e74c3c" %)version(%%) when [[artefact>>doc:Glossary.Artefact.WebHome]] elements are added in a backwards compatible manner, or
--1. PATCH (% style="color:#e74c3c" %)version(%%) when backwards compatible [[artefact>>doc: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:#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:#e74c3c" %)version(%%) number MAJOR.MINOR.PATCH-EXTENSION, when making changes to that versioned [[artefact>>doc: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.
++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:Glossary.Statistical data and metadata exchange.WebHome]] [[artefacts>>doc: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:Glossary.Statistical data and metadata exchange.WebHome]] [[artefact>>doc:Glossary.Artefact.WebHome]] (% style="color:#e74c3c" %)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:#e74c3c" %)versions(%%) of [[identifiable artefacts>>doc:Glossary.Identifiable artefact.WebHome]] are assumed stable, i.e., they do not have an EXTENSION. This is because once in production, an [[artefact>>doc:Glossary.Artefact.WebHome]] cannot change in any way, or it must change the (% style="color:#e74c3c" %)version(%%). For cases where an [[artefact>>doc: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:Glossary.Artefact.WebHome]] should not be used outside of a specific system designed to accommodate them. For most purposes, all [[artefacts>>doc: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:#e74c3c" %)version(%%) numbers (MAJOR.MINOR) as in the past, such as '2.3', but without the ‘isFinal’ property. The new [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 standard does not add any strict rules or guarantees about changes in those [[artefacts>>doc: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:Glossary.Artefact.WebHome]] immutable or changes truly predictable, a move to the new semantic versioning syntax is required.
++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.
  === 4.3.4 Dependency management and references ===
--New flexible dependency specifications with wildcarding allow for easier data model maintenance and enhancements for semantically versioned [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] [[artefacts>>doc:Glossary.Artefact.WebHome]]. This allows implementing a smart referencing mechanism, whereby an [[artefact>>doc:Glossary.Artefact.WebHome]] may reference:
++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:#e74c3c" %)version(%%) of another [[artefact>>doc:Glossary.Artefact.WebHome]]
--* the **latest available** (% style="color:#e74c3c" %)version(%%) of another [[artefact>>doc:Glossary.Artefact.WebHome]]
--* the **latest backward compatible** (% style="color:#e74c3c" %)version(%%) of another [[artefact>>doc:Glossary.Artefact.WebHome]], or the **latest backward and forward** **compatible** (% style="color:#e74c3c" %)version(%%) of another [[artefact>>doc: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:Glossary.Artefact.WebHome]] dependency, such as the target [[artefacts>>doc:Glossary.Artefact.WebHome]] defined in a MetadataProvisionAgreement allow for linking to **all currently available** (% style="color:#e74c3c" %)versions(%%) of another [[artefact>>doc: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:Glossary.Dataflow.WebHome]] or [[Metadataflows>>doc: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.
++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:Glossary.Artefact.WebHome]] must only reference other semantically versioned [[artefacts>>doc:Glossary.Artefact.WebHome]], which may include extended (% style="color:#e74c3c" %)versions(%%). Non-versioned and legacy-versioned [[artefacts>>doc:Glossary.Artefact.WebHome]] can reference any other non-versioned or versioned (whether semantic or legacy) [[artefacts>>doc: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: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:Glossary.Artefact.WebHome]] at runtime.
++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: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:Glossary.Concept scheme.WebHome]], etc.) In an [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Structure Message, whenever an [[isExternalReference>>doc:Glossary.isExternalReference.WebHome]] [[attribute>>doc:Glossary.Attribute.WebHome]] is set to true, then the application must resolve the address provided in the associated "uri" [[attribute>>doc:Glossary.Attribute.WebHome]] and use the [[SDMX>>doc: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: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:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 Rest API supports retrievals legacy-versioned, wildcarded and extended [[artefact>>doc:Glossary.Artefact.WebHome]] (% style="color:#e74c3c" %)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:Glossary.Artefact.WebHome]] queries for a **specific** (% style="color:#e74c3c" %)version(%%) (X.Y, X.Y.Z or X.Y.Z-EXT).
--* [[Artefact>>doc: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:Glossary.Artefact.WebHome]].
--* [[Artefact>>doc: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.
++* [[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:#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:#e74c3c" %)version(%%) extension is not permitted.
--Full details can be found in the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web services specification.
++Full details can be found in the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web services specification.
  == 4.4 Structural Metadata Querying Best Practices ==
--When querying for [[structural metadata>>doc:Glossary.Structural metadata.WebHome]], the ability to state how references should be resolved is quite powerful. However, this mechanism is not always necessary and can create an undue burden on the systems processing the queries if it is not used properly.
++When querying for [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]], the ability to state how references should be resolved is quite powerful. However, this mechanism is not always necessary and can create an undue burden on the systems processing the queries if it is not used properly.
--Any [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] object which contains a reference to an object can be queried based on that reference. For example, a categorisation references both a [[category>>doc:Glossary.Category.WebHome]] and the object is it categorising. As this is the case, one can query for categorisations which categorise a particular object or which categorise against a particular [[category>>doc:Glossary.Category.WebHome]] or [[category scheme>>doc:Glossary.Category scheme.WebHome]]. This mechanism should be used when the referenced object is known.
++Any [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] object which contains a reference to an object can be queried based on that reference. For example, a categorisation references both a [[category>>doc:xwiki:Glossary.Category.WebHome]] and the object is it categorising. As this is the case, one can query for categorisations which categorise a particular object or which categorise against a particular [[category>>doc:xwiki:Glossary.Category.WebHome]] or [[category scheme>>doc:xwiki:Glossary.Category scheme.WebHome]]. This mechanism should be used when the referenced object is known.
--When the referenced object is not known, then the reference resolution mechanism could be used. For example, suppose one wanted to find all [[category schemes>>doc:Glossary.Category scheme.WebHome]] and the related categorisations for a given [[maintenance agency>>doc:Glossary.Maintenance agency.WebHome]]. In this case, one could query for the [[category scheme>>doc:Glossary.Category scheme.WebHome]] by the [[maintenance agency>>doc:Glossary.Maintenance agency.WebHome]] and specify that parent and sibling references should be resolved. This would result in the categorisations which reference the [[categories>>doc:Glossary.Category.WebHome]] in the matched schemes to be returned, as well as the object which they categorise.
++When the referenced object is not known, then the reference resolution mechanism could be used. For example, suppose one wanted to find all [[category schemes>>doc:xwiki:Glossary.Category scheme.WebHome]] and the related categorisations for a given [[maintenance agency>>doc:xwiki:Glossary.Maintenance agency.WebHome]]. In this case, one could query for the [[category scheme>>doc:xwiki:Glossary.Category scheme.WebHome]] by the [[maintenance agency>>doc:xwiki:Glossary.Maintenance agency.WebHome]] and specify that parent and sibling references should be resolved. This would result in the categorisations which reference the [[categories>>doc:xwiki:Glossary.Category.WebHome]] in the matched schemes to be returned, as well as the object which they categorise.
  {{putFootnotes/}}