Changes for page Part IV. Data and Reference Metadata Namespaces
Last modified by Elena on 2025/09/10 11:19
Summary
-
Page properties (1 modified, 0 added, 0 removed)
-
Objects (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -38,7 +38,7 @@ 38 38 Derivation: 39 39 40 40 AnnotableType (extension) 41 - DataSetType 41 + DataSetType 42 42 43 43 [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: 44 44 structureRef, setID?, action?, reportingBeginDate?, reportingEndDate?, validFromDate?, validToDate?, publicationYear?, publicationPeriod? ... ... @@ -66,10 +66,10 @@ 66 66 |**Name**|**Type**|**Documentation** 67 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 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).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 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 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]]. ... ... @@ -181,7 +181,7 @@ 181 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 182 |Metadata|MetadataSetType|Allows for attachment of [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] against to the observation. 183 183 184 -** *AttsType*:** AttsType is the abstract type which defines a structure which is used to group a collection of data or metadata [[attributes>>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]].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]]. 185 185 186 186 Derivation: 187 187 ... ... @@ -226,11 +226,11 @@ 226 226 227 227 === 2.2.2 Global Elements === 228 228 229 -**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. 230 230 231 231 === 2.2.3 Complex Types === 232 232 233 -** *MetadataSetBaseType*:** MetadataSetBaseType defines the base refinement of the MetadataSetType. Its purpose is to restrict the urn attribute.233 +//**MetadataSetBaseType:**// MetadataSetBaseType defines the base refinement of the MetadataSetType. Its purpose is to restrict the urn [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. 234 234 235 235 Derivation: 236 236 ... ... @@ -242,38 +242,38 @@ 242 242 MaintainableType (restriction) 243 243 MetadataSetBaseType 244 244 245 -Attributes: 246 -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? 247 247 248 248 Content: 249 -Annotations?, Link*, Name+, Description 249 +[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, Link*, Name+, Description 250 250 251 -Attribute Documentation: 251 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: 252 252 253 253 (% style="width:1051.29px" %) 254 254 |**Name**|**Type**|(% style="width:669px" %)**Documentation** 255 255 |id|IDType|(% style="width:669px" %)The id is the identifier for the object. 256 -|urn|MetadataSetUrnType|(% style="width:669px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). 257 -|uri|xs:anyURI|(% style="width:669px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. 258 -|version|VersionType|(% style="width:669px" %)This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. 259 -|validFrom|xs:dateTime|(% style="width:669px" %)The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. 260 -|validTo|xs:dateTime|(% style="width:669px" %)The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. 261 -|agencyID|NestedNCNameIDType|(% style="width:669px" %)The agencyID must be provided and identifies the maintenance agency of the object. 262 -|isExternalReference (default: false)|xs:boolean|(% style="width:669px" %)The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. 263 -|serviceURL|xs:anyURI|(% style="width:669px" %)The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. 264 -|structureURL|xs:anyURI|(% style="width:669px" %)The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. 265 -|isPartialLanguage (default: false)|xs:boolean|(% style="width:669px" %)The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header Accept-Language. 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. 266 266 267 267 Element Documentation: 268 268 269 269 (% style="width:1057.29px" %) 270 270 |**Name**|**Type**|**Documentation** 271 -|Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. 272 -|Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the metadata report can be dynamically inserted in the structure metadata. 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 273 |Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. 274 274 |Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. 275 275 276 -**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. 277 277 278 278 Derivation: 279 279 ... ... @@ -286,46 +286,49 @@ 286 286 MetadataSetBaseType (extension) 287 287 MetadataSetType 288 288 289 -Attributes: 290 -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? 291 291 292 292 Content: 293 -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]]+)? 294 294 295 -Attribute Documentation: 295 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: 296 296 297 297 (% style="width:1050.29px" %) 298 298 |**Name**|**Type**|(% style="width:622px" %)**Documentation** 299 299 |id|IDType|(% style="width:622px" %)The id is the identifier for the object. 300 -|urn|MetadataSetUrnType|(% style="width:622px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). 301 -|uri|xs:anyURI|(% style="width:622px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. 302 -|version|VersionType|(% style="width:622px" %)This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. 303 -|validFrom|xs:dateTime|(% style="width:622px" %)The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. 304 -|validTo|xs:dateTime|(% style="width:622px" %)The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. 305 -|agencyID|NestedNCNameIDType|(% style="width:622px" %)The agencyID must be provided and identifies the maintenance agency of the object. 306 -|isExternalReference (default: false)|xs:boolean|(% style="width:622px" %)The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. 307 -|serviceURL|xs:anyURI|(% style="width:622px" %)The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. 308 -|structureURL|xs:anyURI|(% style="width:622px" %)The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. 309 -|isPartialLanguage (default: false)|xs:boolean|(% style="width:622px" %)The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header Accept-Language. 310 -|reportingBeginDate|BasicTimePeriodType|(% style="width:622px" %)The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set. 311 -|reportingEndDate|BasicTimePeriodType|(% style="width:622px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set. 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 312 |publicationYear|xs:gYear|(% style="width:622px" %)The publicationYear holds the ISO 8601 four-digit year. 313 -|publicationPeriod|ObservationalTimePeriodType|(% style="width:622px" %)The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a data set published on a quarterly basis). 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). 314 314 315 315 Element Documentation: 316 316 317 317 (% style="width:1054.29px" %) 318 318 |**Name**|(% style="width:185px" %)**Type**|(% style="width:412px" %)**Documentation** 319 -|Annotations|(% style="width:185px" %)AnnotationsType|(% style="width:412px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. 320 -|Link|(% style="width:185px" %)LinkType|(% style="width:412px" %)Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the metadata report can be dynamically inserted in the structure metadata. 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 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 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<br/>Agreement|(% style="width:185px" %)MetadataProvisionAgree<br/>mentReferenceType|(% style="width:412px" %)Metadataflow provides a reference to the metadata provision agreement the metadata set is being reported against. 324 -|Metadataflow|(% style="width:185px" %)MetadataflowReference<br/>Type|(% style="width:412px" %)Metadataflow provides a reference to the metadataflow the metadata set is being reported against. 325 -|Target|(% style="width:185px" %)WildcardUrnType|(% style="width:412px" %)Target references the target structures for which metadata is being reported. These must conform with the constraints defined by the metadata provision agreement and/or the metadataflow. 326 -|Attribute|(% style="width:185px" %)AttributeType|(% style="width:412px" %)Att elements hold the reported metadata attribute values being reported in the metadata set. These conform to the metadata structure definition. 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. 327 327 328 -**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]]. 329 329 330 330 Derivation: 331 331 ... ... @@ -332,27 +332,27 @@ 332 332 AnnotableType (extension) 333 333 AttributeType 334 334 335 -Attributes: 338 +[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: 336 336 id 337 337 338 338 Content: 339 -Annotations?, (Value+|Text+|StructuredText+)?, Attribute 342 +[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]]?, (Value+|Text+|StructuredText+)?, [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 340 340 341 -Attribute Documentation: 344 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: 342 342 343 343 (% style="width:1037.29px" %) 344 344 |(% style="width:113px" %)**Name**|(% style="width:162px" %)**Type**|(% style="width:760px" %)**Documentation** 345 -|(% style="width:113px" %)id|(% style="width:162px" %)IDType|(% style="width:760px" %)The id attribute identifies the metadata attribute that the value is being reported for. 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. 346 346 347 347 Element Documentation: 348 348 349 349 (% style="width:1095.29px" %) 350 350 |**Name**|**Type**|(% style="width:821px" %)**Documentation** 351 -|Annotations|AnnotationsType|(% style="width:821px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. 352 -|Value|xs:anySimpleType|(% style="width:821px" %)Value holds any simple value (enumerated or not) for the metadata attribute. It can be repeated if this metadata attribute allows for multiple values. 353 -|Text|TextType|(% style="width:821px" %)Text is used to supply parallel multi-lingual textual values for the reported metadata attribute. This will be used if the text format of the metadata attribute has a type of string, and the multi-lingual value is set to true. 354 -|StructuredText|XHTMLType|(% style="width:821px" %)StructuredText is used to supply parallel multi-lingual structured (as XHTML) textual values for the reported metadata attribute. This will be used if the text format of the metadata attribute has a type of XHTML, and the multi-lingual value is set to true. 355 -|Attribute|AttributeType|(% style="width:821px" %)Att contains the reported metadata attribute values for the child metadata attributes. 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]]. 356 356 357 357 = 3 Mapping to Structure-Specific Schemas = 358 358 ... ... @@ -376,45 +376,45 @@ 376 376 377 377 **Schema:** Refers to the format specific schema in general, and in particular the root xs:schema element of that schema file. 378 378 379 -**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]]). 380 380 381 -**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]]). 382 382 383 383 **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. 384 384 385 -**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]]). 386 386 387 -**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). 388 388 389 -**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. 390 390 391 391 **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. 392 392 393 393 **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. 394 394 395 -**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]]) 396 396 397 -**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]]). 398 398 399 -**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]]). 400 400 401 -**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]]). 402 402 403 -**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]]). 404 404 405 -**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. 406 406 407 -**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). 408 408 409 -**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]]). 410 410 411 411 == 3.2 Namespace Rules == 412 412 413 -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. 414 414 415 415 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. 416 416 417 -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". 418 418 419 419 == 3.3 General Rules == 420 420 ... ... @@ -422,57 +422,56 @@ 422 422 423 423 === 3.3.1 Component Name Determination === 424 424 425 -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: 426 426 427 -1. If the component defines an identifier, the element or attribute name is the value of that identifier 428 -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). 429 429 430 430 === 3.3.2 Representation Determination === 431 431 432 -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]]). 433 433 434 -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: 435 435 436 -1. The local representation defined by the component 437 -1. The core representation defined in the concept from which the component takes its semantic 438 -1. 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. 439 439 440 -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). 441 441 442 -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. 443 443 444 444 === 3.3.3 Simple / Primitive Type Determination === 445 445 446 -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). 447 447 448 -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. 449 449 450 450 === 3.3.4 Representation with Codelist Enumeration === 451 451 452 -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: 453 453 454 -xml 455 - <xs:simpleType name="ESTAT.CL\_COUNTRY.1.0"> 456 - <xs:restriction base="common:IDType"> 457 - <xs:enumeration value="BE"> 458 - <xs:annotation> 459 - <xs:documentation xml:lang="en">Belgium</xs:documentation> 460 - </xs:annotation> 461 - </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> 462 462 463 463 === 3.3.5 Representation with Value List Enumeration === 464 464 465 -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. 466 466 467 467 === 3.3.6 Representation with Simple Text Format === 468 468 469 -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: 470 470 471 -* representation max occurs is greater than 1 473 +* [[representation>>doc:sdmx:Glossary.Representation.WebHome]] max occurs is greater than 1 472 472 * text format data type is XHMTL 473 473 * text format is multi-lingual 474 474 475 -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: 476 476 477 477 (% style="width:679.294px" %) 478 478 |(% style="width:286px" %)**SDMX Data Type**|(% style="width:390px" %)**XML Schema Data Type** ... ... @@ -518,7 +518,7 @@ 518 518 |(% style="width:286px" %)GeospatialInformation|(% style="width:390px" %)xs:string 519 519 |(% style="width:286px" %)XHTML|(% style="width:390px" %)See the following section for complex representations 520 520 521 -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): 522 522 523 523 (% style="width:1007.29px" %) 524 524 |(% style="width:267px" %)**SDMX Facet**|(% style="width:729px" %)**XML Schema Facet** ... ... @@ -529,37 +529,34 @@ 529 529 |(% style="width:267px" %)decimals^^1^^|(% style="width:729px" %)xs:fractionDigits 530 530 |(% style="width:267px" %)pattern|(% style="width:729px" %)xs:pattern 531 531 532 -Any other facets are informational only and will not affect the determined type. 534 +Any other [[facets>>doc:sdmx:Glossary.Facet.WebHome]] are informational only and will not affect the determined type. 533 533 534 534 === 3.3.7 Representation for Not Applicable Dimensions === 535 535 536 -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. 537 537 538 -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: 539 539 540 -xml 541 - <xs:simpleType name="DecimalOrNotApplicableType"> 542 - <xs:union memberTypes="xs:decimal common:NotApplicableType"/> 543 - </xs:simpleType> 542 +> <xs:simpleType name="DecimalOrNotApplicableType"> 543 +> <xs:union memberTypes="xs:decimal common:NotApplicableType"/> 544 +> </xs:simpleType> 544 544 545 545 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. 546 546 547 547 Option 1: Augmenting the enumeration with the special value 548 548 549 -xml 550 - <xs:simpleType name="CL\_SUBINDICATOR\_OR\_NOT\_APPLICABLE"> 551 - <xs:union memberTypes="CL\_SUBINDICATOR common:NotApplicableType"/> 552 - </xs:simpleType> 550 +> <xs:simpleType name="CL\_SUBINDICATOR\_OR\_NOT\_APPLICABLE"> 551 +> <xs:union memberTypes="CL\_SUBINDICATOR common:NotApplicableType"/> 552 +> </xs:simpleType> 553 553 554 554 Option 2: Extending the enumeration with the special value 555 555 556 -xml 557 - <xs:simpleType name="CL\_ SUBINDICATOR "> 558 - <xs:restriction base="xs:string"> 559 - <xs:enumeration value="A"/> 560 - <xs:enumeration value=""/> 561 - <xs:restriction> 562 - </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> 563 563 564 564 For convenience the common schema provides the union types for the following data types. 565 565 ... ... @@ -596,38 +596,35 @@ 596 596 597 597 === 3.3.8 Representation for Intentionally Missing Measure and Attribute Values === 598 598 599 -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: 600 600 601 601 * NaN for all numeric types (float, double) 602 602 * #N/A for all other types 603 603 604 -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. 605 605 606 606 This union is as shown in the following example: 607 607 608 -xml 609 - <xs:simpleType name="DecimalOrMissingType"> 610 - <xs:union memberTypes="xs:decimal common:MissingType"/> 611 - </xs:simpleType> 607 +> <xs:simpleType name="DecimalOrMissingType"> 608 +> <xs:union memberTypes="xs:decimal common:MissingType"/> 609 +> </xs:simpleType> 612 612 613 613 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. 614 614 615 615 Option 1: Augmenting the enumeration with the special value 616 616 617 -xml 618 - <xs:simpleType name="CL\_SUBINDICATOR\_OR\_NOT\_APPLICABLE"> 619 - <xs:union memberTypes="CL\_SUBINDICATOR common:MissingType"/> 620 - </xs:simpleType> 615 + > <xs:simpleType name="CL\_SUBINDICATOR\_OR\_NOT\_APPLICABLE"> 616 + > <xs:union memberTypes="CL\_SUBINDICATOR common:MissingType"/> 617 + > </xs:simpleType> 621 621 622 622 Option 2: Extending the enumeration with the special value 623 623 624 -xml 625 - <xs:simpleType name="CL\_ SUBINDICATOR "> 626 - <xs:restriction base="xs:string"> 627 - <xs:enumeration value="A"/> 628 - <xs:enumeration value="#N/A"/> 629 - <xs:restriction> 630 - </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> 631 631 632 632 For convenience the common schema provides the union types for the following data types. 633 633 ... ... @@ -664,40 +664,40 @@ 664 664 665 665 === 3.3.9 Representation with Complex Text Format === 666 666 667 -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: 668 668 669 -* representation max occurs is greater than 1 665 +* [[representation>>doc:sdmx:Glossary.Representation.WebHome]] max occurs is greater than 1 670 670 * text format data type is XHMTL 671 671 * text format is multi-lingual 672 672 673 673 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: 674 674 675 -* 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 676 -* 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 677 -* if the text format has no additional facets and the data type is: 678 - +Boolean, common:BooleanValueType can be used679 - +String, common:StringValueType can be used680 - +Integer, common:IntValueType can be used681 - +Double, common:DoubleValueType can be used682 - +ObservationalTimePeriod, common:ObservationalTimePeriodValueType can be used671 +* 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 683 683 684 -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. 685 685 686 686 === 3.3.10 Type Names === 687 687 688 688 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. 689 689 690 -* 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] 691 -* 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] 692 -* If the type is based on a text format of a component local representation, and; 693 - +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]694 - +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] 695 695 696 696 === 3.3.11 Type Reuse === 697 697 698 698 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. 699 699 700 -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: 701 701 702 702 Does the component define a local type? 703 703 Yes: Is that type enumerated? ... ... @@ -709,167 +709,172 @@ 709 709 710 710 == 3.4 Data-Structure-Specific Schema == 711 711 712 -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]. 713 713 714 -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. 715 715 716 716 === 3.4.1 DataSetType === 717 717 718 -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: 719 719 720 720 ~1. A sequence consisting of: 721 721 722 -* i. An element reference to common:Annotations, with a minimum occurrence of 0 723 -* ii A local element named DataProvider with the type common:DataProviderReferenceType, a form of unqualified and a minimum occurrence of 0724 -* iii A choice with a minimum occurrence of 0 and a maximum occurrence of unbounded consisting of:725 -** a. A local element named Atts with a form of unqualified and a type of AttsType (as defined in the AttsType section which follows)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) 726 726 ** 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. 727 -** c. If the dimension at the observation level is not AllDimensions, a local element named Series with a form of unqualified and a type of SeriesType (as defined in the SeriesType section which follows) 728 -** d. If the dimension at the observation level is AllDimensions, a local element named Obs with a form of unqualified and a type of ObsType (as defined in the ObsType section which follows) 729 -* iv. If any metadata attribute usages defined in the data structure that declares an attribute relationship of dataflow, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurences of 0 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 730 730 731 731 === 3.4.2 GroupType === 732 732 733 -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: 729 +If the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] 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>>doc:sdmx:Glossary.Data structure definition.WebHome]]:GroupType. The complex type content model will be as follows: 734 734 735 735 ~1. A sequence consisting of: 736 736 737 -* i. An element reference to common:Annotations, with a minimum occurrence of 0 738 -* 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 739 -* 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 733 +* i. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0 734 +* ii. If any [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] defined in the data structure that declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] 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>>doc:sdmx:Glossary.Data structure definition.WebHome]]:CompType 735 +* iii. 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]] with the group, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0 740 740 741 -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 742 -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 743 -4. An attribute named type with a type of common:IDType, usage of optional, and a fixed value of the identifier of the group 737 +2. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] referenced by the group. The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is required 738 +3. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each data [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] with simple [[representation>>doc:sdmx:Glossary.Representation.WebHome]] defined in the data structure that declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] with the group or specifies the group as an attachment group. The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is optional 739 +4. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named type with a type of common:IDType, usage of optional, and a fixed value of the identifier of the group 744 744 745 -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: 741 +If the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] 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>>doc:sdmx:Glossary.Data structure definition.WebHome]]:GroupType. The complex type content model will be as follows: 746 746 747 747 ~1. A sequence consisting of: 748 748 749 -* i. An element reference to common:Annotations, with a minimum occurrence of 0 750 -* 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 751 -* 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 745 +* i. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0 746 +* ii. If any [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] defined in the data structure that declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] 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>>doc:sdmx:Glossary.Data structure definition.WebHome]]:CompType 747 +* iii. 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]] with any group, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0 752 752 753 -2. An attribute named type with a type of Group.ID, and a usage of optional 749 +2. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named type with a type of Group.ID, and a usage of optional 754 754 3. An anyAttribute declaration with a namespace of ##local## 755 755 756 -A simple type named Group.ID must be created. This should restrict the common:IDType. For each group defined by the data structure definition, an enumeration will be created within the restriction with a value of the group identifier. 752 +A simple type named Group.ID must be created. This should restrict the common:IDType. For each group defined by the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], an enumeration will be created within the restriction with a value of the group identifier. 757 757 758 -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: 754 +For each group defined in the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], 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: 759 759 760 760 ~1. A sequence consisting of: 761 761 762 -* i. An element reference to common:Annotations, with a minimum occurrence of 0 763 -* 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 764 -* 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 758 +* i. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0 759 +* ii. If any [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] with complex [[representation>>doc:sdmx:Glossary.Representation.WebHome]] defined in the data structure declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] 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>>doc:sdmx:Glossary.Data structure definition.WebHome]]:CompType 760 +* iii. 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]] with the group, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0 765 765 766 -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 767 -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 768 -4. An attribute named type with a type of Group.ID, usage of optional, and a fixed value of the identifier of the group 762 +2. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] referenced by the group. The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is required 763 +3. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each data [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] with simple [[representation>>doc:sdmx:Glossary.Representation.WebHome]] defined in the data structure that declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] with the group or specifies the group as an attachment group. The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is optional 764 +4. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named type with a type of Group.ID, usage of optional, and a fixed value of the identifier of the group 769 769 770 770 === 3.4.3 SeriesType === 771 771 772 -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: 768 +If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation is not AllDimensions, a complex type name SeriesType must be created. Its content model will be derived via restriction of [[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]:SeriesType. The complex type content model will be as follows: 773 773 774 774 ~1. A sequence consisting of: 775 775 776 -* i. An element reference to common:Annotations, with a minimum occurrence of 0 777 -* 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 772 +* i. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0 773 +* ii. If any [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] with complex [[representation>>doc:sdmx:Glossary.Representation.WebHome]] defined in the data structure declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] with a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] that is not at the observation (% style="color:#e74c3c" %)level(%%), a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of [[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]:CompType 778 778 * 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) 779 -* 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 775 +* 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]] with the series, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0 780 780 781 -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 782 -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 783 -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 777 +2. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named TIME\_PERIOD with a type of common:ObservationalTimePeriod. If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) is the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (TIME\_PERIOD) or there is no time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] defined by the data structure, a usage of prohibited; otherwise, a usage of required 778 +3. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] defined by the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], except for the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) and the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (TIME\_PERIOD). 784 784 780 +The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is required 781 +4. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each data [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] defined with simple [[representation>>doc:sdmx:Glossary.Representation.WebHome]] in the data structure that declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] with any [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] outside of the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) (so long as it does not also declare an attachment group). The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is optional 782 + 785 785 === 3.4.4 AttsType === 786 786 787 -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: 785 +A complex type named AttsType must be created. Its content model will be derived via restriction of [[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]:AttsType. The complex type content model will be as follows: 788 788 789 789 ~1. A sequence consisting of: 790 790 791 -* i. An element reference to common:Annotations, with a minimum occurrence of 0 792 -* 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 +* i. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0 790 +* ii. If any [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] with complex [[representation>>doc:sdmx:Glossary.Representation.WebHome]] are defined in the data structure, a Comp element with a form of unqualified, a minimum occurrence of 0, a maximum occurrence of unbounded, and a type of dsd:CompType 793 793 794 -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 795 -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 796 -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 792 +2. If there is no [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (TIME\_PERIOD) defined by the data structure, an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named TIME\_PERIOD with a type of common:ObservationalTimePeriod, and a usage of prohibited 793 +3. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for all [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] defined by the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is optional 794 +4. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each data [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] defined with simple [[representation>>doc:sdmx:Glossary.Representation.WebHome]] in the data structure. The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is optional 797 797 798 798 === 3.4.5 ObsType === 799 799 800 -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: 798 +A complex type name ObsType must be created. Its content model will be derived via restriction of the base type [[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]:ObsType. The complex type content model will be as follows: 801 801 802 802 ~1. A sequence consisting of: 803 803 804 -* i. An element reference to common:Annotations, with a minimum occurrence of 0 805 -* 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 806 -* 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 802 +* i. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0 803 +* ii. If any [[measures>>doc:sdmx:Glossary.Measure.WebHome]] with complex [[representations>>doc:sdmx:Glossary.Representation.WebHome]] are defined in the data structure, any [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] with complex [[representation>>doc:sdmx:Glossary.Representation.WebHome]] that declare an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] 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>>doc:sdmx:Glossary.Data structure definition.WebHome]]:CompType 804 +* iii. 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]] with the observation, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurrence of 0 807 807 808 -2. An attribute named TIME\_PERIOD with a type of common: 809 - 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 810 -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 811 -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 812 -5. An attribute for each measure with simple representation defined by the data structure definition. The XML attribute name and type is defined according to the general rules defined in the previous section, and the usage is optional 813 -6. An attribute for each data attribute with simple representation defined in the data structure that declares an attribute relationship with the observation. The XML attribute name and type are defined according to the general rules defined in the previous section, and the usage is optional 806 +2. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named TIME\_PERIOD with a type of common: ObservationalTimePeriodValueType. If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) is the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (TIME\_PERIOD) or all [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] and the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] is defined by the data structure, a usage of required; otherwise, a usage of prohibited 807 +3. If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) is not all [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] or the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (TIME\_PERIOD), an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%). The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is required 808 +4. If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) is all [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]], an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] defined by the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], except for the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (TIME\_PERIOD). 814 814 810 +The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is required 811 +5. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each [[measure>>doc:sdmx:Glossary.Measure.WebHome]] with simple [[representation>>doc:sdmx:Glossary.Representation.WebHome]] defined by the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type is defined according to the general rules defined in the previous section, and the usage is optional 812 +6. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for each data [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] with simple [[representation>>doc:sdmx:Glossary.Representation.WebHome]] defined in the data structure that declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] with the observation. The XML [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] name and type are defined according to the general rules defined in the previous section, and the usage is optional 813 + 815 815 === 3.4.6 CompType === 816 816 817 -For every measure and data attribute with complex representation defined by the data structure definition, a complex type must be derived from the restriction of the dsd:CompType. The complex type content model will be as follows: 816 +For every [[measure>>doc:sdmx:Glossary.Measure.WebHome]] and data [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] with complex [[representation>>doc:sdmx:Glossary.Representation.WebHome]] defined by the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], a complex type must be derived from the restriction of the [[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]:CompType. The complex type content model will be as follows: 818 818 819 -1. A sequence consisting of: 820 -1. An element reference to common:Annotations, with a minimum occurrence of 0 821 - 2. A Value element with a form of unqualified, with a minimum occurrence of 0, a maximum occurrence defined by the representation, and a type based on the [complex representation type](#339-Representation-with-Complex-Text-Format) defined according to the general rules defined in the previous section 822 -2. An attribute named id with a type of common: NCNameIDType, usage of required, and a fixed value of the identifier of the measure or attribute 818 +~1. A sequence consisting of: 823 823 820 +* i. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0 821 +* ii. A Value element with a form of unqualified, with a minimum occurrence of 0, a maximum occurrence defined by the [[representation>>doc:sdmx:Glossary.Representation.WebHome]], and a type based on the complex [[representation>>doc:sdmx:Glossary.Representation.WebHome]] type defined according to the general rules defined in the previous section 822 + 823 +2. An [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] named id with a type of common: NCNameIDType, usage of required, and a fixed value of the identifier of the [[measure>>doc:sdmx:Glossary.Measure.WebHome]] or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 824 + 824 824 = 4 Data and Reference Metadata Actions = 825 825 826 826 == 4.1 Data Actions == 827 827 828 -Data messages allow indicating intended actions when used to update an SDMX storage system. This purpose is noted in the action of the data set, which is either inherited from the header of the data message or explicitly stated at the data set level. 829 +Data messages allow indicating intended actions when used to update an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] storage system. This purpose is noted in the action of the [[data set>>doc:sdmx:Glossary.Data set.WebHome]], which is either inherited from the header of the data message or explicitly stated at the [[data set>>doc:sdmx:Glossary.Data set.WebHome]] (% style="color:#e74c3c" %)level(%%). 829 829 830 -Note that the former *Append*and*Information*actions are deprecated. When used to update an SDMX storage system, the*Merge*action is assumed.831 +Note that the former //Append// and //Information// actions are deprecated. When used to update an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] storage system, the //Merge// action is assumed. 831 831 832 832 === 4.1.1 Merge Action === 833 833 834 -Data or data-related reference metadata is to be merged, through either update or insertion depending on already existing information. This operation does not allow deleting any component values. Updating individual values in multi-valued measure, attribute or data-related reference metadata values is not supported either. The complete multi-valued value is to be provided. 835 +Data or data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] is to be merged, through either update or insertion depending on already existing information. This operation does not allow deleting any [[component>>doc:sdmx:Glossary.Component.WebHome]] values. Updating individual values in multi-valued [[measure>>doc:sdmx:Glossary.Measure.WebHome]], [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] or data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] values is not supported either. The complete multi-valued value is to be provided. 835 835 836 -Only non-dimensional components (measure, attribute or data-related reference metadata values) can be **omitted** (null or absent) as long as at least one of those components is present. Bulk merges are thus not supported. Only the provided values are merged. 837 +Only non-dimensional [[components>>doc:sdmx:Glossary.Component.WebHome]] ([[measure>>doc:sdmx:Glossary.Measure.WebHome]], [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] or data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] values) can be **omitted** (null or absent) as long as at least one of those [[components>>doc:sdmx:Glossary.Component.WebHome]] is present. Bulk merges are thus not supported. Only the provided values are merged. 837 837 838 -Dimension values for higher-level (data-related reference metadata) attributes can be **switched-off** (using ) when those are not attached to these dimensions. 839 +[[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values for higher-(% style="color:#e74c3c" %)level(%%) (data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]]) [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] can be **switched-off** (using ) when those are not attached to these dimensions. 839 839 840 -All observations as well as the sets of data-related reference metadata attributes at specific dimension combinations impacted by the *Merge*action change their time stamp when used to update an SDMX storage system.841 +All observations as well as the sets of data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] at specific [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] combinations impacted by the //Merge// action change their time stamp when used to update an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] storage system. 841 841 842 842 === 4.1.2 Replace Action === 843 843 844 -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). 845 +Data or data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] 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 (% style="color:#e74c3c" %)levels//(%%)”: for entire observations and for any specific [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] combination for data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. Within these “replacement (% style="color:#e74c3c" %)levels(%%)” the provided values are inserted or updated, and omitted values are deleted. Values provided for the other [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] (those above the observation (% style="color:#e74c3c" %)level(%%)) are merged (see //Merge// action). 845 845 846 -Only non-dimensional components (measure, attribute or reference metadata values) can be **omitted** (null or absent). Bulk replacing is thus not supported. 847 +Only non-dimensional [[components>>doc:sdmx:Glossary.Component.WebHome]] ([[measure>>doc:sdmx:Glossary.Measure.WebHome]], [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] values) can be **omitted** (null or absent). Bulk replacing is thus not supported. 847 847 848 -Dimension values for higher-level (data-related reference metadata) attributes can be **switched-off** (using ) when those are not attached to these dimensions. 849 +[[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values for higher-(% style="color:#e74c3c" %)level(%%) (data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]]) [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] can be **switched-off** (using ) when those are not attached to these dimensions. 849 849 850 850 Replacing non-existing elements is not resulting in an error. 851 851 852 -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. 853 +All observations as well as the sets of data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] at specific [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] combinations impacted by the //Replace// action change their time stamp when used to update an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] storage system. 853 853 854 -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. 855 +Because the //replace// action always takes place at specific (% style="color:#e74c3c" %)levels(%%), it cannot be used to replace a whole [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] or a whole series. However, a //“replace all”// effect can be achieved by combining a //Delete// [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] containing a completely wildcarded key (where all [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values are omitted) with a //Merge// or //Replace// [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] within the same data message. Similarly, to replace a whole series, a message can combine a //delete// [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] containing only the partial key of the series (where the not used [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values are omitted) with a //Merge// or //Replace// [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] for that series. 855 855 856 856 === 4.1.3 Delete Action === 857 857 858 -Data or data-related reference metadata is to be deleted. Deletion is hereby assumed to take place at the lowest level of detail provided in the message. 859 +Data or data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] is to be deleted. Deletion is hereby assumed to take place at the lowest (% style="color:#e74c3c" %)level(%%) of detail provided in the message. 859 859 860 -Any component (including dimensions) can be **omitted** (dimensions: empty, others: null or absent). Omitting dimension values allows for bulk deletions. Partially omitting non-dimension component values allows restricting the deletion of measure, attribute or data-related reference metadata values to the ones being present. Instead of real values for non-dimensional components, it is sufficient to use any valid value. 861 +Any [[component>>doc:sdmx:Glossary.Component.WebHome]] (including [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]) can be **omitted** ([[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]: empty, others: null or absent). Omitting [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values allows for bulk deletions. Partially omitting non-[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] [[component>>doc:sdmx:Glossary.Component.WebHome]] values allows restricting the deletion of [[measure>>doc:sdmx:Glossary.Measure.WebHome]], [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] or data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] values to the ones being present. Instead of real values for non-dimensional [[components>>doc:sdmx:Glossary.Component.WebHome]], it is sufficient to use any valid value. 861 861 862 -With this, whole datasets, any slices of observations for dimension groups such as time series, observations or individual measure, attribute and data-related reference metadata attributes values can be deleted. 863 +With this, whole [[datasets>>doc:sdmx:Glossary.Data set.WebHome]], any slices of observations for [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] groups such as time series, observations or individual [[measure>>doc:sdmx:Glossary.Measure.WebHome]], [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] and data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] values can be deleted. 863 863 864 -Dimension values for higher-level (data-related reference metadata) attributes can be **switched-off** (using ) when those are not attached to these dimensions. 865 +[[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values for higher-(% style="color:#e74c3c" %)level(%%) (data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]]) [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] can be **switched-off** (using ) when those are not attached to these [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]. 865 865 866 866 Deleting non-existing elements or values is not resulting in an error. 867 867 868 -All observations as well as the sets of attributes and data-related reference metadata at higher partial keys impacted by the *Delete*action change their time stamp when used to update an SDMX storage system.869 +All observations as well as the sets of [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] and data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] at higher partial keys impacted by the //Delete// action change their time stamp when used to update an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] storage system. 869 869 870 870 === 4.1.4 Further Details === 871 871 872 -The following convention is used to indicate the state of components in data messages: 873 +The following convention is used to indicate the state of [[components>>doc:sdmx:Glossary.Component.WebHome]] in data messages: 873 873 874 874 (% style="width:1364.29px" %) 875 875 | | |(% style="width:260px" %)**Dimension value is**|(% style="width:391px" %) |(% style="width:383px" %)**Measure, attribute or reference metadata value is**|(% style="width:184px" %) ... ... @@ -883,47 +883,47 @@ 883 883 884 884 **Important notes:** 885 885 886 -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.887 +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>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] web service implementations that do not support the //includeHistory// and //asOf// URL parameters might physically replace the existing values in the database. [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] web services that neither support the //updatedAfter// URL parameter might also implement physical deletions. However, [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] web services that support these parameters (or other time-machine features), would not overwrite or delete the physical values. 887 887 888 -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. 889 +[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 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>>doc:sdmx:Glossary.Data consumer.WebHome]], such as data aggregators. Therefore, a specific feature to physically delete previous (outdated) content is intentionally not added to the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] standard syntax. If such a feature is required by an organisation, then it needs to be implemented as a custom feature outside the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] standard. 889 889 890 -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). 891 +Likewise, all [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-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). 891 891 892 -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. 893 +All [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] – 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>>doc:sdmx:Glossary.Data set.WebHome]] 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. 893 893 894 -**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:** 895 +**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>>doc:sdmx:Glossary.Data set.WebHome]] actions in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] web service responses to GET data queries:** 895 895 896 -~1. Without the //updatedAfter//, //includeHistory//, //detail//, //attributes// or //measures// URL parameters: 897 +~1. Without the //updatedAfter//, //includeHistory//, //detail//, //[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]// or //[[measures>>doc:sdmx:Glossary.Measure.WebHome]]// URL parameters: 897 897 898 -The response message should contain the retrieved data in a //Replace// dataset (instead of the previous *information*dataset).899 +The response message should contain the retrieved data in a //Replace// [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] (instead of the previous //information// [[dataset>>doc:sdmx:Glossary.Data set.WebHome]]). 899 899 900 -2. Without the //updatedAfter// and //includeHistory//, but with //detail//, //attributes// or //measures// URL parameters: 901 +2. Without the //updatedAfter// and //includeHistory//, but with //detail//, //[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]// or //[[measures>>doc:sdmx:Glossary.Measure.WebHome]]// URL parameters: 901 901 902 -The response message should contain the retrieved data in a //Merge// dataset (instead of the previous *Information*dataset).903 +The response message should contain the retrieved data in a //Merge// [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] (instead of the previous //Information// [[dataset>>doc:sdmx:Glossary.Data set.WebHome]]). 903 903 904 904 3. With the //updatedAfter// URL parameter: 905 905 906 -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: 907 +The response must include the information of all previously updated, inserted and deleted data or data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]], even if bulk deletions have been used. One of the two approaches are possible: 907 907 908 -* 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 909 -a //Replace// dataset for all other changed observations and changed attribute and data-related reference metadata values attached to specific dimension combinations, or 910 -* 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 911 -a //Merge// dataset for all other updated or inserted observation, attribute and data-related reference metadata values. 909 +* a //Delete// [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] for entirely deleted observations and for entirely deleted sets of (data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]]) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values attached to specific [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] combinations and 910 +a //Replace// [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] for all other changed observations and changed [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] and data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] values attached to specific [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] combinations, or 911 +* a //Delete// [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] for entirely deleted observations, for entirely deleted sets of (data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]]) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values attached to specific [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] combinations and for individually deleted mesure, [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] and [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] values and 912 +a //Merge// [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] for all other updated or inserted observation, [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] and data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] values. 912 912 913 913 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. 914 914 915 -~1. With the *includeHistory*URL parameter:916 +~1. With the //includeHistory// URL parameter: 916 916 917 -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.918 +Using a number of [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] 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. 918 918 919 -2. With the *asOf*URL parameter:920 +2. With the //asOf// URL parameter: 920 920 921 -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.922 +The recommendations of 1 and 2 apply depending on the other parameters. In addition, the returned [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] should have its validity time span limited to the point in time requested in the //asOf// parameter. 922 922 923 923 == 4.2 Reference Metadata Actions == 924 924 925 -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.926 +[[Reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] defined by a [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] or a MetadataProvisionAgreement are exchanged within reference metadatasets, which are maintainable and thus for actions behave like [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] ([[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]): When interacting with [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 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>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] storage system will only add or update the included languages but not change other languages. 926 926 927 -The former message header or metadataset property *DataSetAction*is deprecated. To avoid conflicts, it is now ignored if still present.928 +The former message header or metadataset property //DataSetAction// is deprecated. To avoid conflicts, it is now ignored if still present. 928 928 929 929 {{putFootnotes/}}
- SUZ.Methodology.Code.MethodologyClass[0]
-
- index
-
... ... @@ -1,1 +1,1 @@ 1 - 41 +5