Skip to Content
Last modified by Helena on 2025/09/10 11:19
From version 3.1
edited by Helena
on 2025/05/15 15:48
Change comment: There is no comment for this version
To version 4.6
edited by Helena
on 2025/05/16 11:22
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,4 +1,6 @@
1 -= {{id name="_Toc291503"/}}4 General Notes for Implementers =
1 +{{box title="**Contents**"}}
2 +{{toc/}}
3 +{{/box}}
2 2  
3 3  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.
4 4  
... ... @@ -8,99 +8,69 @@
8 8  
9 9  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.
10 10  
11 -|SDMX-ML Data Type|XML Schema Data Type|.NET Framework Type|Java Data Type
12 -|**String**|**xsd:string**|**System.String**|**java.lang.String**
13 -|**Big Integer**|**xsd:integer**|**System.Decimal**|**java.math.BigInteger**
14 -|**Integer**|**xsd:int**|**System.Int32**|**int**
15 -|**Long**|**xsd.long**|**System.Int64**|**long**
16 -|**Short**|**xsd:short**|**System.Int16**|**short**
17 -|**Decimal**|**xsd:decimal**|**System.Decimal**|**java.math.BigDecimal**
18 -|**Float**|**xsd:float**|**System.Single**|**float**
19 -|**Double**|**xsd:double**|**System.Double**|**double**
20 -|**Boolean**|**xsd:boolean**|**System.Boolean**|**boolean**
21 -|**URI**|**xsd:anyURI**|**System.Uri**|**Java.net.URI or java.lang.String**
22 -|**DateTime**|**xsd:dateTime**|**System.DateTime**|**javax.xml.datatype.XMLG regorianCalendar**
23 -|**Time**|**xsd:time**|**System.DateTime**|**javax.xml.datatype.XMLG regorianCalendar**
24 -|**GregorianYear**|**xsd:gYear**|**System.DateTime**|**javax.xml.datatype.XMLG regorianCalendar**
25 -|**GregorianMonth**|**xsd:gYearMonth**|**System.DateTime**|**javax.xml.datatype.XMLG regorianCalendar**
26 -|**GregorianDay**|**xsd:date**|**System.DateTime**|**javax.xml.datatype.XMLG regorianCalendar**
27 -|**Day, MonthDay, Month**|**xsd:g***|**System.DateTime**|**javax.xml.datatype.XMLG regorianCalendar**
28 -|**Duration**|**xsd:duration**|**System.TimeSpan**|**javax.xml.datatype.Dura tion**
13 +(% style="width:1185.29px" %)
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**
15 +|(% style="width:250px" %)String|(% style="width:285px" %)xsd:string|(% style="width:271px" %)System.String|(% style="width:354px" %)java.lang.String
16 +|(% style="width:250px" %)Big Integer|(% style="width:285px" %)xsd:integer|(% style="width:271px" %)System.Decimal|(% style="width:354px" %)java.math.BigInteger
17 +|(% style="width:250px" %)Integer|(% style="width:285px" %)xsd:int|(% style="width:271px" %)System.Int32|(% style="width:354px" %)int
18 +|(% style="width:250px" %)Long|(% style="width:285px" %)xsd.long|(% style="width:271px" %)System.Int64|(% style="width:354px" %)long
19 +|(% style="width:250px" %)Short|(% style="width:285px" %)xsd:short|(% style="width:271px" %)System.Int16|(% style="width:354px" %)short
20 +|(% style="width:250px" %)Decimal|(% style="width:285px" %)xsd:decimal|(% style="width:271px" %)System.Decimal|(% style="width:354px" %)java.math.BigDecimal
21 +|(% style="width:250px" %)Float|(% style="width:285px" %)xsd:float|(% style="width:271px" %)System.Single|(% style="width:354px" %)float
22 +|(% style="width:250px" %)Double|(% style="width:285px" %)xsd:double|(% style="width:271px" %)System.Double|(% style="width:354px" %)double
23 +|(% style="width:250px" %)Boolean|(% style="width:285px" %)xsd:boolean|(% style="width:271px" %)System.Boolean|(% style="width:354px" %)boolean
24 +|(% style="width:250px" %)URI|(% style="width:285px" %)xsd:anyURI|(% style="width:271px" %)System.Uri|(% style="width:354px" %)Java.net.URI or java.lang.String
25 +|(% style="width:250px" %)DateTime|(% style="width:285px" %)xsd:dateTime|(% style="width:271px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
26 +|(% style="width:250px" %)Time|(% style="width:285px" %)xsd:time|(% style="width:271px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
27 +|(% style="width:250px" %)GregorianYear|(% style="width:285px" %)xsd:gYear|(% style="width:271px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
28 +|(% style="width:250px" %)GregorianMonth|(% style="width:285px" %)xsd:gYearMonth|(% style="width:271px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
29 +|(% style="width:250px" %)GregorianDay|(% style="width:285px" %)xsd:date|(% style="width:271px" %)System.DateTime|(% style="width:354px" %)javax.xml.datatype.XMLG regorianCalendar
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 +|(% style="width:250px" %)Duration|(% style="width:285px" %)xsd:duration|(% style="width:271px" %)System.TimeSpan|(% style="width:354px" %)javax.xml.datatype.Dura tion
29 29  
30 30  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:
31 31  
32 -• **AlphaNumeric** (**common:AlphaNumericType**, string which only allows A-z and 0-9)
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 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)
33 33  
34 -• **Alpha** (**common:AlphaType**, string which only allows A-z)
35 -
36 -• ,,**Numeric**,, (,,**common:NumericType**,,, string which only allows 0-9, but is not numeric so that is can having leading zeros)
37 -
38 -• ,,**Count**,, (,,**xs:integer**,,, a sequence with an interval of "1")
39 -
40 -• **InclusiveValueRange** (**xs:decimal** with the **minValue** and **maxValue** facets supplying the bounds)
41 -
42 -• **ExclusiveValueRange** (**xs:decimal** with the **minValue** and **maxValue** facets supplying the bounds)
43 -
44 -• **Incremental** (**xs:decimal** with a specified **interval**; the interval is typically enforced outside of the XML validation)
45 -
46 -• **TimeRange** (**common:TimeRangeType**, **startDateTime** + **Duration**)
47 -
48 -• **ObservationalTimePeriod** (**common:ObservationalTimePeriodType**, a union of **StandardTimePeriod** and **TimeRange**).
49 -
50 -• **StandardTimePeriod** (**common:StandardTimePeriodType**, a union of **BasicTimePeriod** and **ReportingTimePeriod**).
51 -
52 -• **BasicTimePeriod** (**common:BasicTimePeriodType**, a union of **GregorianTimePeriod** and **DateTime**)
53 -
54 -• **GregorianTimePeriod** (**common:GregorianTimePeriodType**, a union of **GregorianYear**, **GregorianMonth**, and **GregorianDay**)
55 -
56 -• **ReportingTimePeriod** (**common:ReportingTimePeriodType**, a union of **ReportingYear**, **ReportingSemester**, **ReportingTrimester**, **ReportingQuarter**, **ReportingMonth**, **ReportingWeek**, and **ReportingDay**).
57 -
58 -• **ReportingYear** (**common:ReportingYearType**)
59 -
60 -• **ReportingSemester** (**common:ReportingSemesterType**)
61 -
62 -• **ReportingTrimester** (**common:ReportingTrimesterType**)
63 -
64 -• **ReportingQuarter** (**common:ReportingQuarterType**)
65 -
66 -• **ReportingMonth** (**common:ReportingMonthType**)
67 -
68 -• **ReportingWeek** (**common:ReportingWeekType**)
69 -
70 -• **ReportingDay** (**common:ReportingDayType**)
71 -
72 -• ,,**XHTML**,, (,,**common:StructuredText**,,, allows for multi-lingual text content that has ,,**XHTML**,, markup)
73 -
74 -• **KeyValues** (**common:DataKeyType**)
75 -
76 -• ,,**IdentifiableReference**,, (types for each IdentifiableObject)
77 -
78 -• ,,**GeospatialInformation**,, (a geo feature set, according to the pattern in section 7.2)
79 -
80 80  Data types also have a set of facets:
81 81  
82 -• ,,**isSequence = true | false**,, (indicates a sequentially increasing value)
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 (for numeric sequence)
66 +* endValue = decimal (for numeric sequence)
67 +* interval = decimal (for numeric sequence)
68 +* timeInterval = duration
69 +* startTime = BasicTimePeriod (for time range) endTime = BasicTimePeriod (for time range)
70 +* minValue = decimal (for numeric range)
71 +* maxValue = decimal (for numeric range)
72 +* decimal = Integer (# of digits to right of decimal point)
73 +* pattern = (a regular expression, as per W3C XML Schema)
74 +* isMultiLingual = boolean (for specifying text can occur in more than one language)
83 83  
84 -• ,,**minLength = positive integer**,, (# of characters/digits)
85 -
86 -• ,,**maxLength = positive integer**,, (# of characters/digits)
87 -
88 -• ,,**startValue = decimal**,, (for numeric sequence)
89 -
90 -• ,,**endValue = decimal**,, (for numeric sequence)
91 -
92 -• ,,**interval = decimal**,, (for numeric sequence)
93 -
94 -• **timeInterval = duration**
95 -
96 -• **startTime = BasicTimePer,,iod,,** (for time range) ,,**endTime = BasicTimePeriod**,, (for time range)
97 -
98 -* ,,**minValue = decimal**,, (for numeric range)
99 -* ,,**maxValue = decimal**,, (for numeric range)
100 -* ,,**decimal = Integer**,, (# of digits to right of decimal point)
101 -* ,,**pattern =**,, (a regular expression, as per W3C XML Schema)
102 -* ,,**isMultiLingual = boolean**,, (for specifying text can occur in more than one language)
103 -
104 104  Note that code lists may also have textual representations assigned to them, in addition to their enumeration of codes.
105 105  
106 106  === {{id name="_Toc291505"/}}4.1.1 Data Types ===
... ... @@ -111,76 +111,47 @@
111 111  
112 112  For example, for the id type, this is the XML schema definition:
113 113  
114 -<xs:simpleType name="IDType">
86 +> <xs:simpleType name="IDType">
87 +> <xs:restriction base="NestedIDType">
88 +> <xs:pattern value="[A-Za-z0-9_@$\-]+"/>
89 +> </xs:restriction>
90 +> </xs:simpleType>
115 115  
116 -<xs:restriction base="NestedIDType">
117 -
118 -<xs:pattern value="[A-Za-z0-9_@$\-]+"/>
119 -
120 -</xs:restriction>
121 -
122 -</xs:simpleType>
123 -
124 124  Where the NestedIDType is also a restriction of string.
125 125  
126 126  The above looks like this, in JSON schema:
127 127  
128 -"idType": {
96 +> "idType": {
97 +> "type": "string",
98 +> "pattern": "^[A-Za-z0-9_@$-]+$"
99 +> }
129 129  
130 -"type": "string",
131 -
132 -"pattern": "^[A-Za-z0-9_@$-]+$"
133 -
134 -}
135 -
136 136  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.
137 137  
138 138  Further to the above, the mapping between the non-native data types is presented in the table below:
139 139  
140 -|**SDMX Facet**|**XML Schema**|**JSON schema **"**pattern**"^^[[^^1^^>>path:#sdfootnote1sym||name="sdfootnote1anc"]]^^ **for "string" type**
141 -|GregorianYear|xsd:gYear|(((
142 -"^-?([1-9][0-9]{3,}|0[0-9]{3})(Z|(\+|-)((0[0-
143 -
144 -9]|1[0-3]):[0-5][0-9]|14:00))?$"
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))?$"
145 145  )))
146 -|GregorianMonth|xsd:gYearMonth|(((
147 -"^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-
148 -
149 -2])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-
150 -
151 -9]|14:00))?$"
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))?$"
152 152  )))
153 -
154 -[[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_59eee18f.gif||alt="Shape1" height="1" width="192"]]
155 -
156 -|GregorianDay|xsd:date|(((
157 -"^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-
158 -
159 -(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-
160 -
161 -3]):[0-5][0-9]|14:00))?$"
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))?$"
162 162  )))
163 -|Day|xsd:gDay|(((
164 -"^~-~--(0[1-9]|[12][0-9]|3[01])(Z|(\+|-
165 -
166 -)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$"
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))?$"
167 167  )))
168 -|MonthDay|xsd:gMonthDay|(((
169 -"^~-~-(0[1-9]|1[0-2])-(0[1-9]|[12][0-
170 -
171 -9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-
172 -
173 -9]|14:00))?$"
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))?$"
174 174  )))
175 -|Month|xsd:Month|(((
176 -"^~-~-(0[1-9]|1[0-2])(Z|(\+|-)((0[0-9]|1[0-
177 -
178 -3]):[0-5][0-9]|14:00))?$"
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))?$"
179 179  )))
180 -|Duration|xsd:duration|(((
181 -"^-?P[0-9]+Y?([0-9]+M)?([0-9]+D)?(T([0-
182 -
183 -9]+H)?([0-9]+M)?([0-9]+(\.[0-9]+)?S)?)?$"
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)?)?$"
184 184  )))
185 185  
186 186  == {{id name="_Toc291506"/}}4.2 Time and Time Format ==
... ... @@ -195,17 +195,14 @@
195 195  
196 196  The hierarchy of time formats is as follows (**bold** indicates a category which is made up of multiple formats, //italic// indicates a distinct format):
197 197  
198 -* **Observational Time Period **o **Standard Time Period**
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//**
199 199  
200 -▪ **Basic Time Period**
201 -
202 -* **Gregorian Time Period**
203 -* //Date Time//
204 -
205 -▪ **Reporting Time Period**
206 -
207 -o //Time Range//
208 -
209 209  The details of these time period categories and of the distinct formats which make them up are detailed in the sections to follow.
210 210  
211 211  === {{id name="_Toc291508"/}}4.2.2 Observational Time Period ===
... ... @@ -224,12 +224,16 @@
224 224  
225 225  Representation: xs:gYear (YYYY)
226 226  
227 -Period: the start of January 1 to the end of December 31 **Gregorian Year Month**:
167 +Period: the start of January 1 to the end of December 31
228 228  
169 +**Gregorian Year Month**:
170 +
229 229  Representation: xs:gYearMonth (YYYY-MM)
230 230  
231 -Period: the start of the first day of the month to end of the last day of the month **Gregorian Day**:
173 +Period: the start of the first day of the month to end of the last day of the month
232 232  
175 +**Gregorian Day**:
176 +
233 233  Representation: xs:date (YYYY-MM-DD)
234 234  
235 235  Period: the start of the day (00:00:00) to the end of the day (23:59:59)
... ... @@ -238,7 +238,7 @@
238 238  
239 239  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.
240 240  
241 -Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss)^^[[^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]]^^
185 +Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss){{footnote}}The seconds can be reported fractionally{{/footnote}}
242 242  
243 243  === {{id name="_Toc291512"/}}4.2.6 Standard Reporting Period ===
244 244  
... ... @@ -262,8 +262,10 @@
262 262  
263 263  Limit per year: 1
264 264  
265 -Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1) **Reporting Semester:**
209 +Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1)
266 266  
211 +**Reporting Semester:**
212 +
267 267  Period Indicator: S
268 268  
269 269  Period Duration: P6M (six months)
... ... @@ -272,8 +272,6 @@
272 272  
273 273  Representation: common:ReportingSemesterType (YYYY-Ss, e.g. 2000-S2)
274 274  
275 -[[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_59eee18f.gif||alt="Shape2" height="1" width="192"]]
276 -
277 277  **Reporting Trimester:**
278 278  
279 279  Period Indicator: T
... ... @@ -282,8 +282,10 @@
282 282  
283 283  Limit per year: 3
284 284  
285 -Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3) **Reporting Quarter:**
229 +Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3)
286 286  
231 +**Reporting Quarter:**
232 +
287 287  Period Indicator: Q
288 288  
289 289  Period Duration: P3M (three months)
... ... @@ -290,8 +290,10 @@
290 290  
291 291  Limit per year: 4
292 292  
293 -Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4) **Reporting Month**:
239 +Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4)
294 294  
241 +**Reporting Month**:
242 +
295 295  Period Indicator: M
296 296  
297 297  Period Duration: P1M (one month)
... ... @@ -312,7 +312,7 @@
312 312  
313 313  Representation: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53)
314 314  
315 -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:#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.
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" %)^^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.
316 316  
317 317  **Reporting Day**:
318 318  
... ... @@ -332,49 +332,38 @@
332 332  
333 333  (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.
334 334  
335 -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
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]):
336 336  
337 -Gregorian calendar period covered by the reporting period can be computed as follows
285 +**~1. Determine [REPORTING_YEAR_BASE]:**
338 338  
339 -(based on the standard format of [REPROTING_YEAR]-
340 -
341 -[PERIOD_INDICATOR][PERIOD_VALUE] and the reporting year start day as [REPORTING_YEAR_START_DAY]):
342 -
343 -1. **Determine [REPORTING_YEAR_BASE]:**
344 -
345 345  Combine [REPORTING_YEAR] of the reporting period value (YYYY) with [REPORTING_YEAR_START_DAY] (MM-DD) to get a date (YYYY-MM-DD).
346 -
347 347  This is the [REPORTING_YEAR_START_DATE]
348 348  
349 -1.
350 -11. **If the [PERIOD_INDICATOR] is W:**
351 -111. **If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday:**
290 +**a) If the [PERIOD_INDICATOR] is W:**
352 352  
353 -Add^^[[^^4^^>>path:#sdfootnote4sym||name="sdfootnote4anc"]]^^ (P3D, P2D, or P1D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE].
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].
354 354  
355 -1.
356 -11.
357 -111. **If [REPORTING_YEAR_START_DATE] is a Monday, Tuesday, Wednesday, or Thursday:**
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 358  
359 -Add^^4^^ (P0D, -P1D, -P2D, or -P3D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE].
360 -
361 -1.
362 -11. **Else:**
363 -
298 +**b) Else:**
364 364  The [REPORTING_YEAR_START_DATE] is the [REPORTING_YEAR_BASE].
365 365  
366 -1. **Determine [PERIOD_DURATION]:**
367 -11. If the [PERIOD_INDICATOR] is A, the [PERIOD_DURATION] is P1Y.
368 -11. If the [PERIOD_INDICATOR] is S, the [PERIOD_DURATION] is P6M.
369 -11. If the [PERIOD_INDICATOR] is T, the [PERIOD_DURATION] is P4M.
370 -11. If the [PERIOD_INDICATOR] is Q, the [PERIOD_DURATION] is P3M.
371 -11. If the [PERIOD_INDICATOR] is M, the [PERIOD_DURATION] is P1M.
372 -11. If the [PERIOD_INDICATOR] is W, the [PERIOD_DURATION] is P7D.
373 -11. If the [PERIOD_INDICATOR] is D, the [PERIOD_DURATION] is P1D.
374 -1. **Determine [PERIOD_START]:**
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]:**
375 375  
376 -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]:**
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].
377 377  
313 +**4. Determine the [PERIOD_END]:**
314 +
378 378  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].
379 379  
380 380  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).
... ... @@ -382,53 +382,34 @@
382 382  **Examples:**
383 383  
384 384  **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
385 385  
386 -1. [REPORTING_YEAR_START_DATE] = 2010-07-01
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
387 387  
388 -b) [REPORTING_YEAR_BASE] = 2010-07-01
389 -
390 -1. [PERIOD_DURATION] = P3M
391 -1. (2-1) * P3M = P3M
392 -
393 -2010-07-01 + P3M = 2010-10-01
394 -
395 -[PERIOD_START] = 2010-10-01
396 -
397 -1. 2 * P3M = P6M
398 -
399 -2010-07-01 + P6M = 2010-13-01 = 2011-01-01
400 -
401 -2011-01-01 + -P1D = 2010-12-31
402 -
403 -[PERIOD_END] = 2010-12-31
404 -
405 405  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
406 406  
407 407  **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
408 408  
409 -1. [REPORTING_YEAR_START_DATE] = 2010-07-01
410 -
411 -a) 2011-07-01 = Friday
412 -
413 -2011-07-01 + P3D = 2011-07-04
414 -
415 -[REPORTING_YEAR_BASE] = 2011-07-04
416 -
417 -1. [PERIOD_DURATION] = P7D
418 -1. (36-1) * P7D = P245D
419 -
420 -2011-07-04 + P245D = 2012-03-05
421 -
422 -[PERIOD_START] = 2012-03-05
423 -
424 -1. 36 * P7D = P252D
425 -
426 -2011-07-04 + P252D =2012-03-12
427 -
428 -2012-03-12 + -P1D = 2012-03-11
429 -
430 -[PERIOD_END] = 2012-03-11
431 -
432 432  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
433 433  
434 434  === {{id name="_Toc291513"/}}4.2.7 Distinct Range ===
... ... @@ -439,29 +439,29 @@
439 439  
440 440  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.
441 441  
442 -|Code|Format
443 -|OTP|Observational Time Period: Superset of all SDMX time formats (Gregorian Time Period, Reporting Time Period, and Time Range)
444 -|STP|Standard Time Period: Superset of Gregorian and Reporting Time Periods
445 -|GTP|Superset of all Gregorian Time Periods and date-time
446 -|RTP|Superset of all Reporting Time Periods
447 -|TR|(((
448 -Time Range: Start time and duration (YYYY-MM-
449 -
450 -DD(Thh:mm:ss)?/<duration>)
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>)
451 451  )))
452 -|GY|Gregorian Year (YYYY)
453 -|GTM|Gregorian Year Month (YYYY-MM)
454 -|GD|Gregorian Day (YYYY-MM-DD)
455 -|DT|Distinct Point: date-time (YYYY-MM-DDThh:mm:ss)
456 -|RY|Reporting Year (YYYY-A1)
457 -|RS|Reporting Semester (YYYY-Ss)
458 -|RT|Reporting Trimester (YYYY-Tt)
459 -|RQ|Reporting Quarter (YYYY-Qq)
460 -|RM|Reporting Month (YYYY-Mmm)
461 -|RW|Reporting Week (YYYY-Www)
462 -|RD|Reporting Day (YYYY-Dddd)
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)
463 463  
464 -==== Table 1: SDMX-ML Time Format Codes ====
381 +(% class="wikigeneratedid" id="HTable1:SDMX-MLTimeFormatCodes" %)
382 +Table 1: SDMX-ML Time Format Codes
465 465  
466 466  === {{id name="_Toc291515"/}}4.2.9 Time Zones ===
467 467  
... ... @@ -508,12 +508,13 @@
508 508  
509 509  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.
510 510  
511 -|**Operator**|**Rule**
512 -|Greater Than|Any data after the last moment of the period
513 -|Less Than|Any data before the first moment of the period
514 -|Greater Than or Equal To|Any data on or after the first moment of the period
515 -|Less Than or Equal To|Any data on or before the last moment of the period
516 -|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
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
517 517  
518 518  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.
519 519  
... ... @@ -562,7 +562,7 @@
562 562  
563 563  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".
564 564  
565 -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’.
484 +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’.
566 566  
567 567  === 4.3.1 Non-versioned artefacts ===
568 568  
... ... @@ -570,8 +570,6 @@
570 570  
571 571  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.
572 572  
573 -[[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_59eee18f.gif||alt="Shape3" height="1" width="192"]]
574 -
575 575  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.
576 576  
577 577  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.
... ... @@ -642,3 +642,5 @@
642 642  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.
643 643  
644 644  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.
562 +
563 +{{putFootnotes/}}