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
-
... ... @@ -138,17 +138,14 @@ 138 138 139 139 The hierarchy of time formats is as follows (**bold** indicates a category which is made up of multiple formats, //italic// indicates a distinct format): 140 140 141 -* **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//** 142 142 143 -▪ **Basic Time Period** 144 - 145 -* **Gregorian Time Period** 146 -* //Date Time// 147 - 148 -▪ **Reporting Time Period** 149 - 150 -o //Time Range// 151 - 152 152 The details of these time period categories and of the distinct formats which make them up are detailed in the sections to follow. 153 153 154 154 === {{id name="_Toc291508"/}}4.2.2 Observational Time Period === ... ... @@ -167,12 +167,16 @@ 167 167 168 168 Representation: xs:gYear (YYYY) 169 169 170 -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 171 171 169 +**Gregorian Year Month**: 170 + 172 172 Representation: xs:gYearMonth (YYYY-MM) 173 173 174 -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 175 175 175 +**Gregorian Day**: 176 + 176 176 Representation: xs:date (YYYY-MM-DD) 177 177 178 178 Period: the start of the day (00:00:00) to the end of the day (23:59:59) ... ... @@ -181,7 +181,7 @@ 181 181 182 182 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. 183 183 184 -Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss) ^^[[(% class="wikiinternallink 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}} 185 185 186 186 === {{id name="_Toc291512"/}}4.2.6 Standard Reporting Period === 187 187 ... ... @@ -205,8 +205,10 @@ 205 205 206 206 Limit per year: 1 207 207 208 -Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1) **Reporting Semester:**209 +Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1) 209 209 211 +**Reporting Semester:** 212 + 210 210 Period Indicator: S 211 211 212 212 Period Duration: P6M (six months) ... ... @@ -215,8 +215,6 @@ 215 215 216 216 Representation: common:ReportingSemesterType (YYYY-Ss, e.g. 2000-S2) 217 217 218 -[[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_59eee18f.gif||alt="Shape2" height="1" width="192"]] 219 - 220 220 **Reporting Trimester:** 221 221 222 222 Period Indicator: T ... ... @@ -225,8 +225,10 @@ 225 225 226 226 Limit per year: 3 227 227 228 -Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3) **Reporting Quarter:**229 +Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3) 229 229 231 +**Reporting Quarter:** 232 + 230 230 Period Indicator: Q 231 231 232 232 Period Duration: P3M (three months) ... ... @@ -233,8 +233,10 @@ 233 233 234 234 Limit per year: 4 235 235 236 -Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4) **Reporting Month**:239 +Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4) 237 237 241 +**Reporting Month**: 242 + 238 238 Period Indicator: M 239 239 240 240 Period Duration: P1M (one month) ... ... @@ -255,7 +255,7 @@ 255 255 256 256 Representation: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53) 257 257 258 -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" %)^^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" %)^^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. 259 259 260 260 **Reporting Day**: 261 261 ... ... @@ -293,7 +293,7 @@ 293 293 11. **If the [PERIOD_INDICATOR] is W:** 294 294 111. **If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday:** 295 295 296 -Add ^^[[(% class="wikiinternallink wikiinternallinkwikiinternallinkwikiinternallinkwikiinternallinkwikiinternallinkwikiinternallinkwikiinternallink" %)^^4^^>>path:#sdfootnote4sym||name="sdfootnote4anc"]](%%)^^(P3D, P2D, or P1D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE].301 +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]. 297 297 298 298 1. 299 299 11. ... ... @@ -316,8 +316,10 @@ 316 316 11. If the [PERIOD_INDICATOR] is D, the [PERIOD_DURATION] is P1D. 317 317 1. **Determine [PERIOD_START]:** 318 318 319 -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]:**324 +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]. 320 320 326 +**4. Determine the [PERIOD_END]:** 327 + 321 321 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]. 322 322 323 323 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). ... ... @@ -382,29 +382,29 @@ 382 382 383 383 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. 384 384 385 -|Code|Format 386 -|OTP|Observational Time Period: Superset of all SDMX time formats (Gregorian Time Period, Reporting Time Period, and Time Range) 387 -|STP|Standard Time Period: Superset of Gregorian and Reporting Time Periods 388 -|GTP|Superset of all Gregorian Time Periods and date-time 389 -|RTP|Superset of all Reporting Time Periods 390 -|TR|((( 391 -Time Range: Start time and duration (YYYY-MM- 392 - 393 -DD(Thh:mm:ss)?/<duration>) 392 +(% style="width:771.294px" %) 393 +|Code|(% style="width:659px" %)Format 394 +|OTP|(% style="width:659px" %)Observational Time Period: Superset of all SDMX time formats (Gregorian Time Period, Reporting Time Period, and Time Range) 395 +|STP|(% style="width:659px" %)Standard Time Period: Superset of Gregorian and Reporting Time Periods 396 +|GTP|(% style="width:659px" %)Superset of all Gregorian Time Periods and date-time 397 +|RTP|(% style="width:659px" %)Superset of all Reporting Time Periods 398 +|TR|(% style="width:659px" %)((( 399 +Time Range: Start time and duration (YYYY-MM-DD(Thh:mm:ss)?/<duration>) 394 394 ))) 395 -|GY|Gregorian Year (YYYY) 396 -|GTM|Gregorian Year Month (YYYY-MM) 397 -|GD|Gregorian Day (YYYY-MM-DD) 398 -|DT|Distinct Point: date-time (YYYY-MM-DDThh:mm:ss) 399 -|RY|Reporting Year (YYYY-A1) 400 -|RS|Reporting Semester (YYYY-Ss) 401 -|RT|Reporting Trimester (YYYY-Tt) 402 -|RQ|Reporting Quarter (YYYY-Qq) 403 -|RM|Reporting Month (YYYY-Mmm) 404 -|RW|Reporting Week (YYYY-Www) 405 -|RD|Reporting Day (YYYY-Dddd) 401 +|GY|(% style="width:659px" %)Gregorian Year (YYYY) 402 +|GTM|(% style="width:659px" %)Gregorian Year Month (YYYY-MM) 403 +|GD|(% style="width:659px" %)Gregorian Day (YYYY-MM-DD) 404 +|DT|(% style="width:659px" %)Distinct Point: date-time (YYYY-MM-DDThh:mm:ss) 405 +|RY|(% style="width:659px" %)Reporting Year (YYYY-A1) 406 +|RS|(% style="width:659px" %)Reporting Semester (YYYY-Ss) 407 +|RT|(% style="width:659px" %)Reporting Trimester (YYYY-Tt) 408 +|RQ|(% style="width:659px" %)Reporting Quarter (YYYY-Qq) 409 +|RM|(% style="width:659px" %)Reporting Month (YYYY-Mmm) 410 +|RW|(% style="width:659px" %)Reporting Week (YYYY-Www) 411 +|RD|(% style="width:659px" %)Reporting Day (YYYY-Dddd) 406 406 407 -==== Table 1: SDMX-ML Time Format Codes ==== 413 +(% class="wikigeneratedid" id="HTable1:SDMX-MLTimeFormatCodes" %) 414 +Table 1: SDMX-ML Time Format Codes 408 408 409 409 === {{id name="_Toc291515"/}}4.2.9 Time Zones === 410 410 ... ... @@ -451,12 +451,13 @@ 451 451 452 452 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. 453 453 454 -|**Operator**|**Rule** 455 -|Greater Than|Any data after the last moment of the period 456 -|Less Than|Any data before the first moment of the period 457 -|Greater Than or Equal To|Any data on or after the first moment of the period 458 -|Less Than or Equal To|Any data on or before the last moment of the period 459 -|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 461 +(% style="width:1020.29px" %) 462 +|(% style="width:236px" %)**Operator**|(% style="width:781px" %)**Rule** 463 +|(% style="width:236px" %)Greater Than|(% style="width:781px" %)Any data after the last moment of the period 464 +|(% style="width:236px" %)Less Than|(% style="width:781px" %)Any data before the first moment of the period 465 +|(% style="width:236px" %)Greater Than or Equal To|(% style="width:781px" %)Any data on or after the first moment of the period 466 +|(% style="width:236px" %)Less Than or Equal To|(% style="width:781px" %)Any data on or before the last moment of the period 467 +|(% 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 460 460 461 461 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. 462 462 ... ... @@ -505,7 +505,7 @@ 505 505 506 506 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". 507 507 508 -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’.516 +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’. 509 509 510 510 === 4.3.1 Non-versioned artefacts === 511 511 ... ... @@ -513,8 +513,6 @@ 513 513 514 514 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. 515 515 516 -[[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_59eee18f.gif||alt="Shape3" height="1" width="192"]] 517 - 518 518 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. 519 519 520 520 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.