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.11 to 2.12 From 2.18 to 3.1

From version 2.12

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

Change comment: There is no comment for this version

To version 2.18

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

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Attachments (0 modified, 6 added, 0 removed)

Details

Page properties

Content

@@ -1105,10 +1105,10 @@
  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.
++[[image:1747829109466-595.png]]
  **Figure 11: SDMX-IM of the Data Provider**
--
  Note that the Data Provider does not inherit the hierarchy association. The diagram below shows a logical schematic of the data model classes required to maintain provision agreements
  [[image:1747824123019-181.jpeg]]
@@ -1117,8 +1117,10 @@
  The diagram below is a logical representation of the data required in order to maintain Provision Agreements.
++[[image:1747829139951-378.png]]
--==== Figure 13: Logical class diagram of the information contained in the Provision Agreement ====
++(% class="wikigeneratedid" id="HFigure13:LogicalclassdiagramoftheinformationcontainedintheProvisionAgreement" %)
++**Figure 13: Logical class diagram of the information contained in the Provision Agreement**
  A Provision Agreement is structural metadata. Each Provision Agreement must reference a Data Provider and a Dataflow or Metadataflow Definition. The Data Provider and the Dataflow/Metadataflow Definition must exist already in order to set up a Provision Agreement.
@@ -1146,13 +1146,12 @@
  === 7.3.3 Data and Metadata Constraints: Model ===
++[[image:1747829204737-370.png]]
++**Figure 15: Logical class diagram showing inheritance between and reference to constrainable artifacts**
--==== Figure 15: Logical class diagram showing inheritance between and reference to constrainable artifacts ====
++The class diagram above shows that DataProvider, DataflowDefinition, MetadataflowDefinition, ProvisionAgreement, DataStructureDefinition, MetadataStructureDefinition, SimpleDatasource and QueryDatasource are all concrete sub-classes of ConstrainableArtefact and can therefore have Constraints specified. Note that the actual Constraint as submitted is associated to the reference classes which inherit from ConstrainableRef: these are used to refer to the classes to which the Constraint applies.
--The     class    diagram          above shows that      DataProvider, DataflowDefinition, MetadataflowDefinition,         ProvisionAgreement, DataStructureDefinition, MetadataStructureDefinition, SimpleDatasource and QueryDatasource are all concrete sub-classes of ConstrainableArtefact and can therefore have Constraints specified. Note that the actual Constraint as submitted is associated to the reference classes which inherit from ConstrainableRef: these are used to refer to the classes to which the Constraint applies.
--
--
  The content of the Constraint can be found in the SDMX Information Model document.
  == 7.4 Data and Metadata Registration ==
@@ -1187,11 +1187,14 @@
  The Registration has an action attribute which takes one of the following values:
--|**Action Attribute Value**|**Behaviour**
--|Append|Add this Registration to the registry
--|Replace|Replace the existing Registration with identified by the id in the Registration of the Submit Registration Request
--|Delete|Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
++(% style="width:970.294px" %)
++|(% style="width:212px" %)**Action Attribute Value**|(% style="width:756px" %)**Behaviour**
++|(% style="width:212px" %)Append|(% style="width:756px" %)Add this Registration to the registry
++|(% style="width:212px" %)Replace|(% style="width:756px" %)Replace the existing Registration with identified by the id in the Registration of the Submit Registration Request
++|(% style="width:212px" %)Delete|(% style="width:756px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
++[[image:1747829290890-122.png]]
++
  **Figure 17: Logical Class Diagram of Registration of Data and Metadata**
  The Query Datasource is an abstract class that represents a data source which can understand an SDMX-ML query (SOAPDatasource) or RESTful query
@@ -1206,25 +1206,19 @@
  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.
--|**Indexing Required**|**Registration Process Activity**
--|indexTimeSeries|Extract all the series keys and create a KeySet(s) Constraint.
--|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.
++|(% style="width:185px" %)**Indexing Required**|(% style="width:1686px" %)**Registration Process Activity**
++|(% style="width:185px" %)indexTimeSeries|(% style="width:1686px" %)Extract all the series keys and create a KeySet(s) Constraint.
++|(% style="width:185px" %)indexDataSet|(% style="width:1686px" %)(((
++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.
  )))
--|indexReportingPeriod|(((
++|(% style="width:185px" %)indexReportingPeriod|(% style="width:1686px" %)(((
  This applies only to a registered dataset.
--
  Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint.
  )))
--|indexAttributes|(((
++|(% style="width:185px" %)indexAttributes|(% style="width:1686px" %)(((
  **Data Set**
--
  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
--
  **Metadata Set**
--
  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.
  )))
@@ -1234,14 +1234,13 @@
  === 7.4.3 Registration Response ===
--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
++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”.
--“Success”, “Warning” or “Failure”.
--
  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.
  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:
++[[image:1747829477882-750.png]]
  **Figure 18: Logical class diagram showing the registration response**
@@ -1251,15 +1251,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 ===
@@ -1266,73 +1266,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.

1747829109466-595.png

Author

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

Size

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

Content

1747829139951-378.png

Author

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

Size

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

Content

1747829204737-370.png

Author

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

Size

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

Content

1747829290890-122.png

Author

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

Size

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

Content

1747829477882-750.png

Author

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

Size

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

Content

1747829554603-150.png

Author

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

Size

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

Content