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

From version 6.1
edited by Helena
on 2025/05/17 00:05
Change comment: There is no comment for this version
To version 5.2
edited by Helena
on 2025/05/16 23:55
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -98,7 +98,7 @@
98 98  > "pattern": "^[A-Za-z0-9_@$-]+$"
99 99  > }
100 100  
101 -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.
101 +There are also cases, though, that data types cannot be mapped like above. One such case is the array data type, which was introduced in SDMX 3.0 as a new representation. 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 specific definition (i.e., specific element/attribute names for SDMX). Beyond that, the minimum and/or maximum number of items within an array is possible in both cases.
102 102  
103 103  Further to the above, the mapping between the non-native data types is presented in the table below:
104 104  
... ... @@ -132,11 +132,11 @@
132 132  
133 133  === {{id name="_Toc291507"/}}4.2.1 Introduction ===
134 134  
135 -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.
135 +First, it is important to recognize that most observation times are a period. SDMX specifies precisely how Time is handled.
136 136  
137 -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]].
137 +The representation of time is broken into a hierarchical collection of representations. A data structure definition can use of any of the representations in the hierarchy as the representation of time. This allows for the time dimension of a particular data structure definition allow for only a subset of the default representation.
138 138  
139 -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):
139 +The hierarchy of time formats is as follows (**bold** indicates a category which is made up of multiple formats, //italic// indicates a distinct format):
140 140  
141 141  * **Observational Time Period**
142 142  ** **Standard Time Period**
... ... @@ -146,43 +146,43 @@
146 146  *** **Reporting Time Period**
147 147  ** **//Time Range//**
148 148  
149 -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.
149 +The details of these time period categories and of the distinct formats which make them up are detailed in the sections to follow.
150 150  
151 151  === {{id name="_Toc291508"/}}4.2.2 Observational Time Period ===
152 152  
153 -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.
153 +This is the superset of all time representations in SDMX. This allows for time to be expressed as any of the allowable formats.
154 154  
155 155  === {{id name="_Toc291509"/}}4.2.3 Standard Time Period ===
156 156  
157 -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).
157 +This is the superset of any predefined time period or a distinct point in time. A time period 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).
158 158  
159 159  === {{id name="_Toc291510"/}}4.2.4 Gregorian Time Period ===
160 160  
161 -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:
161 +A Gregorian time period is always represented by a Gregorian year, year-month, or day. These are all based on ISO 8601 dates. The representation in SDMX-ML messages and the period covered by each of the Gregorian time periods are as follows:
162 162  
163 163  **Gregorian Year:**
164 164  
165 -[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: xs:gYear (YYYY)
165 +Representation: xs:gYear (YYYY)
166 166  
167 167  Period: the start of January 1 to the end of December 31
168 168  
169 169  **Gregorian Year Month**:
170 170  
171 -[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: xs:gYearMonth (YYYY-MM)
171 +Representation: xs:gYearMonth (YYYY-MM)
172 172  
173 173  Period: the start of the first day of the month to end of the last day of the month
174 174  
175 175  **Gregorian Day**:
176 176  
177 -[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: xs:date (YYYY-MM-DD)
177 +Representation: xs:date (YYYY-MM-DD)
178 178  
179 179  Period: the start of the day (00:00:00) to the end of the day (23:59:59)
180 180  
181 181  === {{id name="_Toc291511"/}}4.2.5 Date Time ===
182 182  
183 -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.
183 +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 for data which is measured at a distinct point in time rather than being reported over a period, the date-time representation can be used.
184 184  
185 -[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: xs:dateTime (YYYY-MM-DDThh:mm:ss){{footnote}}The seconds can be reported fractionally{{/footnote}}
185 +Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss){{footnote}}The seconds can be reported fractionally{{/footnote}}
186 186  
187 187  === {{id name="_Toc291512"/}}4.2.6 Standard Reporting Period ===
188 188  
... ... @@ -196,7 +196,7 @@
196 196  
197 197  PERIOD_VALUE indicates the actual period within the year
198 198  
199 -The following section details each of the standard reporting periods defined in [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]]:
199 +The following section details each of the standard reporting periods defined in SDMX:
200 200  
201 201  **Reporting Year**:
202 202  
... ... @@ -206,7 +206,7 @@
206 206  
207 207  Limit per year: 1
208 208  
209 -[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: common:ReportingYearType (YYYY-A1, e.g. 2000-A1)
209 +Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1)
210 210  
211 211  **Reporting Semester:**
212 212  
... ... @@ -216,7 +216,7 @@
216 216  
217 217  Limit per year: 2
218 218  
219 -[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: common:ReportingSemesterType (YYYY-Ss, e.g. 2000-S2)
219 +Representation: common:ReportingSemesterType (YYYY-Ss, e.g. 2000-S2)
220 220  
221 221  **Reporting Trimester:**
222 222  
... ... @@ -226,7 +226,7 @@
226 226  
227 227  Limit per year: 3
228 228  
229 -[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3)
229 +Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3)
230 230  
231 231  **Reporting Quarter:**
232 232  
... ... @@ -236,7 +236,7 @@
236 236  
237 237  Limit per year: 4
238 238  
239 -[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4)
239 +Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4)
240 240  
241 241  **Reporting Month**:
242 242  
... ... @@ -246,7 +246,7 @@
246 246  
247 247  Limit per year: 1
248 248  
249 -[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: common:ReportingMonthType (YYYY-Mmm, e.g. 2000-M12)
249 +Representation: common:ReportingMonthType (YYYY-Mmm, e.g. 2000-M12)
250 250  
251 251  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.
252 252  
... ... @@ -258,9 +258,9 @@
258 258  
259 259  Limit per year: 53
260 260  
261 -[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53)
261 +Representation: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53)
262 262  
263 -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.
263 +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.^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]](%%)^^ 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.
264 264  
265 265  **Reporting Day**:
266 266  
... ... @@ -270,15 +270,15 @@
270 270  
271 271  Limit per year: 366
272 272  
273 -[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: common:ReportingDayType (YYYY-Dddd, e.g. 2000-D366)
273 +Representation: common:ReportingDayType (YYYY-Dddd, e.g. 2000-D366)
274 274  
275 275  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.
276 276  
277 277  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.
278 278  
279 -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
279 +A specialized attribute (reporting year start day) exists for the purpose of communicating the reporting year start day. This attribute has a fixed identifier
280 280  
281 -(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.
281 +(REPORTING_YEAR_START_DAY) and a fixed representation (xs:gMonthDay) so that it can always be easily identified and processed in a data message. Although this attribute exists in specialized sub-class, it functions the same as any other attribute outside of its identification and representation. It must takes its identity from a concept and state its relationship with other components of the data structure definition. The ability to state this relationship allows this reporting year start day attribute to exist at the appropriate levels of a data message. In the absence of this attribute, the reporting year start date is assumed to be January 1; therefore if the reporting year coincides with the calendar year, this Attribute is not necessary.
282 282  
283 283  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]):
284 284  
... ... @@ -308,11 +308,11 @@
308 308  g) If the [PERIOD_INDICATOR] is D, the [PERIOD_DURATION] is P1D.
309 309  **3. Determine [PERIOD_START]:**
310 310  
311 -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].
311 +Subtract one from the [PERIOD_VALUE] and multiply this by the [PERIOD_DURATION]. Add^^4^^ this to the [REPORTING_YEAR_BASE]. The result is the [PERIOD_START].
312 312  
313 313  **4. Determine the [PERIOD_END]:**
314 314  
315 -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].
315 +Multiply the [PERIOD_VALUE] by the [PERIOD_DURATION]. Add^^4^^ this to the [REPORTING_YEAR_BASE] add^^4^^ -P1D. The result is the [PERIOD_END].
316 316  
317 317  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).
318 318  
... ... @@ -355,16 +355,16 @@
355 355  
356 356  === {{id name="_Toc291514"/}}4.2.8 Time Format ===
357 357  
358 -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]].
358 +In version 2.0 of SDMX there is a recommendation to use the time format attribute 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 attribute in SDMX-ML.
359 359  
360 360  (% style="width:771.294px" %)
361 361  |**Code**|(% style="width:659px" %)**Format**
362 -|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)
363 -|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]]
364 -|GTP|(% style="width:659px" %)Superset of all Gregorian [[Time Periods>>doc:xwiki:Glossary.Time period.WebHome]] and date-time
365 -|RTP|(% style="width:659px" %)Superset of all Reporting [[Time Periods>>doc:xwiki:Glossary.Time period.WebHome]]
362 +|OTP|(% style="width:659px" %)Observational Time Period: Superset of all SDMX time formats (Gregorian Time Period, Reporting Time Period, and Time Range)
363 +|STP|(% style="width:659px" %)Standard Time Period: Superset of Gregorian and Reporting Time Periods
364 +|GTP|(% style="width:659px" %)Superset of all Gregorian Time Periods and date-time
365 +|RTP|(% style="width:659px" %)Superset of all Reporting Time Periods
366 366  |TR|(% style="width:659px" %)(((
367 -Time Range: Start time and duration (YYYY-MM-DD(Thh:mm:ss)?/)
367 +Time Range: Start time and duration (YYYY-MM-DD(Thh:mm:ss)?/<duration>)
368 368  )))
369 369  |GY|(% style="width:659px" %)Gregorian Year (YYYY)
370 370  |GTM|(% style="width:659px" %)Gregorian Year Month (YYYY-MM)
... ... @@ -383,7 +383,7 @@
383 383  
384 384  === {{id name="_Toc291515"/}}4.2.9 Time Zones ===
385 385  
386 -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):
386 +In alignment with ISO 8601, SDMX allows the specification of a time zone on all time periods 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. 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):
387 387  
388 388  * Time Range (start date): 2006-06-05**-05:00**/P5D
389 389  * Time Range (start date-time): 2006-06-05T00:00:00**-05:00**/P5D
... ... @@ -398,13 +398,13 @@
398 398  * Reporting Month: 2006-M06**-05:00**
399 399  * Reporting Week: 2006-W23**-05:00**
400 400  * Reporting Day: 2006-D156**-05:00**
401 -* Reporting Year Start Day: 07-01**-05:00**
401 +* Reporting Year Start Day: ~-~-07-01**-05:00**
402 402  
403 -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.
403 +According to ISO 8601, a date without a time-zone is considered "local time". SDMX assumes that local time is that of the sender of the message. In this version of SDMX, 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.
404 404  
405 405  === {{id name="_Toc291516"/}}4.2.10 Representing Time Spans Elsewhere ===
406 406  
407 -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:
407 +It has been possible since SDMX 2.0 for a Component to specify a representation of a time span. Depending on the format of the data message, this resulted in either an element with 2 XML attributes for holding the start time and the duration or two separate XML attributes based on the underlying Component identifier. For example, if REF_PERIOD were given a representation of time span, then in the Compact data format, it would be represented by two XML attributes; REF_PERIODStartTime (holding the start) and REF_PERIOD (holding the duration). If a new simple type is introduced in the SDMX schemas that can hold ISO 8601 time intervals, then this will no longer be necessary. What was represented as this:
408 408  
409 409  > <Series REF_PERIODStartTime="2000-01-01T00:00:00" REF_PERIOD="P2M"/>
410 410  
... ... @@ -414,17 +414,17 @@
414 414  
415 415  === {{id name="_Toc291517"/}}4.2.11 Notes on Formats ===
416 416  
417 -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.
417 +There is no ambiguity in these formats so that for any given value of time, the category of the period (and thus the intended time period 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.
418 418  
419 419  === {{id name="_Toc291518"/}}4.2.12 Effect on Time Ranges ===
420 420  
421 -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.
421 +All SDMX-ML data messages are capable of functioning in a manner similar to SDMXEDI if the Dimension at the observation level is time: the time period 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.
422 422  
423 423  === 4.2.13 Time in Query Messages ===
424 424  
425 -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.
425 +When querying for time values, the value of a time parameter can be provided as any of the Observational Time Period formats and must be paired with an operator. This section will detail how systems processing query messages should interpret these parameters.
426 426  
427 -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.
427 +Fundamental to processing a time value parameter in a query message is understanding that all time periods 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 for requested parameter is encompassed by the time period resulting from value of the query parameter. The following table details how the operators should be interpreted for any time period provided as a parameter.
428 428  
429 429  (% style="width:1020.29px" %)
430 430  |(% style="width:236px" %)**Operator**|(% style="width:781px" %)**Rule**
... ... @@ -434,7 +434,7 @@
434 434  |(% style="width:236px" %)Less Than or Equal To|(% style="width:781px" %)Any data on or before the last moment of the period
435 435  |(% 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
436 436  
437 -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.
437 +Reporting Time Periods 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 to compare weeks and days to higher order report periods. This will be demonstrated in the examples to follow.
438 438  
439 439  **Examples:**
440 440  
... ... @@ -448,12 +448,12 @@
448 448  * 2011-01-01 or later
449 449  * 2011-01-01/P[Any Duration] or any later start date
450 450  * 2011-[Any reporting period] (any reporting year start day)
451 -* 2010-S2 (reporting year start day 07-01 or later)
452 -* 2010-T3 (reporting year start day 07-01 or later)
453 -* 2010-Q3 or later (reporting year start day 07-01 or later)
454 -* 2010-M07 or later (reporting year start day 07-01 or later)
455 -* 2010-W28 or later (reporting year start day 07-01 or later)
456 -* 2010-D185 or later (reporting year start day 07-01 or later)
451 +* 2010-S2 (reporting year start day ~-~-07-01 or later)
452 +* 2010-T3 (reporting year start day ~-~-07-01 or later)
453 +* 2010-Q3 or later (reporting year start day ~-~-07-01 or later)
454 +* 2010-M07 or later (reporting year start day ~-~-07-01 or later)
455 +* 2010-W28 or later (reporting year start day ~-~-07-01 or later)
456 +* 2010-D185 or later (reporting year start day ~-~-07-01 or later)
457 457  
458 458  **Reporting Period**
459 459  Query Parameter: Greater than or equal to 2010-Q3
... ... @@ -469,91 +469,91 @@
469 469  * 2010-T3 (any reporting year start day)
470 470  * 2010-Q3 or later (any reporting year start day)
471 471  * 2010-M07 or later (any reporting year start day)
472 -* 2010-W27 or later (reporting year start day 01-01)^^5^^ • 2010-D182 or later (reporting year start day 01-01)
473 -* 2010-W28 or later (reporting year start day 07-01)^^6^^
474 -* 2010-D185 or later (reporting year start day 07-01)
472 +* 2010-W27 or later (reporting year start day ~-~-01-01)^^5^^ • 2010-D182 or later (reporting year start day ~-~-01-01)
473 +* 2010-W28 or later (reporting year start day ~-~-07-01)^^6^^
474 +* 2010-D185 or later (reporting year start day ~-~-07-01)
475 475  
476 476  == 4.3 Versioning ==
477 477  
478 -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".
478 +Versioning operates at the level of versionable and maintainable objects in the SDMX information model. Within the SDMX Structure and MetadataSet messages, there is a well-defined pattern for artefact versioning and referencing. The artefact identifiers are qualified by their version numbers – that is, an object with an Agency of "A", and ID of "X" and a version of "1.0.0" is a different object than one with an Agency of "A", an ID of "X", and a version of "1.1.0".
479 479  
480 -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’.
480 +As of SDMX 3.0, the versioning rules are extended to allow for truly versioned artefacts 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 defined without a version is equivalent to following the legacy versioning, thus having version ‘1.0’.
481 481  
482 482  === 4.3.1 Non-versioned artefacts ===
483 483  
484 -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’.
484 +Indeed, some use cases do not need or are incompatible with versioning for some or all their structural artefacts, such as the Agency, Data Providers, Metadata Providers and Data Consumer Schemes. These artefacts follow the legacy versioning, with a fixed version set to ‘1.0’.
485 485  
486 -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.
486 +Many existing organisation’s data management systems work with version-less structures and apply ad-hoc structural metadata governance processes. The new nonversioned artefacts will allow supporting those numerous situations, where organisations do not manage version numbers.
487 487  
488 -2010-Q3 (with a reporting year start day of 01-01) starts on 2010-07-01. This is day 4 of week 26, therefore the first week matched is week 27.
488 +2010-Q3 (with a reporting year start day of ~-~-01-01) starts on 2010-07-01. This is day 4 of week 26, therefore the first week matched is week 27.
489 489  
490 -2010-Q3 (with a reporting year start day of 07-01) starts on 2011-01-01. This is day 6 of week 27, therefore the first week matched is week 28.
490 +2010-Q3 (with a reporting year start day of ~-~-07-01) starts on 2011-01-01. This is day 6 of week 27, therefore the first week matched is week 28.
491 491  
492 492  === 4.3.2 Semantically versioned artefacts ===
493 493  
494 -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.
494 +Since the purpose of SDMX versioning is to allow communicating the structural artefact changes to data exchange partners and connected systems, SDMX 3.0 offers Semantic Versioning (aka SemVer) with a clear and unambiguous syntax to all semantically versioned SDMX 3.0 structural artefacts. Semantic versioning will thus better respond to situations where the SDMX standard itself is the only structural contract between data providers and data consumers and where changes in structures can only be communicated through the version number increases.
495 495  
496 -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.
496 +The semantic 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 versions are ordered.
497 497  
498 498  The detailed rules for semantic versioning are listed in chapter 14 in the annex for “Semantic Versioning”. In short, they define:
499 499  
500 -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:
500 +Given a version number MAJOR.MINOR.PATCH (without EXTENSION), when making changes to that semantically versioned SDMX artefact, then one must increment the:
501 501  
502 -1. MAJOR (% style="color:#2ecc71" %)version(%%) when backwards incompatible [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] changes are made,
503 -1. MINOR (% style="color:#2ecc71" %)version(%%) when [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] elements are added in a backwards compatible manner, or
504 -1. PATCH (% style="color:#2ecc71" %)version(%%) when backwards compatible [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] property changes are made.
502 +1. MAJOR version when backwards incompatible artefact changes are made,
503 +1. MINOR version when artefact elements are added in a backwards compatible manner, or
504 +1. PATCH version when backwards compatible artefact property changes are made.
505 505  
506 -When incrementing a (% style="color:#2ecc71" %)version(%%) part, the right-hand side parts are 0-ed (reset to ‘0’).
506 +When incrementing a version part, the right-hand side parts are 0-ed (reset to ‘0’).
507 507  
508 508  Extensions can be added, changed or dropped.
509 509  
510 -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.
510 +iven an extended version number MAJOR.MINOR.PATCH-EXTENSION, when making changes to that versioned artefact, then one is not required to increment the version if those changes are within the allowed scope of the version increment from the previous version (if that existed); otherwise, the above version increment rules apply. EXTENSIONs can be used e.g., for drafting or a pre-release.
511 511  
512 -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(%%).
512 +Semantically versioned SDMX artefacts will thus be safe to use. Specific 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 version must be created first. Furthermore, the impact of the further change is communicated using a clear version increment. The built-in version extension facility allows for eased drafting of new SDMX artefact versions.
513 513  
514 -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.
514 +The production versions of identifiable artefacts are assumed stable, i.e., they do not have an EXTENSION. This is because once in production, an artefact cannot change in any way, or it must change the version. For cases where an artefact is not static, like during the drafting, the version must indicate this by including an EXTENSION. Draft artefacts should not be used outside of a specific system designed to accommodate them. For most purposes, all artefacts should become stable before being used in production.
515 515  
516 516  === 4.3.3 Legacy-versioned artefacts ===
517 517  
518 -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.
518 +Organisations wishing to keep a maximum of backwards compatibility with existing implementations can continue using the previous 2-digit convention for version numbers (MAJOR.MINOR) as in the past, such as '2.3', but without the ‘isFinal’ property. The new SDMX 3.0 standard does not add any strict rules or guarantees about changes in those artefacts, since the legacy versioning rules were rather loose and non-binding, including the meaning of the ‘isFinal’ property, and their implementations were varying.
519 519  
520 -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.
520 +In order to make artefacts immutable or changes truly predictable, a move to the new semantic versioning syntax is required.
521 521  
522 522  === 4.3.4 Dependency management and references ===
523 523  
524 -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:
524 +New flexible dependency specifications with wildcarding allow for easier data model maintenance and enhancements for semantically versioned SDMX artefacts. This allows implementing a smart referencing mechanism, whereby an artefact may reference:
525 525  
526 -* a fixed (% style="color:#2ecc71" %)version(%%) of another [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]]
527 -* the **latest available** (% style="color:#2ecc71" %)version(%%) of another [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]]
528 -* 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]].
526 +* a fixed version of another artefact
527 +* the **latest available** version of another artefact
528 +* the **latest backward compatible** version of another artefact, or the **latest backward and forward** **compatible** version of another artefact.
529 529  
530 -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.
530 +References not representing a strict artefact dependency, such as the target artefacts defined in a MetadataProvisionAgreement allow for linking to **all currently available** versions of another artefact. Another illustrative case for such loose referencing is that of Constraints and flows. A Constraint may reference many Dataflows or Metadataflows, the addition of more references to flow objects does not version the Constraint. This is because the Constraints are not properties of the flows – they merely make references to them.
531 531  
532 -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.
532 +Semantically versioned artefacts must only reference other semantically versioned artefacts, which may include extended versions. Non-versioned and legacy-versioned artefacts can reference any other non-versioned or versioned (whether semantic or legacy) artefacts. The scope of wildcards in references adapts correspondingly.
533 533  
534 -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.
534 +The mechanism named "early binding" refers to a dependency on a stable versioned artefact – 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 at runtime.
535 535  
536 -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.
536 +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, it is useful to have a scheme for external referencing. This is done at the level of maintainable objects (DSDs, Codelists, Concept Schemes, etc.) In an SDMX Structure Message, whenever an "isExternalReference" attribute is set to true, then the application must resolve the address provided in the associated "uri" attribute and use the SDMX Structure Message stored at that location for the full definition of the object in question. Alternately, if a registry "urn" attribute has been provided, the registry can be used to supply the full details of the object.
537 537  
538 538  The detailed rules for dependency management and references are listed in chapter 14 in the annex for “Semantic Versioning”.
539 539  
540 -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(%%):
540 +In order to allow resolving the described new forms of dependencies, the SDMX 3.0 Rest API supports retrievals legacy-versioned, wildcarded and extended artefact versions:
541 541  
542 -* [[Artefact>>doc:xwiki:Glossary.Artefact.WebHome]] queries for a **specific** (% style="color:#2ecc71" %)version(%%) (X.Y, X.Y.Z or X.Y.Z-EXT).
543 -* [[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+).
544 -* Queries for **non-versioned** [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]].
545 -* [[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.
542 +* Artefact queries for a **specific** version (X.Y, X.Y.Z or X.Y.Z-EXT).
543 +* Artefact queries for **latest available** semantic versions within the wildcard scope (X+.Y.Z, X.Y+.Z or X.Y.Z+).
544 +* Queries for **non-versioned** artefacts.
545 +* Artefact queries for **all available** semantic versions within the wildcard scope (*, X.* or X.Y.*), where only the first form is required for resolving wildcarded loose references.
546 546  
547 -The combination of wildcarded queries with a specific (% style="color:#2ecc71" %)version(%%) extension is not permitted.
547 +The combination of wildcarded queries with a specific version extension is not permitted.
548 548  
549 -Full details can be found in the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web services specification.
549 +Full details can be found in the SDMX RESTful web services specification.
550 550  
551 551  == 4.4 Structural Metadata Querying Best Practices ==
552 552  
553 -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.
553 +When querying for structural metadata, the ability to state how references should be resolved is quite powerful. However, this mechanism is not always necessary and can create an undue burden on the systems processing the queries if it is not used properly.
554 554  
555 -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.
555 +Any structural metadata object which contains a reference to an object can be queried based on that reference. For example, a categorisation references both a category 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 or category scheme. This mechanism should be used when the referenced object is known.
556 556  
557 -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.
557 +When the referenced object is not known, then the reference resolution mechanism could be used. For example, suppose one wanted to find all category schemes and the related categorisations for a given maintenance agency. In this case, one could query for the category scheme by the maintenance agency and specify that parent and sibling references should be resolved. This would result in the categorisations which reference the categories in the matched schemes to be returned, as well as the object which they categorise.
558 558  
559 559  {{putFootnotes/}}