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.3 to 3.4

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.3

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

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

@@ -288,27 +288,25 @@
  * that a queryable data source exists - this would necessitate the registration service querying the service to determine its existence
  * that a simple data source exists (i.e. a file accessible at a URL)
  * 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
--*  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
++* 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
 The Registration has an action attribute which takes one of the following values:
--|(% style="width:249px" %)(((
++(% style="margin-left:auto; margin-right:auto" %)
++|(% style="width:200px" %)(((
  **Action Attribute Value**
--)))|(% style="width:1622px" %)**Behaviour**
--|(% style="width:249px" %)Append|(% style="width:1622px" %)Add this registration to the registry
--|(% 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
--|(% style="width:249px" %)Delete|(% style="width:1622px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
--
++)))|(% style="width:1672px" %)**Behaviour**
++|(% style="width:200px" %)Append|(% style="width:1672px" %)Add this registration to the registry
++|(% style="width:200px" %)Replace|(% style="width:1672px" %)Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request
++|(% style="width:200px" %)Delete|(% style="width:1672px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
  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:
--
--|**Boolean Attribute**|**Behaviour if Value is “true”**
--|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)
--|indexDataSet|(((
++|(% style="width:200px" %)**Boolean Attribute**|(% style="width:1672px" %)**Behaviour if Value is “true”**
++|(% style="width:200px" %)indexTimeSeries|(% style="width:1672px" %)A compliant indexing application must index all the time series keys (for a Dataset registration) or metadata target values (for a Metadata Set registration)
++|(% style="width:200px" %)indexDataSet|(% style="width:1672px" %)(((
  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.
--
  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
  )))
--|indexReportingPeriod|A compliant indexing application must index the time period range(s) for which data are present in the Dataset or Metadata Set
++|(% style="width:200px" %)indexReportingPeriod|(% style="width:1672px" %)A compliant indexing application must index the time period range(s) for which data are present in the Dataset or Metadata Set
  === 5.2.5 Data and Reference Metadata Discovery ===
@@ -340,8 +340,8 @@
  The following table defines the behaviour of the SDMX Registry for the various Registry Interface messages.
--|(% style="width:244px" %)**Interface**|**Behaviour**
--|(% style="width:244px" %)All|(((
++|(% style="width:227px" %)**Interface**|(% style="width:1644px" %)**Behaviour**
++|(% style="width:227px" %)All|(% style="width:1644px" %)(((
 ) 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:
  * Name – this applies to the Maintainable object and its contained elements, such a Code in a Code list.
@@ -355,7 +355,6 @@
  * isExternalReference
 ) 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.
--
 ) 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:
  а) Not have the final attribute set to “true”
@@ -362,12 +362,11 @@
  b) Not be referenced from any other object in the Registry.
 ) The version rules in the SDMX Schema documentation MUST be obeyed.
--
 ) The specific rules for the elements and attributes documented in the SDMX Schema MUST be obeyed.
  )))
--|(% 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.
--|(% style="width:244px" %)SubmitProvisioningRequest|No additional behaviour.
--|(% style="width:244px" %)Submit Registration Request|(((
++|(% 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.
++|(% style="width:227px" %)SubmitProvisioningRequest|(% style="width:1644px" %)No additional behaviour.
++|(% style="width:227px" %)Submit Registration Request|(% style="width:1644px" %)(((
  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.
  For a queryable datasource the Registry MAY validate that the source exists and can accept an SDMX-ML data query.
  )))
@@ -490,7 +490,7 @@
  The generic structure of the URN is as follows:
--SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobject-id(maintainedobject-version).*containerobject-id.object-id
++>SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobject-id(maintainedobject-version).*containerobject-id.object-id
  ~* this can repeat and may not be present (see explanation below)
@@ -502,7 +502,7 @@
  In the explanation below the actual object that is the target of the URN is called the **//actual object//**.
--**SDMXPrefix:** urn:sdmx:org.
++**SDMXPrefix:** urn:sdmx:org.
  **SDMX-IM package name:** sdmx.infomodel.package=
@@ -1174,7 +1174,7 @@
  [[image:1747824123025-411.jpeg]]
--  **Figure 16: Schematic of the Objects Concerned with Registration**
++**Figure 16: Schematic of the Objects Concerned with Registration**
  ==== 7.4.2.2 Registration Request Model ====
@@ -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