Last modified by Helena on 2025/09/10 11:19
Summary
-
Page properties (1 modified, 0 added, 0 removed)
-
Attachments (0 modified, 8 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -4,10 +4,11 @@ 4 4 5 5 **Revision History** 6 6 7 -|**Revision**|**Date**|**Contents** 8 -| |April 2011|Initial release 9 -|1.0|July 2011|Rectification of problems of the specifications dated April 2011 10 -|2.0|July 2020|Addition of VTL (Validation and Transformation Language) package, maintainable artefacts, nameable artefacts to 5.2.3, 6.2.2, 6.2.3, 6.2.4, 7.1.1 7 +(% style="width:833.294px" %) 8 +|(% style="width:122px" %)**Revision**|(% style="width:126px" %)**Date**|(% style="width:581px" %)**Contents** 9 +|(% style="width:122px" %) |(% style="width:126px" %)April 2011|(% style="width:581px" %)Initial release 10 +|(% style="width:122px" %)1.0|(% style="width:126px" %)July 2011|(% style="width:581px" %)Rectification of problems of the specifications dated April 2011 11 +|(% style="width:122px" %)2.0|(% style="width:126px" %)July 2020|(% style="width:581px" %)Addition of VTL (Validation and Transformation Language) package, maintainable artefacts, nameable artefacts to 5.2.3, 6.2.2, 6.2.3, 6.2.4, 7.1.1 11 11 12 12 **Corrigendum** 13 13 ... ... @@ -288,27 +288,22 @@ 288 288 * that a queryable data source exists - this would necessitate the registration service querying the service to determine its existence 289 289 * that a simple data source exists (i.e. a file accessible at a URL) 290 290 * that the correct Data Structure Definition or Metadata Structure Definition is used by the registered data that the components (Dimensions, Attributes, Measures, Identifier Components etc.) are consistent with the Data Structure Definition or Metadata Structure Definition 291 -* that the valid representations of the concepts to which these components382correspond conform to the definition in the Data Structure Definition or Metadata Structure Definition292 +* that the valid representations of the concepts to which these components correspond conform to the definition in the Data Structure Definition or Metadata Structure Definition 292 292 293 - 3The Registration has an action attribute which takes one of the following values:294 +The Registration has an action attribute which takes one of the following values: 294 294 295 -|(% style="width:249px" %)((( 296 -**Action Attribute Value** 297 -)))|(% style="width:1622px" %)**Behaviour** 298 -|(% style="width:249px" %)Append|(% style="width:1622px" %)Add this registration to the registry 299 -|(% style="width:249px" %)Replace|(% style="width:1622px" %)Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request 300 -|(% style="width:249px" %)Delete|(% style="width:1622px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request 296 +|(% style="width:219px" %)**Action Attribute Value**|(% style="width:1652px" %)**Behaviour** 297 +|(% style="width:219px" %)Append|(% style="width:1652px" %)Add this registration to the registry 298 +|(% style="width:219px" %)Replace|(% style="width:1652px" %)Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request 299 +|(% style="width:219px" %)Delete|(% style="width:1652px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request 301 301 302 302 The Registration has three Boolean attributes which may be present to determine how an SDMX compliant Dataset or Metadata Set indexing application must index the Datasets or Metadata Set upon registration. The indexing application behaviour is as follows: 303 303 304 -|**Boolean Attribute**|**Behaviour if Value is “true”** 305 -|indexTimeSeries|A compliant indexing application must index all the time series keys (for a Dataset registration) or metadata target values (for a Metadata Set registration) 306 -|indexDataSet|((( 307 -A compliant indexing application must index the range of actual (present) values for each dimension of the Dataset (for a Dataset registration) or the range of actual (present) values for each Metadata Attribute which takes an enumerated value. 308 - 303 +|(% style="width:228px" %)**Boolean Attribute**|(% style="width:1644px" %)**Behaviour if Value is “true”** 304 +|(% style="width:228px" %)indexTimeSeries|(% style="width:1644px" %)A compliant indexing application must index all the time series keys (for a Dataset registration) or metadata target values (for a Metadata Set registration) 305 +|(% style="width:228px" %)indexDataSet|(% style="width:1644px" %)A compliant indexing application must index the range of actual (present) values for each dimension of the Dataset (for a Dataset registration) or the range of actual (present) values for each Metadata Attribute which takes an enumerated value. 309 309 Note that for data this requires much less storage than full key indexing, but this method cannot guarantee that a specific combination of Dimension values (the Key) is actually present in the Dataset 310 -))) 311 -|indexReportingPeriod|A compliant indexing application must index the time period range(s) for which data are present in the Dataset or Metadata Set 307 +|(% style="width:228px" %)indexReportingPeriod|(% style="width:1644px" %)A compliant indexing application must index the time period range(s) for which data are present in the Dataset or Metadata Set 312 312 313 313 === 5.2.5 Data and Reference Metadata Discovery === 314 314 ... ... @@ -340,8 +340,8 @@ 340 340 341 341 The following table defines the behaviour of the SDMX Registry for the various Registry Interface messages. 342 342 343 -|(% style="width:2 44px" %)**Interface**|**Behaviour**344 -|(% style="width:2 44px" %)All|(((339 +|(% style="width:227px" %)**Interface**|(% style="width:1644px" %)**Behaviour** 340 +|(% style="width:227px" %)All|(% style="width:1644px" %)((( 345 345 1) If the action is set to “replace” then the entire contents of the existing maintainable object in the Registry MUST be replaced by the object submitted, unless the final attribute is set to “true” in which case the only changes that are allowed are to the following constructs: 346 346 347 347 * Name – this applies to the Maintainable object and its contained elements, such a Code in a Code list. ... ... @@ -355,7 +355,6 @@ 355 355 * isExternalReference 356 356 357 357 2) Cross referenced structures MUST exist in either the submitted document (in Structures or Structure Location) or in the registry to which the request is submitted. 358 - 359 359 3) If the action is set to “delete” then the Registry MUST verify that the object can deleted. In order to qualify for deletion the object must: 360 360 361 361 а) Not have the final attribute set to “true” ... ... @@ -362,12 +362,11 @@ 362 362 b) Not be referenced from any other object in the Registry. 363 363 364 364 4) The version rules in the SDMX Schema documentation MUST be obeyed. 365 - 366 366 5) The specific rules for the elements and attributes documented in the SDMX Schema MUST be obeyed. 367 367 ))) 368 -|(% style="width:2 44px" %)SubmitStructureRequest|Structures are submitted at the level of the Maintainable Artefact and the behaviour in “All” above is therefore at the level of the Maintainable Artefact.369 -|(% style="width:2 44px" %)SubmitProvisioningRequest|No additional behaviour.370 -|(% style="width:2 44px" %)Submit Registration Request|(((362 +|(% style="width:227px" %)SubmitStructureRequest|(% style="width:1644px" %)Structures are submitted at the level of the Maintainable Artefact and the behaviour in “All” above is therefore at the level of the Maintainable Artefact. 363 +|(% style="width:227px" %)SubmitProvisioningRequest|(% style="width:1644px" %)No additional behaviour. 364 +|(% style="width:227px" %)Submit Registration Request|(% style="width:1644px" %)((( 371 371 If the datasource is a file (simple datasource) then the file MAY be retrieved and indexed according to the Boolean attributes set in the Registration. 372 372 For a queryable datasource the Registry MAY validate that the source exists and can accept an SDMX-ML data query. 373 373 ))) ... ... @@ -454,7 +454,8 @@ 454 454 455 455 [[image:1747824123012-527.jpeg]] 456 456 457 -==== Figure 7: Example of Hierarchic Structure of Agencies ==== 451 +* 452 +** Figure 7: Example of Hierarchic Structure of Agencies 458 458 459 459 The following organizations maintain an Agency Scheme. 460 460 ... ... @@ -471,7 +471,6 @@ 471 471 472 472 [[image:1747824123013-196.jpeg||height="309" width="446"]] 473 473 474 -(% class="wikigeneratedid" id="HFigure8:ExampleShowingUseofAgencyIdentifiers" %) 475 475 **Figure 8: Example Showing Use of Agency Identifiers** 476 476 477 477 Each of these maintenance agencies has an identical Code list with the Id CL_BOP. However, each is uniquely identified by means of the hierarchic agency structure. ... ... @@ -490,7 +490,7 @@ 490 490 491 491 The generic structure of the URN is as follows: 492 492 493 -SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobject-id(maintainedobject-version).*containerobject-id.object-id 487 +>SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobject-id(maintainedobject-version).*containerobject-id.object-id 494 494 495 495 ~* this can repeat and may not be present (see explanation below) 496 496 ... ... @@ -502,7 +502,7 @@ 502 502 503 503 In the explanation below the actual object that is the target of the URN is called the **//actual object//**. 504 504 505 -**SDMXPrefix:** urn:sdmx:org. 499 +**SDMXPrefix:** urn:sdmx:org. 506 506 507 507 **SDMX-IM package name:** sdmx.infomodel.package= 508 508 ... ... @@ -710,8 +710,6 @@ 710 710 hierarchicalcodelistId(version).Hierarchy.Level 711 711 )))|(% style="width:396px" %)((( 712 712 ESTAT:HCL_REGION(1.0).H_1.COUNTRY 713 - 714 - 715 715 ))) 716 716 |(% 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 717 717 |(% style="width:250px" %)*DataStructure|(% style="width:444px" %)dataStructureDefintitionAgencyId: dataStructureDefintitionId(version)|(% style="width:396px" %)TFFS:EXT_DEBT(1.0) ... ... @@ -816,15 +816,11 @@ 816 816 817 817 |(% style="width:251px" %)((( 818 818 ReportStructure 819 - 820 - 821 821 )))|(% style="width:442px" %)((( 822 822 MSDAgencyId: MSDId(version).reportStructureId 823 823 )))|(% style="width:1178px" %)IMF:SDDS_MSD(1.0).AGENCY_REPORT 824 824 |(% style="width:251px" %)((( 825 -Metadata 826 - 827 -Attribute 815 +Metadata Attribute 828 828 )))|(% style="width:442px" %)((( 829 829 MSDAgencyId: MSDId(version).reportStructureId.metadataattri buteID 830 830 )))|(% style="width:1178px" %)IMF:SDDS_MSD(1.0).AGENCY_REPORT.COMPILATION ... ... @@ -835,14 +835,10 @@ 835 835 TFFS:CRED_EXT_DEBT_AB(1.0) 836 836 ))) 837 837 |(% style="width:251px" %)((( 838 -*Content 839 - 840 -Constraint 826 +*Content Constraint 841 841 )))|(% style="width:442px" %)constraintAgencyId:ContentConstraintId(versio n)|(% style="width:1178px" %)TFFS:CREDITOR_DATA_CONTENT(1.0) 842 842 |(% style="width:251px" %)((( 843 -*Attachment 844 - 845 -Constraint 829 +*Attachment Constraint 846 846 )))|(% style="width:442px" %)((( 847 847 constraintAgencyId: 848 848 ... ... @@ -865,9 +865,7 @@ 865 865 codeMapId 866 866 )))| 867 867 |((( 868 -Category 869 - 870 -SchemeMap 852 +CategorySchemeMap 871 871 )))|structureSetAgencyId: structureSetId(version). categorySchemeMapId|SDMX:BOP_STRUCTURES(1.0).SDMX_EUROSTAT 872 872 |CategoryMap|structureSetAgencyId: structureSetId(version). categorySchemeMapId. categoryMapId|SDMX:BOP_STRUCTURES(1.0).SDMX_EUROSTAT.TOURISM_M AP 873 873 |Organisation SchemeMap|structureSetAgencyId: structureSetId(version). organisationSchemeMapId|SDMX:BOP_STRUCTURES(1.0).DATA_PROVIDER_MAP ... ... @@ -881,13 +881,10 @@ 881 881 structureSetAgencyId: structureSetId(version). conceptSchemeMapId. 882 882 883 883 conceptMapId 884 - 885 885 886 886 )))|SDMX:BOP_STRUCTURES(1.0).SDMX_OECD.COVERAGE_AVAI LABILITY 887 887 |((( 888 -Reporting 889 - 890 -TaxonomyMap 869 +ReportingTaxonomyMap 891 891 )))|structureSetAgencyId: structureSetId(version). reportingTaxonomyMapId|SDMX:BOP_STRUCTURES(1.0).TAXMAP 892 892 |((( 893 893 Reporting ... ... @@ -895,57 +895,44 @@ 895 895 CategoryMap 896 896 )))|((( 897 897 structureSetAgencyId: structureSetId(version). 898 - 899 899 reportngCategoryId 900 900 )))|SDMX:BOP_STRUCTURES(1.0).TAXMAP.TOPCAT 901 901 902 - 903 - 904 904 |((( 905 -HybridCodelist 906 - 907 -Map 908 -)))|structureSetAgencyId: structureSetId(version). hybridCodelistMapId.|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP 881 +HybridCodelistMap 882 +)))|structureSetAgencyId: structureSetId(version). 883 +hybridCodelistMapId.|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP 909 909 |HybridCodeMap|structureSetAgencyId: structureSetId(version). hybridCodelistMapId. hybridCodeMapId|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP.CO DEMAP1 910 910 |*Process|processAgencyId: processId{version]|BIS:PROCESS1(1.0) 911 911 |ProcessStep|((( 912 912 processAgencyId: processId(version). 913 - 914 914 processStepId 915 915 )))|BIS:PROCESS1(1.0).STEP1 916 916 |Transition|((( 917 917 processAgencyId: processId(version). 918 - 919 919 processStepId transitionId 920 920 )))|BIS:PROCESS1(1.0).STEP1.TRANSITION1 921 921 |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. 922 922 |((( 923 -*Transformation 924 - 925 -Scheme 896 +*Transformation Scheme 926 926 )))|transformationSchemeAgencyId transformationSchemeId(version)|ECB: TRANSFORMATION_SCHEME(1.0) 927 927 |Transformation|((( 928 928 transformationSchemeAgencyId transformationSchemeId(version) 929 - 930 930 transformationId 931 931 )))|ECB:TRANSFORMATION_SCHEME(1.0).TRANS_1 932 932 |CustomType Scheme|customTypeSchemeAgencyId customTypeSchemeId(version)|ECB:CUSTOM_TYPE_SCHEME(1.0) 933 933 934 - 935 - 936 936 |CustomType|customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|ECB: CUSTOM_TYPE_SCHEME(1.0).CUSTOM_TYPE_1 937 937 |((( 938 938 Name 939 - 940 940 Personalisation 941 - 942 942 Scheme 943 943 )))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|ECB:PSN_SCHEME(1.0) 944 944 |((( 945 945 Name 946 - 947 947 Personalisation 948 -)))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|ECB:PSN_SCHEME(1.0).PSN1234 913 +)))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) 914 +namePersonalisationId|ECB:PSN_SCHEME(1.0).PSN1234 949 949 |VtlMapping Scheme|vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|ECB:CLIST_MP(2.0) 950 950 |VtlCodelist Mapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|ECB:CLIST_MP(2.0).ABZ 951 951 |VtlConcept Mapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|ECB:CLIST_MP(1.0).XYA ... ... @@ -1077,6 +1077,8 @@ 1077 1077 1078 1078 ==== 7.1.3.3 Structure Usage Model ==== 1079 1079 1046 +[[image:1747829078194-749.png]] 1047 + 1080 1080 **Figure 10: SDMX-IM of links from Structure Usage to Category** 1081 1081 1082 1082 In addition to the maintenance of the Dataflow Definition and the Metadataflow Definition the following links must be maintained in the registry: ... ... @@ -1103,10 +1103,10 @@ 1103 1103 1104 1104 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. 1105 1105 1074 +[[image:1747829109466-595.png]] 1106 1106 1107 1107 **Figure 11: SDMX-IM of the Data Provider** 1108 1108 1109 - 1110 1110 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 1111 1111 1112 1112 [[image:1747824123019-181.jpeg]] ... ... @@ -1115,8 +1115,10 @@ 1115 1115 1116 1116 The diagram below is a logical representation of the data required in order to maintain Provision Agreements. 1117 1117 1086 +[[image:1747829139951-378.png]] 1118 1118 1119 -==== Figure 13: Logical class diagram of the information contained in the Provision Agreement ==== 1088 +(% class="wikigeneratedid" id="HFigure13:LogicalclassdiagramoftheinformationcontainedintheProvisionAgreement" %) 1089 +**Figure 13: Logical class diagram of the information contained in the Provision Agreement** 1120 1120 1121 1121 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. 1122 1122 ... ... @@ -1144,13 +1144,12 @@ 1144 1144 1145 1145 === 7.3.3 Data and Metadata Constraints: Model === 1146 1146 1117 +[[image:1747829204737-370.png]] 1147 1147 1119 +**Figure 15: Logical class diagram showing inheritance between and reference to constrainable artifacts** 1148 1148 1149 - ==== Figure15: Logicalclass diagram showing inheritancebetween and reference to constrainable artifacts====1121 +The class diagram above shows that DataProvider, DataflowDefinition, MetadataflowDefinition, ProvisionAgreement, DataStructureDefinition, MetadataStructureDefinition, SimpleDatasource and QueryDatasource are all concrete sub-classes of ConstrainableArtefact and can therefore have Constraints specified. Note that the actual Constraint as submitted is associated to the reference classes which inherit from ConstrainableRef: these are used to refer to the classes to which the Constraint applies. 1150 1150 1151 -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. 1152 - 1153 - 1154 1154 The content of the Constraint can be found in the SDMX Information Model document. 1155 1155 1156 1156 == 7.4 Data and Metadata Registration == ... ... @@ -1171,7 +1171,7 @@ 1171 1171 1172 1172 [[image:1747824123025-411.jpeg]] 1173 1173 1174 - **Figure 16: Schematic of the Objects Concerned with Registration**1143 +**Figure 16: Schematic of the Objects Concerned with Registration** 1175 1175 1176 1176 ==== 7.4.2.2 Registration Request Model ==== 1177 1177 ... ... @@ -1185,11 +1185,14 @@ 1185 1185 1186 1186 The Registration has an action attribute which takes one of the following values: 1187 1187 1188 -|**Action Attribute Value**|**Behaviour** 1189 -|Append|Add this Registration to the registry 1190 -|Replace|Replace the existing Registration with identified by the id in the Registration of the Submit Registration Request 1191 -|Delete|Delete the existing Registration identified by the id in the Registration of the Submit Registration Request 1157 +(% style="width:970.294px" %) 1158 +|(% style="width:212px" %)**Action Attribute Value**|(% style="width:756px" %)**Behaviour** 1159 +|(% style="width:212px" %)Append|(% style="width:756px" %)Add this Registration to the registry 1160 +|(% style="width:212px" %)Replace|(% style="width:756px" %)Replace the existing Registration with identified by the id in the Registration of the Submit Registration Request 1161 +|(% style="width:212px" %)Delete|(% style="width:756px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request 1192 1192 1163 +[[image:1747829290890-122.png]] 1164 + 1193 1193 **Figure 17: Logical Class Diagram of Registration of Data and Metadata** 1194 1194 1195 1195 The Query Datasource is an abstract class that represents a data source which can understand an SDMX-ML query (SOAPDatasource) or RESTful query ... ... @@ -1204,25 +1204,19 @@ 1204 1204 1205 1205 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. 1206 1206 1207 -|**Indexing Required**|**Registration Process Activity** 1208 -|indexTimeSeries|Extract all the series keys and create a KeySet(s) Constraint. 1209 -|indexDataSet|((( 1210 -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 1211 - 1212 -Regions containing Member Selections of Dimension Components of the Constraints model in the SDMX-IM, and the associated Selection Value. 1179 +|(% style="width:185px" %)**Indexing Required**|(% style="width:1686px" %)**Registration Process Activity** 1180 +|(% style="width:185px" %)indexTimeSeries|(% style="width:1686px" %)Extract all the series keys and create a KeySet(s) Constraint. 1181 +|(% style="width:185px" %)indexDataSet|(% style="width:1686px" %)((( 1182 +Extract all the codes and other content of the Key value of the Series Key in a Data Set and create one or more Cube Regions containing Member Selections of Dimension Components of the Constraints model in the SDMX-IM, and the associated Selection Value. 1213 1213 ))) 1214 -|indexReportingPeriod|((( 1184 +|(% style="width:185px" %)indexReportingPeriod|(% style="width:1686px" %)((( 1215 1215 This applies only to a registered dataset. 1216 - 1217 1217 Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint. 1218 1218 ))) 1219 -|indexAttributes|((( 1188 +|(% style="width:185px" %)indexAttributes|(% style="width:1686px" %)((( 1220 1220 **Data Set** 1221 - 1222 1222 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 1223 - 1224 1224 **Metadata Set** 1225 - 1226 1226 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. 1227 1227 ))) 1228 1228 ... ... @@ -1232,14 +1232,13 @@ 1232 1232 1233 1233 === 7.4.3 Registration Response === 1234 1234 1235 -After a registration request has been submitted to the registry, a response is returned to the submitter indicating success or failure. Given that a registration request can hold many Registrations, then there must be a registration status for each Registration. The Submit Registration class has a status field which is either set to 1201 +After a registration request has been submitted to the registry, a response is returned to the submitter indicating success or failure. Given that a registration request can hold many Registrations, then there must be a registration status for each Registration. The Submit Registration class has a status field which is either set to “Success”, “Warning” or “Failure”. 1236 1236 1237 -“Success”, “Warning” or “Failure”. 1238 - 1239 1239 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. 1240 1240 1241 1241 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: 1242 1242 1207 +[[image:1747829477882-750.png]] 1243 1243 1244 1244 **Figure 18: Logical class diagram showing the registration response** 1245 1245 ... ... @@ -1249,15 +1249,12 @@ 1249 1249 1250 1250 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. 1251 1251 1252 -When a registry/repository artefact is modified, any subscriptions which are observing the object are activated, and either an email or HTTP POST is instigated to report details of the changes to the user specified in the subscription. This is called a 1217 +When a registry/repository artefact is modified, any subscriptions which are observing the object are activated, and either an email or HTTP POST is instigated to report details of the changes to the user specified in the subscription. This is called a “notification”. 1253 1253 1254 - “notification”.1219 +=== 7.5.1Subscription Logical Class Diagram === 1255 1255 1256 - 7.5.1SubscriptionLogical Class Diagram1221 +[[image:1747829554603-150.png]] 1257 1257 1258 - 1259 -[[image:1747824123028-257.png]] 1260 - 1261 1261 **Figure 19: Logical Class Diagram of the Subscription** 1262 1262 1263 1263 === 7.5.2 Subscription Information === ... ... @@ -1264,73 +1264,58 @@ 1264 1264 1265 1265 Regardless of the type of registry/repository events being observed, a subscription always contains: 1266 1266 1267 -~1. A set of URIs describing the end-points to which notifications must be sent if the subscription is activated. The URIs can be either mailto~: or http: protocol. In the former case an email notification is sent; in the latter an HTTP POST notification is sent. 1229 +1. A set of URIs describing the end-points to which notifications must be sent if the subscription is activated. The URIs can be either mailto~: or http: protocol. In the former case an email notification is sent; in the latter an HTTP POST notification is sent. 1230 +1. A user-defined identifier which is returned in the response to the subscription request. This helps with asynchronous processing and is NOT stored in the Registry. 1231 +1. A validity period which defines both when the subscription becomes active and expires. The subscriber may be sent a notification on expiration of the subscription. 1232 +1. A selector which specifies which type of events are of interest. The set of event types is: 1268 1268 1269 -2. A user-defined identifier which is returned in the response to the subscription request. This helps with asynchronous processing and is NOT stored in the Registry. 1234 +|(% style="width:327px" %)**Event Type**|(% style="width:1545px" %)**Comment** 1235 +|(% style="width:327px" %)STRUCTURAL_REPOSITORY_EVENTS|(% style="width:1545px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository. 1236 +|(% style="width:327px" %)DATA_REGISTRATION_EVENTS|(% style="width:1545px" %)Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database. 1237 +|(% style="width:327px" %)METADATA_REGISTRATION_EVENTS|(% style="width:1545px" %)Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database. 1238 +|(% style="width:327px" %)ALL_EVENTS|(% style="width:1545px" %)All events of the specified EventType 1270 1270 1271 -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. 1272 - 1273 -4. A selector which specifies which type of events are of interest. The set of event types is: 1274 - 1275 -|**Event Type**|**Comment** 1276 -|STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository. 1277 -|DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database. 1278 -|METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database. 1279 -|ALL_EVENTS|All events of the specified EventType 1280 - 1281 1281 === 7.5.3 Wildcard Facility === 1282 1282 1283 1283 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: 1284 1284 1285 - agencyID 1244 +* agencyID 1245 +* id 1246 +* version 1286 1286 1287 - id 1288 - 1289 - version 1290 - 1291 1291 Examples of wildcarded identifier components for an identified object type of Codelist are shown below. 1292 1292 1293 -AgencyID = % 1294 - 1250 +//AgencyID = % 1295 1295 Id = % 1252 +Version = %// 1296 1296 1297 -Version = % 1298 - 1299 1299 This subscribes to all Codelists of all versions for all agencies. 1300 1300 1301 -AgencyID = AGENCY1 1302 - 1256 +//AgencyID = AGENCY1 1303 1303 Id = CODELIST1 1258 +Version = %// 1304 1304 1305 -Version = % 1306 - 1307 1307 This subscribes to all versions of Codelist CODELIST1 maintained by the agency 1308 1308 1309 -AGENCY1 1310 - 1262 +//AGENCY1 1311 1311 AgencyID = AGENCY1 1312 - 1313 1313 Id = % 1265 +Version = %// 1314 1314 1315 -Version = % 1316 - 1317 1317 This subscribes to all versions of all Codelist objects maintained by the agency 1318 1318 1319 -AGENCY1 1320 - 1269 +//AGENCY1 1321 1321 AgencyID = % 1322 - 1323 1323 Id = CODELIST1 1272 +Version = %// 1324 1324 1325 -Version = % 1326 - 1327 1327 This subscribes to all versions of Codelist CODELIST1 maintained by the agency 1328 1328 1329 -AGENCY1 1276 +//AGENCY1// 1330 1330 1331 1331 Note that if the subscription is to the latest version then this can be achieved by the * character 1332 1332 1333 -i.e. Version = * 1280 +//i.e. Version = *// 1334 1334 1335 1335 Note that a subscription using the URN mechanism cannot use wildcard characters. 1336 1336 ... ... @@ -1342,16 +1342,15 @@ 1342 1342 1343 1343 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: 1344 1344 1292 +|(% style="width:405px" %)**Selector**|(% style="width:1467px" %)**Comment** 1293 +|(% style="width:405px" %)DataProvider|(% style="width:1467px" %)Any datasets or metadata sets registered by the specified data provider will activate the notification. 1294 +|(% style="width:405px" %)ProvisionAgreement|(% style="width:1467px" %)Any datasets or metadata sets registered for the provision agreement will activate the notification. 1295 +|(% style="width:405px" %)Dataflow (&Metadataflow)|(% style="width:1467px" %)Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification. 1296 +|(% style="width:405px" %)DataStructureDefinition & MetadataStructureDefinition|(% style="width:1467px" %)Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will 1297 +|(% style="width:405px" %)**Selector**|(% style="width:1467px" %)**Comment** 1298 +|(% style="width:405px" %) |(% style="width:1467px" %)activate the notification. 1299 +|(% style="width:405px" %)Category|(% style="width:1467px" %)Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category. 1345 1345 1346 -|**Selector**|**Comment** 1347 -|DataProvider|Any datasets or metadata sets registered by the specified data provider will activate the notification. 1348 -|ProvisionAgreement|Any datasets or metadata sets registered for the provision agreement will activate the notification. 1349 -|Dataflow (&Metadataflow)|Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification. 1350 -|DataStructureDefinition & MetadataStructureDefinition|Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will 1351 -|**Selector**|**Comment** 1352 -| |activate the notification. 1353 -|Category|Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category. 1354 - 1355 1355 The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration. 1356 1356 1357 1357 == 7.6 Notification == ... ... @@ -1358,8 +1358,10 @@ 1358 1358 1359 1359 === 7.6.1 Logical Class Diagram === 1360 1360 1307 +[[image:1747829675568-610.png]] 1361 1361 1362 -==== Figure 20: Logical Class Diagram of the Notification ==== 1309 +(% class="wikigeneratedid" id="HFigure20:LogicalClassDiagramoftheNotification" %) 1310 +**Figure 20: Logical Class Diagram of the Notification** 1363 1363 1364 1364 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. 1365 1365 ... ... @@ -1379,5 +1379,3 @@ 1379 1379 === 7.6.3 Registration Event Component === 1380 1380 1381 1381 The notification will contain the Registration. 1382 - 1383 -
- 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