Last modified by Artur on 2025/09/30 13:28

From version 24.2
edited by Helena
on 2025/06/08 21:34
Change comment: There is no comment for this version
To version 22.16
edited by Helena
on 2025/06/08 17:10
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -11,69 +11,69 @@
11 11  
12 12  = 1 Introduction =
13 13  
14 -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:
14 +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:
15 15  
16 -* the availability of an abstract information model capable of supporting time series and cross-sectional data, [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]], and [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] ([[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]])
17 -* standardised XML and JSON schemas for the [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] and [[SDMX-JSON>>doc:sdmx:Glossary.SDMX-JSON.WebHome]] formats derived from the model (XSD, JSON)
16 +* the availability of an abstract information model capable of supporting time series and cross-sectional data, structural metadata, and reference metadata (SDMX-IM)
17 +* standardised XML and JSON schemas for the SDMX-ML and SDMX-JSON formats derived from the model (XSD, JSON)
18 18  * the use of web-services technology (XML, JSON, Open API)
19 19  
20 -Such an architecture needs to be well organised, and the [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]]/Repository (SDMXRR) 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 data sharing vision.
20 +Such an architecture needs to be well organised, and the SDMX Registry/Repository (SDMXRR) is tasked with providing structure, organisation, and maintenance and query interfaces for most of the SDMX components required to support the data sharing vision.
21 21  
22 -However, it is important to emphasise 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.
22 +However, it is important to emphasise 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.
23 23  
24 -Standard formats for the exchange of aggregated statistical data and metadata as prescribed in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] v3.1 are envisaged to bring benefits to the statistical community because data reporting and dissemination processes can be made more efficient.
24 +Standard formats for the exchange of aggregated statistical data and metadata as prescribed in SDMX v3.1 are envisaged to bring benefits to the statistical community because data reporting and dissemination processes can be made more efficient.
25 25  
26 -As organisations migrate to [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] enabled systems, many XML, JSON (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 (% style="color:#e74c3c" %)Concept(%%) definitions – often collectively called [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] – XML schemas generated from [[data structure definitions>>doc:sdmx:Glossary.Data structure definition.WebHome]], XSLT stylesheets 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.
26 +As organisations migrate to SDMX enabled systems, many XML, JSON (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 structure definitions, XSLT stylesheets 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.
27 27  
28 28  This is the role of the registry.
29 29  
30 -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.
30 +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.
31 31  
32 -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:
32 +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:
33 33  
34 -* [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository
34 +* structural metadata repository
35 35  * data and metadata registration
36 36  * query
37 37  
38 -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.
38 +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.
39 39  
40 40  = 2 Scope and Normative Status =
41 41  
42 -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.
42 +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.
43 43  
44 44  In this document, functions and behaviours of the Registry Interfaces are described in four ways:
45 45  
46 46  * in text
47 47  * with tables
48 -* 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]])
49 -* 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 diagrams are clearly marked as “Logical Class Diagram ...”)
48 +* with UML diagrams excerpted from the SDMX Information Model (SDMX-IM)
49 +* with UML diagrams that are not a part of the SDMX-IM but are included here for clarity and to aid implementations (these diagrams are clearly marked as “Logical Class Diagram ...”)
50 50  
51 51  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.
52 52  
53 -Note that chapters 5 and 6 below 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 (Section 3 of the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Standard). All other sections of this document are informative.
53 +Note that chapters 5 and 6 below 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 (Section 3 of the SDMX Standard). All other sections of this document are informative.
54 54  
55 -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.
55 +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.
56 56  
57 57  = 3 Scope of the SDMX Registry/Repository =
58 58  
59 59  == 3.1 Objective ==
60 60  
61 -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:
61 +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:
62 62  
63 -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.
64 -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]].
63 +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.
64 +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.
65 65  
66 66  == 3.2 Structural Metadata ==
67 67  
68 -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]]:
68 +Setting up structural metadata and the exchange context (referred to as “data provisioning”) involves the following steps for maintenance agencies:
69 69  
70 -* 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;
71 -* 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”;
72 -* 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 metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] and their presentational arrangement in a Metadataset or as part of a [[Dataset>>doc:sdmx:Glossary.Data set.WebHome]], and their valid values and content;
73 -* if required, defining a subset or view of an [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] which allows some restriction of content called a “[[metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]”;
74 -* 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]] to enable browsing;
70 +* 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;
71 +* if required, defining a subset or view of a DSD which allows some restriction of content called a “dataflow definition”;
72 +* agreeing and creating a specification of the structure of reference metadata (Metadata Structure Definition) which defines the metadata attributes and their presentational arrangement in a Metadataset or as part of a Dataset, and their valid values and content;
73 +* if required, defining a subset or view of an MSD which allows some restriction of content called a “metadataflow”;
74 +* defining which subject matter domains (specified as a Category Scheme) are related to the Dataflow and Metadataflow to enable browsing;
75 75  * defining one or more lists of Data and Metadata Providers;
76 -* defining which Data/Metadata Providers have agreed to publish a given [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]/[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] – this is called a [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] or Metadata [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], respectively.
76 +* defining which Data/Metadata Providers have agreed to publish a given Dataflow/Metadataflow – this is called a Provision Agreement or Metadata Provision Agreement, respectively.
77 77  
78 78  [[image:SDMX 3.1 Section 5_en_c485399b.jpg||height="539" width="443"]]
79 79  
... ... @@ -81,20 +81,20 @@
81 81  
82 82  Note that in Figure 1 (but also most of the relevant subsequent figures) terms that include both data and metadata have been used. For example:
83 83  
84 -* Structure Definition: refers to [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] ([[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]]) and [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] ([[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]])
85 -* Flow: refers to [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] and [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]
86 -* [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]]: refers to [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] (for data) and Metadata [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]]
87 -* Provider Scheme: refers to [[Data Provider Scheme>>doc:sdmx:Glossary.Data provider scheme.WebHome]] and Metadata Provider Scheme
88 -* Provider: refers to [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] and Metadata Provider
84 +* Structure Definition: refers to Data Structure Definition (DSD) and Metadata Structure Definition (MSD)
85 +* Flow: refers to Dataflow and Metadataflow
86 +* Provision Agreement: refers to Provision Agreement (for data) and Metadata Provision Agreement
87 +* Provider Scheme: refers to Data Provider Scheme and Metadata Provider Scheme
88 +* Provider: refers to Data Provider and Metadata Provider
89 89  
90 -In that context, the term “Metadata” refers to [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]].
90 +In that context, the term “Metadata” refers to reference metadata.
91 91  
92 92  == 3.3 Registration ==
93 93  
94 -Publishing the data and [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] involves the following steps for a Data/Metadata Provider:
94 +Publishing the data and reference metadata involves the following steps for a Data/Metadata Provider:
95 95  
96 -* making the [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] and data available in [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]]/JSON conformant data files or databases (which respond to an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] query with data). The data and [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] files or databases must be web accessible, and must conform to an agreed [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] or [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] ([[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] or [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] subset);
97 -* registering the existence of published [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] and data files or databases with one or more [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] registries.
96 +* making the reference metadata and data available in SDMX-ML/JSON conformant data files or databases (which respond to an SDMX query with data). The data and reference metadata files or databases must be web accessible, and must conform to an agreed Dataflow or Metadataflow (Data Structure Definition or Metadata Structure Definition subset);
97 +* registering the existence of published reference metadata and data files or databases with one or more SDMX registries.
98 98  
99 99  [[image:SDMX 3.1 Section 5_en_6e468656.jpg||height="407" width="553"]]
100 100  
... ... @@ -102,17 +102,17 @@
102 102  
103 103  == 3.4 Notification ==
104 104  
105 -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:
105 +Notifying interested parties of newly published or re-published data, reference metadata or changes in structural metadata involves:
106 106  
107 -* 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.
107 + 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.
108 108  
109 109  == 3.5 Discovery ==
110 110  
111 -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:
111 +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:
112 112  
113 -* optionally browsing a subject matter domain [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] to find [[Dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]] (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;
114 -* 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;
115 -* processing the query result set and retrieving data and/or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] from the supplied URLs.
113 +* optionally browsing a subject matter domain category scheme to find Dataflows (and hence Data Structure Definitions) and Metadataflows which structure the type of data and/or reference metadata being sought;
114 +* 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;
115 +* processing the query result set and retrieving data and/or reference metadata from the supplied URLs.
116 116  
117 117  [[image:SDMX 3.1 Section 5_en_6c6c7b74.jpg||height="328" width="554"]]
118 118  
... ... @@ -122,7 +122,7 @@
122 122  
123 123  == 4.1 Architectural Schematic ==
124 124  
125 -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.
125 +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.
126 126  
127 127  [[image:SDMX 3.1 Section 5_en_81e92e22.jpg||height="325" width="553"]]
128 128  
... ... @@ -130,18 +130,18 @@
130 130  
131 131  == 4.2 Structural Metadata Repository ==
132 132  
133 -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.
133 +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.
134 134  
135 -Note that the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] REST API 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 yet supported are:
135 +Note that the SDMX REST API supports all of the SDMX structural artefacts. The only structural artefacts that are not yet supported are:
136 136  
137 137  * Registration of data and metadata sources
138 -* [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] and [[Notification>>doc:sdmx:Glossary.Notification.WebHome]]
138 +* Subscription and Notification
139 139  
140 -As of the initial (% style="color:#e74c3c" %)version(%%) of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 no messages are defined to support these [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]; hence, users may need to use [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 2.1 Registry Interface messages, instead.
140 +As of the initial version of SDMX 3.0 no messages are defined to support these artefacts; hence, users may need to use SDMX 2.1 Registry Interface messages, instead.
141 141  
142 142  == 4.3 Provisioning Metadata Repository ==
143 143  
144 -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/metadata provider, 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 or Metadata [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]].
144 +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/metadata provider, for a specific data or metadata flow. In the SDMX model this is called the Provision or Metadata Provision Agreement.
145 145  
146 146  This layer is supported by the Data and Metadata Registration Service.
147 147  
... ... @@ -152,25 +152,25 @@
152 152  The Registry Interfaces are:
153 153  
154 154  * Notify Registry Event
155 -* Submit [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] Request
156 -* Submit [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] Response
155 +* Submit Subscription Request
156 +* Submit Subscription Response
157 157  * Submit Registration Request
158 158  * Submit Registration Response
159 159  * Query Registration Request
160 160  * Query Registration Response
161 -* Query [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] Request
162 -* Query [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] Response
161 +* Query Subscription Request
162 +* Query Subscription Response
163 163  
164 164  The registry interfaces are invoked in one of two ways:
165 165  
166 -1. The interface is the name of the root node of the [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] document
167 -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.
166 +1. The interface is the name of the root node of the SDMX-ML document
167 +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.
168 168  
169 -In addition to these interfaces the registry must support a mechanism for submitting and querying for [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]]. This is detailed in sections 5.2.2 and 5.2.3.
169 +In addition to these interfaces the registry must support a mechanism for submitting and querying for structural metadata. This is detailed in sections 5.2.2 and 5.2.3.
170 170  
171 -All these interactions with the Registry – with the exception of NotifyRegistryEvent – 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.
171 +All these interactions with the Registry – with the exception of NotifyRegistryEvent – 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.
172 172  
173 -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 requestresponse pattern, because it is inherently asynchronous.
173 +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 requestresponse pattern, because it is inherently asynchronous.
174 174  
175 175  == 5.2 Registry Services ==
176 176  
... ... @@ -180,15 +180,15 @@
180 180  
181 181  === 5.2.2 Structure Submission Service ===
182 182  
183 -The registry must support a mechanism for submitting [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]]. This mechanism can be 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 the corresponding GitHub project, dedicated to the SDMX REST API: [[__https:~~/~~/github.com/sdmx-twg/sdmx-rest__>>https://https:github.comsdmx-twgsdmx-rest]]). 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, with the exception of [[Item Schemes>>doc:sdmx:Glossary.Item scheme.WebHome]], where changes at an Item (% style="color:#e74c3c" %)level(%%) is also possible (see next section on the [[SDMX Information Model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]).
183 +The registry must support a mechanism for submitting structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: [[__https:~~/~~/github.com/sdmx-twg/sdmx-rest__>>https://https:github.comsdmx-twgsdmx-rest]]). 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, with the exception of Item Schemes, where changes at an Item level is also possible (see next section on the SDMX Information Model).
184 184  
185 185  === 5.2.3 Structure Query Service ===
186 186  
187 -The registry must support a mechanism for querying for [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]]. This mechanism can be 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 the corresponding GitHub project, dedicated to the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] REST API: [[__https:~~/~~/github.com/sdmx-twg/sdmx-rest__>>https://https:github.comsdmx-twgsdmx-rest]]). The registry response to this query mechanism is the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Structure message, which has as its root node:
187 +The registry must support a mechanism for querying for structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: [[__https:~~/~~/github.com/sdmx-twg/sdmx-rest__>>https://https:github.comsdmx-twgsdmx-rest]]). The registry response to this query mechanism is the SDMX Structure message, which has as its root node:
188 188  
189 189  * Structure
190 190  
191 -The [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] structural [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] that may be queried are defined in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] structure web service specification which is compatible with this release of the standard __[[https:~~/~~/github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md>>https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]] __[[https:~~/~~/github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md>>https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]]
191 +The SDMX structural artefacts that may be queried are defined in the SDMX structure web service specification which is compatible with this release of the standard __[[https:~~/~~/github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md>>https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]] __[[https:~~/~~/github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md>>https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]]
192 192  
193 193  === 5.2.4 Data and Reference Metadata Registration Service ===
194 194  
... ... @@ -222,7 +222,7 @@
222 222  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 metadataset indexing application must index the [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] or metadatasets upon registration. The indexing application behaviour is as follows:
223 223  
224 224  (% style="width:896.835px" %)
225 -|**Boolean Attribute**|(% style="width:712px" %)**Behaviour if Value is “true”**
225 +|**Boolean [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]**|(% style="width:712px" %)**Behaviour if Value is “true”**
226 226  |indexTimeSeries|(% style="width:712px" %)A compliant indexing application must index all the time series keys
227 227  |indexDataSet|(% style="width:712px" %)(((
228 228  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]].
... ... @@ -294,7 +294,7 @@
294 294  
295 295  [[image:SDMX 3.1 Section 5_en_4a9b2cfc.jpg||height="688" width="587"]]
296 296  
297 -**Figure 5: Class diagram of fundamental artefacts in the SDMX-IM**
297 +**Figure 5: Class diagram of fundamental [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] in the [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]**
298 298  
299 299  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:
300 300  
... ... @@ -339,7 +339,7 @@
339 339  |(% colspan="2" %) |(% colspan="2" %)structureURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the resource.
340 340  |(% colspan="2" %) |(% colspan="2" %)(Maintenance) organisationId|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)The object must be linked to a maintenance organisation, i.e., Agency or Metadata Provider.
341 341  
342 -**Table 1: Common Attributes of Object Types**
342 +**Table 1: Common [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]] of Object Types**
343 343  
344 344  == 6.2 Unique identification of SDMX objects ==
345 345  
... ... @@ -739,7 +739,7 @@
739 739  The following table lists the [[Maintainable Artefacts>>doc:sdmx:Glossary.Maintainable artefact.WebHome]].
740 740  
741 741  (% style="width:825.835px" %)
742 -|(% colspan="2" style="width:455px" %)**Maintainable Artefacts**|(% style="width:367px" %)**Content**
742 +|(% colspan="2" style="width:455px" %)**[[Maintainable Artefacts>>doc:sdmx:Glossary.Maintainable artefact.WebHome]]**|(% style="width:367px" %)**Content**
743 743  |(% style="width:160px" %)**Abstract Class**|(% style="width:295px" %)**Concrete Class**|(% style="width:367px" %)
744 744  |(% style="width:160px" %)[[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]]|(% style="width:295px" %)Codelist|(% style="width:367px" %)[[Code>>doc:sdmx:Glossary.Code.WebHome]]
745 745  |(% style="width:160px" %) |(% style="width:295px" %)[[Concept Scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]]|(% style="width:367px" %)(% style="color:#e74c3c" %)Concept