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,29 +57,29 @@ 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 ... ... @@ -98,33 +98,31 @@ 98 98 > "pattern": "^[A-Za-z0-9_@$-]+$" 99 99 > } 100 100 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. 101 +There are also cases, though, that data types cannot be (% style="color:#2ecc71" %)mapped(%%) like above. One such case is the array data type, which was introduced in [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 as a new [[representation>>doc:xwiki:Glossary.Representation.WebHome]]. 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>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] specific definition (i.e., specific element/[[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] names for [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]]). 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:1 026.29px" %)106 -|(% style="width:159px" %)**SDMX Facet**|(% style="width:179px" %)**XML Schema**|(% style="width: 683px" %)**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: 683px" %)(((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 108 "^-?( [1-9] [0-9] {3,}|0[0-9]{3}) (Z| (\ + | -) ((0 [0 - 9]| 1[0 - 3]):[0 - 5] [0 - 9] | 14:00))?$" 109 109 ))) 110 -|(% style="width:159px" %)GregorianMonth|(% style="width:179px" %)xsd:gYearMonth|(% style="width: 683px" %)(((110 +|(% style="width:159px" %)GregorianMonth|(% style="width:179px" %)xsd:gYearMonth|(% style="width:800px" %)((( 111 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))?$" 112 112 ))) 113 - 114 -(% style="width:1030.29px" %) 115 -|(% style="width:163px" %)GregorianDay|(% style="width:179px" %)xsd:date|(% style="width:684px" %)((( 113 +|(% style="width:163px" %)GregorianDay|(% style="width:179px" %)xsd:date|(% style="width:800px" %)((( 116 116 "^-?([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))?$" 117 117 ))) 118 -|(% style="width:163px" %)Day|(% style="width:179px" %)xsd:gDay|(% style="width: 684px" %)(((116 +|(% style="width:163px" %)Day|(% style="width:179px" %)xsd:gDay|(% style="width:800px" %)((( 119 119 "^~-~--(0[1-9]|[12][0-9]|3[01])(Z|(\+|- )((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$" 120 120 ))) 121 -|(% style="width:163px" %)MonthDay|(% style="width:179px" %)xsd:gMonthDay|(% style="width: 684px" %)(((119 +|(% style="width:163px" %)MonthDay|(% style="width:179px" %)xsd:gMonthDay|(% style="width:800px" %)((( 122 122 "^~-~-(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))?$" 123 123 ))) 124 -|(% style="width:163px" %)Month|(% style="width:179px" %)xsd:Month|(% style="width: 684px" %)(((122 +|(% style="width:163px" %)Month|(% style="width:179px" %)xsd:Month|(% style="width:800px" %)((( 125 125 "^~-~-(0[1-9]|1[0-2])(Z|(\+|-)((0[0-9]|1[0- 3]):[0-5][0-9]|14:00))?$" 126 126 ))) 127 -|(% style="width:163px" %)Duration|(% style="width:179px" %)xsd:duration|(% style="width: 684px" %)(((125 +|(% style="width:163px" %)Duration|(% style="width:179px" %)xsd:duration|(% style="width:800px" %)((( 128 128 "^-?P[0-9]+Y?([0-9]+M)?([0-9]+D)?(T([0- 9]+H)?([0-9]+M)?([0-9]+(\.[0-9]+)?S)?)?$" 129 129 ))) 130 130 ... ... @@ -134,56 +134,57 @@ 134 134 135 135 === {{id name="_Toc291507"/}}4.2.1 Introduction === 136 136 137 -First, it is important to recognize that most observation times are a period. SDMX specifies precisely how Time is handled. 135 +First, it is important to recognize that most observation times are a period. [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] specifies precisely how Time is handled. 138 138 139 -The representation of time is broken into a hierarchical collection of representations. A data structure definition can use of any of the representations in the hierarchy as the representation of time. This allows for the time dimension of a particular data structure definition allow for only a subset of the default representation. 137 +The [[representation>>doc:xwiki:Glossary.Representation.WebHome]] of time is broken into a hierarchical collection of [[representations>>doc:xwiki:Glossary.Representation.WebHome]]. A [[data structure definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] can use of any of the [[representations>>doc:xwiki:Glossary.Representation.WebHome]] in the [[hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] as the [[representation>>doc:xwiki:Glossary.Representation.WebHome]] of time. This allows for the time [[dimension>>doc:xwiki:Glossary.Dimension.WebHome]] of a particular [[data structure definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] allow for only a subset of the default [[representation>>doc:xwiki:Glossary.Representation.WebHome]]. 140 140 141 -The hierarchy of time formats is as follows (**bold** indicates a category which is made up of multiple formats, //italic// indicates a distinct format): 139 +The [[hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] of [[time formats>>doc:xwiki:Glossary.Time format.WebHome]] is as follows (**bold** indicates a [[category>>doc:xwiki:Glossary.Category.WebHome]] which is made up of multiple formats, //italic// indicates a distinct format): 142 142 143 -* **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//** 144 144 145 - ▪**BasicTimePeriod**149 +The details of these [[time period>>doc:xwiki:Glossary.Time period.WebHome]] [[categories>>doc:xwiki:Glossary.Category.WebHome]] and of the distinct formats which make them up are detailed in the sections to follow. 146 146 147 -* **Gregorian Time Period** 148 -* //Date Time// 149 - 150 -▪ **Reporting Time Period** 151 - 152 -o //Time Range// 153 - 154 -The details of these time period categories and of the distinct formats which make them up are detailed in the sections to follow. 155 - 156 156 === {{id name="_Toc291508"/}}4.2.2 Observational Time Period === 157 157 158 -This is the superset of all time representations in SDMX. This allows for time to be expressed as any of the allowable formats. 153 +This is the superset of all time [[representations>>doc:xwiki:Glossary.Representation.WebHome]] in [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]]. This allows for time to be expressed as any of the allowable formats. 159 159 160 160 === {{id name="_Toc291509"/}}4.2.3 Standard Time Period === 161 161 162 -This is the superset of any predefined time period or a distinct point in time. A time period consists of a distinct start and end point. If the start and end of a period are expressed as date instead of a complete date time, then it is implied that the start of the period is the beginning of the start day (i.e. 00:00:00) and the end of the period is the end of the end day (i.e. 23:59:59). 157 +This is the superset of any predefined [[time period>>doc:xwiki:Glossary.Time period.WebHome]] or a distinct point in time. A [[time period>>doc:xwiki:Glossary.Time period.WebHome]] consists of a distinct start and end point. If the start and end of a period are expressed as date instead of a complete date time, then it is implied that the start of the period is the beginning of the start day (i.e. 00:00:00) and the end of the period is the end of the end day (i.e. 23:59:59). 163 163 164 164 === {{id name="_Toc291510"/}}4.2.4 Gregorian Time Period === 165 165 166 -A Gregorian time period is always represented by a Gregorian year, year-month, or day. These are all based on ISO 8601 dates. The representation in SDMX-ML messages and the period covered by each of the Gregorian time periods are as follows: 161 +A Gregorian [[time period>>doc:xwiki:Glossary.Time period.WebHome]] is always represented by a Gregorian year, year-month, or day. These are all based on ISO 8601 dates. The [[representation>>doc:xwiki:Glossary.Representation.WebHome]] in [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] messages and the period covered by each of the Gregorian [[time periods>>doc:xwiki:Glossary.Time period.WebHome]] are as follows: 167 167 168 168 **Gregorian Year:** 169 169 170 -Representation: xs:gYear (YYYY) 165 +[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: xs:gYear (YYYY) 171 171 172 -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 173 173 174 - Representation:xs:gYearMonth(YYYY-MM)169 +**Gregorian Year Month**: 175 175 176 - Period: thestartof the first dayof themonthtoendof thelast dayof the month**Gregorian Day**:171 +[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: xs:gYearMonth (YYYY-MM) 177 177 178 - Representation:xs:date(YYYY-MM-DD)173 +Period: the start of the first day of the month to end of the last day of the month 179 179 175 +**Gregorian Day**: 176 + 177 +[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: xs:date (YYYY-MM-DD) 178 + 180 180 Period: the start of the day (00:00:00) to the end of the day (23:59:59) 181 181 182 182 === {{id name="_Toc291511"/}}4.2.5 Date Time === 183 183 184 -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. 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>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] for data which is measured at a distinct point in time rather than being reported over a period, the date-time [[representation>>doc:xwiki:Glossary.Representation.WebHome]] can be used. 185 185 186 -Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss) ^^[[(% class="wikiinternallink wikiinternallinkwikiinternallinkwikiinternallinkwikiinternallink wikiinternallink wikiinternallink" %)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^185 +[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: xs:dateTime (YYYY-MM-DDThh:mm:ss){{footnote}}The seconds can be reported fractionally{{/footnote}} 187 187 188 188 === {{id name="_Toc291512"/}}4.2.6 Standard Reporting Period === 189 189 ... ... @@ -197,7 +197,7 @@ 197 197 198 198 PERIOD_VALUE indicates the actual period within the year 199 199 200 -The following section details each of the standard reporting periods defined in SDMX: 199 +The following section details each of the standard reporting periods defined in [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]]: 201 201 202 202 **Reporting Year**: 203 203 ... ... @@ -207,8 +207,10 @@ 207 207 208 208 Limit per year: 1 209 209 210 -Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1) **Reporting Semester:**209 +[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: common:ReportingYearType (YYYY-A1, e.g. 2000-A1) 211 211 211 +**Reporting Semester:** 212 + 212 212 Period Indicator: S 213 213 214 214 Period Duration: P6M (six months) ... ... @@ -215,10 +215,8 @@ 215 215 216 216 Limit per year: 2 217 217 218 -Representation: common:ReportingSemesterType (YYYY-Ss, e.g. 2000-S2) 219 +[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: common:ReportingSemesterType (YYYY-Ss, e.g. 2000-S2) 219 219 220 -[[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_59eee18f.gif||alt="Shape2" height="1" width="192"]] 221 - 222 222 **Reporting Trimester:** 223 223 224 224 Period Indicator: T ... ... @@ -227,8 +227,10 @@ 227 227 228 228 Limit per year: 3 229 229 230 -Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3) **Reporting Quarter:**229 +[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3) 231 231 231 +**Reporting Quarter:** 232 + 232 232 Period Indicator: Q 233 233 234 234 Period Duration: P3M (three months) ... ... @@ -235,8 +235,10 @@ 235 235 236 236 Limit per year: 4 237 237 238 -Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4) **Reporting Month**:239 +[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4) 239 239 241 +**Reporting Month**: 242 + 240 240 Period Indicator: M 241 241 242 242 Period Duration: P1M (one month) ... ... @@ -243,7 +243,7 @@ 243 243 244 244 Limit per year: 1 245 245 246 -Representation: common:ReportingMonthType (YYYY-Mmm, e.g. 2000-M12) 249 +[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: common:ReportingMonthType (YYYY-Mmm, e.g. 2000-M12) 247 247 248 248 Notes: The reporting month 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. 249 249 ... ... @@ -255,9 +255,9 @@ 255 255 256 256 Limit per year: 53 257 257 258 -Representation: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53) 261 +[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53) 259 259 260 -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="wikiinternallinkwikiinternallinkwikiinternallinkwikiinternallinkwikiinternallink wikiinternallinkwikiinternallink"%)^^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.{{footnote}}ISO 8601 defines alternative definitions for the first week, all of which produce equivalent results. Any of these definitions could be substituted so long as they are in relation to the reporting year start day.{{/footnote}} 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. 261 261 262 262 **Reporting Day**: 263 263 ... ... @@ -267,113 +267,83 @@ 267 267 268 268 Limit per year: 366 269 269 270 -Representation: common:ReportingDayType (YYYY-Dddd, e.g. 2000-D366) 273 +[[Representation>>doc:xwiki:Glossary.Representation.WebHome]]: common:ReportingDayType (YYYY-Dddd, e.g. 2000-D366) 271 271 272 272 Notes: There are either 365 or 366 days in a reporting year, depending on whether the reporting year includes leap day (February 29). The reporting day is always represented as three digits, therefore 1-99 are 0 padded (e.g. 001). This allows the values to be sorted chronologically using textual sorting methods. 273 273 274 274 The meaning of a reporting year is always based on the start day of the year and requires that the reporting year is expressed as the year at the start of the period. This start day is always the same for a reporting year, and is expressed as a day and a month (e.g. July 1). Therefore, the reporting year 2000 with a start day of July 1 begins on July 1, 2000. 275 275 276 -A specialized attribute (reporting year start day) exists for the purpose of communicating the reporting year start day. This attribute has a fixed identifier 279 +A specialized [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] (reporting year start day) exists for the purpose of communicating the reporting year start day. This [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] has a fixed identifier 277 277 278 -(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. 281 +(REPORTING_YEAR_START_DAY) and a fixed [[representation>>doc:xwiki:Glossary.Representation.WebHome]] (xs:gMonthDay) so that it can always be easily identified and processed in a data message. Although this [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] exists in specialized sub-class, it functions the same as any other [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] outside of its identification and [[representation>>doc:xwiki:Glossary.Representation.WebHome]]. It must takes its identity from a (% style="color:#2ecc71" %)concept(%%) and state its relationship with other [[components>>doc:xwiki:Glossary.Component.WebHome]] of the [[data structure definition>>doc:xwiki:Glossary.Data structure definition.WebHome]]. The ability to state this relationship allows this reporting year start day [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] to exist at the appropriate (% style="color:#2ecc71" %)levels(%%) of a data message. In the absence of this [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]], the reporting year start date is assumed to be January 1; therefore if the reporting year coincides with the calendar year, this [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is not necessary. 279 279 280 -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]): 281 281 282 - Gregoriancalendar period covered bythereporting periodcan be computed as follows285 +**~1. Determine [REPORTING_YEAR_BASE]:** 283 283 284 -(based on the standard format of [REPROTING_YEAR]- 285 - 286 -[PERIOD_INDICATOR][PERIOD_VALUE] and the reporting year start day as [REPORTING_YEAR_START_DAY]): 287 - 288 -1. **Determine [REPORTING_YEAR_BASE]:** 289 - 290 290 Combine [REPORTING_YEAR] of the reporting period value (YYYY) with [REPORTING_YEAR_START_DAY] (MM-DD) to get a date (YYYY-MM-DD). 291 - 292 292 This is the [REPORTING_YEAR_START_DATE] 293 293 294 -1. 295 -11. **If the [PERIOD_INDICATOR] is W:** 296 -111. **If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday:** 290 +**a) If the [PERIOD_INDICATOR] is W:** 297 297 298 -Add^^[[(% class="wikiinternallink wikiinternallink wikiinternallink 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]. 299 299 300 -1. 301 -11. 302 -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]. 303 303 304 -Add^^4^^ (P0D, -P1D, -P2D, or -P3D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE]. 305 - 306 -1. 307 -11. **Else:** 308 - 298 +**b) Else:** 309 309 The [REPORTING_YEAR_START_DATE] is the [REPORTING_YEAR_BASE]. 310 310 311 - 1.**Determine [PERIOD_DURATION]:**312 - 11.If the [PERIOD_INDICATOR] is A, the [PERIOD_DURATION] is P1Y.313 - 11.If the [PERIOD_INDICATOR] is S, the [PERIOD_DURATION] is P6M.314 - 11.If the [PERIOD_INDICATOR] is T, the [PERIOD_DURATION] is P4M.315 - 11.If the [PERIOD_INDICATOR] is Q, the [PERIOD_DURATION] is P3M.316 - 11.If the [PERIOD_INDICATOR] is M, the [PERIOD_DURATION] is P1M.317 - 11.If the [PERIOD_INDICATOR] is W, the [PERIOD_DURATION] is P7D.318 - 11.If the [PERIOD_INDICATOR] is D, the [PERIOD_DURATION] is P1D.319 - 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]:** 320 320 321 -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{{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}} this to the [REPORTING_YEAR_BASE]. The result is the [PERIOD_START]. 322 322 323 - Multiplythe [PERIOD_VALUE] by the[PERIOD_DURATION]. Add^^4^^this to the[REPORTING_YEAR_BASE] add^^4^^ -P1D. Theresultisthe [PERIOD_END].313 +**4. Determine the [PERIOD_END]:** 324 324 315 +Multiply the [PERIOD_VALUE] by the [PERIOD_DURATION]. 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}} this to the [REPORTING_YEAR_BASE] add{{footnote}}The rules for adding durations to a date time are described in the W3C XML Schema specification. See http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes for further details.{{/footnote}} -P1D. The result is the [PERIOD_END]. 316 + 325 325 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). 326 326 327 327 **Examples:** 328 328 329 329 **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 330 330 331 -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 332 332 333 -b) [REPORTING_YEAR_BASE] = 2010-07-01 334 - 335 -1. [PERIOD_DURATION] = P3M 336 -1. (2-1) * P3M = P3M 337 - 338 -2010-07-01 + P3M = 2010-10-01 339 - 340 -[PERIOD_START] = 2010-10-01 341 - 342 -1. 2 * P3M = P6M 343 - 344 -2010-07-01 + P6M = 2010-13-01 = 2011-01-01 345 - 346 -2011-01-01 + -P1D = 2010-12-31 347 - 348 -[PERIOD_END] = 2010-12-31 349 - 350 350 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 351 351 352 352 **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 353 353 354 -1. [REPORTING_YEAR_START_DATE] = 2010-07-01 355 - 356 -a) 2011-07-01 = Friday 357 - 358 -2011-07-01 + P3D = 2011-07-04 359 - 360 -[REPORTING_YEAR_BASE] = 2011-07-04 361 - 362 -1. [PERIOD_DURATION] = P7D 363 -1. (36-1) * P7D = P245D 364 - 365 -2011-07-04 + P245D = 2012-03-05 366 - 367 -[PERIOD_START] = 2012-03-05 368 - 369 -1. 36 * P7D = P252D 370 - 371 -2011-07-04 + P252D =2012-03-12 372 - 373 -2012-03-12 + -P1D = 2012-03-11 374 - 375 -[PERIOD_END] = 2012-03-11 376 - 377 377 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 378 378 379 379 === {{id name="_Toc291513"/}}4.2.7 Distinct Range === ... ... @@ -384,29 +384,29 @@ 384 384 385 385 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. 386 386 387 -|Code|Format 388 -|OTP|Observational Time Period: Superset of all SDMX time formats (Gregorian Time Period, Reporting Time Period, and Time Range) 389 -|STP|Standard Time Period: Superset of Gregorian and Reporting Time Periods 390 -|GTP|Superset of all Gregorian Time Periods and date-time 391 -|RTP|Superset of all Reporting Time Periods 392 -|TR|((( 393 -Time Range: Start time and duration (YYYY-MM- 394 - 395 -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>) 396 396 ))) 397 -|GY|Gregorian Year (YYYY) 398 -|GTM|Gregorian Year Month (YYYY-MM) 399 -|GD|Gregorian Day (YYYY-MM-DD) 400 -|DT|Distinct Point: date-time (YYYY-MM-DDThh:mm:ss) 401 -|RY|Reporting Year (YYYY-A1) 402 -|RS|Reporting Semester (YYYY-Ss) 403 -|RT|Reporting Trimester (YYYY-Tt) 404 -|RQ|Reporting Quarter (YYYY-Qq) 405 -|RM|Reporting Month (YYYY-Mmm) 406 -|RW|Reporting Week (YYYY-Www) 407 -|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) 408 408 409 -==== Table 1: SDMX-ML Time Format Codes ==== 381 +(% class="wikigeneratedid" id="HTable1:SDMX-MLTimeFormatCodes" %) 382 +**Table 1: SDMX-ML Time Format Codes** 410 410 411 411 === {{id name="_Toc291515"/}}4.2.9 Time Zones === 412 412 ... ... @@ -433,11 +433,11 @@ 433 433 434 434 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: 435 435 436 -<Series REF_PERIODStartTime="2000-01-01T00:00:00" REF_PERIOD="P2M"/> 409 +> <Series REF_PERIODStartTime="2000-01-01T00:00:00" REF_PERIOD="P2M"/> 437 437 438 438 can now be represented with this: 439 439 440 -<Series REF_PERIOD="2000-01-01T00:00:00/P2M"/> 413 +> <Series REF_PERIOD="2000-01-01T00:00:00/P2M"/> 441 441 442 442 === {{id name="_Toc291517"/}}4.2.11 Notes on Formats === 443 443 ... ... @@ -453,12 +453,13 @@ 453 453 454 454 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. 455 455 456 -|**Operator**|**Rule** 457 -|Greater Than|Any data after the last moment of the period 458 -|Less Than|Any data before the first moment of the period 459 -|Greater Than or Equal To|Any data on or after the first moment of the period 460 -|Less Than or Equal To|Any data on or before the last moment of the period 461 -|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 462 462 463 463 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. 464 464 ... ... @@ -465,11 +465,8 @@ 465 465 **Examples:** 466 466 467 467 **Gregorian Period** 468 - 469 469 Query Parameter: Greater than 2010 470 - 471 471 Literal Interpretation: Any data where the start period occurs after 2010-1231T23:59:59. 472 - 473 473 Example Matches: 474 474 475 475 * 2011 or later ... ... @@ -485,11 +485,10 @@ 485 485 * 2010-D185 or later (reporting year start day ~-~-07-01 or later) 486 486 487 487 **Reporting Period** 488 - 489 489 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: 490 490 491 -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: 492 - 493 493 * 2011 or later 494 494 * 2010-07 or later 495 495 * 2010-07-01 or later ... ... @@ -507,7 +507,7 @@ 507 507 508 508 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". 509 509 510 -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’. 511 511 512 512 === 4.3.1 Non-versioned artefacts === 513 513 ... ... @@ -515,8 +515,6 @@ 515 515 516 516 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. 517 517 518 -[[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_59eee18f.gif||alt="Shape3" height="1" width="192"]] 519 - 520 520 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. 521 521 522 522 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.