Last modified by Helena K. on 2026/06/09 17:04

From version 2.9
edited by Helena K.
on 2025/07/02 15:09
Change comment: There is no comment for this version
To version 12.2
edited by Helena K.
on 2026/06/09 16:42
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Part IV. Data
1 +Part IV. Data and Reference Metadata Namespaces
Tags
... ... @@ -1,0 +1,1 @@
1 +Annotation|Artefact|Attachment level|Attribute|Attribute relationship|Code|Code list|Component|Concept scheme|Data consumer|Data set|Data structure definition|Dataflow|Dimension|Facet|Hierarchy|Incremental update|Item scheme|Maintenance agency|Measure|Metadata set|Metadataflow|Provision agreement|Reference metadata|Representation|SDMX Registry|SDMX-ML|Series key|Statistical data and metadata exchange|Structural metadata|isExternalReference
Content
... ... @@ -6,11 +6,11 @@
6 6  
7 7  The first change in the data and metadata message is one of terminology. In order to foster consistency in the standard, the names and namespaces of the data and metadata message have been changed. The namespaces now have a uniform format of /data/format and /metadata/format. This also applies to the message names as well, where the names follow the pattern of FormatData (e.g. StructuredData and GenericMetadata).
8 8  
9 -For data messages, since (% style="color:#e74c3c" %)version(%%) 3.0 only the (data-)structure-specific format is maintained, the generic format being deprecated. The structure-specific data message combines the principles of the former compact and cross-sectional formats into one more generalised format. All data can be exchanged as either an un-grouped collection of observations, each specifying a full key, or it can be exchanged as data grouped into series with any single [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] placed at the observation level.
9 +For data messages, since version 3.0 only the (data-)structure-specific format is maintained, the generic format being deprecated. The structure-specific data message combines the principles of the former compact and cross-sectional formats into one more generalised format. All data can be exchanged as either an un-grouped collection of observations, each specifying a full key, or it can be exchanged as data grouped into series with any single dimension placed at the observation level.
10 10  
11 11  A base schema now imposes a strict format for the generated structure-specific schemas. This not only allows performing the required validations, but the messages will also be much simpler to process as the format will always use the same element names.
12 12  
13 -For metadata messages, since (% style="color:#e74c3c" %)version(%%) 3.0, in opposite, only the generic format is maintained, the (metadata-)structure-specific format being deprecated.
13 +For metadata messages, since version 3.0, in opposite, only the generic format is maintained, the (metadata-)structure-specific format being deprecated.
14 14  
15 15  = 2 Schema Documentation =
16 16  
... ... @@ -38,7 +38,7 @@
38 38  Derivation:
39 39  
40 40  AnnotableType (extension)
41 - DataSetType
41 + DataSetType
42 42  
43 43  Attributes:
44 44  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?
... ... @@ -66,10 +66,10 @@
66 66  |**Name**|**Type**|**Documentation**
67 67  |Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
68 68  |DataProvider|DataProviderReferenceType|DataProvider contains a reference to the provider for the data set.
69 -|Atts|*AttsType*|Atts contains a set of data or metadata attribute values with an attachment level of none (i.e. data set level) or reported against a partial set of dimension values.
70 -|Group|*GroupType*|Group contains a reference to a defined group in the data structure definition along with its key (if necessary) and values for the attributes which are associated with the group. An attribute is associated to a group by either an explicit group relationship or by a group attachment when the attribute has a relationship with a dimension which is a member of this group.
71 -|Series|*SeriesType*|Series contains a collection of observations that share a common key (set of dimension values). The key of a series is every dimension defined in the data structure definition, save the dimension at the observation level. In addition to the key and observations, the series contains values for data and metadata attributes which have a relationship with any dimension that is part of the series key, so long as the attribute does not specify an attachment group or also has a relationship with the dimension declared to be at the observation level.
72 -|Obs|*ObsType*|Obs is an un-grouped observation. This observation has a key which is a set of values for all dimensions declared in the data structure definition. In addition to the key, the value of the observation can be provided along with values for all data and metadata attributes which have an association with the observation or any dimension (so long as it does not specify a group attachment).
69 +|Atts|//AttsType//|Atts contains a set of data or metadata attribute values with an attachment level of none (i.e. data set level) or reported against a partial set of dimension values.
70 +|Group|//GroupType//|Group contains a reference to a defined group in the data structure definition along with its key (if necessary) and values for the attributes which are associated with the group. An attribute is associated to a group by either an explicit group relationship or by a group attachment when the attribute has a relationship with a dimension which is a member of this group.
71 +|Series|//SeriesType//|Series contains a collection of observations that share a common key (set of dimension values). The key of a series is every dimension defined in the data structure definition, save the dimension at the observation level. In addition to the key and observations, the series contains values for data and metadata attributes which have a relationship with any dimension that is part of the series key, so long as the attribute does not specify an attachment group or also has a relationship with the dimension declared to be at the observation level.
72 +|Obs|//ObsType//|Obs is an un-grouped observation. This observation has a key which is a set of values for all dimensions declared in the data structure definition. In addition to the key, the value of the observation can be provided along with values for all data and metadata attributes which have an association with the observation or any dimension (so long as it does not specify a group attachment).
73 73  |Metadata|MetadataSetType|Allows for attachment of reference metadata against to the data set.
74 74  
75 75  //**GroupType:**// GroupType is the abstract type which defines a structure which is used to communicate attribute values for a group defined in a data structure definition. The group can consist of either a subset of the dimensions defined by the data structure definition, or an association to an attachment constraint, which in turn defines key sets to which attributes can be attached. In the case that the group is based on an attachment constraint, only the identification of group is provided. It is expected that a system which is processing this will relate that identifier to the key sets defined in the constraint and apply the values provided for the attributes appropriately. Data structure definition schemas will drive types based on this for each group defined in the data structure definition. Both the dimension values which make up the key (if applicable) and the attribute values associated with the group will be represented with XML attributes. This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived group type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). The dimension XML attributes will be required while the attribute XML attributes will be optional. To allow for generic processing, it is required that the only unqualified XML attributes in the derived group type be for the group dimensions and data or metadata attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition dimension or attribute.
... ... @@ -181,7 +181,7 @@
181 181  |Comp|//CompType//|Comp contains the details of observation measures or attributes that have complex representation and cannot be expressed as XML attributes.
182 182  |Metadata|MetadataSetType|Allows for attachment of reference metadata against to the observation.
183 183  
184 -***AttsType*:** AttsType is the abstract type which defines a structure which is used to group a collection of data or metadata attributes which have a key in common. The key for a attribute collection is a subset of the dimension defined in the data structure definition. This is also used for data set level attributes (i.e. those with an attribute relationship of none). In this case, the subset of dimensions is empty. Data structure definition schemas will derive a type based on this that is specific to the data structure definition. The dimension values which make up the key will be represented with local (non-namespace qualified) XML attributes. The metadata attribute values associated with the key dimensions will be expressed as XML local (non-namespace qualified) attributes if they are simple values (e.g. enumerated, dates, numbers) and are not repeatable. Metadata attributes that are repeatable, or do not have simple values (e.g. text) will be expressed using the Comp element. These dimensions and simple attributes are specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived series type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). The dimension XML attributes will be required while the attribute XML attributes will be optional. To allow for generic processing, it is required that the only unqualified XML attributes in the derived group type be for the series dimensions and attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition dimension or attribute.
184 +//**AttsType:**// AttsType is the abstract type which defines a structure which is used to group a collection of data or metadata attributes which have a key in common. The key for a attribute collection is a subset of the dimension defined in the data structure definition. This is also used for data set level attributes (i.e. those with an attribute relationship of none). In this case, the subset of dimensions is empty. Data structure definition schemas will derive a type based on this that is specific to the data structure definition. The dimension values which make up the key will be represented with local (non-namespace qualified) XML attributes. The metadata attribute values associated with the key dimensions will be expressed as XML local (non-namespace qualified) attributes if they are simple values (e.g. enumerated, dates, numbers) and are not repeatable. Metadata attributes that are repeatable, or do not have simple values (e.g. text) will be expressed using the Comp element. These dimensions and simple attributes are specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived series type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). The dimension XML attributes will be required while the attribute XML attributes will be optional. To allow for generic processing, it is required that the only unqualified XML attributes in the derived group type be for the series dimensions and attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition dimension or attribute.
185 185  
186 186  Derivation:
187 187  
... ... @@ -230,7 +230,7 @@
230 230  
231 231  === 2.2.3 Complex Types ===
232 232  
233 -***MetadataSetBaseType*:** MetadataSetBaseType defines the base refinement of the MetadataSetType. Its purpose is to restrict the urn attribute.
233 +//**MetadataSetBaseType:**// MetadataSetBaseType defines the base refinement of the MetadataSetType. Its purpose is to restrict the urn attribute.
234 234  
235 235  Derivation:
236 236  
... ... @@ -320,8 +320,11 @@
320 320  |Link|(% style="width:185px" %)LinkType|(% style="width:412px" %)Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the metadata report can be dynamically inserted in the structure metadata.
321 321  |Name|(% style="width:185px" %)TextType|(% style="width:412px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
322 322  |Description|(% style="width:185px" %)TextType|(% style="width:412px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
323 -|MetadataProvision<br/>Agreement|(% style="width:185px" %)MetadataProvisionAgree<br/>mentReferenceType|(% style="width:412px" %)Metadataflow provides a reference to the metadata provision agreement the metadata set is being reported against.
324 -|Metadataflow|(% style="width:185px" %)MetadataflowReference<br/>Type|(% style="width:412px" %)Metadataflow provides a reference to the metadataflow the metadata set is being reported against.
323 +|MetadataProvision
324 +Agreement|(% style="width:185px" %)MetadataProvisionAgree
325 +mentReferenceType|(% style="width:412px" %)Metadataflow provides a reference to the metadata provision agreement the metadata set is being reported against.
326 +|Metadataflow|(% style="width:185px" %)MetadataflowReference
327 +Type|(% style="width:412px" %)Metadataflow provides a reference to the metadataflow the metadata set is being reported against.
325 325  |Target|(% style="width:185px" %)WildcardUrnType|(% style="width:412px" %)Target references the target structures for which metadata is being reported. These must conform with the constraints defined by the metadata provision agreement and/or the metadataflow.
326 326  |Attribute|(% style="width:185px" %)AttributeType|(% style="width:412px" %)Att elements hold the reported metadata attribute values being reported in the metadata set. These conform to the metadata structure definition.
327 327  
... ... @@ -451,14 +451,13 @@
451 451  
452 452  A representation which defines an enumeration from a codelist or hierarchy will result in a simple type that is a restriction of the common:IDType. The simple type will define enumerations for each code in the codelist or hierarchy, accounting for extensions. The value for these enumerations will be identifier of the item. If desired, the names of the item may be placed in the documentation of the enumeration, but this is not required. Example:
453 453  
454 -xml
455 - <xs:simpleType name="ESTAT.CL\_COUNTRY.1.0">
456 - <xs:restriction base="common:IDType">
457 - <xs:enumeration value="BE">
458 - <xs:annotation>
459 - <xs:documentation xml:lang="en">Belgium</xs:documentation>
460 - </xs:annotation>
461 - </xs:enumeration>
457 +> <xs:simpleType name="ESTAT.CL\_COUNTRY.1.0">
458 +> <xs:restriction base="common:IDType">
459 +> <xs:enumeration value="BE">
460 +> <xs:annotation>
461 +> <xs:documentation xml:lang="en">Belgium</xs:documentation>
462 +> </xs:annotation>
463 +> </xs:enumeration>
462 462  
463 463  === 3.3.5 Representation with Value List Enumeration ===
464 464  
... ... @@ -474,61 +474,61 @@
474 474  
475 475  If the representation is not simple, see the rules in the following section for complex text formats. If the representation is simple, the first step is to determine the base type from the text format data type:
476 476  
477 -|**SDMX Data Type**|**XML Schema Data Type**|
478 -|String|xs:string|
479 -|AlphaNumeric|common:AlphaNumericType|
480 -|Alpha|common:AlphaType|
481 -|Numeric|common:NumericType|
482 -|BigInteger|xs:integer|
483 -|Integer|xs:int|
484 -|Long|xs:long|
485 -|Short|xs:short|
486 -|Decimal|xs:decimal|
487 -|Float|xs:float|
488 -|Double|xs:double|
489 -|Boolean|xs:Boolean|
490 -|URI|xs:anyURI|
491 -|Count|xs:integer|
492 -|InclusiveValueRange|xs:decimal|
493 -|ExclusiveValueRange|xs: decimal|
494 -|Incremental|xs: decimal|
495 -|ObservationalTimePeriod|common:ObservationalTimePeriodType|
496 -|StandardTimePeriod|common:StandardTimePeriodType|
497 -|BasicTimePeriod|common:BasicTimePeriodType|
498 -|GregorianTimePeriod|common:GregorianTimePeriodType|
499 -|GregorianYear|xs:gYear|
500 -|GregorianYearMonth|xs:gYearMonth|
501 -|GregorianDay|xs:date|
502 -|ReportingTimePeriod|common:ReportingTimePeriodType|
503 -|ReportingYear|common:ReportingYearType|
504 -|ReportingSemester|common:ReportingSemesterType|
505 -|ReportingTrimester|common:ReportingTrimesterType|
506 -|ReportingQuarter|common:ReportingQuarterType|
507 -|ReportingMonth|common:ReportingMonthType|
508 -|ReportingWeek|common:ReportingWeekType|
509 -|ReportingDay|common:ReportingDayType|
510 -|DateTime|xs:dateTime|
511 -|TimeRange|common:TimeRangeType|
512 -|Month|xs:gMonth|
513 -|MonthDay|xs:gMonthDay|
514 -|Day|xs:gDay|
515 -|Time|xs:time|
516 -|Duration|xs:duration|
517 -|GeospatialInformation|xs:string|
518 -|XHTML|See the following section for complex representations|
479 +(% style="width:679.294px" %)
480 +|(% style="width:286px" %)**SDMX Data Type**|(% style="width:390px" %)**XML Schema Data Type**
481 +|(% style="width:286px" %)String|(% style="width:390px" %)xs:string
482 +|(% style="width:286px" %)AlphaNumeric|(% style="width:390px" %)common:AlphaNumericType
483 +|(% style="width:286px" %)Alpha|(% style="width:390px" %)common:AlphaType
484 +|(% style="width:286px" %)Numeric|(% style="width:390px" %)common:NumericType
485 +|(% style="width:286px" %)BigInteger|(% style="width:390px" %)xs:integer
486 +|(% style="width:286px" %)Integer|(% style="width:390px" %)xs:int
487 +|(% style="width:286px" %)Long|(% style="width:390px" %)xs:long
488 +|(% style="width:286px" %)Short|(% style="width:390px" %)xs:short
489 +|(% style="width:286px" %)Decimal|(% style="width:390px" %)xs:decimal
490 +|(% style="width:286px" %)Float|(% style="width:390px" %)xs:float
491 +|(% style="width:286px" %)Double|(% style="width:390px" %)xs:double
492 +|(% style="width:286px" %)Boolean|(% style="width:390px" %)xs:Boolean
493 +|(% style="width:286px" %)URI|(% style="width:390px" %)xs:anyURI
494 +|(% style="width:286px" %)Count|(% style="width:390px" %)xs:integer
495 +|(% style="width:286px" %)InclusiveValueRange|(% style="width:390px" %)xs:decimal
496 +|(% style="width:286px" %)ExclusiveValueRange|(% style="width:390px" %)xs: decimal
497 +|(% style="width:286px" %)Incremental|(% style="width:390px" %)xs: decimal
498 +|(% style="width:286px" %)ObservationalTimePeriod|(% style="width:390px" %)common:ObservationalTimePeriodType
499 +|(% style="width:286px" %)StandardTimePeriod|(% style="width:390px" %)common:StandardTimePeriodType
500 +|(% style="width:286px" %)BasicTimePeriod|(% style="width:390px" %)common:BasicTimePeriodType
501 +|(% style="width:286px" %)GregorianTimePeriod|(% style="width:390px" %)common:GregorianTimePeriodType
502 +|(% style="width:286px" %)GregorianYear|(% style="width:390px" %)xs:gYear
503 +|(% style="width:286px" %)GregorianYearMonth|(% style="width:390px" %)xs:gYearMonth
504 +|(% style="width:286px" %)GregorianDay|(% style="width:390px" %)xs:date
505 +|(% style="width:286px" %)ReportingTimePeriod|(% style="width:390px" %)common:ReportingTimePeriodType
506 +|(% style="width:286px" %)ReportingYear|(% style="width:390px" %)common:ReportingYearType
507 +|(% style="width:286px" %)ReportingSemester|(% style="width:390px" %)common:ReportingSemesterType
508 +|(% style="width:286px" %)ReportingTrimester|(% style="width:390px" %)common:ReportingTrimesterType
509 +|(% style="width:286px" %)ReportingQuarter|(% style="width:390px" %)common:ReportingQuarterType
510 +|(% style="width:286px" %)ReportingMonth|(% style="width:390px" %)common:ReportingMonthType
511 +|(% style="width:286px" %)ReportingWeek|(% style="width:390px" %)common:ReportingWeekType
512 +|(% style="width:286px" %)ReportingDay|(% style="width:390px" %)common:ReportingDayType
513 +|(% style="width:286px" %)DateTime|(% style="width:390px" %)xs:dateTime
514 +|(% style="width:286px" %)TimeRange|(% style="width:390px" %)common:TimeRangeType
515 +|(% style="width:286px" %)Month|(% style="width:390px" %)xs:gMonth
516 +|(% style="width:286px" %)MonthDay|(% style="width:390px" %)xs:gMonthDay
517 +|(% style="width:286px" %)Day|(% style="width:390px" %)xs:gDay
518 +|(% style="width:286px" %)Time|(% style="width:390px" %)xs:time
519 +|(% style="width:286px" %)Duration|(% style="width:390px" %)xs:duration
520 +|(% style="width:286px" %)GeospatialInformation|(% style="width:390px" %)xs:string
521 +|(% style="width:286px" %)XHTML|(% style="width:390px" %)See the following section for complex representations
519 519  
520 520  If the text format does not specify any further facets, then the determined type is the listed type or a type which derives from the listed type without placing any addition restrictions on it. However, if one or more facets are specified, then a simple type based on the listed type is necessary. The simple type derives via restriction from the listed type and adds facets according to the following table (the values are mapped as is):
521 521  
522 -|**SDMX Facet**|**XML Schema Facet**|
523 -|minLength|xs:minLength|
524 -|maxLength|xs:maxLength|
525 -|minValue[^1]|if ExclusiveValueRange: xs:minExclusives, else: xs:minInclusive|
526 -|maxValue[^1]|if ExclusiveValueRange: xs:maxExclusives, else: xs:maxInclusive|
527 -|decimals[^1]|xs:fractionDigits|
528 -|pattern|xs:pattern|
525 +(% style="width:1007.29px" %)
526 +|(% style="width:267px" %)**SDMX Facet**|(% style="width:729px" %)**XML Schema Facet**
527 +|(% style="width:267px" %)minLength|(% style="width:729px" %)xs:minLength
528 +|(% style="width:267px" %)maxLength|(% style="width:729px" %)xs:maxLength
529 +|(% style="width:267px" %)minValue{{footnote}}Note that these options only apply to numeric representations and should be ignored if the data type is non-numeric.{{/footnote}}|(% style="width:729px" %)if ExclusiveValueRange: xs:minExclusives, else: xs:minInclusive
530 +|(% style="width:267px" %)maxValue^^1^^|(% style="width:729px" %)if ExclusiveValueRange: xs:maxExclusives, else: xs:maxInclusive
531 +|(% style="width:267px" %)decimals^^1^^|(% style="width:729px" %)xs:fractionDigits
532 +|(% style="width:267px" %)pattern|(% style="width:729px" %)xs:pattern
529 529  
530 -[^1]: Note that these options only apply to numeric representations and should be ignored if the data type is non-numeric.
531 -
532 532  Any other facets are informational only and will not affect the determined type.
533 533  
534 534  === 3.3.7 Representation for Not Applicable Dimensions ===
... ... @@ -537,61 +537,59 @@
537 537  
538 538  To support a specific type and allow for a not applicable dimension value, the structure-specific schema must union the type with the common:NotApplicableType, which enumerates the tilde ‘’ character. This is as shown in the following example:
539 539  
540 -xml
541 - <xs:simpleType name="DecimalOrNotApplicableType">
542 - <xs:union memberTypes="xs:decimal common:NotApplicableType"/>
543 - </xs:simpleType>
542 +> <xs:simpleType name="DecimalOrNotApplicableType">
543 +> <xs:union memberTypes="xs:decimal common:NotApplicableType"/>
544 +> </xs:simpleType>
544 544  
545 545  For enumerated types, the generated structure-specific schema can include the special value in the enumeration or create a union between the enumerated type and the common:NotApplicableType.
546 546  
547 547  Option 1: Augmenting the enumeration with the special value
548 548  
549 -xml
550 - <xs:simpleType name="CL\_SUBINDICATOR\_OR\_NOT\_APPLICABLE">
551 - <xs:union memberTypes="CL\_SUBINDICATOR common:NotApplicableType"/>
552 - </xs:simpleType>
550 +> <xs:simpleType name="CL\_SUBINDICATOR\_OR\_NOT\_APPLICABLE">
551 +> <xs:union memberTypes="CL\_SUBINDICATOR common:NotApplicableType"/>
552 +> </xs:simpleType>
553 553  
554 554  Option 2: Extending the enumeration with the special value
555 555  
556 -xml
557 - <xs:simpleType name="CL\_ SUBINDICATOR ">
558 - <xs:restriction base="xs:string">
559 - <xs:enumeration value="A"/>
560 - <xs:enumeration value=""/>
561 - <xs:restriction>
562 - </xs:simpleType>
556 +> <xs:simpleType name="CL\_ SUBINDICATOR ">
557 +> <xs:restriction base="xs:string">
558 +> <xs:enumeration value="A"/>
559 +> <xs:enumeration value=""/>
560 +> <xs:restriction>
561 +> </xs:simpleType>
563 563  
564 564  For convenience the common schema provides the union types for the following data types.
565 565  
566 -|**SDMX Data Type**|**XML Schema Data Type**|
567 -|AlphaNumeric|common:AlphaNumericOrNotApplicableType|
568 -|Alpha|common:AlphaOrNotApplicableType|
569 -|Numeric|common:NumericOrNotApplicableType|
570 -|BigInteger|common:IntegerOrNotApplicableType|
571 -|Integer|common:IntOrNotApplicableType|
572 -|Long|common:LongOrNotApplicableType|
573 -|Short|common:ShortOrNotApplicableType|
574 -|Decimal|common:DecimalOrNotApplicableType|
575 -|Float|common:FloatOrNotApplicableType|
576 -|Double|common:DoubleOrNotApplicableType|
577 -|Boolean|common:BooleanOrNotApplicableType|
578 -|Count|common:IntegerOrNotApplicableType|
579 -|InclusiveValueRange|common:DecimalOrNotApplicableType|
580 -|ExclusiveValueRange|common:DecimalOrNotApplicableType|
581 -|Incremental|common:DecimalOrNotApplicableType|
582 -|ObservationalTimePeriod|common:ObservationalTimePeriodOrNotApplicableType|
583 -|StandardTimePeriod|common:StandardTimePeriodOrNotApplicableType|
584 -|BasicTimePeriod|common:BasicTimePeriodType|
585 -|GregorianTimePeriod|common:GregorianTimePeriodOrNotApplicableType|
586 -|ReportingTimePeriod|common:ReportingTimePeriodOrNotApplicableType|
587 -|ReportingYear|common:ReportingYearOrNotApplicableType|
588 -|ReportingSemester|common:ReportingSemesterOrNotApplicableType|
589 -|ReportingTrimester|common:ReportingTrimesterOrNotApplicableType|
590 -|ReportingQuarter|common:ReportingQuarterOrNotApplicableType|
591 -|ReportingMonth|common:ReportingMonthOrNotApplicableType|
592 -|ReportingWeek|common:ReportingWeekOrNotApplicableType|
593 -|ReportingDay|common:ReportingDayOrNotApplicableType|
594 -|TimeRange|common:TimeRangeOrNotApplicableType|
565 +(% style="width:747.294px" %)
566 +|**SDMX Data Type**|(% style="width:418px" %)**XML Schema Data Type**
567 +|AlphaNumeric|(% style="width:418px" %)common:AlphaNumericOrNotApplicableType
568 +|Alpha|(% style="width:418px" %)common:AlphaOrNotApplicableType
569 +|Numeric|(% style="width:418px" %)common:NumericOrNotApplicableType
570 +|BigInteger|(% style="width:418px" %)common:IntegerOrNotApplicableType
571 +|Integer|(% style="width:418px" %)common:IntOrNotApplicableType
572 +|Long|(% style="width:418px" %)common:LongOrNotApplicableType
573 +|Short|(% style="width:418px" %)common:ShortOrNotApplicableType
574 +|Decimal|(% style="width:418px" %)common:DecimalOrNotApplicableType
575 +|Float|(% style="width:418px" %)common:FloatOrNotApplicableType
576 +|Double|(% style="width:418px" %)common:DoubleOrNotApplicableType
577 +|Boolean|(% style="width:418px" %)common:BooleanOrNotApplicableType
578 +|Count|(% style="width:418px" %)common:IntegerOrNotApplicableType
579 +|InclusiveValueRange|(% style="width:418px" %)common:DecimalOrNotApplicableType
580 +|ExclusiveValueRange|(% style="width:418px" %)common:DecimalOrNotApplicableType
581 +|Incremental|(% style="width:418px" %)common:DecimalOrNotApplicableType
582 +|ObservationalTimePeriod|(% style="width:418px" %)common:ObservationalTimePeriodOrNotApplicableType
583 +|StandardTimePeriod|(% style="width:418px" %)common:StandardTimePeriodOrNotApplicableType
584 +|BasicTimePeriod|(% style="width:418px" %)common:BasicTimePeriodType
585 +|GregorianTimePeriod|(% style="width:418px" %)common:GregorianTimePeriodOrNotApplicableType
586 +|ReportingTimePeriod|(% style="width:418px" %)common:ReportingTimePeriodOrNotApplicableType
587 +|ReportingYear|(% style="width:418px" %)common:ReportingYearOrNotApplicableType
588 +|ReportingSemester|(% style="width:418px" %)common:ReportingSemesterOrNotApplicableType
589 +|ReportingTrimester|(% style="width:418px" %)common:ReportingTrimesterOrNotApplicableType
590 +|ReportingQuarter|(% style="width:418px" %)common:ReportingQuarterOrNotApplicableType
591 +|ReportingMonth|(% style="width:418px" %)common:ReportingMonthOrNotApplicableType
592 +|ReportingWeek|(% style="width:418px" %)common:ReportingWeekOrNotApplicableType
593 +|ReportingDay|(% style="width:418px" %)common:ReportingDayOrNotApplicableType
594 +|TimeRange|(% style="width:418px" %)common:TimeRangeOrNotApplicableType
595 595  
596 596  === 3.3.8 Representation for Intentionally Missing Measure and Attribute Values ===
597 597  
... ... @@ -604,61 +604,59 @@
604 604  
605 605  This union is as shown in the following example:
606 606  
607 -xml
608 - <xs:simpleType name="DecimalOrMissingType">
609 - <xs:union memberTypes="xs:decimal common:MissingType"/>
610 - </xs:simpleType>
607 +> <xs:simpleType name="DecimalOrMissingType">
608 +> <xs:union memberTypes="xs:decimal common:MissingType"/>
609 +> </xs:simpleType>
611 611  
612 612  For enumerated types, the generated structure-specific schema can include the special value in the enumeration or create a union between the enumerated type and the common:MissingType.
613 613  
614 614  Option 1: Augmenting the enumeration with the special value
615 615  
616 -xml
617 - <xs:simpleType name="CL\_SUBINDICATOR\_OR\_NOT\_APPLICABLE">
618 - <xs:union memberTypes="CL\_SUBINDICATOR common:MissingType"/>
619 - </xs:simpleType>
615 + > <xs:simpleType name="CL\_SUBINDICATOR\_OR\_NOT\_APPLICABLE">
616 + > <xs:union memberTypes="CL\_SUBINDICATOR common:MissingType"/>
617 + > </xs:simpleType>
620 620  
621 621  Option 2: Extending the enumeration with the special value
622 622  
623 -xml
624 - <xs:simpleType name="CL\_ SUBINDICATOR ">
625 - <xs:restriction base="xs:string">
626 - <xs:enumeration value="A"/>
627 - <xs:enumeration value="#N/A"/>
628 - <xs:restriction>
629 - </xs:simpleType>
621 +> <xs:simpleType name="CL\_ SUBINDICATOR ">
622 +> <xs:restriction base="xs:string">
623 +> <xs:enumeration value="A"/>
624 +> <xs:enumeration value="#N/A"/>
625 +> <xs:restriction>
626 +> </xs:simpleType>
630 630  
631 631  For convenience the common schema provides the union types for the following data types.
632 632  
633 -|**SDMX Data Type**|**XML Schema Data Type**|
634 -|AlphaNumeric|common:AlphaNumericOrMissingType|
635 -|Alpha|common:AlphaOrMissingType|
636 -|Numeric|common:NumericOrMissingType|
637 -|BigInteger|common:IntegerOrMissingType|
638 -|Integer|common:IntOrMissingType|
639 -|Long|common:LongOrMissingType|
640 -|Short|common:ShortOrMissingType|
641 -|Decimal|common:DecimalOrMissingType|
642 -|Float|common:FloatOrMissingType|
643 -|Double|common:DoubleOrMissingType|
644 -|Boolean|common:BooleanOrMissingType|
645 -|Count|common:IntegerOrMissingType|
646 -|InclusiveValueRange|common:DecimalOrMissingType|
647 -|ExclusiveValueRange|common:DecimalOrMissingType|
648 -|Incremental|common:DecimalOrMissingType|
649 -|ObservationalTimePeriod|common:ObservationalTimePeriodOrMissingType|
650 -|StandardTimePeriod|common:StandardTimePeriodOrMissingType|
651 -|BasicTimePeriod|common:BasicTimePeriodType|
652 -|GregorianTimePeriod|common:GregorianTimePeriodOrMissingType|
653 -|ReportingTimePeriod|common:ReportingTimePeriodOrMissingType|
654 -|ReportingYear|common:ReportingYearOrMissingType|
655 -|ReportingSemester|common:ReportingSemesterOrMissingType|
656 -|ReportingTrimester|common:ReportingTrimesterOrMissingType|
657 -|ReportingQuarter|common:ReportingQuarterOrMissingType|
658 -|ReportingMonth|common:ReportingMonthOrMissingType|
659 -|ReportingWeek|common:ReportingWeekOrMissingType|
660 -|ReportingDay|common:ReportingDayOrMissingType|
661 -|TimeRange|common:TimeRangeOrMissingType|
630 +(% style="width:804.294px" %)
631 +|(% style="width:279px" %)**SDMX Data Type**|(% style="width:522px" %)**XML Schema Data Type**
632 +|(% style="width:279px" %)AlphaNumeric|(% style="width:522px" %)common:AlphaNumericOrMissingType
633 +|(% style="width:279px" %)Alpha|(% style="width:522px" %)common:AlphaOrMissingType
634 +|(% style="width:279px" %)Numeric|(% style="width:522px" %)common:NumericOrMissingType
635 +|(% style="width:279px" %)BigInteger|(% style="width:522px" %)common:IntegerOrMissingType
636 +|(% style="width:279px" %)Integer|(% style="width:522px" %)common:IntOrMissingType
637 +|(% style="width:279px" %)Long|(% style="width:522px" %)common:LongOrMissingType
638 +|(% style="width:279px" %)Short|(% style="width:522px" %)common:ShortOrMissingType
639 +|(% style="width:279px" %)Decimal|(% style="width:522px" %)common:DecimalOrMissingType
640 +|(% style="width:279px" %)Float|(% style="width:522px" %)common:FloatOrMissingType
641 +|(% style="width:279px" %)Double|(% style="width:522px" %)common:DoubleOrMissingType
642 +|(% style="width:279px" %)Boolean|(% style="width:522px" %)common:BooleanOrMissingType
643 +|(% style="width:279px" %)Count|(% style="width:522px" %)common:IntegerOrMissingType
644 +|(% style="width:279px" %)InclusiveValueRange|(% style="width:522px" %)common:DecimalOrMissingType
645 +|(% style="width:279px" %)ExclusiveValueRange|(% style="width:522px" %)common:DecimalOrMissingType
646 +|(% style="width:279px" %)Incremental|(% style="width:522px" %)common:DecimalOrMissingType
647 +|(% style="width:279px" %)ObservationalTimePeriod|(% style="width:522px" %)common:ObservationalTimePeriodOrMissingType
648 +|(% style="width:279px" %)StandardTimePeriod|(% style="width:522px" %)common:StandardTimePeriodOrMissingType
649 +|(% style="width:279px" %)BasicTimePeriod|(% style="width:522px" %)common:BasicTimePeriodType
650 +|(% style="width:279px" %)GregorianTimePeriod|(% style="width:522px" %)common:GregorianTimePeriodOrMissingType
651 +|(% style="width:279px" %)ReportingTimePeriod|(% style="width:522px" %)common:ReportingTimePeriodOrMissingType
652 +|(% style="width:279px" %)ReportingYear|(% style="width:522px" %)common:ReportingYearOrMissingType
653 +|(% style="width:279px" %)ReportingSemester|(% style="width:522px" %)common:ReportingSemesterOrMissingType
654 +|(% style="width:279px" %)ReportingTrimester|(% style="width:522px" %)common:ReportingTrimesterOrMissingType
655 +|(% style="width:279px" %)ReportingQuarter|(% style="width:522px" %)common:ReportingQuarterOrMissingType
656 +|(% style="width:279px" %)ReportingMonth|(% style="width:522px" %)common:ReportingMonthOrMissingType
657 +|(% style="width:279px" %)ReportingWeek|(% style="width:522px" %)common:ReportingWeekOrMissingType
658 +|(% style="width:279px" %)ReportingDay|(% style="width:522px" %)common:ReportingDayOrMissingType
659 +|(% style="width:279px" %)TimeRange|(% style="width:522px" %)common:TimeRangeOrMissingType
662 662  
663 663  === 3.3.9 Representation with Complex Text Format ===
664 664  
... ... @@ -673,11 +673,11 @@
673 673  * if the text format data type is XHTML, common:StructuredTextValueType can be used; note that this type cannot be further restricted – all other facets are ignored
674 674  * if the text format is multi-lingual, common:TextValueType can be used; note that this type cannot be further restricted – all other facets are ignored
675 675  * if the text format has no additional facets and the data type is:
676 - + Boolean, common:BooleanValueType can be used
677 - + String, common:StringValueType can be used
678 - + Integer, common:IntValueType can be used
679 - + Double, common:DoubleValueType can be used
680 - + ObservationalTimePeriod, common:ObservationalTimePeriodValueType can be used
674 +** Boolean, common:BooleanValueType can be used
675 +** String, common:StringValueType can be used
676 +** Integer, common:IntValueType can be used
677 +** Double, common:DoubleValueType can be used
678 +** ObservationalTimePeriod, common:ObservationalTimePeriodValueType can be used
681 681  
682 682  If a pre-defined type cannot be used, one will have to be created. The complex type must define a simple content restriction of the common:ValueType. The restriction should define an anonymous simple type based on the text format data type and facets as described in the previous section.
683 683  
... ... @@ -687,9 +687,10 @@
687 687  
688 688  * It the type is an enumeration from an item scheme, the recommended name is [Item Scheme Class].[Maintenance Agency].[Item Scheme ID].[Item Scheme Version]
689 689  * If the type is based on a text format of a concept core representation, the recommended name is Concept.[Maintenance Agency].[Concept Scheme ID].[Concept Scheme Version].[Concept ID]
690 -* If the type is based on a text format of a component local representation, and;
691 - + The component id is required to be unique for all components within the scope of the structure which defines it (e.g. a dimension), the recommended name is [Component ID]
692 - + The component id is only required to be unique within the component list and which defines it (e.g. a metadata attribute), the recommend name is [Component List ID].[Parent Component ID]\*.[Component ID]
688 +* If the type is
689 +* based on a text format of a component local representation, and;
690 +** The component id is required to be unique for all components within the scope of the structure which defines it (e.g. a dimension), the recommended name is [Component ID]
691 +** The component id is only required to be unique within the component list and which defines it (e.g. a metadata attribute), the recommend name is [Component List ID].[Parent Component ID]*.[Component ID]
693 693  
694 694  === 3.3.11 Type Reuse ===
695 695  
... ... @@ -715,34 +715,39 @@
715 715  
716 716  A complex type named DataSetType must be created. Its content model will be derived via restriction. The base type of the restriction is dsd:DataSetType. The complex type content model will be as follows:
717 717  
718 -1. A sequence consisting of:
719 -1. An element reference to common:Annotations, with a minimum occurrence of 0
720 - 2. A local element named DataProvider with the type common:DataProviderReferenceType, a form of unqualified and a minimum occurrence of 0
721 - 3. A choice with a minimum occurrence of 0 and a maximum occurrence of unbounded consisting of:
722 -1. A local element named Atts with a form of unqualified and a type of AttsType (as defined in the AttsType section which follows)
723 - 2. If the data structure defines groups, a local element named Group with a form of unqualified. The type of this element should be the type that is described in the GroupType section which follows.
724 - 3. If the dimension at the observation level is not AllDimensions, a local element named Series with a form of unqualified and a type of SeriesType (as defined in the SeriesType section which follows)
725 - 4. If the dimension at the observation level is AllDimensions, a local element named Obs with a form of unqualified and a type of ObsType (as defined in the ObsType section which follows)
726 - 4. If any metadata attribute usages defined in the data structure that declares an attribute relationship of dataflow, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurences of 0
717 +~1. A sequence consisting of:
727 727  
719 +* i. An element reference to common:Annotations, with a minimum occurrence of 0
720 +* ii  A local element named DataProvider with the type common:DataProviderReferenceType, a form of unqualified and a minimum occurrence of 0
721 +* iii A choice with a minimum occurrence of 0 and a maximum occurrence of unbounded consisting of:
722 +** a. A local element named Atts with a form of unqualified and a type of AttsType (as defined in the AttsType section which follows)
723 +** b. If the data structure defines groups, a local element named Group with a form of unqualified. The type of this element should be the type that is described in the GroupType section which follows.
724 +** c. If the dimension at the observation level is not AllDimensions, a local element named Series with a form of unqualified and a type of SeriesType (as defined in the SeriesType section which follows)
725 +** d. If the dimension at the observation level is AllDimensions, a local element named Obs with a form of unqualified and a type of ObsType (as defined in the ObsType section which follows)
726 +* iv. If any metadata attribute usages defined in the data structure that declares an attribute relationship of dataflow, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurences of 0
727 +
728 728  === 3.4.2 GroupType ===
729 729  
730 730  If the data structure definition defines only one group, a complex type with its name taken from the identifier of the lone group must be defined. This type is used for the Group element in the DataSetType. Its content model will be derived via restriction of the dsd:GroupType. The complex type content model will be as follows:
731 731  
732 -1. A sequence consisting of:
733 -1. An element reference to common:Annotations, with a minimum occurrence of 0
734 - 2. If any attributes defined in the data structure that declares an attribute relationship with the group, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
735 - 3. If any metadata attribute usages defined in the data structure that declares an attribute relationship with the group, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0
736 -2. An attribute for each dimension referenced by the group. The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is required
737 -3. An attribute for each data attribute with simple representation defined in the data structure that declares an attribute relationship with the group or specifies the group as an attachment group. The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is optional
732 +~1. A sequence consisting of:
733 +
734 +* i. An element reference to common:Annotations, with a minimum occurrence of 0
735 +* ii. If any attributes defined in the data structure that declares an attribute relationship with the group, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
736 +* iii. If any metadata attribute usages defined in the data structure that declares an attribute relationship with the group, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0
737 +
738 +2. An attribute for each dimension referenced by the group. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is required
739 +3. An attribute for each data attribute with simple representation defined in the data structure that declares an attribute relationship with the group or specifies the group as an attachment group. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is optional
738 738  4. An attribute named type with a type of common:IDType, usage of optional, and a fixed value of the identifier of the group
739 739  
740 740  If the data structure definition defines more than one group, an abstract complex type with name GroupType must be created. This type is used for the Group element in the DataSetType. Its content model will be derived via restriction of the dsd:GroupType. The complex type content model will be as follows:
741 741  
742 -1. A sequence consisting of:
743 -1. An element reference to common:Annotations, with a minimum occurrence of 0
744 - 2. If any attributes defined in the data structure that declares an attribute relationship with a group, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
745 - 3. If any metadata attribute usages defined in the data structure that declares an attribute relationship with any group, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0
744 +~1. A sequence consisting of:
745 +
746 +* i. An element reference to common:Annotations, with a minimum occurrence of 0
747 +* ii. If any attributes defined in the data structure that declares an attribute relationship with a group, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
748 +* iii. If any metadata attribute usages defined in the data structure that declares an attribute relationship with any group, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0
749 +
746 746  2. An attribute named type with a type of Group.ID, and a usage of optional
747 747  3. An anyAttribute declaration with a namespace of ##local##
748 748  
... ... @@ -750,12 +750,14 @@
750 750  
751 751  For each group defined in the data structure definition, a complex type with its name taken from the group identifier is defined. Its content model will be derived via restriction of the previously defined GroupType. The complex type content model will be as follows:
752 752  
753 -1. A sequence consisting of:
754 -1. An element reference to common:Annotations, with a minimum occurrence of 0
755 - 2. If any attributes with complex representation defined in the data structure declares an attribute relationship with the group, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
756 - 3. If any metadata attribute usages defined in the data structure that declares an attribute relationship with the group, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0
757 -2. An attribute for each dimension referenced by the group. The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is required
758 -3. An attribute for each data attribute with simple representation defined in the data structure that declares an attribute relationship with the group or specifies the group as an attachment group. The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is optional
757 +~1. A sequence consisting of:
758 +
759 +* i. An element reference to common:Annotations, with a minimum occurrence of 0
760 +* ii. If any attributes with complex representation defined in the data structure declares an attribute relationship with the group, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
761 +* iii. If any metadata attribute usages defined in the data structure that declares an attribute relationship with the group, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0
762 +
763 +2. An attribute for each dimension referenced by the group. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is required
764 +3. An attribute for each data attribute with simple representation defined in the data structure that declares an attribute relationship with the group or specifies the group as an attachment group. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is optional
759 759  4. An attribute named type with a type of Group.ID, usage of optional, and a fixed value of the identifier of the group
760 760  
761 761  === 3.4.3 SeriesType ===
... ... @@ -762,48 +762,59 @@
762 762  
763 763  If the dimension at the observation is not AllDimensions, a complex type name SeriesType must be created. Its content model will be derived via restriction of dsd:SeriesType. The complex type content model will be as follows:
764 764  
765 -1. A sequence consisting of:
766 -1. An element reference to common:Annotations, with a minimum occurrence of 0
767 - 2. If any attributes with complex representation defined in the data structure declares an attribute relationship with a dimension that is not at the observation level, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
768 - 3. A local element named Obs with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of ObsType (as defined in the ObsType section which follows)
769 - 4. If any metadata attribute usages defined in the data structure that declares an attribute relationship with the series, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0
771 +~1. A sequence consisting of:
772 +
773 +* i. An element reference to common:Annotations, with a minimum occurrence of 0
774 +* ii. If any attributes with complex representation defined in the data structure declares an attribute relationship with a dimension that is not at the observation level, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
775 +* iii. A local element named Obs with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of ObsType (as defined in the ObsType section which follows)
776 +* iv. If any metadata attribute usages defined in the data structure that declares an attribute relationship with the series, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0
777 +
770 770  2. An attribute named TIME\_PERIOD with a type of common:ObservationalTimePeriod. If the dimension at the observation level is the time dimension (TIME\_PERIOD) or there is no time dimension defined by the data structure, a usage of prohibited; otherwise, a usage of required
771 -3. An attribute for each dimension defined by the data structure definition, except for the dimension at the observation level and the time dimension (TIME\_PERIOD). The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is required
772 -4. An attribute for each data attribute defined with simple representation in the data structure that declares an attribute relationship with any dimension outside of the dimension at the observation level (so long as it does not also declare an attachment group). The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is optional
779 +3. An attribute for each dimension defined by the data structure definition, except for the dimension at the observation level and the time dimension (TIME\_PERIOD).
773 773  
781 +The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is required
782 +4. An attribute for each data attribute defined with simple representation in the data structure that declares an attribute relationship with any dimension outside of the dimension at the observation level (so long as it does not also declare an attachment group). The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is optional
783 +
774 774  === 3.4.4 AttsType ===
775 775  
776 776  A complex type named AttsType must be created. Its content model will be derived via restriction of dsd:AttsType. The complex type content model will be as follows:
777 777  
778 -1. A sequence consisting of:
779 -1. An element reference to common:Annotations, with a minimum occurrence of 0
780 - 2. If any attributes with complex representation are defined in the data structure, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
788 +~1. A sequence consisting of:
789 +
790 +* i. An element reference to common:Annotations, with a minimum occurrence of 0
791 +* ii. If any attributes with complex representation are defined in the data structure, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
792 +
781 781  2. If there is no dimension (TIME\_PERIOD) defined by the data structure, an attribute named TIME\_PERIOD with a type of common:ObservationalTimePeriod, and a usage of prohibited
782 -3. An attribute for all dimension defined by the data structure definition. The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is optional
783 -4. An attribute for each data attribute defined with simple representation in the data structure. The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is optional
794 +3. An attribute for all dimension defined by the data structure definition. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is optional
795 +4. An attribute for each data attribute defined with simple representation in the data structure. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is optional
784 784  
785 785  === 3.4.5 ObsType ===
786 786  
787 787  A complex type name ObsType must be created. Its content model will be derived via restriction of the base type dsd:ObsType. The complex type content model will be as follows:
788 788  
789 -1. A sequence consisting of:
790 -1. An element reference to common:Annotations, with a minimum occurrence of 0
791 - 2. If any measures with complex representations are defined in the data structure, any attributes with complex representation that declare an attribute relationship with the observation, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
792 - 3. If any metadata attribute usages defined in the data structure that declares an attribute relationship with the observation, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0
793 -2. An attribute named TIME\_PERIOD with a type of common:
794 - ObservationalTimePeriodValueType. If the dimension at the observation level is the time dimension (TIME\_PERIOD) or all dimensions and the time dimension is defined by the data structure, a usage of required; otherwise, a usage of prohibited
795 -3. If the dimension at the observation level is not all dimensions or the time dimension (TIME\_PERIOD), an attribute for the dimension at the observation level. The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is required
796 -4. If the dimension at the observation level is all dimensions, an attribute for each dimension defined by the data structure definition, except for the time dimension (TIME\_PERIOD). The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is required
797 -5. An attribute for each measure with simple representation defined by the data structure definition. The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) is defined according to the general rules defined in the previous section, and the usage is optional
798 -6. An attribute for each data attribute with simple representation defined in the data structure that declares an attribute relationship with the observation. The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is optional
801 +~1. A sequence consisting of:
799 799  
803 +* i. An element reference to common:Annotations, with a minimum occurrence of 0
804 +* ii. If any measures with complex representations are defined in the data structure, any attributes with complex representation that declare an attribute relationship with the observation, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
805 +* iii. If any metadata attribute usages defined in the data structure that declares an attribute relationship with the observation, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0
806 +
807 +2. An attribute named TIME\_PERIOD with a type of common: ObservationalTimePeriodValueType. If the dimension at the observation level is the time dimension (TIME\_PERIOD) or all dimensions and the time dimension is defined by the data structure, a usage of required; otherwise, a usage of prohibited
808 +3. If the dimension at the observation level is not all dimensions or the time dimension (TIME\_PERIOD), an attribute for the dimension at the observation level. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is required
809 +4. If the dimension at the observation level is all dimensions, an attribute for each dimension defined by the data structure definition, except for the time dimension (TIME\_PERIOD).
810 +
811 +The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is required
812 +5. An attribute for each measure with simple representation defined by the data structure definition. The XML attribute name and type is defined according to the general rules defined in the previous section, and the usage is optional
813 +6. An attribute for each data attribute with simple representation defined in the data structure that declares an attribute relationship with the observation. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is optional
814 +
800 800  === 3.4.6 CompType ===
801 801  
802 802  For every measure and data attribute with complex representation defined by the data structure definition, a complex type must be derived from the restriction of the dsd:CompType. The complex type content model will be as follows:
803 803  
804 -1. A sequence consisting of:
805 -1. An element reference to common:Annotations, with a minimum occurrence of 0
806 - 2. A Value element with a form of unqualified, with a minimum occurrence of 0, a maximum occurrence defined by the representation, and a type based on the [complex representation type](#339-Representation-with-Complex-Text-Format) defined according to the general rules defined in the previous section
819 +~1. A sequence consisting of:
820 +
821 +* i. An element reference to common:Annotations, with a minimum occurrence of 0
822 +* ii. A Value element with a form of unqualified, with a minimum occurrence of 0, a maximum occurrence defined by the representation, and a type based on the complex representation type defined according to the general rules defined in the previous section
823 +
807 807  2. An attribute named id with a type of common: NCNameIDType, usage of required, and a fixed value of the identifier of the measure or attribute
808 808  
809 809  = 4 Data and Reference Metadata Actions =
... ... @@ -812,7 +812,7 @@
812 812  
813 813  Data messages allow indicating intended actions when used to update an SDMX storage system. This purpose is noted in the action of the data set, which is either inherited from the header of the data message or explicitly stated at the data set level.
814 814  
815 -Note that the former *Append* and *Information* actions are deprecated. When used to update an SDMX storage system, the *Merge* action is assumed.
832 +Note that the former //Append// and //Information// actions are deprecated. When used to update an SDMX storage system, the //Merge// action is assumed.
816 816  
817 817  === 4.1.1 Merge Action ===
818 818  
... ... @@ -822,11 +822,11 @@
822 822  
823 823  Dimension values for higher-level (data-related reference metadata) attributes can be **switched-off** (using ) when those are not attached to these dimensions.
824 824  
825 -All observations as well as the sets of data-related reference metadata attributes at specific dimension combinations impacted by the *Merge* action change their time stamp when used to update an SDMX storage system.
842 +All observations as well as the sets of data-related reference metadata attributes at specific dimension combinations impacted by the //Merge// action change their time stamp when used to update an SDMX storage system.
826 826  
827 827  === 4.1.2 Replace Action ===
828 828  
829 -Data or data-related reference metadata is to be replaced, through either update, insert or delete depending on already existing information. A full replacement is hereby assumed to take place at specific “replacement levels”: for entire observations and for any specific dimension combination for data-related reference metadata attributes. Within these “replacement levels” the provided values are inserted or updated, and omitted values are deleted. Values provided for the other attributes (those above the observation level) are merged (see *Merge* action).
846 +Data or data-related reference metadata is to be replaced, through either update, insert or delete depending on already existing information. A full replacement is hereby assumed to take place at specific “//replacement levels//”: for entire observations and for any specific dimension combination for data-related reference metadata attributes. Within these “replacement levels” the provided values are inserted or updated, and omitted values are deleted. Values provided for the other attributes (those above the observation level) are merged (see //Merge// action).
830 830  
831 831  Only non-dimensional components (measure, attribute or reference metadata values) can be **omitted** (null or absent). Bulk replacing is thus not supported.
832 832  
... ... @@ -834,9 +834,9 @@
834 834  
835 835  Replacing non-existing elements is not resulting in an error.
836 836  
837 -All observations as well as the sets of data-related reference metadata attributes at specific dimension combinations impacted by the *Replace* action change their time stamp when used to update an SDMX storage system.
854 +All observations as well as the sets of data-related reference metadata attributes at specific dimension combinations impacted by the //Replace// action change their time stamp when used to update an SDMX storage system.
838 838  
839 -Because the *replace* action always takes place at specific levels, it cannot be used to replace a whole dataset or a whole series. However, a “*replace all*” effect can be achieved by combining a *Delete* dataset containing a completely wildcarded key (where all dimension values are omitted) with a *Merge* or *Replace* dataset within the same data message. Similarly, to replace a whole series, a message can combine a *delete* dataset containing only the partial key of the series (where the not used dimension values are omitted) with a *Merge* or *Replace* dataset for that series.
856 +Because the //replace// action always takes place at specific levels, it cannot be used to replace a whole dataset or a whole series. However, a //“replace all”// effect can be achieved by combining a //Delete// dataset containing a completely wildcarded key (where all dimension values are omitted) with a //Merge// or //Replace// dataset within the same data message. Similarly, to replace a whole series, a message can combine a //delete// dataset containing only the partial key of the series (where the not used dimension values are omitted) with a //Merge// or //Replace// dataset for that series.
840 840  
841 841  === 4.1.3 Delete Action ===
842 842  
... ... @@ -850,64 +850,66 @@
850 850  
851 851  Deleting non-existing elements or values is not resulting in an error.
852 852  
853 -All observations as well as the sets of attributes and data-related reference metadata at higher partial keys impacted by the *Delete* action change their time stamp when used to update an SDMX storage system.
870 +All observations as well as the sets of attributes and data-related reference metadata at higher partial keys impacted by the //Delete// action change their time stamp when used to update an SDMX storage system.
854 854  
855 855  === 4.1.4 Further Details ===
856 856  
857 857  The following convention is used to indicate the state of components in data messages:
858 858  
859 -| | |**Dimension value is**| |**Measure, attribute or reference metadata value is**| |
860 -| | |**Omitted**|**switched off**|**Omitted**|**Present**|
861 -|Action|Delete|bulk deletion: dimension value doesn't matter|only for irrelevant dimensions:1) higher-level (reference metadata) attributes not attached to this dimension(incl. TIME\_PERIOD)2) measures and attributes not attached to this dimension if the DSD allows for an ‘evolving structure’ (excl. TIME\_PERIOD)|to be deleted only if **all** non-dimension components are omitted|to be deleted|
862 -| |Merge|*bulk merge is not permitted*|(see above)|not to be changed|to be updated/inserted|
863 -| |Replace|*bulk replace is not permitted*|(see above)|at permitted replacement levels: to be deleted, otherwise not to be changed|to be updated/inserted|
864 -|Format|XML|xml element/attribute is absent|~|xml element/attribute is absent|any valid or intentionally missing value|
865 -| |JSON|\<empty\>|““|NULL or absent|(see above)|
866 -| |CSV|\<empty\> cell or column is absent|~|<empty> cell or column is absent|(see above)|
876 +(% style="width:1364.29px" %)
877 +| | |(% style="width:260px" %)**Dimension value is**|(% style="width:391px" %) |(% style="width:383px" %)**Measure, attribute or reference metadata value is**|(% style="width:184px" %)
878 +| | |(% style="width:260px" %)**Omitted**|(% style="width:391px" %)**switched off**|(% style="width:383px" %)**Omitted**|(% style="width:184px" %)**Present**
879 +|Action|Delete|(% style="width:260px" %)bulk deletion: dimension value doesn't matter|(% style="width:391px" %)only for irrelevant dimensions:1) higher-level (reference metadata) attributes not attached to this dimension(incl. TIME\_PERIOD)2) measures and attributes not attached to this dimension if the DSD allows for an ‘evolving structure’ (excl. TIME\_PERIOD)|(% style="width:383px" %)to be deleted only if **all** non-dimension components are omitted|(% style="width:184px" %)to be deleted
880 +| |Merge|(% style="width:260px" %)//bulk merge is not permitted//|(% style="width:391px" %)(see above)|(% style="width:383px" %)not to be changed|(% style="width:184px" %)to be updated/inserted
881 +| |Replace|(% style="width:260px" %)//bulk replace is not permitted//|(% style="width:391px" %)(see above)|(% style="width:383px" %)at permitted replacement levels: to be deleted, otherwise not to be changed|(% style="width:184px" %)to be updated/inserted
882 +|Format|XML|(% style="width:260px" %)xml element/attribute is absent|(% style="width:391px" %)~|xml element/attribute is absent|(% style="width:383px" %)any valid or intentionally missing value|(% style="width:184px" %)
883 +| |JSON|(% style="width:260px" %)\<empty\>|(% style="width:391px" %)““|(% style="width:383px" %)NULL or absent|(% style="width:184px" %)(see above)
884 +| |CSV|(% style="width:260px" %)\<empty\> cell or column is absent|(% style="width:391px" %)~|<empty> cell or column is absent|(% style="width:383px" %)(see above)|(% style="width:184px" %)
867 867  
868 868  **Important notes:**
869 869  
870 -The terms “*delete*”, “*merge*” and “*replace*” do **not** imply a physical replacement or deletion of values in the underlying database. To minimize the physical resource requirements, SDMX web service implementations that do not support the *includeHistory* and *asOf* URL parameters might physically replace the existing values in the database. SDMX web services that neither support the *updatedAfter* URL parameter might also implement physical deletions. However, SDMX web services that support these parameters (or other time-machine features), would not overwrite or delete the physical values.
888 +The terms “//delete//”, “//merge//” and “//replace//” do **not** imply a physical replacement or deletion of values in the underlying database. To minimize the physical resource requirements, SDMX web service implementations that do not support the //includeHistory// and //asOf// URL parameters might physically replace the existing values in the database. SDMX web services that neither support the //updatedAfter// URL parameter might also implement physical deletions. However, SDMX web services that support these parameters (or other time-machine features), would not overwrite or delete the physical values.
871 871  
872 -SDMX web services that support the *includeHistory* or *asOf* URL parameters should never allow deleting their **historic** data content because this would interfere with the interests of data consumers, such as data aggregators. Therefore, a specific feature to physically delete previous (outdated) content is intentionally not added to the SDMX standard syntax. If such a feature is required by an organisation, then it needs to be implemented as a custom feature outside the SDMX standard.
890 +SDMX web services that support the //includeHistory// or //asOf// URL parameters should never allow deleting their **historic** data content because this would interfere with the interests of data consumers, such as data aggregators. Therefore, a specific feature to physically delete previous (outdated) content is intentionally not added to the SDMX standard syntax. If such a feature is required by an organisation, then it needs to be implemented as a custom feature outside the SDMX standard.
873 873  
874 -Likewise, all SDMX-compliant systems that do (or are configured to) support the *updatedAfter* URL parameter need to systematically retain the information about deleted data (or data-related reference metadata).
892 +Likewise, all SDMX-compliant systems that do (or are configured to) support the //updatedAfter// URL parameter need to systematically retain the information about deleted data (or data-related reference metadata).
875 875  
876 -All datasets – even with varying actions – within a single data message have always to be treated as **ACID transaction** to guarantee “transactional safety” (full data consistency and validity despite errors, power failures, and other mishaps). These datasets are to be processed in the order of appearance in the message. The advantage of such data messages is thus the ability to bundle separate *delete* and *replace* or *merge* actions into one transactional data message.
894 +All datasets – even with varying actions – within a single data message have always to be treated as **ACID transaction** to guarantee “transactional safety” (full data consistency and validity despite errors, power failures, and other mishaps). These datasets are to be processed in the order of appearance in the message. The advantage of such data messages is thus the ability to bundle separate //delete// and //replace// or //merge// actions into one transactional data message.
877 877  
878 -**Recommended[^2] dataset actions in SDMX web service responses to GET data queries:**
896 +**Recommended{{footnote}}So far this is recommended for systems that do not require backward-compatibility. Later, with SDMX 4.0, this may generally be made mandatory{{/footnote}} dataset actions in SDMX web service responses to GET data queries:**
879 879  
880 -1. Without the *updatedAfter*, *includeHistory*, *detail*, *attributes* or *measures* URL parameters:
881 -
882 - The response message should contain the retrieved data in a *Replace* dataset (instead of the previous *information* dataset).
898 +~1. Without the //updatedAfter//, //includeHistory//, //detail//, //attributes// or //measures// URL parameters:
883 883  
884 -1. Without the *updatedAfter* and *includeHistory*, but with *detail*, *attributes* or *measures* URL parameters:
885 -
886 - The response message should contain the retrieved data in a *Merge* dataset (instead of the previous *Information* dataset).
900 +The response message should contain the retrieved data in a //Replace// dataset (instead of the previous //information// dataset).
887 887  
888 -1. With the *updatedAfter* URL parameter:
889 -
890 - The response must include the information of all previously updated, inserted and deleted data or data-related reference metadata, even if bulk deletions have been used. One of the two approaches are possible:
902 +2. Without the //updatedAfter// and //includeHistory//, but with //detail//, //attributes// or //measures// URL parameters:
891 891  
892 -* a *Delete* dataset for entirely deleted observations and for entirely deleted sets of (data-related reference metadata) attribute values attached to specific dimension combinations and
893 - a *Replace* dataset for all other changed observations and changed attribute and data-related reference metadata values attached to specific dimension combinations, or 
894 -* a *Delete* dataset for entirely deleted observations, for entirely deleted sets of (data-related reference metadata) attribute values attached to specific dimension combinations and for individually deleted mesure, attribute and reference metadata values and
895 - a *Merge* dataset for all other updated or inserted observation, attribute and data-related reference metadata values.
896 -
897 - The DB synchronization use case requires that the generated response must always allow achieving to replicate the exact same punctual data content as currently stored in the queried data source.
904 +The response message should contain the retrieved data in a //Merge// dataset (instead of the previous //Information// dataset).
898 898  
899 -1. With the *includeHistory* URL parameter:
900 -
901 - Using a number of datasets with *Delete*, *Replace* or *Merge* actions and limited in their validity time span that allow achieving to replicate the exact same punctual data contents as previously stored in the queried data source.
906 +3. With the //updatedAfter// URL parameter:
902 902  
903 -1. With the *asOf* URL parameter:
904 -
905 - The recommendations of 1 and 2 apply depending on the other parameters. In addition, the returned dataset should have its validity time span limited to the point in time requested in the *asOf* parameter.
908 +The response must include the information of all previously updated, inserted and deleted data or data-related reference metadata, even if bulk deletions have been used. One of the two approaches are possible:
906 906  
907 -[^2]: So far this is recommended for systems that do not require backward-compatibility. Later, with SDMX 4.0, this may generally be made mandatory.
910 +* a //Delete// dataset for entirely deleted observations and for entirely deleted sets of (data-related reference metadata) attribute values attached to specific dimension combinations and
911 +a //Replace// dataset for all other changed observations and changed attribute and data-related reference metadata values attached to specific dimension combinations, or
912 +* a //Delete// dataset for entirely deleted observations, for entirely deleted sets of (data-related reference metadata) attribute values attached to specific dimension combinations and for individually deleted mesure, attribute and reference metadata values and
913 +a //Merge// dataset for all other updated or inserted observation, attribute and data-related reference metadata values.
908 908  
915 +The DB synchronization use case requires that the generated response must always allow achieving to replicate the exact same punctual data content as currently stored in the queried data source.
916 +
917 +~1. With the //includeHistory// URL parameter:
918 +
919 +Using a number of datasets with //Delete//, //Replace// or //Merge// actions and limited in their validity time span that allow achieving to replicate the exact same punctual data contents as previously stored in the queried data source.
920 +
921 +2. With the //asOf// URL parameter:
922 +
923 +The recommendations of 1 and 2 apply depending on the other parameters. In addition, the returned dataset should have its validity time span limited to the point in time requested in the //asOf// parameter.
924 +
909 909  == 4.2 Reference Metadata Actions ==
910 910  
911 -Reference metadata defined by a Metadataflow or a MetadataProvisionAgreement are exchanged within reference metadatasets, which are maintainable and thus for actions behave like structural metadata (artefacts): When interacting with SDMX Rest web services, the HTTP action verbs GET, PUT and POST are used to indicate the intended action per web request. Consequently, different actions cannot be bundled and executed with “transactional ACIDity”. Note that metadatasets retrieved using the HTTP header “Accept-Language” may contain only partial languages, and thus should be marked with its *isPartialLanguage* property set to true. Submitting such a partial metadataset to update an SDMX storage system will only add or update the included languages but not change other languages.
927 +Reference metadata defined by a Metadataflow or a MetadataProvisionAgreement are exchanged within reference metadatasets, which are maintainable and thus for actions behave like structural metadata (artefacts): When interacting with SDMX Rest web services, the HTTP action verbs GET, PUT and POST are used to indicate the intended action per web request. Consequently, different actions cannot be bundled and executed with “transactional ACIDity”. Note that metadatasets retrieved using the HTTP header “Accept-Language” may contain only partial languages, and thus should be marked with its //isPartialLanguage// property set to true. Submitting such a partial metadataset to update an SDMX storage system will only add or update the included languages but not change other languages.
912 912  
913 -The former message header or metadataset property *DataSetAction* is deprecated. To avoid conflicts, it is now ignored if still present.
929 +The former message header or metadataset property //DataSetAction// is deprecated. To avoid conflicts, it is now ignored if still present.
930 +
931 +---
932 +{{putFootnotes/}}--
SUZ.Methodology.Code.MethodologyClass[0]
index
... ... @@ -1,1 +1,0 @@
1 -4
SKMS.Methodology.Code.MethodologyClass[0]
Index
... ... @@ -1,0 +1,1 @@
1 +5
© Semantic R&D Group, 2026