Changes for page Part IV. Data and Reference Metadata Namespaces
Last modified by Elena on 2025/09/10 11:19
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -99,7 +99,7 @@ 99 99 |Comp|//CompType//|(% style="width:717px" %)Comp contains the details of group level attributes that have complex representation and cannot be expressed as XML attributes. 100 100 |Metadata|MetadataSetType|(% style="width:717px" %)Allows for attachment of reference metadata against to the group. 101 101 102 -** *SeriesType*:** SeriesType is the abstract type which defines a structure which is used to group a collection of observations which have a key in common. The key for a series is every dimension defined in the data structure definition save the dimension declared to be at the observation level for this data set. Note, if the schema is generated against a dataflow with a dimension constraint, they key includes only the dimensions defined in the dimension constraint. In addition to observations, values can be provided for data and metadata attributes which are associated with the dimensions which make up this series key (so long as the attributes do not specify a group attachment or also have a relationship with the observation dimension). It is possible for the series to contain only observations or only attribute values, or both. Data structure definition schemas will derive a type based on this that is specific to the data structure definition and the variation of the format being expressed in the schema. Both the dimension values which make up the key and the attribute values associated with the key dimensions will be represented with XML attributes. This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived series type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). The dimension XML attributes will be required while the attribute XML attributes will be optional. To allow for generic processing, it is required that the only unqualified XML attributes in the derived group type be for the series dimensions and attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition dimension or attribute.102 +//**SeriesType:**// SeriesType is the abstract type which defines a structure which is used to group a collection of observations which have a key in common. The key for a series is every dimension defined in the data structure definition save the dimension declared to be at the observation level for this data set. Note, if the schema is generated against a dataflow with a dimension constraint, they key includes only the dimensions defined in the dimension constraint. In addition to observations, values can be provided for data and metadata attributes which are associated with the dimensions which make up this series key (so long as the attributes do not specify a group attachment or also have a relationship with the observation dimension). It is possible for the series to contain only observations or only attribute values, or both. Data structure definition schemas will derive a type based on this that is specific to the data structure definition and the variation of the format being expressed in the schema. Both the dimension values which make up the key and the attribute values associated with the key dimensions will be represented with XML attributes. This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived series type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). The dimension XML attributes will be required while the attribute XML attributes will be optional. To allow for generic processing, it is required that the only unqualified XML attributes in the derived group type be for the series dimensions and attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition dimension or attribute. 103 103 104 104 Derivation: 105 105 ... ... @@ -114,18 +114,20 @@ 114 114 115 115 Attribute Documentation: 116 116 117 -|**Name**|**Type**|**Documentation**| 118 -|TIME_PERIOD|ObservationalTimePeriodType|The TIME_PERIOD attribute is an explict attribute for the time dimension. This is declared in the base schema since it has a fixed identifier and representation. The derived series type will either require or prohibit this attribute, depending on whether time is the observation dimension. If the time dimension specifies a more specific representation of time the derived type will restrict the type definition to the appropriate type.| 117 +(% style="width:1084.29px" %) 118 +|**Name**|**Type**|**Documentation** 119 +|TIME_PERIOD|ObservationalTimePeriodType|The TIME_PERIOD attribute is an explict attribute for the time dimension. This is declared in the base schema since it has a fixed identifier and representation. The derived series type will either require or prohibit this attribute, depending on whether time is the observation dimension. If the time dimension specifies a more specific representation of time the derived type will restrict the type definition to the appropriate type. 119 119 120 120 Element Documentation: 121 121 122 -|**Name**|**Type**|**Documentation**| 123 -|Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| 124 -|Comp|*CompType*|Comp contains the details of series level attributes that have complex representation and cannot be expressed as XML attributes.| 125 -|Obs|*ObsType*| | 126 -|Metadata|MetadataSetType|Allows for attachment of reference metadata against to the series.| 123 +(% style="width:1093.29px" %) 124 +|**Name**|**Type**|**Documentation** 125 +|Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. 126 +|Comp|//CompType//|Comp contains the details of series level attributes that have complex representation and cannot be expressed as XML attributes. 127 +|Obs|//ObsType//| 128 +|Metadata|MetadataSetType|Allows for attachment of reference metadata against to the series. 127 127 128 -** *CompType*:** CompType is the abstract base for any component value (e.g. a data or metadata attribute, or a measure) that cannot be represented as an XML attribute. For example, a repeated value, a text value in multiple languages, or a value with structured text (XHTML) cannot be expressed as an XML attribute. This type is meant to be restricted based on the component to restrict the cardinality and type of its Value element to conform to the component definition. The type of the value element should be restricted to common:SimpleValueType, common:TextValueType, or common:StructuredValueType. In addition, the id attribute should be restricted to be a fixed value with the component identifier. This restricted type based on the component can then be used on Comp elements by using the xsi:type to state the component being expressed and refine the contents of the element to the values allowed by the component.130 +//**CompType:**// CompType is the abstract base for any component value (e.g. a data or metadata attribute, or a measure) that cannot be represented as an XML attribute. For example, a repeated value, a text value in multiple languages, or a value with structured text (XHTML) cannot be expressed as an XML attribute. This type is meant to be restricted based on the component to restrict the cardinality and type of its Value element to conform to the component definition. The type of the value element should be restricted to common:SimpleValueType, common:TextValueType, or common:StructuredValueType. In addition, the id attribute should be restricted to be a fixed value with the component identifier. This restricted type based on the component can then be used on Comp elements by using the xsi:type to state the component being expressed and refine the contents of the element to the values allowed by the component. 129 129 130 130 Derivation: 131 131 ... ... @@ -140,16 +140,18 @@ 140 140 141 141 Attribute Documentation: 142 142 143 -|**Name**|**Type**|**Documentation**| 144 -|id|NCNameIDType| | 145 +(% style="width:1007.29px" %) 146 +|(% style="width:157px" %)**Name**|(% style="width:291px" %)**Type**|(% style="width:556px" %)**Documentation** 147 +|(% style="width:157px" %)id|(% style="width:291px" %)NCNameIDType|(% style="width:556px" %) 145 145 146 146 Element Documentation: 147 147 148 -|**Name**|**Type**|**Documentation**| 149 -|Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| 150 -|Value|*ValueType*| | 151 +(% style="width:1015.29px" %) 152 +|**Name**|**Type**|(% style="width:684px" %)**Documentation** 153 +|Annotations|AnnotationsType|(% style="width:684px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. 154 +|Value|//ValueType//|(% style="width:684px" %) 151 151 152 -** *ObsType*:** ObsType is the abstract type which defines the structure of a grouped or un-grouped observation. The observation must be provided a key, which is either a value for the dimension which is declared to be at the observation level if the observation is grouped, or a full set of values for all dimensions in the data structure definition if the observation is un-grouped. This key should disambiguate the observation within the context in which it is defined (e.g. there should not be another observation with the same dimension value in a series). The observation can contain an observed value and/or attribute values. Data structure definition schemas will derive a type or types based on this that is specific to the data structure definition and the variation of the format being expressed in the schema. The dimension value(s) which make up the key and the data and metadata attribute values associated with the key dimension(s) or the primary measure will be represented with XML attributes. This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived observation type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). The dimension XML attribute(s) will be required while the attribute XML attributes will be optional. To allow for generic processing, it is required that the only unqualified XML attributes in the derived observation type be for the observation dimension(s) and attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition dimension or attribute.156 +//**ObsType:**// ObsType is the abstract type which defines the structure of a grouped or un-grouped observation. The observation must be provided a key, which is either a value for the dimension which is declared to be at the observation level if the observation is grouped, or a full set of values for all dimensions in the data structure definition if the observation is un-grouped. This key should disambiguate the observation within the context in which it is defined (e.g. there should not be another observation with the same dimension value in a series). The observation can contain an observed value and/or attribute values. Data structure definition schemas will derive a type or types based on this that is specific to the data structure definition and the variation of the format being expressed in the schema. The dimension value(s) which make up the key and the data and metadata attribute values associated with the key dimension(s) or the primary measure will be represented with XML attributes. This is specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived observation type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). The dimension XML attribute(s) will be required while the attribute XML attributes will be optional. To allow for generic processing, it is required that the only unqualified XML attributes in the derived observation type be for the observation dimension(s) and attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition dimension or attribute. 153 153 154 154 Derivation: 155 155 ... ... @@ -164,16 +164,18 @@ 164 164 165 165 Attribute Documentation: 166 166 167 -|**Name**|**Type**|**Documentation**| 168 -|type|IDType|The type attribute is used when the derived format requires that explicit measure be used. In this case, the derived type based on the measure will fix this value to be the identification of the measure concept. This will not be required, but since it is fixed it will be available in the post validation information set which will allow for generic processing of the data. If explicit measures are not used, then the derived type will prohibit the use of this attribute.| 169 -|TIME_PERIOD|ObservationalTimePeriodType|The TIME_PERIOD attribute is an explicit attribute for the time dimension. This is declared in the base schema since it has a fixed identifier and representation. The derived series type will either require or prohibit this attribute, depending on whether time is the observation dimension. If the time dimension specifies a more specific representation of time the derived type will restrict the type definition to the appropriate type.| 171 +(% style="width:1008.29px" %) 172 +|**Name**|**Type**|(% style="width:648px" %)**Documentation** 173 +|type|IDType|(% style="width:648px" %)The type attribute is used when the derived format requires that explicit measure be used. In this case, the derived type based on the measure will fix this value to be the identification of the measure concept. This will not be required, but since it is fixed it will be available in the post validation information set which will allow for generic processing of the data. If explicit measures are not used, then the derived type will prohibit the use of this attribute. 174 +|TIME_PERIOD|ObservationalTimePeriodType|(% style="width:648px" %)The TIME_PERIOD attribute is an explicit attribute for the time dimension. This is declared in the base schema since it has a fixed identifier and representation. The derived series type will either require or prohibit this attribute, depending on whether time is the observation dimension. If the time dimension specifies a more specific representation of time the derived type will restrict the type definition to the appropriate type. 170 170 171 171 Element Documentation: 172 172 173 -|**Name**|**Type**|**Documentation**| 174 -|Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| 175 -|Comp|*CompType*|Comp contains the details of observation measures or attributes that have complex representation and cannot be expressed as XML attributes.| 176 -|Metadata|MetadataSetType|Allows for attachment of reference metadata against to the observation.| 178 +(% style="width:1020.29px" %) 179 +|**Name**|**Type**|**Documentation** 180 +|Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. 181 +|Comp|//CompType//|Comp contains the details of observation measures or attributes that have complex representation and cannot be expressed as XML attributes. 182 +|Metadata|MetadataSetType|Allows for attachment of reference metadata against to the observation. 177 177 178 178 ***AttsType*:** AttsType is the abstract type which defines a structure which is used to group a collection of data or metadata attributes which have a key in common. The key for a attribute collection is a subset of the dimension defined in the data structure definition. This is also used for data set level attributes (i.e. those with an attribute relationship of none). In this case, the subset of dimensions is empty. Data structure definition schemas will derive a type based on this that is specific to the data structure definition. The dimension values which make up the key will be represented with local (non-namespace qualified) XML attributes. The metadata attribute values associated with the key dimensions will be expressed as XML local (non-namespace qualified) attributes if they are simple values (e.g. enumerated, dates, numbers) and are not repeatable. Metadata attributes that are repeatable, or do not have simple values (e.g. text) will be expressed using the Comp element. These dimensions and simple attributes are specified in the content model with the declaration of anyAttributes in the "local" namespace. The derived series type will refine this structure so that the attributes are explicit. The XML attributes will be given a name based on the attribute's identifier. These XML attributes will be unqualified (meaning they do not have a namespace associated with them). The dimension XML attributes will be required while the attribute XML attributes will be optional. To allow for generic processing, it is required that the only unqualified XML attributes in the derived group type be for the series dimensions and attributes declared in the data structure definition. If additional attributes are required, these should be qualified with a namespace so that a generic application can easily distinguish them as not being meant to represent a data structure definition dimension or attribute. 179 179 ... ... @@ -190,29 +190,31 @@ 190 190 191 191 Attribute Documentation: 192 192 193 -|**Name**|**Type**|**Documentation**| 194 -|TIME_PERIOD|ObservationalTimePeriodType|The TIME_PERIOD attribute is an explict attribute for the time dimension. This is declared in the base schema since it has a fixed identifier and representation. The derived series type will either require or prohibit this attribute, depending on whether time is the observation dimension. If the time dimension specifies a more specific representation of time the derived type will restrict the type definition to the appropriate type.| 199 +(% style="width:1013.29px" %) 200 +|**Name**|**Type**|**Documentation** 201 +|TIME_PERIOD|ObservationalTimePeriodType|The TIME_PERIOD attribute is an explict attribute for the time dimension. This is declared in the base schema since it has a fixed identifier and representation. The derived series type will either require or prohibit this attribute, depending on whether time is the observation dimension. If the time dimension specifies a more specific representation of time the derived type will restrict the type definition to the appropriate type. 195 195 196 196 Element Documentation: 197 197 198 -|**Name**|**Type**|**Documentation**| 199 -|Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| 200 -|Comp|*CompType*|Comp contains the details of the data or metadata attributes that have complex representation and cannot be expressed as XML attributes.| 205 +(% style="width:1020.29px" %) 206 +|**Name**|**Type**|**Documentation** 207 +|Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. 208 +|Comp|//CompType//|Comp contains the details of the data or metadata attributes that have complex representation and cannot be expressed as XML attributes. 201 201 202 202 == 2.2 Generic Reference Metadata Namespace == 203 203 204 - **http://www.sdmx.org/resources/sdmxml/schemas/v3_1/metadata/generic****212 +[[http:~~/~~/www.sdmx.org/resources/sdmxml/schemas/v3_1/metadata/generic>>http://www.sdmx.org/resources/sdmxml/schemas/v3_1/metadata/generic**]] 205 205 206 206 === 2.2.1 Summary === 207 207 208 208 Referenced Namespaces: 209 209 210 -|**Namespace**|**Prefix**| 211 -|http://www.sdmx.org/resources/sdmxml/schemas/v3\_1/common|common| 212 -|<http://www.w3.org/2001/XMLSchema>|xs| 218 +(% style="width:1037.29px" %) 219 +|(% style="width:516px" %)**Namespace**|(% style="width:518px" %)**Prefix** 220 +|(% style="width:516px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v3\_1/common|(% style="width:518px" %)common 221 +|(% style="width:516px" %)<http:~/~/www.w3.org/2001/XMLSchema>|(% style="width:518px" %)xs 213 213 214 214 Contents: 215 - 216 216 1 Global Element 217 217 3 Complex Types 218 218 ... ... @@ -242,26 +242,28 @@ 242 242 243 243 Attribute Documentation: 244 244 245 -|**Name**|**Type**|**Documentation**| 246 -|id|IDType|The id is the identifier for the object.| 247 -|urn|MetadataSetUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| 248 -|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| 249 -|version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.| 250 -|validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.| 251 -|validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.| 252 -|agencyID|NestedNCNameIDType|The agencyID must be provided and identifies the maintenance agency of the object.| 253 -|isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| 254 -|serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.| 255 -|structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.| 256 -|isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header Accept-Language.| 253 +(% style="width:1051.29px" %) 254 +|**Name**|**Type**|(% style="width:669px" %)**Documentation** 255 +|id|IDType|(% style="width:669px" %)The id is the identifier for the object. 256 +|urn|MetadataSetUrnType|(% style="width:669px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). 257 +|uri|xs:anyURI|(% style="width:669px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. 258 +|version|VersionType|(% style="width:669px" %)This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. 259 +|validFrom|xs:dateTime|(% style="width:669px" %)The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. 260 +|validTo|xs:dateTime|(% style="width:669px" %)The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. 261 +|agencyID|NestedNCNameIDType|(% style="width:669px" %)The agencyID must be provided and identifies the maintenance agency of the object. 262 +|isExternalReference (default: false)|xs:boolean|(% style="width:669px" %)The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. 263 +|serviceURL|xs:anyURI|(% style="width:669px" %)The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. 264 +|structureURL|xs:anyURI|(% style="width:669px" %)The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. 265 +|isPartialLanguage (default: false)|xs:boolean|(% style="width:669px" %)The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header Accept-Language. 257 257 258 258 Element Documentation: 259 259 260 -|**Name**|**Type**|**Documentation**| 261 -|Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| 262 -|Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the metadata report can be dynamically inserted in the structure metadata.| 263 -|Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| 264 -|Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| 269 +(% style="width:1057.29px" %) 270 +|**Name**|**Type**|**Documentation** 271 +|Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. 272 +|Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the metadata report can be dynamically inserted in the structure metadata. 273 +|Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. 274 +|Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. 265 265 266 266 **MetadataSetType:** MetadataSetType describes the structure for a metadata set, which contains a collection of reported metadata against a set of targets. The targets should conform to the restrictions described by the metadata provision or the metadataflow. Note that this is maintainable, and as such must specify in agency. In this case, the agency is the metadata provider. If a metadata provision agreement is referenced, it is assumed that the metadata provider described in the provision will be the same as the agency for this set. 267 267 ... ... @@ -284,34 +284,36 @@ 284 284 285 285 Attribute Documentation: 286 286 287 -|**Name**|**Type**|**Documentation**| 288 -|id|IDType|The id is the identifier for the object.| 289 -|urn|MetadataSetUrnType|The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details).| 290 -|uri|xs:anyURI|The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message.| 291 -|version|VersionType|This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned.| 292 -|validFrom|xs:dateTime|The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version.| 293 -|validTo|xs:dateTime|The validTo attribute provides the inclusive end date for providing supplemental validity information about the version.| 294 -|agencyID|NestedNCNameIDType|The agencyID must be provided and identifies the maintenance agency of the object.| 295 -|isExternalReference (default: false)|xs:boolean|The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object.| 296 -|serviceURL|xs:anyURI|The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface.| 297 -|structureURL|xs:anyURI|The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object.| 298 -|isPartialLanguage (default: false)|xs:boolean|The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header Accept-Language.| 299 -|reportingBeginDate|BasicTimePeriodType|The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set.| 300 -|reportingEndDate|BasicTimePeriodType|The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set.| 301 -|publicationYear|xs:gYear|The publicationYear holds the ISO 8601 four-digit year.| 302 -|publicationPeriod|ObservationalTimePeriodType|The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a data set published on a quarterly basis).| 297 +(% style="width:1050.29px" %) 298 +|**Name**|**Type**|(% style="width:622px" %)**Documentation** 299 +|id|IDType|(% style="width:622px" %)The id is the identifier for the object. 300 +|urn|MetadataSetUrnType|(% style="width:622px" %)The urn attribute holds a valid SDMX Registry URN (see SDMX Registry Specification for details). 301 +|uri|xs:anyURI|(% style="width:622px" %)The uri attribute holds a URI that contains a link to a resource with additional information about the object, such as a web page. This uri is not a SDMX message. 302 +|version|VersionType|(% style="width:622px" %)This version attribute holds a version number (see common:VersionType definition for details). If not supplied, artefact is considered to be un-versioned. 303 +|validFrom|xs:dateTime|(% style="width:622px" %)The validFrom attribute provides the inclusive start date for providing supplemental validity information about the version. 304 +|validTo|xs:dateTime|(% style="width:622px" %)The validTo attribute provides the inclusive end date for providing supplemental validity information about the version. 305 +|agencyID|NestedNCNameIDType|(% style="width:622px" %)The agencyID must be provided and identifies the maintenance agency of the object. 306 +|isExternalReference (default: false)|xs:boolean|(% style="width:622px" %)The isExternalReference attribute, if true, indicates that the actual object is not defined the corresponding element, rather its full details are defined elsewhere - indicated by either the registryURL, the repositoryURL, or the structureURL. The purpose of this is so that each structure message does not have to redefine object that are already defined elsewhere. If the isExternalReference attribute is not set, then it is assumed to be false, and the object should contain the full definition of its contents. If more than one of the registryURL, the repositoryURL, and the structureURL are supplied, then the application processing the object can choose the method it finds best suited to retrieve the details of the object. 307 +|serviceURL|xs:anyURI|(% style="width:622px" %)The serviceURL attribute indicates the URL of an SDMX SOAP web service from which the details of the object can be retrieved. Note that this can be a registry or and SDMX structural metadata repository, as they both implement that same web service interface. 308 +|structureURL|xs:anyURI|(% style="width:622px" %)The structureURL attribute indicates the URL of a SDMX-ML structure message (in the same version as the source document) in which the externally referenced object is contained. Note that this may be a URL of an SDMX RESTful web service which will return the referenced object. 309 +|isPartialLanguage (default: false)|xs:boolean|(% style="width:622px" %)The isPartialLanguage attribute, if true, indicates that the object doesn't contain the complete set of all available languages, e.g., when obtained as a response to a GET query that requested specific languages through the HTTP header Accept-Language. 310 +|reportingBeginDate|BasicTimePeriodType|(% style="width:622px" %)The reportingBeginDate indicates the inclusive start time of the data reported in the data or metadata set. 311 +|reportingEndDate|BasicTimePeriodType|(% style="width:622px" %)The reportingEndDate indicates the inclusive end time of the data reported in the data or metadata set. 312 +|publicationYear|xs:gYear|(% style="width:622px" %)The publicationYear holds the ISO 8601 four-digit year. 313 +|publicationPeriod|ObservationalTimePeriodType|(% style="width:622px" %)The publicationPeriod specifies the period of publication of the data or metadata in terms of whatever provisioning agreements might be in force (i.e., "Q1 2005" if that is the time of publication for a data set published on a quarterly basis). 303 303 304 304 Element Documentation: 305 305 306 -|**Name**|**Type**|**Documentation**| 307 -|Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| 308 -|Link|LinkType|Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the metadata report can be dynamically inserted in the structure metadata.| 309 -|Name|TextType|Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms.| 310 -|Description|TextType|Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms.| 311 -|MetadataProvision<br/>Agreement|MetadataProvisionAgree<br/>mentReferenceType|Metadataflow provides a reference to the metadata provision agreement the metadata set is being reported against.| 312 -|Metadataflow|MetadataflowReference<br/>Type|Metadataflow provides a reference to the metadataflow the metadata set is being reported against.| 313 -|Target|WildcardUrnType|Target references the target structures for which metadata is being reported. These must conform with the constraints defined by the metadata provision agreement and/or the metadataflow.| 314 -|Attribute|AttributeType|Att elements hold the reported metadata attribute values being reported in the metadata set. These conform to the metadata structure definition.| 317 +(% style="width:1054.29px" %) 318 +|**Name**|(% style="width:185px" %)**Type**|(% style="width:412px" %)**Documentation** 319 +|Annotations|(% style="width:185px" %)AnnotationsType|(% style="width:412px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. 320 +|Link|(% style="width:185px" %)LinkType|(% style="width:412px" %)Allows for the linking of other resources to identifiable objects. For example, if there is reference metadata associated with a structure, a link to the metadata report can be dynamically inserted in the structure metadata. 321 +|Name|(% style="width:185px" %)TextType|(% style="width:412px" %)Name provides for a human-readable name for the object. This may be provided in multiple, parallel language-equivalent forms. 322 +|Description|(% style="width:185px" %)TextType|(% style="width:412px" %)Description provides for a longer human-readable description of the object. This may be provided in multiple, parallel language-equivalent forms. 323 +|MetadataProvision<br/>Agreement|(% style="width:185px" %)MetadataProvisionAgree<br/>mentReferenceType|(% style="width:412px" %)Metadataflow provides a reference to the metadata provision agreement the metadata set is being reported against. 324 +|Metadataflow|(% style="width:185px" %)MetadataflowReference<br/>Type|(% style="width:412px" %)Metadataflow provides a reference to the metadataflow the metadata set is being reported against. 325 +|Target|(% style="width:185px" %)WildcardUrnType|(% style="width:412px" %)Target references the target structures for which metadata is being reported. These must conform with the constraints defined by the metadata provision agreement and/or the metadataflow. 326 +|Attribute|(% style="width:185px" %)AttributeType|(% style="width:412px" %)Att elements hold the reported metadata attribute values being reported in the metadata set. These conform to the metadata structure definition. 315 315 316 316 **AttributeType:** AttributeType defines the structure for a reported metadata attribute. A value for the attribute can be supplied as either a single value (enumerated or non-enumerated single value), or multi-lingual text values (either structured or unstructured). Optional child attributes are also available if the metadata attribute definition defines nested metadata attributes. 317 317 ... ... @@ -328,17 +328,19 @@ 328 328 329 329 Attribute Documentation: 330 330 331 -|**Name**|**Type**|**Documentation**| 332 -|id|IDType|The id attribute identifies the metadata attribute that the value is being reported for.| 343 +(% style="width:1037.29px" %) 344 +|(% style="width:113px" %)**Name**|(% style="width:162px" %)**Type**|(% style="width:760px" %)**Documentation** 345 +|(% style="width:113px" %)id|(% style="width:162px" %)IDType|(% style="width:760px" %)The id attribute identifies the metadata attribute that the value is being reported for. 333 333 334 334 Element Documentation: 335 335 336 -|**Name**|**Type**|**Documentation**| 337 -|Annotations|AnnotationsType|Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it.| 338 -|Value|xs:anySimpleType|Value holds any simple value (enumerated or not) for the metadata attribute. It can be repeated if this metadata attribute allows for multiple values.| 339 -|Text|TextType|Text is used to supply parallel multi-lingual textual values for the reported metadata attribute. This will be used if the text format of the metadata attribute has a type of string, and the multi-lingual value is set to true.| 340 -|StructuredText|XHTMLType|StructuredText is used to supply parallel multi-lingual structured (as XHTML) textual values for the reported metadata attribute. This will be used if the text format of the metadata attribute has a type of XHTML, and the multi-lingual value is set to true.| 341 -|Attribute|AttributeType|Att contains the reported metadata attribute values for the child metadata attributes.| 349 +(% style="width:1095.29px" %) 350 +|**Name**|**Type**|(% style="width:821px" %)**Documentation** 351 +|Annotations|AnnotationsType|(% style="width:821px" %)Annotations is a reusable element the provides for a collection of annotations. It has been made global so that restrictions of types that extend AnnotatableType may reference it. 352 +|Value|xs:anySimpleType|(% style="width:821px" %)Value holds any simple value (enumerated or not) for the metadata attribute. It can be repeated if this metadata attribute allows for multiple values. 353 +|Text|TextType|(% style="width:821px" %)Text is used to supply parallel multi-lingual textual values for the reported metadata attribute. This will be used if the text format of the metadata attribute has a type of string, and the multi-lingual value is set to true. 354 +|StructuredText|XHTMLType|(% style="width:821px" %)StructuredText is used to supply parallel multi-lingual structured (as XHTML) textual values for the reported metadata attribute. This will be used if the text format of the metadata attribute has a type of XHTML, and the multi-lingual value is set to true. 355 +|Attribute|AttributeType|(% style="width:821px" %)Att contains the reported metadata attribute values for the child metadata attributes. 342 342 343 343 = 3 Mapping to Structure-Specific Schemas = 344 344 ... ... @@ -353,10 +353,10 @@ 353 353 In the subsequent sections, the following namespace prefixes are used: 354 354 355 355 |**Namespace**|**Prefix**| 356 -|http://www.w3.org/2001/XMLSchema|xs| 357 -|http://www.sdmx.org/resources/sdmxml/schemas/v3_1/common|common| 358 -|http://www.sdmx.org/resources/sdmxml/schemas/v3_1/data/structurespecific|dsd| 359 -|<http://www.sdmx.org/resources/sdmxml/schemas/v3_1/metadata/generic>|metadata| 370 +|http:~/~/www.w3.org/2001/XMLSchema|xs| 371 +|http:~/~/www.sdmx.org/resources/sdmxml/schemas/v3_1/common|common| 372 +|http:~/~/www.sdmx.org/resources/sdmxml/schemas/v3_1/data/structurespecific|dsd| 373 +|<http:~/~/www.sdmx.org/resources/sdmxml/schemas/v3_1/metadata/generic>|metadata| 360 360 361 361 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: 362 362 ... ... @@ -420,8 +420,8 @@ 420 420 The representation of a component is determined by the following precedence: 421 421 422 422 1. The local representation defined by the component 423 - 2. The core representation defined in the concept from which the component takes its semantic424 - 3. A default representation of an un-faceted text format with a data type of String.437 +1. The core representation defined in the concept from which the component takes its semantic 438 +1. A default representation of an un-faceted text format with a data type of String. 425 425 426 426 The representation will either define a text format, an enumeration with an enumeration format, or a union of the former with the value of a irrelevant representation ‘’ (tilde). 427 427 ... ... @@ -446,7 +446,6 @@ 446 446 </xs:annotation> 447 447 </xs:enumeration> 448 448 449 - 450 450 === 3.3.5 Representation with Value List Enumeration === 451 451 452 452 A representation which defines an enumeration from a value list will result in a simple type that is a restriction of the xs:string data type. The simple type will define enumerations for each value item in the value list. The value for these enumerations will be identifier of the item. If desired, the names of the item may be placed in the documentation of the enumeration, but this is not required.