Skip to Content

Changes for page Part VI. Samples

Last modified by Elena on 2025/09/10 11:19
From version 6.2
edited by Helena
on 2025/07/03 11:33
Change comment: There is no comment for this version
To version 14.1
edited by Helena
on 2025/07/20 13:34
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Part VI. Samples: This provides a brief explanation of the currently available sample files
1 +Part VI. Samples
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
... ... @@ -14,7 +14,7 @@
14 14  
15 15  = 2 Structure Samples =
16 16  
17 -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.
17 +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.
18 18  
19 19  == Codelist ==
20 20  
... ... @@ -21,7 +21,7 @@
21 21  (% class="wikigeneratedid" id="Hcodelist.xml" %)
22 22  **codelist.xml**
23 23  
24 -A simple enumerated [[code list>>doc:sdmx:Glossary.Code list.WebHome]] directly equivalent to those in (% style="color:#e74c3c" %)version(%%) 2.1 and earlier.
24 +A simple enumerated [[code list>>doc:sdmx:Glossary.Code list.WebHome]] directly equivalent to those in version 2.1 and earlier.
25 25  
26 26  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]].
27 27  
... ... @@ -52,10 +52,10 @@
52 52  
53 53  In the sample:
54 54  
55 -* [[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]].
55 +* [[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:CL_ACTIVITY_NACE2 and SDMX:CL_ACTIVITY_ISIC4 [[codelists>>doc:sdmx:Glossary.Code list.WebHome]].
56 56  * 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]].
57 57  * 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]].
58 -* 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.
58 +* 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 version 3.0.
59 59  
60 60  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_"
61 61  
... ... @@ -64,7 +64,7 @@
64 64  
65 65  A simple enumerated value list.
66 66  
67 -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.
67 +Value lists were introduced in 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.
68 68  
69 69  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.
70 70  
... ... @@ -77,21 +77,21 @@
77 77  
78 78  The example illustrates a single [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] ECB:ECB_CONCEPTS containing multiple individual (% style="color:#e74c3c" %)concepts(%%).
79 79  
80 -== ##Data Structure Definition## ==
80 +== Data Structure Definition ==
81 81  
82 -**##ECB EXR.xml##**
82 +**ECB EXR.xml**
83 83  
84 84  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.
85 85  
86 -== ##Dataflow## ==
86 +== Dataflow ==
87 87  
88 -##**dataflow.xml**##
88 +**dataflow.xml**
89 89  
90 90  A simple [[data flow>>doc:sdmx:Glossary.Dataflow.WebHome]] for the ECB:EXR [[data set>>doc:sdmx:Glossary.Data set.WebHome]].
91 91  
92 -== ##Geospatial## ==
92 +== Geospatial ==
93 93  
94 -**##geospatial geocomponents.xml##**
94 +**geospatial geocomponents.xml**
95 95  
96 96  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.
97 97  
... ... @@ -101,7 +101,7 @@
101 101  * 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.
102 102  * The AREA [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] also carries a LocalRepresentation with textType="GeospatialInformation".
103 103  
104 -**##geospatial geographiccodelist.xml##**
104 +**geospatial geographiccodelist.xml**
105 105  
106 106  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.
107 107  
... ... @@ -112,7 +112,7 @@
112 112  * Three illustrative GeoFeatureSetCodes have been defined with IDs "A1", "A2" and "A3".
113 113  * 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.
114 114  
115 -**##geospatial geogridcodelist.xml##**
115 +**geospatial geogridcodelist.xml**
116 116  
117 117  An example of the definition of GeoGridCodelists, the second specialised form of [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] for modelling gridded geographies.
118 118  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]].
... ... @@ -124,27 +124,27 @@
124 124  * 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.
125 125  * 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.
126 126  
127 -## [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] Transformations##
127 +== VTL Transformations ==
128 128  
129 -##**VTL Sample 1.xml**##
129 +**VTL Sample 1.xml**
130 130  
131 131  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.
132 132  
133 133  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.
134 134  
135 -##**VTL Sample 2.xml**##
135 +**VTL Sample 2.xml**
136 136  
137 137  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.
138 138  
139 139  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]].
140 140  
141 -##**VTL Sample 3.xml**##
141 +**VTL Sample 3.xml**
142 142  
143 143  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.
144 144  
145 145  = 3 Data Samples =
146 146  
147 -[[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.
147 +[[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 version 2.1 and earlier such as Generic, Utility and Cross Sectional are deprecated.
148 148  
149 149  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:
150 150  
... ... @@ -155,7 +155,7 @@
155 155  
156 156  == Aggregated Time Series with Simple Data Attributes ==
157 157  
158 -##**ECB EXR.xml**##
158 +**ECB EXR.xml**
159 159  
160 160  Structure specific data message.
161 161  
... ... @@ -167,33 +167,33 @@
167 167  
168 168  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.
169 169  
170 -**##ECB EXR [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]].xsd##**
170 +**ECB EXR Dataflow.xsd**
171 171  
172 172  Structure-specific schema for validating the [[dataset>>doc:sdmx:Glossary.Data set.WebHome]].
173 173  
174 174  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]].
175 175  
176 -## Aggregated Time Series with Complex Data [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]##
176 +== Aggregated Time Series with Complex Data Attributes ==
177 177  
178 178  Complex [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] include those with multilingual text and arrays of values.
179 179  
180 -**##EXB EXR CA.xml##**
180 +**EXB EXR CA.xml**
181 181  
182 182  Structure specific data message.
183 183  
184 184  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:
185 185  
186 -[[TITLE>>doc:sdmx:Glossary.Title.WebHome]] - multi-lingual series-(% style="color:#e74c3c" %)level(%%) array [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]
186 +[[TITLE>>doc:sdmx:Glossary.Title.WebHome]] - multi-lingual series-level array [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]
187 187  
188 -SOURCE_AGENCY - coded series-(% style="color:#e74c3c" %)level(%%) array [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifying a minimum of three values
188 +SOURCE_AGENCY - coded series-level array [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] specifying a minimum of three values
189 189  
190 -SOURCE_PUB - uncoded string series-(% style="color:#e74c3c" %)level(%%) array [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] with maximum length of 350 characters
190 +SOURCE_PUB - uncoded string series-level array [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] with maximum length of 350 characters
191 191  
192 -OBS_STATUS - coded observation-(% style="color:#e74c3c" %)level(%%) array [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]
192 +OBS_STATUS - coded observation-level array [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]
193 193  
194 194  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.
195 195  
196 -##**ECB EXR CA [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]].xsd**##
196 +**ECB EXR CA Dataflow.xsd**
197 197  
198 198  Structure specific schema for validating the [[dataset>>doc:sdmx:Glossary.Data set.WebHome]].
199 199  
... ... @@ -201,7 +201,7 @@
201 201  
202 202  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]].
203 203  
204 -##**ECB EXR CA [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]].xml**##
204 +**ECB EXR CA DSD.xml**
205 205  
206 206  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]]:
207 207  
SUZ.Methodology.Code.MethodologyClass[0]
index
... ... @@ -1,1 +1,0 @@
1 -7
SKMS.Methodology.Code.MethodologyClass[0]
Index
... ... @@ -1,0 +1,1 @@
1 +7