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
-
... ... @@ -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**"[[(% class="wikiinternallink wikiinternallink" %)^^~[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 === ... ... @@ -182,11 +182,12 @@ 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 184 **Gregorian Year:** 185 - 186 186 Representation: xs:gYear (YYYY) 187 -Period: the start of January 1 to the end of December 31 **Gregorian Year Month**: 166 +Period: the start of January 1 to the end of December 31 167 +**Gregorian Year Month**: 188 188 Representation: xs:gYearMonth (YYYY-MM) 189 -Period: the start of the first day of the month to end of the last day of the month **Gregorian Day**: 169 +Period: the start of the first day of the month to end of the last day of the month 170 +**Gregorian Day**: 190 190 Representation: xs:date (YYYY-MM-DD) 191 191 Period: the start of the day (00:00:00) to the end of the day (23:59:59) 192 192 ... ... @@ -194,7 +194,7 @@ 194 194 195 195 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. 196 196 197 -Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss) [[(% class="wikiinternallinkwikiinternallink" %)^^~[2~]^^>>path:#_ftn2]]178 +Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss){{footnote}}The seconds can be reported fractionally{{/footnote}} 198 198 199 199 === 4.2.6 Standard Reporting Period === 200 200 ... ... @@ -210,85 +210,50 @@ 210 210 The following section details each of the standard reporting periods defined in SDMX: 211 211 212 212 **Reporting Year**: 213 - 214 - Period Indicator: A 215 - 194 +Period Indicator: A 216 216 Period Duration: P1Y (one year) 217 - 218 218 Limit per year: 1 219 - 220 -Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1) **Reporting Semester:** 221 - 222 - Period Indicator: S 223 - 197 +Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1) 198 +**Reporting Semester:** 199 +Period Indicator: S 224 224 Period Duration: P6M (six months) 225 - 226 226 Limit per year: 2 227 - 228 228 Representation: common:ReportingSemesterType (YYYY-Ss, e.g. 2000-S2) 229 - 230 230 **Reporting Trimester:** 231 - 232 - Period Indicator: T 233 - 204 +Period Indicator: T 234 234 Period Duration: P4M (four months) 235 - 236 236 Limit per year: 3 237 - 238 -Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3) **Reporting Quarter:** 239 - 240 - Period Indicator: Q 241 - 207 +Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3) 208 +**Reporting Quarter:** 209 +Period Indicator: Q 242 242 Period Duration: P3M (three months) 243 - 244 244 Limit per year: 4 245 - 246 -Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4) **Reporting Month**: 247 - 212 +Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4) 213 +**Reporting Month**: 248 248 Period Indicator: M 249 - 250 250 Period Duration: P1M (one month) 251 - 252 252 Limit per year: 1 253 - 254 254 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. 255 - 256 256 **Reporting Week**: 257 - 258 258 Period Indicator: W 259 - 260 260 Period Duration: P7D (seven days) 261 - 262 262 Limit per year: 53 263 - 264 264 Representation: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53) 265 - 266 -Notes: There are either 52 or 53 weeks in a reporting year. This is based on the ISO 8601 definition of a week (Monday - Saturday), where the first week of a reporting year is defined as the week with the first Thursday on or after the reporting year start day.[[(% class="wikiinternallink wikiinternallink" %)^^~[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. 267 - 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. 268 268 **Reporting Day**: 269 - 270 270 Period Indicator: D 271 - 272 272 Period Duration: P1D (one day) 273 - 274 274 Limit per year: 366 275 - 276 276 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. 277 - 278 278 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. 279 279 280 -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. 281 281 282 - (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]): 283 283 284 -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]- 285 - 286 -[PERIOD_INDICATOR][PERIOD_VALUE] and the reporting year start day as [REPORTING_YEAR_START_DAY]): 287 - 288 -1. **Determine [REPORTING_YEAR_BASE]:** 289 - 236 +**~1. Determine [REPORTING_YEAR_BASE]:** 290 290 Combine [REPORTING_YEAR] of the reporting period value (YYYY) with [REPORTING_YEAR_START_DAY] (MM-DD) to get a date (YYYY-MM-DD). 291 - 292 292 This is the [REPORTING_YEAR_START_DATE] 293 293 294 294 1. ... ... @@ -295,7 +295,7 @@ 295 295 11. **If the [PERIOD_INDICATOR] is W:** 296 296 111. **If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday:** 297 297 298 -Add[[(% class="wikiinternallink wikiinternallink" %)^^~[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" %)^^~[4~]^^>>path:#_ftn4]](%%) (P3D, P2D, or P1D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE]. 299 299 300 300 1. 301 301 11. ... ... @@ -596,4 +596,5 @@ 596 596 597 597 [[~[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. 598 598 599 - 545 + 546 +{{putFootnotes/}}