Changes for page SDMX 2.1 Standards. Section 5. Registry Specification: Logical Interfaces

Summary

• Page properties (1 modified, 0 added, 0 removed)
• Attachments (0 modified, 0 added, 3 removed)
  • 1747829477882-750.png
  • 1747829554603-150.png
  • 1747829675568-610.png

Details

Page properties

Content

...	...	@@ -4,11 +4,10 @@
4	4
5	5	**Revision History**
6	6
7		-(% style="width:833.294px" %)
8		-|(% style="width:122px" %)**Revision**|(% style="width:126px" %)**Date**|(% style="width:581px" %)**Contents**
9		-|(% style="width:122px" %) |(% style="width:126px" %)April 2011|(% style="width:581px" %)Initial release
10		-|(% style="width:122px" %)1.0|(% style="width:126px" %)July 2011|(% style="width:581px" %)Rectification of problems of the specifications dated April 2011
11		-|(% style="width:122px" %)2.0|(% style="width:126px" %)July 2020|(% style="width:581px" %)Addition of VTL (Validation and Transformation Language) package, maintainable artefacts, nameable artefacts to 5.2.3, 6.2.2, 6.2.3, 6.2.4, 7.1.1
	7	+|**Revision**|**Date**|**Contents**
	8	+| |April 2011|Initial release
	9	+|1.0|July 2011|Rectification of problems of the specifications dated April 2011
	10	+|2.0|July 2020|Addition of VTL (Validation and Transformation Language) package, maintainable artefacts, nameable artefacts to 5.2.3, 6.2.2, 6.2.3, 6.2.4, 7.1.1
12	12
13	13	**Corrigendum**
14	14
...	...	@@ -289,22 +289,27 @@
289	289	* that a queryable data source exists - this would necessitate the registration service querying the service to determine its existence
290	290	* that a simple data source exists (i.e. a file accessible at a URL)
291	291	* that the correct Data Structure Definition or Metadata Structure Definition is used by the registered data that the components (Dimensions, Attributes, Measures, Identifier Components etc.) are consistent with the Data Structure Definition or Metadata Structure Definition
292		-* that the valid representations of the concepts to which these components correspond conform to the definition in the Data Structure Definition or Metadata Structure Definition
	291	+*  that the valid representations of the concepts to which these components 382 correspond conform to the definition in the Data Structure Definition or Metadata Structure Definition
293	293
294		-The Registration has an action attribute which takes one of the following values:
	293	+3The Registration has an action attribute which takes one of the following values:
295	295
296		-|(% style="width:219px" %)**Action Attribute Value**|(% style="width:1652px" %)**Behaviour**
297		-|(% style="width:219px" %)Append|(% style="width:1652px" %)Add this registration to the registry
298		-|(% style="width:219px" %)Replace|(% style="width:1652px" %)Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request
299		-|(% style="width:219px" %)Delete|(% style="width:1652px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
	295	+|(% style="width:249px" %)(((
	296	+**Action Attribute Value**
	297	+)))|(% style="width:1622px" %)**Behaviour**
	298	+|(% style="width:249px" %)Append|(% style="width:1622px" %)Add this registration to the registry
	299	+|(% style="width:249px" %)Replace|(% style="width:1622px" %)Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request
	300	+|(% style="width:249px" %)Delete|(% style="width:1622px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
300	300
301	301	The Registration has three Boolean attributes which may be present to determine how an SDMX compliant Dataset or Metadata Set indexing application must index the Datasets or Metadata Set upon registration. The indexing application behaviour is as follows:
302	302
303		-|(% style="width:228px" %)**Boolean Attribute**|(% style="width:1644px" %)**Behaviour if Value is “true”**
304		-|(% style="width:228px" %)indexTimeSeries|(% style="width:1644px" %)A compliant indexing application must index all the time series keys (for a Dataset registration) or metadata target values (for a Metadata Set registration)
305		-|(% style="width:228px" %)indexDataSet|(% style="width:1644px" %)A compliant indexing application must index the range of actual (present) values for each dimension of the Dataset (for a Dataset registration) or the range of actual (present) values for each Metadata Attribute which takes an enumerated value.
	304	+|**Boolean Attribute**|**Behaviour if Value is “true”**
	305	+|indexTimeSeries|A compliant indexing application must index all the time series keys (for a Dataset registration) or metadata target values (for a Metadata Set registration)
	306	+|indexDataSet|(((
	307	+A compliant indexing application must index the range of actual (present) values for each dimension of the Dataset (for a Dataset registration) or the range of actual (present) values for each Metadata Attribute which takes an enumerated value.
	308	+
306	306	Note that for data this requires much less storage than full key indexing, but this method cannot guarantee that a specific combination of Dimension values (the Key) is actually present in the Dataset
307		-|(% style="width:228px" %)indexReportingPeriod|(% style="width:1644px" %)A compliant indexing application must index the time period range(s) for which data are present in the Dataset or Metadata Set
	310	+)))
	311	+|indexReportingPeriod|A compliant indexing application must index the time period range(s) for which data are present in the Dataset or Metadata Set
308	308
309	309	=== 5.2.5 Data and Reference Metadata Discovery ===
310	310
...	...	@@ -336,8 +336,8 @@
336	336
337	337	The following table defines the behaviour of the SDMX Registry for the various Registry Interface messages.
338	338
339		-|(% style="width:227px" %)**Interface**|(% style="width:1644px" %)**Behaviour**
340		-|(% style="width:227px" %)All|(% style="width:1644px" %)(((
	343	+|(% style="width:244px" %)**Interface**|**Behaviour**
	344	+|(% style="width:244px" %)All|(((
341	341	1) If the action is set to “replace” then the entire contents of the existing maintainable object in the Registry MUST be replaced by the object submitted, unless the final attribute is set to “true” in which case the only changes that are allowed are to the following constructs:
342	342
343	343	* Name – this applies to the Maintainable object and its contained elements, such a Code in a Code list.
...	...	@@ -351,6 +351,7 @@
351	351	* isExternalReference
352	352
353	353	2) Cross referenced structures MUST exist in either the submitted document (in Structures or Structure Location) or in the registry to which the request is submitted.
	358	+
354	354	3) If the action is set to “delete” then the Registry MUST verify that the object can deleted. In order to qualify for deletion the object must:
355	355
356	356	а) Not have the final attribute set to “true”
...	...	@@ -357,11 +357,12 @@
357	357	b) Not be referenced from any other object in the Registry.
358	358
359	359	4) The version rules in the SDMX Schema documentation MUST be obeyed.
	365	+
360	360	5) The specific rules for the elements and attributes documented in the SDMX Schema MUST be obeyed.
361	361	)))
362		-|(% style="width:227px" %)SubmitStructureRequest|(% style="width:1644px" %)Structures are submitted at the level of the Maintainable Artefact and the behaviour in “All” above is therefore at the level of the Maintainable Artefact.
363		-|(% style="width:227px" %)SubmitProvisioningRequest|(% style="width:1644px" %)No additional behaviour.
364		-|(% style="width:227px" %)Submit Registration Request|(% style="width:1644px" %)(((
	368	+|(% style="width:244px" %)SubmitStructureRequest|Structures are submitted at the level of the Maintainable Artefact and the behaviour in “All” above is therefore at the level of the Maintainable Artefact.
	369	+|(% style="width:244px" %)SubmitProvisioningRequest|No additional behaviour.
	370	+|(% style="width:244px" %)Submit Registration Request|(((
365	365	If the datasource is a file (simple datasource) then the file MAY be retrieved and indexed according to the Boolean attributes set in the Registration.
366	366	For a queryable datasource the Registry MAY validate that the source exists and can accept an SDMX-ML data query.
367	367	)))
...	...	@@ -448,8 +448,7 @@
448	448
449	449	[[image:1747824123012-527.jpeg]]
450	450
451		-*
452		-** Figure 7: Example of Hierarchic Structure of Agencies
	457	+==== Figure 7: Example of Hierarchic Structure of Agencies ====
453	453
454	454	The following organizations maintain an Agency Scheme.
455	455
...	...	@@ -466,6 +466,7 @@
466	466
467	467	[[image:1747824123013-196.jpeg||height="309" width="446"]]
468	468
	474	+(% class="wikigeneratedid" id="HFigure8:ExampleShowingUseofAgencyIdentifiers" %)
469	469	**Figure 8: Example Showing Use of Agency Identifiers**
470	470
471	471	Each of these maintenance agencies has an identical Code list with the Id CL_BOP. However, each is uniquely identified by means of the hierarchic agency structure.
...	...	@@ -484,7 +484,7 @@
484	484
485	485	The generic structure of the URN is as follows:
486	486
487		->SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobject-id(maintainedobject-version).*containerobject-id.object-id
	493	+SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobject-id(maintainedobject-version).*containerobject-id.object-id
488	488
489	489	~* this can repeat and may not be present (see explanation below)
490	490
...	...	@@ -496,7 +496,7 @@
496	496
497	497	In the explanation below the actual object that is the target of the URN is called the **//actual object//**.
498	498
499		-**SDMXPrefix:** urn:sdmx:org.
	505	+**SDMXPrefix:** urn:sdmx:org.
500	500
501	501	**SDMX-IM package name:** sdmx.infomodel.package=
502	502
...	...	@@ -704,6 +704,8 @@
704	704	hierarchicalcodelistId(version).Hierarchy.Level
705	705	)))|(% style="width:396px" %)(((
706	706	ESTAT:HCL_REGION(1.0).H_1.COUNTRY
	713	+
	714	+
707	707	)))
708	708	|(% style="width:250px" %)HierarchicalCode|(% style="width:444px" %)hierachicalCodeListAgencyId: hierarchicalcodelistId(version).hierarchy.hierarc hicalCode|(% style="width:396px" %)UNESCO:CL_EXP_SOURCE(1.0). H-C-GOV.GOV_CODE1
709	709	|(% style="width:250px" %)*DataStructure|(% style="width:444px" %)dataStructureDefintitionAgencyId: dataStructureDefintitionId(version)|(% style="width:396px" %)TFFS:EXT_DEBT(1.0)
...	...	@@ -808,11 +808,15 @@
808	808
809	809	|(% style="width:251px" %)(((
810	810	ReportStructure
	819	+
	820	+
811	811	)))|(% style="width:442px" %)(((
812	812	MSDAgencyId: MSDId(version).reportStructureId
813	813	)))|(% style="width:1178px" %)IMF:SDDS_MSD(1.0).AGENCY_REPORT
814	814	|(% style="width:251px" %)(((
815		-Metadata Attribute
	825	+Metadata
	826	+
	827	+Attribute
816	816	)))|(% style="width:442px" %)(((
817	817	MSDAgencyId: MSDId(version).reportStructureId.metadataattri buteID
818	818	)))|(% style="width:1178px" %)IMF:SDDS_MSD(1.0).AGENCY_REPORT.COMPILATION
...	...	@@ -823,10 +823,14 @@
823	823	TFFS:CRED_EXT_DEBT_AB(1.0)
824	824	)))
825	825	|(% style="width:251px" %)(((
826		-*Content Constraint
	838	+*Content
	839	+
	840	+Constraint
827	827	)))|(% style="width:442px" %)constraintAgencyId:ContentConstraintId(versio n)|(% style="width:1178px" %)TFFS:CREDITOR_DATA_CONTENT(1.0)
828	828	|(% style="width:251px" %)(((
829		-*Attachment Constraint
	843	+*Attachment
	844	+
	845	+Constraint
830	830	)))|(% style="width:442px" %)(((
831	831	constraintAgencyId:
832	832
...	...	@@ -849,7 +849,9 @@
849	849	codeMapId
850	850	)))|
851	851	|(((
852		-CategorySchemeMap
	868	+Category
	869	+
	870	+SchemeMap
853	853	)))|structureSetAgencyId: structureSetId(version). categorySchemeMapId|SDMX:BOP_STRUCTURES(1.0).SDMX_EUROSTAT
854	854	|CategoryMap|structureSetAgencyId: structureSetId(version). categorySchemeMapId. categoryMapId|SDMX:BOP_STRUCTURES(1.0).SDMX_EUROSTAT.TOURISM_M AP
855	855	|Organisation SchemeMap|structureSetAgencyId: structureSetId(version). organisationSchemeMapId|SDMX:BOP_STRUCTURES(1.0).DATA_PROVIDER_MAP
...	...	@@ -863,53 +863,71 @@
863	863	structureSetAgencyId: structureSetId(version). conceptSchemeMapId.
864	864
865	865	conceptMapId
	884	+
866	866
867	867	)))|SDMX:BOP_STRUCTURES(1.0).SDMX_OECD.COVERAGE_AVAI LABILITY
868	868	|(((
869		-ReportingTaxonomyMap
	888	+Reporting
	889	+
	890	+TaxonomyMap
870	870	)))|structureSetAgencyId: structureSetId(version). reportingTaxonomyMapId|SDMX:BOP_STRUCTURES(1.0).TAXMAP
871	871	|(((
872		-ReportingCategoryMap
	893	+Reporting
	894	+
	895	+CategoryMap
873	873	)))|(((
874	874	structureSetAgencyId: structureSetId(version).
	898	+
875	875	reportngCategoryId
876	876	)))|SDMX:BOP_STRUCTURES(1.0).TAXMAP.TOPCAT
877	877
	902	+
	903	+
878	878	|(((
879		-HybridCodelistMap
880		-)))|structureSetAgencyId: structureSetId(version).
881		-hybridCodelistMapId.|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP
	905	+HybridCodelist
	906	+
	907	+Map
	908	+)))|structureSetAgencyId: structureSetId(version). hybridCodelistMapId.|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP
882	882	|HybridCodeMap|structureSetAgencyId: structureSetId(version). hybridCodelistMapId. hybridCodeMapId|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP.CO DEMAP1
883	883	|*Process|processAgencyId: processId{version]|BIS:PROCESS1(1.0)
884	884	|ProcessStep|(((
885	885	processAgencyId: processId(version).
	913	+
886	886	processStepId
887	887	)))|BIS:PROCESS1(1.0).STEP1
888	888	|Transition|(((
889	889	processAgencyId: processId(version).
	918	+
890	890	processStepId transitionId
891	891	)))|BIS:PROCESS1(1.0).STEP1.TRANSITION1
892	892	|Subscription|The Subscription is not itself an Identifiable Artefact and therefore it does not follow the rules for URN structure, The name of the URN is registryURN There is no pre-determined format.|This cannot be generated by a common mechanism as subscriptions, although maintainable in the sense that they can be submitted and deleted, are not mandated to be created by a maintenance agency, and have no versioning mechanism. It is therefore the responsibility of the target registry to generate a unique Id for the Subscription, and for the application creating the subscription to store the registryURN that is returned from the registry in the subscription response message.
893	893	|(((
894		-*Transformation Scheme
	923	+*Transformation
	924	+
	925	+Scheme
895	895	)))|transformationSchemeAgencyId transformationSchemeId(version)|ECB: TRANSFORMATION_SCHEME(1.0)
896	896	|Transformation|(((
897	897	transformationSchemeAgencyId transformationSchemeId(version)
	929	+
898	898	transformationId
899	899	)))|ECB:TRANSFORMATION_SCHEME(1.0).TRANS_1
900	900	|CustomType Scheme|customTypeSchemeAgencyId customTypeSchemeId(version)|ECB:CUSTOM_TYPE_SCHEME(1.0)
901	901
	934	+
	935	+
902	902	|CustomType|customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|ECB: CUSTOM_TYPE_SCHEME(1.0).CUSTOM_TYPE_1
903	903	|(((
904	904	Name
	939	+
905	905	Personalisation
	941	+
906	906	Scheme
907	907	)))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|ECB:PSN_SCHEME(1.0)
908	908	|(((
909	909	Name
	946	+
910	910	Personalisation
911		-)))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)
912		-namePersonalisationId|ECB:PSN_SCHEME(1.0).PSN1234
	948	+)))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|ECB:PSN_SCHEME(1.0).PSN1234
913	913	|VtlMapping Scheme|vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|ECB:CLIST_MP(2.0)
914	914	|VtlCodelist Mapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|ECB:CLIST_MP(2.0).ABZ
915	915	|VtlConcept Mapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|ECB:CLIST_MP(1.0).XYA
...	...	@@ -922,11 +922,13 @@
922	922	|RulesetScheme|rulesetSchemeAgencyId rulesetSchemeId(version)|ECB:RULESET_23(1.0)
923	923	|Ruleset|rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|ECB:RULESET_23(1.0).SET111
924	924	|(((
925		-UserDefinedOperatorScheme
	961	+UserDefined
	962	+
	963	+OperatorScheme
926	926	)))|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|ECB:OS_CALC(1.2)
927	927	|UserDefined Operator|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|ECB:OS_CALC(1.2).OS267
928	928
929		-**Table 3: Table of identification components for SDMX Identifiable Artefacts**
	967	+7**Table 3: Table of identification components for SDMX Identifiable Artefacts**
930	930
931	931	= 7 Implementation Notes =
932	932
...	...	@@ -1136,7 +1136,7 @@
1136	1136
1137	1137	[[image:1747824123025-411.jpeg]]
1138	1138
1139		-**Figure 16: Schematic of the Objects Concerned with Registration**
	1177	+ **Figure 16: Schematic of the Objects Concerned with Registration**
1140	1140
1141	1141	==== 7.4.2.2 Registration Request Model ====
1142	1142
...	...	@@ -1172,19 +1172,25 @@
1172	1172
1173	1173	Information in the data or metadata set is extracted and placed in one or more Content Constraints (see the Constraints model in the SDMX Information Model – Section 2 of the SDMX Standards). The information to be extracted is indicated by the Boolean values set on the Provision Agreement as shown in the table below.
1174	1174
1175		-|(% style="width:185px" %)**Indexing Required**|(% style="width:1686px" %)**Registration Process Activity**
1176		-|(% style="width:185px" %)indexTimeSeries|(% style="width:1686px" %)Extract all the series keys and create a KeySet(s) Constraint.
1177		-|(% style="width:185px" %)indexDataSet|(% style="width:1686px" %)(((
1178		-Extract all the codes and other content of the Key value of the Series Key in a Data Set and create one or more Cube Regions containing Member Selections of Dimension Components of the Constraints model in the SDMX-IM, and the associated Selection Value.
	1213	+|**Indexing Required**|**Registration Process Activity**
	1214	+|indexTimeSeries|Extract all the series keys and create a KeySet(s) Constraint.
	1215	+|indexDataSet|(((
	1216	+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
	1217	+
	1218	+Regions containing Member Selections of Dimension Components of the Constraints model in the SDMX-IM, and the associated Selection Value.
1179	1179	)))
1180		-|(% style="width:185px" %)indexReportingPeriod|(% style="width:1686px" %)(((
	1220	+|indexReportingPeriod|(((
1181	1181	This applies only to a registered dataset.
	1222	+
1182	1182	Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint.
1183	1183	)))
1184		-|(% style="width:185px" %)indexAttributes|(% style="width:1686px" %)(((
	1225	+|indexAttributes|(((
1185	1185	**Data Set**
	1227	+
1186	1186	Extract the content of the Attribute Values in a Data Set and create one or more Cube Regions containing Member Selections of Data Attribute Components of the Constraints model in the SDMXIM, and the associated Selection Value
	1229	+
1187	1187	**Metadata Set**
	1231	+
1188	1188	Indicate the presence of a Reported Attribute by creating one or more Cube Regions containing Member Selections of Metadata Attribute Components of the Constraints model in the SDMX-IM. Note that the content is not stored in the Selection Value.
1189	1189	)))
1190	1190
...	...	@@ -1194,13 +1194,14 @@
1194	1194
1195	1195	=== 7.4.3 Registration Response ===
1196	1196
1197		-After a registration request has been submitted to the registry, a response is returned to the submitter indicating success or failure. Given that a registration request can hold many Registrations, then there must be a registration status for each Registration. The Submit Registration class has a status field which is either set to “Success”, “Warning” or “Failure”.
	1241	+After a registration request has been submitted to the registry, a response is returned to the submitter indicating success or failure. Given that a registration request can hold many Registrations, then there must be a registration status for each Registration. The Submit Registration class has a status field which is either set to
1198	1198
	1243	+“Success”, “Warning” or “Failure”.
	1244	+
1199	1199	If the registration has succeeded, a Registration will be returned - this holds the Registry-allocated Id of the newly registered Datasource plus a Datasource holding the URL to access the dataset, metadataset, or query service.
1200	1200
1201	1201	The Registration Response returns set of registration status (one for each registration submitted) in terms of a Status Message (this is common to all Registry Responses) that indicates success or failure. In the event of registration failure, a set of Message Text are returned, giving the error messages that occurred during registration. It is entirely possible when registering a batch of datasets, that the response will contain some successful and some failed statuses. The logical model for the Registration Response is shown below:
1202	1202
1203		-[[image:1747829477882-750.png]]
1204	1204
1205	1205	**Figure 18: Logical class diagram showing the registration response**
1206	1206
...	...	@@ -1210,12 +1210,15 @@
1210	1210
1211	1211	A user can submit a subscription in the registry that defines which events are of interest, and either an email and/or an HTTP address to which a notification of qualifying events will be delivered. The subscription will be identified in the registry by a URN which is returned to the user when the subscription is created. If the user wants to delete the subscription at a later point, the subscription URN is used as identification. Subscriptions have a validity period expressed as a date range (startDate, endDate) and the registry may delete any expired subscriptions, and will notify the subscriber on expiry.
1212	1212
1213		-When a registry/repository artefact is modified, any subscriptions which are observing the object are activated, and either an email or HTTP POST is instigated to report details of the changes to the user specified in the subscription. This is called a “notification”.
	1258	+When a registry/repository artefact is modified, any subscriptions which are observing the object are activated, and either an email or HTTP POST is instigated to report details of the changes to the user specified in the subscription. This is called a
1214	1214
1215		-=== 7.5.1Subscription Logical Class Diagram ===
	1260	+“notification”.
1216	1216
1217		-[[image:1747829554603-150.png]]
	1262	+ 7.5.1Subscription Logical Class Diagram
1218	1218
	1264	+
	1265	+[[image:1747824123028-257.png]]
	1266	+
1219	1219	**Figure 19: Logical Class Diagram of the Subscription**
1220	1220
1221	1221	=== 7.5.2 Subscription Information ===
...	...	@@ -1222,58 +1222,73 @@
1222	1222
1223	1223	Regardless of the type of registry/repository events being observed, a subscription always contains:
1224	1224
1225		-1. A set of URIs describing the end-points to which notifications must be sent if the subscription is activated. The URIs can be either mailto~: or http: protocol. In the former case an email notification is sent; in the latter an HTTP POST notification is sent.
1226		-1. A user-defined identifier which is returned in the response to the subscription request. This helps with asynchronous processing and is NOT stored in the Registry.
1227		-1. A validity period which defines both when the subscription becomes active and expires. The subscriber may be sent a notification on expiration of the subscription.
1228		-1. A selector which specifies which type of events are of interest. The set of event types is:
	1273	+~1. A set of URIs describing the end-points to which notifications must be sent if the subscription is activated. The URIs can be either mailto~: or http: protocol. In the former case an email notification is sent; in the latter an HTTP POST notification is sent.
1229	1229
1230		-|(% style="width:319px" %)**Event Type**|(% style="width:1553px" %)**Comment**
1231		-|(% style="width:319px" %)STRUCTURAL_REPOSITORY_EVENTS|(% style="width:1553px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1232		-|(% style="width:319px" %)DATA_REGISTRATION_EVENTS|(% style="width:1553px" %)Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
1233		-|(% style="width:319px" %)METADATA_REGISTRATION_EVENTS|(% style="width:1553px" %)Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
1234		-|(% style="width:319px" %)ALL_EVENTS|(% style="width:1553px" %)All events of the specified EventType
	1275	+2. A user-defined identifier which is returned in the response to the subscription request. This helps with asynchronous processing and is NOT stored in the Registry.
1235	1235
	1277	+3. A validity period which defines both when the subscription becomes active and expires. The subscriber may be sent a notification on expiration of the subscription.
	1278	+
	1279	+4. A selector which specifies which type of events are of interest. The set of event types is:
	1280	+
	1281	+|**Event Type**|**Comment**
	1282	+|STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
	1283	+|DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
	1284	+|METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
	1285	+|ALL_EVENTS|All events of the specified EventType
	1286	+
1236	1236	=== 7.5.3 Wildcard Facility ===
1237	1237
1238	1238	Subscription notification supports wildcarded identifier components URNs, which are identiiers which have some or all of their component parts replaced by the wildcard character `%`. Identifier components comprise:
1239	1239
1240		-* agencyID
1241		-* id
1242		-* version
	1291	+ agencyID
1243	1243
	1293	+ id
	1294	+
	1295	+ version
	1296	+
1244	1244	Examples of wildcarded identifier components for an identified object type of Codelist are shown below.
1245	1245
1246		-//AgencyID = %
	1299	+AgencyID = %
	1300	+
1247	1247	Id = %
1248		-Version = %//
1249	1249
	1303	+Version = %
	1304	+
1250	1250	This subscribes to all Codelists of all versions for all agencies.
1251	1251
1252		-//AgencyID = AGENCY1
	1307	+AgencyID = AGENCY1
	1308	+
1253	1253	Id = CODELIST1
1254		-Version = %//
1255	1255
	1311	+Version = %
	1312	+
1256	1256	This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1257	1257
1258		-//AGENCY1
	1315	+AGENCY1
	1316	+
1259	1259	AgencyID = AGENCY1
	1318	+
1260	1260	Id = %
1261		-Version = %//
1262	1262
	1321	+Version = %
	1322	+
1263	1263	This subscribes to all versions of all Codelist objects maintained by the agency
1264	1264
1265		-//AGENCY1
	1325	+AGENCY1
	1326	+
1266	1266	AgencyID = %
	1328	+
1267	1267	Id = CODELIST1
1268		-Version = %//
1269	1269
	1331	+Version = %
	1332	+
1270	1270	This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1271	1271
1272		-//AGENCY1//
	1335	+AGENCY1
1273	1273
1274	1274	Note that if the subscription is to the latest version then this can be achieved by the * character
1275	1275
1276		-//i.e. Version = *//
	1339	+i.e. Version = *
1277	1277
1278	1278	Note that a subscription using the URN mechanism cannot use wildcard characters.
1279	1279
...	...	@@ -1285,15 +1285,16 @@
1285	1285
1286	1286	Whenever a dataset or metadata-set is registered a registration event is created. A subscription may be observing all data or metadata registrations, or it may focus on specific registrations as shown in the table below:
1287	1287
1288		-|(% style="width:405px" %)**Selector**|(% style="width:1467px" %)**Comment**
1289		-|(% style="width:405px" %)DataProvider|(% style="width:1467px" %)Any datasets or metadata sets registered by the specified data provider will activate the notification.
1290		-|(% style="width:405px" %)ProvisionAgreement|(% style="width:1467px" %)Any datasets or metadata sets registered for the provision agreement will activate the notification.
1291		-|(% style="width:405px" %)Dataflow (&Metadataflow)|(% style="width:1467px" %)Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
1292		-|(% style="width:405px" %)DataStructureDefinition & MetadataStructureDefinition|(% style="width:1467px" %)Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will
1293		-|(% style="width:405px" %)**Selector**|(% style="width:1467px" %)**Comment**
1294		-|(% style="width:405px" %) |(% style="width:1467px" %)activate the notification.
1295		-|(% style="width:405px" %)Category|(% style="width:1467px" %)Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category.
1296	1296
	1352	+|**Selector**|**Comment**
	1353	+|DataProvider|Any datasets or metadata sets registered by the specified data provider will activate the notification.
	1354	+|ProvisionAgreement|Any datasets or metadata sets registered for the provision agreement will activate the notification.
	1355	+|Dataflow (&Metadataflow)|Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
	1356	+|DataStructureDefinition & MetadataStructureDefinition|Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will
	1357	+|**Selector**|**Comment**
	1358	+| |activate the notification.
	1359	+|Category|Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category.
	1360	+
1297	1297	The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration.
1298	1298
1299	1299	== 7.6 Notification ==
...	...	@@ -1300,10 +1300,8 @@
1300	1300
1301	1301	=== 7.6.1 Logical Class Diagram ===
1302	1302
1303		-[[image:1747829675568-610.png]]
1304	1304
1305		-(% class="wikigeneratedid" id="HFigure20:LogicalClassDiagramoftheNotification" %)
1306		-**Figure 20: Logical Class Diagram of the Notification**
	1368	+==== Figure 20: Logical Class Diagram of the Notification ====
1307	1307
1308	1308	A notification is an XML document that is sent to a user via email or http POST whenever a subscription is activated. It is an asynchronous one-way message.
1309	1309
...	...	@@ -1323,3 +1323,5 @@
1323	1323	=== 7.6.3 Registration Event Component ===
1324	1324
1325	1325	The notification will contain the Registration.
	1388	+
	1389	+

1747829477882-750.png

Author

...	...	@@ -1,1 +1,0 @@
1		-xwiki:XWiki.helena

Size

...	...	@@ -1,1 +1,0 @@
1		-24.6 KB

Content

1747829554603-150.png

Author

...	...	@@ -1,1 +1,0 @@
1		-xwiki:XWiki.helena

Size

...	...	@@ -1,1 +1,0 @@
1		-99.1 KB

Content

1747829675568-610.png

Author

...	...	@@ -1,1 +1,0 @@
1		-xwiki:XWiki.helena

Size

...	...	@@ -1,1 +1,0 @@
1		-31.1 KB

Content