Last modified by Artur on 2025/09/10 11:19

From version 5.1
edited by Helena
on 2025/06/24 15:00
Change comment: There is no comment for this version
To version 6.1
edited by Helena
on 2025/06/24 15:06
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -8,7 +8,7 @@
8 8  
9 9  The various data messages which existed in the standard have been harmonised into two general formats; generic and structured data. The generic data is much like it has been previously, only slightly modified to conform with the harmonised view on data. The structured data combined the principles of the previous versions compact and cross sectional formats into one more generalised format.
10 10  
11 -The major shift from the previous version is now that 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. This in effect, combined the abilities of the time series and cross sectional formats in the a single data format. This format also allows for multiple measure to be expressed when the observation dimension is the measure dimension defined in the data structured. The key differences from the previous versions is that this all is possible in a single data structure definition specific format, as well as being possible in the generic format as well. The goal was to make the structures as homogenous as possible.
11 +The major shift from the previous version is now that all data can be exchanged as either an un-grouped collection oData structure and metadata structure-specific schemas are each based on one single core construct found in their respective structure-specific namespaces;f 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. This in effect, combined the abilities of the time series and cross sectional formats in the a single data format. This format also allows for multiple measure to be expressed when the observation dimension is the measure dimension defined in the data structured. The key differences from the previous versions is that this all is possible in a single data structure definition specific format, as well as being possible in the generic format as well. The goal was to make the structures as homogenous as possible.
12 12  
13 13  Another shift from the previous version in the manner in which the base data structure specific format is defined. In previous versions there was not structure defined, so one had to understand all of the requirements and read the specification in order to understand what could be expected in any structure specific format. In this version, that issue has been addressed. The base structures now impose a strict format on the data structure specific schemas. This is achieved much like the referencing structure in the common namespace through the use of unqualified elements. By the elements not existing in a namespace, the structure specific schemas can place the necessary restrictions of them while still being forced to adhere to prescribed structure. This means that not only are the structures able to perform the validation that is required, but that the messages will be much simpler to process as the format will always use the same element names.
14 14  
... ... @@ -26,11 +26,13 @@
26 26  
27 27  Referenced Namespaces:
28 28  
29 -|**Namespace**|**Prefix**
30 -|http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|com
31 -|http:~/~/www.w3.org/2001/XMLSchema|xs
29 +(% style="width:610.294px" %)
30 +|(% style="width:487px" %)**Namespace**|(% style="width:120px" %)**Prefix**
31 +|(% style="width:487px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|(% style="width:120px" %)com
32 +|(% style="width:487px" %)http:~/~/www.w3.org/2001/XMLSchema|(% style="width:120px" %)xs
32 32  
33 33  Contents:
35 +
34 34  13 Complex Types
35 35  
36 36  === 2.1.2 Complex Types ===
... ... @@ -43,33 +43,37 @@
43 43  ** DataSetType
44 44  
45 45  Attributes:
48 +
46 46  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?
47 47  
48 48  Content:
52 +
49 49  com:Annotations?, DataProvider?, Attributes?, Group*, (Series+ | Obs+)?
50 50  
51 51  Attribute Documentation:
52 52  
53 -|**Name**|**Type**|**Documentation**
54 -|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).
55 -|setID|com:IDType|The setID provides an identification of the data or metadata set.
56 -|action|com:ActionType|The action attribute indicates whether the file is appending, replacing, or deleting.
57 -|reportingBeginDate|com: BasicTimePeriodType|The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set.
58 -|reportingEndDate|com: BasicTimePeriodType|The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.
59 -|validFromDate|xs:dateTime|The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set.
60 -|validToDate|xs:dateTime|The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set.
61 -|publicationYear|xs:gYear|The publicationYear holds the ISO 8601 four-digit year.
62 -|publicationPeriod|com: ObservationalTimePer iodType|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).
57 +(% style="width:1011.29px" %)
58 +|**Name**|**Type**|(% style="width:597px" %)**Documentation**
59 +|structureRef|xs:IDREF|(% style="width:597px" %)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).
60 +|setID|com:IDType|(% style="width:597px" %)The setID provides an identification of the data or metadata set.
61 +|action|com:ActionType|(% style="width:597px" %)The action attribute indicates whether the file is appending, replacing, or deleting.
62 +|reportingBeginDate|com: BasicTimePeriodType|(% style="width:597px" %)The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set.
63 +|reportingEndDate|com: BasicTimePeriodType|(% style="width:597px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.
64 +|validFromDate|xs:dateTime|(% style="width:597px" %)The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set.
65 +|validToDate|xs:dateTime|(% style="width:597px" %)The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set.
66 +|publicationYear|xs:gYear|(% style="width:597px" %)The publicationYear holds the ISO 8601 four-digit year.
67 +|publicationPeriod|com: ObservationalTimePeriodType|(% style="width:597px" %)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).
63 63  
64 64  Element Documentation:
65 65  
66 -|**Name**|**Type**|**Documentation**
67 -|com:Annotations|com: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 my reference it.
68 -|DataProvider|com: DataProviderReferenc eType|DataProvider contains a reference to the provider for the data set.
69 -|Attributes|ValuesType|Attributes contains the collection of attribute values for attributes defined in the data structure definition which do not have an attribute relationship with any other data structure definition components.
70 -|Group|GroupType|Group contains a references 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 which is declared in the structure specification to be at the observation level. In addition to the key and observations, the series contains values for 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|ObsOnlyType|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 attributes which have an association with the primary measure or any dimension (so long as it does not specify a group attachment).
71 +(% style="width:1016.29px" %)
72 +|**Name**|**Type**|(% style="width:642px" %)**Documentation**
73 +|com:Annotations|com:AnnotationsType|(% style="width:642px" %)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 my reference it.
74 +|DataProvider|com: DataProviderReferenceType|(% style="width:642px" %)DataProvider contains a reference to the provider for the data set.
75 +|Attributes|ValuesType|(% style="width:642px" %)Attributes contains the collection of attribute values for attributes defined in the data structure definition which do not have an attribute relationship with any other data structure definition components.
76 +|Group|GroupType|(% style="width:642px" %)Group contains a references 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.
77 +|Series|SeriesType|(% style="width:642px" %)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 which is declared in the structure specification to be at the observation level. In addition to the key and observations, the series contains values for 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.
78 +|Obs|ObsOnlyType|(% style="width:642px" %)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 attributes which have an association with the primary measure or any dimension (so long as it does not specify a group attachment).
73 73  
74 74  **GroupType: **GroupType 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.
75 75  
... ... @@ -79,22 +79,26 @@
79 79  ** GroupType
80 80  
81 81  Attributes:
88 +
82 82  type
83 83  
84 84  Content:
92 +
85 85  com:Annotations?, GroupKey?, Attributes
86 86  
87 87  Attribute Documentation:
88 88  
89 -|**Name**|**Type**|**Documentation**
90 -|type|com:IDType|The type attribute holds the identifier assigned to the group in the data structure definition for which attribute values are being provided.
97 +(% style="width:1010.29px" %)
98 +|**Name**|**Type**|(% style="width:709px" %)**Documentation**
99 +|type|com:IDType|(% style="width:709px" %)The type attribute holds the identifier assigned to the group in the data structure definition for which attribute values are being provided.
91 91  
92 92  Element Documentation:
93 93  
94 -|**Name**|**Type**|**Documentation**
95 -|com:Annotations|com: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 my reference it.
96 -|GroupKey|ValuesType|GroupKey contains the values for each dimension defined as being a member of the referenced group in the data structure definition. A value must be provided for every group dimension. This is optional, and not used if the group is defined as an association to an attachment constraint rather than a subset of the data structure definition dimensions.
97 -|Attributes|ValuesType|Attributes contains the set of attribute values which are reported for group. The attribute values provided here apply to all data matching the partial key defined by the group key or the key sets of the associated attachment constraint.
103 +(% style="width:1014.29px" %)
104 +|**Name**|**Type**|(% style="width:704px" %)**Documentation**
105 +|com:Annotations|com:AnnotationsType|(% style="width:704px" %)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 my reference it.
106 +|GroupKey|ValuesType|(% style="width:704px" %)GroupKey contains the values for each dimension defined as being a member of the referenced group in the data structure definition. A value must be provided for every group dimension. This is optional, and not used if the group is defined as an association to an attachment constraint rather than a subset of the data structure definition dimensions.
107 +|Attributes|ValuesType|(% style="width:704px" %)Attributes contains the set of attribute values which are reported for group. The attribute values provided here apply to all data matching the partial key defined by the group key or the key sets of the associated attachment constraint.
98 98  
99 99  **SeriesType: **SeriesType 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. In addition to observations, values can be provided for 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 an relationship with the observation dimension). It is possible for the series to contain only observations or only attribute values, or both.
100 100  
... ... @@ -104,15 +104,17 @@
104 104  ** SeriesType
105 105  
106 106  Content:
117 +
107 107  com:Annotations?, SeriesKey, Attributes?, Obs*
108 108  
109 109  Element Documentation:
110 110  
111 -|**Name**|**Type**|**Documentation**
112 -|com:Annotations|com: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 my reference it.
113 -|SeriesKey|ValuesType|SeriesKey contains the values for each all dimensions defined in the data structure definition, except for that which is declared to be at the observation level for this data set. This key is required, and every dimension must be provided a value.
114 -|Attributes|ValuesType|Attributes contains the values for attributes which are associated with the dimensions which make up the series key, so long as the attributes do not also specify an attachment group or have a relationship with the observation dimension.
115 -|Obs|ObsType|Obs contains an observation which shares the dimensionality of the series key. These observations are disambiguated from one another within this series by a single dimension value provided for each dimension. The dimension which provides this observation key is declared in the structure specification for the data set, which is provided in the header of the data message.
122 +(% style="width:999.294px" %)
123 +|**Name**|**Type**|(% style="width:689px" %)**Documentation**
124 +|com:Annotations|com:AnnotationsType|(% style="width:689px" %)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 my reference it.
125 +|SeriesKey|ValuesType|(% style="width:689px" %)SeriesKey contains the values for each all dimensions defined in the data structure definition, except for that which is declared to be at the observation level for this data set. This key is required, and every dimension must be provided a value.
126 +|Attributes|ValuesType|(% style="width:689px" %)Attributes contains the values for attributes which are associated with the dimensions which make up the series key, so long as the attributes do not also specify an attachment group or have a relationship with the observation dimension.
127 +|Obs|ObsType|(% style="width:689px" %)Obs contains an observation which shares the dimensionality of the series key. These observations are disambiguated from one another within this series by a single dimension value provided for each dimension. The dimension which provides this observation key is declared in the structure specification for the data set, which is provided in the header of the data message.
116 116  
117 117  **ObsOnlyType: **ObsOnlyType defines the structure for an un-grouped observation. Unlike a group observation, an un-grouped must provided a full set of values for every dimension declared in the data structure definition. The observation can contain an observed value and/or a collection of attribute values.
118 118  
... ... @@ -122,15 +122,17 @@
122 122  ** ObsOnlyType
123 123  
124 124  Content:
137 +
125 125  com:Annotations?, ObsKey, ObsValue?, Attributes?
126 126  
127 127  Element Documentation:
128 128  
129 -|**Name**|**Type**|**Documentation**
130 -|com:Annotations|com: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 my reference it.
131 -|ObsKey|ValuesType|ObsKey contains the values for every dimension defined in the data structure definition. A value must be provided for each dimension. This key serves to disambiguate the un-grouped observation within the data set.
132 -|ObsValue|ObsValueType|ObsValue type contains the value for the observation.
133 -|Attributes|ValuesType|Attributes contains the set of values reported for the attributes which have an association with the primary measure or any dimension in the data structure definition (so long as an attachment group is not also specified).
142 +(% style="width:996.294px" %)
143 +|**Name**|**Type**|(% style="width:651px" %)**Documentation**
144 +|com:Annotations|com:AnnotationsType|(% style="width:651px" %)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 my reference it.
145 +|ObsKey|ValuesType|(% style="width:651px" %)ObsKey contains the values for every dimension defined in the data structure definition. A value must be provided for each dimension. This key serves to disambiguate the un-grouped observation within the data set.
146 +|ObsValue|ObsValueType|(% style="width:651px" %)ObsValue type contains the value for the observation.
147 +|Attributes|ValuesType|(% style="width:651px" %)Attributes contains the set of values reported for the attributes which have an association with the primary measure or any dimension in the data structure definition (so long as an attachment group is not also specified).
134 134  
135 135  **ObsType: **ObsType defines the structure of a grouped observation. The observation must be provided a value for the dimension which is declared to be at the observation level for this data set. This dimension value should disambiguate the observation within the series in which it is defined (i.e. there should not be another observation with the same dimension value). The observation can contain an observed value and/or attribute values.
136 136  
... ... @@ -140,39 +140,46 @@
140 140  ** ObsType
141 141  
142 142  Content:
157 +
143 143  com:Annotations?, ObsDimension, ObsValue?, Attributes?
144 144  
145 145  Element Documentation:
146 146  
147 -|**Name**|**Type**|**Documentation**
148 -|com:Annotations|com: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 my reference it.
149 -|ObsDimension|BaseValueType|ObsDimension holds the key for the grouped observation, i.e. the value of the observation dimension. Note that in this element, the reference to the dimension is optional, since it can be inferred from the structure specification for the data set. This saves having to repeat the value unnecessarily. It is assumed that any application processing the data set will have the information from the structure specification available, so that if a dimension identifier is not supplied here, the proper reference can be applied.
150 -|ObsValue|ObsValueType|ObsValue type contains the value for the observation.
151 -|Attributes|ValuesType|Attributes contains the set of values reported for the attributes which have an association with the primary measure or the observations dimension (so long as an attachment group is not also specified).
162 +(% style="width:1004.29px" %)
163 +|**Name**|**Type**|(% style="width:694px" %)**Documentation**
164 +|com:Annotations|com:AnnotationsType|(% style="width:694px" %)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 my reference it.
165 +|ObsDimension|BaseValueType|(% style="width:694px" %)ObsDimension holds the key for the grouped observation, i.e. the value of the observation dimension. Note that in this element, the reference to the dimension is optional, since it can be inferred from the structure specification for the data set. This saves having to repeat the value unnecessarily. It is assumed that any application processing the data set will have the information from the structure specification available, so that if a dimension identifier is not supplied here, the proper reference can be applied.
166 +|ObsValue|ObsValueType|(% style="width:694px" %)ObsValue type contains the value for the observation.
167 +|Attributes|ValuesType|(% style="width:694px" %)Attributes contains the set of values reported for the attributes which have an association with the primary measure or the observations dimension (so long as an attachment group is not also specified).
152 152  
153 153  **ValuesType: **ValuesType is a general structure which contains a collection of data structure definition component values. This type is used to provide both key and attribute collection values.
154 154  
155 155  Content:
172 +
156 156  Value+
157 157  
158 158  Element Documentation:
159 159  
160 -|**Name**|**Type**|**Documentation**
161 -|Value|ComponentValueType|Value contains a component value and a reference to the component for which a value is being provided.
177 +(% style="width:1008.29px" %)
178 +|**Name**|(% style="width:185px" %)**Type**|(% style="width:692px" %)**Documentation**
179 +|Value|(% style="width:185px" %)ComponentValueType|(% style="width:692px" %)Value contains a component value and a reference to the component for which a value is being provided.
162 162  
163 163  **BaseValueType: **BaseValueType is a general structure which contains a reference to a data structure definition component and a value for that component. In this structure the reference to the component is optional to allow for usages where the actual reference might be provided in another context.
164 164  
165 165  Attributes:
184 +
166 166  id?, value
167 167  
168 168  Content:
188 +
169 169  {Empty}
170 170  
171 171  Attribute Documentation:
172 172  
173 -|**Name**|**Type**|**Documentation**
174 -|id|com:NCNameIDType|The id attribute contains the identifier for the component for which a value is being provided.
175 -|value|xs:anySimpleType|The value attribute contains the provided component value.
193 +(% style="width:1003.29px" %)
194 +|**Name**|(% style="width:194px" %)**Type**|(% style="width:664px" %)**Documentation**
195 +|id|(% style="width:194px" %)com:NCNameIDType|(% style="width:664px" %)The id attribute contains the identifier for the component for which a value is being provided.
196 +|value|(% style="width:194px" %)xs:anySimpleType|(% style="width:664px" %)The value attribute contains the provided component value.
176 176  
177 177  **ObsValueType: **ObsValueType is a derivation of the BaseValueType which is used to provide an observation value. Since an observation value is always associated with the data structure definition primary measure, and the identifier for the primary measure is fixed, the component reference for this structure is fixed. Note that this means that it is not necessary to provide a value in an instance as the fixed value will be provided in the post validation information set.
178 178  
... ... @@ -182,16 +182,19 @@
182 182  ** ObsValueType
183 183  
184 184  Attributes:
206 +
185 185  id?, value
186 186  
187 187  Content:
210 +
188 188  {Empty}
189 189  
190 190  Attribute Documentation:
191 191  
192 -|**Name**|**Type**|**Documentation**
193 -|id (fixed: OBS_VALUE)|com:NCNameIDType|The id attribute contains a fixed reference to the primary measure component of the data structure definition.
194 -|value|xs:string|The value attribute contains the provided component value.
215 +(% style="width:1004.29px" %)
216 +|(% style="width:190px" %)**Name**|(% style="width:213px" %)**Type**|(% style="width:598px" %)**Documentation**
217 +|(% style="width:190px" %)id (fixed: OBS_VALUE)|(% style="width:213px" %)com:NCNameIDType|(% style="width:598px" %)The id attribute contains a fixed reference to the primary measure component of the data structure definition.
218 +|(% style="width:190px" %)value|(% style="width:213px" %)xs:string|(% style="width:598px" %)The value attribute contains the provided component value.
195 195  
196 196  **ComponentValueType: **ComponentValueType is a derivation of the BaseValueType which requires that the component reference be provided. This is used when the identification of the component cannot be inferred from another context.
197 197  
... ... @@ -201,16 +201,19 @@
201 201  ** ComponentValueType
202 202  
203 203  Attributes:
228 +
204 204  id, value
205 205  
206 206  Content:
232 +
207 207  {Empty}
208 208  
209 209  Attribute Documentation:
210 210  
211 -|**Name**|**Type**|**Documentation**
212 -|id|com:NCNameIDType|The id attribute contains the identifier for the component for which a value is being provided.
213 -|value|xs:string|The value attribute contains the provided component value.
237 +(% style="width:1008.29px" %)
238 +|**Name**|(% style="width:184px" %)**Type**|(% style="width:679px" %)**Documentation**
239 +|id|(% style="width:184px" %)com:NCNameIDType|(% style="width:679px" %)The id attribute contains the identifier for the component for which a value is being provided.
240 +|value|(% style="width:184px" %)xs:string|(% style="width:679px" %)The value attribute contains the provided component value.
214 214  
215 215  **TimeSeriesDataSetType: **TimeSeriesDataSetType is a derivation of the base DataSetType of the generic format the restricts the data set to only allow for grouped observations where the dimension at the observation level is the time dimension of the data structure definition. This means that unlike the base data set structure, there can be no un-grouped observations. Because this derivation is achieved using restriction, data sets conforming to this type will inherently conform to the base data set structure as well. In fact, data structured here will be identical to data in the base data set when the time dimension is the observation dimension. This means that the data contained in this structure can be processed in exactly the same manner as the base structure.
216 216  
... ... @@ -221,32 +221,36 @@
221 221  *** TimeSeriesDataSetType
222 222  
223 223  Attributes:
251 +
224 224  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?
225 225  
226 226  Content:
255 +
227 227  com:Annotations?, DataProvider?, Attributes?, Group*, Series*
228 228  
229 229  Attribute Documentation:
230 230  
231 -|**Name**|**Type**|**Documentation**
232 -|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).
233 -|setID|com:IDType|The setID provides an identification of the data or metadata set.
234 -|action|com:ActionType|The action attribute indicates whether the file is appending, replacing, or deleting.
235 -|reportingBeginDate|com: BasicTimePeriodType|The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set.
236 -|reportingEndDate|com: BasicTimePeriodType|The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.
237 -|validFromDate|xs:dateTime|The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set.
238 -|validToDate|xs:dateTime|The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set.
239 -|publicationYear|xs:gYear|The publicationYear holds the ISO 8601 four-digit year.
240 -|publicationPeriod|com: ObservationalTimePer iodType|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).
260 +(% style="width:1004.29px" %)
261 +|**Name**|**Type**|(% style="width:590px" %)**Documentation**
262 +|structureRef|xs:IDREF|(% style="width:590px" %)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).
263 +|setID|com:IDType|(% style="width:590px" %)The setID provides an identification of the data or metadata set.
264 +|action|com:ActionType|(% style="width:590px" %)The action attribute indicates whether the file is appending, replacing, or deleting.
265 +|reportingBeginDate|com: BasicTimePeriodType|(% style="width:590px" %)The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set.
266 +|reportingEndDate|com: BasicTimePeriodType|(% style="width:590px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.
267 +|validFromDate|xs:dateTime|(% style="width:590px" %)The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set.
268 +|validToDate|xs:dateTime|(% style="width:590px" %)The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set.
269 +|publicationYear|xs:gYear|(% style="width:590px" %)The publicationYear holds the ISO 8601 four-digit year.
270 +|publicationPeriod|com: ObservationalTimePeriodType|(% style="width:590px" %)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).
241 241  
242 242  Element Documentation:
243 243  
244 -|**Name**|**Type**|**Documentation**
245 -|com:Annotations|com: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 my reference it.
246 -|DataProvider|com: DataProviderReferenc eType|DataProvider contains a reference to the provider for the data set.
247 -|Attributes|ValuesType|Attributes contains the collection of attribute values for attributes defined in the data structure definition which do not have an attribute relationship with any other data structure definition components.
248 -|Group|GroupType|Group contains a references 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.
249 -|Series|TimeSeriesType|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 time dimension. In addition to the key and observations, the series contains values for 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 time dimension.
274 +(% style="width:999.294px" %)
275 +|**Name**|**Type**|(% style="width:622px" %)**Documentation**
276 +|com:Annotations|com:AnnotationsType|(% style="width:622px" %)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 my reference it.
277 +|DataProvider|com: DataProviderReferenceType|(% style="width:622px" %)DataProvider contains a reference to the provider for the data set.
278 +|Attributes|ValuesType|(% style="width:622px" %)Attributes contains the collection of attribute values for attributes defined in the data structure definition which do not have an attribute relationship with any other data structure definition components.
279 +|Group|GroupType|(% style="width:622px" %)Group contains a references 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.
280 +|Series|TimeSeriesType|(% style="width:622px" %)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 time dimension. In addition to the key and observations, the series contains values for 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 time dimension.
250 250  
251 251  **TimeSeriesType: **TimeSeriesType defines a structure which is used to group a collection of observations which have a key in common, organised by time. The key for a series is every dimension defined in the data structure definition, save the time dimension. In addition to observations, values can be provided for 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 an relationship with the time dimension). It is possible for the series to contain only observations or only attribute values, or both.
252 252  
... ... @@ -257,15 +257,17 @@
257 257  *** TimeSeriesType
258 258  
259 259  Content:
291 +
260 260  com:Annotations?, SeriesKey, Attributes?, Obs*
261 261  
262 262  Element Documentation:
263 263  
264 -|**Name**|**Type**|**Documentation**
265 -|com:Annotations|com: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 my reference it.
266 -|SeriesKey|ValuesType|SeriesKey contains the values for each all dimensions defined in the data structure definition, except for that which is declared to be at the observation level for this data set. This key is required, and every dimension must be provided a value.
267 -|Attributes|ValuesType|Attributes contains the values for attributes which are associated with the dimensions which make up the series key, so long as the attributes do not also specify an attachment group or have a relationship with the observation dimension.
268 -|Obs|TimeSeriesObsType|Obs contains an observation which shares the dimensionality of the series key. These observations are disambiguated from one another within this series by a time value.
296 +(% style="width:1012.29px" %)
297 +|**Name**|**Type**|(% style="width:695px" %)**Documentation**
298 +|com:Annotations|com:AnnotationsType|(% style="width:695px" %)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 my reference it.
299 +|SeriesKey|ValuesType|(% style="width:695px" %)SeriesKey contains the values for each all dimensions defined in the data structure definition, except for that which is declared to be at the observation level for this data set. This key is required, and every dimension must be provided a value.
300 +|Attributes|ValuesType|(% style="width:695px" %)Attributes contains the values for attributes which are associated with the dimensions which make up the series key, so long as the attributes do not also specify an attachment group or have a relationship with the observation dimension.
301 +|Obs|TimeSeriesObsType|(% style="width:695px" %)Obs contains an observation which shares the dimensionality of the series key. These observations are disambiguated from one another within this series by a time value.
269 269  
270 270  **TimeSeriesObsType: **TimeSeriesObsType defines the structure of a time series observation. The observation must be provided a value for the time dimension. This time value should disambiguate the observation within the series in which it is defined (i.e. there should not be another observation with the same time value). The observation can contain an observed value and/or attribute values.
271 271  
... ... @@ -276,15 +276,17 @@
276 276  *** TimeSeriesObsType
277 277  
278 278  Content:
312 +
279 279  com:Annotations?, ObsDimension, ObsValue?, Attributes?
280 280  
281 281  Element Documentation:
282 282  
283 -|**Name**|**Type**|**Documentation**
284 -|com:Annotations|com: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 my reference it.
285 -|ObsDimension|TimeValueType|ObsDimension holds the key for the grouped observation, i.e. the value of the observation dimension. Note that in this element, the reference to the dimension is optional, since it can be inferred from the structure specification for the data set. This saves having to repeat the value unnecessarily. It is assumed that any application processing the data set will have the information from the structure specification available, so that if a dimension identifier is not supplied here, the proper reference can be applied.
286 -|ObsValue|ObsValueType|ObsValue type contains the value for the observation.
287 -|Attributes|ValuesType|Attributes contains the set of values reported for the attributes which have an association with the primary measure or the time dimension (so long as an attachment group is not also specified).
317 +(% style="width:1019.29px" %)
318 +|**Name**|**Type**|(% style="width:709px" %)**Documentation**
319 +|com:Annotations|com:AnnotationsType|(% style="width:709px" %)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 my reference it.
320 +|ObsDimension|TimeValueType|(% style="width:709px" %)ObsDimension holds the key for the grouped observation, i.e. the value of the observation dimension. Note that in this element, the reference to the dimension is optional, since it can be inferred from the structure specification for the data set. This saves having to repeat the value unnecessarily. It is assumed that any application processing the data set will have the information from the structure specification available, so that if a dimension identifier is not supplied here, the proper reference can be applied.
321 +|ObsValue|ObsValueType|(% style="width:709px" %)ObsValue type contains the value for the observation.
322 +|Attributes|ValuesType|(% style="width:709px" %)Attributes contains the set of values reported for the attributes which have an association with the primary measure or the time dimension (so long as an attachment group is not also specified).
288 288  
289 289  **TimeValueType: **TimeValueType is a derivation of the BaseValueType which is used to provide a value for the time dimension. Since the identifier for the time dimension is fixed, the component reference for this structure is fixed. Note that this means that it is not necessary to provide a value in an instance as the fixed value will be provided in the post validation information set.
290 290  
... ... @@ -294,72 +294,80 @@
294 294  ** TimeValueType
295 295  
296 296  Attributes:
332 +
297 297  id?, value
298 298  
299 299  Content:
336 +
300 300  {Empty}
301 301  
302 302  Attribute Documentation:
303 303  
304 -|**Name**|**Type**|**Documentation**
305 -|id (fixed: TIME_PERIOD)|com:NCNameIDType|The id attribute contains the identifier for the component for which a value is being provided.
306 -|value|com: ObservationalTimePer iodType|The value attribute contains the provided component value.
341 +(% style="width:1013.29px" %)
342 +|(% style="width:205px" %)**Name**|(% style="width:277px" %)**Type**|(% style="width:528px" %)**Documentation**
343 +|(% style="width:205px" %)id (fixed: TIME_PERIOD)|(% style="width:277px" %)com:NCNameIDType|(% style="width:528px" %)The id attribute contains the identifier for the component for which a value is being provided.
344 +|(% style="width:205px" %)value|(% style="width:277px" %)com: ObservationalTimePer iodType|(% style="width:528px" %)The value attribute contains the provided component value.
307 307  
308 308  == 2.2 Structure Specific Data Namespace ==
309 309  
310 310  **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/data/structurespecific**
311 311  
312 -=== Summary ===
350 +=== 2.2.1 Summary ===
313 313  
314 314  Referenced Namespaces:
315 315  
316 -|**Namespace**|**Prefix**
317 -| |
318 -|http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|com
319 -|http:~/~/www.w3.org/2001/XMLSchema|xs
354 +(% style="width:1027.29px" %)
355 +|(% style="width:475px" %)**Namespace**|(% style="width:549px" %)**Prefix**
356 +|(% style="width:475px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|(% style="width:549px" %)com
357 +|(% style="width:475px" %)http:~/~/www.w3.org/2001/XMLSchema|(% style="width:549px" %)xs
320 320  
321 321  Contents:
360 +
322 322  7 Complex Types
323 323  1 Simple Type
324 324  
325 -=== Complex Types ===
364 +=== 2.2.2 Complex Types ===
326 326  
327 327  **//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 and whether explicit measures should be used). 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 (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, and observation 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. The data set can contain values for attributes which do not have an attribute relationship with any data structure definition components. These attribute values will exist in XML attributes in this element based on this type (DataSet). This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived data set 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). To allow for generic processing, it is required that the only unqualified XML attributes in the derived data set type (outside of the standard data set attributes) be for 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 attribute.
328 328  
329 329  Derivation:
330 330  
331 -* //com:AnnotableType// (extension) 
370 +* //com:AnnotableType// (extension)
332 332  ** //DataSetType//
333 333  
334 334  Attributes:
374 +
335 335  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?, dataScope, REPORTING_YEAR_START_DAY?
336 336  
337 337  Content:
378 +
338 338  com:Annotations?, DataProvider?, Group*, (Series+ | Obs+)?
339 339  
340 340  Attribute Documentation:
341 341  
342 -|**Name**|**Type**|**Documentation**
343 -|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).
344 -|setID|com:IDType|The setID provides an identification of the data or metadata set.
345 -|action|com:ActionType|The action attribute indicates whether the file is appending, replacing, or deleting.
346 -|reportingBeginDate|com: BasicTimePeriodType|The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set.
347 -|reportingEndDate|com: BasicTimePeriodType|The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.
348 -|validFromDate|xs:dateTime|The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set.
349 -|validToDate|xs:dateTime|The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set.
350 -|publicationYear|xs:gYear|The publicationYear holds the ISO 8601 four-digit year.
351 -|publicationPeriod|com: ObservationalTimePer iodType|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).
352 -|dataScope|DataScopeType|The dataScope attribute indicates the scope at which the data is meant to be validated. These scopes are hierarchical and are (from the top down); DataStructure, ConstrainedDataStructure, Dataflow, and ProvisionAgreement. the hierarchy of these scopes represent the cascading level of constraints, which can restrict the valid values for components. For example, a data structure defines a dimension with a coded representation. A data flow might have a constraint associated with it which further restricts the values allowed from the referenced code list to a subset of the values allowed by the data structure definition. A provision agreement that is based on the dataflow might also have a constraint, which further restricts the subset of the codelist from the dataflow. Therefore, the allowed content becomes stricter lower in the hierarchy. Data that is given a scope of one value is stated to be valid at that level and all levels below it. Therefore, this scope serves to state that data that is meant to be structured simply against the data structure definition is not meant to be validated against the a dataflow, where constraints might be applied.
353 -|REPORTING_YEAR_START_DAY|xs:gMonthDay|The REPORTING_YEAR_START_DAY attribute is an explict attribute for the reporting year start day, which provides context to the time dimension when its value contains a reporting period (e.g. 2010-Q1). This attribute is used to state the month and day that the reporting year begins (e.g. ~-~-07-01 for July 1st). In the absence of an explicit value provided in this attribute, all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and representation. The derived data set type may either require or prohibit this attribute, depending on whether the data structure declared the reporting year start day attribute and if so, the attribute relationship and assignment status assigned to it.
383 +(% style="width:1005.29px" %)
384 +|(% style="width:199px" %)**Name**|(% style="width:216px" %)**Type**|(% style="width:521px" %)**Documentation**
385 +|(% style="width:199px" %)structureRef|(% style="width:216px" %)xs:IDREF|(% style="width:521px" %)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).
386 +|(% style="width:199px" %)setID|(% style="width:216px" %)com:IDType|(% style="width:521px" %)The setID provides an identification of the data or metadata set.
387 +|(% style="width:199px" %)action|(% style="width:216px" %)com:ActionType|(% style="width:521px" %)The action attribute indicates whether the file is appending, replacing, or deleting.
388 +|(% style="width:199px" %)reportingBeginDate|(% style="width:216px" %)com: BasicTimePeriodType|(% style="width:521px" %)The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set.
389 +|(% style="width:199px" %)reportingEndDate|(% style="width:216px" %)com: BasicTimePeriodType|(% style="width:521px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.
390 +|(% style="width:199px" %)validFromDate|(% style="width:216px" %)xs:dateTime|(% style="width:521px" %)The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set.
391 +|(% style="width:199px" %)validToDate|(% style="width:216px" %)xs:dateTime|(% style="width:521px" %)The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set.
392 +|(% style="width:199px" %)publicationYear|(% style="width:216px" %)xs:gYear|(% style="width:521px" %)The publicationYear holds the ISO 8601 four-digit year.
393 +|(% style="width:199px" %)publicationPeriod|(% style="width:216px" %)com: ObservationalTimePeriodType|(% style="width:521px" %)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).
394 +|(% style="width:199px" %)dataScope|(% style="width:216px" %)DataScopeType|(% style="width:521px" %)The dataScope attribute indicates the scope at which the data is meant to be validated. These scopes are hierarchical and are (from the top down); DataStructure, ConstrainedDataStructure, Dataflow, and ProvisionAgreement. the hierarchy of these scopes represent the cascading level of constraints, which can restrict the valid values for components. For example, a data structure defines a dimension with a coded representation. A data flow might have a constraint associated with it which further restricts the values allowed from the referenced code list to a subset of the values allowed by the data structure definition. A provision agreement that is based on the dataflow might also have a constraint, which further restricts the subset of the codelist from the dataflow. Therefore, the allowed content becomes stricter lower in the hierarchy. Data that is given a scope of one value is stated to be valid at that level and all levels below it. Therefore, this scope serves to state that data that is meant to be structured simply against the data structure definition is not meant to be validated against the a dataflow, where constraints might be applied.
395 +|(% style="width:199px" %)REPORTING_YEAR_START_DAY|(% style="width:216px" %)xs:gMonthDay|(% style="width:521px" %)The REPORTING_YEAR_START_DAY attribute is an explict attribute for the reporting year start day, which provides context to the time dimension when its value contains a reporting period (e.g. 2010-Q1). This attribute is used to state the month and day that the reporting year begins (e.g. ~-~-07-01 for July 1st). In the absence of an explicit value provided in this attribute, all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and representation. The derived data set type may either require or prohibit this attribute, depending on whether the data structure declared the reporting year start day attribute and if so, the attribute relationship and assignment status assigned to it.
354 354  
355 355  Element Documentation:
356 356  
357 -|**Name**|**Type**|**Documentation**
358 -|com:Annotations|com: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 my reference it.
359 -|DataProvider|com: DataProviderReferenc eType|DataProvider contains a reference to the provider for the data set.
360 -|Group|//GroupType//|Group contains a references 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.
361 -|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 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.
362 -|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 attributes which have an association with the primary measure or any dimension (so long as it does not specify a group attachment).
399 +(% style="width:1005.29px" %)
400 +|**Name**|**Type**|(% style="width:630px" %)**Documentation**
401 +|com:Annotations|com:AnnotationsType|(% style="width:630px" %)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 my reference it.
402 +|DataProvider|com: DataProviderReferenceType|(% style="width:630px" %)DataProvider contains a reference to the provider for the data set.
403 +|Group|//GroupType//|(% style="width:630px" %)Group contains a references 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.
404 +|Series|//SeriesType//|(% style="width:630px" %)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 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.
405 +|Obs|//ObsType//|(% style="width:630px" %)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 attributes which have an association with the primary measure or any dimension (so long as it does not specify a group attachment).
363 363  
364 364  **//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 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.
365 365  
... ... @@ -369,16 +369,19 @@
369 369  ** //GroupType//
370 370  
371 371  Attributes:
415 +
372 372  type?, REPORTING_YEAR_START_DAY?
373 373  
374 374  Content:
419 +
375 375  com:Annotations?
376 376  
377 377  Attribute Documentation:
378 378  
379 -|**Name**|**Type**|**Documentation**
380 -|type|com: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.
381 -|REPORTING_YEAR_START_DAY|xs:gMonthDay|The REPORTING_YEAR_START_DAY attribute is an explict attribute for the reporting year start day, which provides context to the time dimension when its value contains a reporting period (e.g. 2010-Q1). This attribute is used to state the month and day that the reporting year begins (e.g. ~-~-07-01 for July 1st). In the absence of an explicit value provided in this attribute, all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and representation. The derived group types may either require or prohibit this attribute, depending on whether the data structure declared the reporting year start day attribute and if so, the attribute relationship and assignment status assigned to it.
424 +(% style="width:1008.29px" %)
425 +|**Name**|**Type**|(% style="width:621px" %)**Documentation**
426 +|type|com:IDType|(% style="width:621px" %)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.
427 +|REPORTING_YEAR_START_DAY|xs:gMonthDay|(% style="width:621px" %)The REPORTING_YEAR_START_DAY attribute is an explict attribute for the reporting year start day, which provides context to the time dimension when its value contains a reporting period (e.g. 2010-Q1). This attribute is used to state the month and day that the reporting year begins (e.g. ~-~-07-01 for July 1st). In the absence of an explicit value provided in this attribute, all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and representation. The derived group types may either require or prohibit this attribute, depending on whether the data structure declared the reporting year start day attribute and if so, the attribute relationship and assignment status assigned to it.
382 382  
383 383  Element Documentation:
384 384  
... ... @@ -393,16 +393,19 @@
393 393  ** //SeriesType//
394 394  
395 395  Attributes:
442 +
396 396  TIME_PERIOD?, REPORTING_YEAR_START_DAY?
397 397  
398 398  Content:
446 +
399 399  com:Annotations?, Obs*
400 400  
401 401  Attribute Documentation:
402 402  
403 -|**Name**|**Type**|**Documentation**
404 -|TIME_PERIOD|com: ObservationalTimePer iodType|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.
405 -|REPORTING_YEAR_START_DAY|xs:gMonthDay|The REPORTING_YEAR_START_DAY attribute is an explict attribute for the reporting year start day, which provides context to the time dimension when its value contains a reporting period (e.g. 2010-Q1). This attribute is used to state the month and day that the reporting year begins (e.g. ~-~-07-01 for July 1st). In the absence of an explicit value provided in this attribute, all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and representation. The derived series type may either require or prohibit this attribute, depending on whether the data structure declared the reporting year start day attribute and if so, the attribute relationship and assignment status assigned to it.
451 +(% style="width:1002.29px" %)
452 +|**Name**|**Type**|(% style="width:533px" %)**Documentation**
453 +|TIME_PERIOD|com: ObservationalTimePer iodType|(% style="width:533px" %)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.
454 +|REPORTING_YEAR_START_DAY|xs:gMonthDay|(% style="width:533px" %)The REPORTING_YEAR_START_DAY attribute is an explict attribute for the reporting year start day, which provides context to the time dimension when its value contains a reporting period (e.g. 2010-Q1). This attribute is used to state the month and day that the reporting year begins (e.g. ~-~-07-01 for July 1st). In the absence of an explicit value provided in this attribute, all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and representation. The derived series type may either require or prohibit this attribute, depending on whether the data structure declared the reporting year start day attribute and if so, the attribute relationship and assignment status assigned to it.
406 406  
407 407  Element Documentation:
408 408  
... ... @@ -418,18 +418,21 @@
418 418  ** //ObsType//
419 419  
420 420  Attributes:
470 +
421 421  type?, TIME_PERIOD?, REPORTING_YEAR_START_DAY?, OBS_VALUE?
422 422  
423 423  Content:
474 +
424 424  com:Annotations?
425 425  
426 426  Attribute Documentation:
427 427  
428 -|**Name**|**Type**|**Documentation**
429 -|type|com: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.
430 -|TIME_PERIOD|com: ObservationalTimePer iodType|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.
431 -|REPORTING_YEAR_START_DAY|xs:gMonthDay|The REPORTING_YEAR_START_DAY attribute is an explict attribute for the reporting year start day, which provides context to the time dimension when its value contains a reporting period (e.g. 2010-Q1). This attribute is used to state the month and day that the reporting year begins (e.g. ~-~-07-01 for July 1st). In the absence of an explicit value provided in this attribute, all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and representation. The derived observation type may either require or prohibit this attribute, depending on whether the data structure declared the reporting year start day attribute and if so, the attribute relationship and assignment status assigned to it.
432 -|OBS_VALUE|xs:anySimpleType|The OBS_VALUE attribute is an explicit attribute for the primary measure, which is intended to hold the value for the observation. This is declared in the base schema since it has a fixed identifier. This attribute is un-typed, since the representation of the observed value can vary widely. Derived types will restrict this to be a type based on the representation of the primary measure. In the case that an explicit measure is used, the derived type for a given measure might further restrict the type of the primary measure to be more specific to the core representation for the measure concept. Note that it is required that in the case of multiple measures being used, that the representation of the primary measure is broad enough to handle the various representations of the measure concepts.
479 +(% style="width:1014.29px" %)
480 +|**Name**|**Type**|(% style="width:505px" %)**Documentation**
481 +|type|com:IDType|(% style="width:505px" %)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.
482 +|TIME_PERIOD|com: ObservationalTimePeriodType|(% style="width:505px" %)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.
483 +|REPORTING_YEAR_START_DAY|xs:gMonthDay|(% style="width:505px" %)The REPORTING_YEAR_START_DAY attribute is an explict attribute for the reporting year start day, which provides context to the time dimension when its value contains a reporting period (e.g. 2010-Q1). This attribute is used to state the month and day that the reporting year begins (e.g. ~-~-07-01 for July 1st). In the absence of an explicit value provided in this attribute, all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and representation. The derived observation type may either require or prohibit this attribute, depending on whether the data structure declared the reporting year start day attribute and if so, the attribute relationship and assignment status assigned to it.
484 +|OBS_VALUE|xs:anySimpleType|(% style="width:505px" %)The OBS_VALUE attribute is an explicit attribute for the primary measure, which is intended to hold the value for the observation. This is declared in the base schema since it has a fixed identifier. This attribute is un-typed, since the representation of the observed value can vary widely. Derived types will restrict this to be a type based on the representation of the primary measure. In the case that an explicit measure is used, the derived type for a given measure might further restrict the type of the primary measure to be more specific to the core representation for the measure concept. Note that it is required that in the case of multiple measures being used, that the representation of the primary measure is broad enough to handle the various representations of the measure concepts.
433 433  
434 434  Element Documentation:
435 435  
... ... @@ -445,33 +445,37 @@
445 445  *** //TimeSeriesDataSetType//
446 446  
447 447  Attributes:
500 +
448 448  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?, dataScope, REPORTING_YEAR_START_DAY?
449 449  
450 450  Content:
504 +
451 451  com:Annotations?, DataProvider?, Group*, Series*
452 452  
453 453  Attribute Documentation:
454 454  
455 -|**Name**|**Type**|**Documentation**
456 -|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).
457 -|setID|com:IDType|The setID provides an identification of the data or metadata set.
458 -|action|com:ActionType|The action attribute indicates whether the file is appending, replacing, or deleting.
459 -|reportingBeginDate|com: BasicTimePeriodType|The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set.
460 -|reportingEndDate|com: BasicTimePeriodType|The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.
461 -|validFromDate|xs:dateTime|The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set.
462 -|validToDate|xs:dateTime|The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set.
463 -|publicationYear|xs:gYear|The publicationYear holds the ISO 8601 four-digit year.
464 -|publicationPeriod|com: ObservationalTimePer iodType|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).
465 -|dataScope|DataScopeType|The dataScope attribute indicates the scope at which the data is meant to be validated. These scopes are hierarchical and are (from the top down); DataStructure, ConstrainedDataStructure, Dataflow, and ProvisionAgreement. the hierarchy of these scopes represent the cascading level of constraints, which can restrict the valid values for components. For example, a data structure defines a dimension with a coded representation. A data flow might have a constraint associated with it which further restricts the values allowed from the referenced code list to a subset of the values allowed by the data structure definition. A provision agreement that is based on the dataflow might also have a constraint, which further restricts the subset of the codelist from the dataflow. Therefore, the allowed content becomes stricter lower in the hierarchy. Data that is given a scope of one value is stated to be valid at that level and all levels below it. Therefore, this scope serves to state that data that is meant to be structured simply against the data structure definition is not meant to be validated against the a dataflow, where constraints might be applied.
466 -|REPORTING_YEAR_START_DAY|xs:gMonthDay|The REPORTING_YEAR_START_DAY attribute is an explict attribute for the reporting year start day, which provides context to the time dimension when its value contains a reporting period (e.g. 2010-Q1). This attribute is used to state the month and day that the reporting year begins (e.g. ~-~-07-01 for July 1st). In the absence of an explicit value provided in this attribute, all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and representation. The derived data set type may either require or prohibit this attribute, depending on whether the data structure declared the reporting year start day attribute and if so, the attribute relationship and assignment status assigned to it.
509 +(% style="width:1003.29px" %)
510 +|(% style="width:213px" %)**Name**|(% style="width:274px" %)**Type**|(% style="width:461px" %)**Documentation**
511 +|(% style="width:213px" %)structureRef|(% style="width:274px" %)xs:IDREF|(% style="width:461px" %)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).
512 +|(% style="width:213px" %)setID|(% style="width:274px" %)com:IDType|(% style="width:461px" %)The setID provides an identification of the data or metadata set.
513 +|(% style="width:213px" %)action|(% style="width:274px" %)com:ActionType|(% style="width:461px" %)The action attribute indicates whether the file is appending, replacing, or deleting.
514 +|(% style="width:213px" %)reportingBeginDate|(% style="width:274px" %)com: BasicTimePeriodType|(% style="width:461px" %)The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set.
515 +|(% style="width:213px" %)reportingEndDate|(% style="width:274px" %)com: BasicTimePeriodType|(% style="width:461px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.
516 +|(% style="width:213px" %)validFromDate|(% style="width:274px" %)xs:dateTime|(% style="width:461px" %)The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set.
517 +|(% style="width:213px" %)validToDate|(% style="width:274px" %)xs:dateTime|(% style="width:461px" %)The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set.
518 +|(% style="width:213px" %)publicationYear|(% style="width:274px" %)xs:gYear|(% style="width:461px" %)The publicationYear holds the ISO 8601 four-digit year.
519 +|(% style="width:213px" %)publicationPeriod|(% style="width:274px" %)com: ObservationalTimePeriodType|(% style="width:461px" %)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).
520 +|(% style="width:213px" %)dataScope|(% style="width:274px" %)DataScopeType|(% style="width:461px" %)The dataScope attribute indicates the scope at which the data is meant to be validated. These scopes are hierarchical and are (from the top down); DataStructure, ConstrainedDataStructure, Dataflow, and ProvisionAgreement. the hierarchy of these scopes represent the cascading level of constraints, which can restrict the valid values for components. For example, a data structure defines a dimension with a coded representation. A data flow might have a constraint associated with it which further restricts the values allowed from the referenced code list to a subset of the values allowed by the data structure definition. A provision agreement that is based on the dataflow might also have a constraint, which further restricts the subset of the codelist from the dataflow. Therefore, the allowed content becomes stricter lower in the hierarchy. Data that is given a scope of one value is stated to be valid at that level and all levels below it. Therefore, this scope serves to state that data that is meant to be structured simply against the data structure definition is not meant to be validated against the a dataflow, where constraints might be applied.
521 +|(% style="width:213px" %)REPORTING_YEAR_START_DAY|(% style="width:274px" %)xs:gMonthDay|(% style="width:461px" %)The REPORTING_YEAR_START_DAY attribute is an explict attribute for the reporting year start day, which provides context to the time dimension when its value contains a reporting period (e.g. 2010-Q1). This attribute is used to state the month and day that the reporting year begins (e.g. ~-~-07-01 for July 1st). In the absence of an explicit value provided in this attribute, all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and representation. The derived data set type may either require or prohibit this attribute, depending on whether the data structure declared the reporting year start day attribute and if so, the attribute relationship and assignment status assigned to it.
467 467  
468 468  Element Documentation:
469 469  
470 -|**Name**|**Type**|**Documentation**
471 -|com:Annotations|com: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 my reference it.
472 -|DataProvider|com: DataProviderReferenc eType|DataProvider contains a reference to the provider for the data set.
473 -|Group|//GroupType//|Group contains a references 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.
474 -|Series|TimeSeriesType|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 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.
525 +(% style="width:1007.29px" %)
526 +|**Name**|**Type**|(% style="width:632px" %)**Documentation**
527 +|com:Annotations|com:AnnotationsType|(% style="width:632px" %)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 my reference it.
528 +|DataProvider|com: DataProviderReferenceType|(% style="width:632px" %)DataProvider contains a reference to the provider for the data set.
529 +|Group|//GroupType//|(% style="width:632px" %)Group contains a references 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.
530 +|Series|TimeSeriesType|(% style="width:632px" %)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 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.
475 475  
476 476  **TimeSeriesType: **TimeSeriesType defines an abstract structure which is used to group a collection of observations which have a key in common, organised by time. The key for a series is every dimension defined in the data structure definition, save the time dimension. In addition to observations, values can be provided for 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 an relationship with the time dimension). It is possible for the series to contain only observations or only attribute values, or both. The same rules for derivation as the base series type apply to this specialized series.
477 477  
... ... @@ -482,21 +482,25 @@
482 482  *** TimeSeriesType
483 483  
484 484  Attributes:
541 +
485 485  REPORTING_YEAR_START_DAY?
486 486  
487 487  Content:
545 +
488 488  com:Annotations?, Obs*
489 489  
490 490  Attribute Documentation:
491 491  
492 -|**Name**|**Type**|**Documentation**
493 -|REPORTING_YEAR_START_DAY|xs:gMonthDay|The REPORTING_YEAR_START_DAY attribute is an explict attribute for the reporting year start day, which provides context to the time dimension when its value contains a reporting period (e.g. 2010-Q1). This attribute is used to state the month and day that the reporting year begins (e.g. ~-~-07-01 for July 1st). In the absence of an explicit value provided in this attribute, all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and representation. The derived series type may either require or prohibit this attribute, depending on whether the data structure declared the reporting year start day attribute and if so, the attribute relationship and assignment status assigned to it.
550 +(% style="width:1004.29px" %)
551 +|**Name**|**Type**|(% style="width:617px" %)**Documentation**
552 +|REPORTING_YEAR_START_DAY|xs:gMonthDay|(% style="width:617px" %)The REPORTING_YEAR_START_DAY attribute is an explict attribute for the reporting year start day, which provides context to the time dimension when its value contains a reporting period (e.g. 2010-Q1). This attribute is used to state the month and day that the reporting year begins (e.g. ~-~-07-01 for July 1st). In the absence of an explicit value provided in this attribute, all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and representation. The derived series type may either require or prohibit this attribute, depending on whether the data structure declared the reporting year start day attribute and if so, the attribute relationship and assignment status assigned to it.
494 494  
495 495  Element Documentation:
496 496  
497 -|**Name**|**Type**|**Documentation**
498 -|com:Annotations|com: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 my reference it.
499 -|Obs|//TimeSeriesObsType//|
556 +(% style="width:1003.29px" %)
557 +|**Name**|**Type**|(% style="width:593px" %)**Documentation**
558 +|com:Annotations|com:AnnotationsType|(% style="width:593px" %)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 my reference it.
559 +|Obs|//TimeSeriesObsType//|(% style="width:593px" %)
500 500  
501 501  **//TimeSeriesObsType//: **TimeSeriesObsType defines the abstract structure of a time series observation. The observation must be provided a value for the time dimension. This time value should disambiguate the observation within the series in which it is defined (i.e. there should not be another observation with the same time value). The observation can contain an observed value and/or attribute values. The same rules for derivation as the base observation type apply to this specialized observation.
502 502  
... ... @@ -507,24 +507,28 @@
507 507  *** //TimeSeriesObsType//
508 508  
509 509  Attributes:
570 +
510 510  TIME_PERIOD, REPORTING_YEAR_START_DAY?, OBS_VALUE?
511 511  
512 512  Content:
574 +
513 513  com:Annotations?
514 514  
515 515  Attribute Documentation:
516 516  
517 -|**Name**|**Type**|**Documentation**
518 -|TIME_PERIOD|com: ObservationalTimePer iodType|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. Since this data is structured to be time series only, this attribute is always required. If the time dimension specifies a more specific representation of time the derived type will restrict the type definition to the appropriate type.
519 -|REPORTING_YEAR_START_DAY|xs:gMonthDay|The REPORTING_YEAR_START_DAY attribute is an explict attribute for the reporting year start day, which provides context to the time dimension when its value contains a reporting period (e.g. 2010-Q1). This attribute is used to state the month and day that the reporting year begins (e.g. ~-~-07-01 for July 1st). In the absence of an explicit value provided in this attribute, all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and representation. The derived observation type may either require or prohibit this attribute, depending on whether the data structure declared the reporting year start day attribute and if so, the attribute relationship and assignment status assigned to it.
520 -|OBS_VALUE|xs:anySimpleType|The OBS_VALUE attribute is an explicit attribute for the primary measure, which is intended to hold the value for the observation. This is declared in the base schema since it has a fixed identifier. This attribute is un-typed, since the representation of the observed value can vary widely. Derived types will restrict this to be a type based on the representation of the primary measure. In the case that an explicit measure is used, the derived type for a given measure might further restrict the type of the primary measure to be more specific to the core representation for the measure concept. Note that it is required that in the case of multiple measures being used, that the representation of the primary measure is broad enough to handle the various representations of the measure concepts.
579 +(% style="width:1005.29px" %)
580 +|**Name**|**Type**|(% style="width:496px" %)**Documentation**
581 +|TIME_PERIOD|com: ObservationalTimePeriodType|(% style="width:496px" %)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. Since this data is structured to be time series only, this attribute is always required. If the time dimension specifies a more specific representation of time the derived type will restrict the type definition to the appropriate type.
582 +|REPORTING_YEAR_START_DAY|xs:gMonthDay|(% style="width:496px" %)The REPORTING_YEAR_START_DAY attribute is an explict attribute for the reporting year start day, which provides context to the time dimension when its value contains a reporting period (e.g. 2010-Q1). This attribute is used to state the month and day that the reporting year begins (e.g. ~-~-07-01 for July 1st). In the absence of an explicit value provided in this attribute, all reporting period values will be assumed to be based on a reporting year start day of January 1. This is declared in the base schema since it has a fixed identifier and representation. The derived observation type may either require or prohibit this attribute, depending on whether the data structure declared the reporting year start day attribute and if so, the attribute relationship and assignment status assigned to it.
583 +|OBS_VALUE|xs:anySimpleType|(% style="width:496px" %)The OBS_VALUE attribute is an explicit attribute for the primary measure, which is intended to hold the value for the observation. This is declared in the base schema since it has a fixed identifier. This attribute is un-typed, since the representation of the observed value can vary widely. Derived types will restrict this to be a type based on the representation of the primary measure. In the case that an explicit measure is used, the derived type for a given measure might further restrict the type of the primary measure to be more specific to the core representation for the measure concept. Note that it is required that in the case of multiple measures being used, that the representation of the primary measure is broad enough to handle the various representations of the measure concepts.
521 521  
522 522  Element Documentation:
523 523  
524 -|**Name**|**Type**|**Documentation**
525 -|com:Annotations|com: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 my reference it.
587 +(% style="width:1013.29px" %)
588 +|**Name**|**Type**|(% style="width:603px" %)**Documentation**
589 +|com:Annotations|com:AnnotationsType|(% style="width:603px" %)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 my reference it.
526 526  
527 -=== Simple Types ===
591 +=== 2.2.3 Simple Types ===
528 528  
529 529  **DataScopeType: **DataScopeType is an enumeration of the possible validity scopes for a data set. These scopes indicate the level at which the data is stated to be valid.
530 530  
... ... @@ -532,28 +532,31 @@
532 532  
533 533  Enumerations:
534 534  
535 -|**Value**|**Documentation**
536 -|DataStructure|The data set conforms simply to the data structure definition as it is defined, without regard to any constraints.
537 -|ConstrainedDataStructure|The data set conforms to the known allowable content constraints applied to the data structure definition.
538 -|Dataflow|The data set conforms to the known allowable content constraints applied to the dataflow.
539 -|ProvisionAgreement|The data set conforms to the known allowable content constraints applied to the provision agreement.
599 +(% style="width:1020.29px" %)
600 +|(% style="width:208px" %)**Value**|(% style="width:809px" %)**Documentation**
601 +|(% style="width:208px" %)DataStructure|(% style="width:809px" %)The data set conforms simply to the data structure definition as it is defined, without regard to any constraints.
602 +|(% style="width:208px" %)ConstrainedDataStructure|(% style="width:809px" %)The data set conforms to the known allowable content constraints applied to the data structure definition.
603 +|(% style="width:208px" %)Dataflow|(% style="width:809px" %)The data set conforms to the known allowable content constraints applied to the dataflow.
604 +|(% style="width:208px" %)ProvisionAgreement|(% style="width:809px" %)The data set conforms to the known allowable content constraints applied to the provision agreement.
540 540  
541 -== Generic Metadata Namespace ==
606 +== 2.3 Generic Metadata Namespace ==
542 542  
543 543  **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/metadata/generic**
544 544  
545 -=== Summary ===
610 +=== 2.3.1 Summary ===
546 546  
547 547  Referenced Namespaces:
548 548  
549 -|**Namespace**|**Prefix**
550 -|http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|com
551 -|http:~/~/www.w3.org/2001/XMLSchema|xs
614 +(% style="width:694.294px" %)
615 +|(% style="width:492px" %)**Namespace**|(% style="width:199px" %)**Prefix**
616 +|(% style="width:492px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|(% style="width:199px" %)com
617 +|(% style="width:492px" %)http:~/~/www.w3.org/2001/XMLSchema|(% style="width:199px" %)xs
552 552  
553 553  Contents:
620 +
554 554  6 Complex Types
555 555  
556 -=== Complex Types ===
623 +=== 2.3.2 Complex Types ===
557 557  
558 558  **MetadataSetType: **MetadataSetType describes the structure for a metadata set, which contains a collection of reported metadata against a set of values for a given full or partial target identifier, as described in a metadata structure definition. The metadata set may contain reported metadata for multiple report structures defined in a metadata structure definition.
559 559  
... ... @@ -563,31 +563,35 @@
563 563  ** MetadataSetType
564 564  
565 565  Attributes:
633 +
566 566  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?
567 567  
568 568  Content:
637 +
569 569  com:Annotations?, com:Name*, DataProvider?, Report+
570 570  
571 571  Attribute Documentation:
572 572  
573 -|**Name**|**Type**|**Documentation**
574 -|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).
575 -|setID|com:IDType|The setID provides an identification of the data or metadata set.
576 -|action|com:ActionType|The action attribute indicates whether the file is appending, replacing, or deleting.
577 -|reportingBeginDate|com: BasicTimePeriodType|The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set.
578 -|reportingEndDate|com: BasicTimePeriodType|The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.
579 -|validFromDate|xs:dateTime|The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set.
580 -|validToDate|xs:dateTime|The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set.
581 -|publicationYear|xs:gYear|The publicationYear holds the ISO 8601 four-digit year.
582 -|publicationPeriod|com: ObservationalTimePer iodType|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).
642 +(% style="width:1006.29px" %)
643 +|**Name**|**Type**|(% style="width:592px" %)**Documentation**
644 +|structureRef|xs:IDREF|(% style="width:592px" %)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).
645 +|setID|com:IDType|(% style="width:592px" %)The setID provides an identification of the data or metadata set.
646 +|action|com:ActionType|(% style="width:592px" %)The action attribute indicates whether the file is appending, replacing, or deleting.
647 +|reportingBeginDate|com: BasicTimePeriodType|(% style="width:592px" %)The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set.
648 +|reportingEndDate|com: BasicTimePeriodType|(% style="width:592px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.
649 +|validFromDate|xs:dateTime|(% style="width:592px" %)The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set.
650 +|validToDate|xs:dateTime|(% style="width:592px" %)The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set.
651 +|publicationYear|xs:gYear|(% style="width:592px" %)The publicationYear holds the ISO 8601 four-digit year.
652 +|publicationPeriod|com: ObservationalTimePeriodType|(% style="width:592px" %)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).
583 583  
584 584  Element Documentation:
585 585  
586 -|**Name**|**Type**|**Documentation**
587 -|com:Annotations|com: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 my reference it.
588 -|com:Name|com:TextType|Name is a reusable element, used for providing a human-readable name for an object.
589 -|DataProvider|com: DataProviderReferenc eType|DataProviderReference provides a references to an organisation with the role of data provider that is providing this metadata set.
590 -|Report|ReportType|Report contains the details of a the reported metadata, including the identification of the target and the report attributes.
656 +(% style="width:1006.29px" %)
657 +|**Name**|(% style="width:268px" %)**Type**|(% style="width:562px" %)**Documentation**
658 +|com:Annotations|(% style="width:268px" %)com:AnnotationsType|(% style="width:562px" %)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 my reference it.
659 +|com:Name|(% style="width:268px" %)com:TextType|(% style="width:562px" %)Name is a reusable element, used for providing a human-readable name for an object.
660 +|DataProvider|(% style="width:268px" %)com: DataProviderReferenceType|(% style="width:562px" %)DataProviderReference provides a references to an organisation with the role of data provider that is providing this metadata set.
661 +|Report|(% style="width:268px" %)ReportType|(% style="width:562px" %)Report contains the details of a the reported metadata, including the identification of the target and the report attributes.
591 591  
592 592  **ReportType: **ReportType contains a set of report attributes and identifies a target objects] to which they apply.
593 593  
... ... @@ -597,72 +597,86 @@
597 597  ** ReportType
598 598  
599 599  Attributes:
671 +
600 600  id
601 601  
602 602  Content:
675 +
603 603  com:Annotations?, Target, AttributeSet
604 604  
605 605  Attribute Documentation:
606 606  
607 -|**Name**|**Type**|**Documentation**
608 -|id|com:IDType|The id attribute holds the identifier of the report structure as defined in the metadata structure definition. This identifies the report structure which defines the structure of metadata that is being reported.
680 +(% style="width:1003.29px" %)
681 +|**Name**|**Type**|(% style="width:788px" %)**Documentation**
682 +|id|com:IDType|(% style="width:788px" %)The id attribute holds the identifier of the report structure as defined in the metadata structure definition. This identifies the report structure which defines the structure of metadata that is being reported.
609 609  
610 610  Element Documentation:
611 611  
612 -|**Name**|**Type**|**Documentation**
613 -|com:Annotations|com: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 my reference it.
614 -|Target|TargetType|Target contains a set of target reference values which when taken together, identify the object or objects to which the reported metadata apply.
615 -|AttributeSet|AttributeSetType|AttributeSet contains the reported metadata attribute values for the reported metadata.
686 +(% style="width:1003.29px" %)
687 +|**Name**|**Type**|(% style="width:593px" %)**Documentation**
688 +|com:Annotations|com:AnnotationsType|(% style="width:593px" %)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 my reference it.
689 +|Target|TargetType|(% style="width:593px" %)Target contains a set of target reference values which when taken together, identify the object or objects to which the reported metadata apply.
690 +|AttributeSet|AttributeSetType|(% style="width:593px" %)AttributeSet contains the reported metadata attribute values for the reported metadata.
616 616  
617 617  **TargetType: **TargetType defines the structure of a target. It contains a set of target reference values which when taken together, identify the object or objects to which the reported metadata apply.
618 618  
619 619  Attributes:
695 +
620 620  id
621 621  
622 622  Content:
699 +
623 623  ReferenceValue+
624 624  
625 625  Attribute Documentation:
626 626  
627 -|**Name**|**Type**|**Documentation**
628 -|id|com:IDType|The id attribute holds the identifier of the metadata target as defined in the metadata structure definition. This identifies the metadata target of the report structure that identifies the target object(s) of the reported metadata.
704 +(% style="width:1003.29px" %)
705 +|**Name**|**Type**|(% style="width:805px" %)**Documentation**
706 +|id|com:IDType|(% style="width:805px" %)The id attribute holds the identifier of the metadata target as defined in the metadata structure definition. This identifies the metadata target of the report structure that identifies the target object(s) of the reported metadata.
629 629  
630 630  Element Documentation:
631 631  
632 -|**Name**|**Type**|**Documentation**
633 -|ReferenceValue|ReferenceValueType|ReferenceValue contains a value for a target reference object reference. When this is taken with its sibling elements, they identify the object or objects to which the reported metadata apply. The content of this will either be a reference to an identifiable object, a data key, a reference to a data set, or a report period.
710 +(% style="width:1009.29px" %)
711 +|**Name**|**Type**|(% style="width:710px" %)**Documentation**
712 +|ReferenceValue|ReferenceValueType|(% style="width:710px" %)ReferenceValue contains a value for a target reference object reference. When this is taken with its sibling elements, they identify the object or objects to which the reported metadata apply. The content of this will either be a reference to an identifiable object, a data key, a reference to a data set, or a report period.
634 634  
635 635  **ReferenceValueType: **ReferenceValueType defines the structure of a target object reference value. A target reference value will either be a reference to an identifiable object, a data key, a reference to a data set, or a report period.
636 636  
637 637  Attributes:
717 +
638 638  id
639 639  
640 640  Content:
721 +
641 641  (ObjectReference | DataKey | DataSetReference | ConstraintContentReference | ReportPeriod)
642 642  
643 643  Attribute Documentation:
644 644  
645 -|**Name**|**Type**|**Documentation**
646 -|id|com:IDType|The id attribute holds the identifier of the target reference object as defined in the metadata structure definition. This identifies the target reference of the metadata target that identifes one of the target references, that when taken together, identify the target of the reported metadata.
726 +(% style="width:1013.29px" %)
727 +|**Name**|**Type**|(% style="width:847px" %)**Documentation**
728 +|id|com:IDType|(% style="width:847px" %)The id attribute holds the identifier of the target reference object as defined in the metadata structure definition. This identifies the target reference of the metadata target that identifes one of the target references, that when taken together, identify the target of the reported metadata.
647 647  
648 648  Element Documentation:
649 649  
650 -|**Name**|**Type**|**Documentation**
651 -|ObjectReference|com: ObjectReferenceType|ObjectReference provides a reference to an identifiable object in the SDMX information model. An identifiable object target will utilize this option as the representation of the target reference value.
652 -|DataKey|com:DataKeyType|ObjectReference provides a set of dimension references and values for those dimension for the purpose of reporting metadata against a set of data. A key descriptor values target will utilize this option as the representation of the target reference value.
653 -|DataSetReference|com:SetReferenceType|DataSetReference provides a reference to a data set for the purpose of reporting metadata against the data. A data set target will utilize this option as the representation of the target reference value.
654 -|ConstraintContentRef erence|com: AttachmentConstraint ReferenceType|ConstraintContentReference provides a reference to an attachment constraint for the purpose of reporting metadata against the data identified in the key sets and/or cube regions identified by the constraint. A constraint target will utilize this option as the representation of the target reference value.
655 -|ReportPeriod|com: ObservationalTimePer iodType|ReportPeriod provides a report period for the purpose of qualifying the target reporting period of reported metadata. A report period target will utilize this option as the representation of the target reference value.
732 +(% style="width:1017.29px" %)
733 +|**Name**|**Type**|(% style="width:522px" %)**Documentation**
734 +|ObjectReference|com: ObjectReferenceType|(% style="width:522px" %)ObjectReference provides a reference to an identifiable object in the SDMX information model. An identifiable object target will utilize this option as the representation of the target reference value.
735 +|DataKey|com:DataKeyType|(% style="width:522px" %)ObjectReference provides a set of dimension references and values for those dimension for the purpose of reporting metadata against a set of data. A key descriptor values target will utilize this option as the representation of the target reference value.
736 +|DataSetReference|com:SetReferenceType|(% style="width:522px" %)DataSetReference provides a reference to a data set for the purpose of reporting metadata against the data. A data set target will utilize this option as the representation of the target reference value.
737 +|ConstraintContentRef erence|com: AttachmentConstraint ReferenceType|(% style="width:522px" %)ConstraintContentReference provides a reference to an attachment constraint for the purpose of reporting metadata against the data identified in the key sets and/or cube regions identified by the constraint. A constraint target will utilize this option as the representation of the target reference value.
738 +|ReportPeriod|com: ObservationalTimePer iodType|(% style="width:522px" %)ReportPeriod provides a report period for the purpose of qualifying the target reporting period of reported metadata. A report period target will utilize this option as the representation of the target reference value.
656 656  
657 657  **AttributeSetType: **AttributeSetType defines the structure for a collection of reported metadata attributes.
658 658  
659 659  Content:
743 +
660 660  ReportedAttribute+
661 661  
662 662  Element Documentation:
663 663  
664 -|**Name**|**Type**|**Documentation**
665 -|ReportedAttribute|ReportedAttributeTyp e|ReportedAttribute provides the details of a reported attribute, including a value and/or child reported attributes.
748 +(% style="width:1023.29px" %)
749 +|(% style="width:150px" %)**Name**|(% style="width:202px" %)**Type**|(% style="width:668px" %)**Documentation**
750 +|(% style="width:150px" %)ReportedAttribute|(% style="width:202px" %)ReportedAttributeType|(% style="width:668px" %)ReportedAttribute provides the details of a reported attribute, including a value and/or child reported attributes.
666 666  
667 667  **ReportedAttributeType: **ReportedAttributeType defines the structure for a reported metadata attribute. A value for the attribute can be supplied as either a single value, or multi-lingual text values (either structured or unstructured). An optional set of child metadata attributes is also available if the metadata attribute definition defines nested metadata attributes.
668 668  
... ... @@ -672,42 +672,48 @@
672 672  ** ReportedAttributeType
673 673  
674 674  Attributes:
760 +
675 675  id, value?
676 676  
677 677  Content:
764 +
678 678  com:Annotations?, (com:Text+ | com:StructuredText+)?, AttributeSet?
679 679  
680 680  Attribute Documentation:
681 681  
682 -|**Name**|**Type**|**Documentation**
683 -|id|com:IDType|The id attribute identifies the metadata attribute that the value is being reported for.
684 -|value|xs:string|The value attribute holds any simple value for the metadata attribute.
769 +(% style="width:996.294px" %)
770 +|**Name**|(% style="width:170px" %)**Type**|(% style="width:657px" %)**Documentation**
771 +|id|(% style="width:170px" %)com:IDType|(% style="width:657px" %)The id attribute identifies the metadata attribute that the value is being reported for.
772 +|value|(% style="width:170px" %)xs:string|(% style="width:657px" %)The value attribute holds any simple value for the metadata attribute.
685 685  
686 686  Element Documentation:
687 687  
688 -|**Name**|**Type**|**Documentation**
689 -|com:Annotations|com: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 my reference it.
690 -|com:Text|com: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.
691 -|com:StructuredText|com: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.
692 -|AttributeSet|AttributeSetType|AttributeSet contains the reported metadata attribute values for the child metadata attributes.
776 +(% style="width:999.294px" %)
777 +|**Name**|**Type**|(% style="width:670px" %)**Documentation**
778 +|com:Annotations|com:AnnotationsType|(% style="width:670px" %)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 my reference it.
779 +|com:Text|com:TextType|(% style="width:670px" %)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.
780 +|com:StructuredText|com:XHTMLType|(% style="width:670px" %)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.
781 +|AttributeSet|AttributeSetType|(% style="width:670px" %)AttributeSet contains the reported metadata attribute values for the child metadata attributes.
693 693  
694 -== Structure Specific Metadata Namespace ==
783 +== 2.4 Structure Specific Metadata Namespace ==
695 695  
696 696  **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/metadata/structurespecific**
697 697  
698 -=== Summary ===
787 +=== 2.4.1 Summary ===
699 699  
700 700  Referenced Namespaces:
701 701  
702 -|**Namespace**|**Prefix**
703 -| |
704 -|http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|com
705 -|http:~/~/www.w3.org/2001/XMLSchema|xs
791 +(% style="width:654.294px" %)
792 +|(% style="width:492px" %)**Namespace**|(% style="width:159px" %)**Prefix**
793 +|(% style="width:492px" %) |(% style="width:159px" %)
794 +|(% style="width:492px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|(% style="width:159px" %)com
795 +|(% style="width:492px" %)http:~/~/www.w3.org/2001/XMLSchema|(% style="width:159px" %)xs
706 706  
707 707  Contents:
798 +
708 708  5 Complex Types
709 709  
710 -=== Complex Types ===
801 +=== 2.4.2 Complex Types ===
711 711  
712 712  **//MetadataSetType//: **MetadataSetType is an abstract base type the forms the basis for a metadata structure specific metadata set. It is restricted by the metadata structure definition specific schema to meet its needs.
713 713  
... ... @@ -717,31 +717,35 @@
717 717  ** //MetadataSetType//
718 718  
719 719  Attributes:
811 +
720 720  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?
721 721  
722 722  Content:
815 +
723 723  com:Annotations?, com:Name*, DataProvider?, Report+
724 724  
725 725  Attribute Documentation:
726 726  
727 -|**Name**|**Type**|**Documentation**
728 -|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).
729 -|setID|com:IDType|The setID provides an identification of the data or metadata set.
730 -|action|com:ActionType|The action attribute indicates whether the file is appending, replacing, or deleting.
731 -|reportingBeginDate|com: BasicTimePeriodType|The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set.
732 -|reportingEndDate|com: BasicTimePeriodType|The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.
733 -|validFromDate|xs:dateTime|The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set.
734 -|validToDate|xs:dateTime|The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set.
735 -|publicationYear|xs:gYear|The publicationYear holds the ISO 8601 four-digit year.
736 -|publicationPeriod|com: ObservationalTimePer iodType|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).
820 +(% style="width:1003.29px" %)
821 +|**Name**|**Type**|(% style="width:607px" %)**Documentation**
822 +|structureRef|xs:IDREF|(% style="width:607px" %)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).
823 +|setID|com:IDType|(% style="width:607px" %)The setID provides an identification of the data or metadata set.
824 +|action|com:ActionType|(% style="width:607px" %)The action attribute indicates whether the file is appending, replacing, or deleting.
825 +|reportingBeginDate|com: BasicTimePeriodType|(% style="width:607px" %)The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set.
826 +|reportingEndDate|com: BasicTimePeriodType|(% style="width:607px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.
827 +|validFromDate|xs:dateTime|(% style="width:607px" %)The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set.
828 +|validToDate|xs:dateTime|(% style="width:607px" %)The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set.
829 +|publicationYear|xs:gYear|(% style="width:607px" %)The publicationYear holds the ISO 8601 four-digit year.
830 +|publicationPeriod|com: ObservationalTimePeriodType|(% style="width:607px" %)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).
737 737  
738 738  Element Documentation:
739 739  
740 -|**Name**|**Type**|**Documentation**
741 -|com:Annotations|com: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 my reference it.
742 -|com:Name|com:TextType|Name is a reusable element, used for providing a human-readable name for an object.
743 -|DataProvider|com: DataProviderReferenc eType|>DataProviderReference provides a references to an organisation with the role of data provider that is providing this metadata set.
744 -|Report|//ReportType//|Report contains the details of a the reported metadata, including the identification of the target and the report attributes. This element is unqualified so that the metadata structure definition specific schema can refine the type of the element such that it requires types built according to the metadata structure definition. This allows the metadata structure definition to validate the structure of the reported metadata against the metadata structure definition while still allowing the content to be processed in a generic manner.
834 +(% style="width:1006.29px" %)
835 +|**Name**|**Type**|(% style="width:631px" %)**Documentation**
836 +|com:Annotations|com:AnnotationsType|(% style="width:631px" %)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 my reference it.
837 +|com:Name|com:TextType|(% style="width:631px" %)Name is a reusable element, used for providing a human-readable name for an object.
838 +|DataProvider|com: DataProviderReferenceType|(% style="width:631px" %)>DataProviderReference provides a references to an organisation with the role of data provider that is providing this metadata set.
839 +|Report|//ReportType//|(% style="width:631px" %)Report contains the details of a the reported metadata, including the identification of the target and the report attributes. This element is unqualified so that the metadata structure definition specific schema can refine the type of the element such that it requires types built according to the metadata structure definition. This allows the metadata structure definition to validate the structure of the reported metadata against the metadata structure definition while still allowing the content to be processed in a generic manner.
745 745  
746 746  **//ReportType//: **ReportType is an abstract base type the forms the basis for a metadata structure definition specific report, based on the defined report structures. This type is restricted in the metadata structure definition specific schema so that the Target and AttributeSet conform to the prescribed report structure.
747 747  
... ... @@ -751,62 +751,74 @@
751 751  ** //ReportType//
752 752  
753 753  Attributes:
849 +
754 754  id?
755 755  
756 756  Content:
853 +
757 757  com:Annotations?, Target, AttributeSet
758 758  
759 759  Attribute Documentation:
760 760  
761 -|**Name**|**Type**|**Documentation**
762 -|id|com:IDType|The id attribute holds the identifier of the report structure as defined in the metadata structure definition. This identifies the report structure which defines the structure of metadata that is being reported. This is optional and not expected to be supplied as the metadata structure definition specific schema will specify a fixed value such that the reference to the report structure will always be available if required for processing.
858 +(% style="width:1003.29px" %)
859 +|**Name**|**Type**|(% style="width:837px" %)**Documentation**
860 +|id|com:IDType|(% style="width:837px" %)The id attribute holds the identifier of the report structure as defined in the metadata structure definition. This identifies the report structure which defines the structure of metadata that is being reported. This is optional and not expected to be supplied as the metadata structure definition specific schema will specify a fixed value such that the reference to the report structure will always be available if required for processing.
763 763  
764 764  Element Documentation:
765 765  
766 -|**Name**|**Type**|**Documentation**
767 -|com:Annotations|com: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 my reference it.
768 -|Target|//TargetType//|Target contains a set of target reference values which when taken together, identify the object or objects to which the reported metadata apply. This element is unqualified so that the metadata structure definition specific schema can refine the type of the element such that the references values can be validated against those defined in the metadata targets for the report structure.
769 -|AttributeSet|xs:anyType|AttributeSet contains the reported metadata attribute values for the reported metadata. This element is unqualified and un-typed so that it can refined by the metadata structure definition specific schema to validate that the reported metadata attributes conform to those prescribed by the report structure. The content of this must be element only, and these elements must always represent a reported attribute. Since this can not be strictly enforced in XML Schema, additional steps have been added to make generic processing of this element simpler. When processing this element, any element found with the attribute isMetadataAttribute in this target namespace is assumed to be a reported metadata attribute and can be processed as such.
864 +(% style="width:1005.29px" %)
865 +|**Name**|**Type**|(% style="width:695px" %)**Documentation**
866 +|com:Annotations|com:AnnotationsType|(% style="width:695px" %)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 my reference it.
867 +|Target|//TargetType//|(% style="width:695px" %)Target contains a set of target reference values which when taken together, identify the object or objects to which the reported metadata apply. This element is unqualified so that the metadata structure definition specific schema can refine the type of the element such that the references values can be validated against those defined in the metadata targets for the report structure.
868 +|AttributeSet|xs:anyType|(% style="width:695px" %)AttributeSet contains the reported metadata attribute values for the reported metadata. This element is unqualified and un-typed so that it can refined by the metadata structure definition specific schema to validate that the reported metadata attributes conform to those prescribed by the report structure. The content of this must be element only, and these elements must always represent a reported attribute. Since this can not be strictly enforced in XML Schema, additional steps have been added to make generic processing of this element simpler. When processing this element, any element found with the attribute isMetadataAttribute in this target namespace is assumed to be a reported metadata attribute and can be processed as such.
770 770  
771 771  **//TargetType//: **TargetType is an abstract base type that forms the basis of a the metadata report's metadata target value. This type is restricted in the metadata structure definition specific schema so that the ReferenceValue elements conform to the targets specified in the metadata target defined in the metadata structure definition.
772 772  
773 773  Attributes:
873 +
774 774  id?
775 775  
776 776  Content:
877 +
777 777  ReferenceValue+
778 778  
779 779  Attribute Documentation:
780 780  
781 -|**Name**|**Type**|**Documentation**
782 -|id|com:IDType|The id attribute holds the identifier of the metadata target as defined in the metadata structure definition. This identifies the metadata target of the report structure that identifies the target object(s) of the reported metadata. This is optional and not expected to be supplied as the metadata structure definition specific schema will specify a fixed value such that the reference to the metadata target will always be available if required for processing.
882 +(% style="width:999.294px" %)
883 +|**Name**|**Type**|(% style="width:833px" %)**Documentation**
884 +|id|com:IDType|(% style="width:833px" %)The id attribute holds the identifier of the metadata target as defined in the metadata structure definition. This identifies the metadata target of the report structure that identifies the target object(s) of the reported metadata. This is optional and not expected to be supplied as the metadata structure definition specific schema will specify a fixed value such that the reference to the metadata target will always be available if required for processing.
783 783  
784 784  Element Documentation:
785 785  
786 -|**Name**|**Type**|**Documentation**
787 -|ReferenceValue|//ReferenceValueType//|ReferenceValue contains a value for a target reference. When this is taken with its sibling elements, they identify the object or objects to which the reported metadata apply. The content of this will either be a reference to an identifiable object, a data key, a reference to a data set, or a report period. This element is unqualified so that the metadata structure definition specific schema can refine the type of the element such that value can be validated against the format defined in the metadata structure definition.
888 +(% style="width:999.294px" %)
889 +|**Name**|**Type**|(% style="width:700px" %)**Documentation**
890 +|ReferenceValue|//ReferenceValueType//|(% style="width:700px" %)ReferenceValue contains a value for a target reference. When this is taken with its sibling elements, they identify the object or objects to which the reported metadata apply. The content of this will either be a reference to an identifiable object, a data key, a reference to a data set, or a report period. This element is unqualified so that the metadata structure definition specific schema can refine the type of the element such that value can be validated against the format defined in the metadata structure definition.
788 788  
789 789  **//ReferenceValueType//: **ReferenceValueType is an abstract base type that forms the basis of a target reference value. A target reference value will either be a reference to an identifiable object, a data key, a reference to a data set, or a report period. The choice of these options will be refined to only one according to the definition of the target in the metadata structure definition.
790 790  
791 791  Attributes:
895 +
792 792  id?
793 793  
794 794  Content:
899 +
795 795  (ObjectReference | DataKey | DataSetReference | ConstraintContentReference | ReportPeriod)
796 796  
797 797  Attribute Documentation:
798 798  
799 -|**Name**|**Type**|**Documentation**
800 -|id|com:IDType|The id attribute holds the identifier of the target reference object reference as defined in the metadata structure definition. This identifies the target reference of the metadata target that identifes one of the target references, that when taken together, identify the target of the reported metadata. This is optional and not expected to be supplied as the metadata structure definition specific schema will specify a fixed value such that the reference to the target object definition will always be available if required for processing.
904 +(% style="width:1013.29px" %)
905 +|**Name**|**Type**|(% style="width:847px" %)**Documentation**
906 +|id|com:IDType|(% style="width:847px" %)The id attribute holds the identifier of the target reference object reference as defined in the metadata structure definition. This identifies the target reference of the metadata target that identifes one of the target references, that when taken together, identify the target of the reported metadata. This is optional and not expected to be supplied as the metadata structure definition specific schema will specify a fixed value such that the reference to the target object definition will always be available if required for processing.
801 801  
802 802  Element Documentation:
803 803  
804 -|**Name**|**Type**|**Documentation**
805 -|ObjectReference|//com:ReferenceType//|ObjectReference provides a reference to an identifiable object in the SDMX information model. An identifiable object target will utilize this option as the representation of the target reference value. This element is unqualified so that the metadata structure definition specific schema can refine the type of the element such that the type of reference is valid according to the object type specified in the identifiable object target in the metadata structure definition. At the very least, the reference will be specific to the type of object being referenced so that a complete set of reference fields must be provided. In cases where an item object is restricted to be from a particular scheme, this type will be further restricted so that only a valid item reference can be supplied. The structure of this reference is such that it can be generically processed without needing to know what the intended target object type is prior to processing, as this information is part of the reference.
806 -|DataKey|com:DataKeyType|ObjectReference provides a set of dimension references and values for those dimension for the purpose of reporting metadata against a set of data. A key descriptor values target will utilize this option as the representation of the target reference value. It is not expect that the metadata structure definition specific schema would refine this, but none the less, it is an unqualified element.
807 -|DataSetReference|com:SetReferenceType|DataSetReference provides a reference to a data set for the purpose of reporting metadata against the data. A data set target will utilize this option as the representation of the target reference value.
808 -|ConstraintContentRef erence|com: AttachmentConstraint ReferenceType|ConstraintContentReference provides a reference to an attachment constraint for the purpose of reporting metadata against the data identified in the key sets and/or cube regions identified by the constraint. A constraint target will utilize this option as the representation of the target reference value.
809 -|ReportPeriod|com: ObservationalTimePer iodType|ReportPeriod provides a report period for the purpose of qualifying the target reporting period of reported metadata. A report period target will utilize this option as the representation of the target reference value. It is not expect that the metadata structure definition specific schema would refine this, but none the less, it is an unqualified element. This element is unqualified so that the metadata structure definition specific schema can refine the type of the element such that the specific type of time value prescribed in the metadata structure definition can be validated.
910 +(% style="width:1000.29px" %)
911 +|**Name**|**Type**|(% style="width:563px" %)**Documentation**
912 +|ObjectReference|//com:ReferenceType//|(% style="width:563px" %)ObjectReference provides a reference to an identifiable object in the SDMX information model. An identifiable object target will utilize this option as the representation of the target reference value. This element is unqualified so that the metadata structure definition specific schema can refine the type of the element such that the type of reference is valid according to the object type specified in the identifiable object target in the metadata structure definition. At the very least, the reference will be specific to the type of object being referenced so that a complete set of reference fields must be provided. In cases where an item object is restricted to be from a particular scheme, this type will be further restricted so that only a valid item reference can be supplied. The structure of this reference is such that it can be generically processed without needing to know what the intended target object type is prior to processing, as this information is part of the reference.
913 +|DataKey|com:DataKeyType|(% style="width:563px" %)ObjectReference provides a set of dimension references and values for those dimension for the purpose of reporting metadata against a set of data. A key descriptor values target will utilize this option as the representation of the target reference value. It is not expect that the metadata structure definition specific schema would refine this, but none the less, it is an unqualified element.
914 +|DataSetReference|com:SetReferenceType|(% style="width:563px" %)DataSetReference provides a reference to a data set for the purpose of reporting metadata against the data. A data set target will utilize this option as the representation of the target reference value.
915 +|ConstraintContentRef erence|com: AttachmentConstraint ReferenceType|(% style="width:563px" %)ConstraintContentReference provides a reference to an attachment constraint for the purpose of reporting metadata against the data identified in the key sets and/or cube regions identified by the constraint. A constraint target will utilize this option as the representation of the target reference value.
916 +|ReportPeriod|com: ObservationalTimePeriodType|(% style="width:563px" %)ReportPeriod provides a report period for the purpose of qualifying the target reporting period of reported metadata. A report period target will utilize this option as the representation of the target reference value. It is not expect that the metadata structure definition specific schema would refine this, but none the less, it is an unqualified element. This element is unqualified so that the metadata structure definition specific schema can refine the type of the element such that the specific type of time value prescribed in the metadata structure definition can be validated.
810 810  
811 811  **//ReportedAttributeType//: **ReportedAttributeType is an abstract base type that forms the basis for a metadata structure specific metadata attribute. A value for the attribute can be supplied as either a single value, or multi-lingual text values (either structured or unstructured). An optional set of child metadata attributes is also available if the metadata attribute definition defines nested metadata attributes. The metadata structure definition specific schema will refine this type for each metadata attribute such that the content can be validation against what is defined in the metadata structure definition.
812 812  
... ... @@ -816,47 +816,52 @@
816 816  ** //ReportedAttributeType//
817 817  
818 818  Attributes:
926 +
819 819  id?, value?, isMetadataAttribute?
820 820  
821 821  Content:
930 +
822 822  com:Annotations?, (com:Text+ | com:StructuredText+)?, AttributeSet?
823 823  
824 824  Attribute Documentation:
825 825  
826 -|**Name**|**Type**|**Documentation**
827 -|id|com:IDType|The id attribute identifies the metadata attribute that the value is being reported for. This is optional and not expected to be supplied as the metadata structure definition specific schema will specify a fixed value such that the reference to the metadata attribute will always be available if required for processing.
828 -|value|xs:anySimpleType|The value attribute holds any simple value for the metadata attribute. This attribute is un-typed such that the metadata structure definition specific schema can specify any simple type according the text format / local representation defined by the metadata structure definition.
829 -|isMetadataAttribute (fixed: true)|xs:boolean|The isMetadataAttribute attribute is a fixed boolean (true) and is intended to designate to processing applications that a given element represents a reported attribute. This attribute is qualified (meaning that it will be qualified in an instance with the target namespace) to ensure that it can be properly identified by applications. The purpose of this is to allow applications to identify elements with unknown names as reported attributes so that they may process a metadata structure definition specific instance without knowledge of the underlying metadata structure definition.
935 +(% style="width:999.294px" %)
936 +|**Name**|**Type**|(% style="width:660px" %)**Documentation**
937 +|id|com:IDType|(% style="width:660px" %)The id attribute identifies the metadata attribute that the value is being reported for. This is optional and not expected to be supplied as the metadata structure definition specific schema will specify a fixed value such that the reference to the metadata attribute will always be available if required for processing.
938 +|value|xs:anySimpleType|(% style="width:660px" %)The value attribute holds any simple value for the metadata attribute. This attribute is un-typed such that the metadata structure definition specific schema can specify any simple type according the text format / local representation defined by the metadata structure definition.
939 +|isMetadataAttribute (fixed: true)|xs:boolean|(% style="width:660px" %)The isMetadataAttribute attribute is a fixed boolean (true) and is intended to designate to processing applications that a given element represents a reported attribute. This attribute is qualified (meaning that it will be qualified in an instance with the target namespace) to ensure that it can be properly identified by applications. The purpose of this is to allow applications to identify elements with unknown names as reported attributes so that they may process a metadata structure definition specific instance without knowledge of the underlying metadata structure definition.
830 830  
831 831  Element Documentation:
832 832  
833 -|**Name**|**Type**|**Documentation**
834 -|com:Annotations|com: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 my reference it.
835 -|com:Text|com: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.
836 -|com:StructuredText|com: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. If the multi-lingual flag is not set to true, it is expected that the maximum occurrence of this will be refined to be 1 in the metadata structure definition specific schema.
837 -|AttributeSet|xs:anyType|AttributeSet contains the reported metadata attribute values for the child metadata attributes. This element is unqualified and un-typed so that it can refined by the metadata structure definition specific schema to validate that the reported metadata attributes conform to those prescribed by the metadata attribute definition. The content of this must be element only, and these elements must always represent a reported attribute. Since this can not be strictly enforced in XML Schema, additional steps have been added to make generic processing of this element simpler. When processing this element, any element found with the attribute isMetadataAttribute in this target namespace is assumed to be a reported metadata attribute and can be processed as such.
943 +(% style="width:997.294px" %)
944 +|**Name**|**Type**|(% style="width:668px" %)**Documentation**
945 +|com:Annotations|com:AnnotationsType|(% style="width:668px" %)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 my reference it.
946 +|com:Text|com:TextType|(% style="width:668px" %)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.
947 +|com:StructuredText|com:XHTMLType|(% style="width:668px" %)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. If the multi-lingual flag is not set to true, it is expected that the maximum occurrence of this will be refined to be 1 in the metadata structure definition specific schema.
948 +|AttributeSet|xs:anyType|(% style="width:668px" %)AttributeSet contains the reported metadata attribute values for the child metadata attributes. This element is unqualified and un-typed so that it can refined by the metadata structure definition specific schema to validate that the reported metadata attributes conform to those prescribed by the metadata attribute definition. The content of this must be element only, and these elements must always represent a reported attribute. Since this can not be strictly enforced in XML Schema, additional steps have been added to make generic processing of this element simpler. When processing this element, any element found with the attribute isMetadataAttribute in this target namespace is assumed to be a reported metadata attribute and can be processed as such.
838 838  
839 -= Mapping to Structure-Specific Schemas =
950 += 3. Mapping to Structure-Specific Schemas =
840 840  
841 -== General ==
952 +== 3.1 General ==
842 842  
843 843  Data structure and metadata structure-specific schemas are each based on one single core construct found in their respective structure-specific namespaces;
844 844  
845 -Data  - http:~/~/www.SDMX.org/resources/SDMXML/schemas/v2_1/data/structurespecific
956 +Data - http:~/~/www.SDMX.org/resources/SDMXML/schemas/v2_1/data/structurespecific
846 846  
847 847  Metadata - http:~/~/www.SDMX.org/resources/SDMXML/schemas/v2_1/data/structurespecific
848 848  
849 849  For a metadata structure, only a single schema will be created for the entire structure definition. For data structures, many variations of the base schema are possible, each specific as to how the data is organised. This will be discussed in more details in the specific rules for the data structure schemas.
850 850  
851 -=== Basic Terminology ===
962 +=== 3.1.1 Basic Terminology ===
852 852  
853 853  In the subsequent sections, the following namespace prefixes are used:
854 854  
855 -|**Namespace**|**Prefix**
856 -|http:~/~/www.w3.org/2001/XMLSchema|xs
857 -|http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|common
858 -|http:~/~/www.sdmx.org/resources/sdmxml/schemas/ v2_1/data/structurespecific|dsd
859 -|http:~/~/www.sdmx.org/resources/sdmxml/schemas/ v2_1/metadata/structurespecific|msd
966 +(% style="width:763.294px" %)
967 +|(% style="width:623px" %)**Namespace**|(% style="width:137px" %)**Prefix**
968 +|(% style="width:623px" %)http:~/~/www.w3.org/2001/XMLSchema|(% style="width:137px" %)xs
969 +|(% style="width:623px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|(% style="width:137px" %)common
970 +|(% style="width:623px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/ v2_1/data/structurespecific|(% style="width:137px" %)dsd
971 +|(% style="width:623px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/ v2_1/metadata/structurespecific|(% style="width:137px" %)msd
860 860  
861 861  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:
862 862  
... ... @@ -894,7 +894,7 @@
894 894  
895 895  **XML Attribute:** Refers to the definition of an XML attribute for a complex type (i.e. and xs:attribute element in a xs:complexType element). An attribute must define a name and type (name and type attributes) and may also specify a usage (use attribute).
896 896  
897 -== Namespace Rules ==
1009 +== 3.2 Namespace Rules ==
898 898  
899 899  Each format specific schema will specify its namespace in the target namespace of the schema (the targetNamespace attribute of the schema). This document also assumes that the root namespace (that which is defined by the xmlns attribute) of the schema will be the same as the target namespace. Therefore any types or global elements referenced in these descriptions without a namespace prefix are assumed to be in the format specific namespace.
900 900  
... ... @@ -902,18 +902,19 @@
902 902  
903 903  For the purpose of the descriptions here, the default element form for the schema (as specified in the elementFormDefault attribute of the schema) is “qualified", and the default attribute form (as specified in the attributeFormDefault attribute of the schema) is "unqualified".
904 904  
905 -== General Rules ==
1017 +== 3.3 General Rules ==
906 906  
907 907  The following section details the general rules which apply to all structure specific schema creation.
908 908  
909 -=== Component Name Determination ===
1021 +=== 3.3.1 Component Name Determination ===
910 910  
911 911  When required to create an XML element or attribute, the name for a component is always its identifier. However, the identifier may be inherited. Therefore, the general rules is as follows:
912 912  
913 -If the component defines an identifier, the element or attribute name is the value of that identifier
914 -Otherwise, the element or attribute name is the identifier of the concept from which it takes its semantic (Note that this is technically the component identifer).
915 -Representation Determination
1025 +1. If the component defines an identifier, the element or attribute name is the value of that identifier
1026 +1. Otherwise, the element or attribute name is the identifier of the concept from which it takes its semantic (Note that this is technically the component identifer).
916 916  
1028 +=== 3.3.2 Representation Determination ===
1029 +
917 917  Every component has a representation associated with it, whether it is defined as a local representation in the component definition, or it is inherited from the concept from which the component takes it semantic (as defined in the concept identity of the component).
918 918  
919 919  The representation of a component is determined by the following precedence:
... ... @@ -926,13 +926,13 @@
926 926  
927 927  A text format consists of a data type and an optional collection of facets. It is the combination of these which determine the exact nature of the component representation. An enumeration consists of a reference to an item scheme, for which an enumerated list of possible values can be created.
928 928  
929 -=== Simple / Primitive Type Determination ===
1042 +=== 3.3.3 Simple / Primitive Type Determination ===
930 930  
931 -For any given representation, there exist rules for determining the simple or primitive type which should be used to validate the value. There are no specific requirements to how a simple type is named or if it is referenced or used as an anonymous type. This section simply serves to state the requirements of the type for a component based on its [[determined representation>>path:#_Representation_Determination:]].
1044 +For any given representation, there exist rules for determining the simple or primitive type which should be used to validate the value. There are no specific requirements to how a simple type is named or if it is referenced or used as an anonymous type. This section simply serves to state the requirements of the type for a component based on its determined representation.
932 932  
933 933  For example, a dimension may inherit its representation for a concept, and the data type of a representation data type may be a String. The simplest solution would be to use the xs:string primitive type. However, an implementer may have chosen to generate simple types for all concepts to avoid having to look up the concept core representation for very component. In this case, the type may be given a name based on the concept and be a simple derivation from the xs:string type that places no further restrictions. The result would be that the type that is actually used for the dimension, although named after the concept, is effectively the required xs:string. These rules are meant to allow such flexibility in how types are created. The only requirement is that the type meet the requirements stated here.
934 934  
935 -=== Representation with Enumeration ===
1048 +=== 3.3.4 Representation with Enumeration ===
936 936  
937 937  A representation which defines an enumeration will result in a simple type that is a restriction of the common:IDType. The simple type will define enumerations for each item in the item scheme. 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:
938 938  
... ... @@ -945,69 +945,71 @@
945 945  > </xs:enumeration>
946 946  
947 947  
948 -=== Representation with Text Format ===
1061 +=== 3.3.5 Representation with Text Format ===
949 949  
950 950  A representation which defines a text format will result in a simple type or primitive type. The first step is to determine the base type from the text format data type:
951 951  
952 -|**SDMX Data Type**|**XML Schema Data Type**
953 -|String|xs:string
954 -|AlphaNumeric|common:AlphaNumericType
955 -|Alpha|common:AlphaType
956 -|Numeric|common:NumericType
957 -|BigInteger|xs:integer
958 -|Integer|xs:int
959 -|Long|xs:long
960 -|Short|xs:short
961 -|Decimal|xs:decimal
962 -|Float|xs:float
963 -|Double|xs:double
964 -|Boolean|xs:boolean
965 -|URI|xs:anyURI
966 -|Count|xs:integer
967 -|InclusiveValueRange|xs:decimal
968 -|ExclusiveValueRange|xs: decimal
969 -|Incremental|xs: decimal
970 -|ObservationalTimePeriod|common:ObservationalTimePeriodType
971 -|StandardTimePeriod|common:StandardTimePeriodType
972 -|BasicTimePeriod|common:BasicTimePeriodType
973 -|GregorianTimePeriod|common:GregorianTimePeriodType
974 -|GregorianYear|xs:gYear
975 -|GregorianYearMonth|xs:gYearMonth
976 -|GregorianDay|xs:date
977 -|ReportingTimePeriod|common:ReportingTimePeriodType
978 -|ReportingYear|common:ReportingYearType
979 -|ReportingSemester|common:ReportingSemesterType
980 -|ReportingTrimester|common:ReportingTrimesterType
981 -|ReportingQuarter|common:ReportingQuarterType
982 -|ReportingMonth|common:ReportingMonthType
983 -|ReportingWeek|common:ReportingWeekType
984 -|ReportingDay|common:ReportingDayType
985 -|DateTime|xs:dateTime
986 -|TimeRange|common:TimeRangeType
987 -|Month|xs:gMonth
988 -|MonthDay|xs:gMonthDay
989 -|Day|xs:gDay
990 -|Time|xs:time
991 -|Duration|xs:duration
992 -|XHTML|N/A{{footnote}}These types are only used in complex types and will be discussed within their appropriate context.{{/footnote}}
993 -|KeyValues|N/A^^1^^
994 -|IdentifiableReference|N/A^^1^^
995 -|DataSetReference|N/A^^1^^
996 -|AttachmentConstraintReference|N/A^^1^^
1065 +(% style="width:698.294px" %)
1066 +|(% style="width:286px" %)**SDMX Data Type**|(% style="width:409px" %)**XML Schema Data Type**
1067 +|(% style="width:286px" %)String|(% style="width:409px" %)xs:string
1068 +|(% style="width:286px" %)AlphaNumeric|(% style="width:409px" %)common:AlphaNumericType
1069 +|(% style="width:286px" %)Alpha|(% style="width:409px" %)common:AlphaType
1070 +|(% style="width:286px" %)Numeric|(% style="width:409px" %)common:NumericType
1071 +|(% style="width:286px" %)BigInteger|(% style="width:409px" %)xs:integer
1072 +|(% style="width:286px" %)Integer|(% style="width:409px" %)xs:int
1073 +|(% style="width:286px" %)Long|(% style="width:409px" %)xs:long
1074 +|(% style="width:286px" %)Short|(% style="width:409px" %)xs:short
1075 +|(% style="width:286px" %)Decimal|(% style="width:409px" %)xs:decimal
1076 +|(% style="width:286px" %)Float|(% style="width:409px" %)xs:float
1077 +|(% style="width:286px" %)Double|(% style="width:409px" %)xs:double
1078 +|(% style="width:286px" %)Boolean|(% style="width:409px" %)xs:boolean
1079 +|(% style="width:286px" %)URI|(% style="width:409px" %)xs:anyURI
1080 +|(% style="width:286px" %)Count|(% style="width:409px" %)xs:integer
1081 +|(% style="width:286px" %)InclusiveValueRange|(% style="width:409px" %)xs:decimal
1082 +|(% style="width:286px" %)ExclusiveValueRange|(% style="width:409px" %)xs: decimal
1083 +|(% style="width:286px" %)Incremental|(% style="width:409px" %)xs: decimal
1084 +|(% style="width:286px" %)ObservationalTimePeriod|(% style="width:409px" %)common:ObservationalTimePeriodType
1085 +|(% style="width:286px" %)StandardTimePeriod|(% style="width:409px" %)common:StandardTimePeriodType
1086 +|(% style="width:286px" %)BasicTimePeriod|(% style="width:409px" %)common:BasicTimePeriodType
1087 +|(% style="width:286px" %)GregorianTimePeriod|(% style="width:409px" %)common:GregorianTimePeriodType
1088 +|(% style="width:286px" %)GregorianYear|(% style="width:409px" %)xs:gYear
1089 +|(% style="width:286px" %)GregorianYearMonth|(% style="width:409px" %)xs:gYearMonth
1090 +|(% style="width:286px" %)GregorianDay|(% style="width:409px" %)xs:date
1091 +|(% style="width:286px" %)ReportingTimePeriod|(% style="width:409px" %)common:ReportingTimePeriodType
1092 +|(% style="width:286px" %)ReportingYear|(% style="width:409px" %)common:ReportingYearType
1093 +|(% style="width:286px" %)ReportingSemester|(% style="width:409px" %)common:ReportingSemesterType
1094 +|(% style="width:286px" %)ReportingTrimester|(% style="width:409px" %)common:ReportingTrimesterType
1095 +|(% style="width:286px" %)ReportingQuarter|(% style="width:409px" %)common:ReportingQuarterType
1096 +|(% style="width:286px" %)ReportingMonth|(% style="width:409px" %)common:ReportingMonthType
1097 +|(% style="width:286px" %)ReportingWeek|(% style="width:409px" %)common:ReportingWeekType
1098 +|(% style="width:286px" %)ReportingDay|(% style="width:409px" %)common:ReportingDayType
1099 +|(% style="width:286px" %)DateTime|(% style="width:409px" %)xs:dateTime
1100 +|(% style="width:286px" %)TimeRange|(% style="width:409px" %)common:TimeRangeType
1101 +|(% style="width:286px" %)Month|(% style="width:409px" %)xs:gMonth
1102 +|(% style="width:286px" %)MonthDay|(% style="width:409px" %)xs:gMonthDay
1103 +|(% style="width:286px" %)Day|(% style="width:409px" %)xs:gDay
1104 +|(% style="width:286px" %)Time|(% style="width:409px" %)xs:time
1105 +|(% style="width:286px" %)Duration|(% style="width:409px" %)xs:duration
1106 +|(% style="width:286px" %)XHTML|(% style="width:409px" %)N/A{{footnote}}These types are only used in complex types and will be discussed within their appropriate context.{{/footnote}}^^{{footnote}}These types are only used in complex types and will be discussed within their appropriate context.{{/footnote}}^^
1107 +|(% style="width:286px" %)KeyValues|(% style="width:409px" %)N/A^^1^^
1108 +|(% style="width:286px" %)IdentifiableReference|(% style="width:409px" %)N/A^^1^^
1109 +|(% style="width:286px" %)DataSetReference|(% style="width:409px" %)N/A^^1^^
1110 +|(% style="width:286px" %)AttachmentConstraintReference|(% style="width:409px" %)N/A^^1^^
997 997  
998 998  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):
999 999  
1000 -|**SDMX Facet**|**XML Schema Facet**
1001 -|minLength|xs:minLength
1002 -|maxLength|xs:maxLength
1003 -|minValue{{footnote}}Note that these options only apply to numeric representations and should be ignored if the data type is non-numeric{{/footnote}}|if ExclusiveValueRange: xs:minExclusives, else: xs:minInclusive
1004 -|maxValue^^2^^|if ExclusiveValueRange: xs:maxExclusives, else: xs:maxInclusive
1005 -|decimals^^2^^|xs:fractionDigits
1006 -|pattern|xs:pattern
1114 +(% style="width:773.294px" %)
1115 +|(% style="width:291px" %)**SDMX Facet**|(% style="width:479px" %)**XML Schema Facet**
1116 +|(% style="width:291px" %)minLength|(% style="width:479px" %)xs:minLength
1117 +|(% style="width:291px" %)maxLength|(% style="width:479px" %)xs:maxLength
1118 +|(% style="width:291px" %)minValue{{footnote}}Note that these options only apply to numeric representations and should be ignored if the data type is non-numeric{{/footnote}}^^{{footnote}}Note that these options only apply to numeric representations and should be ignored if the data type is non-numeric{{/footnote}}^^|(% style="width:479px" %)if ExclusiveValueRange: xs:minExclusives, else: xs:minInclusive
1119 +|(% style="width:291px" %)maxValue^^2^^|(% style="width:479px" %)if ExclusiveValueRange: xs:maxExclusives, else: xs:maxInclusive
1120 +|(% style="width:291px" %)decimals^^2^^|(% style="width:479px" %)xs:fractionDigits
1121 +|(% style="width:291px" %)pattern|(% style="width:479px" %)xs:pattern
1007 1007  
1008 1008  Any other facets are informational only, and will not affect the determined type.
1009 1009  
1010 -=== Type Names ===
1125 +=== 3.3.6 Type Names ===
1011 1011  
1012 1012  These rules will only dictate type names where absolutely necessary. In all other cases, it is the decision of the implementer as to how to name or use the type. It is also the implementer's requirement to ensure that any type name is properly unique within its scope. To assist in this, the following recommendations are offered for naming types such that they are unique.
1013 1013  
... ... @@ -1016,126 +1016,157 @@
1016 1016  * If the type is based on a text format of a component local representation, and;
1017 1017  ** 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]
1018 1018  ** 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]
1019 -**1. Type Reuse
1020 1020  
1135 +=== 3.3.7 Type Reuse ===
1136 +
1021 1021  It is possible that organisations that manage a large number of structure specific schemas my wish to take advantage of the reuse of previously defined type in order to simply the structure specific schema creation and lessen the number of schema elements which are created. The structure specific formats are designed in such a way that this would be allowed without any adverse affects.
1022 1022  
1023 1023  For example, an organisation my create predefined types for all of codelists and concept schemes which their structures utilize. These could be contained in a common schema with any namespace deemed appropriate. This would allow the structure specific schemas generation process to recognize the reused components and not be concerned with regenerating types. The logical flow for setting the representation of a component might be as follows:
1024 1024  
1025 -Does the component define a local type?
1141 +> Does the component define a local type?
1142 +> Yes: Is that type enumerated?
1143 +> Yes: Type is the qualified type name for the item scheme
1144 +> No: Generate simple type for text format
1145 +> No: Type is the qualified name for the concept from which the component takes its semantic.
1026 1026  
1027 -Yes: Is that type enumerated?
1028 -
1029 -Yes: Type is the qualified type name for the item scheme
1030 -
1031 -No: Generate simple type for text format
1032 -
1033 -No: Type is the qualified name for the concept from which the component takes its semantic.
1034 -
1035 1035  Only the constructs that will be detailed in the data and metadata structure-specific rules below are required to be in the specified target namespace of the structure-specific schema. So long as any other generated type conforms to the rules specified, it may exist in any namespace.
1036 1036  
1037 -== Data Structure Specific Schema ==
1149 +== 3.4 Data Structure Specific Schema ==
1038 1038  
1039 1039  Separate schemas will be created for the data structure depending on which dimension occurs at the observation level, and whether explicit measures are used in the case that the observation dimension is the measure dimension. The recommended target namespace of the data structured specific schema is: [Data Structure URN]:ObsLevelDim:[Observation Dimensions](:explicit)?. Note that the explicit trailer is only used when the measure dimension is used at the observation level and the explicit measure concepts are to be used.
1040 1040  
1041 1041  The rules for generating the data structure specific-schema are broken into sections based on the level within the structure (i.e. data set, group, series, observation). Each section will state the rules for each variation of the structure specific format.
1042 1042  
1043 -=== DataSetType ===
1155 +=== 3.4.1 DataSetType ===
1044 1044  
1045 1045  A complex type named DataSetType must be created. Its content model will be derived via restriction. If the dimension at the observation level is the time dimension (TIME_PERIOD) the base type of the restriction is dsd:TimeSeriesDataSetType. Otherwise, the base type of the restriction is dsd:DataSetType. The complex type content model will be as follows:
1046 1046  
1047 -1. A sequence consisting of:
1048 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1049 -11. A local element named DataProvider with the type common:DataProviderReferenceType, a form of unqualified and a minimum occurrence of 0
1050 -11. If the data structure defines groups, a local element named Group with a form of unqualified, a minimum occurrence of 0, and a maximum occurrence of unbounded. The type of this element should be the type that is described in the GroupType section which follows.
1051 -11. A choice with a minimum occurrence of 0 consisting of:
1052 -111. If the dimension at the observation level is not AllDimensions, a local element named Series with a form of unqualified, a maximum occurrence of unbounded, and a type of SeriesType (as defined in the SeriesType section which follows)
1053 -111. If the dimension at the observation level is AllDimensions, a local element named Obs with a form of unqualified, a maximum occurrence of unbounded, and a type of ObsType (as defined in the ObsType section which follows)
1054 -1. If the reporting year start day attribute is not declared in the data structure definition or if it is declared but does not declare an attribute relationship of None, an attribute named REPORTING_YEAR_START_DAY with a type of xs:gMonthDay and a usage of prohibited
1055 -1. An attribute for each attribute defined in the data structured definition that declares an attribute relationship of None. The XML attribute [[name>>path:#_Component_Name_Determination]] and [[type>>path:#_Simple_/_Primitive]] are defined according to the general rules defined in the previous section, and the usage is optional
1056 -11.
1159 +~1. A sequence consisting of:
1057 1057  
1058 -=== GroupType ===
1161 +* a. An element reference to common:Annotations, with a minimum occurrence of 0
1162 +* b. A local element named DataProvider with the type common:DataProviderReferenceType, a form of unqualified and a minimum occurrence of 0
1163 +* c. If the data structure defines groups, a local element named Group with a form of unqualified, a minimum occurrence of 0, and a maximum occurrence of unbounded. The type of this element should be the type that is described in the GroupType section which follows.
1164 +* d. A choice with a minimum occurrence of 0 consisting of:
1165 +** i. If the dimension at the observation level is not AllDimensions, a local element named Series with a form of unqualified, a maximum occurrence of unbounded, and a type of SeriesType (as defined in the SeriesType section which follows)
1166 +** ii. If the dimension at the observation level is AllDimensions, a local element named Obs with a form of unqualified, a maximum occurrence of unbounded, and a type of ObsType (as defined in the ObsType section which follows)
1059 1059  
1168 +2. If the reporting year start day attribute is not declared in the data structure definition or if it is declared but does not declare an attribute relationship of None, an attribute named REPORTING_YEAR_START_DAY with a type of xs:gMonthDay and a usage of prohibited
1169 +
1170 +3. An attribute for each attribute defined in the data structured definition that declares an attribute relationship of None. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is optional
1171 +
1172 +=== 3.4.2 GroupType ===
1173 +
1060 1060  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:
1061 1061  
1062 -1. A sequence consisting of:
1063 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1064 -1. An attribute for each dimension referenced by the group. The XML attribute [[name>>path:#_Component_Name_Determination]] and [[type>>path:#_Simple_/_Primitive]] are defined according to the general rules defined in the previous section, and the usage is required
1065 -1. If the reporting year start day attribute is not declared in the data structure definition or if it is declared but does not declare an attribute relationship with the group and does not specify the group as an attachment group, an attribute named REPORTING_YEAR_START_DAY with a type of xs:gMonthDay and a usage of prohibited
1066 -1. An attribute for each attribute 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>>path:#_Component_Name_Determination]] and [[type>>path:#_Simple_/_Primitive]] are defined according to the general rules defined in the previous section, and the usage is optional
1067 -1. An attribute named type with a type of common:IDType, usage of optional, and a fixed value of the identifier of the group
1176 +~1. A sequence consisting of:
1068 1068  
1178 +* a. An element reference to common:Annotations, with a minimum occurrence of 0
1179 +
1180 +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
1181 +
1182 +3. If the reporting year start day attribute is not declared in the data structure definition or if it is declared but does not declare an attribute relationship with the group and does not specify the group as an attachment group, an attribute named REPORTING_YEAR_START_DAY with a type of xs:gMonthDay and a usage of prohibited
1183 +
1184 +4. An attribute for each attribute 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
1185 +
1186 +5. An attribute named type with a type of common:IDType, usage of optional, and a fixed value of the identifier of the group
1187 +
1069 1069  If the data structure definitions 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:
1070 1070  
1071 -1. A sequence consisting of:
1072 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1073 -1. An attribute named type with a type of Group.ID, and a usage of optional
1074 -1. An anyAttribute declaration with a namespace of ~#~#local
1190 +~1. A sequence consisting of:
1075 1075  
1192 +* a. An element reference to common:Annotations, with a minimum occurrence of 0
1193 +
1194 +2. An attribute named type with a type of Group.ID, and a usage of optional
1195 +
1196 +3. An anyAttribute declaration with a namespace of ~#~#local
1197 +
1076 1076  A simple type named Group.ID must be created. This should restrict the common:IDType. For each group defined by the data structure definition, an enumeration will be created within the restriction with a value of the group identifier.
1077 1077  
1078 1078  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:
1079 1079  
1080 -1. A sequence consisting of:
1081 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1082 -1. An attribute for each dimension referenced by the group. The XML attribute [[name>>path:#_Component_Name_Determination]] and [[type>>path:#_Simple_/_Primitive]] are defined according to the general rules defined in the previous section, and the usage is required
1083 -1. If the reporting year start day attribute is not declared in the data structure definition or if it is declared but does not declare an attribute relationship with the group and does not specify the group as an attachment group, an attribute named REPORTING_YEAR_START_DAY with a type of xs:gMonthDay and a usage of prohibited
1084 -1. An attribute for each attribute 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>>path:#_Component_Name_Determination]] and [[type>>path:#_Simple_/_Primitive]] are defined according to the general rules defined in the previous section, and the usage is optional
1085 -1. An attribute named type with a type of Group.ID, usage of optional, and a fixed value of the identifier of the group
1202 +~1. A sequence consisting of:
1086 1086  
1087 -=== SeriesType ===
1204 +* a. An element reference to common:Annotations, with a minimum occurrence of 0
1088 1088  
1206 +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
1207 +
1208 +3. If the reporting year start day attribute is not declared in the data structure definition or if it is declared but does not declare an attribute relationship with the group and does not specify the group as an attachment group, an attribute named REPORTING_YEAR_START_DAY with a type of xs:gMonthDay and a usage of prohibited
1209 +
1210 +4. An attribute for each attribute 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
1211 +
1212 +5. An attribute named type with a type of Group.ID, usage of optional, and a fixed value of the identifier of the group
1213 +
1214 +=== 3.4.3 SeriesType ===
1215 +
1089 1089  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. If the dimension at the observation level is the time dimension (TIME_PERIOD) the base type of the restriction is dsd:TimeSeriesType. Otherwise, the base type of the restriction is dsd:SeriesType. The complex type content model will be as follows:
1090 1090  
1091 -1. A sequence consisting of:
1092 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1093 -11. 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)
1094 -1. An attribute for each dimension defined by the data structure definition, except for the dimension at the observation level. The XML attribute [[name>>path:#_Component_Name_Determination]] and [[type>>path:#_Simple_/_Primitive]] are defined according to the general rules defined in the previous section, and the usage is required
1095 -1. If the reporting year start day attribute is not declared in the data structure definition or if it is declared and declares an attribute relationship of None, or with a group, or the dimension at the observation level, or specifies a group as an attachment group, an attribute named REPORTING_YEAR_START_DAY with a type of xs:gMonthDay and a usage of prohibited
1096 -1. An attribute for each attribute defined 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>>path:#_Component_Name_Determination]] and [[type>>path:#_Simple_/_Primitive]] are defined according to the general rules defined in the previous section, and the usage is optional
1218 +~1. A sequence consisting of:
1097 1097  
1098 -=== ObsType ===
1220 +* a. An element reference to common:Annotations, with a minimum occurrence of 0
1099 1099  
1222 +2. 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)
1223 +
1224 +3. An attribute for each dimension defined by the data structure definition, except 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
1225 +
1226 +4. If the reporting year start day attribute is not declared in the data structure definition or if it is declared and declares an attribute relationship of None, or with a group, or the dimension at the observation level, or specifies a group as an attachment group, an attribute named REPORTING_YEAR_START_DAY with a type of xs:gMonthDay and a usage of prohibited
1227 +
1228 +5. An attribute for each attribute defined 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.
1229 +
1230 +=== 3.4.4 ObsType ===
1231 +
1100 1100  A complex type name ObsType must be created. Its content model will be derived via restriction. If the dimension at the observation level is the time dimension (TIME_PERIOD) the base type of the restriction is dsd:TimeSeriesObsType. Otherwise, the base type of the restriction is dsd:ObsType. If the explicit measure option is used, this complex type must be abstract. The complex type content model will be as follows:
1101 1101  
1102 -1. A sequence consisting of:
1103 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1104 -1. If the dimension at the observation level is not the time dimension (TIME_PERIOD) an attribute named TIME_PERIOD with a type of common:TimePeriodType and a usage of prohibited
1105 -1. If the dimension at the observation level is not the time dimension (TIME_PERIOD) an attribute for the dimension at the observation level. The XML attribute [[name>>path:#_Component_Name_Determination]] and [[type>>path:#_Simple_/_Primitive]] are defined according to the general rules defined in the previous section, and the usage is required
1106 -1. An attribute for the primary measure (OBS_VALUE) defined by the data structure definition. The XML attribute [[name>>path:#_Component_Name_Determination]] and [[type>>path:#_Simple_/_Primitive]] is defined according to the general rules defined in the previous section, and the usage is optional
1107 -1. An attribute for each attribute defined in the data structure that declares an attribute relationship with the dimension at the observation level or the primary measure (OBS_VALUE). The XML attribute [[name>>path:#_Component_Name_Determination]] and [[type>>path:#_Simple_/_Primitive]] are defined according to the general rules defined in the previous section, and the usage is optional
1108 -1. An attribute named type. If the explicit measure option is not used, this attribute must have a type of common:IDType and a usage of prohibited. If the explicit measure option is used, this attribute must have a type of the simple type generated for the representation of the measure dimension that is the dimension at the observation level (this will be an simple type with enumerations with values of the concept identifiers which make up the concept scheme that is the representation of the measure dimension) a and a usage of optional
1234 +~1. A sequence consisting of:
1109 1109  
1236 +* a. An element reference to common:Annotations, with a minimum occurrence of 0
1237 +
1238 +2. If the dimension at the observation level is not the time dimension (TIME_PERIOD) an attribute named TIME_PERIOD with a type of common:TimePeriodType and a usage of prohibited
1239 +
1240 +3. If the dimension at the observation level is not 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
1241 +
1242 +4. An attribute for the primary measure (OBS_VALUE) 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
1243 +
1244 +5. An attribute for each attribute defined in the data structure that declares an attribute relationship with the dimension at the observation level or the primary measure (OBS_VALUE). The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is optional
1245 +
1246 +An attribute named type. If the explicit measure option is not used, this attribute must have a type of common:IDType and a usage of prohibited. If the explicit measure option is used, this attribute must have a type of the simple type generated for the representation of the measure dimension that is the dimension at the observation level (this will be an simple type with enumerations with values of the concept identifiers which make up the concept scheme that is the representation of the measure dimension) a and a usage of optional
1247 +
1110 1110  If the explicit measure option is used, then complex type must be created for every concept which make up the representation of the measure dimension which is the dimension at the observation level. The name of this complex type will be taken from the identifier of the concept. Its content model will be derived via restriction of the ObsType. The complex type content model will be as follows:
1111 1111  
1112 -1. A sequence consisting of:
1113 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1114 -1. If the core representation of the Concept differs from that of the primary measure, an attribute for the primary measure (OBS_VALUE) defined by the data structure definition, except for the dimension at the observation level. The XML [[name>>path:#_Component_Name_Determination]] is defined according to the general rules defined in the previous section, and the usage is optional. The type of the attribute is the type that is generated for the core representation of the measure concept. Note that this representation type must have an explicit derivation from the type resulting from the primary measure. For example, if the primary measure type is xyz:CodeType, then the simple type which is defined for the core representation of the concept must restrict xyz:CodeType or one another type which restricts it
1115 -1. An attribute named type with a type of the simple type generated for the representation of the measure dimension that is the dimension at the observation level, a usage of optional, and a fixed value of the concept identifier.
1116 -11. Metadata Structure Specific Schema
1250 +~1. A sequence consisting of:
1117 1117  
1252 +* a. An element reference to common:Annotations, with a minimum occurrence of 0
1253 +
1254 +2. If the core representation of the Concept differs from that of the primary measure, an attribute for the primary measure (OBS_VALUE) defined by the data structure definition, except for the dimension at the observation level. The XML name is defined according to the general rules defined in the previous section, and the usage is optional. The type of the attribute is the type that is generated for the core representation of the measure concept. Note that this representation type must have an explicit derivation from the type resulting from the primary measure. For example, if the primary measure type is xyz:CodeType, then the simple type which is defined for the core representation of the concept must restrict xyz:CodeType or one another type which restricts it
1255 +
1256 +3. An attribute named type with a type of the simple type generated for the representation of the measure dimension that is the dimension at the observation level, a usage of optional, and a fixed value of the concept identifier.
1257 +
1258 +== 3.5 Metadata Structure Specific Schema ==
1259 +
1118 1118  One schema will be created for each metadata structure. This schema will define the contents of all report structures defined by the metadata structure. The recommended target namespace of the data structured specific schema is the URN of the metadata structure.
1119 1119  
1120 1120  The rules for generating the data structure specific-schema are broken into sections based on the level within the structure (i.e. metadata set, metadata targets, reports, metadata attributes). These rules will recommend names for generated types, and will refer back to these names throughout the description. These names are simply recommendations that should produce a unique name, but there is no requirement to use them. When a name is required, it will be made clear this is the case.
1121 1121  
1122 -=== MetadataSetType ===
1264 +=== 3.5.1 MetadataSetType ===
1123 1123  
1124 1124  A complex type that must be named MetadataSetType must be created. Its content model will be derived via restriction of the base type, msd:MetadataSetType. The complex type content model will be as follows:
1125 1125  
1126 -1. A sequence consisting of:
1127 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1128 -11. An element reference to common:Name, with a minimum occurrence of 0 and a maximum occurrence of unbounded
1129 -11. A local element named DataProvider with the type common:DataProviderReferenceType, a form of unqualified and a minimum occurrence of 0
1130 -11. A local element named Report with a type ReportType, a form of unqualified, a minimum occurrence of 0, and a maximum occurrence of unbounded.
1131 -111. TargetType
1268 +~1. A sequence consisting of:
1132 1132  
1270 +* a. An element reference to common:Annotations, with a minimum occurrence of 0
1271 +* b. An element reference to common:Name, with a minimum occurrence of 0 and a maximum occurrence of unbounded
1272 +* c. A local element named DataProvider with the type common:DataProviderReferenceType, a form of unqualified and a minimum occurrence of 0
1273 +* d. A local element named Report with a type ReportType, a form of unqualified, a minimum occurrence of 0, and a maximum occurrence of unbounded.
1274 +
1275 +=== 3.5.2 TargetType ===
1276 +
1133 1133  An abstract complex type with a recommended name of TargetType must be created. Its content model will be derived via restriction of the msd:TargetType. The complex type content model will be as follows:
1134 1134  
1135 -1. A sequence consisting of:
1136 -11. A local element named ReferenceValue with a type of msd:ReferenceValueType, a form of unqualified, and a maximum occurrence of unbounded
1137 -1. An attribute named id with a type of Target.ID, and a usage of optional
1279 +~1. A sequence consisting of:
1138 1138  
1281 +* a. A local element named ReferenceValue with a type of msd:ReferenceValueType, a form of unqualified, and a maximum occurrence of unbounded
1282 +
1283 +2. An attribute named id with a type of Target.ID, and a usage of optional
1284 +
1139 1139  A simple type with a recommended name of Target.ID must be created. This should restrict the common:IDType. For each report structure defined by the metadata structure definition, an enumeration will be created within the restriction with a value of the report structure identifier.
1140 1140  
1141 1141  A simple type with a recommended name of [metadata target identifier].TargetObject.ID must be created. This should restrict the Target.ID type. For each target object defined by the metadata target, an enumeration will be created within the restriction with a value of the target object identifier.
... ... @@ -1142,40 +1142,44 @@
1142 1142  
1143 1143  An abstract complex type with a recommended name of [metadata target identifier].ReferenceValueType will be created. Its content model will be derived via restriction of the msd:ReferenceValueType. The complex type content model will be as follows:
1144 1144  
1145 -1. A choice consisting of:
1146 -11. A local element named ObjectReference with a type of common:ReferenceType, and a form of unqualified
1147 -11. A local element named DataKey with a type of common:DataKeyType, and a form of unqualified
1148 -11. A local element named DataSetReference with a type of common:SetReferenceType, and a form of unqualified
1149 -11. A local element named ReportPeriod with a type of common:ObservationalTimePeriodType, and a form of unqualified
1150 -1. An attribute named id with the type defined previously as [metadata target identifier].TargetObject.ID, and a usage of optional
1291 +~1. A choice consisting of:
1151 1151  
1293 +* a. A local element named ObjectReference with a type of common:ReferenceType, and a form of unqualified
1294 +* b. A local element named DataKey with a type of common:DataKeyType, and a form of unqualified
1295 +* c. A local element named DataSetReference with a type of common:SetReferenceType, and a form of unqualified
1296 +* d. A local element named ReportPeriod with a type of common:ObservationalTimePeriodType, and a form of unqualified
1297 +
1298 +2. An attribute named id with the type defined previously as [metadata target identifier].TargetObject.ID, and a usage of optional
1299 +
1152 1152  For each metadata target defined in the metadata structure definition, a content group with a recommended name of [metadata target identifier] with be defined. Its content model will be as follows:
1153 1153  
1154 -1. A sequence consisting of:
1155 -11. A local element named ReferenceValue with the type previously defined as [metadata target identifier].ReferenceValueType, a form of unqualified, and a minimum and maximum occurrence of the number of target objects defined within the metadata target
1302 +~1. A sequence consisting of:
1156 1156  
1304 +* a. A local element named ReferenceValue with the type previously defined as [metadata target identifier].ReferenceValueType, a form of unqualified, and a minimum and maximum occurrence of the number of target objects defined within the metadata target
1305 +
1157 1157  For each target object defined by the metadata target, a complex type that must be named [metadata target identifier].[target object identifier] must be created. Its content model will be derived via restriction of the type previously created as [metadata target identifier].ReferenceValueType type created prior to this. The complex type content model will be as follows:
1158 1158  
1159 -1. A choice consisting of:
1160 -11. If the target object is an identifiable object target, a local element named ObjectReference with a type determined as defined in Identifiable Object Target Type Determination:
1161 -11. If the target object is an key descriptor values target, a local element named DataKey with a type of common:DataKeyType, and a form of unqualified
1162 -11. If the target object is a data set target, a local element named DataSetReference with a type of common:SetReferenceType, and a form of unqualified
1163 -11. If the target object is a constraint target, a local element named ConstraintReference with a type of common:AttachmentConstraintReferenceType, and a form of unqualified
1164 -11. If the target object is report period target, a local element named ReportPeriod with a form of unqualified, and a [[type>>path:#_Simple_/_Primitive]] as defined based on the data type of the local representation according to the general rules defined in the previous section
1165 -1. An attribute named id with a type previously created as [metadata target identifier].TargetObject.ID, a usage of optional, and fixed value of the target object identifier
1308 +~1. A choice consisting of:
1166 1166  
1167 -The final complex type (which will be the determined type) is derived by restriction from the reference type determined above. The suggested name of this type is [metadata target identifier].[target object identifier].Reference. The content model of this type will be as follows:
1310 +* a. If the target object is an identifiable object target, a local element named ObjectReference with a type determined as defined in Identifiable Object Target Type Determination:
1311 +* b. If the target object is an key descriptor values target, a local element named DataKey with a type of common:DataKeyType, and a form of unqualified
1312 +* c. If the target object is a data set target, a local element named DataSetReference with a type of common:SetReferenceType, and a form of unqualified
1313 +* d. If the target object is a constraint target, a local element named ConstraintReference with a type of common:AttachmentConstraintReferenceType, and a form of unqualified
1314 +* e. If the target object is report period target, a local element named ReportPeriod with a form of unqualified, and a [[type>>path:#_Simple_/_Primitive]] as defined based on the data type of the local representation according to the general rules defined in the previous section
1168 1168  
1169 -1. A choice consisting of:
1170 -11. A sequence consisting of
1171 -111. A local element named Ref, with a form of unqualified and a the type defined above as is [metadata target].[target object].Ref
1172 -111. A local element named URN, with a form of unqualified, a minimum occurrence of 0, and the type defined above as [item scheme agency].[item scheme identifier].[item scheme version].URN
1173 -11. A local element named URN, with a form of unqualified, and the type defined above as [item scheme agency].[item scheme identifier].[item scheme version].URN
1316 +2. An attribute named id with a type previously created as [metadata target identifier].TargetObject.ID, a usage of optional, and fixed value of the target object identifier
1174 1174  
1318 +The final complex type (which will be the determined type) is derived by restriction from the reference type determined above. The suggested name of this type is [metadata target identifier].[target object identifier].Reference. The content model of this type will be as follows:
1175 1175  
1320 +~1. A choice consisting of:
1176 1176  
1177 -==== Identifiable Object Target Type Determination ====
1322 +* a. A sequence consisting of
1323 +** i. A local element named Ref, with a form of unqualified and a the type defined above as is [metadata target].[target object].Ref
1324 +** ii. A local element named URN, with a form of unqualified, a minimum occurrence of 0, and the type defined above as [item scheme agency].[item scheme identifier].[item scheme version].URN
1325 +* b. A local element named URN, with a form of unqualified, and the type defined above as [item scheme agency].[item scheme identifier].[item scheme version].URN
1178 1178  
1327 +==== 3.5.2.1 Identifiable Object Target Type Determination ====
1328 +
1179 1179  An identifiable object target is meant to reference an SDMX identifiable object. In the metadata structure specific schema, the complex type which defines the reference is restricted according to the local representation and object type of the identifiable object target. If the identifiable object target does not provide an enumeration in its local representation, then the complex type for the target object is the specific reference type from the common namespace, based on the object type defined by the target object. For example, if the object type is DataProivder, the type will be common:DataProviderReferenceType. The general rule for the name of this type is common:[object type]ReferenceType.
1180 1180  
1181 1181  If the target object defines an enumeration in its local representation, then the declared object type must be for the items contained the enumeration's referenced item scheme. If this is not true, the reference type as defined above is the type for the target object.
... ... @@ -1193,18 +1193,20 @@
1193 1193  1. An attribute named maintainableParentVersion with a type of common:VersionType, a use of optional, and a fixed value of the version of the item scheme referenced from the enumeration
1194 1194  1. An attribute named id, with a use of option, and the type defined above as [item scheme agency].[item scheme identifier].[item scheme version].ID.
1195 1195  
1196 -=== ReportType ===
1346 +=== 3.5.3 ReportType ===
1197 1197  
1198 1198  A simple type with a recommend name of Report.ID must be created. This must restrict the common:IDType. For each report structure defined by the metadata structure definition, an enumeration will be created within the restriction with a value of the report structure identifier.
1199 1199  
1200 1200  An abstract complex type with a recommended name of ReportType must be created. Its content model will be derived via restriction of the msd:ReportType. The complex type content model will be as follows:
1201 1201  
1202 -1. A sequence consisting of:
1203 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1204 -11. A local element named Target with the type previously defined as TargetType and a form of unqualified
1205 -11. A local element named AttributeSet with no type assigned and a form of unqualified
1206 -1. An attribute named id with a type previously defined as Report.ID, and a usage of optional
1352 +~1. A sequence consisting of:
1207 1207  
1354 +* a. An element reference to common:Annotations, with a minimum occurrence of 0
1355 +* b. A local element named Target with the type previously defined as TargetType and a form of unqualified
1356 +* c. A local element named AttributeSet with no type assigned and a form of unqualified
1357 +
1358 +2. An attribute named id with a type previously defined as Report.ID, and a usage of optional
1359 +
1208 1208  For each report structure defined in the metadata structure definition, a complex type with its name taken from the report structure identifier must be defined. In order to construct this type, some other complex type must be defined first.
1209 1209  
1210 1210  A simple type with a recommended name of [report structure identifier].Target.ID must be created. This must restrict the type previously created as Target.ID. For each metadata target referenced by the report structure, an enumeration will be created within the restriction with a value of the metadata target identifier.
... ... @@ -1211,10 +1211,12 @@
1211 1211  
1212 1212  An abstract complex type must be create, with a recommended name of [report structure identifier].TargetType. Its content model will be derived by restriction of the type previously created as TargetType. The content model of this type must be as follows:
1213 1213  
1214 -1. A sequence consisting of:
1215 -11. A local element named ReferenceValue with a type of msd:ReferenceValueType, a form of unqualified, and a maximum occurrence of unbounded
1216 -1. An attribute named id with the type previously created as [report structure identifier].Target.ID, and a use of optional
1366 +~1. A sequence consisting of:
1217 1217  
1368 +* a. A local element named ReferenceValue with a type of msd:ReferenceValueType, a form of unqualified, and a maximum occurrence of unbounded
1369 +
1370 +2. An attribute named id with the type previously created as [report structure identifier].Target.ID, and a use of optional
1371 +
1218 1218  For each metadata target referenced from the report structure, a complex type that must be named [report structure identifier].[metadata target identifier] must be created. This type must derived its content by restriction of the type previously defined as [report structure identifier].TargetType. The content model is as follows:
1219 1219  
1220 1220  1. A reference to the content group that was previously created as [metadata target identifier] for this metadata target
... ... @@ -1222,44 +1222,50 @@
1222 1222  
1223 1223  For every metadata attribute defined by the report structure a complex type must be created with the recommended name of [report structure identifier].[nested metadata attribute identifier]. Note that the recommend name assumes the metadata attribute identifier is the nested identifier for the full hierarchy in which the metadata attribute was defined. This content model of this type is derived from restriction of the msd:ReportedAttributeType. The content of this must consists be as follows:
1224 1224  
1225 -1. A sequence consisting of:
1226 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1227 -11. If the isPresentational flag is not set to true:
1228 -111. If the [[determined representation>>path:#_Representation_Determination:]] has data type of XHTML, an element reference to common:StructuredText with a maximum occurrence of unbounded
1229 -111. If the [[determined representation>>path:#_Representation_Determination:]] has is not XHTML, but has a facet of isMultiLinguale, an element reference to common: Text with a maximum occurrence of unbounded
1230 -11. If the metadata attribute defines which child metadata attributes, a local element named AttributeSet with a form of unqualified, and a type as defined according to the rules defined in Attribute Set Complex Type Creation
1231 -1. An attribute named id with a type of common:IDType, a use of optional, and a fixed value of [metadata attribute identifier], where this identifier is not nested
1232 -1. If the isPresentational flag is not set to true, and the [[determined representation>>path:#_Representation_Determination:]] is not XHTML and does not have a facet of isMultiLingual, an attribute named value where the [[type>>path:#_Simple_/_Primitive]] is defined according to the general rules defined in the previous section, and the use is required
1379 +~1. A sequence consisting of:
1233 1233  
1381 +a. An element reference to common:Annotations, with a minimum occurrence of 0
1382 +
1383 +* a. If the isPresentational flag is not set to true:
1384 +* b. If the determined representation has data type of XHTML, an element reference to common:StructuredText with a maximum occurrence of unbounded
1385 +** i. If the determined representation has is not XHTML, but has a facet of isMultiLinguale, an element reference to common: Text with a maximum occurrence of unbounded
1386 +** ii. If the metadata attribute defines which child metadata attributes, a local element named AttributeSet with a form of unqualified, and a type as defined according to the rules defined in Attribute Set Complex Type Creation
1387 +
1388 +2. An attribute named id with a type of common:IDType, a use of optional, and a fixed value of [metadata attribute identifier], where this identifier is not nested
1389 +
1390 +If the isPresentational flag is not set to true, and the determined representation is not XHTML and does not have a facet of isMultiLingual, an attribute named value where the [[type>>path:#_Simple_/_Primitive]] is defined according to the general rules defined in the previous section, and the use is required
1391 +
1234 1234  For each report structure defined in the metadata structure, a complex type that must be named [report structure identifier] must be created. Its content model will be derived via restriction of the previously defined ReportType. The complex type content model will be as follows:
1235 1235  
1236 -1. A sequence consisting of:
1237 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1238 -11. A local element named Target with the type previously defined as [report structure identifier].TargetType, and a form of unqualified. This element must define a uniqueness constraint with a recommended name of [report structure identifier].Target.ReferenceValue.Unique. This uniqueness constraint must contain:
1239 -111. A selector with an xpath of "*"
1240 -111. A field with an xpath of "@id"
1394 +~1. A sequence consisting of:
1241 1241  
1242 -1.
1243 -11. A local element named AttributeSet with a form of unqualified and a type as defined according to the rules defined in Attribute Set Complex Type Creation
1244 -1. An attribute named id with the type previously defined as Report.ID, a use of optional, and a fixed value of [report structure identifier]
1396 +* a. An element reference to common:Annotations, with a minimum occurrence of 0
1397 +* b. A local element named Target with the type previously defined as [report structure identifier].TargetType, and a form of unqualified. This element must define a uniqueness constraint with a recommended name of [report structure identifier].Target.ReferenceValue.Unique. This uniqueness constraint must contain:
1398 +** i. A selector with an xpath of "*"
1399 +** ii. A field with an xpath of "@id"
1400 +* c. A local element named AttributeSet with a form of unqualified and a type as defined according to the rules defined in Attribute Set Complex Type Creation
1245 1245  
1246 -=== Attribute Set Complex Type Creation ===
1402 +2. An attribute named id with the type previously defined as Report.ID, a use of optional, and a fixed value of [report structure identifier]
1247 1247  
1404 +==== 3.5.3.1 Attribute Set Complex Type Creation ====
1405 +
1248 1248  An attribute set is created for a report structure or a metadata attribute which contains child metadata attributes. This type is a complex type with a recommend name of [report structure identifier].[nested metadata attribute identifier].AttributeSet, where the metadata attribute section only applies to attribute sets created for metadata attributes and is assumed to consist of the full hierarchy of the metadata attribute's definition. This complex type must consists of:
1249 1249  
1250 -1. A sequence consisting of:
1251 -11. A local element for each metadata attribute defined as a direct child of the object for which the attribute set is being created. The recommended name of this element is [metadata attribute identifier] and it has a form of unqualified. If the metadata attribute defines a minOccurs and maxOccurs, these values are translated to this element. The type of this element is the type previously created as [report structure identifier].[nested metadata attribute identifier].
1408 +~1. A sequence consisting of:
1252 1252  
1253 -= Special data functions =
1410 +* a. A local element for each metadata attribute defined as a direct child of the object for which the attribute set is being created. The recommended name of this element is [metadata attribute identifier] and it has a form of unqualified. If the metadata attribute defines a minOccurs and maxOccurs, these values are translated to this element. The type of this element is the type previously created as [report structure identifier].[nested metadata attribute identifier].
1254 1254  
1255 -== Updates ==
1412 += 4. Special data functions =
1256 1256  
1414 +== 4.1 Updates ==
1415 +
1257 1257  Both the generic and the structure-specific data messages allow for incremental updating of data. This purpose is noted in the action for the data set, which is either inherited from the header of the data message or explicitly stated at the data set level.
1258 1258  
1259 1259  A dataset with an action of Append is assumed to be an incremental update. This means that one the information provided explicitly in the message should be altered. Any data attribute or observation value that is to be changed must be provided. However, the absence of an observation value or a data attribute at any level does not imply deletion; instead it is simply implied that the value is to remain unchanged. Therefore, it is valid and acceptable to send a data message with an action of Append which contains only a Series elements with attribute values. In this case, the values for the attributes will be updated. Note that it is not permissible to update data attributes using partial keys (outside of those associated with defined groups). In order to update an attribute, a full key must always be provided even if the message format does not require this.
1260 1260  
1261 -== Deletes ==
1262 1262  
1421 +== 4.2 Deletes ==
1422 +
1263 1263  Both the generic and the structure-specific data messages allow for incremental deletion of data. This purpose is noted in the action for the data set, which is either inherited from the header of the data message or explicitly stated at the data set level.
1264 1264  
1265 1265  A dataset with an action of Delete is assumed to be an incremental deletion. The deletion is assumed to take place of the lowest level of detail provided in the message. For example, if a delete message is sent with only a data set element, the entire data set will be deleted. On the other hand, if that data set contains a data attribute, only that data attribute value will be deleted. This same dynamic continues through the data set hierarchy. A data set containing only a series with no data attributes or observations will result in that entire series (all observations and data attributes) being deleted. If the series contains data attributes, only the supplied data attributes for that series will be deleted. Finally, if a series contains observations, then only the specified observations will be deleted. If an entire observation is to be deleted (value and data attributes), only the observation dimension should be provided. If only the observation value or particular data attributes are to be deleted, then these should be specified for the observation. Note that a group can only be used to delete the data attributes associated with it. Although the format might not require it, a full key must be provided to delete a series or observation. It is not permissible to wild card a key in order to delete more than one series or observation. Finally, to delete a data attribute or observation value it is recommended that the value to be deleted be supplied; however, it is only required that any valid value be provided.