Skip to Content
Version 14.1 by Helena on 2025/05/22 00:15
Show last authors
1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 **Revision History**
6
7 (% style="width:954.835px" %)
8 |(% style="width:106px" %)**Revision**|(% style="width:124px" %)**Date**|(% style="width:723px" %)**Contents**
9 |(% style="width:106px" %) |(% style="width:124px" %)April 2011|(% style="width:723px" %)Initial release
10 |(% style="width:106px" %)1.0|(% style="width:124px" %)April 2013|(% style="width:723px" %)Added section 9 - Transforming between versions of SDMX
11 |(% style="width:106px" %)2.0|(% style="width:124px" %)July 2020|(% style="width:723px" %)Added section 10 – Validation and Transformation Language – before the Annex 1.
12
13 = 1 Purpose and Structure =
14
15 == 1.1 Purpose ==
16
17 The intention of this document is to document certain aspects of SDMX that are important to understand and will aid implementation decisions. The explanations here supplement the information documented in the SDMX XML schema and the Information Model.
18
19 == 1.2 Structure ==
20
21 This document is organized into the following major parts:
22
23 A guide to the SDMX Information Model relating to Data Structure Definitions and Data Sets, statement of differences in functionality supported by the different formats and syntaxes for Data Structure Definitions and Data Sets, and best practices for use of SDMX formats, including the representation for time period
24
25 A guide to the SDMX Information Model relating to Metadata Structure Definitions, and Metadata Sets
26
27 Other structural artefacts of interest: agencies, concept role. constraint, partial code list
28
29 = 2 General Notes on This Document =
30
31 At this version of the standards, the term “Key family” is replaced by Data Structure Definition (also known and referred to as DSD) both in the XML schemas and the Information Model. The term “Key family” is not familiar to many people and its name was taken from the model of SDMX-EDI (previously known as GESMES/TS). The more familiar name “Data Structure Definition” which was used in many documents is now also the technical artefact in the SDMX-ML and Information Model technical specifications. The term “Key family” is still used in the SDMX-EDI specification.
32
33 There has been much work within the SDMX community on the creation of user guides, tutorials, and other aides to implementation and understanding of the standard. This document is not intended to duplicate the function of these documents, but instead represents a short set of technical notes not generally covered elsewhere.
34
35 = 3 Guide for SDMX Format Standards =
36
37 == 3.1 Introduction ==
38
39 This guide exists to provide information to implementers of the SDMX format standards – SDMX-ML and SDMX-EDI – that are concerned with data, i.e. Data Structure Definitions and Data Sets. This section is intended to provide information which will help users of SDMX understand and implement the standards. It is not normative, and it does not provide any rules for the use of the standards, such as those found in //SDMX-ML: Schema and Documentation// and //SDMX-EDI: Syntax and Documentation//.
40
41 == 3.2 SDMX Information Model for Format Implementers ==
42
43 === 3.2.1 Introduction ===
44
45 The purpose of this sub-section is to provide an introduction to the SDMX-IM relating to Data Structure Definitions and Data Sets for those whose primary interest is in the use of the XML or EDI formats. For those wishing to have a deeper understanding of the Information Model, the full SDMX-IM document, and other sections in this guide provide a more in-depth view, along with UML diagrams and supporting explanation. For those who are unfamiliar with DSDs, an appendix to the SDMX-IM provides a tutorial which may serve as a useful introduction.
46
47 The SDMX-IM is used to describe the basic data and metadata structures used in all of the SDMX data formats. The Information Model concerns itself with statistical data and its structural metadata, and that is what is described here. Both structural metadata and data have some additional metadata in common, related to their management and administration. These aspects of the data model are not addressed in this section and covered elsewhere in this guide or in the full SDMX-IM document.
48
49 The Data Structure Definition and Data Set parts of the information model are consistent with the GESMES/TS version 3.0 Data Model (called SDMX-EDI in the SDMX standard), with these exceptions:
50
51 * the “sibling group” construct has been generalized to permit any dimension or dimensions to be wildcarded, and not just frequency, as in GESMES/TS. It has been renamed a “group” to distinguish it from the “sibling group” where only frequency is wildcarded. The set of allowable partial “group” keys must be declared in the DSD, and attributes may be attached to any of these group keys;
52 * furthermore, whilst the “group” has been retained for compatibility with version 2.0 and with SDMX-EDI, it has, at version 2.1, been replaced by the “Attribute Relationship” definition which is explained later
53 * the section on data representation is now a convention, to support interoperability with EDIFACT-syntax implementations ( see section 3.3.2);
54
55 DSD-specific data formats are derived from the model, and some supporting features for declaring multiple measures have been added to the structural metadata descriptions Clearly, this is not a coincidence. The GESMES/TS Data Model provides the foundation for the EDIFACT messages in SDMX-EDI, and also is the starting point for the development of SDMX-ML.
56
57 Note that in the descriptions below, text in courier and italicised are the names used in the information model (e.g. //DataSet//).
58
59 == 3.3 SDMX-ML and SDMX-EDI: Comparison of Expressive Capabilities and Function ==
60
61 SDMX offers several equivalent formats for describing data and structural metadata, optimized for use in different applications. Although all of these formats are derived directly from the SDM-IM, and are thus equivalent, the syntaxes used to express the model place some restrictions on their use. Also, different optimizations provide different capabilities. This section describes these differences, and provides some rules for applications which may need to support more than one SDMX format or syntax. This section is constrained to the Data Structure Definitionand the Date Set.
62
63 === 3.3.1 Format Optimizations and Differences ===
64
65 The following section provides a brief overview of the differences between the various SDMX formats.
66
67 Version 2.0 was characterised by 4 data messages, each with a distinct format: Generic, Compact, Cross-Sectional and Utility. Because of the design, data in some formats could not always be related to another format. In version 2.1, this issue has been addressed by merging some formats and eliminating others. As a result, in SDMX 2.1 there are just two types of data formats: //GenericData// and //StructureSpecificData// (i.e. specific to one Data Structure Definition).
68
69 Both of these formats are now flexible enough to allow for data to be oriented in series with any dimension used to disambiguate the observations (as opposed to only time or a cross sectional measure in version 2.0). The formats have also been expanded to allow for ungrouped observations.
70
71 To allow for applications which only understand time series data, variations of these formats have been introduced in the form of two data messages; //GenericTimeSeriesData// and //StructureSpecificTimeSeriesData//. It is important to note that these variations are built on the same root structure and can be processed in the same manner as the base format so that they do NOT introduce additional processing requirements.
72
73 **//Structure Definition//**
74
75 The SDMX-ML Structure Message supports the use of annotations to the structure, which is not supported by the SDMX-EDI syntax.
76
77 The SDMX-ML Structure Message allows for the structures on which a Data Structure Definition depends – that is, codelists and concepts – to be either included in the message or to be referenced by the message containing the data structure definition. XML syntax is designed to leverage URIs and other Internet-based referencing mechanisms, and these are used in the SDMX-ML message. This option is not available to those using the SDMX-EDI structure message.
78
79 **//Validation//**
80
81 SDMX-EDI – as is typical of EDIFACT syntax messages – leaves validation to dedicated applications (“validation” being the checking of syntax, data typing, and adherence of the data message to the structure as described in the structural definition.)
82
83 The SDMX-ML Generic Data Message also leaves validation above the XML syntax level to the application.
84
85 The SDMX-ML DSD-specific messages will allow validation of XML syntax and datatyping to be performed with a generic XML parser, and enforce agreement between the structural definition and the data to a moderate degree with the same tool.
86
87 //Update and Delete Messages and Documentation Messages//
88
89 All SDMX data messages allow for both delete messages and messages consisting of only data or only documentation.
90
91 **//Character Encodings//**
92
93 All SDMX-ML messages use the UTF-8 encoding, while SDMX-EDI uses the ISO 8879-1 character encoding. There is a greater capacity with UTF-8 to express some character sets (see the “APPENDIX: MAP OF ISO 8859-1 (UNOC) CHARACTER SET (LATIN 1 OR “WESTERN”) in the document “SYNTAX AND DOCUMENTATION VERSION 2.0”.) Many transformation tools are available which allow XML instances with UTF-8 encodings to be expressed as ISO 8879-1-encoded characters, and to transform UTF-8 into ISO 8879-1. Such tools should be used when transforming SDMX-ML messages into SDMX-EDI messages and vice-versa.
94
95 **//Data Typing//**
96
97 The XML syntax and EDIFACT syntax have different data-typing mechanisms. The section below provides a set of conventions to be observed when support for messages in both syntaxes is required. For more information on the SDMX-ML representations of data, see below.
98
99 === 3.3.2 Data Types ===
100
101 The XML syntax has a very different mechanism for data-typing than the EDIFACT syntax, and this difference may create some difficulties for applications which support both EDIFACT-based and XML-based SDMX data formats. This section provides a set of conventions for the expression in data in all formats, to allow for clean interoperability between them.
102
103 It should be noted that this section does not address character encodings – it is assumed that conversion software will include the use of transformations which will map between the ISO 8879-1 encoding of the SDMX-EDI format and the UTF-8 encoding of the SDMX-ML formats.
104
105 Note that the following conventions may be followed for ease of interoperation between EDIFACT and XML representations of the data and metadata. For implementations in which no transformation between EDIFACT and XML syntaxes is foreseen, the restrictions below need not apply.
106
107 1. **Identifiers** are:
108 1*. Maximum 18 characters;
109 1*. Any of A..Z (upper case alphabetic), 0..9 (numeric), _ (underscore);
110 1*. The first character is alphabetic.
111 1. **Names** are:
112 1*. Maximum 70 characters.
113 1*. From ISO 8859-1 character set (including accented characters)
114 1. **Descriptions **are:
115 1*. Maximum 350 characters;
116 1*. From ISO 8859-1 character set.
117 1. **Code values** are:
118 1*. Maximum 18 characters;
119 1*. Any of A..Z (upper case alphabetic), 0..9 (numeric), _ (underscore), / (solidus, slash), = (equal sign), - (hyphen);
120
121 However, code values providing values to a dimension must use only the following characters:
122
123 A..Z (upper case alphabetic), 0..9 (numeric), _ (underscore)
124
125 **5. Observation values** are:
126
127 * Decimal numerics (signed only if they are negative);
128 * The maximum number of significant figures is:
129 * 15 for a positive number
130 * 14 for a positive decimal or a negative integer
131 * 13 for a negative decimal
132 * Scientific notation may be used.
133
134 **6. Uncoded statistical concept** text values are:
135
136 * Maximum 1050 characters;
137 * From ISO 8859-1 character set.
138
139 **7. Time series keys**:
140
141 In principle, the maximum permissible length of time series keys used in a data exchange does not need to be restricted. However, for working purposes, an effort is made to limit the maximum length to 35 characters; in this length, also (for SDMXEDI) one (separator) position is included between all successive dimension values; this means that the maximum length allowed for a pure series key (concatenation of dimension values) can be less than 35 characters. The separator character is a colon (“:”) by conventional usage.
142
143 == 3.4 SDMX-ML and SDMX-EDI Best Practices ==
144
145 === 3.4.1 Reporting and Dissemination Guidelines ===
146
147 ==== 3.4.1.1 Central Institutions and Their Role in Statistical Data Exchanges ====
148
149 Central institutions are the organisations to which other partner institutions "report" statistics. These statistics are used by central institutions either to compile aggregates and/or they are put together and made available in a uniform manner (e.g. on-line or on a CD-ROM or through file transfers). Therefore, central institutions receive data from other institutions and, usually, they also "disseminate" data to individual and/or institutions for end-use. Within a country, a NSI or a national central bank (NCB) plays, of course, a central institution role as it collects data from other entities and it disseminates statistical information to end users. In SDMX the role of central institution is very important: every statistical message is based on underlying structural definitions (statistical concepts, code lists, DSDs) which have been devised by a particular agency, usually a central institution. Such an institution plays the role of the reference "structural definitions maintenance agency" for the corresponding messages which are exchanged. Of course, two institutions could exchange data using/referring to structural information devised by a third institution.
150
151 Central institutions can play a double role:
152
153 * collecting and further disseminating statistics;
154 * devising structural definitions for use in data exchanges.
155
156 ==== 3.4.1.2 Defining Data Structure Definitions (DSDs) ====
157
158 The following guidelines are suggested for building a DSD. However, it is expected that these guidelines will be considered by central institutions when devising new DSDs.
159
160 (% class="wikigeneratedid" id="HDimensions2CAttributesandCodeLists" %)
161 __Dimensions, Attributes and Code Lists__
162
163 **//Avoid dimensions that are not appropriate for all the series in the data structure definition.//** If some dimensions are not applicable (this is evident from the need to have a code in a code list which is marked as “not applicable”, “not relevant” or “total”) for some series then consider moving these series to a new data structure definition in which these dimensions are dropped from the key structure. This is a judgement call as it is sometimes difficult to achieve this without increasing considerably the number of DSDs.
164
165 **//Devise DSDs with a small number of Dimensions for public viewing of data.//** A DSD with the number dimensions in excess 6 or 7 is often difficult for non specialist users to understand. In these cases it is better to have a larger number of DSDs with smaller “cubes” of data, or to eliminate dimensions and aggregate the data at a higher level. Dissemination of data on the web is a growing use case for the SDMX standards: the differentiation of observations by dimensionality which are necessary for statisticians and economists are often obscure to public consumers who may not always understand the semantic of the differentiation.
166
167 **//Avoid composite dimensions.//** Each dimension should correspond to a single characteristic of the data, not to a combination of characteristics.
168
169 **//Consider the inclusion of the following attributes//**. Once the key structure of a data structure definition has been decided, then the set of (preferably mandatory) attributes of this data structure definition has to be defined. In general, some statistical concepts are deemed necessary across all Data Structure Definitions to qualify the contained information. Examples of these are:
170
171 * A descriptive title for the series (this is most useful for dissemination of data for viewing e.g. on the web)
172 * Collection (e.g. end of period, averaged or summed over period)
173 * Unit (e.g. currency of denomination)
174 * Unit multiplier (e.g. expressed in millions)
175 * Availability (which institutions can a series become available to)
176 * Decimals (i.e. number of decimal digits used in numerical observations)
177 * Observation Status (e.g. estimate, provisional, normal)
178
179 Moreover, additional attributes may be considered as mandatory when a specific data structure definition is defined.
180
181 **//Avoid creating a new code list where one already exists.//** It is highly recommended that structural definitions and code lists be consistent with internationally agreed standard methodologies, wherever they exist, e.g., System of National Accounts 1993; Balance of Payments Manual, Fifth Edition; Monetary and Financial Statistics Manual; Government Finance Statistics Manual, etc. When setting-up a new data exchange, the following order of priority is suggested when considering the use of code lists:
182
183 * international standard code lists;
184 * international code lists supplemented by other international and/or regional institutions;
185 * standardised lists used already by international institutions;
186 * new code lists agreed between two international or regional institutions;
187 * new specific code lists.
188
189 The same code list can be used for several statistical concepts, within a data structure definition or across DSDs. Note that SDMX has recognised that these classifications are often quite large and the usage of codes in any one DSD is only a small extract of the full code list. In this version of the standard it is possible to exchange and disseminate a **partial code list** which is extracted from the full code list and which supports the dimension values valid for a particular DSD.
190
191 __Data Structure Definition Structure__
192
193 The following items have to be specified by a structural definitions maintenance agency when defining a new data structure definition:
194
195 Data structure definition (DSD) identification:
196
197 * DSD identifier
198 * DSD name
199
200 A list of metadata concepts assigned as dimensions of the data structure definition. For each:
201
202 * (statistical) concept identifier
203 * ordinal number of the dimension in the key structure (SDMX-EDI only)
204 * code list identifier (Id, version, maintenance agency) if the representation is coded
205
206 A list of (statistical) concepts assigned as attributes for the data structure definition. For each:
207
208 * (statistical) concept identifier
209 * code list identifier if the concept is coded
210 * assignment status: mandatory or conditional
211 * attachment level
212 * maximum text length for the uncoded concepts
213 * maximum code length for the coded concepts
214
215 A list of the code lists used in the data structure definition. For each:
216
217 * code list identifier
218 * code list name
219 * code values and descriptions
220
221 Definition of data flow definitions. Two (or more) partners performing data exchanges in a certain context need to agree on:
222
223 * the list of data set identifiers they will be using;
224 * for each data flow:
225 * its content and description
226 * the relevant DSD that defines the structure of the data reported or disseminated according the the dataflow definition
227
228 ==== 3.4.1.3 Exchanging Attributes ====
229
230 ===== //3.4.1.3.1 Attributes on series, sibling and data set level // =====
231
232 //Static properties//.
233
234 * Upon creation of a series the sender has to provide to the receiver values for all mandatory attributes. In case they are available, values for conditional attributes should also be provided. Whereas initially this information may be provided by means other than SDMX-ML or SDMX-EDI messages (e.g. paper, telephone) it is expected that partner institutions will be in a position to provide this information in SDMX-ML or SDMX-EDI format over time.
235 * A centre may agree with its data exchange partners special procedures for authorising the setting of attributes' initial values.
236 * Attribute values at a data set level are set and maintained exclusively by the centre administrating the exchanged data set.
237
238 //Communication of changes// to the centre.
239
240 * Following the creation of a series, the attribute values do not have to be reported again by senders, as long as they do not change.
241 * Whenever changes in attribute values for a series (or sibling group) occur, the reporting institutions should report either all attribute values again (this is the recommended option) or only the attribute values which have changed. This applies both to the mandatory and the conditional attributes. For example, if a previously reported value for a conditional attribute is no longer valid, this has to be reported to the centre.
242 * A centre may agree with its data exchange partners special procedures for authorising modifications in the attribute values.
243
244 Communication of observation level attributes “observation status”, "observation confidentiality", "observation pre-break".
245
246 * In SDMX-EDI, the observation level attribute “observation status” is part of the fixed syntax of the ARR segment used for observation reporting. Whenever an observation is exchanged, the corresponding observation status must also be exchanged attached to the observation, regardless of whether it has changed or not since the previous data exchange. This rule also applies to the use of the SDMX-ML formats, although the syntax does not necessarily require this.
247 * If the “observation status” changes and the observation remains unchanged, both components would have to be reported.
248 * For Data Structure Definitions having also the observation level attributes “observation confidentiality” and "observation pre-break" defined, this rule applies to these attribute as well: if an institution receives from another institution an observation with an observation status attribute only attached, this means that the associated observation confidentiality and prebreak observation attributes either never existed or from now they do not have a value for this observation.
249
250 === 3.4.2 Best Practices for Batch Data Exchange ===
251
252 ==== 3.4.2.1 Introduction ====
253
254 Batch data exchange is the exchange and maintenance of entire databases between counterparties. It is an activity that often employs SDMX-EDI formats, and might also use the SDMX-ML DSD-specific data set. The following points apply equally to both formats.
255
256 ==== 3.4.2.2 Positioning of the Dimension "Frequency" ====
257
258 The position of the “frequency” dimension is unambiguously identified in the data structure definition. Moreover, most central institutions devising structural definitions have decided to assign to this dimension the first position in the key structure. This facilitates the easy identification of this dimension, something that it is necessary to frequency's crucial role in several database systems and in attaching attributes at the “sibling” group level.
259
260 ==== 3.4.2.3 Identification of Data Structure Definitions (DSDs) ====
261
262 In order to facilitate the easy and immediate recognition of the structural definition maintenance agency that defined a data structure definition, most central institutions devising structural definitions use the first characters of the data structure definition identifiers to identify their institution: e.g. BIS_EER, EUROSTAT_BOP_01, ECB_BOP1, etc.
263
264 ==== 3.4.2.4 Identification of the Data Flows ====
265
266 In order to facilitate the easy and immediate recognition of the institution administrating a data flow definitions, many central institutions prefer to use the first characters of the data flow definition identifiers to identify their institution: e.g. BIS_EER, ECB_BOP1, ECB_BOP1, etc. Note that in GESMES/TS the Data Set plays the role of the data flow definition (see //DataSet //in the SDMX-IM//)//.
267
268 The statistical information in SDMX is broken down into two fundamental parts - structural metadata (comprising the Data Structure Definition, and associated Concepts and Code Lists) - see Framework for Standards -, and observational data (the DataSet). This is an important distinction, with specific terminology associated with each part. Data - which is typically a set of numeric observations at specific points in time - is organized into data sets (//DataSet//) These data sets are structured according to a specific Data Structure Definition (//DataStructureDefinition//) and are described in the data flow definition (//DataflowDefinition)// The Data Structure Definition describes the metadata that allows an understanding of what is expressed in the data set, whilst the data flow definition provides the identifier and other important information (such as the periodicity of reporting) that is common to all of its component data sets.
269
270 Note that the role of the Data Flow (called //DataflowDefintion// in the model) and Data Set is very specific in the model, and the terminology used may not be the same as used in all organisations, and specifically the term Data Set is used differently in SDMX than in GESMES/TS. Essentially the GESMES/TS term "Data Set" is, in SDMX, the "Dataflow Definition" whist the term "Data Set" in SDMX is used to describe the "container" for an instance of the data.
271
272 ==== 3.4.2.5 Special Issues ====
273
274 ===== 3.4.2.5.1 "Frequency" related issues =====
275
276 **//Special frequencies.//** The issue of data collected at special (regular or irregular) intervals at a lower than daily frequency (e.g. 24 or 36 or 48 observations per year, on irregular days during the year) is not extensively discussed here. However, for data exchange purposes:
277
278 * such data can be mapped into a series with daily frequency; this daily series will only hold observations for those days on which the measured event takes place;
279 * if the collection intervals are regular, additional values to the existing frequency code list(s) could be added in the future.
280
281 **//Tick data.//** The issue of data collected at irregular intervals at a higher than daily frequency (e.g. tick-by-tick data) is not discussed here either. However, for data exchange purposes, such series can already be exchanged in the SDMX-EDI format by using the option to send observations with the associated time stamp.
282
283 = 4 General Notes for Implementers =
284
285 This section discusses a number of topics other than the exchange of data sets in SDMX-ML and SDMX-EDI. Supported only in SDMX-ML, these topics include the use of the reference metadata mechanism in SDMX, the use of Structure Sets and Reporting Taxonomies, the use of Processes, a discussion of time and data-typing, and some of the conventional mechanisms within the SDMX-ML Structure message regarding versioning and external referencing.
286
287 This section does not go into great detail on these topics, but provides a useful overview of these features to assist implementors in further use of the parts of the specification which are relevant to them.
288
289 == 4.1 Representations ==
290
291 There are several different representations in SDMX-ML, taken from XML Schemas and common programming languages. The table below describes the various representations which are found in SDMX-ML, and their equivalents.
292
293 (% style="width:912.294px" %)
294 |(% style="width:172px" %)**SDMX-ML Data Type**|(% style="width:204px" %)**XML Schema Data Type**|(% style="width:189px" %)**.NET Framework Type**|(% style="width:342px" %)(((
295 **Java Data Type **
296 )))
297 |(% style="width:172px" %)String|(% style="width:204px" %)xsd:string|(% style="width:189px" %)System.String|(% style="width:342px" %)java.lang.String
298 |(% style="width:172px" %)Big Integer|(% style="width:204px" %)xsd:integer|(% style="width:189px" %)System.Decimal|(% style="width:342px" %)java.math.BigInteg er
299 |(% style="width:172px" %)Integer|(% style="width:204px" %)xsd:int|(% style="width:189px" %)System.Int32|(% style="width:342px" %)int
300 |(% style="width:172px" %)Long|(% style="width:204px" %)xsd.long|(% style="width:189px" %)System.Int64|(% style="width:342px" %)long
301 |(% style="width:172px" %)Short|(% style="width:204px" %)xsd:short|(% style="width:189px" %)System.Int16|(% style="width:342px" %)short
302 |(% style="width:172px" %)Decimal|(% style="width:204px" %)xsd:decimal|(% style="width:189px" %)System.Decimal|(% style="width:342px" %)java.math.BigDecim al
303 |(% style="width:172px" %)Float|(% style="width:204px" %)xsd:float|(% style="width:189px" %)System.Single|(% style="width:342px" %)float
304 |(% style="width:172px" %)Double|(% style="width:204px" %)xsd:double|(% style="width:189px" %)System.Double|(% style="width:342px" %)double
305 |(% style="width:172px" %)Boolean|(% style="width:204px" %)xsd:boolean|(% style="width:189px" %)System.Boolean|(% style="width:342px" %)boolean
306 |(% style="width:172px" %)URI|(% style="width:204px" %)xsd:anyURI|(% style="width:189px" %)System.Uri|(% style="width:342px" %)Java.net.URI or java.lang.String
307 |(% style="width:172px" %)DateTime|(% style="width:204px" %)xsd:dateTime|(% style="width:189px" %)System.DateTime|(% style="width:342px" %)javax.xml.datatype .XMLGregorianCalen dar
308 |(% style="width:172px" %)Time|(% style="width:204px" %)xsd:time|(% style="width:189px" %)System.DateTime|(% style="width:342px" %)javax.xml.datatype .XMLGregorianCalen dar
309 |(% style="width:172px" %)GregorianYear|(% style="width:204px" %)xsd:gYear|(% style="width:189px" %)System.DateTime|(% style="width:342px" %)javax.xml.datatype .XMLGregorianCalen dar
310 |(% style="width:172px" %)GregorianMonth|(% style="width:204px" %)xsd:gYearMonth|(% style="width:189px" %)System.DateTime|(% style="width:342px" %)javax.xml.datatype .XMLGregorianCalen dar
311 |(% style="width:172px" %)GregorianDay|(% style="width:204px" %)xsd:date|(% style="width:189px" %)System.DateTime|(% style="width:342px" %)javax.xml.datatype .XMLGregorianCalen dar
312 |(% style="width:172px" %)(((
313 Day, MonthDay, Month
314 )))|(% style="width:204px" %)xsd:g*|(% style="width:189px" %)System.DateTime|(% style="width:342px" %)javax.xml.datatype .XMLGregorianCalen dar
315 |(% style="width:172px" %)Duration|(% style="width:204px" %)xsd:duration |(% style="width:189px" %)System.TimeSpa|(% style="width:342px" %)javax.xml.datatype
316 |(% style="width:172px" %) |(% style="width:204px" %) |(% style="width:189px" %)n|(% style="width:342px" %).Duration
317
318 There are also a number of SDMX-ML data types which do not have these direct correspondences, often because they are composite representations or restrictions of a broader data type. For most of these, there are simple types which can be referenced from the SDMX schemas, for others a derived simple type will be necessary:
319
320 * AlphaNumeric (common:AlphaNumericType, string which only allows A-z and 0-9)
321 * Alpha (common:AlphaType, string which only allows A-z)
322 * Numeric (common:NumericType, string which only allows 0-9, but is not numeric so that is can having leading zeros)
323 * Count (xs:integer, a sequence with an interval of “1”)
324 * InclusiveValueRange (xs:decimal with the minValue and maxValue facets supplying the bounds)
325 * ExclusiveValueRange (xs:decimal with the minValue and maxValue facets supplying the bounds)
326 * Incremental (xs:decimal with a specified interval; the interval is typically enforced outside of the XML validation)
327 * TimeRange (common:TimeRangeType, start DateTime + Duration,)
328 * ObservationalTimePeriod (common: ObservationalTimePeriodType, a union of StandardTimePeriod and TimeRange).
329 * StandardTimePeriod (common: StandardTimePeriodType, a union of BasicTimePeriod and TimeRange).
330 * BasicTimePeriod (common: BasicTimePeriodType, a union of GregorianTimePeriod and DateTime)
331 * GregorianTimePeriod (common:GregorianTimePeriodType, a union of GregorianYear, GregorianMonth, and GregorianDay)
332 * ReportingTimePeriod (common:ReportingTimePeriodType, a union of ReportingYear, ReportingSemester, ReportingTrimester, ReportingQuarter, ReportingMonth, ReportingWeek, and ReportingDay).  ReportingYear (common:ReportingYearType)
333 * ReportingSemester (common:ReportingSemesterType)
334 * ReportingTrimester (common:ReportingTrimesterType)
335 * ReportingQuarter (common:ReportingQuarterType)
336 * ReportingMonth (common:ReportingMonthType)
337 * ReportingWeek (common:ReportingWeekType)
338 * ReportingDay (common:ReportingDayType)
339 * XHTML (common:StructuredText, allows for multi-lingual text content that has XHTML markup)
340 * KeyValues (common:DataKeyType)
341 * IdentifiableReference (types for each identifiable object)
342 * DataSetReference (common:DataSetReferenceType)
343 * AttachmentConstraintReference (common:AttachmentConstraintReferenceType)
344
345 Data types also have a set of facets:
346
347 * isSequence = true | false (indicates a sequentially increasing value)
348 * minLength = positive integer (# of characters/digits)
349 * maxLength = positive integer (# of characters/digits)
350 * startValue = decimal (for numeric sequence)
351 * endValue = decimal (for numeric sequence)
352 * interval = decimal (for numeric sequence)
353 * timeInterval = duration
354 * startTime = BasicTimePeriod (for time range)
355 * endTime = BasicTimePeriod (for time range)
356 * minValue = decimal (for numeric range)
357 * maxValue = decimal (for numeric range)
358 * decimal = Integer (# of digits to right of decimal point)
359 * pattern = (a regular expression, as per W3C XML Schema)
360 * isMultiLingual = boolean (for specifying text can occur in more than one language)
361
362 Note that code lists may also have textual representations assigned to them, in addition to their enumeration of codes.s
363
364 == 4.2 Time and Time Format ==
365
366 === 4.2.1 Introduction ===
367
368 First, it is important to recognize that most observation times are a period. SDMX specifies precisely how Time is handled.
369
370 The representation of time is broken into a hierarchical collection of representations. A data structure definition can use of any of the representations in the hierarchy as the representation of time. This allows for the time dimension of a particular data structure definition allow for only a subset of the default representation.
371
372 The hierarchy of time formats is as follows (**bold** indicates a category which is made up of multiple formats, //italic// indicates a distinct format):
373
374 * **Observational Time Period**
375 ** **Standard Time Period**
376 *** **Basic Time Period**
377 **** **Gregorian Time Period**
378 **** //Date Time//
379 *** **Reporting Time Period**
380 ** //Time Range//
381
382 The details of these time period categories and of the distinct formats which make them up are detailed in the sections to follow.
383
384 === 4.2.2 Observational Time Period ===
385
386 This is the superset of all time representations in SDMX. This allows for time to be expressed as any of the allowable formats.
387
388 === 4.2.3 Standard Time Period ===
389
390 This is the superset of any predefined time period or a distinct point in time. A time period consists of a distinct start and end point. If the start and end of a period are expressed as date instead of a complete date time, then it is implied that the start of the period is the beginning of the start day (i.e. 00:00:00) and the end of the period is the end of the end day (i.e. 23:59:59).
391
392 === 4.2.4 Gregorian Time Period ===
393
394 A Gregorian time period is always represented by a Gregorian year, year-month, or day. These are all based on ISO 8601 dates. The representation in SDMX-ML messages and the period covered by each of the Gregorian time periods are as follows:
395
396 **Gregorian Year:**
397 Representation: xs:gYear (YYYY)
398 Period: the start of January 1 to the end of December 31
399
400 **Gregorian Year Month**:
401 Representation: xs:gYearMonth (YYYY-MM)
402 Period: the start of the first day of the month to end of the last day of the month
403
404 **Gregorian Day**:
405 Representation: xs:date (YYYY-MM-DD)
406 Period: the start of the day (00:00:00) to the end of the day (23:59:59)
407
408 === 4.2.5 Date Time ===
409
410 This is used to unambiguously state that a date-time represents an observation at a single point in time. Therefore, if one wants to use SDMX for data which is measured at a distinct point in time rather than being reported over a period, the date-time representation can be used.
411
412 Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss)[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[1~]^^>>path:#_ftn1]]
413
414 === 4.2.6 Standard Reporting Period ===
415
416 Standard reporting periods are periods of time in relation to a reporting year. Each of these standard reporting periods has a duration (based on the ISO 8601 definition) associated with it. The general format of a reporting period is as follows:
417
418 [REPORTING_YEAR]-[PERIOD_INDICATOR][PERIOD_VALUE]
419
420 Where:
421 REPORTING_YEAR represents the reporting year as four digits (YYYY) PERIOD_INDICATOR identifies the type of period which determines the duration of the period
422 PERIOD_VALUE indicates the actual period within the year
423
424 The following section details each of the standard reporting periods defined in SDMX:
425
426 **Reporting Year**:
427 Period Indicator: A
428 Period Duration: P1Y (one year)
429 Limit per year: 1
430 Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1)
431
432 **Reporting Semester:**
433 Period Indicator: S
434 Period Duration: P6M (six months)
435 Limit per year: 2
436 Representation: common:ReportingSemesterType (YYYY-Ss, e.g. 2000-S2)
437
438 **Reporting Trimester:**
439 Period Indicator: T
440 Period Duration: P4M (four months)
441 Limit per year: 3
442 Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3)
443
444 **Reporting Quarter:**
445 Period Indicator: Q
446 Period Duration: P3M (three months)
447 Limit per year: 4
448 Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4)
449
450 **Reporting Month**:
451 Period Indicator: M
452 Period Duration: P1M (one month)
453 Limit per year: 1
454 Representation: common:ReportingMonthType (YYYY-Mmm, e.g. 2000-M12) Notes: The reporting month is always represented as two digits, therefore 1-9 are 0 padded (e.g. 01). This allows the values to be sorted chronologically using textual sorting methods.
455
456 **Reporting Week**:
457 Period Indicator: W
458 Period Duration: P7D (seven days)
459 Limit per year: 53
460 Representation: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53)
461 Notes: There are either 52 or 53 weeks in a reporting year. This is based on the ISO 8601 definition of a week (Monday - Saturday), where the first week of a reporting year is defined as the week with the first Thursday on or after the reporting year start day.[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[2~]^^>>path:#_ftn2]](%%) The reporting week is always represented as two digits, therefore 1-9 are 0 padded (e.g. 01). This allows the values to be sorted chronologically using textual sorting methods.
462
463 **Reporting Day**:
464 Period Indicator: D
465 Period Duration: P1D (one day)
466 Limit per year: 366
467 Representation: common:ReportingDayType (YYYY-Dddd, e.g. 2000-D366) Notes: There are either 365 or 366 days in a reporting year, depending on whether the reporting year includes leap day (February 29). The reporting day is always represented as three digits, therefore 1-99 are 0 padded (e.g. 001).
468
469 This allows the values to be sorted chronologically using textual sorting methods.
470
471 The meaning of a reporting year is always based on the start day of the year and requires that the reporting year is expressed as the year at the start of the period. This start day is always the same for a reporting year, and is expressed as a day and a month (e.g. July 1). Therefore, the reporting year 2000 with a start day of July 1 begins on July 1, 2000.
472
473 A specialized attribute (reporting year start day) exists for the purpose of communicating the reporting year start day. This attribute has a fixed identifier (REPORTING_YEAR_START_DAY) and a fixed representation (xs:gMonthDay) so that it can always be easily identified and processed in a data message. Although this attribute exists in specialized sub-class, it functions the same as any other attribute outside of its identification and representation. It must takes its identity from a concept and state its relationship with other components of the data structure definition. The ability to state this relationship allows this reporting year start day attribute to exist at the appropriate levels of a data message. In the absence of this attribute, the reporting year start date is assumed to be January 1; therefore if the reporting year coincides with the calendar year, this Attribute is not necessary.
474
475 Since the duration and the reporting year start day are known for any reporting period, it is possible to relate any reporting period to a distinct calendar period. The actual Gregorian calendar period covered by the reporting period can be computed as follows (based on the standard format of [REPROTING_YEAR][PERIOD_INDICATOR][PERIOD_VALUE] and the reporting year start day as [REPORTING_YEAR_START_DAY]):
476
477 **~1. Determine [REPORTING_YEAR_BASE]:**
478 Combine [REPORTING_YEAR] of the reporting period value (YYYY) with [REPORTING_YEAR_START_DAY] (MM-DD) to get a date (YYYY-MM-DD).
479 This is the [REPORTING_YEAR_START_DATE]
480 **a) If the [PERIOD_INDICATOR] is W:
481 ~1. If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday:**
482 Add^^3^^ (P3D, P2D, or P1D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE].
483
484 2. **If [REPORTING_YEAR_START_DATE] is a Monday, Tuesday, Wednesday, or Thursday:**
485 Add^^3^^ (P0D, -P1D, -P2D, or -P3D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE].
486 b) **Else:** 
487 The [REPORTING_YEAR_START_DATE] is the [REPORTING_YEAR_BASE]
488
489 **2. Determine [PERIOD_DURATION]:**
490
491 a) If the [PERIOD_INDICATOR] is A, the [PERIOD_DURATION] is P1Y.
492 b) If the [PERIOD_INDICATOR] is S, the [PERIOD_DURATION] is P6M.
493 c) If the [PERIOD_INDICATOR] is T, the [PERIOD_DURATION] is P4M.
494 d) If the [PERIOD_INDICATOR] is Q, the [PERIOD_DURATION] is P3M.
495 e) If the [PERIOD_INDICATOR] is M, the [PERIOD_DURATION] is P1M.
496 f) If the [PERIOD_INDICATOR] is W, the [PERIOD_DURATION] is P7D.
497 g) If the [PERIOD_INDICATOR] is D, the [PERIOD_DURATION] is P1D.
498
499 **3. Determine [PERIOD_START]:**
500 Subtract one from the [PERIOD_VALUE] and multiply this by the [PERIOD_DURATION]. Add[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[3~]^^>>path:#_ftn3]](%%) this to the [REPORTING_YEAR_BASE]. The result is the [PERIOD_START].
501
502 **4. Determine the [PERIOD_END]:**
503 Multiply the [PERIOD_VALUE] by the [PERIOD_DURATION]. Add^^3^^ this to the [REPORTING_YEAR_BASE] add^^3^^ -P1D. The result is the [PERIOD_END].
504
505 For all of these ranges, the bounds include the beginning of the [PERIOD_START] (i.e. 00:00:00) and the end of the [PERIOD_END] (i.e. 23:59:59).
506
507 **Examples:**
508
509 **2010-Q2, REPORTING_YEAR_START_DAY = ~-~-07-01 (July 1)**
510 ~1. [REPORTING_YEAR_START_DATE] = 2010-07-01
511 b) [REPORTING_YEAR_BASE] = 2010-07-01
512 [PERIOD_DURATION] = P3M
513 (2-1) * P3M = P3M
514 2010-07-01 + P3M = 2010-10-01
515 [PERIOD_START] = 2010-10-01
516 4. 2 * P3M = P6M
517 2010-07-01 + P6M = 2010-13-01 = 2011-01-01
518 2011-01-01 + -P1D = 2010-12-31
519 [PERIOD_END] = 2011-12-31
520
521 The actual calendar range covered by 2010-Q2 (assuming the reporting year begins July 1) is 2010-10-01T00:00:00/2010-12-31T23:59:59
522
523 **2011-W36, REPORTING_YEAR_START_DAY = ~-~-07-01 (July 1)**
524 ~1. [REPORTING_YEAR_START_DATE] = 2010-07-01
525 a) 2011-07-01 = Friday
526 2011-07-01 + P3D = 2011-07-04
527 [REPORTING_YEAR_BASE] = 2011-07-04
528 2. [PERIOD_DURATION] = P7D
529 3. (36-1) * P7D = P245D
530 2011-07-04 + P245D = 2012-03-05
531 [PERIOD_START] = 2012-03-05
532 4. 36 * P7D = P252D
533 2011-07-04 + P252D =2012-03-12
534 2012-03-12 + -P1D = 2012-03-11
535 [PERIOD_END] = 2012-03-11
536
537 The actual calendar range covered by 2011-W36 (assuming the reporting year begins July 1) is 2012-03-05T00:00:00/2012-03-11T23:59:59
538
539 === 4.2.7 Distinct Range ===
540
541 In the case that the reporting period does not fit into one of the prescribe periods above, a distinct time range can be used. The value of these ranges is based on the ISO 8601 time interval format of start/duration. Start can be expressed as either an ISO 8601 date or a date-time, and duration is expressed as an ISO 8601 duration. However, the duration can only be postive.
542
543 === 4.2.8 Time Format ===
544
545 In version 2.0 of SDMX there is a recommendation to use the time format attribute to gives additional information on the way time is represented in the message. Following an appraisal of its usefulness this is no longer required. However, it is still possible, if required , to include the time format attribute in SDMX-ML.
546
547 (% style="width:716.835px" %)
548 |(% style="width:197px" %)**Code**|(% style="width:517px" %)**Format**
549 |(% style="width:197px" %)**OTP**|(% style="width:517px" %)Observational Time Period: Superset of all SDMX time formats (Gregorian Time Period, Reporting Time Period, and Time Range)
550 |(% style="width:197px" %)**STP**|(% style="width:517px" %)Standard Time Period: Superset of Gregorian and Reporting Time Periods
551 |(% style="width:197px" %)**GTP**|(% style="width:517px" %)Superset of all Gregorian Time Periods and date-time
552 |(% style="width:197px" %)**RTP**|(% style="width:517px" %)Superset of all Reporting Time Periods
553 |(% style="width:197px" %)**TR**|(% style="width:517px" %)Time Range: Start time and duration (YYYY-MMDD(Thh:mm:ss)?/<duration>)
554 |(% style="width:197px" %)**GY**|(% style="width:517px" %)Gregorian Year (YYYY)
555 |(% style="width:197px" %)**GTM**|(% style="width:517px" %)Gregorian Year Month (YYYY-MM)
556 |(% style="width:197px" %)**GD**|(% style="width:517px" %)Gregorian Day (YYYY-MM-DD)
557 |(% style="width:197px" %)**DT**|(% style="width:517px" %)Distinct Point: date-time (YYYY-MM-DDThh:mm:ss)
558 |(% style="width:197px" %)**RY**|(% style="width:517px" %)Reporting Year (YYYY-A1)
559 |(% style="width:197px" %)**RS**|(% style="width:517px" %)Reporting Semester (YYYY-Ss)
560 |(% style="width:197px" %)**RT**|(% style="width:517px" %)Reporting Trimester (YYYY-Tt)
561 |(% style="width:197px" %)**RQ**|(% style="width:517px" %)Reporting Quarter (YYYY-Qq)
562 |(% style="width:197px" %)**RM**|(% style="width:517px" %)Reporting Month (YYYY-Mmm)
563 |(% style="width:197px" %)**Code**|(% style="width:517px" %)**Format**
564 |(% style="width:197px" %)**RW**|(% style="width:517px" %)Reporting Week (YYYY-Www)
565 |(% style="width:197px" %)**RD**|(% style="width:517px" %)Reporting Day (YYYY-Dddd)
566
567 **Table 1: SDMX-ML Time Format Codes**
568
569 === 4.2.9 Transformation between SDMX-ML and SDMX-EDI ===
570
571 When converting SDMX-ML data structure definitions to SDMX-EDI data structure definitions, only the identifier of the time format attribute will be retained. The representation of the attribute will be converted from the SDMX-ML format to the fixed SDMX-EDI code list. If the SDMX-ML data structure definition does not define a time format attribute, then one will be automatically created with the identifier "TIME_FORMAT".
572
573 When converting SDMX-ML data to SDMX-EDI, the source time format attribute will be irrelevant. Since the SDMX-ML time representation types are not ambiguous, the target time format can be determined from the source time value directly. For example, if the SDMX-ML time is 2000-Q2 the SDMX-EDI format will always be 608/708 (depending on whether the target series contains one observation or a range of observations).
574
575 When converting a data structure definition originating in SDMX-EDI, the time format attribute should be ignored, as it serves no purpose in SDMX-ML.
576
577 When converting data from SDMX-EDI to SDMX-ML, the source time format is only necessary to determine the format of the target time value. For example, a source time format of will result in a target time in the format YYYY-Ss whereas a source format of will result in a target time value in the format YYYY-Qq.
578
579 === 4.2.10 Time Zones ===
580
581 In alignment with ISO 8601, SDMX allows the specification of a time zone on all time periods and on the reporting year start day. If a time zone is provided on a reporting year start day, then the same time zone (or none) should be reported for each reporting time period. If the reporting year start day and the reporting period time zone differ, the time zone of the reporting period will take precedence. Examples of each format with time zones are as follows (time zone indicated in bold):
582
583 * Time Range (start date): 2006-06-05**-05:00**/P5D
584 * Time Range (start date-time): 2006-06-05T00:00:00**-05:00**/P5D
585 * Gregorian Year: 2006**-05:00**
586 * Gregorian Month: 2006-06**-05:00**
587 * Gregorian Day: 2006-06-05**-05:00**
588 * Distinct Point: 2006-06-05T00:00:00**-05:00**
589 * Reporting Year: 2006-A1**-05:00**
590 * Reporting Semester: 2006-S2**-05:00**
591 * Reporting Trimester: 2006-T2**-05:00**
592 * Reporting Quarter: 2006-Q3**-05:00**
593 * Reporting Month: 2006-M06**-05:00**
594 * Reporting Week: 2006-W23**-05:00**
595 * Reporting Day: 2006-D156**-05:00**
596 * Reporting Year Start Day: ~-~-07-01**-05:00**
597
598 According to ISO 8601, a date without a time-zone is considered "local time". SDMX assumes that local time is that of the sender of the message. In this version of SDMX, an optional field is added to the sender definition in the header for specifying a time zone. This field has a default value of 'Z' (UTC). This determination of local time applies for all dates in a message.
599
600 === 4.2.11 Representing Time Spans Elsewhere ===
601
602 It has been possible since SDMX 2.0 for a Component to specify a representation of a time span. Depending on the format of the data message, this resulted in either an element with 2 XML attributes for holding the start time and the duration or two separate XML attributes based on the underlying Component identifier. For example if REF_PERIOD were given a representation of time span, then in the Compact data format, it would be represented by two XML attributes; REF_PERIODStartTime (holding the start) and REF_PERIOD (holding the duration). If a new simple type is introduced in the SDMX schemas that can hold ISO 8601 time intervals, then this will no longer be necessary. What was represented as this:
603
604 <Series REF_PERIODStartTime="2000-01-01T00:00:00" REF_PERIOD="P2M"/>
605
606 can now be represented with this:
607
608 <Series REF_PERIOD="2000-01-01T00:00:00/P2M"/>
609
610 === 4.2.12 Notes on Formats ===
611
612 There is no ambiguity in these formats so that for any given value of time, the category of the period (and thus the intended time period range) is always clear. It should also be noted that by utilizing the ISO 8601 format, and a format loosely based on it for the report periods, the values of time can easily be sorted chronologically without additional parsing.
613
614 === 4.2.13 Effect on Time Ranges ===
615
616 All SDMX-ML data messages are capable of functioning in a manner similar to SDMX-EDI if the Dimension at the observation level is time: the time period for the first observation can be stated and the rest of the observations can omit the time value as it can be derived from the start time and the frequency. Since the frequency can be determined based on the actual format of the time value for everything but distinct points in time and time ranges, this makes is even simpler to process as the interval between time ranges is known directly from the time value.
617
618 === 4.2.14 Time in Query Messages ===
619
620 When querying for time values, the value of a time parameter can be provided as any of the Observational Time Period formats and must be paired with an operator. In addition, an explicit value for the reporting year start day can be provided, or this can be set to "Any". This section will detail how systems processing query messages should interpret these parameters.
621
622 Fundamental to processing a time value parameter in a query message is understanding that all time periods should be handled as a distinct range of time. Since the time parameter in the query is paired with an operator, this is also effectively represents a distinct range of time. Therefore, a system processing the query must simply match the data where the time period for requested parameter is encompassed by the time period resulting from value of the query parameter. The following table details how the operators should be interpreted for any time period provided as a parameter.
623
624 (% style="width:1024.29px" %)
625 |(% style="width:238px" %)**Operator**|(% style="width:782px" %)**Rule**
626 |(% style="width:238px" %)Greater Than|(% style="width:782px" %)Any data after the last moment of the period
627 |(% style="width:238px" %)Less Than|(% style="width:782px" %)Any data before the first moment of the period
628 |(% style="width:238px" %)Greater Than or Equal To|(% style="width:782px" %)(((
629 Any data on or after the first moment of the period
630 )))
631 |(% style="width:238px" %)Less Than or Equal To|(% style="width:782px" %)Any data on or before the last moment of the period
632 |(% style="width:238px" %)Equal To|(% style="width:782px" %)Any data which falls on or after the first moment of the period and before or on the last moment of the period
633
634 Reporting Time Periods as query parameters are handled based on whether the value of the reportingYearStartDay XML attribute is an explicit month and day or "Any":
635
636 If the time parameter provides an explicit month and day value for the reportingYearStartDay XML attribute, then the parameter value is converted to a distinct range and processed as any other time period would be processed.
637
638 If the reportingYeartStartDay XML attribute has a value of "Any", then any data within the bounds of the reporting period for the year is matched, regardless of the actual start day of the reporting year. In addition, data reported against a normal calendar period is matched if it falls within the bounds of the time parameter based on a reporting year start day of January 1. When determining whether another reporting period falls within the bounds of a report period query parameter, one will have to take into account the actual time period to compare weeks and days to higher order report periods. This will be demonstrated in the examples to follow.
639
640 Note that the reportingYearStartDay XML attribute on the time value parameter is only used to qualify a reporting period value for the given time value parameter. The usage of this is different than using the attribute value parameter for the actual reporting year start day attribute. In the case that the attribute value parameters is used for the reporting year start day data structure attribute, it will be treated as any other attribute value parameter; data will be filtered to that which matches the values specified for the given attribute. For example, if the attribute value parameter references the reporting year start day attribute and specifies a value of "~-~-07-01", then only data which has this attribute with the value "~-~-07-01" will be returned. In terms of processing any time value parameters, the value supplied in the attribute value parameter will be irrelevant.
641
642 **Examples:**
643
644 **Gregorian Period**
645 Query Parameter: Greater than 2010
646 Literal Interpretation: Any data where the start period occurs after 2010-1231T23:59:59.
647
648 Example Matches:
649
650 * 2011 or later
651 * 2011-01 or later
652 * 2011-01-01 or later
653 * 2011-01-01/P[Any Duration] or any later start date
654 * 2011-[Any reporting period] (any reporting year start day)
655 * 2010-S2 (reporting year start day ~-~-07-01 or later)
656 * 2010-T3 (reporting year start day ~-~-07-01 or later)
657 * 2010-Q3 or later (reporting year start day ~-~-07-01 or later)
658 * 2010-M07 or later (reporting year start day ~-~-07-01 or later)
659 * 2010-W28 or later (reporting year start day ~-~-07-01 or later)
660 * 2010-D185 or later (reporting year start day ~-~-07-01 or later)
661
662 **Reporting Period with explicit start day**
663 Query Parameter: Greater than or equal to 2009-Q3, reporting year start day = "-07-01"
664 Literal Interpretation: Any data where the start period occurs on after 2010-0101T00:00:00 (Note that in this case 2009-Q3 is converted to the explicit date range of 2010-01-01/2010-03-31 because of the reporting year start day value). Example Matches: Same as previous example
665
666 **Reporting Period with "Any" start day**
667 Query Parameter: Greater than or equal to 2010-Q3, reporting year start day = "Any"
668 Literal Interpretation: Any data with a reporting period where the start period is on or after the start period of 2010-Q3 for the same reporting year start day, or and data where the start period is on or after 2010-07-01. Example Matches:
669
670 * 2011 or later
671 * 2010-07 or later
672 * 2010-07-01 or later
673 * 2010-07-01/P[Any Duration] or any later start date
674 * 2011-[Any reporting period] (any reporting year start day)
675 * 2010-S2 (any reporting year start day)
676 * 2010-T3 (any reporting year start day)
677 * 2010-Q3 or later (any reporting year start day)
678 * 2010-M07 or later (any reporting year start day)
679 * 2010-W27 or later (reporting year start day ~-~-01-01){{footnote}}2010-Q3 (with a reporting year start day of --01-01) starts on 2010-07-01. This is day 4 of week 26, therefore the first week matched is week 27.{{/footnote}}  2010-D182 or later (reporting year start day ~-~-01-01)
680 * 2010-W28 or later (reporting year start day ~-~-07-01){{footnote}}2010-Q3 (with a reporting year start day of --07-01) starts on 2011-01-01. This is day 6 of week 27, therefore the first week matched is week 28.{{/footnote}}
681 * 2010-D185 or later (reporting year start day ~-~-07-01)
682
683 == 4.3 Structural Metadata Querying Best Practices ==
684
685 When querying for structural metadata, the ability to state how references should be resolved is quite powerful. However, this mechanism is not always necessary and can create an undue burden on the systems processing the queries if it is not used properly.
686
687 Any structural metadata object which contains a reference to an object can be queried based on that reference. For example, a categorisation references both a category and the object is it categorising. As this is the case, one can query for categorisations which categorise a particular object or which categorise against a particular category or category scheme. This mechanism should be used when the referenced object is known.
688
689 When the referenced object is not known, then the reference resolution mechanism could be used. For example, suppose one wanted to find all category schemes and the related categorisations for a given maintenance agency. In this case, one could query for the category scheme by the maintenance agency and specify that parent and sibling references should be resolved. This would result in the categorisations which reference the categories in the matched schemes to be returned, as well as the object which they categorise.
690
691 == 4.4 Versioning and External Referencing ==
692
693 Within the SDMX-ML Structure Message, there is a pattern for versioning and external referencing which should be pointed out. The identifiers are qualified by their version numbers – that is, an object with an Agency of “A”, and ID of “X” and a version of “1.0” is a different object than one with an Agency of “A’, an ID of “X”, and a version of “1.1”.
694
695 The production versions of identifiable objects/resources are assumed to be static – that is, they have their isFinal attribute set to ‘true”. Once in production, and object cannot change in any way, or it must be versioned. For cases where an object is not static, the isFinal attribute must have a value of “false”, but non-final objects should not be used outside of a specific system designed to accommodate them. For most purposes, all objects should be declared final before use in production.
696
697 This mechanism is an “early binding” one – everything with a versioned identity is a known quantity, and will not change. It is worth pointing out that in some cases relationships are essentially one-way references: an illustrative case is that of Categories. While a Category may be referenced by many dataflows and metadata flows, the addition of more references from flow objects does not version the Category. This is because the flows are not properties of the Categories – they merely make references to it. If the name of a Category changed, or its subCategories changed, then versioning would be necessary.
698
699 Versioning operates at the level of versionable and maintainable objects in the SDMX information model. If any of the children of objects at these levels change, then the objects themselves are versioned.
700
701 One area which is much impacted by this versioning scheme is the ability to reference external objects. With the many dependencies within the various structural objects in SDMX, it is useful to have a scheme for external referencing. This is done at the level of maintainable objects (DSDs, code lists, concept schemes, etc.) In an SDMX-ML Structure Message, whenever an “isExternalReference” attribute is set to true, then the application must resolve the address provided in the associated “uri” attribute and use the SDMX-ML Structure Message stored at that location for the full definition of the object in question. Alternately, if a registry “urn” attribute has been provided, the registry can be used to supply the full details of the object.
702
703 Because the version number is part of the identifier for an object, versions are a necessary part of determining that a given resource is the one which was called for. It should be noted that whenever a version number is not supplied, it is assumed to be “1.0”. (The “x.x” versioning notation is conventional in practice with SDMX, but not required.)
704
705 = 5 Metadata Structure Definition (MSD) =
706
707 == 5.1 Scope ==
708
709 The scope of the MSD is enhanced in this version to better support the types of construct to which metadata can be attached. In particular it is possible to specify an attachment to any key or partial key of a data set. This is particularly useful for web dissemination where metadata may be present for the data, but is not stored with the data but is related to it. For this use case to be supported it is necessary to be able to specify in the MSD that metadata is attached to a key or partial key, and the actual key or partial key to be identified in the Metadata Set.
710
711 In addition to the increase in the scope of objects that can be included in an MSD, the way the identifier mechanism works in this version, and the terminology used, is much simpler.
712
713 == 5.2 Identification of the Object Type to which the Metadata is to be Attached ==
714
715 The following example shows the structure and naming of the MSD components for the use case of defining full and partial keys.
716
717 The schematic structure of an MSD is shown below.
718
719 [[image:1747836776649-282.jpeg]]
720
721 **Figure 1: Schematic of the Metadata Structure Definition**
722
723 The MSD comprises the specification of the object types to which metadata can be reported in a Metadata Set (Metadata Target(s)), and the Report Structure(s) comprising the Metadata Attributes that identify the Concept for which metadata may be reported in the Metadata Set. Importantly, one Report Structure references the Metadata Target for which it is relevant. One Report Structure can reference many Metadata Target i.e. the same Report Structure can be used for different target objects.
724
725 [[image:1747836776655-364.jpeg]]
726
727 **Figure 2: Example MSD showing Metadata Targets**
728
729 Note that the SDMX-ML schemas have explicit XML elements for each identifiable object type because identifying, for instance, a Maintainable Object has different properties from an Identifiable Object which must also include the agencyId, version, and id of the Maintainable Object in which it resides.
730
731 == 5.3 Report Structure ==
732
733 An example is shown below.
734
735 [[image:1747836776658-510.jpeg]]
736
737 **Figure 3: Example MSD showing specification of three Metadata Attributes**
738
739 This example shows the following hierarchy of Metadata Attributes:
740
741 Source – this is presentational and no metadata is expected to be reported at this level
742
743 * Source Type
744 * Collection Source Name
745
746 == 5.4 Metadata Set ==
747
748 An example of reporting metadata according to the MSD described above, is shown below.
749
750 [[image:1747836776677-246.jpeg]]
751
752 **Figure 4: Example Metadata Set **This example shows:
753
754 1. The reference to the MSD, Metadata Report, and Metadata Target (MetadataTargetValue)
755 1. The reported metadata attributes (AttributeValueSet)
756
757 = 6 Maintenance Agencies =
758
759 All structural metadata in SDMX is owned and maintained by a maintenance agency (Agency identified by agencyID in the schemas). It is vital to the integrity of the structural metadata that there are no conflicts in agencyID. In order to achieve this SDMX adopts the following rules:
760
761 1. Agencies are maintained in an Agency Scheme (which is a sub class of Organisation Scheme)
762 1. The maintenance agency of the Agency Scheme must also be declared in a (different) Agency Scheme.
763 1. The “top-level” agency is SDMX and this agency scheme is maintained by SDMX.
764 1. Agencies registered in the top-level scheme can themselves maintain a single Agency Scheme. SDMX is an agency in the SDMX agency scheme. Agencies in this scheme can themselves maintain a single Agency Scheme and so on.
765 1. The AgencyScheme cannot be versioned and so take a default version number of 1.0 and cannot be made “final”.
766 1. There can be only one AgencyScheme maintained by any one Agency. It has a fixed Id of AgencyScheme.
767 1. The format of the agency identifier is agencyId.agencyID etc. The top-level agency in this identification mechanism is the agency registered in the SDMX agency scheme. In other words, SDMX is not a part of the hierarchical ID structure for agencies. SDMX is, itself, a maintenance agency.
768
769 This supports a hierarchical structure of agencyID.
770
771 An example is shown below.
772
773 [[image:1747836776680-229.jpeg]]
774
775 **Figure 5: Example of Hierarchic Structure of Agencies**
776
777 Each agency is identified by its full hierarchy excluding SDMX.
778
779 The XML representing this structure is shown below.
780
781 [[image:1747836776682-757.jpeg]]
782
783 **Figure 6: Example Agency Schemes Showing a Hierarchy**
784
785 Example of Structure Definitions:
786
787 [[image:1747836776687-934.jpeg]]
788
789 **Figure 7: Example Showing Use of Agency Identifiers**
790
791 Each of these maintenance agencies has an identical Codelist with the Id CL_BOP. However, each is uniquely identified by means of the hierarchic agency structure.
792
793 = 7 Concept Roles =
794
795 == 7.1 Overview ==
796
797 The DSD Components of Dimension and Attribute can play a specific role in the DSD and it is important to some applications that this role is specified. For instance, the following roles are some examples:
798
799 **Frequency **– in a data set the content of this Component contains information on the frequency of the observation values
800 **Geography** - in a data set the content of this Component contains information on the geographic location of the observation values
801 **Unit** **of Measure** - in a data set the content of this Component contains information on the unit of measure of the observation values
802
803 In order for these roles to be extensible and also to enable user communities to maintain community-specific roles, the roles are maintained in a controlled vocabulary which is implemented in SDMX as Concepts in a Concept Scheme. The Component optionally references this Concept if it is required to declare the role explicitly. Note that a Component can play more than one role and therefore multiple “role” concepts can be referenced.
804
805 == 7.2 Information Model ==
806
807 The Information Model for this is shown below:
808
809 [[image:1747855024745-946.png]]
810
811 **Figure 8: Information Model Extract for Concept Role**
812
813 It is possible to specify zero or more concept roles for a Dimension, Measure Dimension and Data Attribute (but not the ReportingYearStartDay). The Time Dimension, Primary Measure, and the Attribute ReportingYearStartDay have explicitly defined roles and cannot be further specified with additional concept roles.
814
815 == 7.3 Technical Mechanism ==
816
817 The mechanism for maintain and using concept roles is as follows:
818
819 1. Any recognized Agency can have a concept scheme that contains concepts that identify concept roles. Indeed, from a technical perspective any agency can have more than one of these schemes, though this is not recommended.
820 1. The concept scheme that contains the “role” concepts can contain concepts that do not play a role.
821 1. There is no explicit indication on the Concept whether it is a ‘role” concept.
822 1. Therefore, any concept in any concept scheme is capable of being a “role” concept.
823 1. It is the responsibility of Agencies to ensure their community knows which concepts in which concept schemes play a “role” and the significance and interpretation of this role. In other words, such concepts must be known by applications, there is no technical mechanism that can inform an application on how to process such a “role”.
824 1. If the concept referenced in the Concept Identity in a DSD component (Dimension, Measure Dimension, Attribute) is contained in the concept scheme containing concept roles then the DSD component could play the role implied by the concept, if this is understood by the processing application.
825 1. If the concept referenced in the Concept Identity in a DSD component (Dimension, Measure Dimension, Attribute) is not contained in the concept scheme containing concept roles, and the DSD component is playing a role, then the concept role is identified by the Concept Role in the schema.
826
827 == 7.4 SDMX-ML Examples in a DSD ==
828
829 The Cross-Domain Concept Scheme maintained by SDMX contains concept role concepts (FREQ chosen as an example).
830
831 [[image:1747855054559-410.png]]
832
833 Whether this is a role or not depends upon the application understanding that FREQ in the Cross-Domain Concept Scheme is a role of Frequency.
834
835 Using a Concept Scheme that is not the Cross-Domain Concept Scheme where it is required to assign a role using the Cross-Domain Concept Scheme. Again FREQ is chosen as the example.
836
837 [[image:1747855075263-887.png]]
838
839 This explicitly states that this Dimension is playing a role identified by the FREQ concept in the Cross-Domain Concept Scheme. Again the application needs to understand what FREQ in the Cross-Domain Concept Scheme implies in terms of a role.
840
841 This is all that is required for interoperability within a community. The important point is that a community must recognise a specific Agency as having the authority to define concept roles and to maintain these “role” concepts in a concept scheme together with documentation on the meaning of the role and any relevant processing implications. This will then ensure there is interoperability between systems that understand the use of these concepts.
842
843 Note that each of the Components (Data Attribute, Primary Measure, Dimension, Measure Dimension, Time Dimension) has a mandatory identity association (Concept Identity) and if this Concept also identifies the role then it is possible to state this by
844
845 == 7.5 SDMX Cross Domain Concept Scheme ==
846
847 All concepts in the SDMX Cross Domain Concept Scheme are capable of playing a role and this scheme will contain all of the roles that were allowed at version 2.0 and will be maintained with new roles that are agreed at the level of the community using the Cross Domain Concept Scheme.
848
849 The table below lists the Concepts that need to be in this scheme either for compatibility with version 2.0 or because of requests for additional roles at version 2.1 which have been accepted.
850
851 Note that each of the Components (Data Attribute, Primary Measure, Dimension, Measure Dimension, Time Dimension) has a mandatory identity association (Concept Identity) and if this Concept also identifies the role then it is possible to state this by means of the isRole attribute (isRole=true) Additional roles can still be specified by means of the +role association to additional Concepts that identify the role.
852
853 = 8 Constraints =
854
855 == 8.1 Introduction ==
856
857 In this version of SDMX the Constraints is a Maintainable Artefact can be associated to one or more of:
858
859 * Data Structure Definition
860 * Metadata Structure Definition
861 * Dataflow
862 * Metadataflow
863 * Provision Agreement
864 * Data Provider (this is restricted to a Release Calendar Constraint)
865 * Simple or Queryable Datasources
866
867 Note that regardless of the artifact to which the Constraint is associated, it is constraining the contents of code lists in the DSD to which the constrained object is related. This does not apply, of course, to a Data Provider as the Data Provider can be associated, via the Provision Agreement, to many DSDs. Hence the reason for the restriction on the type of Constraint that can be attached to a Data Provider.
868
869 == 8.2 Types of Constraint ==
870
871 The Constraint can be of one of two types:
872
873 * Content constraint
874 * Attachable constraint
875
876 The attachable constraint is used to define “cube slices” which identify sub sets of data in terms of series keys or dimension values. The purpose of this is to enable metadata to be attached to the constraint, and thereby to the cube slices defined in the Constraint. The metadata can be attached via the “reference metadata” mechanism – MSD and Metadata Set – or via a Group in the DSD. Below is snippet of the schema for a DSD that shows the constructs that enable the Constraint to referenced from a Group in a DSD.
877
878 [[image:1747836776695-806.jpeg]]
879
880 **Figure 9: Extract from the SDMX-ML Schema showing reference to Attachment Constraint**
881
882 For the Content Constraint specific “inheritance” rules apply and these are detailed below.
883
884 == 8.3 Rules for a Content Constraint ==
885
886 === 8.3.1 Scope of a Content Constraint ===
887
888 A Content Constraint is used specify the content of a data or metadata source in terms of the component values or the keys.
889
890 In terms of data the components are:
891
892 * Dimension
893 * Measure Dimension
894 * Time Dimension
895 * Data Attribute
896 * Primary Measure
897
898 And the keys are the content of the KeyDescriptor – i.e. the series keys composed, for each key, by a value for each Dimension and Measure Dimension
899
900 In terms of reference metadata the components are:
901
902 * Target Object which is one of:
903 ** Key Descriptor Values o Data Set o Report Period
904 ** IdentifiableObject
905 * Metadata Attribute
906
907 The “key” is therefore the combination of the Target Objects that are defined for the Metadata Target.
908
909 For a Constraint based on a DSD the Content Constraint can reference one or more of:
910
911 * Data Structure Definition
912 * Dataflow
913 * Provision Agreement
914
915 For a Constraint based on an MSD the Content Constraint can reference one or more of:
916
917 * Metadata Structure Definition
918 * Metadataflow
919 * Provision Agreement
920
921 Furthermore, there can be more than one Content Constraint specified for a specific object e.g. more than one Constraint for a specific DSD.
922
923 In view of the flexibility of constraints attachment, clear rules on their usage are required. These are elaborated below.
924
925 === 8.3.2 Multiple Content Constraints ===
926
927 There can be many Content Constraints for any Constrainable Artefact (e.g. DSD), subject to the following restrictions:
928
929 ==== 8.3.2.1 Cube Region ====
930
931 1. The constraint can contain multiple Member Selections (e.g. Dimension) but:
932 1. A specific Member Selection (e.g. Dimension FREQ) can only be contained in one Content Constraint for any one attached object (e.g. a specific DSD or specific Dataflow)
933
934 ==== 8.3.2.2 Key Set ====
935
936 Key Sets will be processed in the order they appear in the Constraint and wildcards can be used (e.g. any key position not reference explicitly is deemed to be “all values”). As the Key Sets can be “included” or “excluded” it is recommended that Key Sets with wildcards are declared before KeySets with specific series keys. This will minimize the risk that keys are inadvertently included or excluded.
937
938 === 8.3.3 Inheritance of a Content Constraint ===
939
940 ==== 8.3.3.1 Attachment levels of a Content Constraint ====
941
942 There are three levels of constraint attachment for which these inheritance rules apply:
943
944 * DSD/MSD – top level
945 ** Dataflow/Metadataflow – second level
946 *** Provision Agreement – third level
947
948 Note that these rules do not apply to the Simple Datasoucre or Queryable Datasource: the Content Constraint(s) attached to these artefacts are resolved for this artefact only and do not take into account Constraints attached to other artefacts (e.g. Provision Agreement. Dataflow, DSD).
949
950 It is not necessary for a Content Constraint to be attached to higher level artifact. e.g. it is valid to have a Content Constraint for a Provision Agreement where there are no constraints attached the relevant dataflow or DSD.
951
952 ==== 8.3.3.2 Cascade rules for processing Constraints ====
953
954 The processing of the constraints on either Dataflow/Metadataflow or Provision Agreement must take into account the constraints declared at higher levels. The rules for the lower level constraints (attached to Dataflow/ Metadataflow and Provision Agreement) are detailed below.
955
956 Note that there can be a situation where a constraint is specified at a lower level before a constraint is specified at a higher level. Therefore, it is possible that a higher level constraint makes a lower level constraint invalid. SDMX makes no rules on how such a conflict should be handled when processing the constraint for attachment. However, the cascade rules on evaluating constraints for usage are clear - the higher level constraint takes precedence in any conflicts that result in a less restrictive specification at the lower level.
957
958 ==== 8.3.3.3 Cube Region ====
959
960 1. It is not necessary to have a constraint on the higher level artifact (e.g. DSD referenced by the Dataflow) but if there is such a constraint at the higher level(s) then:
961 a. The lower level constraint cannot be less restrictive than the constraint specified for the same Member Selection (e.g. Dimension) at the next higher level which constraints that Member Selection (e.g. if the Dimension FREQ is constrained to A, Q in a DSD then the constraint at the Dataflow or Provision Agreement cannot be A, Q, M or even just M – it can only further constrain A,Q).
962 b. The constraint at the lower level for any one Member Selection further constrains the content for the same Member Selection at the higher level(s).
963 1. Any Member Selection which is not referenced in a Content Constraint is deemed to be constrained according to the Content Constraint specified at the next higher level which constraints that Member Selection.
964 1. If there is a conflict when resolving the constraint in terms of a lower-level constraint being less restrictive than a higher-level constraint then the constraint at the higher-level is used.
965
966 Note that it is possible for a Content Constraint at a higher level to constrain, say, four Dimensions in a single constraint, and a Content Constraint at a lower level to constrain the same four in two, three, or four Content Constraints.
967
968 ==== 8.3.3.4 Key Set ====
969
970 1. It is not necessary to have a constraint on the higher level artefact (e.g. DSD referenced by the Dataflow) but if there is such a constraint at the higher level(s) then:
971 a. The lower level constraint cannot be less restrictive than the constraint specified at the higher level.
972 b. The constraint at the lower level for any one Member Selection further constrains the keys specified at the higher level(s).
973 1. Any Member Selection which is not referenced in a Content Constraint is deemed to be constrained according to the Content Constraint specified at the next higher level which constraints that Member Selection.
974 1. If there is a conflict when resolving the keys in the constraint at two levels, in terms of a lower-level constraint being less restrictive than a higher-level constraint, then the offending keys specified at the lower level are not deemed part of the constraint.
975
976 Note that a Key in a Key Set can have wildcarded Components. For instance the constraint may simply constrain the Dimension FREQ to “A”, and all keys where the FREQ=A are therefore valid.
977
978 The following logic explains how the inheritance mechanism works. Note that this is conceptual logic and actual systems may differ in the way this is implemented.
979
980 1. Determine all possible keys that are valid at the higher level.
981 1. These keys are deemed to be inherited by the lower level constrained object, subject to the constraints specified at the lower level.
982 1. Determine all possible keys that are possible using the constraints specified at the lower level.
983 1. At the lower level inherit all keys that match with the higher level constraint.
984 1. If there are keys in the lower level constraint that are not inherited then the key is invalid (i.e. it is less restrictive).
985
986 === 8.3.4 Constraints Examples ===
987
988 The following scenario is used.
989
990 __DSD__
991
992 This contains the following Dimensions:
993
994 * GEO – Geography
995 * SEX – Sex
996 * AGE – Age
997 * CAS – Current Activity Status
998
999 In the DSD common code lists are used and the requirement is to restrict these at various levels to specify the actual code that are valid for the object to which the Content Constraint is attached.
1000
1001 [[image:1747855493531-357.png]]
1002
1003 **Figure 10: Example Scenario for Constraints**
1004
1005 Constraints are declared as follows:
1006
1007 [[image:1747855462293-368.png]]
1008
1009 **Figure 11: Example Content Constraints**
1010
1011 **Notes:**
1012
1013 1. AGE is constrained for the DSD and is further restricted for the Dataflow CENSUS_CUBE1.
1014 1. The same Constraint applies to both Provision Agreements.
1015
1016 The cascade rules elaborated above result as follows:
1017
1018 __DSD__
1019
1020 ~1. Constrained by eliminating code 001 from the code list for the AGE Dimension.
1021
1022 __Dataflow CENSUS_CUBE1__
1023
1024 1. Constrained by restricting the code list for the AGE Dimension to codes 002 and 003(note that this is a more restrictive constraint than that declared for the DSD which specifies all codes except code 001).
1025 1. Restricts the CAS codes to 003 and 004.
1026
1027 __Dataflow CENSUS_CUBE2__
1028
1029 1. Restricts the code list for the CAS Dimension to codes TOT and NAP.
1030 1. Inherits the AGE constraint applied at the level of the DSD.
1031
1032 __Provision Agreements CENSUS_CUBE1_IT__
1033
1034 1. Restricts the codes for the GEO Dimension to IT and its children.
1035 1. Inherits the constraints from Dataflow CENSUS_CUBE1 for the AGE and CAS Dimensions.
1036
1037 __Provision Agreements CENSUS_CUBE2_IT__
1038
1039 1. Restricts the codes for the GEO Dimension to IT and its children.
1040 1. Inherits the constraints from Dataflow CENSUS_CUBE2 for the CAS Dimension.
1041 1. Inherits the AGE constraint applied at the level of the DSD.
1042
1043 The constraints are defined as follows:
1044
1045 __DSD Constraint__
1046
1047 [[image:1747836776698-720.jpeg]]
1048
1049 __Dataflow Constraints__
1050
1051 [[image:1747836776701-360.jpeg]]
1052
1053 [[image:1747836776707-834.jpeg]]
1054
1055 __Provision Agreement Constraint__
1056
1057 [[image:1747836776710-262.jpeg]]
1058
1059 = 9 Transforming between versions of SDMX =
1060
1061 == 9.1 Scope ==
1062
1063 The scope of this section is to define both best practices and mandatory behaviour for specific aspects of transformation between different formats of SDMX.
1064
1065 == 9.2 Groups and Dimension Groups ==
1066
1067 === 9.2.1 Issue ===
1068
1069 Version 2.1 introduces a more granular mechanism for specifying the relationship between a Data Attribute and the Dimensions to which the attribute applies. The technical construct for this is the Dimension Group. This Dimension Group has no direct equivalent in versions 2.0 and 1.0 and so the application transforming data from a version 2.1 data set to a version 2.0 or version 1.0 data set must decide to which construct the attribute value, whose Attribute is declared in a Dimension Group, should be attached. The closest construct is the “Series” attachment level and in many cases this is the correct construct to use.
1070
1071 However, there is one case where the attribute MUST be attached to a Group in the version 2.0 and 1.0 message. The conditions of this case are:
1072
1073 1. A Group is defined in the DSD with exactly the same Dimensions as a Dimension Group in the same DSD.
1074 1. The Attribute is defined in the DSD with an Attribute Relationship to the Dimension Group. This attribute is NOT defined as having an Attribute Relationship to the Group.
1075
1076 === 9.2.2 Structural Metadata ===
1077
1078 If the conditions defined in 9.2.1are true then on conversion to a version 2.0 or 1.0 DSD (Key Family) the Component/Attribute.attachmentLevel must be set to “Group” and the Component/Attribute/AttachmentGroup” is used to identify the Group. Note that under rule(1) in 1.2.1 this group will have been defined in the V 2.1 DSD and so will be present in the V 2.0 transformation.
1079
1080 === 9.2.3 Data ===
1081
1082 If the conditions defined in 9.2.1are true then, on conversion from a 2.1 data set to a 2.0 or 1.0 dataset the attribute value will be placed in the relevant <Group>. If these conditions are not true then the attribute value will be placed in the <Series>.
1083
1084 === 9.2.4 Compact Schema ===
1085
1086 If the conditions defined in 9.2.1are true then the Compact Schema must be generated with the Group present and the Attribute(s) present in that group definition.
1087
1088 = 10 Validation and Transformation Language (VTL) =
1089
1090 == 10.1 Introduction ==
1091
1092 The Validation and Transformation Language (VTL) supports the definition of Transformations, which are algorithms to calculate new data starting from already existing ones[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[4~]^^>>path:#_ftn4]](%%). The purpose of the VTL in the SDMX context is to enable the:
1093
1094 * definition of validation and transformation algorithms, in order to specify how to calculate new data from existing ones;
1095 * exchange of the definition of VTL algorithms, also together the definition of the data structures of the involved data (for example, exchange the data structures of a reporting framework together with the validation rules to be applied, exchange the input and output data structures of a calculation task together with the VTL Transformations describing the calculation algorithms);
1096 * compilation and execution of VTL algorithms, either interpreting the VTL transformations or translating them in whatever other computer language is deemed as appropriate.
1097
1098 It is important to note that the VTL has its own information model (IM), derived from the Generic Statistical Information Model (GSIM) and described in the VTL User Guide. The VTL IM is designed to be compatible with more standards, like SDMX, DDI (Data Documentation Initiative) and GSIM, and includes the model artefacts that can be manipulated (inputs and/or outputs of transformations, e.g. “Data Set”, “Data Structure”) and the model artefacts that allow the definition of the transformation algorithms (e.g. “Transformation”, “Transformation Scheme”).
1099
1100 The VTL language can be applied to SDMX artefacts by mapping the SDMX IM model artefacts to the model artefacts that VTL can manipulate. Thus, the SDMX artefacts can be used in VTL as inputs and/or outputs of transformations. It is important to be aware that the artefacts do not always have the same names in the SDMX and VTL IMs, nor do they always have the same meaning. The more evident example is given by the SDMX Dataset and the VTL “Data Set”, which do not correspond one another: as a matter of fact, the VTL “Data Set” maps to the SDMX “Dataflow”, while the SDMX “Dataset” has no explicit mapping to VTL (such an abstraction is not needed in the definition of VTL transformations). A SDMX “Dataset”, however, is an instance of a SDMX “Dataflow” and can be the artefact on which the VTL transformations are executed (i.e., the transformations are defined on Dataflows and are applied to Dataflow instances that can be Datasets).
1101
1102 The VTL programs (Transformation Schemes) are represented in SDMX through the TransformationScheme maintainable class which is composed of Transformation (nameable artefact). Each Transformation assigns the outcome of the evaluation of a VTL expression to a result.
1103
1104 This section does not explain the VTL language or any of the content published in the VTL guides. Rather, this is a description of how the VTL can be used in the SDMX context and applied to SDMX artefacts.
1105
1106 == 10.2 References to SDMX artefacts from VTL statements ==
1107
1108 === 10.2.1 Introduction ===
1109
1110 The VTL can manipulate SDMX artefacts (or objects) by referencing them through pre-defined conventional names (aliases).
1111
1112 The alias of a SDMX artefact can be its URN (Universal Resource Name), an abbreviation of its URN or another user-defined name.
1113
1114 In any case, the aliases used in the VTL transformations have to be mapped to the SDMX artefacts through the VtlMappingScheme and VtlMapping classes (see the section of the SDMX IM relevant to the VTL). A VtlMapping allows specifying the aliases to be used in the VTL transformations, rulesets[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[5~]^^>>path:#_ftn5]](%%) or user defined operators[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[6~]^^>>path:#_ftn6]](%%) to reference SDMX artefacts. A VtlMappingScheme is a container for zero or more VtlMapping.
1115
1116 The correspondence between an alias and a SDMX artefact must be one-to-one, meaning that a generic alias identifies one and just one SDMX artefact while a SDMX artefact is identified by one and just one alias. In other words, within a VtlMappingScheme an artefact can have just one alias and different artefacts cannot have the same alias.
1117
1118 The references through the URN and the abbreviated URN are described in the following paragraphs.
1119
1120 === 10.2.2 References through the URN ===
1121
1122 This approach has the advantage that in the VTL code the URN of the referenced artefacts is directly intelligible by a human reader but has the drawback that the references are verbose.
1123
1124 The SDMX URN[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[7~]^^>>path:#_ftn7]](%%) is the concatenation of the following parts, separated by special symbols like dot, equal, asterisk, comma, and parenthesis:^^ ^^
1125
1126 * SDMXprefix
1127 * SDMX-IM-package-name
1128 * class-name
1129 * agency-id
1130 * maintainedobject-id
1131 * maintainedobject-version
1132 * container-object-id [[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[8~]^^>>path:#_ftn8]]
1133 * object-id
1134
1135 The generic structure of the URN is the following:
1136
1137 SDMXprefix**.**SDMX-IM-package-name**.**class-name**=**agency-id**:**maintainedobject-id
1138
1139 **(**maintainedobject-version**).***container-object-id**.**object-id
1140
1141 The **SDMX prefix** is “urn:sdmx:org”, always the same for all SDMX artefacts.
1142
1143 The **SDMX-IM-package-name **is the concatenation of the string** **“sdmx.infomodel.” with the package-name which the artefact belongs to. For example, for referencing a dataflow the SDMX-IM-package-name is “sdmx.infomodel.datastructure”, because the class ,,Dataflow,, belongs to the package “datastructure”.
1144
1145 The **class-name** is the name of the SDMX object class which the SDMX object belongs to (e.g., for referencing a dataflow the class-name is “Dataflow”). The VTL can reference SDMX artefacts that belong to the classes ,,Dataflow, Dimension,,,
1146
1147 MeasureDimension, TimeDimension, PrimaryMeasure, DataAttribute, Concept, ConceptScheme, Codelist.
1148
1149 The **agency-id** is the acronym of the agency that owns the definition of the artefact, for example for the Eurostat artefacts the agency-id is “ESTAT”). The agency-id can be composite (for example AgencyA.Dept1.Unit2).
1150
1151 The **maintainedobject-id** is the name of the maintained object which the artefact belongs to, and in case the artefact itself is maintainable[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[9~]^^>>path:#_ftn9]](%%), coincides with the name of the artefact. Therefore the maintainedobject-id depends on the class of the artefact:
1152
1153 * if the artefact is a Dataflow, which is a maintainable class, the maintainedobject-id is the Dataflow name (dataflow-id);
1154 * if the artefact is a Dimension, MeasureDimension, TimeDimension, PrimaryMeasure or DataAttribute, which are not maintainable and belong to the DataStructure maintainable class, the maintainedobject-id is the name of the DataStructure (dataStructure-id) which the artefact belongs to;
1155 * if the artefact is a Concept, which is not maintainable and belongs to the ConceptScheme maintainable class, ,, ,,the maintainedobject-id is the name of the ConceptScheme (conceptScheme-id) which the artefact belongs to;
1156 * if the artefact is a ConceptScheme, which is a maintainable class, ,, ,,the maintainedobject-id is the name of the ConceptScheme (conceptScheme-id);
1157 * if the artefact is a Codelist, which is a maintainable class, the maintainedobject-id is the Codelist name (codelist-id).
1158
1159 The **maintainedobject-version** is the version of the maintained object which the artefact belongs to (for example, possible versions are 1.0, 2.1, 3.1.2).
1160
1161 The **container-object-id** does not apply to the classes that can be referenced in VTL transformations, therefore is not present in their URN
1162
1163 The **object-id** is the name of the non-maintainable artefact (when the artefact is maintainable its name is already specified as the maintainedobject-id, see above), in particular it has to be specified:
1164
1165 * if the artefact is a Dimension, MeasureDimension, TimeDimension, PrimaryMeasure or DataAttribute (the object-id is the name of one of the artefacts above, which are data structure components)
1166 * if the artefact is a Concept (the object-id is the name of the Concept)
1167
1168 For example, by using the URN, the VTL transformation that sums two SDMX dataflows DF1 and DF2 and assigns the result to a third persistent dataflow DFR, assuming that DF1, DF2 and DFR are the maintainedobject-id of the three dataflows, that their version is 1.0 and their Agency is AG, would be written as[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[10~]^^>>path:#_ftn10]](%%):
1169
1170 ‘urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=AG:DFR(1.0)’  <-
1171 ‘urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=AG:DF1(1.0)’  +
1172 ‘urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=AG:DF2(1.0)’
1173
1174 === 10.2.3 Abbreviation of the URN ===
1175
1176 The complete formulation of the URN described above is exhaustive but verbose, even for very simple statements. In order to reduce the verbosity through a simplified identifier and make the work of transformation definers easier, proper abbreviations of the URN are possible. Using this approach, the referenced artefacts remain intelligible in the VTL code by a human reader.
1177
1178 The URN can be abbreviated by omitting the parts that are not essential for the identification of the artefact or that can be deduced from other available information, including the context in which the invocation is made. The possible abbreviations are described below.
1179
1180 * The **SDMXPrefix** can be omitted for all the SDMX objects, because it is a prefixed string (urn:sdmx:org), always the same for SDMX objects.
1181 * The **SDMX-IM-package-name **can be omitted as well because it can be deduced from the class-name that follows it (the table of the SDMX-IM packages and classes that allows this deduction is in the SDMX 2.1 Standards - Section 5 - Registry Specifications, paragraph 6.2.3). In particular, considering the object classes of the artefacts that VTL can reference, the package is: 
1182 ** “datastructure” for the classes Dataflow, Dimension, MeasureDimension, TimeDimension, PrimaryMeasure, DataAttribute,
1183 ** “conceptscheme” for the classes Concept and ConceptScheme
1184 ** “codelist” for the class Codelist.
1185 * The **class-name** can be omitted as it can be deduced from the VTL invocation. In particular, starting from the VTL class of the invoked artefact (e.g. dataset, component, identifier, measure, attribute, variable, valuedomain), which is known given the syntax of the invoking VTL operator[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[11~]^^>>path:#_ftn11]](%%), the SDMX class can be deduced from the mapping rules between VTL and SDMX (see the section “Mapping between VTL and SDMX” hereinafter)[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[12~]^^>>path:#_ftn12]](%%).
1186 * If the **agency-id** is not specified, it is assumed by default equal to the agency-id of the TransformationScheme, UserDefinedOperatorScheme or RulesetScheme from which the artefact is invoked. For example, the agency-id can be omitted if it is the same as the invoking TransformationScheme and cannot be omitted if the artefact comes from another agency.[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[13~]^^>>path:#_ftn13]](%%) Take also into account that, according to the VTL consistency rules, the agency of the result of a Transformation must be the same as its TransformationScheme, therefore the agency-id can be omitted for all the results (left part of Transformation statements).
1187 * As for the **maintainedobject-id**, this is essential in some cases while in other cases it can be omitted: o if the referenced artefact is a Dataflow, which is a maintainable class, the maintainedobject-id is the dataflow-id and obviously cannot be omitted;
1188 ** if the referenced artefact is a Dimension, MeasureDimension, TimeDimension, PrimaryMeasure, DataAttribute, which are not maintainable and belong to the DataStructure maintainable class, the maintainedobject-id is the dataStructure-id and can be omitted, given that these components are always invoked within the invocation of a Dataflow, whose dataStructure-id can be deduced from the SDMX structural definitions;
1189 ** if the referenced artefact is a Concept, which is not maintainable and belong to the ConceptScheme maintainable class,,, ,,the maintained object is the conceptScheme-id and cannot be omitted;
1190 ** if the referenced artefact is a ConceptScheme, which is a,, ,,maintainable class,,, ,,the maintained object is the conceptScheme-id and obviously cannot be omitted;
1191 ** if the referenced artefact is a Codelist, which is a maintainable class, the maintainedobject-id is the codelist-id and obviously cannot be omitted.
1192 * When the maintainedobject-id is omitted, the **maintainedobject-version** is omitted too. When the maintainedobject-id is not omitted and the maintainedobject-version is omitted, the version 1.0 is assumed by default.,, ,,
1193 * As said, the **container-object-id** does not apply to the classes that can be referenced in VTL transformations, therefore is not present in their URN
1194 * The **object-id** does not exist for the artefacts belonging to the Dataflow, ConceptScheme and Codelist classes, while it exists and cannot be omitted for the artefacts belonging to the classes Dimension, MeasureDimension, TimeDimension, PrimaryMeasure, DataAttribute and Concept, as for them the object-id is the main identifier of the artefact
1195
1196 The simplified object identifier is obtained by omitting all the first part of the URN, including the special characters, till the first part not omitted.
1197
1198 For example, the full formulation that uses the complete URN shown at the end of the previous paragraph:
1199
1200 ‘urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=AG:DFR(1.0)’  :=
1201 ‘urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=AG:DF1(1.0)’   +
1202 ‘urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=AG:DF2(1.0)’
1203
1204 by omitting all the non-essential parts would become simply:
1205
1206 DFR := DF1 + DF2
1207
1208 The references to the Codelists can be simplified similarly. For example, given the non-abbreviated reference to the Codelist AG:CL_FREQ(1.0), which is[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[14~]^^>>path:#_ftn14]](%%):
1209
1210 ‘urn:sdmx:org.sdmx.infomodel.codelist.Codelist=AG:CL_FREQ(1.0)’
1211
1212 if the Codelist is referenced from a ruleset scheme belonging to the agency AG, omitting all the optional parts, the abbreviated reference would become simply[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[15~]^^>>path:#_ftn15]](%%):
1213
1214 CL_FREQ
1215
1216 As for the references to the components, it can be enough to specify the componentId, given that the dataStructure-Id can be omitted. An example of non-abbreviated reference, if the data structure is DST1 and the component is SECTOR, is the following:
1217
1218 ‘urn:sdmx:org.sdmx.infomodel.datastructure.DataStructure=AG:DST1(1.0).SECTOR’
1219
1220 The corresponding fully abbreviated reference, if made from a transformation scheme belonging to AG, would become simply:
1221
1222 SECTOR
1223
1224 For example, the transformation for renaming the component SECTOR of the dataflow DF1 into SEC can be written as[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[16~]^^>>path:#_ftn16]](%%):
1225
1226 ‘DFR(1.0)’ := ‘DF1(1.0)’ [rename SECTOR to SEC]
1227
1228 In the references to the Concepts, which can exist for example in the definition of the VTL Rulesets, at least the conceptScheme-id and the concept-id must be specified.
1229
1230 An example of non-abbreviated reference, if the conceptScheme-id is CS1 and the concept-id is SECTOR, is the following:
1231
1232 ‘urn:sdmx:org.sdmx.infomodel.conceptscheme.Concept=AG:CS1(1.0).SECTOR’
1233
1234 The corresponding fully abbreviated reference, if made from a RulesetScheme belonging to AG, would become simply:
1235
1236 CS1(1.0).SECTOR
1237
1238 The Codes and in general all the Values can be written without any other specification, for example, the transformation to check if the values of the measures of the dataflow DF1 are between 0 and 25000 can be written like follows:
1239
1240 ‘DFR(1.0)’ := between ( ‘DF1(1.0)’, 0, 25000 )
1241
1242 The artefact (component, concept, codelist …) which the Values are referred to can be deduced from the context in which the reference is made, taking also into account the VTL syntax. In the transformation above, for example, the values 0 and 2500 are compared to the values of the measures of DF1(1.0).
1243
1244 === 10.2.4 User-defined alias ===
1245
1246 The third possibility for referencing SDMX artefacts from VTL statements is to use user-defined aliases not related to the SDMX URN of the artefact.
1247
1248 This approach gives preference to the use of symbolic names for the SDMX artefacts. As a consequence, in the VTL code the referenced artefacts would become not directly intelligible by a human reader. In any case, the VTL aliases are associated to the SDMX URN through the VtlMappingScheme and VtlMapping classes. These classes provide for structured references to SDMX artefacts whatever kind of reference is used in VTL statements (URN, abbreviated URN or user-defined aliases).
1249
1250 === 10.2.5 References to SDMX artefacts from VTL Rulesets ===
1251
1252 The VTL Rulesets allow defining sets of reusable rules that can be applied by some
1253
1254 VTL operators, like the ones for validation and hierarchical roll-up. A “rule” consists in a relationship between Values belonging to some Value Domains or taken by some Variables, for example: (i) when the Country is USA then the Currency is USD; (ii) the Benelux is composed by Belgium, Luxembourg, Netherlands.
1255
1256 The VTL Rulesets have a signature, in which the Value Domains or the Variables on which the Ruleset is defined are declared, and a body, which contains the rules.
1257
1258 In the signature, given the mapping between VTL and SDMX better described in the following paragraphs, a reference to a VTL Value Domain becomes a reference to a SDMX Codelist or to a SDMX ConceptScheme (for SDMX measure dimensions), while a reference to a VTL Represented Variable becomes a reference to a SDMX Concept, assuming for it a definite representation[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[17~]^^>>path:#_ftn17]](%%).
1259
1260 In general, for referencing SDMX Codelists and Concepts, the conventions described in the previous paragraphs apply. In the Ruleset syntax, the elements that reference SDMX artefacts are called “valueDomain” and “variable” for the Datapoint Rulesets and “ruleValueDomain”, “ruleVariable”, “condValueDomain” “condVariable” for the Hierarchical Rulesets). The syntax of the Ruleset signature allows also to define aliases of the elements above, these aliases are valid only within the specific ruleset definition statement and cannot be mapped to SDMX.[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[18~]^^>>path:#_ftn18]](%%)
1261
1262 In the body of the Rulesets, the Codes and in general all the Values can be written without any other specification, because the artefact which the Values are referred (Codelist, ConceptScheme, Concept) to can be deduced from the Ruleset signature.
1263
1264 == 10.3 Mapping between SDMX and VTL artefacts ==
1265
1266 === 10.3.1 When the mapping occurs ===
1267
1268 The mapping methods between the VTL and SDMX object classes allow transforming a SDMX definition in a VTL one and vice-versa for the artefacts to be manipulated.
1269
1270 It should be remembered that VTL programs (i.e. Transformation Schemes) are represented in SDMX through the TransformationScheme maintainable class which is composed of Transformations (nameable artefacts). Each Transformation assigns the outcome of the evaluation of a VTL expression to a result: the input operands of the expression and the result can be SDMX artefacts.
1271
1272 Every time a SDMX object is referenced in a VTL Transformation as an input operand, there is the need to generate a VTL definition of the object, so that the VTL operations can take place. This can be made starting from the SDMX definition and applying a SDMX-VTL mapping method in the direction from SDMX to VTL. The possible mapping methods from SDMX to VTL are described in the following paragraphs and are conceived to allow the automatic deduction of the VTL definition of the object from the knowledge of the SDMX definition.
1273
1274 In the opposite direction, every time an object calculated by means of VTL must be treated as a SDMX object (for example for exchanging it through SDMX), there is the need of a SDMX definition of the object, so that the SDMX operations can take place. The SDMX definition is needed for the VTL objects for which a SDMX use is envisaged[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[19~]^^>>path:#_ftn19]](%%).
1275
1276 The mapping methods from VTL to SDMX are described in the following paragraphs as well, however they do not allow the complete SDMX definition to be automatically deduced from the VTL definition, more than all because the former typically contains additional information in respect to the latter. For example, the definition of a SDMX DSD includes also some mandatory information not available in VTL (like the concept scheme to which the SDMX components refer, the assignmentStatus and attributeRelationship for the DataAttributes and so on). Therefore the mapping methods from VTL to SDMX provide only a general guidance for generating SDMX definitions properly starting from the information available in VTL, independently of how the SDMX definition it is actually generated (manually, automatically or part and part).
1277
1278 === 10.3.2 General mapping of VTL and SDMX data structures ===
1279
1280 This section makes reference to the VTL “Model for data and their structure”[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[20~]^^>>path:#_ftn20]](%%) and the correspondent SDMX “Data Structure Definition”[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[21~]^^>>path:#_ftn21]](%%).
1281
1282 The main type of artefact that the VTL can manipulate is the VTL Data Set, which in general is mapped to the SDMX Dataflow. This means that a VTL Transformation, in the SDMX context, expresses the algorithm for calculating a derived Dataflow starting from some already existing Dataflows (either collected or derived).[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[22~]^^>>path:#_ftn22]](%%)
1283
1284 While the VTL Transformations are defined in term of Dataflow definitions, they are assumed to be executed on instances of such Dataflows, provided at runtime to the VTL engine (the mechanism for identifying the instances to be processed are not part of the VTL specifications and depend on the implementation of the VTL-based systems). As already said, the SDMX Datasets are instances of SDMX Dataflows, therefore a VTL Transformation defined on some SDMX Dataflows can be applied on some corresponding SDMX Datasets.
1285
1286 A VTL Data Set is structured by one and just one Data Structure and a VTL Data Structure can structure any number of Data Sets. Correspondingly, in the SDMX context a SDMX Dataflow is structured by one and just one DataStructureDefinition and one DataStructureDefinition can structure any number of Dataflows.
1287
1288 A VTL Data Set has a Data Structure made of Components, which in turn can be Identifiers, Measures and Attributes. Similarly, a SDMX DataflowDefinition has a DataStructureDefinition made of components that can be DimensionComponents, PrimaryMeasure and DataAttributes. In turn, a SDMX DimensionComponent can be a Dimension, a TimeDimension or a MeasureDimension. Correspondingly, in the SDMX implementation of the VTL, the VTL Identifiers can be (optionally) distinguished in three sub-classes (Simple Identifier, Time Identifier, Measure Identifier) even if such a distinction is not evidenced in the VTL IM.
1289
1290 However, a VTL Data Structure can have any number of Identifiers, Measures and Attributes, while a SDMX 2.1 DataStructureDefinition can have any number of Dimensions and DataAttributes but just one PrimaryMeasure[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[23~]^^>>path:#_ftn23]](%%). This is due to a difference between SDMX 2.1 and VTL in the possible representation methods of the data that contain more measures.
1291
1292 As for SDMX, because the data structure cannot contain more than one measure component (i.e., the primaryMeasure), the representation of data having more measures is possible only by means of a particular dimension, called MeasureDimension, which is aimed at containing the name of the measure concepts, so that for each observation the value contained in the PrimaryMeasure component is the value of the measure concept reported in the MeasureDimension component.
1293
1294 Instead VTL allows either the method above (an identifier containing the name of the measure together with just one measure component) or a more generic method that consists in defining more measure components in the data structure, one for each measure.
1295
1296 Therefore for multi-measure data more mapping options are possible, as described in more detail in the following sections.
1297
1298 === 10.3.3 Mapping from SDMX to VTL data structures ===
1299
1300 ==== 10.3.3.1 Basic Mapping** ** ====
1301
1302 The main mapping method from SDMX to VTL is called **Basic **mapping. This is considered as the default mapping method and is applied unless a different method is specified through the VtlMappingScheme and VtlDataflowMapping classes.
1303
1304 When transforming **from SDMX to VTL**, this method consists in leaving the components unchanged and maintaining their names and roles, according to the following table:
1305
1306 (% style="width:636.294px" %)
1307 |(% style="width:286px" %)**SDMX**|(% style="width:347px" %)**VTL**
1308 |(% style="width:286px" %)Dimension|(% style="width:347px" %)(Simple) Identifier
1309 |(% style="width:286px" %)Time Dimension|(% style="width:347px" %)(Time) Identifier
1310 |(% style="width:286px" %)Measure Dimension|(% style="width:347px" %)(Measure) Identifier
1311 |(% style="width:286px" %)Primary Measure|(% style="width:347px" %)Measure
1312 |(% style="width:286px" %)Data Attribute|(% style="width:347px" %)Attribute
1313
1314 According to this method, the resulting VTL structures are always mono-measure (i.e., they have just one measure component) and their Measure is the SDMX PrimaryMeasure. Nevertheless, if the SDMX data structure has a MeasureDimension, which can convey the name of one or more measure concepts, such unique measure component can contain the value of more (conceptual) measures (one for each observation).
1315
1316 As for the SDMX DataAttributes, in VTL they are all considered “at data point / observation level” (i.e. dependent on all the VTL Identifiers), because VTL does not have the SDMX AttributeRelationships, which defines the construct to which the DataAttribute is related (e.g. observation, dimension or set or group of dimensions, whole data set).
1317
1318 With the Basic mapping, one SDMX observation generates one VTL data point.
1319
1320 ==== 10.3.3.2 Pivot Mapping ====
1321
1322 An alternative mapping method from SDMX to VTL is the **Pivot **mapping, which is different from the Basic method only for the SDMX data structures that contain a MeasureDimension, which are mapped to multi-measure VTL data structures.
1323
1324 The SDMX structures that do not contain a MeasureDimension are mapped like in the Basic mapping (see the previous paragraph).
1325
1326 The SDMX structures that contain a MeasureDimension are mapped as follows (this mapping is equivalent to a pivoting operation):
1327
1328 * A SDMX simple dimension becomes a VTL (simple) identifier and a SDMX TimeDimension becomes a VTL (time) identifier;
1329 * Each possible Concept Cj of the SDMX MeasureDimension is mapped to a VTL Measure, having the same name as the SDMX Concept (i.e. Cj); the VTL Measure Cj is a new VTL component even if the SDMX data structure has not such a Component;
1330 * The SDMX MeasureDimension is not mapped to VTL (it disappears in the VTL Data Structure);
1331 * The SDMX PrimaryMeasure is not mapped to VTL as well (it disappears in the VTL Data Structure);
1332 * A SDMX DataAttribute is mapped in different ways according to its AttributeRelationship:
1333 ** If, according to the SDMX AttributeRelationship, the values of the DataAttribute do not depend on the values of the MeasureDimension, the SDMX DataAttribute becomes a VTL Attribute having the same name. This happens if the AttributeRelationship is not specified (i.e. the DataAttribute does not depend on any DimensionComponent and therefore is at data set level), or if it refers to a set (or a group) of dimensions which does not include the MeasureDimension;
1334 ** Otherwise if, according to the SDMX AttributeRelationship, the values of the DataAttribute depend on the MeasureDimension, the SDMX DataAttribute is mapped to one VTL Attribute for each possible Concept of the SDMX MeasureDimension; by default, the names of the VTL Attributes are obtained by concatenating the name of the SDMX DataAttribute and the names of the correspondent
1335
1336 Concept of the MeasureDimension separated by underscore; for example, if the SDMX DataAttribute is named DA and the possible concepts of the SDMX MeasureDimension are named C1, C2, …, Cn, then the corresponding VTL Attributes will be named DA_C1, DA_C2, …, DA_Cn (if different names are desired, they can be achieved afterwards by renaming the Attributes through VTL operators). o Like in the Basic mapping, the resulting VTL Attributes are considered as dependent on all the VTL identifiers (i.e. “at data point / observation level”), because VTL does not have the SDMX notion of Attribute Relationship.
1337
1338 The summary mapping table of the “pivot” mapping from SDMX to VTL for the SDMX data structures that contain a MeasureDimension is the following:
1339
1340 (% style="width:941.294px" %)
1341 |(% style="width:441px" %)**SDMX**|(% style="width:497px" %)**VTL**
1342 |(% style="width:441px" %)Dimension|(% style="width:497px" %)(Simple) Identifier
1343 |(% style="width:441px" %)TimeDimension|(% style="width:497px" %)(Time) Identifier
1344 |(% style="width:441px" %)MeasureDimension & PrimaryMeasure|(% style="width:497px" %)One Measure for each Concept of the SDMX Measure Dimension
1345 |(% style="width:441px" %)DataAttribute not depending on the MeasureDimension|(% style="width:497px" %)Attribute
1346 |(% style="width:441px" %)DataAttribute depending on the MeasureDimension|(% style="width:497px" %)One Attribute for each Concept of the SDMX Measure Dimension
1347
1348 Using this mapping method, the components of the data structure can change in the conversion from SDMX to VTL and it must be taken into account that the VTL statements can reference only the components of the resulting VTL data structure.
1349
1350 At observation / data point level, calling Cj (j=1, … n) the j^^th^^ Concept of the MeasureDimension:
1351
1352 * The set of SDMX observations having the same values for all the Dimensions except than the MeasureDimension become one multi-measure VTL Data Point, having one Measure for each Concept Cj of the SDMX MeasureDimension;
1353 * The values of the SDMX simple Dimensions, TimeDimension and DataAttributes not depending on the MeasureDimension (these components by definition have always the same values for all the observations of the set above) become the values of the corresponding VTL (simple) Identifiers, (time) Identifier and Attributes.
1354 * The value of the PrimaryMeasure of the SDMX observation belonging to the set above and having MeasureDimension=Cj becomes the value of the VTL Measure Cj
1355 * For the SDMX DataAttributes depending on the MeasureDimension, the value of the DataAttribute DA of the SDMX observation belonging to the set above and having MeasureDimension=Cj becomes the value of the VTL Attribute DA_Cj
1356
1357 ==== 10.3.3.3 From SDMX DataAttributes to VTL Measures ====
1358
1359 * In some cases it may happen that the DataAttributes of the SDMX DataStructure need to be managed as Measures in VTL. Therefore, a variant of both the methods above consists in transforming all the SDMX DataAttributes in VTL Measures. When DataAttributes are converted to Measures, the two methods above are called Basic_A2M and Pivot_A2M (the suffix “A2M” stands for Attributes to Measures). Obviously, the resulting VTL data structure is, in general, multi-measure and does not contain Attributes.
1360
1361 The Basic_A2M and Pivot_A2M behaves respectively like the Basic and Pivot methods, except that the final VTL components, which according to the Basic and Pivot methods would have had the role of Attribute, assume instead the role of Measure.
1362
1363 Proper VTL features allow changing the role of specific attributes even after the SDMX to VTL mapping: they can be useful when only some of the DataAttributes need to be managed as VTL Measures.
1364
1365 === 10.3.4 Mapping from VTL to SDMX data structures ===
1366
1367 ==== 10.3.4.1 Basic Mapping** ** ====
1368
1369 The main mapping method **from VTL to SDMX** is called **Basic **mapping as well.
1370
1371 This is considered as the default mapping method and is applied unless a different method is specified through the VtlMappingScheme and VtlDataflowMapping classes.
1372
1373 The method consists in leaving the components unchanged and maintaining their names and roles in SDMX, according to the following mapping table, which is the same as the basic mapping from SDMX to VTL, only seen in the opposite direction.
1374
1375 This mapping method cannot be applied for SDMX 2.1 if the VTL data structure has more than one measure component, given that the SDMX 2.1 DataStructureDefinition allows just one measure component (the PrimaryMeasure). In this case it becomes mandatory to specify a different mapping method through the VtlMappingScheme and VtlDataflowMapping classes.[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[24~]^^>>path:#_ftn24]](%%)
1376
1377 Please note that the VTL measures can have any name while in SDMX 2.1 the MeasureComponent has the mandatory name “obs_value”, therefore the name of the VTL measure name must become “obs_value” in SDMX 2.1.
1378
1379 Mapping table:
1380
1381 (% style="width:592.294px" %)
1382 |(% style="width:253px" %)**VTL**|(% style="width:336px" %)**SDMX**
1383 |(% style="width:253px" %)(Simple) Identifier|(% style="width:336px" %)Dimension
1384 |(% style="width:253px" %)(Time) Identifier|(% style="width:336px" %)TimeDimension
1385 |(% style="width:253px" %)(Measure) Identifier|(% style="width:336px" %)MeasureDimension
1386 |(% style="width:253px" %)Measure|(% style="width:336px" %)PrimaryMeasure
1387 |(% style="width:253px" %)Attribute|(% style="width:336px" %)DataAttribute
1388
1389 If the distinction between simple identifier, time identifier and measure identifier is not maintained in the VTL environment, the classification between Dimension, TimeDimension and MeasureDimension exists only in SDMX, as declared in the relevant DataStructureDefinition.
1390
1391 Regarding the Attributes, because VTL considers all of them “at observation level”, the corresponding SDMX DataAttributes should be put “at observation level” as well (AttributeRelationships referred to the PrimaryMeasure), unless some other information about their AttributeRelationship is available.
1392
1393 Note that the basic mappings in the two directions (from SDMX 2.1 to VTL 2.0 and vice-versa) are (almost completely) reversible. In fact, if a SDMX 2.1 structure is mapped to a VTL structure and then the latter is mapped back to SDMX 2.1, the resulting data structure is like the original one (apart for the AttributeRelationship, that can be different if the original SDMX 2.1 structure contains DataAttributes that are not at observation level). In reverse order, if a VTL 2.0 mono-measure structure is mapped to SDMX 2.1 and then the latter is mapped back to VTL 2.0, the original data structure is obtained (apart from the name of the VTL measure, that in SDMX 2.1 must become “obs_value”).
1394
1395 As said, the resulting SDMX definitions must be compliant with the SDMX consistency rules. For example, the SDMX DSD must have the assignmentStatus, which does not exist in VTL, the AttributeRelationship for the DataAttributes and so on.
1396
1397 ==== 10.3.4.2 Unpivot Mapping ====
1398
1399 An alternative mapping method from VTL to SDMX is the **Unpivot **mapping.
1400
1401 Although this mapping method can be used in any case, it makes major sense in case the VTL data structure has more than one measure component (multi-measures VTL structure). For such VTL structures, in fact, the basic method cannot be applied, given that by maintaining the data structure unchanged the resulting SDMX data structure would have more than one measure component, which is not allowed by SDMX 2.1 (it allows just one measure component, the PrimaryMeasure, called “obs_value”).
1402
1403 The multi-measures VTL structures have not a Measure Identifier (because the Measures are separate components) and need to be converted to SDMX dataflows having an added MeasureDimension which disambiguates the multiple measures, and an added PrimaryMeasure, in which the measures’ values are maintained.
1404
1405 The **unpivot** mapping behaves like follows:
1406
1407 * like in the basic mapping, a VTL (simple) identifier becomes a SDMX
1408
1409 Dimension and a VTL (time) identifier becomes a SDMX TimeDimension (as said, a measure identifier cannot exist in multi-measure VTL structures);
1410
1411 * a MeasureDimension component called “measure_name” is added to the SDMX DataStructure;
1412 * a PrimaryMeasure component called “obs_value” is added to the SDMX DataStructure;
1413 * each VTL Measure is mapped to a Concept of the SDMX MeasureDimension having the same name as the VTL Measure (therefore all the VTL Measure Components do not originate Components in the SDMX DataStructure);
1414 * a VTL Attribute becomes a SDMX DataAttribute having AttributeRelationship referred to all the SDMX DimensionComponents including the TimeDimension and except the MeasureDimension.
1415
1416 The summary mapping table of the **unpivot** mapping method is the following:
1417
1418 (% style="width:904.294px" %)
1419 |(% style="width:291px" %)**VTL**|(% style="width:611px" %)**SDMX**
1420 |(% style="width:291px" %)(Simple) Identifier|(% style="width:611px" %)Dimension
1421 |(% style="width:291px" %)(Time) Identifier|(% style="width:611px" %)TimeDimension
1422 |(% style="width:291px" %)All Measure Components|(% style="width:611px" %)(((
1423 MeasureDimension (having one Measure Concept for each VTL measure component) & PrimaryMeasure
1424 )))
1425 |(% style="width:291px" %)Attribute |(% style="width:611px" %)(((
1426 DataAttribute depending on all SDMX Dimensions including the TimeDimension and except the MeasureDimension
1427 )))
1428
1429 At observation / data point level:
1430
1431 * a multi-measure VTL Data Point becomes a set of SDMX observations, one for each VTL measure
1432 * the values of the VTL identifiers become the values of the corresponding SDMX Dimensions, for all the observations of the set above
1433 * the name of the j^^th^^ VTL measure (e.g. “Cj”) becomes the value of the SDMX MeasureDimension of the j^^th^^ observation of the set (i.e. the Concept Cj)
1434 * the value of the j^^th^^ VTL measure becomes the value of the SDMX PrimaryMeasure of the j^^th^^ observation of the set
1435 * the values of the VTL Attributes become the values of the corresponding SDMX DataAttributes (in principle for all the observations of the set above)
1436
1437 If desired, this method can be applied also to mono-measure VTL structures, provided that none of the VTL components has already the role of measure identifier.
1438
1439 Like in the general case, a MeasureDimension component called “measure_name” would be added to the SDMX DataStructure and would have just one possible measure concept, corresponding to the unique VTL measure. The original VTL measure component would not become a Component in the SDMX data structure. The value of the VTL measure would be assigned to the SDMX PrimaryMeasure called “obs_value”.
1440
1441 In any case, the resulting SDMX definitions must be compliant with the SDMX consistency rules. For example, the possible Concepts of the SDMX MeasureDimension need to be listed in a SDMX ConceptScheme, with proper id, agency and version; moreover, the SDMX DSD must have the assignmentStatus, which does not exist in VTL, the attributeRelationship for the DataAttributes and so on.
1442
1443 ==== 10.3.4.3 From VTL Measures to SDMX Data Attributes** ** ====
1444
1445 For the multi-measure VTL structures (having more than one Measure Component), it may happen that the Measures of the VTL Data Structure need to be managed as DataAttributes in SDMX. Therefore a third mapping method consists in transforming one VTL measure in the SDMX primaryMeasure and all the other VTL Measures in SDMX DataAttributes. This method is called M2A (“M2A” stands for “Measures to DataAttributes”).
1446
1447 When applied to mono-measure VTL structures (having one Measure component), the M2A method behaves like the Basic mapping (the VTL Measure component becomes the SDMX primary measure “obs_value”, there is no additional VTL measure to be converted to SDMX DataAttribute). Therefore the mapping table is the same as for the Basic method:
1448
1449 (% style="width:591.294px" %)
1450 |(% style="width:252px" %)**VTL**|(% style="width:336px" %)**SDMX**
1451 |(% style="width:252px" %)(Simple) Identifier|(% style="width:336px" %)Dimension
1452 |(% style="width:252px" %)(Time) Identifier|(% style="width:336px" %)TimeDimension
1453 |(% style="width:252px" %)(Measure) Identifier (if any)|(% style="width:336px" %)MeasureDimension
1454 |(% style="width:252px" %)Measure|(% style="width:336px" %)PrimaryMeasure
1455 |(% style="width:252px" %)Attribute|(% style="width:336px" %)DataAttribute
1456
1457 For multi-measure VTL structures (having more than one Measure component), one VTL Measure becomes the SDMX PrimaryMeasure while the other VTL Measures maintain their names and values but assume the role of DataAttribute in SDMX. The choice of the VTL Measure that correspond to the SDMX PrimaryMeasure is left to the definer of the SDMX data structure definition.
1458
1459 Taking into account that the multi-measure VTL structures do not have a measure identifier, the mapping table is the following:
1460
1461 (% style="width:588.294px" %)
1462 |(% style="width:259px" %)**VTL**|(% style="width:326px" %)**SDMX**
1463 |(% style="width:259px" %)(Simple) Identifier|(% style="width:326px" %)Dimension
1464 |(% style="width:259px" %)(Time) Identifier|(% style="width:326px" %)TimeDimension
1465 |(% style="width:259px" %)One of the Measures|(% style="width:326px" %)PrimaryMeasure
1466 |(% style="width:259px" %)Other Measures|(% style="width:326px" %)DataAttribute
1467 |(% style="width:259px" %)Attribute|(% style="width:326px" %)DataAttribute
1468
1469 Even in this case, the resulting SDMX definitions must be compliant with the SDMX consistency rules. For example, the SDMX DSD must have the assignmentStatus, which does not exist in VTL, the attributeRelationship for the DataAttributes and so on. In particular, the primaryMeasure of the SDMX 2.1 DSD must be called “obs_value” and must be one of the VTL Measures, chosen by the DSD definer.
1470
1471 === 10.3.5 Declaration of the mapping methods between data structures ===
1472
1473 In order to define and understand properly VTL transformations, the applied mapping methods must be specified in the SDMX structural metadata. If the default mapping method (Basic) is applied, no specification is needed.
1474
1475 A customized mapping can be defined through the VtlMappingScheme and VtlDataflowMapping classes (see the section of the SDMX IM relevant to the VTL). A VtlDataflowMapping allows specifying the mapping methods to be used for a specific dataflow, both in the direction from SDMX to VTL (toVtlMappingMethod) and from VTL to SDMX (fromVtlMappingMethod); in fact a VtlDataflowMapping associates the structured URN that identifies a SDMX dataflow to its VTL alias and its mapping methods.
1476
1477 It is possible to specify the toVtlMappingMethod and fromVtlMappingMethod also for the conventional dataflow called “generic_dataflow”: in this case the specified mapping methods are intended to become the default ones, overriding the “Basic” methods. In turn, the toVtlMappingMethod and fromVtlMappingMethod declared for a specific Dataflow are intended to override the default ones for such a Dataflow.
1478
1479 The VtlMappingScheme is a container for zero or more VtlDataflowMapping (besides possible mappings to artefacts other than dataflows).
1480
1481 === 10.3.6 Mapping dataflow subsets to distinct VTL data sets[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^**~[25~]**^^>>path:#_ftn25]](%%) ===
1482
1483 Until now it as been assumed to map one SMDX Dataflow to one VTL dataset and vice-versa. This mapping one-to-one is not mandatory according to VTL because a VTL data set is meant to be a set of observations (data points) on a logical plane, having the same logical data structure and the same general meaning, independently of the possible physical representation or storage (see VTL 2.0 User Manual page 24), therefore a SDMX Dataflow can be seen either as a unique set of data observations (corresponding to one VTL data set) or as the union of many sets of data observations (each one corresponding to a distinct VTL data set).
1484
1485 As a matter of fact, in some cases it can be useful to define VTL operations involving definite parts of a SDMX Dataflow instead than the whole.[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[26~]^^>>path:#_ftn26]](%%)
1486
1487 Therefore, in order to make the coding of VTL operations simpler when applied on parts of SDMX Dataflows, it is allowed to map distinct parts of a SDMX Dataflow to distinct VTL data sets according to the following rules and conventions. This kind of mapping is possible both from SDMX to VTL and from VTL to SDMX, as better explained below.[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[27~]^^>>path:#_ftn27]](%%)
1488
1489 Given a SDMX Dataflow and some predefined Dimensions of its DataStructure, it is allowed to map the subsets of observations that have the same combination of values for such Dimensions to correspondent VTL datasets.
1490
1491 For example, assuming that the SDMX dataflow DF1(1.0) has the Dimensions INDICATOR, TIME_PERIOD and COUNTRY, and that the user declares the Dimensions INDICATOR and COUNTRY as basis for the mapping (i.e. the mapping dimensions): the observations that have the same values for INDICATOR and COUNTRY would be mapped to the same VTL dataset (and vice-versa).
1492
1493 In practice, this kind mapping is obtained like follows:
1494
1495 * For a given SDMX dataflow, the user (VTL definer) declares the dimension components on which the mapping will be based, in a given order.[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[28~]^^>>path:#_ftn28]](%%) Following the example above, imagine that the user declares the dimensions INDICATOR and COUNTRY.
1496 * The VTL dataset is given a name using a special notation also called “ordered concatenation” and composed of the following parts: 
1497 ** The reference to the SDMX dataflow (expressed according to the rules described in the previous paragraphs, i.e. URN, abbreviated URN or another alias); for example DF(1.0);
1498 ** a slash (“/”) as a separator; [[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[29~]^^>>path:#_ftn29]]
1499 ** The reference to a specific part of the SDMX dataflow above, expressed as the concatenation of the values that the SDMX dimensions declared above must have, separated by dots (“.”) and written in the order in which these dimensions are defined[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[30~]^^>>path:#_ftn30]](%%). For example POPULATION.USA would mean that such a VTL dataset is mapped to the SDMX observations for which the dimension //INDICATOR// is equal to POPULATION and the dimension //COUNTRY// is equal to USA.
1500
1501 In the VTL transformations, this kind of dataset name must be referenced between single quotes because the slash (“/”) is not a regular character according to the VTL rules.
1502
1503 Therefore, the generic name of this kind of VTL datasets would be:
1504
1505 > ‘DF(1.0)///INDICATORvalue//.//COUNTRYvalue//’
1506
1507 Where DF(1.0) is the Dataflow and //INDICATORvalue// and //COUNTRYvalue //are placeholders for one value of the INDICATOR and // //COUNTRY dimensions.
1508
1509 Instead the specific name of one of these VTL datasets would be:
1510
1511 > ‘DF(1.0)/POPULATION.USA’
1512
1513 In particular, this is the VTL dataset that contains all the observations of the dataflow DF(1.0) for which //INDICATOR// = POPULATION and //COUNTRY// = USA.
1514
1515 Let us now analyse the different meaning of this kind of mapping in the two mapping directions, i.e. from SDMX to VTL and from VTL to SDMX.
1516
1517 As already said, the mapping from SDMX to VTL happens when the VTL datasets are operand of VTL transformations, instead the mapping from VTL to SDMX happens when the VTL datasets are result of VTL transformations[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[31~]^^>>path:#_ftn31]](%%) and need to be treated as SDMX objects. This kind of mapping can be applied independently in the two directions and the Dimensions on which the mapping is based can be different in the two directions: these Dimensions are defined in the ToVtlSpaceKey and in the FromVtlSpaceKey classes respectively.
1518
1519 First, let us see what happens in the__ mapping direction from SDMX to VTL__, i.e. when parts of a SDMX dataflow (e.g. DF1(1.0)) need to be mapped to distinct VTL datasets that are operand of some VTL transformations.
1520
1521 As already said, each VTL dataset is assumed to contain all the observations of the SDMX dataflow having INDICATOR=//INDICATORvalue //and COUNTRY=//COUNTRYvalue//. For example, the VTL dataset ‘DF1(1.0)/POPULATION.USA’ would contain all the observations of DF1(1.0) having INDICATOR = POPULATION and COUNTRY = USA.
1522
1523 In order to obtain the data structure of these VTL datasets from the SDMX one, it is assumed that the SDMX dimensions on which the mapping is based are dropped, i.e. not maintained in the VTL data structure; this is possible because their values are fixed for each one of the invoked VTL datasets[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[32~]^^>>path:#_ftn32]](%%). After that, the mapping method from SDMX to VTL specified for the dataflow DF1(1.0) is applied (i.e. basic, pivot …).
1524
1525 In the example above, for all the datasets of the kind ‘DF1(1.0)///INDICATORvalue//.//COUNTRYvalue//’, the dimensions INDICATOR and COUNTRY would be dropped so that the data structure of all the resulting VTL data sets would have the identifier TIME_PERIOD only.
1526
1527 It should be noted that the desired VTL datasets (i.e. of the kind ‘DF1(1.0)/// INDICATORvalue//.//COUNTRYvalue//’) can be obtained also by applying the VTL operator “**sub**” (subspace) to the dataflow DF1(1.0), like in the following VTL expression:
1528
1529 > ‘DF1(1.0)/POPULATION.USA’ :=
1530 > DF1(1.0) [ sub INDICATOR=“POPULATION”, COUNTRY=“USA” ];
1531 > ‘DF1(1.0)/POPULATION.CANADA’ :=
1532 > DF1(1.0) [ sub INDICATOR=“POPULATION”, COUNTRY=“CANADA” ];
1533 > …   …   …
1534
1535 In fact the VTL operator “sub” has exactly the same behaviour. Therefore, mapping different parts of a SDMX dataflow to different VTL datasets in the direction from SDMX to VTL through the ordered concatenation notation is equivalent to a proper use of the operator “**sub**” on such a dataflow. [[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[33~]^^>>path:#_ftn33]]
1536
1537 In the direction from SDMX to VTL it is allowed to omit the value of one or more Dimensions on which the mapping is based, but maintaining all the separating dots (therefore it may happen to find two or more consecutive dots and dots in the beginning or in the end). The absence of value means that for the corresponding Dimension all the values are kept and the Dimension is not dropped.
1538
1539 For example, ‘DF(1.0)/POPULATION.’ (note the dot in the end of the name) is the VTL dataset that contains all the observations of the dataflow DF(1.0) for which //INDICATOR// = POPULATION and COUNTRY = any value.
1540
1541 This is equivalent to the application of the VTL “sub” operator only to the identifier //INDICATOR//:
1542
1543 > ‘DF1(1.0)/POPULATION.’ := 
1544 > DF1(1.0) [sub INDICATOR=“POPULATION” ];
1545
1546 Therefore the VTL dataset ‘DF1(1.0)/POPULATION.’ would have the identifiers COUNTRY and TIME_PERIOD.
1547
1548 Heterogeneous invocations of the same Dataflow are allowed, i.e. omitting different Dimensions in different invocations.
1549
1550 Let us now analyse the __mapping direction from VTL to SDMX__.
1551
1552 In this situation, distinct parts of a SDMX dataflow are calculated as distinct VTL datasets, under the constraint that they must have the same VTL data structure.
1553
1554 For example, let us assume that the VTL programmer wants to calculate the SDMX dataflow DF2(1.0) having the Dimensions TIME_PERIOD, INDICATOR, and COUNTRY and that such a programmer finds it convenient to calculate separately the parts of DF2(1.0) that have different combinations of values for INDICATOR and COUNTRY:
1555
1556 * each part is calculated as a VTL derived dataset, result of a dedicated VTL transformation; [[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[34~]^^>>path:#_ftn34]](%%)
1557 * the data structure of all these VTL datasets has the TIME_PERIOD identifier and does not have the INDICATOR and COUNTRY identifiers.[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[35~]^^>>path:#_ftn35]]
1558
1559 Under these hypothesis, such derived VTL datasets can be mapped to DF2(1.0) by declaring the Dimensions INDICATOR and COUNTRY as mapping dimensions[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[36~]^^>>path:#_ftn36]](%%).
1560
1561 The corresponding VTL transformations, assuming that the result needs to be persistent, would be of this kind:^^ ^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[37~]^^>>path:#_ftn37]]
1562
1563 ‘DF2(1.0)///INDICATORvalue//.//COUNTRYvalue//’  <-  expression
1564
1565 Some examples follow, for some specific values of INDICATOR and COUNTRY:
1566
1567 ‘DF2(1.0)/GDPPERCAPITA.USA’  <-   expression11;
1568 ‘DF2(1.0)/GDPPERCAPITA.CANADA’   <-   expression12;
1569 …   …   …
1570 ‘DF2(1.0)/POPGROWTH.USA’  <-   expression21;
1571 ‘DF2(1.0)/POPGROWTH.CANADA’  <-   expression22;
1572
1573 …   …   …
1574
1575 As said, it is assumed that these VTL derived datasets have the TIME_PERIOD as the only identifier. In the mapping from VTL to SMDX, the Dimensions INDICATOR and COUNTRY are added to the VTL data structure on order to obtain the SDMX one, with the following values respectively:
1576
1577 [[image:1747859458410-183.png||height="170" width="663"]]
1578
1579 It should be noted that the application of this many-to-one mapping from VTL to SDMX is equivalent to an appropriate sequence of VTL Transformations. These use the VTL operator “calc” to add the proper VTL identifiers (in the example, INDICATOR and COUNTRY) and to assign to them the proper values and the operator “union” in order to obtain the final VTL dataset (in the example DF2(1.0)), that can be mapped one-to-one to the homonymous SDMX Dataflow. Following the same example, these VTL transformations would be:
1580
1581 [[image:1747859612718-454.png||height="451" width="602"]]
1582
1583 In other words, starting from the datasets explicitly calculated through VTL (in the example ‘DF2(1.0)/GDPPERCAPITA.USA’ and so on), the first step consists in calculating other (non-persistent) VTL datasets (in the example DF2bis_GDPPERCAPITA_USA and so on) by adding the identifiers INDICATOR and COUNTRY with the desired values (//INDICATORvalue// and //COUNTRYvalue)//. Finally, all these non-persistent data sets are united and give the final result DF2(1.0)[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[38~]^^>>path:#_ftn38]](%%), which can be mapped one-to-one to the homonymous SDMX dataflow having the dimension components TIME_PERIOD, INDICATOR and COUNTRY.
1584
1585 Therefore, mapping different VTL datasets having the same data structure to different parts of a SDMX dataflow, i.e. in the direction from VTL to SDMX, through the ordered concatenation notation is equivalent to a proper use of the operators “calc” and “union” on such datasets. [[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[39~]^^>>path:#_ftn39]](%%)[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[40~]^^>>path:#_ftn40]]
1586
1587 It is worth noting that in the direction from VTL to SDMX it is mandatory to specify the value for every Dimension on which the mapping is based (in other word, in the name of the calculated VTL dataset is not possible to omit the value of some of the Dimensions).
1588
1589 === 10.3.7 Mapping variables and value domains between VTL and SDMX ===
1590
1591 With reference to the VTL “model for Variables and Value domains”, the following additional mappings have to be considered:
1592
1593 (% style="width:890.835px" %)
1594 |(% style="width:314px" %)VTL|(% style="width:574px" %)SDMX
1595 |(% style="width:314px" %)**Data Set Component**|(% style="width:574px" %)Although this abstraction exists in SDMX, it does not have an explicit definition and correspond to a Component (either a Dimension or a PrimaryMeasure or a DataAttribute) belonging to one specific Dataflow^^42^^
1596 |(% style="width:314px" %)**Represented Variable**|(% style="width:574px" %)**Concept** with a definite Representation
1597 |(% style="width:314px" %)**Value Domain**|(% style="width:574px" %)**Representation** (see the Structure Pattern in the Base Package)
1598 |(% style="width:314px" %)**Enumerated Value Domain / Code List**|(% style="width:574px" %)(((
1599 **Codelist** (for enumerated Dimension, PrimaryMeasure, DataAttribute) or **ConceptScheme **(for MeasureDimension)
1600 )))
1601 |(% style="width:314px" %)**Code**|(% style="width:574px" %)**Code** (for enumerated Dimension, PrimaryMeasure, DataAttribute) or **Concept** (for MeasureDimension)
1602 |(% style="width:314px" %)**Described Value Domain**|(% style="width:574px" %)(((
1603 non-enumerated** Representation **(having Facets / ExtendedFacets, see the Structure Pattern in the Base Package)
1604 )))
1605 |(% style="width:314px" %)**Value**|(% style="width:574px" %)(((
1606 Although this abstraction exists in SDMX, it does not have an explicit definition and correspond to a **Code** of a Codelist (for enumerated Representations) or to a valid **value **(for non-enumerated** **Representations) or to a **Concept **(for MeasureDimension)
1607 )))
1608 |(% style="width:314px" %)**Value Domain Subset / Set**|(% style="width:574px" %)This abstraction does not exist in SDMX
1609 |(% style="width:314px" %)**Enumerated Value Domain Subset / Enumerated Set**|(% style="width:574px" %)This abstraction does not exist in SDMX
1610 |(% style="width:314px" %)**Described Value Domain Subset / Described Set**|(% style="width:574px" %)This abstraction does not exist in SDMX
1611 |(% style="width:314px" %)**Set list**|(% style="width:574px" %)This abstraction does not exist in SDMX
1612
1613 The main difference between VTL and SDMX relies on the fact that the VTL artefacts for defining subsets of Value Domains do not exist in SDMX, therefore the VTL features for referring to predefined subsets are not available in SDMX. These artefacts are the Value Domain Subset (or Set), either enumerated or described, the Set List (list of values belonging to enumerated subsets) and the Data Set Component (aimed at defining the set of values that the Component of a Data Set can take, possibly a subset of the codes of Value Domain).
1614
1615 Another difference consists in the fact that all Value Domains are considered as identifiable objects in VTL either if enumerated or not, while in SDMX the Codelist (corresponding to a VTL enumerated Value Domain) is identifiable, while the SDMX non-enumerated Representation (corresponding to a VTL non-enumerated Value Domain) is not identifiable. As a consequence, the definition of the VTL rulesets, which in VTL can refer either to enumerated or non-enumerated value domains, in SDMX can refer only to enumerated Value Domains (i.e. to SDMX Codelists).
1616
1617 As for the mapping between VTL variables and SDMX Concepts, it should be noted that these artefacts do not coincide perfectly. In fact, the VTL variables are represented variables, defined always on the same Value Domain (“Representation” in SDMX) independently of the data set / data structure in which they appear[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[41~]^^>>path:#_ftn41]](%%), while the SDMX Concepts can have different Representations in different DataStructures.[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[42~]^^>>path:#_ftn42]](%%) This means that one SDMX Concept can correspond to many VTL Variables, one for each representation the Concept has.
1618
1619 Therefore, it is important to be aware that some VTL operations (for example the binary operations at data set level) are consistent only if the components having the same names in the operated VTL data sets have also the same representation (i.e. the same Value Domain as for VTL). For example, it is possible to obtain correct results from the VTL expression
1620
1621 DS_c := DS_a + DS_b (where DS_a, DS_b, DS_c are VTL Data Sets)
1622
1623 if the matching components in DS_a and DS_b (e.g. ref_date, geo_area, sector …) refer to the same general representation. In simpler words, DS_a and DS_b must use the same values/codes (for ref_date, geo_area, sector … ), otherwise the relevant values would not match and the result of the operation would be wrong.
1624
1625 As mentioned, the property above is not enforced by construction in SDMX, and different representations of the same Concept can be not compatible one another (for example, it may happen that geo_area is represented by ISO-alpha-3 codes in DS_a and by ISO alpha-2 codes in DS_b). Therefore, it will be up to the definer of VTL transformations to ensure that the VTL expressions are consistent with the actual representations of the correspondent SDMX Concepts.
1626
1627 It remains up to the SDMX-VTL definer also the assurance of the consistency between a VTL Ruleset defined on Variables and the SDMX Components on which the Ruleset is applied. In fact, a VTL Ruleset is expressed by means of the values of the Variables (i.e. SDMX Concepts), i.e. assuming definite representations for them (e.g. ISO-alpha-3 for country). If the Ruleset is applied to SDMX Components that have the same name of the Concept they refer to but different representations (e.g. ISO-alpha-2 for country), the Ruleset cannot work properly.
1628
1629 == 10.4 Mapping between SDMX and VTL Data Types ==
1630
1631 === 10.4.1 VTL Data types ===
1632
1633 According to the VTL User Guide the possible operations in VTL depend on the data types of the artefacts. For example, numbers can be multiplied but text strings cannot. In the VTL Transformations, the compliance between the operators and the data types of their operands is statically checked, i.e., violations result in compiletime errors.
1634
1635 The VTL data types are sub-divided in scalar types (like integers, strings, etc.), which are the types of the scalar values, and compound types (like data sets, components, rulesets, etc.), which are the types of the compound structures. See below the diagram of the VTL data types, taken from the VTL User Manual:
1636
1637 [[image:1747836776716-178.png]]
1638
1639 **Figure 12 – VTL Data Types**
1640
1641 The VTL scalar types are in turn subdivided in basic scalar types, which are elementary (not defined in term of other data types) and Value Domain and Set scalar types, which are defined in terms of the basic scalar types.
1642
1643 The VTL basic scalar types are listed below and follow a hierarchical structure in terms of supersets/subsets (e.g. “scalar” is the superset of all the basic scalar types):
1644
1645 [[image:1747859722732-549.png||height="283" width="224"]]
1646
1647 **Figure 13 – VTL Basic Scalar Types**
1648
1649 === 10.4.2 VTL basic scalar types and SDMX data types ===
1650
1651 The VTL assumes that a basic scalar type has a unique internal representation and can have more external representations.
1652
1653 The internal representation is the format used within a VTL system to represent (and process) all the scalar values of a certain type. In principle, this format is hidden and not necessarily known by users. The external representations are instead the external formats of the values of a certain basic scalar type, i.e. the formats known by the users. For example, the internal representation of the dates can be an integer counting the days since a predefined date (e.g. from 01/01/4713 BC up to 31/12/5874897 AD like in Postgres) while two possible external representations are the formats YYYY-MM-GG and MM-GG-YYYY (e.g. respectively 2010-12-31 and 1231-2010).
1654
1655 The internal representation is the reference format that allows VTL to operate on more values of the same type (for example on more dates) even if such values have different external formats: these values are all converted to the unique internal representation so that they can be composed together (e.g. to find the more recent date, to find the time span between these dates and so on).
1656
1657 The VTL assumes that a unique internal representation exists for each basic scalar type but does not prescribe any particular format for it, leaving the VTL systems free to using they preferred or already existing internal format. By consequence, in VTL the basic scalar types are abstractions not associated to a specific format.
1658
1659 SDMX data types are conceived instead to support the data exchange, therefore they do have a format, which is known by the users and correspond, in VTL terms, to external representations. Therefore, for each VTL basic scalar type there can be more SDMX data types (the latter are explained in the section “General Notes for Implementers” of this document and are actually much more numerous than the former).
1660
1661 The following paragraphs describe the mapping between the SDMX data types and the VTL basic scalar types. This mapping shall be presented in the two directions of possible conversion, i.e. from SDMX to VTL and vice-versa.
1662
1663 The conversion from SDMX to VTL happens when an SDMX artefact acts as inputs of a VTL transformation. As already said, in fact, at compile time the VTL needs to know the VTL type of the operands in order to check their compliance with the VTL operators and at runtime it must convert the values from their external (SDMX) representations to the corresponding internal (VTL) ones.
1664
1665 The opposite conversion, i.e. from VTL to SDMX, happens when a VTL result, i.e. a VTL data set output of a transformation, must become a SDMX artefact (or part of it). The values of the VTL result must be converted into the desired (SDMX) external representations (data types) of the SDMX artefact.
1666
1667 === 10.4.3 Mapping SDMX data types to VTL basic scalar types ===
1668
1669 The following table describes the default mapping for converting from the SDMX data types to the VTL basic scalar types.
1670
1671 (% style="width:653.835px" %)
1672 |(% style="width:366px" %)**SDMX data type (BasicComponentDataType)**|(% style="width:284px" %)**Default VTL basic scalar type**
1673 |(% style="width:366px" %)(((
1674 **String**
1675 (string allowing any character)
1676 )))|(% style="width:284px" %)**string**
1677 |(% style="width:366px" %)(((
1678 **Alpha**
1679 (string which only allows A-z)
1680 )))|(% style="width:284px" %)**string**
1681 |(% style="width:366px" %)(((
1682 **AlphaNumeric**
1683 (string which only allows A-z and 0-9)
1684 )))|(% style="width:284px" %)**string**
1685 |(% style="width:366px" %)(((
1686 **Numeric**
1687 (string which only allows 0-9, but is not numeric so that is can having leading zeros)
1688 )))|(% style="width:284px" %)**string**
1689 |(% style="width:366px" %)(((
1690 **BigInteger**
1691 (corresponds to XML Schema xs:integer datatype; infinite set of integer values)
1692 )))|(% style="width:284px" %)**integer**
1693 |(% style="width:366px" %)(((
1694 **Integer**
1695 (corresponds to XML Schema xs:int datatype; between -2147483648 and +2147483647 (inclusive))
1696 )))|(% style="width:284px" %)**integer**
1697 |(% style="width:366px" %)(((
1698 **Long**
1699 (corresponds to XML Schema xs:long datatype; between -9223372036854775808 and +9223372036854775807 (inclusive))
1700 )))|(% style="width:284px" %)**integer**
1701 |(% style="width:366px" %)(((
1702 **Short**
1703 (corresponds to XML Schema xs:short datatype; between -32768 and -32767 (inclusive))
1704 )))|(% style="width:284px" %)**integer**
1705 |(% style="width:366px" %)(((
1706 **Decimal**
1707 (corresponds to XML Schema xs:decimal datatype; subset of real numbers that can be represented as decimals)
1708 )))|(% style="width:284px" %)**number**
1709 |(% style="width:366px" %)(((
1710 **Float**
1711 (corresponds to XML Schema xs:float datatype; patterned after the IEEE single-precision 32-bit floating point type)
1712 )))|(% style="width:284px" %)**number**
1713 |(% style="width:366px" %)(((
1714 **Double**
1715 (corresponds to XML Schema xs:double datatype; patterned after the IEEE double-precision 64-bit floating point type)
1716 )))|(% style="width:284px" %)**number**
1717 |(% style="width:366px" %)(((
1718 **Boolean**
1719 (corresponds to the XML Schema xs:boolean datatype; support the mathematical concept of binary-valued logic: {true, false})
1720 )))|(% style="width:284px" %)**boolean**
1721 |(% style="width:366px" %)(((
1722 **URI**
1723 (corresponds to the XML Schema xs:anyURI; absolute or relative Uniform Resource Identifier Reference)
1724 )))|(% style="width:284px" %)**string**
1725 |(% style="width:366px" %)(((
1726 **Count**
1727 (an integer following a sequential pattern, increasing by 1 for each occurrence)
1728 )))|(% style="width:284px" %)**integer**
1729 |(% style="width:366px" %)(((
1730 **InclusiveValueRange**
1731 (decimal number within a closed interval, whose bounds are specified in the SDMX representation by the facets minValue and maxValue)
1732 )))|(% style="width:284px" %)**number**
1733 |(% style="width:366px" %)(((
1734 **ExclusiveValueRange**
1735 (decimal number within an open interval, whose bounds are specified in the SDMX representation by the facets minValue and maxValue)
1736 )))|(% style="width:284px" %)**number**
1737 |(% style="width:366px" %)(((
1738 **Incremental **
1739 (decimal number the increased by a specific interval (defined by the interval facet), which is typically enforced outside of the XML validation)
1740 )))|(% style="width:284px" %)**number**
1741 |(% style="width:366px" %)(((
1742 **ObservationalTimePeriod**
1743 (superset of StandardTimePeriod and TimeRange)
1744 )))|(% style="width:284px" %)**time**
1745 |(% style="width:366px" %)(((
1746 **StandardTimePeriod**
1747 (superset of BasicTimePeriod and ReportingTimePeriod)
1748 )))|(% style="width:284px" %)**time**
1749 |(% style="width:366px" %)(((
1750 **BasicTimePeriod**
1751 (superset of GregorianTimePeriod and DateTime)
1752 )))|(% style="width:284px" %)**date**
1753 |(% style="width:366px" %)(((
1754 **GregorianTimePeriod**
1755 (superset of GregorianYear, GregorianYearMonth, and GregorianDay)
1756 )))|(% style="width:284px" %)**date**
1757 |(% style="width:366px" %)**GregorianYear **(YYYY)|(% style="width:284px" %)**date**
1758 |(% style="width:366px" %)**GregorianYearMonth** / **GregorianMonth** (YYYY-MM)|(% style="width:284px" %)**date**
1759 |(% style="width:366px" %)**GregorianDay **(YYYY-MM-DD)|(% style="width:284px" %)**date**
1760 |(% style="width:366px" %)(((
1761 **ReportingTimePeriod **
1762 (superset of RepostingYear, ReportingSemester, ReportingTrimester, ReportingQuarter, ReportingMonth, ReportingWeek, ReportingDay)
1763 )))|(% style="width:284px" %)**time_period**
1764 |(% style="width:366px" %)(((
1765 **ReportingYear**
1766 (YYYY-A1 – 1 year period)
1767 )))|(% style="width:284px" %)**time_period**
1768 |(% style="width:366px" %)(((
1769 **ReportingSemester**
1770 (YYYY-Ss – 6 month period)
1771 )))|(% style="width:284px" %)**time_period**
1772 |(% style="width:366px" %)(((
1773 **ReportingTrimester**
1774 (YYYY-Tt – 4 month period)
1775 )))|(% style="width:284px" %)**time_period**
1776 |(% style="width:366px" %)(((
1777 **ReportingQuarter**
1778 (YYYY-Qq – 3 month period)
1779 )))|(% style="width:284px" %)**time_period**
1780 |(% style="width:366px" %)(((
1781 **ReportingMonth**
1782 (YYYY-Mmm – 1 month period)
1783 )))|(% style="width:284px" %)**time_period**
1784 |(% style="width:366px" %)(((
1785 **ReportingWeek**
1786 (YYYY-Www – 7 day period; following ISO 8601 definition of a week in a year)
1787 )))|(% style="width:284px" %)**time_period**
1788 |(% style="width:366px" %)(((
1789 **ReportingDay**
1790 (YYYY-Dddd – 1 day period)
1791 )))|(% style="width:284px" %)**time_period**
1792 |(% style="width:366px" %)(((
1793 **DateTime**
1794 (YYYY-MM-DDThh:mm:ss)
1795 )))|(% style="width:284px" %)**date**
1796 |(% style="width:366px" %)(((
1797 **TimeRange**
1798
1799 (YYYY-MM-DD(Thh:mm:ss)?/<duration>)
1800 )))|(% style="width:284px" %)**time**
1801 |(% style="width:366px" %)(((
1802 **Month**
1803 (~-~-MM; speicifies a month independent of a year; e.g. February is black history month in the United States)
1804 )))|(% style="width:284px" %)**string**
1805 |(% style="width:366px" %)(((
1806 **MonthDay**
1807 (~-~-MM-DD; specifies a day within a month independent of a year; e.g. Christmas is December 25^^th^^; used to specify reporting year start day)
1808 )))|(% style="width:284px" %)**string**
1809 |(% style="width:366px" %)(((
1810 **Day**
1811 (~-~--DD; specifies a day independent of a month or year; e.g. the 15^^th^^ is payday)
1812 )))|(% style="width:284px" %)**string**
1813 |(% style="width:366px" %)(((
1814 **Time**
1815 (hh:mm:ss; time independent of a date; e.g. coffee break is at 10:00 AM)
1816 )))|(% style="width:284px" %)**string**
1817 |(% style="width:366px" %)(((
1818 **Duration**
1819 (corresponds to XML Schema xs:duration datatype)
1820 )))|(% style="width:284px" %)**duration**
1821 |(% style="width:366px" %)XHTML|(% style="width:284px" %)Metadata type – not applicable
1822 |(% style="width:366px" %)KeyValues|(% style="width:284px" %)Metadata type – not applicable
1823 |(% style="width:366px" %)IdentifiableReference|(% style="width:284px" %)Metadata type – not applicable
1824 |(% style="width:366px" %)DataSetReference|(% style="width:284px" %)Metadata type – not applicable
1825 |(% style="width:366px" %)AttachmentConstraintReference|(% style="width:284px" %)Metadata type – not applicable
1826
1827 **Figure 14 – Mappings from SDMX data types to VTL Basic Scalar Types**
1828
1829 When VTL takes in input SDMX artefacts, it is assumed that a type conversion according to the table above always happens. In case a different VTL basic scalar type is desired, it can be achieved in the VTL program taking in input the default VTL basic scalar type above and applying to it the VTL type conversion features (see the implicit and explicit type conversion and the “cast” operator in the VTL Reference Manual).
1830
1831 === 10.4.4 Mapping VTL basic scalar types to SDMX data types ===
1832
1833 The following table describes the default conversion from the VTL basic scalar types to the SDMX data types .
1834
1835 (% style="width:923.835px" %)
1836 |(% style="width:191px" %)**VTL basic scalar type**|(% style="width:419px" %)**Default SDMX data type (BasicComponentDataType)**|(% style="width:311px" %)**Default output format**
1837 |(% style="width:191px" %)**String**|(% style="width:419px" %)**String **|(% style="width:311px" %)Like XML (xs:string)
1838 |(% style="width:191px" %)**Number**|(% style="width:419px" %)**Float **|(% style="width:311px" %)Like XML (xs:float)
1839 |(% style="width:191px" %)**Integer**|(% style="width:419px" %)**Integer **|(% style="width:311px" %)Like XML (xs:int)
1840 |(% style="width:191px" %)**Date**|(% style="width:419px" %)**DateTime**|(% style="width:311px" %)YYYY-MM-DDT00:00:00Z
1841 |(% style="width:191px" %)**Time**|(% style="width:419px" %)**StandardTimePeriod**|(% style="width:311px" %)<date>/<date> (as defined above)
1842 |(% style="width:191px" %)**time_period**|(% style="width:419px" %)(((
1843 **ReportingTimePeriod
1844 (StandardReportingPeriod)**
1845 )))|(% style="width:311px" %)(((
1846 YYYY-Pppp
1847 (according to SDMX )
1848 )))
1849 |(% style="width:191px" %)**Duration**|(% style="width:419px" %)**Duration **|(% style="width:311px" %)(((
1850 Like XML (xs:duration)
1851 PnYnMnDTnHnMnS
1852 )))
1853 |(% style="width:191px" %)**Boolean**|(% style="width:419px" %)**Boolean **|(% style="width:311px" %)(((
1854 Like XML (xs:boolean) with the values “true” or “false”
1855 )))
1856
1857 **Figure 14 – Mappings from SDMX data types to VTL Basic Scalar Types**
1858
1859 In case a different default conversion is desired, it can be achieved through the CustomTypeScheme and CustomType artefacts (see also the section Transformations and Expressions of the SDMX information model).
1860
1861 The custom output formats can be specified by means of the VTL formatting mask described in the section “Type Conversion and Formatting Mask” of the VTL Reference Manual. Such a section describes the masks for the VTL basic scalar types “number”, “integer”, “date”, “time”, “time_period” and “duration” and gives examples. As for the types “string” and “boolean” the VTL conventions are extended with some other special characters as described in the following table.
1862
1863 (% style="width:671.835px" %)
1864 |(% colspan="2" style="width:669px" %)**VTL special characters for the formatting masks**
1865 |(% colspan="2" style="width:669px" %)** **
1866 |(% colspan="2" style="width:669px" %)**Number **
1867 |(% style="width:141px" %)D|(% style="width:528px" %)one numeric digit (if the scientific notation is adopted, D is only for the mantissa)
1868 |(% style="width:141px" %)E|(% style="width:528px" %)one numeric digit (for the exponent of the scientific notation)
1869 |(% style="width:141px" %).(dot)|(% style="width:528px" %)possible separator between the integer and the decimal parts.
1870 |(% style="width:141px" %),(comma)|(% style="width:528px" %)possible separator between the integer and the decimal parts.
1871 |(% style="width:141px" %) |(% style="width:528px" %)
1872 |(% colspan="2" style="width:669px" %)**Time and duration**
1873 |(% style="width:141px" %)C |(% style="width:528px" %)century
1874 |(% style="width:141px" %)Y|(% style="width:528px" %)year
1875 |(% style="width:141px" %)S|(% style="width:528px" %)semester
1876 |(% style="width:141px" %)Q|(% style="width:528px" %)quarter
1877 |(% style="width:141px" %)M|(% style="width:528px" %)month
1878 |(% style="width:141px" %)W|(% style="width:528px" %)week
1879 |(% style="width:141px" %)D|(% style="width:528px" %)day
1880 |(% style="width:141px" %)h |(% style="width:528px" %)hour digit (by default on 24 hours)
1881 |(% style="width:141px" %)M|(% style="width:528px" %)minute
1882 |(% style="width:141px" %)S|(% style="width:528px" %)second
1883 |(% style="width:141px" %)D|(% style="width:528px" %)decimal of second
1884 |(% style="width:141px" %)P|(% style="width:528px" %)period indicator (representation in one digit for the duration)
1885 |(% style="width:141px" %)P|(% style="width:528px" %)number of the periods specified in the period indicator
1886 |(% style="width:141px" %)AM/PM |(% style="width:528px" %)indicator of AM / PM (e.g. am/pm for “am” or “pm”)
1887 |(% style="width:141px" %)MONTH|(% style="width:528px" %)uppercase textual representation of the month (e.g., JANUARY for January)
1888 |(% style="width:141px" %)DAY|(% style="width:528px" %)uppercase textual representation of the day (e.g., MONDAY for Monday)
1889 |(% style="width:141px" %)Month|(% style="width:528px" %)lowercase textual representation of the month (e.g., january)
1890 |(% style="width:141px" %)Day|(% style="width:528px" %)lowercase textual representation of the month (e.g., monday)
1891 |(% style="width:141px" %)Month|(% style="width:528px" %)First character uppercase, then lowercase textual representation of the month (e.g., January)
1892 |(% style="width:141px" %)Day|(% style="width:528px" %)First character uppercase, then lowercase textual representation of the day using (e.g. Monday)
1893 |(% style="width:141px" %) |(% style="width:528px" %)
1894 |(% colspan="2" style="width:669px" %)**String**
1895 |(% style="width:141px" %)X|(% style="width:528px" %)any string character
1896 |(% style="width:141px" %)Z|(% style="width:528px" %)any string character from “A” to “z”
1897 |(% style="width:141px" %)9|(% style="width:528px" %)any string character from “0” to “9”
1898 |(% style="width:141px" %) |(% style="width:528px" %)
1899 |(% colspan="2" style="width:669px" %)**Boolean **
1900 |(% style="width:141px" %)B|(% style="width:528px" %)Boolean using “true” for True and “false” for False
1901 |(% style="width:141px" %)1|(% style="width:528px" %)Boolean using “1” for True and “0” for False
1902 |(% style="width:141px" %)0|(% style="width:528px" %)Boolean using “0” for True and “1” for False
1903 |(% style="width:141px" %) |(% style="width:528px" %)
1904 |(% colspan="2" style="width:669px" %)Other qualifiers
1905 |(% style="width:141px" %)*|(% style="width:528px" %)an arbitrary number of digits (of the preceding type)
1906 |(% style="width:141px" %)+|(% style="width:528px" %)at least one digit (of the preceding type)
1907 |(% style="width:141px" %)( )|(% style="width:528px" %)optional digits (specified within the brackets)
1908 |(% style="width:141px" %)\|(% style="width:528px" %)prefix for the special characters that must appear in the mask
1909 |(% style="width:141px" %)N|(% style="width:528px" %)fixed number of digits used in the preceding textual representation of the month or the day
1910 |(% style="width:141px" %) |(% style="width:528px" %)
1911
1912 The default conversion, either standard or customized, can be used to deduce automatically the representation of the components of the result of a VTL transformation. In alternative, the representation of the resulting SDMX Dataflow can be given explicitly by providing its DataStructureDefinition. In other words, the representation specified in the DSD, if available, overrides any default conversion[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[43~]^^>>path:#_ftn43]](%%).
1913
1914 === 10.4.5 Null Values ===
1915
1916 In the conversions from SDMX to VTL it is assumed by default that a missing value in SDMX becomes a NULL in VTL. After the conversion, the NULLs can be manipulated through the proper VTL operators.
1917
1918 On the other side, the VTL programs can produce in output NULL values for Measures and Attributes (Null values are not allowed in the Identifiers). In the conversion from VTL to SDMX, it is assumed that a NULL in VTL becomes a missing value in SDMX.
1919
1920 In the conversion from VTL to SDMX, the default assumption can be overridden, separately for each VTL basic scalar type, by specifying which the value that represents the NULL in SDMX is. This can be specified in the attribute “nullValue” of the CustomType artefact (see also the section Transformations and Expressions of the SDMX information model). A CustomType belongs to a CustomTypeScheme, which can be referenced by one or more TransformationScheme (i.e. VTL programs). The overriding assumption is applied for all the SDMX Dataflows calculated in the TransformationScheme.
1921
1922 === 10.4.6 Format of the literals used in VTL transformations ===
1923
1924 The VTL programs can contain literals, i.e. specific values of certain data types written directly in the VTL definitions or expressions. The VTL does not prescribe a specific format for the literals and leave the specific VTL systems and the definers of VTL transformations free of using their preferred formats.
1925
1926 Given this discretion, it is essential to know which are the external representations adopted for the literals in a VTL program, in order to interpret them correctly. For example, if the external format for the dates is YYYY-MM-DD the date literal 201001-02 has the meaning of 2^^nd^^ January 2010, instead if the external format for the dates is YYYY-DD-MM the same literal has the meaning of 1^^st^^ February 2010.
1927
1928 Hereinafter, i.e. in the SDMX implementation of the VTL, it is assumed that the literals are expressed according to the “default output format” of the table of the previous paragraph (“Mapping VTL basic scalar types to SDMX data types”) unless otherwise specified.
1929
1930 A different format can be specified in the attribute “vtlLiteralFormat” of the CustomType artefact (see also the section Transformations and Expressions of the SDMX information model).
1931
1932 Like in the case of the conversion of NULLs described in the previous paragraph, the overriding assumption is applied, for a certain VTL basic scalar type, if a value is found for the vtlLiteralFormat attribute of the CustomType of such VTL basic scalar type. The overriding assumption is applied for all the literals of a related VTL TransformationScheme.
1933
1934 In case a literal is operand of a VTL Cast operation, the format specified in the Cast overrides all the possible otherwise specified formats.
1935
1936 = 11 Annex I: How to eliminate extra element in the .NET SDMX Web Service =
1937
1938 == 11.1 Problem statement ==
1939
1940 For implementing an SDMX compliant Web Service the standardised WSDL file should be used that describes the expected request/response structure. The request message of the operation contains a wrapper element (e.g. “GetGenericData”) that wraps a tag called “GenericDataQuery”, which is the actual SDMX query XML message that contains the query to be processed by the Web Service. In the same way the response is formulated in a wrapper element “GetGenericDataResponse”.
1941
1942 As defined in the SOAP specification, the root element of a SOAP message is the Envelope, which contains an optional Header and a mandatory Body. These are illustrated below along with the Body contents according to the WSDL:
1943
1944 [[image:1747854006117-843.png]]
1945
1946 The problem that initiated the present analysis refers to the difference in the way SOAP requests are when trying to implement the aforementioned Web Service in .NET framework.
1947
1948 Building such a Web Service using the .NET framework is done by exposing a method (i.e. the getGenericData in the example) with an XML document argument (lets name it “Query”). **The difference that appears in Microsoft .Net implementations is that there is a need for an extra XML container around the SDMX GenericDataQuery.** This is the expected behavior since the framework is let to publish automatically the Web Service as a remote procedure call, thus wraps each parameter into an extra element. The .NET request is illustrated below:
1949
1950 [[image:1747854039499-443.png]]
1951
1952 [[image:1747854067769-691.png]]
1953
1954 Furthermore this extra element is also inserted in the automatically generated WSDL from the framework. Therefore this particularity requires custom clients for the .NET Web Services that is not an interoperable solution.
1955
1956 == 11.2 Solution ==
1957
1958 The solution proposed for conforming the .NET implementation to the envisioned SOAP requests has to do with the manual intervention to the serialisation and deserialisation of the XML payloads. Since it is a Web Service of already prepared XML messages requests/responses this is the indicate way so as to have full control on the XML messages. This is the way the Java implementation (using Apache Axis) of the SDMX Web Service has adopted.
1959
1960 As regards the .NET platform this is related with the usage of **XmlAnyElement** parameter for the .NET web methods.
1961
1962 Web methods use XmlSerializer in the .NET Framework to invoke methods and build the response.
1963
1964 [[image:1747836776717-914.jpeg]]
1965
1966 The XML is passed to the XmlSerializer to de-serialize it into the instances of classes in managed code that map to the input parameters for the Web method. Likewise, the output parameters and return values of the Web method are serialized into XML in order to create the body of the SOAP response message.
1967
1968 In case the developer wants more control over the serialization and de-serialization process a solution is represented by the usage of **XmlElement** parameters. This offers the opportunity of validating the XML against a schema before de-serializing it, avoiding de-serialization in the first place, analyzing the XML to determine how you want to de-serialize it, or using the many powerful XML APIs that are available to deal with the XML directly. This also gives the developer the control to handle errors in a particular way instead of using the faults that the XmlSerializer might generate under the covers.
1969
1970 In order to control the de-serialization process of the XmlSerializer for a Web method, **XmlAnyElement** is a simple solution to use.
1971
1972 To understand how the **XmlAnyElement** attribute works we present the following two web methods:
1973
1974 [[image:1747854096778-844.png]]
1975
1976 In this method the **input** parameter is decorated with the **XmlAnyElement** parameter. This is a hint that this parameter will be de-serialized from an **xsd:any** element. Since the attribute is not passed any parameters, it means that the entire XML element for this parameter in the SOAP message will be in the Infoset that is represented by this **XmlElement** parameter.
1977
1978 [[image:1747854127303-270.png]]
1979
1980 The difference between the two is that for the first method, **SubmitXml**, the XmlSerializer will expect an element named **input** to be an immediate child of the **SubmitXml** element in the SOAP body. The second method, **SubmitXmlAny**, will not care what the name of the child of the **SubmitXmlAny** element is. It will plug whatever XML is included into the input parameter. The message style from ASP.NET Help for the two methods is shown below. First we look at the message for the method without the **XmlAnyElement** attribute.
1981
1982 [[image:1747854163928-581.png]]
1983
1984 Now we look at the message for the method that uses the **XmlAnyElement** attribute.
1985
1986 [[image:1747854190641-364.png]]
1987
1988 [[image:1747854236732-512.png]]
1989
1990 The method decorated with the **XmlAnyElement** attribute has one fewer wrapping elements. Only an element with the name of the method wraps what is passed to the **input** parameter.
1991
1992 For more information please consult: [[http:~~/~~/msdn.microsoft.com/en-us/library/aa480498.aspx>>http://msdn.microsoft.com/en-us/library/aa480498.aspx]]
1993
1994 Furthermore at this point the problem with the different requests has been solved. However there is still the difference in the produced WSDL that has to be taken care. The automatic generated WSDL now doesn’t insert the extra element, but defines the content of the operation wrapper element as “xsd:any” type.
1995
1996 [[image:1747854286398-614.png]]
1997
1998 Without a common WSDL still the solution doesn’t enforce interoperability. In order to
1999
2000 “fix” the WSDL, there two approaches. The first is to intervene in the generation process. This is a complicated approach, compared to the second approach, which overrides the generation process and returns the envisioned WSDL for the SDMX Web Service.
2001
2002 This is done by redirecting the request to the “/Service?WSDL” to the envisioned WSDL stored locally into the application. To do this, from the project add a “Global Application Class” item (.asax file) and override the request in the “Application_BeginRequest” method. This is demonstrated in detail in the next section.
2003
2004 This approach has the disadvantage that for each deployment the WSDL end point has to be changed to reflect the current URL. However this inconvenience can be easily eliminated if a developer implements a simple rewriting module for changing the end point to the one of the current deployment.
2005
2006 == 11.3 Applying the solution ==
2007
2008 In the context of the SDMX Web Service, applying the above solution translates into the following:
2009
2010 [[image:1747854385465-132.png]]
2011
2012 The SOAP request/response will then be as follows:
2013
2014 **GenericData Request**
2015
2016 [[image:1747854406014-782.png]]
2017
2018 **GenericData Response**
2019
2020 [[image:1747854424488-855.png]]
2021
2022 For overriding the automatically produced WSDL, in the solution explorer right click the project and select “Add” -> “New item…”. Then select the “Global Application Class”. This will create “.asax” class file in which the following code should replace the existing empty method:
2023
2024 [[image:1747854453895-524.png]]
2025
2026 [[image:1747854476631-125.png]]
2027
2028 The SDMX_WSDL.wsdl should reside in the in the root directory of the application. After applying this solution the returned WSDL is the envisioned. Thus in the request message definition contains:
2029
2030 [[image:1747854493363-776.png]]
2031
2032 ----
2033
2034 [[~[1~]>>path:#_ftnref1]] The seconds can be reported fractionally
2035
2036 [[~[2~]>>path:#_ftnref2]] ISO 8601 defines alternative definitions for the first week, all of which produce equivalent results. Any of these definitions could be substituted so long as they are in relation to the reporting year start day.
2037
2038 [[~[3~]>>path:#_ftnref3]] The rules for adding durations to a date time are described in the W3C XML Schema specification. See [[http:~~/~~/www.w3.org/TR/xmlschema>>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[->>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[2/#adding>>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[->>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[durations>>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[->>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[to>>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[dateTimes>>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]][[ >>url:http://www.w3.org/TR/xmlschema-2/#adding-durations-to-dateTimes]]for further details.
2039
2040 [[~[4~]>>path:#_ftnref4]] The Validation and Transformation Language is a standard language designed and published under the SDMX initiative. VTL is described in the VTL User and Reference Guides available on the SDMX website [[https:~~/~~/sdmx.org>>url:https://sdmx.org/]][[.>>url:https://sdmx.org/]]
2041
2042 [[~[5~]>>path:#_ftnref5]] See also the section “VTL-DL Rulesets” in the VTL Reference Manual.
2043
2044 [[~[6~]>>path:#_ftnref6]] The VTLMapping are used also for User Defined Operators (UDO). Although UDOperators are envisaged to be defined on generic operands, so that the specific artefacts to be manipulated are passed as parameters at their invocation, it is also possible that an UDOperator invokes directly some specific SDMX artefacts. These SDMX artefacts have to be mapped to the corresponding aliases used in the definition of the UDO through the VtlMappingScheme and VtlMapping classes as well.
2045
2046 [[~[7~]>>path:#_ftnref7]] For a complete description of the structure of the URN see the SDMX 2.1 Standards - Section 5 - Registry Specifications, paragraph 6.2.2 (“Universal Resource Name (URN)”).
2047
2048 [[~[8~]>>path:#_ftnref8]] The container-object-id can repeat and may not be present.
2049
2050 [[~[9~]>>path:#_ftnref9]] i.e., the artefact belongs to a maintainable class
2051
2052 [[~[10~]>>path:#_ftnref10]] Since these references to SDMX objects include non-permitted characters as per the VTL ID notation, they need to be included between single quotes, according to the VTL rules for irregular names.
2053
2054 [[~[11~]>>path:#_ftnref11]] For the syntax of the VTL operators see the VTL Reference Manual
2055
2056 [[~[12~]>>path:#_ftnref12]] In case the invoked artefact is a VTL component, which can be invoked only within the invocation of a
2057
2058 VTL data set (SDMX dataflow), the specific SDMX class-name (e.g. Dimension, MeasureDimension, TimeDimension, PrimaryMeasure or DataAttribute) can be deduced from the data structure of the SDMX Dataflow which the component belongs to.
2059
2060 [[~[13~]>>path:#_ftnref13]] If the Agency is composite (for example AgencyA.Dept1.Unit2), the agency is considered different even if only part of the composite name is different (for example AgencyA.Dept1.Unit3 is a different Agency than the previous one). Moreover the agency-id cannot be omitted in part (i.e., if a TransformationScheme owned by AgencyA.Dept1.Unit2 references an artefact coming from AgencyA.Dept1.Unit3, the specification of the agency-id becomes mandatory and must be complete, without omitting the possibly equal parts like AgencyA.Dept1)
2061
2062 [[~[14~]>>path:#_ftnref14]] Single quotes are needed because this reference is not a VTL regular name.
2063
2064 [[~[15~]>>path:#_ftnref15]] Single quotes are not needed in this case because CL_FREQ is a VTL regular name.
2065
2066 [[~[16~]>>path:#_ftnref16]] The result DFR(1.0) is be equal to DF1(1.0) save that the component SECTOR is called SEC
2067
2068 [[~[17~]>>path:#_ftnref17]] Rulesets of this kind cannot be reused when the referenced Concept has a different representation.
2069
2070 [[~[18~]>>path:#_ftnref18]] See also the section “VTL-DL Rulesets” in the VTL Reference Manual.
2071
2072 [[~[19~]>>path:#_ftnref19]] If a calculated artefact is persistent, it needs a persistent definition, i.e. a SDMX definition in a SDMX environment. Also possible calculated artefact that are not persistent may require a SDMX definition, for example when the result of a non-persistent calculation is disseminated through SDMX tools (like an inquiry tool).
2073
2074 [[~[20~]>>path:#_ftnref20]] See the VTL 2.0 User Manual
2075
2076 [[~[21~]>>path:#_ftnref21]] See the SDMX 2.1 Section 2 – Information Model
2077
2078 [[~[22~]>>path:#_ftnref22]] Besides the mapping between one SDMX Dataflow and one VTL Data Set, it is also possible to map distinct parts of a SDMX Dataflow to different VTL Data Set, as explained in a following paragraph.
2079
2080 [[~[23~]>>path:#_ftnref23]] The SDMX community is evaluating the opportunity of allowing more than one measure component in a DataStructureDefinition in the next SDMX major version.
2081
2082 [[~[24~]>>path:#_ftnref24]] If future SDMX major versions will allow multi-measures data structures, this method is expected to become applicable even if the VTL data structure has more than one measure
2083
2084 [[~[25~]>>path:#_ftnref25]] The kind of mapping explained here works in combination with a SDMX specific naming convention that requires pre-processing before parsing the VTL expressions. As highlighted below, the identifiers of the VTL datasets are a shortcut of some specific VTL operators applied to the SDMX Dataflows. This is not safe to use outside an SDMX context, as the naming convention may have no meaning there.
2085
2086 [[~[26~]>>path:#_ftnref26]] A typical example of this kind is the validation, and more in general the manipulation, of individual time series belonging to the same Dataflow, identifiable through the dimension components of the Dataflow except the time Dimension. The coding of these kind of operations might be simplified by mapping distinct time series (i.e. different parts of a SDMX Dataflow) to distinct VTL data sets.
2087
2088 [[~[27~]>>path:#_ftnref27]] Please note that this kind of mapping is only an option at disposal of the definer of VTL Transformations; in fact it remains always possible to manipulate the needed parts of SDMX Dataflows by means of VTL operators (e.g. “sub”, “filter”, “calc”, “union” …), maintaining a mapping one-to-one between SDMX Dataflows and VTL datasets.
2089
2090 [[~[28~]>>path:#_ftnref28]] This definition is made through the ToVtlSubspace and ToVtlSpaceKey classes and/or the FromVtlSuperspace and FromVtlSpaceKey classes, depending on the direction of the mapping (“key” means “dimension”). The mapping of Dataflow subsets can be applied independently in the two directions, also according to different Dimensions. When no Dimension is declared for a given direction, it is assumed that the option of mapping different parts of a SDMX Dataflow to different VTL datasets is not used.
2091
2092 [[~[29~]>>path:#_ftnref29]] As a consequence of this formalism, a slash in the name of the VTL dataset assumes the specific meaning of separator between the name of the Dataflow and the values of some of its Dimensions.
2093
2094 [[~[30~]>>path:#_ftnref30]] This is the order in which the dimensions are defined in the ToVtlSpaceKey class or in the FromVtlSpaceKey class, depending on the direction of the mapping.
2095
2096 [[~[31~]>>path:#_ftnref31]] It should be remembered that, according to the VTL consistency rules, a given VTL dataset cannot be the result of more than one VTL transformation.
2097
2098 [[~[32~]>>path:#_ftnref32]] If these dimensions would not be dropped, taking into account that the typical binary VTL operations at dataset level (+, -, *, / and so on) are executed on the observations having matching identifiers, the VTL datasets resulting from this kind of mapping would have non-matching values for the mapping dimensions (e.g. POPULATION and COUNTRY), therefore it would not be possible to compose the resulting VTL datasets one another (e.g. it would not be possible to calculate the population ratio between USA and CANADA). ^^ ^^
2099
2100 [[~[33~]>>path:#_ftnref33]] In case the ordered concatenation notation is used, the VTL Transformation described above, e.g.
2101
2102 ‘DF1(1.0)/POPULATION.USA’ := DF1(1.0) [ sub INDICATOR=“POPULATION”, COUNTRY=“USA”], is implicitly executed and, in order to test the overall compliance of the VTL program to the VTL consistency rules, it has to be considered as part of the VTL program even if it is not explicitly coded.
2103
2104 [[~[34~]>>path:#_ftnref34]] If the whole DF2(1.0) is calculated by means of just one VTL transformation, then the mapping between the SDMX dataflow and the corresponding VTL dataset is one-to-one and this kind of mapping (one SDMX Dataflow to many VTL datasets) does not apply..
2105
2106 [[~[35~]>>path:#_ftnref35]] This is possible as each VTL dataset corresponds to one particular combination of values of INDICATOR and COUNTRY
2107
2108 [[~[36~]>>path:#_ftnref36]] The mapping dimensions are defined as FromVtlSpaceKeys of the FromVtlSuperSpace of the ,,VtlDataflowMapping,, relevant to DF2(1.0)
2109
2110 [[~[37~]>>path:#_ftnref37]] the symbol of the VTL persistent assignment is used (<-)
2111
2112 [[~[38~]>>path:#_ftnref38]] The result is persistent in this example but it can be also non persistent if needed.
2113
2114 [[~[39~]>>path:#_ftnref39]] In case the ordered concatenation notation from VTL to SDMX is used, the set of transformations described above is implicitly performed; therefore, in order to test the overall compliance of the VTL program to the VTL consistency rules, these implicit transformations have to be considered as part of the VTL program even if they are not explicitly coded.
2115
2116 [[~[40~]>>path:#_ftnref40]] Through SDMX Constraints, it is possible to specify the values that a Component of a Dataflow can assume.
2117
2118 [[~[41~]>>path:#_ftnref41]] By using represented variables, VTL can assume that data structures having the same variables as identifiers can be composed one another because the correspondent values can match.
2119
2120 [[~[42~]>>path:#_ftnref42]] A Concept becomes a Component in a DataStructureDefinition, and Components can have different LocalRepresentations in different DataStructureDefinitions, also overriding the (possible) base representation of the Concept.
2121
2122 [[~[43~]>>path:#_ftnref43]] The representation given in the DSD should obviously be compatible with the VTL data type.
2123
2124 {{putFootnotes/}}