Skip to Content
Last modified by Artur on 2025/09/10 11:19
From version 2.5
edited by Helena
on 2025/06/08 23:40
Change comment: There is no comment for this version
To version 4.2
edited by Helena
on 2025/06/11 00:24
Change comment: There is no comment for this version

Summary

Details

Page properties
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:sdmx:Glossary.Data set.WebHome]] in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] formats. Supported only in [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] (and some in [[SDMX-JSON>>doc:sdmx:Glossary.SDMX-JSON.WebHome]]), these topics include the use of the [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] mechanism in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]], the use of [[Structure Sets>>doc:sdmx:Glossary.Structure set.WebHome]] and [[Reporting Taxonomies>>doc:sdmx:Glossary.Reporting taxonomy.WebHome]], the use of Processes, a discussion of time and datatyping, and the conventional mechanisms within the [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] Structure message regarding versioning and referencing.
6 6  
7 7  == 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:sdmx:Glossary.Representation.WebHome]] in [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]], taken from XML Schemas and common programming languages. The table below describes the various [[representations>>doc:sdmx:Glossary.Representation.WebHome]], which are found in [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]], and their equivalents.
12 12  
13 13  |(% style="width:191px" %)**SDMX-ML Data Type**|(% style="width:232px" %)**XML Schema Data Type**|(% style="width:212px" %)**.NET Framework Type**|(% style="width:980px" %)(((
14 14  **Java Data Type**
... ... @@ -18,7 +18,7 @@
18 18  |(% style="width:191px" %)Integer|(% style="width:232px" %)xsd:int|(% style="width:212px" %)System.Int32|(% style="width:980px" %)int
19 19  |(% style="width:191px" %)Long|(% style="width:232px" %)xsd.long|(% style="width:212px" %)System.Int64|(% style="width:980px" %)long
20 20  |(% style="width:191px" %)Short|(% style="width:232px" %)xsd:short|(% style="width:212px" %)System.Int16|(% style="width:980px" %)short
21 -|(% style="width:191px" %)Decimal|(% style="width:232px" %)xsd:decimal|(% style="width:212px" %)System.Decimal|(% style="width:980px" %)java.math.BigDecimal
21 +|(% style="width:191px" %)[[Decimal>>doc:sdmx:Glossary.Decimals.WebHome]]|(% style="width:232px" %)xsd:decimal|(% style="width:212px" %)System.Decimal|(% style="width:980px" %)java.math.BigDecimal
22 22  |(% style="width:191px" %)Float|(% style="width:232px" %)xsd:float|(% style="width:212px" %)System.Single|(% style="width:980px" %)float
23 23  |(% style="width:191px" %)Double|(% style="width:232px" %)xsd:double|(% style="width:212px" %)System.Double|(% style="width:980px" %)double
24 24  |(% style="width:191px" %)Boolean|(% style="width:232px" %)xsd:boolean|(% style="width:212px" %)System.Boolean|(% style="width:980px" %)boolean
... ... @@ -31,7 +31,7 @@
31 31  |(% style="width:191px" %)Day, MonthDay, Month|(% style="width:232px" %)xsd:g*|(% style="width:212px" %)System.DateTime|(% style="width:980px" %)javax.xml.datatype.XMLGregorianCalendar
32 32  |(% style="width:191px" %)Duration|(% style="width:232px" %)xsd:duration|(% style="width:212px" %)System.TimeSpan|(% style="width:980px" %)javax.xml.datatype.Duration
33 33  
34 -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:
34 +There are also a number of [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] data types which do not have these direct correspondences, often because they are composite [[representations>>doc:sdmx: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:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] schemas, for others a derived simple type will be necessary:
35 35  
36 36  * **AlphaNumeric** (**common:AlphaNumericType**, string which only allows A-z and 09)
37 37  * **Alpha** (**common:AlphaType**, string which only allows A-z)
... ... @@ -58,7 +58,7 @@
58 58  * **IdentifiableReference** (types for each IdentifiableObject)
59 59  * **GeospatialInformation** (a geo feature set, according to the pattern in section 7.2)
60 60  
61 -Data types also have a set of facets:
61 +Data types also have a set of [[facets>>doc:sdmx:Glossary.Facet.WebHome]]:
62 62  
63 63  * **isSequence = true | false** (indicates a sequentially increasing value)
64 64  * **minLength = positive integer** (# of characters/digits)
... ... @@ -74,13 +74,13 @@
74 74  * **pattern =** (a regular expression, as per W3C XML Schema)
75 75  * **isMultiLingual = boolean** (for specifying text can occur in more than one language)
76 76  
77 -Note that code lists may also have textual representations assigned to them, in addition to their enumeration of codes.
77 +Note that [[code lists>>doc:sdmx:Glossary.Code list.WebHome]] may also have textual [[representations>>doc:sdmx:Glossary.Representation.WebHome]] assigned to them, in addition to their enumeration of [[codes>>doc:sdmx:Glossary.Code.WebHome]].
78 78  
79 79  === 4.1.1 Data Types ===
80 80  
81 -XML and JSON schemas support a variety of data types that, although rich, are not mapped one-to-one in all cases. This section provides an explanation of the mapping performed in SDMX 3.0, between such cases.
81 +XML and JSON schemas support a variety of data types that, although rich, are not (% style="color:#e74c3c" %)mapped(%%) one-to-one in all cases. This section provides an explanation of the mapping performed in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0, between such cases.
82 82  
83 -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.
83 +For identifiers, text fields and [[Codes>>doc:sdmx:Glossary.Code.WebHome]] there are no restriction from either side, since a generic type (e.g., that of string) accompanied by the proper regular expression works equally well for both XML and JSON.
84 84  
85 85  For example, for the id type, this is the XML schema definition:
86 86  
... ... @@ -99,7 +99,7 @@
99 99  > "pattern": "^[A-Za-z0-9_@$-]+$"
100 100  > }
101 101  
102 -There are also cases, though, that data types cannot be 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 +There are also cases, though, that data types cannot be (% style="color:#e74c3c" %)mapped(%%) like above. One such case is the array data type, which was introduced in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 as a new [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. In JSON schema an array is already natively foreseen, while in the XML schema, this has to be defined as a complex type, with an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] specific definition (i.e., specific element/[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] names for [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]). Beyond that, the minimum and/or maximum number of items within an array is possible in both cases.
103 103  
104 104  Further to the above, the mapping between the non-native data types is presented in the table below:
105 105  
... ... @@ -133,49 +133,49 @@
133 133  
134 134  === 4.2.1 Introduction ===
135 135  
136 -First, it is important to recognize that most observation times are a period. SDMX specifies precisely how Time is handled.
136 +First, it is important to recognize that most observation times are a period. [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] specifies precisely how Time is handled.
137 137  
138 -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 +The [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of time is broken into a hierarchical collection of [[representations>>doc:sdmx:Glossary.Representation.WebHome]]. A [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] can use of any of the [[representations>>doc:sdmx:Glossary.Representation.WebHome]] in the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] as the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of time. This allows for the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] of a particular [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] allow for only a subset of the default [[representation>>doc:sdmx:Glossary.Representation.WebHome]].
139 139  
140 -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 +The [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] of [[time formats>>doc:sdmx:Glossary.Time format.WebHome]] is as follows (**bold** indicates a [[category>>doc:sdmx:Glossary.Category.WebHome]] which is made up of multiple formats, //italic// indicates a distinct format):
141 141  
142 -* **Observational Time Period**
143 -** **Standard Time Period**
144 -*** **Basic Time Period**
145 -**** **Gregorian Time Period**
142 +* **Observational [[Time Period>>doc:sdmx:Glossary.Time period.WebHome]]**
143 +** **Standard [[Time Period>>doc:sdmx:Glossary.Time period.WebHome]]**
144 +*** **Basic [[Time Period>>doc:sdmx:Glossary.Time period.WebHome]]**
145 +**** **Gregorian [[Time Period>>doc:sdmx:Glossary.Time period.WebHome]]**
146 146  **** //Date Time//
147 -*** **Reporting Time Period**
147 +*** **Reporting [[Time Period>>doc:sdmx:Glossary.Time period.WebHome]]**
148 148  ** //Time Range//
149 149  
150 -The details of these time period categories and of the distinct formats which make them up are detailed in the sections to follow.
150 +The details of these [[time period>>doc:sdmx:Glossary.Time period.WebHome]] [[categories>>doc:sdmx:Glossary.Category.WebHome]] and of the distinct formats which make them up are detailed in the sections to follow.
151 151  
152 152  === 4.2.2 Observational Time Period ===
153 153  
154 -This is the superset of all time representations in SDMX. This allows for time to be expressed as any of the allowable formats.
154 +This is the superset of all time [[representations>>doc:sdmx:Glossary.Representation.WebHome]] in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]. This allows for time to be expressed as any of the allowable formats.
155 155  
156 156  === 4.2.3 Standard Time Period ===
157 157  
158 -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 +This is the superset of any predefined [[time period>>doc:sdmx:Glossary.Time period.WebHome]] or a distinct point in time. A [[time period>>doc:sdmx: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).
159 159  
160 160  === 4.2.4 Gregorian Time Period ===
161 161  
162 -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 +A Gregorian [[time period>>doc:sdmx: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:sdmx:Glossary.Representation.WebHome]] in [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] messages and the period covered by each of the Gregorian [[time periods>>doc:sdmx:Glossary.Time period.WebHome]] are as follows:
163 163  
164 164  **Gregorian Year:**
165 -Representation: xs:gYear (YYYY)
165 +[[Representation>>doc:sdmx:Glossary.Representation.WebHome]]: xs:gYear (YYYY)
166 166  Period: the start of January 1 to the end of December 31
167 167  **Gregorian Year Month**:
168 -Representation: xs:gYearMonth (YYYY-MM)
168 +[[Representation>>doc:sdmx:Glossary.Representation.WebHome]]: xs:gYearMonth (YYYY-MM)
169 169  Period: the start of the first day of the month to end of the last day of the month
170 170  **Gregorian Day**:
171 -Representation: xs:date (YYYY-MM-DD)
171 +[[Representation>>doc:sdmx:Glossary.Representation.WebHome]]: xs:date (YYYY-MM-DD)
172 172  Period: the start of the day (00:00:00) to the end of the day (23:59:59)
173 173  
174 174  === 4.2.5 Date Time ===
175 175  
176 -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.
176 +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:sdmx: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:sdmx:Glossary.Representation.WebHome]] can be used.
177 177  
178 -Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss)[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[2~]^^>>path:#_ftn2]]
178 +[[Representation>>doc:sdmx:Glossary.Representation.WebHome]]: xs:dateTime (YYYY-MM-DDThh:mm:ss){{footnote}}The seconds can be reported fractionally{{/footnote}}
179 179  
180 180  === 4.2.6 Standard Reporting Period ===
181 181  
... ... @@ -188,118 +188,82 @@
188 188  REPORTING_YEAR represents the reporting year as four digits (YYYY) PERIOD_INDICATOR identifies the type of period which determines the duration of the period
189 189  PERIOD_VALUE indicates the actual period within the year
190 190  
191 -The following section details each of the standard reporting periods defined in SDMX:
191 +The following section details each of the standard reporting periods defined in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:
192 192  
193 193  **Reporting Year**:
194 -
195 - Period Indicator: A
196 -
194 +Period Indicator: A
197 197  Period Duration: P1Y (one year)
198 -
199 199  Limit per year: 1
200 -
201 -Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1) **Reporting Semester:**
202 -
203 - Period Indicator: S
204 -
197 +[[Representation>>doc:sdmx:Glossary.Representation.WebHome]]: common:ReportingYearType (YYYY-A1, e.g. 2000-A1)
198 +**Reporting Semester:**
199 +Period Indicator: S
205 205  Period Duration: P6M (six months)
206 -
207 207  Limit per year: 2
208 -
209 -Representation: common:ReportingSemesterType (YYYY-Ss, e.g. 2000-S2)
210 -
202 +[[Representation>>doc:sdmx:Glossary.Representation.WebHome]]: common:ReportingSemesterType (YYYY-Ss, e.g. 2000-S2)
211 211  **Reporting Trimester:**
212 -
213 - Period Indicator: T
214 -
204 +Period Indicator: T
215 215  Period Duration: P4M (four months)
216 -
217 217  Limit per year: 3
218 -
219 -Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3) **Reporting Quarter:**
220 -
221 - Period Indicator: Q
222 -
207 +[[Representation>>doc:sdmx:Glossary.Representation.WebHome]]: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3)
208 +**Reporting Quarter:**
209 +Period Indicator: Q
223 223  Period Duration: P3M (three months)
224 -
225 225  Limit per year: 4
226 -
227 -Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4) **Reporting Month**:
228 -
212 +[[Representation>>doc:sdmx:Glossary.Representation.WebHome]]: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4)
213 +**Reporting Month**:
229 229  Period Indicator: M
230 -
231 231  Period Duration: P1M (one month)
232 -
233 233  Limit per year: 1
234 -
235 -Representation: common:ReportingMonthType (YYYY-Mmm, e.g. 2000-M12) Notes: The reporting month is always represented as two digits, therefore 1-9 are 0 padded (e.g. 01). This allows the values to be sorted chronologically using textual sorting methods.
236 -
217 +[[Representation>>doc:sdmx:Glossary.Representation.WebHome]]: common:ReportingMonthType (YYYY-Mmm, e.g. 2000-M12) Notes: The reporting month is always represented as two digits, therefore 1-9 are 0 padded (e.g. 01). This allows the values to be sorted chronologically using textual sorting methods.
237 237  **Reporting Week**:
238 -
239 239  Period Indicator: W
240 -
241 241  Period Duration: P7D (seven days)
242 -
243 243  Limit per year: 53
244 -
245 -Representation: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53)
246 -
247 -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" %)^^~[3~]^^>>path:#_ftn3]](%%) 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.
248 -
222 +[[Representation>>doc:sdmx:Glossary.Representation.WebHome]]: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53)
223 +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
224 +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.
249 249  **Reporting Day**:
250 -
251 251  Period Indicator: D
252 -
253 253  Period Duration: P1D (one day)
254 -
255 255  Limit per year: 366
256 -
257 -Representation: common:ReportingDayType (YYYY-Dddd, e.g. 2000-D366) Notes: There are either 365 or 366 days in a reporting year, depending on whether the reporting year includes leap day (February 29). The reporting day is always represented as three digits, therefore 1-99 are 0 padded (e.g. 001). This allows the values to be sorted chronologically using textual sorting methods.
258 -
229 +[[Representation>>doc:sdmx:Glossary.Representation.WebHome]]: common:ReportingDayType (YYYY-Dddd, e.g. 2000-D366) Notes: There are either 365 or 366 days in a reporting year, depending on whether the reporting year includes leap day (February 29). The reporting day is always represented as three digits, therefore 1-99 are 0 padded (e.g. 001). This allows the values to be sorted chronologically using textual sorting methods.
259 259  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.
260 260  
261 -A specialized attribute (reporting year start day) exists for the purpose of communicating the reporting year start day. This attribute has a fixed identifier
232 +A specialized [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] (reporting year start day) exists for the purpose of communicating the reporting year start day. This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] has a fixed identifier (REPORTING_YEAR_START_DAY) and a fixed [[representation>>doc:sdmx:Glossary.Representation.WebHome]] (xs:gMonthDay) so that it can always be easily identified and processed in a data message. Although this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] exists in specialized sub-class, it functions the same as any other [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] outside of its identification and [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. It must takes its identity from a (% style="color:#e74c3c" %)concept(%%) and state its relationship with other [[components>>doc:sdmx:Glossary.Component.WebHome]] of the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. The ability to state this relationship allows this reporting year start day [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] to exist at the appropriate (% style="color:#e74c3c" %)levels(%%) of a data message. In the absence of this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], the reporting year start date is assumed to be January 1; therefore if the reporting year coincides with the calendar year, this [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not necessary.
262 262  
263 -(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.
234 +Since the duration and the reporting year start day are known for any reporting period, it is possible to relate any reporting period to a distinct calendar period. The actual Gregorian calendar period covered by the reporting period can be computed as follows (based on the standard format of [REPROTING_YEAR]-[PERIOD_INDICATOR][PERIOD_VALUE] and the reporting year start day as [REPORTING_YEAR_START_DAY]):
264 264  
265 -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]-
266 -
267 -[PERIOD_INDICATOR][PERIOD_VALUE] and the reporting year start day as [REPORTING_YEAR_START_DAY]):
268 -
269 -1. **Determine [REPORTING_YEAR_BASE]:**
270 -
236 +**~1. Determine [REPORTING_YEAR_BASE]:**
271 271  Combine [REPORTING_YEAR] of the reporting period value (YYYY) with [REPORTING_YEAR_START_DAY] (MM-DD) to get a date (YYYY-MM-DD).
272 -
273 273  This is the [REPORTING_YEAR_START_DATE]
274 274  
275 -1.
276 -11. **If the [PERIOD_INDICATOR] is W:**
277 -111. **If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday:**
240 +a) **If the [PERIOD_INDICATOR] is W:**
278 278  
279 -Add[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[4~]^^>>path:#_ftn4]](%%) (P3D, P2D, or P1D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE].
242 +**~1. If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday:**
243 +Add[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[4~]^^>>path:#_ftn4]](%%) (P3D, P2D, or P1D respectively) to the 
244 +[REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE].
280 280  
281 -1.
282 -11.
283 -111. **If [REPORTING_YEAR_START_DATE] is a Monday, Tuesday, Wednesday, or Thursday:**
246 +2. **If [REPORTING_YEAR_START_DATE] is a Monday, Tuesday, Wednesday, or Thursday:**
284 284  
285 -Add^^4^^ (P0D, -P1D, -P2D, or -P3D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE].
248 +Add^^4^^ (P0D, -P1D, -P2D, or -P3D respectively) to the
249 +[REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE].
286 286  
287 -1.
288 -11. **Else:**
251 +**b)** **Else:**
289 289  
290 290  The [REPORTING_YEAR_START_DATE] is the [REPORTING_YEAR_BASE].
291 291  
292 -1. **Determine [PERIOD_DURATION]:**
293 -11. If the [PERIOD_INDICATOR] is A, the [PERIOD_DURATION] is P1Y.
294 -11. If the [PERIOD_INDICATOR] is S, the [PERIOD_DURATION] is P6M.
295 -11. If the [PERIOD_INDICATOR] is T, the [PERIOD_DURATION] is P4M.
296 -11. If the [PERIOD_INDICATOR] is Q, the [PERIOD_DURATION] is P3M.
297 -11. If the [PERIOD_INDICATOR] is M, the [PERIOD_DURATION] is P1M.
298 -11. If the [PERIOD_INDICATOR] is W, the [PERIOD_DURATION] is P7D.
299 -11. If the [PERIOD_INDICATOR] is D, the [PERIOD_DURATION] is P1D.
255 +**2. Determine [PERIOD_DURATION]:**
256 +
257 +1. If the [PERIOD_INDICATOR] is A, the [PERIOD_DURATION] is P1Y.
258 +1. If the [PERIOD_INDICATOR] is S, the [PERIOD_DURATION] is P6M.
259 +1. If the [PERIOD_INDICATOR] is T, the [PERIOD_DURATION] is P4M.
260 +1. If the [PERIOD_INDICATOR] is Q, the [PERIOD_DURATION] is P3M.
261 +1. If the [PERIOD_INDICATOR] is M, the [PERIOD_DURATION] is P1M.
262 +1. If the [PERIOD_INDICATOR] is W, the [PERIOD_DURATION] is P7D.
263 +1. If the [PERIOD_INDICATOR] is D, the [PERIOD_DURATION] is P1D.
300 300  1. **Determine [PERIOD_START]:**
301 301  
302 -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].
266 +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-todateTimes for further details.{{/footnote}} this to the [REPORTING_YEAR_BASE]. The result is the [PERIOD_START].
303 303  
304 304  1. **Determine the [PERIOD_END]:**
305 305  
... ... @@ -363,27 +363,28 @@
363 363  
364 364  === 4.2.8 Time Format ===
365 365  
366 -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.
330 +In (% style="color:#e74c3c" %)version(%%) 2.0 of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] there is a recommendation to use the [[time format>>doc:sdmx:Glossary.Time format.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] to gives additional information on the way time is represented in the message. Following an appraisal of its usefulness this is no longer required. However, it is still possible, if required , to include the [[time format>>doc:sdmx:Glossary.Time format.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] in [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]].
367 367  
368 -|(% style="width:95px" %)Code|(% style="width:1520px" %)Format
369 -|(% style="width:95px" %)OTP|(% style="width:1520px" %)Observational Time Period: Superset of all SDMX time formats (Gregorian Time Period, Reporting Time Period, and Time Range)
370 -|(% style="width:95px" %)STP|(% style="width:1520px" %)Standard Time Period: Superset of Gregorian and Reporting Time Periods
371 -|(% style="width:95px" %)GTP|(% style="width:1520px" %)Superset of all Gregorian Time Periods and date-time
372 -|(% style="width:95px" %)RTP|(% style="width:1520px" %)Superset of all Reporting Time Periods
373 -|(% style="width:95px" %)TR|(% style="width:1520px" %)(((
374 -Time Range: Start time and duration (YYYY-MM-DD(Thh:mm:ss)?/<duration>)
332 +(% style="width:890.835px" %)
333 +|(% style="width:95px" %)**Code**|(% style="width:793px" %)**Format**
334 +|(% style="width:95px" %)OTP|(% style="width:793px" %)Observational [[Time Period>>doc:sdmx:Glossary.Time period.WebHome]]: Superset of all [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[time formats>>doc:sdmx:Glossary.Time format.WebHome]] (Gregorian [[Time Period>>doc:sdmx:Glossary.Time period.WebHome]], Reporting [[Time Period>>doc:sdmx:Glossary.Time period.WebHome]], and Time Range)
335 +|(% style="width:95px" %)STP|(% style="width:793px" %)Standard [[Time Period>>doc:sdmx:Glossary.Time period.WebHome]]: Superset of Gregorian and Reporting [[Time Periods>>doc:sdmx:Glossary.Time period.WebHome]]
336 +|(% style="width:95px" %)GTP|(% style="width:793px" %)Superset of all Gregorian [[Time Periods>>doc:sdmx:Glossary.Time period.WebHome]] and date-time
337 +|(% style="width:95px" %)RTP|(% style="width:793px" %)Superset of all Reporting [[Time Periods>>doc:sdmx:Glossary.Time period.WebHome]]
338 +|(% style="width:95px" %)TR|(% style="width:793px" %)(((
339 +Time Range: Start time and duration (YYYY-MM-DD(Thh:mm:ss)?/)
375 375  )))
376 -|(% style="width:95px" %)GY|(% style="width:1520px" %)Gregorian Year (YYYY)
377 -|(% style="width:95px" %)GTM|(% style="width:1520px" %)Gregorian Year Month (YYYY-MM)
378 -|(% style="width:95px" %)GD|(% style="width:1520px" %)Gregorian Day (YYYY-MM-DD)
379 -|(% style="width:95px" %)DT|(% style="width:1520px" %)Distinct Point: date-time (YYYY-MM-DDThh:mm:ss)
380 -|(% style="width:95px" %)RY|(% style="width:1520px" %)Reporting Year (YYYY-A1)
381 -|(% style="width:95px" %)RS|(% style="width:1520px" %)Reporting Semester (YYYY-Ss)
382 -|(% style="width:95px" %)RT|(% style="width:1520px" %)Reporting Trimester (YYYY-Tt)
383 -|(% style="width:95px" %)RQ|(% style="width:1520px" %)Reporting Quarter (YYYY-Qq)
384 -|(% style="width:95px" %)RM|(% style="width:1520px" %)Reporting Month (YYYY-Mmm)
385 -|(% style="width:95px" %)RW|(% style="width:1520px" %)Reporting Week (YYYY-Www)
386 -|(% style="width:95px" %)RD|(% style="width:1520px" %)Reporting Day (YYYY-Dddd)
341 +|(% style="width:95px" %)GY|(% style="width:793px" %)Gregorian Year (YYYY)
342 +|(% style="width:95px" %)GTM|(% style="width:793px" %)Gregorian Year Month (YYYY-MM)
343 +|(% style="width:95px" %)GD|(% style="width:793px" %)Gregorian Day (YYYY-MM-DD)
344 +|(% style="width:95px" %)DT|(% style="width:793px" %)Distinct Point: date-time (YYYY-MM-DDThh:mm:ss)
345 +|(% style="width:95px" %)RY|(% style="width:793px" %)Reporting Year (YYYY-A1)
346 +|(% style="width:95px" %)RS|(% style="width:793px" %)Reporting Semester (YYYY-Ss)
347 +|(% style="width:95px" %)RT|(% style="width:793px" %)Reporting Trimester (YYYY-Tt)
348 +|(% style="width:95px" %)RQ|(% style="width:793px" %)Reporting Quarter (YYYY-Qq)
349 +|(% style="width:95px" %)RM|(% style="width:793px" %)Reporting Month (YYYY-Mmm)
350 +|(% style="width:95px" %)RW|(% style="width:793px" %)Reporting Week (YYYY-Www)
351 +|(% style="width:95px" %)RD|(% style="width:793px" %)Reporting Day (YYYY-Dddd)
387 387  
388 388  (% class="wikigeneratedid" id="HTable1:SDMX-MLTimeFormatCodes" %)
389 389  **Table 1: SDMX-ML Time Format Codes**
... ... @@ -390,7 +390,7 @@
390 390  
391 391  === 4.2.9 Time Zones ===
392 392  
393 -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):
358 +In alignment with ISO 8601, [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] allows the specification of a time zone on all [[time periods>>doc:sdmx: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:sdmx: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):
394 394  
395 395  * Time Range (start date): 2006-06-05**-05:00**/P5D
396 396  * Time Range (start date-time): 2006-06-05T00:00:00**-05:00**/P5D
... ... @@ -405,13 +405,13 @@
405 405  * Reporting Month: 2006-M06**-05:00**
406 406  * Reporting Week: 2006-W23**-05:00**
407 407  * Reporting Day: 2006-D156**-05:00**
408 -* Reporting Year Start Day: ~-~-07-01**-05:00**
373 +* Reporting Year Start Day: 07-01**-05:00**
409 409  
410 -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.
375 +According to ISO 8601, a date without a time-zone is considered "local time". [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] assumes that local time is that of the sender of the message. In this (% style="color:#e74c3c" %)version(%%) of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]], an optional field is added to the sender definition in the header for specifying a time zone. This field has a default value of 'Z' (UTC). This determination of local time applies for all dates in a message.
411 411  
412 412  === 4.2.10 Representing Time Spans Elsewhere ===
413 413  
414 -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:
379 +It has been possible since [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 2.0 for a [[Component>>doc:sdmx:Glossary.Component.WebHome]] to specify a [[representation>>doc:sdmx: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:sdmx:Glossary.Attribute.WebHome]] for holding the start time and the duration or two separate XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] based on the underlying [[Component>>doc:sdmx:Glossary.Component.WebHome]] identifier. For example, if REF_PERIOD were given a [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of time span, then in the Compact data format, it would be represented by two XML [[attributes>>doc:sdmx: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:sdmx: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:
415 415  
416 416  >(% style="font-size:18px" %) <Series REF_PERIODStartTime="2000-01-01T00:00:00" REF_PERIOD="P2M"/>
417 417  
... ... @@ -421,35 +421,33 @@
421 421  
422 422  === 4.2.11 Notes on Formats ===
423 423  
424 -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.
389 +There is no ambiguity in these formats so that for any given value of time, the [[category>>doc:sdmx:Glossary.Category.WebHome]] of the period (and thus the intended [[time period>>doc:sdmx: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.
425 425  
426 426  === 4.2.12 Effect on Time Ranges ===
427 427  
428 -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.
393 +All [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] data messages are capable of functioning in a manner similar to SDMXEDI if the [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) is time: the [[time period>>doc:sdmx:Glossary.Time period.WebHome]] for the first observation can be stated and the rest of the observations can omit the time value as it can be derived from the start time and the frequency. Since the frequency can be determined based on the actual format of the time value for everything but distinct points in time and time ranges, this makes is even simpler to process as the interval between time ranges is known directly from the time value.
429 429  
430 430  === 4.2.13 Time in Query Messages ===
431 431  
432 -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.
397 +When querying for time values, the value of a time parameter can be provided as any of the Observational [[Time Period>>doc:sdmx: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.
433 433  
434 -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.
399 +Fundamental to processing a time value parameter in a query message is understanding that all [[time periods>>doc:sdmx: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:sdmx:Glossary.Time period.WebHome]] for requested parameter is encompassed by the [[time period>>doc:sdmx: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:sdmx:Glossary.Time period.WebHome]] provided as a parameter.
435 435  
436 -|**Operator**|**Rule**
437 -|Greater Than|Any data after the last moment of the period
438 -|Less Than|Any data before the first moment of the period
439 -|Greater Than or Equal To|Any data on or after the first moment of the period
440 -|Less Than or Equal To|Any data on or before the last moment of the period
441 -|Equal To|Any data which falls on or after the first moment of the period and before or on the last moment of the period
401 +(% style="width:770.835px" %)
402 +|(% style="width:220px" %)**Operator**|(% style="width:548px" %)**Rule**
403 +|(% style="width:220px" %)Greater Than|(% style="width:548px" %)Any data after the last moment of the period
404 +|(% style="width:220px" %)Less Than|(% style="width:548px" %)Any data before the first moment of the period
405 +|(% style="width:220px" %)Greater Than or Equal To|(% style="width:548px" %)Any data on or after the first moment of the period
406 +|(% style="width:220px" %)Less Than or Equal To|(% style="width:548px" %)Any data on or before the last moment of the period
407 +|(% style="width:220px" %)Equal To|(% style="width:548px" %)Any data which falls on or after the first moment of the period and before or on the last moment of the period
442 442  
443 -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.
409 +Reporting [[Time Periods>>doc:sdmx: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:sdmx:Glossary.Time period.WebHome]] to compare weeks and days to higher order report periods. This will be demonstrated in the examples to follow.
444 444  
445 445  **Examples:**
446 446  
447 447  **Gregorian Period**
448 -
449 449  Query Parameter: Greater than 2010
450 -
451 451  Literal Interpretation: Any data where the start period occurs after 2010-1231T23:59:59.
452 -
453 453  Example Matches:
454 454  
455 455  * 2011 or later
... ... @@ -465,9 +465,7 @@
465 465  * 2010-D185 or later (reporting year start day ~-~-07-01 or later)
466 466  
467 467  **Reporting Period**
468 -
469 469  Query Parameter: Greater than or equal to 2010-Q3
470 -
471 471  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:
472 472  
473 473  * 2011 or later
... ... @@ -479,103 +479,90 @@
479 479  * 2010-T3 (any reporting year start day)
480 480  * 2010-Q3 or later (any reporting year start day)
481 481  * 2010-M07 or later (any reporting year start day)
482 -* 2010-W27 or later (reporting year start day ~-~-01-01)^^5^^
443 +* 2010-W27 or later (reporting year start day ~-~-01-01){{footnote}}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.{{/footnote}}
483 483  * 2010-D182 or later (reporting year start day ~-~-01-01)
484 -* 2010-W28 or later (reporting year start day ~-~-07-01)^^6^^
445 +* 2010-W28 or later (reporting year start day ~-~-07-01){{footnote}}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.{{/footnote}}
485 485  * 2010-D185 or later (reporting year start day ~-~-07-01)
486 486  
487 487  == 4.3 Versioning ==
488 488  
489 -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".
450 +Versioning operates at the (% style="color:#e74c3c" %)level(%%) of versionable and maintainable objects in the [[SDMX information model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]. Within the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Structure and MetadataSet messages, there is a well-defined pattern for [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] versioning and referencing. The [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] identifiers are qualified by their (% style="color:#e74c3c" %)version(%%) numbers – that is, an object with an Agency of "A", and ID of "X" and a (% style="color:#e74c3c" %)version(%%) of "1.0.0" is a different object than one with an Agency of "A", an ID of "X", and a (% style="color:#e74c3c" %)version(%%) of "1.1.0".
490 490  
491 -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" [[(>>url:http://semver.org/]][[http:~~/~~/semver.org>>url:http://semver.org/]][[)>>url:http://semver.org/]], in addition to the legacy non-restrictive versioning scheme. In addition, the "isFinal" property is removed from
452 +As of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0, the versioning rules are extended to allow for truly versioned [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] through the implementation of the rules of the well-known practice called "Semantic Versioning" ([[http:~~/~~/semver.org>>https://http:semver.org]]), in addition to the legacy non-restrictive versioning scheme. In addition, the "isFinal" property is removed from //MaintainableArtefact//. According to the legacy versioning, any [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] defined without a (% style="color:#e74c3c" %)version(%%) is equivalent to following the legacy versioning, thus having (% style="color:#e74c3c" %)version(%%) ‘1.0’.
492 492  
493 -//MaintainableArtefact//. According to the legacy versioning, any artefact defined without a version is equivalent to following the legacy versioning, thus having version
494 -
495 -‘1.0’.
496 -
497 497  === 4.3.1 Non-versioned artefacts ===
498 498  
499 -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’.
456 +Indeed, some use cases do not need or are incompatible with versioning for some or all their structural [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]], such as the Agency, [[Data Providers>>doc:sdmx:Glossary.Data provider.WebHome]], Metadata Providers and [[Data Consumer Schemes>>doc:sdmx:Glossary.Data consumer scheme.WebHome]]. These [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] follow the legacy versioning, with a fixed (% style="color:#e74c3c" %)version(%%) set to ‘1.0’.
500 500  
501 -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.
458 +Many existing organisation’s data management systems work with (% style="color:#e74c3c" %)version(%%)-less structures and apply ad-hoc [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] governance processes. The new nonversioned [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] will allow supporting those numerous situations, where organisations do not manage (% style="color:#e74c3c" %)version(%%) numbers.
502 502  
503 503  === 4.3.2 Semantically versioned artefacts ===
504 504  
505 -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.
462 +Since the purpose of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] versioning is to allow communicating the structural [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] changes to data exchange partners and connected systems, [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 offers Semantic Versioning (aka SemVer) with a clear and unambiguous syntax to all semantically versioned [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 structural [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]. Semantic versioning will thus better respond to situations where the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] standard itself is the only structural contract between [[data providers>>doc:sdmx:Glossary.Data provider.WebHome]] and [[data consumers>>doc:sdmx:Glossary.Data consumer.WebHome]] and where changes in structures can only be communicated through the (% style="color:#e74c3c" %)version(%%) number increases.
506 506  
507 -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.
464 +The semantic (% style="color:#e74c3c" %)version(%%) number consists of four parts: MAJOR, MINOR, PATCH and EXTENSION, the first three parts being separated by a dot (.), the last two parts being separated by a hyphen : MAJOR.MINOR.PATCH-EXTENSION. All (% style="color:#e74c3c" %)versions(%%) are ordered.
508 508  
509 509  The detailed rules for semantic versioning are listed in chapter 14 in the annex for “Semantic Versioning”. In short, they define:
510 510  
511 -Given a version number MAJOR.MINOR.PATCH (without EXTENSION), when making changes to that semantically versioned SDMX artefact, then one must increment the:
468 +Given a (% style="color:#e74c3c" %)version(%%) number MAJOR.MINOR.PATCH (without EXTENSION), when making changes to that semantically versioned [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]], then one must increment the:
512 512  
513 -1. MAJOR version when backwards incompatible artefact changes are made,
514 -1. MINOR version when artefact elements are added in a backwards compatible manner, or
515 -1. PATCH version when backwards compatible artefact property changes are made.
470 +1. MAJOR (% style="color:#e74c3c" %)version(%%) when backwards incompatible [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] changes are made,
471 +1. MINOR (% style="color:#e74c3c" %)version(%%) when [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] elements are added in a backwards compatible manner, or
472 +1. PATCH (% style="color:#e74c3c" %)version(%%) when backwards compatible [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] property changes are made.
516 516  
517 -When incrementing a version part, the right-hand side parts are 0-ed (reset to ‘0’).
474 +When incrementing a (% style="color:#e74c3c" %)version(%%) part, the right-hand side parts are 0-ed (reset to ‘0’).
518 518  
519 519  Extensions can be added, changed or dropped.
520 520  
521 -Given 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.
478 +Given an extended (% style="color:#e74c3c" %)version(%%) number MAJOR.MINOR.PATCH-EXTENSION, when making changes to that versioned [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]], then one is not required to increment the (% style="color:#e74c3c" %)version(%%) if those changes are within the allowed scope of the (% style="color:#e74c3c" %)version(%%) increment from the previous (% style="color:#e74c3c" %)version(%%) (if that existed); otherwise, the above (% style="color:#e74c3c" %)version(%%) increment rules apply. EXTENSIONs can be used e.g., for drafting or a pre-release.
522 522  
523 -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.
480 +Semantically versioned [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] will thus be safe to use. Specific (% style="color:#e74c3c" %)version(%%) patterns allow them to become either immutable, i.e., the maintainer commits to never change their content, or changeable only within a well-defined scope. If any further change is required, a new (% style="color:#e74c3c" %)version(%%) must be created first. Furthermore, the impact of the further change is communicated using a clear (% style="color:#e74c3c" %)version(%%) increment. The built-in (% style="color:#e74c3c" %)version(%%) extension facility allows for eased drafting of new [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] (% style="color:#e74c3c" %)versions(%%).
524 524  
525 -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.
482 +The production (% style="color:#e74c3c" %)versions(%%) of [[identifiable artefacts>>doc:sdmx:Glossary.Identifiable artefact.WebHome]] are assumed stable, i.e., they do not have an EXTENSION. This is because once in production, an [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] cannot change in any way, or it must change the (% style="color:#e74c3c" %)version(%%). For cases where an [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is not static, like during the drafting, the (% style="color:#e74c3c" %)version(%%) must indicate this by including an EXTENSION. Draft [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] should not be used outside of a specific system designed to accommodate them. For most purposes, all [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] should become stable before being used in production.
526 526  
527 527  === 4.3.3 Legacy-versioned artefacts ===
528 528  
529 -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.
486 +Organisations wishing to keep a maximum of backwards compatibility with existing implementations can continue using the previous 2-digit convention for (% style="color:#e74c3c" %)version(%%) numbers (MAJOR.MINOR) as in the past, such as '2.3', but without the ‘isFinal’ property. The new [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 standard does not add any strict rules or guarantees about changes in those [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]], since the legacy versioning rules were rather loose and non-binding, including the meaning of the ‘isFinal’ property, and their implementations were varying.
530 530  
531 -In order to make artefacts immutable or changes truly predictable, a move to the new semantic versioning syntax is required.
488 +In order to make [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] immutable or changes truly predictable, a move to the new semantic versioning syntax is required.
532 532  
533 533  === 4.3.4 Dependency management and references ===
534 534  
535 -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:
492 +New flexible dependency specifications with wildcarding allow for easier data model maintenance and enhancements for semantically versioned [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]. This allows implementing a smart referencing mechanism, whereby an [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] may reference:
536 536  
537 -* a fixed version of another artefact
538 -* the **latest available** version of another artefact
539 -* the **latest backward compatible** version of another artefact, or the **latest backward and forward** **compatible** version of another artefact.
494 +* a fixed (% style="color:#e74c3c" %)version(%%) of another [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]]
495 +* the **latest available** (% style="color:#e74c3c" %)version(%%) of another [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]]
496 +* the **latest backward compatible** (% style="color:#e74c3c" %)version(%%) of another [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]], or the **latest backward and forward** **compatible** (% style="color:#e74c3c" %)version(%%) of another [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]].
540 540  
541 -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.
498 +References not representing a strict [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] dependency, such as the target [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] defined in a MetadataProvisionAgreement allow for linking to **all currently available** (% style="color:#e74c3c" %)versions(%%) of another [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]]. Another illustrative case for such loose referencing is that of (% style="color:#e74c3c" %)Constraints(%%) and flows. A (% style="color:#e74c3c" %)Constraint(%%) may reference many [[Dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]] or [[Metadataflows>>doc:sdmx:Glossary.Metadataflow.WebHome]], the addition of more references to flow objects does not (% style="color:#e74c3c" %)version(%%) the (% style="color:#e74c3c" %)Constraint(%%). This is because the (% style="color:#e74c3c" %)Constraints(%%) are not properties of the flows – they merely make references to them.
542 542  
543 -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.
500 +Semantically versioned [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] must only reference other semantically versioned [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]], which may include extended (% style="color:#e74c3c" %)versions(%%). Non-versioned and legacy-versioned [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] can reference any other non-versioned or versioned (whether semantic or legacy) [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]. The scope of wildcards in references adapts correspondingly.
544 544  
545 -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.
502 +The mechanism named "early binding" refers to a dependency on a stable versioned [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] – everything with a stable versioned identity is a known quantity and will not change. The "late binding" mechanism is based on a wildcarded reference, and it resolves that reference and determines the currently related [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] at runtime.
546 546  
547 -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.
504 +One area which is much impacted by this versioning scheme is the ability to reference external objects. With the many dependencies within the various structural objects in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]], it is useful to have a scheme for external referencing. This is done at the (% style="color:#e74c3c" %)level(%%) of maintainable objects (DSDs, Codelists, [[Concept Schemes>>doc:sdmx:Glossary.Concept scheme.WebHome]], etc.) In an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Structure Message, whenever an "[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]" [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is set to true, then the application must resolve the address provided in the associated "uri" [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] and use the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Structure Message stored at that location for the full definition of the object in question. Alternately, if a registry "urn" [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] has been provided, the registry can be used to supply the full details of the object.
548 548  
549 549  The detailed rules for dependency management and references are listed in chapter 14 in the annex for “Semantic Versioning”.
550 550  
551 -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:
508 +In order to allow resolving the described new forms of dependencies, the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 Rest API supports retrievals legacy-versioned, wildcarded and extended [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] (% style="color:#e74c3c" %)versions(%%):
552 552  
553 -* Artefact queries for a **specific** version (X.Y, X.Y.Z or X.Y.Z-EXT).
554 -* Artefact queries for **latest available** semantic versions within the wildcard scope (X+.Y.Z, X.Y+.Z or X.Y.Z+).
555 -* Queries for **non-versioned** artefacts.
556 -* 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.
510 +* [[Artefact>>doc:sdmx:Glossary.Artefact.WebHome]] queries for a **specific** (% style="color:#e74c3c" %)version(%%) (X.Y, X.Y.Z or X.Y.Z-EXT).
511 +* [[Artefact>>doc:sdmx:Glossary.Artefact.WebHome]] queries for **latest available** semantic (% style="color:#e74c3c" %)versions(%%) within the wildcard scope (X+.Y.Z, X.Y+.Z or X.Y.Z+).
512 +* Queries for **non-versioned** [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]].
513 +* [[Artefact>>doc:sdmx:Glossary.Artefact.WebHome]] queries for **all available** semantic (% style="color:#e74c3c" %)versions(%%) within the wildcard scope (*, X.* or X.Y.*), where only the first form is required for resolving wildcarded loose references.
557 557  
558 -The combination of wildcarded queries with a specific version extension is not permitted.
515 +The combination of wildcarded queries with a specific (% style="color:#e74c3c" %)version(%%) extension is not permitted.
559 559  
560 -Full details can be found in the SDMX RESTful web services specification.
517 +Full details can be found in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web services specification.
561 561  
562 562  == 4.4 Structural Metadata Querying Best Practices ==
563 563  
564 -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.
521 +When querying for [[structural metadata>>doc:sdmx: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.
565 565  
566 -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.
523 +Any [[structural metadata>>doc:sdmx: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:sdmx: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:sdmx:Glossary.Category.WebHome]] or [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]]. This mechanism should be used when the referenced object is known.
567 567  
568 -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.
525 +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:sdmx:Glossary.Category scheme.WebHome]] and the related categorisations for a given [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]]. In this case, one could query for the [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] by the [[maintenance agency>>doc:sdmx: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:sdmx:Glossary.Category.WebHome]] in the matched schemes to be returned, as well as the object which they categorise.
569 569  
570 570  ----
571 571  
572 -[[~[1~]>>path:#_ftnref1]] Regular expressions, as specified in [[W3C XML Schema Definition Language (XSD)>>url:https://www.w3.org/TR/xmlschema11-2/]][[ >>url:https://www.w3.org/TR/xmlschema11-2/]][[1.1 Part 2: Datatypes>>url:https://www.w3.org/TR/xmlschema11-2/]][[.>>url:https://www.w3.org/TR/xmlschema11-2/]]
573 -
574 -[[~[2~]>>path:#_ftnref2]] The seconds can be reported fractionally
575 -
576 -[[~[3~]>>path:#_ftnref3]] 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.
577 -
578 -[[~[4~]>>path:#_ftnref4]] The rules for adding durations to a date time are described in the W3C XML Schema specification. See [[http:~~/~~/www.w3.org/TR/xmlschema>>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[->>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[2/#adding>>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[->>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[durations>>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[->>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[to>>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[dateTimes>>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[ >>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]]for further details.
579 -
580 -
581 581  {{putFootnotes/}}
SUZ.Methodology.Code.MethodologyClass[0]
index
... ... @@ -1,0 +1,1 @@
1 +4