Changes for page 4 General Notes for Implementers
Last modified by Helena on 2025/09/10 11:19
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -2,13 +2,13 @@ 2 2 {{toc/}} 3 3 {{/box}} 4 4 5 -This section discusses a number of topics other than the exchange of [[data sets>>doc:xwiki:Glossary.Dataset.WebHome]]in[[SDMX>>doc:xwiki:Glossary.Statisticaldata and metadata exchange.WebHome]]formats. Supported only in[[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]](and some in[[SDMX-JSON>>doc:xwiki:Glossary.SDMX-JSON.WebHome]]), these topics include the use of the[[reference metadata>>doc:xwiki:Glossary.Referencemetadata.WebHome]] mechanism in[[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]], the use of[[Structure Sets>>doc:xwiki:Glossary.Structureset.WebHome]]and[[Reporting Taxonomies>>doc:xwiki:Glossary.Reporting taxonomy.WebHome]], the use of Processes, a discussion of time and datatyping, and the conventional mechanisms within the[[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]]Structure message regarding versioning and referencing.5 +This section discusses a number of topics other than the exchange of data sets in SDMX formats. Supported only in SDMX-ML (and some in SDMX-JSON), these topics include the use of the reference metadata mechanism in SDMX, the use of Structure Sets and Reporting Taxonomies, the use of Processes, a discussion of time and datatyping, and the conventional mechanisms within the SDMX-ML Structure message regarding versioning and referencing. 6 6 7 7 == {{id name="_Toc291504"/}}4.1 Representations == 8 8 9 9 This section does not go into great detail on these topics but provides a useful overview of these features to assist implementors in further use of the parts of the specification which are relevant to them. 10 10 11 -There are several different [[representations>>doc:xwiki:Glossary.Representation.WebHome]]in[[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]], taken from XML Schemas and common programming languages. The table below describes the various[[representations>>doc:xwiki:Glossary.Representation.WebHome]], which are found in[[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]], and their equivalents.11 +There are several different representations in SDMX-ML, taken from XML Schemas and common programming languages. The table below describes the various representations, which are found in SDMX-ML, and their equivalents. 12 12 13 13 (% style="width:1185.29px" %) 14 14 |(% style="width:250px" %)**SDMX-ML Data Type**|(% style="width:285px" %)**XML Schema Data Type**|(% style="width:271px" %)**.NET Framework Type**|(% style="width:354px" %)**Java Data Type** ... ... @@ -30,100 +30,160 @@ 30 30 |(% style="width:250px" %)Day, MonthDay, Month|(% style="width:285px" %)xsd:g*|(% style="width:271px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar 31 31 |(% style="width:250px" %)Duration|(% style="width:285px" %)xsd:duration|(% style="width:271px" %)System.TimeSpan|(% style="width:354px" %)javax.xml.datatype.Dura tion 32 32 33 -There are also a number of [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]]data types which do not have these direct correspondences, often because they are composite[[representations>>doc:xwiki:Glossary.Representation.WebHome]]or restrictions of a broader data type. For most of these, there are simple types which can be referenced from the[[SDMX>>doc:xwiki:Glossary.Statisticaldata and metadata exchange.WebHome]]schemas, for others a derived simple type will be necessary:33 +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: 34 34 35 -* AlphaNumeric (common:AlphaNumericType, string which only allows A-z and 0-9) 36 -* Alpha (common:AlphaType, string which only allows A-z) 37 -* Numeric (common:NumericType, string which only allows 0-9, but is not numeric so that is can having leading zeros) 38 -* Count (xs:integer, a sequence with an interval of "1") 39 -* InclusiveValueRange (xs:decimal with the minValue and maxValue facets supplying the bounds) 40 -* ExclusiveValueRange (xs:decimal with the minValue and maxValue [[facets>>doc:xwiki:Glossary.Facet.WebHome]] supplying the bounds) 41 -* Incremental (xs:decimal with a specified interval; the interval is typically enforced outside of the XML validation) 42 -* TimeRange (common:TimeRangeType, startDateTime + Duration) 43 -* ObservationalTimePeriod (common:ObservationalTimePeriodType, a union of StandardTimePeriod and TimeRange). 44 -* StandardTimePeriod (common:StandardTimePeriodType, a union of BasicTimePeriod and ReportingTimePeriod). 45 -* BasicTimePeriod (common:BasicTimePeriodType, a union of GregorianTimePeriod and DateTime) 46 -* GregorianTimePeriod (common:GregorianTimePeriodType, a union of GregorianYear, GregorianMonth, and GregorianDay) 47 -* ReportingTimePeriod (common:ReportingTimePeriodType, a union of ReportingYear, ReportingSemester, ReportingTrimester, ReportingQuarter, ReportingMonth, ReportingWeek, and ReportingDay). 48 -* ReportingYear (common:ReportingYearType) 49 -* ReportingSemester (common:ReportingSemesterType) 50 -* ReportingTrimester (common:ReportingTrimesterType) 51 -* ReportingQuarter (common:ReportingQuarterType) 52 -* ReportingMonth (common:ReportingMonthType) 53 -* ReportingWeek (common:ReportingWeekType) 54 -* ReportingDay (common:ReportingDayType) 55 -* XHTML (common:StructuredText, allows for multi-lingual text content that has XHTML markup) 56 -* KeyValues (common:DataKeyType) 57 -* IdentifiableReference (types for each IdentifiableObject) 58 -* GeospatialInformation (a geo feature set, according to the pattern in section 7.2) 35 +• **AlphaNumeric** (**common:AlphaNumericType**, string which only allows A-z and 0-9) 59 59 60 - Datatypesalsohaveasetof [[facets>>doc:xwiki:Glossary.Facet.WebHome]]:37 +• **Alpha** (**common:AlphaType**, string which only allows A-z) 61 61 62 -* isSequence = true | false (indicates a sequentially increasing value) 63 -* minLength = positive integer (# of characters/digits) 64 -* maxLength = positive integer (# of characters/digits) 65 -* startValue = [[decimal>>doc:xwiki:Glossary.Decimals.WebHome]] (for numeric sequence) 66 -* endValue = [[decimal>>doc:xwiki:Glossary.Decimals.WebHome]] (for numeric sequence) 67 -* interval = [[decimal>>doc:xwiki:Glossary.Decimals.WebHome]] (for numeric sequence) 68 -* timeInterval = duration 69 -* startTime = BasicTimePeriod (for time range) endTime = BasicTimePeriod (for time range) 70 -* minValue = [[decimal>>doc:xwiki:Glossary.Decimals.WebHome]] (for numeric range) 71 -* maxValue = [[decimal>>doc:xwiki:Glossary.Decimals.WebHome]] (for numeric range) 72 -* [[decimal>>doc:xwiki:Glossary.Decimals.WebHome]] = Integer (# of digits to right of [[decimal>>doc:xwiki:Glossary.Decimals.WebHome]] point) 73 -* pattern = (a regular expression, as per W3C XML Schema) 74 -* isMultiLingual = boolean (for specifying text can occur in more than one language) 39 +• ,,**Numeric**,, (,,**common:NumericType**,,, string which only allows 0-9, but is not numeric so that is can having leading zeros) 75 75 76 - Notethat [[code lists>>doc:xwiki:Glossary.Code list.WebHome]]mayalso havetextual [[representations>>doc:xwiki:Glossary.Representation.WebHome]]assignedto them,inadditionto theirenumerationof[[codes>>doc:xwiki:Glossary.Code.WebHome]].41 +• ,,**Count**,, (,,**xs:integer**,,, a sequence with an interval of "1") 77 77 43 +• **InclusiveValueRange** (**xs:decimal** with the **minValue** and **maxValue** facets supplying the bounds) 44 + 45 +• **ExclusiveValueRange** (**xs:decimal** with the **minValue** and **maxValue** facets supplying the bounds) 46 + 47 +• **Incremental** (**xs:decimal** with a specified **interval**; the interval is typically enforced outside of the XML validation) 48 + 49 +• **TimeRange** (**common:TimeRangeType**, **startDateTime** + **Duration**) 50 + 51 +• **ObservationalTimePeriod** (**common:ObservationalTimePeriodType**, a union of **StandardTimePeriod** and **TimeRange**). 52 + 53 +• **StandardTimePeriod** (**common:StandardTimePeriodType**, a union of **BasicTimePeriod** and **ReportingTimePeriod**). 54 + 55 +• **BasicTimePeriod** (**common:BasicTimePeriodType**, a union of **GregorianTimePeriod** and **DateTime**) 56 + 57 +• **GregorianTimePeriod** (**common:GregorianTimePeriodType**, a union of **GregorianYear**, **GregorianMonth**, and **GregorianDay**) 58 + 59 +• **ReportingTimePeriod** (**common:ReportingTimePeriodType**, a union of **ReportingYear**, **ReportingSemester**, **ReportingTrimester**, **ReportingQuarter**, **ReportingMonth**, **ReportingWeek**, and **ReportingDay**). 60 + 61 +• **ReportingYear** (**common:ReportingYearType**) 62 + 63 +• **ReportingSemester** (**common:ReportingSemesterType**) 64 + 65 +• **ReportingTrimester** (**common:ReportingTrimesterType**) 66 + 67 +• **ReportingQuarter** (**common:ReportingQuarterType**) 68 + 69 +• **ReportingMonth** (**common:ReportingMonthType**) 70 + 71 +• **ReportingWeek** (**common:ReportingWeekType**) 72 + 73 +• **ReportingDay** (**common:ReportingDayType**) 74 + 75 +• ,,**XHTML**,, (,,**common:StructuredText**,,, allows for multi-lingual text content that has ,,**XHTML**,, markup) 76 + 77 +• **KeyValues** (**common:DataKeyType**) 78 + 79 +• ,,**IdentifiableReference**,, (types for each IdentifiableObject) 80 + 81 +• ,,**GeospatialInformation**,, (a geo feature set, according to the pattern in section 7.2) 82 + 83 +Data types also have a set of facets: 84 + 85 +• ,,**isSequence = true | false**,, (indicates a sequentially increasing value) 86 + 87 +• ,,**minLength = positive integer**,, (# of characters/digits) 88 + 89 +• ,,**maxLength = positive integer**,, (# of characters/digits) 90 + 91 +• ,,**startValue = decimal**,, (for numeric sequence) 92 + 93 +• ,,**endValue = decimal**,, (for numeric sequence) 94 + 95 +• ,,**interval = decimal**,, (for numeric sequence) 96 + 97 +• **timeInterval = duration** 98 + 99 +• **startTime = BasicTimePer,,iod,,** (for time range) ,,**endTime = BasicTimePeriod**,, (for time range) 100 + 101 +* ,,**minValue = decimal**,, (for numeric range) 102 +* ,,**maxValue = decimal**,, (for numeric range) 103 +* ,,**decimal = Integer**,, (# of digits to right of decimal point) 104 +* ,,**pattern =**,, (a regular expression, as per W3C XML Schema) 105 +* ,,**isMultiLingual = boolean**,, (for specifying text can occur in more than one language) 106 + 107 +Note that code lists may also have textual representations assigned to them, in addition to their enumeration of codes. 108 + 78 78 === {{id name="_Toc291505"/}}4.1.1 Data Types === 79 79 80 -XML and JSON schemas support a variety of data types that, although rich, are not (% style="color:#2ecc71" %)mapped(%%)one-to-one in all cases. This section provides an explanation of the mapping performed in[[SDMX>>doc:xwiki:Glossary.Statisticaldata and metadata exchange.WebHome]]3.0, between such cases.111 +XML and JSON schemas support a variety of data types that, although rich, are not mapped one-to-one in all cases. This section provides an explanation of the mapping performed in SDMX 3.0, between such cases. 81 81 82 -For identifiers, text fields and [[Codes>>doc:xwiki:Glossary.Code.WebHome]]there are no restriction from either side, since a generic type (e.g., that of string) accompanied by the proper regular expression works equally well for both XML and JSON.113 +For identifiers, text fields and Codes there are no restriction from either side, since a generic type (e.g., that of string) accompanied by the proper regular expression works equally well for both XML and JSON. 83 83 84 84 For example, for the id type, this is the XML schema definition: 85 85 86 -> <xs:simpleType name="IDType"> 87 -> <xs:restriction base="NestedIDType"> 88 -> <xs:pattern value="[A-Za-z0-9_@$\-]+"/> 89 -> </xs:restriction> 90 -> </xs:simpleType> 117 +<xs:simpleType name="IDType"> 91 91 119 +<xs:restriction base="NestedIDType"> 120 + 121 +<xs:pattern value="[A-Za-z0-9_@$\-]+"/> 122 + 123 +</xs:restriction> 124 + 125 +</xs:simpleType> 126 + 92 92 Where the NestedIDType is also a restriction of string. 93 93 94 94 The above looks like this, in JSON schema: 95 95 96 -> "idType": { 97 -> "type": "string", 98 -> "pattern": "^[A-Za-z0-9_@$-]+$" 99 -> } 131 +"idType": { 100 100 133 +"type": "string", 134 + 135 +"pattern": "^[A-Za-z0-9_@$-]+$" 136 + 137 +} 138 + 101 101 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. 102 102 103 103 Further to the above, the mapping between the non-native data types is presented in the table below: 104 104 105 -(% style="width:1146.29px" %) 106 -|(% 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** 107 -|(% style="width:159px" %)GregorianYear|(% style="width:179px" %)xsd:gYear|(% style="width:800px" %)((( 108 -"^-?( [1-9] [0-9] {3,}|0[0-9]{3}) (Z| (\ + | -) ((0 [0 - 9]| 1[0 - 3]):[0 - 5] [0 - 9] | 14:00))?$" 143 +|**SDMX Facet**|**XML Schema**|**JSON schema **"**pattern**"^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^1^^>>path:#sdfootnote1sym||name="sdfootnote1anc"]](%%)^^ **for "string" type** 144 +|GregorianYear|xsd:gYear|((( 145 +"^-?([1-9][0-9]{3,}|0[0-9]{3})(Z|(\+|-)((0[0- 146 + 147 +9]|1[0-3]):[0-5][0-9]|14:00))?$" 109 109 ))) 110 -|(% style="width:159px" %)GregorianMonth|(% style="width:179px" %)xsd:gYearMonth|(% style="width:800px" %)((( 111 -"^-?([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))?$" 149 +|GregorianMonth|xsd:gYearMonth|((( 150 +"^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0- 151 + 152 +2])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0- 153 + 154 +9]|14:00))?$" 112 112 ))) 113 -|(% style="width:163px" %)GregorianDay|(% style="width:179px" %)xsd:date|(% style="width:800px" %)((( 114 -"^-?([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))?$" 156 + 157 +[[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_59eee18f.gif||alt="Shape1" height="1" width="192"]] 158 + 159 +|GregorianDay|xsd:date|((( 160 +"^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])- 161 + 162 +(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0- 163 + 164 +3]):[0-5][0-9]|14:00))?$" 115 115 ))) 116 -|(% style="width:163px" %)Day|(% style="width:179px" %)xsd:gDay|(% style="width:800px" %)((( 117 -"^~-~--(0[1-9]|[12][0-9]|3[01])(Z|(\+|- )((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$" 166 +|Day|xsd:gDay|((( 167 +"^~-~--(0[1-9]|[12][0-9]|3[01])(Z|(\+|- 168 + 169 +)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$" 118 118 ))) 119 -|(% style="width:163px" %)MonthDay|(% style="width:179px" %)xsd:gMonthDay|(% style="width:800px" %)((( 120 -"^~-~-(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))?$" 171 +|MonthDay|xsd:gMonthDay|((( 172 +"^~-~-(0[1-9]|1[0-2])-(0[1-9]|[12][0- 173 + 174 +9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0- 175 + 176 +9]|14:00))?$" 121 121 ))) 122 -|(% style="width:163px" %)Month|(% style="width:179px" %)xsd:Month|(% style="width:800px" %)((( 123 -"^~-~-(0[1-9]|1[0-2])(Z|(\+|-)((0[0-9]|1[0- 3]):[0-5][0-9]|14:00))?$" 178 +|Month|xsd:Month|((( 179 +"^~-~-(0[1-9]|1[0-2])(Z|(\+|-)((0[0-9]|1[0- 180 + 181 +3]):[0-5][0-9]|14:00))?$" 124 124 ))) 125 -|(% style="width:163px" %)Duration|(% style="width:179px" %)xsd:duration|(% style="width:800px" %)((( 126 -"^-?P[0-9]+Y?([0-9]+M)?([0-9]+D)?(T([0- 9]+H)?([0-9]+M)?([0-9]+(\.[0-9]+)?S)?)?$" 183 +|Duration|xsd:duration|((( 184 +"^-?P[0-9]+Y?([0-9]+M)?([0-9]+D)?(T([0- 185 + 186 +9]+H)?([0-9]+M)?([0-9]+(\.[0-9]+)?S)?)?$" 127 127 ))) 128 128 129 129 == {{id name="_Toc291506"/}}4.2 Time and Time Format == ... ... @@ -138,14 +138,17 @@ 138 138 139 139 The hierarchy of time formats is as follows (**bold** indicates a category which is made up of multiple formats, //italic// indicates a distinct format): 140 140 141 -* **Observational Time Period** 142 -** **Standard Time Period** 143 -*** **Basic Time Period** 144 -**** **Gregorian Time Period** 145 -**** //Date Time// 146 -*** **Reporting Time Period** 147 -** **//Time Range//** 201 +* **Observational Time Period **o **Standard Time Period** 148 148 203 +▪ **Basic Time Period** 204 + 205 +* **Gregorian Time Period** 206 +* //Date Time// 207 + 208 +▪ **Reporting Time Period** 209 + 210 +o //Time Range// 211 + 149 149 The details of these time period categories and of the distinct formats which make them up are detailed in the sections to follow. 150 150 151 151 === {{id name="_Toc291508"/}}4.2.2 Observational Time Period === ... ... @@ -164,16 +164,12 @@ 164 164 165 165 Representation: xs:gYear (YYYY) 166 166 167 -Period: the start of January 1 to the end of December 31 230 +Period: the start of January 1 to the end of December 31 **Gregorian Year Month**: 168 168 169 -**Gregorian Year Month**: 170 - 171 171 Representation: xs:gYearMonth (YYYY-MM) 172 172 173 -Period: the start of the first day of the month to end of the last day of the month 234 +Period: the start of the first day of the month to end of the last day of the month **Gregorian Day**: 174 174 175 -**Gregorian Day**: 176 - 177 177 Representation: xs:date (YYYY-MM-DD) 178 178 179 179 Period: the start of the day (00:00:00) to the end of the day (23:59:59) ... ... @@ -182,7 +182,7 @@ 182 182 183 183 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. 184 184 185 -Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss) {{footnote}}Theseconds canbereportedfractionally{{/footnote}}244 +Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss)^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^ 186 186 187 187 === {{id name="_Toc291512"/}}4.2.6 Standard Reporting Period === 188 188 ... ... @@ -206,10 +206,8 @@ 206 206 207 207 Limit per year: 1 208 208 209 -Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1) 268 +Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1) **Reporting Semester:** 210 210 211 -**Reporting Semester:** 212 - 213 213 Period Indicator: S 214 214 215 215 Period Duration: P6M (six months) ... ... @@ -218,6 +218,8 @@ 218 218 219 219 Representation: common:ReportingSemesterType (YYYY-Ss, e.g. 2000-S2) 220 220 278 +[[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_59eee18f.gif||alt="Shape2" height="1" width="192"]] 279 + 221 221 **Reporting Trimester:** 222 222 223 223 Period Indicator: T ... ... @@ -226,10 +226,8 @@ 226 226 227 227 Limit per year: 3 228 228 229 -Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3) 288 +Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3) **Reporting Quarter:** 230 230 231 -**Reporting Quarter:** 232 - 233 233 Period Indicator: Q 234 234 235 235 Period Duration: P3M (three months) ... ... @@ -236,10 +236,8 @@ 236 236 237 237 Limit per year: 4 238 238 239 -Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4) 296 +Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4) **Reporting Month**: 240 240 241 -**Reporting Month**: 242 - 243 243 Period Indicator: M 244 244 245 245 Period Duration: P1M (one month) ... ... @@ -260,7 +260,7 @@ 260 260 261 261 Representation: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53) 262 262 263 -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 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.318 +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. 264 264 265 265 **Reporting Day**: 266 266 ... ... @@ -280,38 +280,49 @@ 280 280 281 281 (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. 282 282 283 -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]):338 +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 284 284 285 - **~1.Determine[REPORTING_YEAR_BASE]:**340 +Gregorian calendar period covered by the reporting period can be computed as follows 286 286 342 +(based on the standard format of [REPROTING_YEAR]- 343 + 344 +[PERIOD_INDICATOR][PERIOD_VALUE] and the reporting year start day as [REPORTING_YEAR_START_DAY]): 345 + 346 +1. **Determine [REPORTING_YEAR_BASE]:** 347 + 287 287 Combine [REPORTING_YEAR] of the reporting period value (YYYY) with [REPORTING_YEAR_START_DAY] (MM-DD) to get a date (YYYY-MM-DD). 349 + 288 288 This is the [REPORTING_YEAR_START_DATE] 289 289 290 -**a) If the [PERIOD_INDICATOR] is W:** 352 +1. 353 +11. **If the [PERIOD_INDICATOR] is W:** 354 +111. **If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday:** 291 291 292 - ~1. **If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday**: 293 - 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]. 356 +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]. 294 294 295 -**~ 2. If [REPORTING_YEAR_START_DATE] is a Monday, Tuesday, Wednesday, or Thursday:** 296 - Add^^4^^ (P0D, -P1D, -P2D, or -P3D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE]. 358 +1. 359 +11. 360 +111. **If [REPORTING_YEAR_START_DATE] is a Monday, Tuesday, Wednesday, or Thursday:** 297 297 298 -**b) Else:** 299 -The [REPORTING_YEAR_START_DATE] is the [REPORTING_YEAR_BASE]. 362 +Add^^4^^ (P0D, -P1D, -P2D, or -P3D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE]. 300 300 301 -**2. Determine [PERIOD_DURATION]:** 302 -a) If the [PERIOD_INDICATOR] is A, the [PERIOD_DURATION] is P1Y. 303 -b) If the [PERIOD_INDICATOR] is S, the [PERIOD_DURATION] is P6M. 304 -c) If the [PERIOD_INDICATOR] is T, the [PERIOD_DURATION] is P4M. 305 -d) If the [PERIOD_INDICATOR] is Q, the [PERIOD_DURATION] is P3M. 306 -e) If the [PERIOD_INDICATOR] is M, the [PERIOD_DURATION] is P1M. 307 -f) If the [PERIOD_INDICATOR] is W, the [PERIOD_DURATION] is P7D. 308 -g) If the [PERIOD_INDICATOR] is D, the [PERIOD_DURATION] is P1D. 309 -**3. Determine [PERIOD_START]:** 364 +1. 365 +11. **Else:** 310 310 311 - 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].367 +The [REPORTING_YEAR_START_DATE] is the [REPORTING_YEAR_BASE]. 312 312 313 -**4. Determine the [PERIOD_END]:** 369 +1. **Determine [PERIOD_DURATION]:** 370 +11. If the [PERIOD_INDICATOR] is A, the [PERIOD_DURATION] is P1Y. 371 +11. If the [PERIOD_INDICATOR] is S, the [PERIOD_DURATION] is P6M. 372 +11. If the [PERIOD_INDICATOR] is T, the [PERIOD_DURATION] is P4M. 373 +11. If the [PERIOD_INDICATOR] is Q, the [PERIOD_DURATION] is P3M. 374 +11. If the [PERIOD_INDICATOR] is M, the [PERIOD_DURATION] is P1M. 375 +11. If the [PERIOD_INDICATOR] is W, the [PERIOD_DURATION] is P7D. 376 +11. If the [PERIOD_INDICATOR] is D, the [PERIOD_DURATION] is P1D. 377 +1. **Determine [PERIOD_START]:** 314 314 379 +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]:** 380 + 315 315 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]. 316 316 317 317 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). ... ... @@ -319,34 +319,53 @@ 319 319 **Examples:** 320 320 321 321 **2010-Q2, REPORTING_YEAR_START_DAY = ~-~-07-01 (July 1)** 322 -~1. [REPORTING_YEAR_START_DATE] = 2010-07-01 323 - b) [REPORTING_YEAR_BASE] = 2010-07-01 324 -2. [PERIOD_DURATION] = P3M 325 -3. (2-1) * P3M = P3M 326 - 2010-07-01 + P3M = 2010-10-01 327 - [PERIOD_START] = 2010-10-01 328 328 329 -4. 2 * P3M = P6M 330 - 2010-07-01 + P6M = 2010-13-01 = 2011-01-01 331 - 2011-01-01 + -P1D = 2010-12-31 332 - [PERIOD_END] = 2010-12-31 389 +1. [REPORTING_YEAR_START_DATE] = 2010-07-01 333 333 391 +b) [REPORTING_YEAR_BASE] = 2010-07-01 392 + 393 +1. [PERIOD_DURATION] = P3M 394 +1. (2-1) * P3M = P3M 395 + 396 +2010-07-01 + P3M = 2010-10-01 397 + 398 +[PERIOD_START] = 2010-10-01 399 + 400 +1. 2 * P3M = P6M 401 + 402 +2010-07-01 + P6M = 2010-13-01 = 2011-01-01 403 + 404 +2011-01-01 + -P1D = 2010-12-31 405 + 406 +[PERIOD_END] = 2010-12-31 407 + 334 334 The actual calendar range covered by 2010-Q2 (assuming the reporting year begins July 1) is 2010-10-01T00:00:00/2010-12-31T23:59:59 335 335 336 336 **2011-W36, REPORTING_YEAR_START_DAY = ~-~-07-01 (July 1)** 337 -~1. [REPORTING_YEAR_START_DATE] = 2010-07-01 338 - a) 2011-07-01 = Friday 339 - 2011-07-01 + P3D = 2011-07-04 340 - [REPORTING_YEAR_BASE] = 2011-07-04 341 -2. [PERIOD_DURATION] = P7D 342 -3. (36-1) * P7D = P245D 343 - 2011-07-04 + P245D = 2012-03-05 344 - [PERIOD_START] = 2012-03-05 345 -4. 36 * P7D = P252D 346 - 2011-07-04 + P252D =2012-03-12 347 - 2012-03-12 + -P1D = 2012-03-11 348 - [PERIOD_END] = 2012-03-11 349 349 412 +1. [REPORTING_YEAR_START_DATE] = 2010-07-01 413 + 414 +a) 2011-07-01 = Friday 415 + 416 +2011-07-01 + P3D = 2011-07-04 417 + 418 +[REPORTING_YEAR_BASE] = 2011-07-04 419 + 420 +1. [PERIOD_DURATION] = P7D 421 +1. (36-1) * P7D = P245D 422 + 423 +2011-07-04 + P245D = 2012-03-05 424 + 425 +[PERIOD_START] = 2012-03-05 426 + 427 +1. 36 * P7D = P252D 428 + 429 +2011-07-04 + P252D =2012-03-12 430 + 431 +2012-03-12 + -P1D = 2012-03-11 432 + 433 +[PERIOD_END] = 2012-03-11 434 + 350 350 The actual calendar range covered by 2011-W36 (assuming the reporting year begins July 1) is 2012-03-05T00:00:00/2012-03-11T23:59:59 351 351 352 352 === {{id name="_Toc291513"/}}4.2.7 Distinct Range === ... ... @@ -357,29 +357,29 @@ 357 357 358 358 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. 359 359 360 -(% style="width:771.294px" %) 361 -|**Code**|(% style="width:659px" %)**Format** 362 -|OTP|(% style="width:659px" %)Observational Time Period: Superset of all SDMX time formats (Gregorian Time Period, Reporting Time Period, and Time Range) 363 -|STP|(% style="width:659px" %)Standard Time Period: Superset of Gregorian and Reporting Time Periods 364 -|GTP|(% style="width:659px" %)Superset of all Gregorian Time Periods and date-time 365 -|RTP|(% style="width:659px" %)Superset of all Reporting Time Periods 366 -|TR|(% style="width:659px" %)((( 367 -Time Range: Start time and duration (YYYY-MM-DD(Thh:mm:ss)?/<duration>) 445 +|Code|Format 446 +|OTP|Observational Time Period: Superset of all SDMX time formats (Gregorian Time Period, Reporting Time Period, and Time Range) 447 +|STP|Standard Time Period: Superset of Gregorian and Reporting Time Periods 448 +|GTP|Superset of all Gregorian Time Periods and date-time 449 +|RTP|Superset of all Reporting Time Periods 450 +|TR|((( 451 +Time Range: Start time and duration (YYYY-MM- 452 + 453 +DD(Thh:mm:ss)?/<duration>) 368 368 ))) 369 -|GY| (% style="width:659px" %)Gregorian Year (YYYY)370 -|GTM| (% style="width:659px" %)Gregorian Year Month (YYYY-MM)371 -|GD| (% style="width:659px" %)Gregorian Day (YYYY-MM-DD)372 -|DT| (% style="width:659px" %)Distinct Point: date-time (YYYY-MM-DDThh:mm:ss)373 -|RY| (% style="width:659px" %)Reporting Year (YYYY-A1)374 -|RS| (% style="width:659px" %)Reporting Semester (YYYY-Ss)375 -|RT| (% style="width:659px" %)Reporting Trimester (YYYY-Tt)376 -|RQ| (% style="width:659px" %)Reporting Quarter (YYYY-Qq)377 -|RM| (% style="width:659px" %)Reporting Month (YYYY-Mmm)378 -|RW| (% style="width:659px" %)Reporting Week (YYYY-Www)379 -|RD| (% style="width:659px" %)Reporting Day (YYYY-Dddd)455 +|GY|Gregorian Year (YYYY) 456 +|GTM|Gregorian Year Month (YYYY-MM) 457 +|GD|Gregorian Day (YYYY-MM-DD) 458 +|DT|Distinct Point: date-time (YYYY-MM-DDThh:mm:ss) 459 +|RY|Reporting Year (YYYY-A1) 460 +|RS|Reporting Semester (YYYY-Ss) 461 +|RT|Reporting Trimester (YYYY-Tt) 462 +|RQ|Reporting Quarter (YYYY-Qq) 463 +|RM|Reporting Month (YYYY-Mmm) 464 +|RW|Reporting Week (YYYY-Www) 465 +|RD|Reporting Day (YYYY-Dddd) 380 380 381 -(% class="wikigeneratedid" id="HTable1:SDMX-MLTimeFormatCodes" %) 382 -**Table 1: SDMX-ML Time Format Codes** 467 +==== Table 1: SDMX-ML Time Format Codes ==== 383 383 384 384 === {{id name="_Toc291515"/}}4.2.9 Time Zones === 385 385 ... ... @@ -406,11 +406,11 @@ 406 406 407 407 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: 408 408 409 - ><Series REF_PERIODStartTime="2000-01-01T00:00:00" REF_PERIOD="P2M"/>494 +<Series REF_PERIODStartTime="2000-01-01T00:00:00" REF_PERIOD="P2M"/> 410 410 411 411 can now be represented with this: 412 412 413 - ><Series REF_PERIOD="2000-01-01T00:00:00/P2M"/>498 +<Series REF_PERIOD="2000-01-01T00:00:00/P2M"/> 414 414 415 415 === {{id name="_Toc291517"/}}4.2.11 Notes on Formats === 416 416 ... ... @@ -426,13 +426,12 @@ 426 426 427 427 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. 428 428 429 -(% style="width:1020.29px" %) 430 -|(% style="width:236px" %)**Operator**|(% style="width:781px" %)**Rule** 431 -|(% style="width:236px" %)Greater Than|(% style="width:781px" %)Any data after the last moment of the period 432 -|(% style="width:236px" %)Less Than|(% style="width:781px" %)Any data before the first moment of the period 433 -|(% style="width:236px" %)Greater Than or Equal To|(% style="width:781px" %)Any data on or after the first moment of the period 434 -|(% style="width:236px" %)Less Than or Equal To|(% style="width:781px" %)Any data on or before the last moment of the period 435 -|(% 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 514 +|**Operator**|**Rule** 515 +|Greater Than|Any data after the last moment of the period 516 +|Less Than|Any data before the first moment of the period 517 +|Greater Than or Equal To|Any data on or after the first moment of the period 518 +|Less Than or Equal To|Any data on or before the last moment of the period 519 +|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 436 436 437 437 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. 438 438 ... ... @@ -439,8 +439,11 @@ 439 439 **Examples:** 440 440 441 441 **Gregorian Period** 526 + 442 442 Query Parameter: Greater than 2010 528 + 443 443 Literal Interpretation: Any data where the start period occurs after 2010-1231T23:59:59. 530 + 444 444 Example Matches: 445 445 446 446 * 2011 or later ... ... @@ -456,10 +456,11 @@ 456 456 * 2010-D185 or later (reporting year start day ~-~-07-01 or later) 457 457 458 458 **Reporting Period** 546 + 459 459 Query Parameter: Greater than or equal to 2010-Q3 460 -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. 461 -Example Matches: 462 462 549 +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: 550 + 463 463 * 2011 or later 464 464 * 2010-07 or later 465 465 * 2010-07-01 or later ... ... @@ -477,7 +477,7 @@ 477 477 478 478 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". 479 479 480 -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__>>http s://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’.568 +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’. 481 481 482 482 === 4.3.1 Non-versioned artefacts === 483 483 ... ... @@ -485,6 +485,8 @@ 485 485 486 486 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. 487 487 576 +[[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_59eee18f.gif||alt="Shape3" height="1" width="192"]] 577 + 488 488 2010-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. 489 489 490 490 2010-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. ... ... @@ -555,5 +555,3 @@ 555 555 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. 556 556 557 557 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. 558 - 559 -{{putFootnotes/}}