Skip to Content
Last modified by Artur on 2025/09/30 13:28
From version 22.7
edited by Helena
on 2025/06/08 16:55
Change comment: There is no comment for this version
To version 22.13
edited by Helena
on 2025/06/08 17:03
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -361,11 +361,9 @@
361 361  * Agencies registered in the top-level scheme can themselves maintain a single Agency Scheme. Agencies in these second-tier schemes can themselves maintain a single Agency Scheme and so on.
362 362  * The AgencyScheme has a fixed version, i.e., ‘1.0’, hence it is an exception from the Semantic Versioning that other Artefacts follow.
363 363  * There can be only one AgencyScheme maintained by any one Agency. It has a fixed id of AGENCIES.
364 +* The /hierarchy of Organisation is not inherited by Maintenance Agency – thus each Agency Scheme is a flat list of Maintenance Agencies.
365 +* The format of the agency identifier is agencyID.agencyID etc. The top-level agency in this identification mechanism is the agency registered in the SDMX agency scheme. In other words, SDMX is not a part of the hierarchical ID structure for agencies. However, SDMX is, itself, a maintenance agency and is contained in the top-level Agency Scheme.
364 364  
365 -• The /hierarchy of Organisation is not inherited by Maintenance Agency – thus each Agency Scheme is a flat list of Maintenance Agencies.
366 -
367 -• The format of the agency identifier is agencyID.agencyID etc. The top-level agency in this identification mechanism is the agency registered in the SDMX agency scheme. In other words, SDMX is not a part of the hierarchical ID structure for agencies. However, SDMX is, itself, a maintenance agency and is contained in the top-level Agency Scheme.
368 -
369 369  This supports a hierarchical structure of agencyID.
370 370  
371 371  An example is shown below.
... ... @@ -595,29 +595,29 @@
595 595  urn:sdmx.org.sdmx.infomodel.{package}.{classname}=
596 596  
597 597  (% style="width:1272.83px" %)
598 -|(% style="width:290px" %)**Classname**|(% style="width:649px" %)**Ending URN pattern**|(% style="width:332px" %)**Example**
599 -|(% style="width:290px" %)Agency^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^|(% style="width:649px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|(% style="width:332px" %)ECB:**AGENCIES**(**1.0**).AA
600 -|(% style="width:290px" %)//AgencyScheme//|(% style="width:649px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**)|(% style="width:332px" %)ECB:**AGENCIES**(**1.0**)
601 -|(% style="width:290px" %)//Categorisation//|(% style="width:649px" %)categorisationAgencyId:categorisationId(version)|(% style="width:332px" %)IMF:cat001(1.0.0)
602 -|(% style="width:290px" %)Category|(% style="width:649px" %)categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|(% style="width:332px" %)IMF:SDDS(1.0.0):level_1_category.level_2_category …
603 -|(% style="width:290px" %)//CategoryScheme//|(% style="width:649px" %)categorySchemeAgencyId:categorySchemeId(versi on)|(% style="width:332px" %)IMF:SDDS(1.0.0)
596 +|(% style="width:289px" %)**Classname**|(% style="width:600px" %)**Ending URN pattern**|(% style="width:383px" %)**Example**
597 +|(% style="width:289px" %)Agency{{footnote}}The object must be linked to a maintenance organisation, i.e., Agency or Metadata Provider.{{/footnote}}|(% style="width:600px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|(% style="width:383px" %)ECB:**AGENCIES**(**1.0**).AA
598 +|(% style="width:289px" %)//AgencyScheme//|(% style="width:600px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**)|(% style="width:383px" %)ECB:**AGENCIES**(**1.0**)
599 +|(% style="width:289px" %)//Categorisation//|(% style="width:600px" %)categorisationAgencyId:categorisationId(version)|(% style="width:383px" %)IMF:cat001(1.0.0)
600 +|(% style="width:289px" %)Category|(% style="width:600px" %)categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|(% style="width:383px" %)IMF:SDDS(1.0.0):level_1_category.level_2_category …
601 +|(% style="width:289px" %)//CategoryScheme//|(% style="width:600px" %)categorySchemeAgencyId:categorySchemeId(versi on)|(% style="width:383px" %)IMF:SDDS(1.0.0)
604 604  
605 -|(% style="width:292px" %)**Classname**|(% style="width:647px" %)**Ending URN pattern**|(% style="width:742px" %)**Example**
606 -|(% style="width:292px" %)//CategorySchemeMap//|(% style="width:647px" %)(((
603 +|(% style="width:292px" %)**Classname**|(% style="width:595px" %)**Ending URN pattern**|(% style="width:794px" %)**Example**
604 +|(% style="width:292px" %)//CategorySchemeMap//|(% style="width:595px" %)(((
607 607  catSchemeMapAgencyId:catSchemeMapId(version)
608 -)))|(% style="width:742px" %)SDMX:EUROSTAT_SUBJECT_DOMAIN(1.0.0)
609 -|(% style="width:292px" %)Code|(% style="width:647px" %)codeListAgencyId:codelistId(version).codeId|(% style="width:742px" %)SDMX:CL_FREQ(1.0.0).Q
610 -|(% style="width:292px" %)//Codelist//|(% style="width:647px" %)codeListAgencyId:codeListId(version)|(% style="width:742px" %)SDMX:CL_FREQ(1.0.0)
611 -|(% style="width:292px" %)ComponentMap|(% style="width:647px" %)structureMapAgencyId:structureMap(version).com ponentMapId|(% style="width:742px" %)SDMX:BOP_STRUCTURES(1.0.0).REF_AREA_TO_COUNT RY
612 -|(% style="width:292px" %)Concept|(% style="width:647px" %)conceptSchemeAgencyId:conceptSchemeId(versio n).conceptId|(% style="width:742px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0).FREQ
613 -|(% style="width:292px" %)//ConceptScheme//|(% style="width:647px" %)conceptSchemeAgencyId:conceptSchemeId(versio n)|(% style="width:742px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0)
614 -|(% style="width:292px" %)//ConceptSchemeMap//|(% style="width:647px" %)(((
606 +)))|(% style="width:794px" %)SDMX:EUROSTAT_SUBJECT_DOMAIN(1.0.0)
607 +|(% style="width:292px" %)Code|(% style="width:595px" %)codeListAgencyId:codelistId(version).codeId|(% style="width:794px" %)SDMX:CL_FREQ(1.0.0).Q
608 +|(% style="width:292px" %)//Codelist//|(% style="width:595px" %)codeListAgencyId:codeListId(version)|(% style="width:794px" %)SDMX:CL_FREQ(1.0.0)
609 +|(% style="width:292px" %)ComponentMap|(% style="width:595px" %)structureMapAgencyId:structureMap(version).com ponentMapId|(% style="width:794px" %)SDMX:BOP_STRUCTURES(1.0.0).REF_AREA_TO_COUNT RY
610 +|(% style="width:292px" %)Concept|(% style="width:595px" %)conceptSchemeAgencyId:conceptSchemeId(versio n).conceptId|(% style="width:794px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0).FREQ
611 +|(% style="width:292px" %)//ConceptScheme//|(% style="width:595px" %)conceptSchemeAgencyId:conceptSchemeId(versio n)|(% style="width:794px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0)
612 +|(% style="width:292px" %)//ConceptSchemeMap//|(% style="width:595px" %)(((
615 615  conceptSchemeMapAgencyId:conceptSchemeMap Id(version)
616 -)))|(% style="width:742px" %)SDMX:CONCEPT_MAP(1.0.0)
617 -|(% style="width:292px" %)CustomType|(% style="width:647px" %)customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|(% style="width:742px" %)ECB: CUSTOM_TYPE_SCHEME(1.0.0).CUSTOM_TYPE_1
618 -|(% style="width:292px" %)//CustomTypeScheme//|(% style="width:647px" %)customTypeSchemeAgencyId customTypeSchemeId(version)|(% style="width:742px" %)ECB:CUSTOM_TYPE_SCHEME(1.0.0)
619 -|(% style="width:292px" %)DataAttrribute|(% style="width:647px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dataAttributeId|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0).OBS_STATUS
620 -|(% style="width:292px" %)//DataConstraint//|(% style="width:647px" %)dataConstraintAgencyId:dataConstraintId(version)|(% style="width:742px" %)TFFS:CREDITOR_DATA_CONTENT(1.0.0)
614 +)))|(% style="width:794px" %)SDMX:CONCEPT_MAP(1.0.0)
615 +|(% style="width:292px" %)CustomType|(% style="width:595px" %)customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|(% style="width:794px" %)ECB: CUSTOM_TYPE_SCHEME(1.0.0).CUSTOM_TYPE_1
616 +|(% style="width:292px" %)//CustomTypeScheme//|(% style="width:595px" %)customTypeSchemeAgencyId customTypeSchemeId(version)|(% style="width:794px" %)ECB:CUSTOM_TYPE_SCHEME(1.0.0)
617 +|(% style="width:292px" %)DataAttrribute|(% style="width:595px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dataAttributeId|(% style="width:794px" %)TFFS:EXT_DEBT(1.0.0).OBS_STATUS
618 +|(% style="width:292px" %)//DataConstraint//|(% style="width:595px" %)dataConstraintAgencyId:dataConstraintId(version)|(% style="width:794px" %)TFFS:CREDITOR_DATA_CONTENT(1.0.0)
621 621  
622 622  |(% style="width:294px" %)**Classname**|(% style="width:645px" %)**Ending URN pattern**|(% style="width:742px" %)**Example**
623 623  |(% style="width:294px" %)DataConsumer|(% style="width:645px" %)dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**).dataConsumerId|(% style="width:742px" %)SDMX:**DATA_CONSUMERS**(**1.0**).CONSUMER_1
... ... @@ -718,7 +718,7 @@
718 718  |(% style="width:297px" %)VtlDataflowMapping|(% style="width:647px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|(% style="width:737px" %)ECB:CLIST_MP(1.0.0).MOQ
719 719  |(% style="width:297px" %)//VtlMappingScheme//|(% style="width:647px" %)vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|(% style="width:737px" %)ECB:CLIST_MP(2.0.0)
720 720  
721 -5**Table 3: Table of identification components for SDMX Identifiable Artefacts**
719 +**Table 3: Table of identification components for SDMX Identifiable Artefacts**
722 722  
723 723  = 7 Implementation Notes =
724 724  
... ... @@ -801,7 +801,7 @@
801 801  The artefacts included in the structural definitions are:
802 802  
803 803  * 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)
804 -* All types of Enumerated List (ValueList)^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]](%%)^^
802 +* All types of Enumerated List (ValueList){{footnote}}Note that Codelist is also an EnumeratedList.{{/footnote}}
805 805  * All types of Structure (Data Structure Definition, Metadata Structure Definition)
806 806  * All types of Structure Usage (Dataflow, Metadataflow)
807 807  
... ... @@ -825,15 +825,13 @@
825 825  
826 826  In addition to the maintenance of the Dataflow and the Metadataflow, the following links must be maintained in the registry:
827 827  
828 -1.
829 -1*. Dataflow to Data Structure Definition
830 -1*. Metadataflow to Metadata Structure Definition
826 +* Dataflow to Data Structure Definition
827 +* Metadataflow to Metadata Structure Definition
831 831  
832 832  The following links may be created by means of a Categorisation
833 833  
834 -1.
835 -1*. Categorisation to Dataflow and Category
836 -1*. Categorisation to Metadataflow and Category
831 +* Categorisation to Dataflow and Category
832 +* Categorisation to Metadataflow and Category
837 837  
838 838  == 7.2 Data and Metadata Provisioning ==
839 839  
... ... @@ -871,17 +871,17 @@
871 871  
872 872  === 7.3.1 Data and Metadata Constraints: Basic Concepts ===
873 873  
874 -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.
870 +(% style="color:#e74c3c" %)Constraints(%%) are, effectively, lists of the valid or actual content of data and metadata. (% style="color:#e74c3c" %)Constraints(%%) can be used to specify a subset of the theoretical content of [[data set>>doc:sdmx:Glossary.Data set.WebHome]] or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] which can be derived from the specification of the [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] or [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. A (% style="color:#e74c3c" %)Constraint(%%) can comprise a list of keys or a list of content (usually [[code>>doc:sdmx:Glossary.Code.WebHome]] values) of a specific [[component>>doc:sdmx:Glossary.Component.WebHome]] such as a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].
875 875  
876 -Constraints comprise the specification of subsets of key or attribute values that are to be provided for a Dataflow or Metadataflow, or directly attached to a Data Structure Definition or Metadata Structure Definition. This is important metadata because, for example, the full range of possibilities which is implied by the Data Structure Definition (e.g., the complete set of valid keys is the Cartesian product of all the values in the code lists for each of the Dimensions) is often more than is intended to be supplied according to a specific Dataflow.
872 +(% style="color:#e74c3c" %)Constraints(%%) comprise the specification of subsets of key or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values that are to be provided for a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] or [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]], or directly attached to a [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] or [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. This is important metadata because, for example, the full range of possibilities which is implied by the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] (e.g., the complete set of valid keys is the Cartesian product of all the values in the [[code lists>>doc:sdmx:Glossary.Code list.WebHome]] for each of the [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]) is often more than is intended to be supplied according to a specific [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]].
877 877  
878 -Often a Data Provider will not be able to provide data for all key combinations, either because the combination itself is not meaningful, or simply because the provider does not have the data for that combination. In this case the Data Provider could constrain the data source (at the level of the Provision Agreement or the Data Provider) by supplying metadata that defines the key combinations or cube regions that are available. This is done by means of a Constraint. The Constraint is also used to define a code list subset which is used to populate a partial code list, and in generating a schema for data reporters to validate their datasets against.
874 +Often a [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] will not be able to provide data for all key combinations, either because the combination itself is not meaningful, or simply because the provider does not have the data for that combination. In this case the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] could constrain the [[data source>>doc:sdmx:Glossary.Data source.WebHome]] (at the (% style="color:#e74c3c" %)level(%%) of the [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] or the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]]) by supplying metadata that defines the key combinations or cube regions that are available. This is done by means of a (% style="color:#e74c3c" %)Constraint(%%). The (% style="color:#e74c3c" %)Constraint(%%) is also used to define a [[code list>>doc:sdmx:Glossary.Code list.WebHome]] subset which is used to populate a partial [[code list>>doc:sdmx:Glossary.Code list.WebHome]], and in generating a schema for data reporters to validate their [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] against.
879 879  
880 -Furthermore, it is often useful to define subsets or views of the Data Structure Definition which restrict values in some code lists, especially where many such subsets restrict the same Data Structure Definition. Such a view is called a Dataflow, and there can be one or more defined for any Data Structure Definition.
876 +Furthermore, it is often useful to define subsets or views of the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] which restrict values in some [[code lists>>doc:sdmx:Glossary.Code list.WebHome]], especially where many such subsets restrict the same [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. Such a view is called a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], and there can be one or more defined for any [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]].
881 881  
882 -Whenever data is published or made available by a Data Provider, it must conform to a Dataflow (and hence to a Data Structure Definition). The Dataflow is thus a means of enabling content based processing.
878 +Whenever data is published or made available by a [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]], it must conform to a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] (and hence to a [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]). The [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] is thus a means of enabling content based processing.
883 883  
884 -In addition, DataAvailabilityConstraints can be extremely useful in a data visualisation system, such as dissemination of statistics on a website. In such a system a Cube Region can be used to specify the Dimension codes that actually exist in a data source (these can be used to build relevant selection tables).
880 +In addition, DataAvailabilityConstraints can be extremely useful in a data visualisation system, such as dissemination of statistics on a website. In such a system a Cube Region can be used to specify the [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] [[codes>>doc:sdmx:Glossary.Code.WebHome]] that actually exist in a [[data source>>doc:sdmx:Glossary.Data source.WebHome]] (these can be used to build relevant selection tables).
885 885  
886 886  === 7.3.2 Data and Metadata Constraints: Schematic ===
887 887  
... ... @@ -895,27 +895,27 @@
895 895  
896 896  **Figure 15: Logical class diagram showing inheritance between and reference to constrainable artefacts**
897 897  
898 -Logical class diagram showing inheritance between and reference to constrainable artefacts
894 +Logical class diagram showing inheritance between and reference to constrainable artefacts.
899 899  
900 -The class diagram above shows that Data Provider, Metadata Provider, Dataflow, Metadataflow, Provision Agreement, Metadata Provision Agreement, Data Structure
896 +The class diagram above shows that [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]], Metadata Provider, [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]], [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], Metadata [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], Data Structure.
901 901  
902 -Definition, Metadata Structure Definition are all concrete sub-classes of Constrainable Artefact and can therefore have Data Constraints specified. Note that the actual Constraint as submitted is associated to the reference classes defines in the Constraint Attachment.
898 +Definition, [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] are all concrete sub-classes of Constrainable [[Artefact>>doc:sdmx:Glossary.Artefact.WebHome]] and can therefore have Data (% style="color:#e74c3c" %)Constraints(%%) specified. Note that the actual (% style="color:#e74c3c" %)Constraint(%%) as submitted is associated to the reference classes defines in the (% style="color:#e74c3c" %)Constraint(%%) Attachment.
903 903  
904 -these are used to refer to the classes to which the Constraint applies.
900 +these are used to refer to the classes to which the (% style="color:#e74c3c" %)Constraint(%%) applies.
905 905  
906 -The content of the Constraint can be found in the SDMX Information Model document.
902 +The content of the (% style="color:#e74c3c" %)Constraint(%%) can be found in the [[SDMX Information Model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]] document.
907 907  
908 908  == 7.4 Data Registration ==
909 909  
910 910  === 7.4.1 Basic Concepts ===
911 911  
912 -A Data Provider has published a new dataset conforming to an existing Dataflow (and hence Data Structure Definition). This is implemented as either a web-accessible SDMXML file, or in a database which has a web-services interface capable of responding to an SDMX RESTful query with an SDMX-ML data stream.
908 +A [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] has published a new [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] conforming to an existing [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] (and hence [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]). This is implemented as either a web-accessible SDMXML file, or in a database which has a web-services interface capable of responding to an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful query with an [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] data stream.
913 913  
914 -The Data Provider wishes to make this new data available to one or more data collectors in a “pull” scenario, or to make the data available to data consumers. To do this, the Data Provider registers the new dataset with one or more SDMX conformant registries that have been configured with structural and provisioning metadata. In other words, the registry “knows” the Data Provider and “knows” what data flows the data provider has agreed to make available.
910 +The [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] wishes to make this new data available to one or more data collectors in a “pull” scenario, or to make the data available to [[data consumers>>doc:sdmx:Glossary.Data consumer.WebHome]]. To do this, the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] registers the new [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] with one or more [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] conformant registries that have been configured with structural and provisioning metadata. In other words, the registry “knows” the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] and “knows” what [[data flows>>doc:sdmx:Glossary.Dataflow.WebHome]] the [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] has agreed to make available.
915 915  
916 916  The same mechanism can be used to report or make available a metadata set.
917 917  
918 -SDMX-RR supports dataset registration via the Registration Request, which can be created by the Data Provider (giving the Data Provider maximum control). The registry responds to the registration request with a registration response which indicates if the registration was successful. In the event of an error, the error messages are returned as a registry exception within the response.
914 +[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-RR supports [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] registration via the Registration Request, which can be created by the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] (giving the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] maximum control). The registry responds to the registration request with a registration response which indicates if the registration was successful. In the event of an error, the error messages are returned as a registry exception within the response.
919 919  
920 920  === 7.4.2 The Registration Request ===
921 921  
... ... @@ -927,7 +927,7 @@
927 927  
928 928  ==== 7.4.2.2 Registration Request Model ====
929 929  
930 -The following UML diagram shows the composition of the registration request. Each request is made up of one or more Registrations, one per dataset to be registered. The Registration can optionally have information, which has been extracted from the Registration:
926 +The following UML diagram shows the composition of the registration request. Each request is made up of one or more Registrations, one per [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] to be registered. The Registration can optionally have information, which has been extracted from the Registration:
931 931  
932 932  * validFrom
933 933  * validTo
... ... @@ -935,7 +935,7 @@
935 935  
936 936  The last updated date is useful during the discovery process to make sure the client knows which data is freshest.
937 937  
938 -The Registration has an action attribute which takes one of the following values:
934 +The Registration has an action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] which takes one of the following values:
939 939  
940 940  (((
941 941  |(% style="width:224px" %)**Action Attribute Value**|(% style="width:1457px" %)**Behaviour**
... ... @@ -948,15 +948,15 @@
948 948  
949 949  **Figure 17: Logical Class Diagram of Registration of Data and Metadata**
950 950  
951 -The //QueryDatasource// is an abstract class that represents a data source, which can understand an API query (i.e., a RESTful query – RESTDatasource) and respond appropriately. Each data source inherits the dataURL from //Datasource//, and the //QueryDatasource// has an additional URL to locate the specification of the service (specURL) to describe how to access it. All other supported protocols are assumed to use the SimpleDatasource URL.
947 +The //QueryDatasource// is an abstract class that represents a [[data source>>doc:sdmx:Glossary.Data source.WebHome]], which can understand an API query (i.e., a RESTful query – RESTDatasource) and respond appropriately. Each [[data source>>doc:sdmx:Glossary.Data source.WebHome]] inherits the dataURL from //Datasource//, and the //QueryDatasource// has an additional URL to locate the specification of the service (specURL) to describe how to access it. All other supported protocols are assumed to use the SimpleDatasource URL.
952 952  
953 -A SimpleDatasource is used to reference a physical SDMX-ML file that is available at a URL.
949 +A SimpleDatasource is used to reference a physical [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] file that is available at a URL.
954 954  
955 -The RegistrationRequest has an action attribute which defines whether this is a new (append) or updated (replace) Registration, or that the Registration is to be deleted (delete). The id is only provided for the replace and delete actions, as the Registry will allocate the unique id of the (new) Registration.
951 +The RegistrationRequest has an action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] which defines whether this is a new (append) or updated (replace) Registration, or that the Registration is to be deleted (delete). The id is only provided for the replace and delete actions, as the Registry will allocate the unique id of the (new) Registration.
956 956  
957 -The Registration includes attributes that state how a SimpleDatasource is to be indexed when registered. The Registry registration process must act as follows:
953 +The Registration includes [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] that state how a SimpleDatasource is to be indexed when registered. The Registry registration process must act as follows:
958 958  
959 -Information in the dataset is extracted and made available via the availability REST API as documented here:
955 +Information in the [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] is extracted and made available via the availability REST API as documented here:
960 960  
961 961  https:~/~/github.com/sdmx-twg/sdmx-rest/blob/master/doc/availability.md
962 962  
... ... @@ -963,24 +963,24 @@
963 963  (((
964 964  (% style="width:918.835px" %)
965 965  |**Indexing Required**|(% style="width:745px" %)**Registration Process Activity**
966 -|indexTimeSeries|(% style="width:745px" %)Extract all the series keys and create a KeySet(s) Constraint.
967 -|indexDataSet|(% style="width:745px" %)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.
962 +|indexTimeSeries|(% style="width:745px" %)Extract all the [[series keys>>doc:sdmx:Glossary.Series key.WebHome]] and create a KeySet(s) Constraint.
963 +|indexDataSet|(% style="width:745px" %)Extract all the [[codes>>doc:sdmx:Glossary.Code.WebHome]] and other content of the Key value of the [[Series Key>>doc:sdmx:Glossary.Series key.WebHome]] in a [[Data Set>>doc:sdmx:Glossary.Data set.WebHome]] and create one or more Cube Regions containing [[Member Selections>>doc:sdmx:Glossary.Member selection.WebHome]] of [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] [[Components>>doc:sdmx:Glossary.Component.WebHome]] of the (% style="color:#e74c3c" %)Constraints(%%) model in the [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]], and the associated Selection Value.
968 968  |indexReportingPeriod|(% style="width:745px" %)(((
969 -This applies only to a registered __dataset__.
970 -Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint.
965 +This applies only to a registered __[[dataset>>doc:sdmx:Glossary.Data set.WebHome]]__.
966 +Extract the Reporting Begin and Reporting End from the Header of the Message containing the [[data set>>doc:sdmx:Glossary.Data set.WebHome]], and create a [[Reference Period>>doc:sdmx:Glossary.Reference period.WebHome]] constraint.
971 971  )))
972 972  |indexAttributes|(% style="width:745px" %)(((
973 973  **Data Set**
974 -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
970 +Extract the content of the [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Values in a [[Data Set>>doc:sdmx:Glossary.Data set.WebHome]] and create one or more Cube Regions containing [[Member Selections>>doc:sdmx:Glossary.Member selection.WebHome]] of Data [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] [[Components>>doc:sdmx:Glossary.Component.WebHome]] of the (% style="color:#e74c3c" %)Constraints(%%) model in the SDMXIM, and the associated Selection Value
975 975  
976 976  **Metadata Set**
977 -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
973 +Indicate the presence of a Reported [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] by creating one or more Cube Regions containing [[Member Selections>>doc:sdmx:Glossary.Member selection.WebHome]] of Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] [[Components>>doc:sdmx:Glossary.Component.WebHome]] of the (% style="color:#e74c3c" %)Constraints(%%) model in the
978 978  )))
979 979  |**Indexing Required**|(% style="width:745px" %)**Registration Process Activity**
980 -| |(% style="width:745px" %)SDMX-IM. Note that the content is not stored in the Selection Value.
976 +| |(% style="width:745px" %)[[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]. Note that the content is not stored in the Selection Value.
981 981  )))
982 982  
983 -Constraints that specify the contents of a //QueryDatasource// are submitted to the Registry via the structure submission service (i.e., the RESTful API).
979 +(% style="color:#e74c3c" %)Constraints(%%) that specify the contents of a //QueryDatasource// are submitted to the Registry via the structure submission service (i.e., the RESTful API).
984 984  
985 985  The Registration must reference the ProvisionAgreement to which it relates.
986 986  
... ... @@ -988,9 +988,9 @@
988 988  
989 989  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”.
990 990  
991 -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 or query service.
987 +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>>doc:sdmx:Glossary.Data set.WebHome]] or query service.
992 992  
993 -The RegistrationResponse returns set of registration status (one for each registration submitted) in terms of a StatusMessage (this is common to all Registry responses) that indicates success or failure. In the event of registration failure, a set of MessageText 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 RegistrationResponse is shown below:
989 +The RegistrationResponse returns set of registration status (one for each registration submitted) in terms of a StatusMessage (this is common to all Registry responses) that indicates success or failure. In the event of registration failure, a set of MessageText are returned, giving the error messages that occurred during registration. It is entirely possible when registering a batch of [[datasets>>doc:sdmx:Glossary.Data set.WebHome]], that the response will contain some successful and some failed statuses. The logical model for the RegistrationResponse is shown below:
994 994  
995 995  [[image:SDMX 3.1 Section 5_en_cdba03b5.jpg||height="371" width="579"]]
996 996  
... ... @@ -998,11 +998,11 @@
998 998  
999 999  == 7.5 Subscription and Notification Service ==
1000 1000  
1001 -The contents of the SDMX Registry/Repository will change regularly: new code lists and key families will be published and new datasets and metadata-sets will be registered. To obviate the need for users to repeatedly query the registry to see when new information is available, a mechanism is provided to allow users to be notified when these events happen.
997 +The contents of the [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]]/Repository will change regularly: new [[code lists>>doc:sdmx:Glossary.Code list.WebHome]] and key families will be published and new [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] and metadata-sets will be registered. To obviate the need for users to repeatedly query the registry to see when new information is available, a mechanism is provided to allow users to be notified when these events happen.
1002 1002  
1003 -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.
999 +A user can submit a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] in the registry that defines which events are of interest, and either an email and/or an HTTP address to which a [[notification>>doc:sdmx:Glossary.Notification.WebHome]] of qualifying events will be delivered. The [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] will be identified in the registry by a URN, which is returned to the user when the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] is created. If the user wants to delete the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] at a later point, the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] URN is used as identification. [[Subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] have a validity period expressed as a date range (startDate, endDate) and the registry may delete any expired [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]], and will notify the subscriber on expiry.
1004 1004  
1005 -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”.
1001 +When a registry/repository [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is modified, any [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] 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>>doc:sdmx:Glossary.Subscription.WebHome]]. This is called a “[[notification>>doc:sdmx:Glossary.Notification.WebHome]]”.
1006 1006  
1007 1007  === 7.5.1 Subscription Logical Class Diagram ===
1008 1008  
... ... @@ -1012,19 +1012,19 @@
1012 1012  
1013 1013  === 7.5.2 Subscription Information ===
1014 1014  
1015 -Regardless of the type of registry/repository events being observed, a subscription always contains:
1011 +Regardless of the type of registry/repository events being observed, a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] always contains:
1016 1016  
1017 -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.
1018 -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.
1019 -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.
1013 +1. A set of URIs describing the end-points to which [[notifications>>doc:sdmx:Glossary.Notification.WebHome]] must be sent if the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] is activated. The URIs can be either mailto~: or http: protocol. In the former case an email [[notification>>doc:sdmx:Glossary.Notification.WebHome]] is sent; in the latter an HTTP POST [[notification>>doc:sdmx:Glossary.Notification.WebHome]] is sent.
1014 +1. A user-defined identifier, which is returned in the response to the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request. This helps with asynchronous processing and is NOT stored in the Registry.
1015 +1. A validity period which defines both when the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] becomes active and expires. The subscriber may be sent a [[notification>>doc:sdmx:Glossary.Notification.WebHome]] on expiration of the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]].
1020 1020  1. A selector which specifies which type of events are of interest. The set of event types is:
1021 1021  
1022 1022  (((
1023 1023  (% style="width:1061.83px" %)
1024 1024  |**Event Type**|(% style="width:660px" %)**Comment**
1025 -|STRUCTURAL_REPOSITORY_EVENTS|(% style="width:660px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1026 -|DATA_REGISTRATION_EVENTS|(% style="width:660px" %)Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
1027 -|METADATA_REGISTRATION_EVENTS|(% style="width:660px" %)Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
1021 +|STRUCTURAL_REPOSITORY_EVENTS|(% style="width:660px" %)Life-cycle changes to [[Maintainable Artefacts>>doc:sdmx:Glossary.Maintainable artefact.WebHome]] in the [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository.
1022 +|DATA_REGISTRATION_EVENTS|(% style="width:660px" %)Whenever a published [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] is registered. This can be either a SDMXML data file or an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] conformant database.
1023 +|METADATA_REGISTRATION_EVENTS|(% style="width:660px" %)Whenever a published metadataset is registered. This can be either a SDMXML [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] file or an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] conformant database.
1028 1028  |ALL_EVENTS|(% style="width:660px" %)All events of the specified EventType
1029 1029  )))
1030 1030  
... ... @@ -1086,20 +1086,20 @@
1086 1086  
1087 1087  === 7.5.4 Structural Repository Events ===
1088 1088  
1089 -Whenever a maintainable artefact (data structure definition, concept scheme, codelist, metadata structure definition, category scheme, etc.) is added to, deleted from, or modified in the structural metadata repository, a structural metadata event is triggered. Subscriptions may be set up to monitor all such events, or focus on specific artefacts such as a Data Structure Definition.
1085 +Whenever a [[maintainable artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]] ([[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]], codelist, [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]], etc.) is added to, deleted from, or modified in the [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, a [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] event is triggered. [[Subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] may be set up to monitor all such events, or focus on specific [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] such as a [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]].
1090 1090  
1091 1091  === 7.5.5 Registration Events ===
1092 1092  
1093 -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:
1089 +Whenever a [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] or metadata-set is registered a registration event is created. A [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] may be observing all data or metadata registrations, or it may focus on specific registrations as shown in the table below:
1094 1094  
1095 1095  (((
1096 1096  (% style="width:1082.83px" %)
1097 1097  |(% style="width:230px" %)**Selector**|(% style="width:850px" %)**Comment**
1098 -|(% style="width:230px" %)DataProvider|(% style="width:850px" %)Any datasets registered by the specified dataprovider will activate the notification.
1099 -|(% style="width:230px" %)ProvisionAgreement|(% style="width:850px" %)Any datasets for the agreement will activate the notification.
1100 -|(% style="width:230px" %)Dataflow|(% style="width:850px" %)Any datasets for the specified dataflow will activate the notification.
1101 -|(% style="width:230px" %)DataStructureDefinition|(% style="width:850px" %)Any datasets for those dataflows that are based on the specified Data Structure Definition will activate the notification
1102 -|(% style="width:230px" %)Category|(% style="width:850px" %)Any datasets registered for those dataflows, provision agreements that are categorised by the category.
1094 +|(% style="width:230px" %)DataProvider|(% style="width:850px" %)Any [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] registered by the specified dataprovider will activate the notification.
1095 +|(% style="width:230px" %)ProvisionAgreement|(% style="width:850px" %)Any [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] for the agreement will activate the notification.
1096 +|(% style="width:230px" %)[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]|(% style="width:850px" %)Any [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] for the specified [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] will activate the notification.
1097 +|(% style="width:230px" %)DataStructureDefinition|(% style="width:850px" %)Any [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] for those [[dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]] that are based on the specified [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] will activate the notification
1098 +|(% style="width:230px" %)Category|(% style="width:850px" %)Any [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] registered for those [[dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]], [[provision agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]] that are categorised by the category.
1103 1103  )))
1104 1104  
1105 1105  The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration.
... ... @@ -1133,10 +1133,4 @@
1133 1133  
1134 1134  ----
1135 1135  
1136 -[[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:
1137 -
1138 -IMF.SubAgency1
1139 -
1140 -[[3>>path:#sdfootnote3anc||name="sdfootnote3sym"]] Note that Codelist is also an EnumeratedList.
1141 -
1142 1142  {{putFootnotes/}}