Skip to Content

Changes for page 5 Reference Metadata

Last modified by Helena on 2025/09/10 11:19
From version 6.1
edited by Helena
on 2025/05/16 00:09
Change comment: There is no comment for this version
To version 3.1
edited by Helena
on 2025/05/15 15:48
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,6 +1,4 @@
1 -{{box title="**Contents**"}}
2 -{{toc/}}
3 -{{/box}}
1 += 5 Reference Metadata =
4 4  
5 5  == 5.1 Scope of the Metadata Structure Definition (MSD) ==
6 6  
... ... @@ -19,21 +19,66 @@
19 19  
20 20  [[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_bf0dc4e4.jpg||height="309" width="550"]]
21 21  
22 -(% class="wikigeneratedid" id="HFigure1:SchematicoftheMetadataStructureDefinition" %)
23 -**Figure 1: Schematic of the Metadata Structure Definition**
20 +==== Figure 1: Schematic of the Metadata Structure Definition ====
24 24  
25 25  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)).
26 26  
27 27  The high-level view of the MSD, as well as the way the Metadataflow and Metadata Provision Agreement specify the Targets:
28 28  
26 +**<str:MetadataStructure agencyID="SDMX" id="MSD" version="1.0.0-draft">**
29 29  
30 -(% class="wikigeneratedid" id="HFigure3:WildcardedTargetObjectsasspecifiedinaMetadataflow" %)
31 -**Figure 3: Wildcarded Target Objects as specified in a Metadataflow**
28 +**<com:Name>MSD 3.0 sample</com:Name>**
32 32  
30 +**<str:MetadataAttributeDescriptor id="MetadataAttributeDescriptor">**
33 33  
34 -(% class="wikigeneratedid" id="HFigure4:SpecificTargetObjectsasspecifiedinaMetadataProvisionAgreement" %)
35 -**Figure 4: Specific Target Objects as specified in a Metadata Provision Agreement**
32 +**...**
36 36  
34 +**</str: MetadataAttributeDescriptor>**
35 +
36 +**</str:MetadataStructure>**
37 +
38 +**Figure 2: The high-level view of the MSD containing one Metadata Attribute Descriptor**
39 +
40 +**<str:Metadataflow agencyID="OECD" id="GENERAL_METADATA" version="1.0.0draft">**
41 +
42 +**<com:Name xml:lang="en">Metadataflow 3.0 sample</com:Name> &nbsp;&nbsp;<str:Structure>urn:sdmx:org.sdmx.infomodel.metadatastructure.**
43 +
44 +**MetadataStructure=OECD:MSD(1.0.0-draft)</str:Structure>**
45 +
46 +**<!~-~- Attach to any Dataflows maintained by the OECD ~-~-> &nbsp;&nbsp;<str:Targets>urn:sdmx:org.sdmx.infomodel.datastructure.**
47 +
48 +**Dataflow=OECD:*(*)</str:Targets>**
49 +
50 +**</str:Metadataflow>**
51 +
52 +==== Figure 3: Wildcarded Target Objects as specified in a Metadataflow ====
53 +
54 +**<str:MetadataProvisionAgreement agencyID="OECD" id="ABS_INDICATORS" version="1.0.0-draft">**
55 +
56 +**<com:Name xml:lang="en">Metadata Provision Agreement 3.0 sample</com:Name>**
57 +
58 +**<str:StructureUsage>urn:sdmx:org.sdmx.infomodel.metadatastructure.**
59 +
60 +**Metadataflow=OECD:GENERAL_METADATA(1.0.0-draft)</str:StructureUsage>**
61 +
62 +**<str:MetadataProvider>urn:sdmx:org.sdmx.infomodel.base.**
63 +
64 +**MetadataProvider=OECD:METADATA_PROVIDERS(1.0).ABS</str:MetadataProvider>**
65 +
66 +**<!~-~- Attach to specific Dataflows maintained by the OECD ~-~->**
67 +
68 +**<str:Target>urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow= OECD:GDP(*)</str:Target>**
69 +
70 +**<str:Target>urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow= OECD:EXR(*)</str:Target>**
71 +
72 +**<str:Target>urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=**
73 +
74 +**OECD:ABC(*)</str:Target>**
75 +
76 +**</str:MetadataProvisionAgreement>**
77 +
78 +==== Figure 4: Specific Target Objects as specified in a Metadata Provision Agreement ====
79 +
37 37  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.
38 38  
39 39  == 5.3 Metadata Structure Definition ==
... ... @@ -40,22 +40,125 @@
40 40  
41 41  An example is shown below.
42 42  
86 +**<str:MetadataStructure agencyID="SDMX" id="MSD" version="1.0.0-draft">**
43 43  
88 +**<com:Name>MSD 3.0 sample</com:Name>**
89 +
90 +**<str:MetadataAttributeDescriptor id="MetadataAttributeDescriptor">**
91 +
92 +**<str:MetadataAttribute id="CONTACT" isPresentational="true"> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<str:ConceptIdentity>urn:sdmx:org.sdmx.infomodel.conceptscheme.**
93 +
94 +**Concept=SDMX:CONCEPTS(1.0.0).CONTACT</str:ConceptIdentity>**
95 +
96 +**<str:MetadataAttribute id="CONTACT_NAME" minOccurs="1" maxOccurs="1">**
97 +
98 +**<str:ConceptIdentity>urn:sdmx:org.sdmx.infomodel.conceptscheme.**
99 +
100 +**Concept=SDMX:CONCEPTS(1.0.0).CONTACT_NAME</str:ConceptIdentity>**
101 +
102 +**<str:LocalRepresentation>**
103 +
104 +**<str:TextFormat textType="String"/>**
105 +
106 +**</str:LocalRepresentation>**
107 +
108 +**</str:MetadataAttribute>**
109 +
110 +**<str:MetadataAttribute id="ADDRESS" minOccurs="1" maxOccurs="3" isPresentational="true">**
111 +
112 +**<str:ConceptIdentity>urn:sdmx:org.sdmx.infomodel.conceptscheme.**
113 +
114 +**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">**
115 +
116 +**<str:ConceptIdentity>urn:sdmx:org.sdmx.infomodel.conceptscheme.**
117 +
118 +**Concept=SDMX:CONCEPTS(1.0.0).HOUSE_NUMBER</str:ConceptIdentity>**
119 +
120 +**<str:LocalRepresentation>**
121 +
122 +**<str:TextFormat textType="Integer"/>**
123 +
124 +**</str:LocalRepresentation>**
125 +
126 +**</str:MetadataAttribute>**
127 +
128 +**</str:MetadataAttribute>**
129 +
130 +**</str:MetadataAttribute>**
131 +
132 +**</str:MetadataAttributeDescriptor>**
133 +
134 +**</str:MetadataStructure>**
135 +
44 44  **Figure 5: Example MSD showing specification of some Metadata Attributes **This example shows the following hierarchy of Metadata Attributes:
45 45  
46 -* Contact – this is presentational; no metadata is expected to be reported at this level
47 -** Contact Name
48 -** Address – this is also presentational; up to 3 addresses are allowed
49 -*** House Number
138 +• Contact – this is presentational; no metadata is expected to be reported at this level
50 50  
140 +* Contact Name
141 +* Address – this is also presentational; up to 3 addresses are allowed
142 +
143 +▪ House Number
144 +
51 51  == 5.4 Metadata Set ==
52 52  
53 53  An example of reporting metadata according to the MSD described above, is shown below.
54 54  
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.**
55 55  
56 -(% class="wikigeneratedid" id="HFigure6:ExampleMetadataSet" %)
57 -**Figure 6: Example Metadata Set**
151 +**0.0)</str:Target>**
58 58  
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 +
59 59  This example shows:
60 60  
61 61  1. The reference to the Metadata Provision Agreement and Metadata Target