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 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. 5 +This section discusses a number of topics other than the exchange of [[data sets>>doc:xwiki:Glossary.Data set.WebHome]] in [[SDMX>>doc:xwiki:Glossary.Statistical data 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.Reference metadata.WebHome]] mechanism in [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]], the use of [[Structure Sets>>doc:xwiki:Glossary.Structure set.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. 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 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. 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. 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,7 +30,7 @@ 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 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: 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.Statistical data and metadata exchange.WebHome]] schemas, for others a derived simple type will be necessary: 34 34 35 35 * AlphaNumeric (common:AlphaNumericType, string which only allows A-z and 0-9) 36 36 * Alpha (common:AlphaType, string which only allows A-z) ... ... @@ -37,7 +37,7 @@ 37 37 * Numeric (common:NumericType, string which only allows 0-9, but is not numeric so that is can having leading zeros) 38 38 * Count (xs:integer, a sequence with an interval of "1") 39 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) 40 +* ExclusiveValueRange (xs:decimal with the minValue and maxValue [[facets>>doc:xwiki:Glossary.Facet.WebHome]] supplying the bounds) 41 41 * Incremental (xs:decimal with a specified interval; the interval is typically enforced outside of the XML validation) 42 42 * TimeRange (common:TimeRangeType, startDateTime + Duration) 43 43 * ObservationalTimePeriod (common:ObservationalTimePeriodType, a union of StandardTimePeriod and TimeRange). ... ... @@ -57,102 +57,73 @@ 57 57 * IdentifiableReference (types for each IdentifiableObject) 58 58 * GeospatialInformation (a geo feature set, according to the pattern in section 7.2) 59 59 60 -Data types also have a set of facets: 60 +Data types also have a set of [[facets>>doc:xwiki:Glossary.Facet.WebHome]]: 61 61 62 62 * isSequence = true | false (indicates a sequentially increasing value) 63 63 * minLength = positive integer (# of characters/digits) 64 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) 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 68 * timeInterval = duration 69 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) 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 73 * pattern = (a regular expression, as per W3C XML Schema) 74 74 * isMultiLingual = boolean (for specifying text can occur in more than one language) 75 75 76 -Note that code lists may also have textual representations assigned to them, in addition to their enumeration of codes. 76 +Note that [[code lists>>doc:xwiki:Glossary.Code list.WebHome]] may also have textual [[representations>>doc:xwiki:Glossary.Representation.WebHome]] assigned to them, in addition to their enumeration of [[codes>>doc:xwiki:Glossary.Code.WebHome]]. 77 77 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 mapped one-to-one in all cases. This section provides an explanation of the mapping performed in SDMX 3.0, between such cases. 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.Statistical data and metadata exchange.WebHome]] 3.0, between such cases. 81 81 82 -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. 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. 83 83 84 84 For example, for the id type, this is the XML schema definition: 85 85 86 -<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> 87 87 88 -<xs:restriction base="NestedIDType"> 89 - 90 -<xs:pattern value="[A-Za-z0-9_@$\-]+"/> 91 - 92 -</xs:restriction> 93 - 94 -</xs:simpleType> 95 - 96 96 Where the NestedIDType is also a restriction of string. 97 97 98 98 The above looks like this, in JSON schema: 99 99 100 -"idType": { 96 +> "idType": { 97 +> "type": "string", 98 +> "pattern": "^[A-Za-z0-9_@$-]+$" 99 +> } 101 101 102 -"type": "string", 103 - 104 -"pattern": "^[A-Za-z0-9_@$-]+$" 105 - 106 -} 107 - 108 108 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. 109 109 110 110 Further to the above, the mapping between the non-native data types is presented in the table below: 111 111 112 -|**SDMX Facet**|**XML Schema**|**JSON schema **"**pattern**"^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^1^^>>path:#sdfootnote1sym||name="sdfootnote1anc"]](%%)^^ **for "string" type** 113 -|GregorianYear|xsd:gYear|((( 114 -"^-?([1-9][0-9]{3,}|0[0-9]{3})(Z|(\+|-)((0[0- 115 - 116 -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))?$" 117 117 ))) 118 -|GregorianMonth|xsd:gYearMonth|((( 119 -"^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0- 120 - 121 -2])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0- 122 - 123 -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))?$" 124 124 ))) 125 - 126 -[[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_59eee18f.gif||alt="Shape1" height="1" width="192"]] 127 - 128 -|GregorianDay|xsd:date|((( 129 -"^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])- 130 - 131 -(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0- 132 - 133 -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))?$" 134 134 ))) 135 -|Day|xsd:gDay|((( 136 -"^~-~--(0[1-9]|[12][0-9]|3[01])(Z|(\+|- 137 - 138 -)((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))?$" 139 139 ))) 140 -|MonthDay|xsd:gMonthDay|((( 141 -"^~-~-(0[1-9]|1[0-2])-(0[1-9]|[12][0- 142 - 143 -9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0- 144 - 145 -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))?$" 146 146 ))) 147 -|Month|xsd:Month|((( 148 -"^~-~-(0[1-9]|1[0-2])(Z|(\+|-)((0[0-9]|1[0- 149 - 150 -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))?$" 151 151 ))) 152 -|Duration|xsd:duration|((( 153 -"^-?P[0-9]+Y?([0-9]+M)?([0-9]+D)?(T([0- 154 - 155 -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)?)?$" 156 156 ))) 157 157 158 158 == {{id name="_Toc291506"/}}4.2 Time and Time Format == ... ... @@ -167,17 +167,14 @@ 167 167 168 168 The hierarchy of time formats is as follows (**bold** indicates a category which is made up of multiple formats, //italic// indicates a distinct format): 169 169 170 -* **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//** 171 171 172 -▪ **Basic Time Period** 173 - 174 -* **Gregorian Time Period** 175 -* //Date Time// 176 - 177 -▪ **Reporting Time Period** 178 - 179 -o //Time Range// 180 - 181 181 The details of these time period categories and of the distinct formats which make them up are detailed in the sections to follow. 182 182 183 183 === {{id name="_Toc291508"/}}4.2.2 Observational Time Period === ... ... @@ -196,12 +196,16 @@ 196 196 197 197 Representation: xs:gYear (YYYY) 198 198 199 -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 200 200 169 +**Gregorian Year Month**: 170 + 201 201 Representation: xs:gYearMonth (YYYY-MM) 202 202 203 -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 204 204 175 +**Gregorian Day**: 176 + 205 205 Representation: xs:date (YYYY-MM-DD) 206 206 207 207 Period: the start of the day (00:00:00) to the end of the day (23:59:59) ... ... @@ -210,7 +210,7 @@ 210 210 211 211 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. 212 212 213 -Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss) ^^[[(% class="wikiinternallink wikiinternallinkwikiinternallinkwikiinternallink"%)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^185 +Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss){{footnote}}The seconds can be reported fractionally{{/footnote}} 214 214 215 215 === {{id name="_Toc291512"/}}4.2.6 Standard Reporting Period === 216 216 ... ... @@ -234,8 +234,10 @@ 234 234 235 235 Limit per year: 1 236 236 237 -Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1) **Reporting Semester:**209 +Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1) 238 238 211 +**Reporting Semester:** 212 + 239 239 Period Indicator: S 240 240 241 241 Period Duration: P6M (six months) ... ... @@ -244,8 +244,6 @@ 244 244 245 245 Representation: common:ReportingSemesterType (YYYY-Ss, e.g. 2000-S2) 246 246 247 -[[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_59eee18f.gif||alt="Shape2" height="1" width="192"]] 248 - 249 249 **Reporting Trimester:** 250 250 251 251 Period Indicator: T ... ... @@ -254,8 +254,10 @@ 254 254 255 255 Limit per year: 3 256 256 257 -Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3) **Reporting Quarter:**229 +Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3) 258 258 231 +**Reporting Quarter:** 232 + 259 259 Period Indicator: Q 260 260 261 261 Period Duration: P3M (three months) ... ... @@ -262,8 +262,10 @@ 262 262 263 263 Limit per year: 4 264 264 265 -Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4) **Reporting Month**:239 +Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4) 266 266 241 +**Reporting Month**: 242 + 267 267 Period Indicator: M 268 268 269 269 Period Duration: P1M (one month) ... ... @@ -284,7 +284,7 @@ 284 284 285 285 Representation: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53) 286 286 287 -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. 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. 288 288 289 289 **Reporting Day**: 290 290 ... ... @@ -304,49 +304,38 @@ 304 304 305 305 (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. 306 306 307 -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]): 308 308 309 - Gregoriancalendar period covered bythereporting periodcan be computed as follows285 +**~1. Determine [REPORTING_YEAR_BASE]:** 310 310 311 -(based on the standard format of [REPROTING_YEAR]- 312 - 313 -[PERIOD_INDICATOR][PERIOD_VALUE] and the reporting year start day as [REPORTING_YEAR_START_DAY]): 314 - 315 -1. **Determine [REPORTING_YEAR_BASE]:** 316 - 317 317 Combine [REPORTING_YEAR] of the reporting period value (YYYY) with [REPORTING_YEAR_START_DAY] (MM-DD) to get a date (YYYY-MM-DD). 318 - 319 319 This is the [REPORTING_YEAR_START_DATE] 320 320 321 -1. 322 -11. **If the [PERIOD_INDICATOR] is W:** 323 -111. **If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday:** 290 +**a) If the [PERIOD_INDICATOR] is W:** 324 324 325 -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]. 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]. 326 326 327 -1. 328 -11. 329 -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]. 330 330 331 -Add^^4^^ (P0D, -P1D, -P2D, or -P3D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE]. 332 - 333 -1. 334 -11. **Else:** 335 - 298 +**b) Else:** 336 336 The [REPORTING_YEAR_START_DATE] is the [REPORTING_YEAR_BASE]. 337 337 338 - 1.**Determine [PERIOD_DURATION]:**339 - 11.If the [PERIOD_INDICATOR] is A, the [PERIOD_DURATION] is P1Y.340 - 11.If the [PERIOD_INDICATOR] is S, the [PERIOD_DURATION] is P6M.341 - 11.If the [PERIOD_INDICATOR] is T, the [PERIOD_DURATION] is P4M.342 - 11.If the [PERIOD_INDICATOR] is Q, the [PERIOD_DURATION] is P3M.343 - 11.If the [PERIOD_INDICATOR] is M, the [PERIOD_DURATION] is P1M.344 - 11.If the [PERIOD_INDICATOR] is W, the [PERIOD_DURATION] is P7D.345 - 11.If the [PERIOD_INDICATOR] is D, the [PERIOD_DURATION] is P1D.346 - 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]:** 347 347 348 -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]. 349 349 313 +**4. Determine the [PERIOD_END]:** 314 + 350 350 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]. 351 351 352 352 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). ... ... @@ -354,53 +354,34 @@ 354 354 **Examples:** 355 355 356 356 **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 357 357 358 -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 359 359 360 -b) [REPORTING_YEAR_BASE] = 2010-07-01 361 - 362 -1. [PERIOD_DURATION] = P3M 363 -1. (2-1) * P3M = P3M 364 - 365 -2010-07-01 + P3M = 2010-10-01 366 - 367 -[PERIOD_START] = 2010-10-01 368 - 369 -1. 2 * P3M = P6M 370 - 371 -2010-07-01 + P6M = 2010-13-01 = 2011-01-01 372 - 373 -2011-01-01 + -P1D = 2010-12-31 374 - 375 -[PERIOD_END] = 2010-12-31 376 - 377 377 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 378 378 379 379 **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 380 380 381 -1. [REPORTING_YEAR_START_DATE] = 2010-07-01 382 - 383 -a) 2011-07-01 = Friday 384 - 385 -2011-07-01 + P3D = 2011-07-04 386 - 387 -[REPORTING_YEAR_BASE] = 2011-07-04 388 - 389 -1. [PERIOD_DURATION] = P7D 390 -1. (36-1) * P7D = P245D 391 - 392 -2011-07-04 + P245D = 2012-03-05 393 - 394 -[PERIOD_START] = 2012-03-05 395 - 396 -1. 36 * P7D = P252D 397 - 398 -2011-07-04 + P252D =2012-03-12 399 - 400 -2012-03-12 + -P1D = 2012-03-11 401 - 402 -[PERIOD_END] = 2012-03-11 403 - 404 404 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 405 405 406 406 === {{id name="_Toc291513"/}}4.2.7 Distinct Range === ... ... @@ -411,29 +411,29 @@ 411 411 412 412 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. 413 413 414 -|Code|Format 415 -|OTP|Observational Time Period: Superset of all SDMX time formats (Gregorian Time Period, Reporting Time Period, and Time Range) 416 -|STP|Standard Time Period: Superset of Gregorian and Reporting Time Periods 417 -|GTP|Superset of all Gregorian Time Periods and date-time 418 -|RTP|Superset of all Reporting Time Periods 419 -|TR|((( 420 -Time Range: Start time and duration (YYYY-MM- 421 - 422 -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>) 423 423 ))) 424 -|GY|Gregorian Year (YYYY) 425 -|GTM|Gregorian Year Month (YYYY-MM) 426 -|GD|Gregorian Day (YYYY-MM-DD) 427 -|DT|Distinct Point: date-time (YYYY-MM-DDThh:mm:ss) 428 -|RY|Reporting Year (YYYY-A1) 429 -|RS|Reporting Semester (YYYY-Ss) 430 -|RT|Reporting Trimester (YYYY-Tt) 431 -|RQ|Reporting Quarter (YYYY-Qq) 432 -|RM|Reporting Month (YYYY-Mmm) 433 -|RW|Reporting Week (YYYY-Www) 434 -|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) 435 435 436 -==== Table 1: SDMX-ML Time Format Codes ==== 381 +(% class="wikigeneratedid" id="HTable1:SDMX-MLTimeFormatCodes" %) 382 +**Table 1: SDMX-ML Time Format Codes** 437 437 438 438 === {{id name="_Toc291515"/}}4.2.9 Time Zones === 439 439 ... ... @@ -460,11 +460,11 @@ 460 460 461 461 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: 462 462 463 -<Series REF_PERIODStartTime="2000-01-01T00:00:00" REF_PERIOD="P2M"/> 409 +> <Series REF_PERIODStartTime="2000-01-01T00:00:00" REF_PERIOD="P2M"/> 464 464 465 465 can now be represented with this: 466 466 467 -<Series REF_PERIOD="2000-01-01T00:00:00/P2M"/> 413 +> <Series REF_PERIOD="2000-01-01T00:00:00/P2M"/> 468 468 469 469 === {{id name="_Toc291517"/}}4.2.11 Notes on Formats === 470 470 ... ... @@ -480,12 +480,13 @@ 480 480 481 481 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. 482 482 483 -|**Operator**|**Rule** 484 -|Greater Than|Any data after the last moment of the period 485 -|Less Than|Any data before the first moment of the period 486 -|Greater Than or Equal To|Any data on or after the first moment of the period 487 -|Less Than or Equal To|Any data on or before the last moment of the period 488 -|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 489 489 490 490 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. 491 491 ... ... @@ -492,11 +492,8 @@ 492 492 **Examples:** 493 493 494 494 **Gregorian Period** 495 - 496 496 Query Parameter: Greater than 2010 497 - 498 498 Literal Interpretation: Any data where the start period occurs after 2010-1231T23:59:59. 499 - 500 500 Example Matches: 501 501 502 502 * 2011 or later ... ... @@ -512,11 +512,10 @@ 512 512 * 2010-D185 or later (reporting year start day ~-~-07-01 or later) 513 513 514 514 **Reporting Period** 515 - 516 516 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: 517 517 518 -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: 519 - 520 520 * 2011 or later 521 521 * 2010-07 or later 522 522 * 2010-07-01 or later ... ... @@ -534,7 +534,7 @@ 534 534 535 535 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". 536 536 537 -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’.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__>>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’. 538 538 539 539 === 4.3.1 Non-versioned artefacts === 540 540 ... ... @@ -542,8 +542,6 @@ 542 542 543 543 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. 544 544 545 -[[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_59eee18f.gif||alt="Shape3" height="1" width="192"]] 546 - 547 547 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. 548 548 549 549 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. ... ... @@ -614,3 +614,5 @@ 614 614 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. 615 615 616 616 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/}}