Skip to Content
Last modified by Artur on 2025/09/10 11:19
From version 4.5
edited by Helena
on 2025/06/24 14:51
Change comment: There is no comment for this version
To version 5.1
edited by Helena
on 2025/06/24 15:00
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -74,6 +74,7 @@
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:
77 +
77 77  * //com:AnnotableType// (extension) 
78 78  ** GroupType
79 79  
... ... @@ -106,6 +106,7 @@
106 106  com:Annotations?, SeriesKey, Attributes?, Obs*
107 107  
108 108  Element Documentation:
110 +
109 109  |**Name**|**Type**|**Documentation**
110 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 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.
... ... @@ -123,6 +123,7 @@
123 123  com:Annotations?, ObsKey, ObsValue?, Attributes?
124 124  
125 125  Element Documentation:
128 +
126 126  |**Name**|**Type**|**Documentation**
127 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 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.
... ... @@ -140,6 +140,7 @@
140 140  com:Annotations?, ObsDimension, ObsValue?, Attributes?
141 141  
142 142  Element Documentation:
146 +
143 143  |**Name**|**Type**|**Documentation**
144 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 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.
... ... @@ -152,6 +152,7 @@
152 152  Value+
153 153  
154 154  Element Documentation:
159 +
155 155  |**Name**|**Type**|**Documentation**
156 156  |Value|ComponentValueType|Value contains a component value and a reference to the component for which a value is being provided.
157 157  
... ... @@ -164,6 +164,7 @@
164 164  {Empty}
165 165  
166 166  Attribute Documentation:
172 +
167 167  |**Name**|**Type**|**Documentation**
168 168  |id|com:NCNameIDType|The id attribute contains the identifier for the component for which a value is being provided.
169 169  |value|xs:anySimpleType|The value attribute contains the provided component value.
... ... @@ -182,6 +182,7 @@
182 182  {Empty}
183 183  
184 184  Attribute Documentation:
191 +
185 185  |**Name**|**Type**|**Documentation**
186 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 187  |value|xs:string|The value attribute contains the provided component value.
... ... @@ -189,6 +189,7 @@
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:
199 +
192 192  * BaseValueType (restriction) 
193 193  ** ComponentValueType
194 194  
... ... @@ -199,6 +199,7 @@
199 199  {Empty}
200 200  
201 201  Attribute Documentation:
210 +
202 202  |**Name**|**Type**|**Documentation**
203 203  |id|com:NCNameIDType|The id attribute contains the identifier for the component for which a value is being provided.
204 204  |value|xs:string|The value attribute contains the provided component value.
... ... @@ -206,6 +206,7 @@
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:
218 +
209 209  * //com:AnnotableType// (extension) 
210 210  ** DataSetType (restriction) 
211 211  *** TimeSeriesDataSetType
... ... @@ -217,6 +217,7 @@
217 217  com:Annotations?, DataProvider?, Attributes?, Group*, Series*
218 218  
219 219  Attribute Documentation:
230 +
220 220  |**Name**|**Type**|**Documentation**
221 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 222  |setID|com:IDType|The setID provides an identification of the data or metadata set.
... ... @@ -240,6 +240,7 @@
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:
254 +
243 243  * //com:AnnotableType// (extension) 
244 244  ** SeriesType (restriction) 
245 245  *** TimeSeriesType
... ... @@ -248,6 +248,7 @@
248 248  com:Annotations?, SeriesKey, Attributes?, Obs*
249 249  
250 250  Element Documentation:
263 +
251 251  |**Name**|**Type**|**Documentation**
252 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 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.
... ... @@ -257,6 +257,7 @@
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:
273 +
260 260  * //com:AnnotableType// (extension) 
261 261  ** ObsType (restriction) 
262 262  *** TimeSeriesObsType
... ... @@ -265,6 +265,7 @@
265 265  com:Annotations?, ObsDimension, ObsValue?, Attributes?
266 266  
267 267  Element Documentation:
282 +
268 268  |**Name**|**Type**|**Documentation**
269 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 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.
... ... @@ -274,6 +274,7 @@
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:
292 +
277 277  * BaseValueType (restriction) 
278 278  ** TimeValueType
279 279  
... ... @@ -284,6 +284,7 @@
284 284  {Empty}
285 285  
286 286  Attribute Documentation:
303 +
287 287  |**Name**|**Type**|**Documentation**
288 288  |id (fixed: TIME_PERIOD)|com:NCNameIDType|The id attribute contains the identifier for the component for which a value is being provided.
289 289  |value|com: ObservationalTimePer iodType|The value attribute contains the provided component value.
... ... @@ -295,6 +295,7 @@
295 295  === Summary ===
296 296  
297 297  Referenced Namespaces:
315 +
298 298  |**Namespace**|**Prefix**
299 299  | |
300 300  |http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|com
... ... @@ -309,6 +309,7 @@
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:
330 +
312 312  * //com:AnnotableType// (extension) 
313 313  ** //DataSetType//
314 314  
... ... @@ -319,6 +319,7 @@
319 319  com:Annotations?, DataProvider?, Group*, (Series+ | Obs+)?
320 320  
321 321  Attribute Documentation:
341 +
322 322  |**Name**|**Type**|**Documentation**
323 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 324  |setID|com:IDType|The setID provides an identification of the data or metadata set.
... ... @@ -344,6 +344,7 @@
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:
367 +
347 347  * //com:AnnotableType// (extension) 
348 348  ** //GroupType//
349 349  
... ... @@ -354,6 +354,7 @@
354 354  com:Annotations?
355 355  
356 356  Attribute Documentation:
378 +
357 357  |**Name**|**Type**|**Documentation**
358 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 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.
... ... @@ -366,6 +366,7 @@
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:
391 +
369 369  * //com:AnnotableType// (extension) 
370 370  ** //SeriesType//
371 371  
... ... @@ -376,6 +376,7 @@
376 376  com:Annotations?, Obs*
377 377  
378 378  Attribute Documentation:
402 +
379 379  |**Name**|**Type**|**Documentation**
380 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 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.
... ... @@ -389,6 +389,7 @@
389 389  **//ObsType//: **ObsType is the abstract type which defines the structure of a grouped or un-grouped observation. The observation must be provided a key, which is either a value for the dimension which is declared to be at the observation level if the observation is grouped, or a full set of values for all dimensions in the data structure definition if the observation is un-grouped. This key should disambiguate the observation within the context in which it is defined (e.g. there should not be another observation with the same dimension value in a series). The observation can contain an observed value and/or attribute values. Data structure definition schemas will drive a type or types based on this that is specific to the data structure definition and the variation of the format being expressed in the schema. The dimension value(s) which make up the key and the attribute values associated with the key dimension(s) or the primary measure will be represented with XML attributes. This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived observation type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). The dimension XML attribute(s) will be required while the attribute XML attributes will be optional. To allow for generic processing, it is required that the only unqualified XML attributes in the derived observation type be for the observation dimension(s) and attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition dimension or attribute. If the data structure definition specific schema requires that explicit measures be used (only possible when the measure dimension is specified at the observation), then there will be types derived for each measure defined by the measure dimension. In this case, the types will be specific to each measure, which is to say that the representation of the primary measure (i.e. the observed value) will be restricted to that which is specified by the specific measure.
390 390  
391 391  Derivation:
416 +
392 392  * //com:AnnotableType// (extension) 
393 393  ** //ObsType//
394 394  
... ... @@ -399,6 +399,7 @@
399 399  com:Annotations?
400 400  
401 401  Attribute Documentation:
427 +
402 402  |**Name**|**Type**|**Documentation**
403 403  |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.
404 404  |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.
... ... @@ -413,6 +413,7 @@
413 413  **//TimeSeriesDataSetType//: **TimeSeriesDataSetType is the abstract type which defines the base structure for any data structure definition specific time series based data set. A derived data set type will be created that is specific to a data structure definition. Unlike the base format, only one variation of this is allowed for a data structure definition. This variation is the time dimension as the observation dimension. Data is organised into a collection of time series. 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 structure specific here will be identical to data in the base data set when the time dimension is the observation dimension, even for the derived data set types. This means that the data contained in this structure can be processed in exactly the same manner as the base structure. The same rules for derivation as the base data set type apply to this specialized data set.
414 414  
415 415  Derivation:
442 +
416 416  * //com:AnnotableType// (extension) 
417 417  ** //DataSetType// (restriction) 
418 418  *** //TimeSeriesDataSetType//
... ... @@ -424,6 +424,7 @@
424 424  com:Annotations?, DataProvider?, Group*, Series*
425 425  
426 426  Attribute Documentation:
454 +
427 427  |**Name**|**Type**|**Documentation**
428 428  |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).
429 429  |setID|com:IDType|The setID provides an identification of the data or metadata set.
... ... @@ -448,6 +448,7 @@
448 448  **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.
449 449  
450 450  Derivation:
479 +
451 451  * //com:AnnotableType// (extension) 
452 452  ** //SeriesType// (restriction) 
453 453  *** TimeSeriesType
... ... @@ -459,6 +459,7 @@
459 459  com:Annotations?, Obs*
460 460  
461 461  Attribute Documentation:
491 +
462 462  |**Name**|**Type**|**Documentation**
463 463  |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.
464 464  
... ... @@ -472,16 +472,14 @@
472 472  
473 473  Derivation:
474 474  
475 -//com:AnnotableType// (extension) 
476 - //ObsType// (restriction) 
477 - //TimeSeriesObsType//
505 +* //com:AnnotableType// (extension) 
506 +** //ObsType// (restriction) 
507 +*** //TimeSeriesObsType//
478 478  
479 479  Attributes:
480 -
481 481  TIME_PERIOD, REPORTING_YEAR_START_DAY?, OBS_VALUE?
482 482  
483 483  Content:
484 -
485 485  com:Annotations?
486 486  
487 487  Attribute Documentation:
... ... @@ -496,9 +496,7 @@
496 496  |**Name**|**Type**|**Documentation**
497 497  |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.
498 498  
499 -1.
500 -11.
501 -111. Simple Types
527 +=== Simple Types ===
502 502  
503 503  **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.
504 504  
... ... @@ -512,14 +512,11 @@
512 512  |Dataflow|The data set conforms to the known allowable content constraints applied to the dataflow.
513 513  |ProvisionAgreement|The data set conforms to the known allowable content constraints applied to the provision agreement.
514 514  
515 -1.
516 -11. Generic Metadata Namespace
541 +== Generic Metadata Namespace ==
517 517  
518 518  **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/metadata/generic**
519 519  
520 -1.
521 -11.
522 -111. Summary
545 +=== Summary ===
523 523  
524 524  Referenced Namespaces:
525 525  
... ... @@ -528,26 +528,21 @@
528 528  |http:~/~/www.w3.org/2001/XMLSchema|xs
529 529  
530 530  Contents:
531 -
532 532  6 Complex Types
533 533  
534 -1.
535 -11.
536 -111. Complex Types
556 +=== Complex Types ===
537 537  
538 538  **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.
539 539  
540 540  Derivation:
541 541  
542 -//com:AnnotableType// (extension) 
543 - MetadataSetType
562 +* //com:AnnotableType// (extension) 
563 +** MetadataSetType
544 544  
545 545  Attributes:
546 -
547 547  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?
548 548  
549 549  Content:
550 -
551 551  com:Annotations?, com:Name*, DataProvider?, Report+
552 552  
553 553  Attribute Documentation:
... ... @@ -575,15 +575,13 @@
575 575  
576 576  Derivation:
577 577  
578 -//com:AnnotableType// (extension) 
579 - ReportType
596 +* //com:AnnotableType// (extension) 
597 +** ReportType
580 580  
581 581  Attributes:
582 -
583 583  id
584 584  
585 585  Content:
586 -
587 587  com:Annotations?, Target, AttributeSet
588 588  
589 589  Attribute Documentation:
... ... @@ -601,11 +601,9 @@
601 601  **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.
602 602  
603 603  Attributes:
604 -
605 605  id
606 606  
607 607  Content:
608 -
609 609  ReferenceValue+
610 610  
611 611  Attribute Documentation:
... ... @@ -621,11 +621,9 @@
621 621  **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.
622 622  
623 623  Attributes:
624 -
625 625  id
626 626  
627 627  Content:
628 -
629 629  (ObjectReference | DataKey | DataSetReference | ConstraintContentReference | ReportPeriod)
630 630  
631 631  Attribute Documentation:
... ... @@ -645,7 +645,6 @@
645 645  **AttributeSetType: **AttributeSetType defines the structure for a collection of reported metadata attributes.
646 646  
647 647  Content:
648 -
649 649  ReportedAttribute+
650 650  
651 651  Element Documentation:
... ... @@ -657,15 +657,13 @@
657 657  
658 658  Derivation:
659 659  
660 -//com:AnnotableType// (extension) 
661 - ReportedAttributeType
671 +* //com:AnnotableType// (extension) 
672 +** ReportedAttributeType
662 662  
663 663  Attributes:
664 -
665 665  id, value?
666 666  
667 667  Content:
668 -
669 669  com:Annotations?, (com:Text+ | com:StructuredText+)?, AttributeSet?
670 670  
671 671  Attribute Documentation:
... ... @@ -682,14 +682,11 @@
682 682  |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.
683 683  |AttributeSet|AttributeSetType|AttributeSet contains the reported metadata attribute values for the child metadata attributes.
684 684  
685 -1.
686 -11. Structure Specific Metadata Namespace
694 +== Structure Specific Metadata Namespace ==
687 687  
688 688  **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/metadata/structurespecific**
689 689  
690 -1.
691 -11.
692 -111. Summary
698 +=== Summary ===
693 693  
694 694  Referenced Namespaces:
695 695  
... ... @@ -699,26 +699,21 @@
699 699  |http:~/~/www.w3.org/2001/XMLSchema|xs
700 700  
701 701  Contents:
702 -
703 703  5 Complex Types
704 704  
705 -1.
706 -11.
707 -111. Complex Types
710 +=== Complex Types ===
708 708  
709 709  **//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.
710 710  
711 711  Derivation:
712 712  
713 -//com:AnnotableType// (extension) 
714 - //MetadataSetType//
716 +* //com:AnnotableType// (extension) 
717 +** //MetadataSetType//
715 715  
716 716  Attributes:
717 -
718 718  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?
719 719  
720 720  Content:
721 -
722 722  com:Annotations?, com:Name*, DataProvider?, Report+
723 723  
724 724  Attribute Documentation:
... ... @@ -746,15 +746,13 @@
746 746  
747 747  Derivation:
748 748  
749 -//com:AnnotableType// (extension) 
750 - //ReportType//
750 +* //com:AnnotableType// (extension) 
751 +** //ReportType//
751 751  
752 752  Attributes:
753 -
754 754  id?
755 755  
756 756  Content:
757 -
758 758  com:Annotations?, Target, AttributeSet
759 759  
760 760  Attribute Documentation:
... ... @@ -772,11 +772,9 @@
772 772  **//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.
773 773  
774 774  Attributes:
775 -
776 776  id?
777 777  
778 778  Content:
779 -
780 780  ReferenceValue+
781 781  
782 782  Attribute Documentation:
... ... @@ -792,11 +792,9 @@
792 792  **//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.
793 793  
794 794  Attributes:
795 -
796 796  id?
797 797  
798 798  Content:
799 -
800 800  (ObjectReference | DataKey | DataSetReference | ConstraintContentReference | ReportPeriod)
801 801  
802 802  Attribute Documentation:
... ... @@ -817,15 +817,13 @@
817 817  
818 818  Derivation:
819 819  
820 -//com:AnnotableType// (extension) 
821 - //ReportedAttributeType//
815 +* //com:AnnotableType// (extension) 
816 +** //ReportedAttributeType//
822 822  
823 823  Attributes:
824 -
825 825  id?, value?, isMetadataAttribute?
826 826  
827 827  Content:
828 -
829 829  com:Annotations?, (com:Text+ | com:StructuredText+)?, AttributeSet?
830 830  
831 831  Attribute Documentation:
... ... @@ -843,9 +843,10 @@
843 843  |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.
844 844  |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.
845 845  
846 -1. Mapping to Structure-Specific Schemas
847 -11. General
839 += Mapping to Structure-Specific Schemas =
848 848  
841 +== General ==
842 +
849 849  Data structure and metadata structure-specific schemas are each based on one single core construct found in their respective structure-specific namespaces;
850 850  
851 851  Data  - http:~/~/www.SDMX.org/resources/SDMXML/schemas/v2_1/data/structurespecific
... ... @@ -854,9 +854,7 @@
854 854  
855 855  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.
856 856  
857 -1.
858 -11.
859 -111. Basic Terminology
851 +=== Basic Terminology ===
860 860  
861 861  In the subsequent sections, the following namespace prefixes are used:
862 862  
... ... @@ -902,8 +902,7 @@
902 902  
903 903  **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).
904 904  
905 -1.
906 -11. Namespace Rules
897 +== Namespace Rules ==
907 907  
908 908  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.
909 909  
... ... @@ -911,21 +911,17 @@
911 911  
912 912  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".
913 913  
914 -1.
915 -11. General Rules
905 +== General Rules ==
916 916  
917 917  The following section details the general rules which apply to all structure specific schema creation.
918 918  
919 -1.
920 -11.
921 -111. Component Name Determination
909 +=== Component Name Determination ===
922 922  
923 923  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:
924 924  
925 -1. If the component defines an identifier, the element or attribute name is the value of that identifier
926 -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).
927 -11.
928 -111. Representation Determination
913 +If the component defines an identifier, the element or attribute name is the value of that identifier
914 +Otherwise, the element or attribute name is the identifier of the concept from which it takes its semantic (Note that this is technically the component identifer).
915 +Representation Determination
929 929  
930 930  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).
931 931  
... ... @@ -939,40 +939,27 @@
939 939  
940 940  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.
941 941  
942 -1.
943 -11.
944 -111. Simple / Primitive Type Determination
929 +=== Simple / Primitive Type Determination ===
945 945  
946 946  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:]].
947 947  
948 948  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.
949 949  
950 -1.
951 -11.
952 -111. Representation with Enumeration
935 +=== Representation with Enumeration ===
953 953  
954 954  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:
955 955  
939 +> <xs:simpleType name="ESTAT.CL_COUNTRY.1.0">
940 +> <xs:restriction base="common:IDType">
941 +> <xs:enumeration value="BE">
942 +> <xs:annotation>
943 +> <xs:documentation xml:lang="en">Belgium</xs:documentation>
944 +> </xs:annotation>
945 +> </xs:enumeration>
956 956  
957 -<xs:simpleType name="ESTAT.CL_COUNTRY.1.0">
958 958  
959 -<xs:restriction base="common:IDType">
948 +=== Representation with Text Format ===
960 960  
961 -<xs:enumeration value="BE">
962 -
963 -<xs:annotation>
964 -
965 -<xs:documentation xml:lang="en">Belgium</xs:documentation>
966 -
967 -</xs:annotation>
968 -
969 -</xs:enumeration>
970 -
971 -
972 -1.
973 -11.
974 -111. Representation with Text Format
975 -
976 976  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:
977 977  
978 978  |**SDMX Data Type**|**XML Schema Data Type**
... ... @@ -1015,7 +1015,7 @@
1015 1015  |Day|xs:gDay
1016 1016  |Time|xs:time
1017 1017  |Duration|xs:duration
1018 -|XHTML|N/A[[~[1~]>>path:#_ftn1]]
992 +|XHTML|N/A{{footnote}}These types are only used in complex types and will be discussed within their appropriate context.{{/footnote}}
1019 1019  |KeyValues|N/A^^1^^
1020 1020  |IdentifiableReference|N/A^^1^^
1021 1021  |DataSetReference|N/A^^1^^
... ... @@ -1026,7 +1026,7 @@
1026 1026  |**SDMX Facet**|**XML Schema Facet**
1027 1027  |minLength|xs:minLength
1028 1028  |maxLength|xs:maxLength
1029 -|minValue[[~[2~]>>path:#_ftn2]]|if ExclusiveValueRange: xs:minExclusives, else: xs:minInclusive
1003 +|minValue{{footnote}}Note that these options only apply to numeric representations and should be ignored if the data type is non-numeric{{/footnote}}|if ExclusiveValueRange: xs:minExclusives, else: xs:minInclusive
1030 1030  |maxValue^^2^^|if ExclusiveValueRange: xs:maxExclusives, else: xs:maxInclusive
1031 1031  |decimals^^2^^|xs:fractionDigits
1032 1032  |pattern|xs:pattern
... ... @@ -1033,9 +1033,7 @@
1033 1033  
1034 1034  Any other facets are informational only, and will not affect the determined type.
1035 1035  
1036 -1.
1037 -11.
1038 -111. //Type Names//
1010 +=== Type Names ===
1039 1039  
1040 1040  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.
1041 1041  
... ... @@ -1062,16 +1062,13 @@
1062 1062  
1063 1063  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.
1064 1064  
1065 -1.
1066 -11. Data Structure Specific Schema
1037 +== Data Structure Specific Schema ==
1067 1067  
1068 1068  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.
1069 1069  
1070 1070  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.
1071 1071  
1072 -1.
1073 -11.
1074 -111. DataSetType
1043 +=== DataSetType ===
1075 1075  
1076 1076  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:
1077 1077  
... ... @@ -1084,9 +1084,10 @@
1084 1084  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)
1085 1085  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
1086 1086  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
1087 -11.
1088 -111. GroupType
1056 +11.
1089 1089  
1058 +=== GroupType ===
1059 +
1090 1090  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:
1091 1091  
1092 1092  1. A sequence consisting of:
... ... @@ -1113,9 +1113,9 @@
1113 1113  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
1114 1114  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
1115 1115  1. An attribute named type with a type of Group.ID, usage of optional, and a fixed value of the identifier of the group
1116 -11.
1117 -111. SeriesType
1118 1118  
1087 +=== SeriesType ===
1088 +
1119 1119  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:
1120 1120  
1121 1121  1. A sequence consisting of:
... ... @@ -1124,9 +1124,9 @@
1124 1124  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
1125 1125  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
1126 1126  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
1127 -11.
1128 -111. ObsType
1129 1129  
1098 +=== ObsType ===
1099 +
1130 1130  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:
1131 1131  
1132 1132  1. A sequence consisting of:
... ... @@ -1149,9 +1149,7 @@
1149 1149  
1150 1150  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.
1151 1151  
1152 -1.
1153 -11.
1154 -111. MetadataSetType
1122 +=== MetadataSetType ===
1155 1155  
1156 1156  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:
1157 1157  
... ... @@ -1203,9 +1203,11 @@
1203 1203  111. A local element named Ref, with a form of unqualified and a the type defined above as is [metadata target].[target object].Ref
1204 1204  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
1205 1205  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
1206 -111.
1207 -1111. Identifiable Object Target Type Determination
1208 1208  
1175 +
1176 +
1177 +==== Identifiable Object Target Type Determination ====
1178 +
1209 1209  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.
1210 1210  
1211 1211  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.
... ... @@ -1222,9 +1222,9 @@
1222 1222  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
1223 1223  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
1224 1224  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.
1225 -11.
1226 -111. ReportType
1227 1227  
1196 +=== ReportType ===
1197 +
1228 1228  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.
1229 1229  
1230 1230  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:
... ... @@ -1272,34 +1272,28 @@
1272 1272  1.
1273 1273  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
1274 1274  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]
1275 -11.
1276 -111.
1277 -1111. Attribute Set Complex Type Creation
1278 1278  
1246 +=== Attribute Set Complex Type Creation ===
1247 +
1279 1279  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:
1280 1280  
1281 1281  1. A sequence consisting of:
1282 1282  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].
1283 1283  
1284 -1. Special data functions
1285 -11. Updates
1253 += Special data functions =
1286 1286  
1255 +== Updates ==
1256 +
1287 1287  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.
1288 1288  
1289 -
1290 1290  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.
1291 1291  
1292 -1.
1293 -11. Deletes
1261 +== Deletes ==
1294 1294  
1295 1295  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.
1296 1296  
1297 -
1298 1298  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.
1299 1299  
1300 -
1301 1301  ----
1302 1302  
1303 -[[~[1~]>>path:#_ftnref1]] These types are only used in complex types and will be discussed within their appropriate context.
1304 -
1305 -[[~[2~]>>path:#_ftnref2]] Note that these options only apply to numeric representations and should be ignored if the data type is non-numeric
1269 +{{putFootnotes/}}