Last modified by Artur on 2025/09/30 13:28

From version 18.1
edited by Helena
on 2025/06/08 16:26
Change comment: There is no comment for this version
To version 21.9
edited by Helena
on 2025/06/08 16:33
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,0 @@
1 -1 Introduction
Content
... ... @@ -1,15 +1,16 @@
1 +{{box title="**Contents**"}}
2 +{{toc/}}
3 +{{/box}}
4 +
1 1  **Revision History**
2 2  
3 -:
7 +(% style="width:824.835px" %)
8 +|(% style="width:184px" %)**Revision**|(% style="width:195px" %)**Date**|(% style="width:442px" %)**Contents**
9 +|(% style="width:184px" %)DRAFT 1.0|(% style="width:195px" %)December 2024|(% style="width:442px" %)Draft release updated for SDMX 3.1 for public consultation
10 +|(% style="width:184px" %)1.0|(% style="width:195px" %)May 2025|(% style="width:442px" %)Public release for SDMX 3.1
4 4  
5 -(((
6 -|**Revision**|**Date**|**Contents**
7 -|DRAFT 1.0|December 2024|Draft release updated for SDMX 3.1 for public consultation
8 -|1.0|May 2025|Public release for SDMX 3.1
9 -)))
12 += 1 Introduction =
10 10  
11 -= {{id name="_Toc90780"/}}1 Introduction =
12 -
13 13  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:
14 14  
15 15  * the availability of an abstract information model capable of supporting time series and cross-sectional data, structural metadata, and reference metadata (SDMX-IM)
... ... @@ -30,15 +30,13 @@
30 30  
31 31  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:
32 32  
33 -• structural metadata repository
34 +* structural metadata repository
35 +* data and metadata registration
36 +* query
34 34  
35 -• data and metadata registration
36 -
37 -• query
38 -
39 39  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.
40 40  
41 -= {{id name="_Toc90781"/}}2 Scope and Normative Status =
40 += 2 Scope and Normative Status =
42 42  
43 43  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.
44 44  
... ... @@ -55,9 +55,9 @@
55 55  
56 56  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.
57 57  
58 -= {{id name="_Toc90782"/}}3 Scope of the SDMX Registry/Repository =
57 += 3 Scope of the SDMX Registry/Repository =
59 59  
60 -=== {{id name="_Toc90783"/}}3.1 Objective ===
59 +== 3.1 Objective ==
61 61  
62 62  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:
63 63  
... ... @@ -64,7 +64,7 @@
64 64  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.
65 65  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.
66 66  
67 -=== {{id name="_Toc90784"/}}3.2 Structural Metadata ===
66 +== 3.2 Structural Metadata ==
68 68  
69 69  Setting up structural metadata and the exchange context (referred to as “data provisioning”) involves the following steps for maintenance agencies:
70 70  
... ... @@ -90,7 +90,7 @@
90 90  
91 91  In that context, the term “Metadata” refers to reference metadata.
92 92  
93 -=== {{id name="_Toc90785"/}}3.3 Registration ===
92 +== 3.3 Registration ==
94 94  
95 95  Publishing the data and reference metadata involves the following steps for a Data/Metadata Provider:
96 96  
... ... @@ -101,13 +101,13 @@
101 101  
102 102  **Figure 2: Schematic of Registered Data and Metadata Sources in the SDMX-IM**
103 103  
104 -=== {{id name="_Toc90786"/}}3.4 Notification ===
103 +== 3.4 Notification ==
105 105  
106 106  Notifying interested parties of newly published or re-published data, reference metadata or changes in structural metadata involves:
107 107  
108 108  • 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.
109 109  
110 -=== {{id name="_Toc90787"/}}3.5 Discovery ===
109 +== 3.5 Discovery ==
111 111  
112 112  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:
113 113  
... ... @@ -119,9 +119,9 @@
119 119  
120 120  **Figure 3: Schematic of Data and Metadata Discovery and Query in the SDMX-IM**
121 121  
122 -= {{id name="_Toc90788"/}}4 SDMX Registry/Repository Architecture =
121 += 4 SDMX Registry/Repository Architecture =
123 123  
124 -=== {{id name="_Toc90789"/}}4.1 Architectural Schematic ===
123 +== 4.1 Architectural Schematic ==
125 125  
126 126  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.
127 127  
... ... @@ -129,7 +129,7 @@
129 129  
130 130  **Figure 4: Schematic of the Registry Content and Services**
131 131  
132 -=== {{id name="_Toc90790"/}}4.2 Structural Metadata Repository ===
131 +== 4.2 Structural Metadata Repository ==
133 133  
134 134  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.
135 135  
... ... @@ -140,15 +140,15 @@
140 140  
141 141  As of the initial version of SDMX 3.0 no messages are defined to support these artefacts; hence, users may need to use SDMX 2.1 Registry Interface messages, instead.
142 142  
143 -=== {{id name="_Toc90791"/}}4.3 Provisioning Metadata Repository ===
142 +== 4.3 Provisioning Metadata Repository ==
144 144  
145 145  The function of this repository is to support the definition of the structural metadata that describes the various types of data-store which model SDMX-conformant databases or files, and to link to these data sources. These links can be specified for a data/metadata provider, for a specific data or metadata flow. In the SDMX model this is called the Provision or Metadata Provision Agreement.
146 146  
147 147  This layer is supported by the Data and Metadata Registration Service.
148 148  
149 -= {{id name="_Toc90792"/}}5 Registry Interfaces and Services =
148 += 5 Registry Interfaces and Services =
150 150  
151 -=== {{id name="_Toc90793"/}}5.1 Registry Interfaces ===
150 +== 5.1 Registry Interfaces ==
152 152  
153 153  The Registry Interfaces are:
154 154  
... ... @@ -164,7 +164,7 @@
164 164  
165 165  The registry interfaces are invoked in one of two ways:
166 166  
167 -*
166 +*
168 168  *1. The interface is the name of the root node of the SDMX-ML document
169 169  *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.
170 170  
... ... @@ -174,17 +174,17 @@
174 174  
175 175  It should be noted that all interactions are assumed to be synchronous, with the exception of Notify Registry Event. This document is sent by the SDMX-RR to all subscribers whenever an even occurs to which any users have subscribed. Thus, it does not conform to the requestresponse pattern, because it is inherently asynchronous.
176 176  
177 -=== {{id name="_Toc90794"/}}5.2 Registry Services ===
176 +== 5.2 Registry Services ==
178 178  
179 -===== {{id name="_Toc90795"/}}5.2.1 Introduction =====
178 +=== 5.2.1 Introduction ===
180 180  
181 181  The services described in this section do not imply that each is implemented as a discrete web service.
182 182  
183 -===== {{id name="_Toc90796"/}}5.2.2 Structure Submission Service =====
182 +=== 5.2.2 Structure Submission Service ===
184 184  
185 185  The registry must support a mechanism for submitting structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: __[[https:~~/~~/github.com/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[twg/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[rest>>url:https://github.com/sdmx-twg/sdmx-rest]]__[[)>>url:https://github.com/sdmx-twg/sdmx-rest]]. In order for the architecture to be scalable, the finest-grained piece of structural metadata that can be processed by the SDMX-RR is a MaintainableArtefact, with the exception of Item Schemes, where changes at an Item level is also possible (see next section on the SDMX Information Model).
186 186  
187 -===== {{id name="_Toc90797"/}}5.2.3 Structure Query Service =====
186 +=== 5.2.3 Structure Query Service ===
188 188  
189 189  The registry must support a mechanism for querying for structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: __[[https:~~/~~/github.com/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[twg/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[rest>>url:https://github.com/sdmx-twg/sdmx-rest]]__[[)>>url:https://github.com/sdmx-twg/sdmx-rest]]. The registry response to this query mechanism is the SDMX Structure message, which has as its root node:
190 190  
... ... @@ -192,7 +192,7 @@
192 192  
193 193  The SDMX structural artefacts that may be queried are defined in the SDMX structure web service specification which is compatible with this release of the standard __[[https:~~/~~/github.com/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]][[->>url:https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]][[twg/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]][[->>url:https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]][[rest/blob/master/doc/structures.md>>url:https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]]__[[url:https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]]
194 194  
195 -===== {{id name="_Toc90798"/}}5.2.4 Data and Reference Metadata Registration Service =====
194 +=== 5.2.4 Data and Reference Metadata Registration Service ===
196 196  
197 197  This service must implement the following Registry Interfaces:
198 198  
... ... @@ -215,23 +215,24 @@
215 215  
216 216  The Registration has an action attribute which takes one of the following values:
217 217  
218 -|**Action Attribute Value**|**Behaviour**
219 -|Append|Add this registration to the registry
220 -|Replace|Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request
221 -|Delete|Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
217 +(% style="width:893.835px" %)
218 +|(% style="width:241px" %)**Action Attribute Value**|(% style="width:650px" %)**Behaviour**
219 +|(% style="width:241px" %)Append|(% style="width:650px" %)Add this registration to the registry
220 +|(% style="width:241px" %)Replace|(% style="width:650px" %)Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request
221 +|(% style="width:241px" %)Delete|(% style="width:650px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
222 222  
223 223  The Registration has three Boolean attributes which may be present to determine how an SDMX compliant dataset or metadataset indexing application must index the datasets or metadatasets upon registration. The indexing application behaviour is as follows:
224 224  
225 -|**Boolean Attribute**|**Behaviour if Value is “true”**
226 -|indexTimeSeries|A compliant indexing application must index all the time series keys
227 -|indexDataSet|(((
225 +(% style="width:896.835px" %)
226 +|**Boolean Attribute**|(% style="width:712px" %)**Behaviour if Value is “true”**
227 +|indexTimeSeries|(% style="width:712px" %)A compliant indexing application must index all the time series keys
228 +|indexDataSet|(% style="width:712px" %)(((
228 228  A compliant indexing application must index the range of actual (present) values for each dimension of the Dataset.
229 -
230 230  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
231 231  )))
232 -|indexReportingPeriod|A compliant indexing application must index the time period range(s) for which data are present in the Dataset.
232 +|indexReportingPeriod|(% style="width:712px" %)A compliant indexing application must index the time period range(s) for which data are present in the Dataset.
233 233  
234 -===== {{id name="_Toc90799"/}}5.2.5 Data Discovery =====
234 +=== 5.2.5 Data Discovery ===
235 235  
236 236  The Data Discovery Service implements the following Registry Interfaces:
237 237  
... ... @@ -238,7 +238,7 @@
238 238  * QueryRegistrationRequest
239 239  * QueryRegistrationResponse
240 240  
241 -===== {{id name="_Toc90800"/}}5.2.6 Subscription and Notification =====
241 +=== 5.2.6 Subscription and Notification ===
242 242  
243 243  The Subscription and Notification Service implements the following Registry Interfaces:
244 244  
... ... @@ -257,34 +257,32 @@
257 257  
258 258  Notification requires that the structural metadata repository and the provisioning metadata repository monitor any event which is of interest to a user (the object of a subscription request query), and to issue an SDMX notification document to the endpoints specified in the relevant subscriptions.
259 259  
260 -===== {{id name="_Toc90801"/}}5.2.7 Registry Behaviour =====
260 +=== 5.2.7 Registry Behaviour ===
261 261  
262 262  The following table defines the behaviour of the SDMX Registry for the various Registry Interface messages. It should be noted, though, that as of SDMX 3.0, an extended versioning scheme newly including semantic versioning is foreseen for all Maintainable Artefacts. Moreover, while the old versioning scheme is allowed, given there is no more a "final" flag, there is no way guaranteeing the consistency across version of a Maintainable, unless semantic versioning is used.
263 263  
264 264  Given the above, the behaviour described in the following table concerns either draft Artefacts using semantic versioning or any Artefacts using the old versioning scheme. Nevertheless, in the case of semantic versioning the registry must respect the versioning rules when performing the actions below. For example, it is not possible to replace a non-draft Artefact that follows semantic versioning, unless a newer version is introduced according to the semantic versioning rules. Furthermore, even when draft Artefacts are submitted, the registry has to verify semantic versioning is respected against the previous non-draft versions. It is worth noting that the rules for semantic versioning and replacing or maintaining semantically versioned Artefacts applies to externally shared Artefacts. This means that any system may internally perform any change within a version of an Artefact, until the latter is shared outside of that system or becomes public. Then (as also explained in the SDMX Standards Section 6 “Technical Notes”) the Artefacts must adhere to the Semantic Versioning rules.
265 265  
266 -|**Interface**|**Behaviour**
267 -|All|(((
266 +(% style="width:982.835px" %)
267 +|(% style="width:217px" %)**Interface**|(% style="width:763px" %)**Behaviour**
268 +|(% style="width:217px" %)All|(% style="width:763px" %)(((
268 268  1. If the action is set to “replace” (or a maintainable Artefact is PUT or POSTed) then the entire contents of the existing maintainable object in the Registry MUST be replaced by the object submitted.
269 269  1. Cross referenced structures MUST exist in either the submitted document (in Structures or Structure Location) or in the registry to which the request is submitted.
270 270  1. If the action is set to “delete” (or a maintainable Artefact is DELETEd) then the Registry MUST verify that the object can be deleted. In order to qualify for deletion, the object must:
271 271  
272 -1. Be a draft version.
273 +a) Be a draft version.
274 +b) Not be explicitly^^[[(% class="wikiinternallink wikiinternallink wikiinternallink" %)^^1^^>>path:#sdfootnote1sym||name="sdfootnote1anc"]](%%)^^ referenced from any other object in the Registry.
273 273  
274 -b) Not be explicitly^^[[^^1^^>>path:#sdfootnote1sym||name="sdfootnote1anc"]]^^ referenced from any other object in the Registry.
275 -
276 276  4) The semantic versioning rules in the SDMX documentation MUST be obeyed.
277 277  )))
278 -|Structure submission|(((
279 -Structures are submitted at the level of the
280 -
281 -Maintainable Artefact and the behaviour in “All” above is therefore at the level of the Maintainable Artefact.
278 +|(% style="width:217px" %)Structure submission|(% style="width:763px" %)(((
279 +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.
282 282  )))
283 -|SubmitRegistrationRequest|If the datasource is a file (simple datasource) then the file MAY be retrieved and indexed according to the Boolean attributes set in the Registration. For a queryable datasource the Registry MAY validate that the source exists and can accept an SDMX data query.
281 +|(% style="width:217px" %)SubmitRegistrationRequest|(% style="width:763px" %)If the datasource is a file (simple datasource) then the file MAY be retrieved and indexed according to the Boolean attributes set in the Registration. For a queryable datasource the Registry MAY validate that the source exists and can accept an SDMX data query.
284 284  
285 -= {{id name="_Toc90802"/}}6 Identification of SDMX Objects =
283 += 6 Identification of SDMX Objects =
286 286  
287 -=== {{id name="_Toc90803"/}}6.1 Identification, Versioning, and Maintenance ===
285 +== 6.1 Identification, Versioning, and Maintenance ==
288 288  
289 289  All major classes of the SDMX Information model inherit from one of:
290 290  
... ... @@ -293,7 +293,7 @@
293 293  * //**VersionableArtefact**// – this has all of the above features plus a version number, according to the SDMX versioning rules in SDMX Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”, and a validity period.
294 294  * //**MaintainableArtefact**// – this has all of the above features, plus registry and structure URIs, and an association to the maintenance organisation of the object.
295 295  
296 -===== {{id name="_Toc90804"/}}6.1.1 Identification, Naming, Versioning, and Maintenance Model =====
294 +=== 6.1.1 Identification, Naming, Versioning, and Maintenance Model ===
297 297  
298 298  [[image:SDMX 3.1 Section 5_en_4a9b2cfc.jpg||height="688" width="587"]]
299 299  
... ... @@ -302,60 +302,58 @@
302 302  The table below shows the identification and related data attributes to be stored in a registry for objects that are one of:
303 303  
304 304  * //Annotable//
303 +* //Identifiable//
304 +* //Nameable//
305 +* //Versionable//
306 +* //Maintainable//
305 305  
306 -//Identifiable// • //Nameable//
307 -
308 -• //Versionable//
309 -
310 -• //Maintainable//
311 -
312 -||(% colspan="2" %)**Object Type**|(% colspan="2" %)**Data Attributes**|(% colspan="2" %)**Status**|(% colspan="2" %)**Data type**|(% colspan="2" %)**Notes**
313 -||(% colspan="2" rowspan="4" %)//Annotable//|(% colspan="2" %)AnnotationTitle|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
314 -||(% colspan="2" %)AnnotationType|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
315 -||(% colspan="2" %)AnnotationURN|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
316 -||(% colspan="2" %)(((
308 +| |(% colspan="2" %)**Object Type**|(% colspan="2" %)**Data Attributes**|(% colspan="2" %)**Status**|(% colspan="2" %)**Data type**|(% colspan="2" %)**Notes**
309 +| |(% colspan="2" rowspan="4" %)//Annotable//|(% colspan="2" %)AnnotationTitle|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
310 +| |(% colspan="2" %)AnnotationType|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
311 +| |(% colspan="2" %)AnnotationURN|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
312 +| |(% colspan="2" %)(((
317 317  AnnotationText in the form of
318 318  
319 319  InternationalString
320 -)))|(% colspan="2" %)C|(% colspan="2" %)|(% colspan="2" %)This can have languagespecific variants
321 -||(% colspan="2" rowspan="4" %)//Identifiable//|(% colspan="2" %)All content as for //Annotable// plus|(% colspan="2" %)|(% colspan="2" %)|(% colspan="2" %)
322 -||(% colspan="2" %)id|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)
323 -||(% colspan="2" %)uri|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
324 -||(% colspan="2" %)urn|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)Although the urn is computable and therefore may not be submitted or stored physically, the Registry must return the urn for each object, and must be able to service a query on an object referenced solely by its urn.
325 -||(% colspan="2" rowspan="3" %)//Nameable//|(% colspan="2" %)(((
316 +)))|(% colspan="2" %)C|(% colspan="2" %) |(% colspan="2" %)This can have languagespecific variants
317 +| |(% colspan="2" rowspan="4" %)//Identifiable//|(% colspan="2" %)All content as for //Annotable// plus|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
318 +| |(% colspan="2" %)id|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)
319 +| |(% colspan="2" %)uri|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
320 +| |(% colspan="2" %)urn|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)Although the urn is computable and therefore may not be submitted or stored physically, the Registry must return the urn for each object, and must be able to service a query on an object referenced solely by its urn.
321 +| |(% colspan="2" rowspan="3" %)//Nameable//|(% colspan="2" %)(((
326 326  All content as for
327 327  
328 328  //Identifiable// plus
329 -)))|(% colspan="2" %)|(% colspan="2" %)|(% colspan="2" %)
330 -||(% colspan="2" %)(((
325 +)))|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
326 +| |(% colspan="2" %)(((
331 331  Name in the form of
332 332  
333 333  InternationalString
334 334  )))|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)This can have language specific variants.
335 -||(% colspan="2" %)(((
331 +| |(% colspan="2" %)(((
336 336  Description in the form of
337 337  
338 338  InternationalString
339 339  )))|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)This can have language specific variants.
340 -||(% colspan="2" rowspan="4" %)//Versionable//|(% colspan="2" %)(((
336 +| |(% colspan="2" rowspan="4" %)//Versionable//|(% colspan="2" %)(((
341 341  All content as for
342 342  
343 343  //Identifiable// plus
344 -)))|(% colspan="2" %)|(% colspan="2" %)|(% colspan="2" %)
345 -||(% colspan="2" %)version|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)This is the version number according to SDMX versioning rules.
346 -||(% colspan="2" %)validFrom|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %)
347 -||(% colspan="2" %)validTo|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %)
348 -|(% colspan="2" rowspan="5" %)//Maintainable//|(% colspan="2" %)All content as for //Versionable// plus|(% colspan="2" %)|(% colspan="2" %)|(% colspan="2" %)|
349 -|(% colspan="2" %)isExternalReference|(% colspan="2" %)C|(% colspan="2" %)boolean|(% colspan="2" %)Value of “true” indicates that the actual resource is held outside of this registry. The actual reference is given in the registry URI or the structureURL, each of which must return a valid SDMX-ML file.|
350 -|(% colspan="2" %)serviceURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the service that can be queried for this resource.|
351 -|(% colspan="2" %)structureURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the resource.|
352 -|(% colspan="2" %)(Maintenance) organisationId|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)The object must be linked to a maintenance organisation, i.e., Agency or Metadata Provider.|
340 +)))|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
341 +| |(% colspan="2" %)version|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)This is the version number according to SDMX versioning rules.
342 +| |(% colspan="2" %)validFrom|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %)
343 +| |(% colspan="2" %)validTo|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %)
344 +|(% colspan="2" rowspan="5" %)//Maintainable//|(% colspan="2" %)All content as for //Versionable// plus|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %) |
345 +|(% colspan="2" %)isExternalReference|(% colspan="2" %)C|(% colspan="2" %)boolean|(% colspan="2" %)Value of “true” indicates that the actual resource is held outside of this registry. The actual reference is given in the registry URI or the structureURL, each of which must return a valid SDMX-ML file.|
346 +|(% colspan="2" %)serviceURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the service that can be queried for this resource.|
347 +|(% colspan="2" %)structureURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the resource.|
348 +|(% colspan="2" %)(Maintenance) organisationId|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)The object must be linked to a maintenance organisation, i.e., Agency or Metadata Provider.|
353 353  
354 354  **Table 1: Common Attributes of Object Types**
355 355  
356 -=== {{id name="_Toc90805"/}}6.2 Unique identification of SDMX objects ===
352 +== 6.2 Unique identification of SDMX objects ==
357 357  
358 -===== {{id name="_Toc90806"/}}6.2.1 Agencies and Metadata Providers =====
354 +=== 6.2.1 Agencies and Metadata Providers ===
359 359  
360 360  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.
361 361  
... ... @@ -388,14 +388,11 @@
388 388  
389 389  The following organizations maintain an Agency Scheme.
390 390  
391 -• SDMX – contains Agencies AA, BB
387 +* SDMX – contains Agencies AA, BB
388 +* AA – contains Agencies CC, DD
389 +* BB – contains Agencies CC, DD
390 +* DD – Contains Agency EE
392 392  
393 -• AA – contains Agencies CC, DD
394 -
395 -• BB – contains Agencies CC, DD
396 -
397 -• DD – Contains Agency EE
398 -
399 399  Each agency is identified by its full hierarchy excluding SDMX.
400 400  
401 401  e.g., the id of EE as an agencyID is AA.DD.EE
... ... @@ -408,13 +408,13 @@
408 408  
409 409  Following the same principles, the Metadata Provider is the maintenance organisation for a special subset of Maintainable Artefacts, i.e., the Metadatasets; the latter are the containers of reference metadata combined with a target that those metadata refer to.
410 410  
411 -===== {{id name="_Toc90807"/}}6.2.2 Universal Resource Name (URN) =====
404 +=== 6.2.2 Universal Resource Name (URN) ===
412 412  
413 -**6.2.2.1 Introduction**
406 +==== 6.2.2.1 Introduction ====
414 414  
415 415  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.).
416 416  
417 -**6.2.2.2 URN Structure //__Case Rules for URN__//**// //
410 +==== 6.2.2.2 URN Structure //__Case Rules for URN__// ====
418 418  
419 419  For the URN, all parts of the string are case sensitive. The generic structure of the URN is as follows:
420 420  
... ... @@ -511,92 +511,92 @@
511 511  
512 512  |**Package**|**URN class name (model class name where this is different)**
513 513  |base|Agency
514 -||AgencyScheme
515 -||DataConsumer
516 -||DataConsumerScheme
517 -||DataProvider
518 -||DataProviderScheme
519 -||MetadataProvider
520 -||MetadataProviderScheme
521 -||OrganisationUnit
522 -||OrganisationUnitScheme
523 -||
507 +| |AgencyScheme
508 +| |DataConsumer
509 +| |DataConsumerScheme
510 +| |DataProvider
511 +| |DataProviderScheme
512 +| |MetadataProvider
513 +| |MetadataProviderScheme
514 +| |OrganisationUnit
515 +| |OrganisationUnitScheme
516 +| |
524 524  |datastructure|AttributeDescriptor
525 -||DataAttribute
526 -||Dataflow
527 -||DataStructure (DataStructureDefinition)
528 -||Dimension
529 -||DimensionDescriptor
530 -||GroupDimensionDescriptor
531 -||Measure
532 -||MeasureDescriptor
533 -||TimeDimension
534 -||
518 +| |DataAttribute
519 +| |Dataflow
520 +| |DataStructure (DataStructureDefinition)
521 +| |Dimension
522 +| |DimensionDescriptor
523 +| |GroupDimensionDescriptor
524 +| |Measure
525 +| |MeasureDescriptor
526 +| |TimeDimension
527 +| |
535 535  |metadatastructure|MetadataAttribute
536 -||MetadataAttributeDescriptor
537 -||(((
529 +| |MetadataAttributeDescriptor
530 +| |(((
538 538  MetadataStructure
539 539  
540 540  (MetadataStructureDefinition)
541 541  )))
542 542  
543 -:
536 +:
544 544  
545 545  (((
546 546  |**Package**|**URN class name (model class name where this is different)**
547 -||Metadataflow
548 -||MetadataSet
549 -||
540 +| |Metadataflow
541 +| |MetadataSet
542 +| |
550 550  |process|Process
551 -||ProcessStep
552 -||Transition
553 -||
544 +| |ProcessStep
545 +| |Transition
546 +| |
554 554  |registry|DataConstraint
555 -||MetadataConstraint
556 -||MetadataProvisionAgreement
557 -||ProvisionAgreement
558 -||Subscription
559 -||
548 +| |MetadataConstraint
549 +| |MetadataProvisionAgreement
550 +| |ProvisionAgreement
551 +| |Subscription
552 +| |
560 560  |structuremapping|CategorySchemeMap
561 -||ConceptSchemeMap
562 -||OrganisationSchemeMap
563 -||ReportingTaxonomyMap
564 -||RepresentationMap
565 -||StructureMap
566 -||
554 +| |ConceptSchemeMap
555 +| |OrganisationSchemeMap
556 +| |ReportingTaxonomyMap
557 +| |RepresentationMap
558 +| |StructureMap
559 +| |
567 567  |codelist|Code
568 -||Codelist
569 -||HierarchicalCode
570 -||Hierarchy
571 -||HierarchyAssociation
572 -||Level
573 -||ValueList
574 -||
561 +| |Codelist
562 +| |HierarchicalCode
563 +| |Hierarchy
564 +| |HierarchyAssociation
565 +| |Level
566 +| |ValueList
567 +| |
575 575  |categoryscheme|Categorisation
576 -||Category
577 -||CategoryScheme
578 -||ReportingCategory
579 -||ReportingTaxonomy
569 +| |Category
570 +| |CategoryScheme
571 +| |ReportingCategory
572 +| |ReportingTaxonomy
580 580  |**Package**|**URN class name (model class name where this is different)**
581 -||
574 +| |
582 582  |conceptscheme|Concept
583 -||ConceptScheme
584 -||
576 +| |ConceptScheme
577 +| |
585 585  |transformation|CustomType
586 -||CustomTypeScheme
587 -||NamePersonalisation
588 -||NamePersonalisationScheme
589 -||Ruleset
590 -||RulesetScheme
591 -||Transformation
592 -||TransformationScheme
593 -||UserDefinedOperator
594 -||UserDefinedOperatorScheme
595 -||VtlCodelistMapping
596 -||VtlConceptMapping
597 -||VtlDataflowMapping
598 -||VtlMappingScheme
599 -||
579 +| |CustomTypeScheme
580 +| |NamePersonalisation
581 +| |NamePersonalisationScheme
582 +| |Ruleset
583 +| |RulesetScheme
584 +| |Transformation
585 +| |TransformationScheme
586 +| |UserDefinedOperator
587 +| |UserDefinedOperatorScheme
588 +| |VtlCodelistMapping
589 +| |VtlConceptMapping
590 +| |VtlDataflowMapping
591 +| |VtlMappingScheme
592 +| |
600 600  )))
601 601  
602 602  **Table 2: SDMX-IM Packages and Contained Classes**
... ... @@ -610,7 +610,7 @@
610 610  urn:sdmx.org.sdmx.infomodel.{package}.{classname}=
611 611  
612 612  |**Classname**|**Ending URN pattern**|**Example**
613 -|Agency^^[[^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]]^^|agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|ECB:**AGENCIES**(**1.0**).AA
606 +|Agency^^[[(% class="wikiinternallink wikiinternallink wikiinternallink" %)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^|agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|ECB:**AGENCIES**(**1.0**).AA
614 614  |//AgencyScheme//|agencySchemeAgencyId:**AGENCIES**(**1.0**)|ECB:**AGENCIES**(**1.0**)
615 615  |//Categorisation//|categorisationAgencyId:categorisationId(version)|IMF:cat001(1.0.0)
616 616  |Category|categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|IMF:SDDS(1.0.0):level_1_category.level_2_category …
... ... @@ -769,22 +769,22 @@
769 769  The following table lists the Maintainable Artefacts.
770 770  
771 771  |(% colspan="2" %)**Maintainable Artefacts**|**Content**
772 -|**Abstract Class**|**Concrete Class**|
765 +|**Abstract Class**|**Concrete Class**|
773 773  |Item Scheme|Codelist|Code
774 -||Concept Scheme|Concept
775 -||Category Scheme|Category
776 -||Organisation Unit Scheme|Organisation Unit
777 -||Agency Scheme|Agency
778 -||Data Provider Scheme|Data Provider
779 -||Metadata Provider Scheme|Metadata Provider
780 -||Data Consumer Scheme|Data Consumer
781 -||Reporting Taxonomy|Reporting Category
782 -||Transformation Scheme|Transformation
783 -||Custom Type Scheme|Custom Type
784 -||Name Personalisation Scheme|Name Personalisation
785 -||Vtl Mapping Scheme|Vtl Codelist Mapping Vtl Concept Mapping
786 -||Ruleset Scheme|Ruleset
787 -||User Defined Operator Scheme|User Defined Operator
767 +| |Concept Scheme|Concept
768 +| |Category Scheme|Category
769 +| |Organisation Unit Scheme|Organisation Unit
770 +| |Agency Scheme|Agency
771 +| |Data Provider Scheme|Data Provider
772 +| |Metadata Provider Scheme|Metadata Provider
773 +| |Data Consumer Scheme|Data Consumer
774 +| |Reporting Taxonomy|Reporting Category
775 +| |Transformation Scheme|Transformation
776 +| |Custom Type Scheme|Custom Type
777 +| |Name Personalisation Scheme|Name Personalisation
778 +| |Vtl Mapping Scheme|Vtl Codelist Mapping Vtl Concept Mapping
779 +| |Ruleset Scheme|Ruleset
780 +| |User Defined Operator Scheme|User Defined Operator
788 788  |Enumerated List|ValueList|Value Item
789 789  |Structure|Data Structure Definition|(((
790 790  Dimension Descriptor
... ... @@ -803,9 +803,9 @@
803 803  
804 804  Measure
805 805  )))
806 -||Metadata Structure Definition|Metadata Attribute Descriptor Metadata Attribute
807 -|Structure Usage|Dataflow|
808 -||Metadataflow|
799 +| |Metadata Structure Definition|Metadata Attribute Descriptor Metadata Attribute
800 +|Structure Usage|Dataflow|
801 +| |Metadataflow|
809 809  |None|Process|Process Step
810 810  |None|Structure Map|(((
811 811  Component Map
... ... @@ -816,16 +816,16 @@
816 816  )))
817 817  |None|Representation Map|Representation Mapping
818 818  |Item Scheme Map|Organisation Scheme Map|Item Map
819 -||Concept Scheme Map|Item Map
820 -||Category Scheme Map|Item Map
821 -||Reporting Taxonomy Map|Item Map
822 -|None|Provision Agreement|
823 -|None|Metadata Provision Agreement|
812 +| |Concept Scheme Map|Item Map
813 +| |Category Scheme Map|Item Map
814 +| |Reporting Taxonomy Map|Item Map
815 +|None|Provision Agreement|
816 +|None|Metadata Provision Agreement|
824 824  |None|Hierarchy|Hierarchical Code
825 -|None|Hierarchy Association|
826 -|None|Categorisation|
818 +|None|Hierarchy Association|
819 +|None|Categorisation|
827 827  |Constraint|Data Constraint|DataKeySet
828 -|||CubeRegion
821 +| | |CubeRegion
829 829  |Constraint|Metadata Constraint|MetadataTargetRegion
830 830  
831 831  **Table 4: Table of Maintainable Artefacts for Structural Definition Metadata**
... ... @@ -835,7 +835,7 @@
835 835  The artefacts included in the structural definitions are:
836 836  
837 837  * All types of Item Scheme (Codelist, Concept Scheme, Category Scheme, Organisation Scheme, Agency Scheme, Data Provider Scheme, Metadata Provider Scheme, Data Consumer Scheme, Organisation Unit Scheme, Transformation Scheme, Name Personalisation Scheme, Custom Type Scheme, Vtl Mapping Scheme, Ruleset Scheme, User Defined Operator Scheme)
838 -* All types of Enumerated List (ValueList)^^[[^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]]^^
831 +* All types of Enumerated List (ValueList)^^[[(% class="wikiinternallink wikiinternallink wikiinternallink" %)^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]](%%)^^
839 839  * All types of Structure (Data Structure Definition, Metadata Structure Definition)
840 840  * All types of Structure Usage (Dataflow, Metadataflow)
841 841  
... ... @@ -859,13 +859,13 @@
859 859  
860 860  In addition to the maintenance of the Dataflow and the Metadataflow, the following links must be maintained in the registry:
861 861  
862 -1.
855 +1.
863 863  1*. Dataflow to Data Structure Definition
864 864  1*. Metadataflow to Metadata Structure Definition
865 865  
866 866  The following links may be created by means of a Categorisation
867 867  
868 -1.
861 +1.
869 869  1*. Categorisation to Dataflow and Category
870 870  1*. Categorisation to Metadataflow and Category
871 871  
... ... @@ -971,7 +971,7 @@
971 971  
972 972  The Registration has an action attribute which takes one of the following values:
973 973  
974 -:
967 +:
975 975  
976 976  (((
977 977  |**Action Attribute Value**|**Behaviour**
... ... @@ -996,7 +996,7 @@
996 996  
997 997  https:~/~/github.com/sdmx-twg/sdmx-rest/blob/master/doc/availability.md
998 998  
999 -:
992 +:
1000 1000  
1001 1001  (((
1002 1002  |**Indexing Required**|**Registration Process Activity**
... ... @@ -1019,7 +1019,7 @@
1019 1019  Components of the Constraints model in the
1020 1020  )))
1021 1021  |**Indexing Required**|**Registration Process Activity**
1022 -||SDMX-IM. Note that the content is not stored in the Selection Value.
1015 +| |SDMX-IM. Note that the content is not stored in the Selection Value.
1023 1023  )))
1024 1024  
1025 1025  Constraints that specify the contents of a //QueryDatasource// are submitted to the Registry via the structure submission service (i.e., the RESTful API).
... ... @@ -1061,8 +1061,8 @@
1061 1061  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.
1062 1062  1. A selector which specifies which type of events are of interest. The set of event types is:
1063 1063  
1064 -:
1065 -::
1057 +:
1058 +::
1066 1066  
1067 1067  (((
1068 1068  |**Event Type**|**Comment**
... ... @@ -1136,7 +1136,7 @@
1136 1136  
1137 1137  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:
1138 1138  
1139 -:
1132 +:
1140 1140  
1141 1141  (((
1142 1142  |**Selector**|**Comment**
SDMX 3.1 Section 5_en_9b750e13.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +55.6 KB
Content
SDMX 3.1 Section 5_en_b08fd1a2.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +46.3 KB
Content
SDMX 3.1 Section 5_en_c63d10ab.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +101.3 KB
Content