Last modified by Artur on 2025/09/30 13:28
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -163,8 +163,9 @@ 163 163 164 164 The registry interfaces are invoked in one of two ways: 165 165 166 -1. The interface is the name of the root node of the SDMX-ML document 167 -1. The interface is invoked as a child element of the RegistryInterface message where the RegistryInterface is the root node of the SDMX-ML document. 166 +* 167 +*1. The interface is the name of the root node of the SDMX-ML document 168 +*1. The interface is invoked as a child element of the RegistryInterface message where the RegistryInterface is the root node of the SDMX-ML document. 168 168 169 169 In addition to these interfaces the registry must support a mechanism for submitting and querying for structural metadata. This is detailed in sections 5.2.2 and 5.2.3. 170 170 ... ... @@ -180,15 +180,15 @@ 180 180 181 181 === 5.2.2 Structure Submission Service === 182 182 183 -The registry must support a mechanism for submitting structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: [[__https:~~/~~/github.com/sdmx-twg/sdmx-rest__>>https://https:github.comsdmx-twgsdmx-rest]]). In order for the architecture to be scalable, the finest-grained piece of structural metadata that can be processed by the SDMX-RR is a MaintainableArtefact, with the exception of Item Schemes, where changes at an Item level is also possible (see next section on the SDMX Information Model).184 +The registry must support a mechanism for submitting structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: __[[https:~~/~~/github.com/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[twg/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[rest>>url:https://github.com/sdmx-twg/sdmx-rest]]__[[)>>url:https://github.com/sdmx-twg/sdmx-rest]]. In order for the architecture to be scalable, the finest-grained piece of structural metadata that can be processed by the SDMX-RR is a MaintainableArtefact, with the exception of Item Schemes, where changes at an Item level is also possible (see next section on the SDMX Information Model). 184 184 185 185 === 5.2.3 Structure Query Service === 186 186 187 -The registry must support a mechanism for querying for structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: [[__https:~~/~~/github.com/sdmx-twg/sdmx-rest__>>https://https:github.comsdmx-twgsdmx-rest]]). The registry response to this query mechanism is the SDMX Structure message, which has as its root node:188 +The registry must support a mechanism for querying for structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: __[[https:~~/~~/github.com/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[twg/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[rest>>url:https://github.com/sdmx-twg/sdmx-rest]]__[[)>>url:https://github.com/sdmx-twg/sdmx-rest]]. The registry response to this query mechanism is the SDMX Structure message, which has as its root node: 188 188 189 - *Structure190 +• Structure 190 190 191 -The SDMX structural artefacts that may be queried are defined in the SDMX structure web service specification which is compatible with this release of the standard __[[https:~~/~~/github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md>>https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]] __[[https:~~/~~/github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md>>https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]]192 +The SDMX structural artefacts that may be queried are defined in the SDMX structure web service specification which is compatible with this release of the standard __[[https:~~/~~/github.com/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]][[->>url:https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]][[twg/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]][[->>url:https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]][[rest/blob/master/doc/structures.md>>url:https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]]__[[url:https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]] 192 192 193 193 === 5.2.4 Data and Reference Metadata Registration Service === 194 194 ... ... @@ -270,7 +270,7 @@ 270 270 1. If the action is set to “delete” (or a maintainable Artefact is DELETEd) then the Registry MUST verify that the object can be deleted. In order to qualify for deletion, the object must: 271 271 272 272 a) Be a draft version. 273 -b) Not be explicitly {{footnote}}Withsemanticversioning,itis allowed toreferencearangeof artefacts, e.g., a DSDreferencingaCodelistwith version1.2.3+ means allpatch versionsgreaterthan1.2.3. This means that deleting1.2.4draftdoes notbreak integrityoftheaforementionedDSD.{{/footnote}}referenced from any other object in the Registry.274 +b) Not be explicitly^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^1^^>>path:#sdfootnote1sym||name="sdfootnote1anc"]](%%)^^ referenced from any other object in the Registry. 274 274 275 275 4) The semantic versioning rules in the SDMX documentation MUST be obeyed. 276 276 ))) ... ... @@ -304,40 +304,47 @@ 304 304 * //Versionable// 305 305 * //Maintainable// 306 306 307 -(% style="width:1038.83px" %) 308 -|(% colspan="2" %)**Object Type**|(% colspan="2" %)**Data Attributes**|(% colspan="2" %)**Status**|(% colspan="2" %)**Data type**|(% colspan="2" %)**Notes** 309 -|(% colspan="2" rowspan="4" %)//Annotable//|(% colspan="2" %)AnnotationTitle|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %) 310 -|(% colspan="2" %)AnnotationType|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %) 311 -|(% colspan="2" %)AnnotationURN|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %) 312 -|(% colspan="2" %)((( 313 -AnnotationText in the form of InternationalString 308 +| |(% colspan="2" %)**Object Type**|(% colspan="2" %)**Data Attributes**|(% colspan="2" %)**Status**|(% colspan="2" %)**Data type**|(% colspan="2" %)**Notes** 309 +| |(% colspan="2" rowspan="4" %)//Annotable//|(% colspan="2" %)AnnotationTitle|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %) 310 +| |(% colspan="2" %)AnnotationType|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %) 311 +| |(% colspan="2" %)AnnotationURN|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %) 312 +| |(% colspan="2" %)((( 313 +AnnotationText in the form of 314 + 315 +InternationalString 314 314 )))|(% colspan="2" %)C|(% colspan="2" %) |(% colspan="2" %)This can have languagespecific variants 315 -|(% colspan="2" rowspan="4" %)//Identifiable//|(% colspan="2" %)All content as for //Annotable// plus|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %) 316 -|(% colspan="2" %)id|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %) 317 -|(% colspan="2" %)uri|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %) 318 -|(% colspan="2" %)urn|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)Although the urn is computable and therefore may not be submitted or stored physically, the Registry must return the urn for each object, and must be able to service a query on an object referenced solely by its urn. 319 -|(% colspan="2" rowspan="3" %)//Nameable//|(% colspan="2" %)((( 320 -All content as for //Identifiable// plus 317 +| |(% colspan="2" rowspan="4" %)//Identifiable//|(% colspan="2" %)All content as for //Annotable// plus|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %) 318 +| |(% colspan="2" %)id|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %) 319 +| |(% colspan="2" %)uri|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %) 320 +| |(% colspan="2" %)urn|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)Although the urn is computable and therefore may not be submitted or stored physically, the Registry must return the urn for each object, and must be able to service a query on an object referenced solely by its urn. 321 +| |(% colspan="2" rowspan="3" %)//Nameable//|(% colspan="2" %)((( 322 +All content as for 323 + 324 +//Identifiable// plus 321 321 )))|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %) 322 -|(% colspan="2" %)((( 323 -Name in the form of InternationalString 326 +| |(% colspan="2" %)((( 327 +Name in the form of 328 + 329 +InternationalString 324 324 )))|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)This can have language specific variants. 325 -|(% colspan="2" %)((( 326 -Description in the form of InternationalString 331 +| |(% colspan="2" %)((( 332 +Description in the form of 333 + 334 +InternationalString 327 327 )))|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)This can have language specific variants. 328 -|(% colspan="2" rowspan="4" %)//Versionable//|(% colspan="2" %)((( 336 +| |(% colspan="2" rowspan="4" %)//Versionable//|(% colspan="2" %)((( 329 329 All content as for 330 330 331 331 //Identifiable// plus 332 332 )))|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %) 333 -|(% colspan="2" %)version|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)This is the version number according to SDMX versioning rules. 334 -|(% colspan="2" %)validFrom|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %) 335 -|(% colspan="2" %)validTo|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %) 336 -|(% colspan="2" %)//Maintainable//|(% colspan="2" %)All content as for //Versionable// plus|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %) 337 -|(% colspan="2" %) |(% colspan="2" %)isExternalReference|(% colspan="2" %)C|(% colspan="2" %)boolean|(% colspan="2" %)Value of “true” indicates that the actual resource is held outside of this registry. The actual reference is given in the registry URI or the structureURL, each of which must return a valid SDMX-ML file.338 -|(% colspan="2" %) |(% colspan="2" %)serviceURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the service that can be queried for this resource.339 -|(% colspan="2" %) |(% colspan="2" %)structureURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the resource.340 -|(% colspan="2" %) |(% colspan="2" %)(Maintenance) organisationId|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)The object must be linked to a maintenance organisation, i.e., Agency or Metadata Provider.341 +| |(% colspan="2" %)version|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)This is the version number according to SDMX versioning rules. 342 +| |(% colspan="2" %)validFrom|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %) 343 +| |(% colspan="2" %)validTo|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %) 344 +|(% colspan="2" rowspan="5" %)//Maintainable//|(% colspan="2" %)All content as for //Versionable// plus|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %) | 345 +|(% colspan="2" %)isExternalReference|(% colspan="2" %)C|(% colspan="2" %)boolean|(% colspan="2" %)Value of “true” indicates that the actual resource is held outside of this registry. The actual reference is given in the registry URI or the structureURL, each of which must return a valid SDMX-ML file.| 346 +|(% colspan="2" %)serviceURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the service that can be queried for this resource.| 347 +|(% colspan="2" %)structureURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the resource.| 348 +|(% colspan="2" %)(Maintenance) organisationId|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)The object must be linked to a maintenance organisation, i.e., Agency or Metadata Provider.| 341 341 342 342 **Table 1: Common Attributes of Object Types** 343 343 ... ... @@ -596,7 +596,7 @@ 596 596 597 597 (% style="width:1272.83px" %) 598 598 |(% style="width:290px" %)**Classname**|(% style="width:649px" %)**Ending URN pattern**|(% style="width:332px" %)**Example** 599 -|(% style="width:290px" %)Agency^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^|(% style="width:649px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|(% style="width:332px" %)ECB:**AGENCIES**(**1.0**).AA607 +|(% style="width:290px" %)Agency^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^|(% style="width:649px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|(% style="width:332px" %)ECB:**AGENCIES**(**1.0**).AA 600 600 |(% style="width:290px" %)//AgencyScheme//|(% style="width:649px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**)|(% style="width:332px" %)ECB:**AGENCIES**(**1.0**) 601 601 |(% style="width:290px" %)//Categorisation//|(% style="width:649px" %)categorisationAgencyId:categorisationId(version)|(% style="width:332px" %)IMF:cat001(1.0.0) 602 602 |(% style="width:290px" %)Category|(% style="width:649px" %)categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|(% style="width:332px" %)IMF:SDDS(1.0.0):level_1_category.level_2_category … ... ... @@ -801,7 +801,7 @@ 801 801 The artefacts included in the structural definitions are: 802 802 803 803 * All types of Item Scheme (Codelist, Concept Scheme, Category Scheme, Organisation Scheme, Agency Scheme, Data Provider Scheme, Metadata Provider Scheme, Data Consumer Scheme, Organisation Unit Scheme, Transformation Scheme, Name Personalisation Scheme, Custom Type Scheme, Vtl Mapping Scheme, Ruleset Scheme, User Defined Operator Scheme) 804 -* All types of Enumerated List (ValueList)^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]](%%)^^812 +* All types of Enumerated List (ValueList)^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]](%%)^^ 805 805 * All types of Structure (Data Structure Definition, Metadata Structure Definition) 806 806 * All types of Structure Usage (Dataflow, Metadataflow) 807 807 ... ... @@ -867,9 +867,9 @@ 867 867 868 868 A Provision Agreement is structural metadata. Each Provision Agreement must reference a Data Provider or Metadata Provider and a Dataflow or Metadataflow Definition. The Data/Metadata Provider and the Dataflow/Metadataflow must exist already in order to set up a Metadata Provision or Provision Agreement. 869 869 870 -== 7.3 Data and Metadata Constraints == 878 +=== {{id name="_Toc90818"/}}7.3 Data and Metadata Constraints === 871 871 872 -=== 7.3.1 Data and Metadata Constraints: Basic Concepts === 880 +===== {{id name="_Toc90819"/}}7.3.1 Data and Metadata Constraints: Basic Concepts ===== 873 873 874 874 Constraints are, effectively, lists of the valid or actual content of data and metadata. Constraints can be used to specify a subset of the theoretical content of data set or metadata set which can be derived from the specification of the DSD or MSD. A Constraint can comprise a list of keys or a list of content (usually code values) of a specific component such as a dimension or attribute. 875 875 ... ... @@ -883,13 +883,13 @@ 883 883 884 884 In addition, DataAvailabilityConstraints can be extremely useful in a data visualisation system, such as dissemination of statistics on a website. In such a system a Cube Region can be used to specify the Dimension codes that actually exist in a data source (these can be used to build relevant selection tables). 885 885 886 -=== 7.3.2 Data and Metadata Constraints: Schematic === 894 +===== {{id name="_Toc90820"/}}7.3.2 Data and Metadata Constraints: Schematic ===== 887 887 888 888 [[image:SDMX 3.1 Section 5_en_28d0cadc.jpg||height="326" width="580"]] 889 889 890 890 **Figure 14: Schematic of the Constraint and the Artefacts that can be constrained** 891 891 892 -=== 7.3.3 Data and Metadata Constraints: Model === 900 +===== {{id name="_Toc90821"/}}7.3.3 Data and Metadata Constraints: Model ===== 893 893 894 894 [[image:SDMX 3.1 Section 5_en_a3184f6a.jpg||height="298" width="579"]] 895 895 ... ... @@ -905,9 +905,9 @@ 905 905 906 906 The content of the Constraint can be found in the SDMX Information Model document. 907 907 908 -== 7.4 Data Registration == 916 +=== {{id name="_Toc90822"/}}7.4 Data Registration === 909 909 910 -=== 7.4.1 Basic Concepts === 918 +===== {{id name="_Toc90823"/}}7.4.1 Basic Concepts ===== 911 911 912 912 A Data Provider has published a new dataset conforming to an existing Dataflow (and hence Data Structure Definition). This is implemented as either a web-accessible SDMXML file, or in a database which has a web-services interface capable of responding to an SDMX RESTful query with an SDMX-ML data stream. 913 913 ... ... @@ -917,15 +917,15 @@ 917 917 918 918 SDMX-RR supports dataset registration via the Registration Request, which can be created by the Data Provider (giving the Data Provider maximum control). The registry responds to the registration request with a registration response which indicates if the registration was successful. In the event of an error, the error messages are returned as a registry exception within the response. 919 919 920 -=== 7.4.2 The Registration Request === 928 +===== {{id name="_Toc90824"/}}7.4.2 The Registration Request ===== 921 921 922 - ====7.4.2.1 Registration Request Schematic====930 +**7.4.2.1 Registration Request Schematic** 923 923 924 924 [[image:SDMX 3.1 Section 5_en_293a2ea6.jpg||height="337" width="554"]] 925 925 926 926 **Figure 16: Schematic of the Objects Concerned with Registration** 927 927 928 - ====7.4.2.2 Registration Request Model====936 +**7.4.2.2 Registration Request Model** 929 929 930 930 The following UML diagram shows the composition of the registration request. Each request is made up of one or more Registrations, one per dataset to be registered. The Registration can optionally have information, which has been extracted from the Registration: 931 931 ... ... @@ -937,11 +937,13 @@ 937 937 938 938 The Registration has an action attribute which takes one of the following values: 939 939 948 +: 949 + 940 940 ((( 941 -| (% style="width:224px" %)**Action Attribute Value**|(% style="width:1457px" %)**Behaviour**942 -| (% style="width:224px" %)Append|(% style="width:1457px" %)Add this Registration to the registry943 -| (% style="width:224px" %)Replace|(% style="width:1457px" %)Replace the existing Registration with identified by the id in the Registration of the SubmitRegistrationRequest944 -| (% style="width:224px" %)Delete|(% style="width:1457px" %)Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest951 +|**Action Attribute Value**|**Behaviour** 952 +|Append|Add this Registration to the registry 953 +|Replace|Replace the existing Registration with identified by the id in the Registration of the SubmitRegistrationRequest 954 +|Delete|Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest 945 945 ))) 946 946 947 947 [[image:SDMX 3.1 Section 5_en_90b3c64a.jpg||height="434" width="579"]] ... ... @@ -960,24 +960,30 @@ 960 960 961 961 https:~/~/github.com/sdmx-twg/sdmx-rest/blob/master/doc/availability.md 962 962 973 +: 974 + 963 963 ((( 964 -(% style="width:918.835px" %) 965 -|**Indexing Required**|(% style="width:745px" %)**Registration Process Activity** 966 -|indexTimeSeries|(% style="width:745px" %)Extract all the series keys and create a KeySet(s) Constraint. 967 -|indexDataSet|(% style="width:745px" %)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. 968 -|indexReportingPeriod|(% style="width:745px" %)((( 976 +|**Indexing Required**|**Registration Process Activity** 977 +|indexTimeSeries|Extract all the series keys and create a KeySet(s) Constraint. 978 +|indexDataSet|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. 979 +|indexReportingPeriod|((( 969 969 This applies only to a registered __dataset__. 981 + 970 970 Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint. 971 971 ))) 972 -|indexAttributes|( % style="width:745px" %)(((984 +|indexAttributes|((( 973 973 **Data Set** 986 + 974 974 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 975 975 976 976 **Metadata Set** 977 -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 990 + 991 +Indicate the presence of a Reported Attribute by creating one or more Cube Regions containing Member Selections of Metadata Attribute 992 + 993 +Components of the Constraints model in the 978 978 ))) 979 -|**Indexing Required**| (% style="width:745px" %)**Registration Process Activity**980 -| | (% style="width:745px" %)SDMX-IM. Note that the content is not stored in the Selection Value.995 +|**Indexing Required**|**Registration Process Activity** 996 +| |SDMX-IM. Note that the content is not stored in the Selection Value. 981 981 ))) 982 982 983 983 Constraints that specify the contents of a //QueryDatasource// are submitted to the Registry via the structure submission service (i.e., the RESTful API). ... ... @@ -984,7 +984,7 @@ 984 984 985 985 The Registration must reference the ProvisionAgreement to which it relates. 986 986 987 -=== 7.4.3 Registration Response === 1003 +===== {{id name="_Toc90825"/}}7.4.3 Registration Response ===== 988 988 989 989 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 SubmitRegistration class has a status field, which is either set to “Success”, “Warning” or “Failure”. 990 990 ... ... @@ -996,7 +996,7 @@ 996 996 997 997 **Figure 18: Logical class diagram showing the registration response** 998 998 999 -== 7.5 Subscription and Notification Service == 1015 +=== {{id name="_Toc90826"/}}7.5 Subscription and Notification Service === 1000 1000 1001 1001 The contents of the SDMX Registry/Repository will change regularly: new code lists and key families will be published and new datasets and metadata-sets will be registered. To obviate the need for users to repeatedly query the registry to see when new information is available, a mechanism is provided to allow users to be notified when these events happen. 1002 1002 ... ... @@ -1004,13 +1004,13 @@ 1004 1004 1005 1005 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”. 1006 1006 1007 -=== 7.5.1 Subscription Logical Class Diagram === 1023 +===== {{id name="_Toc90827"/}}7.5.1 Subscription Logical Class Diagram ===== 1008 1008 1009 1009 [[image:SDMX 3.1 Section 5_en_1433df5d.jpg||height="680" width="587"]] 1010 1010 1011 1011 **Figure 19: Logical Class Diagram of the Subscription** 1012 1012 1013 -=== 7.5.2 Subscription Information === 1029 +===== {{id name="_Toc90828"/}}7.5.2 Subscription Information ===== 1014 1014 1015 1015 Regardless of the type of registry/repository events being observed, a subscription always contains: 1016 1016 ... ... @@ -1019,16 +1019,18 @@ 1019 1019 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. 1020 1020 1. A selector which specifies which type of events are of interest. The set of event types is: 1021 1021 1038 +: 1039 +:: 1040 + 1022 1022 ((( 1023 -(% style="width:1061.83px" %) 1024 -|**Event Type**|(% style="width:660px" %)**Comment** 1025 -|STRUCTURAL_REPOSITORY_EVENTS|(% style="width:660px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository. 1026 -|DATA_REGISTRATION_EVENTS|(% style="width:660px" %)Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database. 1027 -|METADATA_REGISTRATION_EVENTS|(% style="width:660px" %)Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database. 1028 -|ALL_EVENTS|(% style="width:660px" %)All events of the specified EventType 1042 +|**Event Type**|**Comment** 1043 +|STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository. 1044 +|DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database. 1045 +|METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database. 1046 +|ALL_EVENTS|All events of the specified EventType 1029 1029 ))) 1030 1030 1031 -=== 7.5.3 Wildcard Facility === 1049 +===== {{id name="_Toc90829"/}}7.5.3 Wildcard Facility ===== 1032 1032 1033 1033 Subscription notification supports wildcarded identifier components URNs, which are identifiers which have some or all of their component parts replaced by the wildcard character `*`. Identifier components comprise: 1034 1034 ... ... @@ -1084,29 +1084,30 @@ 1084 1084 1085 1085 The complete SDMX versioning syntax can be found in the SDMX Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”. 1086 1086 1087 -=== 7.5.4 Structural Repository Events === 1105 +===== {{id name="_Toc90830"/}}7.5.4 Structural Repository Events ===== 1088 1088 1089 1089 Whenever a maintainable artefact (data structure definition, concept scheme, codelist, metadata structure definition, category scheme, etc.) is added to, deleted from, or modified in the structural metadata repository, a structural metadata event is triggered. Subscriptions may be set up to monitor all such events, or focus on specific artefacts such as a Data Structure Definition. 1090 1090 1091 -=== 7.5.5 Registration Events === 1109 +===== {{id name="_Toc90831"/}}7.5.5 Registration Events ===== 1092 1092 1093 1093 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: 1094 1094 1113 +: 1114 + 1095 1095 ((( 1096 -(% style="width:1082.83px" %) 1097 -|(% style="width:230px" %)**Selector**|(% style="width:850px" %)**Comment** 1098 -|(% style="width:230px" %)DataProvider|(% style="width:850px" %)Any datasets registered by the specified dataprovider will activate the notification. 1099 -|(% style="width:230px" %)ProvisionAgreement|(% style="width:850px" %)Any datasets for the agreement will activate the notification. 1100 -|(% style="width:230px" %)Dataflow|(% style="width:850px" %)Any datasets for the specified dataflow will activate the notification. 1101 -|(% style="width:230px" %)DataStructureDefinition|(% style="width:850px" %)Any datasets for those dataflows that are based on the specified Data Structure Definition will activate the notification 1102 -|(% style="width:230px" %)Category|(% style="width:850px" %)Any datasets registered for those dataflows, provision agreements that are categorised by the category. 1116 +|**Selector**|**Comment** 1117 +|DataProvider|Any datasets registered by the specified dataprovider will activate the notification. 1118 +|ProvisionAgreement|Any datasets for the agreement will activate the notification. 1119 +|Dataflow|Any datasets for the specified dataflow will activate the notification. 1120 +|DataStructureDefinition|Any datasets for those dataflows that are based on the specified Data Structure Definition will activate the notification 1121 +|Category|Any datasets registered for those dataflows, provision agreements that are categorised by the category. 1103 1103 ))) 1104 1104 1105 1105 The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration. 1106 1106 1107 -== 7.6 Notification == 1126 +== {{id name="_Toc90832"/}}7.6 Notification == 1108 1108 1109 -=== 7.6.1 Logical Class Diagram === 1128 +==== {{id name="_Toc90833"/}}7.6.1 Logical Class Diagram ==== 1110 1110 1111 1111 [[image:SDMX 3.1 Section 5_en_8bc1b889.jpg||height="379" width="579"]] 1112 1112 ... ... @@ -1123,15 +1123,15 @@ 1123 1123 1124 1124 Additionally, supplementary information may be contained in the notification as detailed below. 1125 1125 1126 -=== 7.6.2 Structural Event Component === 1145 +==== {{id name="_Toc90834"/}}7.6.2 Structural Event Component ==== 1127 1127 1128 1128 The notification will contain the MaintainableArtefact that triggered the event in a form similar to the SDMX-ML structural message (using elements from that namespace). 1129 1129 1130 -=== 7.6.3 Registration Event Component === 1149 +==== {{id name="_Toc90835"/}}7.6.3 Registration Event Component ==== 1131 1131 1132 1132 The notification will contain the Registration. 1133 1133 1134 - ----1153 +[[1>>path:#sdfootnote1anc||name="sdfootnote1sym"]] With semantic versioning, it is allowed to reference a range of artefacts, e.g., a DSD referencing a Codelist with version 1.2.3+ means all patch versions greater than 1.2.3. This means that deleting 1.2.4draft does not break integrity of the aforementioned DSD. 1135 1135 1136 1136 [[2>>path:#sdfootnote2anc||name="sdfootnote2sym"]] The identification of an Agency in the URN structure for the maintainable object is by means of the agencyId. The AgencyScheme is not identified as SDMX has a mechanism for identifying an Agency uniquely by its Id. Note that this Id may be hierarchical. For example, a sub-agency of IMF is referred like this: 1137 1137 ... ... @@ -1138,5 +1138,3 @@ 1138 1138 IMF.SubAgency1 1139 1139 1140 1140 [[3>>path:#sdfootnote3anc||name="sdfootnote3sym"]] Note that Codelist is also an EnumeratedList. 1141 - 1142 -{{putFootnotes/}}