Version 30.1 by Artur on 2025/07/14 10:19

Hide last authors
Helena 21.2 1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
Helena 2.1 5 **Revision History**
6
Helena 21.2 7 (% style="width:824.835px" %)
8 |(% style="width:184px" %)**Revision**|(% style="width:195px" %)**Date**|(% style="width:442px" %)**Contents**
9 |(% style="width:184px" %)DRAFT 1.0|(% style="width:195px" %)December 2024|(% style="width:442px" %)Draft release updated for SDMX 3.1 for public consultation
10 |(% style="width:184px" %)1.0|(% style="width:195px" %)May 2025|(% style="width:442px" %)Public release for SDMX 3.1
Helena 2.1 11
Helena 21.2 12 = 1 Introduction =
Helena 2.1 13
Helena 23.1 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:
Helena 2.1 15
Helena 23.1 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)
Helena 2.1 18 * the use of web-services technology (XML, JSON, Open API)
19
Helena 23.1 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.
Helena 2.1 21
Helena 23.1 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.
Helena 2.1 23
Helena 23.1 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.
Helena 2.1 25
Elena 27.2 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>>doc:sdmx:Glossary.Concept.WebHome]](%%) 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.
Helena 2.1 27
28 This is the role of the registry.
29
Helena 23.1 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.
Helena 2.1 31
Helena 23.1 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:
Helena 2.1 33
Helena 23.1 34 * [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository
Helena 21.3 35 * data and metadata registration
36 * query
Helena 2.1 37
Helena 23.1 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.
Helena 2.1 39
Helena 21.4 40 = 2 Scope and Normative Status =
Helena 2.1 41
Helena 23.1 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.
Helena 2.1 43
44 In this document, functions and behaviours of the Registry Interfaces are described in four ways:
45
46 * in text
47 * with tables
Helena 23.1 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 ...”)
Helena 2.1 50
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
Helena 23.1 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.
Helena 2.1 54
Helena 23.1 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.
Helena 2.1 56
Helena 21.4 57 = 3 Scope of the SDMX Registry/Repository =
Helena 2.1 58
Helena 21.4 59 == 3.1 Objective ==
Helena 2.1 60
Helena 23.1 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:
Helena 2.1 62
Helena 23.1 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]].
Helena 2.1 65
Helena 21.4 66 == 3.2 Structural Metadata ==
Helena 2.1 67
Helena 23.1 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]]:
Helena 2.1 69
Helena 23.1 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;
Helena 2.1 75 * defining one or more lists of Data and Metadata Providers;
Helena 23.1 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.
Helena 2.1 77
78 [[image:SDMX 3.1 Section 5_en_c485399b.jpg||height="539" width="443"]]
79
Helena 24.1 80 **Figure 1: Schematic of the Basic Structural Artefacts in the SDMX-IM**
Helena 2.1 81
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
Helena 23.1 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
Helena 2.1 89
Helena 23.1 90 In that context, the term “Metadata” refers to [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]].
Helena 2.1 91
Helena 21.5 92 == 3.3 Registration ==
Helena 2.1 93
Helena 23.1 94 Publishing the data and [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] involves the following steps for a Data/Metadata Provider:
Helena 2.1 95
Helena 23.1 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.
Helena 2.1 98
99 [[image:SDMX 3.1 Section 5_en_6e468656.jpg||height="407" width="553"]]
100
Helena 24.1 101 **Figure 2: Schematic of Registered Data and Metadata Sources in the SDMX-IM**
Helena 2.1 102
Helena 21.5 103 == 3.4 Notification ==
Helena 2.1 104
Helena 23.1 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:
Helena 2.1 106
Helena 24.2 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.
Helena 2.1 108
Helena 21.5 109 == 3.5 Discovery ==
Helena 2.1 110
Helena 23.1 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:
Helena 2.1 112
Helena 23.1 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.
Helena 2.1 116
117 [[image:SDMX 3.1 Section 5_en_6c6c7b74.jpg||height="328" width="554"]]
118
Helena 24.1 119 **Figure 3: Schematic of Data and Metadata Discovery and Query in the SDMX-IM**
Helena 2.1 120
Helena 21.5 121 = 4 SDMX Registry/Repository Architecture =
Helena 2.1 122
Helena 21.5 123 == 4.1 Architectural Schematic ==
Helena 2.1 124
Helena 23.1 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.
Helena 2.1 126
127 [[image:SDMX 3.1 Section 5_en_81e92e22.jpg||height="325" width="553"]]
128
129 **Figure 4: Schematic of the Registry Content and Services**
130
Helena 21.5 131 == 4.2 Structural Metadata Repository ==
Helena 2.1 132
Helena 23.1 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.
Helena 2.1 134
Helena 23.1 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:
Helena 2.1 136
137 * Registration of data and metadata sources
Helena 23.1 138 * [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] and [[Notification>>doc:sdmx:Glossary.Notification.WebHome]]
Helena 2.1 139
Elena 27.2 140 As of the initial 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.
Helena 2.1 141
Helena 21.5 142 == 4.3 Provisioning Metadata Repository ==
Helena 2.1 143
Helena 23.1 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]].
Helena 2.1 145
146 This layer is supported by the Data and Metadata Registration Service.
147
Helena 21.5 148 = 5 Registry Interfaces and Services =
Helena 2.1 149
Helena 21.5 150 == 5.1 Registry Interfaces ==
Helena 2.1 151
152 The Registry Interfaces are:
153
154 * Notify Registry Event
Helena 23.1 155 * Submit [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] Request
156 * Submit [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] Response
Helena 2.1 157 * Submit Registration Request
158 * Submit Registration Response
159 * Query Registration Request
160 * Query Registration Response
Helena 23.1 161 * Query [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] Request
162 * Query [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] Response
Helena 2.1 163
164 The registry interfaces are invoked in one of two ways:
165
Helena 23.1 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.
Helena 2.1 168
Helena 23.1 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.
Helena 2.1 170
Helena 23.1 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.
Helena 2.1 172
Helena 23.1 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.
Helena 2.1 174
Helena 21.5 175 == 5.2 Registry Services ==
Helena 2.1 176
Helena 21.5 177 === 5.2.1 Introduction ===
Helena 2.1 178
179 The services described in this section do not imply that each is implemented as a discrete web service.
180
Helena 21.5 181 === 5.2.2 Structure Submission Service ===
Helena 2.1 182
Elena 27.2 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>>doc:sdmx:Glossary.Level.WebHome]](%%) is also possible (see next section on the [[SDMX Information Model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]).
Helena 2.1 184
Helena 21.5 185 === 5.2.3 Structure Query Service ===
Helena 2.1 186
Helena 23.1 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:
Helena 2.1 188
Helena 22.4 189 * Structure
Helena 2.1 190
Helena 23.1 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]]
Helena 2.1 192
Helena 21.6 193 === 5.2.4 Data and Reference Metadata Registration Service ===
Helena 2.1 194
195 This service must implement the following Registry Interfaces:
196
197 * SubmitRegistrationRequest
198 * SubmitRegistrationResponse
199 * QueryRegistrationRequest
200 * QueryRegistrationResponse
201
Elena 27.2 202 The Data Registration Service allows [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] conformant 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 [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] or metadata-sets, and MAY extract a concise [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the contents in terms of (% style="color:#e74c3c" %)concept(%%) 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 [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] or
Helena 2.1 203
Elena 27.2 204 metadata-set. These are called (% style="color:#e74c3c" %)[[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]](%%) in the SDMX-IM.
205
Helena 2.1 206 The Data Registration Service MAY validate the following, subject to the access control mechanism implemented in the Registry:
207
Helena 22.15 208 * that the data/metadata provider is allowed to register the [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] or metadataset;
Elena 27.2 209 * that the content of the [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] or metadataset meets the validation (% style="color:#e74c3c" %)[[constraints>>doc:sdmx:Glossary.Constraint.WebHome]](%%). This is dependent upon such (% style="color:#e74c3c" %)[[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]], Metadata Provider, [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], Metadata [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]];
Helena 22.15 210 * 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;
211 * that a simple [[data source>>doc:sdmx:Glossary.Data source.WebHome]] exists (i.e., a file accessible at a URL);
212 * that the correct [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] is used by the registered data;
213 * 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]]) are consistent with the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]];
Elena 27.2 214 * that the valid [[representations>>doc:sdmx:Glossary.Representation.WebHome]] of the (% style="color:#e74c3c" %)[[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]].
Helena 2.1 215
Helena 22.15 216 The Registration has an action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] which takes one of the following values:
Helena 2.1 217
Helena 21.6 218 (% style="width:893.835px" %)
Helena 24.3 219 |(% style="width:241px" %)**Action Attribute Value**|(% style="width:650px" %)**Behaviour**
Helena 21.6 220 |(% style="width:241px" %)Append|(% style="width:650px" %)Add this registration to the registry
221 |(% style="width:241px" %)Replace|(% style="width:650px" %)Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request
222 |(% style="width:241px" %)Delete|(% style="width:650px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
Helena 2.1 223
Helena 22.15 224 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:
Helena 2.1 225
Helena 21.6 226 (% style="width:896.835px" %)
Helena 23.1 227 |**Boolean Attribute**|(% style="width:712px" %)**Behaviour if Value is “true”**
Helena 21.6 228 |indexTimeSeries|(% style="width:712px" %)A compliant indexing application must index all the time series keys
229 |indexDataSet|(% style="width:712px" %)(((
Helena 22.15 230 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]].
231 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]]
Helena 2.1 232 )))
Helena 22.15 233 |indexReportingPeriod|(% style="width:712px" %)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]].
Helena 2.1 234
Helena 21.7 235 === 5.2.5 Data Discovery ===
Helena 2.1 236
237 The Data Discovery Service implements the following Registry Interfaces:
238
239 * QueryRegistrationRequest
240 * QueryRegistrationResponse
241
Helena 21.7 242 === 5.2.6 Subscription and Notification ===
Helena 2.1 243
Helena 22.15 244 The [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] and [[Notification>>doc:sdmx:Glossary.Notification.WebHome]] Service implements the following Registry Interfaces:
Helena 2.1 245
246 * SubmitSubscriptionRequest
247 * SubmitSubscriptionResponse
248 * NotifyRegistryEvent
249
Helena 22.15 250 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]], or [[Code List>>doc:sdmx:Glossary.Code list.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]].
Helena 2.1 251
Helena 22.15 252 [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] management involves a user submitting a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request which contains:
Helena 2.1 253
Elena 27.2 254 * a query or (% style="color:#e74c3c" %)[[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).
Helena 22.15 255 * a list of URIs or endpoints to which an XML [[notification>>doc:sdmx:Glossary.Notification.WebHome]] message can be sent. Supported endpoint types will be email (mailto and HTTP POST (a normal http:~/~/ address);
Elena 27.2 256 * request for a list of submitted subscriptions;
Helena 22.15 257 * deletion of a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]];
Helena 2.1 258
Helena 22.15 259 [[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>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[notification>>doc:sdmx:Glossary.Notification.WebHome]] document to the endpoints specified in the relevant [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]].
Helena 2.1 260
Helena 21.7 261 === 5.2.7 Registry Behaviour ===
Helena 2.1 262
Elena 27.2 263 The following table defines the behaviour of the [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] for the various Registry Interface messages. It should be noted, though, that as of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0, an extended versioning scheme newly including semantic versioning is foreseen for all [[Maintainable Artefacts>>doc:sdmx:Glossary.Maintainable artefact.WebHome]]. Moreover, while the old versioning scheme is allowed, given there is no more
Helena 2.1 264
Elena 27.2 265 a "final" flag, there is no way guaranteeing the consistency across (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) of a Maintainable, unless semantic versioning is used.
Helena 2.1 266
Elena 27.2 267 Given the above, the behaviour described in the following table concerns either draft [[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] using semantic versioning or any [[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] using the old versioning scheme. Nevertheless, in the case of semantic versioning the registry must respect the versioning rules when performing the actions below. For example, it is not possible to replace a non-draft [[Artefact>>doc:sdmx:Glossary.Artefact.WebHome]] that follows semantic versioning, unless a newer (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) is introduced according to the semantic versioning rules. Furthermore, even when draft [[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] are submitted, the registry has to verify semantic versioning is respected against the previous non-draft (% style="color:#e74c3c" %)[[versions>>doc:sdmx:Glossary.Version.WebHome]](%%). It is worth noting that the rules for semantic versioning and replacing or maintaining semantically versioned [[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] applies to externally shared [[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]. This means that any system may internally perform any change within a (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) of an [[Artefact>>doc:sdmx:Glossary.Artefact.WebHome]], until the latter is shared outside of that system or becomes public. Then (as also explained in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”) the [[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] must adhere to the Semantic Versioning rules.
268
Helena 21.8 269 (% style="width:982.835px" %)
270 |(% style="width:217px" %)**Interface**|(% style="width:763px" %)**Behaviour**
271 |(% style="width:217px" %)All|(% style="width:763px" %)(((
Helena 22.15 272 1. If the action is set to “replace” (or a [[maintainable Artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]] is PUT or POSTed) then the entire contents of the existing maintainable object in the Registry MUST be replaced by the object submitted.
Helena 2.1 273 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.
Helena 22.15 274 1. If the action is set to “delete” (or a [[maintainable Artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]] is DELETEd) then the Registry MUST verify that the object can be deleted. In order to qualify for deletion, the object must:
Helena 2.1 275
Elena 27.2 276 a) Be a draft (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%).
Helena 22.5 277 b) Not be explicitly{{footnote}}With semantic versioning, it is allowed to reference a range of artefacts, e.g., a DSD referencing a Codelist with version 1.2.3+ means all patch versions greater than 1.2.3. This means that deleting 1.2.4draft does not break integrity of the aforementioned DSD.{{/footnote}} referenced from any other object in the Registry.
Helena 2.1 278
Helena 22.15 279 4) The semantic versioning rules in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] documentation MUST be obeyed.
Helena 2.1 280 )))
Helena 21.8 281 |(% style="width:217px" %)Structure submission|(% style="width:763px" %)(((
Elena 27.2 282 Structures are submitted at the level of the [[Maintainable Artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]] and the behaviour in “All” above is therefore at the level of the [[Maintainable Artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]].
Helena 2.1 283 )))
Helena 22.15 284 |(% style="width:217px" %)SubmitRegistrationRequest|(% style="width:763px" %)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. For a queryable datasource the Registry MAY validate that the source exists and can accept an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] data query.
Helena 2.1 285
Helena 21.8 286 = 6 Identification of SDMX Objects =
Helena 2.1 287
Helena 21.8 288 == 6.1 Identification, Versioning, and Maintenance ==
Helena 2.1 289
Helena 22.15 290 All major classes of the [[SDMX Information model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]] inherit from one of:
Helena 2.1 291
292 * //**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.
293 * //**NameableArtefact**// – this has all of the features of //IdentifiableArtefact// plus the ability to have a multi-lingual name and description.
Elena 27.2 294 * //**VersionableArtefact**// – this has all of the above features plus a (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) number, according to the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”, and a validity period.
Helena 2.1 295 * //**MaintainableArtefact**// – this has all of the above features, plus registry and structure URIs, and an association to the maintenance organisation of the object.
296
Helena 21.8 297 === 6.1.1 Identification, Naming, Versioning, and Maintenance Model ===
Helena 2.1 298
299 [[image:SDMX 3.1 Section 5_en_4a9b2cfc.jpg||height="688" width="587"]]
300
Helena 23.1 301 **Figure 5: Class diagram of fundamental artefacts in the SDMX-IM**
Helena 2.1 302
Helena 22.15 303 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:
Helena 2.1 304
305 * //Annotable//
Helena 21.8 306 * //Identifiable//
307 * //Nameable//
308 * //Versionable//
309 * //Maintainable//
Helena 2.1 310
Helena 22.7 311 (% style="width:1038.83px" %)
Helena 22.15 312 |(% colspan="2" %)**Object Type**|(% colspan="2" %)**Data [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]**|(% colspan="2" %)**Status**|(% colspan="2" %)**Data type**|(% colspan="2" %)**Notes**
Helena 22.6 313 |(% colspan="2" rowspan="4" %)//Annotable//|(% colspan="2" %)AnnotationTitle|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
314 |(% colspan="2" %)AnnotationType|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
315 |(% colspan="2" %)AnnotationURN|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
316 |(% colspan="2" %)(((
Helena 22.7 317 AnnotationText in the form of InternationalString
Helena 21.2 318 )))|(% colspan="2" %)C|(% colspan="2" %) |(% colspan="2" %)This can have languagespecific variants
Helena 22.6 319 |(% colspan="2" rowspan="4" %)//Identifiable//|(% colspan="2" %)All content as for //Annotable// plus|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
320 |(% colspan="2" %)id|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)
321 |(% colspan="2" %)uri|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
322 |(% colspan="2" %)urn|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)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.
323 |(% colspan="2" rowspan="3" %)//Nameable//|(% colspan="2" %)(((
Helena 22.7 324 All content as for //Identifiable// plus
Helena 21.2 325 )))|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
Helena 22.6 326 |(% colspan="2" %)(((
Helena 22.7 327 Name in the form of InternationalString
Helena 2.1 328 )))|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)This can have language specific variants.
Helena 22.6 329 |(% colspan="2" %)(((
Helena 22.7 330 Description in the form of InternationalString
Helena 2.1 331 )))|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)This can have language specific variants.
Helena 22.6 332 |(% colspan="2" rowspan="4" %)//Versionable//|(% colspan="2" %)(((
Helena 2.1 333 All content as for
334
335 //Identifiable// plus
Helena 21.2 336 )))|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
Elena 27.2 337 |(% colspan="2" %)(% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]]|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)This is the (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) number according to [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules.
Helena 22.6 338 |(% colspan="2" %)validFrom|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %)
339 |(% colspan="2" %)validTo|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %)
340 |(% colspan="2" %)//Maintainable//|(% colspan="2" %)All content as for //Versionable// plus|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
Helena 22.15 341 |(% colspan="2" %) |(% colspan="2" %)[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]|(% colspan="2" %)C|(% colspan="2" %)boolean|(% colspan="2" %)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 structureURL, each of which must return a valid [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] file.
Helena 22.6 342 |(% colspan="2" %) |(% colspan="2" %)serviceURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the service that can be queried for this resource.
343 |(% colspan="2" %) |(% colspan="2" %)structureURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the resource.
344 |(% 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.
Helena 2.1 345
Helena 23.1 346 **Table 1: Common Attributes of Object Types**
Helena 2.1 347
Helena 21.8 348 == 6.2 Unique identification of SDMX objects ==
Helena 2.1 349
Helena 21.8 350 === 6.2.1 Agencies and Metadata Providers ===
Helena 2.1 351
Helena 22.15 352 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.
Helena 2.1 353
354 [[image:SDMX 3.1 Section 5_en_67b3555e.jpg||height="313" width="554"]]
355
Helena 22.16 356 **Figure 6: Agency Scheme Model**
Helena 2.1 357
Elena 27.2 358 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 nlevel structure. The top level of this structure is maintained by [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]. Any Agency in this top level 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 (version ‘1.0’) and is never declared explicitly in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object identification mechanism.
Helena 2.1 359
Helena 22.15 360 In order to achieve this [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] adopts the following rules:
Helena 2.1 361
Helena 22.15 362 * Agencies are maintained in an [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]] (which is a sub class of Organisation Scheme).
363 * 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]].
Elena 27.2 364 * The “top-level” agency is [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] and maintains the “top-level” [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]].
365 * Agencies registered in the top-level 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.
366 * The AgencyScheme has a fixed (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%), i.e., ‘1.0’, hence it is an exception from the Semantic Versioning that other [[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] follow.
Helena 2.1 367 * There can be only one AgencyScheme maintained by any one Agency. It has a fixed id of AGENCIES.
Helena 22.15 368 * The /[[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] 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>>doc:sdmx:Glossary.Maintenance agency.WebHome]].
Elena 27.2 369 * The format of the agency identifier is agencyID.agencyID etc. The top-level 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-(% style="color:#e74c3c" %)level(%%) [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]].
Helena 2.1 370
371 This supports a hierarchical structure of agencyID.
372
373 An example is shown below.
374
375 [[image:SDMX 3.1 Section 5_en_d02edd62.jpg||height="251" width="432"]]
376
377 **Figure 7: Example of Hierarchic Structure of Agencies**
378
Helena 22.15 379 The following organizations maintain an [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]].
Helena 2.1 380
Helena 22.15 381 * [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] – contains Agencies AA, BB
Helena 21.9 382 * AA – contains Agencies CC, DD
383 * BB – contains Agencies CC, DD
384 * DD – Contains Agency EE
Helena 2.1 385
Helena 22.15 386 Each agency is identified by its full [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] excluding [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]].
Helena 2.1 387
388 e.g., the id of EE as an agencyID is AA.DD.EE
389
390 An example of this is shown in the XML snippet below:
391
Helena 26.2 392 [[image:1749590035576-196.png]]
393
Helena 2.1 394 **Figure 8: Example Showing Use of Agency Identifiers**
395
Helena 22.15 396 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.
Helena 2.1 397
Helena 22.15 398 Following the same principles, the Metadata Provider is the maintenance organisation for a special subset of [[Maintainable Artefacts>>doc:sdmx:Glossary.Maintainable artefact.WebHome]], i.e., the Metadatasets; the latter are the containers of [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] combined with a target that those metadata refer to.
Helena 2.1 399
Helena 21.9 400 === 6.2.2 Universal Resource Name (URN) ===
Helena 2.1 401
Helena 21.9 402 ==== 6.2.2.1 Introduction ====
Helena 2.1 403
Elena 27.2 404 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, (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) etc.).
Helena 2.1 405
Helena 21.9 406 ==== 6.2.2.2 URN Structure //__Case Rules for URN__// ====
Helena 2.1 407
408 For the URN, all parts of the string are case sensitive. The generic structure of the URN is as follows:
409
Elena 27.2 410 SDMXprefix.[[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]-package-name.class-name=agencyid:maintainedobjectid(maintainedobject-version).*containerobject-id.object-id
Helena 2.1 411
412 ~* this can repeat and may not be present (see explanation below)
413
Elena 27.2 414 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 (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) information that is allowed is for the maintainable object.
Helena 2.1 415
Elena 27.2 416 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 ‘.’. The (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) information is encapsulated in parentheses ‘()’ and adheres to the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules, as explained in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning.
Helena 2.1 417
Helena 21.10 418 ==== 6.2.2.3 Explanation of the generic structure ====
Helena 2.1 419
420 In the explanation below the actual object that is the target of the URN is called the **actual object**.
421
Helena 22.16 422 **SDMXPrefix**: urn:sdmx:org
Helena 2.1 423
Helena 22.16 424 **SDMX-IM-package-name**: sdmx.infomodel.package=
Helena 2.1 425
426 The packages are:
427
428 base codelist conceptscheme datastructure categoryscheme registry metadatastructure process structuremapping transformation
429
430 **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.
431
Elena 27.2 432 **maintainable-object-[[version>>doc:sdmx:Glossary.Version.WebHome]]** is the (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%), according to the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules, of the maintainable object and is enclosed in parentheses ‘()’, which are always present.
Helena 2.1 433
Elena 27.2 434 **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 ([[Codelist>>doc:sdmx:Glossary.Code list.WebHome]]) and has no intermediary container object, whereas a MetadataAttribute has an intermediary container object (MetadataAttributeDescriptor) and may have an intermediary container object, which is its parent MetadataAttribute. For this reason, the container object id may repeat, with each repetition identifying the object at the next-lower (% style="color:#e74c3c" %)[[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 AttributeDescriptor, DimensionDescriptor, and MeasureDescriptor 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 AttributeDescriptor, DimensionDescriptor, and MeasureDescriptor is not included when the actual object is a DataAttribute or a Dimension/ TimeDimension, or a Measure.
Helena 2.1 435
Elena 27.2 436 Note that although a [[Code>>doc:sdmx:Glossary.Code.WebHome]] can have a parent [[Code>>doc:sdmx:Glossary.Code.WebHome]] and a (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) can have a parent (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) these are maintained in a flat structure and therefore do not have a containerobject-id.
Helena 2.1 437
Elena 27.2 438 For example, the sequence is agency:DSDid((% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%)).DimensionId and not agency:DSDid((% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%)).DimensionDescriptorId.DimensionId.
Helena 2.1 439
440 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.
441
442 //__**Generic Examples of the URN Structure**__//
443
444 __Actual object is a maintainable__
445
Helena 24.3 446 SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version)
Helena 2.1 447
448 __Actual object is contained in a maintained object with no intermediate containing object__
449
Helena 24.3 450 SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version).object-id
Helena 2.1 451
452 __Actual object is contained in a maintained object with an intermediate containing object__
453
Helena 24.3 454 SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version).contained-object-id.object-id
Helena 2.1 455
456 __Actual object is contained in a maintained object with no intermediate containing__ __object but__ __the object type itself is hierarchical__
457
Helena 22.15 458 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 CategoryScheme. 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 CategoryScheme/ [[Category>>doc:sdmx:Glossary.Category.WebHome]]/ [[Category>>doc:sdmx:Glossary.Category.WebHome]].
Helena 2.1 459
Helena 24.3 460 SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version).contained-object-id.object-id
Helena 2.1 461
462 Actual object is contained in a maintained object with an intermediate containing object and the object type itself is hierarchical
463
Helena 22.15 464 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 MetadataAttribute where the contained objects are MetadataAttributeDescriptor (first contained object id) and MetadataAttribute (subsequent contained object ids). The example below shows the generic structure for [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]/ MetadataAttributeDescriptor/ MetadataAttribute/ MetadataAttribute
Helena 2.1 465
Helena 24.3 466 SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version).contained-object-id.contained-object-id contained-objectid.object-id
Helena 2.1 467
468 //__**Concrete Examples of the URN Structure**__//
469
Elena 27.2 470 The [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] CRED_EXT_DEBT of legacy (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) 2.1 maintained by the toplevel Agency TFFS would have the URN:
Helena 2.1 471
Helena 22.16 472 urn:sdmx:org.sdmx.infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(2.1)
Helena 2.1 473
Elena 27.2 474 The URN for a [[code>>doc:sdmx:Glossary.Code.WebHome]] for Argentina maintained by ISO in the [[code list>>doc:sdmx:Glossary.Code list.WebHome]] CL_3166A2 of semantic (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) 1.0.0 would be:
Helena 2.1 475
Elena 27.2 476 urn:[[sdmx>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:org.[[sdmx>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]].infomodel.codelist.[[Code>>doc:sdmx:Glossary.Code.WebHome]]=ISO:CL_3166A2(1.0.0).AR
Helena 2.1 477
Elena 27.2 478 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 of the semantic extended (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) 1.0.0draft would be:
Helena 2.1 479
Elena 27.2 480 urn:[[sdmx>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:org.[[sdmx>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]].infomodel.categoryscheme.[[Category>>doc:sdmx:Glossary.Category.WebHome]]=[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:SUBJECT_MATT ER_DOMAINS(1.0.0-draft).1.2
Helena 2.1 481
Elena 27.2 482 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 of semantic (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) 1.0.0 where the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] of the Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is CONTACT_DETAILS/CONTACT_NAME would be:
Helena 2.1 483
Elena 27.2 484 urn:[[sdmx>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:org.[[sdmx>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]].infomodel.metadatastructure.MetadataAttribute=[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]: CONTACT_METADATA(1.0.0).CONTACT_DETAILS.CONTACT_NAME
Helena 2.1 485
Elena 27.2 486 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 of semantic (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) 1.0.0 would be:
Helena 2.1 487
Elena 27.2 488 urn:[[sdmx>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:org.[[sdmx>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]].infomodel.datastructure.[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]=TFFS.ABC:EXTERNAL_ DEBT(1.0.0)
Helena 2.1 489
Helena 22.15 490 The [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-RR MUST support this globally unique identification scheme. The [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-RR 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:
Helena 2.1 491
Helena 22.15 492 * **Identifiable and [[Nameable Artefacts>>doc:sdmx:Glossary.Nameable artefact.WebHome]]**: id (in some cases this id may be hierarchic)
Elena 27.2 493 * **Maintainable [[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]**: id, (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%), agencyId
Helena 2.1 494
Helena 22.15 495 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.
Helena 2.1 496
Helena 21.10 497 === 6.2.3 Table of SDMX-IM Packages and Classes ===
Helena 2.1 498
Helena 22.15 499 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.
Helena 2.1 500
Helena 21.10 501 (% style="width:750.835px" %)
502 |(% style="width:222px" %)**Package**|(% style="width:526px" %)**URN class name (model class name where this is different)**
503 |(% style="width:222px" %)base|(% style="width:526px" %)Agency
504 |(% style="width:222px" %) |(% style="width:526px" %)AgencyScheme
505 |(% style="width:222px" %) |(% style="width:526px" %)DataConsumer
506 |(% style="width:222px" %) |(% style="width:526px" %)DataConsumerScheme
507 |(% style="width:222px" %) |(% style="width:526px" %)DataProvider
508 |(% style="width:222px" %) |(% style="width:526px" %)DataProviderScheme
509 |(% style="width:222px" %) |(% style="width:526px" %)MetadataProvider
510 |(% style="width:222px" %) |(% style="width:526px" %)MetadataProviderScheme
511 |(% style="width:222px" %) |(% style="width:526px" %)OrganisationUnit
512 |(% style="width:222px" %) |(% style="width:526px" %)OrganisationUnitScheme
513 |(% style="width:222px" %) |(% style="width:526px" %)
514 |(% style="width:222px" %)datastructure|(% style="width:526px" %)AttributeDescriptor
515 |(% style="width:222px" %) |(% style="width:526px" %)DataAttribute
Helena 22.15 516 |(% style="width:222px" %) |(% style="width:526px" %)[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]
Helena 21.10 517 |(% style="width:222px" %) |(% style="width:526px" %)DataStructure (DataStructureDefinition)
Helena 22.15 518 |(% style="width:222px" %) |(% style="width:526px" %)[[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]
Helena 21.10 519 |(% style="width:222px" %) |(% style="width:526px" %)DimensionDescriptor
520 |(% style="width:222px" %) |(% style="width:526px" %)GroupDimensionDescriptor
521 |(% style="width:222px" %) |(% style="width:526px" %)Measure
522 |(% style="width:222px" %) |(% style="width:526px" %)MeasureDescriptor
523 |(% style="width:222px" %) |(% style="width:526px" %)TimeDimension
524 |(% style="width:222px" %) |(% style="width:526px" %)
525 |(% style="width:222px" %)metadatastructure|(% style="width:526px" %)MetadataAttribute
526 |(% style="width:222px" %) |(% style="width:526px" %)MetadataAttributeDescriptor
527 |(% style="width:222px" %) |(% style="width:526px" %)(((
Helena 2.1 528 MetadataStructure
529
530 (MetadataStructureDefinition)
531 )))
532
533 (((
Helena 21.10 534 (% style="width:751.835px" %)
535 |(% style="width:221px" %)**Package**|(% style="width:528px" %)**URN class name (model class name where this is different)**
Helena 22.15 536 |(% style="width:221px" %) |(% style="width:528px" %)[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]
Helena 21.10 537 |(% style="width:221px" %) |(% style="width:528px" %)MetadataSet
538 |(% style="width:221px" %) |(% style="width:528px" %)
539 |(% style="width:221px" %)process|(% style="width:528px" %)Process
540 |(% style="width:221px" %) |(% style="width:528px" %)ProcessStep
541 |(% style="width:221px" %) |(% style="width:528px" %)Transition
542 |(% style="width:221px" %) |(% style="width:528px" %)
543 |(% style="width:221px" %)registry|(% style="width:528px" %)DataConstraint
544 |(% style="width:221px" %) |(% style="width:528px" %)MetadataConstraint
545 |(% style="width:221px" %) |(% style="width:528px" %)MetadataProvisionAgreement
546 |(% style="width:221px" %) |(% style="width:528px" %)ProvisionAgreement
Helena 22.15 547 |(% style="width:221px" %) |(% style="width:528px" %)[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]
Helena 21.10 548 |(% style="width:221px" %) |(% style="width:528px" %)
549 |(% style="width:221px" %)structuremapping|(% style="width:528px" %)CategorySchemeMap
550 |(% style="width:221px" %) |(% style="width:528px" %)ConceptSchemeMap
551 |(% style="width:221px" %) |(% style="width:528px" %)OrganisationSchemeMap
552 |(% style="width:221px" %) |(% style="width:528px" %)ReportingTaxonomyMap
553 |(% style="width:221px" %) |(% style="width:528px" %)RepresentationMap
554 |(% style="width:221px" %) |(% style="width:528px" %)StructureMap
555 |(% style="width:221px" %) |(% style="width:528px" %)
Helena 22.15 556 |(% style="width:221px" %)codelist|(% style="width:528px" %)[[Code>>doc:sdmx:Glossary.Code.WebHome]]
Helena 21.10 557 |(% style="width:221px" %) |(% style="width:528px" %)Codelist
558 |(% style="width:221px" %) |(% style="width:528px" %)HierarchicalCode
Helena 22.15 559 |(% style="width:221px" %) |(% style="width:528px" %)[[Hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]
Helena 21.10 560 |(% style="width:221px" %) |(% style="width:528px" %)HierarchyAssociation
Elena 27.2 561 |(% style="width:221px" %) |(% style="width:528px" %)(% style="color:#e74c3c" %)[[Level>>doc:sdmx:Glossary.Level.WebHome]]
Helena 21.10 562 |(% style="width:221px" %) |(% style="width:528px" %)ValueList
563 |(% style="width:221px" %) |(% style="width:528px" %)
564 |(% style="width:221px" %)categoryscheme|(% style="width:528px" %)Categorisation
Helena 22.15 565 |(% style="width:221px" %) |(% style="width:528px" %)[[Category>>doc:sdmx:Glossary.Category.WebHome]]
Helena 21.10 566 |(% style="width:221px" %) |(% style="width:528px" %)CategoryScheme
567 |(% style="width:221px" %) |(% style="width:528px" %)ReportingCategory
568 |(% style="width:221px" %) |(% style="width:528px" %)ReportingTaxonomy
569 |(% style="width:221px" %) |(% style="width:528px" %)
Elena 27.2 570 |(% style="width:221px" %)conceptscheme|(% style="width:528px" %)(% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]]
Helena 21.10 571 |(% style="width:221px" %) |(% style="width:528px" %)ConceptScheme
572 |(% style="width:221px" %) |(% style="width:528px" %)
573 |(% style="width:221px" %)transformation|(% style="width:528px" %)CustomType
574 |(% style="width:221px" %) |(% style="width:528px" %)CustomTypeScheme
575 |(% style="width:221px" %) |(% style="width:528px" %)NamePersonalisation
576 |(% style="width:221px" %) |(% style="width:528px" %)NamePersonalisationScheme
577 |(% style="width:221px" %) |(% style="width:528px" %)Ruleset
578 |(% style="width:221px" %) |(% style="width:528px" %)RulesetScheme
579 |(% style="width:221px" %) |(% style="width:528px" %)Transformation
580 |(% style="width:221px" %) |(% style="width:528px" %)TransformationScheme
581 |(% style="width:221px" %) |(% style="width:528px" %)UserDefinedOperator
582 |(% style="width:221px" %) |(% style="width:528px" %)UserDefinedOperatorScheme
583 |(% style="width:221px" %) |(% style="width:528px" %)VtlCodelistMapping
584 |(% style="width:221px" %) |(% style="width:528px" %)VtlConceptMapping
585 |(% style="width:221px" %) |(% style="width:528px" %)VtlDataflowMapping
586 |(% style="width:221px" %) |(% style="width:528px" %)VtlMappingScheme
587 |(% style="width:221px" %) |(% style="width:528px" %)
Helena 2.1 588 )))
589
Helena 22.16 590 **Table 2: SDMX-IM Packages and Contained Classes**
Helena 2.1 591
Helena 21.10 592 === 6.2.4 URN Identification components of SDMX objects ===
Helena 2.1 593
Helena 22.15 594 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.
Helena 2.1 595
596 Note that for brevity the URN examples omit the prefix (classnames in italics indicate maintainable objects, keywords in bold indicate fixed value) All URNs have the prefix:
597
Helena 24.4 598 urn:sdmx.org.sdmx.infomodel.{package}.{classname}=
Helena 2.1 599
Helena 21.10 600 (% style="width:1272.83px" %)
Helena 22.10 601 |(% style="width:289px" %)**Classname**|(% style="width:600px" %)**Ending URN pattern**|(% style="width:383px" %)**Example**
602 |(% style="width:289px" %)Agency{{footnote}}The object must be linked to a maintenance organisation, i.e., Agency or Metadata Provider.{{/footnote}}|(% style="width:600px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|(% style="width:383px" %)ECB:**AGENCIES**(**1.0**).AA
603 |(% style="width:289px" %)//AgencyScheme//|(% style="width:600px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**)|(% style="width:383px" %)ECB:**AGENCIES**(**1.0**)
Helena 22.15 604 |(% style="width:289px" %)//Categorisation//|(% style="width:600px" %)categorisationAgencyId:categoris(% style="color:#000000" %)ationId(version)|(% style="width:383px" %)IMF:cat001(1.0.0)
605 |(% style="width:289px" %)[[Category>>doc:sdmx:Glossary.Category.WebHome]]|(% style="width:600px" %)categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|(% style="width:383px" %)IMF:SDDS(1.0.0):level_1_category.level_2_category …
Helena 22.10 606 |(% style="width:289px" %)//CategoryScheme//|(% style="width:600px" %)categorySchemeAgencyId:categorySchemeId(versi on)|(% style="width:383px" %)IMF:SDDS(1.0.0)
Helena 2.1 607
Helena 26.3 608 |(% style="width:285px" %)**Classname**|(% style="width:569px" %)**Ending URN pattern**|(% style="width:794px" %)**Example**
609 |(% style="width:285px" %)//CategorySchemeMap//|(% style="width:569px" %)(((
Helena 22.15 610 (% style="color:#000000" %)catSchemeMapAgencyId:catSchemeMapId(version)
Helena 22.10 611 )))|(% style="width:794px" %)SDMX:EUROSTAT_SUBJECT_DOMAIN(1.0.0)
Helena 26.3 612 |(% style="width:285px" %)[[Code>>doc:sdmx:Glossary.Code.WebHome]]|(% style="width:569px" %)(% style="color:#000000" %)codeListAgencyId:codelistId(version).codeId|(% style="width:794px" %)SDMX:CL_FREQ(1.0.0).Q
Elena 27.2 613 |(% style="width:285px" %)//[[Codelist>>doc:sdmx:Glossary.Code list.WebHome]]//|(% style="width:569px" %)(% style="color:#000000" %)codeListAgencyId:codeListId(version)|(% style="width:794px" %)SDMX:CL_FREQ(1.0.0)
Helena 26.3 614 |(% style="width:285px" %)ComponentMap|(% style="width:569px" %)(% style="color:#000000" %)structureMapAgencyId:structureMap(version).com ponentMapId|(% style="width:794px" %)SDMX:BOP_STRUCTURES(1.0.0).REF_AREA_TO_COUNT RY
Elena 27.2 615 |(% style="width:285px" %)(% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]]|(% style="width:569px" %)(% style="color:#000000" %)conceptSchemeAgencyId:conceptSchemeId(versio n).conceptId|(% style="width:794px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0).FREQ
Helena 26.3 616 |(% style="width:285px" %)//ConceptScheme//|(% style="width:569px" %)(% style="color:#000000" %)conceptSchemeAgencyId:conceptSchemeId(versio n)|(% style="width:794px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0)
617 |(% style="width:285px" %)//ConceptSchemeMap//|(% style="width:569px" %)(((
Helena 22.15 618 (% style="color:#000000" %)conceptSchemeMapAgencyId:conceptSchemeMap Id(version)
Helena 22.10 619 )))|(% style="width:794px" %)SDMX:CONCEPT_MAP(1.0.0)
Helena 26.3 620 |(% style="width:285px" %)CustomType|(% style="width:569px" %)(% style="color:#000000" %)customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|(% style="width:794px" %)ECB: CUSTOM_TYPE_SCHEME(1.0.0).CUSTOM_TYPE_1
621 |(% style="width:285px" %)//CustomTypeScheme//|(% style="width:569px" %)(% style="color:#000000" %)customTypeSchemeAgencyId customTypeSchemeId(version)|(% style="width:794px" %)ECB:CUSTOM_TYPE_SCHEME(1.0.0)
622 |(% style="width:285px" %)DataAttrribute|(% style="width:569px" %)(% style="color:#000000" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dataAttributeId|(% style="width:794px" %)TFFS:EXT_DEBT(1.0.0).OBS_STATUS
623 |(% style="width:285px" %)//DataConstraint//|(% style="width:569px" %)(% style="color:#000000" %)dataConstraintAgencyId:dataConstraintId(version)|(% style="width:794px" %)TFFS:CREDITOR_DATA_CONTENT(1.0.0)
Helena 2.1 624
Helena 26.3 625 |(% style="width:279px" %)**Classname**|(% style="width:563px" %)**Ending URN pattern**|(% style="width:776px" %)**Example**
626 |(% style="width:279px" %)DataConsumer|(% style="width:563px" %)dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**).dataConsumerId|(% style="width:776px" %)SDMX:**DATA_CONSUMERS**(**1.0**).CONSUMER_1
627 |(% style="width:279px" %)//DataConsumerScheme//|(% style="width:563px" %)(((
Helena 21.10 628 dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**)
Helena 26.3 629 )))|(% style="width:776px" %)SDMX:**DATA_CONSUMERS**(**1.0**)
630 |(% style="width:279px" %)//[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]//|(% style="width:563px" %)(% style="color:#000000" %)dataflowAgencyId:dataflowId(version)|(% style="width:776px" %)TFFS:CRED_EXT_DEBT(1.0.0)
631 |(% style="width:279px" %)DataProvider|(% style="width:563px" %)(((
Helena 22.15 632 (% style="color:#000000" %)dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**).dataProviderId
Helena 26.3 633 )))|(% style="width:776px" %)SDMX:**DATA_PROVIDERS**(**1.0**).PROVIDER_1
634 |(% style="width:279px" %)//DataProviderScheme//|(% style="width:563px" %)(((
Helena 22.15 635 (% style="color:#000000" %)dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**)
Helena 26.3 636 )))|(% style="width:776px" %)SDMX:**DATA_PROVIDERS**(**1.0**)
637 |(% style="width:279px" %)//DataStructure//|(% style="width:563px" %)(% style="color:#000000" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version)|(% style="width:776px" %)TFFS:EXT_DEBT(1.0.0)
638 |(% style="width:279px" %)[[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]|(% style="width:563px" %)(% style="color:#000000" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dimensionId|(% style="width:776px" %)TFFS:EXT_DEBT(1.0.0).FREQ
639 |(% style="width:279px" %)(((
Helena 2.1 640 DimensionDescriptor
641
642 MeasureDescriptor
643
644 AttributeDescriptor
Helena 26.3 645 )))|(% style="width:563px" %)(((
Helena 22.15 646 dataStructureDefinitionAgencyId:dataStructureDef initionId((% style="color:#000000" %)version)(%%).componentListId
Helena 2.1 647
Helena 22.15 648 where the componentListId is the name of the class (there is only one occurrence of each in the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]])
Helena 26.3 649 )))|(% style="width:776px" %)(((
Helena 2.1 650 TFFS:EXT_DEBT(1.0.0).DimensionDescriptor
651
652 TFFS:EXT_DEBT(1.0.0).MeasureDescriptor
653
654 TFFS:EXT_DEBT(1.0.0).AttributeDescriptor
655 )))
Helena 26.3 656 |(% style="width:279px" %)GroupDimensionDescriptor|(% style="width:563px" %)(% style="color:#000000" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).groupDimensionDescriptorId|(% style="width:776px" %)TFFS:EXT_DEBT(1.0.0).SIBLING
657 |(% style="width:279px" %)HierarchicalCode|(% style="width:563px" %)(% style="color:#000000" %)hierarchyAgencyId:hierarchyId(version).hierarchica lCode.hierarchicalCode|(% style="width:776px" %)UNESCO:H-C-GOV(1.0.0).GOV_CODE1.GOV_CODE1_1
Helena 2.1 658
Helena 26.3 659 |(% style="width:281px" %)**Classname**|(% style="width:562px" %)**Ending URN pattern**|(% style="width:772px" %)**Example**
660 |(% style="width:281px" %)//[[Hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]//|(% style="width:562px" %)(% style="color:#000000" %)hierarchyAgencyId:hierarchyId(version)|(% style="width:772px" %)UNESCO:H-C-GOV(1.0.0)
661 |(% style="width:281px" %)//HierarchyAssociation//|(% style="width:562px" %)(% style="color:#000000" %)hierarchyAssociationAgencyId:hierarchyAssociatio nId(version)|(% style="width:772px" %)UNESCO:CL_EXP_SOURCE(1.0.0)
Elena 27.2 662 |(% style="width:281px" %)(% style="color:#e74c3c" %)[[Level>>doc:sdmx:Glossary.Level.WebHome]]|(% style="width:562px" %)(% style="color:#000000" %)hierarchyAgencyId:hierarchyId(version).level|(% style="width:772px" %)UNESCO:H-C-GOV(1.0.0).LVL1
Helena 26.3 663 |(% style="width:281px" %)Measure|(% style="width:562px" %)(% style="color:#000000" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).measureId|(% style="width:772px" %)TFFS:EXT_DEBT(1.0.0).OBS_VALUE
664 |(% style="width:281px" %)MetadataAttribute|(% style="width:562px" %)(((
Helena 22.15 665 (% style="color:#000000" %)msdAgencyId:msdId(version).metadataAttributeId.
Helena 2.1 666
Helena 22.15 667 (% style="color:#000000" %)metadataAttributeId
Helena 26.3 668 )))|(% style="width:772px" %)IMF:SDDS_MSD(1.0.0).COMPILATION.METHOD
669 |(% style="width:281px" %)MetadataAttributeDescriptor|(% style="width:562px" %)(% style="color:#000000" %)msdAgencyId:msdId(version).metadataAttributeDe scriptorId|(% style="width:772px" %)IMF:SDDS_MSD(1.0.0).MetadataAttributeDescriptor
670 |(% style="width:281px" %)//MetadataConstraint//|(% style="width:562px" %)(% style="color:#000000" %)metadataConstraintAgencyId:metadataConstraintI d(version)|(% style="width:772px" %)TFFS:CREDITOR_METADATA_CONTENT(1.0.0)
671 |(% style="width:281px" %)//[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]//|(% style="width:562px" %)(% style="color:#000000" %)metadataflowAgencyId:metadataflowId(version)|(% style="width:772px" %)IMF:SDDS_MDF(1.0.0)
672 |(% style="width:281px" %)MetadataProvider|(% style="width:562px" %)(% style="color:#000000" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**).metadataProviderId|(% style="width:772px" %)SDMX:**METADATA_PROVIDERS**(**1.0**).MD_PROVIDER_1
673 |(% style="width:281px" %)//MetadataProviderScheme//|(% style="width:562px" %)(% style="color:#000000" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**)|(% style="width:772px" %)SDMX:**METADATA_PROVIDERS**(**1.0**)
674 |(% style="width:281px" %)//MetadataProvisionAgreement//|(% style="width:562px" %)(% style="color:#000000" %)metadataProvisionAgreementAgencyId:metadataP rovisionAgreementId(version)|(% style="width:772px" %)IMF:SDDS_MDF_AB(1.0.0)
675 |(% style="width:281px" %)//MetadataSet//|(% style="width:562px" %)(% style="color:#000000" %)metadataProviderId:metadataSetId(version)|(% style="width:772px" %)MD_PROVIDER:METADATASET(1.0.0)
676 |(% style="width:281px" %)//MetadataStructure//|(% style="width:562px" %)(% style="color:#000000" %)msdAgencyId:msdId(version)|(% style="width:772px" %)IMF:SDDS_MSD(1.0.0)
Helena 2.1 677
Helena 26.4 678 |(% style="width:283px" %)**Classname**|(% style="width:564px" %)**Ending URN pattern**|(% style="width:771px" %)**Example**
679 |(% style="width:283px" %)NamePersonalisation|(% style="width:564px" %)(% style="color:#000000" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|(% style="width:771px" %)ECB:PSN_SCHEME(1.0.0).PSN1234
680 |(% style="width:283px" %)//NamePersonalisationScheme//|(% style="width:564px" %)(% style="color:#000000" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|(% style="width:771px" %)ECB:PSN_SCHEME(1.0.0)
681 |(% style="width:283px" %)//OrganisationSchemeMap//|(% style="width:564px" %)(% style="color:#000000" %)orgSchemeMapAgencyId:orgSchemeMapId(versio n)|(% style="width:771px" %)SDMX:AGENCIES_PROVIDERS(1.0.0)
682 |(% style="width:283px" %)OrganisationUnit|(% style="width:564px" %)(% style="color:#000000" %)organisationUnitSchemeAgencyId:organisationUni tSchemeId(version).organisationUnitId|(% style="width:771px" %)ECB:ORGANISATIONS(1.0.0).1F
683 |(% style="width:283px" %)//OrganisationUnitScheme//|(% style="width:564px" %)(% style="color:#000000" %)organisationUnitSchemeAgencyId:organisationUni tSchemeId(version)|(% style="width:771px" %)ECB:ORGANISATIONS(1.0.0)
684 |(% style="width:283px" %)//Process//|(% style="width:564px" %)(% style="color:#000000" %)processAgencyId:processId{version)|(% style="width:771px" %)BIS:PROCESS1(1.0.0)
685 |(% style="width:283px" %)ProcessStep|(% style="width:564px" %)(((
Helena 22.15 686 (% style="color:#000000" %)processAgencyId:processId(version).processStepId.
Helena 2.1 687
Helena 22.15 688 (% style="color:#000000" %)processStepId
Helena 26.4 689 )))|(% style="width:771px" %)BIS:PROCESS1(1.0.0).STEP1.STEP1_1
690 |(% style="width:283px" %)//ProvisionAgreement//|(% style="width:564px" %)(% style="color:#000000" %)provisionAgreementAgencyId:provisionAgreement Id(version)|(% style="width:771px" %)TFFS:CRED_EXT_DEBT_AB(1.0.0)
691 |(% style="width:283px" %)ReportingCategory|(% style="width:564px" %)(((
Helena 22.15 692 (% style="color:#000000" %)reportingTaxonomyAgencyId:
Helena 2.1 693
Helena 22.15 694 (% style="color:#000000" %)reportingTaxonomyId(version).reportingCategoryI d.reportingCategoryId
Helena 26.4 695 )))|(% style="width:771px" %)IMF:REP_1(1.0.0):LVL1_REP_CAT.LVL2_REP_CAT
696 |(% style="width:283px" %)//ReportingTaxonomy//|(% style="width:564px" %)(% style="color:#000000" %)reportingTaxonomyAgencyId:reportingTaxonomyI d(version)|(% style="width:771px" %)IMF:REP_1(1.0.0)
697 |(% style="width:283px" %)//ReportingTaxonomyMap//|(% style="width:564px" %)repTaxonomyAgencyId:repTaxonomyId(version)|(% style="width:771px" %)SDMX:RT_MAP(1.0.0)
Helena 2.1 698
Helena 26.4 699 |(% style="width:282px" %)**Classname**|(% style="width:566px" %)**Ending URN pattern**|(% style="width:768px" %)**Example**
700 |(% style="width:282px" %)//RepresentationMap//|(% style="width:566px" %)repMapAgencyId:repMapId(version)|(% style="width:768px" %)SDMX:REF_AREA_MAPPING(1.0.0)
701 |(% style="width:282px" %)Ruleset|(% style="width:566px" %)rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|(% style="width:768px" %)ECB:RULESET_23(1.0.0).SET111
702 |(% style="width:282px" %)//RulesetScheme//|(% style="width:566px" %)rulesetSchemeAgencyId rulesetSchemeId(version)|(% style="width:768px" %)ECB:RULESET_23(1.0.0)
703 |(% style="width:282px" %)//StructureMap//|(% style="width:566px" %)structureMapAgencyId:structureMap(version)|(% style="width:768px" %)SDMX:BOP_STRUCTURES(1.0.0)
704 |(% style="width:282px" %)[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]|(% style="width:566px" %)(((
Helena 22.15 705 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.
Helena 2.1 706 The name of the URN is registryURN There is no pre-determined format.
Helena 26.4 707 )))|(% style="width:768px" %)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 registry URN that is returned from the registry in the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] response message.
708 |(% style="width:282px" %)TimeDimension|(% style="width:566px" %)(% style="color:#000000" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).timeDimensionId|(% style="width:768px" %)TFFS:EXT_DEBT(1.0.0).TIME_PERIOD
709 |(% style="width:282px" %)Transformation|(% style="width:566px" %)(% style="color:#000000" %)transformationSchemeAgencyId transformationSchemeId(version) transformationId|(% style="width:768px" %)ECB:TRANSFORMATION_SCHEME(1.0.0).TRANS_1
710 |(% style="width:282px" %)//TransformationScheme//|(% style="width:566px" %)(% style="color:#000000" %)transformationSchemeAgencyId transformationSchemeId(version)|(% style="width:768px" %)ECB: TRANSFORMATION_SCHEME(1.0.0)
711 |(% style="width:282px" %)**Classname**|(% style="width:566px" %)**Ending URN pattern**|(% style="width:768px" %)**Example**
712 |(% style="width:282px" %)Transition|(% style="width:566px" %)(((
Helena 22.15 713 (% style="color:#000000" %)processAgencyId:processId(version).processStepId.
Helena 2.1 714 transitionId
Helena 26.4 715 )))|(% style="width:768px" %)BIS:PROCESS1(1.0.0).STEP1.TRANSITION1
716 |(% style="width:282px" %)UserDefinedOperator|(% style="width:566px" %)(% style="color:#000000" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|(% style="width:768px" %)ECB:OS_CALC(1.2.0).OS267
717 |(% style="width:282px" %)//UserDefinedOperatorScheme//|(% style="width:566px" %)(% style="color:#000000" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|(% style="width:768px" %)ECB:OS_CALC(1.2.0)
718 |(% style="width:282px" %)//ValueList//|(% style="width:566px" %)(% style="color:#000000" %)valuelistAgencyId:valuelistId(version)|(% style="width:768px" %)SDMX:VLIST(1.0.0)
719 |(% style="width:282px" %)VtlCodelistMapping|(% style="width:566px" %)(% style="color:#000000" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|(% style="width:768px" %)ECB:CLIST_MP(2.0.0).ABZ
720 |(% style="width:282px" %)VtlConceptMapping|(% style="width:566px" %)(% style="color:#000000" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|(% style="width:768px" %)ECB:CLIST_MP(1.0.0).XYA
721 |(% style="width:282px" %)VtlDataflowMapping|(% style="width:566px" %)(% style="color:#000000" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|(% style="width:768px" %)ECB:CLIST_MP(1.0.0).MOQ
722 |(% style="width:282px" %)//VtlMappingScheme//|(% style="width:566px" %)(% style="color:#000000" %)vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|(% style="width:768px" %)ECB:CLIST_MP(2.0.0)
Helena 2.1 723
Helena 22.11 724 **Table 3: Table of identification components for SDMX Identifiable Artefacts**
Helena 2.1 725
Helena 21.10 726 = 7 Implementation Notes =
Helena 2.1 727
Helena 21.10 728 == 7.1 Structural Definition Metadata ==
Helena 2.1 729
Helena 21.10 730 === 7.1.1 Introduction ===
Helena 2.1 731
Elena 27.2 732 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]], (% style="color:#e74c3c" %)[[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.)
Helena 2.1 733
Helena 22.15 734 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]] messages for [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] and the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful API for structure queries. 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.
Helena 2.1 735
Helena 22.15 736 [[Structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] items
Helena 2.1 737
Helena 22.15 738 * may only be modified by the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] which created them;
Helena 2.1 739 * may only be deleted by the agency which created them;
740 * may not be deleted if they are referenced from other constructs in the Registry.
741
Elena 27.2 742 The level 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]]. Especially for [[Item Schemes>>doc:sdmx:Glossary.Item scheme.WebHome]], though, partial maintenance may be performed, i.e., at the (% style="color:#e74c3c" %)[[level>>doc:sdmx:Glossary.Level.WebHome]](%%) of the Item, by submitting an [[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] with the 'isPartial' flag set and a reduced set of Items.
Helena 2.1 743
Helena 22.15 744 The following table lists the [[Maintainable Artefacts>>doc:sdmx:Glossary.Maintainable artefact.WebHome]].
Helena 2.1 745
Helena 21.10 746 (% style="width:825.835px" %)
Helena 24.1 747 |(% colspan="2" style="width:455px" %)**Maintainable Artefacts**|(% style="width:367px" %)**Content**
Helena 21.10 748 |(% style="width:160px" %)**Abstract Class**|(% style="width:295px" %)**Concrete Class**|(% style="width:367px" %)
Helena 22.15 749 |(% style="width:160px" %)[[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]]|(% style="width:295px" %)Codelist|(% style="width:367px" %)[[Code>>doc:sdmx:Glossary.Code.WebHome]]
Elena 27.2 750 |(% style="width:160px" %) |(% style="width:295px" %)[[Concept Scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]]|(% style="width:367px" %)(% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]]
Helena 22.15 751 |(% style="width:160px" %) |(% style="width:295px" %)[[Category Scheme>>doc:sdmx:Glossary.Category scheme.WebHome]]|(% style="width:367px" %)[[Category>>doc:sdmx:Glossary.Category.WebHome]]
752 |(% style="width:160px" %) |(% style="width:295px" %)[[Organisation Unit Scheme>>doc:sdmx:Glossary.Organisation unit scheme.WebHome]]|(% style="width:367px" %)Organisation Unit
753 |(% style="width:160px" %) |(% style="width:295px" %)[[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]]|(% style="width:367px" %)Agency
754 |(% style="width:160px" %) |(% style="width:295px" %)[[Data Provider Scheme>>doc:sdmx:Glossary.Data provider scheme.WebHome]]|(% style="width:367px" %)[[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]]
Helena 21.10 755 |(% style="width:160px" %) |(% style="width:295px" %)Metadata Provider Scheme|(% style="width:367px" %)Metadata Provider
Helena 22.15 756 |(% style="width:160px" %) |(% style="width:295px" %)[[Data Consumer Scheme>>doc:sdmx:Glossary.Data consumer scheme.WebHome]]|(% style="width:367px" %)[[Data Consumer>>doc:sdmx:Glossary.Data consumer.WebHome]]
757 |(% style="width:160px" %) |(% style="width:295px" %)Reporting Taxonomy|(% style="width:367px" %)Reporting [[Category>>doc:sdmx:Glossary.Category.WebHome]]
Helena 21.10 758 |(% style="width:160px" %) |(% style="width:295px" %)Transformation Scheme|(% style="width:367px" %)Transformation
759 |(% style="width:160px" %) |(% style="width:295px" %)Custom Type Scheme|(% style="width:367px" %)Custom Type
760 |(% style="width:160px" %) |(% style="width:295px" %)Name Personalisation Scheme|(% style="width:367px" %)Name Personalisation
Elena 27.2 761 |(% style="width:160px" %) |(% style="width:295px" %)[[Vtl>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] Mapping Scheme|(% style="width:367px" %)[[Vtl>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] [[Codelist>>doc:sdmx:Glossary.Code list.WebHome]] Mapping [[Vtl>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] (% style="color:#e74c3c" %)[[Concept>>doc:sdmx:Glossary.Concept.WebHome]](%%) Mapping
Helena 21.10 762 |(% style="width:160px" %) |(% style="width:295px" %)Ruleset Scheme|(% style="width:367px" %)Ruleset
763 |(% style="width:160px" %) |(% style="width:295px" %)User Defined Operator Scheme|(% style="width:367px" %)User Defined Operator
764 |(% style="width:160px" %)Enumerated List|(% style="width:295px" %)ValueList|(% style="width:367px" %)Value Item
Helena 22.15 765 |(% style="width:160px" %)Structure|(% style="width:295px" %)[[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]|(% style="width:367px" %)(((
766 [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] Descriptor
767 Group [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] Descriptor
768 [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]
769 Time [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]
770 [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Descriptor
771 Data [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]
Helena 2.1 772 Measure Descriptor
773 Measure
774 )))
Helena 22.15 775 |(% style="width:160px" %) |(% style="width:295px" %)[[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]|(% style="width:367px" %)Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Descriptor Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]
776 |(% style="width:160px" %)Structure Usage|(% style="width:295px" %)[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]|(% style="width:367px" %)
777 |(% style="width:160px" %) |(% style="width:295px" %)[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]|(% style="width:367px" %)
Helena 21.10 778 |(% style="width:160px" %)None|(% style="width:295px" %)Process|(% style="width:367px" %)Process Step
Elena 27.2 779 |(% style="width:160px" %)None|(% style="width:295px" %)Structure Map|(% style="width:367px" %)(((
780 [[Component>>doc:sdmx:Glossary.Component.WebHome]] (% style="color:#e74c3c" %)[[Map>>doc:sdmx:Glossary.Map.WebHome]](%%)
781 Epoch (% style="color:#e74c3c" %)[[Map>>doc:sdmx:Glossary.Map.WebHome]](%%)
782 Date Pattern (% style="color:#e74c3c" %)[[Map>>doc:sdmx:Glossary.Map.WebHome]]
Helena 2.1 783 )))
Elena 27.2 784 |(% style="width:160px" %)None|(% style="width:295px" %)[[Representation>>doc:sdmx:Glossary.Representation.WebHome]] Map|(% style="width:367px" %)[[Representation>>doc:sdmx:Glossary.Representation.WebHome]] Mapping
785 |(% style="width:160px" %)[[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] Map|(% style="width:295px" %)Organisation Scheme Map|(% style="width:367px" %)Item (% style="color:#e74c3c" %)[[Map>>doc:sdmx:Glossary.Map.WebHome]]
786 |(% style="width:160px" %) |(% style="width:295px" %)[[Concept Scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] Map|(% style="width:367px" %)Item (% style="color:#e74c3c" %)[[Map>>doc:sdmx:Glossary.Map.WebHome]]
787 |(% style="width:160px" %) |(% style="width:295px" %)[[Category Scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] Map|(% style="width:367px" %)Item (% style="color:#e74c3c" %)[[Map>>doc:sdmx:Glossary.Map.WebHome]]
788 |(% style="width:160px" %) |(% style="width:295px" %)Reporting Taxonomy Map|(% style="width:367px" %)Item (% style="color:#e74c3c" %)[[Map>>doc:sdmx:Glossary.Map.WebHome]]
Helena 22.15 789 |(% style="width:160px" %)None|(% style="width:295px" %)[[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]]|(% style="width:367px" %)
790 |(% style="width:160px" %)None|(% style="width:295px" %)Metadata [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]]|(% style="width:367px" %)
791 |(% style="width:160px" %)None|(% style="width:295px" %)[[Hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]|(% style="width:367px" %)Hierarchical [[Code>>doc:sdmx:Glossary.Code.WebHome]]
792 |(% style="width:160px" %)None|(% style="width:295px" %)[[Hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] Association|(% style="width:367px" %)
Helena 21.10 793 |(% style="width:160px" %)None|(% style="width:295px" %)Categorisation|(% style="width:367px" %)
Elena 27.2 794 |(% style="width:160px" %)(% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]]|(% style="width:295px" %)Data (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]]|(% style="width:367px" %)DataKeySet
Helena 21.10 795 |(% style="width:160px" %) |(% style="width:295px" %) |(% style="width:367px" %)CubeRegion
Elena 27.2 796 |(% style="width:160px" %)(% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]]|(% style="width:295px" %)Metadata (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]]|(% style="width:367px" %)MetadataTargetRegion
Helena 2.1 797
798 **Table 4: Table of Maintainable Artefacts for Structural Definition Metadata**
799
Helena 21.10 800 === 7.1.2 Item Scheme, Structure ===
Helena 2.1 801
Helena 22.15 802 The [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] included in the structural definitions are:
Helena 2.1 803
Helena 22.15 804 * All types of [[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] (Codelist, [[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]], Metadata Provider Scheme, [[Data Consumer Scheme>>doc:sdmx:Glossary.Data consumer scheme.WebHome]], [[Organisation Unit Scheme>>doc:sdmx:Glossary.Organisation unit scheme.WebHome]], Transformation Scheme, Name Personalisation Scheme, Custom Type Scheme, [[Vtl>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] Mapping Scheme, Ruleset Scheme, User Defined Operator Scheme)
Helena 22.11 805 * All types of Enumerated List (ValueList){{footnote}}Note that Codelist is also an EnumeratedList.{{/footnote}}
Helena 22.15 806 * All types of Structure ([[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]])
807 * All types of Structure Usage ([[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]])
Helena 2.1 808
Helena 21.10 809 === 7.1.3 Structure Usage ===
Helena 2.1 810
Helena 21.10 811 ==== 7.1.3.1 Structure Usage: Basic Concepts ====
Helena 2.1 812
Helena 22.15 813 The Structure Usage defines, in its concrete classes of [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] and [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]], 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]].
Helena 2.1 814
Helena 21.10 815 ==== 7.1.3.2 Structure Usage Schematic ====
Helena 2.1 816
817 [[image:SDMX 3.1 Section 5_en_9b750e13.jpg||height="246" width="438"]]
818
819 **Figure 9: Schematic of Linking the Data and Metadata Flows to Categories and Structure Definitions**
820
Helena 21.10 821 ==== 7.1.3.3 Structure Usage Model ====
Helena 2.1 822
823 [[image:SDMX 3.1 Section 5_en_1c94cbe.jpg||height="548" width="578"]]
824
825 **Figure 10: SDMX-IM of links from Structure Usage to Category**
826
Helena 22.15 827 In addition to the maintenance of the [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] and the [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]], the following links must be maintained in the registry:
Helena 2.1 828
Helena 22.15 829 * [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] to Data Structure Definition
830 * [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] to Metadata Structure Definition
Helena 2.1 831
832 The following links may be created by means of a Categorisation
833
Helena 22.15 834 * Categorisation to [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] and [[Category>>doc:sdmx:Glossary.Category.WebHome]]
835 * Categorisation to [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] and [[Category>>doc:sdmx:Glossary.Category.WebHome]]
Helena 2.1 836
Helena 21.10 837 == 7.2 Data and Metadata Provisioning ==
Helena 2.1 838
Helena 21.10 839 === 7.2.1 Provisioning Agreement: Basic concepts ===
Helena 2.1 840
Elena 27.2 841 Data/Metadata provisioning defines a framework in which the provision of different types of statistical data and metadata by various data/metadata providers 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 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.
Helena 2.1 842
843 Note that the term “data provisioning” here includes both the provisioning of data and metadata.
844
Helena 22.15 845 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.
Helena 2.1 846
Helena 21.10 847 === 7.2.2 Provisioning Agreement Model – pull use case ===
Helena 2.1 848
Helena 22.15 849 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]].
Helena 2.1 850
851 [[image:SDMX 3.1 Section 5_en_5a16c7fe.jpg||height="455" width="551"]]
852
853 **Figure 11: SDMX-IM of the Data Provider**
854
Helena 22.15 855 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]].
Helena 2.1 856
857 [[image:SDMX 3.1 Section 5_en_b08fd1a2.jpg||height="299" width="533"]]
858
859 **Figure 12: Schematic of the Provision Agreement**
860
Helena 22.15 861 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]].
Helena 2.1 862
863 [[image:SDMX 3.1 Section 5_en_c63d10ab.jpg||height="246" width="579"]]
864
865 **Figure 13: Logical class diagram of the information contained in the Provision Agreement**
866
Helena 22.15 867 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]] or Metadata Provider and a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] or [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] Definition. The Data/Metadata Provider and the [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]/[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] must exist already in order to set up a Metadata Provision or [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]].
Helena 2.1 868
Helena 21.11 869 == 7.3 Data and Metadata Constraints ==
Helena 2.1 870
Helena 21.11 871 === 7.3.1 Data and Metadata Constraints: Basic Concepts ===
Helena 2.1 872
Elena 27.2 873 (% style="color:#e74c3c" %)[[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]](%%) are, effectively, lists of the valid or actual content of data and metadata. (% style="color:#e74c3c" %)[[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]](%%) can be used to specify a subset 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 (% style="color:#e74c3c" %)[[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]].
Helena 2.1 874
Elena 27.2 875 (% style="color:#e74c3c" %)[[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]](%%) comprise the specification of subsets of key or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values that are to be provided for a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] or [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]], 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 intended to be supplied according to a specific [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]].
Helena 2.1 876
Elena 27.2 877 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 [[data source>>doc:sdmx:Glossary.Data source.WebHome]] (at the level 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 (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%). The (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) is also used to define a [[code list>>doc:sdmx:Glossary.Code list.WebHome]] subset which is used to populate a partial [[code list>>doc:sdmx:Glossary.Code list.WebHome]], and in generating a schema for data reporters to validate their [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] against.
Helena 2.1 878
Helena 22.13 879 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]], and there can be one or more defined for any [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]].
Helena 2.1 880
Helena 22.13 881 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]] (and hence to a [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]). The [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] is thus a means of enabling content based processing.
Helena 2.1 882
Helena 22.13 883 In addition, DataAvailabilityConstraints 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 [[data source>>doc:sdmx:Glossary.Data source.WebHome]] (these can be used to build relevant selection tables).
Helena 2.1 884
Helena 21.11 885 === 7.3.2 Data and Metadata Constraints: Schematic ===
Helena 2.1 886
887 [[image:SDMX 3.1 Section 5_en_28d0cadc.jpg||height="326" width="580"]]
888
889 **Figure 14: Schematic of the Constraint and the Artefacts that can be constrained**
890
Helena 21.11 891 === 7.3.3 Data and Metadata Constraints: Model ===
Helena 2.1 892
893 [[image:SDMX 3.1 Section 5_en_a3184f6a.jpg||height="298" width="579"]]
894
895 **Figure 15: Logical class diagram showing inheritance between and reference to constrainable artefacts**
896
Helena 22.13 897 Logical class diagram showing inheritance between and reference to constrainable artefacts.
Helena 2.1 898
Helena 22.13 899 The class diagram above shows that [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]], Metadata Provider, [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]], [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], Metadata [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], Data Structure.
Helena 2.1 900
Elena 27.2 901 Definition, [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] are all concrete sub-classes of Constrainable [[Artefact>>doc:sdmx:Glossary.Artefact.WebHome]] and can therefore have Data (% style="color:#e74c3c" %)[[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]](%%) specified. Note that the actual (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) as submitted is associated to the reference classes defines in the (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) Attachment. these are used to refer to the classes to which the (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) applies.
Helena 2.1 902
Elena 27.2 903 The content of the (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) can be found in the [[SDMX Information Model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]] document.
Helena 2.1 904
Helena 21.11 905 == 7.4 Data Registration ==
Helena 2.1 906
Helena 21.11 907 === 7.4.1 Basic Concepts ===
Helena 2.1 908
Helena 22.13 909 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]] (and hence [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]). This is implemented as either a web-accessible SDMXML file, or in a database which has a web-services interface capable of responding to an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful query with an [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] data stream.
Helena 2.1 910
Helena 22.13 911 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.
Helena 2.1 912
913 The same mechanism can be used to report or make available a metadata set.
914
Helena 22.13 915 [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-RR supports [[dataset>>doc:sdmx:Glossary.Data 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.
Helena 2.1 916
Helena 21.11 917 === 7.4.2 The Registration Request ===
Helena 2.1 918
Helena 21.11 919 ==== 7.4.2.1 Registration Request Schematic ====
Helena 2.1 920
921 [[image:SDMX 3.1 Section 5_en_293a2ea6.jpg||height="337" width="554"]]
922
923 **Figure 16: Schematic of the Objects Concerned with Registration**
924
Helena 21.12 925 ==== 7.4.2.2 Registration Request Model ====
Helena 2.1 926
Helena 22.13 927 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]] to be registered. The Registration can optionally have information, which has been extracted from the Registration:
Helena 2.1 928
929 * validFrom
930 * validTo
931 * lastUpdated
932
933 The last updated date is useful during the discovery process to make sure the client knows which data is freshest.
934
Helena 22.13 935 The Registration has an action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] which takes one of the following values:
Helena 2.1 936
937 (((
Helena 24.5 938 (% style="width:918.835px" %)
939 |(% style="width:224px" %)**Action Attribute Value**|(% style="width:692px" %)**Behaviour**
940 |(% style="width:224px" %)Append|(% style="width:692px" %)Add this Registration to the registry
941 |(% style="width:224px" %)Replace|(% style="width:692px" %)Replace the existing Registration with identified by the id in the Registration of the SubmitRegistrationRequest
942 |(% style="width:224px" %)Delete|(% style="width:692px" %)Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest
Helena 2.1 943 )))
944
945 [[image:SDMX 3.1 Section 5_en_90b3c64a.jpg||height="434" width="579"]]
946
947 **Figure 17: Logical Class Diagram of Registration of Data and Metadata**
948
Helena 22.13 949 The //QueryDatasource// is an abstract class that represents a [[data source>>doc:sdmx:Glossary.Data source.WebHome]], which can understand an API query (i.e., a RESTful query – RESTDatasource) and respond appropriately. Each [[data source>>doc:sdmx:Glossary.Data source.WebHome]] inherits the dataURL from //Datasource//, and the //QueryDatasource// has an additional URL to locate the specification of the service (specURL) to describe how to access it. All other supported protocols are assumed to use the SimpleDatasource URL.
Helena 2.1 950
Helena 22.13 951 A SimpleDatasource is used to reference a physical [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] file that is available at a URL.
Helena 2.1 952
Helena 22.13 953 The RegistrationRequest 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.
Helena 2.1 954
Helena 22.13 955 The Registration includes [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] that state how a SimpleDatasource is to be indexed when registered. The Registry registration process must act as follows:
Helena 2.1 956
Helena 22.13 957 Information in the [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] is extracted and made available via the availability REST API as documented here:
Helena 2.1 958
959 https:~/~/github.com/sdmx-twg/sdmx-rest/blob/master/doc/availability.md
960
961 (((
Helena 21.12 962 (% style="width:918.835px" %)
963 |**Indexing Required**|(% style="width:745px" %)**Registration Process Activity**
Helena 22.13 964 |indexTimeSeries|(% style="width:745px" %)Extract all the [[series keys>>doc:sdmx:Glossary.Series key.WebHome]] and create a KeySet(s) Constraint.
965 |indexDataSet|(% style="width:745px" %)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 (% style="color:#e74c3c" %)Constraints(%%) model in the [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]], and the associated Selection Value.
Helena 21.12 966 |indexReportingPeriod|(% style="width:745px" %)(((
Helena 22.13 967 This applies only to a registered __[[dataset>>doc:sdmx:Glossary.Data set.WebHome]]__.
968 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.
Helena 2.1 969 )))
Helena 21.12 970 |indexAttributes|(% style="width:745px" %)(((
Helena 2.1 971 **Data Set**
Elena 27.2 972 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 (% style="color:#e74c3c" %)[[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]](%%) model in the SDMXIM, and the associated Selection Value
Helena 2.1 973
974 **Metadata Set**
Elena 27.2 975 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 (% style="color:#e74c3c" %)[[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]](%%) model in the
Helena 2.1 976 )))
Helena 21.12 977 |**Indexing Required**|(% style="width:745px" %)**Registration Process Activity**
Helena 22.13 978 | |(% style="width:745px" %)[[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]. Note that the content is not stored in the Selection Value.
Helena 2.1 979 )))
980
Elena 27.2 981 (% style="color:#e74c3c" %)[[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]](%%) that specify the contents of a //QueryDatasource// are submitted to the Registry via the structure submission service (i.e., the RESTful API).
Helena 2.1 982
983 The Registration must reference the ProvisionAgreement to which it relates.
984
Helena 21.13 985 === 7.4.3 Registration Response ===
Helena 2.1 986
987 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 SubmitRegistration class has a status field, which is either set to “Success”, “Warning” or “Failure”.
988
Helena 22.13 989 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]] or query service.
Helena 2.1 990
Helena 22.13 991 The RegistrationResponse returns set of registration status (one for each registration submitted) in terms of a StatusMessage (this is common to all Registry responses) that indicates success or failure. In the event of registration failure, a set of MessageText 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 RegistrationResponse is shown below:
Helena 2.1 992
993 [[image:SDMX 3.1 Section 5_en_cdba03b5.jpg||height="371" width="579"]]
994
995 **Figure 18: Logical class diagram showing the registration response**
996
Helena 21.14 997 == 7.5 Subscription and Notification Service ==
Helena 2.1 998
Helena 22.13 999 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 and 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.
Helena 2.1 1000
Helena 22.13 1001 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.
Helena 2.1 1002
Helena 22.13 1003 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]]”.
Helena 2.1 1004
Helena 21.14 1005 === 7.5.1 Subscription Logical Class Diagram ===
Helena 2.1 1006
1007 [[image:SDMX 3.1 Section 5_en_1433df5d.jpg||height="680" width="587"]]
1008
1009 **Figure 19: Logical Class Diagram of the Subscription**
1010
Helena 21.15 1011 === 7.5.2 Subscription Information ===
Helena 2.1 1012
Helena 22.13 1013 Regardless of the type of registry/repository events being observed, a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] always contains:
Helena 2.1 1014
Helena 22.13 1015 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.
1016 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.
1017 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]].
Helena 2.1 1018 1. A selector which specifies which type of events are of interest. The set of event types is:
1019
Helena 21.15 1020 (% style="width:1061.83px" %)
1021 |**Event Type**|(% style="width:660px" %)**Comment**
Helena 22.13 1022 |STRUCTURAL_REPOSITORY_EVENTS|(% style="width:660px" %)Life-cycle changes to [[Maintainable Artefacts>>doc:sdmx:Glossary.Maintainable artefact.WebHome]] in the [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository.
1023 |DATA_REGISTRATION_EVENTS|(% style="width:660px" %)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.
1024 |METADATA_REGISTRATION_EVENTS|(% style="width:660px" %)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.
Helena 21.15 1025 |ALL_EVENTS|(% style="width:660px" %)All events of the specified EventType
Helena 2.1 1026
Helena 21.15 1027 === 7.5.3 Wildcard Facility ===
Helena 2.1 1028
1029 Subscription notification supports wildcarded identifier components URNs, which are identifiers which have some or all of their component parts replaced by the wildcard character `*`. Identifier components comprise:
1030
1031 * agencyID
1032 * id
1033 * version
1034
1035 Examples of wildcarded identifier components for an identified object type of Codelist are shown below:
1036
Helena 25.1 1037 >(% style="font-size:18px" %) AgencyID = *
1038 >(% style="font-size:18px" %) Id = *
1039 >(% style="font-size:18px" %) Version = *
Helena 2.1 1040
1041 This subscribes to all Codelists of all versions for all agencies.
1042
Helena 25.1 1043 > (% style="font-size:18px" %)AgencyID = AGENCY1
1044 >(% style="font-size:18px" %) Id = CODELIST1
1045 >(% style="font-size:18px" %) Version = *
Helena 2.1 1046
1047 This subscribes to all versions of Codelist CODELIST1 maintained by the agency AGENCY1.
1048
Helena 25.1 1049 > (% style="font-size:18px" %)AgencyID = AGENCY1
1050 >(% style="font-size:18px" %) Id = *
1051 >(% style="font-size:18px" %) Version = *
Helena 2.1 1052
1053 This subscribes to all versions of all Codelist objects maintained by the agency AGENCY1.
1054
Helena 25.1 1055 > (% style="font-size:18px" %)AgencyID = *
1056 >(% style="font-size:18px" %) Id = CODELIST1
1057 >(% style="font-size:18px" %) Version = *
Helena 2.1 1058
1059 This subscribes to all versions of Codelist CODELIST1 maintained by any agency.
1060
1061 Note that if the subscription is to the latest stable version then this can be achieved by the + character, i.e.:
1062
Helena 25.1 1063 >(% style="font-size:18px" %) Version = +
Helena 2.1 1064
1065 A subscription to the latest version (whether stable, draft or non-versioned) can be achieved by the ~~ character, i.e.:
1066
Helena 25.1 1067 > (% style="font-size:18px" %)Version = ~~
Helena 2.1 1068
1069 A subscription to the latest stable version within major version 2 starting with version 2.3.1 can be achieved by adding the + character after the minor version number, i.e.:
1070
Helena 25.1 1071 >(% style="font-size:18px" %) Version = 2.3+.1
Helena 2.1 1072
1073 The complete SDMX versioning syntax can be found in the SDMX Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”.
1074
Helena 21.16 1075 === 7.5.4 Structural Repository Events ===
Helena 2.1 1076
Helena 22.13 1077 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, [[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]].
Helena 2.1 1078
Helena 21.16 1079 === 7.5.5 Registration Events ===
Helena 2.1 1080
Helena 22.13 1081 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:
Helena 2.1 1082
1083 (((
Helena 21.16 1084 (% style="width:1082.83px" %)
1085 |(% style="width:230px" %)**Selector**|(% style="width:850px" %)**Comment**
Helena 22.13 1086 |(% style="width:230px" %)DataProvider|(% style="width:850px" %)Any [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] registered by the specified dataprovider will activate the notification.
1087 |(% style="width:230px" %)ProvisionAgreement|(% style="width:850px" %)Any [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] for the agreement will activate the notification.
1088 |(% style="width:230px" %)[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]|(% style="width:850px" %)Any [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] for the specified [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] will activate the notification.
1089 |(% style="width:230px" %)DataStructureDefinition|(% style="width:850px" %)Any [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] for those [[dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]] that are based on the specified [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] will activate the notification
1090 |(% style="width:230px" %)Category|(% style="width:850px" %)Any [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] registered for those [[dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]], [[provision agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]] that are categorised by the category.
Helena 2.1 1091 )))
1092
1093 The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration.
1094
Helena 21.16 1095 == 7.6 Notification ==
Helena 2.1 1096
Helena 21.16 1097 === 7.6.1 Logical Class Diagram ===
Helena 2.1 1098
1099 [[image:SDMX 3.1 Section 5_en_8bc1b889.jpg||height="379" width="579"]]
1100
1101 **Figure 20: Logical Class Diagram of the Notification**
1102
Helena 22.14 1103 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.
Helena 2.1 1104
Helena 22.14 1105 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:
Helena 2.1 1106
1107 * Date and time that the event occurred
Helena 22.14 1108 * The URN of the [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] that caused the event
1109 * The URN of the [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] that produced the [[notification>>doc:sdmx:Glossary.Notification.WebHome]]
Helena 2.1 1110 * Event Action: Add, Replace, or Delete.
1111
Helena 22.14 1112 Additionally, supplementary information may be contained in the [[notification>>doc:sdmx:Glossary.Notification.WebHome]] as detailed below.
Helena 2.1 1113
Helena 21.16 1114 === 7.6.2 Structural Event Component ===
Helena 2.1 1115
Helena 22.14 1116 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).
Helena 2.1 1117
Helena 21.16 1118 === 7.6.3 Registration Event Component ===
Helena 2.1 1119
Helena 22.14 1120 The [[notification>>doc:sdmx:Glossary.Notification.WebHome]] will contain the Registration.
Helena 2.1 1121
Helena 22.5 1122 ----
Helena 2.1 1123
Helena 22.5 1124 {{putFootnotes/}}