Changes for page SDMX 3.1 Standards. Section 5. Registry Specification: Logical Interfaces

Last modified by Artur on 2025/09/30 13:28

From 21.10 to 21.9 From 22.4 to 22.3

From version 22.3

edited by Helena
on 2025/06/08 16:48

Change comment: There is no comment for this version

To version 21.10

edited by Helena
on 2025/06/08 16:40

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -163,8 +163,9 @@
  The registry interfaces are invoked in one of two ways:
--1. The interface is the name of the root node of the SDMX-ML document
--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.
++*
++*1. The interface is the name of the root node of the SDMX-ML document
++*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.
  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.
@@ -180,7 +180,7 @@
  === 5.2.2 Structure Submission Service ===
--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).
++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).
  === 5.2.3 Structure Query Service ===
@@ -270,7 +270,7 @@
 . 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:
  a) Be a draft version.
--b) Not be explicitly^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^1^^>>path:#sdfootnote1sym||name="sdfootnote1anc"]](%%)^^ referenced from any other object in the Registry.
++b) Not be explicitly^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^1^^>>path:#sdfootnote1sym||name="sdfootnote1anc"]](%%)^^ referenced from any other object in the Registry.
 ) The semantic versioning rules in the SDMX documentation MUST be obeyed.
  )))
@@ -603,7 +603,7 @@
  (% style="width:1272.83px" %)
  |(% style="width:290px" %)**Classname**|(% style="width:649px" %)**Ending URN pattern**|(% style="width:332px" %)**Example**
--|(% style="width:290px" %)Agency^^[[(% class="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**).AA
++|(% 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
  |(% style="width:290px" %)//AgencyScheme//|(% style="width:649px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**)|(% style="width:332px" %)ECB:**AGENCIES**(**1.0**)
  |(% style="width:290px" %)//Categorisation//|(% style="width:649px" %)categorisationAgencyId:categorisationId(version)|(% style="width:332px" %)IMF:cat001(1.0.0)
  |(% 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 …
@@ -808,7 +808,7 @@
  The artefacts included in the structural definitions are:
  * 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)
--* All types of Enumerated List (ValueList)^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]](%%)^^
++* All types of Enumerated List (ValueList)^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]](%%)^^
  * All types of Structure (Data Structure Definition, Metadata Structure Definition)
  * All types of Structure Usage (Dataflow, Metadataflow)
@@ -874,9 +874,9 @@
  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.
--== 7.3 Data and Metadata Constraints ==
++=== {{id name="_Toc90818"/}}7.3 Data and Metadata Constraints ===
--=== 7.3.1 Data and Metadata Constraints: Basic Concepts ===
++===== {{id name="_Toc90819"/}}7.3.1 Data and Metadata Constraints: Basic Concepts =====
  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.
@@ -890,13 +890,13 @@
  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).
--=== 7.3.2 Data and Metadata Constraints: Schematic ===
++===== {{id name="_Toc90820"/}}7.3.2 Data and Metadata Constraints: Schematic =====
  [[image:SDMX 3.1 Section 5_en_28d0cadc.jpg||height="326" width="580"]]
  **Figure 14: Schematic of the Constraint and the Artefacts that can be constrained**
--=== 7.3.3 Data and Metadata Constraints: Model ===
++===== {{id name="_Toc90821"/}}7.3.3 Data and Metadata Constraints: Model =====
  [[image:SDMX 3.1 Section 5_en_a3184f6a.jpg||height="298" width="579"]]
@@ -912,9 +912,9 @@
  The content of the Constraint can be found in the SDMX Information Model document.
--== 7.4 Data Registration ==
++=== {{id name="_Toc90822"/}}7.4 Data Registration ===
--=== 7.4.1 Basic Concepts ===
++===== {{id name="_Toc90823"/}}7.4.1 Basic Concepts =====
  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.
@@ -924,15 +924,15 @@
  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.
--=== 7.4.2 The Registration Request ===
++===== {{id name="_Toc90824"/}}7.4.2 The Registration Request =====
--==== 7.4.2.1 Registration Request Schematic ====
++**7.4.2.1 Registration Request Schematic**
  [[image:SDMX 3.1 Section 5_en_293a2ea6.jpg||height="337" width="554"]]
  **Figure 16: Schematic of the Objects Concerned with Registration**
--==== 7.4.2.2 Registration Request Model ====
++**7.4.2.2 Registration Request Model**
  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:
@@ -944,11 +944,13 @@
  The Registration has an action attribute which takes one of the following values:
++:
++
  (((
--|(% style="width:224px" %)**Action Attribute Value**|(% style="width:1457px" %)**Behaviour**
--|(% style="width:224px" %)Append|(% style="width:1457px" %)Add this Registration to the registry
--|(% style="width:224px" %)Replace|(% style="width:1457px" %)Replace the existing Registration with identified by the id in the Registration of the SubmitRegistrationRequest
--|(% style="width:224px" %)Delete|(% style="width:1457px" %)Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest
++|**Action Attribute Value**|**Behaviour**
++|Append|Add this Registration to the registry
++|Replace|Replace the existing Registration with identified by the id in the Registration of the SubmitRegistrationRequest
++|Delete|Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest
  )))
  [[image:SDMX 3.1 Section 5_en_90b3c64a.jpg||height="434" width="579"]]
@@ -967,24 +967,30 @@
  https:~/~/github.com/sdmx-twg/sdmx-rest/blob/master/doc/availability.md
++:
++
  (((
--(% style="width:918.835px" %)
--|**Indexing Required**|(% style="width:745px" %)**Registration Process Activity**
--|indexTimeSeries|(% style="width:745px" %)Extract all the series keys and create a KeySet(s) Constraint.
--|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.
--|indexReportingPeriod|(% style="width:745px" %)(((
++|**Indexing Required**|**Registration Process Activity**
++|indexTimeSeries|Extract all the series keys and create a KeySet(s) Constraint.
++|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.
++|indexReportingPeriod|(((
  This applies only to a registered __dataset__.
++
  Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint.
  )))
--|indexAttributes|(% style="width:745px" %)(((
++|indexAttributes|(((
  **Data Set**
++
  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
  **Metadata Set**
--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
++
++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
  )))
--|**Indexing Required**|(% style="width:745px" %)**Registration Process Activity**
--| |(% style="width:745px" %)SDMX-IM. Note that the content is not stored in the Selection Value.
++|**Indexing Required**|**Registration Process Activity**
++| |SDMX-IM. Note that the content is not stored in the Selection Value.
  )))
  Constraints that specify the contents of a //QueryDatasource// are submitted to the Registry via the structure submission service (i.e., the RESTful API).
@@ -991,7 +991,7 @@
  The Registration must reference the ProvisionAgreement to which it relates.
--=== 7.4.3 Registration Response ===
++===== {{id name="_Toc90825"/}}7.4.3 Registration Response =====
  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”.
@@ -1003,7 +1003,7 @@
  **Figure 18: Logical class diagram showing the registration response**
--== 7.5 Subscription and Notification Service ==
++=== {{id name="_Toc90826"/}}7.5 Subscription and Notification Service ===
  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.
@@ -1011,13 +1011,13 @@
  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”.
--=== 7.5.1 Subscription Logical Class Diagram ===
++===== {{id name="_Toc90827"/}}7.5.1 Subscription Logical Class Diagram =====
  [[image:SDMX 3.1 Section 5_en_1433df5d.jpg||height="680" width="587"]]
  **Figure 19: Logical Class Diagram of the Subscription**
--=== 7.5.2 Subscription Information ===
++===== {{id name="_Toc90828"/}}7.5.2 Subscription Information =====
  Regardless of the type of registry/repository events being observed, a subscription always contains:
@@ -1026,16 +1026,18 @@
 . 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.
 . A selector which specifies which type of events are of interest. The set of event types is:
++:
++::
++
  (((
--(% style="width:1061.83px" %)
--|**Event Type**|(% style="width:660px" %)**Comment**
--|STRUCTURAL_REPOSITORY_EVENTS|(% style="width:660px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
--|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.
--|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.
--|ALL_EVENTS|(% style="width:660px" %)All events of the specified EventType
++|**Event Type**|**Comment**
++|STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
++|DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
++|METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
++|ALL_EVENTS|All events of the specified EventType
  )))
--=== 7.5.3 Wildcard Facility ===
++===== {{id name="_Toc90829"/}}7.5.3 Wildcard Facility =====
  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:
@@ -1091,29 +1091,30 @@
  The complete SDMX versioning syntax can be found in the SDMX Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”.
--=== 7.5.4 Structural Repository Events ===
++===== {{id name="_Toc90830"/}}7.5.4 Structural Repository Events =====
  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.
--=== 7.5.5 Registration Events ===
++===== {{id name="_Toc90831"/}}7.5.5 Registration Events =====
  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:
++:
++
  (((
--(% style="width:1082.83px" %)
--|(% style="width:230px" %)**Selector**|(% style="width:850px" %)**Comment**
--|(% style="width:230px" %)DataProvider|(% style="width:850px" %)Any datasets registered by the specified dataprovider will activate the notification.
--|(% style="width:230px" %)ProvisionAgreement|(% style="width:850px" %)Any datasets for the agreement will activate the notification.
--|(% style="width:230px" %)Dataflow|(% style="width:850px" %)Any datasets for the specified dataflow will activate the notification.
--|(% 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
--|(% style="width:230px" %)Category|(% style="width:850px" %)Any datasets registered for those dataflows, provision agreements that are categorised by the category.
++|**Selector**|**Comment**
++|DataProvider|Any datasets registered by the specified dataprovider will activate the notification.
++|ProvisionAgreement|Any datasets for the agreement will activate the notification.
++|Dataflow|Any datasets for the specified dataflow will activate the notification.
++|DataStructureDefinition|Any datasets for those dataflows that are based on the specified Data Structure Definition will activate the notification
++|Category|Any datasets registered for those dataflows, provision agreements that are categorised by the category.
  )))
  The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration.
--== 7.6 Notification ==
++== {{id name="_Toc90832"/}}7.6 Notification ==
--=== 7.6.1 Logical Class Diagram ===
++==== {{id name="_Toc90833"/}}7.6.1 Logical Class Diagram ====
  [[image:SDMX 3.1 Section 5_en_8bc1b889.jpg||height="379" width="579"]]
@@ -1130,11 +1130,11 @@
  Additionally, supplementary information may be contained in the notification as detailed below.
--=== 7.6.2 Structural Event Component ===
++==== {{id name="_Toc90834"/}}7.6.2 Structural Event Component ====
  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).
--=== 7.6.3 Registration Event Component ===
++==== {{id name="_Toc90835"/}}7.6.3 Registration Event Component ====
  The notification will contain the Registration.