Skip to Content
Version 2.15 by Helena on 2025/06/08 23:51
Show last authors
1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
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.
6
7 == 4.1 Representations ==
8
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
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.
12
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 **Java Data Type**
15 )))
16 |(% style="width:191px" %)String|(% style="width:232px" %)xsd:string|(% style="width:212px" %)System.String|(% style="width:980px" %)java.lang.String
17 |(% style="width:191px" %)Big Integer|(% style="width:232px" %)xsd:integer|(% style="width:212px" %)System.Decimal|(% style="width:980px" %)java.math.BigInteger
18 |(% style="width:191px" %)Integer|(% style="width:232px" %)xsd:int|(% style="width:212px" %)System.Int32|(% style="width:980px" %)int
19 |(% style="width:191px" %)Long|(% style="width:232px" %)xsd.long|(% style="width:212px" %)System.Int64|(% style="width:980px" %)long
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
22 |(% style="width:191px" %)Float|(% style="width:232px" %)xsd:float|(% style="width:212px" %)System.Single|(% style="width:980px" %)float
23 |(% style="width:191px" %)Double|(% style="width:232px" %)xsd:double|(% style="width:212px" %)System.Double|(% style="width:980px" %)double
24 |(% style="width:191px" %)Boolean|(% style="width:232px" %)xsd:boolean|(% style="width:212px" %)System.Boolean|(% style="width:980px" %)boolean
25 |(% style="width:191px" %)URI|(% style="width:232px" %)xsd:anyURI|(% style="width:212px" %)System.Uri|(% style="width:980px" %)Java.net.URI or java.lang.String
26 |(% style="width:191px" %)DateTime|(% style="width:232px" %)xsd:dateTime|(% style="width:212px" %)System.DateTime|(% style="width:980px" %)javax.xml.datatype.XMLGregorianCalendar
27 |(% style="width:191px" %)Time|(% style="width:232px" %)xsd:time|(% style="width:212px" %)System.DateTime|(% style="width:980px" %)javax.xml.datatype.XMLGregorianCalendar
28 |(% style="width:191px" %)GregorianYear|(% style="width:232px" %)xsd:gYear|(% style="width:212px" %)System.DateTime|(% style="width:980px" %)javax.xml.datatype.XMLGregorianCalendar
29 |(% style="width:191px" %)GregorianMonth|(% style="width:232px" %)xsd:gYearMonth|(% style="width:212px" %)System.DateTime|(% style="width:980px" %)javax.xml.datatype.XMLGregorianCalendar
30 |(% style="width:191px" %)GregorianDay|(% style="width:232px" %)xsd:date|(% style="width:212px" %)System.DateTime|(% style="width:980px" %)javax.xml.datatype.XMLGregorianCalendar
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 |(% style="width:191px" %)Duration|(% style="width:232px" %)xsd:duration|(% style="width:212px" %)System.TimeSpan|(% style="width:980px" %)javax.xml.datatype.Duration
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:
35
36 * **AlphaNumeric** (**common:AlphaNumericType**, string which only allows A-z and 09)
37 * **Alpha** (**common:AlphaType**, string which only allows A-z)
38 * **Numeric** (**common:NumericType**, string which only allows 0-9, but is not numeric so that is can having leading zeros)
39 * **Count** (**xs:integer**, a sequence with an interval of "1")
40 * **InclusiveValueRange** (**xs:decimal** with the **minValue** and **maxValue** facets supplying the bounds)
41 * **ExclusiveValueRange** (**xs:decimal** with the **minValue** and **maxValue** facets supplying the bounds)
42 * **Incremental** (**xs:decimal** with a specified **interval**; the interval is typically enforced outside of the XML validation)
43 * **TimeRange** (**common:TimeRangeType**, **startDateTime** + **Duration**)
44 * **ObservationalTimePeriod** (**common:ObservationalTimePeriodType**, a union of **StandardTimePeriod** and **TimeRange**).
45 * **StandardTimePeriod** (**common:StandardTimePeriodType**, a union of **BasicTimePeriod** and **ReportingTimePeriod**).
46 * **BasicTimePeriod** (**common:BasicTimePeriodType**, a union of **GregorianTimePeriod** and **DateTime**)
47 * **GregorianTimePeriod** (**common:GregorianTimePeriodType**, a union of **GregorianYear**, **GregorianMonth**, and **GregorianDay**)
48 * **ReportingTimePeriod** (**common:ReportingTimePeriodType**, a union of **ReportingYear**, **ReportingSemester**, **ReportingTrimester**, **ReportingQuarter**, **ReportingMonth**, **ReportingWeek**, and **ReportingDay**).
49 * **ReportingYear** (**common:ReportingYearType**)
50 * **ReportingSemester** (**common:ReportingSemesterType**)
51 * **ReportingTrimester** (**common:ReportingTrimesterType**)
52 * **ReportingQuarter** (**common:ReportingQuarterType**)
53 * **ReportingMonth** (**common:ReportingMonthType**)
54 * **ReportingWeek** (**common:ReportingWeekType**)
55 * **ReportingDay** (**common:ReportingDayType**)
56 * **XHTML** (**common:StructuredText**, allows for multi-lingual text content that has **XHTML** markup)
57 * **KeyValues** (**common:DataKeyType**)
58 * **IdentifiableReference** (types for each IdentifiableObject)
59 * **GeospatialInformation** (a geo feature set, according to the pattern in section 7.2)
60
61 Data types also have a set of facets:
62
63 * **isSequence = true | false** (indicates a sequentially increasing value)
64 * **minLength = positive integer** (# of characters/digits)
65 * **maxLength = positive integer** (# of characters/digits)
66 * **startValue = decimal** (for numeric sequence)
67 * **endValue = decimal** (for numeric sequence)
68 * **interval = decimal** (for numeric sequence) • **timeInterval = duration**
69 * **startTime = BasicTimePeriod** (for time range)
70 * **endTime = BasicTimePeriod** (for time range)
71 * **minValue = decimal** (for numeric range)
72 * **maxValue = decimal** (for numeric range)
73 * **decimal = Integer** (# of digits to right of decimal point)
74 * **pattern =** (a regular expression, as per W3C XML Schema)
75 * **isMultiLingual = boolean** (for specifying text can occur in more than one language)
76
77 Note that code lists may also have textual representations assigned to them, in addition to their enumeration of codes.
78
79 === 4.1.1 Data Types ===
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.
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.
84
85 For example, for the id type, this is the XML schema definition:
86
87 > <xs:simpleType name="IDType">
88 > <xs:restriction base="NestedIDType">
89 > <xs:pattern value="[A-Za-z0-9_@$\-]+"/>
90 > </xs:restriction>
91 > </xs:simpleType>
92
93 Where the NestedIDType is also a restriction of string.
94
95 The above looks like this, in JSON schema:
96
97 > "idType": {
98 > "type": "string",
99 > "pattern": "^[A-Za-z0-9_@$-]+$"
100 > }
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.
103
104 Further to the above, the mapping between the non-native data types is presented in the table below:
105
106 (% style="width:1005.83px" %)
107 |(% style="width:198px" %)**SDMX Facet**|(% style="width:241px" %)**XML Schema**|(% style="width:563px" %)**JSON schema **"**pattern**"{{footnote}}Regular expressions, as specified in W3C XML Schema Definition Language (XSD) 1.1 Part 2: Datatypes.{{/footnote}} **for "string" type**
108 |(% style="width:198px" %)GregorianYear|(% style="width:241px" %)xsd:gYear|(% style="width:563px" %)(((
109 "^-?([1-9][0-9]{3,}|0[0-9]{3})(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$"
110 )))
111 |(% style="width:198px" %)GregorianMonth|(% style="width:241px" %)xsd:gYearMonth|(% style="width:563px" %)(((
112 "^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$"
113 )))
114 |(% style="width:198px" %)GregorianDay|(% style="width:241px" %)xsd:date|(% style="width:563px" %)(((
115 "^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$"
116 )))
117 |(% style="width:198px" %)Day|(% style="width:241px" %)xsd:gDay|(% style="width:563px" %)(((
118 "^~-~--(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$"
119 )))
120 |(% style="width:198px" %)MonthDay|(% style="width:241px" %)xsd:gMonthDay|(% style="width:563px" %)(((
121 "^~-~-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$"
122 )))
123 |(% style="width:198px" %)Month|(% style="width:241px" %)xsd:Month|(% style="width:563px" %)(((
124 "^~-~-(0[1-9]|1[0-2])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$"
125 )))
126 |(% style="width:198px" %)Duration|(% style="width:241px" %)xsd:duration|(% style="width:563px" %)(((
127 "^-?P[0-9]+Y?([0-9]+M)?([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+(\.[0-9]+)?S)?)?$"
128 )))
129
130 == 4.2 Time and Time Format ==
131
132 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.
133
134 === 4.2.1 Introduction ===
135
136 First, it is important to recognize that most observation times are a period. SDMX specifies precisely how Time is handled.
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.
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):
141
142 * **Observational Time Period**
143 ** **Standard Time Period**
144 *** **Basic Time Period**
145 **** **Gregorian Time Period**
146 **** //Date Time//
147 *** **Reporting Time Period**
148 ** //Time Range//
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.
151
152 === 4.2.2 Observational Time Period ===
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.
155
156 === 4.2.3 Standard Time Period ===
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).
159
160 === 4.2.4 Gregorian Time Period ===
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:
163
164 **Gregorian Year:**
165 Representation: xs:gYear (YYYY)
166 Period: the start of January 1 to the end of December 31
167 **Gregorian Year Month**:
168 Representation: xs:gYearMonth (YYYY-MM)
169 Period: the start of the first day of the month to end of the last day of the month
170 **Gregorian Day**:
171 Representation: xs:date (YYYY-MM-DD)
172 Period: the start of the day (00:00:00) to the end of the day (23:59:59)
173
174 === 4.2.5 Date Time ===
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.
177
178 Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss){{footnote}}The seconds can be reported fractionally{{/footnote}}
179
180 === 4.2.6 Standard Reporting Period ===
181
182 Standard reporting periods are periods of time in relation to a reporting year. Each of these standard reporting periods has a duration (based on the ISO 8601 definition) associated with it. The general format of a reporting period is as follows:
183
184 [REPORTING_YEAR]-[PERIOD_INDICATOR][PERIOD_VALUE]
185
186 Where:
187
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 PERIOD_VALUE indicates the actual period within the year
190
191 The following section details each of the standard reporting periods defined in SDMX:
192
193 **Reporting Year**:
194 Period Indicator: A
195 Period Duration: P1Y (one year)
196 Limit per year: 1
197 Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1)
198 **Reporting Semester:**
199 Period Indicator: S
200 Period Duration: P6M (six months)
201 Limit per year: 2
202 Representation: common:ReportingSemesterType (YYYY-Ss, e.g. 2000-S2)
203 **Reporting Trimester:**
204 Period Indicator: T
205 Period Duration: P4M (four months)
206 Limit per year: 3
207 Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3)
208 **Reporting Quarter:**
209 Period Indicator: Q
210 Period Duration: P3M (three months)
211 Limit per year: 4
212 Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4)
213 **Reporting Month**:
214 Period Indicator: M
215 Period Duration: P1M (one month)
216 Limit per year: 1
217 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.
218 **Reporting Week**:
219 Period Indicator: W
220 Period Duration: P7D (seven days)
221 Limit per year: 53
222 Representation: 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.
225 **Reporting Day**:
226 Period Indicator: D
227 Period Duration: P1D (one day)
228 Limit per year: 366
229 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.
230 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.
231
232 A specialized attribute (reporting year start day) exists for the purpose of communicating the reporting year start day. This attribute has a fixed identifier (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.
233
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]):
235
236 **~1. Determine [REPORTING_YEAR_BASE]:**
237 Combine [REPORTING_YEAR] of the reporting period value (YYYY) with [REPORTING_YEAR_START_DAY] (MM-DD) to get a date (YYYY-MM-DD).
238 This is the [REPORTING_YEAR_START_DATE]
239
240 1.
241 11. **If the [PERIOD_INDICATOR] is W:**
242 111. **If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday:**
243
244 Add[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink 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].
245
246 1.
247 11.
248 111. **If [REPORTING_YEAR_START_DATE] is a Monday, Tuesday, Wednesday, or Thursday:**
249
250 Add^^4^^ (P0D, -P1D, -P2D, or -P3D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE].
251
252 1.
253 11. **Else:**
254
255 The [REPORTING_YEAR_START_DATE] is the [REPORTING_YEAR_BASE].
256
257 **2. Determine [PERIOD_DURATION]:**
258
259 1. If the [PERIOD_INDICATOR] is A, the [PERIOD_DURATION] is P1Y.
260 1. If the [PERIOD_INDICATOR] is S, the [PERIOD_DURATION] is P6M.
261 1. If the [PERIOD_INDICATOR] is T, the [PERIOD_DURATION] is P4M.
262 1. If the [PERIOD_INDICATOR] is Q, the [PERIOD_DURATION] is P3M.
263 1. If the [PERIOD_INDICATOR] is M, the [PERIOD_DURATION] is P1M.
264 1. If the [PERIOD_INDICATOR] is W, the [PERIOD_DURATION] is P7D.
265 1. If the [PERIOD_INDICATOR] is D, the [PERIOD_DURATION] is P1D.
266 1. **Determine [PERIOD_START]:**
267
268 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].
269
270 1. **Determine the [PERIOD_END]:**
271
272 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].
273
274 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).
275
276 **Examples:**
277
278 **2010-Q2, REPORTING_YEAR_START_DAY = ~-~-07-01 (July 1)**
279
280 1. [REPORTING_YEAR_START_DATE] = 2010-07-01
281
282 b) [REPORTING_YEAR_BASE] = 2010-07-01
283
284 1. [PERIOD_DURATION] = P3M 3. (2-1) * P3M = P3M
285
286 2010-07-01 + P3M = 2010-10-01
287
288 [PERIOD_START] = 2010-10-01
289
290 4. 2 * P3M = P6M
291
292 2010-07-01 + P6M = 2010-13-01 = 2011-01-01
293
294 2011-01-01 + -P1D = 2010-12-31
295
296 [PERIOD_END] = 2010-12-31
297
298 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
299
300 **2011-W36, REPORTING_YEAR_START_DAY = ~-~-07-01 (July 1)**
301
302 1. [REPORTING_YEAR_START_DATE] = 2010-07-01
303
304 a) 2011-07-01 = Friday
305
306 2011-07-01 + P3D = 2011-07-04
307
308 [REPORTING_YEAR_BASE] = 2011-07-04
309
310 1. [PERIOD_DURATION] = P7D 3. (36-1) * P7D = P245D
311
312 2011-07-04 + P245D = 2012-03-05
313
314 [PERIOD_START] = 2012-03-05
315
316 4. 36 * P7D = P252D
317
318 2011-07-04 + P252D =2012-03-12
319
320 2012-03-12 + -P1D = 2012-03-11
321
322 [PERIOD_END] = 2012-03-11
323
324 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
325
326 === 4.2.7 Distinct Range ===
327
328 In the case that the reporting period does not fit into one of the prescribe periods above, a distinct time range can be used. The value of these ranges is based on the ISO 8601 time interval format of start/duration. Start can be expressed as either an ISO 8601 date or a date-time, and duration is expressed as an ISO 8601 duration. However, the duration can only be positive.
329
330 === 4.2.8 Time Format ===
331
332 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.
333
334 (% style="width:890.835px" %)
335 |(% style="width:95px" %)**Code**|(% style="width:793px" %)**Format**
336 |(% style="width:95px" %)OTP|(% style="width:793px" %)Observational Time Period: Superset of all SDMX time formats (Gregorian Time Period, Reporting Time Period, and Time Range)
337 |(% style="width:95px" %)STP|(% style="width:793px" %)Standard Time Period: Superset of Gregorian and Reporting Time Periods
338 |(% style="width:95px" %)GTP|(% style="width:793px" %)Superset of all Gregorian Time Periods and date-time
339 |(% style="width:95px" %)RTP|(% style="width:793px" %)Superset of all Reporting Time Periods
340 |(% style="width:95px" %)TR|(% style="width:793px" %)(((
341 Time Range: Start time and duration (YYYY-MM-DD(Thh:mm:ss)?/<duration>)
342 )))
343 |(% style="width:95px" %)GY|(% style="width:793px" %)Gregorian Year (YYYY)
344 |(% style="width:95px" %)GTM|(% style="width:793px" %)Gregorian Year Month (YYYY-MM)
345 |(% style="width:95px" %)GD|(% style="width:793px" %)Gregorian Day (YYYY-MM-DD)
346 |(% style="width:95px" %)DT|(% style="width:793px" %)Distinct Point: date-time (YYYY-MM-DDThh:mm:ss)
347 |(% style="width:95px" %)RY|(% style="width:793px" %)Reporting Year (YYYY-A1)
348 |(% style="width:95px" %)RS|(% style="width:793px" %)Reporting Semester (YYYY-Ss)
349 |(% style="width:95px" %)RT|(% style="width:793px" %)Reporting Trimester (YYYY-Tt)
350 |(% style="width:95px" %)RQ|(% style="width:793px" %)Reporting Quarter (YYYY-Qq)
351 |(% style="width:95px" %)RM|(% style="width:793px" %)Reporting Month (YYYY-Mmm)
352 |(% style="width:95px" %)RW|(% style="width:793px" %)Reporting Week (YYYY-Www)
353 |(% style="width:95px" %)RD|(% style="width:793px" %)Reporting Day (YYYY-Dddd)
354
355 (% class="wikigeneratedid" id="HTable1:SDMX-MLTimeFormatCodes" %)
356 **Table 1: SDMX-ML Time Format Codes**
357
358 === 4.2.9 Time Zones ===
359
360 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):
361
362 * Time Range (start date): 2006-06-05**-05:00**/P5D
363 * Time Range (start date-time): 2006-06-05T00:00:00**-05:00**/P5D
364 * Gregorian Year: 2006**-05:00**
365 * Gregorian Month: 2006-06**-05:00**
366 * Gregorian Day: 2006-06-05**-05:00**
367 * Distinct Point: 2006-06-05T00:00:00**-05:00**
368 * Reporting Year: 2006-A1**-05:00**
369 * Reporting Semester: 2006-S2**-05:00**
370 * Reporting Trimester: 2006-T2**-05:00**
371 * Reporting Quarter: 2006-Q3**-05:00**
372 * Reporting Month: 2006-M06**-05:00**
373 * Reporting Week: 2006-W23**-05:00**
374 * Reporting Day: 2006-D156**-05:00**
375 * Reporting Year Start Day: ~-~-07-01**-05:00**
376
377 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.
378
379 === 4.2.10 Representing Time Spans Elsewhere ===
380
381 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:
382
383 >(% style="font-size:18px" %) <Series REF_PERIODStartTime="2000-01-01T00:00:00" REF_PERIOD="P2M"/>
384
385 can now be represented with this:
386
387 >(% style="font-size:18px" %) <Series REF_PERIOD="2000-01-01T00:00:00/P2M"/>
388
389 === 4.2.11 Notes on Formats ===
390
391 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.
392
393 === 4.2.12 Effect on Time Ranges ===
394
395 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.
396
397 === 4.2.13 Time in Query Messages ===
398
399 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.
400
401 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.
402
403 (% style="width:770.835px" %)
404 |(% style="width:220px" %)**Operator**|(% style="width:548px" %)**Rule**
405 |(% style="width:220px" %)Greater Than|(% style="width:548px" %)Any data after the last moment of the period
406 |(% style="width:220px" %)Less Than|(% style="width:548px" %)Any data before the first moment of the period
407 |(% style="width:220px" %)Greater Than or Equal To|(% style="width:548px" %)Any data on or after the first moment of the period
408 |(% style="width:220px" %)Less Than or Equal To|(% style="width:548px" %)Any data on or before the last moment of the period
409 |(% 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
410
411 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.
412
413 **Examples:**
414
415 **Gregorian Period**
416 Query Parameter: Greater than 2010
417 Literal Interpretation: Any data where the start period occurs after 2010-1231T23:59:59.
418 Example Matches:
419
420 * 2011 or later
421 * 2011-01 or later
422 * 2011-01-01 or later
423 * 2011-01-01/P[Any Duration] or any later start date
424 * 2011-[Any reporting period] (any reporting year start day)
425 * 2010-S2 (reporting year start day ~-~-07-01 or later)
426 * 2010-T3 (reporting year start day ~-~-07-01 or later)
427 * 2010-Q3 or later (reporting year start day ~-~-07-01 or later)
428 * 2010-M07 or later (reporting year start day ~-~-07-01 or later)
429 * 2010-W28 or later (reporting year start day ~-~-07-01 or later)
430 * 2010-D185 or later (reporting year start day ~-~-07-01 or later)
431
432 **Reporting Period**
433 Query Parameter: Greater than or equal to 2010-Q3
434 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:
435
436 * 2011 or later
437 * 2010-07 or later
438 * 2010-07-01 or later
439 * 2010-07-01/P[Any Duration] or any later start date
440 * 2011-[Any reporting period] (any reporting year start day)
441 * 2010-S2 (any reporting year start day)
442 * 2010-T3 (any reporting year start day)
443 * 2010-Q3 or later (any reporting year start day)
444 * 2010-M07 or later (any reporting year start day)
445 * 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}}
446 * 2010-D182 or later (reporting year start day ~-~-01-01)
447 * 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}}
448 * 2010-D185 or later (reporting year start day ~-~-07-01)
449
450 == 4.3 Versioning ==
451
452 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".
453
454 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’.
455
456 === 4.3.1 Non-versioned artefacts ===
457
458 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’.
459
460 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.
461
462 === 4.3.2 Semantically versioned artefacts ===
463
464 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.
465
466 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.
467
468 The detailed rules for semantic versioning are listed in chapter 14 in the annex for “Semantic Versioning”. In short, they define:
469
470 Given a version number MAJOR.MINOR.PATCH (without EXTENSION), when making changes to that semantically versioned SDMX artefact, then one must increment the:
471
472 1. MAJOR version when backwards incompatible artefact changes are made,
473 1. MINOR version when artefact elements are added in a backwards compatible manner, or
474 1. PATCH version when backwards compatible artefact property changes are made.
475
476 When incrementing a version part, the right-hand side parts are 0-ed (reset to ‘0’).
477
478 Extensions can be added, changed or dropped.
479
480 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.
481
482 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.
483
484 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.
485
486 === 4.3.3 Legacy-versioned artefacts ===
487
488 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.
489
490 In order to make artefacts immutable or changes truly predictable, a move to the new semantic versioning syntax is required.
491
492 === 4.3.4 Dependency management and references ===
493
494 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:
495
496 * a fixed version of another artefact
497 * the **latest available** version of another artefact
498 * the **latest backward compatible** version of another artefact, or the **latest backward and forward** **compatible** version of another artefact.
499
500 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.
501
502 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.
503
504 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.
505
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, 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.
507
508 The detailed rules for dependency management and references are listed in chapter 14 in the annex for “Semantic Versioning”.
509
510 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:
511
512 * Artefact queries for a **specific** version (X.Y, X.Y.Z or X.Y.Z-EXT).
513 * Artefact queries for **latest available** semantic versions within the wildcard scope (X+.Y.Z, X.Y+.Z or X.Y.Z+).
514 * Queries for **non-versioned** artefacts.
515 * 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.
516
517 The combination of wildcarded queries with a specific version extension is not permitted.
518
519 Full details can be found in the SDMX RESTful web services specification.
520
521 == 4.4 Structural Metadata Querying Best Practices ==
522
523 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.
524
525 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.
526
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 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.
528
529 ----
530
531 {{putFootnotes/}}