Skip to Content
Last modified by Artur on 2025/09/10 11:19
From version 3.3
edited by Helena
on 2025/06/16 13:43
Change comment: There is no comment for this version
To version 1.25
edited by Helena
on 2025/06/16 13:38
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -18,7 +18,7 @@
18 18  
19 19  This section does not explain the VTL language or any of the content published in the VTL guides. Rather, this is a description of how the VTL can be used in the SDMX context and applied to SDMX artefacts.
20 20  
21 -== 12.2 References to SDMX artefacts from VTL statements ==
21 +== 12.2 References to SDMX artefacts from VTL statements ==
22 22  
23 23  === 12.2.1 Introduction ===
24 24  
... ... @@ -116,7 +116,7 @@
116 116  
117 117  by omitting all the non-essential parts would become simply:
118 118  
119 -> DFR  : = DF1 + DF2
119 +> DFR  : =  DF1 + DF2
120 120  
121 121  The references to the Codelists can be simplified similarly. For example, given the non-abbreviated reference to the Codelist AG:CL_FREQ(1.0.0), which is{{footnote}}Single quotes are needed because this reference is not a VTL regular name. 19 Single quotes are not needed in this case because CL_FREQ is a VTL regular name.{{/footnote}}:
122 122  
... ... @@ -452,17 +452,16 @@
452 452  
453 453  > ‘DF2(1.0.0)/GDPPERCAPITA.USA’ <- expression11; ‘DF2(1.0.0)/GDPPERCAPITA.CANADA’ <- expression12;
454 454  > … … …
455 -> ‘DF2(1.0.0)/POPGROWTH.USA’ <- expression21;
455 +> ‘DF2(1.0.0)/POPGROWTH.USA’ <- expression21;
456 456  > ‘DF2(1.0.0)/POPGROWTH.CANADA’ <- expression22;
457 457  > … … …
458 458  
459 459  As said, it is assumed that these VTL derived Data Sets have the TIME_PERIOD as the only identifier. In the mapping from VTL to SMDX, the Dimensions INDICATOR and COUNTRY are added to the VTL data structure on order to obtain the SDMX one, with the following values respectively:
460 460  
461 -> VTL dataset  INDICATOR value COUNTRY value
462 ->
461 +VTL dataset   INDICATOR value COUNTRY value
462 +
463 463  > ‘DF2(1.0.0)/GDPPERCAPITA.USA’ GDPPERCAPITA USA
464 464  > ‘DF2(1.0.0)/GDPPERCAPITA.CANADA’ GDPPERCAPITA CANADA … … …
465 ->
466 466  > ‘DF2(1.0.0)/POPGROWTH.USA’  POPGROWTH USA
467 467  > ‘DF2(1.0.0)/POPGROWTH.CANADA’ POPGROWTH CANADA
468 468  > … … …
... ... @@ -544,8 +544,6 @@
544 544  
545 545  The VTL basic scalar types are listed below and follow a hierarchical structure in terms of supersets/subsets (e.g. "scalar" is the superset of all the basic scalar types):
546 546  
547 -[[image:1750070310572-584.png]]
548 -
549 549  **Figure 23 – VTL Basic Scalar Types**
550 550  
551 551  === 12.4.2 VTL basic scalar types and SDMX data types ===
... ... @@ -570,157 +570,158 @@
570 570  
571 571  The following table describes the default mapping for converting from the SDMX data types to the VTL basic scalar types.
572 572  
573 -(% style="width:583.294px" %)
574 -|(% style="width:360px" %)SDMX data type (BasicComponentDataType)|(% style="width:221px" %)Default VTL basic scalar type
575 -|(% style="width:360px" %)(((
570 +|SDMX data type (BasicComponentDataType)|Default VTL basic scalar type
571 +|(((
576 576  String
577 577  (string allowing any character)
578 -)))|(% style="width:221px" %)string
579 -|(% style="width:360px" %)(((
580 -Alpha
574 +)))|string
575 +|(((
576 +Alpha 
577 +
581 581  (string which only allows A-z)
582 -)))|(% style="width:221px" %)string
583 -|(% style="width:360px" %)(((
579 +)))|string
580 +|(((
584 584  AlphaNumeric
585 585  (string which only allows A-z and 0-9)
586 -)))|(% style="width:221px" %)string
587 -|(% style="width:360px" %)(((
583 +)))|string
584 +|(((
588 588  Numeric
586 +
589 589  (string which only allows 0-9, but is not numeric so that is can having leading zeros)
590 -)))|(% style="width:221px" %)string
591 -|(% style="width:360px" %)(((
588 +)))|string
589 +|(((
592 592  BigInteger
593 593  (corresponds to XML Schema xs:integer datatype; infinite set of integer values)
594 -)))|(% style="width:221px" %)integer
595 -|(% style="width:360px" %)(((
592 +)))|integer
593 +|(((
596 596  Integer
597 597  (corresponds to XML Schema xs:int datatype; between -2147483648 and +2147483647
598 598  (inclusive))
599 -)))|(% style="width:221px" %)integer
600 -|(% style="width:360px" %)(((
597 +)))|integer
598 +|(((
601 601  Long
602 602  (corresponds to XML Schema xs:long datatype; between -9223372036854775808 and
603 603  +9223372036854775807 (inclusive))
604 -)))|(% style="width:221px" %)integer
605 -|(% style="width:360px" %)(((
602 +)))|integer
603 +|(((
606 606  Short
607 607  (corresponds to XML Schema xs:short datatype; between -32768 and -32767 (inclusive))
608 -)))|(% style="width:221px" %)integer
609 -|(% style="width:360px" %)Decimal (corresponds to XML Schema xs:decimal datatype; subset of real numbers that can be represented as decimals)|(% style="width:221px" %)number
610 -|(% style="width:360px" %)(((
606 +)))|integer
607 +|Decimal (corresponds to XML Schema xs:decimal datatype; subset of real numbers that can be represented as decimals)|number
608 +|(((
611 611  Float
612 612  (corresponds to XML Schema xs:float datatype; patterned after the IEEE single-precision 32-bit floating point type)
613 -)))|(% style="width:221px" %)number
614 -|(% style="width:360px" %)(((
611 +)))|number
612 +|(((
615 615  Double
616 616  (corresponds to XML Schema xs:double datatype; patterned after the IEEE double-precision 64-bit floating point type)
617 -)))|(% style="width:221px" %)number
618 -|(% style="width:360px" %)(((
615 +)))|number
616 +|(((
619 619  Boolean
620 620  (corresponds to the XML Schema xs:boolean datatype; support the mathematical concept of
621 621  binary-valued logic: {true, false})
622 -)))|(% style="width:221px" %)boolean
623 -|(% style="width:360px" %)(((
620 +)))|boolean
621 +|(((
624 624  URI
625 625  (corresponds to the XML Schema xs:anyURI; absolute or relative Uniform Resource Identifier Reference)
626 -)))|(% style="width:221px" %)string
627 -|(% style="width:360px" %)(((
624 +)))|string
625 +|(((
628 628  Count
629 629  (an integer following a sequential pattern, increasing by 1 for each occurrence)
630 -)))|(% style="width:221px" %)integer
631 -|(% style="width:360px" %)(((
628 +)))|integer
629 +|(((
632 632  InclusiveValueRange
633 633  (decimal number within a closed interval, whose bounds are specified in the SDMX representation by the facets minValue and maxValue)
634 -)))|(% style="width:221px" %)number
635 -|(% style="width:360px" %)(((
632 +)))|number
633 +|(((
636 636  ExclusiveValueRange
637 637  (decimal number within an open interval, whose bounds are specified in the SDMX representation by the facets minValue and maxValue)
638 -)))|(% style="width:221px" %)number
639 -|(% style="width:360px" %)(((
636 +)))|number
637 +|(((
640 640  Incremental
641 641  (decimal number the increased by a specific interval (defined by the interval facet), which is typically enforced outside of the XML validation)
642 -)))|(% style="width:221px" %)number
643 -|(% style="width:360px" %)(((
640 +)))|number
641 +|(((
644 644  ObservationalTimePeriod
645 645  (superset of StandardTimePeriod and TimeRange)
646 -)))|(% style="width:221px" %)time
647 -|(% style="width:360px" %)(((
644 +)))|time
645 +|(((
648 648  StandardTimePeriod
649 649  (superset of BasicTimePeriod and ReportingTimePeriod)
650 -)))|(% style="width:221px" %)time
651 -|(% style="width:360px" %)(((
648 +)))|time
649 +|(((
652 652  BasicTimePeriod
653 653  (superset of GregorianTimePeriod and DateTime)
654 -)))|(% style="width:221px" %)date
655 -|(% style="width:360px" %)(((
652 +)))|date
653 +|(((
656 656  GregorianTimePeriod
657 657  (superset of GregorianYear, GregorianYearMonth, and GregorianDay)
658 -)))|(% style="width:221px" %)date
659 -|(% style="width:360px" %)GregorianYear (YYYY)|(% style="width:221px" %)date
660 -|(% style="width:360px" %)GregorianYearMonth / GregorianMonth (YYYY-MM)|(% style="width:221px" %)date
661 -|(% style="width:360px" %)GregorianDay (YYYY-MM-DD)|(% style="width:221px" %)date
662 -|(% style="width:360px" %)(((
656 +)))|date
657 +|GregorianYear (YYYY)|date
658 +|GregorianYearMonth / GregorianMonth (YYYY-MM)|date
659 +|GregorianDay (YYYY-MM-DD)|date
660 +|(((
663 663  ReportingTimePeriod
664 664  (superset of RepostingYear, ReportingSemester, ReportingTrimester, ReportingQuarter, ReportingMonth, ReportingWeek, ReportingDay)
665 -)))|(% style="width:221px" %)time_period
666 -|(% style="width:360px" %)(((
663 +)))|time_period
664 +|(((
667 667  ReportingYear
668 668  (YYYY-A1 – 1 year period)
669 -)))|(% style="width:221px" %)time_period
670 -|(% style="width:360px" %)(((
667 +)))|time_period
668 +|(((
671 671  ReportingSemester
672 672  (YYYY-Ss – 6 month period)
673 -)))|(% style="width:221px" %)time_period
674 -|(% style="width:360px" %)(((
671 +)))|time_period
672 +|(((
675 675  ReportingTrimester
676 676  (YYYY-Tt – 4 month period)
677 -)))|(% style="width:221px" %)time_period
678 -|(% style="width:360px" %)(((
675 +)))|time_period
676 +|(((
679 679  ReportingQuarter
680 680  (YYYY-Qq – 3 month period)
681 -)))|(% style="width:221px" %)time_period
682 -|(% style="width:360px" %)(((
679 +)))|time_period
680 +|(((
683 683  ReportingMonth
684 684  (YYYY-Mmm – 1 month period)
685 -)))|(% style="width:221px" %)time_period
686 -|(% style="width:360px" %)ReportingWeek|(% style="width:221px" %)time_period
687 -|(% style="width:360px" %) (YYYY-Www – 7 day period; following ISO 8601 definition of a week in a year)|(% style="width:221px" %)
688 -|(% style="width:360px" %)(((
683 +)))|time_period
684 +|ReportingWeek|time_period
685 +| (YYYY-Www – 7 day period; following ISO 8601 definition of a week in a year)|
686 +|(((
689 689  ReportingDay
690 690  (YYYY-Dddd – 1 day period)
691 -)))|(% style="width:221px" %)time_period
692 -|(% style="width:360px" %)(((
689 +)))|time_period
690 +|(((
693 693  DateTime
694 694  (YYYY-MM-DDThh:mm:ss)
695 -)))|(% style="width:221px" %)date
696 -|(% style="width:360px" %)(((
693 +)))|date
694 +|(((
697 697  TimeRange
698 698  (YYYY-MM-DD(Thh:mm:ss)?/<duration>)
699 -)))|(% style="width:221px" %)time
700 -|(% style="width:360px" %)(((
697 +)))|time
698 +|(((
701 701  Month
702 702  (~-~-MM; speicifies a month independent of a year; e.g. February is black history month in the United States)
703 -)))|(% style="width:221px" %)string
704 -|(% style="width:360px" %)(((
701 +)))|string
702 +|(((
705 705  MonthDay
706 706  (~-~-MM-DD; specifies a day within a month independent of a year; e.g. Christmas is December 25^^th^^; used to specify reporting year start day)
707 -)))|(% style="width:221px" %)string
708 -|(% style="width:360px" %)(((
705 +)))|string
706 +|(((
709 709  Day
710 710  (~-~--DD; specifies a day independent of a month or year; e.g. the 15^^th^^ is payday)
711 -)))|(% style="width:221px" %)string
712 -|(% style="width:360px" %)(((
709 +)))|string
710 +|(((
713 713  Time
714 714  (hh:mm:ss; time independent of a date; e.g. coffee break is at 10:00 AM)
715 -)))|(% style="width:221px" %)string
716 -|(% style="width:360px" %)(((
713 +)))|string
714 +|(((
717 717  Duration
718 718  (corresponds to XML Schema xs:duration datatype)
719 -)))|(% style="width:221px" %)duration
720 -|(% style="width:360px" %)XHTML|(% style="width:221px" %)Metadata type – not applicable
721 -|(% style="width:360px" %)KeyValues|(% style="width:221px" %)Metadata type – not applicable
722 -|(% style="width:360px" %)IdentifiableReference|(% style="width:221px" %)Metadata type – not applicable
723 -|(% style="width:360px" %)DataSetReference|(% style="width:221px" %)Metadata type – not applicable
717 +)))|duration
718 +|XHTML|Metadata type – not applicable
719 +|KeyValues|Metadata type – not applicable
720 +|IdentifiableReference|Metadata type – not applicable
721 +|DataSetReference|Metadata type – not applicable
724 724  
725 725  **Figure 14 – Mappings from SDMX data types to VTL Basic Scalar Types**
726 726  
... ... @@ -730,82 +730,84 @@
730 730  
731 731  The following table describes the default conversion from the VTL basic scalar types to the SDMX data types .
732 732  
733 -(% style="width:748.294px" %)
734 -|(% style="width:164px" %)(((
735 -VTL basic scalar type
736 -)))|(% style="width:304px" %)(((
731 +|(((
732 +VTL basic
733 +scalar type
734 +)))|(((
737 737  Default SDMX data type
738 -(BasicComponentDataType)
739 -)))|(% style="width:277px" %)Default output format
740 -|(% style="width:164px" %)String|(% style="width:304px" %)String|(% style="width:277px" %)Like XML (xs:string)
741 -|(% style="width:164px" %)Number|(% style="width:304px" %)Float|(% style="width:277px" %)Like XML (xs:float)
742 -|(% style="width:164px" %)Integer|(% style="width:304px" %)Integer|(% style="width:277px" %)Like XML (xs:int)
743 -|(% style="width:164px" %)Date|(% style="width:304px" %)DateTime|(% style="width:277px" %)YYYY-MM-DDT00:00:00Z
744 -|(% style="width:164px" %)Time|(% style="width:304px" %)StandardTimePeriod|(% style="width:277px" %)<date>/<date> (as defined above)
745 -|(% style="width:164px" %)time_period|(% style="width:304px" %)(((
736 +(BasicComponentDataType
737 +)
738 +)))|Default output format
739 +|String|String|Like XML (xs:string)
740 +|Number|Float|Like XML (xs:float)
741 +|Integer|Integer|Like XML (xs:int)
742 +|Date|DateTime|YYYY-MM-DDT00:00:00Z
743 +|Time|StandardTimePeriod|<date>/<date> (as defined above)
744 +|time_period|(((
746 746  ReportingTimePeriod
747 747  (StandardReportingPeriod)
748 -)))|(% style="width:277px" %)(((
747 +)))|(((
749 749   YYYY-Pppp
750 750  (according to SDMX )
751 751  )))
752 -|(% style="width:164px" %)Duration|(% style="width:304px" %)Duration|(% style="width:277px" %)Like XML (xs:duration) PnYnMnDTnHnMnS
753 -|(% style="width:164px" %)Boolean|(% style="width:304px" %)Boolean|(% style="width:277px" %)Like XML (xs:boolean) with the values "true" or "false"
751 +|Duration|Duration|Like XML (xs:duration) PnYnMnDTnHnMnS
752 +|Boolean|Boolean|Like XML (xs:boolean) with the values "true" or "false"
754 754  
755 755  **Figure 14 – Mappings from SDMX data types to VTL Basic Scalar Types**
756 756  
757 -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).
756 +In case a different default conversion is desired, it can be achieved through the CustomTypeScheme and CustomType artefacts (see also the section
758 758  
758 +Transformations and Expressions of the SDMX information model).
759 +
759 759  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.
760 760  
761 -(% style="width:717.294px" %)
762 -|(% colspan="2" style="width:714px" %)VTL special characters for the formatting masks
763 -|(% colspan="2" style="width:714px" %)
764 -|(% colspan="2" style="width:714px" %)Number
765 -|(% style="width:122px" %)D|(% style="width:591px" %)one numeric digit (if the scientific notation is adopted, D is only for the mantissa)
766 -|(% style="width:122px" %)E|(% style="width:591px" %)one numeric digit (for the exponent of the scientific notation)
767 -|(% style="width:122px" %). (dot)|(% style="width:591px" %)possible separator between the integer and the decimal parts.
768 -|(% style="width:122px" %), (comma)|(% style="width:591px" %)possible separator between the integer and the decimal parts.
769 -|(% style="width:122px" %) |(% style="width:591px" %)
770 -|(% colspan="2" style="width:714px" %)Time and duration
771 -|(% style="width:122px" %)C|(% style="width:591px" %)century
772 -|(% style="width:122px" %)Y|(% style="width:591px" %)year
773 -|(% style="width:122px" %)S|(% style="width:591px" %)semester
774 -|(% style="width:122px" %)Q|(% style="width:591px" %)quarter
775 -|(% style="width:122px" %)M|(% style="width:591px" %)month
776 -|(% style="width:122px" %)W|(% style="width:591px" %)week
777 -|(% style="width:122px" %)D|(% style="width:591px" %)day
778 -|(% style="width:122px" %)h|(% style="width:591px" %)hour digit (by default on 24 hours)
779 -|(% style="width:122px" %)M|(% style="width:591px" %)minute
780 -|(% style="width:122px" %)S|(% style="width:591px" %)second
781 -|(% style="width:122px" %)D|(% style="width:591px" %)decimal of second
782 -|(% style="width:122px" %)P|(% style="width:591px" %)period indicator (representation in one digit for the duration)
783 -|(% style="width:122px" %)P|(% style="width:591px" %)number of the periods specified in the period indicator
784 -|(% style="width:122px" %)AM/PM|(% style="width:591px" %)indicator of AM / PM (e.g. am/pm for "am" or "pm")
785 -|(% style="width:122px" %)MONTH|(% style="width:591px" %)uppercase textual representation of the month (e.g., JANUARY for January)
786 -|(% style="width:122px" %)DAY|(% style="width:591px" %)uppercase textual representation of the day (e.g., MONDAY for Monday)
787 -|(% style="width:122px" %)Month|(% style="width:591px" %)lowercase textual representation of the month (e.g., january)
788 -|(% style="width:122px" %)Day|(% style="width:591px" %)lowercase textual representation of the month (e.g., monday)
789 -|(% style="width:122px" %)Month|(% style="width:591px" %)First character uppercase, then lowercase textual representation of the month (e.g., January)
790 -|(% style="width:122px" %)Day|(% style="width:591px" %)First character uppercase, then lowercase textual representation of the day using (e.g. Monday)
791 -|(% style="width:122px" %) |(% style="width:591px" %)
792 -|(% colspan="2" style="width:714px" %)String
793 -|(% style="width:122px" %)X|(% style="width:591px" %)any string character
794 -|(% style="width:122px" %)Z|(% style="width:591px" %)any string character from "A" to "z"
795 -|(% style="width:122px" %)9|(% style="width:591px" %)any string character from "0" to "9"
796 -|(% style="width:122px" %) |(% style="width:591px" %)
797 -|(% colspan="2" style="width:714px" %)Boolean
798 -|(% style="width:122px" %)B|(% style="width:591px" %)Boolean using "true" for True and "false" for False
799 -|(% style="width:122px" %)1|(% style="width:591px" %)Boolean using "1" for True and "0" for False
800 -|(% style="width:122px" %)0|(% style="width:591px" %)Boolean using "0" for True and "1" for False
801 -|(% style="width:122px" %) |(% style="width:591px" %)
802 -|(% colspan="2" style="width:714px" %)Other qualifiers
803 -|(% style="width:122px" %)*|(% style="width:591px" %)an arbitrary number of digits (of the preceding type)
804 -|(% style="width:122px" %)+|(% style="width:591px" %)at least one digit (of the preceding type)
805 -|(% style="width:122px" %)( )|(% style="width:591px" %)optional digits (specified within the brackets)
806 -|(% style="width:122px" %)\|(% style="width:591px" %)prefix for the special characters that must appear in the mask
807 -|(% style="width:122px" %)N|(% style="width:591px" %)fixed number of digits used in the preceding textual representation of the month or the day
808 -|(% style="width:122px" %) |(% style="width:591px" %)
762 +|(% colspan="2" %)VTL special characters for the formatting masks
763 +|(% colspan="2" %)
764 +|(% colspan="2" %)Number
765 +|D|one numeric digit (if the scientific notation is adopted, D is only for the mantissa)
766 +|E|one numeric digit (for the exponent of the scientific notation)
767 +|. (dot)|possible separator between the integer and the decimal parts.
768 +|, (comma)|possible separator between the integer and the decimal parts.
769 +| |
770 +|(% colspan="2" %)Time and duration
771 +|C|century
772 +|Y|year
773 +|S|semester
774 +|Q|quarter
775 +|M|month
776 +|W|week
777 +|D|day
778 +|h|hour digit (by default on 24 hours)
779 +|M|minute
780 +|S|second
781 +|D|decimal of second
782 +|P|period indicator (representation in one digit for the duration)
783 +|P|number of the periods specified in the period indicator
784 +|AM/PM|indicator of AM / PM (e.g. am/pm for "am" or "pm")
785 +|MONTH|uppercase textual representation of the month (e.g., JANUARY for January)
786 +|DAY|uppercase textual representation of the day (e.g., MONDAY for Monday)
787 +|Month|lowercase textual representation of the month (e.g., january)
788 +|Day|lowercase textual representation of the month (e.g., monday)
789 +|Month|First character uppercase, then lowercase textual representation of the month (e.g., January)
790 +|Day|First character uppercase, then lowercase textual representation of the day using (e.g. Monday)
791 +| |
792 +|(% colspan="2" %)String
793 +|X|any string character
794 +|Z|any string character from "A" to "z"
795 +|9|any string character from "0" to "9"
796 +| |
797 +|(% colspan="2" %)Boolean
798 +|B|Boolean using "true" for True and "false" for False
799 +|1|Boolean using "1" for True and "0" for False
800 +|0|Boolean using "0" for True and "1" for False
801 +| |
802 +|(% colspan="2" %)Other qualifiers
803 +|*|an arbitrary number of digits (of the preceding type)
804 +|+|at least one digit (of the preceding type)
805 +|( )|optional digits (specified within the brackets)
806 +|\|prefix for the special characters that must appear in the mask
807 +|N|fixed number of digits used in the preceding textual representation of the month or the day
808 +| |
809 809  
810 810  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{{footnote}}The representation given in the DSD should obviously be compatible with the VTL data type.{{/footnote}}.
811 811  
1750070310572-584.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -18.9 KB
Content
1750067055028-964.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +5.5 KB
Content