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

From version 4.4
edited by Helena
on 2025/06/24 14:50
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,57 +43,66 @@
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  
76 76  Derivation:
83 +
77 77  * //com:AnnotableType// (extension) 
78 78  ** GroupType
79 79  
80 80  Attributes:
88 +
81 81  type
82 82  
83 83  Content:
92 +
84 84  com:Annotations?, GroupKey?, Attributes
85 85  
86 86  Attribute Documentation:
87 87  
88 -|**Name**|**Type**|**Documentation**
89 -|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.
90 90  
91 91  Element Documentation:
92 92  
93 -|**Name**|**Type**|**Documentation**
94 -|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.
95 -|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.
96 -|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.
97 97  
98 98  **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.
99 99  
... ... @@ -103,15 +103,18 @@
103 103  ** SeriesType
104 104  
105 105  Content:
117 +
106 106  com:Annotations?, SeriesKey, Attributes?, Obs*
107 107  
108 108  Element Documentation:
109 -|**Name**|**Type**|**Documentation**
110 -|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.
111 -|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.
112 -|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.
113 -|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.
114 114  
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.
128 +
115 115  **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.
116 116  
117 117  Derivation:
... ... @@ -120,15 +120,18 @@
120 120  ** ObsOnlyType
121 121  
122 122  Content:
137 +
123 123  com:Annotations?, ObsKey, ObsValue?, Attributes?
124 124  
125 125  Element Documentation:
126 -|**Name**|**Type**|**Documentation**
127 -|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.
128 -|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.
129 -|ObsValue|ObsValueType|ObsValue type contains the value for the observation.
130 -|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).
131 131  
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).
148 +
132 132  **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.
133 133  
134 134  Derivation:
... ... @@ -137,37 +137,47 @@
137 137  ** ObsType
138 138  
139 139  Content:
157 +
140 140  com:Annotations?, ObsDimension, ObsValue?, Attributes?
141 141  
142 142  Element Documentation:
143 -|**Name**|**Type**|**Documentation**
144 -|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.
145 -|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.
146 -|ObsValue|ObsValueType|ObsValue type contains the value for the observation.
147 -|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).
148 148  
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).
168 +
149 149  **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.
150 150  
151 151  Content:
172 +
152 152  Value+
153 153  
154 154  Element Documentation:
155 -|**Name**|**Type**|**Documentation**
156 -|Value|ComponentValueType|Value contains a component value and a reference to the component for which a value is being provided.
157 157  
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.
180 +
158 158  **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.
159 159  
160 160  Attributes:
184 +
161 161  id?, value
162 162  
163 163  Content:
188 +
164 164  {Empty}
165 165  
166 166  Attribute Documentation:
167 -|**Name**|**Type**|**Documentation**
168 -|id|com:NCNameIDType|The id attribute contains the identifier for the component for which a value is being provided.
169 -|value|xs:anySimpleType|The value attribute contains the provided component value.
170 170  
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.
197 +
171 171  **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.
172 172  
173 173  Derivation:
... ... @@ -176,188 +176,229 @@
176 176  ** ObsValueType
177 177  
178 178  Attributes:
206 +
179 179  id?, value
180 180  
181 181  Content:
210 +
182 182  {Empty}
183 183  
184 184  Attribute Documentation:
185 -|**Name**|**Type**|**Documentation**
186 -|id (fixed: OBS_VALUE)|com:NCNameIDType|The id attribute contains a fixed reference to the primary measure component of the data structure definition.
187 -|value|xs:string|The value attribute contains the provided component value.
188 188  
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.
219 +
189 189  **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.
190 190  
191 191  Derivation:
223 +
192 192  * BaseValueType (restriction) 
193 193  ** ComponentValueType
194 194  
195 195  Attributes:
228 +
196 196  id, value
197 197  
198 198  Content:
232 +
199 199  {Empty}
200 200  
201 201  Attribute Documentation:
202 -|**Name**|**Type**|**Documentation**
203 -|id|com:NCNameIDType|The id attribute contains the identifier for the component for which a value is being provided.
204 -|value|xs:string|The value attribute contains the provided component value.
205 205  
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.
241 +
206 206  **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.
207 207  
208 208  Derivation:
245 +
209 209  * //com:AnnotableType// (extension) 
210 210  ** DataSetType (restriction) 
211 211  *** TimeSeriesDataSetType
212 212  
213 213  Attributes:
251 +
214 214  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?
215 215  
216 216  Content:
255 +
217 217  com:Annotations?, DataProvider?, Attributes?, Group*, Series*
218 218  
219 219  Attribute Documentation:
220 -|**Name**|**Type**|**Documentation**
221 -|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).
222 -|setID|com:IDType|The setID provides an identification of the data or metadata set.
223 -|action|com:ActionType|The action attribute indicates whether the file is appending, replacing, or deleting.
224 -|reportingBeginDate|com: BasicTimePeriodType|The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set.
225 -|reportingEndDate|com: BasicTimePeriodType|The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.
226 -|validFromDate|xs:dateTime|The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set.
227 -|validToDate|xs:dateTime|The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set.
228 -|publicationYear|xs:gYear|The publicationYear holds the ISO 8601 four-digit year.
229 -|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).
230 230  
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).
271 +
231 231  Element Documentation:
232 232  
233 -|**Name**|**Type**|**Documentation**
234 -|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.
235 -|DataProvider|com: DataProviderReferenc eType|DataProvider contains a reference to the provider for the data set.
236 -|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.
237 -|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.
238 -|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.
239 239  
240 240  **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.
241 241  
242 242  Derivation:
285 +
243 243  * //com:AnnotableType// (extension) 
244 244  ** SeriesType (restriction) 
245 245  *** TimeSeriesType
246 246  
247 247  Content:
291 +
248 248  com:Annotations?, SeriesKey, Attributes?, Obs*
249 249  
250 250  Element Documentation:
251 -|**Name**|**Type**|**Documentation**
252 -|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.
253 -|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.
254 -|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.
255 -|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.
256 256  
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.
302 +
257 257  **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.
258 258  
259 259  Derivation:
306 +
260 260  * //com:AnnotableType// (extension) 
261 261  ** ObsType (restriction) 
262 262  *** TimeSeriesObsType
263 263  
264 264  Content:
312 +
265 265  com:Annotations?, ObsDimension, ObsValue?, Attributes?
266 266  
267 267  Element Documentation:
268 -|**Name**|**Type**|**Documentation**
269 -|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.
270 -|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.
271 -|ObsValue|ObsValueType|ObsValue type contains the value for the observation.
272 -|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).
273 273  
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).
323 +
274 274  **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.
275 275  
276 276  Derivation:
327 +
277 277  * BaseValueType (restriction) 
278 278  ** TimeValueType
279 279  
280 280  Attributes:
332 +
281 281  id?, value
282 282  
283 283  Content:
336 +
284 284  {Empty}
285 285  
286 286  Attribute Documentation:
287 -|**Name**|**Type**|**Documentation**
288 -|id (fixed: TIME_PERIOD)|com:NCNameIDType|The id attribute contains the identifier for the component for which a value is being provided.
289 -|value|com: ObservationalTimePer iodType|The value attribute contains the provided component value.
290 290  
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.
345 +
291 291  == 2.2 Structure Specific Data Namespace ==
292 292  
293 293  **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/data/structurespecific**
294 294  
295 -=== Summary ===
350 +=== 2.2.1 Summary ===
296 296  
297 297  Referenced Namespaces:
298 -|**Namespace**|**Prefix**
299 -| |
300 -|http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|com
301 -|http:~/~/www.w3.org/2001/XMLSchema|xs
302 302  
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
358 +
303 303  Contents:
360 +
304 304  7 Complex Types
305 305  1 Simple Type
306 306  
307 -=== Complex Types ===
364 +=== 2.2.2 Complex Types ===
308 308  
309 309  **//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.
310 310  
311 311  Derivation:
312 -* //com:AnnotableType// (extension) 
369 +
370 +* //com:AnnotableType// (extension)
313 313  ** //DataSetType//
314 314  
315 315  Attributes:
374 +
316 316  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?, dataScope, REPORTING_YEAR_START_DAY?
317 317  
318 318  Content:
378 +
319 319  com:Annotations?, DataProvider?, Group*, (Series+ | Obs+)?
320 320  
321 321  Attribute Documentation:
322 -|**Name**|**Type**|**Documentation**
323 -|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).
324 -|setID|com:IDType|The setID provides an identification of the data or metadata set.
325 -|action|com:ActionType|The action attribute indicates whether the file is appending, replacing, or deleting.
326 -|reportingBeginDate|com: BasicTimePeriodType|The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set.
327 -|reportingEndDate|com: BasicTimePeriodType|The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.
328 -|validFromDate|xs:dateTime|The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set.
329 -|validToDate|xs:dateTime|The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set.
330 -|publicationYear|xs:gYear|The publicationYear holds the ISO 8601 four-digit year.
331 -|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).
332 -|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.
333 -|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.
334 334  
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.
396 +
335 335  Element Documentation:
336 336  
337 -|**Name**|**Type**|**Documentation**
338 -|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.
339 -|DataProvider|com: DataProviderReferenc eType|DataProvider contains a reference to the provider for the data set.
340 -|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.
341 -|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.
342 -|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).
343 343  
344 344  **//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.
345 345  
346 346  Derivation:
410 +
347 347  * //com:AnnotableType// (extension) 
348 348  ** //GroupType//
349 349  
350 350  Attributes:
415 +
351 351  type?, REPORTING_YEAR_START_DAY?
352 352  
353 353  Content:
419 +
354 354  com:Annotations?
355 355  
356 356  Attribute Documentation:
357 -|**Name**|**Type**|**Documentation**
358 -|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.
359 -|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.
360 360  
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.
428 +
361 361  Element Documentation:
362 362  
363 363  |**Name**|**Type**|**Documentation**
... ... @@ -366,20 +366,25 @@
366 366  **//SeriesType//: **SeriesType is the abstract type which defines a structure which is used to group a collection of observations which have a key in common. The key for a series is every dimension defined in the data structure definition, save the dimension declared to be at the observation level for this data set. 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. Data structure definition schemas will drive a type based on this that is specific to the data structure definition and the variation of the format being expressed in the schema. Both the dimension values which make up the key and the attribute values associated with the key dimensions will be represented with XML attributes. This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived series type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). The dimension XML attributes will be required while the attribute XML attributes will be optional. To allow for generic processing, it is required that the only unqualified XML attributes in the derived group type be for the series dimensions and attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition dimension or attribute.
367 367  
368 368  Derivation:
437 +
369 369  * //com:AnnotableType// (extension) 
370 370  ** //SeriesType//
371 371  
372 372  Attributes:
442 +
373 373  TIME_PERIOD?, REPORTING_YEAR_START_DAY?
374 374  
375 375  Content:
446 +
376 376  com:Annotations?, Obs*
377 377  
378 378  Attribute Documentation:
379 -|**Name**|**Type**|**Documentation**
380 -|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.
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 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.
382 382  
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.
455 +
383 383  Element Documentation:
384 384  
385 385  |**Name**|**Type**|**Documentation**
... ... @@ -390,8 +390,8 @@
390 390  
391 391  Derivation:
392 392  
393 -//com:AnnotableType// (extension) 
394 - //ObsType//
466 +* //com:AnnotableType// (extension) 
467 +** //ObsType//
395 395  
396 396  Attributes:
397 397  
... ... @@ -403,11 +403,12 @@
403 403  
404 404  Attribute Documentation:
405 405  
406 -|**Name**|**Type**|**Documentation**
407 -|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.
408 -|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.
409 -|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.
410 -|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.
411 411  
412 412  Element Documentation:
413 413  
... ... @@ -418,9 +418,9 @@
418 418  
419 419  Derivation:
420 420  
421 -//com:AnnotableType// (extension) 
422 - //DataSetType// (restriction) 
423 - //TimeSeriesDataSetType//
495 +* //com:AnnotableType// (extension) 
496 +** //DataSetType// (restriction) 
497 +*** //TimeSeriesDataSetType//
424 424  
425 425  Attributes:
426 426  
... ... @@ -432,34 +432,36 @@
432 432  
433 433  Attribute Documentation:
434 434  
435 -|**Name**|**Type**|**Documentation**
436 -|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).
437 -|setID|com:IDType|The setID provides an identification of the data or metadata set.
438 -|action|com:ActionType|The action attribute indicates whether the file is appending, replacing, or deleting.
439 -|reportingBeginDate|com: BasicTimePeriodType|The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set.
440 -|reportingEndDate|com: BasicTimePeriodType|The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.
441 -|validFromDate|xs:dateTime|The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set.
442 -|validToDate|xs:dateTime|The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set.
443 -|publicationYear|xs:gYear|The publicationYear holds the ISO 8601 four-digit year.
444 -|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).
445 -|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.
446 -|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.
447 447  
448 448  Element Documentation:
449 449  
450 -|**Name**|**Type**|**Documentation**
451 -|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.
452 -|DataProvider|com: DataProviderReferenc eType|DataProvider contains a reference to the provider for the data set.
453 -|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.
454 -|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.
455 455  
456 456  **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.
457 457  
458 458  Derivation:
459 459  
460 -//com:AnnotableType// (extension) 
461 - //SeriesType// (restriction) 
462 - TimeSeriesType
536 +* //com:AnnotableType// (extension) 
537 +** //SeriesType// (restriction) 
538 +*** TimeSeriesType
463 463  
464 464  Attributes:
465 465  
... ... @@ -471,22 +471,24 @@
471 471  
472 472  Attribute Documentation:
473 473  
474 -|**Name**|**Type**|**Documentation**
475 -|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.
476 476  
477 477  Element Documentation:
478 478  
479 -|**Name**|**Type**|**Documentation**
480 -|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.
481 -|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" %)
482 482  
483 483  **//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.
484 484  
485 485  Derivation:
486 486  
487 -//com:AnnotableType// (extension) 
488 - //ObsType// (restriction) 
489 - //TimeSeriesObsType//
565 +* //com:AnnotableType// (extension) 
566 +** //ObsType// (restriction) 
567 +*** //TimeSeriesObsType//
490 490  
491 491  Attributes:
492 492  
... ... @@ -498,19 +498,19 @@
498 498  
499 499  Attribute Documentation:
500 500  
501 -|**Name**|**Type**|**Documentation**
502 -|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.
503 -|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.
504 -|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.
505 505  
506 506  Element Documentation:
507 507  
508 -|**Name**|**Type**|**Documentation**
509 -|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.
510 510  
511 -1.
512 -11.
513 -111. Simple Types
591 +=== 2.2.3 Simple Types ===
514 514  
515 515  **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.
516 516  
... ... @@ -518,41 +518,38 @@
518 518  
519 519  Enumerations:
520 520  
521 -|**Value**|**Documentation**
522 -|DataStructure|The data set conforms simply to the data structure definition as it is defined, without regard to any constraints.
523 -|ConstrainedDataStructure|The data set conforms to the known allowable content constraints applied to the data structure definition.
524 -|Dataflow|The data set conforms to the known allowable content constraints applied to the dataflow.
525 -|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.
526 526  
527 -1.
528 -11. Generic Metadata Namespace
606 +== 2.3 Generic Metadata Namespace ==
529 529  
530 530  **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/metadata/generic**
531 531  
532 -1.
533 -11.
534 -111. Summary
610 +=== 2.3.1 Summary ===
535 535  
536 536  Referenced Namespaces:
537 537  
538 -|**Namespace**|**Prefix**
539 -|http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|com
540 -|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
541 541  
542 542  Contents:
543 543  
544 544  6 Complex Types
545 545  
546 -1.
547 -11.
548 -111. Complex Types
623 +=== 2.3.2 Complex Types ===
549 549  
550 550  **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.
551 551  
552 552  Derivation:
553 553  
554 -//com:AnnotableType// (extension) 
555 - MetadataSetType
629 +* //com:AnnotableType// (extension) 
630 +** MetadataSetType
556 556  
557 557  Attributes:
558 558  
... ... @@ -564,31 +564,33 @@
564 564  
565 565  Attribute Documentation:
566 566  
567 -|**Name**|**Type**|**Documentation**
568 -|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).
569 -|setID|com:IDType|The setID provides an identification of the data or metadata set.
570 -|action|com:ActionType|The action attribute indicates whether the file is appending, replacing, or deleting.
571 -|reportingBeginDate|com: BasicTimePeriodType|The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set.
572 -|reportingEndDate|com: BasicTimePeriodType|The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.
573 -|validFromDate|xs:dateTime|The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set.
574 -|validToDate|xs:dateTime|The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set.
575 -|publicationYear|xs:gYear|The publicationYear holds the ISO 8601 four-digit year.
576 -|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).
577 577  
578 578  Element Documentation:
579 579  
580 -|**Name**|**Type**|**Documentation**
581 -|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.
582 -|com:Name|com:TextType|Name is a reusable element, used for providing a human-readable name for an object.
583 -|DataProvider|com: DataProviderReferenc eType|DataProviderReference provides a references to an organisation with the role of data provider that is providing this metadata set.
584 -|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.
585 585  
586 586  **ReportType: **ReportType contains a set of report attributes and identifies a target objects] to which they apply.
587 587  
588 588  Derivation:
589 589  
590 -//com:AnnotableType// (extension) 
591 - ReportType
667 +* //com:AnnotableType// (extension) 
668 +** ReportType
592 592  
593 593  Attributes:
594 594  
... ... @@ -600,15 +600,17 @@
600 600  
601 601  Attribute Documentation:
602 602  
603 -|**Name**|**Type**|**Documentation**
604 -|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.
605 605  
606 606  Element Documentation:
607 607  
608 -|**Name**|**Type**|**Documentation**
609 -|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.
610 -|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.
611 -|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.
612 612  
613 613  **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.
614 614  
... ... @@ -622,13 +622,15 @@
622 622  
623 623  Attribute Documentation:
624 624  
625 -|**Name**|**Type**|**Documentation**
626 -|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.
627 627  
628 628  Element Documentation:
629 629  
630 -|**Name**|**Type**|**Documentation**
631 -|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.
632 632  
633 633  **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.
634 634  
... ... @@ -642,17 +642,19 @@
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  
... ... @@ -662,15 +662,16 @@
662 662  
663 663  Element Documentation:
664 664  
665 -|**Name**|**Type**|**Documentation**
666 -|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.
667 667  
668 668  **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.
669 669  
670 670  Derivation:
671 671  
672 -//com:AnnotableType// (extension) 
673 - ReportedAttributeType
756 +* //com:AnnotableType// (extension) 
757 +** ReportedAttributeType
674 674  
675 675  Attributes:
676 676  
... ... @@ -682,48 +682,46 @@
682 682  
683 683  Attribute Documentation:
684 684  
685 -|**Name**|**Type**|**Documentation**
686 -|id|com:IDType|The id attribute identifies the metadata attribute that the value is being reported for.
687 -|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.
688 688  
689 689  Element Documentation:
690 690  
691 -|**Name**|**Type**|**Documentation**
692 -|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.
693 -|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.
694 -|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.
695 -|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.
696 696  
697 -1.
698 -11. Structure Specific Metadata Namespace
783 +== 2.4 Structure Specific Metadata Namespace ==
699 699  
700 700  **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/metadata/structurespecific**
701 701  
702 -1.
703 -11.
704 -111. Summary
787 +=== 2.4.1 Summary ===
705 705  
706 706  Referenced Namespaces:
707 707  
708 -|**Namespace**|**Prefix**
709 -| |
710 -|http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|com
711 -|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
712 712  
713 713  Contents:
714 714  
715 715  5 Complex Types
716 716  
717 -1.
718 -11.
719 -111. Complex Types
801 +=== 2.4.2 Complex Types ===
720 720  
721 721  **//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.
722 722  
723 723  Derivation:
724 724  
725 -//com:AnnotableType// (extension) 
726 - //MetadataSetType//
807 +* //com:AnnotableType// (extension) 
808 +** //MetadataSetType//
727 727  
728 728  Attributes:
729 729  
... ... @@ -735,31 +735,33 @@
735 735  
736 736  Attribute Documentation:
737 737  
738 -|**Name**|**Type**|**Documentation**
739 -|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).
740 -|setID|com:IDType|The setID provides an identification of the data or metadata set.
741 -|action|com:ActionType|The action attribute indicates whether the file is appending, replacing, or deleting.
742 -|reportingBeginDate|com: BasicTimePeriodType|The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set.
743 -|reportingEndDate|com: BasicTimePeriodType|The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.
744 -|validFromDate|xs:dateTime|The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set.
745 -|validToDate|xs:dateTime|The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set.
746 -|publicationYear|xs:gYear|The publicationYear holds the ISO 8601 four-digit year.
747 -|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).
748 748  
749 749  Element Documentation:
750 750  
751 -|**Name**|**Type**|**Documentation**
752 -|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.
753 -|com:Name|com:TextType|Name is a reusable element, used for providing a human-readable name for an object.
754 -|DataProvider|com: DataProviderReferenc eType|>DataProviderReference provides a references to an organisation with the role of data provider that is providing this metadata set.
755 -|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.
756 756  
757 757  **//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.
758 758  
759 759  Derivation:
760 760  
761 -//com:AnnotableType// (extension) 
762 - //ReportType//
845 +* //com:AnnotableType// (extension) 
846 +** //ReportType//
763 763  
764 764  Attributes:
765 765  
... ... @@ -771,15 +771,17 @@
771 771  
772 772  Attribute Documentation:
773 773  
774 -|**Name**|**Type**|**Documentation**
775 -|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.
776 776  
777 777  Element Documentation:
778 778  
779 -|**Name**|**Type**|**Documentation**
780 -|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.
781 -|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.
782 -|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.
783 783  
784 784  **//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.
785 785  
... ... @@ -793,13 +793,15 @@
793 793  
794 794  Attribute Documentation:
795 795  
796 -|**Name**|**Type**|**Documentation**
797 -|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.
798 798  
799 799  Element Documentation:
800 800  
801 -|**Name**|**Type**|**Documentation**
802 -|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.
803 803  
804 804  **//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.
805 805  
... ... @@ -813,24 +813,26 @@
813 813  
814 814  Attribute Documentation:
815 815  
816 -|**Name**|**Type**|**Documentation**
817 -|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.
818 818  
819 819  Element Documentation:
820 820  
821 -|**Name**|**Type**|**Documentation**
822 -|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.
823 -|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.
824 -|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.
825 -|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.
826 -|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.
827 827  
828 828  **//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.
829 829  
830 830  Derivation:
831 831  
832 -//com:AnnotableType// (extension) 
833 - //ReportedAttributeType//
922 +* //com:AnnotableType// (extension) 
923 +** //ReportedAttributeType//
834 834  
835 835  Attributes:
836 836  
... ... @@ -842,41 +842,43 @@
842 842  
843 843  Attribute Documentation:
844 844  
845 -|**Name**|**Type**|**Documentation**
846 -|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.
847 -|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.
848 -|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.
849 849  
850 850  Element Documentation:
851 851  
852 -|**Name**|**Type**|**Documentation**
853 -|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.
854 -|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.
855 -|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.
856 -|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.
857 857  
858 -1. Mapping to Structure-Specific Schemas
859 -11. General
950 += 3. Mapping to Structure-Specific Schemas =
860 860  
952 +== 3.1 General ==
953 +
861 861  Data structure and metadata structure-specific schemas are each based on one single core construct found in their respective structure-specific namespaces;
862 862  
863 -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
864 864  
865 865  Metadata - http:~/~/www.SDMX.org/resources/SDMXML/schemas/v2_1/data/structurespecific
866 866  
867 867  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.
868 868  
869 -1.
870 -11.
871 -111. Basic Terminology
962 +=== 3.1.1 Basic Terminology ===
872 872  
873 873  In the subsequent sections, the following namespace prefixes are used:
874 874  
875 -|**Namespace**|**Prefix**
876 -|http:~/~/www.w3.org/2001/XMLSchema|xs
877 -|http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|common
878 -|http:~/~/www.sdmx.org/resources/sdmxml/schemas/ v2_1/data/structurespecific|dsd
879 -|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
880 880  
881 881  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:
882 882  
... ... @@ -914,8 +914,7 @@
914 914  
915 915  **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).
916 916  
917 -1.
918 -11. Namespace Rules
1009 +== 3.2 Namespace Rules ==
919 919  
920 920  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.
921 921  
... ... @@ -923,22 +923,19 @@
923 923  
924 924  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".
925 925  
926 -1.
927 -11. General Rules
1017 +== 3.3 General Rules ==
928 928  
929 929  The following section details the general rules which apply to all structure specific schema creation.
930 930  
931 -1.
932 -11.
933 -111. Component Name Determination
1021 +=== 3.3.1 Component Name Determination ===
934 934  
935 935  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:
936 936  
937 937  1. If the component defines an identifier, the element or attribute name is the value of that identifier
938 938  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).
939 -11.
940 -111. Representation Determination
941 941  
1028 +=== 3.3.2 Representation Determination ===
1029 +
942 942  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).
943 943  
944 944  The representation of a component is determined by the following precedence:
... ... @@ -951,103 +951,90 @@
951 951  
952 952  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.
953 953  
954 -1.
955 -11.
956 -111. Simple / Primitive Type Determination
1042 +=== 3.3.3 Simple / Primitive Type Determination ===
957 957  
958 -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.
959 959  
960 960  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.
961 961  
962 -1.
963 -11.
964 -111. Representation with Enumeration
1048 +=== 3.3.4 Representation with Enumeration ===
965 965  
966 966  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:
967 967  
1052 +> <xs:simpleType name="ESTAT.CL_COUNTRY.1.0">
1053 +> <xs:restriction base="common:IDType">
1054 +> <xs:enumeration value="BE">
1055 +> <xs:annotation>
1056 +> <xs:documentation xml:lang="en">Belgium</xs:documentation>
1057 +> </xs:annotation>
1058 +> </xs:enumeration>
968 968  
969 -<xs:simpleType name="ESTAT.CL_COUNTRY.1.0">
970 970  
971 -<xs:restriction base="common:IDType">
1061 +=== 3.3.5 Representation with Text Format ===
972 972  
973 -<xs:enumeration value="BE">
974 -
975 -<xs:annotation>
976 -
977 -<xs:documentation xml:lang="en">Belgium</xs:documentation>
978 -
979 -</xs:annotation>
980 -
981 -</xs:enumeration>
982 -
983 -
984 -1.
985 -11.
986 -111. Representation with Text Format
987 -
988 988  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:
989 989  
990 -|**SDMX Data Type**|**XML Schema Data Type**
991 -|String|xs:string
992 -|AlphaNumeric|common:AlphaNumericType
993 -|Alpha|common:AlphaType
994 -|Numeric|common:NumericType
995 -|BigInteger|xs:integer
996 -|Integer|xs:int
997 -|Long|xs:long
998 -|Short|xs:short
999 -|Decimal|xs:decimal
1000 -|Float|xs:float
1001 -|Double|xs:double
1002 -|Boolean|xs:boolean
1003 -|URI|xs:anyURI
1004 -|Count|xs:integer
1005 -|InclusiveValueRange|xs:decimal
1006 -|ExclusiveValueRange|xs: decimal
1007 -|Incremental|xs: decimal
1008 -|ObservationalTimePeriod|common:ObservationalTimePeriodType
1009 -|StandardTimePeriod|common:StandardTimePeriodType
1010 -|BasicTimePeriod|common:BasicTimePeriodType
1011 -|GregorianTimePeriod|common:GregorianTimePeriodType
1012 -|GregorianYear|xs:gYear
1013 -|GregorianYearMonth|xs:gYearMonth
1014 -|GregorianDay|xs:date
1015 -|ReportingTimePeriod|common:ReportingTimePeriodType
1016 -|ReportingYear|common:ReportingYearType
1017 -|ReportingSemester|common:ReportingSemesterType
1018 -|ReportingTrimester|common:ReportingTrimesterType
1019 -|ReportingQuarter|common:ReportingQuarterType
1020 -|ReportingMonth|common:ReportingMonthType
1021 -|ReportingWeek|common:ReportingWeekType
1022 -|ReportingDay|common:ReportingDayType
1023 -|DateTime|xs:dateTime
1024 -|TimeRange|common:TimeRangeType
1025 -|Month|xs:gMonth
1026 -|MonthDay|xs:gMonthDay
1027 -|Day|xs:gDay
1028 -|Time|xs:time
1029 -|Duration|xs:duration
1030 -|XHTML|N/A[[~[1~]>>path:#_ftn1]]
1031 -|KeyValues|N/A^^1^^
1032 -|IdentifiableReference|N/A^^1^^
1033 -|DataSetReference|N/A^^1^^
1034 -|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^^
1035 1035  
1036 1036  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):
1037 1037  
1038 -|**SDMX Facet**|**XML Schema Facet**
1039 -|minLength|xs:minLength
1040 -|maxLength|xs:maxLength
1041 -|minValue[[~[2~]>>path:#_ftn2]]|if ExclusiveValueRange: xs:minExclusives, else: xs:minInclusive
1042 -|maxValue^^2^^|if ExclusiveValueRange: xs:maxExclusives, else: xs:maxInclusive
1043 -|decimals^^2^^|xs:fractionDigits
1044 -|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
1045 1045  
1046 1046  Any other facets are informational only, and will not affect the determined type.
1047 1047  
1048 -1.
1049 -11.
1050 -111. //Type Names//
1125 +=== 3.3.6 Type Names ===
1051 1051  
1052 1052  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.
1053 1053  
... ... @@ -1056,130 +1056,157 @@
1056 1056  * If the type is based on a text format of a component local representation, and;
1057 1057  ** 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]
1058 1058  ** 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]
1059 -**1. Type Reuse
1060 1060  
1135 +=== 3.3.7 Type Reuse ===
1136 +
1061 1061  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.
1062 1062  
1063 1063  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:
1064 1064  
1065 -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.
1066 1066  
1067 -Yes: Is that type enumerated?
1068 -
1069 -Yes: Type is the qualified type name for the item scheme
1070 -
1071 -No: Generate simple type for text format
1072 -
1073 -No: Type is the qualified name for the concept from which the component takes its semantic.
1074 -
1075 1075  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.
1076 1076  
1077 -1.
1078 -11. Data Structure Specific Schema
1149 +== 3.4 Data Structure Specific Schema ==
1079 1079  
1080 1080  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.
1081 1081  
1082 1082  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.
1083 1083  
1084 -1.
1085 -11.
1086 -111. DataSetType
1155 +=== 3.4.1 DataSetType ===
1087 1087  
1088 1088  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:
1089 1089  
1090 -1. A sequence consisting of:
1091 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1092 -11. A local element named DataProvider with the type common:DataProviderReferenceType, a form of unqualified and a minimum occurrence of 0
1093 -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.
1094 -11. A choice with a minimum occurrence of 0 consisting of:
1095 -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)
1096 -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)
1097 -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
1098 -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
1099 -11.
1100 -111. GroupType
1159 +~1. A sequence consisting of:
1101 1101  
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)
1167 +
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 +
1102 1102  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:
1103 1103  
1104 -1. A sequence consisting of:
1105 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1106 -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
1107 -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
1108 -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
1109 -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:
1110 1110  
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 +
1111 1111  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:
1112 1112  
1113 -1. A sequence consisting of:
1114 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1115 -1. An attribute named type with a type of Group.ID, and a usage of optional
1116 -1. An anyAttribute declaration with a namespace of ~#~#local
1190 +~1. A sequence consisting of:
1117 1117  
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 +
1118 1118  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.
1119 1119  
1120 1120  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:
1121 1121  
1122 -1. A sequence consisting of:
1123 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1124 -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
1125 -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
1126 -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
1127 -1. An attribute named type with a type of Group.ID, usage of optional, and a fixed value of the identifier of the group
1128 -11.
1129 -111. SeriesType
1202 +~1. A sequence consisting of:
1130 1130  
1204 +* a. An element reference to common:Annotations, with a minimum occurrence of 0
1205 +
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 +
1131 1131  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:
1132 1132  
1133 -1. A sequence consisting of:
1134 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1135 -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)
1136 -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
1137 -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
1138 -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
1139 -11.
1140 -111. ObsType
1218 +~1. A sequence consisting of:
1141 1141  
1220 +* a. An element reference to common:Annotations, with a minimum occurrence of 0
1221 +
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 +
1142 1142  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:
1143 1143  
1144 -1. A sequence consisting of:
1145 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1146 -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
1147 -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
1148 -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
1149 -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
1150 -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:
1151 1151  
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 +
1152 1152  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:
1153 1153  
1154 -1. A sequence consisting of:
1155 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1156 -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
1157 -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.
1158 -11. Metadata Structure Specific Schema
1250 +~1. A sequence consisting of:
1159 1159  
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 +
1160 1160  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.
1161 1161  
1162 1162  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.
1163 1163  
1164 -1.
1165 -11.
1166 -111. MetadataSetType
1264 +=== 3.5.1 MetadataSetType ===
1167 1167  
1168 1168  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:
1169 1169  
1170 -1. A sequence consisting of:
1171 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1172 -11. An element reference to common:Name, with a minimum occurrence of 0 and a maximum occurrence of unbounded
1173 -11. A local element named DataProvider with the type common:DataProviderReferenceType, a form of unqualified and a minimum occurrence of 0
1174 -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.
1175 -111. TargetType
1268 +~1. A sequence consisting of:
1176 1176  
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 +
1177 1177  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:
1178 1178  
1179 -1. A sequence consisting of:
1180 -11. A local element named ReferenceValue with a type of msd:ReferenceValueType, a form of unqualified, and a maximum occurrence of unbounded
1181 -1. An attribute named id with a type of Target.ID, and a usage of optional
1279 +~1. A sequence consisting of:
1182 1182  
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 +
1183 1183  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.
1184 1184  
1185 1185  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.
... ... @@ -1186,38 +1186,44 @@
1186 1186  
1187 1187  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:
1188 1188  
1189 -1. A choice consisting of:
1190 -11. A local element named ObjectReference with a type of common:ReferenceType, and a form of unqualified
1191 -11. A local element named DataKey with a type of common:DataKeyType, and a form of unqualified
1192 -11. A local element named DataSetReference with a type of common:SetReferenceType, and a form of unqualified
1193 -11. A local element named ReportPeriod with a type of common:ObservationalTimePeriodType, and a form of unqualified
1194 -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:
1195 1195  
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 +
1196 1196  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:
1197 1197  
1198 -1. A sequence consisting of:
1199 -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:
1200 1200  
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 +
1201 1201  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:
1202 1202  
1203 -1. A choice consisting of:
1204 -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:
1205 -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
1206 -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
1207 -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
1208 -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
1209 -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:
1210 1210  
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
1315 +
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
1317 +
1211 1211  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:
1212 1212  
1213 -1. A choice consisting of:
1214 -11. A sequence consisting of
1215 -111. A local element named Ref, with a form of unqualified and a the type defined above as is [metadata target].[target object].Ref
1216 -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
1217 -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
1218 -111.
1219 -1111. Identifiable Object Target Type Determination
1320 +~1. A choice consisting of:
1220 1220  
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
1326 +
1327 +==== 3.5.2.1 Identifiable Object Target Type Determination ====
1328 +
1221 1221  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.
1222 1222  
1223 1223  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.
... ... @@ -1234,19 +1234,21 @@
1234 1234  1. An attribute named maintinableParentID with a type of common:IDType, a use of required, and a fixed value of the identifier of the item scheme referenced from the enumeration
1235 1235  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
1236 1236  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.
1237 -11.
1238 -111. ReportType
1239 1239  
1346 +=== 3.5.3 ReportType ===
1347 +
1240 1240  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.
1241 1241  
1242 1242  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:
1243 1243  
1244 -1. A sequence consisting of:
1245 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1246 -11. A local element named Target with the type previously defined as TargetType and a form of unqualified
1247 -11. A local element named AttributeSet with no type assigned and a form of unqualified
1248 -1. An attribute named id with a type previously defined as Report.ID, and a usage of optional
1352 +~1. A sequence consisting of:
1249 1249  
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 +
1250 1250  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.
1251 1251  
1252 1252  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.
... ... @@ -1253,10 +1253,12 @@
1253 1253  
1254 1254  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:
1255 1255  
1256 -1. A sequence consisting of:
1257 -11. A local element named ReferenceValue with a type of msd:ReferenceValueType, a form of unqualified, and a maximum occurrence of unbounded
1258 -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:
1259 1259  
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 +
1260 1260  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:
1261 1261  
1262 1262  1. A reference to the content group that was previously created as [metadata target identifier] for this metadata target
... ... @@ -1264,54 +1264,54 @@
1264 1264  
1265 1265  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:
1266 1266  
1267 -1. A sequence consisting of:
1268 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1269 -11. If the isPresentational flag is not set to true:
1270 -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
1271 -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
1272 -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
1273 -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
1274 -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:
1275 1275  
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 +
1276 1276  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:
1277 1277  
1278 -1. A sequence consisting of:
1279 -11. An element reference to common:Annotations, with a minimum occurrence of 0
1280 -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:
1281 -111. A selector with an xpath of "*"
1282 -111. A field with an xpath of "@id"
1394 +~1. A sequence consisting of:
1283 1283  
1284 -1.
1285 -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
1286 -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]
1287 -11.
1288 -111.
1289 -1111. Attribute Set Complex Type Creation
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
1290 1290  
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]
1403 +
1404 +==== 3.5.3.1 Attribute Set Complex Type Creation ====
1405 +
1291 1291  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:
1292 1292  
1293 -1. A sequence consisting of:
1294 -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:
1295 1295  
1296 -1. Special data functions
1297 -11. Updates
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].
1298 1298  
1299 -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.
1412 += 4. Special data functions =
1300 1300  
1414 +== 4.1 Updates ==
1301 1301  
1416 +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.
1417 +
1302 1302  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.
1303 1303  
1304 -1.
1305 -11. Deletes
1306 1306  
1421 +== 4.2 Deletes ==
1422 +
1307 1307  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.
1308 1308  
1309 -
1310 1310  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.
1311 1311  
1312 -
1313 1313  ----
1314 1314  
1315 -[[~[1~]>>path:#_ftnref1]] These types are only used in complex types and will be discussed within their appropriate context.
1316 -
1317 -[[~[2~]>>path:#_ftnref2]] Note that these options only apply to numeric representations and should be ignored if the data type is non-numeric
1429 +{{putFootnotes/}}