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

From version 22.1
edited by Helena
on 2025/05/15 14:33
Change comment: There is no comment for this version
To version 29.3
edited by Helena
on 2025/05/16 14:09
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -183,11 +183,11 @@
183 183  
184 184  === {{id name="_Toc93847"/}}5.2.2 Structure Submission Service ===
185 185  
186 -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).
186 +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).
187 187  
188 188  === {{id name="_Toc93848"/}}5.2.3 Structure Query Service ===
189 189  
190 -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:
190 +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:
191 191  
192 192  * Structure
193 193  
... ... @@ -280,7 +280,7 @@
280 280  Subscription management involves a user submitting a subscription request which contains:
281 281  
282 282  * 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).
283 -* 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);
283 +* 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);
284 284  * request for a list of submitted subscriptions;
285 285  * deletion of a subscription;
286 286  
... ... @@ -301,10 +301,8 @@
301 301  
302 302  a) Be a draft version.
303 303  )))
304 -|(% style="width:188px" %)**Interface**|(% style="width:542px" %)**Behaviour**
305 305  |(% style="width:188px" %) |(% style="width:542px" %)(((
306 306  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.
307 -
308 308  4) The semantic versioning rules in the SDMX documentation MUST be obeyed.
309 309  )))
310 310  |(% 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.
... ... @@ -329,14 +329,12 @@
329 329  
330 330  The table below shows the identification and related data attributes to be stored in a registry for objects that are one of:
331 331  
332 -* //Annotable//
330 +* //nnotable//
333 333  * //Identifiable//
334 334  * //Nameable//
335 335  * //Versionable//
336 336  * //Maintainable//
337 337  
338 -:
339 -
340 340  (((
341 341  (% style="width:1052.29px" %)
342 342  |**Object Type**|(% style="width:241px" %)**Data Attributes**|(% style="width:156px" %)**Status**|**Data type**|(% style="width:457px" %)**Notes**
... ... @@ -364,9 +364,9 @@
364 364  
365 365  **Table 1: Common Attributes of Object Types**
366 366  
367 -=== {{id name="_Toc93856"/}}6.2 Unique identification of SDMX objects ===
363 +== {{id name="_Toc93856"/}}6.2 Unique identification of SDMX objects ==
368 368  
369 -===== {{id name="_Toc93857"/}}6.2.1 Agencies and Metadata Providers =====
365 +=== {{id name="_Toc93857"/}}6.2.1 Agencies and Metadata Providers ===
370 370  
371 371  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.
372 372  
... ... @@ -447,23 +447,14 @@
447 447  The packages are:
448 448  
449 449  base
450 -
451 451  codelist
452 -
453 453  conceptscheme
454 -
455 455  datastructure
456 -
457 457  categoryscheme
458 -
459 459  registry
460 -
461 461  metadatastructure
462 -
463 463  process
464 -
465 465  structuremapping
466 -
467 467  transformation
468 468  
469 469  **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.
... ... @@ -508,23 +508,23 @@
508 508  
509 509  The Data Structure Definition CRED_EXT_DEBT of legacy version 2.1 maintained by the toplevel Agency TFFS would have the URN:
510 510  
511 -urn:sdmx:org.sdmx.infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(2.1)
498 + urn:sdmx:org.sdmx.infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(2.1)
512 512  
513 513  The URN for a code for Argentina maintained by ISO in the code list CL_3166A2 of semantic version 1.0.0 would be:
514 514  
515 -urn:sdmx:org.sdmx.infomodel.codelist.Code=ISO:CL_3166A2(1.0.0).AR
502 + urn:sdmx:org.sdmx.infomodel.codelist.Code=ISO:CL_3166A2(1.0.0).AR
516 516  
517 517  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:
518 518  
519 -urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:SUBJECT_MATT ER_DOMAINS(1.0.0-draft).1.2
506 + urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:SUBJECT_MATT ER_DOMAINS(1.0.0-draft).1.2
520 520  
521 521  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:
522 522  
523 -urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataAttribute=SDMX: CONTACT_METADATA(1.0.0).CONTACT_DETAILS.CONTACT_NAME
510 + urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataAttribute=SDMX: CONTACT_METADATA(1.0.0).CONTACT_DETAILS.CONTACT_NAME
524 524  
525 525  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:
526 526  
527 -urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=TFFS.ABC:EXTERNAL_ DEBT(1.0.0)
514 + urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=TFFS.ABC:EXTERNAL_ DEBT(1.0.0)
528 528  
529 529  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:
530 530  
... ... @@ -743,7 +743,7 @@
743 743  
744 744  === {{id name="_Toc93862"/}}7.1 Structural Definition Metadata ===
745 745  
746 -===== {{id name="_Toc93863"/}}7.1.1 Introduction =====
733 +=== {{id name="_Toc93863"/}}7.1.1 Introduction ===
747 747  
748 748  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.)
749 749  
... ... @@ -810,7 +810,7 @@
810 810  
811 811  **Table 4: Table of Maintainable Artefacts for Structural Definition Metadata**
812 812  
813 -===== {{id name="_Toc93864"/}}7.1.2 Item Scheme, Structure =====
800 +=== {{id name="_Toc93864"/}}7.1.2 Item Scheme, Structure ===
814 814  
815 815  The artefacts included in the structural definitions are:
816 816  
... ... @@ -819,19 +819,19 @@
819 819  * All types of Structure (Data Structure Definition, Metadata Structure Definition)
820 820  * All types of Structure Usage (Dataflow, Metadataflow)
821 821  
822 -===== {{id name="_Toc93865"/}}7.1.3 Structure Usage =====
809 +=== {{id name="_Toc93865"/}}7.1.3 Structure Usage ===
823 823  
824 -**7.1.3.1 Structure Usage: Basic Concepts**
811 +==== 7.1.3.1 Structure Usage: Basic Concepts ====
825 825  
826 826  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.
827 827  
828 -**7.1.3.2 Structure Usage Schematic**
815 +==== 7.1.3.2 Structure Usage Schematic ====
829 829  
830 830  [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_52097ab5.jpg||height="246" width="438"]]
831 831  
832 832  **Figure 9: Schematic of Linking the Data and Metadata Flows to Categories and Structure Definitions**
833 833  
834 -**7.1.3.3 Structure Usage Model**
821 +==== 7.1.3.3 Structure Usage Model ====
835 835  
836 836  [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_302cc1a2.jpg||height="548" width="578"]]
837 837  
SUZ.Methodology.Code.MethodologyClass[0]