Skip to Content
Last modified by Artur on 2025/09/10 11:19
From version 9.3
edited by Helena
on 2025/05/16 23:02
Change comment: There is no comment for this version
To version 9.2
edited by Helena
on 2025/05/16 23:01
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -99,42 +99,42 @@
99 99  
100 100  ==== 5.3.2.1 Narrative ====
101 101  
102 -A DataStructureDefinition defines the [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]], TimeDimension, DataAttributes, and [[Measures>>doc:xwiki:Glossary.Measure.WebHome]], and associated [[Representations>>doc:xwiki:Glossary.Representation.WebHome]], that comprise the valid structure of data and related [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]] that are contained in a [[DataSet>>doc:xwiki:Glossary.Data set.WebHome]], which is defined by a [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]]. In addition, a DataStructureDefinition may be related to one MetadataStructureDefinition, in order to use the latter’s MetadataAttributes, by relating them to other //[[Components>>doc:xwiki:Glossary.Component.WebHome]]// within the [[DSD>>doc:xwiki:Glossary.Data structure definition.WebHome]], as explained below.
102 +A DataStructureDefinition defines the Dimensions, TimeDimension, DataAttributes, and Measures, and associated Representations, that comprise the valid structure of data and related attributes that are contained in a DataSet, which is defined by a Dataflow. In addition, a DataStructureDefinition may be related to one MetadataStructureDefinition, in order to use the latter’s MetadataAttributes, by relating them to other //Components// within the DSD, as explained below.
103 103  
104 -The [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] may also have additional metadata attached that define qualitative information and (% style="color:#2ecc71" %)Constraints(%%) on the use of the DataStructureDefinition such as the subset of [[Codes>>doc:xwiki:Glossary.Code.WebHome]] used in a [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] (this is covered later in this document – see sections “(% style="color:#2ecc71" %)Constraints(%%)” and “Data Provisioning”). Each [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] has a maximum of one DataStructureDefinition specified which defines the structure of any [[DataSets>>doc:xwiki:Glossary.Data set.WebHome]] to be reported/disseminated.
104 +The Dataflow may also have additional metadata attached that define qualitative information and Constraints on the use of the DataStructureDefinition such as the subset of Codes used in a Dimension (this is covered later in this document – see sections “Constraints” and “Data Provisioning”). Each Dataflow has a maximum of one DataStructureDefinition specified which defines the structure of any DataSets to be reported/disseminated.
105 105  
106 -There are two types of [[dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] each having a common association to (% style="color:#2ecc71" %)Concept(%%):
106 +There are two types of dimensions each having a common association to Concept:
107 107  
108 -* [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]]
108 +* Dimension
109 109  * TimeDimension
110 110  
111 -Note that DimensionComponent can be any or all its sub classes i.e., [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]], TimeDimension.
111 +Note that DimensionComponent can be any or all its sub classes i.e., Dimension, TimeDimension.
112 112  
113 -The //DimensionComponent//, DataAttribute, MetadataAttribute and [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] link to the (% style="color:#2ecc71" %)Concept(%%) that defines its name and semantic (/conceptIdentity association to (% style="color:#2ecc71" %)Concept(%%)). The DataAttribute, [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] (but not TimeDimension) and [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] can optionally have a +conceptRole association with a (% style="color:#2ecc71" %)Concept(%%) that identifies its role in the DataStructureDefinition, or one of the standard pre-defined roles, i.e., those published in "GUIDELINES FOR [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] (% style="color:#2ecc71" %)CONCEPT(%%) ROLES" by the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] SWG. The use of these roles is to enable applications to process the data in a meaningful way (e.g., relating a [[dimension>>doc:xwiki:Glossary.Dimension.WebHome]] value to a mapping vector). It is expected, beyond the standard roles published by the SWG, that communities (such as the official statistics community) will harmonise such roles within their community so that data can be exchanged and shared in a meaningful way within that community.
113 +The //DimensionComponent//, DataAttribute, MetadataAttribute and Measure link to the Concept that defines its name and semantic (/conceptIdentity association to Concept). The DataAttribute, Dimension (but not TimeDimension) and Measure can optionally have a +conceptRole association with a Concept that identifies its role in the DataStructureDefinition, or one of the standard pre-defined roles, i.e., those published in "GUIDELINES FOR SDMX CONCEPT ROLES" by the SDMX SWG. The use of these roles is to enable applications to process the data in a meaningful way (e.g., relating a dimension value to a mapping vector). It is expected, beyond the standard roles published by the SWG, that communities (such as the official statistics community) will harmonise such roles within their community so that data can be exchanged and shared in a meaningful way within that community.
114 114  
115 -The valid values for a //DimensionComponent//, [[Measure>>doc:xwiki:Glossary.Measure.WebHome]], DataAttribute or MetadataAttribute, when used in this DataStructureDefinition, are defined by the [[Representation>>doc:xwiki:Glossary.Representation.WebHome]]. This [[Representation>>doc:xwiki:Glossary.Representation.WebHome]] is taken from the (% style="color:#2ecc71" %)Concept(%%) definition (coreRepresentation) unless it is overridden in this DataStructureDefinition (localRepresentation) – see Figure 28. Note also that TimeDimension is constrained to specific FacetValueTypes. Moreover, the [[Representations>>doc:xwiki:Glossary.Representation.WebHome]] of MetadataAttributes are specified in the corresponding MetadataStructureDefinition, linked by the DataStructureDefinition.
115 +The valid values for a //DimensionComponent//, Measure, DataAttribute or MetadataAttribute, when used in this DataStructureDefinition, are defined by the Representation. This Representation is taken from the Concept definition (coreRepresentation) unless it is overridden in this DataStructureDefinition (localRepresentation) – see Figure 28. Note also that TimeDimension is constrained to specific FacetValueTypes. Moreover, the Representations of MetadataAttributes are specified in the corresponding MetadataStructureDefinition, linked by the DataStructureDefinition.
116 116  
117 -There will always be a DimensionDescriptor grouping that identifies all of the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] comprising the full key. Together the [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] specify the key of an Observation.
117 +There will always be a DimensionDescriptor grouping that identifies all of the Dimension comprising the full key. Together the Dimensions specify the key of an Observation.
118 118  
119 -The //DimensionComponent// can optionally be grouped by multiple GroupDimensionDescriptors each of which identifies the group of [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] that can form a partial key. The GroupDimensionDescriptor must be identified (GroupDimensionDescriptor.id) and this is used in the GroupKey of the [[DataSet>>doc:xwiki:Glossary.Data set.WebHome]] to declare which DataAttributes or MetadataAttributes are reported at this group (% style="color:#2ecc71" %)level(%%) in the [[DataSet>>doc:xwiki:Glossary.Data set.WebHome]].
119 +The //DimensionComponent// can optionally be grouped by multiple GroupDimensionDescriptors each of which identifies the group of Dimensions that can form a partial key. The GroupDimensionDescriptor must be identified (GroupDimensionDescriptor.id) and this is used in the GroupKey of the DataSet to declare which DataAttributes or MetadataAttributes are reported at this group level in the DataSet.
120 120  
121 -There can be a maximum of one TimeDimension specified in the DimensionDescriptor. The TimeDimension is used to specify the (% style="color:#2ecc71" %)Concept(%%) used to convey the [[time period>>doc:xwiki:Glossary.Time period.WebHome]] of the observation in a [[data set>>doc:xwiki:Glossary.Data set.WebHome]]. The TimeDimension must contain a valid [[representation>>doc:xwiki:Glossary.Representation.WebHome]] of time and cannot be coded.
121 +There can be a maximum of one TimeDimension specified in the DimensionDescriptor. The TimeDimension is used to specify the Concept used to convey the time period of the observation in a data set. The TimeDimension must contain a valid representation of time and cannot be coded.
122 122  
123 -here can be one or more [[Measures>>doc:xwiki:Glossary.Measure.WebHome]] under the MeasureDescriptor. [[Measures>>doc:xwiki:Glossary.Measure.WebHome]] represent the observable phenomena. Each [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] may have a valid [[representation>>doc:xwiki:Glossary.Representation.WebHome]], a maxOccurs [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] limiting the maximum number of values per [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] (which may be set to 'unbounded' for unlimited occurrences), as well as a minOccurs [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]], indicating the minimum required number of values, when the [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] is reported. If minOccurs or maxOccurs are omitted (they both default to ‘1’), the [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] is considered to take a single value; otherwise, it is an array. Moreover, the usage [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] indicates whether a [[Measure>>doc:xwiki:Glossary.Measure.WebHome]] must be reported or not, by the corresponding values: mandatory or optional.
123 +here can be one or more Measures under the MeasureDescriptor. Measures represent the observable phenomena. Each Measure may have a valid representation, a maxOccurs attribute limiting the maximum number of values per Measure (which may be set to 'unbounded' for unlimited occurrences), as well as a minOccurs attribute, indicating the minimum required number of values, when the Measure is reported. If minOccurs or maxOccurs are omitted (they both default to ‘1’), the Measure is considered to take a single value; otherwise, it is an array. Moreover, the usage attribute indicates whether a Measure must be reported or not, by the corresponding values: mandatory or optional.
124 124  
125 -The AttributeDescriptor may contain one or more //[[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]]//s, i.e., at least one DataAttribute definition or one MetadataAttribute reference.
125 +The AttributeDescriptor may contain one or more //Attribute//s, i.e., at least one DataAttribute definition or one MetadataAttribute reference.
126 126  
127 -The DataAttribute defines a characteristic of data that are collected or disseminated and is grouped in the DataStructureDefinition by a single AttributeDescriptor. The DataAttribute can be indicated if it must be reported or not, by the corresponding value of the usage [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]]: i.e., mandatory or optional. The property minOccurs specifies the minimum number of array values to be included when the DataAttribute is reported. Moreover, a maxOccurs [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] indicates whether the DataAttribute may need to report more than one values, i.e., an array of values. The DataAttribute may play a specific role in the structure and this is specified by the +role association to the (% style="color:#2ecc71" %)Concept(%%) that identifies its role.
127 +The DataAttribute defines a characteristic of data that are collected or disseminated and is grouped in the DataStructureDefinition by a single AttributeDescriptor. The DataAttribute can be indicated if it must be reported or not, by the corresponding value of the usage attribute: i.e., mandatory or optional. The property minOccurs specifies the minimum number of array values to be included when the DataAttribute is reported. Moreover, a maxOccurs attribute indicates whether the DataAttribute may need to report more than one values, i.e., an array of values. The DataAttribute may play a specific role in the structure and this is specified by the +role association to the Concept that identifies its role.
128 128  
129 -The MetadataAttribute defines [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] that may be collected or disseminated and is grouped together with DataAttribute under the AttributeDescriptor.
129 +The MetadataAttribute defines reference metadata that may be collected or disseminated and is grouped together with DataAttribute under the AttributeDescriptor.
130 130  
131 -A DataAttribute or a MetadataAttribute (i.e., an //AttributeComponent//) is specified as being +relatedTo an AttributeRelationship, which defines the constructs to which the //AttributeComponent// is to be reported within a //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]//. An //AttributeComponent// can be specified as being related to one of the following [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]]:
131 +A DataAttribute or a MetadataAttribute (i.e., an //AttributeComponent//) is specified as being +relatedTo an AttributeRelationship, which defines the constructs to which the //AttributeComponent// is to be reported within a //DataSet//. An //AttributeComponent// can be specified as being related to one of the following artefacts:
132 132  
133 -* All data within the [[dataset>>doc:xwiki:Glossary.Data set.WebHome]] (DataflowRelationship) – this is equivalent to attaching an [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] to all data within the [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]].
134 -* [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] or set of [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] (DimensionRelationship)
135 -* Set of [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] specified by a GroupKey (GroupRelationship – this is retained for compatibility reasons – or +groupKey of the DimensionRelationship)
133 +* All data within the dataset (DataflowRelationship) – this is equivalent to attaching an Attribute to all data within the Dataflow.
134 +* Dimension or set of Dimensions (DimensionRelationship)
135 +* Set of Dimensions specified by a GroupKey (GroupRelationship – this is retained for compatibility reasons – or +groupKey of the DimensionRelationship)
136 136  * Observation (ObservationRelationship)
137 -* In addition to the positioning of an //AttributeComponent// within a //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]//, another relationship indicates the [[Measure>>doc:xwiki:Glossary.Measure.WebHome]](s) for which the //AttributeComponent// is reported. Regardless of the position of the //AttributeComponent// within the //[[DataSet>>doc:xwiki:Glossary.Data set.WebHome]]//, the //AttributeComponent// may concern one, more than one, or all [[Measures>>doc:xwiki:Glossary.Measure.WebHome]] included in the [[DSD>>doc:xwiki:Glossary.Data structure definition.WebHome]]. This is expressed using the MeasureRelationship class, which relates a DataAttribute to one or more [[Measures>>doc:xwiki:Glossary.Measure.WebHome]]. Lack of the MeasureRelationship defaults to a relationship to all [[Measures>>doc:xwiki:Glossary.Measure.WebHome]].
137 +* In addition to the positioning of an //AttributeComponent// within a //DataSet//, another relationship indicates the Measure(s) for which the //AttributeComponent// is reported. Regardless of the position of the //AttributeComponent// within the //DataSet//, the //AttributeComponent// may concern one, more than one, or all Measures included in the DSD. This is expressed using the MeasureRelationship class, which relates a DataAttribute to one or more Measures. Lack of the MeasureRelationship defaults to a relationship to all Measures.
138 138  
139 139  [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_f235bfd4.jpg||height="542" width="604"]]
140 140  
... ... @@ -144,10 +144,10 @@
144 144  
145 145  (% style="width:839.039px" %)
146 146  |**Relationship**|(% style="width:384px" %)**Meaning**|(% style="width:303px" %)**Location in Data Set at which the Attribute is reported**
147 -|DataflowRelationship|(% style="width:384px" %)The value of the [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is fixed for all data contained in the [[dataset>>doc:xwiki:Glossary.Data set.WebHome]]. The [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] value applies to all data defined by the underlying [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]].|(% style="width:303px" %)The [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is reported at the [[Dataset>>doc:xwiki:Glossary.Data set.WebHome]] (% style="color:#2ecc71" %)level(%%).
148 -|[[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] (1..n)|(% style="width:384px" %)The value of the [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] will vary with the value(s) of the referenced [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]](s). In this case, Group(s) to which the [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] should be attached may optionally be specified.|(% style="width:303px" %)The [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is reported at the lowest (% style="color:#2ecc71" %)level(%%) of the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] to which the [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is related, otherwise at the (% style="color:#2ecc71" %)level(%%) of the Group if Attachment Group(s) is specified.
149 -|Group|(% style="width:384px" %)The value of the [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] varies with combination of values for all of the [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] contained in the Group. This is added as a convenience to listing all [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]] and the attachment Group, but should only be used when the [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] value varies based on __all__ Group [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] values.|(% style="width:303px" %)The [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is reported at the (% style="color:#2ecc71" %)level(%%) of Group.
150 -|Observation|(% style="width:384px" %)The value of the [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] varies with the observed value.|(% style="width:303px" %)The [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is reported at the (% style="color:#2ecc71" %)level(%%) of Observation.
147 +|DataflowRelationship|(% style="width:384px" %)The value of the attribute is fixed for all data contained in the dataset. The Attribute value applies to all data defined by the underlying Dataflow.|(% style="width:303px" %)The attribute is reported at the Dataset level.
148 +|Dimension (1..n)|(% style="width:384px" %)The value of the attribute will vary with the value(s) of the referenced Dimension(s). In this case, Group(s) to which the attribute should be attached may optionally be specified.|(% style="width:303px" %)The attribute is reported at the lowest level of the Dimension to which the Attribute is related, otherwise at the level of the Group if Attachment Group(s) is specified.
149 +|Group|(% style="width:384px" %)The value of the Attribute varies with combination of values for all of the Dimensions contained in the Group. This is added as a convenience to listing all Dimensions and the attachment Group, but should only be used when the Attribute value varies based on __all__ Group Dimension values.|(% style="width:303px" %)The attribute is reported at the level of Group.
150 +|Observation|(% style="width:384px" %)The value of the Attribute varies with the observed value.|(% style="width:303px" %)The attribute is reported at the level of Observation.
151 151  
152 152  [[image:SDMX 3-0-0 SECTION 2 FINAL-1.0 (1)_en_42ff01fb.jpg||height="380" width="590"]]
153 153