Skip to Content
Version 22.16 by Helena on 2025/06/08 17:10
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-twg/sdmx-rest__>>https://https:github.comsdmx-twgsdmx-rest]]). In order for the architecture to be scalable, the finest-grained piece of structural metadata that can be processed by the SDMX-RR is a MaintainableArtefact, with the exception of Item Schemes, where changes at an Item level is also possible (see next section on the SDMX Information Model).
184
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-twg/sdmx-rest__>>https://https:github.comsdmx-twgsdmx-rest]]). The registry response to this query mechanism is the SDMX Structure message, which has as its root node:
188
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-twg/sdmx-rest/blob/master/doc/structures.md>>https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]] __[[https:~~/~~/github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md>>https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]]
192
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>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] conformant files and web-accessible databases containing published data and [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] to be registered in the [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]]. The registration process MAY validate the content of the [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] or metadata-sets, and MAY extract a concise [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the contents in terms of (% style="color:#e74c3c" %)concept(%%) values (e.g., values of the data [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]), or entire keys, and storing this as a record in the registry to enable discovery of the original [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] or metadata-set. These are called (% style="color:#e74c3c" %)Constraints(%%) in the [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]].
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>>doc:sdmx:Glossary.Data set.WebHome]] or metadataset;
207 * that the content of the [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] or metadataset meets the validation (% style="color:#e74c3c" %)constraints(%%). This is dependent upon such (% style="color:#e74c3c" %)constraints(%%) being defined in the structural repository and which reference the relevant [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]], [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]], Metadata Provider, [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], Metadata [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]];
208 * that a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] exists – this would necessitate the registration service querying the service to determine its existence;
209 * that a simple [[data source>>doc:sdmx:Glossary.Data source.WebHome]] exists (i.e., a file accessible at a URL);
210 * that the correct [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] is used by the registered data;
211 * that the [[components>>doc:sdmx:Glossary.Component.WebHome]] ([[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]], [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]], [[Measures>>doc:sdmx:Glossary.Measure.WebHome]]) are consistent with the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]];
212 * that the valid [[representations>>doc:sdmx:Glossary.Representation.WebHome]] of the (% style="color:#e74c3c" %)concepts(%%) to which these [[components>>doc:sdmx:Glossary.Component.WebHome]] correspond conform to the definition in the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]].
213
214 The Registration has an action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] which takes one of the following values:
215
216 (% style="width:893.835px" %)
217 |(% style="width:241px" %)**Action [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] 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>>doc:sdmx:Glossary.Attribute.WebHome]] which may be present to determine how an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] compliant [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] or metadataset indexing application must index the [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] or metadatasets upon registration. The indexing application behaviour is as follows:
223
224 (% style="width:896.835px" %)
225 |**Boolean [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]**|(% 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>>doc:sdmx:Glossary.Dimension.WebHome]] of the [[Dataset>>doc:sdmx:Glossary.Data set.WebHome]].
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>>doc:sdmx:Glossary.Dimension.WebHome]] values (the Key) is actually present in the [[Dataset>>doc:sdmx:Glossary.Data set.WebHome]]
230 )))
231 |indexReportingPeriod|(% style="width:712px" %)A compliant indexing application must index the [[time period>>doc:sdmx:Glossary.Time period.WebHome]] range(s) for which data are present in the [[Dataset>>doc:sdmx:Glossary.Data set.WebHome]].
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>>doc:sdmx:Glossary.Subscription.WebHome]] and [[Notification>>doc:sdmx:Glossary.Notification.WebHome]] 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>>doc:sdmx:Glossary.Data provider.WebHome]]’ dissemination systems. For this to work efficiently, a [[data consumer>>doc:sdmx:Glossary.Data consumer.WebHome]] needs to know when to pull data, i.e., when something has changed in the registry (e.g., a [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] has been updated and re-registered). Additionally, [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] systems may also want to know if a new [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], or [[Code List>>doc:sdmx:Glossary.Code list.WebHome]] has been added. The [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] and [[Notification>>doc:sdmx:Glossary.Notification.WebHome]] Service comprises two parts: [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] management, and [[notification>>doc:sdmx:Glossary.Notification.WebHome]].
249
250 [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] management involves a user submitting a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request which contains:
251
252 * a query or (% style="color:#e74c3c" %)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>>doc:sdmx:Glossary.Dataflow.WebHome]], or for a domain [[category>>doc:sdmx:Glossary.Category.WebHome]], or changes to a [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]).
253 * a list of URIs or endpoints to which an XML [[notification>>doc:sdmx:Glossary.Notification.WebHome]] message can be sent. Supported endpoint types will be email (mailto and HTTP POST (a normal http:~/~/ address);
254 * request for a list of submitted [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]];
255 * deletion of a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]];
256
257 [[Notification>>doc:sdmx:Glossary.Notification.WebHome]] requires that the [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository and the provisioning [[metadata repository>>doc:sdmx:Glossary.Metadata repository.WebHome]] monitor any event which is of interest to a user (the object of a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request query), and to issue an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[notification>>doc:sdmx:Glossary.Notification.WebHome]] document to the endpoints specified in the relevant [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]].
258
259 === 5.2.7 Registry Behaviour ===
260
261 The following table defines the behaviour of the [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] for the various Registry Interface messages. It should be noted, though, that as of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0, an extended versioning scheme newly including semantic versioning is foreseen for all [[Maintainable Artefacts>>doc:sdmx:Glossary.Maintainable artefact.WebHome]]. Moreover, while the old versioning scheme is allowed, given there is no more a "final" flag, there is no way guaranteeing the consistency across (% style="color:#e74c3c" %)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>>doc:sdmx:Glossary.Artefact.WebHome]] using semantic versioning or any [[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] using the old versioning scheme. Nevertheless, in the case of semantic versioning the registry must respect the versioning rules when performing the actions below. For example, it is not possible to replace a non-draft [[Artefact>>doc:sdmx:Glossary.Artefact.WebHome]] that follows semantic versioning, unless a newer (% style="color:#e74c3c" %)version(%%) is introduced according to the semantic versioning rules. Furthermore, even when draft [[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] are submitted, the registry has to verify semantic versioning is respected against the previous non-draft (% style="color:#e74c3c" %)versions(%%). It is worth noting that the rules for semantic versioning and replacing or maintaining semantically versioned [[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] applies to externally shared [[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]. This means that any system may internally perform any change within a (% style="color:#e74c3c" %)version(%%) of an [[Artefact>>doc:sdmx:Glossary.Artefact.WebHome]], until the latter is shared outside of that system or becomes public. Then (as also explained in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”) the [[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] must adhere to the Semantic Versioning rules.
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>>doc:sdmx:Glossary.Maintainable artefact.WebHome]] is PUT or POSTed) then the entire contents of the existing maintainable object in the Registry MUST be replaced by the object submitted.
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>>doc:sdmx:Glossary.Maintainable artefact.WebHome]] is DELETEd) then the Registry MUST verify that the object can be deleted. In order to qualify for deletion, the object must:
271
272 a) Be a draft (% style="color:#e74c3c" %)version(%%).
273 b) Not be explicitly{{footnote}}With semantic versioning, it is allowed to reference a range of artefacts, e.g., a DSD referencing a Codelist with version 1.2.3+ means all patch versions greater than 1.2.3. This means that deleting 1.2.4draft does not break integrity of the aforementioned DSD.{{/footnote}} referenced from any other object in the Registry.
274
275 4) The semantic versioning rules in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] documentation MUST be obeyed.
276 )))
277 |(% style="width:217px" %)Structure submission|(% style="width:763px" %)(((
278 Structures are submitted at the (% style="color:#e74c3c" %)level(%%) of the [[Maintainable Artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]] and the behaviour in “All” above is therefore at the (% style="color:#e74c3c" %)level(%%) of the [[Maintainable Artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]].
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>>doc:sdmx:Glossary.Attribute.WebHome]] set in the Registration. For a queryable datasource the Registry MAY validate that the source exists and can accept an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] data query.
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>>doc:sdmx:Glossary.SDMX Information Model.WebHome]] 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 (% style="color:#e74c3c" %)version(%%) number, according to the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”, and a validity period.
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>>doc:sdmx:Glossary.Artefact.WebHome]] in the [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]**
298
299 The table below shows the identification and related data [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] to be stored in a registry for objects that are one of:
300
301 * //Annotable//
302 * //Identifiable//
303 * //Nameable//
304 * //Versionable//
305 * //Maintainable//
306
307 (% style="width:1038.83px" %)
308 |(% colspan="2" %)**Object Type**|(% colspan="2" %)**Data [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]**|(% colspan="2" %)**Status**|(% colspan="2" %)**Data type**|(% colspan="2" %)**Notes**
309 |(% colspan="2" rowspan="4" %)//Annotable//|(% colspan="2" %)AnnotationTitle|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
310 |(% colspan="2" %)AnnotationType|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
311 |(% colspan="2" %)AnnotationURN|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
312 |(% colspan="2" %)(((
313 AnnotationText in the form of InternationalString
314 )))|(% colspan="2" %)C|(% colspan="2" %) |(% colspan="2" %)This can have languagespecific variants
315 |(% colspan="2" rowspan="4" %)//Identifiable//|(% colspan="2" %)All content as for //Annotable// plus|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
316 |(% colspan="2" %)id|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)
317 |(% colspan="2" %)uri|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
318 |(% 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.
319 |(% colspan="2" rowspan="3" %)//Nameable//|(% colspan="2" %)(((
320 All content as for //Identifiable// plus
321 )))|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
322 |(% colspan="2" %)(((
323 Name in the form of InternationalString
324 )))|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)This can have language specific variants.
325 |(% colspan="2" %)(((
326 Description in the form of InternationalString
327 )))|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)This can have language specific variants.
328 |(% colspan="2" rowspan="4" %)//Versionable//|(% colspan="2" %)(((
329 All content as for
330
331 //Identifiable// plus
332 )))|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
333 |(% colspan="2" %)(% style="color:#e74c3c" %)version|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)This is the (% style="color:#e74c3c" %)version(%%) number according to [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules.
334 |(% colspan="2" %)validFrom|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %)
335 |(% colspan="2" %)validTo|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %)
336 |(% colspan="2" %)//Maintainable//|(% colspan="2" %)All content as for //Versionable// plus|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
337 |(% colspan="2" %) |(% colspan="2" %)[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]|(% colspan="2" %)C|(% colspan="2" %)boolean|(% colspan="2" %)Value of “true” indicates that the actual resource is held outside of this registry. The actual reference is given in the registry URI or the structureURL, each of which must return a valid [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] file.
338 |(% colspan="2" %) |(% colspan="2" %)serviceURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the service that can be queried for this resource.
339 |(% colspan="2" %) |(% colspan="2" %)structureURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the resource.
340 |(% colspan="2" %) |(% colspan="2" %)(Maintenance) organisationId|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)The object must be linked to a maintenance organisation, i.e., Agency or Metadata Provider.
341
342 **Table 1: Common [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]] of Object Types**
343
344 == 6.2 Unique identification of SDMX objects ==
345
346 === 6.2.1 Agencies and Metadata Providers ===
347
348 The [[Maintenance Agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] is maintained in an [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]] which itself is a sub class of Organisation Scheme – this is shown in the class diagram below.
349
350 [[image:SDMX 3.1 Section 5_en_67b3555e.jpg||height="313" width="554"]]
351
352 **Figure 6: Agency Scheme Model**
353
354 The Agency in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] is extremely important. The Agency Id system used in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] is an nlevel structure. The top (% style="color:#e74c3c" %)level(%%) of this structure is maintained by [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]. Any Agency in this top (% style="color:#e74c3c" %)level(%%) can declare sub agencies and any sub agency can also declare sub agencies. The [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]] has a fixed id and (% style="color:#e74c3c" %)version(%%) ((% style="color:#e74c3c" %)version(%%) ‘1.0’) and is never declared explicitly in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object identification mechanism.
355
356 In order to achieve this [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] adopts the following rules:
357
358 * Agencies are maintained in an [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]] (which is a sub class of Organisation Scheme).
359 * The agency of the [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]] must also be declared in a (different) [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]].
360 * The “top-(% style="color:#e74c3c" %)level(%%)” agency is [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] and maintains the “top-(% style="color:#e74c3c" %)level(%%)” [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]].
361 * Agencies registered in the top-(% style="color:#e74c3c" %)level(%%) scheme can themselves maintain a single [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]]. Agencies in these second-tier schemes can themselves maintain a single [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]] and so on.
362 * The AgencyScheme has a fixed (% style="color:#e74c3c" %)version(%%), i.e., ‘1.0’, hence it is an exception from the Semantic Versioning that other [[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] follow.
363 * There can be only one AgencyScheme maintained by any one Agency. It has a fixed id of AGENCIES.
364 * The /[[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] of Organisation is not inherited by [[Maintenance Agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] – thus each [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]] is a flat list of [[Maintenance Agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]].
365 * The format of the agency identifier is agencyID.agencyID etc. The top-(% style="color:#e74c3c" %)level(%%) agency in this identification mechanism is the agency registered in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[agency scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]]. In other words, [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] is not a part of the hierarchical ID structure for agencies. However, [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] is, itself, a [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] and is contained in the top-(% style="color:#e74c3c" %)level(%%) [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]].
366
367 This supports a hierarchical structure of agencyID.
368
369 An example is shown below.
370
371 [[image:SDMX 3.1 Section 5_en_d02edd62.jpg||height="251" width="432"]]
372
373 **Figure 7: Example of Hierarchic Structure of Agencies**
374
375 The following organizations maintain an [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]].
376
377 * [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] – contains Agencies AA, BB
378 * AA – contains Agencies CC, DD
379 * BB – contains Agencies CC, DD
380 * DD – Contains Agency EE
381
382 Each agency is identified by its full [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] excluding [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]].
383
384 e.g., the id of EE as an agencyID is AA.DD.EE
385
386 An example of this is shown in the XML snippet below:
387
388 **Figure 8: Example Showing Use of Agency Identifiers**
389
390 Each of these [[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]] has an identical [[Code list>>doc:sdmx:Glossary.Code list.WebHome]] with the Id CL_BOP. However, each is uniquely identified by means of the hierarchic agency structure.
391
392 Following the same principles, the Metadata Provider is the maintenance organisation for a special subset of [[Maintainable Artefacts>>doc:sdmx:Glossary.Maintainable artefact.WebHome]], i.e., the Metadatasets; the latter are the containers of [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] combined with a target that those metadata refer to.
393
394 === 6.2.2 Universal Resource Name (URN) ===
395
396 ==== 6.2.2.1 Introduction ====
397
398 To provide interoperability between [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]]/Repositories in a distributed network environment, it is important to have a scheme for uniquely identifying (and thus accessing) all first-class (Identifiable) [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]] objects. Most of these unique identifiers are composite (containing [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]], or parent object identifiers), and there is a need to be able to construct a unique reference as a single string. This is achieved by having a globally unique identifier called a universal resource name (URN) which is generated from the actual identification [[components>>doc:sdmx:Glossary.Component.WebHome]] in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-RR APIs. In other words, the URN for any [[Identifiable Artefact>>doc:sdmx:Glossary.Identifiable artefact.WebHome]] is constructed from its [[component>>doc:sdmx:Glossary.Component.WebHome]] identifiers (agency, id, (% style="color:#e74c3c" %)version(%%) etc.).
399
400 ==== 6.2.2.2 URN Structure //__Case Rules for URN__// ====
401
402 For the URN, all parts of the string are case sensitive. The generic structure of the URN is as follows:
403
404 SDMXprefix.[[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]-package-name.class-name=agencyid:maintainedobjectid(maintainedobject-(% style="color:#e74c3c" %)version(%%)).*containerobject-id.object-id
405
406 ~* this can repeat and may not be present (see explanation below)
407
408 Note that in the [[SDMX Information Model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]] there are no concrete [[Versionable Artefacts>>doc:sdmx:Glossary.Versionable artefact.WebHome]] that are not a [[Maintainable Artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]]. For this reason, the only (% style="color:#e74c3c" %)version(%%) information that is allowed is for the maintainable object.
409
410 The [[Maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] identifier is separated from the [[maintainable artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]] identifier by a colon ‘:’. All other identifiers in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] URN syntax are separated by a period ‘.’. The (% style="color:#e74c3c" %)version(%%) information is encapsulated in parentheses ‘()’ and adheres to the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules, as explained in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning.
411
412 ==== 6.2.2.3 Explanation of the generic structure ====
413
414 In the explanation below the actual object that is the target of the URN is called the **actual object**.
415
416 **SDMXPrefix**: urn:sdmx:org
417
418 **SDMX-IM-package-name**: sdmx.infomodel.package=
419
420 The packages are:
421
422 base codelist conceptscheme datastructure categoryscheme registry metadatastructure process structuremapping transformation
423
424 **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.
425
426 **maintainable-object-version** is the (% style="color:#e74c3c" %)version(%%), according to the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules, of the maintainable object and is enclosed in parentheses ‘()’, which are always present.
427
428 **container-object-id** is the identifier of an intermediary object that contains the actual object which the URN is identifying. It is not mandatory as many actual objects do not have an intermediary container object. For instance, a [[Code>>doc:sdmx:Glossary.Code.WebHome]] is in a maintained object (Codelist) and has no intermediary container object, whereas a MetadataAttribute has an intermediary container object (MetadataAttributeDescriptor) and may have an intermediary container object, which is its parent MetadataAttribute. For this reason, the container object id may repeat, with each repetition identifying the object at the next-lower (% style="color:#e74c3c" %)level(%%) in its [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]. Note that if there is only a single containing object in the model then it is NOT included in the URN structure. This applies to AttributeDescriptor, DimensionDescriptor, and MeasureDescriptor where there can be only one such object and this object has a fixed id. Therefore, whilst each of these has a URN, the id of the AttributeDescriptor, DimensionDescriptor, and MeasureDescriptor is not included when the actual object is a DataAttribute or a [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]/ TimeDimension, or a Measure.
429
430 Note that although a [[Code>>doc:sdmx:Glossary.Code.WebHome]] can have a parent [[Code>>doc:sdmx:Glossary.Code.WebHome]] and a (% style="color:#e74c3c" %)Concept(%%) can have a parent (% style="color:#e74c3c" %)Concept(%%) these are maintained in a flat structure and therefore do not have a containerobject-id.
431
432 For example, the sequence is agency:DSDid((% style="color:#e74c3c" %)version(%%)).DimensionId and not agency:DSDid((% style="color:#e74c3c" %)version(%%)).DimensionDescriptorId.DimensionId.
433
434 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.
435
436 //__**Generic Examples of the URN Structure**__//
437
438 __Actual object is a maintainable__
439
440 SDMXPrefix.[[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid((% style="color:#e74c3c" %)version(%%))
441
442 __Actual object is contained in a maintained object with no intermediate containing object__
443
444 SDMXPrefix.[[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid((% style="color:#e74c3c" %)version(%%)).object-id
445
446 __Actual object is contained in a maintained object with an intermediate containing object__
447
448 SDMXPrefix.[[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid((% style="color:#e74c3c" %)version(%%)).contained-object-id.object-id
449
450 __Actual object is contained in a maintained object with no intermediate containing__ __object but__ __the object type itself is hierarchical__
451
452 In this case the object id may not be unique in itself but only within the context of the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]. In the general syntax of the URN all intermediary objects in the structure (with the exception, of course, of the maintained object) are shown as a contained object. An example here would be a [[Category>>doc:sdmx:Glossary.Category.WebHome]] in a CategoryScheme. The [[Category>>doc:sdmx:Glossary.Category.WebHome]] is hierarchical, and all intermediate [[Categories>>doc:sdmx:Glossary.Category.WebHome]] are shown as a contained object. The example below shows the generic structure for CategoryScheme/ [[Category>>doc:sdmx:Glossary.Category.WebHome]]/ [[Category>>doc:sdmx:Glossary.Category.WebHome]].
453
454 SDMXPrefix.[[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid((% style="color:#e74c3c" %)version(%%)).contained-object-id.object-id
455
456 Actual object is contained in a maintained object with an intermediate containing object and the object type itself is hierarchical
457
458 In this case the generic syntax is the same as for the example above as the parent object is regarded as a containing object, even if it is of the same type. An example here is a MetadataAttribute where the contained objects are MetadataAttributeDescriptor (first contained object id) and MetadataAttribute (subsequent contained object ids). The example below shows the generic structure for [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]/ MetadataAttributeDescriptor/ MetadataAttribute/ MetadataAttribute
459
460 SDMXPrefix.[[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid((% style="color:#e74c3c" %)version(%%)).contained-object-id.contained-object-id contained-objectid.object-id
461
462 //__**Concrete Examples of the URN Structure**__//
463
464 The [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] CRED_EXT_DEBT of legacy (% style="color:#e74c3c" %)version(%%) 2.1 maintained by the toplevel Agency TFFS would have the URN:
465
466 urn:sdmx:org.sdmx.infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(2.1)
467
468 The URN for a [[code>>doc:sdmx:Glossary.Code.WebHome]] for Argentina maintained by ISO in the [[code list>>doc:sdmx:Glossary.Code list.WebHome]] CL_3166A2 of semantic (% style="color:#e74c3c" %)version(%%) 1.0.0 would be:
469
470 urn:sdmx:org.sdmx.infomodel.codelist.Code=ISO:CL_3166A2(1.0.0).AR
471
472 The URN for a [[category>>doc:sdmx:Glossary.Category.WebHome]] (id of 1) which has parent [[category>>doc:sdmx:Glossary.Category.WebHome]] (id of 2) maintained by [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] in the [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] SUBJECT_MATTER_DOMAINS of the semantic extended (% style="color:#e74c3c" %)version(%%) 1.0.0draft would be:
473
474 urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:SUBJECT_MATT ER_DOMAINS(1.0.0-draft).1.2
475
476 The URN for a Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] maintained by [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] in the [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] CONTACT_METADATA of semantic (% style="color:#e74c3c" %)version(%%) 1.0.0 where the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] of the Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is CONTACT_DETAILS/CONTACT_NAME would be:
477
478 urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataAttribute=SDMX: CONTACT_METADATA(1.0.0).CONTACT_DETAILS.CONTACT_NAME
479
480 The TFFS defines ABC as a sub-Agency of TFFS then the URN of a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] maintained by ABC and identified as EXTERNAL_DEBT of semantic (% style="color:#e74c3c" %)version(%%) 1.0.0 would be:
481
482 urn:sdmx:org.sdmx.infomodel.datastructure.[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]=TFFS.ABC:EXTERNAL_ DEBT(1.0.0)
483
484 The [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-RR MUST support this globally unique identification scheme. The [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-RR MUST be able to create the URN from the individual identification [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] submitted and to transform the URN to these identification [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. The identification [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] are:
485
486 * **Identifiable and [[Nameable Artefacts>>doc:sdmx:Glossary.Nameable artefact.WebHome]]**: id (in some cases this id may be hierarchic)
487 * **[[Maintainable Artefacts>>doc:sdmx:Glossary.Maintainable artefact.WebHome]]**: id, (% style="color:#e74c3c" %)version(%%), agencyId
488
489 The [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-RR MUST be able to resolve the unique identifier of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] and to produce an [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] rendering of that [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] if it is located in the Registry.
490
491 === 6.2.3 Table of SDMX-IM Packages and Classes ===
492
493 The table below lists all of the packages in the [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]] together with the concrete classes that are in these packages and whose objects have a URN.
494
495 (% style="width:750.835px" %)
496 |(% style="width:222px" %)**Package**|(% style="width:526px" %)**URN class name (model class name where this is different)**
497 |(% style="width:222px" %)base|(% style="width:526px" %)Agency
498 |(% style="width:222px" %) |(% style="width:526px" %)AgencyScheme
499 |(% style="width:222px" %) |(% style="width:526px" %)DataConsumer
500 |(% style="width:222px" %) |(% style="width:526px" %)DataConsumerScheme
501 |(% style="width:222px" %) |(% style="width:526px" %)DataProvider
502 |(% style="width:222px" %) |(% style="width:526px" %)DataProviderScheme
503 |(% style="width:222px" %) |(% style="width:526px" %)MetadataProvider
504 |(% style="width:222px" %) |(% style="width:526px" %)MetadataProviderScheme
505 |(% style="width:222px" %) |(% style="width:526px" %)OrganisationUnit
506 |(% style="width:222px" %) |(% style="width:526px" %)OrganisationUnitScheme
507 |(% style="width:222px" %) |(% style="width:526px" %)
508 |(% style="width:222px" %)datastructure|(% style="width:526px" %)AttributeDescriptor
509 |(% style="width:222px" %) |(% style="width:526px" %)DataAttribute
510 |(% style="width:222px" %) |(% style="width:526px" %)[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]
511 |(% style="width:222px" %) |(% style="width:526px" %)DataStructure (DataStructureDefinition)
512 |(% style="width:222px" %) |(% style="width:526px" %)[[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]
513 |(% style="width:222px" %) |(% style="width:526px" %)DimensionDescriptor
514 |(% style="width:222px" %) |(% style="width:526px" %)GroupDimensionDescriptor
515 |(% style="width:222px" %) |(% style="width:526px" %)Measure
516 |(% style="width:222px" %) |(% style="width:526px" %)MeasureDescriptor
517 |(% style="width:222px" %) |(% style="width:526px" %)TimeDimension
518 |(% style="width:222px" %) |(% style="width:526px" %)
519 |(% style="width:222px" %)metadatastructure|(% style="width:526px" %)MetadataAttribute
520 |(% style="width:222px" %) |(% style="width:526px" %)MetadataAttributeDescriptor
521 |(% style="width:222px" %) |(% style="width:526px" %)(((
522 MetadataStructure
523
524 (MetadataStructureDefinition)
525 )))
526
527 (((
528 (% style="width:751.835px" %)
529 |(% style="width:221px" %)**Package**|(% style="width:528px" %)**URN class name (model class name where this is different)**
530 |(% style="width:221px" %) |(% style="width:528px" %)[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]
531 |(% style="width:221px" %) |(% style="width:528px" %)MetadataSet
532 |(% style="width:221px" %) |(% style="width:528px" %)
533 |(% style="width:221px" %)process|(% style="width:528px" %)Process
534 |(% style="width:221px" %) |(% style="width:528px" %)ProcessStep
535 |(% style="width:221px" %) |(% style="width:528px" %)Transition
536 |(% style="width:221px" %) |(% style="width:528px" %)
537 |(% style="width:221px" %)registry|(% style="width:528px" %)DataConstraint
538 |(% style="width:221px" %) |(% style="width:528px" %)MetadataConstraint
539 |(% style="width:221px" %) |(% style="width:528px" %)MetadataProvisionAgreement
540 |(% style="width:221px" %) |(% style="width:528px" %)ProvisionAgreement
541 |(% style="width:221px" %) |(% style="width:528px" %)[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]
542 |(% style="width:221px" %) |(% style="width:528px" %)
543 |(% style="width:221px" %)structuremapping|(% style="width:528px" %)CategorySchemeMap
544 |(% style="width:221px" %) |(% style="width:528px" %)ConceptSchemeMap
545 |(% style="width:221px" %) |(% style="width:528px" %)OrganisationSchemeMap
546 |(% style="width:221px" %) |(% style="width:528px" %)ReportingTaxonomyMap
547 |(% style="width:221px" %) |(% style="width:528px" %)RepresentationMap
548 |(% style="width:221px" %) |(% style="width:528px" %)StructureMap
549 |(% style="width:221px" %) |(% style="width:528px" %)
550 |(% style="width:221px" %)codelist|(% style="width:528px" %)[[Code>>doc:sdmx:Glossary.Code.WebHome]]
551 |(% style="width:221px" %) |(% style="width:528px" %)Codelist
552 |(% style="width:221px" %) |(% style="width:528px" %)HierarchicalCode
553 |(% style="width:221px" %) |(% style="width:528px" %)[[Hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]
554 |(% style="width:221px" %) |(% style="width:528px" %)HierarchyAssociation
555 |(% style="width:221px" %) |(% style="width:528px" %)(% style="color:#e74c3c" %)Level
556 |(% style="width:221px" %) |(% style="width:528px" %)ValueList
557 |(% style="width:221px" %) |(% style="width:528px" %)
558 |(% style="width:221px" %)categoryscheme|(% style="width:528px" %)Categorisation
559 |(% style="width:221px" %) |(% style="width:528px" %)[[Category>>doc:sdmx:Glossary.Category.WebHome]]
560 |(% style="width:221px" %) |(% style="width:528px" %)CategoryScheme
561 |(% style="width:221px" %) |(% style="width:528px" %)ReportingCategory
562 |(% style="width:221px" %) |(% style="width:528px" %)ReportingTaxonomy
563 |(% style="width:221px" %)**Package**|(% style="width:528px" %)**URN class name (model class name where this is different)**
564 |(% style="width:221px" %) |(% style="width:528px" %)
565 |(% style="width:221px" %)conceptscheme|(% style="width:528px" %)(% style="color:#e74c3c" %)Concept
566 |(% style="width:221px" %) |(% style="width:528px" %)ConceptScheme
567 |(% style="width:221px" %) |(% style="width:528px" %)
568 |(% style="width:221px" %)transformation|(% style="width:528px" %)CustomType
569 |(% style="width:221px" %) |(% style="width:528px" %)CustomTypeScheme
570 |(% style="width:221px" %) |(% style="width:528px" %)NamePersonalisation
571 |(% style="width:221px" %) |(% style="width:528px" %)NamePersonalisationScheme
572 |(% style="width:221px" %) |(% style="width:528px" %)Ruleset
573 |(% style="width:221px" %) |(% style="width:528px" %)RulesetScheme
574 |(% style="width:221px" %) |(% style="width:528px" %)Transformation
575 |(% style="width:221px" %) |(% style="width:528px" %)TransformationScheme
576 |(% style="width:221px" %) |(% style="width:528px" %)UserDefinedOperator
577 |(% style="width:221px" %) |(% style="width:528px" %)UserDefinedOperatorScheme
578 |(% style="width:221px" %) |(% style="width:528px" %)VtlCodelistMapping
579 |(% style="width:221px" %) |(% style="width:528px" %)VtlConceptMapping
580 |(% style="width:221px" %) |(% style="width:528px" %)VtlDataflowMapping
581 |(% style="width:221px" %) |(% style="width:528px" %)VtlMappingScheme
582 |(% style="width:221px" %) |(% style="width:528px" %)
583 )))
584
585 **Table 2: SDMX-IM Packages and Contained Classes**
586
587 === 6.2.4 URN Identification components of SDMX objects ===
588
589 The table below describes the identification [[components>>doc:sdmx:Glossary.Component.WebHome]] for all [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object types that have identification. Note the actual [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] are all ‘id’ but have been prefixed by their class name or multiple class names to show navigation, e.g., ‘conceptSchemeAgencyId’ is really the ‘Id’ [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] of the Agency class that is associated to the ConceptScheme.
590
591 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:
592
593 urn:[[sdmx>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]].org.[[sdmx>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]].infomodel.{package}.{classname}=
594
595 (% style="width:1272.83px" %)
596 |(% style="width:289px" %)**Classname**|(% style="width:600px" %)**Ending URN pattern**|(% style="width:383px" %)**Example**
597 |(% style="width:289px" %)Agency{{footnote}}The object must be linked to a maintenance organisation, i.e., Agency or Metadata Provider.{{/footnote}}|(% style="width:600px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|(% style="width:383px" %)ECB:**AGENCIES**(**1.0**).AA
598 |(% style="width:289px" %)//AgencyScheme//|(% style="width:600px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**)|(% style="width:383px" %)ECB:**AGENCIES**(**1.0**)
599 |(% style="width:289px" %)//Categorisation//|(% style="width:600px" %)categorisationAgencyId:categoris(% style="color:#000000" %)ationId(version)|(% style="width:383px" %)IMF:cat001(1.0.0)
600 |(% style="width:289px" %)[[Category>>doc:sdmx:Glossary.Category.WebHome]]|(% style="width:600px" %)categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|(% style="width:383px" %)IMF:SDDS(1.0.0):level_1_category.level_2_category …
601 |(% style="width:289px" %)//CategoryScheme//|(% style="width:600px" %)categorySchemeAgencyId:categorySchemeId(versi on)|(% style="width:383px" %)IMF:SDDS(1.0.0)
602
603 |(% style="width:292px" %)**Classname**|(% style="width:595px" %)**Ending URN pattern**|(% style="width:794px" %)**Example**
604 |(% style="width:292px" %)//CategorySchemeMap//|(% style="width:595px" %)(((
605 (% style="color:#000000" %)catSchemeMapAgencyId:catSchemeMapId(version)
606 )))|(% style="width:794px" %)SDMX:EUROSTAT_SUBJECT_DOMAIN(1.0.0)
607 |(% style="width:292px" %)[[Code>>doc:sdmx:Glossary.Code.WebHome]]|(% style="width:595px" %)(% style="color:#000000" %)codeListAgencyId:codelistId(version).codeId|(% style="width:794px" %)SDMX:CL_FREQ(1.0.0).Q
608 |(% style="width:292px" %)//Codelist//|(% style="width:595px" %)(% style="color:#000000" %)codeListAgencyId:codeListId(version)|(% style="width:794px" %)SDMX:CL_FREQ(1.0.0)
609 |(% style="width:292px" %)ComponentMap|(% style="width:595px" %)(% style="color:#000000" %)structureMapAgencyId:structureMap(version).com ponentMapId|(% style="width:794px" %)SDMX:BOP_STRUCTURES(1.0.0).REF_AREA_TO_COUNT RY
610 |(% style="width:292px" %)(% style="color:#e74c3c" %)Concept|(% style="width:595px" %)(% style="color:#000000" %)conceptSchemeAgencyId:conceptSchemeId(versio n).conceptId|(% style="width:794px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0).FREQ
611 |(% style="width:292px" %)//ConceptScheme//|(% style="width:595px" %)(% style="color:#000000" %)conceptSchemeAgencyId:conceptSchemeId(versio n)|(% style="width:794px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0)
612 |(% style="width:292px" %)//ConceptSchemeMap//|(% style="width:595px" %)(((
613 (% style="color:#000000" %)conceptSchemeMapAgencyId:conceptSchemeMap Id(version)
614 )))|(% style="width:794px" %)SDMX:CONCEPT_MAP(1.0.0)
615 |(% style="width:292px" %)CustomType|(% style="width:595px" %)(% style="color:#000000" %)customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|(% style="width:794px" %)ECB: CUSTOM_TYPE_SCHEME(1.0.0).CUSTOM_TYPE_1
616 |(% style="width:292px" %)//CustomTypeScheme//|(% style="width:595px" %)(% style="color:#000000" %)customTypeSchemeAgencyId customTypeSchemeId(version)|(% style="width:794px" %)ECB:CUSTOM_TYPE_SCHEME(1.0.0)
617 |(% style="width:292px" %)DataAttrribute|(% style="width:595px" %)(% style="color:#000000" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dataAttributeId|(% style="width:794px" %)TFFS:EXT_DEBT(1.0.0).OBS_STATUS
618 |(% style="width:292px" %)//DataConstraint//|(% style="width:595px" %)(% style="color:#000000" %)dataConstraintAgencyId:dataConstraintId(version)|(% style="width:794px" %)TFFS:CREDITOR_DATA_CONTENT(1.0.0)
619
620 |(% style="width:294px" %)**Classname**|(% style="width:645px" %)**Ending URN pattern**|(% style="width:742px" %)**Example**
621 |(% style="width:294px" %)DataConsumer|(% style="width:645px" %)dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**).dataConsumerId|(% style="width:742px" %)SDMX:**DATA_CONSUMERS**(**1.0**).CONSUMER_1
622 |(% style="width:294px" %)//DataConsumerScheme//|(% style="width:645px" %)(((
623 dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**)
624 )))|(% style="width:742px" %)SDMX:**DATA_CONSUMERS**(**1.0**)
625 |(% style="width:294px" %)//[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]//|(% style="width:645px" %)(% style="color:#000000" %)dataflowAgencyId:dataflowId(version)|(% style="width:742px" %)TFFS:CRED_EXT_DEBT(1.0.0)
626 |(% style="width:294px" %)DataProvider|(% style="width:645px" %)(((
627 (% style="color:#000000" %)dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**).dataProviderId
628 )))|(% style="width:742px" %)SDMX:**DATA_PROVIDERS**(**1.0**).PROVIDER_1
629 |(% style="width:294px" %)//DataProviderScheme//|(% style="width:645px" %)(((
630 (% style="color:#000000" %)dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**)
631 )))|(% style="width:742px" %)SDMX:**DATA_PROVIDERS**(**1.0**)
632 |(% style="width:294px" %)//DataStructure//|(% style="width:645px" %)(% style="color:#000000" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version)|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0)
633 |(% style="width:294px" %)[[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]|(% style="width:645px" %)(% style="color:#000000" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dimensionId|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0).FREQ
634 |(% style="width:294px" %)(((
635 DimensionDescriptor
636
637 MeasureDescriptor
638
639 AttributeDescriptor
640 )))|(% style="width:645px" %)(((
641 dataStructureDefinitionAgencyId:dataStructureDef initionId((% style="color:#000000" %)version)(%%).componentListId
642
643 where the componentListId is the name of the class (there is only one occurrence of each in the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]])
644 )))|(% style="width:742px" %)(((
645 TFFS:EXT_DEBT(1.0.0).DimensionDescriptor
646
647 TFFS:EXT_DEBT(1.0.0).MeasureDescriptor
648
649 TFFS:EXT_DEBT(1.0.0).AttributeDescriptor
650 )))
651 |(% style="width:294px" %)GroupDimensionDescriptor|(% style="width:645px" %)(% style="color:#000000" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).groupDimensionDescriptorId|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0).SIBLING
652 |(% style="width:294px" %)HierarchicalCode|(% style="width:645px" %)(% style="color:#000000" %)hierarchyAgencyId:hierarchyId(version).hierarchica lCode.hierarchicalCode|(% style="width:742px" %)UNESCO:H-C-GOV(1.0.0).GOV_CODE1.GOV_CODE1_1
653
654 |**Classname**|(% style="width:644px" %)**Ending URN pattern**|(% style="width:743px" %)**Example**
655 |//[[Hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]//|(% style="width:644px" %)(% style="color:#000000" %)hierarchyAgencyId:hierarchyId(version)|(% style="width:743px" %)UNESCO:H-C-GOV(1.0.0)
656 |//HierarchyAssociation//|(% style="width:644px" %)(% style="color:#000000" %)hierarchyAssociationAgencyId:hierarchyAssociatio nId(version)|(% style="width:743px" %)UNESCO:CL_EXP_SOURCE(1.0.0)
657 |(%%)(% style="color:#e74c3c" %)Level|(% style="width:644px" %)(% style="color:#000000" %)hierarchyAgencyId:hierarchyId(version).level|(% style="width:743px" %)UNESCO:H-C-GOV(1.0.0).LVL1
658 |Measure|(% style="width:644px" %)(% style="color:#000000" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).measureId|(% style="width:743px" %)TFFS:EXT_DEBT(1.0.0).OBS_VALUE
659 |MetadataAttribute|(% style="width:644px" %)(((
660 (% style="color:#000000" %)msdAgencyId:msdId(version).metadataAttributeId.
661
662 (% style="color:#000000" %)metadataAttributeId
663 )))|(% style="width:743px" %)IMF:SDDS_MSD(1.0.0).COMPILATION.METHOD
664 |MetadataAttributeDescriptor|(% style="width:644px" %)(% style="color:#000000" %)msdAgencyId:msdId(version).metadataAttributeDe scriptorId|(% style="width:743px" %)IMF:SDDS_MSD(1.0.0).MetadataAttributeDescriptor
665 |//MetadataConstraint//|(% style="width:644px" %)(% style="color:#000000" %)metadataConstraintAgencyId:metadataConstraintI d(version)|(% style="width:743px" %)TFFS:CREDITOR_METADATA_CONTENT(1.0.0)
666 |//[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]//|(% style="width:644px" %)(% style="color:#000000" %)metadataflowAgencyId:metadataflowId(version)|(% style="width:743px" %)IMF:SDDS_MDF(1.0.0)
667 |MetadataProvider|(% style="width:644px" %)(% style="color:#000000" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**).metadataProviderId|(% style="width:743px" %)SDMX:**METADATA_PROVIDERS**(**1.0**).MD_PROVIDER_1
668 |//MetadataProviderScheme//|(% style="width:644px" %)(% style="color:#000000" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**)|(% style="width:743px" %)SDMX:**METADATA_PROVIDERS**(**1.0**)
669 |//MetadataProvisionAgreement//|(% style="width:644px" %)(% style="color:#000000" %)metadataProvisionAgreementAgencyId:metadataP rovisionAgreementId(version)|(% style="width:743px" %)IMF:SDDS_MDF_AB(1.0.0)
670 |//MetadataSet//|(% style="width:644px" %)(% style="color:#000000" %)metadataProviderId:metadataSetId(version)|(% style="width:743px" %)MD_PROVIDER:METADATASET(1.0.0)
671 |//MetadataStructure//|(% style="width:644px" %)(% style="color:#000000" %)msdAgencyId:msdId(version)|(% style="width:743px" %)IMF:SDDS_MSD(1.0.0)
672
673 |(% style="width:296px" %)**Classname**|(% style="width:646px" %)**Ending URN pattern**|(% style="width:739px" %)**Example**
674 |(% style="width:296px" %)NamePersonalisation|(% style="width:646px" %)(% style="color:#000000" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|(% style="width:739px" %)ECB:PSN_SCHEME(1.0.0).PSN1234
675 |(% style="width:296px" %)//NamePersonalisationScheme//|(% style="width:646px" %)(% style="color:#000000" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|(% style="width:739px" %)ECB:PSN_SCHEME(1.0.0)
676 |(% style="width:296px" %)//OrganisationSchemeMap//|(% style="width:646px" %)(% style="color:#000000" %)orgSchemeMapAgencyId:orgSchemeMapId(versio n)|(% style="width:739px" %)SDMX:AGENCIES_PROVIDERS(1.0.0)
677 |(% style="width:296px" %)OrganisationUnit|(% style="width:646px" %)(% style="color:#000000" %)organisationUnitSchemeAgencyId:organisationUni tSchemeId(version).organisationUnitId|(% style="width:739px" %)ECB:ORGANISATIONS(1.0.0).1F
678 |(% style="width:296px" %)//OrganisationUnitScheme//|(% style="width:646px" %)(% style="color:#000000" %)organisationUnitSchemeAgencyId:organisationUni tSchemeId(version)|(% style="width:739px" %)ECB:ORGANISATIONS(1.0.0)
679 |(% style="width:296px" %)//Process//|(% style="width:646px" %)(% style="color:#000000" %)processAgencyId:processId{version)|(% style="width:739px" %)BIS:PROCESS1(1.0.0)
680 |(% style="width:296px" %)ProcessStep|(% style="width:646px" %)(((
681 (% style="color:#000000" %)processAgencyId:processId(version).processStepId.
682
683 (% style="color:#000000" %)processStepId
684 )))|(% style="width:739px" %)BIS:PROCESS1(1.0.0).STEP1.STEP1_1
685 |(% style="width:296px" %)//ProvisionAgreement//|(% style="width:646px" %)(% style="color:#000000" %)provisionAgreementAgencyId:provisionAgreement Id(version)|(% style="width:739px" %)TFFS:CRED_EXT_DEBT_AB(1.0.0)
686 |(% style="width:296px" %)ReportingCategory|(% style="width:646px" %)(((
687 (% style="color:#000000" %)reportingTaxonomyAgencyId:
688
689 (% style="color:#000000" %)reportingTaxonomyId(version).reportingCategoryI d.reportingCategoryId
690 )))|(% style="width:739px" %)IMF:REP_1(1.0.0):LVL1_REP_CAT.LVL2_REP_CAT
691 |(% style="width:296px" %)//ReportingTaxonomy//|(% style="width:646px" %)(% style="color:#000000" %)reportingTaxonomyAgencyId:reportingTaxonomyI d(version)|(% style="width:739px" %)IMF:REP_1(1.0.0)
692 |(% style="width:296px" %)//ReportingTaxonomyMap//|(% style="width:646px" %)repTaxonomyAgencyId:repTaxonomyId((% style="color:#e74c3c" %)version(%%))|(% style="width:739px" %)[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:RT_MAP(1.0.0)
693
694 |(% style="width:297px" %)**Classname**|(% style="width:647px" %)**Ending URN pattern**|(% style="width:737px" %)**Example**
695 |(% style="width:297px" %)//RepresentationMap//|(% style="width:647px" %)repMapAgencyId:repMapId((% style="color:#e74c3c" %)version(%%))|(% style="width:737px" %)[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:REF_AREA_MAPPING(1.0.0)
696 |(% style="width:297px" %)Ruleset|(% style="width:647px" %)rulesetSchemeAgencyId rulesetSchemeId((% style="color:#e74c3c" %)version(%%)) rulesetId|(% style="width:737px" %)ECB:RULESET_23(1.0.0).SET111
697 |(% style="width:297px" %)//RulesetScheme//|(% style="width:647px" %)rulesetSchemeAgencyId rulesetSchemeId((% style="color:#e74c3c" %)version(%%))|(% style="width:737px" %)ECB:RULESET_23(1.0.0)
698 |(% style="width:297px" %)//StructureMap//|(% style="width:647px" %)structureMapAgencyId:structureMap((% style="color:#e74c3c" %)version(%%))|(% style="width:737px" %)[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:BOP_STRUCTURES(1.0.0)
699 |(% style="width:297px" %)[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]|(% style="width:647px" %)(((
700 The [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] is not itself an [[Identifiable Artefact>>doc:sdmx:Glossary.Identifiable artefact.WebHome]] and therefore it does not follow the rules for URN structure.
701 The name of the URN is registryURN There is no pre-determined format.
702 )))|(% style="width:737px" %)This cannot be generated by a common mechanism as [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]], although maintainable in the sense that they can be submitted and deleted, are not mandated to be created by a [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] and have no versioning mechanism. It is therefore the responsibility of the target registry to generate a unique Id for the [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]], and for the application creating the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] to store the registry URN that is returned from the registry in the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] response message.
703 |(% style="width:297px" %)TimeDimension|(% style="width:647px" %)(% style="color:#000000" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).timeDimensionId|(% style="width:737px" %)TFFS:EXT_DEBT(1.0.0).TIME_PERIOD
704 |(% style="width:297px" %)Transformation|(% style="width:647px" %)(% style="color:#000000" %)transformationSchemeAgencyId transformationSchemeId(version) transformationId|(% style="width:737px" %)ECB:TRANSFORMATION_SCHEME(1.0.0).TRANS_1
705 |(% style="width:297px" %)//TransformationScheme//|(% style="width:647px" %)(% style="color:#000000" %)transformationSchemeAgencyId transformationSchemeId(version)|(% style="width:737px" %)ECB: TRANSFORMATION_SCHEME(1.0.0)
706 |(% style="width:297px" %)**Classname**|(% style="width:647px" %)**Ending URN pattern**|(% style="width:737px" %)**Example**
707 |(% style="width:297px" %)Transition|(% style="width:647px" %)(((
708 (% style="color:#000000" %)processAgencyId:processId(version).processStepId.
709 transitionId
710 )))|(% style="width:737px" %)BIS:PROCESS1(1.0.0).STEP1.TRANSITION1
711 |(% style="width:297px" %)UserDefinedOperator|(% style="width:647px" %)(% style="color:#000000" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|(% style="width:737px" %)ECB:OS_CALC(1.2.0).OS267
712 |(% style="width:297px" %)//UserDefinedOperatorScheme//|(% style="width:647px" %)(% style="color:#000000" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|(% style="width:737px" %)ECB:OS_CALC(1.2.0)
713 |(% style="width:297px" %)//ValueList//|(% style="width:647px" %)(% style="color:#000000" %)valuelistAgencyId:valuelistId(version)|(% style="width:737px" %)[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:VLIST(1.0.0)
714 |(% style="width:297px" %)VtlCodelistMapping|(% style="width:647px" %)(% style="color:#000000" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|(% style="width:737px" %)ECB:CLIST_MP(2.0.0).ABZ
715 |(% style="width:297px" %)VtlConceptMapping|(% style="width:647px" %)(% style="color:#000000" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|(% style="width:737px" %)ECB:CLIST_MP(1.0.0).XYA
716 |(% style="width:297px" %)VtlDataflowMapping|(% style="width:647px" %)(% style="color:#000000" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|(% style="width:737px" %)ECB:CLIST_MP(1.0.0).MOQ
717 |(% style="width:297px" %)//VtlMappingScheme//|(% style="width:647px" %)(% style="color:#000000" %)vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|(% style="width:737px" %)ECB:CLIST_MP(2.0.0)
718
719 **Table 3: Table of identification components for SDMX Identifiable Artefacts**
720
721 = 7 Implementation Notes =
722
723 == 7.1 Structural Definition Metadata ==
724
725 === 7.1.1 Introduction ===
726
727 The [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] must have the ability to support agencies in their role of defining and disseminating [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]. These [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] include [[data structure definitions>>doc:sdmx:Glossary.Data structure definition.WebHome]], [[code lists>>doc:sdmx:Glossary.Code list.WebHome]], (% style="color:#e74c3c" %)concepts(%%) etc. and are fully defined in the [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]. An authenticated agency may submit valid [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] definitions which must be stored in the registry. Note that the term “[[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]]” refers as a general term to all structural [[components>>doc:sdmx:Glossary.Component.WebHome]] ([[Data Structure Definitions>>doc:sdmx:Glossary.Data structure definition.WebHome]], [[Metadata Structure Definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], [[Code Lists>>doc:sdmx:Glossary.Code list.WebHome]], [[Concept Schemes>>doc:sdmx:Glossary.Concept scheme.WebHome]], etc.)
728
729 At a minimum, [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] definitions may be submitted to and queried from the registry via an HTTP/HTTPS POST in the form of one of the [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] messages for [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] and the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful API for structure queries. The message may contain all [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] items for the whole registry, [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] items for one [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]], or individual [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] items.
730
731 [[Structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] items
732
733 * may only be modified by the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] which created them;
734 * may only be deleted by the agency which created them;
735 * may not be deleted if they are referenced from other constructs in the Registry.
736
737 The (% style="color:#e74c3c" %)level(%%) of granularity for the maintenance of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[Structural Metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] objects in the registry is the [[Maintainable Artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]]. Especially for [[Item Schemes>>doc:sdmx:Glossary.Item scheme.WebHome]], though, partial maintenance may be performed, i.e., at the (% style="color:#e74c3c" %)level(%%) of the Item, by submitting an [[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] with the 'isPartial' flag set and a reduced set of Items.
738
739 The following table lists the [[Maintainable Artefacts>>doc:sdmx:Glossary.Maintainable artefact.WebHome]].
740
741 (% style="width:825.835px" %)
742 |(% colspan="2" style="width:455px" %)**[[Maintainable Artefacts>>doc:sdmx:Glossary.Maintainable artefact.WebHome]]**|(% style="width:367px" %)**Content**
743 |(% style="width:160px" %)**Abstract Class**|(% style="width:295px" %)**Concrete Class**|(% style="width:367px" %)
744 |(% style="width:160px" %)[[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]]|(% style="width:295px" %)Codelist|(% style="width:367px" %)[[Code>>doc:sdmx:Glossary.Code.WebHome]]
745 |(% style="width:160px" %) |(% style="width:295px" %)[[Concept Scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]]|(% style="width:367px" %)(% style="color:#e74c3c" %)Concept
746 |(% style="width:160px" %) |(% style="width:295px" %)[[Category Scheme>>doc:sdmx:Glossary.Category scheme.WebHome]]|(% style="width:367px" %)[[Category>>doc:sdmx:Glossary.Category.WebHome]]
747 |(% style="width:160px" %) |(% style="width:295px" %)[[Organisation Unit Scheme>>doc:sdmx:Glossary.Organisation unit scheme.WebHome]]|(% style="width:367px" %)Organisation Unit
748 |(% style="width:160px" %) |(% style="width:295px" %)[[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]]|(% style="width:367px" %)Agency
749 |(% style="width:160px" %) |(% style="width:295px" %)[[Data Provider Scheme>>doc:sdmx:Glossary.Data provider scheme.WebHome]]|(% style="width:367px" %)[[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]]
750 |(% style="width:160px" %) |(% style="width:295px" %)Metadata Provider Scheme|(% style="width:367px" %)Metadata Provider
751 |(% style="width:160px" %) |(% style="width:295px" %)[[Data Consumer Scheme>>doc:sdmx:Glossary.Data consumer scheme.WebHome]]|(% style="width:367px" %)[[Data Consumer>>doc:sdmx:Glossary.Data consumer.WebHome]]
752 |(% style="width:160px" %) |(% style="width:295px" %)Reporting Taxonomy|(% style="width:367px" %)Reporting [[Category>>doc:sdmx:Glossary.Category.WebHome]]
753 |(% style="width:160px" %) |(% style="width:295px" %)Transformation Scheme|(% style="width:367px" %)Transformation
754 |(% style="width:160px" %) |(% style="width:295px" %)Custom Type Scheme|(% style="width:367px" %)Custom Type
755 |(% style="width:160px" %) |(% style="width:295px" %)Name Personalisation Scheme|(% style="width:367px" %)Name Personalisation
756 |(% style="width:160px" %) |(% style="width:295px" %)[[Vtl>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] Mapping Scheme|(% style="width:367px" %)[[Vtl>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] Codelist Mapping [[Vtl>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] (% style="color:#e74c3c" %)Concept(%%) Mapping
757 |(% style="width:160px" %) |(% style="width:295px" %)Ruleset Scheme|(% style="width:367px" %)Ruleset
758 |(% style="width:160px" %) |(% style="width:295px" %)User Defined Operator Scheme|(% style="width:367px" %)User Defined Operator
759 |(% style="width:160px" %)Enumerated List|(% style="width:295px" %)ValueList|(% style="width:367px" %)Value Item
760 |(% style="width:160px" %)Structure|(% style="width:295px" %)[[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]|(% style="width:367px" %)(((
761 [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] Descriptor
762 Group [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] Descriptor
763 [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]
764 Time [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]
765 [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Descriptor
766 Data [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]
767 Measure Descriptor
768 Measure
769 )))
770 |(% style="width:160px" %) |(% style="width:295px" %)[[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]|(% style="width:367px" %)Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Descriptor Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]
771 |(% style="width:160px" %)Structure Usage|(% style="width:295px" %)[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]|(% style="width:367px" %)
772 |(% style="width:160px" %) |(% style="width:295px" %)[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]|(% style="width:367px" %)
773 |(% style="width:160px" %)None|(% style="width:295px" %)Process|(% style="width:367px" %)Process Step
774 |(% style="width:160px" %)None|(% style="width:295px" %)Structure (% style="color:#e74c3c" %)Map|(% style="width:367px" %)(((
775 [[Component>>doc:sdmx:Glossary.Component.WebHome]] (% style="color:#e74c3c" %)Map(%%)
776 Epoch (% style="color:#e74c3c" %)Map(%%)
777 Date Pattern (% style="color:#e74c3c" %)Map
778 )))
779 |(% style="width:160px" %)None|(% style="width:295px" %)[[Representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)Map|(% style="width:367px" %)[[Representation>>doc:sdmx:Glossary.Representation.WebHome]] Mapping
780 |(% style="width:160px" %)[[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] (% style="color:#e74c3c" %)Map|(% style="width:295px" %)Organisation Scheme (% style="color:#e74c3c" %)Map|(% style="width:367px" %)Item (% style="color:#e74c3c" %)Map
781 |(% style="width:160px" %) |(% style="width:295px" %)[[Concept Scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] (% style="color:#e74c3c" %)Map|(% style="width:367px" %)Item (% style="color:#e74c3c" %)Map
782 |(% style="width:160px" %) |(% style="width:295px" %)[[Category Scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] (% style="color:#e74c3c" %)Map|(% style="width:367px" %)Item (% style="color:#e74c3c" %)Map
783 |(% style="width:160px" %) |(% style="width:295px" %)Reporting Taxonomy (% style="color:#e74c3c" %)Map|(% style="width:367px" %)Item (% style="color:#e74c3c" %)Map
784 |(% style="width:160px" %)None|(% style="width:295px" %)[[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]]|(% style="width:367px" %)
785 |(% style="width:160px" %)None|(% style="width:295px" %)Metadata [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]]|(% style="width:367px" %)
786 |(% style="width:160px" %)None|(% style="width:295px" %)[[Hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]|(% style="width:367px" %)Hierarchical [[Code>>doc:sdmx:Glossary.Code.WebHome]]
787 |(% style="width:160px" %)None|(% style="width:295px" %)[[Hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] Association|(% style="width:367px" %)
788 |(% style="width:160px" %)None|(% style="width:295px" %)Categorisation|(% style="width:367px" %)
789 |(% style="width:160px" %)(% style="color:#e74c3c" %)Constraint|(% style="width:295px" %)Data (% style="color:#e74c3c" %)Constraint|(% style="width:367px" %)DataKeySet
790 |(% style="width:160px" %) |(% style="width:295px" %) |(% style="width:367px" %)CubeRegion
791 |(% style="width:160px" %)(% style="color:#e74c3c" %)Constraint|(% style="width:295px" %)Metadata (% style="color:#e74c3c" %)Constraint|(% style="width:367px" %)MetadataTargetRegion
792
793 **Table 4: Table of Maintainable Artefacts for Structural Definition Metadata**
794
795 === 7.1.2 Item Scheme, Structure ===
796
797 The [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] included in the structural definitions are:
798
799 * All types of [[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] (Codelist, [[Concept Scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]], [[Category Scheme>>doc:sdmx:Glossary.Category scheme.WebHome]], Organisation Scheme, [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]], [[Data Provider Scheme>>doc:sdmx:Glossary.Data provider scheme.WebHome]], Metadata Provider Scheme, [[Data Consumer Scheme>>doc:sdmx:Glossary.Data consumer scheme.WebHome]], [[Organisation Unit Scheme>>doc:sdmx:Glossary.Organisation unit scheme.WebHome]], Transformation Scheme, Name Personalisation Scheme, Custom Type Scheme, [[Vtl>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] Mapping Scheme, Ruleset Scheme, User Defined Operator Scheme)
800 * All types of Enumerated List (ValueList){{footnote}}Note that Codelist is also an EnumeratedList.{{/footnote}}
801 * All types of Structure ([[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]])
802 * All types of Structure Usage ([[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]])
803
804 === 7.1.3 Structure Usage ===
805
806 ==== 7.1.3.1 Structure Usage: Basic Concepts ====
807
808 The Structure Usage defines, in its concrete classes of [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] and [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]], which flows of data and metadata use which specific Structure, and importantly for the support of data and metadata discovery, the Structure Usage can be linked to one or more [[Category>>doc:sdmx:Glossary.Category.WebHome]] in one or more [[Category Scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] using the Categorisation mechanism. This gives the ability for an application to discover data and metadata by “drilling down” the [[Category Schemes>>doc:sdmx:Glossary.Category scheme.WebHome]].
809
810 ==== 7.1.3.2 Structure Usage Schematic ====
811
812 [[image:SDMX 3.1 Section 5_en_9b750e13.jpg||height="246" width="438"]]
813
814 **Figure 9: Schematic of Linking the Data and Metadata Flows to Categories and Structure Definitions**
815
816 ==== 7.1.3.3 Structure Usage Model ====
817
818 [[image:SDMX 3.1 Section 5_en_1c94cbe.jpg||height="548" width="578"]]
819
820 **Figure 10: SDMX-IM of links from Structure Usage to Category**
821
822 In addition to the maintenance of the [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] and the [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]], the following links must be maintained in the registry:
823
824 * [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] to Data Structure Definition
825 * [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] to Metadata Structure Definition
826
827 The following links may be created by means of a Categorisation
828
829 * Categorisation to [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] and [[Category>>doc:sdmx:Glossary.Category.WebHome]]
830 * Categorisation to [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] and [[Category>>doc:sdmx:Glossary.Category.WebHome]]
831
832 == 7.2 Data and Metadata Provisioning ==
833
834 === 7.2.1 Provisioning Agreement: Basic concepts ===
835
836 Data/Metadata provisioning defines a framework in which the provision of different types of statistical data and metadata by various data/metadata providers can be specified and controlled. This framework is the basis on which the existence of data can be made known to the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-enabled community and hence the basis on which data can subsequently be discovered. Such a framework can be used to regulate the data content to facilitate the building of intelligent applications. It can also be used to facilitate the processing implied by service (% style="color:#e74c3c" %)level(%%) agreements, or other provisioning agreements in those scenarios that are based on legal directives. Additionally, quality and [[timeliness>>doc:sdmx:Glossary.Timeliness.WebHome]] metadata can be supported by this framework which makes it practical to implement information supply chain monitoring.
837
838 Note that the term “data provisioning” here includes both the provisioning of data and metadata.
839
840 Although the [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] directly supports the data-sharing “pull” model, it is also useful in “push” exchanges (bilateral and gateway scenarios), or in a dissemination environment. It should be noted, too, that in any exchange scenario, the registry functions as a repository of structural metadata.
841
842 === 7.2.2 Provisioning Agreement Model – pull use case ===
843
844 An organisation which publishes statistical data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] and wishes to make it available to an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] enabled community is called a [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]]. In terms of the [[SDMX Information Model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]], the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] is maintained in a [[Data Provider Scheme>>doc:sdmx:Glossary.Data provider scheme.WebHome]].
845
846 [[image:SDMX 3.1 Section 5_en_5a16c7fe.jpg||height="455" width="551"]]
847
848 **Figure 11: SDMX-IM of the Data Provider**
849
850 Note that the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] does not inherit the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] association. The diagram below shows a logical schematic of the data model classes required to maintain [[provision agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]].
851
852 [[image:SDMX 3.1 Section 5_en_b08fd1a2.jpg||height="299" width="533"]]
853
854 **Figure 12: Schematic of the Provision Agreement**
855
856 The diagram below is a logical [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the data required in order to maintain [[Provision Agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]].
857
858 [[image:SDMX 3.1 Section 5_en_c63d10ab.jpg||height="246" width="579"]]
859
860 **Figure 13: Logical class diagram of the information contained in the Provision Agreement**
861
862 A [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] is [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]]. Each [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] must reference a [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] or Metadata Provider and a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] or [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] Definition. The Data/Metadata Provider and the [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]/[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] must exist already in order to set up a Metadata Provision or [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]].
863
864 == 7.3 Data and Metadata Constraints ==
865
866 === 7.3.1 Data and Metadata Constraints: Basic Concepts ===
867
868 (% style="color:#e74c3c" %)Constraints(%%) are, effectively, lists of the valid or actual content of data and metadata. (% style="color:#e74c3c" %)Constraints(%%) can be used to specify a subset of the theoretical content of [[data set>>doc:sdmx:Glossary.Data set.WebHome]] or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] which can be derived from the specification of the [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] or [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. A (% style="color:#e74c3c" %)Constraint(%%) can comprise a list of keys or a list of content (usually [[code>>doc:sdmx:Glossary.Code.WebHome]] values) of a specific [[component>>doc:sdmx:Glossary.Component.WebHome]] such as a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].
869
870 (% style="color:#e74c3c" %)Constraints(%%) comprise the specification of subsets of key or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values that are to be provided for a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] or [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]], or directly attached to a [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] or [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. This is important metadata because, for example, the full range of possibilities which is implied by the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] (e.g., the complete set of valid keys is the Cartesian product of all the values in the [[code lists>>doc:sdmx:Glossary.Code list.WebHome]] for each of the [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]) is often more than is intended to be supplied according to a specific [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]].
871
872 Often a [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] will not be able to provide data for all key combinations, either because the combination itself is not meaningful, or simply because the provider does not have the data for that combination. In this case the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] could constrain the [[data source>>doc:sdmx:Glossary.Data source.WebHome]] (at the (% style="color:#e74c3c" %)level(%%) of the [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] or the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]]) by supplying metadata that defines the key combinations or cube regions that are available. This is done by means of a (% style="color:#e74c3c" %)Constraint(%%). The (% style="color:#e74c3c" %)Constraint(%%) is also used to define a [[code list>>doc:sdmx:Glossary.Code list.WebHome]] subset which is used to populate a partial [[code list>>doc:sdmx:Glossary.Code list.WebHome]], and in generating a schema for data reporters to validate their [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] against.
873
874 Furthermore, it is often useful to define subsets or views of the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] which restrict values in some [[code lists>>doc:sdmx:Glossary.Code list.WebHome]], especially where many such subsets restrict the same [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. Such a view is called a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], and there can be one or more defined for any [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]].
875
876 Whenever data is published or made available by a [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]], it must conform to a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] (and hence to a [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]). The [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] is thus a means of enabling content based processing.
877
878 In addition, DataAvailabilityConstraints can be extremely useful in a data visualisation system, such as dissemination of statistics on a website. In such a system a Cube Region can be used to specify the [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] [[codes>>doc:sdmx:Glossary.Code.WebHome]] that actually exist in a [[data source>>doc:sdmx:Glossary.Data source.WebHome]] (these can be used to build relevant selection tables).
879
880 === 7.3.2 Data and Metadata Constraints: Schematic ===
881
882 [[image:SDMX 3.1 Section 5_en_28d0cadc.jpg||height="326" width="580"]]
883
884 **Figure 14: Schematic of the Constraint and the Artefacts that can be constrained**
885
886 === 7.3.3 Data and Metadata Constraints: Model ===
887
888 [[image:SDMX 3.1 Section 5_en_a3184f6a.jpg||height="298" width="579"]]
889
890 **Figure 15: Logical class diagram showing inheritance between and reference to constrainable artefacts**
891
892 Logical class diagram showing inheritance between and reference to constrainable artefacts.
893
894 The class diagram above shows that [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]], Metadata Provider, [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]], [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], Metadata [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], Data Structure.
895
896 Definition, [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] are all concrete sub-classes of Constrainable [[Artefact>>doc:sdmx:Glossary.Artefact.WebHome]] and can therefore have Data (% style="color:#e74c3c" %)Constraints(%%) specified. Note that the actual (% style="color:#e74c3c" %)Constraint(%%) as submitted is associated to the reference classes defines in the (% style="color:#e74c3c" %)Constraint(%%) Attachment.
897
898 these are used to refer to the classes to which the (% style="color:#e74c3c" %)Constraint(%%) applies.
899
900 The content of the (% style="color:#e74c3c" %)Constraint(%%) can be found in the [[SDMX Information Model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]] document.
901
902 == 7.4 Data Registration ==
903
904 === 7.4.1 Basic Concepts ===
905
906 A [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] has published a new [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] conforming to an existing [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] (and hence [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]). This is implemented as either a web-accessible SDMXML file, or in a database which has a web-services interface capable of responding to an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful query with an [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] data stream.
907
908 The [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] wishes to make this new data available to one or more data collectors in a “pull” scenario, or to make the data available to [[data consumers>>doc:sdmx:Glossary.Data consumer.WebHome]]. To do this, the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] registers the new [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] with one or more [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] conformant registries that have been configured with structural and provisioning metadata. In other words, the registry “knows” the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] and “knows” what [[data flows>>doc:sdmx:Glossary.Dataflow.WebHome]] the [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] has agreed to make available.
909
910 The same mechanism can be used to report or make available a metadata set.
911
912 [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-RR supports [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] registration via the Registration Request, which can be created by the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] (giving the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] maximum control). The registry responds to the registration request with a registration response which indicates if the registration was successful. In the event of an error, the error messages are returned as a registry exception within the response.
913
914 === 7.4.2 The Registration Request ===
915
916 ==== 7.4.2.1 Registration Request Schematic ====
917
918 [[image:SDMX 3.1 Section 5_en_293a2ea6.jpg||height="337" width="554"]]
919
920 **Figure 16: Schematic of the Objects Concerned with Registration**
921
922 ==== 7.4.2.2 Registration Request Model ====
923
924 The following UML diagram shows the composition of the registration request. Each request is made up of one or more Registrations, one per [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] to be registered. The Registration can optionally have information, which has been extracted from the Registration:
925
926 * validFrom
927 * validTo
928 * lastUpdated
929
930 The last updated date is useful during the discovery process to make sure the client knows which data is freshest.
931
932 The Registration has an action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] which takes one of the following values:
933
934 (((
935 |(% style="width:224px" %)**Action Attribute Value**|(% style="width:1457px" %)**Behaviour**
936 |(% style="width:224px" %)Append|(% style="width:1457px" %)Add this Registration to the registry
937 |(% style="width:224px" %)Replace|(% style="width:1457px" %)Replace the existing Registration with identified by the id in the Registration of the SubmitRegistrationRequest
938 |(% style="width:224px" %)Delete|(% style="width:1457px" %)Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest
939 )))
940
941 [[image:SDMX 3.1 Section 5_en_90b3c64a.jpg||height="434" width="579"]]
942
943 **Figure 17: Logical Class Diagram of Registration of Data and Metadata**
944
945 The //QueryDatasource// is an abstract class that represents a [[data source>>doc:sdmx:Glossary.Data source.WebHome]], which can understand an API query (i.e., a RESTful query – RESTDatasource) and respond appropriately. Each [[data source>>doc:sdmx:Glossary.Data source.WebHome]] inherits the dataURL from //Datasource//, and the //QueryDatasource// has an additional URL to locate the specification of the service (specURL) to describe how to access it. All other supported protocols are assumed to use the SimpleDatasource URL.
946
947 A SimpleDatasource is used to reference a physical [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] file that is available at a URL.
948
949 The RegistrationRequest has an action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] which defines whether this is a new (append) or updated (replace) Registration, or that the Registration is to be deleted (delete). The id is only provided for the replace and delete actions, as the Registry will allocate the unique id of the (new) Registration.
950
951 The Registration includes [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] that state how a SimpleDatasource is to be indexed when registered. The Registry registration process must act as follows:
952
953 Information in the [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] is extracted and made available via the availability REST API as documented here:
954
955 https:~/~/github.com/sdmx-twg/sdmx-rest/blob/master/doc/availability.md
956
957 (((
958 (% style="width:918.835px" %)
959 |**Indexing Required**|(% style="width:745px" %)**Registration Process Activity**
960 |indexTimeSeries|(% style="width:745px" %)Extract all the [[series keys>>doc:sdmx:Glossary.Series key.WebHome]] and create a KeySet(s) Constraint.
961 |indexDataSet|(% style="width:745px" %)Extract all the [[codes>>doc:sdmx:Glossary.Code.WebHome]] and other content of the Key value of the [[Series Key>>doc:sdmx:Glossary.Series key.WebHome]] in a [[Data Set>>doc:sdmx:Glossary.Data set.WebHome]] and create one or more Cube Regions containing [[Member Selections>>doc:sdmx:Glossary.Member selection.WebHome]] of [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] [[Components>>doc:sdmx:Glossary.Component.WebHome]] of the (% style="color:#e74c3c" %)Constraints(%%) model in the [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]], and the associated Selection Value.
962 |indexReportingPeriod|(% style="width:745px" %)(((
963 This applies only to a registered __[[dataset>>doc:sdmx:Glossary.Data set.WebHome]]__.
964 Extract the Reporting Begin and Reporting End from the Header of the Message containing the [[data set>>doc:sdmx:Glossary.Data set.WebHome]], and create a [[Reference Period>>doc:sdmx:Glossary.Reference period.WebHome]] constraint.
965 )))
966 |indexAttributes|(% style="width:745px" %)(((
967 **Data Set**
968 Extract the content of the [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Values in a [[Data Set>>doc:sdmx:Glossary.Data set.WebHome]] and create one or more Cube Regions containing [[Member Selections>>doc:sdmx:Glossary.Member selection.WebHome]] of Data [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] [[Components>>doc:sdmx:Glossary.Component.WebHome]] of the (% style="color:#e74c3c" %)Constraints(%%) model in the SDMXIM, and the associated Selection Value
969
970 **Metadata Set**
971 Indicate the presence of a Reported [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] by creating one or more Cube Regions containing [[Member Selections>>doc:sdmx:Glossary.Member selection.WebHome]] of Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] [[Components>>doc:sdmx:Glossary.Component.WebHome]] of the (% style="color:#e74c3c" %)Constraints(%%) model in the
972 )))
973 |**Indexing Required**|(% style="width:745px" %)**Registration Process Activity**
974 | |(% style="width:745px" %)[[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]. Note that the content is not stored in the Selection Value.
975 )))
976
977 (% style="color:#e74c3c" %)Constraints(%%) that specify the contents of a //QueryDatasource// are submitted to the Registry via the structure submission service (i.e., the RESTful API).
978
979 The Registration must reference the ProvisionAgreement to which it relates.
980
981 === 7.4.3 Registration Response ===
982
983 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”.
984
985 If the registration has succeeded, a Registration will be returned – this holds the Registry-allocated Id of the newly registered //Datasource// plus a //Datasource// holding the URL to access the [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] or query service.
986
987 The RegistrationResponse returns set of registration status (one for each registration submitted) in terms of a StatusMessage (this is common to all Registry responses) that indicates success or failure. In the event of registration failure, a set of MessageText are returned, giving the error messages that occurred during registration. It is entirely possible when registering a batch of [[datasets>>doc:sdmx:Glossary.Data set.WebHome]], that the response will contain some successful and some failed statuses. The logical model for the RegistrationResponse is shown below:
988
989 [[image:SDMX 3.1 Section 5_en_cdba03b5.jpg||height="371" width="579"]]
990
991 **Figure 18: Logical class diagram showing the registration response**
992
993 == 7.5 Subscription and Notification Service ==
994
995 The contents of the [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]]/Repository will change regularly: new [[code lists>>doc:sdmx:Glossary.Code list.WebHome]] and key families will be published and new [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] and metadata-sets will be registered. To obviate the need for users to repeatedly query the registry to see when new information is available, a mechanism is provided to allow users to be notified when these events happen.
996
997 A user can submit a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] in the registry that defines which events are of interest, and either an email and/or an HTTP address to which a [[notification>>doc:sdmx:Glossary.Notification.WebHome]] of qualifying events will be delivered. The [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] will be identified in the registry by a URN, which is returned to the user when the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] is created. If the user wants to delete the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] at a later point, the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] URN is used as identification. [[Subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] have a validity period expressed as a date range (startDate, endDate) and the registry may delete any expired [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]], and will notify the subscriber on expiry.
998
999 When a registry/repository [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is modified, any [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] which are observing the object are activated, and either an email or HTTP POST is instigated to report details of the changes to the user specified in the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. This is called a “[[notification>>doc:sdmx:Glossary.Notification.WebHome]]”.
1000
1001 === 7.5.1 Subscription Logical Class Diagram ===
1002
1003 [[image:SDMX 3.1 Section 5_en_1433df5d.jpg||height="680" width="587"]]
1004
1005 **Figure 19: Logical Class Diagram of the Subscription**
1006
1007 === 7.5.2 Subscription Information ===
1008
1009 Regardless of the type of registry/repository events being observed, a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] always contains:
1010
1011 1. A set of URIs describing the end-points to which [[notifications>>doc:sdmx:Glossary.Notification.WebHome]] must be sent if the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] is activated. The URIs can be either mailto~: or http: protocol. In the former case an email [[notification>>doc:sdmx:Glossary.Notification.WebHome]] is sent; in the latter an HTTP POST [[notification>>doc:sdmx:Glossary.Notification.WebHome]] is sent.
1012 1. A user-defined identifier, which is returned in the response to the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request. This helps with asynchronous processing and is NOT stored in the Registry.
1013 1. A validity period which defines both when the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] becomes active and expires. The subscriber may be sent a [[notification>>doc:sdmx:Glossary.Notification.WebHome]] on expiration of the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]].
1014 1. A selector which specifies which type of events are of interest. The set of event types is:
1015
1016 (((
1017 (% style="width:1061.83px" %)
1018 |**Event Type**|(% style="width:660px" %)**Comment**
1019 |STRUCTURAL_REPOSITORY_EVENTS|(% style="width:660px" %)Life-cycle changes to [[Maintainable Artefacts>>doc:sdmx:Glossary.Maintainable artefact.WebHome]] in the [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository.
1020 |DATA_REGISTRATION_EVENTS|(% style="width:660px" %)Whenever a published [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] is registered. This can be either a SDMXML data file or an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] conformant database.
1021 |METADATA_REGISTRATION_EVENTS|(% style="width:660px" %)Whenever a published metadataset is registered. This can be either a SDMXML [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] file or an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] conformant database.
1022 |ALL_EVENTS|(% style="width:660px" %)All events of the specified EventType
1023 )))
1024
1025 === 7.5.3 Wildcard Facility ===
1026
1027 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:
1028
1029 * agencyID
1030 * id
1031 * version
1032
1033 Examples of wildcarded identifier components for an identified object type of Codelist are shown below:
1034
1035 AgencyID = *
1036
1037 Id = *
1038
1039 Version = *
1040
1041 This subscribes to all Codelists of all versions for all agencies.
1042
1043 AgencyID = AGENCY1
1044
1045 Id = CODELIST1
1046
1047 Version = *
1048
1049 This subscribes to all versions of Codelist CODELIST1 maintained by the agency AGENCY1.
1050
1051 AgencyID = AGENCY1
1052
1053 Id = *
1054
1055 Version = *
1056
1057 This subscribes to all versions of all Codelist objects maintained by the agency AGENCY1.
1058
1059 AgencyID = *
1060
1061 Id = CODELIST1
1062
1063 Version = *
1064
1065 This subscribes to all versions of Codelist CODELIST1 maintained by any agency.
1066
1067 Note that if the subscription is to the latest stable version then this can be achieved by the + character, i.e.:
1068
1069 Version = +
1070
1071 A subscription to the latest version (whether stable, draft or non-versioned) can be achieved by the ~~ character, i.e.:
1072
1073 Version = ~~
1074
1075 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.:
1076
1077 Version = 2.3+.1
1078
1079 The complete SDMX versioning syntax can be found in the SDMX Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”.
1080
1081 === 7.5.4 Structural Repository Events ===
1082
1083 Whenever a [[maintainable artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]] ([[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]], codelist, [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]], etc.) is added to, deleted from, or modified in the [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, a [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] event is triggered. [[Subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] may be set up to monitor all such events, or focus on specific [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] such as a [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]].
1084
1085 === 7.5.5 Registration Events ===
1086
1087 Whenever a [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] or metadata-set is registered a registration event is created. A [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] may be observing all data or metadata registrations, or it may focus on specific registrations as shown in the table below:
1088
1089 (((
1090 (% style="width:1082.83px" %)
1091 |(% style="width:230px" %)**Selector**|(% style="width:850px" %)**Comment**
1092 |(% style="width:230px" %)DataProvider|(% style="width:850px" %)Any [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] registered by the specified dataprovider will activate the notification.
1093 |(% style="width:230px" %)ProvisionAgreement|(% style="width:850px" %)Any [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] for the agreement will activate the notification.
1094 |(% style="width:230px" %)[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]|(% style="width:850px" %)Any [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] for the specified [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] will activate the notification.
1095 |(% style="width:230px" %)DataStructureDefinition|(% style="width:850px" %)Any [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] for those [[dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]] that are based on the specified [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] will activate the notification
1096 |(% style="width:230px" %)Category|(% style="width:850px" %)Any [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] registered for those [[dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]], [[provision agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]] that are categorised by the category.
1097 )))
1098
1099 The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration.
1100
1101 == 7.6 Notification ==
1102
1103 === 7.6.1 Logical Class Diagram ===
1104
1105 [[image:SDMX 3.1 Section 5_en_8bc1b889.jpg||height="379" width="579"]]
1106
1107 **Figure 20: Logical Class Diagram of the Notification**
1108
1109 A [[notification>>doc:sdmx:Glossary.Notification.WebHome]] is an XML document that is sent to a user via email or http POST whenever a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] is activated. It is an asynchronous one-way message.
1110
1111 Regardless of the registry [[component>>doc:sdmx:Glossary.Component.WebHome]] that caused the event to be triggered, the following common information is in the message:
1112
1113 * Date and time that the event occurred
1114 * The URN of the [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] that caused the event
1115 * The URN of the [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] that produced the [[notification>>doc:sdmx:Glossary.Notification.WebHome]]
1116 * Event Action: Add, Replace, or Delete.
1117
1118 Additionally, supplementary information may be contained in the [[notification>>doc:sdmx:Glossary.Notification.WebHome]] as detailed below.
1119
1120 === 7.6.2 Structural Event Component ===
1121
1122 The [[notification>>doc:sdmx:Glossary.Notification.WebHome]] will contain the MaintainableArtefact that triggered the event in a form similar to the [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] structural message (using elements from that namespace).
1123
1124 === 7.6.3 Registration Event Component ===
1125
1126 The [[notification>>doc:sdmx:Glossary.Notification.WebHome]] will contain the Registration.
1127
1128 ----
1129
1130 {{putFootnotes/}}