Skip to Content
Last modified by Helena on 2025/09/10 11:19
From version 9.3
edited by Helena
on 2025/05/23 13:00
Change comment: There is no comment for this version
To version 2.13
edited by Helena
on 2025/05/21 15:07
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,7 +450,7 @@
450 450  
451 451  [[image:1747824123012-527.jpeg]]
452 452  
453 -**Figure 7: Example of Hierarchic Structure of Agencies**
457 +==== Figure 7: Example of Hierarchic Structure of Agencies ====
454 454  
455 455  The following organizations maintain an Agency Scheme.
456 456  
... ... @@ -465,8 +465,9 @@
465 465  
466 466  An example of this is shown in the XML snippet below.
467 467  
468 -[[image:1747832400104-286.png]]
472 +[[image:1747824123013-196.jpeg||height="309" width="446"]]
469 469  
474 +(% class="wikigeneratedid" id="HFigure8:ExampleShowingUseofAgencyIdentifiers" %)
470 470  **Figure 8: Example Showing Use of Agency Identifiers**
471 471  
472 472  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.
... ... @@ -479,14 +479,13 @@
479 479  
480 480  ==== 6.2.2.2 URN Structure ====
481 481  
482 -(% class="wikigeneratedid" id="HCaseRulesforURN" %)
483 -//Case Rules for URN//
487 +===== //Case Rules for URN// =====
484 484  
485 485  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.
486 486  
487 487  The generic structure of the URN is as follows:
488 488  
489 ->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
490 490  
491 491  ~* this can repeat and may not be present (see explanation below)
492 492  
... ... @@ -498,7 +498,7 @@
498 498  
499 499  In the explanation below the actual object that is the target of the URN is called the **//actual object//**.
500 500  
501 -**SDMXPrefix:** urn:sdmx:org.
505 +**SDMXPrefix:** urn:sdmx:org.                                     
502 502  
503 503  **SDMX-IM package name:** sdmx.infomodel.package=
504 504  
... ... @@ -706,6 +706,8 @@
706 706  hierarchicalcodelistId(version).Hierarchy.Level
707 707  )))|(% style="width:396px" %)(((
708 708  ESTAT:HCL_REGION(1.0).H_1.COUNTRY
713 +
714 +
709 709  )))
710 710  |(% 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
711 711  |(% style="width:250px" %)*DataStructure|(% style="width:444px" %)dataStructureDefintitionAgencyId: dataStructureDefintitionId(version)|(% style="width:396px" %)TFFS:EXT_DEBT(1.0)
... ... @@ -810,11 +810,15 @@
810 810  
811 811  |(% style="width:251px" %)(((
812 812  ReportStructure
819 +
820 +
813 813  )))|(% style="width:442px" %)(((
814 814  MSDAgencyId: MSDId(version).reportStructureId
815 815  )))|(% style="width:1178px" %)IMF:SDDS_MSD(1.0).AGENCY_REPORT
816 816  |(% style="width:251px" %)(((
817 -Metadata Attribute
825 +Metadata
826 +
827 +Attribute
818 818  )))|(% style="width:442px" %)(((
819 819  MSDAgencyId: MSDId(version).reportStructureId.metadataattri buteID
820 820  )))|(% style="width:1178px" %)IMF:SDDS_MSD(1.0).AGENCY_REPORT.COMPILATION
... ... @@ -825,10 +825,14 @@
825 825  TFFS:CRED_EXT_DEBT_AB(1.0)
826 826  )))
827 827  |(% style="width:251px" %)(((
828 -*Content Constraint
838 +*Content
839 +
840 +Constraint
829 829  )))|(% style="width:442px" %)constraintAgencyId:ContentConstraintId(versio n)|(% style="width:1178px" %)TFFS:CREDITOR_DATA_CONTENT(1.0)
830 830  |(% style="width:251px" %)(((
831 -*Attachment Constraint
843 +*Attachment
844 +
845 +Constraint
832 832  )))|(% style="width:442px" %)(((
833 833  constraintAgencyId:
834 834  
... ... @@ -851,7 +851,9 @@
851 851  codeMapId
852 852  )))|
853 853  |(((
854 -CategorySchemeMap
868 +Category
869 +
870 +SchemeMap
855 855  )))|structureSetAgencyId: structureSetId(version). categorySchemeMapId|SDMX:BOP_STRUCTURES(1.0).SDMX_EUROSTAT
856 856  |CategoryMap|structureSetAgencyId: structureSetId(version). categorySchemeMapId. categoryMapId|SDMX:BOP_STRUCTURES(1.0).SDMX_EUROSTAT.TOURISM_M AP
857 857  |Organisation SchemeMap|structureSetAgencyId: structureSetId(version). organisationSchemeMapId|SDMX:BOP_STRUCTURES(1.0).DATA_PROVIDER_MAP
... ... @@ -865,53 +865,71 @@
865 865  structureSetAgencyId: structureSetId(version). conceptSchemeMapId.
866 866  
867 867  conceptMapId
884 +
868 868  
869 869  )))|SDMX:BOP_STRUCTURES(1.0).SDMX_OECD.COVERAGE_AVAI LABILITY
870 870  |(((
871 -ReportingTaxonomyMap
888 +Reporting
889 +
890 +TaxonomyMap
872 872  )))|structureSetAgencyId: structureSetId(version). reportingTaxonomyMapId|SDMX:BOP_STRUCTURES(1.0).TAXMAP
873 873  |(((
874 -ReportingCategoryMap
893 +Reporting
894 +
895 +CategoryMap
875 875  )))|(((
876 876  structureSetAgencyId: structureSetId(version).
898 +
877 877  reportngCategoryId
878 878  )))|SDMX:BOP_STRUCTURES(1.0).TAXMAP.TOPCAT
879 879  
902 +
903 +
880 880  |(((
881 -HybridCodelistMap
882 -)))|structureSetAgencyId: structureSetId(version).
883 -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
884 884  |HybridCodeMap|structureSetAgencyId: structureSetId(version). hybridCodelistMapId. hybridCodeMapId|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP.CO DEMAP1
885 885  |*Process|processAgencyId: processId{version]|BIS:PROCESS1(1.0)
886 886  |ProcessStep|(((
887 887  processAgencyId: processId(version).
913 +
888 888  processStepId
889 889  )))|BIS:PROCESS1(1.0).STEP1
890 890  |Transition|(((
891 891  processAgencyId: processId(version).
918 +
892 892  processStepId transitionId
893 893  )))|BIS:PROCESS1(1.0).STEP1.TRANSITION1
894 894  |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.
895 895  |(((
896 -*Transformation Scheme
923 +*Transformation
924 +
925 +Scheme
897 897  )))|transformationSchemeAgencyId transformationSchemeId(version)|ECB: TRANSFORMATION_SCHEME(1.0)
898 898  |Transformation|(((
899 899  transformationSchemeAgencyId transformationSchemeId(version)
929 +
900 900  transformationId
901 901  )))|ECB:TRANSFORMATION_SCHEME(1.0).TRANS_1
902 902  |CustomType Scheme|customTypeSchemeAgencyId customTypeSchemeId(version)|ECB:CUSTOM_TYPE_SCHEME(1.0)
903 903  
934 +
935 +
904 904  |CustomType|customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|ECB: CUSTOM_TYPE_SCHEME(1.0).CUSTOM_TYPE_1
905 905  |(((
906 906  Name
939 +
907 907  Personalisation
941 +
908 908  Scheme
909 909  )))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|ECB:PSN_SCHEME(1.0)
910 910  |(((
911 911  Name
946 +
912 912  Personalisation
913 -)))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)
914 -namePersonalisationId|ECB:PSN_SCHEME(1.0).PSN1234
948 +)))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|ECB:PSN_SCHEME(1.0).PSN1234
915 915  |VtlMapping Scheme|vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|ECB:CLIST_MP(2.0)
916 916  |VtlCodelist Mapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|ECB:CLIST_MP(2.0).ABZ
917 917  |VtlConcept Mapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|ECB:CLIST_MP(1.0).XYA
... ... @@ -924,11 +924,13 @@
924 924  |RulesetScheme|rulesetSchemeAgencyId rulesetSchemeId(version)|ECB:RULESET_23(1.0)
925 925  |Ruleset|rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|ECB:RULESET_23(1.0).SET111
926 926  |(((
927 -UserDefinedOperatorScheme
961 +UserDefined
962 +
963 +OperatorScheme
928 928  )))|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|ECB:OS_CALC(1.2)
929 929  |UserDefined Operator|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|ECB:OS_CALC(1.2).OS267
930 930  
931 -**Table 3: Table of identification components for SDMX Identifiable Artefacts**
967 +7**Table 3: Table of identification components for SDMX Identifiable Artefacts**
932 932  
933 933  = 7 Implementation Notes =
934 934  
... ... @@ -1138,7 +1138,7 @@
1138 1138  
1139 1139  [[image:1747824123025-411.jpeg]]
1140 1140  
1141 -**Figure 16: Schematic of the Objects Concerned with Registration**
1177 + **Figure 16: Schematic of the Objects Concerned with Registration**
1142 1142  
1143 1143  ==== 7.4.2.2 Registration Request Model ====
1144 1144  
... ... @@ -1152,14 +1152,11 @@
1152 1152  
1153 1153  The Registration has an action attribute which takes one of the following values:
1154 1154  
1155 -(% style="width:970.294px" %)
1156 -|(% style="width:212px" %)**Action Attribute Value**|(% style="width:756px" %)**Behaviour**
1157 -|(% style="width:212px" %)Append|(% style="width:756px" %)Add this Registration to the registry
1158 -|(% style="width:212px" %)Replace|(% style="width:756px" %)Replace the existing Registration with identified by the id in the Registration of the Submit Registration Request
1159 -|(% style="width:212px" %)Delete|(% style="width:756px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
1191 +|**Action Attribute Value**|**Behaviour**
1192 +|Append|Add this Registration to the registry
1193 +|Replace|Replace the existing Registration with identified by the id in the Registration of the Submit Registration Request
1194 +|Delete|Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
1160 1160  
1161 -[[image:1747829290890-122.png]]
1162 -
1163 1163  **Figure 17: Logical Class Diagram of Registration of Data and Metadata**
1164 1164  
1165 1165  The Query Datasource is an abstract class that represents a data source which can understand an SDMX-ML query (SOAPDatasource) or RESTful query
... ... @@ -1174,19 +1174,25 @@
1174 1174  
1175 1175  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.
1176 1176  
1177 -|(% style="width:185px" %)**Indexing Required**|(% style="width:1686px" %)**Registration Process Activity**
1178 -|(% style="width:185px" %)indexTimeSeries|(% style="width:1686px" %)Extract all the series keys and create a KeySet(s) Constraint.
1179 -|(% style="width:185px" %)indexDataSet|(% style="width:1686px" %)(((
1180 -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.
1210 +|**Indexing Required**|**Registration Process Activity**
1211 +|indexTimeSeries|Extract all the series keys and create a KeySet(s) Constraint.
1212 +|indexDataSet|(((
1213 +Extract all the codes and other content of the Key value of the Series Key in a Data Set and create one or more Cube
1214 +
1215 +Regions containing Member Selections of Dimension Components of the Constraints model in the SDMX-IM, and the associated Selection Value.
1181 1181  )))
1182 -|(% style="width:185px" %)indexReportingPeriod|(% style="width:1686px" %)(((
1217 +|indexReportingPeriod|(((
1183 1183  This applies only to a registered dataset.
1219 +
1184 1184  Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint.
1185 1185  )))
1186 -|(% style="width:185px" %)indexAttributes|(% style="width:1686px" %)(((
1222 +|indexAttributes|(((
1187 1187  **Data Set**
1224 +
1188 1188  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
1226 +
1189 1189  **Metadata Set**
1228 +
1190 1190  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.
1191 1191  )))
1192 1192  
... ... @@ -1196,13 +1196,14 @@
1196 1196  
1197 1197  === 7.4.3 Registration Response ===
1198 1198  
1199 -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”.
1238 +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
1200 1200  
1240 +“Success”, “Warning” or “Failure”.
1241 +
1201 1201  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.
1202 1202  
1203 1203  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:
1204 1204  
1205 -[[image:1747829477882-750.png]]
1206 1206  
1207 1207  **Figure 18: Logical class diagram showing the registration response**
1208 1208  
... ... @@ -1212,12 +1212,15 @@
1212 1212  
1213 1213  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.
1214 1214  
1215 -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”.
1255 +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
1216 1216  
1217 -=== 7.5.1Subscription Logical Class Diagram ===
1257 +“notification”.
1218 1218  
1219 -[[image:1747829554603-150.png]]
1259 + 7.5.1Subscription Logical Class Diagram
1220 1220  
1261 +
1262 +[[image:1747824123028-257.png]]
1263 +
1221 1221  **Figure 19: Logical Class Diagram of the Subscription**
1222 1222  
1223 1223  === 7.5.2 Subscription Information ===
... ... @@ -1224,58 +1224,73 @@
1224 1224  
1225 1225  Regardless of the type of registry/repository events being observed, a subscription always contains:
1226 1226  
1227 -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.
1228 -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.
1229 -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.
1230 -1. A selector which specifies which type of events are of interest. The set of event types is:
1270 +~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.
1231 1231  
1232 -|(% style="width:319px" %)**Event Type**|(% style="width:1553px" %)**Comment**
1233 -|(% style="width:319px" %)STRUCTURAL_REPOSITORY_EVENTS|(% style="width:1553px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1234 -|(% 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.
1235 -|(% 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.
1236 -|(% style="width:319px" %)ALL_EVENTS|(% style="width:1553px" %)All events of the specified EventType
1272 +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.
1237 1237  
1274 +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.
1275 +
1276 +4. A selector which specifies which type of events are of interest. The set of event types is:
1277 +
1278 +|**Event Type**|**Comment**
1279 +|STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1280 +|DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
1281 +|METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
1282 +|ALL_EVENTS|All events of the specified EventType
1283 +
1238 1238  === 7.5.3 Wildcard Facility ===
1239 1239  
1240 1240  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:
1241 1241  
1242 -* agencyID
1243 -* id
1244 -* version
1288 + agencyID
1245 1245  
1290 + id
1291 +
1292 + version
1293 +
1246 1246  Examples of wildcarded identifier components for an identified object type of Codelist are shown below.
1247 1247  
1248 -//AgencyID = %
1296 +AgencyID = %
1297 +
1249 1249  Id = %
1250 -Version = %//
1251 1251  
1300 +Version = %
1301 +
1252 1252  This subscribes to all Codelists of all versions for all agencies.
1253 1253  
1254 -//AgencyID = AGENCY1
1304 +AgencyID = AGENCY1
1305 +
1255 1255  Id = CODELIST1
1256 -Version = %//
1257 1257  
1308 +Version = %
1309 +
1258 1258  This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1259 1259  
1260 -//AGENCY1
1312 +AGENCY1
1313 +
1261 1261  AgencyID = AGENCY1
1315 +
1262 1262  Id = %
1263 -Version = %//
1264 1264  
1318 +Version = %
1319 +
1265 1265  This subscribes to all versions of all Codelist objects maintained by the agency
1266 1266  
1267 -//AGENCY1
1322 +AGENCY1
1323 +
1268 1268  AgencyID = %
1325 +
1269 1269  Id = CODELIST1
1270 -Version = %//
1271 1271  
1328 +Version = %
1329 +
1272 1272  This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1273 1273  
1274 -//AGENCY1//
1332 +AGENCY1
1275 1275  
1276 1276  Note that if the subscription is to the latest version then this can be achieved by the * character
1277 1277  
1278 -//i.e. Version = *//
1336 +i.e. Version = *
1279 1279  
1280 1280  Note that a subscription using the URN mechanism cannot use wildcard characters.
1281 1281  
... ... @@ -1287,15 +1287,16 @@
1287 1287  
1288 1288  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:
1289 1289  
1290 -|(% style="width:405px" %)**Selector**|(% style="width:1467px" %)**Comment**
1291 -|(% style="width:405px" %)DataProvider|(% style="width:1467px" %)Any datasets or metadata sets registered by the specified data provider will activate the notification.
1292 -|(% style="width:405px" %)ProvisionAgreement|(% style="width:1467px" %)Any datasets or metadata sets registered for the provision agreement will activate the notification.
1293 -|(% style="width:405px" %)Dataflow (&Metadataflow)|(% style="width:1467px" %)Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
1294 -|(% 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
1295 -|(% style="width:405px" %)**Selector**|(% style="width:1467px" %)**Comment**
1296 -|(% style="width:405px" %) |(% style="width:1467px" %)activate the notification.
1297 -|(% 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.
1298 1298  
1349 +|**Selector**|**Comment**
1350 +|DataProvider|Any datasets or metadata sets registered by the specified data provider will activate the notification.
1351 +|ProvisionAgreement|Any datasets or metadata sets registered for the provision agreement will activate the notification.
1352 +|Dataflow (&Metadataflow)|Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
1353 +|DataStructureDefinition & MetadataStructureDefinition|Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will
1354 +|**Selector**|**Comment**
1355 +| |activate the notification.
1356 +|Category|Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category.
1357 +
1299 1299  The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration.
1300 1300  
1301 1301  == 7.6 Notification ==
... ... @@ -1302,10 +1302,8 @@
1302 1302  
1303 1303  === 7.6.1 Logical Class Diagram ===
1304 1304  
1305 -[[image:1747829675568-610.png]]
1306 1306  
1307 -(% class="wikigeneratedid" id="HFigure20:LogicalClassDiagramoftheNotification" %)
1308 -**Figure 20: Logical Class Diagram of the Notification**
1365 +==== Figure 20: Logical Class Diagram of the Notification ====
1309 1309  
1310 1310  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.
1311 1311  
... ... @@ -1325,3 +1325,5 @@
1325 1325  === 7.6.3 Registration Event Component ===
1326 1326  
1327 1327  The notification will contain the Registration.
1385 +
1386 +
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