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

From version 1.3
edited by Helena
on 2025/05/21 13:45
Change comment: There is no comment for this version
To version 1.7
edited by Helena
on 2025/05/21 13:49
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -340,13 +340,12 @@
340 340  
341 341  The following table defines the behaviour of the SDMX Registry for the various Registry Interface messages.
342 342  
343 -|**Interface**|**Behaviour**
344 -|All|(((
343 +|(% style="width:143px" %)**Interface**|(% style="width:1729px" %)**Behaviour**
344 +|(% style="width:143px" %)All|(% style="width:1729px" %)(((
345 345  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:
346 346  
347 347  * Name – this applies to the Maintainable object and its contained elements, such a Code in a Code list.
348 348  * Description - this applies to the Maintainable object and its contained elements, such a Code in a Code list.
349 -
350 350  * Annotation - this applies to the Maintainable object and its contained elements, such a Code in a Code list.
351 351  * validTo
352 352  * validFrom
... ... @@ -355,26 +355,25 @@
355 355  * uri
356 356  * isExternalReference
357 357  
358 -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.
359 -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.
360 360  
361 -1. Not have the final attribute set to “true”
362 -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:
363 363  
364 -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.
365 365  
366 -* 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.
367 367  )))
368 -|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 -|SubmitProvisioningRequest|No additional behaviour.
370 -|Submit Registration Request|(((
368 +|(% style="width:143px" %)SubmitStructureRequest|(% style="width:1729px" %)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:143px" %)SubmitProvisioningRequest|(% style="width:1729px" %)No additional behaviour.
370 +|(% style="width:143px" %)Submit Registration Request|(% style="width:1729px" %)(((
371 371  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.
372 372  
373 373  For a queryable datasource the Registry MAY validate that the source exists and can accept an SDMX-ML data query.
374 374  )))
375 375  
376 -
377 -
378 378  = 6 Identification of SDMX Objects =
379 379  
380 380  == 6.1 Identification, Versioning, and Maintenance ==
... ... @@ -381,7 +381,6 @@
381 381  
382 382  All major classes of the SDMX Information model inherit from one of:
383 383  
384 -
385 385  * **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.
386 386  * **NamableArtefact **- this has all of the features of IdentifiableArtefact plus the ability to have a multi-lingual name and description,
387 387  * **VersionableArtefact **– this has all of the above features plus a version number and a validity period.
... ... @@ -389,6 +389,8 @@
389 389  
390 390  === 6.1.1 Identification, Naming, Versioning, and Maintenance Model ===
391 391  
389 +[[image:1747824504225-229.png]]
390 +
392 392  **Figure 5: Class diagram of fundamental artefacts in the SDMX-IM**
393 393  
394 394  The table below shows the identification and related data attributes to be stored in a registry for objects that are one of:
... ... @@ -399,38 +399,34 @@
399 399  * Versionable
400 400  * Maintainable
401 401  
402 -|**Object Type**|**Data Attributes**|**Status**|**Data type**|**Notes**
403 -|Annotable|AnnotationTitle|C|string|
404 -| |AnnotationType|C|string|
405 -| |AnnotationURN|C|string|
406 -| |(((
407 -AnnotationText in the form of
401 +(% style="width:935.294px" %)
402 +|**Object Type**|(% style="width:244px" %)**Data Attributes**|(% style="width:99px" %)**Status**|**Data type**|(% style="width:389px" %)**Notes**
403 +|Annotable|(% style="width:244px" %)AnnotationTitle|(% style="width:99px" %)C|string|(% style="width:389px" %)
404 +| |(% style="width:244px" %)AnnotationType|(% style="width:99px" %)C|string|(% style="width:389px" %)
405 +| |(% style="width:244px" %)AnnotationURN|(% style="width:99px" %)C|string|(% style="width:389px" %)
406 +| |(% style="width:244px" %)(((
407 +AnnotationText in the form of International String
408 +)))|(% style="width:99px" %)C| |(% style="width:389px" %)This can have languagespecific variants.
409 +|Identifiable|(% style="width:244px" %)all content as for Annotable plus|(% style="width:99px" %) | |(% style="width:389px" %)
410 +| |(% style="width:244px" %)id|(% style="width:99px" %)M|string|(% style="width:389px" %)
411 +| |(% style="width:244px" %)uri|(% style="width:99px" %)C|string|(% style="width:389px" %)
412 +| |(% 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.
413 +|Nameable|(% style="width:244px" %)all content as for Identifiable plus|(% style="width:99px" %) | |(% style="width:389px" %)
414 +| |(% style="width:244px" %)Name in the form of International String|(% style="width:99px" %)M|string|(% style="width:389px" %)This can have languagespecific variants.
415 +| |(% style="width:244px" %)(((
416 +Description in the form of International String
417 +)))|(% style="width:99px" %)C|string|(% style="width:389px" %)This can have languagespecific variants.
418 +|Versionable|(% style="width:244px" %)All content as for Identifiable plus|(% style="width:99px" %) | |(% style="width:389px" %)
419 +| |(% 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
420 +| |(% style="width:244px" %)validFrom|(% style="width:99px" %)C|Date/time|(% style="width:389px" %)
421 +| |(% style="width:244px" %)validTo|(% style="width:99px" %)C|Date/time|(% style="width:389px" %)
422 +|Maintainable|(% style="width:244px" %)All content as for Versionable plus|(% style="width:99px" %) | |(% style="width:389px" %)
423 +| |(% 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.
424 +| |(% 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.
425 +| |(% style="width:244px" %)serviceURL|(% style="width:99px" %)C|string|(% style="width:389px" %)The url of the service that can be queried for this resource
426 +| |(% style="width:244px" %)structureURL|(% style="width:99px" %)C|string|(% style="width:389px" %)The url of the resource.
427 +| |(% style="width:244px" %)(Maintenance) agencyId|(% style="width:99px" %)M|string|(% style="width:389px" %)The object must be linked to a maintenance agency.
408 408  
409 -International String
410 -)))|C| |This can have languagespecific variants.
411 -| | | | |
412 -|Identifiable|all content as for Annotable plus| | |
413 -| |id|M|string|
414 -| |uri|C|string|
415 -| |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.
416 -|Nameable|all content as for Identifiable plus| | |
417 -| |Name in the form of International String|M|string|This can have languagespecific variants.
418 -| |(((
419 -Description in the form of International
420 -
421 -String
422 -)))|C|string|This can have languagespecific variants.
423 -|Versionable|All content as for Identifiable plus| | |
424 -| |version|C|string|This is the version number. If not present the default is 1.0
425 -| |validFrom|C|Date/time|
426 -| |validTo|C|Date/time|
427 -|Maintainable|All content as for Versionable plus| | |
428 -| |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.
429 -| |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.
430 -| |serviceURL|C|string|The url of the service that can be queried for this resource
431 -| |structureURL|C|string|The url of the resource.
432 -| |(Maintenance) agencyId|M|string|The object must be linked to a maintenance agency.
433 -
434 434  **Table 1: Common Attributes of Object Types**
435 435  
436 436  == 6.2 Unique identification of SDMX objects ==
... ... @@ -475,7 +475,6 @@
475 475  
476 476  An example of this is shown in the XML snippet below.
477 477  
478 -
479 479  [[image:1747824123013-196.jpeg]]
480 480  
481 481  ==== Figure 8: Example Showing Use of Agency Identifiers ====
1747824504225-229.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +52.8 KB
Content