Last modified by Helena on 2025/09/10 11:19

From version 13.1
edited by Helena
on 2025/05/16 15:18
Change comment: Rollback to version 11.1
To version 4.9
edited by Helena
on 2025/05/14 15:27
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -25,25 +25,21 @@
25 25  
26 26  **Section 6** **SDMX Technical Notes** – detailed technical guidance for implementors of the SDMX standard.
27 27  
28 -The following are published on the GitHub repository of the SDMX Standards Technical Working Group (__[[https:~~/~~/github.com/sdmx-twg>>https://github.com/sdmx-twg]]__):
28 +The following are published on the GitHub repository of the SDMX Standards Technical Working Group ( __[[https:~~/~~/github.com/sdmx-twg>>https://github.com/sdmx-twg]]) :__
29 29  
30 -(% class="wikigeneratedid" id="Hsdmx-twg2Fsdmx-rest2013RESTAPI" %)
31 -**sdmx-twg/sdmx-rest – REST API**
30 +=== sdmx-twg/sdmx-rest – REST API ===
32 32  
33 33  Technical specifications for the SDMX RESTful web services application programming interfaces (API).
34 34  
35 -(% class="wikigeneratedid" id="Hsdmx-twg2Fsdmx-ml2013SDMX-ML" %)
36 -**sdmx-twg/sdmx-ml – SDMX-ML**
34 +=== sdmx-twg/sdmx-ml – SDMX-ML ===
37 37  
38 38  Technical specifications for the XML transmission format including XSD schemas, documentation and samples for data, structure and reference metadata messages.
39 39  
40 -(% class="wikigeneratedid" id="Hsdmx-twg2Fsdmx-json2013SDMX-JSON" %)
41 -**sdmx-twg/sdmx-json – SDMX-JSON**
38 +=== sdmx-twg/sdmx-json – SDMX-JSON ===
42 42  
43 43  Technical specifications for the JSON transmission format including documentation, schemas and samples for data, structure and reference metadata messages.
44 44  
45 -(% class="wikigeneratedid" id="Hsdmx-twg2Fsdmx-csv2013SDMX-CSV" %)
46 -**sdmx-twg/sdmx-csv – SDMX-CSV**
42 +=== sdmx-twg/sdmx-csv – SDMX-CSV ===
47 47  
48 48  Technical specifications for the SDMX-CSV transmission format for ‘comma-separated values’ (CSV) data and reference metadata.
49 49  
... ... @@ -89,8 +89,7 @@
89 89  
90 90  SDMX version 3.0 introduces new features, improvements and changes to the Standard in the following key areas:
91 91  
92 -(% class="wikigeneratedid" id="HInformationModel" %)
93 -**Information Model**
88 +===== Information Model =====
94 94  
95 95  * Simplification and improvement of the reference metadata model
96 96  * Support for microdata
... ... @@ -100,13 +100,11 @@
100 100  * Improvements to code hierarchies for data discovery
101 101  * Improvements to constraints
102 102  
103 -(% class="wikigeneratedid" id="HVersioningofStructuralMetadataArtefacts" %)
104 -**Versioning of Structural Metadata Artefacts**
98 +===== Versioning of Structural Metadata Artefacts =====
105 105  
106 106  * Adoption of the three-number semantic versioning standard for structural metadata artefacts (__[[https:~~/~~/semver.org>>url:https://semver.org/]])__
107 107  
108 -(% class="wikigeneratedid" id="HRESTWebServicesApplicationProgrammingInterface28API29" %)
109 -**REST Web Services Application Programming Interface (API)**
102 +===== REST Web Services Application Programming Interface (API) =====
110 110  
111 111  * Change to a single ‘structure’ resource for structure queries simplifying the REST API specification by reducing the number of resources to five
112 112  * Improvements to data queries
... ... @@ -113,13 +113,11 @@
113 113  * Improvements to reference metadata queries
114 114  * Support for structural metadata maintenance using HTTP PUT, POST and DELETE verbs
115 115  
116 -(% class="wikigeneratedid" id="HSOAPWebServicesAPI" %)
117 -**SOAP Web Services API**
109 +===== SOAP Web Services API =====
118 118  
119 119  * The SOAP web services API has been deprecated with version 3.0 standardising on REST
120 120  
121 -(% class="wikigeneratedid" id="HXML2CJSON2CCSVandEDITransmissionformats" %)
122 -**XML, JSON, CSV and EDI Transmission formats**
113 +===== XML, JSON, CSV and EDI Transmission formats =====
123 123  
124 124  * 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
125 125  * 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
... ... @@ -231,7 +231,7 @@
231 231  * //**Dataflow Definition:**// In SDMX, data sets are reported or disseminated according to a data flow definition. The data flow definition identifies the data structure definition and may be associated with one or more subject matter domains via a Categorisation (this facilitates the search for data according to organised category schemes). Constraints, in terms of reporting periodicity or sub set of possible keys that are allowed in a data set, may be attached to the data flow definition.
232 232  * //**Metadataflow Definition:**// A metadata flow definition is very similar to a data flow definition, but describes, categorises, and constrains metadata sets.
233 233  * //**Data Provider: **//An organization which produces data is termed a data provider.
234 -* //**Metadata Provider: **//An organization which produces reference metadata is termed a metadata provider.
225 +* //**Metadata Provider: **//An organization which produces reference metadata is termed a metadata provider.//  //
235 235  * //**Provision Agreement (Metadata Provision Agreement):**// The set of information which describes the way in which data sets and metadata sets are provided by a data/metadata provider. A provision agreement can be constrained in much the same way as a data or metadata flow definition. Thus, a data provider can express the fact that it provides a particular data flow covering a specific set of countries and topics, Importantly, the actual source of registered data or metadata is attached to the provision agreement (in terms of a URL). The term “agreement” is used because this information can be understood as the basis of a “service-level agreement”. In SDMX, however, this is informational metadata to support the technical systems, as opposed to any sort of contractual information (which is outside the scope of a technical specification). In version 3.0, metadata provision agreement and data provision agreement are two separate artefacts.
236 236  * //**Constraint:**// Data and Metadata Constraints describe a subset of a data source or metadata source, and may also provide information about scheduled releases of data. They are associated with data / metadata providers, provision agreements, data flows, metadataflows, data structure definitions and metadata structure definitions.
237 237  * //**Structure Map: **//Structure maps describes a mapping between data structure definitions or dataflows for the purpose of transforming a data set into a different structure. The mapping rules are defined using one or more component maps which each map in turn describes how one or more components from the source data 534 structure definition map to one or more components in that of the target. Represent maps act as lookup tables and specific provision is made for mapping dates and times.
... ... @@ -276,8 +276,10 @@
276 276  
277 277  SDMX provides a way of modelling statistical data, and defines the set of metadata constructs used for this purpose. Because SDMX specifies a number of transmission formats for expressing data and structural metadata, the model is used as a mechanism for guaranteeing that transformation between the different formats is lossless. In this sense, all of the formats are syntax-bound expressions of the common information model.
278 278  
279 -SDMX recognizes that statistical data is structured; in SDMX this structure is termed a Data Structure Definition. “Data sets” are made up of one or more lower-level “groups”, based on their degrees of similarity. Each group is in turn comprised of one or more “series” of data. Each series or section has a “key” - values for each of a cluster of concepts, also called "dimensions" - which identifies it, and one or more “observations”, which typically combine the time of the observation, and the value of the observation (e.g., measurement). Additionally, metadata may be attached at any level of this structure as descriptive “attributes”. Code lists (enumerations) and other patterns for representation of data and metadata are also modelled.
270 +SDMX recognizes that statistical data is structured; in SDMX this structure is termed a Data Structure Definition. “Data sets” are made up of one or more lower-level “groups”, based on their degrees of similarity. Each group is in turn comprised of one or more “series” of data. Each series or section has a “key” - values for each of a cluster of concepts, also called
280 280  
272 +"dimensions" - which identifies it, and one or more “observations”, which typically combine the time of the observation, and the value of the observation (e.g., measurement). Additionally, metadata may be attached at any level of this structure as descriptive “attributes”. Code lists (enumerations) and other patterns for representation of data and metadata are also modelled.
273 +
281 281  There is some similarity between “cube” structures commonly used to process statistical data, and the Data Structure Definition idea in the SDMX Information Model. It is important to note that the data as structured according to the SDMX Information Model is optimized for exchange, potentially with partners who may have no ability to process a “cube” of data coming from complex statistical systems. SDMX time series can be understood as “slices” of the cube. Such a slice is identified by its key. A "series" key consists of the values for all dimensions specified by the key family except time. Thus, it is possible to reconstruct and describe data cubes from SDMX-structured data, and to exchange such databases using the interfaces and formats provided for that purpose in the standard. Additional objects such as hierarchical code lists, constraints and structure maps make it possible to more fully model the structure of cubes.
282 282  
283 283  The information model also provides a view of reference metadata: a mechanism for referencing the meaningful “objects” within the SDMX view of statistical exchange processes (data providers, structures, provisioning agreements, dataflows, metadata flows, etc.) to which metadata is attached; a mechanism for describing a set of meaningful concepts, of organizing them into a presentational structure, and of indicating how their values are represented. This is based on a simple, hierarchical view of reference metadata which is common to many metadata systems and classification/categorization schemes. SDMX provides a model (and XML and JSON formats) for both describing reference metadata structures, and of reporting reference metadata according to those structures.
... ... @@ -302,10 +302,12 @@
302 302  Many XML tools and technologies have expectations about the functions performed by an XML schema, one of which is a very direct relationship between the XML constructs described in the XML schema and the tagged data in the XML instance. Strong data typing is also considered normal, supporting full validation of the tagged data. These message types are designed to support validation and other expected XML schema functions.
303 303  
304 304  1. //Generic Metadata~:// For the exchange of reference metadata sets. ‘Generic’ means the XML elements and XML attributes are the same regardless of the metadata set.
305 -1. //Registry~:// All of the possible interactions with the SDMX registry services are supported using SDMX-ML interfaces and REST API calls. Submission of structural metadata content, data / metadata registrations and subscriptions is performed by a synchronous exchange of documents – a “request” message answered by a “response” message.
298 +1. //Registry~:// All of the possible interactions with the SDMX registry services are supported using SDMX-ML interfaces and REST API calls. Submission of structural metadata content, data / metadata registrations and subscriptions is performed by a synchronous exchange of documents – a “request” message answered by a
306 306  
307 -== 5.2 SDMX-JSON ==
300 +“response” message.
308 308  
302 +== {{id name="_Toc56241"/}}5.2 SDMX-JSON ==
303 +
309 309  SDMX-JSON is the JSON transmission format specification for exchanging structural metadata, data and reference metadata. It provides an alternative to SDMX-ML and is most suited to applications like web data dissemination.
310 310  
311 311  SDMX-JSON messages serve the same function as those of the XML formats but have a different structure. For data, an important distinction is that they carry both component codes and labels which provides all the information needed to display the content in a single JSON response. The XML Structure-specific Data format by contrast carries only code IDs thus requiring applications obtain and hold structural metadata about the data set in order to display the content in human-readable form.
... ... @@ -318,7 +318,7 @@
318 318  1. //Data: //For the exchange of data. Unlike SDMX-ML, the structure of a SDMX-JSON data message is not specific to the DSDs of the data sets so schema validation will not check for compliance of the data with the DSDs.
319 319  1. //Metadata//: For the exchange of reference metadata sets.
320 320  
321 -== 5.3 SDMX-CSV ==
316 +== {{id name="_Toc56242"/}}5.3 SDMX-CSV ==
322 322  
323 323  SDMX-CSV is the CSV transmission format specification for exchanging data and reference metadata only.
324 324  
... ... @@ -329,7 +329,7 @@
329 329  1. //Data//: For the exchange of data. Like SDMX-JSON, SDMX-CSV can include both code IDs and labels which is helpful when using the data to create human readable charts and dashboards.
330 330  1. //Metadata//: For the exchange of reference metadata sets.
331 331  
332 -== 5.4 Formats and Messages Deprecated in Version 3.0 ==
327 +== {{id name="_Toc56243"/}}5.4 Formats and Messages Deprecated in Version 3.0 ==
333 333  
334 334  The following formats and messages have been deprecated in version 3.0 to simplify, modernise and rationalise the standard.
335 335  
... ... @@ -346,35 +346,35 @@
346 346  * SDMX-ML Query messages
347 347  * SDMX-ML Submit Structure Request messages
348 348  
349 -= 6 Dependencies on SDMX content-oriented guidelines =
344 += {{id name="_Toc56244"/}}6 Dependencies on SDMX content-oriented guidelines =
350 350  
351 351  The technical standards proposed here are designed so that they can be used in conjunction with other SDMX guidelines which are more closely tied to the content and semantics of statistical data exchange. The SDMX Information Model works equally well with any statistical concept, but to encourage interoperability, it is also necessary to standardize and harmonize the use of specific concepts and terminology. To achieve this goal, SDMX creates and maintains guidelines for cross-domain concepts, terminology, and structural definitions. There are three major parts to this effort.
352 352  
353 -== 6.1 Cross-Domain Concepts ==
348 +== {{id name="_Toc56245"/}}6.1 Cross-Domain Concepts ==
354 354  
355 355  The SDMX Cross-Domain Concepts is a content guideline concerning concepts which are used across statistical domains. This list is expected to grow and to be subject to revision as SDMX is used in a growing number of domains. The use of the SDMX Cross-Domain Concepts, where appropriate, provides a framework to further promote interoperability among organisations using the technical standards presented here. The harmonization of statistical concepts includes not only the definitions of the concepts, and their names, but also, where appropriate, their representation with standard code lists, and the role they play within data structure definitions and metadata structure definitions.
356 356  
357 357  The intent of this guideline is two-fold: to provide a core set of concepts which can be used to structure statistical data and metadata, to promote interoperability between systems (“structural metadata”, as described above); and to promote the exchange of metadata more widely, with a set of harmonized concept names and definitions for other types of metadata (“reference metadata”, as defined above.)
358 358  
359 -== 6.2 Metadata Common Vocabulary ==
354 +== {{id name="_Toc56246"/}}6.2 Metadata Common Vocabulary ==
360 360  
361 361  The Metadata Common Vocabulary is an SDMX guideline which provides definition of terms to be used for the comparison and mapping of terminology found in data structure definitions and in other aspects of statistical metadata management. Essentially, it provides ISOcompliant definitions for a wide range of statistical terms, which may be used directly, or against which other terminology systems may be mapped. This set of terms is inclusive of the terminology used within the SDMX Technical Standards.
362 362  
363 363  The MCV provides definitions for terms on which the SDMX Cross-Domain Metadata Concepts work is built.
364 364  
365 -== 6.3 Statistical Subject-Matter Domains ==
360 +== {{id name="_Toc56247"/}}6.3 Statistical Subject-Matter Domains ==
366 366  
367 367  The Statistical Subject-Matter Domains is a listing of the breadth of statistical information for the purposes of organizing widespread statistical exchange and categorization. It acts as a standard scheme against which the categorization schemes of various counterparties can be mapped, to facilitate interoperable data and metadata exchange. It serves another useful purpose, however, which is to allow an organization of corresponding “domain groups”, each of which could define standard data structure definitions, concepts, etc. within their domains. Such groups already exist within the international community. SDMX would use the Statistical Subject-Matter Domains list to facilitate the efforts of these groups to develop the kinds of content standards which could support the interoperation of SDMX-conformant technical systems within and across statistical domains. The organisation of the content of such schemes is supported in SDMX as a Category Scheme.
368 368  
369 369  SDMX Statistical Subject-Matter Domains will be listed and maintained by the SDMX Initiative and will be subject to adjustment.
370 370  
371 -== 6.4 SDMX Concept Roles ==
366 +== {{id name="_Toc56248"/}}6.4 SDMX Concept Roles ==
372 372  
373 373  These guidelines define the standard set of SDMX Concept Roles and their use. This set of standard SDMX Concepts are implemented as a cross-domain Concept Scheme that defines the set of concept roles and gives examples on concept role implementation in SDMX 2.0, 2.1 and 3.0. A concept role gives a particular context to a concept for easy and systematic interpretation by machine processing and visualization tools. For example, the concepts REPORTING_AREA and COUNTERPART_AREA are different concepts but they are both geographical characteristics, therefore they can be associated with the same concept role ID: "GEO". This allows visualization systems to interpret these concepts as geographical data in order to generate maps. The implementation of concept roles is different in versions 2.0 and 2.1/3.0 of the SDMX technical standard. Specifically for SDMX 3.0, this set of roles is considered a normative list that must be interpreted in the same way by all organisations.
374 374  
375 375  Additional roles may be provided via the standard roles’ mechanism in SDMX 3.0, i.e., via Concept Schemes; the semantics of these roles have to be agreed bilateraly in data exchanges. The Concept Roles are available as an SDMX Concept Scheme on the SDMX Global Registry.
376 376  
377 -= 7 Validation and Transformation Language =
372 += {{id name="_Toc56249"/}}7 Validation and Transformation Language =
378 378  
379 379  For many years the SDMX initiative has been fostering and supporting the development of a standard calculation language, called Validation and Transformation Language (VTL). A blueprint for defining calculations was already described in the original SDMX 2.1 specifications (package 13 of the Information Model - “Transformations and Expressions”). It was just a basic framework that required further developments to became operational in order to achieve a calculation language able to manipulate SDMX artefacts.
380 380  
SUZ.Methodology.Code.MethodologyClass[0]