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, 4 added, 0 removed)
  • 1747829290890-122.png
  • 1747829477882-750.png
  • 1747829554603-150.png
  • 1747829675568-610.png

Details

Page properties

Content

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

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

1747829675568-610.png

Author

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

Size

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

Content