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, 4 removed)
  • 1747829290890-122.png
  • 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,25 +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	294	3The Registration has an action attribute which takes one of the following values:
295	295
296		-(% style="margin-left:auto; margin-right:auto" %)
297		-|(% style="width:200px" %)(((
	295	+|(% style="width:249px" %)(((
298	298	**Action Attribute Value**
299		-)))|(% style="width:1672px" %)**Behaviour**
300		-|(% style="width:200px" %)Append|(% style="width:1672px" %)Add this registration to the registry
301		-|(% 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
302		-|(% style="width:200px" %)Delete|(% style="width:1672px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
	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
	301	+
303	303	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:
304		-|(% style="width:200px" %)**Boolean Attribute**|(% style="width:1672px" %)**Behaviour if Value is “true”**
305		-|(% 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)
306		-|(% style="width:200px" %)indexDataSet|(% style="width:1672px" %)(((
	303	+
	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	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	+
308	308	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
309	309	)))
310		-|(% 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
	311	+|indexReportingPeriod|A compliant indexing application must index the time period range(s) for which data are present in the Dataset or Metadata Set
311	311
312	312	=== 5.2.5 Data and Reference Metadata Discovery ===
313	313
...	...	@@ -339,8 +339,8 @@
339	339
340	340	The following table defines the behaviour of the SDMX Registry for the various Registry Interface messages.
341	341
342		-|(% style="width:227px" %)**Interface**|(% style="width:1644px" %)**Behaviour**
343		-|(% style="width:227px" %)All|(% style="width:1644px" %)(((
	343	+|(% style="width:244px" %)**Interface**|**Behaviour**
	344	+|(% style="width:244px" %)All|(((
344	344	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:
345	345
346	346	* Name – this applies to the Maintainable object and its contained elements, such a Code in a Code list.
...	...	@@ -354,6 +354,7 @@
354	354	* isExternalReference
355	355
356	356	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	+
357	357	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:
358	358
359	359	а) Not have the final attribute set to “true”
...	...	@@ -360,11 +360,12 @@
360	360	b) Not be referenced from any other object in the Registry.
361	361
362	362	4) The version rules in the SDMX Schema documentation MUST be obeyed.
	365	+
363	363	5) The specific rules for the elements and attributes documented in the SDMX Schema MUST be obeyed.
364	364	)))
365		-|(% 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.
366		-|(% style="width:227px" %)SubmitProvisioningRequest|(% style="width:1644px" %)No additional behaviour.
367		-|(% 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|(((
368	368	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.
369	369	For a queryable datasource the Registry MAY validate that the source exists and can accept an SDMX-ML data query.
370	370	)))
...	...	@@ -487,7 +487,7 @@
487	487
488	488	The generic structure of the URN is as follows:
489	489
490		->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
491	491
492	492	~* this can repeat and may not be present (see explanation below)
493	493
...	...	@@ -499,7 +499,7 @@
499	499
500	500	In the explanation below the actual object that is the target of the URN is called the **//actual object//**.
501	501
502		-**SDMXPrefix:** urn:sdmx:org.
	505	+**SDMXPrefix:** urn:sdmx:org.
503	503
504	504	**SDMX-IM package name:** sdmx.infomodel.package=
505	505
...	...	@@ -1171,7 +1171,7 @@
1171	1171
1172	1172	[[image:1747824123025-411.jpeg]]
1173	1173
1174		-**Figure 16: Schematic of the Objects Concerned with Registration**
	1177	+ **Figure 16: Schematic of the Objects Concerned with Registration**
1175	1175
1176	1176	==== 7.4.2.2 Registration Request Model ====
1177	1177
...	...	@@ -1185,14 +1185,11 @@
1185	1185
1186	1186	The Registration has an action attribute which takes one of the following values:
1187	1187
1188		-(% style="width:970.294px" %)
1189		-|(% style="width:212px" %)**Action Attribute Value**|(% style="width:756px" %)**Behaviour**
1190		-|(% style="width:212px" %)Append|(% style="width:756px" %)Add this Registration to the registry
1191		-|(% style="width:212px" %)Replace|(% style="width:756px" %)Replace the existing Registration with identified by the id in the Registration of the Submit Registration Request
1192		-|(% style="width:212px" %)Delete|(% style="width:756px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
	1191	+|**Action Attribute Value**|**Behaviour**
	1192	+|Append|Add this Registration to the registry
	1193	+|Replace|Replace the existing Registration with identified by the id in the Registration of the Submit Registration Request
	1194	+|Delete|Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
1193	1193
1194		-[[image:1747829290890-122.png]]
1195		-
1196	1196	**Figure 17: Logical Class Diagram of Registration of Data and Metadata**
1197	1197
1198	1198	The Query Datasource is an abstract class that represents a data source which can understand an SDMX-ML query (SOAPDatasource) or RESTful query
...	...	@@ -1207,19 +1207,25 @@
1207	1207
1208	1208	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.
1209	1209
1210		-|(% style="width:185px" %)**Indexing Required**|(% style="width:1686px" %)**Registration Process Activity**
1211		-|(% style="width:185px" %)indexTimeSeries|(% style="width:1686px" %)Extract all the series keys and create a KeySet(s) Constraint.
1212		-|(% style="width:185px" %)indexDataSet|(% style="width:1686px" %)(((
1213		-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.
	1210	+|**Indexing Required**|**Registration Process Activity**
	1211	+|indexTimeSeries|Extract all the series keys and create a KeySet(s) Constraint.
	1212	+|indexDataSet|(((
	1213	+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
	1214	+
	1215	+Regions containing Member Selections of Dimension Components of the Constraints model in the SDMX-IM, and the associated Selection Value.
1214	1214	)))
1215		-|(% style="width:185px" %)indexReportingPeriod|(% style="width:1686px" %)(((
	1217	+|indexReportingPeriod|(((
1216	1216	This applies only to a registered dataset.
	1219	+
1217	1217	Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint.
1218	1218	)))
1219		-|(% style="width:185px" %)indexAttributes|(% style="width:1686px" %)(((
	1222	+|indexAttributes|(((
1220	1220	**Data Set**
	1224	+
1221	1221	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
	1226	+
1222	1222	**Metadata Set**
	1228	+
1223	1223	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.
1224	1224	)))
1225	1225
...	...	@@ -1229,13 +1229,14 @@
1229	1229
1230	1230	=== 7.4.3 Registration Response ===
1231	1231
1232		-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”.
	1238	+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
1233	1233
	1240	+“Success”, “Warning” or “Failure”.
	1241	+
1234	1234	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.
1235	1235
1236	1236	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:
1237	1237
1238		-[[image:1747829477882-750.png]]
1239	1239
1240	1240	**Figure 18: Logical class diagram showing the registration response**
1241	1241
...	...	@@ -1245,12 +1245,15 @@
1245	1245
1246	1246	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.
1247	1247
1248		-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”.
	1255	+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
1249	1249
1250		-=== 7.5.1Subscription Logical Class Diagram ===
	1257	+“notification”.
1251	1251
1252		-[[image:1747829554603-150.png]]
	1259	+ 7.5.1Subscription Logical Class Diagram
1253	1253
	1261	+
	1262	+[[image:1747824123028-257.png]]
	1263	+
1254	1254	**Figure 19: Logical Class Diagram of the Subscription**
1255	1255
1256	1256	=== 7.5.2 Subscription Information ===
...	...	@@ -1257,58 +1257,73 @@
1257	1257
1258	1258	Regardless of the type of registry/repository events being observed, a subscription always contains:
1259	1259
1260		-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.
1261		-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.
1262		-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.
1263		-1. A selector which specifies which type of events are of interest. The set of event types is:
	1270	+~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.
1264	1264
1265		-|(% style="width:327px" %)**Event Type**|(% style="width:1545px" %)**Comment**
1266		-|(% style="width:327px" %)STRUCTURAL_REPOSITORY_EVENTS|(% style="width:1545px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1267		-|(% 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.
1268		-|(% 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.
1269		-|(% style="width:327px" %)ALL_EVENTS|(% style="width:1545px" %)All events of the specified EventType
	1272	+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.
1270	1270
	1274	+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.
	1275	+
	1276	+4. A selector which specifies which type of events are of interest. The set of event types is:
	1277	+
	1278	+|**Event Type**|**Comment**
	1279	+|STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
	1280	+|DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
	1281	+|METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
	1282	+|ALL_EVENTS|All events of the specified EventType
	1283	+
1271	1271	=== 7.5.3 Wildcard Facility ===
1272	1272
1273	1273	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:
1274	1274
1275		-* agencyID
1276		-* id
1277		-* version
	1288	+ agencyID
1278	1278
	1290	+ id
	1291	+
	1292	+ version
	1293	+
1279	1279	Examples of wildcarded identifier components for an identified object type of Codelist are shown below.
1280	1280
1281		-//AgencyID = %
	1296	+AgencyID = %
	1297	+
1282	1282	Id = %
1283		-Version = %//
1284	1284
	1300	+Version = %
	1301	+
1285	1285	This subscribes to all Codelists of all versions for all agencies.
1286	1286
1287		-//AgencyID = AGENCY1
	1304	+AgencyID = AGENCY1
	1305	+
1288	1288	Id = CODELIST1
1289		-Version = %//
1290	1290
	1308	+Version = %
	1309	+
1291	1291	This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1292	1292
1293		-//AGENCY1
	1312	+AGENCY1
	1313	+
1294	1294	AgencyID = AGENCY1
	1315	+
1295	1295	Id = %
1296		-Version = %//
1297	1297
	1318	+Version = %
	1319	+
1298	1298	This subscribes to all versions of all Codelist objects maintained by the agency
1299	1299
1300		-//AGENCY1
	1322	+AGENCY1
	1323	+
1301	1301	AgencyID = %
	1325	+
1302	1302	Id = CODELIST1
1303		-Version = %//
1304	1304
	1328	+Version = %
	1329	+
1305	1305	This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1306	1306
1307		-//AGENCY1//
	1332	+AGENCY1
1308	1308
1309	1309	Note that if the subscription is to the latest version then this can be achieved by the * character
1310	1310
1311		-//i.e. Version = *//
	1336	+i.e. Version = *
1312	1312
1313	1313	Note that a subscription using the URN mechanism cannot use wildcard characters.
1314	1314
...	...	@@ -1320,15 +1320,16 @@
1320	1320
1321	1321	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:
1322	1322
1323		-|(% style="width:405px" %)**Selector**|(% style="width:1467px" %)**Comment**
1324		-|(% style="width:405px" %)DataProvider|(% style="width:1467px" %)Any datasets or metadata sets registered by the specified data provider will activate the notification.
1325		-|(% style="width:405px" %)ProvisionAgreement|(% style="width:1467px" %)Any datasets or metadata sets registered for the provision agreement will activate the notification.
1326		-|(% style="width:405px" %)Dataflow (&Metadataflow)|(% style="width:1467px" %)Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
1327		-|(% 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
1328		-|(% style="width:405px" %)**Selector**|(% style="width:1467px" %)**Comment**
1329		-|(% style="width:405px" %) |(% style="width:1467px" %)activate the notification.
1330		-|(% 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.
1331	1331
	1349	+|**Selector**|**Comment**
	1350	+|DataProvider|Any datasets or metadata sets registered by the specified data provider will activate the notification.
	1351	+|ProvisionAgreement|Any datasets or metadata sets registered for the provision agreement will activate the notification.
	1352	+|Dataflow (&Metadataflow)|Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
	1353	+|DataStructureDefinition & MetadataStructureDefinition|Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will
	1354	+|**Selector**|**Comment**
	1355	+| |activate the notification.
	1356	+|Category|Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category.
	1357	+
1332	1332	The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration.
1333	1333
1334	1334	== 7.6 Notification ==
...	...	@@ -1335,10 +1335,8 @@
1335	1335
1336	1336	=== 7.6.1 Logical Class Diagram ===
1337	1337
1338		-[[image:1747829675568-610.png]]
1339	1339
1340		-(% class="wikigeneratedid" id="HFigure20:LogicalClassDiagramoftheNotification" %)
1341		-**Figure 20: Logical Class Diagram of the Notification**
	1365	+==== Figure 20: Logical Class Diagram of the Notification ====
1342	1342
1343	1343	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.
1344	1344
...	...	@@ -1358,3 +1358,5 @@
1358	1358	=== 7.6.3 Registration Event Component ===
1359	1359
1360	1360	The notification will contain the Registration.
	1385	+
	1386	+

1747829290890-122.png

Author

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

Size

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

Content

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