Skip to Content
Last modified by Helena on 2025/09/10 11:19
From version 2.11
edited by Helena
on 2025/05/21 15:04
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  
... ... @@ -1077,6 +1077,8 @@
1077 1077  
1078 1078  ==== 7.1.3.3 Structure Usage Model ====
1079 1079  
1080 +[[image:1747829078194-749.png]]
1081 +
1080 1080  **Figure 10: SDMX-IM of links from Structure Usage to Category**
1081 1081  
1082 1082  In addition to the maintenance of the Dataflow Definition and the Metadataflow Definition the following links must be maintained in the registry:
... ... @@ -1103,10 +1103,10 @@
1103 1103  
1104 1104  An organisation which publishes statistical data or reference metadata and wishes to make it available to an SDMX enabled community is called a Data Provider. In terms of the SDMX Information Model, the Data Provider is maintained in a Data Provider Scheme.
1105 1105  
1108 +[[image:1747829109466-595.png]]
1106 1106  
1107 1107  **Figure 11: SDMX-IM of the Data Provider**
1108 1108  
1109 -
1110 1110  Note that the Data Provider does not inherit the hierarchy association. The diagram below shows a logical schematic of the data model classes required to maintain provision agreements
1111 1111  
1112 1112  [[image:1747824123019-181.jpeg]]
... ... @@ -1115,8 +1115,10 @@
1115 1115  
1116 1116  The diagram below is a logical representation of the data required in order to maintain Provision Agreements.
1117 1117  
1120 +[[image:1747829139951-378.png]]
1118 1118  
1119 -==== Figure 13: Logical class diagram of the information contained in the Provision Agreement ====
1122 +(% class="wikigeneratedid" id="HFigure13:LogicalclassdiagramoftheinformationcontainedintheProvisionAgreement" %)
1123 +**Figure 13: Logical class diagram of the information contained in the Provision Agreement**
1120 1120  
1121 1121  A Provision Agreement is structural metadata. Each Provision Agreement must reference a Data Provider and a Dataflow or Metadataflow Definition. The Data Provider and the Dataflow/Metadataflow Definition must exist already in order to set up a Provision Agreement.
1122 1122  
... ... @@ -1144,13 +1144,12 @@
1144 1144  
1145 1145  === 7.3.3 Data and Metadata Constraints: Model ===
1146 1146  
1151 +[[image:1747829204737-370.png]]
1147 1147  
1153 +**Figure 15: Logical class diagram showing inheritance between and reference to constrainable artifacts**
1148 1148  
1149 -==== Figure 15: Logical class diagram showing inheritance between and reference to constrainable artifacts ====
1155 +The class diagram above shows that DataProvider, DataflowDefinition, MetadataflowDefinition, ProvisionAgreement, DataStructureDefinition, MetadataStructureDefinition, SimpleDatasource and QueryDatasource are all concrete sub-classes of ConstrainableArtefact and can therefore have Constraints specified. Note that the actual Constraint as submitted is associated to the reference classes which inherit from ConstrainableRef: these are used to refer to the classes to which the Constraint applies.
1150 1150  
1151 -The class diagram above shows that DataProvider, DataflowDefinition, MetadataflowDefinition, ProvisionAgreement, DataStructureDefinition, MetadataStructureDefinition, SimpleDatasource and QueryDatasource are all concrete sub-classes of ConstrainableArtefact and can therefore have Constraints specified. Note that the actual Constraint as submitted is associated to the reference classes which inherit from ConstrainableRef: these are used to refer to the classes to which the Constraint applies.
1152 -
1153 -
1154 1154  The content of the Constraint can be found in the SDMX Information Model document.
1155 1155  
1156 1156  == 7.4 Data and Metadata Registration ==
... ... @@ -1185,11 +1185,14 @@
1185 1185  
1186 1186  The Registration has an action attribute which takes one of the following values:
1187 1187  
1188 -|**Action Attribute Value**|**Behaviour**
1189 -|Append|Add this Registration to the registry
1190 -|Replace|Replace the existing Registration with identified by the id in the Registration of the Submit Registration Request
1191 -|Delete|Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
1191 +(% style="width:970.294px" %)
1192 +|(% style="width:212px" %)**Action Attribute Value**|(% style="width:756px" %)**Behaviour**
1193 +|(% style="width:212px" %)Append|(% style="width:756px" %)Add this Registration to the registry
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 +|(% style="width:212px" %)Delete|(% style="width:756px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
1192 1192  
1197 +[[image:1747829290890-122.png]]
1198 +
1193 1193  **Figure 17: Logical Class Diagram of Registration of Data and Metadata**
1194 1194  
1195 1195  The Query Datasource is an abstract class that represents a data source which can understand an SDMX-ML query (SOAPDatasource) or RESTful query
... ... @@ -1204,25 +1204,19 @@
1204 1204  
1205 1205  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.
1206 1206  
1207 -|**Indexing Required**|**Registration Process Activity**
1208 -|indexTimeSeries|Extract all the series keys and create a KeySet(s) Constraint.
1209 -|indexDataSet|(((
1210 -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
1211 -
1212 -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.
1213 1213  )))
1214 -|indexReportingPeriod|(((
1218 +|(% style="width:185px" %)indexReportingPeriod|(% style="width:1686px" %)(((
1215 1215  This applies only to a registered dataset.
1216 -
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 -|indexAttributes|(((
1222 +|(% style="width:185px" %)indexAttributes|(% style="width:1686px" %)(((
1220 1220  **Data Set**
1221 -
1222 1222  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
1223 -
1224 1224  **Metadata Set**
1225 -
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,14 +1232,13 @@
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
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”.
1236 1236  
1237 -“Success”, “Warning” or “Failure”.
1238 -
1239 1239  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.
1240 1240  
1241 1241  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:
1242 1242  
1241 +[[image:1747829477882-750.png]]
1243 1243  
1244 1244  **Figure 18: Logical class diagram showing the registration response**
1245 1245  
... ... @@ -1249,15 +1249,12 @@
1249 1249  
1250 1250  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.
1251 1251  
1252 -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”.
1253 1253  
1254 -“notification”.
1253 +=== 7.5.1Subscription Logical Class Diagram ===
1255 1255  
1256 - 7.5.1Subscription Logical Class Diagram
1255 +[[image:1747829554603-150.png]]
1257 1257  
1258 -
1259 -[[image:1747824123028-257.png]]
1260 -
1261 1261  **Figure 19: Logical Class Diagram of the Subscription**
1262 1262  
1263 1263  === 7.5.2 Subscription Information ===
... ... @@ -1264,73 +1264,58 @@
1264 1264  
1265 1265  Regardless of the type of registry/repository events being observed, a subscription always contains:
1266 1266  
1267 -~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:
1268 1268  
1269 -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
1270 1270  
1271 -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.
1272 -
1273 -4. A selector which specifies which type of events are of interest. The set of event types is:
1274 -
1275 -|**Event Type**|**Comment**
1276 -|STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1277 -|DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
1278 -|METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
1279 -|ALL_EVENTS|All events of the specified EventType
1280 -
1281 1281  === 7.5.3 Wildcard Facility ===
1282 1282  
1283 1283  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:
1284 1284  
1285 - agencyID
1278 +* agencyID
1279 +* id
1280 +* version
1286 1286  
1287 - id
1288 -
1289 - version
1290 -
1291 1291  Examples of wildcarded identifier components for an identified object type of Codelist are shown below.
1292 1292  
1293 -AgencyID = %
1294 -
1284 +//AgencyID = %
1295 1295  Id = %
1286 +Version = %//
1296 1296  
1297 -Version = %
1298 -
1299 1299  This subscribes to all Codelists of all versions for all agencies.
1300 1300  
1301 -AgencyID = AGENCY1
1302 -
1290 +//AgencyID = AGENCY1
1303 1303  Id = CODELIST1
1292 +Version = %//
1304 1304  
1305 -Version = %
1306 -
1307 1307  This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1308 1308  
1309 -AGENCY1
1310 -
1296 +//AGENCY1
1311 1311  AgencyID = AGENCY1
1312 -
1313 1313  Id = %
1299 +Version = %//
1314 1314  
1315 -Version = %
1316 -
1317 1317  This subscribes to all versions of all Codelist objects maintained by the agency
1318 1318  
1319 -AGENCY1
1320 -
1303 +//AGENCY1
1321 1321  AgencyID = %
1322 -
1323 1323  Id = CODELIST1
1306 +Version = %//
1324 1324  
1325 -Version = %
1326 -
1327 1327  This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1328 1328  
1329 -AGENCY1
1310 +//AGENCY1//
1330 1330  
1331 1331  Note that if the subscription is to the latest version then this can be achieved by the * character
1332 1332  
1333 -i.e. Version = *
1314 +//i.e. Version = *//
1334 1334  
1335 1335  Note that a subscription using the URN mechanism cannot use wildcard characters.
1336 1336  
... ... @@ -1342,16 +1342,15 @@
1342 1342  
1343 1343  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:
1344 1344  
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.
1345 1345  
1346 -|**Selector**|**Comment**
1347 -|DataProvider|Any datasets or metadata sets registered by the specified data provider will activate the notification.
1348 -|ProvisionAgreement|Any datasets or metadata sets registered for the provision agreement will activate the notification.
1349 -|Dataflow (&Metadataflow)|Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
1350 -|DataStructureDefinition & MetadataStructureDefinition|Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will
1351 -|**Selector**|**Comment**
1352 -| |activate the notification.
1353 -|Category|Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category.
1354 -
1355 1355  The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration.
1356 1356  
1357 1357  == 7.6 Notification ==
... ... @@ -1358,8 +1358,10 @@
1358 1358  
1359 1359  === 7.6.1 Logical Class Diagram ===
1360 1360  
1341 +[[image:1747829675568-610.png]]
1361 1361  
1362 -==== Figure 20: Logical Class Diagram of the Notification ====
1343 +(% class="wikigeneratedid" id="HFigure20:LogicalClassDiagramoftheNotification" %)
1344 +**Figure 20: Logical Class Diagram of the Notification**
1363 1363  
1364 1364  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.
1365 1365  
... ... @@ -1379,5 +1379,3 @@
1379 1379  === 7.6.3 Registration Event Component ===
1380 1380  
1381 1381  The notification will contain the Registration.
1382 -
1383 -
1747829078194-749.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +40.4 KB
Content
1747829109466-595.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +30.4 KB
Content
1747829139951-378.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +21.1 KB
Content
1747829204737-370.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.helena
Size
... ... @@ -1,0 +1,1 @@
1 +55.8 KB
Content
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