Wiki source code of 5 Reference Metadata

Version 10.1 by Helena on 2025/05/19 11:35

Hide last authors
Helena 3.2 1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
Helena 2.1 4
5 == 5.1 Scope of the Metadata Structure Definition (MSD) ==
6
Helena 8.1 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.
Helena 2.1 8
Helena 8.1 9 Two more changes, introduced in this (% style="color:#2ecc71" %)version(%%), are the following:
Helena 2.1 10
Helena 8.1 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]].
Helena 2.1 13
14 == 5.2 Identification of the Object(s) to which the Metadata is to be attached ==
15
Helena 8.1 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.
Helena 2.1 17
Helena 8.1 18 The schematic structure of an [[MSD>>doc:xwiki:Glossary.Metadata structure definition.WebHome]] is shown below.
Helena 2.1 19
20 [[image:SDMX 3-0-0 SECTION 6 FINAL-1.0_en_bf0dc4e4.jpg||height="309" width="550"]]
21
Helena 6.1 22 (% class="wikigeneratedid" id="HFigure1:SchematicoftheMetadataStructureDefinition" %)
23 **Figure 1: Schematic of the Metadata Structure Definition**
Helena 2.1 24
Helena 8.1 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)).
Helena 2.1 26
Helena 8.1 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:
Helena 2.1 28
Helena 6.2 29 [[image:1747384080138-902.png]]
Helena 2.1 30
Helena 6.2 31 **Figure 2: The high-level view of the MSD containing one Metadata Attribute Descriptor**
32
Helena 6.3 33 [[image:1747384138269-958.png]]
Helena 6.2 34
Helena 5.1 35 (% class="wikigeneratedid" id="HFigure3:WildcardedTargetObjectsasspecifiedinaMetadataflow" %)
36 **Figure 3: Wildcarded Target Objects as specified in a Metadataflow**
Helena 2.1 37
Helena 6.3 38 [[image:1747384174686-528.png]]
Helena 2.1 39
Helena 5.1 40 (% class="wikigeneratedid" id="HFigure4:SpecificTargetObjectsasspecifiedinaMetadataProvisionAgreement" %)
41 **Figure 4: Specific Target Objects as specified in a Metadata Provision Agreement**
Helena 2.1 42
Helena 8.1 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.
Helena 2.1 44
45 == 5.3 Metadata Structure Definition ==
46
47 An example is shown below.
48
Helena 6.3 49 [[image:1747384374785-123.png]]
Helena 2.1 50
Helena 8.1 51 **Figure 5: Example MSD showing specification of some Metadata Attributes **
Helena 2.1 52
Helena 8.1 53 This example shows the following [[hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] of Metadata [[Attributes>>doc:xwiki:Glossary.Attribute.WebHome]]:
54
55 * (% style="color:#2ecc71" %)Contact(%%) – this is presentational; no metadata is expected to be reported at this level
56 ** (% style="color:#2ecc71" %)Contact(%%) Name
Helena 3.3 57 ** Address – this is also presentational; up to 3 addresses are allowed
58 *** House Number
Helena 2.1 59
60 == 5.4 Metadata Set ==
61
Helena 8.1 62 An example of reporting metadata according to the [[MSD>>doc:xwiki:Glossary.Metadata structure definition.WebHome]] described above, is shown below.
Helena 2.1 63
Helena 6.4 64 [[image:1747384548140-783.png]]
Helena 2.1 65
Helena 5.1 66 (% class="wikigeneratedid" id="HFigure6:ExampleMetadataSet" %)
67 **Figure 6: Example Metadata Set**
Helena 2.1 68
69 This example shows:
70
Helena 8.1 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)
Helena 2.1 73
74 == 5.5 Reference Metadata in Data Structure Definition and Dataset ==
75
Helena 8.1 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.
Helena 2.1 77
78 This is achieved by the following:
79
Helena 8.1 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]].
Helena 9.2 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”).