Changes for page Part IV. Data and Reference Metadata Namespaces
Last modified by Helena K. on 2026/06/09 17:04
Summary
-
Page properties (3 modified, 0 added, 0 removed)
-
Objects (0 modified, 1 added, 1 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 -Part IV. Data and Reference Metadata Namespaces1 +Part IV. Data - Tags
-
... ... @@ -1,0 +1,1 @@ 1 +Dimension - 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 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. 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. 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 version 3.0, in opposite, only the generic format is maintained, the (metadata-)structure-specific format being deprecated. 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. 14 14 15 15 = 2 Schema Documentation = 16 16 ... ... @@ -38,7 +38,7 @@ 38 38 Derivation: 39 39 40 40 AnnotableType (extension) 41 - DataSetType41 + 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,11 +320,8 @@ 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 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. 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. 328 328 |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. 329 329 |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. 330 330 ... ... @@ -454,13 +454,14 @@ 454 454 455 455 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: 456 456 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> 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> 464 464 465 465 === 3.3.5 Representation with Value List Enumeration === 466 466 ... ... @@ -526,11 +526,13 @@ 526 526 |(% style="width:267px" %)**SDMX Facet**|(% style="width:729px" %)**XML Schema Facet** 527 527 |(% style="width:267px" %)minLength|(% style="width:729px" %)xs:minLength 528 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:minInclusive530 -|(% style="width:267px" %)maxValue^ ^1^^|(% style="width:729px" %)if ExclusiveValueRange: xs:maxExclusives, else: xs:maxInclusive531 -|(% style="width:267px" %)decimals^ ^1^^|(% style="width:729px" %)xs:fractionDigits527 +|(% style="width:267px" %)minValue[^1]|(% style="width:729px" %)if ExclusiveValueRange: xs:minExclusives, else: xs:minInclusive 528 +|(% style="width:267px" %)maxValue[^1]|(% style="width:729px" %)if ExclusiveValueRange: xs:maxExclusives, else: xs:maxInclusive 529 +|(% style="width:267px" %)decimals[^1]|(% style="width:729px" %)xs:fractionDigits 532 532 |(% style="width:267px" %)pattern|(% style="width:729px" %)xs:pattern 533 533 532 +[^1]: Note that these options only apply to numeric representations and should be ignored if the data type is non-numeric. 533 + 534 534 Any other facets are informational only and will not affect the determined type. 535 535 536 536 === 3.3.7 Representation for Not Applicable Dimensions === ... ... @@ -539,26 +539,29 @@ 539 539 540 540 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: 541 541 542 -> <xs:simpleType name="DecimalOrNotApplicableType"> 543 -> <xs:union memberTypes="xs:decimal common:NotApplicableType"/> 544 -> </xs:simpleType> 542 +xml 543 + <xs:simpleType name="DecimalOrNotApplicableType"> 544 + <xs:union memberTypes="xs:decimal common:NotApplicableType"/> 545 + </xs:simpleType> 545 545 546 546 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. 547 547 548 548 Option 1: Augmenting the enumeration with the special value 549 549 550 -> <xs:simpleType name="CL\_SUBINDICATOR\_OR\_NOT\_APPLICABLE"> 551 -> <xs:union memberTypes="CL\_SUBINDICATOR common:NotApplicableType"/> 552 -> </xs:simpleType> 551 +xml 552 + <xs:simpleType name="CL\_SUBINDICATOR\_OR\_NOT\_APPLICABLE"> 553 + <xs:union memberTypes="CL\_SUBINDICATOR common:NotApplicableType"/> 554 + </xs:simpleType> 553 553 554 554 Option 2: Extending the enumeration with the special value 555 555 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> 558 +xml 559 + <xs:simpleType name="CL\_ SUBINDICATOR "> 560 + <xs:restriction base="xs:string"> 561 + <xs:enumeration value="A"/> 562 + <xs:enumeration value=""/> 563 + <xs:restriction> 564 + </xs:simpleType> 562 562 563 563 For convenience the common schema provides the union types for the following data types. 564 564 ... ... @@ -604,26 +604,29 @@ 604 604 605 605 This union is as shown in the following example: 606 606 607 -> <xs:simpleType name="DecimalOrMissingType"> 608 -> <xs:union memberTypes="xs:decimal common:MissingType"/> 609 -> </xs:simpleType> 610 +xml 611 + <xs:simpleType name="DecimalOrMissingType"> 612 + <xs:union memberTypes="xs:decimal common:MissingType"/> 613 + </xs:simpleType> 610 610 611 611 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. 612 612 613 613 Option 1: Augmenting the enumeration with the special value 614 614 615 - > <xs:simpleType name="CL\_SUBINDICATOR\_OR\_NOT\_APPLICABLE"> 616 - > <xs:union memberTypes="CL\_SUBINDICATOR common:MissingType"/> 617 - > </xs:simpleType> 619 +xml 620 + <xs:simpleType name="CL\_SUBINDICATOR\_OR\_NOT\_APPLICABLE"> 621 + <xs:union memberTypes="CL\_SUBINDICATOR common:MissingType"/> 622 + </xs:simpleType> 618 618 619 619 Option 2: Extending the enumeration with the special value 620 620 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> 626 +xml 627 + <xs:simpleType name="CL\_ SUBINDICATOR "> 628 + <xs:restriction base="xs:string"> 629 + <xs:enumeration value="A"/> 630 + <xs:enumeration value="#N/A"/> 631 + <xs:restriction> 632 + </xs:simpleType> 627 627 628 628 For convenience the common schema provides the union types for the following data types. 629 629 ... ... @@ -671,11 +671,11 @@ 671 671 * 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 672 672 * 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 673 673 * if the text format has no additional facets and the data type is: 674 - **Boolean, common:BooleanValueType can be used675 - **String, common:StringValueType can be used676 - **Integer, common:IntValueType can be used677 - **Double, common:DoubleValueType can be used678 - **ObservationalTimePeriod, common:ObservationalTimePeriodValueType can be used680 + + Boolean, common:BooleanValueType can be used 681 + + String, common:StringValueType can be used 682 + + Integer, common:IntValueType can be used 683 + + Double, common:DoubleValueType can be used 684 + + ObservationalTimePeriod, common:ObservationalTimePeriodValueType can be used 679 679 680 680 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. 681 681 ... ... @@ -685,10 +685,9 @@ 685 685 686 686 * 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] 687 687 * 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] 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] 694 +* If the type is based on a text format of a component local representation, and; 695 + + 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] 696 + + 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] 692 692 693 693 === 3.3.11 Type Reuse === 694 694 ... ... @@ -717,9 +717,9 @@ 717 717 ~1. A sequence consisting of: 718 718 719 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) 725 +* ii A local element named DataProvider with the type common:DataProviderReferenceType, a form of unqualified and a minimum occurrence of 0 726 +* iii A choice with a minimum occurrence of 0 and a maximum occurrence of unbounded consisting of: 727 +** 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 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 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 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) ... ... @@ -776,9 +776,7 @@ 776 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 777 778 778 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 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). 780 - 781 -The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is required 784 +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 and type are defined according to the general rules defined in the previous section, and the usage is required 782 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 783 784 784 === 3.4.4 AttsType === ... ... @@ -804,11 +804,10 @@ 804 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 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 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 810 +2. An attribute named TIME\_PERIOD with a type of common: 811 + 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 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 813 +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 and type are defined according to the general rules defined in the previous section, and the usage is required 812 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 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 814 ... ... @@ -816,11 +816,9 @@ 816 816 817 817 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: 818 818 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 - 821 +1. A sequence consisting of: 822 +1. An element reference to common:Annotations, with a minimum occurrence of 0 823 + 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 824 824 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 825 825 826 826 = 4 Data and Reference Metadata Actions = ... ... @@ -829,7 +829,7 @@ 829 829 830 830 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. 831 831 832 -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. 833 833 834 834 === 4.1.1 Merge Action === 835 835 ... ... @@ -839,7 +839,7 @@ 839 839 840 840 Dimension values for higher-level (data-related reference metadata) attributes can be **switched-off** (using ) when those are not attached to these dimensions. 841 841 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.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. 843 843 844 844 === 4.1.2 Replace Action === 845 845 ... ... @@ -867,7 +867,7 @@ 867 867 868 868 Deleting non-existing elements or values is not resulting in an error. 869 869 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.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. 871 871 872 872 === 4.1.4 Further Details === 873 873 ... ... @@ -885,7 +885,7 @@ 885 885 886 886 **Important notes:** 887 887 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.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. 889 889 890 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. 891 891 ... ... @@ -897,11 +897,11 @@ 897 897 898 898 ~1. Without the //updatedAfter//, //includeHistory//, //detail//, //attributes// or //measures// URL parameters: 899 899 900 -The response message should contain the retrieved data in a //Replace// 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). 901 901 902 902 2. Without the //updatedAfter// and //includeHistory//, but with //detail//, //attributes// or //measures// URL parameters: 903 903 904 -The response message should contain the retrieved data in a //Merge// dataset (instead of the previous //Information//dataset).904 +The response message should contain the retrieved data in a //Merge// dataset (instead of the previous *Information* dataset). 905 905 906 906 3. With the //updatedAfter// URL parameter: 907 907 ... ... @@ -908,25 +908,26 @@ 908 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: 909 909 910 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 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 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 913 a //Merge// dataset for all other updated or inserted observation, attribute and data-related reference metadata values. 914 914 915 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 916 917 -~1. With the //includeHistory// URL parameter: 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. 918 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. 921 +1. 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. 920 920 921 -2 .With the//asOf// URLparameter:925 +[^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. 922 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 - 925 925 == 4.2 Reference Metadata Actions == 926 926 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.929 +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. 928 928 929 -The former message header or metadataset property //DataSetAction//is deprecated. To avoid conflicts, it is now ignored if still present.931 +The former message header or metadataset property *DataSetAction* is deprecated. To avoid conflicts, it is now ignored if still present. 930 930 931 ---- 932 -{{putFootnotes/}}-- 933 +{{putFootnotes/}}
- SKMS.Methodology.Code.MethodologyClass[0]
-
- Index
-
... ... @@ -1,1 +1,0 @@ 1 -5
- SUZ.Methodology.Code.MethodologyClass[0]
-
- index
-
... ... @@ -1,0 +1,1 @@ 1 +4