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.14 to 21.13 From 29.5 to 29.4

From version 29.4

edited by Helena
on 2025/05/16 14:10

Change comment: There is no comment for this version

To version 21.14

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

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)
Objects (0 modified, 0 added, 1 removed)
- SUZ.Methodology.Code.MethodologyClass[0]

Details

Page properties

Content

@@ -183,11 +183,11 @@
  === {{id name="_Toc93847"/}}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).
  === {{id name="_Toc93848"/}}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-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:
++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:
  * Structure
@@ -280,7 +280,7 @@
  Subscription management involves a user submitting a subscription request which contains:
  * a query or constraint expression in terms of a filter which defines the events for which the user is interested (e.g., new data for a specific dataflow, or for a domain category, or changes to a Data Structure Definition).
--* a list of URIs or endpoints to which an XML notification message can be sent. Supported endpoint types will be email (mailto~: ) and HTTP POST (a normal http:~/~/ address);
++* a list of URIs or endpoints to which an XML notification message can be sent. Supported endpoint types will be email (mailto~:) and HTTP POST (a normal http:~/~/ address);
  * request for a list of submitted subscriptions;
  * deletion of a subscription;
@@ -301,8 +301,10 @@
  a) Be a draft version.
  )))
++|(% 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.
  )))
  |(% 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.
@@ -327,12 +327,14 @@
  The table below shows the identification and related data attributes to be stored in a registry for objects that are one of:
--* //nnotable//
++* //Annotable//
  * //Identifiable//
  * //Nameable//
  * //Versionable//
  * //Maintainable//
++:
++
  (((
  (% style="width:1052.29px" %)
  |**Object Type**|(% style="width:241px" %)**Data Attributes**|(% style="width:156px" %)**Status**|**Data type**|(% style="width:457px" %)**Notes**
@@ -360,9 +360,9 @@
  **Table 1: Common Attributes of Object Types**
--== {{id name="_Toc93856"/}}6.2 Unique identification of SDMX objects ==
++=== {{id name="_Toc93856"/}}6.2 Unique identification of SDMX objects ===
--=== {{id name="_Toc93857"/}}6.2.1 Agencies and Metadata Providers ===
++===== {{id name="_Toc93857"/}}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.
@@ -443,14 +443,23 @@
  The packages are:
  base
++
  codelist
++
  conceptscheme
++
  datastructure
++
  categoryscheme
++
  registry
++
  metadatastructure
++
  process
++
  structuremapping
++
  transformation
  **maintainable-object-id** is the identifier of the maintainable object. This will always be present as all identifiable objects are either a maintainable object or contained in a maintainable object.
@@ -495,23 +495,23 @@
  The Data Structure Definition CRED_EXT_DEBT of legacy version 2.1 maintained by the toplevel Agency TFFS would have the URN:
--       urn:sdmx:org.sdmx.infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(2.1)
++urn:sdmx:org.sdmx.infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(2.1)
  The URN for a code for Argentina maintained by ISO in the code list CL_3166A2 of semantic version 1.0.0 would be:
--        urn:sdmx:org.sdmx.infomodel.codelist.Code=ISO:CL_3166A2(1.0.0).AR
++urn:sdmx:org.sdmx.infomodel.codelist.Code=ISO:CL_3166A2(1.0.0).AR
  The URN for a category (id of 1) which has parent category (id of 2) maintained by SDMX in the category scheme SUBJECT_MATTER_DOMAINS of the semantic extended version 1.0.0draft would be:
--        urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:SUBJECT_MATT ER_DOMAINS(1.0.0-draft).1.2
++urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:SUBJECT_MATT ER_DOMAINS(1.0.0-draft).1.2
  The URN for a Metadata Attribute maintained by SDMX in the MSD CONTACT_METADATA of semantic version 1.0.0 where the hierarchy of the Metadata Attribute is CONTACT_DETAILS/CONTACT_NAME would be:
--       urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataAttribute=SDMX: CONTACT_METADATA(1.0.0).CONTACT_DETAILS.CONTACT_NAME
++urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataAttribute=SDMX: CONTACT_METADATA(1.0.0).CONTACT_DETAILS.CONTACT_NAME
  The TFFS defines ABC as a sub-Agency of TFFS then the URN of a Dataflow maintained by ABC and identified as EXTERNAL_DEBT of semantic version 1.0.0 would be:
--       urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=TFFS.ABC:EXTERNAL_ DEBT(1.0.0)
++urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=TFFS.ABC:EXTERNAL_ DEBT(1.0.0)
  The SDMX-RR MUST support this globally unique identification scheme. The SDMX-RR MUST be able to create the URN from the individual identification attributes submitted and to transform the URN to these identification attributes. The identification attributes are:
@@ -618,6 +618,8 @@
  |(% style="width:252px" %)//Categorisation//|(% style="width:639px" %)categorisationAgencyId:categorisationId(version)|(% style="width:418px" %)IMF:cat001(1.0.0)
  |(% style="width:252px" %)Category|(% style="width:639px" %)categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|(% style="width:418px" %)IMF:SDDS(1.0.0):level_1_category.level_2_category …
  |(% style="width:252px" %)//CategoryScheme//|(% style="width:639px" %)categorySchemeAgencyId:categorySchemeId(versi on)|(% style="width:418px" %)IMF:SDDS(1.0.0)
++
++|(% style="width:250px" %)**Classname**|(% style="width:639px" %)**Ending URN pattern**|(% style="width:1049px" %)**Example**
  |(% style="width:250px" %)//CategorySchemeMap//|(% style="width:639px" %)(((
  catSchemeMapAgencyId:catSchemeMapId(version)
  )))|(% style="width:1049px" %)SDMX:EUROSTAT_SUBJECT_DOMAIN(1.0.0)
@@ -728,7 +728,7 @@
  === {{id name="_Toc93862"/}}7.1 Structural Definition Metadata ===
--=== {{id name="_Toc93863"/}}7.1.1 Introduction ===
++===== {{id name="_Toc93863"/}}7.1.1 Introduction =====
  The SDMX Registry must have the ability to support agencies in their role of defining and disseminating structural metadata artefacts. These artefacts include data structure definitions, code lists, concepts etc. and are fully defined in the SDMX-IM. An authenticated agency may submit valid structural metadata definitions which must be stored in the registry. Note that the term “structural metadata” refers as a general term to all structural components (Data Structure Definitions, Metadata Structure Definitions, Code Lists, Concept Schemes, etc.)
@@ -795,7 +795,7 @@
  **Table 4: Table of Maintainable Artefacts for Structural Definition Metadata**
--=== {{id name="_Toc93864"/}}7.1.2 Item Scheme, Structure ===
++===== {{id name="_Toc93864"/}}7.1.2 Item Scheme, Structure =====
  The artefacts included in the structural definitions are:
@@ -804,19 +804,19 @@
  * All types of Structure (Data Structure Definition, Metadata Structure Definition)
  * All types of Structure Usage (Dataflow, Metadataflow)
--=== {{id name="_Toc93865"/}}7.1.3 Structure Usage ===
++===== {{id name="_Toc93865"/}}7.1.3 Structure Usage =====
--==== 7.1.3.1 Structure Usage: Basic Concepts ====
++**7.1.3.1 Structure Usage: Basic Concepts**
  The Structure Usage defines, in its concrete classes of Dataflow and Metadataflow, which flows of data and metadata use which specific Structure, and importantly for the support of data and metadata discovery, the Structure Usage can be linked to one or more Category in one or more Category Scheme using the Categorisation mechanism. This gives the ability for an application to discover data and metadata by “drilling down” the Category Schemes.
--==== 7.1.3.2 Structure Usage Schematic ====
++**7.1.3.2 Structure Usage Schematic**
  [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_52097ab5.jpg||height="246" width="438"]]
  **Figure 9: Schematic of Linking the Data and Metadata Flows to Categories and Structure Definitions**
--==== 7.1.3.3 Structure Usage Model ====
++**7.1.3.3 Structure Usage Model**
  [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_302cc1a2.jpg||height="548" width="578"]]
@@ -931,13 +931,13 @@
  The Registration has an action attribute which takes one of the following values:
  (((
--(% style="width:761.294px" %)
--|(% style="width:196px" %)**Action Attribute Value**|(% style="width:561px" %)**Behaviour**
--|(% style="width:196px" %)Append|(% style="width:561px" %)Add this Registration to the registry
--|(% style="width:196px" %)Replace|(% style="width:561px" %)(((
++(% style="width:679.294px" %)
++|(% style="width:196px" %)**Action Attribute Value**|(% style="width:480px" %)**Behaviour**
++|(% style="width:196px" %)Append|(% style="width:480px" %)Add this Registration to the registry
++|(% style="width:196px" %)Replace|(% style="width:480px" %)(((
  Replace the existing Registration with identified by the id in the Registration of the SubmitRegistrationRequest
  )))
--|(% style="width:196px" %)Delete|(% style="width:561px" %)Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest
++|(% style="width:196px" %)Delete|(% style="width:480px" %)Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest
  )))
  [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_bc1dcdec.jpg||height="575" width="579"]]
@@ -954,20 +954,27 @@
  Information in the data or metadata set is extracted and placed in one or more //Constraint//s (see the //Constraint// model in the SDMX Information Model – Section 2 of the SDMX Standards). The information to be extracted is indicated by the Boolean values set on the ProvisionAgreement or MetadataProvisionAgreement as shown in the table below.
++:
++
  (((
--(% style="width:678.294px" %)
--|**Indexing Required**|(% style="width:504px" %)**Registration Process Activity**
--|indexTimeSeries|(% style="width:504px" %)Extract all the series keys and create a KeySet(s) Constraint.
--|indexDataSet|(% style="width:504px" %)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:504px" %)(((
++|**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.
  )))
--|**Indexing Required**|(% style="width:504px" %)**Registration Process Activity**
--|indexAttributes|(% style="width:504px" %)(((
++|**Indexing Required**|**Registration Process Activity**
++|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
++
++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 SDMX-IM. Note that the content is not stored in the Selection Value.
  )))
  )))
@@ -976,7 +976,7 @@
  The Registration must reference the ProvisionAgreement or MetadataProvisionAgreement to which it relates.
--=== {{id name="_Toc93876"/}}7.4.3 Registration Response ===
++===== {{id name="_Toc93876"/}}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”.
@@ -1006,18 +1006,20 @@
  Regardless of the type of registry/repository events being observed, a subscription always contains:
--1.  set of URIs describing the end-points to which notifications must be sent if the subscription is activated. The URIs can be either mailto~: or http: protocol. In the former case an email notification is sent; in the latter an HTTP POST notification is sent.
++1. A set of URIs describing the end-points to which notifications must be sent if the subscription is activated. The URIs can be either mailto~: or http: protocol. In the former case an email notification is sent; in the latter an HTTP POST notification is sent.
 . A user-defined identifier, which is returned in the response to the subscription request. This helps with asynchronous processing and is NOT stored in the Registry.
 . 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:856.294px" %)
--|(% style="width:320px" %)**Event Type**|(% style="width:532px" %)**Comment**
--|(% style="width:320px" %)STRUCTURAL_REPOSITORY_EVENTS|(% style="width:532px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
--|(% style="width:320px" %)DATA_REGISTRATION_EVENTS|(% style="width:532px" %)Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
--|(% style="width:320px" %)METADATA_REGISTRATION_EVENTS|(% style="width:532px" %)Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
--|(% style="width:320px" %)ALL_EVENTS|(% style="width:532px" %)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
  )))
  === {{id name="_Toc93880"/}}7.5.3 Wildcard Facility ===
@@ -1084,14 +1084,15 @@
  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:1126.29px" %)
--|(% style="width:382px" %)**Selector**|(% style="width:740px" %)**Comment**
--|(% style="width:382px" %)DataProvider & MetadataProvider|(% style="width:740px" %)Any datasets or metadata sets registered by the specified data or metadata provider will activate the notification.
--|(% style="width:382px" %)ProvisionAgreement & MetadataProvisionAgreement|(% style="width:740px" %)Any datasets or metadata sets registered for the agreement will activate the notification.
--|(% style="width:382px" %)Dataflow & Metadataflow|(% style="width:740px" %)Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
--|(% style="width:382px" %)DataStructureDefinition & MetadataStructureDefinition|(% style="width:740px" %)Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will activate the notification
--|(% style="width:382px" %)Category|(% style="width:740px" %)Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category.
++|**Selector**|**Comment**
++|DataProvider & MetadataProvider|Any datasets or metadata sets registered by the specified data or metadata provider will activate the notification.
++|ProvisionAgreement & MetadataProvisionAgreement|Any datasets or metadata sets registered for the agreement will activate the notification.
++|Dataflow & Metadataflow|Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
++|DataStructureDefinition & MetadataStructureDefinition|Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will activate the notification
++|Category|Any datasets or metadata sets registered for those dataflows, metadataflows, 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.
@@ -1123,6 +1123,12 @@
  The notification will contain the Registration.
------
++[[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.
++[[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:
++
++IMF.SubAgency1
++
++[[3>>path:#sdfootnote3anc||name="sdfootnote3sym"]] Note that Codelist is also an EnumeratedList.
++
  {{putFootnotes/}}

SUZ.Methodology.Code.MethodologyClass[0]