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

From version 21.3
edited by Helena
on 2025/06/08 16:28
Change comment: There is no comment for this version
To version 21.14
edited by Helena
on 2025/06/08 16:42
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -37,7 +37,7 @@
37 37  
38 38  The registry services outlined in this specification are designed to help the SDMX community manage the proliferation of SDMX assets and to support data sharing for reporting and dissemination.
39 39  
40 -= {{id name="_Toc90781"/}}2 Scope and Normative Status =
40 += 2 Scope and Normative Status =
41 41  
42 42  The scope of this document is to specify the logical interfaces for the SDMX registry in terms of the functions required and the data that may be present in the function call, and the behaviour expected of the registry.
43 43  
... ... @@ -54,9 +54,9 @@
54 54  
55 55  Note that although the term “authorised user” is used in this document, the SDMX standards do not define an access control mechanism. Such a mechanism, if required, must be chosen and implemented by the registry software provider.
56 56  
57 -= {{id name="_Toc90782"/}}3 Scope of the SDMX Registry/Repository =
57 += 3 Scope of the SDMX Registry/Repository =
58 58  
59 -=== {{id name="_Toc90783"/}}3.1 Objective ===
59 +== 3.1 Objective ==
60 60  
61 61  The objective of the SDMX registry/repository is, in broad terms, to allow organisations to publish statistical data and reference metadata in known formats such that interested third parties can discover these data and interpret them accurately and correctly. The mechanism for doing this is twofold:
62 62  
... ... @@ -63,7 +63,7 @@
63 63  1. To maintain and publish structural metadata that describes the structure and valid content of data and reference metadata sources such as databases, metadata repositories, data sets, metadata sets. This structural metadata enables software applications to understand and to interpret the data and reference metadata in these sources.
64 64  1. To enable applications, organisations, and individuals to share and to discover data and reference metadata. This facilitates data and reference metadata dissemination by implementing the data sharing vision of SDMX.
65 65  
66 -=== {{id name="_Toc90784"/}}3.2 Structural Metadata ===
66 +== 3.2 Structural Metadata ==
67 67  
68 68  Setting up structural metadata and the exchange context (referred to as “data provisioning”) involves the following steps for maintenance agencies:
69 69  
... ... @@ -89,7 +89,7 @@
89 89  
90 90  In that context, the term “Metadata” refers to reference metadata.
91 91  
92 -=== {{id name="_Toc90785"/}}3.3 Registration ===
92 +== 3.3 Registration ==
93 93  
94 94  Publishing the data and reference metadata involves the following steps for a Data/Metadata Provider:
95 95  
... ... @@ -100,13 +100,13 @@
100 100  
101 101  **Figure 2: Schematic of Registered Data and Metadata Sources in the SDMX-IM**
102 102  
103 -=== {{id name="_Toc90786"/}}3.4 Notification ===
103 +== 3.4 Notification ==
104 104  
105 105  Notifying interested parties of newly published or re-published data, reference metadata or changes in structural metadata involves:
106 106  
107 107  • registry support of a subscription-based notification service which sends an email or notifies an HTTP address announcing all published data that meets the criteria contained in the subscription request.
108 108  
109 -=== {{id name="_Toc90787"/}}3.5 Discovery ===
109 +== 3.5 Discovery ==
110 110  
111 111  Discovering published data and reference metadata involves interaction with the registry to fulfil the following logical steps that would be carried out by a user interacting with a service that itself interacts with the registry and an SDMX-enabled data or reference metadata resource:
112 112  
... ... @@ -118,9 +118,9 @@
118 118  
119 119  **Figure 3: Schematic of Data and Metadata Discovery and Query in the SDMX-IM**
120 120  
121 -= {{id name="_Toc90788"/}}4 SDMX Registry/Repository Architecture =
121 += 4 SDMX Registry/Repository Architecture =
122 122  
123 -=== {{id name="_Toc90789"/}}4.1 Architectural Schematic ===
123 +== 4.1 Architectural Schematic ==
124 124  
125 125  The architecture of the SDMX registry/repository is derived from the objectives stated above. It is a layered architecture that is founded by a structural metadata repository which supports a provisioning metadata repository which supports the registry services. These are all supported by the SDMX-ML schemas. Applications can be built on top of these services which support the reporting, storage, retrieval, and dissemination aspects of the statistical lifecycle as well as the maintenance of the structural metadata required to drive these applications.
126 126  
... ... @@ -128,7 +128,7 @@
128 128  
129 129  **Figure 4: Schematic of the Registry Content and Services**
130 130  
131 -=== {{id name="_Toc90790"/}}4.2 Structural Metadata Repository ===
131 +== 4.2 Structural Metadata Repository ==
132 132  
133 133  The basic layer is that of a structural metadata service which supports the lifecycle of SDMX structural metadata artefacts such as Maintenance Agencies, Data Structure Definitions, Metadata Structure Definitions, Provision Agreements, Processes etc. This layer is supported by the Structure Submission and Query Service.
134 134  
... ... @@ -139,15 +139,15 @@
139 139  
140 140  As of the initial version of SDMX 3.0 no messages are defined to support these artefacts; hence, users may need to use SDMX 2.1 Registry Interface messages, instead.
141 141  
142 -=== {{id name="_Toc90791"/}}4.3 Provisioning Metadata Repository ===
142 +== 4.3 Provisioning Metadata Repository ==
143 143  
144 144  The function of this repository is to support the definition of the structural metadata that describes the various types of data-store which model SDMX-conformant databases or files, and to link to these data sources. These links can be specified for a data/metadata provider, for a specific data or metadata flow. In the SDMX model this is called the Provision or Metadata Provision Agreement.
145 145  
146 146  This layer is supported by the Data and Metadata Registration Service.
147 147  
148 -= {{id name="_Toc90792"/}}5 Registry Interfaces and Services =
148 += 5 Registry Interfaces and Services =
149 149  
150 -=== {{id name="_Toc90793"/}}5.1 Registry Interfaces ===
150 +== 5.1 Registry Interfaces ==
151 151  
152 152  The Registry Interfaces are:
153 153  
... ... @@ -173,17 +173,17 @@
173 173  
174 174  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.
175 175  
176 -=== {{id name="_Toc90794"/}}5.2 Registry Services ===
176 +== 5.2 Registry Services ==
177 177  
178 -===== {{id name="_Toc90795"/}}5.2.1 Introduction =====
178 +=== 5.2.1 Introduction ===
179 179  
180 180  The services described in this section do not imply that each is implemented as a discrete web service.
181 181  
182 -===== {{id name="_Toc90796"/}}5.2.2 Structure Submission Service =====
182 +=== 5.2.2 Structure Submission Service ===
183 183  
184 184  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).
185 185  
186 -===== {{id name="_Toc90797"/}}5.2.3 Structure Query Service =====
186 +=== 5.2.3 Structure Query Service ===
187 187  
188 188  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:
189 189  
... ... @@ -191,7 +191,7 @@
191 191  
192 192  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]]
193 193  
194 -===== {{id name="_Toc90798"/}}5.2.4 Data and Reference Metadata Registration Service =====
194 +=== 5.2.4 Data and Reference Metadata Registration Service ===
195 195  
196 196  This service must implement the following Registry Interfaces:
197 197  
... ... @@ -214,23 +214,24 @@
214 214  
215 215  The Registration has an action attribute which takes one of the following values:
216 216  
217 -|**Action Attribute Value**|**Behaviour**
218 -|Append|Add this registration to the registry
219 -|Replace|Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request
220 -|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
221 221  
222 222  The Registration has three Boolean attributes which may be present to determine how an SDMX compliant dataset or metadataset indexing application must index the datasets or metadatasets upon registration. The indexing application behaviour is as follows:
223 223  
224 -|**Boolean Attribute**|**Behaviour if Value is “true”**
225 -|indexTimeSeries|A compliant indexing application must index all the time series keys
226 -|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" %)(((
227 227  A compliant indexing application must index the range of actual (present) values for each dimension of the Dataset.
228 -
229 229  Note that for data this requires much less storage than full key indexing, but this method cannot guarantee that a specific combination of Dimension values (the Key) is actually present in the Dataset
230 230  )))
231 -|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.
232 232  
233 -===== {{id name="_Toc90799"/}}5.2.5 Data Discovery =====
234 +=== 5.2.5 Data Discovery ===
234 234  
235 235  The Data Discovery Service implements the following Registry Interfaces:
236 236  
... ... @@ -237,7 +237,7 @@
237 237  * QueryRegistrationRequest
238 238  * QueryRegistrationResponse
239 239  
240 -===== {{id name="_Toc90800"/}}5.2.6 Subscription and Notification =====
241 +=== 5.2.6 Subscription and Notification ===
241 241  
242 242  The Subscription and Notification Service implements the following Registry Interfaces:
243 243  
... ... @@ -256,34 +256,32 @@
256 256  
257 257  Notification requires that the structural metadata repository and the provisioning metadata repository monitor any event which is of interest to a user (the object of a subscription request query), and to issue an SDMX notification document to the endpoints specified in the relevant subscriptions.
258 258  
259 -===== {{id name="_Toc90801"/}}5.2.7 Registry Behaviour =====
260 +=== 5.2.7 Registry Behaviour ===
260 260  
261 261  The following table defines the behaviour of the SDMX Registry for the various Registry Interface messages. It should be noted, though, that as of SDMX 3.0, an extended versioning scheme newly including semantic versioning is foreseen for all Maintainable Artefacts. Moreover, while the old versioning scheme is allowed, given there is no more a "final" flag, there is no way guaranteeing the consistency across version of a Maintainable, unless semantic versioning is used.
262 262  
263 263  Given the above, the behaviour described in the following table concerns either draft Artefacts using semantic versioning or any Artefacts using the old versioning scheme. Nevertheless, in the case of semantic versioning the registry must respect the versioning rules when performing the actions below. For example, it is not possible to replace a non-draft Artefact that follows semantic versioning, unless a newer version is introduced according to the semantic versioning rules. Furthermore, even when draft Artefacts are submitted, the registry has to verify semantic versioning is respected against the previous non-draft versions. It is worth noting that the rules for semantic versioning and replacing or maintaining semantically versioned Artefacts applies to externally shared Artefacts. This means that any system may internally perform any change within a version of an Artefact, until the latter is shared outside of that system or becomes public. Then (as also explained in the SDMX Standards Section 6 “Technical Notes”) the Artefacts must adhere to the Semantic Versioning rules.
264 264  
265 -|**Interface**|**Behaviour**
266 -|All|(((
266 +(% style="width:982.835px" %)
267 +|(% style="width:217px" %)**Interface**|(% style="width:763px" %)**Behaviour**
268 +|(% style="width:217px" %)All|(% style="width:763px" %)(((
267 267  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.
268 268  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.
269 269  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:
270 270  
271 -1. Be a draft version.
273 +a) Be a draft version.
274 +b) Not be explicitly^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^1^^>>path:#sdfootnote1sym||name="sdfootnote1anc"]](%%)^^ referenced from any other object in the Registry.
272 272  
273 -b) Not be explicitly^^[[(% class="wikiinternallink wikiinternallink" %)^^1^^>>path:#sdfootnote1sym||name="sdfootnote1anc"]](%%)^^ referenced from any other object in the Registry.
274 -
275 275  4) The semantic versioning rules in the SDMX documentation MUST be obeyed.
276 276  )))
277 -|Structure submission|(((
278 -Structures are submitted at the level of the
279 -
280 -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.
281 281  )))
282 -|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.
283 283  
284 -= {{id name="_Toc90802"/}}6 Identification of SDMX Objects =
283 += 6 Identification of SDMX Objects =
285 285  
286 -=== {{id name="_Toc90803"/}}6.1 Identification, Versioning, and Maintenance ===
285 +== 6.1 Identification, Versioning, and Maintenance ==
287 287  
288 288  All major classes of the SDMX Information model inherit from one of:
289 289  
... ... @@ -292,7 +292,7 @@
292 292  * //**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.
293 293  * //**MaintainableArtefact**// – this has all of the above features, plus registry and structure URIs, and an association to the maintenance organisation of the object.
294 294  
295 -===== {{id name="_Toc90804"/}}6.1.1 Identification, Naming, Versioning, and Maintenance Model =====
294 +=== 6.1.1 Identification, Naming, Versioning, and Maintenance Model ===
296 296  
297 297  [[image:SDMX 3.1 Section 5_en_4a9b2cfc.jpg||height="688" width="587"]]
298 298  
... ... @@ -301,13 +301,11 @@
301 301  The table below shows the identification and related data attributes to be stored in a registry for objects that are one of:
302 302  
303 303  * //Annotable//
303 +* //Identifiable//
304 +* //Nameable//
305 +* //Versionable//
306 +* //Maintainable//
304 304  
305 -//Identifiable// • //Nameable//
306 -
307 -• //Versionable//
308 -
309 -• //Maintainable//
310 -
311 311  | |(% colspan="2" %)**Object Type**|(% colspan="2" %)**Data Attributes**|(% colspan="2" %)**Status**|(% colspan="2" %)**Data type**|(% colspan="2" %)**Notes**
312 312  | |(% colspan="2" rowspan="4" %)//Annotable//|(% colspan="2" %)AnnotationTitle|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
313 313  | |(% colspan="2" %)AnnotationType|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
... ... @@ -352,9 +352,9 @@
352 352  
353 353  **Table 1: Common Attributes of Object Types**
354 354  
355 -=== {{id name="_Toc90805"/}}6.2 Unique identification of SDMX objects ===
352 +== 6.2 Unique identification of SDMX objects ==
356 356  
357 -===== {{id name="_Toc90806"/}}6.2.1 Agencies and Metadata Providers =====
354 +=== 6.2.1 Agencies and Metadata Providers ===
358 358  
359 359  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.
360 360  
... ... @@ -387,14 +387,11 @@
387 387  
388 388  The following organizations maintain an Agency Scheme.
389 389  
390 -• 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
391 391  
392 -• AA – contains Agencies CC, DD
393 -
394 -• BB – contains Agencies CC, DD
395 -
396 -• DD – Contains Agency EE
397 -
398 398  Each agency is identified by its full hierarchy excluding SDMX.
399 399  
400 400  e.g., the id of EE as an agencyID is AA.DD.EE
... ... @@ -407,13 +407,13 @@
407 407  
408 408  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.
409 409  
410 -===== {{id name="_Toc90807"/}}6.2.2 Universal Resource Name (URN) =====
404 +=== 6.2.2 Universal Resource Name (URN) ===
411 411  
412 -**6.2.2.1 Introduction**
406 +==== 6.2.2.1 Introduction ====
413 413  
414 414  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.).
415 415  
416 -**6.2.2.2 URN Structure //__Case Rules for URN__//**// //
410 +==== 6.2.2.2 URN Structure //__Case Rules for URN__// ====
417 417  
418 418  For the URN, all parts of the string are case sensitive. The generic structure of the URN is as follows:
419 419  
... ... @@ -425,7 +425,7 @@
425 425  
426 426  The Maintenance agency identifier is separated from the maintainable artefact identifier by a colon ‘:’. All other identifiers in the SDMX URN syntax are separated by a period ‘.’. The version information is encapsulated in parentheses ‘()’ and adheres to the SDMX versioning rules, as explained in SDMX Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning.
427 427  
428 -**6.2.2.3 Explanation of the generic structure**
422 +==== 6.2.2.3 Explanation of the generic structure ====
429 429  
430 430  In the explanation below the actual object that is the target of the URN is called the **actual object**.
431 431  
... ... @@ -504,103 +504,103 @@
504 504  
505 505  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.
506 506  
507 -===== {{id name="_Toc90808"/}}6.2.3 Table of SDMX-IM Packages and Classes =====
501 +=== 6.2.3 Table of SDMX-IM Packages and Classes ===
508 508  
509 509  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.
510 510  
511 -|**Package**|**URN class name (model class name where this is different)**
512 -|base|Agency
513 -| |AgencyScheme
514 -| |DataConsumer
515 -| |DataConsumerScheme
516 -| |DataProvider
517 -| |DataProviderScheme
518 -| |MetadataProvider
519 -| |MetadataProviderScheme
520 -| |OrganisationUnit
521 -| |OrganisationUnitScheme
522 -| |
523 -|datastructure|AttributeDescriptor
524 -| |DataAttribute
525 -| |Dataflow
526 -| |DataStructure (DataStructureDefinition)
527 -| |Dimension
528 -| |DimensionDescriptor
529 -| |GroupDimensionDescriptor
530 -| |Measure
531 -| |MeasureDescriptor
532 -| |TimeDimension
533 -| |
534 -|metadatastructure|MetadataAttribute
535 -| |MetadataAttributeDescriptor
536 -| |(((
505 +(% style="width:750.835px" %)
506 +|(% style="width:222px" %)**Package**|(% style="width:526px" %)**URN class name (model class name where this is different)**
507 +|(% style="width:222px" %)base|(% style="width:526px" %)Agency
508 +|(% style="width:222px" %) |(% style="width:526px" %)AgencyScheme
509 +|(% style="width:222px" %) |(% style="width:526px" %)DataConsumer
510 +|(% style="width:222px" %) |(% style="width:526px" %)DataConsumerScheme
511 +|(% style="width:222px" %) |(% style="width:526px" %)DataProvider
512 +|(% style="width:222px" %) |(% style="width:526px" %)DataProviderScheme
513 +|(% style="width:222px" %) |(% style="width:526px" %)MetadataProvider
514 +|(% style="width:222px" %) |(% style="width:526px" %)MetadataProviderScheme
515 +|(% style="width:222px" %) |(% style="width:526px" %)OrganisationUnit
516 +|(% style="width:222px" %) |(% style="width:526px" %)OrganisationUnitScheme
517 +|(% style="width:222px" %) |(% style="width:526px" %)
518 +|(% style="width:222px" %)datastructure|(% style="width:526px" %)AttributeDescriptor
519 +|(% style="width:222px" %) |(% style="width:526px" %)DataAttribute
520 +|(% style="width:222px" %) |(% style="width:526px" %)Dataflow
521 +|(% style="width:222px" %) |(% style="width:526px" %)DataStructure (DataStructureDefinition)
522 +|(% style="width:222px" %) |(% style="width:526px" %)Dimension
523 +|(% style="width:222px" %) |(% style="width:526px" %)DimensionDescriptor
524 +|(% style="width:222px" %) |(% style="width:526px" %)GroupDimensionDescriptor
525 +|(% style="width:222px" %) |(% style="width:526px" %)Measure
526 +|(% style="width:222px" %) |(% style="width:526px" %)MeasureDescriptor
527 +|(% style="width:222px" %) |(% style="width:526px" %)TimeDimension
528 +|(% style="width:222px" %) |(% style="width:526px" %)
529 +|(% style="width:222px" %)metadatastructure|(% style="width:526px" %)MetadataAttribute
530 +|(% style="width:222px" %) |(% style="width:526px" %)MetadataAttributeDescriptor
531 +|(% style="width:222px" %) |(% style="width:526px" %)(((
537 537  MetadataStructure
538 538  
539 539  (MetadataStructureDefinition)
540 540  )))
541 541  
542 -:
543 -
544 544  (((
545 -|**Package**|**URN class name (model class name where this is different)**
546 -| |Metadataflow
547 -| |MetadataSet
548 -| |
549 -|process|Process
550 -| |ProcessStep
551 -| |Transition
552 -| |
553 -|registry|DataConstraint
554 -| |MetadataConstraint
555 -| |MetadataProvisionAgreement
556 -| |ProvisionAgreement
557 -| |Subscription
558 -| |
559 -|structuremapping|CategorySchemeMap
560 -| |ConceptSchemeMap
561 -| |OrganisationSchemeMap
562 -| |ReportingTaxonomyMap
563 -| |RepresentationMap
564 -| |StructureMap
565 -| |
566 -|codelist|Code
567 -| |Codelist
568 -| |HierarchicalCode
569 -| |Hierarchy
570 -| |HierarchyAssociation
571 -| |Level
572 -| |ValueList
573 -| |
574 -|categoryscheme|Categorisation
575 -| |Category
576 -| |CategoryScheme
577 -| |ReportingCategory
578 -| |ReportingTaxonomy
579 -|**Package**|**URN class name (model class name where this is different)**
580 -| |
581 -|conceptscheme|Concept
582 -| |ConceptScheme
583 -| |
584 -|transformation|CustomType
585 -| |CustomTypeScheme
586 -| |NamePersonalisation
587 -| |NamePersonalisationScheme
588 -| |Ruleset
589 -| |RulesetScheme
590 -| |Transformation
591 -| |TransformationScheme
592 -| |UserDefinedOperator
593 -| |UserDefinedOperatorScheme
594 -| |VtlCodelistMapping
595 -| |VtlConceptMapping
596 -| |VtlDataflowMapping
597 -| |VtlMappingScheme
598 -| |
538 +(% style="width:751.835px" %)
539 +|(% style="width:221px" %)**Package**|(% style="width:528px" %)**URN class name (model class name where this is different)**
540 +|(% style="width:221px" %) |(% style="width:528px" %)Metadataflow
541 +|(% style="width:221px" %) |(% style="width:528px" %)MetadataSet
542 +|(% style="width:221px" %) |(% style="width:528px" %)
543 +|(% style="width:221px" %)process|(% style="width:528px" %)Process
544 +|(% style="width:221px" %) |(% style="width:528px" %)ProcessStep
545 +|(% style="width:221px" %) |(% style="width:528px" %)Transition
546 +|(% style="width:221px" %) |(% style="width:528px" %)
547 +|(% style="width:221px" %)registry|(% style="width:528px" %)DataConstraint
548 +|(% style="width:221px" %) |(% style="width:528px" %)MetadataConstraint
549 +|(% style="width:221px" %) |(% style="width:528px" %)MetadataProvisionAgreement
550 +|(% style="width:221px" %) |(% style="width:528px" %)ProvisionAgreement
551 +|(% style="width:221px" %) |(% style="width:528px" %)Subscription
552 +|(% style="width:221px" %) |(% style="width:528px" %)
553 +|(% style="width:221px" %)structuremapping|(% style="width:528px" %)CategorySchemeMap
554 +|(% style="width:221px" %) |(% style="width:528px" %)ConceptSchemeMap
555 +|(% style="width:221px" %) |(% style="width:528px" %)OrganisationSchemeMap
556 +|(% style="width:221px" %) |(% style="width:528px" %)ReportingTaxonomyMap
557 +|(% style="width:221px" %) |(% style="width:528px" %)RepresentationMap
558 +|(% style="width:221px" %) |(% style="width:528px" %)StructureMap
559 +|(% style="width:221px" %) |(% style="width:528px" %)
560 +|(% style="width:221px" %)codelist|(% style="width:528px" %)Code
561 +|(% style="width:221px" %) |(% style="width:528px" %)Codelist
562 +|(% style="width:221px" %) |(% style="width:528px" %)HierarchicalCode
563 +|(% style="width:221px" %) |(% style="width:528px" %)Hierarchy
564 +|(% style="width:221px" %) |(% style="width:528px" %)HierarchyAssociation
565 +|(% style="width:221px" %) |(% style="width:528px" %)Level
566 +|(% style="width:221px" %) |(% style="width:528px" %)ValueList
567 +|(% style="width:221px" %) |(% style="width:528px" %)
568 +|(% style="width:221px" %)categoryscheme|(% style="width:528px" %)Categorisation
569 +|(% style="width:221px" %) |(% style="width:528px" %)Category
570 +|(% style="width:221px" %) |(% style="width:528px" %)CategoryScheme
571 +|(% style="width:221px" %) |(% style="width:528px" %)ReportingCategory
572 +|(% style="width:221px" %) |(% style="width:528px" %)ReportingTaxonomy
573 +|(% style="width:221px" %)**Package**|(% style="width:528px" %)**URN class name (model class name where this is different)**
574 +|(% style="width:221px" %) |(% style="width:528px" %)
575 +|(% style="width:221px" %)conceptscheme|(% style="width:528px" %)Concept
576 +|(% style="width:221px" %) |(% style="width:528px" %)ConceptScheme
577 +|(% style="width:221px" %) |(% style="width:528px" %)
578 +|(% style="width:221px" %)transformation|(% style="width:528px" %)CustomType
579 +|(% style="width:221px" %) |(% style="width:528px" %)CustomTypeScheme
580 +|(% style="width:221px" %) |(% style="width:528px" %)NamePersonalisation
581 +|(% style="width:221px" %) |(% style="width:528px" %)NamePersonalisationScheme
582 +|(% style="width:221px" %) |(% style="width:528px" %)Ruleset
583 +|(% style="width:221px" %) |(% style="width:528px" %)RulesetScheme
584 +|(% style="width:221px" %) |(% style="width:528px" %)Transformation
585 +|(% style="width:221px" %) |(% style="width:528px" %)TransformationScheme
586 +|(% style="width:221px" %) |(% style="width:528px" %)UserDefinedOperator
587 +|(% style="width:221px" %) |(% style="width:528px" %)UserDefinedOperatorScheme
588 +|(% style="width:221px" %) |(% style="width:528px" %)VtlCodelistMapping
589 +|(% style="width:221px" %) |(% style="width:528px" %)VtlConceptMapping
590 +|(% style="width:221px" %) |(% style="width:528px" %)VtlDataflowMapping
591 +|(% style="width:221px" %) |(% style="width:528px" %)VtlMappingScheme
592 +|(% style="width:221px" %) |(% style="width:528px" %)
599 599  )))
600 600  
601 601  **Table 2: SDMX-IM Packages and Contained Classes**
602 602  
603 -===== {{id name="_Toc90809"/}}6.2.4 URN Identification components of SDMX objects =====
597 +=== 6.2.4 URN Identification components of SDMX objects ===
604 604  
605 605  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.
606 606  
... ... @@ -608,67 +608,56 @@
608 608  
609 609  urn:sdmx.org.sdmx.infomodel.{package}.{classname}=
610 610  
611 -|**Classname**|**Ending URN pattern**|**Example**
612 -|Agency^^[[(% class="wikiinternallink wikiinternallink" %)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^|agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|ECB:**AGENCIES**(**1.0**).AA
613 -|//AgencyScheme//|agencySchemeAgencyId:**AGENCIES**(**1.0**)|ECB:**AGENCIES**(**1.0**)
614 -|//Categorisation//|categorisationAgencyId:categorisationId(version)|IMF:cat001(1.0.0)
615 -|Category|categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|IMF:SDDS(1.0.0):level_1_category.level_2_category …
616 -|//CategoryScheme//|categorySchemeAgencyId:categorySchemeId(versi on)|IMF:SDDS(1.0.0)
605 +(% style="width:1272.83px" %)
606 +|(% style="width:290px" %)**Classname**|(% style="width:649px" %)**Ending URN pattern**|(% style="width:332px" %)**Example**
607 +|(% style="width:290px" %)Agency^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^|(% style="width:649px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|(% style="width:332px" %)ECB:**AGENCIES**(**1.0**).AA
608 +|(% style="width:290px" %)//AgencyScheme//|(% style="width:649px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**)|(% style="width:332px" %)ECB:**AGENCIES**(**1.0**)
609 +|(% style="width:290px" %)//Categorisation//|(% style="width:649px" %)categorisationAgencyId:categorisationId(version)|(% style="width:332px" %)IMF:cat001(1.0.0)
610 +|(% style="width:290px" %)Category|(% style="width:649px" %)categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|(% style="width:332px" %)IMF:SDDS(1.0.0):level_1_category.level_2_category …
611 +|(% style="width:290px" %)//CategoryScheme//|(% style="width:649px" %)categorySchemeAgencyId:categorySchemeId(versi on)|(% style="width:332px" %)IMF:SDDS(1.0.0)
617 617  
618 -|**Classname**|**Ending URN pattern**|**Example**
619 -|//CategorySchemeMap//|(((
620 -catSchemeMapAgencyId:catSchemeMapId(version
613 +|(% style="width:292px" %)**Classname**|(% style="width:647px" %)**Ending URN pattern**|(% style="width:742px" %)**Example**
614 +|(% style="width:292px" %)//CategorySchemeMap//|(% style="width:647px" %)(((
615 +catSchemeMapAgencyId:catSchemeMapId(version)
616 +)))|(% style="width:742px" %)SDMX:EUROSTAT_SUBJECT_DOMAIN(1.0.0)
617 +|(% style="width:292px" %)Code|(% style="width:647px" %)codeListAgencyId:codelistId(version).codeId|(% style="width:742px" %)SDMX:CL_FREQ(1.0.0).Q
618 +|(% style="width:292px" %)//Codelist//|(% style="width:647px" %)codeListAgencyId:codeListId(version)|(% style="width:742px" %)SDMX:CL_FREQ(1.0.0)
619 +|(% style="width:292px" %)ComponentMap|(% style="width:647px" %)structureMapAgencyId:structureMap(version).com ponentMapId|(% style="width:742px" %)SDMX:BOP_STRUCTURES(1.0.0).REF_AREA_TO_COUNT RY
620 +|(% style="width:292px" %)Concept|(% style="width:647px" %)conceptSchemeAgencyId:conceptSchemeId(versio n).conceptId|(% style="width:742px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0).FREQ
621 +|(% style="width:292px" %)//ConceptScheme//|(% style="width:647px" %)conceptSchemeAgencyId:conceptSchemeId(versio n)|(% style="width:742px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0)
622 +|(% style="width:292px" %)//ConceptSchemeMap//|(% style="width:647px" %)(((
623 +conceptSchemeMapAgencyId:conceptSchemeMap Id(version)
624 +)))|(% style="width:742px" %)SDMX:CONCEPT_MAP(1.0.0)
625 +|(% style="width:292px" %)CustomType|(% style="width:647px" %)customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|(% style="width:742px" %)ECB: CUSTOM_TYPE_SCHEME(1.0.0).CUSTOM_TYPE_1
626 +|(% style="width:292px" %)//CustomTypeScheme//|(% style="width:647px" %)customTypeSchemeAgencyId customTypeSchemeId(version)|(% style="width:742px" %)ECB:CUSTOM_TYPE_SCHEME(1.0.0)
627 +|(% style="width:292px" %)DataAttrribute|(% style="width:647px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dataAttributeId|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0).OBS_STATUS
628 +|(% style="width:292px" %)//DataConstraint//|(% style="width:647px" %)dataConstraintAgencyId:dataConstraintId(version)|(% style="width:742px" %)TFFS:CREDITOR_DATA_CONTENT(1.0.0)
621 621  
622 -)
623 -)))|SDMX:EUROSTAT_SUBJECT_DOMAIN(1.0.0)
624 -|Code|codeListAgencyId:codelistId(version).codeId|SDMX:CL_FREQ(1.0.0).Q
625 -|//Codelist//|codeListAgencyId:codeListId(version)|SDMX:CL_FREQ(1.0.0)
626 -|ComponentMap|structureMapAgencyId:structureMap(version).com ponentMapId|SDMX:BOP_STRUCTURES(1.0.0).REF_AREA_TO_COUNT RY
627 -|Concept|conceptSchemeAgencyId:conceptSchemeId(versio n).conceptId|SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0).FREQ
628 -|//ConceptScheme//|conceptSchemeAgencyId:conceptSchemeId(versio n)|SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0)
629 -|//ConceptSchemeMap//|(((
630 -conceptSchemeMapAgencyId:conceptSchemeMap
631 -
632 -Id(version)
633 -)))|SDMX:CONCEPT_MAP(1.0.0)
634 -|CustomType|customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|ECB: CUSTOM_TYPE_SCHEME(1.0.0).CUSTOM_TYPE_1
635 -|//CustomTypeScheme//|customTypeSchemeAgencyId customTypeSchemeId(version)|ECB:CUSTOM_TYPE_SCHEME(1.0.0)
636 -|DataAttrribute|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dataAttributeId|TFFS:EXT_DEBT(1.0.0).OBS_STATUS
637 -|//DataConstraint//|dataConstraintAgencyId:dataConstraintId(version)|TFFS:CREDITOR_DATA_CONTENT(1.0.0)
638 -
639 -|**Classname**|**Ending URN pattern**|**Example**
640 -|DataConsumer|dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**).dataConsumerId|SDMX:**DATA_CONSUMERS**(**1.0**).CONSUMER_1
641 -|//DataConsumerScheme//|(((
642 -dataConsumerSchemeAgencyId:**DATA_CONSUME**
643 -
644 -**RS**(**1.0**)
645 -)))|SDMX:**DATA_CONSUMERS**(**1.0**)
646 -|//Dataflow//|dataflowAgencyId:dataflowId(version)|TFFS:CRED_EXT_DEBT(1.0.0)
647 -|DataProvider|(((
648 -dataProviderSchemeAgencyId:**DATA_PROVIDERS**(
649 -
650 -**1.0**).dataProviderId
651 -)))|SDMX:**DATA_PROVIDERS**(**1.0**).PROVIDER_1
652 -|//DataProviderScheme//|(((
653 -dataProviderSchemeAgencyId:**DATA_PROVIDERS**(
654 -
655 -**1.0**)
656 -)))|SDMX:**DATA_PROVIDERS**(**1.0**)
657 -|//DataStructure//|dataStructureDefinitionAgencyId:dataStructureDef initionId(version)|TFFS:EXT_DEBT(1.0.0)
658 -|Dimension|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dimensionId|TFFS:EXT_DEBT(1.0.0).FREQ
659 -|(((
630 +|(% style="width:294px" %)**Classname**|(% style="width:645px" %)**Ending URN pattern**|(% style="width:742px" %)**Example**
631 +|(% style="width:294px" %)DataConsumer|(% style="width:645px" %)dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**).dataConsumerId|(% style="width:742px" %)SDMX:**DATA_CONSUMERS**(**1.0**).CONSUMER_1
632 +|(% style="width:294px" %)//DataConsumerScheme//|(% style="width:645px" %)(((
633 +dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**)
634 +)))|(% style="width:742px" %)SDMX:**DATA_CONSUMERS**(**1.0**)
635 +|(% style="width:294px" %)//Dataflow//|(% style="width:645px" %)dataflowAgencyId:dataflowId(version)|(% style="width:742px" %)TFFS:CRED_EXT_DEBT(1.0.0)
636 +|(% style="width:294px" %)DataProvider|(% style="width:645px" %)(((
637 +dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**).dataProviderId
638 +)))|(% style="width:742px" %)SDMX:**DATA_PROVIDERS**(**1.0**).PROVIDER_1
639 +|(% style="width:294px" %)//DataProviderScheme//|(% style="width:645px" %)(((
640 +dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**)
641 +)))|(% style="width:742px" %)SDMX:**DATA_PROVIDERS**(**1.0**)
642 +|(% style="width:294px" %)//DataStructure//|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version)|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0)
643 +|(% style="width:294px" %)Dimension|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dimensionId|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0).FREQ
644 +|(% style="width:294px" %)(((
660 660  DimensionDescriptor
661 661  
662 662  MeasureDescriptor
663 663  
664 664  AttributeDescriptor
665 -)))|(((
650 +)))|(% style="width:645px" %)(((
666 666  dataStructureDefinitionAgencyId:dataStructureDef initionId(version).componentListId
667 667  
668 -where the componentListId is the name of the class (there is only one occurrence of each in the
669 -
670 -Data Structure Definition)
671 -)))|(((
653 +where the componentListId is the name of the class (there is only one occurrence of each in the Data Structure Definition)
654 +)))|(% style="width:742px" %)(((
672 672  TFFS:EXT_DEBT(1.0.0).DimensionDescriptor
673 673  
674 674  TFFS:EXT_DEBT(1.0.0).MeasureDescriptor
... ... @@ -675,83 +675,81 @@
675 675  
676 676  TFFS:EXT_DEBT(1.0.0).AttributeDescriptor
677 677  )))
678 -|GroupDimensionDescriptor|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).groupDimensionDescriptorId|TFFS:EXT_DEBT(1.0.0).SIBLING
679 -|HierarchicalCode|hierarchyAgencyId:hierarchyId(version).hierarchica lCode.hierarchicalCode|UNESCO:H-C-GOV(1.0.0).GOV_CODE1.GOV_CODE1_1
661 +|(% style="width:294px" %)GroupDimensionDescriptor|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).groupDimensionDescriptorId|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0).SIBLING
662 +|(% style="width:294px" %)HierarchicalCode|(% style="width:645px" %)hierarchyAgencyId:hierarchyId(version).hierarchica lCode.hierarchicalCode|(% style="width:742px" %)UNESCO:H-C-GOV(1.0.0).GOV_CODE1.GOV_CODE1_1
680 680  
681 -|**Classname**|**Ending URN pattern**|**Example**
682 -|//Hierarchy//|hierarchyAgencyId:hierarchyId(version)|UNESCO:H-C-GOV(1.0.0)
683 -|//HierarchyAssociation//|hierarchyAssociationAgencyId:hierarchyAssociatio nId(version)|UNESCO:CL_EXP_SOURCE(1.0.0)
684 -|Level|hierarchyAgencyId:hierarchyId(version).level|UNESCO:H-C-GOV(1.0.0).LVL1
685 -|Measure|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).measureId|TFFS:EXT_DEBT(1.0.0).OBS_VALUE
686 -|MetadataAttribute|(((
664 +|**Classname**|(% style="width:644px" %)**Ending URN pattern**|(% style="width:743px" %)**Example**
665 +|//Hierarchy//|(% style="width:644px" %)hierarchyAgencyId:hierarchyId(version)|(% style="width:743px" %)UNESCO:H-C-GOV(1.0.0)
666 +|//HierarchyAssociation//|(% style="width:644px" %)hierarchyAssociationAgencyId:hierarchyAssociatio nId(version)|(% style="width:743px" %)UNESCO:CL_EXP_SOURCE(1.0.0)
667 +|Level|(% style="width:644px" %)hierarchyAgencyId:hierarchyId(version).level|(% style="width:743px" %)UNESCO:H-C-GOV(1.0.0).LVL1
668 +|Measure|(% style="width:644px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).measureId|(% style="width:743px" %)TFFS:EXT_DEBT(1.0.0).OBS_VALUE
669 +|MetadataAttribute|(% style="width:644px" %)(((
687 687  msdAgencyId:msdId(version).metadataAttributeId.
688 688  
689 689  metadataAttributeId
690 -)))|IMF:SDDS_MSD(1.0.0).COMPILATION.METHOD
691 -|MetadataAttributeDescriptor|msdAgencyId:msdId(version).metadataAttributeDe scriptorId|IMF:SDDS_MSD(1.0.0).MetadataAttributeDescriptor
692 -|//MetadataConstraint//|metadataConstraintAgencyId:metadataConstraintI d(version)|TFFS:CREDITOR_METADATA_CONTENT(1.0.0)
693 -|//Metadataflow//|metadataflowAgencyId:metadataflowId(version)|IMF:SDDS_MDF(1.0.0)
694 -|MetadataProvider|metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**).metadataProviderId|SDMX:**METADATA_PROVIDERS**(**1.0**).MD_PROVIDER_1
695 -|//MetadataProviderScheme//|metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**)|SDMX:**METADATA_PROVIDERS**(**1.0**)
696 -|//MetadataProvisionAgreement//|metadataProvisionAgreementAgencyId:metadataP rovisionAgreementId(version)|IMF:SDDS_MDF_AB(1.0.0)
697 -|//MetadataSet//|metadataProviderId:metadataSetId(version)|MD_PROVIDER:METADATASET(1.0.0)
698 -|//MetadataStructure//|msdAgencyId:msdId(version)|IMF:SDDS_MSD(1.0.0)
673 +)))|(% style="width:743px" %)IMF:SDDS_MSD(1.0.0).COMPILATION.METHOD
674 +|MetadataAttributeDescriptor|(% style="width:644px" %)msdAgencyId:msdId(version).metadataAttributeDe scriptorId|(% style="width:743px" %)IMF:SDDS_MSD(1.0.0).MetadataAttributeDescriptor
675 +|//MetadataConstraint//|(% style="width:644px" %)metadataConstraintAgencyId:metadataConstraintI d(version)|(% style="width:743px" %)TFFS:CREDITOR_METADATA_CONTENT(1.0.0)
676 +|//Metadataflow//|(% style="width:644px" %)metadataflowAgencyId:metadataflowId(version)|(% style="width:743px" %)IMF:SDDS_MDF(1.0.0)
677 +|MetadataProvider|(% style="width:644px" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**).metadataProviderId|(% style="width:743px" %)SDMX:**METADATA_PROVIDERS**(**1.0**).MD_PROVIDER_1
678 +|//MetadataProviderScheme//|(% style="width:644px" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**)|(% style="width:743px" %)SDMX:**METADATA_PROVIDERS**(**1.0**)
679 +|//MetadataProvisionAgreement//|(% style="width:644px" %)metadataProvisionAgreementAgencyId:metadataP rovisionAgreementId(version)|(% style="width:743px" %)IMF:SDDS_MDF_AB(1.0.0)
680 +|//MetadataSet//|(% style="width:644px" %)metadataProviderId:metadataSetId(version)|(% style="width:743px" %)MD_PROVIDER:METADATASET(1.0.0)
681 +|//MetadataStructure//|(% style="width:644px" %)msdAgencyId:msdId(version)|(% style="width:743px" %)IMF:SDDS_MSD(1.0.0)
699 699  
700 -|**Classname**|**Ending URN pattern**|**Example**
701 -|NamePersonalisation|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|ECB:PSN_SCHEME(1.0.0).PSN1234
702 -|//NamePersonalisationScheme//|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|ECB:PSN_SCHEME(1.0.0)
703 -|//OrganisationSchemeMap//|orgSchemeMapAgencyId:orgSchemeMapId(versio n)|SDMX:AGENCIES_PROVIDERS(1.0.0)
704 -|OrganisationUnit|organisationUnitSchemeAgencyId:organisationUni tSchemeId(version).organisationUnitId|ECB:ORGANISATIONS(1.0.0).1F
705 -|//OrganisationUnitScheme//|organisationUnitSchemeAgencyId:organisationUni tSchemeId(version)|ECB:ORGANISATIONS(1.0.0)
706 -|//Process//|processAgencyId:processId{version)|BIS:PROCESS1(1.0.0)
707 -|ProcessStep|(((
683 +|(% style="width:296px" %)**Classname**|(% style="width:646px" %)**Ending URN pattern**|(% style="width:739px" %)**Example**
684 +|(% style="width:296px" %)NamePersonalisation|(% style="width:646px" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|(% style="width:739px" %)ECB:PSN_SCHEME(1.0.0).PSN1234
685 +|(% style="width:296px" %)//NamePersonalisationScheme//|(% style="width:646px" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|(% style="width:739px" %)ECB:PSN_SCHEME(1.0.0)
686 +|(% style="width:296px" %)//OrganisationSchemeMap//|(% style="width:646px" %)orgSchemeMapAgencyId:orgSchemeMapId(versio n)|(% style="width:739px" %)SDMX:AGENCIES_PROVIDERS(1.0.0)
687 +|(% style="width:296px" %)OrganisationUnit|(% style="width:646px" %)organisationUnitSchemeAgencyId:organisationUni tSchemeId(version).organisationUnitId|(% style="width:739px" %)ECB:ORGANISATIONS(1.0.0).1F
688 +|(% style="width:296px" %)//OrganisationUnitScheme//|(% style="width:646px" %)organisationUnitSchemeAgencyId:organisationUni tSchemeId(version)|(% style="width:739px" %)ECB:ORGANISATIONS(1.0.0)
689 +|(% style="width:296px" %)//Process//|(% style="width:646px" %)processAgencyId:processId{version)|(% style="width:739px" %)BIS:PROCESS1(1.0.0)
690 +|(% style="width:296px" %)ProcessStep|(% style="width:646px" %)(((
708 708  processAgencyId:processId(version).processStepId.
709 709  
710 710  processStepId
711 -)))|BIS:PROCESS1(1.0.0).STEP1.STEP1_1
712 -|//ProvisionAgreement//|provisionAgreementAgencyId:provisionAgreement Id(version)|TFFS:CRED_EXT_DEBT_AB(1.0.0)
713 -|ReportingCategory|(((
694 +)))|(% style="width:739px" %)BIS:PROCESS1(1.0.0).STEP1.STEP1_1
695 +|(% style="width:296px" %)//ProvisionAgreement//|(% style="width:646px" %)provisionAgreementAgencyId:provisionAgreement Id(version)|(% style="width:739px" %)TFFS:CRED_EXT_DEBT_AB(1.0.0)
696 +|(% style="width:296px" %)ReportingCategory|(% style="width:646px" %)(((
714 714  reportingTaxonomyAgencyId:
715 715  
716 716  reportingTaxonomyId(version).reportingCategoryI d.reportingCategoryId
717 -)))|IMF:REP_1(1.0.0):LVL1_REP_CAT.LVL2_REP_CAT
718 -|//ReportingTaxonomy//|reportingTaxonomyAgencyId:reportingTaxonomyI d(version)|IMF:REP_1(1.0.0)
719 -|//ReportingTaxonomyMap//|repTaxonomyAgencyId:repTaxonomyId(version)|SDMX:RT_MAP(1.0.0)
700 +)))|(% style="width:739px" %)IMF:REP_1(1.0.0):LVL1_REP_CAT.LVL2_REP_CAT
701 +|(% style="width:296px" %)//ReportingTaxonomy//|(% style="width:646px" %)reportingTaxonomyAgencyId:reportingTaxonomyI d(version)|(% style="width:739px" %)IMF:REP_1(1.0.0)
702 +|(% style="width:296px" %)//ReportingTaxonomyMap//|(% style="width:646px" %)repTaxonomyAgencyId:repTaxonomyId(version)|(% style="width:739px" %)SDMX:RT_MAP(1.0.0)
720 720  
721 -|**Classname**|**Ending URN pattern**|**Example**
722 -|//RepresentationMap//|repMapAgencyId:repMapId(version)|SDMX:REF_AREA_MAPPING(1.0.0)
723 -|Ruleset|rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|ECB:RULESET_23(1.0.0).SET111
724 -|//RulesetScheme//|rulesetSchemeAgencyId rulesetSchemeId(version)|ECB:RULESET_23(1.0.0)
725 -|//StructureMap//|structureMapAgencyId:structureMap(version)|SDMX:BOP_STRUCTURES(1.0.0)
726 -|Subscription|(((
704 +|(% style="width:297px" %)**Classname**|(% style="width:647px" %)**Ending URN pattern**|(% style="width:737px" %)**Example**
705 +|(% style="width:297px" %)//RepresentationMap//|(% style="width:647px" %)repMapAgencyId:repMapId(version)|(% style="width:737px" %)SDMX:REF_AREA_MAPPING(1.0.0)
706 +|(% style="width:297px" %)Ruleset|(% style="width:647px" %)rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|(% style="width:737px" %)ECB:RULESET_23(1.0.0).SET111
707 +|(% style="width:297px" %)//RulesetScheme//|(% style="width:647px" %)rulesetSchemeAgencyId rulesetSchemeId(version)|(% style="width:737px" %)ECB:RULESET_23(1.0.0)
708 +|(% style="width:297px" %)//StructureMap//|(% style="width:647px" %)structureMapAgencyId:structureMap(version)|(% style="width:737px" %)SDMX:BOP_STRUCTURES(1.0.0)
709 +|(% style="width:297px" %)Subscription|(% style="width:647px" %)(((
727 727  The Subscription is not itself an Identifiable Artefact and therefore it does not follow the rules for URN structure.
728 -
729 729  The name of the URN is registryURN There is no pre-determined format.
730 -)))|This cannot be generated by a common mechanism as subscriptions, although maintainable in the sense that they can be submitted and deleted, are not mandated to be created by a maintenance agency and have no versioning mechanism. It is therefore the responsibility of the target registry to generate a unique Id for the Subscription, and for the application creating the subscription to store the registry URN that is returned from the registry in the subscription response message.
731 -|TimeDimension|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).timeDimensionId|TFFS:EXT_DEBT(1.0.0).TIME_PERIOD
732 -|Transformation|transformationSchemeAgencyId transformationSchemeId(version) transformationId|ECB:TRANSFORMATION_SCHEME(1.0.0).TRANS_1
733 -|//TransformationScheme//|transformationSchemeAgencyId transformationSchemeId(version)|ECB: TRANSFORMATION_SCHEME(1.0.0)
734 -|**Classname**|**Ending URN pattern**|**Example**
735 -|Transition|(((
712 +)))|(% style="width:737px" %)This cannot be generated by a common mechanism as subscriptions, although maintainable in the sense that they can be submitted and deleted, are not mandated to be created by a maintenance agency and have no versioning mechanism. It is therefore the responsibility of the target registry to generate a unique Id for the Subscription, and for the application creating the subscription to store the registry URN that is returned from the registry in the subscription response message.
713 +|(% style="width:297px" %)TimeDimension|(% style="width:647px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).timeDimensionId|(% style="width:737px" %)TFFS:EXT_DEBT(1.0.0).TIME_PERIOD
714 +|(% style="width:297px" %)Transformation|(% style="width:647px" %)transformationSchemeAgencyId transformationSchemeId(version) transformationId|(% style="width:737px" %)ECB:TRANSFORMATION_SCHEME(1.0.0).TRANS_1
715 +|(% style="width:297px" %)//TransformationScheme//|(% style="width:647px" %)transformationSchemeAgencyId transformationSchemeId(version)|(% style="width:737px" %)ECB: TRANSFORMATION_SCHEME(1.0.0)
716 +|(% style="width:297px" %)**Classname**|(% style="width:647px" %)**Ending URN pattern**|(% style="width:737px" %)**Example**
717 +|(% style="width:297px" %)Transition|(% style="width:647px" %)(((
736 736  processAgencyId:processId(version).processStepId.
737 -
738 738  transitionId
739 -)))|BIS:PROCESS1(1.0.0).STEP1.TRANSITION1
740 -|UserDefinedOperator|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|ECB:OS_CALC(1.2.0).OS267
741 -|//UserDefinedOperatorScheme//|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|ECB:OS_CALC(1.2.0)
742 -|//ValueList//|valuelistAgencyId:valuelistId(version)|SDMX:VLIST(1.0.0)
743 -|VtlCodelistMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|ECB:CLIST_MP(2.0.0).ABZ
744 -|VtlConceptMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|ECB:CLIST_MP(1.0.0).XYA
745 -|VtlDataflowMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|ECB:CLIST_MP(1.0.0).MOQ
746 -|//VtlMappingScheme//|vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|ECB:CLIST_MP(2.0.0)
720 +)))|(% style="width:737px" %)BIS:PROCESS1(1.0.0).STEP1.TRANSITION1
721 +|(% style="width:297px" %)UserDefinedOperator|(% style="width:647px" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|(% style="width:737px" %)ECB:OS_CALC(1.2.0).OS267
722 +|(% style="width:297px" %)//UserDefinedOperatorScheme//|(% style="width:647px" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|(% style="width:737px" %)ECB:OS_CALC(1.2.0)
723 +|(% style="width:297px" %)//ValueList//|(% style="width:647px" %)valuelistAgencyId:valuelistId(version)|(% style="width:737px" %)SDMX:VLIST(1.0.0)
724 +|(% style="width:297px" %)VtlCodelistMapping|(% style="width:647px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|(% style="width:737px" %)ECB:CLIST_MP(2.0.0).ABZ
725 +|(% style="width:297px" %)VtlConceptMapping|(% style="width:647px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|(% style="width:737px" %)ECB:CLIST_MP(1.0.0).XYA
726 +|(% style="width:297px" %)VtlDataflowMapping|(% style="width:647px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|(% style="width:737px" %)ECB:CLIST_MP(1.0.0).MOQ
727 +|(% style="width:297px" %)//VtlMappingScheme//|(% style="width:647px" %)vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|(% style="width:737px" %)ECB:CLIST_MP(2.0.0)
747 747  
748 748  5**Table 3: Table of identification components for SDMX Identifiable Artefacts**
749 749  
750 -= {{id name="_Toc90810"/}}7 Implementation Notes =
731 += 7 Implementation Notes =
751 751  
752 -=== {{id name="_Toc90811"/}}7.1 Structural Definition Metadata ===
733 +== 7.1 Structural Definition Metadata ==
753 753  
754 -===== {{id name="_Toc90812"/}}7.1.1 Introduction =====
735 +=== 7.1.1 Introduction ===
755 755  
756 756  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.)
757 757  
... ... @@ -767,46 +767,40 @@
767 767  
768 768  The following table lists the Maintainable Artefacts.
769 769  
770 -|(% colspan="2" %)**Maintainable Artefacts**|**Content**
771 -|**Abstract Class**|**Concrete Class**|
772 -|Item Scheme|Codelist|Code
773 -| |Concept Scheme|Concept
774 -| |Category Scheme|Category
775 -| |Organisation Unit Scheme|Organisation Unit
776 -| |Agency Scheme|Agency
777 -| |Data Provider Scheme|Data Provider
778 -| |Metadata Provider Scheme|Metadata Provider
779 -| |Data Consumer Scheme|Data Consumer
780 -| |Reporting Taxonomy|Reporting Category
781 -| |Transformation Scheme|Transformation
782 -| |Custom Type Scheme|Custom Type
783 -| |Name Personalisation Scheme|Name Personalisation
784 -| |Vtl Mapping Scheme|Vtl Codelist Mapping Vtl Concept Mapping
785 -| |Ruleset Scheme|Ruleset
786 -| |User Defined Operator Scheme|User Defined Operator
787 -|Enumerated List|ValueList|Value Item
788 -|Structure|Data Structure Definition|(((
751 +(% style="width:825.835px" %)
752 +|(% colspan="2" style="width:455px" %)**Maintainable Artefacts**|(% style="width:367px" %)**Content**
753 +|(% style="width:160px" %)**Abstract Class**|(% style="width:295px" %)**Concrete Class**|(% style="width:367px" %)
754 +|(% style="width:160px" %)Item Scheme|(% style="width:295px" %)Codelist|(% style="width:367px" %)Code
755 +|(% style="width:160px" %) |(% style="width:295px" %)Concept Scheme|(% style="width:367px" %)Concept
756 +|(% style="width:160px" %) |(% style="width:295px" %)Category Scheme|(% style="width:367px" %)Category
757 +|(% style="width:160px" %) |(% style="width:295px" %)Organisation Unit Scheme|(% style="width:367px" %)Organisation Unit
758 +|(% style="width:160px" %) |(% style="width:295px" %)Agency Scheme|(% style="width:367px" %)Agency
759 +|(% style="width:160px" %) |(% style="width:295px" %)Data Provider Scheme|(% style="width:367px" %)Data Provider
760 +|(% style="width:160px" %) |(% style="width:295px" %)Metadata Provider Scheme|(% style="width:367px" %)Metadata Provider
761 +|(% style="width:160px" %) |(% style="width:295px" %)Data Consumer Scheme|(% style="width:367px" %)Data Consumer
762 +|(% style="width:160px" %) |(% style="width:295px" %)Reporting Taxonomy|(% style="width:367px" %)Reporting Category
763 +|(% style="width:160px" %) |(% style="width:295px" %)Transformation Scheme|(% style="width:367px" %)Transformation
764 +|(% style="width:160px" %) |(% style="width:295px" %)Custom Type Scheme|(% style="width:367px" %)Custom Type
765 +|(% style="width:160px" %) |(% style="width:295px" %)Name Personalisation Scheme|(% style="width:367px" %)Name Personalisation
766 +|(% style="width:160px" %) |(% style="width:295px" %)Vtl Mapping Scheme|(% style="width:367px" %)Vtl Codelist Mapping Vtl Concept Mapping
767 +|(% style="width:160px" %) |(% style="width:295px" %)Ruleset Scheme|(% style="width:367px" %)Ruleset
768 +|(% style="width:160px" %) |(% style="width:295px" %)User Defined Operator Scheme|(% style="width:367px" %)User Defined Operator
769 +|(% style="width:160px" %)Enumerated List|(% style="width:295px" %)ValueList|(% style="width:367px" %)Value Item
770 +|(% style="width:160px" %)Structure|(% style="width:295px" %)Data Structure Definition|(% style="width:367px" %)(((
789 789  Dimension Descriptor
790 -
791 791  Group Dimension Descriptor
792 -
793 793  Dimension
794 -
795 795  Time Dimension
796 -
797 797  Attribute Descriptor
798 -
799 799  Data Attribute
800 -
801 801  Measure Descriptor
802 -
803 803  Measure
804 804  )))
805 -| |Metadata Structure Definition|Metadata Attribute Descriptor Metadata Attribute
806 -|Structure Usage|Dataflow|
807 -| |Metadataflow|
808 -|None|Process|Process Step
809 -|None|Structure Map|(((
780 +|(% style="width:160px" %) |(% style="width:295px" %)Metadata Structure Definition|(% style="width:367px" %)Metadata Attribute Descriptor Metadata Attribute
781 +|(% style="width:160px" %)Structure Usage|(% style="width:295px" %)Dataflow|(% style="width:367px" %)
782 +|(% style="width:160px" %) |(% style="width:295px" %)Metadataflow|(% style="width:367px" %)
783 +|(% style="width:160px" %)None|(% style="width:295px" %)Process|(% style="width:367px" %)Process Step
784 +|(% style="width:160px" %)None|(% style="width:295px" %)Structure Map|(% style="width:367px" %)(((
810 810  Component Map
811 811  
812 812  Epoch Map
... ... @@ -813,44 +813,44 @@
813 813  
814 814  Date Pattern Map
815 815  )))
816 -|None|Representation Map|Representation Mapping
817 -|Item Scheme Map|Organisation Scheme Map|Item Map
818 -| |Concept Scheme Map|Item Map
819 -| |Category Scheme Map|Item Map
820 -| |Reporting Taxonomy Map|Item Map
821 -|None|Provision Agreement|
822 -|None|Metadata Provision Agreement|
823 -|None|Hierarchy|Hierarchical Code
824 -|None|Hierarchy Association|
825 -|None|Categorisation|
826 -|Constraint|Data Constraint|DataKeySet
827 -| | |CubeRegion
828 -|Constraint|Metadata Constraint|MetadataTargetRegion
791 +|(% style="width:160px" %)None|(% style="width:295px" %)Representation Map|(% style="width:367px" %)Representation Mapping
792 +|(% style="width:160px" %)Item Scheme Map|(% style="width:295px" %)Organisation Scheme Map|(% style="width:367px" %)Item Map
793 +|(% style="width:160px" %) |(% style="width:295px" %)Concept Scheme Map|(% style="width:367px" %)Item Map
794 +|(% style="width:160px" %) |(% style="width:295px" %)Category Scheme Map|(% style="width:367px" %)Item Map
795 +|(% style="width:160px" %) |(% style="width:295px" %)Reporting Taxonomy Map|(% style="width:367px" %)Item Map
796 +|(% style="width:160px" %)None|(% style="width:295px" %)Provision Agreement|(% style="width:367px" %)
797 +|(% style="width:160px" %)None|(% style="width:295px" %)Metadata Provision Agreement|(% style="width:367px" %)
798 +|(% style="width:160px" %)None|(% style="width:295px" %)Hierarchy|(% style="width:367px" %)Hierarchical Code
799 +|(% style="width:160px" %)None|(% style="width:295px" %)Hierarchy Association|(% style="width:367px" %)
800 +|(% style="width:160px" %)None|(% style="width:295px" %)Categorisation|(% style="width:367px" %)
801 +|(% style="width:160px" %)Constraint|(% style="width:295px" %)Data Constraint|(% style="width:367px" %)DataKeySet
802 +|(% style="width:160px" %) |(% style="width:295px" %) |(% style="width:367px" %)CubeRegion
803 +|(% style="width:160px" %)Constraint|(% style="width:295px" %)Metadata Constraint|(% style="width:367px" %)MetadataTargetRegion
829 829  
830 830  **Table 4: Table of Maintainable Artefacts for Structural Definition Metadata**
831 831  
832 -===== {{id name="_Toc90813"/}}7.1.2 Item Scheme, Structure =====
807 +=== 7.1.2 Item Scheme, Structure ===
833 833  
834 834  The artefacts included in the structural definitions are:
835 835  
836 836  * 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)
837 -* All types of Enumerated List (ValueList)^^[[(% class="wikiinternallink wikiinternallink" %)^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]](%%)^^
812 +* All types of Enumerated List (ValueList)^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]](%%)^^
838 838  * All types of Structure (Data Structure Definition, Metadata Structure Definition)
839 839  * All types of Structure Usage (Dataflow, Metadataflow)
840 840  
841 -===== {{id name="_Toc90814"/}}7.1.3 Structure Usage =====
816 +=== 7.1.3 Structure Usage ===
842 842  
843 -**7.1.3.1 Structure Usage: Basic Concepts**
818 +==== 7.1.3.1 Structure Usage: Basic Concepts ====
844 844  
845 845  The Structure Usage defines, in its concrete classes of Dataflow and Metadataflow, which flows of data and metadata use which specific Structure, and importantly for the support of data and metadata discovery, the Structure Usage can be linked to one or more Category in one or more Category Scheme using the Categorisation mechanism. This gives the ability for an application to discover data and metadata by “drilling down” the Category Schemes.
846 846  
847 -**7.1.3.2 Structure Usage Schematic**
822 +==== 7.1.3.2 Structure Usage Schematic ====
848 848  
849 849  [[image:SDMX 3.1 Section 5_en_9b750e13.jpg||height="246" width="438"]]
850 850  
851 851  **Figure 9: Schematic of Linking the Data and Metadata Flows to Categories and Structure Definitions**
852 852  
853 -**7.1.3.3 Structure Usage Model**
828 +==== 7.1.3.3 Structure Usage Model ====
854 854  
855 855  [[image:SDMX 3.1 Section 5_en_1c94cbe.jpg||height="548" width="578"]]
856 856  
... ... @@ -868,9 +868,9 @@
868 868  1*. Categorisation to Dataflow and Category
869 869  1*. Categorisation to Metadataflow and Category
870 870  
871 -=== {{id name="_Toc90815"/}}7.2 Data and Metadata Provisioning ===
846 +== 7.2 Data and Metadata Provisioning ==
872 872  
873 -===== {{id name="_Toc90816"/}}7.2.1 Provisioning Agreement: Basic concepts =====
848 +=== 7.2.1 Provisioning Agreement: Basic concepts ===
874 874  
875 875  Data/Metadata provisioning defines a framework in which the provision of different types of statistical data and metadata by various data/metadata providers can be specified and controlled. This framework is the basis on which the existence of data can be made known to the SDMX-enabled community and hence the basis on which data can subsequently be discovered. Such a framework can be used to regulate the data content to facilitate the building of intelligent applications. It can also be used to facilitate the processing implied by service level agreements, or other provisioning agreements in those scenarios that are based on legal directives. Additionally, quality and timeliness metadata can be supported by this framework which makes it practical to implement information supply chain monitoring.
876 876  
... ... @@ -878,7 +878,7 @@
878 878  
879 879  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.
880 880  
881 -===== {{id name="_Toc90817"/}}7.2.2 Provisioning Agreement Model – pull use case =====
856 +=== 7.2.2 Provisioning Agreement Model – pull use case ===
882 882  
883 883  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.
884 884  
... ... @@ -900,9 +900,9 @@
900 900  
901 901  A Provision Agreement is structural metadata. Each Provision Agreement must reference a Data Provider or Metadata Provider and a Dataflow or Metadataflow Definition. The Data/Metadata Provider and the Dataflow/Metadataflow must exist already in order to set up a Metadata Provision or Provision Agreement.
902 902  
903 -=== {{id name="_Toc90818"/}}7.3 Data and Metadata Constraints ===
878 +== 7.3 Data and Metadata Constraints ==
904 904  
905 -===== {{id name="_Toc90819"/}}7.3.1 Data and Metadata Constraints: Basic Concepts =====
880 +=== 7.3.1 Data and Metadata Constraints: Basic Concepts ===
906 906  
907 907  Constraints are, effectively, lists of the valid or actual content of data and metadata. Constraints can be used to specify a subset of the theoretical content of data set or metadata set which can be derived from the specification of the DSD or MSD. A Constraint can comprise a list of keys or a list of content (usually code values) of a specific component such as a dimension or attribute.
908 908  
... ... @@ -916,13 +916,13 @@
916 916  
917 917  In addition, DataAvailabilityConstraints can be extremely useful in a data visualisation system, such as dissemination of statistics on a website. In such a system a Cube Region can be used to specify the Dimension codes that actually exist in a data source (these can be used to build relevant selection tables).
918 918  
919 -===== {{id name="_Toc90820"/}}7.3.2 Data and Metadata Constraints: Schematic =====
894 +=== 7.3.2 Data and Metadata Constraints: Schematic ===
920 920  
921 921  [[image:SDMX 3.1 Section 5_en_28d0cadc.jpg||height="326" width="580"]]
922 922  
923 923  **Figure 14: Schematic of the Constraint and the Artefacts that can be constrained**
924 924  
925 -===== {{id name="_Toc90821"/}}7.3.3 Data and Metadata Constraints: Model =====
900 +=== 7.3.3 Data and Metadata Constraints: Model ===
926 926  
927 927  [[image:SDMX 3.1 Section 5_en_a3184f6a.jpg||height="298" width="579"]]
928 928  
... ... @@ -938,9 +938,9 @@
938 938  
939 939  The content of the Constraint can be found in the SDMX Information Model document.
940 940  
941 -=== {{id name="_Toc90822"/}}7.4 Data Registration ===
916 +== 7.4 Data Registration ==
942 942  
943 -===== {{id name="_Toc90823"/}}7.4.1 Basic Concepts =====
918 +=== 7.4.1 Basic Concepts ===
944 944  
945 945  A Data Provider has published a new dataset conforming to an existing Dataflow (and hence Data Structure Definition). This is implemented as either a web-accessible SDMXML file, or in a database which has a web-services interface capable of responding to an SDMX RESTful query with an SDMX-ML data stream.
946 946  
... ... @@ -950,15 +950,15 @@
950 950  
951 951  SDMX-RR supports dataset registration via the Registration Request, which can be created by the Data Provider (giving the Data Provider maximum control). The registry responds to the registration request with a registration response which indicates if the registration was successful. In the event of an error, the error messages are returned as a registry exception within the response.
952 952  
953 -===== {{id name="_Toc90824"/}}7.4.2 The Registration Request =====
928 +=== 7.4.2 The Registration Request ===
954 954  
955 -**7.4.2.1 Registration Request Schematic**
930 +==== 7.4.2.1 Registration Request Schematic ====
956 956  
957 957  [[image:SDMX 3.1 Section 5_en_293a2ea6.jpg||height="337" width="554"]]
958 958  
959 959  **Figure 16: Schematic of the Objects Concerned with Registration**
960 960  
961 -**7.4.2.2 Registration Request Model**
936 +==== 7.4.2.2 Registration Request Model ====
962 962  
963 963  The following UML diagram shows the composition of the registration request. Each request is made up of one or more Registrations, one per dataset to be registered. The Registration can optionally have information, which has been extracted from the Registration:
964 964  
... ... @@ -970,13 +970,11 @@
970 970  
971 971  The Registration has an action attribute which takes one of the following values:
972 972  
973 -:
974 -
975 975  (((
976 -|**Action Attribute Value**|**Behaviour**
977 -|Append|Add this Registration to the registry
978 -|Replace|Replace the existing Registration with identified by the id in the Registration of the SubmitRegistrationRequest
979 -|Delete|Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest
949 +|(% style="width:224px" %)**Action Attribute Value**|(% style="width:1457px" %)**Behaviour**
950 +|(% style="width:224px" %)Append|(% style="width:1457px" %)Add this Registration to the registry
951 +|(% style="width:224px" %)Replace|(% style="width:1457px" %)Replace the existing Registration with identified by the id in the Registration of the SubmitRegistrationRequest
952 +|(% style="width:224px" %)Delete|(% style="width:1457px" %)Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest
980 980  )))
981 981  
982 982  [[image:SDMX 3.1 Section 5_en_90b3c64a.jpg||height="434" width="579"]]
... ... @@ -995,30 +995,24 @@
995 995  
996 996  https:~/~/github.com/sdmx-twg/sdmx-rest/blob/master/doc/availability.md
997 997  
998 -:
999 -
1000 1000  (((
1001 -|**Indexing Required**|**Registration Process Activity**
1002 -|indexTimeSeries|Extract all the series keys and create a KeySet(s) Constraint.
1003 -|indexDataSet|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.
1004 -|indexReportingPeriod|(((
972 +(% style="width:918.835px" %)
973 +|**Indexing Required**|(% style="width:745px" %)**Registration Process Activity**
974 +|indexTimeSeries|(% style="width:745px" %)Extract all the series keys and create a KeySet(s) Constraint.
975 +|indexDataSet|(% style="width:745px" %)Extract all the codes and other content of the Key value of the Series Key in a Data Set and create one or more Cube Regions containing Member Selections of Dimension Components of the Constraints model in the SDMX-IM, and the associated Selection Value.
976 +|indexReportingPeriod|(% style="width:745px" %)(((
1005 1005  This applies only to a registered __dataset__.
1006 -
1007 1007  Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint.
1008 1008  )))
1009 -|indexAttributes|(((
980 +|indexAttributes|(% style="width:745px" %)(((
1010 1010  **Data Set**
1011 -
1012 1012  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
1013 1013  
1014 1014  **Metadata Set**
1015 -
1016 -Indicate the presence of a Reported Attribute by creating one or more Cube Regions containing Member Selections of Metadata Attribute
1017 -
1018 -Components of the Constraints model in the
985 +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
1019 1019  )))
1020 -|**Indexing Required**|**Registration Process Activity**
1021 -| |SDMX-IM. Note that the content is not stored in the Selection Value.
987 +|**Indexing Required**|(% style="width:745px" %)**Registration Process Activity**
988 +| |(% style="width:745px" %)SDMX-IM. Note that the content is not stored in the Selection Value.
1022 1022  )))
1023 1023  
1024 1024  Constraints that specify the contents of a //QueryDatasource// are submitted to the Registry via the structure submission service (i.e., the RESTful API).
... ... @@ -1025,7 +1025,7 @@
1025 1025  
1026 1026  The Registration must reference the ProvisionAgreement to which it relates.
1027 1027  
1028 -===== {{id name="_Toc90825"/}}7.4.3 Registration Response =====
995 +=== 7.4.3 Registration Response ===
1029 1029  
1030 1030  After a registration request has been submitted to the registry, a response is returned to the submitter indicating success or failure. Given that a registration request can hold many Registrations, then there must be a registration status for each Registration. The SubmitRegistration class has a status field, which is either set to “Success”, “Warning” or “Failure”.
1031 1031  
... ... @@ -1037,7 +1037,7 @@
1037 1037  
1038 1038  **Figure 18: Logical class diagram showing the registration response**
1039 1039  
1040 -=== {{id name="_Toc90826"/}}7.5 Subscription and Notification Service ===
1007 +== 7.5 Subscription and Notification Service ==
1041 1041  
1042 1042  The contents of the SDMX Registry/Repository will change regularly: new code lists and key families will be published and new datasets and metadata-sets will be registered. To obviate the need for users to repeatedly query the registry to see when new information is available, a mechanism is provided to allow users to be notified when these events happen.
1043 1043  
... ... @@ -1045,7 +1045,7 @@
1045 1045  
1046 1046  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”.
1047 1047  
1048 -===== {{id name="_Toc90827"/}}7.5.1 Subscription Logical Class Diagram =====
1015 +=== 7.5.1 Subscription Logical Class Diagram ===
1049 1049  
1050 1050  [[image:SDMX 3.1 Section 5_en_1433df5d.jpg||height="680" width="587"]]
1051 1051