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

From version 3.3
edited by Helena
on 2025/05/21 15:27
Change comment: There is no comment for this version
To version 1.1
edited by Helena
on 2025/05/21 13:44
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -192,8 +192,10 @@
192 192  
193 193  In addition to these interfaces the registry must support a mechanism for querying for structural metadata. This is detailed in 5.2.2.
194 194  
195 -All these interactions with the Registry – with the exception of Notify Registry Event – are designed in pairs. The first document – the one which invokes the SDMX-RR interface, is a “Request” document. The message returned by the interface is a “Response” document.
195 +All these interactions with the Registry – with the exception of Notify Registry Event – are designed in pairs. The first document – the one which invokes the SDMX-RR interface, is a “Request” document. The message returned by the interface is a
196 196  
197 +“Response” document.
198 +
197 197  It should be noted that all interactions are assumed to be synchronous, with the exception of Notify Registry Event. This document is sent by the SDMX-RR to all subscribers whenever an even occurs to which any users have subscribed. Thus, it does not conform to the request-response pattern, because it is inherently asynchronous.
198 198  
199 199  == 5.2 Registry Services ==
... ... @@ -288,33 +288,38 @@
288 288  * that a queryable data source exists - this would necessitate the registration service querying the service to determine its existence
289 289  * that a simple data source exists (i.e. a file accessible at a URL)
290 290  * that the correct Data Structure Definition or Metadata Structure Definition is used by the registered data that the components (Dimensions, Attributes, Measures, Identifier Components etc.) are consistent with the Data Structure Definition or Metadata Structure Definition
291 -* that the valid representations of the concepts to which these components correspond conform to the definition in the Data Structure Definition or Metadata Structure Definition
293 +* that the valid representations of the concepts to which these components 382 correspond conform to the definition in the Data Structure Definition or Metadata Structure Definition
292 292  
293 293  3The Registration has an action attribute which takes one of the following values:
294 294  
295 -(% style="margin-left:auto; margin-right:auto" %)
296 -|(% style="width:200px" %)(((
297 -**Action Attribute Value**
298 -)))|(% style="width:1672px" %)**Behaviour**
299 -|(% style="width:200px" %)Append|(% style="width:1672px" %)Add this registration to the registry
300 -|(% style="width:200px" %)Replace|(% style="width:1672px" %)Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request
301 -|(% style="width:200px" %)Delete|(% style="width:1672px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
297 +|(((
298 +**Action**
299 +
300 +**Attribute Value**
301 +)))|**Behaviour**
302 +|Append|Add this registration to the registry
303 +|Replace|Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request
304 +|Delete|Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
305 +
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 -|(% style="width:200px" %)**Boolean Attribute**|(% style="width:1672px" %)**Behaviour if Value is “true”**
304 -|(% style="width:200px" %)indexTimeSeries|(% style="width:1672px" %)A compliant indexing application must index all the time series keys (for a Dataset registration) or metadata target values (for a Metadata Set registration)
305 -|(% style="width:200px" %)indexDataSet|(% style="width:1672px" %)(((
307 +
308 +|**Boolean Attribute**|**Behaviour if Value is “true”**
309 +|indexTimeSeries|A compliant indexing application must index all the time series keys (for a Dataset registration) or metadata target values (for a Metadata Set registration)
310 +|indexDataSet|(((
306 306  A compliant indexing application must index the range of actual (present) values for each dimension of the Dataset (for a Dataset registration) or the range of actual (present) values for each Metadata Attribute which takes an enumerated value.
312 +
307 307  Note that for data this requires much less storage than full key indexing, but this method cannot guarantee that a specific combination of Dimension values (the Key) is actually present in the Dataset
308 308  )))
309 -|(% style="width:200px" %)indexReportingPeriod|(% style="width:1672px" %)A compliant indexing application must index the time period range(s) for which data are present in the Dataset or Metadata Set
315 +|indexReportingPeriod|A compliant indexing application must index the time period range(s) for which data are present in the Dataset or Metadata Set
310 310  
311 311  === 5.2.5 Data and Reference Metadata Discovery ===
312 312  
313 313  The Data and Metadata Discovery Service implements the following Registry Interfaces:
314 314  
315 -* QueryRegistrationRequest
316 -* QueryRegistrationResponse
321 + QueryRegistrationRequest
317 317  
323 + QueryRegistrationResponse
324 +
318 318  === 5.2.6 Subscription and Notification ===
319 319  
320 320  The Subscription and Notification Service implements the following Registry Interfaces:
... ... @@ -338,12 +338,13 @@
338 338  
339 339  The following table defines the behaviour of the SDMX Registry for the various Registry Interface messages.
340 340  
341 -|(% style="width:227px" %)**Interface**|(% style="width:1644px" %)**Behaviour**
342 -|(% style="width:227px" %)All|(% style="width:1644px" %)(((
348 +|**Interface**|**Behaviour**
349 +|All|(((
343 343  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:
344 344  
345 345  * Name – this applies to the Maintainable object and its contained elements, such a Code in a Code list.
346 346  * Description - this applies to the Maintainable object and its contained elements, such a Code in a Code list.
354 +
347 347  * Annotation - this applies to the Maintainable object and its contained elements, such a Code in a Code list.
348 348  * validTo
349 349  * validFrom
... ... @@ -352,22 +352,26 @@
352 352  * uri
353 353  * isExternalReference
354 354  
355 -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.
356 -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 +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.
364 +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 357  
358 -а) Not have the final attribute set to “true”
359 -b) Not be referenced from any other object in the Registry.
366 +1. Not have the final attribute set to “true”
367 +1. Not be referenced from any other object in the Registry.
360 360  
361 -4) The version rules in the SDMX Schema documentation MUST be obeyed.
362 -5) The specific rules for the elements and attributes documented in the SDMX Schema MUST be obeyed.
369 +1. The version rules in the SDMX Schema documentation MUST be obeyed.
370 +
371 +* The specific rules for the elements and attributes documented in the SDMX Schema MUST be obeyed.
363 363  )))
364 -|(% style="width:227px" %)SubmitStructureRequest|(% style="width:1644px" %)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.
365 -|(% style="width:227px" %)SubmitProvisioningRequest|(% style="width:1644px" %)No additional behaviour.
366 -|(% style="width:227px" %)Submit Registration Request|(% style="width:1644px" %)(((
373 +|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.
374 +|SubmitProvisioningRequest|No additional behaviour.
375 +|Submit Registration Request|(((
367 367  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.
377 +
368 368  For a queryable datasource the Registry MAY validate that the source exists and can accept an SDMX-ML data query.
369 369  )))
370 370  
381 +
382 +
371 371  = 6 Identification of SDMX Objects =
372 372  
373 373  == 6.1 Identification, Versioning, and Maintenance ==
... ... @@ -374,6 +374,7 @@
374 374  
375 375  All major classes of the SDMX Information model inherit from one of:
376 376  
389 +
377 377  * **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.
378 378  * **NamableArtefact **- this has all of the features of IdentifiableArtefact plus the ability to have a multi-lingual name and description,
379 379  * **VersionableArtefact **– this has all of the above features plus a version number and a validity period.
... ... @@ -381,8 +381,6 @@
381 381  
382 382  === 6.1.1 Identification, Naming, Versioning, and Maintenance Model ===
383 383  
384 -[[image:1747824504225-229.png]]
385 -
386 386  **Figure 5: Class diagram of fundamental artefacts in the SDMX-IM**
387 387  
388 388  The table below shows the identification and related data attributes to be stored in a registry for objects that are one of:
... ... @@ -393,34 +393,38 @@
393 393  * Versionable
394 394  * Maintainable
395 395  
396 -(% style="width:935.294px" %)
397 -|**Object Type**|(% style="width:244px" %)**Data Attributes**|(% style="width:99px" %)**Status**|**Data type**|(% style="width:389px" %)**Notes**
398 -|Annotable|(% style="width:244px" %)AnnotationTitle|(% style="width:99px" %)C|string|(% style="width:389px" %)
399 -| |(% style="width:244px" %)AnnotationType|(% style="width:99px" %)C|string|(% style="width:389px" %)
400 -| |(% style="width:244px" %)AnnotationURN|(% style="width:99px" %)C|string|(% style="width:389px" %)
401 -| |(% style="width:244px" %)(((
402 -AnnotationText in the form of International String
403 -)))|(% style="width:99px" %)C| |(% style="width:389px" %)This can have languagespecific variants.
404 -|Identifiable|(% style="width:244px" %)all content as for Annotable plus|(% style="width:99px" %) | |(% style="width:389px" %)
405 -| |(% style="width:244px" %)id|(% style="width:99px" %)M|string|(% style="width:389px" %)
406 -| |(% style="width:244px" %)uri|(% style="width:99px" %)C|string|(% style="width:389px" %)
407 -| |(% 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.
408 -|Nameable|(% style="width:244px" %)all content as for Identifiable plus|(% style="width:99px" %) | |(% style="width:389px" %)
409 -| |(% style="width:244px" %)Name in the form of International String|(% style="width:99px" %)M|string|(% style="width:389px" %)This can have languagespecific variants.
410 -| |(% style="width:244px" %)(((
411 -Description in the form of International String
412 -)))|(% style="width:99px" %)C|string|(% style="width:389px" %)This can have languagespecific variants.
413 -|Versionable|(% style="width:244px" %)All content as for Identifiable plus|(% style="width:99px" %) | |(% style="width:389px" %)
414 -| |(% 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
415 -| |(% style="width:244px" %)validFrom|(% style="width:99px" %)C|Date/time|(% style="width:389px" %)
416 -| |(% style="width:244px" %)validTo|(% style="width:99px" %)C|Date/time|(% style="width:389px" %)
417 -|Maintainable|(% style="width:244px" %)All content as for Versionable plus|(% style="width:99px" %) | |(% style="width:389px" %)
418 -| |(% 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.
419 -| |(% 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.
420 -| |(% style="width:244px" %)serviceURL|(% style="width:99px" %)C|string|(% style="width:389px" %)The url of the service that can be queried for this resource
421 -| |(% style="width:244px" %)structureURL|(% style="width:99px" %)C|string|(% style="width:389px" %)The url of the resource.
422 -| |(% style="width:244px" %)(Maintenance) agencyId|(% style="width:99px" %)M|string|(% style="width:389px" %)The object must be linked to a maintenance agency.
407 +|**Object Type**|**Data Attributes**|**Status**|**Data type**|**Notes**
408 +|Annotable|AnnotationTitle|C|string|
409 +| |AnnotationType|C|string|
410 +| |AnnotationURN|C|string|
411 +| |(((
412 +AnnotationText in the form of
423 423  
414 +International String
415 +)))|C| |This can have languagespecific variants.
416 +| | | | |
417 +|Identifiable|all content as for Annotable plus| | |
418 +| |id|M|string|
419 +| |uri|C|string|
420 +| |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.
421 +|Nameable|all content as for Identifiable plus| | |
422 +| |Name in the form of International String|M|string|This can have languagespecific variants.
423 +| |(((
424 +Description in the form of International
425 +
426 +String
427 +)))|C|string|This can have languagespecific variants.
428 +|Versionable|All content as for Identifiable plus| | |
429 +| |version|C|string|This is the version number. If not present the default is 1.0
430 +| |validFrom|C|Date/time|
431 +| |validTo|C|Date/time|
432 +|Maintainable|All content as for Versionable plus| | |
433 +| |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.
434 +| |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.
435 +| |serviceURL|C|string|The url of the service that can be queried for this resource
436 +| |structureURL|C|string|The url of the resource.
437 +| |(Maintenance) agencyId|M|string|The object must be linked to a maintenance agency.
438 +
424 424  **Table 1: Common Attributes of Object Types**
425 425  
426 426  == 6.2 Unique identification of SDMX objects ==
... ... @@ -465,11 +465,11 @@
465 465  
466 466  An example of this is shown in the XML snippet below.
467 467  
468 -[[image:1747824123013-196.jpeg||height="309" width="446"]]
469 469  
470 -(% class="wikigeneratedid" id="HFigure8:ExampleShowingUseofAgencyIdentifiers" %)
471 -**Figure 8: Example Showing Use of Agency Identifiers**
484 +[[image:1747824123013-196.jpeg]]
472 472  
486 +==== Figure 8: Example Showing Use of Agency Identifiers ====
487 +
473 473  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.
474 474  
475 475  === 6.2.2 Universal Resource Name (URN) ===
... ... @@ -486,7 +486,7 @@
486 486  
487 487  The generic structure of the URN is as follows:
488 488  
489 ->SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobject-id(maintainedobject-version).*containerobject-id.object-id
504 +SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobject-id(maintainedobject-version).*containerobject-id.object-id
490 490  
491 491  ~* this can repeat and may not be present (see explanation below)
492 492  
... ... @@ -498,7 +498,7 @@
498 498  
499 499  In the explanation below the actual object that is the target of the URN is called the **//actual object//**.
500 500  
501 -**SDMXPrefix:** urn:sdmx:org.
516 +**SDMXPrefix:** urn:sdmx:org.                                     
502 502  
503 503  **SDMX-IM package name:** sdmx.infomodel.package=
504 504  
... ... @@ -508,8 +508,10 @@
508 508  
509 509  **(maintainable-object-version)** is the version of the maintainable object and is enclosed in round brackets (). It will always be present.
510 510  
511 -**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.
526 +**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
512 512  
528 +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.
529 +
513 513  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.
514 514  
515 515  For example the sequence is agency:DSDid(version).DimensionId and not agency:DSDid(version).DimensionDescriptorId.DimensionId.
... ... @@ -516,57 +516,58 @@
516 516  
517 517  **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.
518 518  
519 -===== __**//Generic Examples of the URN Structure//**__ =====
536 +===== //Generic Examples of the URN Structure// =====
520 520  
521 -__Actual object is a maintainable__
522 522  
523 -> SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version)
539 +Actual object is a maintainable
524 524  
525 -__Actual object is contained in a maintained object with no intermediate containing object__
541 +SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version)
526 526  
527 -> SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).object-id
543 +Actual object is contained in a maintained object with no intermediate containing object
528 528  
529 -__Actual object is contained in a maintained object with an intermediate containing object__
545 +SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).object-id
530 530  
531 -> SDMXPrefix.SDMX-IM package name.classname=agency
547 +Actual object is contained in a maintained object with an intermediate containing object
532 532  
549 +SDMXPrefix.SDMX-IM package name.classname=agency
550 +
533 533  id:maintained-object-id(version).contained-object-id.object-id
534 534  
535 -__Actual object is contained in a maintained object with no intermediate containing object but the object type itself is hierarchical__
553 +Actual object is contained in a maintained object with no intermediate containing object but the object type itself is hierarchical
536 536  
537 537  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
538 538  
539 -> SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).contained-object-id.object-id
557 +SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).contained-object-id.object-id
540 540  
541 -__Actual object is contained in a maintained object with an intermediate containing object and the object type itself is hierarchical__
559 +Actual object is contained in a maintained object with an intermediate containing object and the object type itself is hierarchical
542 542  
543 543  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
544 544  
545 -> SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).contained-object-id. contained-object-id contained-object-id.object-id
563 +SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).contained-object-id. contained-object-id contained-object-id.object-id
546 546  
547 -===== __**//Concrete Examples of the URN Structure//**__ =====
565 +===== //Concrete Examples of the URN Structure// =====
548 548  
549 549  The Data Structure Definition CRED_EXT_DEBT version 1.0 maintained by the top level Agency TFFS would have the URN:
550 550  
551 -> urn:sdmx:org.sdmx.infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(1.0)
569 +urn:sdmx:org.sdmx.infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(1.0)
552 552  
553 553  The URN for a code for Argentina maintained by ISO in the code list CL_3166A2 version 1.0 would be:
554 554  
555 -> urn:sdmx:org.sdmx.infomodel.codelist.Code=ISO:CL_3166A2(1.0).AR
573 +urn:sdmx:org.sdmx.infomodel.codelist.Code=ISO:CL_3166A2(1.0).AR
556 556  
557 557  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:
558 558  
559 -> urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:SUBJE CT_MATTER_DOMAINS(1.0).1.2
577 +urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:SUBJE CT_MATTER_DOMAINS(1.0).1.2
560 560  
561 561  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
562 562  
563 563  CONTACT_DETAILS/CONTACT_NAME would be:
564 564  
565 -> urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataAttribut e=SDMX:CONTACT_METADATA(1.0).CONTACT_REPORT.CONTACT_DETAILS.CO NTACT_NAME
583 +urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataAttribut e=SDMX:CONTACT_METADATA(1.0).CONTACT_REPORT.CONTACT_DETAILS.CO NTACT_NAME
566 566  
567 567  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:
568 568  
569 -> urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=TFFS.ABC:EX
587 +urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=TFFS.ABC:EX
570 570  
571 571  TERNAL_DEBT(1.0)
572 572  
... ... @@ -581,94 +581,112 @@
581 581  
582 582  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.
583 583  
584 -|(% style="width:127px" %)**Package**|(% style="width:1745px" %)(((
585 -**URN Classname (model classname where this is different)**
602 +|**Package**|(((
603 +**URN Classname (model classname**
604 +
605 +**where this is different)**
586 586  )))
587 -|(% style="width:127px" %)base|(% style="width:45px" %)Agency
588 -|(% style="width:127px" %) |(% style="width:45px" %)OrganisationUnitScheme
589 -|(% style="width:127px" %) |(% style="width:45px" %)AgencyScheme
590 -|(% style="width:127px" %) |(% style="width:45px" %)DataProviderScheme
591 -|(% style="width:127px" %) |(% style="width:45px" %)DataConsumerScheme
592 -|(% style="width:127px" %) |(% style="width:45px" %)OrganisationUnit
593 -|(% style="width:127px" %) |(% style="width:45px" %)DataProvider
594 -|(% style="width:127px" %) |(% style="width:45px" %)DataConsumer
595 -|(% style="width:127px" %)datastructure|(% style="width:45px" %)DataStructure (DataStructureDefinition)
596 -|(% style="width:127px" %) |(% style="width:45px" %)AttributeDescriptor
597 -|(% style="width:127px" %) |(% style="width:45px" %)DataAttribute
598 -|(% style="width:127px" %) |(% style="width:45px" %)GroupDimensionDescriptor
599 -|(% style="width:127px" %) |(% style="width:45px" %)DimensionDescriptor
600 -|(% style="width:127px" %) |(% style="width:45px" %)Dimension
601 -|(% style="width:127px" %) |(% style="width:45px" %)MeasureDimension
602 -|(% style="width:127px" %) |(% style="width:45px" %)TimeDimension
603 -|(% style="width:127px" %) |(% style="width:45px" %)MeasureDescriptor
604 -|(% style="width:127px" %) |(% style="width:45px" %)PrimaryMeasure
605 -|(% style="width:127px" %) |(% style="width:45px" %)Dataflow (DataflowDefinition)
606 -|(% style="width:127px" %)metadatastructure|(% style="width:45px" %)MetadataTarget
607 -|(% style="width:127px" %) |(% style="width:45px" %)DimensionDescriptorValueTarget
608 -|(% style="width:127px" %) |(% style="width:45px" %)IdentifiableObjectTarget
609 -|(% style="width:127px" %) |(% style="width:45px" %)ReportPeriodTarget
610 -|(% style="width:127px" %) |(% style="width:45px" %)DataSetTarget
611 -|(% style="width:127px" %) |(% style="width:45px" %)ReportStructure
612 -|(% style="width:127px" %) |(% style="width:45px" %)MetadataAttribute
613 -|(% style="width:127px" %) |(% style="width:45px" %)(((
607 +|base|Agency
608 +| |OrganisationUnitScheme
609 +| |AgencyScheme
610 +| |DataProviderScheme
611 +| |DataConsumerScheme
612 +| |OrganisationUnit
613 +| |DataProvider
614 +| |DataConsumer
615 +| |
616 +|datastructure|DataStructure (DataStructureDefinition)
617 +| |AttributeDescriptor
618 +| |DataAttribute
619 +| |GroupDimensionDescriptor
620 +| |DimensionDescriptor
621 +| |Dimension
622 +| |MeasureDimension
623 +| |TimeDimension
624 +| |MeasureDescriptor
625 +| |PrimaryMeasure
626 +| |Dataflow (DataflowDefinition)
627 +| |
628 +|metadatastructure|MetadataTarget
629 +| |DimensionDescriptorValueTarget
630 +| |IdentifiableObjectTarget
631 +| |ReportPeriodTarget
632 +| |DataSetTarget
633 +| |ReportStructure
634 +| |MetadataAttribute
635 +| |(((
614 614  MetadataStructure
615 615  
616 616  (MetadataStructureDefinition)
617 617  )))
618 -|(% style="width:127px" %) |(% style="width:45px" %)Metadataflow (MetadataflowDefinition)
619 -|(% style="width:127px" %)process|(% style="width:45px" %)Process
620 -|(% style="width:127px" %) |(% style="width:45px" %)ProcessStep
621 -|(% style="width:127px" %) |(% style="width:45px" %)Transition
622 -|(% style="width:127px" %)registry|(% style="width:45px" %)ProvisionAgreement
623 -|(% style="width:127px" %) |(% style="width:45px" %)AttachmentConstraint
624 -|(% style="width:127px" %) |(% style="width:45px" %)ContentConstraint
625 -|(% style="width:127px" %) |(% style="width:45px" %)Subscription
626 -|(% style="width:127px" %)mapping|(% style="width:45px" %)StructureMap
627 -|(% style="width:127px" %) |(% style="width:45px" %)StructureSet
628 -|(% style="width:127px" %) |(% style="width:45px" %)ComponentMap
629 -|(% style="width:127px" %) |(% style="width:1745px" %)ConceptSchemeMap
630 -|(% style="width:127px" %) |(% style="width:1745px" %)OrganisationSchemeMap
631 -|(% style="width:127px" %) |(% style="width:1745px" %)CodelistMap
632 -|(% style="width:127px" %) |(% style="width:1745px" %)CategorySchemeMap
633 -|(% style="width:127px" %) |(% style="width:1745px" %)ReportingTaxonomyMap
634 -|(% style="width:127px" %) |(% style="width:1745px" %)ConceptMap
635 -|(% style="width:127px" %) |(% style="width:1745px" %)OrganisationMap
636 -|(% style="width:127px" %) |(% style="width:1745px" %)CodeMap
637 -|(% style="width:127px" %) |(% style="width:1745px" %)HybridCodelistMap
638 -|(% style="width:127px" %) |(% style="width:1745px" %)CategoryMap
639 -|(% style="width:127px" %) |(% style="width:1745px" %)HybridCodeMap
640 -|(% style="width:127px" %) |(% style="width:1745px" %)ReportingCategoryMap
641 -|(% style="width:127px" %)codelist|(% style="width:1745px" %)Codelist
642 -|(% style="width:127px" %) |(% style="width:1745px" %)HierarchicalCodelist
643 -|(% style="width:127px" %) |(% style="width:1745px" %)Hierarchy
644 -|(% style="width:127px" %) |(% style="width:1745px" %)Hierarchy
645 -|(% style="width:127px" %) |(% style="width:1745px" %)Code
646 -|(% style="width:127px" %) |(% style="width:1745px" %)HierarchicalCode
647 -|(% style="width:127px" %) |(% style="width:1745px" %)Level
648 -|(% style="width:127px" %)categoryscheme|(% style="width:1745px" %)CategoryScheme
649 -|(% style="width:127px" %) |(% style="width:1745px" %)Category
650 -|(% style="width:127px" %) |(% style="width:1745px" %)Categorisation
651 -|(% style="width:127px" %) |(% style="width:1745px" %)ReportingTaxonomy
652 -|(% style="width:127px" %) |(% style="width:1745px" %)ReportingCategory
653 -|(% style="width:127px" %)conceptscheme|(% style="width:1745px" %)ConceptScheme
654 -|(% style="width:127px" %) |(% style="width:1745px" %)Concept
655 -|(% style="width:127px" %)transformation|(% style="width:1745px" %)TransformationScheme
656 -|(% style="width:127px" %) |(% style="width:1745px" %)Transformation
657 -|(% style="width:127px" %) |(% style="width:1745px" %)CustomTypeScheme
658 -|(% style="width:127px" %) |(% style="width:1745px" %)CustomType
659 -|(% style="width:127px" %) |(% style="width:1745px" %)NamePersonalisationScheme
660 -|(% style="width:127px" %) |(% style="width:1745px" %)NamePersonalisation
661 -|(% style="width:127px" %) |(% style="width:1745px" %)VtlCodelistMapping
662 -|(% style="width:127px" %) |(% style="width:1745px" %)VtlConceptMapping
663 -|(% style="width:127px" %) |(% style="width:1745px" %)VtlDataflowMapping
664 -|(% style="width:127px" %) |(% style="width:1745px" %)VtlConceptSchemeMapping
665 -|(% style="width:127px" %) |(% style="width:1745px" %)RulesetScheme
666 -|(% style="width:127px" %) |(% style="width:1745px" %)Ruleset
667 -|(% style="width:127px" %) |(% style="width:1745px" %)UserDefinedOperatorScheme
668 -|(% style="width:127px" %) |(% style="width:1745px" %)UserDefinedOperator
640 +| |Metadataflow (MetadataflowDefinition)
641 +| |
642 +|process|Process
643 +| |ProcessStep
644 +| |Transition
645 +| |
646 +|registry|ProvisionAgreement
647 +| |AttachmentConstraint
648 +| |ContentConstraint
649 +| |Subscription
650 +| |
651 +|mapping|StructureMap
652 +| |StructureSet
653 +| |ComponentMap
654 +|**Package**|(((
655 +**URN Classname (model classname**
669 669  
657 +**where this is different)**
658 +)))
659 +| |ConceptSchemeMap
660 +| |OrganisationSchemeMap
661 +| |CodelistMap
662 +| |CategorySchemeMap
663 +| |ReportingTaxonomyMap
664 +| |ConceptMap
665 +| |OrganisationMap
666 +| |CodeMap
667 +| |HybridCodelistMap
668 +| |CategoryMap
669 +| |HybridCodeMap
670 +| |ReportingCategoryMap
671 +| |
672 +|codelist|Codelist
673 +| |HierarchicalCodelist
674 +| |Hierarchy
675 +| |Hierarchy
676 +| |Code
677 +| |HierarchicalCode
678 +| |Level
679 +| |
680 +|categoryscheme|CategoryScheme
681 +| |Category
682 +| |Categorisation
683 +| |ReportingTaxonomy
684 +| |ReportingCategory
685 +| |
686 +|conceptscheme|ConceptScheme
687 +| |Concept
688 +| |
689 +|transformation|TransformationScheme
690 +| |Transformation
691 +| |CustomTypeScheme
692 +| |CustomType
693 +| |NamePersonalisationScheme
694 +| |NamePersonalisation
695 +| |VtlCodelistMapping
696 +| |VtlConceptMapping
697 +| |VtlDataflowMapping
698 +| |VtlConceptSchemeMapping
699 +| |RulesetScheme
700 +| |Ruleset
701 +| |UserDefinedOperatorScheme
702 +| |UserDefinedOperator
703 +| |
704 +
670 670  **Table 2: SDMX-IM Packages and Contained Classes**
671 671  
707 +
672 672  === 6.2.4 URN Identification components of SDMX objects ===
673 673  
674 674  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.
... ... @@ -677,52 +677,78 @@
677 677  
678 678  Note that for brevity the URN examples omit the prefix. All URNs have the prefix
679 679  
680 -> urn:sdmx.org.sdmx.infomodel.{package}.{classname}=
716 +urn:sdmx.org.sdmx.infomodel.{package}.{classname}=
681 681  
682 -(% style="width:1091.29px" %)
683 -|(% style="width:250px" %)**SDMX Class**|(% style="width:444px" %)**Key attribute(s)**|(% style="width:396px" %)**Example of URN**
684 -|(% 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" %)(((
718 +
719 +|**SDMX Class**|**Key attribute(s)**|**Example of URN**
720 +|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.|(((
685 685  IMF
722 +
723 +
686 686  Sub agency in the IMF AGENCIES
725 +
726 +
687 687  IMF.SubAgency1
688 688  )))
689 -|(% style="width:250px" %)*ConceptScheme|(% style="width:444px" %)conceptSchemeAgencyId:conceptSchemeId(ve rsion)|(% style="width:396px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0)
690 -|(% style="width:250px" %)Concept|(% style="width:444px" %)conceptSchemeAgencyId:
691 -conceptSchemeId(version).conceptId|(% style="width:396px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0).FREQ
692 -|(% style="width:250px" %)*Codelist|(% style="width:444px" %)codeListAgencyId:codeListId(version)|(% style="width:396px" %)SDMX:CL_FREQ(1.0)
693 -|(% style="width:250px" %)Code|(% style="width:444px" %)codeListAgencyId:codelistId(version).codeId|(% style="width:396px" %)SDMX:CL_FREQ(1.0).Q
694 -|(% style="width:250px" %)(((
695 -*Hierarchical Codelist
696 -)))|(% style="width:444px" %)hierachicalCodelistAgencyId: hierarchicalCodelistId(version)|(% style="width:396px" %)(((
697 -UNESCO:CL_EXP_SOURCE(1.0(% style="background-color:transparent" %))
729 +|*ConceptScheme|conceptSchemeAgencyId:conceptSchemeId(ve rsion)|SDMX:CROSS_DOMAIN_CONCEPTS(1.0)
730 +|Concept|(((
731 +conceptSchemeAgencyId:
732 +
733 +conceptSchemeId(version).conceptId
734 +)))|SDMX:CROSS_DOMAIN_CONCEPTS(1.0).FREQ
735 +|*Codelist|codeListAgencyId:codeListId(version)|SDMX:CL_FREQ(1.0)
736 +|Code|codeListAgencyId:codelistId(version).codeId|(((
737 +SDMX:CL_FREQ(1.0).Q
738 +
739 +
698 698  )))
699 -|(% style="width:250px" %)Hierarchy|(% style="width:444px" %)(((
741 +
742 +
743 +
744 +|(((
745 +*Hierarchical
746 +
747 +Codelist
748 +)))|hierachicalCodelistAgencyId: hierarchicalCodelistId(version)|(((
749 +UNESCO:CL_EXP_SOURCE(1.0)
750 +
751 +
752 +)))
753 +|Hierarchy|(((
700 700  hierachicalcodeListAgencyId:
755 +
701 701  hierarchicalcodelistId(version).Hierarchy
702 -)))|(% style="width:396px" %)UNESCO:CL_EXP_SOURCE(1.0).
703 -H-C-GOV
704 -|(% style="width:250px" %)Level|(% style="width:444px" %)(((
757 +)))|UNESCO:CL_EXP_SOURCE(1.0). H-C-GOV
758 +|Level|(((
705 705  hierachicalcodeListAgencyId:
760 +
706 706  hierarchicalcodelistId(version).Hierarchy.Level
707 -)))|(% style="width:396px" %)(((
762 +)))|(((
708 708  ESTAT:HCL_REGION(1.0).H_1.COUNTRY
709 709  
710 710  
711 711  )))
712 -|(% 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
713 -|(% style="width:250px" %)*DataStructure|(% style="width:444px" %)dataStructureDefintitionAgencyId: dataStructureDefintitionId(version)|(% style="width:396px" %)TFFS:EXT_DEBT(1.0)
714 -|(% style="width:250px" %)(((
767 +|HierarchicalCode|hierachicalCodeListAgencyId: hierarchicalcodelistId(version).hierarchy.hierarc hicalCode|UNESCO:CL_EXP_SOURCE(1.0). H-C-GOV.GOV_CODE1
768 +|*DataStructure|dataStructureDefintitionAgencyId: dataStructureDefintitionId(version)|TFFS:EXT_DEBT(1.0)
769 +|(((
715 715  Dimension
771 +
716 716  Descriptor
773 +
717 717  Measure
775 +
718 718  Descriptor
777 +
719 719  Attribute
779 +
720 720  Descriptor
721 -)))|(% style="width:444px" %)(((
781 +)))|(((
722 722  dataStructureDefinitionAgencyId: dataStructureDefinitionId(version).
783 +
723 723  componentListId
785 +
724 724  where the componentListId is the name of the class (there is only one occurrence of each in the Data Structure Definition)
725 -)))|(% style="width:396px" %)(((
787 +)))|(((
726 726  TFFS:EXT_DEBT(1.0).DimensionDescriptor
727 727  
728 728  TFFS:EXT_DEBT(1.0).MeasureDescriptor
... ... @@ -729,132 +729,181 @@
729 729  
730 730  TFFS:EXT_DEBT(1.0).AttributeDescriptor
731 731  )))
732 -|(% style="width:250px" %)(((
794 +|(((
733 733  GroupDimension
796 +
734 734  Descriptor
735 -)))|(% style="width:444px" %)(((
798 +)))|(((
736 736  dataStructureDefinitionAgencyId: dataStructureDefinitionId(version).
800 +
737 737  groupDimensionDescriptorId
738 -)))|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).SIBLING
739 -|(% style="width:250px" %)Dimension|(% style="width:444px" %)(((
802 +)))|TFFS:EXT_DEBT(1.0).SIBLING
803 +|Dimension|(((
740 740  dataStructureDefinitionAgencyId: dataStructureDefinition (version).
805 +
741 741  dimensionId
742 -)))|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).FREQ
743 -|(% style="width:250px" %)TimeDimension|(% style="width:444px" %)(((
807 +)))|TFFS:EXT_DEBT(1.0).FREQ
808 +|TimeDimension|(((
744 744  dataStructureDefinitionAgencyId: dataStructureDefinition (version).
810 +
745 745  timeDimensionId
746 -)))|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).TIME_PERIOD
747 -|(% style="width:250px" %)Measure Dimension|(% style="width:444px" %)dataStructureDefinitionAgencyId: dataStructureDefinition (version).
748 -measureDimensionId|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).STOCK_FLOW
749 -|(% style="width:250px" %)DataAttrribute|(% style="width:444px" %)dataStructureDefinitionAgencyId: dataStructureDefinition (version). dataAttributeId|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).OBS_STATUS
750 -|(% style="width:250px" %)PrimaryMeasure|(% style="width:444px" %)(((
812 +)))|TFFS:EXT_DEBT(1.0).TIME_PERIOD
813 +|Measure Dimension|dataStructureDefinitionAgencyId: dataStructureDefinition (version).|TFFS:EXT_DEBT(1.0).STOCK_FLOW
814 +
815 +
816 +
817 +| |measureDimensionId|
818 +|DataAttrribute|dataStructureDefinitionAgencyId: dataStructureDefinition (version). dataAttributeId|TFFS:EXT_DEBT(1.0).OBS_STATUS
819 +|PrimaryMeasure|(((
751 751  dataStructureDefinitionAgencyId: dataStructureDefinition (version).
821 +
752 752  primaryMeasureId
753 -)))|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).OBS_VALUE
754 -|(% style="width:250px" %)(((
755 -*Category Scheme
756 -)))|(% style="width:444px" %)categorySchemeAgencyId:
757 -categorySchemeId(version)|(% style="width:396px" %)IMF:SDDS(1.0)
758 -|(% style="width:250px" %)Category|(% style="width:444px" %)categorySchemeAgencyId:
759 -categorySchemeId(version).
760 -categoryId.categoryId categoryId.categoryId etc.|(% style="width:396px" %)(((
823 +)))|TFFS:EXT_DEBT(1.0).OBS_VALUE
824 +|(((
825 +*Category
826 +
827 +Scheme
828 +)))|categorySchemeAgencyId: categorySchemeId(version)|IMF:SDDS(1.0)
829 +|Category|categorySchemeAgencyId: categorySchemeId(version). categoryId.categoryId categoryId.categoryId etc.|(((
761 761  IMF:SDDS(1.0):
831 +
762 762  level_1_category.level_2_category …
763 763  )))
764 -|(% style="width:250px" %)(((
765 -*Reporting Taxonomy
766 -)))|(% style="width:444px" %)reportingTaxonomyAgencyId: reportingTaxonomyId(version)|(% style="width:396px" %) IMF:REP_1(1.0)
767 -|(% style="width:250px" %)ReportingCategory|(% style="width:444px" %)reportingTaxonomyAgencyId: reportingTaxonomyId(version) reportingcategoryId.reportingcategoryId|(% style="width:396px" %)(((
834 +|(((
835 +*Reporting
836 +
837 +Taxonomy
838 +)))|reportingTaxonomyAgencyId: reportingTaxonomyId(version)| IMF:REP_1(1.0)
839 +|ReportingCategory|reportingTaxonomyAgencyId: reportingTaxonomyId(version) reportingcategoryId.reportingcategoryId|(((
768 768  IMF:REP_1(1.0):
841 +
769 769  level_1_repcategory.level_2_repcategory …
770 770  )))
771 -|(% style="width:250px" %)*Categorisation|(% style="width:444px" %)categorisationAgencyId: categorisationId(version)|(% style="width:396px" %)IMF:cat001(1.0)
772 -|(% style="width:250px" %)(((
773 -*Organisation Unit Scheme
774 -)))|(% style="width:444px" %)organisationUnitSchemeAgencyId: organisationUnitSchemeId(version)|(% style="width:396px" %)ECB:ORGANISATIONS(1.0)
775 -|(% style="width:250px" %)Organisation Unit|(% style="width:444px" %)organisationUnitSchemeAgencyId: organisationUnitSchemeId(version). organisationUnitId|(% style="width:396px" %)ECB:ORGANISATIONS(1.0).1F
776 -|(% style="width:250px" %)*AgencyScheme|(% style="width:444px" %)agencySchemeAgencyId: agencySchemeId(version)|(% style="width:396px" %)ECB:AGENCIES(1.0)
844 +|*Categorisation|categorisationAgencyId: categorisationId(version)|IMF:cat001(1.0)
845 +|(((
846 +*Organisation
777 777  
778 -|(% style="width:262px" %)Agency|(% style="width:369px" %)agencySchemeAgencyId: agencySchemeId(version). agencyId|(% style="width:1262px" %)ECB:AGENCY(1.0).AA
779 -|(% style="width:262px" %)(((
780 -*DataProvider Scheme
781 -)))|(% style="width:369px" %)dataProviderSchemeAgencyId: dataProviderSchemeId(version)|(% style="width:1262px" %)SDMX:DATA_PROVIDERS(1.0)
782 -|(% style="width:262px" %)DataProvider|(% style="width:369px" %)dataProviderSchemeAgencyId: dataProviderSchemeId(version) dataProviderId|(% style="width:1262px" %)SDMX:DATA_PROVIDERS(1.0).PROVIDER_1
783 -|(% style="width:262px" %)(((
784 -*DataConsumer Scheme
785 -)))|(% style="width:369px" %)dataConsumerSchemeAgencyId: dataConsumerSchemeId(version)|(% style="width:1262px" %)SDMX:DATA_CONSUMERS(1.0)
786 -|(% style="width:262px" %)Data Consumer|(% style="width:369px" %)dataConsumerSchemeAgencyId: dataConsumerSchemeId(version) dataConsumerId|(% style="width:1262px" %)SDMX:DATA_CONSUMERS(1.0).CONSUMER_1
787 -|(% style="width:262px" %)(((
788 -*Metadata Structure
789 -)))|(% style="width:369px" %)MSDAgencyId:MSDId(version)|(% style="width:1262px" %)IMF:SDDS_MSD(1.0)
790 -|(% style="width:262px" %)MetadataTarget|(% style="width:369px" %)(((
848 +Unit Scheme
849 +)))|organisationUnitSchemeAgencyId: organisationUnitSchemeId(version)|ECB:ORGANISATIONS(1.0)
850 +|Organisation Unit|organisationUnitSchemeAgencyId: organisationUnitSchemeId(version). organisationUnitId|ECB:ORGANISATIONS(1.0).1F
851 +|*AgencyScheme|agencySchemeAgencyId: agencySchemeId(version)|ECB:AGENCIES(1.0)
852 +
853 +
854 +
855 +|Agency|agencySchemeAgencyId: agencySchemeId(version). agencyId|ECB:AGENCY(1.0).AA
856 +|(((
857 +*DataProvider
858 +
859 +Scheme
860 +)))|dataProviderSchemeAgencyId: dataProviderSchemeId(version)|SDMX:DATA_PROVIDERS(1.0)
861 +|DataProvider|dataProviderSchemeAgencyId: dataProviderSchemeId(version) dataProviderId|SDMX:DATA_PROVIDERS(1.0).PROVIDER_1
862 +|(((
863 +*DataConsumer
864 +
865 +Scheme
866 +)))|dataConsumerSchemeAgencyId: dataConsumerSchemeId(version)|SDMX:DATA_CONSUMERS(1.0)
867 +|Data Consumer|dataConsumerSchemeAgencyId: dataConsumerSchemeId(version) dataConsumerId|SDMX:DATA_CONSUMERS(1.0).CONSUMER_1
868 +|(((
869 +*Metadata
870 +
871 +Structure
872 +)))|MSDAgencyId:MSDId(version)|IMF:SDDS_MSD(1.0)
873 +|MetadataTarget|(((
791 791  MSDAgencyId:
875 +
792 792  MSDId(version).metadataTargetId
793 -)))|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY
794 -|(% style="width:262px" %)(((
877 +)))|IMF:SDDS_MSD(1.0).AGENCY
878 +|(((
795 795  Dimension
880 +
796 796  DescriptorValues
882 +
797 797  Target
798 -)))|(% style="width:369px" %)(((
884 +)))|(((
799 799  MSDAgencyId: MSDId(version).
886 +
800 800  metadataTargetId.keyDescriptorValueTargetId
801 -)))|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY.KEY
802 -|(% style="width:262px" %)Identifiable Object Target|(% style="width:369px" %)(((
803 -MSDAgencyId: MSDId(version).metadataTargetId.identifiableObjectTargetId
804 -)))|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY.STR-OBJECT
805 -|(% style="width:262px" %)DataSetTarget|(% style="width:369px" %)(((
888 +)))|IMF:SDDS_MSD(1.0).AGENCY.KEY
889 +|Identifiable ObjectTarget|(((
806 806  MSDAgencyId:
807 -MSDId(version).metadataTargetId.dataSetTargetId
808 -)))|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY.D1101
809 -|(% style="width:262px" %)PeportPeriod Target|(% style="width:369px" %)(((
810 -MSDAgencyId: MSDId(version).metadataTargetId.reportPeriodTargetId
811 -)))|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY.REP_PER
812 812  
813 -|(% style="width:251px" %)(((
892 +MSDId(version).metadataTargetId.identifiable
893 +
894 +ObjectTargetId
895 +)))|IMF:SDDS_MSD(1.0).AGENCY.STR-OBJECT
896 +|DataSetTarget|(((
897 +MSDAgencyId:
898 +
899 +MSDId(version).metadataTargetId.dataSet
900 +
901 +TargetId
902 +)))|IMF:SDDS_MSD(1.0).AGENCY.D1101
903 +|PeportPeriod Target|(((
904 +MSDAgencyId:
905 +
906 +MSDId(version).metadataTargetId.reportPeriod
907 +
908 +TargetId
909 +)))|IMF:SDDS_MSD(1.0).AGENCY.REP_PER
910 +
911 +
912 +
913 +|(((
814 814  ReportStructure
815 815  
816 816  
817 -)))|(% style="width:442px" %)(((
818 -MSDAgencyId: MSDId(version).reportStructureId
819 -)))|(% style="width:1178px" %)IMF:SDDS_MSD(1.0).AGENCY_REPORT
820 -|(% style="width:251px" %)(((
917 +)))|(((
918 +MSDAgencyId:
919 +
920 +MSDId(version).reportStructureId
921 +)))|IMF:SDDS_MSD(1.0).AGENCY_REPORT
922 +|(((
821 821  Metadata
822 822  
823 823  Attribute
824 -)))|(% style="width:442px" %)(((
825 -MSDAgencyId: MSDId(version).reportStructureId.metadataattri buteID
826 -)))|(% style="width:1178px" %)IMF:SDDS_MSD(1.0).AGENCY_REPORT.COMPILATION
827 -|(% style="width:251px" %)*Dataflow|(% style="width:442px" %)dataflowAgencyId: dataflowId(version)|(% style="width:1178px" %)TFFS:CRED_EXT_DEBT(1.0)
828 -|(% style="width:251px" %)*Provision Agreement|(% style="width:442px" %)(((
926 +)))|(((
927 +MSDAgencyId:
928 +
929 +MSDId(version).reportStructureId.metadataattri buteID
930 +)))|IMF:SDDS_MSD(1.0).AGENCY_REPORT.COMPILATION
931 +|*Dataflow|dataflowAgencyId: dataflowId(version)|TFFS:CRED_EXT_DEBT(1.0)
932 +|*Provision Agreement|(((
829 829  provisionAgreementAgencyId:provisionAgreem entId(version)
830 -)))|(% style="width:1178px" %)(((
934 +
935 +
936 +)))|(((
831 831  TFFS:CRED_EXT_DEBT_AB(1.0)
938 +
939 +
940 +
832 832  )))
833 -|(% style="width:251px" %)(((
942 +|(((
834 834  *Content
835 835  
836 836  Constraint
837 -)))|(% style="width:442px" %)constraintAgencyId:ContentConstraintId(versio n)|(% style="width:1178px" %)TFFS:CREDITOR_DATA_CONTENT(1.0)
838 -|(% style="width:251px" %)(((
946 +)))|constraintAgencyId:ContentConstraintId(versio n)|TFFS:CREDITOR_DATA_CONTENT(1.0)
947 +|(((
839 839  *Attachment
840 840  
841 841  Constraint
842 -)))|(% style="width:442px" %)(((
951 +)))|(((
843 843  constraintAgencyId:
844 844  
845 845  attachmentConstraintId(version)
846 -)))|(% style="width:1178px" %)TFFS:CREDITOR_DATA_ATTACHMENT_CONSTRAINT_ONE(1.0)
847 -|(% style="width:251px" %)*Metadataflow|(% style="width:442px" %)metadataflowAgencyId: metadataflowId(version)|(% style="width:1178px" %)IMF:SDDS_FLOW(1.0)
848 -|(% style="width:251px" %)*StructureSet|(% style="width:442px" %)structureSetAgencyId: structureSetId(version)|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0)
849 -|(% style="width:251px" %)StructureMap|(% style="width:442px" %)structureSetAgencyId: structureSetId(version). structureMapId|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2
850 -|(% style="width:251px" %)Component Map|(% style="width:442px" %)(((
955 +)))|TFFS:CREDITOR_DATA_ATTACHMENT_CONSTRAINT_ONE(1.0)
956 +|*Metadataflow|metadataflowAgencyId: metadataflowId(version)|IMF:SDDS_FLOW(1.0)
957 +|*StructureSet|structureSetAgencyId: structureSetId(version)|SDMX:BOP_STRUCTURES(1.0)
958 +|StructureMap|structureSetAgencyId: structureSetId(version). structureMapId|SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2
959 +|Component Map|(((
851 851  structureSetAgencyId: structureSetId(version).
852 852  
853 853  structureMapId. componentMapId
854 -)))|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2. REFAREA_REPCOUNTRY
855 -|(% style="width:251px" %)CodelistMap|(% style="width:442px" %)structureSetAgencyId: structureSetId(version). codelistMapId|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0).CLREFAREA_CLREPCOUNTRY
856 -|(% style="width:251px" %)CodeMap|(% style="width:442px" %)structureSetAgencyId: structureSetId(version).|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0).CLREFAREA_CLREPCOUNTRY. DE_GER
963 +)))|SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2. REFAREA_REPCOUNTRY
964 +|CodelistMap|structureSetAgencyId: structureSetId(version). codelistMapId|SDMX:BOP_STRUCTURES(1.0).CLREFAREA_CLREPCOUNTRY
965 +|CodeMap|structureSetAgencyId: structureSetId(version).|SDMX:BOP_STRUCTURES(1.0).CLREFAREA_CLREPCOUNTRY. DE_GER
857 857  
967 +
968 +
858 858  | |(((
859 859  codeListMapId.
860 860  
... ... @@ -962,6 +962,7 @@
962 962  
963 963  7**Table 3: Table of identification components for SDMX Identifiable Artefacts**
964 964  
1076 +
965 965  = 7 Implementation Notes =
966 966  
967 967  == 7.1 Structural Definition Metadata ==
... ... @@ -982,72 +982,109 @@
982 982  
983 983  The following table lists the Maintainable Artefacts.
984 984  
985 -(% style="width:640.294px" %)
986 -|(% colspan="2" rowspan="1" style="width:186px" %)**Maintainable Artefacts**|(% style="width:206px" %)**Content**
987 -|(% style="width:171px" %)**Abstract Class**|(% style="width:232px" %)**Concrete Class**|(% style="width:206px" %)
988 -|(% style="width:171px" %)Item Scheme|(% style="width:232px" %)Codelist|(% style="width:206px" %)Code
989 -|(% style="width:171px" %) |(% style="width:232px" %)Concept Scheme|(% style="width:206px" %)Concept
990 -|(% style="width:171px" %) |(% style="width:232px" %)Category Scheme|(% style="width:206px" %)Category
991 -|(% style="width:171px" %) |(% style="width:232px" %)Organisation Unit Scheme|(% style="width:206px" %)Organisation Unit
992 -|(% style="width:171px" %) |(% style="width:232px" %)Agency Scheme|(% style="width:206px" %)Agency
993 -|(% style="width:171px" %) |(% style="width:232px" %)Data Provider Scheme|(% style="width:206px" %)Data Provider
994 -|(% style="width:171px" %) |(% style="width:232px" %)Data Consumer Scheme|(% style="width:206px" %)Data Consumer
995 -|(% style="width:171px" %) |(% style="width:232px" %)Reporting Taxonomy|(% style="width:206px" %)Reporting Category
996 -|(% style="width:171px" %) |(% style="width:232px" %)Transformation Scheme|(% style="width:206px" %)Transformation
997 -|(% style="width:171px" %) |(% style="width:232px" %)Custom Type Scheme|(% style="width:206px" %)Custom Type
998 -|(% style="width:171px" %) |(% style="width:232px" %)Name Personalisation Scheme|(% style="width:206px" %)Name Personalisation
999 -|(% style="width:171px" %) |(% style="width:232px" %)Vtl Mapping Scheme|(% style="width:206px" %)Vtl Codelist Mapping
1000 -|(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)Vtl Dataflow Mapping
1001 -|(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)Vtl Concept Scheme Mapping
1002 -|(% style="width:171px" %) |(% style="width:232px" %)Ruleset Scheme|(% style="width:206px" %)Ruleset
1003 -|(% style="width:171px" %) |(% style="width:232px" %)User Defined Operator Scheme|(% style="width:206px" %)User Defined Operator
1004 -|(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)User Defined Operator
1005 -|(% style="width:171px" %)Structure|(% style="width:232px" %)Data Structure Definition|(% style="width:206px" %)(((
1097 +|(% colspan="4" %)**Maintainable Artefacts**|(% colspan="2" %)**Content**|
1098 +|(% colspan="2" %)**Abstract Class**|(% colspan="2" %)**Concrete Class**|(% colspan="2" %) |
1099 +|(% colspan="2" %)Item Scheme|(% colspan="2" %)Codelist|(% colspan="2" %)Code|
1100 +|(% colspan="2" %) |(% colspan="2" %)Concept Scheme|(% colspan="2" %)Concept|
1101 +|(% colspan="2" %) |(% colspan="2" %)Category Scheme|(% colspan="2" %)Category|
1102 +|(% colspan="2" %) |(% colspan="2" %)Organisation Unit Scheme|(% colspan="2" %)Organisation Unit|
1103 +|(% colspan="2" %) |(% colspan="2" %)Agency Scheme|(% colspan="2" %)Agency|
1104 +|(% colspan="2" %) |(% colspan="2" %)Data Provider Scheme|(% colspan="2" %)Data Provider|
1105 +|(% colspan="2" %) |(% colspan="2" %)Data Consumer Scheme|(% colspan="2" %)Data Consumer|
1106 +|(% colspan="2" %) |(% colspan="2" %)Reporting Taxonomy|(% colspan="2" %)Reporting Category|
1107 +|(% colspan="2" %) |(% colspan="2" %)Transformation Scheme|(% colspan="2" %)Transformation|
1108 +|(% colspan="2" %) |(% colspan="2" %)Custom Type Scheme|(% colspan="2" %)Custom Type|
1109 +| |(% colspan="4" %)**Maintainable Artefacts**|(% colspan="2" %)**Content**
1110 +| |(% colspan="2" %)**Abstract Class**|(% colspan="2" %)**Concrete Class**|(% colspan="2" %)
1111 +| |(% colspan="2" %) |(% colspan="2" %)Name Personalisation Scheme|(% colspan="2" %)Name Personalisation
1112 +| |(% colspan="2" %) |(% colspan="2" %)Vtl Mapping Scheme|(% colspan="2" %)Vtl Codelist Mapping
1113 +| |(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)Vtl Concept Mapping
1114 +| |(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)Vtl Dataflow Mapping
1115 +| |(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)(((
1116 +Vtl Concept Scheme
1117 +
1118 +Mapping
1119 +)))
1120 +| |(% colspan="2" %) |(% colspan="2" %)Ruleset Scheme|(% colspan="2" %)Ruleset
1121 +| |(% colspan="2" %) |(% colspan="2" %)User Defined Operator Scheme|(% colspan="2" %)User Defined Operator
1122 +| |(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
1123 +| |(% colspan="2" %)Structure|(% colspan="2" %)Data Structure Definition|(% colspan="2" %)(((
1006 1006  Dimension Descriptor
1125 +
1007 1007  Group Dimension
1127 +
1008 1008  Descriptor
1129 +
1009 1009  Dimension
1131 +
1010 1010  Measure Dimension
1133 +
1011 1011  Time Dimension
1135 +
1012 1012  Attribute Descriptor
1137 +
1013 1013  Data Attribute
1139 +
1014 1014  Measure Descriptor
1141 +
1015 1015  Primary Measure
1016 1016  )))
1017 -|(% style="width:171px" %) |(% style="width:232px" %)Metadata Structure Definition|(% style="width:206px" %)(((
1018 -Metadata Target, Dimension Descriptor
1144 +| |(% colspan="2" %) |(% colspan="2" %)Metadata Structure Definition|(% colspan="2" %)(((
1145 +Metadata Target,
1146 +
1147 +Dimension Descriptor
1148 +
1019 1019  Values Target Identifiable
1150 +
1020 1020  Object Target
1152 +
1021 1021  Report Period Target
1154 +
1022 1022  Data SetTarget
1156 +
1023 1023  Report Structure
1158 +
1024 1024  Metadata Attribute
1025 1025  )))
1026 -|(% style="width:171px" %)Structure Usage|(% style="width:232px" %)Dataflow Definition|(% style="width:206px" %)
1027 -|(% style="width:171px" %) |(% style="width:232px" %)Metadataflow Definition|(% style="width:206px" %)
1028 -|(% style="width:171px" %)None|(% style="width:232px" %)Process|(% style="width:206px" %)Process Step
1029 -|(% style="width:171px" %)None|(% style="width:232px" %)Structure Set|(% style="width:206px" %)(((
1161 +| |(% colspan="2" %)Structure Usage|(% colspan="2" %)Dataflow Definition|(% colspan="2" %)
1162 +| |(% colspan="2" %) |(% colspan="2" %)Metadataflow Definition|(% colspan="2" %)
1163 +| |(% colspan="2" %)None|(% colspan="2" %)Process|(% colspan="2" %)Process Step
1164 +| |(% colspan="2" %)None|(% colspan="2" %)Structure Set|(% colspan="2" %)(((
1030 1030  Component Map
1166 +
1031 1031  Concept Scheme Map
1168 +
1032 1032  Codelist Map
1170 +
1033 1033  Category Scheme Map
1172 +
1034 1034  Reporting Taxonomy Map
1174 +
1035 1035  Organisation Scheme Map
1176 +
1036 1036  Concept Map
1178 +
1037 1037  Code Map
1180 +
1038 1038  Category Map
1182 +
1039 1039  Organisation Map
1184 +
1040 1040  Reporting Category Map
1186 +
1041 1041  Hybrid Codelist Map
1188 +
1042 1042  Hybrid Code Map
1043 1043  )))
1044 -|(% style="width:171px" %)None|(% style="width:232px" %)Provision Agreement|(% style="width:206px" %)
1045 -|(% style="width:171px" %)None|(% style="width:232px" %)Hierarchical Codelist|(% style="width:206px" %)(((
1191 +| |(% colspan="2" %)None|(% colspan="2" %)Provision Agreement|(% colspan="2" %)
1192 +| |(% colspan="2" %)None|(% colspan="2" %)Hierarchical Codelist|(% colspan="2" %)(((
1046 1046  Hierarchy
1194 +
1047 1047  Hierarchical Code
1048 1048  )))
1197 +| | | | | | |
1049 1049  
1050 -**able 4: Table of Maintainable Artefacts for Structural Definition Metadata**
1199 +**Table 4: Table of Maintainable Artefacts for Structural Definition Metadata**
1051 1051  
1052 1052  === 7.1.2 Item Scheme, Structure ===
1053 1053  
... ... @@ -1054,7 +1054,10 @@
1054 1054  The artefacts included in the structural definitions are:
1055 1055  
1056 1056  * All types of Item Scheme (Codelist, Concept Scheme, Category Scheme, Organisation Scheme - Agency Scheme, Data Provider Scheme, Data Consumer Scheme, Organisation Unit Scheme)
1057 -* All types of Structure (Data Structure Definition, Metadata Structure Definition)
1206 +* All types of Structure (Data Structure Definition, Metadata Structure
1207 +
1208 +Definition)
1209 +
1058 1058  * All types of Structure Usage (Dataflow Definition, Metadataflow Definition)
1059 1059  
1060 1060  === 7.1.3 Structure Usage ===
... ... @@ -1073,8 +1073,6 @@
1073 1073  
1074 1074  ==== 7.1.3.3 Structure Usage Model ====
1075 1075  
1076 -[[image:1747829078194-749.png]]
1077 -
1078 1078  **Figure 10: SDMX-IM of links from Structure Usage to Category**
1079 1079  
1080 1080  In addition to the maintenance of the Dataflow Definition and the Metadataflow Definition the following links must be maintained in the registry:
... ... @@ -1101,10 +1101,10 @@
1101 1101  
1102 1102  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.
1103 1103  
1104 -[[image:1747829109466-595.png]]
1105 1105  
1106 1106  **Figure 11: SDMX-IM of the Data Provider**
1107 1107  
1257 +
1108 1108  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
1109 1109  
1110 1110  [[image:1747824123019-181.jpeg]]
... ... @@ -1113,10 +1113,8 @@
1113 1113  
1114 1114  The diagram below is a logical representation of the data required in order to maintain Provision Agreements.
1115 1115  
1116 -[[image:1747829139951-378.png]]
1117 1117  
1118 -(% class="wikigeneratedid" id="HFigure13:LogicalclassdiagramoftheinformationcontainedintheProvisionAgreement" %)
1119 -**Figure 13: Logical class diagram of the information contained in the Provision Agreement**
1267 +==== Figure 13: Logical class diagram of the information contained in the Provision Agreement ====
1120 1120  
1121 1121  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.
1122 1122  
... ... @@ -1144,12 +1144,13 @@
1144 1144  
1145 1145  === 7.3.3 Data and Metadata Constraints: Model ===
1146 1146  
1147 -[[image:1747829204737-370.png]]
1148 1148  
1149 -**Figure 15: Logical class diagram showing inheritance between and reference to constrainable artifacts**
1150 1150  
1151 -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.
1297 +==== Figure 15: Logical class diagram showing inheritance between and reference to constrainable artifacts ====
1152 1152  
1299 +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.
1300 +
1301 +
1153 1153  The content of the Constraint can be found in the SDMX Information Model document.
1154 1154  
1155 1155  == 7.4 Data and Metadata Registration ==
... ... @@ -1170,7 +1170,7 @@
1170 1170  
1171 1171  [[image:1747824123025-411.jpeg]]
1172 1172  
1173 -**Figure 16: Schematic of the Objects Concerned with Registration**
1322 + **Figure 16: Schematic of the Objects Concerned with Registration**
1174 1174  
1175 1175  ==== 7.4.2.2 Registration Request Model ====
1176 1176  
... ... @@ -1184,14 +1184,11 @@
1184 1184  
1185 1185  The Registration has an action attribute which takes one of the following values:
1186 1186  
1187 -(% style="width:970.294px" %)
1188 -|(% style="width:212px" %)**Action Attribute Value**|(% style="width:756px" %)**Behaviour**
1189 -|(% style="width:212px" %)Append|(% style="width:756px" %)Add this Registration to the registry
1190 -|(% style="width:212px" %)Replace|(% style="width:756px" %)Replace the existing Registration with identified by the id in the Registration of the Submit Registration Request
1191 -|(% style="width:212px" %)Delete|(% style="width:756px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
1336 +|**Action Attribute Value**|**Behaviour**
1337 +|Append|Add this Registration to the registry
1338 +|Replace|Replace the existing Registration with identified by the id in the Registration of the Submit Registration Request
1339 +|Delete|Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
1192 1192  
1193 -[[image:1747829290890-122.png]]
1194 -
1195 1195  **Figure 17: Logical Class Diagram of Registration of Data and Metadata**
1196 1196  
1197 1197  The Query Datasource is an abstract class that represents a data source which can understand an SDMX-ML query (SOAPDatasource) or RESTful query
... ... @@ -1206,19 +1206,25 @@
1206 1206  
1207 1207  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.
1208 1208  
1209 -|(% style="width:185px" %)**Indexing Required**|(% style="width:1686px" %)**Registration Process Activity**
1210 -|(% style="width:185px" %)indexTimeSeries|(% style="width:1686px" %)Extract all the series keys and create a KeySet(s) Constraint.
1211 -|(% style="width:185px" %)indexDataSet|(% style="width:1686px" %)(((
1212 -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.
1355 +|**Indexing Required**|**Registration Process Activity**
1356 +|indexTimeSeries|Extract all the series keys and create a KeySet(s) Constraint.
1357 +|indexDataSet|(((
1358 +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
1359 +
1360 +Regions containing Member Selections of Dimension Components of the Constraints model in the SDMX-IM, and the associated Selection Value.
1213 1213  )))
1214 -|(% style="width:185px" %)indexReportingPeriod|(% style="width:1686px" %)(((
1362 +|indexReportingPeriod|(((
1215 1215  This applies only to a registered dataset.
1364 +
1216 1216  Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint.
1217 1217  )))
1218 -|(% style="width:185px" %)indexAttributes|(% style="width:1686px" %)(((
1367 +|indexAttributes|(((
1219 1219  **Data Set**
1369 +
1220 1220  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
1371 +
1221 1221  **Metadata Set**
1373 +
1222 1222  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.
1223 1223  )))
1224 1224  
... ... @@ -1228,13 +1228,14 @@
1228 1228  
1229 1229  === 7.4.3 Registration Response ===
1230 1230  
1231 -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”.
1383 +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
1232 1232  
1385 +“Success”, “Warning” or “Failure”.
1386 +
1233 1233  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.
1234 1234  
1235 1235  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:
1236 1236  
1237 -[[image:1747829477882-750.png]]
1238 1238  
1239 1239  **Figure 18: Logical class diagram showing the registration response**
1240 1240  
... ... @@ -1244,12 +1244,15 @@
1244 1244  
1245 1245  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.
1246 1246  
1247 -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”.
1400 +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
1248 1248  
1249 -=== 7.5.1Subscription Logical Class Diagram ===
1402 +notification”.
1250 1250  
1251 -[[image:1747829554603-150.png]]
1404 + 7.5.1Subscription Logical Class Diagram
1252 1252  
1406 +
1407 +[[image:1747824123028-257.png]]
1408 +
1253 1253  **Figure 19: Logical Class Diagram of the Subscription**
1254 1254  
1255 1255  === 7.5.2 Subscription Information ===
... ... @@ -1256,58 +1256,73 @@
1256 1256  
1257 1257  Regardless of the type of registry/repository events being observed, a subscription always contains:
1258 1258  
1259 -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.
1260 -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.
1261 -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.
1262 -1. A selector which specifies which type of events are of interest. The set of event types is:
1415 +~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.
1263 1263  
1264 -|(% style="width:327px" %)**Event Type**|(% style="width:1545px" %)**Comment**
1265 -|(% style="width:327px" %)STRUCTURAL_REPOSITORY_EVENTS|(% style="width:1545px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1266 -|(% 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.
1267 -|(% 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.
1268 -|(% style="width:327px" %)ALL_EVENTS|(% style="width:1545px" %)All events of the specified EventType
1417 +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.
1269 1269  
1419 +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.
1420 +
1421 +4. A selector which specifies which type of events are of interest. The set of event types is:
1422 +
1423 +|**Event Type**|**Comment**
1424 +|STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1425 +|DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
1426 +|METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
1427 +|ALL_EVENTS|All events of the specified EventType
1428 +
1270 1270  === 7.5.3 Wildcard Facility ===
1271 1271  
1272 1272  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:
1273 1273  
1274 -* agencyID
1275 -* id
1276 -* version
1433 + agencyID
1277 1277  
1435 + id
1436 +
1437 + version
1438 +
1278 1278  Examples of wildcarded identifier components for an identified object type of Codelist are shown below.
1279 1279  
1280 -//AgencyID = %
1441 +AgencyID = %
1442 +
1281 1281  Id = %
1282 -Version = %//
1283 1283  
1445 +Version = %
1446 +
1284 1284  This subscribes to all Codelists of all versions for all agencies.
1285 1285  
1286 -//AgencyID = AGENCY1
1449 +AgencyID = AGENCY1
1450 +
1287 1287  Id = CODELIST1
1288 -Version = %//
1289 1289  
1453 +Version = %
1454 +
1290 1290  This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1291 1291  
1292 -//AGENCY1
1457 +AGENCY1
1458 +
1293 1293  AgencyID = AGENCY1
1460 +
1294 1294  Id = %
1295 -Version = %//
1296 1296  
1463 +Version = %
1464 +
1297 1297  This subscribes to all versions of all Codelist objects maintained by the agency
1298 1298  
1299 -//AGENCY1
1467 +AGENCY1
1468 +
1300 1300  AgencyID = %
1470 +
1301 1301  Id = CODELIST1
1302 -Version = %//
1303 1303  
1473 +Version = %
1474 +
1304 1304  This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1305 1305  
1306 -//AGENCY1//
1477 +AGENCY1
1307 1307  
1308 1308  Note that if the subscription is to the latest version then this can be achieved by the * character
1309 1309  
1310 -//i.e. Version = *//
1481 +i.e. Version = *
1311 1311  
1312 1312  Note that a subscription using the URN mechanism cannot use wildcard characters.
1313 1313  
... ... @@ -1319,15 +1319,16 @@
1319 1319  
1320 1320  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:
1321 1321  
1322 -|(% style="width:405px" %)**Selector**|(% style="width:1467px" %)**Comment**
1323 -|(% style="width:405px" %)DataProvider|(% style="width:1467px" %)Any datasets or metadata sets registered by the specified data provider will activate the notification.
1324 -|(% style="width:405px" %)ProvisionAgreement|(% style="width:1467px" %)Any datasets or metadata sets registered for the provision agreement will activate the notification.
1325 -|(% style="width:405px" %)Dataflow (&Metadataflow)|(% style="width:1467px" %)Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
1326 -|(% 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
1327 -|(% style="width:405px" %)**Selector**|(% style="width:1467px" %)**Comment**
1328 -|(% style="width:405px" %) |(% style="width:1467px" %)activate the notification.
1329 -|(% 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.
1330 1330  
1494 +|**Selector**|**Comment**
1495 +|DataProvider|Any datasets or metadata sets registered by the specified data provider will activate the notification.
1496 +|ProvisionAgreement|Any datasets or metadata sets registered for the provision agreement will activate the notification.
1497 +|Dataflow (&Metadataflow)|Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
1498 +|DataStructureDefinition & MetadataStructureDefinition|Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will
1499 +|**Selector**|**Comment**
1500 +| |activate the notification.
1501 +|Category|Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category.
1502 +
1331 1331  The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration.
1332 1332  
1333 1333  == 7.6 Notification ==
... ... @@ -1334,10 +1334,8 @@
1334 1334  
1335 1335  === 7.6.1 Logical Class Diagram ===
1336 1336  
1337 -[[image:1747829675568-610.png]]
1338 1338  
1339 -(% class="wikigeneratedid" id="HFigure20:LogicalClassDiagramoftheNotification" %)
1340 -**Figure 20: Logical Class Diagram of the Notification**
1510 +==== Figure 20: Logical Class Diagram of the Notification ====
1341 1341  
1342 1342  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.
1343 1343  
... ... @@ -1357,3 +1357,5 @@
1357 1357  === 7.6.3 Registration Event Component ===
1358 1358  
1359 1359  The notification will contain the Registration.
1530 +
1531 +
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