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
-
... ... @@ -260,7 +260,7 @@ 260 260 261 261 Representation: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53) 262 262 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 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" %)^^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. 264 264 265 265 **Reporting Day**: 266 266 ... ... @@ -280,38 +280,49 @@ 280 280 281 281 (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. 282 282 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]):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 284 284 285 - **~1.Determine[REPORTING_YEAR_BASE]:**285 +Gregorian calendar period covered by the reporting period can be computed as follows 286 286 287 +(based on the standard format of [REPROTING_YEAR]- 288 + 289 +[PERIOD_INDICATOR][PERIOD_VALUE] and the reporting year start day as [REPORTING_YEAR_START_DAY]): 290 + 291 +1. **Determine [REPORTING_YEAR_BASE]:** 292 + 287 287 Combine [REPORTING_YEAR] of the reporting period value (YYYY) with [REPORTING_YEAR_START_DAY] (MM-DD) to get a date (YYYY-MM-DD). 294 + 288 288 This is the [REPORTING_YEAR_START_DATE] 289 289 290 -**a) If the [PERIOD_INDICATOR] is W:** 297 +1. 298 +11. **If the [PERIOD_INDICATOR] is W:** 299 +111. **If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday:** 291 291 292 - ~1. **If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday**: 293 - 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]. 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]. 294 294 295 -**~ 2. If [REPORTING_YEAR_START_DATE] is a Monday, Tuesday, Wednesday, or Thursday:** 296 - Add^^4^^ (P0D, -P1D, -P2D, or -P3D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE]. 303 +1. 304 +11. 305 +111. **If [REPORTING_YEAR_START_DATE] is a Monday, Tuesday, Wednesday, or Thursday:** 297 297 298 -**b) Else:** 299 -The [REPORTING_YEAR_START_DATE] is the [REPORTING_YEAR_BASE]. 307 +Add^^4^^ (P0D, -P1D, -P2D, or -P3D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE]. 300 300 301 -**2. Determine [PERIOD_DURATION]:** 302 -a) If the [PERIOD_INDICATOR] is A, the [PERIOD_DURATION] is P1Y. 303 -b) If the [PERIOD_INDICATOR] is S, the [PERIOD_DURATION] is P6M. 304 -c) If the [PERIOD_INDICATOR] is T, the [PERIOD_DURATION] is P4M. 305 -d) If the [PERIOD_INDICATOR] is Q, the [PERIOD_DURATION] is P3M. 306 -e) If the [PERIOD_INDICATOR] is M, the [PERIOD_DURATION] is P1M. 307 -f) If the [PERIOD_INDICATOR] is W, the [PERIOD_DURATION] is P7D. 308 -g) If the [PERIOD_INDICATOR] is D, the [PERIOD_DURATION] is P1D. 309 -**3. Determine [PERIOD_START]:** 309 +1. 310 +11. **Else:** 310 310 311 - 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].312 +The [REPORTING_YEAR_START_DATE] is the [REPORTING_YEAR_BASE]. 312 312 313 -**4. Determine the [PERIOD_END]:** 314 +1. **Determine [PERIOD_DURATION]:** 315 +11. If the [PERIOD_INDICATOR] is A, the [PERIOD_DURATION] is P1Y. 316 +11. If the [PERIOD_INDICATOR] is S, the [PERIOD_DURATION] is P6M. 317 +11. If the [PERIOD_INDICATOR] is T, the [PERIOD_DURATION] is P4M. 318 +11. If the [PERIOD_INDICATOR] is Q, the [PERIOD_DURATION] is P3M. 319 +11. If the [PERIOD_INDICATOR] is M, the [PERIOD_DURATION] is P1M. 320 +11. If the [PERIOD_INDICATOR] is W, the [PERIOD_DURATION] is P7D. 321 +11. If the [PERIOD_INDICATOR] is D, the [PERIOD_DURATION] is P1D. 322 +1. **Determine [PERIOD_START]:** 314 314 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]. **4. Determine the [PERIOD_END]:** 325 + 315 315 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]. 316 316 317 317 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). ... ... @@ -320,21 +320,25 @@ 320 320 321 321 **2010-Q2, REPORTING_YEAR_START_DAY = ~-~-07-01 (July 1)** 322 322 323 - ~1. [REPORTING_YEAR_START_DATE] = 2010-07-01334 +1. [REPORTING_YEAR_START_DATE] = 2010-07-01 324 324 325 - 336 +b) [REPORTING_YEAR_BASE] = 2010-07-01 326 326 327 -2. [PERIOD_DURATION] = P3M 338 +1. [PERIOD_DURATION] = P3M 339 +1. (2-1) * P3M = P3M 328 328 329 -3. (2-1) * P3M = P3M 330 - 2010-07-01 + P3M = 2010-10-01 331 - [PERIOD_START] = 2010-10-01 341 +2010-07-01 + P3M = 2010-10-01 332 332 333 -4. 2 * P3M = P6M 334 - 2010-07-01 + P6M = 2010-13-01 = 2011-01-01 335 - 2011-01-01 + -P1D = 2010-12-31 336 - [PERIOD_END] = 2010-12-31 343 +[PERIOD_START] = 2010-10-01 337 337 345 +1. 2 * P3M = P6M 346 + 347 +2010-07-01 + P6M = 2010-13-01 = 2011-01-01 348 + 349 +2011-01-01 + -P1D = 2010-12-31 350 + 351 +[PERIOD_END] = 2010-12-31 352 + 338 338 The actual calendar range covered by 2010-Q2 (assuming the reporting year begins July 1) is 2010-10-01T00:00:00/2010-12-31T23:59:59 339 339 340 340 **2011-W36, REPORTING_YEAR_START_DAY = ~-~-07-01 (July 1)** ... ... @@ -372,29 +372,29 @@ 372 372 373 373 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. 374 374 375 -(% style="width:771.294px" %) 376 -|Code|(% style="width:659px" %)Format 377 -|OTP|(% style="width:659px" %)Observational Time Period: Superset of all SDMX time formats (Gregorian Time Period, Reporting Time Period, and Time Range) 378 -|STP|(% style="width:659px" %)Standard Time Period: Superset of Gregorian and Reporting Time Periods 379 -|GTP|(% style="width:659px" %)Superset of all Gregorian Time Periods and date-time 380 -|RTP|(% style="width:659px" %)Superset of all Reporting Time Periods 381 -|TR|(% style="width:659px" %)((( 382 -Time Range: Start time and duration (YYYY-MM-DD(Thh:mm:ss)?/<duration>) 390 +|Code|Format 391 +|OTP|Observational Time Period: Superset of all SDMX time formats (Gregorian Time Period, Reporting Time Period, and Time Range) 392 +|STP|Standard Time Period: Superset of Gregorian and Reporting Time Periods 393 +|GTP|Superset of all Gregorian Time Periods and date-time 394 +|RTP|Superset of all Reporting Time Periods 395 +|TR|((( 396 +Time Range: Start time and duration (YYYY-MM- 397 + 398 +DD(Thh:mm:ss)?/<duration>) 383 383 ))) 384 -|GY| (% style="width:659px" %)Gregorian Year (YYYY)385 -|GTM| (% style="width:659px" %)Gregorian Year Month (YYYY-MM)386 -|GD| (% style="width:659px" %)Gregorian Day (YYYY-MM-DD)387 -|DT| (% style="width:659px" %)Distinct Point: date-time (YYYY-MM-DDThh:mm:ss)388 -|RY| (% style="width:659px" %)Reporting Year (YYYY-A1)389 -|RS| (% style="width:659px" %)Reporting Semester (YYYY-Ss)390 -|RT| (% style="width:659px" %)Reporting Trimester (YYYY-Tt)391 -|RQ| (% style="width:659px" %)Reporting Quarter (YYYY-Qq)392 -|RM| (% style="width:659px" %)Reporting Month (YYYY-Mmm)393 -|RW| (% style="width:659px" %)Reporting Week (YYYY-Www)394 -|RD| (% style="width:659px" %)Reporting Day (YYYY-Dddd)400 +|GY|Gregorian Year (YYYY) 401 +|GTM|Gregorian Year Month (YYYY-MM) 402 +|GD|Gregorian Day (YYYY-MM-DD) 403 +|DT|Distinct Point: date-time (YYYY-MM-DDThh:mm:ss) 404 +|RY|Reporting Year (YYYY-A1) 405 +|RS|Reporting Semester (YYYY-Ss) 406 +|RT|Reporting Trimester (YYYY-Tt) 407 +|RQ|Reporting Quarter (YYYY-Qq) 408 +|RM|Reporting Month (YYYY-Mmm) 409 +|RW|Reporting Week (YYYY-Www) 410 +|RD|Reporting Day (YYYY-Dddd) 395 395 396 -(% class="wikigeneratedid" id="HTable1:SDMX-MLTimeFormatCodes" %) 397 -Table 1: SDMX-ML Time Format Codes 412 +==== Table 1: SDMX-ML Time Format Codes ==== 398 398 399 399 === {{id name="_Toc291515"/}}4.2.9 Time Zones === 400 400 ... ... @@ -441,13 +441,12 @@ 441 441 442 442 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. 443 443 444 -(% style="width:1020.29px" %) 445 -|(% style="width:236px" %)**Operator**|(% style="width:781px" %)**Rule** 446 -|(% style="width:236px" %)Greater Than|(% style="width:781px" %)Any data after the last moment of the period 447 -|(% style="width:236px" %)Less Than|(% style="width:781px" %)Any data before the first moment of the period 448 -|(% style="width:236px" %)Greater Than or Equal To|(% style="width:781px" %)Any data on or after the first moment of the period 449 -|(% style="width:236px" %)Less Than or Equal To|(% style="width:781px" %)Any data on or before the last moment of the period 450 -|(% 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 459 +|**Operator**|**Rule** 460 +|Greater Than|Any data after the last moment of the period 461 +|Less Than|Any data before the first moment of the period 462 +|Greater Than or Equal To|Any data on or after the first moment of the period 463 +|Less Than or Equal To|Any data on or before the last moment of the period 464 +|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 451 451 452 452 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. 453 453 ... ... @@ -496,7 +496,7 @@ 496 496 497 497 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". 498 498 499 -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__>>http s://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’.513 +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’. 500 500 501 501 === 4.3.1 Non-versioned artefacts === 502 502 ... ... @@ -504,6 +504,8 @@ 504 504 505 505 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. 506 506 521 +[[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_59eee18f.gif||alt="Shape3" height="1" width="192"]] 522 + 507 507 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. 508 508 509 509 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.