Changes for page Part IV. Data and Reference Metadata Namespaces
Last modified by Elena on 2025/09/10 11:19
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -66,10 +66,10 @@ 66 66 |**Name**|**Type**|**Documentation** 67 67 |[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. 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>>doc:sdmx:Glossary.Data set.WebHome]]. 69 -|Atts| *AttsType*|Atts contains a set of data or metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values with an [[attachment level>>doc:sdmx:Glossary.Attachment level.WebHome]] of none (i.e. [[data set>>doc:sdmx:Glossary.Data set.WebHome]] (% style="color:#e74c3c" %)level(%%)) or reported against a partial set of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values.70 -|Group| *GroupType*|Group contains a reference to a defined group in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] along with its key (if necessary) and values for the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which are associated with the group. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is associated to a group by either an explicit group relationship or by a group attachment when the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] has a relationship with a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] which is a member of this group.71 -|Series| *SeriesType*|Series contains a collection of observations that share a common key (set of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values). The key of a series is every [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] defined in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], save the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%). In addition to the key and observations, the series contains values for data and metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which have a relationship with any [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] that is part of the [[series key>>doc:sdmx:Glossary.Series key.WebHome]], so long as the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] does not specify an attachment group or also has a relationship with the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] declared to be at the observation (% style="color:#e74c3c" %)level(%%).72 -|Obs| *ObsType*|Obs is an un-grouped observation. This observation has a key which is a set of values for all [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] declared in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. In addition to the key, the value of the observation can be provided along with values for all data and metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which have an association with the observation or any [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (so long as it does not specify a group attachment).69 +|Atts|//AttsType//|Atts contains a set of data or metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values with an [[attachment level>>doc:sdmx:Glossary.Attachment level.WebHome]] of none (i.e. [[data set>>doc:sdmx:Glossary.Data set.WebHome]] (% style="color:#e74c3c" %)level(%%)) or reported against a partial set of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values. 70 +|Group|//GroupType//|Group contains a reference to a defined group in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] along with its key (if necessary) and values for the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which are associated with the group. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is associated to a group by either an explicit group relationship or by a group attachment when the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] has a relationship with a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] which is a member of this group. 71 +|Series|//SeriesType//|Series contains a collection of observations that share a common key (set of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values). The key of a series is every [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] defined in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], save the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%). In addition to the key and observations, the series contains values for data and metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which have a relationship with any [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] that is part of the [[series key>>doc:sdmx:Glossary.Series key.WebHome]], so long as the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] does not specify an attachment group or also has a relationship with the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] declared to be at the observation (% style="color:#e74c3c" %)level(%%). 72 +|Obs|//ObsType//|Obs is an un-grouped observation. This observation has a key which is a set of values for all [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] declared in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. In addition to the key, the value of the observation can be provided along with values for all data and metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which have an association with the observation or any [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (so long as it does not specify a group attachment). 73 73 |Metadata|MetadataSetType|Allows for attachment of [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] against to the [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. 74 74 75 75 //**GroupType:**// GroupType is the abstract type which defines a structure which is used to communicate [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values for a group defined in a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. The group can consist of either a subset of the [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] defined by the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], or an association to an attachment (% style="color:#e74c3c" %)constraint(%%), which in turn defines key sets to which [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] can be attached. In the case that the group is based on an attachment (% style="color:#e74c3c" %)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 (% style="color:#e74c3c" %)constraint(%%) and apply the values provided for the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] appropriately. [[Data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] schemas will drive types based on this for each group defined in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. Both the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values which make up the key (if applicable) and the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values associated with the group will be represented with XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. 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>>doc:sdmx:Glossary.Attribute.WebHome]] are explicit. The XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be given a name based on the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]'s identifier. These XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be unqualified (meaning they do not have a namespace associated with them). The [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be required while the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be optional. To allow for generic processing, it is required that the only unqualified XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] in the derived group type be for the group [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] and data or metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] declared in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. If additional [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Data structure definition.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. ... ... @@ -181,7 +181,7 @@ 181 181 |Comp|//CompType//|Comp contains the details of observation [[measures>>doc:sdmx:Glossary.Measure.WebHome]] or [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] that have complex [[representation>>doc:sdmx:Glossary.Representation.WebHome]] and cannot be expressed as XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. 182 182 |Metadata|MetadataSetType|Allows for attachment of [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] 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>>doc:sdmx:Glossary.Attribute.WebHome]] which have a key in common. The key for a [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] collection is a subset of the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] defined in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. This is also used for [[data set>>doc:sdmx:Glossary.Data set.WebHome]] (% style="color:#e74c3c" %)level(%%) [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] (i.e. those with an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] of none). In this case, the subset of [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] is empty. [[Data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] schemas will derive a type based on this that is specific to the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. The [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values which make up the key will be represented with local (non-namespace qualified) XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. The metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values associated with the key [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] will be expressed as XML local (non-namespace qualified) [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] if they are simple values (e.g. enumerated, dates, numbers) and are not repeatable. Metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] that are repeatable, or do not have simple values (e.g. text) will be expressed using the Comp element. These [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] and simple [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Attribute.WebHome]] are explicit. The XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be given a name based on the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]'s identifier. These XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be unqualified (meaning they do not have a namespace associated with them). The [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be required while the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be optional. To allow for generic processing, it is required that the only unqualified XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] in the derived group type be for the series [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] and [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] declared in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. If additional [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Data structure definition.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].184 +//**AttsType:**// AttsType is the abstract type which defines a structure which is used to group a collection of data or metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which have a key in common. The key for a [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] collection is a subset of the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] defined in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. This is also used for [[data set>>doc:sdmx:Glossary.Data set.WebHome]] (% style="color:#e74c3c" %)level(%%) [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] (i.e. those with an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] of none). In this case, the subset of [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] is empty. [[Data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] schemas will derive a type based on this that is specific to the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. The [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values which make up the key will be represented with local (non-namespace qualified) XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. The metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values associated with the key [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] will be expressed as XML local (non-namespace qualified) [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] if they are simple values (e.g. enumerated, dates, numbers) and are not repeatable. Metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] that are repeatable, or do not have simple values (e.g. text) will be expressed using the Comp element. These [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] and simple [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Attribute.WebHome]] are explicit. The XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be given a name based on the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]'s identifier. These XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be unqualified (meaning they do not have a namespace associated with them). The [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be required while the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be optional. To allow for generic processing, it is required that the only unqualified XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] in the derived group type be for the series [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] and [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] declared in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. If additional [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Data structure definition.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. 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>>doc:sdmx:Glossary.Attribute.WebHome]].233 +//**MetadataSetBaseType:**// MetadataSetBaseType defines the base refinement of the MetadataSetType. Its purpose is to restrict the urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. 234 234 235 235 Derivation: 236 236 ... ... @@ -531,37 +531,34 @@ 531 531 |(% style="width:267px" %)decimals^^1^^|(% style="width:729px" %)xs:fractionDigits 532 532 |(% style="width:267px" %)pattern|(% style="width:729px" %)xs:pattern 533 533 534 -Any other facets are informational only and will not affect the determined type. 534 +Any other [[facets>>doc:sdmx:Glossary.Facet.WebHome]] are informational only and will not affect the determined type. 535 535 536 536 === 3.3.7 Representation for Not Applicable Dimensions === 537 537 538 -Not applicable dimensions, i.e., when reported measures or attributes are not attached to those dimensions, take as value the tilde ‘’ character. This is required for datasets defined by a DSD that has the ‘evolving structure’ property set to true and that includes data from dataflows, which only use a subset of dimensions as defined by a dimension constraint. This is also required for data-related higher-level (i.e., attached to dataflow or partial list of Dimensions) reference metadata attributes that don’t have a fixed pre-defined attachment. 538 +Not applicable [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]], i.e., when reported [[measures>>doc:sdmx:Glossary.Measure.WebHome]] or [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] are not attached to those [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]], take as value the tilde ‘’ character. This is required for [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] defined by a [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] that has the ‘evolving structure’ property set to true and that includes data from [[dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]], which only use a subset of [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] as defined by a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (% style="color:#e74c3c" %)constraint(%%). This is also required for data-related higher-(% style="color:#e74c3c" %)level(%%) (i.e., attached to [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] or partial list of [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]) [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] that don’t have a fixed pre-defined attachment. 539 539 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: 540 +To support a specific type and allow for a not applicable [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] 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 -xml 543 - <xs:simpleType name="DecimalOrNotApplicableType"> 544 - <xs:union memberTypes="xs:decimal common:NotApplicableType"/> 545 - </xs:simpleType> 542 +> <xs:simpleType name="DecimalOrNotApplicableType"> 543 +> <xs:union memberTypes="xs:decimal common:NotApplicableType"/> 544 +> </xs:simpleType> 546 546 547 547 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. 548 548 549 549 Option 1: Augmenting the enumeration with the special value 550 550 551 -xml 552 - <xs:simpleType name="CL\_SUBINDICATOR\_OR\_NOT\_APPLICABLE"> 553 - <xs:union memberTypes="CL\_SUBINDICATOR common:NotApplicableType"/> 554 - </xs:simpleType> 550 +> <xs:simpleType name="CL\_SUBINDICATOR\_OR\_NOT\_APPLICABLE"> 551 +> <xs:union memberTypes="CL\_SUBINDICATOR common:NotApplicableType"/> 552 +> </xs:simpleType> 555 555 556 556 Option 2: Extending the enumeration with the special value 557 557 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> 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> 565 565 566 566 For convenience the common schema provides the union types for the following data types. 567 567 ... ... @@ -598,38 +598,35 @@ 598 598 599 599 === 3.3.8 Representation for Intentionally Missing Measure and Attribute Values === 600 600 601 -For intentionally missing measure and attribute values, even if mandatory, the following special values can be used: 598 +For intentionally missing [[measure>>doc:sdmx:Glossary.Measure.WebHome]] and [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values, even if mandatory, the following special values can be used: 602 602 603 603 * NaN for all numeric types (float, double) 604 604 * #N/A for all other types 605 605 606 -To support a specific type and allow for an intentionally missing measure or attribute value, the structure-specific schema must union the type with the common:MissingType, which enumerates the #N/A string. Note that XML natively already supports NaN for float and double values. 603 +To support a specific type and allow for an intentionally missing [[measure>>doc:sdmx:Glossary.Measure.WebHome]] or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] value, the structure-specific schema must union the type with the common:MissingType, which enumerates the #N/A string. Note that XML natively already supports NaN for float and double values. 607 607 608 608 This union is as shown in the following example: 609 609 610 -xml 611 - <xs:simpleType name="DecimalOrMissingType"> 612 - <xs:union memberTypes="xs:decimal common:MissingType"/> 613 - </xs:simpleType> 607 +> <xs:simpleType name="DecimalOrMissingType"> 608 +> <xs:union memberTypes="xs:decimal common:MissingType"/> 609 +> </xs:simpleType> 614 614 615 615 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. 616 616 617 617 Option 1: Augmenting the enumeration with the special value 618 618 619 -xml 620 - <xs:simpleType name="CL\_SUBINDICATOR\_OR\_NOT\_APPLICABLE"> 621 - <xs:union memberTypes="CL\_SUBINDICATOR common:MissingType"/> 622 - </xs:simpleType> 615 + > <xs:simpleType name="CL\_SUBINDICATOR\_OR\_NOT\_APPLICABLE"> 616 + > <xs:union memberTypes="CL\_SUBINDICATOR common:MissingType"/> 617 + > </xs:simpleType> 623 623 624 624 Option 2: Extending the enumeration with the special value 625 625 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> 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> 633 633 634 634 For convenience the common schema provides the union types for the following data types. 635 635 ... ... @@ -666,40 +666,40 @@ 666 666 667 667 === 3.3.9 Representation with Complex Text Format === 668 668 669 -A representation which defines a complex text format will result in a complex type. The representation is complex if any of the following conditions are true: 663 +A [[representation>>doc:sdmx:Glossary.Representation.WebHome]] which defines a complex text format will result in a complex type. The [[representation>>doc:sdmx:Glossary.Representation.WebHome]] is complex if any of the following conditions are true: 670 670 671 -* representation max occurs is greater than 1 665 +* [[representation>>doc:sdmx:Glossary.Representation.WebHome]] max occurs is greater than 1 672 672 * text format data type is XHMTL 673 673 * text format is multi-lingual 674 674 675 675 The resulting complex type will be derived via restriction of the common:ValueType. In simple cases, there are pre-defined types that can be used: 676 676 677 -* 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 678 -* 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 679 -* if the text format has no additional facets and the data type is: 680 - +Boolean, common:BooleanValueType can be used681 - +String, common:StringValueType can be used682 - +Integer, common:IntValueType can be used683 - +Double, common:DoubleValueType can be used684 - +ObservationalTimePeriod, common:ObservationalTimePeriodValueType can be used671 +* if the text format data type is XHTML, common:StructuredTextValueType can be used; note that this type cannot be further restricted – all other [[facets>>doc:sdmx:Glossary.Facet.WebHome]] are ignored 672 +* if the text format is multi-lingual, common:TextValueType can be used; note that this type cannot be further restricted – all other [[facets>>doc:sdmx:Glossary.Facet.WebHome]] are ignored 673 +* if the text format has no additional [[facets>>doc:sdmx:Glossary.Facet.WebHome]] and the data type is: 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 685 685 686 -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. 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>>doc:sdmx:Glossary.Facet.WebHome]] as described in the previous section. 687 687 688 688 === 3.3.10 Type Names === 689 689 690 690 These rules will only dictate type names where absolutely necessary. In all other cases, it is the decision of the implementer as to how to name or use the type. It is also the implementer's requirement to ensure that any type name is properly unique within its scope. To assist in this, the following recommendations are offered for naming types such that they are unique. 691 691 692 -* 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] 693 -* 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] 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]686 +* It the type is an enumeration from an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]], the recommended name is ~[[[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] Class].[Maintenance Agency].~[[[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] ID].~[[[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] Version] 687 +* If the type is based on a text format of a (% style="color:#e74c3c" %)concept(%%) core [[representation>>doc:sdmx:Glossary.Representation.WebHome]], the recommended name is (% style="color:#e74c3c" %)Concept(%%).[Maintenance Agency].[(% style="color:#e74c3c" %)Concept(%%) Scheme ID].[(% style="color:#e74c3c" %)Concept(%%) Scheme Version].[(% style="color:#e74c3c" %)Concept(%%) ID] 688 +* If the type is based on a text format of a [[component>>doc:sdmx:Glossary.Component.WebHome]] local [[representation>>doc:sdmx:Glossary.Representation.WebHome]], and; 689 +** The [[component>>doc:sdmx:Glossary.Component.WebHome]] id is required to be unique for all [[components>>doc:sdmx:Glossary.Component.WebHome]] within the scope of the structure which defines it (e.g. a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]), the recommended name is ~[[[Component>>doc:sdmx:Glossary.Component.WebHome]] ID] 690 +** The [[component>>doc:sdmx:Glossary.Component.WebHome]] id is only required to be unique within the [[component>>doc:sdmx:Glossary.Component.WebHome]] list and which defines it (e.g. a metadata attribute), the recommend name is [Component List ID].[Parent Component ID]*.[Component ID] 697 697 698 698 === 3.3.11 Type Reuse === 699 699 700 700 It is possible that organisations that manage a large number of structure-specific schemas my wish to take advantage of the reuse of previously defined type in order to simply the structure-specific schema creation and lessen the number of schema elements which are created. The structure-specific formats are designed in such a way that this would be allowed without any adverse affects. 701 701 702 -For example, an organisation my create predefined types for all of codelists and concept schemes which their structures utilize. These could be contained in a common schema with any namespace deemed appropriate. This would allow the structure-specific schemas generation process to recognize the reused components and not be concerned with regenerating types. The logical flow for setting the representation of a component might be as follows: 696 +For example, an organisation my create predefined types for all of [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] and [[concept schemes>>doc:sdmx:Glossary.Concept scheme.WebHome]] which their structures utilize. These could be contained in a common schema with any namespace deemed appropriate. This would allow the structure-specific schemas generation process to recognize the reused [[components>>doc:sdmx:Glossary.Component.WebHome]] and not be concerned with regenerating types. The logical flow for setting the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of a [[component>>doc:sdmx:Glossary.Component.WebHome]] might be as follows: 703 703 704 704 Does the component define a local type? 705 705 Yes: Is that type enumerated? ... ... @@ -711,167 +711,172 @@ 711 711 712 712 == 3.4 Data-Structure-Specific Schema == 713 713 714 -Separate schemas will be created for the data structure depending on which dimension occurs at the observation level. The recommended target namespace of the data structured specific schema is: [Data Structure URN]:ObsLevelDim:[Observation Dimensions]. 708 +Separate schemas will be created for the data structure depending on which [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] occurs at the observation (% style="color:#e74c3c" %)level(%%). The recommended target namespace of the data structured specific schema is: [Data Structure URN]:ObsLevelDim:[Observation Dimensions]. 715 715 716 -The rules for generating the data-structure-specific-schema are broken into sections based on the level within the structure (i.e. data set, group, series, attributes, observation). Each section will state the rules for each variation of the structure-specific format. 710 +The rules for generating the data-structure-specific-schema are broken into sections based on the (% style="color:#e74c3c" %)level(%%) within the structure (i.e. [[data set>>doc:sdmx:Glossary.Data set.WebHome]], group, series, [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]], observation). Each section will state the rules for each variation of the structure-specific format. 717 717 718 718 === 3.4.1 DataSetType === 719 719 720 -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: 714 +A complex type named DataSetType must be created. Its content model will be derived via restriction. The base type of the restriction is [[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]:DataSetType. The complex type content model will be as follows: 721 721 722 722 ~1. A sequence consisting of: 723 723 724 -* i. An element reference to common:Annotations, with a minimum occurrence of 0 718 +* i. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0 725 725 * ii A local element named DataProvider with the type common:DataProviderReferenceType, a form of unqualified and a minimum occurrence of 0 726 726 * iii A choice with a minimum occurrence of 0 and a maximum occurrence of unbounded consisting of: 727 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) 728 728 ** 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. 729 -** 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) 730 -** 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) 731 -* 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 723 +** c. If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)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) 724 +** d. If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)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) 725 +* iv. If any metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] usages defined in the data structure that declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] of [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurences of 0 732 732 733 733 === 3.4.2 GroupType === 734 734 735 -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: 729 +If the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] 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>>doc:sdmx:Glossary.Data structure definition.WebHome]]:GroupType. The complex type content model will be as follows: 736 736 737 737 ~1. A sequence consisting of: 738 738 739 -* i. An element reference to common:Annotations, with a minimum occurrence of 0 740 -* 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 741 -* 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 733 +* i. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0 734 +* ii. If any [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] defined in the data structure that declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] 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>>doc:sdmx:Glossary.Data structure definition.WebHome]]:CompType 735 +* iii. If any metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] usages defined in the data structure that declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] with the group, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0 742 742 743 -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 744 -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 745 -4. An attribute named type with a type of common:IDType, usage of optional, and a fixed value of the identifier of the group 737 +2. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] referenced by the group. The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is required 738 +3. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each data [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] with simple [[representation>>doc:sdmx:Glossary.Representation.WebHome]] defined in the data structure that declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] with the group or specifies the group as an attachment group. The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is optional 739 +4. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named type with a type of common:IDType, usage of optional, and a fixed value of the identifier of the group 746 746 747 -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 +If the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] 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>>doc:sdmx:Glossary.Data structure definition.WebHome]]:GroupType. The complex type content model will be as follows: 748 748 749 749 ~1. A sequence consisting of: 750 750 751 -* i. An element reference to common:Annotations, with a minimum occurrence of 0 752 -* 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 753 -* 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 745 +* i. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0 746 +* ii. If any [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] defined in the data structure that declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] 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>>doc:sdmx:Glossary.Data structure definition.WebHome]]:CompType 747 +* iii. If any metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] usages defined in the data structure that declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] with any group, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0 754 754 755 -2. An attribute named type with a type of Group.ID, and a usage of optional 749 +2. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named type with a type of Group.ID, and a usage of optional 756 756 3. An anyAttribute declaration with a namespace of ##local## 757 757 758 -A simple type named Group.ID must be created. This should restrict the common:IDType. For each group defined by the data structure definition, an enumeration will be created within the restriction with a value of the group identifier. 752 +A simple type named Group.ID must be created. This should restrict the common:IDType. For each group defined by the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], an enumeration will be created within the restriction with a value of the group identifier. 759 759 760 -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: 754 +For each group defined in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], 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: 761 761 762 762 ~1. A sequence consisting of: 763 763 764 -* i. An element reference to common:Annotations, with a minimum occurrence of 0 765 -* 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 766 -* 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 758 +* i. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0 759 +* ii. If any [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] with complex [[representation>>doc:sdmx:Glossary.Representation.WebHome]] defined in the data structure declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] 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>>doc:sdmx:Glossary.Data structure definition.WebHome]]:CompType 760 +* iii. If any metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] usages defined in the data structure that declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] with the group, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0 767 767 768 -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 769 -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 770 -4. An attribute named type with a type of Group.ID, usage of optional, and a fixed value of the identifier of the group 762 +2. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] referenced by the group. The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is required 763 +3. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each data [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] with simple [[representation>>doc:sdmx:Glossary.Representation.WebHome]] defined in the data structure that declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] with the group or specifies the group as an attachment group. The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is optional 764 +4. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named type with a type of Group.ID, usage of optional, and a fixed value of the identifier of the group 771 771 772 772 === 3.4.3 SeriesType === 773 773 774 -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: 768 +If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation is not AllDimensions, a complex type name SeriesType must be created. Its content model will be derived via restriction of [[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]:SeriesType. The complex type content model will be as follows: 775 775 776 776 ~1. A sequence consisting of: 777 777 778 -* i. An element reference to common:Annotations, with a minimum occurrence of 0 779 -* 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 772 +* i. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0 773 +* ii. If any [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] with complex [[representation>>doc:sdmx:Glossary.Representation.WebHome]] defined in the data structure declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] with a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] that is not at the observation (% style="color:#e74c3c" %)level(%%), a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of [[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]:CompType 780 780 * 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) 781 -* 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 775 +* iv. If any metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] usages defined in the data structure that declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] with the series, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0 782 782 783 -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 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 785 -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 777 +2. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named TIME\_PERIOD with a type of common:ObservationalTimePeriod. If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) is the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (TIME\_PERIOD) or there is no time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] defined by the data structure, a usage of prohibited; otherwise, a usage of required 778 +3. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] defined by the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], except for the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) and the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (TIME\_PERIOD). 786 786 780 +The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is required 781 +4. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each data [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] defined with simple [[representation>>doc:sdmx:Glossary.Representation.WebHome]] in the data structure that declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] with any [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] outside of the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) (so long as it does not also declare an attachment group). The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is optional 782 + 787 787 === 3.4.4 AttsType === 788 788 789 -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: 785 +A complex type named AttsType must be created. Its content model will be derived via restriction of [[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]:AttsType. The complex type content model will be as follows: 790 790 791 791 ~1. A sequence consisting of: 792 792 793 -* i. An element reference to common:Annotations, with a minimum occurrence of 0 794 -* 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 789 +* i. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0 790 +* ii. If any [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] with complex [[representation>>doc:sdmx:Glossary.Representation.WebHome]] 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 795 795 796 -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 797 -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 798 -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 792 +2. If there is no [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (TIME\_PERIOD) defined by the data structure, an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named TIME\_PERIOD with a type of common:ObservationalTimePeriod, and a usage of prohibited 793 +3. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for all [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] defined by the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is optional 794 +4. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each data [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] defined with simple [[representation>>doc:sdmx:Glossary.Representation.WebHome]] in the data structure. The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is optional 799 799 800 800 === 3.4.5 ObsType === 801 801 802 -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: 798 +A complex type name ObsType must be created. Its content model will be derived via restriction of the base type [[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]:ObsType. The complex type content model will be as follows: 803 803 804 804 ~1. A sequence consisting of: 805 805 806 -* i. An element reference to common:Annotations, with a minimum occurrence of 0 807 -* 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 808 -* 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 802 +* i. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0 803 +* ii. If any [[measures>>doc:sdmx:Glossary.Measure.WebHome]] with complex [[representations>>doc:sdmx:Glossary.Representation.WebHome]] are defined in the data structure, any [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] with complex [[representation>>doc:sdmx:Glossary.Representation.WebHome]] that declare an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] 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>>doc:sdmx:Glossary.Data structure definition.WebHome]]:CompType 804 +* iii. If any metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] usages defined in the data structure that declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] with the observation, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0 809 809 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 812 -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 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 814 -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 815 -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 806 +2. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named TIME\_PERIOD with a type of common: ObservationalTimePeriodValueType. If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) is the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (TIME\_PERIOD) or all [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] and the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is defined by the data structure, a usage of required; otherwise, a usage of prohibited 807 +3. If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) is not all [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] or the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (TIME\_PERIOD), an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%). The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is required 808 +4. If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) is all [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]], an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] defined by the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], except for the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (TIME\_PERIOD). 816 816 810 +The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is required 811 +5. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each [[measure>>doc:sdmx:Glossary.Measure.WebHome]] with simple [[representation>>doc:sdmx:Glossary.Representation.WebHome]] defined by the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type is defined according to the general rules defined in the previous section, and the usage is optional 812 +6. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each data [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] with simple [[representation>>doc:sdmx:Glossary.Representation.WebHome]] defined in the data structure that declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] with the observation. The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is optional 813 + 817 817 === 3.4.6 CompType === 818 818 819 -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: 816 +For every [[measure>>doc:sdmx:Glossary.Measure.WebHome]] and data [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] with complex [[representation>>doc:sdmx:Glossary.Representation.WebHome]] defined by the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], a complex type must be derived from the restriction of the [[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]:CompType. The complex type content model will be as follows: 820 820 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 -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 818 +~1. A sequence consisting of: 825 825 820 +* i. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0 821 +* ii. A Value element with a form of unqualified, with a minimum occurrence of 0, a maximum occurrence defined by the [[representation>>doc:sdmx:Glossary.Representation.WebHome]], and a type based on the complex [[representation>>doc:sdmx:Glossary.Representation.WebHome]] type defined according to the general rules defined in the previous section 822 + 823 +2. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named id with a type of common: NCNameIDType, usage of required, and a fixed value of the identifier of the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 824 + 826 826 = 4 Data and Reference Metadata Actions = 827 827 828 828 == 4.1 Data Actions == 829 829 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. 829 +Data messages allow indicating intended actions when used to update an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] storage system. This purpose is noted in the action of the [[data set>>doc:sdmx:Glossary.Data set.WebHome]], which is either inherited from the header of the data message or explicitly stated at the [[data set>>doc:sdmx:Glossary.Data set.WebHome]] (% style="color:#e74c3c" %)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. 831 +Note that the former *Append* and *Information* actions are deprecated. When used to update an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] storage system, the *Merge* action is assumed. 833 833 834 834 === 4.1.1 Merge Action === 835 835 836 -Data or data-related reference metadata is to be merged, through either update or insertion depending on already existing information. This operation does not allow deleting any component values. Updating individual values in multi-valued measure, attribute or data-related reference metadata values is not supported either. The complete multi-valued value is to be provided. 835 +Data or data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] is to be merged, through either update or insertion depending on already existing information. This operation does not allow deleting any [[component>>doc:sdmx:Glossary.Component.WebHome]] values. Updating individual values in multi-valued [[measure>>doc:sdmx:Glossary.Measure.WebHome]], [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] or data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] values is not supported either. The complete multi-valued value is to be provided. 837 837 838 -Only non-dimensional components (measure, attribute or data-related reference metadata values) can be **omitted** (null or absent) as long as at least one of those components is present. Bulk merges are thus not supported. Only the provided values are merged. 837 +Only non-dimensional [[components>>doc:sdmx:Glossary.Component.WebHome]] ([[measure>>doc:sdmx:Glossary.Measure.WebHome]], [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] or data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] values) can be **omitted** (null or absent) as long as at least one of those [[components>>doc:sdmx:Glossary.Component.WebHome]] is present. Bulk merges are thus not supported. Only the provided values are merged. 839 839 840 -Dimension values for higher-level (data-related reference metadata) attributes can be **switched-off** (using ) when those are not attached to these dimensions. 839 +[[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values for higher-(% style="color:#e74c3c" %)level(%%) (data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]]) [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] 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. 841 +All observations as well as the sets of data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] at specific [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] combinations impacted by the *Merge* action change their time stamp when used to update an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] storage system. 843 843 844 844 === 4.1.2 Replace Action === 845 845 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). 845 +Data or data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] 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 (% style="color:#e74c3c" %)levels//(%%)”: for entire observations and for any specific [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] combination for data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. Within these “replacement (% style="color:#e74c3c" %)levels(%%)” the provided values are inserted or updated, and omitted values are deleted. Values provided for the other [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] (those above the observation (% style="color:#e74c3c" %)level(%%)) are merged (see //Merge// action). 847 847 848 -Only non-dimensional components (measure, attribute or reference metadata values) can be **omitted** (null or absent). Bulk replacing is thus not supported. 847 +Only non-dimensional [[components>>doc:sdmx:Glossary.Component.WebHome]] ([[measure>>doc:sdmx:Glossary.Measure.WebHome]], [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] values) can be **omitted** (null or absent). Bulk replacing is thus not supported. 849 849 850 -Dimension values for higher-level (data-related reference metadata) attributes can be **switched-off** (using ) when those are not attached to these dimensions. 849 +[[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values for higher-(% style="color:#e74c3c" %)level(%%) (data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]]) [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] can be **switched-off** (using ) when those are not attached to these dimensions. 851 851 852 852 Replacing non-existing elements is not resulting in an error. 853 853 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. 853 +All observations as well as the sets of data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] at specific [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] combinations impacted by the //Replace// action change their time stamp when used to update an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] storage system. 855 855 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. 855 +Because the //replace// action always takes place at specific (% style="color:#e74c3c" %)levels(%%), it cannot be used to replace a whole [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] or a whole series. However, a //“replace all”// effect can be achieved by combining a //Delete// [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] containing a completely wildcarded key (where all [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values are omitted) with a //Merge// or //Replace// [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] within the same data message. Similarly, to replace a whole series, a message can combine a //delete// [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] containing only the partial key of the series (where the not used [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values are omitted) with a //Merge// or //Replace// [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] for that series. 857 857 858 858 === 4.1.3 Delete Action === 859 859 860 -Data or data-related reference metadata is to be deleted. Deletion is hereby assumed to take place at the lowest level of detail provided in the message. 859 +Data or data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] is to be deleted. Deletion is hereby assumed to take place at the lowest (% style="color:#e74c3c" %)level(%%) of detail provided in the message. 861 861 862 -Any component (including dimensions) can be **omitted** (dimensions: empty, others: null or absent). Omitting dimension values allows for bulk deletions. Partially omitting non-dimension component values allows restricting the deletion of measure, attribute or data-related reference metadata values to the ones being present. Instead of real values for non-dimensional components, it is sufficient to use any valid value. 861 +Any [[component>>doc:sdmx:Glossary.Component.WebHome]] (including [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]) can be **omitted** ([[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]: empty, others: null or absent). Omitting [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values allows for bulk deletions. Partially omitting non-[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] [[component>>doc:sdmx:Glossary.Component.WebHome]] values allows restricting the deletion of [[measure>>doc:sdmx:Glossary.Measure.WebHome]], [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] or data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] values to the ones being present. Instead of real values for non-dimensional [[components>>doc:sdmx:Glossary.Component.WebHome]], it is sufficient to use any valid value. 863 863 864 -With this, whole datasets, any slices of observations for dimension groups such as time series, observations or individual measure, attribute and data-related reference metadata attributes values can be deleted. 863 +With this, whole [[datasets>>doc:sdmx:Glossary.Data set.WebHome]], any slices of observations for [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] groups such as time series, observations or individual [[measure>>doc:sdmx:Glossary.Measure.WebHome]], [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] and data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] values can be deleted. 865 865 866 -Dimension values for higher-level (data-related reference metadata) attributes can be **switched-off** (using ) when those are not attached to these dimensions. 865 +[[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values for higher-(% style="color:#e74c3c" %)level(%%) (data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]]) [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] can be **switched-off** (using ) when those are not attached to these [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]. 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. 869 +All observations as well as the sets of [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] and data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] at higher partial keys impacted by the *Delete* action change their time stamp when used to update an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] storage system. 871 871 872 872 === 4.1.4 Further Details === 873 873 874 -The following convention is used to indicate the state of components in data messages: 873 +The following convention is used to indicate the state of [[components>>doc:sdmx:Glossary.Component.WebHome]] in data messages: 875 875 876 876 (% style="width:1364.29px" %) 877 877 | | |(% style="width:260px" %)**Dimension value is**|(% style="width:391px" %) |(% style="width:383px" %)**Measure, attribute or reference metadata value is**|(% style="width:184px" %) ... ... @@ -885,46 +885,46 @@ 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. 887 +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>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] web service implementations that do not support the //includeHistory// and //asOf// URL parameters might physically replace the existing values in the database. [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] web services that neither support the *updatedAfter* URL parameter might also implement physical deletions. However, [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] web services that support these parameters (or other time-machine features), would not overwrite or delete the physical values. 889 889 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. 889 +[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 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>>doc:sdmx:Glossary.Data consumer.WebHome]], such as data aggregators. Therefore, a specific feature to physically delete previous (outdated) content is intentionally not added to the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] standard syntax. If such a feature is required by an organisation, then it needs to be implemented as a custom feature outside the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] standard. 891 891 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). 891 +Likewise, all [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-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). 893 893 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. 893 +All [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] – 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>>doc:sdmx:Glossary.Data set.WebHome]] 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. 895 895 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:** 895 +**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>>doc:sdmx:Glossary.Data set.WebHome]] actions in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] web service responses to GET data queries:** 897 897 898 -~1. Without the //updatedAfter//, //includeHistory//, //detail//, //attributes// or //measures// URL parameters: 897 +~1. Without the //updatedAfter//, //includeHistory//, //detail//, //[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]// or //[[measures>>doc:sdmx:Glossary.Measure.WebHome]]// URL parameters: 899 899 900 -The response message should contain the retrieved data in a //Replace// dataset (instead of the previous *information* dataset). 899 +The response message should contain the retrieved data in a //Replace// [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] (instead of the previous *information* [[dataset>>doc:sdmx:Glossary.Data set.WebHome]]). 901 901 902 -2. Without the //updatedAfter// and //includeHistory//, but with //detail//, //attributes// or //measures// URL parameters: 901 +2. Without the //updatedAfter// and //includeHistory//, but with //detail//, //[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]// or //[[measures>>doc:sdmx:Glossary.Measure.WebHome]]// URL parameters: 903 903 904 -The response message should contain the retrieved data in a //Merge// dataset (instead of the previous *Information* dataset). 903 +The response message should contain the retrieved data in a //Merge// [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] (instead of the previous *Information* [[dataset>>doc:sdmx:Glossary.Data set.WebHome]]). 905 905 906 906 3. With the //updatedAfter// URL parameter: 907 907 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: 907 +The response must include the information of all previously updated, inserted and deleted data or data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]], even if bulk deletions have been used. One of the two approaches are possible: 909 909 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. 909 +* a //Delete// [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] for entirely deleted observations and for entirely deleted sets of (data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]]) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values attached to specific [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] combinations and 910 +a //Replace// [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] for all other changed observations and changed [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] and data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] values attached to specific [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] combinations, or 911 +* a //Delete// [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] for entirely deleted observations, for entirely deleted sets of (data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]]) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values attached to specific [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] combinations and for individually deleted mesure, [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] and [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] values and 912 +a //Merge// [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] for all other updated or inserted observation, [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] and data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] 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 917 ~1. With the *includeHistory* URL parameter: 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. 918 +Using a number of [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] 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 920 921 921 2. With the *asOf* URL parameter: 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. 922 +The recommendations of 1 and 2 apply depending on the other parameters. In addition, the returned [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] should have its validity time span limited to the point in time requested in the *asOf* parameter. 924 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. 926 +[[Reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] defined by a [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] or a MetadataProvisionAgreement are exchanged within reference metadatasets, which are maintainable and thus for actions behave like [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] ([[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]): When interacting with [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 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>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] storage system will only add or update the included languages but not change other languages. 928 928 929 929 The former message header or metadataset property *DataSetAction* is deprecated. To avoid conflicts, it is now ignored if still present. 930 930