Changes for page 4 General Notes for Implementers

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

From 3.2 to 3.1 From 3.13 to 3.12

From version 3.12

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

Change comment: There is no comment for this version

To version 3.2

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

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -32,47 +32,78 @@
  There are also a number of SDMX-ML data types which do not have these direct correspondences, often because they are composite representations or restrictions of a broader data type. For most of these, there are simple types which can be referenced from the SDMX schemas, for others a derived simple type will be necessary:
--* AlphaNumeric (common:AlphaNumericType, string which only allows A-z and 0-9)
--* Alpha (common:AlphaType, string which only allows A-z)
--* Numeric (common:NumericType, string which only allows 0-9, but is not numeric so that is can having leading zeros)
--* Count (xs:integer, a sequence with an interval of "1")
--* InclusiveValueRange (xs:decimal with the minValue and maxValue facets supplying the bounds)
--* ExclusiveValueRange (xs:decimal with the minValue and maxValue facets supplying the bounds)
--* Incremental (xs:decimal with a specified interval; the interval is typically enforced outside of the XML validation)
--* TimeRange (common:TimeRangeType, startDateTime + Duration)
--* ObservationalTimePeriod (common:ObservationalTimePeriodType, a union of StandardTimePeriod and TimeRange).
--* StandardTimePeriod (common:StandardTimePeriodType, a union of BasicTimePeriod and ReportingTimePeriod).
--* BasicTimePeriod (common:BasicTimePeriodType, a union of GregorianTimePeriod and DateTime)
--* GregorianTimePeriod (common:GregorianTimePeriodType, a union of GregorianYear, GregorianMonth, and GregorianDay)
--* ReportingTimePeriod (common:ReportingTimePeriodType, a union of ReportingYear, ReportingSemester, ReportingTrimester, ReportingQuarter, ReportingMonth, ReportingWeek, and ReportingDay).
--* ReportingYear (common:ReportingYearType)
--* ReportingSemester (common:ReportingSemesterType)
--* ReportingTrimester (common:ReportingTrimesterType)
--* ReportingQuarter (common:ReportingQuarterType)
--* ReportingMonth (common:ReportingMonthType)
--* ReportingWeek (common:ReportingWeekType)
--* ReportingDay (common:ReportingDayType)
--* XHTML (common:StructuredText, allows for multi-lingual text content that has XHTML markup)
--* KeyValues (common:DataKeyType)
--* IdentifiableReference (types for each IdentifiableObject)
--* GeospatialInformation (a geo feature set, according to the pattern in section 7.2)
++• **AlphaNumeric** (**common:AlphaNumericType**, string which only allows A-z and 0-9)
++• **Alpha** (**common:AlphaType**, string which only allows A-z)
++
++• ,,**Numeric**,, (,,**common:NumericType**,,, string which only allows 0-9, but is not numeric so that is can having leading zeros)
++
++• ,,**Count**,, (,,**xs:integer**,,, a sequence with an interval of "1")
++
++• **InclusiveValueRange** (**xs:decimal** with the **minValue** and **maxValue** facets supplying the bounds)
++
++• **ExclusiveValueRange** (**xs:decimal** with the **minValue** and **maxValue** facets supplying the bounds)
++
++• **Incremental** (**xs:decimal** with a specified **interval**; the interval is typically enforced outside of the XML validation)
++
++• **TimeRange** (**common:TimeRangeType**, **startDateTime** + **Duration**)
++
++• **ObservationalTimePeriod** (**common:ObservationalTimePeriodType**, a union of **StandardTimePeriod** and **TimeRange**).
++
++• **StandardTimePeriod** (**common:StandardTimePeriodType**, a union of **BasicTimePeriod** and **ReportingTimePeriod**).
++
++• **BasicTimePeriod** (**common:BasicTimePeriodType**, a union of **GregorianTimePeriod** and **DateTime**)
++
++• **GregorianTimePeriod** (**common:GregorianTimePeriodType**, a union of **GregorianYear**, **GregorianMonth**, and **GregorianDay**)
++
++• **ReportingTimePeriod** (**common:ReportingTimePeriodType**, a union of **ReportingYear**, **ReportingSemester**, **ReportingTrimester**, **ReportingQuarter**, **ReportingMonth**, **ReportingWeek**, and **ReportingDay**).
++
++• **ReportingYear** (**common:ReportingYearType**)
++
++• **ReportingSemester** (**common:ReportingSemesterType**)
++
++• **ReportingTrimester** (**common:ReportingTrimesterType**)
++
++• **ReportingQuarter** (**common:ReportingQuarterType**)
++
++• **ReportingMonth** (**common:ReportingMonthType**)
++
++• **ReportingWeek** (**common:ReportingWeekType**)
++
++• **ReportingDay** (**common:ReportingDayType**)
++
++• ,,**XHTML**,, (,,**common:StructuredText**,,, allows for multi-lingual text content that has ,,**XHTML**,, markup)
++
++• **KeyValues** (**common:DataKeyType**)
++
++• ,,**IdentifiableReference**,, (types for each IdentifiableObject)
++
++• ,,**GeospatialInformation**,, (a geo feature set, according to the pattern in section 7.2)
++
  Data types also have a set of facets:
--* isSequence = true | false (indicates a sequentially increasing value)
--* minLength = positive integer (# of characters/digits)
--* maxLength = positive integer (# of characters/digits)
--* startValue = decimal (for numeric sequence)
--* endValue = decimal (for numeric sequence)
--* interval = decimal (for numeric sequence)
--* timeInterval = duration
--* startTime = BasicTimePeriod (for time range) endTime = BasicTimePeriod (for time range)
--* minValue = decimal (for numeric range)
--* maxValue = decimal (for numeric range)
--* decimal = Integer (# of digits to right of decimal point)
--* pattern = (a regular expression, as per W3C XML Schema)
--* isMultiLingual = boolean (for specifying text can occur in more than one language)
++• ,,**isSequence = true | false**,, (indicates a sequentially increasing value)
++• ,,**minLength = positive integer**,, (# of characters/digits)
++
++• ,,**maxLength = positive integer**,, (# of characters/digits)
++
++• ,,**startValue = decimal**,, (for numeric sequence)
++
++• ,,**endValue = decimal**,, (for numeric sequence)
++
++• ,,**interval = decimal**,, (for numeric sequence)
++
++• **timeInterval = duration**
++
++• **startTime = BasicTimePer,,iod,,** (for time range) ,,**endTime = BasicTimePeriod**,, (for time range)
++
++* ,,**minValue = decimal**,, (for numeric range)
++* ,,**maxValue = decimal**,, (for numeric range)
++* ,,**decimal = Integer**,, (# of digits to right of decimal point)
++* ,,**pattern =**,, (a regular expression, as per W3C XML Schema)
++* ,,**isMultiLingual = boolean**,, (for specifying text can occur in more than one language)
++
  Note that code lists may also have textual representations assigned to them, in addition to their enumeration of codes.
  === {{id name="_Toc291505"/}}4.1.1 Data Types ===
@@ -83,47 +83,76 @@
  For example, for the id type, this is the XML schema definition:
--> <xs:simpleType name="IDType">
-->   <xs:restriction base="NestedIDType">
-->     <xs:pattern value="[A-Za-z0-9_@$\-]+"/>
-->   </xs:restriction>
--> </xs:simpleType>
++<xs:simpleType name="IDType">
++<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": {
-->   "type": "string",
-->   "pattern": "^[A-Za-z0-9_@$-]+$"
--> }
++"idType": {
++"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:
--(% 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))?$"
++|**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: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))?$"
++|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: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))?$"
++
++[[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" %)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))?$"
++|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" %)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))?$"
++|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" %)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))?$"
++|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" %)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)?)?$"
++|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)?)?$"
  )))
  == {{id name="_Toc291506"/}}4.2 Time and Time Format ==
@@ -138,14 +138,17 @@
  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**
--** **Standard Time Period**
--*** **Basic Time Period**
--**** **Gregorian Time Period**
--**** //Date Time//
--*** **Reporting Time Period**
--** **//Time Range//**
++* **Observational Time Period **o **Standard Time Period**
++▪ **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 ===
@@ -164,16 +164,12 @@
  Representation: xs:gYear (YYYY)
--Period: the start of January 1 to the end of December 31
++Period: the start of January 1 to the end of December 31 **Gregorian Year Month**:
--**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
++Period: the start of the first day of the month to end of the last day of the month **Gregorian Day**:
--**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)
@@ -182,7 +182,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){{footnote}}The seconds can be reported fractionally{{/footnote}}
++Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss)^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^
  === {{id name="_Toc291512"/}}4.2.6 Standard Reporting Period ===
@@ -206,10 +206,8 @@
  Limit per year: 1
--Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1)
++Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1) **Reporting Semester:**
--**Reporting Semester:**
--
  Period Indicator: S
  Period Duration: P6M (six months)
@@ -218,6 +218,8 @@
  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
@@ -226,10 +226,8 @@
  Limit per year: 3
--Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3)
++Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3) **Reporting Quarter:**
--**Reporting Quarter:**
--
  Period Indicator: Q
  Period Duration: P3M (three months)
@@ -236,10 +236,8 @@
  Limit per year: 4
--Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4)
++Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4) **Reporting Month**:
--**Reporting Month**:
--
  Period Indicator: M
  Period Duration: P1M (one month)
@@ -260,7 +260,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 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.
++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.
  **Reporting Day**:
@@ -298,7 +298,7 @@
 . **If the [PERIOD_INDICATOR] is W:**
 . **If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday:**
--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].
++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].
 .
 .
@@ -590,5 +590,3 @@
  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/}}