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
-
... ... @@ -103,7 +103,7 @@ 103 103 104 104 Further to the above, the mapping between the non-native data types is presented in the table below: 105 105 106 -|**SDMX Facet**|**XML Schema**|**JSON schema **"**pattern**"[[ (% class="wikiinternallink wikiinternallink" %)^^~[1~]^^>>path:#_ftn1]](%%)**for "string" type**106 +|**SDMX Facet**|**XML Schema**|**JSON schema **"**pattern**"[[^^~[1~]^^>>path:#_ftn1]] **for "string" type** 107 107 |GregorianYear|xsd:gYear|((( 108 108 "^-?([1-9][0-9]{3,}|0[0-9]{3})(Z|(\+|-)((0[0- 109 109 ... ... @@ -194,7 +194,7 @@ 194 194 195 195 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. 196 196 197 -Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss)[[ (% class="wikiinternallink wikiinternallink" %)^^~[2~]^^>>path:#_ftn2]]197 +Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss)[[^^~[2~]^^>>path:#_ftn2]] 198 198 199 199 === 4.2.6 Standard Reporting Period === 200 200 ... ... @@ -263,7 +263,7 @@ 263 263 264 264 Representation: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53) 265 265 266 -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" %)^^~[3~]^^>>path:#_ftn3]](%%)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.266 +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.[[^^~[3~]^^>>path:#_ftn3]] 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. 267 267 268 268 **Reporting Day**: 269 269 ... ... @@ -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 wikiinternallink" %)^^~[4~]^^>>path:#_ftn4]](%%)(P3D, P2D, or P1D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE].298 +Add[[^^~[4~]^^>>path:#_ftn4]] (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. ... ... @@ -384,28 +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 -|(% style="width:95px" %)Code|(% style="width:1520px" %)Format 388 -|(% 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) 389 -|(% style="width:95px" %)STP|(% style="width:1520px" %)Standard Time Period: Superset of Gregorian and Reporting Time Periods 390 -|(% style="width:95px" %)GTP|(% style="width:1520px" %)Superset of all Gregorian Time Periods and date-time 391 -|(% style="width:95px" %)RTP|(% style="width:1520px" %)Superset of all Reporting Time Periods 392 -|(% style="width:95px" %)TR|(% style="width:1520px" %)((( 393 -Time Range: Start time and duration (YYYY-MM-DD(Thh:mm:ss)?/<duration>) 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>) 394 394 ))) 395 -| (% style="width:95px" %)GY|(% style="width:1520px" %)Gregorian Year (YYYY)396 -| (% style="width:95px" %)GTM|(% style="width:1520px" %)Gregorian Year Month (YYYY-MM)397 -| (% style="width:95px" %)GD|(% style="width:1520px" %)Gregorian Day (YYYY-MM-DD)398 -| (% style="width:95px" %)DT|(% style="width:1520px" %)Distinct Point: date-time (YYYY-MM-DDThh:mm:ss)399 -| (% style="width:95px" %)RY|(% style="width:1520px" %)Reporting Year (YYYY-A1)400 -| (% style="width:95px" %)RS|(% style="width:1520px" %)Reporting Semester (YYYY-Ss)401 -| (% style="width:95px" %)RT|(% style="width:1520px" %)Reporting Trimester (YYYY-Tt)402 -| (% style="width:95px" %)RQ|(% style="width:1520px" %)Reporting Quarter (YYYY-Qq)403 -| (% style="width:95px" %)RM|(% style="width:1520px" %)Reporting Month (YYYY-Mmm)404 -| (% style="width:95px" %)RW|(% style="width:1520px" %)Reporting Week (YYYY-Www)405 -| (% style="width:95px" %)RD|(% style="width:1520px" %)Reporting Day (YYYY-Dddd)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) 406 406 407 -(% class="wikigeneratedid" id="HTable1:SDMX-MLTimeFormatCodes" %) 408 -**Table 1: SDMX-ML Time Format Codes** 409 +==== Table 1: SDMX-ML Time Format Codes ==== 409 409 410 410 === 4.2.9 Time Zones === 411 411 ... ... @@ -432,11 +432,11 @@ 432 432 433 433 It has been possible since SDMX 2.0 for a Component to specify a representation of a time span. Depending on the format of the data message, this resulted in either an element with 2 XML attributes for holding the start time and the duration or two separate XML attributes based on the underlying Component identifier. For example, if REF_PERIOD were given a representation of time span, then in the Compact data format, it would be represented by two XML attributes; REF_PERIODStartTime (holding the start) and REF_PERIOD (holding the duration). If a new simple type is introduced in the SDMX schemas that can hold ISO 8601 time intervals, then this will no longer be necessary. What was represented as this: 434 434 435 - >(% style="font-size:18px" %)<Series REF_PERIODStartTime="2000-01-01T00:00:00" REF_PERIOD="P2M"/>436 +<Series REF_PERIODStartTime="2000-01-01T00:00:00" REF_PERIOD="P2M"/> 436 436 437 437 can now be represented with this: 438 438 439 - >(% style="font-size:18px" %)<Series REF_PERIOD="2000-01-01T00:00:00/P2M"/>440 +<Series REF_PERIOD="2000-01-01T00:00:00/P2M"/> 440 440 441 441 === 4.2.11 Notes on Formats === 442 442 ... ... @@ -503,7 +503,7 @@ 503 503 * 2010-W28 or later (reporting year start day ~-~-07-01)^^6^^ 504 504 * 2010-D185 or later (reporting year start day ~-~-07-01) 505 505 506 -= =4.3 Versioning ==507 += 4.3 Versioning == 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 ... ... @@ -543,13 +543,17 @@ 543 543 544 544 The production versions of identifiable artefacts are assumed stable, i.e., they do not have an EXTENSION. This is because once in production, an artefact cannot change in any way, or it must change the version. For cases where an artefact is not static, like during the drafting, the version must indicate this by including an EXTENSION. Draft artefacts should not be used outside of a specific system designed to accommodate them. For most purposes, all artefacts should become stable before being used in production. 545 545 546 -=== 4.3.3 Legacy-versioned artefacts === 547 +1. 548 +11. 549 +111. Legacy-versioned artefacts 547 547 548 548 Organisations wishing to keep a maximum of backwards compatibility with existing implementations can continue using the previous 2-digit convention for version numbers (MAJOR.MINOR) as in the past, such as '2.3', but without the ‘isFinal’ property. The new SDMX 3.0 standard does not add any strict rules or guarantees about changes in those artefacts, since the legacy versioning rules were rather loose and non-binding, including the meaning of the ‘isFinal’ property, and their implementations were varying. 549 549 550 550 In order to make artefacts immutable or changes truly predictable, a move to the new semantic versioning syntax is required. 551 551 552 -=== 4.3.4 Dependency management and references === 555 +1. 556 +11. 557 +111. Dependency management and references 553 553 554 554 New flexible dependency specifications with wildcarding allow for easier data model maintenance and enhancements for semantically versioned SDMX artefacts. This allows implementing a smart referencing mechanism, whereby an artefact may reference: 555 555 ... ... @@ -578,7 +578,8 @@ 578 578 579 579 Full details can be found in the SDMX RESTful web services specification. 580 580 581 -== 4.4 Structural Metadata Querying Best Practices == 586 +1. 587 +11. Structural Metadata Querying Best Practices 582 582 583 583 When querying for structural metadata, the ability to state how references should be resolved is quite powerful. However, this mechanism is not always necessary and can create an undue burden on the systems processing the queries if it is not used properly. 584 584 ... ... @@ -586,6 +586,7 @@ 586 586 587 587 When the referenced object is not known, then the reference resolution mechanism could be used. For example, suppose one wanted to find all category schemes and the related categorisations for a given maintenance agency. In this case, one could query for the category scheme by the maintenance agency and specify that parent and sibling references should be resolved. This would result in the categorisations which reference the categories in the matched schemes to be returned, as well as the object which they categorise. 588 588 595 + 589 589 ---- 590 590 591 591 [[~[1~]>>path:#_ftnref1]] Regular expressions, as specified in [[W3C XML Schema Definition Language (XSD)>>url:https://www.w3.org/TR/xmlschema11-2/]][[ >>url:https://www.w3.org/TR/xmlschema11-2/]][[1.1 Part 2: Datatypes>>url:https://www.w3.org/TR/xmlschema11-2/]][[.>>url:https://www.w3.org/TR/xmlschema11-2/]]