Last modified by Helena on 2025/09/10 11:19
Summary
-
Page properties (1 modified, 0 added, 0 removed)
-
Attachments (0 modified, 8 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -4,10 +4,11 @@ 4 4 5 5 **Revision History** 6 6 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 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 11 11 12 12 **Corrigendum** 13 13 ... ... @@ -288,27 +288,22 @@ 288 288 * that a queryable data source exists - this would necessitate the registration service querying the service to determine its existence 289 289 * that a simple data source exists (i.e. a file accessible at a URL) 290 290 * 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 291 -* that the valid representations of the concepts to which these components382correspond conform to the definition in the Data Structure Definition or Metadata Structure Definition292 +* 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 292 292 293 - 3The Registration has an action attribute which takes one of the following values:294 +The Registration has an action attribute which takes one of the following values: 294 294 295 -|(% style="width:249px" %)((( 296 -**Action Attribute Value** 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 296 +|(% style="width:219px" %)**Action Attribute Value**|(% style="width:1652px" %)**Behaviour** 297 +|(% style="width:219px" %)Append|(% style="width:1652px" %)Add this registration to the registry 298 +|(% style="width:219px" %)Replace|(% style="width:1652px" %)Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request 299 +|(% style="width:219px" %)Delete|(% style="width:1652px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request 301 301 302 302 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: 303 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 -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 - 303 +|(% style="width:228px" %)**Boolean Attribute**|(% style="width:1644px" %)**Behaviour if Value is “true”** 304 +|(% style="width:228px" %)indexTimeSeries|(% style="width:1644px" %)A compliant indexing application must index all the time series keys (for a Dataset registration) or metadata target values (for a Metadata Set registration) 305 +|(% style="width:228px" %)indexDataSet|(% style="width:1644px" %)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. 309 309 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 310 -))) 311 -|indexReportingPeriod|A compliant indexing application must index the time period range(s) for which data are present in the Dataset or Metadata Set 307 +|(% style="width:228px" %)indexReportingPeriod|(% style="width:1644px" %)A compliant indexing application must index the time period range(s) for which data are present in the Dataset or Metadata Set 312 312 313 313 === 5.2.5 Data and Reference Metadata Discovery === 314 314 ... ... @@ -340,8 +340,8 @@ 340 340 341 341 The following table defines the behaviour of the SDMX Registry for the various Registry Interface messages. 342 342 343 -|(% style="width:2 44px" %)**Interface**|**Behaviour**344 -|(% style="width:2 44px" %)All|(((339 +|(% style="width:227px" %)**Interface**|(% style="width:1644px" %)**Behaviour** 340 +|(% style="width:227px" %)All|(% style="width:1644px" %)((( 345 345 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: 346 346 347 347 * Name – this applies to the Maintainable object and its contained elements, such a Code in a Code list. ... ... @@ -355,7 +355,6 @@ 355 355 * isExternalReference 356 356 357 357 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 - 359 359 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: 360 360 361 361 а) Not have the final attribute set to “true” ... ... @@ -362,12 +362,11 @@ 362 362 b) Not be referenced from any other object in the Registry. 363 363 364 364 4) The version rules in the SDMX Schema documentation MUST be obeyed. 365 - 366 366 5) The specific rules for the elements and attributes documented in the SDMX Schema MUST be obeyed. 367 367 ))) 368 -|(% style="width:2 44px" %)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:2 44px" %)SubmitProvisioningRequest|No additional behaviour.370 -|(% style="width:2 44px" %)Submit Registration Request|(((362 +|(% style="width:227px" %)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. 363 +|(% style="width:227px" %)SubmitProvisioningRequest|(% style="width:1644px" %)No additional behaviour. 364 +|(% style="width:227px" %)Submit Registration Request|(% style="width:1644px" %)((( 371 371 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. 372 372 For a queryable datasource the Registry MAY validate that the source exists and can accept an SDMX-ML data query. 373 373 ))) ... ... @@ -454,7 +454,8 @@ 454 454 455 455 [[image:1747824123012-527.jpeg]] 456 456 457 -==== Figure 7: Example of Hierarchic Structure of Agencies ==== 451 +* 452 +** Figure 7: Example of Hierarchic Structure of Agencies 458 458 459 459 The following organizations maintain an Agency Scheme. 460 460 ... ... @@ -471,7 +471,6 @@ 471 471 472 472 [[image:1747824123013-196.jpeg||height="309" width="446"]] 473 473 474 -(% class="wikigeneratedid" id="HFigure8:ExampleShowingUseofAgencyIdentifiers" %) 475 475 **Figure 8: Example Showing Use of Agency Identifiers** 476 476 477 477 Each of these maintenance agencies has an identical Code list with the Id CL_BOP. However, each is uniquely identified by means of the hierarchic agency structure. ... ... @@ -490,7 +490,7 @@ 490 490 491 491 The generic structure of the URN is as follows: 492 492 493 -SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobject-id(maintainedobject-version).*containerobject-id.object-id 487 +>SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobject-id(maintainedobject-version).*containerobject-id.object-id 494 494 495 495 ~* this can repeat and may not be present (see explanation below) 496 496 ... ... @@ -502,7 +502,7 @@ 502 502 503 503 In the explanation below the actual object that is the target of the URN is called the **//actual object//**. 504 504 505 -**SDMXPrefix:** urn:sdmx:org. 499 +**SDMXPrefix:** urn:sdmx:org. 506 506 507 507 **SDMX-IM package name:** sdmx.infomodel.package= 508 508 ... ... @@ -681,78 +681,50 @@ 681 681 682 682 Note that for brevity the URN examples omit the prefix. All URNs have the prefix 683 683 684 -urn:sdmx.org.sdmx.infomodel.{package}.{classname}= 678 +> urn:sdmx.org.sdmx.infomodel.{package}.{classname}= 685 685 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.|((( 680 +(% style="width:1091.29px" %) 681 +|(% style="width:250px" %)**SDMX Class**|(% style="width:444px" %)**Key attribute(s)**|(% style="width:396px" %)**Example of URN** 682 +|(% 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" %)((( 689 689 IMF 690 - 691 - 692 692 Sub agency in the IMF AGENCIES 693 - 694 - 695 695 IMF.SubAgency1 696 696 ))) 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 - 687 +|(% style="width:250px" %)*ConceptScheme|(% style="width:444px" %)conceptSchemeAgencyId:conceptSchemeId(ve rsion)|(% style="width:396px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0) 688 +|(% style="width:250px" %)Concept|(% style="width:444px" %)conceptSchemeAgencyId: 689 +conceptSchemeId(version).conceptId|(% style="width:396px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0).FREQ 690 +|(% style="width:250px" %)*Codelist|(% style="width:444px" %)codeListAgencyId:codeListId(version)|(% style="width:396px" %)SDMX:CL_FREQ(1.0) 691 +|(% style="width:250px" %)Code|(% style="width:444px" %)codeListAgencyId:codelistId(version).codeId|(% style="width:396px" %)SDMX:CL_FREQ(1.0).Q 692 +|(% style="width:250px" %)((( 693 +*Hierarchical Codelist 694 +)))|(% style="width:444px" %)hierachicalCodelistAgencyId: hierarchicalCodelistId(version)|(% style="width:396px" %)((( 695 +UNESCO:CL_EXP_SOURCE(1.0(% style="background-color:transparent" %)) 708 708 ))) 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|((( 697 +|(% style="width:250px" %)Hierarchy|(% style="width:444px" %)((( 722 722 hierachicalcodeListAgencyId: 723 - 724 724 hierarchicalcodelistId(version).Hierarchy 725 -)))|UNESCO:CL_EXP_SOURCE(1.0). H-C-GOV 726 -|Level|((( 700 +)))|(% style="width:396px" %)UNESCO:CL_EXP_SOURCE(1.0). 701 +H-C-GOV 702 +|(% style="width:250px" %)Level|(% style="width:444px" %)((( 727 727 hierachicalcodeListAgencyId: 728 - 729 729 hierarchicalcodelistId(version).Hierarchy.Level 730 -)))|((( 705 +)))|(% style="width:396px" %)((( 731 731 ESTAT:HCL_REGION(1.0).H_1.COUNTRY 732 - 733 - 734 734 ))) 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 -|((( 708 +|(% 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_CODE1 709 +|(% style="width:250px" %)*DataStructure|(% style="width:444px" %)dataStructureDefintitionAgencyId: dataStructureDefintitionId(version)|(% style="width:396px" %)TFFS:EXT_DEBT(1.0) 710 +|(% style="width:250px" %)((( 738 738 Dimension 739 - 740 740 Descriptor 741 - 742 742 Measure 743 - 744 744 Descriptor 745 - 746 746 Attribute 747 - 748 748 Descriptor 749 -)))|((( 717 +)))|(% style="width:444px" %)((( 750 750 dataStructureDefinitionAgencyId: dataStructureDefinitionId(version). 751 - 752 752 componentListId 753 - 754 754 where the componentListId is the name of the class (there is only one occurrence of each in the Data Structure Definition) 755 -)))|((( 721 +)))|(% style="width:396px" %)((( 756 756 TFFS:EXT_DEBT(1.0).DimensionDescriptor 757 757 758 758 TFFS:EXT_DEBT(1.0).MeasureDescriptor ... ... @@ -759,181 +759,124 @@ 759 759 760 760 TFFS:EXT_DEBT(1.0).AttributeDescriptor 761 761 ))) 762 -|((( 728 +|(% style="width:250px" %)((( 763 763 GroupDimension 764 - 765 765 Descriptor 766 -)))|((( 731 +)))|(% style="width:444px" %)((( 767 767 dataStructureDefinitionAgencyId: dataStructureDefinitionId(version). 768 - 769 769 groupDimensionDescriptorId 770 -)))|TFFS:EXT_DEBT(1.0).SIBLING 771 -|Dimension|((( 734 +)))|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).SIBLING 735 +|(% style="width:250px" %)Dimension|(% style="width:444px" %)((( 772 772 dataStructureDefinitionAgencyId: dataStructureDefinition (version). 773 - 774 774 dimensionId 775 -)))|TFFS:EXT_DEBT(1.0).FREQ 776 -|TimeDimension|((( 738 +)))|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).FREQ 739 +|(% style="width:250px" %)TimeDimension|(% style="width:444px" %)((( 777 777 dataStructureDefinitionAgencyId: dataStructureDefinition (version). 778 - 779 779 timeDimensionId 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|((( 742 +)))|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).TIME_PERIOD 743 +|(% style="width:250px" %)Measure Dimension|(% style="width:444px" %)dataStructureDefinitionAgencyId: dataStructureDefinition (version). 744 +measureDimensionId|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).STOCK_FLOW 745 +|(% style="width:250px" %)DataAttrribute|(% style="width:444px" %)dataStructureDefinitionAgencyId: dataStructureDefinition (version). dataAttributeId|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).OBS_STATUS 746 +|(% style="width:250px" %)PrimaryMeasure|(% style="width:444px" %)((( 788 788 dataStructureDefinitionAgencyId: dataStructureDefinition (version). 789 - 790 790 primaryMeasureId 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.|((( 749 +)))|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).OBS_VALUE 750 +|(% style="width:250px" %)((( 751 +*Category Scheme 752 +)))|(% style="width:444px" %)categorySchemeAgencyId: 753 +categorySchemeId(version)|(% style="width:396px" %)IMF:SDDS(1.0) 754 +|(% style="width:250px" %)Category|(% style="width:444px" %)categorySchemeAgencyId: 755 +categorySchemeId(version). 756 +categoryId.categoryId categoryId.categoryId etc.|(% style="width:396px" %)((( 798 798 IMF:SDDS(1.0): 799 - 800 800 level_1_category.level_2_category … 801 801 ))) 802 -|((( 803 -*Reporting 804 - 805 -Taxonomy 806 -)))|reportingTaxonomyAgencyId: reportingTaxonomyId(version)| IMF:REP_1(1.0) 807 -|ReportingCategory|reportingTaxonomyAgencyId: reportingTaxonomyId(version) reportingcategoryId.reportingcategoryId|((( 760 +|(% style="width:250px" %)((( 761 +*Reporting Taxonomy 762 +)))|(% style="width:444px" %)reportingTaxonomyAgencyId: reportingTaxonomyId(version)|(% style="width:396px" %) IMF:REP_1(1.0) 763 +|(% style="width:250px" %)ReportingCategory|(% style="width:444px" %)reportingTaxonomyAgencyId: reportingTaxonomyId(version) reportingcategoryId.reportingcategoryId|(% style="width:396px" %)((( 808 808 IMF:REP_1(1.0): 809 - 810 810 level_1_repcategory.level_2_repcategory … 811 811 ))) 812 -|*Categorisation|categorisationAgencyId: categorisationId(version)|IMF:cat001(1.0) 813 -|((( 814 -*Organisation 767 +|(% style="width:250px" %)*Categorisation|(% style="width:444px" %)categorisationAgencyId: categorisationId(version)|(% style="width:396px" %)IMF:cat001(1.0) 768 +|(% style="width:250px" %)((( 769 +*Organisation Unit Scheme 770 +)))|(% style="width:444px" %)organisationUnitSchemeAgencyId: organisationUnitSchemeId(version)|(% style="width:396px" %)ECB:ORGANISATIONS(1.0) 771 +|(% style="width:250px" %)Organisation Unit|(% style="width:444px" %)organisationUnitSchemeAgencyId: organisationUnitSchemeId(version). organisationUnitId|(% style="width:396px" %)ECB:ORGANISATIONS(1.0).1F 772 +|(% style="width:250px" %)*AgencyScheme|(% style="width:444px" %)agencySchemeAgencyId: agencySchemeId(version)|(% style="width:396px" %)ECB:AGENCIES(1.0) 815 815 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|((( 774 +|(% style="width:262px" %)Agency|(% style="width:369px" %)agencySchemeAgencyId: agencySchemeId(version). agencyId|(% style="width:1262px" %)ECB:AGENCY(1.0).AA 775 +|(% style="width:262px" %)((( 776 +*DataProvider Scheme 777 +)))|(% style="width:369px" %)dataProviderSchemeAgencyId: dataProviderSchemeId(version)|(% style="width:1262px" %)SDMX:DATA_PROVIDERS(1.0) 778 +|(% style="width:262px" %)DataProvider|(% style="width:369px" %)dataProviderSchemeAgencyId: dataProviderSchemeId(version) dataProviderId|(% style="width:1262px" %)SDMX:DATA_PROVIDERS(1.0).PROVIDER_1 779 +|(% style="width:262px" %)((( 780 +*DataConsumer Scheme 781 +)))|(% style="width:369px" %)dataConsumerSchemeAgencyId: dataConsumerSchemeId(version)|(% style="width:1262px" %)SDMX:DATA_CONSUMERS(1.0) 782 +|(% style="width:262px" %)Data Consumer|(% style="width:369px" %)dataConsumerSchemeAgencyId: dataConsumerSchemeId(version) dataConsumerId|(% style="width:1262px" %)SDMX:DATA_CONSUMERS(1.0).CONSUMER_1 783 +|(% style="width:262px" %)((( 784 +*Metadata Structure 785 +)))|(% style="width:369px" %)MSDAgencyId:MSDId(version)|(% style="width:1262px" %)IMF:SDDS_MSD(1.0) 786 +|(% style="width:262px" %)MetadataTarget|(% style="width:369px" %)((( 842 842 MSDAgencyId: 843 - 844 844 MSDId(version).metadataTargetId 845 -)))|IMF:SDDS_MSD(1.0).AGENCY 846 -|((( 789 +)))|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY 790 +|(% style="width:262px" %)((( 847 847 Dimension 848 - 849 849 DescriptorValues 850 - 851 851 Target 852 -)))|((( 794 +)))|(% style="width:369px" %)((( 853 853 MSDAgencyId: MSDId(version). 854 - 855 855 metadataTargetId.keyDescriptorValueTargetId 856 -)))|IMF:SDDS_MSD(1.0).AGENCY.KEY 857 -|Identifiable ObjectTarget|((( 797 +)))|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY.KEY 798 +|(% style="width:262px" %)Identifiable Object Target|(% style="width:369px" %)((( 799 +MSDAgencyId: MSDId(version).metadataTargetId.identifiableObjectTargetId 800 +)))|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY.STR-OBJECT 801 +|(% style="width:262px" %)DataSetTarget|(% style="width:369px" %)((( 858 858 MSDAgencyId: 803 +MSDId(version).metadataTargetId.dataSetTargetId 804 +)))|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY.D1101 805 +|(% style="width:262px" %)PeportPeriod Target|(% style="width:369px" %)((( 806 +MSDAgencyId: MSDId(version).metadataTargetId.reportPeriodTargetId 807 +)))|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY.REP_PER 859 859 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 -|((( 809 +|(% style="width:251px" %)((( 882 882 ReportStructure 883 - 884 - 885 -)))|((( 886 -MSDAgencyId: 887 - 888 -MSDId(version).reportStructureId 889 -)))|IMF:SDDS_MSD(1.0).AGENCY_REPORT 890 -|((( 891 -Metadata 892 - 893 -Attribute 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|((( 811 +)))|(% style="width:442px" %)((( 812 +MSDAgencyId: MSDId(version).reportStructureId 813 +)))|(% style="width:1178px" %)IMF:SDDS_MSD(1.0).AGENCY_REPORT 814 +|(% style="width:251px" %)((( 815 +Metadata Attribute 816 +)))|(% style="width:442px" %)((( 817 +MSDAgencyId: MSDId(version).reportStructureId.metadataattri buteID 818 +)))|(% style="width:1178px" %)IMF:SDDS_MSD(1.0).AGENCY_REPORT.COMPILATION 819 +|(% style="width:251px" %)*Dataflow|(% style="width:442px" %)dataflowAgencyId: dataflowId(version)|(% style="width:1178px" %)TFFS:CRED_EXT_DEBT(1.0) 820 +|(% style="width:251px" %)*Provision Agreement|(% style="width:442px" %)((( 901 901 provisionAgreementAgencyId:provisionAgreem entId(version) 902 - 903 - 904 -)))|((( 822 +)))|(% style="width:1178px" %)((( 905 905 TFFS:CRED_EXT_DEBT_AB(1.0) 906 - 907 - 908 - 909 909 ))) 910 -|((( 911 -*Content 912 - 913 -Constraint 914 -)))|constraintAgencyId:ContentConstraintId(versio n)|TFFS:CREDITOR_DATA_CONTENT(1.0) 915 -|((( 916 -*Attachment 917 - 918 -Constraint 919 -)))|((( 825 +|(% style="width:251px" %)((( 826 +*Content Constraint 827 +)))|(% style="width:442px" %)constraintAgencyId:ContentConstraintId(versio n)|(% style="width:1178px" %)TFFS:CREDITOR_DATA_CONTENT(1.0) 828 +|(% style="width:251px" %)((( 829 +*Attachment Constraint 830 +)))|(% style="width:442px" %)((( 920 920 constraintAgencyId: 921 921 922 922 attachmentConstraintId(version) 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|((( 834 +)))|(% style="width:1178px" %)TFFS:CREDITOR_DATA_ATTACHMENT_CONSTRAINT_ONE(1.0) 835 +|(% style="width:251px" %)*Metadataflow|(% style="width:442px" %)metadataflowAgencyId: metadataflowId(version)|(% style="width:1178px" %)IMF:SDDS_FLOW(1.0) 836 +|(% style="width:251px" %)*StructureSet|(% style="width:442px" %)structureSetAgencyId: structureSetId(version)|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0) 837 +|(% style="width:251px" %)StructureMap|(% style="width:442px" %)structureSetAgencyId: structureSetId(version). structureMapId|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2 838 +|(% style="width:251px" %)Component Map|(% style="width:442px" %)((( 928 928 structureSetAgencyId: structureSetId(version). 929 929 930 930 structureMapId. componentMapId 931 -)))|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 842 +)))|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2. REFAREA_REPCOUNTRY 843 +|(% style="width:251px" %)CodelistMap|(% style="width:442px" %)structureSetAgencyId: structureSetId(version). codelistMapId|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0).CLREFAREA_CLREPCOUNTRY 844 +|(% style="width:251px" %)CodeMap|(% style="width:442px" %)structureSetAgencyId: structureSetId(version).|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0).CLREFAREA_CLREPCOUNTRY. DE_GER 934 934 935 - 936 - 937 937 | |((( 938 938 codeListMapId. 939 939 ... ... @@ -940,9 +940,7 @@ 940 940 codeMapId 941 941 )))| 942 942 |((( 943 -Category 944 - 945 -SchemeMap 852 +CategorySchemeMap 946 946 )))|structureSetAgencyId: structureSetId(version). categorySchemeMapId|SDMX:BOP_STRUCTURES(1.0).SDMX_EUROSTAT 947 947 |CategoryMap|structureSetAgencyId: structureSetId(version). categorySchemeMapId. categoryMapId|SDMX:BOP_STRUCTURES(1.0).SDMX_EUROSTAT.TOURISM_M AP 948 948 |Organisation SchemeMap|structureSetAgencyId: structureSetId(version). organisationSchemeMapId|SDMX:BOP_STRUCTURES(1.0).DATA_PROVIDER_MAP ... ... @@ -956,13 +956,10 @@ 956 956 structureSetAgencyId: structureSetId(version). conceptSchemeMapId. 957 957 958 958 conceptMapId 959 - 960 960 961 961 )))|SDMX:BOP_STRUCTURES(1.0).SDMX_OECD.COVERAGE_AVAI LABILITY 962 962 |((( 963 -Reporting 964 - 965 -TaxonomyMap 869 +ReportingTaxonomyMap 966 966 )))|structureSetAgencyId: structureSetId(version). reportingTaxonomyMapId|SDMX:BOP_STRUCTURES(1.0).TAXMAP 967 967 |((( 968 968 Reporting ... ... @@ -970,57 +970,44 @@ 970 970 CategoryMap 971 971 )))|((( 972 972 structureSetAgencyId: structureSetId(version). 973 - 974 974 reportngCategoryId 975 975 )))|SDMX:BOP_STRUCTURES(1.0).TAXMAP.TOPCAT 976 976 977 - 978 - 979 979 |((( 980 -HybridCodelist 981 - 982 -Map 983 -)))|structureSetAgencyId: structureSetId(version). hybridCodelistMapId.|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP 881 +HybridCodelistMap 882 +)))|structureSetAgencyId: structureSetId(version). 883 +hybridCodelistMapId.|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP 984 984 |HybridCodeMap|structureSetAgencyId: structureSetId(version). hybridCodelistMapId. hybridCodeMapId|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP.CO DEMAP1 985 985 |*Process|processAgencyId: processId{version]|BIS:PROCESS1(1.0) 986 986 |ProcessStep|((( 987 987 processAgencyId: processId(version). 988 - 989 989 processStepId 990 990 )))|BIS:PROCESS1(1.0).STEP1 991 991 |Transition|((( 992 992 processAgencyId: processId(version). 993 - 994 994 processStepId transitionId 995 995 )))|BIS:PROCESS1(1.0).STEP1.TRANSITION1 996 996 |Subscription|The Subscription is not itself an Identifiable Artefact and therefore it does not follow the rules for URN structure, The name of the URN is registryURN There is no pre-determined format.|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 registryURN that is returned from the registry in the subscription response message. 997 997 |((( 998 -*Transformation 999 - 1000 -Scheme 896 +*Transformation Scheme 1001 1001 )))|transformationSchemeAgencyId transformationSchemeId(version)|ECB: TRANSFORMATION_SCHEME(1.0) 1002 1002 |Transformation|((( 1003 1003 transformationSchemeAgencyId transformationSchemeId(version) 1004 - 1005 1005 transformationId 1006 1006 )))|ECB:TRANSFORMATION_SCHEME(1.0).TRANS_1 1007 1007 |CustomType Scheme|customTypeSchemeAgencyId customTypeSchemeId(version)|ECB:CUSTOM_TYPE_SCHEME(1.0) 1008 1008 1009 - 1010 - 1011 1011 |CustomType|customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|ECB: CUSTOM_TYPE_SCHEME(1.0).CUSTOM_TYPE_1 1012 1012 |((( 1013 1013 Name 1014 - 1015 1015 Personalisation 1016 - 1017 1017 Scheme 1018 1018 )))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|ECB:PSN_SCHEME(1.0) 1019 1019 |((( 1020 1020 Name 1021 - 1022 1022 Personalisation 1023 -)))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|ECB:PSN_SCHEME(1.0).PSN1234 913 +)))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) 914 +namePersonalisationId|ECB:PSN_SCHEME(1.0).PSN1234 1024 1024 |VtlMapping Scheme|vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|ECB:CLIST_MP(2.0) 1025 1025 |VtlCodelist Mapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|ECB:CLIST_MP(2.0).ABZ 1026 1026 |VtlConcept Mapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|ECB:CLIST_MP(1.0).XYA ... ... @@ -1041,7 +1041,6 @@ 1041 1041 1042 1042 7**Table 3: Table of identification components for SDMX Identifiable Artefacts** 1043 1043 1044 - 1045 1045 = 7 Implementation Notes = 1046 1046 1047 1047 == 7.1 Structural Definition Metadata == ... ... @@ -1062,109 +1062,72 @@ 1062 1062 1063 1063 The following table lists the Maintainable Artefacts. 1064 1064 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" %)((( 955 +(% style="width:640.294px" %) 956 +|(% colspan="2" rowspan="1" style="width:186px" %)**Maintainable Artefacts**|(% style="width:206px" %)**Content** 957 +|(% style="width:171px" %)**Abstract Class**|(% style="width:232px" %)**Concrete Class**|(% style="width:206px" %) 958 +|(% style="width:171px" %)Item Scheme|(% style="width:232px" %)Codelist|(% style="width:206px" %)Code 959 +|(% style="width:171px" %) |(% style="width:232px" %)Concept Scheme|(% style="width:206px" %)Concept 960 +|(% style="width:171px" %) |(% style="width:232px" %)Category Scheme|(% style="width:206px" %)Category 961 +|(% style="width:171px" %) |(% style="width:232px" %)Organisation Unit Scheme|(% style="width:206px" %)Organisation Unit 962 +|(% style="width:171px" %) |(% style="width:232px" %)Agency Scheme|(% style="width:206px" %)Agency 963 +|(% style="width:171px" %) |(% style="width:232px" %)Data Provider Scheme|(% style="width:206px" %)Data Provider 964 +|(% style="width:171px" %) |(% style="width:232px" %)Data Consumer Scheme|(% style="width:206px" %)Data Consumer 965 +|(% style="width:171px" %) |(% style="width:232px" %)Reporting Taxonomy|(% style="width:206px" %)Reporting Category 966 +|(% style="width:171px" %) |(% style="width:232px" %)Transformation Scheme|(% style="width:206px" %)Transformation 967 +|(% style="width:171px" %) |(% style="width:232px" %)Custom Type Scheme|(% style="width:206px" %)Custom Type 968 +|(% style="width:171px" %) |(% style="width:232px" %)Name Personalisation Scheme|(% style="width:206px" %)Name Personalisation 969 +|(% style="width:171px" %) |(% style="width:232px" %)Vtl Mapping Scheme|(% style="width:206px" %)Vtl Codelist Mapping 970 +|(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)Vtl Dataflow Mapping 971 +|(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)Vtl Concept Scheme Mapping 972 +|(% style="width:171px" %) |(% style="width:232px" %)Ruleset Scheme|(% style="width:206px" %)Ruleset 973 +|(% style="width:171px" %) |(% style="width:232px" %)User Defined Operator Scheme|(% style="width:206px" %)User Defined Operator 974 +|(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)User Defined Operator 975 +|(% style="width:171px" %)Structure|(% style="width:232px" %)Data Structure Definition|(% style="width:206px" %)((( 1092 1092 Dimension Descriptor 1093 - 1094 1094 Group Dimension 1095 - 1096 1096 Descriptor 1097 - 1098 1098 Dimension 1099 - 1100 1100 Measure Dimension 1101 - 1102 1102 Time Dimension 1103 - 1104 1104 Attribute Descriptor 1105 - 1106 1106 Data Attribute 1107 - 1108 1108 Measure Descriptor 1109 - 1110 1110 Primary Measure 1111 1111 ))) 1112 -| |(% colspan="2" %) |(% colspan="2" %)Metadata Structure Definition|(% colspan="2" %)((( 1113 -Metadata Target, 1114 - 1115 -Dimension Descriptor 1116 - 987 +|(% style="width:171px" %) |(% style="width:232px" %)Metadata Structure Definition|(% style="width:206px" %)((( 988 +Metadata Target, Dimension Descriptor 1117 1117 Values Target Identifiable 1118 - 1119 1119 Object Target 1120 - 1121 1121 Report Period Target 1122 - 1123 1123 Data SetTarget 1124 - 1125 1125 Report Structure 1126 - 1127 1127 Metadata Attribute 1128 1128 ))) 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 Step1132 -| |(%colspan="2" %)None|(%colspan="2" %)Structure Set|(%colspan="2" %)(((996 +|(% style="width:171px" %)Structure Usage|(% style="width:232px" %)Dataflow Definition|(% style="width:206px" %) 997 +|(% style="width:171px" %) |(% style="width:232px" %)Metadataflow Definition|(% style="width:206px" %) 998 +|(% style="width:171px" %)None|(% style="width:232px" %)Process|(% style="width:206px" %)Process Step 999 +|(% style="width:171px" %)None|(% style="width:232px" %)Structure Set|(% style="width:206px" %)((( 1133 1133 Component Map 1134 - 1135 1135 Concept Scheme Map 1136 - 1137 1137 Codelist Map 1138 - 1139 1139 Category Scheme Map 1140 - 1141 1141 Reporting Taxonomy Map 1142 - 1143 1143 Organisation Scheme Map 1144 - 1145 1145 Concept Map 1146 - 1147 1147 Code Map 1148 - 1149 1149 Category Map 1150 - 1151 1151 Organisation Map 1152 - 1153 1153 Reporting Category Map 1154 - 1155 1155 Hybrid Codelist Map 1156 - 1157 1157 Hybrid Code Map 1158 1158 ))) 1159 -| |(%colspan="2" %)None|(%colspan="2" %)Provision Agreement|(%colspan="2" %)1160 -| |(%colspan="2" %)None|(%colspan="2" %)Hierarchical Codelist|(%colspan="2" %)(((1014 +|(% style="width:171px" %)None|(% style="width:232px" %)Provision Agreement|(% style="width:206px" %) 1015 +|(% style="width:171px" %)None|(% style="width:232px" %)Hierarchical Codelist|(% style="width:206px" %)((( 1161 1161 Hierarchy 1162 - 1163 1163 Hierarchical Code 1164 1164 ))) 1165 -| | | | | | | 1166 1166 1167 -** Table 4: Table of Maintainable Artefacts for Structural Definition Metadata**1020 +**able 4: Table of Maintainable Artefacts for Structural Definition Metadata** 1168 1168 1169 1169 === 7.1.2 Item Scheme, Structure === 1170 1170 ... ... @@ -1171,10 +1171,7 @@ 1171 1171 The artefacts included in the structural definitions are: 1172 1172 1173 1173 * All types of Item Scheme (Codelist, Concept Scheme, Category Scheme, Organisation Scheme - Agency Scheme, Data Provider Scheme, Data Consumer Scheme, Organisation Unit Scheme) 1174 -* All types of Structure (Data Structure Definition, Metadata Structure 1175 - 1176 -Definition) 1177 - 1027 +* All types of Structure (Data Structure Definition, Metadata Structure Definition) 1178 1178 * All types of Structure Usage (Dataflow Definition, Metadataflow Definition) 1179 1179 1180 1180 === 7.1.3 Structure Usage === ... ... @@ -1193,6 +1193,8 @@ 1193 1193 1194 1194 ==== 7.1.3.3 Structure Usage Model ==== 1195 1195 1046 +[[image:1747829078194-749.png]] 1047 + 1196 1196 **Figure 10: SDMX-IM of links from Structure Usage to Category** 1197 1197 1198 1198 In addition to the maintenance of the Dataflow Definition and the Metadataflow Definition the following links must be maintained in the registry: ... ... @@ -1219,10 +1219,10 @@ 1219 1219 1220 1220 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. 1221 1221 1074 +[[image:1747829109466-595.png]] 1222 1222 1223 1223 **Figure 11: SDMX-IM of the Data Provider** 1224 1224 1225 - 1226 1226 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 1227 1227 1228 1228 [[image:1747824123019-181.jpeg]] ... ... @@ -1231,8 +1231,10 @@ 1231 1231 1232 1232 The diagram below is a logical representation of the data required in order to maintain Provision Agreements. 1233 1233 1086 +[[image:1747829139951-378.png]] 1234 1234 1235 -==== Figure 13: Logical class diagram of the information contained in the Provision Agreement ==== 1088 +(% class="wikigeneratedid" id="HFigure13:LogicalclassdiagramoftheinformationcontainedintheProvisionAgreement" %) 1089 +**Figure 13: Logical class diagram of the information contained in the Provision Agreement** 1236 1236 1237 1237 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. 1238 1238 ... ... @@ -1260,13 +1260,12 @@ 1260 1260 1261 1261 === 7.3.3 Data and Metadata Constraints: Model === 1262 1262 1117 +[[image:1747829204737-370.png]] 1263 1263 1119 +**Figure 15: Logical class diagram showing inheritance between and reference to constrainable artifacts** 1264 1264 1265 - ==== Figure15: Logicalclass diagram showing inheritancebetween and reference to constrainable artifacts====1121 +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. 1266 1266 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 - 1270 1270 The content of the Constraint can be found in the SDMX Information Model document. 1271 1271 1272 1272 == 7.4 Data and Metadata Registration == ... ... @@ -1287,7 +1287,7 @@ 1287 1287 1288 1288 [[image:1747824123025-411.jpeg]] 1289 1289 1290 - **Figure 16: Schematic of the Objects Concerned with Registration**1143 +**Figure 16: Schematic of the Objects Concerned with Registration** 1291 1291 1292 1292 ==== 7.4.2.2 Registration Request Model ==== 1293 1293 ... ... @@ -1301,11 +1301,14 @@ 1301 1301 1302 1302 The Registration has an action attribute which takes one of the following values: 1303 1303 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 1157 +(% style="width:970.294px" %) 1158 +|(% style="width:212px" %)**Action Attribute Value**|(% style="width:756px" %)**Behaviour** 1159 +|(% style="width:212px" %)Append|(% style="width:756px" %)Add this Registration to the registry 1160 +|(% style="width:212px" %)Replace|(% style="width:756px" %)Replace the existing Registration with identified by the id in the Registration of the Submit Registration Request 1161 +|(% style="width:212px" %)Delete|(% style="width:756px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request 1308 1308 1163 +[[image:1747829290890-122.png]] 1164 + 1309 1309 **Figure 17: Logical Class Diagram of Registration of Data and Metadata** 1310 1310 1311 1311 The Query Datasource is an abstract class that represents a data source which can understand an SDMX-ML query (SOAPDatasource) or RESTful query ... ... @@ -1320,25 +1320,19 @@ 1320 1320 1321 1321 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. 1322 1322 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. 1179 +|(% style="width:185px" %)**Indexing Required**|(% style="width:1686px" %)**Registration Process Activity** 1180 +|(% style="width:185px" %)indexTimeSeries|(% style="width:1686px" %)Extract all the series keys and create a KeySet(s) Constraint. 1181 +|(% style="width:185px" %)indexDataSet|(% style="width:1686px" %)((( 1182 +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. 1329 1329 ))) 1330 -|indexReportingPeriod|((( 1184 +|(% style="width:185px" %)indexReportingPeriod|(% style="width:1686px" %)((( 1331 1331 This applies only to a registered dataset. 1332 - 1333 1333 Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint. 1334 1334 ))) 1335 -|indexAttributes|((( 1188 +|(% style="width:185px" %)indexAttributes|(% style="width:1686px" %)((( 1336 1336 **Data Set** 1337 - 1338 1338 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 - 1340 1340 **Metadata Set** 1341 - 1342 1342 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. 1343 1343 ))) 1344 1344 ... ... @@ -1348,14 +1348,13 @@ 1348 1348 1349 1349 === 7.4.3 Registration Response === 1350 1350 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 1201 +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”. 1352 1352 1353 -“Success”, “Warning” or “Failure”. 1354 - 1355 1355 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. 1356 1356 1357 1357 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: 1358 1358 1207 +[[image:1747829477882-750.png]] 1359 1359 1360 1360 **Figure 18: Logical class diagram showing the registration response** 1361 1361 ... ... @@ -1365,15 +1365,12 @@ 1365 1365 1366 1366 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. 1367 1367 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 1217 +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”. 1369 1369 1370 - “notification”.1219 +=== 7.5.1Subscription Logical Class Diagram === 1371 1371 1372 - 7.5.1SubscriptionLogical Class Diagram1221 +[[image:1747829554603-150.png]] 1373 1373 1374 - 1375 -[[image:1747824123028-257.png]] 1376 - 1377 1377 **Figure 19: Logical Class Diagram of the Subscription** 1378 1378 1379 1379 === 7.5.2 Subscription Information === ... ... @@ -1380,73 +1380,58 @@ 1380 1380 1381 1381 Regardless of the type of registry/repository events being observed, a subscription always contains: 1382 1382 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. 1229 +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. 1230 +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. 1231 +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. 1232 +1. A selector which specifies which type of events are of interest. The set of event types is: 1384 1384 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. 1234 +|(% style="width:327px" %)**Event Type**|(% style="width:1545px" %)**Comment** 1235 +|(% style="width:327px" %)STRUCTURAL_REPOSITORY_EVENTS|(% style="width:1545px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository. 1236 +|(% 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. 1237 +|(% 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. 1238 +|(% style="width:327px" %)ALL_EVENTS|(% style="width:1545px" %)All events of the specified EventType 1386 1386 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 - 1397 1397 === 7.5.3 Wildcard Facility === 1398 1398 1399 1399 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: 1400 1400 1401 - agencyID 1244 +* agencyID 1245 +* id 1246 +* version 1402 1402 1403 - id 1404 - 1405 - version 1406 - 1407 1407 Examples of wildcarded identifier components for an identified object type of Codelist are shown below. 1408 1408 1409 -AgencyID = % 1410 - 1250 +//AgencyID = % 1411 1411 Id = % 1252 +Version = %// 1412 1412 1413 -Version = % 1414 - 1415 1415 This subscribes to all Codelists of all versions for all agencies. 1416 1416 1417 -AgencyID = AGENCY1 1418 - 1256 +//AgencyID = AGENCY1 1419 1419 Id = CODELIST1 1258 +Version = %// 1420 1420 1421 -Version = % 1422 - 1423 1423 This subscribes to all versions of Codelist CODELIST1 maintained by the agency 1424 1424 1425 -AGENCY1 1426 - 1262 +//AGENCY1 1427 1427 AgencyID = AGENCY1 1428 - 1429 1429 Id = % 1265 +Version = %// 1430 1430 1431 -Version = % 1432 - 1433 1433 This subscribes to all versions of all Codelist objects maintained by the agency 1434 1434 1435 -AGENCY1 1436 - 1269 +//AGENCY1 1437 1437 AgencyID = % 1438 - 1439 1439 Id = CODELIST1 1272 +Version = %// 1440 1440 1441 -Version = % 1442 - 1443 1443 This subscribes to all versions of Codelist CODELIST1 maintained by the agency 1444 1444 1445 -AGENCY1 1276 +//AGENCY1// 1446 1446 1447 1447 Note that if the subscription is to the latest version then this can be achieved by the * character 1448 1448 1449 -i.e. Version = * 1280 +//i.e. Version = *// 1450 1450 1451 1451 Note that a subscription using the URN mechanism cannot use wildcard characters. 1452 1452 ... ... @@ -1458,16 +1458,15 @@ 1458 1458 1459 1459 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: 1460 1460 1292 +|(% style="width:405px" %)**Selector**|(% style="width:1467px" %)**Comment** 1293 +|(% style="width:405px" %)DataProvider|(% style="width:1467px" %)Any datasets or metadata sets registered by the specified data provider will activate the notification. 1294 +|(% style="width:405px" %)ProvisionAgreement|(% style="width:1467px" %)Any datasets or metadata sets registered for the provision agreement will activate the notification. 1295 +|(% style="width:405px" %)Dataflow (&Metadataflow)|(% style="width:1467px" %)Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification. 1296 +|(% 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 1297 +|(% style="width:405px" %)**Selector**|(% style="width:1467px" %)**Comment** 1298 +|(% style="width:405px" %) |(% style="width:1467px" %)activate the notification. 1299 +|(% 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. 1461 1461 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 - 1471 1471 The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration. 1472 1472 1473 1473 == 7.6 Notification == ... ... @@ -1474,8 +1474,10 @@ 1474 1474 1475 1475 === 7.6.1 Logical Class Diagram === 1476 1476 1307 +[[image:1747829675568-610.png]] 1477 1477 1478 -==== Figure 20: Logical Class Diagram of the Notification ==== 1309 +(% class="wikigeneratedid" id="HFigure20:LogicalClassDiagramoftheNotification" %) 1310 +**Figure 20: Logical Class Diagram of the Notification** 1479 1479 1480 1480 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. 1481 1481 ... ... @@ -1495,5 +1495,3 @@ 1495 1495 === 7.6.3 Registration Event Component === 1496 1496 1497 1497 The notification will contain the Registration. 1498 - 1499 -
- 1747829078194-749.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.helena - Size
-
... ... @@ -1,0 +1,1 @@ 1 +40.4 KB - Content
- 1747829109466-595.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.helena - Size
-
... ... @@ -1,0 +1,1 @@ 1 +30.4 KB - Content
- 1747829139951-378.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.helena - Size
-
... ... @@ -1,0 +1,1 @@ 1 +21.1 KB - Content
- 1747829204737-370.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.helena - Size
-
... ... @@ -1,0 +1,1 @@ 1 +55.8 KB - Content
- 1747829290890-122.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.helena - Size
-
... ... @@ -1,0 +1,1 @@ 1 +41.4 KB - Content
- 1747829477882-750.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.helena - Size
-
... ... @@ -1,0 +1,1 @@ 1 +24.6 KB - Content
- 1747829554603-150.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.helena - Size
-
... ... @@ -1,0 +1,1 @@ 1 +99.1 KB - Content
- 1747829675568-610.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +xwiki:XWiki.helena - Size
-
... ... @@ -1,0 +1,1 @@ 1 +31.1 KB - Content