Skip to Content
Last modified by Helena on 2025/09/10 11:19
From version 30.1
edited by Helena
on 2025/05/16 14:21
Change comment: There is no comment for this version
To version 21.8
edited by Helena
on 2025/05/15 14:21
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -183,11 +183,11 @@
183 183  
184 184  === {{id name="_Toc93847"/}}5.2.2 Structure Submission Service ===
185 185  
186 -The registry must support a mechanism for submitting structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: [[__https:~~/~~/github.com/sdmx-twg/sdmx-rest__>>https://https:github.comsdmx-twgsdmx-rest]]). In order for the architecture to be scalable, the finest-grained piece of structural metadata that can be processed by the SDMX-RR is a MaintainableArtefact, with the exception of Item Schemes, where changes at an Item level is also possible (see next section on the SDMX Information Model).
186 +The registry must support a mechanism for submitting structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: __[[https:~~/~~/github.com/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[twg/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[rest>>url:https://github.com/sdmx-twg/sdmx-rest]]__[[)>>url:https://github.com/sdmx-twg/sdmx-rest]]. In order for the architecture to be scalable, the finest-grained piece of structural metadata that can be processed by the SDMX-RR is a MaintainableArtefact, with the exception of Item Schemes, where changes at an Item level is also possible (see next section on the SDMX Information Model).
187 187  
188 188  === {{id name="_Toc93848"/}}5.2.3 Structure Query Service ===
189 189  
190 -The registry must support a mechanism for querying for structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: [[__https:~~/~~/github.com/sdmx-twg/sdmx-rest__>>https://https:github.comsdmx-twgsdmx-rest]]). The registry response to this query mechanism is the SDMX Structure message, which has as its root node:
190 +The registry must support a mechanism for querying for structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: __[[https:~~/~~/github.com/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[twg/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[rest>>url:https://github.com/sdmx-twg/sdmx-rest]]__ [[)>>url:https://github.com/sdmx-twg/sdmx-rest]]. The registry response to this query mechanism is the SDMX Structure message, which has as its root node:
191 191  
192 192  * Structure
193 193  
... ... @@ -280,7 +280,7 @@
280 280  Subscription management involves a user submitting a subscription request which contains:
281 281  
282 282  * 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).
283 -* a list of URIs or endpoints to which an XML notification message can be sent. Supported endpoint types will be email (mailto~: ) and HTTP POST (a normal http:~/~/ address);
283 +* a list of URIs or endpoints to which an XML notification message can be sent. Supported endpoint types will be email (mailto~:) and HTTP POST (a normal http:~/~/ address);
284 284  * request for a list of submitted subscriptions;
285 285  * deletion of a subscription;
286 286  
... ... @@ -301,8 +301,10 @@
301 301  
302 302  a) Be a draft version.
303 303  )))
304 +|(% style="width:188px" %)**Interface**|(% style="width:542px" %)**Behaviour**
304 304  |(% style="width:188px" %) |(% style="width:542px" %)(((
305 305  b) Not be explicitly{{footnote}}With semantic versioning, it is allowed to reference a range of artefacts, e.g., a DSD referencing a Codelist with version 1.2.3+ means all patch versions greater than 1.2.3. This means that deleting 1.2.4-draft does not break integrity of the aforementioned DSD.{{/footnote}} referenced from any other object in the Registry.
307 +
306 306  4) The semantic versioning rules in the SDMX documentation MUST be obeyed.
307 307  )))
308 308  |(% style="width:188px" %)Structure submission|(% style="width:542px" %)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.
... ... @@ -327,12 +327,14 @@
327 327  
328 328  The table below shows the identification and related data attributes to be stored in a registry for objects that are one of:
329 329  
330 -* //nnotable//
332 +* //Annotable//
331 331  * //Identifiable//
332 332  * //Nameable//
333 333  * //Versionable//
334 334  * //Maintainable//
335 335  
338 +:
339 +
336 336  (((
337 337  (% style="width:1052.29px" %)
338 338  |**Object Type**|(% style="width:241px" %)**Data Attributes**|(% style="width:156px" %)**Status**|**Data type**|(% style="width:457px" %)**Notes**
... ... @@ -360,9 +360,9 @@
360 360  
361 361  **Table 1: Common Attributes of Object Types**
362 362  
363 -== {{id name="_Toc93856"/}}6.2 Unique identification of SDMX objects ==
367 +=== {{id name="_Toc93856"/}}6.2 Unique identification of SDMX objects ===
364 364  
365 -=== {{id name="_Toc93857"/}}6.2.1 Agencies and Metadata Providers ===
369 +===== {{id name="_Toc93857"/}}6.2.1 Agencies and Metadata Providers =====
366 366  
367 367  The Maintenance Agency in SDMX is maintained in an Agency Scheme which itself is a sub class of Organisation Scheme – this is shown in the class diagram below.
368 368  
... ... @@ -443,14 +443,23 @@
443 443  The packages are:
444 444  
445 445  base
450 +
446 446  codelist
452 +
447 447  conceptscheme
454 +
448 448  datastructure
456 +
449 449  categoryscheme
458 +
450 450  registry
460 +
451 451  metadatastructure
462 +
452 452  process
464 +
453 453  structuremapping
466 +
454 454  transformation
455 455  
456 456  **maintainable-object-id** is the identifier of the maintainable object. This will always be present as all identifiable objects are either a maintainable object or contained in a maintainable object.
... ... @@ -491,27 +491,27 @@
491 491  
492 492  SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version).contained-object-id.contained-object-id contained-objectid.object-id
493 493  
494 -===== //__**Concrete Examples of the URN Structure**__// =====
507 +//__**Concrete Examples of the URN Structure**__//
495 495  
496 496  The Data Structure Definition CRED_EXT_DEBT of legacy version 2.1 maintained by the toplevel Agency TFFS would have the URN:
497 497  
498 - urn:sdmx:org.sdmx.infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(2.1)
511 +urn:sdmx:org.sdmx.infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(2.1)
499 499  
500 500  The URN for a code for Argentina maintained by ISO in the code list CL_3166A2 of semantic version 1.0.0 would be:
501 501  
502 - urn:sdmx:org.sdmx.infomodel.codelist.Code=ISO:CL_3166A2(1.0.0).AR
515 +urn:sdmx:org.sdmx.infomodel.codelist.Code=ISO:CL_3166A2(1.0.0).AR
503 503  
504 504  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 of the semantic extended version 1.0.0draft would be:
505 505  
506 - urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:SUBJECT_MATT ER_DOMAINS(1.0.0-draft).1.2
519 +urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:SUBJECT_MATT ER_DOMAINS(1.0.0-draft).1.2
507 507  
508 508  The URN for a Metadata Attribute maintained by SDMX in the MSD CONTACT_METADATA of semantic version 1.0.0 where the hierarchy of the Metadata Attribute is CONTACT_DETAILS/CONTACT_NAME would be:
509 509  
510 - urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataAttribute=SDMX: CONTACT_METADATA(1.0.0).CONTACT_DETAILS.CONTACT_NAME
523 +urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataAttribute=SDMX: CONTACT_METADATA(1.0.0).CONTACT_DETAILS.CONTACT_NAME
511 511  
512 512  The TFFS defines ABC as a sub-Agency of TFFS then the URN of a Dataflow maintained by ABC and identified as EXTERNAL_DEBT of semantic version 1.0.0 would be:
513 513  
514 - urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=TFFS.ABC:EXTERNAL_ DEBT(1.0.0)
527 +urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=TFFS.ABC:EXTERNAL_ DEBT(1.0.0)
515 515  
516 516  The SDMX-RR MUST support this globally unique identification scheme. The SDMX-RR MUST be able to create the URN from the individual identification attributes submitted and to transform the URN to these identification attributes. The identification attributes are:
517 517  
... ... @@ -611,108 +611,136 @@
611 611  
612 612  urn:sdmx.org.sdmx.infomodel.{package}.{classname}=
613 613  
614 -(% style="width:1419.29px" %)
615 -|(% style="width:227px" %)**Classname**|(% style="width:645px" %)**Ending URN pattern**|(% style="width:543px" %)**Example**
616 -|(% style="width:227px" %)Agency{{footnote}}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. For example, a sub-agency of IMF is referred like this: IMF.SubAgency1{{/footnote}}|(% style="width:645px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|(% style="width:543px" %)ECB:**AGENCIES**(**1.0**).AA
617 -|(% style="width:227px" %)//AgencyScheme//|(% style="width:645px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**)|(% style="width:543px" %)ECB:**AGENCIES**(**1.0**)
618 -|(% style="width:227px" %)//Categorisation//|(% style="width:645px" %)categorisationAgencyId:categorisationId(version)|(% style="width:543px" %)IMF:cat001(1.0.0)
619 -|(% style="width:227px" %)Category|(% style="width:645px" %)categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|(% style="width:543px" %)IMF:SDDS(1.0.0):level_1_category.level_2_category …
620 -|(% style="width:227px" %)//CategoryScheme//|(% style="width:645px" %)categorySchemeAgencyId:categorySchemeId(versi on)|(% style="width:543px" %)IMF:SDDS(1.0.0)
621 -|(% style="width:227px" %)//CategorySchemeMap//|(% style="width:645px" %)(((
622 -catSchemeMapAgencyId:catSchemeMapId(version)
623 -)))|(% style="width:543px" %)SDMX:EUROSTAT_SUBJECT_DOMAIN(1.0.0)
624 -|(% style="width:227px" %)Code|(% style="width:645px" %)codeListAgencyId:codelistId(version).codeId|(% style="width:543px" %)SDMX:CL_FREQ(1.0.0).Q
625 -|(% style="width:227px" %)//Codelist//|(% style="width:645px" %)codeListAgencyId:codeListId(version)|(% style="width:543px" %)SDMX:CL_FREQ(1.0.0)
626 -|(% style="width:227px" %)ComponentMap|(% style="width:645px" %)structureMapAgencyId:structureMap(version).com ponentMapId|(% style="width:543px" %)SDMX:BOP_STRUCTURES(1.0.0).REF_AREA_TO_COUNT RY
627 -|(% style="width:227px" %)Concept|(% style="width:645px" %)conceptSchemeAgencyId:conceptSchemeId(versio n).conceptId|(% style="width:543px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0).FREQ
628 -|(% style="width:227px" %)//ConceptScheme//|(% style="width:645px" %)conceptSchemeAgencyId:conceptSchemeId(versio n)|(% style="width:543px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0)
629 -|(% style="width:227px" %)//ConceptSchemeMap//|(% style="width:645px" %)(((
627 +|**Classname**|**Ending URN pattern**|**Example**
628 +|Agency^^[[(% class="wikiinternallink wikiinternallink wikiinternallink" %)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^|agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|ECB:**AGENCIES**(**1.0**).AA
629 +|//AgencyScheme//|agencySchemeAgencyId:**AGENCIES**(**1.0**)|ECB:**AGENCIES**(**1.0**)
630 +|//Categorisation//|categorisationAgencyId:categorisationId(version)|IMF:cat001(1.0.0)
631 +|Category|categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|IMF:SDDS(1.0.0):level_1_category.level_2_category …
632 +|//CategoryScheme//|categorySchemeAgencyId:categorySchemeId(versi on)|IMF:SDDS(1.0.0)
633 +
634 +|**Classname**|**Ending URN pattern**|**Example**
635 +|//CategorySchemeMap//|(((
636 +catSchemeMapAgencyId:catSchemeMapId(version
637 +
638 +)
639 +)))|SDMX:EUROSTAT_SUBJECT_DOMAIN(1.0.0)
640 +|Code|codeListAgencyId:codelistId(version).codeId|SDMX:CL_FREQ(1.0.0).Q
641 +|//Codelist//|codeListAgencyId:codeListId(version)|SDMX:CL_FREQ(1.0.0)
642 +|ComponentMap|structureMapAgencyId:structureMap(version).com ponentMapId|SDMX:BOP_STRUCTURES(1.0.0).REF_AREA_TO_COUNT RY
643 +|Concept|conceptSchemeAgencyId:conceptSchemeId(versio n).conceptId|SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0).FREQ
644 +|//ConceptScheme//|conceptSchemeAgencyId:conceptSchemeId(versio n)|SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0)
645 +|//ConceptSchemeMap//|(((
630 630  conceptSchemeMapAgencyId:conceptSchemeMap
647 +
631 631  Id(version)
632 -)))|(% style="width:543px" %)SDMX:CONCEPT_MAP(1.0.0)
633 -|(% style="width:227px" %)CustomType|(% style="width:645px" %)customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|(% style="width:543px" %)ECB: CUSTOM_TYPE_SCHEME(1.0.0).CUSTOM_TYPE_1
634 -|(% style="width:227px" %)//CustomTypeScheme//|(% style="width:645px" %)customTypeSchemeAgencyId customTypeSchemeId(version)|(% style="width:543px" %)ECB:CUSTOM_TYPE_SCHEME(1.0.0)
635 -|(% style="width:227px" %)DataAttrribute|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dataAttributeId|(% style="width:543px" %)TFFS:EXT_DEBT(1.0.0).OBS_STATUS
636 -|(% style="width:227px" %)//DataConstraint//|(% style="width:645px" %)dataConstraintAgencyId:dataConstraintId(version)|(% style="width:543px" %)TFFS:CREDITOR_DATA_CONTENT(1.0.0)
637 -|(% style="width:229px" %)DataConsumer|(% style="width:645px" %)dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**).dataConsumerId|(% style="width:543px" %)SDMX:**DATA_CONSUMERS**(**1.0**).CONSUMER_1
638 -|(% style="width:229px" %)//DataConsumerScheme//|(% style="width:645px" %)(((
639 -dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**)
640 -)))|(% style="width:543px" %)SDMX:**DATA_CONSUMERS**(**1.0**)
641 -|(% style="width:229px" %)//Dataflow//|(% style="width:645px" %)dataflowAgencyId:dataflowId(version)|(% style="width:543px" %)TFFS:CRED_EXT_DEBT(1.0.0)
642 -|(% style="width:229px" %)DataProvider|(% style="width:645px" %)(((
643 -dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**).dataProviderId
644 -)))|(% style="width:543px" %)SDMX:**DATA_PROVIDERS**(**1.0**).PROVIDER_1
645 -|(% style="width:229px" %)//DataProviderScheme//|(% style="width:645px" %)(((
646 -dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**)
647 -)))|(% style="width:543px" %)SDMX:**DATA_PROVIDERS**(**1.0**)
648 -|(% style="width:229px" %)//DataStructure//|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version)|(% style="width:543px" %)TFFS:EXT_DEBT(1.0.0)
649 -|(% style="width:229px" %)Dimension|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dimensionId|(% style="width:543px" %)TFFS:EXT_DEBT(1.0.0).FREQ
650 -|(% style="width:229px" %)(((
649 +)))|SDMX:CONCEPT_MAP(1.0.0)
650 +|CustomType|customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|ECB: CUSTOM_TYPE_SCHEME(1.0.0).CUSTOM_TYPE_1
651 +|//CustomTypeScheme//|customTypeSchemeAgencyId customTypeSchemeId(version)|ECB:CUSTOM_TYPE_SCHEME(1.0.0)
652 +|DataAttrribute|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dataAttributeId|TFFS:EXT_DEBT(1.0.0).OBS_STATUS
653 +|//DataConstraint//|dataConstraintAgencyId:dataConstraintId(version)|TFFS:CREDITOR_DATA_CONTENT(1.0.0)
654 +
655 +|**Classname**|**Ending URN pattern**|**Example**
656 +|DataConsumer|dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**).dataConsumerId|SDMX:**DATA_CONSUMERS**(**1.0**).CONSUMER_1
657 +|//DataConsumerScheme//|(((
658 +dataConsumerSchemeAgencyId:**DATA_CONSUME**
659 +
660 +**RS**(**1.0**)
661 +)))|SDMX:**DATA_CONSUMERS**(**1.0**)
662 +|//Dataflow//|dataflowAgencyId:dataflowId(version)|TFFS:CRED_EXT_DEBT(1.0.0)
663 +|DataProvider|(((
664 +dataProviderSchemeAgencyId:**DATA_PROVIDERS**(
665 +
666 +**1.0**).dataProviderId
667 +)))|SDMX:**DATA_PROVIDERS**(**1.0**).PROVIDER_1
668 +|//DataProviderScheme//|(((
669 +dataProviderSchemeAgencyId:**DATA_PROVIDERS**(
670 +
671 +**1.0**)
672 +)))|SDMX:**DATA_PROVIDERS**(**1.0**)
673 +|//DataStructure//|dataStructureDefinitionAgencyId:dataStructureDef initionId(version)|TFFS:EXT_DEBT(1.0.0)
674 +|Dimension|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dimensionId|TFFS:EXT_DEBT(1.0.0).FREQ
675 +|(((
651 651  DimensionDescriptor
677 +
652 652  MeasureDescriptor
679 +
653 653  AttributeDescriptor
654 -)))|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).componentListId where the componentListId is the name of the class (there is only one occurrence of each in the Data Structure Definition)|(% style="width:543px" %)(((
681 +)))|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).componentListId where the componentListId is the name of the class (there is only one occurrence of each in the Data Structure Definition)|(((
655 655  TFFS:EXT_DEBT(1.0.0).DimensionDescriptor
683 +
656 656  TFFS:EXT_DEBT(1.0.0).MeasureDescriptor
685 +
657 657  TFFS:EXT_DEBT(1.0.0).AttributeDescriptor
658 658  )))
659 -|(% style="width:229px" %)GroupDimensionDescriptor|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).groupDimensionDescriptorId|(% style="width:543px" %)TFFS:EXT_DEBT(1.0.0).SIBLING
660 -|(% style="width:229px" %)HierarchicalCode|(% style="width:645px" %)hierarchyAgencyId:hierarchyId(version).hierarchica lCode.hierarchicalCode|(% style="width:543px" %)UNESCO:H-C-GOV(1.0.0).GOV_CODE1.GOV_CODE1_1
661 -|(% style="width:206px" %)//Hierarchy//|(% style="width:645px" %)hierarchyAgencyId:hierarchyId(version)|(% style="width:543px" %)UNESCO:H-C-GOV(1.0.0)
662 -|(% style="width:206px" %)//HierarchyAssociation//|(% style="width:645px" %)hierarchyAssociationAgencyId:hierarchyAssociatio nId(version)|(% style="width:543px" %)UNESCO:CL_EXP_SOURCE(1.0.0)
663 -|(% style="width:206px" %)Level|(% style="width:645px" %)hierarchyAgencyId:hierarchyId(version).level|(% style="width:543px" %)UNESCO:H-C-GOV(1.0.0).LVL1
664 -|(% style="width:206px" %)Measure|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).measureId|(% style="width:543px" %)TFFS:EXT_DEBT(1.0.0).OBS_VALUE
665 -|(% style="width:206px" %)MetadataAttribute|(% style="width:645px" %)(((
688 +|GroupDimensionDescriptor|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).groupDimensionDescriptorId|TFFS:EXT_DEBT(1.0.0).SIBLING
689 +|HierarchicalCode|hierarchyAgencyId:hierarchyId(version).hierarchica lCode.hierarchicalCode|UNESCO:H-C-GOV(1.0.0).GOV_CODE1.GOV_CODE1_1
690 +
691 +|**Classname**|**Ending URN pattern**|**Example**
692 +|//Hierarchy//|hierarchyAgencyId:hierarchyId(version)|UNESCO:H-C-GOV(1.0.0)
693 +|//HierarchyAssociation//|hierarchyAssociationAgencyId:hierarchyAssociatio nId(version)|UNESCO:CL_EXP_SOURCE(1.0.0)
694 +|Level|hierarchyAgencyId:hierarchyId(version).level|UNESCO:H-C-GOV(1.0.0).LVL1
695 +|Measure|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).measureId|TFFS:EXT_DEBT(1.0.0).OBS_VALUE
696 +|MetadataAttribute|(((
666 666  msdAgencyId:msdId(version).metadataAttributeId.
698 +
667 667  metadataAttributeId
668 -)))|(% style="width:543px" %)IMF:SDDS_MSD(1.0.0).COMPILATION.METHOD
669 -|(% style="width:206px" %)MetadataAttributeDescriptor|(% style="width:645px" %)msdAgencyId:msdId(version).metadataAttributeDe scriptorId|(% style="width:543px" %)IMF:SDDS_MSD(1.0.0).MetadataAttributeDescriptor
670 -|(% style="width:206px" %)//MetadataConstraint//|(% style="width:645px" %)metadataConstraintAgencyId:metadataConstraintI d(version)|(% style="width:543px" %)TFFS:CREDITOR_METADATA_CONTENT(1.0.0)
671 -|(% style="width:206px" %)//Metadataflow//|(% style="width:645px" %)metadataflowAgencyId:metadataflowId(version)|(% style="width:543px" %)IMF:SDDS_MDF(1.0.0)
672 -|(% style="width:206px" %)MetadataProvider|(% style="width:645px" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**).metadataProviderId|(% style="width:543px" %)SDMX:**METADATA_PROVIDERS**(**1.0**).MD_PROVIDER_1
673 -|(% style="width:206px" %)//MetadataProviderScheme//|(% style="width:645px" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**)|(% style="width:543px" %)SDMX:**METADATA_PROVIDERS**(**1.0**)
674 -|(% style="width:206px" %)//MetadataProvisionAgreement//|(% style="width:645px" %)metadataProvisionAgreementAgencyId:metadataP rovisionAgreementId(version)|(% style="width:543px" %)IMF:SDDS_MDF_AB(1.0.0)
675 -|(% style="width:206px" %)//MetadataSet//|(% style="width:645px" %)metadataProviderId:metadataSetId(version)|(% style="width:543px" %)MD_PROVIDER:METADATASET(1.0.0)
676 -|(% style="width:206px" %)//MetadataStructure//|(% style="width:645px" %)msdAgencyId:msdId(version)|(% style="width:543px" %)IMF:SDDS_MSD(1.0.0)
677 -|(% style="width:227px" %)NamePersonalisation|(% style="width:527px" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|(% style="width:545px" %)ECB:PSN_SCHEME(1.0.0).PSN1234
678 -|(% style="width:227px" %)//NamePersonalisationScheme//|(% style="width:527px" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|(% style="width:545px" %)ECB:PSN_SCHEME(1.0.0)
679 -|(% style="width:227px" %)//OrganisationSchemeMap//|(% style="width:527px" %)orgSchemeMapAgencyId:orgSchemeMapId(versio n)|(% style="width:545px" %)SDMX:AGENCIES_PROVIDERS(1.0.0)
680 -|(% style="width:227px" %)OrganisationUnit|(% style="width:527px" %)organisationUnitSchemeAgencyId:organisationUnitSchemeId(version).organisationUnitId|(% style="width:545px" %)ECB:ORGANISATIONS(1.0.0).1F
681 -|(% style="width:227px" %)//OrganisationUnitScheme//|(% style="width:527px" %)organisationUnitSchemeAgencyId:organisationUni tSchemeId(version)|(% style="width:545px" %)ECB:ORGANISATIONS(1.0.0)
682 -|(% style="width:227px" %)//Process//|(% style="width:527px" %)processAgencyId:processId{version)|(% style="width:545px" %)BIS:PROCESS1(1.0.0)
683 -|(% style="width:227px" %)ProcessStep|(% style="width:527px" %)(((
700 +)))|IMF:SDDS_MSD(1.0.0).COMPILATION.METHOD
701 +|MetadataAttributeDescriptor|msdAgencyId:msdId(version).metadataAttributeDe scriptorId|IMF:SDDS_MSD(1.0.0).MetadataAttributeDescriptor
702 +|//MetadataConstraint//|metadataConstraintAgencyId:metadataConstraintI d(version)|TFFS:CREDITOR_METADATA_CONTENT(1.0.0)
703 +|//Metadataflow//|metadataflowAgencyId:metadataflowId(version)|IMF:SDDS_MDF(1.0.0)
704 +|MetadataProvider|metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**).metadataProviderId|SDMX:**METADATA_PROVIDERS**(**1.0**).MD_PROVIDER_1
705 +|//MetadataProviderScheme//|metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**)|SDMX:**METADATA_PROVIDERS**(**1.0**)
706 +|//MetadataProvisionAgreement//|metadataProvisionAgreementAgencyId:metadataP rovisionAgreementId(version)|IMF:SDDS_MDF_AB(1.0.0)
707 +|//MetadataSet//|metadataProviderId:metadataSetId(version)|MD_PROVIDER:METADATASET(1.0.0)
708 +|//MetadataStructure//|msdAgencyId:msdId(version)|IMF:SDDS_MSD(1.0.0)
709 +
710 +|**Classname**|**Ending URN pattern**|**Example**
711 +|NamePersonalisation|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|ECB:PSN_SCHEME(1.0.0).PSN1234
712 +|//NamePersonalisationScheme//|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|ECB:PSN_SCHEME(1.0.0)
713 +|//OrganisationSchemeMap//|orgSchemeMapAgencyId:orgSchemeMapId(versio n)|SDMX:AGENCIES_PROVIDERS(1.0.0)
714 +|OrganisationUnit|organisationUnitSchemeAgencyId:organisationUni tSchemeId(version).organisationUnitId|ECB:ORGANISATIONS(1.0.0).1F
715 +|//OrganisationUnitScheme//|organisationUnitSchemeAgencyId:organisationUni tSchemeId(version)|ECB:ORGANISATIONS(1.0.0)
716 +|//Process//|processAgencyId:processId{version)|BIS:PROCESS1(1.0.0)
717 +|ProcessStep|(((
684 684  processAgencyId:processId(version).processStepId.
719 +
685 685  processStepId
686 -)))|(% style="width:545px" %)BIS:PROCESS1(1.0.0).STEP1.STEP1_1
687 -|(% style="width:227px" %)//ProvisionAgreement//|(% style="width:527px" %)provisionAgreementAgencyId:provisionAgreement Id(version)|(% style="width:545px" %)TFFS:CRED_EXT_DEBT_AB(1.0.0)
688 -|(% style="width:227px" %)ReportingCategory|(% style="width:527px" %)(((
721 +)))|BIS:PROCESS1(1.0.0).STEP1.STEP1_1
722 +|//ProvisionAgreement//|provisionAgreementAgencyId:provisionAgreement Id(version)|TFFS:CRED_EXT_DEBT_AB(1.0.0)
723 +|ReportingCategory|(((
689 689  reportingTaxonomyAgencyId:
725 +
690 690  reportingTaxonomyId(version).reportingCategoryI d.reportingCategoryId
691 -)))|(% style="width:545px" %)IMF:REP_1(1.0.0):LVL1_REP_CAT.LVL2_REP_CAT
692 -|(% style="width:227px" %)//ReportingTaxonomy//|(% style="width:527px" %)reportingTaxonomyAgencyId:reportingTaxonomyI d(version)|(% style="width:545px" %)IMF:REP_1(1.0.0)
693 -|(% style="width:227px" %)//ReportingTaxonomyMap//|(% style="width:527px" %)repTaxonomyAgencyId:repTaxonomyId(version)|(% style="width:545px" %)SDMX:RT_MAP(1.0.0)
694 -|(% style="width:229px" %)//RepresentationMap//|(% style="width:645px" %)repMapAgencyId:repMapId(version)|(% style="width:215px" %)SDMX:REF_AREA_MAPPING(1.0.0)
695 -|(% style="width:229px" %)Ruleset|(% style="width:645px" %)rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|(% style="width:215px" %)ECB:RULESET_23(1.0.0).SET111
696 -|(% style="width:229px" %)//RulesetScheme//|(% style="width:645px" %)rulesetSchemeAgencyId rulesetSchemeId(version)|(% style="width:215px" %)ECB:RULESET_23(1.0.0)
697 -|(% style="width:229px" %)//StructureMap//|(% style="width:645px" %)structureMapAgencyId:structureMap(version)|(% style="width:215px" %)SDMX:BOP_STRUCTURES(1.0.0)
698 -|(% style="width:229px" %)Subscription|(% style="width:645px" %)(((
727 +)))|IMF:REP_1(1.0.0):LVL1_REP_CAT.LVL2_REP_CAT
728 +|//ReportingTaxonomy//|reportingTaxonomyAgencyId:reportingTaxonomyI d(version)|IMF:REP_1(1.0.0)
729 +|//ReportingTaxonomyMap//|repTaxonomyAgencyId:repTaxonomyId(version)|SDMX:RT_MAP(1.0.0)
730 +
731 +|**Classname**|**Ending URN pattern**|**Example**
732 +|//RepresentationMap//|repMapAgencyId:repMapId(version)|SDMX:REF_AREA_MAPPING(1.0.0)
733 +|Ruleset|rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|ECB:RULESET_23(1.0.0).SET111
734 +|//RulesetScheme//|rulesetSchemeAgencyId rulesetSchemeId(version)|ECB:RULESET_23(1.0.0)
735 +|//StructureMap//|structureMapAgencyId:structureMap(version)|SDMX:BOP_STRUCTURES(1.0.0)
736 +|Subscription|(((
699 699  The Subscription is not itself an Identifiable Artefact and therefore it does not follow the rules for URN structure.
738 +
700 700  The name of the URN is registryURN There is no pre-determined format.
701 -)))|(% style="width:1015px" %)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 registry URN that is returned from the registry in the subscription response message.
702 -|(% style="width:229px" %)TimeDimension|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).timeDimensionId|(% style="width:1015px" %)TFFS:EXT_DEBT(1.0.0).TIME_PERIOD
703 -|(% style="width:229px" %)Transformation|(% style="width:645px" %)transformationSchemeAgencyId transformationSchemeId(version) transformationId|(% style="width:1015px" %)ECB:TRANSFORMATION_SCHEME(1.0.0).TRANS_1
704 -|(% style="width:229px" %)//TransformationScheme//|(% style="width:645px" %)transformationSchemeAgencyId transformationSchemeId(version)|(% style="width:1015px" %)ECB: TRANSFORMATION_SCHEME(1.0.0)
705 -|(% style="width:229px" %)Transition|(% style="width:645px" %)(((
740 +)))|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 registry URN that is returned from the registry in the subscription response message.
741 +|TimeDimension|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).timeDimensionId|TFFS:EXT_DEBT(1.0.0).TIME_PERIOD
742 +|Transformation|transformationSchemeAgencyId transformationSchemeId(version) transformationId|ECB:TRANSFORMATION_SCHEME(1.0.0).TRANS_1
743 +|//TransformationScheme//|transformationSchemeAgencyId transformationSchemeId(version)|ECB: TRANSFORMATION_SCHEME(1.0.0)
744 +|**Classname**|**Ending URN pattern**|**Example**
745 +|Transition|(((
706 706  processAgencyId:processId(version).processStepId.
747 +
707 707  transitionId
708 -)))|(% style="width:1015px" %)BIS:PROCESS1(1.0.0).STEP1.TRANSITION1
709 -|(% style="width:229px" %)UserDefinedOperator|(% style="width:645px" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|(% style="width:1015px" %)ECB:OS_CALC(1.2.0).OS267
710 -|(% style="width:229px" %)//UserDefinedOperatorScheme//|(% style="width:645px" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|(% style="width:1015px" %)ECB:OS_CALC(1.2.0)
711 -|(% style="width:229px" %)//ValueList//|(% style="width:645px" %)valuelistAgencyId:valuelistId(version)|(% style="width:1015px" %)SDMX:VLIST(1.0.0)
712 -|(% style="width:229px" %)VtlCodelistMapping|(% style="width:645px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|(% style="width:1015px" %)ECB:CLIST_MP(2.0.0).ABZ
713 -|(% style="width:229px" %)VtlConceptMapping|(% style="width:645px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|(% style="width:1015px" %)ECB:CLIST_MP(1.0.0).XYA
714 -|(% style="width:229px" %)VtlDataflowMapping|(% style="width:645px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|(% style="width:1015px" %)ECB:CLIST_MP(1.0.0).MOQ
715 -|(% style="width:229px" %)//VtlMappingScheme//|(% style="width:645px" %)vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|(% style="width:1015px" %)ECB:CLIST_MP(2.0.0)
749 +)))|BIS:PROCESS1(1.0.0).STEP1.TRANSITION1
750 +|UserDefinedOperator|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|ECB:OS_CALC(1.2.0).OS267
751 +|//UserDefinedOperatorScheme//|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|ECB:OS_CALC(1.2.0)
752 +|//ValueList//|valuelistAgencyId:valuelistId(version)|SDMX:VLIST(1.0.0)
753 +|VtlCodelistMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|ECB:CLIST_MP(2.0.0).ABZ
754 +|VtlConceptMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|ECB:CLIST_MP(1.0.0).XYA
755 +|VtlDataflowMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|ECB:CLIST_MP(1.0.0).MOQ
756 +|//VtlMappingScheme//|vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|ECB:CLIST_MP(2.0.0)
716 716  
717 717  **Table 3: Table of identification components for SDMX Identifiable Artefacts**
718 718  
... ... @@ -720,7 +720,7 @@
720 720  
721 721  === {{id name="_Toc93862"/}}7.1 Structural Definition Metadata ===
722 722  
723 -=== {{id name="_Toc93863"/}}7.1.1 Introduction ===
764 +===== {{id name="_Toc93863"/}}7.1.1 Introduction =====
724 724  
725 725  The SDMX Registry must have the ability to support agencies in their role of defining and disseminating structural metadata artefacts. These artefacts include data structure definitions, code lists, concepts etc. and are fully defined in the SDMX-IM. An authenticated agency may submit valid structural metadata definitions which must be stored in the registry. Note that the term “structural metadata” refers as a general term to all structural components (Data Structure Definitions, Metadata Structure Definitions, Code Lists, Concept Schemes, etc.)
726 726  
... ... @@ -736,79 +736,90 @@
736 736  
737 737  The following table lists the Maintainable Artefacts.
738 738  
739 -(% style="width:881.294px" %)
740 -|(% colspan="2" style="width:522px" %)**Maintainable Artefacts**|(% style="width:490px" %)**Content**
741 -|(% style="width:198px" %)**Abstract Class**|(% style="width:324px" %)**Concrete Class**|(% style="width:490px" %)
742 -|(% style="width:198px" %)Item Scheme|(% style="width:324px" %)Codelist|(% style="width:490px" %)Code
743 -|(% style="width:198px" %) |(% style="width:324px" %)Concept Scheme|(% style="width:490px" %)Concept
744 -|(% style="width:198px" %) |(% style="width:324px" %)Category Scheme|(% style="width:490px" %)Category
745 -|(% style="width:198px" %) |(% style="width:324px" %)Organisation Unit Scheme|(% style="width:490px" %)Organisation Unit
746 -|(% style="width:198px" %) |(% style="width:324px" %)Agency Scheme|(% style="width:490px" %)Agency
747 -|(% style="width:198px" %) |(% style="width:324px" %)Data Provider Scheme|(% style="width:490px" %)Data Provider
748 -|(% style="width:198px" %) |(% style="width:324px" %)Metadata Provider Scheme|(% style="width:490px" %)Metadata Provider
749 -|(% style="width:198px" %) |(% style="width:324px" %)Data Consumer Scheme|(% style="width:490px" %)Data Consumer
750 -|(% style="width:198px" %) |(% style="width:324px" %)Reporting Taxonomy|(% style="width:490px" %)Reporting Category
751 -|(% style="width:198px" %) |(% style="width:324px" %)Transformation Scheme|(% style="width:490px" %)Transformation
752 -|(% style="width:198px" %) |(% style="width:324px" %)Custom Type Scheme|(% style="width:490px" %)Custom Type
753 -|(% style="width:198px" %) |(% style="width:324px" %)Name Personalisation Scheme|(% style="width:490px" %)Name Personalisation
754 -|(% style="width:198px" %) |(% style="width:324px" %)Vtl Mapping Scheme|(% style="width:490px" %)Vtl Codelist Mapping Vtl Concept Mapping
755 -|(% style="width:198px" %) |(% style="width:324px" %)Ruleset Scheme|(% style="width:490px" %)Ruleset
756 -|(% style="width:198px" %) |(% style="width:324px" %)User Defined Operator Scheme|(% style="width:490px" %)User Defined Operator
757 -|(% style="width:198px" %)Enumerated List|(% style="width:324px" %)ValueList|(% style="width:490px" %)Value Item
758 -|(% style="width:198px" %)Structure|(% style="width:324px" %)Data Structure Definition|(% style="width:490px" %)(((
780 +|(% colspan="2" %)**Maintainable Artefacts**|**Content**
781 +|**Abstract Class**|**Concrete Class**|
782 +|Item Scheme|Codelist|Code
783 +| |Concept Scheme|Concept
784 +| |Category Scheme|Category
785 +| |Organisation Unit Scheme|Organisation Unit
786 +| |Agency Scheme|Agency
787 +| |Data Provider Scheme|Data Provider
788 +| |Metadata Provider Scheme|Metadata Provider
789 +| |Data Consumer Scheme|Data Consumer
790 +| |Reporting Taxonomy|Reporting Category
791 +| |Transformation Scheme|Transformation
792 +| |Custom Type Scheme|Custom Type
793 +| |Name Personalisation Scheme|Name Personalisation
794 +| |Vtl Mapping Scheme|Vtl Codelist Mapping Vtl Concept Mapping
795 +| |Ruleset Scheme|Ruleset
796 +| |User Defined Operator Scheme|User Defined Operator
797 +|Enumerated List|ValueList|Value Item
798 +|Structure|Data Structure Definition|(((
759 759  Dimension Descriptor
800 +
760 760  Group Dimension Descriptor
802 +
761 761  Dimension
804 +
762 762  Time Dimension
806 +
763 763  Attribute Descriptor
808 +
764 764  Data Attribute
810 +
765 765  Measure Descriptor
812 +
766 766  Measure
767 767  )))
768 -|(% style="width:198px" %) |(% style="width:324px" %)Metadata Structure Definition|(% style="width:490px" %)Metadata Attribute Descriptor Metadata Attribute
769 -|(% style="width:198px" %)Structure Usage|(% style="width:324px" %)Dataflow|(% style="width:490px" %)
770 -|(% style="width:198px" %) |(% style="width:324px" %)Metadataflow|(% style="width:490px" %)
771 -|(% style="width:198px" %)None|(% style="width:324px" %)Process|(% style="width:490px" %)Process Step
772 -|(% style="width:198px" %)None|(% style="width:324px" %)Structure Map|(% style="width:490px" %)(((
815 +| |Metadata Structure Definition|Metadata Attribute Descriptor Metadata Attribute
816 +|Structure Usage|Dataflow|
817 +| |Metadataflow|
818 +|None|Process|Process Step
819 +|None|Structure Map|(((
773 773  Component Map
821 +
774 774  Epoch Map
823 +
775 775  Date Pattern Map
776 776  )))
777 -|(% style="width:198px" %)None|(% style="width:324px" %)Representation Map|(% style="width:490px" %)Representation Mapping
778 -|(% style="width:198px" %)Item Scheme Map|(% style="width:324px" %)Organisation Scheme Map|(% style="width:490px" %)Item Map
779 -|(% style="width:198px" %) |(% style="width:324px" %)Concept Scheme Map|(% style="width:490px" %)Item Map
780 -|(% style="width:198px" %) |(% style="width:324px" %)Category Scheme Map|(% style="width:490px" %)Item Map
781 -|(% style="width:198px" %) |(% style="width:324px" %)Reporting Taxonomy Map|(% style="width:490px" %)Item Map
782 -|(% style="width:198px" %)None|(% style="width:324px" %)Provision Agreement|(% style="width:490px" %)
783 -|(% style="width:198px" %)None|(% style="width:324px" %)Metadata Provision Agreement|(% style="width:490px" %)
784 -|(% style="width:198px" %)None|(% style="width:324px" %)Hierarchy|(% style="width:490px" %)Hierarchical Code
785 -|(% style="width:198px" %)None|(% style="width:324px" %)Hierarchy Association|(% style="width:490px" %)
786 -|(% style="width:198px" %)None|(% style="width:324px" %)Categorisation|(% style="width:490px" %)
826 +|None|Representation Map|Representation Mapping
827 +|Item Scheme Map|Organisation Scheme Map|Item Map
828 +| |Concept Scheme Map|Item Map
829 +| |Category Scheme Map|Item Map
830 +| |Reporting Taxonomy Map|Item Map
831 +|None|Provision Agreement|
832 +|None|Metadata Provision Agreement|
833 +|None|Hierarchy|Hierarchical Code
834 +|None|Hierarchy Association|
835 +|None|Categorisation|
787 787  
788 788  **Table 4: Table of Maintainable Artefacts for Structural Definition Metadata**
789 789  
790 -=== {{id name="_Toc93864"/}}7.1.2 Item Scheme, Structure ===
839 +===== {{id name="_Toc93864"/}}7.1.2 Item Scheme, Structure =====
791 791  
792 792  The artefacts included in the structural definitions are:
793 793  
794 -* All types of Item Scheme (Codelist, Concept Scheme, Category Scheme, Organisation Scheme, Agency Scheme, Data Provider Scheme, Metadata Provider Scheme, Data Consumer Scheme, Organisation Unit Scheme, Transformation Scheme, Name Personalisation Scheme, Custom Type Scheme, Vtl Mapping Scheme, Ruleset Scheme, User Defined Operator Scheme)
795 -* All types of Enumerated List (ValueList){{footnote}}Note that Codelist is also an EnumeratedList.{{/footnote}}
796 -* All types of Structure (Data Structure Definition, Metadata Structure Definition)
797 -* All types of Structure Usage (Dataflow, Metadataflow)
843 +• All types of Item Scheme (Codelist, Concept Scheme, Category Scheme, Organisation Scheme, Agency Scheme, Data Provider Scheme, Metadata Provider Scheme, Data Consumer Scheme, Organisation Unit Scheme, Transformation Scheme, Name Personalisation Scheme, Custom Type Scheme, Vtl Mapping Scheme, Ruleset Scheme, User Defined Operator Scheme)
798 798  
799 -=== {{id name="_Toc93865"/}}7.1.3 Structure Usage ===
845 +• All types of Enumerated List (ValueList)^^[[(% class="wikiinternallink wikiinternallink wikiinternallink" %)^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]](%%)^^
800 800  
801 -==== 7.1.3.1 Structure Usage: Basic Concepts ====
847 +• All types of Structure (Data Structure Definition, Metadata Structure Definition)
802 802  
849 +• All types of Structure Usage (Dataflow, Metadataflow)
850 +
851 +===== {{id name="_Toc93865"/}}7.1.3 Structure Usage =====
852 +
853 +**7.1.3.1 Structure Usage: Basic Concepts**
854 +
803 803  The Structure Usage defines, in its concrete classes of Dataflow and Metadataflow, which flows of data and metadata use which specific Structure, and importantly for the support of data and metadata discovery, the Structure Usage can be linked to one or more Category in one or more Category Scheme using the Categorisation mechanism. This gives the ability for an application to discover data and metadata by “drilling down” the Category Schemes.
804 804  
805 -==== 7.1.3.2 Structure Usage Schematic ====
857 +**7.1.3.2 Structure Usage Schematic**
806 806  
807 807  [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_52097ab5.jpg||height="246" width="438"]]
808 808  
809 809  **Figure 9: Schematic of Linking the Data and Metadata Flows to Categories and Structure Definitions**
810 810  
811 -==== 7.1.3.3 Structure Usage Model ====
863 +**7.1.3.3 Structure Usage Model**
812 812  
813 813  [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_302cc1a2.jpg||height="548" width="578"]]
814 814  
... ... @@ -824,9 +824,9 @@
824 824  * Categorisation to Dataflow and Category
825 825  * Categorisation to Metadataflow and Category
826 826  
827 -== {{id name="_Toc93866"/}}7.2 Data and Metadata Provisioning ==
879 +=== {{id name="_Toc93866"/}}7.2 Data and Metadata Provisioning ===
828 828  
829 -=== {{id name="_Toc93867"/}}7.2.1 Provisioning Agreement: Basic concepts ===
881 +===== {{id name="_Toc93867"/}}7.2.1 Provisioning Agreement: Basic concepts =====
830 830  
831 831  Data/Metadata provisioning defines a framework in which the provision of different types of statistical data and metadata by various data/metadata providers can be specified and controlled. This framework is the basis on which the existence of data can be made known to the SDMX-enabled community and hence the basis on which data can subsequently be discovered. Such a framework can be used to regulate the data content to facilitate the building of intelligent applications. It can also be used to facilitate the processing implied by service level agreements, or other provisioning agreements in those scenarios that are based on legal directives. Additionally, quality and timeliness metadata can be supported by this framework which makes it practical to implement information supply chain monitoring.
832 832  
... ... @@ -834,7 +834,7 @@
834 834  
835 835  Although the Provision Agreement directly supports the data-sharing “pull” model, it is also useful in “push” exchanges (bilateral and gateway scenarios), or in a dissemination environment. It should be noted, too, that in any exchange scenario, the registry functions as a repository of structural metadata.
836 836  
837 -=== {{id name="_Toc93868"/}}7.2.2 Provisioning Agreement Model – pull use case ===
889 +===== {{id name="_Toc93868"/}}7.2.2 Provisioning Agreement Model – pull use case =====
838 838  
839 839  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.
840 840  
... ... @@ -856,9 +856,9 @@
856 856  
857 857  A Provision Agreement is structural metadata. Each Provision Agreement must reference a Data Provider or Metadata Provider and a Dataflow or Metadataflow Definition. The Data/Metadata Provider and the Dataflow/Metadataflow must exist already in order to set up a Metadata Provision or Provision Agreement.
858 858  
859 -== {{id name="_Toc93869"/}}7.3 Data and Metadata Constraints ==
911 +=== {{id name="_Toc93869"/}}7.3 Data and Metadata Constraints ===
860 860  
861 -=== {{id name="_Toc93870"/}}7.3.1 Data and Metadata Constraints: Basic Concepts ===
913 +===== {{id name="_Toc93870"/}}7.3.1 Data and Metadata Constraints: Basic Concepts =====
862 862  
863 863  Constraints are, effectively, lists of the valid or actual content of data and metadata. Constraints can be used to specify a subset of the theoretical content of data set or metadata set which can be derived from the specification of the DSD or MSD. A Constraint can comprise a list of keys or a list of content (usually code values) of a specific component such as a dimension or attribute.
864 864  
... ... @@ -922,14 +922,17 @@
922 922  
923 923  The Registration has an action attribute which takes one of the following values:
924 924  
977 +:
978 +
925 925  (((
926 -(% style="width:761.294px" %)
927 -|(% style="width:196px" %)**Action Attribute Value**|(% style="width:561px" %)**Behaviour**
928 -|(% style="width:196px" %)Append|(% style="width:561px" %)Add this Registration to the registry
929 -|(% style="width:196px" %)Replace|(% style="width:561px" %)(((
930 -Replace the existing Registration with identified by the id in the Registration of the SubmitRegistrationRequest
980 +|**Action Attribute Value**|**Behaviour**
981 +|Append|Add this Registration to the registry
982 +|Replace|(((
983 +Replace the existing Registration with identified by the id in the
984 +
985 +Registration of the SubmitRegistrationRequest
931 931  )))
932 -|(% style="width:196px" %)Delete|(% style="width:561px" %)Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest
987 +|Delete|Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest
933 933  )))
934 934  
935 935  [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_bc1dcdec.jpg||height="575" width="579"]]
... ... @@ -946,20 +946,27 @@
946 946  
947 947  Information in the data or metadata set is extracted and placed in one or more //Constraint//s (see the //Constraint// 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 ProvisionAgreement or MetadataProvisionAgreement as shown in the table below.
948 948  
1004 +:
1005 +
949 949  (((
950 -(% style="width:678.294px" %)
951 -|**Indexing Required**|(% style="width:504px" %)**Registration Process Activity**
952 -|indexTimeSeries|(% style="width:504px" %)Extract all the series keys and create a KeySet(s) Constraint.
953 -|indexDataSet|(% style="width:504px" %)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.
954 -|indexReportingPeriod|(% style="width:504px" %)(((
1007 +|**Indexing Required**|**Registration Process Activity**
1008 +|indexTimeSeries|Extract all the series keys and create a KeySet(s) Constraint.
1009 +|indexDataSet|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.
1010 +|indexReportingPeriod|(((
955 955  This applies only to a registered __dataset__.
1012 +
956 956  Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint.
957 957  )))
958 -|**Indexing Required**|(% style="width:504px" %)**Registration Process Activity**
959 -|indexAttributes|(% style="width:504px" %)(((
1015 +|**Indexing Required**|**Registration Process Activity**
1016 +|indexAttributes|(((
960 960  **Data Set**
961 -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
1018 +
1019 +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
1020 +
1021 +SDMXIM, and the associated Selection Value
1022 +
962 962  **Metadata Set**
1024 +
963 963  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.
964 964  )))
965 965  )))
... ... @@ -968,7 +968,7 @@
968 968  
969 969  The Registration must reference the ProvisionAgreement or MetadataProvisionAgreement to which it relates.
970 970  
971 -=== {{id name="_Toc93876"/}}7.4.3 Registration Response ===
1033 +===== {{id name="_Toc93876"/}}7.4.3 Registration Response =====
972 972  
973 973  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 SubmitRegistration class has a status field, which is either set to “Success”, “Warning” or “Failure”.
974 974  
... ... @@ -998,18 +998,20 @@
998 998  
999 999  Regardless of the type of registry/repository events being observed, a subscription always contains:
1000 1000  
1001 -1. 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.
1063 +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.
1002 1002  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.
1003 1003  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.
1004 1004  1. A selector which specifies which type of events are of interest. The set of event types is:
1005 1005  
1068 +:
1069 +::
1070 +
1006 1006  (((
1007 -(% style="width:856.294px" %)
1008 -|(% style="width:320px" %)**Event Type**|(% style="width:532px" %)**Comment**
1009 -|(% style="width:320px" %)STRUCTURAL_REPOSITORY_EVENTS|(% style="width:532px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1010 -|(% style="width:320px" %)DATA_REGISTRATION_EVENTS|(% style="width:532px" %)Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
1011 -|(% style="width:320px" %)METADATA_REGISTRATION_EVENTS|(% style="width:532px" %)Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
1012 -|(% style="width:320px" %)ALL_EVENTS|(% style="width:532px" %)All events of the specified EventType
1072 +|**Event Type**|**Comment**
1073 +|STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1074 +|DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
1075 +|METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
1076 +|ALL_EVENTS|All events of the specified EventType
1013 1013  )))
1014 1014  
1015 1015  === {{id name="_Toc93880"/}}7.5.3 Wildcard Facility ===
... ... @@ -1023,25 +1023,33 @@
1023 1023  Examples of wildcarded identifier components for an identified object type of Codelist are shown below:
1024 1024  
1025 1025  AgencyID = *
1090 +
1026 1026  Id = *
1092 +
1027 1027  Version = *
1028 1028  
1029 1029  This subscribes to all Codelists of all versions for all agencies.
1030 1030  
1031 1031  AgencyID = AGENCY1
1098 +
1032 1032  Id = CODELIST1
1100 +
1033 1033  Version = *
1034 1034  
1035 1035  This subscribes to all versions of Codelist CODELIST1 maintained by the agency AGENCY1.
1036 1036  
1037 1037  AgencyID = AGENCY1
1106 +
1038 1038  Id = *
1108 +
1039 1039  Version = *
1040 1040  
1041 1041  This subscribes to all versions of all Codelist objects maintained by the agency AGENCY1.
1042 1042  
1043 1043  AgencyID = *
1114 +
1044 1044  Id = CODELIST1
1116 +
1045 1045  Version = *
1046 1046  
1047 1047  This subscribes to all versions of Codelist CODELIST1 maintained by any agency.
... ... @@ -1068,14 +1068,15 @@
1068 1068  
1069 1069  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:
1070 1070  
1143 +:
1144 +
1071 1071  (((
1072 -(% style="width:1126.29px" %)
1073 -|(% style="width:382px" %)**Selector**|(% style="width:740px" %)**Comment**
1074 -|(% style="width:382px" %)DataProvider & MetadataProvider|(% style="width:740px" %)Any datasets or metadata sets registered by the specified data or metadata provider will activate the notification.
1075 -|(% style="width:382px" %)ProvisionAgreement & MetadataProvisionAgreement|(% style="width:740px" %)Any datasets or metadata sets registered for the agreement will activate the notification.
1076 -|(% style="width:382px" %)Dataflow & Metadataflow|(% style="width:740px" %)Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
1077 -|(% style="width:382px" %)DataStructureDefinition & MetadataStructureDefinition|(% style="width:740px" %)Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will activate the notification
1078 -|(% style="width:382px" %)Category|(% style="width:740px" %)Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category.
1146 +|**Selector**|**Comment**
1147 +|DataProvider & MetadataProvider|Any datasets or metadata sets registered by the specified data or metadata provider will activate the notification.
1148 +|ProvisionAgreement & MetadataProvisionAgreement|Any datasets or metadata sets registered for the agreement will activate the notification.
1149 +|Dataflow & Metadataflow|Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
1150 +|DataStructureDefinition & MetadataStructureDefinition|Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will activate the notification
1151 +|Category|Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category.
1079 1079  )))
1080 1080  
1081 1081  The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration.
... ... @@ -1107,6 +1107,12 @@
1107 1107  
1108 1108  The notification will contain the Registration.
1109 1109  
1110 -----
1183 +[[1>>path:#sdfootnote1anc||name="sdfootnote1sym"]] With semantic versioning, it is allowed to reference a range of artefacts, e.g., a DSD referencing a Codelist with version 1.2.3+ means all patch versions greater than 1.2.3. This means that deleting 1.2.4draft does not break integrity of the aforementioned DSD.
1111 1111  
1185 +[[2>>path:#sdfootnote2anc||name="sdfootnote2sym"]] 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. For example, a sub-agency of IMF is referred like this:
1186 +
1187 +IMF.SubAgency1
1188 +
1189 +[[3>>path:#sdfootnote3anc||name="sdfootnote3sym"]] Note that Codelist is also an EnumeratedList.
1190 +
1112 1112  {{putFootnotes/}}
SUZ.Methodology.Code.MethodologyClass[0]