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

Summary

Details

Page properties
Content
... ... @@ -1027,31 +1027,49 @@
1027 1027  Report Structure
1028 1028  Metadata Attribute
1029 1029  )))
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" %)(((
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" %)(((
1034 1034  Component Map
1039 +
1035 1035  Concept Scheme Map
1041 +
1036 1036  Codelist Map
1043 +
1037 1037  Category Scheme Map
1045 +
1038 1038  Reporting Taxonomy Map
1047 +
1039 1039  Organisation Scheme Map
1049 +
1040 1040  Concept Map
1051 +
1041 1041  Code Map
1053 +
1042 1042  Category Map
1055 +
1043 1043  Organisation Map
1057 +
1044 1044  Reporting Category Map
1059 +
1045 1045  Hybrid Codelist Map
1061 +
1046 1046  Hybrid Code Map
1047 1047  )))
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" %)(((
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" %)(((
1050 1050  Hierarchy
1067 +
1051 1051  Hierarchical Code
1052 1052  )))
1070 +|(% style="width:86px" %) |(% style="width:127px" %) |(% style="width:426px" %) |(% style="width:767.58px" %) | |(% style="width:1.41771px" %)
1053 1053  
1054 -**able 4: Table of Maintainable Artefacts for Structural Definition Metadata**
1072 +**Table 4: Table of Maintainable Artefacts for Structural Definition Metadata**
1055 1055  
1056 1056  === 7.1.2 Item Scheme, Structure ===
1057 1057  
... ... @@ -1058,7 +1058,10 @@
1058 1058  The artefacts included in the structural definitions are:
1059 1059  
1060 1060  * All types of Item Scheme (Codelist, Concept Scheme, Category Scheme, Organisation Scheme - Agency Scheme, Data Provider Scheme, Data Consumer Scheme, Organisation Unit Scheme)
1061 -* All types of Structure (Data Structure Definition, Metadata Structure Definition)
1079 +* All types of Structure (Data Structure Definition, Metadata Structure
1080 +
1081 +Definition)
1082 +
1062 1062  * All types of Structure Usage (Dataflow Definition, Metadataflow Definition)
1063 1063  
1064 1064  === 7.1.3 Structure Usage ===
... ... @@ -1077,8 +1077,6 @@
1077 1077  
1078 1078  ==== 7.1.3.3 Structure Usage Model ====
1079 1079  
1080 -[[image:1747829078194-749.png]]
1081 -
1082 1082  **Figure 10: SDMX-IM of links from Structure Usage to Category**
1083 1083  
1084 1084  In addition to the maintenance of the Dataflow Definition and the Metadataflow Definition the following links must be maintained in the registry:
... ... @@ -1105,10 +1105,10 @@
1105 1105  
1106 1106  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.
1107 1107  
1108 -[[image:1747829109466-595.png]]
1109 1109  
1110 1110  **Figure 11: SDMX-IM of the Data Provider**
1111 1111  
1130 +
1112 1112  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
1113 1113  
1114 1114  [[image:1747824123019-181.jpeg]]
... ... @@ -1117,10 +1117,8 @@
1117 1117  
1118 1118  The diagram below is a logical representation of the data required in order to maintain Provision Agreements.
1119 1119  
1120 -[[image:1747829139951-378.png]]
1121 1121  
1122 -(% class="wikigeneratedid" id="HFigure13:LogicalclassdiagramoftheinformationcontainedintheProvisionAgreement" %)
1123 -**Figure 13: Logical class diagram of the information contained in the Provision Agreement**
1140 +==== Figure 13: Logical class diagram of the information contained in the Provision Agreement ====
1124 1124  
1125 1125  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.
1126 1126  
... ... @@ -1148,12 +1148,13 @@
1148 1148  
1149 1149  === 7.3.3 Data and Metadata Constraints: Model ===
1150 1150  
1151 -[[image:1747829204737-370.png]]
1152 1152  
1153 -**Figure 15: Logical class diagram showing inheritance between and reference to constrainable artifacts**
1154 1154  
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.
1170 +==== Figure 15: Logical class diagram showing inheritance between and reference to constrainable artifacts ====
1156 1156  
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 +
1157 1157  The content of the Constraint can be found in the SDMX Information Model document.
1158 1158  
1159 1159  == 7.4 Data and Metadata Registration ==
... ... @@ -1188,14 +1188,11 @@
1188 1188  
1189 1189  The Registration has an action attribute which takes one of the following values:
1190 1190  
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
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
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.
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.
1217 1217  )))
1218 -|(% style="width:185px" %)indexReportingPeriod|(% style="width:1686px" %)(((
1235 +|indexReportingPeriod|(((
1219 1219  This applies only to a registered dataset.
1237 +
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" %)(((
1240 +|indexAttributes|(((
1223 1223  **Data Set**
1242 +
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
1244 +
1225 1225  **Metadata Set**
1246 +
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”.
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
1236 1236  
1258 +“Success”, “Warning” or “Failure”.
1259 +
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”.
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
1252 1252  
1253 -=== 7.5.1Subscription Logical Class Diagram ===
1275 +“notification”.
1254 1254  
1255 -[[image:1747829554603-150.png]]
1277 + 7.5.1Subscription Logical Class Diagram
1256 1256  
1279 +
1280 +[[image:1747824123028-257.png]]
1281 +
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:
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.
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
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.
1273 1273  
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 +
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
1306 + agencyID
1281 1281  
1308 + id
1309 +
1310 + version
1311 +
1282 1282  Examples of wildcarded identifier components for an identified object type of Codelist are shown below.
1283 1283  
1284 -//AgencyID = %
1314 +AgencyID = %
1315 +
1285 1285  Id = %
1286 -Version = %//
1287 1287  
1318 +Version = %
1319 +
1288 1288  This subscribes to all Codelists of all versions for all agencies.
1289 1289  
1290 -//AgencyID = AGENCY1
1322 +AgencyID = AGENCY1
1323 +
1291 1291  Id = CODELIST1
1292 -Version = %//
1293 1293  
1326 +Version = %
1327 +
1294 1294  This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1295 1295  
1296 -//AGENCY1
1330 +AGENCY1
1331 +
1297 1297  AgencyID = AGENCY1
1333 +
1298 1298  Id = %
1299 -Version = %//
1300 1300  
1336 +Version = %
1337 +
1301 1301  This subscribes to all versions of all Codelist objects maintained by the agency
1302 1302  
1303 -//AGENCY1
1340 +AGENCY1
1341 +
1304 1304  AgencyID = %
1343 +
1305 1305  Id = CODELIST1
1306 -Version = %//
1307 1307  
1346 +Version = %
1347 +
1308 1308  This subscribes to all versions of Codelist CODELIST1 maintained by the agency
1309 1309  
1310 -//AGENCY1//
1350 +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 = *//
1354 +i.e. Version = *
1315 1315  
1316 1316  Note that a subscription using the URN mechanism cannot use wildcard characters.
1317 1317  
1747829078194-749.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -40.4 KB
Content
1747829109466-595.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -30.4 KB
Content
1747829139951-378.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -21.1 KB
Content
1747829204737-370.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -55.8 KB
Content
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