Skip to Content
Last modified by Helena on 2025/09/10 11:19
From version 2.15
edited by Helena
on 2025/05/21 15:08
Change comment: There is no comment for this version
To version 3.2
edited by Helena
on 2025/05/21 15:15
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  
... ... @@ -1210,25 +1210,19 @@
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 -|**Indexing Required**|**Registration Process Activity**
1214 -|indexTimeSeries|Extract all the series keys and create a KeySet(s) Constraint.
1215 -|indexDataSet|(((
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
1217 -
1218 -Regions containing Member Selections of Dimension Components of the Constraints model in the SDMX-IM, and the associated Selection Value.
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.
1219 1219  )))
1220 -|indexReportingPeriod|(((
1218 +|(% style="width:185px" %)indexReportingPeriod|(% style="width:1686px" %)(((
1221 1221  This applies only to a registered dataset.
1222 -
1223 1223  Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint.
1224 1224  )))
1225 -|indexAttributes|(((
1222 +|(% style="width:185px" %)indexAttributes|(% style="width:1686px" %)(((
1226 1226  **Data Set**
1227 -
1228 1228  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
1229 -
1230 1230  **Metadata Set**
1231 -
1232 1232  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.
1233 1233  )))
1234 1234  
... ... @@ -1238,14 +1238,13 @@
1238 1238  
1239 1239  === 7.4.3 Registration Response ===
1240 1240  
1241 -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
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”.
1242 1242  
1243 -“Success”, “Warning” or “Failure”.
1244 -
1245 1245  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.
1246 1246  
1247 1247  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:
1248 1248  
1241 +[[image:1747829477882-750.png]]
1249 1249  
1250 1250  **Figure 18: Logical class diagram showing the registration response**
1251 1251  
... ... @@ -1255,15 +1255,12 @@
1255 1255  
1256 1256  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.
1257 1257  
1258 -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
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”.
1259 1259  
1260 -“notification”.
1253 +=== 7.5.1Subscription Logical Class Diagram ===
1261 1261  
1262 - 7.5.1Subscription Logical Class Diagram
1255 +[[image:1747829554603-150.png]]
1263 1263  
1264 -
1265 -[[image:1747824123028-257.png]]
1266 -
1267 1267  **Figure 19: Logical Class Diagram of the Subscription**
1268 1268  
1269 1269  === 7.5.2 Subscription Information ===
... ... @@ -1270,73 +1270,58 @@
1270 1270  
1271 1271  Regardless of the type of registry/repository events being observed, a subscription always contains:
1272 1272  
1273 -~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.
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:
1274 1274  
1275 -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.
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
1276 1276  
1277 -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.
1278 -
1279 -4. A selector which specifies which type of events are of interest. The set of event types is:
1280 -
1281 -|**Event Type**|**Comment**
1282 -|STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1283 -|DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
1284 -|METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
1285 -|ALL_EVENTS|All events of the specified EventType
1286 -
1287 1287  === 7.5.3 Wildcard Facility ===
1288 1288  
1289 1289  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:
1290 1290  
1291 - agencyID
1278 +* agencyID
1279 +* id
1280 +* version
1292 1292  
1293 - id
1294 -
1295 - version
1296 -
1297 1297  Examples of wildcarded identifier components for an identified object type of Codelist are shown below.
1298 1298  
1299 -AgencyID = %
1300 -
1284 +//AgencyID = %
1301 1301  Id = %
1286 +Version = %//
1302 1302  
1303 -Version = %
1304 -
1305 1305  This subscribes to all Codelists of all versions for all agencies.
1306 1306  
1307 -AgencyID = AGENCY1
1308 -
1290 +//AgencyID = AGENCY1
1309 1309  Id = CODELIST1
1292 +Version = %//
1310 1310  
1311 -Version = %
1312 -
1313 1313  This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1314 1314  
1315 -AGENCY1
1316 -
1296 +//AGENCY1
1317 1317  AgencyID = AGENCY1
1318 -
1319 1319  Id = %
1299 +Version = %//
1320 1320  
1321 -Version = %
1322 -
1323 1323  This subscribes to all versions of all Codelist objects maintained by the agency
1324 1324  
1325 -AGENCY1
1326 -
1303 +//AGENCY1
1327 1327  AgencyID = %
1328 -
1329 1329  Id = CODELIST1
1306 +Version = %//
1330 1330  
1331 -Version = %
1332 -
1333 1333  This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1334 1334  
1335 -AGENCY1
1310 +//AGENCY1//
1336 1336  
1337 1337  Note that if the subscription is to the latest version then this can be achieved by the * character
1338 1338  
1339 -i.e. Version = *
1314 +//i.e. Version = *//
1340 1340  
1341 1341  Note that a subscription using the URN mechanism cannot use wildcard characters.
1342 1342  
... ... @@ -1348,16 +1348,15 @@
1348 1348  
1349 1349  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:
1350 1350  
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.
1351 1351  
1352 -|**Selector**|**Comment**
1353 -|DataProvider|Any datasets or metadata sets registered by the specified data provider will activate the notification.
1354 -|ProvisionAgreement|Any datasets or metadata sets registered for the provision agreement will activate the notification.
1355 -|Dataflow (&Metadataflow)|Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
1356 -|DataStructureDefinition & MetadataStructureDefinition|Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will
1357 -|**Selector**|**Comment**
1358 -| |activate the notification.
1359 -|Category|Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category.
1360 -
1361 1361  The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration.
1362 1362  
1363 1363  == 7.6 Notification ==
... ... @@ -1364,8 +1364,10 @@
1364 1364  
1365 1365  === 7.6.1 Logical Class Diagram ===
1366 1366  
1341 +[[image:1747829675568-610.png]]
1367 1367  
1368 -==== Figure 20: Logical Class Diagram of the Notification ====
1343 +(% class="wikigeneratedid" id="HFigure20:LogicalClassDiagramoftheNotification" %)
1344 +**Figure 20: Logical Class Diagram of the Notification**
1369 1369  
1370 1370  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.
1371 1371  
... ... @@ -1385,5 +1385,3 @@
1385 1385  === 7.6.3 Registration Event Component ===
1386 1386  
1387 1387  The notification will contain the Registration.
1388 -
1389 -
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