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
-
... ... @@ -206,8 +206,10 @@ 206 206 207 207 Limit per year: 1 208 208 209 -Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1) **Reporting Semester:**209 +Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1) 210 210 211 +**Reporting Semester:** 212 + 211 211 Period Indicator: S 212 212 213 213 Period Duration: P6M (six months) ... ... @@ -224,8 +224,10 @@ 224 224 225 225 Limit per year: 3 226 226 227 -Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3) **Reporting Quarter:**229 +Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3) 228 228 231 +**Reporting Quarter:** 232 + 229 229 Period Indicator: Q 230 230 231 231 Period Duration: P3M (three months) ... ... @@ -232,8 +232,10 @@ 232 232 233 233 Limit per year: 4 234 234 235 -Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4) **Reporting Month**:239 +Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4) 236 236 241 +**Reporting Month**: 242 + 237 237 Period Indicator: M 238 238 239 239 Period Duration: P1M (one month) ... ... @@ -254,7 +254,7 @@ 254 254 255 255 Representation: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53) 256 256 257 -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" %)^^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 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. 258 258 259 259 **Reporting Day**: 260 260 ... ... @@ -274,49 +274,38 @@ 274 274 275 275 (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. 276 276 277 -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]): 278 278 279 - Gregoriancalendar period covered bythereporting periodcan be computed as follows285 +**~1. Determine [REPORTING_YEAR_BASE]:** 280 280 281 -(based on the standard format of [REPROTING_YEAR]- 282 - 283 -[PERIOD_INDICATOR][PERIOD_VALUE] and the reporting year start day as [REPORTING_YEAR_START_DAY]): 284 - 285 -1. **Determine [REPORTING_YEAR_BASE]:** 286 - 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). 288 - 289 289 This is the [REPORTING_YEAR_START_DATE] 290 290 291 -1. 292 -11. **If the [PERIOD_INDICATOR] is W:** 293 -111. **If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday:** 290 +**a) If the [PERIOD_INDICATOR] is W:** 294 294 295 -Add^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^4^^>>path:#sdfootnote4sym||name="sdfootnote4anc"]](%%)^^ (P3D, P2D, or P1D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE]. 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]. 296 296 297 -1. 298 -11. 299 -111. **If [REPORTING_YEAR_START_DATE] is a Monday, Tuesday, Wednesday, or Thursday:** 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]. 300 300 301 -Add^^4^^ (P0D, -P1D, -P2D, or -P3D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE]. 302 - 303 -1. 304 -11. **Else:** 305 - 298 +**b) Else:** 306 306 The [REPORTING_YEAR_START_DATE] is the [REPORTING_YEAR_BASE]. 307 307 308 - 1.**Determine [PERIOD_DURATION]:**309 - 11.If the [PERIOD_INDICATOR] is A, the [PERIOD_DURATION] is P1Y.310 - 11.If the [PERIOD_INDICATOR] is S, the [PERIOD_DURATION] is P6M.311 - 11.If the [PERIOD_INDICATOR] is T, the [PERIOD_DURATION] is P4M.312 - 11.If the [PERIOD_INDICATOR] is Q, the [PERIOD_DURATION] is P3M.313 - 11.If the [PERIOD_INDICATOR] is M, the [PERIOD_DURATION] is P1M.314 - 11.If the [PERIOD_INDICATOR] is W, the [PERIOD_DURATION] is P7D.315 - 11.If the [PERIOD_INDICATOR] is D, the [PERIOD_DURATION] is P1D.316 - 1.**Determine [PERIOD_START]:**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]:** 317 317 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]. **4. Determine the [PERIOD_END]:**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]. 319 319 313 +**4. Determine the [PERIOD_END]:** 314 + 320 320 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]. 321 321 322 322 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). ... ... @@ -325,25 +325,21 @@ 325 325 326 326 **2010-Q2, REPORTING_YEAR_START_DAY = ~-~-07-01 (July 1)** 327 327 328 -1. [REPORTING_YEAR_START_DATE] = 2010-07-01 323 +~1. [REPORTING_YEAR_START_DATE] = 2010-07-01 329 329 330 -b) [REPORTING_YEAR_BASE] = 2010-07-01 325 + b) [REPORTING_YEAR_BASE] = 2010-07-01 331 331 332 -1. [PERIOD_DURATION] = P3M 333 -1. (2-1) * P3M = P3M 327 +2. [PERIOD_DURATION] = P3M 334 334 335 -2010-07-01 + P3M = 2010-10-01 329 +3. (2-1) * P3M = P3M 330 + 2010-07-01 + P3M = 2010-10-01 331 + [PERIOD_START] = 2010-10-01 336 336 337 -[PERIOD_START] = 2010-10-01 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 338 338 339 -1. 2 * P3M = P6M 340 - 341 -2010-07-01 + P6M = 2010-13-01 = 2011-01-01 342 - 343 -2011-01-01 + -P1D = 2010-12-31 344 - 345 -[PERIOD_END] = 2010-12-31 346 - 347 347 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 348 348 349 349 **2011-W36, REPORTING_YEAR_START_DAY = ~-~-07-01 (July 1)** ... ... @@ -381,29 +381,29 @@ 381 381 382 382 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. 383 383 384 -|Code|Format 385 -|OTP|Observational Time Period: Superset of all SDMX time formats (Gregorian Time Period, Reporting Time Period, and Time Range) 386 -|STP|Standard Time Period: Superset of Gregorian and Reporting Time Periods 387 -|GTP|Superset of all Gregorian Time Periods and date-time 388 -|RTP|Superset of all Reporting Time Periods 389 -|TR|((( 390 -Time Range: Start time and duration (YYYY-MM- 391 - 392 -DD(Thh:mm:ss)?/<duration>) 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>) 393 393 ))) 394 -|GY|Gregorian Year (YYYY) 395 -|GTM|Gregorian Year Month (YYYY-MM) 396 -|GD|Gregorian Day (YYYY-MM-DD) 397 -|DT|Distinct Point: date-time (YYYY-MM-DDThh:mm:ss) 398 -|RY|Reporting Year (YYYY-A1) 399 -|RS|Reporting Semester (YYYY-Ss) 400 -|RT|Reporting Trimester (YYYY-Tt) 401 -|RQ|Reporting Quarter (YYYY-Qq) 402 -|RM|Reporting Month (YYYY-Mmm) 403 -|RW|Reporting Week (YYYY-Www) 404 -|RD|Reporting Day (YYYY-Dddd) 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) 405 405 406 -==== Table 1: SDMX-ML Time Format Codes ==== 396 +(% class="wikigeneratedid" id="HTable1:SDMX-MLTimeFormatCodes" %) 397 +Table 1: SDMX-ML Time Format Codes 407 407 408 408 === {{id name="_Toc291515"/}}4.2.9 Time Zones === 409 409 ... ... @@ -450,12 +450,13 @@ 450 450 451 451 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. 452 452 453 -|**Operator**|**Rule** 454 -|Greater Than|Any data after the last moment of the period 455 -|Less Than|Any data before the first moment of the period 456 -|Greater Than or Equal To|Any data on or after the first moment of the period 457 -|Less Than or Equal To|Any data on or before the last moment of the period 458 -|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 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 459 460 460 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. 461 461 ... ... @@ -504,7 +504,7 @@ 504 504 505 505 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". 506 506 507 -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’.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__>>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’. 508 508 509 509 === 4.3.1 Non-versioned artefacts === 510 510 ... ... @@ -512,8 +512,6 @@ 512 512 513 513 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. 514 514 515 -[[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_59eee18f.gif||alt="Shape3" height="1" width="192"]] 516 - 517 517 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. 518 518 519 519 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.