Last modified by Artur on 2025/09/30 13:28
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -163,8 +163,9 @@ 163 163 164 164 The registry interfaces are invoked in one of two ways: 165 165 166 -1. The interface is the name of the root node of the SDMX-ML document 167 -1. The interface is invoked as a child element of the RegistryInterface message where the RegistryInterface is the root node of the SDMX-ML document. 166 +* 167 +*1. The interface is the name of the root node of the SDMX-ML document 168 +*1. The interface is invoked as a child element of the RegistryInterface message where the RegistryInterface is the root node of the SDMX-ML document. 168 168 169 169 In addition to these interfaces the registry must support a mechanism for submitting and querying for structural metadata. This is detailed in sections 5.2.2 and 5.2.3. 170 170 ... ... @@ -270,7 +270,7 @@ 270 270 1. If the action is set to “delete” (or a maintainable Artefact is DELETEd) then the Registry MUST verify that the object can be deleted. In order to qualify for deletion, the object must: 271 271 272 272 a) Be a draft version. 273 -b) Not be explicitly^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^1^^>>path:#sdfootnote1sym||name="sdfootnote1anc"]](%%)^^ referenced from any other object in the Registry.274 +b) Not be explicitly^^[[(% class="wikiinternallink wikiinternallink wikiinternallink" %)^^1^^>>path:#sdfootnote1sym||name="sdfootnote1anc"]](%%)^^ referenced from any other object in the Registry. 274 274 275 275 4) The semantic versioning rules in the SDMX documentation MUST be obeyed. 276 276 ))) ... ... @@ -418,7 +418,7 @@ 418 418 419 419 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. 420 420 421 - ====6.2.2.3 Explanation of the generic structure====422 +**6.2.2.3 Explanation of the generic structure** 422 422 423 423 In the explanation below the actual object that is the target of the URN is called the **actual object**. 424 424 ... ... @@ -497,103 +497,103 @@ 497 497 498 498 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. 499 499 500 -=== 6.2.3 Table of SDMX-IM Packages and Classes === 501 +===== {{id name="_Toc90808"/}}6.2.3 Table of SDMX-IM Packages and Classes ===== 501 501 502 502 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. 503 503 504 -(% style="width:750.835px" %) 505 -|(% style="width:222px" %)**Package**|(% style="width:526px" %)**URN class name (model class name where this is different)** 506 -|(% style="width:222px" %)base|(% style="width:526px" %)Agency 507 -|(% style="width:222px" %) |(% style="width:526px" %)AgencyScheme 508 -|(% style="width:222px" %) |(% style="width:526px" %)DataConsumer 509 -|(% style="width:222px" %) |(% style="width:526px" %)DataConsumerScheme 510 -|(% style="width:222px" %) |(% style="width:526px" %)DataProvider 511 -|(% style="width:222px" %) |(% style="width:526px" %)DataProviderScheme 512 -|(% style="width:222px" %) |(% style="width:526px" %)MetadataProvider 513 -|(% style="width:222px" %) |(% style="width:526px" %)MetadataProviderScheme 514 -|(% style="width:222px" %) |(% style="width:526px" %)OrganisationUnit 515 -|(% style="width:222px" %) |(% style="width:526px" %)OrganisationUnitScheme 516 -|(% style="width:222px" %) |(% style="width:526px" %) 517 -|(% style="width:222px" %)datastructure|(% style="width:526px" %)AttributeDescriptor 518 -|(% style="width:222px" %) |(% style="width:526px" %)DataAttribute 519 -|(% style="width:222px" %) |(% style="width:526px" %)Dataflow 520 -|(% style="width:222px" %) |(% style="width:526px" %)DataStructure (DataStructureDefinition) 521 -|(% style="width:222px" %) |(% style="width:526px" %)Dimension 522 -|(% style="width:222px" %) |(% style="width:526px" %)DimensionDescriptor 523 -|(% style="width:222px" %) |(% style="width:526px" %)GroupDimensionDescriptor 524 -|(% style="width:222px" %) |(% style="width:526px" %)Measure 525 -|(% style="width:222px" %) |(% style="width:526px" %)MeasureDescriptor 526 -|(% style="width:222px" %) |(% style="width:526px" %)TimeDimension 527 -|(% style="width:222px" %) |(% style="width:526px" %) 528 -|(% style="width:222px" %)metadatastructure|(% style="width:526px" %)MetadataAttribute 529 -|(% style="width:222px" %) |(% style="width:526px" %)MetadataAttributeDescriptor 530 -|(% style="width:222px" %) |(% style="width:526px" %)((( 505 +|**Package**|**URN class name (model class name where this is different)** 506 +|base|Agency 507 +| |AgencyScheme 508 +| |DataConsumer 509 +| |DataConsumerScheme 510 +| |DataProvider 511 +| |DataProviderScheme 512 +| |MetadataProvider 513 +| |MetadataProviderScheme 514 +| |OrganisationUnit 515 +| |OrganisationUnitScheme 516 +| | 517 +|datastructure|AttributeDescriptor 518 +| |DataAttribute 519 +| |Dataflow 520 +| |DataStructure (DataStructureDefinition) 521 +| |Dimension 522 +| |DimensionDescriptor 523 +| |GroupDimensionDescriptor 524 +| |Measure 525 +| |MeasureDescriptor 526 +| |TimeDimension 527 +| | 528 +|metadatastructure|MetadataAttribute 529 +| |MetadataAttributeDescriptor 530 +| |((( 531 531 MetadataStructure 532 532 533 533 (MetadataStructureDefinition) 534 534 ))) 535 535 536 +: 537 + 536 536 ((( 537 -(% style="width:751.835px" %) 538 -|(% style="width:221px" %)**Package**|(% style="width:528px" %)**URN class name (model class name where this is different)** 539 -|(% style="width:221px" %) |(% style="width:528px" %)Metadataflow 540 -|(% style="width:221px" %) |(% style="width:528px" %)MetadataSet 541 -|(% style="width:221px" %) |(% style="width:528px" %) 542 -|(% style="width:221px" %)process|(% style="width:528px" %)Process 543 -|(% style="width:221px" %) |(% style="width:528px" %)ProcessStep 544 -|(% style="width:221px" %) |(% style="width:528px" %)Transition 545 -|(% style="width:221px" %) |(% style="width:528px" %) 546 -|(% style="width:221px" %)registry|(% style="width:528px" %)DataConstraint 547 -|(% style="width:221px" %) |(% style="width:528px" %)MetadataConstraint 548 -|(% style="width:221px" %) |(% style="width:528px" %)MetadataProvisionAgreement 549 -|(% style="width:221px" %) |(% style="width:528px" %)ProvisionAgreement 550 -|(% style="width:221px" %) |(% style="width:528px" %)Subscription 551 -|(% style="width:221px" %) |(% style="width:528px" %) 552 -|(% style="width:221px" %)structuremapping|(% style="width:528px" %)CategorySchemeMap 553 -|(% style="width:221px" %) |(% style="width:528px" %)ConceptSchemeMap 554 -|(% style="width:221px" %) |(% style="width:528px" %)OrganisationSchemeMap 555 -|(% style="width:221px" %) |(% style="width:528px" %)ReportingTaxonomyMap 556 -|(% style="width:221px" %) |(% style="width:528px" %)RepresentationMap 557 -|(% style="width:221px" %) |(% style="width:528px" %)StructureMap 558 -|(% style="width:221px" %) |(% style="width:528px" %) 559 -|(% style="width:221px" %)codelist|(% style="width:528px" %)Code 560 -|(% style="width:221px" %) |(% style="width:528px" %)Codelist 561 -|(% style="width:221px" %) |(% style="width:528px" %)HierarchicalCode 562 -|(% style="width:221px" %) |(% style="width:528px" %)Hierarchy 563 -|(% style="width:221px" %) |(% style="width:528px" %)HierarchyAssociation 564 -|(% style="width:221px" %) |(% style="width:528px" %)Level 565 -|(% style="width:221px" %) |(% style="width:528px" %)ValueList 566 -|(% style="width:221px" %) |(% style="width:528px" %) 567 -|(% style="width:221px" %)categoryscheme|(% style="width:528px" %)Categorisation 568 -|(% style="width:221px" %) |(% style="width:528px" %)Category 569 -|(% style="width:221px" %) |(% style="width:528px" %)CategoryScheme 570 -|(% style="width:221px" %) |(% style="width:528px" %)ReportingCategory 571 -|(% style="width:221px" %) |(% style="width:528px" %)ReportingTaxonomy 572 -|(% style="width:221px" %)**Package**|(% style="width:528px" %)**URN class name (model class name where this is different)** 573 -|(% style="width:221px" %) |(% style="width:528px" %) 574 -|(% style="width:221px" %)conceptscheme|(% style="width:528px" %)Concept 575 -|(% style="width:221px" %) |(% style="width:528px" %)ConceptScheme 576 -|(% style="width:221px" %) |(% style="width:528px" %) 577 -|(% style="width:221px" %)transformation|(% style="width:528px" %)CustomType 578 -|(% style="width:221px" %) |(% style="width:528px" %)CustomTypeScheme 579 -|(% style="width:221px" %) |(% style="width:528px" %)NamePersonalisation 580 -|(% style="width:221px" %) |(% style="width:528px" %)NamePersonalisationScheme 581 -|(% style="width:221px" %) |(% style="width:528px" %)Ruleset 582 -|(% style="width:221px" %) |(% style="width:528px" %)RulesetScheme 583 -|(% style="width:221px" %) |(% style="width:528px" %)Transformation 584 -|(% style="width:221px" %) |(% style="width:528px" %)TransformationScheme 585 -|(% style="width:221px" %) |(% style="width:528px" %)UserDefinedOperator 586 -|(% style="width:221px" %) |(% style="width:528px" %)UserDefinedOperatorScheme 587 -|(% style="width:221px" %) |(% style="width:528px" %)VtlCodelistMapping 588 -|(% style="width:221px" %) |(% style="width:528px" %)VtlConceptMapping 589 -|(% style="width:221px" %) |(% style="width:528px" %)VtlDataflowMapping 590 -|(% style="width:221px" %) |(% style="width:528px" %)VtlMappingScheme 591 -|(% style="width:221px" %) |(% style="width:528px" %) 539 +|**Package**|**URN class name (model class name where this is different)** 540 +| |Metadataflow 541 +| |MetadataSet 542 +| | 543 +|process|Process 544 +| |ProcessStep 545 +| |Transition 546 +| | 547 +|registry|DataConstraint 548 +| |MetadataConstraint 549 +| |MetadataProvisionAgreement 550 +| |ProvisionAgreement 551 +| |Subscription 552 +| | 553 +|structuremapping|CategorySchemeMap 554 +| |ConceptSchemeMap 555 +| |OrganisationSchemeMap 556 +| |ReportingTaxonomyMap 557 +| |RepresentationMap 558 +| |StructureMap 559 +| | 560 +|codelist|Code 561 +| |Codelist 562 +| |HierarchicalCode 563 +| |Hierarchy 564 +| |HierarchyAssociation 565 +| |Level 566 +| |ValueList 567 +| | 568 +|categoryscheme|Categorisation 569 +| |Category 570 +| |CategoryScheme 571 +| |ReportingCategory 572 +| |ReportingTaxonomy 573 +|**Package**|**URN class name (model class name where this is different)** 574 +| | 575 +|conceptscheme|Concept 576 +| |ConceptScheme 577 +| | 578 +|transformation|CustomType 579 +| |CustomTypeScheme 580 +| |NamePersonalisation 581 +| |NamePersonalisationScheme 582 +| |Ruleset 583 +| |RulesetScheme 584 +| |Transformation 585 +| |TransformationScheme 586 +| |UserDefinedOperator 587 +| |UserDefinedOperatorScheme 588 +| |VtlCodelistMapping 589 +| |VtlConceptMapping 590 +| |VtlDataflowMapping 591 +| |VtlMappingScheme 592 +| | 592 592 ))) 593 593 594 594 **Table 2: SDMX-IM Packages and Contained Classes** 595 595 596 -=== 6.2.4 URN Identification components of SDMX objects === 597 +===== {{id name="_Toc90809"/}}6.2.4 URN Identification components of SDMX objects ===== 597 597 598 598 The table below describes the identification components for all SDMX object types that have identification. Note the actual attributes are all ‘id’ but have been prefixed by their class name or multiple class names to show navigation, e.g., ‘conceptSchemeAgencyId’ is really the ‘Id’ attribute of the Agency class that is associated to the ConceptScheme. 599 599 ... ... @@ -601,56 +601,67 @@ 601 601 602 602 urn:sdmx.org.sdmx.infomodel.{package}.{classname}= 603 603 604 -(% style="width:1272.83px" %) 605 -|(% style="width:290px" %)**Classname**|(% style="width:649px" %)**Ending URN pattern**|(% style="width:332px" %)**Example** 606 -|(% style="width:290px" %)Agency^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^|(% style="width:649px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|(% style="width:332px" %)ECB:**AGENCIES**(**1.0**).AA 607 -|(% style="width:290px" %)//AgencyScheme//|(% style="width:649px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**)|(% style="width:332px" %)ECB:**AGENCIES**(**1.0**) 608 -|(% style="width:290px" %)//Categorisation//|(% style="width:649px" %)categorisationAgencyId:categorisationId(version)|(% style="width:332px" %)IMF:cat001(1.0.0) 609 -|(% style="width:290px" %)Category|(% style="width:649px" %)categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|(% style="width:332px" %)IMF:SDDS(1.0.0):level_1_category.level_2_category … 610 -|(% style="width:290px" %)//CategoryScheme//|(% style="width:649px" %)categorySchemeAgencyId:categorySchemeId(versi on)|(% style="width:332px" %)IMF:SDDS(1.0.0) 605 +|**Classname**|**Ending URN pattern**|**Example** 606 +|Agency^^[[(% class="wikiinternallink wikiinternallink wikiinternallink" %)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^|agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|ECB:**AGENCIES**(**1.0**).AA 607 +|//AgencyScheme//|agencySchemeAgencyId:**AGENCIES**(**1.0**)|ECB:**AGENCIES**(**1.0**) 608 +|//Categorisation//|categorisationAgencyId:categorisationId(version)|IMF:cat001(1.0.0) 609 +|Category|categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|IMF:SDDS(1.0.0):level_1_category.level_2_category … 610 +|//CategoryScheme//|categorySchemeAgencyId:categorySchemeId(versi on)|IMF:SDDS(1.0.0) 611 611 612 -|(% style="width:292px" %)**Classname**|(% style="width:647px" %)**Ending URN pattern**|(% style="width:742px" %)**Example** 613 -|(% style="width:292px" %)//CategorySchemeMap//|(% style="width:647px" %)((( 614 -catSchemeMapAgencyId:catSchemeMapId(version) 615 -)))|(% style="width:742px" %)SDMX:EUROSTAT_SUBJECT_DOMAIN(1.0.0) 616 -|(% style="width:292px" %)Code|(% style="width:647px" %)codeListAgencyId:codelistId(version).codeId|(% style="width:742px" %)SDMX:CL_FREQ(1.0.0).Q 617 -|(% style="width:292px" %)//Codelist//|(% style="width:647px" %)codeListAgencyId:codeListId(version)|(% style="width:742px" %)SDMX:CL_FREQ(1.0.0) 618 -|(% style="width:292px" %)ComponentMap|(% style="width:647px" %)structureMapAgencyId:structureMap(version).com ponentMapId|(% style="width:742px" %)SDMX:BOP_STRUCTURES(1.0.0).REF_AREA_TO_COUNT RY 619 -|(% style="width:292px" %)Concept|(% style="width:647px" %)conceptSchemeAgencyId:conceptSchemeId(versio n).conceptId|(% style="width:742px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0).FREQ 620 -|(% style="width:292px" %)//ConceptScheme//|(% style="width:647px" %)conceptSchemeAgencyId:conceptSchemeId(versio n)|(% style="width:742px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0) 621 -|(% style="width:292px" %)//ConceptSchemeMap//|(% style="width:647px" %)((( 622 -conceptSchemeMapAgencyId:conceptSchemeMap Id(version) 623 -)))|(% style="width:742px" %)SDMX:CONCEPT_MAP(1.0.0) 624 -|(% style="width:292px" %)CustomType|(% style="width:647px" %)customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|(% style="width:742px" %)ECB: CUSTOM_TYPE_SCHEME(1.0.0).CUSTOM_TYPE_1 625 -|(% style="width:292px" %)//CustomTypeScheme//|(% style="width:647px" %)customTypeSchemeAgencyId customTypeSchemeId(version)|(% style="width:742px" %)ECB:CUSTOM_TYPE_SCHEME(1.0.0) 626 -|(% style="width:292px" %)DataAttrribute|(% style="width:647px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dataAttributeId|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0).OBS_STATUS 627 -|(% style="width:292px" %)//DataConstraint//|(% style="width:647px" %)dataConstraintAgencyId:dataConstraintId(version)|(% style="width:742px" %)TFFS:CREDITOR_DATA_CONTENT(1.0.0) 612 +|**Classname**|**Ending URN pattern**|**Example** 613 +|//CategorySchemeMap//|((( 614 +catSchemeMapAgencyId:catSchemeMapId(version 628 628 629 -|(% style="width:294px" %)**Classname**|(% style="width:645px" %)**Ending URN pattern**|(% style="width:742px" %)**Example** 630 -|(% style="width:294px" %)DataConsumer|(% style="width:645px" %)dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**).dataConsumerId|(% style="width:742px" %)SDMX:**DATA_CONSUMERS**(**1.0**).CONSUMER_1 631 -|(% style="width:294px" %)//DataConsumerScheme//|(% style="width:645px" %)((( 632 -dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**) 633 -)))|(% style="width:742px" %)SDMX:**DATA_CONSUMERS**(**1.0**) 634 -|(% style="width:294px" %)//Dataflow//|(% style="width:645px" %)dataflowAgencyId:dataflowId(version)|(% style="width:742px" %)TFFS:CRED_EXT_DEBT(1.0.0) 635 -|(% style="width:294px" %)DataProvider|(% style="width:645px" %)((( 636 -dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**).dataProviderId 637 -)))|(% style="width:742px" %)SDMX:**DATA_PROVIDERS**(**1.0**).PROVIDER_1 638 -|(% style="width:294px" %)//DataProviderScheme//|(% style="width:645px" %)((( 639 -dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**) 640 -)))|(% style="width:742px" %)SDMX:**DATA_PROVIDERS**(**1.0**) 641 -|(% style="width:294px" %)//DataStructure//|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version)|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0) 642 -|(% style="width:294px" %)Dimension|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dimensionId|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0).FREQ 643 -|(% style="width:294px" %)((( 616 +) 617 +)))|SDMX:EUROSTAT_SUBJECT_DOMAIN(1.0.0) 618 +|Code|codeListAgencyId:codelistId(version).codeId|SDMX:CL_FREQ(1.0.0).Q 619 +|//Codelist//|codeListAgencyId:codeListId(version)|SDMX:CL_FREQ(1.0.0) 620 +|ComponentMap|structureMapAgencyId:structureMap(version).com ponentMapId|SDMX:BOP_STRUCTURES(1.0.0).REF_AREA_TO_COUNT RY 621 +|Concept|conceptSchemeAgencyId:conceptSchemeId(versio n).conceptId|SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0).FREQ 622 +|//ConceptScheme//|conceptSchemeAgencyId:conceptSchemeId(versio n)|SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0) 623 +|//ConceptSchemeMap//|((( 624 +conceptSchemeMapAgencyId:conceptSchemeMap 625 + 626 +Id(version) 627 +)))|SDMX:CONCEPT_MAP(1.0.0) 628 +|CustomType|customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|ECB: CUSTOM_TYPE_SCHEME(1.0.0).CUSTOM_TYPE_1 629 +|//CustomTypeScheme//|customTypeSchemeAgencyId customTypeSchemeId(version)|ECB:CUSTOM_TYPE_SCHEME(1.0.0) 630 +|DataAttrribute|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dataAttributeId|TFFS:EXT_DEBT(1.0.0).OBS_STATUS 631 +|//DataConstraint//|dataConstraintAgencyId:dataConstraintId(version)|TFFS:CREDITOR_DATA_CONTENT(1.0.0) 632 + 633 +|**Classname**|**Ending URN pattern**|**Example** 634 +|DataConsumer|dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**).dataConsumerId|SDMX:**DATA_CONSUMERS**(**1.0**).CONSUMER_1 635 +|//DataConsumerScheme//|((( 636 +dataConsumerSchemeAgencyId:**DATA_CONSUME** 637 + 638 +**RS**(**1.0**) 639 +)))|SDMX:**DATA_CONSUMERS**(**1.0**) 640 +|//Dataflow//|dataflowAgencyId:dataflowId(version)|TFFS:CRED_EXT_DEBT(1.0.0) 641 +|DataProvider|((( 642 +dataProviderSchemeAgencyId:**DATA_PROVIDERS**( 643 + 644 +**1.0**).dataProviderId 645 +)))|SDMX:**DATA_PROVIDERS**(**1.0**).PROVIDER_1 646 +|//DataProviderScheme//|((( 647 +dataProviderSchemeAgencyId:**DATA_PROVIDERS**( 648 + 649 +**1.0**) 650 +)))|SDMX:**DATA_PROVIDERS**(**1.0**) 651 +|//DataStructure//|dataStructureDefinitionAgencyId:dataStructureDef initionId(version)|TFFS:EXT_DEBT(1.0.0) 652 +|Dimension|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dimensionId|TFFS:EXT_DEBT(1.0.0).FREQ 653 +|((( 644 644 DimensionDescriptor 645 645 646 646 MeasureDescriptor 647 647 648 648 AttributeDescriptor 649 -)))|( % style="width:645px" %)(((659 +)))|((( 650 650 dataStructureDefinitionAgencyId:dataStructureDef initionId(version).componentListId 651 651 652 -where the componentListId is the name of the class (there is only one occurrence of each in the Data Structure Definition) 653 -)))|(% style="width:742px" %)((( 662 +where the componentListId is the name of the class (there is only one occurrence of each in the 663 + 664 +Data Structure Definition) 665 +)))|((( 654 654 TFFS:EXT_DEBT(1.0.0).DimensionDescriptor 655 655 656 656 TFFS:EXT_DEBT(1.0.0).MeasureDescriptor ... ... @@ -657,81 +657,83 @@ 657 657 658 658 TFFS:EXT_DEBT(1.0.0).AttributeDescriptor 659 659 ))) 660 -| (% style="width:294px" %)GroupDimensionDescriptor|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).groupDimensionDescriptorId|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0).SIBLING661 -| (% style="width:294px" %)HierarchicalCode|(% style="width:645px" %)hierarchyAgencyId:hierarchyId(version).hierarchica lCode.hierarchicalCode|(% style="width:742px" %)UNESCO:H-C-GOV(1.0.0).GOV_CODE1.GOV_CODE1_1672 +|GroupDimensionDescriptor|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).groupDimensionDescriptorId|TFFS:EXT_DEBT(1.0.0).SIBLING 673 +|HierarchicalCode|hierarchyAgencyId:hierarchyId(version).hierarchica lCode.hierarchicalCode|UNESCO:H-C-GOV(1.0.0).GOV_CODE1.GOV_CODE1_1 662 662 663 -|**Classname**| (% style="width:644px" %)**Ending URN pattern**|(% style="width:743px" %)**Example**664 -|//Hierarchy//| (% style="width:644px" %)hierarchyAgencyId:hierarchyId(version)|(% style="width:743px" %)UNESCO:H-C-GOV(1.0.0)665 -|//HierarchyAssociation//| (% style="width:644px" %)hierarchyAssociationAgencyId:hierarchyAssociatio nId(version)|(% style="width:743px" %)UNESCO:CL_EXP_SOURCE(1.0.0)666 -|Level| (% style="width:644px" %)hierarchyAgencyId:hierarchyId(version).level|(% style="width:743px" %)UNESCO:H-C-GOV(1.0.0).LVL1667 -|Measure| (% style="width:644px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).measureId|(% style="width:743px" %)TFFS:EXT_DEBT(1.0.0).OBS_VALUE668 -|MetadataAttribute|( % style="width:644px" %)(((675 +|**Classname**|**Ending URN pattern**|**Example** 676 +|//Hierarchy//|hierarchyAgencyId:hierarchyId(version)|UNESCO:H-C-GOV(1.0.0) 677 +|//HierarchyAssociation//|hierarchyAssociationAgencyId:hierarchyAssociatio nId(version)|UNESCO:CL_EXP_SOURCE(1.0.0) 678 +|Level|hierarchyAgencyId:hierarchyId(version).level|UNESCO:H-C-GOV(1.0.0).LVL1 679 +|Measure|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).measureId|TFFS:EXT_DEBT(1.0.0).OBS_VALUE 680 +|MetadataAttribute|((( 669 669 msdAgencyId:msdId(version).metadataAttributeId. 670 670 671 671 metadataAttributeId 672 -)))| (% style="width:743px" %)IMF:SDDS_MSD(1.0.0).COMPILATION.METHOD673 -|MetadataAttributeDescriptor| (% style="width:644px" %)msdAgencyId:msdId(version).metadataAttributeDe scriptorId|(% style="width:743px" %)IMF:SDDS_MSD(1.0.0).MetadataAttributeDescriptor674 -|//MetadataConstraint//| (% style="width:644px" %)metadataConstraintAgencyId:metadataConstraintI d(version)|(% style="width:743px" %)TFFS:CREDITOR_METADATA_CONTENT(1.0.0)675 -|//Metadataflow//| (% style="width:644px" %)metadataflowAgencyId:metadataflowId(version)|(% style="width:743px" %)IMF:SDDS_MDF(1.0.0)676 -|MetadataProvider| (% style="width:644px" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**).metadataProviderId|(% style="width:743px" %)SDMX:**METADATA_PROVIDERS**(**1.0**).MD_PROVIDER_1677 -|//MetadataProviderScheme//| (% style="width:644px" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**)|(% style="width:743px" %)SDMX:**METADATA_PROVIDERS**(**1.0**)678 -|//MetadataProvisionAgreement//| (% style="width:644px" %)metadataProvisionAgreementAgencyId:metadataP rovisionAgreementId(version)|(% style="width:743px" %)IMF:SDDS_MDF_AB(1.0.0)679 -|//MetadataSet//| (% style="width:644px" %)metadataProviderId:metadataSetId(version)|(% style="width:743px" %)MD_PROVIDER:METADATASET(1.0.0)680 -|//MetadataStructure//| (% style="width:644px" %)msdAgencyId:msdId(version)|(% style="width:743px" %)IMF:SDDS_MSD(1.0.0)684 +)))|IMF:SDDS_MSD(1.0.0).COMPILATION.METHOD 685 +|MetadataAttributeDescriptor|msdAgencyId:msdId(version).metadataAttributeDe scriptorId|IMF:SDDS_MSD(1.0.0).MetadataAttributeDescriptor 686 +|//MetadataConstraint//|metadataConstraintAgencyId:metadataConstraintI d(version)|TFFS:CREDITOR_METADATA_CONTENT(1.0.0) 687 +|//Metadataflow//|metadataflowAgencyId:metadataflowId(version)|IMF:SDDS_MDF(1.0.0) 688 +|MetadataProvider|metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**).metadataProviderId|SDMX:**METADATA_PROVIDERS**(**1.0**).MD_PROVIDER_1 689 +|//MetadataProviderScheme//|metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**)|SDMX:**METADATA_PROVIDERS**(**1.0**) 690 +|//MetadataProvisionAgreement//|metadataProvisionAgreementAgencyId:metadataP rovisionAgreementId(version)|IMF:SDDS_MDF_AB(1.0.0) 691 +|//MetadataSet//|metadataProviderId:metadataSetId(version)|MD_PROVIDER:METADATASET(1.0.0) 692 +|//MetadataStructure//|msdAgencyId:msdId(version)|IMF:SDDS_MSD(1.0.0) 681 681 682 -| (% style="width:296px" %)**Classname**|(% style="width:646px" %)**Ending URN pattern**|(% style="width:739px" %)**Example**683 -| (% style="width:296px" %)NamePersonalisation|(% style="width:646px" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|(% style="width:739px" %)ECB:PSN_SCHEME(1.0.0).PSN1234684 -| (% style="width:296px" %)//NamePersonalisationScheme//|(% style="width:646px" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|(% style="width:739px" %)ECB:PSN_SCHEME(1.0.0)685 -| (% style="width:296px" %)//OrganisationSchemeMap//|(% style="width:646px" %)orgSchemeMapAgencyId:orgSchemeMapId(versio n)|(% style="width:739px" %)SDMX:AGENCIES_PROVIDERS(1.0.0)686 -| (% style="width:296px" %)OrganisationUnit|(% style="width:646px" %)organisationUnitSchemeAgencyId:organisationUni tSchemeId(version).organisationUnitId|(% style="width:739px" %)ECB:ORGANISATIONS(1.0.0).1F687 -| (% style="width:296px" %)//OrganisationUnitScheme//|(% style="width:646px" %)organisationUnitSchemeAgencyId:organisationUni tSchemeId(version)|(% style="width:739px" %)ECB:ORGANISATIONS(1.0.0)688 -| (% style="width:296px" %)//Process//|(% style="width:646px" %)processAgencyId:processId{version)|(% style="width:739px" %)BIS:PROCESS1(1.0.0)689 -| (% style="width:296px" %)ProcessStep|(% style="width:646px" %)(((694 +|**Classname**|**Ending URN pattern**|**Example** 695 +|NamePersonalisation|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|ECB:PSN_SCHEME(1.0.0).PSN1234 696 +|//NamePersonalisationScheme//|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|ECB:PSN_SCHEME(1.0.0) 697 +|//OrganisationSchemeMap//|orgSchemeMapAgencyId:orgSchemeMapId(versio n)|SDMX:AGENCIES_PROVIDERS(1.0.0) 698 +|OrganisationUnit|organisationUnitSchemeAgencyId:organisationUni tSchemeId(version).organisationUnitId|ECB:ORGANISATIONS(1.0.0).1F 699 +|//OrganisationUnitScheme//|organisationUnitSchemeAgencyId:organisationUni tSchemeId(version)|ECB:ORGANISATIONS(1.0.0) 700 +|//Process//|processAgencyId:processId{version)|BIS:PROCESS1(1.0.0) 701 +|ProcessStep|((( 690 690 processAgencyId:processId(version).processStepId. 691 691 692 692 processStepId 693 -)))| (% style="width:739px" %)BIS:PROCESS1(1.0.0).STEP1.STEP1_1694 -| (% style="width:296px" %)//ProvisionAgreement//|(% style="width:646px" %)provisionAgreementAgencyId:provisionAgreement Id(version)|(% style="width:739px" %)TFFS:CRED_EXT_DEBT_AB(1.0.0)695 -| (% style="width:296px" %)ReportingCategory|(% style="width:646px" %)(((705 +)))|BIS:PROCESS1(1.0.0).STEP1.STEP1_1 706 +|//ProvisionAgreement//|provisionAgreementAgencyId:provisionAgreement Id(version)|TFFS:CRED_EXT_DEBT_AB(1.0.0) 707 +|ReportingCategory|((( 696 696 reportingTaxonomyAgencyId: 697 697 698 698 reportingTaxonomyId(version).reportingCategoryI d.reportingCategoryId 699 -)))| (% style="width:739px" %)IMF:REP_1(1.0.0):LVL1_REP_CAT.LVL2_REP_CAT700 -| (% style="width:296px" %)//ReportingTaxonomy//|(% style="width:646px" %)reportingTaxonomyAgencyId:reportingTaxonomyI d(version)|(% style="width:739px" %)IMF:REP_1(1.0.0)701 -| (% style="width:296px" %)//ReportingTaxonomyMap//|(% style="width:646px" %)repTaxonomyAgencyId:repTaxonomyId(version)|(% style="width:739px" %)SDMX:RT_MAP(1.0.0)711 +)))|IMF:REP_1(1.0.0):LVL1_REP_CAT.LVL2_REP_CAT 712 +|//ReportingTaxonomy//|reportingTaxonomyAgencyId:reportingTaxonomyI d(version)|IMF:REP_1(1.0.0) 713 +|//ReportingTaxonomyMap//|repTaxonomyAgencyId:repTaxonomyId(version)|SDMX:RT_MAP(1.0.0) 702 702 703 -| (% style="width:297px" %)**Classname**|(% style="width:647px" %)**Ending URN pattern**|(% style="width:737px" %)**Example**704 -| (% style="width:297px" %)//RepresentationMap//|(% style="width:647px" %)repMapAgencyId:repMapId(version)|(% style="width:737px" %)SDMX:REF_AREA_MAPPING(1.0.0)705 -| (% style="width:297px" %)Ruleset|(% style="width:647px" %)rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|(% style="width:737px" %)ECB:RULESET_23(1.0.0).SET111706 -| (% style="width:297px" %)//RulesetScheme//|(% style="width:647px" %)rulesetSchemeAgencyId rulesetSchemeId(version)|(% style="width:737px" %)ECB:RULESET_23(1.0.0)707 -| (% style="width:297px" %)//StructureMap//|(%style="width:647px" %)structureMapAgencyId:structureMap(version)|(% style="width:737px" %)SDMX:BOP_STRUCTURES(1.0.0)708 -| (% style="width:297px" %)Subscription|(% style="width:647px" %)(((715 +|**Classname**|**Ending URN pattern**|**Example** 716 +|//RepresentationMap//|repMapAgencyId:repMapId(version)|SDMX:REF_AREA_MAPPING(1.0.0) 717 +|Ruleset|rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|ECB:RULESET_23(1.0.0).SET111 718 +|//RulesetScheme//|rulesetSchemeAgencyId rulesetSchemeId(version)|ECB:RULESET_23(1.0.0) 719 +|//StructureMap//|structureMapAgencyId:structureMap(version)|SDMX:BOP_STRUCTURES(1.0.0) 720 +|Subscription|((( 709 709 The Subscription is not itself an Identifiable Artefact and therefore it does not follow the rules for URN structure. 722 + 710 710 The name of the URN is registryURN There is no pre-determined format. 711 -)))| (% style="width:737px" %)This cannot be generated by a common mechanism as subscriptions, although maintainable in the sense that they can be submitted and deleted, are not mandated to be created by a maintenance agency and have no versioning mechanism. It is therefore the responsibility of the target registry to generate a unique Id for the Subscription, and for the application creating the subscription to store the registry URN that is returned from the registry in the subscription response message.712 -| (% style="width:297px" %)TimeDimension|(% style="width:647px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).timeDimensionId|(% style="width:737px" %)TFFS:EXT_DEBT(1.0.0).TIME_PERIOD713 -| (% style="width:297px" %)Transformation|(% style="width:647px" %)transformationSchemeAgencyId transformationSchemeId(version) transformationId|(% style="width:737px" %)ECB:TRANSFORMATION_SCHEME(1.0.0).TRANS_1714 -| (% style="width:297px" %)//TransformationScheme//|(% style="width:647px" %)transformationSchemeAgencyId transformationSchemeId(version)|(% style="width:737px" %)ECB: TRANSFORMATION_SCHEME(1.0.0)715 -| (% style="width:297px" %)**Classname**|(% style="width:647px" %)**Ending URN pattern**|(% style="width:737px" %)**Example**716 -| (% style="width:297px" %)Transition|(% style="width:647px" %)(((724 +)))|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. 725 +|TimeDimension|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).timeDimensionId|TFFS:EXT_DEBT(1.0.0).TIME_PERIOD 726 +|Transformation|transformationSchemeAgencyId transformationSchemeId(version) transformationId|ECB:TRANSFORMATION_SCHEME(1.0.0).TRANS_1 727 +|//TransformationScheme//|transformationSchemeAgencyId transformationSchemeId(version)|ECB: TRANSFORMATION_SCHEME(1.0.0) 728 +|**Classname**|**Ending URN pattern**|**Example** 729 +|Transition|((( 717 717 processAgencyId:processId(version).processStepId. 731 + 718 718 transitionId 719 -)))| (% style="width:737px" %)BIS:PROCESS1(1.0.0).STEP1.TRANSITION1720 -| (% style="width:297px" %)UserDefinedOperator|(% style="width:647px" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|(% style="width:737px" %)ECB:OS_CALC(1.2.0).OS267721 -| (% style="width:297px" %)//UserDefinedOperatorScheme//|(% style="width:647px" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|(% style="width:737px" %)ECB:OS_CALC(1.2.0)722 -| (% style="width:297px" %)//ValueList//|(% style="width:647px" %)valuelistAgencyId:valuelistId(version)|(% style="width:737px" %)SDMX:VLIST(1.0.0)723 -| (% style="width:297px" %)VtlCodelistMapping|(% style="width:647px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|(% style="width:737px" %)ECB:CLIST_MP(2.0.0).ABZ724 -| (% style="width:297px" %)VtlConceptMapping|(% style="width:647px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|(% style="width:737px" %)ECB:CLIST_MP(1.0.0).XYA725 -| (% style="width:297px" %)VtlDataflowMapping|(% style="width:647px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|(% style="width:737px" %)ECB:CLIST_MP(1.0.0).MOQ726 -| (% style="width:297px" %)//VtlMappingScheme//|(% style="width:647px" %)vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|(% style="width:737px" %)ECB:CLIST_MP(2.0.0)733 +)))|BIS:PROCESS1(1.0.0).STEP1.TRANSITION1 734 +|UserDefinedOperator|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|ECB:OS_CALC(1.2.0).OS267 735 +|//UserDefinedOperatorScheme//|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|ECB:OS_CALC(1.2.0) 736 +|//ValueList//|valuelistAgencyId:valuelistId(version)|SDMX:VLIST(1.0.0) 737 +|VtlCodelistMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|ECB:CLIST_MP(2.0.0).ABZ 738 +|VtlConceptMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|ECB:CLIST_MP(1.0.0).XYA 739 +|VtlDataflowMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|ECB:CLIST_MP(1.0.0).MOQ 740 +|//VtlMappingScheme//|vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|ECB:CLIST_MP(2.0.0) 727 727 728 728 5**Table 3: Table of identification components for SDMX Identifiable Artefacts** 729 729 730 -= 7 Implementation Notes = 744 += {{id name="_Toc90810"/}}7 Implementation Notes = 731 731 732 -== 7.1 Structural Definition Metadata == 746 +=== {{id name="_Toc90811"/}}7.1 Structural Definition Metadata === 733 733 734 -=== 7.1.1 Introduction === 748 +===== {{id name="_Toc90812"/}}7.1.1 Introduction ===== 735 735 736 736 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.) 737 737 ... ... @@ -747,40 +747,46 @@ 747 747 748 748 The following table lists the Maintainable Artefacts. 749 749 750 -(% style="width:825.835px" %) 751 -|(% colspan="2" style="width:455px" %)**Maintainable Artefacts**|(% style="width:367px" %)**Content** 752 -|(% style="width:160px" %)**Abstract Class**|(% style="width:295px" %)**Concrete Class**|(% style="width:367px" %) 753 -|(% style="width:160px" %)Item Scheme|(% style="width:295px" %)Codelist|(% style="width:367px" %)Code 754 -|(% style="width:160px" %) |(% style="width:295px" %)Concept Scheme|(% style="width:367px" %)Concept 755 -|(% style="width:160px" %) |(% style="width:295px" %)Category Scheme|(% style="width:367px" %)Category 756 -|(% style="width:160px" %) |(% style="width:295px" %)Organisation Unit Scheme|(% style="width:367px" %)Organisation Unit 757 -|(% style="width:160px" %) |(% style="width:295px" %)Agency Scheme|(% style="width:367px" %)Agency 758 -|(% style="width:160px" %) |(% style="width:295px" %)Data Provider Scheme|(% style="width:367px" %)Data Provider 759 -|(% style="width:160px" %) |(% style="width:295px" %)Metadata Provider Scheme|(% style="width:367px" %)Metadata Provider 760 -|(% style="width:160px" %) |(% style="width:295px" %)Data Consumer Scheme|(% style="width:367px" %)Data Consumer 761 -|(% style="width:160px" %) |(% style="width:295px" %)Reporting Taxonomy|(% style="width:367px" %)Reporting Category 762 -|(% style="width:160px" %) |(% style="width:295px" %)Transformation Scheme|(% style="width:367px" %)Transformation 763 -|(% style="width:160px" %) |(% style="width:295px" %)Custom Type Scheme|(% style="width:367px" %)Custom Type 764 -|(% style="width:160px" %) |(% style="width:295px" %)Name Personalisation Scheme|(% style="width:367px" %)Name Personalisation 765 -|(% style="width:160px" %) |(% style="width:295px" %)Vtl Mapping Scheme|(% style="width:367px" %)Vtl Codelist Mapping Vtl Concept Mapping 766 -|(% style="width:160px" %) |(% style="width:295px" %)Ruleset Scheme|(% style="width:367px" %)Ruleset 767 -|(% style="width:160px" %) |(% style="width:295px" %)User Defined Operator Scheme|(% style="width:367px" %)User Defined Operator 768 -|(% style="width:160px" %)Enumerated List|(% style="width:295px" %)ValueList|(% style="width:367px" %)Value Item 769 -|(% style="width:160px" %)Structure|(% style="width:295px" %)Data Structure Definition|(% style="width:367px" %)((( 764 +|(% colspan="2" %)**Maintainable Artefacts**|**Content** 765 +|**Abstract Class**|**Concrete Class**| 766 +|Item Scheme|Codelist|Code 767 +| |Concept Scheme|Concept 768 +| |Category Scheme|Category 769 +| |Organisation Unit Scheme|Organisation Unit 770 +| |Agency Scheme|Agency 771 +| |Data Provider Scheme|Data Provider 772 +| |Metadata Provider Scheme|Metadata Provider 773 +| |Data Consumer Scheme|Data Consumer 774 +| |Reporting Taxonomy|Reporting Category 775 +| |Transformation Scheme|Transformation 776 +| |Custom Type Scheme|Custom Type 777 +| |Name Personalisation Scheme|Name Personalisation 778 +| |Vtl Mapping Scheme|Vtl Codelist Mapping Vtl Concept Mapping 779 +| |Ruleset Scheme|Ruleset 780 +| |User Defined Operator Scheme|User Defined Operator 781 +|Enumerated List|ValueList|Value Item 782 +|Structure|Data Structure Definition|((( 770 770 Dimension Descriptor 784 + 771 771 Group Dimension Descriptor 786 + 772 772 Dimension 788 + 773 773 Time Dimension 790 + 774 774 Attribute Descriptor 792 + 775 775 Data Attribute 794 + 776 776 Measure Descriptor 796 + 777 777 Measure 778 778 ))) 779 -| (%style="width:160px" %)|(% style="width:295px" %)Metadata Structure Definition|(% style="width:367px" %)Metadata Attribute Descriptor Metadata Attribute780 -| (% style="width:160px" %)Structure Usage|(% style="width:295px" %)Dataflow|(%style="width:367px" %)781 -| (%style="width:160px" %)|(% style="width:295px" %)Metadataflow|(%style="width:367px" %)782 -| (% style="width:160px" %)None|(% style="width:295px" %)Process|(% style="width:367px" %)Process Step783 -| (% style="width:160px" %)None|(% style="width:295px" %)Structure Map|(% style="width:367px" %)(((799 +| |Metadata Structure Definition|Metadata Attribute Descriptor Metadata Attribute 800 +|Structure Usage|Dataflow| 801 +| |Metadataflow| 802 +|None|Process|Process Step 803 +|None|Structure Map|((( 784 784 Component Map 785 785 786 786 Epoch Map ... ... @@ -787,44 +787,44 @@ 787 787 788 788 Date Pattern Map 789 789 ))) 790 -| (% style="width:160px" %)None|(% style="width:295px" %)Representation Map|(% style="width:367px" %)Representation Mapping791 -| (% style="width:160px" %)Item Scheme Map|(% style="width:295px" %)Organisation Scheme Map|(% style="width:367px" %)Item Map792 -| (%style="width:160px" %)|(% style="width:295px" %)Concept Scheme Map|(% style="width:367px" %)Item Map793 -| (%style="width:160px" %)|(% style="width:295px" %)Category Scheme Map|(% style="width:367px" %)Item Map794 -| (%style="width:160px" %)|(% style="width:295px" %)Reporting Taxonomy Map|(% style="width:367px" %)Item Map795 -| (% style="width:160px" %)None|(% style="width:295px" %)Provision Agreement|(%style="width:367px" %)796 -| (% style="width:160px" %)None|(% style="width:295px" %)Metadata Provision Agreement|(%style="width:367px" %)797 -| (% style="width:160px" %)None|(% style="width:295px" %)Hierarchy|(% style="width:367px" %)Hierarchical Code798 -| (% style="width:160px" %)None|(% style="width:295px" %)Hierarchy Association|(%style="width:367px" %)799 -| (% style="width:160px" %)None|(% style="width:295px" %)Categorisation|(%style="width:367px" %)800 -| (% style="width:160px" %)Constraint|(% style="width:295px" %)Data Constraint|(% style="width:367px" %)DataKeySet801 -| (%style="width:160px" %)|(%style="width:295px" %)|(% style="width:367px" %)CubeRegion802 -| (% style="width:160px" %)Constraint|(% style="width:295px" %)Metadata Constraint|(% style="width:367px" %)MetadataTargetRegion810 +|None|Representation Map|Representation Mapping 811 +|Item Scheme Map|Organisation Scheme Map|Item Map 812 +| |Concept Scheme Map|Item Map 813 +| |Category Scheme Map|Item Map 814 +| |Reporting Taxonomy Map|Item Map 815 +|None|Provision Agreement| 816 +|None|Metadata Provision Agreement| 817 +|None|Hierarchy|Hierarchical Code 818 +|None|Hierarchy Association| 819 +|None|Categorisation| 820 +|Constraint|Data Constraint|DataKeySet 821 +| | |CubeRegion 822 +|Constraint|Metadata Constraint|MetadataTargetRegion 803 803 804 804 **Table 4: Table of Maintainable Artefacts for Structural Definition Metadata** 805 805 806 -=== 7.1.2 Item Scheme, Structure === 826 +===== {{id name="_Toc90813"/}}7.1.2 Item Scheme, Structure ===== 807 807 808 808 The artefacts included in the structural definitions are: 809 809 810 810 * 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) 811 -* All types of Enumerated List (ValueList)^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]](%%)^^831 +* All types of Enumerated List (ValueList)^^[[(% class="wikiinternallink wikiinternallink wikiinternallink" %)^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]](%%)^^ 812 812 * All types of Structure (Data Structure Definition, Metadata Structure Definition) 813 813 * All types of Structure Usage (Dataflow, Metadataflow) 814 814 815 -=== 7.1.3 Structure Usage === 835 +===== {{id name="_Toc90814"/}}7.1.3 Structure Usage ===== 816 816 817 - ====7.1.3.1 Structure Usage: Basic Concepts====837 +**7.1.3.1 Structure Usage: Basic Concepts** 818 818 819 819 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. 820 820 821 - ====7.1.3.2 Structure Usage Schematic====841 +**7.1.3.2 Structure Usage Schematic** 822 822 823 823 [[image:SDMX 3.1 Section 5_en_9b750e13.jpg||height="246" width="438"]] 824 824 825 825 **Figure 9: Schematic of Linking the Data and Metadata Flows to Categories and Structure Definitions** 826 826 827 - ====7.1.3.3 Structure Usage Model====847 +**7.1.3.3 Structure Usage Model** 828 828 829 829 [[image:SDMX 3.1 Section 5_en_1c94cbe.jpg||height="548" width="578"]] 830 830 ... ... @@ -832,19 +832,19 @@ 832 832 833 833 In addition to the maintenance of the Dataflow and the Metadataflow, the following links must be maintained in the registry: 834 834 835 -1. 855 +1. 836 836 1*. Dataflow to Data Structure Definition 837 837 1*. Metadataflow to Metadata Structure Definition 838 838 839 839 The following links may be created by means of a Categorisation 840 840 841 -1. 861 +1. 842 842 1*. Categorisation to Dataflow and Category 843 843 1*. Categorisation to Metadataflow and Category 844 844 845 -== 7.2 Data and Metadata Provisioning == 865 +=== {{id name="_Toc90815"/}}7.2 Data and Metadata Provisioning === 846 846 847 -=== 7.2.1 Provisioning Agreement: Basic concepts === 867 +===== {{id name="_Toc90816"/}}7.2.1 Provisioning Agreement: Basic concepts ===== 848 848 849 849 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. 850 850 ... ... @@ -852,7 +852,7 @@ 852 852 853 853 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. 854 854 855 -=== 7.2.2 Provisioning Agreement Model – pull use case === 875 +===== {{id name="_Toc90817"/}}7.2.2 Provisioning Agreement Model – pull use case ===== 856 856 857 857 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. 858 858 ... ... @@ -874,9 +874,9 @@ 874 874 875 875 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. 876 876 877 -== 7.3 Data and Metadata Constraints == 897 +=== {{id name="_Toc90818"/}}7.3 Data and Metadata Constraints === 878 878 879 -=== 7.3.1 Data and Metadata Constraints: Basic Concepts === 899 +===== {{id name="_Toc90819"/}}7.3.1 Data and Metadata Constraints: Basic Concepts ===== 880 880 881 881 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. 882 882 ... ... @@ -890,13 +890,13 @@ 890 890 891 891 In addition, DataAvailabilityConstraints can be extremely useful in a data visualisation system, such as dissemination of statistics on a website. In such a system a Cube Region can be used to specify the Dimension codes that actually exist in a data source (these can be used to build relevant selection tables). 892 892 893 -=== 7.3.2 Data and Metadata Constraints: Schematic === 913 +===== {{id name="_Toc90820"/}}7.3.2 Data and Metadata Constraints: Schematic ===== 894 894 895 895 [[image:SDMX 3.1 Section 5_en_28d0cadc.jpg||height="326" width="580"]] 896 896 897 897 **Figure 14: Schematic of the Constraint and the Artefacts that can be constrained** 898 898 899 -=== 7.3.3 Data and Metadata Constraints: Model === 919 +===== {{id name="_Toc90821"/}}7.3.3 Data and Metadata Constraints: Model ===== 900 900 901 901 [[image:SDMX 3.1 Section 5_en_a3184f6a.jpg||height="298" width="579"]] 902 902 ... ... @@ -912,9 +912,9 @@ 912 912 913 913 The content of the Constraint can be found in the SDMX Information Model document. 914 914 915 -== 7.4 Data Registration == 935 +=== {{id name="_Toc90822"/}}7.4 Data Registration === 916 916 917 -=== 7.4.1 Basic Concepts === 937 +===== {{id name="_Toc90823"/}}7.4.1 Basic Concepts ===== 918 918 919 919 A Data Provider has published a new dataset conforming to an existing Dataflow (and hence Data Structure Definition). This is implemented as either a web-accessible SDMXML file, or in a database which has a web-services interface capable of responding to an SDMX RESTful query with an SDMX-ML data stream. 920 920 ... ... @@ -924,15 +924,15 @@ 924 924 925 925 SDMX-RR supports dataset registration via the Registration Request, which can be created by the Data Provider (giving the Data Provider maximum control). The registry responds to the registration request with a registration response which indicates if the registration was successful. In the event of an error, the error messages are returned as a registry exception within the response. 926 926 927 -=== 7.4.2 The Registration Request === 947 +===== {{id name="_Toc90824"/}}7.4.2 The Registration Request ===== 928 928 929 - ====7.4.2.1 Registration Request Schematic====949 +**7.4.2.1 Registration Request Schematic** 930 930 931 931 [[image:SDMX 3.1 Section 5_en_293a2ea6.jpg||height="337" width="554"]] 932 932 933 933 **Figure 16: Schematic of the Objects Concerned with Registration** 934 934 935 - ====7.4.2.2 Registration Request Model====955 +**7.4.2.2 Registration Request Model** 936 936 937 937 The following UML diagram shows the composition of the registration request. Each request is made up of one or more Registrations, one per dataset to be registered. The Registration can optionally have information, which has been extracted from the Registration: 938 938 ... ... @@ -944,11 +944,13 @@ 944 944 945 945 The Registration has an action attribute which takes one of the following values: 946 946 967 +: 968 + 947 947 ((( 948 -| (% style="width:224px" %)**Action Attribute Value**|(% style="width:1457px" %)**Behaviour**949 -| (% style="width:224px" %)Append|(% style="width:1457px" %)Add this Registration to the registry950 -| (% style="width:224px" %)Replace|(% style="width:1457px" %)Replace the existing Registration with identified by the id in the Registration of the SubmitRegistrationRequest951 -| (% style="width:224px" %)Delete|(% style="width:1457px" %)Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest970 +|**Action Attribute Value**|**Behaviour** 971 +|Append|Add this Registration to the registry 972 +|Replace|Replace the existing Registration with identified by the id in the Registration of the SubmitRegistrationRequest 973 +|Delete|Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest 952 952 ))) 953 953 954 954 [[image:SDMX 3.1 Section 5_en_90b3c64a.jpg||height="434" width="579"]] ... ... @@ -967,24 +967,30 @@ 967 967 968 968 https:~/~/github.com/sdmx-twg/sdmx-rest/blob/master/doc/availability.md 969 969 992 +: 993 + 970 970 ((( 971 -(% style="width:918.835px" %) 972 -|**Indexing Required**|(% style="width:745px" %)**Registration Process Activity** 973 -|indexTimeSeries|(% style="width:745px" %)Extract all the series keys and create a KeySet(s) Constraint. 974 -|indexDataSet|(% style="width:745px" %)Extract all the codes and other content of the Key value of the Series Key in a Data Set and create one or more Cube Regions containing Member Selections of Dimension Components of the Constraints model in the SDMX-IM, and the associated Selection Value. 975 -|indexReportingPeriod|(% style="width:745px" %)((( 995 +|**Indexing Required**|**Registration Process Activity** 996 +|indexTimeSeries|Extract all the series keys and create a KeySet(s) Constraint. 997 +|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. 998 +|indexReportingPeriod|((( 976 976 This applies only to a registered __dataset__. 1000 + 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 -|indexAttributes|( % style="width:745px" %)(((1003 +|indexAttributes|((( 980 980 **Data Set** 1005 + 981 981 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 982 982 983 983 **Metadata Set** 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 1009 + 1010 +Indicate the presence of a Reported Attribute by creating one or more Cube Regions containing Member Selections of Metadata Attribute 1011 + 1012 +Components of the Constraints model in the 985 985 ))) 986 -|**Indexing Required**| (% style="width:745px" %)**Registration Process Activity**987 -| | (% style="width:745px" %)SDMX-IM. Note that the content is not stored in the Selection Value.1014 +|**Indexing Required**|**Registration Process Activity** 1015 +| |SDMX-IM. Note that the content is not stored in the Selection Value. 988 988 ))) 989 989 990 990 Constraints that specify the contents of a //QueryDatasource// are submitted to the Registry via the structure submission service (i.e., the RESTful API). ... ... @@ -991,7 +991,7 @@ 991 991 992 992 The Registration must reference the ProvisionAgreement to which it relates. 993 993 994 -=== 7.4.3 Registration Response === 1022 +===== {{id name="_Toc90825"/}}7.4.3 Registration Response ===== 995 995 996 996 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”. 997 997 ... ... @@ -1003,7 +1003,7 @@ 1003 1003 1004 1004 **Figure 18: Logical class diagram showing the registration response** 1005 1005 1006 -== 7.5 Subscription and Notification Service == 1034 +=== {{id name="_Toc90826"/}}7.5 Subscription and Notification Service === 1007 1007 1008 1008 The contents of the SDMX Registry/Repository will change regularly: new code lists and key families will be published and new datasets and metadata-sets will be registered. To obviate the need for users to repeatedly query the registry to see when new information is available, a mechanism is provided to allow users to be notified when these events happen. 1009 1009 ... ... @@ -1011,13 +1011,13 @@ 1011 1011 1012 1012 When a registry/repository artefact is modified, any subscriptions which are observing the object are activated, and either an email or HTTP POST is instigated to report details of the changes to the user specified in the subscription. This is called a “notification”. 1013 1013 1014 -=== 7.5.1 Subscription Logical Class Diagram === 1042 +===== {{id name="_Toc90827"/}}7.5.1 Subscription Logical Class Diagram ===== 1015 1015 1016 1016 [[image:SDMX 3.1 Section 5_en_1433df5d.jpg||height="680" width="587"]] 1017 1017 1018 1018 **Figure 19: Logical Class Diagram of the Subscription** 1019 1019 1020 -=== 7.5.2 Subscription Information === 1048 +===== {{id name="_Toc90828"/}}7.5.2 Subscription Information ===== 1021 1021 1022 1022 Regardless of the type of registry/repository events being observed, a subscription always contains: 1023 1023 ... ... @@ -1026,16 +1026,18 @@ 1026 1026 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. 1027 1027 1. A selector which specifies which type of events are of interest. The set of event types is: 1028 1028 1057 +: 1058 +:: 1059 + 1029 1029 ((( 1030 -(% style="width:1061.83px" %) 1031 -|**Event Type**|(% style="width:660px" %)**Comment** 1032 -|STRUCTURAL_REPOSITORY_EVENTS|(% style="width:660px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository. 1033 -|DATA_REGISTRATION_EVENTS|(% style="width:660px" %)Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database. 1034 -|METADATA_REGISTRATION_EVENTS|(% style="width:660px" %)Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database. 1035 -|ALL_EVENTS|(% style="width:660px" %)All events of the specified EventType 1061 +|**Event Type**|**Comment** 1062 +|STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository. 1063 +|DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database. 1064 +|METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database. 1065 +|ALL_EVENTS|All events of the specified EventType 1036 1036 ))) 1037 1037 1038 -=== 7.5.3 Wildcard Facility === 1068 +===== {{id name="_Toc90829"/}}7.5.3 Wildcard Facility ===== 1039 1039 1040 1040 Subscription notification supports wildcarded identifier components URNs, which are identifiers which have some or all of their component parts replaced by the wildcard character `*`. Identifier components comprise: 1041 1041 ... ... @@ -1091,29 +1091,30 @@ 1091 1091 1092 1092 The complete SDMX versioning syntax can be found in the SDMX Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”. 1093 1093 1094 -=== 7.5.4 Structural Repository Events === 1124 +===== {{id name="_Toc90830"/}}7.5.4 Structural Repository Events ===== 1095 1095 1096 1096 Whenever a maintainable artefact (data structure definition, concept scheme, codelist, metadata structure definition, category scheme, etc.) is added to, deleted from, or modified in the structural metadata repository, a structural metadata event is triggered. Subscriptions may be set up to monitor all such events, or focus on specific artefacts such as a Data Structure Definition. 1097 1097 1098 -=== 7.5.5 Registration Events === 1128 +===== {{id name="_Toc90831"/}}7.5.5 Registration Events ===== 1099 1099 1100 1100 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: 1101 1101 1132 +: 1133 + 1102 1102 ((( 1103 -(% style="width:1082.83px" %) 1104 -|(% style="width:230px" %)**Selector**|(% style="width:850px" %)**Comment** 1105 -|(% style="width:230px" %)DataProvider|(% style="width:850px" %)Any datasets registered by the specified dataprovider will activate the notification. 1106 -|(% style="width:230px" %)ProvisionAgreement|(% style="width:850px" %)Any datasets for the agreement will activate the notification. 1107 -|(% style="width:230px" %)Dataflow|(% style="width:850px" %)Any datasets for the specified dataflow will activate the notification. 1108 -|(% style="width:230px" %)DataStructureDefinition|(% style="width:850px" %)Any datasets for those dataflows that are based on the specified Data Structure Definition will activate the notification 1109 -|(% style="width:230px" %)Category|(% style="width:850px" %)Any datasets registered for those dataflows, provision agreements that are categorised by the category. 1135 +|**Selector**|**Comment** 1136 +|DataProvider|Any datasets registered by the specified dataprovider will activate the notification. 1137 +|ProvisionAgreement|Any datasets for the agreement will activate the notification. 1138 +|Dataflow|Any datasets for the specified dataflow will activate the notification. 1139 +|DataStructureDefinition|Any datasets for those dataflows that are based on the specified Data Structure Definition will activate the notification 1140 +|Category|Any datasets registered for those dataflows, provision agreements that are categorised by the category. 1110 1110 ))) 1111 1111 1112 1112 The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration. 1113 1113 1114 -== 7.6 Notification == 1145 +== {{id name="_Toc90832"/}}7.6 Notification == 1115 1115 1116 -=== 7.6.1 Logical Class Diagram === 1147 +==== {{id name="_Toc90833"/}}7.6.1 Logical Class Diagram ==== 1117 1117 1118 1118 [[image:SDMX 3.1 Section 5_en_8bc1b889.jpg||height="379" width="579"]] 1119 1119 ... ... @@ -1130,11 +1130,11 @@ 1130 1130 1131 1131 Additionally, supplementary information may be contained in the notification as detailed below. 1132 1132 1133 -=== 7.6.2 Structural Event Component === 1164 +==== {{id name="_Toc90834"/}}7.6.2 Structural Event Component ==== 1134 1134 1135 1135 The notification will contain the MaintainableArtefact that triggered the event in a form similar to the SDMX-ML structural message (using elements from that namespace). 1136 1136 1137 -=== 7.6.3 Registration Event Component === 1168 +==== {{id name="_Toc90835"/}}7.6.3 Registration Event Component ==== 1138 1138 1139 1139 The notification will contain the Registration. 1140 1140