Skip to Content
Last modified by Artur on 2025/09/10 11:19
From version 1.25
edited by Helena
on 2025/06/16 13:38
Change comment: There is no comment for this version
To version 3.2
edited by Helena
on 2025/06/16 13:41
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  
... ... @@ -543,6 +543,8 @@
543 543  
544 544  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):
545 545  
546 +[[image:1750070310572-584.png]]
547 +
546 546  **Figure 23 – VTL Basic Scalar Types**
547 547  
548 548  === 12.4.2 VTL basic scalar types and SDMX data types ===
... ... @@ -567,158 +567,157 @@
567 567  
568 568  The following table describes the default mapping for converting from the SDMX data types to the VTL basic scalar types.
569 569  
570 -|SDMX data type (BasicComponentDataType)|Default VTL basic scalar type
571 -|(((
572 +(% style="width:583.294px" %)
573 +|(% style="width:360px" %)SDMX data type (BasicComponentDataType)|(% style="width:221px" %)Default VTL basic scalar type
574 +|(% style="width:360px" %)(((
572 572  String
573 573  (string allowing any character)
574 -)))|string
575 -|(((
576 -Alpha 
577 -
577 +)))|(% style="width:221px" %)string
578 +|(% style="width:360px" %)(((
579 +Alpha
578 578  (string which only allows A-z)
579 -)))|string
580 -|(((
581 +)))|(% style="width:221px" %)string
582 +|(% style="width:360px" %)(((
581 581  AlphaNumeric
582 582  (string which only allows A-z and 0-9)
583 -)))|string
584 -|(((
585 +)))|(% style="width:221px" %)string
586 +|(% style="width:360px" %)(((
585 585  Numeric
586 -
587 587  (string which only allows 0-9, but is not numeric so that is can having leading zeros)
588 -)))|string
589 -|(((
589 +)))|(% style="width:221px" %)string
590 +|(% style="width:360px" %)(((
590 590  BigInteger
591 591  (corresponds to XML Schema xs:integer datatype; infinite set of integer values)
592 -)))|integer
593 -|(((
593 +)))|(% style="width:221px" %)integer
594 +|(% style="width:360px" %)(((
594 594  Integer
595 595  (corresponds to XML Schema xs:int datatype; between -2147483648 and +2147483647
596 596  (inclusive))
597 -)))|integer
598 -|(((
598 +)))|(% style="width:221px" %)integer
599 +|(% style="width:360px" %)(((
599 599  Long
600 600  (corresponds to XML Schema xs:long datatype; between -9223372036854775808 and
601 601  +9223372036854775807 (inclusive))
602 -)))|integer
603 -|(((
603 +)))|(% style="width:221px" %)integer
604 +|(% style="width:360px" %)(((
604 604  Short
605 605  (corresponds to XML Schema xs:short datatype; between -32768 and -32767 (inclusive))
606 -)))|integer
607 -|Decimal (corresponds to XML Schema xs:decimal datatype; subset of real numbers that can be represented as decimals)|number
608 -|(((
607 +)))|(% style="width:221px" %)integer
608 +|(% 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
609 +|(% style="width:360px" %)(((
609 609  Float
610 610  (corresponds to XML Schema xs:float datatype; patterned after the IEEE single-precision 32-bit floating point type)
611 -)))|number
612 -|(((
612 +)))|(% style="width:221px" %)number
613 +|(% style="width:360px" %)(((
613 613  Double
614 614  (corresponds to XML Schema xs:double datatype; patterned after the IEEE double-precision 64-bit floating point type)
615 -)))|number
616 -|(((
616 +)))|(% style="width:221px" %)number
617 +|(% style="width:360px" %)(((
617 617  Boolean
618 618  (corresponds to the XML Schema xs:boolean datatype; support the mathematical concept of
619 619  binary-valued logic: {true, false})
620 -)))|boolean
621 -|(((
621 +)))|(% style="width:221px" %)boolean
622 +|(% style="width:360px" %)(((
622 622  URI
623 623  (corresponds to the XML Schema xs:anyURI; absolute or relative Uniform Resource Identifier Reference)
624 -)))|string
625 -|(((
625 +)))|(% style="width:221px" %)string
626 +|(% style="width:360px" %)(((
626 626  Count
627 627  (an integer following a sequential pattern, increasing by 1 for each occurrence)
628 -)))|integer
629 -|(((
629 +)))|(% style="width:221px" %)integer
630 +|(% style="width:360px" %)(((
630 630  InclusiveValueRange
631 631  (decimal number within a closed interval, whose bounds are specified in the SDMX representation by the facets minValue and maxValue)
632 -)))|number
633 -|(((
633 +)))|(% style="width:221px" %)number
634 +|(% style="width:360px" %)(((
634 634  ExclusiveValueRange
635 635  (decimal number within an open interval, whose bounds are specified in the SDMX representation by the facets minValue and maxValue)
636 -)))|number
637 -|(((
637 +)))|(% style="width:221px" %)number
638 +|(% style="width:360px" %)(((
638 638  Incremental
639 639  (decimal number the increased by a specific interval (defined by the interval facet), which is typically enforced outside of the XML validation)
640 -)))|number
641 -|(((
641 +)))|(% style="width:221px" %)number
642 +|(% style="width:360px" %)(((
642 642  ObservationalTimePeriod
643 643  (superset of StandardTimePeriod and TimeRange)
644 -)))|time
645 -|(((
645 +)))|(% style="width:221px" %)time
646 +|(% style="width:360px" %)(((
646 646  StandardTimePeriod
647 647  (superset of BasicTimePeriod and ReportingTimePeriod)
648 -)))|time
649 -|(((
649 +)))|(% style="width:221px" %)time
650 +|(% style="width:360px" %)(((
650 650  BasicTimePeriod
651 651  (superset of GregorianTimePeriod and DateTime)
652 -)))|date
653 -|(((
653 +)))|(% style="width:221px" %)date
654 +|(% style="width:360px" %)(((
654 654  GregorianTimePeriod
655 655  (superset of GregorianYear, GregorianYearMonth, and GregorianDay)
656 -)))|date
657 -|GregorianYear (YYYY)|date
658 -|GregorianYearMonth / GregorianMonth (YYYY-MM)|date
659 -|GregorianDay (YYYY-MM-DD)|date
660 -|(((
657 +)))|(% style="width:221px" %)date
658 +|(% style="width:360px" %)GregorianYear (YYYY)|(% style="width:221px" %)date
659 +|(% style="width:360px" %)GregorianYearMonth / GregorianMonth (YYYY-MM)|(% style="width:221px" %)date
660 +|(% style="width:360px" %)GregorianDay (YYYY-MM-DD)|(% style="width:221px" %)date
661 +|(% style="width:360px" %)(((
661 661  ReportingTimePeriod
662 662  (superset of RepostingYear, ReportingSemester, ReportingTrimester, ReportingQuarter, ReportingMonth, ReportingWeek, ReportingDay)
663 -)))|time_period
664 -|(((
664 +)))|(% style="width:221px" %)time_period
665 +|(% style="width:360px" %)(((
665 665  ReportingYear
666 666  (YYYY-A1 – 1 year period)
667 -)))|time_period
668 -|(((
668 +)))|(% style="width:221px" %)time_period
669 +|(% style="width:360px" %)(((
669 669  ReportingSemester
670 670  (YYYY-Ss – 6 month period)
671 -)))|time_period
672 -|(((
672 +)))|(% style="width:221px" %)time_period
673 +|(% style="width:360px" %)(((
673 673  ReportingTrimester
674 674  (YYYY-Tt – 4 month period)
675 -)))|time_period
676 -|(((
676 +)))|(% style="width:221px" %)time_period
677 +|(% style="width:360px" %)(((
677 677  ReportingQuarter
678 678  (YYYY-Qq – 3 month period)
679 -)))|time_period
680 -|(((
680 +)))|(% style="width:221px" %)time_period
681 +|(% style="width:360px" %)(((
681 681  ReportingMonth
682 682  (YYYY-Mmm – 1 month period)
683 -)))|time_period
684 -|ReportingWeek|time_period
685 -| (YYYY-Www – 7 day period; following ISO 8601 definition of a week in a year)|
686 -|(((
684 +)))|(% style="width:221px" %)time_period
685 +|(% style="width:360px" %)ReportingWeek|(% style="width:221px" %)time_period
686 +|(% style="width:360px" %) (YYYY-Www – 7 day period; following ISO 8601 definition of a week in a year)|(% style="width:221px" %)
687 +|(% style="width:360px" %)(((
687 687  ReportingDay
688 688  (YYYY-Dddd – 1 day period)
689 -)))|time_period
690 -|(((
690 +)))|(% style="width:221px" %)time_period
691 +|(% style="width:360px" %)(((
691 691  DateTime
692 692  (YYYY-MM-DDThh:mm:ss)
693 -)))|date
694 -|(((
694 +)))|(% style="width:221px" %)date
695 +|(% style="width:360px" %)(((
695 695  TimeRange
696 696  (YYYY-MM-DD(Thh:mm:ss)?/<duration>)
697 -)))|time
698 -|(((
698 +)))|(% style="width:221px" %)time
699 +|(% style="width:360px" %)(((
699 699  Month
700 700  (~-~-MM; speicifies a month independent of a year; e.g. February is black history month in the United States)
701 -)))|string
702 -|(((
702 +)))|(% style="width:221px" %)string
703 +|(% style="width:360px" %)(((
703 703  MonthDay
704 704  (~-~-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)
705 -)))|string
706 -|(((
706 +)))|(% style="width:221px" %)string
707 +|(% style="width:360px" %)(((
707 707  Day
708 708  (~-~--DD; specifies a day independent of a month or year; e.g. the 15^^th^^ is payday)
709 -)))|string
710 -|(((
710 +)))|(% style="width:221px" %)string
711 +|(% style="width:360px" %)(((
711 711  Time
712 712  (hh:mm:ss; time independent of a date; e.g. coffee break is at 10:00 AM)
713 -)))|string
714 -|(((
714 +)))|(% style="width:221px" %)string
715 +|(% style="width:360px" %)(((
715 715  Duration
716 716  (corresponds to XML Schema xs:duration datatype)
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
718 +)))|(% style="width:221px" %)duration
719 +|(% style="width:360px" %)XHTML|(% style="width:221px" %)Metadata type – not applicable
720 +|(% style="width:360px" %)KeyValues|(% style="width:221px" %)Metadata type – not applicable
721 +|(% style="width:360px" %)IdentifiableReference|(% style="width:221px" %)Metadata type – not applicable
722 +|(% style="width:360px" %)DataSetReference|(% style="width:221px" %)Metadata type – not applicable
722 722  
723 723  **Figure 14 – Mappings from SDMX data types to VTL Basic Scalar Types**
724 724  
... ... @@ -728,84 +728,82 @@
728 728  
729 729  The following table describes the default conversion from the VTL basic scalar types to the SDMX data types .
730 730  
731 -|(((
732 -VTL basic
733 -scalar type
734 -)))|(((
732 +(% style="width:748.294px" %)
733 +|(% style="width:164px" %)(((
734 +VTL basic scalar type
735 +)))|(% style="width:304px" %)(((
735 735  Default SDMX data type
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|(((
737 +(BasicComponentDataType)
738 +)))|(% style="width:277px" %)Default output format
739 +|(% style="width:164px" %)String|(% style="width:304px" %)String|(% style="width:277px" %)Like XML (xs:string)
740 +|(% style="width:164px" %)Number|(% style="width:304px" %)Float|(% style="width:277px" %)Like XML (xs:float)
741 +|(% style="width:164px" %)Integer|(% style="width:304px" %)Integer|(% style="width:277px" %)Like XML (xs:int)
742 +|(% style="width:164px" %)Date|(% style="width:304px" %)DateTime|(% style="width:277px" %)YYYY-MM-DDT00:00:00Z
743 +|(% style="width:164px" %)Time|(% style="width:304px" %)StandardTimePeriod|(% style="width:277px" %)<date>/<date> (as defined above)
744 +|(% style="width:164px" %)time_period|(% style="width:304px" %)(((
745 745  ReportingTimePeriod
746 746  (StandardReportingPeriod)
747 -)))|(((
747 +)))|(% style="width:277px" %)(((
748 748   YYYY-Pppp
749 749  (according to SDMX )
750 750  )))
751 -|Duration|Duration|Like XML (xs:duration) PnYnMnDTnHnMnS
752 -|Boolean|Boolean|Like XML (xs:boolean) with the values "true" or "false"
751 +|(% style="width:164px" %)Duration|(% style="width:304px" %)Duration|(% style="width:277px" %)Like XML (xs:duration) PnYnMnDTnHnMnS
752 +|(% style="width:164px" %)Boolean|(% style="width:304px" %)Boolean|(% style="width:277px" %)Like XML (xs:boolean) with the values "true" or "false"
753 753  
754 754  **Figure 14 – Mappings from SDMX data types to VTL Basic Scalar Types**
755 755  
756 -In case a different default conversion is desired, it can be achieved through the CustomTypeScheme and CustomType artefacts (see also the section
756 +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).
757 757  
758 -Transformations and Expressions of the SDMX information model).
759 -
760 760  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.
761 761  
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 -| |
760 +(% style="width:717.294px" %)
761 +|(% colspan="2" style="width:714px" %)VTL special characters for the formatting masks
762 +|(% colspan="2" style="width:714px" %)
763 +|(% colspan="2" style="width:714px" %)Number
764 +|(% style="width:122px" %)D|(% style="width:591px" %)one numeric digit (if the scientific notation is adopted, D is only for the mantissa)
765 +|(% style="width:122px" %)E|(% style="width:591px" %)one numeric digit (for the exponent of the scientific notation)
766 +|(% style="width:122px" %). (dot)|(% style="width:591px" %)possible separator between the integer and the decimal parts.
767 +|(% style="width:122px" %), (comma)|(% style="width:591px" %)possible separator between the integer and the decimal parts.
768 +|(% style="width:122px" %) |(% style="width:591px" %)
769 +|(% colspan="2" style="width:714px" %)Time and duration
770 +|(% style="width:122px" %)C|(% style="width:591px" %)century
771 +|(% style="width:122px" %)Y|(% style="width:591px" %)year
772 +|(% style="width:122px" %)S|(% style="width:591px" %)semester
773 +|(% style="width:122px" %)Q|(% style="width:591px" %)quarter
774 +|(% style="width:122px" %)M|(% style="width:591px" %)month
775 +|(% style="width:122px" %)W|(% style="width:591px" %)week
776 +|(% style="width:122px" %)D|(% style="width:591px" %)day
777 +|(% style="width:122px" %)h|(% style="width:591px" %)hour digit (by default on 24 hours)
778 +|(% style="width:122px" %)M|(% style="width:591px" %)minute
779 +|(% style="width:122px" %)S|(% style="width:591px" %)second
780 +|(% style="width:122px" %)D|(% style="width:591px" %)decimal of second
781 +|(% style="width:122px" %)P|(% style="width:591px" %)period indicator (representation in one digit for the duration)
782 +|(% style="width:122px" %)P|(% style="width:591px" %)number of the periods specified in the period indicator
783 +|(% style="width:122px" %)AM/PM|(% style="width:591px" %)indicator of AM / PM (e.g. am/pm for "am" or "pm")
784 +|(% style="width:122px" %)MONTH|(% style="width:591px" %)uppercase textual representation of the month (e.g., JANUARY for January)
785 +|(% style="width:122px" %)DAY|(% style="width:591px" %)uppercase textual representation of the day (e.g., MONDAY for Monday)
786 +|(% style="width:122px" %)Month|(% style="width:591px" %)lowercase textual representation of the month (e.g., january)
787 +|(% style="width:122px" %)Day|(% style="width:591px" %)lowercase textual representation of the month (e.g., monday)
788 +|(% style="width:122px" %)Month|(% style="width:591px" %)First character uppercase, then lowercase textual representation of the month (e.g., January)
789 +|(% style="width:122px" %)Day|(% style="width:591px" %)First character uppercase, then lowercase textual representation of the day using (e.g. Monday)
790 +|(% style="width:122px" %) |(% style="width:591px" %)
791 +|(% colspan="2" style="width:714px" %)String
792 +|(% style="width:122px" %)X|(% style="width:591px" %)any string character
793 +|(% style="width:122px" %)Z|(% style="width:591px" %)any string character from "A" to "z"
794 +|(% style="width:122px" %)9|(% style="width:591px" %)any string character from "0" to "9"
795 +|(% style="width:122px" %) |(% style="width:591px" %)
796 +|(% colspan="2" style="width:714px" %)Boolean
797 +|(% style="width:122px" %)B|(% style="width:591px" %)Boolean using "true" for True and "false" for False
798 +|(% style="width:122px" %)1|(% style="width:591px" %)Boolean using "1" for True and "0" for False
799 +|(% style="width:122px" %)0|(% style="width:591px" %)Boolean using "0" for True and "1" for False
800 +|(% style="width:122px" %) |(% style="width:591px" %)
801 +|(% colspan="2" style="width:714px" %)Other qualifiers
802 +|(% style="width:122px" %)*|(% style="width:591px" %)an arbitrary number of digits (of the preceding type)
803 +|(% style="width:122px" %)+|(% style="width:591px" %)at least one digit (of the preceding type)
804 +|(% style="width:122px" %)( )|(% style="width:591px" %)optional digits (specified within the brackets)
805 +|(% style="width:122px" %)\|(% style="width:591px" %)prefix for the special characters that must appear in the mask
806 +|(% style="width:122px" %)N|(% style="width:591px" %)fixed number of digits used in the preceding textual representation of the month or the day
807 +|(% style="width:122px" %) |(% style="width:591px" %)
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  
1750067055028-964.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -5.5 KB
Content
1750070310572-584.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +18.9 KB
Content