Last modified by Artur on 2025/09/30 13:28
Summary
-
Page properties (2 modified, 0 added, 0 removed)
-
Attachments (0 modified, 0 added, 7 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,0 +1,1 @@ 1 +1 Introduction - Content
-
... ... @@ -1,16 +5,15 @@ 1 -{{box title="**Contents**"}} 2 -{{toc/}} 3 -{{/box}} 4 - 5 5 **Revision History** 6 6 7 -(% style="width:824.835px" %) 8 -|(% style="width:184px" %)**Revision**|(% style="width:195px" %)**Date**|(% style="width:442px" %)**Contents** 9 -|(% style="width:184px" %)DRAFT 1.0|(% style="width:195px" %)December 2024|(% style="width:442px" %)Draft release updated for SDMX 3.1 for public consultation 10 -|(% style="width:184px" %)1.0|(% style="width:195px" %)May 2025|(% style="width:442px" %)Public release for SDMX 3.1 3 +: 11 11 12 -= 1 Introduction = 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 +))) 13 13 11 += {{id name="_Toc90780"/}}1 Introduction = 12 + 14 14 The business vision for SDMX envisages the promotion of a “data sharing” model to facilitate low-cost, high-quality statistical data and metadata exchange. Data sharing reduces the reporting burden of organisations by allowing them to publish data once and let their counterparties “pull” data and related metadata as required. The scenario is based on: 15 15 16 16 * the availability of an abstract information model capable of supporting time series and cross-sectional data, structural metadata, and reference metadata (SDMX-IM) ... ... @@ -31,13 +31,15 @@ 31 31 32 32 These architectural standards address the ‘how’, rather than the ‘what’, and are aimed at enabling existing SDMX standards to achieve their mission. The architectural standards address registry services, which initially comprise: 33 33 34 -* structural metadata repository 35 -* data and metadata registration 36 -* query 33 +• structural metadata repository 37 37 35 +• data and metadata registration 36 + 37 +• query 38 + 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 -= 2 Scope and Normative Status = 41 += {{id name="_Toc90781"/}}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 -= 3 Scope of the SDMX Registry/Repository = 58 += {{id name="_Toc90782"/}}3 Scope of the SDMX Registry/Repository = 58 58 59 -== 3.1 Objective == 60 +=== {{id name="_Toc90783"/}}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 -== 3.2 Structural Metadata == 67 +=== {{id name="_Toc90784"/}}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 -== 3.3 Registration == 93 +=== {{id name="_Toc90785"/}}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 -== 3.4 Notification == 104 +=== {{id name="_Toc90786"/}}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 -== 3.5 Discovery == 110 +=== {{id name="_Toc90787"/}}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 -= 4 SDMX Registry/Repository Architecture = 122 += {{id name="_Toc90788"/}}4 SDMX Registry/Repository Architecture = 122 122 123 -== 4.1 Architectural Schematic == 124 +=== {{id name="_Toc90789"/}}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 -== 4.2 Structural Metadata Repository == 132 +=== {{id name="_Toc90790"/}}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 -== 4.3 Provisioning Metadata Repository == 143 +=== {{id name="_Toc90791"/}}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 -= 5 Registry Interfaces and Services = 149 += {{id name="_Toc90792"/}}5 Registry Interfaces and Services = 149 149 150 -== 5.1 Registry Interfaces == 151 +=== {{id name="_Toc90793"/}}5.1 Registry Interfaces === 151 151 152 152 The Registry Interfaces are: 153 153 ... ... @@ -163,8 +163,9 @@ 163 163 164 164 The registry interfaces are invoked in one of two ways: 165 165 166 -1. The interface is the name of the root node of the SDMX-ML document 167 -1. The interface is invoked as a child element of the RegistryInterface message where the RegistryInterface is the root node of the SDMX-ML document. 167 +* 168 +*1. The interface is the name of the root node of the SDMX-ML document 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. 168 168 169 169 In addition to these interfaces the registry must support a mechanism for submitting and querying for structural metadata. This is detailed in sections 5.2.2 and 5.2.3. 170 170 ... ... @@ -172,25 +172,25 @@ 172 172 173 173 It should be noted that all interactions are assumed to be synchronous, with the exception of Notify Registry Event. This document is sent by the SDMX-RR to all subscribers whenever an even occurs to which any users have subscribed. Thus, it does not conform to the requestresponse pattern, because it is inherently asynchronous. 174 174 175 -== 5.2 Registry Services == 177 +=== {{id name="_Toc90794"/}}5.2 Registry Services === 176 176 177 -=== 5.2.1 Introduction === 179 +===== {{id name="_Toc90795"/}}5.2.1 Introduction ===== 178 178 179 179 The services described in this section do not imply that each is implemented as a discrete web service. 180 180 181 -=== 5.2.2 Structure Submission Service === 183 +===== {{id name="_Toc90796"/}}5.2.2 Structure Submission Service ===== 182 182 183 -The registry must support a mechanism for submitting structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: [[__https:~~/~~/github.com/sdmx-twg/sdmx-rest__>>https://https:github.comsdmx-twgsdmx-rest]]). In order for the architecture to be scalable, the finest-grained piece of structural metadata that can be processed by the SDMX-RR is a MaintainableArtefact, with the exception of Item Schemes, where changes at an Item level is also possible (see next section on the SDMX Information Model).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). 184 184 185 -=== 5.2.3 Structure Query Service === 187 +===== {{id name="_Toc90797"/}}5.2.3 Structure Query Service ===== 186 186 187 -The registry must support a mechanism for querying for structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: [[__https:~~/~~/github.com/sdmx-twg/sdmx-rest__>>https://https:github.comsdmx-twgsdmx-rest]]). The registry response to this query mechanism is the SDMX Structure message, which has as its root node: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: 188 188 189 - *Structure191 +• Structure 190 190 191 -The SDMX structural artefacts that may be queried are defined in the SDMX structure web service specification which is compatible with this release of the standard __[[https:~~/~~/github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md>>https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]] __[[https:~~/~~/github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md>>https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]]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]] 192 192 193 -=== 5.2.4 Data and Reference Metadata Registration Service === 195 +===== {{id name="_Toc90798"/}}5.2.4 Data and Reference Metadata Registration Service ===== 194 194 195 195 This service must implement the following Registry Interfaces: 196 196 ... ... @@ -213,24 +213,23 @@ 213 213 214 214 The Registration has an action attribute which takes one of the following values: 215 215 216 -(% style="width:893.835px" %) 217 -|(% style="width:241px" %)**Action Attribute Value**|(% style="width:650px" %)**Behaviour** 218 -|(% style="width:241px" %)Append|(% style="width:650px" %)Add this registration to the registry 219 -|(% style="width:241px" %)Replace|(% style="width:650px" %)Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request 220 -|(% style="width:241px" %)Delete|(% style="width:650px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request 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 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 -(% style="width:896.835px" %) 225 -|**Boolean Attribute**|(% style="width:712px" %)**Behaviour if Value is “true”** 226 -|indexTimeSeries|(% style="width:712px" %)A compliant indexing application must index all the time series keys 227 -|indexDataSet|(% style="width:712px" %)((( 225 +|**Boolean Attribute**|**Behaviour if Value is “true”** 226 +|indexTimeSeries|A compliant indexing application must index all the time series keys 227 +|indexDataSet|((( 228 228 A compliant indexing application must index the range of actual (present) values for each dimension of the Dataset. 229 + 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| (% style="width:712px" %)A compliant indexing application must index the time period range(s) for which data are present in the Dataset.232 +|indexReportingPeriod|A compliant indexing application must index the time period range(s) for which data are present in the Dataset. 232 232 233 -=== 5.2.5 Data Discovery === 234 +===== {{id name="_Toc90799"/}}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 -=== 5.2.6 Subscription and Notification === 241 +===== {{id name="_Toc90800"/}}5.2.6 Subscription and Notification ===== 241 241 242 242 The Subscription and Notification Service implements the following Registry Interfaces: 243 243 ... ... @@ -256,32 +256,34 @@ 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 -=== 5.2.7 Registry Behaviour === 260 +===== {{id name="_Toc90801"/}}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 -(% style="width:982.835px" %) 266 -|(% style="width:217px" %)**Interface**|(% style="width:763px" %)**Behaviour** 267 -|(% style="width:217px" %)All|(% style="width:763px" %)((( 266 +|**Interface**|**Behaviour** 267 +|All|((( 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 -a) Be a draft version. 273 -b) Not be explicitly{{footnote}}With semantic versioning, it is allowed to reference a range of artefacts, e.g., a DSD referencing a Codelist with version 1.2.3+ means all patch versions greater than 1.2.3. This means that deleting 1.2.4draft does not break integrity of the aforementioned DSD.{{/footnote}} referenced from any other object in the Registry. 272 +1. Be a draft version. 274 274 274 +b) Not be explicitly^^[[^^1^^>>path:#sdfootnote1sym||name="sdfootnote1anc"]]^^ referenced from any other object in the Registry. 275 + 275 275 4) The semantic versioning rules in the SDMX documentation MUST be obeyed. 276 276 ))) 277 -|(% style="width:217px" %)Structure submission|(% style="width:763px" %)((( 278 -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. 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. 279 279 ))) 280 -| (% style="width:217px" %)SubmitRegistrationRequest|(% style="width:763px" %)If the datasource is a file (simple datasource) then the file MAY be retrieved and indexed according to the Boolean attributes set in the Registration. For a queryable datasource the Registry MAY validate that the source exists and can accept an SDMX data query.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 281 282 -= 6 Identification of SDMX Objects = 285 += {{id name="_Toc90802"/}}6 Identification of SDMX Objects = 283 283 284 -== 6.1 Identification, Versioning, and Maintenance == 287 +=== {{id name="_Toc90803"/}}6.1 Identification, Versioning, and Maintenance === 285 285 286 286 All major classes of the SDMX Information model inherit from one of: 287 287 ... ... @@ -290,7 +290,7 @@ 290 290 * //**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. 291 291 * //**MaintainableArtefact**// – this has all of the above features, plus registry and structure URIs, and an association to the maintenance organisation of the object. 292 292 293 -=== 6.1.1 Identification, Naming, Versioning, and Maintenance Model === 296 +===== {{id name="_Toc90804"/}}6.1.1 Identification, Naming, Versioning, and Maintenance Model ===== 294 294 295 295 [[image:SDMX 3.1 Section 5_en_4a9b2cfc.jpg||height="688" width="587"]] 296 296 ... ... @@ -299,51 +299,60 @@ 299 299 The table below shows the identification and related data attributes to be stored in a registry for objects that are one of: 300 300 301 301 * //Annotable// 302 -* //Identifiable// 303 -* //Nameable// 304 -* //Versionable// 305 -* //Maintainable// 306 306 307 -(% style="width:1038.83px" %) 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" %)((( 313 -AnnotationText in the form of InternationalString 314 -)))|(% colspan="2" %)C|(% colspan="2" %) |(% colspan="2" %)This can have languagespecific variants 315 -|(% colspan="2" rowspan="4" %)//Identifiable//|(% colspan="2" %)All content as for //Annotable// plus|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %) 316 -|(% colspan="2" %)id|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %) 317 -|(% colspan="2" %)uri|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %) 318 -|(% colspan="2" %)urn|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)Although the urn is computable and therefore may not be submitted or stored physically, the Registry must return the urn for each object, and must be able to service a query on an object referenced solely by its urn. 319 -|(% colspan="2" rowspan="3" %)//Nameable//|(% colspan="2" %)((( 320 -All content as for //Identifiable// plus 321 -)))|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %) 322 -|(% colspan="2" %)((( 323 -Name in the form of InternationalString 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" %)((( 317 +AnnotationText in the form of 318 + 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" %)((( 326 +All content as for 327 + 328 +//Identifiable// plus 329 +)))|(% colspan="2" %)|(% colspan="2" %)|(% colspan="2" %) 330 +||(% colspan="2" %)((( 331 +Name in the form of 332 + 333 +InternationalString 324 324 )))|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)This can have language specific variants. 325 -|(% colspan="2" %)((( 326 -Description in the form of InternationalString 335 +||(% colspan="2" %)((( 336 +Description in the form of 337 + 338 +InternationalString 327 327 )))|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)This can have language specific variants. 328 -|(% colspan="2" rowspan="4" %)//Versionable//|(% colspan="2" %)((( 340 +||(% colspan="2" rowspan="4" %)//Versionable//|(% colspan="2" %)((( 329 329 All content as for 330 330 331 331 //Identifiable// plus 332 -)))|(% colspan="2" %) |(% colspan="2" %)|(% colspan="2" %)333 -|(% colspan="2" %)version|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)This is the version number according to SDMX versioning rules. 334 -|(% colspan="2" %)validFrom|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %) 335 -|(% colspan="2" %)validTo|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %) 336 -|(% colspan="2" %)//Maintainable//|(% colspan="2" %)All content as for //Versionable// plus|(% colspan="2" %) |(% colspan="2" %)|(% colspan="2" %)337 -|(% colspan="2" %) |(% colspan="2" %)isExternalReference|(% 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.338 -|(% colspan="2" %) |(% colspan="2" %)serviceURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the service that can be queried for this resource.339 -|(% colspan="2" %) |(% colspan="2" %)structureURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the resource.340 -|(% colspan="2" %) |(% colspan="2" %)(Maintenance) organisationId|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)The object must be linked to a maintenance organisation, i.e., Agency or Metadata Provider.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.| 341 341 342 342 **Table 1: Common Attributes of Object Types** 343 343 344 -== 6.2 Unique identification of SDMX objects == 356 +=== {{id name="_Toc90805"/}}6.2 Unique identification of SDMX objects === 345 345 346 -=== 6.2.1 Agencies and Metadata Providers === 358 +===== {{id name="_Toc90806"/}}6.2.1 Agencies and Metadata Providers ===== 347 347 348 348 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. 349 349 ... ... @@ -376,11 +376,14 @@ 376 376 377 377 The following organizations maintain an Agency Scheme. 378 378 379 -* SDMX – contains Agencies AA, BB 380 -* AA – contains Agencies CC, DD 381 -* BB – contains Agencies CC, DD 382 -* DD – Contains Agency EE 391 +• SDMX – contains Agencies AA, BB 383 383 393 +• AA – contains Agencies CC, DD 394 + 395 +• BB – contains Agencies CC, DD 396 + 397 +• DD – Contains Agency EE 398 + 384 384 Each agency is identified by its full hierarchy excluding SDMX. 385 385 386 386 e.g., the id of EE as an agencyID is AA.DD.EE ... ... @@ -393,13 +393,13 @@ 393 393 394 394 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. 395 395 396 -=== 6.2.2 Universal Resource Name (URN) === 411 +===== {{id name="_Toc90807"/}}6.2.2 Universal Resource Name (URN) ===== 397 397 398 - ====6.2.2.1 Introduction====413 +**6.2.2.1 Introduction** 399 399 400 400 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.). 401 401 402 - ====6.2.2.2 URN Structure //__Case Rules for URN__//====417 +**6.2.2.2 URN Structure //__Case Rules for URN__//**// // 403 403 404 404 For the URN, all parts of the string are case sensitive. The generic structure of the URN is as follows: 405 405 ... ... @@ -411,7 +411,7 @@ 411 411 412 412 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. 413 413 414 - ====6.2.2.3 Explanation of the generic structure====429 +**6.2.2.3 Explanation of the generic structure** 415 415 416 416 In the explanation below the actual object that is the target of the URN is called the **actual object**. 417 417 ... ... @@ -490,103 +490,103 @@ 490 490 491 491 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. 492 492 493 -=== 6.2.3 Table of SDMX-IM Packages and Classes === 508 +===== {{id name="_Toc90808"/}}6.2.3 Table of SDMX-IM Packages and Classes ===== 494 494 495 495 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. 496 496 497 -(% style="width:750.835px" %) 498 -|(% style="width:222px" %)**Package**|(% style="width:526px" %)**URN class name (model class name where this is different)** 499 -|(% style="width:222px" %)base|(% style="width:526px" %)Agency 500 -|(% style="width:222px" %) |(% style="width:526px" %)AgencyScheme 501 -|(% style="width:222px" %) |(% style="width:526px" %)DataConsumer 502 -|(% style="width:222px" %) |(% style="width:526px" %)DataConsumerScheme 503 -|(% style="width:222px" %) |(% style="width:526px" %)DataProvider 504 -|(% style="width:222px" %) |(% style="width:526px" %)DataProviderScheme 505 -|(% style="width:222px" %) |(% style="width:526px" %)MetadataProvider 506 -|(% style="width:222px" %) |(% style="width:526px" %)MetadataProviderScheme 507 -|(% style="width:222px" %) |(% style="width:526px" %)OrganisationUnit 508 -|(% style="width:222px" %) |(% style="width:526px" %)OrganisationUnitScheme 509 -|(% style="width:222px" %) |(% style="width:526px" %) 510 -|(% style="width:222px" %)datastructure|(% style="width:526px" %)AttributeDescriptor 511 -|(% style="width:222px" %) |(% style="width:526px" %)DataAttribute 512 -|(% style="width:222px" %) |(% style="width:526px" %)Dataflow 513 -|(% style="width:222px" %) |(% style="width:526px" %)DataStructure (DataStructureDefinition) 514 -|(% style="width:222px" %) |(% style="width:526px" %)Dimension 515 -|(% style="width:222px" %) |(% style="width:526px" %)DimensionDescriptor 516 -|(% style="width:222px" %) |(% style="width:526px" %)GroupDimensionDescriptor 517 -|(% style="width:222px" %) |(% style="width:526px" %)Measure 518 -|(% style="width:222px" %) |(% style="width:526px" %)MeasureDescriptor 519 -|(% style="width:222px" %) |(% style="width:526px" %)TimeDimension 520 -|(% style="width:222px" %) |(% style="width:526px" %) 521 -|(% style="width:222px" %)metadatastructure|(% style="width:526px" %)MetadataAttribute 522 -|(% style="width:222px" %) |(% style="width:526px" %)MetadataAttributeDescriptor 523 -|(% style="width:222px" %) |(% style="width:526px" %)((( 512 +|**Package**|**URN class name (model class name where this is different)** 513 +|base|Agency 514 +||AgencyScheme 515 +||DataConsumer 516 +||DataConsumerScheme 517 +||DataProvider 518 +||DataProviderScheme 519 +||MetadataProvider 520 +||MetadataProviderScheme 521 +||OrganisationUnit 522 +||OrganisationUnitScheme 523 +|| 524 +|datastructure|AttributeDescriptor 525 +||DataAttribute 526 +||Dataflow 527 +||DataStructure (DataStructureDefinition) 528 +||Dimension 529 +||DimensionDescriptor 530 +||GroupDimensionDescriptor 531 +||Measure 532 +||MeasureDescriptor 533 +||TimeDimension 534 +|| 535 +|metadatastructure|MetadataAttribute 536 +||MetadataAttributeDescriptor 537 +||((( 524 524 MetadataStructure 525 525 526 526 (MetadataStructureDefinition) 527 527 ))) 528 528 543 +: 544 + 529 529 ((( 530 -(% style="width:751.835px" %) 531 -|(% style="width:221px" %)**Package**|(% style="width:528px" %)**URN class name (model class name where this is different)** 532 -|(% style="width:221px" %) |(% style="width:528px" %)Metadataflow 533 -|(% style="width:221px" %) |(% style="width:528px" %)MetadataSet 534 -|(% style="width:221px" %) |(% style="width:528px" %) 535 -|(% style="width:221px" %)process|(% style="width:528px" %)Process 536 -|(% style="width:221px" %) |(% style="width:528px" %)ProcessStep 537 -|(% style="width:221px" %) |(% style="width:528px" %)Transition 538 -|(% style="width:221px" %) |(% style="width:528px" %) 539 -|(% style="width:221px" %)registry|(% style="width:528px" %)DataConstraint 540 -|(% style="width:221px" %) |(% style="width:528px" %)MetadataConstraint 541 -|(% style="width:221px" %) |(% style="width:528px" %)MetadataProvisionAgreement 542 -|(% style="width:221px" %) |(% style="width:528px" %)ProvisionAgreement 543 -|(% style="width:221px" %) |(% style="width:528px" %)Subscription 544 -|(% style="width:221px" %) |(% style="width:528px" %) 545 -|(% style="width:221px" %)structuremapping|(% style="width:528px" %)CategorySchemeMap 546 -|(% style="width:221px" %) |(% style="width:528px" %)ConceptSchemeMap 547 -|(% style="width:221px" %) |(% style="width:528px" %)OrganisationSchemeMap 548 -|(% style="width:221px" %) |(% style="width:528px" %)ReportingTaxonomyMap 549 -|(% style="width:221px" %) |(% style="width:528px" %)RepresentationMap 550 -|(% style="width:221px" %) |(% style="width:528px" %)StructureMap 551 -|(% style="width:221px" %) |(% style="width:528px" %) 552 -|(% style="width:221px" %)codelist|(% style="width:528px" %)Code 553 -|(% style="width:221px" %) |(% style="width:528px" %)Codelist 554 -|(% style="width:221px" %) |(% style="width:528px" %)HierarchicalCode 555 -|(% style="width:221px" %) |(% style="width:528px" %)Hierarchy 556 -|(% style="width:221px" %) |(% style="width:528px" %)HierarchyAssociation 557 -|(% style="width:221px" %) |(% style="width:528px" %)Level 558 -|(% style="width:221px" %) |(% style="width:528px" %)ValueList 559 -|(% style="width:221px" %) |(% style="width:528px" %) 560 -|(% style="width:221px" %)categoryscheme|(% style="width:528px" %)Categorisation 561 -|(% style="width:221px" %) |(% style="width:528px" %)Category 562 -|(% style="width:221px" %) |(% style="width:528px" %)CategoryScheme 563 -|(% style="width:221px" %) |(% style="width:528px" %)ReportingCategory 564 -|(% style="width:221px" %) |(% style="width:528px" %)ReportingTaxonomy 565 -|(% style="width:221px" %)**Package**|(% style="width:528px" %)**URN class name (model class name where this is different)** 566 -|(% style="width:221px" %) |(% style="width:528px" %) 567 -|(% style="width:221px" %)conceptscheme|(% style="width:528px" %)Concept 568 -|(% style="width:221px" %) |(% style="width:528px" %)ConceptScheme 569 -|(% style="width:221px" %) |(% style="width:528px" %) 570 -|(% style="width:221px" %)transformation|(% style="width:528px" %)CustomType 571 -|(% style="width:221px" %) |(% style="width:528px" %)CustomTypeScheme 572 -|(% style="width:221px" %) |(% style="width:528px" %)NamePersonalisation 573 -|(% style="width:221px" %) |(% style="width:528px" %)NamePersonalisationScheme 574 -|(% style="width:221px" %) |(% style="width:528px" %)Ruleset 575 -|(% style="width:221px" %) |(% style="width:528px" %)RulesetScheme 576 -|(% style="width:221px" %) |(% style="width:528px" %)Transformation 577 -|(% style="width:221px" %) |(% style="width:528px" %)TransformationScheme 578 -|(% style="width:221px" %) |(% style="width:528px" %)UserDefinedOperator 579 -|(% style="width:221px" %) |(% style="width:528px" %)UserDefinedOperatorScheme 580 -|(% style="width:221px" %) |(% style="width:528px" %)VtlCodelistMapping 581 -|(% style="width:221px" %) |(% style="width:528px" %)VtlConceptMapping 582 -|(% style="width:221px" %) |(% style="width:528px" %)VtlDataflowMapping 583 -|(% style="width:221px" %) |(% style="width:528px" %)VtlMappingScheme 584 -|(% style="width:221px" %) |(% style="width:528px" %) 546 +|**Package**|**URN class name (model class name where this is different)** 547 +||Metadataflow 548 +||MetadataSet 549 +|| 550 +|process|Process 551 +||ProcessStep 552 +||Transition 553 +|| 554 +|registry|DataConstraint 555 +||MetadataConstraint 556 +||MetadataProvisionAgreement 557 +||ProvisionAgreement 558 +||Subscription 559 +|| 560 +|structuremapping|CategorySchemeMap 561 +||ConceptSchemeMap 562 +||OrganisationSchemeMap 563 +||ReportingTaxonomyMap 564 +||RepresentationMap 565 +||StructureMap 566 +|| 567 +|codelist|Code 568 +||Codelist 569 +||HierarchicalCode 570 +||Hierarchy 571 +||HierarchyAssociation 572 +||Level 573 +||ValueList 574 +|| 575 +|categoryscheme|Categorisation 576 +||Category 577 +||CategoryScheme 578 +||ReportingCategory 579 +||ReportingTaxonomy 580 +|**Package**|**URN class name (model class name where this is different)** 581 +|| 582 +|conceptscheme|Concept 583 +||ConceptScheme 584 +|| 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 +|| 585 585 ))) 586 586 587 587 **Table 2: SDMX-IM Packages and Contained Classes** 588 588 589 -=== 6.2.4 URN Identification components of SDMX objects === 604 +===== {{id name="_Toc90809"/}}6.2.4 URN Identification components of SDMX objects ===== 590 590 591 591 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. 592 592 ... ... @@ -594,56 +594,67 @@ 594 594 595 595 urn:sdmx.org.sdmx.infomodel.{package}.{classname}= 596 596 597 -(% style="width:1272.83px" %) 598 -|(% style="width:290px" %)**Classname**|(% style="width:649px" %)**Ending URN pattern**|(% style="width:332px" %)**Example** 599 -|(% style="width:290px" %)Agency^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink 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 600 -|(% style="width:290px" %)//AgencyScheme//|(% style="width:649px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**)|(% style="width:332px" %)ECB:**AGENCIES**(**1.0**) 601 -|(% style="width:290px" %)//Categorisation//|(% style="width:649px" %)categorisationAgencyId:categorisationId(version)|(% style="width:332px" %)IMF:cat001(1.0.0) 602 -|(% 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 … 603 -|(% style="width:290px" %)//CategoryScheme//|(% style="width:649px" %)categorySchemeAgencyId:categorySchemeId(versi on)|(% style="width:332px" %)IMF:SDDS(1.0.0) 612 +|**Classname**|**Ending URN pattern**|**Example** 613 +|Agency^^[[^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]]^^|agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|ECB:**AGENCIES**(**1.0**).AA 614 +|//AgencyScheme//|agencySchemeAgencyId:**AGENCIES**(**1.0**)|ECB:**AGENCIES**(**1.0**) 615 +|//Categorisation//|categorisationAgencyId:categorisationId(version)|IMF:cat001(1.0.0) 616 +|Category|categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|IMF:SDDS(1.0.0):level_1_category.level_2_category … 617 +|//CategoryScheme//|categorySchemeAgencyId:categorySchemeId(versi on)|IMF:SDDS(1.0.0) 604 604 605 -|(% style="width:292px" %)**Classname**|(% style="width:647px" %)**Ending URN pattern**|(% style="width:742px" %)**Example** 606 -|(% style="width:292px" %)//CategorySchemeMap//|(% style="width:647px" %)((( 607 -catSchemeMapAgencyId:catSchemeMapId(version) 608 -)))|(% style="width:742px" %)SDMX:EUROSTAT_SUBJECT_DOMAIN(1.0.0) 609 -|(% style="width:292px" %)Code|(% style="width:647px" %)codeListAgencyId:codelistId(version).codeId|(% style="width:742px" %)SDMX:CL_FREQ(1.0.0).Q 610 -|(% style="width:292px" %)//Codelist//|(% style="width:647px" %)codeListAgencyId:codeListId(version)|(% style="width:742px" %)SDMX:CL_FREQ(1.0.0) 611 -|(% 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 612 -|(% style="width:292px" %)Concept|(% style="width:647px" %)conceptSchemeAgencyId:conceptSchemeId(versio n).conceptId|(% style="width:742px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0).FREQ 613 -|(% style="width:292px" %)//ConceptScheme//|(% style="width:647px" %)conceptSchemeAgencyId:conceptSchemeId(versio n)|(% style="width:742px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0) 614 -|(% style="width:292px" %)//ConceptSchemeMap//|(% style="width:647px" %)((( 615 -conceptSchemeMapAgencyId:conceptSchemeMap Id(version) 616 -)))|(% style="width:742px" %)SDMX:CONCEPT_MAP(1.0.0) 617 -|(% style="width:292px" %)CustomType|(% style="width:647px" %)customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|(% style="width:742px" %)ECB: CUSTOM_TYPE_SCHEME(1.0.0).CUSTOM_TYPE_1 618 -|(% style="width:292px" %)//CustomTypeScheme//|(% style="width:647px" %)customTypeSchemeAgencyId customTypeSchemeId(version)|(% style="width:742px" %)ECB:CUSTOM_TYPE_SCHEME(1.0.0) 619 -|(% style="width:292px" %)DataAttrribute|(% style="width:647px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dataAttributeId|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0).OBS_STATUS 620 -|(% style="width:292px" %)//DataConstraint//|(% style="width:647px" %)dataConstraintAgencyId:dataConstraintId(version)|(% style="width:742px" %)TFFS:CREDITOR_DATA_CONTENT(1.0.0) 619 +|**Classname**|**Ending URN pattern**|**Example** 620 +|//CategorySchemeMap//|((( 621 +catSchemeMapAgencyId:catSchemeMapId(version 621 621 622 -|(% style="width:294px" %)**Classname**|(% style="width:645px" %)**Ending URN pattern**|(% style="width:742px" %)**Example** 623 -|(% style="width:294px" %)DataConsumer|(% style="width:645px" %)dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**).dataConsumerId|(% style="width:742px" %)SDMX:**DATA_CONSUMERS**(**1.0**).CONSUMER_1 624 -|(% style="width:294px" %)//DataConsumerScheme//|(% style="width:645px" %)((( 625 -dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**) 626 -)))|(% style="width:742px" %)SDMX:**DATA_CONSUMERS**(**1.0**) 627 -|(% style="width:294px" %)//Dataflow//|(% style="width:645px" %)dataflowAgencyId:dataflowId(version)|(% style="width:742px" %)TFFS:CRED_EXT_DEBT(1.0.0) 628 -|(% style="width:294px" %)DataProvider|(% style="width:645px" %)((( 629 -dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**).dataProviderId 630 -)))|(% style="width:742px" %)SDMX:**DATA_PROVIDERS**(**1.0**).PROVIDER_1 631 -|(% style="width:294px" %)//DataProviderScheme//|(% style="width:645px" %)((( 632 -dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**) 633 -)))|(% style="width:742px" %)SDMX:**DATA_PROVIDERS**(**1.0**) 634 -|(% style="width:294px" %)//DataStructure//|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version)|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0) 635 -|(% style="width:294px" %)Dimension|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dimensionId|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0).FREQ 636 -|(% style="width:294px" %)((( 623 +) 624 +)))|SDMX:EUROSTAT_SUBJECT_DOMAIN(1.0.0) 625 +|Code|codeListAgencyId:codelistId(version).codeId|SDMX:CL_FREQ(1.0.0).Q 626 +|//Codelist//|codeListAgencyId:codeListId(version)|SDMX:CL_FREQ(1.0.0) 627 +|ComponentMap|structureMapAgencyId:structureMap(version).com ponentMapId|SDMX:BOP_STRUCTURES(1.0.0).REF_AREA_TO_COUNT RY 628 +|Concept|conceptSchemeAgencyId:conceptSchemeId(versio n).conceptId|SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0).FREQ 629 +|//ConceptScheme//|conceptSchemeAgencyId:conceptSchemeId(versio n)|SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0) 630 +|//ConceptSchemeMap//|((( 631 +conceptSchemeMapAgencyId:conceptSchemeMap 632 + 633 +Id(version) 634 +)))|SDMX:CONCEPT_MAP(1.0.0) 635 +|CustomType|customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|ECB: CUSTOM_TYPE_SCHEME(1.0.0).CUSTOM_TYPE_1 636 +|//CustomTypeScheme//|customTypeSchemeAgencyId customTypeSchemeId(version)|ECB:CUSTOM_TYPE_SCHEME(1.0.0) 637 +|DataAttrribute|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dataAttributeId|TFFS:EXT_DEBT(1.0.0).OBS_STATUS 638 +|//DataConstraint//|dataConstraintAgencyId:dataConstraintId(version)|TFFS:CREDITOR_DATA_CONTENT(1.0.0) 639 + 640 +|**Classname**|**Ending URN pattern**|**Example** 641 +|DataConsumer|dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**).dataConsumerId|SDMX:**DATA_CONSUMERS**(**1.0**).CONSUMER_1 642 +|//DataConsumerScheme//|((( 643 +dataConsumerSchemeAgencyId:**DATA_CONSUME** 644 + 645 +**RS**(**1.0**) 646 +)))|SDMX:**DATA_CONSUMERS**(**1.0**) 647 +|//Dataflow//|dataflowAgencyId:dataflowId(version)|TFFS:CRED_EXT_DEBT(1.0.0) 648 +|DataProvider|((( 649 +dataProviderSchemeAgencyId:**DATA_PROVIDERS**( 650 + 651 +**1.0**).dataProviderId 652 +)))|SDMX:**DATA_PROVIDERS**(**1.0**).PROVIDER_1 653 +|//DataProviderScheme//|((( 654 +dataProviderSchemeAgencyId:**DATA_PROVIDERS**( 655 + 656 +**1.0**) 657 +)))|SDMX:**DATA_PROVIDERS**(**1.0**) 658 +|//DataStructure//|dataStructureDefinitionAgencyId:dataStructureDef initionId(version)|TFFS:EXT_DEBT(1.0.0) 659 +|Dimension|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dimensionId|TFFS:EXT_DEBT(1.0.0).FREQ 660 +|((( 637 637 DimensionDescriptor 638 638 639 639 MeasureDescriptor 640 640 641 641 AttributeDescriptor 642 -)))|( % style="width:645px" %)(((666 +)))|((( 643 643 dataStructureDefinitionAgencyId:dataStructureDef initionId(version).componentListId 644 644 645 -where the componentListId is the name of the class (there is only one occurrence of each in the Data Structure Definition) 646 -)))|(% style="width:742px" %)((( 669 +where the componentListId is the name of the class (there is only one occurrence of each in the 670 + 671 +Data Structure Definition) 672 +)))|((( 647 647 TFFS:EXT_DEBT(1.0.0).DimensionDescriptor 648 648 649 649 TFFS:EXT_DEBT(1.0.0).MeasureDescriptor ... ... @@ -650,81 +650,83 @@ 650 650 651 651 TFFS:EXT_DEBT(1.0.0).AttributeDescriptor 652 652 ))) 653 -| (% style="width:294px" %)GroupDimensionDescriptor|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).groupDimensionDescriptorId|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0).SIBLING654 -| (% 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_1679 +|GroupDimensionDescriptor|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).groupDimensionDescriptorId|TFFS:EXT_DEBT(1.0.0).SIBLING 680 +|HierarchicalCode|hierarchyAgencyId:hierarchyId(version).hierarchica lCode.hierarchicalCode|UNESCO:H-C-GOV(1.0.0).GOV_CODE1.GOV_CODE1_1 655 655 656 -|**Classname**| (% style="width:644px" %)**Ending URN pattern**|(% style="width:743px" %)**Example**657 -|//Hierarchy//| (% style="width:644px" %)hierarchyAgencyId:hierarchyId(version)|(% style="width:743px" %)UNESCO:H-C-GOV(1.0.0)658 -|//HierarchyAssociation//| (% style="width:644px" %)hierarchyAssociationAgencyId:hierarchyAssociatio nId(version)|(% style="width:743px" %)UNESCO:CL_EXP_SOURCE(1.0.0)659 -|Level| (% style="width:644px" %)hierarchyAgencyId:hierarchyId(version).level|(% style="width:743px" %)UNESCO:H-C-GOV(1.0.0).LVL1660 -|Measure| (% style="width:644px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).measureId|(% style="width:743px" %)TFFS:EXT_DEBT(1.0.0).OBS_VALUE661 -|MetadataAttribute|( % style="width:644px" %)(((682 +|**Classname**|**Ending URN pattern**|**Example** 683 +|//Hierarchy//|hierarchyAgencyId:hierarchyId(version)|UNESCO:H-C-GOV(1.0.0) 684 +|//HierarchyAssociation//|hierarchyAssociationAgencyId:hierarchyAssociatio nId(version)|UNESCO:CL_EXP_SOURCE(1.0.0) 685 +|Level|hierarchyAgencyId:hierarchyId(version).level|UNESCO:H-C-GOV(1.0.0).LVL1 686 +|Measure|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).measureId|TFFS:EXT_DEBT(1.0.0).OBS_VALUE 687 +|MetadataAttribute|((( 662 662 msdAgencyId:msdId(version).metadataAttributeId. 663 663 664 664 metadataAttributeId 665 -)))| (% style="width:743px" %)IMF:SDDS_MSD(1.0.0).COMPILATION.METHOD666 -|MetadataAttributeDescriptor| (% style="width:644px" %)msdAgencyId:msdId(version).metadataAttributeDe scriptorId|(% style="width:743px" %)IMF:SDDS_MSD(1.0.0).MetadataAttributeDescriptor667 -|//MetadataConstraint//| (% style="width:644px" %)metadataConstraintAgencyId:metadataConstraintI d(version)|(% style="width:743px" %)TFFS:CREDITOR_METADATA_CONTENT(1.0.0)668 -|//Metadataflow//| (% style="width:644px" %)metadataflowAgencyId:metadataflowId(version)|(% style="width:743px" %)IMF:SDDS_MDF(1.0.0)669 -|MetadataProvider| (% style="width:644px" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**).metadataProviderId|(% style="width:743px" %)SDMX:**METADATA_PROVIDERS**(**1.0**).MD_PROVIDER_1670 -|//MetadataProviderScheme//| (% style="width:644px" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**)|(% style="width:743px" %)SDMX:**METADATA_PROVIDERS**(**1.0**)671 -|//MetadataProvisionAgreement//| (% style="width:644px" %)metadataProvisionAgreementAgencyId:metadataP rovisionAgreementId(version)|(% style="width:743px" %)IMF:SDDS_MDF_AB(1.0.0)672 -|//MetadataSet//| (% style="width:644px" %)metadataProviderId:metadataSetId(version)|(% style="width:743px" %)MD_PROVIDER:METADATASET(1.0.0)673 -|//MetadataStructure//| (% style="width:644px" %)msdAgencyId:msdId(version)|(% style="width:743px" %)IMF:SDDS_MSD(1.0.0)691 +)))|IMF:SDDS_MSD(1.0.0).COMPILATION.METHOD 692 +|MetadataAttributeDescriptor|msdAgencyId:msdId(version).metadataAttributeDe scriptorId|IMF:SDDS_MSD(1.0.0).MetadataAttributeDescriptor 693 +|//MetadataConstraint//|metadataConstraintAgencyId:metadataConstraintI d(version)|TFFS:CREDITOR_METADATA_CONTENT(1.0.0) 694 +|//Metadataflow//|metadataflowAgencyId:metadataflowId(version)|IMF:SDDS_MDF(1.0.0) 695 +|MetadataProvider|metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**).metadataProviderId|SDMX:**METADATA_PROVIDERS**(**1.0**).MD_PROVIDER_1 696 +|//MetadataProviderScheme//|metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**)|SDMX:**METADATA_PROVIDERS**(**1.0**) 697 +|//MetadataProvisionAgreement//|metadataProvisionAgreementAgencyId:metadataP rovisionAgreementId(version)|IMF:SDDS_MDF_AB(1.0.0) 698 +|//MetadataSet//|metadataProviderId:metadataSetId(version)|MD_PROVIDER:METADATASET(1.0.0) 699 +|//MetadataStructure//|msdAgencyId:msdId(version)|IMF:SDDS_MSD(1.0.0) 674 674 675 -| (% style="width:296px" %)**Classname**|(% style="width:646px" %)**Ending URN pattern**|(% style="width:739px" %)**Example**676 -| (% style="width:296px" %)NamePersonalisation|(% style="width:646px" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|(% style="width:739px" %)ECB:PSN_SCHEME(1.0.0).PSN1234677 -| (% style="width:296px" %)//NamePersonalisationScheme//|(% style="width:646px" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|(% style="width:739px" %)ECB:PSN_SCHEME(1.0.0)678 -| (% style="width:296px" %)//OrganisationSchemeMap//|(% style="width:646px" %)orgSchemeMapAgencyId:orgSchemeMapId(versio n)|(% style="width:739px" %)SDMX:AGENCIES_PROVIDERS(1.0.0)679 -| (% style="width:296px" %)OrganisationUnit|(% style="width:646px" %)organisationUnitSchemeAgencyId:organisationUni tSchemeId(version).organisationUnitId|(% style="width:739px" %)ECB:ORGANISATIONS(1.0.0).1F680 -| (% style="width:296px" %)//OrganisationUnitScheme//|(% style="width:646px" %)organisationUnitSchemeAgencyId:organisationUni tSchemeId(version)|(% style="width:739px" %)ECB:ORGANISATIONS(1.0.0)681 -| (% style="width:296px" %)//Process//|(% style="width:646px" %)processAgencyId:processId{version)|(% style="width:739px" %)BIS:PROCESS1(1.0.0)682 -| (% style="width:296px" %)ProcessStep|(% style="width:646px" %)(((701 +|**Classname**|**Ending URN pattern**|**Example** 702 +|NamePersonalisation|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|ECB:PSN_SCHEME(1.0.0).PSN1234 703 +|//NamePersonalisationScheme//|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|ECB:PSN_SCHEME(1.0.0) 704 +|//OrganisationSchemeMap//|orgSchemeMapAgencyId:orgSchemeMapId(versio n)|SDMX:AGENCIES_PROVIDERS(1.0.0) 705 +|OrganisationUnit|organisationUnitSchemeAgencyId:organisationUni tSchemeId(version).organisationUnitId|ECB:ORGANISATIONS(1.0.0).1F 706 +|//OrganisationUnitScheme//|organisationUnitSchemeAgencyId:organisationUni tSchemeId(version)|ECB:ORGANISATIONS(1.0.0) 707 +|//Process//|processAgencyId:processId{version)|BIS:PROCESS1(1.0.0) 708 +|ProcessStep|((( 683 683 processAgencyId:processId(version).processStepId. 684 684 685 685 processStepId 686 -)))| (% style="width:739px" %)BIS:PROCESS1(1.0.0).STEP1.STEP1_1687 -| (% style="width:296px" %)//ProvisionAgreement//|(% style="width:646px" %)provisionAgreementAgencyId:provisionAgreement Id(version)|(% style="width:739px" %)TFFS:CRED_EXT_DEBT_AB(1.0.0)688 -| (% style="width:296px" %)ReportingCategory|(% style="width:646px" %)(((712 +)))|BIS:PROCESS1(1.0.0).STEP1.STEP1_1 713 +|//ProvisionAgreement//|provisionAgreementAgencyId:provisionAgreement Id(version)|TFFS:CRED_EXT_DEBT_AB(1.0.0) 714 +|ReportingCategory|((( 689 689 reportingTaxonomyAgencyId: 690 690 691 691 reportingTaxonomyId(version).reportingCategoryI d.reportingCategoryId 692 -)))| (% style="width:739px" %)IMF:REP_1(1.0.0):LVL1_REP_CAT.LVL2_REP_CAT693 -| (% style="width:296px" %)//ReportingTaxonomy//|(% style="width:646px" %)reportingTaxonomyAgencyId:reportingTaxonomyI d(version)|(% style="width:739px" %)IMF:REP_1(1.0.0)694 -| (% style="width:296px" %)//ReportingTaxonomyMap//|(% style="width:646px" %)repTaxonomyAgencyId:repTaxonomyId(version)|(% style="width:739px" %)SDMX:RT_MAP(1.0.0)718 +)))|IMF:REP_1(1.0.0):LVL1_REP_CAT.LVL2_REP_CAT 719 +|//ReportingTaxonomy//|reportingTaxonomyAgencyId:reportingTaxonomyI d(version)|IMF:REP_1(1.0.0) 720 +|//ReportingTaxonomyMap//|repTaxonomyAgencyId:repTaxonomyId(version)|SDMX:RT_MAP(1.0.0) 695 695 696 -| (% style="width:297px" %)**Classname**|(% style="width:647px" %)**Ending URN pattern**|(% style="width:737px" %)**Example**697 -| (% style="width:297px" %)//RepresentationMap//|(% style="width:647px" %)repMapAgencyId:repMapId(version)|(% style="width:737px" %)SDMX:REF_AREA_MAPPING(1.0.0)698 -| (% style="width:297px" %)Ruleset|(% style="width:647px" %)rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|(% style="width:737px" %)ECB:RULESET_23(1.0.0).SET111699 -| (% style="width:297px" %)//RulesetScheme//|(% style="width:647px" %)rulesetSchemeAgencyId rulesetSchemeId(version)|(% style="width:737px" %)ECB:RULESET_23(1.0.0)700 -| (% style="width:297px" %)//StructureMap//|(%style="width:647px" %)structureMapAgencyId:structureMap(version)|(% style="width:737px" %)SDMX:BOP_STRUCTURES(1.0.0)701 -| (% style="width:297px" %)Subscription|(% style="width:647px" %)(((722 +|**Classname**|**Ending URN pattern**|**Example** 723 +|//RepresentationMap//|repMapAgencyId:repMapId(version)|SDMX:REF_AREA_MAPPING(1.0.0) 724 +|Ruleset|rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|ECB:RULESET_23(1.0.0).SET111 725 +|//RulesetScheme//|rulesetSchemeAgencyId rulesetSchemeId(version)|ECB:RULESET_23(1.0.0) 726 +|//StructureMap//|structureMapAgencyId:structureMap(version)|SDMX:BOP_STRUCTURES(1.0.0) 727 +|Subscription|((( 702 702 The Subscription is not itself an Identifiable Artefact and therefore it does not follow the rules for URN structure. 729 + 703 703 The name of the URN is registryURN There is no pre-determined format. 704 -)))| (% 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.705 -| (% style="width:297px" %)TimeDimension|(% style="width:647px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).timeDimensionId|(% style="width:737px" %)TFFS:EXT_DEBT(1.0.0).TIME_PERIOD706 -| (% style="width:297px" %)Transformation|(% style="width:647px" %)transformationSchemeAgencyId transformationSchemeId(version) transformationId|(% style="width:737px" %)ECB:TRANSFORMATION_SCHEME(1.0.0).TRANS_1707 -| (% style="width:297px" %)//TransformationScheme//|(% style="width:647px" %)transformationSchemeAgencyId transformationSchemeId(version)|(% style="width:737px" %)ECB: TRANSFORMATION_SCHEME(1.0.0)708 -| (% style="width:297px" %)**Classname**|(% style="width:647px" %)**Ending URN pattern**|(% style="width:737px" %)**Example**709 -| (% style="width:297px" %)Transition|(% style="width:647px" %)(((731 +)))|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. 732 +|TimeDimension|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).timeDimensionId|TFFS:EXT_DEBT(1.0.0).TIME_PERIOD 733 +|Transformation|transformationSchemeAgencyId transformationSchemeId(version) transformationId|ECB:TRANSFORMATION_SCHEME(1.0.0).TRANS_1 734 +|//TransformationScheme//|transformationSchemeAgencyId transformationSchemeId(version)|ECB: TRANSFORMATION_SCHEME(1.0.0) 735 +|**Classname**|**Ending URN pattern**|**Example** 736 +|Transition|((( 710 710 processAgencyId:processId(version).processStepId. 738 + 711 711 transitionId 712 -)))| (% style="width:737px" %)BIS:PROCESS1(1.0.0).STEP1.TRANSITION1713 -| (% style="width:297px" %)UserDefinedOperator|(% style="width:647px" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|(% style="width:737px" %)ECB:OS_CALC(1.2.0).OS267714 -| (% style="width:297px" %)//UserDefinedOperatorScheme//|(% style="width:647px" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|(% style="width:737px" %)ECB:OS_CALC(1.2.0)715 -| (% style="width:297px" %)//ValueList//|(% style="width:647px" %)valuelistAgencyId:valuelistId(version)|(% style="width:737px" %)SDMX:VLIST(1.0.0)716 -| (% style="width:297px" %)VtlCodelistMapping|(% style="width:647px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|(% style="width:737px" %)ECB:CLIST_MP(2.0.0).ABZ717 -| (% style="width:297px" %)VtlConceptMapping|(% style="width:647px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|(% style="width:737px" %)ECB:CLIST_MP(1.0.0).XYA718 -| (% style="width:297px" %)VtlDataflowMapping|(% style="width:647px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|(% style="width:737px" %)ECB:CLIST_MP(1.0.0).MOQ719 -| (% style="width:297px" %)//VtlMappingScheme//|(% style="width:647px" %)vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|(% style="width:737px" %)ECB:CLIST_MP(2.0.0)740 +)))|BIS:PROCESS1(1.0.0).STEP1.TRANSITION1 741 +|UserDefinedOperator|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|ECB:OS_CALC(1.2.0).OS267 742 +|//UserDefinedOperatorScheme//|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|ECB:OS_CALC(1.2.0) 743 +|//ValueList//|valuelistAgencyId:valuelistId(version)|SDMX:VLIST(1.0.0) 744 +|VtlCodelistMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|ECB:CLIST_MP(2.0.0).ABZ 745 +|VtlConceptMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|ECB:CLIST_MP(1.0.0).XYA 746 +|VtlDataflowMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|ECB:CLIST_MP(1.0.0).MOQ 747 +|//VtlMappingScheme//|vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|ECB:CLIST_MP(2.0.0) 720 720 721 721 5**Table 3: Table of identification components for SDMX Identifiable Artefacts** 722 722 723 -= 7 Implementation Notes = 751 += {{id name="_Toc90810"/}}7 Implementation Notes = 724 724 725 -== 7.1 Structural Definition Metadata == 753 +=== {{id name="_Toc90811"/}}7.1 Structural Definition Metadata === 726 726 727 -=== 7.1.1 Introduction === 755 +===== {{id name="_Toc90812"/}}7.1.1 Introduction ===== 728 728 729 729 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.) 730 730 ... ... @@ -740,40 +740,46 @@ 740 740 741 741 The following table lists the Maintainable Artefacts. 742 742 743 -(% style="width:825.835px" %) 744 -|(% colspan="2" style="width:455px" %)**Maintainable Artefacts**|(% style="width:367px" %)**Content** 745 -|(% style="width:160px" %)**Abstract Class**|(% style="width:295px" %)**Concrete Class**|(% style="width:367px" %) 746 -|(% style="width:160px" %)Item Scheme|(% style="width:295px" %)Codelist|(% style="width:367px" %)Code 747 -|(% style="width:160px" %) |(% style="width:295px" %)Concept Scheme|(% style="width:367px" %)Concept 748 -|(% style="width:160px" %) |(% style="width:295px" %)Category Scheme|(% style="width:367px" %)Category 749 -|(% style="width:160px" %) |(% style="width:295px" %)Organisation Unit Scheme|(% style="width:367px" %)Organisation Unit 750 -|(% style="width:160px" %) |(% style="width:295px" %)Agency Scheme|(% style="width:367px" %)Agency 751 -|(% style="width:160px" %) |(% style="width:295px" %)Data Provider Scheme|(% style="width:367px" %)Data Provider 752 -|(% style="width:160px" %) |(% style="width:295px" %)Metadata Provider Scheme|(% style="width:367px" %)Metadata Provider 753 -|(% style="width:160px" %) |(% style="width:295px" %)Data Consumer Scheme|(% style="width:367px" %)Data Consumer 754 -|(% style="width:160px" %) |(% style="width:295px" %)Reporting Taxonomy|(% style="width:367px" %)Reporting Category 755 -|(% style="width:160px" %) |(% style="width:295px" %)Transformation Scheme|(% style="width:367px" %)Transformation 756 -|(% style="width:160px" %) |(% style="width:295px" %)Custom Type Scheme|(% style="width:367px" %)Custom Type 757 -|(% style="width:160px" %) |(% style="width:295px" %)Name Personalisation Scheme|(% style="width:367px" %)Name Personalisation 758 -|(% style="width:160px" %) |(% style="width:295px" %)Vtl Mapping Scheme|(% style="width:367px" %)Vtl Codelist Mapping Vtl Concept Mapping 759 -|(% style="width:160px" %) |(% style="width:295px" %)Ruleset Scheme|(% style="width:367px" %)Ruleset 760 -|(% style="width:160px" %) |(% style="width:295px" %)User Defined Operator Scheme|(% style="width:367px" %)User Defined Operator 761 -|(% style="width:160px" %)Enumerated List|(% style="width:295px" %)ValueList|(% style="width:367px" %)Value Item 762 -|(% style="width:160px" %)Structure|(% style="width:295px" %)Data Structure Definition|(% style="width:367px" %)((( 771 +|(% colspan="2" %)**Maintainable Artefacts**|**Content** 772 +|**Abstract Class**|**Concrete Class**| 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 788 +|Enumerated List|ValueList|Value Item 789 +|Structure|Data Structure Definition|((( 763 763 Dimension Descriptor 791 + 764 764 Group Dimension Descriptor 793 + 765 765 Dimension 795 + 766 766 Time Dimension 797 + 767 767 Attribute Descriptor 799 + 768 768 Data Attribute 801 + 769 769 Measure Descriptor 803 + 770 770 Measure 771 771 ))) 772 -| (% style="width:160px" %)|(% style="width:295px" %)Metadata Structure Definition|(% style="width:367px" %)Metadata Attribute Descriptor Metadata Attribute773 -| (% style="width:160px" %)Structure Usage|(% style="width:295px" %)Dataflow|(% style="width:367px" %)774 -| (% style="width:160px" %)|(% style="width:295px" %)Metadataflow|(% style="width:367px" %)775 -| (% style="width:160px" %)None|(% style="width:295px" %)Process|(% style="width:367px" %)Process Step776 -| (% style="width:160px" %)None|(% style="width:295px" %)Structure Map|(% style="width:367px" %)(((806 +||Metadata Structure Definition|Metadata Attribute Descriptor Metadata Attribute 807 +|Structure Usage|Dataflow| 808 +||Metadataflow| 809 +|None|Process|Process Step 810 +|None|Structure Map|((( 777 777 Component Map 778 778 779 779 Epoch Map ... ... @@ -780,44 +780,44 @@ 780 780 781 781 Date Pattern Map 782 782 ))) 783 -| (% style="width:160px" %)None|(% style="width:295px" %)Representation Map|(% style="width:367px" %)Representation Mapping784 -| (% style="width:160px" %)Item Scheme Map|(% style="width:295px" %)Organisation Scheme Map|(% style="width:367px" %)Item Map785 -| (% style="width:160px" %)|(% style="width:295px" %)Concept Scheme Map|(% style="width:367px" %)Item Map786 -| (% style="width:160px" %)|(% style="width:295px" %)Category Scheme Map|(% style="width:367px" %)Item Map787 -| (% style="width:160px" %)|(% style="width:295px" %)Reporting Taxonomy Map|(% style="width:367px" %)Item Map788 -| (% style="width:160px" %)None|(% style="width:295px" %)Provision Agreement|(% style="width:367px" %)789 -| (% style="width:160px" %)None|(% style="width:295px" %)Metadata Provision Agreement|(% style="width:367px" %)790 -| (% style="width:160px" %)None|(% style="width:295px" %)Hierarchy|(% style="width:367px" %)Hierarchical Code791 -| (% style="width:160px" %)None|(% style="width:295px" %)Hierarchy Association|(% style="width:367px" %)792 -| (% style="width:160px" %)None|(% style="width:295px" %)Categorisation|(% style="width:367px" %)793 -| (% style="width:160px" %)Constraint|(% style="width:295px" %)Data Constraint|(% style="width:367px" %)DataKeySet794 -| (% style="width:160px" %)|(% style="width:295px" %)|(% style="width:367px" %)CubeRegion795 -| (% style="width:160px" %)Constraint|(% style="width:295px" %)Metadata Constraint|(% style="width:367px" %)MetadataTargetRegion817 +|None|Representation Map|Representation Mapping 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| 824 +|None|Hierarchy|Hierarchical Code 825 +|None|Hierarchy Association| 826 +|None|Categorisation| 827 +|Constraint|Data Constraint|DataKeySet 828 +|||CubeRegion 829 +|Constraint|Metadata Constraint|MetadataTargetRegion 796 796 797 797 **Table 4: Table of Maintainable Artefacts for Structural Definition Metadata** 798 798 799 -=== 7.1.2 Item Scheme, Structure === 833 +===== {{id name="_Toc90813"/}}7.1.2 Item Scheme, Structure ===== 800 800 801 801 The artefacts included in the structural definitions are: 802 802 803 803 * 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) 804 -* All types of Enumerated List (ValueList)^^[[ (% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]](%%)^^838 +* All types of Enumerated List (ValueList)^^[[^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]]^^ 805 805 * All types of Structure (Data Structure Definition, Metadata Structure Definition) 806 806 * All types of Structure Usage (Dataflow, Metadataflow) 807 807 808 -=== 7.1.3 Structure Usage === 842 +===== {{id name="_Toc90814"/}}7.1.3 Structure Usage ===== 809 809 810 - ====7.1.3.1 Structure Usage: Basic Concepts====844 +**7.1.3.1 Structure Usage: Basic Concepts** 811 811 812 812 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. 813 813 814 - ====7.1.3.2 Structure Usage Schematic====848 +**7.1.3.2 Structure Usage Schematic** 815 815 816 816 [[image:SDMX 3.1 Section 5_en_9b750e13.jpg||height="246" width="438"]] 817 817 818 818 **Figure 9: Schematic of Linking the Data and Metadata Flows to Categories and Structure Definitions** 819 819 820 - ====7.1.3.3 Structure Usage Model====854 +**7.1.3.3 Structure Usage Model** 821 821 822 822 [[image:SDMX 3.1 Section 5_en_1c94cbe.jpg||height="548" width="578"]] 823 823 ... ... @@ -835,9 +835,9 @@ 835 835 1*. Categorisation to Dataflow and Category 836 836 1*. Categorisation to Metadataflow and Category 837 837 838 -== 7.2 Data and Metadata Provisioning == 872 +=== {{id name="_Toc90815"/}}7.2 Data and Metadata Provisioning === 839 839 840 -=== 7.2.1 Provisioning Agreement: Basic concepts === 874 +===== {{id name="_Toc90816"/}}7.2.1 Provisioning Agreement: Basic concepts ===== 841 841 842 842 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. 843 843 ... ... @@ -845,7 +845,7 @@ 845 845 846 846 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. 847 847 848 -=== 7.2.2 Provisioning Agreement Model – pull use case === 882 +===== {{id name="_Toc90817"/}}7.2.2 Provisioning Agreement Model – pull use case ===== 849 849 850 850 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. 851 851 ... ... @@ -867,9 +867,9 @@ 867 867 868 868 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. 869 869 870 -== 7.3 Data and Metadata Constraints == 904 +=== {{id name="_Toc90818"/}}7.3 Data and Metadata Constraints === 871 871 872 -=== 7.3.1 Data and Metadata Constraints: Basic Concepts === 906 +===== {{id name="_Toc90819"/}}7.3.1 Data and Metadata Constraints: Basic Concepts ===== 873 873 874 874 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. 875 875 ... ... @@ -883,13 +883,13 @@ 883 883 884 884 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). 885 885 886 -=== 7.3.2 Data and Metadata Constraints: Schematic === 920 +===== {{id name="_Toc90820"/}}7.3.2 Data and Metadata Constraints: Schematic ===== 887 887 888 888 [[image:SDMX 3.1 Section 5_en_28d0cadc.jpg||height="326" width="580"]] 889 889 890 890 **Figure 14: Schematic of the Constraint and the Artefacts that can be constrained** 891 891 892 -=== 7.3.3 Data and Metadata Constraints: Model === 926 +===== {{id name="_Toc90821"/}}7.3.3 Data and Metadata Constraints: Model ===== 893 893 894 894 [[image:SDMX 3.1 Section 5_en_a3184f6a.jpg||height="298" width="579"]] 895 895 ... ... @@ -905,9 +905,9 @@ 905 905 906 906 The content of the Constraint can be found in the SDMX Information Model document. 907 907 908 -== 7.4 Data Registration == 942 +=== {{id name="_Toc90822"/}}7.4 Data Registration === 909 909 910 -=== 7.4.1 Basic Concepts === 944 +===== {{id name="_Toc90823"/}}7.4.1 Basic Concepts ===== 911 911 912 912 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. 913 913 ... ... @@ -917,15 +917,15 @@ 917 917 918 918 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. 919 919 920 -=== 7.4.2 The Registration Request === 954 +===== {{id name="_Toc90824"/}}7.4.2 The Registration Request ===== 921 921 922 - ====7.4.2.1 Registration Request Schematic====956 +**7.4.2.1 Registration Request Schematic** 923 923 924 924 [[image:SDMX 3.1 Section 5_en_293a2ea6.jpg||height="337" width="554"]] 925 925 926 926 **Figure 16: Schematic of the Objects Concerned with Registration** 927 927 928 - ====7.4.2.2 Registration Request Model====962 +**7.4.2.2 Registration Request Model** 929 929 930 930 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: 931 931 ... ... @@ -937,11 +937,13 @@ 937 937 938 938 The Registration has an action attribute which takes one of the following values: 939 939 974 +: 975 + 940 940 ((( 941 -| (% style="width:224px" %)**Action Attribute Value**|(% style="width:1457px" %)**Behaviour**942 -| (% style="width:224px" %)Append|(% style="width:1457px" %)Add this Registration to the registry943 -| (% style="width:224px" %)Replace|(% style="width:1457px" %)Replace the existing Registration with identified by the id in the Registration of the SubmitRegistrationRequest944 -| (% style="width:224px" %)Delete|(% style="width:1457px" %)Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest977 +|**Action Attribute Value**|**Behaviour** 978 +|Append|Add this Registration to the registry 979 +|Replace|Replace the existing Registration with identified by the id in the Registration of the SubmitRegistrationRequest 980 +|Delete|Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest 945 945 ))) 946 946 947 947 [[image:SDMX 3.1 Section 5_en_90b3c64a.jpg||height="434" width="579"]] ... ... @@ -960,24 +960,30 @@ 960 960 961 961 https:~/~/github.com/sdmx-twg/sdmx-rest/blob/master/doc/availability.md 962 962 999 +: 1000 + 963 963 ((( 964 -(% style="width:918.835px" %) 965 -|**Indexing Required**|(% style="width:745px" %)**Registration Process Activity** 966 -|indexTimeSeries|(% style="width:745px" %)Extract all the series keys and create a KeySet(s) Constraint. 967 -|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. 968 -|indexReportingPeriod|(% style="width:745px" %)((( 1002 +|**Indexing Required**|**Registration Process Activity** 1003 +|indexTimeSeries|Extract all the series keys and create a KeySet(s) Constraint. 1004 +|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. 1005 +|indexReportingPeriod|((( 969 969 This applies only to a registered __dataset__. 1007 + 970 970 Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint. 971 971 ))) 972 -|indexAttributes|( % style="width:745px" %)(((1010 +|indexAttributes|((( 973 973 **Data Set** 1012 + 974 974 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 975 975 976 976 **Metadata Set** 977 -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 1016 + 1017 +Indicate the presence of a Reported Attribute by creating one or more Cube Regions containing Member Selections of Metadata Attribute 1018 + 1019 +Components of the Constraints model in the 978 978 ))) 979 -|**Indexing Required**| (% style="width:745px" %)**Registration Process Activity**980 -| |(% style="width:745px" %)SDMX-IM. Note that the content is not stored in the Selection Value.1021 +|**Indexing Required**|**Registration Process Activity** 1022 +||SDMX-IM. Note that the content is not stored in the Selection Value. 981 981 ))) 982 982 983 983 Constraints that specify the contents of a //QueryDatasource// are submitted to the Registry via the structure submission service (i.e., the RESTful API). ... ... @@ -984,7 +984,7 @@ 984 984 985 985 The Registration must reference the ProvisionAgreement to which it relates. 986 986 987 -=== 7.4.3 Registration Response === 1029 +===== {{id name="_Toc90825"/}}7.4.3 Registration Response ===== 988 988 989 989 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”. 990 990 ... ... @@ -996,7 +996,7 @@ 996 996 997 997 **Figure 18: Logical class diagram showing the registration response** 998 998 999 -== 7.5 Subscription and Notification Service == 1041 +=== {{id name="_Toc90826"/}}7.5 Subscription and Notification Service === 1000 1000 1001 1001 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. 1002 1002 ... ... @@ -1004,13 +1004,13 @@ 1004 1004 1005 1005 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”. 1006 1006 1007 -=== 7.5.1 Subscription Logical Class Diagram === 1049 +===== {{id name="_Toc90827"/}}7.5.1 Subscription Logical Class Diagram ===== 1008 1008 1009 1009 [[image:SDMX 3.1 Section 5_en_1433df5d.jpg||height="680" width="587"]] 1010 1010 1011 1011 **Figure 19: Logical Class Diagram of the Subscription** 1012 1012 1013 -=== 7.5.2 Subscription Information === 1055 +===== {{id name="_Toc90828"/}}7.5.2 Subscription Information ===== 1014 1014 1015 1015 Regardless of the type of registry/repository events being observed, a subscription always contains: 1016 1016 ... ... @@ -1019,16 +1019,18 @@ 1019 1019 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. 1020 1020 1. A selector which specifies which type of events are of interest. The set of event types is: 1021 1021 1064 +: 1065 +:: 1066 + 1022 1022 ((( 1023 -(% style="width:1061.83px" %) 1024 -|**Event Type**|(% style="width:660px" %)**Comment** 1025 -|STRUCTURAL_REPOSITORY_EVENTS|(% style="width:660px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository. 1026 -|DATA_REGISTRATION_EVENTS|(% style="width:660px" %)Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database. 1027 -|METADATA_REGISTRATION_EVENTS|(% style="width:660px" %)Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database. 1028 -|ALL_EVENTS|(% style="width:660px" %)All events of the specified EventType 1068 +|**Event Type**|**Comment** 1069 +|STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository. 1070 +|DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database. 1071 +|METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database. 1072 +|ALL_EVENTS|All events of the specified EventType 1029 1029 ))) 1030 1030 1031 -=== 7.5.3 Wildcard Facility === 1075 +===== {{id name="_Toc90829"/}}7.5.3 Wildcard Facility ===== 1032 1032 1033 1033 Subscription notification supports wildcarded identifier components URNs, which are identifiers which have some or all of their component parts replaced by the wildcard character `*`. Identifier components comprise: 1034 1034 ... ... @@ -1084,29 +1084,30 @@ 1084 1084 1085 1085 The complete SDMX versioning syntax can be found in the SDMX Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”. 1086 1086 1087 -=== 7.5.4 Structural Repository Events === 1131 +===== {{id name="_Toc90830"/}}7.5.4 Structural Repository Events ===== 1088 1088 1089 1089 Whenever a maintainable artefact (data structure definition, concept scheme, codelist, metadata structure definition, category scheme, etc.) is added to, deleted from, or modified in the structural metadata repository, a structural metadata event is triggered. Subscriptions may be set up to monitor all such events, or focus on specific artefacts such as a Data Structure Definition. 1090 1090 1091 -=== 7.5.5 Registration Events === 1135 +===== {{id name="_Toc90831"/}}7.5.5 Registration Events ===== 1092 1092 1093 1093 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: 1094 1094 1139 +: 1140 + 1095 1095 ((( 1096 -(% style="width:1082.83px" %) 1097 -|(% style="width:230px" %)**Selector**|(% style="width:850px" %)**Comment** 1098 -|(% style="width:230px" %)DataProvider|(% style="width:850px" %)Any datasets registered by the specified dataprovider will activate the notification. 1099 -|(% style="width:230px" %)ProvisionAgreement|(% style="width:850px" %)Any datasets for the agreement will activate the notification. 1100 -|(% style="width:230px" %)Dataflow|(% style="width:850px" %)Any datasets for the specified dataflow will activate the notification. 1101 -|(% style="width:230px" %)DataStructureDefinition|(% style="width:850px" %)Any datasets for those dataflows that are based on the specified Data Structure Definition will activate the notification 1102 -|(% style="width:230px" %)Category|(% style="width:850px" %)Any datasets registered for those dataflows, provision agreements that are categorised by the category. 1142 +|**Selector**|**Comment** 1143 +|DataProvider|Any datasets registered by the specified dataprovider will activate the notification. 1144 +|ProvisionAgreement|Any datasets for the agreement will activate the notification. 1145 +|Dataflow|Any datasets for the specified dataflow will activate the notification. 1146 +|DataStructureDefinition|Any datasets for those dataflows that are based on the specified Data Structure Definition will activate the notification 1147 +|Category|Any datasets registered for those dataflows, provision agreements that are categorised by the category. 1103 1103 ))) 1104 1104 1105 1105 The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration. 1106 1106 1107 -== 7.6 Notification == 1152 +== {{id name="_Toc90832"/}}7.6 Notification == 1108 1108 1109 -=== 7.6.1 Logical Class Diagram === 1154 +==== {{id name="_Toc90833"/}}7.6.1 Logical Class Diagram ==== 1110 1110 1111 1111 [[image:SDMX 3.1 Section 5_en_8bc1b889.jpg||height="379" width="579"]] 1112 1112 ... ... @@ -1123,15 +1123,15 @@ 1123 1123 1124 1124 Additionally, supplementary information may be contained in the notification as detailed below. 1125 1125 1126 -=== 7.6.2 Structural Event Component === 1171 +==== {{id name="_Toc90834"/}}7.6.2 Structural Event Component ==== 1127 1127 1128 1128 The notification will contain the MaintainableArtefact that triggered the event in a form similar to the SDMX-ML structural message (using elements from that namespace). 1129 1129 1130 -=== 7.6.3 Registration Event Component === 1175 +==== {{id name="_Toc90835"/}}7.6.3 Registration Event Component ==== 1131 1131 1132 1132 The notification will contain the Registration. 1133 1133 1134 - ----1179 +[[1>>path:#sdfootnote1anc||name="sdfootnote1sym"]] With semantic versioning, it is allowed to reference a range of artefacts, e.g., a DSD referencing a Codelist with version 1.2.3+ means all patch versions greater than 1.2.3. This means that deleting 1.2.4draft does not break integrity of the aforementioned DSD. 1135 1135 1136 1136 [[2>>path:#sdfootnote2anc||name="sdfootnote2sym"]] The identification of an Agency in the URN structure for the maintainable object is by means of the agencyId. The AgencyScheme is not identified as SDMX has a mechanism for identifying an Agency uniquely by its Id. Note that this Id may be hierarchical. For example, a sub-agency of IMF is referred like this: 1137 1137 ... ... @@ -1138,5 +1138,3 @@ 1138 1138 IMF.SubAgency1 1139 1139 1140 1140 [[3>>path:#sdfootnote3anc||name="sdfootnote3sym"]] Note that Codelist is also an EnumeratedList. 1141 - 1142 -{{putFootnotes/}}
- SDMX 3.1 Section 5_en_293a2ea6.jpg
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -45.0 KB - Content
- SDMX 3.1 Section 5_en_6c6c7b74.jpg
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -71.1 KB - Content
- SDMX 3.1 Section 5_en_6e468656.jpg
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -51.1 KB - Content
- SDMX 3.1 Section 5_en_8bc1b889.jpg
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -116.5 KB - Content
- SDMX 3.1 Section 5_en_9b750e13.jpg
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -55.6 KB - Content
- SDMX 3.1 Section 5_en_b08fd1a2.jpg
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -46.3 KB - Content
- SDMX 3.1 Section 5_en_c63d10ab.jpg
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -101.3 KB - Content