Last modified by Helena on 2025/09/10 11:19
Summary
-
Page properties (1 modified, 0 added, 0 removed)
-
Attachments (0 modified, 0 added, 8 removed)
Details
- Page properties
-
- Content
-
... ... @@ -4,11 +4,10 @@ 4 4 5 5 **Revision History** 6 6 7 -(% style="width:833.294px" %) 8 -|(% style="width:122px" %)**Revision**|(% style="width:126px" %)**Date**|(% style="width:581px" %)**Contents** 9 -|(% style="width:122px" %) |(% style="width:126px" %)April 2011|(% style="width:581px" %)Initial release 10 -|(% style="width:122px" %)1.0|(% style="width:126px" %)July 2011|(% style="width:581px" %)Rectification of problems of the specifications dated April 2011 11 -|(% style="width:122px" %)2.0|(% style="width:126px" %)July 2020|(% style="width:581px" %)Addition of VTL (Validation and Transformation Language) package, maintainable artefacts, nameable artefacts to 5.2.3, 6.2.2, 6.2.3, 6.2.4, 7.1.1 7 +|**Revision**|**Date**|**Contents** 8 +| |April 2011|Initial release 9 +|1.0|July 2011|Rectification of problems of the specifications dated April 2011 10 +|2.0|July 2020|Addition of VTL (Validation and Transformation Language) package, maintainable artefacts, nameable artefacts to 5.2.3, 6.2.2, 6.2.3, 6.2.4, 7.1.1 12 12 13 13 **Corrigendum** 14 14 ... ... @@ -289,25 +289,27 @@ 289 289 * that a queryable data source exists - this would necessitate the registration service querying the service to determine its existence 290 290 * that a simple data source exists (i.e. a file accessible at a URL) 291 291 * that the correct Data Structure Definition or Metadata Structure Definition is used by the registered data that the components (Dimensions, Attributes, Measures, Identifier Components etc.) are consistent with the Data Structure Definition or Metadata Structure Definition 292 -* that the valid representations of the concepts to which these components correspond conform to the definition in the Data Structure Definition or Metadata Structure Definition 291 +* that the valid representations of the concepts to which these components 382 correspond conform to the definition in the Data Structure Definition or Metadata Structure Definition 293 293 294 294 3The Registration has an action attribute which takes one of the following values: 295 295 296 -(% style="margin-left:auto; margin-right:auto" %) 297 -|(% style="width:200px" %)((( 295 +|(% style="width:249px" %)((( 298 298 **Action Attribute Value** 299 -)))|(% style="width:1672px" %)**Behaviour** 300 -|(% style="width:200px" %)Append|(% style="width:1672px" %)Add this registration to the registry 301 -|(% style="width:200px" %)Replace|(% style="width:1672px" %)Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request 302 -|(% style="width:200px" %)Delete|(% style="width:1672px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request 297 +)))|(% style="width:1622px" %)**Behaviour** 298 +|(% style="width:249px" %)Append|(% style="width:1622px" %)Add this registration to the registry 299 +|(% style="width:249px" %)Replace|(% style="width:1622px" %)Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request 300 +|(% style="width:249px" %)Delete|(% style="width:1622px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request 301 + 303 303 The Registration has three Boolean attributes which may be present to determine how an SDMX compliant Dataset or Metadata Set indexing application must index the Datasets or Metadata Set upon registration. The indexing application behaviour is as follows: 304 -|(% style="width:200px" %)**Boolean Attribute**|(% style="width:1672px" %)**Behaviour if Value is “true”** 305 -|(% style="width:200px" %)indexTimeSeries|(% style="width:1672px" %)A compliant indexing application must index all the time series keys (for a Dataset registration) or metadata target values (for a Metadata Set registration) 306 -|(% style="width:200px" %)indexDataSet|(% style="width:1672px" %)((( 303 + 304 +|**Boolean Attribute**|**Behaviour if Value is “true”** 305 +|indexTimeSeries|A compliant indexing application must index all the time series keys (for a Dataset registration) or metadata target values (for a Metadata Set registration) 306 +|indexDataSet|((( 307 307 A compliant indexing application must index the range of actual (present) values for each dimension of the Dataset (for a Dataset registration) or the range of actual (present) values for each Metadata Attribute which takes an enumerated value. 308 + 308 308 Note that for data this requires much less storage than full key indexing, but this method cannot guarantee that a specific combination of Dimension values (the Key) is actually present in the Dataset 309 309 ))) 310 -| (% style="width:200px" %)indexReportingPeriod|(% style="width:1672px" %)A compliant indexing application must index the time period range(s) for which data are present in the Dataset or Metadata Set311 +|indexReportingPeriod|A compliant indexing application must index the time period range(s) for which data are present in the Dataset or Metadata Set 311 311 312 312 === 5.2.5 Data and Reference Metadata Discovery === 313 313 ... ... @@ -339,8 +339,8 @@ 339 339 340 340 The following table defines the behaviour of the SDMX Registry for the various Registry Interface messages. 341 341 342 -|(% style="width:2 27px" %)**Interface**|(% style="width:1644px" %)**Behaviour**343 -|(% style="width:2 27px" %)All|(% style="width:1644px" %)(((343 +|(% style="width:244px" %)**Interface**|**Behaviour** 344 +|(% style="width:244px" %)All|((( 344 344 1) If the action is set to “replace” then the entire contents of the existing maintainable object in the Registry MUST be replaced by the object submitted, unless the final attribute is set to “true” in which case the only changes that are allowed are to the following constructs: 345 345 346 346 * Name – this applies to the Maintainable object and its contained elements, such a Code in a Code list. ... ... @@ -354,6 +354,7 @@ 354 354 * isExternalReference 355 355 356 356 2) Cross referenced structures MUST exist in either the submitted document (in Structures or Structure Location) or in the registry to which the request is submitted. 358 + 357 357 3) If the action is set to “delete” then the Registry MUST verify that the object can deleted. In order to qualify for deletion the object must: 358 358 359 359 а) Not have the final attribute set to “true” ... ... @@ -360,11 +360,12 @@ 360 360 b) Not be referenced from any other object in the Registry. 361 361 362 362 4) The version rules in the SDMX Schema documentation MUST be obeyed. 365 + 363 363 5) The specific rules for the elements and attributes documented in the SDMX Schema MUST be obeyed. 364 364 ))) 365 -|(% style="width:2 27px" %)SubmitStructureRequest|(% style="width:1644px" %)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.366 -|(% style="width:2 27px" %)SubmitProvisioningRequest|(% style="width:1644px" %)No additional behaviour.367 -|(% style="width:2 27px" %)Submit Registration Request|(% style="width:1644px" %)(((368 +|(% style="width:244px" %)SubmitStructureRequest|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. 369 +|(% style="width:244px" %)SubmitProvisioningRequest|No additional behaviour. 370 +|(% style="width:244px" %)Submit Registration Request|((( 368 368 If the datasource is a file (simple datasource) then the file MAY be retrieved and indexed according to the Boolean attributes set in the Registration. 369 369 For a queryable datasource the Registry MAY validate that the source exists and can accept an SDMX-ML data query. 370 370 ))) ... ... @@ -487,7 +487,7 @@ 487 487 488 488 The generic structure of the URN is as follows: 489 489 490 - >SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobject-id(maintainedobject-version).*containerobject-id.object-id493 +SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobject-id(maintainedobject-version).*containerobject-id.object-id 491 491 492 492 ~* this can repeat and may not be present (see explanation below) 493 493 ... ... @@ -499,7 +499,7 @@ 499 499 500 500 In the explanation below the actual object that is the target of the URN is called the **//actual object//**. 501 501 502 -**SDMXPrefix:** urn:sdmx:org. 505 +**SDMXPrefix:** urn:sdmx:org. 503 503 504 504 **SDMX-IM package name:** sdmx.infomodel.package= 505 505 ... ... @@ -678,52 +678,78 @@ 678 678 679 679 Note that for brevity the URN examples omit the prefix. All URNs have the prefix 680 680 681 - >urn:sdmx.org.sdmx.infomodel.{package}.{classname}=684 +urn:sdmx.org.sdmx.infomodel.{package}.{classname}= 682 682 683 - (% style="width:1091.29px" %)684 -| (% style="width:250px" %)**SDMX Class**|(% style="width:444px" %)**Key attribute(s)**|(% style="width:396px" %)**Example of URN**685 -| (% style="width:250px" %)Agency|(% style="width:444px" %)The URN for an Agency is shown later in this table. 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.|(% style="width:396px" %)(((686 + 687 +|**SDMX Class**|**Key attribute(s)**|**Example of URN** 688 +|Agency|The URN for an Agency is shown later in this table. 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.|((( 686 686 IMF 690 + 691 + 687 687 Sub agency in the IMF AGENCIES 693 + 694 + 688 688 IMF.SubAgency1 689 689 ))) 690 -|(% style="width:250px" %)*ConceptScheme|(% style="width:444px" %)conceptSchemeAgencyId:conceptSchemeId(ve rsion)|(% style="width:396px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0) 691 -|(% style="width:250px" %)Concept|(% style="width:444px" %)conceptSchemeAgencyId: 692 -conceptSchemeId(version).conceptId|(% style="width:396px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0).FREQ 693 -|(% style="width:250px" %)*Codelist|(% style="width:444px" %)codeListAgencyId:codeListId(version)|(% style="width:396px" %)SDMX:CL_FREQ(1.0) 694 -|(% style="width:250px" %)Code|(% style="width:444px" %)codeListAgencyId:codelistId(version).codeId|(% style="width:396px" %)SDMX:CL_FREQ(1.0).Q 695 -|(% style="width:250px" %)((( 696 -*Hierarchical Codelist 697 -)))|(% style="width:444px" %)hierachicalCodelistAgencyId: hierarchicalCodelistId(version)|(% style="width:396px" %)((( 698 -UNESCO:CL_EXP_SOURCE(1.0(% style="background-color:transparent" %)) 697 +|*ConceptScheme|conceptSchemeAgencyId:conceptSchemeId(ve rsion)|SDMX:CROSS_DOMAIN_CONCEPTS(1.0) 698 +|Concept|((( 699 +conceptSchemeAgencyId: 700 + 701 +conceptSchemeId(version).conceptId 702 +)))|SDMX:CROSS_DOMAIN_CONCEPTS(1.0).FREQ 703 +|*Codelist|codeListAgencyId:codeListId(version)|SDMX:CL_FREQ(1.0) 704 +|Code|codeListAgencyId:codelistId(version).codeId|((( 705 +SDMX:CL_FREQ(1.0).Q 706 + 707 + 699 699 ))) 700 -|(% style="width:250px" %)Hierarchy|(% style="width:444px" %)((( 709 + 710 + 711 + 712 +|((( 713 +*Hierarchical 714 + 715 +Codelist 716 +)))|hierachicalCodelistAgencyId: hierarchicalCodelistId(version)|((( 717 +UNESCO:CL_EXP_SOURCE(1.0) 718 + 719 + 720 +))) 721 +|Hierarchy|((( 701 701 hierachicalcodeListAgencyId: 723 + 702 702 hierarchicalcodelistId(version).Hierarchy 703 -)))|(% style="width:396px" %)UNESCO:CL_EXP_SOURCE(1.0). 704 -H-C-GOV 705 -|(% style="width:250px" %)Level|(% style="width:444px" %)((( 725 +)))|UNESCO:CL_EXP_SOURCE(1.0). H-C-GOV 726 +|Level|((( 706 706 hierachicalcodeListAgencyId: 728 + 707 707 hierarchicalcodelistId(version).Hierarchy.Level 708 -)))|( % style="width:396px" %)(((730 +)))|((( 709 709 ESTAT:HCL_REGION(1.0).H_1.COUNTRY 710 710 711 711 712 712 ))) 713 -| (% style="width:250px" %)HierarchicalCode|(% style="width:444px" %)hierachicalCodeListAgencyId: hierarchicalcodelistId(version).hierarchy.hierarc hicalCode|(% style="width:396px" %)UNESCO:CL_EXP_SOURCE(1.0). H-C-GOV.GOV_CODE1714 -| (% style="width:250px" %)*DataStructure|(% style="width:444px" %)dataStructureDefintitionAgencyId: dataStructureDefintitionId(version)|(% style="width:396px" %)TFFS:EXT_DEBT(1.0)715 -|( % style="width:250px" %)(((735 +|HierarchicalCode|hierachicalCodeListAgencyId: hierarchicalcodelistId(version).hierarchy.hierarc hicalCode|UNESCO:CL_EXP_SOURCE(1.0). H-C-GOV.GOV_CODE1 736 +|*DataStructure|dataStructureDefintitionAgencyId: dataStructureDefintitionId(version)|TFFS:EXT_DEBT(1.0) 737 +|((( 716 716 Dimension 739 + 717 717 Descriptor 741 + 718 718 Measure 743 + 719 719 Descriptor 745 + 720 720 Attribute 747 + 721 721 Descriptor 722 -)))|( % style="width:444px" %)(((749 +)))|((( 723 723 dataStructureDefinitionAgencyId: dataStructureDefinitionId(version). 751 + 724 724 componentListId 753 + 725 725 where the componentListId is the name of the class (there is only one occurrence of each in the Data Structure Definition) 726 -)))|( % style="width:396px" %)(((755 +)))|((( 727 727 TFFS:EXT_DEBT(1.0).DimensionDescriptor 728 728 729 729 TFFS:EXT_DEBT(1.0).MeasureDescriptor ... ... @@ -730,132 +730,181 @@ 730 730 731 731 TFFS:EXT_DEBT(1.0).AttributeDescriptor 732 732 ))) 733 -|( % style="width:250px" %)(((762 +|((( 734 734 GroupDimension 764 + 735 735 Descriptor 736 -)))|( % style="width:444px" %)(((766 +)))|((( 737 737 dataStructureDefinitionAgencyId: dataStructureDefinitionId(version). 768 + 738 738 groupDimensionDescriptorId 739 -)))| (% style="width:396px" %)TFFS:EXT_DEBT(1.0).SIBLING740 -| (% style="width:250px" %)Dimension|(% style="width:444px" %)(((770 +)))|TFFS:EXT_DEBT(1.0).SIBLING 771 +|Dimension|((( 741 741 dataStructureDefinitionAgencyId: dataStructureDefinition (version). 773 + 742 742 dimensionId 743 -)))| (% style="width:396px" %)TFFS:EXT_DEBT(1.0).FREQ744 -| (% style="width:250px" %)TimeDimension|(% style="width:444px" %)(((775 +)))|TFFS:EXT_DEBT(1.0).FREQ 776 +|TimeDimension|((( 745 745 dataStructureDefinitionAgencyId: dataStructureDefinition (version). 778 + 746 746 timeDimensionId 747 -)))|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).TIME_PERIOD 748 -|(% style="width:250px" %)Measure Dimension|(% style="width:444px" %)dataStructureDefinitionAgencyId: dataStructureDefinition (version). 749 -measureDimensionId|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).STOCK_FLOW 750 -|(% style="width:250px" %)DataAttrribute|(% style="width:444px" %)dataStructureDefinitionAgencyId: dataStructureDefinition (version). dataAttributeId|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).OBS_STATUS 751 -|(% style="width:250px" %)PrimaryMeasure|(% style="width:444px" %)((( 780 +)))|TFFS:EXT_DEBT(1.0).TIME_PERIOD 781 +|Measure Dimension|dataStructureDefinitionAgencyId: dataStructureDefinition (version).|TFFS:EXT_DEBT(1.0).STOCK_FLOW 782 + 783 + 784 + 785 +| |measureDimensionId| 786 +|DataAttrribute|dataStructureDefinitionAgencyId: dataStructureDefinition (version). dataAttributeId|TFFS:EXT_DEBT(1.0).OBS_STATUS 787 +|PrimaryMeasure|((( 752 752 dataStructureDefinitionAgencyId: dataStructureDefinition (version). 789 + 753 753 primaryMeasureId 754 -)))|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).OBS_VALUE 755 -|(% style="width:250px" %)((( 756 -*Category Scheme 757 -)))|(% style="width:444px" %)categorySchemeAgencyId: 758 -categorySchemeId(version)|(% style="width:396px" %)IMF:SDDS(1.0) 759 -|(% style="width:250px" %)Category|(% style="width:444px" %)categorySchemeAgencyId: 760 -categorySchemeId(version). 761 -categoryId.categoryId categoryId.categoryId etc.|(% style="width:396px" %)((( 791 +)))|TFFS:EXT_DEBT(1.0).OBS_VALUE 792 +|((( 793 +*Category 794 + 795 +Scheme 796 +)))|categorySchemeAgencyId: categorySchemeId(version)|IMF:SDDS(1.0) 797 +|Category|categorySchemeAgencyId: categorySchemeId(version). categoryId.categoryId categoryId.categoryId etc.|((( 762 762 IMF:SDDS(1.0): 799 + 763 763 level_1_category.level_2_category … 764 764 ))) 765 -|(% style="width:250px" %)((( 766 -*Reporting Taxonomy 767 -)))|(% style="width:444px" %)reportingTaxonomyAgencyId: reportingTaxonomyId(version)|(% style="width:396px" %) IMF:REP_1(1.0) 768 -|(% style="width:250px" %)ReportingCategory|(% style="width:444px" %)reportingTaxonomyAgencyId: reportingTaxonomyId(version) reportingcategoryId.reportingcategoryId|(% style="width:396px" %)((( 802 +|((( 803 +*Reporting 804 + 805 +Taxonomy 806 +)))|reportingTaxonomyAgencyId: reportingTaxonomyId(version)| IMF:REP_1(1.0) 807 +|ReportingCategory|reportingTaxonomyAgencyId: reportingTaxonomyId(version) reportingcategoryId.reportingcategoryId|((( 769 769 IMF:REP_1(1.0): 809 + 770 770 level_1_repcategory.level_2_repcategory … 771 771 ))) 772 -|(% style="width:250px" %)*Categorisation|(% style="width:444px" %)categorisationAgencyId: categorisationId(version)|(% style="width:396px" %)IMF:cat001(1.0) 773 -|(% style="width:250px" %)((( 774 -*Organisation Unit Scheme 775 -)))|(% style="width:444px" %)organisationUnitSchemeAgencyId: organisationUnitSchemeId(version)|(% style="width:396px" %)ECB:ORGANISATIONS(1.0) 776 -|(% style="width:250px" %)Organisation Unit|(% style="width:444px" %)organisationUnitSchemeAgencyId: organisationUnitSchemeId(version). organisationUnitId|(% style="width:396px" %)ECB:ORGANISATIONS(1.0).1F 777 -|(% style="width:250px" %)*AgencyScheme|(% style="width:444px" %)agencySchemeAgencyId: agencySchemeId(version)|(% style="width:396px" %)ECB:AGENCIES(1.0) 812 +|*Categorisation|categorisationAgencyId: categorisationId(version)|IMF:cat001(1.0) 813 +|((( 814 +*Organisation 778 778 779 -|(% style="width:262px" %)Agency|(% style="width:369px" %)agencySchemeAgencyId: agencySchemeId(version). agencyId|(% style="width:1262px" %)ECB:AGENCY(1.0).AA 780 -|(% style="width:262px" %)((( 781 -*DataProvider Scheme 782 -)))|(% style="width:369px" %)dataProviderSchemeAgencyId: dataProviderSchemeId(version)|(% style="width:1262px" %)SDMX:DATA_PROVIDERS(1.0) 783 -|(% style="width:262px" %)DataProvider|(% style="width:369px" %)dataProviderSchemeAgencyId: dataProviderSchemeId(version) dataProviderId|(% style="width:1262px" %)SDMX:DATA_PROVIDERS(1.0).PROVIDER_1 784 -|(% style="width:262px" %)((( 785 -*DataConsumer Scheme 786 -)))|(% style="width:369px" %)dataConsumerSchemeAgencyId: dataConsumerSchemeId(version)|(% style="width:1262px" %)SDMX:DATA_CONSUMERS(1.0) 787 -|(% style="width:262px" %)Data Consumer|(% style="width:369px" %)dataConsumerSchemeAgencyId: dataConsumerSchemeId(version) dataConsumerId|(% style="width:1262px" %)SDMX:DATA_CONSUMERS(1.0).CONSUMER_1 788 -|(% style="width:262px" %)((( 789 -*Metadata Structure 790 -)))|(% style="width:369px" %)MSDAgencyId:MSDId(version)|(% style="width:1262px" %)IMF:SDDS_MSD(1.0) 791 -|(% style="width:262px" %)MetadataTarget|(% style="width:369px" %)((( 816 +Unit Scheme 817 +)))|organisationUnitSchemeAgencyId: organisationUnitSchemeId(version)|ECB:ORGANISATIONS(1.0) 818 +|Organisation Unit|organisationUnitSchemeAgencyId: organisationUnitSchemeId(version). organisationUnitId|ECB:ORGANISATIONS(1.0).1F 819 +|*AgencyScheme|agencySchemeAgencyId: agencySchemeId(version)|ECB:AGENCIES(1.0) 820 + 821 + 822 + 823 +|Agency|agencySchemeAgencyId: agencySchemeId(version). agencyId|ECB:AGENCY(1.0).AA 824 +|((( 825 +*DataProvider 826 + 827 +Scheme 828 +)))|dataProviderSchemeAgencyId: dataProviderSchemeId(version)|SDMX:DATA_PROVIDERS(1.0) 829 +|DataProvider|dataProviderSchemeAgencyId: dataProviderSchemeId(version) dataProviderId|SDMX:DATA_PROVIDERS(1.0).PROVIDER_1 830 +|((( 831 +*DataConsumer 832 + 833 +Scheme 834 +)))|dataConsumerSchemeAgencyId: dataConsumerSchemeId(version)|SDMX:DATA_CONSUMERS(1.0) 835 +|Data Consumer|dataConsumerSchemeAgencyId: dataConsumerSchemeId(version) dataConsumerId|SDMX:DATA_CONSUMERS(1.0).CONSUMER_1 836 +|((( 837 +*Metadata 838 + 839 +Structure 840 +)))|MSDAgencyId:MSDId(version)|IMF:SDDS_MSD(1.0) 841 +|MetadataTarget|((( 792 792 MSDAgencyId: 843 + 793 793 MSDId(version).metadataTargetId 794 -)))| (% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY795 -|( % style="width:262px" %)(((845 +)))|IMF:SDDS_MSD(1.0).AGENCY 846 +|((( 796 796 Dimension 848 + 797 797 DescriptorValues 850 + 798 798 Target 799 -)))|( % style="width:369px" %)(((852 +)))|((( 800 800 MSDAgencyId: MSDId(version). 854 + 801 801 metadataTargetId.keyDescriptorValueTargetId 802 -)))|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY.KEY 803 -|(% style="width:262px" %)Identifiable Object Target|(% style="width:369px" %)((( 804 -MSDAgencyId: MSDId(version).metadataTargetId.identifiableObjectTargetId 805 -)))|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY.STR-OBJECT 806 -|(% style="width:262px" %)DataSetTarget|(% style="width:369px" %)((( 856 +)))|IMF:SDDS_MSD(1.0).AGENCY.KEY 857 +|Identifiable ObjectTarget|((( 807 807 MSDAgencyId: 808 -MSDId(version).metadataTargetId.dataSetTargetId 809 -)))|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY.D1101 810 -|(% style="width:262px" %)PeportPeriod Target|(% style="width:369px" %)((( 811 -MSDAgencyId: MSDId(version).metadataTargetId.reportPeriodTargetId 812 -)))|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY.REP_PER 813 813 814 -|(% style="width:251px" %)((( 860 +MSDId(version).metadataTargetId.identifiable 861 + 862 +ObjectTargetId 863 +)))|IMF:SDDS_MSD(1.0).AGENCY.STR-OBJECT 864 +|DataSetTarget|((( 865 +MSDAgencyId: 866 + 867 +MSDId(version).metadataTargetId.dataSet 868 + 869 +TargetId 870 +)))|IMF:SDDS_MSD(1.0).AGENCY.D1101 871 +|PeportPeriod Target|((( 872 +MSDAgencyId: 873 + 874 +MSDId(version).metadataTargetId.reportPeriod 875 + 876 +TargetId 877 +)))|IMF:SDDS_MSD(1.0).AGENCY.REP_PER 878 + 879 + 880 + 881 +|((( 815 815 ReportStructure 816 816 817 817 818 -)))|(% style="width:442px" %)((( 819 -MSDAgencyId: MSDId(version).reportStructureId 820 -)))|(% style="width:1178px" %)IMF:SDDS_MSD(1.0).AGENCY_REPORT 821 -|(% style="width:251px" %)((( 885 +)))|((( 886 +MSDAgencyId: 887 + 888 +MSDId(version).reportStructureId 889 +)))|IMF:SDDS_MSD(1.0).AGENCY_REPORT 890 +|((( 822 822 Metadata 823 823 824 824 Attribute 825 -)))|(% style="width:442px" %)((( 826 -MSDAgencyId: MSDId(version).reportStructureId.metadataattri buteID 827 -)))|(% style="width:1178px" %)IMF:SDDS_MSD(1.0).AGENCY_REPORT.COMPILATION 828 -|(% style="width:251px" %)*Dataflow|(% style="width:442px" %)dataflowAgencyId: dataflowId(version)|(% style="width:1178px" %)TFFS:CRED_EXT_DEBT(1.0) 829 -|(% style="width:251px" %)*Provision Agreement|(% style="width:442px" %)((( 894 +)))|((( 895 +MSDAgencyId: 896 + 897 +MSDId(version).reportStructureId.metadataattri buteID 898 +)))|IMF:SDDS_MSD(1.0).AGENCY_REPORT.COMPILATION 899 +|*Dataflow|dataflowAgencyId: dataflowId(version)|TFFS:CRED_EXT_DEBT(1.0) 900 +|*Provision Agreement|((( 830 830 provisionAgreementAgencyId:provisionAgreem entId(version) 831 -)))|(% style="width:1178px" %)((( 902 + 903 + 904 +)))|((( 832 832 TFFS:CRED_EXT_DEBT_AB(1.0) 906 + 907 + 908 + 833 833 ))) 834 -|( % style="width:251px" %)(((910 +|((( 835 835 *Content 836 836 837 837 Constraint 838 -)))| (% style="width:442px" %)constraintAgencyId:ContentConstraintId(versio n)|(% style="width:1178px" %)TFFS:CREDITOR_DATA_CONTENT(1.0)839 -|( % style="width:251px" %)(((914 +)))|constraintAgencyId:ContentConstraintId(versio n)|TFFS:CREDITOR_DATA_CONTENT(1.0) 915 +|((( 840 840 *Attachment 841 841 842 842 Constraint 843 -)))|( % style="width:442px" %)(((919 +)))|((( 844 844 constraintAgencyId: 845 845 846 846 attachmentConstraintId(version) 847 -)))| (% style="width:1178px" %)TFFS:CREDITOR_DATA_ATTACHMENT_CONSTRAINT_ONE(1.0)848 -| (% style="width:251px" %)*Metadataflow|(% style="width:442px" %)metadataflowAgencyId: metadataflowId(version)|(% style="width:1178px" %)IMF:SDDS_FLOW(1.0)849 -| (% style="width:251px" %)*StructureSet|(%style="width:442px" %)structureSetAgencyId: structureSetId(version)|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0)850 -| (% style="width:251px" %)StructureMap|(%style="width:442px" %)structureSetAgencyId: structureSetId(version). structureMapId|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2851 -| (% style="width:251px" %)Component Map|(% style="width:442px" %)(((923 +)))|TFFS:CREDITOR_DATA_ATTACHMENT_CONSTRAINT_ONE(1.0) 924 +|*Metadataflow|metadataflowAgencyId: metadataflowId(version)|IMF:SDDS_FLOW(1.0) 925 +|*StructureSet|structureSetAgencyId: structureSetId(version)|SDMX:BOP_STRUCTURES(1.0) 926 +|StructureMap|structureSetAgencyId: structureSetId(version). structureMapId|SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2 927 +|Component Map|((( 852 852 structureSetAgencyId: structureSetId(version). 853 853 854 854 structureMapId. componentMapId 855 -)))| (% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2. REFAREA_REPCOUNTRY856 -| (% style="width:251px" %)CodelistMap|(%style="width:442px" %)structureSetAgencyId: structureSetId(version). codelistMapId|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0).CLREFAREA_CLREPCOUNTRY857 -| (% style="width:251px" %)CodeMap|(%style="width:442px" %)structureSetAgencyId: structureSetId(version).|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0).CLREFAREA_CLREPCOUNTRY. DE_GER931 +)))|SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2. REFAREA_REPCOUNTRY 932 +|CodelistMap|structureSetAgencyId: structureSetId(version). codelistMapId|SDMX:BOP_STRUCTURES(1.0).CLREFAREA_CLREPCOUNTRY 933 +|CodeMap|structureSetAgencyId: structureSetId(version).|SDMX:BOP_STRUCTURES(1.0).CLREFAREA_CLREPCOUNTRY. DE_GER 858 858 935 + 936 + 859 859 | |((( 860 860 codeListMapId. 861 861 ... ... @@ -963,6 +963,7 @@ 963 963 964 964 7**Table 3: Table of identification components for SDMX Identifiable Artefacts** 965 965 1044 + 966 966 = 7 Implementation Notes = 967 967 968 968 == 7.1 Structural Definition Metadata == ... ... @@ -983,72 +983,109 @@ 983 983 984 984 The following table lists the Maintainable Artefacts. 985 985 986 -(% style="width:640.294px" %) 987 -|(% colspan="2" rowspan="1" style="width:186px" %)**Maintainable Artefacts**|(% style="width:206px" %)**Content** 988 -|(% style="width:171px" %)**Abstract Class**|(% style="width:232px" %)**Concrete Class**|(% style="width:206px" %) 989 -|(% style="width:171px" %)Item Scheme|(% style="width:232px" %)Codelist|(% style="width:206px" %)Code 990 -|(% style="width:171px" %) |(% style="width:232px" %)Concept Scheme|(% style="width:206px" %)Concept 991 -|(% style="width:171px" %) |(% style="width:232px" %)Category Scheme|(% style="width:206px" %)Category 992 -|(% style="width:171px" %) |(% style="width:232px" %)Organisation Unit Scheme|(% style="width:206px" %)Organisation Unit 993 -|(% style="width:171px" %) |(% style="width:232px" %)Agency Scheme|(% style="width:206px" %)Agency 994 -|(% style="width:171px" %) |(% style="width:232px" %)Data Provider Scheme|(% style="width:206px" %)Data Provider 995 -|(% style="width:171px" %) |(% style="width:232px" %)Data Consumer Scheme|(% style="width:206px" %)Data Consumer 996 -|(% style="width:171px" %) |(% style="width:232px" %)Reporting Taxonomy|(% style="width:206px" %)Reporting Category 997 -|(% style="width:171px" %) |(% style="width:232px" %)Transformation Scheme|(% style="width:206px" %)Transformation 998 -|(% style="width:171px" %) |(% style="width:232px" %)Custom Type Scheme|(% style="width:206px" %)Custom Type 999 -|(% style="width:171px" %) |(% style="width:232px" %)Name Personalisation Scheme|(% style="width:206px" %)Name Personalisation 1000 -|(% style="width:171px" %) |(% style="width:232px" %)Vtl Mapping Scheme|(% style="width:206px" %)Vtl Codelist Mapping 1001 -|(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)Vtl Dataflow Mapping 1002 -|(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)Vtl Concept Scheme Mapping 1003 -|(% style="width:171px" %) |(% style="width:232px" %)Ruleset Scheme|(% style="width:206px" %)Ruleset 1004 -|(% style="width:171px" %) |(% style="width:232px" %)User Defined Operator Scheme|(% style="width:206px" %)User Defined Operator 1005 -|(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)User Defined Operator 1006 -|(% style="width:171px" %)Structure|(% style="width:232px" %)Data Structure Definition|(% style="width:206px" %)((( 1065 +|(% colspan="4" %)**Maintainable Artefacts**|(% colspan="2" %)**Content**| 1066 +|(% colspan="2" %)**Abstract Class**|(% colspan="2" %)**Concrete Class**|(% colspan="2" %) | 1067 +|(% colspan="2" %)Item Scheme|(% colspan="2" %)Codelist|(% colspan="2" %)Code| 1068 +|(% colspan="2" %) |(% colspan="2" %)Concept Scheme|(% colspan="2" %)Concept| 1069 +|(% colspan="2" %) |(% colspan="2" %)Category Scheme|(% colspan="2" %)Category| 1070 +|(% colspan="2" %) |(% colspan="2" %)Organisation Unit Scheme|(% colspan="2" %)Organisation Unit| 1071 +|(% colspan="2" %) |(% colspan="2" %)Agency Scheme|(% colspan="2" %)Agency| 1072 +|(% colspan="2" %) |(% colspan="2" %)Data Provider Scheme|(% colspan="2" %)Data Provider| 1073 +|(% colspan="2" %) |(% colspan="2" %)Data Consumer Scheme|(% colspan="2" %)Data Consumer| 1074 +|(% colspan="2" %) |(% colspan="2" %)Reporting Taxonomy|(% colspan="2" %)Reporting Category| 1075 +|(% colspan="2" %) |(% colspan="2" %)Transformation Scheme|(% colspan="2" %)Transformation| 1076 +|(% colspan="2" %) |(% colspan="2" %)Custom Type Scheme|(% colspan="2" %)Custom Type| 1077 +| |(% colspan="4" %)**Maintainable Artefacts**|(% colspan="2" %)**Content** 1078 +| |(% colspan="2" %)**Abstract Class**|(% colspan="2" %)**Concrete Class**|(% colspan="2" %) 1079 +| |(% colspan="2" %) |(% colspan="2" %)Name Personalisation Scheme|(% colspan="2" %)Name Personalisation 1080 +| |(% colspan="2" %) |(% colspan="2" %)Vtl Mapping Scheme|(% colspan="2" %)Vtl Codelist Mapping 1081 +| |(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)Vtl Concept Mapping 1082 +| |(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)Vtl Dataflow Mapping 1083 +| |(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)((( 1084 +Vtl Concept Scheme 1085 + 1086 +Mapping 1087 +))) 1088 +| |(% colspan="2" %) |(% colspan="2" %)Ruleset Scheme|(% colspan="2" %)Ruleset 1089 +| |(% colspan="2" %) |(% colspan="2" %)User Defined Operator Scheme|(% colspan="2" %)User Defined Operator 1090 +| |(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %) 1091 +| |(% colspan="2" %)Structure|(% colspan="2" %)Data Structure Definition|(% colspan="2" %)((( 1007 1007 Dimension Descriptor 1093 + 1008 1008 Group Dimension 1095 + 1009 1009 Descriptor 1097 + 1010 1010 Dimension 1099 + 1011 1011 Measure Dimension 1101 + 1012 1012 Time Dimension 1103 + 1013 1013 Attribute Descriptor 1105 + 1014 1014 Data Attribute 1107 + 1015 1015 Measure Descriptor 1109 + 1016 1016 Primary Measure 1017 1017 ))) 1018 -|(% style="width:171px" %) |(% style="width:232px" %)Metadata Structure Definition|(% style="width:206px" %)((( 1019 -Metadata Target, Dimension Descriptor 1112 +| |(% colspan="2" %) |(% colspan="2" %)Metadata Structure Definition|(% colspan="2" %)((( 1113 +Metadata Target, 1114 + 1115 +Dimension Descriptor 1116 + 1020 1020 Values Target Identifiable 1118 + 1021 1021 Object Target 1120 + 1022 1022 Report Period Target 1122 + 1023 1023 Data SetTarget 1124 + 1024 1024 Report Structure 1126 + 1025 1025 Metadata Attribute 1026 1026 ))) 1027 -|(% style="width:171px" %)Structure Usage|(%style="width:232px" %)Dataflow Definition|(%style="width:206px" %)1028 -|(% style="width:171px" %) |(%style="width:232px" %)Metadataflow Definition|(%style="width:206px" %)1029 -|(% style="width:171px" %)None|(%style="width:232px" %)Process|(%style="width:206px" %)Process Step1030 -|(% style="width:171px" %)None|(%style="width:232px" %)Structure Set|(%style="width:206px" %)(((1129 +| |(% colspan="2" %)Structure Usage|(% colspan="2" %)Dataflow Definition|(% colspan="2" %) 1130 +| |(% colspan="2" %) |(% colspan="2" %)Metadataflow Definition|(% colspan="2" %) 1131 +| |(% colspan="2" %)None|(% colspan="2" %)Process|(% colspan="2" %)Process Step 1132 +| |(% colspan="2" %)None|(% colspan="2" %)Structure Set|(% colspan="2" %)((( 1031 1031 Component Map 1134 + 1032 1032 Concept Scheme Map 1136 + 1033 1033 Codelist Map 1138 + 1034 1034 Category Scheme Map 1140 + 1035 1035 Reporting Taxonomy Map 1142 + 1036 1036 Organisation Scheme Map 1144 + 1037 1037 Concept Map 1146 + 1038 1038 Code Map 1148 + 1039 1039 Category Map 1150 + 1040 1040 Organisation Map 1152 + 1041 1041 Reporting Category Map 1154 + 1042 1042 Hybrid Codelist Map 1156 + 1043 1043 Hybrid Code Map 1044 1044 ))) 1045 -|(% style="width:171px" %)None|(%style="width:232px" %)Provision Agreement|(%style="width:206px" %)1046 -|(% style="width:171px" %)None|(%style="width:232px" %)Hierarchical Codelist|(%style="width:206px" %)(((1159 +| |(% colspan="2" %)None|(% colspan="2" %)Provision Agreement|(% colspan="2" %) 1160 +| |(% colspan="2" %)None|(% colspan="2" %)Hierarchical Codelist|(% colspan="2" %)((( 1047 1047 Hierarchy 1162 + 1048 1048 Hierarchical Code 1049 1049 ))) 1165 +| | | | | | | 1050 1050 1051 -**able 4: Table of Maintainable Artefacts for Structural Definition Metadata** 1167 +**Table 4: Table of Maintainable Artefacts for Structural Definition Metadata** 1052 1052 1053 1053 === 7.1.2 Item Scheme, Structure === 1054 1054 ... ... @@ -1055,7 +1055,10 @@ 1055 1055 The artefacts included in the structural definitions are: 1056 1056 1057 1057 * All types of Item Scheme (Codelist, Concept Scheme, Category Scheme, Organisation Scheme - Agency Scheme, Data Provider Scheme, Data Consumer Scheme, Organisation Unit Scheme) 1058 -* All types of Structure (Data Structure Definition, Metadata Structure Definition) 1174 +* All types of Structure (Data Structure Definition, Metadata Structure 1175 + 1176 +Definition) 1177 + 1059 1059 * All types of Structure Usage (Dataflow Definition, Metadataflow Definition) 1060 1060 1061 1061 === 7.1.3 Structure Usage === ... ... @@ -1074,8 +1074,6 @@ 1074 1074 1075 1075 ==== 7.1.3.3 Structure Usage Model ==== 1076 1076 1077 -[[image:1747829078194-749.png]] 1078 - 1079 1079 **Figure 10: SDMX-IM of links from Structure Usage to Category** 1080 1080 1081 1081 In addition to the maintenance of the Dataflow Definition and the Metadataflow Definition the following links must be maintained in the registry: ... ... @@ -1102,10 +1102,10 @@ 1102 1102 1103 1103 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. 1104 1104 1105 -[[image:1747829109466-595.png]] 1106 1106 1107 1107 **Figure 11: SDMX-IM of the Data Provider** 1108 1108 1225 + 1109 1109 Note that the Data Provider does not inherit the hierarchy association. The diagram below shows a logical schematic of the data model classes required to maintain provision agreements 1110 1110 1111 1111 [[image:1747824123019-181.jpeg]] ... ... @@ -1114,10 +1114,8 @@ 1114 1114 1115 1115 The diagram below is a logical representation of the data required in order to maintain Provision Agreements. 1116 1116 1117 -[[image:1747829139951-378.png]] 1118 1118 1119 -(% class="wikigeneratedid" id="HFigure13:LogicalclassdiagramoftheinformationcontainedintheProvisionAgreement" %) 1120 -**Figure 13: Logical class diagram of the information contained in the Provision Agreement** 1235 +==== Figure 13: Logical class diagram of the information contained in the Provision Agreement ==== 1121 1121 1122 1122 A Provision Agreement is structural metadata. Each Provision Agreement must reference a Data Provider and a Dataflow or Metadataflow Definition. The Data Provider and the Dataflow/Metadataflow Definition must exist already in order to set up a Provision Agreement. 1123 1123 ... ... @@ -1145,12 +1145,13 @@ 1145 1145 1146 1146 === 7.3.3 Data and Metadata Constraints: Model === 1147 1147 1148 -[[image:1747829204737-370.png]] 1149 1149 1150 -**Figure 15: Logical class diagram showing inheritance between and reference to constrainable artifacts** 1151 1151 1152 - The class diagramaboveshows that DataProvider, DataflowDefinition, MetadataflowDefinition, ProvisionAgreement,DataStructureDefinition, MetadataStructureDefinition, SimpleDatasource and QueryDatasourceare all concrete sub-classes of ConstrainableArtefactandcan thereforehave Constraints specified. Note that the actual Constraint as submitted is associatedtothe reference classes which inherit from ConstrainableRef:theseare usedto refer to the classes to whichthe Constraintapplies.1265 +==== Figure 15: Logical class diagram showing inheritance between and reference to constrainable artifacts ==== 1153 1153 1267 +The class diagram above shows that DataProvider, DataflowDefinition, MetadataflowDefinition, ProvisionAgreement, DataStructureDefinition, MetadataStructureDefinition, SimpleDatasource and QueryDatasource are all concrete sub-classes of ConstrainableArtefact and can therefore have Constraints specified. Note that the actual Constraint as submitted is associated to the reference classes which inherit from ConstrainableRef: these are used to refer to the classes to which the Constraint applies. 1268 + 1269 + 1154 1154 The content of the Constraint can be found in the SDMX Information Model document. 1155 1155 1156 1156 == 7.4 Data and Metadata Registration == ... ... @@ -1171,7 +1171,7 @@ 1171 1171 1172 1172 [[image:1747824123025-411.jpeg]] 1173 1173 1174 -**Figure 16: Schematic of the Objects Concerned with Registration** 1290 + **Figure 16: Schematic of the Objects Concerned with Registration** 1175 1175 1176 1176 ==== 7.4.2.2 Registration Request Model ==== 1177 1177 ... ... @@ -1185,14 +1185,11 @@ 1185 1185 1186 1186 The Registration has an action attribute which takes one of the following values: 1187 1187 1188 -(% style="width:970.294px" %) 1189 -|(% style="width:212px" %)**Action Attribute Value**|(% style="width:756px" %)**Behaviour** 1190 -|(% style="width:212px" %)Append|(% style="width:756px" %)Add this Registration to the registry 1191 -|(% style="width:212px" %)Replace|(% style="width:756px" %)Replace the existing Registration with identified by the id in the Registration of the Submit Registration Request 1192 -|(% style="width:212px" %)Delete|(% style="width:756px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request 1304 +|**Action Attribute Value**|**Behaviour** 1305 +|Append|Add this Registration to the registry 1306 +|Replace|Replace the existing Registration with identified by the id in the Registration of the Submit Registration Request 1307 +|Delete|Delete the existing Registration identified by the id in the Registration of the Submit Registration Request 1193 1193 1194 -[[image:1747829290890-122.png]] 1195 - 1196 1196 **Figure 17: Logical Class Diagram of Registration of Data and Metadata** 1197 1197 1198 1198 The Query Datasource is an abstract class that represents a data source which can understand an SDMX-ML query (SOAPDatasource) or RESTful query ... ... @@ -1207,19 +1207,25 @@ 1207 1207 1208 1208 Information in the data or metadata set is extracted and placed in one or more Content Constraints (see the Constraints 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 Provision Agreement as shown in the table below. 1209 1209 1210 -|(% style="width:185px" %)**Indexing Required**|(% style="width:1686px" %)**Registration Process Activity** 1211 -|(% style="width:185px" %)indexTimeSeries|(% style="width:1686px" %)Extract all the series keys and create a KeySet(s) Constraint. 1212 -|(% style="width:185px" %)indexDataSet|(% style="width:1686px" %)((( 1213 -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. 1323 +|**Indexing Required**|**Registration Process Activity** 1324 +|indexTimeSeries|Extract all the series keys and create a KeySet(s) Constraint. 1325 +|indexDataSet|((( 1326 +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 1327 + 1328 +Regions containing Member Selections of Dimension Components of the Constraints model in the SDMX-IM, and the associated Selection Value. 1214 1214 ))) 1215 -| (% style="width:185px" %)indexReportingPeriod|(% style="width:1686px" %)(((1330 +|indexReportingPeriod|((( 1216 1216 This applies only to a registered dataset. 1332 + 1217 1217 Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint. 1218 1218 ))) 1219 -| (% style="width:185px" %)indexAttributes|(% style="width:1686px" %)(((1335 +|indexAttributes|((( 1220 1220 **Data Set** 1337 + 1221 1221 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 1339 + 1222 1222 **Metadata Set** 1341 + 1223 1223 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. 1224 1224 ))) 1225 1225 ... ... @@ -1229,13 +1229,14 @@ 1229 1229 1230 1230 === 7.4.3 Registration Response === 1231 1231 1232 -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 Submit Registration class has a status field which is either set to “Success”, “Warning” or “Failure”.1351 +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 Submit Registration class has a status field which is either set to 1233 1233 1353 +“Success”, “Warning” or “Failure”. 1354 + 1234 1234 If the registration has succeeded, a Registration will be returned - this holds the Registry-allocated Id of the newly registered Datasource plus a Datasource holding the URL to access the dataset, metadataset, or query service. 1235 1235 1236 1236 The Registration Response returns set of registration status (one for each registration submitted) in terms of a Status Message (this is common to all Registry Responses) that indicates success or failure. In the event of registration failure, a set of Message Text are returned, giving the error messages that occurred during registration. It is entirely possible when registering a batch of datasets, that the response will contain some successful and some failed statuses. The logical model for the Registration Response is shown below: 1237 1237 1238 -[[image:1747829477882-750.png]] 1239 1239 1240 1240 **Figure 18: Logical class diagram showing the registration response** 1241 1241 ... ... @@ -1245,12 +1245,15 @@ 1245 1245 1246 1246 A user can submit a subscription in the registry that defines which events are of interest, and either an email and/or an HTTP address to which a notification of qualifying events will be delivered. The subscription will be identified in the registry by a URN which is returned to the user when the subscription is created. If the user wants to delete the subscription at a later point, the subscription URN is used as identification. Subscriptions have a validity period expressed as a date range (startDate, endDate) and the registry may delete any expired subscriptions, and will notify the subscriber on expiry. 1247 1247 1248 -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”.1368 +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 1249 1249 1250 - === 7.5.1SubscriptionLogical Class Diagram ===1370 +“notification”. 1251 1251 1252 - [[image:1747829554603-150.png]]1372 + 7.5.1Subscription Logical Class Diagram 1253 1253 1374 + 1375 +[[image:1747824123028-257.png]] 1376 + 1254 1254 **Figure 19: Logical Class Diagram of the Subscription** 1255 1255 1256 1256 === 7.5.2 Subscription Information === ... ... @@ -1257,58 +1257,73 @@ 1257 1257 1258 1258 Regardless of the type of registry/repository events being observed, a subscription always contains: 1259 1259 1260 -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. 1261 -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. 1262 -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. 1263 -1. A selector which specifies which type of events are of interest. The set of event types is: 1383 +~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. 1264 1264 1265 -|(% style="width:327px" %)**Event Type**|(% style="width:1545px" %)**Comment** 1266 -|(% style="width:327px" %)STRUCTURAL_REPOSITORY_EVENTS|(% style="width:1545px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository. 1267 -|(% style="width:327px" %)DATA_REGISTRATION_EVENTS|(% style="width:1545px" %)Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database. 1268 -|(% style="width:327px" %)METADATA_REGISTRATION_EVENTS|(% style="width:1545px" %)Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database. 1269 -|(% style="width:327px" %)ALL_EVENTS|(% style="width:1545px" %)All events of the specified EventType 1385 +2. 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. 1270 1270 1387 +3. 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. 1388 + 1389 +4. A selector which specifies which type of events are of interest. The set of event types is: 1390 + 1391 +|**Event Type**|**Comment** 1392 +|STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository. 1393 +|DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database. 1394 +|METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database. 1395 +|ALL_EVENTS|All events of the specified EventType 1396 + 1271 1271 === 7.5.3 Wildcard Facility === 1272 1272 1273 1273 Subscription notification supports wildcarded identifier components URNs, which are identiiers which have some or all of their component parts replaced by the wildcard character `%`. Identifier components comprise: 1274 1274 1275 -* agencyID 1276 -* id 1277 -* version 1401 + agencyID 1278 1278 1403 + id 1404 + 1405 + version 1406 + 1279 1279 Examples of wildcarded identifier components for an identified object type of Codelist are shown below. 1280 1280 1281 -//AgencyID = % 1409 +AgencyID = % 1410 + 1282 1282 Id = % 1283 -Version = %// 1284 1284 1413 +Version = % 1414 + 1285 1285 This subscribes to all Codelists of all versions for all agencies. 1286 1286 1287 -//AgencyID = AGENCY1 1417 +AgencyID = AGENCY1 1418 + 1288 1288 Id = CODELIST1 1289 -Version = %// 1290 1290 1421 +Version = % 1422 + 1291 1291 This subscribes to all versions of Codelist CODELIST1 maintained by the agency 1292 1292 1293 -//AGENCY1 1425 +AGENCY1 1426 + 1294 1294 AgencyID = AGENCY1 1428 + 1295 1295 Id = % 1296 -Version = %// 1297 1297 1431 +Version = % 1432 + 1298 1298 This subscribes to all versions of all Codelist objects maintained by the agency 1299 1299 1300 -//AGENCY1 1435 +AGENCY1 1436 + 1301 1301 AgencyID = % 1438 + 1302 1302 Id = CODELIST1 1303 -Version = %// 1304 1304 1441 +Version = % 1442 + 1305 1305 This subscribes to all versions of Codelist CODELIST1 maintained by the agency 1306 1306 1307 - //AGENCY1//1445 +AGENCY1 1308 1308 1309 1309 Note that if the subscription is to the latest version then this can be achieved by the * character 1310 1310 1311 - //i.e. Version = *//1449 +i.e. Version = * 1312 1312 1313 1313 Note that a subscription using the URN mechanism cannot use wildcard characters. 1314 1314 ... ... @@ -1320,15 +1320,16 @@ 1320 1320 1321 1321 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: 1322 1322 1323 -|(% style="width:405px" %)**Selector**|(% style="width:1467px" %)**Comment** 1324 -|(% style="width:405px" %)DataProvider|(% style="width:1467px" %)Any datasets or metadata sets registered by the specified data provider will activate the notification. 1325 -|(% style="width:405px" %)ProvisionAgreement|(% style="width:1467px" %)Any datasets or metadata sets registered for the provision agreement will activate the notification. 1326 -|(% style="width:405px" %)Dataflow (&Metadataflow)|(% style="width:1467px" %)Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification. 1327 -|(% style="width:405px" %)DataStructureDefinition & MetadataStructureDefinition|(% style="width:1467px" %)Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will 1328 -|(% style="width:405px" %)**Selector**|(% style="width:1467px" %)**Comment** 1329 -|(% style="width:405px" %) |(% style="width:1467px" %)activate the notification. 1330 -|(% style="width:405px" %)Category|(% style="width:1467px" %)Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category. 1331 1331 1462 +|**Selector**|**Comment** 1463 +|DataProvider|Any datasets or metadata sets registered by the specified data provider will activate the notification. 1464 +|ProvisionAgreement|Any datasets or metadata sets registered for the provision agreement will activate the notification. 1465 +|Dataflow (&Metadataflow)|Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification. 1466 +|DataStructureDefinition & MetadataStructureDefinition|Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will 1467 +|**Selector**|**Comment** 1468 +| |activate the notification. 1469 +|Category|Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category. 1470 + 1332 1332 The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration. 1333 1333 1334 1334 == 7.6 Notification == ... ... @@ -1335,10 +1335,8 @@ 1335 1335 1336 1336 === 7.6.1 Logical Class Diagram === 1337 1337 1338 -[[image:1747829675568-610.png]] 1339 1339 1340 -(% class="wikigeneratedid" id="HFigure20:LogicalClassDiagramoftheNotification" %) 1341 -**Figure 20: Logical Class Diagram of the Notification** 1478 +==== Figure 20: Logical Class Diagram of the Notification ==== 1342 1342 1343 1343 A notification is an XML document that is sent to a user via email or http POST whenever a subscription is activated. It is an asynchronous one-way message. 1344 1344 ... ... @@ -1358,3 +1358,5 @@ 1358 1358 === 7.6.3 Registration Event Component === 1359 1359 1360 1360 The notification will contain the Registration. 1498 + 1499 +
- 1747829078194-749.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -40.4 KB - Content
- 1747829109466-595.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -30.4 KB - Content
- 1747829139951-378.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -21.1 KB - Content
- 1747829204737-370.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -55.8 KB - Content
- 1747829290890-122.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -41.4 KB - Content
- 1747829477882-750.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -24.6 KB - Content
- 1747829554603-150.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -99.1 KB - Content
- 1747829675568-610.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -31.1 KB - Content