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**"[[^^~[1~]^^>>path:#_ftn1]] **for "string" type** 106 +|**SDMX Facet**|**XML Schema**|**JSON schema **"**pattern**"[[(% class="wikiinternallink" %)^^~[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)[[^^~[2~]^^>>path:#_ftn2]] 197 +Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss)[[(% class="wikiinternallink" %)^^~[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.[[^^~[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.[[(% class="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. 267 267 268 268 **Reporting Day**: 269 269 ... ... @@ -291,19 +291,19 @@ 291 291 292 292 This is the [REPORTING_YEAR_START_DATE] 293 293 294 -1. 294 +1. 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[[^^~[4~]^^>>path:#_ftn4]] (P3D, P2D, or P1D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE]. 298 +Add[[(% class="wikiinternallink" %)^^~[4~]^^>>path:#_ftn4]](%%) (P3D, P2D, or P1D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE]. 299 299 300 -1. 301 -11. 300 +1. 301 +11. 302 302 111. **If [REPORTING_YEAR_START_DATE] is a Monday, Tuesday, Wednesday, or Thursday:** 303 303 304 304 Add^^4^^ (P0D, -P1D, -P2D, or -P3D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE]. 305 305 306 -1. 306 +1. 307 307 11. **Else:** 308 308 309 309 The [REPORTING_YEAR_START_DATE] is the [REPORTING_YEAR_BASE]. ... ... @@ -390,9 +390,7 @@ 390 390 |GTP|Superset of all Gregorian Time Periods and date-time 391 391 |RTP|Superset of all Reporting Time Periods 392 392 |TR|((( 393 -Time Range: Start time and duration (YYYY-MM- 394 - 395 -DD(Thh:mm:ss)?/<duration>) 393 +Time Range: Start time and duration (YYYY-MM-DD(Thh:mm:ss)?/<duration>) 396 396 ))) 397 397 |GY|Gregorian Year (YYYY) 398 398 |GTM|Gregorian Year Month (YYYY-MM) ... ... @@ -406,7 +406,8 @@ 406 406 |RW|Reporting Week (YYYY-Www) 407 407 |RD|Reporting Day (YYYY-Dddd) 408 408 409 -==== Table 1: SDMX-ML Time Format Codes ==== 407 +(% class="wikigeneratedid" id="HTable1:SDMX-MLTimeFormatCodes" %) 408 +**Table 1: SDMX-ML Time Format Codes** 410 410 411 411 === 4.2.9 Time Zones === 412 412 ... ... @@ -501,9 +501,11 @@ 501 501 * 2010-M07 or later (any reporting year start day) 502 502 * 2010-W27 or later (reporting year start day ~-~-01-01)^^5^^ 503 503 * 2010-D182 or later (reporting year start day ~-~-01-01) 504 -* 2010-W28 or later (reporting year start day ~-~-07-01)^^6^^ • 2010-D185 or later (reporting year start day ~-~-07-01)505 -*1 .Versioning503 +* 2010-W28 or later (reporting year start day ~-~-07-01)^^6^^ 504 +* 2010-D185 or later (reporting year start day ~-~-07-01) 506 506 506 += 4.3 Versioning = 507 + 507 507 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". 508 508 509 509 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 ... ... @@ -512,15 +512,13 @@ 512 512 513 513 ‘1.0’. 514 514 515 -=== 4. 2.14Non-versioned artefacts ===516 +=== 4.3.1 Non-versioned artefacts === 516 516 517 517 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’. 518 518 519 519 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. 520 520 521 -1. 522 -11. 523 -111. Semantically versioned artefacts 522 +=== 4.3.2 Semantically versioned artefacts === 524 524 525 525 Since the purpose of SDMX versioning is to allow communicating the structural artefact changes to data exchange partners and connected systems, SDMX 3.0 offers Semantic Versioning (aka SemVer) with a clear and unambiguous syntax to all semantically versioned SDMX 3.0 structural artefacts. Semantic versioning will thus better respond to situations where the SDMX standard itself is the only structural contract between data providers and data consumers and where changes in structures can only be communicated through the version number increases. 526 526 ... ... @@ -544,17 +544,13 @@ 544 544 545 545 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. 546 546 547 -1. 548 -11. 549 -111. Legacy-versioned artefacts 546 +=== 4.3.3 Legacy-versioned artefacts === 550 550 551 551 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. 552 552 553 553 In order to make artefacts immutable or changes truly predictable, a move to the new semantic versioning syntax is required. 554 554 555 -1. 556 -11. 557 -111. Dependency management and references 552 +=== 4.3.4 Dependency management and references === 558 558 559 559 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: 560 560 ... ... @@ -583,8 +583,7 @@ 583 583 584 584 Full details can be found in the SDMX RESTful web services specification. 585 585 586 -1. 587 -11. Structural Metadata Querying Best Practices 581 +== 4.4 Structural Metadata Querying Best Practices == 588 588 589 589 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. 590 590 ... ... @@ -592,7 +592,6 @@ 592 592 593 593 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. 594 594 595 - 596 596 ---- 597 597 598 598 [[~[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/]]