Skip to Content
Version 1.1 by Helena on 2025/05/21 13:44
Show last authors
1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 **Revision History**
6
7 |**Revision**|**Date**|**Contents**
8 | |April 2011|Initial release
9 |1.0|July 2011|Rectification of problems of the specifications dated April 2011
10 |2.0|July 2020|Addition of VTL (Validation and Transformation Language) package, maintainable artefacts, nameable artefacts to 5.2.3, 6.2.2, 6.2.3, 6.2.4, 7.1.1
11
12 **Corrigendum**
13
14 The following problems with the specification dated April 2011 have been rectified as described below.
15
16 1. **Problem**
17
18 Figure 17 - Logical Class Diagram of Registration of Data and Metadata – shows the Provision Agreement as it was identified in version 2.0, and not as it is identified in version 2.1.
19
20 **Rectification**
21
22 Provision Agreement is a Maintainable Artefact at version 2.1 and so the relationship is shown directly to the Provision Agreement class and not indirectly to the Provision Agreement via a ProvisionAgreementRef class.
23
24 **~1. Problem**
25
26 Figure 17 - Logical Class Diagram of Registration of Data and Metadata – shows the Registration class without the indexAttributes attribute.
27
28 **Rectification**
29
30 The attribute indexAttribute attribute is added to the Registration class and a description is of its purpose is given in the table at line 916.
31
32 **2. Problem**
33
34 Lines 437 and 648 of the April 2011 document mention that the fixed id for an AgencyScheme is AGENCY_SCHEME whereas it should be AGENCIES. **Rectification**
35
36 The reference to AGENCY_SCHEME is changed to AGENCIES.
37
38 **Adoption of the Validation and Transformation Language in 2020**
39
40 The SDMX specifications dated July 2011 envisaged the adoption of a language aimed at defining algorithms for the derivation of the data and presented a basic framework requiring however further elaboration for its actual use.
41
42 Following the adoption of the Validation and Transformation Language (VTL) version 2.0 and its application to SDMX 2.1, this section of the SDMX specifications has been integrated by introducing the VTL package, maintainable artefacts, nameable artefacts to the sections 5.2.3, 6.2.2, 6.2.3, 6.2.4 and 7.1.1.
43
44 = 1 Introduction =
45
46 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:
47
48 * the availability of an abstract information model capable of supporting timeseries and cross-sectional data, structural metadata, and reference metadata (SDMX-IM)
49 * standardised XML schemas derived from the model (SDMX-ML)
50 * the use of web-services technology (XML, XSD, WSDL, WADL)
51
52 Such an architecture needs to be well organised, and the SDMX Registry/Repository (SDMX-RR) is tasked with providing structure, organisation, and maintenance and query interfaces for most of the SDMX components required to support the datasharing vision.
53
54 However, it is important to emphasis 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.
55
56 Standard formats for the exchange of aggregated statistical data and metadata as prescribed in SDMX v2.1 are envisaged to bring benefits to the statistical community because data reporting and dissemination processes can be made more efficient.
57
58 As organisations migrate to SDMX enabled systems, many XML (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 and metadata structure definitions, XSLT style-sheets 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.
59
60 This is the role of the registry.
61
62 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.
63
64 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:
65
66 * structural metadata repository
67 * data and metadata registration
68 * query
69
70 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.
71
72 = 2 Scope and Normative Status =
73
74 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.
75
76 In this document, functions and behaviours of the Registry Interfaces are described in four ways:
77
78 * in text
79 * with tables
80 * with UML diagrams excerpted from the SDMX Information Model (SDMX-IM)
81 * with UML diagrams that are not a part of the SDMX-IM but are included here for clarity and to aid implementations (these diagram are clearly marked as “Logical Class Diagram ...”)
82
83 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.
84
85 Note that sections 5 and 6 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 (Part 03 of the SDMX Standard). All other sections of this document are informative.
86
87 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.
88
89 = 3 Scope of the SDMX Registry/Repository =
90
91 == 3.1 Objective ==
92
93 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:
94
95 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.
96 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.
97
98 == 3.2 Structural Metadata ==
99
100 Setting up structural metadata and the exchange context (referred to as “data provisioning”) involves the following steps for maintenance agencies:
101
102 * 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
103 * if required, defining a subset or view of a DSD which allows some restriction of content called a “dataflow definition”
104 * agreeing and creating a specification of the structure of reference metadata (Metadata Structure Definition) which defines the attributes and presentational arrangement of a Metadataset and their valid values and content
105 * if required, defining a subset or view of a MSD which allows some restriction of content called a “metadataflow definition”
106 * defining which subject matter domains (specified as a Category Scheme) are related to the Dataflow and Metadataflow Definitions to enable browsing
107 * defining one or more lists of Data Providers (which includes metadata providers)
108 * defining which Data Providers have agreed to publish a given Dataflow and/or Metadataflow Definition - this is called a Provision Agreement
109
110 [[image:1747824122996-812.jpeg]]
111
112 **Figure 1: Schematic of the Basic Structural Artifacts in the SDMX-IM**
113
114 == 3.3 Registration ==
115
116 Publishing the data and reference metadata involves the following steps for a Data Provider:
117
118 * making the reference metadata and data available in SDMX-ML conformant data files or databases (which respond to an SDMX-ML query with SDMX-ML data). The data and reference metadata files or databases must be webaccessible, and must conform to an agreed Dataflow or Metadataflow Definition (Data Structure Definition or Metadata Structure Definition subset)
119 * registering the existence of published reference metadata and data files or databases with one or more SDMX registries
120
121 [[image:1747824123003-199.jpeg]]
122
123 **Figure 2: Schematic of Registered Data and Metadata Sources in the SDMX-IM**
124
125 == 3.4 Notification ==
126
127 Notifying interested parties of newly published or re-published data, reference metadata or changes in structural metadata involves:
128
129 * 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
130
131 == 3.5 Discovery ==
132
133 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:
134
135 * optionally browsing a subject matter domain category scheme to find Dataflow Definitions (and hence Data Structure Definitions) and Metadataflows which structure the type of data and/or reference metadata being sought
136 * 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
137 * processing the query result set and retrieving data and/or reference metadata from the supplied URLs
138
139 [[image:1747824123006-476.jpeg]]
140
141 **Figure 3: Schematic of Data and Metadata Discovery and Query in the SDMX-IM**
142
143 = 4 SDMX Registry/Repository Architecture =
144
145 == 4.1 Architectural Schematic ==
146
147 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.
148
149 [[image:1747824123008-995.jpeg]]
150
151 **Figure 4: Schematic of the Registry Content and Services**
152
153 == 4.2 Structural Metadata Repository ==
154
155 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.
156
157 Note that the SDMX-ML Submit Structure Request message supports all of the SDMX structural artefacts. The only structural artefacts that are not supported by the SDMX-ML Submit Structure Request are::
158
159 * Registration of data and metadata sources
160 * Subscription and Notification
161
162 Separate registry-based messages are defined to support these artefacts.
163
164 == 4.3 Provisioning Metadata Repository ==
165
166 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 provider, for a specific data or metadata flow. In the SDMX model this is called the Provision Agreement.
167
168 This layer is supported by the Data and Metadata Registration Service.
169
170 = 5 Registry Interfaces and Services =
171
172 == 5.1 Registry Interfaces ==
173
174 The Registry Interfaces are:
175
176 * Notify Registry Event
177 * Submit Subscription Request
178 * Submit Subscription Response
179 * Submit Registration Request
180 * Submit Registration Response
181 * Query Registration Request
182 * Query Registration Response
183 * Query Subscription Request
184 * Query Subscription Response
185 * Submit Structure Request
186 * Submit Structure Response
187
188 The registry interfaces are invoked in one of two ways:
189
190 1. The interface is the name of the root node of the SDMX-ML document
191 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.
192
193 In addition to these interfaces the registry must support a mechanism for querying for structural metadata. This is detailed in 5.2.2.
194
195 All these interactions with the Registry – with the exception of Notify Registry Event – 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
196
197 “Response” document.
198
199 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 request-response pattern, because it is inherently asynchronous.
200
201 == 5.2 Registry Services ==
202
203 === 5.2.1 Introduction ===
204
205 The services described in this section do not imply that each is implemented as a discrete web service.
206
207 === 5.2.2 Structure Submission and Query Service ===
208
209 This service must implement the following SDMX-ML Interfaces:
210
211 * SubmitStructureRequest
212 * SubmitStructureResponse
213
214 These interfaces allow structural definitions to be created, modified, and removed in a controlled fashion. It also allows the structural metadata artefacts to be queried and retrieved either in part or as a whole. 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 (see next section on the SDMX Information Model).
215
216 === 5.2.3 Structure Query Service ===
217
218 The registry must support a mechanism for querying for structural metadata. This mechanism can be one or both of the SDMX-ML Query message and the SDMX REST interface for structural metadata (this is defined in Part 7 of the SDMX standards). The registry response to both of these query mechanisms is the SDMX Structure message which has as its root node
219
220 * Structure
221
222 The SDMX structural artefacts that may be queried are:
223
224 * dataflows and metadataflows
225 * data structure definitions and metadata structure definitions
226 * codelists
227 * concept schemes
228 * reporting taxonomies
229 * provision agreements
230 * structure sets
231 * processes
232 * hierarchical code lists
233 * constraints
234 * category schemes
235 * categorisations and categorised objects (examples are categorised dataflows and metadatflows, data structure definitions, metadata structure definitions, provision agreements registered data sources and metadata sources)
236 * organisation schemes (agency scheme, data provider scheme, data consumer scheme, organisation unit scheme)
237
238 Due to the VTL implementation the other structural artefact that may be queried are:
239
240 * transformation schemes
241 * custom type schemes
242 * name personalisation schemes
243 * vtl mapping schemes
244 * ruleset schemes
245 * user defined operator schemes
246
247 The SDMX query messages that are a part of the SDMX-ML Query message are:
248
249 * StructuresQuery
250 * DataflowQuery
251 * MetadataflowQuery
252 * DataStructureQuery
253 * MetadataStructureQuery
254 * CategorySchemeQuery
255 * ConceptScheneQuery
256 * CodelistQuery
257 * HierarchicalCodelistQuery
258 * OrganisationSchemeQuery
259 * ReportingTaxonomyQuery
260 * StructureSetQuery
261 * ProcessQuery
262 * CategorisationQuery
263 * ProvisionAgreementQuery
264 * ConstraintQuery
265
266 Due to the VTL implementation the other query messages that became a part of the SDMX-ML Query message are:
267
268 * TransformationSchemeQuery
269 * CustomTypeSchemeQuery
270 * VtlMappingSchemeQuery
271 * NamePersonalisationSchemeQuery
272 * RulesetSchemeQuery
273 * UserDefinedOperatorSchemeQuery
274
275 === 5.2.4 Data and Reference Metadata Registration Service ===
276
277 This service must implement the following SDMX-ML Interfaces:
278
279 * SubmitRegistrationRequest
280 * SubmitRegistrationResponse
281 * QueryRegistrationRequest
282 * QueryRegistrationResponse
283
284 The Data and Metadata Registration Service allows SDMX conformant XML files and web-accessible databases containing published data and reference metadata to be registered in the SDMX Registry. The registration process MAY validate the content of the data-sets or metadata-sets, and MAY extract a concise representation of the contents in terms of concept values (e.g. values of the data attribute, dimension, metadata attribute), or entire keys, and storing this as a record in the registry to enable discovery of the original data-set or metadata-set. These are called Constraints in the SDMX-IM.
285
286 The Data and Metadata Registration Service MAY validate the following, subject to the access control mechanism implemented in the Registry:
287
288 * that the data provider is allowed to register the data-set or metadata-set
289 * that the content of the data set or metadata set meets the validation constraints. This is dependent upon such constraints being defined in the structural repository and which reference the relevant Dataflow, Metadataflow, Data Provider, Data Structure Definition, Metadata Structure Definition, Provision Agreement
290 * that a queryable data source exists - this would necessitate the registration service querying the service to determine its existence
291 * that a simple data source exists (i.e. a file accessible at a URL)
292 * that the correct Data Structure Definition or Metadata Structure Definition is used by the registered data that the components (Dimensions, Attributes, Measures, Identifier Components etc.) are consistent with the Data Structure Definition or Metadata Structure Definition
293 *  that the valid representations of the concepts to which these components 382 correspond conform to the definition in the Data Structure Definition or Metadata Structure Definition
294
295 3The Registration has an action attribute which takes one of the following values:
296
297 |(((
298 **Action**
299
300 **Attribute Value**
301 )))|**Behaviour**
302 |Append|Add this registration to the registry
303 |Replace|Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request
304 |Delete|Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
305
306 The Registration has three Boolean attributes which may be present to determine how an SDMX compliant Dataset or Metadata Set indexing application must index the Datasets or Metadata Set upon registration. The indexing application behaviour is as follows:
307
308 |**Boolean Attribute**|**Behaviour if Value is “true”**
309 |indexTimeSeries|A compliant indexing application must index all the time series keys (for a Dataset registration) or metadata target values (for a Metadata Set registration)
310 |indexDataSet|(((
311 A compliant indexing application must index the range of actual (present) values for each dimension of the Dataset (for a Dataset registration) or the range of actual (present) values for each Metadata Attribute which takes an enumerated value.
312
313 Note that for data this requires much less storage than full key indexing, but this method cannot guarantee that a specific combination of Dimension values (the Key) is actually present in the Dataset
314 )))
315 |indexReportingPeriod|A compliant indexing application must index the time period range(s) for which data are present in the Dataset or Metadata Set
316
317 === 5.2.5 Data and Reference Metadata Discovery ===
318
319 The Data and Metadata Discovery Service implements the following Registry Interfaces:
320
321  QueryRegistrationRequest
322
323  QueryRegistrationResponse
324
325 === 5.2.6 Subscription and Notification ===
326
327 The Subscription and Notification Service implements the following Registry Interfaces:
328
329 * SubmitSubscriptionRequest
330 * SubmitSubscriptionResponse
331 * NotifyRegistryEvent
332
333 The data sharing paradigm relies upon the consumers of data and metadata being able to pull information from data providers’ dissemination systems. For this to work efficiently, a data consumer needs to know when to pull data, i.e. when something has changed in the registry (e.g. a dataset has been updated and re-registered). Additionally, SDMX systems may also want to know if a new Data Structure Definition, Code List or Metadata Structure Definition has been added. The Subscription and Notification Service comprises two parts: subscription management, and notification.
334
335 Subscription management involves a user submitting a subscription request which contains:
336
337 * a query or constraint expression in terms of a filter which defines the events for which the user is interested (e.g. new data for a specific dataflow, or for a domain category, or changes to a Data Structure Definition).
338 * a list of URIs or end-points to which an XML notification message can be sent. Supported end-point types will be email (mailto~:) and HTTP POST (a normal http:~/~/ address)
339 * request for a list of submitted subscriptions
340 * deletion of a subscription
341
342 Notification requires that the structural metadata repository and the provisioning metadata repository monitor any event which is of interest to a user (the object of a subscription request query), and to issue an SDMX-ML notification document to the end-points specified in the relevant subscriptions.
343
344 === 5.2.7 Registry Behaviour ===
345
346 The following table defines the behaviour of the SDMX Registry for the various Registry Interface messages.
347
348 |**Interface**|**Behaviour**
349 |All|(((
350 1) If the action is set to “replace” then the entire contents of the existing maintainable object in the Registry MUST be replaced by the object submitted, unless the final attribute is set to “true” in which case the only changes that are allowed are to the following constructs:
351
352 * Name – this applies to the Maintainable object and its contained elements, such a Code in a Code list.
353 * Description - this applies to the Maintainable object and its contained elements, such a Code in a Code list.
354
355 * Annotation - this applies to the Maintainable object and its contained elements, such a Code in a Code list.
356 * validTo
357 * validFrom
358 * structureURL
359 * serviceURL
360 * uri
361 * isExternalReference
362
363 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.
364 1. If the action is set to “delete” then the Registry MUST verify that the object can deleted. In order to qualify for deletion the object must:
365
366 1. Not have the final attribute set to “true”
367 1. Not be referenced from any other object in the Registry.
368
369 1. The version rules in the SDMX Schema documentation MUST be obeyed.
370
371 * The specific rules for the elements and attributes documented in the SDMX Schema MUST be obeyed.
372 )))
373 |SubmitStructureRequest|Structures are submitted at the level of the Maintainable Artefact and the behaviour in “All” above is therefore at the level of the Maintainable Artefact.
374 |SubmitProvisioningRequest|No additional behaviour.
375 |Submit Registration Request|(((
376 If the datasource is a file (simple datasource) then the file MAY be retrieved and indexed according to the Boolean attributes set in the Registration.
377
378 For a queryable datasource the Registry MAY validate that the source exists and can accept an SDMX-ML data query.
379 )))
380
381
382
383 = 6 Identification of SDMX Objects =
384
385 == 6.1 Identification, Versioning, and Maintenance ==
386
387 All major classes of the SDMX Information model inherit from one of:
388
389
390 * **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.
391 * **NamableArtefact **- this has all of the features of IdentifiableArtefact plus the ability to have a multi-lingual name and description,
392 * **VersionableArtefact **– this has all of the above features plus a version number and a validity period.
393 * **MaintainableArtefact** – this has all of the above features, and indication as to whether the object is “final” and cannot be changed or deleted, registry and structure URIs, plus an association to the maintenance agency of the object.
394
395 === 6.1.1 Identification, Naming, Versioning, and Maintenance Model ===
396
397 **Figure 5: Class diagram of fundamental artefacts in the SDMX-IM**
398
399 The table below shows the identification and related data attributes to be stored in a registry for objects that are one of:
400
401 * Annotable
402 * Identifiable
403 * Nameable
404 * Versionable
405 * Maintainable
406
407 |**Object Type**|**Data Attributes**|**Status**|**Data type**|**Notes**
408 |Annotable|AnnotationTitle|C|string|
409 | |AnnotationType|C|string|
410 | |AnnotationURN|C|string|
411 | |(((
412 AnnotationText in the form of
413
414 International String
415 )))|C| |This can have languagespecific variants.
416 | | | | |
417 |Identifiable|all content as for Annotable plus| | |
418 | |id|M|string|
419 | |uri|C|string|
420 | |urn|C|string|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.
421 |Nameable|all content as for Identifiable plus| | |
422 | |Name in the form of International String|M|string|This can have languagespecific variants.
423 | |(((
424 Description in the form of International
425
426 String
427 )))|C|string|This can have languagespecific variants.
428 |Versionable|All content as for Identifiable plus| | |
429 | |version|C|string|This is the version number. If not present the default is 1.0
430 | |validFrom|C|Date/time|
431 | |validTo|C|Date/time|
432 |Maintainable|All content as for Versionable plus| | |
433 | |final| |boolean|Value of “true” indicates that this is a final specification and it cannot be changed except as a new version. Note that providing a “final’ object is not referenced from another object then it may be deleted.
434 | |isExternalReference|C|boolean|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 structureURI, each of which must return a valid SDMX-ML file.
435 | |serviceURL|C|string|The url of the service that can be queried for this resource
436 | |structureURL|C|string|The url of the resource.
437 | |(Maintenance) agencyId|M|string|The object must be linked to a maintenance agency.
438
439 **Table 1: Common Attributes of Object Types**
440
441 == 6.2 Unique identification of SDMX objects ==
442
443 === 6.2.1 Agencies ===
444
445 The Maintenance Agency in SDMX is maintained in an Agency Scheme which itself is a sub class of Organisation Scheme – this is shown in the class diagram below.
446
447 **Figure 6: Agency Scheme Model**
448
449 The Agency in SDMX is extremely important. The Agency Id system used in SDMX is an n-level structure. The top level of this structure is maintained by SDMX. Any Agency in this top level can declare sub agencies and any sub agency can also declare sub agencies. The Agency Scheme has a fixed id and version and is never declared explicitly in the SDMX object identification mechanism.
450
451 In order to achieve this SDMX adopts the following rules:
452
453 1. Agencies are maintained in an Agency Scheme (which is a sub class of Organisation Scheme)
454 1. The agency of the Agency Scheme must also be declared in a (different) Agency Scheme.
455 1. The “top-level” agency is SDMX and maintains the “top-level” Agency Scheme.
456 1. Agencies registered in the top-level scheme can themselves maintain a single Agency Scheme. Agencies in these second-tier schemes can themselves maintain a single Agency Scheme and so on.
457 1. The AgencyScheme cannot be versioned and so take a default version number of 1.0 and cannot be made “final”.
458 1. There can be only one AgencyScheme maintained by any one Agency. It has a fixed Id of AGENCIES.
459 1. The /hierarchy of Organisation is not inherited by Maintenance Agency – thus each Agency Scheme is a flat list of Maintenance Agencies.
460 1. The format of the agency identifier is agencyID.agencyID etc. The toplevel agency in this identification mechanism is the agency registered in the SDMX agency scheme. In other words, SDMX is not a part of the hierarchical ID structure for agencies. However SDMX is, itself, a maintenance agency and is contained in the top-level Agency Scheme.
461
462 This supports a hierarchical structure of agencyID.
463
464 An example is shown below.
465
466 [[image:1747824123012-527.jpeg]]
467
468 ==== Figure 7: Example of Hierarchic Structure of Agencies ====
469
470 The following organizations maintain an Agency Scheme.
471
472 * SDMX – contains Agencies AA, BB
473 * AA – contains Agencies CC, DD
474 * BB – contains Agencies CC, DD
475 * DD – Contains Agency EE
476
477 Each agency is identified by its full hierarchy excluding SDMX.
478
479 e.g. the id of EE as an agencyID is AA.DD.EE
480
481 An example of this is shown in the XML snippet below.
482
483
484 [[image:1747824123013-196.jpeg]]
485
486 ==== Figure 8: Example Showing Use of Agency Identifiers ====
487
488 Each of these maintenance agencies has an identical Code list with the Id CL_BOP. However, each is uniquely identified by means of the hierarchic agency structure.
489
490 === 6.2.2 Universal Resource Name (URN) ===
491
492 ==== 6.2.2.1 Introduction ====
493
494 To provide interoperability between SDMX Registry/Repositories in a distributed network environment, it is important to have a scheme for uniquely identifying (and thus accessing) all first-class (Identifiable) SDMX-IM objects. Most of these unique identifiers are composite (containing maintenance agency, or parent object identifiers), and there is a need to be able to construct a unique reference as a single string. This is achieved by having a globally unique identifier called a universal resource name (URN) which is generated from the actual identification components in the SDMX-RR APIs. In other words, the URN for any Identifiable Artefact is constructed from its component identifiers (agency, Id, version etc.).
495
496 ==== 6.2.2.2 URN Structure ====
497
498 ===== //Case Rules for URN// =====
499
500 For the URN, all parts of the string are case sensitive. The Id of any object must be UPPER CASE. Therefore, CRED_ext_Debt is invalid and it should be CRED_EXT_DEBT.
501
502 The generic structure of the URN is as follows:
503
504 SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobject-id(maintainedobject-version).*containerobject-id.object-id
505
506 ~* this can repeat and may not be present (see explanation below)
507
508 Note that in the SDMX Information Model there are no concrete Versionable Artefacts that are not a Maintainable Artefact. For this reason the only version information that is allowed is for the maintainable object.
509
510 The Maintenance agency identifier is separated from the maintainable artefact identifier by a colon ‘:’. All other identifiers in the SDMX URN syntax are separated by a period(.).
511
512 ==== 6.2.2.3 Explanation of the generic structure ====
513
514 In the explanation below the actual object that is the target of the URN is called the **//actual object//**.
515
516 **SDMXPrefix:** urn:sdmx:org.                                     
517
518 **SDMX-IM package name:** sdmx.infomodel.package=
519
520 [[image:1747824123016-678.png]]
521
522 **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.
523
524 **(maintainable-object-version)** is the version of the maintainable object and is enclosed in round brackets (). It will always be present.
525
526 **container-object-id** is the identifier of an intermediary object that contains the actual object which the URN is identifying. It is not mandatory as many actual objects do not have an intermediary container object. For instance, a Code is in a maintained object (Code List) and has no intermediary container object, whereas a Metadata Attribute has an intermediary container object (Report Structure) and may have an intermediary container object which is its parent Metadata Attribute. For this reason the container object id may repeat, with each repetition identifying the object at the next-lower level in its hierarchy. Note that if there is only a single containing object in the model then it is NOT included in the URN structure. This applies to Attribute Descriptor, Dimension Descriptor, and Measure Descriptor where there can be only one such object and this object has a fixed id. Therefore, whilst each of these has a
527
528 URN, the id of the Attribute Descriptor, Dimension Descriptor, and Measure Descriptor is not included when the actual object is a Data Attribute or a Dimension/Measure Dimension/ Time Dimension, or a Measure.
529
530 Note that although a Code can have a parent Code and a Concept can have a parent Concept these are maintained in a flat structure and therefore do not have a container-object-id.
531
532 For example the sequence is agency:DSDid(version).DimensionId and not agency:DSDid(version).DimensionDescriptorId.DimensionId.
533
534 **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.
535
536 ===== //Generic Examples of the URN Structure// =====
537
538
539 Actual object is a maintainable
540
541 SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version)
542
543 Actual object is contained in a maintained object with no intermediate containing object
544
545 SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).object-id
546
547 Actual object is contained in a maintained object with an intermediate containing object
548
549 SDMXPrefix.SDMX-IM package name.classname=agency
550
551 id:maintained-object-id(version).contained-object-id.object-id
552
553 Actual object is contained in a maintained object with no intermediate containing object but the object type itself is hierarchical
554
555 In this case the object id may not be unique in itself but only within the context of the hierarchy. In the general syntax of the URN all intermediary objects in the structure (with the exception, of course, of the maintained object) are shown as a contained object. An example here would be a Category in a Category Scheme. The Category is hierarchical and all intermediate Categories are shown as a contained object. The example below shows the generic structure for Category Scheme/Category/Category
556
557 SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).contained-object-id.object-id
558
559 Actual object is contained in a maintained object with an intermediate containing object and the object type itself is hierarchical
560
561 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 Metadata Attribute where the contained objects are Report Structure (first contained object id) and Metadata Attribute (subsequent contained object Ids). The example below shows the generic structure for MSD/Report Structure/Metadata Attribute/Metadata Attribute
562
563 SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).contained-object-id. contained-object-id contained-object-id.object-id
564
565 ===== //Concrete Examples of the URN Structure// =====
566
567 The Data Structure Definition CRED_EXT_DEBT version 1.0 maintained by the top level Agency TFFS would have the URN:
568
569 urn:sdmx:org.sdmx.infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(1.0)
570
571 The URN for a code for Argentina maintained by ISO in the code list CL_3166A2 version 1.0 would be:
572
573 urn:sdmx:org.sdmx.infomodel.codelist.Code=ISO:CL_3166A2(1.0).AR
574
575 The URN for a category (id of 1) which has parent category (id of 2) maintained by SDMX in the category scheme SUBJECT_MATTER_DOMAINS version 1.0 would be:
576
577 urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:SUBJE CT_MATTER_DOMAINS(1.0).1.2
578
579 The URN for a Metadata Attribute maintained by SDMX in the MSD CONTACT_METADATA version 1.0 in the Report Structure CONTACT_REPORT where the hierarchy of the Metadata Attribute is
580
581 CONTACT_DETAILS/CONTACT_NAME would be:
582
583 urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataAttribut e=SDMX:CONTACT_METADATA(1.0).CONTACT_REPORT.CONTACT_DETAILS.CO NTACT_NAME
584
585 The TFFS defines ABC as a sub Agency of TFFS then the URN of a Dataflow maintained by ABC and identified as EXTERNAL_DEBT version 1.0 would be:
586
587 urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=TFFS.ABC:EX
588
589 TERNAL_DEBT(1.0)
590
591 The SDMX-RR MUST support this globally unique identification scheme. The SDMXRR MUST be able to create the URN from the individual identification attributes submitted and to transform the URN to these identification attributes. The identification attributes are:
592
593 * **Identifiable and Nameable Artefacts**: id (in some cases this id may be hierarchic)
594 * **Maintainable Artefacts**: id, version, agencyId,
595
596 The SDMX-RR MUST be able to resolve the unique identifier of an SDMX artefact and to produce an SDMX-ML rendering of that artefact if it is located in the Registry.
597
598 === 6.2.3 Table of SDMX-IM Packages and Classes ===
599
600 The table below lists all of the packages in the SDMX-IM together with the concrete classes that are in these packages and whose objects have a URN.
601
602 |**Package**|(((
603 **URN Classname (model classname**
604
605 **where this is different)**
606 )))
607 |base|Agency
608 | |OrganisationUnitScheme
609 | |AgencyScheme
610 | |DataProviderScheme
611 | |DataConsumerScheme
612 | |OrganisationUnit
613 | |DataProvider
614 | |DataConsumer
615 | |
616 |datastructure|DataStructure (DataStructureDefinition)
617 | |AttributeDescriptor
618 | |DataAttribute
619 | |GroupDimensionDescriptor
620 | |DimensionDescriptor
621 | |Dimension
622 | |MeasureDimension
623 | |TimeDimension
624 | |MeasureDescriptor
625 | |PrimaryMeasure
626 | |Dataflow (DataflowDefinition)
627 | |
628 |metadatastructure|MetadataTarget
629 | |DimensionDescriptorValueTarget
630 | |IdentifiableObjectTarget
631 | |ReportPeriodTarget
632 | |DataSetTarget
633 | |ReportStructure
634 | |MetadataAttribute
635 | |(((
636 MetadataStructure
637
638 (MetadataStructureDefinition)
639 )))
640 | |Metadataflow (MetadataflowDefinition)
641 | |
642 |process|Process
643 | |ProcessStep
644 | |Transition
645 | |
646 |registry|ProvisionAgreement
647 | |AttachmentConstraint
648 | |ContentConstraint
649 | |Subscription
650 | |
651 |mapping|StructureMap
652 | |StructureSet
653 | |ComponentMap
654 |**Package**|(((
655 **URN Classname (model classname**
656
657 **where this is different)**
658 )))
659 | |ConceptSchemeMap
660 | |OrganisationSchemeMap
661 | |CodelistMap
662 | |CategorySchemeMap
663 | |ReportingTaxonomyMap
664 | |ConceptMap
665 | |OrganisationMap
666 | |CodeMap
667 | |HybridCodelistMap
668 | |CategoryMap
669 | |HybridCodeMap
670 | |ReportingCategoryMap
671 | |
672 |codelist|Codelist
673 | |HierarchicalCodelist
674 | |Hierarchy
675 | |Hierarchy
676 | |Code
677 | |HierarchicalCode
678 | |Level
679 | |
680 |categoryscheme|CategoryScheme
681 | |Category
682 | |Categorisation
683 | |ReportingTaxonomy
684 | |ReportingCategory
685 | |
686 |conceptscheme|ConceptScheme
687 | |Concept
688 | |
689 |transformation|TransformationScheme
690 | |Transformation
691 | |CustomTypeScheme
692 | |CustomType
693 | |NamePersonalisationScheme
694 | |NamePersonalisation
695 | |VtlCodelistMapping
696 | |VtlConceptMapping
697 | |VtlDataflowMapping
698 | |VtlConceptSchemeMapping
699 | |RulesetScheme
700 | |Ruleset
701 | |UserDefinedOperatorScheme
702 | |UserDefinedOperator
703 | |
704
705 **Table 2: SDMX-IM Packages and Contained Classes**
706
707
708 === 6.2.4 URN Identification components of SDMX objects ===
709
710 The table below describes the identification components for all SDMX object types that have identification. Note the actual attributes are all Id, but have been prefixed by their class name or multiple class names to show navigation, e.g. conceptSchemeAgencyId is really the Id attribute of the Agency class that is associated to the ConceptScheme.
711
712 ~* indicates that the object is maintainable.
713
714 Note that for brevity the URN examples omit the prefix. All URNs have the prefix
715
716 urn:sdmx.org.sdmx.infomodel.{package}.{classname}=
717
718
719 |**SDMX Class**|**Key attribute(s)**|**Example of URN**
720 |Agency|The URN for an Agency is shown later in this table. The identification of an Agency in the URN structure for the maintainable object is by means of the agencyId. The AgencyScheme is not identified as SDMX has a mechanism for identifying an Agency uniquely by its Id. Note that this Id may be hierarchical.|(((
721 IMF
722
723
724 Sub agency in the IMF AGENCIES
725
726
727 IMF.SubAgency1
728 )))
729 |*ConceptScheme|conceptSchemeAgencyId:conceptSchemeId(ve rsion)|SDMX:CROSS_DOMAIN_CONCEPTS(1.0)
730 |Concept|(((
731 conceptSchemeAgencyId:
732
733 conceptSchemeId(version).conceptId
734 )))|SDMX:CROSS_DOMAIN_CONCEPTS(1.0).FREQ
735 |*Codelist|codeListAgencyId:codeListId(version)|SDMX:CL_FREQ(1.0)
736 |Code|codeListAgencyId:codelistId(version).codeId|(((
737 SDMX:CL_FREQ(1.0).Q
738
739
740 )))
741
742
743
744 |(((
745 *Hierarchical
746
747 Codelist
748 )))|hierachicalCodelistAgencyId: hierarchicalCodelistId(version)|(((
749 UNESCO:CL_EXP_SOURCE(1.0)
750
751
752 )))
753 |Hierarchy|(((
754 hierachicalcodeListAgencyId:
755
756 hierarchicalcodelistId(version).Hierarchy
757 )))|UNESCO:CL_EXP_SOURCE(1.0). H-C-GOV
758 |Level|(((
759 hierachicalcodeListAgencyId:
760
761 hierarchicalcodelistId(version).Hierarchy.Level
762 )))|(((
763 ESTAT:HCL_REGION(1.0).H_1.COUNTRY
764
765
766 )))
767 |HierarchicalCode|hierachicalCodeListAgencyId: hierarchicalcodelistId(version).hierarchy.hierarc hicalCode|UNESCO:CL_EXP_SOURCE(1.0). H-C-GOV.GOV_CODE1
768 |*DataStructure|dataStructureDefintitionAgencyId: dataStructureDefintitionId(version)|TFFS:EXT_DEBT(1.0)
769 |(((
770 Dimension
771
772 Descriptor
773
774 Measure
775
776 Descriptor
777
778 Attribute
779
780 Descriptor
781 )))|(((
782 dataStructureDefinitionAgencyId: dataStructureDefinitionId(version).
783
784 componentListId
785
786 where the componentListId is the name of the class (there is only one occurrence of each in the Data Structure Definition)
787 )))|(((
788 TFFS:EXT_DEBT(1.0).DimensionDescriptor
789
790 TFFS:EXT_DEBT(1.0).MeasureDescriptor
791
792 TFFS:EXT_DEBT(1.0).AttributeDescriptor
793 )))
794 |(((
795 GroupDimension
796
797 Descriptor
798 )))|(((
799 dataStructureDefinitionAgencyId: dataStructureDefinitionId(version).
800
801 groupDimensionDescriptorId
802 )))|TFFS:EXT_DEBT(1.0).SIBLING
803 |Dimension|(((
804 dataStructureDefinitionAgencyId: dataStructureDefinition (version).
805
806 dimensionId
807 )))|TFFS:EXT_DEBT(1.0).FREQ
808 |TimeDimension|(((
809 dataStructureDefinitionAgencyId: dataStructureDefinition (version).
810
811 timeDimensionId
812 )))|TFFS:EXT_DEBT(1.0).TIME_PERIOD
813 |Measure Dimension|dataStructureDefinitionAgencyId: dataStructureDefinition (version).|TFFS:EXT_DEBT(1.0).STOCK_FLOW
814
815
816
817 | |measureDimensionId|
818 |DataAttrribute|dataStructureDefinitionAgencyId: dataStructureDefinition (version). dataAttributeId|TFFS:EXT_DEBT(1.0).OBS_STATUS
819 |PrimaryMeasure|(((
820 dataStructureDefinitionAgencyId: dataStructureDefinition (version).
821
822 primaryMeasureId
823 )))|TFFS:EXT_DEBT(1.0).OBS_VALUE
824 |(((
825 *Category
826
827 Scheme
828 )))|categorySchemeAgencyId: categorySchemeId(version)|IMF:SDDS(1.0)
829 |Category|categorySchemeAgencyId: categorySchemeId(version). categoryId.categoryId categoryId.categoryId etc.|(((
830 IMF:SDDS(1.0):
831
832 level_1_category.level_2_category …
833 )))
834 |(((
835 *Reporting
836
837 Taxonomy
838 )))|reportingTaxonomyAgencyId: reportingTaxonomyId(version)| IMF:REP_1(1.0)
839 |ReportingCategory|reportingTaxonomyAgencyId: reportingTaxonomyId(version) reportingcategoryId.reportingcategoryId|(((
840 IMF:REP_1(1.0):
841
842 level_1_repcategory.level_2_repcategory …
843 )))
844 |*Categorisation|categorisationAgencyId: categorisationId(version)|IMF:cat001(1.0)
845 |(((
846 *Organisation
847
848 Unit Scheme
849 )))|organisationUnitSchemeAgencyId: organisationUnitSchemeId(version)|ECB:ORGANISATIONS(1.0)
850 |Organisation Unit|organisationUnitSchemeAgencyId: organisationUnitSchemeId(version). organisationUnitId|ECB:ORGANISATIONS(1.0).1F
851 |*AgencyScheme|agencySchemeAgencyId: agencySchemeId(version)|ECB:AGENCIES(1.0)
852
853
854
855 |Agency|agencySchemeAgencyId: agencySchemeId(version). agencyId|ECB:AGENCY(1.0).AA
856 |(((
857 *DataProvider
858
859 Scheme
860 )))|dataProviderSchemeAgencyId: dataProviderSchemeId(version)|SDMX:DATA_PROVIDERS(1.0)
861 |DataProvider|dataProviderSchemeAgencyId: dataProviderSchemeId(version) dataProviderId|SDMX:DATA_PROVIDERS(1.0).PROVIDER_1
862 |(((
863 *DataConsumer
864
865 Scheme
866 )))|dataConsumerSchemeAgencyId: dataConsumerSchemeId(version)|SDMX:DATA_CONSUMERS(1.0)
867 |Data Consumer|dataConsumerSchemeAgencyId: dataConsumerSchemeId(version) dataConsumerId|SDMX:DATA_CONSUMERS(1.0).CONSUMER_1
868 |(((
869 *Metadata
870
871 Structure
872 )))|MSDAgencyId:MSDId(version)|IMF:SDDS_MSD(1.0)
873 |MetadataTarget|(((
874 MSDAgencyId:
875
876 MSDId(version).metadataTargetId
877 )))|IMF:SDDS_MSD(1.0).AGENCY
878 |(((
879 Dimension
880
881 DescriptorValues
882
883 Target
884 )))|(((
885 MSDAgencyId: MSDId(version).
886
887 metadataTargetId.keyDescriptorValueTargetId
888 )))|IMF:SDDS_MSD(1.0).AGENCY.KEY
889 |Identifiable ObjectTarget|(((
890 MSDAgencyId:
891
892 MSDId(version).metadataTargetId.identifiable
893
894 ObjectTargetId
895 )))|IMF:SDDS_MSD(1.0).AGENCY.STR-OBJECT
896 |DataSetTarget|(((
897 MSDAgencyId:
898
899 MSDId(version).metadataTargetId.dataSet
900
901 TargetId
902 )))|IMF:SDDS_MSD(1.0).AGENCY.D1101
903 |PeportPeriod Target|(((
904 MSDAgencyId:
905
906 MSDId(version).metadataTargetId.reportPeriod
907
908 TargetId
909 )))|IMF:SDDS_MSD(1.0).AGENCY.REP_PER
910
911
912
913 |(((
914 ReportStructure
915
916
917 )))|(((
918 MSDAgencyId:
919
920 MSDId(version).reportStructureId
921 )))|IMF:SDDS_MSD(1.0).AGENCY_REPORT
922 |(((
923 Metadata
924
925 Attribute
926 )))|(((
927 MSDAgencyId:
928
929 MSDId(version).reportStructureId.metadataattri buteID
930 )))|IMF:SDDS_MSD(1.0).AGENCY_REPORT.COMPILATION
931 |*Dataflow|dataflowAgencyId: dataflowId(version)|TFFS:CRED_EXT_DEBT(1.0)
932 |*Provision Agreement|(((
933 provisionAgreementAgencyId:provisionAgreem entId(version)
934
935
936 )))|(((
937 TFFS:CRED_EXT_DEBT_AB(1.0)
938
939
940
941 )))
942 |(((
943 *Content
944
945 Constraint
946 )))|constraintAgencyId:ContentConstraintId(versio n)|TFFS:CREDITOR_DATA_CONTENT(1.0)
947 |(((
948 *Attachment
949
950 Constraint
951 )))|(((
952 constraintAgencyId:
953
954 attachmentConstraintId(version)
955 )))|TFFS:CREDITOR_DATA_ATTACHMENT_CONSTRAINT_ONE(1.0)
956 |*Metadataflow|metadataflowAgencyId: metadataflowId(version)|IMF:SDDS_FLOW(1.0)
957 |*StructureSet|structureSetAgencyId: structureSetId(version)|SDMX:BOP_STRUCTURES(1.0)
958 |StructureMap|structureSetAgencyId: structureSetId(version). structureMapId|SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2
959 |Component Map|(((
960 structureSetAgencyId: structureSetId(version).
961
962 structureMapId. componentMapId
963 )))|SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2. REFAREA_REPCOUNTRY
964 |CodelistMap|structureSetAgencyId: structureSetId(version). codelistMapId|SDMX:BOP_STRUCTURES(1.0).CLREFAREA_CLREPCOUNTRY
965 |CodeMap|structureSetAgencyId: structureSetId(version).|SDMX:BOP_STRUCTURES(1.0).CLREFAREA_CLREPCOUNTRY. DE_GER
966
967
968
969 | |(((
970 codeListMapId.
971
972 codeMapId
973 )))|
974 |(((
975 Category
976
977 SchemeMap
978 )))|structureSetAgencyId: structureSetId(version). categorySchemeMapId|SDMX:BOP_STRUCTURES(1.0).SDMX_EUROSTAT
979 |CategoryMap|structureSetAgencyId: structureSetId(version). categorySchemeMapId. categoryMapId|SDMX:BOP_STRUCTURES(1.0).SDMX_EUROSTAT.TOURISM_M AP
980 |Organisation SchemeMap|structureSetAgencyId: structureSetId(version). organisationSchemeMapId|SDMX:BOP_STRUCTURES(1.0).DATA_PROVIDER_MAP
981 |Organisation Map|structureSetAgencyId: structureSetId(version). organisationSchemeMapId. organisationMapId|SDMX:BOP_STRUCTURES(1.0).DATA_PROVIDER_MAP.IMF_1C0
982 |(((
983 Concept
984
985 SchemeMap
986 )))|structureSetAgencyId: structureSetId(version). conceptSchemeMapId|SDMX:BOP_STRUCTURES(1.0).SDMX_OECD
987 |ConceptMap|(((
988 structureSetAgencyId: structureSetId(version). conceptSchemeMapId.
989
990 conceptMapId
991
992
993 )))|SDMX:BOP_STRUCTURES(1.0).SDMX_OECD.COVERAGE_AVAI LABILITY
994 |(((
995 Reporting
996
997 TaxonomyMap
998 )))|structureSetAgencyId: structureSetId(version). reportingTaxonomyMapId|SDMX:BOP_STRUCTURES(1.0).TAXMAP
999 |(((
1000 Reporting
1001
1002 CategoryMap
1003 )))|(((
1004 structureSetAgencyId: structureSetId(version).
1005
1006 reportngCategoryId
1007 )))|SDMX:BOP_STRUCTURES(1.0).TAXMAP.TOPCAT
1008
1009
1010
1011 |(((
1012 HybridCodelist
1013
1014 Map
1015 )))|structureSetAgencyId: structureSetId(version). hybridCodelistMapId.|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP
1016 |HybridCodeMap|structureSetAgencyId: structureSetId(version). hybridCodelistMapId. hybridCodeMapId|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP.CO DEMAP1
1017 |*Process|processAgencyId: processId{version]|BIS:PROCESS1(1.0)
1018 |ProcessStep|(((
1019 processAgencyId: processId(version).
1020
1021 processStepId
1022 )))|BIS:PROCESS1(1.0).STEP1
1023 |Transition|(((
1024 processAgencyId: processId(version).
1025
1026 processStepId transitionId
1027 )))|BIS:PROCESS1(1.0).STEP1.TRANSITION1
1028 |Subscription|The Subscription is not itself an Identifiable Artefact and therefore it does not follow the rules for URN structure, The name of the URN is registryURN There is no pre-determined format.|This cannot be generated by a common mechanism as subscriptions, although maintainable in the sense that they can be submitted and deleted, are not mandated to be created by a maintenance agency, and have no versioning mechanism. It is therefore the responsibility of the target registry to generate a unique Id for the Subscription, and for the application creating the subscription to store the registryURN that is returned from the registry in the subscription response message.
1029 |(((
1030 *Transformation
1031
1032 Scheme
1033 )))|transformationSchemeAgencyId transformationSchemeId(version)|ECB: TRANSFORMATION_SCHEME(1.0)
1034 |Transformation|(((
1035 transformationSchemeAgencyId transformationSchemeId(version)
1036
1037 transformationId
1038 )))|ECB:TRANSFORMATION_SCHEME(1.0).TRANS_1
1039 |CustomType Scheme|customTypeSchemeAgencyId customTypeSchemeId(version)|ECB:CUSTOM_TYPE_SCHEME(1.0)
1040
1041
1042
1043 |CustomType|customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|ECB: CUSTOM_TYPE_SCHEME(1.0).CUSTOM_TYPE_1
1044 |(((
1045 Name
1046
1047 Personalisation
1048
1049 Scheme
1050 )))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|ECB:PSN_SCHEME(1.0)
1051 |(((
1052 Name
1053
1054 Personalisation
1055 )))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|ECB:PSN_SCHEME(1.0).PSN1234
1056 |VtlMapping Scheme|vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|ECB:CLIST_MP(2.0)
1057 |VtlCodelist Mapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|ECB:CLIST_MP(2.0).ABZ
1058 |VtlConcept Mapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|ECB:CLIST_MP(1.0).XYA
1059 |VtlDataflow Mapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|ECB:CLIST_MP(1.0).MOQ
1060 |(((
1061 VtlConcept
1062
1063 SchemeMapping
1064 )))|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptSchemeId|ECB:CLIST_MP(1.0).Z11
1065 |RulesetScheme|rulesetSchemeAgencyId rulesetSchemeId(version)|ECB:RULESET_23(1.0)
1066 |Ruleset|rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|ECB:RULESET_23(1.0).SET111
1067 |(((
1068 UserDefined
1069
1070 OperatorScheme
1071 )))|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|ECB:OS_CALC(1.2)
1072 |UserDefined Operator|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|ECB:OS_CALC(1.2).OS267
1073
1074 7**Table 3: Table of identification components for SDMX Identifiable Artefacts**
1075
1076
1077 = 7 Implementation Notes =
1078
1079 == 7.1 Structural Definition Metadata ==
1080
1081 === 7.1.1 Introduction ===
1082
1083 The SDMX Registry must have the ability to support agencies in their role of defining and disseminating structural metadata artefacts. These artefacts include data structure definitions, code lists, concepts etc. and are fully defined in the SDMX-IM. An authenticated agency may submit valid structural metadata definitions which must be stored in the registry. Note that the term “structural metadata” refers as a general term to all structural components (Data structure Definitions, Metadata Structure Definitions, Code lists, Concept Schemes, etc.)
1084
1085 At a minimum, structural metadata definitions may be submitted to and queried from the registry via an HTTP/HTTPS POST in the form of one of the SDMX-ML registry messages for structural metadata and the SDMX Query message for structure queries. The use of SOAP is also recommended, as described in the SDMX Web Services Guidelines. The message may contain all structural metadata items for the whole registry, structural metadata items for one maintenance agency, or individual structural metadata items.
1086
1087 Structural metadata items
1088
1089 * may only be modified by the maintenance agency which created them
1090 * may only be deleted by the agency which created them
1091 * may not be deleted if they are referenced from other constructs in the Registry
1092
1093 The level of granularity for the maintenance of SDMX Structural Metadata objects in the registry is the Maintainable Artefact. In other words, any function such as add, modify, delete is at the level of the Maintainable Artefact. For instance, if a Code is added to a Code List, or the Name of a Code is changed, the Registry must replace the existing Code List with the submitted Code List of the same Maintenance Agency, Code List, Id and Version.
1094
1095 The following table lists the Maintainable Artefacts.
1096
1097 |(% colspan="4" %)**Maintainable Artefacts**|(% colspan="2" %)**Content**|
1098 |(% colspan="2" %)**Abstract Class**|(% colspan="2" %)**Concrete Class**|(% colspan="2" %) |
1099 |(% colspan="2" %)Item Scheme|(% colspan="2" %)Codelist|(% colspan="2" %)Code|
1100 |(% colspan="2" %) |(% colspan="2" %)Concept Scheme|(% colspan="2" %)Concept|
1101 |(% colspan="2" %) |(% colspan="2" %)Category Scheme|(% colspan="2" %)Category|
1102 |(% colspan="2" %) |(% colspan="2" %)Organisation Unit Scheme|(% colspan="2" %)Organisation Unit|
1103 |(% colspan="2" %) |(% colspan="2" %)Agency Scheme|(% colspan="2" %)Agency|
1104 |(% colspan="2" %) |(% colspan="2" %)Data Provider Scheme|(% colspan="2" %)Data Provider|
1105 |(% colspan="2" %) |(% colspan="2" %)Data Consumer Scheme|(% colspan="2" %)Data Consumer|
1106 |(% colspan="2" %) |(% colspan="2" %)Reporting Taxonomy|(% colspan="2" %)Reporting Category|
1107 |(% colspan="2" %) |(% colspan="2" %)Transformation Scheme|(% colspan="2" %)Transformation|
1108 |(% colspan="2" %) |(% colspan="2" %)Custom Type Scheme|(% colspan="2" %)Custom Type|
1109 | |(% colspan="4" %)**Maintainable Artefacts**|(% colspan="2" %)**Content**
1110 | |(% colspan="2" %)**Abstract Class**|(% colspan="2" %)**Concrete Class**|(% colspan="2" %)
1111 | |(% colspan="2" %) |(% colspan="2" %)Name Personalisation Scheme|(% colspan="2" %)Name Personalisation
1112 | |(% colspan="2" %) |(% colspan="2" %)Vtl Mapping Scheme|(% colspan="2" %)Vtl Codelist Mapping
1113 | |(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)Vtl Concept Mapping
1114 | |(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)Vtl Dataflow Mapping
1115 | |(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)(((
1116 Vtl Concept Scheme
1117
1118 Mapping
1119 )))
1120 | |(% colspan="2" %) |(% colspan="2" %)Ruleset Scheme|(% colspan="2" %)Ruleset
1121 | |(% colspan="2" %) |(% colspan="2" %)User Defined Operator Scheme|(% colspan="2" %)User Defined Operator
1122 | |(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
1123 | |(% colspan="2" %)Structure|(% colspan="2" %)Data Structure Definition|(% colspan="2" %)(((
1124 Dimension Descriptor
1125
1126 Group Dimension
1127
1128 Descriptor
1129
1130 Dimension
1131
1132 Measure Dimension
1133
1134 Time Dimension
1135
1136 Attribute Descriptor
1137
1138 Data Attribute
1139
1140 Measure Descriptor
1141
1142 Primary Measure
1143 )))
1144 | |(% colspan="2" %) |(% colspan="2" %)Metadata Structure Definition|(% colspan="2" %)(((
1145 Metadata Target,
1146
1147 Dimension Descriptor
1148
1149 Values Target Identifiable
1150
1151 Object Target
1152
1153 Report Period Target
1154
1155 Data SetTarget
1156
1157 Report Structure
1158
1159 Metadata Attribute
1160 )))
1161 | |(% colspan="2" %)Structure Usage|(% colspan="2" %)Dataflow Definition|(% colspan="2" %)
1162 | |(% colspan="2" %) |(% colspan="2" %)Metadataflow Definition|(% colspan="2" %)
1163 | |(% colspan="2" %)None|(% colspan="2" %)Process|(% colspan="2" %)Process Step
1164 | |(% colspan="2" %)None|(% colspan="2" %)Structure Set|(% colspan="2" %)(((
1165 Component Map
1166
1167 Concept Scheme Map
1168
1169 Codelist Map
1170
1171 Category Scheme Map
1172
1173 Reporting Taxonomy Map
1174
1175 Organisation Scheme Map
1176
1177 Concept Map
1178
1179 Code Map
1180
1181 Category Map
1182
1183 Organisation Map
1184
1185 Reporting Category Map
1186
1187 Hybrid Codelist Map
1188
1189 Hybrid Code Map
1190 )))
1191 | |(% colspan="2" %)None|(% colspan="2" %)Provision Agreement|(% colspan="2" %)
1192 | |(% colspan="2" %)None|(% colspan="2" %)Hierarchical Codelist|(% colspan="2" %)(((
1193 Hierarchy
1194
1195 Hierarchical Code
1196 )))
1197 | | | | | | |
1198
1199 **Table 4: Table of Maintainable Artefacts for Structural Definition Metadata**
1200
1201 === 7.1.2 Item Scheme, Structure ===
1202
1203 The artefacts included in the structural definitions are:
1204
1205 * All types of Item Scheme (Codelist, Concept Scheme, Category Scheme, Organisation Scheme - Agency Scheme, Data Provider Scheme, Data Consumer Scheme, Organisation Unit Scheme)
1206 * All types of Structure (Data Structure Definition, Metadata Structure
1207
1208 Definition)
1209
1210 * All types of Structure Usage (Dataflow Definition, Metadataflow Definition)
1211
1212 === 7.1.3 Structure Usage ===
1213
1214 ==== 7.1.3.1 Structure Usage: Basic Concepts ====
1215
1216 The Structure Usage defines, in its concrete classes of Dataflow Definition and
1217
1218 Metadataflow Definition, which flows of data and metadata use which specific Structure, and importantly for the support of data and metadata discovery, the Structure Usage can be linked to one or more Category in one or more Category Scheme using the Categorisation mechanism. This gives the ability for an application to discover data and metadata by “drilling down” the Category Schemes.
1219
1220 ==== 7.1.3.2 Structure Usage Schematic ====
1221
1222 [[image:1747824123018-658.jpeg]]
1223
1224 **Figure 9: Schematic of Linking the Data and Metadata Flows to Categories and Structure Definitions**
1225
1226 ==== 7.1.3.3 Structure Usage Model ====
1227
1228 **Figure 10: SDMX-IM of links from Structure Usage to Category**
1229
1230 In addition to the maintenance of the Dataflow Definition and the Metadataflow Definition the following links must be maintained in the registry:
1231
1232 * Dataflow Definition to Data Structure Definition
1233 * Metadataflow Definition to Metadata Structure Definition
1234
1235 The following links may be created by means of a Categorisation
1236
1237 * Categorisation to Dataflow Definition and Category
1238 * Categorisation to Metadataflow Definition and Category
1239
1240 == 7.2 Data and Metadata Provisioning ==
1241
1242 === 7.2.1 Provisioning Agreement: Basic concepts ===
1243
1244 Data provisioning defines a framework in which the provision of different types of statistical data and metadata by various data providers can be specified and controlled. This framework is the basis on which the existence of data can be made known to the SDMX-enabled community and hence the basis on which data can subsequently be discovered. Such a framework can be used to regulate the data content to facilitate the building of intelligent applications. It can also be used to facilitate the processing implied by service level agreements, or other provisioning agreements in those scenarios that are based on legal directives. Additionally, quality and timeliness metadata can be supported by this framework which makes it practical to implement information supply chain monitoring.
1245
1246 Note that in the SDMX-IM the class “Data Provider” encompasses both data and metadata and the term “data provisioning” here includes both the provisioning of data and metadata.
1247
1248 Although the Provision Agreement directly supports the data-sharing “pull” model, it is also useful in “push” exchanges (bilateral and gateway scenarios), or in a dissemination environment. It should be noted, too, that in any exchange scenario, the registry functions as a repository of structural metadata.
1249
1250 === 7.2.2 Provisioning Agreement Model – pull use case ===
1251
1252 An organisation which publishes statistical data or reference metadata and wishes to make it available to an SDMX enabled community is called a Data Provider. In terms of the SDMX Information Model, the Data Provider is maintained in a Data Provider Scheme.
1253
1254
1255 **Figure 11: SDMX-IM of the Data Provider**
1256
1257
1258 Note that the Data Provider does not inherit the hierarchy association. The diagram below shows a logical schematic of the data model classes required to maintain provision agreements
1259
1260 [[image:1747824123019-181.jpeg]]
1261
1262 **Figure 12: Schematic of the Provision Agreement**
1263
1264 The diagram below is a logical representation of the data required in order to maintain Provision Agreements.
1265
1266
1267 ==== Figure 13: Logical class diagram of the information contained in the Provision Agreement ====
1268
1269 A Provision Agreement is structural metadata. Each Provision Agreement must reference a Data Provider and a Dataflow or Metadataflow Definition. The Data Provider and the Dataflow/Metadataflow Definition must exist already in order to set up a Provision Agreement.
1270
1271 == 7.3 Data and Metadata Constraints ==
1272
1273 === 7.3.1 Data and Metadata Constraints: Basic Concepts ===
1274
1275 Constraints are, effectively, lists of the valid or actual content of data and metadata. Constraints can be used to specify a sub set of the theoretical content of data set or metadata set which can be derived from the specification of the DSD or MSD. A Constraint can comprise a list of keys or a list of content (usually code values) of a specific component such as a dimension or attribute.
1276
1277 Constraints comprise the specification of subsets of key or target values or attribute values that are contained in a Datasource, or is to be provided for a Dataflow or Metadataflow Definition, or directly attached to a Data Structure Definition or Metadata Structure Definition. This is important metadata because, for example, the full range of possibilities which is implied by the Data Structure Definition (e.g. the complete set of valid keys is the Cartesian product of all the values in the code lists for each of the Dimensions) is often more than is actually present in any specific Datasource, or more than is intended to be supplied according to a specific Dataflow Definition.
1278
1279 Often a Data Provider will not be able to provide data for all key combinations, either because the combination itself is not meaningful, or simply because the provider does not have the data for that combination. In this case the Data Provider could constrain the Datasource (at the level of the Provision Agreement or the Data Provider) by supplying metadata that defines the key combinations or cube regions that are available. This is done by means of a Constraint. The Content Constraint is also used to define a code list sub set which is used to populate a Partial Code List.
1280
1281 Furthermore, it is often useful to define subsets or views of the Data Structure Definition which restrict values in some code lists, especially where many such subsets restrict the same Data Structure Definition. Such a view is called a Dataflow Definition, and there can be one or more defined for any Data Structure Definition.
1282
1283 Whenever data is published or made available by a Data Provider, it must conform to a Dataflow Definition (and hence to a Data Structure Definition). The Dataflow Definition is thus a means of enabling content based processing.
1284
1285 In addition, Constraints can be extremely useful in a data visualisation system, such as dissemination of statistics on a website. In such a system a Cube Region can be used to specify the Dimension codes that actually exist in a datasource (these can be used to build relevant selection tables), and the Key Set can be used to specify the keys that exist in a datasource (these can be used to guide the user to select only those Dimension code values that will return data based on the Dimension values already selected).
1286
1287 === 7.3.2 Data and Metadata Constraints: Schematic ===
1288
1289 [[image:1747824123021-978.jpeg]]
1290
1291 **Figure 14: Schematic of the Constraint and the Artefacts that can be Constrained**
1292
1293 === 7.3.3 Data and Metadata Constraints: Model ===
1294
1295
1296
1297 ==== Figure 15: Logical class diagram showing inheritance between and reference to constrainable artifacts ====
1298
1299 The class diagram above shows that DataProvider, DataflowDefinition, MetadataflowDefinition, ProvisionAgreement, DataStructureDefinition, MetadataStructureDefinition, SimpleDatasource and QueryDatasource are all concrete sub-classes of ConstrainableArtefact and can therefore have Constraints specified. Note that the actual Constraint as submitted is associated to the reference classes which inherit from ConstrainableRef: these are used to refer to the classes to which the Constraint applies.
1300
1301
1302 The content of the Constraint can be found in the SDMX Information Model document.
1303
1304 == 7.4 Data and Metadata Registration ==
1305
1306 === 7.4.1 Basic Concepts ===
1307
1308 A Data Provider has published a new dataset conforming to an existing Dataflow Definition (and hence Data Structure Definition). This is implemented as either a web-accessible SDMX-ML file, or in a database which has a web-services interface capable of responding to an SDMX-ML Query or RESTful query with an SDMX-ML data stream.
1309
1310 The Data Provider wishes to make this new data available to one or more data collectors in a “pull” scenario, or to make the data available to data consumers. To do this, the Data Provider registers the new dataset with one or more SDMX conformant registries that have been configured with structural and provisioning metadata. In other words, the registry “knows” the Data Provider and “knows” what data flows the data provider has agreed to make available.
1311
1312 The same mechanism can be used to report or make available a metadata set.
1313
1314 SDMX-RR supports dataset and metadata set registration via the Registration Request, which can be created by the Data Provider (giving the Data Provider maximum control). The registry responds to the registration request with a registration response which indicates if the registration was successful. In the event of an error, the error messages are returned as a registry exception within the response.
1315
1316 === 7.4.2 The Registration Request ===
1317
1318 ==== 7.4.2.1 Registration Request Schematic ====
1319
1320 [[image:1747824123025-411.jpeg]]
1321
1322 **Figure 16: Schematic of the Objects Concerned with Registration**
1323
1324 ==== 7.4.2.2 Registration Request Model ====
1325
1326 The following UML diagram shows the composition of the registration request. Each request is made up of one or more Registrations, one per dataset or metadata set to be registered. The Registration can optionally have information which has been extracted from the Registration:
1327
1328 * validFrom
1329 * validTo
1330 * lastUpdated
1331
1332 The last updated date is useful during the discovery process to make sure the client knows which data is freshest.
1333
1334 The Registration has an action attribute which takes one of the following values:
1335
1336 |**Action Attribute Value**|**Behaviour**
1337 |Append|Add this Registration to the registry
1338 |Replace|Replace the existing Registration with identified by the id in the Registration of the Submit Registration Request
1339 |Delete|Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
1340
1341 **Figure 17: Logical Class Diagram of Registration of Data and Metadata**
1342
1343 The Query Datasource is an abstract class that represents a data source which can understand an SDMX-ML query (SOAPDatasource) or RESTful query
1344
1345 (RESTDatasource) and respond appropriately. Each of these different Datasources inherit the dataURL from Datasource, and the QueryDatasource has an additional URL to locate a WSDL or WADL document to describe how to access it. All other supported protocols are assumed to use the Simple Datasource URL.
1346
1347 A Simple Datasource is used to reference a physical SDMX-ML file that is available at a URL.
1348
1349 The Registration Request has an action attribute which defines whether this is a new (append) or updated (replace) Registration, or that the Registration is to be deleted (delete). The id is only provided for the replace and delete actions, as the Registry will allocate the unique id of the (new) Registration.
1350
1351 The Registration includes attributes that state how a Simple Datasource is to be indexed when registered. The Registry registration process must act as follows.
1352
1353 Information in the data or metadata set is extracted and placed in one or more Content Constraints (see the Constraints model in the SDMX Information Model – Section 2 of the SDMX Standards). The information to be extracted is indicated by the Boolean values set on the Provision Agreement as shown in the table below.
1354
1355 |**Indexing Required**|**Registration Process Activity**
1356 |indexTimeSeries|Extract all the series keys and create a KeySet(s) Constraint.
1357 |indexDataSet|(((
1358 Extract all the codes and other content of the Key value of the Series Key in a Data Set and create one or more Cube
1359
1360 Regions containing Member Selections of Dimension Components of the Constraints model in the SDMX-IM, and the associated Selection Value.
1361 )))
1362 |indexReportingPeriod|(((
1363 This applies only to a registered dataset.
1364
1365 Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint.
1366 )))
1367 |indexAttributes|(((
1368 **Data Set**
1369
1370 Extract the content of the Attribute Values in a Data Set and create one or more Cube Regions containing Member Selections of Data Attribute Components of the Constraints model in the SDMXIM, and the associated Selection Value
1371
1372 **Metadata Set**
1373
1374 Indicate the presence of a Reported Attribute by creating one or more Cube Regions containing Member Selections of Metadata Attribute Components of the Constraints model in the SDMX-IM. Note that the content is not stored in the Selection Value.
1375 )))
1376
1377 Constraints that specify the contents of a Query Datasource are submitted to the Registry in a Submit Structure Request.
1378
1379 The Registration must reference the Provision Agreement to which it relates.
1380
1381 === 7.4.3 Registration Response ===
1382
1383 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 Submit Registration class has a status field which is either set to
1384
1385 “Success”, “Warning” or “Failure”.
1386
1387 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, metadataset, or query service.
1388
1389 The Registration Response returns set of registration status (one for each registration submitted) in terms of a Status Message (this is common to all Registry Responses) that indicates success or failure. In the event of registration failure, a set of Message Text are returned, giving the error messages that occurred during registration. It is entirely possible when registering a batch of datasets, that the response will contain some successful and some failed statuses. The logical model for the Registration Response is shown below:
1390
1391
1392 **Figure 18: Logical class diagram showing the registration response**
1393
1394 == 7.5 Subscription and Notification Service ==
1395
1396 The contents of the SDMX Registry/Repository will change regularly: new code lists and key families will be published, new datasets and metadata-sets will be registered. To obviate the need for users to repeatedly query the registry to see when new information is available, a mechanism is provided to allow users to be notified when these events happen.
1397
1398 A user can submit a subscription in the registry that defines which events are of interest, and either an email and/or an HTTP address to which a notification of qualifying events will be delivered. The subscription will be identified in the registry by a URN which is returned to the user when the subscription is created. If the user wants to delete the subscription at a later point, the subscription URN is used as identification. Subscriptions have a validity period expressed as a date range (startDate, endDate) and the registry may delete any expired subscriptions, and will notify the subscriber on expiry.
1399
1400 When a registry/repository artefact is modified, any subscriptions which are observing the object are activated, and either an email or HTTP POST is instigated to report details of the changes to the user specified in the subscription. This is called a
1401
1402 “notification”.
1403
1404 7.5.1Subscription Logical Class Diagram
1405
1406
1407 [[image:1747824123028-257.png]]
1408
1409 **Figure 19: Logical Class Diagram of the Subscription**
1410
1411 === 7.5.2 Subscription Information ===
1412
1413 Regardless of the type of registry/repository events being observed, a subscription always contains:
1414
1415 ~1. A set of URIs describing the end-points to which notifications must be sent if the subscription is activated. The URIs can be either mailto~: or http: protocol. In the former case an email notification is sent; in the latter an HTTP POST notification is sent.
1416
1417 2. A user-defined identifier which is returned in the response to the subscription request. This helps with asynchronous processing and is NOT stored in the Registry.
1418
1419 3. A validity period which defines both when the subscription becomes active and expires. The subscriber may be sent a notification on expiration of the subscription.
1420
1421 4. A selector which specifies which type of events are of interest. The set of event types is:
1422
1423 |**Event Type**|**Comment**
1424 |STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1425 |DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
1426 |METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
1427 |ALL_EVENTS|All events of the specified EventType
1428
1429 === 7.5.3 Wildcard Facility ===
1430
1431 Subscription notification supports wildcarded identifier components URNs, which are identiiers which have some or all of their component parts replaced by the wildcard character `%`. Identifier components comprise:
1432
1433  agencyID
1434
1435  id
1436
1437  version
1438
1439 Examples of wildcarded identifier components for an identified object type of Codelist are shown below.
1440
1441 AgencyID = %
1442
1443 Id = %
1444
1445 Version = %
1446
1447 This subscribes to all Codelists of all versions for all agencies.
1448
1449 AgencyID = AGENCY1
1450
1451 Id = CODELIST1
1452
1453 Version = %
1454
1455 This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1456
1457 AGENCY1
1458
1459 AgencyID = AGENCY1
1460
1461 Id = %
1462
1463 Version = %
1464
1465 This subscribes to all versions of all Codelist objects maintained by the agency
1466
1467 AGENCY1
1468
1469 AgencyID = %
1470
1471 Id = CODELIST1
1472
1473 Version = %
1474
1475 This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1476
1477 AGENCY1
1478
1479 Note that if the subscription is to the latest version then this can be achieved by the * character
1480
1481 i.e. Version = *
1482
1483 Note that a subscription using the URN mechanism cannot use wildcard characters.
1484
1485 === 7.5.4 Structural Repository Events ===
1486
1487 Whenever a maintainable artefact (data structure definition, concept scheme, codelist, metadata structure definition, category scheme, etc.) is added to, deleted from, or modified in the structural metadata repository, a structural metadata event is triggered. Subscriptions may be set up to monitor all such events, or focus on specific artefacts such as a Data Structure Definition.
1488
1489 === 7.5.5 Registration Events ===
1490
1491 Whenever a dataset or metadata-set is registered a registration event is created. A subscription may be observing all data or metadata registrations, or it may focus on specific registrations as shown in the table below:
1492
1493
1494 |**Selector**|**Comment**
1495 |DataProvider|Any datasets or metadata sets registered by the specified data provider will activate the notification.
1496 |ProvisionAgreement|Any datasets or metadata sets registered for the provision agreement will activate the notification.
1497 |Dataflow (&Metadataflow)|Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
1498 |DataStructureDefinition & MetadataStructureDefinition|Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will
1499 |**Selector**|**Comment**
1500 | |activate the notification.
1501 |Category|Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category.
1502
1503 The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration.
1504
1505 == 7.6 Notification ==
1506
1507 === 7.6.1 Logical Class Diagram ===
1508
1509
1510 ==== Figure 20: Logical Class Diagram of the Notification ====
1511
1512 A notification is an XML document that is sent to a user via email or http POST whenever a subscription is activated. It is an asynchronous one-way message.
1513
1514 Regardless of the registry component that caused the event to be triggered, the following common information is in the message:
1515
1516 * Date and time that the event occurred
1517 * The URN of the artefact that caused the event
1518 * The URN of the Subscription that produced the notification
1519 * Event Action: Add, Replace, or Delete.
1520
1521 Additionally, supplementary information may be contained in the notification as detailed below.
1522
1523 === 7.6.2 Structural Event Component ===
1524
1525 The notification will contain the MaintainableArtefact that triggered the event in a form similar to the SDMX-ML structural message (using elements from that namespace).
1526
1527 === 7.6.3 Registration Event Component ===
1528
1529 The notification will contain the Registration.
1530
1531