Changes for page SDMX 3.0 Standards. Section 5. Registry Specification: Logical Functionality

Last modified by Helena on 2025/09/10 11:19

From 21.1 to 21.2 From 21.6 to 21.7

From version 21.2

edited by Helena
on 2025/05/15 14:07

Change comment: There is no comment for this version

To version 21.6

edited by Helena
on 2025/05/15 14:12

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -11,7 +11,7 @@
  |(% style="width:188px" %)1.0|(% style="width:205px" %)October 2021|(% style="width:441px" %)Public release for SDMX 3.0
  )))
--= {{id name="_Toc93831"/}}1 Introduction =
++= 1 Introduction =
  The business vision for SDMX envisages the promotion of a “data sharing” model to facilitate low-cost, high-quality statistical data and metadata exchange. Data sharing reduces the reporting burden of organisations by allowing them to publish data once and let their counterparties “pull” data and related metadata as required. The scenario is based on:
@@ -33,12 +33,10 @@
  These architectural standards address the ‘how’, rather than the ‘what’, and are aimed at enabling existing SDMX standards to achieve their mission. The architectural standards address registry services, which initially comprise:
--• structural metadata repository
++* structural metadata repository
++* data and metadata registration
++* query
--• data and metadata registration
--
--• query
--
  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="_Toc93832"/}}2 Scope and Normative Status =
@@ -81,7 +81,8 @@
  [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_28806f51.jpg||height="539" width="443"]]
--====== Figure 1: Schematic of the Basic Structural Artefacts in the SDMX-IM ======
++(% class="wikigeneratedid" id="HFigure1:SchematicoftheBasicStructuralArtefactsintheSDMX-IM" %)
++**Figure 1: Schematic of the Basic Structural Artefacts in the SDMX-IM**
  Note that in Figure 1 (but also most of the relevant subsequent figures) terms that include both data and metadata have been used. For example:
@@ -108,7 +108,7 @@
  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.
++* 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="_Toc93838"/}}3.5 Discovery ==
@@ -167,9 +167,8 @@
  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.
@@ -245,23 +245,22 @@
  * that the components (Dimensions, Attributes, Measures, Metadata Attributes, etc.) are consistent with the Data Structure Definition or Metadata Structure Definition;
  * 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. 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:755.294px" %)
++|(% style="width:187px" %)**Action Attribute Value**|(% style="width:566px" %)**Behaviour**
++|(% style="width:187px" %)Append|(% style="width:566px" %)Add this registration to the registry
++|(% style="width:187px" %)Replace|(% style="width:566px" %)Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request
++|(% style="width:187px" %)Delete|(% style="width:566px" %)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 (for a Dataset registration) or metadata target values (for a Metadataset registration)
--|indexDataSet|(((
--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.
--
++(% style="width:759.294px" %)
++|(% style="width:191px" %)**Boolean Attribute**|(% style="width:565px" %)**Behaviour if Value is “true”**
++|(% style="width:191px" %)indexTimeSeries|(% style="width:565px" %)A compliant indexing application must index all the time series keys (for a Dataset registration) or metadata target values (for a Metadataset registration)
++|(% style="width:191px" %)indexDataSet|(% style="width:565px" %)(((
++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.
  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. The validity period of the Metadatasets may also be indexed.
++|(% style="width:191px" %)indexReportingPeriod|(% style="width:565px" %)A compliant indexing application must index the time period range(s) for which data are present in the Dataset. The validity period of the Metadatasets may also be indexed.
  === {{id name="_Toc93850"/}}5.2.5 Data and Reference Metadata Discovery ===
@@ -295,8 +295,9 @@
  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:757.294px" %)
++|(% style="width:188px" %)**Interface**|(% style="width:542px" %)**Behaviour**
++|(% style="width:188px" %)All|(% style="width:542px" %)(((
 . 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:
@@ -303,14 +303,14 @@
  a) Be a draft version.
  )))
--|**Interface**|**Behaviour**
--| |(((
--b) Not be explicitly^^[[(% class="wikiinternallink wikiinternallink" %)^^1^^>>path:#sdfootnote1sym||name="sdfootnote1anc"]](%%)^^ referenced from any other object in the Registry.
++|(% style="width:188px" %)**Interface**|(% style="width:542px" %)**Behaviour**
++|(% style="width:188px" %) |(% style="width:542px" %)(((
++b) Not be explicitly{{footnote}}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.4-draft does not break integrity of the aforementioned DSD.{{/footnote}} 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.
--|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:188px" %)Structure submission|(% style="width:542px" %)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:188px" %)SubmitRegistrationRequest|(% style="width:542px" %)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="_Toc93853"/}}6 Identification of SDMX Objects =
@@ -340,27 +340,28 @@
  :
  (((
--|**Object Type**|**Data Attributes**|**Status**|**Data type**|**Notes**
--|(% rowspan="4" %)//Annotable//|AnnotationTitle|C|string|
--|AnnotationType|C|string|
--|AnnotationURN|C|string|
--|AnnotationText in the form of InternationalString|C| |This can have languagespecific variants
--|(% rowspan="4" %)//Identifiable//|All content as for //Annotable// plus| | |
--|id|M|string|
--|uri|C|string|
--|urn|C|string|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.
--|(% rowspan="3" %)//Nameable//|All content as for //Identifiable// plus| | |
--|Name in the form of InternationalString|M|string|This can have language specific variants.
--|Description in the form of InternationalString|C|string|This can have language specific variants.
--|(% rowspan="4" %)//Versionable//|All content as for //Identifiable// plus| | |
--|version|M|string|This is the version number according to SDMX versioning rules.
--|validFrom|C|Date/time|
--|validTo|C|Date/time|
--|//Maintainable//|All content as for //Versionable// plus| | |
--| |isExternalReference|C|boolean|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.
--| |serviceURL|C|string|The url of the service that can be queried for this resource.
--| |structureURL|C|string|The url of the resource.
--| |(Maintenance) organisationId|M|string|The object must be linked to a maintenance organisation, i.e., Agency or Metadata Provider.
++(% style="width:1052.29px" %)
++|**Object Type**|(% style="width:241px" %)**Data Attributes**|(% style="width:156px" %)**Status**|**Data type**|(% style="width:457px" %)**Notes**
++|(% rowspan="4" %)//Annotable//|(% style="width:241px" %)AnnotationTitle|(% style="width:156px" %)C|string|(% style="width:457px" %)
++|(% style="width:241px" %)AnnotationType|(% style="width:156px" %)C|string|(% style="width:457px" %)
++|(% style="width:241px" %)AnnotationURN|(% style="width:156px" %)C|string|(% style="width:457px" %)
++|(% style="width:241px" %)AnnotationText in the form of InternationalString|(% style="width:156px" %)C| |(% style="width:457px" %)This can have languagespecific variants
++|(% rowspan="4" %)//Identifiable//|(% style="width:241px" %)All content as for //Annotable// plus|(% style="width:156px" %) | |(% style="width:457px" %)
++|(% style="width:241px" %)id|(% style="width:156px" %)M|string|(% style="width:457px" %)
++|(% style="width:241px" %)uri|(% style="width:156px" %)C|string|(% style="width:457px" %)
++|(% style="width:241px" %)urn|(% style="width:156px" %)C|string|(% style="width:457px" %)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.
++|(% rowspan="3" %)//Nameable//|(% style="width:241px" %)All content as for //Identifiable// plus|(% style="width:156px" %) | |(% style="width:457px" %)
++|(% style="width:241px" %)Name in the form of InternationalString|(% style="width:156px" %)M|string|(% style="width:457px" %)This can have language specific variants.
++|(% style="width:241px" %)Description in the form of InternationalString|(% style="width:156px" %)C|string|(% style="width:457px" %)This can have language specific variants.
++|(% rowspan="4" %)//Versionable//|(% style="width:241px" %)All content as for //Identifiable// plus|(% style="width:156px" %) | |(% style="width:457px" %)
++|(% style="width:241px" %)version|(% style="width:156px" %)M|string|(% style="width:457px" %)This is the version number according to SDMX versioning rules.
++|(% style="width:241px" %)validFrom|(% style="width:156px" %)C|Date/time|(% style="width:457px" %)
++|(% style="width:241px" %)validTo|(% style="width:156px" %)C|Date/time|(% style="width:457px" %)
++|//Maintainable//|(% style="width:241px" %)All content as for //Versionable// plus|(% style="width:156px" %) | |(% style="width:457px" %)
++| |(% style="width:241px" %)isExternalReference|(% style="width:156px" %)C|boolean|(% style="width:457px" %)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.
++| |(% style="width:241px" %)serviceURL|(% style="width:156px" %)C|string|(% style="width:457px" %)The url of the service that can be queried for this resource.
++| |(% style="width:241px" %)structureURL|(% style="width:156px" %)C|string|(% style="width:457px" %)The url of the resource.
++| |(% style="width:241px" %)(Maintenance) organisationId|(% style="width:156px" %)M|string|(% style="width:457px" %)The object must be linked to a maintenance organisation, i.e., Agency or Metadata Provider.
  )))
  **Table 1: Common Attributes of Object Types**
@@ -441,13 +441,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="_Toc93858"/}}6.2.2 Universal Resource Name (URN) =====
++=== {{id name="_Toc93858"/}}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__&nbsp;// ====
  For the URN, all parts of the string are case sensitive. The generic structure of the URN is as follows:
@@ -625,7 +625,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 …
@@ -842,7 +842,7 @@
  • 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)
@@ -1187,3 +1187,5 @@
  IMF.SubAgency1
  [[3>>path:#sdfootnote3anc||name="sdfootnote3sym"]] Note that Codelist is also an EnumeratedList.
++
++{{putFootnotes/}}