Skip to Content
Last modified by Helena on 2025/09/10 11:19
From version 2.10
edited by Helena
on 2025/05/21 15:00
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  
... ... @@ -1027,49 +1027,31 @@
1027 1027  Report Structure
1028 1028  Metadata Attribute
1029 1029  )))
1030 -|(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)
1031 -|(% style="width:171px" %) |(% style="width:232px" %) |(% style="width:206px" %)
1032 -
1033 -(% style="width:1644.71px" %)
1034 -|(% colspan="2" style="width:213px" %)Structure Usage|(% colspan="2" style="width:1193px" %)Dataflow Definition|(% colspan="2" style="width:234.418px" %)
1035 -|(% colspan="2" style="width:213px" %) |(% colspan="2" style="width:1193px" %)Metadataflow Definition|(% colspan="2" style="width:234.418px" %)
1036 -|(% colspan="2" style="width:213px" %)None|(% colspan="2" style="width:1193px" %)Process|(% colspan="2" style="width:234.418px" %)Process Step
1037 -|(% colspan="2" style="width:213px" %)None|(% colspan="2" style="width:1193px" %)Structure Set|(% colspan="2" style="width:234.418px" %)(((
1030 +|(% style="width:171px" %)Structure Usage|(% style="width:232px" %)Dataflow Definition|(% style="width:206px" %)
1031 +|(% style="width:171px" %) |(% style="width:232px" %)Metadataflow Definition|(% style="width:206px" %)
1032 +|(% style="width:171px" %)None|(% style="width:232px" %)Process|(% style="width:206px" %)Process Step
1033 +|(% style="width:171px" %)None|(% style="width:232px" %)Structure Set|(% style="width:206px" %)(((
1038 1038  Component Map
1039 -
1040 1040  Concept Scheme Map
1041 -
1042 1042  Codelist Map
1043 -
1044 1044  Category Scheme Map
1045 -
1046 1046  Reporting Taxonomy Map
1047 -
1048 1048  Organisation Scheme Map
1049 -
1050 1050  Concept Map
1051 -
1052 1052  Code Map
1053 -
1054 1054  Category Map
1055 -
1056 1056  Organisation Map
1057 -
1058 1058  Reporting Category Map
1059 -
1060 1060  Hybrid Codelist Map
1061 -
1062 1062  Hybrid Code Map
1063 1063  )))
1064 -|(% colspan="2" style="width:213px" %)None|(% colspan="2" style="width:1193px" %)Provision Agreement|(% colspan="2" style="width:234.418px" %)
1065 -|(% colspan="2" style="width:213px" %)None|(% colspan="2" style="width:1193px" %)Hierarchical Codelist|(% colspan="2" style="width:234.418px" %)(((
1048 +|(% style="width:171px" %)None|(% style="width:232px" %)Provision Agreement|(% style="width:206px" %)
1049 +|(% style="width:171px" %)None|(% style="width:232px" %)Hierarchical Codelist|(% style="width:206px" %)(((
1066 1066  Hierarchy
1067 -
1068 1068  Hierarchical Code
1069 1069  )))
1070 -|(% style="width:86px" %) |(% style="width:127px" %) |(% style="width:426px" %) |(% style="width:767.58px" %) | |(% style="width:1.41771px" %)
1071 1071  
1072 -**Table 4: Table of Maintainable Artefacts for Structural Definition Metadata**
1054 +**able 4: Table of Maintainable Artefacts for Structural Definition Metadata**
1073 1073  
1074 1074  === 7.1.2 Item Scheme, Structure ===
1075 1075  
... ... @@ -1076,10 +1076,7 @@
1076 1076  The artefacts included in the structural definitions are:
1077 1077  
1078 1078  * All types of Item Scheme (Codelist, Concept Scheme, Category Scheme, Organisation Scheme - Agency Scheme, Data Provider Scheme, Data Consumer Scheme, Organisation Unit Scheme)
1079 -* All types of Structure (Data Structure Definition, Metadata Structure
1080 -
1081 -Definition)
1082 -
1061 +* All types of Structure (Data Structure Definition, Metadata Structure Definition)
1083 1083  * All types of Structure Usage (Dataflow Definition, Metadataflow Definition)
1084 1084  
1085 1085  === 7.1.3 Structure Usage ===
... ... @@ -1098,6 +1098,8 @@
1098 1098  
1099 1099  ==== 7.1.3.3 Structure Usage Model ====
1100 1100  
1080 +[[image:1747829078194-749.png]]
1081 +
1101 1101  **Figure 10: SDMX-IM of links from Structure Usage to Category**
1102 1102  
1103 1103  In addition to the maintenance of the Dataflow Definition and the Metadataflow Definition the following links must be maintained in the registry:
... ... @@ -1124,10 +1124,10 @@
1124 1124  
1125 1125  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.
1126 1126  
1108 +[[image:1747829109466-595.png]]
1127 1127  
1128 1128  **Figure 11: SDMX-IM of the Data Provider**
1129 1129  
1130 -
1131 1131  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
1132 1132  
1133 1133  [[image:1747824123019-181.jpeg]]
... ... @@ -1136,8 +1136,10 @@
1136 1136  
1137 1137  The diagram below is a logical representation of the data required in order to maintain Provision Agreements.
1138 1138  
1120 +[[image:1747829139951-378.png]]
1139 1139  
1140 -==== 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**
1141 1141  
1142 1142  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.
1143 1143  
... ... @@ -1165,13 +1165,12 @@
1165 1165  
1166 1166  === 7.3.3 Data and Metadata Constraints: Model ===
1167 1167  
1151 +[[image:1747829204737-370.png]]
1168 1168  
1153 +**Figure 15: Logical class diagram showing inheritance between and reference to constrainable artifacts**
1169 1169  
1170 -==== 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.
1171 1171  
1172 -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.
1173 -
1174 -
1175 1175  The content of the Constraint can be found in the SDMX Information Model document.
1176 1176  
1177 1177  == 7.4 Data and Metadata Registration ==
... ... @@ -1206,11 +1206,14 @@
1206 1206  
1207 1207  The Registration has an action attribute which takes one of the following values:
1208 1208  
1209 -|**Action Attribute Value**|**Behaviour**
1210 -|Append|Add this Registration to the registry
1211 -|Replace|Replace the existing Registration with identified by the id in the Registration of the Submit Registration Request
1212 -|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
1213 1213  
1197 +[[image:1747829290890-122.png]]
1198 +
1214 1214  **Figure 17: Logical Class Diagram of Registration of Data and Metadata**
1215 1215  
1216 1216  The Query Datasource is an abstract class that represents a data source which can understand an SDMX-ML query (SOAPDatasource) or RESTful query
... ... @@ -1225,25 +1225,19 @@
1225 1225  
1226 1226  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.
1227 1227  
1228 -|**Indexing Required**|**Registration Process Activity**
1229 -|indexTimeSeries|Extract all the series keys and create a KeySet(s) Constraint.
1230 -|indexDataSet|(((
1231 -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
1232 -
1233 -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.
1234 1234  )))
1235 -|indexReportingPeriod|(((
1218 +|(% style="width:185px" %)indexReportingPeriod|(% style="width:1686px" %)(((
1236 1236  This applies only to a registered dataset.
1237 -
1238 1238  Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint.
1239 1239  )))
1240 -|indexAttributes|(((
1222 +|(% style="width:185px" %)indexAttributes|(% style="width:1686px" %)(((
1241 1241  **Data Set**
1242 -
1243 1243  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
1244 -
1245 1245  **Metadata Set**
1246 -
1247 1247  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.
1248 1248  )))
1249 1249  
... ... @@ -1253,14 +1253,13 @@
1253 1253  
1254 1254  === 7.4.3 Registration Response ===
1255 1255  
1256 -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”.
1257 1257  
1258 -“Success”, “Warning” or “Failure”.
1259 -
1260 1260  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.
1261 1261  
1262 1262  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:
1263 1263  
1241 +[[image:1747829477882-750.png]]
1264 1264  
1265 1265  **Figure 18: Logical class diagram showing the registration response**
1266 1266  
... ... @@ -1270,15 +1270,12 @@
1270 1270  
1271 1271  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.
1272 1272  
1273 -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”.
1274 1274  
1275 -“notification”.
1253 +=== 7.5.1Subscription Logical Class Diagram ===
1276 1276  
1277 - 7.5.1Subscription Logical Class Diagram
1255 +[[image:1747829554603-150.png]]
1278 1278  
1279 -
1280 -[[image:1747824123028-257.png]]
1281 -
1282 1282  **Figure 19: Logical Class Diagram of the Subscription**
1283 1283  
1284 1284  === 7.5.2 Subscription Information ===
... ... @@ -1285,73 +1285,58 @@
1285 1285  
1286 1286  Regardless of the type of registry/repository events being observed, a subscription always contains:
1287 1287  
1288 -~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:
1289 1289  
1290 -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
1291 1291  
1292 -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.
1293 -
1294 -4. A selector which specifies which type of events are of interest. The set of event types is:
1295 -
1296 -|**Event Type**|**Comment**
1297 -|STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1298 -|DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
1299 -|METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
1300 -|ALL_EVENTS|All events of the specified EventType
1301 -
1302 1302  === 7.5.3 Wildcard Facility ===
1303 1303  
1304 1304  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:
1305 1305  
1306 - agencyID
1278 +* agencyID
1279 +* id
1280 +* version
1307 1307  
1308 - id
1309 -
1310 - version
1311 -
1312 1312  Examples of wildcarded identifier components for an identified object type of Codelist are shown below.
1313 1313  
1314 -AgencyID = %
1315 -
1284 +//AgencyID = %
1316 1316  Id = %
1286 +Version = %//
1317 1317  
1318 -Version = %
1319 -
1320 1320  This subscribes to all Codelists of all versions for all agencies.
1321 1321  
1322 -AgencyID = AGENCY1
1323 -
1290 +//AgencyID = AGENCY1
1324 1324  Id = CODELIST1
1292 +Version = %//
1325 1325  
1326 -Version = %
1327 -
1328 1328  This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1329 1329  
1330 -AGENCY1
1331 -
1296 +//AGENCY1
1332 1332  AgencyID = AGENCY1
1333 -
1334 1334  Id = %
1299 +Version = %//
1335 1335  
1336 -Version = %
1337 -
1338 1338  This subscribes to all versions of all Codelist objects maintained by the agency
1339 1339  
1340 -AGENCY1
1341 -
1303 +//AGENCY1
1342 1342  AgencyID = %
1343 -
1344 1344  Id = CODELIST1
1306 +Version = %//
1345 1345  
1346 -Version = %
1347 -
1348 1348  This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1349 1349  
1350 -AGENCY1
1310 +//AGENCY1//
1351 1351  
1352 1352  Note that if the subscription is to the latest version then this can be achieved by the * character
1353 1353  
1354 -i.e. Version = *
1314 +//i.e. Version = *//
1355 1355  
1356 1356  Note that a subscription using the URN mechanism cannot use wildcard characters.
1357 1357  
... ... @@ -1363,16 +1363,15 @@
1363 1363  
1364 1364  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:
1365 1365  
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.
1366 1366  
1367 -|**Selector**|**Comment**
1368 -|DataProvider|Any datasets or metadata sets registered by the specified data provider will activate the notification.
1369 -|ProvisionAgreement|Any datasets or metadata sets registered for the provision agreement will activate the notification.
1370 -|Dataflow (&Metadataflow)|Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
1371 -|DataStructureDefinition & MetadataStructureDefinition|Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will
1372 -|**Selector**|**Comment**
1373 -| |activate the notification.
1374 -|Category|Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category.
1375 -
1376 1376  The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration.
1377 1377  
1378 1378  == 7.6 Notification ==
... ... @@ -1379,8 +1379,10 @@
1379 1379  
1380 1380  === 7.6.1 Logical Class Diagram ===
1381 1381  
1341 +[[image:1747829675568-610.png]]
1382 1382  
1383 -==== Figure 20: Logical Class Diagram of the Notification ====
1343 +(% class="wikigeneratedid" id="HFigure20:LogicalClassDiagramoftheNotification" %)
1344 +**Figure 20: Logical Class Diagram of the Notification**
1384 1384  
1385 1385  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.
1386 1386  
... ... @@ -1400,5 +1400,3 @@
1400 1400  === 7.6.3 Registration Event Component ===
1401 1401  
1402 1402  The notification will contain the Registration.
1403 -
1404 -
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