Changes for page SDMX 3.0 Standards. Section 5. Registry Specification: Logical Functionality

Summary

• Page properties (2 modified, 0 added, 0 removed)
• Objects (0 modified, 0 added, 1 removed)
  • SUZ.Methodology.Code.MethodologyClass[0]

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
...	...	@@ -304,6 +304,7 @@
304	304	|(% style="width:188px" %)**Interface**|(% style="width:542px" %)**Behaviour**
305	305	|(% style="width:188px" %) |(% style="width:542px" %)(((
306	306	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	+
307	307	4) The semantic versioning rules in the SDMX documentation MUST be obeyed.
308	308	)))
309	309	|(% 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.
...	...	@@ -328,12 +328,14 @@
328	328
329	329	The table below shows the identification and related data attributes to be stored in a registry for objects that are one of:
330	330
331		-* //nnotable//
	332	+* //Annotable//
332	332	* //Identifiable//
333	333	* //Nameable//
334	334	* //Versionable//
335	335	* //Maintainable//
336	336
	338	+:
	339	+
337	337	(((
338	338	(% style="width:1052.29px" %)
339	339	|**Object Type**|(% style="width:241px" %)**Data Attributes**|(% style="width:156px" %)**Status**|**Data type**|(% style="width:457px" %)**Notes**
...	...	@@ -361,9 +361,9 @@
361	361
362	362	**Table 1: Common Attributes of Object Types**
363	363
364		-== {{id name="_Toc93856"/}}6.2 Unique identification of SDMX objects ==
	367	+=== {{id name="_Toc93856"/}}6.2 Unique identification of SDMX objects ===
365	365
366		-=== {{id name="_Toc93857"/}}6.2.1 Agencies and Metadata Providers ===
	369	+===== {{id name="_Toc93857"/}}6.2.1 Agencies and Metadata Providers =====
367	367
368	368	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.
369	369
...	...	@@ -740,7 +740,7 @@
740	740
741	741	=== {{id name="_Toc93862"/}}7.1 Structural Definition Metadata ===
742	742
743		-=== {{id name="_Toc93863"/}}7.1.1 Introduction ===
	746	+===== {{id name="_Toc93863"/}}7.1.1 Introduction =====
744	744
745	745	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.)
746	746
...	...	@@ -807,28 +807,31 @@
807	807
808	808	**Table 4: Table of Maintainable Artefacts for Structural Definition Metadata**
809	809
810		-=== {{id name="_Toc93864"/}}7.1.2 Item Scheme, Structure ===
	813	+===== {{id name="_Toc93864"/}}7.1.2 Item Scheme, Structure =====
811	811
812	812	The artefacts included in the structural definitions are:
813	813
814		-* 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)
815		-* All types of Enumerated List (ValueList){{footnote}}Note that Codelist is also an EnumeratedList.{{/footnote}}
816		-* All types of Structure (Data Structure Definition, Metadata Structure Definition)
817		-* All types of Structure Usage (Dataflow, Metadataflow)
	817	+• 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)
818	818
819		-=== {{id name="_Toc93865"/}}7.1.3 Structure Usage ===
	819	+• All types of Enumerated List (ValueList){{footnote}}Note that Codelist is also an EnumeratedList.{{/footnote}}
820	820
821		-==== 7.1.3.1 Structure Usage: Basic Concepts ====
	821	+• All types of Structure (Data Structure Definition, Metadata Structure Definition)
822	822
	823	+• All types of Structure Usage (Dataflow, Metadataflow)
	824	+
	825	+===== {{id name="_Toc93865"/}}7.1.3 Structure Usage =====
	826	+
	827	+**7.1.3.1 Structure Usage: Basic Concepts**
	828	+
823	823	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.
824	824
825		-==== 7.1.3.2 Structure Usage Schematic ====
	831	+**7.1.3.2 Structure Usage Schematic**
826	826
827	827	[[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_52097ab5.jpg||height="246" width="438"]]
828	828
829	829	**Figure 9: Schematic of Linking the Data and Metadata Flows to Categories and Structure Definitions**
830	830
831		-==== 7.1.3.3 Structure Usage Model ====
	837	+**7.1.3.3 Structure Usage Model**
832	832
833	833	[[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_302cc1a2.jpg||height="548" width="578"]]
834	834
...	...	@@ -844,9 +844,9 @@
844	844	* Categorisation to Dataflow and Category
845	845	* Categorisation to Metadataflow and Category
846	846
847		-== {{id name="_Toc93866"/}}7.2 Data and Metadata Provisioning ==
	853	+=== {{id name="_Toc93866"/}}7.2 Data and Metadata Provisioning ===
848	848
849		-=== {{id name="_Toc93867"/}}7.2.1 Provisioning Agreement: Basic concepts ===
	855	+===== {{id name="_Toc93867"/}}7.2.1 Provisioning Agreement: Basic concepts =====
850	850
851	851	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.
852	852
...	...	@@ -854,7 +854,7 @@
854	854
855	855	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.
856	856
857		-=== {{id name="_Toc93868"/}}7.2.2 Provisioning Agreement Model – pull use case ===
	863	+===== {{id name="_Toc93868"/}}7.2.2 Provisioning Agreement Model – pull use case =====
858	858
859	859	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.
860	860
...	...	@@ -876,9 +876,9 @@
876	876
877	877	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.
878	878
879		-== {{id name="_Toc93869"/}}7.3 Data and Metadata Constraints ==
	885	+=== {{id name="_Toc93869"/}}7.3 Data and Metadata Constraints ===
880	880
881		-=== {{id name="_Toc93870"/}}7.3.1 Data and Metadata Constraints: Basic Concepts ===
	887	+===== {{id name="_Toc93870"/}}7.3.1 Data and Metadata Constraints: Basic Concepts =====
882	882
883	883	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.
884	884
...	...	@@ -942,14 +942,17 @@
942	942
943	943	The Registration has an action attribute which takes one of the following values:
944	944
	951	+:
	952	+
945	945	(((
946		-(% style="width:761.294px" %)
947		-|(% style="width:196px" %)**Action Attribute Value**|(% style="width:561px" %)**Behaviour**
948		-|(% style="width:196px" %)Append|(% style="width:561px" %)Add this Registration to the registry
949		-|(% style="width:196px" %)Replace|(% style="width:561px" %)(((
950		-Replace the existing Registration with identified by the id in the Registration of the SubmitRegistrationRequest
	954	+|**Action Attribute Value**|**Behaviour**
	955	+|Append|Add this Registration to the registry
	956	+|Replace|(((
	957	+Replace the existing Registration with identified by the id in the
	958	+
	959	+Registration of the SubmitRegistrationRequest
951	951	)))
952		-|(% style="width:196px" %)Delete|(% style="width:561px" %)Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest
	961	+|Delete|Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest
953	953	)))
954	954
955	955	[[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_bc1dcdec.jpg||height="575" width="579"]]
...	...	@@ -966,20 +966,27 @@
966	966
967	967	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.
968	968
	978	+:
	979	+
969	969	(((
970		-(% style="width:678.294px" %)
971		-|**Indexing Required**|(% style="width:504px" %)**Registration Process Activity**
972		-|indexTimeSeries|(% style="width:504px" %)Extract all the series keys and create a KeySet(s) Constraint.
973		-|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.
974		-|indexReportingPeriod|(% style="width:504px" %)(((
	981	+|**Indexing Required**|**Registration Process Activity**
	982	+|indexTimeSeries|Extract all the series keys and create a KeySet(s) Constraint.
	983	+|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.
	984	+|indexReportingPeriod|(((
975	975	This applies only to a registered __dataset__.
	986	+
976	976	Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint.
977	977	)))
978		-|**Indexing Required**|(% style="width:504px" %)**Registration Process Activity**
979		-|indexAttributes|(% style="width:504px" %)(((
	989	+|**Indexing Required**|**Registration Process Activity**
	990	+|indexAttributes|(((
980	980	**Data Set**
981		-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
	992	+
	993	+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
	994	+
	995	+SDMXIM, and the associated Selection Value
	996	+
982	982	**Metadata Set**
	998	+
983	983	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.
984	984	)))
985	985	)))
...	...	@@ -988,7 +988,7 @@
988	988
989	989	The Registration must reference the ProvisionAgreement or MetadataProvisionAgreement to which it relates.
990	990
991		-=== {{id name="_Toc93876"/}}7.4.3 Registration Response ===
	1007	+===== {{id name="_Toc93876"/}}7.4.3 Registration Response =====
992	992
993	993	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”.
994	994
...	...	@@ -1018,18 +1018,20 @@
1018	1018
1019	1019	Regardless of the type of registry/repository events being observed, a subscription always contains:
1020	1020
1021		-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.
	1037	+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.
1022	1022	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.
1023	1023	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.
1024	1024	1. A selector which specifies which type of events are of interest. The set of event types is:
1025	1025
	1042	+:
	1043	+::
	1044	+
1026	1026	(((
1027		-(% style="width:856.294px" %)
1028		-|(% style="width:320px" %)**Event Type**|(% style="width:532px" %)**Comment**
1029		-|(% style="width:320px" %)STRUCTURAL_REPOSITORY_EVENTS|(% style="width:532px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1030		-|(% 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.
1031		-|(% 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.
1032		-|(% style="width:320px" %)ALL_EVENTS|(% style="width:532px" %)All events of the specified EventType
	1046	+|**Event Type**|**Comment**
	1047	+|STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
	1048	+|DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
	1049	+|METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
	1050	+|ALL_EVENTS|All events of the specified EventType
1033	1033	)))
1034	1034
1035	1035	=== {{id name="_Toc93880"/}}7.5.3 Wildcard Facility ===
...	...	@@ -1096,14 +1096,15 @@
1096	1096
1097	1097	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:
1098	1098
	1117	+:
	1118	+
1099	1099	(((
1100		-(% style="width:1126.29px" %)
1101		-|(% style="width:382px" %)**Selector**|(% style="width:740px" %)**Comment**
1102		-|(% 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.
1103		-|(% style="width:382px" %)ProvisionAgreement & MetadataProvisionAgreement|(% style="width:740px" %)Any datasets or metadata sets registered for the agreement will activate the notification.
1104		-|(% style="width:382px" %)Dataflow & Metadataflow|(% style="width:740px" %)Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
1105		-|(% 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
1106		-|(% 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.
	1120	+|**Selector**|**Comment**
	1121	+|DataProvider & MetadataProvider|Any datasets or metadata sets registered by the specified data or metadata provider will activate the notification.
	1122	+|ProvisionAgreement & MetadataProvisionAgreement|Any datasets or metadata sets registered for the agreement will activate the notification.
	1123	+|Dataflow & Metadataflow|Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
	1124	+|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
	1125	+|Category|Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category.
1107	1107	)))
1108	1108
1109	1109	The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration.
...	...	@@ -1135,6 +1135,12 @@
1135	1135
1136	1136	The notification will contain the Registration.
1137	1137
1138		-----
	1157	+[[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.
1139	1139
	1159	+[[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:
	1160	+
	1161	+IMF.SubAgency1
	1162	+
	1163	+[[3>>path:#sdfootnote3anc||name="sdfootnote3sym"]] Note that Codelist is also an EnumeratedList.
	1164	+
1140	1140	{{putFootnotes/}}

SUZ.Methodology.Code.MethodologyClass[0]