Last modified by Helena on 2025/09/10 11:19
Summary
-
Page properties (2 modified, 0 added, 0 removed)
-
Attachments (0 modified, 0 added, 4 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 - SDMXSTANDARDS: SECTION 51 +1 Introduction - Content
-
... ... @@ -1,17 +1,14 @@ 1 -{{box title="**Contents**"}} 2 -{{toc/}} 3 -{{/box}} 1 +**Revision History** 4 4 5 - =Revision History =3 +: 6 6 7 7 ((( 8 -(% style="width:838.294px" %) 9 -|(% style="width:188px" %)**Revision**|(% style="width:205px" %)**Date**|(% style="width:441px" %)**Contents** 10 -|(% style="width:188px" %)DRAFT 1.0|(% style="width:205px" %)May 2021|(% style="width:441px" %)Draft release updated for SDMX 3.0 for public consultation 11 -|(% style="width:188px" %)1.0|(% style="width:205px" %)October 2021|(% style="width:441px" %)Public release for SDMX 3.0 6 +|**Revision**|**Date**|**Contents** 7 +|DRAFT 1.0|May 2021|Draft release updated for SDMX 3.0 for public consultation 8 +|1.0|October 2021|Public release for SDMX 3.0 12 12 ))) 13 13 14 -= 1 Introduction = 11 += {{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 33 +• structural metadata repository 39 39 35 +• data and metadata registration 36 + 37 +• query 38 + 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** 81 +====== 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.108 +• registry support of a subscription-based notification service which sends an email or notifies an HTTP address announcing all published data that meets the criteria contained in the subscription request. 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. 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. 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 ... ... @@ -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 245 +|**Action Attribute Value**|**Behaviour** 246 +|Append|Add this registration to the registry 247 +|Replace|Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request 248 +|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. 252 +|**Boolean Attribute**|**Behaviour if Value is “true”** 253 +|indexTimeSeries|A compliant indexing application must index all the time series keys (for a Dataset registration) or metadata target values (for a Metadataset registration) 254 +|indexDataSet|((( 255 +A compliant indexing application must index the range of actual 256 + 257 +(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. 258 + 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.261 +|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 ... ... @@ -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" %)((( 295 +|**Interface**|**Behaviour** 296 +|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,14 +301,14 @@ 301 301 302 302 a) Be a draft version. 303 303 ))) 304 -| (% style="width:188px" %)**Interface**|(% style="width:542px" %)**Behaviour**305 -| (% style="width:188px" %)|(% style="width:542px" %)(((306 -b) Not be explicitly {{footnote}}Withemantic versioning, it is allowedto reference a rangeof artefacts, e.g., a DSD referencing a Codelistwith version1.2.3+meansall patch versions greater than 1.2.3. Thismeansthatdeleting 1.2.4-draft does notbreak integrityoftheforementionedDSD.{{/footnote}}referenced from any other object in the Registry.303 +|**Interface**|**Behaviour** 304 +||((( 305 +b) Not be explicitly^^[[^^1^^>>path:#sdfootnote1sym||name="sdfootnote1anc"]]^^ referenced from any other object in the Registry. 307 307 308 308 4) The semantic versioning rules in the SDMX documentation MUST be obeyed. 309 309 ))) 310 -| (% 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.311 -| (% 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.309 +|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. 310 +|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. 312 312 313 313 = {{id name="_Toc93853"/}}6 Identification of SDMX Objects = 314 314 ... ... @@ -329,42 +329,43 @@ 329 329 330 330 The table below shows the identification and related data attributes to be stored in a registry for objects that are one of: 331 331 332 -* //nnotable// 331 +* //Annotable// 333 333 * //Identifiable// 334 334 * //Nameable// 335 335 * //Versionable// 336 336 * //Maintainable// 337 337 337 +: 338 + 338 338 ((( 339 -(% style="width:1052.29px" %) 340 -|**Object Type**|(% style="width:241px" %)**Data Attributes**|(% style="width:156px" %)**Status**|**Data type**|(% style="width:457px" %)**Notes** 341 -|(% rowspan="4" %)//Annotable//|(% style="width:241px" %)AnnotationTitle|(% style="width:156px" %)C|string|(% style="width:457px" %) 342 -|(% style="width:241px" %)AnnotationType|(% style="width:156px" %)C|string|(% style="width:457px" %) 343 -|(% style="width:241px" %)AnnotationURN|(% style="width:156px" %)C|string|(% style="width:457px" %) 344 -|(% style="width:241px" %)AnnotationText in the form of InternationalString|(% style="width:156px" %)C| |(% style="width:457px" %)This can have languagespecific variants 345 -|(% rowspan="4" %)//Identifiable//|(% style="width:241px" %)All content as for //Annotable// plus|(% style="width:156px" %) | |(% style="width:457px" %) 346 -|(% style="width:241px" %)id|(% style="width:156px" %)M|string|(% style="width:457px" %) 347 -|(% style="width:241px" %)uri|(% style="width:156px" %)C|string|(% style="width:457px" %) 348 -|(% 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. 349 -|(% rowspan="3" %)//Nameable//|(% style="width:241px" %)All content as for //Identifiable// plus|(% style="width:156px" %) | |(% style="width:457px" %) 350 -|(% style="width:241px" %)Name in the form of InternationalString|(% style="width:156px" %)M|string|(% style="width:457px" %)This can have language specific variants. 351 -|(% style="width:241px" %)Description in the form of InternationalString|(% style="width:156px" %)C|string|(% style="width:457px" %)This can have language specific variants. 352 -|(% rowspan="4" %)//Versionable//|(% style="width:241px" %)All content as for //Identifiable// plus|(% style="width:156px" %) | |(% style="width:457px" %) 353 -|(% style="width:241px" %)version|(% style="width:156px" %)M|string|(% style="width:457px" %)This is the version number according to SDMX versioning rules. 354 -|(% style="width:241px" %)validFrom|(% style="width:156px" %)C|Date/time|(% style="width:457px" %) 355 -|(% style="width:241px" %)validTo|(% style="width:156px" %)C|Date/time|(% style="width:457px" %) 356 -|//Maintainable//|(% style="width:241px" %)All content as for //Versionable// plus|(% style="width:156px" %) | |(% style="width:457px" %) 357 -| |(% 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. 358 -| |(% style="width:241px" %)serviceURL|(% style="width:156px" %)C|string|(% style="width:457px" %)The url of the service that can be queried for this resource. 359 -| |(% style="width:241px" %)structureURL|(% style="width:156px" %)C|string|(% style="width:457px" %)The url of the resource. 360 -| |(% 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. 340 +|**Object Type**|**Data Attributes**|**Status**|**Data type**|**Notes** 341 +|(% rowspan="4" %)//Annotable//|AnnotationTitle|C|string| 342 +|AnnotationType|C|string| 343 +|AnnotationURN|C|string| 344 +|AnnotationText in the form of InternationalString|C||This can have languagespecific variants 345 +|(% rowspan="4" %)//Identifiable//|All content as for //Annotable// plus||| 346 +|id|M|string| 347 +|uri|C|string| 348 +|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. 349 +|(% rowspan="3" %)//Nameable//|All content as for //Identifiable// plus||| 350 +|Name in the form of InternationalString|M|string|This can have language specific variants. 351 +|Description in the form of InternationalString|C|string|This can have language specific variants. 352 +|(% rowspan="4" %)//Versionable//|All content as for //Identifiable// plus||| 353 +|version|M|string|This is the version number according to SDMX versioning rules. 354 +|validFrom|C|Date/time| 355 +|validTo|C|Date/time| 356 +|//Maintainable//|All content as for //Versionable// plus||| 357 +||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. 358 +|\\|serviceURL|C|string|The url of the service that can be queried for this resource. 359 +||structureURL|C|string|The url of the resource. 360 +||(Maintenance) organisationId|M|string|The object must be linked to a maintenance organisation, i.e., Agency or Metadata Provider. 361 361 ))) 362 362 363 363 **Table 1: Common Attributes of Object Types** 364 364 365 -== {{id name="_Toc93856"/}}6.2 Unique identification of SDMX objects == 365 +=== {{id name="_Toc93856"/}}6.2 Unique identification of SDMX objects === 366 366 367 -=== {{id name="_Toc93857"/}}6.2.1 Agencies and Metadata Providers === 367 +===== {{id name="_Toc93857"/}}6.2.1 Agencies and Metadata Providers ===== 368 368 369 369 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. 370 370 ... ... @@ -406,8 +406,32 @@ 406 406 407 407 An example of this is shown in the XML snippet below: 408 408 409 - [[image:1747307906944-697.png]]409 +**<str:Codelists>** 410 410 411 +**<str:Codelist id="CL_FREQ" agencyID="SDMX" version="1.0.0">** 412 + 413 +**<com:Name xml:lang="en">Standard frequency Codelist</com:Name>** 414 + 415 +**</str:Codelist>** 416 + 417 +**<str:Codelist id="CL_FREQ" agencyID="AA" version="1.0.0">** 418 + 419 +**<com:Name xml:lang="en">Codelist maintained by agency AA</com:Name>** 420 + 421 +**</str:Codelist>** 422 + 423 +**<str:Codelist id="CL_FREQ" agencyID="AA.CC" version="1.0.0">** 424 + 425 +**<com:Name xml:lang="en">Codelist maintained by the AA unit CC</com:Name>** 426 + 427 +**</str:Codelist>** 428 + 429 +**<str:Codelist id="CL_FREQ" agencyID="BB.CC" version="1.0.0">** 430 + 431 +**<com:Name xml:lang="en">Codelist maintained by the BB unit CC</com:Name>** 432 + 433 +**</str:Codelist>** 434 + 411 411 **Figure 8: Example Showing Use of Agency Identifiers** 412 412 413 413 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. ... ... @@ -414,16 +414,14 @@ 414 414 415 415 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. 416 416 417 -=== {{id name="_Toc93858"/}}6.2.2 Universal Resource Name (URN) === 441 +===== {{id name="_Toc93858"/}}6.2.2 Universal Resource Name (URN) ===== 418 418 419 - ====6.2.2.1 Introduction====443 +**6.2.2.1 Introduction** 420 420 421 421 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.). 422 422 423 - ====6.2.2.2 URN Structure====447 +**6.2.2.2 URN Structure //__Case Rules for URN__//**// // 424 424 425 -===== **//__Case Rules for URN__//** ===== 426 - 427 427 For the URN, all parts of the string are case sensitive. The generic structure of the URN is as follows: 428 428 429 429 SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobjectid(maintainedobject-version).*containerobject-id.object-id ... ... @@ -434,7 +434,7 @@ 434 434 435 435 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. 436 436 437 - ====6.2.2.3 Explanation of the generic structure====459 +**6.2.2.3 Explanation of the generic structure** 438 438 439 439 In the explanation below the actual object that is the target of the URN is called the **actual object**. 440 440 ... ... @@ -444,32 +444,10 @@ 444 444 445 445 The packages are: 446 446 447 -base 469 +base codelist conceptscheme datastructure categoryscheme registry metadatastructure process structuremapping transformation 448 448 449 -codelist 471 +**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. 450 450 451 -conceptscheme 452 - 453 -datastructure 454 - 455 -categoryscheme 456 - 457 -registry 458 - 459 -metadatastructure 460 - 461 -process 462 - 463 -structuremapping 464 - 465 -transformation 466 - 467 -**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. 468 - 469 -**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. 470 - 471 -**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. 472 - 473 473 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. 474 474 475 475 For example, the sequence is agency:DSDid(version).DimensionId and not agency:DSDid(version).DimensionDescriptorId.DimensionId. ... ... @@ -476,7 +476,7 @@ 476 476 477 477 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. 478 478 479 - =====//__**Generic Examples of the URN Structure**__//=====479 +//__**Generic Examples of the URN Structure**__// 480 480 481 481 __Actual object is a maintainable__ 482 482 ... ... @@ -502,7 +502,7 @@ 502 502 503 503 SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version).contained-object-id.contained-object-id contained-objectid.object-id 504 504 505 - =====//__**Concrete Examples of the URN Structure**__//=====505 +//__**Concrete Examples of the URN Structure**__// 506 506 507 507 The Data Structure Definition CRED_EXT_DEBT of legacy version 2.1 maintained by the toplevel Agency TFFS would have the URN: 508 508 ... ... @@ -531,86 +531,85 @@ 531 531 532 532 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. 533 533 534 -=== {{id name="_Toc93859"/}}6.2.3 Table of SDMX-IM Packages and Classes === 534 +===== {{id name="_Toc93859"/}}6.2.3 Table of SDMX-IM Packages and Classes ===== 535 535 536 536 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. 537 537 538 -(% style="width:651.294px" %) 539 -|(% style="width:134px" %)**Package**|(% style="width:502px" %)**URN class name (model class name where this is different)** 540 -|(% style="width:134px" %)base|(% style="width:502px" %)Agency 541 -|(% style="width:134px" %) |(% style="width:502px" %)AgencyScheme 542 -|(% style="width:134px" %) |(% style="width:502px" %)DataConsumer 543 -|(% style="width:134px" %) |(% style="width:502px" %)DataConsumerScheme 544 -|(% style="width:134px" %) |(% style="width:502px" %)DataProvider 545 -|(% style="width:134px" %) |(% style="width:502px" %)DataProviderScheme 546 -|(% style="width:134px" %) |(% style="width:502px" %)MetadataProvider 547 -|(% style="width:134px" %) |(% style="width:502px" %)MetadataProviderScheme 548 -|(% style="width:134px" %) |(% style="width:502px" %)OrganisationUnit 549 -|(% style="width:134px" %) |(% style="width:502px" %)OrganisationUnitScheme 550 -|(% style="width:134px" %)datastructure|(% style="width:502px" %)AttributeDescriptor 551 -|(% style="width:134px" %) |(% style="width:502px" %)DataAttribute 552 -|(% style="width:134px" %) |(% style="width:502px" %)Dataflow 553 -|(% style="width:134px" %) |(% style="width:502px" %)DataStructure (DataStructureDefinition) 554 -|(% style="width:134px" %) |(% style="width:502px" %)Dimension 555 -|(% style="width:134px" %) |(% style="width:502px" %)DimensionDescriptor 556 -|(% style="width:134px" %) |(% style="width:502px" %)GroupDimensionDescriptor 557 -|(% style="width:134px" %) |(% style="width:502px" %)Measure 558 -|(% style="width:134px" %) |(% style="width:502px" %)MeasureDescriptor 559 -|(% style="width:134px" %) |(% style="width:502px" %)TimeDimension 560 -|(% style="width:134px" %) |(% style="width:502px" %) 561 -|(% style="width:134px" %)metadatastructure|(% style="width:502px" %)MetadataAttribute 562 -|(% style="width:134px" %) |(% style="width:502px" %)MetadataAttributeDescriptor 563 -|(% style="width:134px" %) |(% style="width:502px" %)MetadataStructure MetadataStructureDefinition) 564 -|(% style="width:134px" %) |(% style="width:502px" %)Metadataflow 565 -|(% style="width:134px" %) |(% style="width:502px" %)MetadataSet 566 -|(% style="width:134px" %) |(% style="width:502px" %) 567 -|(% style="width:134px" %)process|(% style="width:502px" %)Process 568 -|(% style="width:134px" %) |(% style="width:502px" %)ProcessStep 569 -|(% style="width:134px" %) |(% style="width:502px" %)Transition 570 -|(% style="width:134px" %) |(% style="width:502px" %) 571 -|(% style="width:134px" %)registry|(% style="width:502px" %)DataConstraint 572 -|(% style="width:134px" %) |(% style="width:502px" %)MetadataConstraint 573 -|(% style="width:134px" %) |(% style="width:502px" %)MetadataProvisionAgreement 574 -|(% style="width:134px" %) |(% style="width:502px" %)ProvisionAgreement 575 -|(% style="width:134px" %) |(% style="width:502px" %)Subscription 576 -|(% style="width:134px" %) |(% style="width:502px" %) 577 -|(% style="width:134px" %)structuremapping|(% style="width:502px" %)CategorySchemeMap 578 -|(% style="width:134px" %) |(% style="width:502px" %)ConceptSchemeMap 579 -|(% style="width:134px" %) |(% style="width:502px" %)OrganisationSchemeMap 580 -|(% style="width:134px" %) |(% style="width:502px" %)ReportingTaxonomyMap 581 -|(% style="width:134px" %) |(% style="width:502px" %)RepresentationMap 582 -|(% style="width:134px" %) |(% style="width:502px" %)StructureMap 583 -|(% style="width:134px" %) |(% style="width:502px" %) 584 -|(% style="width:134px" %)codelist|(% style="width:502px" %)Code 585 -|(% style="width:134px" %) |(% style="width:502px" %)Codelist 586 -|(% style="width:134px" %) |(% style="width:502px" %)HierarchicalCode 587 -|(% style="width:134px" %) |(% style="width:502px" %)Hierarchy 588 -|(% style="width:134px" %) |(% style="width:502px" %)HierarchyAssociation 589 -|(% style="width:134px" %) |(% style="width:502px" %)Level 590 -|(% style="width:134px" %) |(% style="width:502px" %)ValueList 591 -|(% style="width:134px" %) |(% style="width:502px" %) 592 -|(% style="width:134px" %)categoryscheme|(% style="width:502px" %)Categorisation 593 -|(% style="width:134px" %) |(% style="width:502px" %)Category 594 -|(% style="width:134px" %) |(% style="width:502px" %)CategoryScheme 595 -|(% style="width:134px" %) |(% style="width:502px" %)ReportingCategory 596 -|(% style="width:134px" %) |(% style="width:502px" %)ReportingTaxonomy 597 -|(% style="width:134px" %)conceptscheme|(% style="width:502px" %)Concept 598 -|(% style="width:134px" %) |(% style="width:502px" %)ConceptScheme 599 -|(% style="width:134px" %) |(% style="width:502px" %) 600 -|(% style="width:134px" %)transformation|(% style="width:502px" %)CustomType 601 -|(% style="width:134px" %) |(% style="width:502px" %)CustomTypeScheme 602 -|(% style="width:134px" %) |(% style="width:502px" %)NamePersonalisation 603 -|(% style="width:134px" %) |(% style="width:502px" %)NamePersonalisationScheme 604 -|(% style="width:134px" %) |(% style="width:502px" %)Ruleset 605 -|(% style="width:134px" %) |(% style="width:502px" %)RulesetScheme 606 -|(% style="width:134px" %) |(% style="width:502px" %)Transformation 607 -|(% style="width:134px" %) |(% style="width:502px" %)TransformationScheme 608 -|(% style="width:134px" %) |(% style="width:502px" %)UserDefinedOperator 609 -|(% style="width:134px" %) |(% style="width:502px" %)UserDefinedOperatorScheme 610 -|(% style="width:134px" %) |(% style="width:502px" %)VtlCodelistMapping 611 -|(% style="width:134px" %) |(% style="width:502px" %)VtlConceptMapping 612 -|(% style="width:134px" %) |(% style="width:502px" %)VtlDataflowMapping 613 -|(% style="width:134px" %) |(% style="width:502px" %)VtlMappingScheme 538 +|**Package**|**URN class name (model class name where this is different)** 539 +|base|Agency 540 +||AgencyScheme 541 +||DataConsumer 542 +||DataConsumerScheme 543 +||DataProvider 544 +||DataProviderScheme 545 +||MetadataProvider 546 +||MetadataProviderScheme 547 +||OrganisationUnit 548 +||OrganisationUnitScheme 549 +|datastructure|AttributeDescriptor 550 +||DataAttribute 551 +||Dataflow 552 +||DataStructure (DataStructureDefinition) 553 +||Dimension 554 +||DimensionDescriptor 555 +||GroupDimensionDescriptor 556 +||Measure 557 +||MeasureDescriptor 558 +||TimeDimension 559 +|| 560 +|metadatastructure|MetadataAttribute 561 +||MetadataAttributeDescriptor 562 +||MetadataStructure MetadataStructureDefinition) 563 +||Metadataflow 564 +||MetadataSet 565 +|| 566 +|process|Process 567 +||ProcessStep 568 +||Transition 569 +|| 570 +|registry|DataConstraint 571 +||MetadataConstraint 572 +||MetadataProvisionAgreement 573 +||ProvisionAgreement 574 +||Subscription 575 +|| 576 +|structuremapping|CategorySchemeMap 577 +||ConceptSchemeMap 578 +||OrganisationSchemeMap 579 +||ReportingTaxonomyMap 580 +||RepresentationMap 581 +||StructureMap 582 +|| 583 +|codelist|Code 584 +||Codelist 585 +||HierarchicalCode 586 +||Hierarchy 587 +||HierarchyAssociation 588 +||Level 589 +||ValueList 590 +|| 591 +|categoryscheme|Categorisation 592 +||Category 593 +||CategoryScheme 594 +||ReportingCategory 595 +||ReportingTaxonomy 596 +|conceptscheme|Concept 597 +||ConceptScheme 598 +|| 599 +|transformation|CustomType 600 +||CustomTypeScheme 601 +||NamePersonalisation 602 +||NamePersonalisationScheme 603 +||Ruleset 604 +||RulesetScheme 605 +||Transformation 606 +||TransformationScheme 607 +||UserDefinedOperator 608 +||UserDefinedOperatorScheme 609 +||VtlCodelistMapping 610 +||VtlConceptMapping 611 +||VtlDataflowMapping 612 +||VtlMappingScheme 614 614 615 615 **Table 2: SDMX-IM Packages and Contained Classes** 616 616 ... ... @@ -622,118 +622,136 @@ 622 622 623 623 urn:sdmx.org.sdmx.infomodel.{package}.{classname}= 624 624 625 -(% style="width:1311.29px" %) 626 -|(% style="width:252px" %)**Classname**|(% style="width:639px" %)**Ending URN pattern**|(% style="width:418px" %)**Example** 627 -|(% style="width:252px" %)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:639px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|(% style="width:418px" %)ECB:**AGENCIES**(**1.0**).AA 628 -|(% style="width:252px" %)//AgencyScheme//|(% style="width:639px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**)|(% style="width:418px" %)ECB:**AGENCIES**(**1.0**) 629 -|(% style="width:252px" %)//Categorisation//|(% style="width:639px" %)categorisationAgencyId:categorisationId(version)|(% style="width:418px" %)IMF:cat001(1.0.0) 630 -|(% style="width:252px" %)Category|(% style="width:639px" %)categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|(% style="width:418px" %)IMF:SDDS(1.0.0):level_1_category.level_2_category … 631 -|(% style="width:252px" %)//CategoryScheme//|(% style="width:639px" %)categorySchemeAgencyId:categorySchemeId(versi on)|(% style="width:418px" %)IMF:SDDS(1.0.0) 624 +|**Classname**|**Ending URN pattern**|**Example** 625 +|Agency^^[[^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]]^^|agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|ECB:**AGENCIES**(**1.0**).AA 626 +|//AgencyScheme//|agencySchemeAgencyId:**AGENCIES**(**1.0**)|ECB:**AGENCIES**(**1.0**) 627 +|//Categorisation//|categorisationAgencyId:categorisationId(version)|IMF:cat001(1.0.0) 628 +|Category|categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|IMF:SDDS(1.0.0):level_1_category.level_2_category … 629 +|//CategoryScheme//|categorySchemeAgencyId:categorySchemeId(versi on)|IMF:SDDS(1.0.0) 632 632 633 -|(% style="width:250px" %)**Classname**|(% style="width:639px" %)**Ending URN pattern**|(% style="width:1049px" %)**Example** 634 -|(% style="width:250px" %)//CategorySchemeMap//|(% style="width:639px" %)((( 635 -catSchemeMapAgencyId:catSchemeMapId(version) 636 -)))|(% style="width:1049px" %)SDMX:EUROSTAT_SUBJECT_DOMAIN(1.0.0) 637 -|(% style="width:250px" %)Code|(% style="width:639px" %)codeListAgencyId:codelistId(version).codeId|(% style="width:1049px" %)SDMX:CL_FREQ(1.0.0).Q 638 -|(% style="width:250px" %)//Codelist//|(% style="width:639px" %)codeListAgencyId:codeListId(version)|(% style="width:1049px" %)SDMX:CL_FREQ(1.0.0) 639 -|(% style="width:250px" %)ComponentMap|(% style="width:639px" %)structureMapAgencyId:structureMap(version).com ponentMapId|(% style="width:1049px" %)SDMX:BOP_STRUCTURES(1.0.0).REF_AREA_TO_COUNT RY 640 -|(% style="width:250px" %)Concept|(% style="width:639px" %)conceptSchemeAgencyId:conceptSchemeId(versio n).conceptId|(% style="width:1049px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0).FREQ 641 -|(% style="width:250px" %)//ConceptScheme//|(% style="width:639px" %)conceptSchemeAgencyId:conceptSchemeId(versio n)|(% style="width:1049px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0) 642 -|(% style="width:250px" %)//ConceptSchemeMap//|(% style="width:639px" %)((( 631 +|**Classname**|**Ending URN pattern**|**Example** 632 +|//CategorySchemeMap//|((( 633 +catSchemeMapAgencyId:catSchemeMapId(version 634 + 635 +) 636 +)))|SDMX:EUROSTAT_SUBJECT_DOMAIN(1.0.0) 637 +|Code|codeListAgencyId:codelistId(version).codeId|SDMX:CL_FREQ(1.0.0).Q 638 +|//Codelist//|codeListAgencyId:codeListId(version)|SDMX:CL_FREQ(1.0.0) 639 +|ComponentMap|structureMapAgencyId:structureMap(version).com ponentMapId|SDMX:BOP_STRUCTURES(1.0.0).REF_AREA_TO_COUNT RY 640 +|Concept|conceptSchemeAgencyId:conceptSchemeId(versio n).conceptId|SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0).FREQ 641 +|//ConceptScheme//|conceptSchemeAgencyId:conceptSchemeId(versio n)|SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0) 642 +|//ConceptSchemeMap//|((( 643 643 conceptSchemeMapAgencyId:conceptSchemeMap 644 + 644 644 Id(version) 645 -)))| (% style="width:1049px" %)SDMX:CONCEPT_MAP(1.0.0)646 -| (% style="width:250px" %)CustomType|(% style="width:639px" %)customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|(% style="width:1049px" %)ECB: CUSTOM_TYPE_SCHEME(1.0.0).CUSTOM_TYPE_1647 -| (% style="width:250px" %)//CustomTypeScheme//|(% style="width:639px" %)customTypeSchemeAgencyId customTypeSchemeId(version)|(% style="width:1049px" %)ECB:CUSTOM_TYPE_SCHEME(1.0.0)648 -| (% style="width:250px" %)DataAttrribute|(% style="width:639px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dataAttributeId|(% style="width:1049px" %)TFFS:EXT_DEBT(1.0.0).OBS_STATUS649 -| (% style="width:250px" %)//DataConstraint//|(% style="width:639px" %)dataConstraintAgencyId:dataConstraintId(version)|(% style="width:1049px" %)TFFS:CREDITOR_DATA_CONTENT(1.0.0)646 +)))|SDMX:CONCEPT_MAP(1.0.0) 647 +|CustomType|customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|ECB: CUSTOM_TYPE_SCHEME(1.0.0).CUSTOM_TYPE_1 648 +|//CustomTypeScheme//|customTypeSchemeAgencyId customTypeSchemeId(version)|ECB:CUSTOM_TYPE_SCHEME(1.0.0) 649 +|DataAttrribute|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dataAttributeId|TFFS:EXT_DEBT(1.0.0).OBS_STATUS 650 +|//DataConstraint//|dataConstraintAgencyId:dataConstraintId(version)|TFFS:CREDITOR_DATA_CONTENT(1.0.0) 650 650 651 -|(% style="width:248px" %)**Classname**|(% style="width:643px" %)**Ending URN pattern**|(% style="width:1047px" %)**Example** 652 -|(% style="width:248px" %)DataConsumer|(% style="width:643px" %)dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**).dataConsumerId|(% style="width:1047px" %)SDMX:**DATA_CONSUMERS**(**1.0**).CONSUMER_1 653 -|(% style="width:248px" %)//DataConsumerScheme//|(% style="width:643px" %)((( 654 -dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**) 655 -)))|(% style="width:1047px" %)SDMX:**DATA_CONSUMERS**(**1.0**) 656 -|(% style="width:248px" %)//Dataflow//|(% style="width:643px" %)dataflowAgencyId:dataflowId(version)|(% style="width:1047px" %)TFFS:CRED_EXT_DEBT(1.0.0) 657 -|(% style="width:248px" %)DataProvider|(% style="width:643px" %)((( 658 -dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**).dataProviderId 659 -)))|(% style="width:1047px" %)SDMX:**DATA_PROVIDERS**(**1.0**).PROVIDER_1 660 -|(% style="width:248px" %)//DataProviderScheme//|(% style="width:643px" %)((( 661 -dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**) 662 -)))|(% style="width:1047px" %)SDMX:**DATA_PROVIDERS**(**1.0**) 663 -|(% style="width:248px" %)//DataStructure//|(% style="width:643px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version)|(% style="width:1047px" %)TFFS:EXT_DEBT(1.0.0) 664 -|(% style="width:248px" %)Dimension|(% style="width:643px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dimensionId|(% style="width:1047px" %)TFFS:EXT_DEBT(1.0.0).FREQ 665 -|(% style="width:248px" %)((( 652 +|**Classname**|**Ending URN pattern**|**Example** 653 +|DataConsumer|dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**).dataConsumerId|SDMX:**DATA_CONSUMERS**(**1.0**).CONSUMER_1 654 +|//DataConsumerScheme//|((( 655 +dataConsumerSchemeAgencyId:**DATA_CONSUME** 656 + 657 +**RS**(**1.0**) 658 +)))|SDMX:**DATA_CONSUMERS**(**1.0**) 659 +|//Dataflow//|dataflowAgencyId:dataflowId(version)|TFFS:CRED_EXT_DEBT(1.0.0) 660 +|DataProvider|((( 661 +dataProviderSchemeAgencyId:**DATA_PROVIDERS**( 662 + 663 +**1.0**).dataProviderId 664 +)))|SDMX:**DATA_PROVIDERS**(**1.0**).PROVIDER_1 665 +|//DataProviderScheme//|((( 666 +dataProviderSchemeAgencyId:**DATA_PROVIDERS**( 667 + 668 +**1.0**) 669 +)))|SDMX:**DATA_PROVIDERS**(**1.0**) 670 +|//DataStructure//|dataStructureDefinitionAgencyId:dataStructureDef initionId(version)|TFFS:EXT_DEBT(1.0.0) 671 +|Dimension|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dimensionId|TFFS:EXT_DEBT(1.0.0).FREQ 672 +|((( 666 666 DimensionDescriptor 674 + 667 667 MeasureDescriptor 676 + 668 668 AttributeDescriptor 669 -)))| (% style="width:643px" %)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:1047px" %)(((678 +)))|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)|((( 670 670 TFFS:EXT_DEBT(1.0.0).DimensionDescriptor 680 + 671 671 TFFS:EXT_DEBT(1.0.0).MeasureDescriptor 682 + 672 672 TFFS:EXT_DEBT(1.0.0).AttributeDescriptor 673 673 ))) 674 -| (% style="width:248px" %)GroupDimensionDescriptor|(% style="width:643px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).groupDimensionDescriptorId|(% style="width:1047px" %)TFFS:EXT_DEBT(1.0.0).SIBLING675 -| (% style="width:248px" %)HierarchicalCode|(% style="width:643px" %)hierarchyAgencyId:hierarchyId(version).hierarchica lCode.hierarchicalCode|(% style="width:1047px" %)UNESCO:H-C-GOV(1.0.0).GOV_CODE1.GOV_CODE1_1685 +|GroupDimensionDescriptor|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).groupDimensionDescriptorId|TFFS:EXT_DEBT(1.0.0).SIBLING 686 +|HierarchicalCode|hierarchyAgencyId:hierarchyId(version).hierarchica lCode.hierarchicalCode|UNESCO:H-C-GOV(1.0.0).GOV_CODE1.GOV_CODE1_1 676 676 677 -| (% style="width:248px" %)**Classname**|(% style="width:646px" %)**Ending URN pattern**|(% style="width:1044px" %)**Example**678 -| (% style="width:248px" %)//Hierarchy//|(% style="width:646px" %)hierarchyAgencyId:hierarchyId(version)|(% style="width:1044px" %)UNESCO:H-C-GOV(1.0.0)679 -| (% style="width:248px" %)//HierarchyAssociation//|(% style="width:646px" %)hierarchyAssociationAgencyId:hierarchyAssociatio nId(version)|(% style="width:1044px" %)UNESCO:CL_EXP_SOURCE(1.0.0)680 -| (% style="width:248px" %)Level|(% style="width:646px" %)hierarchyAgencyId:hierarchyId(version).level|(% style="width:1044px" %)UNESCO:H-C-GOV(1.0.0).LVL1681 -| (% style="width:248px" %)Measure|(% style="width:646px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).measureId|(% style="width:1044px" %)TFFS:EXT_DEBT(1.0.0).OBS_VALUE682 -| (% style="width:248px" %)MetadataAttribute|(% style="width:646px" %)(((688 +|**Classname**|**Ending URN pattern**|**Example** 689 +|//Hierarchy//|hierarchyAgencyId:hierarchyId(version)|UNESCO:H-C-GOV(1.0.0) 690 +|//HierarchyAssociation//|hierarchyAssociationAgencyId:hierarchyAssociatio nId(version)|UNESCO:CL_EXP_SOURCE(1.0.0) 691 +|Level|hierarchyAgencyId:hierarchyId(version).level|UNESCO:H-C-GOV(1.0.0).LVL1 692 +|Measure|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).measureId|TFFS:EXT_DEBT(1.0.0).OBS_VALUE 693 +|MetadataAttribute|((( 683 683 msdAgencyId:msdId(version).metadataAttributeId. 695 + 684 684 metadataAttributeId 685 -)))| (% style="width:1044px" %)IMF:SDDS_MSD(1.0.0).COMPILATION.METHOD686 -| (% style="width:248px" %)MetadataAttributeDescriptor|(% style="width:646px" %)msdAgencyId:msdId(version).metadataAttributeDe scriptorId|(% style="width:1044px" %)IMF:SDDS_MSD(1.0.0).MetadataAttributeDescriptor687 -| (% style="width:248px" %)//MetadataConstraint//|(% style="width:646px" %)metadataConstraintAgencyId:metadataConstraintI d(version)|(% style="width:1044px" %)TFFS:CREDITOR_METADATA_CONTENT(1.0.0)688 -| (% style="width:248px" %)//Metadataflow//|(% style="width:646px" %)metadataflowAgencyId:metadataflowId(version)|(% style="width:1044px" %)IMF:SDDS_MDF(1.0.0)689 -| (% style="width:248px" %)MetadataProvider|(% style="width:646px" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**).metadataProviderId|(% style="width:1044px" %)SDMX:**METADATA_PROVIDERS**(**1.0**).MD_PROVIDER_1690 -| (% style="width:248px" %)//MetadataProviderScheme//|(% style="width:646px" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**)|(% style="width:1044px" %)SDMX:**METADATA_PROVIDERS**(**1.0**)691 -| (% style="width:248px" %)//MetadataProvisionAgreement//|(% style="width:646px" %)metadataProvisionAgreementAgencyId:metadataP rovisionAgreementId(version)|(% style="width:1044px" %)IMF:SDDS_MDF_AB(1.0.0)692 -| (% style="width:248px" %)//MetadataSet//|(% style="width:646px" %)metadataProviderId:metadataSetId(version)|(% style="width:1044px" %)MD_PROVIDER:METADATASET(1.0.0)693 -| (% style="width:248px" %)//MetadataStructure//|(% style="width:646px" %)msdAgencyId:msdId(version)|(% style="width:1044px" %)IMF:SDDS_MSD(1.0.0)697 +)))|IMF:SDDS_MSD(1.0.0).COMPILATION.METHOD 698 +|MetadataAttributeDescriptor|msdAgencyId:msdId(version).metadataAttributeDe scriptorId|IMF:SDDS_MSD(1.0.0).MetadataAttributeDescriptor 699 +|//MetadataConstraint//|metadataConstraintAgencyId:metadataConstraintI d(version)|TFFS:CREDITOR_METADATA_CONTENT(1.0.0) 700 +|//Metadataflow//|metadataflowAgencyId:metadataflowId(version)|IMF:SDDS_MDF(1.0.0) 701 +|MetadataProvider|metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**).metadataProviderId|SDMX:**METADATA_PROVIDERS**(**1.0**).MD_PROVIDER_1 702 +|//MetadataProviderScheme//|metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**)|SDMX:**METADATA_PROVIDERS**(**1.0**) 703 +|//MetadataProvisionAgreement//|metadataProvisionAgreementAgencyId:metadataP rovisionAgreementId(version)|IMF:SDDS_MDF_AB(1.0.0) 704 +|//MetadataSet//|metadataProviderId:metadataSetId(version)|MD_PROVIDER:METADATASET(1.0.0) 705 +|//MetadataStructure//|msdAgencyId:msdId(version)|IMF:SDDS_MSD(1.0.0) 694 694 695 -| (% style="width:248px" %)**Classname**|(% style="width:629px" %)**Ending URN pattern**|(% style="width:1061px" %)**Example**696 -| (% style="width:248px" %)NamePersonalisation|(% style="width:629px" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|(% style="width:1061px" %)ECB:PSN_SCHEME(1.0.0).PSN1234697 -| (% style="width:248px" %)//NamePersonalisationScheme//|(% style="width:629px" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|(% style="width:1061px" %)ECB:PSN_SCHEME(1.0.0)698 -| (% style="width:248px" %)//OrganisationSchemeMap//|(% style="width:629px" %)orgSchemeMapAgencyId:orgSchemeMapId(versio n)|(% style="width:1061px" %)SDMX:AGENCIES_PROVIDERS(1.0.0)699 -| (% style="width:248px" %)OrganisationUnit|(% style="width:629px" %)organisationUnitSchemeAgencyId:organisationUnitSchemeId(version).organisationUnitId|(% style="width:1061px" %)ECB:ORGANISATIONS(1.0.0).1F700 -| (% style="width:248px" %)//OrganisationUnitScheme//|(% style="width:629px" %)organisationUnitSchemeAgencyId:organisationUni tSchemeId(version)|(% style="width:1061px" %)ECB:ORGANISATIONS(1.0.0)701 -| (% style="width:248px" %)//Process//|(% style="width:629px" %)processAgencyId:processId{version)|(% style="width:1061px" %)BIS:PROCESS1(1.0.0)702 -| (% style="width:248px" %)ProcessStep|(% style="width:629px" %)(((707 +|**Classname**|**Ending URN pattern**|**Example** 708 +|NamePersonalisation|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|ECB:PSN_SCHEME(1.0.0).PSN1234 709 +|//NamePersonalisationScheme//|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|ECB:PSN_SCHEME(1.0.0) 710 +|//OrganisationSchemeMap//|orgSchemeMapAgencyId:orgSchemeMapId(versio n)|SDMX:AGENCIES_PROVIDERS(1.0.0) 711 +|OrganisationUnit|organisationUnitSchemeAgencyId:organisationUni tSchemeId(version).organisationUnitId|ECB:ORGANISATIONS(1.0.0).1F 712 +|//OrganisationUnitScheme//|organisationUnitSchemeAgencyId:organisationUni tSchemeId(version)|ECB:ORGANISATIONS(1.0.0) 713 +|//Process//|processAgencyId:processId{version)|BIS:PROCESS1(1.0.0) 714 +|ProcessStep|((( 703 703 processAgencyId:processId(version).processStepId. 716 + 704 704 processStepId 705 -)))| (% style="width:1061px" %)BIS:PROCESS1(1.0.0).STEP1.STEP1_1706 -| (% style="width:248px" %)//ProvisionAgreement//|(% style="width:629px" %)provisionAgreementAgencyId:provisionAgreement Id(version)|(% style="width:1061px" %)TFFS:CRED_EXT_DEBT_AB(1.0.0)707 -| (% style="width:248px" %)ReportingCategory|(% style="width:629px" %)(((718 +)))|BIS:PROCESS1(1.0.0).STEP1.STEP1_1 719 +|//ProvisionAgreement//|provisionAgreementAgencyId:provisionAgreement Id(version)|TFFS:CRED_EXT_DEBT_AB(1.0.0) 720 +|ReportingCategory|((( 708 708 reportingTaxonomyAgencyId: 722 + 709 709 reportingTaxonomyId(version).reportingCategoryI d.reportingCategoryId 710 -)))| (% style="width:1061px" %)IMF:REP_1(1.0.0):LVL1_REP_CAT.LVL2_REP_CAT711 -| (% style="width:248px" %)//ReportingTaxonomy//|(% style="width:629px" %)reportingTaxonomyAgencyId:reportingTaxonomyI d(version)|(% style="width:1061px" %)IMF:REP_1(1.0.0)712 -| (% style="width:248px" %)//ReportingTaxonomyMap//|(% style="width:629px" %)repTaxonomyAgencyId:repTaxonomyId(version)|(% style="width:1061px" %)SDMX:RT_MAP(1.0.0)724 +)))|IMF:REP_1(1.0.0):LVL1_REP_CAT.LVL2_REP_CAT 725 +|//ReportingTaxonomy//|reportingTaxonomyAgencyId:reportingTaxonomyI d(version)|IMF:REP_1(1.0.0) 726 +|//ReportingTaxonomyMap//|repTaxonomyAgencyId:repTaxonomyId(version)|SDMX:RT_MAP(1.0.0) 713 713 714 -| (% style="width:247px" %)**Classname**|(% style="width:649px" %)**Ending URN pattern**|(% style="width:1042px" %)**Example**715 -| (% style="width:247px" %)//RepresentationMap//|(% style="width:649px" %)repMapAgencyId:repMapId(version)|(% style="width:1042px" %)SDMX:REF_AREA_MAPPING(1.0.0)716 -| (% style="width:247px" %)Ruleset|(% style="width:649px" %)rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|(% style="width:1042px" %)ECB:RULESET_23(1.0.0).SET111717 -| (% style="width:247px" %)//RulesetScheme//|(% style="width:649px" %)rulesetSchemeAgencyId rulesetSchemeId(version)|(% style="width:1042px" %)ECB:RULESET_23(1.0.0)718 -| (% style="width:247px" %)//StructureMap//|(%style="width:649px" %)structureMapAgencyId:structureMap(version)|(% style="width:1042px" %)SDMX:BOP_STRUCTURES(1.0.0)719 -| (% style="width:247px" %)Subscription|(% style="width:649px" %)(((728 +|**Classname**|**Ending URN pattern**|**Example** 729 +|//RepresentationMap//|repMapAgencyId:repMapId(version)|SDMX:REF_AREA_MAPPING(1.0.0) 730 +|Ruleset|rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|ECB:RULESET_23(1.0.0).SET111 731 +|//RulesetScheme//|rulesetSchemeAgencyId rulesetSchemeId(version)|ECB:RULESET_23(1.0.0) 732 +|//StructureMap//|structureMapAgencyId:structureMap(version)|SDMX:BOP_STRUCTURES(1.0.0) 733 +|Subscription|((( 720 720 The Subscription is not itself an Identifiable Artefact and therefore it does not follow the rules for URN structure. 735 + 721 721 The name of the URN is registryURN There is no pre-determined format. 722 -)))|(% 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. 723 -|(% style="width:247px" %)TimeDimension|(% style="width:649px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).timeDimensionId|(% style="width:1042px" %)TFFS:EXT_DEBT(1.0.0).TIME_PERIOD 724 -|(% style="width:247px" %)Transformation|(% style="width:649px" %)transformationSchemeAgencyId transformationSchemeId(version) transformationId|(% style="width:1042px" %)ECB:TRANSFORMATION_SCHEME(1.0.0).TRANS_1 725 -|(% style="width:247px" %)//TransformationScheme//|(% style="width:649px" %)transformationSchemeAgencyId transformationSchemeId(version)|(% style="width:1042px" %)ECB: TRANSFORMATION_SCHEME(1.0.0) 726 -|(% style="width:247px" %)Transition|(% style="width:649px" %)((( 737 +)))|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. 738 +|TimeDimension|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).timeDimensionId|TFFS:EXT_DEBT(1.0.0).TIME_PERIOD 739 +|Transformation|transformationSchemeAgencyId transformationSchemeId(version) transformationId|ECB:TRANSFORMATION_SCHEME(1.0.0).TRANS_1 740 +|//TransformationScheme//|transformationSchemeAgencyId transformationSchemeId(version)|ECB: TRANSFORMATION_SCHEME(1.0.0) 741 +|**Classname**|**Ending URN pattern**|**Example** 742 +|Transition|((( 727 727 processAgencyId:processId(version).processStepId. 744 + 728 728 transitionId 729 -)))| (% style="width:1042px" %)BIS:PROCESS1(1.0.0).STEP1.TRANSITION1730 -| (% style="width:247px" %)UserDefinedOperator|(% style="width:649px" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|(% style="width:1042px" %)ECB:OS_CALC(1.2.0).OS267731 -| (% style="width:247px" %)//UserDefinedOperatorScheme//|(% style="width:649px" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|(% style="width:1042px" %)ECB:OS_CALC(1.2.0)732 -| (% style="width:247px" %)//ValueList//|(% style="width:649px" %)valuelistAgencyId:valuelistId(version)|(% style="width:1042px" %)SDMX:VLIST(1.0.0)733 -| (% style="width:247px" %)VtlCodelistMapping|(% style="width:649px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|(% style="width:1042px" %)ECB:CLIST_MP(2.0.0).ABZ734 -| (% style="width:247px" %)VtlConceptMapping|(% style="width:649px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|(% style="width:1042px" %)ECB:CLIST_MP(1.0.0).XYA735 -| (% style="width:247px" %)VtlDataflowMapping|(% style="width:649px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|(% style="width:1042px" %)ECB:CLIST_MP(1.0.0).MOQ736 -| (% style="width:247px" %)//VtlMappingScheme//|(% style="width:649px" %)vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|(% style="width:1042px" %)ECB:CLIST_MP(2.0.0)746 +)))|BIS:PROCESS1(1.0.0).STEP1.TRANSITION1 747 +|UserDefinedOperator|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|ECB:OS_CALC(1.2.0).OS267 748 +|//UserDefinedOperatorScheme//|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|ECB:OS_CALC(1.2.0) 749 +|//ValueList//|valuelistAgencyId:valuelistId(version)|SDMX:VLIST(1.0.0) 750 +|VtlCodelistMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|ECB:CLIST_MP(2.0.0).ABZ 751 +|VtlConceptMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|ECB:CLIST_MP(1.0.0).XYA 752 +|VtlDataflowMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|ECB:CLIST_MP(1.0.0).MOQ 753 +|//VtlMappingScheme//|vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|ECB:CLIST_MP(2.0.0) 737 737 738 738 **Table 3: Table of identification components for SDMX Identifiable Artefacts** 739 739 ... ... @@ -757,54 +757,62 @@ 757 757 758 758 The following table lists the Maintainable Artefacts. 759 759 760 -(% style="width:881.294px" %) 761 -|(% colspan="2" style="width:522px" %)**Maintainable Artefacts**|(% style="width:490px" %)**Content** 762 -|(% style="width:198px" %)**Abstract Class**|(% style="width:324px" %)**Concrete Class**|(% style="width:490px" %) 763 -|(% style="width:198px" %)Item Scheme|(% style="width:324px" %)Codelist|(% style="width:490px" %)Code 764 -|(% style="width:198px" %) |(% style="width:324px" %)Concept Scheme|(% style="width:490px" %)Concept 765 -|(% style="width:198px" %) |(% style="width:324px" %)Category Scheme|(% style="width:490px" %)Category 766 -|(% style="width:198px" %) |(% style="width:324px" %)Organisation Unit Scheme|(% style="width:490px" %)Organisation Unit 767 -|(% style="width:198px" %) |(% style="width:324px" %)Agency Scheme|(% style="width:490px" %)Agency 768 -|(% style="width:198px" %) |(% style="width:324px" %)Data Provider Scheme|(% style="width:490px" %)Data Provider 769 -|(% style="width:198px" %) |(% style="width:324px" %)Metadata Provider Scheme|(% style="width:490px" %)Metadata Provider 770 -|(% style="width:198px" %) |(% style="width:324px" %)Data Consumer Scheme|(% style="width:490px" %)Data Consumer 771 -|(% style="width:198px" %) |(% style="width:324px" %)Reporting Taxonomy|(% style="width:490px" %)Reporting Category 772 -|(% style="width:198px" %) |(% style="width:324px" %)Transformation Scheme|(% style="width:490px" %)Transformation 773 -|(% style="width:198px" %) |(% style="width:324px" %)Custom Type Scheme|(% style="width:490px" %)Custom Type 774 -|(% style="width:198px" %) |(% style="width:324px" %)Name Personalisation Scheme|(% style="width:490px" %)Name Personalisation 775 -|(% style="width:198px" %) |(% style="width:324px" %)Vtl Mapping Scheme|(% style="width:490px" %)Vtl Codelist Mapping Vtl Concept Mapping 776 -|(% style="width:198px" %) |(% style="width:324px" %)Ruleset Scheme|(% style="width:490px" %)Ruleset 777 -|(% style="width:198px" %) |(% style="width:324px" %)User Defined Operator Scheme|(% style="width:490px" %)User Defined Operator 778 -|(% style="width:198px" %)Enumerated List|(% style="width:324px" %)ValueList|(% style="width:490px" %)Value Item 779 -|(% style="width:198px" %)Structure|(% style="width:324px" %)Data Structure Definition|(% style="width:490px" %)((( 777 +|(% colspan="2" %)**Maintainable Artefacts**|**Content** 778 +|**Abstract Class**|**Concrete Class**| 779 +|Item Scheme|Codelist|Code 780 +||Concept Scheme|Concept 781 +||Category Scheme|Category 782 +||Organisation Unit Scheme|Organisation Unit 783 +||Agency Scheme|Agency 784 +||Data Provider Scheme|Data Provider 785 +||Metadata Provider Scheme|Metadata Provider 786 +||Data Consumer Scheme|Data Consumer 787 +||Reporting Taxonomy|Reporting Category 788 +||Transformation Scheme|Transformation 789 +||Custom Type Scheme|Custom Type 790 +||Name Personalisation Scheme|Name Personalisation 791 +||Vtl Mapping Scheme|Vtl Codelist Mapping Vtl Concept Mapping 792 +||Ruleset Scheme|Ruleset 793 +||User Defined Operator Scheme|User Defined Operator 794 +|Enumerated List|ValueList|Value Item 795 +|Structure|Data Structure Definition|((( 780 780 Dimension Descriptor 797 + 781 781 Group Dimension Descriptor 799 + 782 782 Dimension 801 + 783 783 Time Dimension 803 + 784 784 Attribute Descriptor 805 + 785 785 Data Attribute 807 + 786 786 Measure Descriptor 809 + 787 787 Measure 788 788 ))) 789 -| (% style="width:198px" %)|(% style="width:324px" %)Metadata Structure Definition|(% style="width:490px" %)Metadata Attribute Descriptor Metadata Attribute790 -| (% style="width:198px" %)Structure Usage|(% style="width:324px" %)Dataflow|(% style="width:490px" %)791 -| (% style="width:198px" %)|(% style="width:324px" %)Metadataflow|(% style="width:490px" %)792 -| (% style="width:198px" %)None|(% style="width:324px" %)Process|(% style="width:490px" %)Process Step793 -| (% style="width:198px" %)None|(% style="width:324px" %)Structure Map|(% style="width:490px" %)(((812 +||Metadata Structure Definition|Metadata Attribute Descriptor Metadata Attribute 813 +|Structure Usage|Dataflow| 814 +||Metadataflow| 815 +|None|Process|Process Step 816 +|None|Structure Map|((( 794 794 Component Map 818 + 795 795 Epoch Map 820 + 796 796 Date Pattern Map 797 797 ))) 798 -| (% style="width:198px" %)None|(% style="width:324px" %)Representation Map|(% style="width:490px" %)Representation Mapping799 -| (% style="width:198px" %)Item Scheme Map|(% style="width:324px" %)Organisation Scheme Map|(% style="width:490px" %)Item Map800 -| (% style="width:198px" %)|(% style="width:324px" %)Concept Scheme Map|(% style="width:490px" %)Item Map801 -| (% style="width:198px" %)|(% style="width:324px" %)Category Scheme Map|(% style="width:490px" %)Item Map802 -| (% style="width:198px" %)|(% style="width:324px" %)Reporting Taxonomy Map|(% style="width:490px" %)Item Map803 -| (% style="width:198px" %)None|(% style="width:324px" %)Provision Agreement|(% style="width:490px" %)804 -| (% style="width:198px" %)None|(% style="width:324px" %)Metadata Provision Agreement|(% style="width:490px" %)805 -| (% style="width:198px" %)None|(% style="width:324px" %)Hierarchy|(% style="width:490px" %)Hierarchical Code806 -| (% style="width:198px" %)None|(% style="width:324px" %)Hierarchy Association|(% style="width:490px" %)807 -| (% style="width:198px" %)None|(% style="width:324px" %)Categorisation|(% style="width:490px" %)823 +|None|Representation Map|Representation Mapping 824 +|Item Scheme Map|Organisation Scheme Map|Item Map 825 +||Concept Scheme Map|Item Map 826 +||Category Scheme Map|Item Map 827 +||Reporting Taxonomy Map|Item Map 828 +|None|Provision Agreement| 829 +|None|Metadata Provision Agreement| 830 +|None|Hierarchy|Hierarchical Code 831 +|None|Hierarchy Association| 832 +|None|Categorisation| 808 808 809 809 **Table 4: Table of Maintainable Artefacts for Structural Definition Metadata** 810 810 ... ... @@ -812,11 +812,14 @@ 812 812 813 813 The artefacts included in the structural definitions are: 814 814 815 -* 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) 816 -* All types of Enumerated List (ValueList){{footnote}}Note that Codelist is also an EnumeratedList.{{/footnote}} 817 -* All types of Structure (Data Structure Definition, Metadata Structure Definition) 818 -* All types of Structure Usage (Dataflow, Metadataflow) 840 +• 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) 819 819 842 +• All types of Enumerated List (ValueList)^^[[^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]]^^ 843 + 844 +• All types of Structure (Data Structure Definition, Metadata Structure Definition) 845 + 846 +• All types of Structure Usage (Dataflow, Metadataflow) 847 + 820 820 ===== {{id name="_Toc93865"/}}7.1.3 Structure Usage ===== 821 821 822 822 **7.1.3.1 Structure Usage: Basic Concepts** ... ... @@ -845,9 +845,9 @@ 845 845 * Categorisation to Dataflow and Category 846 846 * Categorisation to Metadataflow and Category 847 847 848 -== {{id name="_Toc93866"/}}7.2 Data and Metadata Provisioning == 876 +=== {{id name="_Toc93866"/}}7.2 Data and Metadata Provisioning === 849 849 850 -=== {{id name="_Toc93867"/}}7.2.1 Provisioning Agreement: Basic concepts === 878 +===== {{id name="_Toc93867"/}}7.2.1 Provisioning Agreement: Basic concepts ===== 851 851 852 852 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. 853 853 ... ... @@ -855,7 +855,7 @@ 855 855 856 856 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. 857 857 858 -=== {{id name="_Toc93868"/}}7.2.2 Provisioning Agreement Model – pull use case === 886 +===== {{id name="_Toc93868"/}}7.2.2 Provisioning Agreement Model – pull use case ===== 859 859 860 860 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. 861 861 ... ... @@ -877,9 +877,9 @@ 877 877 878 878 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. 879 879 880 -== {{id name="_Toc93869"/}}7.3 Data and Metadata Constraints == 908 +=== {{id name="_Toc93869"/}}7.3 Data and Metadata Constraints === 881 881 882 -=== {{id name="_Toc93870"/}}7.3.1 Data and Metadata Constraints: Basic Concepts === 910 +===== {{id name="_Toc93870"/}}7.3.1 Data and Metadata Constraints: Basic Concepts ===== 883 883 884 884 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. 885 885 ... ... @@ -943,14 +943,17 @@ 943 943 944 944 The Registration has an action attribute which takes one of the following values: 945 945 974 +: 975 + 946 946 ((( 947 -(% style="width:761.294px" %) 948 -|(% style="width:196px" %)**Action Attribute Value**|(% style="width:561px" %)**Behaviour** 949 -|(% style="width:196px" %)Append|(% style="width:561px" %)Add this Registration to the registry 950 -|(% style="width:196px" %)Replace|(% style="width:561px" %)((( 951 -Replace the existing Registration with identified by the id in the Registration of the SubmitRegistrationRequest 977 +|**Action Attribute Value**|**Behaviour** 978 +|Append|Add this Registration to the registry 979 +|Replace|((( 980 +Replace the existing Registration with identified by the id in the 981 + 982 +Registration of the SubmitRegistrationRequest 952 952 ))) 953 -| (% style="width:196px" %)Delete|(% style="width:561px" %)Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest984 +|Delete|Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest 954 954 ))) 955 955 956 956 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_bc1dcdec.jpg||height="575" width="579"]] ... ... @@ -967,20 +967,27 @@ 967 967 968 968 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. 969 969 1001 +: 1002 + 970 970 ((( 971 -(% style="width:678.294px" %) 972 -|**Indexing Required**|(% style="width:504px" %)**Registration Process Activity** 973 -|indexTimeSeries|(% style="width:504px" %)Extract all the series keys and create a KeySet(s) Constraint. 974 -|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. 975 -|indexReportingPeriod|(% style="width:504px" %)((( 1004 +|**Indexing Required**|**Registration Process Activity** 1005 +|indexTimeSeries|Extract all the series keys and create a KeySet(s) Constraint. 1006 +|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. 1007 +|indexReportingPeriod|((( 976 976 This applies only to a registered __dataset__. 1009 + 977 977 Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint. 978 978 ))) 979 -|**Indexing Required**| (% style="width:504px" %)**Registration Process Activity**980 -|indexAttributes|( % style="width:504px" %)(((1012 +|**Indexing Required**|**Registration Process Activity** 1013 +|indexAttributes|((( 981 981 **Data Set** 982 -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 1015 + 1016 +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 1017 + 1018 +SDMXIM, and the associated Selection Value 1019 + 983 983 **Metadata Set** 1021 + 984 984 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. 985 985 ))) 986 986 ))) ... ... @@ -989,7 +989,7 @@ 989 989 990 990 The Registration must reference the ProvisionAgreement or MetadataProvisionAgreement to which it relates. 991 991 992 -=== {{id name="_Toc93876"/}}7.4.3 Registration Response === 1030 +===== {{id name="_Toc93876"/}}7.4.3 Registration Response ===== 993 993 994 994 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”. 995 995 ... ... @@ -1019,18 +1019,20 @@ 1019 1019 1020 1020 Regardless of the type of registry/repository events being observed, a subscription always contains: 1021 1021 1022 -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. 1060 +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. 1023 1023 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. 1024 1024 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. 1025 1025 1. A selector which specifies which type of events are of interest. The set of event types is: 1026 1026 1065 +: 1066 +:: 1067 + 1027 1027 ((( 1028 -(% style="width:856.294px" %) 1029 -|(% style="width:320px" %)**Event Type**|(% style="width:532px" %)**Comment** 1030 -|(% style="width:320px" %)STRUCTURAL_REPOSITORY_EVENTS|(% style="width:532px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository. 1031 -|(% 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. 1032 -|(% 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. 1033 -|(% style="width:320px" %)ALL_EVENTS|(% style="width:532px" %)All events of the specified EventType 1069 +|**Event Type**|**Comment** 1070 +|STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository. 1071 +|DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database. 1072 +|METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database. 1073 +|ALL_EVENTS|All events of the specified EventType 1034 1034 ))) 1035 1035 1036 1036 === {{id name="_Toc93880"/}}7.5.3 Wildcard Facility === ... ... @@ -1097,14 +1097,15 @@ 1097 1097 1098 1098 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: 1099 1099 1140 +: 1141 + 1100 1100 ((( 1101 -(% style="width:1126.29px" %) 1102 -|(% style="width:382px" %)**Selector**|(% style="width:740px" %)**Comment** 1103 -|(% 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. 1104 -|(% style="width:382px" %)ProvisionAgreement & MetadataProvisionAgreement|(% style="width:740px" %)Any datasets or metadata sets registered for the agreement will activate the notification. 1105 -|(% style="width:382px" %)Dataflow & Metadataflow|(% style="width:740px" %)Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification. 1106 -|(% 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 1107 -|(% 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. 1143 +|**Selector**|**Comment** 1144 +|DataProvider & MetadataProvider|Any datasets or metadata sets registered by the specified data or metadata provider will activate the notification. 1145 +|ProvisionAgreement & MetadataProvisionAgreement|Any datasets or metadata sets registered for the agreement will activate the notification. 1146 +|Dataflow & Metadataflow|Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification. 1147 +|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 1148 +|Category|Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category. 1108 1108 ))) 1109 1109 1110 1110 The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration. ... ... @@ -1136,6 +1136,10 @@ 1136 1136 1137 1137 The notification will contain the Registration. 1138 1138 1139 - ----1180 +[[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. 1140 1140 1141 -{{putFootnotes/}} 1182 +[[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: 1183 + 1184 +IMF.SubAgency1 1185 + 1186 +[[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
- SDMX 3-0-0 SECTION 5 FINAL-1.0_en_1edb9829.jpg
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -50.9 KB - Content
- SDMX 3-0-0 SECTION 5 FINAL-1.0_en_8a88db1c.jpg
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -184.8 KB - Content
- SDMX 3-0-0 SECTION 5 FINAL-1.0_en_99c4cc7e.jpg
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -126.4 KB - Content