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
-
... ... @@ -231,14 +231,10 @@ 231 231 232 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. 233 233 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]- 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]): 235 235 236 -[PERIOD_INDICATOR][PERIOD_VALUE] and the reporting year start day as [REPORTING_YEAR_START_DAY]): 237 - 238 -1. **Determine [REPORTING_YEAR_BASE]:** 239 - 236 +**~1. Determine [REPORTING_YEAR_BASE]:** 240 240 Combine [REPORTING_YEAR] of the reporting period value (YYYY) with [REPORTING_YEAR_START_DAY] (MM-DD) to get a date (YYYY-MM-DD). 241 - 242 242 This is the [REPORTING_YEAR_START_DATE] 243 243 244 244 1. ... ... @@ -258,14 +258,15 @@ 258 258 259 259 The [REPORTING_YEAR_START_DATE] is the [REPORTING_YEAR_BASE]. 260 260 261 -1. **Determine [PERIOD_DURATION]:** 262 -11. If the [PERIOD_INDICATOR] is A, the [PERIOD_DURATION] is P1Y. 263 -11. If the [PERIOD_INDICATOR] is S, the [PERIOD_DURATION] is P6M. 264 -11. If the [PERIOD_INDICATOR] is T, the [PERIOD_DURATION] is P4M. 265 -11. If the [PERIOD_INDICATOR] is Q, the [PERIOD_DURATION] is P3M. 266 -11. If the [PERIOD_INDICATOR] is M, the [PERIOD_DURATION] is P1M. 267 -11. If the [PERIOD_INDICATOR] is W, the [PERIOD_DURATION] is P7D. 268 -11. If the [PERIOD_INDICATOR] is D, the [PERIOD_DURATION] is P1D. 257 +**2. Determine [PERIOD_DURATION]:** 258 + 259 +1. If the [PERIOD_INDICATOR] is A, the [PERIOD_DURATION] is P1Y. 260 +1. If the [PERIOD_INDICATOR] is S, the [PERIOD_DURATION] is P6M. 261 +1. If the [PERIOD_INDICATOR] is T, the [PERIOD_DURATION] is P4M. 262 +1. If the [PERIOD_INDICATOR] is Q, the [PERIOD_DURATION] is P3M. 263 +1. If the [PERIOD_INDICATOR] is M, the [PERIOD_DURATION] is P1M. 264 +1. If the [PERIOD_INDICATOR] is W, the [PERIOD_DURATION] is P7D. 265 +1. If the [PERIOD_INDICATOR] is D, the [PERIOD_DURATION] is P1D. 269 269 1. **Determine [PERIOD_START]:** 270 270 271 271 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]. ... ... @@ -334,25 +334,26 @@ 334 334 335 335 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. 336 336 337 -|(% style="width:95px" %)Code|(% style="width:1520px" %)Format 338 -|(% style="width:95px" %)OTP|(% style="width:1520px" %)Observational Time Period: Superset of all SDMX time formats (Gregorian Time Period, Reporting Time Period, and Time Range) 339 -|(% style="width:95px" %)STP|(% style="width:1520px" %)Standard Time Period: Superset of Gregorian and Reporting Time Periods 340 -|(% style="width:95px" %)GTP|(% style="width:1520px" %)Superset of all Gregorian Time Periods and date-time 341 -|(% style="width:95px" %)RTP|(% style="width:1520px" %)Superset of all Reporting Time Periods 342 -|(% style="width:95px" %)TR|(% style="width:1520px" %)((( 334 +(% style="width:890.835px" %) 335 +|(% style="width:95px" %)**Code**|(% style="width:793px" %)**Format** 336 +|(% style="width:95px" %)OTP|(% style="width:793px" %)Observational Time Period: Superset of all SDMX time formats (Gregorian Time Period, Reporting Time Period, and Time Range) 337 +|(% style="width:95px" %)STP|(% style="width:793px" %)Standard Time Period: Superset of Gregorian and Reporting Time Periods 338 +|(% style="width:95px" %)GTP|(% style="width:793px" %)Superset of all Gregorian Time Periods and date-time 339 +|(% style="width:95px" %)RTP|(% style="width:793px" %)Superset of all Reporting Time Periods 340 +|(% style="width:95px" %)TR|(% style="width:793px" %)((( 343 343 Time Range: Start time and duration (YYYY-MM-DD(Thh:mm:ss)?/<duration>) 344 344 ))) 345 -|(% style="width:95px" %)GY|(% style="width: 1520px" %)Gregorian Year (YYYY)346 -|(% style="width:95px" %)GTM|(% style="width: 1520px" %)Gregorian Year Month (YYYY-MM)347 -|(% style="width:95px" %)GD|(% style="width: 1520px" %)Gregorian Day (YYYY-MM-DD)348 -|(% style="width:95px" %)DT|(% style="width: 1520px" %)Distinct Point: date-time (YYYY-MM-DDThh:mm:ss)349 -|(% style="width:95px" %)RY|(% style="width: 1520px" %)Reporting Year (YYYY-A1)350 -|(% style="width:95px" %)RS|(% style="width: 1520px" %)Reporting Semester (YYYY-Ss)351 -|(% style="width:95px" %)RT|(% style="width: 1520px" %)Reporting Trimester (YYYY-Tt)352 -|(% style="width:95px" %)RQ|(% style="width: 1520px" %)Reporting Quarter (YYYY-Qq)353 -|(% style="width:95px" %)RM|(% style="width: 1520px" %)Reporting Month (YYYY-Mmm)354 -|(% style="width:95px" %)RW|(% style="width: 1520px" %)Reporting Week (YYYY-Www)355 -|(% style="width:95px" %)RD|(% style="width: 1520px" %)Reporting Day (YYYY-Dddd)343 +|(% style="width:95px" %)GY|(% style="width:793px" %)Gregorian Year (YYYY) 344 +|(% style="width:95px" %)GTM|(% style="width:793px" %)Gregorian Year Month (YYYY-MM) 345 +|(% style="width:95px" %)GD|(% style="width:793px" %)Gregorian Day (YYYY-MM-DD) 346 +|(% style="width:95px" %)DT|(% style="width:793px" %)Distinct Point: date-time (YYYY-MM-DDThh:mm:ss) 347 +|(% style="width:95px" %)RY|(% style="width:793px" %)Reporting Year (YYYY-A1) 348 +|(% style="width:95px" %)RS|(% style="width:793px" %)Reporting Semester (YYYY-Ss) 349 +|(% style="width:95px" %)RT|(% style="width:793px" %)Reporting Trimester (YYYY-Tt) 350 +|(% style="width:95px" %)RQ|(% style="width:793px" %)Reporting Quarter (YYYY-Qq) 351 +|(% style="width:95px" %)RM|(% style="width:793px" %)Reporting Month (YYYY-Mmm) 352 +|(% style="width:95px" %)RW|(% style="width:793px" %)Reporting Week (YYYY-Www) 353 +|(% style="width:95px" %)RD|(% style="width:793px" %)Reporting Day (YYYY-Dddd) 356 356 357 357 (% class="wikigeneratedid" id="HTable1:SDMX-MLTimeFormatCodes" %) 358 358 **Table 1: SDMX-ML Time Format Codes** ... ... @@ -402,12 +402,13 @@ 402 402 403 403 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. 404 404 405 -|**Operator**|**Rule** 406 -|Greater Than|Any data after the last moment of the period 407 -|Less Than|Any data before the first moment of the period 408 -|Greater Than or Equal To|Any data on or after the first moment of the period 409 -|Less Than or Equal To|Any data on or before the last moment of the period 410 -|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 403 +(% style="width:770.835px" %) 404 +|(% style="width:220px" %)**Operator**|(% style="width:548px" %)**Rule** 405 +|(% style="width:220px" %)Greater Than|(% style="width:548px" %)Any data after the last moment of the period 406 +|(% style="width:220px" %)Less Than|(% style="width:548px" %)Any data before the first moment of the period 407 +|(% style="width:220px" %)Greater Than or Equal To|(% style="width:548px" %)Any data on or after the first moment of the period 408 +|(% style="width:220px" %)Less Than or Equal To|(% style="width:548px" %)Any data on or before the last moment of the period 409 +|(% style="width:220px" %)Equal To|(% style="width:548px" %)Any data which falls on or after the first moment of the period and before or on the last moment of the period 411 411 412 412 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. 413 413 ... ... @@ -414,11 +414,8 @@ 414 414 **Examples:** 415 415 416 416 **Gregorian Period** 417 - 418 418 Query Parameter: Greater than 2010 419 - 420 420 Literal Interpretation: Any data where the start period occurs after 2010-1231T23:59:59. 421 - 422 422 Example Matches: 423 423 424 424 * 2011 or later ... ... @@ -434,9 +434,7 @@ 434 434 * 2010-D185 or later (reporting year start day ~-~-07-01 or later) 435 435 436 436 **Reporting Period** 437 - 438 438 Query Parameter: Greater than or equal to 2010-Q3 439 - 440 440 Literal Interpretation: Any data with a reporting period where the start period is on or after the start period of 2010-Q3 for the same reporting year start day, or and data where the start period is on or after 2010-07-01. Example Matches: 441 441 442 442 * 2011 or later ... ... @@ -457,12 +457,10 @@ 457 457 458 458 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". 459 459 460 -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 from454 +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 461 461 462 -//MaintainableArtefact//. According to the legacy versioning, any artefact defined without a version is equivalent to following the legacy versioning, thus having version 456 +//MaintainableArtefact//. According to the legacy versioning, any artefact defined without a version is equivalent to following the legacy versioning, thus having version ‘1.0’. 463 463 464 -‘1.0’. 465 - 466 466 === 4.3.1 Non-versioned artefacts === 467 467 468 468 Indeed, some use cases do not need or are incompatible with versioning for some or all their structural artefacts, such as the Agency, Data Providers, Metadata Providers and Data Consumer Schemes. These artefacts follow the legacy versioning, with a fixed version set to ‘1.0’.