Changes for page Part IV. Data and Reference Metadata Namespaces

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

From 3.6 to 3.5 From 3.12 to 3.11

From version 3.11

edited by Helena
on 2025/07/02 16:11

Change comment: There is no comment for this version

To version 3.6

edited by Helena
on 2025/07/02 16:00

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -531,34 +531,37 @@
  |(% style="width:267px" %)decimals^^1^^|(% style="width:729px" %)xs:fractionDigits
  |(% style="width:267px" %)pattern|(% style="width:729px" %)xs:pattern
--Any other [[facets>>doc:sdmx:Glossary.Facet.WebHome]] are informational only and will not affect the determined type.
++Any other facets are informational only and will not affect the determined type.
  === 3.3.7 Representation for Not Applicable Dimensions ===
--Not applicable [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]], i.e., when reported [[measures>>doc:sdmx:Glossary.Measure.WebHome]] or [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] are not attached to those [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]], take as value the tilde ‘’ character. This is required for [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] defined by a [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] that has the ‘evolving structure’ property set to true and that includes data from [[dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]], which only use a subset of [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] as defined by a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] (% style="color:#e74c3c" %)constraint(%%). This is also required for data-related higher-(% style="color:#e74c3c" %)level(%%) (i.e., attached to [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] or partial list of [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]) [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] that don’t have a fixed pre-defined attachment.
++Not applicable dimensions, i.e., when reported measures or attributes are not attached to those dimensions, take as value the tilde ‘’ character. This is required for datasets defined by a DSD that has the ‘evolving structure’ property set to true and that includes data from dataflows, which only use a subset of dimensions as defined by a dimension constraint. This is also required for data-related higher-level (i.e., attached to dataflow or partial list of Dimensions) reference metadata attributes that don’t have a fixed pre-defined attachment.
--To support a specific type and allow for a not applicable [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] value, the structure-specific schema must union the type with the common:NotApplicableType, which enumerates the tilde ‘’ character. This is as shown in the following example:
++To support a specific type and allow for a not applicable dimension value, the structure-specific schema must union the type with the common:NotApplicableType, which enumerates the tilde ‘’ character. This is as shown in the following example:
-->  <xs:simpleType name="DecimalOrNotApplicableType">
-->     <xs:union memberTypes="xs:decimal common:NotApplicableType"/>
-->  </xs:simpleType>
++xml
++   <xs:simpleType name="DecimalOrNotApplicableType">
++      <xs:union memberTypes="xs:decimal common:NotApplicableType"/>
++   </xs:simpleType>
  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.
  Option 1: Augmenting the enumeration with the special value
-->  <xs:simpleType name="CL\_SUBINDICATOR\_OR\_NOT\_APPLICABLE">
-->     <xs:union memberTypes="CL\_SUBINDICATOR common:NotApplicableType"/>
-->  </xs:simpleType>
++xml
++   <xs:simpleType name="CL\_SUBINDICATOR\_OR\_NOT\_APPLICABLE">
++      <xs:union memberTypes="CL\_SUBINDICATOR common:NotApplicableType"/>
++   </xs:simpleType>
  Option 2: Extending the enumeration with the special value
-->  <xs:simpleType name="CL\_ SUBINDICATOR ">
-->     <xs:restriction base="xs:string">
-->        <xs:enumeration value="A"/>
-->        <xs:enumeration value=""/>
-->     <xs:restriction>
-->  </xs:simpleType>
++xml
++   <xs:simpleType name="CL\_ SUBINDICATOR ">
++      <xs:restriction base="xs:string">
++         <xs:enumeration value="A"/>
++         <xs:enumeration value=""/>
++      <xs:restriction>
++   </xs:simpleType>
  For convenience the common schema provides the union types for the following data types.
@@ -595,35 +595,38 @@
  === 3.3.8 Representation for Intentionally Missing Measure and Attribute Values ===
--For intentionally missing [[measure>>doc:sdmx:Glossary.Measure.WebHome]] and [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values, even if mandatory, the following special values can be used:
++For intentionally missing measure and attribute values, even if mandatory, the following special values can be used:
  * NaN for all numeric types (float, double)
  * #N/A for all other types
--To support a specific type and allow for an intentionally missing [[measure>>doc:sdmx:Glossary.Measure.WebHome]] or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] value, the structure-specific schema must union the type with the common:MissingType, which enumerates the #N/A string. Note that XML natively already supports NaN for float and double values.
++To support a specific type and allow for an intentionally missing measure or attribute value, the structure-specific schema must union the type with the common:MissingType, which enumerates the #N/A string. Note that XML natively already supports NaN for float and double values.
  This union is as shown in the following example:
-->   <xs:simpleType name="DecimalOrMissingType">
-->      <xs:union memberTypes="xs:decimal common:MissingType"/>
-->   </xs:simpleType>
++xml
++   <xs:simpleType name="DecimalOrMissingType">
++      <xs:union memberTypes="xs:decimal common:MissingType"/>
++   </xs:simpleType>
  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.
  Option 1: Augmenting the enumeration with the special value
-- >  <xs:simpleType name="CL\_SUBINDICATOR\_OR\_NOT\_APPLICABLE">
-- >     <xs:union memberTypes="CL\_SUBINDICATOR common:MissingType"/>
-- >  </xs:simpleType>
++xml
++   <xs:simpleType name="CL\_SUBINDICATOR\_OR\_NOT\_APPLICABLE">
++      <xs:union memberTypes="CL\_SUBINDICATOR common:MissingType"/>
++   </xs:simpleType>
  Option 2: Extending the enumeration with the special value
-->   <xs:simpleType name="CL\_ SUBINDICATOR ">
-->      <xs:restriction base="xs:string">
-->         <xs:enumeration value="A"/>
-->         <xs:enumeration value="#N/A"/>
-->      <xs:restriction>
-->   </xs:simpleType>
++xml
++   <xs:simpleType name="CL\_ SUBINDICATOR ">
++      <xs:restriction base="xs:string">
++         <xs:enumeration value="A"/>
++         <xs:enumeration value="#N/A"/>
++      <xs:restriction>
++   </xs:simpleType>
  For convenience the common schema provides the union types for the following data types.
@@ -660,40 +660,40 @@
  === 3.3.9 Representation with Complex Text Format ===
--A [[representation>>doc:sdmx:Glossary.Representation.WebHome]] which defines a complex text format will result in a complex type. The [[representation>>doc:sdmx:Glossary.Representation.WebHome]] is complex if any of the following conditions are true:
++A representation which defines a complex text format will result in a complex type. The representation is complex if any of the following conditions are true:
--* [[representation>>doc:sdmx:Glossary.Representation.WebHome]] max occurs is greater than 1
++* representation max occurs is greater than 1
  * text format data type is XHMTL
  * text format is multi-lingual
  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:
--* if the text format data type is XHTML, common:StructuredTextValueType can be used; note that this type cannot be further restricted – all other [[facets>>doc:sdmx:Glossary.Facet.WebHome]] are ignored
--* if the text format is multi-lingual, common:TextValueType can be used; note that this type cannot be further restricted – all other [[facets>>doc:sdmx:Glossary.Facet.WebHome]] are ignored
--* if the text format has no additional [[facets>>doc:sdmx:Glossary.Facet.WebHome]] and the data type is:
--** Boolean, common:BooleanValueType can be used
--** String, common:StringValueType can be used
--** Integer, common:IntValueType can be used
--** Double, common:DoubleValueType can be used
--** ObservationalTimePeriod, common:ObservationalTimePeriodValueType can be used
++* if the text format data type is XHTML, common:StructuredTextValueType can be used; note that this type cannot be further restricted – all other facets are ignored
++* if the text format is multi-lingual, common:TextValueType can be used; note that this type cannot be further restricted – all other facets are ignored
++* if the text format has no additional facets and the data type is:
++  + Boolean, common:BooleanValueType can be used
++  + String, common:StringValueType can be used
++  + Integer, common:IntValueType can be used
++  + Double, common:DoubleValueType can be used
++  + ObservationalTimePeriod, common:ObservationalTimePeriodValueType can be used
--If a pre-defined type cannot be used, one will have to be created. The complex type must define a simple content restriction of the common:ValueType. The restriction should define an anonymous simple type based on the text format data type and [[facets>>doc:sdmx:Glossary.Facet.WebHome]] as described in the previous section.
++If a pre-defined type cannot be used, one will have to be created. The complex type must define a simple content restriction of the common:ValueType. The restriction should define an anonymous simple type based on the text format data type and facets as described in the previous section.
  === 3.3.10 Type Names ===
  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.
--* It the type is an enumeration from an [[item scheme>>doc:sdmx:Glossary.Item scheme.WebHome]], the recommended name is ~[[[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] Class].[Maintenance Agency].~[[[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] ID].~[[[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] Version]
--* If the type is based on a text format of a (% style="color:#e74c3c" %)concept(%%) core [[representation>>doc:sdmx:Glossary.Representation.WebHome]], the recommended name is (% style="color:#e74c3c" %)Concept(%%).[Maintenance Agency].[(% style="color:#e74c3c" %)Concept(%%) Scheme ID].[(% style="color:#e74c3c" %)Concept(%%) Scheme Version].[(% style="color:#e74c3c" %)Concept(%%) ID]
--* If the type is based on a text format of a [[component>>doc:sdmx:Glossary.Component.WebHome]] local [[representation>>doc:sdmx:Glossary.Representation.WebHome]], and;
--** The [[component>>doc:sdmx:Glossary.Component.WebHome]] id is required to be unique for all [[components>>doc:sdmx:Glossary.Component.WebHome]] within the scope of the structure which defines it (e.g. a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]), the recommended name is ~[[[Component>>doc:sdmx:Glossary.Component.WebHome]] ID]
--** The [[component>>doc:sdmx:Glossary.Component.WebHome]] id is only required to be unique within the [[component>>doc:sdmx:Glossary.Component.WebHome]] list and which defines it (e.g. a metadata attribute), the recommend name is [Component List ID].[Parent Component ID]\*.[Component ID]
++* It the type is an enumeration from an item scheme, the recommended name is [Item Scheme Class].[Maintenance Agency].[Item Scheme ID].[Item Scheme Version]
++* If the type is based on a text format of a concept core representation, the recommended name is Concept.[Maintenance Agency].[Concept Scheme ID].[Concept Scheme Version].[Concept ID]
++* If the type is based on a text format of a component local representation, and;
++  + The component id is required to be unique for all components within the scope of the structure which defines it (e.g. a dimension), the recommended name is [Component ID]
++  + The component id is only required to be unique within the component list and which defines it (e.g. a metadata attribute), the recommend name is [Component List ID].[Parent Component ID]\*.[Component ID]
  === 3.3.11 Type Reuse ===
  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.
--For example, an organisation my create predefined types for all of [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] and [[concept schemes>>doc:sdmx:Glossary.Concept scheme.WebHome]] which their structures utilize. These could be contained in a common schema with any namespace deemed appropriate. This would allow the structure-specific schemas generation process to recognize the reused [[components>>doc:sdmx:Glossary.Component.WebHome]] and not be concerned with regenerating types. The logical flow for setting the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of a [[component>>doc:sdmx:Glossary.Component.WebHome]] might be as follows:
++For example, an organisation my create predefined types for all of codelists and concept schemes which their structures utilize. These could be contained in a common schema with any namespace deemed appropriate. This would allow the structure-specific schemas generation process to recognize the reused components and not be concerned with regenerating types. The logical flow for setting the representation of a component might be as follows:
        Does the component define a local type?
              Yes: Is that type enumerated?
@@ -705,24 +705,24 @@
  == 3.4 Data-Structure-Specific Schema ==
--Separate schemas will be created for the data structure depending on which [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] occurs at the observation (% style="color:#e74c3c" %)level(%%). The recommended target namespace of the data structured specific schema is: [Data Structure URN]:ObsLevelDim:[Observation Dimensions].
++Separate schemas will be created for the data structure depending on which dimension occurs at the observation level. The recommended target namespace of the data structured specific schema is: [Data Structure URN]:ObsLevelDim:[Observation Dimensions].
--The rules for generating the data-structure-specific-schema are broken into sections based on the (% style="color:#e74c3c" %)level(%%) within the structure (i.e. [[data set>>doc:sdmx:Glossary.Data set.WebHome]], group, series, [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]], observation). Each section will state the rules for each variation of the structure-specific format.
++The rules for generating the data-structure-specific-schema are broken into sections based on the level within the structure (i.e. data set, group, series, attributes, observation). Each section will state the rules for each variation of the structure-specific format.
  === 3.4.1 DataSetType ===
--A complex type named DataSetType must be created. Its content model will be derived via restriction. The base type of the restriction is [[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]:DataSetType. The complex type content model will be as follows:
++A complex type named DataSetType must be created. Its content model will be derived via restriction. The base type of the restriction is dsd:DataSetType. The complex type content model will be as follows:
  ~1. A sequence consisting of:
--* i. An element reference to common:[[Annotations>>doc:sdmx:Glossary.Annotation.WebHome]], with a minimum occurrence of 0
++* i. An element reference to common:Annotations, with a minimum occurrence of 0
  * ii   A local element named DataProvider with the type common:DataProviderReferenceType, a form of unqualified and a minimum occurrence of 0
  * iii  A choice with a minimum occurrence of 0 and a maximum occurrence of unbounded consisting of:
  ** a.  A local element named Atts with a form of unqualified and a type of AttsType (as defined in the AttsType section which follows)
  ** 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.
--** c. If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) is not AllDimensions, a local element named Series with a form of unqualified and a type of SeriesType (as defined in the SeriesType section which follows)
--** d. If the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation (% style="color:#e74c3c" %)level(%%) is AllDimensions, a local element named Obs with a form of unqualified and a type of ObsType (as defined in the ObsType section which follows)
--* iv. If any metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] usages defined in the data structure that declares an [[attribute relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] of [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurences of 0
++** c. If the dimension at the observation level is not AllDimensions, a local element named Series with a form of unqualified and a type of SeriesType (as defined in the SeriesType section which follows)
++** d. If the dimension at the observation level is AllDimensions, a local element named Obs with a form of unqualified and a type of ObsType (as defined in the ObsType section which follows)
++* iv. If any metadata attribute usages defined in the data structure that declares an attribute relationship of dataflow, a local element named Metadata with the type metadata:MetadataSetType a form of unqualified, and a minimum occurences of 0
  === 3.4.2 GroupType ===