Skip to Content
Version 14.1 by Artur on 2025/07/14 10:19
Show last authors
1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 **Revision History**
6
7 (% style="width:833.294px" %)
8 |(% style="width:122px" %)**Revision**|(% style="width:126px" %)**Date**|(% style="width:581px" %)**Contents**
9 |(% style="width:122px" %) |(% style="width:126px" %)April 2011|(% style="width:581px" %)Initial release
10 |(% style="width:122px" %)1.0|(% style="width:126px" %)July 2011|(% style="width:581px" %)Rectification of problems of the specifications dated April 2011
11 |(% style="width:122px" %)2.0|(% style="width:126px" %)July 2020|(% style="width:581px" %)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
12
13 **Corrigendum**
14
15 The following problems with the specification dated April 2011 have been rectified as described below.
16
17 1. **Problem**
18
19 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.
20
21 **Rectification**
22
23 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.
24
25 **~1. Problem**
26
27 Figure 17 - Logical Class Diagram of Registration of Data and Metadata – shows the Registration class without the indexAttributes attribute.
28
29 **Rectification**
30
31 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.
32
33 **2. Problem**
34
35 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**
36
37 The reference to AGENCY_SCHEME is changed to AGENCIES.
38
39 **Adoption of the Validation and Transformation Language in 2020**
40
41 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.
42
43 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.
44
45 = 1 Introduction =
46
47 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:
48
49 * the availability of an abstract information model capable of supporting timeseries and cross-sectional data, structural metadata, and reference metadata (SDMX-IM)
50 * standardised XML schemas derived from the model (SDMX-ML)
51 * the use of web-services technology (XML, XSD, WSDL, WADL)
52
53 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.
54
55 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.
56
57 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.
58
59 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.
60
61 This is the role of the registry.
62
63 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.
64
65 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:
66
67 * structural metadata repository
68 * data and metadata registration
69 * query
70
71 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.
72
73 = 2 Scope and Normative Status =
74
75 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.
76
77 In this document, functions and behaviours of the Registry Interfaces are described in four ways:
78
79 * in text
80 * with tables
81 * with UML diagrams excerpted from the SDMX Information Model (SDMX-IM)
82 * 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 ...”)
83
84 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.
85
86 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.
87
88 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.
89
90 = 3 Scope of the SDMX Registry/Repository =
91
92 == 3.1 Objective ==
93
94 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:
95
96 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.
97 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.
98
99 == 3.2 Structural Metadata ==
100
101 Setting up structural metadata and the exchange context (referred to as “data provisioning”) involves the following steps for maintenance agencies:
102
103 * 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
104 * if required, defining a subset or view of a DSD which allows some restriction of content called a “dataflow definition”
105 * 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
106 * if required, defining a subset or view of a MSD which allows some restriction of content called a “metadataflow definition”
107 * defining which subject matter domains (specified as a Category Scheme) are related to the Dataflow and Metadataflow Definitions to enable browsing
108 * defining one or more lists of Data Providers (which includes metadata providers)
109 * defining which Data Providers have agreed to publish a given Dataflow and/or Metadataflow Definition - this is called a Provision Agreement
110
111 [[image:1747824122996-812.jpeg]]
112
113 **Figure 1: Schematic of the Basic Structural Artifacts in the SDMX-IM**
114
115 == 3.3 Registration ==
116
117 Publishing the data and reference metadata involves the following steps for a Data Provider:
118
119 * 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)
120 * registering the existence of published reference metadata and data files or databases with one or more SDMX registries
121
122 [[image:1747824123003-199.jpeg]]
123
124 **Figure 2: Schematic of Registered Data and Metadata Sources in the SDMX-IM**
125
126 == 3.4 Notification ==
127
128 Notifying interested parties of newly published or re-published data, reference metadata or changes in structural metadata involves:
129
130 * 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
131
132 == 3.5 Discovery ==
133
134 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:
135
136 * 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
137 * 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
138 * processing the query result set and retrieving data and/or reference metadata from the supplied URLs
139
140 [[image:1747824123006-476.jpeg]]
141
142 **Figure 3: Schematic of Data and Metadata Discovery and Query in the SDMX-IM**
143
144 = 4 SDMX Registry/Repository Architecture =
145
146 == 4.1 Architectural Schematic ==
147
148 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.
149
150 [[image:1747824123008-995.jpeg]]
151
152 **Figure 4: Schematic of the Registry Content and Services**
153
154 == 4.2 Structural Metadata Repository ==
155
156 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.
157
158 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::
159
160 * Registration of data and metadata sources
161 * Subscription and Notification
162
163 Separate registry-based messages are defined to support these artefacts.
164
165 == 4.3 Provisioning Metadata Repository ==
166
167 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.
168
169 This layer is supported by the Data and Metadata Registration Service.
170
171 = 5 Registry Interfaces and Services =
172
173 == 5.1 Registry Interfaces ==
174
175 The Registry Interfaces are:
176
177 * Notify Registry Event
178 * Submit Subscription Request
179 * Submit Subscription Response
180 * Submit Registration Request
181 * Submit Registration Response
182 * Query Registration Request
183 * Query Registration Response
184 * Query Subscription Request
185 * Query Subscription Response
186 * Submit Structure Request
187 * Submit Structure Response
188
189 The registry interfaces are invoked in one of two ways:
190
191 1. The interface is the name of the root node of the SDMX-ML document
192 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.
193
194 In addition to these interfaces the registry must support a mechanism for querying for structural metadata. This is detailed in 5.2.2.
195
196 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 “Response” document.
197
198 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.
199
200 == 5.2 Registry Services ==
201
202 === 5.2.1 Introduction ===
203
204 The services described in this section do not imply that each is implemented as a discrete web service.
205
206 === 5.2.2 Structure Submission and Query Service ===
207
208 This service must implement the following SDMX-ML Interfaces:
209
210 * SubmitStructureRequest
211 * SubmitStructureResponse
212
213 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).
214
215 === 5.2.3 Structure Query Service ===
216
217 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
218
219 * Structure
220
221 The SDMX structural artefacts that may be queried are:
222
223 * dataflows and metadataflows
224 * data structure definitions and metadata structure definitions
225 * codelists
226 * concept schemes
227 * reporting taxonomies
228 * provision agreements
229 * structure sets
230 * processes
231 * hierarchical code lists
232 * constraints
233 * category schemes
234 * categorisations and categorised objects (examples are categorised dataflows and metadatflows, data structure definitions, metadata structure definitions, provision agreements registered data sources and metadata sources)
235 * organisation schemes (agency scheme, data provider scheme, data consumer scheme, organisation unit scheme)
236
237 Due to the VTL implementation the other structural artefact that may be queried are:
238
239 * transformation schemes
240 * custom type schemes
241 * name personalisation schemes
242 * vtl mapping schemes
243 * ruleset schemes
244 * user defined operator schemes
245
246 The SDMX query messages that are a part of the SDMX-ML Query message are:
247
248 * StructuresQuery
249 * DataflowQuery
250 * MetadataflowQuery
251 * DataStructureQuery
252 * MetadataStructureQuery
253 * CategorySchemeQuery
254 * ConceptScheneQuery
255 * CodelistQuery
256 * HierarchicalCodelistQuery
257 * OrganisationSchemeQuery
258 * ReportingTaxonomyQuery
259 * StructureSetQuery
260 * ProcessQuery
261 * CategorisationQuery
262 * ProvisionAgreementQuery
263 * ConstraintQuery
264
265 Due to the VTL implementation the other query messages that became a part of the SDMX-ML Query message are:
266
267 * TransformationSchemeQuery
268 * CustomTypeSchemeQuery
269 * VtlMappingSchemeQuery
270 * NamePersonalisationSchemeQuery
271 * RulesetSchemeQuery
272 * UserDefinedOperatorSchemeQuery
273
274 === 5.2.4 Data and Reference Metadata Registration Service ===
275
276 This service must implement the following SDMX-ML Interfaces:
277
278 * SubmitRegistrationRequest
279 * SubmitRegistrationResponse
280 * QueryRegistrationRequest
281 * QueryRegistrationResponse
282
283 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.
284
285 The Data and Metadata Registration Service MAY validate the following, subject to the access control mechanism implemented in the Registry:
286
287 * that the data provider is allowed to register the data-set or metadata-set
288 * 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
289 * that a queryable data source exists - this would necessitate the registration service querying the service to determine its existence
290 * that a simple data source exists (i.e. a file accessible at a URL)
291 * 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
292 * that the valid representations of the concepts to which these components correspond conform to the definition in the Data Structure Definition or Metadata Structure Definition
293
294 The Registration has an action attribute which takes one of the following values:
295
296 |(% style="width:219px" %)**Action Attribute Value**|(% style="width:1652px" %)**Behaviour**
297 |(% style="width:219px" %)Append|(% style="width:1652px" %)Add this registration to the registry
298 |(% style="width:219px" %)Replace|(% style="width:1652px" %)Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request
299 |(% style="width:219px" %)Delete|(% style="width:1652px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
300
301 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:
302
303 |(% style="width:228px" %)**Boolean Attribute**|(% style="width:1644px" %)**Behaviour if Value is “true”**
304 |(% style="width:228px" %)indexTimeSeries|(% style="width:1644px" %)A compliant indexing application must index all the time series keys (for a Dataset registration) or metadata target values (for a Metadata Set registration)
305 |(% style="width:228px" %)indexDataSet|(% style="width:1644px" %)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.
306 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
307 |(% style="width:228px" %)indexReportingPeriod|(% style="width:1644px" %)A compliant indexing application must index the time period range(s) for which data are present in the Dataset or Metadata Set
308
309 === 5.2.5 Data and Reference Metadata Discovery ===
310
311 The Data and Metadata Discovery Service implements the following Registry Interfaces:
312
313 * QueryRegistrationRequest
314 * QueryRegistrationResponse
315
316 === 5.2.6 Subscription and Notification ===
317
318 The Subscription and Notification Service implements the following Registry Interfaces:
319
320 * SubmitSubscriptionRequest
321 * SubmitSubscriptionResponse
322 * NotifyRegistryEvent
323
324 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.
325
326 Subscription management involves a user submitting a subscription request which contains:
327
328 * 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).
329 * 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)
330 * request for a list of submitted subscriptions
331 * deletion of a subscription
332
333 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.
334
335 === 5.2.7 Registry Behaviour ===
336
337 The following table defines the behaviour of the SDMX Registry for the various Registry Interface messages.
338
339 |(% style="width:227px" %)**Interface**|(% style="width:1644px" %)**Behaviour**
340 |(% style="width:227px" %)All|(% style="width:1644px" %)(((
341 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:
342
343 * Name – this applies to the Maintainable object and its contained elements, such a Code in a Code list.
344 * Description - this applies to the Maintainable object and its contained elements, such a Code in a Code list.
345 * Annotation - this applies to the Maintainable object and its contained elements, such a Code in a Code list.
346 * validTo
347 * validFrom
348 * structureURL
349 * serviceURL
350 * uri
351 * isExternalReference
352
353 2) 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.
354 3) 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:
355
356 а) Not have the final attribute set to “true”
357 b) Not be referenced from any other object in the Registry.
358
359 4) The version rules in the SDMX Schema documentation MUST be obeyed.
360 5) The specific rules for the elements and attributes documented in the SDMX Schema MUST be obeyed.
361 )))
362 |(% style="width:227px" %)SubmitStructureRequest|(% style="width:1644px" %)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.
363 |(% style="width:227px" %)SubmitProvisioningRequest|(% style="width:1644px" %)No additional behaviour.
364 |(% style="width:227px" %)Submit Registration Request|(% style="width:1644px" %)(((
365 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.
366 For a queryable datasource the Registry MAY validate that the source exists and can accept an SDMX-ML data query.
367 )))
368
369 = 6 Identification of SDMX Objects =
370
371 == 6.1 Identification, Versioning, and Maintenance ==
372
373 All major classes of the SDMX Information model inherit from one of:
374
375 * **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.
376 * **NamableArtefact **- this has all of the features of IdentifiableArtefact plus the ability to have a multi-lingual name and description,
377 * **VersionableArtefact **– this has all of the above features plus a version number and a validity period.
378 * **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.
379
380 === 6.1.1 Identification, Naming, Versioning, and Maintenance Model ===
381
382 [[image:1747824504225-229.png]]
383
384 **Figure 5: Class diagram of fundamental artefacts in the SDMX-IM**
385
386 The table below shows the identification and related data attributes to be stored in a registry for objects that are one of:
387
388 * Annotable
389 * Identifiable
390 * Nameable
391 * Versionable
392 * Maintainable
393
394 (% style="width:935.294px" %)
395 |**Object Type**|(% style="width:244px" %)**Data Attributes**|(% style="width:99px" %)**Status**|**Data type**|(% style="width:389px" %)**Notes**
396 |Annotable|(% style="width:244px" %)AnnotationTitle|(% style="width:99px" %)C|string|(% style="width:389px" %)
397 | |(% style="width:244px" %)AnnotationType|(% style="width:99px" %)C|string|(% style="width:389px" %)
398 | |(% style="width:244px" %)AnnotationURN|(% style="width:99px" %)C|string|(% style="width:389px" %)
399 | |(% style="width:244px" %)(((
400 AnnotationText in the form of International String
401 )))|(% style="width:99px" %)C| |(% style="width:389px" %)This can have languagespecific variants.
402 |Identifiable|(% style="width:244px" %)all content as for Annotable plus|(% style="width:99px" %) | |(% style="width:389px" %)
403 | |(% style="width:244px" %)id|(% style="width:99px" %)M|string|(% style="width:389px" %)
404 | |(% style="width:244px" %)uri|(% style="width:99px" %)C|string|(% style="width:389px" %)
405 | |(% style="width:244px" %)urn|(% style="width:99px" %)C|string|(% style="width:389px" %)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.
406 |Nameable|(% style="width:244px" %)all content as for Identifiable plus|(% style="width:99px" %) | |(% style="width:389px" %)
407 | |(% style="width:244px" %)Name in the form of International String|(% style="width:99px" %)M|string|(% style="width:389px" %)This can have languagespecific variants.
408 | |(% style="width:244px" %)(((
409 Description in the form of International String
410 )))|(% style="width:99px" %)C|string|(% style="width:389px" %)This can have languagespecific variants.
411 |Versionable|(% style="width:244px" %)All content as for Identifiable plus|(% style="width:99px" %) | |(% style="width:389px" %)
412 | |(% style="width:244px" %)version|(% style="width:99px" %)C|string|(% style="width:389px" %)This is the version number. If not present the default is 1.0
413 | |(% style="width:244px" %)validFrom|(% style="width:99px" %)C|Date/time|(% style="width:389px" %)
414 | |(% style="width:244px" %)validTo|(% style="width:99px" %)C|Date/time|(% style="width:389px" %)
415 |Maintainable|(% style="width:244px" %)All content as for Versionable plus|(% style="width:99px" %) | |(% style="width:389px" %)
416 | |(% style="width:244px" %)final|(% style="width:99px" %) |boolean|(% style="width:389px" %)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.
417 | |(% style="width:244px" %)isExternalReference|(% style="width:99px" %)C|boolean|(% style="width:389px" %)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.
418 | |(% style="width:244px" %)serviceURL|(% style="width:99px" %)C|string|(% style="width:389px" %)The url of the service that can be queried for this resource
419 | |(% style="width:244px" %)structureURL|(% style="width:99px" %)C|string|(% style="width:389px" %)The url of the resource.
420 | |(% style="width:244px" %)(Maintenance) agencyId|(% style="width:99px" %)M|string|(% style="width:389px" %)The object must be linked to a maintenance agency.
421
422 **Table 1: Common Attributes of Object Types**
423
424 == 6.2 Unique identification of SDMX objects ==
425
426 === 6.2.1 Agencies ===
427
428 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.
429
430 [[image:1747994320263-112.png]]
431
432 **Figure 6: Agency Scheme Model**
433
434 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.
435
436 In order to achieve this SDMX adopts the following rules:
437
438 1. Agencies are maintained in an Agency Scheme (which is a sub class of Organisation Scheme)
439 1. The agency of the Agency Scheme must also be declared in a (different) Agency Scheme.
440 1. The “top-level” agency is SDMX and maintains the “top-level” Agency Scheme.
441 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.
442 1. The AgencyScheme cannot be versioned and so take a default version number of 1.0 and cannot be made “final”.
443 1. There can be only one AgencyScheme maintained by any one Agency. It has a fixed Id of AGENCIES.
444 1. The /hierarchy of Organisation is not inherited by Maintenance Agency – thus each Agency Scheme is a flat list of Maintenance Agencies.
445 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.
446
447 This supports a hierarchical structure of agencyID.
448
449 An example is shown below.
450
451 [[image:1747824123012-527.jpeg]]
452
453 **Figure 7: Example of Hierarchic Structure of Agencies**
454
455 The following organizations maintain an Agency Scheme.
456
457 * SDMX – contains Agencies AA, BB
458 * AA – contains Agencies CC, DD
459 * BB – contains Agencies CC, DD
460 * DD – Contains Agency EE
461
462 Each agency is identified by its full hierarchy excluding SDMX.
463
464 e.g. the id of EE as an agencyID is AA.DD.EE
465
466 An example of this is shown in the XML snippet below.
467
468 [[image:1747832400104-286.png]]
469
470 **Figure 8: Example Showing Use of Agency Identifiers**
471
472 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.
473
474 === 6.2.2 Universal Resource Name (URN) ===
475
476 ==== 6.2.2.1 Introduction ====
477
478 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.).
479
480 ==== 6.2.2.2 URN Structure ====
481
482 (% class="wikigeneratedid" id="HCaseRulesforURN" %)
483 //Case Rules for URN//
484
485 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.
486
487 The generic structure of the URN is as follows:
488
489 >SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobject-id(maintainedobject-version).*containerobject-id.object-id
490
491 ~* this can repeat and may not be present (see explanation below)
492
493 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.
494
495 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(.).
496
497 ==== 6.2.2.3 Explanation of the generic structure ====
498
499 In the explanation below the actual object that is the target of the URN is called the **//actual object//**.
500
501 **SDMXPrefix:** urn:sdmx:org.
502
503 **SDMX-IM package name:** sdmx.infomodel.package=
504
505 [[image:1747824123016-678.png]]
506
507 **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.
508
509 **(maintainable-object-version)** is the version of the maintainable object and is enclosed in round brackets (). It will always be present.
510
511 **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 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.
512
513 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.
514
515 For example the sequence is agency:DSDid(version).DimensionId and not agency:DSDid(version).DimensionDescriptorId.DimensionId.
516
517 **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.
518
519 ===== __**//Generic Examples of the URN Structure//**__ =====
520
521 __Actual object is a maintainable__
522
523 > SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version)
524
525 __Actual object is contained in a maintained object with no intermediate containing object__
526
527 > SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).object-id
528
529 __Actual object is contained in a maintained object with an intermediate containing object__
530
531 > SDMXPrefix.SDMX-IM package name.classname=agency
532
533 id:maintained-object-id(version).contained-object-id.object-id
534
535 __Actual object is contained in a maintained object with no intermediate containing object but the object type itself is hierarchical__
536
537 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
538
539 > SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).contained-object-id.object-id
540
541 __Actual object is contained in a maintained object with an intermediate containing object and the object type itself is hierarchical__
542
543 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
544
545 > SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).contained-object-id. contained-object-id contained-object-id.object-id
546
547 ===== __**//Concrete Examples of the URN Structure//**__ =====
548
549 The Data Structure Definition CRED_EXT_DEBT version 1.0 maintained by the top level Agency TFFS would have the URN:
550
551 > urn:sdmx:org.sdmx.infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(1.0)
552
553 The URN for a code for Argentina maintained by ISO in the code list CL_3166A2 version 1.0 would be:
554
555 > urn:sdmx:org.sdmx.infomodel.codelist.Code=ISO:CL_3166A2(1.0).AR
556
557 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:
558
559 > urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:SUBJE CT_MATTER_DOMAINS(1.0).1.2
560
561 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
562
563 CONTACT_DETAILS/CONTACT_NAME would be:
564
565 > urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataAttribut e=SDMX:CONTACT_METADATA(1.0).CONTACT_REPORT.CONTACT_DETAILS.CO NTACT_NAME
566
567 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:
568
569 > urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=TFFS.ABC:EX
570
571 TERNAL_DEBT(1.0)
572
573 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:
574
575 * **Identifiable and Nameable Artefacts**: id (in some cases this id may be hierarchic)
576 * **Maintainable Artefacts**: id, version, agencyId,
577
578 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.
579
580 === 6.2.3 Table of SDMX-IM Packages and Classes ===
581
582 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.
583
584 (% style="width:644.294px" %)
585 |(% style="width:127px" %)**Package**|(% style="width:494px" %)(((
586 **URN Classname (model classname where this is different)**
587 )))
588 |(% style="width:127px" %)base|(% style="width:494px" %)Agency
589 |(% style="width:127px" %) |(% style="width:494px" %)OrganisationUnitScheme
590 |(% style="width:127px" %) |(% style="width:494px" %)AgencyScheme
591 |(% style="width:127px" %) |(% style="width:494px" %)DataProviderScheme
592 |(% style="width:127px" %) |(% style="width:494px" %)DataConsumerScheme
593 |(% style="width:127px" %) |(% style="width:494px" %)OrganisationUnit
594 |(% style="width:127px" %) |(% style="width:494px" %)DataProvider
595 |(% style="width:127px" %) |(% style="width:494px" %)DataConsumer
596 |(% style="width:127px" %)datastructure|(% style="width:494px" %)DataStructure (DataStructureDefinition)
597 |(% style="width:127px" %) |(% style="width:494px" %)AttributeDescriptor
598 |(% style="width:127px" %) |(% style="width:494px" %)DataAttribute
599 |(% style="width:127px" %) |(% style="width:494px" %)GroupDimensionDescriptor
600 |(% style="width:127px" %) |(% style="width:494px" %)DimensionDescriptor
601 |(% style="width:127px" %) |(% style="width:494px" %)Dimension
602 |(% style="width:127px" %) |(% style="width:494px" %)MeasureDimension
603 |(% style="width:127px" %) |(% style="width:494px" %)TimeDimension
604 |(% style="width:127px" %) |(% style="width:494px" %)MeasureDescriptor
605 |(% style="width:127px" %) |(% style="width:494px" %)PrimaryMeasure
606 |(% style="width:127px" %) |(% style="width:494px" %)Dataflow (DataflowDefinition)
607 |(% style="width:127px" %)metadatastructure|(% style="width:494px" %)MetadataTarget
608 |(% style="width:127px" %) |(% style="width:494px" %)DimensionDescriptorValueTarget
609 |(% style="width:127px" %) |(% style="width:494px" %)IdentifiableObjectTarget
610 |(% style="width:127px" %) |(% style="width:494px" %)ReportPeriodTarget
611 |(% style="width:127px" %) |(% style="width:494px" %)DataSetTarget
612 |(% style="width:127px" %) |(% style="width:494px" %)ReportStructure
613 |(% style="width:127px" %) |(% style="width:494px" %)MetadataAttribute
614 |(% style="width:127px" %) |(% style="width:494px" %)(((
615 MetadataStructure
616
617 (MetadataStructureDefinition)
618 )))
619 |(% style="width:127px" %) |(% style="width:494px" %)Metadataflow (MetadataflowDefinition)
620 |(% style="width:127px" %)process|(% style="width:494px" %)Process
621 |(% style="width:127px" %) |(% style="width:494px" %)ProcessStep
622 |(% style="width:127px" %) |(% style="width:494px" %)Transition
623 |(% style="width:127px" %)registry|(% style="width:494px" %)ProvisionAgreement
624 |(% style="width:127px" %) |(% style="width:494px" %)AttachmentConstraint
625 |(% style="width:127px" %) |(% style="width:494px" %)ContentConstraint
626 |(% style="width:127px" %) |(% style="width:494px" %)Subscription
627 |(% style="width:127px" %)mapping|(% style="width:494px" %)StructureMap
628 |(% style="width:127px" %) |(% style="width:494px" %)StructureSet
629 |(% style="width:127px" %) |(% style="width:494px" %)ComponentMap
630 |(% style="width:127px" %) |(% style="width:494px" %)ConceptSchemeMap
631 |(% style="width:127px" %) |(% style="width:494px" %)OrganisationSchemeMap
632 |(% style="width:127px" %) |(% style="width:494px" %)CodelistMap
633 |(% style="width:127px" %) |(% style="width:494px" %)CategorySchemeMap
634 |(% style="width:127px" %) |(% style="width:494px" %)ReportingTaxonomyMap
635 |(% style="width:127px" %) |(% style="width:494px" %)ConceptMap
636 |(% style="width:127px" %) |(% style="width:494px" %)OrganisationMap
637 |(% style="width:127px" %) |(% style="width:494px" %)CodeMap
638 |(% style="width:127px" %) |(% style="width:494px" %)HybridCodelistMap
639 |(% style="width:127px" %) |(% style="width:494px" %)CategoryMap
640 |(% style="width:127px" %) |(% style="width:494px" %)HybridCodeMap
641 |(% style="width:127px" %) |(% style="width:494px" %)ReportingCategoryMap
642 |(% style="width:127px" %)codelist|(% style="width:494px" %)Codelist
643 |(% style="width:127px" %) |(% style="width:494px" %)HierarchicalCodelist
644 |(% style="width:127px" %) |(% style="width:494px" %)Hierarchy
645 |(% style="width:127px" %) |(% style="width:494px" %)Hierarchy
646 |(% style="width:127px" %) |(% style="width:494px" %)Code
647 |(% style="width:127px" %) |(% style="width:494px" %)HierarchicalCode
648 |(% style="width:127px" %) |(% style="width:494px" %)Level
649 |(% style="width:127px" %)categoryscheme|(% style="width:494px" %)CategoryScheme
650 |(% style="width:127px" %) |(% style="width:494px" %)Category
651 |(% style="width:127px" %) |(% style="width:494px" %)Categorisation
652 |(% style="width:127px" %) |(% style="width:494px" %)ReportingTaxonomy
653 |(% style="width:127px" %) |(% style="width:494px" %)ReportingCategory
654 |(% style="width:127px" %)conceptscheme|(% style="width:494px" %)ConceptScheme
655 |(% style="width:127px" %) |(% style="width:494px" %)Concept
656 |(% style="width:127px" %)transformation|(% style="width:494px" %)TransformationScheme
657 |(% style="width:127px" %) |(% style="width:494px" %)Transformation
658 |(% style="width:127px" %) |(% style="width:494px" %)CustomTypeScheme
659 |(% style="width:127px" %) |(% style="width:494px" %)CustomType
660 |(% style="width:127px" %) |(% style="width:494px" %)NamePersonalisationScheme
661 |(% style="width:127px" %) |(% style="width:494px" %)NamePersonalisation
662 |(% style="width:127px" %) |(% style="width:494px" %)VtlCodelistMapping
663 |(% style="width:127px" %) |(% style="width:494px" %)VtlConceptMapping
664 |(% style="width:127px" %) |(% style="width:494px" %)VtlDataflowMapping
665 |(% style="width:127px" %) |(% style="width:494px" %)VtlConceptSchemeMapping
666 |(% style="width:127px" %) |(% style="width:494px" %)RulesetScheme
667 |(% style="width:127px" %) |(% style="width:494px" %)Ruleset
668 |(% style="width:127px" %) |(% style="width:494px" %)UserDefinedOperatorScheme
669 |(% style="width:127px" %) |(% style="width:494px" %)UserDefinedOperator
670
671 **Table 2: SDMX-IM Packages and Contained Classes**
672
673 === 6.2.4 URN Identification components of SDMX objects ===
674
675 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.
676
677 ~* indicates that the object is maintainable.
678
679 Note that for brevity the URN examples omit the prefix. All URNs have the prefix
680
681 > urn:sdmx.org.sdmx.infomodel.{package}.{classname}=
682
683 (% style="width:1277.29px" %)
684 |(% style="width:269px" %)**SDMX Class**|(% style="width:453px" %)**Key attribute(s)**|(% style="width:550px" %)**Example of URN**
685 |(% style="width:269px" %)Agency|(% style="width:453px" %)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.|(% style="width:550px" %)(((
686 IMF
687 Sub agency in the IMF AGENCIES
688 IMF.SubAgency1
689 )))
690 |(% style="width:269px" %)*ConceptScheme|(% style="width:453px" %)conceptSchemeAgencyId:conceptSchemeId(ve rsion)|(% style="width:550px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0)
691 |(% style="width:269px" %)Concept|(% style="width:453px" %)conceptSchemeAgencyId:
692 conceptSchemeId(version).conceptId|(% style="width:550px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0).FREQ
693 |(% style="width:269px" %)*Codelist|(% style="width:453px" %)codeListAgencyId:codeListId(version)|(% style="width:550px" %)SDMX:CL_FREQ(1.0)
694 |(% style="width:269px" %)Code|(% style="width:453px" %)codeListAgencyId:codelistId(version).codeId|(% style="width:550px" %)SDMX:CL_FREQ(1.0).Q
695 |(% style="width:269px" %)(((
696 *Hierarchical Codelist
697 )))|(% style="width:453px" %)hierachicalCodelistAgencyId:
698 hierarchicalCodelistId(version)|(% style="width:550px" %)(((
699 UNESCO:CL_EXP_SOURCE(1.0(% style="background-color:transparent" %))
700 )))
701 |(% style="width:269px" %)Hierarchy|(% style="width:453px" %)(((
702 hierachicalcodeListAgencyId:
703 hierarchicalcodelistId(version).Hierarchy
704 )))|(% style="width:550px" %)UNESCO:CL_EXP_SOURCE(1.0).
705 H-C-GOV
706 |(% style="width:269px" %)Level|(% style="width:453px" %)(((
707 hierachicalcodeListAgencyId:
708 hierarchicalcodelistId(version).Hierarchy.Level
709 )))|(% style="width:550px" %)(((
710 ESTAT:HCL_REGION(1.0).H_1.COUNTRY
711 )))
712 |(% style="width:269px" %)HierarchicalCode|(% style="width:453px" %)hierachicalCodeListAgencyId: hierarchicalcodelistId(version).hierarchy.hierarc hicalCode|(% style="width:550px" %)UNESCO:CL_EXP_SOURCE(1.0). H-C-GOV.GOV_CODE1
713 |(% style="width:269px" %)*DataStructure|(% style="width:453px" %)dataStructureDefintitionAgencyId: dataStructureDefintitionId(version)|(% style="width:550px" %)TFFS:EXT_DEBT(1.0)
714 |(% style="width:269px" %)(((
715 Dimension
716 Descriptor
717 Measure
718 Descriptor
719 Attribute
720 Descriptor
721 )))|(% style="width:453px" %)(((
722 dataStructureDefinitionAgencyId: dataStructureDefinitionId(version).
723 componentListId
724 where the componentListId is the name of the class (there is only one occurrence of each in the Data Structure Definition)
725 )))|(% style="width:550px" %)(((
726 TFFS:EXT_DEBT(1.0).DimensionDescriptor
727
728 TFFS:EXT_DEBT(1.0).MeasureDescriptor
729
730 TFFS:EXT_DEBT(1.0).AttributeDescriptor
731 )))
732 |(% style="width:269px" %)(((
733 GroupDimension
734 Descriptor
735 )))|(% style="width:453px" %)(((
736 dataStructureDefinitionAgencyId: dataStructureDefinitionId(version).
737 groupDimensionDescriptorId
738 )))|(% style="width:550px" %)TFFS:EXT_DEBT(1.0).SIBLING
739 |(% style="width:269px" %)Dimension|(% style="width:453px" %)(((
740 dataStructureDefinitionAgencyId: dataStructureDefinition (version).
741 dimensionId
742 )))|(% style="width:550px" %)TFFS:EXT_DEBT(1.0).FREQ
743 |(% style="width:269px" %)TimeDimension|(% style="width:453px" %)(((
744 dataStructureDefinitionAgencyId: dataStructureDefinition (version).
745 timeDimensionId
746 )))|(% style="width:550px" %)TFFS:EXT_DEBT(1.0).TIME_PERIOD
747 |(% style="width:269px" %)Measure Dimension|(% style="width:453px" %)dataStructureDefinitionAgencyId: dataStructureDefinition (version).
748 measureDimensionId|(% style="width:550px" %)TFFS:EXT_DEBT(1.0).STOCK_FLOW
749 |(% style="width:269px" %)DataAttrribute|(% style="width:453px" %)dataStructureDefinitionAgencyId: dataStructureDefinition (version). dataAttributeId|(% style="width:550px" %)TFFS:EXT_DEBT(1.0).OBS_STATUS
750 |(% style="width:269px" %)PrimaryMeasure|(% style="width:453px" %)(((
751 dataStructureDefinitionAgencyId: dataStructureDefinition (version).
752 primaryMeasureId
753 )))|(% style="width:550px" %)TFFS:EXT_DEBT(1.0).OBS_VALUE
754 |(% style="width:269px" %)(((
755 *Category Scheme
756 )))|(% style="width:453px" %)categorySchemeAgencyId:
757 categorySchemeId(version)|(% style="width:550px" %)IMF:SDDS(1.0)
758 |(% style="width:269px" %)Category|(% style="width:453px" %)categorySchemeAgencyId:
759 categorySchemeId(version).
760 categoryId.categoryId categoryId.categoryId etc.|(% style="width:550px" %)(((
761 IMF:SDDS(1.0):
762 level_1_category.level_2_category …
763 )))
764 |(% style="width:269px" %)(((
765 *Reporting Taxonomy
766 )))|(% style="width:453px" %)reportingTaxonomyAgencyId: reportingTaxonomyId(version)|(% style="width:550px" %) IMF:REP_1(1.0)
767 |(% style="width:269px" %)ReportingCategory|(% style="width:453px" %)reportingTaxonomyAgencyId: reportingTaxonomyId(version) reportingcategoryId.reportingcategoryId|(% style="width:550px" %)(((
768 IMF:REP_1(1.0):
769 level_1_repcategory.level_2_repcategory …
770 )))
771 |(% style="width:269px" %)*Categorisation|(% style="width:453px" %)categorisationAgencyId: categorisationId(version)|(% style="width:550px" %)IMF:cat001(1.0)
772 |(% style="width:269px" %)(((
773 *Organisation Unit Scheme
774 )))|(% style="width:453px" %)organisationUnitSchemeAgencyId: organisationUnitSchemeId(version)|(% style="width:550px" %)ECB:ORGANISATIONS(1.0)
775 |(% style="width:269px" %)Organisation Unit|(% style="width:453px" %)organisationUnitSchemeAgencyId: organisationUnitSchemeId(version). organisationUnitId|(% style="width:550px" %)ECB:ORGANISATIONS(1.0).1F
776 |(% style="width:269px" %)*AgencyScheme|(% style="width:453px" %)agencySchemeAgencyId: agencySchemeId(version)|(% style="width:550px" %)ECB:AGENCIES(1.0)
777
778 (% style="width:1274.29px" %)
779 |(% style="width:262px" %)Agency|(% style="width:369px" %)agencySchemeAgencyId: agencySchemeId(version). agencyId|(% style="width:535px" %)ECB:AGENCY(1.0).AA
780 |(% style="width:262px" %)(((
781 *DataProvider Scheme
782 )))|(% style="width:369px" %)dataProviderSchemeAgencyId: dataProviderSchemeId(version)|(% style="width:535px" %)SDMX:DATA_PROVIDERS(1.0)
783 |(% style="width:262px" %)DataProvider|(% style="width:369px" %)dataProviderSchemeAgencyId: dataProviderSchemeId(version) dataProviderId|(% style="width:535px" %)SDMX:DATA_PROVIDERS(1.0).PROVIDER_1
784 |(% style="width:262px" %)(((
785 *DataConsumer Scheme
786 )))|(% style="width:369px" %)dataConsumerSchemeAgencyId: dataConsumerSchemeId(version)|(% style="width:535px" %)SDMX:DATA_CONSUMERS(1.0)
787 |(% style="width:262px" %)Data Consumer|(% style="width:369px" %)dataConsumerSchemeAgencyId: dataConsumerSchemeId(version) dataConsumerId|(% style="width:535px" %)SDMX:DATA_CONSUMERS(1.0).CONSUMER_1
788 |(% style="width:262px" %)(((
789 *Metadata Structure
790 )))|(% style="width:369px" %)MSDAgencyId:MSDId(version)|(% style="width:535px" %)IMF:SDDS_MSD(1.0)
791 |(% style="width:262px" %)MetadataTarget|(% style="width:369px" %)(((
792 MSDAgencyId:
793 MSDId(version).metadataTargetId
794 )))|(% style="width:535px" %)IMF:SDDS_MSD(1.0).AGENCY
795 |(% style="width:262px" %)(((
796 Dimension
797 DescriptorValues
798 Target
799 )))|(% style="width:369px" %)(((
800 MSDAgencyId: MSDId(version).
801 metadataTargetId.keyDescriptorValueTargetId
802 )))|(% style="width:535px" %)IMF:SDDS_MSD(1.0).AGENCY.KEY
803 |(% style="width:262px" %)Identifiable Object Target|(% style="width:369px" %)(((
804 MSDAgencyId: MSDId(version).metadataTargetId.identifiableObjectTargetId
805 )))|(% style="width:535px" %)IMF:SDDS_MSD(1.0).AGENCY.STR-OBJECT
806 |(% style="width:262px" %)DataSetTarget|(% style="width:369px" %)(((
807 MSDAgencyId:
808 MSDId(version).metadataTargetId.dataSetTargetId
809 )))|(% style="width:535px" %)IMF:SDDS_MSD(1.0).AGENCY.D1101
810 |(% style="width:262px" %)PeportPeriod Target|(% style="width:369px" %)(((
811 MSDAgencyId: MSDId(version).metadataTargetId.reportPeriodTargetId
812 )))|(% style="width:535px" %)IMF:SDDS_MSD(1.0).AGENCY.REP_PER
813
814 (% style="width:1277.29px" %)
815 |(% style="width:270px" %)(((
816 ReportStructure
817 )))|(% style="width:454px" %)(((
818 MSDAgencyId: MSDId(version).reportStructureId
819 )))|(% style="width:549px" %)IMF:SDDS_MSD(1.0).AGENCY_REPORT
820 |(% style="width:270px" %)(((
821 Metadata Attribute
822 )))|(% style="width:454px" %)(((
823 MSDAgencyId: MSDId(version).reportStructureId.metadataattri buteID
824 )))|(% style="width:549px" %)IMF:SDDS_MSD(1.0).AGENCY_REPORT.COMPILATION
825 |(% style="width:270px" %)*Dataflow|(% style="width:454px" %)dataflowAgencyId: dataflowId(version)|(% style="width:549px" %)TFFS:CRED_EXT_DEBT(1.0)
826 |(% style="width:270px" %)*Provision Agreement|(% style="width:454px" %)(((
827 provisionAgreementAgencyId:provisionAgreem entId(version)
828 )))|(% style="width:549px" %)(((
829 TFFS:CRED_EXT_DEBT_AB(1.0)
830 )))
831 |(% style="width:270px" %)(((
832 *Content Constraint
833 )))|(% style="width:454px" %)constraintAgencyId:ContentConstraintId(versio n)|(% style="width:549px" %)TFFS:CREDITOR_DATA_CONTENT(1.0)
834 |(% style="width:270px" %)(((
835 *Attachment Constraint
836 )))|(% style="width:454px" %)(((
837 constraintAgencyId:
838
839 attachmentConstraintId(version)
840 )))|(% style="width:549px" %)TFFS:CREDITOR_DATA_ATTACHMENT_CONSTRAINT_ONE(1.0)
841 |(% style="width:270px" %)*Metadataflow|(% style="width:454px" %)metadataflowAgencyId: metadataflowId(version)|(% style="width:549px" %)IMF:SDDS_FLOW(1.0)
842 |(% style="width:270px" %)*StructureSet|(% style="width:454px" %)structureSetAgencyId: structureSetId(version)|(% style="width:549px" %)SDMX:BOP_STRUCTURES(1.0)
843 |(% style="width:270px" %)StructureMap|(% style="width:454px" %)structureSetAgencyId: structureSetId(version). structureMapId|(% style="width:549px" %)SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2
844 |(% style="width:270px" %)Component Map|(% style="width:454px" %)(((
845 structureSetAgencyId: structureSetId(version).
846
847 structureMapId. componentMapId
848 )))|(% style="width:549px" %)SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2. REFAREA_REPCOUNTRY
849 |(% style="width:270px" %)CodelistMap|(% style="width:454px" %)structureSetAgencyId: structureSetId(version). codelistMapId|(% style="width:549px" %)SDMX:BOP_STRUCTURES(1.0).CLREFAREA_CLREPCOUNTRY
850 |(% style="width:270px" %)CodeMap|(% style="width:454px" %)structureSetAgencyId: structureSetId(version).
851 codeListMapId.
852 codeMapId|(% style="width:549px" %)SDMX:BOP_STRUCTURES(1.0).CLREFAREA_CLREPCOUNTRY. DE_GER
853
854 (% style="width:1279.29px" %)
855 |(% style="width:271px" %)(((
856 CategorySchemeMap
857 )))|(% style="width:453px" %)structureSetAgencyId: structureSetId(version). categorySchemeMapId|(% style="width:551px" %)SDMX:BOP_STRUCTURES(1.0).SDMX_EUROSTAT
858 |(% style="width:271px" %)CategoryMap|(% style="width:453px" %)structureSetAgencyId: structureSetId(version). categorySchemeMapId. categoryMapId|(% style="width:551px" %)SDMX:BOP_STRUCTURES(1.0).SDMX_EUROSTAT.TOURISM_MAP
859 |(% style="width:271px" %)Organisation SchemeMap|(% style="width:453px" %)structureSetAgencyId: structureSetId(version). organisationSchemeMapId|(% style="width:551px" %)SDMX:BOP_STRUCTURES(1.0).DATA_PROVIDER_MAP
860 |(% style="width:271px" %)Organisation Map|(% style="width:453px" %)structureSetAgencyId: structureSetId(version). organisationSchemeMapId. organisationMapId|(% style="width:551px" %)SDMX:BOP_STRUCTURES(1.0).DATA_PROVIDER_MAP.IMF_1C0
861 |(% style="width:271px" %)(((
862 Concept
863
864 SchemeMap
865 )))|(% style="width:453px" %)structureSetAgencyId: structureSetId(version). conceptSchemeMapId|(% style="width:551px" %)SDMX:BOP_STRUCTURES(1.0).SDMX_OECD
866 |(% style="width:271px" %)ConceptMap|(% style="width:453px" %)(((
867 structureSetAgencyId: structureSetId(version). conceptSchemeMapId.
868 conceptMapId
869 )))|(% style="width:551px" %)SDMX:BOP_STRUCTURES(1.0).SDMX_OECD.COVERAGE_AVAI LABILITY
870 |(% style="width:271px" %)(((
871 ReportingTaxonomyMap
872 )))|(% style="width:453px" %)structureSetAgencyId: structureSetId(version). reportingTaxonomyMapId|(% style="width:551px" %)SDMX:BOP_STRUCTURES(1.0).TAXMAP
873 |(% style="width:271px" %)(((
874 ReportingCategoryMap
875 )))|(% style="width:453px" %)(((
876 structureSetAgencyId: structureSetId(version).
877 reportngCategoryId
878 )))|(% style="width:551px" %)SDMX:BOP_STRUCTURES(1.0).TAXMAP.TOPCAT
879
880 (% style="width:1282.29px" %)
881 |(% style="width:272px" %)(((
882 HybridCodelistMap
883 )))|(% style="width:450px" %)structureSetAgencyId: structureSetId(version).
884 hybridCodelistMapId.|(% style="width:557px" %)SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP
885 |(% style="width:272px" %)HybridCodeMap|(% style="width:450px" %)structureSetAgencyId: structureSetId(version). hybridCodelistMapId. hybridCodeMapId|(% style="width:557px" %)SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP.CO DEMAP1
886 |(% style="width:272px" %)*Process|(% style="width:450px" %)processAgencyId: processId{version]|(% style="width:557px" %)BIS:PROCESS1(1.0)
887 |(% style="width:272px" %)ProcessStep|(% style="width:450px" %)(((
888 processAgencyId: processId(version).
889 processStepId
890 )))|(% style="width:557px" %)BIS:PROCESS1(1.0).STEP1
891 |(% style="width:272px" %)Transition|(% style="width:450px" %)(((
892 processAgencyId: processId(version).
893 processStepId transitionId
894 )))|(% style="width:557px" %)BIS:PROCESS1(1.0).STEP1.TRANSITION1
895 |(% style="width:272px" %)Subscription|(% style="width:450px" %)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.|(% style="width:557px" %)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.
896 |(% style="width:272px" %)(((
897 *Transformation Scheme
898 )))|(% style="width:450px" %)transformationSchemeAgencyId transformationSchemeId(version)|(% style="width:557px" %)ECB: TRANSFORMATION_SCHEME(1.0)
899 |(% style="width:272px" %)Transformation|(% style="width:450px" %)(((
900 transformationSchemeAgencyId transformationSchemeId(version)
901 transformationId
902 )))|(% style="width:557px" %)ECB:TRANSFORMATION_SCHEME(1.0).TRANS_1
903 |(% style="width:272px" %)CustomType Scheme|(% style="width:450px" %)customTypeSchemeAgencyId customTypeSchemeId(version)|(% style="width:557px" %)ECB:CUSTOM_TYPE_SCHEME(1.0)
904
905 (% style="width:1281.29px" %)
906 |(% style="width:275px" %)CustomType|(% style="width:450px" %)customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|(% style="width:552px" %)ECB: CUSTOM_TYPE_SCHEME(1.0).CUSTOM_TYPE_1
907 |(% style="width:275px" %)(((
908 Name
909 Personalisation
910 Scheme
911 )))|(% style="width:450px" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|(% style="width:552px" %)ECB:PSN_SCHEME(1.0)
912 |(% style="width:275px" %)(((
913 Name
914 Personalisation
915 )))|(% style="width:450px" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)
916 namePersonalisationId|(% style="width:552px" %)ECB:PSN_SCHEME(1.0).PSN1234
917 |(% style="width:275px" %)VtlMapping Scheme|(% style="width:450px" %)vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|(% style="width:552px" %)ECB:CLIST_MP(2.0)
918 |(% style="width:275px" %)VtlCodelist Mapping|(% style="width:450px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|(% style="width:552px" %)ECB:CLIST_MP(2.0).ABZ
919 |(% style="width:275px" %)VtlConcept Mapping|(% style="width:450px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|(% style="width:552px" %)ECB:CLIST_MP(1.0).XYA
920 |(% style="width:275px" %)VtlDataflow Mapping|(% style="width:450px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|(% style="width:552px" %)ECB:CLIST_MP(1.0).MOQ
921 |(% style="width:275px" %)(((
922 VtlConcept
923
924 SchemeMapping
925 )))|(% style="width:450px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptSchemeId|(% style="width:552px" %)ECB:CLIST_MP(1.0).Z11
926 |(% style="width:275px" %)RulesetScheme|(% style="width:450px" %)rulesetSchemeAgencyId rulesetSchemeId(version)|(% style="width:552px" %)ECB:RULESET_23(1.0)
927 |(% style="width:275px" %)Ruleset|(% style="width:450px" %)rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|(% style="width:552px" %)ECB:RULESET_23(1.0).SET111
928 |(% style="width:275px" %)(((
929 UserDefinedOperatorScheme
930 )))|(% style="width:450px" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|(% style="width:552px" %)ECB:OS_CALC(1.2)
931 |(% style="width:275px" %)UserDefined Operator|(% style="width:450px" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|(% style="width:552px" %)ECB:OS_CALC(1.2).OS267
932
933 **Table 3: Table of identification components for SDMX Identifiable Artefacts**
934
935 = 7 Implementation Notes =
936
937 == 7.1 Structural Definition Metadata ==
938
939 === 7.1.1 Introduction ===
940
941 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.)
942
943 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.
944
945 Structural metadata items
946
947 * may only be modified by the maintenance agency which created them
948 * may only be deleted by the agency which created them
949 * may not be deleted if they are referenced from other constructs in the Registry
950
951 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.
952
953 The following table lists the Maintainable Artefacts.
954
955 (% style="width:640.294px" %)
956 |(% colspan="2" rowspan="1" style="width:186px" %)**Maintainable Artefacts**|(% style="width:206px" %)**Content**
957 |(% style="width:171px" %)**Abstract Class**|(% style="width:232px" %)**Concrete Class**|(% style="width:206px" %)
958 |(% style="width:171px" %)Item Scheme|(% style="width:232px" %)Codelist|(% style="width:206px" %)Code
959 |(% style="width:171px" %) |(% style="width:232px" %)Concept Scheme|(% style="width:206px" %)Concept
960 |(% style="width:171px" %) |(% style="width:232px" %)Category Scheme|(% style="width:206px" %)Category
961 |(% style="width:171px" %) |(% style="width:232px" %)Organisation Unit Scheme|(% style="width:206px" %)Organisation Unit
962 |(% style="width:171px" %) |(% style="width:232px" %)Agency Scheme|(% style="width:206px" %)Agency
963 |(% style="width:171px" %) |(% style="width:232px" %)Data Provider Scheme|(% style="width:206px" %)Data Provider
964 |(% style="width:171px" %) |(% style="width:232px" %)Data Consumer Scheme|(% style="width:206px" %)Data Consumer
965 |(% style="width:171px" %) |(% style="width:232px" %)Reporting Taxonomy|(% style="width:206px" %)Reporting Category
966 |(% style="width:171px" %) |(% style="width:232px" %)Transformation Scheme|(% style="width:206px" %)Transformation
967 |(% style="width:171px" %) |(% style="width:232px" %)Custom Type Scheme|(% style="width:206px" %)Custom Type
968 |(% style="width:171px" %) |(% style="width:232px" %)Name Personalisation Scheme|(% style="width:206px" %)Name Personalisation
969 |(% style="width:171px" %) |(% style="width:232px" %)Vtl Mapping Scheme|(% style="width:206px" %)Vtl Codelist Mapping
970 |(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)Vtl Dataflow Mapping
971 |(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)Vtl Concept Scheme Mapping
972 |(% style="width:171px" %) |(% style="width:232px" %)Ruleset Scheme|(% style="width:206px" %)Ruleset
973 |(% style="width:171px" %) |(% style="width:232px" %)User Defined Operator Scheme|(% style="width:206px" %)User Defined Operator
974 |(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)User Defined Operator
975 |(% style="width:171px" %)Structure|(% style="width:232px" %)Data Structure Definition|(% style="width:206px" %)(((
976 Dimension Descriptor
977 Group Dimension
978 Descriptor
979 Dimension
980 Measure Dimension
981 Time Dimension
982 Attribute Descriptor
983 Data Attribute
984 Measure Descriptor
985 Primary Measure
986 )))
987 |(% style="width:171px" %) |(% style="width:232px" %)Metadata Structure Definition|(% style="width:206px" %)(((
988 Metadata Target, Dimension Descriptor
989 Values Target Identifiable
990 Object Target
991 Report Period Target
992 Data SetTarget
993 Report Structure
994 Metadata Attribute
995 )))
996 |(% style="width:171px" %)Structure Usage|(% style="width:232px" %)Dataflow Definition|(% style="width:206px" %)
997 |(% style="width:171px" %) |(% style="width:232px" %)Metadataflow Definition|(% style="width:206px" %)
998 |(% style="width:171px" %)None|(% style="width:232px" %)Process|(% style="width:206px" %)Process Step
999 |(% style="width:171px" %)None|(% style="width:232px" %)Structure Set|(% style="width:206px" %)(((
1000 Component Map
1001 Concept Scheme Map
1002 Codelist Map
1003 Category Scheme Map
1004 Reporting Taxonomy Map
1005 Organisation Scheme Map
1006 Concept Map
1007 Code Map
1008 Category Map
1009 Organisation Map
1010 Reporting Category Map
1011 Hybrid Codelist Map
1012 Hybrid Code Map
1013 )))
1014 |(% style="width:171px" %)None|(% style="width:232px" %)Provision Agreement|(% style="width:206px" %)
1015 |(% style="width:171px" %)None|(% style="width:232px" %)Hierarchical Codelist|(% style="width:206px" %)(((
1016 Hierarchy
1017 Hierarchical Code
1018 )))
1019
1020 **able 4: Table of Maintainable Artefacts for Structural Definition Metadata**
1021
1022 === 7.1.2 Item Scheme, Structure ===
1023
1024 The artefacts included in the structural definitions are:
1025
1026 * All types of Item Scheme (Codelist, Concept Scheme, Category Scheme, Organisation Scheme - Agency Scheme, Data Provider Scheme, Data Consumer Scheme, Organisation Unit Scheme)
1027 * All types of Structure (Data Structure Definition, Metadata Structure Definition)
1028 * All types of Structure Usage (Dataflow Definition, Metadataflow Definition)
1029
1030 === 7.1.3 Structure Usage ===
1031
1032 ==== 7.1.3.1 Structure Usage: Basic Concepts ====
1033
1034 The Structure Usage defines, in its concrete classes of Dataflow Definition and
1035
1036 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.
1037
1038 ==== 7.1.3.2 Structure Usage Schematic ====
1039
1040 [[image:1747824123018-658.jpeg]]
1041
1042 **Figure 9: Schematic of Linking the Data and Metadata Flows to Categories and Structure Definitions**
1043
1044 ==== 7.1.3.3 Structure Usage Model ====
1045
1046 [[image:1747829078194-749.png]]
1047
1048 **Figure 10: SDMX-IM of links from Structure Usage to Category**
1049
1050 In addition to the maintenance of the Dataflow Definition and the Metadataflow Definition the following links must be maintained in the registry:
1051
1052 * Dataflow Definition to Data Structure Definition
1053 * Metadataflow Definition to Metadata Structure Definition
1054
1055 The following links may be created by means of a Categorisation
1056
1057 * Categorisation to Dataflow Definition and Category
1058 * Categorisation to Metadataflow Definition and Category
1059
1060 == 7.2 Data and Metadata Provisioning ==
1061
1062 === 7.2.1 Provisioning Agreement: Basic concepts ===
1063
1064 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.
1065
1066 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.
1067
1068 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.
1069
1070 === 7.2.2 Provisioning Agreement Model – pull use case ===
1071
1072 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.
1073
1074 [[image:1747829109466-595.png]]
1075
1076 **Figure 11: SDMX-IM of the Data Provider**
1077
1078 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
1079
1080 [[image:1747824123019-181.jpeg]]
1081
1082 **Figure 12: Schematic of the Provision Agreement**
1083
1084 The diagram below is a logical representation of the data required in order to maintain Provision Agreements.
1085
1086 [[image:1747829139951-378.png]]
1087
1088 (% class="wikigeneratedid" id="HFigure13:LogicalclassdiagramoftheinformationcontainedintheProvisionAgreement" %)
1089 **Figure 13: Logical class diagram of the information contained in the Provision Agreement**
1090
1091 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.
1092
1093 == 7.3 Data and Metadata Constraints ==
1094
1095 === 7.3.1 Data and Metadata Constraints: Basic Concepts ===
1096
1097 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.
1098
1099 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.
1100
1101 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.
1102
1103 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.
1104
1105 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.
1106
1107 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).
1108
1109 === 7.3.2 Data and Metadata Constraints: Schematic ===
1110
1111 [[image:1747824123021-978.jpeg]]
1112
1113 **Figure 14: Schematic of the Constraint and the Artefacts that can be Constrained**
1114
1115 === 7.3.3 Data and Metadata Constraints: Model ===
1116
1117 [[image:1747829204737-370.png]]
1118
1119 **Figure 15: Logical class diagram showing inheritance between and reference to constrainable artifacts**
1120
1121 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.
1122
1123 The content of the Constraint can be found in the SDMX Information Model document.
1124
1125 == 7.4 Data and Metadata Registration ==
1126
1127 === 7.4.1 Basic Concepts ===
1128
1129 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.
1130
1131 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.
1132
1133 The same mechanism can be used to report or make available a metadata set.
1134
1135 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.
1136
1137 === 7.4.2 The Registration Request ===
1138
1139 ==== 7.4.2.1 Registration Request Schematic ====
1140
1141 [[image:1747824123025-411.jpeg]]
1142
1143 **Figure 16: Schematic of the Objects Concerned with Registration**
1144
1145 ==== 7.4.2.2 Registration Request Model ====
1146
1147 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:
1148
1149 * validFrom
1150 * validTo
1151 * lastUpdated
1152
1153 The last updated date is useful during the discovery process to make sure the client knows which data is freshest.
1154
1155 The Registration has an action attribute which takes one of the following values:
1156
1157 (% style="width:798.294px" %)
1158 |(% style="width:212px" %)**Action Attribute Value**|(% style="width:582px" %)**Behaviour**
1159 |(% style="width:212px" %)Append|(% style="width:582px" %)Add this Registration to the registry
1160 |(% style="width:212px" %)Replace|(% style="width:582px" %)Replace the existing Registration with identified by the id in the Registration of the Submit Registration Request
1161 |(% style="width:212px" %)Delete|(% style="width:582px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
1162
1163 [[image:1747829290890-122.png]]
1164
1165 **Figure 17: Logical Class Diagram of Registration of Data and Metadata**
1166
1167 The Query Datasource is an abstract class that represents a data source which can understand an SDMX-ML query (SOAPDatasource) or RESTful query
1168
1169 (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.
1170
1171 A Simple Datasource is used to reference a physical SDMX-ML file that is available at a URL.
1172
1173 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.
1174
1175 The Registration includes attributes that state how a Simple Datasource is to be indexed when registered. The Registry registration process must act as follows.
1176
1177 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.
1178
1179 (% style="width:860.294px" %)
1180 |(% style="width:185px" %)**Indexing Required**|(% style="width:672px" %)**Registration Process Activity**
1181 |(% style="width:185px" %)indexTimeSeries|(% style="width:672px" %)Extract all the series keys and create a KeySet(s) Constraint.
1182 |(% style="width:185px" %)indexDataSet|(% style="width:672px" %)(((
1183 Extract all the codes and other content of the Key value of the Series Key in a Data Set and create one or more Cube Regions containing Member Selections of Dimension Components of the Constraints model in the SDMX-IM, and the associated Selection Value.
1184 )))
1185 |(% style="width:185px" %)indexReportingPeriod|(% style="width:672px" %)(((
1186 This applies only to a registered dataset.
1187 Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint.
1188 )))
1189 |(% style="width:185px" %)indexAttributes|(% style="width:672px" %)(((
1190 **Data Set**
1191 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
1192 **Metadata Set**
1193 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.
1194 )))
1195
1196 Constraints that specify the contents of a Query Datasource are submitted to the Registry in a Submit Structure Request.
1197
1198 The Registration must reference the Provision Agreement to which it relates.
1199
1200 === 7.4.3 Registration Response ===
1201
1202 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 “Success”, “Warning” or “Failure”.
1203
1204 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.
1205
1206 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:
1207
1208 [[image:1747829477882-750.png]]
1209
1210 **Figure 18: Logical class diagram showing the registration response**
1211
1212 == 7.5 Subscription and Notification Service ==
1213
1214 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.
1215
1216 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.
1217
1218 When a registry/repository artefact is modified, any subscriptions which are observing the object are activated, and either an email or HTTP POST is instigated to report details of the changes to the user specified in the subscription. This is called a “notification”.
1219
1220 === 7.5.1Subscription Logical Class Diagram ===
1221
1222 [[image:1747829554603-150.png]]
1223
1224 **Figure 19: Logical Class Diagram of the Subscription**
1225
1226 === 7.5.2 Subscription Information ===
1227
1228 Regardless of the type of registry/repository events being observed, a subscription always contains:
1229
1230 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.
1231 1. A user-defined identifier which is returned in the response to the subscription request. This helps with asynchronous processing and is NOT stored in the Registry.
1232 1. A validity period which defines both when the subscription becomes active and expires. The subscriber may be sent a notification on expiration of the subscription.
1233 1. A selector which specifies which type of events are of interest. The set of event types is:
1234
1235 (% style="width:1031.29px" %)
1236 |(% style="width:319px" %)**Event Type**|(% style="width:678px" %)**Comment**
1237 |(% style="width:319px" %)STRUCTURAL_REPOSITORY_EVENTS|(% style="width:678px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1238 |(% style="width:319px" %)DATA_REGISTRATION_EVENTS|(% style="width:678px" %)Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
1239 |(% style="width:319px" %)METADATA_REGISTRATION_EVENTS|(% style="width:678px" %)Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
1240 |(% style="width:319px" %)ALL_EVENTS|(% style="width:678px" %)All events of the specified EventType
1241
1242 === 7.5.3 Wildcard Facility ===
1243
1244 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:
1245
1246 * agencyID
1247 * id
1248 * version
1249
1250 Examples of wildcarded identifier components for an identified object type of Codelist are shown below.
1251
1252 //AgencyID = %
1253 Id = %
1254 Version = %//
1255
1256 This subscribes to all Codelists of all versions for all agencies.
1257
1258 //AgencyID = AGENCY1
1259 Id = CODELIST1
1260 Version = %//
1261
1262 This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1263
1264 //AGENCY1
1265 AgencyID = AGENCY1
1266 Id = %
1267 Version = %//
1268
1269 This subscribes to all versions of all Codelist objects maintained by the agency
1270
1271 //AGENCY1
1272 AgencyID = %
1273 Id = CODELIST1
1274 Version = %//
1275
1276 This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1277
1278 //AGENCY1//
1279
1280 Note that if the subscription is to the latest version then this can be achieved by the * character
1281
1282 //i.e. Version = *//
1283
1284 Note that a subscription using the URN mechanism cannot use wildcard characters.
1285
1286 === 7.5.4 Structural Repository Events ===
1287
1288 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.
1289
1290 === 7.5.5 Registration Events ===
1291
1292 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:
1293
1294 (% style="width:974.294px" %)
1295 |(% style="width:295px" %)**Selector**|(% style="width:677px" %)**Comment**
1296 |(% style="width:295px" %)DataProvider|(% style="width:677px" %)Any datasets or metadata sets registered by the specified data provider will activate the notification.
1297 |(% style="width:295px" %)ProvisionAgreement|(% style="width:677px" %)Any datasets or metadata sets registered for the provision agreement will activate the notification.
1298 |(% style="width:295px" %)Dataflow (&Metadataflow)|(% style="width:677px" %)Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
1299 |(% style="width:295px" %)DataStructureDefinition & MetadataStructureDefinition|(% style="width:677px" %)Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will activate the notification.
1300 |(% style="width:295px" %)Category|(% style="width:677px" %)Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category.
1301
1302 The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration.
1303
1304 == 7.6 Notification ==
1305
1306 === 7.6.1 Logical Class Diagram ===
1307
1308 [[image:1747829675568-610.png]]
1309
1310 (% class="wikigeneratedid" id="HFigure20:LogicalClassDiagramoftheNotification" %)
1311 **Figure 20: Logical Class Diagram of the Notification**
1312
1313 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.
1314
1315 Regardless of the registry component that caused the event to be triggered, the following common information is in the message:
1316
1317 * Date and time that the event occurred
1318 * The URN of the artefact that caused the event
1319 * The URN of the Subscription that produced the notification
1320 * Event Action: Add, Replace, or Delete.
1321
1322 Additionally, supplementary information may be contained in the notification as detailed below.
1323
1324 === 7.6.2 Structural Event Component ===
1325
1326 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).
1327
1328 === 7.6.3 Registration Event Component ===
1329
1330 The notification will contain the Registration.