Changes for page 4 General Notes for Implementers
Last modified by Helena on 2025/09/10 11:19
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -102,29 +102,27 @@ 102 102 103 103 Further to the above, the mapping between the non-native data types is presented in the table below: 104 104 105 -(% style="width:1 026.29px" %)106 -|(% style="width:159px" %)**SDMX Facet**|(% style="width:179px" %)**XML Schema**|(% style="width: 683px" %)**JSON schema **"**pattern**"{{footnote}}Regular expressions, as specified in W3C XML Schema Definition Language (XSD) 1.1 Part 2: Datatypes.{{/footnote}} **for "string" type**107 -|(% style="width:159px" %)GregorianYear|(% style="width:179px" %)xsd:gYear|(% style="width: 683px" %)(((105 +(% style="width:1146.29px" %) 106 +|(% style="width:159px" %)**SDMX Facet**|(% style="width:179px" %)**XML Schema**|(% style="width:800px" %)**JSON schema **"**pattern**"{{footnote}}Regular expressions, as specified in W3C XML Schema Definition Language (XSD) 1.1 Part 2: Datatypes.{{/footnote}} **for "string" type** 107 +|(% style="width:159px" %)GregorianYear|(% style="width:179px" %)xsd:gYear|(% style="width:800px" %)((( 108 108 "^-?( [1-9] [0-9] {3,}|0[0-9]{3}) (Z| (\ + | -) ((0 [0 - 9]| 1[0 - 3]):[0 - 5] [0 - 9] | 14:00))?$" 109 109 ))) 110 -|(% style="width:159px" %)GregorianMonth|(% style="width:179px" %)xsd:gYearMonth|(% style="width: 683px" %)(((110 +|(% style="width:159px" %)GregorianMonth|(% style="width:179px" %)xsd:gYearMonth|(% style="width:800px" %)((( 111 111 "^-?([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))?$" 112 112 ))) 113 - 114 -(% style="width:1030.29px" %) 115 -|(% style="width:163px" %)GregorianDay|(% style="width:179px" %)xsd:date|(% style="width:684px" %)((( 113 +|(% style="width:163px" %)GregorianDay|(% style="width:179px" %)xsd:date|(% style="width:800px" %)((( 116 116 "^-?([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))?$" 117 117 ))) 118 -|(% style="width:163px" %)Day|(% style="width:179px" %)xsd:gDay|(% style="width: 684px" %)(((116 +|(% style="width:163px" %)Day|(% style="width:179px" %)xsd:gDay|(% style="width:800px" %)((( 119 119 "^~-~--(0[1-9]|[12][0-9]|3[01])(Z|(\+|- )((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$" 120 120 ))) 121 -|(% style="width:163px" %)MonthDay|(% style="width:179px" %)xsd:gMonthDay|(% style="width: 684px" %)(((119 +|(% style="width:163px" %)MonthDay|(% style="width:179px" %)xsd:gMonthDay|(% style="width:800px" %)((( 122 122 "^~-~-(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))?$" 123 123 ))) 124 -|(% style="width:163px" %)Month|(% style="width:179px" %)xsd:Month|(% style="width: 684px" %)(((122 +|(% style="width:163px" %)Month|(% style="width:179px" %)xsd:Month|(% style="width:800px" %)((( 125 125 "^~-~-(0[1-9]|1[0-2])(Z|(\+|-)((0[0-9]|1[0- 3]):[0-5][0-9]|14:00))?$" 126 126 ))) 127 -|(% style="width:163px" %)Duration|(% style="width:179px" %)xsd:duration|(% style="width: 684px" %)(((125 +|(% style="width:163px" %)Duration|(% style="width:179px" %)xsd:duration|(% style="width:800px" %)((( 128 128 "^-?P[0-9]+Y?([0-9]+M)?([0-9]+D)?(T([0- 9]+H)?([0-9]+M)?([0-9]+(\.[0-9]+)?S)?)?$" 129 129 ))) 130 130 ... ... @@ -140,17 +140,14 @@ 140 140 141 141 The hierarchy of time formats is as follows (**bold** indicates a category which is made up of multiple formats, //italic// indicates a distinct format): 142 142 143 -* **Observational Time Period **o **Standard Time Period** 141 +* **Observational Time Period** 142 +** **Standard Time Period** 143 +*** **Basic Time Period** 144 +**** **Gregorian Time Period** 145 +**** //Date Time// 146 +*** **Reporting Time Period** 147 +** **//Time Range//** 144 144 145 -▪ **Basic Time Period** 146 - 147 -* **Gregorian Time Period** 148 -* //Date Time// 149 - 150 -▪ **Reporting Time Period** 151 - 152 -o //Time Range// 153 - 154 154 The details of these time period categories and of the distinct formats which make them up are detailed in the sections to follow. 155 155 156 156 === {{id name="_Toc291508"/}}4.2.2 Observational Time Period === ... ... @@ -169,12 +169,16 @@ 169 169 170 170 Representation: xs:gYear (YYYY) 171 171 172 -Period: the start of January 1 to the end of December 31 **Gregorian Year Month**:167 +Period: the start of January 1 to the end of December 31 173 173 169 +**Gregorian Year Month**: 170 + 174 174 Representation: xs:gYearMonth (YYYY-MM) 175 175 176 -Period: the start of the first day of the month to end of the last day of the month **Gregorian Day**:173 +Period: the start of the first day of the month to end of the last day of the month 177 177 175 +**Gregorian Day**: 176 + 178 178 Representation: xs:date (YYYY-MM-DD) 179 179 180 180 Period: the start of the day (00:00:00) to the end of the day (23:59:59) ... ... @@ -183,7 +183,7 @@ 183 183 184 184 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. 185 185 186 -Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss) ^^[[(% class="wikiinternallink wikiinternallinkwikiinternallinkwikiinternallinkwikiinternallink wikiinternallink wikiinternallink" %)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^185 +Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss){{footnote}}The seconds can be reported fractionally{{/footnote}} 187 187 188 188 === {{id name="_Toc291512"/}}4.2.6 Standard Reporting Period === 189 189 ... ... @@ -207,8 +207,10 @@ 207 207 208 208 Limit per year: 1 209 209 210 -Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1) **Reporting Semester:**209 +Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1) 211 211 211 +**Reporting Semester:** 212 + 212 212 Period Indicator: S 213 213 214 214 Period Duration: P6M (six months) ... ... @@ -217,8 +217,6 @@ 217 217 218 218 Representation: common:ReportingSemesterType (YYYY-Ss, e.g. 2000-S2) 219 219 220 -[[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_59eee18f.gif||alt="Shape2" height="1" width="192"]] 221 - 222 222 **Reporting Trimester:** 223 223 224 224 Period Indicator: T ... ... @@ -227,8 +227,10 @@ 227 227 228 228 Limit per year: 3 229 229 230 -Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3) **Reporting Quarter:**229 +Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3) 231 231 231 +**Reporting Quarter:** 232 + 232 232 Period Indicator: Q 233 233 234 234 Period Duration: P3M (three months) ... ... @@ -235,8 +235,10 @@ 235 235 236 236 Limit per year: 4 237 237 238 -Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4) **Reporting Month**:239 +Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4) 239 239 241 +**Reporting Month**: 242 + 240 240 Period Indicator: M 241 241 242 242 Period Duration: P1M (one month) ... ... @@ -257,7 +257,7 @@ 257 257 258 258 Representation: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53) 259 259 260 -Notes: There are either 52 or 53 weeks in a reporting year. This is based on the ISO 8601 definition of a week (Monday - Saturday), where the first week of a reporting year is defined as the week with the first Thursday on or after the reporting year start day.^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]](%%)^^ 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. 263 +Notes: There are either 52 or 53 weeks in a reporting year. This is based on the ISO 8601 definition of a week (Monday - Saturday), where the first week of a reporting year is defined as the week with the first Thursday on or after the reporting year start day.^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]](%%)^^ 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. 261 261 262 262 **Reporting Day**: 263 263 ... ... @@ -277,14 +277,8 @@ 277 277 278 278 (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. 279 279 280 -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 283 +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]): 281 281 282 -Gregorian calendar period covered by the reporting period can be computed as follows 283 - 284 -(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 288 1. **Determine [REPORTING_YEAR_BASE]:** 289 289 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). ... ... @@ -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 wikiinternallinkwikiinternallinkwikiinternallinkwikiinternallinkwikiinternallinkwikiinternallink" %)^^4^^>>path:#sdfootnote4sym||name="sdfootnote4anc"]](%%)^^(P3D, P2D, or P1D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE].295 +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-to-dateTimes for further details.{{/footnote}} (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. ... ... @@ -318,8 +318,10 @@ 318 318 11. If the [PERIOD_INDICATOR] is D, the [PERIOD_DURATION] is P1D. 319 319 1. **Determine [PERIOD_START]:** 320 320 321 -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]. **4. Determine the [PERIOD_END]:**318 +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]. 322 322 320 +**4. Determine the [PERIOD_END]:** 321 + 323 323 Multiply the [PERIOD_VALUE] by the [PERIOD_DURATION]. Add^^4^^ this to the [REPORTING_YEAR_BASE] add^^4^^ -P1D. The result is the [PERIOD_END]. 324 324 325 325 For all of these ranges, the bounds include the beginning of the [PERIOD_START] (i.e. 00:00:00) and the end of the [PERIOD_END] (i.e. 23:59:59). ... ... @@ -384,29 +384,29 @@ 384 384 385 385 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. 386 386 387 -|Code|Format 388 -|OTP|Observational Time Period: Superset of all SDMX time formats (Gregorian Time Period, Reporting Time Period, and Time Range) 389 -|STP|Standard Time Period: Superset of Gregorian and Reporting Time Periods 390 -|GTP|Superset of all Gregorian Time Periods and date-time 391 -|RTP|Superset of all Reporting Time Periods 392 -|TR|((( 393 -Time Range: Start time and duration (YYYY-MM- 394 - 395 -DD(Thh:mm:ss)?/<duration>) 386 +(% style="width:771.294px" %) 387 +|Code|(% style="width:659px" %)Format 388 +|OTP|(% style="width:659px" %)Observational Time Period: Superset of all SDMX time formats (Gregorian Time Period, Reporting Time Period, and Time Range) 389 +|STP|(% style="width:659px" %)Standard Time Period: Superset of Gregorian and Reporting Time Periods 390 +|GTP|(% style="width:659px" %)Superset of all Gregorian Time Periods and date-time 391 +|RTP|(% style="width:659px" %)Superset of all Reporting Time Periods 392 +|TR|(% style="width:659px" %)((( 393 +Time Range: Start time and duration (YYYY-MM-DD(Thh:mm:ss)?/<duration>) 396 396 ))) 397 -|GY|Gregorian Year (YYYY) 398 -|GTM|Gregorian Year Month (YYYY-MM) 399 -|GD|Gregorian Day (YYYY-MM-DD) 400 -|DT|Distinct Point: date-time (YYYY-MM-DDThh:mm:ss) 401 -|RY|Reporting Year (YYYY-A1) 402 -|RS|Reporting Semester (YYYY-Ss) 403 -|RT|Reporting Trimester (YYYY-Tt) 404 -|RQ|Reporting Quarter (YYYY-Qq) 405 -|RM|Reporting Month (YYYY-Mmm) 406 -|RW|Reporting Week (YYYY-Www) 407 -|RD|Reporting Day (YYYY-Dddd) 395 +|GY|(% style="width:659px" %)Gregorian Year (YYYY) 396 +|GTM|(% style="width:659px" %)Gregorian Year Month (YYYY-MM) 397 +|GD|(% style="width:659px" %)Gregorian Day (YYYY-MM-DD) 398 +|DT|(% style="width:659px" %)Distinct Point: date-time (YYYY-MM-DDThh:mm:ss) 399 +|RY|(% style="width:659px" %)Reporting Year (YYYY-A1) 400 +|RS|(% style="width:659px" %)Reporting Semester (YYYY-Ss) 401 +|RT|(% style="width:659px" %)Reporting Trimester (YYYY-Tt) 402 +|RQ|(% style="width:659px" %)Reporting Quarter (YYYY-Qq) 403 +|RM|(% style="width:659px" %)Reporting Month (YYYY-Mmm) 404 +|RW|(% style="width:659px" %)Reporting Week (YYYY-Www) 405 +|RD|(% style="width:659px" %)Reporting Day (YYYY-Dddd) 408 408 409 -==== Table 1: SDMX-ML Time Format Codes ==== 407 +(% class="wikigeneratedid" id="HTable1:SDMX-MLTimeFormatCodes" %) 408 +Table 1: SDMX-ML Time Format Codes 410 410 411 411 === {{id name="_Toc291515"/}}4.2.9 Time Zones === 412 412 ... ... @@ -453,12 +453,13 @@ 453 453 454 454 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. 455 455 456 -|**Operator**|**Rule** 457 -|Greater Than|Any data after the last moment of the period 458 -|Less Than|Any data before the first moment of the period 459 -|Greater Than or Equal To|Any data on or after the first moment of the period 460 -|Less Than or Equal To|Any data on or before the last moment of the period 461 -|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 455 +(% style="width:1020.29px" %) 456 +|(% style="width:236px" %)**Operator**|(% style="width:781px" %)**Rule** 457 +|(% style="width:236px" %)Greater Than|(% style="width:781px" %)Any data after the last moment of the period 458 +|(% style="width:236px" %)Less Than|(% style="width:781px" %)Any data before the first moment of the period 459 +|(% style="width:236px" %)Greater Than or Equal To|(% style="width:781px" %)Any data on or after the first moment of the period 460 +|(% style="width:236px" %)Less Than or Equal To|(% style="width:781px" %)Any data on or before the last moment of the period 461 +|(% style="width:236px" %)Equal To|(% style="width:781px" %)Any data which falls on or after the first moment of the period and before or on the last moment of the period 462 462 463 463 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. 464 464 ... ... @@ -507,7 +507,7 @@ 507 507 508 508 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". 509 509 510 -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 //MaintainableArtefact//. According to the legacy versioning, any artefact defined without a version is equivalent to following the legacy versioning, thus having version ‘1.0’.510 +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’. 511 511 512 512 === 4.3.1 Non-versioned artefacts === 513 513 ... ... @@ -515,8 +515,6 @@ 515 515 516 516 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. 517 517 518 -[[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_59eee18f.gif||alt="Shape3" height="1" width="192"]] 519 - 520 520 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. 521 521 522 522 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.