Last modified by Helena on 2025/09/10 11:19
Summary
-
Page properties (2 modified, 0 added, 0 removed)
-
Objects (0 modified, 0 added, 1 removed)
Details
- Page properties
-
- Content
-
... ... @@ -183,11 +183,11 @@ 183 183 184 184 === {{id name="_Toc93847"/}}5.2.2 Structure Submission Service === 185 185 186 -The registry must support a mechanism for submitting structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: [[__https:~~/~~/github.com/sdmx-twg/sdmx-rest__>>https://https:github.comsdmx-twgsdmx-rest]]). In order for the architecture to be scalable, the finest-grained piece of structural metadata that can be processed by the SDMX-RR is a MaintainableArtefact, with the exception of Item Schemes, where changes at an Item level is also possible (see next section on the SDMX Information Model).186 +The registry must support a mechanism for submitting structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: __[[https:~~/~~/github.com/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[twg/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[rest>>url:https://github.com/sdmx-twg/sdmx-rest]]__[[)>>url:https://github.com/sdmx-twg/sdmx-rest]]. In order for the architecture to be scalable, the finest-grained piece of structural metadata that can be processed by the SDMX-RR is a MaintainableArtefact, with the exception of Item Schemes, where changes at an Item level is also possible (see next section on the SDMX Information Model). 187 187 188 188 === {{id name="_Toc93848"/}}5.2.3 Structure Query Service === 189 189 190 -The registry must support a mechanism for querying for structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: [[__https:~~/~~/github.com/sdmx-twg/sdmx-rest__>>https://https:github.comsdmx-twgsdmx-rest]]). The registry response to this query mechanism is the SDMX Structure message, which has as its root node:190 +The registry must support a mechanism for querying for structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: __[[https:~~/~~/github.com/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[twg/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[rest>>url:https://github.com/sdmx-twg/sdmx-rest]]__ [[)>>url:https://github.com/sdmx-twg/sdmx-rest]]. The registry response to this query mechanism is the SDMX Structure message, which has as its root node: 191 191 192 192 * Structure 193 193 ... ... @@ -280,7 +280,7 @@ 280 280 Subscription management involves a user submitting a subscription request which contains: 281 281 282 282 * a query or constraint expression in terms of a filter which defines the events for which the user is interested (e.g., new data for a specific dataflow, or for a domain category, or changes to a Data Structure Definition). 283 -* a list of URIs or endpoints to which an XML notification message can be sent. Supported endpoint types will be email (mailto~: ) and HTTP POST (a normal http:~/~/ address);283 +* a list of URIs or endpoints to which an XML notification message can be sent. Supported endpoint types will be email (mailto~:) and HTTP POST (a normal http:~/~/ address); 284 284 * request for a list of submitted subscriptions; 285 285 * deletion of a subscription; 286 286 ... ... @@ -304,6 +304,7 @@ 304 304 |(% style="width:188px" %)**Interface**|(% style="width:542px" %)**Behaviour** 305 305 |(% style="width:188px" %) |(% style="width:542px" %)((( 306 306 b) Not be explicitly{{footnote}}With semantic versioning, it is allowed to reference a range of artefacts, e.g., a DSD referencing a Codelist with version 1.2.3+ means all patch versions greater than 1.2.3. This means that deleting 1.2.4-draft does not break integrity of the aforementioned DSD.{{/footnote}} referenced from any other object in the Registry. 307 + 307 307 4) The semantic versioning rules in the SDMX documentation MUST be obeyed. 308 308 ))) 309 309 |(% 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. ... ... @@ -328,12 +328,14 @@ 328 328 329 329 The table below shows the identification and related data attributes to be stored in a registry for objects that are one of: 330 330 331 -* //nnotable// 332 +* //Annotable// 332 332 * //Identifiable// 333 333 * //Nameable// 334 334 * //Versionable// 335 335 * //Maintainable// 336 336 338 +: 339 + 337 337 ((( 338 338 (% style="width:1052.29px" %) 339 339 |**Object Type**|(% style="width:241px" %)**Data Attributes**|(% style="width:156px" %)**Status**|**Data type**|(% style="width:457px" %)**Notes** ... ... @@ -361,9 +361,9 @@ 361 361 362 362 **Table 1: Common Attributes of Object Types** 363 363 364 -== {{id name="_Toc93856"/}}6.2 Unique identification of SDMX objects == 367 +=== {{id name="_Toc93856"/}}6.2 Unique identification of SDMX objects === 365 365 366 -=== {{id name="_Toc93857"/}}6.2.1 Agencies and Metadata Providers === 369 +===== {{id name="_Toc93857"/}}6.2.1 Agencies and Metadata Providers ===== 367 367 368 368 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. 369 369 ... ... @@ -501,7 +501,7 @@ 501 501 502 502 SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version).contained-object-id.contained-object-id contained-objectid.object-id 503 503 504 - =====//__**Concrete Examples of the URN Structure**__//=====507 +//__**Concrete Examples of the URN Structure**__// 505 505 506 506 The Data Structure Definition CRED_EXT_DEBT of legacy version 2.1 maintained by the toplevel Agency TFFS would have the URN: 507 507 ... ... @@ -621,118 +621,136 @@ 621 621 622 622 urn:sdmx.org.sdmx.infomodel.{package}.{classname}= 623 623 624 -(% style="width:1311.29px" %) 625 -|(% style="width:252px" %)**Classname**|(% style="width:639px" %)**Ending URN pattern**|(% style="width:418px" %)**Example** 626 -|(% 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 627 -|(% style="width:252px" %)//AgencyScheme//|(% style="width:639px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**)|(% style="width:418px" %)ECB:**AGENCIES**(**1.0**) 628 -|(% style="width:252px" %)//Categorisation//|(% style="width:639px" %)categorisationAgencyId:categorisationId(version)|(% style="width:418px" %)IMF:cat001(1.0.0) 629 -|(% 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 … 630 -|(% style="width:252px" %)//CategoryScheme//|(% style="width:639px" %)categorySchemeAgencyId:categorySchemeId(versi on)|(% style="width:418px" %)IMF:SDDS(1.0.0) 627 +|**Classname**|**Ending URN pattern**|**Example** 628 +|Agency^^[[(% class="wikiinternallink wikiinternallink wikiinternallink" %)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^|agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|ECB:**AGENCIES**(**1.0**).AA 629 +|//AgencyScheme//|agencySchemeAgencyId:**AGENCIES**(**1.0**)|ECB:**AGENCIES**(**1.0**) 630 +|//Categorisation//|categorisationAgencyId:categorisationId(version)|IMF:cat001(1.0.0) 631 +|Category|categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|IMF:SDDS(1.0.0):level_1_category.level_2_category … 632 +|//CategoryScheme//|categorySchemeAgencyId:categorySchemeId(versi on)|IMF:SDDS(1.0.0) 631 631 632 -|(% style="width:250px" %)**Classname**|(% style="width:639px" %)**Ending URN pattern**|(% style="width:1049px" %)**Example** 633 -|(% style="width:250px" %)//CategorySchemeMap//|(% style="width:639px" %)((( 634 -catSchemeMapAgencyId:catSchemeMapId(version) 635 -)))|(% style="width:1049px" %)SDMX:EUROSTAT_SUBJECT_DOMAIN(1.0.0) 636 -|(% style="width:250px" %)Code|(% style="width:639px" %)codeListAgencyId:codelistId(version).codeId|(% style="width:1049px" %)SDMX:CL_FREQ(1.0.0).Q 637 -|(% style="width:250px" %)//Codelist//|(% style="width:639px" %)codeListAgencyId:codeListId(version)|(% style="width:1049px" %)SDMX:CL_FREQ(1.0.0) 638 -|(% 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 639 -|(% style="width:250px" %)Concept|(% style="width:639px" %)conceptSchemeAgencyId:conceptSchemeId(versio n).conceptId|(% style="width:1049px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0).FREQ 640 -|(% style="width:250px" %)//ConceptScheme//|(% style="width:639px" %)conceptSchemeAgencyId:conceptSchemeId(versio n)|(% style="width:1049px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0) 641 -|(% style="width:250px" %)//ConceptSchemeMap//|(% style="width:639px" %)((( 634 +|**Classname**|**Ending URN pattern**|**Example** 635 +|//CategorySchemeMap//|((( 636 +catSchemeMapAgencyId:catSchemeMapId(version 637 + 638 +) 639 +)))|SDMX:EUROSTAT_SUBJECT_DOMAIN(1.0.0) 640 +|Code|codeListAgencyId:codelistId(version).codeId|SDMX:CL_FREQ(1.0.0).Q 641 +|//Codelist//|codeListAgencyId:codeListId(version)|SDMX:CL_FREQ(1.0.0) 642 +|ComponentMap|structureMapAgencyId:structureMap(version).com ponentMapId|SDMX:BOP_STRUCTURES(1.0.0).REF_AREA_TO_COUNT RY 643 +|Concept|conceptSchemeAgencyId:conceptSchemeId(versio n).conceptId|SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0).FREQ 644 +|//ConceptScheme//|conceptSchemeAgencyId:conceptSchemeId(versio n)|SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0) 645 +|//ConceptSchemeMap//|((( 642 642 conceptSchemeMapAgencyId:conceptSchemeMap 647 + 643 643 Id(version) 644 -)))| (% style="width:1049px" %)SDMX:CONCEPT_MAP(1.0.0)645 -| (% style="width:250px" %)CustomType|(% style="width:639px" %)customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|(% style="width:1049px" %)ECB: CUSTOM_TYPE_SCHEME(1.0.0).CUSTOM_TYPE_1646 -| (% style="width:250px" %)//CustomTypeScheme//|(% style="width:639px" %)customTypeSchemeAgencyId customTypeSchemeId(version)|(% style="width:1049px" %)ECB:CUSTOM_TYPE_SCHEME(1.0.0)647 -| (% style="width:250px" %)DataAttrribute|(% style="width:639px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dataAttributeId|(% style="width:1049px" %)TFFS:EXT_DEBT(1.0.0).OBS_STATUS648 -| (% style="width:250px" %)//DataConstraint//|(% style="width:639px" %)dataConstraintAgencyId:dataConstraintId(version)|(% style="width:1049px" %)TFFS:CREDITOR_DATA_CONTENT(1.0.0)649 +)))|SDMX:CONCEPT_MAP(1.0.0) 650 +|CustomType|customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|ECB: CUSTOM_TYPE_SCHEME(1.0.0).CUSTOM_TYPE_1 651 +|//CustomTypeScheme//|customTypeSchemeAgencyId customTypeSchemeId(version)|ECB:CUSTOM_TYPE_SCHEME(1.0.0) 652 +|DataAttrribute|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dataAttributeId|TFFS:EXT_DEBT(1.0.0).OBS_STATUS 653 +|//DataConstraint//|dataConstraintAgencyId:dataConstraintId(version)|TFFS:CREDITOR_DATA_CONTENT(1.0.0) 649 649 650 -|(% style="width:248px" %)**Classname**|(% style="width:643px" %)**Ending URN pattern**|(% style="width:1047px" %)**Example** 651 -|(% style="width:248px" %)DataConsumer|(% style="width:643px" %)dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**).dataConsumerId|(% style="width:1047px" %)SDMX:**DATA_CONSUMERS**(**1.0**).CONSUMER_1 652 -|(% style="width:248px" %)//DataConsumerScheme//|(% style="width:643px" %)((( 653 -dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**) 654 -)))|(% style="width:1047px" %)SDMX:**DATA_CONSUMERS**(**1.0**) 655 -|(% style="width:248px" %)//Dataflow//|(% style="width:643px" %)dataflowAgencyId:dataflowId(version)|(% style="width:1047px" %)TFFS:CRED_EXT_DEBT(1.0.0) 656 -|(% style="width:248px" %)DataProvider|(% style="width:643px" %)((( 657 -dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**).dataProviderId 658 -)))|(% style="width:1047px" %)SDMX:**DATA_PROVIDERS**(**1.0**).PROVIDER_1 659 -|(% style="width:248px" %)//DataProviderScheme//|(% style="width:643px" %)((( 660 -dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**) 661 -)))|(% style="width:1047px" %)SDMX:**DATA_PROVIDERS**(**1.0**) 662 -|(% style="width:248px" %)//DataStructure//|(% style="width:643px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version)|(% style="width:1047px" %)TFFS:EXT_DEBT(1.0.0) 663 -|(% style="width:248px" %)Dimension|(% style="width:643px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dimensionId|(% style="width:1047px" %)TFFS:EXT_DEBT(1.0.0).FREQ 664 -|(% style="width:248px" %)((( 655 +|**Classname**|**Ending URN pattern**|**Example** 656 +|DataConsumer|dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**).dataConsumerId|SDMX:**DATA_CONSUMERS**(**1.0**).CONSUMER_1 657 +|//DataConsumerScheme//|((( 658 +dataConsumerSchemeAgencyId:**DATA_CONSUME** 659 + 660 +**RS**(**1.0**) 661 +)))|SDMX:**DATA_CONSUMERS**(**1.0**) 662 +|//Dataflow//|dataflowAgencyId:dataflowId(version)|TFFS:CRED_EXT_DEBT(1.0.0) 663 +|DataProvider|((( 664 +dataProviderSchemeAgencyId:**DATA_PROVIDERS**( 665 + 666 +**1.0**).dataProviderId 667 +)))|SDMX:**DATA_PROVIDERS**(**1.0**).PROVIDER_1 668 +|//DataProviderScheme//|((( 669 +dataProviderSchemeAgencyId:**DATA_PROVIDERS**( 670 + 671 +**1.0**) 672 +)))|SDMX:**DATA_PROVIDERS**(**1.0**) 673 +|//DataStructure//|dataStructureDefinitionAgencyId:dataStructureDef initionId(version)|TFFS:EXT_DEBT(1.0.0) 674 +|Dimension|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dimensionId|TFFS:EXT_DEBT(1.0.0).FREQ 675 +|((( 665 665 DimensionDescriptor 677 + 666 666 MeasureDescriptor 679 + 667 667 AttributeDescriptor 668 -)))| (% 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" %)(((681 +)))|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).componentListId where the componentListId is the name of the class (there is only one occurrence of each in the Data Structure Definition)|((( 669 669 TFFS:EXT_DEBT(1.0.0).DimensionDescriptor 683 + 670 670 TFFS:EXT_DEBT(1.0.0).MeasureDescriptor 685 + 671 671 TFFS:EXT_DEBT(1.0.0).AttributeDescriptor 672 672 ))) 673 -| (% style="width:248px" %)GroupDimensionDescriptor|(% style="width:643px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).groupDimensionDescriptorId|(% style="width:1047px" %)TFFS:EXT_DEBT(1.0.0).SIBLING674 -| (% 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_1688 +|GroupDimensionDescriptor|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).groupDimensionDescriptorId|TFFS:EXT_DEBT(1.0.0).SIBLING 689 +|HierarchicalCode|hierarchyAgencyId:hierarchyId(version).hierarchica lCode.hierarchicalCode|UNESCO:H-C-GOV(1.0.0).GOV_CODE1.GOV_CODE1_1 675 675 676 -| (% style="width:248px" %)**Classname**|(% style="width:646px" %)**Ending URN pattern**|(% style="width:1044px" %)**Example**677 -| (% style="width:248px" %)//Hierarchy//|(% style="width:646px" %)hierarchyAgencyId:hierarchyId(version)|(% style="width:1044px" %)UNESCO:H-C-GOV(1.0.0)678 -| (% style="width:248px" %)//HierarchyAssociation//|(% style="width:646px" %)hierarchyAssociationAgencyId:hierarchyAssociatio nId(version)|(% style="width:1044px" %)UNESCO:CL_EXP_SOURCE(1.0.0)679 -| (% style="width:248px" %)Level|(% style="width:646px" %)hierarchyAgencyId:hierarchyId(version).level|(% style="width:1044px" %)UNESCO:H-C-GOV(1.0.0).LVL1680 -| (% style="width:248px" %)Measure|(% style="width:646px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).measureId|(% style="width:1044px" %)TFFS:EXT_DEBT(1.0.0).OBS_VALUE681 -| (% style="width:248px" %)MetadataAttribute|(% style="width:646px" %)(((691 +|**Classname**|**Ending URN pattern**|**Example** 692 +|//Hierarchy//|hierarchyAgencyId:hierarchyId(version)|UNESCO:H-C-GOV(1.0.0) 693 +|//HierarchyAssociation//|hierarchyAssociationAgencyId:hierarchyAssociatio nId(version)|UNESCO:CL_EXP_SOURCE(1.0.0) 694 +|Level|hierarchyAgencyId:hierarchyId(version).level|UNESCO:H-C-GOV(1.0.0).LVL1 695 +|Measure|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).measureId|TFFS:EXT_DEBT(1.0.0).OBS_VALUE 696 +|MetadataAttribute|((( 682 682 msdAgencyId:msdId(version).metadataAttributeId. 698 + 683 683 metadataAttributeId 684 -)))| (% style="width:1044px" %)IMF:SDDS_MSD(1.0.0).COMPILATION.METHOD685 -| (% style="width:248px" %)MetadataAttributeDescriptor|(% style="width:646px" %)msdAgencyId:msdId(version).metadataAttributeDe scriptorId|(% style="width:1044px" %)IMF:SDDS_MSD(1.0.0).MetadataAttributeDescriptor686 -| (% style="width:248px" %)//MetadataConstraint//|(% style="width:646px" %)metadataConstraintAgencyId:metadataConstraintI d(version)|(% style="width:1044px" %)TFFS:CREDITOR_METADATA_CONTENT(1.0.0)687 -| (% style="width:248px" %)//Metadataflow//|(% style="width:646px" %)metadataflowAgencyId:metadataflowId(version)|(% style="width:1044px" %)IMF:SDDS_MDF(1.0.0)688 -| (% style="width:248px" %)MetadataProvider|(% style="width:646px" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**).metadataProviderId|(% style="width:1044px" %)SDMX:**METADATA_PROVIDERS**(**1.0**).MD_PROVIDER_1689 -| (% style="width:248px" %)//MetadataProviderScheme//|(% style="width:646px" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**)|(% style="width:1044px" %)SDMX:**METADATA_PROVIDERS**(**1.0**)690 -| (% style="width:248px" %)//MetadataProvisionAgreement//|(% style="width:646px" %)metadataProvisionAgreementAgencyId:metadataP rovisionAgreementId(version)|(% style="width:1044px" %)IMF:SDDS_MDF_AB(1.0.0)691 -| (% style="width:248px" %)//MetadataSet//|(% style="width:646px" %)metadataProviderId:metadataSetId(version)|(% style="width:1044px" %)MD_PROVIDER:METADATASET(1.0.0)692 -| (% style="width:248px" %)//MetadataStructure//|(% style="width:646px" %)msdAgencyId:msdId(version)|(% style="width:1044px" %)IMF:SDDS_MSD(1.0.0)700 +)))|IMF:SDDS_MSD(1.0.0).COMPILATION.METHOD 701 +|MetadataAttributeDescriptor|msdAgencyId:msdId(version).metadataAttributeDe scriptorId|IMF:SDDS_MSD(1.0.0).MetadataAttributeDescriptor 702 +|//MetadataConstraint//|metadataConstraintAgencyId:metadataConstraintI d(version)|TFFS:CREDITOR_METADATA_CONTENT(1.0.0) 703 +|//Metadataflow//|metadataflowAgencyId:metadataflowId(version)|IMF:SDDS_MDF(1.0.0) 704 +|MetadataProvider|metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**).metadataProviderId|SDMX:**METADATA_PROVIDERS**(**1.0**).MD_PROVIDER_1 705 +|//MetadataProviderScheme//|metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**)|SDMX:**METADATA_PROVIDERS**(**1.0**) 706 +|//MetadataProvisionAgreement//|metadataProvisionAgreementAgencyId:metadataP rovisionAgreementId(version)|IMF:SDDS_MDF_AB(1.0.0) 707 +|//MetadataSet//|metadataProviderId:metadataSetId(version)|MD_PROVIDER:METADATASET(1.0.0) 708 +|//MetadataStructure//|msdAgencyId:msdId(version)|IMF:SDDS_MSD(1.0.0) 693 693 694 -| (% style="width:248px" %)**Classname**|(% style="width:629px" %)**Ending URN pattern**|(% style="width:1061px" %)**Example**695 -| (% style="width:248px" %)NamePersonalisation|(% style="width:629px" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|(% style="width:1061px" %)ECB:PSN_SCHEME(1.0.0).PSN1234696 -| (% style="width:248px" %)//NamePersonalisationScheme//|(% style="width:629px" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|(% style="width:1061px" %)ECB:PSN_SCHEME(1.0.0)697 -| (% style="width:248px" %)//OrganisationSchemeMap//|(% style="width:629px" %)orgSchemeMapAgencyId:orgSchemeMapId(versio n)|(% style="width:1061px" %)SDMX:AGENCIES_PROVIDERS(1.0.0)698 -| (% style="width:248px" %)OrganisationUnit|(% style="width:629px" %)organisationUnitSchemeAgencyId:organisationUnitSchemeId(version).organisationUnitId|(% style="width:1061px" %)ECB:ORGANISATIONS(1.0.0).1F699 -| (% style="width:248px" %)//OrganisationUnitScheme//|(% style="width:629px" %)organisationUnitSchemeAgencyId:organisationUni tSchemeId(version)|(% style="width:1061px" %)ECB:ORGANISATIONS(1.0.0)700 -| (% style="width:248px" %)//Process//|(% style="width:629px" %)processAgencyId:processId{version)|(% style="width:1061px" %)BIS:PROCESS1(1.0.0)701 -| (% style="width:248px" %)ProcessStep|(% style="width:629px" %)(((710 +|**Classname**|**Ending URN pattern**|**Example** 711 +|NamePersonalisation|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|ECB:PSN_SCHEME(1.0.0).PSN1234 712 +|//NamePersonalisationScheme//|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|ECB:PSN_SCHEME(1.0.0) 713 +|//OrganisationSchemeMap//|orgSchemeMapAgencyId:orgSchemeMapId(versio n)|SDMX:AGENCIES_PROVIDERS(1.0.0) 714 +|OrganisationUnit|organisationUnitSchemeAgencyId:organisationUni tSchemeId(version).organisationUnitId|ECB:ORGANISATIONS(1.0.0).1F 715 +|//OrganisationUnitScheme//|organisationUnitSchemeAgencyId:organisationUni tSchemeId(version)|ECB:ORGANISATIONS(1.0.0) 716 +|//Process//|processAgencyId:processId{version)|BIS:PROCESS1(1.0.0) 717 +|ProcessStep|((( 702 702 processAgencyId:processId(version).processStepId. 719 + 703 703 processStepId 704 -)))| (% style="width:1061px" %)BIS:PROCESS1(1.0.0).STEP1.STEP1_1705 -| (% style="width:248px" %)//ProvisionAgreement//|(% style="width:629px" %)provisionAgreementAgencyId:provisionAgreement Id(version)|(% style="width:1061px" %)TFFS:CRED_EXT_DEBT_AB(1.0.0)706 -| (% style="width:248px" %)ReportingCategory|(% style="width:629px" %)(((721 +)))|BIS:PROCESS1(1.0.0).STEP1.STEP1_1 722 +|//ProvisionAgreement//|provisionAgreementAgencyId:provisionAgreement Id(version)|TFFS:CRED_EXT_DEBT_AB(1.0.0) 723 +|ReportingCategory|((( 707 707 reportingTaxonomyAgencyId: 725 + 708 708 reportingTaxonomyId(version).reportingCategoryI d.reportingCategoryId 709 -)))| (% style="width:1061px" %)IMF:REP_1(1.0.0):LVL1_REP_CAT.LVL2_REP_CAT710 -| (% style="width:248px" %)//ReportingTaxonomy//|(% style="width:629px" %)reportingTaxonomyAgencyId:reportingTaxonomyI d(version)|(% style="width:1061px" %)IMF:REP_1(1.0.0)711 -| (% style="width:248px" %)//ReportingTaxonomyMap//|(% style="width:629px" %)repTaxonomyAgencyId:repTaxonomyId(version)|(% style="width:1061px" %)SDMX:RT_MAP(1.0.0)727 +)))|IMF:REP_1(1.0.0):LVL1_REP_CAT.LVL2_REP_CAT 728 +|//ReportingTaxonomy//|reportingTaxonomyAgencyId:reportingTaxonomyI d(version)|IMF:REP_1(1.0.0) 729 +|//ReportingTaxonomyMap//|repTaxonomyAgencyId:repTaxonomyId(version)|SDMX:RT_MAP(1.0.0) 712 712 713 -| (% style="width:247px" %)**Classname**|(% style="width:649px" %)**Ending URN pattern**|(% style="width:1042px" %)**Example**714 -| (% style="width:247px" %)//RepresentationMap//|(% style="width:649px" %)repMapAgencyId:repMapId(version)|(% style="width:1042px" %)SDMX:REF_AREA_MAPPING(1.0.0)715 -| (% style="width:247px" %)Ruleset|(% style="width:649px" %)rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|(% style="width:1042px" %)ECB:RULESET_23(1.0.0).SET111716 -| (% style="width:247px" %)//RulesetScheme//|(% style="width:649px" %)rulesetSchemeAgencyId rulesetSchemeId(version)|(% style="width:1042px" %)ECB:RULESET_23(1.0.0)717 -| (% style="width:247px" %)//StructureMap//|(%style="width:649px" %)structureMapAgencyId:structureMap(version)|(% style="width:1042px" %)SDMX:BOP_STRUCTURES(1.0.0)718 -| (% style="width:247px" %)Subscription|(% style="width:649px" %)(((731 +|**Classname**|**Ending URN pattern**|**Example** 732 +|//RepresentationMap//|repMapAgencyId:repMapId(version)|SDMX:REF_AREA_MAPPING(1.0.0) 733 +|Ruleset|rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|ECB:RULESET_23(1.0.0).SET111 734 +|//RulesetScheme//|rulesetSchemeAgencyId rulesetSchemeId(version)|ECB:RULESET_23(1.0.0) 735 +|//StructureMap//|structureMapAgencyId:structureMap(version)|SDMX:BOP_STRUCTURES(1.0.0) 736 +|Subscription|((( 719 719 The Subscription is not itself an Identifiable Artefact and therefore it does not follow the rules for URN structure. 738 + 720 720 The name of the URN is registryURN There is no pre-determined format. 721 -)))|(% 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. 722 -|(% style="width:247px" %)TimeDimension|(% style="width:649px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).timeDimensionId|(% style="width:1042px" %)TFFS:EXT_DEBT(1.0.0).TIME_PERIOD 723 -|(% style="width:247px" %)Transformation|(% style="width:649px" %)transformationSchemeAgencyId transformationSchemeId(version) transformationId|(% style="width:1042px" %)ECB:TRANSFORMATION_SCHEME(1.0.0).TRANS_1 724 -|(% style="width:247px" %)//TransformationScheme//|(% style="width:649px" %)transformationSchemeAgencyId transformationSchemeId(version)|(% style="width:1042px" %)ECB: TRANSFORMATION_SCHEME(1.0.0) 725 -|(% style="width:247px" %)Transition|(% style="width:649px" %)((( 740 +)))|This cannot be generated by a common mechanism as subscriptions, although maintainable in the sense that they can be submitted and deleted, are not mandated to be created by a maintenance agency and have no versioning mechanism. It is therefore the responsibility of the target registry to generate a unique Id for the Subscription, and for the application creating the subscription to store the registry URN that is returned from the registry in the subscription response message. 741 +|TimeDimension|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).timeDimensionId|TFFS:EXT_DEBT(1.0.0).TIME_PERIOD 742 +|Transformation|transformationSchemeAgencyId transformationSchemeId(version) transformationId|ECB:TRANSFORMATION_SCHEME(1.0.0).TRANS_1 743 +|//TransformationScheme//|transformationSchemeAgencyId transformationSchemeId(version)|ECB: TRANSFORMATION_SCHEME(1.0.0) 744 +|**Classname**|**Ending URN pattern**|**Example** 745 +|Transition|((( 726 726 processAgencyId:processId(version).processStepId. 747 + 727 727 transitionId 728 -)))| (% style="width:1042px" %)BIS:PROCESS1(1.0.0).STEP1.TRANSITION1729 -| (% style="width:247px" %)UserDefinedOperator|(% style="width:649px" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|(% style="width:1042px" %)ECB:OS_CALC(1.2.0).OS267730 -| (% style="width:247px" %)//UserDefinedOperatorScheme//|(% style="width:649px" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|(% style="width:1042px" %)ECB:OS_CALC(1.2.0)731 -| (% style="width:247px" %)//ValueList//|(% style="width:649px" %)valuelistAgencyId:valuelistId(version)|(% style="width:1042px" %)SDMX:VLIST(1.0.0)732 -| (% style="width:247px" %)VtlCodelistMapping|(% style="width:649px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|(% style="width:1042px" %)ECB:CLIST_MP(2.0.0).ABZ733 -| (% style="width:247px" %)VtlConceptMapping|(% style="width:649px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|(% style="width:1042px" %)ECB:CLIST_MP(1.0.0).XYA734 -| (% style="width:247px" %)VtlDataflowMapping|(% style="width:649px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|(% style="width:1042px" %)ECB:CLIST_MP(1.0.0).MOQ735 -| (% style="width:247px" %)//VtlMappingScheme//|(% style="width:649px" %)vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|(% style="width:1042px" %)ECB:CLIST_MP(2.0.0)749 +)))|BIS:PROCESS1(1.0.0).STEP1.TRANSITION1 750 +|UserDefinedOperator|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|ECB:OS_CALC(1.2.0).OS267 751 +|//UserDefinedOperatorScheme//|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|ECB:OS_CALC(1.2.0) 752 +|//ValueList//|valuelistAgencyId:valuelistId(version)|SDMX:VLIST(1.0.0) 753 +|VtlCodelistMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|ECB:CLIST_MP(2.0.0).ABZ 754 +|VtlConceptMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|ECB:CLIST_MP(1.0.0).XYA 755 +|VtlDataflowMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|ECB:CLIST_MP(1.0.0).MOQ 756 +|//VtlMappingScheme//|vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|ECB:CLIST_MP(2.0.0) 736 736 737 737 **Table 3: Table of identification components for SDMX Identifiable Artefacts** 738 738 ... ... @@ -740,7 +740,7 @@ 740 740 741 741 === {{id name="_Toc93862"/}}7.1 Structural Definition Metadata === 742 742 743 -=== {{id name="_Toc93863"/}}7.1.1 Introduction === 764 +===== {{id name="_Toc93863"/}}7.1.1 Introduction ===== 744 744 745 745 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.) 746 746 ... ... @@ -756,79 +756,90 @@ 756 756 757 757 The following table lists the Maintainable Artefacts. 758 758 759 -(% style="width:881.294px" %) 760 -|(% colspan="2" style="width:522px" %)**Maintainable Artefacts**|(% style="width:490px" %)**Content** 761 -|(% style="width:198px" %)**Abstract Class**|(% style="width:324px" %)**Concrete Class**|(% style="width:490px" %) 762 -|(% style="width:198px" %)Item Scheme|(% style="width:324px" %)Codelist|(% style="width:490px" %)Code 763 -|(% style="width:198px" %) |(% style="width:324px" %)Concept Scheme|(% style="width:490px" %)Concept 764 -|(% style="width:198px" %) |(% style="width:324px" %)Category Scheme|(% style="width:490px" %)Category 765 -|(% style="width:198px" %) |(% style="width:324px" %)Organisation Unit Scheme|(% style="width:490px" %)Organisation Unit 766 -|(% style="width:198px" %) |(% style="width:324px" %)Agency Scheme|(% style="width:490px" %)Agency 767 -|(% style="width:198px" %) |(% style="width:324px" %)Data Provider Scheme|(% style="width:490px" %)Data Provider 768 -|(% style="width:198px" %) |(% style="width:324px" %)Metadata Provider Scheme|(% style="width:490px" %)Metadata Provider 769 -|(% style="width:198px" %) |(% style="width:324px" %)Data Consumer Scheme|(% style="width:490px" %)Data Consumer 770 -|(% style="width:198px" %) |(% style="width:324px" %)Reporting Taxonomy|(% style="width:490px" %)Reporting Category 771 -|(% style="width:198px" %) |(% style="width:324px" %)Transformation Scheme|(% style="width:490px" %)Transformation 772 -|(% style="width:198px" %) |(% style="width:324px" %)Custom Type Scheme|(% style="width:490px" %)Custom Type 773 -|(% style="width:198px" %) |(% style="width:324px" %)Name Personalisation Scheme|(% style="width:490px" %)Name Personalisation 774 -|(% style="width:198px" %) |(% style="width:324px" %)Vtl Mapping Scheme|(% style="width:490px" %)Vtl Codelist Mapping Vtl Concept Mapping 775 -|(% style="width:198px" %) |(% style="width:324px" %)Ruleset Scheme|(% style="width:490px" %)Ruleset 776 -|(% style="width:198px" %) |(% style="width:324px" %)User Defined Operator Scheme|(% style="width:490px" %)User Defined Operator 777 -|(% style="width:198px" %)Enumerated List|(% style="width:324px" %)ValueList|(% style="width:490px" %)Value Item 778 -|(% style="width:198px" %)Structure|(% style="width:324px" %)Data Structure Definition|(% style="width:490px" %)((( 780 +|(% colspan="2" %)**Maintainable Artefacts**|**Content** 781 +|**Abstract Class**|**Concrete Class**| 782 +|Item Scheme|Codelist|Code 783 +| |Concept Scheme|Concept 784 +| |Category Scheme|Category 785 +| |Organisation Unit Scheme|Organisation Unit 786 +| |Agency Scheme|Agency 787 +| |Data Provider Scheme|Data Provider 788 +| |Metadata Provider Scheme|Metadata Provider 789 +| |Data Consumer Scheme|Data Consumer 790 +| |Reporting Taxonomy|Reporting Category 791 +| |Transformation Scheme|Transformation 792 +| |Custom Type Scheme|Custom Type 793 +| |Name Personalisation Scheme|Name Personalisation 794 +| |Vtl Mapping Scheme|Vtl Codelist Mapping Vtl Concept Mapping 795 +| |Ruleset Scheme|Ruleset 796 +| |User Defined Operator Scheme|User Defined Operator 797 +|Enumerated List|ValueList|Value Item 798 +|Structure|Data Structure Definition|((( 779 779 Dimension Descriptor 800 + 780 780 Group Dimension Descriptor 802 + 781 781 Dimension 804 + 782 782 Time Dimension 806 + 783 783 Attribute Descriptor 808 + 784 784 Data Attribute 810 + 785 785 Measure Descriptor 812 + 786 786 Measure 787 787 ))) 788 -| (%style="width:198px" %)|(% style="width:324px" %)Metadata Structure Definition|(% style="width:490px" %)Metadata Attribute Descriptor Metadata Attribute789 -| (% style="width:198px" %)Structure Usage|(% style="width:324px" %)Dataflow|(%style="width:490px" %)790 -| (%style="width:198px" %)|(% style="width:324px" %)Metadataflow|(%style="width:490px" %)791 -| (% style="width:198px" %)None|(% style="width:324px" %)Process|(% style="width:490px" %)Process Step792 -| (% style="width:198px" %)None|(% style="width:324px" %)Structure Map|(% style="width:490px" %)(((815 +| |Metadata Structure Definition|Metadata Attribute Descriptor Metadata Attribute 816 +|Structure Usage|Dataflow| 817 +| |Metadataflow| 818 +|None|Process|Process Step 819 +|None|Structure Map|((( 793 793 Component Map 821 + 794 794 Epoch Map 823 + 795 795 Date Pattern Map 796 796 ))) 797 -| (% style="width:198px" %)None|(% style="width:324px" %)Representation Map|(% style="width:490px" %)Representation Mapping798 -| (% style="width:198px" %)Item Scheme Map|(% style="width:324px" %)Organisation Scheme Map|(% style="width:490px" %)Item Map799 -| (%style="width:198px" %)|(% style="width:324px" %)Concept Scheme Map|(% style="width:490px" %)Item Map800 -| (%style="width:198px" %)|(% style="width:324px" %)Category Scheme Map|(% style="width:490px" %)Item Map801 -| (%style="width:198px" %)|(% style="width:324px" %)Reporting Taxonomy Map|(% style="width:490px" %)Item Map802 -| (% style="width:198px" %)None|(% style="width:324px" %)Provision Agreement|(%style="width:490px" %)803 -| (% style="width:198px" %)None|(% style="width:324px" %)Metadata Provision Agreement|(%style="width:490px" %)804 -| (% style="width:198px" %)None|(% style="width:324px" %)Hierarchy|(% style="width:490px" %)Hierarchical Code805 -| (% style="width:198px" %)None|(% style="width:324px" %)Hierarchy Association|(%style="width:490px" %)806 -| (% style="width:198px" %)None|(% style="width:324px" %)Categorisation|(%style="width:490px" %)826 +|None|Representation Map|Representation Mapping 827 +|Item Scheme Map|Organisation Scheme Map|Item Map 828 +| |Concept Scheme Map|Item Map 829 +| |Category Scheme Map|Item Map 830 +| |Reporting Taxonomy Map|Item Map 831 +|None|Provision Agreement| 832 +|None|Metadata Provision Agreement| 833 +|None|Hierarchy|Hierarchical Code 834 +|None|Hierarchy Association| 835 +|None|Categorisation| 807 807 808 808 **Table 4: Table of Maintainable Artefacts for Structural Definition Metadata** 809 809 810 -=== {{id name="_Toc93864"/}}7.1.2 Item Scheme, Structure === 839 +===== {{id name="_Toc93864"/}}7.1.2 Item Scheme, Structure ===== 811 811 812 812 The artefacts included in the structural definitions are: 813 813 814 -* 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) 815 -* All types of Enumerated List (ValueList){{footnote}}Note that Codelist is also an EnumeratedList.{{/footnote}} 816 -* All types of Structure (Data Structure Definition, Metadata Structure Definition) 817 -* All types of Structure Usage (Dataflow, Metadataflow) 843 +• All types of Item Scheme (Codelist, Concept Scheme, Category Scheme, Organisation Scheme, Agency Scheme, Data Provider Scheme, Metadata Provider Scheme, Data Consumer Scheme, Organisation Unit Scheme, Transformation Scheme, Name Personalisation Scheme, Custom Type Scheme, Vtl Mapping Scheme, Ruleset Scheme, User Defined Operator Scheme) 818 818 819 - ==={{idname="_Toc93865"/}}7.1.3StructureUsage===845 +• All types of Enumerated List (ValueList)^^[[(% class="wikiinternallink wikiinternallink wikiinternallink" %)^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]](%%)^^ 820 820 821 - ====7.1.3.1StructureUsage: BasicConcepts====847 +• All types of Structure (Data Structure Definition, Metadata Structure Definition) 822 822 849 +• All types of Structure Usage (Dataflow, Metadataflow) 850 + 851 +===== {{id name="_Toc93865"/}}7.1.3 Structure Usage ===== 852 + 853 +**7.1.3.1 Structure Usage: Basic Concepts** 854 + 823 823 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. 824 824 825 - ====7.1.3.2 Structure Usage Schematic====857 +**7.1.3.2 Structure Usage Schematic** 826 826 827 827 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_52097ab5.jpg||height="246" width="438"]] 828 828 829 829 **Figure 9: Schematic of Linking the Data and Metadata Flows to Categories and Structure Definitions** 830 830 831 - ====7.1.3.3 Structure Usage Model====863 +**7.1.3.3 Structure Usage Model** 832 832 833 833 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_302cc1a2.jpg||height="548" width="578"]] 834 834 ... ... @@ -844,9 +844,9 @@ 844 844 * Categorisation to Dataflow and Category 845 845 * Categorisation to Metadataflow and Category 846 846 847 -== {{id name="_Toc93866"/}}7.2 Data and Metadata Provisioning == 879 +=== {{id name="_Toc93866"/}}7.2 Data and Metadata Provisioning === 848 848 849 -=== {{id name="_Toc93867"/}}7.2.1 Provisioning Agreement: Basic concepts === 881 +===== {{id name="_Toc93867"/}}7.2.1 Provisioning Agreement: Basic concepts ===== 850 850 851 851 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. 852 852 ... ... @@ -854,7 +854,7 @@ 854 854 855 855 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. 856 856 857 -=== {{id name="_Toc93868"/}}7.2.2 Provisioning Agreement Model – pull use case === 889 +===== {{id name="_Toc93868"/}}7.2.2 Provisioning Agreement Model – pull use case ===== 858 858 859 859 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. 860 860 ... ... @@ -876,9 +876,9 @@ 876 876 877 877 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. 878 878 879 -== {{id name="_Toc93869"/}}7.3 Data and Metadata Constraints == 911 +=== {{id name="_Toc93869"/}}7.3 Data and Metadata Constraints === 880 880 881 -=== {{id name="_Toc93870"/}}7.3.1 Data and Metadata Constraints: Basic Concepts === 913 +===== {{id name="_Toc93870"/}}7.3.1 Data and Metadata Constraints: Basic Concepts ===== 882 882 883 883 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. 884 884 ... ... @@ -942,14 +942,17 @@ 942 942 943 943 The Registration has an action attribute which takes one of the following values: 944 944 977 +: 978 + 945 945 ((( 946 -(% style="width:761.294px" %) 947 -|(% style="width:196px" %)**Action Attribute Value**|(% style="width:561px" %)**Behaviour** 948 -|(% style="width:196px" %)Append|(% style="width:561px" %)Add this Registration to the registry 949 -|(% style="width:196px" %)Replace|(% style="width:561px" %)((( 950 -Replace the existing Registration with identified by the id in the Registration of the SubmitRegistrationRequest 980 +|**Action Attribute Value**|**Behaviour** 981 +|Append|Add this Registration to the registry 982 +|Replace|((( 983 +Replace the existing Registration with identified by the id in the 984 + 985 +Registration of the SubmitRegistrationRequest 951 951 ))) 952 -| (% style="width:196px" %)Delete|(% style="width:561px" %)Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest987 +|Delete|Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest 953 953 ))) 954 954 955 955 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_bc1dcdec.jpg||height="575" width="579"]] ... ... @@ -966,20 +966,27 @@ 966 966 967 967 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. 968 968 1004 +: 1005 + 969 969 ((( 970 -(% style="width:678.294px" %) 971 -|**Indexing Required**|(% style="width:504px" %)**Registration Process Activity** 972 -|indexTimeSeries|(% style="width:504px" %)Extract all the series keys and create a KeySet(s) Constraint. 973 -|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. 974 -|indexReportingPeriod|(% style="width:504px" %)((( 1007 +|**Indexing Required**|**Registration Process Activity** 1008 +|indexTimeSeries|Extract all the series keys and create a KeySet(s) Constraint. 1009 +|indexDataSet|Extract all the codes and other content of the Key value of the Series Key in a Data Set and create one or more Cube Regions containing Member Selections of Dimension Components of the Constraints model in the SDMX-IM, and the associated Selection Value. 1010 +|indexReportingPeriod|((( 975 975 This applies only to a registered __dataset__. 1012 + 976 976 Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint. 977 977 ))) 978 -|**Indexing Required**| (% style="width:504px" %)**Registration Process Activity**979 -|indexAttributes|( % style="width:504px" %)(((1015 +|**Indexing Required**|**Registration Process Activity** 1016 +|indexAttributes|((( 980 980 **Data Set** 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 1018 + 1019 +Extract the content of the Attribute Values in a Data Set and create one or more Cube Regions containing Member Selections of Data Attribute Components of the Constraints model in the 1020 + 1021 +SDMXIM, and the associated Selection Value 1022 + 982 982 **Metadata Set** 1024 + 983 983 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. 984 984 ))) 985 985 ))) ... ... @@ -988,7 +988,7 @@ 988 988 989 989 The Registration must reference the ProvisionAgreement or MetadataProvisionAgreement to which it relates. 990 990 991 -=== {{id name="_Toc93876"/}}7.4.3 Registration Response === 1033 +===== {{id name="_Toc93876"/}}7.4.3 Registration Response ===== 992 992 993 993 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”. 994 994 ... ... @@ -1018,18 +1018,20 @@ 1018 1018 1019 1019 Regardless of the type of registry/repository events being observed, a subscription always contains: 1020 1020 1021 -1. set of URIs describing the end-points to which notifications must be sent if the subscription is activated. The URIs can be either mailto~: or http: protocol. In the former case an email notification is sent; in the latter an HTTP POST notification is sent. 1063 +1. A set of URIs describing the end-points to which notifications must be sent if the subscription is activated. The URIs can be either mailto~: or http: protocol. In the former case an email notification is sent; in the latter an HTTP POST notification is sent. 1022 1022 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. 1023 1023 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. 1024 1024 1. A selector which specifies which type of events are of interest. The set of event types is: 1025 1025 1068 +: 1069 +:: 1070 + 1026 1026 ((( 1027 -(% style="width:856.294px" %) 1028 -|(% style="width:320px" %)**Event Type**|(% style="width:532px" %)**Comment** 1029 -|(% style="width:320px" %)STRUCTURAL_REPOSITORY_EVENTS|(% style="width:532px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository. 1030 -|(% 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. 1031 -|(% 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. 1032 -|(% style="width:320px" %)ALL_EVENTS|(% style="width:532px" %)All events of the specified EventType 1072 +|**Event Type**|**Comment** 1073 +|STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository. 1074 +|DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database. 1075 +|METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database. 1076 +|ALL_EVENTS|All events of the specified EventType 1033 1033 ))) 1034 1034 1035 1035 === {{id name="_Toc93880"/}}7.5.3 Wildcard Facility === ... ... @@ -1096,14 +1096,15 @@ 1096 1096 1097 1097 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: 1098 1098 1143 +: 1144 + 1099 1099 ((( 1100 -(% style="width:1126.29px" %) 1101 -|(% style="width:382px" %)**Selector**|(% style="width:740px" %)**Comment** 1102 -|(% 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. 1103 -|(% style="width:382px" %)ProvisionAgreement & MetadataProvisionAgreement|(% style="width:740px" %)Any datasets or metadata sets registered for the agreement will activate the notification. 1104 -|(% style="width:382px" %)Dataflow & Metadataflow|(% style="width:740px" %)Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification. 1105 -|(% 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 1106 -|(% style="width:382px" %)Category|(% style="width:740px" %)Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category. 1146 +|**Selector**|**Comment** 1147 +|DataProvider & MetadataProvider|Any datasets or metadata sets registered by the specified data or metadata provider will activate the notification. 1148 +|ProvisionAgreement & MetadataProvisionAgreement|Any datasets or metadata sets registered for the agreement will activate the notification. 1149 +|Dataflow & Metadataflow|Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification. 1150 +|DataStructureDefinition & MetadataStructureDefinition|Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will activate the notification 1151 +|Category|Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category. 1107 1107 ))) 1108 1108 1109 1109 The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration. ... ... @@ -1135,6 +1135,12 @@ 1135 1135 1136 1136 The notification will contain the Registration. 1137 1137 1138 - ----1183 +[[1>>path:#sdfootnote1anc||name="sdfootnote1sym"]] With semantic versioning, it is allowed to reference a range of artefacts, e.g., a DSD referencing a Codelist with version 1.2.3+ means all patch versions greater than 1.2.3. This means that deleting 1.2.4draft does not break integrity of the aforementioned DSD. 1139 1139 1185 +[[2>>path:#sdfootnote2anc||name="sdfootnote2sym"]] The identification of an Agency in the URN structure for the maintainable object is by means of the agencyId. The AgencyScheme is not identified as SDMX has a mechanism for identifying an Agency uniquely by its Id. Note that this Id may be hierarchical. For example, a sub-agency of IMF is referred like this: 1186 + 1187 +IMF.SubAgency1 1188 + 1189 +[[3>>path:#sdfootnote3anc||name="sdfootnote3sym"]] Note that Codelist is also an EnumeratedList. 1190 + 1140 1140 {{putFootnotes/}}
- SUZ.Methodology.Code.MethodologyClass[0]
-