Changes for page 4 General Notes for Implementers
Last modified by Artur on 2025/09/10 11:19
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -10,26 +10,26 @@ 10 10 11 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 12 13 -|SDMX-ML Data Type|XML Schema Data Type|.NET Framework Type|((( 14 -Java Data Type 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 15 ))) 16 -| **String**|**xsd:string**|**System.String**|**java.lang.String**17 -| **Big Integer**|**xsd:integer**|**System.Decimal**|**java.math.BigInteger**18 -| **Integer**|**xsd:int**|**System.Int32**|**int**19 -| **Long**|**xsd.long**|**System.Int64**|**long**20 -| **Short**|**xsd:short**|**System.Int16**|**short**21 -| **Decimal**|**xsd:decimal**|**System.Decimal**|**java.math.BigDecimal**22 -| **Float**|**xsd:float**|**System.Single**|**float**23 -| **Double**|**xsd:double**|**System.Double**|**double**24 -| **Boolean**|**xsd:boolean**|**System.Boolean**|**boolean**25 -| **URI**|**xsd:anyURI**|**System.Uri**|**Java.net.URI or java.lang.String**26 -| **DateTime**|**xsd:dateTime**|**System.DateTime**|**javax.xml.datatype.XMLGregorianCalendar**27 -| **Time**|**xsd:time**|**System.DateTime**|**javax.xml.datatype.XMLGregorianCalendar**28 -| **GregorianYear**|**xsd:gYear**|**System.DateTime**|**javax.xml.datatype.XMLGregorianCalendar**29 -| **GregorianMonth**|**xsd:gYearMonth**|**System.DateTime**|**javax.xml.datatype.XMLGregorianCalendar**30 -| **GregorianDay**|**xsd:date**|**System.DateTime**|**javax.xml.datatype.XMLGregorianCalendar**31 -| **Day, MonthDay, Month**|**xsd:g***|**System.DateTime**|**javax.xml.datatype.XMLGregorianCalendar**32 -| **Duration**|**xsd:duration**|**System.TimeSpan**|**javax.xml.datatype.Duration**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 33 34 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 35 ... ... @@ -76,7 +76,7 @@ 76 76 77 77 Note that code lists may also have textual representations assigned to them, in addition to their enumeration of codes. 78 78 79 -4.1.1 Data Types 79 +=== 4.1.1 Data Types === 80 80 81 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 82 ... ... @@ -95,8 +95,8 @@ 95 95 The above looks like this, in JSON schema: 96 96 97 97 > "idType": { 98 -> "type": "string", 99 -> "pattern": "^[A-Za-z0-9_@$-]+$" 98 +> "type": "string", 99 +> "pattern": "^[A-Za-z0-9_@$-]+$" 100 100 > } 101 101 102 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,57 +103,35 @@ 103 103 104 104 Further to the above, the mapping between the non-native data types is presented in the table below: 105 105 106 -|**SDMX Facet**|**XML Schema**|**JSON schema **"**pattern**"[[^^~[1~]^^>>path:#_ftn1]] **for "string" type** 107 -|GregorianYear|xsd:gYear|((( 108 -"^-?([1-9][0-9]{3,}|0[0-9]{3})(Z|(\+|-)((0[0- 109 - 110 -9]|1[0-3]):[0-5][0-9]|14:00))?$" 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))?$" 111 111 ))) 112 -|GregorianMonth|xsd:gYearMonth|((( 113 -"^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0- 114 - 115 -2])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0- 116 - 117 -9]|14:00))?$" 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))?$" 118 118 ))) 119 -|GregorianDay|xsd:date|((( 120 -"^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])- 121 - 122 -(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0- 123 - 124 -3]):[0-5][0-9]|14:00))?$" 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))?$" 125 125 ))) 126 -|Day|xsd:gDay|((( 127 -"^~-~--(0[1-9]|[12][0-9]|3[01])(Z|(\+|- 128 - 129 -)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$" 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))?$" 130 130 ))) 131 -|MonthDay|xsd:gMonthDay|((( 132 -"^~-~-(0[1-9]|1[0-2])-(0[1-9]|[12][0- 133 - 134 -9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0- 135 - 136 -9]|14:00))?$" 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))?$" 137 137 ))) 138 -|Month|xsd:Month|((( 139 -"^~-~-(0[1-9]|1[0-2])(Z|(\+|-)((0[0-9]|1[0- 140 - 141 -3]):[0-5][0-9]|14:00))?$" 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))?$" 142 142 ))) 143 -|Duration|xsd:duration|((( 144 -"^-?P[0-9]+Y?([0-9]+M)?([0-9]+D)?(T([0- 145 - 146 -9]+H)?([0-9]+M)?([0-9]+(\.[0-9]+)?S)?)?$" 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)?)?$" 147 147 ))) 148 148 149 -1. 150 -11. Time and Time Format 130 +== 4.2 Time and Time Format == 151 151 152 152 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. 153 153 154 -1. 155 -11. 156 -111. Introduction 134 +=== 4.2.1 Introduction === 157 157 158 158 First, it is important to recognize that most observation times are a period. SDMX specifies precisely how Time is handled. 159 159 ... ... @@ -161,61 +161,45 @@ 161 161 162 162 The hierarchy of time formats is as follows (**bold** indicates a category which is made up of multiple formats, //italic// indicates a distinct format): 163 163 164 -* **Observational Time Period **o **Standard Time Period** 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// 165 165 166 - § **Basic Time Period** 167 - 168 -* **Gregorian Time Period** 169 -* //Date Time// 170 - 171 -§ **Reporting Time Period **o //Time Range// 172 - 173 173 The details of these time period categories and of the distinct formats which make them up are detailed in the sections to follow. 174 174 175 -1. 176 -11. 177 -111. Observational Time Period 152 +=== 4.2.2 Observational Time Period === 178 178 179 179 This is the superset of all time representations in SDMX. This allows for time to be expressed as any of the allowable formats. 180 180 181 -1. 182 -11. 183 -111. Standard Time Period 156 +=== 4.2.3 Standard Time Period === 184 184 185 185 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). 186 186 187 -1. 188 -11. 189 -111. Gregorian Time Period 160 +=== 4.2.4 Gregorian Time Period === 190 190 191 191 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: 192 192 193 - 194 194 **Gregorian Year:** 195 - 196 196 Representation: xs:gYear (YYYY) 197 - 198 -Period: the start of January 1 to the end of December 31 **Gregorian Year Month**: 199 - 166 +Period: the start of January 1 to the end of December 31 167 +**Gregorian Year Month**: 200 200 Representation: xs:gYearMonth (YYYY-MM) 201 - 202 -Period: the start of the first day of the month to end of the last day of the month **Gregorian Day**: 203 - 169 +Period: the start of the first day of the month to end of the last day of the month 170 +**Gregorian Day**: 204 204 Representation: xs:date (YYYY-MM-DD) 205 - 206 206 Period: the start of the day (00:00:00) to the end of the day (23:59:59) 207 207 208 -1. 209 -11. 210 -111. Date Time 174 +=== 4.2.5 Date Time === 211 211 212 212 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. 213 213 214 -Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss) [[^^~[2~]^^>>path:#_ftn2]]178 +Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss){{footnote}}The seconds can be reported fractionally{{/footnote}} 215 215 216 -1. 217 -11. 218 -111. Standard Reporting Period 180 +=== 4.2.6 Standard Reporting Period === 219 219 220 220 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: 221 221 ... ... @@ -224,83 +224,51 @@ 224 224 Where: 225 225 226 226 REPORTING_YEAR represents the reporting year as four digits (YYYY) PERIOD_INDICATOR identifies the type of period which determines the duration of the period 227 - 228 228 PERIOD_VALUE indicates the actual period within the year 229 229 230 230 The following section details each of the standard reporting periods defined in SDMX: 231 231 232 232 **Reporting Year**: 233 - 234 - Period Indicator: A 235 - 194 +Period Indicator: A 236 236 Period Duration: P1Y (one year) 237 - 238 238 Limit per year: 1 239 - 240 -Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1) **Reporting Semester:** 241 - 242 - Period Indicator: S 243 - 197 +Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1) 198 +**Reporting Semester:** 199 +Period Indicator: S 244 244 Period Duration: P6M (six months) 245 - 246 246 Limit per year: 2 247 - 248 248 Representation: common:ReportingSemesterType (YYYY-Ss, e.g. 2000-S2) 249 - 250 250 **Reporting Trimester:** 251 - 252 - Period Indicator: T 253 - 204 +Period Indicator: T 254 254 Period Duration: P4M (four months) 255 - 256 256 Limit per year: 3 257 - 258 -Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3) **Reporting Quarter:** 259 - 260 - Period Indicator: Q 261 - 207 +Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3) 208 +**Reporting Quarter:** 209 +Period Indicator: Q 262 262 Period Duration: P3M (three months) 263 - 264 264 Limit per year: 4 265 - 266 -Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4) **Reporting Month**: 267 - 212 +Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4) 213 +**Reporting Month**: 268 268 Period Indicator: M 269 - 270 270 Period Duration: P1M (one month) 271 - 272 272 Limit per year: 1 273 - 274 274 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. 275 - 276 276 **Reporting Week**: 277 - 278 278 Period Indicator: W 279 - 280 280 Period Duration: P7D (seven days) 281 - 282 282 Limit per year: 53 283 - 284 284 Representation: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53) 285 - 286 -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.[[^^~[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. 287 - 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. 288 288 **Reporting Day**: 289 - 290 290 Period Indicator: D 291 - 292 292 Period Duration: P1D (one day) 293 - 294 294 Limit per year: 366 295 - 296 296 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. 297 - 298 298 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. 299 299 300 -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 (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. 301 301 302 -(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. 303 - 304 304 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]- 305 305 306 306 [PERIOD_INDICATOR][PERIOD_VALUE] and the reporting year start day as [REPORTING_YEAR_START_DAY]): ... ... @@ -315,7 +315,7 @@ 315 315 11. **If the [PERIOD_INDICATOR] is W:** 316 316 111. **If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday:** 317 317 318 -Add[[^^~[4~]^^>>path:#_ftn4]] (P3D, P2D, or P1D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE]. 248 +Add[[(% class="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]. 319 319 320 320 1. 321 321 11. ... ... @@ -396,45 +396,38 @@ 396 396 397 397 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 398 398 399 -1. 400 -11. 401 -111. Distinct Range 329 +=== 4.2.7 Distinct Range === 402 402 403 403 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. 404 404 405 -1. 406 -11. 407 -111. Time Format 333 +=== 4.2.8 Time Format === 408 408 409 409 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. 410 410 411 -|Code|Format 412 -|OTP|Observational Time Period: Superset of all SDMX time formats (Gregorian Time Period, Reporting Time Period, and Time Range) 413 -|STP|Standard Time Period: Superset of Gregorian and Reporting Time Periods 414 -|GTP|Superset of all Gregorian Time Periods and date-time 415 -|RTP|Superset of all Reporting Time Periods 416 -|TR|((( 417 -Time Range: Start time and duration (YYYY-MM- 418 - 419 -DD(Thh:mm:ss)?/<duration>) 337 +|(% style="width:95px" %)Code|(% style="width:1520px" %)Format 338 +|(% 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) 339 +|(% style="width:95px" %)STP|(% style="width:1520px" %)Standard Time Period: Superset of Gregorian and Reporting Time Periods 340 +|(% style="width:95px" %)GTP|(% style="width:1520px" %)Superset of all Gregorian Time Periods and date-time 341 +|(% style="width:95px" %)RTP|(% style="width:1520px" %)Superset of all Reporting Time Periods 342 +|(% style="width:95px" %)TR|(% style="width:1520px" %)((( 343 +Time Range: Start time and duration (YYYY-MM-DD(Thh:mm:ss)?/<duration>) 420 420 ))) 421 -|GY|Gregorian Year (YYYY) 422 -|GTM|Gregorian Year Month (YYYY-MM) 423 -|GD|Gregorian Day (YYYY-MM-DD) 424 -|DT|Distinct Point: date-time (YYYY-MM-DDThh:mm:ss) 425 -|RY|Reporting Year (YYYY-A1) 426 -|RS|Reporting Semester (YYYY-Ss) 427 -|RT|Reporting Trimester (YYYY-Tt) 428 -|RQ|Reporting Quarter (YYYY-Qq) 429 -|RM|Reporting Month (YYYY-Mmm) 430 -|RW|Reporting Week (YYYY-Www) 431 -|RD|Reporting Day (YYYY-Dddd) 345 +|(% style="width:95px" %)GY|(% style="width:1520px" %)Gregorian Year (YYYY) 346 +|(% style="width:95px" %)GTM|(% style="width:1520px" %)Gregorian Year Month (YYYY-MM) 347 +|(% style="width:95px" %)GD|(% style="width:1520px" %)Gregorian Day (YYYY-MM-DD) 348 +|(% style="width:95px" %)DT|(% style="width:1520px" %)Distinct Point: date-time (YYYY-MM-DDThh:mm:ss) 349 +|(% style="width:95px" %)RY|(% style="width:1520px" %)Reporting Year (YYYY-A1) 350 +|(% style="width:95px" %)RS|(% style="width:1520px" %)Reporting Semester (YYYY-Ss) 351 +|(% style="width:95px" %)RT|(% style="width:1520px" %)Reporting Trimester (YYYY-Tt) 352 +|(% style="width:95px" %)RQ|(% style="width:1520px" %)Reporting Quarter (YYYY-Qq) 353 +|(% style="width:95px" %)RM|(% style="width:1520px" %)Reporting Month (YYYY-Mmm) 354 +|(% style="width:95px" %)RW|(% style="width:1520px" %)Reporting Week (YYYY-Www) 355 +|(% style="width:95px" %)RD|(% style="width:1520px" %)Reporting Day (YYYY-Dddd) 432 432 433 -==== Table 1: SDMX-ML Time Format Codes ==== 357 +(% class="wikigeneratedid" id="HTable1:SDMX-MLTimeFormatCodes" %) 358 +**Table 1: SDMX-ML Time Format Codes** 434 434 435 -1. 436 -11. 437 -111. Time Zones 360 +=== 4.2.9 Time Zones === 438 438 439 439 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): 440 440 ... ... @@ -455,33 +455,25 @@ 455 455 456 456 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. 457 457 458 -1. 459 -11. 460 -111. Representing Time Spans Elsewhere 381 +=== 4.2.10 Representing Time Spans Elsewhere === 461 461 462 462 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: 463 463 464 -<Series REF_PERIODStartTime="2000-01-01T00:00:00" REF_PERIOD="P2M"/> 385 +>(% style="font-size:18px" %) <Series REF_PERIODStartTime="2000-01-01T00:00:00" REF_PERIOD="P2M"/> 465 465 466 466 can now be represented with this: 467 467 468 -<Series REF_PERIOD="2000-01-01T00:00:00/P2M"/> 389 +>(% style="font-size:18px" %) <Series REF_PERIOD="2000-01-01T00:00:00/P2M"/> 469 469 470 -1. 471 -11. 472 -111. Notes on Formats 391 +=== 4.2.11 Notes on Formats === 473 473 474 474 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. 475 475 476 -1. 477 -11. 478 -111. Effect on Time Ranges 395 +=== 4.2.12 Effect on Time Ranges === 479 479 480 480 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. 481 481 482 -1. 483 -11. 484 -111. Time in Query Messages 399 +=== 4.2.13 Time in Query Messages === 485 485 486 486 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. 487 487 ... ... @@ -535,9 +535,11 @@ 535 535 * 2010-M07 or later (any reporting year start day) 536 536 * 2010-W27 or later (reporting year start day ~-~-01-01)^^5^^ 537 537 * 2010-D182 or later (reporting year start day ~-~-01-01) 538 -* 2010-W28 or later (reporting year start day ~-~-07-01)^^6^^ • 2010-D185 or later (reporting year start day ~-~-07-01)539 -*1 .Versioning453 +* 2010-W28 or later (reporting year start day ~-~-07-01)^^6^^ 454 +* 2010-D185 or later (reporting year start day ~-~-07-01) 540 540 456 +== 4.3 Versioning == 457 + 541 541 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". 542 542 543 543 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 ... ... @@ -546,17 +546,13 @@ 546 546 547 547 ‘1.0’. 548 548 549 -1. 550 -11. 551 -111. Non-versioned artefacts 466 +=== 4.3.1 Non-versioned artefacts === 552 552 553 553 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’. 554 554 555 555 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. 556 556 557 -1. 558 -11. 559 -111. Semantically versioned artefacts 472 +=== 4.3.2 Semantically versioned artefacts === 560 560 561 561 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. 562 562 ... ... @@ -580,17 +580,13 @@ 580 580 581 581 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. 582 582 583 -1. 584 -11. 585 -111. Legacy-versioned artefacts 496 +=== 4.3.3 Legacy-versioned artefacts === 586 586 587 587 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. 588 588 589 589 In order to make artefacts immutable or changes truly predictable, a move to the new semantic versioning syntax is required. 590 590 591 -1. 592 -11. 593 -111. Dependency management and references 502 +=== 4.3.4 Dependency management and references === 594 594 595 595 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: 596 596 ... ... @@ -619,8 +619,7 @@ 619 619 620 620 Full details can be found in the SDMX RESTful web services specification. 621 621 622 -1. 623 -11. Structural Metadata Querying Best Practices 531 +== 4.4 Structural Metadata Querying Best Practices == 624 624 625 625 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. 626 626 ... ... @@ -628,7 +628,6 @@ 628 628 629 629 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. 630 630 631 - 632 632 ---- 633 633 634 634 [[~[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/]] ... ... @@ -639,4 +639,5 @@ 639 639 640 640 [[~[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. 641 641 642 - 549 + 550 +{{putFootnotes/}}