Skip to Content
Last modified by Helena on 2025/09/10 11:19
From version 1.2
edited by Helena
on 2025/05/21 13:44
Change comment: There is no comment for this version
To version 2.5
edited by Helena
on 2025/05/21 14:21
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -292,15 +292,13 @@
292 292  
293 293  3The Registration has an action attribute which takes one of the following values:
294 294  
295 -|(((
296 -**Action**
295 +|(% style="width:249px" %)(((
296 +**Action Attribute Value**
297 +)))|(% style="width:1622px" %)**Behaviour**
298 +|(% style="width:249px" %)Append|(% style="width:1622px" %)Add this registration to the registry
299 +|(% 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
300 +|(% style="width:249px" %)Delete|(% style="width:1622px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
297 297  
298 -**Attribute Value**
299 -)))|**Behaviour**
300 -|Append|Add this registration to the registry
301 -|Replace|Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request
302 -|Delete|Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
303 -
304 304  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:
305 305  
306 306  |**Boolean Attribute**|**Behaviour if Value is “true”**
... ... @@ -316,10 +316,9 @@
316 316  
317 317  The Data and Metadata Discovery Service implements the following Registry Interfaces:
318 318  
319 - QueryRegistrationRequest
317 +* QueryRegistrationRequest
318 +* QueryRegistrationResponse
320 320  
321 - QueryRegistrationResponse
322 -
323 323  === 5.2.6 Subscription and Notification ===
324 324  
325 325  The Subscription and Notification Service implements the following Registry Interfaces:
... ... @@ -343,13 +343,12 @@
343 343  
344 344  The following table defines the behaviour of the SDMX Registry for the various Registry Interface messages.
345 345  
346 -|**Interface**|**Behaviour**
347 -|All|(((
343 +|(% style="width:244px" %)**Interface**|**Behaviour**
344 +|(% style="width:244px" %)All|(((
348 348  1) 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:
349 349  
350 350  * Name – this applies to the Maintainable object and its contained elements, such a Code in a Code list.
351 351  * Description - this applies to the Maintainable object and its contained elements, such a Code in a Code list.
352 -
353 353  * Annotation - this applies to the Maintainable object and its contained elements, such a Code in a Code list.
354 354  * validTo
355 355  * validFrom
... ... @@ -358,26 +358,24 @@
358 358  * uri
359 359  * isExternalReference
360 360  
361 -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.
362 -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:
357 +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.
363 363  
364 -1. Not have the final attribute set to “true”
365 -1. Not be referenced from any other object in the Registry.
359 +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:
366 366  
367 -1. The version rules in the SDMX Schema documentation MUST be obeyed.
361 +а) Not have the final attribute set to “true”
362 +b) Not be referenced from any other object in the Registry.
368 368  
369 -* The specific rules for the elements and attributes documented in the SDMX Schema MUST be obeyed.
364 +4) The version rules in the SDMX Schema documentation MUST be obeyed.
365 +
366 +5) The specific rules for the elements and attributes documented in the SDMX Schema MUST be obeyed.
370 370  )))
371 -|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.
372 -|SubmitProvisioningRequest|No additional behaviour.
373 -|Submit Registration Request|(((
368 +|(% 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.
369 +|(% style="width:244px" %)SubmitProvisioningRequest|No additional behaviour.
370 +|(% style="width:244px" %)Submit Registration Request|(((
374 374  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.
375 -
376 376  For a queryable datasource the Registry MAY validate that the source exists and can accept an SDMX-ML data query.
377 377  )))
378 378  
379 -
380 -
381 381  = 6 Identification of SDMX Objects =
382 382  
383 383  == 6.1 Identification, Versioning, and Maintenance ==
... ... @@ -384,7 +384,6 @@
384 384  
385 385  All major classes of the SDMX Information model inherit from one of:
386 386  
387 -
388 388  * **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.
389 389  * **NamableArtefact **- this has all of the features of IdentifiableArtefact plus the ability to have a multi-lingual name and description,
390 390  * **VersionableArtefact **– this has all of the above features plus a version number and a validity period.
... ... @@ -392,6 +392,8 @@
392 392  
393 393  === 6.1.1 Identification, Naming, Versioning, and Maintenance Model ===
394 394  
388 +[[image:1747824504225-229.png]]
389 +
395 395  **Figure 5: Class diagram of fundamental artefacts in the SDMX-IM**
396 396  
397 397  The table below shows the identification and related data attributes to be stored in a registry for objects that are one of:
... ... @@ -402,38 +402,34 @@
402 402  * Versionable
403 403  * Maintainable
404 404  
405 -|**Object Type**|**Data Attributes**|**Status**|**Data type**|**Notes**
406 -|Annotable|AnnotationTitle|C|string|
407 -| |AnnotationType|C|string|
408 -| |AnnotationURN|C|string|
409 -| |(((
410 -AnnotationText in the form of
400 +(% style="width:935.294px" %)
401 +|**Object Type**|(% style="width:244px" %)**Data Attributes**|(% style="width:99px" %)**Status**|**Data type**|(% style="width:389px" %)**Notes**
402 +|Annotable|(% style="width:244px" %)AnnotationTitle|(% style="width:99px" %)C|string|(% style="width:389px" %)
403 +| |(% style="width:244px" %)AnnotationType|(% style="width:99px" %)C|string|(% style="width:389px" %)
404 +| |(% style="width:244px" %)AnnotationURN|(% style="width:99px" %)C|string|(% style="width:389px" %)
405 +| |(% style="width:244px" %)(((
406 +AnnotationText in the form of International String
407 +)))|(% style="width:99px" %)C| |(% style="width:389px" %)This can have languagespecific variants.
408 +|Identifiable|(% style="width:244px" %)all content as for Annotable plus|(% style="width:99px" %) | |(% style="width:389px" %)
409 +| |(% style="width:244px" %)id|(% style="width:99px" %)M|string|(% style="width:389px" %)
410 +| |(% style="width:244px" %)uri|(% style="width:99px" %)C|string|(% style="width:389px" %)
411 +| |(% 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.
412 +|Nameable|(% style="width:244px" %)all content as for Identifiable plus|(% style="width:99px" %) | |(% style="width:389px" %)
413 +| |(% style="width:244px" %)Name in the form of International String|(% style="width:99px" %)M|string|(% style="width:389px" %)This can have languagespecific variants.
414 +| |(% style="width:244px" %)(((
415 +Description in the form of International String
416 +)))|(% style="width:99px" %)C|string|(% style="width:389px" %)This can have languagespecific variants.
417 +|Versionable|(% style="width:244px" %)All content as for Identifiable plus|(% style="width:99px" %) | |(% style="width:389px" %)
418 +| |(% 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
419 +| |(% style="width:244px" %)validFrom|(% style="width:99px" %)C|Date/time|(% style="width:389px" %)
420 +| |(% style="width:244px" %)validTo|(% style="width:99px" %)C|Date/time|(% style="width:389px" %)
421 +|Maintainable|(% style="width:244px" %)All content as for Versionable plus|(% style="width:99px" %) | |(% style="width:389px" %)
422 +| |(% 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.
423 +| |(% 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.
424 +| |(% style="width:244px" %)serviceURL|(% style="width:99px" %)C|string|(% style="width:389px" %)The url of the service that can be queried for this resource
425 +| |(% style="width:244px" %)structureURL|(% style="width:99px" %)C|string|(% style="width:389px" %)The url of the resource.
426 +| |(% style="width:244px" %)(Maintenance) agencyId|(% style="width:99px" %)M|string|(% style="width:389px" %)The object must be linked to a maintenance agency.
411 411  
412 -International String
413 -)))|C| |This can have languagespecific variants.
414 -| | | | |
415 -|Identifiable|all content as for Annotable plus| | |
416 -| |id|M|string|
417 -| |uri|C|string|
418 -| |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.
419 -|Nameable|all content as for Identifiable plus| | |
420 -| |Name in the form of International String|M|string|This can have languagespecific variants.
421 -| |(((
422 -Description in the form of International
423 -
424 -String
425 -)))|C|string|This can have languagespecific variants.
426 -|Versionable|All content as for Identifiable plus| | |
427 -| |version|C|string|This is the version number. If not present the default is 1.0
428 -| |validFrom|C|Date/time|
429 -| |validTo|C|Date/time|
430 -|Maintainable|All content as for Versionable plus| | |
431 -| |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.
432 -| |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.
433 -| |serviceURL|C|string|The url of the service that can be queried for this resource
434 -| |structureURL|C|string|The url of the resource.
435 -| |(Maintenance) agencyId|M|string|The object must be linked to a maintenance agency.
436 -
437 437  **Table 1: Common Attributes of Object Types**
438 438  
439 439  == 6.2 Unique identification of SDMX objects ==
... ... @@ -478,11 +478,11 @@
478 478  
479 479  An example of this is shown in the XML snippet below.
480 480  
472 +[[image:1747824123013-196.jpeg||height="309" width="446"]]
481 481  
482 -[[image:1747824123013-196.jpeg]]
474 +(% class="wikigeneratedid" id="HFigure8:ExampleShowingUseofAgencyIdentifiers" %)
475 +**Figure 8: Example Showing Use of Agency Identifiers**
483 483  
484 -==== Figure 8: Example Showing Use of Agency Identifiers ====
485 -
486 486  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.
487 487  
488 488  === 6.2.2 Universal Resource Name (URN) ===
... ... @@ -521,10 +521,8 @@
521 521  
522 522  **(maintainable-object-version)** is the version of the maintainable object and is enclosed in round brackets (). It will always be present.
523 523  
524 -**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
515 +**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.
525 525  
526 -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.
527 -
528 528  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.
529 529  
530 530  For example the sequence is agency:DSDid(version).DimensionId and not agency:DSDid(version).DimensionDescriptorId.DimensionId.
... ... @@ -531,58 +531,57 @@
531 531  
532 532  **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.
533 533  
534 -===== //Generic Examples of the URN Structure// =====
523 +===== __**//Generic Examples of the URN Structure//**__ =====
535 535  
525 +__Actual object is a maintainable__
536 536  
537 -Actual object is a maintainable
527 +> SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version)
538 538  
539 -SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version)
529 +__Actual object is contained in a maintained object with no intermediate containing object__
540 540  
541 -Actual object is contained in a maintained object with no intermediate containing object
531 +> SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).object-id
542 542  
543 -SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).object-id
533 +__Actual object is contained in a maintained object with an intermediate containing object__
544 544  
545 -Actual object is contained in a maintained object with an intermediate containing object
535 +> SDMXPrefix.SDMX-IM package name.classname=agency
546 546  
547 -SDMXPrefix.SDMX-IM package name.classname=agency
548 -
549 549  id:maintained-object-id(version).contained-object-id.object-id
550 550  
551 -Actual object is contained in a maintained object with no intermediate containing object but the object type itself is hierarchical
539 +__Actual object is contained in a maintained object with no intermediate containing object but the object type itself is hierarchical__
552 552  
553 553  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
554 554  
555 -SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).contained-object-id.object-id
543 +> SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).contained-object-id.object-id
556 556  
557 -Actual object is contained in a maintained object with an intermediate containing object and the object type itself is hierarchical
545 +__Actual object is contained in a maintained object with an intermediate containing object and the object type itself is hierarchical__
558 558  
559 559  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
560 560  
561 -SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).contained-object-id. contained-object-id contained-object-id.object-id
549 +> SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).contained-object-id. contained-object-id contained-object-id.object-id
562 562  
563 -===== //Concrete Examples of the URN Structure// =====
551 +===== __**//Concrete Examples of the URN Structure//**__ =====
564 564  
565 565  The Data Structure Definition CRED_EXT_DEBT version 1.0 maintained by the top level Agency TFFS would have the URN:
566 566  
567 -urn:sdmx:org.sdmx.infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(1.0)
555 +> urn:sdmx:org.sdmx.infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(1.0)
568 568  
569 569  The URN for a code for Argentina maintained by ISO in the code list CL_3166A2 version 1.0 would be:
570 570  
571 -urn:sdmx:org.sdmx.infomodel.codelist.Code=ISO:CL_3166A2(1.0).AR
559 +> urn:sdmx:org.sdmx.infomodel.codelist.Code=ISO:CL_3166A2(1.0).AR
572 572  
573 573  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 version 1.0 would be:
574 574  
575 -urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:SUBJE CT_MATTER_DOMAINS(1.0).1.2
563 +> urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:SUBJE CT_MATTER_DOMAINS(1.0).1.2
576 576  
577 577  The URN for a Metadata Attribute maintained by SDMX in the MSD CONTACT_METADATA version 1.0 in the Report Structure CONTACT_REPORT where the hierarchy of the Metadata Attribute is
578 578  
579 579  CONTACT_DETAILS/CONTACT_NAME would be:
580 580  
581 -urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataAttribut e=SDMX:CONTACT_METADATA(1.0).CONTACT_REPORT.CONTACT_DETAILS.CO NTACT_NAME
569 +> urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataAttribut e=SDMX:CONTACT_METADATA(1.0).CONTACT_REPORT.CONTACT_DETAILS.CO NTACT_NAME
582 582  
583 583  The TFFS defines ABC as a sub Agency of TFFS then the URN of a Dataflow maintained by ABC and identified as EXTERNAL_DEBT version 1.0 would be:
584 584  
585 -urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=TFFS.ABC:EX
573 +> urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=TFFS.ABC:EX
586 586  
587 587  TERNAL_DEBT(1.0)
588 588  
1747824504225-229.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +52.8 KB
Content