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