Skip to Content
Last modified by Helena on 2025/09/10 11:19
From version 4.2
edited by Helena
on 2025/05/16 11:11
Change comment: There is no comment for this version
To version 13.2
edited by Artur
on 2025/06/06 12:55
Change comment: Update document after refactoring.

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +Methodology.SDMX 3\.0 Standards\. Section 6\. Technical Notes.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.helena
1 +xwiki:XWiki.arturkryazhev
Tags
... ... @@ -1,0 +1,1 @@
1 +Artefact|Attribute|Category|Category scheme|Code|Code list|Component|Concept scheme|Data consumer|Data consumer scheme|Data provider|Data set|Data structure definition|Dataflow|Decimals|Dimension|Facet|Hierarchy|Identifiable artefact|Maintenance agency|Metadataflow|Reference metadata|Reporting taxonomy|Representation|SDMX Information Model|SDMX-JSON|SDMX-ML|Statistical data and metadata exchange|Structural metadata|Structure set|Time format|Time period|isExternalReference
Content
... ... @@ -2,13 +2,13 @@
2 2  {{toc/}}
3 3  {{/box}}
4 4  
5 -This section discusses a number of topics other than the exchange of data sets in SDMX formats. Supported only in SDMX-ML (and some in SDMX-JSON), these topics include the use of the reference metadata mechanism in SDMX, the use of Structure Sets and Reporting Taxonomies, the use of Processes, a discussion of time and datatyping, and the conventional mechanisms within the SDMX-ML Structure message regarding versioning and referencing.
5 +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.
6 6  
7 7  == {{id name="_Toc291504"/}}4.1 Representations ==
8 8  
9 9  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.
10 10  
11 -There are several different representations in SDMX-ML, taken from XML Schemas and common programming languages. The table below describes the various representations, which are found in SDMX-ML, and their equivalents.
11 +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.
12 12  
13 13  (% style="width:1185.29px" %)
14 14  |(% 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 @@
30 30  |(% style="width:250px" %)Day, MonthDay, Month|(% style="width:285px" %)xsd:g*|(% style="width:271px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
31 31  |(% style="width:250px" %)Duration|(% style="width:285px" %)xsd:duration|(% style="width:271px" %)System.TimeSpan|(% style="width:354px" %)javax.xml.datatype.Dura tion
32 32  
33 -There are also a number of SDMX-ML data types which do not have these direct correspondences, often because they are composite representations or restrictions of a broader data type. For most of these, there are simple types which can be referenced from the SDMX schemas, for others a derived simple type will be necessary:
33 +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:
34 34  
35 35  * AlphaNumeric (common:AlphaNumericType, string which only allows A-z and 0-9)
36 36  * Alpha (common:AlphaType, string which only allows A-z)
... ... @@ -37,7 +37,7 @@
37 37  * Numeric (common:NumericType, string which only allows 0-9, but is not numeric so that is can having leading zeros)
38 38  * Count (xs:integer, a sequence with an interval of "1")
39 39  * InclusiveValueRange (xs:decimal with the minValue and maxValue facets supplying the bounds)
40 -* ExclusiveValueRange (xs:decimal with the minValue and maxValue facets supplying the bounds)
40 +* ExclusiveValueRange (xs:decimal with the minValue and maxValue [[facets>>doc:Glossary.Facet.WebHome]] supplying the bounds)
41 41  * Incremental (xs:decimal with a specified interval; the interval is typically enforced outside of the XML validation)
42 42  * TimeRange (common:TimeRangeType, startDateTime + Duration)
43 43  * ObservationalTimePeriod (common:ObservationalTimePeriodType, a union of StandardTimePeriod and TimeRange).
... ... @@ -57,29 +57,29 @@
57 57  * IdentifiableReference (types for each IdentifiableObject)
58 58  * GeospatialInformation (a geo feature set, according to the pattern in section 7.2)
59 59  
60 -Data types also have a set of facets:
60 +Data types also have a set of [[facets>>doc:Glossary.Facet.WebHome]]:
61 61  
62 62  * isSequence = true | false (indicates a sequentially increasing value)
63 63  * minLength = positive integer (# of characters/digits)
64 64  * maxLength = positive integer (# of characters/digits)
65 -* startValue = decimal (for numeric sequence)
66 -* endValue = decimal (for numeric sequence)
67 -* interval = decimal (for numeric sequence)
65 +* startValue = [[decimal>>doc:Glossary.Decimals.WebHome]] (for numeric sequence)
66 +* endValue = [[decimal>>doc:Glossary.Decimals.WebHome]] (for numeric sequence)
67 +* interval = [[decimal>>doc:Glossary.Decimals.WebHome]] (for numeric sequence)
68 68  * timeInterval = duration
69 69  * startTime = BasicTimePeriod (for time range) endTime = BasicTimePeriod (for time range)
70 -* minValue = decimal (for numeric range)
71 -* maxValue = decimal (for numeric range)
72 -* decimal = Integer (# of digits to right of decimal point)
70 +* minValue = [[decimal>>doc:Glossary.Decimals.WebHome]] (for numeric range)
71 +* maxValue = [[decimal>>doc:Glossary.Decimals.WebHome]] (for numeric range)
72 +* [[decimal>>doc:Glossary.Decimals.WebHome]] = Integer (# of digits to right of [[decimal>>doc:Glossary.Decimals.WebHome]] point)
73 73  * pattern = (a regular expression, as per W3C XML Schema)
74 74  * isMultiLingual = boolean (for specifying text can occur in more than one language)
75 75  
76 -Note that code lists may also have textual representations assigned to them, in addition to their enumeration of codes.
76 +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]].
77 77  
78 78  === {{id name="_Toc291505"/}}4.1.1 Data Types ===
79 79  
80 -XML and JSON schemas support a variety of data types that, although rich, are not mapped one-to-one in all cases. This section provides an explanation of the mapping performed in SDMX 3.0, between such cases.
80 +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.
81 81  
82 -For identifiers, text fields and Codes 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.
82 +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.
83 83  
84 84  For example, for the id type, this is the XML schema definition:
85 85  
... ... @@ -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 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.
101 +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.
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 specifies precisely how Time is handled.
135 +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.
136 136  
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.
137 +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]].
138 138  
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):
139 +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):
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 categories and of the distinct formats which make them up are detailed in the sections to follow.
149 +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.
150 150  
151 151  === {{id name="_Toc291508"/}}4.2.2 Observational Time Period ===
152 152  
153 -This is the superset of all time representations in SDMX. This allows for time to be expressed as any of the allowable formats.
153 +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.
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 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).
157 +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).
158 158  
159 159  === {{id name="_Toc291510"/}}4.2.4 Gregorian Time Period ===
160 160  
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:
161 +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:
162 162  
163 163  **Gregorian Year:**
164 164  
165 -Representation: xs:gYear (YYYY)
165 +[[Representation>>doc:Glossary.Representation.WebHome]]: 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: xs:gYearMonth (YYYY-MM)
171 +[[Representation>>doc:Glossary.Representation.WebHome]]: 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: xs:date (YYYY-MM-DD)
177 +[[Representation>>doc:Glossary.Representation.WebHome]]: 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 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.
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: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.
184 184  
185 -Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss){{footnote}}The seconds can be reported fractionally{{/footnote}}
185 +[[Representation>>doc:Glossary.Representation.WebHome]]: 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,183 +196,128 @@
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:
199 +The following section details each of the standard reporting periods defined in [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]:
200 200  
201 201  **Reporting Year**:
202 -
203 203  Period Indicator: A
204 -
205 205  Period Duration: P1Y (one year)
206 -
207 207  Limit per year: 1
205 +[[Representation>>doc:Glossary.Representation.WebHome]]: common:ReportingYearType (YYYY-A1, e.g. 2000-A1)
208 208  
209 -Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1)
210 -
211 211  **Reporting Semester:**
212 -
213 213  Period Indicator: S
214 -
215 215  Period Duration: P6M (six months)
216 -
217 217  Limit per year: 2
211 +[[Representation>>doc:Glossary.Representation.WebHome]]: common:ReportingSemesterType (YYYY-Ss, e.g. 2000-S2)
218 218  
219 -Representation: common:ReportingSemesterType (YYYY-Ss, e.g. 2000-S2)
220 -
221 221  **Reporting Trimester:**
222 -
223 223  Period Indicator: T
224 -
225 225  Period Duration: P4M (four months)
226 -
227 227  Limit per year: 3
217 +[[Representation>>doc:Glossary.Representation.WebHome]]: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3)
228 228  
229 -Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3)
230 -
231 231  **Reporting Quarter:**
232 -
233 233  Period Indicator: Q
234 -
235 235  Period Duration: P3M (three months)
236 -
237 237  Limit per year: 4
223 +[[Representation>>doc:Glossary.Representation.WebHome]]: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4)
238 238  
239 -Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4)
240 -
241 241  **Reporting Month**:
242 -
243 243  Period Indicator: M
244 -
245 245  Period Duration: P1M (one month)
246 -
247 247  Limit per year: 1
229 +[[Representation>>doc:Glossary.Representation.WebHome]]: common:ReportingMonthType (YYYY-Mmm, e.g. 2000-M12)
248 248  
249 -Representation: common:ReportingMonthType (YYYY-Mmm, e.g. 2000-M12)
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  
253 253  **Reporting Week**:
254 -
255 255  Period Indicator: W
256 -
257 257  Period Duration: P7D (seven days)
258 -
259 259  Limit per year: 53
237 +[[Representation>>doc:Glossary.Representation.WebHome]]: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53)
260 260  
261 -Representation: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53)
239 +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.
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.^^[[(% class="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 -
265 265  **Reporting Day**:
266 -
267 267  Period Indicator: D
268 -
269 269  Period Duration: P1D (one day)
270 -
271 271  Limit per year: 366
245 +[[Representation>>doc:Glossary.Representation.WebHome]]: common:ReportingDayType (YYYY-Dddd, e.g. 2000-D366)
272 272  
273 -Representation: common:ReportingDayType (YYYY-Dddd, e.g. 2000-D366)
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 (reporting year start day) exists for the purpose of communicating the reporting year start day. This attribute has a fixed identifier
251 +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
280 280  
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.
253 +(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.
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  
285 -1. **Determine [REPORTING_YEAR_BASE]:**
257 +**~1. Determine [REPORTING_YEAR_BASE]:**
286 286  
287 287  Combine [REPORTING_YEAR] of the reporting period value (YYYY) with [REPORTING_YEAR_START_DAY] (MM-DD) to get a date (YYYY-MM-DD).
288 -
289 289  This is the [REPORTING_YEAR_START_DATE]
290 290  
291 -1.
292 -11. **If the [PERIOD_INDICATOR] is W:**
293 -111. **If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday:**
262 +**a) If the [PERIOD_INDICATOR] is W:**
294 294  
295 -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].
264 + ~1. **If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday**:
265 + 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].
266 +**~ 2. If [REPORTING_YEAR_START_DATE] is a Monday, Tuesday, Wednesday, or Thursday:**
267 + Add^^4^^ (P0D, -P1D, -P2D, or -P3D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE].
296 296  
297 -1.
298 -11.
299 -111. **If [REPORTING_YEAR_START_DATE] is a Monday, Tuesday, Wednesday, or Thursday:**
300 -
301 -Add^^4^^ (P0D, -P1D, -P2D, or -P3D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE].
302 -
303 -1.
304 -11. **Else:**
305 -
269 +**b) Else:**
306 306  The [REPORTING_YEAR_START_DATE] is the [REPORTING_YEAR_BASE].
307 307  
308 -1. **Determine [PERIOD_DURATION]:**
309 -11. If the [PERIOD_INDICATOR] is A, the [PERIOD_DURATION] is P1Y.
310 -11. If the [PERIOD_INDICATOR] is S, the [PERIOD_DURATION] is P6M.
311 -11. If the [PERIOD_INDICATOR] is T, the [PERIOD_DURATION] is P4M.
312 -11. If the [PERIOD_INDICATOR] is Q, the [PERIOD_DURATION] is P3M.
313 -11. If the [PERIOD_INDICATOR] is M, the [PERIOD_DURATION] is P1M.
314 -11. If the [PERIOD_INDICATOR] is W, the [PERIOD_DURATION] is P7D.
315 -11. If the [PERIOD_INDICATOR] is D, the [PERIOD_DURATION] is P1D.
316 -1. **Determine [PERIOD_START]:**
272 +**2. Determine [PERIOD_DURATION]:**
273 +a) If the [PERIOD_INDICATOR] is A, the [PERIOD_DURATION] is P1Y.
274 +b) If the [PERIOD_INDICATOR] is S, the [PERIOD_DURATION] is P6M.
275 +c) If the [PERIOD_INDICATOR] is T, the [PERIOD_DURATION] is P4M.
276 +d) If the [PERIOD_INDICATOR] is Q, the [PERIOD_DURATION] is P3M.
277 +e) If the [PERIOD_INDICATOR] is M, the [PERIOD_DURATION] is P1M.
278 +f) If the [PERIOD_INDICATOR] is W, the [PERIOD_DURATION] is P7D.
279 +g) If the [PERIOD_INDICATOR] is D, the [PERIOD_DURATION] is P1D.
280 +
317 317  
318 -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].
282 +**3. Determine [PERIOD_START]:**
283 +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].
319 319  
320 320  **4. Determine the [PERIOD_END]:**
286 +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].
321 321  
322 -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].
323 -
324 324  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).
325 325  
326 326  **Examples:**
327 327  
328 328  **2010-Q2, REPORTING_YEAR_START_DAY = ~-~-07-01 (July 1)**
293 +~1. [REPORTING_YEAR_START_DATE] = 2010-07-01
294 + b) [REPORTING_YEAR_BASE] = 2010-07-01
295 +2. [PERIOD_DURATION] = P3M
296 +3. (2-1) * P3M = P3M
297 + 2010-07-01 + P3M = 2010-10-01
298 + [PERIOD_START] = 2010-10-01
329 329  
330 -1. [REPORTING_YEAR_START_DATE] = 2010-07-01
300 +4. 2 * P3M = P6M
301 + 2010-07-01 + P6M = 2010-13-01 = 2011-01-01
302 + 2011-01-01 + -P1D = 2010-12-31
303 + [PERIOD_END] = 2010-12-31
331 331  
332 -b) [REPORTING_YEAR_BASE] = 2010-07-01
333 -
334 -1. [PERIOD_DURATION] = P3M
335 -1. (2-1) * P3M = P3M
336 -
337 -2010-07-01 + P3M = 2010-10-01
338 -
339 -[PERIOD_START] = 2010-10-01
340 -
341 -1. 2 * P3M = P6M
342 -
343 -2010-07-01 + P6M = 2010-13-01 = 2011-01-01
344 -
345 -2011-01-01 + -P1D = 2010-12-31
346 -
347 -[PERIOD_END] = 2010-12-31
348 -
349 349  The actual calendar range covered by 2010-Q2 (assuming the reporting year begins July 1) is 2010-10-01T00:00:00/2010-12-31T23:59:59
350 350  
351 351  **2011-W36, REPORTING_YEAR_START_DAY = ~-~-07-01 (July 1)**
308 +~1. [REPORTING_YEAR_START_DATE] = 2010-07-01
309 + a) 2011-07-01 = Friday
310 + 2011-07-01 + P3D = 2011-07-04
311 + [REPORTING_YEAR_BASE] = 2011-07-04
312 +2. [PERIOD_DURATION] = P7D
313 +3. (36-1) * P7D = P245D
314 + 2011-07-04 + P245D = 2012-03-05
315 + [PERIOD_START] = 2012-03-05
316 +4. 36 * P7D = P252D
317 + 2011-07-04 + P252D =2012-03-12
318 + 2012-03-12 + -P1D = 2012-03-11
319 + [PERIOD_END] = 2012-03-11
352 352  
353 -1. [REPORTING_YEAR_START_DATE] = 2010-07-01
354 -
355 -a) 2011-07-01 = Friday
356 -
357 -2011-07-01 + P3D = 2011-07-04
358 -
359 -[REPORTING_YEAR_BASE] = 2011-07-04
360 -
361 -1. [PERIOD_DURATION] = P7D
362 -1. (36-1) * P7D = P245D
363 -
364 -2011-07-04 + P245D = 2012-03-05
365 -
366 -[PERIOD_START] = 2012-03-05
367 -
368 -1. 36 * P7D = P252D
369 -
370 -2011-07-04 + P252D =2012-03-12
371 -
372 -2012-03-12 + -P1D = 2012-03-11
373 -
374 -[PERIOD_END] = 2012-03-11
375 -
376 376  The actual calendar range covered by 2011-W36 (assuming the reporting year begins July 1) is 2012-03-05T00:00:00/2012-03-11T23:59:59
377 377  
378 378  === {{id name="_Toc291513"/}}4.2.7 Distinct Range ===
... ... @@ -381,16 +381,16 @@
381 381  
382 382  === {{id name="_Toc291514"/}}4.2.8 Time Format ===
383 383  
384 -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.
329 +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]].
385 385  
386 386  (% style="width:771.294px" %)
387 -|Code|(% style="width:659px" %)Format
388 -|OTP|(% style="width:659px" %)Observational Time Period: Superset of all SDMX time formats (Gregorian Time Period, Reporting Time Period, and Time Range)
389 -|STP|(% style="width:659px" %)Standard Time Period: Superset of Gregorian and Reporting Time Periods
390 -|GTP|(% style="width:659px" %)Superset of all Gregorian Time Periods and date-time
391 -|RTP|(% style="width:659px" %)Superset of all Reporting Time Periods
332 +|**Code**|(% style="width:659px" %)**Format**
333 +|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)
334 +|STP|(% style="width:659px" %)Standard [[Time Period>>doc:Glossary.Time period.WebHome]]: Superset of Gregorian and Reporting [[Time Periods>>doc:Glossary.Time period.WebHome]]
335 +|GTP|(% style="width:659px" %)Superset of all Gregorian [[Time Periods>>doc:Glossary.Time period.WebHome]] and date-time
336 +|RTP|(% style="width:659px" %)Superset of all Reporting [[Time Periods>>doc:Glossary.Time period.WebHome]]
392 392  |TR|(% style="width:659px" %)(((
393 -Time Range: Start time and duration (YYYY-MM-DD(Thh:mm:ss)?/<duration>)
338 +Time Range: Start time and duration (YYYY-MM-DD(Thh:mm:ss)?/)
394 394  )))
395 395  |GY|(% style="width:659px" %)Gregorian Year (YYYY)
396 396  |GTM|(% style="width:659px" %)Gregorian Year Month (YYYY-MM)
... ... @@ -405,11 +405,11 @@
405 405  |RD|(% style="width:659px" %)Reporting Day (YYYY-Dddd)
406 406  
407 407  (% class="wikigeneratedid" id="HTable1:SDMX-MLTimeFormatCodes" %)
408 -Table 1: SDMX-ML Time Format Codes
353 +**Table 1: SDMX-ML Time Format Codes**
409 409  
410 410  === {{id name="_Toc291515"/}}4.2.9 Time Zones ===
411 411  
412 -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):
357 +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):
413 413  
414 414  * Time Range (start date): 2006-06-05**-05:00**/P5D
415 415  * Time Range (start date-time): 2006-06-05T00:00:00**-05:00**/P5D
... ... @@ -424,33 +424,33 @@
424 424  * Reporting Month: 2006-M06**-05:00**
425 425  * Reporting Week: 2006-W23**-05:00**
426 426  * Reporting Day: 2006-D156**-05:00**
427 -* Reporting Year Start Day: ~-~-07-01**-05:00**
372 +* Reporting Year Start Day: 07-01**-05:00**
428 428  
429 -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.
374 +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.
430 430  
431 431  === {{id name="_Toc291516"/}}4.2.10 Representing Time Spans Elsewhere ===
432 432  
433 -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:
378 +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:
434 434  
435 -<Series REF_PERIODStartTime="2000-01-01T00:00:00" REF_PERIOD="P2M"/>
380 +> <Series REF_PERIODStartTime="2000-01-01T00:00:00" REF_PERIOD="P2M"/>
436 436  
437 437  can now be represented with this:
438 438  
439 -<Series REF_PERIOD="2000-01-01T00:00:00/P2M"/>
384 +> <Series REF_PERIOD="2000-01-01T00:00:00/P2M"/>
440 440  
441 441  === {{id name="_Toc291517"/}}4.2.11 Notes on Formats ===
442 442  
443 -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.
388 +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.
444 444  
445 445  === {{id name="_Toc291518"/}}4.2.12 Effect on Time Ranges ===
446 446  
447 -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.
392 +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.
448 448  
449 449  === 4.2.13 Time in Query Messages ===
450 450  
451 -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.
396 +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.
452 452  
453 -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.
398 +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.
454 454  
455 455  (% style="width:1020.29px" %)
456 456  |(% style="width:236px" %)**Operator**|(% style="width:781px" %)**Rule**
... ... @@ -460,16 +460,13 @@
460 460  |(% style="width:236px" %)Less Than or Equal To|(% style="width:781px" %)Any data on or before the last moment of the period
461 461  |(% 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
462 462  
463 -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.
408 +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.
464 464  
465 465  **Examples:**
466 466  
467 467  **Gregorian Period**
468 -
469 469  Query Parameter: Greater than 2010
470 -
471 471  Literal Interpretation: Any data where the start period occurs after 2010-1231T23:59:59.
472 -
473 473  Example Matches:
474 474  
475 475  * 2011 or later
... ... @@ -477,19 +477,18 @@
477 477  * 2011-01-01 or later
478 478  * 2011-01-01/P[Any Duration] or any later start date
479 479  * 2011-[Any reporting period] (any reporting year start day)
480 -* 2010-S2 (reporting year start day ~-~-07-01 or later)
481 -* 2010-T3 (reporting year start day ~-~-07-01 or later)
482 -* 2010-Q3 or later (reporting year start day ~-~-07-01 or later)
483 -* 2010-M07 or later (reporting year start day ~-~-07-01 or later)
484 -* 2010-W28 or later (reporting year start day ~-~-07-01 or later)
485 -* 2010-D185 or later (reporting year start day ~-~-07-01 or later)
422 +* 2010-S2 (reporting year start day 07-01 or later)
423 +* 2010-T3 (reporting year start day 07-01 or later)
424 +* 2010-Q3 or later (reporting year start day 07-01 or later)
425 +* 2010-M07 or later (reporting year start day 07-01 or later)
426 +* 2010-W28 or later (reporting year start day 07-01 or later)
427 +* 2010-D185 or later (reporting year start day 07-01 or later)
486 486  
487 487  **Reporting Period**
488 -
489 489  Query Parameter: Greater than or equal to 2010-Q3
431 +Literal Interpretation: Any data with a reporting period where the start period is on or after the start period of 2010-Q3 for the same reporting year start day, or and data where the start period is on or after 2010-07-01.
432 +Example Matches:
490 490  
491 -Literal Interpretation: Any data with a reporting period where the start period is on or after the start period of 2010-Q3 for the same reporting year start day, or and data where the start period is on or after 2010-07-01. Example Matches:
492 -
493 493  * 2011 or later
494 494  * 2010-07 or later
495 495  * 2010-07-01 or later
... ... @@ -499,91 +499,90 @@
499 499  * 2010-T3 (any reporting year start day)
500 500  * 2010-Q3 or later (any reporting year start day)
501 501  * 2010-M07 or later (any reporting year start day)
502 -* 2010-W27 or later (reporting year start day ~-~-01-01)^^5^^ • 2010-D182 or later (reporting year start day ~-~-01-01)
503 -* 2010-W28 or later (reporting year start day ~-~-07-01)^^6^^
504 -* 2010-D185 or later (reporting year start day ~-~-07-01)
443 +* 2010-W27 or later (reporting year start day 01-01)^^5^^ • 2010-D182 or later (reporting year start day 01-01)
444 +* 2010-W28 or later (reporting year start day 07-01)^^6^^
445 +* 2010-D185 or later (reporting year start day 07-01)
505 505  
506 506  == 4.3 Versioning ==
507 507  
508 -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".
449 +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".
509 509  
510 -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’.
451 +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’.
511 511  
512 512  === 4.3.1 Non-versioned artefacts ===
513 513  
514 -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’.
455 +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’.
515 515  
516 -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.
457 +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.
517 517  
518 -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.
459 +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.
460 +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.
519 519  
520 -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.
521 -
522 522  === 4.3.2 Semantically versioned artefacts ===
523 523  
524 -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.
464 +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.
525 525  
526 -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.
466 +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.
527 527  
528 528  The detailed rules for semantic versioning are listed in chapter 14 in the annex for “Semantic Versioning”. In short, they define:
529 529  
530 -Given a version number MAJOR.MINOR.PATCH (without EXTENSION), when making changes to that semantically versioned SDMX artefact, then one must increment the:
470 +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:
531 531  
532 -1. MAJOR version when backwards incompatible artefact changes are made,
533 -1. MINOR version when artefact elements are added in a backwards compatible manner, or
534 -1. PATCH version when backwards compatible artefact property changes are made.
472 +1. MAJOR (% style="color:#e74c3c" %)version(%%) when backwards incompatible [[artefact>>doc:Glossary.Artefact.WebHome]] changes are made,
473 +1. MINOR (% style="color:#e74c3c" %)version(%%) when [[artefact>>doc:Glossary.Artefact.WebHome]] elements are added in a backwards compatible manner, or
474 +1. PATCH (% style="color:#e74c3c" %)version(%%) when backwards compatible [[artefact>>doc:Glossary.Artefact.WebHome]] property changes are made.
535 535  
536 -When incrementing a version part, the right-hand side parts are 0-ed (reset to ‘0’).
476 +When incrementing a (% style="color:#e74c3c" %)version(%%) part, the right-hand side parts are 0-ed (reset to ‘0’).
537 537  
538 538  Extensions can be added, changed or dropped.
539 539  
540 -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.
480 +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.
541 541  
542 -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.
482 +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(%%).
543 543  
544 -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.
484 +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.
545 545  
546 546  === 4.3.3 Legacy-versioned artefacts ===
547 547  
548 -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.
488 +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.
549 549  
550 -In order to make artefacts immutable or changes truly predictable, a move to the new semantic versioning syntax is required.
490 +In order to make [[artefacts>>doc:Glossary.Artefact.WebHome]] immutable or changes truly predictable, a move to the new semantic versioning syntax is required.
551 551  
552 552  === 4.3.4 Dependency management and references ===
553 553  
554 -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:
494 +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:
555 555  
556 -* a fixed version of another artefact
557 -* the **latest available** version of another artefact
558 -* the **latest backward compatible** version of another artefact, or the **latest backward and forward** **compatible** version of another artefact.
496 +* a fixed (% style="color:#e74c3c" %)version(%%) of another [[artefact>>doc:Glossary.Artefact.WebHome]]
497 +* the **latest available** (% style="color:#e74c3c" %)version(%%) of another [[artefact>>doc:Glossary.Artefact.WebHome]]
498 +* 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]].
559 559  
560 -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.
500 +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.
561 561  
562 -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.
502 +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.
563 563  
564 -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.
504 +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.
565 565  
566 -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.
506 +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.
567 567  
568 568  The detailed rules for dependency management and references are listed in chapter 14 in the annex for “Semantic Versioning”.
569 569  
570 -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:
510 +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(%%):
571 571  
572 -* Artefact queries for a **specific** version (X.Y, X.Y.Z or X.Y.Z-EXT).
573 -* Artefact queries for **latest available** semantic versions within the wildcard scope (X+.Y.Z, X.Y+.Z or X.Y.Z+).
574 -* Queries for **non-versioned** artefacts.
575 -* 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.
512 +* [[Artefact>>doc:Glossary.Artefact.WebHome]] queries for a **specific** (% style="color:#e74c3c" %)version(%%) (X.Y, X.Y.Z or X.Y.Z-EXT).
513 +* [[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+).
514 +* Queries for **non-versioned** [[artefacts>>doc:Glossary.Artefact.WebHome]].
515 +* [[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.
576 576  
577 -The combination of wildcarded queries with a specific version extension is not permitted.
517 +The combination of wildcarded queries with a specific (% style="color:#e74c3c" %)version(%%) extension is not permitted.
578 578  
579 -Full details can be found in the SDMX RESTful web services specification.
519 +Full details can be found in the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web services specification.
580 580  
581 581  == 4.4 Structural Metadata Querying Best Practices ==
582 582  
583 -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.
523 +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.
584 584  
585 -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.
525 +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.
586 586  
587 -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.
527 +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.
588 588  
589 589  {{putFootnotes/}}
SUZ.Methodology.Code.MethodologyClass[0]
index
... ... @@ -1,0 +1,1 @@
1 +4