Last modified by Helena on 2025/09/10 11:19

From version 1.2
edited by Helena
on 2025/05/21 13:44
Change comment: There is no comment for this version
To version 15.1
edited by Helena
on 2025/07/14 11:34
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -SDMX 2.1 Standards. Section. 5. Registry Specification Logical Interfaces
1 +SDMX 2.1 Standards. Section 5. Registry Specification: Logical Interfaces
Content
... ... @@ -4,10 +4,11 @@
4 4  
5 5  **Revision History**
6 6  
7 -|**Revision**|**Date**|**Contents**
8 -| |April 2011|Initial release
9 -|1.0|July 2011|Rectification of problems of the specifications dated April 2011
10 -|2.0|July 2020|Addition of VTL (Validation and Transformation Language) package, maintainable artefacts, nameable artefacts to 5.2.3, 6.2.2, 6.2.3, 6.2.4, 7.1.1
7 +(% style="width:833.294px" %)
8 +|(% style="width:122px" %)**Revision**|(% style="width:126px" %)**Date**|(% style="width:581px" %)**Contents**
9 +|(% style="width:122px" %) |(% style="width:126px" %)April 2011|(% style="width:581px" %)Initial release
10 +|(% style="width:122px" %)1.0|(% style="width:126px" %)July 2011|(% style="width:581px" %)Rectification of problems of the specifications dated April 2011
11 +|(% style="width:122px" %)2.0|(% style="width:126px" %)July 2020|(% style="width:581px" %)Addition of VTL (Validation and Transformation Language) package, maintainable artefacts, nameable artefacts to 5.2.3, 6.2.2, 6.2.3, 6.2.4, 7.1.1
11 11  
12 12  **Corrigendum**
13 13  
... ... @@ -15,19 +15,19 @@
15 15  
16 16  1. **Problem**
17 17  
18 -Figure 17 - Logical Class Diagram of Registration of Data and Metadata – shows the Provision Agreement as it was identified in version 2.0, and not as it is identified in version 2.1.
19 +Figure 17 - Logical Class Diagram of Registration of Data and Metadata – shows the [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] as it was identified in [[version>>doc:sdmx:Glossary.Version.WebHome]] 2.0, and not as it is identified in [[version>>doc:sdmx:Glossary.Version.WebHome]] 2.1.
19 19  
20 20  **Rectification**
21 21  
22 -Provision Agreement is a Maintainable Artefact at version 2.1 and so the relationship is shown directly to the Provision Agreement class and not indirectly to the Provision Agreement via a ProvisionAgreementRef class.
23 +[[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] is a [[Maintainable Artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]] at [[version>>doc:sdmx:Glossary.Version.WebHome]] 2.1 and so the relationship is shown directly to the [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] class and not indirectly to the [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] via a ProvisionAgreementRef class.
23 23  
24 24  **~1. Problem**
25 25  
26 -Figure 17 - Logical Class Diagram of Registration of Data and Metadata – shows the Registration class without the indexAttributes attribute.
27 +Figure 17 - Logical Class Diagram of Registration of Data and Metadata – shows the Registration class without the indexAttributes [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].
27 27  
28 28  **Rectification**
29 29  
30 -The attribute indexAttribute attribute is added to the Registration class and a description is of its purpose is given in the table at line 916.
31 +The [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indexAttribute [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is added to the Registration class and a description is of its purpose is given in the table at line 916.
31 31  
32 32  **2. Problem**
33 33  
... ... @@ -35,77 +35,77 @@
35 35  
36 36  The reference to AGENCY_SCHEME is changed to AGENCIES.
37 37  
38 -**Adoption of the Validation and Transformation Language in 2020**
39 +**Adoption of the [[Validation and Transformation Language>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] in 2020**
39 39  
40 -The SDMX specifications dated July 2011 envisaged the adoption of a language aimed at defining algorithms for the derivation of the data and presented a basic framework requiring however further elaboration for its actual use.
41 +The [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] specifications dated July 2011 envisaged the adoption of a language aimed at defining algorithms for the derivation of the data and presented a basic framework requiring however further elaboration for its actual use.
41 41  
42 -Following the adoption of the Validation and Transformation Language (VTL) version 2.0 and its application to SDMX 2.1, this section of the SDMX specifications has been integrated by introducing the VTL package, maintainable artefacts, nameable artefacts to the sections 5.2.3, 6.2.2, 6.2.3, 6.2.4 and 7.1.1.
43 +Following the adoption of the [[Validation and Transformation Language>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] ([[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]]) [[version>>doc:sdmx:Glossary.Version.WebHome]] 2.0 and its application to [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 2.1, this section of the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] specifications has been integrated by introducing the [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] package, [[maintainable artefacts>>doc:sdmx:Glossary.Maintainable artefact.WebHome]], [[nameable artefacts>>doc:sdmx:Glossary.Nameable artefact.WebHome]] to the sections 5.2.3, 6.2.2, 6.2.3, 6.2.4 and 7.1.1.
43 43  
44 44  = 1 Introduction =
45 45  
46 -The business vision for SDMX envisages the promotion of a “data sharing” model to facilitate low-cost, high-quality statistical data and metadata exchange. Data sharing reduces the reporting burden of organisations by allowing them to publish data once, and let their counterparties “pull” data and related metadata as required. The scenario is based on:
47 +The business vision for [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] envisages the promotion of a “data sharing” model to facilitate low-cost, high-quality [[statistical data and metadata exchange>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]. Data sharing reduces the reporting burden of organisations by allowing them to publish data once, and let their counterparties “pull” data and related metadata as required. The scenario is based on:
47 47  
48 -* the availability of an abstract information model capable of supporting timeseries and cross-sectional data, structural metadata, and reference metadata (SDMX-IM)
49 -* standardised XML schemas derived from the model (SDMX-ML)
49 +* the availability of an abstract information model capable of supporting timeseries and cross-sectional data, [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]], and [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] ([[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-IM)
50 +* standardised XML schemas derived from the model ([[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-ML)
50 50  * the use of web-services technology (XML, XSD, WSDL, WADL)
51 51  
52 -Such an architecture needs to be well organised, and the SDMX Registry/Repository (SDMX-RR) is tasked with providing structure, organisation, and maintenance and query interfaces for most of the SDMX components required to support the datasharing vision.
53 +Such an architecture needs to be well organised, and the [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]]/Repository ([[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-RR) is tasked with providing structure, organisation, and maintenance and query interfaces for most of the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[components>>doc:sdmx:Glossary.Component.WebHome]] required to support the datasharing vision.
53 53  
54 -However, it is important to emphasis that the SDMX-RR provides support for the submission and retrieval of all SDMX structural metadata and provisioning metadata. Therefore, the Registry not only supports the data sharing scenario, but this metadata is also vital in order to provide support for data and metadata reporting/collection, and dissemination scenarios.
55 +However, it is important to emphasis that the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-RR provides support for the submission and retrieval of all [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] and provisioning metadata. Therefore, the Registry not only supports the data sharing scenario, but this metadata is also vital in order to provide support for data and metadata reporting/collection, and dissemination scenarios.
55 55  
56 -Standard formats for the exchange of aggregated statistical data and metadata as prescribed in SDMX v2.1 are envisaged to bring benefits to the statistical community because data reporting and dissemination processes can be made more efficient.
57 +Standard formats for the exchange of aggregated statistical data and metadata as prescribed in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] v2.1 are envisaged to bring benefits to the statistical community because data reporting and dissemination processes can be made more efficient.
57 57  
58 -As organisations migrate to SDMX enabled systems, many XML (and conventional) artefacts will be produced (e.g. Data Structure, Metadata Structure, Code List and Concept definitions (often collectively called structural metadata), XML schemas generated from data and metadata structure definitions, XSLT style-sheets for transformation and display of data and metadata, terminology references, etc.). The SDMX model supports interoperability, and it is important to be able to discover and share these artefacts between parties in a controlled and organized way.
59 +As organisations migrate to [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] enabled systems, many XML (and conventional) [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] will be produced (e.g. Data Structure, Metadata Structure, [[Code List>>doc:sdmx:Glossary.Code list.WebHome]] and [[Concept>>doc:sdmx:Glossary.Concept.WebHome]] definitions (often collectively called [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]]), XML schemas generated from data and [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], XSLT style-sheets for transformation and display of data and metadata, terminology references, etc.). The [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] model supports interoperability, and it is important to be able to discover and share these [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] between parties in a controlled and organized way.
59 59  
60 60  This is the role of the registry.
61 61  
62 -With the fundamental SDMX standards in place, a set of architectural standards are needed to address some of the processes involved in statistical data and metadata exchange, with an emphasis on maintenance, retrieval and sharing of the structural metadata. In addition, the architectural standards support the registration and discovery of data and referential metadata.
63 +With the fundamental [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] standards in place, a set of architectural standards are needed to address some of the processes involved in [[statistical data and metadata exchange>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]], with an emphasis on maintenance, retrieval and sharing of the [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]]. In addition, the architectural standards support the registration and discovery of data and referential metadata.
63 63  
64 -These architectural standards address the ‘how’ rather than the ‘what’, and are aimed at enabling existing SDMX standards to achieve their mission. The architectural standards address registry services which initially comprise:
65 +These architectural standards address the ‘how’ rather than the ‘what’, and are aimed at enabling existing [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] standards to achieve their mission. The architectural standards address registry services which initially comprise:
65 65  
66 -* structural metadata repository
67 +* [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository
67 67  * data and metadata registration
68 68  * query
69 69  
70 -The registry services outlined in this specification are designed to help the SDMX community manage the proliferation of SDMX assets and to support data sharing for reporting and dissemination.
71 +The registry services outlined in this specification are designed to help the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] community manage the proliferation of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] assets and to support data sharing for reporting and dissemination.
71 71  
72 72  = 2 Scope and Normative Status =
73 73  
74 -The scope of this document is to specify the logical interfaces for the SDMX registry in terms of the functions required and the data that may be present in the function call, and the behaviour expected of the registry.
75 +The scope of this document is to specify the logical interfaces for the [[SDMX registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] in terms of the functions required and the data that may be present in the function call, and the behaviour expected of the registry.
75 75  
76 76  In this document, functions and behaviours of the Registry Interfaces are described in four ways:
77 77  
78 78  * in text
79 79  * with tables
80 -* with UML diagrams excerpted from the SDMX Information Model (SDMX-IM)
81 -* with UML diagrams that are not a part of the SDMX-IM but are included here for clarity and to aid implementations (these diagram are clearly marked as “Logical Class Diagram ...”)
81 +* with UML diagrams excerpted from the [[SDMX Information Model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]] ([[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]])
82 +* with UML diagrams that are not a part of the [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]] but are included here for clarity and to aid implementations (these diagram are clearly marked as “Logical Class Diagram ...”)
82 82  
83 83  Whilst the introductory section contains some information on the role of the registry, it is assumed that the reader is familiar with the uses of a registry in providing shared metadata across a community of counterparties.
84 84  
85 -Note that sections 5 and 6 contain normative rules regarding the Registry Interface and the identification of registry objects. Further, the minimum standard for access to the registry is via a REST interface (HTTP or HTTPS), as described in the appropriate sections. The notification mechanism must support e-mail and HTTP/HTTPS protocols as described. Normative registry interfaces are specified in the SDMX-ML specification (Part 03 of the SDMX Standard). All other sections of this document are informative.
86 +Note that sections 5 and 6 contain normative rules regarding the Registry Interface and the identification of registry objects. Further, the minimum standard for access to the registry is via a REST interface (HTTP or HTTPS), as described in the appropriate sections. The [[notification>>doc:sdmx:Glossary.Notification.WebHome]] mechanism must support e-mail and HTTP/HTTPS protocols as described. Normative registry interfaces are specified in the [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] specification (Part 03 of the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Standard). All other sections of this document are informative.
86 86  
87 -Note that although the term “authorised user” is used in this document, the SDMX standards do not define an access control mechanism. Such a mechanism, if required, must be chosen and implemented by the registry software provider.
88 +Note that although the term “authorised user” is used in this document, the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] standards do not define an access control mechanism. Such a mechanism, if required, must be chosen and implemented by the registry software provider.
88 88  
89 89  = 3 Scope of the SDMX Registry/Repository =
90 90  
91 91  == 3.1 Objective ==
92 92  
93 -The objective of the SDMX registry/repository is, in broad terms, to allow organisations to publish statistical data and reference metadata in known formats such that interested third parties can discover these data and interpret them accurately and correctly. The mechanism for doing this is twofold:
94 +The objective of the [[SDMX registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]]/repository is, in broad terms, to allow organisations to publish statistical data and [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] in known formats such that interested third parties can discover these data and interpret them accurately and correctly. The mechanism for doing this is twofold:
94 94  
95 -1. To maintain and publish structural metadata that describes the structure and valid content of data and reference metadata sources such as databases, metadata repositories, data sets, metadata sets. This structural metadata enables software applications to understand and to interpret the data and reference metadata in these sources.
96 -1. To enable applications, organisations, and individuals to share and to discover data and reference metadata. This facilitates data and reference metadata dissemination by implementing the data sharing vision of SDMX.
96 +1. To maintain and publish [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] that describes the structure and valid content of data and [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] sources such as databases, [[metadata repositories>>doc:sdmx:Glossary.Metadata repository.WebHome]], [[data sets>>doc:sdmx:Glossary.Data set.WebHome]], [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]]. This [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] enables software applications to understand and to interpret the data and [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] in these sources.
97 +1. To enable applications, organisations, and individuals to share and to discover data and [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]]. This facilitates data and [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] dissemination by implementing the data sharing vision of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]].
97 97  
98 98  == 3.2 Structural Metadata ==
99 99  
100 -Setting up structural metadata and the exchange context (referred to as “data provisioning”) involves the following steps for maintenance agencies:
101 +Setting up [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] and the exchange context (referred to as “data provisioning”) involves the following steps for [[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]]:
101 101  
102 -* agreeing and creating a specification of the structure of the data (called a Data Structure Definition or DSD in this document but also known as “key family”) which defines the dimensions, measures and attributes of a dataset and their valid value set
103 -* if required, defining a subset or view of a DSD which allows some restriction of content called a “dataflow definition”
104 -* agreeing and creating a specification of the structure of reference metadata (Metadata Structure Definition) which defines the attributes and presentational arrangement of a Metadataset and their valid values and content
105 -* if required, defining a subset or view of a MSD which allows some restriction of content called a “metadataflow definition”
106 -* defining which subject matter domains (specified as a Category Scheme) are related to the Dataflow and Metadataflow Definitions to enable browsing
107 -* defining one or more lists of Data Providers (which includes metadata providers)
108 -* defining which Data Providers have agreed to publish a given Dataflow and/or Metadataflow Definition - this is called a Provision Agreement
103 +* agreeing and creating a specification of the structure of the data (called a [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] or [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] in this document but also known as “key family”) which defines the [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]], [[measures>>doc:sdmx:Glossary.Measure.WebHome]] and [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] of a [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] and their valid value set
104 +* if required, defining a subset or view of a [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] which allows some restriction of content called a “[[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] definition”
105 +* agreeing and creating a specification of the structure of [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] ([[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]) which defines the [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] and presentational arrangement of a Metadataset and their valid values and content
106 +* if required, defining a subset or view of a [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] which allows some restriction of content called a “[[metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] definition”
107 +* defining which subject matter domains (specified as a [[Category Scheme>>doc:sdmx:Glossary.Category scheme.WebHome]]) are related to the [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] and [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] Definitions to enable browsing
108 +* defining one or more lists of [[Data Providers>>doc:sdmx:Glossary.Data provider.WebHome]] (which includes metadata providers)
109 +* defining which [[Data Providers>>doc:sdmx:Glossary.Data provider.WebHome]] have agreed to publish a given [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] and/or [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] Definition - this is called a [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]]
109 109  
110 110  [[image:1747824122996-812.jpeg]]
111 111  
... ... @@ -113,10 +113,10 @@
113 113  
114 114  == 3.3 Registration ==
115 115  
116 -Publishing the data and reference metadata involves the following steps for a Data Provider:
117 +Publishing the data and [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] involves the following steps for a [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]]:
117 117  
118 -* making the reference metadata and data available in SDMX-ML conformant data files or databases (which respond to an SDMX-ML query with SDMX-ML data). The data and reference metadata files or databases must be webaccessible, and must conform to an agreed Dataflow or Metadataflow Definition (Data Structure Definition or Metadata Structure Definition subset)
119 -* registering the existence of published reference metadata and data files or databases with one or more SDMX registries
119 +* making the [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] and data available in [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] conformant data files or databases (which respond to an [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] query with [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] data). The data and [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] files or databases must be webaccessible, and must conform to an agreed [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] or [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] Definition ([[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] or [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] subset)
120 +* registering the existence of published [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] and data files or databases with one or more [[SDMX registries>>doc:sdmx:Glossary.SDMX Registry.WebHome]]
120 120  
121 121  [[image:1747824123003-199.jpeg]]
122 122  
... ... @@ -124,17 +124,17 @@
124 124  
125 125  == 3.4 Notification ==
126 126  
127 -Notifying interested parties of newly published or re-published data, reference metadata or changes in structural metadata involves:
128 +Notifying interested parties of newly published or re-published data, [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] or changes in [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] involves:
128 128  
129 -* registry support of a subscription-based notification service which sends an email or notifies an HTTP address announcing all published data that meets the criteria contained in the subscription request
130 +* registry support of a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]-based [[notification>>doc:sdmx:Glossary.Notification.WebHome]] service which sends an email or notifies an HTTP address announcing all published data that meets the criteria contained in the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request
130 130  
131 131  == 3.5 Discovery ==
132 132  
133 -Discovering published data and reference metadata involves interaction with the registry to fulfil the following logical steps that would be carried out by a user interacting with a service that itself interacts with the registry and an SDMX-enabled data or reference metadata resource:
134 +Discovering published data and [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] involves interaction with the registry to fulfil the following logical steps that would be carried out by a user interacting with a service that itself interacts with the registry and an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-enabled data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] resource:
134 134  
135 -* optionally browsing a subject matter domain category scheme to find Dataflow Definitions (and hence Data Structure Definitions) and Metadataflows which structure the type of data and/or reference metadata being sought
136 -* build a query, in terms of the selected Data Structure Definition or Metadata Structure Definition, which specifies what data are required and submitting this to a service that can query an SDMX registry which will return a list of (URLs of) data and reference metadata files and databases which satisfy the query
137 -* processing the query result set and retrieving data and/or reference metadata from the supplied URLs
136 +* optionally browsing a subject matter domain [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] to find [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] Definitions (and hence [[Data Structure Definitions>>doc:sdmx:Glossary.Data structure definition.WebHome]]) and [[Metadataflows>>doc:sdmx:Glossary.Metadataflow.WebHome]] which structure the type of data and/or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] being sought
137 +* build a query, in terms of the selected [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] or [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], which specifies what data are required and submitting this to a service that can query an [[SDMX registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] which will return a list of (URLs of) data and [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] files and databases which satisfy the query
138 +* processing the query result set and retrieving data and/or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] from the supplied URLs
138 138  
139 139  [[image:1747824123006-476.jpeg]]
140 140  
... ... @@ -144,7 +144,7 @@
144 144  
145 145  == 4.1 Architectural Schematic ==
146 146  
147 -The architecture of the SDMX registry/repository is derived from the objectives stated above. It is a layered architecture that is founded by a structural metadata repository which supports a provisioning metadata repository which supports the registry services. These are all supported by the SDMX-ML schemas. Applications can be built on top of these services which support the reporting, storage, retrieval, and dissemination aspects of the statistical lifecycle as well as the maintenance of the structural metadata required to drive these applications.
148 +The architecture of the [[SDMX registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]]/repository is derived from the objectives stated above. It is a layered architecture that is founded by a [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository which supports a provisioning [[metadata repository>>doc:sdmx:Glossary.Metadata repository.WebHome]] which supports the registry services. These are all supported by the [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] schemas. Applications can be built on top of these services which support the reporting, storage, retrieval, and dissemination aspects of the statistical lifecycle as well as the maintenance of the [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] required to drive these applications.
148 148  
149 149  [[image:1747824123008-995.jpeg]]
150 150  
... ... @@ -152,18 +152,18 @@
152 152  
153 153  == 4.2 Structural Metadata Repository ==
154 154  
155 -The basic layer is that of a structural metadata service which supports the lifecycle of SDMX structural metadata artefacts such as Maintenance Agencies, Data Structure Definitions, Metadata Structure Definitions, Provision Agreements, Processes etc. This layer is supported by the Structure Submission and Query Service.
156 +The basic layer is that of a [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] service which supports the lifecycle of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] such as [[Maintenance Agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]], [[Data Structure Definitions>>doc:sdmx:Glossary.Data structure definition.WebHome]], [[Metadata Structure Definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], [[Provision Agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]], Processes etc. This layer is supported by the Structure Submission and Query Service.
156 156  
157 -Note that the SDMX-ML Submit Structure Request message supports all of the SDMX structural artefacts. The only structural artefacts that are not supported by the SDMX-ML Submit Structure Request are::
158 +Note that the [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] Submit Structure Request message supports all of the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] structural [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]. The only structural [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] that are not supported by the [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] Submit Structure Request are::
158 158  
159 159  * Registration of data and metadata sources
160 160  * Subscription and Notification
161 161  
162 -Separate registry-based messages are defined to support these artefacts.
163 +Separate registry-based messages are defined to support these [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]].
163 163  
164 164  == 4.3 Provisioning Metadata Repository ==
165 165  
166 -The function of this repository is to support the definition of the structural metadata that describes the various types of data-store which model SDMX-conformant databases or files, and to link to these data sources. These links can be specified for a data provider, for a specific data or metadata flow. In the SDMX model this is called the Provision Agreement.
167 +The function of this repository is to support the definition of the [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] that describes the various types of data-store which model [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-conformant databases or files, and to link to these [[data sources>>doc:sdmx:Glossary.Data source.WebHome]]. These links can be specified for a [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]], for a specific data or [[metadata flow>>doc:sdmx:Glossary.Metadataflow.WebHome]]. In the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] model this is called the Provision Agreement.
167 167  
168 168  This layer is supported by the Data and Metadata Registration Service.
169 169  
... ... @@ -174,27 +174,27 @@
174 174  The Registry Interfaces are:
175 175  
176 176  * Notify Registry Event
177 -* Submit Subscription Request
178 -* Submit Subscription Response
178 +* Submit [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] Request
179 +* Submit [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] Response
179 179  * Submit Registration Request
180 180  * Submit Registration Response
181 181  * Query Registration Request
182 182  * Query Registration Response
183 -* Query Subscription Request
184 -* Query Subscription Response
184 +* Query [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] Request
185 +* Query [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] Response
185 185  * Submit Structure Request
186 186  * Submit Structure Response
187 187  
188 188  The registry interfaces are invoked in one of two ways:
189 189  
190 -1. The interface is the name of the root node of the SDMX-ML document
191 -1. The interface is invoked as a child element of the RegistryInterface message where the RegistryInterface is the root node of the SDMX-ML document.
191 +1. The interface is the name of the root node of the [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] document
192 +1. The interface is invoked as a child element of the RegistryInterface message where the RegistryInterface is the root node of the [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] document.
192 192  
193 -In addition to these interfaces the registry must support a mechanism for querying for structural metadata. This is detailed in 5.2.2.
194 +In addition to these interfaces the registry must support a mechanism for querying for [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]]. This is detailed in 5.2.2.
194 194  
195 -All these interactions with the Registry – with the exception of Notify Registry Event – are designed in pairs. The first document – the one which invokes the SDMX-RR interface, is a “Request” document. The message returned by the interface is a “Response” document.
196 +All these interactions with the Registry – with the exception of Notify Registry Event – are designed in pairs. The first document – the one which invokes the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-RR interface, is a “Request” document. The message returned by the interface is a “Response” document.
196 196  
197 -It should be noted that all interactions are assumed to be synchronous, with the exception of Notify Registry Event. This document is sent by the SDMX-RR to all subscribers whenever an even occurs to which any users have subscribed. Thus, it does not conform to the request-response pattern, because it is inherently asynchronous.
198 +It should be noted that all interactions are assumed to be synchronous, with the exception of Notify Registry Event. This document is sent by the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-RR to all subscribers whenever an even occurs to which any users have subscribed. Thus, it does not conform to the request-response pattern, because it is inherently asynchronous.
198 198  
199 199  == 5.2 Registry Services ==
200 200  
... ... @@ -204,45 +204,45 @@
204 204  
205 205  === 5.2.2 Structure Submission and Query Service ===
206 206  
207 -This service must implement the following SDMX-ML Interfaces:
208 +This service must implement the following [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] Interfaces:
208 208  
209 209  * SubmitStructureRequest
210 210  * SubmitStructureResponse
211 211  
212 -These interfaces allow structural definitions to be created, modified, and removed in a controlled fashion. It also allows the structural metadata artefacts to be queried and retrieved either in part or as a whole. In order for the architecture to be scalable, the finest-grained piece of structural metadata that can be processed by the SDMX-RR is a MaintainableArtefact (see next section on the SDMX Information Model).
213 +These interfaces allow structural definitions to be created, modified, and removed in a controlled fashion. It also allows the [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] to be queried and retrieved either in part or as a whole. In order for the architecture to be scalable, the finest-grained piece of [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] that can be processed by the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-RR is a MaintainableArtefact (see next section on the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Information Model).
213 213  
214 214  === 5.2.3 Structure Query Service ===
215 215  
216 -The registry must support a mechanism for querying for structural metadata. This mechanism can be one or both of the SDMX-ML Query message and the SDMX REST interface for structural metadata (this is defined in Part 7 of the SDMX standards). The registry response to both of these query mechanisms is the SDMX Structure message which has as its root node
217 +The registry must support a mechanism for querying for [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]]. This mechanism can be one or both of the [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] Query message and the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] REST interface for [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] (this is defined in Part 7 of the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] standards). The registry response to both of these query mechanisms is the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Structure message which has as its root node
217 217  
218 218  * Structure
219 219  
220 -The SDMX structural artefacts that may be queried are:
221 +The [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] structural [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] that may be queried are:
221 221  
222 -* dataflows and metadataflows
223 -* data structure definitions and metadata structure definitions
223 +* [[dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]] and metadataflows
224 +* [[data structure definitions>>doc:sdmx:Glossary.Data structure definition.WebHome]] and [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]
224 224  * codelists
225 -* concept schemes
226 +* [[concept>>doc:sdmx:Glossary.Concept.WebHome]] schemes
226 226  * reporting taxonomies
227 -* provision agreements
228 +* [[provision agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]]
228 228  * structure sets
229 229  * processes
230 230  * hierarchical code lists
231 -* constraints
232 +* [[constraints>>doc:sdmx:Glossary.Constraint.WebHome]]
232 232  * category schemes
233 -* categorisations and categorised objects (examples are categorised dataflows and metadatflows, data structure definitions, metadata structure definitions, provision agreements registered data sources and metadata sources)
234 -* organisation schemes (agency scheme, data provider scheme, data consumer scheme, organisation unit scheme)
234 +* categorisations and categorised objects (examples are categorised [[dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]] and metadatflows, [[data structure definitions>>doc:sdmx:Glossary.Data structure definition.WebHome]], [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], [[provision agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]] registered [[data sources>>doc:sdmx:Glossary.Data source.WebHome]] and metadata sources)
235 +* organisation schemes ([[agency scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]], [[data provider scheme>>doc:sdmx:Glossary.Data provider scheme.WebHome]], [[data consumer scheme>>doc:sdmx:Glossary.Data consumer scheme.WebHome]], organisation unit scheme)
235 235  
236 -Due to the VTL implementation the other structural artefact that may be queried are:
237 +Due to the [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] implementation the other structural [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] that may be queried are:
237 237  
238 238  * transformation schemes
239 239  * custom type schemes
240 240  * name personalisation schemes
241 -* vtl mapping schemes
242 +* [[vtl>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] mapping schemes
242 242  * ruleset schemes
243 243  * user defined operator schemes
244 244  
245 -The SDMX query messages that are a part of the SDMX-ML Query message are:
246 +The [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] query messages that are a part of the [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] Query message are:
246 246  
247 247  * StructuresQuery
248 248  * DataflowQuery
... ... @@ -261,7 +261,7 @@
261 261  * ProvisionAgreementQuery
262 262  * ConstraintQuery
263 263  
264 -Due to the VTL implementation the other query messages that became a part of the SDMX-ML Query message are:
265 +Due to the [[VTL>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] implementation the other query messages that became a part of the [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] Query message are:
265 265  
266 266  * TransformationSchemeQuery
267 267  * CustomTypeSchemeQuery
... ... @@ -272,7 +272,7 @@
272 272  
273 273  === 5.2.4 Data and Reference Metadata Registration Service ===
274 274  
275 -This service must implement the following SDMX-ML Interfaces:
276 +This service must implement the following [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] Interfaces:
276 276  
277 277  * SubmitRegistrationRequest
278 278  * SubmitRegistrationResponse
... ... @@ -279,78 +279,69 @@
279 279  * QueryRegistrationRequest
280 280  * QueryRegistrationResponse
281 281  
282 -The Data and Metadata Registration Service allows SDMX conformant XML files and web-accessible databases containing published data and reference metadata to be registered in the SDMX Registry. The registration process MAY validate the content of the data-sets or metadata-sets, and MAY extract a concise representation of the contents in terms of concept values (e.g. values of the data attribute, dimension, metadata attribute), or entire keys, and storing this as a record in the registry to enable discovery of the original data-set or metadata-set. These are called Constraints in the SDMX-IM.
283 +The Data and Metadata Registration Service allows [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] conformant XML files and web-accessible databases containing published data and [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] to be registered in the [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]]. The registration process MAY validate the content of the data-sets or metadata-sets, and MAY extract a concise [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the contents in terms of [[concept>>doc:sdmx:Glossary.Concept.WebHome]] values (e.g. values of the data [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]), or entire keys, and storing this as a record in the registry to enable discovery of the original data-set or metadata-set. These are called [[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]] in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-IM.
283 283  
284 284  The Data and Metadata Registration Service MAY validate the following, subject to the access control mechanism implemented in the Registry:
285 285  
286 -* that the data provider is allowed to register the data-set or metadata-set
287 -* that the content of the data set or metadata set meets the validation constraints. This is dependent upon such constraints being defined in the structural repository and which reference the relevant Dataflow, Metadataflow, Data Provider, Data Structure Definition, Metadata Structure Definition, Provision Agreement
288 -* that a queryable data source exists - this would necessitate the registration service querying the service to determine its existence
289 -* that a simple data source exists (i.e. a file accessible at a URL)
290 -* that the correct Data Structure Definition or Metadata Structure Definition is used by the registered data that the components (Dimensions, Attributes, Measures, Identifier Components etc.) are consistent with the Data Structure Definition or Metadata Structure Definition
291 -* that the valid representations of the concepts to which these components 382 correspond conform to the definition in the Data Structure Definition or Metadata Structure Definition
287 +* that the [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] is allowed to register the data-set or metadata-set
288 +* that the content of the [[data set>>doc:sdmx:Glossary.Data set.WebHome]] or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] meets the validation [[constraints>>doc:sdmx:Glossary.Constraint.WebHome]]. This is dependent upon such [[constraints>>doc:sdmx:Glossary.Constraint.WebHome]] being defined in the structural repository and which reference the relevant [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]], [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]], [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], Provision Agreement
289 +* that a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] exists - this would necessitate the registration service querying the service to determine its existence
290 +* that a simple [[data source>>doc:sdmx:Glossary.Data source.WebHome]] exists (i.e. a file accessible at a URL)
291 +* that the correct [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] or [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] is used by the registered data that the [[components>>doc:sdmx:Glossary.Component.WebHome]] ([[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]], [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]], [[Measures>>doc:sdmx:Glossary.Measure.WebHome]], Identifier [[Components>>doc:sdmx:Glossary.Component.WebHome]] etc.) are consistent with the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] or [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]
292 +* that the valid [[representations>>doc:sdmx:Glossary.Representation.WebHome]] of the [[concepts>>doc:sdmx:Glossary.Concept.WebHome]] to which these [[components>>doc:sdmx:Glossary.Component.WebHome]] correspond conform to the definition in the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] or [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]
292 292  
293 -3The Registration has an action attribute which takes one of the following values:
294 +The Registration has an action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] which takes one of the following values:
294 294  
295 -|(((
296 -**Action**
296 +|(% style="width:219px" %)**Action [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Value**|(% style="width:1652px" %)**Behaviour**
297 +|(% style="width:219px" %)Append|(% style="width:1652px" %)Add this registration to the registry
298 +|(% style="width:219px" %)Replace|(% style="width:1652px" %)Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request
299 +|(% style="width:219px" %)Delete|(% style="width:1652px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
297 297  
298 -**Attribute Value**
299 -)))|**Behaviour**
300 -|Append|Add this registration to the registry
301 -|Replace|Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request
302 -|Delete|Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
301 +The Registration has three Boolean [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which may be present to determine how an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] compliant [[Dataset>>doc:sdmx:Glossary.Data set.WebHome]] or [[Metadata Set>>doc:sdmx:Glossary.Metadata set.WebHome]] indexing application must index the [[Datasets>>doc:sdmx:Glossary.Data set.WebHome]] or [[Metadata Set>>doc:sdmx:Glossary.Metadata set.WebHome]] upon registration. The indexing application behaviour is as follows:
303 303  
304 -The Registration has three Boolean attributes which may be present to determine how an SDMX compliant Dataset or Metadata Set indexing application must index the Datasets or Metadata Set upon registration. The indexing application behaviour is as follows:
303 +|(% style="width:228px" %)**Boolean [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]**|(% style="width:1644px" %)**Behaviour if Value is “true”**
304 +|(% style="width:228px" %)indexTimeSeries|(% style="width:1644px" %)A compliant indexing application must index all the time [[series keys>>doc:sdmx:Glossary.Series key.WebHome]] (for a [[Dataset>>doc:sdmx:Glossary.Data set.WebHome]] registration) or metadata target values (for a [[Metadata Set>>doc:sdmx:Glossary.Metadata set.WebHome]] registration)
305 +|(% style="width:228px" %)indexDataSet|(% style="width:1644px" %)A compliant indexing application must index the range of actual (present) values for each [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] of the [[Dataset>>doc:sdmx:Glossary.Data set.WebHome]] (for a [[Dataset>>doc:sdmx:Glossary.Data set.WebHome]] registration) or the range of actual (present) values for each Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] which takes an enumerated value.
306 +Note that for data this requires much less storage than full key indexing, but this method cannot guarantee that a specific combination of [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values (the Key) is actually present in the [[Dataset>>doc:sdmx:Glossary.Data set.WebHome]]
307 +|(% style="width:228px" %)indexReportingPeriod|(% style="width:1644px" %)A compliant indexing application must index the [[time period>>doc:sdmx:Glossary.Time period.WebHome]] range(s) for which data are present in the [[Dataset>>doc:sdmx:Glossary.Data set.WebHome]] or [[Metadata Set>>doc:sdmx:Glossary.Metadata set.WebHome]]
305 305  
306 -|**Boolean Attribute**|**Behaviour if Value is “true”**
307 -|indexTimeSeries|A compliant indexing application must index all the time series keys (for a Dataset registration) or metadata target values (for a Metadata Set registration)
308 -|indexDataSet|(((
309 -A compliant indexing application must index the range of actual (present) values for each dimension of the Dataset (for a Dataset registration) or the range of actual (present) values for each Metadata Attribute which takes an enumerated value.
310 -
311 -Note that for data this requires much less storage than full key indexing, but this method cannot guarantee that a specific combination of Dimension values (the Key) is actually present in the Dataset
312 -)))
313 -|indexReportingPeriod|A compliant indexing application must index the time period range(s) for which data are present in the Dataset or Metadata Set
314 -
315 315  === 5.2.5 Data and Reference Metadata Discovery ===
316 316  
317 317  The Data and Metadata Discovery Service implements the following Registry Interfaces:
318 318  
319 - QueryRegistrationRequest
313 +* QueryRegistrationRequest
314 +* QueryRegistrationResponse
320 320  
321 - QueryRegistrationResponse
322 -
323 323  === 5.2.6 Subscription and Notification ===
324 324  
325 -The Subscription and Notification Service implements the following Registry Interfaces:
318 +The [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] and [[Notification>>doc:sdmx:Glossary.Notification.WebHome]] Service implements the following Registry Interfaces:
326 326  
327 327  * SubmitSubscriptionRequest
328 328  * SubmitSubscriptionResponse
329 329  * NotifyRegistryEvent
330 330  
331 -The data sharing paradigm relies upon the consumers of data and metadata being able to pull information from data providers’ dissemination systems. For this to work efficiently, a data consumer needs to know when to pull data, i.e. when something has changed in the registry (e.g. a dataset has been updated and re-registered). Additionally, SDMX systems may also want to know if a new Data Structure Definition, Code List or Metadata Structure Definition has been added. The Subscription and Notification Service comprises two parts: subscription management, and notification.
324 +The data sharing paradigm relies upon the consumers of data and metadata being able to pull information from [[data providers>>doc:sdmx:Glossary.Data provider.WebHome]]’ dissemination systems. For this to work efficiently, a [[data consumer>>doc:sdmx:Glossary.Data consumer.WebHome]] needs to know when to pull data, i.e. when something has changed in the registry (e.g. a [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] has been updated and re-registered). Additionally, [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] systems may also want to know if a new [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], [[Code List>>doc:sdmx:Glossary.Code list.WebHome]] or [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] has been added. The [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] and [[Notification>>doc:sdmx:Glossary.Notification.WebHome]] Service comprises two parts: [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] management, and [[notification>>doc:sdmx:Glossary.Notification.WebHome]].
332 332  
333 -Subscription management involves a user submitting a subscription request which contains:
326 +[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] management involves a user submitting a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request which contains:
334 334  
335 -* a query or constraint expression in terms of a filter which defines the events for which the user is interested (e.g. new data for a specific dataflow, or for a domain category, or changes to a Data Structure Definition).
336 -* a list of URIs or end-points to which an XML notification message can be sent. Supported end-point types will be email (mailto~:) and HTTP POST (a normal http:~/~/ address)
328 +* a query or [[constraint>>doc:sdmx:Glossary.Constraint.WebHome]] expression in terms of a filter which defines the events for which the user is interested (e.g. new data for a specific [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], or for a domain [[category>>doc:sdmx:Glossary.Category.WebHome]], or changes to a [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]).
329 +* a list of URIs or end-points to which an XML [[notification>>doc:sdmx:Glossary.Notification.WebHome]] message can be sent. Supported end-point types will be email (mailto : ) and HTTP POST (a normal http:~/~/ address)
337 337  * request for a list of submitted subscriptions
338 -* deletion of a subscription
331 +* deletion of a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]
339 339  
340 -Notification requires that the structural metadata repository and the provisioning metadata repository monitor any event which is of interest to a user (the object of a subscription request query), and to issue an SDMX-ML notification document to the end-points specified in the relevant subscriptions.
333 +[[Notification>>doc:sdmx:Glossary.Notification.WebHome]] requires that the [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository and the provisioning [[metadata repository>>doc:sdmx:Glossary.Metadata repository.WebHome]] monitor any event which is of interest to a user (the object of a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request query), and to issue an [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] [[notification>>doc:sdmx:Glossary.Notification.WebHome]] document to the end-points specified in the relevant subscriptions.
341 341  
342 342  === 5.2.7 Registry Behaviour ===
343 343  
344 -The following table defines the behaviour of the SDMX Registry for the various Registry Interface messages.
337 +The following table defines the behaviour of the [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] for the various Registry Interface messages.
345 345  
346 -|**Interface**|**Behaviour**
347 -|All|(((
348 -1) If the action is set to “replace” then the entire contents of the existing maintainable object in the Registry MUST be replaced by the object submitted, unless the final attribute is set to “true” in which case the only changes that are allowed are to the following constructs:
339 +|(% style="width:227px" %)**Interface**|(% style="width:1644px" %)**Behaviour**
340 +|(% style="width:227px" %)All|(% style="width:1644px" %)(((
341 +1) If the action is set to “replace” then the entire contents of the existing maintainable object in the Registry MUST be replaced by the object submitted, unless the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is set to “true” in which case the only changes that are allowed are to the following constructs:
349 349  
350 -* Name – this applies to the Maintainable object and its contained elements, such a Code in a Code list.
351 -* Description - this applies to the Maintainable object and its contained elements, such a Code in a Code list.
352 -
353 -* Annotation - this applies to the Maintainable object and its contained elements, such a Code in a Code list.
343 +* Name – this applies to the Maintainable object and its contained elements, such a [[Code>>doc:sdmx:Glossary.Code.WebHome]] in a [[Code list>>doc:sdmx:Glossary.Code list.WebHome]].
344 +* Description - this applies to the Maintainable object and its contained elements, such a [[Code>>doc:sdmx:Glossary.Code.WebHome]] in a [[Code list>>doc:sdmx:Glossary.Code list.WebHome]].
345 +* Annotation - this applies to the Maintainable object and its contained elements, such a [[Code>>doc:sdmx:Glossary.Code.WebHome]] in a [[Code list>>doc:sdmx:Glossary.Code list.WebHome]].
354 354  * validTo
355 355  * validFrom
356 356  * structureURL
... ... @@ -358,43 +358,40 @@
358 358  * uri
359 359  * isExternalReference
360 360  
361 -1. Cross referenced structures MUST exist in either the submitted document (in Structures or Structure Location) or in the registry to which the request is submitted.
362 -1. If the action is set to “delete” then the Registry MUST verify that the object can deleted. In order to qualify for deletion the object must:
353 +2) Cross referenced structures MUST exist in either the submitted document (in Structures or Structure Location) or in the registry to which the request is submitted.
354 +3) If the action is set to “delete” then the Registry MUST verify that the object can deleted. In order to qualify for deletion the object must:
363 363  
364 -1. Not have the final attribute set to “true”
365 -1. Not be referenced from any other object in the Registry.
356 +а) Not have the final [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] set to “true”
357 +b) Not be referenced from any other object in the Registry.
366 366  
367 -1. The version rules in the SDMX Schema documentation MUST be obeyed.
368 -
369 -* The specific rules for the elements and attributes documented in the SDMX Schema MUST be obeyed.
359 +4) The [[version>>doc:sdmx:Glossary.Version.WebHome]] rules in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Schema documentation MUST be obeyed.
360 +5) The specific rules for the elements and [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] documented in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Schema MUST be obeyed.
370 370  )))
371 -|SubmitStructureRequest|Structures are submitted at the level of the Maintainable Artefact and the behaviour in “All” above is therefore at the level of the Maintainable Artefact.
372 -|SubmitProvisioningRequest|No additional behaviour.
373 -|Submit Registration Request|(((
374 -If the datasource is a file (simple datasource) then the file MAY be retrieved and indexed according to the Boolean attributes set in the Registration.
375 -
376 -For a queryable datasource the Registry MAY validate that the source exists and can accept an SDMX-ML data query.
362 +|(% style="width:227px" %)SubmitStructureRequest|(% style="width:1644px" %)Structures are submitted at the [[level>>doc:sdmx:Glossary.Level.WebHome]] of the [[Maintainable Artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]] and the behaviour in “All” above is therefore at the [[level>>doc:sdmx:Glossary.Level.WebHome]] of the [[Maintainable Artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]].
363 +|(% style="width:227px" %)SubmitProvisioningRequest|(% style="width:1644px" %)No additional behaviour.
364 +|(% style="width:227px" %)Submit Registration Request|(% style="width:1644px" %)(((
365 +If the datasource is a file (simple datasource) then the file MAY be retrieved and indexed according to the Boolean [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] set in the Registration.
366 +For a queryable datasource the Registry MAY validate that the source exists and can accept an [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] data query.
377 377  )))
378 378  
379 -
380 -
381 381  = 6 Identification of SDMX Objects =
382 382  
383 383  == 6.1 Identification, Versioning, and Maintenance ==
384 384  
385 -All major classes of the SDMX Information model inherit from one of:
373 +All major classes of the [[SDMX Information model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]] inherit from one of:
386 386  
387 -
388 388  * **IdentifiableArtefact** - this gives an object the ability to be uniquely identified (see following section on identification), to have a user-defined URI, and to have multi-lingual annotations.
389 389  * **NamableArtefact **- this has all of the features of IdentifiableArtefact plus the ability to have a multi-lingual name and description,
390 -* **VersionableArtefact **– this has all of the above features plus a version number and a validity period.
391 -* **MaintainableArtefact** – this has all of the above features, and indication as to whether the object is “final” and cannot be changed or deleted, registry and structure URIs, plus an association to the maintenance agency of the object.
377 +* **VersionableArtefact **– this has all of the above features plus a [[version>>doc:sdmx:Glossary.Version.WebHome]] number and a validity period.
378 +* **MaintainableArtefact** – this has all of the above features, and indication as to whether the object is “final” and cannot be changed or deleted, registry and structure URIs, plus an association to the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] of the object.
392 392  
393 393  === 6.1.1 Identification, Naming, Versioning, and Maintenance Model ===
394 394  
382 +[[image:1747824504225-229.png]]
383 +
395 395  **Figure 5: Class diagram of fundamental artefacts in the SDMX-IM**
396 396  
397 -The table below shows the identification and related data attributes to be stored in a registry for objects that are one of:
386 +The table below shows the identification and related data [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] to be stored in a registry for objects that are one of:
398 398  
399 399  * Annotable
400 400  * Identifiable
... ... @@ -402,60 +402,58 @@
402 402  * Versionable
403 403  * Maintainable
404 404  
405 -|**Object Type**|**Data Attributes**|**Status**|**Data type**|**Notes**
406 -|Annotable|AnnotationTitle|C|string|
407 -| |AnnotationType|C|string|
408 -| |AnnotationURN|C|string|
409 -| |(((
410 -AnnotationText in the form of
394 +(% style="width:935.294px" %)
395 +|**Object Type**|(% style="width:244px" %)**Data [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]**|(% style="width:99px" %)**Status**|**Data type**|(% style="width:389px" %)**Notes**
396 +|Annotable|(% style="width:244px" %)AnnotationTitle|(% style="width:99px" %)C|string|(% style="width:389px" %)
397 +| |(% style="width:244px" %)AnnotationType|(% style="width:99px" %)C|string|(% style="width:389px" %)
398 +| |(% style="width:244px" %)AnnotationURN|(% style="width:99px" %)C|string|(% style="width:389px" %)
399 +| |(% style="width:244px" %)(((
400 +AnnotationText in the form of [[International String>>doc:sdmx:Glossary.International string.WebHome]]
401 +)))|(% style="width:99px" %)C| |(% style="width:389px" %)This can have languagespecific variants.
402 +|Identifiable|(% style="width:244px" %)all content as for Annotable plus|(% style="width:99px" %) | |(% style="width:389px" %)
403 +| |(% style="width:244px" %)id|(% style="width:99px" %)M|string|(% style="width:389px" %)
404 +| |(% style="width:244px" %)uri|(% style="width:99px" %)C|string|(% style="width:389px" %)
405 +| |(% style="width:244px" %)urn|(% style="width:99px" %)C|string|(% style="width:389px" %)Although the urn is computable and therefore may not be submitted or stored physically, the Registry must return the urn for each object, and must be able to service a query on an object referenced solely by its urn.
406 +|Nameable|(% style="width:244px" %)all content as for Identifiable plus|(% style="width:99px" %) | |(% style="width:389px" %)
407 +| |(% style="width:244px" %)Name in the form of [[International String>>doc:sdmx:Glossary.International string.WebHome]]|(% style="width:99px" %)M|string|(% style="width:389px" %)This can have languagespecific variants.
408 +| |(% style="width:244px" %)(((
409 +Description in the form of [[International String>>doc:sdmx:Glossary.International string.WebHome]]
410 +)))|(% style="width:99px" %)C|string|(% style="width:389px" %)This can have languagespecific variants.
411 +|Versionable|(% style="width:244px" %)All content as for Identifiable plus|(% style="width:99px" %) | |(% style="width:389px" %)
412 +| |(% style="width:244px" %)[[version>>doc:sdmx:Glossary.Version.WebHome]]|(% style="width:99px" %)C|string|(% style="width:389px" %)This is the [[version>>doc:sdmx:Glossary.Version.WebHome]] number. If not present the default is 1.0
413 +| |(% style="width:244px" %)validFrom|(% style="width:99px" %)C|Date/time|(% style="width:389px" %)
414 +| |(% style="width:244px" %)validTo|(% style="width:99px" %)C|Date/time|(% style="width:389px" %)
415 +|Maintainable|(% style="width:244px" %)All content as for Versionable plus|(% style="width:99px" %) | |(% style="width:389px" %)
416 +| |(% style="width:244px" %)final|(% style="width:99px" %) |boolean|(% style="width:389px" %)Value of “true” indicates that this is a final specification and it cannot be changed except as a new [[version>>doc:sdmx:Glossary.Version.WebHome]]. Note that providing a “final’ object is not referenced from another object then it may be deleted.
417 +| |(% style="width:244px" %)isExternalReference|(% style="width:99px" %)C|boolean|(% style="width:389px" %)Value of “true” indicates that the actual resource is held outside of this registry. The actual reference is given in the registry URI or the structureURI, each of which must return a valid [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] file.
418 +| |(% style="width:244px" %)serviceURL|(% style="width:99px" %)C|string|(% style="width:389px" %)The url of the service that can be queried for this resource
419 +| |(% style="width:244px" %)structureURL|(% style="width:99px" %)C|string|(% style="width:389px" %)The url of the resource.
420 +| |(% style="width:244px" %)(Maintenance) agencyId|(% style="width:99px" %)M|string|(% style="width:389px" %)The object must be linked to a [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]].
411 411  
412 -International String
413 -)))|C| |This can have languagespecific variants.
414 -| | | | |
415 -|Identifiable|all content as for Annotable plus| | |
416 -| |id|M|string|
417 -| |uri|C|string|
418 -| |urn|C|string|Although the urn is computable and therefore may not be submitted or stored physically, the Registry must return the urn for each object, and must be able to service a query on an object referenced solely by its urn.
419 -|Nameable|all content as for Identifiable plus| | |
420 -| |Name in the form of International String|M|string|This can have languagespecific variants.
421 -| |(((
422 -Description in the form of International
422 +**Table 1: Common [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]] of Object Types**
423 423  
424 -String
425 -)))|C|string|This can have languagespecific variants.
426 -|Versionable|All content as for Identifiable plus| | |
427 -| |version|C|string|This is the version number. If not present the default is 1.0
428 -| |validFrom|C|Date/time|
429 -| |validTo|C|Date/time|
430 -|Maintainable|All content as for Versionable plus| | |
431 -| |final| |boolean|Value of “true” indicates that this is a final specification and it cannot be changed except as a new version. Note that providing a “final’ object is not referenced from another object then it may be deleted.
432 -| |isExternalReference|C|boolean|Value of “true” indicates that the actual resource is held outside of this registry. The actual reference is given in the registry URI or the structureURI, each of which must return a valid SDMX-ML file.
433 -| |serviceURL|C|string|The url of the service that can be queried for this resource
434 -| |structureURL|C|string|The url of the resource.
435 -| |(Maintenance) agencyId|M|string|The object must be linked to a maintenance agency.
436 -
437 -**Table 1: Common Attributes of Object Types**
438 -
439 439  == 6.2 Unique identification of SDMX objects ==
440 440  
441 441  === 6.2.1 Agencies ===
442 442  
443 -The Maintenance Agency in SDMX is maintained in an Agency Scheme which itself is a sub class of Organisation Scheme – this is shown in the class diagram below.
428 +The [[Maintenance Agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] is maintained in an [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]] which itself is a sub class of Organisation Scheme – this is shown in the class diagram below.
444 444  
445 -**Figure 6: Agency Scheme Model**
430 +[[image:1747994320263-112.png]]
446 446  
447 -The Agency in SDMX is extremely important. The Agency Id system used in SDMX is an n-level structure. The top level of this structure is maintained by SDMX. Any Agency in this top level can declare sub agencies and any sub agency can also declare sub agencies. The Agency Scheme has a fixed id and version and is never declared explicitly in the SDMX object identification mechanism.
432 +**Figure 6: [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]] Model**
448 448  
449 -In order to achieve this SDMX adopts the following rules:
434 +The Agency in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] is extremely important. The Agency Id system used in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] is an n-[[level>>doc:sdmx:Glossary.Level.WebHome]] structure. The top [[level>>doc:sdmx:Glossary.Level.WebHome]] of this structure is maintained by [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]. Any Agency in this top [[level>>doc:sdmx:Glossary.Level.WebHome]] can declare sub agencies and any sub agency can also declare sub agencies. The [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]] has a fixed id and [[version>>doc:sdmx:Glossary.Version.WebHome]] and is never declared explicitly in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object identification mechanism.
450 450  
451 -1. Agencies are maintained in an Agency Scheme (which is a sub class of Organisation Scheme)
452 -1. The agency of the Agency Scheme must also be declared in a (different) Agency Scheme.
453 -1. The “top-level” agency is SDMX and maintains the “top-level” Agency Scheme.
454 -1. Agencies registered in the top-level scheme can themselves maintain a single Agency Scheme. Agencies in these second-tier schemes can themselves maintain a single Agency Scheme and so on.
455 -1. The AgencyScheme cannot be versioned and so take a default version number of 1.0 and cannot be made “final”.
436 +In order to achieve this [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] adopts the following rules:
437 +
438 +1. Agencies are maintained in an [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]] (which is a sub class of Organisation Scheme)
439 +1. The agency of the [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]] must also be declared in a (different) [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]].
440 +1. The “top-[[level>>doc:sdmx:Glossary.Level.WebHome]]” agency is [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] and maintains the “top-[[level>>doc:sdmx:Glossary.Level.WebHome]]” [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]].
441 +1. Agencies registered in the top-[[level>>doc:sdmx:Glossary.Level.WebHome]] scheme can themselves maintain a single [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]]. Agencies in these second-tier schemes can themselves maintain a single [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]] and so on.
442 +1. The AgencyScheme cannot be versioned and so take a default [[version>>doc:sdmx:Glossary.Version.WebHome]] number of 1.0 and cannot be made “final”.
456 456  1. There can be only one AgencyScheme maintained by any one Agency. It has a fixed Id of AGENCIES.
457 -1. The /hierarchy of Organisation is not inherited by Maintenance Agency – thus each Agency Scheme is a flat list of Maintenance Agencies.
458 -1. The format of the agency identifier is agencyID.agencyID etc. The toplevel agency in this identification mechanism is the agency registered in the SDMX agency scheme. In other words, SDMX is not a part of the hierarchical ID structure for agencies. However SDMX is, itself, a maintenance agency and is contained in the top-level Agency Scheme.
444 +1. The /hierarchy of Organisation is not inherited by [[Maintenance Agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] – thus each [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]] is a flat list of Maintenance Agencies.
445 +1. The format of the agency identifier is agencyID.agencyID etc. The toplevel agency in this identification mechanism is the agency registered in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[agency scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]]. In other words, [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] is not a part of the hierarchical ID structure for agencies. However [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] is, itself, a [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] and is contained in the top-[[level>>doc:sdmx:Glossary.Level.WebHome]] [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]].
459 459  
460 460  This supports a hierarchical structure of agencyID.
461 461  
... ... @@ -463,7 +463,7 @@
463 463  
464 464  [[image:1747824123012-527.jpeg]]
465 465  
466 -==== Figure 7: Example of Hierarchic Structure of Agencies ====
453 +**Figure 7: Example of Hierarchic Structure of Agencies**
467 467  
468 468  The following organizations maintain an Agency Scheme.
469 469  
... ... @@ -472,46 +472,46 @@
472 472  * BB – contains Agencies CC, DD
473 473  * DD – Contains Agency EE
474 474  
475 -Each agency is identified by its full hierarchy excluding SDMX.
462 +Each agency is identified by its full [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] excluding SDMX.
476 476  
477 477  e.g. the id of EE as an agencyID is AA.DD.EE
478 478  
479 479  An example of this is shown in the XML snippet below.
480 480  
468 +[[image:1747832400104-286.png]]
481 481  
482 -[[image:1747824123013-196.jpeg]]
470 +**Figure 8: Example Showing Use of Agency Identifiers**
483 483  
484 -==== Figure 8: Example Showing Use of Agency Identifiers ====
472 +Each of these [[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]] has an identical [[Code list>>doc:sdmx:Glossary.Code list.WebHome]] with the Id CL_BOP. However, each is uniquely identified by means of the hierarchic agency structure.
485 485  
486 -Each of these maintenance agencies has an identical Code list with the Id CL_BOP. However, each is uniquely identified by means of the hierarchic agency structure.
487 -
488 488  === 6.2.2 Universal Resource Name (URN) ===
489 489  
490 490  ==== 6.2.2.1 Introduction ====
491 491  
492 -To provide interoperability between SDMX Registry/Repositories in a distributed network environment, it is important to have a scheme for uniquely identifying (and thus accessing) all first-class (Identifiable) SDMX-IM objects. Most of these unique identifiers are composite (containing maintenance agency, or parent object identifiers), and there is a need to be able to construct a unique reference as a single string. This is achieved by having a globally unique identifier called a universal resource name (URN) which is generated from the actual identification components in the SDMX-RR APIs. In other words, the URN for any Identifiable Artefact is constructed from its component identifiers (agency, Id, version etc.).
478 +To provide interoperability between [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]]/Repositories in a distributed network environment, it is important to have a scheme for uniquely identifying (and thus accessing) all first-class (Identifiable) [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]] objects. Most of these unique identifiers are composite (containing [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]], or parent object identifiers), and there is a need to be able to construct a unique reference as a single string. This is achieved by having a globally unique identifier called a universal resource name (URN) which is generated from the actual identification [[components>>doc:sdmx:Glossary.Component.WebHome]] in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-RR APIs. In other words, the URN for any [[Identifiable Artefact>>doc:sdmx:Glossary.Identifiable artefact.WebHome]] is constructed from its [[component>>doc:sdmx:Glossary.Component.WebHome]] identifiers (agency, Id, [[version>>doc:sdmx:Glossary.Version.WebHome]] etc.).
493 493  
494 494  ==== 6.2.2.2 URN Structure ====
495 495  
496 -===== //Case Rules for URN// =====
482 +(% class="wikigeneratedid" id="HCaseRulesforURN" %)
483 +//Case Rules for URN//
497 497  
498 498  For the URN, all parts of the string are case sensitive. The Id of any object must be UPPER CASE. Therefore, CRED_ext_Debt is invalid and it should be CRED_EXT_DEBT.
499 499  
500 500  The generic structure of the URN is as follows:
501 501  
502 -SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobject-id(maintainedobject-version).*containerobject-id.object-id
489 +>SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobject-id(maintainedobject-version).*containerobject-id.object-id
503 503  
504 504  ~* this can repeat and may not be present (see explanation below)
505 505  
506 -Note that in the SDMX Information Model there are no concrete Versionable Artefacts that are not a Maintainable Artefact. For this reason the only version information that is allowed is for the maintainable object.
493 +Note that in the [[SDMX Information Model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]] there are no concrete [[Versionable Artefacts>>doc:sdmx:Glossary.Versionable artefact.WebHome]] that are not a [[Maintainable Artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]]. For this reason the only [[version>>doc:sdmx:Glossary.Version.WebHome]] information that is allowed is for the maintainable object.
507 507  
508 -The Maintenance agency identifier is separated from the maintainable artefact identifier by a colon ‘:’. All other identifiers in the SDMX URN syntax are separated by a period(.).
495 +The [[Maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] identifier is separated from the [[maintainable artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]] identifier by a colon ‘:’. All other identifiers in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] URN syntax are separated by a period(.).
509 509  
510 510  ==== 6.2.2.3 Explanation of the generic structure ====
511 511  
512 512  In the explanation below the actual object that is the target of the URN is called the **//actual object//**.
513 513  
514 -**SDMXPrefix:** urn:sdmx:org.                                     
501 +**SDMXPrefix:** urn:sdmx:org.
515 515  
516 516  **SDMX-IM package name:** sdmx.infomodel.package=
517 517  
... ... @@ -519,270 +519,223 @@
519 519  
520 520  **maintainable-object-id** is the identifier of the maintainable object. This will always be present as all identifiable objects are either a maintainable object or contained in a maintainable object.
521 521  
522 -**(maintainable-object-version)** is the version of the maintainable object and is enclosed in round brackets (). It will always be present.
509 +**(maintainable-object-version)** is the [[version>>doc:sdmx:Glossary.Version.WebHome]] of the maintainable object and is enclosed in round brackets (). It will always be present.
523 523  
524 -**container-object-id** is the identifier of an intermediary object that contains the actual object which the URN is identifying. It is not mandatory as many actual objects do not have an intermediary container object. For instance, a Code is in a maintained object (Code List) and has no intermediary container object, whereas a Metadata Attribute has an intermediary container object (Report Structure) and may have an intermediary container object which is its parent Metadata Attribute. For this reason the container object id may repeat, with each repetition identifying the object at the next-lower level in its hierarchy. Note that if there is only a single containing object in the model then it is NOT included in the URN structure. This applies to Attribute Descriptor, Dimension Descriptor, and Measure Descriptor where there can be only one such object and this object has a fixed id. Therefore, whilst each of these has a
511 +**container-object-id** is the identifier of an intermediary object that contains the actual object which the URN is identifying. It is not mandatory as many actual objects do not have an intermediary container object. For instance, a [[Code>>doc:sdmx:Glossary.Code.WebHome]] is in a maintained object ([[Code List>>doc:sdmx:Glossary.Code list.WebHome]]) and has no intermediary container object, whereas a Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] has an intermediary container object (Report Structure) and may have an intermediary container object which is its parent Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]. For this reason the container object id may repeat, with each repetition identifying the object at the next-lower [[level>>doc:sdmx:Glossary.Level.WebHome]] in its [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]. Note that if there is only a single containing object in the model then it is NOT included in the URN structure. This applies to [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Descriptor, [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] Descriptor, and [[Measure>>doc:sdmx:Glossary.Measure.WebHome]] Descriptor where there can be only one such object and this object has a fixed id. Therefore, whilst each of these has a URN, the id of the [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Descriptor, [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] Descriptor, and [[Measure>>doc:sdmx:Glossary.Measure.WebHome]] Descriptor is not included when the actual object is a Data [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] or a [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]/[[Measure>>doc:sdmx:Glossary.Measure.WebHome]] [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]/ Time [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]], or a [[Measure>>doc:sdmx:Glossary.Measure.WebHome]].
525 525  
526 -URN, the id of the Attribute Descriptor, Dimension Descriptor, and Measure Descriptor is not included when the actual object is a Data Attribute or a Dimension/Measure Dimension/ Time Dimension, or a Measure.
513 +Note that although a [[Code>>doc:sdmx:Glossary.Code.WebHome]] can have a parent [[Code>>doc:sdmx:Glossary.Code.WebHome]] and a [[Concept>>doc:sdmx:Glossary.Concept.WebHome]] can have a parent [[Concept>>doc:sdmx:Glossary.Concept.WebHome]] these are maintained in a flat structure and therefore do not have a container-object-id.
527 527  
528 -Note that although a Code can have a parent Code and a Concept can have a parent Concept these are maintained in a flat structure and therefore do not have a container-object-id.
515 +For example the sequence is agency:DSDid([[version>>doc:sdmx:Glossary.Version.WebHome]]).DimensionId and not agency:DSDid([[version>>doc:sdmx:Glossary.Version.WebHome]]).DimensionDescriptorId.DimensionId.
529 529  
530 -For example the sequence is agency:DSDid(version).DimensionId and not agency:DSDid(version).DimensionDescriptorId.DimensionId.
531 -
532 532  **object-id** is the identifier of the actual object unless the actual object is a maintainable object. If present it is always the last id and is not followed by any other character.
533 533  
534 -===== //Generic Examples of the URN Structure// =====
519 +===== __**//Generic Examples of the URN Structure//**__ =====
535 535  
521 +__Actual object is a maintainable__
536 536  
537 -Actual object is a maintainable
523 +> SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version)
538 538  
539 -SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version)
525 +__Actual object is contained in a maintained object with no intermediate containing object__
540 540  
541 -Actual object is contained in a maintained object with no intermediate containing object
527 +> SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).object-id
542 542  
543 -SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).object-id
529 +__Actual object is contained in a maintained object with an intermediate containing object__
544 544  
545 -Actual object is contained in a maintained object with an intermediate containing object
531 +> SDMXPrefix.SDMX-IM package name.classname=agency
546 546  
547 -SDMXPrefix.SDMX-IM package name.classname=agency
548 -
549 549  id:maintained-object-id(version).contained-object-id.object-id
550 550  
551 -Actual object is contained in a maintained object with no intermediate containing object but the object type itself is hierarchical
535 +__Actual object is contained in a maintained object with no intermediate containing object but the object type itself is hierarchical__
552 552  
553 -In this case the object id may not be unique in itself but only within the context of the hierarchy. In the general syntax of the URN all intermediary objects in the structure (with the exception, of course, of the maintained object) are shown as a contained object. An example here would be a Category in a Category Scheme. The Category is hierarchical and all intermediate Categories are shown as a contained object. The example below shows the generic structure for Category Scheme/Category/Category
537 +In this case the object id may not be unique in itself but only within the context of the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]. In the general syntax of the URN all intermediary objects in the structure (with the exception, of course, of the maintained object) are shown as a contained object. An example here would be a [[Category>>doc:sdmx:Glossary.Category.WebHome]] in a [[Category Scheme>>doc:sdmx:Glossary.Category scheme.WebHome]]. The [[Category>>doc:sdmx:Glossary.Category.WebHome]] is hierarchical and all intermediate [[Categories>>doc:sdmx:Glossary.Category.WebHome]] are shown as a contained object. The example below shows the generic structure for [[Category Scheme>>doc:sdmx:Glossary.Category scheme.WebHome]]/[[Category>>doc:sdmx:Glossary.Category.WebHome]]/[[Category>>doc:sdmx:Glossary.Category.WebHome]]
554 554  
555 -SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).contained-object-id.object-id
539 +> SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).contained-object-id.object-id
556 556  
557 -Actual object is contained in a maintained object with an intermediate containing object and the object type itself is hierarchical
541 +__Actual object is contained in a maintained object with an intermediate containing object and the object type itself is hierarchical__
558 558  
559 -In this case the generic syntax is the same as for the example above as the parent object is regarded as a containing object, even if it is of the same type. An example here is a Metadata Attribute where the contained objects are Report Structure (first contained object id) and Metadata Attribute (subsequent contained object Ids). The example below shows the generic structure for MSD/Report Structure/Metadata Attribute/Metadata Attribute
543 +In this case the generic syntax is the same as for the example above as the parent object is regarded as a containing object, even if it is of the same type. An example here is a Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] where the contained objects are Report Structure (first contained object id) and Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] (subsequent contained object Ids). The example below shows the generic structure for [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]/Report Structure/Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]/Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]
560 560  
561 -SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).contained-object-id. contained-object-id contained-object-id.object-id
545 +> SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).contained-object-id. contained-object-id contained-object-id.object-id
562 562  
563 -===== //Concrete Examples of the URN Structure// =====
547 +===== __**//Concrete Examples of the URN Structure//**__ =====
564 564  
565 -The Data Structure Definition CRED_EXT_DEBT version 1.0 maintained by the top level Agency TFFS would have the URN:
549 +The [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] CRED_EXT_DEBT version 1.0 maintained by the top level Agency TFFS would have the URN:
566 566  
567 -urn:sdmx:org.sdmx.infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(1.0)
551 +> urn:sdmx:org.sdmx.infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(1.0)
568 568  
569 -The URN for a code for Argentina maintained by ISO in the code list CL_3166A2 version 1.0 would be:
553 +The URN for a [[code>>doc:sdmx:Glossary.Code.WebHome]] for Argentina maintained by ISO in the code list CL_3166A2 version 1.0 would be:
570 570  
571 -urn:sdmx:org.sdmx.infomodel.codelist.Code=ISO:CL_3166A2(1.0).AR
555 +> urn:sdmx:org.sdmx.infomodel.codelist.Code=ISO:CL_3166A2(1.0).AR
572 572  
573 -The URN for a category (id of 1) which has parent category (id of 2) maintained by SDMX in the category scheme SUBJECT_MATTER_DOMAINS version 1.0 would be:
557 +The URN for a [[category>>doc:sdmx:Glossary.Category.WebHome]] (id of 1) which has parent [[category>>doc:sdmx:Glossary.Category.WebHome]] (id of 2) maintained by [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] in the [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] SUBJECT_MATTER_DOMAINS version 1.0 would be:
574 574  
575 -urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:SUBJE CT_MATTER_DOMAINS(1.0).1.2
559 +> urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:SUBJE CT_MATTER_DOMAINS(1.0).1.2
576 576  
577 -The URN for a Metadata Attribute maintained by SDMX in the MSD CONTACT_METADATA version 1.0 in the Report Structure CONTACT_REPORT where the hierarchy of the Metadata Attribute is
561 +The URN for a Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] maintained by [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] in the [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] CONTACT_METADATA [[version>>doc:sdmx:Glossary.Version.WebHome]] 1.0 in the Report Structure CONTACT_REPORT where the hierarchy of the Metadata Attribute is
578 578  
579 579  CONTACT_DETAILS/CONTACT_NAME would be:
580 580  
581 -urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataAttribut e=SDMX:CONTACT_METADATA(1.0).CONTACT_REPORT.CONTACT_DETAILS.CO NTACT_NAME
565 +> urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataAttribut e=SDMX:CONTACT_METADATA(1.0).CONTACT_REPORT.CONTACT_DETAILS.CO NTACT_NAME
582 582  
583 -The TFFS defines ABC as a sub Agency of TFFS then the URN of a Dataflow maintained by ABC and identified as EXTERNAL_DEBT version 1.0 would be:
567 +The TFFS defines ABC as a sub Agency of TFFS then the URN of a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] maintained by ABC and identified as EXTERNAL_DEBT version 1.0 would be:
584 584  
585 -urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=TFFS.ABC:EX
569 +> urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=TFFS.ABC:EX
586 586  
587 587  TERNAL_DEBT(1.0)
588 588  
589 -The SDMX-RR MUST support this globally unique identification scheme. The SDMXRR MUST be able to create the URN from the individual identification attributes submitted and to transform the URN to these identification attributes. The identification attributes are:
573 +The [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-RR MUST support this globally unique identification scheme. The SDMXRR MUST be able to create the URN from the individual identification [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] submitted and to transform the URN to these identification [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. The identification [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] are:
590 590  
591 -* **Identifiable and Nameable Artefacts**: id (in some cases this id may be hierarchic)
592 -* **Maintainable Artefacts**: id, version, agencyId,
575 +* **Identifiable and [[Nameable Artefacts>>doc:sdmx:Glossary.Nameable artefact.WebHome]]**: id (in some cases this id may be hierarchic)
576 +* **Maintainable [[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]**: id, [[version>>doc:sdmx:Glossary.Version.WebHome]], agencyId,
593 593  
594 -The SDMX-RR MUST be able to resolve the unique identifier of an SDMX artefact and to produce an SDMX-ML rendering of that artefact if it is located in the Registry.
578 +The [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-RR MUST be able to resolve the unique identifier of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] and to produce an [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] rendering of that [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] if it is located in the Registry.
595 595  
596 596  === 6.2.3 Table of SDMX-IM Packages and Classes ===
597 597  
598 -The table below lists all of the packages in the SDMX-IM together with the concrete classes that are in these packages and whose objects have a URN.
582 +The table below lists all of the packages in the [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]] together with the concrete classes that are in these packages and whose objects have a URN.
599 599  
600 -|**Package**|(((
601 -**URN Classname (model classname**
602 -
603 -**where this is different)**
584 +(% style="width:644.294px" %)
585 +|(% style="width:127px" %)**Package**|(% style="width:494px" %)(((
586 +**URN Classname (model classname where this is different)**
604 604  )))
605 -|base|Agency
606 -| |OrganisationUnitScheme
607 -| |AgencyScheme
608 -| |DataProviderScheme
609 -| |DataConsumerScheme
610 -| |OrganisationUnit
611 -| |DataProvider
612 -| |DataConsumer
613 -| |
614 -|datastructure|DataStructure (DataStructureDefinition)
615 -| |AttributeDescriptor
616 -| |DataAttribute
617 -| |GroupDimensionDescriptor
618 -| |DimensionDescriptor
619 -| |Dimension
620 -| |MeasureDimension
621 -| |TimeDimension
622 -| |MeasureDescriptor
623 -| |PrimaryMeasure
624 -| |Dataflow (DataflowDefinition)
625 -| |
626 -|metadatastructure|MetadataTarget
627 -| |DimensionDescriptorValueTarget
628 -| |IdentifiableObjectTarget
629 -| |ReportPeriodTarget
630 -| |DataSetTarget
631 -| |ReportStructure
632 -| |MetadataAttribute
633 -| |(((
588 +|(% style="width:127px" %)base|(% style="width:494px" %)Agency
589 +|(% style="width:127px" %) |(% style="width:494px" %)OrganisationUnitScheme
590 +|(% style="width:127px" %) |(% style="width:494px" %)AgencyScheme
591 +|(% style="width:127px" %) |(% style="width:494px" %)DataProviderScheme
592 +|(% style="width:127px" %) |(% style="width:494px" %)DataConsumerScheme
593 +|(% style="width:127px" %) |(% style="width:494px" %)OrganisationUnit
594 +|(% style="width:127px" %) |(% style="width:494px" %)DataProvider
595 +|(% style="width:127px" %) |(% style="width:494px" %)DataConsumer
596 +|(% style="width:127px" %)datastructure|(% style="width:494px" %)DataStructure (DataStructureDefinition)
597 +|(% style="width:127px" %) |(% style="width:494px" %)AttributeDescriptor
598 +|(% style="width:127px" %) |(% style="width:494px" %)DataAttribute
599 +|(% style="width:127px" %) |(% style="width:494px" %)GroupDimensionDescriptor
600 +|(% style="width:127px" %) |(% style="width:494px" %)DimensionDescriptor
601 +|(% style="width:127px" %) |(% style="width:494px" %)Dimension
602 +|(% style="width:127px" %) |(% style="width:494px" %)MeasureDimension
603 +|(% style="width:127px" %) |(% style="width:494px" %)TimeDimension
604 +|(% style="width:127px" %) |(% style="width:494px" %)MeasureDescriptor
605 +|(% style="width:127px" %) |(% style="width:494px" %)PrimaryMeasure
606 +|(% style="width:127px" %) |(% style="width:494px" %)Dataflow (DataflowDefinition)
607 +|(% style="width:127px" %)metadatastructure|(% style="width:494px" %)MetadataTarget
608 +|(% style="width:127px" %) |(% style="width:494px" %)DimensionDescriptorValueTarget
609 +|(% style="width:127px" %) |(% style="width:494px" %)IdentifiableObjectTarget
610 +|(% style="width:127px" %) |(% style="width:494px" %)ReportPeriodTarget
611 +|(% style="width:127px" %) |(% style="width:494px" %)DataSetTarget
612 +|(% style="width:127px" %) |(% style="width:494px" %)ReportStructure
613 +|(% style="width:127px" %) |(% style="width:494px" %)MetadataAttribute
614 +|(% style="width:127px" %) |(% style="width:494px" %)(((
634 634  MetadataStructure
635 635  
636 636  (MetadataStructureDefinition)
637 637  )))
638 -| |Metadataflow (MetadataflowDefinition)
639 -| |
640 -|process|Process
641 -| |ProcessStep
642 -| |Transition
643 -| |
644 -|registry|ProvisionAgreement
645 -| |AttachmentConstraint
646 -| |ContentConstraint
647 -| |Subscription
648 -| |
649 -|mapping|StructureMap
650 -| |StructureSet
651 -| |ComponentMap
652 -|**Package**|(((
653 -**URN Classname (model classname**
619 +|(% style="width:127px" %) |(% style="width:494px" %)Metadataflow (MetadataflowDefinition)
620 +|(% style="width:127px" %)process|(% style="width:494px" %)Process
621 +|(% style="width:127px" %) |(% style="width:494px" %)ProcessStep
622 +|(% style="width:127px" %) |(% style="width:494px" %)Transition
623 +|(% style="width:127px" %)registry|(% style="width:494px" %)ProvisionAgreement
624 +|(% style="width:127px" %) |(% style="width:494px" %)AttachmentConstraint
625 +|(% style="width:127px" %) |(% style="width:494px" %)ContentConstraint
626 +|(% style="width:127px" %) |(% style="width:494px" %)Subscription
627 +|(% style="width:127px" %)mapping|(% style="width:494px" %)StructureMap
628 +|(% style="width:127px" %) |(% style="width:494px" %)StructureSet
629 +|(% style="width:127px" %) |(% style="width:494px" %)ComponentMap
630 +|(% style="width:127px" %) |(% style="width:494px" %)ConceptSchemeMap
631 +|(% style="width:127px" %) |(% style="width:494px" %)OrganisationSchemeMap
632 +|(% style="width:127px" %) |(% style="width:494px" %)CodelistMap
633 +|(% style="width:127px" %) |(% style="width:494px" %)CategorySchemeMap
634 +|(% style="width:127px" %) |(% style="width:494px" %)ReportingTaxonomyMap
635 +|(% style="width:127px" %) |(% style="width:494px" %)ConceptMap
636 +|(% style="width:127px" %) |(% style="width:494px" %)OrganisationMap
637 +|(% style="width:127px" %) |(% style="width:494px" %)CodeMap
638 +|(% style="width:127px" %) |(% style="width:494px" %)HybridCodelistMap
639 +|(% style="width:127px" %) |(% style="width:494px" %)CategoryMap
640 +|(% style="width:127px" %) |(% style="width:494px" %)HybridCodeMap
641 +|(% style="width:127px" %) |(% style="width:494px" %)ReportingCategoryMap
642 +|(% style="width:127px" %)codelist|(% style="width:494px" %)Codelist
643 +|(% style="width:127px" %) |(% style="width:494px" %)HierarchicalCodelist
644 +|(% style="width:127px" %) |(% style="width:494px" %)Hierarchy
645 +|(% style="width:127px" %) |(% style="width:494px" %)Hierarchy
646 +|(% style="width:127px" %) |(% style="width:494px" %)Code
647 +|(% style="width:127px" %) |(% style="width:494px" %)HierarchicalCode
648 +|(% style="width:127px" %) |(% style="width:494px" %)Level
649 +|(% style="width:127px" %)categoryscheme|(% style="width:494px" %)CategoryScheme
650 +|(% style="width:127px" %) |(% style="width:494px" %)Category
651 +|(% style="width:127px" %) |(% style="width:494px" %)Categorisation
652 +|(% style="width:127px" %) |(% style="width:494px" %)ReportingTaxonomy
653 +|(% style="width:127px" %) |(% style="width:494px" %)ReportingCategory
654 +|(% style="width:127px" %)conceptscheme|(% style="width:494px" %)ConceptScheme
655 +|(% style="width:127px" %) |(% style="width:494px" %)Concept
656 +|(% style="width:127px" %)transformation|(% style="width:494px" %)TransformationScheme
657 +|(% style="width:127px" %) |(% style="width:494px" %)Transformation
658 +|(% style="width:127px" %) |(% style="width:494px" %)CustomTypeScheme
659 +|(% style="width:127px" %) |(% style="width:494px" %)CustomType
660 +|(% style="width:127px" %) |(% style="width:494px" %)NamePersonalisationScheme
661 +|(% style="width:127px" %) |(% style="width:494px" %)NamePersonalisation
662 +|(% style="width:127px" %) |(% style="width:494px" %)VtlCodelistMapping
663 +|(% style="width:127px" %) |(% style="width:494px" %)VtlConceptMapping
664 +|(% style="width:127px" %) |(% style="width:494px" %)VtlDataflowMapping
665 +|(% style="width:127px" %) |(% style="width:494px" %)VtlConceptSchemeMapping
666 +|(% style="width:127px" %) |(% style="width:494px" %)RulesetScheme
667 +|(% style="width:127px" %) |(% style="width:494px" %)Ruleset
668 +|(% style="width:127px" %) |(% style="width:494px" %)UserDefinedOperatorScheme
669 +|(% style="width:127px" %) |(% style="width:494px" %)UserDefinedOperator
654 654  
655 -**where this is different)**
656 -)))
657 -| |ConceptSchemeMap
658 -| |OrganisationSchemeMap
659 -| |CodelistMap
660 -| |CategorySchemeMap
661 -| |ReportingTaxonomyMap
662 -| |ConceptMap
663 -| |OrganisationMap
664 -| |CodeMap
665 -| |HybridCodelistMap
666 -| |CategoryMap
667 -| |HybridCodeMap
668 -| |ReportingCategoryMap
669 -| |
670 -|codelist|Codelist
671 -| |HierarchicalCodelist
672 -| |Hierarchy
673 -| |Hierarchy
674 -| |Code
675 -| |HierarchicalCode
676 -| |Level
677 -| |
678 -|categoryscheme|CategoryScheme
679 -| |Category
680 -| |Categorisation
681 -| |ReportingTaxonomy
682 -| |ReportingCategory
683 -| |
684 -|conceptscheme|ConceptScheme
685 -| |Concept
686 -| |
687 -|transformation|TransformationScheme
688 -| |Transformation
689 -| |CustomTypeScheme
690 -| |CustomType
691 -| |NamePersonalisationScheme
692 -| |NamePersonalisation
693 -| |VtlCodelistMapping
694 -| |VtlConceptMapping
695 -| |VtlDataflowMapping
696 -| |VtlConceptSchemeMapping
697 -| |RulesetScheme
698 -| |Ruleset
699 -| |UserDefinedOperatorScheme
700 -| |UserDefinedOperator
701 -| |
671 +**Table 2: [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]] Packages and Contained Classes**
702 702  
703 -**Table 2: SDMX-IM Packages and Contained Classes**
704 -
705 -
706 706  === 6.2.4 URN Identification components of SDMX objects ===
707 707  
708 -The table below describes the identification components for all SDMX object types that have identification. Note the actual attributes are all Id, but have been prefixed by their class name or multiple class names to show navigation, e.g. conceptSchemeAgencyId is really the Id attribute of the Agency class that is associated to the ConceptScheme.
675 +The table below describes the identification [[components>>doc:sdmx:Glossary.Component.WebHome]] for all [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object types that have identification. Note the actual [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] are all Id, but have been prefixed by their class name or multiple class names to show navigation, e.g. conceptSchemeAgencyId is really the Id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] of the Agency class that is associated to the ConceptScheme.
709 709  
710 710  ~* indicates that the object is maintainable.
711 711  
712 712  Note that for brevity the URN examples omit the prefix. All URNs have the prefix
713 713  
714 -urn:sdmx.org.sdmx.infomodel.{package}.{classname}=
681 +> urn:sdmx.org.sdmx.infomodel.{package}.{classname}=
715 715  
716 -
717 -|**SDMX Class**|**Key attribute(s)**|**Example of URN**
718 -|Agency|The URN for an Agency is shown later in this table. The identification of an Agency in the URN structure for the maintainable object is by means of the agencyId. The AgencyScheme is not identified as SDMX has a mechanism for identifying an Agency uniquely by its Id. Note that this Id may be hierarchical.|(((
683 +(% style="width:1277.29px" %)
684 +|(% style="width:269px" %)**SDMX Class**|(% style="width:453px" %)**Key attribute(s)**|(% style="width:550px" %)**Example of URN**
685 +|(% style="width:269px" %)Agency|(% style="width:453px" %)The URN for an Agency is shown later in this table. The identification of an Agency in the URN structure for the maintainable object is by means of the agencyId. The AgencyScheme is not identified as [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] has a mechanism for identifying an Agency uniquely by its Id. Note that this Id may be hierarchical.|(% style="width:550px" %)(((
719 719  IMF
720 -
721 -
722 722  Sub agency in the IMF AGENCIES
723 -
724 -
725 725  IMF.SubAgency1
726 726  )))
727 -|*ConceptScheme|conceptSchemeAgencyId:conceptSchemeId(ve rsion)|SDMX:CROSS_DOMAIN_CONCEPTS(1.0)
728 -|Concept|(((
729 -conceptSchemeAgencyId:
730 -
731 -conceptSchemeId(version).conceptId
732 -)))|SDMX:CROSS_DOMAIN_CONCEPTS(1.0).FREQ
733 -|*Codelist|codeListAgencyId:codeListId(version)|SDMX:CL_FREQ(1.0)
734 -|Code|codeListAgencyId:codelistId(version).codeId|(((
735 -SDMX:CL_FREQ(1.0).Q
736 -
737 -
690 +|(% style="width:269px" %)*ConceptScheme|(% style="width:453px" %)conceptSchemeAgencyId:conceptSchemeId(ve rsion)|(% style="width:550px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0)
691 +|(% style="width:269px" %)Concept|(% style="width:453px" %)conceptSchemeAgencyId:
692 +conceptSchemeId(version).conceptId|(% style="width:550px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0).FREQ
693 +|(% style="width:269px" %)*Codelist|(% style="width:453px" %)codeListAgencyId:codeListId(version)|(% style="width:550px" %)SDMX:CL_FREQ(1.0)
694 +|(% style="width:269px" %)Code|(% style="width:453px" %)codeListAgencyId:codelistId(version).codeId|(% style="width:550px" %)SDMX:CL_FREQ(1.0).Q
695 +|(% style="width:269px" %)(((
696 +*Hierarchical Codelist
697 +)))|(% style="width:453px" %)hierachicalCodelistAgencyId:
698 +hierarchicalCodelistId(version)|(% style="width:550px" %)(((
699 +UNESCO:CL_EXP_SOURCE(1.0(% style="background-color:transparent" %))
738 738  )))
739 -
740 -
741 -
742 -|(((
743 -*Hierarchical
744 -
745 -Codelist
746 -)))|hierachicalCodelistAgencyId: hierarchicalCodelistId(version)|(((
747 -UNESCO:CL_EXP_SOURCE(1.0)
748 -
749 -
750 -)))
751 -|Hierarchy|(((
701 +|(% style="width:269px" %)Hierarchy|(% style="width:453px" %)(((
752 752  hierachicalcodeListAgencyId:
753 -
754 754  hierarchicalcodelistId(version).Hierarchy
755 -)))|UNESCO:CL_EXP_SOURCE(1.0). H-C-GOV
756 -|Level|(((
704 +)))|(% style="width:550px" %)UNESCO:CL_EXP_SOURCE(1.0).
705 +H-C-GOV
706 +|(% style="width:269px" %)Level|(% style="width:453px" %)(((
757 757  hierachicalcodeListAgencyId:
758 -
759 759  hierarchicalcodelistId(version).Hierarchy.Level
760 -)))|(((
709 +)))|(% style="width:550px" %)(((
761 761  ESTAT:HCL_REGION(1.0).H_1.COUNTRY
762 -
763 -
764 764  )))
765 -|HierarchicalCode|hierachicalCodeListAgencyId: hierarchicalcodelistId(version).hierarchy.hierarc hicalCode|UNESCO:CL_EXP_SOURCE(1.0). H-C-GOV.GOV_CODE1
766 -|*DataStructure|dataStructureDefintitionAgencyId: dataStructureDefintitionId(version)|TFFS:EXT_DEBT(1.0)
767 -|(((
712 +|(% style="width:269px" %)HierarchicalCode|(% style="width:453px" %)hierachicalCodeListAgencyId: hierarchicalcodelistId(version).hierarchy.hierarc hicalCode|(% style="width:550px" %)UNESCO:CL_EXP_SOURCE(1.0). H-C-GOV.GOV_CODE1
713 +|(% style="width:269px" %)*DataStructure|(% style="width:453px" %)dataStructureDefintitionAgencyId: dataStructureDefintitionId(version)|(% style="width:550px" %)TFFS:EXT_DEBT(1.0)
714 +|(% style="width:269px" %)(((
768 768  Dimension
769 -
770 770  Descriptor
771 -
772 772  Measure
773 -
774 774  Descriptor
775 -
776 776  Attribute
777 -
778 778  Descriptor
779 -)))|(((
721 +)))|(% style="width:453px" %)(((
780 780  dataStructureDefinitionAgencyId: dataStructureDefinitionId(version).
781 -
782 782  componentListId
783 -
784 784  where the componentListId is the name of the class (there is only one occurrence of each in the Data Structure Definition)
785 -)))|(((
725 +)))|(% style="width:550px" %)(((
786 786  TFFS:EXT_DEBT(1.0).DimensionDescriptor
787 787  
788 788  TFFS:EXT_DEBT(1.0).MeasureDescriptor
... ... @@ -789,289 +789,209 @@
789 789  
790 790  TFFS:EXT_DEBT(1.0).AttributeDescriptor
791 791  )))
792 -|(((
732 +|(% style="width:269px" %)(((
793 793  GroupDimension
794 -
795 795  Descriptor
796 -)))|(((
735 +)))|(% style="width:453px" %)(((
797 797  dataStructureDefinitionAgencyId: dataStructureDefinitionId(version).
798 -
799 799  groupDimensionDescriptorId
800 -)))|TFFS:EXT_DEBT(1.0).SIBLING
801 -|Dimension|(((
738 +)))|(% style="width:550px" %)TFFS:EXT_DEBT(1.0).SIBLING
739 +|(% style="width:269px" %)Dimension|(% style="width:453px" %)(((
802 802  dataStructureDefinitionAgencyId: dataStructureDefinition (version).
803 -
804 804  dimensionId
805 -)))|TFFS:EXT_DEBT(1.0).FREQ
806 -|TimeDimension|(((
742 +)))|(% style="width:550px" %)TFFS:EXT_DEBT(1.0).FREQ
743 +|(% style="width:269px" %)TimeDimension|(% style="width:453px" %)(((
807 807  dataStructureDefinitionAgencyId: dataStructureDefinition (version).
808 -
809 809  timeDimensionId
810 -)))|TFFS:EXT_DEBT(1.0).TIME_PERIOD
811 -|Measure Dimension|dataStructureDefinitionAgencyId: dataStructureDefinition (version).|TFFS:EXT_DEBT(1.0).STOCK_FLOW
812 -
813 -
814 -
815 -| |measureDimensionId|
816 -|DataAttrribute|dataStructureDefinitionAgencyId: dataStructureDefinition (version). dataAttributeId|TFFS:EXT_DEBT(1.0).OBS_STATUS
817 -|PrimaryMeasure|(((
746 +)))|(% style="width:550px" %)TFFS:EXT_DEBT(1.0).TIME_PERIOD
747 +|(% style="width:269px" %)Measure Dimension|(% style="width:453px" %)dataStructureDefinitionAgencyId: dataStructureDefinition (version).
748 +measureDimensionId|(% style="width:550px" %)TFFS:EXT_DEBT(1.0).STOCK_FLOW
749 +|(% style="width:269px" %)DataAttrribute|(% style="width:453px" %)dataStructureDefinitionAgencyId: dataStructureDefinition (version). dataAttributeId|(% style="width:550px" %)TFFS:EXT_DEBT(1.0).OBS_STATUS
750 +|(% style="width:269px" %)PrimaryMeasure|(% style="width:453px" %)(((
818 818  dataStructureDefinitionAgencyId: dataStructureDefinition (version).
819 -
820 820  primaryMeasureId
821 -)))|TFFS:EXT_DEBT(1.0).OBS_VALUE
822 -|(((
823 -*Category
824 -
825 -Scheme
826 -)))|categorySchemeAgencyId: categorySchemeId(version)|IMF:SDDS(1.0)
827 -|Category|categorySchemeAgencyId: categorySchemeId(version). categoryId.categoryId categoryId.categoryId etc.|(((
753 +)))|(% style="width:550px" %)TFFS:EXT_DEBT(1.0).OBS_VALUE
754 +|(% style="width:269px" %)(((
755 +*Category Scheme
756 +)))|(% style="width:453px" %)categorySchemeAgencyId:
757 +categorySchemeId(version)|(% style="width:550px" %)IMF:SDDS(1.0)
758 +|(% style="width:269px" %)Category|(% style="width:453px" %)categorySchemeAgencyId:
759 +categorySchemeId(version).
760 +categoryId.categoryId categoryId.categoryId etc.|(% style="width:550px" %)(((
828 828  IMF:SDDS(1.0):
829 -
830 830  level_1_category.level_2_category …
831 831  )))
832 -|(((
833 -*Reporting
834 -
835 -Taxonomy
836 -)))|reportingTaxonomyAgencyId: reportingTaxonomyId(version)| IMF:REP_1(1.0)
837 -|ReportingCategory|reportingTaxonomyAgencyId: reportingTaxonomyId(version) reportingcategoryId.reportingcategoryId|(((
764 +|(% style="width:269px" %)(((
765 +*Reporting Taxonomy
766 +)))|(% style="width:453px" %)reportingTaxonomyAgencyId: reportingTaxonomyId(version)|(% style="width:550px" %) IMF:REP_1(1.0)
767 +|(% style="width:269px" %)ReportingCategory|(% style="width:453px" %)reportingTaxonomyAgencyId: reportingTaxonomyId(version) reportingcategoryId.reportingcategoryId|(% style="width:550px" %)(((
838 838  IMF:REP_1(1.0):
839 -
840 840  level_1_repcategory.level_2_repcategory …
841 841  )))
842 -|*Categorisation|categorisationAgencyId: categorisationId(version)|IMF:cat001(1.0)
843 -|(((
844 -*Organisation
771 +|(% style="width:269px" %)*Categorisation|(% style="width:453px" %)categorisationAgencyId: categorisationId(version)|(% style="width:550px" %)IMF:cat001(1.0)
772 +|(% style="width:269px" %)(((
773 +*Organisation Unit Scheme
774 +)))|(% style="width:453px" %)organisationUnitSchemeAgencyId: organisationUnitSchemeId(version)|(% style="width:550px" %)ECB:ORGANISATIONS(1.0)
775 +|(% style="width:269px" %)Organisation Unit|(% style="width:453px" %)organisationUnitSchemeAgencyId: organisationUnitSchemeId(version). organisationUnitId|(% style="width:550px" %)ECB:ORGANISATIONS(1.0).1F
776 +|(% style="width:269px" %)*AgencyScheme|(% style="width:453px" %)agencySchemeAgencyId: agencySchemeId(version)|(% style="width:550px" %)ECB:AGENCIES(1.0)
845 845  
846 -Unit Scheme
847 -)))|organisationUnitSchemeAgencyId: organisationUnitSchemeId(version)|ECB:ORGANISATIONS(1.0)
848 -|Organisation Unit|organisationUnitSchemeAgencyId: organisationUnitSchemeId(version). organisationUnitId|ECB:ORGANISATIONS(1.0).1F
849 -|*AgencyScheme|agencySchemeAgencyId: agencySchemeId(version)|ECB:AGENCIES(1.0)
850 -
851 -
852 -
853 -|Agency|agencySchemeAgencyId: agencySchemeId(version). agencyId|ECB:AGENCY(1.0).AA
854 -|(((
855 -*DataProvider
856 -
857 -Scheme
858 -)))|dataProviderSchemeAgencyId: dataProviderSchemeId(version)|SDMX:DATA_PROVIDERS(1.0)
859 -|DataProvider|dataProviderSchemeAgencyId: dataProviderSchemeId(version) dataProviderId|SDMX:DATA_PROVIDERS(1.0).PROVIDER_1
860 -|(((
861 -*DataConsumer
862 -
863 -Scheme
864 -)))|dataConsumerSchemeAgencyId: dataConsumerSchemeId(version)|SDMX:DATA_CONSUMERS(1.0)
865 -|Data Consumer|dataConsumerSchemeAgencyId: dataConsumerSchemeId(version) dataConsumerId|SDMX:DATA_CONSUMERS(1.0).CONSUMER_1
866 -|(((
867 -*Metadata
868 -
869 -Structure
870 -)))|MSDAgencyId:MSDId(version)|IMF:SDDS_MSD(1.0)
871 -|MetadataTarget|(((
778 +(% style="width:1274.29px" %)
779 +|(% style="width:262px" %)Agency|(% style="width:369px" %)agencySchemeAgencyId: agencySchemeId(version). agencyId|(% style="width:535px" %)ECB:AGENCY(1.0).AA
780 +|(% style="width:262px" %)(((
781 +*DataProvider Scheme
782 +)))|(% style="width:369px" %)dataProviderSchemeAgencyId: dataProviderSchemeId(version)|(% style="width:535px" %)SDMX:DATA_PROVIDERS(1.0)
783 +|(% style="width:262px" %)DataProvider|(% style="width:369px" %)dataProviderSchemeAgencyId: dataProviderSchemeId(version) dataProviderId|(% style="width:535px" %)SDMX:DATA_PROVIDERS(1.0).PROVIDER_1
784 +|(% style="width:262px" %)(((
785 +*DataConsumer Scheme
786 +)))|(% style="width:369px" %)dataConsumerSchemeAgencyId: dataConsumerSchemeId(version)|(% style="width:535px" %)SDMX:DATA_CONSUMERS(1.0)
787 +|(% style="width:262px" %)Data Consumer|(% style="width:369px" %)dataConsumerSchemeAgencyId: dataConsumerSchemeId(version) dataConsumerId|(% style="width:535px" %)SDMX:DATA_CONSUMERS(1.0).CONSUMER_1
788 +|(% style="width:262px" %)(((
789 +*Metadata Structure
790 +)))|(% style="width:369px" %)MSDAgencyId:MSDId(version)|(% style="width:535px" %)IMF:SDDS_MSD(1.0)
791 +|(% style="width:262px" %)MetadataTarget|(% style="width:369px" %)(((
872 872  MSDAgencyId:
873 -
874 874  MSDId(version).metadataTargetId
875 -)))|IMF:SDDS_MSD(1.0).AGENCY
876 -|(((
794 +)))|(% style="width:535px" %)IMF:SDDS_MSD(1.0).AGENCY
795 +|(% style="width:262px" %)(((
877 877  Dimension
878 -
879 879  DescriptorValues
880 -
881 881  Target
882 -)))|(((
799 +)))|(% style="width:369px" %)(((
883 883  MSDAgencyId: MSDId(version).
884 -
885 885  metadataTargetId.keyDescriptorValueTargetId
886 -)))|IMF:SDDS_MSD(1.0).AGENCY.KEY
887 -|Identifiable ObjectTarget|(((
802 +)))|(% style="width:535px" %)IMF:SDDS_MSD(1.0).AGENCY.KEY
803 +|(% style="width:262px" %)Identifiable Object Target|(% style="width:369px" %)(((
804 +MSDAgencyId: MSDId(version).metadataTargetId.identifiableObjectTargetId
805 +)))|(% style="width:535px" %)IMF:SDDS_MSD(1.0).AGENCY.STR-OBJECT
806 +|(% style="width:262px" %)DataSetTarget|(% style="width:369px" %)(((
888 888  MSDAgencyId:
808 +MSDId(version).metadataTargetId.dataSetTargetId
809 +)))|(% style="width:535px" %)IMF:SDDS_MSD(1.0).AGENCY.D1101
810 +|(% style="width:262px" %)PeportPeriod Target|(% style="width:369px" %)(((
811 +MSDAgencyId: MSDId(version).metadataTargetId.reportPeriodTargetId
812 +)))|(% style="width:535px" %)IMF:SDDS_MSD(1.0).AGENCY.REP_PER
889 889  
890 -MSDId(version).metadataTargetId.identifiable
891 -
892 -ObjectTargetId
893 -)))|IMF:SDDS_MSD(1.0).AGENCY.STR-OBJECT
894 -|DataSetTarget|(((
895 -MSDAgencyId:
896 -
897 -MSDId(version).metadataTargetId.dataSet
898 -
899 -TargetId
900 -)))|IMF:SDDS_MSD(1.0).AGENCY.D1101
901 -|PeportPeriod Target|(((
902 -MSDAgencyId:
903 -
904 -MSDId(version).metadataTargetId.reportPeriod
905 -
906 -TargetId
907 -)))|IMF:SDDS_MSD(1.0).AGENCY.REP_PER
908 -
909 -
910 -
911 -|(((
814 +(% style="width:1277.29px" %)
815 +|(% style="width:270px" %)(((
912 912  ReportStructure
913 -
914 -
915 -)))|(((
916 -MSDAgencyId:
917 -
918 -MSDId(version).reportStructureId
919 -)))|IMF:SDDS_MSD(1.0).AGENCY_REPORT
920 -|(((
921 -Metadata
922 -
923 -Attribute
924 -)))|(((
925 -MSDAgencyId:
926 -
927 -MSDId(version).reportStructureId.metadataattri buteID
928 -)))|IMF:SDDS_MSD(1.0).AGENCY_REPORT.COMPILATION
929 -|*Dataflow|dataflowAgencyId: dataflowId(version)|TFFS:CRED_EXT_DEBT(1.0)
930 -|*Provision Agreement|(((
817 +)))|(% style="width:454px" %)(((
818 +MSDAgencyId: MSDId(version).reportStructureId
819 +)))|(% style="width:549px" %)IMF:SDDS_MSD(1.0).AGENCY_REPORT
820 +|(% style="width:270px" %)(((
821 +Metadata Attribute
822 +)))|(% style="width:454px" %)(((
823 +MSDAgencyId: MSDId(version).reportStructureId.metadataattri buteID
824 +)))|(% style="width:549px" %)IMF:SDDS_MSD(1.0).AGENCY_REPORT.COMPILATION
825 +|(% style="width:270px" %)*Dataflow|(% style="width:454px" %)dataflowAgencyId: dataflowId(version)|(% style="width:549px" %)TFFS:CRED_EXT_DEBT(1.0)
826 +|(% style="width:270px" %)*Provision Agreement|(% style="width:454px" %)(((
931 931  provisionAgreementAgencyId:provisionAgreem entId(version)
932 -
933 -
934 -)))|(((
828 +)))|(% style="width:549px" %)(((
935 935  TFFS:CRED_EXT_DEBT_AB(1.0)
936 -
937 -
938 -
939 939  )))
940 -|(((
941 -*Content
942 -
943 -Constraint
944 -)))|constraintAgencyId:ContentConstraintId(versio n)|TFFS:CREDITOR_DATA_CONTENT(1.0)
945 -|(((
946 -*Attachment
947 -
948 -Constraint
949 -)))|(((
831 +|(% style="width:270px" %)(((
832 +*Content Constraint
833 +)))|(% style="width:454px" %)constraintAgencyId:ContentConstraintId(versio n)|(% style="width:549px" %)TFFS:CREDITOR_DATA_CONTENT(1.0)
834 +|(% style="width:270px" %)(((
835 +*Attachment Constraint
836 +)))|(% style="width:454px" %)(((
950 950  constraintAgencyId:
951 951  
952 952  attachmentConstraintId(version)
953 -)))|TFFS:CREDITOR_DATA_ATTACHMENT_CONSTRAINT_ONE(1.0)
954 -|*Metadataflow|metadataflowAgencyId: metadataflowId(version)|IMF:SDDS_FLOW(1.0)
955 -|*StructureSet|structureSetAgencyId: structureSetId(version)|SDMX:BOP_STRUCTURES(1.0)
956 -|StructureMap|structureSetAgencyId: structureSetId(version). structureMapId|SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2
957 -|Component Map|(((
840 +)))|(% style="width:549px" %)TFFS:CREDITOR_DATA_ATTACHMENT_CONSTRAINT_ONE(1.0)
841 +|(% style="width:270px" %)*Metadataflow|(% style="width:454px" %)metadataflowAgencyId: metadataflowId(version)|(% style="width:549px" %)IMF:SDDS_FLOW(1.0)
842 +|(% style="width:270px" %)*StructureSet|(% style="width:454px" %)structureSetAgencyId: structureSetId(version)|(% style="width:549px" %)SDMX:BOP_STRUCTURES(1.0)
843 +|(% style="width:270px" %)StructureMap|(% style="width:454px" %)structureSetAgencyId: structureSetId(version). structureMapId|(% style="width:549px" %)SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2
844 +|(% style="width:270px" %)Component Map|(% style="width:454px" %)(((
958 958  structureSetAgencyId: structureSetId(version).
959 959  
960 960  structureMapId. componentMapId
961 -)))|SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2. REFAREA_REPCOUNTRY
962 -|CodelistMap|structureSetAgencyId: structureSetId(version). codelistMapId|SDMX:BOP_STRUCTURES(1.0).CLREFAREA_CLREPCOUNTRY
963 -|CodeMap|structureSetAgencyId: structureSetId(version).|SDMX:BOP_STRUCTURES(1.0).CLREFAREA_CLREPCOUNTRY. DE_GER
964 -
965 -
966 -
967 -| |(((
848 +)))|(% style="width:549px" %)SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2. REFAREA_REPCOUNTRY
849 +|(% style="width:270px" %)CodelistMap|(% style="width:454px" %)structureSetAgencyId: structureSetId(version). codelistMapId|(% style="width:549px" %)SDMX:BOP_STRUCTURES(1.0).CLREFAREA_CLREPCOUNTRY
850 +|(% style="width:270px" %)CodeMap|(% style="width:454px" %)structureSetAgencyId: structureSetId(version).
968 968  codeListMapId.
852 +codeMapId|(% style="width:549px" %)SDMX:BOP_STRUCTURES(1.0).CLREFAREA_CLREPCOUNTRY. DE_GER
969 969  
970 -codeMapId
971 -)))|
972 -|(((
973 -Category
974 -
975 -SchemeMap
976 -)))|structureSetAgencyId: structureSetId(version). categorySchemeMapId|SDMX:BOP_STRUCTURES(1.0).SDMX_EUROSTAT
977 -|CategoryMap|structureSetAgencyId: structureSetId(version). categorySchemeMapId. categoryMapId|SDMX:BOP_STRUCTURES(1.0).SDMX_EUROSTAT.TOURISM_M AP
978 -|Organisation SchemeMap|structureSetAgencyId: structureSetId(version). organisationSchemeMapId|SDMX:BOP_STRUCTURES(1.0).DATA_PROVIDER_MAP
979 -|Organisation Map|structureSetAgencyId: structureSetId(version). organisationSchemeMapId. organisationMapId|SDMX:BOP_STRUCTURES(1.0).DATA_PROVIDER_MAP.IMF_1C0
980 -|(((
854 +(% style="width:1279.29px" %)
855 +|(% style="width:271px" %)(((
856 +CategorySchemeMap
857 +)))|(% style="width:453px" %)structureSetAgencyId: structureSetId(version). categorySchemeMapId|(% style="width:551px" %)SDMX:BOP_STRUCTURES(1.0).SDMX_EUROSTAT
858 +|(% style="width:271px" %)CategoryMap|(% style="width:453px" %)structureSetAgencyId: structureSetId(version). categorySchemeMapId. categoryMapId|(% style="width:551px" %)SDMX:BOP_STRUCTURES(1.0).SDMX_EUROSTAT.TOURISM_MAP
859 +|(% style="width:271px" %)Organisation SchemeMap|(% style="width:453px" %)structureSetAgencyId: structureSetId(version). organisationSchemeMapId|(% style="width:551px" %)SDMX:BOP_STRUCTURES(1.0).DATA_PROVIDER_MAP
860 +|(% style="width:271px" %)Organisation Map|(% style="width:453px" %)structureSetAgencyId: structureSetId(version). organisationSchemeMapId. organisationMapId|(% style="width:551px" %)SDMX:BOP_STRUCTURES(1.0).DATA_PROVIDER_MAP.IMF_1C0
861 +|(% style="width:271px" %)(((
981 981  Concept
982 982  
983 983  SchemeMap
984 -)))|structureSetAgencyId: structureSetId(version). conceptSchemeMapId|SDMX:BOP_STRUCTURES(1.0).SDMX_OECD
985 -|ConceptMap|(((
865 +)))|(% style="width:453px" %)structureSetAgencyId: structureSetId(version). conceptSchemeMapId|(% style="width:551px" %)SDMX:BOP_STRUCTURES(1.0).SDMX_OECD
866 +|(% style="width:271px" %)ConceptMap|(% style="width:453px" %)(((
986 986  structureSetAgencyId: structureSetId(version). conceptSchemeMapId.
987 -
988 988  conceptMapId
989 -
990 -
991 -)))|SDMX:BOP_STRUCTURES(1.0).SDMX_OECD.COVERAGE_AVAI LABILITY
992 -|(((
993 -Reporting
994 -
995 -TaxonomyMap
996 -)))|structureSetAgencyId: structureSetId(version). reportingTaxonomyMapId|SDMX:BOP_STRUCTURES(1.0).TAXMAP
997 -|(((
998 -Reporting
999 -
1000 -CategoryMap
1001 -)))|(((
869 +)))|(% style="width:551px" %)SDMX:BOP_STRUCTURES(1.0).SDMX_OECD.COVERAGE_AVAI LABILITY
870 +|(% style="width:271px" %)(((
871 +ReportingTaxonomyMap
872 +)))|(% style="width:453px" %)structureSetAgencyId: structureSetId(version). reportingTaxonomyMapId|(% style="width:551px" %)SDMX:BOP_STRUCTURES(1.0).TAXMAP
873 +|(% style="width:271px" %)(((
874 +ReportingCategoryMap
875 +)))|(% style="width:453px" %)(((
1002 1002  structureSetAgencyId: structureSetId(version).
1003 -
1004 1004  reportngCategoryId
1005 -)))|SDMX:BOP_STRUCTURES(1.0).TAXMAP.TOPCAT
878 +)))|(% style="width:551px" %)SDMX:BOP_STRUCTURES(1.0).TAXMAP.TOPCAT
1006 1006  
1007 -
1008 -
1009 -|(((
1010 -HybridCodelist
1011 -
1012 -Map
1013 -)))|structureSetAgencyId: structureSetId(version). hybridCodelistMapId.|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP
1014 -|HybridCodeMap|structureSetAgencyId: structureSetId(version). hybridCodelistMapId. hybridCodeMapId|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP.CO DEMAP1
1015 -|*Process|processAgencyId: processId{version]|BIS:PROCESS1(1.0)
1016 -|ProcessStep|(((
880 +(% style="width:1282.29px" %)
881 +|(% style="width:272px" %)(((
882 +HybridCodelistMap
883 +)))|(% style="width:450px" %)structureSetAgencyId: structureSetId(version).
884 +hybridCodelistMapId.|(% style="width:557px" %)SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP
885 +|(% style="width:272px" %)HybridCodeMap|(% style="width:450px" %)structureSetAgencyId: structureSetId(version). hybridCodelistMapId. hybridCodeMapId|(% style="width:557px" %)SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP.CO DEMAP1
886 +|(% style="width:272px" %)*Process|(% style="width:450px" %)processAgencyId: processId{version]|(% style="width:557px" %)BIS:PROCESS1(1.0)
887 +|(% style="width:272px" %)ProcessStep|(% style="width:450px" %)(((
1017 1017  processAgencyId: processId(version).
1018 -
1019 1019  processStepId
1020 -)))|BIS:PROCESS1(1.0).STEP1
1021 -|Transition|(((
890 +)))|(% style="width:557px" %)BIS:PROCESS1(1.0).STEP1
891 +|(% style="width:272px" %)Transition|(% style="width:450px" %)(((
1022 1022  processAgencyId: processId(version).
1023 -
1024 1024  processStepId transitionId
1025 -)))|BIS:PROCESS1(1.0).STEP1.TRANSITION1
1026 -|Subscription|The Subscription is not itself an Identifiable Artefact and therefore it does not follow the rules for URN structure, The name of the URN is registryURN There is no pre-determined format.|This cannot be generated by a common mechanism as subscriptions, although maintainable in the sense that they can be submitted and deleted, are not mandated to be created by a maintenance agency, and have no versioning mechanism. It is therefore the responsibility of the target registry to generate a unique Id for the Subscription, and for the application creating the subscription to store the registryURN that is returned from the registry in the subscription response message.
1027 -|(((
1028 -*Transformation
1029 -
1030 -Scheme
1031 -)))|transformationSchemeAgencyId transformationSchemeId(version)|ECB: TRANSFORMATION_SCHEME(1.0)
1032 -|Transformation|(((
894 +)))|(% style="width:557px" %)BIS:PROCESS1(1.0).STEP1.TRANSITION1
895 +|(% style="width:272px" %)Subscription|(% style="width:450px" %)The [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] is not itself an [[Identifiable Artefact>>doc:sdmx:Glossary.Identifiable artefact.WebHome]] and therefore it does not follow the rules for URN structure, The name of the URN is registryURN There is no pre-determined format.|(% style="width:557px" %)This cannot be generated by a common mechanism as [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]], although maintainable in the sense that they can be submitted and deleted, are not mandated to be created by a [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]], and have no versioning mechanism. It is therefore the responsibility of the target registry to generate a unique Id for the [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]], and for the application creating the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] to store the registryURN that is returned from the registry in the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] response message.
896 +|(% style="width:272px" %)(((
897 +*Transformation Scheme
898 +)))|(% style="width:450px" %)transformationSchemeAgencyId transformationSchemeId(version)|(% style="width:557px" %)ECB: TRANSFORMATION_SCHEME(1.0)
899 +|(% style="width:272px" %)Transformation|(% style="width:450px" %)(((
1033 1033  transformationSchemeAgencyId transformationSchemeId(version)
1034 -
1035 1035  transformationId
1036 -)))|ECB:TRANSFORMATION_SCHEME(1.0).TRANS_1
1037 -|CustomType Scheme|customTypeSchemeAgencyId customTypeSchemeId(version)|ECB:CUSTOM_TYPE_SCHEME(1.0)
902 +)))|(% style="width:557px" %)ECB:TRANSFORMATION_SCHEME(1.0).TRANS_1
903 +|(% style="width:272px" %)CustomType Scheme|(% style="width:450px" %)customTypeSchemeAgencyId customTypeSchemeId(version)|(% style="width:557px" %)ECB:CUSTOM_TYPE_SCHEME(1.0)
1038 1038  
1039 -
1040 -
1041 -|CustomType|customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|ECB: CUSTOM_TYPE_SCHEME(1.0).CUSTOM_TYPE_1
1042 -|(((
905 +(% style="width:1281.29px" %)
906 +|(% style="width:275px" %)CustomType|(% style="width:450px" %)customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|(% style="width:552px" %)ECB: CUSTOM_TYPE_SCHEME(1.0).CUSTOM_TYPE_1
907 +|(% style="width:275px" %)(((
1043 1043  Name
1044 -
1045 1045  Personalisation
1046 -
1047 1047  Scheme
1048 -)))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|ECB:PSN_SCHEME(1.0)
1049 -|(((
911 +)))|(% style="width:450px" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|(% style="width:552px" %)ECB:PSN_SCHEME(1.0)
912 +|(% style="width:275px" %)(((
1050 1050  Name
1051 -
1052 1052  Personalisation
1053 -)))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|ECB:PSN_SCHEME(1.0).PSN1234
1054 -|VtlMapping Scheme|vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|ECB:CLIST_MP(2.0)
1055 -|VtlCodelist Mapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|ECB:CLIST_MP(2.0).ABZ
1056 -|VtlConcept Mapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|ECB:CLIST_MP(1.0).XYA
1057 -|VtlDataflow Mapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|ECB:CLIST_MP(1.0).MOQ
1058 -|(((
915 +)))|(% style="width:450px" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)
916 +namePersonalisationId|(% style="width:552px" %)ECB:PSN_SCHEME(1.0).PSN1234
917 +|(% style="width:275px" %)VtlMapping Scheme|(% style="width:450px" %)vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|(% style="width:552px" %)ECB:CLIST_MP(2.0)
918 +|(% style="width:275px" %)VtlCodelist Mapping|(% style="width:450px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|(% style="width:552px" %)ECB:CLIST_MP(2.0).ABZ
919 +|(% style="width:275px" %)VtlConcept Mapping|(% style="width:450px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|(% style="width:552px" %)ECB:CLIST_MP(1.0).XYA
920 +|(% style="width:275px" %)VtlDataflow Mapping|(% style="width:450px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|(% style="width:552px" %)ECB:CLIST_MP(1.0).MOQ
921 +|(% style="width:275px" %)(((
1059 1059  VtlConcept
1060 1060  
1061 1061  SchemeMapping
1062 -)))|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptSchemeId|ECB:CLIST_MP(1.0).Z11
1063 -|RulesetScheme|rulesetSchemeAgencyId rulesetSchemeId(version)|ECB:RULESET_23(1.0)
1064 -|Ruleset|rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|ECB:RULESET_23(1.0).SET111
1065 -|(((
1066 -UserDefined
925 +)))|(% style="width:450px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptSchemeId|(% style="width:552px" %)ECB:CLIST_MP(1.0).Z11
926 +|(% style="width:275px" %)RulesetScheme|(% style="width:450px" %)rulesetSchemeAgencyId rulesetSchemeId(version)|(% style="width:552px" %)ECB:RULESET_23(1.0)
927 +|(% style="width:275px" %)Ruleset|(% style="width:450px" %)rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|(% style="width:552px" %)ECB:RULESET_23(1.0).SET111
928 +|(% style="width:275px" %)(((
929 +UserDefinedOperatorScheme
930 +)))|(% style="width:450px" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|(% style="width:552px" %)ECB:OS_CALC(1.2)
931 +|(% style="width:275px" %)UserDefined Operator|(% style="width:450px" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|(% style="width:552px" %)ECB:OS_CALC(1.2).OS267
1067 1067  
1068 -OperatorScheme
1069 -)))|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|ECB:OS_CALC(1.2)
1070 -|UserDefined Operator|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|ECB:OS_CALC(1.2).OS267
933 +**Table 3: Table of identification components for SDMX Identifiable Artefacts**
1071 1071  
1072 -7**Table 3: Table of identification components for SDMX Identifiable Artefacts**
1073 -
1074 -
1075 1075  = 7 Implementation Notes =
1076 1076  
1077 1077  == 7.1 Structural Definition Metadata ==
... ... @@ -1078,142 +1078,102 @@
1078 1078  
1079 1079  === 7.1.1 Introduction ===
1080 1080  
1081 -The SDMX Registry must have the ability to support agencies in their role of defining and disseminating structural metadata artefacts. These artefacts include data structure definitions, code lists, concepts etc. and are fully defined in the SDMX-IM. An authenticated agency may submit valid structural metadata definitions which must be stored in the registry. Note that the term “structural metadata” refers as a general term to all structural components (Data structure Definitions, Metadata Structure Definitions, Code lists, Concept Schemes, etc.)
941 +The [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] must have the ability to support agencies in their role of defining and disseminating [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]. These [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] include [[data structure definitions>>doc:sdmx:Glossary.Data structure definition.WebHome]], [[code lists>>doc:sdmx:Glossary.Code list.WebHome]], [[concepts>>doc:sdmx:Glossary.Concept.WebHome]] etc. and are fully defined in the [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]. An authenticated agency may submit valid [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] definitions which must be stored in the registry. Note that the term “[[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]]” refers as a general term to all structural [[components>>doc:sdmx:Glossary.Component.WebHome]] ([[Data structure Definitions>>doc:sdmx:Glossary.Data structure definition.WebHome]], [[Metadata Structure Definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], [[Code lists>>doc:sdmx:Glossary.Code list.WebHome]], [[Concept Schemes>>doc:sdmx:Glossary.Concept scheme.WebHome]], etc.)
1082 1082  
1083 -At a minimum, structural metadata definitions may be submitted to and queried from the registry via an HTTP/HTTPS POST in the form of one of the SDMX-ML registry messages for structural metadata and the SDMX Query message for structure queries. The use of SOAP is also recommended, as described in the SDMX Web Services Guidelines. The message may contain all structural metadata items for the whole registry, structural metadata items for one maintenance agency, or individual structural metadata items.
943 +At a minimum, [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] definitions may be submitted to and queried from the registry via an HTTP/HTTPS POST in the form of one of the [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] registry messages for [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] and the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Query message for structure queries. The use of SOAP is also recommended, as described in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Web Services Guidelines. The message may contain all [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] items for the whole registry, [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] items for one [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]], or individual [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] items.
1084 1084  
1085 -Structural metadata items
945 +[[Structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] items
1086 1086  
1087 -* may only be modified by the maintenance agency which created them
947 +* may only be modified by the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] which created them
1088 1088  * may only be deleted by the agency which created them
1089 1089  * may not be deleted if they are referenced from other constructs in the Registry
1090 1090  
1091 -The level of granularity for the maintenance of SDMX Structural Metadata objects in the registry is the Maintainable Artefact. In other words, any function such as add, modify, delete is at the level of the Maintainable Artefact. For instance, if a Code is added to a Code List, or the Name of a Code is changed, the Registry must replace the existing Code List with the submitted Code List of the same Maintenance Agency, Code List, Id and Version.
951 +The [[level>>doc:sdmx:Glossary.Level.WebHome]] of granularity for the maintenance of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[Structural Metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] objects in the registry is the [[Maintainable Artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]]. In other words, any function such as add, modify, delete is at the [[level>>doc:sdmx:Glossary.Level.WebHome]] of the [[Maintainable Artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]]. For instance, if a [[Code>>doc:sdmx:Glossary.Code.WebHome]] is added to a [[Code List>>doc:sdmx:Glossary.Code list.WebHome]], or the Name of a [[Code>>doc:sdmx:Glossary.Code.WebHome]] is changed, the Registry must replace the existing [[Code List>>doc:sdmx:Glossary.Code list.WebHome]] with the submitted [[Code List>>doc:sdmx:Glossary.Code list.WebHome]] of the same [[Maintenance Agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]], [[Code List>>doc:sdmx:Glossary.Code list.WebHome]], Id and Version.
1092 1092  
1093 -The following table lists the Maintainable Artefacts.
953 +The following table lists the [[Maintainable Artefacts>>doc:sdmx:Glossary.Maintainable artefact.WebHome]].
1094 1094  
1095 -|(% colspan="4" %)**Maintainable Artefacts**|(% colspan="2" %)**Content**|
1096 -|(% colspan="2" %)**Abstract Class**|(% colspan="2" %)**Concrete Class**|(% colspan="2" %) |
1097 -|(% colspan="2" %)Item Scheme|(% colspan="2" %)Codelist|(% colspan="2" %)Code|
1098 -|(% colspan="2" %) |(% colspan="2" %)Concept Scheme|(% colspan="2" %)Concept|
1099 -|(% colspan="2" %) |(% colspan="2" %)Category Scheme|(% colspan="2" %)Category|
1100 -|(% colspan="2" %) |(% colspan="2" %)Organisation Unit Scheme|(% colspan="2" %)Organisation Unit|
1101 -|(% colspan="2" %) |(% colspan="2" %)Agency Scheme|(% colspan="2" %)Agency|
1102 -|(% colspan="2" %) |(% colspan="2" %)Data Provider Scheme|(% colspan="2" %)Data Provider|
1103 -|(% colspan="2" %) |(% colspan="2" %)Data Consumer Scheme|(% colspan="2" %)Data Consumer|
1104 -|(% colspan="2" %) |(% colspan="2" %)Reporting Taxonomy|(% colspan="2" %)Reporting Category|
1105 -|(% colspan="2" %) |(% colspan="2" %)Transformation Scheme|(% colspan="2" %)Transformation|
1106 -|(% colspan="2" %) |(% colspan="2" %)Custom Type Scheme|(% colspan="2" %)Custom Type|
1107 -| |(% colspan="4" %)**Maintainable Artefacts**|(% colspan="2" %)**Content**
1108 -| |(% colspan="2" %)**Abstract Class**|(% colspan="2" %)**Concrete Class**|(% colspan="2" %)
1109 -| |(% colspan="2" %) |(% colspan="2" %)Name Personalisation Scheme|(% colspan="2" %)Name Personalisation
1110 -| |(% colspan="2" %) |(% colspan="2" %)Vtl Mapping Scheme|(% colspan="2" %)Vtl Codelist Mapping
1111 -| |(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)Vtl Concept Mapping
1112 -| |(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)Vtl Dataflow Mapping
1113 -| |(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)(((
1114 -Vtl Concept Scheme
1115 -
1116 -Mapping
1117 -)))
1118 -| |(% colspan="2" %) |(% colspan="2" %)Ruleset Scheme|(% colspan="2" %)Ruleset
1119 -| |(% colspan="2" %) |(% colspan="2" %)User Defined Operator Scheme|(% colspan="2" %)User Defined Operator
1120 -| |(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
1121 -| |(% colspan="2" %)Structure|(% colspan="2" %)Data Structure Definition|(% colspan="2" %)(((
955 +(% style="width:640.294px" %)
956 +|(% colspan="2" rowspan="1" style="width:186px" %)**Maintainable Artefacts**|(% style="width:206px" %)**Content**
957 +|(% style="width:171px" %)**Abstract Class**|(% style="width:232px" %)**Concrete Class**|(% style="width:206px" %)
958 +|(% style="width:171px" %)Item Scheme|(% style="width:232px" %)Codelist|(% style="width:206px" %)Code
959 +|(% style="width:171px" %) |(% style="width:232px" %)Concept Scheme|(% style="width:206px" %)Concept
960 +|(% style="width:171px" %) |(% style="width:232px" %)Category Scheme|(% style="width:206px" %)Category
961 +|(% style="width:171px" %) |(% style="width:232px" %)Organisation Unit Scheme|(% style="width:206px" %)Organisation Unit
962 +|(% style="width:171px" %) |(% style="width:232px" %)Agency Scheme|(% style="width:206px" %)Agency
963 +|(% style="width:171px" %) |(% style="width:232px" %)Data Provider Scheme|(% style="width:206px" %)Data Provider
964 +|(% style="width:171px" %) |(% style="width:232px" %)Data Consumer Scheme|(% style="width:206px" %)Data Consumer
965 +|(% style="width:171px" %) |(% style="width:232px" %)Reporting Taxonomy|(% style="width:206px" %)Reporting Category
966 +|(% style="width:171px" %) |(% style="width:232px" %)Transformation Scheme|(% style="width:206px" %)Transformation
967 +|(% style="width:171px" %) |(% style="width:232px" %)Custom Type Scheme|(% style="width:206px" %)Custom Type
968 +|(% style="width:171px" %) |(% style="width:232px" %)Name Personalisation Scheme|(% style="width:206px" %)Name Personalisation
969 +|(% style="width:171px" %) |(% style="width:232px" %)Vtl Mapping Scheme|(% style="width:206px" %)Vtl Codelist Mapping
970 +|(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)Vtl Dataflow Mapping
971 +|(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)Vtl Concept Scheme Mapping
972 +|(% style="width:171px" %) |(% style="width:232px" %)Ruleset Scheme|(% style="width:206px" %)Ruleset
973 +|(% style="width:171px" %) |(% style="width:232px" %)User Defined Operator Scheme|(% style="width:206px" %)User Defined Operator
974 +|(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)User Defined Operator
975 +|(% style="width:171px" %)Structure|(% style="width:232px" %)Data Structure Definition|(% style="width:206px" %)(((
1122 1122  Dimension Descriptor
1123 -
1124 1124  Group Dimension
1125 -
1126 1126  Descriptor
1127 -
1128 1128  Dimension
1129 -
1130 1130  Measure Dimension
1131 -
1132 1132  Time Dimension
1133 -
1134 1134  Attribute Descriptor
1135 -
1136 1136  Data Attribute
1137 -
1138 1138  Measure Descriptor
1139 -
1140 1140  Primary Measure
1141 1141  )))
1142 -| |(% colspan="2" %) |(% colspan="2" %)Metadata Structure Definition|(% colspan="2" %)(((
1143 -Metadata Target,
1144 -
1145 -Dimension Descriptor
1146 -
987 +|(% style="width:171px" %) |(% style="width:232px" %)Metadata Structure Definition|(% style="width:206px" %)(((
988 +Metadata Target, Dimension Descriptor
1147 1147  Values Target Identifiable
1148 -
1149 1149  Object Target
1150 -
1151 1151  Report Period Target
1152 -
1153 1153  Data SetTarget
1154 -
1155 1155  Report Structure
1156 -
1157 1157  Metadata Attribute
1158 1158  )))
1159 -| |(% colspan="2" %)Structure Usage|(% colspan="2" %)Dataflow Definition|(% colspan="2" %)
1160 -| |(% colspan="2" %) |(% colspan="2" %)Metadataflow Definition|(% colspan="2" %)
1161 -| |(% colspan="2" %)None|(% colspan="2" %)Process|(% colspan="2" %)Process Step
1162 -| |(% colspan="2" %)None|(% colspan="2" %)Structure Set|(% colspan="2" %)(((
996 +|(% style="width:171px" %)Structure Usage|(% style="width:232px" %)Dataflow Definition|(% style="width:206px" %)
997 +|(% style="width:171px" %) |(% style="width:232px" %)Metadataflow Definition|(% style="width:206px" %)
998 +|(% style="width:171px" %)None|(% style="width:232px" %)Process|(% style="width:206px" %)Process Step
999 +|(% style="width:171px" %)None|(% style="width:232px" %)Structure Set|(% style="width:206px" %)(((
1163 1163  Component Map
1164 -
1165 1165  Concept Scheme Map
1166 -
1167 1167  Codelist Map
1168 -
1169 1169  Category Scheme Map
1170 -
1171 1171  Reporting Taxonomy Map
1172 -
1173 1173  Organisation Scheme Map
1174 -
1175 1175  Concept Map
1176 -
1177 1177  Code Map
1178 -
1179 1179  Category Map
1180 -
1181 1181  Organisation Map
1182 -
1183 1183  Reporting Category Map
1184 -
1185 1185  Hybrid Codelist Map
1186 -
1187 1187  Hybrid Code Map
1188 1188  )))
1189 -| |(% colspan="2" %)None|(% colspan="2" %)Provision Agreement|(% colspan="2" %)
1190 -| |(% colspan="2" %)None|(% colspan="2" %)Hierarchical Codelist|(% colspan="2" %)(((
1014 +|(% style="width:171px" %)None|(% style="width:232px" %)Provision Agreement|(% style="width:206px" %)
1015 +|(% style="width:171px" %)None|(% style="width:232px" %)Hierarchical Codelist|(% style="width:206px" %)(((
1191 1191  Hierarchy
1192 -
1193 1193  Hierarchical Code
1194 1194  )))
1195 -| | | | | | |
1196 1196  
1197 1197  **Table 4: Table of Maintainable Artefacts for Structural Definition Metadata**
1198 1198  
1199 1199  === 7.1.2 Item Scheme, Structure ===
1200 1200  
1201 -The artefacts included in the structural definitions are:
1024 +The [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] included in the structural definitions are:
1202 1202  
1203 -* All types of Item Scheme (Codelist, Concept Scheme, Category Scheme, Organisation Scheme - Agency Scheme, Data Provider Scheme, Data Consumer Scheme, Organisation Unit Scheme)
1204 -* All types of Structure (Data Structure Definition, Metadata Structure
1026 +* All types of [[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] ([[Codelist>>doc:sdmx:Glossary.Code list.WebHome]], [[Concept Scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]], [[Category Scheme>>doc:sdmx:Glossary.Category scheme.WebHome]], Organisation Scheme - [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]], [[Data Provider Scheme>>doc:sdmx:Glossary.Data provider scheme.WebHome]], [[Data Consumer Scheme>>doc:sdmx:Glossary.Data consumer scheme.WebHome]], Organisation Unit Scheme)
1027 +* All types of Structure ([[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], Metadata Structure Definition)
1028 +* All types of Structure Usage ([[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] Definition, [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] Definition)
1205 1205  
1206 -Definition)
1207 -
1208 -* All types of Structure Usage (Dataflow Definition, Metadataflow Definition)
1209 -
1210 1210  === 7.1.3 Structure Usage ===
1211 1211  
1212 1212  ==== 7.1.3.1 Structure Usage: Basic Concepts ====
1213 1213  
1214 -The Structure Usage defines, in its concrete classes of Dataflow Definition and
1034 +The Structure Usage defines, in its concrete classes of [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] Definition and
1215 1215  
1216 -Metadataflow Definition, which flows of data and metadata use which specific Structure, and importantly for the support of data and metadata discovery, the Structure Usage can be linked to one or more Category in one or more Category Scheme using the Categorisation mechanism. This gives the ability for an application to discover data and metadata by “drilling down” the Category Schemes.
1036 +[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] Definition, which flows of data and metadata use which specific Structure, and importantly for the support of data and metadata discovery, the Structure Usage can be linked to one or more [[Category>>doc:sdmx:Glossary.Category.WebHome]] in one or more [[Category Scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] using the Categorisation mechanism. This gives the ability for an application to discover data and metadata by “drilling down” the [[Category Schemes>>doc:sdmx:Glossary.Category scheme.WebHome]].
1217 1217  
1218 1218  ==== 7.1.3.2 Structure Usage Schematic ====
1219 1219  
... ... @@ -1223,64 +1223,68 @@
1223 1223  
1224 1224  ==== 7.1.3.3 Structure Usage Model ====
1225 1225  
1046 +[[image:1747829078194-749.png]]
1047 +
1226 1226  **Figure 10: SDMX-IM of links from Structure Usage to Category**
1227 1227  
1228 -In addition to the maintenance of the Dataflow Definition and the Metadataflow Definition the following links must be maintained in the registry:
1050 +In addition to the maintenance of the [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] Definition and the [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] Definition the following links must be maintained in the registry:
1229 1229  
1230 -* Dataflow Definition to Data Structure Definition
1231 -* Metadataflow Definition to Metadata Structure Definition
1052 +* [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] Definition to Data Structure Definition
1053 +* [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] Definition to Metadata Structure Definition
1232 1232  
1233 1233  The following links may be created by means of a Categorisation
1234 1234  
1235 -* Categorisation to Dataflow Definition and Category
1236 -* Categorisation to Metadataflow Definition and Category
1057 +* Categorisation to [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] Definition and Category
1058 +* Categorisation to [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] Definition and Category
1237 1237  
1238 1238  == 7.2 Data and Metadata Provisioning ==
1239 1239  
1240 1240  === 7.2.1 Provisioning Agreement: Basic concepts ===
1241 1241  
1242 -Data provisioning defines a framework in which the provision of different types of statistical data and metadata by various data providers can be specified and controlled. This framework is the basis on which the existence of data can be made known to the SDMX-enabled community and hence the basis on which data can subsequently be discovered. Such a framework can be used to regulate the data content to facilitate the building of intelligent applications. It can also be used to facilitate the processing implied by service level agreements, or other provisioning agreements in those scenarios that are based on legal directives. Additionally, quality and timeliness metadata can be supported by this framework which makes it practical to implement information supply chain monitoring.
1064 +Data provisioning defines a framework in which the provision of different types of statistical data and metadata by various [[data providers>>doc:sdmx:Glossary.Data provider.WebHome]] can be specified and controlled. This framework is the basis on which the existence of data can be made known to the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-enabled community and hence the basis on which data can subsequently be discovered. Such a framework can be used to regulate the data content to facilitate the building of intelligent applications. It can also be used to facilitate the processing implied by service [[level>>doc:sdmx:Glossary.Level.WebHome]] agreements, or other provisioning agreements in those scenarios that are based on legal directives. Additionally, quality and [[timeliness>>doc:sdmx:Glossary.Timeliness.WebHome]] metadata can be supported by this framework which makes it practical to implement information supply chain monitoring.
1243 1243  
1244 -Note that in the SDMX-IM the class “Data Provider” encompasses both data and metadata and the term “data provisioning” here includes both the provisioning of data and metadata.
1066 +Note that in the [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]] the class “[[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]]” encompasses both data and metadata and the term “data provisioning” here includes both the provisioning of data and metadata.
1245 1245  
1246 -Although the Provision Agreement directly supports the data-sharing “pull” model, it is also useful in “push” exchanges (bilateral and gateway scenarios), or in a dissemination environment. It should be noted, too, that in any exchange scenario, the registry functions as a repository of structural metadata.
1068 +Although the [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] directly supports the data-sharing “pull” model, it is also useful in “push” exchanges (bilateral and gateway scenarios), or in a dissemination environment. It should be noted, too, that in any exchange scenario, the registry functions as a repository of structural metadata.
1247 1247  
1248 1248  === 7.2.2 Provisioning Agreement Model – pull use case ===
1249 1249  
1250 -An organisation which publishes statistical data or reference metadata and wishes to make it available to an SDMX enabled community is called a Data Provider. In terms of the SDMX Information Model, the Data Provider is maintained in a Data Provider Scheme.
1072 +An organisation which publishes statistical data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] and wishes to make it available to an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] enabled community is called a [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]]. In terms of the [[SDMX Information Model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]], the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] is maintained in a [[Data Provider Scheme>>doc:sdmx:Glossary.Data provider scheme.WebHome]].
1251 1251  
1074 +[[image:1747829109466-595.png]]
1252 1252  
1253 1253  **Figure 11: SDMX-IM of the Data Provider**
1254 1254  
1078 +Note that the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] does not inherit the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] association. The diagram below shows a logical schematic of the data model classes required to maintain [[provision agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]]
1255 1255  
1256 -Note that the Data Provider does not inherit the hierarchy association. The diagram below shows a logical schematic of the data model classes required to maintain provision agreements
1257 -
1258 1258  [[image:1747824123019-181.jpeg]]
1259 1259  
1260 1260  **Figure 12: Schematic of the Provision Agreement**
1261 1261  
1262 -The diagram below is a logical representation of the data required in order to maintain Provision Agreements.
1084 +The diagram below is a logical [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the data required in order to maintain [[Provision Agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]].
1263 1263  
1086 +[[image:1747829139951-378.png]]
1264 1264  
1265 -==== Figure 13: Logical class diagram of the information contained in the Provision Agreement ====
1088 +(% class="wikigeneratedid" id="HFigure13:LogicalclassdiagramoftheinformationcontainedintheProvisionAgreement" %)
1089 +**Figure 13: Logical class diagram of the information contained in the Provision Agreement**
1266 1266  
1267 -A Provision Agreement is structural metadata. Each Provision Agreement must reference a Data Provider and a Dataflow or Metadataflow Definition. The Data Provider and the Dataflow/Metadataflow Definition must exist already in order to set up a Provision Agreement.
1091 +A [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] is [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]]. Each [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] must reference a [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] and a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] or [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] Definition. The [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] and the [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]/[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] Definition must exist already in order to set up a [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]].
1268 1268  
1269 1269  == 7.3 Data and Metadata Constraints ==
1270 1270  
1271 1271  === 7.3.1 Data and Metadata Constraints: Basic Concepts ===
1272 1272  
1273 -Constraints are, effectively, lists of the valid or actual content of data and metadata. Constraints can be used to specify a sub set of the theoretical content of data set or metadata set which can be derived from the specification of the DSD or MSD. A Constraint can comprise a list of keys or a list of content (usually code values) of a specific component such as a dimension or attribute.
1097 +[[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]] are, effectively, lists of the valid or actual content of data and metadata. [[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]] can be used to specify a sub set of the theoretical content of [[data set>>doc:sdmx:Glossary.Data set.WebHome]] or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] which can be derived from the specification of the [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] or [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. A [[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]] can comprise a list of keys or a list of content (usually [[code>>doc:sdmx:Glossary.Code.WebHome]] values) of a specific [[component>>doc:sdmx:Glossary.Component.WebHome]] such as a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].
1274 1274  
1275 -Constraints comprise the specification of subsets of key or target values or attribute values that are contained in a Datasource, or is to be provided for a Dataflow or Metadataflow Definition, or directly attached to a Data Structure Definition or Metadata Structure Definition. This is important metadata because, for example, the full range of possibilities which is implied by the Data Structure Definition (e.g. the complete set of valid keys is the Cartesian product of all the values in the code lists for each of the Dimensions) is often more than is actually present in any specific Datasource, or more than is intended to be supplied according to a specific Dataflow Definition.
1099 +[[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]] comprise the specification of subsets of key or target values or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values that are contained in a Datasource, or is to be provided for a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] or [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] Definition, or directly attached to a [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] or [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. This is important metadata because, for example, the full range of possibilities which is implied by the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] (e.g. the complete set of valid keys is the Cartesian product of all the values in the [[code lists>>doc:sdmx:Glossary.Code list.WebHome]] for each of the [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]) is often more than is actually present in any specific Datasource, or more than is intended to be supplied according to a specific [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] Definition.
1276 1276  
1277 -Often a Data Provider will not be able to provide data for all key combinations, either because the combination itself is not meaningful, or simply because the provider does not have the data for that combination. In this case the Data Provider could constrain the Datasource (at the level of the Provision Agreement or the Data Provider) by supplying metadata that defines the key combinations or cube regions that are available. This is done by means of a Constraint. The Content Constraint is also used to define a code list sub set which is used to populate a Partial Code List.
1101 +Often a [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] will not be able to provide data for all key combinations, either because the combination itself is not meaningful, or simply because the provider does not have the data for that combination. In this case the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] could constrain the Datasource (at the [[level>>doc:sdmx:Glossary.Level.WebHome]] of the [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] or the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]]) by supplying metadata that defines the key combinations or cube regions that are available. This is done by means of a [[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]]. The Content [[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]] is also used to define a [[code list>>doc:sdmx:Glossary.Code list.WebHome]] sub set which is used to populate a Partial [[Code List>>doc:sdmx:Glossary.Code list.WebHome]].
1278 1278  
1279 -Furthermore, it is often useful to define subsets or views of the Data Structure Definition which restrict values in some code lists, especially where many such subsets restrict the same Data Structure Definition. Such a view is called a Dataflow Definition, and there can be one or more defined for any Data Structure Definition.
1103 +Furthermore, it is often useful to define subsets or views of the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] which restrict values in some [[code lists>>doc:sdmx:Glossary.Code list.WebHome]], especially where many such subsets restrict the same [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. Such a view is called a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] Definition, and there can be one or more defined for any [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]].
1280 1280  
1281 -Whenever data is published or made available by a Data Provider, it must conform to a Dataflow Definition (and hence to a Data Structure Definition). The Dataflow Definition is thus a means of enabling content based processing.
1105 +Whenever data is published or made available by a [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]], it must conform to a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] Definition (and hence to a [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]). The [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] Definition is thus a means of enabling content based processing.
1282 1282  
1283 -In addition, Constraints can be extremely useful in a data visualisation system, such as dissemination of statistics on a website. In such a system a Cube Region can be used to specify the Dimension codes that actually exist in a datasource (these can be used to build relevant selection tables), and the Key Set can be used to specify the keys that exist in a datasource (these can be used to guide the user to select only those Dimension code values that will return data based on the Dimension values already selected).
1107 +In addition, [[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]] can be extremely useful in a data visualisation system, such as dissemination of statistics on a website. In such a system a Cube Region can be used to specify the [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] [[codes>>doc:sdmx:Glossary.Code.WebHome]] that actually exist in a datasource (these can be used to build relevant selection tables), and the Key Set can be used to specify the keys that exist in a datasource (these can be used to guide the user to select only those [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] [[code>>doc:sdmx:Glossary.Code.WebHome]] values that will return data based on the [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values already selected).
1284 1284  
1285 1285  === 7.3.2 Data and Metadata Constraints: Schematic ===
1286 1286  
... ... @@ -1290,26 +1290,25 @@
1290 1290  
1291 1291  === 7.3.3 Data and Metadata Constraints: Model ===
1292 1292  
1117 +[[image:1747829204737-370.png]]
1293 1293  
1119 +**Figure 15: Logical class diagram showing inheritance between and reference to constrainable artifacts**
1294 1294  
1295 -==== Figure 15: Logical class diagram showing inheritance between and reference to constrainable artifacts ====
1121 +The class diagram above shows that DataProvider, DataflowDefinition, MetadataflowDefinition, ProvisionAgreement, DataStructureDefinition, MetadataStructureDefinition, SimpleDatasource and QueryDatasource are all concrete sub-classes of ConstrainableArtefact and can therefore have [[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]] specified. Note that the actual [[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]] as submitted is associated to the reference classes which inherit from ConstrainableRef: these are used to refer to the classes to which the [[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]] applies.
1296 1296  
1297 -The class diagram above shows that DataProvider, DataflowDefinition, MetadataflowDefinition, ProvisionAgreement, DataStructureDefinition, MetadataStructureDefinition, SimpleDatasource and QueryDatasource are all concrete sub-classes of ConstrainableArtefact and can therefore have Constraints specified. Note that the actual Constraint as submitted is associated to the reference classes which inherit from ConstrainableRef: these are used to refer to the classes to which the Constraint applies.
1123 +The content of the [[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]] can be found in the [[SDMX Information Model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]] document.
1298 1298  
1299 -
1300 -The content of the Constraint can be found in the SDMX Information Model document.
1301 -
1302 1302  == 7.4 Data and Metadata Registration ==
1303 1303  
1304 1304  === 7.4.1 Basic Concepts ===
1305 1305  
1306 -A Data Provider has published a new dataset conforming to an existing Dataflow Definition (and hence Data Structure Definition). This is implemented as either a web-accessible SDMX-ML file, or in a database which has a web-services interface capable of responding to an SDMX-ML Query or RESTful query with an SDMX-ML data stream.
1129 +A [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] has published a new [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] conforming to an existing [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] Definition (and hence [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]). This is implemented as either a web-accessible [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] file, or in a database which has a web-services interface capable of responding to an [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] Query or RESTful query with an [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] data stream.
1307 1307  
1308 -The Data Provider wishes to make this new data available to one or more data collectors in a “pull” scenario, or to make the data available to data consumers. To do this, the Data Provider registers the new dataset with one or more SDMX conformant registries that have been configured with structural and provisioning metadata. In other words, the registry “knows” the Data Provider and “knows” what data flows the data provider has agreed to make available.
1131 +The [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] wishes to make this new data available to one or more data collectors in a “pull” scenario, or to make the data available to [[data consumers>>doc:sdmx:Glossary.Data consumer.WebHome]]. To do this, the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] registers the new [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] with one or more [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] conformant registries that have been configured with structural and provisioning metadata. In other words, the registry “knows” the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] and “knows” what [[data flows>>doc:sdmx:Glossary.Dataflow.WebHome]] the [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] has agreed to make available.
1309 1309  
1310 -The same mechanism can be used to report or make available a metadata set.
1133 +The same mechanism can be used to report or make available a [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].
1311 1311  
1312 -SDMX-RR supports dataset and metadata set registration via the Registration Request, which can be created by the Data Provider (giving the Data Provider maximum control). The registry responds to the registration request with a registration response which indicates if the registration was successful. In the event of an error, the error messages are returned as a registry exception within the response.
1135 +[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-RR supports [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] and [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] registration via the Registration Request, which can be created by the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] (giving the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] maximum control). The registry responds to the registration request with a registration response which indicates if the registration was successful. In the event of an error, the error messages are returned as a registry exception within the response.
1313 1313  
1314 1314  === 7.4.2 The Registration Request ===
1315 1315  
... ... @@ -1317,11 +1317,11 @@
1317 1317  
1318 1318  [[image:1747824123025-411.jpeg]]
1319 1319  
1320 - **Figure 16: Schematic of the Objects Concerned with Registration**
1143 +**Figure 16: Schematic of the Objects Concerned with Registration**
1321 1321  
1322 1322  ==== 7.4.2.2 Registration Request Model ====
1323 1323  
1324 -The following UML diagram shows the composition of the registration request. Each request is made up of one or more Registrations, one per dataset or metadata set to be registered. The Registration can optionally have information which has been extracted from the Registration:
1147 +The following UML diagram shows the composition of the registration request. Each request is made up of one or more Registrations, one per [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] to be registered. The Registration can optionally have information which has been extracted from the Registration:
1325 1325  
1326 1326  * validFrom
1327 1327  * validTo
... ... @@ -1329,175 +1329,154 @@
1329 1329  
1330 1330  The last updated date is useful during the discovery process to make sure the client knows which data is freshest.
1331 1331  
1332 -The Registration has an action attribute which takes one of the following values:
1155 +The Registration has an action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] which takes one of the following values:
1333 1333  
1334 -|**Action Attribute Value**|**Behaviour**
1335 -|Append|Add this Registration to the registry
1336 -|Replace|Replace the existing Registration with identified by the id in the Registration of the Submit Registration Request
1337 -|Delete|Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
1157 +(% style="width:798.294px" %)
1158 +|(% style="width:212px" %)**Action Attribute Value**|(% style="width:582px" %)**Behaviour**
1159 +|(% style="width:212px" %)Append|(% style="width:582px" %)Add this Registration to the registry
1160 +|(% style="width:212px" %)Replace|(% style="width:582px" %)Replace the existing Registration with identified by the id in the Registration of the Submit Registration Request
1161 +|(% style="width:212px" %)Delete|(% style="width:582px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
1338 1338  
1163 +[[image:1747829290890-122.png]]
1164 +
1339 1339  **Figure 17: Logical Class Diagram of Registration of Data and Metadata**
1340 1340  
1341 -The Query Datasource is an abstract class that represents a data source which can understand an SDMX-ML query (SOAPDatasource) or RESTful query
1167 +The Query Datasource is an abstract class that represents a [[data source>>doc:sdmx:Glossary.Data source.WebHome]] which can understand an [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] query (SOAPDatasource) or RESTful query
1342 1342  
1343 1343  (RESTDatasource) and respond appropriately. Each of these different Datasources inherit the dataURL from Datasource, and the QueryDatasource has an additional URL to locate a WSDL or WADL document to describe how to access it. All other supported protocols are assumed to use the Simple Datasource URL.
1344 1344  
1345 -A Simple Datasource is used to reference a physical SDMX-ML file that is available at a URL.
1171 +A Simple Datasource is used to reference a physical [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] file that is available at a URL.
1346 1346  
1347 -The Registration Request has an action attribute which defines whether this is a new (append) or updated (replace) Registration, or that the Registration is to be deleted (delete). The id is only provided for the replace and delete actions, as the Registry will allocate the unique id of the (new) Registration.
1173 +The Registration Request has an action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] which defines whether this is a new (append) or updated (replace) Registration, or that the Registration is to be deleted (delete). The id is only provided for the replace and delete actions, as the Registry will allocate the unique id of the (new) Registration.
1348 1348  
1349 -The Registration includes attributes that state how a Simple Datasource is to be indexed when registered. The Registry registration process must act as follows.
1175 +The Registration includes [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] that state how a Simple Datasource is to be indexed when registered. The Registry registration process must act as follows.
1350 1350  
1351 -Information in the data or metadata set is extracted and placed in one or more Content Constraints (see the Constraints model in the SDMX Information Model – Section 2 of the SDMX Standards). The information to be extracted is indicated by the Boolean values set on the Provision Agreement as shown in the table below.
1177 +Information in the data or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] is extracted and placed in one or more Content [[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]] (see the [[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]] model in the [[SDMX Information Model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]] – Section 2 of the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Standards). The information to be extracted is indicated by the Boolean values set on the [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] as shown in the table below.
1352 1352  
1353 -|**Indexing Required**|**Registration Process Activity**
1354 -|indexTimeSeries|Extract all the series keys and create a KeySet(s) Constraint.
1355 -|indexDataSet|(((
1356 -Extract all the codes and other content of the Key value of the Series Key in a Data Set and create one or more Cube
1357 -
1358 -Regions containing Member Selections of Dimension Components of the Constraints model in the SDMX-IM, and the associated Selection Value.
1179 +(% style="width:860.294px" %)
1180 +|(% style="width:185px" %)**Indexing Required**|(% style="width:672px" %)**Registration Process Activity**
1181 +|(% style="width:185px" %)indexTimeSeries|(% style="width:672px" %)Extract all the [[series keys>>doc:sdmx:Glossary.Series key.WebHome]] and create a KeySet(s) Constraint.
1182 +|(% style="width:185px" %)indexDataSet|(% style="width:672px" %)(((
1183 +Extract all the [[codes>>doc:sdmx:Glossary.Code.WebHome]] and other content of the Key value of the [[Series Key>>doc:sdmx:Glossary.Series key.WebHome]] in a [[Data Set>>doc:sdmx:Glossary.Data set.WebHome]] and create one or more Cube Regions containing [[Member Selections>>doc:sdmx:Glossary.Member selection.WebHome]] of [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] [[Components>>doc:sdmx:Glossary.Component.WebHome]] of the [[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]] model in the [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]], and the associated Selection Value.
1359 1359  )))
1360 -|indexReportingPeriod|(((
1361 -This applies only to a registered dataset.
1362 -
1363 -Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint.
1185 +|(% style="width:185px" %)indexReportingPeriod|(% style="width:672px" %)(((
1186 +This applies only to a registered [[dataset>>doc:sdmx:Glossary.Data set.WebHome]].
1187 +Extract the Reporting Begin and Reporting End from the Header of the Message containing the [[data set>>doc:sdmx:Glossary.Data set.WebHome]], and create a [[Reference Period>>doc:sdmx:Glossary.Reference period.WebHome]] constraint.
1364 1364  )))
1365 -|indexAttributes|(((
1366 -**Data Set**
1367 -
1368 -Extract the content of the Attribute Values in a Data Set and create one or more Cube Regions containing Member Selections of Data Attribute Components of the Constraints model in the SDMXIM, and the associated Selection Value
1369 -
1370 -**Metadata Set**
1371 -
1372 -Indicate the presence of a Reported Attribute by creating one or more Cube Regions containing Member Selections of Metadata Attribute Components of the Constraints model in the SDMX-IM. Note that the content is not stored in the Selection Value.
1189 +|(% style="width:185px" %)indexAttributes|(% style="width:672px" %)(((
1190 +**[[Data Set>>doc:sdmx:Glossary.Data set.WebHome]]**
1191 +Extract the content of the [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Values in a [[Data Set>>doc:sdmx:Glossary.Data set.WebHome]] and create one or more Cube Regions containing [[Member Selections>>doc:sdmx:Glossary.Member selection.WebHome]] of Data [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] [[Components>>doc:sdmx:Glossary.Component.WebHome]] of the [[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]] model in the SDMXIM, and the associated Selection Value
1192 +**[[Metadata Set>>doc:sdmx:Glossary.Metadata set.WebHome]]**
1193 +Indicate the presence of a Reported [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] by creating one or more Cube Regions containing [[Member Selections>>doc:sdmx:Glossary.Member selection.WebHome]] of Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] [[Components>>doc:sdmx:Glossary.Component.WebHome]] of the [[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]] model in the [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]. Note that the content is not stored in the Selection Value.
1373 1373  )))
1374 1374  
1375 -Constraints that specify the contents of a Query Datasource are submitted to the Registry in a Submit Structure Request.
1196 +[[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]] that specify the contents of a Query Datasource are submitted to the Registry in a Submit Structure Request.
1376 1376  
1377 -The Registration must reference the Provision Agreement to which it relates.
1198 +The Registration must reference the [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] to which it relates.
1378 1378  
1379 1379  === 7.4.3 Registration Response ===
1380 1380  
1381 -After a registration request has been submitted to the registry, a response is returned to the submitter indicating success or failure. Given that a registration request can hold many Registrations, then there must be a registration status for each Registration. The Submit Registration class has a status field which is either set to
1202 +After a registration request has been submitted to the registry, a response is returned to the submitter indicating success or failure. Given that a registration request can hold many Registrations, then there must be a registration status for each Registration. The Submit Registration class has a status field which is either set to “Success”, “Warning” or “Failure”.
1382 1382  
1383 -“Success”, “Warning or “Failure.
1204 +If the registration has succeeded, a Registration will be returned - this holds the Registry-allocated Id of the newly registered Datasource plus a Datasource holding the URL to access the [[dataset>>doc:sdmx:Glossary.Data set.WebHome]], metadataset, or query service.
1384 1384  
1385 -If the registration has succeeded, a Registration will be returned - this holds the Registry-allocated Id of the newly registered Datasource plus a Datasource holding the URL to access the dataset, metadataset, or query service.
1206 +The Registration Response returns set of registration status (one for each registration submitted) in terms of a Status Message (this is common to all Registry Responses) that indicates success or failure. In the event of registration failure, a set of Message Text are returned, giving the error messages that occurred during registration. It is entirely possible when registering a batch of [[datasets>>doc:sdmx:Glossary.Data set.WebHome]], that the response will contain some successful and some failed statuses. The logical model for the Registration Response is shown below:
1386 1386  
1387 -The Registration Response returns set of registration status (one for each registration submitted) in terms of a Status Message (this is common to all Registry Responses) that indicates success or failure. In the event of registration failure, a set of Message Text are returned, giving the error messages that occurred during registration. It is entirely possible when registering a batch of datasets, that the response will contain some successful and some failed statuses. The logical model for the Registration Response is shown below:
1208 +[[image:1747829477882-750.png]]
1388 1388  
1389 -
1390 1390  **Figure 18: Logical class diagram showing the registration response**
1391 1391  
1392 1392  == 7.5 Subscription and Notification Service ==
1393 1393  
1394 -The contents of the SDMX Registry/Repository will change regularly: new code lists and key families will be published, new datasets and metadata-sets will be registered. To obviate the need for users to repeatedly query the registry to see when new information is available, a mechanism is provided to allow users to be notified when these events happen.
1214 +The contents of the [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]]/Repository will change regularly: new [[code lists>>doc:sdmx:Glossary.Code list.WebHome]] and key families will be published, new [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] and metadata-sets will be registered. To obviate the need for users to repeatedly query the registry to see when new information is available, a mechanism is provided to allow users to be notified when these events happen.
1395 1395  
1396 -A user can submit a subscription in the registry that defines which events are of interest, and either an email and/or an HTTP address to which a notification of qualifying events will be delivered. The subscription will be identified in the registry by a URN which is returned to the user when the subscription is created. If the user wants to delete the subscription at a later point, the subscription URN is used as identification. Subscriptions have a validity period expressed as a date range (startDate, endDate) and the registry may delete any expired subscriptions, and will notify the subscriber on expiry.
1216 +A user can submit a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] in the registry that defines which events are of interest, and either an email and/or an HTTP address to which a [[notification>>doc:sdmx:Glossary.Notification.WebHome]] of qualifying events will be delivered. The [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] will be identified in the registry by a URN which is returned to the user when the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] is created. If the user wants to delete the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] at a later point, the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] URN is used as identification. [[Subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] have a validity period expressed as a date range (startDate, endDate) and the registry may delete any expired [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]], and will notify the subscriber on expiry.
1397 1397  
1398 -When a registry/repository artefact is modified, any subscriptions which are observing the object are activated, and either an email or HTTP POST is instigated to report details of the changes to the user specified in the subscription. This is called a
1218 +When a registry/repository [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is modified, any [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] which are observing the object are activated, and either an email or HTTP POST is instigated to report details of the changes to the user specified in the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. This is called a “[[notification>>doc:sdmx:Glossary.Notification.WebHome]]”.
1399 1399  
1400 -notification”.
1220 +=== 7.5.1Subscription Logical Class Diagram ===
1401 1401  
1402 - 7.5.1Subscription Logical Class Diagram
1222 +[[image:1747829554603-150.png]]
1403 1403  
1404 -
1405 -[[image:1747824123028-257.png]]
1406 -
1407 1407  **Figure 19: Logical Class Diagram of the Subscription**
1408 1408  
1409 1409  === 7.5.2 Subscription Information ===
1410 1410  
1411 -Regardless of the type of registry/repository events being observed, a subscription always contains:
1228 +Regardless of the type of registry/repository events being observed, a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] always contains:
1412 1412  
1413 -~1. A set of URIs describing the end-points to which notifications must be sent if the subscription is activated. The URIs can be either mailto~: or http: protocol. In the former case an email notification is sent; in the latter an HTTP POST notification is sent.
1230 +1. A set of URIs describing the end-points to which [[notifications>>doc:sdmx:Glossary.Notification.WebHome]] must be sent if the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] is activated. The URIs can be either mailto~: or http: protocol. In the former case an email [[notification>>doc:sdmx:Glossary.Notification.WebHome]] is sent; in the latter an HTTP POST [[notification>>doc:sdmx:Glossary.Notification.WebHome]] is sent.
1231 +1. A user-defined identifier which is returned in the response to the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request. This helps with asynchronous processing and is NOT stored in the Registry.
1232 +1. A validity period which defines both when the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] becomes active and expires. The subscriber may be sent a [[notification>>doc:sdmx:Glossary.Notification.WebHome]] on expiration of the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]].
1233 +1. A selector which specifies which type of events are of interest. The set of event types is:
1414 1414  
1415 -2. A user-defined identifier which is returned in the response to the subscription request. This helps with asynchronous processing and is NOT stored in the Registry.
1235 +(% style="width:1031.29px" %)
1236 +|(% style="width:319px" %)**Event Type**|(% style="width:678px" %)**Comment**
1237 +|(% style="width:319px" %)STRUCTURAL_REPOSITORY_EVENTS|(% style="width:678px" %)Life-cycle changes to [[Maintainable Artefacts>>doc:sdmx:Glossary.Maintainable artefact.WebHome]] in the [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository.
1238 +|(% style="width:319px" %)DATA_REGISTRATION_EVENTS|(% style="width:678px" %)Whenever a published [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] is registered. This can be either a SDMXML data file or an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] conformant database.
1239 +|(% style="width:319px" %)METADATA_REGISTRATION_EVENTS|(% style="width:678px" %)Whenever a published metadataset is registered. This can be either a SDMXML [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] file or an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] conformant database.
1240 +|(% style="width:319px" %)ALL_EVENTS|(% style="width:678px" %)All events of the specified EventType
1416 1416  
1417 -3. A validity period which defines both when the subscription becomes active and expires. The subscriber may be sent a notification on expiration of the subscription.
1418 -
1419 -4. A selector which specifies which type of events are of interest. The set of event types is:
1420 -
1421 -|**Event Type**|**Comment**
1422 -|STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1423 -|DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
1424 -|METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
1425 -|ALL_EVENTS|All events of the specified EventType
1426 -
1427 1427  === 7.5.3 Wildcard Facility ===
1428 1428  
1429 -Subscription notification supports wildcarded identifier components URNs, which are identiiers which have some or all of their component parts replaced by the wildcard character `%`. Identifier components comprise:
1430 1430  
1431 - agencyID
1245 +[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] [[notification>>doc:sdmx:Glossary.Notification.WebHome]] supports wildcarded identifier [[components>>doc:sdmx:Glossary.Component.WebHome]] URNs, which are identiiers which have some or all of their [[component>>doc:sdmx:Glossary.Component.WebHome]] parts replaced by the wildcard character `%`. Identifier [[components>>doc:sdmx:Glossary.Component.WebHome]] comprise:
1432 1432  
1433 - id
1247 +* agencyID
1248 +* id
1249 +* version
1434 1434  
1435 - version
1251 +Examples of wildcarded identifier [[components>>doc:sdmx:Glossary.Component.WebHome]] for an identified object type of [[Codelist>>doc:sdmx:Glossary.Code list.WebHome]] are shown below.
1436 1436  
1437 -Examples of wildcarded identifier components for an identified object type of Codelist are shown below.
1438 -
1439 -AgencyID = %
1440 -
1253 +//AgencyID = %
1441 1441  Id = %
1255 +Version = %//
1442 1442  
1443 -Version = %
1257 +This subscribes to all [[Codelists>>doc:sdmx:Glossary.Code list.WebHome]] of all [[versions>>doc:sdmx:Glossary.Version.WebHome]] for all agencies.
1444 1444  
1445 -This subscribes to all Codelists of all versions for all agencies.
1446 -
1447 -AgencyID = AGENCY1
1448 -
1259 +//AgencyID = AGENCY1
1449 1449  Id = CODELIST1
1261 +Version = %//
1450 1450  
1451 -Version = %
1263 +This subscribes to all [[versions>>doc:sdmx:Glossary.Version.WebHome]] of [[Codelist>>doc:sdmx:Glossary.Code list.WebHome]] CODELIST1 maintained by the agency
1452 1452  
1453 -This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1454 -
1455 -AGENCY1
1456 -
1265 +//AGENCY1
1457 1457  AgencyID = AGENCY1
1458 -
1459 1459  Id = %
1268 +Version = %//
1460 1460  
1461 -Version = %
1270 +This subscribes to all [[versions>>doc:sdmx:Glossary.Version.WebHome]] of all [[Codelist>>doc:sdmx:Glossary.Code list.WebHome]] objects maintained by the agency
1462 1462  
1463 -This subscribes to all versions of all Codelist objects maintained by the agency
1464 -
1465 -AGENCY1
1466 -
1272 +//AGENCY1
1467 1467  AgencyID = %
1468 -
1469 1469  Id = CODELIST1
1275 +Version = %//
1470 1470  
1471 -Version = %
1277 +This subscribes to all [[versions>>doc:sdmx:Glossary.Version.WebHome]] of [[Codelist>>doc:sdmx:Glossary.Code list.WebHome]] CODELIST1 maintained by the agency
1472 1472  
1473 -This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1279 +//AGENCY1//
1474 1474  
1475 -AGENCY1
1281 +Note that if the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] is to the latest [[version>>doc:sdmx:Glossary.Version.WebHome]] then this can be achieved by the * character
1476 1476  
1477 -Note that if the subscription is to the latest version then this can be achieved by the * character
1283 +//i.e. Version = *//
1478 1478  
1479 -i.e. Version = *
1285 +Note that a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] using the URN mechanism cannot use wildcard characters.
1480 1480  
1481 -Note that a subscription using the URN mechanism cannot use wildcard characters.
1482 -
1483 1483  === 7.5.4 Structural Repository Events ===
1484 1484  
1485 -Whenever a maintainable artefact (data structure definition, concept scheme, codelist, metadata structure definition, category scheme, etc.) is added to, deleted from, or modified in the structural metadata repository, a structural metadata event is triggered. Subscriptions may be set up to monitor all such events, or focus on specific artefacts such as a Data Structure Definition.
1289 +Whenever a [[maintainable artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]] ([[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]], [[codelist>>doc:sdmx:Glossary.Code list.WebHome]], [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]], etc.) is added to, deleted from, or modified in the [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, a [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] event is triggered. [[Subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] may be set up to monitor all such events, or focus on specific [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] such as a [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]].
1486 1486  
1487 1487  === 7.5.5 Registration Events ===
1488 1488  
1489 -Whenever a dataset or metadata-set is registered a registration event is created. A subscription may be observing all data or metadata registrations, or it may focus on specific registrations as shown in the table below:
1293 +Whenever a [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] or metadata-set is registered a registration event is created. A [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] may be observing all data or metadata registrations, or it may focus on specific registrations as shown in the table below:
1490 1490  
1295 +(% style="width:974.294px" %)
1296 +|(% style="width:295px" %)**Selector**|(% style="width:677px" %)**Comment**
1297 +|(% style="width:295px" %)DataProvider|(% style="width:677px" %)Any [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] or [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]] registered by the specified [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] will activate the notification.
1298 +|(% style="width:295px" %)ProvisionAgreement|(% style="width:677px" %)Any [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] or [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]] registered for the [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] will activate the notification.
1299 +|(% style="width:295px" %)[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] (&[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]])|(% style="width:677px" %)Any [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] or [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]] registered for the specified [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] (or [[metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]) will activate the notification.
1300 +|(% style="width:295px" %)DataStructureDefinition & MetadataStructureDefinition|(% style="width:677px" %)Any [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] or [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]] registered for those [[dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]] (or [[metadataflows>>doc:sdmx:Glossary.Metadataflow.WebHome]]) that are based on the specified [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] will activate the notification.
1301 +|(% style="width:295px" %)[[Category>>doc:sdmx:Glossary.Category.WebHome]]|(% style="width:677px" %)Any [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] or [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]] registered for those [[dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]], [[metadataflows>>doc:sdmx:Glossary.Metadataflow.WebHome]], [[provision agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]] that are categorised by the [[category>>doc:sdmx:Glossary.Category.WebHome]].
1491 1491  
1492 -|**Selector**|**Comment**
1493 -|DataProvider|Any datasets or metadata sets registered by the specified data provider will activate the notification.
1494 -|ProvisionAgreement|Any datasets or metadata sets registered for the provision agreement will activate the notification.
1495 -|Dataflow (&Metadataflow)|Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
1496 -|DataStructureDefinition & MetadataStructureDefinition|Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will
1497 -|**Selector**|**Comment**
1498 -| |activate the notification.
1499 -|Category|Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category.
1500 -
1501 1501  The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration.
1502 1502  
1503 1503  == 7.6 Notification ==
... ... @@ -1504,26 +1504,26 @@
1504 1504  
1505 1505  === 7.6.1 Logical Class Diagram ===
1506 1506  
1309 +[[image:1747829675568-610.png]]
1507 1507  
1508 -==== Figure 20: Logical Class Diagram of the Notification ====
1311 +(% class="wikigeneratedid" id="HFigure20:LogicalClassDiagramoftheNotification" %)
1312 +**Figure 20: Logical Class Diagram of the Notification**
1509 1509  
1510 -A notification is an XML document that is sent to a user via email or http POST whenever a subscription is activated. It is an asynchronous one-way message.
1314 +A [[notification>>doc:sdmx:Glossary.Notification.WebHome]] is an XML document that is sent to a user via email or http POST whenever a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] is activated. It is an asynchronous one-way message.
1511 1511  
1512 -Regardless of the registry component that caused the event to be triggered, the following common information is in the message:
1316 +Regardless of the registry [[component>>doc:sdmx:Glossary.Component.WebHome]] that caused the event to be triggered, the following common information is in the message:
1513 1513  
1514 1514  * Date and time that the event occurred
1515 -* The URN of the artefact that caused the event
1516 -* The URN of the Subscription that produced the notification
1319 +* The URN of the [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] that caused the event
1320 +* The URN of the [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] that produced the [[notification>>doc:sdmx:Glossary.Notification.WebHome]]
1517 1517  * Event Action: Add, Replace, or Delete.
1518 1518  
1519 -Additionally, supplementary information may be contained in the notification as detailed below.
1323 +Additionally, supplementary information may be contained in the [[notification>>doc:sdmx:Glossary.Notification.WebHome]] as detailed below.
1520 1520  
1521 1521  === 7.6.2 Structural Event Component ===
1522 1522  
1523 -The notification will contain the MaintainableArtefact that triggered the event in a form similar to the SDMX-ML structural message (using elements from that namespace).
1327 +The [[notification>>doc:sdmx:Glossary.Notification.WebHome]] will contain the MaintainableArtefact that triggered the event in a form similar to the [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] structural message (using elements from that namespace).
1524 1524  
1525 1525  === 7.6.3 Registration Event Component ===
1526 1526  
1527 -The notification will contain the Registration.
1528 -
1529 -
1331 +The [[notification>>doc:sdmx:Glossary.Notification.WebHome]] will contain the Registration.
1747824504225-229.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.arturkryazhev
Size
... ... @@ -1,0 +1,1 @@
1 +52.8 KB
Content
1747829078194-749.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.arturkryazhev
Size
... ... @@ -1,0 +1,1 @@
1 +40.4 KB
Content
1747829109466-595.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.arturkryazhev
Size
... ... @@ -1,0 +1,1 @@
1 +30.4 KB
Content
1747829139951-378.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.arturkryazhev
Size
... ... @@ -1,0 +1,1 @@
1 +21.1 KB
Content
1747829204737-370.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.arturkryazhev
Size
... ... @@ -1,0 +1,1 @@
1 +55.8 KB
Content
1747829290890-122.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.arturkryazhev
Size
... ... @@ -1,0 +1,1 @@
1 +41.4 KB
Content
1747829477882-750.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.arturkryazhev
Size
... ... @@ -1,0 +1,1 @@
1 +24.6 KB
Content
1747829554603-150.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.arturkryazhev
Size
... ... @@ -1,0 +1,1 @@
1 +99.1 KB
Content
1747829675568-610.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.arturkryazhev
Size
... ... @@ -1,0 +1,1 @@
1 +31.1 KB
Content
1747832400104-286.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.arturkryazhev
Size
... ... @@ -1,0 +1,1 @@
1 +172.3 KB
Content
1747994320263-112.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.arturkryazhev
Size
... ... @@ -1,0 +1,1 @@
1 +13.9 KB
Content
SUZ.Methodology.Code.MethodologyClass[0]
SKMS.Methodology.Code.MethodologyClass[0]