Wiki source code of 5 Reference Metadata
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
| |
1.1 | 1 | {{box title="**Contents**"}} |
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| 5 | == 5.1 Scope of the Metadata Structure Definition (MSD) == | ||
| 6 | |||
| |
2.1 | 7 | The scope of the [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] is reduced in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0, by means of simplifying its structure, but also in the way referenced [[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] are targeted. In fact, the [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] is restricted to play the role of a single container, without targeting any specific [[Artefact>>doc:sdmx:Glossary.Artefact.WebHome]]. The possible targets of [[Metadata Set>>doc:sdmx:Glossary.Metadata set.WebHome]] are specified in the [[Metadataflows>>doc:sdmx:Glossary.Metadataflow.WebHome]] or Metadata [[Provision Agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]] relating to that [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. To achieve that, the structure of the [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] has changed in this (% style="color:#e74c3c" %)version(%%) of the standard. Moreover, the Metadata [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] [[Artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is introduced to include this feature. |
| |
1.1 | 8 | |
| |
2.1 | 9 | Two more changes, introduced in this (% style="color:#e74c3c" %)version(%%), are the following: |
| |
1.1 | 10 | |
| |
2.1 | 11 | * The [[Metadata Set>>doc:sdmx:Glossary.Metadata set.WebHome]] becomes a [[Maintainable Artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]] but maintained by a Metadata Provider (another new [[Artefact>>doc:sdmx:Glossary.Artefact.WebHome]] in this (% style="color:#e74c3c" %)version(%%)). |
| 12 | * Metadata [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]] may also be used in [[Data Structure Definitions>>doc:sdmx:Glossary.Data structure definition.WebHome]], as long as the latter reference the [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] that specify those Metadata [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. | ||
| |
1.1 | 13 | |
| |
1.5 | 14 | == 5.2 Identification of the Object(s) to which the Metadata is to be attached == |
| 15 | |||
| |
2.1 | 16 | The following example shows the structure and naming of the [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] and related [[components>>doc:sdmx:Glossary.Component.WebHome]] for creating reference metadata. |
| |
1.1 | 17 | |
| |
2.1 | 18 | The schematic structure of an [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] is shown below. |
| |
1.1 | 19 | |
| 20 | [[image:1749590937079-797.jpeg]] | ||
| 21 | |||
| 22 | **Figure 1: Schematic of the Metadata Structure Definition** | ||
| 23 | |||
| |
2.1 | 24 | The [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] contains one Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Descriptor comprising the Metadata [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]] that identify the (% style="color:#e74c3c" %)Concepts(%%) for which metadata may be reported in the [[Metadata Set>>doc:sdmx:Glossary.Metadata set.WebHome]]. The [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] and Metadata [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] comprise the specification of the objects to which metadata can be reported in a [[Metadata Set>>doc:sdmx:Glossary.Metadata set.WebHome]] (Metadata Target(s)). |
| |
1.1 | 25 | |
| |
2.1 | 26 | The high-(% style="color:#e74c3c" %)level(%%) view of the [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], as well as the way the [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] and Metadata [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] specify the Targets: |
| |
1.1 | 27 | |
| |
3.2 | 28 | [[image:1750062059071-852.png]] |
| |
1.4 | 29 | |
| |
1.1 | 30 | **Figure 2: The high-level view of the MSD containing one Metadata Attribute Descriptor** |
| 31 | |||
| |
3.2 | 32 | [[image:1750062042204-714.png]] |
| |
1.4 | 33 | |
| |
1.1 | 34 | **Figure 3: Wildcarded Target Objects as specified in a Metadataflow** |
| 35 | |||
| |
3.2 | 36 | [[image:1750062017456-979.png]] |
| |
1.4 | 37 | |
| |
1.1 | 38 | **Figure 4: Specific Target Objects as specified in a Metadata Provision Agreement** |
| 39 | |||
| |
2.1 | 40 | Note that the [[SDMX-ML>>doc:sdmx: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:#e74c3c" %)version(%%), and id of the Maintainable Object in which it resides. |
| |
1.1 | 41 | |
| |
1.5 | 42 | == 5.3 Metadata Structure Definition == |
| |
1.1 | 43 | |
| 44 | An example is shown below. | ||
| 45 | |||
| |
3.2 | 46 | [[image:1750061909163-858.png]] |
| |
2.1 | 47 | |
| |
1.1 | 48 | **Figure 5: Example MSD showing specification of some Metadata Attributes** |
| 49 | |||
| |
2.1 | 50 | This example shows the following [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] of Metadata [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]: |
| |
1.1 | 51 | |
| |
2.1 | 52 | * (% style="color:#e74c3c" %)Contact(%%) – this is presentational; no metadata is expected to be reported at this level |
| 53 | * (% style="color:#e74c3c" %)Contact(%%) Name | ||
| |
1.1 | 54 | * Address – this is also presentational; up to 3 addresses are allowed |
| |
1.2 | 55 | ** House Number |
| |
1.1 | 56 | |
| |
1.5 | 57 | == 5.4 Metadata Set == |
| |
1.1 | 58 | |
| |
2.1 | 59 | An example of reporting metadata according to the [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] described above, is shown below. |
| |
1.1 | 60 | |
| |
2.1 | 61 | |
| |
1.3 | 62 | **Figure 6: Example Metadata Set** |
| |
1.1 | 63 | |
| 64 | This example shows: | ||
| 65 | |||
| |
2.1 | 66 | 1. The reference to the Metadata [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] and Metadata Target |
| 67 | 1. The reported metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] (AttributeSet) | ||
| 68 | 1. Reference Metadata in [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] and [[Dataset>>doc:sdmx:Glossary.Data set.WebHome]] | ||
| |
1.1 | 69 | |
| |
2.1 | 70 | An important change of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 is the ability to reference an [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] within a [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]], in order to report any Metadata [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]] defined in the former to [[Datasets>>doc:sdmx:Glossary.Data set.WebHome]] of the latter. |
| |
1.1 | 71 | |
| 72 | This is achieved by the following: | ||
| 73 | |||
| |
2.1 | 74 | * In a [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]], the user may add a reference to one [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. |
| 75 | * In the [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Descriptor of the [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]], the user may include any Metadata [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]] defined in the linked [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. | ||
| 76 | ** For each link to a Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]], an [[Attribute Relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] may be specified (similarly to that for Data [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]). | ||
| 77 | * In any [[Dataset>>doc:sdmx:Glossary.Data set.WebHome]] complying with this [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]], Metadata [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]] may be reported according to the specified [[Attribute Relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]]. | ||
| 78 | ** The [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] of the Metadata [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]] defined in the [[MSD>>doc:sdmx: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:sdmx:Glossary.Data structure definition.WebHome]], via their [[Attribute Relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]]. | ||
| 79 | * In Data (% style="color:#e74c3c" %)Constraints(%%), the user is allowed to restrict values for Metadata [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]], in the same way as Data [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]] (more on this in section “10 (% style="color:#e74c3c" %)Constraints(%%)”). |