Skip to Content

Wiki source code of 5 Reference Metadata

Version 16.1 by Helena on 2025/07/20 12:43
Show last authors
1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 == 5.1 Scope of the Metadata Structure Definition (MSD) ==
6
7 The scope of the [[MSD>>doc:Glossary.Metadata structure definition.WebHome]] is reduced in [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] 3.0, by means of simplifying its structure, but also in the way referenced [[Artefacts>>doc:Glossary.Artefact.WebHome]] are targeted. In fact, the [[MSD>>doc:Glossary.Metadata structure definition.WebHome]] is restricted to play the role of a single container, without targeting any specific [[Artefact>>doc:Glossary.Artefact.WebHome]]. The possible targets of [[Metadata Set>>doc:Glossary.Metadata set.WebHome]] are specified in the [[Metadataflows>>doc:Glossary.Metadataflow.WebHome]] or Metadata [[Provision Agreements>>doc:Glossary.Provision agreement.WebHome]] relating to that [[MSD>>doc:Glossary.Metadata structure definition.WebHome]]. To achieve that, the structure of the [[Metadataflow>>doc:Glossary.Metadataflow.WebHome]] has changed in this version of the standard. Moreover, the Metadata [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]] [[Artefact>>doc:Glossary.Artefact.WebHome]] is introduced to include this feature.
8
9 Two more changes, introduced in this version, are the following:
10
11 * The [[Metadata Set>>doc:Glossary.Metadata set.WebHome]] becomes a [[Maintainable Artefact>>doc:Glossary.Maintainable artefact.WebHome]] but maintained by a Metadata Provider (another new [[Artefact>>doc:Glossary.Artefact.WebHome]] in this version).
12 * Metadata [[Attributes>>doc:Glossary.Attribute.WebHome]] may also be used in [[Data Structure Definitions>>doc:Glossary.Data structure definition.WebHome]], as long as the latter reference the [[Metadata Structure Definition>>doc:Glossary.Metadata structure definition.WebHome]] that specify those Metadata [[Attributes>>doc:Glossary.Attribute.WebHome]].
13
14 == 5.2 Identification of the Object(s) to which the Metadata is to be attached ==
15
16 The following example shows the structure and naming of the [[MSD>>doc:Glossary.Metadata structure definition.WebHome]] and related [[components>>doc:Glossary.Component.WebHome]] for creating reference metadata.
17
18 The schematic structure of an [[MSD>>doc:Glossary.Metadata structure definition.WebHome]] is shown below.
19
20 [[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_bf0dc4e4.jpg||height="309" width="550"]]
21
22 (% class="wikigeneratedid" id="HFigure1:SchematicoftheMetadataStructureDefinition" %)
23 **Figure 1: Schematic of the Metadata Structure Definition**
24
25 The [[MSD>>doc:Glossary.Metadata structure definition.WebHome]] contains one Metadata [[Attribute>>doc:Glossary.Attribute.WebHome]] Descriptor comprising the Metadata [[Attributes>>doc:Glossary.Attribute.WebHome]] that identify the (% style="color:#e74c3c" %)[[Concepts>>doc:sdmx:Glossary.Concept.WebHome]](%%) for which metadata may be reported in the [[Metadata Set>>doc:Glossary.Metadata set.WebHome]]. The [[Metadataflow>>doc:Glossary.Metadataflow.WebHome]] and Metadata [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]] comprise the specification of the objects to which metadata can be reported in a [[Metadata Set>>doc:Glossary.Metadata set.WebHome]] (Metadata Target(s)).
26
27 The high-level view of the [[MSD>>doc:Glossary.Metadata structure definition.WebHome]], as well as the way the [[Metadataflow>>doc:Glossary.Metadataflow.WebHome]] and Metadata [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]] specify the Targets:
28
29 [[image:1747384080138-902.png]]
30
31 **Figure 2: The high-level view of the MSD containing one Metadata Attribute Descriptor**
32
33 [[image:1747384138269-958.png]]
34
35 (% class="wikigeneratedid" id="HFigure3:WildcardedTargetObjectsasspecifiedinaMetadataflow" %)
36 **Figure 3: Wildcarded Target Objects as specified in a Metadataflow**
37
38 [[image:1747384174686-528.png]]
39
40 (% class="wikigeneratedid" id="HFigure4:SpecificTargetObjectsasspecifiedinaMetadataProvisionAgreement" %)
41 **Figure 4: Specific Target Objects as specified in a Metadata Provision Agreement**
42
43 Note that the [[SDMX-ML>>doc: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 agency, Id, [[version>>path:/xwiki/wiki/sdmx/get/Methodology/SDMX%203.0%20Standards.%20Section%206.%20Technical%20Notes/4%20General%20Notes%20for%20Implementers/?sheet=CKEditor.ResourceDispatcher&outputSyntax=plain&language=&type=doc&reference=Glossary.Version.WebHome&typed=true]], and id of the Maintainable Object in which it resides.
44
45 == 5.3 Metadata Structure Definition ==
46
47 An example is shown below.
48
49 [[image:1747384374785-123.png]]
50
51 **Figure 5: Example MSD showing specification of some Metadata Attributes **
52
53 This example shows the following [[hierarchy>>doc:Glossary.Hierarchy.WebHome]] of Metadata [[Attributes>>doc:Glossary.Attribute.WebHome]]:
54
55 * [[Contact>>doc:Glossary.Contact.WebHome]] – this is presentational; no metadata is expected to be reported at this level
56 ** Contact Name
57 ** Address – this is also presentational; up to 3 addresses are allowed
58 *** House Number
59
60 == 5.4 Metadata Set ==
61
62 An example of reporting metadata according to the [[MSD>>doc:Glossary.Metadata structure definition.WebHome]] described above, is shown below.
63
64 [[image:1747384548140-783.png]]
65
66 (% class="wikigeneratedid" id="HFigure6:ExampleMetadataSet" %)
67 **Figure 6: Example Metadata Set**
68
69 This example shows:
70
71 1. The reference to the Metadata [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]] and Metadata Target
72 1. The reported metadata [[attributes>>doc:Glossary.Attribute.WebHome]] (AttributeSet)
73
74 == 5.5 Reference Metadata in Data Structure Definition and Dataset ==
75
76 An important change of [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 is the ability to reference an [[MSD>>doc:Glossary.Metadata structure definition.WebHome]] within a [[DSD>>doc:Glossary.Data structure definition.WebHome]], in order to report any Metadata [[Attributes>>doc:Glossary.Attribute.WebHome]] defined in the former to [[Datasets>>doc:Glossary.Data set.WebHome]] of the latter.
77
78 This is achieved by the following:
79
80 * In a [[DSD>>doc:Glossary.Data structure definition.WebHome]], the user may add a reference to one [[MSD>>doc:Glossary.Metadata structure definition.WebHome]].
81 * In the [[Attribute>>doc:Glossary.Attribute.WebHome]] Descriptor of the [[DSD>>doc:Glossary.Data structure definition.WebHome]], the user may include any Metadata [[Attributes>>doc:Glossary.Attribute.WebHome]] defined in the linked [[MSD>>doc:Glossary.Metadata structure definition.WebHome]]. o For each link to a Metadata [[Attribute>>doc:Glossary.Attribute.WebHome]], an [[Attribute Relationship>>doc:Glossary.Attribute relationship.WebHome]] may be specified (similarly to that for Data [[Attributes>>doc:Glossary.Attribute.WebHome]]).
82 * In any [[Dataset>>doc:Glossary.Data set.WebHome]] complying with this [[DSD>>doc:Glossary.Data structure definition.WebHome]], Metadata [[Attributes>>doc:Glossary.Attribute.WebHome]] may be reported according to the specified [[Attribute Relationship>>doc:Glossary.Attribute relationship.WebHome]].
83 ** The [[hierarchy>>doc:Glossary.Hierarchy.WebHome]] of the Metadata [[Attributes>>doc:Glossary.Attribute.WebHome]] defined in the [[MSD>>doc:Glossary.Metadata structure definition.WebHome]] must be respected and they are reported in the same way as in a Metadataset, under the (% style="color:#e74c3c" %)level(%%) they are related within the [[DSD>>doc:Glossary.Data structure definition.WebHome]], via their [[Attribute Relationship>>doc:Glossary.Attribute relationship.WebHome]].
84 * In Data [[Constraints>>doc:Glossary.Constraint.WebHome]], the user is allowed to restrict values for Metadata [[Attributes>>doc:Glossary.Attribute.WebHome]], in the same way as Data [[Attributes>>doc:Glossary.Attribute.WebHome]] (more on this in section “10 Constraints”).