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

From version 3.1
edited by Helena
on 2025/05/21 15:14
Change comment: There is no comment for this version
To version 1.2
edited by Helena
on 2025/05/21 13:44
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -292,13 +292,15 @@
292 292  
293 293  3The Registration has an action attribute which takes one of the following values:
294 294  
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
295 +|(((
296 +**Action**
301 301  
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 +
302 302  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:
303 303  
304 304  |**Boolean Attribute**|**Behaviour if Value is “true”**
... ... @@ -314,9 +314,10 @@
314 314  
315 315  The Data and Metadata Discovery Service implements the following Registry Interfaces:
316 316  
317 -* QueryRegistrationRequest
318 -* QueryRegistrationResponse
319 + QueryRegistrationRequest
319 319  
321 + QueryRegistrationResponse
322 +
320 320  === 5.2.6 Subscription and Notification ===
321 321  
322 322  The Subscription and Notification Service implements the following Registry Interfaces:
... ... @@ -340,12 +340,13 @@
340 340  
341 341  The following table defines the behaviour of the SDMX Registry for the various Registry Interface messages.
342 342  
343 -|(% style="width:244px" %)**Interface**|**Behaviour**
344 -|(% style="width:244px" %)All|(((
346 +|**Interface**|**Behaviour**
347 +|All|(((
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.
352 +
349 349  * Annotation - this applies to the Maintainable object and its contained elements, such a Code in a Code list.
350 350  * validTo
351 351  * validFrom
... ... @@ -354,24 +354,26 @@
354 354  * uri
355 355  * isExternalReference
356 356  
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.
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:
358 358  
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:
364 +1. Not have the final attribute set to “true”
365 +1. Not be referenced from any other object in the Registry.
360 360  
361 -а) Not have the final attribute set to “true”
362 -b) Not be referenced from any other object in the Registry.
367 +1. The version rules in the SDMX Schema documentation MUST be obeyed.
363 363  
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.
369 +* The specific rules for the elements and attributes documented in the SDMX Schema MUST be obeyed.
367 367  )))
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|(((
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|(((
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.
375 +
372 372  For a queryable datasource the Registry MAY validate that the source exists and can accept an SDMX-ML data query.
373 373  )))
374 374  
379 +
380 +
375 375  = 6 Identification of SDMX Objects =
376 376  
377 377  == 6.1 Identification, Versioning, and Maintenance ==
... ... @@ -378,6 +378,7 @@
378 378  
379 379  All major classes of the SDMX Information model inherit from one of:
380 380  
387 +
381 381  * **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.
382 382  * **NamableArtefact **- this has all of the features of IdentifiableArtefact plus the ability to have a multi-lingual name and description,
383 383  * **VersionableArtefact **– this has all of the above features plus a version number and a validity period.
... ... @@ -385,8 +385,6 @@
385 385  
386 386  === 6.1.1 Identification, Naming, Versioning, and Maintenance Model ===
387 387  
388 -[[image:1747824504225-229.png]]
389 -
390 390  **Figure 5: Class diagram of fundamental artefacts in the SDMX-IM**
391 391  
392 392  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 @@
397 397  * Versionable
398 398  * Maintainable
399 399  
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.
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
427 427  
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 +
428 428  **Table 1: Common Attributes of Object Types**
429 429  
430 430  == 6.2 Unique identification of SDMX objects ==
... ... @@ -469,11 +469,11 @@
469 469  
470 470  An example of this is shown in the XML snippet below.
471 471  
472 -[[image:1747824123013-196.jpeg||height="309" width="446"]]
473 473  
474 -(% class="wikigeneratedid" id="HFigure8:ExampleShowingUseofAgencyIdentifiers" %)
475 -**Figure 8: Example Showing Use of Agency Identifiers**
482 +[[image:1747824123013-196.jpeg]]
476 476  
484 +==== Figure 8: Example Showing Use of Agency Identifiers ====
485 +
477 477  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.
478 478  
479 479  === 6.2.2 Universal Resource Name (URN) ===
... ... @@ -512,8 +512,10 @@
512 512  
513 513  **(maintainable-object-version)** is the version of the maintainable object and is enclosed in round brackets (). It will always be present.
514 514  
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.
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
516 516  
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 +
517 517  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.
518 518  
519 519  For example the sequence is agency:DSDid(version).DimensionId and not agency:DSDid(version).DimensionDescriptorId.DimensionId.
... ... @@ -520,57 +520,58 @@
520 520  
521 521  **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.
522 522  
523 -===== __**//Generic Examples of the URN Structure//**__ =====
534 +===== //Generic Examples of the URN Structure// =====
524 524  
525 -__Actual object is a maintainable__
526 526  
527 -> SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version)
537 +Actual object is a maintainable
528 528  
529 -__Actual object is contained in a maintained object with no intermediate containing object__
539 +SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version)
530 530  
531 -> SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).object-id
541 +Actual object is contained in a maintained object with no intermediate containing object
532 532  
533 -__Actual object is contained in a maintained object with an intermediate containing object__
543 +SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).object-id
534 534  
535 -> SDMXPrefix.SDMX-IM package name.classname=agency
545 +Actual object is contained in a maintained object with an intermediate containing object
536 536  
547 +SDMXPrefix.SDMX-IM package name.classname=agency
548 +
537 537  id:maintained-object-id(version).contained-object-id.object-id
538 538  
539 -__Actual object is contained in a maintained object with no intermediate containing object but the object type itself is hierarchical__
551 +Actual object is contained in a maintained object with no intermediate containing object but the object type itself is hierarchical
540 540  
541 541  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
542 542  
543 -> SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).contained-object-id.object-id
555 +SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).contained-object-id.object-id
544 544  
545 -__Actual object is contained in a maintained object with an intermediate containing object and the object type itself is hierarchical__
557 +Actual object is contained in a maintained object with an intermediate containing object and the object type itself is hierarchical
546 546  
547 547  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
548 548  
549 -> SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).contained-object-id. contained-object-id contained-object-id.object-id
561 +SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).contained-object-id. contained-object-id contained-object-id.object-id
550 550  
551 -===== __**//Concrete Examples of the URN Structure//**__ =====
563 +===== //Concrete Examples of the URN Structure// =====
552 552  
553 553  The Data Structure Definition CRED_EXT_DEBT version 1.0 maintained by the top level Agency TFFS would have the URN:
554 554  
555 -> urn:sdmx:org.sdmx.infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(1.0)
567 +urn:sdmx:org.sdmx.infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(1.0)
556 556  
557 557  The URN for a code for Argentina maintained by ISO in the code list CL_3166A2 version 1.0 would be:
558 558  
559 -> urn:sdmx:org.sdmx.infomodel.codelist.Code=ISO:CL_3166A2(1.0).AR
571 +urn:sdmx:org.sdmx.infomodel.codelist.Code=ISO:CL_3166A2(1.0).AR
560 560  
561 561  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:
562 562  
563 -> urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:SUBJE CT_MATTER_DOMAINS(1.0).1.2
575 +urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:SUBJE CT_MATTER_DOMAINS(1.0).1.2
564 564  
565 565  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
566 566  
567 567  CONTACT_DETAILS/CONTACT_NAME would be:
568 568  
569 -> urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataAttribut e=SDMX:CONTACT_METADATA(1.0).CONTACT_REPORT.CONTACT_DETAILS.CO NTACT_NAME
581 +urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataAttribut e=SDMX:CONTACT_METADATA(1.0).CONTACT_REPORT.CONTACT_DETAILS.CO NTACT_NAME
570 570  
571 571  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:
572 572  
573 -> urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=TFFS.ABC:EX
585 +urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=TFFS.ABC:EX
574 574  
575 575  TERNAL_DEBT(1.0)
576 576  
... ... @@ -585,94 +585,112 @@
585 585  
586 586  The table below lists all of the packages in the SDMX-IM together with the concrete classes that are in these packages and whose objects have a URN.
587 587  
588 -|(% style="width:127px" %)**Package**|(% style="width:1745px" %)(((
589 -**URN Classname (model classname where this is different)**
600 +|**Package**|(((
601 +**URN Classname (model classname**
602 +
603 +**where this is different)**
590 590  )))
591 -|(% style="width:127px" %)base|(% style="width:45px" %)Agency
592 -|(% style="width:127px" %) |(% style="width:45px" %)OrganisationUnitScheme
593 -|(% style="width:127px" %) |(% style="width:45px" %)AgencyScheme
594 -|(% style="width:127px" %) |(% style="width:45px" %)DataProviderScheme
595 -|(% style="width:127px" %) |(% style="width:45px" %)DataConsumerScheme
596 -|(% style="width:127px" %) |(% style="width:45px" %)OrganisationUnit
597 -|(% style="width:127px" %) |(% style="width:45px" %)DataProvider
598 -|(% style="width:127px" %) |(% style="width:45px" %)DataConsumer
599 -|(% style="width:127px" %)datastructure|(% style="width:45px" %)DataStructure (DataStructureDefinition)
600 -|(% style="width:127px" %) |(% style="width:45px" %)AttributeDescriptor
601 -|(% style="width:127px" %) |(% style="width:45px" %)DataAttribute
602 -|(% style="width:127px" %) |(% style="width:45px" %)GroupDimensionDescriptor
603 -|(% style="width:127px" %) |(% style="width:45px" %)DimensionDescriptor
604 -|(% style="width:127px" %) |(% style="width:45px" %)Dimension
605 -|(% style="width:127px" %) |(% style="width:45px" %)MeasureDimension
606 -|(% style="width:127px" %) |(% style="width:45px" %)TimeDimension
607 -|(% style="width:127px" %) |(% style="width:45px" %)MeasureDescriptor
608 -|(% style="width:127px" %) |(% style="width:45px" %)PrimaryMeasure
609 -|(% style="width:127px" %) |(% style="width:45px" %)Dataflow (DataflowDefinition)
610 -|(% style="width:127px" %)metadatastructure|(% style="width:45px" %)MetadataTarget
611 -|(% style="width:127px" %) |(% style="width:45px" %)DimensionDescriptorValueTarget
612 -|(% style="width:127px" %) |(% style="width:45px" %)IdentifiableObjectTarget
613 -|(% style="width:127px" %) |(% style="width:45px" %)ReportPeriodTarget
614 -|(% style="width:127px" %) |(% style="width:45px" %)DataSetTarget
615 -|(% style="width:127px" %) |(% style="width:45px" %)ReportStructure
616 -|(% style="width:127px" %) |(% style="width:45px" %)MetadataAttribute
617 -|(% style="width:127px" %) |(% style="width:45px" %)(((
605 +|base|Agency
606 +| |OrganisationUnitScheme
607 +| |AgencyScheme
608 +| |DataProviderScheme
609 +| |DataConsumerScheme
610 +| |OrganisationUnit
611 +| |DataProvider
612 +| |DataConsumer
613 +| |
614 +|datastructure|DataStructure (DataStructureDefinition)
615 +| |AttributeDescriptor
616 +| |DataAttribute
617 +| |GroupDimensionDescriptor
618 +| |DimensionDescriptor
619 +| |Dimension
620 +| |MeasureDimension
621 +| |TimeDimension
622 +| |MeasureDescriptor
623 +| |PrimaryMeasure
624 +| |Dataflow (DataflowDefinition)
625 +| |
626 +|metadatastructure|MetadataTarget
627 +| |DimensionDescriptorValueTarget
628 +| |IdentifiableObjectTarget
629 +| |ReportPeriodTarget
630 +| |DataSetTarget
631 +| |ReportStructure
632 +| |MetadataAttribute
633 +| |(((
618 618  MetadataStructure
619 619  
620 620  (MetadataStructureDefinition)
621 621  )))
622 -|(% style="width:127px" %) |(% style="width:45px" %)Metadataflow (MetadataflowDefinition)
623 -|(% style="width:127px" %)process|(% style="width:45px" %)Process
624 -|(% style="width:127px" %) |(% style="width:45px" %)ProcessStep
625 -|(% style="width:127px" %) |(% style="width:45px" %)Transition
626 -|(% style="width:127px" %)registry|(% style="width:45px" %)ProvisionAgreement
627 -|(% style="width:127px" %) |(% style="width:45px" %)AttachmentConstraint
628 -|(% style="width:127px" %) |(% style="width:45px" %)ContentConstraint
629 -|(% style="width:127px" %) |(% style="width:45px" %)Subscription
630 -|(% style="width:127px" %)mapping|(% style="width:45px" %)StructureMap
631 -|(% style="width:127px" %) |(% style="width:45px" %)StructureSet
632 -|(% style="width:127px" %) |(% style="width:45px" %)ComponentMap
633 -|(% style="width:127px" %) |(% style="width:1745px" %)ConceptSchemeMap
634 -|(% style="width:127px" %) |(% style="width:1745px" %)OrganisationSchemeMap
635 -|(% style="width:127px" %) |(% style="width:1745px" %)CodelistMap
636 -|(% style="width:127px" %) |(% style="width:1745px" %)CategorySchemeMap
637 -|(% style="width:127px" %) |(% style="width:1745px" %)ReportingTaxonomyMap
638 -|(% style="width:127px" %) |(% style="width:1745px" %)ConceptMap
639 -|(% style="width:127px" %) |(% style="width:1745px" %)OrganisationMap
640 -|(% style="width:127px" %) |(% style="width:1745px" %)CodeMap
641 -|(% style="width:127px" %) |(% style="width:1745px" %)HybridCodelistMap
642 -|(% style="width:127px" %) |(% style="width:1745px" %)CategoryMap
643 -|(% style="width:127px" %) |(% style="width:1745px" %)HybridCodeMap
644 -|(% style="width:127px" %) |(% style="width:1745px" %)ReportingCategoryMap
645 -|(% style="width:127px" %)codelist|(% style="width:1745px" %)Codelist
646 -|(% style="width:127px" %) |(% style="width:1745px" %)HierarchicalCodelist
647 -|(% style="width:127px" %) |(% style="width:1745px" %)Hierarchy
648 -|(% style="width:127px" %) |(% style="width:1745px" %)Hierarchy
649 -|(% style="width:127px" %) |(% style="width:1745px" %)Code
650 -|(% style="width:127px" %) |(% style="width:1745px" %)HierarchicalCode
651 -|(% style="width:127px" %) |(% style="width:1745px" %)Level
652 -|(% style="width:127px" %)categoryscheme|(% style="width:1745px" %)CategoryScheme
653 -|(% style="width:127px" %) |(% style="width:1745px" %)Category
654 -|(% style="width:127px" %) |(% style="width:1745px" %)Categorisation
655 -|(% style="width:127px" %) |(% style="width:1745px" %)ReportingTaxonomy
656 -|(% style="width:127px" %) |(% style="width:1745px" %)ReportingCategory
657 -|(% style="width:127px" %)conceptscheme|(% style="width:1745px" %)ConceptScheme
658 -|(% style="width:127px" %) |(% style="width:1745px" %)Concept
659 -|(% style="width:127px" %)transformation|(% style="width:1745px" %)TransformationScheme
660 -|(% style="width:127px" %) |(% style="width:1745px" %)Transformation
661 -|(% style="width:127px" %) |(% style="width:1745px" %)CustomTypeScheme
662 -|(% style="width:127px" %) |(% style="width:1745px" %)CustomType
663 -|(% style="width:127px" %) |(% style="width:1745px" %)NamePersonalisationScheme
664 -|(% style="width:127px" %) |(% style="width:1745px" %)NamePersonalisation
665 -|(% style="width:127px" %) |(% style="width:1745px" %)VtlCodelistMapping
666 -|(% style="width:127px" %) |(% style="width:1745px" %)VtlConceptMapping
667 -|(% style="width:127px" %) |(% style="width:1745px" %)VtlDataflowMapping
668 -|(% style="width:127px" %) |(% style="width:1745px" %)VtlConceptSchemeMapping
669 -|(% style="width:127px" %) |(% style="width:1745px" %)RulesetScheme
670 -|(% style="width:127px" %) |(% style="width:1745px" %)Ruleset
671 -|(% style="width:127px" %) |(% style="width:1745px" %)UserDefinedOperatorScheme
672 -|(% style="width:127px" %) |(% style="width:1745px" %)UserDefinedOperator
638 +| |Metadataflow (MetadataflowDefinition)
639 +| |
640 +|process|Process
641 +| |ProcessStep
642 +| |Transition
643 +| |
644 +|registry|ProvisionAgreement
645 +| |AttachmentConstraint
646 +| |ContentConstraint
647 +| |Subscription
648 +| |
649 +|mapping|StructureMap
650 +| |StructureSet
651 +| |ComponentMap
652 +|**Package**|(((
653 +**URN Classname (model classname**
673 673  
655 +**where this is different)**
656 +)))
657 +| |ConceptSchemeMap
658 +| |OrganisationSchemeMap
659 +| |CodelistMap
660 +| |CategorySchemeMap
661 +| |ReportingTaxonomyMap
662 +| |ConceptMap
663 +| |OrganisationMap
664 +| |CodeMap
665 +| |HybridCodelistMap
666 +| |CategoryMap
667 +| |HybridCodeMap
668 +| |ReportingCategoryMap
669 +| |
670 +|codelist|Codelist
671 +| |HierarchicalCodelist
672 +| |Hierarchy
673 +| |Hierarchy
674 +| |Code
675 +| |HierarchicalCode
676 +| |Level
677 +| |
678 +|categoryscheme|CategoryScheme
679 +| |Category
680 +| |Categorisation
681 +| |ReportingTaxonomy
682 +| |ReportingCategory
683 +| |
684 +|conceptscheme|ConceptScheme
685 +| |Concept
686 +| |
687 +|transformation|TransformationScheme
688 +| |Transformation
689 +| |CustomTypeScheme
690 +| |CustomType
691 +| |NamePersonalisationScheme
692 +| |NamePersonalisation
693 +| |VtlCodelistMapping
694 +| |VtlConceptMapping
695 +| |VtlDataflowMapping
696 +| |VtlConceptSchemeMapping
697 +| |RulesetScheme
698 +| |Ruleset
699 +| |UserDefinedOperatorScheme
700 +| |UserDefinedOperator
701 +| |
702 +
674 674  **Table 2: SDMX-IM Packages and Contained Classes**
675 675  
705 +
676 676  === 6.2.4 URN Identification components of SDMX objects ===
677 677  
678 678  The table below describes the identification components for all SDMX object types that have identification. Note the actual attributes are all Id, but have been prefixed by their class name or multiple class names to show navigation, e.g. conceptSchemeAgencyId is really the Id attribute of the Agency class that is associated to the ConceptScheme.
... ... @@ -681,52 +681,78 @@
681 681  
682 682  Note that for brevity the URN examples omit the prefix. All URNs have the prefix
683 683  
684 -> urn:sdmx.org.sdmx.infomodel.{package}.{classname}=
714 +urn:sdmx.org.sdmx.infomodel.{package}.{classname}=
685 685  
686 -(% style="width:1091.29px" %)
687 -|(% style="width:250px" %)**SDMX Class**|(% style="width:444px" %)**Key attribute(s)**|(% style="width:396px" %)**Example of URN**
688 -|(% style="width:250px" %)Agency|(% style="width:444px" %)The URN for an Agency is shown later in this table. 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.|(% style="width:396px" %)(((
716 +
717 +|**SDMX Class**|**Key attribute(s)**|**Example of URN**
718 +|Agency|The URN for an Agency is shown later in this table. 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.|(((
689 689  IMF
720 +
721 +
690 690  Sub agency in the IMF AGENCIES
723 +
724 +
691 691  IMF.SubAgency1
692 692  )))
693 -|(% style="width:250px" %)*ConceptScheme|(% style="width:444px" %)conceptSchemeAgencyId:conceptSchemeId(ve rsion)|(% style="width:396px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0)
694 -|(% style="width:250px" %)Concept|(% style="width:444px" %)conceptSchemeAgencyId:
695 -conceptSchemeId(version).conceptId|(% style="width:396px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0).FREQ
696 -|(% style="width:250px" %)*Codelist|(% style="width:444px" %)codeListAgencyId:codeListId(version)|(% style="width:396px" %)SDMX:CL_FREQ(1.0)
697 -|(% style="width:250px" %)Code|(% style="width:444px" %)codeListAgencyId:codelistId(version).codeId|(% style="width:396px" %)SDMX:CL_FREQ(1.0).Q
698 -|(% style="width:250px" %)(((
699 -*Hierarchical Codelist
700 -)))|(% style="width:444px" %)hierachicalCodelistAgencyId: hierarchicalCodelistId(version)|(% style="width:396px" %)(((
701 -UNESCO:CL_EXP_SOURCE(1.0(% style="background-color:transparent" %))
727 +|*ConceptScheme|conceptSchemeAgencyId:conceptSchemeId(ve rsion)|SDMX:CROSS_DOMAIN_CONCEPTS(1.0)
728 +|Concept|(((
729 +conceptSchemeAgencyId:
730 +
731 +conceptSchemeId(version).conceptId
732 +)))|SDMX:CROSS_DOMAIN_CONCEPTS(1.0).FREQ
733 +|*Codelist|codeListAgencyId:codeListId(version)|SDMX:CL_FREQ(1.0)
734 +|Code|codeListAgencyId:codelistId(version).codeId|(((
735 +SDMX:CL_FREQ(1.0).Q
736 +
737 +
702 702  )))
703 -|(% style="width:250px" %)Hierarchy|(% style="width:444px" %)(((
739 +
740 +
741 +
742 +|(((
743 +*Hierarchical
744 +
745 +Codelist
746 +)))|hierachicalCodelistAgencyId: hierarchicalCodelistId(version)|(((
747 +UNESCO:CL_EXP_SOURCE(1.0)
748 +
749 +
750 +)))
751 +|Hierarchy|(((
704 704  hierachicalcodeListAgencyId:
753 +
705 705  hierarchicalcodelistId(version).Hierarchy
706 -)))|(% style="width:396px" %)UNESCO:CL_EXP_SOURCE(1.0).
707 -H-C-GOV
708 -|(% style="width:250px" %)Level|(% style="width:444px" %)(((
755 +)))|UNESCO:CL_EXP_SOURCE(1.0). H-C-GOV
756 +|Level|(((
709 709  hierachicalcodeListAgencyId:
758 +
710 710  hierarchicalcodelistId(version).Hierarchy.Level
711 -)))|(% style="width:396px" %)(((
760 +)))|(((
712 712  ESTAT:HCL_REGION(1.0).H_1.COUNTRY
713 713  
714 714  
715 715  )))
716 -|(% style="width:250px" %)HierarchicalCode|(% style="width:444px" %)hierachicalCodeListAgencyId: hierarchicalcodelistId(version).hierarchy.hierarc hicalCode|(% style="width:396px" %)UNESCO:CL_EXP_SOURCE(1.0). H-C-GOV.GOV_CODE1
717 -|(% style="width:250px" %)*DataStructure|(% style="width:444px" %)dataStructureDefintitionAgencyId: dataStructureDefintitionId(version)|(% style="width:396px" %)TFFS:EXT_DEBT(1.0)
718 -|(% style="width:250px" %)(((
765 +|HierarchicalCode|hierachicalCodeListAgencyId: hierarchicalcodelistId(version).hierarchy.hierarc hicalCode|UNESCO:CL_EXP_SOURCE(1.0). H-C-GOV.GOV_CODE1
766 +|*DataStructure|dataStructureDefintitionAgencyId: dataStructureDefintitionId(version)|TFFS:EXT_DEBT(1.0)
767 +|(((
719 719  Dimension
769 +
720 720  Descriptor
771 +
721 721  Measure
773 +
722 722  Descriptor
775 +
723 723  Attribute
777 +
724 724  Descriptor
725 -)))|(% style="width:444px" %)(((
779 +)))|(((
726 726  dataStructureDefinitionAgencyId: dataStructureDefinitionId(version).
781 +
727 727  componentListId
783 +
728 728  where the componentListId is the name of the class (there is only one occurrence of each in the Data Structure Definition)
729 -)))|(% style="width:396px" %)(((
785 +)))|(((
730 730  TFFS:EXT_DEBT(1.0).DimensionDescriptor
731 731  
732 732  TFFS:EXT_DEBT(1.0).MeasureDescriptor
... ... @@ -733,132 +733,181 @@
733 733  
734 734  TFFS:EXT_DEBT(1.0).AttributeDescriptor
735 735  )))
736 -|(% style="width:250px" %)(((
792 +|(((
737 737  GroupDimension
794 +
738 738  Descriptor
739 -)))|(% style="width:444px" %)(((
796 +)))|(((
740 740  dataStructureDefinitionAgencyId: dataStructureDefinitionId(version).
798 +
741 741  groupDimensionDescriptorId
742 -)))|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).SIBLING
743 -|(% style="width:250px" %)Dimension|(% style="width:444px" %)(((
800 +)))|TFFS:EXT_DEBT(1.0).SIBLING
801 +|Dimension|(((
744 744  dataStructureDefinitionAgencyId: dataStructureDefinition (version).
803 +
745 745  dimensionId
746 -)))|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).FREQ
747 -|(% style="width:250px" %)TimeDimension|(% style="width:444px" %)(((
805 +)))|TFFS:EXT_DEBT(1.0).FREQ
806 +|TimeDimension|(((
748 748  dataStructureDefinitionAgencyId: dataStructureDefinition (version).
808 +
749 749  timeDimensionId
750 -)))|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).TIME_PERIOD
751 -|(% style="width:250px" %)Measure Dimension|(% style="width:444px" %)dataStructureDefinitionAgencyId: dataStructureDefinition (version).
752 -measureDimensionId|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).STOCK_FLOW
753 -|(% style="width:250px" %)DataAttrribute|(% style="width:444px" %)dataStructureDefinitionAgencyId: dataStructureDefinition (version). dataAttributeId|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).OBS_STATUS
754 -|(% style="width:250px" %)PrimaryMeasure|(% style="width:444px" %)(((
810 +)))|TFFS:EXT_DEBT(1.0).TIME_PERIOD
811 +|Measure Dimension|dataStructureDefinitionAgencyId: dataStructureDefinition (version).|TFFS:EXT_DEBT(1.0).STOCK_FLOW
812 +
813 +
814 +
815 +| |measureDimensionId|
816 +|DataAttrribute|dataStructureDefinitionAgencyId: dataStructureDefinition (version). dataAttributeId|TFFS:EXT_DEBT(1.0).OBS_STATUS
817 +|PrimaryMeasure|(((
755 755  dataStructureDefinitionAgencyId: dataStructureDefinition (version).
819 +
756 756  primaryMeasureId
757 -)))|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).OBS_VALUE
758 -|(% style="width:250px" %)(((
759 -*Category Scheme
760 -)))|(% style="width:444px" %)categorySchemeAgencyId:
761 -categorySchemeId(version)|(% style="width:396px" %)IMF:SDDS(1.0)
762 -|(% style="width:250px" %)Category|(% style="width:444px" %)categorySchemeAgencyId:
763 -categorySchemeId(version).
764 -categoryId.categoryId categoryId.categoryId etc.|(% style="width:396px" %)(((
821 +)))|TFFS:EXT_DEBT(1.0).OBS_VALUE
822 +|(((
823 +*Category
824 +
825 +Scheme
826 +)))|categorySchemeAgencyId: categorySchemeId(version)|IMF:SDDS(1.0)
827 +|Category|categorySchemeAgencyId: categorySchemeId(version). categoryId.categoryId categoryId.categoryId etc.|(((
765 765  IMF:SDDS(1.0):
829 +
766 766  level_1_category.level_2_category …
767 767  )))
768 -|(% style="width:250px" %)(((
769 -*Reporting Taxonomy
770 -)))|(% style="width:444px" %)reportingTaxonomyAgencyId: reportingTaxonomyId(version)|(% style="width:396px" %) IMF:REP_1(1.0)
771 -|(% style="width:250px" %)ReportingCategory|(% style="width:444px" %)reportingTaxonomyAgencyId: reportingTaxonomyId(version) reportingcategoryId.reportingcategoryId|(% style="width:396px" %)(((
832 +|(((
833 +*Reporting
834 +
835 +Taxonomy
836 +)))|reportingTaxonomyAgencyId: reportingTaxonomyId(version)| IMF:REP_1(1.0)
837 +|ReportingCategory|reportingTaxonomyAgencyId: reportingTaxonomyId(version) reportingcategoryId.reportingcategoryId|(((
772 772  IMF:REP_1(1.0):
839 +
773 773  level_1_repcategory.level_2_repcategory …
774 774  )))
775 -|(% style="width:250px" %)*Categorisation|(% style="width:444px" %)categorisationAgencyId: categorisationId(version)|(% style="width:396px" %)IMF:cat001(1.0)
776 -|(% style="width:250px" %)(((
777 -*Organisation Unit Scheme
778 -)))|(% style="width:444px" %)organisationUnitSchemeAgencyId: organisationUnitSchemeId(version)|(% style="width:396px" %)ECB:ORGANISATIONS(1.0)
779 -|(% style="width:250px" %)Organisation Unit|(% style="width:444px" %)organisationUnitSchemeAgencyId: organisationUnitSchemeId(version). organisationUnitId|(% style="width:396px" %)ECB:ORGANISATIONS(1.0).1F
780 -|(% style="width:250px" %)*AgencyScheme|(% style="width:444px" %)agencySchemeAgencyId: agencySchemeId(version)|(% style="width:396px" %)ECB:AGENCIES(1.0)
842 +|*Categorisation|categorisationAgencyId: categorisationId(version)|IMF:cat001(1.0)
843 +|(((
844 +*Organisation
781 781  
782 -|(% style="width:262px" %)Agency|(% style="width:369px" %)agencySchemeAgencyId: agencySchemeId(version). agencyId|(% style="width:1262px" %)ECB:AGENCY(1.0).AA
783 -|(% style="width:262px" %)(((
784 -*DataProvider Scheme
785 -)))|(% style="width:369px" %)dataProviderSchemeAgencyId: dataProviderSchemeId(version)|(% style="width:1262px" %)SDMX:DATA_PROVIDERS(1.0)
786 -|(% style="width:262px" %)DataProvider|(% style="width:369px" %)dataProviderSchemeAgencyId: dataProviderSchemeId(version) dataProviderId|(% style="width:1262px" %)SDMX:DATA_PROVIDERS(1.0).PROVIDER_1
787 -|(% style="width:262px" %)(((
788 -*DataConsumer Scheme
789 -)))|(% style="width:369px" %)dataConsumerSchemeAgencyId: dataConsumerSchemeId(version)|(% style="width:1262px" %)SDMX:DATA_CONSUMERS(1.0)
790 -|(% style="width:262px" %)Data Consumer|(% style="width:369px" %)dataConsumerSchemeAgencyId: dataConsumerSchemeId(version) dataConsumerId|(% style="width:1262px" %)SDMX:DATA_CONSUMERS(1.0).CONSUMER_1
791 -|(% style="width:262px" %)(((
792 -*Metadata Structure
793 -)))|(% style="width:369px" %)MSDAgencyId:MSDId(version)|(% style="width:1262px" %)IMF:SDDS_MSD(1.0)
794 -|(% style="width:262px" %)MetadataTarget|(% style="width:369px" %)(((
846 +Unit Scheme
847 +)))|organisationUnitSchemeAgencyId: organisationUnitSchemeId(version)|ECB:ORGANISATIONS(1.0)
848 +|Organisation Unit|organisationUnitSchemeAgencyId: organisationUnitSchemeId(version). organisationUnitId|ECB:ORGANISATIONS(1.0).1F
849 +|*AgencyScheme|agencySchemeAgencyId: agencySchemeId(version)|ECB:AGENCIES(1.0)
850 +
851 +
852 +
853 +|Agency|agencySchemeAgencyId: agencySchemeId(version). agencyId|ECB:AGENCY(1.0).AA
854 +|(((
855 +*DataProvider
856 +
857 +Scheme
858 +)))|dataProviderSchemeAgencyId: dataProviderSchemeId(version)|SDMX:DATA_PROVIDERS(1.0)
859 +|DataProvider|dataProviderSchemeAgencyId: dataProviderSchemeId(version) dataProviderId|SDMX:DATA_PROVIDERS(1.0).PROVIDER_1
860 +|(((
861 +*DataConsumer
862 +
863 +Scheme
864 +)))|dataConsumerSchemeAgencyId: dataConsumerSchemeId(version)|SDMX:DATA_CONSUMERS(1.0)
865 +|Data Consumer|dataConsumerSchemeAgencyId: dataConsumerSchemeId(version) dataConsumerId|SDMX:DATA_CONSUMERS(1.0).CONSUMER_1
866 +|(((
867 +*Metadata
868 +
869 +Structure
870 +)))|MSDAgencyId:MSDId(version)|IMF:SDDS_MSD(1.0)
871 +|MetadataTarget|(((
795 795  MSDAgencyId:
873 +
796 796  MSDId(version).metadataTargetId
797 -)))|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY
798 -|(% style="width:262px" %)(((
875 +)))|IMF:SDDS_MSD(1.0).AGENCY
876 +|(((
799 799  Dimension
878 +
800 800  DescriptorValues
880 +
801 801  Target
802 -)))|(% style="width:369px" %)(((
882 +)))|(((
803 803  MSDAgencyId: MSDId(version).
884 +
804 804  metadataTargetId.keyDescriptorValueTargetId
805 -)))|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY.KEY
806 -|(% style="width:262px" %)Identifiable Object Target|(% style="width:369px" %)(((
807 -MSDAgencyId: MSDId(version).metadataTargetId.identifiableObjectTargetId
808 -)))|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY.STR-OBJECT
809 -|(% style="width:262px" %)DataSetTarget|(% style="width:369px" %)(((
886 +)))|IMF:SDDS_MSD(1.0).AGENCY.KEY
887 +|Identifiable ObjectTarget|(((
810 810  MSDAgencyId:
811 -MSDId(version).metadataTargetId.dataSetTargetId
812 -)))|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY.D1101
813 -|(% style="width:262px" %)PeportPeriod Target|(% style="width:369px" %)(((
814 -MSDAgencyId: MSDId(version).metadataTargetId.reportPeriodTargetId
815 -)))|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY.REP_PER
816 816  
817 -|(% style="width:251px" %)(((
890 +MSDId(version).metadataTargetId.identifiable
891 +
892 +ObjectTargetId
893 +)))|IMF:SDDS_MSD(1.0).AGENCY.STR-OBJECT
894 +|DataSetTarget|(((
895 +MSDAgencyId:
896 +
897 +MSDId(version).metadataTargetId.dataSet
898 +
899 +TargetId
900 +)))|IMF:SDDS_MSD(1.0).AGENCY.D1101
901 +|PeportPeriod Target|(((
902 +MSDAgencyId:
903 +
904 +MSDId(version).metadataTargetId.reportPeriod
905 +
906 +TargetId
907 +)))|IMF:SDDS_MSD(1.0).AGENCY.REP_PER
908 +
909 +
910 +
911 +|(((
818 818  ReportStructure
819 819  
820 820  
821 -)))|(% style="width:442px" %)(((
822 -MSDAgencyId: MSDId(version).reportStructureId
823 -)))|(% style="width:1178px" %)IMF:SDDS_MSD(1.0).AGENCY_REPORT
824 -|(% style="width:251px" %)(((
915 +)))|(((
916 +MSDAgencyId:
917 +
918 +MSDId(version).reportStructureId
919 +)))|IMF:SDDS_MSD(1.0).AGENCY_REPORT
920 +|(((
825 825  Metadata
826 826  
827 827  Attribute
828 -)))|(% style="width:442px" %)(((
829 -MSDAgencyId: MSDId(version).reportStructureId.metadataattri buteID
830 -)))|(% style="width:1178px" %)IMF:SDDS_MSD(1.0).AGENCY_REPORT.COMPILATION
831 -|(% style="width:251px" %)*Dataflow|(% style="width:442px" %)dataflowAgencyId: dataflowId(version)|(% style="width:1178px" %)TFFS:CRED_EXT_DEBT(1.0)
832 -|(% style="width:251px" %)*Provision Agreement|(% style="width:442px" %)(((
924 +)))|(((
925 +MSDAgencyId:
926 +
927 +MSDId(version).reportStructureId.metadataattri buteID
928 +)))|IMF:SDDS_MSD(1.0).AGENCY_REPORT.COMPILATION
929 +|*Dataflow|dataflowAgencyId: dataflowId(version)|TFFS:CRED_EXT_DEBT(1.0)
930 +|*Provision Agreement|(((
833 833  provisionAgreementAgencyId:provisionAgreem entId(version)
834 -)))|(% style="width:1178px" %)(((
932 +
933 +
934 +)))|(((
835 835  TFFS:CRED_EXT_DEBT_AB(1.0)
936 +
937 +
938 +
836 836  )))
837 -|(% style="width:251px" %)(((
940 +|(((
838 838  *Content
839 839  
840 840  Constraint
841 -)))|(% style="width:442px" %)constraintAgencyId:ContentConstraintId(versio n)|(% style="width:1178px" %)TFFS:CREDITOR_DATA_CONTENT(1.0)
842 -|(% style="width:251px" %)(((
944 +)))|constraintAgencyId:ContentConstraintId(versio n)|TFFS:CREDITOR_DATA_CONTENT(1.0)
945 +|(((
843 843  *Attachment
844 844  
845 845  Constraint
846 -)))|(% style="width:442px" %)(((
949 +)))|(((
847 847  constraintAgencyId:
848 848  
849 849  attachmentConstraintId(version)
850 -)))|(% style="width:1178px" %)TFFS:CREDITOR_DATA_ATTACHMENT_CONSTRAINT_ONE(1.0)
851 -|(% style="width:251px" %)*Metadataflow|(% style="width:442px" %)metadataflowAgencyId: metadataflowId(version)|(% style="width:1178px" %)IMF:SDDS_FLOW(1.0)
852 -|(% style="width:251px" %)*StructureSet|(% style="width:442px" %)structureSetAgencyId: structureSetId(version)|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0)
853 -|(% style="width:251px" %)StructureMap|(% style="width:442px" %)structureSetAgencyId: structureSetId(version). structureMapId|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2
854 -|(% style="width:251px" %)Component Map|(% style="width:442px" %)(((
953 +)))|TFFS:CREDITOR_DATA_ATTACHMENT_CONSTRAINT_ONE(1.0)
954 +|*Metadataflow|metadataflowAgencyId: metadataflowId(version)|IMF:SDDS_FLOW(1.0)
955 +|*StructureSet|structureSetAgencyId: structureSetId(version)|SDMX:BOP_STRUCTURES(1.0)
956 +|StructureMap|structureSetAgencyId: structureSetId(version). structureMapId|SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2
957 +|Component Map|(((
855 855  structureSetAgencyId: structureSetId(version).
856 856  
857 857  structureMapId. componentMapId
858 -)))|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2. REFAREA_REPCOUNTRY
859 -|(% style="width:251px" %)CodelistMap|(% style="width:442px" %)structureSetAgencyId: structureSetId(version). codelistMapId|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0).CLREFAREA_CLREPCOUNTRY
860 -|(% style="width:251px" %)CodeMap|(% style="width:442px" %)structureSetAgencyId: structureSetId(version).|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0).CLREFAREA_CLREPCOUNTRY. DE_GER
961 +)))|SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2. REFAREA_REPCOUNTRY
962 +|CodelistMap|structureSetAgencyId: structureSetId(version). codelistMapId|SDMX:BOP_STRUCTURES(1.0).CLREFAREA_CLREPCOUNTRY
963 +|CodeMap|structureSetAgencyId: structureSetId(version).|SDMX:BOP_STRUCTURES(1.0).CLREFAREA_CLREPCOUNTRY. DE_GER
861 861  
965 +
966 +
862 862  | |(((
863 863  codeListMapId.
864 864  
... ... @@ -966,6 +966,7 @@
966 966  
967 967  7**Table 3: Table of identification components for SDMX Identifiable Artefacts**
968 968  
1074 +
969 969  = 7 Implementation Notes =
970 970  
971 971  == 7.1 Structural Definition Metadata ==
... ... @@ -986,72 +986,109 @@
986 986  
987 987  The following table lists the Maintainable Artefacts.
988 988  
989 -(% style="width:640.294px" %)
990 -|(% colspan="2" rowspan="1" style="width:186px" %)**Maintainable Artefacts**|(% style="width:206px" %)**Content**
991 -|(% style="width:171px" %)**Abstract Class**|(% style="width:232px" %)**Concrete Class**|(% style="width:206px" %)
992 -|(% style="width:171px" %)Item Scheme|(% style="width:232px" %)Codelist|(% style="width:206px" %)Code
993 -|(% style="width:171px" %) |(% style="width:232px" %)Concept Scheme|(% style="width:206px" %)Concept
994 -|(% style="width:171px" %) |(% style="width:232px" %)Category Scheme|(% style="width:206px" %)Category
995 -|(% style="width:171px" %) |(% style="width:232px" %)Organisation Unit Scheme|(% style="width:206px" %)Organisation Unit
996 -|(% style="width:171px" %) |(% style="width:232px" %)Agency Scheme|(% style="width:206px" %)Agency
997 -|(% style="width:171px" %) |(% style="width:232px" %)Data Provider Scheme|(% style="width:206px" %)Data Provider
998 -|(% style="width:171px" %) |(% style="width:232px" %)Data Consumer Scheme|(% style="width:206px" %)Data Consumer
999 -|(% style="width:171px" %) |(% style="width:232px" %)Reporting Taxonomy|(% style="width:206px" %)Reporting Category
1000 -|(% style="width:171px" %) |(% style="width:232px" %)Transformation Scheme|(% style="width:206px" %)Transformation
1001 -|(% style="width:171px" %) |(% style="width:232px" %)Custom Type Scheme|(% style="width:206px" %)Custom Type
1002 -|(% style="width:171px" %) |(% style="width:232px" %)Name Personalisation Scheme|(% style="width:206px" %)Name Personalisation
1003 -|(% style="width:171px" %) |(% style="width:232px" %)Vtl Mapping Scheme|(% style="width:206px" %)Vtl Codelist Mapping
1004 -|(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)Vtl Dataflow Mapping
1005 -|(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)Vtl Concept Scheme Mapping
1006 -|(% style="width:171px" %) |(% style="width:232px" %)Ruleset Scheme|(% style="width:206px" %)Ruleset
1007 -|(% style="width:171px" %) |(% style="width:232px" %)User Defined Operator Scheme|(% style="width:206px" %)User Defined Operator
1008 -|(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)User Defined Operator
1009 -|(% style="width:171px" %)Structure|(% style="width:232px" %)Data Structure Definition|(% style="width:206px" %)(((
1095 +|(% colspan="4" %)**Maintainable Artefacts**|(% colspan="2" %)**Content**|
1096 +|(% colspan="2" %)**Abstract Class**|(% colspan="2" %)**Concrete Class**|(% colspan="2" %) |
1097 +|(% colspan="2" %)Item Scheme|(% colspan="2" %)Codelist|(% colspan="2" %)Code|
1098 +|(% colspan="2" %) |(% colspan="2" %)Concept Scheme|(% colspan="2" %)Concept|
1099 +|(% colspan="2" %) |(% colspan="2" %)Category Scheme|(% colspan="2" %)Category|
1100 +|(% colspan="2" %) |(% colspan="2" %)Organisation Unit Scheme|(% colspan="2" %)Organisation Unit|
1101 +|(% colspan="2" %) |(% colspan="2" %)Agency Scheme|(% colspan="2" %)Agency|
1102 +|(% colspan="2" %) |(% colspan="2" %)Data Provider Scheme|(% colspan="2" %)Data Provider|
1103 +|(% colspan="2" %) |(% colspan="2" %)Data Consumer Scheme|(% colspan="2" %)Data Consumer|
1104 +|(% colspan="2" %) |(% colspan="2" %)Reporting Taxonomy|(% colspan="2" %)Reporting Category|
1105 +|(% colspan="2" %) |(% colspan="2" %)Transformation Scheme|(% colspan="2" %)Transformation|
1106 +|(% colspan="2" %) |(% colspan="2" %)Custom Type Scheme|(% colspan="2" %)Custom Type|
1107 +| |(% colspan="4" %)**Maintainable Artefacts**|(% colspan="2" %)**Content**
1108 +| |(% colspan="2" %)**Abstract Class**|(% colspan="2" %)**Concrete Class**|(% colspan="2" %)
1109 +| |(% colspan="2" %) |(% colspan="2" %)Name Personalisation Scheme|(% colspan="2" %)Name Personalisation
1110 +| |(% colspan="2" %) |(% colspan="2" %)Vtl Mapping Scheme|(% colspan="2" %)Vtl Codelist Mapping
1111 +| |(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)Vtl Concept Mapping
1112 +| |(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)Vtl Dataflow Mapping
1113 +| |(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)(((
1114 +Vtl Concept Scheme
1115 +
1116 +Mapping
1117 +)))
1118 +| |(% colspan="2" %) |(% colspan="2" %)Ruleset Scheme|(% colspan="2" %)Ruleset
1119 +| |(% colspan="2" %) |(% colspan="2" %)User Defined Operator Scheme|(% colspan="2" %)User Defined Operator
1120 +| |(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
1121 +| |(% colspan="2" %)Structure|(% colspan="2" %)Data Structure Definition|(% colspan="2" %)(((
1010 1010  Dimension Descriptor
1123 +
1011 1011  Group Dimension
1125 +
1012 1012  Descriptor
1127 +
1013 1013  Dimension
1129 +
1014 1014  Measure Dimension
1131 +
1015 1015  Time Dimension
1133 +
1016 1016  Attribute Descriptor
1135 +
1017 1017  Data Attribute
1137 +
1018 1018  Measure Descriptor
1139 +
1019 1019  Primary Measure
1020 1020  )))
1021 -|(% style="width:171px" %) |(% style="width:232px" %)Metadata Structure Definition|(% style="width:206px" %)(((
1022 -Metadata Target, Dimension Descriptor
1142 +| |(% colspan="2" %) |(% colspan="2" %)Metadata Structure Definition|(% colspan="2" %)(((
1143 +Metadata Target,
1144 +
1145 +Dimension Descriptor
1146 +
1023 1023  Values Target Identifiable
1148 +
1024 1024  Object Target
1150 +
1025 1025  Report Period Target
1152 +
1026 1026  Data SetTarget
1154 +
1027 1027  Report Structure
1156 +
1028 1028  Metadata Attribute
1029 1029  )))
1030 -|(% style="width:171px" %)Structure Usage|(% style="width:232px" %)Dataflow Definition|(% style="width:206px" %)
1031 -|(% style="width:171px" %) |(% style="width:232px" %)Metadataflow Definition|(% style="width:206px" %)
1032 -|(% style="width:171px" %)None|(% style="width:232px" %)Process|(% style="width:206px" %)Process Step
1033 -|(% style="width:171px" %)None|(% style="width:232px" %)Structure Set|(% style="width:206px" %)(((
1159 +| |(% colspan="2" %)Structure Usage|(% colspan="2" %)Dataflow Definition|(% colspan="2" %)
1160 +| |(% colspan="2" %) |(% colspan="2" %)Metadataflow Definition|(% colspan="2" %)
1161 +| |(% colspan="2" %)None|(% colspan="2" %)Process|(% colspan="2" %)Process Step
1162 +| |(% colspan="2" %)None|(% colspan="2" %)Structure Set|(% colspan="2" %)(((
1034 1034  Component Map
1164 +
1035 1035  Concept Scheme Map
1166 +
1036 1036  Codelist Map
1168 +
1037 1037  Category Scheme Map
1170 +
1038 1038  Reporting Taxonomy Map
1172 +
1039 1039  Organisation Scheme Map
1174 +
1040 1040  Concept Map
1176 +
1041 1041  Code Map
1178 +
1042 1042  Category Map
1180 +
1043 1043  Organisation Map
1182 +
1044 1044  Reporting Category Map
1184 +
1045 1045  Hybrid Codelist Map
1186 +
1046 1046  Hybrid Code Map
1047 1047  )))
1048 -|(% style="width:171px" %)None|(% style="width:232px" %)Provision Agreement|(% style="width:206px" %)
1049 -|(% style="width:171px" %)None|(% style="width:232px" %)Hierarchical Codelist|(% style="width:206px" %)(((
1189 +| |(% colspan="2" %)None|(% colspan="2" %)Provision Agreement|(% colspan="2" %)
1190 +| |(% colspan="2" %)None|(% colspan="2" %)Hierarchical Codelist|(% colspan="2" %)(((
1050 1050  Hierarchy
1192 +
1051 1051  Hierarchical Code
1052 1052  )))
1195 +| | | | | | |
1053 1053  
1054 -**able 4: Table of Maintainable Artefacts for Structural Definition Metadata**
1197 +**Table 4: Table of Maintainable Artefacts for Structural Definition Metadata**
1055 1055  
1056 1056  === 7.1.2 Item Scheme, Structure ===
1057 1057  
... ... @@ -1058,7 +1058,10 @@
1058 1058  The artefacts included in the structural definitions are:
1059 1059  
1060 1060  * All types of Item Scheme (Codelist, Concept Scheme, Category Scheme, Organisation Scheme - Agency Scheme, Data Provider Scheme, Data Consumer Scheme, Organisation Unit Scheme)
1061 -* All types of Structure (Data Structure Definition, Metadata Structure Definition)
1204 +* All types of Structure (Data Structure Definition, Metadata Structure
1205 +
1206 +Definition)
1207 +
1062 1062  * All types of Structure Usage (Dataflow Definition, Metadataflow Definition)
1063 1063  
1064 1064  === 7.1.3 Structure Usage ===
... ... @@ -1077,8 +1077,6 @@
1077 1077  
1078 1078  ==== 7.1.3.3 Structure Usage Model ====
1079 1079  
1080 -[[image:1747829078194-749.png]]
1081 -
1082 1082  **Figure 10: SDMX-IM of links from Structure Usage to Category**
1083 1083  
1084 1084  In addition to the maintenance of the Dataflow Definition and the Metadataflow Definition the following links must be maintained in the registry:
... ... @@ -1105,10 +1105,10 @@
1105 1105  
1106 1106  An organisation which publishes statistical data or reference metadata and wishes to make it available to an SDMX enabled community is called a Data Provider. In terms of the SDMX Information Model, the Data Provider is maintained in a Data Provider Scheme.
1107 1107  
1108 -[[image:1747829109466-595.png]]
1109 1109  
1110 1110  **Figure 11: SDMX-IM of the Data Provider**
1111 1111  
1255 +
1112 1112  Note that the Data Provider does not inherit the hierarchy association. The diagram below shows a logical schematic of the data model classes required to maintain provision agreements
1113 1113  
1114 1114  [[image:1747824123019-181.jpeg]]
... ... @@ -1117,10 +1117,8 @@
1117 1117  
1118 1118  The diagram below is a logical representation of the data required in order to maintain Provision Agreements.
1119 1119  
1120 -[[image:1747829139951-378.png]]
1121 1121  
1122 -(% class="wikigeneratedid" id="HFigure13:LogicalclassdiagramoftheinformationcontainedintheProvisionAgreement" %)
1123 -**Figure 13: Logical class diagram of the information contained in the Provision Agreement**
1265 +==== Figure 13: Logical class diagram of the information contained in the Provision Agreement ====
1124 1124  
1125 1125  A Provision Agreement is structural metadata. Each Provision Agreement must reference a Data Provider and a Dataflow or Metadataflow Definition. The Data Provider and the Dataflow/Metadataflow Definition must exist already in order to set up a Provision Agreement.
1126 1126  
... ... @@ -1148,12 +1148,13 @@
1148 1148  
1149 1149  === 7.3.3 Data and Metadata Constraints: Model ===
1150 1150  
1151 -[[image:1747829204737-370.png]]
1152 1152  
1153 -**Figure 15: Logical class diagram showing inheritance between and reference to constrainable artifacts**
1154 1154  
1155 -The class diagram above shows that DataProvider, DataflowDefinition, MetadataflowDefinition, ProvisionAgreement, DataStructureDefinition, MetadataStructureDefinition, SimpleDatasource and QueryDatasource are all concrete sub-classes of ConstrainableArtefact and can therefore have Constraints specified. Note that the actual Constraint as submitted is associated to the reference classes which inherit from ConstrainableRef: these are used to refer to the classes to which the Constraint applies.
1295 +==== Figure 15: Logical class diagram showing inheritance between and reference to constrainable artifacts ====
1156 1156  
1297 +The class diagram above shows that DataProvider, DataflowDefinition, MetadataflowDefinition, ProvisionAgreement, DataStructureDefinition, MetadataStructureDefinition, SimpleDatasource and QueryDatasource are all concrete sub-classes of ConstrainableArtefact and can therefore have Constraints specified. Note that the actual Constraint as submitted is associated to the reference classes which inherit from ConstrainableRef: these are used to refer to the classes to which the Constraint applies.
1298 +
1299 +
1157 1157  The content of the Constraint can be found in the SDMX Information Model document.
1158 1158  
1159 1159  == 7.4 Data and Metadata Registration ==
... ... @@ -1188,14 +1188,11 @@
1188 1188  
1189 1189  The Registration has an action attribute which takes one of the following values:
1190 1190  
1191 -(% style="width:970.294px" %)
1192 -|(% style="width:212px" %)**Action Attribute Value**|(% style="width:756px" %)**Behaviour**
1193 -|(% style="width:212px" %)Append|(% style="width:756px" %)Add this Registration to the registry
1194 -|(% style="width:212px" %)Replace|(% style="width:756px" %)Replace the existing Registration with identified by the id in the Registration of the Submit Registration Request
1195 -|(% style="width:212px" %)Delete|(% style="width:756px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
1334 +|**Action Attribute Value**|**Behaviour**
1335 +|Append|Add this Registration to the registry
1336 +|Replace|Replace the existing Registration with identified by the id in the Registration of the Submit Registration Request
1337 +|Delete|Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
1196 1196  
1197 -[[image:1747829290890-122.png]]
1198 -
1199 1199  **Figure 17: Logical Class Diagram of Registration of Data and Metadata**
1200 1200  
1201 1201  The Query Datasource is an abstract class that represents a data source which can understand an SDMX-ML query (SOAPDatasource) or RESTful query
... ... @@ -1210,19 +1210,25 @@
1210 1210  
1211 1211  Information in the data or metadata set is extracted and placed in one or more Content Constraints (see the Constraints 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 Provision Agreement as shown in the table below.
1212 1212  
1213 -|(% style="width:185px" %)**Indexing Required**|(% style="width:1686px" %)**Registration Process Activity**
1214 -|(% style="width:185px" %)indexTimeSeries|(% style="width:1686px" %)Extract all the series keys and create a KeySet(s) Constraint.
1215 -|(% style="width:185px" %)indexDataSet|(% style="width:1686px" %)(((
1216 -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.
1353 +|**Indexing Required**|**Registration Process Activity**
1354 +|indexTimeSeries|Extract all the series keys and create a KeySet(s) Constraint.
1355 +|indexDataSet|(((
1356 +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
1357 +
1358 +Regions containing Member Selections of Dimension Components of the Constraints model in the SDMX-IM, and the associated Selection Value.
1217 1217  )))
1218 -|(% style="width:185px" %)indexReportingPeriod|(% style="width:1686px" %)(((
1360 +|indexReportingPeriod|(((
1219 1219  This applies only to a registered dataset.
1362 +
1220 1220  Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint.
1221 1221  )))
1222 -|(% style="width:185px" %)indexAttributes|(% style="width:1686px" %)(((
1365 +|indexAttributes|(((
1223 1223  **Data Set**
1367 +
1224 1224  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
1369 +
1225 1225  **Metadata Set**
1371 +
1226 1226  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.
1227 1227  )))
1228 1228  
... ... @@ -1232,13 +1232,14 @@
1232 1232  
1233 1233  === 7.4.3 Registration Response ===
1234 1234  
1235 -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 Submit Registration class has a status field which is either set to “Success”, “Warning” or “Failure”.
1381 +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 Submit Registration class has a status field which is either set to
1236 1236  
1383 +“Success”, “Warning” or “Failure”.
1384 +
1237 1237  If the registration has succeeded, a Registration will be returned - this holds the Registry-allocated Id of the newly registered Datasource plus a Datasource holding the URL to access the dataset, metadataset, or query service.
1238 1238  
1239 1239  The Registration Response returns set of registration status (one for each registration submitted) in terms of a Status Message (this is common to all Registry Responses) that indicates success or failure. In the event of registration failure, a set of Message Text are returned, giving the error messages that occurred during registration. It is entirely possible when registering a batch of datasets, that the response will contain some successful and some failed statuses. The logical model for the Registration Response is shown below:
1240 1240  
1241 -[[image:1747829477882-750.png]]
1242 1242  
1243 1243  **Figure 18: Logical class diagram showing the registration response**
1244 1244  
... ... @@ -1248,12 +1248,15 @@
1248 1248  
1249 1249  A user can submit a subscription in the registry that defines which events are of interest, and either an email and/or an HTTP address to which a notification of qualifying events will be delivered. The subscription will be identified in the registry by a URN which is returned to the user when the subscription is created. If the user wants to delete the subscription at a later point, the subscription URN is used as identification. Subscriptions have a validity period expressed as a date range (startDate, endDate) and the registry may delete any expired subscriptions, and will notify the subscriber on expiry.
1250 1250  
1251 -When a registry/repository artefact is modified, any subscriptions which are observing the object are activated, and either an email or HTTP POST is instigated to report details of the changes to the user specified in the subscription. This is called a “notification”.
1398 +When a registry/repository artefact is modified, any subscriptions which are observing the object are activated, and either an email or HTTP POST is instigated to report details of the changes to the user specified in the subscription. This is called a
1252 1252  
1253 -=== 7.5.1Subscription Logical Class Diagram ===
1400 +notification”.
1254 1254  
1255 -[[image:1747829554603-150.png]]
1402 + 7.5.1Subscription Logical Class Diagram
1256 1256  
1404 +
1405 +[[image:1747824123028-257.png]]
1406 +
1257 1257  **Figure 19: Logical Class Diagram of the Subscription**
1258 1258  
1259 1259  === 7.5.2 Subscription Information ===
... ... @@ -1260,58 +1260,73 @@
1260 1260  
1261 1261  Regardless of the type of registry/repository events being observed, a subscription always contains:
1262 1262  
1263 -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.
1264 -1. 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.
1265 -1. 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.
1266 -1. A selector which specifies which type of events are of interest. The set of event types is:
1413 +~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.
1267 1267  
1268 -|(% style="width:327px" %)**Event Type**|(% style="width:1545px" %)**Comment**
1269 -|(% style="width:327px" %)STRUCTURAL_REPOSITORY_EVENTS|(% style="width:1545px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1270 -|(% style="width:327px" %)DATA_REGISTRATION_EVENTS|(% style="width:1545px" %)Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
1271 -|(% style="width:327px" %)METADATA_REGISTRATION_EVENTS|(% style="width:1545px" %)Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
1272 -|(% style="width:327px" %)ALL_EVENTS|(% style="width:1545px" %)All events of the specified EventType
1415 +2. 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.
1273 1273  
1417 +3. 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.
1418 +
1419 +4. A selector which specifies which type of events are of interest. The set of event types is:
1420 +
1421 +|**Event Type**|**Comment**
1422 +|STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1423 +|DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
1424 +|METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
1425 +|ALL_EVENTS|All events of the specified EventType
1426 +
1274 1274  === 7.5.3 Wildcard Facility ===
1275 1275  
1276 1276  Subscription notification supports wildcarded identifier components URNs, which are identiiers which have some or all of their component parts replaced by the wildcard character `%`. Identifier components comprise:
1277 1277  
1278 -* agencyID
1279 -* id
1280 -* version
1431 + agencyID
1281 1281  
1433 + id
1434 +
1435 + version
1436 +
1282 1282  Examples of wildcarded identifier components for an identified object type of Codelist are shown below.
1283 1283  
1284 -//AgencyID = %
1439 +AgencyID = %
1440 +
1285 1285  Id = %
1286 -Version = %//
1287 1287  
1443 +Version = %
1444 +
1288 1288  This subscribes to all Codelists of all versions for all agencies.
1289 1289  
1290 -//AgencyID = AGENCY1
1447 +AgencyID = AGENCY1
1448 +
1291 1291  Id = CODELIST1
1292 -Version = %//
1293 1293  
1451 +Version = %
1452 +
1294 1294  This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1295 1295  
1296 -//AGENCY1
1455 +AGENCY1
1456 +
1297 1297  AgencyID = AGENCY1
1458 +
1298 1298  Id = %
1299 -Version = %//
1300 1300  
1461 +Version = %
1462 +
1301 1301  This subscribes to all versions of all Codelist objects maintained by the agency
1302 1302  
1303 -//AGENCY1
1465 +AGENCY1
1466 +
1304 1304  AgencyID = %
1468 +
1305 1305  Id = CODELIST1
1306 -Version = %//
1307 1307  
1471 +Version = %
1472 +
1308 1308  This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1309 1309  
1310 -//AGENCY1//
1475 +AGENCY1
1311 1311  
1312 1312  Note that if the subscription is to the latest version then this can be achieved by the * character
1313 1313  
1314 -//i.e. Version = *//
1479 +i.e. Version = *
1315 1315  
1316 1316  Note that a subscription using the URN mechanism cannot use wildcard characters.
1317 1317  
... ... @@ -1323,15 +1323,16 @@
1323 1323  
1324 1324  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:
1325 1325  
1326 -|(% style="width:405px" %)**Selector**|(% style="width:1467px" %)**Comment**
1327 -|(% style="width:405px" %)DataProvider|(% style="width:1467px" %)Any datasets or metadata sets registered by the specified data provider will activate the notification.
1328 -|(% style="width:405px" %)ProvisionAgreement|(% style="width:1467px" %)Any datasets or metadata sets registered for the provision agreement will activate the notification.
1329 -|(% style="width:405px" %)Dataflow (&Metadataflow)|(% style="width:1467px" %)Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
1330 -|(% style="width:405px" %)DataStructureDefinition & MetadataStructureDefinition|(% style="width:1467px" %)Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will
1331 -|(% style="width:405px" %)**Selector**|(% style="width:1467px" %)**Comment**
1332 -|(% style="width:405px" %) |(% style="width:1467px" %)activate the notification.
1333 -|(% style="width:405px" %)Category|(% style="width:1467px" %)Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category.
1334 1334  
1492 +|**Selector**|**Comment**
1493 +|DataProvider|Any datasets or metadata sets registered by the specified data provider will activate the notification.
1494 +|ProvisionAgreement|Any datasets or metadata sets registered for the provision agreement will activate the notification.
1495 +|Dataflow (&Metadataflow)|Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
1496 +|DataStructureDefinition & MetadataStructureDefinition|Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will
1497 +|**Selector**|**Comment**
1498 +| |activate the notification.
1499 +|Category|Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category.
1500 +
1335 1335  The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration.
1336 1336  
1337 1337  == 7.6 Notification ==
... ... @@ -1338,10 +1338,8 @@
1338 1338  
1339 1339  === 7.6.1 Logical Class Diagram ===
1340 1340  
1341 -[[image:1747829675568-610.png]]
1342 1342  
1343 -(% class="wikigeneratedid" id="HFigure20:LogicalClassDiagramoftheNotification" %)
1344 -**Figure 20: Logical Class Diagram of the Notification**
1508 +==== Figure 20: Logical Class Diagram of the Notification ====
1345 1345  
1346 1346  A notification is an XML document that is sent to a user via email or http POST whenever a subscription is activated. It is an asynchronous one-way message.
1347 1347  
... ... @@ -1361,3 +1361,5 @@
1361 1361  === 7.6.3 Registration Event Component ===
1362 1362  
1363 1363  The notification will contain the Registration.
1528 +
1529 +
1747824504225-229.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -52.8 KB
Content
1747829078194-749.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -40.4 KB
Content
1747829109466-595.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -30.4 KB
Content
1747829139951-378.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -21.1 KB
Content
1747829204737-370.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -55.8 KB
Content
1747829290890-122.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -41.4 KB
Content
1747829477882-750.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -24.6 KB
Content
1747829554603-150.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -99.1 KB
Content
1747829675568-610.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -31.1 KB
Content