Changes for page SDMX 2.1 Standards. Section 6. Technical Notes
Last modified by Artur on 2025/08/19 10:43
Summary
-
Page properties (1 modified, 0 added, 0 removed)
-
Attachments (0 modified, 0 added, 18 removed)
- 1747854006117-843.png
- 1747854039499-443.png
- 1747854067769-691.png
- 1747854096778-844.png
- 1747854127303-270.png
- 1747854163928-581.png
- 1747854190641-364.png
- 1747854236732-512.png
- 1747854286398-614.png
- 1747854385465-132.png
- 1747854406014-782.png
- 1747854424488-855.png
- 1747854453895-524.png
- 1747854476631-125.png
- 1747854493363-776.png
- 1747855024745-946.png
- 1747855054559-410.png
- 1747855075263-887.png
Details
- Page properties
-
- Content
-
... ... @@ -69,15 +69,13 @@ 69 69 70 70 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. 71 71 72 -(% class="wikigeneratedid" id="HStructureDefinition" %) 73 -**//Structure Definition//** 72 +=== //Structure Definition// === 74 74 75 75 The SDMX-ML Structure Message supports the use of annotations to the structure, which is not supported by the SDMX-EDI syntax. 76 76 77 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 78 79 -(% class="wikigeneratedid" id="HValidation" %) 80 -**//Validation//** 78 +=== //Validation// === 81 81 82 82 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.) 83 83 ... ... @@ -85,22 +85,19 @@ 85 85 86 86 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. 87 87 88 -(% class="wikigeneratedid" id="HUpdateandDeleteMessagesandDocumentationMessages" %) 89 -//Update and Delete Messages and Documentation Messages// 86 +=== //Update and Delete Messages and Documentation Messages// === 90 90 91 91 All SDMX data messages allow for both delete messages and messages consisting of only data or only documentation. 92 92 93 -(% class="wikigeneratedid" id="HCharacterEncodings" %) 94 -**//Character Encodings//** 90 +=== //Character Encodings// === 95 95 96 96 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. 97 97 98 -(% class="wikigeneratedid" id="HDataTyping" %) 99 -**//Data Typing//** 94 +=== //Data Typing// === 100 100 101 101 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. 102 102 103 -=== 3.3.2 Data Types === 98 +==== 3.3.2 Data Types ==== 104 104 105 105 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. 106 106 ... ... @@ -148,21 +148,18 @@ 148 148 149 149 === 3.4.1 Reporting and Dissemination Guidelines === 150 150 151 - ====3.4.1.1 Central Institutions and Their Role in Statistical Data Exchanges====146 +**3.4.1.1 Central Institutions and Their Role in Statistical Data Exchanges **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. 152 152 153 -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. 154 - 155 155 Central institutions can play a double role: 156 156 157 157 * collecting and further disseminating statistics; 158 158 * devising structural definitions for use in data exchanges. 159 159 160 - ====3.4.1.2 Defining Data Structure Definitions (DSDs)====153 +**3.4.1.2 Defining Data Structure Definitions (DSDs)** 161 161 162 162 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. 163 163 164 -(% class="wikigeneratedid" id="HDimensions2CAttributesandCodeLists" %) 165 -__Dimensions, Attributes and Code Lists__ 157 +=== Dimensions, Attributes and Code Lists === 166 166 167 167 **//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. 168 168 ... ... @@ -192,8 +192,7 @@ 192 192 193 193 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. 194 194 195 -(% class="wikigeneratedid" id="HDataStructureDefinitionStructure" %) 196 -__Data Structure Definition Structure__ 187 +=== Data Structure Definition Structure === 197 197 198 198 The following items have to be specified by a structural definitions maintenance agency when defining a new data structure definition: 199 199 ... ... @@ -223,7 +223,7 @@ 223 223 * code list name 224 224 * code values and descriptions 225 225 226 -Definition of data flow definitions. Two (or more) partners performing data exchanges in a certain context need to agree on: 217 +Definition of data flow definitions. Two (or more) partners performing data exchanges in a certain context need to agree on: 227 227 228 228 * the list of data set identifiers they will be using; 229 229 * for each data flow: ... ... @@ -230,12 +230,10 @@ 230 230 * its content and description 231 231 * the relevant DSD that defines the structure of the data reported or disseminated according the the dataflow definition 232 232 233 - ====3.4.1.3 Exchanging Attributes====224 +**3.4.1.3 Exchanging Attributes** 234 234 235 - =====//3.4.1.3.1 Attributes on series, sibling and data set level //=====226 +**//3.4.1.3.1 Attributes on series, sibling and data set level //**//Static properties//. 236 236 237 -//Static properties//. 238 - 239 239 * 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. 240 240 * A centre may agree with its data exchange partners special procedures for authorising the setting of attributes' initial values. 241 241 * Attribute values at a data set level are set and maintained exclusively by the centre administrating the exchanged data set. ... ... @@ -252,21 +252,21 @@ 252 252 * If the “observation status” changes and the observation remains unchanged, both components would have to be reported. 253 253 * 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. 254 254 255 -=== 3.4.2 Best Practices for Batch Data Exchange === 244 +==== 3.4.2 Best Practices for Batch Data Exchange ==== 256 256 257 - ====3.4.2.1 Introduction====246 +**3.4.2.1 Introduction** 258 258 259 259 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. 260 260 261 - ====3.4.2.2 Positioning of the Dimension "Frequency"====250 +**3.4.2.2 Positioning of the Dimension "Frequency"** 262 262 263 263 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. 264 264 265 - ====3.4.2.3 Identification of Data Structure Definitions (DSDs)====254 +**3.4.2.3 Identification of Data Structure Definitions (DSDs)** 266 266 267 267 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. 268 268 269 - ====3.4.2.4 Identification of the Data Flows====258 +**3.4.2.4 Identification of the Data Flows** 270 270 271 271 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//)//. 272 272 ... ... @@ -274,7 +274,7 @@ 274 274 275 275 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. 276 276 277 - ====3.4.2.5 Special Issues====266 +**3.4.2.5 Special Issues** 278 278 279 279 ===== 3.4.2.5.1 "Frequency" related issues ===== 280 280 ... ... @@ -285,6 +285,7 @@ 285 285 286 286 **//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. 287 287 277 + 288 288 = 4 General Notes for Implementers = 289 289 290 290 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. ... ... @@ -295,31 +295,39 @@ 295 295 296 296 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. 297 297 298 -(% style="width:912.294px" %) 299 -|(% style="width:172px" %)**SDMX-ML Data Type**|(% style="width:204px" %)**XML Schema Data Type**|(% style="width:189px" %)**.NET Framework Type**|(% style="width:342px" %)((( 300 -**Java Data Type ** 288 +|**SDMX-ML Data Type**|**XML Schema Data Type**|**.NET Framework Type**|((( 289 +**Java Data Type** 290 + 291 +**~ ** 301 301 ))) 302 -|(% style="width:172px" %)String|(% style="width:204px" %)xsd:string|(% style="width:189px" %)System.String|(% style="width:342px" %)java.lang.String 303 -|(% style="width:172px" %)Big Integer|(% style="width:204px" %)xsd:integer|(% style="width:189px" %)System.Decimal|(% style="width:342px" %)java.math.BigInteg er 304 -|(% style="width:172px" %)Integer|(% style="width:204px" %)xsd:int|(% style="width:189px" %)System.Int32|(% style="width:342px" %)int 305 -|(% style="width:172px" %)Long|(% style="width:204px" %)xsd.long|(% style="width:189px" %)System.Int64|(% style="width:342px" %)long 306 -|(% style="width:172px" %)Short|(% style="width:204px" %)xsd:short|(% style="width:189px" %)System.Int16|(% style="width:342px" %)short 307 -|(% style="width:172px" %)Decimal|(% style="width:204px" %)xsd:decimal|(% style="width:189px" %)System.Decimal|(% style="width:342px" %)java.math.BigDecim al 308 -|(% style="width:172px" %)Float|(% style="width:204px" %)xsd:float|(% style="width:189px" %)System.Single|(% style="width:342px" %)float 309 -|(% style="width:172px" %)Double|(% style="width:204px" %)xsd:double|(% style="width:189px" %)System.Double|(% style="width:342px" %)double 310 -|(% style="width:172px" %)Boolean|(% style="width:204px" %)xsd:boolean|(% style="width:189px" %)System.Boolean|(% style="width:342px" %)boolean 311 -|(% style="width:172px" %)URI|(% style="width:204px" %)xsd:anyURI|(% style="width:189px" %)System.Uri|(% style="width:342px" %)Java.net.URI or java.lang.String 312 -|(% style="width:172px" %)DateTime|(% style="width:204px" %)xsd:dateTime|(% style="width:189px" %)System.DateTime|(% style="width:342px" %)javax.xml.datatype .XMLGregorianCalen dar 313 -|(% style="width:172px" %)Time|(% style="width:204px" %)xsd:time|(% style="width:189px" %)System.DateTime|(% style="width:342px" %)javax.xml.datatype .XMLGregorianCalen dar 314 -|(% style="width:172px" %)GregorianYear|(% style="width:204px" %)xsd:gYear|(% style="width:189px" %)System.DateTime|(% style="width:342px" %)javax.xml.datatype .XMLGregorianCalen dar 315 -|(% style="width:172px" %)GregorianMonth|(% style="width:204px" %)xsd:gYearMonth|(% style="width:189px" %)System.DateTime|(% style="width:342px" %)javax.xml.datatype .XMLGregorianCalen dar 316 -|(% style="width:172px" %)GregorianDay|(% style="width:204px" %)xsd:date|(% style="width:189px" %)System.DateTime|(% style="width:342px" %)javax.xml.datatype .XMLGregorianCalen dar 317 -|(% style="width:172px" %)((( 318 -Day, MonthDay, Month 319 -)))|(% style="width:204px" %)xsd:g*|(% style="width:189px" %)System.DateTime|(% style="width:342px" %)javax.xml.datatype .XMLGregorianCalen dar 320 -|(% style="width:172px" %)Duration|(% style="width:204px" %)xsd:duration |(% style="width:189px" %)System.TimeSpa|(% style="width:342px" %)javax.xml.datatype 321 -|(% style="width:172px" %) |(% style="width:204px" %) |(% style="width:189px" %)n|(% style="width:342px" %).Duration 293 +|String|xsd:string|System.String|java.lang.String 294 +|Big Integer|xsd:integer|System.Decimal|java.math.BigInteg er 295 +|Integer|xsd:int|System.Int32|int 296 +|Long|xsd.long|System.Int64|long 297 +|Short|xsd:short|System.Int16|short 298 +|Decimal|xsd:decimal|System.Decimal|java.math.BigDecim al 299 +|Float|xsd:float|System.Single|float 300 +|Double|xsd:double|System.Double|double 301 +|Boolean|xsd:boolean|System.Boolean|boolean 302 +|URI|xsd:anyURI|System.Uri|Java.net.URI or java.lang.String 303 +|DateTime|xsd:dateTime|System.DateTim e|javax.xml.datatype .XMLGregorianCalen dar 304 +|Time|xsd:time|System.DateTim e|javax.xml.datatype .XMLGregorianCalen dar 305 +|GregorianYear|xsd:gYear|System.DateTim e|javax.xml.datatype .XMLGregorianCalen dar 306 +|GregorianMont h|xsd:gYearMont h|System.DateTim e|javax.xml.datatype .XMLGregorianCalen dar 307 +|GregorianDay|xsd:date|System.DateTim e|javax.xml.datatype .XMLGregorianCalen dar 308 +|((( 309 +Day, 322 322 311 +MonthDay, Month 312 +)))|xsd:g*|System.DateTim e|javax.xml.datatype .XMLGregorianCalen dar 313 +|Duration|xsd:duration |System.TimeSpa|javax.xml.datatype 314 +|**SDMX-ML Data Type**|**XML Schema Data Type**|**.NET Framework Type**|((( 315 +**Java Data Type** 316 + 317 +**~ ** 318 +))) 319 +| | |n|.Duration 320 + 323 323 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: 324 324 325 325 * AlphaNumeric (common:AlphaNumericType, string which only allows A-z and 0-9) ... ... @@ -345,8 +345,10 @@ 345 345 * KeyValues (common:DataKeyType) 346 346 * IdentifiableReference (types for each identifiable object) 347 347 * DataSetReference (common:DataSetReferenceType) 348 -* AttachmentConstraintReference (common:AttachmentConstraintReferenceType)346 +* AttachmentConstraintReference 349 349 348 +(common:AttachmentConstraintReferenceType) 349 + 350 350 Data types also have a set of facets: 351 351 352 352 * isSequence = true | false (indicates a sequentially increasing value) ... ... @@ -368,7 +368,7 @@ 368 368 369 369 == 4.2 Time and Time Format == 370 370 371 -=== 4.2.1 Introduction === 371 +==== 4.2.1 Introduction ==== 372 372 373 373 First, it is important to recognize that most observation times are a period. SDMX specifies precisely how Time is handled. 374 374 ... ... @@ -376,47 +376,50 @@ 376 376 377 377 The hierarchy of time formats is as follows (**bold** indicates a category which is made up of multiple formats, //italic// indicates a distinct format): 378 378 379 -* **Observational Time Period** 380 -** **Standard Time Period** 381 -*** **Basic Time Period** 382 -**** **Gregorian Time Period** 383 -**** //Date Time// 384 -*** **Reporting Time Period** 385 -** //Time Range// 379 +* **Observational Time Period **o **Standard Time Period** 386 386 381 + § **Basic Time Period** 382 + 383 +* **Gregorian Time Period** 384 +* //Date Time// 385 + 386 +§ **Reporting Time Period **o //Time Range// 387 + 387 387 The details of these time period categories and of the distinct formats which make them up are detailed in the sections to follow. 388 388 389 -=== 4.2.2 Observational Time Period === 390 +==== 4.2.2 Observational Time Period ==== 390 390 391 391 This is the superset of all time representations in SDMX. This allows for time to be expressed as any of the allowable formats. 392 392 393 -=== 4.2.3 Standard Time Period === 394 +==== 4.2.3 Standard Time Period ==== 394 394 395 395 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). 396 396 397 -=== 4.2.4 Gregorian Time Period === 398 +==== 4.2.4 Gregorian Time Period ==== 398 398 399 399 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: 400 400 401 -**Gregorian Year:** 402 +**Gregorian Year:** 403 + 402 402 Representation: xs:gYear (YYYY) 403 -Period: the start of January 1 to the end of December 31 404 404 405 -**Gregorian Year Month**: 406 +Period: the start of January 1 to the end of December 31 **Gregorian Year Month**: 407 + 406 406 Representation: xs:gYearMonth (YYYY-MM) 407 -Period: the start of the first day of the month to end of the last day of the month 408 408 409 -**Gregorian Day**: 410 +Period: the start of the first day of the month to end of the last day of the month **Gregorian Day**: 411 + 410 410 Representation: xs:date (YYYY-MM-DD) 413 + 411 411 Period: the start of the day (00:00:00) to the end of the day (23:59:59) 412 412 413 -=== 4.2.5 Date Time === 416 +==== 4.2.5 Date Time ==== 414 414 415 415 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. 416 416 417 -Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss)[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[1~]^^>>path:#_ftn1]]420 +Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss)[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[1~]^^>>path:#_ftn1]] 418 418 419 -=== 4.2.6 Standard Reporting Period === 422 +==== 4.2.6 Standard Reporting Period ==== 420 420 421 421 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: 422 422 ... ... @@ -423,52 +423,75 @@ 423 423 [REPORTING_YEAR]-[PERIOD_INDICATOR][PERIOD_VALUE] 424 424 425 425 Where: 429 + 426 426 REPORTING_YEAR represents the reporting year as four digits (YYYY) PERIOD_INDICATOR identifies the type of period which determines the duration of the period 431 + 427 427 PERIOD_VALUE indicates the actual period within the year 428 428 429 429 The following section details each of the standard reporting periods defined in SDMX: 430 430 431 -**Reporting Year**: 432 -Period Indicator: A 436 +**Reporting Year**: 437 + 438 + Period Indicator: A 439 + 433 433 Period Duration: P1Y (one year) 441 + 434 434 Limit per year: 1 435 -Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1) 436 436 437 -**Reporting Semester:** 438 -Period Indicator: S 444 +Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1) **Reporting Semester:** 445 + 446 + Period Indicator: S 447 + 439 439 Period Duration: P6M (six months) 449 + 440 440 Limit per year: 2 441 -Representation: common:ReportingSemesterType (YYYY-Ss, e.g. 2000-S2) 442 442 443 -**Reporting Trimester:** 444 -Period Indicator: T 452 +Representation: common:ReportingSemesterType (YYYY-Ss, e.g. 2000-S2) **Reporting Trimester:** 453 + 454 + Period Indicator: T 455 + 445 445 Period Duration: P4M (four months) 457 + 446 446 Limit per year: 3 447 -Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3) 448 448 449 -**Reporting Quarter:** 450 -Period Indicator: Q 460 +Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3) **Reporting Quarter:** 461 + 462 + Period Indicator: Q 463 + 451 451 Period Duration: P3M (three months) 465 + 452 452 Limit per year: 4 453 -Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4) 454 454 455 -**Reporting Month**: 468 +Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4) **Reporting Month**: 469 + 456 456 Period Indicator: M 471 + 457 457 Period Duration: P1M (one month) 473 + 458 458 Limit per year: 1 475 + 459 459 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. 460 460 461 461 **Reporting Week**: 479 + 462 462 Period Indicator: W 481 + 463 463 Period Duration: P7D (seven days) 483 + 464 464 Limit per year: 53 485 + 465 465 Representation: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53) 466 -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" %)^^~[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. 467 467 488 +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" %)^^~[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. 489 + 468 468 **Reporting Day**: 491 + 469 469 Period Indicator: D 493 + 470 470 Period Duration: P1D (one day) 495 + 471 471 Limit per year: 366 497 + 472 472 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). 473 473 474 474 This allows the values to be sorted chronologically using textual sorting methods. ... ... @@ -479,109 +479,143 @@ 479 479 480 480 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]): 481 481 482 -**~1. Determine [REPORTING_YEAR_BASE]:** 508 +1. **Determine [REPORTING_YEAR_BASE]:** 509 + 483 483 Combine [REPORTING_YEAR] of the reporting period value (YYYY) with [REPORTING_YEAR_START_DAY] (MM-DD) to get a date (YYYY-MM-DD). 511 + 484 484 This is the [REPORTING_YEAR_START_DATE] 485 -**a) If the [PERIOD_INDICATOR] is W: 486 -~1. If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday:** 513 + 514 +**a) If the [PERIOD_INDICATOR] is W:** 515 + 516 +1. 517 +11. 518 +111. 519 +1111. **If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday:** 520 + 487 487 Add^^3^^ (P3D, P2D, or P1D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE]. 488 488 489 -2. **If [REPORTING_YEAR_START_DATE] is a Monday, Tuesday, Wednesday, or Thursday:** 523 +1. 524 +11. 525 +111. 526 +1111. **If [REPORTING_YEAR_START_DATE] is a Monday, Tuesday, Wednesday, or Thursday:** 527 + 490 490 Add^^3^^ (P0D, -P1D, -P2D, or -P3D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE]. 491 -b) **Else:** 492 -The [REPORTING_YEAR_START_DATE] is the [REPORTING_YEAR_BASE] 493 493 494 -** 2. Determine [PERIOD_DURATION]:**530 +b) **Else:** 495 495 496 -a) If the [PERIOD_INDICATOR] is A, the [PERIOD_DURATION] is P1Y. 497 -b) If the [PERIOD_INDICATOR] is S, the [PERIOD_DURATION] is P6M. 498 -c) If the [PERIOD_INDICATOR] is T, the [PERIOD_DURATION] is P4M. 499 -d) If the [PERIOD_INDICATOR] is Q, the [PERIOD_DURATION] is P3M. 500 -e) If the [PERIOD_INDICATOR] is M, the [PERIOD_DURATION] is P1M. 501 -f) If the [PERIOD_INDICATOR] is W, the [PERIOD_DURATION] is P7D. 502 -g) If the [PERIOD_INDICATOR] is D, the [PERIOD_DURATION] is P1D. 532 +The [REPORTING_YEAR_START_DATE] is the [REPORTING_YEAR_BASE]. 503 503 504 -**3. Determine [PERIOD_START]:** 505 -Subtract one from the [PERIOD_VALUE] and multiply this by the [PERIOD_DURATION]. Add[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[3~]^^>>path:#_ftn3]](%%) this to the [REPORTING_YEAR_BASE]. The result is the [PERIOD_START]. 534 +1. **Determine [PERIOD_DURATION]:** 535 +11. 536 +111. If the [PERIOD_INDICATOR] is A, the [PERIOD_DURATION] is P1Y. 537 +111. If the [PERIOD_INDICATOR] is S, the [PERIOD_DURATION] is P6M. 538 +111. If the [PERIOD_INDICATOR] is T, the [PERIOD_DURATION] is P4M. 539 +111. If the [PERIOD_INDICATOR] is Q, the [PERIOD_DURATION] is P3M. 540 +111. If the [PERIOD_INDICATOR] is M, the [PERIOD_DURATION] is P1M. 541 +111. If the [PERIOD_INDICATOR] is W, the [PERIOD_DURATION] is P7D. 542 +111. If the [PERIOD_INDICATOR] is D, the [PERIOD_DURATION] is P1D. 543 +1. **Determine [PERIOD_START]:** 506 506 507 -**4. Determine the [PERIOD_END]:** 545 +Subtract one from the [PERIOD_VALUE] and multiply this by the [PERIOD_DURATION]. Add[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[3~]^^>>path:#_ftn3]](%%) this to the [REPORTING_YEAR_BASE]. The result is the [PERIOD_START]. 546 + 547 +1. **Determine the [PERIOD_END]:** 548 + 508 508 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]. 509 509 510 510 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). 511 511 512 -**Examples:** 553 +**Examples: ** 513 513 514 514 **2010-Q2, REPORTING_YEAR_START_DAY = ~-~-07-01 (July 1)** 556 + 515 515 ~1. [REPORTING_YEAR_START_DATE] = 2010-07-01 558 + 516 516 b) [REPORTING_YEAR_BASE] = 2010-07-01 517 -[PERIOD_DURATION] = P3M 518 -(2-1) * P3M = P3M 560 + 561 +1. [PERIOD_DURATION] = P3M 562 +1. (2-1) * P3M = P3M 563 + 519 519 2010-07-01 + P3M = 2010-10-01 565 + 520 520 [PERIOD_START] = 2010-10-01 567 + 521 521 4. 2 * P3M = P6M 569 + 522 522 2010-07-01 + P6M = 2010-13-01 = 2011-01-01 571 + 523 523 2011-01-01 + -P1D = 2010-12-31 573 + 524 524 [PERIOD_END] = 2011-12-31 525 525 526 526 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 527 527 528 528 **2011-W36, REPORTING_YEAR_START_DAY = ~-~-07-01 (July 1)** 579 + 529 529 ~1. [REPORTING_YEAR_START_DATE] = 2010-07-01 581 + 530 530 a) 2011-07-01 = Friday 583 + 531 531 2011-07-01 + P3D = 2011-07-04 585 + 532 532 [REPORTING_YEAR_BASE] = 2011-07-04 533 -2. [PERIOD_DURATION] = P7D 534 -3. (36-1) * P7D = P245D 587 + 588 +1. [PERIOD_DURATION] = P7D 589 +1. (36-1) * P7D = P245D 590 + 535 535 2011-07-04 + P245D = 2012-03-05 592 + 536 536 [PERIOD_START] = 2012-03-05 594 + 537 537 4. 36 * P7D = P252D 596 + 538 538 2011-07-04 + P252D =2012-03-12 598 + 539 539 2012-03-12 + -P1D = 2012-03-11 600 + 540 540 [PERIOD_END] = 2012-03-11 541 541 542 542 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 543 543 544 -=== 4.2.7 Distinct Range === 605 +==== 4.2.7 Distinct Range ==== 545 545 546 546 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. 547 547 548 -=== 4.2.8 Time Format === 609 +==== 4.2.8 Time Format ==== 549 549 550 550 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. 551 551 552 -(% style="width:1049.29px" %) 553 -|**Code**|(% style="width:926px" %)**Format** 554 -|**OTP**|(% style="width:926px" %)Observational Time Period: Superset of all SDMX time formats (Gregorian Time Period, Reporting Time Period, and Time Range) 555 -|**STP**|(% style="width:926px" %)Standard Time Period: Superset of Gregorian and Reporting Time Periods 556 -|**GTP**|(% style="width:926px" %)Superset of all Gregorian Time Periods and date-time 557 -|**RTP**|(% style="width:926px" %)Superset of all Reporting Time Periods 558 -|**TR**|(% style="width:926px" %)Time Range: Start time and duration (YYYY-MMDD(Thh:mm:ss)?/<duration>) 559 -|**GY**|(% style="width:926px" %)Gregorian Year (YYYY) 560 -|**GTM**|(% style="width:926px" %)Gregorian Year Month (YYYY-MM) 561 -|**GD**|(% style="width:926px" %)Gregorian Day (YYYY-MM-DD) 562 -|**DT**|(% style="width:926px" %)Distinct Point: date-time (YYYY-MM-DDThh:mm:ss) 563 -|**RY**|(% style="width:926px" %)Reporting Year (YYYY-A1) 564 -|**RS**|(% style="width:926px" %)Reporting Semester (YYYY-Ss) 565 -|**RT**|(% style="width:926px" %)Reporting Trimester (YYYY-Tt) 566 -|**RQ**|(% style="width:926px" %)Reporting Quarter (YYYY-Qq) 567 -|**RM**|(% style="width:926px" %)Reporting Month (YYYY-Mmm) 568 -|**Code**|(% style="width:926px" %)**Format** 569 -|**RW**|(% style="width:926px" %)Reporting Week (YYYY-Www) 570 -|**RD**|(% style="width:926px" %)Reporting Day (YYYY-Dddd) 613 +|**Code**|**Format** 614 +|**OTP**|Observational Time Period: Superset of all SDMX time formats (Gregorian Time Period, Reporting Time Period, and Time Range) 615 +|**STP**|Standard Time Period: Superset of Gregorian and Reporting Time Periods 616 +|**GTP**|Superset of all Gregorian Time Periods and date-time 617 +|**RTP**|Superset of all Reporting Time Periods 618 +|**TR**|Time Range: Start time and duration (YYYY-MMDD(Thh:mm:ss)?/<duration>) 619 +|**GY**|Gregorian Year (YYYY) 620 +|**GTM**|Gregorian Year Month (YYYY-MM) 621 +|**GD**|Gregorian Day (YYYY-MM-DD) 622 +|**DT**|Distinct Point: date-time (YYYY-MM-DDThh:mm:ss) 623 +|**RY**|Reporting Year (YYYY-A1) 624 +|**RS**|Reporting Semester (YYYY-Ss) 625 +|**RT**|Reporting Trimester (YYYY-Tt) 626 +|**RQ**|Reporting Quarter (YYYY-Qq) 627 +|**RM**|Reporting Month (YYYY-Mmm) 628 +|**Code**|**Format** 629 +|**RW**|Reporting Week (YYYY-Www) 630 +|**RD**|Reporting Day (YYYY-Dddd) 571 571 572 -**Table 1: SDMX-ML Time Format Codes** 632 + **Table 1: SDMX-ML Time Format Codes** 573 573 574 -=== 4.2.9 Transformation between SDMX-ML and SDMX-EDI === 634 +==== 4.2.9 Transformation between SDMX-ML and SDMX-EDI ==== 575 575 576 576 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". 577 577 578 -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) .638 +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) 579 579 580 580 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. 581 581 582 582 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. 583 583 584 -=== 4.2.10 Time Zones === 644 +==== 4.2.10 Time Zones ==== 585 585 586 586 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): 587 587 ... ... @@ -602,7 +602,7 @@ 602 602 603 603 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. 604 604 605 -=== 4.2.11 Representing Time Spans Elsewhere === 665 +==== 4.2.11 Representing Time Spans Elsewhere ==== 606 606 607 607 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: 608 608 ... ... @@ -612,29 +612,30 @@ 612 612 613 613 <Series REF_PERIOD="2000-01-01T00:00:00/P2M"/> 614 614 615 -=== 4.2.12 Notes on Formats === 675 +==== 4.2.12 Notes on Formats ==== 616 616 617 617 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. 618 618 619 -=== 4.2.13 Effect on Time Ranges === 679 +==== 4.2.13 Effect on Time Ranges ==== 620 620 621 621 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. 622 622 623 -=== 4.2.14 Time in Query Messages === 683 +==== 4.2.14 Time in Query Messages ==== 624 624 625 625 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. 626 626 627 627 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. 628 628 629 -(% style="width:1024.29px" %) 630 -|(% style="width:238px" %)**Operator**|(% style="width:782px" %)**Rule** 631 -|(% style="width:238px" %)Greater Than|(% style="width:782px" %)Any data after the last moment of the period 632 -|(% style="width:238px" %)Less Than|(% style="width:782px" %)Any data before the first moment of the period 633 -|(% style="width:238px" %)Greater Than or Equal To|(% style="width:782px" %)((( 634 -Any data on or after the first moment of the period 689 +|**Operator**|**Rule** 690 +|Greater Than|Any data after the last moment of the period 691 +|Less Than|Any data before the first moment of the period 692 +|Greater Than or Equal To|((( 693 +Any data on or after the first moment of 694 + 695 +the period 635 635 ))) 636 -| (% style="width:238px" %)Less Than or Equal To|(% style="width:782px" %)Any data on or before the last moment of the period637 -| (% 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 period697 +|Less Than or Equal To|Any data on or before the last moment of the period 698 +|Equal To|Any data which falls on or after the first moment of the period and before or on the last moment of the period 638 638 639 639 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": 640 640 ... ... @@ -647,7 +647,9 @@ 647 647 **Examples:** 648 648 649 649 **Gregorian Period** 711 + 650 650 Query Parameter: Greater than 2010 713 + 651 651 Literal Interpretation: Any data where the start period occurs after 2010-1231T23:59:59. 652 652 653 653 Example Matches: ... ... @@ -665,11 +665,15 @@ 665 665 * 2010-D185 or later (reporting year start day ~-~-07-01 or later) 666 666 667 667 **Reporting Period with explicit start day** 731 + 668 668 Query Parameter: Greater than or equal to 2009-Q3, reporting year start day = "-07-01" 733 + 669 669 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 670 670 671 671 **Reporting Period with "Any" start day** 737 + 672 672 Query Parameter: Greater than or equal to 2010-Q3, reporting year start day = "Any" 739 + 673 673 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: 674 674 675 675 * 2011 or later ... ... @@ -681,10 +681,13 @@ 681 681 * 2010-T3 (any reporting year start day) 682 682 * 2010-Q3 or later (any reporting year start day) 683 683 * 2010-M07 or later (any reporting year start day) 684 -* 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) 685 -* 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}} 686 -* 2010-D185 or later (reporting year start day ~-~-07-01) 751 +* 2010-W27 or later (reporting year start day ~-~-01-01)^^4^^ 2010-D182 or later (reporting year start day ~-~-01-01) 752 +* 2010-W28 or later (reporting year start day ~-~-07-01)^^5^^ 687 687 754 +^^4^^ 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. 755 + 756 + 2010-D185 or later (reporting year start day ~-~-07-01) 757 + 688 688 == 4.3 Structural Metadata Querying Best Practices == 689 689 690 690 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. ... ... @@ -701,6 +701,8 @@ 701 701 702 702 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. 703 703 774 +^^5^^ 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. 775 + 704 704 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. 705 705 706 706 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. ... ... @@ -723,13 +723,13 @@ 723 723 724 724 [[image:1747836776649-282.jpeg]] 725 725 726 -** Figure1: Schematic of the Metadata Structure Definition**798 +1. **1: Schematic of the Metadata Structure Definition** 727 727 728 728 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. 729 729 730 730 [[image:1747836776655-364.jpeg]] 731 731 732 -** Figure2: Example MSD showing Metadata Targets**804 +1. **2: Example MSD showing Metadata Targets** 733 733 734 734 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. 735 735 ... ... @@ -739,10 +739,8 @@ 739 739 740 740 [[image:1747836776658-510.jpeg]] 741 741 742 -**Figure 3: Example MSD showing specification of three Metadata Attributes** 814 +**Figure 3: Example MSD showing specification of three Metadata Attributes **This example shows the following hierarchy of Metadata Attributes: 743 743 744 -This example shows the following hierarchy of Metadata Attributes: 745 - 746 746 Source – this is presentational and no metadata is expected to be reported at this level 747 747 748 748 * Source Type ... ... @@ -756,7 +756,10 @@ 756 756 757 757 **Figure 4: Example Metadata Set **This example shows: 758 758 759 -1. The reference to the MSD, Metadata Report, and Metadata Target (MetadataTargetValue) 829 +1. The reference to the MSD, Metadata Report, and Metadata Target 830 + 831 +(MetadataTargetValue) 832 + 760 760 1. The reported metadata attributes (AttributeValueSet) 761 761 762 762 = 6 Maintenance Agencies = ... ... @@ -813,9 +813,8 @@ 813 813 814 814 The Information Model for this is shown below: 815 815 816 -[[image:1747855024745-946.png]] 817 817 818 -**Figure 8: Information Model Extract for Concept Role** 890 + **Figure 8: Information Model Extract for Concept Role** 819 819 820 820 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. 821 821 ... ... @@ -835,14 +835,13 @@ 835 835 836 836 The Cross-Domain Concept Scheme maintained by SDMX contains concept role concepts (FREQ chosen as an example). 837 837 838 -[[image:17478 55054559-410.png]]910 +[[image:1747836776691-440.jpeg]] 839 839 840 - 841 841 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. 842 842 843 843 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. 844 844 845 -[[image:17478 55075263-887.png]]916 +[[image:1747836776693-898.jpeg]] 846 846 847 847 848 848 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. ... ... @@ -892,7 +892,7 @@ 892 892 893 893 == 8.3 Rules for a Content Constraint == 894 894 895 -=== 8.3.1 (%style="color:inherit;font-family:inherit;font-size:max(21px,min(23px,17.4444px + 0.462963vw))" %)Scope of a Content Constraint(%%)===966 +=== 8.3.1 Scope of a Content Constraint === 896 896 897 897 A Content Constraint is used specify the content of a data or metadata source in terms of the component values or the keys. 898 898 ... ... @@ -931,20 +931,20 @@ 931 931 932 932 In view of the flexibility of constraints attachment, clear rules on their usage are required. These are elaborated below. 933 933 934 -=== 8.3.2 Multiple Content Constraints === 1005 +=== 8.3.2 Multiple Content Constraints === 935 935 936 936 There can be many Content Constraints for any Constrainable Artefact (e.g. DSD), subject to the following restrictions: 937 937 938 - ====8.3.2.1 Cube Region====1009 +**8.3.2.1 Cube Region** 939 939 940 940 1. The constraint can contain multiple Member Selections (e.g. Dimension) but: 941 941 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) 942 942 943 - ====8.3.2.2 Key Set====1014 +**8.3.2.2 Key Set** 944 944 945 945 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. 946 946 947 -=== 8.3.3 Inheritance of a Content Constraint === 1018 +=== 8.3.3 Inheritance of a Content Constraint === 948 948 949 949 **8.3.3.1 Attachment levels of a Content Constraint** 950 950 ... ... @@ -1167,7 +1167,7 @@ 1167 1167 1168 1168 == 10.1 Introduction == 1169 1169 1170 -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" %)^^~[4~]^^>>path:#_ftn4]](%%). The purpose of the VTL in the SDMX context is to enable the:1241 +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" %)^^~[4~]^^>>path:#_ftn4]](%%). The purpose of the VTL in the SDMX context is to enable the: 1171 1171 1172 1172 * definition of validation and transformation algorithms, in order to specify how to calculate new data from existing ones; 1173 1173 * 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); ... ... @@ -1191,7 +1191,7 @@ 1191 1191 1192 1192 In any case, the aliases used in the VTL transformations have to be mapped to the 1193 1193 1194 -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" %)^^~[5~]^^>>path:#_ftn5]](%%) or user defined operators[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallinkwikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[6~]^^>>path:#_ftn6]](%%) to reference SDMX artefacts. A VtlMappingScheme is a container for zero or more VtlMapping.1265 +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" %)^^~[5~]^^>>path:#_ftn5]](%%) or user defined operators[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[6~]^^>>path:#_ftn6]](%%) to reference SDMX artefacts. A VtlMappingScheme is a container for zero or more VtlMapping. 1195 1195 1196 1196 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. 1197 1197 ... ... @@ -1201,7 +1201,7 @@ 1201 1201 1202 1202 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. 1203 1203 1204 -The SDMX URN[[(% class="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:^^ ^^1275 +The SDMX URN[[(% class="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:^^ ^^ 1205 1205 1206 1206 * SDMXprefix 1207 1207 * SDMX-IM-package-name ... ... @@ -1209,7 +1209,7 @@ 1209 1209 * agency-id 1210 1210 * maintainedobject-id 1211 1211 * maintainedobject-version 1212 -* container-object-id [[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[8~]^^>>path:#_ftn8]]1283 +* container-object-id [[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[8~]^^>>path:#_ftn8]] 1213 1213 * object-id 1214 1214 1215 1215 The generic structure of the URN is the following: ... ... @@ -1228,7 +1228,7 @@ 1228 1228 1229 1229 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). 1230 1230 1231 -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" %)^^~[9~]^^>>path:#_ftn9]](%%), coincides with the name of the artefact. Therefore the maintainedobject-id depends on the class of the artefact:1302 +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" %)^^~[9~]^^>>path:#_ftn9]](%%), coincides with the name of the artefact. Therefore the maintainedobject-id depends on the class of the artefact: 1232 1232 1233 1233 * if the artefact is a ,,Dataflow,,, which is a maintainable class, the maintainedobject-id is the Dataflow name (dataflow-id); 1234 1234 * 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; ... ... @@ -1248,7 +1248,7 @@ 1248 1248 1249 1249 * if the artefact is a ,,Concept ,,(the object-id is the name of the ,,Concept,,) 1250 1250 1251 -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" %)^^~[10~]^^>>path:#_ftn10]](%%):1322 +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" %)^^~[10~]^^>>path:#_ftn10]](%%): 1252 1252 1253 1253 ‘urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=AG:DFR(1.0)’ <- 1254 1254 ... ... @@ -1266,8 +1266,8 @@ 1266 1266 * 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: 1267 1267 ** “datastructure” for the classes Dataflow, Dimension, MeasureDimension, TimeDimension, PrimaryMeasure, DataAttribute, 1268 1268 ** “conceptscheme” for the classes Concept and ConceptScheme o “codelist” for the class Codelist. 1269 -* 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" %)^^~[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 wikiinternallinkwikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[12~]^^>>path:#_ftn12]](%%).1270 -* 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 T,,ransformationScheme,, and cannot be omitted if the artefact comes from another agency.[[(% class="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).1340 +* 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" %)^^~[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" %)^^~[12~]^^>>path:#_ftn12]](%%). 1341 +* 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 T,,ransformationScheme,, and cannot be omitted if the artefact comes from another agency.[[(% class="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). 1271 1271 * 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; 1272 1272 ** 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 1273 1273 ... ... @@ -1294,11 +1294,11 @@ 1294 1294 1295 1295 DFR := DF1 + DF2 1296 1296 1297 -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" %)^^~[14~]^^>>path:#_ftn14]](%%):1368 +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" %)^^~[14~]^^>>path:#_ftn14]](%%): 1298 1298 1299 1299 ‘urn:sdmx:org.sdmx.infomodel.codelist.Codelist=AG:CL_FREQ(1.0)’ 1300 1300 1301 -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" %)^^~[15~]^^>>path:#_ftn15]](%%):1372 +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" %)^^~[15~]^^>>path:#_ftn15]](%%): 1302 1302 1303 1303 CL_FREQ 1304 1304 ... ... @@ -1308,7 +1308,7 @@ 1308 1308 1309 1309 SECTOR 1310 1310 1311 -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" %)^^~[16~]^^>>path:#_ftn16]](%%):1382 +For example, the transformation for renaming the component SECTOR of the dataflow DF1 into SEC can be written as[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[16~]^^>>path:#_ftn16]](%%): 1312 1312 1313 1313 ‘DFR(1.0)’ := ‘DF1(1.0)’ [rename SECTOR to SEC] 1314 1314 ... ... @@ -1342,9 +1342,9 @@ 1342 1342 1343 1343 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. 1344 1344 1345 -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" %)^^~[17~]^^>>path:#_ftn17]](%%).1416 +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" %)^^~[17~]^^>>path:#_ftn17]](%%). 1346 1346 1347 -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" %)^^~[18~]^^>>path:#_ftn18]](%%)1418 +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" %)^^~[18~]^^>>path:#_ftn18]](%%) 1348 1348 1349 1349 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. 1350 1350 ... ... @@ -1358,15 +1358,15 @@ 1358 1358 1359 1359 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. 1360 1360 1361 -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" %)^^~[19~]^^>>path:#_ftn19]](%%).1432 +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" %)^^~[19~]^^>>path:#_ftn19]](%%). 1362 1362 1363 1363 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). 1364 1364 1365 1365 === 10.3.2 General mapping of VTL and SDMX data structures === 1366 1366 1367 -This section makes reference to the VTL “Model for data and their structure”[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[20~]^^>>path:#_ftn20]](%%) and the correspondent SDMX “Data Structure Definition”[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallinkwikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[21~]^^>>path:#_ftn21]](%%).1438 +This section makes reference to the VTL “Model for data and their structure”[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[20~]^^>>path:#_ftn20]](%%) and the correspondent SDMX “Data Structure Definition”[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[21~]^^>>path:#_ftn21]](%%). 1368 1368 1369 -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" %)^^~[22~]^^>>path:#_ftn22]](%%)1440 +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" %)^^~[22~]^^>>path:#_ftn22]](%%) 1370 1370 1371 1371 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. 1372 1372 ... ... @@ -1376,7 +1376,7 @@ 1376 1376 1377 1377 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. 1378 1378 1379 -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" %)^^~[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.1450 +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" %)^^~[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. 1380 1380 1381 1381 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. 1382 1382 ... ... @@ -1466,7 +1466,7 @@ 1466 1466 1467 1467 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 1468 1468 1469 -PrimaryMeasure). In this case it becomes mandatory to specify a different 1958 mapping method through the VtlMappingScheme and VtlDataflowMapping 1959 classes.[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[24~]^^>>path:#_ftn24]](%%)1540 +PrimaryMeasure). In this case it becomes mandatory to specify a different 1958 mapping method through the VtlMappingScheme and VtlDataflowMapping 1959 classes.[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[24~]^^>>path:#_ftn24]](%%) 1470 1470 1471 1471 1960 Please note that the VTL measures can have any name while in SDMX 2.1 the 1961 MeasureComponent has the mandatory name “obs_value”, therefore the name of the VTL measure name must become “obs_value” in SDMX 2.1. 1472 1472 ... ... @@ -1583,15 +1583,15 @@ 1583 1583 1584 1584 The VtlMappingScheme is a container for zero or more VtlDataflowMapping (besides possible mappings to artefacts other than dataflows). 1585 1585 1586 -=== 10.3.6 Mapping dataflow subsets to distinct VTL data sets[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^**~[25~]**^^>>path:#_ftn25]](%%) ===1657 +=== 10.3.6 Mapping dataflow subsets to distinct VTL data sets[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^**~[25~]**^^>>path:#_ftn25]](%%) === 1587 1587 1588 1588 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 1589 1589 1590 1590 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). 1591 1591 1592 -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" %)^^~[26~]^^>>path:#_ftn26]](%%)1663 +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" %)^^~[26~]^^>>path:#_ftn26]](%%) 1593 1593 1594 -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" %)^^~[27~]^^>>path:#_ftn27]](%%)1665 +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" %)^^~[27~]^^>>path:#_ftn27]](%%) 1595 1595 1596 1596 Given a SDMX Dataflow and some predefined Dimensions of its 1597 1597 ... ... @@ -1603,14 +1603,14 @@ 1603 1603 1604 1604 In practice, this kind mapping is obtained like follows: 1605 1605 1606 -* 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" %)^^~[28~]^^>>path:#_ftn28]](%%) Following the example above, imagine that the user declares the dimensions INDICATOR and COUNTRY.1677 +* 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" %)^^~[28~]^^>>path:#_ftn28]](%%) Following the example above, imagine that the user declares the dimensions INDICATOR and COUNTRY. 1607 1607 * The VTL dataset is given a name using a special notation also called “ordered concatenation” and composed of the following parts: 1608 1608 ** The reference to the SDMX dataflow (expressed according to the rules described in the previous paragraphs, i.e. URN, abbreviated 1609 1609 1610 -URN or another alias); for example DF(1.0); o a slash (“/”) as a separator; [[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[29~]^^>>path:#_ftn29]]1681 +URN or another alias); for example DF(1.0); o a slash (“/”) as a separator; [[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[29~]^^>>path:#_ftn29]] 1611 1611 1612 1612 * 1613 -** 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" %)^^~[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.1684 +** 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" %)^^~[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. 1614 1614 1615 1615 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. 1616 1616 ... ... @@ -1628,7 +1628,7 @@ 1628 1628 1629 1629 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. 1630 1630 1631 -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" %)^^~[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.1702 +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" %)^^~[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. 1632 1632 1633 1633 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. 1634 1634 ... ... @@ -1638,7 +1638,7 @@ 1638 1638 1639 1639 //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. 1640 1640 1641 -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" %)^^~[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 …).1712 +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" %)^^~[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 …). 1642 1642 1643 1643 In the example above, for all the datasets of the kind 1644 1644 ... ... @@ -1658,7 +1658,7 @@ 1658 1658 1659 1659 … … … 1660 1660 1661 -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" %)^^~[33~]^^>>path:#_ftn33]]1732 +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" %)^^~[33~]^^>>path:#_ftn33]] 1662 1662 1663 1663 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. 1664 1664 ... ... @@ -1681,12 +1681,12 @@ 1681 1681 1682 1682 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: 1683 1683 1684 -* 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" %)^^~[34~]^^>>path:#_ftn34]](%%)1685 -* 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" %)^^~[35~]^^>>path:#_ftn35]]1755 +* each part is calculated as a VTL derived dataset, result of a dedicated VTL transformation; [[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[34~]^^>>path:#_ftn34]](%%) 1756 +* 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" %)^^~[35~]^^>>path:#_ftn35]] 1686 1686 1687 -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" %)^^~[36~]^^>>path:#_ftn36]](%%).1758 +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" %)^^~[36~]^^>>path:#_ftn36]](%%). 1688 1688 1689 -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" %)^^~[37~]^^>>path:#_ftn37]]1760 +The corresponding VTL transformations, assuming that the result needs to be persistent, would be of this kind:^^ ^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[37~]^^>>path:#_ftn37]] 1690 1690 1691 1691 ‘DF2(1.0)///INDICATORvalue//.//COUNTRYvalue//’ <- expression 1692 1692 ... ... @@ -1753,9 +1753,9 @@ 1753 1753 1754 1754 …); 1755 1755 1756 -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" %)^^~[38~]^^>>path:#_ftn38]](%%), which can be mapped one-to-one to the homonymous SDMX dataflow having the dimension components TIME_PERIOD, INDICATOR and COUNTRY.1827 +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" %)^^~[38~]^^>>path:#_ftn38]](%%), which can be mapped one-to-one to the homonymous SDMX dataflow having the dimension components TIME_PERIOD, INDICATOR and COUNTRY. 1757 1757 1758 -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" %)^^~[39~]^^>>path:#_ftn39]](%%)[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallinkwikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[40~]^^>>path:#_ftn40]]1829 +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" %)^^~[39~]^^>>path:#_ftn39]](%%)[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[40~]^^>>path:#_ftn40]] 1759 1759 1760 1760 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). 1761 1761 ... ... @@ -1804,7 +1804,7 @@ 1804 1804 1805 1805 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). 1806 1806 1807 -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" %)^^~[41~]^^>>path:#_ftn41]](%%), while the SDMX Concepts can have different Representations in different DataStructures.[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallinkwikiinternallink 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.1878 +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" %)^^~[41~]^^>>path:#_ftn41]](%%), while the SDMX Concepts can have different Representations in different DataStructures.[[(% class="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. 1808 1808 1809 1809 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 1810 1810 ... ... @@ -2093,12 +2093,12 @@ 2093 2093 “true” or “false” 2094 2094 ))) 2095 2095 2096 - 2097 - 2098 2098 **Figure 14 – Mappings from SDMX data types to VTL Basic Scalar Types** 2099 2099 2100 -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).2169 +In case a different default conversion is desired, it can be achieved through the 2101 2101 2171 +CustomTypeScheme and CustomType artefacts (see also the section Transformations and Expressions of the SDMX information model). 2172 + 2102 2102 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. 2103 2103 2104 2104 |(% colspan="2" %)**VTL special characters for the formatting masks** ... ... @@ -2149,7 +2149,7 @@ 2149 2149 |N|fixed number of digits used in the preceding textual representation of the month or the day 2150 2150 | | 2151 2151 2152 -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" %)^^~[43~]^^>>path:#_ftn43]](%%).2223 +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" %)^^~[43~]^^>>path:#_ftn43]](%%). 2153 2153 2154 2154 === 10.4.5 Null Values === 2155 2155 ... ... @@ -2181,18 +2181,12 @@ 2181 2181 2182 2182 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”. 2183 2183 2184 -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: 2255 +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: 2185 2185 2186 -[[image:1747854006117-843.png]] 2187 - 2188 2188 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. 2189 2189 2190 2190 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: 2191 2191 2192 -[[image:1747854039499-443.png]] 2193 - 2194 -[[image:1747854067769-691.png]] 2195 - 2196 2196 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. 2197 2197 2198 2198 == 11.2 Solution == ... ... @@ -2213,30 +2213,20 @@ 2213 2213 2214 2214 To understand how the **XmlAnyElement** attribute works we present the following two web methods: 2215 2215 2216 - [[image:1747854096778-844.png]]2281 +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. 2217 2217 2218 - In this methodthe **input** parameteris decoratedwith the**XmlAnyElement** parameter. This is a hint that this parameterwill bede-serialized from an**xsd:any** element. Since theattribute is notpassed any parameters,it means thatthe entire XML elementfor this parameterintheSOAPmessage will be inthe Infoset that is representedby this**XmlElement**parameter.2283 +The difference between the two is that for the first method, **SubmitXml**, the 2219 2219 2220 - [[image:1747854127303-270.png]]2285 +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. 2221 2221 2222 -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. 2223 - 2224 -[[image:1747854163928-581.png]] 2225 - 2226 2226 Now we look at the message for the method that uses the **XmlAnyElement** attribute. 2227 2227 2228 -[[image:1747854190641-364.png]] 2229 - 2230 -[[image:1747854236732-512.png]] 2231 - 2232 2232 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. 2233 2233 2234 -For more information please consult: [[http:~~/~~/msdn.microsoft.com/en-us/library/aa480498.aspx>>http://msdn.microsoft.com/en-us/library/aa480498.aspx]] 2291 +For more information please consult: [[http:~~/~~/msdn.microsoft.com/en>>url:http://msdn.microsoft.com/en-us/library/aa480498.aspx]][[->>url:http://msdn.microsoft.com/en-us/library/aa480498.aspx]][[us/library/aa480498.aspx>>url:http://msdn.microsoft.com/en-us/library/aa480498.aspx]][[url:http://msdn.microsoft.com/en-us/library/aa480498.aspx]] 2235 2235 2236 2236 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. 2237 2237 2238 -[[image:1747854286398-614.png]] 2239 - 2240 2240 Without a common WSDL still the solution doesn’t enforce interoperability. In order to 2241 2241 2242 2242 “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. ... ... @@ -2249,27 +2249,16 @@ 2249 2249 2250 2250 In the context of the SDMX Web Service, applying the above solution translates into the following: 2251 2251 2252 -[[image:1747854385465-132.png]] 2253 - 2254 2254 The SOAP request/response will then be as follows: 2255 2255 2256 2256 **GenericData Request** 2257 2257 2258 -[[image:1747854406014-782.png]] 2259 - 2260 2260 **GenericData Response** 2261 2261 2262 -[[image:1747854424488-855.png]] 2263 - 2264 2264 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: 2265 2265 2266 -[[image:1747854453895-524.png]] 2267 - 2268 -[[image:1747854476631-125.png]] 2269 - 2270 2270 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: 2271 2271 2272 -[[image:1747854493363-776.png]] 2273 2273 2274 2274 ---- 2275 2275 ... ... @@ -2362,5 +2362,3 @@ 2362 2362 [[~[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. 2363 2363 2364 2364 [[~[43~]>>path:#_ftnref43]] The representation given in the DSD should obviously be compatible with the VTL data type. 2365 - 2366 -{{putFootnotes/}}
- 1747854006117-843.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -18.7 KB - Content
- 1747854039499-443.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -3.0 KB - Content
- 1747854067769-691.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -21.4 KB - Content
- 1747854096778-844.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -10.6 KB - Content
- 1747854127303-270.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -12.1 KB - Content
- 1747854163928-581.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -29.8 KB - Content
- 1747854190641-364.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -31.5 KB - Content
- 1747854236732-512.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -2.0 KB - Content
- 1747854286398-614.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -55.0 KB - Content
- 1747854385465-132.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -55.0 KB - Content
- 1747854406014-782.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -55.0 KB - Content
- 1747854424488-855.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -55.0 KB - Content
- 1747854453895-524.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -55.0 KB - Content
- 1747854476631-125.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -55.0 KB - Content
- 1747854493363-776.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -55.0 KB - Content
- 1747855024745-946.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -55.0 KB - Content
- 1747855054559-410.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -55.0 KB - Content
- 1747855075263-887.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -55.0 KB - Content