Changes for page 4 General Notes for Implementers

Last modified by Helena on 2025/09/10 11:19

From 3.4 to 3.5 From 3.13 to 4.1

From version 3.5

edited by Helena
on 2025/05/15 23:47

Change comment: There is no comment for this version

To version 3.13

edited by Helena
on 2025/05/16 00:03

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -83,76 +83,47 @@
  For example, for the id type, this is the XML schema definition:
--<xs:simpleType name="IDType">
++> <xs:simpleType name="IDType">
++>   <xs:restriction base="NestedIDType">
++>     <xs:pattern value="[A-Za-z0-9_@$\-]+"/>
++>   </xs:restriction>
++> </xs:simpleType>
--<xs:restriction base="NestedIDType">
--
--<xs:pattern value="[A-Za-z0-9_@$\-]+"/>
--
--</xs:restriction>
--
--</xs:simpleType>
--
  Where the NestedIDType is also a restriction of string.
  The above looks like this, in JSON schema:
--"idType": {
++> "idType": {
++>   "type": "string",
++>   "pattern": "^[A-Za-z0-9_@$-]+$"
++> }
--"type": "string",
--
--"pattern": "^[A-Za-z0-9_@$-]+$"
--
--}
--
  There are also cases, though, that data types cannot be mapped like above. One such case is the array data type, which was introduced in SDMX 3.0 as a new representation. In JSON schema an array is already natively foreseen, while in the XML schema, this has to be defined as a complex type, with an SDMX specific definition (i.e., specific element/attribute names for SDMX). Beyond that, the minimum and/or maximum number of items within an array is possible in both cases.
  Further to the above, the mapping between the non-native data types is presented in the table below:
--|**SDMX Facet**|**XML Schema**|**JSON schema **"**pattern**"^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^1^^>>path:#sdfootnote1sym||name="sdfootnote1anc"]](%%)^^ **for "string" type**
--|GregorianYear|xsd:gYear|(((
--"^-?([1-9][0-9]{3,}|0[0-9]{3})(Z|(\+|-)((0[0-
--
--9]|1[0-3]):[0-5][0-9]|14:00))?$"
++(% style="width:1146.29px" %)
++|(% style="width:159px" %)**SDMX Facet**|(% style="width:179px" %)**XML Schema**|(% style="width:800px" %)**JSON schema **"**pattern**"{{footnote}}Regular expressions, as specified in W3C XML Schema Definition Language (XSD) 1.1 Part 2: Datatypes.{{/footnote}} **for "string" type**
++|(% style="width:159px" %)GregorianYear|(% style="width:179px" %)xsd:gYear|(% style="width:800px" %)(((
++"^-?( [1-9] [0-9] {3,}|0[0-9]{3}) (Z| (\ + | -) ((0 [0 - 9]| 1[0 - 3]):[0 - 5] [0 - 9] | 14:00))?$"
  )))
--|GregorianMonth|xsd:gYearMonth|(((
--"^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-
--
--2])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-
--
--9]|14:00))?$"
++|(% style="width:159px" %)GregorianMonth|(% style="width:179px" %)xsd:gYearMonth|(% style="width:800px" %)(((
++"^-?([1-9] [0-9] {3,}|0 [0-9] {3}) - (0 [1-9]|1[ 0- 2])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5] [0 - 9]|14:00))?$"
  )))
--
--[[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_59eee18f.gif||alt="Shape1" height="1" width="192"]]
--
--|GregorianDay|xsd:date|(((
--"^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-
--
--(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-
--
--3]):[0-5][0-9]|14:00))?$"
++|(% style="width:163px" %)GregorianDay|(% style="width:179px" %)xsd:date|(% style="width:800px" %)(((
++"^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])- (0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0- 3]):[0-5][0-9]|14:00))?$"
  )))
--|Day|xsd:gDay|(((
--"^~-~--(0[1-9]|[12][0-9]|3[01])(Z|(\+|-
--
--)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$"
++|(% style="width:163px" %)Day|(% style="width:179px" %)xsd:gDay|(% style="width:800px" %)(((
++"^~-~--(0[1-9]|[12][0-9]|3[01])(Z|(\+|- )((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$"
  )))
--|MonthDay|xsd:gMonthDay|(((
--"^~-~-(0[1-9]|1[0-2])-(0[1-9]|[12][0-
--
--9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-
--
--9]|14:00))?$"
++|(% style="width:163px" %)MonthDay|(% style="width:179px" %)xsd:gMonthDay|(% style="width:800px" %)(((
++"^~-~-(0[1-9]|1[0-2])-(0[1-9]|[12][0- 9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0- 9]|14:00))?$"
  )))
--|Month|xsd:Month|(((
--"^~-~-(0[1-9]|1[0-2])(Z|(\+|-)((0[0-9]|1[0-
--
--3]):[0-5][0-9]|14:00))?$"
++|(% style="width:163px" %)Month|(% style="width:179px" %)xsd:Month|(% style="width:800px" %)(((
++"^~-~-(0[1-9]|1[0-2])(Z|(\+|-)((0[0-9]|1[0- 3]):[0-5][0-9]|14:00))?$"
  )))
--|Duration|xsd:duration|(((
--"^-?P[0-9]+Y?([0-9]+M)?([0-9]+D)?(T([0-
--
--9]+H)?([0-9]+M)?([0-9]+(\.[0-9]+)?S)?)?$"
++|(% style="width:163px" %)Duration|(% style="width:179px" %)xsd:duration|(% style="width:800px" %)(((
++"^-?P[0-9]+Y?([0-9]+M)?([0-9]+D)?(T([0- 9]+H)?([0-9]+M)?([0-9]+(\.[0-9]+)?S)?)?$"
  )))
  == {{id name="_Toc291506"/}}4.2 Time and Time Format ==
@@ -167,17 +167,14 @@
  The hierarchy of time formats is as follows (**bold** indicates a category which is made up of multiple formats, //italic// indicates a distinct format):
--* **Observational Time Period **o **Standard Time Period**
++* **Observational Time Period**
++** **Standard Time Period**
++*** **Basic Time Period**
++**** **Gregorian Time Period**
++**** //Date Time//
++*** **Reporting Time Period**
++** **//Time Range//**
--▪ **Basic Time Period**
--
--* **Gregorian Time Period**
--* //Date Time//
--
--▪ **Reporting Time Period**
--
--o //Time Range//
--
  The details of these time period categories and of the distinct formats which make them up are detailed in the sections to follow.
  === {{id name="_Toc291508"/}}4.2.2 Observational Time Period ===
@@ -196,12 +196,16 @@
  Representation: xs:gYear (YYYY)
--Period: the start of January 1 to the end of December 31 **Gregorian Year Month**:
++Period: the start of January 1 to the end of December 31
++**Gregorian Year Month**:
++
  Representation: xs:gYearMonth (YYYY-MM)
--Period: the start of the first day of the month to end of the last day of the month **Gregorian Day**:
++Period: the start of the first day of the month to end of the last day of the month
++**Gregorian Day**:
++
  Representation: xs:date (YYYY-MM-DD)
  Period: the start of the day (00:00:00) to the end of the day (23:59:59)
@@ -210,7 +210,7 @@
  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.
--Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss)^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^
++Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss){{footnote}}The seconds can be reported fractionally{{/footnote}}
  === {{id name="_Toc291512"/}}4.2.6 Standard Reporting Period ===
@@ -234,8 +234,10 @@
  Limit per year: 1
--Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1) **Reporting Semester:**
++Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1)
++**Reporting Semester:**
++
  Period Indicator: S
  Period Duration: P6M (six months)
@@ -244,8 +244,6 @@
  Representation: common:ReportingSemesterType (YYYY-Ss, e.g. 2000-S2)
--[[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_59eee18f.gif||alt="Shape2" height="1" width="192"]]
--
  **Reporting Trimester:**
  Period Indicator: T
@@ -254,8 +254,10 @@
  Limit per year: 3
--Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3) **Reporting Quarter:**
++Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3)
++**Reporting Quarter:**
++
  Period Indicator: Q
  Period Duration: P3M (three months)
@@ -262,8 +262,10 @@
  Limit per year: 4
--Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4) **Reporting Month**:
++Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4)
++**Reporting Month**:
++
  Period Indicator: M
  Period Duration: P1M (one month)
@@ -284,7 +284,7 @@
  Representation: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53)
--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" %)^^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.
++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" %)^^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.
  **Reporting Day**:
@@ -318,19 +318,19 @@
  This is the [REPORTING_YEAR_START_DATE]
--1.
++1.
 . **If the [PERIOD_INDICATOR] is W:**
 . **If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday:**
--Add^^[[(% class="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].
++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].
--1.
--11.
++1.
++11.
 . **If [REPORTING_YEAR_START_DATE] is a Monday, Tuesday, Wednesday, or Thursday:**
  Add^^4^^ (P0D, -P1D, -P2D, or -P3D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE].
--1.
++1.
 . **Else:**
  The [REPORTING_YEAR_START_DATE] is the [REPORTING_YEAR_BASE].
@@ -345,8 +345,10 @@
 . If the [PERIOD_INDICATOR] is D, the [PERIOD_DURATION] is P1D.
 . **Determine [PERIOD_START]:**
--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]:**
++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]:**
++
  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].
  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).
@@ -411,29 +411,29 @@
  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.
--|Code|Format
--|OTP|Observational Time Period: Superset of all SDMX time formats (Gregorian Time Period, Reporting Time Period, and Time Range)
--|STP|Standard Time Period: Superset of Gregorian and Reporting Time Periods
--|GTP|Superset of all Gregorian Time Periods and date-time
--|RTP|Superset of all Reporting Time Periods
--|TR|(((
--Time Range: Start time and duration (YYYY-MM-
--
--DD(Thh:mm:ss)?/<duration>)
++(% style="width:771.294px" %)
++|Code|(% style="width:659px" %)Format
++|OTP|(% style="width:659px" %)Observational Time Period: Superset of all SDMX time formats (Gregorian Time Period, Reporting Time Period, and Time Range)
++|STP|(% style="width:659px" %)Standard Time Period: Superset of Gregorian and Reporting Time Periods
++|GTP|(% style="width:659px" %)Superset of all Gregorian Time Periods and date-time
++|RTP|(% style="width:659px" %)Superset of all Reporting Time Periods
++|TR|(% style="width:659px" %)(((
++Time Range: Start time and duration (YYYY-MM-DD(Thh:mm:ss)?/<duration>)
  )))
--|GY|Gregorian Year (YYYY)
--|GTM|Gregorian Year Month (YYYY-MM)
--|GD|Gregorian Day (YYYY-MM-DD)
--|DT|Distinct Point: date-time (YYYY-MM-DDThh:mm:ss)
--|RY|Reporting Year (YYYY-A1)
--|RS|Reporting Semester (YYYY-Ss)
--|RT|Reporting Trimester (YYYY-Tt)
--|RQ|Reporting Quarter (YYYY-Qq)
--|RM|Reporting Month (YYYY-Mmm)
--|RW|Reporting Week (YYYY-Www)
--|RD|Reporting Day (YYYY-Dddd)
++|GY|(% style="width:659px" %)Gregorian Year (YYYY)
++|GTM|(% style="width:659px" %)Gregorian Year Month (YYYY-MM)
++|GD|(% style="width:659px" %)Gregorian Day (YYYY-MM-DD)
++|DT|(% style="width:659px" %)Distinct Point: date-time (YYYY-MM-DDThh:mm:ss)
++|RY|(% style="width:659px" %)Reporting Year (YYYY-A1)
++|RS|(% style="width:659px" %)Reporting Semester (YYYY-Ss)
++|RT|(% style="width:659px" %)Reporting Trimester (YYYY-Tt)
++|RQ|(% style="width:659px" %)Reporting Quarter (YYYY-Qq)
++|RM|(% style="width:659px" %)Reporting Month (YYYY-Mmm)
++|RW|(% style="width:659px" %)Reporting Week (YYYY-Www)
++|RD|(% style="width:659px" %)Reporting Day (YYYY-Dddd)
--==== Table 1: SDMX-ML Time Format Codes ====
++(% class="wikigeneratedid" id="HTable1:SDMX-MLTimeFormatCodes" %)
++Table 1: SDMX-ML Time Format Codes
  === {{id name="_Toc291515"/}}4.2.9 Time Zones ===
@@ -480,12 +480,13 @@
  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.
--|**Operator**|**Rule**
--|Greater Than|Any data after the last moment of the period
--|Less Than|Any data before the first moment of the period
--|Greater Than or Equal To|Any data on or after the first moment of the period
--|Less Than or Equal To|Any data on or before the last moment of the period
--|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
++(% style="width:1020.29px" %)
++|(% style="width:236px" %)**Operator**|(% style="width:781px" %)**Rule**
++|(% style="width:236px" %)Greater Than|(% style="width:781px" %)Any data after the last moment of the period
++|(% style="width:236px" %)Less Than|(% style="width:781px" %)Any data before the first moment of the period
++|(% style="width:236px" %)Greater Than or Equal To|(% style="width:781px" %)Any data on or after the first moment of the period
++|(% style="width:236px" %)Less Than or Equal To|(% style="width:781px" %)Any data on or before the last moment of the period
++|(% 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
  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.
@@ -534,7 +534,7 @@
  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".
--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’.
++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’.
  === 4.3.1 Non-versioned artefacts ===
@@ -542,8 +542,6 @@
  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.
--[[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_59eee18f.gif||alt="Shape3" height="1" width="192"]]
--
 -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.
 -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.
@@ -614,3 +614,5 @@
  Any structural metadata object which contains a reference to an object can be queried based on that reference. For example, a categorisation references both a category and the object is it categorising. As this is the case, one can query for categorisations which categorise a particular object or which categorise against a particular category or category scheme. This mechanism should be used when the referenced object is known.
  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.
++
++{{putFootnotes/}}