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

Last modified by Helena on 2025/09/10 11:19

From 2.15 to 2.16 From 3.1 to 3.2

From version 2.16

edited by Helena
on 2025/05/21 15:11

Change comment: There is no comment for this version

To version 3.1

edited by Helena
on 2025/05/21 15:14

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Attachments (0 modified, 2 added, 0 removed)
- 1747829554603-150.png
- 1747829675568-610.png

Details

Page properties

Content

@@ -1248,15 +1248,12 @@
  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.
--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
++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”.
--“notification”.
++===  7.5.1Subscription Logical Class Diagram ===
-- 7.5.1Subscription Logical Class Diagram
++[[image:1747829554603-150.png]]
--
--[[image:1747824123028-257.png]]
--
  **Figure 19: Logical Class Diagram of the Subscription**
  === 7.5.2 Subscription Information ===
@@ -1263,73 +1263,58 @@
  Regardless of the type of registry/repository events being observed, a subscription always contains:
--~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.
++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.
++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.
++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.
++1. A selector which specifies which type of events are of interest. The set of event types is:
--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.
++|(% style="width:327px" %)**Event Type**|(% style="width:1545px" %)**Comment**
++|(% style="width:327px" %)STRUCTURAL_REPOSITORY_EVENTS|(% style="width:1545px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
++|(% style="width:327px" %)DATA_REGISTRATION_EVENTS|(% style="width:1545px" %)Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
++|(% style="width:327px" %)METADATA_REGISTRATION_EVENTS|(% style="width:1545px" %)Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
++|(% style="width:327px" %)ALL_EVENTS|(% style="width:1545px" %)All events of the specified EventType
--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.
--
--4. A selector which specifies which type of events are of interest. The set of event types is:
--
--|**Event Type**|**Comment**
--|STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
--|DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
--|METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
--|ALL_EVENTS|All events of the specified EventType
--
  === 7.5.3 Wildcard Facility ===
  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:
--         agencyID
++* agencyID
++* id
++* version
--         id
--
--         version
--
  Examples of wildcarded identifier components for an identified object type of Codelist are shown below.
--AgencyID = %
--
++//AgencyID = %
  Id = %
++Version = %//
--Version = %
--
  This subscribes to all Codelists of all versions for all agencies.
--AgencyID = AGENCY1
--
++//AgencyID = AGENCY1
  Id = CODELIST1
++Version = %//
--Version = %
--
  This subscribes to all versions of Codelist CODELIST1 maintained by the agency
--AGENCY1
--
++//AGENCY1
  AgencyID = AGENCY1
--
  Id = %
++Version = %//
--Version = %
--
  This subscribes to all versions of all Codelist objects maintained by the agency
--AGENCY1
--
++//AGENCY1
  AgencyID = %
--
  Id = CODELIST1
++Version = %//
--Version = %
--
  This subscribes to all versions of Codelist CODELIST1 maintained by the agency
--AGENCY1
++//AGENCY1//
  Note that if the subscription is to the latest version then this can be achieved by the * character
--i.e. Version = *
++//i.e. Version = *//
  Note that a subscription using the URN mechanism cannot use wildcard characters.
@@ -1341,16 +1341,15 @@
  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:
++|(% style="width:405px" %)**Selector**|(% style="width:1467px" %)**Comment**
++|(% style="width:405px" %)DataProvider|(% style="width:1467px" %)Any datasets or metadata sets registered by the specified data provider will activate the notification.
++|(% style="width:405px" %)ProvisionAgreement|(% style="width:1467px" %)Any datasets or metadata sets registered for the provision agreement will activate the notification.
++|(% style="width:405px" %)Dataflow (&Metadataflow)|(% style="width:1467px" %)Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
++|(% 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
++|(% style="width:405px" %)**Selector**|(% style="width:1467px" %)**Comment**
++|(% style="width:405px" %) |(% style="width:1467px" %)activate the notification.
++|(% 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.
--|**Selector**|**Comment**
--|DataProvider|Any datasets or metadata sets registered by the specified data provider will activate the notification.
--|ProvisionAgreement|Any datasets or metadata sets registered for the provision agreement will activate the notification.
--|Dataflow (&Metadataflow)|Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
--|DataStructureDefinition & MetadataStructureDefinition|Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will
--|**Selector**|**Comment**
--| |activate the notification.
--|Category|Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category.
--
  The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration.
  == 7.6 Notification ==
@@ -1357,8 +1357,10 @@
  === 7.6.1 Logical Class Diagram ===
++[[image:1747829675568-610.png]]
--==== Figure 20: Logical Class Diagram of the Notification ====
++(% class="wikigeneratedid" id="HFigure20:LogicalClassDiagramoftheNotification" %)
++**Figure 20: Logical Class Diagram of the Notification**
  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.
@@ -1378,5 +1378,3 @@
  === 7.6.3 Registration Event Component ===
  The notification will contain the Registration.
--
--

1747829554603-150.png

Author

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

Size

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

Content

1747829675568-610.png

Author

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

Size

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

Content