Changes for page Part VI. Samples

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

From 6.2 to 6.3

From version 1.1

edited by Helena
on 2025/07/01 18:27

Change comment: There is no comment for this version

To version 6.2

edited by Helena
on 2025/07/03 11:33

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (3 modified, 0 added, 0 removed)
Objects (1 modified, 0 added, 0 removed)
- SUZ.Methodology.Code.MethodologyClass[0]

Details

Page properties

Title

@@ -1,1 +1,1 @@
--Part VI. Registry
++Part VI. Samples: This provides a brief explanation of the currently available sample files

Tags

...	...	@@ -1,0 +1,1 @@
	1	+Age\|Attribute\|Code\|Code list\|Component\|Concept scheme\|Currency\|Data set\|Data structure definition\|Dataflow\|Dimension\|Measure\|Representation\|SDMX-ML\|Statistical data and metadata exchange\|Structural metadata\|Title\|Validation and transformation language

Content

@@ -1,0 +1,210 @@
++{{box title="**Contents**"}}
++{{toc/}}
++{{/box}}
++
++= 1 Introduction =
++
++This document provides a brief overview of the [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] XML sample files.
++
++All samples use the xsi:schemaLocation [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] to define the location of the XSD schema files for the relevant namespaces. The samples assume that the schemas are held locally in a directory called 'schemas' and are referenced as a relative file path. For example:
++
++`xsi:schemaLocation="http:~/~/www.sdmx.org/resources/sdmxml/schemas/v3_1/message ../../schemas/SDMXMessage.xsd"`
++
++Copies of the [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] XSD schemas files will need to be in the appropriate directory in order to validate correctly.
++
++= 2 Structure Samples =
++
++The Structure Samples provide examples of [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] messages within the *structure* namespace which is used for all [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] artefacts.
++
++== Codelist ==
++
++(% class="wikigeneratedid" id="Hcodelist.xml" %)
++**codelist.xml**
++
++A simple enumerated [[code list>>doc:sdmx:Glossary.Code list.WebHome]] directly equivalent to those in (% style="color:#e74c3c" %)version(%%) 2.1 and earlier.
++
++This example shows the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:CL_AGE '[[Age>>doc:sdmx:Glossary.Age.WebHome]]' cross domain [[code list>>doc:sdmx:Glossary.Code list.WebHome]].
++
++(% class="wikigeneratedid" id="Hcodelist-extended.xml" %)
++**codelist - extended.xml**
++
++Extended [[code list>>doc:sdmx:Glossary.Code list.WebHome]].
++
++Illustration of the feature introduced in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 allowing [[code lists>>doc:sdmx:Glossary.Code list.WebHome]] to be defined as an extension of others. One use case envisaged is adding additional [[codes>>doc:sdmx:Glossary.Code.WebHome]] to standard cross domain [[code lists>>doc:sdmx:Glossary.Code list.WebHome]] without needing to take and maintain an explicit copy.
++
++The sample message has two [[codelists>>doc:sdmx:Glossary.Code list.WebHome]]:
++
++* [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:CL_AGE, a simple enumerated [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]; and
++* EXAMPLE:CL_EXTENDED_AGE, an extension of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:CL_AGE.
++
++CL_EXTENDED_AGE defines two additional [[codes>>doc:sdmx:Glossary.Code.WebHome]] "I" and "S".
++
++In addition, the ExclusiveCodeSelection option to exclude the "Y" [[code>>doc:sdmx:Glossary.Code.WebHome]] from the CL_AGE [[code list>>doc:sdmx:Glossary.Code list.WebHome]]. The result is CL_AGE, minus "Y", plus "I" and "S". The InclusiveCodeSelection option could have been used if a specific set of [[codes>>doc:sdmx:Glossary.Code.WebHome]] were needed from CL_AGE.
++
++(% class="wikigeneratedid" id="Hcodelist-discriminatedunion.xml" %)
++**codelist - discriminated union.xml**
++
++Discriminated union of [[code lists>>doc:sdmx:Glossary.Code list.WebHome]].
++
++This sample illustrates the discriminated union of [[code lists>>doc:sdmx:Glossary.Code list.WebHome]] use case where a classification or breakdown has multiple "variants" which are all valid or mutually exclusive.
++
++Economic activity has been used with ISIC4 and NACE2 examples of two mutually exclusive variants.
++
++In the sample:
++
++* [[Code list>>doc:sdmx:Glossary.Code list.WebHome]] extension is used to create a new EXAMPLE:CL_ACTIVITY [[code list>>doc:sdmx:Glossary.Code list.WebHome]] consisting of both the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:CL_ACTIVITY_NACE2 and [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:CL_ACTIVITY_ISIC4 [[codelists>>doc:sdmx:Glossary.Code list.WebHome]].
++* The [[code list>>doc:sdmx:Glossary.Code list.WebHome]] extension prefix feature has been used to prefix the NACE [[codes>>doc:sdmx:Glossary.Code.WebHome]] with "NACE2_", and similarly the ISIC [[codes>>doc:sdmx:Glossary.Code.WebHome]] with "ISIC4_". This ensures there is no ambiguity where the same [[code>>doc:sdmx:Glossary.Code.WebHome]] appear in both NACE and ISIC [[code lists>>doc:sdmx:Glossary.Code list.WebHome]].
++* A [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] has been created with an enumerated ACTIVITY [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] using the EXAMPLE:CL_ACTIVITY [[code list>>doc:sdmx:Glossary.Code list.WebHome]].
++* Two [[data flows>>doc:sdmx:Glossary.Dataflow.WebHome]] are created referencing the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. One [[data flow>>doc:sdmx:Glossary.Dataflow.WebHome]] has a data (% style="color:#e74c3c" %)constraint(%%) attached with a CubeRegion for ACTIVITY and Value = "NACE2_%". The other has a similar data (% style="color:#e74c3c" %)constraint(%%) with Value = "ISIC4_%". The "%" is the wildcard character for (% style="color:#e74c3c" %)constraints(%%) introduced in (% style="color:#e74c3c" %)version(%%) 3.0.
++
++The discriminated unions are achieved by requesting either of the [[data flows>>doc:sdmx:Glossary.Dataflow.WebHome]] with references="all" and detail="referencepartial". The result being CL_ACTIVITY with the extensions resolved and the relevant data (% style="color:#e74c3c" %)constraint(%%) applied. Thus CL_ACTIVITY will only contain [[codes>>doc:sdmx:Glossary.Code.WebHome]] prefixed according to the [[data flow>>doc:sdmx:Glossary.Dataflow.WebHome]]: either beginning "NACE2_" or "ISIC4_"
++
++(% class="wikigeneratedid" id="Hvaluelist.xml" %)
++**valuelist.xml**
++
++A simple enumerated value list.
++
++Value lists were introduced in (% style="color:#e74c3c" %)version(%%) 3.0 to allow the definition of enumerations where the [[codes>>doc:sdmx:Glossary.Code.WebHome]] do not need to comply with the strict [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] rules for identifiers. Thus a "value" can be any string of characters.
++
++In [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] valuelists are treated as a class of enumeration so appear in the structure message under [[Codelists>>doc:sdmx:Glossary.Code list.WebHome]] alongside simple and extended [[codelists>>doc:sdmx:Glossary.Code list.WebHome]], and specialised geospatial [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] variants.
++
++[[Currency>>doc:sdmx:Glossary.Currency.WebHome]] is used as the example with the values being [[currency>>doc:sdmx:Glossary.Currency.WebHome]] symbols including "$", "£", "¥" and "﷼".
++
++== Concept Scheme ==
++
++(% class="wikigeneratedid" id="Hconceptscheme.xml" %)
++**conceptscheme.xml**
++
++The example illustrates a single [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] ECB:ECB_CONCEPTS containing multiple individual (% style="color:#e74c3c" %)concepts(%%).
++
++== ##Data Structure Definition## ==
++
++**##ECB EXR.xml##**
++
++The example illustrates a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] ([[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]]) for ECB:EXR exchange rates. The (% style="color:#e74c3c" %)concept(%%) of primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] has been deprecated in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 and the [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]]'s MeasureList can contain multiple [[measures>>doc:sdmx:Glossary.Measure.WebHome]]. In this case, a single [[measure>>doc:sdmx:Glossary.Measure.WebHome]] OBS_VALUE is defined.
++
++== ##Dataflow## ==
++
++##**dataflow.xml**##
++
++A simple [[data flow>>doc:sdmx:Glossary.Dataflow.WebHome]] for the ECB:EXR [[data set>>doc:sdmx:Glossary.Data set.WebHome]].
++
++== ##Geospatial## ==
++
++**##geospatial geocomponents.xml##**
++
++An example of the use of the "GeospatialInformation" [[representation>>doc:sdmx:Glossary.Representation.WebHome]] type. The GeospatialInformation type can be assigned to a [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], DataAttribute, MetadataAttribute or a [[Measure>>doc:sdmx:Glossary.Measure.WebHome]] in conjunction with the "GEO" role. Values of are included directly in data messages or metadata reports and must conform to the Geo Feature Set syntax defined in Section 6 of the Technical Specifications.
++
++In the sample:
++
++* A simple illustrative [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] has been defined with IDENTIFIER and TIME_PERIOD [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]], plus a series [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] AREA.
++* The AREA [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] has the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] (% style="color:#e74c3c" %)Concept(%%) Role "GEO" defined identifying it generally as a geospatial [[component>>doc:sdmx:Glossary.Component.WebHome]] following guidelines.
++* The AREA [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] also carries a LocalRepresentation with textType="GeospatialInformation".
++
++**##geospatial geographiccodelist.xml##**
++
++An example of the definition of GeographicCodelists, a specialised form of [[code list>>doc:sdmx:Glossary.Code list.WebHome]] introduced in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0. GeographicCodelists are used in the same was as simple [[code lists>>doc:sdmx:Glossary.Code list.WebHome]] to assign a closed enumerated list of values to a [[component>>doc:sdmx:Glossary.Component.WebHome]]. The difference being that the definition of each GeoFeatureSetCode explicitly specifies the geospatial features to which it relates as a string expression using the Geo Feature Set syntax set out in Section 6 of the Technical Specifications. As with any other coded [[component>>doc:sdmx:Glossary.Component.WebHome]], [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] only contain the [[codes>>doc:sdmx:Glossary.Code.WebHome]] and not the Feature Set information itself. Thus, GeoFeatureSetCodes act as pointers to the Geo Feature Set information held in the GeographicCodelist.
++
++In the sample:
++
++* A single illustrative GeographicCodelist has been defined which must be under [[Codelists>>doc:sdmx:Glossary.Code list.WebHome]] in the structure message.
++* The GeographicCodelist geoType [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] must be given the value of "GeographicCodelist".
++* Three illustrative GeoFeatureSetCodes have been defined with IDs "A1", "A2" and "A3".
++* The GeoFeatureSetCode Value [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifies the geospatial features to which the [[code>>doc:sdmx:Glossary.Code.WebHome]] relates as a string expression. Note that the values shown are conceptual examples and are not syntactically valid Geo Feature Set expressions.
++
++**##geospatial geogridcodelist.xml##**
++
++An example of the definition of GeoGridCodelists, the second specialised form of [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] for modelling gridded geographies.
++Like GeographicCodelists, GeoGridCodelists act in the same way as simple [[code lists>>doc:sdmx:Glossary.Code list.WebHome]] to assign a closed enumerated list of values to a [[component>>doc:sdmx:Glossary.Component.WebHome]].
++GeoGridCodelists define a geographical grid by setting the X and Y coordinates of a reference point, and the [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] of each cell. In addition, each GeoGridCode specifies to which cell in the grid it relates using row and column numbers.
++
++In the sample:
++
++* A single illustrative GeoGridCodelist has been defined which must be under [[Codelists>>doc:sdmx:Glossary.Code list.WebHome]] in the structure message.
++* The GridDefinition element defines the grid for the [[code list>>doc:sdmx:Glossary.Code list.WebHome]] using a string expression conforming to the Geo Grid syntax set out in Section 6 of the Technical Specifications.
++* Each GeoGridCode has an ID and a Name in common with the [[codes>>doc:sdmx:Glossary.Code.WebHome]] of simple [[code lists>>doc:sdmx:Glossary.Code list.WebHome]], but also has a GeoCell element containing the row and column of the grid cell as a string expression using the Grid Cell syntax set out in Section 6 of the Technical Specifications.
++
++## [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] Transformations##
++
++##**VTL Sample 1.xml**##
++
++Illustrates the use of [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] Rulesets to validate an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]. The validation process adds additional identifiers and [[measures>>doc:sdmx:Glossary.Measure.WebHome]] to the resulting [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] indicating, on a row by row basis the validation rule applied and the outcome in terms of a valid / invalid. If invalid, details of the error found and its severity are added.
++
++A second transformation takes the resulting [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] filtering out high-severity validation errors and persists the result back to a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] using [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] mappings.
++
++##**VTL Sample 2.xml**##
++
++Illustrates aggregation of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] using [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] hierarchical rulesets, filtering and user defined operators.
++
++After the initial aggregation, unaggregated observations removed are removed from the result [[dataset>>doc:sdmx:Glossary.Data set.WebHome]]. A user defined operator is subsequently applied to calculate a percentage [[measure>>doc:sdmx:Glossary.Measure.WebHome]] with the final persistent result (% style="color:#e74c3c" %)mapped(%%) from [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] to a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]].
++
++##**VTL Sample 3.xml**##
++
++Illustrates the calculation of a GDP per capita [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] from an input (% style="color:#e74c3c" %)mapped(%%) [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] containing GDP and population indicators on a country by country basis.
++
++= 3 Data Samples =
++
++[[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] 3.0 has a single format for data transmission - the Structure Specific Data message. Alternative formats from (% style="color:#e74c3c" %)version(%%) 2.1 and earlier such as Generic, Utility and Cross Sectional are deprecated.
++
++The Structure Specific Data message is characterised by the XML elements and [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] being derived from the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] of the [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. This provides two main benefits:
++
++1. The message content is relatively compact.
++1. It is possible to use an XML schema to validate that the [[data set>>doc:sdmx:Glossary.Data set.WebHome]] contains the correct values as defined by the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] and any (% style="color:#e74c3c" %)constraints(%%) attached to the [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] or data provision agreement.
++
++The samples therefore include both the Structure Specific Data XML, and a corresponding example validation schema XSD. Successful schema validation confirms that the XML is both a valid Structure Specific Data message, and the content is valid according to the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]].
++
++== Aggregated Time Series with Simple Data Attributes ==
++
++##**ECB EXR.xml**##
++
++Structure specific data message.
++
++Excerpt from the ECB's Exchange Rates [[dataset>>doc:sdmx:Glossary.Data set.WebHome]].
++
++In this example which is representative of aggregated time-series [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] with a single [[measure>>doc:sdmx:Glossary.Measure.WebHome]], observations are grouped together under series, which in turn are grouped under the [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] element.
++
++The [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values and those of series-(% style="color:#e74c3c" %)level(%%) [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] are expressed as XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] on each series element. Similarly, the TIME_PERIOD, OBS_VALUE and any observation-(% style="color:#e74c3c" %)level(%%) [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] are expressed as XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] on each obs element.
++
++Note that a structure specific namespace ns1 is defined using xsi:schemalocation to reference the validation schema location, in this case ECB_EXR_Dataflow.xsd.
++
++**##ECB EXR [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]].xsd##**
++
++Structure-specific schema for validating the [[dataset>>doc:sdmx:Glossary.Data set.WebHome]].
++
++The schema defines a complex type called DataSetType derived from the [[data set>>doc:sdmx:Glossary.Data set.WebHome]]'s [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] and (% style="color:#e74c3c" %)constraints(%%), in this case those attached to the [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]].
++
++## Aggregated Time Series with Complex Data [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]##
++
++Complex [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] include those with multilingual text and arrays of values.
++
++**##EXB EXR CA.xml##**
++
++Structure specific data message.
++
++A modification of the ECB's Exchange Rates [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] illustrating the following complex [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] use cases:
++
++[[TITLE>>doc:sdmx:Glossary.Title.WebHome]] - multi-lingual series-(% style="color:#e74c3c" %)level(%%) array [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]
++
++SOURCE_AGENCY - coded series-(% style="color:#e74c3c" %)level(%%) array [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifying a minimum of three values
++
++SOURCE_PUB - uncoded string series-(% style="color:#e74c3c" %)level(%%) array [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] with maximum length of 350 characters
++
++OBS_STATUS - coded observation-(% style="color:#e74c3c" %)level(%%) array [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]
++
++Note that a structure specific namespace ns1 is defined using xsi:schemalocation to reference the validation schema location, in this case ECB_EXR_Dataflow.xsd.
++
++##**ECB EXR CA [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]].xsd**##
++
++Structure specific schema for validating the [[dataset>>doc:sdmx:Glossary.Data set.WebHome]].
++
++The schema defines a complex type called DataSetType derived from the [[data set>>doc:sdmx:Glossary.Data set.WebHome]]'s [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] and (% style="color:#e74c3c" %)constraints(%%), in this case those attached to the [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]].
++
++Complex types based on the abstract [[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]:CompType are defined for each complex [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].
++
++##**ECB EXR CA [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]].xml**##
++
++Structure message describing the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] for the above [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] illustrating, in particular, the definition of complex [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
++
++The XML attribute isMultiLingual="true" on the \<str:TextFormat…\> element specifies a multi-lingual string representation.
++
++Setting the maxOccurs XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] to a number greater than 1 (or unbounded) on the \<str:LocalRepresentation…\> element specifies an array.

SUZ.Methodology.Code.MethodologyClass[0]

index

...	...	@@ -1,0 +1,1 @@
	1	+7