Last modified by Helena on 2025/09/10 11:19

From version 2.7
edited by Helena
on 2025/05/21 14:27
Change comment: There is no comment for this version
To version 7.2
edited by Helena
on 2025/05/21 16:36
Change comment: Update document after refactoring.

Summary

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,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 components 382 correspond conform to the definition in 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
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  
... ... @@ -330,7 +330,7 @@
330 330  Subscription management involves a user submitting a subscription request which contains:
331 331  
332 332  * 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).
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)
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)
334 334  * request for a list of submitted subscriptions
335 335  * deletion of a subscription
336 336  
... ... @@ -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:244px" %)**Interface**|**Behaviour**
344 -|(% style="width:244px" %)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: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|(((
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  
... ... @@ -469,9 +469,8 @@
469 469  
470 470  An example of this is shown in the XML snippet below.
471 471  
472 -[[image:1747824123013-196.jpeg||height="309" width="446"]]
467 +[[image:1747832400104-286.png]]
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  
... ... @@ -683,75 +683,48 @@
683 683  
684 684  > urn:sdmx.org.sdmx.infomodel.{package}.{classname}=
685 685  
686 -|**SDMX Class**|**Key attribute(s)**|**Example of URN**
687 -|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" %)(((
688 688  IMF
689 -
690 -
691 691  Sub agency in the IMF AGENCIES
692 -
693 -
694 694  IMF.SubAgency1
695 695  )))
696 -|*ConceptScheme|conceptSchemeAgencyId:conceptSchemeId(ve rsion)|SDMX:CROSS_DOMAIN_CONCEPTS(1.0)
697 -|Concept|(((
698 -conceptSchemeAgencyId:
699 -
700 -conceptSchemeId(version).conceptId
701 -)))|SDMX:CROSS_DOMAIN_CONCEPTS(1.0).FREQ
702 -|*Codelist|codeListAgencyId:codeListId(version)|SDMX:CL_FREQ(1.0)
703 -|Code|codeListAgencyId:codelistId(version).codeId|(((
704 -SDMX:CL_FREQ(1.0).Q
705 -
706 -
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" %))
707 707  )))
708 -
709 -
710 -
711 -|(((
712 -*Hierarchical
713 -
714 -Codelist
715 -)))|hierachicalCodelistAgencyId: hierarchicalCodelistId(version)|(((
716 -UNESCO:CL_EXP_SOURCE(1.0)
717 -
718 -
719 -)))
720 -|Hierarchy|(((
697 +|(% style="width:250px" %)Hierarchy|(% style="width:444px" %)(((
721 721  hierachicalcodeListAgencyId:
722 -
723 723  hierarchicalcodelistId(version).Hierarchy
724 -)))|UNESCO:CL_EXP_SOURCE(1.0). H-C-GOV
725 -|Level|(((
700 +)))|(% style="width:396px" %)UNESCO:CL_EXP_SOURCE(1.0).
701 +H-C-GOV
702 +|(% style="width:250px" %)Level|(% style="width:444px" %)(((
726 726  hierachicalcodeListAgencyId:
727 -
728 728  hierarchicalcodelistId(version).Hierarchy.Level
729 -)))|(((
705 +)))|(% style="width:396px" %)(((
730 730  ESTAT:HCL_REGION(1.0).H_1.COUNTRY
731 -
732 -
733 733  )))
734 -|HierarchicalCode|hierachicalCodeListAgencyId: hierarchicalcodelistId(version).hierarchy.hierarc hicalCode|UNESCO:CL_EXP_SOURCE(1.0). H-C-GOV.GOV_CODE1
735 -|*DataStructure|dataStructureDefintitionAgencyId: dataStructureDefintitionId(version)|TFFS:EXT_DEBT(1.0)
736 -|(((
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" %)(((
737 737  Dimension
738 -
739 739  Descriptor
740 -
741 741  Measure
742 -
743 743  Descriptor
744 -
745 745  Attribute
746 -
747 747  Descriptor
748 -)))|(((
717 +)))|(% style="width:444px" %)(((
749 749  dataStructureDefinitionAgencyId: dataStructureDefinitionId(version).
750 -
751 751  componentListId
752 -
753 753  where the componentListId is the name of the class (there is only one occurrence of each in the Data Structure Definition)
754 -)))|(((
721 +)))|(% style="width:396px" %)(((
755 755  TFFS:EXT_DEBT(1.0).DimensionDescriptor
756 756  
757 757  TFFS:EXT_DEBT(1.0).MeasureDescriptor
... ... @@ -758,181 +758,124 @@
758 758  
759 759  TFFS:EXT_DEBT(1.0).AttributeDescriptor
760 760  )))
761 -|(((
728 +|(% style="width:250px" %)(((
762 762  GroupDimension
763 -
764 764  Descriptor
765 -)))|(((
731 +)))|(% style="width:444px" %)(((
766 766  dataStructureDefinitionAgencyId: dataStructureDefinitionId(version).
767 -
768 768  groupDimensionDescriptorId
769 -)))|TFFS:EXT_DEBT(1.0).SIBLING
770 -|Dimension|(((
734 +)))|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).SIBLING
735 +|(% style="width:250px" %)Dimension|(% style="width:444px" %)(((
771 771  dataStructureDefinitionAgencyId: dataStructureDefinition (version).
772 -
773 773  dimensionId
774 -)))|TFFS:EXT_DEBT(1.0).FREQ
775 -|TimeDimension|(((
738 +)))|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).FREQ
739 +|(% style="width:250px" %)TimeDimension|(% style="width:444px" %)(((
776 776  dataStructureDefinitionAgencyId: dataStructureDefinition (version).
777 -
778 778  timeDimensionId
779 -)))|TFFS:EXT_DEBT(1.0).TIME_PERIOD
780 -|Measure Dimension|dataStructureDefinitionAgencyId: dataStructureDefinition (version).|TFFS:EXT_DEBT(1.0).STOCK_FLOW
781 -
782 -
783 -
784 -| |measureDimensionId|
785 -|DataAttrribute|dataStructureDefinitionAgencyId: dataStructureDefinition (version). dataAttributeId|TFFS:EXT_DEBT(1.0).OBS_STATUS
786 -|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" %)(((
787 787  dataStructureDefinitionAgencyId: dataStructureDefinition (version).
788 -
789 789  primaryMeasureId
790 -)))|TFFS:EXT_DEBT(1.0).OBS_VALUE
791 -|(((
792 -*Category
793 -
794 -Scheme
795 -)))|categorySchemeAgencyId: categorySchemeId(version)|IMF:SDDS(1.0)
796 -|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" %)(((
797 797  IMF:SDDS(1.0):
798 -
799 799  level_1_category.level_2_category …
800 800  )))
801 -|(((
802 -*Reporting
803 -
804 -Taxonomy
805 -)))|reportingTaxonomyAgencyId: reportingTaxonomyId(version)| IMF:REP_1(1.0)
806 -|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" %)(((
807 807  IMF:REP_1(1.0):
808 -
809 809  level_1_repcategory.level_2_repcategory …
810 810  )))
811 -|*Categorisation|categorisationAgencyId: categorisationId(version)|IMF:cat001(1.0)
812 -|(((
813 -*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)
814 814  
815 -Unit Scheme
816 -)))|organisationUnitSchemeAgencyId: organisationUnitSchemeId(version)|ECB:ORGANISATIONS(1.0)
817 -|Organisation Unit|organisationUnitSchemeAgencyId: organisationUnitSchemeId(version). organisationUnitId|ECB:ORGANISATIONS(1.0).1F
818 -|*AgencyScheme|agencySchemeAgencyId: agencySchemeId(version)|ECB:AGENCIES(1.0)
819 -
820 -
821 -
822 -|Agency|agencySchemeAgencyId: agencySchemeId(version). agencyId|ECB:AGENCY(1.0).AA
823 -|(((
824 -*DataProvider
825 -
826 -Scheme
827 -)))|dataProviderSchemeAgencyId: dataProviderSchemeId(version)|SDMX:DATA_PROVIDERS(1.0)
828 -|DataProvider|dataProviderSchemeAgencyId: dataProviderSchemeId(version) dataProviderId|SDMX:DATA_PROVIDERS(1.0).PROVIDER_1
829 -|(((
830 -*DataConsumer
831 -
832 -Scheme
833 -)))|dataConsumerSchemeAgencyId: dataConsumerSchemeId(version)|SDMX:DATA_CONSUMERS(1.0)
834 -|Data Consumer|dataConsumerSchemeAgencyId: dataConsumerSchemeId(version) dataConsumerId|SDMX:DATA_CONSUMERS(1.0).CONSUMER_1
835 -|(((
836 -*Metadata
837 -
838 -Structure
839 -)))|MSDAgencyId:MSDId(version)|IMF:SDDS_MSD(1.0)
840 -|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" %)(((
841 841  MSDAgencyId:
842 -
843 843  MSDId(version).metadataTargetId
844 -)))|IMF:SDDS_MSD(1.0).AGENCY
845 -|(((
789 +)))|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY
790 +|(% style="width:262px" %)(((
846 846  Dimension
847 -
848 848  DescriptorValues
849 -
850 850  Target
851 -)))|(((
794 +)))|(% style="width:369px" %)(((
852 852  MSDAgencyId: MSDId(version).
853 -
854 854  metadataTargetId.keyDescriptorValueTargetId
855 -)))|IMF:SDDS_MSD(1.0).AGENCY.KEY
856 -|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" %)(((
857 857  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
858 858  
859 -MSDId(version).metadataTargetId.identifiable
860 -
861 -ObjectTargetId
862 -)))|IMF:SDDS_MSD(1.0).AGENCY.STR-OBJECT
863 -|DataSetTarget|(((
864 -MSDAgencyId:
865 -
866 -MSDId(version).metadataTargetId.dataSet
867 -
868 -TargetId
869 -)))|IMF:SDDS_MSD(1.0).AGENCY.D1101
870 -|PeportPeriod Target|(((
871 -MSDAgencyId:
872 -
873 -MSDId(version).metadataTargetId.reportPeriod
874 -
875 -TargetId
876 -)))|IMF:SDDS_MSD(1.0).AGENCY.REP_PER
877 -
878 -
879 -
880 -|(((
809 +|(% style="width:251px" %)(((
881 881  ReportStructure
882 -
883 -
884 -)))|(((
885 -MSDAgencyId:
886 -
887 -MSDId(version).reportStructureId
888 -)))|IMF:SDDS_MSD(1.0).AGENCY_REPORT
889 -|(((
890 -Metadata
891 -
892 -Attribute
893 -)))|(((
894 -MSDAgencyId:
895 -
896 -MSDId(version).reportStructureId.metadataattri buteID
897 -)))|IMF:SDDS_MSD(1.0).AGENCY_REPORT.COMPILATION
898 -|*Dataflow|dataflowAgencyId: dataflowId(version)|TFFS:CRED_EXT_DEBT(1.0)
899 -|*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" %)(((
900 900  provisionAgreementAgencyId:provisionAgreem entId(version)
901 -
902 -
903 -)))|(((
822 +)))|(% style="width:1178px" %)(((
904 904  TFFS:CRED_EXT_DEBT_AB(1.0)
905 -
906 -
907 -
908 908  )))
909 -|(((
910 -*Content
911 -
912 -Constraint
913 -)))|constraintAgencyId:ContentConstraintId(versio n)|TFFS:CREDITOR_DATA_CONTENT(1.0)
914 -|(((
915 -*Attachment
916 -
917 -Constraint
918 -)))|(((
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" %)(((
919 919  constraintAgencyId:
920 920  
921 921  attachmentConstraintId(version)
922 -)))|TFFS:CREDITOR_DATA_ATTACHMENT_CONSTRAINT_ONE(1.0)
923 -|*Metadataflow|metadataflowAgencyId: metadataflowId(version)|IMF:SDDS_FLOW(1.0)
924 -|*StructureSet|structureSetAgencyId: structureSetId(version)|SDMX:BOP_STRUCTURES(1.0)
925 -|StructureMap|structureSetAgencyId: structureSetId(version). structureMapId|SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2
926 -|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" %)(((
927 927  structureSetAgencyId: structureSetId(version).
928 928  
929 929  structureMapId. componentMapId
930 -)))|SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2. REFAREA_REPCOUNTRY
931 -|CodelistMap|structureSetAgencyId: structureSetId(version). codelistMapId|SDMX:BOP_STRUCTURES(1.0).CLREFAREA_CLREPCOUNTRY
932 -|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
933 933  
934 -
935 -
936 936  | |(((
937 937  codeListMapId.
938 938  
... ... @@ -939,9 +939,7 @@
939 939  codeMapId
940 940  )))|
941 941  |(((
942 -Category
943 -
944 -SchemeMap
852 +CategorySchemeMap
945 945  )))|structureSetAgencyId: structureSetId(version). categorySchemeMapId|SDMX:BOP_STRUCTURES(1.0).SDMX_EUROSTAT
946 946  |CategoryMap|structureSetAgencyId: structureSetId(version). categorySchemeMapId. categoryMapId|SDMX:BOP_STRUCTURES(1.0).SDMX_EUROSTAT.TOURISM_M AP
947 947  |Organisation SchemeMap|structureSetAgencyId: structureSetId(version). organisationSchemeMapId|SDMX:BOP_STRUCTURES(1.0).DATA_PROVIDER_MAP
... ... @@ -955,71 +955,53 @@
955 955  structureSetAgencyId: structureSetId(version). conceptSchemeMapId.
956 956  
957 957  conceptMapId
958 -
959 959  
960 960  )))|SDMX:BOP_STRUCTURES(1.0).SDMX_OECD.COVERAGE_AVAI LABILITY
961 961  |(((
962 -Reporting
963 -
964 -TaxonomyMap
869 +ReportingTaxonomyMap
965 965  )))|structureSetAgencyId: structureSetId(version). reportingTaxonomyMapId|SDMX:BOP_STRUCTURES(1.0).TAXMAP
966 966  |(((
967 -Reporting
968 -
969 -CategoryMap
872 +ReportingCategoryMap
970 970  )))|(((
971 971  structureSetAgencyId: structureSetId(version).
972 -
973 973  reportngCategoryId
974 974  )))|SDMX:BOP_STRUCTURES(1.0).TAXMAP.TOPCAT
975 975  
976 -
977 -
978 978  |(((
979 -HybridCodelist
980 -
981 -Map
982 -)))|structureSetAgencyId: structureSetId(version). hybridCodelistMapId.|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP
879 +HybridCodelistMap
880 +)))|structureSetAgencyId: structureSetId(version).
881 +hybridCodelistMapId.|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP
983 983  |HybridCodeMap|structureSetAgencyId: structureSetId(version). hybridCodelistMapId. hybridCodeMapId|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP.CO DEMAP1
984 984  |*Process|processAgencyId: processId{version]|BIS:PROCESS1(1.0)
985 985  |ProcessStep|(((
986 986  processAgencyId: processId(version).
987 -
988 988  processStepId
989 989  )))|BIS:PROCESS1(1.0).STEP1
990 990  |Transition|(((
991 991  processAgencyId: processId(version).
992 -
993 993  processStepId transitionId
994 994  )))|BIS:PROCESS1(1.0).STEP1.TRANSITION1
995 995  |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.
996 996  |(((
997 -*Transformation
998 -
999 -Scheme
894 +*Transformation Scheme
1000 1000  )))|transformationSchemeAgencyId transformationSchemeId(version)|ECB: TRANSFORMATION_SCHEME(1.0)
1001 1001  |Transformation|(((
1002 1002  transformationSchemeAgencyId transformationSchemeId(version)
1003 -
1004 1004  transformationId
1005 1005  )))|ECB:TRANSFORMATION_SCHEME(1.0).TRANS_1
1006 1006  |CustomType Scheme|customTypeSchemeAgencyId customTypeSchemeId(version)|ECB:CUSTOM_TYPE_SCHEME(1.0)
1007 1007  
1008 -
1009 -
1010 1010  |CustomType|customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|ECB: CUSTOM_TYPE_SCHEME(1.0).CUSTOM_TYPE_1
1011 1011  |(((
1012 1012  Name
1013 -
1014 1014  Personalisation
1015 -
1016 1016  Scheme
1017 1017  )))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|ECB:PSN_SCHEME(1.0)
1018 1018  |(((
1019 1019  Name
1020 -
1021 1021  Personalisation
1022 -)))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|ECB:PSN_SCHEME(1.0).PSN1234
911 +)))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)
912 +namePersonalisationId|ECB:PSN_SCHEME(1.0).PSN1234
1023 1023  |VtlMapping Scheme|vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|ECB:CLIST_MP(2.0)
1024 1024  |VtlCodelist Mapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|ECB:CLIST_MP(2.0).ABZ
1025 1025  |VtlConcept Mapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|ECB:CLIST_MP(1.0).XYA
... ... @@ -1032,15 +1032,12 @@
1032 1032  |RulesetScheme|rulesetSchemeAgencyId rulesetSchemeId(version)|ECB:RULESET_23(1.0)
1033 1033  |Ruleset|rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|ECB:RULESET_23(1.0).SET111
1034 1034  |(((
1035 -UserDefined
1036 -
1037 -OperatorScheme
925 +UserDefinedOperatorScheme
1038 1038  )))|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|ECB:OS_CALC(1.2)
1039 1039  |UserDefined Operator|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|ECB:OS_CALC(1.2).OS267
1040 1040  
1041 -7**Table 3: Table of identification components for SDMX Identifiable Artefacts**
929 +**Table 3: Table of identification components for SDMX Identifiable Artefacts**
1042 1042  
1043 -
1044 1044  = 7 Implementation Notes =
1045 1045  
1046 1046  == 7.1 Structural Definition Metadata ==
... ... @@ -1061,109 +1061,72 @@
1061 1061  
1062 1062  The following table lists the Maintainable Artefacts.
1063 1063  
1064 -|(% colspan="4" %)**Maintainable Artefacts**|(% colspan="2" %)**Content**|
1065 -|(% colspan="2" %)**Abstract Class**|(% colspan="2" %)**Concrete Class**|(% colspan="2" %) |
1066 -|(% colspan="2" %)Item Scheme|(% colspan="2" %)Codelist|(% colspan="2" %)Code|
1067 -|(% colspan="2" %) |(% colspan="2" %)Concept Scheme|(% colspan="2" %)Concept|
1068 -|(% colspan="2" %) |(% colspan="2" %)Category Scheme|(% colspan="2" %)Category|
1069 -|(% colspan="2" %) |(% colspan="2" %)Organisation Unit Scheme|(% colspan="2" %)Organisation Unit|
1070 -|(% colspan="2" %) |(% colspan="2" %)Agency Scheme|(% colspan="2" %)Agency|
1071 -|(% colspan="2" %) |(% colspan="2" %)Data Provider Scheme|(% colspan="2" %)Data Provider|
1072 -|(% colspan="2" %) |(% colspan="2" %)Data Consumer Scheme|(% colspan="2" %)Data Consumer|
1073 -|(% colspan="2" %) |(% colspan="2" %)Reporting Taxonomy|(% colspan="2" %)Reporting Category|
1074 -|(% colspan="2" %) |(% colspan="2" %)Transformation Scheme|(% colspan="2" %)Transformation|
1075 -|(% colspan="2" %) |(% colspan="2" %)Custom Type Scheme|(% colspan="2" %)Custom Type|
1076 -| |(% colspan="4" %)**Maintainable Artefacts**|(% colspan="2" %)**Content**
1077 -| |(% colspan="2" %)**Abstract Class**|(% colspan="2" %)**Concrete Class**|(% colspan="2" %)
1078 -| |(% colspan="2" %) |(% colspan="2" %)Name Personalisation Scheme|(% colspan="2" %)Name Personalisation
1079 -| |(% colspan="2" %) |(% colspan="2" %)Vtl Mapping Scheme|(% colspan="2" %)Vtl Codelist Mapping
1080 -| |(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)Vtl Concept Mapping
1081 -| |(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)Vtl Dataflow Mapping
1082 -| |(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)(((
1083 -Vtl Concept Scheme
1084 -
1085 -Mapping
1086 -)))
1087 -| |(% colspan="2" %) |(% colspan="2" %)Ruleset Scheme|(% colspan="2" %)Ruleset
1088 -| |(% colspan="2" %) |(% colspan="2" %)User Defined Operator Scheme|(% colspan="2" %)User Defined Operator
1089 -| |(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
1090 -| |(% colspan="2" %)Structure|(% colspan="2" %)Data Structure Definition|(% colspan="2" %)(((
951 +(% style="width:640.294px" %)
952 +|(% colspan="2" rowspan="1" style="width:186px" %)**Maintainable Artefacts**|(% style="width:206px" %)**Content**
953 +|(% style="width:171px" %)**Abstract Class**|(% style="width:232px" %)**Concrete Class**|(% style="width:206px" %)
954 +|(% style="width:171px" %)Item Scheme|(% style="width:232px" %)Codelist|(% style="width:206px" %)Code
955 +|(% style="width:171px" %) |(% style="width:232px" %)Concept Scheme|(% style="width:206px" %)Concept
956 +|(% style="width:171px" %) |(% style="width:232px" %)Category Scheme|(% style="width:206px" %)Category
957 +|(% style="width:171px" %) |(% style="width:232px" %)Organisation Unit Scheme|(% style="width:206px" %)Organisation Unit
958 +|(% style="width:171px" %) |(% style="width:232px" %)Agency Scheme|(% style="width:206px" %)Agency
959 +|(% style="width:171px" %) |(% style="width:232px" %)Data Provider Scheme|(% style="width:206px" %)Data Provider
960 +|(% style="width:171px" %) |(% style="width:232px" %)Data Consumer Scheme|(% style="width:206px" %)Data Consumer
961 +|(% style="width:171px" %) |(% style="width:232px" %)Reporting Taxonomy|(% style="width:206px" %)Reporting Category
962 +|(% style="width:171px" %) |(% style="width:232px" %)Transformation Scheme|(% style="width:206px" %)Transformation
963 +|(% style="width:171px" %) |(% style="width:232px" %)Custom Type Scheme|(% style="width:206px" %)Custom Type
964 +|(% style="width:171px" %) |(% style="width:232px" %)Name Personalisation Scheme|(% style="width:206px" %)Name Personalisation
965 +|(% style="width:171px" %) |(% style="width:232px" %)Vtl Mapping Scheme|(% style="width:206px" %)Vtl Codelist Mapping
966 +|(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)Vtl Dataflow Mapping
967 +|(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)Vtl Concept Scheme Mapping
968 +|(% style="width:171px" %) |(% style="width:232px" %)Ruleset Scheme|(% style="width:206px" %)Ruleset
969 +|(% style="width:171px" %) |(% style="width:232px" %)User Defined Operator Scheme|(% style="width:206px" %)User Defined Operator
970 +|(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)User Defined Operator
971 +|(% style="width:171px" %)Structure|(% style="width:232px" %)Data Structure Definition|(% style="width:206px" %)(((
1091 1091  Dimension Descriptor
1092 -
1093 1093  Group Dimension
1094 -
1095 1095  Descriptor
1096 -
1097 1097  Dimension
1098 -
1099 1099  Measure Dimension
1100 -
1101 1101  Time Dimension
1102 -
1103 1103  Attribute Descriptor
1104 -
1105 1105  Data Attribute
1106 -
1107 1107  Measure Descriptor
1108 -
1109 1109  Primary Measure
1110 1110  )))
1111 -| |(% colspan="2" %) |(% colspan="2" %)Metadata Structure Definition|(% colspan="2" %)(((
1112 -Metadata Target,
1113 -
1114 -Dimension Descriptor
1115 -
983 +|(% style="width:171px" %) |(% style="width:232px" %)Metadata Structure Definition|(% style="width:206px" %)(((
984 +Metadata Target, Dimension Descriptor
1116 1116  Values Target Identifiable
1117 -
1118 1118  Object Target
1119 -
1120 1120  Report Period Target
1121 -
1122 1122  Data SetTarget
1123 -
1124 1124  Report Structure
1125 -
1126 1126  Metadata Attribute
1127 1127  )))
1128 -| |(% colspan="2" %)Structure Usage|(% colspan="2" %)Dataflow Definition|(% colspan="2" %)
1129 -| |(% colspan="2" %) |(% colspan="2" %)Metadataflow Definition|(% colspan="2" %)
1130 -| |(% colspan="2" %)None|(% colspan="2" %)Process|(% colspan="2" %)Process Step
1131 -| |(% colspan="2" %)None|(% colspan="2" %)Structure Set|(% colspan="2" %)(((
992 +|(% style="width:171px" %)Structure Usage|(% style="width:232px" %)Dataflow Definition|(% style="width:206px" %)
993 +|(% style="width:171px" %) |(% style="width:232px" %)Metadataflow Definition|(% style="width:206px" %)
994 +|(% style="width:171px" %)None|(% style="width:232px" %)Process|(% style="width:206px" %)Process Step
995 +|(% style="width:171px" %)None|(% style="width:232px" %)Structure Set|(% style="width:206px" %)(((
1132 1132  Component Map
1133 -
1134 1134  Concept Scheme Map
1135 -
1136 1136  Codelist Map
1137 -
1138 1138  Category Scheme Map
1139 -
1140 1140  Reporting Taxonomy Map
1141 -
1142 1142  Organisation Scheme Map
1143 -
1144 1144  Concept Map
1145 -
1146 1146  Code Map
1147 -
1148 1148  Category Map
1149 -
1150 1150  Organisation Map
1151 -
1152 1152  Reporting Category Map
1153 -
1154 1154  Hybrid Codelist Map
1155 -
1156 1156  Hybrid Code Map
1157 1157  )))
1158 -| |(% colspan="2" %)None|(% colspan="2" %)Provision Agreement|(% colspan="2" %)
1159 -| |(% colspan="2" %)None|(% colspan="2" %)Hierarchical Codelist|(% colspan="2" %)(((
1010 +|(% style="width:171px" %)None|(% style="width:232px" %)Provision Agreement|(% style="width:206px" %)
1011 +|(% style="width:171px" %)None|(% style="width:232px" %)Hierarchical Codelist|(% style="width:206px" %)(((
1160 1160  Hierarchy
1161 -
1162 1162  Hierarchical Code
1163 1163  )))
1164 -| | | | | | |
1165 1165  
1166 -**Table 4: Table of Maintainable Artefacts for Structural Definition Metadata**
1016 +**able 4: Table of Maintainable Artefacts for Structural Definition Metadata**
1167 1167  
1168 1168  === 7.1.2 Item Scheme, Structure ===
1169 1169  
... ... @@ -1170,10 +1170,7 @@
1170 1170  The artefacts included in the structural definitions are:
1171 1171  
1172 1172  * All types of Item Scheme (Codelist, Concept Scheme, Category Scheme, Organisation Scheme - Agency Scheme, Data Provider Scheme, Data Consumer Scheme, Organisation Unit Scheme)
1173 -* All types of Structure (Data Structure Definition, Metadata Structure
1174 -
1175 -Definition)
1176 -
1023 +* All types of Structure (Data Structure Definition, Metadata Structure Definition)
1177 1177  * All types of Structure Usage (Dataflow Definition, Metadataflow Definition)
1178 1178  
1179 1179  === 7.1.3 Structure Usage ===
... ... @@ -1192,6 +1192,8 @@
1192 1192  
1193 1193  ==== 7.1.3.3 Structure Usage Model ====
1194 1194  
1042 +[[image:1747829078194-749.png]]
1043 +
1195 1195  **Figure 10: SDMX-IM of links from Structure Usage to Category**
1196 1196  
1197 1197  In addition to the maintenance of the Dataflow Definition and the Metadataflow Definition the following links must be maintained in the registry:
... ... @@ -1218,10 +1218,10 @@
1218 1218  
1219 1219  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.
1220 1220  
1070 +[[image:1747829109466-595.png]]
1221 1221  
1222 1222  **Figure 11: SDMX-IM of the Data Provider**
1223 1223  
1224 -
1225 1225  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
1226 1226  
1227 1227  [[image:1747824123019-181.jpeg]]
... ... @@ -1230,8 +1230,10 @@
1230 1230  
1231 1231  The diagram below is a logical representation of the data required in order to maintain Provision Agreements.
1232 1232  
1082 +[[image:1747829139951-378.png]]
1233 1233  
1234 -==== Figure 13: Logical class diagram of the information contained in the Provision Agreement ====
1084 +(% class="wikigeneratedid" id="HFigure13:LogicalclassdiagramoftheinformationcontainedintheProvisionAgreement" %)
1085 +**Figure 13: Logical class diagram of the information contained in the Provision Agreement**
1235 1235  
1236 1236  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.
1237 1237  
... ... @@ -1259,13 +1259,12 @@
1259 1259  
1260 1260  === 7.3.3 Data and Metadata Constraints: Model ===
1261 1261  
1113 +[[image:1747829204737-370.png]]
1262 1262  
1115 +**Figure 15: Logical class diagram showing inheritance between and reference to constrainable artifacts**
1263 1263  
1264 -==== Figure 15: Logical class diagram showing inheritance between and reference to constrainable artifacts ====
1117 +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.
1265 1265  
1266 -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.
1267 -
1268 -
1269 1269  The content of the Constraint can be found in the SDMX Information Model document.
1270 1270  
1271 1271  == 7.4 Data and Metadata Registration ==
... ... @@ -1286,7 +1286,7 @@
1286 1286  
1287 1287  [[image:1747824123025-411.jpeg]]
1288 1288  
1289 - **Figure 16: Schematic of the Objects Concerned with Registration**
1139 +**Figure 16: Schematic of the Objects Concerned with Registration**
1290 1290  
1291 1291  ==== 7.4.2.2 Registration Request Model ====
1292 1292  
... ... @@ -1300,11 +1300,14 @@
1300 1300  
1301 1301  The Registration has an action attribute which takes one of the following values:
1302 1302  
1303 -|**Action Attribute Value**|**Behaviour**
1304 -|Append|Add this Registration to the registry
1305 -|Replace|Replace the existing Registration with identified by the id in the Registration of the Submit Registration Request
1306 -|Delete|Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
1153 +(% style="width:970.294px" %)
1154 +|(% style="width:212px" %)**Action Attribute Value**|(% style="width:756px" %)**Behaviour**
1155 +|(% style="width:212px" %)Append|(% style="width:756px" %)Add this Registration to the registry
1156 +|(% style="width:212px" %)Replace|(% style="width:756px" %)Replace the existing Registration with identified by the id in the Registration of the Submit Registration Request
1157 +|(% style="width:212px" %)Delete|(% style="width:756px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
1307 1307  
1159 +[[image:1747829290890-122.png]]
1160 +
1308 1308  **Figure 17: Logical Class Diagram of Registration of Data and Metadata**
1309 1309  
1310 1310  The Query Datasource is an abstract class that represents a data source which can understand an SDMX-ML query (SOAPDatasource) or RESTful query
... ... @@ -1319,25 +1319,19 @@
1319 1319  
1320 1320  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.
1321 1321  
1322 -|**Indexing Required**|**Registration Process Activity**
1323 -|indexTimeSeries|Extract all the series keys and create a KeySet(s) Constraint.
1324 -|indexDataSet|(((
1325 -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
1326 -
1327 -Regions containing Member Selections of Dimension Components of the Constraints model in the SDMX-IM, and the associated Selection Value.
1175 +|(% style="width:185px" %)**Indexing Required**|(% style="width:1686px" %)**Registration Process Activity**
1176 +|(% style="width:185px" %)indexTimeSeries|(% style="width:1686px" %)Extract all the series keys and create a KeySet(s) Constraint.
1177 +|(% style="width:185px" %)indexDataSet|(% style="width:1686px" %)(((
1178 +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.
1328 1328  )))
1329 -|indexReportingPeriod|(((
1180 +|(% style="width:185px" %)indexReportingPeriod|(% style="width:1686px" %)(((
1330 1330  This applies only to a registered dataset.
1331 -
1332 1332  Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint.
1333 1333  )))
1334 -|indexAttributes|(((
1184 +|(% style="width:185px" %)indexAttributes|(% style="width:1686px" %)(((
1335 1335  **Data Set**
1336 -
1337 1337  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
1338 -
1339 1339  **Metadata Set**
1340 -
1341 1341  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.
1342 1342  )))
1343 1343  
... ... @@ -1347,14 +1347,13 @@
1347 1347  
1348 1348  === 7.4.3 Registration Response ===
1349 1349  
1350 -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
1197 +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 1351  
1352 -“Success”, “Warning” or “Failure”.
1353 -
1354 1354  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.
1355 1355  
1356 1356  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:
1357 1357  
1203 +[[image:1747829477882-750.png]]
1358 1358  
1359 1359  **Figure 18: Logical class diagram showing the registration response**
1360 1360  
... ... @@ -1364,15 +1364,12 @@
1364 1364  
1365 1365  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.
1366 1366  
1367 -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
1213 +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 1368  
1369 -notification”.
1215 +=== 7.5.1Subscription Logical Class Diagram ===
1370 1370  
1371 - 7.5.1Subscription Logical Class Diagram
1217 +[[image:1747829554603-150.png]]
1372 1372  
1373 -
1374 -[[image:1747824123028-257.png]]
1375 -
1376 1376  **Figure 19: Logical Class Diagram of the Subscription**
1377 1377  
1378 1378  === 7.5.2 Subscription Information ===
... ... @@ -1379,73 +1379,58 @@
1379 1379  
1380 1380  Regardless of the type of registry/repository events being observed, a subscription always contains:
1381 1381  
1382 -~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.
1225 +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.
1226 +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.
1227 +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.
1228 +1. A selector which specifies which type of events are of interest. The set of event types is:
1383 1383  
1384 -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.
1230 +|(% style="width:319px" %)**Event Type**|(% style="width:1553px" %)**Comment**
1231 +|(% style="width:319px" %)STRUCTURAL_REPOSITORY_EVENTS|(% style="width:1553px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1232 +|(% 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.
1233 +|(% 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.
1234 +|(% style="width:319px" %)ALL_EVENTS|(% style="width:1553px" %)All events of the specified EventType
1385 1385  
1386 -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.
1387 -
1388 -4. A selector which specifies which type of events are of interest. The set of event types is:
1389 -
1390 -|**Event Type**|**Comment**
1391 -|STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1392 -|DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
1393 -|METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
1394 -|ALL_EVENTS|All events of the specified EventType
1395 -
1396 1396  === 7.5.3 Wildcard Facility ===
1397 1397  
1398 1398  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:
1399 1399  
1400 - agencyID
1240 +* agencyID
1241 +* id
1242 +* version
1401 1401  
1402 - id
1403 -
1404 - version
1405 -
1406 1406  Examples of wildcarded identifier components for an identified object type of Codelist are shown below.
1407 1407  
1408 -AgencyID = %
1409 -
1246 +//AgencyID = %
1410 1410  Id = %
1248 +Version = %//
1411 1411  
1412 -Version = %
1413 -
1414 1414  This subscribes to all Codelists of all versions for all agencies.
1415 1415  
1416 -AgencyID = AGENCY1
1417 -
1252 +//AgencyID = AGENCY1
1418 1418  Id = CODELIST1
1254 +Version = %//
1419 1419  
1420 -Version = %
1421 -
1422 1422  This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1423 1423  
1424 -AGENCY1
1425 -
1258 +//AGENCY1
1426 1426  AgencyID = AGENCY1
1427 -
1428 1428  Id = %
1261 +Version = %//
1429 1429  
1430 -Version = %
1431 -
1432 1432  This subscribes to all versions of all Codelist objects maintained by the agency
1433 1433  
1434 -AGENCY1
1435 -
1265 +//AGENCY1
1436 1436  AgencyID = %
1437 -
1438 1438  Id = CODELIST1
1268 +Version = %//
1439 1439  
1440 -Version = %
1441 -
1442 1442  This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1443 1443  
1444 -AGENCY1
1272 +//AGENCY1//
1445 1445  
1446 1446  Note that if the subscription is to the latest version then this can be achieved by the * character
1447 1447  
1448 -i.e. Version = *
1276 +//i.e. Version = *//
1449 1449  
1450 1450  Note that a subscription using the URN mechanism cannot use wildcard characters.
1451 1451  
... ... @@ -1457,16 +1457,15 @@
1457 1457  
1458 1458  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:
1459 1459  
1288 +|(% style="width:405px" %)**Selector**|(% style="width:1467px" %)**Comment**
1289 +|(% style="width:405px" %)DataProvider|(% style="width:1467px" %)Any datasets or metadata sets registered by the specified data provider will activate the notification.
1290 +|(% style="width:405px" %)ProvisionAgreement|(% style="width:1467px" %)Any datasets or metadata sets registered for the provision agreement will activate the notification.
1291 +|(% style="width:405px" %)Dataflow (&Metadataflow)|(% style="width:1467px" %)Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
1292 +|(% 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
1293 +|(% style="width:405px" %)**Selector**|(% style="width:1467px" %)**Comment**
1294 +|(% style="width:405px" %) |(% style="width:1467px" %)activate the notification.
1295 +|(% 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.
1460 1460  
1461 -|**Selector**|**Comment**
1462 -|DataProvider|Any datasets or metadata sets registered by the specified data provider will activate the notification.
1463 -|ProvisionAgreement|Any datasets or metadata sets registered for the provision agreement will activate the notification.
1464 -|Dataflow (&Metadataflow)|Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
1465 -|DataStructureDefinition & MetadataStructureDefinition|Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will
1466 -|**Selector**|**Comment**
1467 -| |activate the notification.
1468 -|Category|Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category.
1469 -
1470 1470  The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration.
1471 1471  
1472 1472  == 7.6 Notification ==
... ... @@ -1473,8 +1473,10 @@
1473 1473  
1474 1474  === 7.6.1 Logical Class Diagram ===
1475 1475  
1303 +[[image:1747829675568-610.png]]
1476 1476  
1477 -==== Figure 20: Logical Class Diagram of the Notification ====
1305 +(% class="wikigeneratedid" id="HFigure20:LogicalClassDiagramoftheNotification" %)
1306 +**Figure 20: Logical Class Diagram of the Notification**
1478 1478  
1479 1479  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.
1480 1480  
... ... @@ -1494,5 +1494,3 @@
1494 1494  === 7.6.3 Registration Event Component ===
1495 1495  
1496 1496  The notification will contain the Registration.
1497 -
1498 -
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
1747832400104-286.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +172.3 KB
Content