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