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,47 +103,28 @@ 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 149 == 4.2 Time and Time Format == ... ... @@ -158,15 +158,14 @@ 158 158 159 159 The hierarchy of time formats is as follows (**bold** indicates a category which is made up of multiple formats, //italic// indicates a distinct format): 160 160 161 -* **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// 162 162 163 - § **Basic Time Period** 164 - 165 -* **Gregorian Time Period** 166 -* //Date Time// 167 - 168 -§ **Reporting Time Period **o //Time Range// 169 - 170 170 The details of these time period categories and of the distinct formats which make them up are detailed in the sections to follow. 171 171 172 172 === 4.2.2 Observational Time Period === ... ... @@ -181,32 +181,23 @@ 181 181 182 182 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: 183 183 184 - 185 185 **Gregorian Year:** 186 - 187 187 Representation: xs:gYear (YYYY) 188 - 189 -Period: the start of January 1 to the end of December 31 **Gregorian Year Month**: 190 - 166 +Period: the start of January 1 to the end of December 31 167 +**Gregorian Year Month**: 191 191 Representation: xs:gYearMonth (YYYY-MM) 192 - 193 -Period: the start of the first day of the month to end of the last day of the month **Gregorian Day**: 194 - 169 +Period: the start of the first day of the month to end of the last day of the month 170 +**Gregorian Day**: 195 195 Representation: xs:date (YYYY-MM-DD) 196 - 197 197 Period: the start of the day (00:00:00) to the end of the day (23:59:59) 198 198 199 -1. 200 -11. 201 -111. Date Time 174 +=== 4.2.5 Date Time === 202 202 203 203 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. 204 204 205 -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}} 206 206 207 -1. 208 -11. 209 -111. Standard Reporting Period 180 +=== 4.2.6 Standard Reporting Period === 210 210 211 211 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: 212 212 ... ... @@ -215,91 +215,55 @@ 215 215 Where: 216 216 217 217 REPORTING_YEAR represents the reporting year as four digits (YYYY) PERIOD_INDICATOR identifies the type of period which determines the duration of the period 218 - 219 219 PERIOD_VALUE indicates the actual period within the year 220 220 221 221 The following section details each of the standard reporting periods defined in SDMX: 222 222 223 223 **Reporting Year**: 224 - 225 - Period Indicator: A 226 - 194 +Period Indicator: A 227 227 Period Duration: P1Y (one year) 228 - 229 229 Limit per year: 1 230 - 231 -Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1) **Reporting Semester:** 232 - 233 - Period Indicator: S 234 - 197 +Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1) 198 +**Reporting Semester:** 199 +Period Indicator: S 235 235 Period Duration: P6M (six months) 236 - 237 237 Limit per year: 2 238 - 239 239 Representation: common:ReportingSemesterType (YYYY-Ss, e.g. 2000-S2) 240 - 241 241 **Reporting Trimester:** 242 - 243 - Period Indicator: T 244 - 204 +Period Indicator: T 245 245 Period Duration: P4M (four months) 246 - 247 247 Limit per year: 3 248 - 249 -Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3) **Reporting Quarter:** 250 - 251 - Period Indicator: Q 252 - 207 +Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3) 208 +**Reporting Quarter:** 209 +Period Indicator: Q 253 253 Period Duration: P3M (three months) 254 - 255 255 Limit per year: 4 256 - 257 -Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4) **Reporting Month**: 258 - 212 +Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4) 213 +**Reporting Month**: 259 259 Period Indicator: M 260 - 261 261 Period Duration: P1M (one month) 262 - 263 263 Limit per year: 1 264 - 265 265 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. 266 - 267 267 **Reporting Week**: 268 - 269 269 Period Indicator: W 270 - 271 271 Period Duration: P7D (seven days) 272 - 273 273 Limit per year: 53 274 - 275 275 Representation: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53) 276 - 277 -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. 278 - 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. 279 279 **Reporting Day**: 280 - 281 281 Period Indicator: D 282 - 283 283 Period Duration: P1D (one day) 284 - 285 285 Limit per year: 366 286 - 287 287 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. 288 - 289 289 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. 290 290 291 -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. 292 292 293 - (REPORTING_YEAR_START_DAY) anda fixedrepresentation(xs:gMonthDay)sothatit canalways beeasilyidentifiedand processedin adatamessage.Althoughthisattributeexistsinspecializedsub-class, itfunctionsthesame asany other attributeoutsideofits identificationandrepresentation.It must takesits identityfromaconcept andstateitsrelationship withothercomponents of thedata structuredefinition. The abilitytostatethisrelationshipallowsthisreportingyearstart day attribute toexistattheappropriate levelsofadata message.In theabsence ofthisattribute, the reporting yearstart dateis assumed tobeJanuary1;thereforeif thereporting yearcoincideswiththecalendaryear,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]): 294 294 295 -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]- 296 - 297 -[PERIOD_INDICATOR][PERIOD_VALUE] and the reporting year start day as [REPORTING_YEAR_START_DAY]): 298 - 299 -1. **Determine [REPORTING_YEAR_BASE]:** 300 - 236 +**~1. Determine [REPORTING_YEAR_BASE]:** 301 301 Combine [REPORTING_YEAR] of the reporting period value (YYYY) with [REPORTING_YEAR_START_DAY] (MM-DD) to get a date (YYYY-MM-DD). 302 - 303 303 This is the [REPORTING_YEAR_START_DATE] 304 304 305 305 1. ... ... @@ -306,7 +306,7 @@ 306 306 11. **If the [PERIOD_INDICATOR] is W:** 307 307 111. **If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday:** 308 308 309 -Add[[^^~[4~]^^>>path:#_ftn4]] (P3D, P2D, or P1D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE]. 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]. 310 310 311 311 1. 312 312 11. ... ... @@ -319,17 +319,18 @@ 319 319 320 320 The [REPORTING_YEAR_START_DATE] is the [REPORTING_YEAR_BASE]. 321 321 322 -1. **Determine [PERIOD_DURATION]:** 323 -11. If the [PERIOD_INDICATOR] is A, the [PERIOD_DURATION] is P1Y. 324 -11. If the [PERIOD_INDICATOR] is S, the [PERIOD_DURATION] is P6M. 325 -11. If the [PERIOD_INDICATOR] is T, the [PERIOD_DURATION] is P4M. 326 -11. If the [PERIOD_INDICATOR] is Q, the [PERIOD_DURATION] is P3M. 327 -11. If the [PERIOD_INDICATOR] is M, the [PERIOD_DURATION] is P1M. 328 -11. If the [PERIOD_INDICATOR] is W, the [PERIOD_DURATION] is P7D. 329 -11. If the [PERIOD_INDICATOR] is D, the [PERIOD_DURATION] is P1D. 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. 330 330 1. **Determine [PERIOD_START]:** 331 331 332 -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].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]. 333 333 334 334 1. **Determine the [PERIOD_END]:** 335 335 ... ... @@ -387,45 +387,39 @@ 387 387 388 388 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 389 389 390 -1. 391 -11. 392 -111. Distinct Range 326 +=== 4.2.7 Distinct Range === 393 393 394 394 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. 395 395 396 -1. 397 -11. 398 -111. Time Format 330 +=== 4.2.8 Time Format === 399 399 400 400 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. 401 401 402 -|Code|Format 403 -|OTP|Observational Time Period: Superset of all SDMX time formats (Gregorian Time Period, Reporting Time Period, and Time Range) 404 -|STP|Standard Time Period: Superset of Gregorian and Reporting Time Periods 405 -|GTP|Superset of all Gregorian Time Periods and date-time 406 -|RTP|Superset of all Reporting Time Periods 407 -|TR|((( 408 -Time Range: Start time and duration (YYYY-MM- 409 - 410 -DD(Thh:mm:ss)?/<duration>) 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>) 411 411 ))) 412 -|GY|Gregorian Year (YYYY) 413 -|GTM|Gregorian Year Month (YYYY-MM) 414 -|GD|Gregorian Day (YYYY-MM-DD) 415 -|DT|Distinct Point: date-time (YYYY-MM-DDThh:mm:ss) 416 -|RY|Reporting Year (YYYY-A1) 417 -|RS|Reporting Semester (YYYY-Ss) 418 -|RT|Reporting Trimester (YYYY-Tt) 419 -|RQ|Reporting Quarter (YYYY-Qq) 420 -|RM|Reporting Month (YYYY-Mmm) 421 -|RW|Reporting Week (YYYY-Www) 422 -|RD|Reporting Day (YYYY-Dddd) 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) 423 423 424 -==== Table 1: SDMX-ML Time Format Codes ==== 355 +(% class="wikigeneratedid" id="HTable1:SDMX-MLTimeFormatCodes" %) 356 +**Table 1: SDMX-ML Time Format Codes** 425 425 426 -1. 427 -11. 428 -111. Time Zones 358 +=== 4.2.9 Time Zones === 429 429 430 430 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): 431 431 ... ... @@ -446,44 +446,37 @@ 446 446 447 447 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. 448 448 449 -1. 450 -11. 451 -111. Representing Time Spans Elsewhere 379 +=== 4.2.10 Representing Time Spans Elsewhere === 452 452 453 453 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: 454 454 455 -<Series REF_PERIODStartTime="2000-01-01T00:00:00" REF_PERIOD="P2M"/> 383 +>(% style="font-size:18px" %) <Series REF_PERIODStartTime="2000-01-01T00:00:00" REF_PERIOD="P2M"/> 456 456 457 457 can now be represented with this: 458 458 459 -<Series REF_PERIOD="2000-01-01T00:00:00/P2M"/> 387 +>(% style="font-size:18px" %) <Series REF_PERIOD="2000-01-01T00:00:00/P2M"/> 460 460 461 -1. 462 -11. 463 -111. Notes on Formats 389 +=== 4.2.11 Notes on Formats === 464 464 465 465 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. 466 466 467 -1. 468 -11. 469 -111. Effect on Time Ranges 393 +=== 4.2.12 Effect on Time Ranges === 470 470 471 471 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. 472 472 473 -1. 474 -11. 475 -111. Time in Query Messages 397 +=== 4.2.13 Time in Query Messages === 476 476 477 477 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. 478 478 479 479 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. 480 480 481 -|**Operator**|**Rule** 482 -|Greater Than|Any data after the last moment of the period 483 -|Less Than|Any data before the first moment of the period 484 -|Greater Than or Equal To|Any data on or after the first moment of the period 485 -|Less Than or Equal To|Any data on or before the last moment of the period 486 -|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 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 487 487 488 488 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. 489 489 ... ... @@ -490,11 +490,8 @@ 490 490 **Examples:** 491 491 492 492 **Gregorian Period** 493 - 494 494 Query Parameter: Greater than 2010 495 - 496 496 Literal Interpretation: Any data where the start period occurs after 2010-1231T23:59:59. 497 - 498 498 Example Matches: 499 499 500 500 * 2011 or later ... ... @@ -510,9 +510,7 @@ 510 510 * 2010-D185 or later (reporting year start day ~-~-07-01 or later) 511 511 512 512 **Reporting Period** 513 - 514 514 Query Parameter: Greater than or equal to 2010-Q3 515 - 516 516 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: 517 517 518 518 * 2011 or later ... ... @@ -524,30 +524,24 @@ 524 524 * 2010-T3 (any reporting year start day) 525 525 * 2010-Q3 or later (any reporting year start day) 526 526 * 2010-M07 or later (any reporting year start day) 527 -* 2010-W27 or later (reporting year start day ~-~-01-01) ^^5^^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}} 528 528 * 2010-D182 or later (reporting year start day ~-~-01-01) 529 -* 2010-W28 or later (reporting year start day ~-~-07-01) ^^6^^ •2010-D185orlater(reporting year start day~-~-07-01)530 -*1 .Versioning447 +* 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) 531 531 450 +== 4.3 Versioning == 451 + 532 532 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". 533 533 534 -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 from454 +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’. 535 535 536 - //MaintainableArtefact//.According to the legacyversioning, any artefactdefinedwithoutaversion is equivalentto following thelegacy versioning,thushaving version456 +=== 4.3.1 Non-versioned artefacts === 537 537 538 -‘1.0’. 539 - 540 -1. 541 -11. 542 -111. Non-versioned artefacts 543 - 544 544 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’. 545 545 546 546 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. 547 547 548 -1. 549 -11. 550 -111. Semantically versioned artefacts 462 +=== 4.3.2 Semantically versioned artefacts === 551 551 552 552 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. 553 553 ... ... @@ -571,17 +571,13 @@ 571 571 572 572 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. 573 573 574 -1. 575 -11. 576 -111. Legacy-versioned artefacts 486 +=== 4.3.3 Legacy-versioned artefacts === 577 577 578 578 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. 579 579 580 580 In order to make artefacts immutable or changes truly predictable, a move to the new semantic versioning syntax is required. 581 581 582 -1. 583 -11. 584 -111. Dependency management and references 492 +=== 4.3.4 Dependency management and references === 585 585 586 586 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: 587 587 ... ... @@ -610,8 +610,7 @@ 610 610 611 611 Full details can be found in the SDMX RESTful web services specification. 612 612 613 -1. 614 -11. Structural Metadata Querying Best Practices 521 +== 4.4 Structural Metadata Querying Best Practices == 615 615 616 616 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. 617 617 ... ... @@ -619,15 +619,6 @@ 619 619 620 620 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. 621 621 622 - 623 623 ---- 624 624 625 -[[~[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/]] 626 - 627 -[[~[2~]>>path:#_ftnref2]] The seconds can be reported fractionally 628 - 629 -[[~[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. 630 - 631 -[[~[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. 632 - 633 - 531 +{{putFootnotes/}}