Skip to Content
Version 21.2 by Helena on 2025/06/08 16:27
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
14 The business vision for SDMX envisages the promotion of a “data sharing” model to facilitate low-cost, high-quality statistical data and metadata exchange. Data sharing reduces the reporting burden of organisations by allowing them to publish data once and let their counterparties “pull” data and related metadata as required. The scenario is based on:
15
16 * the availability of an abstract information model capable of supporting time series and cross-sectional data, structural metadata, and reference metadata (SDMX-IM)
17 * standardised XML and JSON schemas for the SDMX-ML and SDMX-JSON formats derived from the model (XSD, JSON)
18 * the use of web-services technology (XML, JSON, Open API)
19
20 Such an architecture needs to be well organised, and the SDMX Registry/Repository (SDMXRR) is tasked with providing structure, organisation, and maintenance and query interfaces for most of the SDMX components required to support the data sharing vision.
21
22 However, it is important to emphasise that the SDMX-RR provides support for the submission and retrieval of all SDMX structural metadata and provisioning metadata. Therefore, the Registry not only supports the data-sharing scenario, but this metadata is also vital in order to provide support for data and metadata reporting/collection, and dissemination scenarios.
23
24 Standard formats for the exchange of aggregated statistical data and metadata as prescribed in SDMX v3.1 are envisaged to bring benefits to the statistical community because data reporting and dissemination processes can be made more efficient.
25
26 As organisations migrate to SDMX enabled systems, many XML, JSON (and conventional) artefacts will be produced (e.g., Data Structure, Metadata Structure, Code List and Concept definitions – often collectively called structural metadata – XML schemas generated from data structure definitions, XSLT stylesheets for transformation and display of data and metadata, terminology references, etc.). The SDMX model supports interoperability, and it is important to be able to discover and share these artefacts between parties in a controlled and organized way.
27
28 This is the role of the registry.
29
30 With the fundamental SDMX standards in place, a set of architectural standards are needed to address some of the processes involved in statistical data and metadata exchange, with an emphasis on maintenance, retrieval and sharing of the structural metadata. In addition, the architectural standards support the registration and discovery of data and referential metadata.
31
32 These architectural standards address the ‘how’, rather than the ‘what’, and are aimed at enabling existing SDMX standards to achieve their mission. The architectural standards address registry services, which initially comprise:
33
34 • structural metadata repository
35
36 • data and metadata registration
37
38 • query
39
40 The registry services outlined in this specification are designed to help the SDMX community manage the proliferation of SDMX assets and to support data sharing for reporting and dissemination.
41
42 = {{id name="_Toc90781"/}}2 Scope and Normative Status =
43
44 The scope of this document is to specify the logical interfaces for the SDMX registry in terms of the functions required and the data that may be present in the function call, and the behaviour expected of the registry.
45
46 In this document, functions and behaviours of the Registry Interfaces are described in four ways:
47
48 * in text
49 * with tables
50 * with UML diagrams excerpted from the SDMX Information Model (SDMX-IM)
51 * with UML diagrams that are not a part of the SDMX-IM but are included here for clarity and to aid implementations (these diagrams are clearly marked as “Logical Class Diagram ...”)
52
53 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.
54
55 Note that chapters 5 and 6 below contain normative rules regarding the Registry Interface and the identification of registry objects. Further, the minimum standard for access to the registry is via a REST interface (HTTP or HTTPS), as described in the appropriate sections. The notification mechanism must support e-mail and HTTP/HTTPS protocols as described. Normative registry interfaces are specified in the SDMX-ML specification (Section 3 of the SDMX Standard). All other sections of this document are informative.
56
57 Note that although the term “authorised user” is used in this document, the SDMX standards do not define an access control mechanism. Such a mechanism, if required, must be chosen and implemented by the registry software provider.
58
59 = {{id name="_Toc90782"/}}3 Scope of the SDMX Registry/Repository =
60
61 === {{id name="_Toc90783"/}}3.1 Objective ===
62
63 The objective of the SDMX registry/repository is, in broad terms, to allow organisations to publish statistical data and reference metadata in known formats such that interested third parties can discover these data and interpret them accurately and correctly. The mechanism for doing this is twofold:
64
65 1. To maintain and publish structural metadata that describes the structure and valid content of data and reference metadata sources such as databases, metadata repositories, data sets, metadata sets. This structural metadata enables software applications to understand and to interpret the data and reference metadata in these sources.
66 1. To enable applications, organisations, and individuals to share and to discover data and reference metadata. This facilitates data and reference metadata dissemination by implementing the data sharing vision of SDMX.
67
68 === {{id name="_Toc90784"/}}3.2 Structural Metadata ===
69
70 Setting up structural metadata and the exchange context (referred to as “data provisioning”) involves the following steps for maintenance agencies:
71
72 * agreeing and creating a specification of the structure of the data (called a Data Structure Definition or DSD in this document but also known as “key family”), which defines the dimensions, measures and attributes of a dataset and their valid value set;
73 * if required, defining a subset or view of a DSD which allows some restriction of content called a “dataflow definition”;
74 * agreeing and creating a specification of the structure of reference metadata (Metadata Structure Definition) which defines the metadata attributes and their presentational arrangement in a Metadataset or as part of a Dataset, and their valid values and content;
75 * if required, defining a subset or view of an MSD which allows some restriction of content called a “metadataflow”;
76 * defining which subject matter domains (specified as a Category Scheme) are related to the Dataflow and Metadataflow to enable browsing;
77 * defining one or more lists of Data and Metadata Providers;
78 * defining which Data/Metadata Providers have agreed to publish a given Dataflow/Metadataflow – this is called a Provision Agreement or Metadata Provision Agreement, respectively.
79
80 [[image:SDMX 3.1 Section 5_en_c485399b.jpg||height="539" width="443"]]
81
82 **Figure 1: Schematic of the Basic Structural Artefacts in the SDMX-IM**
83
84 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:
85
86 * Structure Definition: refers to Data Structure Definition (DSD) and Metadata Structure Definition (MSD)
87 * Flow: refers to Dataflow and Metadataflow
88 * Provision Agreement: refers to Provision Agreement (for data) and Metadata Provision Agreement
89 * Provider Scheme: refers to Data Provider Scheme and Metadata Provider Scheme
90 * Provider: refers to Data Provider and Metadata Provider
91
92 In that context, the term “Metadata” refers to reference metadata.
93
94 === {{id name="_Toc90785"/}}3.3 Registration ===
95
96 Publishing the data and reference metadata involves the following steps for a Data/Metadata Provider:
97
98 * making the reference metadata and data available in SDMX-ML/JSON conformant data files or databases (which respond to an SDMX query with data). The data and reference metadata files or databases must be web accessible, and must conform to an agreed Dataflow or Metadataflow (Data Structure Definition or Metadata Structure Definition subset);
99 * registering the existence of published reference metadata and data files or databases with one or more SDMX registries.
100
101 [[image:SDMX 3.1 Section 5_en_6e468656.jpg||height="407" width="553"]]
102
103 **Figure 2: Schematic of Registered Data and Metadata Sources in the SDMX-IM**
104
105 === {{id name="_Toc90786"/}}3.4 Notification ===
106
107 Notifying interested parties of newly published or re-published data, reference metadata or changes in structural metadata involves:
108
109 • registry support of a subscription-based notification service which sends an email or notifies an HTTP address announcing all published data that meets the criteria contained in the subscription request.
110
111 === {{id name="_Toc90787"/}}3.5 Discovery ===
112
113 Discovering published data and reference metadata involves interaction with the registry to fulfil the following logical steps that would be carried out by a user interacting with a service that itself interacts with the registry and an SDMX-enabled data or reference metadata resource:
114
115 * optionally browsing a subject matter domain category scheme to find Dataflows (and hence Data Structure Definitions) and Metadataflows which structure the type of data and/or reference metadata being sought;
116 * build a query, in terms of the selected Data Structure Definition or Metadata Structure Definition, which specifies what data are required and submitting this to a service that can query an SDMX registry which will return a list of (URLs of) data and reference metadata files and databases which satisfy the query;
117 * processing the query result set and retrieving data and/or reference metadata from the supplied URLs.
118
119 [[image:SDMX 3.1 Section 5_en_6c6c7b74.jpg||height="328" width="554"]]
120
121 **Figure 3: Schematic of Data and Metadata Discovery and Query in the SDMX-IM**
122
123 = {{id name="_Toc90788"/}}4 SDMX Registry/Repository Architecture =
124
125 === {{id name="_Toc90789"/}}4.1 Architectural Schematic ===
126
127 The architecture of the SDMX registry/repository is derived from the objectives stated above. It is a layered architecture that is founded by a structural metadata repository which supports a provisioning metadata repository which supports the registry services. These are all supported by the SDMX-ML schemas. Applications can be built on top of these services which support the reporting, storage, retrieval, and dissemination aspects of the statistical lifecycle as well as the maintenance of the structural metadata required to drive these applications.
128
129 [[image:SDMX 3.1 Section 5_en_81e92e22.jpg||height="325" width="553"]]
130
131 **Figure 4: Schematic of the Registry Content and Services**
132
133 === {{id name="_Toc90790"/}}4.2 Structural Metadata Repository ===
134
135 The basic layer is that of a structural metadata service which supports the lifecycle of SDMX structural metadata artefacts such as Maintenance Agencies, Data Structure Definitions, Metadata Structure Definitions, Provision Agreements, Processes etc. This layer is supported by the Structure Submission and Query Service.
136
137 Note that the SDMX REST API supports all of the SDMX structural artefacts. The only structural artefacts that are not yet supported are:
138
139 * Registration of data and metadata sources
140 * Subscription and Notification
141
142 As of the initial version of SDMX 3.0 no messages are defined to support these artefacts; hence, users may need to use SDMX 2.1 Registry Interface messages, instead.
143
144 === {{id name="_Toc90791"/}}4.3 Provisioning Metadata Repository ===
145
146 The function of this repository is to support the definition of the structural metadata that describes the various types of data-store which model SDMX-conformant databases or files, and to link to these data sources. These links can be specified for a data/metadata provider, for a specific data or metadata flow. In the SDMX model this is called the Provision or Metadata Provision Agreement.
147
148 This layer is supported by the Data and Metadata Registration Service.
149
150 = {{id name="_Toc90792"/}}5 Registry Interfaces and Services =
151
152 === {{id name="_Toc90793"/}}5.1 Registry Interfaces ===
153
154 The Registry Interfaces are:
155
156 * Notify Registry Event
157 * Submit Subscription Request
158 * Submit Subscription Response
159 * Submit Registration Request
160 * Submit Registration Response
161 * Query Registration Request
162 * Query Registration Response
163 * Query Subscription Request
164 * Query Subscription Response
165
166 The registry interfaces are invoked in one of two ways:
167
168 *
169 *1. The interface is the name of the root node of the SDMX-ML document
170 *1. The interface is invoked as a child element of the RegistryInterface message where the RegistryInterface is the root node of the SDMX-ML document.
171
172 In addition to these interfaces the registry must support a mechanism for submitting and querying for structural metadata. This is detailed in sections 5.2.2 and 5.2.3.
173
174 All these interactions with the Registry – with the exception of NotifyRegistryEvent – are designed in pairs. The first document, the one which invokes the SDMX-RR interface, is a “Request” document. The message returned by the interface is a “Response” document.
175
176 It should be noted that all interactions are assumed to be synchronous, with the exception of Notify Registry Event. This document is sent by the SDMX-RR to all subscribers whenever an even occurs to which any users have subscribed. Thus, it does not conform to the requestresponse pattern, because it is inherently asynchronous.
177
178 === {{id name="_Toc90794"/}}5.2 Registry Services ===
179
180 ===== {{id name="_Toc90795"/}}5.2.1 Introduction =====
181
182 The services described in this section do not imply that each is implemented as a discrete web service.
183
184 ===== {{id name="_Toc90796"/}}5.2.2 Structure Submission Service =====
185
186 The registry must support a mechanism for submitting structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: __[[https:~~/~~/github.com/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[twg/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[rest>>url:https://github.com/sdmx-twg/sdmx-rest]]__[[)>>url:https://github.com/sdmx-twg/sdmx-rest]]. In order for the architecture to be scalable, the finest-grained piece of structural metadata that can be processed by the SDMX-RR is a MaintainableArtefact, with the exception of Item Schemes, where changes at an Item level is also possible (see next section on the SDMX Information Model).
187
188 ===== {{id name="_Toc90797"/}}5.2.3 Structure Query Service =====
189
190 The registry must support a mechanism for querying for structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: __[[https:~~/~~/github.com/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[twg/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[rest>>url:https://github.com/sdmx-twg/sdmx-rest]]__[[)>>url:https://github.com/sdmx-twg/sdmx-rest]]. The registry response to this query mechanism is the SDMX Structure message, which has as its root node:
191
192 • Structure
193
194 The SDMX structural artefacts that may be queried are defined in the SDMX structure web service specification which is compatible with this release of the standard __[[https:~~/~~/github.com/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]][[->>url:https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]][[twg/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]][[->>url:https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]][[rest/blob/master/doc/structures.md>>url:https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]]__[[url:https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]]
195
196 ===== {{id name="_Toc90798"/}}5.2.4 Data and Reference Metadata Registration Service =====
197
198 This service must implement the following Registry Interfaces:
199
200 * SubmitRegistrationRequest
201 * SubmitRegistrationResponse
202 * QueryRegistrationRequest
203 * QueryRegistrationResponse
204
205 The Data Registration Service allows SDMX conformant files and web-accessible databases containing published data and reference metadata to be registered in the SDMX Registry. The registration process MAY validate the content of the datasets or metadata-sets, and MAY extract a concise representation of the contents in terms of concept values (e.g., values of the data attribute, dimension, metadata attribute), or entire keys, and storing this as a record in the registry to enable discovery of the original dataset or metadata-set. These are called Constraints in the SDMX-IM.
206
207 The Data Registration Service MAY validate the following, subject to the access control mechanism implemented in the Registry:
208
209 * that the data/metadata provider is allowed to register the dataset or metadataset;
210 * that the content of the dataset or metadataset meets the validation constraints. This is dependent upon such constraints being defined in the structural repository and which reference the relevant Dataflow, Metadataflow, Data Provider, Metadata Provider, Data Structure Definition, Metadata Structure Definition, Provision Agreement, Metadata Provision Agreement;
211 * that a queryable data source exists – this would necessitate the registration service querying the service to determine its existence;
212 * that a simple data source exists (i.e., a file accessible at a URL);
213 * that the correct Data Structure Definition is used by the registered data;
214 * that the components (Dimensions, Attributes, Measures) are consistent with the Data Structure Definition;
215 * that the valid representations of the concepts to which these components correspond conform to the definition in the Data Structure Definition.
216
217 The Registration has an action attribute which takes one of the following values:
218
219 |**Action Attribute Value**|**Behaviour**
220 |Append|Add this registration to the registry
221 |Replace|Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request
222 |Delete|Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
223
224 The Registration has three Boolean attributes which may be present to determine how an SDMX compliant dataset or metadataset indexing application must index the datasets or metadatasets upon registration. The indexing application behaviour is as follows:
225
226 |**Boolean Attribute**|**Behaviour if Value is “true”**
227 |indexTimeSeries|A compliant indexing application must index all the time series keys
228 |indexDataSet|(((
229 A compliant indexing application must index the range of actual (present) values for each dimension of the Dataset.
230
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 values (the Key) is actually present in the Dataset
232 )))
233 |indexReportingPeriod|A compliant indexing application must index the time period range(s) for which data are present in the Dataset.
234
235 ===== {{id name="_Toc90799"/}}5.2.5 Data Discovery =====
236
237 The Data Discovery Service implements the following Registry Interfaces:
238
239 * QueryRegistrationRequest
240 * QueryRegistrationResponse
241
242 ===== {{id name="_Toc90800"/}}5.2.6 Subscription and Notification =====
243
244 The Subscription and Notification Service implements the following Registry Interfaces:
245
246 * SubmitSubscriptionRequest
247 * SubmitSubscriptionResponse
248 * NotifyRegistryEvent
249
250 The data sharing paradigm relies upon the consumers of data and metadata being able to pull information from data providers’ dissemination systems. For this to work efficiently, a data consumer needs to know when to pull data, i.e., when something has changed in the registry (e.g., a dataset has been updated and re-registered). Additionally, SDMX systems may also want to know if a new Data Structure Definition, or Code List has been added. The Subscription and Notification Service comprises two parts: subscription management, and notification.
251
252 Subscription management involves a user submitting a subscription request which contains:
253
254 * a query or constraint expression in terms of a filter which defines the events for which the user is interested (e.g., new data for a specific dataflow, or for a domain category, or changes to a Data Structure Definition).
255 * a list of URIs or endpoints to which an XML notification message can be sent. Supported endpoint types will be email (mailto~:) and HTTP POST (a normal http:~/~/ address);
256 * request for a list of submitted subscriptions;
257 * deletion of a subscription;
258
259 Notification requires that the structural metadata repository and the provisioning metadata repository monitor any event which is of interest to a user (the object of a subscription request query), and to issue an SDMX notification document to the endpoints specified in the relevant subscriptions.
260
261 ===== {{id name="_Toc90801"/}}5.2.7 Registry Behaviour =====
262
263 The following table defines the behaviour of the SDMX Registry for the various Registry Interface messages. It should be noted, though, that as of SDMX 3.0, an extended versioning scheme newly including semantic versioning is foreseen for all Maintainable Artefacts. Moreover, while the old versioning scheme is allowed, given there is no more a "final" flag, there is no way guaranteeing the consistency across version of a Maintainable, unless semantic versioning is used.
264
265 Given the above, the behaviour described in the following table concerns either draft Artefacts using semantic versioning or any Artefacts 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 that follows semantic versioning, unless a newer version is introduced according to the semantic versioning rules. Furthermore, even when draft Artefacts are submitted, the registry has to verify semantic versioning is respected against the previous non-draft versions. It is worth noting that the rules for semantic versioning and replacing or maintaining semantically versioned Artefacts applies to externally shared Artefacts. This means that any system may internally perform any change within a version of an Artefact, until the latter is shared outside of that system or becomes public. Then (as also explained in the SDMX Standards Section 6 “Technical Notes”) the Artefacts must adhere to the Semantic Versioning rules.
266
267 |**Interface**|**Behaviour**
268 |All|(((
269 1. If the action is set to “replace” (or a maintainable Artefact is PUT or POSTed) then the entire contents of the existing maintainable object in the Registry MUST be replaced by the object submitted.
270 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.
271 1. If the action is set to “delete” (or a maintainable Artefact is DELETEd) then the Registry MUST verify that the object can be deleted. In order to qualify for deletion, the object must:
272
273 1. Be a draft version.
274
Helena 21.2 275 b) Not be explicitly^^[[(% class="wikiinternallink wikiinternallink" %)^^1^^>>path:#sdfootnote1sym||name="sdfootnote1anc"]](%%)^^ referenced from any other object in the Registry.
Helena 2.1 276
277 4) The semantic versioning rules in the SDMX documentation MUST be obeyed.
278 )))
279 |Structure submission|(((
280 Structures are submitted at the level of the
281
282 Maintainable Artefact and the behaviour in “All” above is therefore at the level of the Maintainable Artefact.
283 )))
284 |SubmitRegistrationRequest|If the datasource is a file (simple datasource) then the file MAY be retrieved and indexed according to the Boolean attributes set in the Registration. For a queryable datasource the Registry MAY validate that the source exists and can accept an SDMX data query.
285
286 = {{id name="_Toc90802"/}}6 Identification of SDMX Objects =
287
288 === {{id name="_Toc90803"/}}6.1 Identification, Versioning, and Maintenance ===
289
290 All major classes of the SDMX Information model inherit from one of:
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.
294 * //**VersionableArtefact**// – this has all of the above features plus a version number, according to the SDMX versioning rules in SDMX Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”, and a validity period.
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
297 ===== {{id name="_Toc90804"/}}6.1.1 Identification, Naming, Versioning, and Maintenance Model =====
298
299 [[image:SDMX 3.1 Section 5_en_4a9b2cfc.jpg||height="688" width="587"]]
300
301 **Figure 5: Class diagram of fundamental artefacts in the SDMX-IM**
302
303 The table below shows the identification and related data attributes to be stored in a registry for objects that are one of:
304
305 * //Annotable//
306
307 //Identifiable// • //Nameable//
308
309 • //Versionable//
310
311 • //Maintainable//
312
Helena 21.2 313 | |(% colspan="2" %)**Object Type**|(% colspan="2" %)**Data Attributes**|(% colspan="2" %)**Status**|(% colspan="2" %)**Data type**|(% colspan="2" %)**Notes**
314 | |(% colspan="2" rowspan="4" %)//Annotable//|(% colspan="2" %)AnnotationTitle|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
315 | |(% colspan="2" %)AnnotationType|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
316 | |(% colspan="2" %)AnnotationURN|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
317 | |(% colspan="2" %)(((
Helena 2.1 318 AnnotationText in the form of
319
320 InternationalString
Helena 21.2 321 )))|(% colspan="2" %)C|(% colspan="2" %) |(% colspan="2" %)This can have languagespecific variants
322 | |(% colspan="2" rowspan="4" %)//Identifiable//|(% colspan="2" %)All content as for //Annotable// plus|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
323 | |(% colspan="2" %)id|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)
324 | |(% colspan="2" %)uri|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
325 | |(% 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.
326 | |(% colspan="2" rowspan="3" %)//Nameable//|(% colspan="2" %)(((
Helena 2.1 327 All content as for
328
329 //Identifiable// plus
Helena 21.2 330 )))|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
331 | |(% colspan="2" %)(((
Helena 2.1 332 Name in the form of
333
334 InternationalString
335 )))|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)This can have language specific variants.
Helena 21.2 336 | |(% colspan="2" %)(((
Helena 2.1 337 Description in the form of
338
339 InternationalString
340 )))|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)This can have language specific variants.
Helena 21.2 341 | |(% colspan="2" rowspan="4" %)//Versionable//|(% colspan="2" %)(((
Helena 2.1 342 All content as for
343
344 //Identifiable// plus
Helena 21.2 345 )))|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
346 | |(% colspan="2" %)version|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)This is the version number according to SDMX versioning rules.
347 | |(% colspan="2" %)validFrom|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %)
348 | |(% colspan="2" %)validTo|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %)
349 |(% colspan="2" rowspan="5" %)//Maintainable//|(% colspan="2" %)All content as for //Versionable// plus|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %) |
350 |(% colspan="2" %)isExternalReference|(% 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 file.|
351 |(% colspan="2" %)serviceURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the service that can be queried for this resource.|
352 |(% colspan="2" %)structureURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the resource.|
353 |(% 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 354
355 **Table 1: Common Attributes of Object Types**
356
357 === {{id name="_Toc90805"/}}6.2 Unique identification of SDMX objects ===
358
359 ===== {{id name="_Toc90806"/}}6.2.1 Agencies and Metadata Providers =====
360
361 The Maintenance Agency in SDMX is maintained in an Agency Scheme which itself is a sub class of Organisation Scheme – this is shown in the class diagram below.
362
363 [[image:SDMX 3.1 Section 5_en_67b3555e.jpg||height="313" width="554"]]
364
365 **Figure 6: Agency Scheme Model**
366
367 The Agency in SDMX is extremely important. The Agency Id system used in SDMX is an nlevel structure. The top level of this structure is maintained by SDMX. Any Agency in this top level can declare sub agencies and any sub agency can also declare sub agencies. The Agency Scheme has a fixed id and version (version ‘1.0’) and is never declared explicitly in the SDMX object identification mechanism.
368
369 In order to achieve this SDMX adopts the following rules:
370
371 * Agencies are maintained in an Agency Scheme (which is a sub class of Organisation Scheme).
372 * The agency of the Agency Scheme must also be declared in a (different) Agency Scheme.
373 * The “top-level” agency is SDMX and maintains the “top-level” Agency Scheme.
374 * Agencies registered in the top-level scheme can themselves maintain a single Agency Scheme. Agencies in these second-tier schemes can themselves maintain a single Agency Scheme and so on.
375 * The AgencyScheme has a fixed version, i.e., ‘1.0’, hence it is an exception from the Semantic Versioning that other Artefacts follow.
376 * There can be only one AgencyScheme maintained by any one Agency. It has a fixed id of AGENCIES.
377
378 • The /hierarchy of Organisation is not inherited by Maintenance Agency – thus each Agency Scheme is a flat list of Maintenance Agencies.
379
380 • 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 agency scheme. In other words, SDMX is not a part of the hierarchical ID structure for agencies. However, SDMX is, itself, a maintenance agency and is contained in the top-level Agency Scheme.
381
382 This supports a hierarchical structure of agencyID.
383
384 An example is shown below.
385
386 [[image:SDMX 3.1 Section 5_en_d02edd62.jpg||height="251" width="432"]]
387
388 **Figure 7: Example of Hierarchic Structure of Agencies**
389
390 The following organizations maintain an Agency Scheme.
391
392 • SDMX – contains Agencies AA, BB
393
394 • AA – contains Agencies CC, DD
395
396 • BB – contains Agencies CC, DD
397
398 • DD – Contains Agency EE
399
400 Each agency is identified by its full hierarchy excluding SDMX.
401
402 e.g., the id of EE as an agencyID is AA.DD.EE
403
404 An example of this is shown in the XML snippet below:
405
406 **Figure 8: Example Showing Use of Agency Identifiers**
407
408 Each of these maintenance agencies has an identical Code list with the Id CL_BOP. However, each is uniquely identified by means of the hierarchic agency structure.
409
410 Following the same principles, the Metadata Provider is the maintenance organisation for a special subset of Maintainable Artefacts, i.e., the Metadatasets; the latter are the containers of reference metadata combined with a target that those metadata refer to.
411
412 ===== {{id name="_Toc90807"/}}6.2.2 Universal Resource Name (URN) =====
413
414 **6.2.2.1 Introduction**
415
416 To provide interoperability between SDMX Registry/Repositories in a distributed network environment, it is important to have a scheme for uniquely identifying (and thus accessing) all first-class (Identifiable) SDMX-IM objects. Most of these unique identifiers are composite (containing maintenance agency, or parent object identifiers), and there is a need to be able to construct a unique reference as a single string. This is achieved by having a globally unique identifier called a universal resource name (URN) which is generated from the actual identification components in the SDMX-RR APIs. In other words, the URN for any Identifiable Artefact is constructed from its component identifiers (agency, id, version etc.).
417
418 **6.2.2.2 URN Structure //__Case Rules for URN__//**// //
419
420 For the URN, all parts of the string are case sensitive. The generic structure of the URN is as follows:
421
422 SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobjectid(maintainedobject-version).*containerobject-id.object-id
423
424 ~* this can repeat and may not be present (see explanation below)
425
426 Note that in the SDMX Information Model there are no concrete Versionable Artefacts that are not a Maintainable Artefact. For this reason, the only version information that is allowed is for the maintainable object.
427
428 The Maintenance agency identifier is separated from the maintainable artefact identifier by a colon ‘:’. All other identifiers in the SDMX URN syntax are separated by a period ‘.’. The version information is encapsulated in parentheses ‘()’ and adheres to the SDMX versioning rules, as explained in SDMX Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning.
429
430 **6.2.2.3 Explanation of the generic structure**
431
432 In the explanation below the actual object that is the target of the URN is called the **actual object**.
433
434 **SDMXPrefix**: urn:sdmx:org
435
436 **SDMX-IM-package-name**: sdmx.infomodel.package=
437
438 The packages are:
439
440 base codelist conceptscheme datastructure categoryscheme registry metadatastructure process structuremapping transformation
441
442 **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.
443
444 **maintainable-object-version** is the version, according to the SDMX versioning rules, of the maintainable object and is enclosed in parentheses ‘()’, which are always present.
445
446 **container-object-id** is the identifier of an intermediary object that contains the actual object which the URN is identifying. It is not mandatory as many actual objects do not have an intermediary container object. For instance, a Code is in a maintained object (Codelist) 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 level in its hierarchy. Note that if there is only a single containing object in the model then it is NOT included in the URN structure. This applies to 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.
447
448 Note that although a Code can have a parent Code and a Concept can have a parent Concept these are maintained in a flat structure and therefore do not have a containerobject-id.
449
450 For example, the sequence is agency:DSDid(version).DimensionId and not agency:DSDid(version).DimensionDescriptorId.DimensionId.
451
452 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.
453
454 //__**Generic Examples of the URN Structure**__//
455
456 __Actual object is a maintainable__
457
458 SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version)
459
460 __Actual object is contained in a maintained object with no intermediate containing object__
461
462 SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version).object-id
463
464 __Actual object is contained in a maintained object with an intermediate containing object__
465
466 SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version).contained-object-id.object-id
467
468 __Actual object is contained in a maintained object with no intermediate containing__ __object but__ __the object type itself is hierarchical__
469
470 In this case the object id may not be unique in itself but only within the context of the hierarchy. In the general syntax of the URN all intermediary objects in the structure (with the exception, of course, of the maintained object) are shown as a contained object. An example here would be a Category in a CategoryScheme. The Category is hierarchical, and all intermediate Categories are shown as a contained object. The example below shows the generic structure for CategoryScheme/ Category/ Category.
471
472 SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version).contained-object-id.object-id
473
474 Actual object is contained in a maintained object with an intermediate containing object and the object type itself is hierarchical
475
476 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/ MetadataAttributeDescriptor/ MetadataAttribute/ MetadataAttribute
477
478 SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version).contained-object-id.contained-object-id contained-objectid.object-id
479
480 //__**Concrete Examples of the URN Structure**__//
481
482 The Data Structure Definition CRED_EXT_DEBT of legacy version 2.1 maintained by the toplevel Agency TFFS would have the URN:
483
484 urn:sdmx:org.sdmx.infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(2.1)
485
486 The URN for a code for Argentina maintained by ISO in the code list CL_3166A2 of semantic version 1.0.0 would be:
487
488 urn:sdmx:org.sdmx.infomodel.codelist.Code=ISO:CL_3166A2(1.0.0).AR
489
490 The URN for a category (id of 1) which has parent category (id of 2) maintained by SDMX in the category scheme SUBJECT_MATTER_DOMAINS of the semantic extended version 1.0.0draft would be:
491
492 urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:SUBJECT_MATT ER_DOMAINS(1.0.0-draft).1.2
493
494 The URN for a Metadata Attribute maintained by SDMX in the MSD CONTACT_METADATA of semantic version 1.0.0 where the hierarchy of the Metadata Attribute is CONTACT_DETAILS/CONTACT_NAME would be:
495
496 urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataAttribute=SDMX: CONTACT_METADATA(1.0.0).CONTACT_DETAILS.CONTACT_NAME
497
498 The TFFS defines ABC as a sub-Agency of TFFS then the URN of a Dataflow maintained by ABC and identified as EXTERNAL_DEBT of semantic version 1.0.0 would be:
499
500 urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=TFFS.ABC:EXTERNAL_ DEBT(1.0.0)
501
502 The SDMX-RR MUST support this globally unique identification scheme. The SDMX-RR MUST be able to create the URN from the individual identification attributes submitted and to transform the URN to these identification attributes. The identification attributes are:
503
504 * **Identifiable and Nameable Artefacts**: id (in some cases this id may be hierarchic)
505 * **Maintainable Artefacts**: id, version, agencyId
506
507 The SDMX-RR MUST be able to resolve the unique identifier of an SDMX artefact and to produce an SDMX-ML rendering of that artefact if it is located in the Registry.
508
509 ===== {{id name="_Toc90808"/}}6.2.3 Table of SDMX-IM Packages and Classes =====
510
511 The table below lists all of the packages in the SDMX-IM together with the concrete classes that are in these packages and whose objects have a URN.
512
513 |**Package**|**URN class name (model class name where this is different)**
514 |base|Agency
Helena 21.2 515 | |AgencyScheme
516 | |DataConsumer
517 | |DataConsumerScheme
518 | |DataProvider
519 | |DataProviderScheme
520 | |MetadataProvider
521 | |MetadataProviderScheme
522 | |OrganisationUnit
523 | |OrganisationUnitScheme
524 | |
Helena 2.1 525 |datastructure|AttributeDescriptor
Helena 21.2 526 | |DataAttribute
527 | |Dataflow
528 | |DataStructure (DataStructureDefinition)
529 | |Dimension
530 | |DimensionDescriptor
531 | |GroupDimensionDescriptor
532 | |Measure
533 | |MeasureDescriptor
534 | |TimeDimension
535 | |
Helena 2.1 536 |metadatastructure|MetadataAttribute
Helena 21.2 537 | |MetadataAttributeDescriptor
538 | |(((
Helena 2.1 539 MetadataStructure
540
541 (MetadataStructureDefinition)
542 )))
543
Helena 21.2 544 :
Helena 2.1 545
546 (((
547 |**Package**|**URN class name (model class name where this is different)**
Helena 21.2 548 | |Metadataflow
549 | |MetadataSet
550 | |
Helena 2.1 551 |process|Process
Helena 21.2 552 | |ProcessStep
553 | |Transition
554 | |
Helena 2.1 555 |registry|DataConstraint
Helena 21.2 556 | |MetadataConstraint
557 | |MetadataProvisionAgreement
558 | |ProvisionAgreement
559 | |Subscription
560 | |
Helena 2.1 561 |structuremapping|CategorySchemeMap
Helena 21.2 562 | |ConceptSchemeMap
563 | |OrganisationSchemeMap
564 | |ReportingTaxonomyMap
565 | |RepresentationMap
566 | |StructureMap
567 | |
Helena 2.1 568 |codelist|Code
Helena 21.2 569 | |Codelist
570 | |HierarchicalCode
571 | |Hierarchy
572 | |HierarchyAssociation
573 | |Level
574 | |ValueList
575 | |
Helena 2.1 576 |categoryscheme|Categorisation
Helena 21.2 577 | |Category
578 | |CategoryScheme
579 | |ReportingCategory
580 | |ReportingTaxonomy
Helena 2.1 581 |**Package**|**URN class name (model class name where this is different)**
Helena 21.2 582 | |
Helena 2.1 583 |conceptscheme|Concept
Helena 21.2 584 | |ConceptScheme
585 | |
Helena 2.1 586 |transformation|CustomType
Helena 21.2 587 | |CustomTypeScheme
588 | |NamePersonalisation
589 | |NamePersonalisationScheme
590 | |Ruleset
591 | |RulesetScheme
592 | |Transformation
593 | |TransformationScheme
594 | |UserDefinedOperator
595 | |UserDefinedOperatorScheme
596 | |VtlCodelistMapping
597 | |VtlConceptMapping
598 | |VtlDataflowMapping
599 | |VtlMappingScheme
600 | |
Helena 2.1 601 )))
602
603 **Table 2: SDMX-IM Packages and Contained Classes**
604
605 ===== {{id name="_Toc90809"/}}6.2.4 URN Identification components of SDMX objects =====
606
607 The table below describes the identification components for all SDMX object types that have identification. Note the actual attributes are all ‘id’ but have been prefixed by their class name or multiple class names to show navigation, e.g., ‘conceptSchemeAgencyId’ is really the ‘Id’ attribute of the Agency class that is associated to the ConceptScheme.
608
609 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:
610
611 urn:sdmx.org.sdmx.infomodel.{package}.{classname}=
612
613 |**Classname**|**Ending URN pattern**|**Example**
Helena 21.2 614 |Agency^^[[(% class="wikiinternallink wikiinternallink" %)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^|agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|ECB:**AGENCIES**(**1.0**).AA
Helena 2.1 615 |//AgencyScheme//|agencySchemeAgencyId:**AGENCIES**(**1.0**)|ECB:**AGENCIES**(**1.0**)
616 |//Categorisation//|categorisationAgencyId:categorisationId(version)|IMF:cat001(1.0.0)
617 |Category|categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|IMF:SDDS(1.0.0):level_1_category.level_2_category …
618 |//CategoryScheme//|categorySchemeAgencyId:categorySchemeId(versi on)|IMF:SDDS(1.0.0)
619
620 |**Classname**|**Ending URN pattern**|**Example**
621 |//CategorySchemeMap//|(((
622 catSchemeMapAgencyId:catSchemeMapId(version
623
624 )
625 )))|SDMX:EUROSTAT_SUBJECT_DOMAIN(1.0.0)
626 |Code|codeListAgencyId:codelistId(version).codeId|SDMX:CL_FREQ(1.0.0).Q
627 |//Codelist//|codeListAgencyId:codeListId(version)|SDMX:CL_FREQ(1.0.0)
628 |ComponentMap|structureMapAgencyId:structureMap(version).com ponentMapId|SDMX:BOP_STRUCTURES(1.0.0).REF_AREA_TO_COUNT RY
629 |Concept|conceptSchemeAgencyId:conceptSchemeId(versio n).conceptId|SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0).FREQ
630 |//ConceptScheme//|conceptSchemeAgencyId:conceptSchemeId(versio n)|SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0)
631 |//ConceptSchemeMap//|(((
632 conceptSchemeMapAgencyId:conceptSchemeMap
633
634 Id(version)
635 )))|SDMX:CONCEPT_MAP(1.0.0)
636 |CustomType|customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|ECB: CUSTOM_TYPE_SCHEME(1.0.0).CUSTOM_TYPE_1
637 |//CustomTypeScheme//|customTypeSchemeAgencyId customTypeSchemeId(version)|ECB:CUSTOM_TYPE_SCHEME(1.0.0)
638 |DataAttrribute|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dataAttributeId|TFFS:EXT_DEBT(1.0.0).OBS_STATUS
639 |//DataConstraint//|dataConstraintAgencyId:dataConstraintId(version)|TFFS:CREDITOR_DATA_CONTENT(1.0.0)
640
641 |**Classname**|**Ending URN pattern**|**Example**
642 |DataConsumer|dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**).dataConsumerId|SDMX:**DATA_CONSUMERS**(**1.0**).CONSUMER_1
643 |//DataConsumerScheme//|(((
644 dataConsumerSchemeAgencyId:**DATA_CONSUME**
645
646 **RS**(**1.0**)
647 )))|SDMX:**DATA_CONSUMERS**(**1.0**)
648 |//Dataflow//|dataflowAgencyId:dataflowId(version)|TFFS:CRED_EXT_DEBT(1.0.0)
649 |DataProvider|(((
650 dataProviderSchemeAgencyId:**DATA_PROVIDERS**(
651
652 **1.0**).dataProviderId
653 )))|SDMX:**DATA_PROVIDERS**(**1.0**).PROVIDER_1
654 |//DataProviderScheme//|(((
655 dataProviderSchemeAgencyId:**DATA_PROVIDERS**(
656
657 **1.0**)
658 )))|SDMX:**DATA_PROVIDERS**(**1.0**)
659 |//DataStructure//|dataStructureDefinitionAgencyId:dataStructureDef initionId(version)|TFFS:EXT_DEBT(1.0.0)
660 |Dimension|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dimensionId|TFFS:EXT_DEBT(1.0.0).FREQ
661 |(((
662 DimensionDescriptor
663
664 MeasureDescriptor
665
666 AttributeDescriptor
667 )))|(((
668 dataStructureDefinitionAgencyId:dataStructureDef initionId(version).componentListId
669
670 where the componentListId is the name of the class (there is only one occurrence of each in the
671
672 Data Structure Definition)
673 )))|(((
674 TFFS:EXT_DEBT(1.0.0).DimensionDescriptor
675
676 TFFS:EXT_DEBT(1.0.0).MeasureDescriptor
677
678 TFFS:EXT_DEBT(1.0.0).AttributeDescriptor
679 )))
680 |GroupDimensionDescriptor|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).groupDimensionDescriptorId|TFFS:EXT_DEBT(1.0.0).SIBLING
681 |HierarchicalCode|hierarchyAgencyId:hierarchyId(version).hierarchica lCode.hierarchicalCode|UNESCO:H-C-GOV(1.0.0).GOV_CODE1.GOV_CODE1_1
682
683 |**Classname**|**Ending URN pattern**|**Example**
684 |//Hierarchy//|hierarchyAgencyId:hierarchyId(version)|UNESCO:H-C-GOV(1.0.0)
685 |//HierarchyAssociation//|hierarchyAssociationAgencyId:hierarchyAssociatio nId(version)|UNESCO:CL_EXP_SOURCE(1.0.0)
686 |Level|hierarchyAgencyId:hierarchyId(version).level|UNESCO:H-C-GOV(1.0.0).LVL1
687 |Measure|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).measureId|TFFS:EXT_DEBT(1.0.0).OBS_VALUE
688 |MetadataAttribute|(((
689 msdAgencyId:msdId(version).metadataAttributeId.
690
691 metadataAttributeId
692 )))|IMF:SDDS_MSD(1.0.0).COMPILATION.METHOD
693 |MetadataAttributeDescriptor|msdAgencyId:msdId(version).metadataAttributeDe scriptorId|IMF:SDDS_MSD(1.0.0).MetadataAttributeDescriptor
694 |//MetadataConstraint//|metadataConstraintAgencyId:metadataConstraintI d(version)|TFFS:CREDITOR_METADATA_CONTENT(1.0.0)
695 |//Metadataflow//|metadataflowAgencyId:metadataflowId(version)|IMF:SDDS_MDF(1.0.0)
696 |MetadataProvider|metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**).metadataProviderId|SDMX:**METADATA_PROVIDERS**(**1.0**).MD_PROVIDER_1
697 |//MetadataProviderScheme//|metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**)|SDMX:**METADATA_PROVIDERS**(**1.0**)
698 |//MetadataProvisionAgreement//|metadataProvisionAgreementAgencyId:metadataP rovisionAgreementId(version)|IMF:SDDS_MDF_AB(1.0.0)
699 |//MetadataSet//|metadataProviderId:metadataSetId(version)|MD_PROVIDER:METADATASET(1.0.0)
700 |//MetadataStructure//|msdAgencyId:msdId(version)|IMF:SDDS_MSD(1.0.0)
701
702 |**Classname**|**Ending URN pattern**|**Example**
703 |NamePersonalisation|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|ECB:PSN_SCHEME(1.0.0).PSN1234
704 |//NamePersonalisationScheme//|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|ECB:PSN_SCHEME(1.0.0)
705 |//OrganisationSchemeMap//|orgSchemeMapAgencyId:orgSchemeMapId(versio n)|SDMX:AGENCIES_PROVIDERS(1.0.0)
706 |OrganisationUnit|organisationUnitSchemeAgencyId:organisationUni tSchemeId(version).organisationUnitId|ECB:ORGANISATIONS(1.0.0).1F
707 |//OrganisationUnitScheme//|organisationUnitSchemeAgencyId:organisationUni tSchemeId(version)|ECB:ORGANISATIONS(1.0.0)
708 |//Process//|processAgencyId:processId{version)|BIS:PROCESS1(1.0.0)
709 |ProcessStep|(((
710 processAgencyId:processId(version).processStepId.
711
712 processStepId
713 )))|BIS:PROCESS1(1.0.0).STEP1.STEP1_1
714 |//ProvisionAgreement//|provisionAgreementAgencyId:provisionAgreement Id(version)|TFFS:CRED_EXT_DEBT_AB(1.0.0)
715 |ReportingCategory|(((
716 reportingTaxonomyAgencyId:
717
718 reportingTaxonomyId(version).reportingCategoryI d.reportingCategoryId
719 )))|IMF:REP_1(1.0.0):LVL1_REP_CAT.LVL2_REP_CAT
720 |//ReportingTaxonomy//|reportingTaxonomyAgencyId:reportingTaxonomyI d(version)|IMF:REP_1(1.0.0)
721 |//ReportingTaxonomyMap//|repTaxonomyAgencyId:repTaxonomyId(version)|SDMX:RT_MAP(1.0.0)
722
723 |**Classname**|**Ending URN pattern**|**Example**
724 |//RepresentationMap//|repMapAgencyId:repMapId(version)|SDMX:REF_AREA_MAPPING(1.0.0)
725 |Ruleset|rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|ECB:RULESET_23(1.0.0).SET111
726 |//RulesetScheme//|rulesetSchemeAgencyId rulesetSchemeId(version)|ECB:RULESET_23(1.0.0)
727 |//StructureMap//|structureMapAgencyId:structureMap(version)|SDMX:BOP_STRUCTURES(1.0.0)
728 |Subscription|(((
729 The Subscription is not itself an Identifiable Artefact and therefore it does not follow the rules for URN structure.
730
731 The name of the URN is registryURN There is no pre-determined format.
732 )))|This cannot be generated by a common mechanism as subscriptions, although maintainable in the sense that they can be submitted and deleted, are not mandated to be created by a maintenance agency and have no versioning mechanism. It is therefore the responsibility of the target registry to generate a unique Id for the Subscription, and for the application creating the subscription to store the registry URN that is returned from the registry in the subscription response message.
733 |TimeDimension|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).timeDimensionId|TFFS:EXT_DEBT(1.0.0).TIME_PERIOD
734 |Transformation|transformationSchemeAgencyId transformationSchemeId(version) transformationId|ECB:TRANSFORMATION_SCHEME(1.0.0).TRANS_1
735 |//TransformationScheme//|transformationSchemeAgencyId transformationSchemeId(version)|ECB: TRANSFORMATION_SCHEME(1.0.0)
736 |**Classname**|**Ending URN pattern**|**Example**
737 |Transition|(((
738 processAgencyId:processId(version).processStepId.
739
740 transitionId
741 )))|BIS:PROCESS1(1.0.0).STEP1.TRANSITION1
742 |UserDefinedOperator|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|ECB:OS_CALC(1.2.0).OS267
743 |//UserDefinedOperatorScheme//|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|ECB:OS_CALC(1.2.0)
744 |//ValueList//|valuelistAgencyId:valuelistId(version)|SDMX:VLIST(1.0.0)
745 |VtlCodelistMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|ECB:CLIST_MP(2.0.0).ABZ
746 |VtlConceptMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|ECB:CLIST_MP(1.0.0).XYA
747 |VtlDataflowMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|ECB:CLIST_MP(1.0.0).MOQ
748 |//VtlMappingScheme//|vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|ECB:CLIST_MP(2.0.0)
749
750 5**Table 3: Table of identification components for SDMX Identifiable Artefacts**
751
752 = {{id name="_Toc90810"/}}7 Implementation Notes =
753
754 === {{id name="_Toc90811"/}}7.1 Structural Definition Metadata ===
755
756 ===== {{id name="_Toc90812"/}}7.1.1 Introduction =====
757
758 The SDMX Registry must have the ability to support agencies in their role of defining and disseminating structural metadata artefacts. These artefacts include data structure definitions, code lists, concepts etc. and are fully defined in the SDMX-IM. An authenticated agency may submit valid structural metadata definitions which must be stored in the registry. Note that the term “structural metadata” refers as a general term to all structural components (Data Structure Definitions, Metadata Structure Definitions, Code Lists, Concept Schemes, etc.)
759
760 At a minimum, structural metadata definitions may be submitted to and queried from the registry via an HTTP/HTTPS POST in the form of one of the SDMX-ML messages for structural metadata and the SDMX RESTful API for structure queries. The message may contain all structural metadata items for the whole registry, structural metadata items for one maintenance agency, or individual structural metadata items.
761
762 Structural metadata items
763
764 * may only be modified by the maintenance agency which created them;
765 * may only be deleted by the agency which created them;
766 * may not be deleted if they are referenced from other constructs in the Registry.
767
768 The level of granularity for the maintenance of SDMX Structural Metadata objects in the registry is the Maintainable Artefact. Especially for Item Schemes, though, partial maintenance may be performed, i.e., at the level of the Item, by submitting an Item Scheme with the 'isPartial' flag set and a reduced set of Items.
769
770 The following table lists the Maintainable Artefacts.
771
772 |(% colspan="2" %)**Maintainable Artefacts**|**Content**
Helena 21.2 773 |**Abstract Class**|**Concrete Class**|
Helena 2.1 774 |Item Scheme|Codelist|Code
Helena 21.2 775 | |Concept Scheme|Concept
776 | |Category Scheme|Category
777 | |Organisation Unit Scheme|Organisation Unit
778 | |Agency Scheme|Agency
779 | |Data Provider Scheme|Data Provider
780 | |Metadata Provider Scheme|Metadata Provider
781 | |Data Consumer Scheme|Data Consumer
782 | |Reporting Taxonomy|Reporting Category
783 | |Transformation Scheme|Transformation
784 | |Custom Type Scheme|Custom Type
785 | |Name Personalisation Scheme|Name Personalisation
786 | |Vtl Mapping Scheme|Vtl Codelist Mapping Vtl Concept Mapping
787 | |Ruleset Scheme|Ruleset
788 | |User Defined Operator Scheme|User Defined Operator
Helena 2.1 789 |Enumerated List|ValueList|Value Item
790 |Structure|Data Structure Definition|(((
791 Dimension Descriptor
792
793 Group Dimension Descriptor
794
795 Dimension
796
797 Time Dimension
798
799 Attribute Descriptor
800
801 Data Attribute
802
803 Measure Descriptor
804
805 Measure
806 )))
Helena 21.2 807 | |Metadata Structure Definition|Metadata Attribute Descriptor Metadata Attribute
808 |Structure Usage|Dataflow|
809 | |Metadataflow|
Helena 2.1 810 |None|Process|Process Step
811 |None|Structure Map|(((
812 Component Map
813
814 Epoch Map
815
816 Date Pattern Map
817 )))
818 |None|Representation Map|Representation Mapping
819 |Item Scheme Map|Organisation Scheme Map|Item Map
Helena 21.2 820 | |Concept Scheme Map|Item Map
821 | |Category Scheme Map|Item Map
822 | |Reporting Taxonomy Map|Item Map
823 |None|Provision Agreement|
824 |None|Metadata Provision Agreement|
Helena 2.1 825 |None|Hierarchy|Hierarchical Code
Helena 21.2 826 |None|Hierarchy Association|
827 |None|Categorisation|
Helena 2.1 828 |Constraint|Data Constraint|DataKeySet
Helena 21.2 829 | | |CubeRegion
Helena 2.1 830 |Constraint|Metadata Constraint|MetadataTargetRegion
831
832 **Table 4: Table of Maintainable Artefacts for Structural Definition Metadata**
833
834 ===== {{id name="_Toc90813"/}}7.1.2 Item Scheme, Structure =====
835
836 The artefacts included in the structural definitions are:
837
838 * All types of Item Scheme (Codelist, Concept Scheme, Category Scheme, Organisation Scheme, Agency Scheme, Data Provider Scheme, Metadata Provider Scheme, Data Consumer Scheme, Organisation Unit Scheme, Transformation Scheme, Name Personalisation Scheme, Custom Type Scheme, Vtl Mapping Scheme, Ruleset Scheme, User Defined Operator Scheme)
Helena 21.2 839 * All types of Enumerated List (ValueList)^^[[(% class="wikiinternallink wikiinternallink" %)^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]](%%)^^
Helena 2.1 840 * All types of Structure (Data Structure Definition, Metadata Structure Definition)
841 * All types of Structure Usage (Dataflow, Metadataflow)
842
843 ===== {{id name="_Toc90814"/}}7.1.3 Structure Usage =====
844
845 **7.1.3.1 Structure Usage: Basic Concepts**
846
847 The Structure Usage defines, in its concrete classes of Dataflow and Metadataflow, which flows of data and metadata use which specific Structure, and importantly for the support of data and metadata discovery, the Structure Usage can be linked to one or more Category in one or more Category Scheme using the Categorisation mechanism. This gives the ability for an application to discover data and metadata by “drilling down” the Category Schemes.
848
849 **7.1.3.2 Structure Usage Schematic**
850
851 [[image:SDMX 3.1 Section 5_en_9b750e13.jpg||height="246" width="438"]]
852
853 **Figure 9: Schematic of Linking the Data and Metadata Flows to Categories and Structure Definitions**
854
855 **7.1.3.3 Structure Usage Model**
856
857 [[image:SDMX 3.1 Section 5_en_1c94cbe.jpg||height="548" width="578"]]
858
859 **Figure 10: SDMX-IM of links from Structure Usage to Category**
860
861 In addition to the maintenance of the Dataflow and the Metadataflow, the following links must be maintained in the registry:
862
863 1.
864 1*. Dataflow to Data Structure Definition
865 1*. Metadataflow to Metadata Structure Definition
866
867 The following links may be created by means of a Categorisation
868
869 1.
870 1*. Categorisation to Dataflow and Category
871 1*. Categorisation to Metadataflow and Category
872
873 === {{id name="_Toc90815"/}}7.2 Data and Metadata Provisioning ===
874
875 ===== {{id name="_Toc90816"/}}7.2.1 Provisioning Agreement: Basic concepts =====
876
877 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-enabled community and hence the basis on which data can subsequently be discovered. Such a framework can be used to regulate the data content to facilitate the building of intelligent applications. It can also be used to facilitate the processing implied by service level agreements, or other provisioning agreements in those scenarios that are based on legal directives. Additionally, quality and timeliness metadata can be supported by this framework which makes it practical to implement information supply chain monitoring.
878
879 Note that the term “data provisioning” here includes both the provisioning of data and metadata.
880
881 Although the Provision Agreement directly supports the data-sharing “pull” model, it is also useful in “push” exchanges (bilateral and gateway scenarios), or in a dissemination environment. It should be noted, too, that in any exchange scenario, the registry functions as a repository of structural metadata.
882
883 ===== {{id name="_Toc90817"/}}7.2.2 Provisioning Agreement Model – pull use case =====
884
885 An organisation which publishes statistical data or reference metadata and wishes to make it available to an SDMX enabled community is called a Data Provider. In terms of the SDMX Information Model, the Data Provider is maintained in a Data Provider Scheme.
886
887 [[image:SDMX 3.1 Section 5_en_5a16c7fe.jpg||height="455" width="551"]]
888
889 **Figure 11: SDMX-IM of the Data Provider**
890
891 Note that the Data Provider does not inherit the hierarchy association. The diagram below shows a logical schematic of the data model classes required to maintain provision agreements.
892
893 [[image:SDMX 3.1 Section 5_en_b08fd1a2.jpg||height="299" width="533"]]
894
895 **Figure 12: Schematic of the Provision Agreement**
896
897 The diagram below is a logical representation of the data required in order to maintain Provision Agreements.
898
899 [[image:SDMX 3.1 Section 5_en_c63d10ab.jpg||height="246" width="579"]]
900
901 **Figure 13: Logical class diagram of the information contained in the Provision Agreement**
902
903 A Provision Agreement is structural metadata. Each Provision Agreement must reference a Data Provider or Metadata Provider and a Dataflow or Metadataflow Definition. The Data/Metadata Provider and the Dataflow/Metadataflow must exist already in order to set up a Metadata Provision or Provision Agreement.
904
905 === {{id name="_Toc90818"/}}7.3 Data and Metadata Constraints ===
906
907 ===== {{id name="_Toc90819"/}}7.3.1 Data and Metadata Constraints: Basic Concepts =====
908
909 Constraints are, effectively, lists of the valid or actual content of data and metadata. Constraints can be used to specify a subset of the theoretical content of data set or metadata set which can be derived from the specification of the DSD or MSD. A Constraint can comprise a list of keys or a list of content (usually code values) of a specific component such as a dimension or attribute.
910
911 Constraints comprise the specification of subsets of key or attribute values that are to be provided for a Dataflow or Metadataflow, or directly attached to a Data Structure Definition or Metadata Structure Definition. This is important metadata because, for example, the full range of possibilities which is implied by the Data Structure Definition (e.g., the complete set of valid keys is the Cartesian product of all the values in the code lists for each of the Dimensions) is often more than is intended to be supplied according to a specific Dataflow.
912
913 Often a Data Provider will not be able to provide data for all key combinations, either because the combination itself is not meaningful, or simply because the provider does not have the data for that combination. In this case the Data Provider could constrain the data source (at the level of the Provision Agreement or the Data Provider) by supplying metadata that defines the key combinations or cube regions that are available. This is done by means of a Constraint. The Constraint is also used to define a code list subset which is used to populate a partial code list, and in generating a schema for data reporters to validate their datasets against.
914
915 Furthermore, it is often useful to define subsets or views of the Data Structure Definition which restrict values in some code lists, especially where many such subsets restrict the same Data Structure Definition. Such a view is called a Dataflow, and there can be one or more defined for any Data Structure Definition.
916
917 Whenever data is published or made available by a Data Provider, it must conform to a Dataflow (and hence to a Data Structure Definition). The Dataflow is thus a means of enabling content based processing.
918
919 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 codes that actually exist in a data source (these can be used to build relevant selection tables).
920
921 ===== {{id name="_Toc90820"/}}7.3.2 Data and Metadata Constraints: Schematic =====
922
923 [[image:SDMX 3.1 Section 5_en_28d0cadc.jpg||height="326" width="580"]]
924
925 **Figure 14: Schematic of the Constraint and the Artefacts that can be constrained**
926
927 ===== {{id name="_Toc90821"/}}7.3.3 Data and Metadata Constraints: Model =====
928
929 [[image:SDMX 3.1 Section 5_en_a3184f6a.jpg||height="298" width="579"]]
930
931 **Figure 15: Logical class diagram showing inheritance between and reference to constrainable artefacts**
932
933 Logical class diagram showing inheritance between and reference to constrainable artefacts
934
935 The class diagram above shows that Data Provider, Metadata Provider, Dataflow, Metadataflow, Provision Agreement, Metadata Provision Agreement, Data Structure
936
937 Definition, Metadata Structure Definition are all concrete sub-classes of Constrainable Artefact and can therefore have Data Constraints specified. Note that the actual Constraint as submitted is associated to the reference classes defines in the Constraint Attachment.
938
939 these are used to refer to the classes to which the Constraint applies.
940
941 The content of the Constraint can be found in the SDMX Information Model document.
942
943 === {{id name="_Toc90822"/}}7.4 Data Registration ===
944
945 ===== {{id name="_Toc90823"/}}7.4.1 Basic Concepts =====
946
947 A Data Provider has published a new dataset conforming to an existing Dataflow (and hence Data Structure Definition). 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 RESTful query with an SDMX-ML data stream.
948
949 The Data Provider wishes to make this new data available to one or more data collectors in a “pull” scenario, or to make the data available to data consumers. To do this, the Data Provider registers the new dataset with one or more SDMX conformant registries that have been configured with structural and provisioning metadata. In other words, the registry “knows” the Data Provider and “knows” what data flows the data provider has agreed to make available.
950
951 The same mechanism can be used to report or make available a metadata set.
952
953 SDMX-RR supports dataset registration via the Registration Request, which can be created by the Data Provider (giving the Data Provider maximum control). The registry responds to the registration request with a registration response which indicates if the registration was successful. In the event of an error, the error messages are returned as a registry exception within the response.
954
955 ===== {{id name="_Toc90824"/}}7.4.2 The Registration Request =====
956
957 **7.4.2.1 Registration Request Schematic**
958
959 [[image:SDMX 3.1 Section 5_en_293a2ea6.jpg||height="337" width="554"]]
960
961 **Figure 16: Schematic of the Objects Concerned with Registration**
962
963 **7.4.2.2 Registration Request Model**
964
965 The following UML diagram shows the composition of the registration request. Each request is made up of one or more Registrations, one per dataset to be registered. The Registration can optionally have information, which has been extracted from the Registration:
966
967 * validFrom
968 * validTo
969 * lastUpdated
970
971 The last updated date is useful during the discovery process to make sure the client knows which data is freshest.
972
973 The Registration has an action attribute which takes one of the following values:
974
Helena 21.2 975 :
Helena 2.1 976
977 (((
978 |**Action Attribute Value**|**Behaviour**
979 |Append|Add this Registration to the registry
980 |Replace|Replace the existing Registration with identified by the id in the Registration of the SubmitRegistrationRequest
981 |Delete|Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest
982 )))
983
984 [[image:SDMX 3.1 Section 5_en_90b3c64a.jpg||height="434" width="579"]]
985
986 **Figure 17: Logical Class Diagram of Registration of Data and Metadata**
987
988 The //QueryDatasource// is an abstract class that represents a data source, which can understand an API query (i.e., a RESTful query – RESTDatasource) and respond appropriately. Each data source 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.
989
990 A SimpleDatasource is used to reference a physical SDMX-ML file that is available at a URL.
991
992 The RegistrationRequest has an action attribute which defines whether this is a new (append) or updated (replace) Registration, or that the Registration is to be deleted (delete). The id is only provided for the replace and delete actions, as the Registry will allocate the unique id of the (new) Registration.
993
994 The Registration includes attributes that state how a SimpleDatasource is to be indexed when registered. The Registry registration process must act as follows:
995
996 Information in the dataset is extracted and made available via the availability REST API as documented here:
997
998 https:~/~/github.com/sdmx-twg/sdmx-rest/blob/master/doc/availability.md
999
Helena 21.2 1000 :
Helena 2.1 1001
1002 (((
1003 |**Indexing Required**|**Registration Process Activity**
1004 |indexTimeSeries|Extract all the series keys and create a KeySet(s) Constraint.
1005 |indexDataSet|Extract all the codes and other content of the Key value of the Series Key in a Data Set and create one or more Cube Regions containing Member Selections of Dimension Components of the Constraints model in the SDMX-IM, and the associated Selection Value.
1006 |indexReportingPeriod|(((
1007 This applies only to a registered __dataset__.
1008
1009 Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint.
1010 )))
1011 |indexAttributes|(((
1012 **Data Set**
1013
1014 Extract the content of the Attribute Values in a Data Set and create one or more Cube Regions containing Member Selections of Data Attribute Components of the Constraints model in the SDMXIM, and the associated Selection Value
1015
1016 **Metadata Set**
1017
1018 Indicate the presence of a Reported Attribute by creating one or more Cube Regions containing Member Selections of Metadata Attribute
1019
1020 Components of the Constraints model in the
1021 )))
1022 |**Indexing Required**|**Registration Process Activity**
Helena 21.2 1023 | |SDMX-IM. Note that the content is not stored in the Selection Value.
Helena 2.1 1024 )))
1025
1026 Constraints that specify the contents of a //QueryDatasource// are submitted to the Registry via the structure submission service (i.e., the RESTful API).
1027
1028 The Registration must reference the ProvisionAgreement to which it relates.
1029
1030 ===== {{id name="_Toc90825"/}}7.4.3 Registration Response =====
1031
1032 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”.
1033
1034 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 or query service.
1035
1036 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, that the response will contain some successful and some failed statuses. The logical model for the RegistrationResponse is shown below:
1037
1038 [[image:SDMX 3.1 Section 5_en_cdba03b5.jpg||height="371" width="579"]]
1039
1040 **Figure 18: Logical class diagram showing the registration response**
1041
1042 === {{id name="_Toc90826"/}}7.5 Subscription and Notification Service ===
1043
1044 The contents of the SDMX Registry/Repository will change regularly: new code lists and key families will be published and new datasets and metadata-sets will be registered. To obviate the need for users to repeatedly query the registry to see when new information is available, a mechanism is provided to allow users to be notified when these events happen.
1045
1046 A user can submit a subscription in the registry that defines which events are of interest, and either an email and/or an HTTP address to which a notification of qualifying events will be delivered. The subscription will be identified in the registry by a URN, which is returned to the user when the subscription is created. If the user wants to delete the subscription at a later point, the subscription URN is used as identification. Subscriptions have a validity period expressed as a date range (startDate, endDate) and the registry may delete any expired subscriptions, and will notify the subscriber on expiry.
1047
1048 When a registry/repository artefact is modified, any subscriptions which are observing the object are activated, and either an email or HTTP POST is instigated to report details of the changes to the user specified in the subscription. This is called a “notification”.
1049
1050 ===== {{id name="_Toc90827"/}}7.5.1 Subscription Logical Class Diagram =====
1051
1052 [[image:SDMX 3.1 Section 5_en_1433df5d.jpg||height="680" width="587"]]
1053
1054 **Figure 19: Logical Class Diagram of the Subscription**
1055
1056 ===== {{id name="_Toc90828"/}}7.5.2 Subscription Information =====
1057
1058 Regardless of the type of registry/repository events being observed, a subscription always contains:
1059
1060 1. A set of URIs describing the end-points to which notifications must be sent if the subscription is activated. The URIs can be either mailto~: or http: protocol. In the former case an email notification is sent; in the latter an HTTP POST notification is sent.
1061 1. A user-defined identifier, which is returned in the response to the subscription request. This helps with asynchronous processing and is NOT stored in the Registry.
1062 1. A validity period which defines both when the subscription becomes active and expires. The subscriber may be sent a notification on expiration of the subscription.
1063 1. A selector which specifies which type of events are of interest. The set of event types is:
1064
1065 :
Helena 21.2 1066 ::
Helena 2.1 1067
1068 (((
1069 |**Event Type**|**Comment**
1070 |STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1071 |DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
1072 |METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
1073 |ALL_EVENTS|All events of the specified EventType
1074 )))
1075
1076 ===== {{id name="_Toc90829"/}}7.5.3 Wildcard Facility =====
1077
1078 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:
1079
1080 * agencyID
1081 * id
1082 * version
1083
1084 Examples of wildcarded identifier components for an identified object type of Codelist are shown below:
1085
1086 AgencyID = *
1087
1088 Id = *
1089
1090 Version = *
1091
1092 This subscribes to all Codelists of all versions for all agencies.
1093
1094 AgencyID = AGENCY1
1095
1096 Id = CODELIST1
1097
1098 Version = *
1099
1100 This subscribes to all versions of Codelist CODELIST1 maintained by the agency AGENCY1.
1101
1102 AgencyID = AGENCY1
1103
1104 Id = *
1105
1106 Version = *
1107
1108 This subscribes to all versions of all Codelist objects maintained by the agency AGENCY1.
1109
1110 AgencyID = *
1111
1112 Id = CODELIST1
1113
1114 Version = *
1115
1116 This subscribes to all versions of Codelist CODELIST1 maintained by any agency.
1117
1118 Note that if the subscription is to the latest stable version then this can be achieved by the + character, i.e.:
1119
1120 Version = +
1121
1122 A subscription to the latest version (whether stable, draft or non-versioned) can be achieved by the ~~ character, i.e.:
1123
1124 Version = ~~
1125
1126 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.:
1127
1128 Version = 2.3+.1
1129
1130 The complete SDMX versioning syntax can be found in the SDMX Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”.
1131
1132 ===== {{id name="_Toc90830"/}}7.5.4 Structural Repository Events =====
1133
1134 Whenever a maintainable artefact (data structure definition, concept scheme, codelist, metadata structure definition, category scheme, etc.) is added to, deleted from, or modified in the structural metadata repository, a structural metadata event is triggered. Subscriptions may be set up to monitor all such events, or focus on specific artefacts such as a Data Structure Definition.
1135
1136 ===== {{id name="_Toc90831"/}}7.5.5 Registration Events =====
1137
1138 Whenever a dataset or metadata-set is registered a registration event is created. A subscription may be observing all data or metadata registrations, or it may focus on specific registrations as shown in the table below:
1139
Helena 21.2 1140 :
Helena 2.1 1141
1142 (((
1143 |**Selector**|**Comment**
1144 |DataProvider|Any datasets registered by the specified dataprovider will activate the notification.
1145 |ProvisionAgreement|Any datasets for the agreement will activate the notification.
1146 |Dataflow|Any datasets for the specified dataflow will activate the notification.
1147 |DataStructureDefinition|Any datasets for those dataflows that are based on the specified Data Structure Definition will activate the notification
1148 |Category|Any datasets registered for those dataflows, provision agreements that are categorised by the category.
1149 )))
1150
1151 The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration.
1152
1153 == {{id name="_Toc90832"/}}7.6 Notification ==
1154
1155 ==== {{id name="_Toc90833"/}}7.6.1 Logical Class Diagram ====
1156
1157 [[image:SDMX 3.1 Section 5_en_8bc1b889.jpg||height="379" width="579"]]
1158
1159 **Figure 20: Logical Class Diagram of the Notification**
1160
1161 A notification is an XML document that is sent to a user via email or http POST whenever a subscription is activated. It is an asynchronous one-way message.
1162
1163 Regardless of the registry component that caused the event to be triggered, the following common information is in the message:
1164
1165 * Date and time that the event occurred
1166 * The URN of the artefact that caused the event
1167 * The URN of the Subscription that produced the notification
1168 * Event Action: Add, Replace, or Delete.
1169
1170 Additionally, supplementary information may be contained in the notification as detailed below.
1171
1172 ==== {{id name="_Toc90834"/}}7.6.2 Structural Event Component ====
1173
1174 The notification will contain the MaintainableArtefact that triggered the event in a form similar to the SDMX-ML structural message (using elements from that namespace).
1175
1176 ==== {{id name="_Toc90835"/}}7.6.3 Registration Event Component ====
1177
1178 The notification will contain the Registration.
1179
1180 [[1>>path:#sdfootnote1anc||name="sdfootnote1sym"]] 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.
1181
1182 [[2>>path:#sdfootnote2anc||name="sdfootnote2sym"]] The identification of an Agency in the URN structure for the maintainable object is by means of the agencyId. The AgencyScheme is not identified as SDMX has a mechanism for identifying an Agency uniquely by its Id. Note that this Id may be hierarchical. For example, a sub-agency of IMF is referred like this:
1183
1184 IMF.SubAgency1
1185
1186 [[3>>path:#sdfootnote3anc||name="sdfootnote3sym"]] Note that Codelist is also an EnumeratedList.