Last modified by Helena on 2025/09/10 11:19
Summary
-
Page properties (2 modified, 0 added, 0 removed)
-
Attachments (0 modified, 0 added, 1 removed)
-
Objects (0 modified, 0 added, 1 removed)
Details
- Page properties
-
- Content
-
... ... @@ -11,7 +11,7 @@ 11 11 |(% style="width:188px" %)1.0|(% style="width:205px" %)October 2021|(% style="width:441px" %)Public release for SDMX 3.0 12 12 ))) 13 13 14 -= 1 Introduction = 14 += {{id name="_Toc93831"/}}1 Introduction = 15 15 16 16 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: 17 17 ... ... @@ -33,10 +33,12 @@ 33 33 34 34 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: 35 35 36 -* structural metadata repository 37 -* data and metadata registration 38 -* query 36 +• structural metadata repository 39 39 38 +• data and metadata registration 39 + 40 +• query 41 + 40 40 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. 41 41 42 42 = {{id name="_Toc93832"/}}2 Scope and Normative Status = ... ... @@ -79,8 +79,7 @@ 79 79 80 80 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_28806f51.jpg||height="539" width="443"]] 81 81 82 -(% class="wikigeneratedid" id="HFigure1:SchematicoftheBasicStructuralArtefactsintheSDMX-IM" %) 83 -**Figure 1: Schematic of the Basic Structural Artefacts in the SDMX-IM** 84 +====== Figure 1: Schematic of the Basic Structural Artefacts in the SDMX-IM ====== 84 84 85 85 Note that in Figure 1 (but also most of the relevant subsequent figures) terms that include both data and metadata have been used. For example: 86 86 ... ... @@ -107,7 +107,7 @@ 107 107 108 108 Notifying interested parties of newly published or re-published data, reference metadata or changes in structural metadata involves: 109 109 110 - *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.111 +• 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. 111 111 112 112 == {{id name="_Toc93838"/}}3.5 Discovery == 113 113 ... ... @@ -166,8 +166,9 @@ 166 166 167 167 The registry interfaces are invoked in one of two ways: 168 168 169 -1. The interface is the name of the root node of the SDMX-ML document 170 -1. The interface is invoked as a child element of the RegistryInterface message where the RegistryInterface is the root node of the SDMX-ML document. 170 +* 171 +*1. The interface is the name of the root node of the SDMX-ML document 172 +*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. 171 171 172 172 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. 173 173 ... ... @@ -183,11 +183,11 @@ 183 183 184 184 === {{id name="_Toc93847"/}}5.2.2 Structure Submission Service === 185 185 186 -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).188 +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). 187 187 188 188 === {{id name="_Toc93848"/}}5.2.3 Structure Query Service === 189 189 190 -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:192 +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: 191 191 192 192 * Structure 193 193 ... ... @@ -243,22 +243,23 @@ 243 243 * that the components (Dimensions, Attributes, Measures, Metadata Attributes, etc.) are consistent with the Data Structure Definition or Metadata Structure Definition; 244 244 * that the valid representations of the concepts to which these components correspond conform to the definition in the Data Structure Definition or Metadata Structure Definition. The Registration has an action attribute which takes one of the following values: 245 245 246 -(% style="width:755.294px" %) 247 -|(% style="width:187px" %)**Action Attribute Value**|(% style="width:566px" %)**Behaviour** 248 -|(% style="width:187px" %)Append|(% style="width:566px" %)Add this registration to the registry 249 -|(% style="width:187px" %)Replace|(% style="width:566px" %)Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request 250 -|(% style="width:187px" %)Delete|(% style="width:566px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request 248 +|**Action Attribute Value**|**Behaviour** 249 +|Append|Add this registration to the registry 250 +|Replace|Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request 251 +|Delete|Delete the existing Registration identified by the id in the Registration of the Submit Registration Request 251 251 252 252 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: 253 253 254 -(% style="width:759.294px" %) 255 -|(% style="width:191px" %)**Boolean Attribute**|(% style="width:565px" %)**Behaviour if Value is “true”** 256 -|(% style="width:191px" %)indexTimeSeries|(% style="width:565px" %)A compliant indexing application must index all the time series keys (for a Dataset registration) or metadata target values (for a Metadataset registration) 257 -|(% style="width:191px" %)indexDataSet|(% style="width:565px" %)((( 258 -A compliant indexing application must index the range of actual (present) values for each dimension of the Dataset (for a Dataset registration) or the range of actual (present) values for each Metadata Attribute which takes an enumerated value. 255 +|**Boolean Attribute**|**Behaviour if Value is “true”** 256 +|indexTimeSeries|A compliant indexing application must index all the time series keys (for a Dataset registration) or metadata target values (for a Metadataset registration) 257 +|indexDataSet|((( 258 +A compliant indexing application must index the range of actual 259 + 260 +(present) values for each dimension of the Dataset (for a Dataset registration) or the range of actual (present) values for each Metadata Attribute which takes an enumerated value. 261 + 259 259 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 260 260 ))) 261 -| (% style="width:191px" %)indexReportingPeriod|(% style="width:565px" %)A compliant indexing application must index the time period range(s) for which data are present in the Dataset. The validity period of the Metadatasets may also be indexed.264 +|indexReportingPeriod|A compliant indexing application must index the time period range(s) for which data are present in the Dataset. The validity period of the Metadatasets may also be indexed. 262 262 263 263 === {{id name="_Toc93850"/}}5.2.5 Data and Reference Metadata Discovery === 264 264 ... ... @@ -280,7 +280,7 @@ 280 280 Subscription management involves a user submitting a subscription request which contains: 281 281 282 282 * a query or constraint expression in terms of a filter which defines the events for which the user is interested (e.g., new data for a specific dataflow, or for a domain category, or changes to a Data Structure Definition). 283 -* a list of URIs or endpoints to which an XML notification message can be sent. Supported endpoint types will be email (mailto~: ) and HTTP POST (a normal http:~/~/ address);286 +* a list of URIs or endpoints to which an XML notification message can be sent. Supported endpoint types will be email (mailto~:) and HTTP POST (a normal http:~/~/ address); 284 284 * request for a list of submitted subscriptions; 285 285 * deletion of a subscription; 286 286 ... ... @@ -292,9 +292,8 @@ 292 292 293 293 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. 294 294 295 -(% style="width:757.294px" %) 296 -|(% style="width:188px" %)**Interface**|(% style="width:542px" %)**Behaviour** 297 -|(% style="width:188px" %)All|(% style="width:542px" %)((( 298 +|**Interface**|**Behaviour** 299 +|All|((( 298 298 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. 299 299 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. 300 300 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: ... ... @@ -301,12 +301,14 @@ 301 301 302 302 a) Be a draft version. 303 303 ))) 304 -|(% style="width:188px" %) |(% style="width:542px" %)((( 305 -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.4-draft does not break integrity of the aforementioned DSD.{{/footnote}} referenced from any other object in the Registry. 306 +|**Interface**|**Behaviour** 307 +| |((( 308 +b) Not be explicitly^^[[(% class="wikiinternallink wikiinternallink" %)^^1^^>>path:#sdfootnote1sym||name="sdfootnote1anc"]](%%)^^ referenced from any other object in the Registry. 309 + 306 306 4) The semantic versioning rules in the SDMX documentation MUST be obeyed. 307 307 ))) 308 -| (% style="width:188px" %)Structure submission|(% style="width:542px" %)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.309 -| (% style="width:188px" %)SubmitRegistrationRequest|(% style="width:542px" %)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.312 +|Structure submission|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. 313 +|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. 310 310 311 311 = {{id name="_Toc93853"/}}6 Identification of SDMX Objects = 312 312 ... ... @@ -327,42 +327,43 @@ 327 327 328 328 The table below shows the identification and related data attributes to be stored in a registry for objects that are one of: 329 329 330 -* //nnotable// 334 +* //Annotable// 331 331 * //Identifiable// 332 332 * //Nameable// 333 333 * //Versionable// 334 334 * //Maintainable// 335 335 340 +: 341 + 336 336 ((( 337 -(% style="width:1052.29px" %) 338 -|**Object Type**|(% style="width:241px" %)**Data Attributes**|(% style="width:156px" %)**Status**|**Data type**|(% style="width:457px" %)**Notes** 339 -|(% rowspan="4" %)//Annotable//|(% style="width:241px" %)AnnotationTitle|(% style="width:156px" %)C|string|(% style="width:457px" %) 340 -|(% style="width:241px" %)AnnotationType|(% style="width:156px" %)C|string|(% style="width:457px" %) 341 -|(% style="width:241px" %)AnnotationURN|(% style="width:156px" %)C|string|(% style="width:457px" %) 342 -|(% style="width:241px" %)AnnotationText in the form of InternationalString|(% style="width:156px" %)C| |(% style="width:457px" %)This can have languagespecific variants 343 -|(% rowspan="4" %)//Identifiable//|(% style="width:241px" %)All content as for //Annotable// plus|(% style="width:156px" %) | |(% style="width:457px" %) 344 -|(% style="width:241px" %)id|(% style="width:156px" %)M|string|(% style="width:457px" %) 345 -|(% style="width:241px" %)uri|(% style="width:156px" %)C|string|(% style="width:457px" %) 346 -|(% style="width:241px" %)urn|(% style="width:156px" %)C|string|(% style="width:457px" %)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. 347 -|(% rowspan="3" %)//Nameable//|(% style="width:241px" %)All content as for //Identifiable// plus|(% style="width:156px" %) | |(% style="width:457px" %) 348 -|(% style="width:241px" %)Name in the form of InternationalString|(% style="width:156px" %)M|string|(% style="width:457px" %)This can have language specific variants. 349 -|(% style="width:241px" %)Description in the form of InternationalString|(% style="width:156px" %)C|string|(% style="width:457px" %)This can have language specific variants. 350 -|(% rowspan="4" %)//Versionable//|(% style="width:241px" %)All content as for //Identifiable// plus|(% style="width:156px" %) | |(% style="width:457px" %) 351 -|(% style="width:241px" %)version|(% style="width:156px" %)M|string|(% style="width:457px" %)This is the version number according to SDMX versioning rules. 352 -|(% style="width:241px" %)validFrom|(% style="width:156px" %)C|Date/time|(% style="width:457px" %) 353 -|(% style="width:241px" %)validTo|(% style="width:156px" %)C|Date/time|(% style="width:457px" %) 354 -|//Maintainable//|(% style="width:241px" %)All content as for //Versionable// plus|(% style="width:156px" %) | |(% style="width:457px" %) 355 -| |(% style="width:241px" %)isExternalReference|(% style="width:156px" %)C|boolean|(% style="width:457px" %)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. 356 -| |(% style="width:241px" %)serviceURL|(% style="width:156px" %)C|string|(% style="width:457px" %)The url of the service that can be queried for this resource. 357 -| |(% style="width:241px" %)structureURL|(% style="width:156px" %)C|string|(% style="width:457px" %)The url of the resource. 358 -| |(% style="width:241px" %)(Maintenance) organisationId|(% style="width:156px" %)M|string|(% style="width:457px" %)The object must be linked to a maintenance organisation, i.e., Agency or Metadata Provider. 343 +|**Object Type**|**Data Attributes**|**Status**|**Data type**|**Notes** 344 +|(% rowspan="4" %)//Annotable//|AnnotationTitle|C|string| 345 +|AnnotationType|C|string| 346 +|AnnotationURN|C|string| 347 +|AnnotationText in the form of InternationalString|C| |This can have languagespecific variants 348 +|(% rowspan="4" %)//Identifiable//|All content as for //Annotable// plus| | | 349 +|id|M|string| 350 +|uri|C|string| 351 +|urn|C|string|Although the urn is computable and therefore may not be submitted or stored physically, the Registry must return the urn for each object, and must be able to service a query on an object referenced solely by its urn. 352 +|(% rowspan="3" %)//Nameable//|All content as for //Identifiable// plus| | | 353 +|Name in the form of InternationalString|M|string|This can have language specific variants. 354 +|Description in the form of InternationalString|C|string|This can have language specific variants. 355 +|(% rowspan="4" %)//Versionable//|All content as for //Identifiable// plus| | | 356 +|version|M|string|This is the version number according to SDMX versioning rules. 357 +|validFrom|C|Date/time| 358 +|validTo|C|Date/time| 359 +|//Maintainable//|All content as for //Versionable// plus| | | 360 +| |isExternalReference|C|boolean|Value of “true” indicates that the actual resource is held outside of this registry. The actual reference is given in the registry URI or the structureURL, each of which must return a valid SDMX-ML file. 361 +| |serviceURL|C|string|The url of the service that can be queried for this resource. 362 +| |structureURL|C|string|The url of the resource. 363 +| |(Maintenance) organisationId|M|string|The object must be linked to a maintenance organisation, i.e., Agency or Metadata Provider. 359 359 ))) 360 360 361 361 **Table 1: Common Attributes of Object Types** 362 362 363 -== {{id name="_Toc93856"/}}6.2 Unique identification of SDMX objects == 368 +=== {{id name="_Toc93856"/}}6.2 Unique identification of SDMX objects === 364 364 365 -=== {{id name="_Toc93857"/}}6.2.1 Agencies and Metadata Providers === 370 +===== {{id name="_Toc93857"/}}6.2.1 Agencies and Metadata Providers ===== 366 366 367 367 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. 368 368 ... ... @@ -404,8 +404,32 @@ 404 404 405 405 An example of this is shown in the XML snippet below: 406 406 407 - [[image:1747307906944-697.png]]412 +**<str:Codelists>** 408 408 414 +**<str:Codelist id="CL_FREQ" agencyID="SDMX" version="1.0.0">** 415 + 416 +**<com:Name xml:lang="en">Standard frequency Codelist</com:Name>** 417 + 418 +**</str:Codelist>** 419 + 420 +**<str:Codelist id="CL_FREQ" agencyID="AA" version="1.0.0">** 421 + 422 +**<com:Name xml:lang="en">Codelist maintained by agency AA</com:Name>** 423 + 424 +**</str:Codelist>** 425 + 426 +**<str:Codelist id="CL_FREQ" agencyID="AA.CC" version="1.0.0">** 427 + 428 +**<com:Name xml:lang="en">Codelist maintained by the AA unit CC</com:Name>** 429 + 430 +**</str:Codelist>** 431 + 432 +**<str:Codelist id="CL_FREQ" agencyID="BB.CC" version="1.0.0">** 433 + 434 +**<com:Name xml:lang="en">Codelist maintained by the BB unit CC</com:Name>** 435 + 436 +**</str:Codelist>** 437 + 409 409 **Figure 8: Example Showing Use of Agency Identifiers** 410 410 411 411 Each of these maintenance agencies has an identical Code list with the Id CL_BOP. However, each is uniquely identified by means of the hierarchic agency structure. ... ... @@ -412,16 +412,14 @@ 412 412 413 413 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. 414 414 415 -=== {{id name="_Toc93858"/}}6.2.2 Universal Resource Name (URN) === 444 +===== {{id name="_Toc93858"/}}6.2.2 Universal Resource Name (URN) ===== 416 416 417 - ====6.2.2.1 Introduction====446 +**6.2.2.1 Introduction** 418 418 419 419 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.). 420 420 421 - ====6.2.2.2 URN Structure====450 +**6.2.2.2 URN Structure //__Case Rules for URN__//**// // 422 422 423 -===== **//__Case Rules for URN__//** ===== 424 - 425 425 For the URN, all parts of the string are case sensitive. The generic structure of the URN is as follows: 426 426 427 427 SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobjectid(maintainedobject-version).*containerobject-id.object-id ... ... @@ -432,7 +432,7 @@ 432 432 433 433 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. 434 434 435 - ====6.2.2.3 Explanation of the generic structure====462 +**6.2.2.3 Explanation of the generic structure** 436 436 437 437 In the explanation below the actual object that is the target of the URN is called the **actual object**. 438 438 ... ... @@ -442,23 +442,10 @@ 442 442 443 443 The packages are: 444 444 445 -base 446 -codelist 447 -conceptscheme 448 -datastructure 449 -categoryscheme 450 -registry 451 -metadatastructure 452 -process 453 -structuremapping 454 -transformation 472 +base codelist conceptscheme datastructure categoryscheme registry metadatastructure process structuremapping transformation 455 455 456 -**maintainable-object-id** is the identifier of the maintainable object. This will always be present as all identifiable objects are either a maintainable object or contained in a maintainable object. 474 +**maintainable-object-id** is the identifier of the maintainable object. This will always be present as all identifiable objects are either a maintainable object or contained in a maintainable object. **maintainable-object-version** is the version, according to the SDMX versioning rules, of the maintainable object and is enclosed in parentheses ‘()’, which are always present. **container-object-id** is the identifier of an intermediary object that contains the actual object which the URN is identifying. It is not mandatory as many actual objects do not have an intermediary container object. For instance, a Code is in a maintained object (Codelist) and has no intermediary container object, whereas a MetadataAttribute has an intermediary container object (MetadataAttributeDescriptor) and may have an intermediary container object, which is its parent MetadataAttribute. For this reason, the container object id may repeat, with each repetition identifying the object at the next-lower level in its hierarchy. Note that if there is only a single containing object in the model then it is NOT included in the URN structure. This applies to AttributeDescriptor, DimensionDescriptor, and MeasureDescriptor where there can be only one such object and this object has a fixed id. Therefore, whilst each of these has a URN, the id of the AttributeDescriptor, DimensionDescriptor, and MeasureDescriptor is not included when the actual object is a DataAttribute or a Dimension/ TimeDimension, or a Measure. 457 457 458 -**maintainable-object-version** is the version, according to the SDMX versioning rules, of the maintainable object and is enclosed in parentheses ‘()’, which are always present. 459 - 460 -**container-object-id** is the identifier of an intermediary object that contains the actual object which the URN is identifying. It is not mandatory as many actual objects do not have an intermediary container object. For instance, a Code is in a maintained object (Codelist) and has no intermediary container object, whereas a MetadataAttribute has an intermediary container object (MetadataAttributeDescriptor) and may have an intermediary container object, which is its parent MetadataAttribute. For this reason, the container object id may repeat, with each repetition identifying the object at the next-lower level in its hierarchy. Note that if there is only a single containing object in the model then it is NOT included in the URN structure. This applies to AttributeDescriptor, DimensionDescriptor, and MeasureDescriptor where there can be only one such object and this object has a fixed id. Therefore, whilst each of these has a URN, the id of the AttributeDescriptor, DimensionDescriptor, and MeasureDescriptor is not included when the actual object is a DataAttribute or a Dimension/ TimeDimension, or a Measure. 461 - 462 462 Note that although a Code can have a parent Code and a Concept can have a parent Concept these are maintained in a flat structure and therefore do not have a containerobject-id. 463 463 464 464 For example, the sequence is agency:DSDid(version).DimensionId and not agency:DSDid(version).DimensionDescriptorId.DimensionId. ... ... @@ -465,7 +465,7 @@ 465 465 466 466 object-id is the identifier of the actual object unless the actual object is a //Maintainable// object. If present it is always the last id and is not followed by any other character. 467 467 468 - =====//__**Generic Examples of the URN Structure**__//=====482 +//__**Generic Examples of the URN Structure**__// 469 469 470 470 __Actual object is a maintainable__ 471 471 ... ... @@ -491,27 +491,27 @@ 491 491 492 492 SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version).contained-object-id.contained-object-id contained-objectid.object-id 493 493 494 - =====//__**Concrete Examples of the URN Structure**__//=====508 +//__**Concrete Examples of the URN Structure**__// 495 495 496 496 The Data Structure Definition CRED_EXT_DEBT of legacy version 2.1 maintained by the toplevel Agency TFFS would have the URN: 497 497 498 - urn:sdmx:org.sdmx.infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(2.1)512 +urn:sdmx:org.sdmx.infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(2.1) 499 499 500 500 The URN for a code for Argentina maintained by ISO in the code list CL_3166A2 of semantic version 1.0.0 would be: 501 501 502 - urn:sdmx:org.sdmx.infomodel.codelist.Code=ISO:CL_3166A2(1.0.0).AR516 +urn:sdmx:org.sdmx.infomodel.codelist.Code=ISO:CL_3166A2(1.0.0).AR 503 503 504 504 The URN for a category (id of 1) which has parent category (id of 2) maintained by SDMX in the category scheme SUBJECT_MATTER_DOMAINS of the semantic extended version 1.0.0draft would be: 505 505 506 - urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:SUBJECT_MATT ER_DOMAINS(1.0.0-draft).1.2520 +urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:SUBJECT_MATT ER_DOMAINS(1.0.0-draft).1.2 507 507 508 508 The URN for a Metadata Attribute maintained by SDMX in the MSD CONTACT_METADATA of semantic version 1.0.0 where the hierarchy of the Metadata Attribute is CONTACT_DETAILS/CONTACT_NAME would be: 509 509 510 - urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataAttribute=SDMX: CONTACT_METADATA(1.0.0).CONTACT_DETAILS.CONTACT_NAME524 +urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataAttribute=SDMX: CONTACT_METADATA(1.0.0).CONTACT_DETAILS.CONTACT_NAME 511 511 512 512 The TFFS defines ABC as a sub-Agency of TFFS then the URN of a Dataflow maintained by ABC and identified as EXTERNAL_DEBT of semantic version 1.0.0 would be: 513 513 514 - urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=TFFS.ABC:EXTERNAL_ DEBT(1.0.0)528 +urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=TFFS.ABC:EXTERNAL_ DEBT(1.0.0) 515 515 516 516 The SDMX-RR MUST support this globally unique identification scheme. The SDMX-RR MUST be able to create the URN from the individual identification attributes submitted and to transform the URN to these identification attributes. The identification attributes are: 517 517 ... ... @@ -520,86 +520,85 @@ 520 520 521 521 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. 522 522 523 -=== {{id name="_Toc93859"/}}6.2.3 Table of SDMX-IM Packages and Classes === 537 +===== {{id name="_Toc93859"/}}6.2.3 Table of SDMX-IM Packages and Classes ===== 524 524 525 525 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. 526 526 527 -(% style="width:651.294px" %) 528 -|(% style="width:134px" %)**Package**|(% style="width:502px" %)**URN class name (model class name where this is different)** 529 -|(% style="width:134px" %)base|(% style="width:502px" %)Agency 530 -|(% style="width:134px" %) |(% style="width:502px" %)AgencyScheme 531 -|(% style="width:134px" %) |(% style="width:502px" %)DataConsumer 532 -|(% style="width:134px" %) |(% style="width:502px" %)DataConsumerScheme 533 -|(% style="width:134px" %) |(% style="width:502px" %)DataProvider 534 -|(% style="width:134px" %) |(% style="width:502px" %)DataProviderScheme 535 -|(% style="width:134px" %) |(% style="width:502px" %)MetadataProvider 536 -|(% style="width:134px" %) |(% style="width:502px" %)MetadataProviderScheme 537 -|(% style="width:134px" %) |(% style="width:502px" %)OrganisationUnit 538 -|(% style="width:134px" %) |(% style="width:502px" %)OrganisationUnitScheme 539 -|(% style="width:134px" %)datastructure|(% style="width:502px" %)AttributeDescriptor 540 -|(% style="width:134px" %) |(% style="width:502px" %)DataAttribute 541 -|(% style="width:134px" %) |(% style="width:502px" %)Dataflow 542 -|(% style="width:134px" %) |(% style="width:502px" %)DataStructure (DataStructureDefinition) 543 -|(% style="width:134px" %) |(% style="width:502px" %)Dimension 544 -|(% style="width:134px" %) |(% style="width:502px" %)DimensionDescriptor 545 -|(% style="width:134px" %) |(% style="width:502px" %)GroupDimensionDescriptor 546 -|(% style="width:134px" %) |(% style="width:502px" %)Measure 547 -|(% style="width:134px" %) |(% style="width:502px" %)MeasureDescriptor 548 -|(% style="width:134px" %) |(% style="width:502px" %)TimeDimension 549 -|(% style="width:134px" %) |(% style="width:502px" %) 550 -|(% style="width:134px" %)metadatastructure|(% style="width:502px" %)MetadataAttribute 551 -|(% style="width:134px" %) |(% style="width:502px" %)MetadataAttributeDescriptor 552 -|(% style="width:134px" %) |(% style="width:502px" %)MetadataStructure MetadataStructureDefinition) 553 -|(% style="width:134px" %) |(% style="width:502px" %)Metadataflow 554 -|(% style="width:134px" %) |(% style="width:502px" %)MetadataSet 555 -|(% style="width:134px" %) |(% style="width:502px" %) 556 -|(% style="width:134px" %)process|(% style="width:502px" %)Process 557 -|(% style="width:134px" %) |(% style="width:502px" %)ProcessStep 558 -|(% style="width:134px" %) |(% style="width:502px" %)Transition 559 -|(% style="width:134px" %) |(% style="width:502px" %) 560 -|(% style="width:134px" %)registry|(% style="width:502px" %)DataConstraint 561 -|(% style="width:134px" %) |(% style="width:502px" %)MetadataConstraint 562 -|(% style="width:134px" %) |(% style="width:502px" %)MetadataProvisionAgreement 563 -|(% style="width:134px" %) |(% style="width:502px" %)ProvisionAgreement 564 -|(% style="width:134px" %) |(% style="width:502px" %)Subscription 565 -|(% style="width:134px" %) |(% style="width:502px" %) 566 -|(% style="width:134px" %)structuremapping|(% style="width:502px" %)CategorySchemeMap 567 -|(% style="width:134px" %) |(% style="width:502px" %)ConceptSchemeMap 568 -|(% style="width:134px" %) |(% style="width:502px" %)OrganisationSchemeMap 569 -|(% style="width:134px" %) |(% style="width:502px" %)ReportingTaxonomyMap 570 -|(% style="width:134px" %) |(% style="width:502px" %)RepresentationMap 571 -|(% style="width:134px" %) |(% style="width:502px" %)StructureMap 572 -|(% style="width:134px" %) |(% style="width:502px" %) 573 -|(% style="width:134px" %)codelist|(% style="width:502px" %)Code 574 -|(% style="width:134px" %) |(% style="width:502px" %)Codelist 575 -|(% style="width:134px" %) |(% style="width:502px" %)HierarchicalCode 576 -|(% style="width:134px" %) |(% style="width:502px" %)Hierarchy 577 -|(% style="width:134px" %) |(% style="width:502px" %)HierarchyAssociation 578 -|(% style="width:134px" %) |(% style="width:502px" %)Level 579 -|(% style="width:134px" %) |(% style="width:502px" %)ValueList 580 -|(% style="width:134px" %) |(% style="width:502px" %) 581 -|(% style="width:134px" %)categoryscheme|(% style="width:502px" %)Categorisation 582 -|(% style="width:134px" %) |(% style="width:502px" %)Category 583 -|(% style="width:134px" %) |(% style="width:502px" %)CategoryScheme 584 -|(% style="width:134px" %) |(% style="width:502px" %)ReportingCategory 585 -|(% style="width:134px" %) |(% style="width:502px" %)ReportingTaxonomy 586 -|(% style="width:134px" %)conceptscheme|(% style="width:502px" %)Concept 587 -|(% style="width:134px" %) |(% style="width:502px" %)ConceptScheme 588 -|(% style="width:134px" %) |(% style="width:502px" %) 589 -|(% style="width:134px" %)transformation|(% style="width:502px" %)CustomType 590 -|(% style="width:134px" %) |(% style="width:502px" %)CustomTypeScheme 591 -|(% style="width:134px" %) |(% style="width:502px" %)NamePersonalisation 592 -|(% style="width:134px" %) |(% style="width:502px" %)NamePersonalisationScheme 593 -|(% style="width:134px" %) |(% style="width:502px" %)Ruleset 594 -|(% style="width:134px" %) |(% style="width:502px" %)RulesetScheme 595 -|(% style="width:134px" %) |(% style="width:502px" %)Transformation 596 -|(% style="width:134px" %) |(% style="width:502px" %)TransformationScheme 597 -|(% style="width:134px" %) |(% style="width:502px" %)UserDefinedOperator 598 -|(% style="width:134px" %) |(% style="width:502px" %)UserDefinedOperatorScheme 599 -|(% style="width:134px" %) |(% style="width:502px" %)VtlCodelistMapping 600 -|(% style="width:134px" %) |(% style="width:502px" %)VtlConceptMapping 601 -|(% style="width:134px" %) |(% style="width:502px" %)VtlDataflowMapping 602 -|(% style="width:134px" %) |(% style="width:502px" %)VtlMappingScheme 541 +|**Package**|**URN class name (model class name where this is different)** 542 +|base|Agency 543 +| |AgencyScheme 544 +| |DataConsumer 545 +| |DataConsumerScheme 546 +| |DataProvider 547 +| |DataProviderScheme 548 +| |MetadataProvider 549 +| |MetadataProviderScheme 550 +| |OrganisationUnit 551 +| |OrganisationUnitScheme 552 +|datastructure|AttributeDescriptor 553 +| |DataAttribute 554 +| |Dataflow 555 +| |DataStructure (DataStructureDefinition) 556 +| |Dimension 557 +| |DimensionDescriptor 558 +| |GroupDimensionDescriptor 559 +| |Measure 560 +| |MeasureDescriptor 561 +| |TimeDimension 562 +| | 563 +|metadatastructure|MetadataAttribute 564 +| |MetadataAttributeDescriptor 565 +| |MetadataStructure MetadataStructureDefinition) 566 +| |Metadataflow 567 +| |MetadataSet 568 +| | 569 +|process|Process 570 +| |ProcessStep 571 +| |Transition 572 +| | 573 +|registry|DataConstraint 574 +| |MetadataConstraint 575 +| |MetadataProvisionAgreement 576 +| |ProvisionAgreement 577 +| |Subscription 578 +| | 579 +|structuremapping|CategorySchemeMap 580 +| |ConceptSchemeMap 581 +| |OrganisationSchemeMap 582 +| |ReportingTaxonomyMap 583 +| |RepresentationMap 584 +| |StructureMap 585 +| | 586 +|codelist|Code 587 +| |Codelist 588 +| |HierarchicalCode 589 +| |Hierarchy 590 +| |HierarchyAssociation 591 +| |Level 592 +| |ValueList 593 +| | 594 +|categoryscheme|Categorisation 595 +| |Category 596 +| |CategoryScheme 597 +| |ReportingCategory 598 +| |ReportingTaxonomy 599 +|conceptscheme|Concept 600 +| |ConceptScheme 601 +| | 602 +|transformation|CustomType 603 +| |CustomTypeScheme 604 +| |NamePersonalisation 605 +| |NamePersonalisationScheme 606 +| |Ruleset 607 +| |RulesetScheme 608 +| |Transformation 609 +| |TransformationScheme 610 +| |UserDefinedOperator 611 +| |UserDefinedOperatorScheme 612 +| |VtlCodelistMapping 613 +| |VtlConceptMapping 614 +| |VtlDataflowMapping 615 +| |VtlMappingScheme 603 603 604 604 **Table 2: SDMX-IM Packages and Contained Classes** 605 605 ... ... @@ -611,115 +611,136 @@ 611 611 612 612 urn:sdmx.org.sdmx.infomodel.{package}.{classname}= 613 613 614 -(% style="width:1311.29px" %) 615 -|(% style="width:213px" %)**Classname**|(% style="width:544px" %)**Ending URN pattern**|(% style="width:575px" %)**Example** 616 -|(% style="width:213px" %)Agency{{footnote}}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: IMF.SubAgency1{{/footnote}}|(% style="width:544px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|(% style="width:575px" %)ECB:**AGENCIES**(**1.0**).AA 617 -|(% style="width:213px" %)//AgencyScheme//|(% style="width:544px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**)|(% style="width:575px" %)ECB:**AGENCIES**(**1.0**) 618 -|(% style="width:213px" %)//Categorisation//|(% style="width:544px" %)categorisationAgencyId:categorisationId(version)|(% style="width:575px" %)IMF:cat001(1.0.0) 619 -|(% style="width:213px" %)Category|(% style="width:544px" %)categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|(% style="width:575px" %)IMF:SDDS(1.0.0):level_1_category.level_2_category … 620 -|(% style="width:213px" %)//CategoryScheme//|(% style="width:544px" %)categorySchemeAgencyId:categorySchemeId(versi on)|(% style="width:575px" %)IMF:SDDS(1.0.0) 621 -|(% style="width:213px" %)//CategorySchemeMap//|(% style="width:544px" %)((( 622 -catSchemeMapAgencyId:catSchemeMapId(version) 623 -)))|(% style="width:575px" %)SDMX:EUROSTAT_SUBJECT_DOMAIN(1.0.0) 624 -|(% style="width:213px" %)Code|(% style="width:544px" %)codeListAgencyId:codelistId(version).codeId|(% style="width:575px" %)SDMX:CL_FREQ(1.0.0).Q 625 -|(% style="width:213px" %)//Codelist//|(% style="width:544px" %)codeListAgencyId:codeListId(version)|(% style="width:575px" %)SDMX:CL_FREQ(1.0.0) 626 -|(% style="width:213px" %)ComponentMap|(% style="width:544px" %)structureMapAgencyId:structureMap(version).com ponentMapId|(% style="width:575px" %)SDMX:BOP_STRUCTURES(1.0.0).REF_AREA_TO_COUNT RY 627 -|(% style="width:213px" %)Concept|(% style="width:544px" %)conceptSchemeAgencyId:conceptSchemeId(versio n).conceptId|(% style="width:575px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0).FREQ 628 -|(% style="width:213px" %)//ConceptScheme//|(% style="width:544px" %)conceptSchemeAgencyId:conceptSchemeId(versio n)|(% style="width:575px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0) 629 -|(% style="width:213px" %)//ConceptSchemeMap//|(% style="width:544px" %)((( 627 +|**Classname**|**Ending URN pattern**|**Example** 628 +|Agency^^[[(% class="wikiinternallink wikiinternallink" %)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^|agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|ECB:**AGENCIES**(**1.0**).AA 629 +|//AgencyScheme//|agencySchemeAgencyId:**AGENCIES**(**1.0**)|ECB:**AGENCIES**(**1.0**) 630 +|//Categorisation//|categorisationAgencyId:categorisationId(version)|IMF:cat001(1.0.0) 631 +|Category|categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|IMF:SDDS(1.0.0):level_1_category.level_2_category … 632 +|//CategoryScheme//|categorySchemeAgencyId:categorySchemeId(versi on)|IMF:SDDS(1.0.0) 633 + 634 +|**Classname**|**Ending URN pattern**|**Example** 635 +|//CategorySchemeMap//|((( 636 +catSchemeMapAgencyId:catSchemeMapId(version 637 + 638 +) 639 +)))|SDMX:EUROSTAT_SUBJECT_DOMAIN(1.0.0) 640 +|Code|codeListAgencyId:codelistId(version).codeId|SDMX:CL_FREQ(1.0.0).Q 641 +|//Codelist//|codeListAgencyId:codeListId(version)|SDMX:CL_FREQ(1.0.0) 642 +|ComponentMap|structureMapAgencyId:structureMap(version).com ponentMapId|SDMX:BOP_STRUCTURES(1.0.0).REF_AREA_TO_COUNT RY 643 +|Concept|conceptSchemeAgencyId:conceptSchemeId(versio n).conceptId|SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0).FREQ 644 +|//ConceptScheme//|conceptSchemeAgencyId:conceptSchemeId(versio n)|SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0) 645 +|//ConceptSchemeMap//|((( 630 630 conceptSchemeMapAgencyId:conceptSchemeMap 647 + 631 631 Id(version) 632 -)))| (% style="width:575px" %)SDMX:CONCEPT_MAP(1.0.0)633 -| (% style="width:213px" %)CustomType|(% style="width:544px" %)customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|(% style="width:575px" %)ECB: CUSTOM_TYPE_SCHEME(1.0.0).CUSTOM_TYPE_1634 -| (% style="width:213px" %)//CustomTypeScheme//|(% style="width:544px" %)customTypeSchemeAgencyId customTypeSchemeId(version)|(% style="width:575px" %)ECB:CUSTOM_TYPE_SCHEME(1.0.0)635 -| (% style="width:213px" %)DataAttrribute|(% style="width:544px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dataAttributeId|(% style="width:575px" %)TFFS:EXT_DEBT(1.0.0).OBS_STATUS636 -| (% style="width:213px" %)//DataConstraint//|(% style="width:544px" %)dataConstraintAgencyId:dataConstraintId(version)|(% style="width:575px" %)TFFS:CREDITOR_DATA_CONTENT(1.0.0)649 +)))|SDMX:CONCEPT_MAP(1.0.0) 650 +|CustomType|customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|ECB: CUSTOM_TYPE_SCHEME(1.0.0).CUSTOM_TYPE_1 651 +|//CustomTypeScheme//|customTypeSchemeAgencyId customTypeSchemeId(version)|ECB:CUSTOM_TYPE_SCHEME(1.0.0) 652 +|DataAttrribute|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dataAttributeId|TFFS:EXT_DEBT(1.0.0).OBS_STATUS 653 +|//DataConstraint//|dataConstraintAgencyId:dataConstraintId(version)|TFFS:CREDITOR_DATA_CONTENT(1.0.0) 637 637 638 -(% style="width:1313.29px" %) 639 -|(% style="width:229px" %)**Classname**|(% style="width:515px" %)**Ending URN pattern**|(% style="width:567px" %)**Example** 640 -|(% style="width:229px" %)DataConsumer|(% style="width:515px" %)dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**).dataConsumerId|(% style="width:567px" %)SDMX:**DATA_CONSUMERS**(**1.0**).CONSUMER_1 641 -|(% style="width:229px" %)//DataConsumerScheme//|(% style="width:515px" %)((( 642 -dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**) 643 -)))|(% style="width:567px" %)SDMX:**DATA_CONSUMERS**(**1.0**) 644 -|(% style="width:229px" %)//Dataflow//|(% style="width:515px" %)dataflowAgencyId:dataflowId(version)|(% style="width:567px" %)TFFS:CRED_EXT_DEBT(1.0.0) 645 -|(% style="width:229px" %)DataProvider|(% style="width:515px" %)((( 646 -dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**).dataProviderId 647 -)))|(% style="width:567px" %)SDMX:**DATA_PROVIDERS**(**1.0**).PROVIDER_1 648 -|(% style="width:229px" %)//DataProviderScheme//|(% style="width:515px" %)((( 649 -dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**) 650 -)))|(% style="width:567px" %)SDMX:**DATA_PROVIDERS**(**1.0**) 651 -|(% style="width:229px" %)//DataStructure//|(% style="width:515px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version)|(% style="width:567px" %)TFFS:EXT_DEBT(1.0.0) 652 -|(% style="width:229px" %)Dimension|(% style="width:515px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dimensionId|(% style="width:567px" %)TFFS:EXT_DEBT(1.0.0).FREQ 653 -|(% style="width:229px" %)((( 655 +|**Classname**|**Ending URN pattern**|**Example** 656 +|DataConsumer|dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**).dataConsumerId|SDMX:**DATA_CONSUMERS**(**1.0**).CONSUMER_1 657 +|//DataConsumerScheme//|((( 658 +dataConsumerSchemeAgencyId:**DATA_CONSUME** 659 + 660 +**RS**(**1.0**) 661 +)))|SDMX:**DATA_CONSUMERS**(**1.0**) 662 +|//Dataflow//|dataflowAgencyId:dataflowId(version)|TFFS:CRED_EXT_DEBT(1.0.0) 663 +|DataProvider|((( 664 +dataProviderSchemeAgencyId:**DATA_PROVIDERS**( 665 + 666 +**1.0**).dataProviderId 667 +)))|SDMX:**DATA_PROVIDERS**(**1.0**).PROVIDER_1 668 +|//DataProviderScheme//|((( 669 +dataProviderSchemeAgencyId:**DATA_PROVIDERS**( 670 + 671 +**1.0**) 672 +)))|SDMX:**DATA_PROVIDERS**(**1.0**) 673 +|//DataStructure//|dataStructureDefinitionAgencyId:dataStructureDef initionId(version)|TFFS:EXT_DEBT(1.0.0) 674 +|Dimension|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dimensionId|TFFS:EXT_DEBT(1.0.0).FREQ 675 +|((( 654 654 DimensionDescriptor 677 + 655 655 MeasureDescriptor 679 + 656 656 AttributeDescriptor 657 -)))| (% style="width:515px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).componentListId where the componentListId is the name of the class (there is only one occurrence of each in the Data Structure Definition)|(% style="width:567px" %)(((681 +)))|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).componentListId where the componentListId is the name of the class (there is only one occurrence of each in the Data Structure Definition)|((( 658 658 TFFS:EXT_DEBT(1.0.0).DimensionDescriptor 683 + 659 659 TFFS:EXT_DEBT(1.0.0).MeasureDescriptor 685 + 660 660 TFFS:EXT_DEBT(1.0.0).AttributeDescriptor 661 661 ))) 662 -|(% style="width:229px" %)GroupDimensionDescriptor|(% style="width:515px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).groupDimensionDescriptorId|(% style="width:567px" %)TFFS:EXT_DEBT(1.0.0).SIBLING 663 -|(% style="width:229px" %)HierarchicalCode|(% style="width:515px" %)hierarchyAgencyId:hierarchyId(version).hierarchica lCode.hierarchicalCode|(% style="width:567px" %)UNESCO:H-C-GOV(1.0.0).GOV_CODE1.GOV_CODE1_1 664 -|(% style="width:206px" %)//Hierarchy//|(% style="width:525px" %)hierarchyAgencyId:hierarchyId(version)|(% style="width:558px" %)UNESCO:H-C-GOV(1.0.0) 665 -|(% style="width:206px" %)//HierarchyAssociation//|(% style="width:525px" %)hierarchyAssociationAgencyId:hierarchyAssociatio nId(version)|(% style="width:558px" %)UNESCO:CL_EXP_SOURCE(1.0.0) 666 -|(% style="width:206px" %)Level|(% style="width:525px" %)hierarchyAgencyId:hierarchyId(version).level|(% style="width:558px" %)UNESCO:H-C-GOV(1.0.0).LVL1 667 -|(% style="width:206px" %)Measure|(% style="width:525px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).measureId|(% style="width:558px" %)TFFS:EXT_DEBT(1.0.0).OBS_VALUE 668 -|(% style="width:206px" %)MetadataAttribute|(% style="width:525px" %)((( 688 +|GroupDimensionDescriptor|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).groupDimensionDescriptorId|TFFS:EXT_DEBT(1.0.0).SIBLING 689 +|HierarchicalCode|hierarchyAgencyId:hierarchyId(version).hierarchica lCode.hierarchicalCode|UNESCO:H-C-GOV(1.0.0).GOV_CODE1.GOV_CODE1_1 690 + 691 +|**Classname**|**Ending URN pattern**|**Example** 692 +|//Hierarchy//|hierarchyAgencyId:hierarchyId(version)|UNESCO:H-C-GOV(1.0.0) 693 +|//HierarchyAssociation//|hierarchyAssociationAgencyId:hierarchyAssociatio nId(version)|UNESCO:CL_EXP_SOURCE(1.0.0) 694 +|Level|hierarchyAgencyId:hierarchyId(version).level|UNESCO:H-C-GOV(1.0.0).LVL1 695 +|Measure|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).measureId|TFFS:EXT_DEBT(1.0.0).OBS_VALUE 696 +|MetadataAttribute|((( 669 669 msdAgencyId:msdId(version).metadataAttributeId. 698 + 670 670 metadataAttributeId 671 -)))| (% style="width:558px" %)IMF:SDDS_MSD(1.0.0).COMPILATION.METHOD672 -| (% style="width:206px" %)MetadataAttributeDescriptor|(% style="width:525px" %)msdAgencyId:msdId(version).metadataAttributeDe scriptorId|(% style="width:558px" %)IMF:SDDS_MSD(1.0.0).MetadataAttributeDescriptor673 -| (% style="width:206px" %)//MetadataConstraint//|(% style="width:525px" %)metadataConstraintAgencyId:metadataConstraintI d(version)|(% style="width:558px" %)TFFS:CREDITOR_METADATA_CONTENT(1.0.0)674 -| (% style="width:206px" %)//Metadataflow//|(% style="width:525px" %)metadataflowAgencyId:metadataflowId(version)|(% style="width:558px" %)IMF:SDDS_MDF(1.0.0)675 -| (% style="width:206px" %)MetadataProvider|(% style="width:525px" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**).metadataProviderId|(% style="width:558px" %)SDMX:**METADATA_PROVIDERS**(**1.0**).MD_PROVIDER_1676 -| (% style="width:206px" %)//MetadataProviderScheme//|(% style="width:525px" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**)|(% style="width:558px" %)SDMX:**METADATA_PROVIDERS**(**1.0**)677 -| (% style="width:206px" %)//MetadataProvisionAgreement//|(% style="width:525px" %)metadataProvisionAgreementAgencyId:metadataP rovisionAgreementId(version)|(% style="width:558px" %)IMF:SDDS_MDF_AB(1.0.0)678 -| (% style="width:206px" %)//MetadataSet//|(% style="width:525px" %)metadataProviderId:metadataSetId(version)|(% style="width:558px" %)MD_PROVIDER:METADATASET(1.0.0)679 -| (% style="width:206px" %)//MetadataStructure//|(% style="width:525px" %)msdAgencyId:msdId(version)|(% style="width:558px" %)IMF:SDDS_MSD(1.0.0)700 +)))|IMF:SDDS_MSD(1.0.0).COMPILATION.METHOD 701 +|MetadataAttributeDescriptor|msdAgencyId:msdId(version).metadataAttributeDe scriptorId|IMF:SDDS_MSD(1.0.0).MetadataAttributeDescriptor 702 +|//MetadataConstraint//|metadataConstraintAgencyId:metadataConstraintI d(version)|TFFS:CREDITOR_METADATA_CONTENT(1.0.0) 703 +|//Metadataflow//|metadataflowAgencyId:metadataflowId(version)|IMF:SDDS_MDF(1.0.0) 704 +|MetadataProvider|metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**).metadataProviderId|SDMX:**METADATA_PROVIDERS**(**1.0**).MD_PROVIDER_1 705 +|//MetadataProviderScheme//|metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**)|SDMX:**METADATA_PROVIDERS**(**1.0**) 706 +|//MetadataProvisionAgreement//|metadataProvisionAgreementAgencyId:metadataP rovisionAgreementId(version)|IMF:SDDS_MDF_AB(1.0.0) 707 +|//MetadataSet//|metadataProviderId:metadataSetId(version)|MD_PROVIDER:METADATASET(1.0.0) 708 +|//MetadataStructure//|msdAgencyId:msdId(version)|IMF:SDDS_MSD(1.0.0) 680 680 681 -| (% style="width:248px" %)**Classname**|(% style="width:629px" %)**Ending URN pattern**|(% style="width:1061px" %)**Example**682 -| (% style="width:248px" %)NamePersonalisation|(% style="width:629px" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|(% style="width:1061px" %)ECB:PSN_SCHEME(1.0.0).PSN1234683 -| (% style="width:248px" %)//NamePersonalisationScheme//|(% style="width:629px" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|(% style="width:1061px" %)ECB:PSN_SCHEME(1.0.0)684 -| (% style="width:248px" %)//OrganisationSchemeMap//|(% style="width:629px" %)orgSchemeMapAgencyId:orgSchemeMapId(versio n)|(% style="width:1061px" %)SDMX:AGENCIES_PROVIDERS(1.0.0)685 -| (% style="width:248px" %)OrganisationUnit|(% style="width:629px" %)organisationUnitSchemeAgencyId:organisationUnitSchemeId(version).organisationUnitId|(% style="width:1061px" %)ECB:ORGANISATIONS(1.0.0).1F686 -| (% style="width:248px" %)//OrganisationUnitScheme//|(% style="width:629px" %)organisationUnitSchemeAgencyId:organisationUni tSchemeId(version)|(% style="width:1061px" %)ECB:ORGANISATIONS(1.0.0)687 -| (% style="width:248px" %)//Process//|(% style="width:629px" %)processAgencyId:processId{version)|(% style="width:1061px" %)BIS:PROCESS1(1.0.0)688 -| (% style="width:248px" %)ProcessStep|(% style="width:629px" %)(((710 +|**Classname**|**Ending URN pattern**|**Example** 711 +|NamePersonalisation|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|ECB:PSN_SCHEME(1.0.0).PSN1234 712 +|//NamePersonalisationScheme//|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|ECB:PSN_SCHEME(1.0.0) 713 +|//OrganisationSchemeMap//|orgSchemeMapAgencyId:orgSchemeMapId(versio n)|SDMX:AGENCIES_PROVIDERS(1.0.0) 714 +|OrganisationUnit|organisationUnitSchemeAgencyId:organisationUni tSchemeId(version).organisationUnitId|ECB:ORGANISATIONS(1.0.0).1F 715 +|//OrganisationUnitScheme//|organisationUnitSchemeAgencyId:organisationUni tSchemeId(version)|ECB:ORGANISATIONS(1.0.0) 716 +|//Process//|processAgencyId:processId{version)|BIS:PROCESS1(1.0.0) 717 +|ProcessStep|((( 689 689 processAgencyId:processId(version).processStepId. 719 + 690 690 processStepId 691 -)))| (% style="width:1061px" %)BIS:PROCESS1(1.0.0).STEP1.STEP1_1692 -| (% style="width:248px" %)//ProvisionAgreement//|(% style="width:629px" %)provisionAgreementAgencyId:provisionAgreement Id(version)|(% style="width:1061px" %)TFFS:CRED_EXT_DEBT_AB(1.0.0)693 -| (% style="width:248px" %)ReportingCategory|(% style="width:629px" %)(((721 +)))|BIS:PROCESS1(1.0.0).STEP1.STEP1_1 722 +|//ProvisionAgreement//|provisionAgreementAgencyId:provisionAgreement Id(version)|TFFS:CRED_EXT_DEBT_AB(1.0.0) 723 +|ReportingCategory|((( 694 694 reportingTaxonomyAgencyId: 725 + 695 695 reportingTaxonomyId(version).reportingCategoryI d.reportingCategoryId 696 -)))| (% style="width:1061px" %)IMF:REP_1(1.0.0):LVL1_REP_CAT.LVL2_REP_CAT697 -| (% style="width:248px" %)//ReportingTaxonomy//|(% style="width:629px" %)reportingTaxonomyAgencyId:reportingTaxonomyI d(version)|(% style="width:1061px" %)IMF:REP_1(1.0.0)698 -| (% style="width:248px" %)//ReportingTaxonomyMap//|(% style="width:629px" %)repTaxonomyAgencyId:repTaxonomyId(version)|(% style="width:1061px" %)SDMX:RT_MAP(1.0.0)727 +)))|IMF:REP_1(1.0.0):LVL1_REP_CAT.LVL2_REP_CAT 728 +|//ReportingTaxonomy//|reportingTaxonomyAgencyId:reportingTaxonomyI d(version)|IMF:REP_1(1.0.0) 729 +|//ReportingTaxonomyMap//|repTaxonomyAgencyId:repTaxonomyId(version)|SDMX:RT_MAP(1.0.0) 699 699 700 -| (% style="width:247px" %)**Classname**|(% style="width:649px" %)**Ending URN pattern**|(% style="width:1042px" %)**Example**701 -| (% style="width:247px" %)//RepresentationMap//|(% style="width:649px" %)repMapAgencyId:repMapId(version)|(% style="width:1042px" %)SDMX:REF_AREA_MAPPING(1.0.0)702 -| (% style="width:247px" %)Ruleset|(% style="width:649px" %)rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|(% style="width:1042px" %)ECB:RULESET_23(1.0.0).SET111703 -| (% style="width:247px" %)//RulesetScheme//|(% style="width:649px" %)rulesetSchemeAgencyId rulesetSchemeId(version)|(% style="width:1042px" %)ECB:RULESET_23(1.0.0)704 -| (% style="width:247px" %)//StructureMap//|(%style="width:649px" %)structureMapAgencyId:structureMap(version)|(% style="width:1042px" %)SDMX:BOP_STRUCTURES(1.0.0)705 -| (% style="width:247px" %)Subscription|(% style="width:649px" %)(((731 +|**Classname**|**Ending URN pattern**|**Example** 732 +|//RepresentationMap//|repMapAgencyId:repMapId(version)|SDMX:REF_AREA_MAPPING(1.0.0) 733 +|Ruleset|rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|ECB:RULESET_23(1.0.0).SET111 734 +|//RulesetScheme//|rulesetSchemeAgencyId rulesetSchemeId(version)|ECB:RULESET_23(1.0.0) 735 +|//StructureMap//|structureMapAgencyId:structureMap(version)|SDMX:BOP_STRUCTURES(1.0.0) 736 +|Subscription|((( 706 706 The Subscription is not itself an Identifiable Artefact and therefore it does not follow the rules for URN structure. 738 + 707 707 The name of the URN is registryURN There is no pre-determined format. 708 -)))|(% style="width:1042px" %)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. 709 -|(% style="width:247px" %)TimeDimension|(% style="width:649px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).timeDimensionId|(% style="width:1042px" %)TFFS:EXT_DEBT(1.0.0).TIME_PERIOD 710 -|(% style="width:247px" %)Transformation|(% style="width:649px" %)transformationSchemeAgencyId transformationSchemeId(version) transformationId|(% style="width:1042px" %)ECB:TRANSFORMATION_SCHEME(1.0.0).TRANS_1 711 -|(% style="width:247px" %)//TransformationScheme//|(% style="width:649px" %)transformationSchemeAgencyId transformationSchemeId(version)|(% style="width:1042px" %)ECB: TRANSFORMATION_SCHEME(1.0.0) 712 -|(% style="width:247px" %)Transition|(% style="width:649px" %)((( 740 +)))|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. 741 +|TimeDimension|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).timeDimensionId|TFFS:EXT_DEBT(1.0.0).TIME_PERIOD 742 +|Transformation|transformationSchemeAgencyId transformationSchemeId(version) transformationId|ECB:TRANSFORMATION_SCHEME(1.0.0).TRANS_1 743 +|//TransformationScheme//|transformationSchemeAgencyId transformationSchemeId(version)|ECB: TRANSFORMATION_SCHEME(1.0.0) 744 +|**Classname**|**Ending URN pattern**|**Example** 745 +|Transition|((( 713 713 processAgencyId:processId(version).processStepId. 747 + 714 714 transitionId 715 -)))| (% style="width:1042px" %)BIS:PROCESS1(1.0.0).STEP1.TRANSITION1716 -| (% style="width:247px" %)UserDefinedOperator|(% style="width:649px" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|(% style="width:1042px" %)ECB:OS_CALC(1.2.0).OS267717 -| (% style="width:247px" %)//UserDefinedOperatorScheme//|(% style="width:649px" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|(% style="width:1042px" %)ECB:OS_CALC(1.2.0)718 -| (% style="width:247px" %)//ValueList//|(% style="width:649px" %)valuelistAgencyId:valuelistId(version)|(% style="width:1042px" %)SDMX:VLIST(1.0.0)719 -| (% style="width:247px" %)VtlCodelistMapping|(% style="width:649px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|(% style="width:1042px" %)ECB:CLIST_MP(2.0.0).ABZ720 -| (% style="width:247px" %)VtlConceptMapping|(% style="width:649px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|(% style="width:1042px" %)ECB:CLIST_MP(1.0.0).XYA721 -| (% style="width:247px" %)VtlDataflowMapping|(% style="width:649px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|(% style="width:1042px" %)ECB:CLIST_MP(1.0.0).MOQ722 -| (% style="width:247px" %)//VtlMappingScheme//|(% style="width:649px" %)vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|(% style="width:1042px" %)ECB:CLIST_MP(2.0.0)749 +)))|BIS:PROCESS1(1.0.0).STEP1.TRANSITION1 750 +|UserDefinedOperator|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|ECB:OS_CALC(1.2.0).OS267 751 +|//UserDefinedOperatorScheme//|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|ECB:OS_CALC(1.2.0) 752 +|//ValueList//|valuelistAgencyId:valuelistId(version)|SDMX:VLIST(1.0.0) 753 +|VtlCodelistMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|ECB:CLIST_MP(2.0.0).ABZ 754 +|VtlConceptMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|ECB:CLIST_MP(1.0.0).XYA 755 +|VtlDataflowMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|ECB:CLIST_MP(1.0.0).MOQ 756 +|//VtlMappingScheme//|vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|ECB:CLIST_MP(2.0.0) 723 723 724 724 **Table 3: Table of identification components for SDMX Identifiable Artefacts** 725 725 ... ... @@ -727,7 +727,7 @@ 727 727 728 728 === {{id name="_Toc93862"/}}7.1 Structural Definition Metadata === 729 729 730 -=== {{id name="_Toc93863"/}}7.1.1 Introduction === 764 +===== {{id name="_Toc93863"/}}7.1.1 Introduction ===== 731 731 732 732 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.) 733 733 ... ... @@ -743,79 +743,90 @@ 743 743 744 744 The following table lists the Maintainable Artefacts. 745 745 746 -(% style="width:881.294px" %) 747 -|(% colspan="2" style="width:522px" %)**Maintainable Artefacts**|(% style="width:490px" %)**Content** 748 -|(% style="width:198px" %)**Abstract Class**|(% style="width:324px" %)**Concrete Class**|(% style="width:490px" %) 749 -|(% style="width:198px" %)Item Scheme|(% style="width:324px" %)Codelist|(% style="width:490px" %)Code 750 -|(% style="width:198px" %) |(% style="width:324px" %)Concept Scheme|(% style="width:490px" %)Concept 751 -|(% style="width:198px" %) |(% style="width:324px" %)Category Scheme|(% style="width:490px" %)Category 752 -|(% style="width:198px" %) |(% style="width:324px" %)Organisation Unit Scheme|(% style="width:490px" %)Organisation Unit 753 -|(% style="width:198px" %) |(% style="width:324px" %)Agency Scheme|(% style="width:490px" %)Agency 754 -|(% style="width:198px" %) |(% style="width:324px" %)Data Provider Scheme|(% style="width:490px" %)Data Provider 755 -|(% style="width:198px" %) |(% style="width:324px" %)Metadata Provider Scheme|(% style="width:490px" %)Metadata Provider 756 -|(% style="width:198px" %) |(% style="width:324px" %)Data Consumer Scheme|(% style="width:490px" %)Data Consumer 757 -|(% style="width:198px" %) |(% style="width:324px" %)Reporting Taxonomy|(% style="width:490px" %)Reporting Category 758 -|(% style="width:198px" %) |(% style="width:324px" %)Transformation Scheme|(% style="width:490px" %)Transformation 759 -|(% style="width:198px" %) |(% style="width:324px" %)Custom Type Scheme|(% style="width:490px" %)Custom Type 760 -|(% style="width:198px" %) |(% style="width:324px" %)Name Personalisation Scheme|(% style="width:490px" %)Name Personalisation 761 -|(% style="width:198px" %) |(% style="width:324px" %)Vtl Mapping Scheme|(% style="width:490px" %)Vtl Codelist Mapping Vtl Concept Mapping 762 -|(% style="width:198px" %) |(% style="width:324px" %)Ruleset Scheme|(% style="width:490px" %)Ruleset 763 -|(% style="width:198px" %) |(% style="width:324px" %)User Defined Operator Scheme|(% style="width:490px" %)User Defined Operator 764 -|(% style="width:198px" %)Enumerated List|(% style="width:324px" %)ValueList|(% style="width:490px" %)Value Item 765 -|(% style="width:198px" %)Structure|(% style="width:324px" %)Data Structure Definition|(% style="width:490px" %)((( 780 +|(% colspan="2" %)**Maintainable Artefacts**|**Content** 781 +|**Abstract Class**|**Concrete Class**| 782 +|Item Scheme|Codelist|Code 783 +| |Concept Scheme|Concept 784 +| |Category Scheme|Category 785 +| |Organisation Unit Scheme|Organisation Unit 786 +| |Agency Scheme|Agency 787 +| |Data Provider Scheme|Data Provider 788 +| |Metadata Provider Scheme|Metadata Provider 789 +| |Data Consumer Scheme|Data Consumer 790 +| |Reporting Taxonomy|Reporting Category 791 +| |Transformation Scheme|Transformation 792 +| |Custom Type Scheme|Custom Type 793 +| |Name Personalisation Scheme|Name Personalisation 794 +| |Vtl Mapping Scheme|Vtl Codelist Mapping Vtl Concept Mapping 795 +| |Ruleset Scheme|Ruleset 796 +| |User Defined Operator Scheme|User Defined Operator 797 +|Enumerated List|ValueList|Value Item 798 +|Structure|Data Structure Definition|((( 766 766 Dimension Descriptor 800 + 767 767 Group Dimension Descriptor 802 + 768 768 Dimension 804 + 769 769 Time Dimension 806 + 770 770 Attribute Descriptor 808 + 771 771 Data Attribute 810 + 772 772 Measure Descriptor 812 + 773 773 Measure 774 774 ))) 775 -| (%style="width:198px" %)|(% style="width:324px" %)Metadata Structure Definition|(% style="width:490px" %)Metadata Attribute Descriptor Metadata Attribute776 -| (% style="width:198px" %)Structure Usage|(% style="width:324px" %)Dataflow|(%style="width:490px" %)777 -| (%style="width:198px" %)|(% style="width:324px" %)Metadataflow|(%style="width:490px" %)778 -| (% style="width:198px" %)None|(% style="width:324px" %)Process|(% style="width:490px" %)Process Step779 -| (% style="width:198px" %)None|(% style="width:324px" %)Structure Map|(% style="width:490px" %)(((815 +| |Metadata Structure Definition|Metadata Attribute Descriptor Metadata Attribute 816 +|Structure Usage|Dataflow| 817 +| |Metadataflow| 818 +|None|Process|Process Step 819 +|None|Structure Map|((( 780 780 Component Map 821 + 781 781 Epoch Map 823 + 782 782 Date Pattern Map 783 783 ))) 784 -| (% style="width:198px" %)None|(% style="width:324px" %)Representation Map|(% style="width:490px" %)Representation Mapping785 -| (% style="width:198px" %)Item Scheme Map|(% style="width:324px" %)Organisation Scheme Map|(% style="width:490px" %)Item Map786 -| (%style="width:198px" %)|(% style="width:324px" %)Concept Scheme Map|(% style="width:490px" %)Item Map787 -| (%style="width:198px" %)|(% style="width:324px" %)Category Scheme Map|(% style="width:490px" %)Item Map788 -| (%style="width:198px" %)|(% style="width:324px" %)Reporting Taxonomy Map|(% style="width:490px" %)Item Map789 -| (% style="width:198px" %)None|(% style="width:324px" %)Provision Agreement|(%style="width:490px" %)790 -| (% style="width:198px" %)None|(% style="width:324px" %)Metadata Provision Agreement|(%style="width:490px" %)791 -| (% style="width:198px" %)None|(% style="width:324px" %)Hierarchy|(% style="width:490px" %)Hierarchical Code792 -| (% style="width:198px" %)None|(% style="width:324px" %)Hierarchy Association|(%style="width:490px" %)793 -| (% style="width:198px" %)None|(% style="width:324px" %)Categorisation|(%style="width:490px" %)826 +|None|Representation Map|Representation Mapping 827 +|Item Scheme Map|Organisation Scheme Map|Item Map 828 +| |Concept Scheme Map|Item Map 829 +| |Category Scheme Map|Item Map 830 +| |Reporting Taxonomy Map|Item Map 831 +|None|Provision Agreement| 832 +|None|Metadata Provision Agreement| 833 +|None|Hierarchy|Hierarchical Code 834 +|None|Hierarchy Association| 835 +|None|Categorisation| 794 794 795 795 **Table 4: Table of Maintainable Artefacts for Structural Definition Metadata** 796 796 797 -=== {{id name="_Toc93864"/}}7.1.2 Item Scheme, Structure === 839 +===== {{id name="_Toc93864"/}}7.1.2 Item Scheme, Structure ===== 798 798 799 799 The artefacts included in the structural definitions are: 800 800 801 -* 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) 802 -* All types of Enumerated List (ValueList){{footnote}}Note that Codelist is also an EnumeratedList.{{/footnote}} 803 -* All types of Structure (Data Structure Definition, Metadata Structure Definition) 804 -* All types of Structure Usage (Dataflow, Metadataflow) 843 +• 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) 805 805 806 - ==={{idname="_Toc93865"/}}7.1.3StructureUsage===845 +• All types of Enumerated List (ValueList)^^[[(% class="wikiinternallink wikiinternallink" %)^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]](%%)^^ 807 807 808 - ====7.1.3.1StructureUsage: BasicConcepts====847 +• All types of Structure (Data Structure Definition, Metadata Structure Definition) 809 809 849 +• All types of Structure Usage (Dataflow, Metadataflow) 850 + 851 +===== {{id name="_Toc93865"/}}7.1.3 Structure Usage ===== 852 + 853 +**7.1.3.1 Structure Usage: Basic Concepts** 854 + 810 810 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. 811 811 812 - ====7.1.3.2 Structure Usage Schematic====857 +**7.1.3.2 Structure Usage Schematic** 813 813 814 814 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_52097ab5.jpg||height="246" width="438"]] 815 815 816 816 **Figure 9: Schematic of Linking the Data and Metadata Flows to Categories and Structure Definitions** 817 817 818 - ====7.1.3.3 Structure Usage Model====863 +**7.1.3.3 Structure Usage Model** 819 819 820 820 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_302cc1a2.jpg||height="548" width="578"]] 821 821 ... ... @@ -831,9 +831,9 @@ 831 831 * Categorisation to Dataflow and Category 832 832 * Categorisation to Metadataflow and Category 833 833 834 -== {{id name="_Toc93866"/}}7.2 Data and Metadata Provisioning == 879 +=== {{id name="_Toc93866"/}}7.2 Data and Metadata Provisioning === 835 835 836 -=== {{id name="_Toc93867"/}}7.2.1 Provisioning Agreement: Basic concepts === 881 +===== {{id name="_Toc93867"/}}7.2.1 Provisioning Agreement: Basic concepts ===== 837 837 838 838 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. 839 839 ... ... @@ -841,7 +841,7 @@ 841 841 842 842 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. 843 843 844 -=== {{id name="_Toc93868"/}}7.2.2 Provisioning Agreement Model – pull use case === 889 +===== {{id name="_Toc93868"/}}7.2.2 Provisioning Agreement Model – pull use case ===== 845 845 846 846 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. 847 847 ... ... @@ -863,9 +863,9 @@ 863 863 864 864 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. 865 865 866 -== {{id name="_Toc93869"/}}7.3 Data and Metadata Constraints == 911 +=== {{id name="_Toc93869"/}}7.3 Data and Metadata Constraints === 867 867 868 -=== {{id name="_Toc93870"/}}7.3.1 Data and Metadata Constraints: Basic Concepts === 913 +===== {{id name="_Toc93870"/}}7.3.1 Data and Metadata Constraints: Basic Concepts ===== 869 869 870 870 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. 871 871 ... ... @@ -929,14 +929,17 @@ 929 929 930 930 The Registration has an action attribute which takes one of the following values: 931 931 977 +: 978 + 932 932 ((( 933 -(% style="width:761.294px" %) 934 -|(% style="width:196px" %)**Action Attribute Value**|(% style="width:561px" %)**Behaviour** 935 -|(% style="width:196px" %)Append|(% style="width:561px" %)Add this Registration to the registry 936 -|(% style="width:196px" %)Replace|(% style="width:561px" %)((( 937 -Replace the existing Registration with identified by the id in the Registration of the SubmitRegistrationRequest 980 +|**Action Attribute Value**|**Behaviour** 981 +|Append|Add this Registration to the registry 982 +|Replace|((( 983 +Replace the existing Registration with identified by the id in the 984 + 985 +Registration of the SubmitRegistrationRequest 938 938 ))) 939 -| (% style="width:196px" %)Delete|(% style="width:561px" %)Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest987 +|Delete|Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest 940 940 ))) 941 941 942 942 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_bc1dcdec.jpg||height="575" width="579"]] ... ... @@ -953,20 +953,27 @@ 953 953 954 954 Information in the data or metadata set is extracted and placed in one or more //Constraint//s (see the //Constraint// model in the SDMX Information Model – Section 2 of the SDMX Standards). The information to be extracted is indicated by the Boolean values set on the ProvisionAgreement or MetadataProvisionAgreement as shown in the table below. 955 955 1004 +: 1005 + 956 956 ((( 957 -(% style="width:678.294px" %) 958 -|**Indexing Required**|(% style="width:504px" %)**Registration Process Activity** 959 -|indexTimeSeries|(% style="width:504px" %)Extract all the series keys and create a KeySet(s) Constraint. 960 -|indexDataSet|(% style="width:504px" %)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. 961 -|indexReportingPeriod|(% style="width:504px" %)((( 1007 +|**Indexing Required**|**Registration Process Activity** 1008 +|indexTimeSeries|Extract all the series keys and create a KeySet(s) Constraint. 1009 +|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. 1010 +|indexReportingPeriod|((( 962 962 This applies only to a registered __dataset__. 1012 + 963 963 Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint. 964 964 ))) 965 -|**Indexing Required**| (% style="width:504px" %)**Registration Process Activity**966 -|indexAttributes|( % style="width:504px" %)(((1015 +|**Indexing Required**|**Registration Process Activity** 1016 +|indexAttributes|((( 967 967 **Data Set** 968 -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 1018 + 1019 +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 1020 + 1021 +SDMXIM, and the associated Selection Value 1022 + 969 969 **Metadata Set** 1024 + 970 970 Indicate the presence of a Reported Attribute by creating one or more Cube Regions containing Member Selections of Metadata Attribute Components of the Constraints model in the SDMX-IM. Note that the content is not stored in the Selection Value. 971 971 ))) 972 972 ))) ... ... @@ -975,7 +975,7 @@ 975 975 976 976 The Registration must reference the ProvisionAgreement or MetadataProvisionAgreement to which it relates. 977 977 978 -=== {{id name="_Toc93876"/}}7.4.3 Registration Response === 1033 +===== {{id name="_Toc93876"/}}7.4.3 Registration Response ===== 979 979 980 980 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”. 981 981 ... ... @@ -1005,18 +1005,20 @@ 1005 1005 1006 1006 Regardless of the type of registry/repository events being observed, a subscription always contains: 1007 1007 1008 -1. set of URIs describing the end-points to which notifications must be sent if the subscription is activated. The URIs can be either mailto~: or http: protocol. In the former case an email notification is sent; in the latter an HTTP POST notification is sent. 1063 +1. A set of URIs describing the end-points to which notifications must be sent if the subscription is activated. The URIs can be either mailto~: or http: protocol. In the former case an email notification is sent; in the latter an HTTP POST notification is sent. 1009 1009 1. A user-defined identifier, which is returned in the response to the subscription request. This helps with asynchronous processing and is NOT stored in the Registry. 1010 1010 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. 1011 1011 1. A selector which specifies which type of events are of interest. The set of event types is: 1012 1012 1068 +: 1069 +:: 1070 + 1013 1013 ((( 1014 -(% style="width:856.294px" %) 1015 -|(% style="width:320px" %)**Event Type**|(% style="width:532px" %)**Comment** 1016 -|(% style="width:320px" %)STRUCTURAL_REPOSITORY_EVENTS|(% style="width:532px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository. 1017 -|(% style="width:320px" %)DATA_REGISTRATION_EVENTS|(% style="width:532px" %)Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database. 1018 -|(% style="width:320px" %)METADATA_REGISTRATION_EVENTS|(% style="width:532px" %)Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database. 1019 -|(% style="width:320px" %)ALL_EVENTS|(% style="width:532px" %)All events of the specified EventType 1072 +|**Event Type**|**Comment** 1073 +|STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository. 1074 +|DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database. 1075 +|METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database. 1076 +|ALL_EVENTS|All events of the specified EventType 1020 1020 ))) 1021 1021 1022 1022 === {{id name="_Toc93880"/}}7.5.3 Wildcard Facility === ... ... @@ -1083,14 +1083,15 @@ 1083 1083 1084 1084 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: 1085 1085 1143 +: 1144 + 1086 1086 ((( 1087 -(% style="width:1126.29px" %) 1088 -|(% style="width:382px" %)**Selector**|(% style="width:740px" %)**Comment** 1089 -|(% style="width:382px" %)DataProvider & MetadataProvider|(% style="width:740px" %)Any datasets or metadata sets registered by the specified data or metadata provider will activate the notification. 1090 -|(% style="width:382px" %)ProvisionAgreement & MetadataProvisionAgreement|(% style="width:740px" %)Any datasets or metadata sets registered for the agreement will activate the notification. 1091 -|(% style="width:382px" %)Dataflow & Metadataflow|(% style="width:740px" %)Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification. 1092 -|(% style="width:382px" %)DataStructureDefinition & MetadataStructureDefinition|(% style="width:740px" %)Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will activate the notification 1093 -|(% style="width:382px" %)Category|(% style="width:740px" %)Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category. 1146 +|**Selector**|**Comment** 1147 +|DataProvider & MetadataProvider|Any datasets or metadata sets registered by the specified data or metadata provider will activate the notification. 1148 +|ProvisionAgreement & MetadataProvisionAgreement|Any datasets or metadata sets registered for the agreement will activate the notification. 1149 +|Dataflow & Metadataflow|Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification. 1150 +|DataStructureDefinition & MetadataStructureDefinition|Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will activate the notification 1151 +|Category|Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category. 1094 1094 ))) 1095 1095 1096 1096 The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration. ... ... @@ -1122,6 +1122,10 @@ 1122 1122 1123 1123 The notification will contain the Registration. 1124 1124 1125 - ----1183 +[[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. 1126 1126 1127 -{{putFootnotes/}} 1185 +[[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: 1186 + 1187 +IMF.SubAgency1 1188 + 1189 +[[3>>path:#sdfootnote3anc||name="sdfootnote3sym"]] Note that Codelist is also an EnumeratedList.
- 1747307906944-697.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -37.9 KB - Content
- SUZ.Methodology.Code.MethodologyClass[0]
-