Skip to Content
Last modified by Helena on 2025/09/10 11:19
From version 3.2
edited by Helena
on 2025/05/21 15:15
Change comment: There is no comment for this version
To version 2.14
edited by Helena
on 2025/05/21 15:07
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -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.
505 +**SDMXPrefix:** urn:sdmx:org.                                     
506 506  
507 507  **SDMX-IM package name:** sdmx.infomodel.package=
508 508  
... ... @@ -1194,8 +1194,6 @@
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  
1197 -[[image:1747829290890-122.png]]
1198 -
1199 1199  **Figure 17: Logical Class Diagram of Registration of Data and Metadata**
1200 1200  
1201 1201  The Query Datasource is an abstract class that represents a data source which can understand an SDMX-ML query (SOAPDatasource) or RESTful query
... ... @@ -1210,19 +1210,25 @@
1210 1210  
1211 1211  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.
1212 1212  
1213 -|(% style="width:185px" %)**Indexing Required**|(% style="width:1686px" %)**Registration Process Activity**
1214 -|(% style="width:185px" %)indexTimeSeries|(% style="width:1686px" %)Extract all the series keys and create a KeySet(s) Constraint.
1215 -|(% style="width:185px" %)indexDataSet|(% style="width:1686px" %)(((
1216 -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.
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.
1217 1217  )))
1218 -|(% style="width:185px" %)indexReportingPeriod|(% style="width:1686px" %)(((
1218 +|indexReportingPeriod|(((
1219 1219  This applies only to a registered dataset.
1220 +
1220 1220  Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint.
1221 1221  )))
1222 -|(% style="width:185px" %)indexAttributes|(% style="width:1686px" %)(((
1223 +|indexAttributes|(((
1223 1223  **Data Set**
1225 +
1224 1224  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 +
1225 1225  **Metadata Set**
1229 +
1226 1226  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.
1227 1227  )))
1228 1228  
... ... @@ -1232,13 +1232,14 @@
1232 1232  
1233 1233  === 7.4.3 Registration Response ===
1234 1234  
1235 -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”.
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
1236 1236  
1241 +“Success”, “Warning” or “Failure”.
1242 +
1237 1237  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.
1238 1238  
1239 1239  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:
1240 1240  
1241 -[[image:1747829477882-750.png]]
1242 1242  
1243 1243  **Figure 18: Logical class diagram showing the registration response**
1244 1244  
... ... @@ -1248,12 +1248,15 @@
1248 1248  
1249 1249  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.
1250 1250  
1251 -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”.
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
1252 1252  
1253 -=== 7.5.1Subscription Logical Class Diagram ===
1258 +“notification”.
1254 1254  
1255 -[[image:1747829554603-150.png]]
1260 + 7.5.1Subscription Logical Class Diagram
1256 1256  
1262 +
1263 +[[image:1747824123028-257.png]]
1264 +
1257 1257  **Figure 19: Logical Class Diagram of the Subscription**
1258 1258  
1259 1259  === 7.5.2 Subscription Information ===
... ... @@ -1260,58 +1260,73 @@
1260 1260  
1261 1261  Regardless of the type of registry/repository events being observed, a subscription always contains:
1262 1262  
1263 -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 -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.
1265 -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.
1266 -1. A selector which specifies which type of events are of interest. The set of event types is:
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.
1267 1267  
1268 -|(% style="width:327px" %)**Event Type**|(% style="width:1545px" %)**Comment**
1269 -|(% style="width:327px" %)STRUCTURAL_REPOSITORY_EVENTS|(% style="width:1545px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1270 -|(% 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.
1271 -|(% 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.
1272 -|(% style="width:327px" %)ALL_EVENTS|(% style="width:1545px" %)All events of the specified EventType
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.
1273 1273  
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 +
1274 1274  === 7.5.3 Wildcard Facility ===
1275 1275  
1276 1276  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:
1277 1277  
1278 -* agencyID
1279 -* id
1280 -* version
1289 + agencyID
1281 1281  
1291 + id
1292 +
1293 + version
1294 +
1282 1282  Examples of wildcarded identifier components for an identified object type of Codelist are shown below.
1283 1283  
1284 -//AgencyID = %
1297 +AgencyID = %
1298 +
1285 1285  Id = %
1286 -Version = %//
1287 1287  
1301 +Version = %
1302 +
1288 1288  This subscribes to all Codelists of all versions for all agencies.
1289 1289  
1290 -//AgencyID = AGENCY1
1305 +AgencyID = AGENCY1
1306 +
1291 1291  Id = CODELIST1
1292 -Version = %//
1293 1293  
1309 +Version = %
1310 +
1294 1294  This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1295 1295  
1296 -//AGENCY1
1313 +AGENCY1
1314 +
1297 1297  AgencyID = AGENCY1
1316 +
1298 1298  Id = %
1299 -Version = %//
1300 1300  
1319 +Version = %
1320 +
1301 1301  This subscribes to all versions of all Codelist objects maintained by the agency
1302 1302  
1303 -//AGENCY1
1323 +AGENCY1
1324 +
1304 1304  AgencyID = %
1326 +
1305 1305  Id = CODELIST1
1306 -Version = %//
1307 1307  
1329 +Version = %
1330 +
1308 1308  This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1309 1309  
1310 -//AGENCY1//
1333 +AGENCY1
1311 1311  
1312 1312  Note that if the subscription is to the latest version then this can be achieved by the * character
1313 1313  
1314 -//i.e. Version = *//
1337 +i.e. Version = *
1315 1315  
1316 1316  Note that a subscription using the URN mechanism cannot use wildcard characters.
1317 1317  
... ... @@ -1323,15 +1323,16 @@
1323 1323  
1324 1324  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:
1325 1325  
1326 -|(% style="width:405px" %)**Selector**|(% style="width:1467px" %)**Comment**
1327 -|(% style="width:405px" %)DataProvider|(% style="width:1467px" %)Any datasets or metadata sets registered by the specified data provider will activate the notification.
1328 -|(% style="width:405px" %)ProvisionAgreement|(% style="width:1467px" %)Any datasets or metadata sets registered for the provision agreement will activate the notification.
1329 -|(% style="width:405px" %)Dataflow (&Metadataflow)|(% style="width:1467px" %)Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
1330 -|(% 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
1331 -|(% style="width:405px" %)**Selector**|(% style="width:1467px" %)**Comment**
1332 -|(% style="width:405px" %) |(% style="width:1467px" %)activate the notification.
1333 -|(% 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.
1334 1334  
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 +
1335 1335  The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration.
1336 1336  
1337 1337  == 7.6 Notification ==
... ... @@ -1338,10 +1338,8 @@
1338 1338  
1339 1339  === 7.6.1 Logical Class Diagram ===
1340 1340  
1341 -[[image:1747829675568-610.png]]
1342 1342  
1343 -(% class="wikigeneratedid" id="HFigure20:LogicalClassDiagramoftheNotification" %)
1344 -**Figure 20: Logical Class Diagram of the Notification**
1366 +==== Figure 20: Logical Class Diagram of the Notification ====
1345 1345  
1346 1346  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.
1347 1347  
... ... @@ -1361,3 +1361,5 @@
1361 1361  === 7.6.3 Registration Event Component ===
1362 1362  
1363 1363  The notification will contain the Registration.
1386 +
1387 +
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