Skip to Content
Last modified by Helena on 2025/09/10 11:19
From version 7.3
edited by Helena
on 2025/05/14 13:30
Change comment: There is no comment for this version
To version 19.7
edited by Helena
on 2025/05/16 16:02
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -1 Overview
1 +SDMX STANDARDS
Parent
... ... @@ -1,0 +1,1 @@
1 +Methodology.WebHome
Tags
... ... @@ -1,0 +1,1 @@
1 +Artefact|Code|Code list|Hierarchy|Reference metadata|SDMX-EDI|SDMX-JSON|SDMX-ML|Statistical data and metadata exchange|Structural metadata
Content
... ... @@ -4,69 +4,71 @@
4 4  
5 5  **Revision History**
6 6  
7 -|Revision|Date|Contents
8 -|DRAFT 1.0|May 2021|Draft release updated for SDMX 3.0 for public consultation
9 -|1.0|October 2021|Public Release for SDMX 3.0
7 +(% style="width:738.039px" %)
8 +|(% style="width:187px" %)Revision|(% style="width:157px" %)Date|(% style="width:390px" %)Contents
9 +|(% style="width:187px" %)DRAFT 1.0|(% style="width:157px" %)May 2021|(% style="width:390px" %)Draft release updated for SDMX 3.0 for public consultation
10 +|(% style="width:187px" %)1.0|(% style="width:157px" %)October 2021|(% style="width:390px" %)Public Release for SDMX 3.0
10 10  
11 11  = 1 Overview =
12 12  
13 -SDMX version 3.0 introduces new features, improvements and changes to the Standard in the following key areas:
14 +[[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] (% style="color:#2ecc71" %)version(%%) 3.0 introduces new features, improvements and changes to the Standard in the following key areas:
14 14  
15 15  **Information Model**
16 16  
17 -* Simplification and improvement of the reference metadata model
18 +* Simplification and improvement of the [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] model
18 18  * Support for microdata
19 19  * Support for geospatial data
20 -* Support for code list extension and discriminated union of code lists
21 +* Support for [[code list>>doc:xwiki:Glossary.Code list.WebHome]] extension and discriminated union of [[code>>doc:xwiki:Glossary.Code.WebHome]] lists
21 21  * Improvements to structure mapping
22 -* Improvements to code hierarchies for data discovery
23 +* Improvements to [[code>>doc:xwiki:Glossary.Code.WebHome]] [[hierarchies>>doc:xwiki:Glossary.Hierarchy.WebHome]] for data discovery
23 23  * Improvements to constraints
24 24  
25 25  **Versioning of Structural Metadata Artefacts**
26 26  
27 -* Adoption of the three-number semantic versioning standard for structural metadata artefacts ([[https:~~/~~/semver.org/>>https://semver.org/||target="_blank"]])
28 +* Adoption of the three-number semantic versioning standard for [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] ([[https:~~/~~/semver.org/>>https://semver.org/||rel="noopener noreferrer" target="_blank"]])
28 28  
29 29  **REST Web Services Application Programming Interface (API)**
30 30  
31 31  * Change to a single ‘structure’ resource for structure queries simplifying the REST API specification by reducing the number of resources to five
32 32  * Improvements to data queries
33 -* Improvements to reference metadata queries
34 -* Support for structural metadata maintenance using HTTP PUT, POST and DELETE verbs
34 +* Improvements to [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] queries
35 +* Support for [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] maintenance using HTTP PUT, POST and DELETE verbs
35 35  
36 36  **SOAP Web Services API**
37 37  
38 -* The SOAP web services API has been deprecated with version 3.0 standardising on REST**;**
39 +* The SOAP web services API has been deprecated with (% style="color:#2ecc71" %)version(%%) 3.0 standardising on REST**;**
39 39  
40 40  **XML, JSON, CSV and EDI Transmission formats**
41 41  
42 -* The SDMX-ML, SDMX-JSON and SDMX-CSV specifications have been extended and modified where needed to support the new features and changes such as reference metadata and microdata
43 -* Obsolete SDMX-ML data message variants including Generic, Compact, Utility and Cross-sectional have been deprecated standardising on Structure Specific Data as the sole XML format for data exchange
44 -* The SDMX-EDI transmission format for structures and data has been deprecated
45 -* The organisation of structures into ‘collections’ in SDMX-ML and SDMX-JSON structure messages has been flattened and simplified
46 -* The option to reference structures in SDMX-ML and SDMX-JSON messages using Agency, ID and Version has been deprecated with URN now exclusively used for all non-local referencing purpose
43 +* The [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]], [[SDMX-JSON>>doc:xwiki:Glossary.SDMX-JSON.WebHome]] and [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]]-CSV specifications have been extended and modified where needed to support the new features and changes such as [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] and microdata
44 +* Obsolete [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] data message variants including Generic, Compact, Utility and Cross-sectional have been deprecated standardising on Structure Specific Data as the sole XML format for data exchange
45 +* The [[SDMX-EDI>>doc:xwiki:Glossary.SDMX-EDI.WebHome]] transmission format for structures and data has been deprecated
46 +* The organisation of structures into ‘collections’ in [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] and [[SDMX-JSON>>doc:xwiki:Glossary.SDMX-JSON.WebHome]] structure messages has been flattened and simplified
47 +* The option to reference structures in [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] and [[SDMX-JSON>>doc:xwiki:Glossary.SDMX-JSON.WebHome]] messages using Agency, ID and (% style="color:#2ecc71" %)Version(%%) has been deprecated with URN now exclusively used for all non-local referencing purpose
47 47  
48 48  **Breaking Changes**
49 49  
50 -Many of the changes made are ‘breaking’ meaning that, while conversion between versions may be possible in certain circumstances, the 3.0 specification is not directly backwardly compatible with earlier versions of the Standard.
51 +Many of the changes made are ‘breaking’ meaning that, while conversion between (% style="color:#2ecc71" %)versions(%%) may be possible in certain circumstances, the 3.0 specification is not directly backwardly compatible with earlier (% style="color:#2ecc71" %)versions(%%) of the Standard.
51 51  
52 52  A summary of the main breaking changes is given in chapter 2.
53 53  
54 54  **Content of the Document**
55 55  
56 -The remainder of the document provides a summary of the main changes. More detailed information can be found the SDMX 3.0 Technical Specifications, in particular:
57 +The remainder of the document provides a summary of the main changes. More detailed information can be found the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 Technical Specifications, in particular:
57 57  
58 58  * Section 2 – Information Model
59 59  * Section 5 – Registry Specification
60 60  * Section 6 – Technical Notes
61 -* SDMX-TWG GitHub for the REST API and the XML, JSON and CSV formats
62 +* [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]]-TWG GitHub for the REST API and the XML, JSON and CSV formats
62 62  
63 63  = 2 Summary of Breaking Changes in 3.0 =
64 64  
65 -Version 3.0 introduces breaking changes into the web services API, transmission formats and information model. A summary is given in the table below.
66 +(% style="color:#2ecc71" %)Version(%%) 3.0 introduces breaking changes into the web services API, transmission formats and information model. A summary is given in the table below.
66 66  
67 -== //2.1 Web Services API// ==
68 +== 2.1 Web Services API ==
68 68  
69 -|**REST API**|(((
70 +(% style="width:948.039px" %)
71 +|**REST API**|(% style="width:818px" %)(((
70 70  The REST API is not backwardly compatible due to modifications to the URLs and query parameters resulting in breaking changes in four of the five main resources:
71 71  
72 72  * Structure queries
... ... @@ -78,139 +78,125 @@
78 78  
79 79  //Guidance for implementors//
80 80  
81 -REST API implementors may provide partial backward compatibility by using web server URL rewriting rules to translate version 2.1 structure queries to the 3.0 equivalent.
83 +REST API implementors may provide partial backward compatibility by using web server URL rewriting rules to translate (% style="color:#2ecc71" %)version(%%) 2.1 structure queries to the 3.0 equivalent.
82 82  
83 -Implementors are also recommended to version their API services providing users with an explicit choice of which version to use.
85 +Implementors are also recommended to (% style="color:#2ecc71" %)version(%%) their API services providing users with an explicit choice of which (% style="color:#2ecc71" %)version(%%) to use.
84 84  )))
85 -|**SOAP API**|The SOAP API has been deprecated.
87 +|**SOAP API**|(% style="width:818px" %)The SOAP API has been deprecated.
86 86  
87 -== //2.2 Transmission Formats// ==
89 +== 2.2 Transmission Formats ==
88 88  
89 -:
90 -
91 91  (((
92 -|**SDMX-ML**|(((
92 +(% style="width:952.039px" %)
93 +|(% style="width:130px" %)**SDMX-ML**|(% style="width:820px" %)(((
93 93  The following legacy XML data messages have been deprecated:
94 94  
95 -SDMX-ML 1.0/2.0 Generic (time-series) data message
96 +[[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] 1.0/2.0 Generic (time-series) data message
97 +[[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] 1.0/2.0 Compact (time-series) data message
98 +[[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] 1.0/2.0 Utility (time-series) data message
99 +[[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] 1.0/2.0 Cross-Sectional data message [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] 2.1 Generic data messages (for observations, time-series and cross-sectional data)
96 96  
97 -SDMX-ML 1.0/2.0 Compact (time-series) data message
101 +Structure Specific is the only data message option in (% style="color:#2ecc71" %)version(%%) 3.0 but is not backwardly compatible with (% style="color:#2ecc71" %)version(%%) 2.1 due to several changes including deprecation of the option to reference structures like the [[DSD>>doc:xwiki:Glossary.Data structure definition.WebHome]], [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] and [[Provision Agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]] using their Agency, ID and (% style="color:#2ecc71" %)Version(%%). The time series variant of the message has also been deprecated.
98 98  
99 -SDMX-ML 1.0/2.0 Utility (time-series) data message
103 +The [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] structure message is not backwardly compatible primarily due to:
100 100  
101 -SDMX-ML 1.0/2.0 Cross-Sectional data message SDMX-ML 2.1 Generic data messages (for observations, time-series and cross-sectional data)
102 -
103 -Structure Specific is the only data message option in version 3.0 but is not backwardly compatible with version 2.1 due to several changes including deprecation of the option to reference structures like the DSD, Dataflow and Provision Agreement using their Agency, ID and Version. The time series variant of the message has also been deprecated.
104 -
105 -The SDMX-ML structure message is not backwardly compatible primarily due to:
106 -
107 107  * Changes to the information model
108 -* Changes to the way the structures are organised into
109 -
110 -‘collections’ within the message
111 -
112 -* Deprecation of the Agency, ID, Version option for referencing of structures in messages
106 +* Changes to the way the structures are organised into ‘collections’ within the message
107 +* Deprecation of the Agency, ID, (% style="color:#2ecc71" %)Version(%%) option for referencing of structures in messages
113 113  )))
114 -|**SDMX-JSON**|(((
115 -The JSON data message is not backwardly compatible with version 2.1 primarily due to changes needed to support the improved REST API data queries, in particular the ability to retrieve in one operation data from multiple datasets with potentially different Data Structure Definitions.
109 +|(% style="width:130px" %)**SDMX-JSON**|(% style="width:820px" %)(((
110 +The JSON data message is not backwardly compatible with (% style="color:#2ecc71" %)version(%%) 2.1 primarily due to changes needed to support the improved REST API data queries, in particular the ability to retrieve in one operation data from multiple [[datasets>>doc:xwiki:Glossary.Data set.WebHome]] with potentially different Data Structure Definitions.
116 116  
117 117  The JSON structure message is not backwardly compatible primarily due to:
118 118  
119 119  * Changes to the information model
120 -* Changes to the way the structures are organised into
121 -
122 -‘collections’ within the message
123 -
124 -* Deprecation of the Agency, ID, Version option for referencing of structures in messages
115 +* Changes to the way the structures are organised into ‘collections’ within the message
116 +* Deprecation of the Agency, ID, (% style="color:#2ecc71" %)Version(%%) option for referencing of structures in messages
125 125  )))
126 -|**SDMX-EDI**|The EDI format for both structures and data has been deprecated.
127 -|**SDMX-CSV**|The CSV data and reference metadata messages are not backwardly compatible with those under version 2.1 due to changes to the structure of the messages needed to support new features such as the improved REST API data queries.**     **
118 +|(% style="width:130px" %)**SDMX-EDI**|(% style="width:820px" %)The EDI format for both structures and data has been deprecated.
119 +|(% style="width:130px" %)**SDMX-CSV**|(% style="width:820px" %)The CSV data and [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] messages are not backwardly compatible with those under (% style="color:#2ecc71" %)version(%%) 2.1 due to changes to the structure of the messages needed to support new features such as the improved REST API data queries.
128 128  )))
129 129  
130 -== //2.3 Information Model// ==
122 +== 2.3 Information Model ==
131 131  
132 -:
133 -
134 134  (((
135 -|**Data Structure Definition**|(((
136 -The version 3.0 Data Structure Definition (DSD) model is not directly backwardly compatible with 2.1 primarily due to the deprecation of the special MeasureDimension.
125 +(% style="width:955.039px" %)
126 +|(% style="width:132px" %)**Data Structure Definition**|(% style="width:819px" %)(((
127 +The (% style="color:#2ecc71" %)version(%%) 3.0 [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] ([[DSD>>doc:xwiki:Glossary.Data structure definition.WebHome]]) model is not directly backwardly compatible with 2.1 primarily due to the deprecation of the special MeasureDimension.
137 137  
138 138  //Conversion guidance for implementors//
139 139  
140 -Version 2.1 DSDs can be converted to the 3.0 model by creating a measure with the “MEASURE” concept role applied as described in paragraph 3.5.
131 +(% style="color:#2ecc71" %)Version(%%) 2.1 DSDs can be converted to the 3.0 model by creating a [[measure>>doc:xwiki:Glossary.Measure.WebHome]] with the “[[MEASURE>>doc:xwiki:Glossary.Measure.WebHome]]” (% style="color:#2ecc71" %)concept(%%) role applied as described in paragraph 3.5.
141 141  
142 -Version 3.0 DSDs cannot be reliably converted to the 2.1 model due to the introduction of new features such as multiple measures and value arrays for measures and attributes.
133 +(% style="color:#2ecc71" %)Version(%%) 3.0 DSDs cannot be reliably converted to the 2.1 model due to the introduction of new features such as multiple [[measures>>doc:xwiki:Glossary.Measure.WebHome]] and value arrays for [[measures>>doc:xwiki:Glossary.Measure.WebHome]] and [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]].
143 143  )))
144 -|**Structure mapping model**|(((
145 -The structure mapping model has changed significantly in version 3.0 with deprecation of the Structure Set maintainable artefact and introduction of five new ones: Representation Map and four variants of item scheme map.
135 +|(% style="width:132px" %)**Structure mapping model**|(% style="width:819px" %)(((
136 +The structure mapping model has changed significantly in (% style="color:#2ecc71" %)version(%%) 3.0 with deprecation of the [[Structure Set>>doc:xwiki:Glossary.Structure set.WebHome]] [[maintainable artefact>>doc:xwiki:Glossary.Maintainable artefact.WebHome]] and introduction of five new ones: [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] (% style="color:#2ecc71" %)Map(%%) and four variants of [[item scheme>>doc:xwiki:Glossary.Item scheme.WebHome]] (% style="color:#2ecc71" %)map(%%).
146 146  
147 147  //Conversion guidance for implementors//
148 148  
149 -Version 2.1 structure sets can be practically converted to the version 3.0 structure mapping model.
140 +(% style="color:#2ecc71" %)Version(%%) 2.1 [[structure sets>>doc:xwiki:Glossary.Structure set.WebHome]] can be practically converted to the (% style="color:#2ecc71" %)version(%%) 3.0 structure mapping model.
150 150  
151 -Conversion from the version 3.0 structure mapping model to 2.1 is generally possible. However, when attempting to convert mapping rules from 2.1 to 3.0 and back to 2.1, the resulting Structure Set will not be precisely the same as the original. In converting to version 3.0, the system must generate IDs for each of the new maintainable artefacts, but details of the original Structure Set artefacts are lost.
142 +Conversion from the (% style="color:#2ecc71" %)version(%%) 3.0 structure mapping model to 2.1 is generally possible. However, when attempting to convert mapping rules from 2.1 to 3.0 and back to 2.1, the resulting [[Structure Set>>doc:xwiki:Glossary.Structure set.WebHome]] will not be precisely the same as the original. In converting to (% style="color:#2ecc71" %)version(%%) 3.0, the system must generate IDs for each of the new [[maintainable artefacts>>doc:xwiki:Glossary.Maintainable artefact.WebHome]], but details of the original [[Structure Set>>doc:xwiki:Glossary.Structure set.WebHome]] [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] are lost.
152 152  )))
153 -|**Reference metadata model**|(((
154 -The reference metadata model has changed in version 3.0 with modifications to the role of the Data Structure Definition, Metadata Structure Definition and Metadataflow artefacts. Metadata Provision Agreement and Metadata Provider Scheme have been added. Metadatasets are now identifiable.
144 +|(% style="width:132px" %)**Reference metadata model**|(% style="width:819px" %)(((
145 +The [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] model has changed in (% style="color:#2ecc71" %)version(%%) 3.0 with modifications to the role of the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]], [[Metadata Structure Definition>>doc:xwiki:Glossary.Metadata structure definition.WebHome]] and [[Metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]] [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]]. Metadata [[Provision Agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]] and Metadata Provider Scheme have been added. Metadatasets are now identifiable.
155 155  
156 -Version 2.1 reference metadata models are not valid in version 3.0.
147 +(% style="color:#2ecc71" %)Version(%%) 2.1 [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] models are not valid in (% style="color:#2ecc71" %)version(%%) 3.0.
157 157  
158 158  //Conversion guidance for implementors//
159 159  
160 -A version 2.1 Metadata Structure Definition can be converted to the version 3.0 model under some circumstances, but target information is either lost or has to be translated into a metadataflow. Further, conversion of a Data Structure Definition for collecting reference metadata against a dataset would need to make changes to the dataset’s Data Structure Definition. As the Data Structure Definition may not actually be specified, judgement would need to be taken, perhaps determining the most likely candidate by examining which
161 -)))
162 -| |(((
163 -already have metadata reported against their datasets. A 2.1 metadata report could be converted to a version 3.0 Metadataset if it is attached to a structure, but requires a Metadata Provision Agreement which would need to be created if not already in existence.
151 +A (% style="color:#2ecc71" %)version(%%) 2.1 [[Metadata Structure Definition>>doc:xwiki:Glossary.Metadata structure definition.WebHome]] can be converted to the (% style="color:#2ecc71" %)version(%%) 3.0 model under some circumstances, but target information is either lost or has to be translated into a [[metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]]. Further, conversion of a [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] for collecting [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] against a [[dataset>>doc:xwiki:Glossary.Data set.WebHome]] would need to make changes to the [[dataset>>doc:xwiki:Glossary.Data set.WebHome]]’s [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]]. As the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] may not actually be specified, judgement would need to be taken, perhaps determining the most likely candidate by examining which already have metadata reported against their [[datasets>>doc:xwiki:Glossary.Data set.WebHome]]. A 2.1 metadata report could be converted to a (% style="color:#2ecc71" %)version(%%) 3.0 Metadataset if it is attached to a structure, but requires a Metadata [[Provision Agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]] which would need to be created if not already in existence.
164 164  
165 -Conversion from the version 3.0 model to version 2.1 cannot be performed reliably. The process would need target information to be derived from analysis of the Metadataflows and Metadata Provision Agreements. Depending on the complexity it may not be possible to express that information in a version 2.1 Data Structure Definition.
153 +Conversion from the (% style="color:#2ecc71" %)version(%%) 3.0 model to (% style="color:#2ecc71" %)version(%%) 2.1 cannot be performed reliably. The process would need target information to be derived from analysis of the [[Metadataflows>>doc:xwiki:Glossary.Metadataflow.WebHome]] and Metadata [[Provision Agreements>>doc:xwiki:Glossary.Provision agreement.WebHome]]. Depending on the complexity it may not be possible to express that information in a (% style="color:#2ecc71" %)version(%%) 2.1 [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]].
166 166  )))
167 -|**Constraint model**|(((
168 -The version 2.1 Content Constraint artefact has been deprecated in version 3.0 and replaced by the Data Constraint for data, and the Metadata Constraint for reference metadata.
155 +|(% style="width:132px" %)**Constraint model**|(% style="width:819px" %)(((
156 +The (% style="color:#2ecc71" %)version(%%) 2.1 Content (% style="color:#2ecc71" %)Constraint(%%) [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] has been deprecated in (% style="color:#2ecc71" %)version(%%) 3.0 and replaced by the Data (% style="color:#2ecc71" %)Constraint(%%) for data, and the Metadata (% style="color:#2ecc71" %)Constraint(%%) for reference metadata.
169 169  
170 170  //Conversion guidance for implementors//
171 171  
172 -2.1 Content Constraints can be converted without loss to the equivalent version 3.0 Data Constraint model.
160 +2.1 Content (% style="color:#2ecc71" %)Constraints(%%) can be converted without loss to the equivalent (% style="color:#2ecc71" %)version(%%) 3.0 Data (% style="color:#2ecc71" %)Constraint(%%) model.
173 173  
174 174  Conversion from 3.0 to 2.1 presents challenges where wildcards have been used, in those cases requiring expansion of the wildcard into explicit values.
175 175  )))
176 -|**Hierarchical codelist structures**|(((
177 -The version 2.1 Hierarchical Codelist artefact has been deprecated in version 3.0 and replaced by two new artefacts, Hierarchy and Hierarchy Association.
164 +|(% style="width:132px" %)**Hierarchical codelist structures**|(% style="width:819px" %)(((
165 +The (% style="color:#2ecc71" %)version(%%) 2.1 Hierarchical Codelist [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] has been deprecated in (% style="color:#2ecc71" %)version(%%) 3.0 and replaced by two new [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]], [[Hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] and [[Hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] Association.
178 178  
179 179  //Conversion guidance for implementors//
180 180  
181 -Version 2.1 Hierarchical Codelists can be successfully converted to the version 3.0 hierarchy model. Information on which artefacts to link the hierarchies to on what context would need to be added as a separate procedure.
169 +(% style="color:#2ecc71" %)Version(%%) 2.1 Hierarchical Codelists can be successfully converted to the (% style="color:#2ecc71" %)version(%%) 3.0 [[hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] model. Information on which [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] to link the [[hierarchies>>doc:xwiki:Glossary.Hierarchy.WebHome]] to on what context would need to be added as a separate procedure.
182 182  
183 -Conversion from the version 3.0 model to version 2.1 is possible, but with loss of the linking information
171 +Conversion from the (% style="color:#2ecc71" %)version(%%) 3.0 model to (% style="color:#2ecc71" %)version(%%) 2.1 is possible, but with loss of the linking information
184 184  )))
185 185  )))
186 186  
187 187  = 3 Information Model =
188 188  
189 -== //3.1 Version 3.0 Information Model// ==
177 +== 3.1 Version 3.0 Information Model ==
190 190  
191 191  [[image:SDMX 3-0-0 Major Changes FINAL-1.0_en_6fc573fe.png||height="404" width="718"]]
192 192  
193 193  //Figure 1 Version 3.0 simplified Information Model UML class diagram with ‘heat map’ illustrating the areas with most change//
194 194  
195 -The schematic above is a simplified UML class diagram of the SDMX 3.0 information model illustrating the major areas of change as a ‘heat map’. Darker colours indicate where new structures have been added in version 3.0 or where structures have been significantly changed.
183 +The schematic above is a simplified UML class diagram of the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 information model illustrating the major areas of change as a ‘heat (% style="color:#2ecc71" %)map(%%)’. Darker colours indicate where new structures have been added in (% style="color:#2ecc71" %)version(%%) 3.0 or where structures have been significantly changed.
196 196  
197 -A number of ancillary structures including organisation schemes, process and reporting taxonomy are unchanged and have not been shown. Similarly, Organisation Scheme Map and Reporting Taxonomy Map have been omitted for simplicity. A schematic of the 2.1 model is given in Appendix A for comparison purposes.
185 +A number of ancillary structures including organisation schemes, process and [[reporting taxonomy>>doc:xwiki:Glossary.Reporting taxonomy.WebHome]] are unchanged and have not been shown. Similarly, Organisation Scheme (% style="color:#2ecc71" %)Map(%%) and [[Reporting Taxonomy>>doc:xwiki:Glossary.Reporting taxonomy.WebHome]] (% style="color:#2ecc71" %)Map(%%) have been omitted for simplicity. A schematic of the 2.1 model is given in Appendix A for comparison purposes.
198 198  
199 -== //3.2 Key Changes from Version 2.1// ==
187 +== 3.2 Key Changes from Version 2.1 ==
200 200  
201 201  New Maintainable Artefacts
202 202  
203 -* Structure Map
204 -* Representation Map
205 -* Organisation Scheme Map
206 -* Concept Scheme Map
207 -* Category Scheme Map
208 -* Reporting Taxonomy Map
191 +* Structure (% style="color:#2ecc71" %)Map
192 +* [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] (% style="color:#2ecc71" %)Map
193 +* Organisation Scheme (% style="color:#2ecc71" %)Map
194 +* (% style="color:#2ecc71" %)Concept(%%) Scheme (% style="color:#2ecc71" %)Map
195 +* Category Scheme (% style="color:#2ecc71" %)Map
196 +* Reporting Taxonomy (% style="color:#2ecc71" %)Map
209 209  * Value List
210 -* Hierarchy
211 -* Hierarchy Association
212 -* Metadata Constraint
213 -* Data Constraint
198 +* [[Hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]]
199 +* [[Hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] Association
200 +* Metadata (% style="color:#2ecc71" %)Constraint
201 +* Data (% style="color:#2ecc71" %)Constraint
214 214  * Metadata Provision Agreement
215 215  * Metadata Provider Scheme
216 216  * Metadataset
... ... @@ -223,24 +223,25 @@
223 223  
224 224  Removed Maintainable Artefacts
225 225  
226 -* Structure Set – replaced by Structure Map and the four item scheme maps
227 -* Hierarchical Codelist – replaced by Hierarchy and Hierarchy Association • Constraint – replaced by Data Constraint and Metadata Constraint
214 +* Structure Set – replaced by Structure (% style="color:#2ecc71" %)Map(%%) and the four [[item scheme>>doc:xwiki:Glossary.Item scheme.WebHome]] maps
215 +* Hierarchical Codelist – replaced by [[Hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] and [[Hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] Association
216 +* (% style="color:#2ecc71" %)Constraint(%%) – replaced by Data (% style="color:#2ecc71" %)Constraint(%%) and Metadata (% style="color:#2ecc71" %)Constraint
228 228  
229 229  Changed Maintainable Artefacts
230 230  
231 -* Data Structure Definition – support for microdatasets and reference metadata linked to data
232 -* Metadataflow – simplifies exchange of reference metadata, in particular those linked to structures
233 -* Metadata Structure Definition – simplified model for reference metadata
220 +* Data Structure Definition – support for microdatasets and [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] linked to data
221 +* Metadataflow – simplifies exchange of [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]], in particular those linked to structures
222 +* Metadata Structure Definition – simplified model for [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]]
234 234  * Codelist – support for codelist extension and geospatial specialised codelists (GeographicCodelist, GeoGridCodelist)
235 -* VTL Mapping Scheme – VTL Concept Mapping Scheme removed to align the VTL / SDMX interface with the 3.0 model
224 +* [[VTL>>doc:xwiki:Glossary.Validation and transformation language.WebHome]] Mapping Scheme – [[VTL>>doc:xwiki:Glossary.Validation and transformation language.WebHome]] (% style="color:#2ecc71" %)Concept(%%) Mapping Scheme removed to align the [[VTL>>doc:xwiki:Glossary.Validation and transformation language.WebHome]] / [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] interface with the 3.0 model
236 236  
237 -New Component Representation Types
226 +New [[Component>>doc:xwiki:Glossary.Component.WebHome]] [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] Types
238 238  
239 239  * GeospatialInformation – a string type where the value is an expression defining a set of geographical features using a purpose-designed syntax
240 240  
241 -== //3.3 Areas Unchanged from Version 2.1// ==
230 +== 3.3 Areas Unchanged from Version 2.1 ==
242 242  
243 -The following areas of the information model are unchanged from version 2.1:
232 +The following areas of the information model are unchanged from (% style="color:#2ecc71" %)version(%%) 2.1:
244 244  
245 245  * Categories
246 246  * Concepts
... ... @@ -247,18 +247,18 @@
247 247  * Data providers
248 248  * Agencies
249 249  * Data consumers
250 -* VTL transformation and expressions – with the exception of VTL mapping scheme as already noted
239 +* [[VTL>>doc:xwiki:Glossary.Validation and transformation language.WebHome]] transformation and expressions – with the exception of [[VTL>>doc:xwiki:Glossary.Validation and transformation language.WebHome]] mapping scheme as already noted
251 251  * Reporting taxonomy
252 252  * Process
253 253  
254 -== //3.4 Reference Metadata// ==
243 +== 3.4 Reference Metadata ==
255 255  
256 -Reference metadata has been substantially re-designed for version 3.0 to simplify the model and better support practical use cases.
245 +[[Reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] has been substantially re-designed for (% style="color:#2ecc71" %)version(%%) 3.0 to simplify the model and better support practical use cases.
257 257  
258 -=== Simplify Metadata Structure Definition ===
247 +(% class="wikigeneratedid" id="HSimplifyMetadataStructureDefinition" %)
248 +**Simplify Metadata Structure Definition**
249 +The [[Metadata Structure Definition>>doc:xwiki:Glossary.Metadata structure definition.WebHome]] ([[MSD>>doc:xwiki:Glossary.Metadata structure definition.WebHome]]) has been simplified to remove target information, and the support of multiple report structures. The [[MSD>>doc:xwiki:Glossary.Metadata structure definition.WebHome]] now only contains Metadata [[Attributes>>doc:xwiki:Glossary.Attribute.WebHome]] which are used to define the structure of a report.
259 259  
260 -The Metadata Structure Definition (MSD) has been simplified to remove target information, and the support of multiple report structures. The MSD now only contains Metadata Attributes which are used to define the structure of a report.
261 -
262 262  [[image:SDMX 3-0-0 Major Changes FINAL-1.0_en_ad5f5c97.png||height="346" width="494"]]
263 263  
264 264  //Figure 2 version 2.1 Metadata Structure Definition (MSD)//
... ... @@ -267,249 +267,191 @@
267 267  
268 268  //Figure 3 the simplified version 3.0 MSD//
269 269  
270 -=== Change to reference metadata reported against data ===
259 +(% class="wikigeneratedid" id="HChangetoreferencemetadatareportedagainstdata" %)
260 +**Change to reference metadata reported against data**
271 271  
272 -Reference metadata associated with datasets, data series or observations are now reported with the data. The dataset’s DSD must reference an MSD to define the structure of its reference metadata. In practice reference metadata for data are transmitted as part of the data message. The metadata attributes are treated in a similar way to the data attributes appearing in the message at the dataset, data series or individual observation level as appropriate. In contrast to simple data attributes, metadata attributes defined by an MSD can be organised into a hierarchical structure as illustrated in Figure 3 above. For this reason, metadata attributes appear in data messages structured in the same way as metadata messages.
262 +(% class="wikigeneratedid" id="HChangetoreferencemetadatareportedagainstdata" %)
263 +[[Reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] associated with [[datasets>>doc:xwiki:Glossary.Data set.WebHome]], data series or observations are now reported with the data. The [[dataset>>doc:xwiki:Glossary.Data set.WebHome]]’s [[DSD>>doc:xwiki:Glossary.Data structure definition.WebHome]] must reference an [[MSD>>doc:xwiki:Glossary.Metadata structure definition.WebHome]] to define the structure of its [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]]. In practice [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] for data are transmitted as part of the data message. The metadata [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]] are treated in a similar way to the data [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]] appearing in the message at the [[dataset>>doc:xwiki:Glossary.Data set.WebHome]], data series or individual observation (% style="color:#2ecc71" %)level(%%) as appropriate. In contrast to simple data [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]], metadata [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]] defined by an [[MSD>>doc:xwiki:Glossary.Metadata structure definition.WebHome]] can be organised into a hierarchical structure as illustrated in Figure 3 above. For this reason, metadata [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]] appear in data messages structured in the same way as metadata messages.
273 273  
274 -The SDMX-ML example below is an excerpt from a structure specific data message illustrating reporting of reference metadata with a hierarchical structure at the observation level.
265 +The [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] example below is an excerpt from a structure specific data message illustrating reporting of [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] with a hierarchical structure at the observation (% style="color:#2ecc71" %)level(%%).
275 275  
276 276  For completeness, the excerpt also shows:
277 277  
278 -* OBS_STATUS – a simple observation-level data attribute
279 -* TITLE – a multi-lingual data attribute
280 -* SOURCE_AGENCY – a multi-value data attribute
269 +* OBS_STATUS – a simple observation-(% style="color:#2ecc71" %)level(%%) data [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]]
270 +* TITLE – a multi-lingual data [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]]
271 +* SOURCE_AGENCY – a multi-value data [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]]
281 281  
282 -<Obs xsi:type="dsd:ObsType" OBS_VALUE="112" OBS_STAUS=”A” TIME_PERIOD="2010-09">
273 +> <Obs xsi:type="dsd:ObsType" OBS_VALUE="112" OBS_STAUS=”A” TIME_PERIOD="2010-09">
274 +> <!—- complex multi-value and multi-lingual data attributes ~-~->
275 +> <Comp id="TITLE" xsi:type="ns1:TITLE_ATTRIBUTE">
276 +> <Value>
277 +> <common:Text xml:lang="en">Some English Text</common:Text>
278 +> <common:Text xml:lang="fr">Quelques textes en anglais</common:Text>
279 +> </Value>
280 +> </Comp>
281 +> <Comp id="SOURCE_AGENCY" xsi:type="ns1:SOURCE_AGENCY_ATTRIBUTE">
282 +> <Value>4F0</Value>
283 +> <Value>4D0</Value>
284 +> <Value>CZ2</Value>
285 +> </Comp>
286 +> <!—- metadata attributes are reported like in metadata messages ~-~->
287 +> <Metadata>
288 +> <Attribute id="COLLECTION">
289 +> <Attribute id="METHOD">
290 +> <Text lang="en">AAA</Text>
291 +> </Attribute>
292 +> </Attribute>
293 +> <Attribute id="CONTACT">
294 +> <Value>CONTACT 1</Value>
295 +> <Attribute id="NAME">
296 +> <Value>Contact 1 Name 1</Value>
297 +> </Attribute>
298 +> <Attribute id="NAME">
299 +> <Value>Contact 1 Name 2</Value>
300 +> </Attribute>
301 +> </Attribute>
302 +> <Attribute id="CONTACT">
303 +> <Value>CONTACT 2</Value>
304 +> <Attribute id="NAME">
305 +> <Value>Contact 2 Name 1</Value>
306 +> </Attribute>
307 +> <Attribute id="NAME">
308 +> <Value>Contact 2 Name 2</Value>
309 +> </Attribute>
310 +> </Attribute>
311 +> </Metadata>
312 +> </Obs>
283 283  
284 -<!—- complex multi-value and multi-lingual data attributes ~-~->
314 +(% class="wikigeneratedid" id="HNew-MetadataProvisionAgreement" %)
315 +**New - Metadata Provision Agreement**
285 285  
286 -<Comp id="TITLE" xsi:type="ns1:TITLE_ATTRIBUTE">
317 +(% class="wikigeneratedid" id="HNew-MetadataProvisionAgreement" %)
318 +In (% style="color:#2ecc71" %)version(%%) 2.1 a [[Provision Agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]] could be used to report information against a [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] or [[Metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]]. From (% style="color:#2ecc71" %)version(%%) 3.0 this is managed by two separate structures, the Data [[Provision Agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]] and the Metadata [[Provision Agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]].
287 287  
288 -<Value>
320 +(% class="wikigeneratedid" id="HMovetargettoMetadataflowandMetadataProvisionAgreement" %)
321 +**Move target to Metadataflow and Metadata Provision Agreement**
322 +For [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] that is reported against structures, the allowable targets information which is used to specify what structures the [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] can be reported against, has moved to the [[Metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]] and can be further refined in the Metadata [[Provision Agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]].
289 289  
290 -<common:Text xml:lang="en">Some English Text</common:Text>
324 +(% class="wikigeneratedid" id="HAddmaintainablepropertiestoreferencemetadata" %)
325 +**Add maintainable properties to reference metadata**
326 +A Metadataset now has mandatory identification information, (owner id, id, (% style="color:#2ecc71" %)version(%%)) enabling metadata providers to uniquely identify their reports for create, update or delete maintenance operations.
291 291  
292 -<common:Text xml:lang="fr">Quelques textes en anglais</common:Text>
328 +== 3.5 Microdata Exchange ==
293 293  
294 -</Value>
330 +Several changes have been made the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] to support microdata use cases in addition to aggregated time series.
295 295  
296 -</Comp>
332 +(% class="wikigeneratedid" id="HMultiplemeasures" %)
333 +**Multiple measures**Multiple [[measures>>doc:xwiki:Glossary.Measure.WebHome]] are a common characteristic of microdatasets. To support this use case, the MeasureDimension has been deprecated and replaced with the option to define zero or more [[measures>>doc:xwiki:Glossary.Measure.WebHome]]. [[Measures>>doc:xwiki:Glossary.Measure.WebHome]] now act like any other [[component>>doc:xwiki:Glossary.Component.WebHome]] in that they use (% style="color:#2ecc71" %)concepts(%%), can have their own local coded or uncoded [[representation>>doc:xwiki:Glossary.Representation.WebHome]] defined within the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]], and can be either mandatory or conditional. Creating a [[measure>>doc:xwiki:Glossary.Measure.WebHome]] with the “[[MEASURE>>doc:xwiki:Glossary.Measure.WebHome]]” (% style="color:#2ecc71" %)concept(%%) role applied emulates the (% style="color:#2ecc71" %)version(%%) 2.1 MeasureDimension behaviour as illustrated in the [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] example below:
297 297  
298 -<Comp id="SOURCE_AGENCY" xsi:type="ns1:SOURCE_AGENCY_ATTRIBUTE">
335 +> <str:MeasureList id=”MeasureDescriptor”>
336 +> <str:Measure id=”OBS_VALUE” minOccurs=”1” maxOccurs=”1” usage=”mandatory” > <str:ConceptIdentity>
337 +> <Ref id=”OBS_VALUE” maintainableParentID=”CONCEPTS” agencyID=”SDMX” maintainableParentVersion=”1.0.0” />
338 +> </str:ConceptIdentity>
339 +> <str:LocalRepresentation>
340 +> <str:TextFormat textType=”String” isMultiLingual=”true” />
341 +> </str:LocalRepresentation>
342 +> <str:ConceptRole>
343 +> <Ref id=”MEASURE” maintainableParentID=”SDMX_CONCEPT_ROLES” agencyID=”SDMX” maintainableParentVersion=”1.0.0” />
344 +> </str:ConceptRole>
345 +> </str:Measure>
346 +> ...
347 +> <str:Measure>
348 +> </str:MeasureList>
299 299  
300 -<Value>4F0</Value>
350 +(% class="wikigeneratedid" id="HMulti-valuemeasuresandattributes" %)
351 +**Multi-value measures and attributes**
352 +Both [[measures>>doc:xwiki:Glossary.Measure.WebHome]] and [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]] have been extended with the option to take ‘arrays’ of 193 multiple coded or uncoded values. This supports use cases like multiple observation 194 status flags. New //minOccurs// and //maxOccurs// properties define the valid number of 195 values. The //usage// property separately defines whether the [[measure>>doc:xwiki:Glossary.Measure.WebHome]] or [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is //mandatory// or optional. In the [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] [[measure>>doc:xwiki:Glossary.Measure.WebHome]] example above, the properties //minOccurs=”1” maxOccurs=”1” usage=”mandatory”// specify that OBS_VALUE must be 198 reported, and can only consist of a single value.
301 301  
302 -<Value>4D0</Value>
354 +(% class="wikigeneratedid" id="HAttributesrelationshiptomeasures" %)
355 +**Attributes relationship to measures**
356 +In addition to attaching [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]] to a specific (% style="color:#2ecc71" %)level(%%) within the [[dataset>>doc:xwiki:Glossary.Data set.WebHome]], their relationship 202 to [[measures>>doc:xwiki:Glossary.Measure.WebHome]] can also be defined.
303 303  
304 -<Value>CZ2</Value>
358 +(% class="wikigeneratedid" id="HValuelists" %)
359 +**Value lists**
360 +Value lists help in modelling microdata by providing an enumeration similar to [[code lists>>doc:xwiki:Glossary.Code list.WebHome]] 206 but allowing any string values without being restricted to the rules of [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] identifiers. That allows ValueItems (the equivalent to [[Code>>doc:xwiki:Glossary.Code.WebHome]]) to contain symbols like ‘¥’ and ‘€’, but also means they are not identifiable.
305 305  
306 -</Comp>
362 +== 3.6 Geospatial Data Exchange ==
307 307  
308 -<!—- metadata attributes are reported like in metadata messages ~-~->
364 +The (% style="color:#2ecc71" %)version(%%) 3.0 model has been extended to provide explicit support for geospatial data.
309 309  
310 -<Metadata>
366 +(% class="wikigeneratedid" id="HGeospatialInformationtype" %)
367 +**GeospatialInformation type**
368 +A new GeospatialInformation string type has been added which can be used as the [[representation>>doc:xwiki:Glossary.Representation.WebHome]] for any [[dimension>>doc:xwiki:Glossary.Dimension.WebHome]], [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] or measure [[component>>doc:xwiki:Glossary.Component.WebHome]]. The value which is a string expression conforming to the syntax defined in Section 6 of the technical specifications precisely defines a ‘Geo Feature Set’ – a collection of geographical features like points, lines or polygons. Its use is recommended in conjunction with the “GEO_FEATURE_SET” (% style="color:#2ecc71" %)concept(%%) role.
311 311  
312 -<Attribute id="COLLECTION">
370 +(% class="wikigeneratedid" id="HGeospatialcodelists" %)
371 +**Geospatial code lists**
313 313  
314 -<Attribute id="METHOD">
373 +(% class="wikigeneratedid" id="HGeospatialcodelists" %)
374 +Two new specialised types of [[code list>>doc:xwiki:Glossary.Code list.WebHome]] have been added where the definition of each [[code>>doc:xwiki:Glossary.Code.WebHome]] includes additional geospatial information in addition to the standard ID, name and description:
315 315  
316 -<Text lang="en">AAA</Text>
317 -
318 -</Attribute>
319 -
320 -</Attribute>
321 -
322 -<Attribute id="CONTACT">
323 -
324 -<Value>CONTACT 1</Value>
325 -
326 -<Attribute id="NAME">
327 -
328 -<Value>Contact 1 Name 1</Value>
329 -
330 -</Attribute>
331 -
332 -<Attribute id="NAME">
333 -
334 -<Value>Contact 1 Name 2</Value>
335 -
336 -</Attribute>
337 -
338 -</Attribute>
339 -
340 -<Attribute id="CONTACT">
341 -
342 -<Value>CONTACT 2</Value>
343 -
344 -<Attribute id="NAME">
345 -
346 -<Value>Contact 2 Name 1</Value>
347 -
348 -</Attribute>
349 -
350 -<Attribute id="NAME">
351 -
352 -<Value>Contact 2 Name 2</Value>
353 -
354 -</Attribute>
355 -
356 -</Attribute>
357 -
358 -</Metadata>
359 -
360 -</Obs>
361 -
362 -=== New - Metadata Provision Agreement ===
363 -
364 -In version 2.1 a Provision Agreement could be used to report information against a Dataflow or Metadataflow. From version 3.0 this is managed by two separate structures, the Data Provision Agreement and the Metadata Provision Agreement.
365 -
366 -=== Move target to Metadataflow and Metadata Provision Agreement ===
367 -
368 -For reference metadata that is reported against structures, the allowable targets information which is used to specify what structures the reference metadata can be reported against, has moved to the Metadataflow and can be further refined in the Metadata Provision Agreement.
369 -
370 -=== Add maintainable properties to reference metadata ===
371 -
372 -A Metadataset now has mandatory identification information, (owner id, id, version) enabling metadata providers to uniquely identify their reports for create, update or delete maintenance operations.
373 -
374 -== //3.5 Microdata Exchange// ==
375 -
376 -Several changes have been made the Data Structure Definition to support microdata use cases in addition to aggregated time series.
377 -
378 -=== Multiple measures ===
379 -
380 -Multiple measures are a common characteristic of microdatasets. To support this use case, the MeasureDimension has been deprecated and replaced with the option to define zero or more measures. Measures now act like any other component in that they use concepts, can have their own local coded or uncoded representation defined within the
381 -
382 -Data Structure Definition, and can be either mandatory or conditional. Creating a measure with the “MEASURE” concept role applied emulates the version 2.1
383 -
384 -MeasureDimension behaviour as illustrated in the SDMX-ML example below:
385 -
386 -<str:MeasureList id=”MeasureDescriptor”>
387 -
388 -<str:Measure id=”OBS_VALUE” minOccurs=”1” maxOccurs=”1” usage=”mandatory” > <str:ConceptIdentity>
389 -
390 -<Ref id=”OBS_VALUE” maintainableParentID=”CONCEPTS” agencyID=”SDMX” maintainableParentVersion=”1.0.0” />
391 -
392 -</str:ConceptIdentity>
393 -
394 -<str:LocalRepresentation>
395 -
396 -<str:TextFormat textType=”String” isMultiLingual=”true” />
397 -
398 -</str:LocalRepresentation>
399 -
400 -<str:ConceptRole>
401 -
402 -<Ref id=”MEASURE” maintainableParentID=”SDMX_CONCEPT_ROLES” agencyID=”SDMX” maintainableParentVersion=”1.0.0” />
403 -
404 -</str:ConceptRole>
405 -
406 -</str:Measure>
407 -
408 -...
409 -
410 -<str:Measure>
411 -
412 -</str:MeasureList>
413 -
414 -=== Multi-value measures and attributes ===
415 -
416 -Both measures and attributes have been extended with the option to take ‘arrays’ of 193 multiple coded or uncoded values. This supports use cases like multiple observation 194 status flags. New //minOccurs// and //maxOccurs// properties define the valid number of 195 values. The //usage// property separately defines whether the measure or attribute is
417 -
418 -//mandatory// or optional. In the SDMX-ML measure example above, the properties
419 -
420 -//minOccurs=”1” maxOccurs=”1” usage=”mandatory”// specify that OBS_VALUE must be 198 reported, and can only consist of a single value.
421 -
422 -=== Attributes relationship to measures ===
423 -
424 -In addition to attaching attributes to a specific level within the dataset, their relationship 202 to measures can also be defined.
425 -
426 -=== Value lists ===
427 -
428 -Value lists help in modelling microdata by providing an enumeration similar to code lists 206 but allowing any string values without being restricted to the rules of SDMX identifiers.
429 -
430 -That allows ValueItems (the equivalent to Code) to contain symbols like ‘¥’ and ‘€’, but 208 also means they are not identifiable.
431 -
432 -== //3.6 Geospatial Data Exchange// ==
433 -
434 -The version 3.0 model has been extended to provide explicit support for geospatial data.
435 -
436 -=== GeospatialInformation type ===
437 -
438 -A new GeospatialInformation string type has been added which can be used as the 214 representation for any dimension, attribute or measure component. The value which is a 215 string expression conforming to the syntax defined in Section 6 of the technical 216 specifications precisely defines a ‘Geo Feature Set’ – a collection of geographical 217 features like points, lines or polygons. Its use is recommended in conjunction with the “GEO_FEATURE_SET” concept role.
439 -
440 -=== Geospatial code lists ===
441 -
442 -Two new specialised types of code list have been added where the definition of each code includes additional geospatial information in addition to the standard ID, name and description:
443 -
444 444  * GeographicCodelist – each item includes an element to represent a specific Geo Feature Set which is described using the same expression syntax as for GeospatialInformation type.
445 -* GeoGridCodelist – A code list defining a geographical grid composed of cells representing regular squared portions of the Earth. Each item references a cell within the grid.
377 +* GeoGridCodelist – A [[code list>>doc:xwiki:Glossary.Code list.WebHome]] defining a geographical grid composed of cells representing regular squared portions of the Earth. Each item references a cell within the grid.
446 446  
447 -=== //3.7 Structure Mapping// ===
379 +== 3.7 Structure Mapping ==
448 448  
449 -The Structure Set in version 2.1 is a container for many mapping structures including Data Structure Map, Codelist Map and Concept Map. For version 3.0 the Structure Set artefact has been deprecated and replaced with a number of new maintainables giving better flexibility and reusability, specifically: Structure Map, Concept Scheme Map, Representation Map, Reporting Taxonomy Map, Category Scheme Map and Organisation Scheme Map.
381 +The [[Structure Set>>doc:xwiki:Glossary.Structure set.WebHome]] in (% style="color:#2ecc71" %)version(%%) 2.1 is a container for many mapping structures including Data Structure (% style="color:#2ecc71" %)Map(%%), Codelist (% style="color:#2ecc71" %)Map(%%) and (% style="color:#2ecc71" %)Concept(%%) (% style="color:#2ecc71" %)Map(%%). For (% style="color:#2ecc71" %)version(%%) 3.0 the [[Structure Set>>doc:xwiki:Glossary.Structure set.WebHome]] [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] has been deprecated and replaced with a number of new maintainables giving better flexibility and reusability, specifically: Structure (% style="color:#2ecc71" %)Map(%%), [[Concept Scheme>>doc:xwiki:Glossary.Concept scheme.WebHome]] (% style="color:#2ecc71" %)Map(%%), [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] (% style="color:#2ecc71" %)Map(%%), [[Reporting Taxonomy>>doc:xwiki:Glossary.Reporting taxonomy.WebHome]] (% style="color:#2ecc71" %)Map(%%), [[Category Scheme>>doc:xwiki:Glossary.Category scheme.WebHome]] (% style="color:#2ecc71" %)Map(%%) and Organisation Scheme (% style="color:#2ecc71" %)Map(%%).
450 450  
451 -The version 2.1 Codelist Map been replaced with Representation Map which allows mappings to be defined between any combination of Code Lists, Value Lists and noncoded representations such as text strings and numbers.
383 +The (% style="color:#2ecc71" %)version(%%) 2.1 Codelist (% style="color:#2ecc71" %)Map(%%) been replaced with [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] (% style="color:#2ecc71" %)Map(%%) which allows mappings to be defined between any combination of [[Code Lists>>doc:xwiki:Glossary.Code list.WebHome]], Value Lists and noncoded [[representations>>doc:xwiki:Glossary.Representation.WebHome]] such as text strings and numbers.
452 452  
453 -==== Many-to-many source and target components ====
385 +(% class="wikigeneratedid" id="HMany-to-manysourceandtargetcomponents" %)
386 +**Many-to-many source and target components**
387 +Structure mapping rules may be defined with both multiple source [[components>>doc:xwiki:Glossary.Component.WebHome]] and multiple target [[components>>doc:xwiki:Glossary.Component.WebHome]] in contrast to (% style="color:#2ecc71" %)version(%%) 2.1 where only one source and target was allowed. That supports many-to-many (n-n) mapping use cases where the output of a mapping rule may be dependent on the combination of a number of input [[components>>doc:xwiki:Glossary.Component.WebHome]]. For instance:
454 454  
455 -Structure mapping rules may be defined with both multiple source components and multiple target components in contrast to version 2.1 where only one source and target was allowed. That supports many-to-many (n-n) mapping use cases where the output of a mapping rule may be dependent on the combination of a number of input components. For instance:
389 +Set the output [[component>>doc:xwiki:Glossary.Component.WebHome]] INDICATOR=”DE_A” if the input [[components>>doc:xwiki:Glossary.Component.WebHome]] are FREQ=”A” and REF_AREA=”DE”.
456 456  
457 -Set the output component INDICATOR=”DE_A” if the input components are FREQ=”A” and REF_AREA=”DE”.
391 +Similarly, an n-n rule may also set the values of any number of output [[components>>doc:xwiki:Glossary.Component.WebHome]]:
458 458  
459 -Similarly, an n-n rule may also set the values of any number of output components:
393 +Set the output [[components>>doc:xwiki:Glossary.Component.WebHome]] FREQ=”A”, REF_AREA=”DE” if the input [[component>>doc:xwiki:Glossary.Component.WebHome]] INDICATOR=”DE_A”.
460 460  
461 -Set the output components FREQ=”A”, REF_AREA=”DE” if the input component INDICATOR=”DE_A”.
462 -
463 463  **Fixed source and target**
396 +The Structure (% style="color:#2ecc71" %)Map(%%) may now define input or output [[components>>doc:xwiki:Glossary.Component.WebHome]] which have a fixed value.
464 464  
465 -The Structure Map may now define input or output components which have a fixed value.
398 +(% class="wikigeneratedid" id="HTimerepresentationsmapping" %)
399 +**Time representations mapping**
400 +Non [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] time [[representations>>doc:xwiki:Glossary.Representation.WebHome]] may now be described in a Structure (% style="color:#2ecc71" %)Map(%%), allowing them to be (% style="color:#2ecc71" %)mapped(%%) into [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] [[time formats>>doc:xwiki:Glossary.Time format.WebHome]].
466 466  
467 -==== Time representations mapping ====
402 +(% class="wikigeneratedid" id="HRegularexpressionandsubstringmappings" %)
403 +**Regular expression and substring mappings**
404 +All item (% style="color:#2ecc71" %)maps(%%) allow the use of regular expressions and substrings to match source values, specifically: [[Concept Scheme>>doc:xwiki:Glossary.Concept scheme.WebHome]] (% style="color:#2ecc71" %)Map(%%), [[Reporting Taxonomy>>doc:xwiki:Glossary.Reporting taxonomy.WebHome]] (% style="color:#2ecc71" %)Map(%%), [[Category Scheme>>doc:xwiki:Glossary.Category scheme.WebHome]] (% style="color:#2ecc71" %)Map(%%) and Organisation Scheme (% style="color:#2ecc71" %)Map(%%).
468 468  
469 -Non SDMX time representations may now be described in a Structure Map, allowing them to be mapped into SDMX time formats.
406 +(% class="wikigeneratedid" id="HItemmapsvalidityperiod" %)
407 +**Item maps validity period**
408 +Item (% style="color:#2ecc71" %)maps(%%) may further define the period for which the mapping is valid, meaning the mapping rule will only be applied if the row of information being (% style="color:#2ecc71" %)mapped(%%) is within the period.
470 470  
471 -==== Regular expression and substring mappings ====
410 +== 3.8 Constraints ==
472 472  
473 -All item maps allow the use of regular expressions and substrings to match source values, specifically: Concept Scheme Map, Reporting Taxonomy Map, Category Scheme Map and Organisation Scheme Map.
412 +(% style="color:#2ecc71" %)Constraints(%%) in (% style="color:#2ecc71" %)version(%%) 3.0 are modelled using two separate [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] which replace the (% style="color:#2ecc71" %)version(%%) 2.1 content (% style="color:#2ecc71" %)constraint(%%):
474 474  
475 -==== Item maps validity period ====
414 +* data (% style="color:#2ecc71" %)constraint(%%) for data; and
415 +* metadata (% style="color:#2ecc71" %)constraint(%%) for [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]].
476 476  
477 -Item maps may further define the period for which the mapping is valid, meaning the mapping rule will only be applied if the row of information being mapped is within the period.
417 +Metadata (% style="color:#2ecc71" %)constraint(%%) differs from its data counterpart in having a simplified cube region model better suited to [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] reporting use cases and not carrying details of the constrained targets – that information instead being defined directly within the [[metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]] and Metadata [[Provision Agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]]. Thus, metadata related (% style="color:#2ecc71" %)constraints(%%) only specify (% style="color:#2ecc71" %)constraints(%%) to the values of metadata attributes.
478 478  
479 -=== //3.8 Constraints// ===
419 +The ‘%’ wildcard character can now be used when defining cube region (% style="color:#2ecc71" %)constraints(%%) to match multiple [[codes>>doc:xwiki:Glossary.Code.WebHome]] with a single expression, for instance for [[economic activity>>doc:xwiki:Glossary.Economic activity.WebHome]], ISIC4_% matches all [[codes>>doc:xwiki:Glossary.Code.WebHome]] beginning with ‘ISIC4_’ avoiding the need to maintain an explicit list.
480 480  
481 -Constraints in version 3.0 are modelled using two separate artefacts which replace the version 2.1 content constraint:
421 +The validity period definition has been moved from the (% style="color:#2ecc71" %)constraint(%%) to the individual constraining terms, specifically CubeRegion, DataKeySet and MetadataTargetRegion providing more granular control.
482 482  
483 -* data constraint for data; and
484 -* metadata constraint for reference metadata.
423 +Attachment (% style="color:#2ecc71" %)constraints(%%) have been deprecated due to a lack of use cases.
485 485  
486 -Metadata constraint differs from its data counterpart in having a simplified cube region model better suited to reference metadata reporting use cases and not carrying details of the constrained targets – that information instead being defined directly within the metadataflow and Metadata Provision Agreement. Thus, metadata related constraints only specify constraints to the values of metadata attributes.
425 +== 3.9 Code List Extension ==
487 487  
488 -The ‘%’ wildcard character can now be used when defining cube region constraints to match multiple codes with a single expression, for instance for economic activity, ISIC4_% matches all codes beginning with ‘ISIC4_’ avoiding the need to maintain an explicit list.
427 +In addition to the two new specialised geospatial forms, the option has been added to define a [[code list>>doc:xwiki:Glossary.Code list.WebHome]] as an extension of, or by inheriting [[codes>>doc:xwiki:Glossary.Code.WebHome]] from, other lists. An optional prefix can be added to inherited [[codes>>doc:xwiki:Glossary.Code.WebHome]] to disambiguate duplicates.
489 489  
490 -The validity period definition has been moved from the constraint to the individual constraining terms, specifically CubeRegion, DataKeySet and MetadataTargetRegion providing more granular control.
429 +This feature allows new [[code lists>>doc:xwiki:Glossary.Code list.WebHome]] to be easily derived from existing lists without the need to make and manually maintain copies. When querying for extended [[code list>>doc:xwiki:Glossary.Code list.WebHome]] structures using the REST API, the option has been added to retrieve either the definition or the materialised list. Traditional literal lists of [[codes>>doc:xwiki:Glossary.Code.WebHome]] continue to be supported.
491 491  
492 -Attachment constraints have been deprecated due to a lack of use cases.
431 +== 3.10 Discriminated Union of Code Lists ==
493 493  
494 -=== //3.9 Code List Extension// ===
433 +Combining [[code list>>doc:xwiki:Glossary.Code list.WebHome]] extension with wildcarded (% style="color:#2ecc71" %)constraints(%%) solves the discriminated union of [[code lists>>doc:xwiki:Glossary.Code list.WebHome]] problem where a classification or breakdown has multiple “variants” which are all valid but mutually exclusive. A common example is [[economic activity>>doc:xwiki:Glossary.Economic activity.WebHome]] where several alternative classification schemes are in use including ISIC revisions 1 to 4 and NACE as used in the European Community.
495 495  
496 -In addition to the two new specialised geospatial forms, the option has been added to define a code list as an extension of, or by inheriting codes from, other lists. An optional prefix can be added to inherited codes to disambiguate duplicates.
435 +== 3.11 Code Hierarchies ==
497 497  
498 -This feature allows new code lists to be easily derived from existing lists without the need to make and manually maintain copies. When querying for extended code list structures using the REST API, the option has been added to retrieve either the definition or the materialised list. Traditional literal lists of codes continue to be supported.
437 +[[Code>>doc:xwiki:Glossary.Code.WebHome]] [[hierarchies>>doc:xwiki:Glossary.Hierarchy.WebHome]] allow the definition of complex [[hierarchies>>doc:xwiki:Glossary.Hierarchy.WebHome]] of [[codes>>doc:xwiki:Glossary.Code.WebHome]] from potentially multiple lists for data discovery purposes. Hierarchical Codelist has been deprecated and replaced by two new [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]]: [[Hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] – the actual [[hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] of [[codes>>doc:xwiki:Glossary.Code.WebHome]], and [[Hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] Association links [[hierarchies>>doc:xwiki:Glossary.Hierarchy.WebHome]] directly to any other identifiable object, a capability missing from the (% style="color:#2ecc71" %)version(%%) 2.1 model. Further, the linkage can be within a particular context, for instance linking a [[hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] to a [[dimension>>doc:xwiki:Glossary.Dimension.WebHome]] within the context of a specific [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] ([[dimension>>doc:xwiki:Glossary.Dimension.WebHome]] REF_AREA in the context of the ECB:EXR [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]]).
499 499  
500 -=== //3.10 Discriminated Union of Code Lists// ===
501 -
502 -Combining code list extension with wildcarded constraints solves the discriminated union of code lists problem where a classification or breakdown has multiple “variants” which are all valid but mutually exclusive. A common example is economic activity where several alternative classification schemes are in use including ISIC revisions 1 to 4 and NACE as used in the European Community.
503 -
504 -=== //3.11 Code Hierarchies// ===
505 -
506 -Code hierarchies allow the definition of complex hierarchies of codes from potentially multiple lists for data discovery purposes. Hierarchical Codelist has been deprecated and replaced by two new artefacts: Hierarchy – the actual hierarchy of codes, and Hierarchy Association links hierarchies directly to any other identifiable object, a capability missing 312 from the version 2.1 model. Further, the linkage can be within a particular context, for instance linking a hierarchy to a dimension within the context of a specific Dataflow (dimension REF_AREA in the context of the ECB:EXR Dataflow).
507 -
508 508  = 4 Versioning of Structural Metadata Artefacts =
509 509  
510 -Version 3.0 adopts semantic versioning principles for versioning of metadata artefacts following the rules set out at [[__https:~~/~~/semver.org__>>url:https://semver.org/]][[.>>url:https://semver.org/]] However, this is not mandatory, and organisations may continue to use the pre-existing two-digit versioning strategy, or not to version artefacts by omitting the //version// property. The version number no longer defaults to 1.0 if not explicitly set.
441 +(% style="color:#2ecc71" %)Version(%%) 3.0 adopts semantic versioning principles for versioning of metadata [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] following the rules set out at __[[https:~~/~~/semver.org>>https://semver.org]] __However, this is not mandatory, and organisations may continue to use the pre-existing two-digit versioning strategy, or not to (% style="color:#2ecc71" %)version(%%) [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] by omitting the (% style="color:#2ecc71" %)//version//(%%) property. The (% style="color:#2ecc71" %)version(%%) number no longer defaults to 1.0 if not explicitly set.
511 511  
512 -Semantic version numbers are three digits:
443 +Semantic (% style="color:#2ecc71" %)version(%%) numbers are three digits:
513 513  
514 514  MAJOR.MINOR.PATCH
515 515  
... ... @@ -522,7 +522,6 @@
522 522  Examples:
523 523  
524 524  SDMX:CL_AREA(1.0.0)
525 -
526 526  SDMX:CL_AREA(2.3.2)
527 527  
528 528  == Dependency management ==
... ... @@ -529,29 +529,26 @@
529 529  
530 530  Additional constructs are possible for dependency management when referencing structures. For instance:
531 531  
532 -2.3+.1 Means the currently latest available version >= “2.3.1” and < “3.0.0” (all backwards compatible versions >= “2.3.1”).
462 +2.3+.1  Means the currently latest available (% style="color:#2ecc71" %)version(%%) >= “2.3.1” and < “3.0.0” (all backwards compatible (% style="color:#2ecc71" %)versions(%%) >= “2.3.1”).
463 +2+.3.1  Means the currently latest available (% style="color:#2ecc71" %)version(%%) >= “2.3.1” (even if not backwards compatible).
533 533  
534 -2+.3.1 Means the currently latest available version >= “2.3.1” (even if not backwards compatible).
535 -
536 536  == Draft structures ==
537 537  
538 -A key principle is that semantically versioned structures are immutable and must not be changed without a corresponding change to the version number, except where explicitly marked as draft using extensions to the version number.
467 +A key principle is that semantically versioned structures are immutable and must not be changed without a corresponding change to the (% style="color:#2ecc71" %)version(%%) number, except where explicitly marked as draft using extensions to the (% style="color:#2ecc71" %)version(%%) number.
539 539  
540 540  MAJOR.MINOR.PATCH-EXTENSION
541 541  
542 -1.10.0-draft Means that version 1.10.0 is still being modified and may change – equivalent to setting isFinal=false in SDMX 2.1.
471 +1.10.0-draft  Means that (% style="color:#2ecc71" %)version(%%) 1.10.0 is still being modified and may change – equivalent to setting isFinal=false in [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] 2.1.
472 +1.10.0-unstable  Alternative to -draft.
473 +1.10.0-notfinal  Alternative to -draft.
543 543  
544 -1.10.0-unstable Alternative to -draft.
475 +The [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] 2.1 isFinal property is deprecated in 3.0.
545 545  
546 -1.10.0-notfinal Alternative to -draft.
547 -
548 -The SDMX 2.1 isFinal property is deprecated in 3.0.
549 -
550 550  = 5 REST Web Services API =
551 551  
552 -== //5.1 Simplified list of resources// ==
479 +== 5.1 Simplified list of resources ==
553 553  
554 -The version 3.0 REST API has just five main resources:
481 +The (% style="color:#2ecc71" %)version(%%) 3.0 REST API has just five main resources:
555 555  
556 556  * structure
557 557  * data
... ... @@ -559,49 +559,53 @@
559 559  * availability
560 560  * metadata
561 561  
562 -All structure and item queries have been organised under the structure resource in contrast to the version 2.1 API which specified a separate resource for each structure.
489 +All structure and item queries have been organised under the structure resource in contrast to the (% style="color:#2ecc71" %)version(%%) 2.1 API which specified a separate resource for each structure.
563 563  
564 -This and changes in the URLs and query parameters on the data, availability and metadata resources means that, with the exception of schema queries, the version 3.0 API is not backwardly compatible.
491 +This and changes in the URLs and query parameters on the data, availability and metadata resources means that, with the exception of schema queries, the (% style="color:#2ecc71" %)version(%%) 3.0 API is not backwardly compatible.
565 565  
566 -== //5.2 Improved data queries// ==
493 +== 5.2 Improved data queries ==
567 567  
568 -Data queries have been changed to provide more granular selections from contexts wider than just a Dataflow.
495 +Data queries have been changed to provide more granular selections from contexts wider than just a [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]].
569 569  
570 -=== Extend the context of data retrieval ===
497 +(% class="wikigeneratedid" id="HExtendthecontextofdataretrieval" %)
498 +**Extend the context of data retrieval**
499 +(% style="color:#2ecc71" %)Version(%%) 2.1 data queries always retrieved data from a single specific [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]]. In (% style="color:#2ecc71" %)version(%%) 3.0, the query context may be specified as:
571 571  
572 -Version 2.1 data queries always retrieved data from a single specific Dataflow. In version 3.0, the query context may be specified as:
501 +* [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]];
502 +* Data Structure Definition – i.e., all [[Dataflows>>doc:xwiki:Glossary.Dataflow.WebHome]] that use it; or
503 +* Provision Agreement – i.e., all [[Dataflows>>doc:xwiki:Glossary.Dataflow.WebHome]] associated with it.
573 573  
574 -* Dataflow;
575 -* Data Structure Definition – i.e., all Dataflows that use it; or
576 -* Provision Agreement – i.e., all Dataflows associated with it.
505 +Data queries may also search across [[datasets>>doc:xwiki:Glossary.Data set.WebHome]], for instance “retrieve all data about a country”.
577 577  
578 -Data queries may also search across datasets, for instance “retrieve all data about a country”.
507 +(% class="wikigeneratedid" id="HComponent-basedfilters" %)
508 +**Component-based filters**
509 +Expressions filtering on individual [[components>>doc:xwiki:Glossary.Component.WebHome]] can now be included as part of the data query URL.
579 579  
580 -=== Component-based filters ===
581 -
582 -Expressions filtering on individual components can now be included as part of the data query URL.
583 -
584 584  /data/dataflow/ESTAT/ICP?c[REF_AREA]=CH&c[CONF_STATUS]=F
585 585  
586 -=== Support for operators ===
587 -
513 +(% class="wikigeneratedid" id="HSupportforoperators" %)
514 +**Support for operators**
588 588  Filter expressions can also include operators.
589 589  
590 -/data/dataflow/ESTAT/ICP?c[REF_AREA]=DE&c[ICP_ITEM]=sw:01&c[TIME_PERIOD]=ge:2015 Operators include:
517 +/data/dataflow/ESTAT/ICP?c[REF_AREA]=DE&c[ICP_ITEM]=sw:01&c[TIME_PERIOD]=ge:2015
591 591  
592 -|eq|Equals
593 -|ne|Not equal to
594 -|le|Less than
595 -|ge|Greater than or equal to
596 -|sw|Starts with
519 +Operators include:
597 597  
598 -=== Support for multiple keys ===
521 +(% style="width:531.039px" %)
522 +|(% style="width:151px" %)eq|(% style="width:378px" %)Equals
523 +|(% style="width:151px" %)ne|(% style="width:378px" %)Not equal to
524 +|(% style="width:151px" %)le|(% style="width:378px" %)Less than
525 +|(% style="width:151px" %)ge|(% style="width:378px" %)Greater than or equal to
526 +|(% style="width:151px" %)sw|(% style="width:378px" %)Starts with
599 599  
600 -Queries can now specify multiple series keys.
528 +(% class="wikigeneratedid" id="HSupportformultiplekeys" %)
529 +**Support for multiple keys**
530 +Queries can now specify multiple [[series keys>>doc:xwiki:Glossary.Series key.WebHome]].
601 601  
532 +(% class="wikigeneratedid" %)
602 602  /data/dataflow/ESTAT/ICP/1.0.0/M…A.ANR,M…A.INX,M…B.CTG
603 603  
604 -== //5.3 Improved reference metadata queries// ==
535 +== 5.3 Improved reference metadata queries ==
605 605  
606 606  Reference metadata queries have been improved with a number of new options to retrieve metadata reports.
607 607  
... ... @@ -617,7 +617,7 @@
617 617  
618 618  /metadata/structure/datastructure/BIS/BIS_CBS/1.0
619 619  
620 -== //5.4 Structural metadata maintenance// ==
551 +== 5.4 Structural metadata maintenance ==
621 621  
622 622  Support has been added for maintenance of structural metadata.
623 623  
... ... @@ -625,62 +625,64 @@
625 625  
626 626  = 6 XML, JSON, CSV and EDI Transmission formats =
627 627  
628 -== //6.1 SDMX-ML// ==
559 +== 6.1 SDMX-ML ==
629 629  
630 630  The SDMX-ML XML messages have been modified and updated for version 3.0. While they broadly follow the same principles, there have been significant changes which break backward compatibility.
631 631  
632 -=== Structure message ===
633 -
563 +(% class="wikigeneratedid" id="HStructuremessage" %)
564 +**Structure message**
634 634  The SDMX-ML structure message is used for transmission of structural metadata. It closely reflects the SDMX information model and has therefore been significantly updated for version 3.0 with the addition of new structures, modifications where structures have changed, and removal of deprecated structures like Structure Set.
635 635  
636 636  Additionally, the way the individual artefacts are organised into ‘collections’ within the message has been significantly revised with a simpler flat structure adopted as set out in the following table:
637 637  
638 -|**Artefact type**|**Version 2.1 Collection**|**Version 3.0 Collection**
639 -|AgencyScheme|OrganisationSchemes|AgencySchemes
640 -|DataConsumerScheme|OrganisationSchemes|DataConsumerSchemes
641 -|DataProviderScheme|OrganisationSchemes|DataProviderSchemes
642 -|MetadataProviderScheme|OrganisationSchemes|MetadataProviderSchemes
643 -|OrganisationUnitScheme|OrganisationSchemes|OrganisationUnitSchemes
644 -|GeographicCodelist|Codelists|GeographicCodelists
645 -|GeoGridCodelist|Codelists|GeoGridCodelists
646 -|ConceptScheme|Concepts|ConceptSchemes
647 -|ValueList|Codelists|ValueLists
648 -|StructureMap|StructureMappings|StructureMaps
649 -|RepresentationMap|StructureMappings|RepresentationMaps
650 -|ConceptSchemeMap|StructureMappings|ConceptSchemeMaps
651 -|CategorySchemeMap|StructureMappings|CategorySchemeMaps
652 -|OrganisationSchemeMap|StructureMappings|OrganisationSchemeMaps
653 -|ReportingTaxonomyMap|StructureMappings|ReportingTaxonomyMaps
654 -|DataConstraint|Constraints|DataConstraints
655 -|MetadataConstraint|Constraints|MetadataConstraints
656 -|MetadataProvisionAgreement|ProvisionAgreement|MetadataProvisionAgreements
657 -|CustomTypeScheme|CustomTypes|CustomTypeSchemes
658 -|VtlMappingScheme|VtlMappings|VtlMappingSchemes
659 -|NamePersonalisationScheme|NamePersonalisations|NamePersonalisationSchemes
660 -|RulesetScheme|Rulesets|RulesetSchemes
661 -|TransformationScheme|Transformations|TransformationSchemes
662 -|UserDefinedOperatorScheme|UserDefinedOperators|UserDefinedOperatorSchemes
569 +(% style="width:1102.04px" %)
570 +|(% style="width:321px" %)**Artefact type**|(% style="width:351px" %)**Version 2.1 Collection**|(% style="width:426px" %)**Version 3.0 Collection**
571 +|(% style="width:321px" %)AgencyScheme|(% style="width:351px" %)OrganisationSchemes|(% style="width:426px" %)AgencySchemes
572 +|(% style="width:321px" %)DataConsumerScheme|(% style="width:351px" %)OrganisationSchemes|(% style="width:426px" %)DataConsumerSchemes
573 +|(% style="width:321px" %)DataProviderScheme|(% style="width:351px" %)OrganisationSchemes|(% style="width:426px" %)DataProviderSchemes
574 +|(% style="width:321px" %)MetadataProviderScheme|(% style="width:351px" %)OrganisationSchemes|(% style="width:426px" %)MetadataProviderSchemes
575 +|(% style="width:321px" %)OrganisationUnitScheme|(% style="width:351px" %)OrganisationSchemes|(% style="width:426px" %)OrganisationUnitSchemes
576 +|(% style="width:321px" %)GeographicCodelist|(% style="width:351px" %)Codelists|(% style="width:426px" %)GeographicCodelists
577 +|(% style="width:321px" %)GeoGridCodelist|(% style="width:351px" %)Codelists|(% style="width:426px" %)GeoGridCodelists
578 +|(% style="width:321px" %)ConceptScheme|(% style="width:351px" %)Concepts|(% style="width:426px" %)ConceptSchemes
579 +|(% style="width:321px" %)ValueList|(% style="width:351px" %)Codelists|(% style="width:426px" %)ValueLists
580 +|(% style="width:321px" %)StructureMap|(% style="width:351px" %)StructureMappings|(% style="width:426px" %)StructureMaps
581 +|(% style="width:321px" %)RepresentationMap|(% style="width:351px" %)StructureMappings|(% style="width:426px" %)RepresentationMaps
582 +|(% style="width:321px" %)ConceptSchemeMap|(% style="width:351px" %)StructureMappings|(% style="width:426px" %)ConceptSchemeMaps
583 +|(% style="width:321px" %)CategorySchemeMap|(% style="width:351px" %)StructureMappings|(% style="width:426px" %)CategorySchemeMaps
584 +|(% style="width:321px" %)OrganisationSchemeMap|(% style="width:351px" %)StructureMappings|(% style="width:426px" %)OrganisationSchemeMaps
585 +|(% style="width:321px" %)ReportingTaxonomyMap|(% style="width:351px" %)StructureMappings|(% style="width:426px" %)ReportingTaxonomyMaps
586 +|(% style="width:321px" %)DataConstraint|(% style="width:351px" %)Constraints|(% style="width:426px" %)DataConstraints
587 +|(% style="width:321px" %)MetadataConstraint|(% style="width:351px" %)Constraints|(% style="width:426px" %)MetadataConstraints
588 +|(% style="width:321px" %)MetadataProvisionAgreement|(% style="width:351px" %)ProvisionAgreement|(% style="width:426px" %)MetadataProvisionAgreements
589 +|(% style="width:321px" %)CustomTypeScheme|(% style="width:351px" %)CustomTypes|(% style="width:426px" %)CustomTypeSchemes
590 +|(% style="width:321px" %)VtlMappingScheme|(% style="width:351px" %)VtlMappings|(% style="width:426px" %)VtlMappingSchemes
591 +|(% style="width:321px" %)NamePersonalisationScheme|(% style="width:351px" %)NamePersonalisations|(% style="width:426px" %)NamePersonalisationSchemes
592 +|(% style="width:321px" %)RulesetScheme|(% style="width:351px" %)Rulesets|(% style="width:426px" %)RulesetSchemes
593 +|(% style="width:321px" %)TransformationScheme|(% style="width:351px" %)Transformations|(% style="width:426px" %)TransformationSchemes
594 +|(% style="width:321px" %)UserDefinedOperatorScheme|(% style="width:351px" %)UserDefinedOperators|(% style="width:426px" %)UserDefinedOperatorSchemes
663 663  
664 664  No changes have been made to the way the following artefacts are organised in the structure message:
665 665  
666 -|**Artefact type**|**Collection**
667 -|Dataflow|Dataflows
668 -|Metadataflow|Metadataflows
669 -|CategoryScheme|CategorySchemes
670 -|Categorisation|Categorisations
671 -|Codelist|Codelists
672 -|Hierarchy|Hierarchies
673 -|HierarchyAssociation|HierarchyAssociations
674 -|MetadataStructure|MetadataStructures
675 -|DataStructure|DataStructures
676 -|ReportingTaxonomy|ReportingTaxonomies
677 -|Process|Processes
678 -|ProvisionAgreement|ProvisionAgreements
598 +(% style="width:1106.04px" %)
599 +|(% style="width:326px" %)**Artefact type**|(% style="width:776px" %)**Collection**
600 +|(% style="width:326px" %)Dataflow|(% style="width:776px" %)Dataflows
601 +|(% style="width:326px" %)Metadataflow|(% style="width:776px" %)Metadataflows
602 +|(% style="width:326px" %)CategoryScheme|(% style="width:776px" %)CategorySchemes
603 +|(% style="width:326px" %)Categorisation|(% style="width:776px" %)Categorisations
604 +|(% style="width:326px" %)Codelist|(% style="width:776px" %)Codelists
605 +|(% style="width:326px" %)Hierarchy|(% style="width:776px" %)Hierarchies
606 +|(% style="width:326px" %)HierarchyAssociation|(% style="width:776px" %)HierarchyAssociations
607 +|(% style="width:326px" %)MetadataStructure|(% style="width:776px" %)MetadataStructures
608 +|(% style="width:326px" %)DataStructure|(% style="width:776px" %)DataStructures
609 +|(% style="width:326px" %)ReportingTaxonomy|(% style="width:776px" %)ReportingTaxonomies
610 +|(% style="width:326px" %)Process|(% style="width:776px" %)Processes
611 +|(% style="width:326px" %)ProvisionAgreement|(% style="width:776px" %)ProvisionAgreements
679 679  
680 680  From version 3.0, collections can appear in any order within a structure message.
681 681  
682 -=== Data messages ===
683 -
615 +(% class="wikigeneratedid" id="HDatamessages" %)
616 +**Data messages**
684 684  All legacy SDMX-ML data messages have been deprecated with the exception of Structure Specific Data which becomes the sole standard format for transmission of SDMX data in XML in version 3.0.
685 685  
686 686  Specifically, the following data messages are not supported in version 3.0:
... ... @@ -697,44 +697,44 @@
697 697  
698 698  The time series variant of the Structure Specific Data message is no longer used.
699 699  
700 -=== Reference metadata message ===
701 -
633 +(% class="wikigeneratedid" id="HReferencemetadatamessage" %)
634 +**Reference metadata message**
702 702  The Generic Metadata message remains the standard format for transmission of reference metadata sets in XML but has been modified to support the revised version 3.0 reference metadata model.
703 703  
704 -=== Registry structural metadata ‘query’ messages ===
705 -
637 +(% class="wikigeneratedid" id="HRegistrystructuralmetadata2018query2019messages" %)
638 +**Registry structural metadata ‘query’ messages**
706 706  As a consequence of the deprecation of the SOAP API and standardisation on REST, the structural metadata ‘query’ messages have all been removed. In version 3.0, querying an SDMX Registry for structural metadata is performed solely using REST GET.
707 707  
708 -=== Structure referencing ===
709 -
641 +(% class="wikigeneratedid" id="HStructurereferencing" %)
642 +**Structure referencing**
710 710  The option to reference structures using Agency, ID and Version has been removed. From SDMX version 3.0 URN is used for all referencing purposes with the exception of local references such as where groups reference dimensions within a DSD.
711 711  
712 -== //6.2 SDMX-JSON// ==
645 +== 6.2 SDMX-JSON ==
713 713  
714 714  Like SDMX-ML, the SDMX-JSON messages have been significantly modified and updated for version 3.0. They are not backwardly compatible with version 2.1.
715 715  
716 -=== Structure message ===
717 -
649 +(% class="wikigeneratedid" id="HStructuremessage-1" %)
650 +**Structure message**
718 718  The SDMX-JSON structure message closely replicates the SDMX-ML equivalent. Like that of SDMX-ML it has been updated to align it with the version 3.0 information model with addition, deletion and modification of artefacts as required. The organisation of the structure collections has also been revised as detailed in paragraph 6.1.
719 719  
720 -=== Data message ===
721 -
653 +(% class="wikigeneratedid" id="HDatamessage" %)
654 +**Data message**
722 722  The SDMX-JSON data message has similarly be updated. Additional changes have been made to allow a single message to carry data from multiple datasets with potentially different Data Structure Definitions to support REST data queries of the form “retrieve all data about a country”. For this reason, the version 3.0 SDMX-JSON is not backwardly compatible with version 2.1 data messages. Support has been added for the transmission of microdata and reporting of reference metadata on data as an integral part of the dataset.
723 723  
724 -=== Reference metadata message ===
725 -
657 +(% class="wikigeneratedid" id="HReferencemetadatamessage-1" %)
658 +**Reference metadata message**
726 726  The SDMX-JSON metadata message has also been updated to support the version 3.0 reference metadata and Metadataset specifications.
727 727  
728 -=== Structure referencing ===
729 -
661 +(% class="wikigeneratedid" id="HStructurereferencing-1" %)
662 +**Structure referencing**
730 730  As for SDMX-ML, the option to reference structures using Agency, ID and Version has been removed with URN used for all non-local referencing purposes.
731 731  
732 -== //6.3 SDMX-CSV// ==
665 +== 6.3 SDMX-CSV ==
733 733  
734 734  CSV in SDMX is used transmission of data and reference metadata only.
735 735  
736 -=== Data message ===
737 -
669 +(% class="wikigeneratedid" id="HDatamessage-1" %)
670 +**Data message**
738 738  The SDMX-CSV data message has been modified to align with the version 3.0 information model, support the enhanced REST API and ensure that data can be freely converted to and from the XML and JSON formats without loss. These changes include:
739 739  
740 740  * An additional column identifying the type if the artefact defining the structure of the data: “dataflow”, “datastructure” or “dataprovision”; • A column for the structure artefact’s identification of the form
... ... @@ -743,11 +743,11 @@
743 743  
744 744  * A column for the dataset action: information, append, replace or delete, which is consistent with both the the SDMX-ML and SDMX-JSON data messages.
745 745  
746 -=== Reference metadata message ===
747 -
679 +(% class="wikigeneratedid" id="HReferencemetadatamessage-2" %)
680 +**Reference metadata message**
748 748  The SDMX-CSV metadata message is new for version 3.0 and, like the SDMX-ML and SDMX-JSON equivalents, is used for the transmission reference metadata sets.
749 749  
750 -=== //6.4 EDI deprecation// ===
683 +== 6.4 EDI deprecation ==
751 751  
752 752  The EDI format for transmission of both structures and data has been deprecated. Version 3.0 is therefore not backwardly compatible with legacy EDI messages.
753 753  
SUZ.Methodology.Code.MethodologyClass[0]