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.2 to 21.3 From 21.9 to 21.10

From version 21.3

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

Change comment: There is no comment for this version

To version 21.9

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

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -37,7 +37,7 @@
  The registry services outlined in this specification are designed to help the SDMX community manage the proliferation of SDMX assets and to support data sharing for reporting and dissemination.
--= {{id name="_Toc90781"/}}2 Scope and Normative Status =
++= 2 Scope and Normative Status =
  The scope of this document is to specify the logical interfaces for the SDMX registry in terms of the functions required and the data that may be present in the function call, and the behaviour expected of the registry.
@@ -54,9 +54,9 @@
  Note that although the term “authorised user” is used in this document, the SDMX standards do not define an access control mechanism. Such a mechanism, if required, must be chosen and implemented by the registry software provider.
--= {{id name="_Toc90782"/}}3 Scope of the SDMX Registry/Repository =
++= 3 Scope of the SDMX Registry/Repository =
--=== {{id name="_Toc90783"/}}3.1 Objective ===
++== 3.1 Objective ==
  The objective of the SDMX registry/repository is, in broad terms, to allow organisations to publish statistical data and reference metadata in known formats such that interested third parties can discover these data and interpret them accurately and correctly. The mechanism for doing this is twofold:
@@ -63,7 +63,7 @@
 . To maintain and publish structural metadata that describes the structure and valid content of data and reference metadata sources such as databases, metadata repositories, data sets, metadata sets. This structural metadata enables software applications to understand and to interpret the data and reference metadata in these sources.
 . To enable applications, organisations, and individuals to share and to discover data and reference metadata. This facilitates data and reference metadata dissemination by implementing the data sharing vision of SDMX.
--=== {{id name="_Toc90784"/}}3.2 Structural Metadata ===
++== 3.2 Structural Metadata ==
  Setting up structural metadata and the exchange context (referred to as “data provisioning”) involves the following steps for maintenance agencies:
@@ -89,7 +89,7 @@
  In that context, the term “Metadata” refers to reference metadata.
--=== {{id name="_Toc90785"/}}3.3 Registration ===
++== 3.3 Registration ==
  Publishing the data and reference metadata involves the following steps for a Data/Metadata Provider:
@@ -100,13 +100,13 @@
  **Figure 2: Schematic of Registered Data and Metadata Sources in the SDMX-IM**
--=== {{id name="_Toc90786"/}}3.4 Notification ===
++== 3.4 Notification ==
  Notifying interested parties of newly published or re-published data, reference metadata or changes in structural metadata involves:
  • registry support of a subscription-based notification service which sends an email or notifies an HTTP address announcing all published data that meets the criteria contained in the subscription request.
--=== {{id name="_Toc90787"/}}3.5 Discovery ===
++== 3.5 Discovery ==
  Discovering published data and reference metadata involves interaction with the registry to fulfil the following logical steps that would be carried out by a user interacting with a service that itself interacts with the registry and an SDMX-enabled data or reference metadata resource:
@@ -118,9 +118,9 @@
  **Figure 3: Schematic of Data and Metadata Discovery and Query in the SDMX-IM**
--= {{id name="_Toc90788"/}}4 SDMX Registry/Repository Architecture =
++= 4 SDMX Registry/Repository Architecture =
--=== {{id name="_Toc90789"/}}4.1 Architectural Schematic ===
++== 4.1 Architectural Schematic ==
  The architecture of the SDMX registry/repository is derived from the objectives stated above. It is a layered architecture that is founded by a structural metadata repository which supports a provisioning metadata repository which supports the registry services. These are all supported by the SDMX-ML schemas. Applications can be built on top of these services which support the reporting, storage, retrieval, and dissemination aspects of the statistical lifecycle as well as the maintenance of the structural metadata required to drive these applications.
@@ -128,7 +128,7 @@
  **Figure 4: Schematic of the Registry Content and Services**
--=== {{id name="_Toc90790"/}}4.2 Structural Metadata Repository ===
++== 4.2 Structural Metadata Repository ==
  The basic layer is that of a structural metadata service which supports the lifecycle of SDMX structural metadata artefacts such as Maintenance Agencies, Data Structure Definitions, Metadata Structure Definitions, Provision Agreements, Processes etc. This layer is supported by the Structure Submission and Query Service.
@@ -139,15 +139,15 @@
  As of the initial version of SDMX 3.0 no messages are defined to support these artefacts; hence, users may need to use SDMX 2.1 Registry Interface messages, instead.
--=== {{id name="_Toc90791"/}}4.3 Provisioning Metadata Repository ===
++== 4.3 Provisioning Metadata Repository ==
  The function of this repository is to support the definition of the structural metadata that describes the various types of data-store which model SDMX-conformant databases or files, and to link to these data sources. These links can be specified for a data/metadata provider, for a specific data or metadata flow. In the SDMX model this is called the Provision or Metadata Provision Agreement.
  This layer is supported by the Data and Metadata Registration Service.
--= {{id name="_Toc90792"/}}5 Registry Interfaces and Services =
++= 5 Registry Interfaces and Services =
--=== {{id name="_Toc90793"/}}5.1 Registry Interfaces ===
++== 5.1 Registry Interfaces ==
  The Registry Interfaces are:
@@ -163,7 +163,7 @@
  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.
@@ -173,17 +173,17 @@
  It should be noted that all interactions are assumed to be synchronous, with the exception of Notify Registry Event. This document is sent by the SDMX-RR to all subscribers whenever an even occurs to which any users have subscribed. Thus, it does not conform to the requestresponse pattern, because it is inherently asynchronous.
--=== {{id name="_Toc90794"/}}5.2 Registry Services ===
++== 5.2 Registry Services ==
--===== {{id name="_Toc90795"/}}5.2.1 Introduction =====
++=== 5.2.1 Introduction ===
  The services described in this section do not imply that each is implemented as a discrete web service.
--===== {{id name="_Toc90796"/}}5.2.2 Structure Submission Service =====
++=== 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>>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).
--===== {{id name="_Toc90797"/}}5.2.3 Structure Query Service =====
++=== 5.2.3 Structure Query Service ===
  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:
@@ -191,7 +191,7 @@
  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]]
--===== {{id name="_Toc90798"/}}5.2.4 Data and Reference Metadata Registration Service =====
++=== 5.2.4 Data and Reference Metadata Registration Service ===
  This service must implement the following Registry Interfaces:
@@ -214,23 +214,24 @@
  The Registration has an action attribute which takes one of the following values:
--|**Action Attribute Value**|**Behaviour**
--|Append|Add this registration to the registry
--|Replace|Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request
--|Delete|Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
++(% style="width:893.835px" %)
++|(% style="width:241px" %)**Action Attribute Value**|(% style="width:650px" %)**Behaviour**
++|(% style="width:241px" %)Append|(% style="width:650px" %)Add this registration to the registry
++|(% style="width:241px" %)Replace|(% style="width:650px" %)Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request
++|(% style="width:241px" %)Delete|(% style="width:650px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
  The Registration has three Boolean attributes which may be present to determine how an SDMX compliant dataset or metadataset indexing application must index the datasets or metadatasets upon registration. The indexing application behaviour is as follows:
--|**Boolean Attribute**|**Behaviour if Value is “true”**
--|indexTimeSeries|A compliant indexing application must index all the time series keys
--|indexDataSet|(((
++(% style="width:896.835px" %)
++|**Boolean Attribute**|(% style="width:712px" %)**Behaviour if Value is “true”**
++|indexTimeSeries|(% style="width:712px" %)A compliant indexing application must index all the time series keys
++|indexDataSet|(% style="width:712px" %)(((
  A compliant indexing application must index the range of actual (present) values for each dimension of the Dataset.
--
  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
  )))
--|indexReportingPeriod|A compliant indexing application must index the time period range(s) for which data are present in the Dataset.
++|indexReportingPeriod|(% style="width:712px" %)A compliant indexing application must index the time period range(s) for which data are present in the Dataset.
--===== {{id name="_Toc90799"/}}5.2.5 Data Discovery =====
++=== 5.2.5 Data Discovery ===
  The Data Discovery Service implements the following Registry Interfaces:
@@ -237,7 +237,7 @@
  * QueryRegistrationRequest
  * QueryRegistrationResponse
--===== {{id name="_Toc90800"/}}5.2.6 Subscription and Notification =====
++=== 5.2.6 Subscription and Notification ===
  The Subscription and Notification Service implements the following Registry Interfaces:
@@ -256,34 +256,32 @@
  Notification requires that the structural metadata repository and the provisioning metadata repository monitor any event which is of interest to a user (the object of a subscription request query), and to issue an SDMX notification document to the endpoints specified in the relevant subscriptions.
--===== {{id name="_Toc90801"/}}5.2.7 Registry Behaviour =====
++=== 5.2.7 Registry Behaviour ===
  The following table defines the behaviour of the SDMX Registry for the various Registry Interface messages. It should be noted, though, that as of SDMX 3.0, an extended versioning scheme newly including semantic versioning is foreseen for all Maintainable Artefacts. Moreover, while the old versioning scheme is allowed, given there is no more a "final" flag, there is no way guaranteeing the consistency across version of a Maintainable, unless semantic versioning is used.
  Given the above, the behaviour described in the following table concerns either draft Artefacts using semantic versioning or any Artefacts using the old versioning scheme. Nevertheless, in the case of semantic versioning the registry must respect the versioning rules when performing the actions below. For example, it is not possible to replace a non-draft Artefact that follows semantic versioning, unless a newer version is introduced according to the semantic versioning rules. Furthermore, even when draft Artefacts are submitted, the registry has to verify semantic versioning is respected against the previous non-draft versions. It is worth noting that the rules for semantic versioning and replacing or maintaining semantically versioned Artefacts applies to externally shared Artefacts. This means that any system may internally perform any change within a version of an Artefact, until the latter is shared outside of that system or becomes public. Then (as also explained in the SDMX Standards Section 6 “Technical Notes”) the Artefacts must adhere to the Semantic Versioning rules.
--|**Interface**|**Behaviour**
--|All|(((
++(% style="width:982.835px" %)
++|(% style="width:217px" %)**Interface**|(% style="width:763px" %)**Behaviour**
++|(% style="width:217px" %)All|(% style="width:763px" %)(((
 . If the action is set to “replace” (or a maintainable Artefact is PUT or POSTed) then the entire contents of the existing maintainable object in the Registry MUST be replaced by the object submitted.
 . 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.
 . 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:
--1. Be a draft version.
++a) Be a draft version.
++b) Not be explicitly^^[[(% class="wikiinternallink wikiinternallink wikiinternallink" %)^^1^^>>path:#sdfootnote1sym||name="sdfootnote1anc"]](%%)^^ referenced from any other object in the Registry.
--b) Not be explicitly^^[[(% class="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.
  )))
--|Structure submission|(((
--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.
++|(% style="width:217px" %)Structure submission|(% style="width:763px" %)(((
++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.
  )))
--|SubmitRegistrationRequest|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. For a queryable datasource the Registry MAY validate that the source exists and can accept an SDMX data query.
++|(% style="width:217px" %)SubmitRegistrationRequest|(% style="width:763px" %)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. For a queryable datasource the Registry MAY validate that the source exists and can accept an SDMX data query.
--= {{id name="_Toc90802"/}}6 Identification of SDMX Objects =
++= 6 Identification of SDMX Objects =
--=== {{id name="_Toc90803"/}}6.1 Identification, Versioning, and Maintenance ===
++== 6.1 Identification, Versioning, and Maintenance ==
  All major classes of the SDMX Information model inherit from one of:
@@ -292,7 +292,7 @@
  * //**VersionableArtefact**// – this has all of the above features plus a version number, according to the SDMX versioning rules in SDMX Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”, and a validity period.
  * //**MaintainableArtefact**// – this has all of the above features, plus registry and structure URIs, and an association to the maintenance organisation of the object.
--===== {{id name="_Toc90804"/}}6.1.1 Identification, Naming, Versioning, and Maintenance Model =====
++=== 6.1.1 Identification, Naming, Versioning, and Maintenance Model ===
  [[image:SDMX 3.1 Section 5_en_4a9b2cfc.jpg||height="688" width="587"]]
@@ -301,13 +301,11 @@
  The table below shows the identification and related data attributes to be stored in a registry for objects that are one of:
  * //Annotable//
++* //Identifiable//
++* //Nameable//
++* //Versionable//
++* //Maintainable//
--//Identifiable// • //Nameable//
--
--• //Versionable//
--
--• //Maintainable//
--
  | |(% colspan="2" %)**Object Type**|(% colspan="2" %)**Data Attributes**|(% colspan="2" %)**Status**|(% colspan="2" %)**Data type**|(% colspan="2" %)**Notes**
  | |(% colspan="2" rowspan="4" %)//Annotable//|(% colspan="2" %)AnnotationTitle|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
  | |(% colspan="2" %)AnnotationType|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
@@ -352,9 +352,9 @@
  **Table 1: Common Attributes of Object Types**
--=== {{id name="_Toc90805"/}}6.2 Unique identification of SDMX objects ===
++== 6.2 Unique identification of SDMX objects ==
--===== {{id name="_Toc90806"/}}6.2.1 Agencies and Metadata Providers =====
++=== 6.2.1 Agencies and Metadata Providers ===
  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.
@@ -387,14 +387,11 @@
  The following organizations maintain an Agency Scheme.
--• SDMX – contains Agencies AA, BB
++* SDMX – contains Agencies AA, BB
++* AA – contains Agencies CC, DD
++* BB – contains Agencies CC, DD
++* DD – Contains Agency EE
--• AA – contains Agencies CC, DD
--
--• BB – contains Agencies CC, DD
--
--• DD – Contains Agency EE
--
  Each agency is identified by its full hierarchy excluding SDMX.
  e.g., the id of EE as an agencyID is AA.DD.EE
@@ -407,13 +407,13 @@
  Following the same principles, the Metadata Provider is the maintenance organisation for a special subset of Maintainable Artefacts, i.e., the Metadatasets; the latter are the containers of reference metadata combined with a target that those metadata refer to.
--===== {{id name="_Toc90807"/}}6.2.2 Universal Resource Name (URN) =====
++=== 6.2.2 Universal Resource Name (URN) ===
--**6.2.2.1 Introduction**
++==== 6.2.2.1 Introduction ====
  To provide interoperability between SDMX Registry/Repositories in a distributed network environment, it is important to have a scheme for uniquely identifying (and thus accessing) all first-class (Identifiable) SDMX-IM objects. Most of these unique identifiers are composite (containing maintenance agency, or parent object identifiers), and there is a need to be able to construct a unique reference as a single string. This is achieved by having a globally unique identifier called a universal resource name (URN) which is generated from the actual identification components in the SDMX-RR APIs. In other words, the URN for any Identifiable Artefact is constructed from its component identifiers (agency, id, version etc.).
--**6.2.2.2 URN Structure //__Case Rules for URN__//**//&nbsp;//
++==== 6.2.2.2 URN Structure //__Case Rules for URN__// ====
  For the URN, all parts of the string are case sensitive. The generic structure of the URN is as follows:
@@ -609,7 +609,7 @@
  urn:sdmx.org.sdmx.infomodel.{package}.{classname}=
  |**Classname**|**Ending URN pattern**|**Example**
--|Agency^^[[(% class="wikiinternallink wikiinternallink" %)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^|agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|ECB:**AGENCIES**(**1.0**).AA
++|Agency^^[[(% class="wikiinternallink wikiinternallink wikiinternallink" %)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^|agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|ECB:**AGENCIES**(**1.0**).AA
  |//AgencyScheme//|agencySchemeAgencyId:**AGENCIES**(**1.0**)|ECB:**AGENCIES**(**1.0**)
  |//Categorisation//|categorisationAgencyId:categorisationId(version)|IMF:cat001(1.0.0)
  |Category|categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|IMF:SDDS(1.0.0):level_1_category.level_2_category …
@@ -834,7 +834,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" %)^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]](%%)^^
++* All types of Enumerated List (ValueList)^^[[(% class="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)
@@ -858,13 +858,13 @@
  In addition to the maintenance of the Dataflow and the Metadataflow, the following links must be maintained in the registry:
--1.
++1.
 *. Dataflow to Data Structure Definition
 *. Metadataflow to Metadata Structure Definition
  The following links may be created by means of a Categorisation
--1.
++1.
 *. Categorisation to Dataflow and Category
 *. Categorisation to Metadataflow and Category
@@ -1060,7 +1060,7 @@
 . 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:
--:
++:
  ::
  (((