Skip to Content
Last modified by Helena on 2025/09/10 11:19
From version 9.2
edited by Helena
on 2025/05/23 12:58
Change comment: There is no comment for this version
To version 2.10
edited by Helena
on 2025/05/21 15:00
Change comment: There is no comment for this version

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,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:227px" %)**Interface**|(% style="width:1644px" %)**Behaviour**
340 -|(% style="width:227px" %)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: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" %)(((
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  )))
... ... @@ -427,8 +427,6 @@
427 427  
428 428  The Maintenance Agency in SDMX is maintained in an Agency Scheme which itself is a sub class of Organisation Scheme – this is shown in the class diagram below.
429 429  
430 -[[image:1747994320263-112.png]]
431 -
432 432  **Figure 6: Agency Scheme Model**
433 433  
434 434  The Agency in SDMX is extremely important. The Agency Id system used in SDMX is an n-level structure. The top level of this structure is maintained by SDMX. Any Agency in this top level can declare sub agencies and any sub agency can also declare sub agencies. The Agency Scheme has a fixed id and version and is never declared explicitly in the SDMX object identification mechanism.
... ... @@ -450,8 +450,7 @@
450 450  
451 451  [[image:1747824123012-527.jpeg]]
452 452  
453 -*
454 -** Figure 7: Example of Hierarchic Structure of Agencies
457 +==== Figure 7: Example of Hierarchic Structure of Agencies ====
455 455  
456 456  The following organizations maintain an Agency Scheme.
457 457  
... ... @@ -466,8 +466,9 @@
466 466  
467 467  An example of this is shown in the XML snippet below.
468 468  
469 -[[image:1747832400104-286.png]]
472 +[[image:1747824123013-196.jpeg||height="309" width="446"]]
470 470  
474 +(% class="wikigeneratedid" id="HFigure8:ExampleShowingUseofAgencyIdentifiers" %)
471 471  **Figure 8: Example Showing Use of Agency Identifiers**
472 472  
473 473  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.
... ... @@ -480,14 +480,13 @@
480 480  
481 481  ==== 6.2.2.2 URN Structure ====
482 482  
483 -(% class="wikigeneratedid" id="HCaseRulesforURN" %)
484 -//Case Rules for URN//
487 +===== //Case Rules for URN// =====
485 485  
486 486  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.
487 487  
488 488  The generic structure of the URN is as follows:
489 489  
490 ->SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobject-id(maintainedobject-version).*containerobject-id.object-id
493 +SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobject-id(maintainedobject-version).*containerobject-id.object-id
491 491  
492 492  ~* this can repeat and may not be present (see explanation below)
493 493  
... ... @@ -499,7 +499,7 @@
499 499  
500 500  In the explanation below the actual object that is the target of the URN is called the **//actual object//**.
501 501  
502 -**SDMXPrefix:** urn:sdmx:org.
505 +**SDMXPrefix:** urn:sdmx:org.                                     
503 503  
504 504  **SDMX-IM package name:** sdmx.infomodel.package=
505 505  
... ... @@ -707,6 +707,8 @@
707 707  hierarchicalcodelistId(version).Hierarchy.Level
708 708  )))|(% style="width:396px" %)(((
709 709  ESTAT:HCL_REGION(1.0).H_1.COUNTRY
713 +
714 +
710 710  )))
711 711  |(% 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
712 712  |(% style="width:250px" %)*DataStructure|(% style="width:444px" %)dataStructureDefintitionAgencyId: dataStructureDefintitionId(version)|(% style="width:396px" %)TFFS:EXT_DEBT(1.0)
... ... @@ -811,11 +811,15 @@
811 811  
812 812  |(% style="width:251px" %)(((
813 813  ReportStructure
819 +
820 +
814 814  )))|(% style="width:442px" %)(((
815 815  MSDAgencyId: MSDId(version).reportStructureId
816 816  )))|(% style="width:1178px" %)IMF:SDDS_MSD(1.0).AGENCY_REPORT
817 817  |(% style="width:251px" %)(((
818 -Metadata Attribute
825 +Metadata
826 +
827 +Attribute
819 819  )))|(% style="width:442px" %)(((
820 820  MSDAgencyId: MSDId(version).reportStructureId.metadataattri buteID
821 821  )))|(% style="width:1178px" %)IMF:SDDS_MSD(1.0).AGENCY_REPORT.COMPILATION
... ... @@ -826,10 +826,14 @@
826 826  TFFS:CRED_EXT_DEBT_AB(1.0)
827 827  )))
828 828  |(% style="width:251px" %)(((
829 -*Content Constraint
838 +*Content
839 +
840 +Constraint
830 830  )))|(% style="width:442px" %)constraintAgencyId:ContentConstraintId(versio n)|(% style="width:1178px" %)TFFS:CREDITOR_DATA_CONTENT(1.0)
831 831  |(% style="width:251px" %)(((
832 -*Attachment Constraint
843 +*Attachment
844 +
845 +Constraint
833 833  )))|(% style="width:442px" %)(((
834 834  constraintAgencyId:
835 835  
... ... @@ -852,7 +852,9 @@
852 852  codeMapId
853 853  )))|
854 854  |(((
855 -CategorySchemeMap
868 +Category
869 +
870 +SchemeMap
856 856  )))|structureSetAgencyId: structureSetId(version). categorySchemeMapId|SDMX:BOP_STRUCTURES(1.0).SDMX_EUROSTAT
857 857  |CategoryMap|structureSetAgencyId: structureSetId(version). categorySchemeMapId. categoryMapId|SDMX:BOP_STRUCTURES(1.0).SDMX_EUROSTAT.TOURISM_M AP
858 858  |Organisation SchemeMap|structureSetAgencyId: structureSetId(version). organisationSchemeMapId|SDMX:BOP_STRUCTURES(1.0).DATA_PROVIDER_MAP
... ... @@ -866,53 +866,71 @@
866 866  structureSetAgencyId: structureSetId(version). conceptSchemeMapId.
867 867  
868 868  conceptMapId
884 +
869 869  
870 870  )))|SDMX:BOP_STRUCTURES(1.0).SDMX_OECD.COVERAGE_AVAI LABILITY
871 871  |(((
872 -ReportingTaxonomyMap
888 +Reporting
889 +
890 +TaxonomyMap
873 873  )))|structureSetAgencyId: structureSetId(version). reportingTaxonomyMapId|SDMX:BOP_STRUCTURES(1.0).TAXMAP
874 874  |(((
875 -ReportingCategoryMap
893 +Reporting
894 +
895 +CategoryMap
876 876  )))|(((
877 877  structureSetAgencyId: structureSetId(version).
898 +
878 878  reportngCategoryId
879 879  )))|SDMX:BOP_STRUCTURES(1.0).TAXMAP.TOPCAT
880 880  
902 +
903 +
881 881  |(((
882 -HybridCodelistMap
883 -)))|structureSetAgencyId: structureSetId(version).
884 -hybridCodelistMapId.|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP
905 +HybridCodelist
906 +
907 +Map
908 +)))|structureSetAgencyId: structureSetId(version). hybridCodelistMapId.|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP
885 885  |HybridCodeMap|structureSetAgencyId: structureSetId(version). hybridCodelistMapId. hybridCodeMapId|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP.CO DEMAP1
886 886  |*Process|processAgencyId: processId{version]|BIS:PROCESS1(1.0)
887 887  |ProcessStep|(((
888 888  processAgencyId: processId(version).
913 +
889 889  processStepId
890 890  )))|BIS:PROCESS1(1.0).STEP1
891 891  |Transition|(((
892 892  processAgencyId: processId(version).
918 +
893 893  processStepId transitionId
894 894  )))|BIS:PROCESS1(1.0).STEP1.TRANSITION1
895 895  |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.
896 896  |(((
897 -*Transformation Scheme
923 +*Transformation
924 +
925 +Scheme
898 898  )))|transformationSchemeAgencyId transformationSchemeId(version)|ECB: TRANSFORMATION_SCHEME(1.0)
899 899  |Transformation|(((
900 900  transformationSchemeAgencyId transformationSchemeId(version)
929 +
901 901  transformationId
902 902  )))|ECB:TRANSFORMATION_SCHEME(1.0).TRANS_1
903 903  |CustomType Scheme|customTypeSchemeAgencyId customTypeSchemeId(version)|ECB:CUSTOM_TYPE_SCHEME(1.0)
904 904  
934 +
935 +
905 905  |CustomType|customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|ECB: CUSTOM_TYPE_SCHEME(1.0).CUSTOM_TYPE_1
906 906  |(((
907 907  Name
939 +
908 908  Personalisation
941 +
909 909  Scheme
910 910  )))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|ECB:PSN_SCHEME(1.0)
911 911  |(((
912 912  Name
946 +
913 913  Personalisation
914 -)))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)
915 -namePersonalisationId|ECB:PSN_SCHEME(1.0).PSN1234
948 +)))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|ECB:PSN_SCHEME(1.0).PSN1234
916 916  |VtlMapping Scheme|vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|ECB:CLIST_MP(2.0)
917 917  |VtlCodelist Mapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|ECB:CLIST_MP(2.0).ABZ
918 918  |VtlConcept Mapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|ECB:CLIST_MP(1.0).XYA
... ... @@ -925,11 +925,13 @@
925 925  |RulesetScheme|rulesetSchemeAgencyId rulesetSchemeId(version)|ECB:RULESET_23(1.0)
926 926  |Ruleset|rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|ECB:RULESET_23(1.0).SET111
927 927  |(((
928 -UserDefinedOperatorScheme
961 +UserDefined
962 +
963 +OperatorScheme
929 929  )))|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|ECB:OS_CALC(1.2)
930 930  |UserDefined Operator|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|ECB:OS_CALC(1.2).OS267
931 931  
932 -**Table 3: Table of identification components for SDMX Identifiable Artefacts**
967 +7**Table 3: Table of identification components for SDMX Identifiable Artefacts**
933 933  
934 934  = 7 Implementation Notes =
935 935  
... ... @@ -992,31 +992,49 @@
992 992  Report Structure
993 993  Metadata Attribute
994 994  )))
995 -|(% style="width:171px" %)Structure Usage|(% style="width:232px" %)Dataflow Definition|(% style="width:206px" %)
996 -|(% style="width:171px" %) |(% style="width:232px" %)Metadataflow Definition|(% style="width:206px" %)
997 -|(% style="width:171px" %)None|(% style="width:232px" %)Process|(% style="width:206px" %)Process Step
998 -|(% style="width:171px" %)None|(% style="width:232px" %)Structure Set|(% style="width:206px" %)(((
1030 +|(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)
1031 +|(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)
1032 +
1033 +(% style="width:1644.71px" %)
1034 +|(% colspan="2" style="width:213px" %)Structure Usage|(% colspan="2" style="width:1193px" %)Dataflow Definition|(% colspan="2" style="width:234.418px" %)
1035 +|(% colspan="2" style="width:213px" %) |(% colspan="2" style="width:1193px" %)Metadataflow Definition|(% colspan="2" style="width:234.418px" %)
1036 +|(% colspan="2" style="width:213px" %)None|(% colspan="2" style="width:1193px" %)Process|(% colspan="2" style="width:234.418px" %)Process Step
1037 +|(% colspan="2" style="width:213px" %)None|(% colspan="2" style="width:1193px" %)Structure Set|(% colspan="2" style="width:234.418px" %)(((
999 999  Component Map
1039 +
1000 1000  Concept Scheme Map
1041 +
1001 1001  Codelist Map
1043 +
1002 1002  Category Scheme Map
1045 +
1003 1003  Reporting Taxonomy Map
1047 +
1004 1004  Organisation Scheme Map
1049 +
1005 1005  Concept Map
1051 +
1006 1006  Code Map
1053 +
1007 1007  Category Map
1055 +
1008 1008  Organisation Map
1057 +
1009 1009  Reporting Category Map
1059 +
1010 1010  Hybrid Codelist Map
1061 +
1011 1011  Hybrid Code Map
1012 1012  )))
1013 -|(% style="width:171px" %)None|(% style="width:232px" %)Provision Agreement|(% style="width:206px" %)
1014 -|(% style="width:171px" %)None|(% style="width:232px" %)Hierarchical Codelist|(% style="width:206px" %)(((
1064 +|(% colspan="2" style="width:213px" %)None|(% colspan="2" style="width:1193px" %)Provision Agreement|(% colspan="2" style="width:234.418px" %)
1065 +|(% colspan="2" style="width:213px" %)None|(% colspan="2" style="width:1193px" %)Hierarchical Codelist|(% colspan="2" style="width:234.418px" %)(((
1015 1015  Hierarchy
1067 +
1016 1016  Hierarchical Code
1017 1017  )))
1070 +|(% style="width:86px" %) |(% style="width:127px" %) |(% style="width:426px" %) |(% style="width:767.58px" %) | |(% style="width:1.41771px" %)
1018 1018  
1019 -**able 4: Table of Maintainable Artefacts for Structural Definition Metadata**
1072 +**Table 4: Table of Maintainable Artefacts for Structural Definition Metadata**
1020 1020  
1021 1021  === 7.1.2 Item Scheme, Structure ===
1022 1022  
... ... @@ -1023,7 +1023,10 @@
1023 1023  The artefacts included in the structural definitions are:
1024 1024  
1025 1025  * All types of Item Scheme (Codelist, Concept Scheme, Category Scheme, Organisation Scheme - Agency Scheme, Data Provider Scheme, Data Consumer Scheme, Organisation Unit Scheme)
1026 -* All types of Structure (Data Structure Definition, Metadata Structure Definition)
1079 +* All types of Structure (Data Structure Definition, Metadata Structure
1080 +
1081 +Definition)
1082 +
1027 1027  * All types of Structure Usage (Dataflow Definition, Metadataflow Definition)
1028 1028  
1029 1029  === 7.1.3 Structure Usage ===
... ... @@ -1042,8 +1042,6 @@
1042 1042  
1043 1043  ==== 7.1.3.3 Structure Usage Model ====
1044 1044  
1045 -[[image:1747829078194-749.png]]
1046 -
1047 1047  **Figure 10: SDMX-IM of links from Structure Usage to Category**
1048 1048  
1049 1049  In addition to the maintenance of the Dataflow Definition and the Metadataflow Definition the following links must be maintained in the registry:
... ... @@ -1070,10 +1070,10 @@
1070 1070  
1071 1071  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.
1072 1072  
1073 -[[image:1747829109466-595.png]]
1074 1074  
1075 1075  **Figure 11: SDMX-IM of the Data Provider**
1076 1076  
1130 +
1077 1077  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
1078 1078  
1079 1079  [[image:1747824123019-181.jpeg]]
... ... @@ -1082,10 +1082,8 @@
1082 1082  
1083 1083  The diagram below is a logical representation of the data required in order to maintain Provision Agreements.
1084 1084  
1085 -[[image:1747829139951-378.png]]
1086 1086  
1087 -(% class="wikigeneratedid" id="HFigure13:LogicalclassdiagramoftheinformationcontainedintheProvisionAgreement" %)
1088 -**Figure 13: Logical class diagram of the information contained in the Provision Agreement**
1140 +==== Figure 13: Logical class diagram of the information contained in the Provision Agreement ====
1089 1089  
1090 1090  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.
1091 1091  
... ... @@ -1113,12 +1113,13 @@
1113 1113  
1114 1114  === 7.3.3 Data and Metadata Constraints: Model ===
1115 1115  
1116 -[[image:1747829204737-370.png]]
1117 1117  
1118 -**Figure 15: Logical class diagram showing inheritance between and reference to constrainable artifacts**
1119 1119  
1120 -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.
1170 +==== Figure 15: Logical class diagram showing inheritance between and reference to constrainable artifacts ====
1121 1121  
1172 +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.
1173 +
1174 +
1122 1122  The content of the Constraint can be found in the SDMX Information Model document.
1123 1123  
1124 1124  == 7.4 Data and Metadata Registration ==
... ... @@ -1139,7 +1139,7 @@
1139 1139  
1140 1140  [[image:1747824123025-411.jpeg]]
1141 1141  
1142 -**Figure 16: Schematic of the Objects Concerned with Registration**
1195 + **Figure 16: Schematic of the Objects Concerned with Registration**
1143 1143  
1144 1144  ==== 7.4.2.2 Registration Request Model ====
1145 1145  
... ... @@ -1153,14 +1153,11 @@
1153 1153  
1154 1154  The Registration has an action attribute which takes one of the following values:
1155 1155  
1156 -(% style="width:970.294px" %)
1157 -|(% style="width:212px" %)**Action Attribute Value**|(% style="width:756px" %)**Behaviour**
1158 -|(% style="width:212px" %)Append|(% style="width:756px" %)Add this Registration to the registry
1159 -|(% style="width:212px" %)Replace|(% style="width:756px" %)Replace the existing Registration with identified by the id in the Registration of the Submit Registration Request
1160 -|(% style="width:212px" %)Delete|(% style="width:756px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
1209 +|**Action Attribute Value**|**Behaviour**
1210 +|Append|Add this Registration to the registry
1211 +|Replace|Replace the existing Registration with identified by the id in the Registration of the Submit Registration Request
1212 +|Delete|Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
1161 1161  
1162 -[[image:1747829290890-122.png]]
1163 -
1164 1164  **Figure 17: Logical Class Diagram of Registration of Data and Metadata**
1165 1165  
1166 1166  The Query Datasource is an abstract class that represents a data source which can understand an SDMX-ML query (SOAPDatasource) or RESTful query
... ... @@ -1175,19 +1175,25 @@
1175 1175  
1176 1176  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.
1177 1177  
1178 -|(% style="width:185px" %)**Indexing Required**|(% style="width:1686px" %)**Registration Process Activity**
1179 -|(% style="width:185px" %)indexTimeSeries|(% style="width:1686px" %)Extract all the series keys and create a KeySet(s) Constraint.
1180 -|(% style="width:185px" %)indexDataSet|(% style="width:1686px" %)(((
1181 -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.
1228 +|**Indexing Required**|**Registration Process Activity**
1229 +|indexTimeSeries|Extract all the series keys and create a KeySet(s) Constraint.
1230 +|indexDataSet|(((
1231 +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
1232 +
1233 +Regions containing Member Selections of Dimension Components of the Constraints model in the SDMX-IM, and the associated Selection Value.
1182 1182  )))
1183 -|(% style="width:185px" %)indexReportingPeriod|(% style="width:1686px" %)(((
1235 +|indexReportingPeriod|(((
1184 1184  This applies only to a registered dataset.
1237 +
1185 1185  Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint.
1186 1186  )))
1187 -|(% style="width:185px" %)indexAttributes|(% style="width:1686px" %)(((
1240 +|indexAttributes|(((
1188 1188  **Data Set**
1242 +
1189 1189  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
1244 +
1190 1190  **Metadata Set**
1246 +
1191 1191  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.
1192 1192  )))
1193 1193  
... ... @@ -1197,13 +1197,14 @@
1197 1197  
1198 1198  === 7.4.3 Registration Response ===
1199 1199  
1200 -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”.
1256 +After a registration request has been submitted to the registry, a response is returned to the submitter indicating success or failure. Given that a registration request can hold many Registrations, then there must be a registration status for each Registration. The Submit Registration class has a status field which is either set to
1201 1201  
1258 +“Success”, “Warning” or “Failure”.
1259 +
1202 1202  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.
1203 1203  
1204 1204  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:
1205 1205  
1206 -[[image:1747829477882-750.png]]
1207 1207  
1208 1208  **Figure 18: Logical class diagram showing the registration response**
1209 1209  
... ... @@ -1213,12 +1213,15 @@
1213 1213  
1214 1214  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.
1215 1215  
1216 -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”.
1273 +When a registry/repository artefact is modified, any subscriptions which are observing the object are activated, and either an email or HTTP POST is instigated to report details of the changes to the user specified in the subscription. This is called a
1217 1217  
1218 -=== 7.5.1Subscription Logical Class Diagram ===
1275 +“notification”.
1219 1219  
1220 -[[image:1747829554603-150.png]]
1277 + 7.5.1Subscription Logical Class Diagram
1221 1221  
1279 +
1280 +[[image:1747824123028-257.png]]
1281 +
1222 1222  **Figure 19: Logical Class Diagram of the Subscription**
1223 1223  
1224 1224  === 7.5.2 Subscription Information ===
... ... @@ -1225,58 +1225,73 @@
1225 1225  
1226 1226  Regardless of the type of registry/repository events being observed, a subscription always contains:
1227 1227  
1228 -1. A set of URIs describing the end-points to which notifications must be sent if the subscription is activated. The URIs can be either mailto~: or http: protocol. In the former case an email notification is sent; in the latter an HTTP POST notification is sent.
1229 -1. A 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 -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.
1231 -1. A selector which specifies which type of events are of interest. The set of event types is:
1288 +~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.
1232 1232  
1233 -|(% style="width:319px" %)**Event Type**|(% style="width:1553px" %)**Comment**
1234 -|(% style="width:319px" %)STRUCTURAL_REPOSITORY_EVENTS|(% style="width:1553px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1235 -|(% 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.
1236 -|(% 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.
1237 -|(% style="width:319px" %)ALL_EVENTS|(% style="width:1553px" %)All events of the specified EventType
1290 +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.
1238 1238  
1292 +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.
1293 +
1294 +4. A selector which specifies which type of events are of interest. The set of event types is:
1295 +
1296 +|**Event Type**|**Comment**
1297 +|STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1298 +|DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
1299 +|METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
1300 +|ALL_EVENTS|All events of the specified EventType
1301 +
1239 1239  === 7.5.3 Wildcard Facility ===
1240 1240  
1241 1241  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:
1242 1242  
1243 -* agencyID
1244 -* id
1245 -* version
1306 + agencyID
1246 1246  
1308 + id
1309 +
1310 + version
1311 +
1247 1247  Examples of wildcarded identifier components for an identified object type of Codelist are shown below.
1248 1248  
1249 -//AgencyID = %
1314 +AgencyID = %
1315 +
1250 1250  Id = %
1251 -Version = %//
1252 1252  
1318 +Version = %
1319 +
1253 1253  This subscribes to all Codelists of all versions for all agencies.
1254 1254  
1255 -//AgencyID = AGENCY1
1322 +AgencyID = AGENCY1
1323 +
1256 1256  Id = CODELIST1
1257 -Version = %//
1258 1258  
1326 +Version = %
1327 +
1259 1259  This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1260 1260  
1261 -//AGENCY1
1330 +AGENCY1
1331 +
1262 1262  AgencyID = AGENCY1
1333 +
1263 1263  Id = %
1264 -Version = %//
1265 1265  
1336 +Version = %
1337 +
1266 1266  This subscribes to all versions of all Codelist objects maintained by the agency
1267 1267  
1268 -//AGENCY1
1340 +AGENCY1
1341 +
1269 1269  AgencyID = %
1343 +
1270 1270  Id = CODELIST1
1271 -Version = %//
1272 1272  
1346 +Version = %
1347 +
1273 1273  This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1274 1274  
1275 -//AGENCY1//
1350 +AGENCY1
1276 1276  
1277 1277  Note that if the subscription is to the latest version then this can be achieved by the * character
1278 1278  
1279 -//i.e. Version = *//
1354 +i.e. Version = *
1280 1280  
1281 1281  Note that a subscription using the URN mechanism cannot use wildcard characters.
1282 1282  
... ... @@ -1288,15 +1288,16 @@
1288 1288  
1289 1289  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:
1290 1290  
1291 -|(% style="width:405px" %)**Selector**|(% style="width:1467px" %)**Comment**
1292 -|(% style="width:405px" %)DataProvider|(% style="width:1467px" %)Any datasets or metadata sets registered by the specified data provider will activate the notification.
1293 -|(% style="width:405px" %)ProvisionAgreement|(% style="width:1467px" %)Any datasets or metadata sets registered for the provision agreement will activate the notification.
1294 -|(% style="width:405px" %)Dataflow (&Metadataflow)|(% style="width:1467px" %)Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
1295 -|(% 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
1296 -|(% style="width:405px" %)**Selector**|(% style="width:1467px" %)**Comment**
1297 -|(% style="width:405px" %) |(% style="width:1467px" %)activate the notification.
1298 -|(% 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.
1299 1299  
1367 +|**Selector**|**Comment**
1368 +|DataProvider|Any datasets or metadata sets registered by the specified data provider will activate the notification.
1369 +|ProvisionAgreement|Any datasets or metadata sets registered for the provision agreement will activate the notification.
1370 +|Dataflow (&Metadataflow)|Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
1371 +|DataStructureDefinition & MetadataStructureDefinition|Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will
1372 +|**Selector**|**Comment**
1373 +| |activate the notification.
1374 +|Category|Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category.
1375 +
1300 1300  The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration.
1301 1301  
1302 1302  == 7.6 Notification ==
... ... @@ -1303,10 +1303,8 @@
1303 1303  
1304 1304  === 7.6.1 Logical Class Diagram ===
1305 1305  
1306 -[[image:1747829675568-610.png]]
1307 1307  
1308 -(% class="wikigeneratedid" id="HFigure20:LogicalClassDiagramoftheNotification" %)
1309 -**Figure 20: Logical Class Diagram of the Notification**
1383 +==== Figure 20: Logical Class Diagram of the Notification ====
1310 1310  
1311 1311  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.
1312 1312  
... ... @@ -1326,3 +1326,5 @@
1326 1326  === 7.6.3 Registration Event Component ===
1327 1327  
1328 1328  The notification will contain the Registration.
1403 +
1404 +
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
1747994320263-112.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -13.9 KB
Content