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

From version 2.5
edited by Helena
on 2025/07/02 14:53
Change comment: There is no comment for this version
To version 3.11
edited by Helena
on 2025/07/02 16:11
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -33,7 +33,7 @@
33 33  
34 34  === 2.1.2 Complex Types ===
35 35  
36 -//**DataSetType:**// DataSetType is the abstract type which defines the base structure for any data structure definition specific data set. A derived data set type will be created that is specific to a data structure definition and the details of the organisation of the data (i.e. which dimension is the observation dimension). Data is organised into either a collection of series (grouped observations) or a collection of un-grouped observations. The derived data set type will restrict this choice to be either grouped or un-grouped observations. If this dimension is "AllDimensions" then the derived data set type must consist of a collection of un-grouped observations; otherwise, the data set will contain a collection of series with the observations in the series disambiguated by the specified dimension at the observation level. This data set is capable of containing data (observed values) and/or documentation (data and metadata attribute values) and can be used for incremental updates and deletions (i.e. only the relevant updates or deletes are exchanged). It is assumed that each series or un-grouped observation will be distinct in its purpose. For example, if series contains both data and documentation, it assumed that each series will have a unique key. If the series contains only data or only documentation, then it is possible that another series with the same key might exist, but with not with the same purpose (i.e. to provide data or documentation) as the first series. This base type is designed such that derived types can be processed in a generic manner; it assures that data structure definition specific data will have a consistent structure. The group, series, obs, and atts elements are unqualified, meaning that they are not qualified with a namespace in an instance. This means that in the derived data set types, the elements will always be the same, regardless of the target namespace of the schemas which defines these derived types. This allows for consistent processing of the structure without regard to what the namespace might be for the data structure definition specific schema.
36 +//**DataSetType:**// DataSetType is the abstract type which defines the base structure for any [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] specific [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. A derived [[data set>>doc:sdmx:Glossary.Data set.WebHome]] type will be created that is specific to a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] and the details of the organisation of the data (i.e. which [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]). Data is organised into either a collection of series (grouped observations) or a collection of un-grouped observations. The derived [[data set>>doc:sdmx:Glossary.Data set.WebHome]] type will restrict this choice to be either grouped or un-grouped observations. If this [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is "AllDimensions" then the derived [[data set>>doc:sdmx:Glossary.Data set.WebHome]] type must consist of a collection of un-grouped observations; otherwise, the [[data set>>doc:sdmx:Glossary.Data set.WebHome]] will contain a collection of series with the observations in the series disambiguated by the specified [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%). This [[data set>>doc:sdmx:Glossary.Data set.WebHome]] is capable of containing data (observed values) and/or documentation (data and metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values) and can be used for [[incremental updates>>doc:sdmx:Glossary.Incremental update.WebHome]] 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>>doc:sdmx:Glossary.Data structure definition.WebHome]] specific data will have a consistent structure. The group, series, obs, and atts elements are unqualified, meaning that they are not qualified with a namespace in an instance. This means that in the derived [[data set>>doc:sdmx:Glossary.Data set.WebHome]] 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>>doc:sdmx:Glossary.Data structure definition.WebHome]] specific schema.
37 37  
38 38  Derivation:
39 39  
... ... @@ -40,39 +40,39 @@
40 40  AnnotableType (extension)
41 41   DataSetType
42 42  
43 -Attributes:
43 +[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
44 44  structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod?
45 45  
46 46  Content:
47 -Annotations?, DataProvider?, (Atts|Group|Series|Obs)*, Metadata?
47 +[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, DataProvider?, (Atts|Group|Series|Obs)*, Metadata?
48 48  
49 -Attribute Documentation:
49 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
50 50  
51 51  (% style="width:1152.29px" %)
52 52  |**Name**|**Type**|**Documentation**
53 -|structureRef|xs:IDREF|The structureRef contains a reference to a structural specification in the header of a data or reference metadata message. The structural specification details which structure the data or reference metadata conforms to, as well as providing additional information such as how the data is structure (e.g. which dimension occurs at the observation level for a data set).
53 +|structureRef|xs:IDREF|The structureRef contains a reference to a structural specification in the header of a data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] message. The structural specification details which structure the data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] conforms to, as well as providing additional information such as how the data is structure (e.g. which [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] occurs at the observation (% style="color:#e74c3c" %)level(%%) for a [[data set>>doc:sdmx:Glossary.Data set.WebHome]]).
54 54  |setID|IDType|The setID provides an identification of the data or metadata set.
55 -|action|ActionType|The action attribute indicates whether the file is merging, replacing, or deleting.
55 +|action|ActionType|The action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether the file is merging, replacing, or deleting.
56 56  |reportingBeginDate|BasicTimePeriodType|The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set.
57 57  |reportingEndDate|BasicTimePeriodType|The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.
58 58  |validFromDate|xs:dateTime|The validFromDate indicates the inclusive start time indicating the validity of the information in the data or metadata set.
59 59  |validToDate|xs:dateTime|The validToDate indicates the inclusive end time indicating the validity of the information in the data or metadata set.
60 60  |publicationYear|xs:gYear|The publicationYear holds the ISO 8601 four-digit year.
61 -|publicationPeriod|ObservationalTimePeriodType|The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a data set published on a quarterly basis).
61 +|publicationPeriod|ObservationalTimePeriodType|The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] published on a quarterly basis).
62 62  
63 63  Element Documentation:
64 64  
65 65  (% style="width:1154.29px" %)
66 66  |**Name**|**Type**|**Documentation**
67 -|Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
68 -|DataProvider|DataProviderReferenceType|DataProvider contains a reference to the provider for the data set.
69 -|Atts|*AttsType*|Atts contains a set of data or metadata attribute values with an attachment level of none (i.e. data set level) or reported against a partial set of dimension values.
70 -|Group|*GroupType*|Group contains a reference to a defined group in the data structure definition along with its key (if necessary) and values for the attributes which are associated with the group. An attribute is associated to a group by either an explicit group relationship or by a group attachment when the attribute has a relationship with a dimension which is a member of this group.
71 -|Series|*SeriesType*|Series contains a collection of observations that share a common key (set of dimension values). The key of a series is every dimension defined in the data structure definition, save the dimension at the observation level. In addition to the key and observations, the series contains values for data and metadata attributes which have a relationship with any dimension that is part of the series key, so long as the attribute does not specify an attachment group or also has a relationship with the dimension declared to be at the observation level.
72 -|Obs|*ObsType*|Obs is an un-grouped observation. This observation has a key which is a set of values for all dimensions declared in the data structure definition. In addition to the key, the value of the observation can be provided along with values for all data and metadata attributes which have an association with the observation or any dimension (so long as it does not specify a group attachment).
73 -|Metadata|MetadataSetType|Allows for attachment of reference metadata against to the data set.
67 +|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
68 +|DataProvider|DataProviderReferenceType|DataProvider contains a reference to the provider for the [[data set>>doc:sdmx:Glossary.Data set.WebHome]].
69 +|Atts|*AttsType*|Atts contains a set of data or metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values with an [[attachment level>>doc:sdmx:Glossary.Attachment level.WebHome]] of none (i.e. [[data set>>doc:sdmx:Glossary.Data set.WebHome]] (% style="color:#e74c3c" %)level(%%)) or reported against a partial set of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values.
70 +|Group|*GroupType*|Group contains a reference to a defined group in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] along with its key (if necessary) and values for the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which are associated with the group. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is associated to a group by either an explicit group relationship or by a group attachment when the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] has a relationship with a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] which is a member of this group.
71 +|Series|*SeriesType*|Series contains a collection of observations that share a common key (set of [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values). The key of a series is every [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] defined in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], save the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%). In addition to the key and observations, the series contains values for data and metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which have a relationship with any [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] that is part of the [[series key>>doc:sdmx:Glossary.Series key.WebHome]], so long as the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] does not specify an attachment group or also has a relationship with the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] declared to be at the observation (% style="color:#e74c3c" %)level(%%).
72 +|Obs|*ObsType*|Obs is an un-grouped observation. This observation has a key which is a set of values for all [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] declared in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. In addition to the key, the value of the observation can be provided along with values for all data and metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which have an association with the observation or any [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (so long as it does not specify a group attachment).
73 +|Metadata|MetadataSetType|Allows for attachment of [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] against to the [[data set>>doc:sdmx:Glossary.Data set.WebHome]].
74 74  
75 -//**GroupType:**// GroupType is the abstract type which defines a structure which is used to communicate attribute values for a group defined in a data structure definition. The group can consist of either a subset of the dimensions defined by the data structure definition, or an association to an attachment constraint, which in turn defines key sets to which attributes can be attached. In the case that the group is based on an attachment constraint, only the identification of group is provided. It is expected that a system which is processing this will relate that identifier to the key sets defined in the constraint and apply the values provided for the attributes appropriately. Data structure definition schemas will drive types based on this for each group defined in the data structure definition. Both the dimension values which make up the key (if applicable) and the attribute values associated with the group will be represented with XML attributes. This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived group type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). The dimension XML attributes will be required while the attribute XML attributes will be optional. To allow for generic processing, it is required that the only unqualified XML attributes in the derived group type be for the group dimensions and data or metadata attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition dimension or attribute.
75 +//**GroupType:**// GroupType is the abstract type which defines a structure which is used to communicate [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values for a group defined in a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. The group can consist of either a subset of the [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] defined by the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], or an association to an attachment (% style="color:#e74c3c" %)constraint(%%), which in turn defines key sets to which [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] can be attached. In the case that the group is based on an attachment (% style="color:#e74c3c" %)constraint(%%), only the identification of group is provided. It is expected that a system which is processing this will relate that identifier to the key sets defined in the (% style="color:#e74c3c" %)constraint(%%) and apply the values provided for the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] appropriately. [[Data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] schemas will drive types based on this for each group defined in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. Both the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values which make up the key (if applicable) and the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values associated with the group will be represented with XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived group type will refine this structure so that the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] are explicit. The XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be given a name based on the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]'s identifier. These XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be unqualified (meaning they do not have a namespace associated with them). The [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be required while the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be optional. To allow for generic processing, it is required that the only unqualified XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] in the derived group type be for the group [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] and data or metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] declared in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. If additional [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].
76 76  
77 77  Derivation:
78 78  
... ... @@ -79,27 +79,27 @@
79 79  AnnotableType (extension)
80 80   GroupType
81 81  
82 -Attributes:
82 +[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
83 83  type?
84 84  
85 85  Content:
86 -Annotations?, Comp*, Metadata?
86 +[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Comp*, Metadata?
87 87  
88 -Attribute Documentation:
88 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
89 89  
90 90  (% style="width:1044.29px" %)
91 91  |**Name**|**Type**|(% style="width:913px" %)**Documentation**
92 -|type|IDType|(% style="width:913px" %)The type attribute reference the identifier of the group as defined in the data structure definition. This is optional, but derived group types will provide a fixed value for this so that it always available in the post validation information set. This allows the group to be processed in a generic manner.
92 +|type|IDType|(% style="width:913px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] reference the identifier of the group as defined in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. This is optional, but derived group types will provide a fixed value for this so that it always available in the post validation information set. This allows the group to be processed in a generic manner.
93 93  
94 94  Element Documentation:
95 95  
96 96  (% style="width:1055.29px" %)
97 97  |**Name**|**Type**|(% style="width:717px" %)**Documentation**
98 -|Annotations|AnnotationsType|(% style="width:717px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
99 -|Comp|//CompType//|(% style="width:717px" %)Comp contains the details of group level attributes that have complex representation and cannot be expressed as XML attributes.
100 -|Metadata|MetadataSetType|(% style="width:717px" %)Allows for attachment of reference metadata against to the group.
98 +|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|(% style="width:717px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
99 +|Comp|//CompType//|(% style="width:717px" %)Comp contains the details of group (% style="color:#e74c3c" %)level(%%) [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] that have complex [[representation>>doc:sdmx:Glossary.Representation.WebHome]] and cannot be expressed as XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].
100 +|Metadata|MetadataSetType|(% style="width:717px" %)Allows for attachment of [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] against to the group.
101 101  
102 -//**SeriesType:**// SeriesType is the abstract type which defines a structure which is used to group a collection of observations which have a key in common. The key for a series is every dimension defined in the data structure definition save the dimension declared to be at the observation level for this data set. Note, if the schema is generated against a dataflow with a dimension constraint, they key includes only the dimensions defined in the dimension constraint. In addition to observations, values can be provided for data and metadata attributes which are associated with the dimensions which make up this series key (so long as the attributes do not specify a group attachment or also have a relationship with the observation dimension). It is possible for the series to contain only observations or only attribute values, or both. Data structure definition schemas will derive a type based on this that is specific to the data structure definition and the variation of the format being expressed in the schema. Both the dimension values which make up the key and the attribute values associated with the key dimensions will be represented with XML attributes. This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived series type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). The dimension XML attributes will be required while the attribute XML attributes will be optional. To allow for generic processing, it is required that the only unqualified XML attributes in the derived group type be for the series dimensions and attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition dimension or attribute.
102 +//**SeriesType:**// SeriesType is the abstract type which defines a structure which is used to group a collection of observations which have a key in common. The key for a series is every [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] defined in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] save the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] declared to be at the observation (% style="color:#e74c3c" %)level(%%) for this [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. Note, if the schema is generated against a [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] with a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (% style="color:#e74c3c" %)constraint(%%), they key includes only the [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] defined in the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (% style="color:#e74c3c" %)constraint(%%). In addition to observations, values can be provided for data and metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which are associated with the [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] which make up this [[series key>>doc:sdmx:Glossary.Series key.WebHome]] (so long as the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] do not specify a group attachment or also have a relationship with the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]). It is possible for the series to contain only observations or only [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values, or both. [[Data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] schemas will derive a type based on this that is specific to the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] and the variation of the format being expressed in the schema. Both the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values which make up the key and the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values associated with the key [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] will be represented with XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived series type will refine this structure so that the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] are explicit. The XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be given a name based on the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]'s identifier. These XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be unqualified (meaning they do not have a namespace associated with them). The [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be required while the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be optional. To allow for generic processing, it is required that the only unqualified XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] in the derived group type be for the series [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] and [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] declared in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. If additional [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].
103 103  
104 104  Derivation:
105 105  
... ... @@ -106,27 +106,28 @@
106 106  AnnotableType (extension)
107 107   SeriesType
108 108  
109 -Attributes:
109 +[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
110 110  TIME_PERIOD?
111 111  
112 112  Content:
113 -Annotations?, Comp*, Obs*, Metadata?
113 +[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Comp*, Obs*, Metadata?
114 114  
115 -Attribute Documentation:
115 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
116 116  
117 117  (% style="width:1084.29px" %)
118 118  |**Name**|**Type**|**Documentation**
119 -|TIME_PERIOD|ObservationalTimePeriodType|The TIME_PERIOD attribute is an explict attribute for the time dimension. This is declared in the base schema since it has a fixed identifier and representation. The derived series type will either require or prohibit this attribute, depending on whether time is the observation dimension. If the time dimension specifies a more specific representation of time the derived type will restrict the type definition to the appropriate type.
119 +|TIME_PERIOD|ObservationalTimePeriodType|The TIME_PERIOD [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is an explict [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. This is declared in the base schema since it has a fixed identifier and [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. The derived series type will either require or prohibit this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], depending on whether time is the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. If the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] specifies a more specific [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of time the derived type will restrict the type definition to the appropriate type.
120 120  
121 121  Element Documentation:
122 122  
123 -|**Name**|**Type**|**Documentation**|
124 -|Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
125 -|Comp|//CompType//|Comp contains the details of series level attributes that have complex representation and cannot be expressed as XML attributes.|
126 -|Obs|//ObsType//| |
127 -|Metadata|MetadataSetType|Allows for attachment of reference metadata against to the series.|
123 +(% style="width:1093.29px" %)
124 +|**Name**|**Type**|**Documentation**
125 +|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
126 +|Comp|//CompType//|Comp contains the details of series (% style="color:#e74c3c" %)level(%%) [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] that have complex [[representation>>doc:sdmx:Glossary.Representation.WebHome]] and cannot be expressed as XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].
127 +|Obs|//ObsType//|
128 +|Metadata|MetadataSetType|Allows for attachment of [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] against to the series.
128 128  
129 -***CompType*:** CompType is the abstract base for any component value (e.g. a data or metadata attribute, or a measure) that cannot be represented as an XML attribute. For example, a repeated value, a text value in multiple languages, or a value with structured text (XHTML) cannot be expressed as an XML attribute. This type is meant to be restricted based on the component to restrict the cardinality and type of its Value element to conform to the component definition. The type of the value element should be restricted to common:SimpleValueType, common:TextValueType, or common:StructuredValueType. In addition, the id attribute should be restricted to be a fixed value with the component identifier. This restricted type based on the component can then be used on Comp elements by using the xsi:type to state the component being expressed and refine the contents of the element to the values allowed by the component.
130 +//**CompType:**// CompType is the abstract base for any [[component>>doc:sdmx:Glossary.Component.WebHome]] value (e.g. a data or metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], or a [[measure>>doc:sdmx:Glossary.Measure.WebHome]]) that cannot be represented as an XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. For example, a repeated value, a text value in multiple languages, or a value with structured text (XHTML) cannot be expressed as an XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. This type is meant to be restricted based on the [[component>>doc:sdmx:Glossary.Component.WebHome]] to restrict the cardinality and type of its Value element to conform to the [[component>>doc:sdmx:Glossary.Component.WebHome]] definition. The type of the value element should be restricted to common:SimpleValueType, common:TextValueType, or common:StructuredValueType. In addition, the id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] should be restricted to be a fixed value with the [[component>>doc:sdmx:Glossary.Component.WebHome]] identifier. This restricted type based on the [[component>>doc:sdmx:Glossary.Component.WebHome]] can then be used on Comp elements by using the xsi:type to state the [[component>>doc:sdmx:Glossary.Component.WebHome]] being expressed and refine the contents of the element to the values allowed by the [[component>>doc:sdmx:Glossary.Component.WebHome]].
130 130  
131 131  Derivation:
132 132  
... ... @@ -133,24 +133,26 @@
133 133  AnnotableType (extension)
134 134   CompType
135 135  
136 -Attributes:
137 +[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
137 137  id
138 138  
139 139  Content:
140 -Annotations?, Value
141 +[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Value
141 141  
142 -Attribute Documentation:
143 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
143 143  
144 -|**Name**|**Type**|**Documentation**|
145 -|id|NCNameIDType| |
145 +(% style="width:1007.29px" %)
146 +|(% style="width:157px" %)**Name**|(% style="width:291px" %)**Type**|(% style="width:556px" %)**Documentation**
147 +|(% style="width:157px" %)id|(% style="width:291px" %)NCNameIDType|(% style="width:556px" %)
146 146  
147 147  Element Documentation:
148 148  
149 -|**Name**|**Type**|**Documentation**|
150 -|Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
151 -|Value|*ValueType*| |
151 +(% style="width:1015.29px" %)
152 +|**Name**|**Type**|(% style="width:684px" %)**Documentation**
153 +|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|(% style="width:684px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
154 +|Value|//ValueType//|(% style="width:684px" %)
152 152  
153 -***ObsType*:** ObsType is the abstract type which defines the structure of a grouped or un-grouped observation. The observation must be provided a key, which is either a value for the dimension which is declared to be at the observation level if the observation is grouped, or a full set of values for all dimensions in the data structure definition if the observation is un-grouped. This key should disambiguate the observation within the context in which it is defined (e.g. there should not be another observation with the same dimension value in a series). The observation can contain an observed value and/or attribute values. Data structure definition schemas will derive a type or types based on this that is specific to the data structure definition and the variation of the format being expressed in the schema. The dimension value(s) which make up the key and the data and metadata attribute values associated with the key dimension(s) or the primary measure will be represented with XML attributes. This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived observation type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). The dimension XML attribute(s) will be required while the attribute XML attributes will be optional. To allow for generic processing, it is required that the only unqualified XML attributes in the derived observation type be for the observation dimension(s) and attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition dimension or attribute.
156 +//**ObsType:**// ObsType is the abstract type which defines the structure of a grouped or un-grouped observation. The observation must be provided a key, which is either a value for the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] which is declared to be at the observation (% style="color:#e74c3c" %)level(%%) if the observation is grouped, or a full set of values for all [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] 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>>doc:sdmx:Glossary.Dimension.WebHome]] value in a series). The observation can contain an observed value and/or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values. [[Data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] schemas will derive a type or types based on this that is specific to the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] and the variation of the format being expressed in the schema. The [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] value(s) which make up the key and the data and metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values associated with the key [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]](s) or the primary [[measure>>doc:sdmx:Glossary.Measure.WebHome]] will be represented with XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived observation type will refine this structure so that the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] are explicit. The XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be given a name based on the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]'s identifier. These XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be unqualified (meaning they do not have a namespace associated with them). The [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]](s) will be required while the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be optional. To allow for generic processing, it is required that the only unqualified XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] in the derived observation type be for the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]](s) and [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] declared in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. If additional [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].
154 154  
155 155  Derivation:
156 156  
... ... @@ -157,26 +157,28 @@
157 157  AnnotableType (extension)
158 158   ObsType
159 159  
160 -Attributes:
163 +[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
161 161  type?, TIME_PERIOD?
162 162  
163 163  Content:
164 -Annotations?, Comp*, Metadata?
167 +[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Comp*, Metadata?
165 165  
166 -Attribute Documentation:
169 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
167 167  
168 -|**Name**|**Type**|**Documentation**|
169 -|type|IDType|The type attribute is used when the derived format requires that explicit measure be used. In this case, the derived type based on the measure will fix this value to be the identification of the measure concept. This will not be required, but since it is fixed it will be available in the post validation information set which will allow for generic processing of the data. If explicit measures are not used, then the derived type will prohibit the use of this attribute.|
170 -|TIME_PERIOD|ObservationalTimePeriodType|The TIME_PERIOD attribute is an explicit attribute for the time dimension. This is declared in the base schema since it has a fixed identifier and representation. The derived series type will either require or prohibit this attribute, depending on whether time is the observation dimension. If the time dimension specifies a more specific representation of time the derived type will restrict the type definition to the appropriate type.|
171 +(% style="width:1008.29px" %)
172 +|**Name**|**Type**|(% style="width:648px" %)**Documentation**
173 +|type|IDType|(% style="width:648px" %)The type [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used when the derived format requires that explicit [[measure>>doc:sdmx:Glossary.Measure.WebHome]] be used. In this case, the derived type based on the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] will fix this value to be the identification of the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] (% style="color:#e74c3c" %)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>>doc:sdmx:Glossary.Measure.WebHome]] are not used, then the derived type will prohibit the use of this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].
174 +|TIME_PERIOD|ObservationalTimePeriodType|(% style="width:648px" %)The TIME_PERIOD [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is an explicit [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. This is declared in the base schema since it has a fixed identifier and [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. The derived series type will either require or prohibit this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], depending on whether time is the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. If the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] specifies a more specific [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of time the derived type will restrict the type definition to the appropriate type.
171 171  
172 172  Element Documentation:
173 173  
174 -|**Name**|**Type**|**Documentation**|
175 -|Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
176 -|Comp|*CompType*|Comp contains the details of observation measures or attributes that have complex representation and cannot be expressed as XML attributes.|
177 -|Metadata|MetadataSetType|Allows for attachment of reference metadata against to the observation.|
178 +(% style="width:1020.29px" %)
179 +|**Name**|**Type**|**Documentation**
180 +|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
181 +|Comp|//CompType//|Comp contains the details of observation [[measures>>doc:sdmx:Glossary.Measure.WebHome]] or [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] that have complex [[representation>>doc:sdmx:Glossary.Representation.WebHome]] and cannot be expressed as XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].
182 +|Metadata|MetadataSetType|Allows for attachment of [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] against to the observation.
178 178  
179 -***AttsType*:** AttsType is the abstract type which defines a structure which is used to group a collection of data or metadata attributes which have a key in common. The key for a attribute collection is a subset of the dimension defined in the data structure definition. This is also used for data set level attributes (i.e. those with an attribute relationship of none). In this case, the subset of dimensions is empty. Data structure definition schemas will derive a type based on this that is specific to the data structure definition. The dimension values which make up the key will be represented with local (non-namespace qualified) XML attributes. The metadata attribute values associated with the key dimensions will be expressed as XML local (non-namespace qualified) attributes if they are simple values (e.g. enumerated, dates, numbers) and are not repeatable. Metadata attributes that are repeatable, or do not have simple values (e.g. text) will be expressed using the Comp element. These dimensions and simple attributes are specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived series type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). The dimension XML attributes will be required while the attribute XML attributes will be optional. To allow for generic processing, it is required that the only unqualified XML attributes in the derived group type be for the series dimensions and attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition dimension or attribute.
184 +***AttsType*:** AttsType is the abstract type which defines a structure which is used to group a collection of data or metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which have a key in common. The key for a [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] collection is a subset of the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] defined in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. This is also used for [[data set>>doc:sdmx:Glossary.Data set.WebHome]] (% style="color:#e74c3c" %)level(%%) [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] (i.e. those with an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] of none). In this case, the subset of [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] is empty. [[Data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] schemas will derive a type based on this that is specific to the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. The [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values which make up the key will be represented with local (non-namespace qualified) XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. The metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values associated with the key [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] will be expressed as XML local (non-namespace qualified) [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] if they are simple values (e.g. enumerated, dates, numbers) and are not repeatable. Metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] that are repeatable, or do not have simple values (e.g. text) will be expressed using the Comp element. These [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] and simple [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] are specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived series type will refine this structure so that the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] are explicit. The XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be given a name based on the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]'s identifier. These XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be unqualified (meaning they do not have a namespace associated with them). The [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be required while the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] will be optional. To allow for generic processing, it is required that the only unqualified XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] in the derived group type be for the series [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] and [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] declared in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. If additional [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].
180 180  
181 181  Derivation:
182 182  
... ... @@ -183,47 +183,49 @@
183 183  AnnotableType (extension)
184 184   AttsType
185 185  
186 -Attributes:
191 +[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
187 187  TIME_PERIOD?
188 188  
189 189  Content:
190 -Annotations?, Comp
195 +[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Comp
191 191  
192 -Attribute Documentation:
197 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
193 193  
194 -|**Name**|**Type**|**Documentation**|
195 -|TIME_PERIOD|ObservationalTimePeriodType|The TIME_PERIOD attribute is an explict attribute for the time dimension. This is declared in the base schema since it has a fixed identifier and representation. The derived series type will either require or prohibit this attribute, depending on whether time is the observation dimension. If the time dimension specifies a more specific representation of time the derived type will restrict the type definition to the appropriate type.|
199 +(% style="width:1013.29px" %)
200 +|**Name**|**Type**|**Documentation**
201 +|TIME_PERIOD|ObservationalTimePeriodType|The TIME_PERIOD [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is an explict [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. This is declared in the base schema since it has a fixed identifier and [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. The derived series type will either require or prohibit this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], depending on whether time is the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]. If the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] specifies a more specific [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of time the derived type will restrict the type definition to the appropriate type.
196 196  
197 197  Element Documentation:
198 198  
199 -|**Name**|**Type**|**Documentation**|
200 -|Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
201 -|Comp|*CompType*|Comp contains the details of the data or metadata attributes that have complex representation and cannot be expressed as XML attributes.|
205 +(% style="width:1020.29px" %)
206 +|**Name**|**Type**|**Documentation**
207 +|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
208 +|Comp|//CompType//|Comp contains the details of the data or metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] that have complex [[representation>>doc:sdmx:Glossary.Representation.WebHome]] and cannot be expressed as XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].
202 202  
203 203  == 2.2 Generic Reference Metadata Namespace ==
204 204  
205 -**http://www.sdmx.org/resources/sdmxml/schemas/v3_1/metadata/generic****
212 +[[http:~~/~~/www.sdmx.org/resources/sdmxml/schemas/v3_1/metadata/generic>>http://www.sdmx.org/resources/sdmxml/schemas/v3_1/metadata/generic**]]
206 206  
207 207  === 2.2.1 Summary ===
208 208  
209 209  Referenced Namespaces:
210 210  
211 -|**Namespace**|**Prefix**|
212 -|http://www.sdmx.org/resources/sdmxml/schemas/v3\_1/common|common|
213 -|<http://www.w3.org/2001/XMLSchema>|xs|
218 +(% style="width:1037.29px" %)
219 +|(% style="width:516px" %)**Namespace**|(% style="width:518px" %)**Prefix**
220 +|(% style="width:516px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v3\_1/common|(% style="width:518px" %)common
221 +|(% style="width:516px" %)<http:~/~/www.w3.org/2001/XMLSchema>|(% style="width:518px" %)xs
214 214  
215 215  Contents:
216 -
217 217  1 Global Element
218 218  3 Complex Types
219 219  
220 220  === 2.2.2 Global Elements ===
221 221  
222 -**Attribute (AttributeType):** Att elements hold the reported values for a given metadata attribute. These values conform to the definition of the metadata attribute in the metadata structure definition.
229 +**[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] (AttributeType):** Att elements hold the reported values for a given metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. These values conform to the definition of the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] in the metadata structure definition.
223 223  
224 224  === 2.2.3 Complex Types ===
225 225  
226 -***MetadataSetBaseType*:** MetadataSetBaseType defines the base refinement of the MetadataSetType. Its purpose is to restrict the urn attribute.
233 +***MetadataSetBaseType*:** MetadataSetBaseType defines the base refinement of the MetadataSetType. Its purpose is to restrict the urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].
227 227  
228 228  Derivation:
229 229  
... ... @@ -235,36 +235,38 @@
235 235   MaintainableType (restriction)
236 236   MetadataSetBaseType
237 237  
238 -Attributes:
239 -id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?
245 +[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
246 +id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isPartialLanguage?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?
240 240  
241 241  Content:
242 -Annotations?, Link*, Name+, Description
249 +[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description
243 243  
244 -Attribute Documentation:
251 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
245 245  
246 -|**Name**|**Type**|**Documentation**|
247 -|id|IDType|The id is the identifier for the object.|
248 -|urn|MetadataSetUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
249 -|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
250 -|version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.|
251 -|validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
252 -|validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
253 -|agencyID|NestedNCNameIDType|The agencyID must be provided and identifies the maintenance agency of the object.|
254 -|isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
255 -|serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
256 -|structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
257 -|isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header Accept-Language.|
253 +(% style="width:1051.29px" %)
254 +|**Name**|**Type**|(% style="width:669px" %)**Documentation**
255 +|id|IDType|(% style="width:669px" %)The id is the identifier for the object.
256 +|urn|MetadataSetUrnType|(% style="width:669px" %)The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details).
257 +|uri|xs:anyURI|(% style="width:669px" %)The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message.
258 +|(%%)(% style="color:#e74c3c" %)version|VersionType|(% style="width:669px" %)This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number (see common:VersionType definition for details). If not supplied, [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is considered to be un-versioned.
259 +|validFrom|xs:dateTime|(% style="width:669px" %)The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive start date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%).
260 +|validTo|xs:dateTime|(% style="width:669px" %)The validTo [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive end date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%).
261 +|agencyID|NestedNCNameIDType|(% style="width:669px" %)The agencyID must be provided and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object.
262 +|[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] (default: false)|xs:boolean|(% style="width:669px" %)The [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
263 +|serviceURL|xs:anyURI|(% style="width:669px" %)The serviceURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, as they both implement that same web service interface.
264 +|structureURL|xs:anyURI|(% style="width:669px" %)The structureURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] structure message (in the same (% style="color:#e74c3c" %)version(%%) as the source document) in which the externally referenced object is contained. Note that this may be a URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web service which will return the referenced object.
265 +|isPartialLanguage (default: false)|xs:boolean|(% style="width:669px" %)The isPartialLanguage [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header Accept-Language.
258 258  
259 259  Element Documentation:
260 260  
261 -|**Name**|**Type**|**Documentation**|
262 -|Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
263 -|Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the metadata report can be dynamically inserted in the structure metadata.|
264 -|Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
265 -|Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
269 +(% style="width:1057.29px" %)
270 +|**Name**|**Type**|**Documentation**
271 +|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
272 +|Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the metadata report can be dynamically inserted in the structure metadata.
273 +|Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
274 +|Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
266 266  
267 -**MetadataSetType:** MetadataSetType describes the structure for a metadata set, which contains a collection of reported metadata against a set of targets. The targets should conform to the restrictions described by the metadata provision or the metadataflow. Note that this is maintainable, and as such must specify in agency. In this case, the agency is the metadata provider. If a metadata provision agreement is referenced, it is assumed that the metadata provider described in the provision will be the same as the agency for this set.
276 +**MetadataSetType:** MetadataSetType describes the structure for a [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]], which contains a collection of reported metadata against a set of targets. The targets should conform to the restrictions described by the metadata provision or the [[metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]. Note that this is maintainable, and as such must specify in agency. In this case, the agency is the metadata provider. If a metadata [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] is referenced, it is assumed that the metadata provider described in the provision will be the same as the agency for this set.
268 268  
269 269  Derivation:
270 270  
... ... @@ -277,44 +277,49 @@
277 277   MetadataSetBaseType (extension)
278 278   MetadataSetType
279 279  
280 -Attributes:
281 -id, urn?, uri?, version?, validFrom?, validTo?, agencyID, isPartialLanguage?, isExternalReference?, serviceURL?, structureURL?, reportingBeginDate?, reportingEndDate?, publicationYear?, publicationPeriod?
289 +[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
290 +id, urn?, uri?, (% style="color:#e74c3c" %)version(%%)?, validFrom?, validTo?, agencyID, isPartialLanguage?, [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]?, serviceURL?, structureURL?, reportingBeginDate?, reportingEndDate?, publicationYear?, publicationPeriod?
282 282  
283 283  Content:
284 -Annotations?, Link*, Name+, Description*, ( (MetadataProvisionAgreement|Metadataflow), Target+, Attribute+)?
293 +[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description*, ( (MetadataProvisionAgreement|[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]), Target+, [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]+)?
285 285  
286 -Attribute Documentation:
295 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
287 287  
288 -|**Name**|**Type**|**Documentation**|
289 -|id|IDType|The id is the identifier for the object.|
290 -|urn|MetadataSetUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).|
291 -|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.|
292 -|version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.|
293 -|validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.|
294 -|validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.|
295 -|agencyID|NestedNCNameIDType|The agencyID must be provided and identifies the maintenance agency of the object.|
296 -|isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.|
297 -|serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.|
298 -|structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.|
299 -|isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header Accept-Language.|
300 -|reportingBeginDate|BasicTimePeriodType|The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set.|
301 -|reportingEndDate|BasicTimePeriodType|The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.|
302 -|publicationYear|xs:gYear|The publicationYear holds the ISO 8601 four-digit year.|
303 -|publicationPeriod|ObservationalTimePeriodType|The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a data set published on a quarterly basis).|
297 +(% style="width:1050.29px" %)
298 +|**Name**|**Type**|(% style="width:622px" %)**Documentation**
299 +|id|IDType|(% style="width:622px" %)The id is the identifier for the object.
300 +|urn|MetadataSetUrnType|(% style="width:622px" %)The urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a valid [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] URN (see [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Specification for details).
301 +|uri|xs:anyURI|(% style="width:622px" %)The uri [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] message.
302 +|(%%)(% style="color:#e74c3c" %)version|VersionType|(% style="width:622px" %)This (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a (% style="color:#e74c3c" %)version(%%) number (see common:VersionType definition for details). If not supplied, [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is considered to be un-versioned.
303 +|validFrom|xs:dateTime|(% style="width:622px" %)The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive start date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%).
304 +|validTo|xs:dateTime|(% style="width:622px" %)The validTo [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides the inclusive end date for providing supplemental validity information about the (% style="color:#e74c3c" %)version(%%).
305 +|agencyID|NestedNCNameIDType|(% style="width:622px" %)The agencyID must be provided and identifies the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object.
306 +|[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] (default: false)|xs:boolean|(% style="width:622px" %)The [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.
307 +|serviceURL|xs:anyURI|(% style="width:622px" %)The serviceURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, as they both implement that same web service interface.
308 +|structureURL|xs:anyURI|(% style="width:622px" %)The structureURL [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the URL of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] structure message (in the same (% style="color:#e74c3c" %)version(%%) as the source document) in which the externally referenced object is contained. Note that this may be a URL of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web service which will return the referenced object.
309 +|isPartialLanguage (default: false)|xs:boolean|(% style="width:622px" %)The isPartialLanguage [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header Accept-Language.
310 +|reportingBeginDate|BasicTimePeriodType|(% style="width:622px" %)The reportingBeginDate indicates the inclusive start time of the data reported in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].
311 +|reportingEndDate|BasicTimePeriodType|(% style="width:622px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].
312 +|publicationYear|xs:gYear|(% style="width:622px" %)The publicationYear holds the ISO 8601 four-digit year.
313 +|publicationPeriod|ObservationalTimePeriodType|(% style="width:622px" %)The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] published on a quarterly basis).
304 304  
305 305  Element Documentation:
306 306  
307 -|**Name**|**Type**|**Documentation**|
308 -|Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
309 -|Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the metadata report can be dynamically inserted in the structure metadata.|
310 -|Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.|
311 -|Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.|
312 -|MetadataProvision<br/>Agreement|MetadataProvisionAgree<br/>mentReferenceType|Metadataflow provides a reference to the metadata provision agreement the metadata set is being reported against.|
313 -|Metadataflow|MetadataflowReference<br/>Type|Metadataflow provides a reference to the metadataflow the metadata set is being reported against.|
314 -|Target|WildcardUrnType|Target references the target structures for which metadata is being reported. These must conform with the constraints defined by the metadata provision agreement and/or the metadataflow.|
315 -|Attribute|AttributeType|Att elements hold the reported metadata attribute values being reported in the metadata set. These conform to the metadata structure definition.|
317 +(% style="width:1054.29px" %)
318 +|**Name**|(% style="width:185px" %)**Type**|(% style="width:412px" %)**Documentation**
319 +|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|(% style="width:185px" %)AnnotationsType|(% style="width:412px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
320 +|Link|(% style="width:185px" %)LinkType|(% style="width:412px" %)Allows for the linking of other resources to identifiable objects. For example, if there is [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] associated with a structure, a link to the metadata report can be dynamically inserted in the structure metadata.
321 +|Name|(% style="width:185px" %)TextType|(% style="width:412px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.
322 +|Description|(% style="width:185px" %)TextType|(% style="width:412px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.
323 +|MetadataProvision
324 +Agreement|(% style="width:185px" %)MetadataProvisionAgree
325 +mentReferenceType|(% style="width:412px" %)[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] provides a reference to the metadata [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] the [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] is being reported against.
326 +|[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]|(% style="width:185px" %)MetadataflowReference
327 +Type|(% style="width:412px" %)[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] provides a reference to the [[metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] the [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] is being reported against.
328 +|Target|(% style="width:185px" %)WildcardUrnType|(% style="width:412px" %)Target references the target structures for which metadata is being reported. These must conform with the (% style="color:#e74c3c" %)constraints(%%) defined by the metadata [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] and/or the [[metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]].
329 +|[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]|(% style="width:185px" %)AttributeType|(% style="width:412px" %)Att elements hold the reported metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values being reported in the [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]]. These conform to the metadata structure definition.
316 316  
317 -**AttributeType:** AttributeType defines the structure for a reported metadata attribute. A value for the attribute can be supplied as either a single value (enumerated or non-enumerated single value), or multi-lingual text values (either structured or unstructured). Optional child attributes are also available if the metadata attribute definition defines nested metadata attributes.
331 +**AttributeType:** AttributeType defines the structure for a reported metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. A value for the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] can be supplied as either a single value (enumerated or non-enumerated single value), or multi-lingual text values (either structured or unstructured). Optional child [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] are also available if the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] definition defines nested metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].
318 318  
319 319  Derivation:
320 320  
... ... @@ -321,25 +321,27 @@
321 321  AnnotableType (extension)
322 322   AttributeType
323 323  
324 -Attributes:
338 +[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]:
325 325  id
326 326  
327 327  Content:
328 -Annotations?, (Value+|Text+|StructuredText+)?, Attribute
342 +[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, (Value+|Text+|StructuredText+)?, [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]
329 329  
330 -Attribute Documentation:
344 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
331 331  
332 -|**Name**|**Type**|**Documentation**|
333 -|id|IDType|The id attribute identifies the metadata attribute that the value is being reported for.|
346 +(% style="width:1037.29px" %)
347 +|(% style="width:113px" %)**Name**|(% style="width:162px" %)**Type**|(% style="width:760px" %)**Documentation**
348 +|(% style="width:113px" %)id|(% style="width:162px" %)IDType|(% style="width:760px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] identifies the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] that the value is being reported for.
334 334  
335 335  Element Documentation:
336 336  
337 -|**Name**|**Type**|**Documentation**|
338 -|Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.|
339 -|Value|xs:anySimpleType|Value holds any simple value (enumerated or not) for the metadata attribute. It can be repeated if this metadata attribute allows for multiple values.|
340 -|Text|TextType|Text is used to supply parallel multi-lingual textual values for the reported metadata attribute. This will be used if the text format of the metadata attribute has a type of string, and the multi-lingual value is set to true.|
341 -|StructuredText|XHTMLType|StructuredText is used to supply parallel multi-lingual structured (as XHTML) textual values for the reported metadata attribute. This will be used if the text format of the metadata attribute has a type of XHTML, and the multi-lingual value is set to true.|
342 -|Attribute|AttributeType|Att contains the reported metadata attribute values for the child metadata attributes.|
352 +(% style="width:1095.29px" %)
353 +|**Name**|**Type**|(% style="width:821px" %)**Documentation**
354 +|[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]|AnnotationsType|(% style="width:821px" %)[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]] is a reusable element the provides for a collection of [[annotations>>doc:sdmx:Glossary.Annotation.WebHome]]. It has been made global so that restrictions of types that extend AnnotatableType may reference it.
355 +|Value|xs:anySimpleType|(% style="width:821px" %)Value holds any simple value (enumerated or not) for the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. It can be repeated if this metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] allows for multiple values.
356 +|Text|TextType|(% style="width:821px" %)Text is used to supply parallel multi-lingual textual values for the reported metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. This will be used if the text format of the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] has a type of string, and the multi-lingual value is set to true.
357 +|StructuredText|XHTMLType|(% style="width:821px" %)StructuredText is used to supply parallel multi-lingual structured (as XHTML) textual values for the reported metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. This will be used if the text format of the metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] has a type of XHTML, and the multi-lingual value is set to true.
358 +|[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]|AttributeType|(% style="width:821px" %)Att contains the reported metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values for the child metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].
343 343  
344 344  = 3 Mapping to Structure-Specific Schemas =
345 345  
... ... @@ -354,54 +354,54 @@
354 354  In the subsequent sections, the following namespace prefixes are used:
355 355  
356 356  |**Namespace**|**Prefix**|
357 -|http://www.w3.org/2001/XMLSchema|xs|
358 -|http://www.sdmx.org/resources/sdmxml/schemas/v3_1/common|common|
359 -|http://www.sdmx.org/resources/sdmxml/schemas/v3_1/data/structurespecific|dsd|
360 -|<http://www.sdmx.org/resources/sdmxml/schemas/v3_1/metadata/generic>|metadata|
373 +|http:~/~/www.w3.org/2001/XMLSchema|xs|
374 +|http:~/~/www.sdmx.org/resources/sdmxml/schemas/v3_1/common|common|
375 +|http:~/~/www.sdmx.org/resources/sdmxml/schemas/v3_1/data/structurespecific|dsd|
376 +|<http:~/~/www.sdmx.org/resources/sdmxml/schemas/v3_1/metadata/generic>|metadata|
361 361  
362 362  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:
363 363  
364 364  **Schema:** Refers to the format specific schema in general, and in particular the root xs:schema element of that schema file.
365 365  
366 -**Global Element:** Refers to an element definition at the top level of the schema (i.e. an xs:element element in the root xs:schema element). It will define a name and type (name and type attributes) and possibly a substitution group (substitutionGroup attribute).
382 +**Global Element:** Refers to an element definition at the top (% style="color:#e74c3c" %)level(%%) of the schema (i.e. an xs:element element in the root xs:schema element). It will define a name and type (name and type [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]) and possibly a substitution group (substitutionGroup [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).
367 367  
368 -**Local Element:** Refers to an element definition within a complex type (i.e. an xs:element element contained within a xs:sequence element that is contained in a xs:complexType element). A local element must define a name and type (name and type attributes) and may also specify a minimum and maximum occurrence (minOccurs and maxOccurs attribute).
384 +**Local Element:** Refers to an element definition within a complex type (i.e. an xs:element element contained within a xs:sequence element that is contained in a xs:complexType element). A local element must define a name and type (name and type [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]) and may also specify a minimum and maximum occurrence (minOccurs and maxOccurs [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).
369 369  
370 370  **Qualified/Unqualified Element:** A qualified element is an element that must be referred to by the namespace in which it was defined. An unqualified element does not have a namespace associated with it. The structure-specific schemas make use of unqualified elements to that the structure-specific schemas can restrict the base content to meet the specific needs of the structure, while maintaining as much of the original document structure as possible.
371 371  
372 -**Element Reference:** Refers to an element definition within a complex type that is a reference to a global element (i.e. an xs:element element contained within a xs:sequence element that is contained in a xs:complexType element). An element reference must reference a global element (via its ref attribute) and may also specify a minimum and maximum occurrence (minOccurs and maxOccurs attribute).
388 +**Element Reference:** Refers to an element definition within a complex type that is a reference to a global element (i.e. an xs:element element contained within a xs:sequence element that is contained in a xs:complexType element). An element reference must reference a global element (via its ref [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]) and may also specify a minimum and maximum occurrence (minOccurs and maxOccurs [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).
373 373  
374 -**Complex Type:** Refers to a complex type definition. In this context, all complex type definitions occur at the top level of the schema (i.e. an xs:complexType element in the root xs:schema element). A complex type must define a name (name attribute) and may be made abstract (via the abstract attribute’s boolean value).
390 +**Complex Type:** Refers to a complex type definition. In this context, all complex type definitions occur at the top (% style="color:#e74c3c" %)level(%%) of the schema (i.e. an xs:complexType element in the root xs:schema element). A complex type must define a name (name [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]) and may be made abstract (via the abstract [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]’s boolean value).
375 375  
376 -**Simple Type:** Refers to a simple type definition. In this context, all simple type definitions occur at the top level of the schema (i.e. an xs:simpleType element in the root xs:schema element). In this context, a simple type will always be defined via a restriction (an xs:restriction element in the xs:simpleType element). The restriction will reference a base type.
392 +**Simple Type:** Refers to a simple type definition. In this context, all simple type definitions occur at the top (% style="color:#e74c3c" %)level(%%) of the schema (i.e. an xs:simpleType element in the root xs:schema element). In this context, a simple type will always be defined via a restriction (an xs:restriction element in the xs:simpleType element). The restriction will reference a base type.
377 377  
378 378  **Anonymous Type:** A complex or simple type definition which occurs within an element definition. The method is sometimes referred to a the "Russian-doll" technique as it creates nested constructs. Anonymous types are not given names and cannot be abstract. The can however, be derived from other types.
379 379  
380 380  **Content Group:** A group which defines a content model for reuse. This is contained in the xs:group element and is defined at the root of the schema. It allows for a common sequence or choice of elements to be reused across multiple types without having to redefine the sequence or choice in each type.
381 381  
382 -**Uniqueness Constraint:** A uniqueness constraint is defined within an element and is used to force descendent elements to be unique based on some criteria of it fields (elements or attributes). This is defined in an \<xs:unique\> element and has content of an \<xs:selector\> and multiple \<xs:field\> elements. The selector designates the descendants that must be unique (with an xpath attribute) and the field specifies which property of the selected element must be unique (also with an xpath attribute)
398 +**Uniqueness (% style="color:#e74c3c" %)Constraint(%%):** A uniqueness (% style="color:#e74c3c" %)constraint(%%) is defined within an element and is used to force descendent elements to be unique based on some criteria of it fields (elements or [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]). This is defined in an \<xs:unique\> element and has content of an \<xs:selector\> and multiple \<xs:field\> elements. The selector designates the descendants that must be unique (with an xpath [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]) and the field specifies which property of the selected element must be unique (also with an xpath [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]])
383 383  
384 -**Extension:** Refers to the definition of a complex type that is an extension of another complex type. The extension will always make a reference to a base. In the schema, this is defined within the xs:complexType element as a child xs:complexContent element containing an xs:extension element (with a base attribute).
400 +**Extension:** Refers to the definition of a complex type that is an extension of another complex type. The extension will always make a reference to a base. In the schema, this is defined within the xs:complexType element as a child xs:complexContent element containing an xs:extension element (with a base [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).
385 385  
386 -**Restriction:** Refers to the definition of a simple or complex type that is a restriction of another type of the same variety. The restriction will always make a reference to a base. In the schema, this is defined with an xs:restriction element (with a base attribute).
402 +**Restriction:** Refers to the definition of a simple or complex type that is a restriction of another type of the same variety. The restriction will always make a reference to a base. In the schema, this is defined with an xs:restriction element (with a base [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).
387 387  
388 -**Sequence:** Refers to a sequence of elements that may be defined as the root of a complex type content model, or as part of the content of a choice or another sequence. This is defined as an xs:sequence element. The sequence may specify a minimum and maximum occurrence (minOccurs and maxOccurs attribute).
404 +**Sequence:** Refers to a sequence of elements that may be defined as the root of a complex type content model, or as part of the content of a choice or another sequence. This is defined as an xs:sequence element. The sequence may specify a minimum and maximum occurrence (minOccurs and maxOccurs [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).
389 389  
390 -**Choice:** Refers to a choice of elements that may be defined as the root of a complex type content model, or as part of the content of a sequence or another choice. This is defined as an xs:choice element. The sequence may specify a minimum and maximum occurrence (minOccurs and maxOccurs attribute).
406 +**Choice:** Refers to a choice of elements that may be defined as the root of a complex type content model, or as part of the content of a sequence or another choice. This is defined as an xs:choice element. The sequence may specify a minimum and maximum occurrence (minOccurs and maxOccurs [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).
391 391  
392 -**Facet:** Refers to a single detail of a simple type restriction. This is represented by elements such as xs:minInclusive, xs:totalDigits, xs:minLength, and is contained in the xs:restriction element of a simple type definition. The value of the facet is contained in a value attribute of the particular element.
408 +**[[Facet>>doc:sdmx:Glossary.Facet.WebHome]]:** Refers to a single detail of a simple type restriction. This is represented by elements such as xs:minInclusive, xs:totalDigits, xs:minLength, and is contained in the xs:restriction element of a simple type definition. The value of the [[facet>>doc:sdmx:Glossary.Facet.WebHome]] is contained in a value [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] of the particular element.
393 393  
394 -**Enumeration:** Refers to an enumerated value of a simple type definition. It is represented by an xs:enumeration element contained within an xs:restriction element of a simple type definition. An enumeration defines a value (in the value attribute) and documentation (in xs:documentation elements contained in an xs:annotation element).
410 +**Enumeration:** Refers to an enumerated value of a simple type definition. It is represented by an xs:enumeration element contained within an xs:restriction element of a simple type definition. An enumeration defines a value (in the value [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]) and documentation (in xs:documentation elements contained in an xs:[[annotation>>doc:sdmx:Glossary.Annotation.WebHome]] element).
395 395  
396 -**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).
412 +**XML [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]:** Refers to the definition of an XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for a complex type (i.e. and xs:[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] element in a xs:complexType element). An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] must define a name and type (name and type [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]) and may also specify a usage (use [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]).
397 397  
398 398  == 3.2 Namespace Rules ==
399 399  
400 -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.
416 +Each format specific schema will specify its namespace in the target namespace of the schema (the targetNamespace [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] of the schema). This document also assumes that the root namespace (that which is defined by the xmlns [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]) 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.
401 401  
402 402  The format specific schemas will incorporate the core format namespace and the common namespace by importing the schemas (via the xs:import element). If necessary, additional namespaces may be imported and referenced.
403 403  
404 -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".
420 +For the purpose of the descriptions here, the default element form for the schema (as specified in the elementFormDefault [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] of the schema) is "qualified", and the default [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] form (as specified in the attributeFormDefault [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] of the schema) is "unqualified".
405 405  
406 406  == 3.3 General Rules ==
407 407  
... ... @@ -409,281 +409,275 @@
409 409  
410 410  === 3.3.1 Component Name Determination ===
411 411  
412 -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 are as follows:
428 +When required to create an XML element or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], the name for a [[component>>doc:sdmx:Glossary.Component.WebHome]] is always its identifier. However, the identifier may be inherited. Therefore, the general rules are as follows:
413 413  
414 -1. If the component defines an identifier, the element or attribute name is the value of that identifier
415 -2. 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 identifier).
430 +1. If the [[component>>doc:sdmx:Glossary.Component.WebHome]] defines an identifier, the element or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name is the value of that identifier
431 +2. Otherwise, the element or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name is the identifier of the (% style="color:#e74c3c" %)concept(%%) from which it takes its semantic (Note that this is technically the [[component>>doc:sdmx:Glossary.Component.WebHome]] identifier).
416 416  
417 417  === 3.3.2 Representation Determination ===
418 418  
419 -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).
435 +Every [[component>>doc:sdmx:Glossary.Component.WebHome]] has a [[representation>>doc:sdmx:Glossary.Representation.WebHome]] associated with it, whether it is defined as a local [[representation>>doc:sdmx:Glossary.Representation.WebHome]] in the [[component>>doc:sdmx:Glossary.Component.WebHome]] definition, or it is inherited from the (% style="color:#e74c3c" %)concept(%%) from which the [[component>>doc:sdmx:Glossary.Component.WebHome]] takes it semantic (as defined in the (% style="color:#e74c3c" %)concept(%%) identity of the [[component>>doc:sdmx:Glossary.Component.WebHome]]).
420 420  
421 -The representation of a component is determined by the following precedence:
437 +The [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of a [[component>>doc:sdmx:Glossary.Component.WebHome]] is determined by the following precedence:
422 422  
423 -1. The local representation defined by the component
424 -2. The core representation defined in the concept from which the component takes its semantic
425 -3. A default representation of an un-faceted text format with a data type of String.
439 +1. The local [[representation>>doc:sdmx:Glossary.Representation.WebHome]] defined by the [[component>>doc:sdmx:Glossary.Component.WebHome]]
440 +1. The core [[representation>>doc:sdmx:Glossary.Representation.WebHome]] defined in the (% style="color:#e74c3c" %)concept(%%) from which the [[component>>doc:sdmx:Glossary.Component.WebHome]] takes its semantic
441 +1. A default [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of an un-faceted text format with a data type of String.
426 426  
427 -The representation will either define a text format, an enumeration with an enumeration format, or a union of the former with the value of a irrelevant representation ‘’ (tilde).
443 +The [[representation>>doc:sdmx:Glossary.Representation.WebHome]] will either define a text format, an enumeration with an enumeration format, or a union of the former with the value of a irrelevant [[representation>>doc:sdmx:Glossary.Representation.WebHome]] ‘’ (tilde).
428 428  
429 -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 a codelist, hierarchy, or value list, for which an enumerated list of possible values can be created.
445 +A text format consists of a data type and an optional collection of [[facets>>doc:sdmx:Glossary.Facet.WebHome]]. It is the combination of these which determine the exact nature of the [[component>>doc:sdmx:Glossary.Component.WebHome]] [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. An enumeration consists of a reference to a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]], [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]], or value list, for which an enumerated list of possible values can be created.
430 430  
431 431  === 3.3.3 Simple / Primitive Type Determination ===
432 432  
433 -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](#332-Representation-Determination).
449 +For any given [[representation>>doc:sdmx:Glossary.Representation.WebHome]], 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>>doc:sdmx:Glossary.Component.WebHome]] based on its [determined [[representation>>doc:sdmx:Glossary.Representation.WebHome]]](#332-[[Representation>>doc:sdmx:Glossary.Representation.WebHome]]-Determination).
434 434  
435 -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.
451 +For example, a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] may inherit its [[representation>>doc:sdmx:Glossary.Representation.WebHome]] for a (% style="color:#e74c3c" %)concept(%%), and the data type of a [[representation>>doc:sdmx:Glossary.Representation.WebHome]] 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 (% style="color:#e74c3c" %)concepts(%%) to avoid having to look up the (% style="color:#e74c3c" %)concept(%%) core [[representation>>doc:sdmx:Glossary.Representation.WebHome]] for very [[component>>doc:sdmx:Glossary.Component.WebHome]]. In this case, the type may be given a name based on the (% style="color:#e74c3c" %)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>>doc:sdmx:Glossary.Dimension.WebHome]], although named after the (% style="color:#e74c3c" %)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.
436 436  
437 437  === 3.3.4 Representation with Codelist Enumeration ===
438 438  
439 -A representation which defines an enumeration from a codelist or hierarchy will result in a simple type that is a restriction of the common:IDType. The simple type will define enumerations for each code in the codelist or hierarchy, accounting for extensions. The value for these enumerations will be identifier of the item. If desired, the names of the item may be placed in the documentation of the enumeration, but this is not required. Example:
455 +A [[representation>>doc:sdmx:Glossary.Representation.WebHome]] which defines an enumeration from a [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] or [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] will result in a simple type that is a restriction of the common:IDType. The simple type will define enumerations for each [[code>>doc:sdmx:Glossary.Code.WebHome]] in the [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] or [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]], accounting for extensions. The value for these enumerations will be identifier of the item. If desired, the names of the item may be placed in the documentation of the enumeration, but this is not required. Example:
440 440  
441 -xml
442 - <xs:simpleType name="ESTAT.CL\_COUNTRY.1.0">
443 - <xs:restriction base="common:IDType">
444 - <xs:enumeration value="BE">
445 - <xs:annotation>
446 - <xs:documentation xml:lang="en">Belgium</xs:documentation>
447 - </xs:annotation>
448 - </xs:enumeration>
457 +> <xs:simpleType name="ESTAT.CL\_COUNTRY.1.0">
458 +> <xs:restriction base="common:IDType">
459 +> <xs:enumeration value="BE">
460 +> <xs:annotation>
461 +> <xs:documentation xml:lang="en">Belgium</xs:documentation>
462 +> </xs:annotation>
463 +> </xs:enumeration>
449 449  
450 -
451 451  === 3.3.5 Representation with Value List Enumeration ===
452 452  
453 -A representation which defines an enumeration from a value list will result in a simple type that is a restriction of the xs:string data type. The simple type will define enumerations for each value item in the value list. The value for these enumerations will be identifier of the item. If desired, the names of the item may be placed in the documentation of the enumeration, but this is not required.
467 +A [[representation>>doc:sdmx:Glossary.Representation.WebHome]] which defines an enumeration from a value list will result in a simple type that is a restriction of the xs:string data type. The simple type will define enumerations for each value item in the value list. The value for these enumerations will be identifier of the item. If desired, the names of the item may be placed in the documentation of the enumeration, but this is not required.
454 454  
455 455  === 3.3.6 Representation with Simple Text Format ===
456 456  
457 -A representation which defines a simple text format will result in a simple type or primitive type. The representation is simple if none of the following conditions are true:
471 +A [[representation>>doc:sdmx:Glossary.Representation.WebHome]] which defines a simple text format will result in a simple type or primitive type. The [[representation>>doc:sdmx:Glossary.Representation.WebHome]] is simple if none of the following conditions are true:
458 458  
459 -* representation max occurs is greater than 1
473 +* [[representation>>doc:sdmx:Glossary.Representation.WebHome]] max occurs is greater than 1
460 460  * text format data type is XHMTL
461 461  * text format is multi-lingual
462 462  
463 -If the representation is not simple, see the rules in the following section for complex text formats. If the representation is simple, the first step is to determine the base type from the text format data type:
477 +If the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] is not simple, see the rules in the following section for complex text formats. If the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] is simple, the first step is to determine the base type from the text format data type:
464 464  
465 -|**SDMX Data Type**|**XML Schema Data Type**|
466 -|String|xs:string|
467 -|AlphaNumeric|common:AlphaNumericType|
468 -|Alpha|common:AlphaType|
469 -|Numeric|common:NumericType|
470 -|BigInteger|xs:integer|
471 -|Integer|xs:int|
472 -|Long|xs:long|
473 -|Short|xs:short|
474 -|Decimal|xs:decimal|
475 -|Float|xs:float|
476 -|Double|xs:double|
477 -|Boolean|xs:Boolean|
478 -|URI|xs:anyURI|
479 -|Count|xs:integer|
480 -|InclusiveValueRange|xs:decimal|
481 -|ExclusiveValueRange|xs: decimal|
482 -|Incremental|xs: decimal|
483 -|ObservationalTimePeriod|common:ObservationalTimePeriodType|
484 -|StandardTimePeriod|common:StandardTimePeriodType|
485 -|BasicTimePeriod|common:BasicTimePeriodType|
486 -|GregorianTimePeriod|common:GregorianTimePeriodType|
487 -|GregorianYear|xs:gYear|
488 -|GregorianYearMonth|xs:gYearMonth|
489 -|GregorianDay|xs:date|
490 -|ReportingTimePeriod|common:ReportingTimePeriodType|
491 -|ReportingYear|common:ReportingYearType|
492 -|ReportingSemester|common:ReportingSemesterType|
493 -|ReportingTrimester|common:ReportingTrimesterType|
494 -|ReportingQuarter|common:ReportingQuarterType|
495 -|ReportingMonth|common:ReportingMonthType|
496 -|ReportingWeek|common:ReportingWeekType|
497 -|ReportingDay|common:ReportingDayType|
498 -|DateTime|xs:dateTime|
499 -|TimeRange|common:TimeRangeType|
500 -|Month|xs:gMonth|
501 -|MonthDay|xs:gMonthDay|
502 -|Day|xs:gDay|
503 -|Time|xs:time|
504 -|Duration|xs:duration|
505 -|GeospatialInformation|xs:string|
506 -|XHTML|See the following section for complex representations|
479 +(% style="width:679.294px" %)
480 +|(% style="width:286px" %)**SDMX Data Type**|(% style="width:390px" %)**XML Schema Data Type**
481 +|(% style="width:286px" %)String|(% style="width:390px" %)xs:string
482 +|(% style="width:286px" %)AlphaNumeric|(% style="width:390px" %)common:AlphaNumericType
483 +|(% style="width:286px" %)Alpha|(% style="width:390px" %)common:AlphaType
484 +|(% style="width:286px" %)Numeric|(% style="width:390px" %)common:NumericType
485 +|(% style="width:286px" %)BigInteger|(% style="width:390px" %)xs:integer
486 +|(% style="width:286px" %)Integer|(% style="width:390px" %)xs:int
487 +|(% style="width:286px" %)Long|(% style="width:390px" %)xs:long
488 +|(% style="width:286px" %)Short|(% style="width:390px" %)xs:short
489 +|(% style="width:286px" %)Decimal|(% style="width:390px" %)xs:decimal
490 +|(% style="width:286px" %)Float|(% style="width:390px" %)xs:float
491 +|(% style="width:286px" %)Double|(% style="width:390px" %)xs:double
492 +|(% style="width:286px" %)Boolean|(% style="width:390px" %)xs:Boolean
493 +|(% style="width:286px" %)URI|(% style="width:390px" %)xs:anyURI
494 +|(% style="width:286px" %)Count|(% style="width:390px" %)xs:integer
495 +|(% style="width:286px" %)InclusiveValueRange|(% style="width:390px" %)xs:decimal
496 +|(% style="width:286px" %)ExclusiveValueRange|(% style="width:390px" %)xs: decimal
497 +|(% style="width:286px" %)Incremental|(% style="width:390px" %)xs: decimal
498 +|(% style="width:286px" %)ObservationalTimePeriod|(% style="width:390px" %)common:ObservationalTimePeriodType
499 +|(% style="width:286px" %)StandardTimePeriod|(% style="width:390px" %)common:StandardTimePeriodType
500 +|(% style="width:286px" %)BasicTimePeriod|(% style="width:390px" %)common:BasicTimePeriodType
501 +|(% style="width:286px" %)GregorianTimePeriod|(% style="width:390px" %)common:GregorianTimePeriodType
502 +|(% style="width:286px" %)GregorianYear|(% style="width:390px" %)xs:gYear
503 +|(% style="width:286px" %)GregorianYearMonth|(% style="width:390px" %)xs:gYearMonth
504 +|(% style="width:286px" %)GregorianDay|(% style="width:390px" %)xs:date
505 +|(% style="width:286px" %)ReportingTimePeriod|(% style="width:390px" %)common:ReportingTimePeriodType
506 +|(% style="width:286px" %)ReportingYear|(% style="width:390px" %)common:ReportingYearType
507 +|(% style="width:286px" %)ReportingSemester|(% style="width:390px" %)common:ReportingSemesterType
508 +|(% style="width:286px" %)ReportingTrimester|(% style="width:390px" %)common:ReportingTrimesterType
509 +|(% style="width:286px" %)ReportingQuarter|(% style="width:390px" %)common:ReportingQuarterType
510 +|(% style="width:286px" %)ReportingMonth|(% style="width:390px" %)common:ReportingMonthType
511 +|(% style="width:286px" %)ReportingWeek|(% style="width:390px" %)common:ReportingWeekType
512 +|(% style="width:286px" %)ReportingDay|(% style="width:390px" %)common:ReportingDayType
513 +|(% style="width:286px" %)DateTime|(% style="width:390px" %)xs:dateTime
514 +|(% style="width:286px" %)TimeRange|(% style="width:390px" %)common:TimeRangeType
515 +|(% style="width:286px" %)Month|(% style="width:390px" %)xs:gMonth
516 +|(% style="width:286px" %)MonthDay|(% style="width:390px" %)xs:gMonthDay
517 +|(% style="width:286px" %)Day|(% style="width:390px" %)xs:gDay
518 +|(% style="width:286px" %)Time|(% style="width:390px" %)xs:time
519 +|(% style="width:286px" %)Duration|(% style="width:390px" %)xs:duration
520 +|(% style="width:286px" %)GeospatialInformation|(% style="width:390px" %)xs:string
521 +|(% style="width:286px" %)XHTML|(% style="width:390px" %)See the following section for complex representations
507 507  
508 -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):
523 +If the text format does not specify any further [[facets>>doc:sdmx:Glossary.Facet.WebHome]], 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>>doc:sdmx:Glossary.Facet.WebHome]] 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>>doc:sdmx:Glossary.Facet.WebHome]] according to the following table (the values are (% style="color:#e74c3c" %)mapped(%%) as is):
509 509  
510 -|**SDMX Facet**|**XML Schema Facet**|
511 -|minLength|xs:minLength|
512 -|maxLength|xs:maxLength|
513 -|minValue[^1]|if ExclusiveValueRange: xs:minExclusives, else: xs:minInclusive|
514 -|maxValue[^1]|if ExclusiveValueRange: xs:maxExclusives, else: xs:maxInclusive|
515 -|decimals[^1]|xs:fractionDigits|
516 -|pattern|xs:pattern|
525 +(% style="width:1007.29px" %)
526 +|(% style="width:267px" %)**SDMX Facet**|(% style="width:729px" %)**XML Schema Facet**
527 +|(% style="width:267px" %)minLength|(% style="width:729px" %)xs:minLength
528 +|(% style="width:267px" %)maxLength|(% style="width:729px" %)xs:maxLength
529 +|(% style="width:267px" %)minValue{{footnote}}Note that these options only apply to numeric representations and should be ignored if the data type is non-numeric.{{/footnote}}|(% style="width:729px" %)if ExclusiveValueRange: xs:minExclusives, else: xs:minInclusive
530 +|(% style="width:267px" %)maxValue^^1^^|(% style="width:729px" %)if ExclusiveValueRange: xs:maxExclusives, else: xs:maxInclusive
531 +|(% style="width:267px" %)decimals^^1^^|(% style="width:729px" %)xs:fractionDigits
532 +|(% style="width:267px" %)pattern|(% style="width:729px" %)xs:pattern
517 517  
518 -[^1]: Note that these options only apply to numeric representations and should be ignored if the data type is non-numeric.
534 +Any other [[facets>>doc:sdmx:Glossary.Facet.WebHome]] are informational only and will not affect the determined type.
519 519  
520 -Any other facets are informational only and will not affect the determined type.
521 -
522 522  === 3.3.7 Representation for Not Applicable Dimensions ===
523 523  
524 -Not applicable dimensions, i.e., when reported measures or attributes are not attached to those dimensions, take as value the tilde ‘’ character. This is required for datasets defined by a DSD that has the ‘evolving structure’ property set to true and that includes data from dataflows, which only use a subset of dimensions as defined by a dimension constraint. This is also required for data-related higher-level (i.e., attached to dataflow or partial list of Dimensions) reference metadata attributes that don’t have a fixed pre-defined attachment.
538 +Not applicable [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]], i.e., when reported [[measures>>doc:sdmx:Glossary.Measure.WebHome]] or [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] are not attached to those [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]], take as value the tilde ‘’ character. This is required for [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] defined by a [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] that has the ‘evolving structure’ property set to true and that includes data from [[dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]], which only use a subset of [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] as defined by a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (% style="color:#e74c3c" %)constraint(%%). This is also required for data-related higher-(% style="color:#e74c3c" %)level(%%) (i.e., attached to [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] or partial list of [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]) [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] that don’t have a fixed pre-defined attachment.
525 525  
526 -To support a specific type and allow for a not applicable dimension value, the structure-specific schema must union the type with the common:NotApplicableType, which enumerates the tilde ‘’ character. This is as shown in the following example:
540 +To support a specific type and allow for a not applicable [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] value, the structure-specific schema must union the type with the common:NotApplicableType, which enumerates the tilde ‘’ character. This is as shown in the following example:
527 527  
528 -xml
529 - <xs:simpleType name="DecimalOrNotApplicableType">
530 - <xs:union memberTypes="xs:decimal common:NotApplicableType"/>
531 - </xs:simpleType>
542 +> <xs:simpleType name="DecimalOrNotApplicableType">
543 +> <xs:union memberTypes="xs:decimal common:NotApplicableType"/>
544 +> </xs:simpleType>
532 532  
533 533  For enumerated types, the generated structure-specific schema can include the special value in the enumeration or create a union between the enumerated type and the common:NotApplicableType.
534 534  
535 535  Option 1: Augmenting the enumeration with the special value
536 536  
537 -xml
538 - <xs:simpleType name="CL\_SUBINDICATOR\_OR\_NOT\_APPLICABLE">
539 - <xs:union memberTypes="CL\_SUBINDICATOR common:NotApplicableType"/>
540 - </xs:simpleType>
550 +> <xs:simpleType name="CL\_SUBINDICATOR\_OR\_NOT\_APPLICABLE">
551 +> <xs:union memberTypes="CL\_SUBINDICATOR common:NotApplicableType"/>
552 +> </xs:simpleType>
541 541  
542 542  Option 2: Extending the enumeration with the special value
543 543  
544 -xml
545 - <xs:simpleType name="CL\_ SUBINDICATOR ">
546 - <xs:restriction base="xs:string">
547 - <xs:enumeration value="A"/>
548 - <xs:enumeration value=""/>
549 - <xs:restriction>
550 - </xs:simpleType>
556 +> <xs:simpleType name="CL\_ SUBINDICATOR ">
557 +> <xs:restriction base="xs:string">
558 +> <xs:enumeration value="A"/>
559 +> <xs:enumeration value=""/>
560 +> <xs:restriction>
561 +> </xs:simpleType>
551 551  
552 552  For convenience the common schema provides the union types for the following data types.
553 553  
554 -|**SDMX Data Type**|**XML Schema Data Type**|
555 -|AlphaNumeric|common:AlphaNumericOrNotApplicableType|
556 -|Alpha|common:AlphaOrNotApplicableType|
557 -|Numeric|common:NumericOrNotApplicableType|
558 -|BigInteger|common:IntegerOrNotApplicableType|
559 -|Integer|common:IntOrNotApplicableType|
560 -|Long|common:LongOrNotApplicableType|
561 -|Short|common:ShortOrNotApplicableType|
562 -|Decimal|common:DecimalOrNotApplicableType|
563 -|Float|common:FloatOrNotApplicableType|
564 -|Double|common:DoubleOrNotApplicableType|
565 -|Boolean|common:BooleanOrNotApplicableType|
566 -|Count|common:IntegerOrNotApplicableType|
567 -|InclusiveValueRange|common:DecimalOrNotApplicableType|
568 -|ExclusiveValueRange|common:DecimalOrNotApplicableType|
569 -|Incremental|common:DecimalOrNotApplicableType|
570 -|ObservationalTimePeriod|common:ObservationalTimePeriodOrNotApplicableType|
571 -|StandardTimePeriod|common:StandardTimePeriodOrNotApplicableType|
572 -|BasicTimePeriod|common:BasicTimePeriodType|
573 -|GregorianTimePeriod|common:GregorianTimePeriodOrNotApplicableType|
574 -|ReportingTimePeriod|common:ReportingTimePeriodOrNotApplicableType|
575 -|ReportingYear|common:ReportingYearOrNotApplicableType|
576 -|ReportingSemester|common:ReportingSemesterOrNotApplicableType|
577 -|ReportingTrimester|common:ReportingTrimesterOrNotApplicableType|
578 -|ReportingQuarter|common:ReportingQuarterOrNotApplicableType|
579 -|ReportingMonth|common:ReportingMonthOrNotApplicableType|
580 -|ReportingWeek|common:ReportingWeekOrNotApplicableType|
581 -|ReportingDay|common:ReportingDayOrNotApplicableType|
582 -|TimeRange|common:TimeRangeOrNotApplicableType|
565 +(% style="width:747.294px" %)
566 +|**SDMX Data Type**|(% style="width:418px" %)**XML Schema Data Type**
567 +|AlphaNumeric|(% style="width:418px" %)common:AlphaNumericOrNotApplicableType
568 +|Alpha|(% style="width:418px" %)common:AlphaOrNotApplicableType
569 +|Numeric|(% style="width:418px" %)common:NumericOrNotApplicableType
570 +|BigInteger|(% style="width:418px" %)common:IntegerOrNotApplicableType
571 +|Integer|(% style="width:418px" %)common:IntOrNotApplicableType
572 +|Long|(% style="width:418px" %)common:LongOrNotApplicableType
573 +|Short|(% style="width:418px" %)common:ShortOrNotApplicableType
574 +|Decimal|(% style="width:418px" %)common:DecimalOrNotApplicableType
575 +|Float|(% style="width:418px" %)common:FloatOrNotApplicableType
576 +|Double|(% style="width:418px" %)common:DoubleOrNotApplicableType
577 +|Boolean|(% style="width:418px" %)common:BooleanOrNotApplicableType
578 +|Count|(% style="width:418px" %)common:IntegerOrNotApplicableType
579 +|InclusiveValueRange|(% style="width:418px" %)common:DecimalOrNotApplicableType
580 +|ExclusiveValueRange|(% style="width:418px" %)common:DecimalOrNotApplicableType
581 +|Incremental|(% style="width:418px" %)common:DecimalOrNotApplicableType
582 +|ObservationalTimePeriod|(% style="width:418px" %)common:ObservationalTimePeriodOrNotApplicableType
583 +|StandardTimePeriod|(% style="width:418px" %)common:StandardTimePeriodOrNotApplicableType
584 +|BasicTimePeriod|(% style="width:418px" %)common:BasicTimePeriodType
585 +|GregorianTimePeriod|(% style="width:418px" %)common:GregorianTimePeriodOrNotApplicableType
586 +|ReportingTimePeriod|(% style="width:418px" %)common:ReportingTimePeriodOrNotApplicableType
587 +|ReportingYear|(% style="width:418px" %)common:ReportingYearOrNotApplicableType
588 +|ReportingSemester|(% style="width:418px" %)common:ReportingSemesterOrNotApplicableType
589 +|ReportingTrimester|(% style="width:418px" %)common:ReportingTrimesterOrNotApplicableType
590 +|ReportingQuarter|(% style="width:418px" %)common:ReportingQuarterOrNotApplicableType
591 +|ReportingMonth|(% style="width:418px" %)common:ReportingMonthOrNotApplicableType
592 +|ReportingWeek|(% style="width:418px" %)common:ReportingWeekOrNotApplicableType
593 +|ReportingDay|(% style="width:418px" %)common:ReportingDayOrNotApplicableType
594 +|TimeRange|(% style="width:418px" %)common:TimeRangeOrNotApplicableType
583 583  
584 584  === 3.3.8 Representation for Intentionally Missing Measure and Attribute Values ===
585 585  
586 -For intentionally missing measure and attribute values, even if mandatory, the following special values can be used:
598 +For intentionally missing [[measure>>doc:sdmx:Glossary.Measure.WebHome]] and [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values, even if mandatory, the following special values can be used:
587 587  
588 588  * NaN for all numeric types (float, double)
589 589  * #N/A for all other types
590 590  
591 -To support a specific type and allow for an intentionally missing measure or attribute value, the structure-specific schema must union the type with the common:MissingType, which enumerates the #N/A string. Note that XML natively already supports NaN for float and double values.
603 +To support a specific type and allow for an intentionally missing [[measure>>doc:sdmx:Glossary.Measure.WebHome]] or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] value, the structure-specific schema must union the type with the common:MissingType, which enumerates the #N/A string. Note that XML natively already supports NaN for float and double values.
592 592  
593 593  This union is as shown in the following example:
594 594  
595 -xml
596 - <xs:simpleType name="DecimalOrMissingType">
597 - <xs:union memberTypes="xs:decimal common:MissingType"/>
598 - </xs:simpleType>
607 +> <xs:simpleType name="DecimalOrMissingType">
608 +> <xs:union memberTypes="xs:decimal common:MissingType"/>
609 +> </xs:simpleType>
599 599  
600 600  For enumerated types, the generated structure-specific schema can include the special value in the enumeration or create a union between the enumerated type and the common:MissingType.
601 601  
602 602  Option 1: Augmenting the enumeration with the special value
603 603  
604 -xml
605 - <xs:simpleType name="CL\_SUBINDICATOR\_OR\_NOT\_APPLICABLE">
606 - <xs:union memberTypes="CL\_SUBINDICATOR common:MissingType"/>
607 - </xs:simpleType>
615 + > <xs:simpleType name="CL\_SUBINDICATOR\_OR\_NOT\_APPLICABLE">
616 + > <xs:union memberTypes="CL\_SUBINDICATOR common:MissingType"/>
617 + > </xs:simpleType>
608 608  
609 609  Option 2: Extending the enumeration with the special value
610 610  
611 -xml
612 - <xs:simpleType name="CL\_ SUBINDICATOR ">
613 - <xs:restriction base="xs:string">
614 - <xs:enumeration value="A"/>
615 - <xs:enumeration value="#N/A"/>
616 - <xs:restriction>
617 - </xs:simpleType>
621 +> <xs:simpleType name="CL\_ SUBINDICATOR ">
622 +> <xs:restriction base="xs:string">
623 +> <xs:enumeration value="A"/>
624 +> <xs:enumeration value="#N/A"/>
625 +> <xs:restriction>
626 +> </xs:simpleType>
618 618  
619 619  For convenience the common schema provides the union types for the following data types.
620 620  
621 -|**SDMX Data Type**|**XML Schema Data Type**|
622 -|AlphaNumeric|common:AlphaNumericOrMissingType|
623 -|Alpha|common:AlphaOrMissingType|
624 -|Numeric|common:NumericOrMissingType|
625 -|BigInteger|common:IntegerOrMissingType|
626 -|Integer|common:IntOrMissingType|
627 -|Long|common:LongOrMissingType|
628 -|Short|common:ShortOrMissingType|
629 -|Decimal|common:DecimalOrMissingType|
630 -|Float|common:FloatOrMissingType|
631 -|Double|common:DoubleOrMissingType|
632 -|Boolean|common:BooleanOrMissingType|
633 -|Count|common:IntegerOrMissingType|
634 -|InclusiveValueRange|common:DecimalOrMissingType|
635 -|ExclusiveValueRange|common:DecimalOrMissingType|
636 -|Incremental|common:DecimalOrMissingType|
637 -|ObservationalTimePeriod|common:ObservationalTimePeriodOrMissingType|
638 -|StandardTimePeriod|common:StandardTimePeriodOrMissingType|
639 -|BasicTimePeriod|common:BasicTimePeriodType|
640 -|GregorianTimePeriod|common:GregorianTimePeriodOrMissingType|
641 -|ReportingTimePeriod|common:ReportingTimePeriodOrMissingType|
642 -|ReportingYear|common:ReportingYearOrMissingType|
643 -|ReportingSemester|common:ReportingSemesterOrMissingType|
644 -|ReportingTrimester|common:ReportingTrimesterOrMissingType|
645 -|ReportingQuarter|common:ReportingQuarterOrMissingType|
646 -|ReportingMonth|common:ReportingMonthOrMissingType|
647 -|ReportingWeek|common:ReportingWeekOrMissingType|
648 -|ReportingDay|common:ReportingDayOrMissingType|
649 -|TimeRange|common:TimeRangeOrMissingType|
630 +(% style="width:804.294px" %)
631 +|(% style="width:279px" %)**SDMX Data Type**|(% style="width:522px" %)**XML Schema Data Type**
632 +|(% style="width:279px" %)AlphaNumeric|(% style="width:522px" %)common:AlphaNumericOrMissingType
633 +|(% style="width:279px" %)Alpha|(% style="width:522px" %)common:AlphaOrMissingType
634 +|(% style="width:279px" %)Numeric|(% style="width:522px" %)common:NumericOrMissingType
635 +|(% style="width:279px" %)BigInteger|(% style="width:522px" %)common:IntegerOrMissingType
636 +|(% style="width:279px" %)Integer|(% style="width:522px" %)common:IntOrMissingType
637 +|(% style="width:279px" %)Long|(% style="width:522px" %)common:LongOrMissingType
638 +|(% style="width:279px" %)Short|(% style="width:522px" %)common:ShortOrMissingType
639 +|(% style="width:279px" %)Decimal|(% style="width:522px" %)common:DecimalOrMissingType
640 +|(% style="width:279px" %)Float|(% style="width:522px" %)common:FloatOrMissingType
641 +|(% style="width:279px" %)Double|(% style="width:522px" %)common:DoubleOrMissingType
642 +|(% style="width:279px" %)Boolean|(% style="width:522px" %)common:BooleanOrMissingType
643 +|(% style="width:279px" %)Count|(% style="width:522px" %)common:IntegerOrMissingType
644 +|(% style="width:279px" %)InclusiveValueRange|(% style="width:522px" %)common:DecimalOrMissingType
645 +|(% style="width:279px" %)ExclusiveValueRange|(% style="width:522px" %)common:DecimalOrMissingType
646 +|(% style="width:279px" %)Incremental|(% style="width:522px" %)common:DecimalOrMissingType
647 +|(% style="width:279px" %)ObservationalTimePeriod|(% style="width:522px" %)common:ObservationalTimePeriodOrMissingType
648 +|(% style="width:279px" %)StandardTimePeriod|(% style="width:522px" %)common:StandardTimePeriodOrMissingType
649 +|(% style="width:279px" %)BasicTimePeriod|(% style="width:522px" %)common:BasicTimePeriodType
650 +|(% style="width:279px" %)GregorianTimePeriod|(% style="width:522px" %)common:GregorianTimePeriodOrMissingType
651 +|(% style="width:279px" %)ReportingTimePeriod|(% style="width:522px" %)common:ReportingTimePeriodOrMissingType
652 +|(% style="width:279px" %)ReportingYear|(% style="width:522px" %)common:ReportingYearOrMissingType
653 +|(% style="width:279px" %)ReportingSemester|(% style="width:522px" %)common:ReportingSemesterOrMissingType
654 +|(% style="width:279px" %)ReportingTrimester|(% style="width:522px" %)common:ReportingTrimesterOrMissingType
655 +|(% style="width:279px" %)ReportingQuarter|(% style="width:522px" %)common:ReportingQuarterOrMissingType
656 +|(% style="width:279px" %)ReportingMonth|(% style="width:522px" %)common:ReportingMonthOrMissingType
657 +|(% style="width:279px" %)ReportingWeek|(% style="width:522px" %)common:ReportingWeekOrMissingType
658 +|(% style="width:279px" %)ReportingDay|(% style="width:522px" %)common:ReportingDayOrMissingType
659 +|(% style="width:279px" %)TimeRange|(% style="width:522px" %)common:TimeRangeOrMissingType
650 650  
651 651  === 3.3.9 Representation with Complex Text Format ===
652 652  
653 -A representation which defines a complex text format will result in a complex type. The representation is complex if any of the following conditions are true:
663 +A [[representation>>doc:sdmx:Glossary.Representation.WebHome]] which defines a complex text format will result in a complex type. The [[representation>>doc:sdmx:Glossary.Representation.WebHome]] is complex if any of the following conditions are true:
654 654  
655 -* representation max occurs is greater than 1
665 +* [[representation>>doc:sdmx:Glossary.Representation.WebHome]] max occurs is greater than 1
656 656  * text format data type is XHMTL
657 657  * text format is multi-lingual
658 658  
659 659  The resulting complex type will be derived via restriction of the common:ValueType. In simple cases, there are pre-defined types that can be used:
660 660  
661 -* if the text format data type is XHTML, common:StructuredTextValueType can be used; note that this type cannot be further restricted – all other facets are ignored
662 -* if the text format is multi-lingual, common:TextValueType can be used; note that this type cannot be further restricted – all other facets are ignored
663 -* if the text format has no additional facets and the data type is:
664 - + Boolean, common:BooleanValueType can be used
665 - + String, common:StringValueType can be used
666 - + Integer, common:IntValueType can be used
667 - + Double, common:DoubleValueType can be used
668 - + ObservationalTimePeriod, common:ObservationalTimePeriodValueType can be used
671 +* if the text format data type is XHTML, common:StructuredTextValueType can be used; note that this type cannot be further restricted – all other [[facets>>doc:sdmx:Glossary.Facet.WebHome]] are ignored
672 +* if the text format is multi-lingual, common:TextValueType can be used; note that this type cannot be further restricted – all other [[facets>>doc:sdmx:Glossary.Facet.WebHome]] are ignored
673 +* if the text format has no additional [[facets>>doc:sdmx:Glossary.Facet.WebHome]] and the data type is:
674 +** Boolean, common:BooleanValueType can be used
675 +** String, common:StringValueType can be used
676 +** Integer, common:IntValueType can be used
677 +** Double, common:DoubleValueType can be used
678 +** ObservationalTimePeriod, common:ObservationalTimePeriodValueType can be used
669 669  
670 -If a pre-defined type cannot be used, one will have to be created. The complex type must define a simple content restriction of the common:ValueType. The restriction should define an anonymous simple type based on the text format data type and facets as described in the previous section.
680 +If a pre-defined type cannot be used, one will have to be created. The complex type must define a simple content restriction of the common:ValueType. The restriction should define an anonymous simple type based on the text format data type and [[facets>>doc:sdmx:Glossary.Facet.WebHome]] as described in the previous section.
671 671  
672 672  === 3.3.10 Type Names ===
673 673  
674 674  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.
675 675  
676 -* It the type is an enumeration from an item scheme, the recommended name is [Item Scheme Class].[Maintenance Agency].[Item Scheme ID].[Item Scheme Version]
677 -* If the type is based on a text format of a concept core representation, the recommended name is Concept.[Maintenance Agency].[Concept Scheme ID].[Concept Scheme Version].[Concept ID]
678 -* If the type is based on a text format of a component local representation, and;
679 - + 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]
680 - + The component id is only required to be unique within the component list and which defines it (e.g. a metadata attribute), the recommend name is [Component List ID].[Parent Component ID]\*.[Component ID]
686 +* It the type is an enumeration from an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]], the recommended name is ~[[[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] Class].[Maintenance Agency].~[[[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] ID].~[[[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] Version]
687 +* If the type is based on a text format of a (% style="color:#e74c3c" %)concept(%%) core [[representation>>doc:sdmx:Glossary.Representation.WebHome]], the recommended name is (% style="color:#e74c3c" %)Concept(%%).[Maintenance Agency].[(% style="color:#e74c3c" %)Concept(%%) Scheme ID].[(% style="color:#e74c3c" %)Concept(%%) Scheme Version].[(% style="color:#e74c3c" %)Concept(%%) ID]
688 +* If the type is based on a text format of a [[component>>doc:sdmx:Glossary.Component.WebHome]] local [[representation>>doc:sdmx:Glossary.Representation.WebHome]], and;
689 +** The [[component>>doc:sdmx:Glossary.Component.WebHome]] id is required to be unique for all [[components>>doc:sdmx:Glossary.Component.WebHome]] within the scope of the structure which defines it (e.g. a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]), the recommended name is ~[[[Component>>doc:sdmx:Glossary.Component.WebHome]] ID]
690 +** The [[component>>doc:sdmx:Glossary.Component.WebHome]] id is only required to be unique within the [[component>>doc:sdmx:Glossary.Component.WebHome]] list and which defines it (e.g. a metadata attribute), the recommend name is [Component List ID].[Parent Component ID]\*.[Component ID]
681 681  
682 682  === 3.3.11 Type Reuse ===
683 683  
684 684  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.
685 685  
686 -For example, an organisation my create predefined types for all of codelists and concept schemes which their structures utilize. These could be contained in a common schema with any namespace deemed appropriate. This would allow the structure-specific schemas generation process to recognize the reused components and not be concerned with regenerating types. The logical flow for setting the representation of a component might be as follows:
696 +For example, an organisation my create predefined types for all of [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] and [[concept schemes>>doc:sdmx:Glossary.Concept scheme.WebHome]] which their structures utilize. These could be contained in a common schema with any namespace deemed appropriate. This would allow the structure-specific schemas generation process to recognize the reused [[components>>doc:sdmx:Glossary.Component.WebHome]] and not be concerned with regenerating types. The logical flow for setting the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of a [[component>>doc:sdmx:Glossary.Component.WebHome]] might be as follows:
687 687  
688 688   Does the component define a local type?
689 689   Yes: Is that type enumerated?
... ... @@ -695,42 +695,47 @@
695 695  
696 696  == 3.4 Data-Structure-Specific Schema ==
697 697  
698 -Separate schemas will be created for the data structure depending on which dimension occurs at the observation level. The recommended target namespace of the data structured specific schema is: [Data Structure URN]:ObsLevelDim:[Observation Dimensions].
708 +Separate schemas will be created for the data structure depending on which [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] occurs at the observation (% style="color:#e74c3c" %)level(%%). The recommended target namespace of the data structured specific schema is: [Data Structure URN]:ObsLevelDim:[Observation Dimensions].
699 699  
700 -The rules for generating the data-structure-specific-schema are broken into sections based on the level within the structure (i.e. data set, group, series, attributes, observation). Each section will state the rules for each variation of the structure-specific format.
710 +The rules for generating the data-structure-specific-schema are broken into sections based on the (% style="color:#e74c3c" %)level(%%) within the structure (i.e. [[data set>>doc:sdmx:Glossary.Data set.WebHome]], group, series, [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]], observation). Each section will state the rules for each variation of the structure-specific format.
701 701  
702 702  === 3.4.1 DataSetType ===
703 703  
704 -A complex type named DataSetType must be created. Its content model will be derived via restriction. The base type of the restriction is dsd:DataSetType. The complex type content model will be as follows:
714 +A complex type named DataSetType must be created. Its content model will be derived via restriction. The base type of the restriction is [[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]:DataSetType. The complex type content model will be as follows:
705 705  
706 -1. A sequence consisting of:
707 -1. An element reference to common:Annotations, with a minimum occurrence of 0
708 - 2. A local element named DataProvider with the type common:DataProviderReferenceType, a form of unqualified and a minimum occurrence of 0
709 - 3. A choice with a minimum occurrence of 0 and a maximum occurrence of unbounded consisting of:
710 -1. A local element named Atts with a form of unqualified and a type of AttsType (as defined in the AttsType section which follows)
711 - 2. If the data structure defines groups, a local element named Group with a form of unqualified. The type of this element should be the type that is described in the GroupType section which follows.
712 - 3. If the dimension at the observation level is not AllDimensions, a local element named Series with a form of unqualified and a type of SeriesType (as defined in the SeriesType section which follows)
713 - 4. If the dimension at the observation level is AllDimensions, a local element named Obs with a form of unqualified and a type of ObsType (as defined in the ObsType section which follows)
714 - 4. If any metadata attribute usages defined in the data structure that declares an attribute relationship of dataflow, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurences of 0
716 +~1. A sequence consisting of:
715 715  
718 +* i. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0
719 +* ii  A local element named DataProvider with the type common:DataProviderReferenceType, a form of unqualified and a minimum occurrence of 0
720 +* iii  A choice with a minimum occurrence of 0 and a maximum occurrence of unbounded consisting of:
721 +** a.  A local element named Atts with a form of unqualified and a type of AttsType (as defined in the AttsType section which follows)
722 +** b. If the data structure defines groups, a local element named Group with a form of unqualified. The type of this element should be the type that is described in the GroupType section which follows.
723 +** c. If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) is not AllDimensions, a local element named Series with a form of unqualified and a type of SeriesType (as defined in the SeriesType section which follows)
724 +** d. If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) is AllDimensions, a local element named Obs with a form of unqualified and a type of ObsType (as defined in the ObsType section which follows)
725 +* iv. If any metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] usages defined in the data structure that declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] of [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurences of 0
726 +
716 716  === 3.4.2 GroupType ===
717 717  
718 718  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:
719 719  
720 -1. A sequence consisting of:
721 -1. An element reference to common:Annotations, with a minimum occurrence of 0
722 - 2. If any attributes defined in the data structure that declares an attribute relationship with the group, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
723 - 3. If any metadata attribute usages defined in the data structure that declares an attribute relationship with the group, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0
724 -2. An attribute for each dimension referenced by the group. The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is required
725 -3. An attribute for each data attribute with simple representation defined in the data structure that declares an attribute relationship with the group or specifies the group as an attachment group. The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is optional
731 +~1. A sequence consisting of:
732 +
733 +* i. An element reference to common:Annotations, with a minimum occurrence of 0
734 +* ii. If any attributes defined in the data structure that declares an attribute relationship with the group, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
735 +* iii. If any metadata attribute usages defined in the data structure that declares an attribute relationship with the group, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0
736 +
737 +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
738 +3. An attribute for each data attribute with simple representation defined in the data structure that declares an attribute relationship with the group or specifies the group as an attachment group. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is optional
726 726  4. An attribute named type with a type of common:IDType, usage of optional, and a fixed value of the identifier of the group
727 727  
728 728  If the data structure definition defines more than one group, an abstract complex type with name GroupType must be created. This type is used for the Group element in the DataSetType. Its content model will be derived via restriction of the dsd:GroupType. The complex type content model will be as follows:
729 729  
730 -1. A sequence consisting of:
731 -1. An element reference to common:Annotations, with a minimum occurrence of 0
732 - 2. If any attributes defined in the data structure that declares an attribute relationship with a group, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
733 - 3. If any metadata attribute usages defined in the data structure that declares an attribute relationship with any group, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0
743 +~1. A sequence consisting of:
744 +
745 +* i. An element reference to common:Annotations, with a minimum occurrence of 0
746 +* ii. If any attributes defined in the data structure that declares an attribute relationship with a group, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
747 +* iii. If any metadata attribute usages defined in the data structure that declares an attribute relationship with any group, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0
748 +
734 734  2. An attribute named type with a type of Group.ID, and a usage of optional
735 735  3. An anyAttribute declaration with a namespace of ##local##
736 736  
... ... @@ -738,12 +738,14 @@
738 738  
739 739  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:
740 740  
741 -1. A sequence consisting of:
742 -1. An element reference to common:Annotations, with a minimum occurrence of 0
743 - 2. If any attributes with complex representation defined in the data structure declares an attribute relationship with the group, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
744 - 3. If any metadata attribute usages defined in the data structure that declares an attribute relationship with the group, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0
745 -2. An attribute for each dimension referenced by the group. The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is required
746 -3. An attribute for each data attribute with simple representation defined in the data structure that declares an attribute relationship with the group or specifies the group as an attachment group. The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is optional
756 +~1. A sequence consisting of:
757 +
758 +* i. An element reference to common:Annotations, with a minimum occurrence of 0
759 +* ii. If any attributes with complex representation defined in the data structure declares an attribute relationship with the group, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
760 +* iii. If any metadata attribute usages defined in the data structure that declares an attribute relationship with the group, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0
761 +
762 +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
763 +3. An attribute for each data attribute with simple representation defined in the data structure that declares an attribute relationship with the group or specifies the group as an attachment group. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is optional
747 747  4. An attribute named type with a type of Group.ID, usage of optional, and a fixed value of the identifier of the group
748 748  
749 749  === 3.4.3 SeriesType ===
... ... @@ -750,40 +750,46 @@
750 750  
751 751  If the dimension at the observation is not AllDimensions, a complex type name SeriesType must be created. Its content model will be derived via restriction of dsd:SeriesType. The complex type content model will be as follows:
752 752  
753 -1. A sequence consisting of:
754 -1. An element reference to common:Annotations, with a minimum occurrence of 0
755 - 2. If any attributes with complex representation defined in the data structure declares an attribute relationship with a dimension that is not at the observation level, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
756 - 3. A local element named Obs with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of ObsType (as defined in the ObsType section which follows)
757 - 4. If any metadata attribute usages defined in the data structure that declares an attribute relationship with the series, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0
770 +~1. A sequence consisting of:
771 +
772 +* i. An element reference to common:Annotations, with a minimum occurrence of 0
773 +* ii. If any attributes with complex representation defined in the data structure declares an attribute relationship with a dimension that is not at the observation level, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
774 +* iii. A local element named Obs with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of ObsType (as defined in the ObsType section which follows)
775 +* iv. If any metadata attribute usages defined in the data structure that declares an attribute relationship with the series, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0
776 +
758 758  2. An attribute named TIME\_PERIOD with a type of common:ObservationalTimePeriod. If the dimension at the observation level is the time dimension (TIME\_PERIOD) or there is no time dimension defined by the data structure, a usage of prohibited; otherwise, a usage of required
759 -3. An attribute for each dimension defined by the data structure definition, except for the dimension at the observation level and the time dimension (TIME\_PERIOD). The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is required
760 -4. An attribute for each data attribute defined with simple representation in the data structure that declares an attribute relationship with any dimension outside of the dimension at the observation level (so long as it does not also declare an attachment group). The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is optional
778 +3. An attribute for each dimension defined by the data structure definition, except for the dimension at the observation level and the time dimension (TIME\_PERIOD). The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is required
779 +4. An attribute for each data attribute defined with simple representation in the data structure that declares an attribute relationship with any dimension outside of the dimension at the observation level (so long as it does not also declare an attachment group). The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is optional
761 761  
762 762  === 3.4.4 AttsType ===
763 763  
764 764  A complex type named AttsType must be created. Its content model will be derived via restriction of dsd:AttsType. The complex type content model will be as follows:
765 765  
766 -1. A sequence consisting of:
767 -1. An element reference to common:Annotations, with a minimum occurrence of 0
768 - 2. If any attributes with complex representation are defined in the data structure, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
785 +~1. A sequence consisting of:
786 +
787 +* i. An element reference to common:Annotations, with a minimum occurrence of 0
788 +* ii. If any attributes with complex representation are defined in the data structure, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
789 +
769 769  2. If there is no dimension (TIME\_PERIOD) defined by the data structure, an attribute named TIME\_PERIOD with a type of common:ObservationalTimePeriod, and a usage of prohibited
770 -3. An attribute for all dimension defined by the data structure definition. The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is optional
771 -4. An attribute for each data attribute defined with simple representation in the data structure. The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is optional
791 +3. An attribute for all dimension defined by the data structure definition. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is optional
792 +4. An attribute for each data attribute defined with simple representation in the data structure. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is optional
772 772  
773 773  === 3.4.5 ObsType ===
774 774  
775 775  A complex type name ObsType must be created. Its content model will be derived via restriction of the base type dsd:ObsType. The complex type content model will be as follows:
776 776  
777 -1. A sequence consisting of:
778 -1. An element reference to common:Annotations, with a minimum occurrence of 0
779 - 2. If any measures with complex representations are defined in the data structure, any attributes with complex representation that declare an attribute relationship with the observation, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
780 - 3. If any metadata attribute usages defined in the data structure that declares an attribute relationship with the observation, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0
798 +~1. A sequence consisting of:
799 +
800 +* i. An element reference to common:Annotations, with a minimum occurrence of 0
801 +* ii. If any measures with complex representations are defined in the data structure, any attributes with complex representation that declare an attribute relationship with the observation, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType
802 +* iii. If any metadata attribute usages defined in the data structure that declares an attribute relationship with the observation, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0
803 +
781 781  2. An attribute named TIME\_PERIOD with a type of common:
782 782   ObservationalTimePeriodValueType. If the dimension at the observation level is the time dimension (TIME\_PERIOD) or all dimensions and the time dimension is defined by the data structure, a usage of required; otherwise, a usage of prohibited
783 -3. If the dimension at the observation level is not all dimensions or the time dimension (TIME\_PERIOD), an attribute for the dimension at the observation level. The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is required
784 -4. If the dimension at the observation level is all dimensions, an attribute for each dimension defined by the data structure definition, except for the time dimension (TIME\_PERIOD). The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is required
785 -5. An attribute for each measure with simple representation defined by the data structure definition. The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) is defined according to the general rules defined in the previous section, and the usage is optional
786 -6. An attribute for each data attribute with simple representation defined in the data structure that declares an attribute relationship with the observation. The XML attribute [name](#331-Component-Name-Determination) and [type](#333-Simple--Primitive-Type-Determination) are defined according to the general rules defined in the previous section, and the usage is optional
806 +3. If the dimension at the observation level is not all dimensions or the time dimension (TIME\_PERIOD), an attribute for the dimension at the observation level. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is required
807 +4. If the dimension at the observation level is all dimensions, an attribute for each dimension defined by the data structure definition, except for the time dimension (TIME\_PERIOD). The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is required
808 +5. An attribute for each measure with simple representation defined by the data structure definition. The XML attribute name and type is defined according to the general rules defined in the previous section, and the usage is optional
809 +6. An attribute for each data attribute with simple representation defined in the data structure that declares an attribute relationship with the observation. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is optional
787 787  
788 788  === 3.4.6 CompType ===
789 789  
... ... @@ -814,7 +814,7 @@
814 814  
815 815  === 4.1.2 Replace Action ===
816 816  
817 -Data or data-related reference metadata is to be replaced, through either update, insert or delete depending on already existing information. A full replacement is hereby assumed to take place at specific “replacement levels”: for entire observations and for any specific dimension combination for data-related reference metadata attributes. Within these “replacement levels” the provided values are inserted or updated, and omitted values are deleted. Values provided for the other attributes (those above the observation level) are merged (see *Merge* action).
840 +Data or data-related reference metadata is to be replaced, through either update, insert or delete depending on already existing information. A full replacement is hereby assumed to take place at specific “//replacement levels//”: for entire observations and for any specific dimension combination for data-related reference metadata attributes. Within these “replacement levels” the provided values are inserted or updated, and omitted values are deleted. Values provided for the other attributes (those above the observation level) are merged (see //Merge// action).
818 818  
819 819  Only non-dimensional components (measure, attribute or reference metadata values) can be **omitted** (null or absent). Bulk replacing is thus not supported.
820 820  
... ... @@ -822,9 +822,9 @@
822 822  
823 823  Replacing non-existing elements is not resulting in an error.
824 824  
825 -All observations as well as the sets of data-related reference metadata attributes at specific dimension combinations impacted by the *Replace* action change their time stamp when used to update an SDMX storage system.
848 +All observations as well as the sets of data-related reference metadata attributes at specific dimension combinations impacted by the //Replace// action change their time stamp when used to update an SDMX storage system.
826 826  
827 -Because the *replace* action always takes place at specific levels, it cannot be used to replace a whole dataset or a whole series. However, a “*replace all*” effect can be achieved by combining a *Delete* dataset containing a completely wildcarded key (where all dimension values are omitted) with a *Merge* or *Replace* dataset within the same data message. Similarly, to replace a whole series, a message can combine a *delete* dataset containing only the partial key of the series (where the not used dimension values are omitted) with a *Merge* or *Replace* dataset for that series.
850 +Because the //replace// action always takes place at specific levels, it cannot be used to replace a whole dataset or a whole series. However, a //“replace all”// effect can be achieved by combining a //Delete// dataset containing a completely wildcarded key (where all dimension values are omitted) with a //Merge// or //Replace// dataset within the same data message. Similarly, to replace a whole series, a message can combine a //delete// dataset containing only the partial key of the series (where the not used dimension values are omitted) with a //Merge// or //Replace// dataset for that series.
828 828  
829 829  === 4.1.3 Delete Action ===
830 830  
... ... @@ -844,58 +844,59 @@
844 844  
845 845  The following convention is used to indicate the state of components in data messages:
846 846  
847 -| | |**Dimension value is**| |**Measure, attribute or reference metadata value is**| |
848 -| | |**Omitted**|**switched off**|**Omitted**|**Present**|
849 -|Action|Delete|bulk deletion: dimension value doesn't matter|only for irrelevant dimensions:1) higher-level (reference metadata) attributes not attached to this dimension(incl. TIME\_PERIOD)2) measures and attributes not attached to this dimension if the DSD allows for an ‘evolving structure’ (excl. TIME\_PERIOD)|to be deleted only if **all** non-dimension components are omitted|to be deleted|
850 -| |Merge|*bulk merge is not permitted*|(see above)|not to be changed|to be updated/inserted|
851 -| |Replace|*bulk replace is not permitted*|(see above)|at permitted replacement levels: to be deleted, otherwise not to be changed|to be updated/inserted|
852 -|Format|XML|xml element/attribute is absent|~|xml element/attribute is absent|any valid or intentionally missing value|
853 -| |JSON|\<empty\>|““|NULL or absent|(see above)|
854 -| |CSV|\<empty\> cell or column is absent|~|<empty> cell or column is absent|(see above)|
870 +(% style="width:1364.29px" %)
871 +| | |(% style="width:260px" %)**Dimension value is**|(% style="width:391px" %) |(% style="width:383px" %)**Measure, attribute or reference metadata value is**|(% style="width:184px" %)
872 +| | |(% style="width:260px" %)**Omitted**|(% style="width:391px" %)**switched off**|(% style="width:383px" %)**Omitted**|(% style="width:184px" %)**Present**
873 +|Action|Delete|(% style="width:260px" %)bulk deletion: dimension value doesn't matter|(% style="width:391px" %)only for irrelevant dimensions:1) higher-level (reference metadata) attributes not attached to this dimension(incl. TIME\_PERIOD)2) measures and attributes not attached to this dimension if the DSD allows for an ‘evolving structure’ (excl. TIME\_PERIOD)|(% style="width:383px" %)to be deleted only if **all** non-dimension components are omitted|(% style="width:184px" %)to be deleted
874 +| |Merge|(% style="width:260px" %)//bulk merge is not permitted//|(% style="width:391px" %)(see above)|(% style="width:383px" %)not to be changed|(% style="width:184px" %)to be updated/inserted
875 +| |Replace|(% style="width:260px" %)//bulk replace is not permitted//|(% style="width:391px" %)(see above)|(% style="width:383px" %)at permitted replacement levels: to be deleted, otherwise not to be changed|(% style="width:184px" %)to be updated/inserted
876 +|Format|XML|(% style="width:260px" %)xml element/attribute is absent|(% style="width:391px" %)~|xml element/attribute is absent|(% style="width:383px" %)any valid or intentionally missing value|(% style="width:184px" %)
877 +| |JSON|(% style="width:260px" %)\<empty\>|(% style="width:391px" %)““|(% style="width:383px" %)NULL or absent|(% style="width:184px" %)(see above)
878 +| |CSV|(% style="width:260px" %)\<empty\> cell or column is absent|(% style="width:391px" %)~|<empty> cell or column is absent|(% style="width:383px" %)(see above)|(% style="width:184px" %)
855 855  
856 856  **Important notes:**
857 857  
858 -The terms “*delete*”, “*merge*” and “*replace*” do **not** imply a physical replacement or deletion of values in the underlying database. To minimize the physical resource requirements, SDMX web service implementations that do not support the *includeHistory* and *asOf* URL parameters might physically replace the existing values in the database. SDMX web services that neither support the *updatedAfter* URL parameter might also implement physical deletions. However, SDMX web services that support these parameters (or other time-machine features), would not overwrite or delete the physical values.
882 +The terms “//delete//”, “//merge//” and “//replace//” do **not** imply a physical replacement or deletion of values in the underlying database. To minimize the physical resource requirements, SDMX web service implementations that do not support the //includeHistory// and //asOf// URL parameters might physically replace the existing values in the database. SDMX web services that neither support the *updatedAfter* URL parameter might also implement physical deletions. However, SDMX web services that support these parameters (or other time-machine features), would not overwrite or delete the physical values.
859 859  
860 -SDMX web services that support the *includeHistory* or *asOf* URL parameters should never allow deleting their **historic** data content because this would interfere with the interests of data consumers, such as data aggregators. Therefore, a specific feature to physically delete previous (outdated) content is intentionally not added to the SDMX standard syntax. If such a feature is required by an organisation, then it needs to be implemented as a custom feature outside the SDMX standard.
884 +SDMX web services that support the //includeHistory// or //asOf// URL parameters should never allow deleting their **historic** data content because this would interfere with the interests of data consumers, such as data aggregators. Therefore, a specific feature to physically delete previous (outdated) content is intentionally not added to the SDMX standard syntax. If such a feature is required by an organisation, then it needs to be implemented as a custom feature outside the SDMX standard.
861 861  
862 -Likewise, all SDMX-compliant systems that do (or are configured to) support the *updatedAfter* URL parameter need to systematically retain the information about deleted data (or data-related reference metadata).
886 +Likewise, all SDMX-compliant systems that do (or are configured to) support the //updatedAfter// URL parameter need to systematically retain the information about deleted data (or data-related reference metadata).
863 863  
864 -All datasets – even with varying actions – within a single data message have always to be treated as **ACID transaction** to guarantee “transactional safety” (full data consistency and validity despite errors, power failures, and other mishaps). These datasets are to be processed in the order of appearance in the message. The advantage of such data messages is thus the ability to bundle separate *delete* and *replace* or *merge* actions into one transactional data message.
888 +All datasets – even with varying actions – within a single data message have always to be treated as **ACID transaction** to guarantee “transactional safety” (full data consistency and validity despite errors, power failures, and other mishaps). These datasets are to be processed in the order of appearance in the message. The advantage of such data messages is thus the ability to bundle separate //delete// and //replace// or //merge// actions into one transactional data message.
865 865  
866 -**Recommended[^2] dataset actions in SDMX web service responses to GET data queries:**
890 +**Recommended{{footnote}}So far this is recommended for systems that do not require backward-compatibility. Later, with SDMX 4.0, this may generally be made mandatory{{/footnote}} dataset actions in SDMX web service responses to GET data queries:**
867 867  
868 -1. Without the *updatedAfter*, *includeHistory*, *detail*, *attributes* or *measures* URL parameters:
869 -
870 - The response message should contain the retrieved data in a *Replace* dataset (instead of the previous *information* dataset).
892 +~1. Without the //updatedAfter//, //includeHistory//, //detail//, //attributes// or //measures// URL parameters:
871 871  
872 -1. Without the *updatedAfter* and *includeHistory*, but with *detail*, *attributes* or *measures* URL parameters:
873 -
874 - The response message should contain the retrieved data in a *Merge* dataset (instead of the previous *Information* dataset).
894 +The response message should contain the retrieved data in a //Replace// dataset (instead of the previous *information* dataset).
875 875  
876 -1. With the *updatedAfter* URL parameter:
877 -
878 - The response must include the information of all previously updated, inserted and deleted data or data-related reference metadata, even if bulk deletions have been used. One of the two approaches are possible:
896 +2. Without the //updatedAfter// and //includeHistory//, but with //detail//, //attributes// or //measures// URL parameters:
879 879  
880 -* a *Delete* dataset for entirely deleted observations and for entirely deleted sets of (data-related reference metadata) attribute values attached to specific dimension combinations and
881 - a *Replace* dataset for all other changed observations and changed attribute and data-related reference metadata values attached to specific dimension combinations, or 
882 -* a *Delete* dataset for entirely deleted observations, for entirely deleted sets of (data-related reference metadata) attribute values attached to specific dimension combinations and for individually deleted mesure, attribute and reference metadata values and
883 - a *Merge* dataset for all other updated or inserted observation, attribute and data-related reference metadata values.
884 -
885 - The DB synchronization use case requires that the generated response must always allow achieving to replicate the exact same punctual data content as currently stored in the queried data source.
898 +The response message should contain the retrieved data in a //Merge// dataset (instead of the previous *Information* dataset).
886 886  
887 -1. With the *includeHistory* URL parameter:
888 -
889 - Using a number of datasets with *Delete*, *Replace* or *Merge* actions and limited in their validity time span that allow achieving to replicate the exact same punctual data contents as previously stored in the queried data source.
900 +3. With the //updatedAfter// URL parameter:
890 890  
891 -1. With the *asOf* URL parameter:
892 -
893 - The recommendations of 1 and 2 apply depending on the other parameters. In addition, the returned dataset should have its validity time span limited to the point in time requested in the *asOf* parameter.
902 +The response must include the information of all previously updated, inserted and deleted data or data-related reference metadata, even if bulk deletions have been used. One of the two approaches are possible:
894 894  
895 -[^2]: So far this is recommended for systems that do not require backward-compatibility. Later, with SDMX 4.0, this may generally be made mandatory.
904 +* a //Delete// dataset for entirely deleted observations and for entirely deleted sets of (data-related reference metadata) attribute values attached to specific dimension combinations and
905 +a //Replace// dataset for all other changed observations and changed attribute and data-related reference metadata values attached to specific dimension combinations, or 
906 +* a //Delete// dataset for entirely deleted observations, for entirely deleted sets of (data-related reference metadata) attribute values attached to specific dimension combinations and for individually deleted mesure, attribute and reference metadata values and
907 +a //Merge// dataset for all other updated or inserted observation, attribute and data-related reference metadata values.
896 896  
909 +The DB synchronization use case requires that the generated response must always allow achieving to replicate the exact same punctual data content as currently stored in the queried data source.
910 +
911 +~1. With the *includeHistory* URL parameter:
912 +
913 +Using a number of datasets with *Delete*, *Replace* or *Merge* actions and limited in their validity time span that allow achieving to replicate the exact same punctual data contents as previously stored in the queried data source.
914 +
915 +2. With the *asOf* URL parameter:
916 +
917 +The recommendations of 1 and 2 apply depending on the other parameters. In addition, the returned dataset should have its validity time span limited to the point in time requested in the *asOf* parameter.
918 +
897 897  == 4.2 Reference Metadata Actions ==
898 898  
899 899  Reference metadata defined by a Metadataflow or a MetadataProvisionAgreement are exchanged within reference metadatasets, which are maintainable and thus for actions behave like structural metadata (artefacts): When interacting with SDMX Rest web services, the HTTP action verbs GET, PUT and POST are used to indicate the intended action per web request. Consequently, different actions cannot be bundled and executed with “transactional ACIDity”. Note that metadatasets retrieved using the HTTP header “Accept-Language” may contain only partial languages, and thus should be marked with its *isPartialLanguage* property set to true. Submitting such a partial metadataset to update an SDMX storage system will only add or update the included languages but not change other languages.
900 900  
901 901  The former message header or metadataset property *DataSetAction* is deprecated. To avoid conflicts, it is now ignored if still present.
924 +
925 +{{putFootnotes/}}