Last modified by Helena on 2025/09/10 11:19
Summary
-
Page properties (1 modified, 0 added, 0 removed)
-
Attachments (0 modified, 0 added, 8 removed)
Details
- Page properties
-
- Content
-
... ... @@ -4,11 +4,10 @@ 4 4 5 5 **Revision History** 6 6 7 -(% style="width:833.294px" %) 8 -|(% style="width:122px" %)**Revision**|(% style="width:126px" %)**Date**|(% style="width:581px" %)**Contents** 9 -|(% style="width:122px" %) |(% style="width:126px" %)April 2011|(% style="width:581px" %)Initial release 10 -|(% style="width:122px" %)1.0|(% style="width:126px" %)July 2011|(% style="width:581px" %)Rectification of problems of the specifications dated April 2011 11 -|(% style="width:122px" %)2.0|(% style="width:126px" %)July 2020|(% style="width:581px" %)Addition of VTL (Validation and Transformation Language) package, maintainable artefacts, nameable artefacts to 5.2.3, 6.2.2, 6.2.3, 6.2.4, 7.1.1 7 +|**Revision**|**Date**|**Contents** 8 +| |April 2011|Initial release 9 +|1.0|July 2011|Rectification of problems of the specifications dated April 2011 10 +|2.0|July 2020|Addition of VTL (Validation and Transformation Language) package, maintainable artefacts, nameable artefacts to 5.2.3, 6.2.2, 6.2.3, 6.2.4, 7.1.1 12 12 13 13 **Corrigendum** 14 14 ... ... @@ -289,22 +289,27 @@ 289 289 * that a queryable data source exists - this would necessitate the registration service querying the service to determine its existence 290 290 * that a simple data source exists (i.e. a file accessible at a URL) 291 291 * 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 292 -* 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 291 +* 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 293 293 294 -The Registration has an action attribute which takes one of the following values: 293 +3The Registration has an action attribute which takes one of the following values: 295 295 296 -|(% style="width:219px" %)**Action Attribute Value**|(% style="width:1652px" %)**Behaviour** 297 -|(% style="width:219px" %)Append|(% style="width:1652px" %)Add this registration to the registry 298 -|(% style="width:219px" %)Replace|(% style="width:1652px" %)Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request 299 -|(% style="width:219px" %)Delete|(% style="width:1652px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request 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 300 300 301 301 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: 302 302 303 -|(% style="width:228px" %)**Boolean Attribute**|(% style="width:1644px" %)**Behaviour if Value is “true”** 304 -|(% style="width:228px" %)indexTimeSeries|(% style="width:1644px" %)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:228px" %)indexDataSet|(% style="width:1644px" %)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. 304 +|**Boolean Attribute**|**Behaviour if Value is “true”** 305 +|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) 306 +|indexDataSet|((( 307 +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. 308 + 306 306 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 307 -|(% style="width:228px" %)indexReportingPeriod|(% style="width:1644px" %)A compliant indexing application must index the time period range(s) for which data are present in the Dataset or Metadata Set 310 +))) 311 +|indexReportingPeriod|A compliant indexing application must index the time period range(s) for which data are present in the Dataset or Metadata Set 308 308 309 309 === 5.2.5 Data and Reference Metadata Discovery === 310 310 ... ... @@ -326,7 +326,7 @@ 326 326 Subscription management involves a user submitting a subscription request which contains: 327 327 328 328 * a query or constraint expression in terms of a filter which defines the events for which the user is interested (e.g. new data for a specific dataflow, or for a domain category, or changes to a Data Structure Definition). 329 -* a list of URIs or end-points to which an XML notification message can be sent. Supported end-point types will be email (mailto :) and HTTP POST (a normal http:~/~/ address)333 +* a list of URIs or end-points to which an XML notification message can be sent. Supported end-point types will be email (mailto~:) and HTTP POST (a normal http:~/~/ address) 330 330 * request for a list of submitted subscriptions 331 331 * deletion of a subscription 332 332 ... ... @@ -336,8 +336,8 @@ 336 336 337 337 The following table defines the behaviour of the SDMX Registry for the various Registry Interface messages. 338 338 339 -|(% style="width:2 27px" %)**Interface**|(% style="width:1644px" %)**Behaviour**340 -|(% style="width:2 27px" %)All|(% style="width:1644px" %)(((343 +|(% style="width:244px" %)**Interface**|**Behaviour** 344 +|(% style="width:244px" %)All|((( 341 341 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: 342 342 343 343 * Name – this applies to the Maintainable object and its contained elements, such a Code in a Code list. ... ... @@ -351,6 +351,7 @@ 351 351 * isExternalReference 352 352 353 353 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. 358 + 354 354 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: 355 355 356 356 а) Not have the final attribute set to “true” ... ... @@ -357,11 +357,12 @@ 357 357 b) Not be referenced from any other object in the Registry. 358 358 359 359 4) The version rules in the SDMX Schema documentation MUST be obeyed. 365 + 360 360 5) The specific rules for the elements and attributes documented in the SDMX Schema MUST be obeyed. 361 361 ))) 362 -|(% style="width:2 27px" %)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.363 -|(% style="width:2 27px" %)SubmitProvisioningRequest|(% style="width:1644px" %)No additional behaviour.364 -|(% style="width:2 27px" %)Submit Registration Request|(% style="width:1644px" %)(((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|((( 365 365 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. 366 366 For a queryable datasource the Registry MAY validate that the source exists and can accept an SDMX-ML data query. 367 367 ))) ... ... @@ -448,8 +448,7 @@ 448 448 449 449 [[image:1747824123012-527.jpeg]] 450 450 451 -* 452 -** Figure 7: Example of Hierarchic Structure of Agencies 457 +==== Figure 7: Example of Hierarchic Structure of Agencies ==== 453 453 454 454 The following organizations maintain an Agency Scheme. 455 455 ... ... @@ -466,6 +466,7 @@ 466 466 467 467 [[image:1747824123013-196.jpeg||height="309" width="446"]] 468 468 474 +(% class="wikigeneratedid" id="HFigure8:ExampleShowingUseofAgencyIdentifiers" %) 469 469 **Figure 8: Example Showing Use of Agency Identifiers** 470 470 471 471 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. ... ... @@ -484,7 +484,7 @@ 484 484 485 485 The generic structure of the URN is as follows: 486 486 487 - >SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobject-id(maintainedobject-version).*containerobject-id.object-id493 +SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobject-id(maintainedobject-version).*containerobject-id.object-id 488 488 489 489 ~* this can repeat and may not be present (see explanation below) 490 490 ... ... @@ -496,7 +496,7 @@ 496 496 497 497 In the explanation below the actual object that is the target of the URN is called the **//actual object//**. 498 498 499 -**SDMXPrefix:** urn:sdmx:org. 505 +**SDMXPrefix:** urn:sdmx:org. 500 500 501 501 **SDMX-IM package name:** sdmx.infomodel.package= 502 502 ... ... @@ -518,15 +518,15 @@ 518 518 519 519 __Actual object is a maintainable__ 520 520 521 - >SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version)527 +SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version) 522 522 523 523 __Actual object is contained in a maintained object with no intermediate containing object__ 524 524 525 - >SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).object-id531 +SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).object-id 526 526 527 527 __Actual object is contained in a maintained object with an intermediate containing object__ 528 528 529 - >SDMXPrefix.SDMX-IM package name.classname=agency535 +SDMXPrefix.SDMX-IM package name.classname=agency 530 530 531 531 id:maintained-object-id(version).contained-object-id.object-id 532 532 ... ... @@ -534,37 +534,37 @@ 534 534 535 535 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 536 536 537 - >SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).contained-object-id.object-id543 +SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).contained-object-id.object-id 538 538 539 539 __Actual object is contained in a maintained object with an intermediate containing object and the object type itself is hierarchical__ 540 540 541 541 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 542 542 543 - >SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).contained-object-id. contained-object-id contained-object-id.object-id549 +SDMXPrefix.SDMX-IM package name.classname=agency id:maintained-object-id(version).contained-object-id. contained-object-id contained-object-id.object-id 544 544 545 545 ===== __**//Concrete Examples of the URN Structure//**__ ===== 546 546 547 547 The Data Structure Definition CRED_EXT_DEBT version 1.0 maintained by the top level Agency TFFS would have the URN: 548 548 549 - >urn:sdmx:org.sdmx.infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(1.0)555 +urn:sdmx:org.sdmx.infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(1.0) 550 550 551 551 The URN for a code for Argentina maintained by ISO in the code list CL_3166A2 version 1.0 would be: 552 552 553 - >urn:sdmx:org.sdmx.infomodel.codelist.Code=ISO:CL_3166A2(1.0).AR559 +urn:sdmx:org.sdmx.infomodel.codelist.Code=ISO:CL_3166A2(1.0).AR 554 554 555 555 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: 556 556 557 - >urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:SUBJE CT_MATTER_DOMAINS(1.0).1.2563 +urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:SUBJE CT_MATTER_DOMAINS(1.0).1.2 558 558 559 559 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 560 560 561 561 CONTACT_DETAILS/CONTACT_NAME would be: 562 562 563 - >urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataAttribut e=SDMX:CONTACT_METADATA(1.0).CONTACT_REPORT.CONTACT_DETAILS.CO NTACT_NAME569 +urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataAttribut e=SDMX:CONTACT_METADATA(1.0).CONTACT_REPORT.CONTACT_DETAILS.CO NTACT_NAME 564 564 565 565 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: 566 566 567 - >urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=TFFS.ABC:EX573 +urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=TFFS.ABC:EX 568 568 569 569 TERNAL_DEBT(1.0) 570 570 ... ... @@ -579,94 +579,112 @@ 579 579 580 580 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. 581 581 582 -|(% style="width:127px" %)**Package**|(% style="width:1745px" %)((( 583 -**URN Classname (model classname where this is different)** 588 +|**Package**|((( 589 +**URN Classname (model classname** 590 + 591 +**where this is different)** 584 584 ))) 585 -|(% style="width:127px" %)base|(% style="width:45px" %)Agency 586 -|(% style="width:127px" %) |(% style="width:45px" %)OrganisationUnitScheme 587 -|(% style="width:127px" %) |(% style="width:45px" %)AgencyScheme 588 -|(% style="width:127px" %) |(% style="width:45px" %)DataProviderScheme 589 -|(% style="width:127px" %) |(% style="width:45px" %)DataConsumerScheme 590 -|(% style="width:127px" %) |(% style="width:45px" %)OrganisationUnit 591 -|(% style="width:127px" %) |(% style="width:45px" %)DataProvider 592 -|(% style="width:127px" %) |(% style="width:45px" %)DataConsumer 593 -|(% style="width:127px" %)datastructure|(% style="width:45px" %)DataStructure (DataStructureDefinition) 594 -|(% style="width:127px" %) |(% style="width:45px" %)AttributeDescriptor 595 -|(% style="width:127px" %) |(% style="width:45px" %)DataAttribute 596 -|(% style="width:127px" %) |(% style="width:45px" %)GroupDimensionDescriptor 597 -|(% style="width:127px" %) |(% style="width:45px" %)DimensionDescriptor 598 -|(% style="width:127px" %) |(% style="width:45px" %)Dimension 599 -|(% style="width:127px" %) |(% style="width:45px" %)MeasureDimension 600 -|(% style="width:127px" %) |(% style="width:45px" %)TimeDimension 601 -|(% style="width:127px" %) |(% style="width:45px" %)MeasureDescriptor 602 -|(% style="width:127px" %) |(% style="width:45px" %)PrimaryMeasure 603 -|(% style="width:127px" %) |(% style="width:45px" %)Dataflow (DataflowDefinition) 604 -|(% style="width:127px" %)metadatastructure|(% style="width:45px" %)MetadataTarget 605 -|(% style="width:127px" %) |(% style="width:45px" %)DimensionDescriptorValueTarget 606 -|(% style="width:127px" %) |(% style="width:45px" %)IdentifiableObjectTarget 607 -|(% style="width:127px" %) |(% style="width:45px" %)ReportPeriodTarget 608 -|(% style="width:127px" %) |(% style="width:45px" %)DataSetTarget 609 -|(% style="width:127px" %) |(% style="width:45px" %)ReportStructure 610 -|(% style="width:127px" %) |(% style="width:45px" %)MetadataAttribute 611 -|(% style="width:127px" %) |(% style="width:45px" %)((( 593 +|base|Agency 594 +| |OrganisationUnitScheme 595 +| |AgencyScheme 596 +| |DataProviderScheme 597 +| |DataConsumerScheme 598 +| |OrganisationUnit 599 +| |DataProvider 600 +| |DataConsumer 601 +| | 602 +|datastructure|DataStructure (DataStructureDefinition) 603 +| |AttributeDescriptor 604 +| |DataAttribute 605 +| |GroupDimensionDescriptor 606 +| |DimensionDescriptor 607 +| |Dimension 608 +| |MeasureDimension 609 +| |TimeDimension 610 +| |MeasureDescriptor 611 +| |PrimaryMeasure 612 +| |Dataflow (DataflowDefinition) 613 +| | 614 +|metadatastructure|MetadataTarget 615 +| |DimensionDescriptorValueTarget 616 +| |IdentifiableObjectTarget 617 +| |ReportPeriodTarget 618 +| |DataSetTarget 619 +| |ReportStructure 620 +| |MetadataAttribute 621 +| |((( 612 612 MetadataStructure 613 613 614 614 (MetadataStructureDefinition) 615 615 ))) 616 -|(% style="width:127px" %) |(% style="width:45px" %)Metadataflow (MetadataflowDefinition) 617 -|(% style="width:127px" %)process|(% style="width:45px" %)Process 618 -|(% style="width:127px" %) |(% style="width:45px" %)ProcessStep 619 -|(% style="width:127px" %) |(% style="width:45px" %)Transition 620 -|(% style="width:127px" %)registry|(% style="width:45px" %)ProvisionAgreement 621 -|(% style="width:127px" %) |(% style="width:45px" %)AttachmentConstraint 622 -|(% style="width:127px" %) |(% style="width:45px" %)ContentConstraint 623 -|(% style="width:127px" %) |(% style="width:45px" %)Subscription 624 -|(% style="width:127px" %)mapping|(% style="width:45px" %)StructureMap 625 -|(% style="width:127px" %) |(% style="width:45px" %)StructureSet 626 -|(% style="width:127px" %) |(% style="width:45px" %)ComponentMap 627 -|(% style="width:127px" %) |(% style="width:1745px" %)ConceptSchemeMap 628 -|(% style="width:127px" %) |(% style="width:1745px" %)OrganisationSchemeMap 629 -|(% style="width:127px" %) |(% style="width:1745px" %)CodelistMap 630 -|(% style="width:127px" %) |(% style="width:1745px" %)CategorySchemeMap 631 -|(% style="width:127px" %) |(% style="width:1745px" %)ReportingTaxonomyMap 632 -|(% style="width:127px" %) |(% style="width:1745px" %)ConceptMap 633 -|(% style="width:127px" %) |(% style="width:1745px" %)OrganisationMap 634 -|(% style="width:127px" %) |(% style="width:1745px" %)CodeMap 635 -|(% style="width:127px" %) |(% style="width:1745px" %)HybridCodelistMap 636 -|(% style="width:127px" %) |(% style="width:1745px" %)CategoryMap 637 -|(% style="width:127px" %) |(% style="width:1745px" %)HybridCodeMap 638 -|(% style="width:127px" %) |(% style="width:1745px" %)ReportingCategoryMap 639 -|(% style="width:127px" %)codelist|(% style="width:1745px" %)Codelist 640 -|(% style="width:127px" %) |(% style="width:1745px" %)HierarchicalCodelist 641 -|(% style="width:127px" %) |(% style="width:1745px" %)Hierarchy 642 -|(% style="width:127px" %) |(% style="width:1745px" %)Hierarchy 643 -|(% style="width:127px" %) |(% style="width:1745px" %)Code 644 -|(% style="width:127px" %) |(% style="width:1745px" %)HierarchicalCode 645 -|(% style="width:127px" %) |(% style="width:1745px" %)Level 646 -|(% style="width:127px" %)categoryscheme|(% style="width:1745px" %)CategoryScheme 647 -|(% style="width:127px" %) |(% style="width:1745px" %)Category 648 -|(% style="width:127px" %) |(% style="width:1745px" %)Categorisation 649 -|(% style="width:127px" %) |(% style="width:1745px" %)ReportingTaxonomy 650 -|(% style="width:127px" %) |(% style="width:1745px" %)ReportingCategory 651 -|(% style="width:127px" %)conceptscheme|(% style="width:1745px" %)ConceptScheme 652 -|(% style="width:127px" %) |(% style="width:1745px" %)Concept 653 -|(% style="width:127px" %)transformation|(% style="width:1745px" %)TransformationScheme 654 -|(% style="width:127px" %) |(% style="width:1745px" %)Transformation 655 -|(% style="width:127px" %) |(% style="width:1745px" %)CustomTypeScheme 656 -|(% style="width:127px" %) |(% style="width:1745px" %)CustomType 657 -|(% style="width:127px" %) |(% style="width:1745px" %)NamePersonalisationScheme 658 -|(% style="width:127px" %) |(% style="width:1745px" %)NamePersonalisation 659 -|(% style="width:127px" %) |(% style="width:1745px" %)VtlCodelistMapping 660 -|(% style="width:127px" %) |(% style="width:1745px" %)VtlConceptMapping 661 -|(% style="width:127px" %) |(% style="width:1745px" %)VtlDataflowMapping 662 -|(% style="width:127px" %) |(% style="width:1745px" %)VtlConceptSchemeMapping 663 -|(% style="width:127px" %) |(% style="width:1745px" %)RulesetScheme 664 -|(% style="width:127px" %) |(% style="width:1745px" %)Ruleset 665 -|(% style="width:127px" %) |(% style="width:1745px" %)UserDefinedOperatorScheme 666 -|(% style="width:127px" %) |(% style="width:1745px" %)UserDefinedOperator 626 +| |Metadataflow (MetadataflowDefinition) 627 +| | 628 +|process|Process 629 +| |ProcessStep 630 +| |Transition 631 +| | 632 +|registry|ProvisionAgreement 633 +| |AttachmentConstraint 634 +| |ContentConstraint 635 +| |Subscription 636 +| | 637 +|mapping|StructureMap 638 +| |StructureSet 639 +| |ComponentMap 640 +|**Package**|((( 641 +**URN Classname (model classname** 667 667 643 +**where this is different)** 644 +))) 645 +| |ConceptSchemeMap 646 +| |OrganisationSchemeMap 647 +| |CodelistMap 648 +| |CategorySchemeMap 649 +| |ReportingTaxonomyMap 650 +| |ConceptMap 651 +| |OrganisationMap 652 +| |CodeMap 653 +| |HybridCodelistMap 654 +| |CategoryMap 655 +| |HybridCodeMap 656 +| |ReportingCategoryMap 657 +| | 658 +|codelist|Codelist 659 +| |HierarchicalCodelist 660 +| |Hierarchy 661 +| |Hierarchy 662 +| |Code 663 +| |HierarchicalCode 664 +| |Level 665 +| | 666 +|categoryscheme|CategoryScheme 667 +| |Category 668 +| |Categorisation 669 +| |ReportingTaxonomy 670 +| |ReportingCategory 671 +| | 672 +|conceptscheme|ConceptScheme 673 +| |Concept 674 +| | 675 +|transformation|TransformationScheme 676 +| |Transformation 677 +| |CustomTypeScheme 678 +| |CustomType 679 +| |NamePersonalisationScheme 680 +| |NamePersonalisation 681 +| |VtlCodelistMapping 682 +| |VtlConceptMapping 683 +| |VtlDataflowMapping 684 +| |VtlConceptSchemeMapping 685 +| |RulesetScheme 686 +| |Ruleset 687 +| |UserDefinedOperatorScheme 688 +| |UserDefinedOperator 689 +| | 690 + 668 668 **Table 2: SDMX-IM Packages and Contained Classes** 669 669 693 + 670 670 === 6.2.4 URN Identification components of SDMX objects === 671 671 672 672 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. ... ... @@ -675,50 +675,78 @@ 675 675 676 676 Note that for brevity the URN examples omit the prefix. All URNs have the prefix 677 677 678 - >urn:sdmx.org.sdmx.infomodel.{package}.{classname}=702 +urn:sdmx.org.sdmx.infomodel.{package}.{classname}= 679 679 680 - (% style="width:1091.29px" %)681 -| (% style="width:250px" %)**SDMX Class**|(% style="width:444px" %)**Key attribute(s)**|(% style="width:396px" %)**Example of URN**682 -| (% 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" %)(((704 + 705 +|**SDMX Class**|**Key attribute(s)**|**Example of URN** 706 +|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.|((( 683 683 IMF 708 + 709 + 684 684 Sub agency in the IMF AGENCIES 711 + 712 + 685 685 IMF.SubAgency1 686 686 ))) 687 -|(% style="width:250px" %)*ConceptScheme|(% style="width:444px" %)conceptSchemeAgencyId:conceptSchemeId(ve rsion)|(% style="width:396px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0) 688 -|(% style="width:250px" %)Concept|(% style="width:444px" %)conceptSchemeAgencyId: 689 -conceptSchemeId(version).conceptId|(% style="width:396px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0).FREQ 690 -|(% style="width:250px" %)*Codelist|(% style="width:444px" %)codeListAgencyId:codeListId(version)|(% style="width:396px" %)SDMX:CL_FREQ(1.0) 691 -|(% style="width:250px" %)Code|(% style="width:444px" %)codeListAgencyId:codelistId(version).codeId|(% style="width:396px" %)SDMX:CL_FREQ(1.0).Q 692 -|(% style="width:250px" %)((( 693 -*Hierarchical Codelist 694 -)))|(% style="width:444px" %)hierachicalCodelistAgencyId: hierarchicalCodelistId(version)|(% style="width:396px" %)((( 695 -UNESCO:CL_EXP_SOURCE(1.0(% style="background-color:transparent" %)) 715 +|*ConceptScheme|conceptSchemeAgencyId:conceptSchemeId(ve rsion)|SDMX:CROSS_DOMAIN_CONCEPTS(1.0) 716 +|Concept|((( 717 +conceptSchemeAgencyId: 718 + 719 +conceptSchemeId(version).conceptId 720 +)))|SDMX:CROSS_DOMAIN_CONCEPTS(1.0).FREQ 721 +|*Codelist|codeListAgencyId:codeListId(version)|SDMX:CL_FREQ(1.0) 722 +|Code|codeListAgencyId:codelistId(version).codeId|((( 723 +SDMX:CL_FREQ(1.0).Q 724 + 725 + 696 696 ))) 697 -|(% style="width:250px" %)Hierarchy|(% style="width:444px" %)((( 727 + 728 + 729 + 730 +|((( 731 +*Hierarchical 732 + 733 +Codelist 734 +)))|hierachicalCodelistAgencyId: hierarchicalCodelistId(version)|((( 735 +UNESCO:CL_EXP_SOURCE(1.0) 736 + 737 + 738 +))) 739 +|Hierarchy|((( 698 698 hierachicalcodeListAgencyId: 741 + 699 699 hierarchicalcodelistId(version).Hierarchy 700 -)))|(% style="width:396px" %)UNESCO:CL_EXP_SOURCE(1.0). 701 -H-C-GOV 702 -|(% style="width:250px" %)Level|(% style="width:444px" %)((( 743 +)))|UNESCO:CL_EXP_SOURCE(1.0). H-C-GOV 744 +|Level|((( 703 703 hierachicalcodeListAgencyId: 746 + 704 704 hierarchicalcodelistId(version).Hierarchy.Level 705 -)))|( % style="width:396px" %)(((748 +)))|((( 706 706 ESTAT:HCL_REGION(1.0).H_1.COUNTRY 750 + 751 + 707 707 ))) 708 -| (% 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_CODE1709 -| (% style="width:250px" %)*DataStructure|(% style="width:444px" %)dataStructureDefintitionAgencyId: dataStructureDefintitionId(version)|(% style="width:396px" %)TFFS:EXT_DEBT(1.0)710 -|( % style="width:250px" %)(((753 +|HierarchicalCode|hierachicalCodeListAgencyId: hierarchicalcodelistId(version).hierarchy.hierarc hicalCode|UNESCO:CL_EXP_SOURCE(1.0). H-C-GOV.GOV_CODE1 754 +|*DataStructure|dataStructureDefintitionAgencyId: dataStructureDefintitionId(version)|TFFS:EXT_DEBT(1.0) 755 +|((( 711 711 Dimension 757 + 712 712 Descriptor 759 + 713 713 Measure 761 + 714 714 Descriptor 763 + 715 715 Attribute 765 + 716 716 Descriptor 717 -)))|( % style="width:444px" %)(((767 +)))|((( 718 718 dataStructureDefinitionAgencyId: dataStructureDefinitionId(version). 769 + 719 719 componentListId 771 + 720 720 where the componentListId is the name of the class (there is only one occurrence of each in the Data Structure Definition) 721 -)))|( % style="width:396px" %)(((773 +)))|((( 722 722 TFFS:EXT_DEBT(1.0).DimensionDescriptor 723 723 724 724 TFFS:EXT_DEBT(1.0).MeasureDescriptor ... ... @@ -725,124 +725,181 @@ 725 725 726 726 TFFS:EXT_DEBT(1.0).AttributeDescriptor 727 727 ))) 728 -|( % style="width:250px" %)(((780 +|((( 729 729 GroupDimension 782 + 730 730 Descriptor 731 -)))|( % style="width:444px" %)(((784 +)))|((( 732 732 dataStructureDefinitionAgencyId: dataStructureDefinitionId(version). 786 + 733 733 groupDimensionDescriptorId 734 -)))| (% style="width:396px" %)TFFS:EXT_DEBT(1.0).SIBLING735 -| (% style="width:250px" %)Dimension|(% style="width:444px" %)(((788 +)))|TFFS:EXT_DEBT(1.0).SIBLING 789 +|Dimension|((( 736 736 dataStructureDefinitionAgencyId: dataStructureDefinition (version). 791 + 737 737 dimensionId 738 -)))| (% style="width:396px" %)TFFS:EXT_DEBT(1.0).FREQ739 -| (% style="width:250px" %)TimeDimension|(% style="width:444px" %)(((793 +)))|TFFS:EXT_DEBT(1.0).FREQ 794 +|TimeDimension|((( 740 740 dataStructureDefinitionAgencyId: dataStructureDefinition (version). 796 + 741 741 timeDimensionId 742 -)))|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).TIME_PERIOD 743 -|(% style="width:250px" %)Measure Dimension|(% style="width:444px" %)dataStructureDefinitionAgencyId: dataStructureDefinition (version). 744 -measureDimensionId|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).STOCK_FLOW 745 -|(% style="width:250px" %)DataAttrribute|(% style="width:444px" %)dataStructureDefinitionAgencyId: dataStructureDefinition (version). dataAttributeId|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).OBS_STATUS 746 -|(% style="width:250px" %)PrimaryMeasure|(% style="width:444px" %)((( 798 +)))|TFFS:EXT_DEBT(1.0).TIME_PERIOD 799 +|Measure Dimension|dataStructureDefinitionAgencyId: dataStructureDefinition (version).|TFFS:EXT_DEBT(1.0).STOCK_FLOW 800 + 801 + 802 + 803 +| |measureDimensionId| 804 +|DataAttrribute|dataStructureDefinitionAgencyId: dataStructureDefinition (version). dataAttributeId|TFFS:EXT_DEBT(1.0).OBS_STATUS 805 +|PrimaryMeasure|((( 747 747 dataStructureDefinitionAgencyId: dataStructureDefinition (version). 807 + 748 748 primaryMeasureId 749 -)))|(% style="width:396px" %)TFFS:EXT_DEBT(1.0).OBS_VALUE 750 -|(% style="width:250px" %)((( 751 -*Category Scheme 752 -)))|(% style="width:444px" %)categorySchemeAgencyId: 753 -categorySchemeId(version)|(% style="width:396px" %)IMF:SDDS(1.0) 754 -|(% style="width:250px" %)Category|(% style="width:444px" %)categorySchemeAgencyId: 755 -categorySchemeId(version). 756 -categoryId.categoryId categoryId.categoryId etc.|(% style="width:396px" %)((( 809 +)))|TFFS:EXT_DEBT(1.0).OBS_VALUE 810 +|((( 811 +*Category 812 + 813 +Scheme 814 +)))|categorySchemeAgencyId: categorySchemeId(version)|IMF:SDDS(1.0) 815 +|Category|categorySchemeAgencyId: categorySchemeId(version). categoryId.categoryId categoryId.categoryId etc.|((( 757 757 IMF:SDDS(1.0): 817 + 758 758 level_1_category.level_2_category … 759 759 ))) 760 -|(% style="width:250px" %)((( 761 -*Reporting Taxonomy 762 -)))|(% style="width:444px" %)reportingTaxonomyAgencyId: reportingTaxonomyId(version)|(% style="width:396px" %) IMF:REP_1(1.0) 763 -|(% style="width:250px" %)ReportingCategory|(% style="width:444px" %)reportingTaxonomyAgencyId: reportingTaxonomyId(version) reportingcategoryId.reportingcategoryId|(% style="width:396px" %)((( 820 +|((( 821 +*Reporting 822 + 823 +Taxonomy 824 +)))|reportingTaxonomyAgencyId: reportingTaxonomyId(version)| IMF:REP_1(1.0) 825 +|ReportingCategory|reportingTaxonomyAgencyId: reportingTaxonomyId(version) reportingcategoryId.reportingcategoryId|((( 764 764 IMF:REP_1(1.0): 827 + 765 765 level_1_repcategory.level_2_repcategory … 766 766 ))) 767 -|(% style="width:250px" %)*Categorisation|(% style="width:444px" %)categorisationAgencyId: categorisationId(version)|(% style="width:396px" %)IMF:cat001(1.0) 768 -|(% style="width:250px" %)((( 769 -*Organisation Unit Scheme 770 -)))|(% style="width:444px" %)organisationUnitSchemeAgencyId: organisationUnitSchemeId(version)|(% style="width:396px" %)ECB:ORGANISATIONS(1.0) 771 -|(% style="width:250px" %)Organisation Unit|(% style="width:444px" %)organisationUnitSchemeAgencyId: organisationUnitSchemeId(version). organisationUnitId|(% style="width:396px" %)ECB:ORGANISATIONS(1.0).1F 772 -|(% style="width:250px" %)*AgencyScheme|(% style="width:444px" %)agencySchemeAgencyId: agencySchemeId(version)|(% style="width:396px" %)ECB:AGENCIES(1.0) 830 +|*Categorisation|categorisationAgencyId: categorisationId(version)|IMF:cat001(1.0) 831 +|((( 832 +*Organisation 773 773 774 -|(% style="width:262px" %)Agency|(% style="width:369px" %)agencySchemeAgencyId: agencySchemeId(version). agencyId|(% style="width:1262px" %)ECB:AGENCY(1.0).AA 775 -|(% style="width:262px" %)((( 776 -*DataProvider Scheme 777 -)))|(% style="width:369px" %)dataProviderSchemeAgencyId: dataProviderSchemeId(version)|(% style="width:1262px" %)SDMX:DATA_PROVIDERS(1.0) 778 -|(% style="width:262px" %)DataProvider|(% style="width:369px" %)dataProviderSchemeAgencyId: dataProviderSchemeId(version) dataProviderId|(% style="width:1262px" %)SDMX:DATA_PROVIDERS(1.0).PROVIDER_1 779 -|(% style="width:262px" %)((( 780 -*DataConsumer Scheme 781 -)))|(% style="width:369px" %)dataConsumerSchemeAgencyId: dataConsumerSchemeId(version)|(% style="width:1262px" %)SDMX:DATA_CONSUMERS(1.0) 782 -|(% style="width:262px" %)Data Consumer|(% style="width:369px" %)dataConsumerSchemeAgencyId: dataConsumerSchemeId(version) dataConsumerId|(% style="width:1262px" %)SDMX:DATA_CONSUMERS(1.0).CONSUMER_1 783 -|(% style="width:262px" %)((( 784 -*Metadata Structure 785 -)))|(% style="width:369px" %)MSDAgencyId:MSDId(version)|(% style="width:1262px" %)IMF:SDDS_MSD(1.0) 786 -|(% style="width:262px" %)MetadataTarget|(% style="width:369px" %)((( 834 +Unit Scheme 835 +)))|organisationUnitSchemeAgencyId: organisationUnitSchemeId(version)|ECB:ORGANISATIONS(1.0) 836 +|Organisation Unit|organisationUnitSchemeAgencyId: organisationUnitSchemeId(version). organisationUnitId|ECB:ORGANISATIONS(1.0).1F 837 +|*AgencyScheme|agencySchemeAgencyId: agencySchemeId(version)|ECB:AGENCIES(1.0) 838 + 839 + 840 + 841 +|Agency|agencySchemeAgencyId: agencySchemeId(version). agencyId|ECB:AGENCY(1.0).AA 842 +|((( 843 +*DataProvider 844 + 845 +Scheme 846 +)))|dataProviderSchemeAgencyId: dataProviderSchemeId(version)|SDMX:DATA_PROVIDERS(1.0) 847 +|DataProvider|dataProviderSchemeAgencyId: dataProviderSchemeId(version) dataProviderId|SDMX:DATA_PROVIDERS(1.0).PROVIDER_1 848 +|((( 849 +*DataConsumer 850 + 851 +Scheme 852 +)))|dataConsumerSchemeAgencyId: dataConsumerSchemeId(version)|SDMX:DATA_CONSUMERS(1.0) 853 +|Data Consumer|dataConsumerSchemeAgencyId: dataConsumerSchemeId(version) dataConsumerId|SDMX:DATA_CONSUMERS(1.0).CONSUMER_1 854 +|((( 855 +*Metadata 856 + 857 +Structure 858 +)))|MSDAgencyId:MSDId(version)|IMF:SDDS_MSD(1.0) 859 +|MetadataTarget|((( 787 787 MSDAgencyId: 861 + 788 788 MSDId(version).metadataTargetId 789 -)))| (% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY790 -|( % style="width:262px" %)(((863 +)))|IMF:SDDS_MSD(1.0).AGENCY 864 +|((( 791 791 Dimension 866 + 792 792 DescriptorValues 868 + 793 793 Target 794 -)))|( % style="width:369px" %)(((870 +)))|((( 795 795 MSDAgencyId: MSDId(version). 872 + 796 796 metadataTargetId.keyDescriptorValueTargetId 797 -)))|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY.KEY 798 -|(% style="width:262px" %)Identifiable Object Target|(% style="width:369px" %)((( 799 -MSDAgencyId: MSDId(version).metadataTargetId.identifiableObjectTargetId 800 -)))|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY.STR-OBJECT 801 -|(% style="width:262px" %)DataSetTarget|(% style="width:369px" %)((( 874 +)))|IMF:SDDS_MSD(1.0).AGENCY.KEY 875 +|Identifiable ObjectTarget|((( 802 802 MSDAgencyId: 803 -MSDId(version).metadataTargetId.dataSetTargetId 804 -)))|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY.D1101 805 -|(% style="width:262px" %)PeportPeriod Target|(% style="width:369px" %)((( 806 -MSDAgencyId: MSDId(version).metadataTargetId.reportPeriodTargetId 807 -)))|(% style="width:1262px" %)IMF:SDDS_MSD(1.0).AGENCY.REP_PER 808 808 809 -|(% style="width:251px" %)((( 878 +MSDId(version).metadataTargetId.identifiable 879 + 880 +ObjectTargetId 881 +)))|IMF:SDDS_MSD(1.0).AGENCY.STR-OBJECT 882 +|DataSetTarget|((( 883 +MSDAgencyId: 884 + 885 +MSDId(version).metadataTargetId.dataSet 886 + 887 +TargetId 888 +)))|IMF:SDDS_MSD(1.0).AGENCY.D1101 889 +|PeportPeriod Target|((( 890 +MSDAgencyId: 891 + 892 +MSDId(version).metadataTargetId.reportPeriod 893 + 894 +TargetId 895 +)))|IMF:SDDS_MSD(1.0).AGENCY.REP_PER 896 + 897 + 898 + 899 +|((( 810 810 ReportStructure 811 -)))|(% style="width:442px" %)((( 812 -MSDAgencyId: MSDId(version).reportStructureId 813 -)))|(% style="width:1178px" %)IMF:SDDS_MSD(1.0).AGENCY_REPORT 814 -|(% style="width:251px" %)((( 815 -Metadata Attribute 816 -)))|(% style="width:442px" %)((( 817 -MSDAgencyId: MSDId(version).reportStructureId.metadataattri buteID 818 -)))|(% style="width:1178px" %)IMF:SDDS_MSD(1.0).AGENCY_REPORT.COMPILATION 819 -|(% style="width:251px" %)*Dataflow|(% style="width:442px" %)dataflowAgencyId: dataflowId(version)|(% style="width:1178px" %)TFFS:CRED_EXT_DEBT(1.0) 820 -|(% style="width:251px" %)*Provision Agreement|(% style="width:442px" %)((( 901 + 902 + 903 +)))|((( 904 +MSDAgencyId: 905 + 906 +MSDId(version).reportStructureId 907 +)))|IMF:SDDS_MSD(1.0).AGENCY_REPORT 908 +|((( 909 +Metadata 910 + 911 +Attribute 912 +)))|((( 913 +MSDAgencyId: 914 + 915 +MSDId(version).reportStructureId.metadataattri buteID 916 +)))|IMF:SDDS_MSD(1.0).AGENCY_REPORT.COMPILATION 917 +|*Dataflow|dataflowAgencyId: dataflowId(version)|TFFS:CRED_EXT_DEBT(1.0) 918 +|*Provision Agreement|((( 821 821 provisionAgreementAgencyId:provisionAgreem entId(version) 822 -)))|(% style="width:1178px" %)((( 920 + 921 + 922 +)))|((( 823 823 TFFS:CRED_EXT_DEBT_AB(1.0) 924 + 925 + 926 + 824 824 ))) 825 -|(% style="width:251px" %)((( 826 -*Content Constraint 827 -)))|(% style="width:442px" %)constraintAgencyId:ContentConstraintId(versio n)|(% style="width:1178px" %)TFFS:CREDITOR_DATA_CONTENT(1.0) 828 -|(% style="width:251px" %)((( 829 -*Attachment Constraint 830 -)))|(% style="width:442px" %)((( 928 +|((( 929 +*Content 930 + 931 +Constraint 932 +)))|constraintAgencyId:ContentConstraintId(versio n)|TFFS:CREDITOR_DATA_CONTENT(1.0) 933 +|((( 934 +*Attachment 935 + 936 +Constraint 937 +)))|((( 831 831 constraintAgencyId: 832 832 833 833 attachmentConstraintId(version) 834 -)))| (% style="width:1178px" %)TFFS:CREDITOR_DATA_ATTACHMENT_CONSTRAINT_ONE(1.0)835 -| (% style="width:251px" %)*Metadataflow|(% style="width:442px" %)metadataflowAgencyId: metadataflowId(version)|(% style="width:1178px" %)IMF:SDDS_FLOW(1.0)836 -| (% style="width:251px" %)*StructureSet|(%style="width:442px" %)structureSetAgencyId: structureSetId(version)|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0)837 -| (% style="width:251px" %)StructureMap|(%style="width:442px" %)structureSetAgencyId: structureSetId(version). structureMapId|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2838 -| (% style="width:251px" %)Component Map|(% style="width:442px" %)(((941 +)))|TFFS:CREDITOR_DATA_ATTACHMENT_CONSTRAINT_ONE(1.0) 942 +|*Metadataflow|metadataflowAgencyId: metadataflowId(version)|IMF:SDDS_FLOW(1.0) 943 +|*StructureSet|structureSetAgencyId: structureSetId(version)|SDMX:BOP_STRUCTURES(1.0) 944 +|StructureMap|structureSetAgencyId: structureSetId(version). structureMapId|SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2 945 +|Component Map|((( 839 839 structureSetAgencyId: structureSetId(version). 840 840 841 841 structureMapId. componentMapId 842 -)))| (% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2. REFAREA_REPCOUNTRY843 -| (% style="width:251px" %)CodelistMap|(%style="width:442px" %)structureSetAgencyId: structureSetId(version). codelistMapId|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0).CLREFAREA_CLREPCOUNTRY844 -| (% style="width:251px" %)CodeMap|(%style="width:442px" %)structureSetAgencyId: structureSetId(version).|(% style="width:1178px" %)SDMX:BOP_STRUCTURES(1.0).CLREFAREA_CLREPCOUNTRY. DE_GER949 +)))|SDMX:BOP_STRUCTURES(1.0).TABLE1_TABLE2. REFAREA_REPCOUNTRY 950 +|CodelistMap|structureSetAgencyId: structureSetId(version). codelistMapId|SDMX:BOP_STRUCTURES(1.0).CLREFAREA_CLREPCOUNTRY 951 +|CodeMap|structureSetAgencyId: structureSetId(version).|SDMX:BOP_STRUCTURES(1.0).CLREFAREA_CLREPCOUNTRY. DE_GER 845 845 953 + 954 + 846 846 | |((( 847 847 codeListMapId. 848 848 ... ... @@ -849,7 +849,9 @@ 849 849 codeMapId 850 850 )))| 851 851 |((( 852 -CategorySchemeMap 961 +Category 962 + 963 +SchemeMap 853 853 )))|structureSetAgencyId: structureSetId(version). categorySchemeMapId|SDMX:BOP_STRUCTURES(1.0).SDMX_EUROSTAT 854 854 |CategoryMap|structureSetAgencyId: structureSetId(version). categorySchemeMapId. categoryMapId|SDMX:BOP_STRUCTURES(1.0).SDMX_EUROSTAT.TOURISM_M AP 855 855 |Organisation SchemeMap|structureSetAgencyId: structureSetId(version). organisationSchemeMapId|SDMX:BOP_STRUCTURES(1.0).DATA_PROVIDER_MAP ... ... @@ -863,53 +863,71 @@ 863 863 structureSetAgencyId: structureSetId(version). conceptSchemeMapId. 864 864 865 865 conceptMapId 977 + 866 866 867 867 )))|SDMX:BOP_STRUCTURES(1.0).SDMX_OECD.COVERAGE_AVAI LABILITY 868 868 |((( 869 -ReportingTaxonomyMap 981 +Reporting 982 + 983 +TaxonomyMap 870 870 )))|structureSetAgencyId: structureSetId(version). reportingTaxonomyMapId|SDMX:BOP_STRUCTURES(1.0).TAXMAP 871 871 |((( 872 -ReportingCategoryMap 986 +Reporting 987 + 988 +CategoryMap 873 873 )))|((( 874 874 structureSetAgencyId: structureSetId(version). 991 + 875 875 reportngCategoryId 876 876 )))|SDMX:BOP_STRUCTURES(1.0).TAXMAP.TOPCAT 877 877 995 + 996 + 878 878 |((( 879 -HybridCodelistMap 880 -)))|structureSetAgencyId: structureSetId(version). 881 -hybridCodelistMapId.|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP 998 +HybridCodelist 999 + 1000 +Map 1001 +)))|structureSetAgencyId: structureSetId(version). hybridCodelistMapId.|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP 882 882 |HybridCodeMap|structureSetAgencyId: structureSetId(version). hybridCodelistMapId. hybridCodeMapId|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP.CO DEMAP1 883 883 |*Process|processAgencyId: processId{version]|BIS:PROCESS1(1.0) 884 884 |ProcessStep|((( 885 885 processAgencyId: processId(version). 1006 + 886 886 processStepId 887 887 )))|BIS:PROCESS1(1.0).STEP1 888 888 |Transition|((( 889 889 processAgencyId: processId(version). 1011 + 890 890 processStepId transitionId 891 891 )))|BIS:PROCESS1(1.0).STEP1.TRANSITION1 892 892 |Subscription|The Subscription is not itself an Identifiable Artefact and therefore it does not follow the rules for URN structure, The name of the URN is registryURN There is no pre-determined format.|This cannot be generated by a common mechanism as subscriptions, although maintainable in the sense that they can be submitted and deleted, are not mandated to be created by a maintenance agency, and have no versioning mechanism. It is therefore the responsibility of the target registry to generate a unique Id for the Subscription, and for the application creating the subscription to store the registryURN that is returned from the registry in the subscription response message. 893 893 |((( 894 -*Transformation Scheme 1016 +*Transformation 1017 + 1018 +Scheme 895 895 )))|transformationSchemeAgencyId transformationSchemeId(version)|ECB: TRANSFORMATION_SCHEME(1.0) 896 896 |Transformation|((( 897 897 transformationSchemeAgencyId transformationSchemeId(version) 1022 + 898 898 transformationId 899 899 )))|ECB:TRANSFORMATION_SCHEME(1.0).TRANS_1 900 900 |CustomType Scheme|customTypeSchemeAgencyId customTypeSchemeId(version)|ECB:CUSTOM_TYPE_SCHEME(1.0) 901 901 1027 + 1028 + 902 902 |CustomType|customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|ECB: CUSTOM_TYPE_SCHEME(1.0).CUSTOM_TYPE_1 903 903 |((( 904 904 Name 1032 + 905 905 Personalisation 1034 + 906 906 Scheme 907 907 )))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|ECB:PSN_SCHEME(1.0) 908 908 |((( 909 909 Name 1039 + 910 910 Personalisation 911 -)))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) 912 -namePersonalisationId|ECB:PSN_SCHEME(1.0).PSN1234 1041 +)))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|ECB:PSN_SCHEME(1.0).PSN1234 913 913 |VtlMapping Scheme|vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|ECB:CLIST_MP(2.0) 914 914 |VtlCodelist Mapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|ECB:CLIST_MP(2.0).ABZ 915 915 |VtlConcept Mapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|ECB:CLIST_MP(1.0).XYA ... ... @@ -922,12 +922,15 @@ 922 922 |RulesetScheme|rulesetSchemeAgencyId rulesetSchemeId(version)|ECB:RULESET_23(1.0) 923 923 |Ruleset|rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|ECB:RULESET_23(1.0).SET111 924 924 |((( 925 -UserDefinedOperatorScheme 1054 +UserDefined 1055 + 1056 +OperatorScheme 926 926 )))|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|ECB:OS_CALC(1.2) 927 927 |UserDefined Operator|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|ECB:OS_CALC(1.2).OS267 928 928 929 -**Table 3: Table of identification components for SDMX Identifiable Artefacts** 1060 +7**Table 3: Table of identification components for SDMX Identifiable Artefacts** 930 930 1062 + 931 931 = 7 Implementation Notes = 932 932 933 933 == 7.1 Structural Definition Metadata == ... ... @@ -948,72 +948,109 @@ 948 948 949 949 The following table lists the Maintainable Artefacts. 950 950 951 -(% style="width:640.294px" %) 952 -|(% colspan="2" rowspan="1" style="width:186px" %)**Maintainable Artefacts**|(% style="width:206px" %)**Content** 953 -|(% style="width:171px" %)**Abstract Class**|(% style="width:232px" %)**Concrete Class**|(% style="width:206px" %) 954 -|(% style="width:171px" %)Item Scheme|(% style="width:232px" %)Codelist|(% style="width:206px" %)Code 955 -|(% style="width:171px" %) |(% style="width:232px" %)Concept Scheme|(% style="width:206px" %)Concept 956 -|(% style="width:171px" %) |(% style="width:232px" %)Category Scheme|(% style="width:206px" %)Category 957 -|(% style="width:171px" %) |(% style="width:232px" %)Organisation Unit Scheme|(% style="width:206px" %)Organisation Unit 958 -|(% style="width:171px" %) |(% style="width:232px" %)Agency Scheme|(% style="width:206px" %)Agency 959 -|(% style="width:171px" %) |(% style="width:232px" %)Data Provider Scheme|(% style="width:206px" %)Data Provider 960 -|(% style="width:171px" %) |(% style="width:232px" %)Data Consumer Scheme|(% style="width:206px" %)Data Consumer 961 -|(% style="width:171px" %) |(% style="width:232px" %)Reporting Taxonomy|(% style="width:206px" %)Reporting Category 962 -|(% style="width:171px" %) |(% style="width:232px" %)Transformation Scheme|(% style="width:206px" %)Transformation 963 -|(% style="width:171px" %) |(% style="width:232px" %)Custom Type Scheme|(% style="width:206px" %)Custom Type 964 -|(% style="width:171px" %) |(% style="width:232px" %)Name Personalisation Scheme|(% style="width:206px" %)Name Personalisation 965 -|(% style="width:171px" %) |(% style="width:232px" %)Vtl Mapping Scheme|(% style="width:206px" %)Vtl Codelist Mapping 966 -|(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)Vtl Dataflow Mapping 967 -|(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)Vtl Concept Scheme Mapping 968 -|(% style="width:171px" %) |(% style="width:232px" %)Ruleset Scheme|(% style="width:206px" %)Ruleset 969 -|(% style="width:171px" %) |(% style="width:232px" %)User Defined Operator Scheme|(% style="width:206px" %)User Defined Operator 970 -|(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)User Defined Operator 971 -|(% style="width:171px" %)Structure|(% style="width:232px" %)Data Structure Definition|(% style="width:206px" %)((( 1083 +|(% colspan="4" %)**Maintainable Artefacts**|(% colspan="2" %)**Content**| 1084 +|(% colspan="2" %)**Abstract Class**|(% colspan="2" %)**Concrete Class**|(% colspan="2" %) | 1085 +|(% colspan="2" %)Item Scheme|(% colspan="2" %)Codelist|(% colspan="2" %)Code| 1086 +|(% colspan="2" %) |(% colspan="2" %)Concept Scheme|(% colspan="2" %)Concept| 1087 +|(% colspan="2" %) |(% colspan="2" %)Category Scheme|(% colspan="2" %)Category| 1088 +|(% colspan="2" %) |(% colspan="2" %)Organisation Unit Scheme|(% colspan="2" %)Organisation Unit| 1089 +|(% colspan="2" %) |(% colspan="2" %)Agency Scheme|(% colspan="2" %)Agency| 1090 +|(% colspan="2" %) |(% colspan="2" %)Data Provider Scheme|(% colspan="2" %)Data Provider| 1091 +|(% colspan="2" %) |(% colspan="2" %)Data Consumer Scheme|(% colspan="2" %)Data Consumer| 1092 +|(% colspan="2" %) |(% colspan="2" %)Reporting Taxonomy|(% colspan="2" %)Reporting Category| 1093 +|(% colspan="2" %) |(% colspan="2" %)Transformation Scheme|(% colspan="2" %)Transformation| 1094 +|(% colspan="2" %) |(% colspan="2" %)Custom Type Scheme|(% colspan="2" %)Custom Type| 1095 +| |(% colspan="4" %)**Maintainable Artefacts**|(% colspan="2" %)**Content** 1096 +| |(% colspan="2" %)**Abstract Class**|(% colspan="2" %)**Concrete Class**|(% colspan="2" %) 1097 +| |(% colspan="2" %) |(% colspan="2" %)Name Personalisation Scheme|(% colspan="2" %)Name Personalisation 1098 +| |(% colspan="2" %) |(% colspan="2" %)Vtl Mapping Scheme|(% colspan="2" %)Vtl Codelist Mapping 1099 +| |(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)Vtl Concept Mapping 1100 +| |(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)Vtl Dataflow Mapping 1101 +| |(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)((( 1102 +Vtl Concept Scheme 1103 + 1104 +Mapping 1105 +))) 1106 +| |(% colspan="2" %) |(% colspan="2" %)Ruleset Scheme|(% colspan="2" %)Ruleset 1107 +| |(% colspan="2" %) |(% colspan="2" %)User Defined Operator Scheme|(% colspan="2" %)User Defined Operator 1108 +| |(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %) 1109 +| |(% colspan="2" %)Structure|(% colspan="2" %)Data Structure Definition|(% colspan="2" %)((( 972 972 Dimension Descriptor 1111 + 973 973 Group Dimension 1113 + 974 974 Descriptor 1115 + 975 975 Dimension 1117 + 976 976 Measure Dimension 1119 + 977 977 Time Dimension 1121 + 978 978 Attribute Descriptor 1123 + 979 979 Data Attribute 1125 + 980 980 Measure Descriptor 1127 + 981 981 Primary Measure 982 982 ))) 983 -|(% style="width:171px" %) |(% style="width:232px" %)Metadata Structure Definition|(% style="width:206px" %)((( 984 -Metadata Target, Dimension Descriptor 1130 +| |(% colspan="2" %) |(% colspan="2" %)Metadata Structure Definition|(% colspan="2" %)((( 1131 +Metadata Target, 1132 + 1133 +Dimension Descriptor 1134 + 985 985 Values Target Identifiable 1136 + 986 986 Object Target 1138 + 987 987 Report Period Target 1140 + 988 988 Data SetTarget 1142 + 989 989 Report Structure 1144 + 990 990 Metadata Attribute 991 991 ))) 992 -|(% style="width:171px" %)Structure Usage|(%style="width:232px" %)Dataflow Definition|(%style="width:206px" %)993 -|(% style="width:171px" %) |(%style="width:232px" %)Metadataflow Definition|(%style="width:206px" %)994 -|(% style="width:171px" %)None|(%style="width:232px" %)Process|(%style="width:206px" %)Process Step995 -|(% style="width:171px" %)None|(%style="width:232px" %)Structure Set|(%style="width:206px" %)(((1147 +| |(% colspan="2" %)Structure Usage|(% colspan="2" %)Dataflow Definition|(% colspan="2" %) 1148 +| |(% colspan="2" %) |(% colspan="2" %)Metadataflow Definition|(% colspan="2" %) 1149 +| |(% colspan="2" %)None|(% colspan="2" %)Process|(% colspan="2" %)Process Step 1150 +| |(% colspan="2" %)None|(% colspan="2" %)Structure Set|(% colspan="2" %)((( 996 996 Component Map 1152 + 997 997 Concept Scheme Map 1154 + 998 998 Codelist Map 1156 + 999 999 Category Scheme Map 1158 + 1000 1000 Reporting Taxonomy Map 1160 + 1001 1001 Organisation Scheme Map 1162 + 1002 1002 Concept Map 1164 + 1003 1003 Code Map 1166 + 1004 1004 Category Map 1168 + 1005 1005 Organisation Map 1170 + 1006 1006 Reporting Category Map 1172 + 1007 1007 Hybrid Codelist Map 1174 + 1008 1008 Hybrid Code Map 1009 1009 ))) 1010 -|(% style="width:171px" %)None|(%style="width:232px" %)Provision Agreement|(%style="width:206px" %)1011 -|(% style="width:171px" %)None|(%style="width:232px" %)Hierarchical Codelist|(%style="width:206px" %)(((1177 +| |(% colspan="2" %)None|(% colspan="2" %)Provision Agreement|(% colspan="2" %) 1178 +| |(% colspan="2" %)None|(% colspan="2" %)Hierarchical Codelist|(% colspan="2" %)((( 1012 1012 Hierarchy 1180 + 1013 1013 Hierarchical Code 1014 1014 ))) 1183 +| | | | | | | 1015 1015 1016 -**able 4: Table of Maintainable Artefacts for Structural Definition Metadata** 1185 +**Table 4: Table of Maintainable Artefacts for Structural Definition Metadata** 1017 1017 1018 1018 === 7.1.2 Item Scheme, Structure === 1019 1019 ... ... @@ -1020,7 +1020,10 @@ 1020 1020 The artefacts included in the structural definitions are: 1021 1021 1022 1022 * All types of Item Scheme (Codelist, Concept Scheme, Category Scheme, Organisation Scheme - Agency Scheme, Data Provider Scheme, Data Consumer Scheme, Organisation Unit Scheme) 1023 -* All types of Structure (Data Structure Definition, Metadata Structure Definition) 1192 +* All types of Structure (Data Structure Definition, Metadata Structure 1193 + 1194 +Definition) 1195 + 1024 1024 * All types of Structure Usage (Dataflow Definition, Metadataflow Definition) 1025 1025 1026 1026 === 7.1.3 Structure Usage === ... ... @@ -1039,8 +1039,6 @@ 1039 1039 1040 1040 ==== 7.1.3.3 Structure Usage Model ==== 1041 1041 1042 -[[image:1747829078194-749.png]] 1043 - 1044 1044 **Figure 10: SDMX-IM of links from Structure Usage to Category** 1045 1045 1046 1046 In addition to the maintenance of the Dataflow Definition and the Metadataflow Definition the following links must be maintained in the registry: ... ... @@ -1067,10 +1067,10 @@ 1067 1067 1068 1068 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. 1069 1069 1070 -[[image:1747829109466-595.png]] 1071 1071 1072 1072 **Figure 11: SDMX-IM of the Data Provider** 1073 1073 1243 + 1074 1074 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 1075 1075 1076 1076 [[image:1747824123019-181.jpeg]] ... ... @@ -1079,10 +1079,8 @@ 1079 1079 1080 1080 The diagram below is a logical representation of the data required in order to maintain Provision Agreements. 1081 1081 1082 -[[image:1747829139951-378.png]] 1083 1083 1084 -(% class="wikigeneratedid" id="HFigure13:LogicalclassdiagramoftheinformationcontainedintheProvisionAgreement" %) 1085 -**Figure 13: Logical class diagram of the information contained in the Provision Agreement** 1253 +==== Figure 13: Logical class diagram of the information contained in the Provision Agreement ==== 1086 1086 1087 1087 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. 1088 1088 ... ... @@ -1110,12 +1110,13 @@ 1110 1110 1111 1111 === 7.3.3 Data and Metadata Constraints: Model === 1112 1112 1113 -[[image:1747829204737-370.png]] 1114 1114 1115 -**Figure 15: Logical class diagram showing inheritance between and reference to constrainable artifacts** 1116 1116 1117 - The class diagramaboveshows that DataProvider, DataflowDefinition, MetadataflowDefinition, ProvisionAgreement,DataStructureDefinition, MetadataStructureDefinition, SimpleDatasource and QueryDatasourceare all concrete sub-classes of ConstrainableArtefactandcan thereforehave Constraints specified. Note that the actual Constraint as submitted is associatedtothe reference classes which inherit from ConstrainableRef:theseare usedto refer to the classes to whichthe Constraintapplies.1283 +==== Figure 15: Logical class diagram showing inheritance between and reference to constrainable artifacts ==== 1118 1118 1285 +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. 1286 + 1287 + 1119 1119 The content of the Constraint can be found in the SDMX Information Model document. 1120 1120 1121 1121 == 7.4 Data and Metadata Registration == ... ... @@ -1136,7 +1136,7 @@ 1136 1136 1137 1137 [[image:1747824123025-411.jpeg]] 1138 1138 1139 -**Figure 16: Schematic of the Objects Concerned with Registration** 1308 + **Figure 16: Schematic of the Objects Concerned with Registration** 1140 1140 1141 1141 ==== 7.4.2.2 Registration Request Model ==== 1142 1142 ... ... @@ -1150,14 +1150,11 @@ 1150 1150 1151 1151 The Registration has an action attribute which takes one of the following values: 1152 1152 1153 -(% style="width:970.294px" %) 1154 -|(% style="width:212px" %)**Action Attribute Value**|(% style="width:756px" %)**Behaviour** 1155 -|(% style="width:212px" %)Append|(% style="width:756px" %)Add this Registration to the registry 1156 -|(% style="width:212px" %)Replace|(% style="width:756px" %)Replace the existing Registration with identified by the id in the Registration of the Submit Registration Request 1157 -|(% style="width:212px" %)Delete|(% style="width:756px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request 1322 +|**Action Attribute Value**|**Behaviour** 1323 +|Append|Add this Registration to the registry 1324 +|Replace|Replace the existing Registration with identified by the id in the Registration of the Submit Registration Request 1325 +|Delete|Delete the existing Registration identified by the id in the Registration of the Submit Registration Request 1158 1158 1159 -[[image:1747829290890-122.png]] 1160 - 1161 1161 **Figure 17: Logical Class Diagram of Registration of Data and Metadata** 1162 1162 1163 1163 The Query Datasource is an abstract class that represents a data source which can understand an SDMX-ML query (SOAPDatasource) or RESTful query ... ... @@ -1172,19 +1172,25 @@ 1172 1172 1173 1173 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. 1174 1174 1175 -|(% style="width:185px" %)**Indexing Required**|(% style="width:1686px" %)**Registration Process Activity** 1176 -|(% style="width:185px" %)indexTimeSeries|(% style="width:1686px" %)Extract all the series keys and create a KeySet(s) Constraint. 1177 -|(% style="width:185px" %)indexDataSet|(% style="width:1686px" %)((( 1178 -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. 1341 +|**Indexing Required**|**Registration Process Activity** 1342 +|indexTimeSeries|Extract all the series keys and create a KeySet(s) Constraint. 1343 +|indexDataSet|((( 1344 +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 1345 + 1346 +Regions containing Member Selections of Dimension Components of the Constraints model in the SDMX-IM, and the associated Selection Value. 1179 1179 ))) 1180 -| (% style="width:185px" %)indexReportingPeriod|(% style="width:1686px" %)(((1348 +|indexReportingPeriod|((( 1181 1181 This applies only to a registered dataset. 1350 + 1182 1182 Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint. 1183 1183 ))) 1184 -| (% style="width:185px" %)indexAttributes|(% style="width:1686px" %)(((1353 +|indexAttributes|((( 1185 1185 **Data Set** 1355 + 1186 1186 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 1357 + 1187 1187 **Metadata Set** 1359 + 1188 1188 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. 1189 1189 ))) 1190 1190 ... ... @@ -1194,13 +1194,14 @@ 1194 1194 1195 1195 === 7.4.3 Registration Response === 1196 1196 1197 -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”.1369 +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 1198 1198 1371 +“Success”, “Warning” or “Failure”. 1372 + 1199 1199 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. 1200 1200 1201 1201 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: 1202 1202 1203 -[[image:1747829477882-750.png]] 1204 1204 1205 1205 **Figure 18: Logical class diagram showing the registration response** 1206 1206 ... ... @@ -1210,12 +1210,15 @@ 1210 1210 1211 1211 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. 1212 1212 1213 -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”.1386 +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 1214 1214 1215 - === 7.5.1SubscriptionLogical Class Diagram ===1388 +“notification”. 1216 1216 1217 - [[image:1747829554603-150.png]]1390 + 7.5.1Subscription Logical Class Diagram 1218 1218 1392 + 1393 +[[image:1747824123028-257.png]] 1394 + 1219 1219 **Figure 19: Logical Class Diagram of the Subscription** 1220 1220 1221 1221 === 7.5.2 Subscription Information === ... ... @@ -1222,58 +1222,73 @@ 1222 1222 1223 1223 Regardless of the type of registry/repository events being observed, a subscription always contains: 1224 1224 1225 -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. 1226 -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. 1227 -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. 1228 -1. A selector which specifies which type of events are of interest. The set of event types is: 1401 +~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. 1229 1229 1230 -|(% style="width:319px" %)**Event Type**|(% style="width:1553px" %)**Comment** 1231 -|(% style="width:319px" %)STRUCTURAL_REPOSITORY_EVENTS|(% style="width:1553px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository. 1232 -|(% style="width:319px" %)DATA_REGISTRATION_EVENTS|(% style="width:1553px" %)Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database. 1233 -|(% style="width:319px" %)METADATA_REGISTRATION_EVENTS|(% style="width:1553px" %)Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database. 1234 -|(% style="width:319px" %)ALL_EVENTS|(% style="width:1553px" %)All events of the specified EventType 1403 +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. 1235 1235 1405 +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. 1406 + 1407 +4. A selector which specifies which type of events are of interest. The set of event types is: 1408 + 1409 +|**Event Type**|**Comment** 1410 +|STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository. 1411 +|DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database. 1412 +|METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database. 1413 +|ALL_EVENTS|All events of the specified EventType 1414 + 1236 1236 === 7.5.3 Wildcard Facility === 1237 1237 1238 1238 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: 1239 1239 1240 -* agencyID 1241 -* id 1242 -* version 1419 + agencyID 1243 1243 1421 + id 1422 + 1423 + version 1424 + 1244 1244 Examples of wildcarded identifier components for an identified object type of Codelist are shown below. 1245 1245 1246 -//AgencyID = % 1427 +AgencyID = % 1428 + 1247 1247 Id = % 1248 -Version = %// 1249 1249 1431 +Version = % 1432 + 1250 1250 This subscribes to all Codelists of all versions for all agencies. 1251 1251 1252 -//AgencyID = AGENCY1 1435 +AgencyID = AGENCY1 1436 + 1253 1253 Id = CODELIST1 1254 -Version = %// 1255 1255 1439 +Version = % 1440 + 1256 1256 This subscribes to all versions of Codelist CODELIST1 maintained by the agency 1257 1257 1258 -//AGENCY1 1443 +AGENCY1 1444 + 1259 1259 AgencyID = AGENCY1 1446 + 1260 1260 Id = % 1261 -Version = %// 1262 1262 1449 +Version = % 1450 + 1263 1263 This subscribes to all versions of all Codelist objects maintained by the agency 1264 1264 1265 -//AGENCY1 1453 +AGENCY1 1454 + 1266 1266 AgencyID = % 1456 + 1267 1267 Id = CODELIST1 1268 -Version = %// 1269 1269 1459 +Version = % 1460 + 1270 1270 This subscribes to all versions of Codelist CODELIST1 maintained by the agency 1271 1271 1272 - //AGENCY1//1463 +AGENCY1 1273 1273 1274 1274 Note that if the subscription is to the latest version then this can be achieved by the * character 1275 1275 1276 - //i.e. Version = *//1467 +i.e. Version = * 1277 1277 1278 1278 Note that a subscription using the URN mechanism cannot use wildcard characters. 1279 1279 ... ... @@ -1285,15 +1285,16 @@ 1285 1285 1286 1286 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: 1287 1287 1288 -|(% style="width:405px" %)**Selector**|(% style="width:1467px" %)**Comment** 1289 -|(% style="width:405px" %)DataProvider|(% style="width:1467px" %)Any datasets or metadata sets registered by the specified data provider will activate the notification. 1290 -|(% style="width:405px" %)ProvisionAgreement|(% style="width:1467px" %)Any datasets or metadata sets registered for the provision agreement will activate the notification. 1291 -|(% style="width:405px" %)Dataflow (&Metadataflow)|(% style="width:1467px" %)Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification. 1292 -|(% 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 1293 -|(% style="width:405px" %)**Selector**|(% style="width:1467px" %)**Comment** 1294 -|(% style="width:405px" %) |(% style="width:1467px" %)activate the notification. 1295 -|(% 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. 1296 1296 1480 +|**Selector**|**Comment** 1481 +|DataProvider|Any datasets or metadata sets registered by the specified data provider will activate the notification. 1482 +|ProvisionAgreement|Any datasets or metadata sets registered for the provision agreement will activate the notification. 1483 +|Dataflow (&Metadataflow)|Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification. 1484 +|DataStructureDefinition & MetadataStructureDefinition|Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will 1485 +|**Selector**|**Comment** 1486 +| |activate the notification. 1487 +|Category|Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category. 1488 + 1297 1297 The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration. 1298 1298 1299 1299 == 7.6 Notification == ... ... @@ -1300,10 +1300,8 @@ 1300 1300 1301 1301 === 7.6.1 Logical Class Diagram === 1302 1302 1303 -[[image:1747829675568-610.png]] 1304 1304 1305 -(% class="wikigeneratedid" id="HFigure20:LogicalClassDiagramoftheNotification" %) 1306 -**Figure 20: Logical Class Diagram of the Notification** 1496 +==== Figure 20: Logical Class Diagram of the Notification ==== 1307 1307 1308 1308 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. 1309 1309 ... ... @@ -1323,3 +1323,5 @@ 1323 1323 === 7.6.3 Registration Event Component === 1324 1324 1325 1325 The notification will contain the Registration. 1516 + 1517 +
- 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