Last modified by Helena on 2025/09/10 11:19
Summary
-
Page properties (2 modified, 0 added, 0 removed)
-
Attachments (0 modified, 0 added, 9 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 -SDMX 2.1 Standards. Section 5. Registry Specification – Logical Interfaces 1 +SDMX 2.1 Standards. Section. 5. Registry Specification – Logical Interfaces - 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,22 +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 -The Registration has an action attribute which takes one of the following values: 293 +3The Registration has an action attribute which takes one of the following values: 295 295 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 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 300 300 301 301 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: 302 302 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. 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 + 306 306 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 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 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 308 308 309 309 === 5.2.5 Data and Reference Metadata Discovery === 310 310 ... ... @@ -326,7 +326,7 @@ 326 326 Subscription management involves a user submitting a subscription request which contains: 327 327 328 328 * a query or constraint expression in terms of a filter which defines the events for which the user is interested (e.g. new data for a specific dataflow, or for a domain category, or changes to a Data Structure Definition). 329 -* a list of URIs or end-points to which an XML notification message can be sent. Supported end-point types will be email (mailto :) and HTTP POST (a normal http:~/~/ address)333 +* a list of URIs or end-points to which an XML notification message can be sent. Supported end-point types will be email (mailto~:) and HTTP POST (a normal http:~/~/ address) 330 330 * request for a list of submitted subscriptions 331 331 * deletion of a subscription 332 332 ... ... @@ -336,8 +336,8 @@ 336 336 337 337 The following table defines the behaviour of the SDMX Registry for the various Registry Interface messages. 338 338 339 -|(% style="width:2 27px" %)**Interface**|(% style="width:1644px" %)**Behaviour**340 -|(% style="width:2 27px" %)All|(% style="width:1644px" %)(((343 +|(% style="width:244px" %)**Interface**|**Behaviour** 344 +|(% style="width:244px" %)All|((( 341 341 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: 342 342 343 343 * Name – this applies to the Maintainable object and its contained elements, such a Code in a Code list. ... ... @@ -351,6 +351,7 @@ 351 351 * isExternalReference 352 352 353 353 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 + 354 354 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: 355 355 356 356 а) Not have the final attribute set to “true” ... ... @@ -357,11 +357,12 @@ 357 357 b) Not be referenced from any other object in the Registry. 358 358 359 359 4) The version rules in the SDMX Schema documentation MUST be obeyed. 365 + 360 360 5) The specific rules for the elements and attributes documented in the SDMX Schema MUST be obeyed. 361 361 ))) 362 -|(% 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.363 -|(% style="width:2 27px" %)SubmitProvisioningRequest|(% style="width:1644px" %)No additional behaviour.364 -|(% 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|((( 365 365 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. 366 366 For a queryable datasource the Registry MAY validate that the source exists and can accept an SDMX-ML data query. 367 367 ))) ... ... @@ -448,8 +448,7 @@ 448 448 449 449 [[image:1747824123012-527.jpeg]] 450 450 451 -* 452 -** Figure 7: Example of Hierarchic Structure of Agencies 457 +==== Figure 7: Example of Hierarchic Structure of Agencies ==== 453 453 454 454 The following organizations maintain an Agency Scheme. 455 455 ... ... @@ -464,8 +464,9 @@ 464 464 465 465 An example of this is shown in the XML snippet below. 466 466 467 -[[image:17478 32400104-286.png]]472 +[[image:1747824123013-196.jpeg||height="309" width="446"]] 468 468 474 +(% class="wikigeneratedid" id="HFigure8:ExampleShowingUseofAgencyIdentifiers" %) 469 469 **Figure 8: Example Showing Use of Agency Identifiers** 470 470 471 471 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. ... ... @@ -478,14 +478,13 @@ 478 478 479 479 ==== 6.2.2.2 URN Structure ==== 480 480 481 -(% class="wikigeneratedid" id="HCaseRulesforURN" %) 482 -//Case Rules for URN// 487 +===== //Case Rules for URN// ===== 483 483 484 484 For the URN, all parts of the string are case sensitive. The Id of any object must be UPPER CASE. Therefore, CRED_ext_Debt is invalid and it should be CRED_EXT_DEBT. 485 485 486 486 The generic structure of the URN is as follows: 487 487 488 - >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 489 489 490 490 ~* this can repeat and may not be present (see explanation below) 491 491 ... ... @@ -497,7 +497,7 @@ 497 497 498 498 In the explanation below the actual object that is the target of the URN is called the **//actual object//**. 499 499 500 -**SDMXPrefix:** urn:sdmx:org. 505 +**SDMXPrefix:** urn:sdmx:org. 501 501 502 502 **SDMX-IM package name:** sdmx.infomodel.package= 503 503 ... ... @@ -676,50 +676,78 @@ 676 676 677 677 Note that for brevity the URN examples omit the prefix. All URNs have the prefix 678 678 679 - >urn:sdmx.org.sdmx.infomodel.{package}.{classname}=684 +urn:sdmx.org.sdmx.infomodel.{package}.{classname}= 680 680 681 - (% style="width:1091.29px" %)682 -| (% style="width:250px" %)**SDMX Class**|(% style="width:444px" %)**Key attribute(s)**|(% style="width:396px" %)**Example of URN**683 -| (% 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.|((( 684 684 IMF 690 + 691 + 685 685 Sub agency in the IMF AGENCIES 693 + 694 + 686 686 IMF.SubAgency1 687 687 ))) 688 -|(% style="width:250px" %)*ConceptScheme|(% style="width:444px" %)conceptSchemeAgencyId:conceptSchemeId(ve rsion)|(% style="width:396px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0) 689 -|(% style="width:250px" %)Concept|(% style="width:444px" %)conceptSchemeAgencyId: 690 -conceptSchemeId(version).conceptId|(% style="width:396px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0).FREQ 691 -|(% style="width:250px" %)*Codelist|(% style="width:444px" %)codeListAgencyId:codeListId(version)|(% style="width:396px" %)SDMX:CL_FREQ(1.0) 692 -|(% style="width:250px" %)Code|(% style="width:444px" %)codeListAgencyId:codelistId(version).codeId|(% style="width:396px" %)SDMX:CL_FREQ(1.0).Q 693 -|(% style="width:250px" %)((( 694 -*Hierarchical Codelist 695 -)))|(% style="width:444px" %)hierachicalCodelistAgencyId: hierarchicalCodelistId(version)|(% style="width:396px" %)((( 696 -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 + 697 697 ))) 698 -|(% 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|((( 699 699 hierachicalcodeListAgencyId: 723 + 700 700 hierarchicalcodelistId(version).Hierarchy 701 -)))|(% style="width:396px" %)UNESCO:CL_EXP_SOURCE(1.0). 702 -H-C-GOV 703 -|(% style="width:250px" %)Level|(% style="width:444px" %)((( 725 +)))|UNESCO:CL_EXP_SOURCE(1.0). H-C-GOV 726 +|Level|((( 704 704 hierachicalcodeListAgencyId: 728 + 705 705 hierarchicalcodelistId(version).Hierarchy.Level 706 -)))|( % style="width:396px" %)(((730 +)))|((( 707 707 ESTAT:HCL_REGION(1.0).H_1.COUNTRY 732 + 733 + 708 708 ))) 709 -| (% 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_CODE1710 -| (% style="width:250px" %)*DataStructure|(% style="width:444px" %)dataStructureDefintitionAgencyId: dataStructureDefintitionId(version)|(% style="width:396px" %)TFFS:EXT_DEBT(1.0)711 -|( % 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 +|((( 712 712 Dimension 739 + 713 713 Descriptor 741 + 714 714 Measure 743 + 715 715 Descriptor 745 + 716 716 Attribute 747 + 717 717 Descriptor 718 -)))|( % style="width:444px" %)(((749 +)))|((( 719 719 dataStructureDefinitionAgencyId: dataStructureDefinitionId(version). 751 + 720 720 componentListId 753 + 721 721 where the componentListId is the name of the class (there is only one occurrence of each in the Data Structure Definition) 722 -)))|( % style="width:396px" %)(((755 +)))|((( 723 723 TFFS:EXT_DEBT(1.0).DimensionDescriptor 724 724 725 725 TFFS:EXT_DEBT(1.0).MeasureDescriptor ... ... @@ -726,124 +726,181 @@ 726 726 727 727 TFFS:EXT_DEBT(1.0).AttributeDescriptor 728 728 ))) 729 -|( % style="width:250px" %)(((762 +|((( 730 730 GroupDimension 764 + 731 731 Descriptor 732 -)))|( % style="width:444px" %)(((766 +)))|((( 733 733 dataStructureDefinitionAgencyId: dataStructureDefinitionId(version). 768 + 734 734 groupDimensionDescriptorId 735 -)))| (% style="width:396px" %)TFFS:EXT_DEBT(1.0).SIBLING736 -| (% style="width:250px" %)Dimension|(% style="width:444px" %)(((770 +)))|TFFS:EXT_DEBT(1.0).SIBLING 771 +|Dimension|((( 737 737 dataStructureDefinitionAgencyId: dataStructureDefinition (version). 773 + 738 738 dimensionId 739 -)))| (% style="width:396px" %)TFFS:EXT_DEBT(1.0).FREQ740 -| (% style="width:250px" %)TimeDimension|(% style="width:444px" %)(((775 +)))|TFFS:EXT_DEBT(1.0).FREQ 776 +|TimeDimension|((( 741 741 dataStructureDefinitionAgencyId: dataStructureDefinition (version). 778 + 742 742 timeDimensionId 743 -)))|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).TIME_PERIOD 744 -|(% style="width:250px" %)Measure Dimension|(% style="width:444px" %)dataStructureDefinitionAgencyId: dataStructureDefinition (version). 745 -measureDimensionId|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).STOCK_FLOW 746 -|(% style="width:250px" %)DataAttrribute|(% style="width:444px" %)dataStructureDefinitionAgencyId: dataStructureDefinition (version). dataAttributeId|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).OBS_STATUS 747 -|(% 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|((( 748 748 dataStructureDefinitionAgencyId: dataStructureDefinition (version). 789 + 749 749 primaryMeasureId 750 -)))|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).OBS_VALUE 751 -|(% style="width:250px" %)((( 752 -*Category Scheme 753 -)))|(% style="width:444px" %)categorySchemeAgencyId: 754 -categorySchemeId(version)|(% style="width:396px" %)IMF:SDDS(1.0) 755 -|(% style="width:250px" %)Category|(% style="width:444px" %)categorySchemeAgencyId: 756 -categorySchemeId(version). 757 -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.|((( 758 758 IMF:SDDS(1.0): 799 + 759 759 level_1_category.level_2_category … 760 760 ))) 761 -|(% style="width:250px" %)((( 762 -*Reporting Taxonomy 763 -)))|(% style="width:444px" %)reportingTaxonomyAgencyId: reportingTaxonomyId(version)|(% style="width:396px" %) IMF:REP_1(1.0) 764 -|(% 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|((( 765 765 IMF:REP_1(1.0): 809 + 766 766 level_1_repcategory.level_2_repcategory … 767 767 ))) 768 -|(% style="width:250px" %)*Categorisation|(% style="width:444px" %)categorisationAgencyId: categorisationId(version)|(% style="width:396px" %)IMF:cat001(1.0) 769 -|(% style="width:250px" %)((( 770 -*Organisation Unit Scheme 771 -)))|(% style="width:444px" %)organisationUnitSchemeAgencyId: organisationUnitSchemeId(version)|(% style="width:396px" %)ECB:ORGANISATIONS(1.0) 772 -|(% style="width:250px" %)Organisation Unit|(% style="width:444px" %)organisationUnitSchemeAgencyId: organisationUnitSchemeId(version). organisationUnitId|(% style="width:396px" %)ECB:ORGANISATIONS(1.0).1F 773 -|(% 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 774 774 775 -|(% style="width:262px" %)Agency|(% style="width:369px" %)agencySchemeAgencyId: agencySchemeId(version). agencyId|(% style="width:1262px" %)ECB:AGENCY(1.0).AA 776 -|(% style="width:262px" %)((( 777 -*DataProvider Scheme 778 -)))|(% style="width:369px" %)dataProviderSchemeAgencyId: dataProviderSchemeId(version)|(% style="width:1262px" %)SDMX:DATA_PROVIDERS(1.0) 779 -|(% style="width:262px" %)DataProvider|(% style="width:369px" %)dataProviderSchemeAgencyId: dataProviderSchemeId(version) dataProviderId|(% style="width:1262px" %)SDMX:DATA_PROVIDERS(1.0).PROVIDER_1 780 -|(% style="width:262px" %)((( 781 -*DataConsumer Scheme 782 -)))|(% style="width:369px" %)dataConsumerSchemeAgencyId: dataConsumerSchemeId(version)|(% style="width:1262px" %)SDMX:DATA_CONSUMERS(1.0) 783 -|(% style="width:262px" %)Data Consumer|(% style="width:369px" %)dataConsumerSchemeAgencyId: dataConsumerSchemeId(version) dataConsumerId|(% style="width:1262px" %)SDMX:DATA_CONSUMERS(1.0).CONSUMER_1 784 -|(% style="width:262px" %)((( 785 -*Metadata Structure 786 -)))|(% style="width:369px" %)MSDAgencyId:MSDId(version)|(% style="width:1262px" %)IMF:SDDS_MSD(1.0) 787 -|(% 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|((( 788 788 MSDAgencyId: 843 + 789 789 MSDId(version).metadataTargetId 790 -)))| (% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY791 -|( % style="width:262px" %)(((845 +)))|IMF:SDDS_MSD(1.0).AGENCY 846 +|((( 792 792 Dimension 848 + 793 793 DescriptorValues 850 + 794 794 Target 795 -)))|( % style="width:369px" %)(((852 +)))|((( 796 796 MSDAgencyId: MSDId(version). 854 + 797 797 metadataTargetId.keyDescriptorValueTargetId 798 -)))|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY.KEY 799 -|(% style="width:262px" %)Identifiable Object Target|(% style="width:369px" %)((( 800 -MSDAgencyId: MSDId(version).metadataTargetId.identifiableObjectTargetId 801 -)))|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY.STR-OBJECT 802 -|(% style="width:262px" %)DataSetTarget|(% style="width:369px" %)((( 856 +)))|IMF:SDDS_MSD(1.0).AGENCY.KEY 857 +|Identifiable ObjectTarget|((( 803 803 MSDAgencyId: 804 -MSDId(version).metadataTargetId.dataSetTargetId 805 -)))|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY.D1101 806 -|(% style="width:262px" %)PeportPeriod Target|(% style="width:369px" %)((( 807 -MSDAgencyId: MSDId(version).metadataTargetId.reportPeriodTargetId 808 -)))|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY.REP_PER 809 809 810 -|(% 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 +|((( 811 811 ReportStructure 812 -)))|(% style="width:442px" %)((( 813 -MSDAgencyId: MSDId(version).reportStructureId 814 -)))|(% style="width:1178px" %)IMF:SDDS_MSD(1.0).AGENCY_REPORT 815 -|(% style="width:251px" %)((( 816 -Metadata Attribute 817 -)))|(% style="width:442px" %)((( 818 -MSDAgencyId: MSDId(version).reportStructureId.metadataattri buteID 819 -)))|(% style="width:1178px" %)IMF:SDDS_MSD(1.0).AGENCY_REPORT.COMPILATION 820 -|(% style="width:251px" %)*Dataflow|(% style="width:442px" %)dataflowAgencyId: dataflowId(version)|(% style="width:1178px" %)TFFS:CRED_EXT_DEBT(1.0) 821 -|(% style="width:251px" %)*Provision Agreement|(% style="width:442px" %)((( 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|((( 822 822 provisionAgreementAgencyId:provisionAgreem entId(version) 823 -)))|(% style="width:1178px" %)((( 902 + 903 + 904 +)))|((( 824 824 TFFS:CRED_EXT_DEBT_AB(1.0) 906 + 907 + 908 + 825 825 ))) 826 -|(% style="width:251px" %)((( 827 -*Content Constraint 828 -)))|(% style="width:442px" %)constraintAgencyId:ContentConstraintId(versio n)|(% style="width:1178px" %)TFFS:CREDITOR_DATA_CONTENT(1.0) 829 -|(% style="width:251px" %)((( 830 -*Attachment Constraint 831 -)))|(% style="width:442px" %)((( 910 +|((( 911 +*Content 912 + 913 +Constraint 914 +)))|constraintAgencyId:ContentConstraintId(versio n)|TFFS:CREDITOR_DATA_CONTENT(1.0) 915 +|((( 916 +*Attachment 917 + 918 +Constraint 919 +)))|((( 832 832 constraintAgencyId: 833 833 834 834 attachmentConstraintId(version) 835 -)))| (% style="width:1178px" %)TFFS:CREDITOR_DATA_ATTACHMENT_CONSTRAINT_ONE(1.0)836 -| (% style="width:251px" %)*Metadataflow|(% style="width:442px" %)metadataflowAgencyId: metadataflowId(version)|(% style="width:1178px" %)IMF:SDDS_FLOW(1.0)837 -| (% style="width:251px" %)*StructureSet|(%style="width:442px" %)structureSetAgencyId: structureSetId(version)|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0)838 -| (% style="width:251px" %)StructureMap|(%style="width:442px" %)structureSetAgencyId: structureSetId(version). structureMapId|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2839 -| (% 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|((( 840 840 structureSetAgencyId: structureSetId(version). 841 841 842 842 structureMapId. componentMapId 843 -)))| (% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2. REFAREA_REPCOUNTRY844 -| (% style="width:251px" %)CodelistMap|(%style="width:442px" %)structureSetAgencyId: structureSetId(version). codelistMapId|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0).CLREFAREA_CLREPCOUNTRY845 -| (% 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 846 846 935 + 936 + 847 847 | |((( 848 848 codeListMapId. 849 849 ... ... @@ -850,7 +850,9 @@ 850 850 codeMapId 851 851 )))| 852 852 |((( 853 -CategorySchemeMap 943 +Category 944 + 945 +SchemeMap 854 854 )))|structureSetAgencyId: structureSetId(version). categorySchemeMapId|SDMX:BOP_STRUCTURES(1.0).SDMX_EUROSTAT 855 855 |CategoryMap|structureSetAgencyId: structureSetId(version). categorySchemeMapId. categoryMapId|SDMX:BOP_STRUCTURES(1.0).SDMX_EUROSTAT.TOURISM_M AP 856 856 |Organisation SchemeMap|structureSetAgencyId: structureSetId(version). organisationSchemeMapId|SDMX:BOP_STRUCTURES(1.0).DATA_PROVIDER_MAP ... ... @@ -864,53 +864,71 @@ 864 864 structureSetAgencyId: structureSetId(version). conceptSchemeMapId. 865 865 866 866 conceptMapId 959 + 867 867 868 868 )))|SDMX:BOP_STRUCTURES(1.0).SDMX_OECD.COVERAGE_AVAI LABILITY 869 869 |((( 870 -ReportingTaxonomyMap 963 +Reporting 964 + 965 +TaxonomyMap 871 871 )))|structureSetAgencyId: structureSetId(version). reportingTaxonomyMapId|SDMX:BOP_STRUCTURES(1.0).TAXMAP 872 872 |((( 873 -ReportingCategoryMap 968 +Reporting 969 + 970 +CategoryMap 874 874 )))|((( 875 875 structureSetAgencyId: structureSetId(version). 973 + 876 876 reportngCategoryId 877 877 )))|SDMX:BOP_STRUCTURES(1.0).TAXMAP.TOPCAT 878 878 977 + 978 + 879 879 |((( 880 -HybridCodelistMap 881 -)))|structureSetAgencyId: structureSetId(version). 882 -hybridCodelistMapId.|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP 980 +HybridCodelist 981 + 982 +Map 983 +)))|structureSetAgencyId: structureSetId(version). hybridCodelistMapId.|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP 883 883 |HybridCodeMap|structureSetAgencyId: structureSetId(version). hybridCodelistMapId. hybridCodeMapId|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP.CO DEMAP1 884 884 |*Process|processAgencyId: processId{version]|BIS:PROCESS1(1.0) 885 885 |ProcessStep|((( 886 886 processAgencyId: processId(version). 988 + 887 887 processStepId 888 888 )))|BIS:PROCESS1(1.0).STEP1 889 889 |Transition|((( 890 890 processAgencyId: processId(version). 993 + 891 891 processStepId transitionId 892 892 )))|BIS:PROCESS1(1.0).STEP1.TRANSITION1 893 893 |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. 894 894 |((( 895 -*Transformation Scheme 998 +*Transformation 999 + 1000 +Scheme 896 896 )))|transformationSchemeAgencyId transformationSchemeId(version)|ECB: TRANSFORMATION_SCHEME(1.0) 897 897 |Transformation|((( 898 898 transformationSchemeAgencyId transformationSchemeId(version) 1004 + 899 899 transformationId 900 900 )))|ECB:TRANSFORMATION_SCHEME(1.0).TRANS_1 901 901 |CustomType Scheme|customTypeSchemeAgencyId customTypeSchemeId(version)|ECB:CUSTOM_TYPE_SCHEME(1.0) 902 902 1009 + 1010 + 903 903 |CustomType|customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|ECB: CUSTOM_TYPE_SCHEME(1.0).CUSTOM_TYPE_1 904 904 |((( 905 905 Name 1014 + 906 906 Personalisation 1016 + 907 907 Scheme 908 908 )))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|ECB:PSN_SCHEME(1.0) 909 909 |((( 910 910 Name 1021 + 911 911 Personalisation 912 -)))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) 913 -namePersonalisationId|ECB:PSN_SCHEME(1.0).PSN1234 1023 +)))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|ECB:PSN_SCHEME(1.0).PSN1234 914 914 |VtlMapping Scheme|vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|ECB:CLIST_MP(2.0) 915 915 |VtlCodelist Mapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|ECB:CLIST_MP(2.0).ABZ 916 916 |VtlConcept Mapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|ECB:CLIST_MP(1.0).XYA ... ... @@ -923,12 +923,15 @@ 923 923 |RulesetScheme|rulesetSchemeAgencyId rulesetSchemeId(version)|ECB:RULESET_23(1.0) 924 924 |Ruleset|rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|ECB:RULESET_23(1.0).SET111 925 925 |((( 926 -UserDefinedOperatorScheme 1036 +UserDefined 1037 + 1038 +OperatorScheme 927 927 )))|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|ECB:OS_CALC(1.2) 928 928 |UserDefined Operator|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|ECB:OS_CALC(1.2).OS267 929 929 930 -**Table 3: Table of identification components for SDMX Identifiable Artefacts** 1042 +7**Table 3: Table of identification components for SDMX Identifiable Artefacts** 931 931 1044 + 932 932 = 7 Implementation Notes = 933 933 934 934 == 7.1 Structural Definition Metadata == ... ... @@ -949,72 +949,109 @@ 949 949 950 950 The following table lists the Maintainable Artefacts. 951 951 952 -(% style="width:640.294px" %) 953 -|(% colspan="2" rowspan="1" style="width:186px" %)**Maintainable Artefacts**|(% style="width:206px" %)**Content** 954 -|(% style="width:171px" %)**Abstract Class**|(% style="width:232px" %)**Concrete Class**|(% style="width:206px" %) 955 -|(% style="width:171px" %)Item Scheme|(% style="width:232px" %)Codelist|(% style="width:206px" %)Code 956 -|(% style="width:171px" %) |(% style="width:232px" %)Concept Scheme|(% style="width:206px" %)Concept 957 -|(% style="width:171px" %) |(% style="width:232px" %)Category Scheme|(% style="width:206px" %)Category 958 -|(% style="width:171px" %) |(% style="width:232px" %)Organisation Unit Scheme|(% style="width:206px" %)Organisation Unit 959 -|(% style="width:171px" %) |(% style="width:232px" %)Agency Scheme|(% style="width:206px" %)Agency 960 -|(% style="width:171px" %) |(% style="width:232px" %)Data Provider Scheme|(% style="width:206px" %)Data Provider 961 -|(% style="width:171px" %) |(% style="width:232px" %)Data Consumer Scheme|(% style="width:206px" %)Data Consumer 962 -|(% style="width:171px" %) |(% style="width:232px" %)Reporting Taxonomy|(% style="width:206px" %)Reporting Category 963 -|(% style="width:171px" %) |(% style="width:232px" %)Transformation Scheme|(% style="width:206px" %)Transformation 964 -|(% style="width:171px" %) |(% style="width:232px" %)Custom Type Scheme|(% style="width:206px" %)Custom Type 965 -|(% style="width:171px" %) |(% style="width:232px" %)Name Personalisation Scheme|(% style="width:206px" %)Name Personalisation 966 -|(% style="width:171px" %) |(% style="width:232px" %)Vtl Mapping Scheme|(% style="width:206px" %)Vtl Codelist Mapping 967 -|(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)Vtl Dataflow Mapping 968 -|(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)Vtl Concept Scheme Mapping 969 -|(% style="width:171px" %) |(% style="width:232px" %)Ruleset Scheme|(% style="width:206px" %)Ruleset 970 -|(% style="width:171px" %) |(% style="width:232px" %)User Defined Operator Scheme|(% style="width:206px" %)User Defined Operator 971 -|(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)User Defined Operator 972 -|(% 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" %)((( 973 973 Dimension Descriptor 1093 + 974 974 Group Dimension 1095 + 975 975 Descriptor 1097 + 976 976 Dimension 1099 + 977 977 Measure Dimension 1101 + 978 978 Time Dimension 1103 + 979 979 Attribute Descriptor 1105 + 980 980 Data Attribute 1107 + 981 981 Measure Descriptor 1109 + 982 982 Primary Measure 983 983 ))) 984 -|(% style="width:171px" %) |(% style="width:232px" %)Metadata Structure Definition|(% style="width:206px" %)((( 985 -Metadata Target, Dimension Descriptor 1112 +| |(% colspan="2" %) |(% colspan="2" %)Metadata Structure Definition|(% colspan="2" %)((( 1113 +Metadata Target, 1114 + 1115 +Dimension Descriptor 1116 + 986 986 Values Target Identifiable 1118 + 987 987 Object Target 1120 + 988 988 Report Period Target 1122 + 989 989 Data SetTarget 1124 + 990 990 Report Structure 1126 + 991 991 Metadata Attribute 992 992 ))) 993 -|(% style="width:171px" %)Structure Usage|(%style="width:232px" %)Dataflow Definition|(%style="width:206px" %)994 -|(% style="width:171px" %) |(%style="width:232px" %)Metadataflow Definition|(%style="width:206px" %)995 -|(% style="width:171px" %)None|(%style="width:232px" %)Process|(%style="width:206px" %)Process Step996 -|(% 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" %)((( 997 997 Component Map 1134 + 998 998 Concept Scheme Map 1136 + 999 999 Codelist Map 1138 + 1000 1000 Category Scheme Map 1140 + 1001 1001 Reporting Taxonomy Map 1142 + 1002 1002 Organisation Scheme Map 1144 + 1003 1003 Concept Map 1146 + 1004 1004 Code Map 1148 + 1005 1005 Category Map 1150 + 1006 1006 Organisation Map 1152 + 1007 1007 Reporting Category Map 1154 + 1008 1008 Hybrid Codelist Map 1156 + 1009 1009 Hybrid Code Map 1010 1010 ))) 1011 -|(% style="width:171px" %)None|(%style="width:232px" %)Provision Agreement|(%style="width:206px" %)1012 -|(% 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" %)((( 1013 1013 Hierarchy 1162 + 1014 1014 Hierarchical Code 1015 1015 ))) 1165 +| | | | | | | 1016 1016 1017 -**able 4: Table of Maintainable Artefacts for Structural Definition Metadata** 1167 +**Table 4: Table of Maintainable Artefacts for Structural Definition Metadata** 1018 1018 1019 1019 === 7.1.2 Item Scheme, Structure === 1020 1020 ... ... @@ -1021,7 +1021,10 @@ 1021 1021 The artefacts included in the structural definitions are: 1022 1022 1023 1023 * All types of Item Scheme (Codelist, Concept Scheme, Category Scheme, Organisation Scheme - Agency Scheme, Data Provider Scheme, Data Consumer Scheme, Organisation Unit Scheme) 1024 -* All types of Structure (Data Structure Definition, Metadata Structure Definition) 1174 +* All types of Structure (Data Structure Definition, Metadata Structure 1175 + 1176 +Definition) 1177 + 1025 1025 * All types of Structure Usage (Dataflow Definition, Metadataflow Definition) 1026 1026 1027 1027 === 7.1.3 Structure Usage === ... ... @@ -1040,8 +1040,6 @@ 1040 1040 1041 1041 ==== 7.1.3.3 Structure Usage Model ==== 1042 1042 1043 -[[image:1747829078194-749.png]] 1044 - 1045 1045 **Figure 10: SDMX-IM of links from Structure Usage to Category** 1046 1046 1047 1047 In addition to the maintenance of the Dataflow Definition and the Metadataflow Definition the following links must be maintained in the registry: ... ... @@ -1068,10 +1068,10 @@ 1068 1068 1069 1069 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. 1070 1070 1071 -[[image:1747829109466-595.png]] 1072 1072 1073 1073 **Figure 11: SDMX-IM of the Data Provider** 1074 1074 1225 + 1075 1075 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 1076 1076 1077 1077 [[image:1747824123019-181.jpeg]] ... ... @@ -1080,10 +1080,8 @@ 1080 1080 1081 1081 The diagram below is a logical representation of the data required in order to maintain Provision Agreements. 1082 1082 1083 -[[image:1747829139951-378.png]] 1084 1084 1085 -(% class="wikigeneratedid" id="HFigure13:LogicalclassdiagramoftheinformationcontainedintheProvisionAgreement" %) 1086 -**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 ==== 1087 1087 1088 1088 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. 1089 1089 ... ... @@ -1111,12 +1111,13 @@ 1111 1111 1112 1112 === 7.3.3 Data and Metadata Constraints: Model === 1113 1113 1114 -[[image:1747829204737-370.png]] 1115 1115 1116 -**Figure 15: Logical class diagram showing inheritance between and reference to constrainable artifacts** 1117 1117 1118 - 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 ==== 1119 1119 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 + 1120 1120 The content of the Constraint can be found in the SDMX Information Model document. 1121 1121 1122 1122 == 7.4 Data and Metadata Registration == ... ... @@ -1137,7 +1137,7 @@ 1137 1137 1138 1138 [[image:1747824123025-411.jpeg]] 1139 1139 1140 -**Figure 16: Schematic of the Objects Concerned with Registration** 1290 + **Figure 16: Schematic of the Objects Concerned with Registration** 1141 1141 1142 1142 ==== 7.4.2.2 Registration Request Model ==== 1143 1143 ... ... @@ -1151,14 +1151,11 @@ 1151 1151 1152 1152 The Registration has an action attribute which takes one of the following values: 1153 1153 1154 -(% style="width:970.294px" %) 1155 -|(% style="width:212px" %)**Action Attribute Value**|(% style="width:756px" %)**Behaviour** 1156 -|(% style="width:212px" %)Append|(% style="width:756px" %)Add this Registration to the registry 1157 -|(% style="width:212px" %)Replace|(% style="width:756px" %)Replace the existing Registration with identified by the id in the Registration of the Submit Registration Request 1158 -|(% 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 1159 1159 1160 -[[image:1747829290890-122.png]] 1161 - 1162 1162 **Figure 17: Logical Class Diagram of Registration of Data and Metadata** 1163 1163 1164 1164 The Query Datasource is an abstract class that represents a data source which can understand an SDMX-ML query (SOAPDatasource) or RESTful query ... ... @@ -1173,19 +1173,25 @@ 1173 1173 1174 1174 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. 1175 1175 1176 -|(% style="width:185px" %)**Indexing Required**|(% style="width:1686px" %)**Registration Process Activity** 1177 -|(% style="width:185px" %)indexTimeSeries|(% style="width:1686px" %)Extract all the series keys and create a KeySet(s) Constraint. 1178 -|(% style="width:185px" %)indexDataSet|(% style="width:1686px" %)((( 1179 -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. 1180 1180 ))) 1181 -| (% style="width:185px" %)indexReportingPeriod|(% style="width:1686px" %)(((1330 +|indexReportingPeriod|((( 1182 1182 This applies only to a registered dataset. 1332 + 1183 1183 Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint. 1184 1184 ))) 1185 -| (% style="width:185px" %)indexAttributes|(% style="width:1686px" %)(((1335 +|indexAttributes|((( 1186 1186 **Data Set** 1337 + 1187 1187 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 + 1188 1188 **Metadata Set** 1341 + 1189 1189 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. 1190 1190 ))) 1191 1191 ... ... @@ -1195,13 +1195,14 @@ 1195 1195 1196 1196 === 7.4.3 Registration Response === 1197 1197 1198 -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 1199 1199 1353 +“Success”, “Warning” or “Failure”. 1354 + 1200 1200 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. 1201 1201 1202 1202 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: 1203 1203 1204 -[[image:1747829477882-750.png]] 1205 1205 1206 1206 **Figure 18: Logical class diagram showing the registration response** 1207 1207 ... ... @@ -1211,12 +1211,15 @@ 1211 1211 1212 1212 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. 1213 1213 1214 -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 1215 1215 1216 - === 7.5.1SubscriptionLogical Class Diagram ===1370 +“notification”. 1217 1217 1218 - [[image:1747829554603-150.png]]1372 + 7.5.1Subscription Logical Class Diagram 1219 1219 1374 + 1375 +[[image:1747824123028-257.png]] 1376 + 1220 1220 **Figure 19: Logical Class Diagram of the Subscription** 1221 1221 1222 1222 === 7.5.2 Subscription Information === ... ... @@ -1223,58 +1223,73 @@ 1223 1223 1224 1224 Regardless of the type of registry/repository events being observed, a subscription always contains: 1225 1225 1226 -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. 1227 -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. 1228 -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. 1229 -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. 1230 1230 1231 -|(% style="width:319px" %)**Event Type**|(% style="width:1553px" %)**Comment** 1232 -|(% style="width:319px" %)STRUCTURAL_REPOSITORY_EVENTS|(% style="width:1553px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository. 1233 -|(% style="width:319px" %)DATA_REGISTRATION_EVENTS|(% style="width:1553px" %)Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database. 1234 -|(% style="width:319px" %)METADATA_REGISTRATION_EVENTS|(% style="width:1553px" %)Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database. 1235 -|(% style="width:319px" %)ALL_EVENTS|(% style="width:1553px" %)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. 1236 1236 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 + 1237 1237 === 7.5.3 Wildcard Facility === 1238 1238 1239 1239 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: 1240 1240 1241 -* agencyID 1242 -* id 1243 -* version 1401 + agencyID 1244 1244 1403 + id 1404 + 1405 + version 1406 + 1245 1245 Examples of wildcarded identifier components for an identified object type of Codelist are shown below. 1246 1246 1247 -//AgencyID = % 1409 +AgencyID = % 1410 + 1248 1248 Id = % 1249 -Version = %// 1250 1250 1413 +Version = % 1414 + 1251 1251 This subscribes to all Codelists of all versions for all agencies. 1252 1252 1253 -//AgencyID = AGENCY1 1417 +AgencyID = AGENCY1 1418 + 1254 1254 Id = CODELIST1 1255 -Version = %// 1256 1256 1421 +Version = % 1422 + 1257 1257 This subscribes to all versions of Codelist CODELIST1 maintained by the agency 1258 1258 1259 -//AGENCY1 1425 +AGENCY1 1426 + 1260 1260 AgencyID = AGENCY1 1428 + 1261 1261 Id = % 1262 -Version = %// 1263 1263 1431 +Version = % 1432 + 1264 1264 This subscribes to all versions of all Codelist objects maintained by the agency 1265 1265 1266 -//AGENCY1 1435 +AGENCY1 1436 + 1267 1267 AgencyID = % 1438 + 1268 1268 Id = CODELIST1 1269 -Version = %// 1270 1270 1441 +Version = % 1442 + 1271 1271 This subscribes to all versions of Codelist CODELIST1 maintained by the agency 1272 1272 1273 - //AGENCY1//1445 +AGENCY1 1274 1274 1275 1275 Note that if the subscription is to the latest version then this can be achieved by the * character 1276 1276 1277 - //i.e. Version = *//1449 +i.e. Version = * 1278 1278 1279 1279 Note that a subscription using the URN mechanism cannot use wildcard characters. 1280 1280 ... ... @@ -1286,15 +1286,16 @@ 1286 1286 1287 1287 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: 1288 1288 1289 -|(% style="width:405px" %)**Selector**|(% style="width:1467px" %)**Comment** 1290 -|(% style="width:405px" %)DataProvider|(% style="width:1467px" %)Any datasets or metadata sets registered by the specified data provider will activate the notification. 1291 -|(% style="width:405px" %)ProvisionAgreement|(% style="width:1467px" %)Any datasets or metadata sets registered for the provision agreement will activate the notification. 1292 -|(% style="width:405px" %)Dataflow (&Metadataflow)|(% style="width:1467px" %)Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification. 1293 -|(% 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 1294 -|(% style="width:405px" %)**Selector**|(% style="width:1467px" %)**Comment** 1295 -|(% style="width:405px" %) |(% style="width:1467px" %)activate the notification. 1296 -|(% 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. 1297 1297 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 + 1298 1298 The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration. 1299 1299 1300 1300 == 7.6 Notification == ... ... @@ -1301,10 +1301,8 @@ 1301 1301 1302 1302 === 7.6.1 Logical Class Diagram === 1303 1303 1304 -[[image:1747829675568-610.png]] 1305 1305 1306 -(% class="wikigeneratedid" id="HFigure20:LogicalClassDiagramoftheNotification" %) 1307 -**Figure 20: Logical Class Diagram of the Notification** 1478 +==== Figure 20: Logical Class Diagram of the Notification ==== 1308 1308 1309 1309 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. 1310 1310 ... ... @@ -1324,3 +1324,5 @@ 1324 1324 === 7.6.3 Registration Event Component === 1325 1325 1326 1326 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
- 1747832400104-286.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -xwiki:XWiki.helena - Size
-
... ... @@ -1,1 +1,0 @@ 1 -172.3 KB - Content