Skip to Content

Changes for page 5 Reference Metadata

Last modified by Helena on 2025/09/10 11:19
From version 3.2
edited by Helena
on 2025/05/16 00:06
Change comment: There is no comment for this version
To version 9.2
edited by Helena
on 2025/05/19 11:35
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -4,219 +4,81 @@
4 4  
5 5  == 5.1 Scope of the Metadata Structure Definition (MSD) ==
6 6  
7 -The scope of the MSD is reduced in SDMX 3.0, by means of simplifying its structure, but also in the way referenced Artefacts are targeted. In fact, the MSD is restricted to play the role of a single container, without targeting any specific Artefact. The possible targets of Metadata Set are specified in the Metadataflows or Metadata Provision Agreements relating to that MSD. To achieve that, the structure of the Metadataflow has changed in this version of the standard. Moreover, the Metadata Provision Agreement Artefact is introduced to include this feature.
7 +The scope of the [[MSD>>doc:xwiki:Glossary.Metadata structure definition.WebHome]] is reduced in [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] 3.0, by means of simplifying its structure, but also in the way referenced [[Artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] are targeted. In fact, the [[MSD>>doc:xwiki:Glossary.Metadata structure definition.WebHome]] is restricted to play the role of a single container, without targeting any specific [[Artefact>>doc:xwiki:Glossary.Artefact.WebHome]]. The possible targets of [[Metadata Set>>doc:xwiki:Glossary.Metadata set.WebHome]] are specified in the [[Metadataflows>>doc:xwiki:Glossary.Metadataflow.WebHome]] or Metadata [[Provision Agreements>>doc:xwiki:Glossary.Provision agreement.WebHome]] relating to that [[MSD>>doc:xwiki:Glossary.Metadata structure definition.WebHome]]. To achieve that, the structure of the [[Metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]] has changed in this (% style="color:#2ecc71" %)version(%%) of the standard. Moreover, the Metadata [[Provision Agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]] [[Artefact>>doc:xwiki:Glossary.Artefact.WebHome]] is introduced to include this feature.
8 8  
9 -Two more changes, introduced in this version, are the following:
9 +Two more changes, introduced in this (% style="color:#2ecc71" %)version(%%), are the following:
10 10  
11 -* The Metadata Set becomes a Maintainable Artefact but maintained by a Metadata Provider (another new Artefact in this version).
12 -* Metadata Attributes may also be used in Data Structure Definitions, as long as the latter reference the Metadata Structure Definition that specify those Metadata Attributes.
11 +* The [[Metadata Set>>doc:xwiki:Glossary.Metadata set.WebHome]] becomes a [[Maintainable Artefact>>doc:xwiki:Glossary.Maintainable artefact.WebHome]] but maintained by a Metadata Provider (another new [[Artefact>>doc:xwiki:Glossary.Artefact.WebHome]] in this (% style="color:#2ecc71" %)version(%%)).
12 +* Metadata [[Attributes>>doc:xwiki:Glossary.Attribute.WebHome]] may also be used in [[Data Structure Definitions>>doc:xwiki:Glossary.Data structure definition.WebHome]], as long as the latter reference the [[Metadata Structure Definition>>doc:xwiki:Glossary.Metadata structure definition.WebHome]] that specify those Metadata [[Attributes>>doc:xwiki:Glossary.Attribute.WebHome]].
13 13  
14 14  == 5.2 Identification of the Object(s) to which the Metadata is to be attached ==
15 15  
16 -The following example shows the structure and naming of the MSD and related components for creating reference metadata.
16 +The following example shows the structure and naming of the [[MSD>>doc:xwiki:Glossary.Metadata structure definition.WebHome]] and related [[components>>doc:xwiki:Glossary.Component.WebHome]] for creating reference metadata.
17 17  
18 -The schematic structure of an MSD is shown below.
18 +The schematic structure of an [[MSD>>doc:xwiki:Glossary.Metadata structure definition.WebHome]] is shown below.
19 19  
20 20  [[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_bf0dc4e4.jpg||height="309" width="550"]]
21 21  
22 -==== Figure 1: Schematic of the Metadata Structure Definition ====
22 +(% class="wikigeneratedid" id="HFigure1:SchematicoftheMetadataStructureDefinition" %)
23 +**Figure 1: Schematic of the Metadata Structure Definition**
23 23  
24 -The MSD contains one Metadata Attribute Descriptor comprising the Metadata Attributes that identify the Concepts for which metadata may be reported in the Metadata Set. The Metadataflow and Metadata Provision Agreement comprise the specification of the objects to which metadata can be reported in a Metadata Set (Metadata Target(s)).
25 +The [[MSD>>doc:xwiki:Glossary.Metadata structure definition.WebHome]] contains one Metadata [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] Descriptor comprising the Metadata [[Attributes>>doc:xwiki:Glossary.Attribute.WebHome]] that identify the (% style="color:#2ecc71" %)Concepts(%%) for which metadata may be reported in the [[Metadata Set>>doc:xwiki:Glossary.Metadata set.WebHome]]. The [[Metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]] and Metadata [[Provision Agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]] comprise the specification of the objects to which metadata can be reported in a [[Metadata Set>>doc:xwiki:Glossary.Metadata set.WebHome]] (Metadata Target(s)).
25 25  
26 -The high-level view of the MSD, as well as the way the Metadataflow and Metadata Provision Agreement specify the Targets:
27 +The high-(% style="color:#2ecc71" %)level(%%) view of the [[MSD>>doc:xwiki:Glossary.Metadata structure definition.WebHome]], as well as the way the [[Metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]] and Metadata [[Provision Agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]] specify the Targets:
27 27  
28 -**<str:MetadataStructure agencyID="SDMX" id="MSD" version="1.0.0-draft">**
29 +[[image:1747384080138-902.png]]
29 29  
30 -**<com:Name>MSD 3.0 sample</com:Name>**
31 -
32 -**<str:MetadataAttributeDescriptor id="MetadataAttributeDescriptor">**
33 -
34 -**...**
35 -
36 -**</str: MetadataAttributeDescriptor>**
37 -
38 -**</str:MetadataStructure>**
39 -
40 40  **Figure 2: The high-level view of the MSD containing one Metadata Attribute Descriptor**
41 41  
42 -**<str:Metadataflow agencyID="OECD" id="GENERAL_METADATA" version="1.0.0draft">**
33 +[[image:1747384138269-958.png]]
43 43  
44 -**<com:Name xml:lang="en">Metadataflow 3.0 sample</com:Name> &nbsp;&nbsp;<str:Structure>urn:sdmx:org.sdmx.infomodel.metadatastructure.**
35 +(% class="wikigeneratedid" id="HFigure3:WildcardedTargetObjectsasspecifiedinaMetadataflow" %)
36 +**Figure 3: Wildcarded Target Objects as specified in a Metadataflow**
45 45  
46 -**MetadataStructure=OECD:MSD(1.0.0-draft)</str:Structure>**
38 +[[image:1747384174686-528.png]]
47 47  
48 -**<!~-~- Attach to any Dataflows maintained by the OECD ~-~-> &nbsp;&nbsp;<str:Targets>urn:sdmx:org.sdmx.infomodel.datastructure.**
40 +(% class="wikigeneratedid" id="HFigure4:SpecificTargetObjectsasspecifiedinaMetadataProvisionAgreement" %)
41 +**Figure 4: Specific Target Objects as specified in a Metadata Provision Agreement**
49 49  
50 -**Dataflow=OECD:*(*)</str:Targets>**
43 +Note that the [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] schemas have specific XML elements for each identifiable object type because identifying, for instance, a Maintainable Object has different properties from an Identifiable Object which must also include the agencyId, (% style="color:#2ecc71" %)version(%%), and id of the Maintainable Object in which it resides.
51 51  
52 -**</str:Metadataflow>**
53 -
54 -==== Figure 3: Wildcarded Target Objects as specified in a Metadataflow ====
55 -
56 -**<str:MetadataProvisionAgreement agencyID="OECD" id="ABS_INDICATORS" version="1.0.0-draft">**
57 -
58 -**<com:Name xml:lang="en">Metadata Provision Agreement 3.0 sample</com:Name>**
59 -
60 -**<str:StructureUsage>urn:sdmx:org.sdmx.infomodel.metadatastructure.**
61 -
62 -**Metadataflow=OECD:GENERAL_METADATA(1.0.0-draft)</str:StructureUsage>**
63 -
64 -**<str:MetadataProvider>urn:sdmx:org.sdmx.infomodel.base.**
65 -
66 -**MetadataProvider=OECD:METADATA_PROVIDERS(1.0).ABS</str:MetadataProvider>**
67 -
68 -**<!~-~- Attach to specific Dataflows maintained by the OECD ~-~->**
69 -
70 -**<str:Target>urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow= OECD:GDP(*)</str:Target>**
71 -
72 -**<str:Target>urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow= OECD:EXR(*)</str:Target>**
73 -
74 -**<str:Target>urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=**
75 -
76 -**OECD:ABC(*)</str:Target>**
77 -
78 -**</str:MetadataProvisionAgreement>**
79 -
80 -==== Figure 4: Specific Target Objects as specified in a Metadata Provision Agreement ====
81 -
82 -Note that the SDMX-ML schemas have specific XML elements for each identifiable object type because identifying, for instance, a Maintainable Object has different properties from an Identifiable Object which must also include the agencyId, version, and id of the Maintainable Object in which it resides.
83 -
84 84  == 5.3 Metadata Structure Definition ==
85 85  
86 86  An example is shown below.
87 87  
88 -**<str:MetadataStructure agencyID="SDMX" id="MSD" version="1.0.0-draft">**
49 +[[image:1747384374785-123.png]]
89 89  
90 -**<com:Name>MSD 3.0 sample</com:Name>**
51 +**Figure 5: Example MSD showing specification of some Metadata Attributes **
91 91  
92 -**<str:MetadataAttributeDescriptor id="MetadataAttributeDescriptor">**
53 +This example shows the following [[hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] of Metadata [[Attributes>>doc:xwiki:Glossary.Attribute.WebHome]]:
93 93  
94 -**<str:MetadataAttribute id="CONTACT" isPresentational="true"> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<str:ConceptIdentity>urn:sdmx:org.sdmx.infomodel.conceptscheme.**
55 +* (% style="color:#2ecc71" %)Contact(%%) – this is presentational; no metadata is expected to be reported at this level
56 +** (% style="color:#2ecc71" %)Contact(%%) Name
57 +** Address – this is also presentational; up to 3 addresses are allowed
58 +*** House Number
95 95  
96 -**Concept=SDMX:CONCEPTS(1.0.0).CONTACT</str:ConceptIdentity>**
97 -
98 -**<str:MetadataAttribute id="CONTACT_NAME" minOccurs="1" maxOccurs="1">**
99 -
100 -**<str:ConceptIdentity>urn:sdmx:org.sdmx.infomodel.conceptscheme.**
101 -
102 -**Concept=SDMX:CONCEPTS(1.0.0).CONTACT_NAME</str:ConceptIdentity>**
103 -
104 -**<str:LocalRepresentation>**
105 -
106 -**<str:TextFormat textType="String"/>**
107 -
108 -**</str:LocalRepresentation>**
109 -
110 -**</str:MetadataAttribute>**
111 -
112 -**<str:MetadataAttribute id="ADDRESS" minOccurs="1" maxOccurs="3" isPresentational="true">**
113 -
114 -**<str:ConceptIdentity>urn:sdmx:org.sdmx.infomodel.conceptscheme.**
115 -
116 -**Concept=SDMX:CONCEPTS(1.0.0).ADDRESS</str:ConceptIdentity> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<str:MetadataAttribute id="HOUSE_NUMBER" minOccurs="1" maxOccurs="1">**
117 -
118 -**<str:ConceptIdentity>urn:sdmx:org.sdmx.infomodel.conceptscheme.**
119 -
120 -**Concept=SDMX:CONCEPTS(1.0.0).HOUSE_NUMBER</str:ConceptIdentity>**
121 -
122 -**<str:LocalRepresentation>**
123 -
124 -**<str:TextFormat textType="Integer"/>**
125 -
126 -**</str:LocalRepresentation>**
127 -
128 -**</str:MetadataAttribute>**
129 -
130 -**</str:MetadataAttribute>**
131 -
132 -**</str:MetadataAttribute>**
133 -
134 -**</str:MetadataAttributeDescriptor>**
135 -
136 -**</str:MetadataStructure>**
137 -
138 -**Figure 5: Example MSD showing specification of some Metadata Attributes **This example shows the following hierarchy of Metadata Attributes:
139 -
140 -* Contact – this is presentational; no metadata is expected to be reported at this level
141 -* Contact Name
142 -* Address – this is also presentational; up to 3 addresses are allowed
143 -* House Number
144 -
145 145  == 5.4 Metadata Set ==
146 146  
147 -An example of reporting metadata according to the MSD described above, is shown below.
62 +An example of reporting metadata according to the [[MSD>>doc:xwiki:Glossary.Metadata structure definition.WebHome]] described above, is shown below.
148 148  
149 -**<msg:MetadataSet id="ALB" metadataProviderID="OECD" version="1.0.0"> <str:MetadataProvision>urn:sdmx:org.sdmx.infomodel.registry.MetadataProvis ionAgreement=OECD:ABS_INDICATORS(1.0.0-draft)</str:MetadataProvision> <str:Target>urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=OECD:GDP(1.**
64 +[[image:1747384548140-783.png]]
150 150  
151 -**0.0)</str:Target>**
66 +(% class="wikigeneratedid" id="HFigure6:ExampleMetadataSet" %)
67 +**Figure 6: Example Metadata Set**
152 152  
153 -**<md:AttributeSet>**
154 -
155 -**<md:ReportedAttribute id="CONTACT">**
156 -
157 -**<md:AttributeSet>**
158 -
159 -**<md:ReportedAttribute id="CONTACT_NAME">John Doe**
160 -
161 -**</md:ReportedAttribute>**
162 -
163 -**<md:ReportedAttribute id="ADDRESS">**
164 -
165 -**<md:AttributeSet>**
166 -
167 -**<md:ReportedAttribute id="STREET_NAME">**
168 -
169 -**<com:Text xml:lang="en">5th Avenue</com:Text>**
170 -
171 -**</md:ReportedAttribute>**
172 -
173 -**<md:ReportedAttribute id="HOUSE_NUMBER">12**
174 -
175 -**</md:ReportedAttribute>**
176 -
177 -**</md:AttributeSet>**
178 -
179 -**</md:ReportedAttribute>**
180 -
181 -**<md:ReportedAttribute id="HTML_ATTR">**
182 -
183 -**<com:StructuredText xml:lang="en">**
184 -
185 -**<div xmlns="http:~/~/www.w3.org/1999/xhtml">**
186 -
187 -**<p>Lorem Ipsum</p>**
188 -
189 -**</div>**
190 -
191 -**</com:StructuredText>**
192 -
193 -**</md:ReportedAttribute>**
194 -
195 -**</md:AttributeSet>**
196 -
197 -**</md:ReportedAttribute>**
198 -
199 -**</md:AttributeSet>**
200 -
201 -**</msg:MetadataSet>**
202 -
203 -==== Figure 6: Example Metadata Set ====
204 -
205 205  This example shows:
206 206  
207 -1. The reference to the Metadata Provision Agreement and Metadata Target
208 -1. The reported metadata attributes (AttributeSet)
71 +1. The reference to the Metadata [[Provision Agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]] and Metadata Target
72 +1. The reported metadata [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]] (AttributeSet)
209 209  
210 210  == 5.5 Reference Metadata in Data Structure Definition and Dataset ==
211 211  
212 -An important change of SDMX 3.0 is the ability to reference an MSD within a DSD, in order to report any Metadata Attributes defined in the former to Datasets of the latter.
76 +An important change of [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 is the ability to reference an [[MSD>>doc:xwiki:Glossary.Metadata structure definition.WebHome]] within a [[DSD>>doc:xwiki:Glossary.Data structure definition.WebHome]], in order to report any Metadata [[Attributes>>doc:xwiki:Glossary.Attribute.WebHome]] defined in the former to [[Datasets>>doc:xwiki:Glossary.Data set.WebHome]] of the latter.
213 213  
214 214  This is achieved by the following:
215 215  
216 -* In a DSD, the user may add a reference to one MSD.
217 -* In the Attribute Descriptor of the DSD, the user may include any Metadata Attributes defined in the linked MSD. o For each link to a Metadata Attribute, an Attribute Relationship may be specified (similarly to that for Data Attributes).
218 -* In any Dataset complying with this DSD, Metadata Attributes may be reported according to the specified Attribute Relationship.
219 -
220 -o The hierarchy of the Metadata Attributes defined in the MSD must be respected and they are reported in the same way as in a Metadataset, under the level they are related within the DSD, via their Attribute Relationship.
221 -
222 -* In Data Constraints, the user is allowed to restrict values for Metadata Attributes, in the same way as Data Attributes (more on this in section “10 Constraints”).
80 +* In a [[DSD>>doc:xwiki:Glossary.Data structure definition.WebHome]], the user may add a reference to one [[MSD>>doc:xwiki:Glossary.Metadata structure definition.WebHome]].
81 +* In the [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] Descriptor of the [[DSD>>doc:xwiki:Glossary.Data structure definition.WebHome]], the user may include any Metadata [[Attributes>>doc:xwiki:Glossary.Attribute.WebHome]] defined in the linked [[MSD>>doc:xwiki:Glossary.Metadata structure definition.WebHome]]. o For each link to a Metadata [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]], an [[Attribute Relationship>>doc:xwiki:Glossary.Attribute relationship.WebHome]] may be specified (similarly to that for Data [[Attributes>>doc:xwiki:Glossary.Attribute.WebHome]]).
82 +* In any [[Dataset>>doc:xwiki:Glossary.Data set.WebHome]] complying with this [[DSD>>doc:xwiki:Glossary.Data structure definition.WebHome]], Metadata [[Attributes>>doc:xwiki:Glossary.Attribute.WebHome]] may be reported according to the specified [[Attribute Relationship>>doc:xwiki:Glossary.Attribute relationship.WebHome]].
83 +** The [[hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] of the Metadata [[Attributes>>doc:xwiki:Glossary.Attribute.WebHome]] defined in the [[MSD>>doc:xwiki:Glossary.Metadata structure definition.WebHome]] must be respected and they are reported in the same way as in a Metadataset, under the (% style="color:#2ecc71" %)level(%%) they are related within the [[DSD>>doc:xwiki:Glossary.Data structure definition.WebHome]], via their [[Attribute Relationship>>doc:xwiki:Glossary.Attribute relationship.WebHome]].
84 +* In Data (% style="color:#2ecc71" %)Constraints(%%), the user is allowed to restrict values for Metadata [[Attributes>>doc:xwiki:Glossary.Attribute.WebHome]], in the same way as Data [[Attributes>>doc:xwiki:Glossary.Attribute.WebHome]] (more on this in section “10 Constraints”).
1747384080138-902.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +18.4 KB
Content
1747384116398-251.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +34.1 KB
Content
1747384138269-958.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +34.2 KB
Content
1747384174686-528.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +45.1 KB
Content
1747384337568-720.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +78.7 KB
Content
1747384374785-123.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +75.9 KB
Content
1747384548140-783.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +62.8 KB
Content