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

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

From 2.4 to 2.3

From version 2.3

edited by Helena
on 2025/05/21 14:19

Change comment: There is no comment for this version

To version 1.1

edited by Helena
on 2025/05/21 13:44

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Attachments (0 modified, 0 added, 1 removed)
- 1747824504225-229.png

Details

Page properties

Content

@@ -192,8 +192,10 @@
  In addition to these interfaces the registry must support a mechanism for querying for structural metadata. This is detailed in 5.2.2.
--All these interactions with the Registry – with the exception of Notify Registry Event – are designed in pairs. The first document – the one which invokes the SDMX-RR interface, is a “Request” document. The message returned by the interface is a “Response” document.
++All these interactions with the Registry – with the exception of Notify Registry Event – are designed in pairs. The first document – the one which invokes the SDMX-RR interface, is a “Request” document. The message returned by the interface is a
++“Response” document.
++
  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 request-response pattern, because it is inherently asynchronous.
  == 5.2 Registry Services ==
@@ -292,13 +292,15 @@
 The Registration has an action attribute which takes one of the following values:
--|(% style="width:249px" %)(((
--**Action Attribute Value**
--)))|(% style="width:1622px" %)**Behaviour**
--|(% style="width:249px" %)Append|(% style="width:1622px" %)Add this registration to the registry
--|(% style="width:249px" %)Replace|(% style="width:1622px" %)Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request
--|(% style="width:249px" %)Delete|(% style="width:1622px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
++|(((
++**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
++
  The Registration has three Boolean attributes which may be present to determine how an SDMX compliant Dataset or Metadata Set indexing application must index the Datasets or Metadata Set upon registration. The indexing application behaviour is as follows:
  |**Boolean Attribute**|**Behaviour if Value is “true”**
@@ -314,9 +314,10 @@
  The Data and Metadata Discovery Service implements the following Registry Interfaces:
--* QueryRegistrationRequest
--* QueryRegistrationResponse
++         QueryRegistrationRequest
++         QueryRegistrationResponse
++
  === 5.2.6 Subscription and Notification ===
  The Subscription and Notification Service implements the following Registry Interfaces:
@@ -340,12 +340,13 @@
  The following table defines the behaviour of the SDMX Registry for the various Registry Interface messages.
--|(% style="width:244px" %)**Interface**|**Behaviour**
--|(% style="width:244px" %)All|(((
++|**Interface**|**Behaviour**
++|All|(((
 ) If the action is set to “replace” then the entire contents of the existing maintainable object in the Registry MUST be replaced by the object submitted, unless the final attribute is set to “true” in which case the only changes that are allowed are to the following constructs:
  * Name – this applies to the Maintainable object and its contained elements, such a Code in a Code list.
  * Description - this applies to the Maintainable object and its contained elements, such a Code in a Code list.
++
  * Annotation - this applies to the Maintainable object and its contained elements, such a Code in a Code list.
  * validTo
  * validFrom
@@ -354,24 +354,26 @@
  * uri
  * isExternalReference
--2) Cross referenced structures MUST exist in either the submitted document (in Structures or Structure Location) or in the registry to which the request is submitted.
++1. 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.
++1. If the action is set to “delete” then the Registry MUST verify that the object can deleted. In order to qualify for deletion the object must:
--3) If the action is set to “delete” then the Registry MUST verify that the object can deleted. In order to qualify for deletion the object must:
++1. Not have the final attribute set to “true”
++1. Not be referenced from any other object in the Registry.
--а) Not have the final attribute set to “true”
--b) Not be referenced from any other object in the Registry.
++1. The version rules in the SDMX Schema documentation MUST be obeyed.
--4) The version rules in the SDMX Schema documentation MUST be obeyed.
--
--5) The specific rules for the elements and attributes documented in the SDMX Schema MUST be obeyed.
++* The specific rules for the elements and attributes documented in the SDMX Schema MUST be obeyed.
  )))
--|(% style="width:244px" %)SubmitStructureRequest|Structures are submitted at the level of the Maintainable Artefact and the behaviour in “All” above is therefore at the level of the Maintainable Artefact.
--|(% style="width:244px" %)SubmitProvisioningRequest|No additional behaviour.
--|(% style="width:244px" %)Submit Registration Request|(((
++|SubmitStructureRequest|Structures are submitted at the level of the Maintainable Artefact and the behaviour in “All” above is therefore at the level of the Maintainable Artefact.
++|SubmitProvisioningRequest|No additional behaviour.
++|Submit Registration Request|(((
  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-ML data query.
  )))
++
++
  = 6 Identification of SDMX Objects =
  == 6.1 Identification, Versioning, and Maintenance ==
@@ -378,6 +378,7 @@
  All major classes of the SDMX Information model inherit from one of:
++
  * **IdentifiableArtefact** - this gives an object the ability to be uniquely identified (see following section on identification), to have a user-defined URI, and to have multi-lingual annotations.
  * **NamableArtefact **- this has all of the features of IdentifiableArtefact plus the ability to have a multi-lingual name and description,
  * **VersionableArtefact **– this has all of the above features plus a version number and a validity period.
@@ -385,8 +385,6 @@
  === 6.1.1 Identification, Naming, Versioning, and Maintenance Model ===
--[[image:1747824504225-229.png]]
--
  **Figure 5: Class diagram of fundamental artefacts in the SDMX-IM**
  The table below shows the identification and related data attributes to be stored in a registry for objects that are one of:
@@ -397,34 +397,38 @@
  * Versionable
  * Maintainable
--(% style="width:935.294px" %)
--|**Object Type**|(% style="width:244px" %)**Data Attributes**|(% style="width:99px" %)**Status**|**Data type**|(% style="width:389px" %)**Notes**
--|Annotable|(% style="width:244px" %)AnnotationTitle|(% style="width:99px" %)C|string|(% style="width:389px" %)
--| |(% style="width:244px" %)AnnotationType|(% style="width:99px" %)C|string|(% style="width:389px" %)
--| |(% style="width:244px" %)AnnotationURN|(% style="width:99px" %)C|string|(% style="width:389px" %)
--| |(% style="width:244px" %)(((
--AnnotationText in the form of International String
--)))|(% style="width:99px" %)C| |(% style="width:389px" %)This can have languagespecific variants.
--|Identifiable|(% style="width:244px" %)all content as for Annotable plus|(% style="width:99px" %) | |(% style="width:389px" %)
--| |(% style="width:244px" %)id|(% style="width:99px" %)M|string|(% style="width:389px" %)
--| |(% style="width:244px" %)uri|(% style="width:99px" %)C|string|(% style="width:389px" %)
--| |(% style="width:244px" %)urn|(% style="width:99px" %)C|string|(% style="width:389px" %)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.
--|Nameable|(% style="width:244px" %)all content as for Identifiable plus|(% style="width:99px" %) | |(% style="width:389px" %)
--| |(% style="width:244px" %)Name in the form of International String|(% style="width:99px" %)M|string|(% style="width:389px" %)This can have languagespecific variants.
--| |(% style="width:244px" %)(((
--Description in the form of International String
--)))|(% style="width:99px" %)C|string|(% style="width:389px" %)This can have languagespecific variants.
--|Versionable|(% style="width:244px" %)All content as for Identifiable plus|(% style="width:99px" %) | |(% style="width:389px" %)
--| |(% style="width:244px" %)version|(% style="width:99px" %)C|string|(% style="width:389px" %)This is the version number. If not present the default is 1.0
--| |(% style="width:244px" %)validFrom|(% style="width:99px" %)C|Date/time|(% style="width:389px" %)
--| |(% style="width:244px" %)validTo|(% style="width:99px" %)C|Date/time|(% style="width:389px" %)
--|Maintainable|(% style="width:244px" %)All content as for Versionable plus|(% style="width:99px" %) | |(% style="width:389px" %)
--| |(% style="width:244px" %)final|(% style="width:99px" %) |boolean|(% style="width:389px" %)Value of “true” indicates that this is a final specification and it cannot be changed except as a new version. Note that providing a “final’ object is not referenced from another object then it may be deleted.
--| |(% style="width:244px" %)isExternalReference|(% style="width:99px" %)C|boolean|(% style="width:389px" %)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 structureURI, each of which must return a valid SDMX-ML file.
--| |(% style="width:244px" %)serviceURL|(% style="width:99px" %)C|string|(% style="width:389px" %)The url of the service that can be queried for this resource
--| |(% style="width:244px" %)structureURL|(% style="width:99px" %)C|string|(% style="width:389px" %)The url of the resource.
--| |(% style="width:244px" %)(Maintenance) agencyId|(% style="width:99px" %)M|string|(% style="width:389px" %)The object must be linked to a maintenance agency.
++|**Object Type**|**Data Attributes**|**Status**|**Data type**|**Notes**
++|Annotable|AnnotationTitle|C|string|
++| |AnnotationType|C|string|
++| |AnnotationURN|C|string|
++| |(((
++AnnotationText in the form of
++International String
++)))|C| |This can have languagespecific variants.
++| | | | |
++|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.
++|Nameable|all content as for Identifiable plus| | |
++| |Name in the form of International String|M|string|This can have languagespecific variants.
++| |(((
++Description in the form of International
++
++String
++)))|C|string|This can have languagespecific variants.
++|Versionable|All content as for Identifiable plus| | |
++| |version|C|string|This is the version number. If not present the default is 1.0
++| |validFrom|C|Date/time|
++| |validTo|C|Date/time|
++|Maintainable|All content as for Versionable plus| | |
++| |final| |boolean|Value of “true” indicates that this is a final specification and it cannot be changed except as a new version. Note that providing a “final’ object is not referenced from another object then it may be deleted.
++| |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 structureURI, 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) agencyId|M|string|The object must be linked to a maintenance agency.
++
  **Table 1: Common Attributes of Object Types**
  == 6.2 Unique identification of SDMX objects ==
@@ -469,11 +469,11 @@
  An example of this is shown in the XML snippet below.
--[[image:1747824123013-196.jpeg||height="309" width="446"]]
--(% class="wikigeneratedid" id="HFigure8:ExampleShowingUseofAgencyIdentifiers" %)
--**Figure 8: Example Showing Use of Agency Identifiers**
++[[image:1747824123013-196.jpeg]]
++==== Figure 8: Example Showing Use of Agency Identifiers ====
++
  Each of these maintenance agencies has an identical Code list with the Id CL_BOP. However, each is uniquely identified by means of the hierarchic agency structure.
  === 6.2.2 Universal Resource Name (URN) ===
@@ -512,8 +512,10 @@
  **(maintainable-object-version)** is the version of the maintainable object and is enclosed in round brackets (). It will always be present.
--**container-object-id** is the identifier of an intermediary object that contains the actual object which the URN is identifying. It is not mandatory as many actual objects do not have an intermediary container object. For instance, a Code is in a maintained object (Code List) and has no intermediary container object, whereas a Metadata Attribute has an intermediary container object (Report Structure) and may have an intermediary container object which is its parent Metadata Attribute. For this reason the container object id may repeat, with each repetition identifying the object at the next-lower level in its hierarchy. Note that if there is only a single containing object in the model then it is NOT included in the URN structure. This applies to Attribute Descriptor, Dimension Descriptor, and Measure Descriptor where there can be only one such object and this object has a fixed id. Therefore, whilst each of these has a URN, the id of the Attribute Descriptor, Dimension Descriptor, and Measure Descriptor is not included when the actual object is a Data Attribute or a Dimension/Measure Dimension/ Time Dimension, or a Measure.
++**container-object-id** is the identifier of an intermediary object that contains the actual object which the URN is identifying. It is not mandatory as many actual objects do not have an intermediary container object. For instance, a Code is in a maintained object (Code List) and has no intermediary container object, whereas a Metadata Attribute has an intermediary container object (Report Structure) and may have an intermediary container object which is its parent Metadata Attribute. For this reason the container object id may repeat, with each repetition identifying the object at the next-lower level in its hierarchy. Note that if there is only a single containing object in the model then it is NOT included in the URN structure. This applies to Attribute Descriptor, Dimension Descriptor, and Measure Descriptor where there can be only one such object and this object has a fixed id. Therefore, whilst each of these has a
++URN, the id of the Attribute Descriptor, Dimension Descriptor, and Measure Descriptor is not included when the actual object is a Data Attribute or a Dimension/Measure Dimension/ Time Dimension, or a Measure.
++
  Note that although a Code can have a parent Code and a Concept can have a parent Concept these are maintained in a flat structure and therefore do not have a container-object-id.
  For example the sequence is agency:DSDid(version).DimensionId and not agency:DSDid(version).DimensionDescriptorId.DimensionId.
@@ -520,29 +520,30 @@
  **object-id** is the identifier of the actual object unless the actual object is a maintainable object. If present it is always the last id and is not followed by any other character.
--===== __**//Generic Examples of the URN Structure//**__ =====
++===== //Generic Examples of the URN Structure// =====
--__Actual object is a maintainable__
++Actual object is a maintainable
++
  SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version)
--__Actual object is contained in a maintained object with no intermediate containing object__
++Actual object is contained in a maintained object with no intermediate containing object
  SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).object-id
--__Actual object is contained in a maintained object with an intermediate containing object__
++Actual object is contained in a maintained object with an intermediate containing object
  SDMXPrefix.SDMX-IM package name.classname=agency
  id:maintained-object-id(version).contained-object-id.object-id
--__Actual object is contained in a maintained object with no intermediate containing object but the object type itself is hierarchical__
++Actual object is contained in a maintained object with no intermediate containing object but the object type itself is hierarchical
  In this case the object id may not be unique in itself but only within the context of the hierarchy. In the general syntax of the URN all intermediary objects in the structure (with the exception, of course, of the maintained object) are shown as a contained object. An example here would be a Category in a Category Scheme. The Category is hierarchical and all intermediate Categories are shown as a contained object. The example below shows the generic structure for Category Scheme/Category/Category
  SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).contained-object-id.object-id
--__Actual object is contained in a maintained object with an intermediate containing object and the object type itself is hierarchical__
++Actual object is contained in a maintained object with an intermediate containing object and the object type itself is hierarchical
  In this case the generic syntax is the same as for the example above as the parent object is regarded as a containing object, even if it is of the same type. An example here is a Metadata Attribute where the contained objects are Report Structure (first contained object id) and Metadata Attribute (subsequent contained object Ids). The example below shows the generic structure for MSD/Report Structure/Metadata Attribute/Metadata Attribute

1747824504225-229.png

Author

...	...	@@ -1,1 +1,0 @@
1		-xwiki:XWiki.helena

Size

...	...	@@ -1,1 +1,0 @@
1		-52.8 KB

Content