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

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

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Part IV. Data and Reference Metadata Namespaces
1 +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  
... ... @@ -33,12 +33,12 @@
33 33  
34 34  === 2.1.2 Complex Types ===
35 35  
36 -//**DataSetType:**// DataSetType is the abstract type which defines the base structure for any data structure definition specific data set. A derived data set type will be created that is specific to a data structure definition and the details of the organisation of the data (i.e. which dimension is the observation dimension). Data is organised into either a collection of series (grouped observations) or a collection of un-grouped observations. The derived data set type will restrict this choice to be either grouped or un-grouped observations. If this dimension is "AllDimensions" then the derived data set type must consist of a collection of un-grouped observations; otherwise, the data set will contain a collection of series with the observations in the series disambiguated by the specified dimension at the observation level. This data set is capable of containing data (observed values) and/or documentation (data and metadata attribute values) and can be used for incremental updates and deletions (i.e. only the relevant updates or deletes are exchanged). It is assumed that each series or un-grouped observation will be distinct in its purpose. For example, if series contains both data and documentation, it assumed that each series will have a unique key. If the series contains only data or only documentation, then it is possible that another series with the same key might exist, but with not with the same purpose (i.e. to provide data or documentation) as the first series. This base type is designed such that derived types can be processed in a generic manner; it assures that data structure definition specific data will have a consistent structure. The group, series, obs, and atts elements are unqualified, meaning that they are not qualified with a namespace in an instance. This means that in the derived data set types, the elements will always be the same, regardless of the target namespace of the schemas which defines these derived types. This allows for consistent processing of the structure without regard to what the namespace might be for the data structure definition specific schema.
36 +***DataSetType*:** DataSetType is the abstract type which defines the base structure for any data structure definition specific data set. A derived data set type will be created that is specific to a data structure definition and the details of the organisation of the data (i.e. which dimension is the observation dimension). Data is organised into either a collection of series (grouped observations) or a collection of un-grouped observations. The derived data set type will restrict this choice to be either grouped or un-grouped observations. If this dimension is "AllDimensions" then the derived data set type must consist of a collection of un-grouped observations; otherwise, the data set will contain a collection of series with the observations in the series disambiguated by the specified dimension at the observation level. This data set is capable of containing data (observed values) and/or documentation (data and metadata attribute values) and can be used for incremental updates and deletions (i.e. only the relevant updates or deletes are exchanged). It is assumed that each series or un-grouped observation will be distinct in its purpose. For example, if series contains both data and documentation, it assumed that each series will have a unique key. If the series contains only data or only documentation, then it is possible that another series with the same key might exist, but with not with the same purpose (i.e. to provide data or documentation) as the first series. This base type is designed such that derived types can be processed in a generic manner; it assures that data structure definition specific data will have a consistent structure. The group, series, obs, and atts elements are unqualified, meaning that they are not qualified with a namespace in an instance. This means that in the derived data set types, the elements will always be the same, regardless of the target namespace of the schemas which defines these derived types. This allows for consistent processing of the structure without regard to what the namespace might be for the data structure definition specific schema.
37 37  
38 38  Derivation:
39 39  
40 40  AnnotableType (extension)
41 - DataSetType
41 + DataSetType
42 42  
43 43  Attributes:
44 44  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?
... ... @@ -48,31 +48,29 @@
48 48  
49 49  Attribute Documentation:
50 50  
51 -(% style="width:1152.29px" %)
52 -|**Name**|**Type**|**Documentation**
53 -|structureRef|xs:IDREF|The structureRef contains a reference to a structural specification in the header of a data or reference metadata message. The structural specification details which structure the data or reference metadata conforms to, as well as providing additional information such as how the data is structure (e.g. which dimension occurs at the observation level for a data set).
54 -|setID|IDType|The setID provides an identification of the data or metadata set.
55 -|action|ActionType|The action attribute indicates whether the file is merging, replacing, or deleting.
56 -|reportingBeginDate|BasicTimePeriodType|The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set.
57 -|reportingEndDate|BasicTimePeriodType|The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.
58 -|validFromDate|xs:dateTime|The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set.
59 -|validToDate|xs:dateTime|The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set.
60 -|publicationYear|xs:gYear|The publicationYear holds the ISO 8601 four-digit year.
61 -|publicationPeriod|ObservationalTimePeriodType|The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a data set published on a quarterly basis).
51 +|**Name**|**Type**|**Documentation**|
52 +|structureRef|xs:IDREF|The structureRef contains a reference to a structural specification in the header of a data or reference metadata message. The structural specification details which structure the data or reference metadata conforms to, as well as providing additional information such as how the data is structure (e.g. which dimension occurs at the observation level for a data set).|
53 +|setID|IDType|The setID provides an identification of the data or metadata set.|
54 +|action|ActionType|The action attribute indicates whether the file is merging, replacing, or deleting.|
55 +|reportingBeginDate|BasicTimePeriodType|The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set.|
56 +|reportingEndDate|BasicTimePeriodType|The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.|
57 +|validFromDate|xs:dateTime|The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set.|
58 +|validToDate|xs:dateTime|The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set.|
59 +|publicationYear|xs:gYear|The publicationYear holds the ISO 8601 four-digit year.|
60 +|publicationPeriod|ObservationalTimePeriodType|The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a data set published on a quarterly basis).|
62 62  
63 63  Element Documentation:
64 64  
65 -(% style="width:1154.29px" %)
66 -|**Name**|**Type**|**Documentation**
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 -|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).
73 -|Metadata|MetadataSetType|Allows for attachment of reference metadata against to the data set.
64 +|**Name**|**Type**|**Documentation**|
65 +|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.|
66 +|DataProvider|DataProviderReferenceType|DataProvider contains a reference to the provider for the data set.|
67 +|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.|
68 +|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.|
69 +|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.|
70 +|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).|
71 +|Metadata|MetadataSetType|Allows for attachment of reference metadata against to the data set.|
74 74  
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.
73 +***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.
76 76  
77 77  Derivation:
78 78  
... ... @@ -87,19 +87,17 @@
87 87  
88 88  Attribute Documentation:
89 89  
90 -(% style="width:1044.29px" %)
91 -|**Name**|**Type**|(% style="width:913px" %)**Documentation**
92 -|type|IDType|(% style="width:913px" %)The type attribute reference the identifier of the group as defined in the data structure definition. This is optional, but derived group types will provide a fixed value for this so that it always available in the post validation information set. This allows the group to be processed in a generic manner.
88 +|**Name**|**Type**|**Documentation**|
89 +|type|IDType|The type attribute reference the identifier of the group as defined in the data structure definition. This is optional, but derived group types will provide a fixed value for this so that it always available in the post validation information set. This allows the group to be processed in a generic manner.|
93 93  
94 94  Element Documentation:
95 95  
96 -(% style="width:1055.29px" %)
97 -|**Name**|**Type**|(% style="width:717px" %)**Documentation**
98 -|Annotations|AnnotationsType|(% style="width:717px" %)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.
99 -|Comp|//CompType//|(% style="width:717px" %)Comp contains the details of group level attributes that have complex representation and cannot be expressed as XML attributes.
100 -|Metadata|MetadataSetType|(% style="width:717px" %)Allows for attachment of reference metadata against to the group.
93 +|**Name**|**Type**|**Documentation**|
94 +|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.|
95 +|Comp|*CompType*|Comp contains the details of group level attributes that have complex representation and cannot be expressed as XML attributes.|
96 +|Metadata|MetadataSetType|Allows for attachment of reference metadata against to the group.|
101 101  
102 -//**SeriesType:**// SeriesType is the abstract type which defines a structure which is used to group a collection of observations which have a key in common. The key for a series is every dimension defined in the data structure definition save the dimension declared to be at the observation level for this data set. Note, if the schema is generated against a dataflow with a dimension constraint, they key includes only the dimensions defined in the dimension constraint. In addition to observations, values can be provided for data and metadata attributes which are associated with the dimensions which make up this series key (so long as the attributes do not specify a group attachment or also have a relationship with the observation dimension). It is possible for the series to contain only observations or only attribute values, or both. Data structure definition schemas will derive a type based on this that is specific to the data structure definition and the variation of the format being expressed in the schema. Both the dimension values which make up the key and the attribute values associated with the key dimensions will be represented with XML attributes. This is 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.
98 +***SeriesType*:** SeriesType is the abstract type which defines a structure which is used to group a collection of observations which have a key in common. The key for a series is every dimension defined in the data structure definition save the dimension declared to be at the observation level for this data set. Note, if the schema is generated against a dataflow with a dimension constraint, they key includes only the dimensions defined in the dimension constraint. In addition to observations, values can be provided for data and metadata attributes which are associated with the dimensions which make up this series key (so long as the attributes do not specify a group attachment or also have a relationship with the observation dimension). It is possible for the series to contain only observations or only attribute values, or both. Data structure definition schemas will derive a type based on this that is specific to the data structure definition and the variation of the format being expressed in the schema. Both the dimension values which make up the key and the attribute values associated with the key dimensions will be represented with XML attributes. This is 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.
103 103  
104 104  Derivation:
105 105  
... ... @@ -114,20 +114,18 @@
114 114  
115 115  Attribute Documentation:
116 116  
117 -(% style="width:1084.29px" %)
118 -|**Name**|**Type**|**Documentation**
119 -|TIME_PERIOD|ObservationalTimePeriodType|The TIME_PERIOD attribute is an explict attribute for the time dimension. This is declared in the base schema since it has a fixed identifier and representation. The derived series type will either require or prohibit this attribute, depending on whether time is the observation dimension. If the time dimension specifies a more specific representation of time the derived type will restrict the type definition to the appropriate type.
113 +|**Name**|**Type**|**Documentation**|
114 +|TIME_PERIOD|ObservationalTimePeriodType|The TIME_PERIOD attribute is an explict attribute for the time dimension. This is declared in the base schema since it has a fixed identifier and representation. The derived series type will either require or prohibit this attribute, depending on whether time is the observation dimension. If the time dimension specifies a more specific representation of time the derived type will restrict the type definition to the appropriate type.|
120 120  
121 121  Element Documentation:
122 122  
123 -(% style="width:1093.29px" %)
124 -|**Name**|**Type**|**Documentation**
125 -|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.
126 -|Comp|//CompType//|Comp contains the details of series level attributes that have complex representation and cannot be expressed as XML attributes.
127 -|Obs|//ObsType//|
128 -|Metadata|MetadataSetType|Allows for attachment of reference metadata against to the series.
118 +|**Name**|**Type**|**Documentation**|
119 +|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.|
120 +|Comp|*CompType*|Comp contains the details of series level attributes that have complex representation and cannot be expressed as XML attributes.|
121 +|Obs|*ObsType*| |
122 +|Metadata|MetadataSetType|Allows for attachment of reference metadata against to the series.|
129 129  
130 -//**CompType:**// CompType is the abstract base for any component value (e.g. a data or metadata attribute, or a measure) that cannot be represented as an XML attribute. For example, a repeated value, a text value in multiple languages, or a value with structured text (XHTML) cannot be expressed as an XML attribute. This type is meant to be restricted based on the component to restrict the cardinality and type of its Value element to conform to the component definition. The type of the value element should be restricted to common:SimpleValueType, common:TextValueType, or common:StructuredValueType. In addition, the id attribute should be restricted to be a fixed value with the component identifier. This restricted type based on the component can then be used on Comp elements by using the xsi:type to state the component being expressed and refine the contents of the element to the values allowed by the component.
124 +***CompType*:** CompType is the abstract base for any component value (e.g. a data or metadata attribute, or a measure) that cannot be represented as an XML attribute. For example, a repeated value, a text value in multiple languages, or a value with structured text (XHTML) cannot be expressed as an XML attribute. This type is meant to be restricted based on the component to restrict the cardinality and type of its Value element to conform to the component definition. The type of the value element should be restricted to common:SimpleValueType, common:TextValueType, or common:StructuredValueType. In addition, the id attribute should be restricted to be a fixed value with the component identifier. This restricted type based on the component can then be used on Comp elements by using the xsi:type to state the component being expressed and refine the contents of the element to the values allowed by the component.
131 131  
132 132  Derivation:
133 133  
... ... @@ -142,18 +142,16 @@
142 142  
143 143  Attribute Documentation:
144 144  
145 -(% style="width:1007.29px" %)
146 -|(% style="width:157px" %)**Name**|(% style="width:291px" %)**Type**|(% style="width:556px" %)**Documentation**
147 -|(% style="width:157px" %)id|(% style="width:291px" %)NCNameIDType|(% style="width:556px" %)
139 +|**Name**|**Type**|**Documentation**|
140 +|id|NCNameIDType| |
148 148  
149 149  Element Documentation:
150 150  
151 -(% style="width:1015.29px" %)
152 -|**Name**|**Type**|(% style="width:684px" %)**Documentation**
153 -|Annotations|AnnotationsType|(% style="width:684px" %)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.
154 -|Value|//ValueType//|(% style="width:684px" %)
144 +|**Name**|**Type**|**Documentation**|
145 +|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.|
146 +|Value|*ValueType*| |
155 155  
156 -//**ObsType:**// ObsType is the abstract type which defines the structure of a grouped or un-grouped observation. The observation must be provided a key, which is either a value for the dimension which is declared to be at the observation level if the observation is grouped, or a full set of values for all dimensions in the data structure definition if the observation is un-grouped. This key should disambiguate the observation within the context in which it is defined (e.g. there should not be another observation with the same dimension value in a series). The observation can contain an observed value and/or attribute values. Data structure definition schemas will derive a type or types based on this that is specific to the data structure definition and the variation of the format being expressed in the schema. The dimension value(s) which make up the key and the data and metadata attribute values associated with the key dimension(s) or the primary measure will be represented with XML attributes. This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived observation 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 attribute(s) 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 observation type be for the observation dimension(s) 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.
148 +***ObsType*:** ObsType is the abstract type which defines the structure of a grouped or un-grouped observation. The observation must be provided a key, which is either a value for the dimension which is declared to be at the observation level if the observation is grouped, or a full set of values for all dimensions in the data structure definition if the observation is un-grouped. This key should disambiguate the observation within the context in which it is defined (e.g. there should not be another observation with the same dimension value in a series). The observation can contain an observed value and/or attribute values. Data structure definition schemas will derive a type or types based on this that is specific to the data structure definition and the variation of the format being expressed in the schema. The dimension value(s) which make up the key and the data and metadata attribute values associated with the key dimension(s) or the primary measure will be represented with XML attributes. This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived observation 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 attribute(s) 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 observation type be for the observation dimension(s) 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.
157 157  
158 158  Derivation:
159 159  
... ... @@ -168,20 +168,18 @@
168 168  
169 169  Attribute Documentation:
170 170  
171 -(% style="width:1008.29px" %)
172 -|**Name**|**Type**|(% style="width:648px" %)**Documentation**
173 -|type|IDType|(% style="width:648px" %)The type attribute is used when the derived format requires that explicit measure be used. In this case, the derived type based on the measure will fix this value to be the identification of the measure concept. This will not be required, but since it is fixed it will be available in the post validation information set which will allow for generic processing of the data. If explicit measures are not used, then the derived type will prohibit the use of this attribute.
174 -|TIME_PERIOD|ObservationalTimePeriodType|(% style="width:648px" %)The TIME_PERIOD attribute is an explicit attribute for the time dimension. This is declared in the base schema since it has a fixed identifier and representation. The derived series type will either require or prohibit this attribute, depending on whether time is the observation dimension. If the time dimension specifies a more specific representation of time the derived type will restrict the type definition to the appropriate type.
163 +|**Name**|**Type**|**Documentation**|
164 +|type|IDType|The type attribute is used when the derived format requires that explicit measure be used. In this case, the derived type based on the measure will fix this value to be the identification of the measure concept. This will not be required, but since it is fixed it will be available in the post validation information set which will allow for generic processing of the data. If explicit measures are not used, then the derived type will prohibit the use of this attribute.|
165 +|TIME_PERIOD|ObservationalTimePeriodType|The TIME_PERIOD attribute is an explicit attribute for the time dimension. This is declared in the base schema since it has a fixed identifier and representation. The derived series type will either require or prohibit this attribute, depending on whether time is the observation dimension. If the time dimension specifies a more specific representation of time the derived type will restrict the type definition to the appropriate type.|
175 175  
176 176  Element Documentation:
177 177  
178 -(% style="width:1020.29px" %)
179 -|**Name**|**Type**|**Documentation**
180 -|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.
181 -|Comp|//CompType//|Comp contains the details of observation measures or attributes that have complex representation and cannot be expressed as XML attributes.
182 -|Metadata|MetadataSetType|Allows for attachment of reference metadata against to the observation.
169 +|**Name**|**Type**|**Documentation**|
170 +|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.|
171 +|Comp|*CompType*|Comp contains the details of observation measures or attributes that have complex representation and cannot be expressed as XML attributes.|
172 +|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.
174 +***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  
... ... @@ -196,31 +196,29 @@
196 196  
197 197  Attribute Documentation:
198 198  
199 -(% style="width:1013.29px" %)
200 -|**Name**|**Type**|**Documentation**
201 -|TIME_PERIOD|ObservationalTimePeriodType|The TIME_PERIOD attribute is an explict attribute for the time dimension. This is declared in the base schema since it has a fixed identifier and representation. The derived series type will either require or prohibit this attribute, depending on whether time is the observation dimension. If the time dimension specifies a more specific representation of time the derived type will restrict the type definition to the appropriate type.
189 +|**Name**|**Type**|**Documentation**|
190 +|TIME_PERIOD|ObservationalTimePeriodType|The TIME_PERIOD attribute is an explict attribute for the time dimension. This is declared in the base schema since it has a fixed identifier and representation. The derived series type will either require or prohibit this attribute, depending on whether time is the observation dimension. If the time dimension specifies a more specific representation of time the derived type will restrict the type definition to the appropriate type.|
202 202  
203 203  Element Documentation:
204 204  
205 -(% style="width:1020.29px" %)
206 -|**Name**|**Type**|**Documentation**
207 -|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.
208 -|Comp|//CompType//|Comp contains the details of the data or metadata attributes that have complex representation and cannot be expressed as XML attributes.
194 +|**Name**|**Type**|**Documentation**|
195 +|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.|
196 +|Comp|*CompType*|Comp contains the details of the data or metadata attributes that have complex representation and cannot be expressed as XML attributes.|
209 209  
210 210  == 2.2 Generic Reference Metadata Namespace ==
211 211  
212 -[[http:~~/~~/www.sdmx.org/resources/sdmxml/schemas/v3_1/metadata/generic>>http://www.sdmx.org/resources/sdmxml/schemas/v3_1/metadata/generic**]]
200 +**http://www.sdmx.org/resources/sdmxml/schemas/v3_1/metadata/generic****
213 213  
214 214  === 2.2.1 Summary ===
215 215  
216 216  Referenced Namespaces:
217 217  
218 -(% style="width:1037.29px" %)
219 -|(% style="width:516px" %)**Namespace**|(% style="width:518px" %)**Prefix**
220 -|(% style="width:516px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v3\_1/common|(% style="width:518px" %)common
221 -|(% style="width:516px" %)<http:~/~/www.w3.org/2001/XMLSchema>|(% style="width:518px" %)xs
206 +|**Namespace**|**Prefix**|
207 +|http://www.sdmx.org/resources/sdmxml/schemas/v3\_1/common|common|
208 +|<http://www.w3.org/2001/XMLSchema>|xs|
222 222  
223 223  Contents:
211 +
224 224  1 Global Element
225 225  3 Complex Types
226 226  
... ... @@ -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.
221 +***MetadataSetBaseType*:** MetadataSetBaseType defines the base refinement of the MetadataSetType. Its purpose is to restrict the urn attribute.
234 234  
235 235  Derivation:
236 236  
... ... @@ -250,28 +250,26 @@
250 250  
251 251  Attribute Documentation:
252 252  
253 -(% style="width:1051.29px" %)
254 -|**Name**|**Type**|(% style="width:669px" %)**Documentation**
255 -|id|IDType|(% style="width:669px" %)The id is the identifier for the object.
256 -|urn|MetadataSetUrnType|(% style="width:669px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
257 -|uri|xs:anyURI|(% style="width:669px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
258 -|version|VersionType|(% style="width:669px" %)This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
259 -|validFrom|xs:dateTime|(% style="width:669px" %)The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
260 -|validTo|xs:dateTime|(% style="width:669px" %)The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
261 -|agencyID|NestedNCNameIDType|(% style="width:669px" %)The agencyID must be provided and identifies the maintenance agency of the object.
262 -|isExternalReference (default: false)|xs:boolean|(% style="width:669px" %)The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
263 -|serviceURL|xs:anyURI|(% style="width:669px" %)The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
264 -|structureURL|xs:anyURI|(% style="width:669px" %)The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
265 -|isPartialLanguage (default: false)|xs:boolean|(% style="width:669px" %)The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header Accept-Language.
241 +|**Name**|**Type**|**Documentation**|
242 +|id|IDType|The id is the identifier for the object.|
243 +|urn|MetadataSetUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
244 +|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
245 +|version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.|
246 +|validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
247 +|validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
248 +|agencyID|NestedNCNameIDType|The agencyID must be provided and identifies the maintenance agency of the object.|
249 +|isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
250 +|serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
251 +|structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
252 +|isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header Accept-Language.|
266 266  
267 267  Element Documentation:
268 268  
269 -(% style="width:1057.29px" %)
270 -|**Name**|**Type**|**Documentation**
271 -|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.
272 -|Link|LinkType|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.
273 -|Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
274 -|Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
256 +|**Name**|**Type**|**Documentation**|
257 +|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.|
258 +|Link|LinkType|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.|
259 +|Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
260 +|Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
275 275  
276 276  **MetadataSetType:** MetadataSetType describes the structure for a metadata set, which contains a collection of reported metadata against a set of targets. The targets should conform to the restrictions described by the metadata provision or the metadataflow. Note that this is maintainable, and as such must specify in agency. In this case, the agency is the metadata provider. If a metadata provision agreement is referenced, it is assumed that the metadata provider described in the provision will be the same as the agency for this set.
277 277  
... ... @@ -294,39 +294,34 @@
294 294  
295 295  Attribute Documentation:
296 296  
297 -(% style="width:1050.29px" %)
298 -|**Name**|**Type**|(% style="width:622px" %)**Documentation**
299 -|id|IDType|(% style="width:622px" %)The id is the identifier for the object.
300 -|urn|MetadataSetUrnType|(% style="width:622px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).
301 -|uri|xs:anyURI|(% style="width:622px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.
302 -|version|VersionType|(% style="width:622px" %)This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.
303 -|validFrom|xs:dateTime|(% style="width:622px" %)The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.
304 -|validTo|xs:dateTime|(% style="width:622px" %)The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.
305 -|agencyID|NestedNCNameIDType|(% style="width:622px" %)The agencyID must be provided and identifies the maintenance agency of the object.
306 -|isExternalReference (default: false)|xs:boolean|(% style="width:622px" %)The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
307 -|serviceURL|xs:anyURI|(% style="width:622px" %)The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.
308 -|structureURL|xs:anyURI|(% style="width:622px" %)The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.
309 -|isPartialLanguage (default: false)|xs:boolean|(% style="width:622px" %)The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header Accept-Language.
310 -|reportingBeginDate|BasicTimePeriodType|(% style="width:622px" %)The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set.
311 -|reportingEndDate|BasicTimePeriodType|(% style="width:622px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.
312 -|publicationYear|xs:gYear|(% style="width:622px" %)The publicationYear holds the ISO 8601 four-digit year.
313 -|publicationPeriod|ObservationalTimePeriodType|(% style="width:622px" %)The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a data set published on a quarterly basis).
283 +|**Name**|**Type**|**Documentation**|
284 +|id|IDType|The id is the identifier for the object.|
285 +|urn|MetadataSetUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
286 +|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
287 +|version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.|
288 +|validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
289 +|validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
290 +|agencyID|NestedNCNameIDType|The agencyID must be provided and identifies the maintenance agency of the object.|
291 +|isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
292 +|serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
293 +|structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
294 +|isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header Accept-Language.|
295 +|reportingBeginDate|BasicTimePeriodType|The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set.|
296 +|reportingEndDate|BasicTimePeriodType|The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.|
297 +|publicationYear|xs:gYear|The publicationYear holds the ISO 8601 four-digit year.|
298 +|publicationPeriod|ObservationalTimePeriodType|The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a data set published on a quarterly basis).|
314 314  
315 315  Element Documentation:
316 316  
317 -(% style="width:1054.29px" %)
318 -|**Name**|(% style="width:185px" %)**Type**|(% style="width:412px" %)**Documentation**
319 -|Annotations|(% style="width:185px" %)AnnotationsType|(% style="width:412px" %)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.
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 -|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 -|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.
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 -|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.
302 +|**Name**|**Type**|**Documentation**|
303 +|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.|
304 +|Link|LinkType|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.|
305 +|Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
306 +|Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
307 +|MetadataProvision<br/>Agreement|MetadataProvisionAgree<br/>mentReferenceType|Metadataflow provides a reference to the metadata provision agreement the metadata set is being reported against.|
308 +|Metadataflow|MetadataflowReference<br/>Type|Metadataflow provides a reference to the metadataflow the metadata set is being reported against.|
309 +|Target|WildcardUrnType|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.|
310 +|Attribute|AttributeType|Att elements hold the reported metadata attribute values being reported in the metadata set. These conform to the metadata structure definition.|
330 330  
331 331  **AttributeType:** AttributeType defines the structure for a reported metadata attribute. A value for the attribute can be supplied as either a single value (enumerated or non-enumerated single value), or multi-lingual text values (either structured or unstructured). Optional child attributes are also available if the metadata attribute definition defines nested metadata attributes.
332 332  
... ... @@ -343,19 +343,17 @@
343 343  
344 344  Attribute Documentation:
345 345  
346 -(% style="width:1037.29px" %)
347 -|(% style="width:113px" %)**Name**|(% style="width:162px" %)**Type**|(% style="width:760px" %)**Documentation**
348 -|(% style="width:113px" %)id|(% style="width:162px" %)IDType|(% style="width:760px" %)The id attribute identifies the metadata attribute that the value is being reported for.
327 +|**Name**|**Type**|**Documentation**|
328 +|id|IDType|The id attribute identifies the metadata attribute that the value is being reported for.|
349 349  
350 350  Element Documentation:
351 351  
352 -(% style="width:1095.29px" %)
353 -|**Name**|**Type**|(% style="width:821px" %)**Documentation**
354 -|Annotations|AnnotationsType|(% style="width:821px" %)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.
355 -|Value|xs:anySimpleType|(% style="width:821px" %)Value holds any simple value (enumerated or not) for the metadata attribute. It can be repeated if this metadata attribute allows for multiple values.
356 -|Text|TextType|(% style="width:821px" %)Text is used to supply parallel multi-lingual textual values for the reported metadata attribute. This will be used if the text format of the metadata attribute has a type of string, and the multi-lingual value is set to true.
357 -|StructuredText|XHTMLType|(% style="width:821px" %)StructuredText is used to supply parallel multi-lingual structured (as XHTML) textual values for the reported metadata attribute. This will be used if the text format of the metadata attribute has a type of XHTML, and the multi-lingual value is set to true.
358 -|Attribute|AttributeType|(% style="width:821px" %)Att contains the reported metadata attribute values for the child metadata attributes.
332 +|**Name**|**Type**|**Documentation**|
333 +|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.|
334 +|Value|xs:anySimpleType|Value holds any simple value (enumerated or not) for the metadata attribute. It can be repeated if this metadata attribute allows for multiple values.|
335 +|Text|TextType|Text is used to supply parallel multi-lingual textual values for the reported metadata attribute. This will be used if the text format of the metadata attribute has a type of string, and the multi-lingual value is set to true.|
336 +|StructuredText|XHTMLType|StructuredText is used to supply parallel multi-lingual structured (as XHTML) textual values for the reported metadata attribute. This will be used if the text format of the metadata attribute has a type of XHTML, and the multi-lingual value is set to true.|
337 +|Attribute|AttributeType|Att contains the reported metadata attribute values for the child metadata attributes.|
359 359  
360 360  = 3 Mapping to Structure-Specific Schemas =
361 361  
... ... @@ -370,10 +370,10 @@
370 370  In the subsequent sections, the following namespace prefixes are used:
371 371  
372 372  |**Namespace**|**Prefix**|
373 -|http:~/~/www.w3.org/2001/XMLSchema|xs|
374 -|http:~/~/www.sdmx.org/resources/sdmxml/schemas/v3_1/common|common|
375 -|http:~/~/www.sdmx.org/resources/sdmxml/schemas/v3_1/data/structurespecific|dsd|
376 -|<http:~/~/www.sdmx.org/resources/sdmxml/schemas/v3_1/metadata/generic>|metadata|
352 +|http://www.w3.org/2001/XMLSchema|xs|
353 +|http://www.sdmx.org/resources/sdmxml/schemas/v3_1/common|common|
354 +|http://www.sdmx.org/resources/sdmxml/schemas/v3_1/data/structurespecific|dsd|
355 +|<http://www.sdmx.org/resources/sdmxml/schemas/v3_1/metadata/generic>|metadata|
377 377  
378 378  It is assumed that in order to use this guide, the reader is familiar with schema terminology. However, for convenience the following is list of the terminology used here:
379 379  
... ... @@ -437,8 +437,8 @@
437 437  The representation of a component is determined by the following precedence:
438 438  
439 439  1. The local representation defined by the component
440 -1. The core representation defined in the concept from which the component takes its semantic
441 -1. A default representation of an un-faceted text format with a data type of String.
419 +2. The core representation defined in the concept from which the component takes its semantic
420 +3. A default representation of an un-faceted text format with a data type of String.
442 442  
443 443  The representation will either define a text format, an enumeration with an enumeration format, or a union of the former with the value of a irrelevant representation ‘’ (tilde).
444 444  
... ... @@ -454,14 +454,16 @@
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>
436 +xml
437 + <xs:simpleType name="ESTAT.CL\_COUNTRY.1.0">
438 + <xs:restriction base="common:IDType">
439 + <xs:enumeration value="BE">
440 + <xs:annotation>
441 + <xs:documentation xml:lang="en">Belgium</xs:documentation>
442 + </xs:annotation>
443 + </xs:enumeration>
464 464  
445 +
465 465  === 3.3.5 Representation with Value List Enumeration ===
466 466  
467 467  A representation which defines an enumeration from a value list will result in a simple type that is a restriction of the xs:string data type. The simple type will define enumerations for each value item in the value list. 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.
... ... @@ -476,61 +476,61 @@
476 476  
477 477  If the representation is not simple, see the rules in the following section for complex text formats. If the representation is simple, the first step is to determine the base type from the text format data type:
478 478  
479 -(% style="width:679.294px" %)
480 -|(% style="width:286px" %)**SDMX Data Type**|(% style="width:390px" %)**XML Schema Data Type**
481 -|(% style="width:286px" %)String|(% style="width:390px" %)xs:string
482 -|(% style="width:286px" %)AlphaNumeric|(% style="width:390px" %)common:AlphaNumericType
483 -|(% style="width:286px" %)Alpha|(% style="width:390px" %)common:AlphaType
484 -|(% style="width:286px" %)Numeric|(% style="width:390px" %)common:NumericType
485 -|(% style="width:286px" %)BigInteger|(% style="width:390px" %)xs:integer
486 -|(% style="width:286px" %)Integer|(% style="width:390px" %)xs:int
487 -|(% style="width:286px" %)Long|(% style="width:390px" %)xs:long
488 -|(% style="width:286px" %)Short|(% style="width:390px" %)xs:short
489 -|(% style="width:286px" %)Decimal|(% style="width:390px" %)xs:decimal
490 -|(% style="width:286px" %)Float|(% style="width:390px" %)xs:float
491 -|(% style="width:286px" %)Double|(% style="width:390px" %)xs:double
492 -|(% style="width:286px" %)Boolean|(% style="width:390px" %)xs:Boolean
493 -|(% style="width:286px" %)URI|(% style="width:390px" %)xs:anyURI
494 -|(% style="width:286px" %)Count|(% style="width:390px" %)xs:integer
495 -|(% style="width:286px" %)InclusiveValueRange|(% style="width:390px" %)xs:decimal
496 -|(% style="width:286px" %)ExclusiveValueRange|(% style="width:390px" %)xs: decimal
497 -|(% style="width:286px" %)Incremental|(% style="width:390px" %)xs: decimal
498 -|(% style="width:286px" %)ObservationalTimePeriod|(% style="width:390px" %)common:ObservationalTimePeriodType
499 -|(% style="width:286px" %)StandardTimePeriod|(% style="width:390px" %)common:StandardTimePeriodType
500 -|(% style="width:286px" %)BasicTimePeriod|(% style="width:390px" %)common:BasicTimePeriodType
501 -|(% style="width:286px" %)GregorianTimePeriod|(% style="width:390px" %)common:GregorianTimePeriodType
502 -|(% style="width:286px" %)GregorianYear|(% style="width:390px" %)xs:gYear
503 -|(% style="width:286px" %)GregorianYearMonth|(% style="width:390px" %)xs:gYearMonth
504 -|(% style="width:286px" %)GregorianDay|(% style="width:390px" %)xs:date
505 -|(% style="width:286px" %)ReportingTimePeriod|(% style="width:390px" %)common:ReportingTimePeriodType
506 -|(% style="width:286px" %)ReportingYear|(% style="width:390px" %)common:ReportingYearType
507 -|(% style="width:286px" %)ReportingSemester|(% style="width:390px" %)common:ReportingSemesterType
508 -|(% style="width:286px" %)ReportingTrimester|(% style="width:390px" %)common:ReportingTrimesterType
509 -|(% style="width:286px" %)ReportingQuarter|(% style="width:390px" %)common:ReportingQuarterType
510 -|(% style="width:286px" %)ReportingMonth|(% style="width:390px" %)common:ReportingMonthType
511 -|(% style="width:286px" %)ReportingWeek|(% style="width:390px" %)common:ReportingWeekType
512 -|(% style="width:286px" %)ReportingDay|(% style="width:390px" %)common:ReportingDayType
513 -|(% style="width:286px" %)DateTime|(% style="width:390px" %)xs:dateTime
514 -|(% style="width:286px" %)TimeRange|(% style="width:390px" %)common:TimeRangeType
515 -|(% style="width:286px" %)Month|(% style="width:390px" %)xs:gMonth
516 -|(% style="width:286px" %)MonthDay|(% style="width:390px" %)xs:gMonthDay
517 -|(% style="width:286px" %)Day|(% style="width:390px" %)xs:gDay
518 -|(% style="width:286px" %)Time|(% style="width:390px" %)xs:time
519 -|(% style="width:286px" %)Duration|(% style="width:390px" %)xs:duration
520 -|(% style="width:286px" %)GeospatialInformation|(% style="width:390px" %)xs:string
521 -|(% style="width:286px" %)XHTML|(% style="width:390px" %)See the following section for complex representations
460 +|**SDMX Data Type**|**XML Schema Data Type**|
461 +|String|xs:string|
462 +|AlphaNumeric|common:AlphaNumericType|
463 +|Alpha|common:AlphaType|
464 +|Numeric|common:NumericType|
465 +|BigInteger|xs:integer|
466 +|Integer|xs:int|
467 +|Long|xs:long|
468 +|Short|xs:short|
469 +|Decimal|xs:decimal|
470 +|Float|xs:float|
471 +|Double|xs:double|
472 +|Boolean|xs:Boolean|
473 +|URI|xs:anyURI|
474 +|Count|xs:integer|
475 +|InclusiveValueRange|xs:decimal|
476 +|ExclusiveValueRange|xs: decimal|
477 +|Incremental|xs: decimal|
478 +|ObservationalTimePeriod|common:ObservationalTimePeriodType|
479 +|StandardTimePeriod|common:StandardTimePeriodType|
480 +|BasicTimePeriod|common:BasicTimePeriodType|
481 +|GregorianTimePeriod|common:GregorianTimePeriodType|
482 +|GregorianYear|xs:gYear|
483 +|GregorianYearMonth|xs:gYearMonth|
484 +|GregorianDay|xs:date|
485 +|ReportingTimePeriod|common:ReportingTimePeriodType|
486 +|ReportingYear|common:ReportingYearType|
487 +|ReportingSemester|common:ReportingSemesterType|
488 +|ReportingTrimester|common:ReportingTrimesterType|
489 +|ReportingQuarter|common:ReportingQuarterType|
490 +|ReportingMonth|common:ReportingMonthType|
491 +|ReportingWeek|common:ReportingWeekType|
492 +|ReportingDay|common:ReportingDayType|
493 +|DateTime|xs:dateTime|
494 +|TimeRange|common:TimeRangeType|
495 +|Month|xs:gMonth|
496 +|MonthDay|xs:gMonthDay|
497 +|Day|xs:gDay|
498 +|Time|xs:time|
499 +|Duration|xs:duration|
500 +|GeospatialInformation|xs:string|
501 +|XHTML|See the following section for complex representations|
522 522  
523 523  If the text format does not specify any further facets, then the determined type is the listed type or a type which derives from the listed type without placing any addition restrictions on it. However, if one or more facets are specified, then a simple type based on the listed type is necessary. The simple type derives via restriction from the listed type and adds facets according to the following table (the values are mapped as is):
524 524  
525 -(% style="width:1007.29px" %)
526 -|(% style="width:267px" %)**SDMX Facet**|(% style="width:729px" %)**XML Schema Facet**
527 -|(% style="width:267px" %)minLength|(% style="width:729px" %)xs:minLength
528 -|(% style="width:267px" %)maxLength|(% style="width:729px" %)xs:maxLength
529 -|(% style="width:267px" %)minValue{{footnote}}Note that these options only apply to numeric representations and should be ignored if the data type is non-numeric.{{/footnote}}|(% style="width:729px" %)if ExclusiveValueRange: xs:minExclusives, else: xs:minInclusive
530 -|(% style="width:267px" %)maxValue^^1^^|(% style="width:729px" %)if ExclusiveValueRange: xs:maxExclusives, else: xs:maxInclusive
531 -|(% style="width:267px" %)decimals^^1^^|(% style="width:729px" %)xs:fractionDigits
532 -|(% style="width:267px" %)pattern|(% style="width:729px" %)xs:pattern
505 +|**SDMX Facet**|**XML Schema Facet**|
506 +|minLength|xs:minLength|
507 +|maxLength|xs:maxLength|
508 +|minValue[^1]|if ExclusiveValueRange: xs:minExclusives, else: xs:minInclusive|
509 +|maxValue[^1]|if ExclusiveValueRange: xs:maxExclusives, else: xs:maxInclusive|
510 +|decimals[^1]|xs:fractionDigits|
511 +|pattern|xs:pattern|
533 533  
513 +[^1]: Note that these options only apply to numeric representations and should be ignored if the data type is non-numeric.
514 +
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,59 +539,61 @@
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>
523 +xml
524 + <xs:simpleType name="DecimalOrNotApplicableType">
525 + <xs:union memberTypes="xs:decimal common:NotApplicableType"/>
526 + </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>
532 +xml
533 + <xs:simpleType name="CL\_SUBINDICATOR\_OR\_NOT\_APPLICABLE">
534 + <xs:union memberTypes="CL\_SUBINDICATOR common:NotApplicableType"/>
535 + </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>
539 +xml
540 + <xs:simpleType name="CL\_ SUBINDICATOR ">
541 + <xs:restriction base="xs:string">
542 + <xs:enumeration value="A"/>
543 + <xs:enumeration value=""/>
544 + <xs:restriction>
545 + </xs:simpleType>
562 562  
563 563  For convenience the common schema provides the union types for the following data types.
564 564  
565 -(% style="width:747.294px" %)
566 -|**SDMX Data Type**|(% style="width:418px" %)**XML Schema Data Type**
567 -|AlphaNumeric|(% style="width:418px" %)common:AlphaNumericOrNotApplicableType
568 -|Alpha|(% style="width:418px" %)common:AlphaOrNotApplicableType
569 -|Numeric|(% style="width:418px" %)common:NumericOrNotApplicableType
570 -|BigInteger|(% style="width:418px" %)common:IntegerOrNotApplicableType
571 -|Integer|(% style="width:418px" %)common:IntOrNotApplicableType
572 -|Long|(% style="width:418px" %)common:LongOrNotApplicableType
573 -|Short|(% style="width:418px" %)common:ShortOrNotApplicableType
574 -|Decimal|(% style="width:418px" %)common:DecimalOrNotApplicableType
575 -|Float|(% style="width:418px" %)common:FloatOrNotApplicableType
576 -|Double|(% style="width:418px" %)common:DoubleOrNotApplicableType
577 -|Boolean|(% style="width:418px" %)common:BooleanOrNotApplicableType
578 -|Count|(% style="width:418px" %)common:IntegerOrNotApplicableType
579 -|InclusiveValueRange|(% style="width:418px" %)common:DecimalOrNotApplicableType
580 -|ExclusiveValueRange|(% style="width:418px" %)common:DecimalOrNotApplicableType
581 -|Incremental|(% style="width:418px" %)common:DecimalOrNotApplicableType
582 -|ObservationalTimePeriod|(% style="width:418px" %)common:ObservationalTimePeriodOrNotApplicableType
583 -|StandardTimePeriod|(% style="width:418px" %)common:StandardTimePeriodOrNotApplicableType
584 -|BasicTimePeriod|(% style="width:418px" %)common:BasicTimePeriodType
585 -|GregorianTimePeriod|(% style="width:418px" %)common:GregorianTimePeriodOrNotApplicableType
586 -|ReportingTimePeriod|(% style="width:418px" %)common:ReportingTimePeriodOrNotApplicableType
587 -|ReportingYear|(% style="width:418px" %)common:ReportingYearOrNotApplicableType
588 -|ReportingSemester|(% style="width:418px" %)common:ReportingSemesterOrNotApplicableType
589 -|ReportingTrimester|(% style="width:418px" %)common:ReportingTrimesterOrNotApplicableType
590 -|ReportingQuarter|(% style="width:418px" %)common:ReportingQuarterOrNotApplicableType
591 -|ReportingMonth|(% style="width:418px" %)common:ReportingMonthOrNotApplicableType
592 -|ReportingWeek|(% style="width:418px" %)common:ReportingWeekOrNotApplicableType
593 -|ReportingDay|(% style="width:418px" %)common:ReportingDayOrNotApplicableType
594 -|TimeRange|(% style="width:418px" %)common:TimeRangeOrNotApplicableType
549 +|**SDMX Data Type**|**XML Schema Data Type**|
550 +|AlphaNumeric|common:AlphaNumericOrNotApplicableType|
551 +|Alpha|common:AlphaOrNotApplicableType|
552 +|Numeric|common:NumericOrNotApplicableType|
553 +|BigInteger|common:IntegerOrNotApplicableType|
554 +|Integer|common:IntOrNotApplicableType|
555 +|Long|common:LongOrNotApplicableType|
556 +|Short|common:ShortOrNotApplicableType|
557 +|Decimal|common:DecimalOrNotApplicableType|
558 +|Float|common:FloatOrNotApplicableType|
559 +|Double|common:DoubleOrNotApplicableType|
560 +|Boolean|common:BooleanOrNotApplicableType|
561 +|Count|common:IntegerOrNotApplicableType|
562 +|InclusiveValueRange|common:DecimalOrNotApplicableType|
563 +|ExclusiveValueRange|common:DecimalOrNotApplicableType|
564 +|Incremental|common:DecimalOrNotApplicableType|
565 +|ObservationalTimePeriod|common:ObservationalTimePeriodOrNotApplicableType|
566 +|StandardTimePeriod|common:StandardTimePeriodOrNotApplicableType|
567 +|BasicTimePeriod|common:BasicTimePeriodType|
568 +|GregorianTimePeriod|common:GregorianTimePeriodOrNotApplicableType|
569 +|ReportingTimePeriod|common:ReportingTimePeriodOrNotApplicableType|
570 +|ReportingYear|common:ReportingYearOrNotApplicableType|
571 +|ReportingSemester|common:ReportingSemesterOrNotApplicableType|
572 +|ReportingTrimester|common:ReportingTrimesterOrNotApplicableType|
573 +|ReportingQuarter|common:ReportingQuarterOrNotApplicableType|
574 +|ReportingMonth|common:ReportingMonthOrNotApplicableType|
575 +|ReportingWeek|common:ReportingWeekOrNotApplicableType|
576 +|ReportingDay|common:ReportingDayOrNotApplicableType|
577 +|TimeRange|common:TimeRangeOrNotApplicableType|
595 595  
596 596  === 3.3.8 Representation for Intentionally Missing Measure and Attribute Values ===
597 597  
... ... @@ -604,59 +604,61 @@
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>
590 +xml
591 + <xs:simpleType name="DecimalOrMissingType">
592 + <xs:union memberTypes="xs:decimal common:MissingType"/>
593 + </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>
599 +xml
600 + <xs:simpleType name="CL\_SUBINDICATOR\_OR\_NOT\_APPLICABLE">
601 + <xs:union memberTypes="CL\_SUBINDICATOR common:MissingType"/>
602 + </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>
606 +xml
607 + <xs:simpleType name="CL\_ SUBINDICATOR ">
608 + <xs:restriction base="xs:string">
609 + <xs:enumeration value="A"/>
610 + <xs:enumeration value="#N/A"/>
611 + <xs:restriction>
612 + </xs:simpleType>
627 627  
628 628  For convenience the common schema provides the union types for the following data types.
629 629  
630 -(% style="width:804.294px" %)
631 -|(% style="width:279px" %)**SDMX Data Type**|(% style="width:522px" %)**XML Schema Data Type**
632 -|(% style="width:279px" %)AlphaNumeric|(% style="width:522px" %)common:AlphaNumericOrMissingType
633 -|(% style="width:279px" %)Alpha|(% style="width:522px" %)common:AlphaOrMissingType
634 -|(% style="width:279px" %)Numeric|(% style="width:522px" %)common:NumericOrMissingType
635 -|(% style="width:279px" %)BigInteger|(% style="width:522px" %)common:IntegerOrMissingType
636 -|(% style="width:279px" %)Integer|(% style="width:522px" %)common:IntOrMissingType
637 -|(% style="width:279px" %)Long|(% style="width:522px" %)common:LongOrMissingType
638 -|(% style="width:279px" %)Short|(% style="width:522px" %)common:ShortOrMissingType
639 -|(% style="width:279px" %)Decimal|(% style="width:522px" %)common:DecimalOrMissingType
640 -|(% style="width:279px" %)Float|(% style="width:522px" %)common:FloatOrMissingType
641 -|(% style="width:279px" %)Double|(% style="width:522px" %)common:DoubleOrMissingType
642 -|(% style="width:279px" %)Boolean|(% style="width:522px" %)common:BooleanOrMissingType
643 -|(% style="width:279px" %)Count|(% style="width:522px" %)common:IntegerOrMissingType
644 -|(% style="width:279px" %)InclusiveValueRange|(% style="width:522px" %)common:DecimalOrMissingType
645 -|(% style="width:279px" %)ExclusiveValueRange|(% style="width:522px" %)common:DecimalOrMissingType
646 -|(% style="width:279px" %)Incremental|(% style="width:522px" %)common:DecimalOrMissingType
647 -|(% style="width:279px" %)ObservationalTimePeriod|(% style="width:522px" %)common:ObservationalTimePeriodOrMissingType
648 -|(% style="width:279px" %)StandardTimePeriod|(% style="width:522px" %)common:StandardTimePeriodOrMissingType
649 -|(% style="width:279px" %)BasicTimePeriod|(% style="width:522px" %)common:BasicTimePeriodType
650 -|(% style="width:279px" %)GregorianTimePeriod|(% style="width:522px" %)common:GregorianTimePeriodOrMissingType
651 -|(% style="width:279px" %)ReportingTimePeriod|(% style="width:522px" %)common:ReportingTimePeriodOrMissingType
652 -|(% style="width:279px" %)ReportingYear|(% style="width:522px" %)common:ReportingYearOrMissingType
653 -|(% style="width:279px" %)ReportingSemester|(% style="width:522px" %)common:ReportingSemesterOrMissingType
654 -|(% style="width:279px" %)ReportingTrimester|(% style="width:522px" %)common:ReportingTrimesterOrMissingType
655 -|(% style="width:279px" %)ReportingQuarter|(% style="width:522px" %)common:ReportingQuarterOrMissingType
656 -|(% style="width:279px" %)ReportingMonth|(% style="width:522px" %)common:ReportingMonthOrMissingType
657 -|(% style="width:279px" %)ReportingWeek|(% style="width:522px" %)common:ReportingWeekOrMissingType
658 -|(% style="width:279px" %)ReportingDay|(% style="width:522px" %)common:ReportingDayOrMissingType
659 -|(% style="width:279px" %)TimeRange|(% style="width:522px" %)common:TimeRangeOrMissingType
616 +|**SDMX Data Type**|**XML Schema Data Type**|
617 +|AlphaNumeric|common:AlphaNumericOrMissingType|
618 +|Alpha|common:AlphaOrMissingType|
619 +|Numeric|common:NumericOrMissingType|
620 +|BigInteger|common:IntegerOrMissingType|
621 +|Integer|common:IntOrMissingType|
622 +|Long|common:LongOrMissingType|
623 +|Short|common:ShortOrMissingType|
624 +|Decimal|common:DecimalOrMissingType|
625 +|Float|common:FloatOrMissingType|
626 +|Double|common:DoubleOrMissingType|
627 +|Boolean|common:BooleanOrMissingType|
628 +|Count|common:IntegerOrMissingType|
629 +|InclusiveValueRange|common:DecimalOrMissingType|
630 +|ExclusiveValueRange|common:DecimalOrMissingType|
631 +|Incremental|common:DecimalOrMissingType|
632 +|ObservationalTimePeriod|common:ObservationalTimePeriodOrMissingType|
633 +|StandardTimePeriod|common:StandardTimePeriodOrMissingType|
634 +|BasicTimePeriod|common:BasicTimePeriodType|
635 +|GregorianTimePeriod|common:GregorianTimePeriodOrMissingType|
636 +|ReportingTimePeriod|common:ReportingTimePeriodOrMissingType|
637 +|ReportingYear|common:ReportingYearOrMissingType|
638 +|ReportingSemester|common:ReportingSemesterOrMissingType|
639 +|ReportingTrimester|common:ReportingTrimesterOrMissingType|
640 +|ReportingQuarter|common:ReportingQuarterOrMissingType|
641 +|ReportingMonth|common:ReportingMonthOrMissingType|
642 +|ReportingWeek|common:ReportingWeekOrMissingType|
643 +|ReportingDay|common:ReportingDayOrMissingType|
644 +|TimeRange|common:TimeRangeOrMissingType|
660 660  
661 661  === 3.3.9 Representation with Complex Text Format ===
662 662  
... ... @@ -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 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
659 + + Boolean, common:BooleanValueType can be used
660 + + String, common:StringValueType can be used
661 + + Integer, common:IntValueType can be used
662 + + Double, common:DoubleValueType can be used
663 + + 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]
673 +* If the type is based on a text format of a component local representation, and;
674 + + 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]
675 + + 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  
... ... @@ -714,39 +714,34 @@
714 714  
715 715  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:
716 716  
717 -~1. A sequence consisting of:
701 +1. A sequence consisting of:
702 +1. An element reference to common:Annotations, with a minimum occurrence of 0
703 + 2. A local element named DataProvider with the type common:DataProviderReferenceType, a form of unqualified and a minimum occurrence of 0
704 + 3. A choice with a minimum occurrence of 0 and a maximum occurrence of unbounded consisting of:
705 +1. A local element named Atts with a form of unqualified and a type of AttsType (as defined in the AttsType section which follows)
706 + 2. If the data structure defines groups, a local element named Group with a form of unqualified. The type of this element should be the type that is described in the GroupType section which follows.
707 + 3. If the dimension at the observation level is not AllDimensions, a local element named Series with a form of unqualified and a type of SeriesType (as defined in the SeriesType section which follows)
708 + 4. If the dimension at the observation level is AllDimensions, a local element named Obs with a form of unqualified and a type of ObsType (as defined in the ObsType section which follows)
709 + 4. If any metadata attribute usages defined in the data structure that declares an attribute relationship of dataflow, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurences of 0
718 718  
719 -* i. An element reference to common:Annotations, with a minimum occurrence of 0
720 -* ii  A local element named DataProvider with the type common:DataProviderReferenceType, a form of unqualified and a minimum occurrence of 0
721 -* iii A choice with a minimum occurrence of 0 and a maximum occurrence of unbounded consisting of:
722 -** a. A local element named Atts with a form of unqualified and a type of AttsType (as defined in the AttsType section which follows)
723 -** b. If the data structure defines groups, a local element named Group with a form of unqualified. The type of this element should be the type that is described in the GroupType section which follows.
724 -** c. If the dimension at the observation level is not AllDimensions, a local element named Series with a form of unqualified and a type of SeriesType (as defined in the SeriesType section which follows)
725 -** d. If the dimension at the observation level is AllDimensions, a local element named Obs with a form of unqualified and a type of ObsType (as defined in the ObsType section which follows)
726 -* iv. If any metadata attribute usages defined in the data structure that declares an attribute relationship of dataflow, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurences of 0
727 -
728 728  === 3.4.2 GroupType ===
729 729  
730 730  If the data structure definition defines only one group, a complex type with its name taken from the identifier of the lone group must be defined. This type is used for the Group element in the DataSetType. Its content model will be derived via restriction of the dsd:GroupType. The complex type content model will be as follows:
731 731  
732 -~1. A sequence consisting of:
733 -
734 -* i. An element reference to common:Annotations, with a minimum occurrence of 0
735 -* ii. If any attributes defined in the data structure that declares an attribute relationship with the group, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
736 -* iii. If any metadata attribute usages defined in the data structure that declares an attribute relationship with the group, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0
737 -
738 -2. An attribute for each dimension referenced by the group. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is required
739 -3. An attribute for each data attribute with simple representation defined in the data structure that declares an attribute relationship with the group or specifies the group as an attachment group. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is optional
715 +1. A sequence consisting of:
716 +1. An element reference to common:Annotations, with a minimum occurrence of 0
717 + 2. If any attributes defined in the data structure that declares an attribute relationship with the group, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
718 + 3. If any metadata attribute usages defined in the data structure that declares an attribute relationship with the group, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0
719 +2. An attribute for each dimension referenced by the group. The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is required
720 +3. An attribute for each data attribute with simple representation defined in the data structure that declares an attribute relationship with the group or specifies the group as an attachment group. The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is optional
740 740  4. An attribute named type with a type of common:IDType, usage of optional, and a fixed value of the identifier of the group
741 741  
742 742  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:
743 743  
744 -~1. A sequence consisting of:
745 -
746 -* i. An element reference to common:Annotations, with a minimum occurrence of 0
747 -* ii. If any attributes defined in the data structure that declares an attribute relationship with a group, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
748 -* iii. If any metadata attribute usages defined in the data structure that declares an attribute relationship with any group, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0
749 -
725 +1. A sequence consisting of:
726 +1. An element reference to common:Annotations, with a minimum occurrence of 0
727 + 2. If any attributes defined in the data structure that declares an attribute relationship with a group, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
728 + 3. If any metadata attribute usages defined in the data structure that declares an attribute relationship with any group, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0
750 750  2. An attribute named type with a type of Group.ID, and a usage of optional
751 751  3. An anyAttribute declaration with a namespace of ##local##
752 752  
... ... @@ -754,14 +754,12 @@
754 754  
755 755  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:
756 756  
757 -~1. A sequence consisting of:
758 -
759 -* i. An element reference to common:Annotations, with a minimum occurrence of 0
760 -* ii. If any attributes with complex representation defined in the data structure declares an attribute relationship with the group, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
761 -* iii. If any metadata attribute usages defined in the data structure that declares an attribute relationship with the group, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0
762 -
763 -2. An attribute for each dimension referenced by the group. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is required
764 -3. An attribute for each data attribute with simple representation defined in the data structure that declares an attribute relationship with the group or specifies the group as an attachment group. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is optional
736 +1. A sequence consisting of:
737 +1. An element reference to common:Annotations, with a minimum occurrence of 0
738 + 2. If any attributes with complex representation defined in the data structure declares an attribute relationship with the group, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
739 + 3. If any metadata attribute usages defined in the data structure that declares an attribute relationship with the group, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0
740 +2. An attribute for each dimension referenced by the group. The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is required
741 +3. An attribute for each data attribute with simple representation defined in the data structure that declares an attribute relationship with the group or specifies the group as an attachment group. The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is optional
765 765  4. An attribute named type with a type of Group.ID, usage of optional, and a fixed value of the identifier of the group
766 766  
767 767  === 3.4.3 SeriesType ===
... ... @@ -768,59 +768,48 @@
768 768  
769 769  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:
770 770  
771 -~1. A sequence consisting of:
772 -
773 -* i. An element reference to common:Annotations, with a minimum occurrence of 0
774 -* ii. If any attributes with complex representation defined in the data structure declares an attribute relationship with a dimension that is not at the observation level, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
775 -* iii. A local element named Obs with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of ObsType (as defined in the ObsType section which follows)
776 -* iv. If any metadata attribute usages defined in the data structure that declares an attribute relationship with the series, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0
777 -
748 +1. A sequence consisting of:
749 +1. An element reference to common:Annotations, with a minimum occurrence of 0
750 + 2. If any attributes with complex representation defined in the data structure declares an attribute relationship with a dimension that is not at the observation level, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
751 + 3. A local element named Obs with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of ObsType (as defined in the ObsType section which follows)
752 + 4. If any metadata attribute usages defined in the data structure that declares an attribute relationship with the series, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0
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).
754 +3. An attribute for each dimension defined by the data structure definition, except for the dimension at the observation level and the time dimension (TIME\_PERIOD). The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is required
755 +4. An attribute for each data attribute defined with simple representation in the data structure that declares an attribute relationship with any dimension outside of the dimension at the observation level (so long as it does not also declare an attachment group). The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is optional
780 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
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 -
784 784  === 3.4.4 AttsType ===
785 785  
786 786  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:
787 787  
788 -~1. A sequence consisting of:
789 -
790 -* i. An element reference to common:Annotations, with a minimum occurrence of 0
791 -* ii. If any attributes with complex representation are defined in the data structure, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
792 -
761 +1. A sequence consisting of:
762 +1. An element reference to common:Annotations, with a minimum occurrence of 0
763 + 2. If any attributes with complex representation are defined in the data structure, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
793 793  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
794 -3. An attribute for all dimension defined by the data structure definition. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is optional
795 -4. An attribute for each data attribute defined with simple representation in the data structure. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is optional
765 +3. An attribute for all dimension defined by the data structure definition. The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is optional
766 +4. An attribute for each data attribute defined with simple representation in the data structure. The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is optional
796 796  
797 797  === 3.4.5 ObsType ===
798 798  
799 799  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:
800 800  
801 -~1. A sequence consisting of:
772 +1. A sequence consisting of:
773 +1. An element reference to common:Annotations, with a minimum occurrence of 0
774 + 2. If any measures with complex representations are defined in the data structure, any attributes with complex representation that declare an attribute relationship with the observation, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
775 + 3. If any metadata attribute usages defined in the data structure that declares an attribute relationship with the observation, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0
776 +2. An attribute named TIME\_PERIOD with a type of common:
777 + 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
778 +3. If the dimension at the observation level is not all dimensions or the time dimension (TIME\_PERIOD), an attribute for the dimension at the observation level. The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is required
779 +4. If the dimension at the observation level is all dimensions, an attribute for each dimension defined by the data structure definition, except for the time dimension (TIME\_PERIOD). The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is required
780 +5. An attribute for each measure with simple representation defined by the data structure definition. The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) is defined according to the general rules defined in the previous section, and the usage is optional
781 +6. An attribute for each data attribute with simple representation defined in the data structure that declares an attribute relationship with the observation. The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is optional
802 802  
803 -* i. An element reference to common:Annotations, with a minimum occurrence of 0
804 -* ii. If any measures with complex representations are defined in the data structure, any attributes with complex representation that declare an attribute relationship with the observation, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
805 -* iii. If any metadata attribute usages defined in the data structure that declares an attribute relationship with the observation, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0
806 -
807 -2. An attribute named TIME\_PERIOD with a type of common: ObservationalTimePeriodValueType. If the dimension at the observation level is the time dimension (TIME\_PERIOD) or all dimensions and the time dimension is defined by the data structure, a usage of required; otherwise, a usage of prohibited
808 -3. If the dimension at the observation level is not all dimensions or the time dimension (TIME\_PERIOD), an attribute for the dimension at the observation level. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is required
809 -4. If the dimension at the observation level is all dimensions, an attribute for each dimension defined by the data structure definition, except for the time dimension (TIME\_PERIOD).
810 -
811 -The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is required
812 -5. An attribute for each measure with simple representation defined by the data structure definition. The XML attribute name and type is defined according to the general rules defined in the previous section, and the usage is optional
813 -6. An attribute for each data attribute with simple representation defined in the data structure that declares an attribute relationship with the observation. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is optional
814 -
815 815  === 3.4.6 CompType ===
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 -
787 +1. A sequence consisting of:
788 +1. An element reference to common:Annotations, with a minimum occurrence of 0
789 + 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.
798 +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,11 +839,11 @@
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.
808 +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  
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).
812 +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).
847 847  
848 848  Only non-dimensional components (measure, attribute or reference metadata values) can be **omitted** (null or absent). Bulk replacing is thus not supported.
849 849  
... ... @@ -851,9 +851,9 @@
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.
820 +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.
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.
822 +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.
857 857  
858 858  === 4.1.3 Delete Action ===
859 859  
... ... @@ -867,66 +867,64 @@
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.
836 +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  
874 874  The following convention is used to indicate the state of components in data messages:
875 875  
876 -(% style="width:1364.29px" %)
877 -| | |(% style="width:260px" %)**Dimension value is**|(% style="width:391px" %) |(% style="width:383px" %)**Measure, attribute or reference metadata value is**|(% style="width:184px" %)
878 -| | |(% style="width:260px" %)**Omitted**|(% style="width:391px" %)**switched off**|(% style="width:383px" %)**Omitted**|(% style="width:184px" %)**Present**
879 -|Action|Delete|(% style="width:260px" %)bulk deletion: dimension value doesn't matter|(% style="width:391px" %)only for irrelevant dimensions:1) higher-level (reference metadata) attributes not attached to this dimension(incl. TIME\_PERIOD)2) measures and attributes not attached to this dimension if the DSD allows for an ‘evolving structure’ (excl. TIME\_PERIOD)|(% style="width:383px" %)to be deleted only if **all** non-dimension components are omitted|(% style="width:184px" %)to be deleted
880 -| |Merge|(% style="width:260px" %)//bulk merge is not permitted//|(% style="width:391px" %)(see above)|(% style="width:383px" %)not to be changed|(% style="width:184px" %)to be updated/inserted
881 -| |Replace|(% style="width:260px" %)//bulk replace is not permitted//|(% style="width:391px" %)(see above)|(% style="width:383px" %)at permitted replacement levels: to be deleted, otherwise not to be changed|(% style="width:184px" %)to be updated/inserted
882 -|Format|XML|(% style="width:260px" %)xml element/attribute is absent|(% style="width:391px" %)~|xml element/attribute is absent|(% style="width:383px" %)any valid or intentionally missing value|(% style="width:184px" %)
883 -| |JSON|(% style="width:260px" %)\<empty\>|(% style="width:391px" %)““|(% style="width:383px" %)NULL or absent|(% style="width:184px" %)(see above)
884 -| |CSV|(% style="width:260px" %)\<empty\> cell or column is absent|(% style="width:391px" %)~|<empty> cell or column is absent|(% style="width:383px" %)(see above)|(% style="width:184px" %)
842 +| | |**Dimension value is**| |**Measure, attribute or reference metadata value is**| |
843 +| | |**Omitted**|**switched off**|**Omitted**|**Present**|
844 +|Action|Delete|bulk deletion: dimension value doesn't matter|only for irrelevant dimensions:1) higher-level (reference metadata) attributes not attached to this dimension(incl. TIME\_PERIOD)2) measures and attributes not attached to this dimension if the DSD allows for an ‘evolving structure’ (excl. TIME\_PERIOD)|to be deleted only if **all** non-dimension components are omitted|to be deleted|
845 +| |Merge|*bulk merge is not permitted*|(see above)|not to be changed|to be updated/inserted|
846 +| |Replace|*bulk replace is not permitted*|(see above)|at permitted replacement levels: to be deleted, otherwise not to be changed|to be updated/inserted|
847 +|Format|XML|xml element/attribute is absent|~|xml element/attribute is absent|any valid or intentionally missing value|
848 +| |JSON|\<empty\>|““|NULL or absent|(see above)|
849 +| |CSV|\<empty\> cell or column is absent|~|<empty> cell or column is absent|(see above)|
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.
853 +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 -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.
855 +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  
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).
857 +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).
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.
859 +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.
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:**
861 +**Recommended[^2] dataset actions in SDMX web service responses to GET data queries:**
897 897  
898 -~1. Without the //updatedAfter//, //includeHistory//, //detail//, //attributes// or //measures// URL parameters:
863 +1. Without the *updatedAfter*, *includeHistory*, *detail*, *attributes* or *measures* URL parameters:
864 +
865 + The response message should contain the retrieved data in a *Replace* dataset (instead of the previous *information* dataset).
899 899  
900 -The response message should contain the retrieved data in a //Replace// dataset (instead of the previous //information// dataset).
867 +1. Without the *updatedAfter* and *includeHistory*, but with *detail*, *attributes* or *measures* URL parameters:
868 +
869 + The response message should contain the retrieved data in a *Merge* dataset (instead of the previous *Information* dataset).
901 901  
902 -2. Without the //updatedAfter// and //includeHistory//, but with //detail//, //attributes// or //measures// URL parameters:
871 +1. With the *updatedAfter* URL parameter:
872 +
873 + 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:
903 903  
904 -The response message should contain the retrieved data in a //Merge// dataset (instead of the previous //Information// dataset).
875 +* 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
876 + a *Replace* dataset for all other changed observations and changed attribute and data-related reference metadata values attached to specific dimension combinations, or 
877 +* 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
878 + a *Merge* dataset for all other updated or inserted observation, attribute and data-related reference metadata values.
879 +
880 + 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.
905 905  
906 -3. With the //updatedAfter// URL parameter:
882 +1. With the *includeHistory* URL parameter:
883 +
884 + 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.
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:
886 +1. With the *asOf* URL parameter:
887 +
888 + 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.
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.
890 +[^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.
914 914  
915 -The DB synchronization use case requires that the generated response must always allow achieving to replicate the exact same punctual data content as currently stored in the queried data source.
916 -
917 -~1. With the //includeHistory// URL parameter:
918 -
919 -Using a number of datasets with //Delete//, //Replace// or //Merge// actions and limited in their validity time span that allow achieving to replicate the exact same punctual data contents as previously stored in the queried data source.
920 -
921 -2. With the //asOf// URL parameter:
922 -
923 -The recommendations of 1 and 2 apply depending on the other parameters. In addition, the returned dataset should have its validity time span limited to the point in time requested in the //asOf// parameter.
924 -
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.
894 +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.
930 -
931 ----
932 -{{putFootnotes/}}--
896 +The former message header or metadataset property *DataSetAction* is deprecated. To avoid conflicts, it is now ignored if still present.
SKMS.Methodology.Code.MethodologyClass[0]
Index
... ... @@ -1,1 +1,0 @@
1 -5
SUZ.Methodology.Code.MethodologyClass[0]
index
... ... @@ -1,0 +1,1 @@
1 +4
© Semantic R&D Group, 2026