Changes for page SDMX 3.0 Standards. Summary of Major Changes and New Functionality
Last modified by Helena on 2025/09/10 11:19
Summary
-
Page properties (4 modified, 0 added, 0 removed)
-
Objects (0 modified, 0 added, 1 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 - SDMXSTANDARDS1 +1 Overview - Parent
-
... ... @@ -1,1 +1,0 @@ 1 -Methodology.WebHome - Content
-
... ... @@ -4,10 +4,9 @@ 4 4 5 5 **Revision History** 6 6 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 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 11 11 12 12 = 1 Overview = 13 13 ... ... @@ -25,7 +25,7 @@ 25 25 26 26 **Versioning of Structural Metadata Artefacts** 27 27 28 - *Adoption of the three-number semantic versioning standard for structural metadata artefacts ([[https:~~/~~/semver.org/>>https://semver.org/||rel="noopenernoreferrer" target="_blank"]])27 +• Adoption of the three-number semantic versioning standard for structural metadata artefacts [[(>>url:https://semver.org/]][[__https:~~/~~/semver.org__>>url:https://semver.org/]][[)>>url:https://semver.org/]] 29 29 30 30 **REST Web Services Application Programming Interface (API)** 31 31 ... ... @@ -36,7 +36,7 @@ 36 36 37 37 **SOAP Web Services API** 38 38 39 - *The SOAP web services API has been deprecated with version 3.0 standardising on REST**;**38 +• The SOAP web services API has been deprecated with version 3.0 standardising on REST** ** 40 40 41 41 **XML, JSON, CSV and EDI Transmission formats** 42 42 ... ... @@ -65,10 +65,9 @@ 65 65 66 66 Version 3.0 introduces breaking changes into the web services API, transmission formats and information model. A summary is given in the table below. 67 67 68 -== 2.1 Web Services API == 67 +== //2.1 Web Services API// == 69 69 70 -(% style="width:948.039px" %) 71 -|**REST API**|(% style="width:818px" %)((( 69 +|**REST API**|((( 72 72 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: 73 73 74 74 * Structure queries ... ... @@ -84,13 +84,14 @@ 84 84 85 85 Implementors are also recommended to version their API services providing users with an explicit choice of which version to use. 86 86 ))) 87 -|**SOAP API**| (% style="width:818px" %)The SOAP API has been deprecated.85 +|**SOAP API**|The SOAP API has been deprecated. 88 88 89 -== 2.2 Transmission Formats == 87 +== //2.2 Transmission Formats// == 90 90 89 +: 90 + 91 91 ((( 92 -(% style="width:952.039px" %) 93 -|(% style="width:130px" %)**SDMX-ML**|(% style="width:820px" %)((( 92 +|**SDMX-ML**|((( 94 94 The following legacy XML data messages have been deprecated: 95 95 96 96 SDMX-ML 1.0/2.0 Generic (time-series) data message ... ... @@ -106,27 +106,34 @@ 106 106 The SDMX-ML structure message is not backwardly compatible primarily due to: 107 107 108 108 * Changes to the information model 109 -* Changes to the way the structures are organised into ‘collections’ within the message 108 +* Changes to the way the structures are organised into 109 + 110 +‘collections’ within the message 111 + 110 110 * Deprecation of the Agency, ID, Version option for referencing of structures in messages 111 111 ))) 112 -| (% style="width:130px" %)**SDMX-JSON**|(% style="width:820px" %)(((114 +|**SDMX-JSON**|((( 113 113 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. 114 114 115 115 The JSON structure message is not backwardly compatible primarily due to: 116 116 117 117 * Changes to the information model 118 -* Changes to the way the structures are organised into ‘collections’ within the message 120 +* Changes to the way the structures are organised into 121 + 122 +‘collections’ within the message 123 + 119 119 * Deprecation of the Agency, ID, Version option for referencing of structures in messages 120 120 ))) 121 -| (% style="width:130px" %)**SDMX-EDI**|(% style="width:820px" %)The EDI format for both structures and data has been deprecated.122 -| (% style="width:130px" %)**SDMX-CSV**|(% style="width:820px" %)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.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.** ** 123 123 ))) 124 124 125 -== 2.3 Information Model == 130 +== //2.3 Information Model// == 126 126 132 +: 133 + 127 127 ((( 128 -(% style="width:955.039px" %) 129 -|(% style="width:132px" %)**Data Structure Definition**|(% style="width:819px" %)((( 135 +|**Data Structure Definition**|((( 130 130 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. 131 131 132 132 //Conversion guidance for implementors// ... ... @@ -135,7 +135,7 @@ 135 135 136 136 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. 137 137 ))) 138 -| (% style="width:132px" %)**Structure mapping model**|(% style="width:819px" %)(((144 +|**Structure mapping model**|((( 139 139 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. 140 140 141 141 //Conversion guidance for implementors// ... ... @@ -144,7 +144,7 @@ 144 144 145 145 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. 146 146 ))) 147 -| (% style="width:132px" %)**Reference metadata model**|(% style="width:819px" %)(((153 +|**Reference metadata model**|((( 148 148 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. 149 149 150 150 Version 2.1 reference metadata models are not valid in version 3.0. ... ... @@ -151,11 +151,14 @@ 151 151 152 152 //Conversion guidance for implementors// 153 153 154 -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 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. 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. 155 155 156 156 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. 157 157 ))) 158 -| (% style="width:132px" %)**Constraint model**|(% style="width:819px" %)(((167 +|**Constraint model**|((( 159 159 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. 160 160 161 161 //Conversion guidance for implementors// ... ... @@ -164,7 +164,7 @@ 164 164 165 165 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. 166 166 ))) 167 -| (% style="width:132px" %)**Hierarchical codelist structures**|(% style="width:819px" %)(((176 +|**Hierarchical codelist structures**|((( 168 168 The version 2.1 Hierarchical Codelist artefact has been deprecated in version 3.0 and replaced by two new artefacts, Hierarchy and Hierarchy Association. 169 169 170 170 //Conversion guidance for implementors// ... ... @@ -177,7 +177,7 @@ 177 177 178 178 = 3 Information Model = 179 179 180 -== 3.1 Version 3.0 Information Model == 189 +== //3.1 Version 3.0 Information Model// == 181 181 182 182 [[image:SDMX 3-0-0 Major Changes FINAL-1.0_en_6fc573fe.png||height="404" width="718"]] 183 183 ... ... @@ -187,7 +187,7 @@ 187 187 188 188 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. 189 189 190 -== 3.2 Key Changes from Version 2.1 == 199 +== //3.2 Key Changes from Version 2.1// == 191 191 192 192 New Maintainable Artefacts 193 193 ... ... @@ -215,8 +215,7 @@ 215 215 Removed Maintainable Artefacts 216 216 217 217 * Structure Set – replaced by Structure Map and the four item scheme maps 218 -* Hierarchical Codelist – replaced by Hierarchy and Hierarchy Association 219 -* Constraint – replaced by Data Constraint and Metadata Constraint 227 +* Hierarchical Codelist – replaced by Hierarchy and Hierarchy Association • Constraint – replaced by Data Constraint and Metadata Constraint 220 220 221 221 Changed Maintainable Artefacts 222 222 ... ... @@ -230,7 +230,7 @@ 230 230 231 231 * GeospatialInformation – a string type where the value is an expression defining a set of geographical features using a purpose-designed syntax 232 232 233 -== 3.3 Areas Unchanged from Version 2.1 == 241 +== //3.3 Areas Unchanged from Version 2.1// == 234 234 235 235 The following areas of the information model are unchanged from version 2.1: 236 236 ... ... @@ -243,7 +243,7 @@ 243 243 * Reporting taxonomy 244 244 * Process 245 245 246 -== 3.4 Reference Metadata == 254 +== //3.4 Reference Metadata// == 247 247 248 248 Reference metadata has been substantially re-designed for version 3.0 to simplify the model and better support practical use cases. 249 249 ... ... @@ -271,47 +271,86 @@ 271 271 * TITLE – a multi-lingual data attribute 272 272 * SOURCE_AGENCY – a multi-value data attribute 273 273 274 -> <Obs xsi:type="dsd:ObsType" OBS_VALUE="112" OBS_STAUS=”A” TIME_PERIOD="2010-09"> 275 -> <!—- complex multi-value and multi-lingual data attributes ~-~-> 276 -> <Comp id="TITLE" xsi:type="ns1:TITLE_ATTRIBUTE"> 277 -> <Value> 278 -> <common:Text xml:lang="en">Some English Text</common:Text> 279 -> <common:Text xml:lang="fr">Quelques textes en anglais</common:Text> 280 -> </Value> 281 -> </Comp> 282 -> <Comp id="SOURCE_AGENCY" xsi:type="ns1:SOURCE_AGENCY_ATTRIBUTE"> 283 -> <Value>4F0</Value> 284 -> <Value>4D0</Value> 285 -> <Value>CZ2</Value> 286 -> </Comp> 287 -> <!—- metadata attributes are reported like in metadata messages ~-~-> 288 -> <Metadata> 289 -> <Attribute id="COLLECTION"> 290 -> <Attribute id="METHOD"> 291 -> <Text lang="en">AAA</Text> 292 -> </Attribute> 293 -> </Attribute> 294 -> <Attribute id="CONTACT"> 295 -> <Value>CONTACT 1</Value> 296 -> <Attribute id="NAME"> 297 -> <Value>Contact 1 Name 1</Value> 298 -> </Attribute> 299 -> <Attribute id="NAME"> 300 -> <Value>Contact 1 Name 2</Value> 301 -> </Attribute> 302 -> </Attribute> 303 -> <Attribute id="CONTACT"> 304 -> <Value>CONTACT 2</Value> 305 -> <Attribute id="NAME"> 306 -> <Value>Contact 2 Name 1</Value> 307 -> </Attribute> 308 -> <Attribute id="NAME"> 309 -> <Value>Contact 2 Name 2</Value> 310 -> </Attribute> 311 -> </Attribute> 312 -> </Metadata> 313 -> </Obs> 282 +<Obs xsi:type="dsd:ObsType" OBS_VALUE="112" OBS_STAUS=”A” TIME_PERIOD="2010-09"> 314 314 284 +<!—- complex multi-value and multi-lingual data attributes ~-~-> 285 + 286 +<Comp id="TITLE" xsi:type="ns1:TITLE_ATTRIBUTE"> 287 + 288 +<Value> 289 + 290 +<common:Text xml:lang="en">Some English Text</common:Text> 291 + 292 +<common:Text xml:lang="fr">Quelques textes en anglais</common:Text> 293 + 294 +</Value> 295 + 296 +</Comp> 297 + 298 +<Comp id="SOURCE_AGENCY" xsi:type="ns1:SOURCE_AGENCY_ATTRIBUTE"> 299 + 300 +<Value>4F0</Value> 301 + 302 +<Value>4D0</Value> 303 + 304 +<Value>CZ2</Value> 305 + 306 +</Comp> 307 + 308 +<!—- metadata attributes are reported like in metadata messages ~-~-> 309 + 310 +<Metadata> 311 + 312 +<Attribute id="COLLECTION"> 313 + 314 +<Attribute id="METHOD"> 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 + 315 315 === New - Metadata Provision Agreement === 316 316 317 317 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. ... ... @@ -324,7 +324,7 @@ 324 324 325 325 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. 326 326 327 -== 3.5 Microdata Exchange == 374 +== //3.5 Microdata Exchange// == 328 328 329 329 Several changes have been made the Data Structure Definition to support microdata use cases in addition to aggregated time series. 330 330 ... ... @@ -336,35 +336,54 @@ 336 336 337 337 MeasureDimension behaviour as illustrated in the SDMX-ML example below: 338 338 339 -> <str:MeasureList id=”MeasureDescriptor”> 340 -> <str:Measure id=”OBS_VALUE” minOccurs=”1” maxOccurs=”1” usage=”mandatory” > <str:ConceptIdentity> 341 -> <Ref id=”OBS_VALUE” maintainableParentID=”CONCEPTS” agencyID=”SDMX” maintainableParentVersion=”1.0.0” /> 342 -> </str:ConceptIdentity> 343 -> <str:LocalRepresentation> 344 -> <str:TextFormat textType=”String” isMultiLingual=”true” /> 345 -> </str:LocalRepresentation> 346 -> <str:ConceptRole> 347 -> <Ref id=”MEASURE” maintainableParentID=”SDMX_CONCEPT_ROLES” agencyID=”SDMX” maintainableParentVersion=”1.0.0” /> 348 -> </str:ConceptRole> 349 -> </str:Measure> 350 -> ... 351 -> <str:Measure> 352 -> </str:MeasureList> 386 +<str:MeasureList id=”MeasureDescriptor”> 353 353 354 -(% class="wikigeneratedid" id="HMulti-valuemeasuresandattributes" %) 355 -**Multi-value measures and attributes** 356 -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 //mandatory// or optional. In the SDMX-ML measure 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. 388 +<str:Measure id=”OBS_VALUE” minOccurs=”1” maxOccurs=”1” usage=”mandatory” > <str:ConceptIdentity> 357 357 358 -(% class="wikigeneratedid" id="HAttributesrelationshiptomeasures" %) 359 -**Attributes relationship to measures** 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 + 360 360 In addition to attaching attributes to a specific level within the dataset, their relationship 202 to measures can also be defined. 361 361 362 -(% class="wikigeneratedid" id="HValuelists" %) 363 -**Value lists** 364 -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. That allows ValueItems (the equivalent to Code) to contain symbols like ‘¥’ and ‘€’, but also means they are not identifiable. 426 +=== Value lists === 365 365 366 - ==3.6GeospatialDataExchange==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. 367 367 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 + 368 368 The version 3.0 model has been extended to provide explicit support for geospatial data. 369 369 370 370 === GeospatialInformation type === ... ... @@ -378,14 +378,14 @@ 378 378 * 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. 379 379 * 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. 380 380 381 -== 3.7 Structure Mapping == 447 +=== //3.7 Structure Mapping// === 382 382 383 383 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. 384 384 385 385 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. 386 386 387 - (% class="wikigeneratedid" id="HMany-to-manysourceandtargetcomponents"%)388 - **Many-to-many source and target components**453 +==== Many-to-many source and target components ==== 454 + 389 389 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: 390 390 391 391 Set the output component INDICATOR=”DE_A” if the input components are FREQ=”A” and REF_AREA=”DE”. ... ... @@ -395,21 +395,22 @@ 395 395 Set the output components FREQ=”A”, REF_AREA=”DE” if the input component INDICATOR=”DE_A”. 396 396 397 397 **Fixed source and target** 464 + 398 398 The Structure Map may now define input or output components which have a fixed value. 399 399 400 - (% class="wikigeneratedid" id="HTimerepresentationsmapping"%)401 - **Time representations mapping**467 +==== Time representations mapping ==== 468 + 402 402 Non SDMX time representations may now be described in a Structure Map, allowing them to be mapped into SDMX time formats. 403 403 404 - (% class="wikigeneratedid" id="HRegularexpressionandsubstringmappings"%)405 - **Regular expression and substring mappings**471 +==== Regular expression and substring mappings ==== 472 + 406 406 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. 407 407 408 - (% class="wikigeneratedid" id="HItemmapsvalidityperiod"%)409 - **Item maps validity period**475 +==== Item maps validity period ==== 476 + 410 410 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. 411 411 412 -== 3.8 Constraints == 479 +=== //3.8 Constraints// === 413 413 414 414 Constraints in version 3.0 are modelled using two separate artefacts which replace the version 2.1 content constraint: 415 415 ... ... @@ -424,23 +424,23 @@ 424 424 425 425 Attachment constraints have been deprecated due to a lack of use cases. 426 426 427 -== 3.9 Code List Extension == 494 +=== //3.9 Code List Extension// === 428 428 429 429 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. 430 430 431 431 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. 432 432 433 -== 3.10 Discriminated Union of Code Lists == 500 +=== //3.10 Discriminated Union of Code Lists// === 434 434 435 435 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. 436 436 437 -== 3.11 Code Hierarchies == 504 +=== //3.11 Code Hierarchies// === 438 438 439 439 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). 440 440 441 441 = 4 Versioning of Structural Metadata Artefacts = 442 442 443 -Version 3.0 adopts semantic versioning principles for versioning of metadata artefacts 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 version artefacts by omitting the //version// property. The version number no longer defaults to 1.0 if not explicitly set.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. 444 444 445 445 Semantic version numbers are three digits: 446 446 ... ... @@ -482,7 +482,7 @@ 482 482 483 483 = 5 REST Web Services API = 484 484 485 -== 5.1 Simplified list of resources == 552 +== //5.1 Simplified list of resources// == 486 486 487 487 The version 3.0 REST API has just five main resources: 488 488 ... ... @@ -496,7 +496,7 @@ 496 496 497 497 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. 498 498 499 -== 5.2 Improved data queries == 566 +== //5.2 Improved data queries// == 500 500 501 501 Data queries have been changed to provide more granular selections from contexts wider than just a Dataflow. 502 502 ... ... @@ -522,12 +522,11 @@ 522 522 523 523 /data/dataflow/ESTAT/ICP?c[REF_AREA]=DE&c[ICP_ITEM]=sw:01&c[TIME_PERIOD]=ge:2015 Operators include: 524 524 525 -(% style="width:531.039px" %) 526 -|(% style="width:151px" %)eq|(% style="width:378px" %)Equals 527 -|(% style="width:151px" %)ne|(% style="width:378px" %)Not equal to 528 -|(% style="width:151px" %)le|(% style="width:378px" %)Less than 529 -|(% style="width:151px" %)ge|(% style="width:378px" %)Greater than or equal to 530 -|(% style="width:151px" %)sw|(% style="width:378px" %)Starts with 592 +|eq|Equals 593 +|ne|Not equal to 594 +|le|Less than 595 +|ge|Greater than or equal to 596 +|sw|Starts with 531 531 532 532 === Support for multiple keys === 533 533 ... ... @@ -535,7 +535,7 @@ 535 535 536 536 /data/dataflow/ESTAT/ICP/1.0.0/M…A.ANR,M…A.INX,M…B.CTG 537 537 538 -== 5.3 Improved reference metadata queries == 604 +== //5.3 Improved reference metadata queries// == 539 539 540 540 Reference metadata queries have been improved with a number of new options to retrieve metadata reports. 541 541 ... ... @@ -551,7 +551,7 @@ 551 551 552 552 /metadata/structure/datastructure/BIS/BIS_CBS/1.0 553 553 554 -== 5.4 Structural metadata maintenance == 620 +== //5.4 Structural metadata maintenance// == 555 555 556 556 Support has been added for maintenance of structural metadata. 557 557 ... ... @@ -559,7 +559,7 @@ 559 559 560 560 = 6 XML, JSON, CSV and EDI Transmission formats = 561 561 562 -== 6.1 SDMX-ML == 628 +== //6.1 SDMX-ML// == 563 563 564 564 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. 565 565 ... ... @@ -569,49 +569,47 @@ 569 569 570 570 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: 571 571 572 -(% style="width:1102.04px" %) 573 -|(% style="width:321px" %)**Artefact type**|(% style="width:351px" %)**Version 2.1 Collection**|(% style="width:426px" %)**Version 3.0 Collection** 574 -|(% style="width:321px" %)AgencyScheme|(% style="width:351px" %)OrganisationSchemes|(% style="width:426px" %)AgencySchemes 575 -|(% style="width:321px" %)DataConsumerScheme|(% style="width:351px" %)OrganisationSchemes|(% style="width:426px" %)DataConsumerSchemes 576 -|(% style="width:321px" %)DataProviderScheme|(% style="width:351px" %)OrganisationSchemes|(% style="width:426px" %)DataProviderSchemes 577 -|(% style="width:321px" %)MetadataProviderScheme|(% style="width:351px" %)OrganisationSchemes|(% style="width:426px" %)MetadataProviderSchemes 578 -|(% style="width:321px" %)OrganisationUnitScheme|(% style="width:351px" %)OrganisationSchemes|(% style="width:426px" %)OrganisationUnitSchemes 579 -|(% style="width:321px" %)GeographicCodelist|(% style="width:351px" %)Codelists|(% style="width:426px" %)GeographicCodelists 580 -|(% style="width:321px" %)GeoGridCodelist|(% style="width:351px" %)Codelists|(% style="width:426px" %)GeoGridCodelists 581 -|(% style="width:321px" %)ConceptScheme|(% style="width:351px" %)Concepts|(% style="width:426px" %)ConceptSchemes 582 -|(% style="width:321px" %)ValueList|(% style="width:351px" %)Codelists|(% style="width:426px" %)ValueLists 583 -|(% style="width:321px" %)StructureMap|(% style="width:351px" %)StructureMappings|(% style="width:426px" %)StructureMaps 584 -|(% style="width:321px" %)RepresentationMap|(% style="width:351px" %)StructureMappings|(% style="width:426px" %)RepresentationMaps 585 -|(% style="width:321px" %)ConceptSchemeMap|(% style="width:351px" %)StructureMappings|(% style="width:426px" %)ConceptSchemeMaps 586 -|(% style="width:321px" %)CategorySchemeMap|(% style="width:351px" %)StructureMappings|(% style="width:426px" %)CategorySchemeMaps 587 -|(% style="width:321px" %)OrganisationSchemeMap|(% style="width:351px" %)StructureMappings|(% style="width:426px" %)OrganisationSchemeMaps 588 -|(% style="width:321px" %)ReportingTaxonomyMap|(% style="width:351px" %)StructureMappings|(% style="width:426px" %)ReportingTaxonomyMaps 589 -|(% style="width:321px" %)DataConstraint|(% style="width:351px" %)Constraints|(% style="width:426px" %)DataConstraints 590 -|(% style="width:321px" %)MetadataConstraint|(% style="width:351px" %)Constraints|(% style="width:426px" %)MetadataConstraints 591 -|(% style="width:321px" %)MetadataProvisionAgreement|(% style="width:351px" %)ProvisionAgreement|(% style="width:426px" %)MetadataProvisionAgreements 592 -|(% style="width:321px" %)CustomTypeScheme|(% style="width:351px" %)CustomTypes|(% style="width:426px" %)CustomTypeSchemes 593 -|(% style="width:321px" %)VtlMappingScheme|(% style="width:351px" %)VtlMappings|(% style="width:426px" %)VtlMappingSchemes 594 -|(% style="width:321px" %)NamePersonalisationScheme|(% style="width:351px" %)NamePersonalisations|(% style="width:426px" %)NamePersonalisationSchemes 595 -|(% style="width:321px" %)RulesetScheme|(% style="width:351px" %)Rulesets|(% style="width:426px" %)RulesetSchemes 596 -|(% style="width:321px" %)TransformationScheme|(% style="width:351px" %)Transformations|(% style="width:426px" %)TransformationSchemes 597 -|(% style="width:321px" %)UserDefinedOperatorScheme|(% style="width:351px" %)UserDefinedOperators|(% style="width:426px" %)UserDefinedOperatorSchemes 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 598 598 599 599 No changes have been made to the way the following artefacts are organised in the structure message: 600 600 601 -(% style="width:1106.04px" %) 602 -|(% style="width:326px" %)**Artefact type**|(% style="width:776px" %)**Collection** 603 -|(% style="width:326px" %)Dataflow|(% style="width:776px" %)Dataflows 604 -|(% style="width:326px" %)Metadataflow|(% style="width:776px" %)Metadataflows 605 -|(% style="width:326px" %)CategoryScheme|(% style="width:776px" %)CategorySchemes 606 -|(% style="width:326px" %)Categorisation|(% style="width:776px" %)Categorisations 607 -|(% style="width:326px" %)Codelist|(% style="width:776px" %)Codelists 608 -|(% style="width:326px" %)Hierarchy|(% style="width:776px" %)Hierarchies 609 -|(% style="width:326px" %)HierarchyAssociation|(% style="width:776px" %)HierarchyAssociations 610 -|(% style="width:326px" %)MetadataStructure|(% style="width:776px" %)MetadataStructures 611 -|(% style="width:326px" %)DataStructure|(% style="width:776px" %)DataStructures 612 -|(% style="width:326px" %)ReportingTaxonomy|(% style="width:776px" %)ReportingTaxonomies 613 -|(% style="width:326px" %)Process|(% style="width:776px" %)Processes 614 -|(% style="width:326px" %)ProvisionAgreement|(% style="width:776px" %)ProvisionAgreements 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 615 615 616 616 From version 3.0, collections can appear in any order within a structure message. 617 617 ... ... @@ -645,7 +645,7 @@ 645 645 646 646 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. 647 647 648 -== 6.2 SDMX-JSON == 712 +== //6.2 SDMX-JSON// == 649 649 650 650 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. 651 651 ... ... @@ -665,7 +665,7 @@ 665 665 666 666 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. 667 667 668 -== 6.3 SDMX-CSV == 732 +== //6.3 SDMX-CSV// == 669 669 670 670 CSV in SDMX is used transmission of data and reference metadata only. 671 671 ... ... @@ -683,7 +683,7 @@ 683 683 684 684 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. 685 685 686 -=== 6.4 EDI deprecation === 750 +=== //6.4 EDI deprecation// === 687 687 688 688 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. 689 689
- SUZ.Methodology.Code.MethodologyClass[0]
-