Last modified by Artur on 2025/09/30 13:28

From version 22.15
edited by Helena
on 2025/06/08 17:08
Change comment: There is no comment for this version
To version 22.6
edited by Helena
on 2025/06/08 16:54
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -199,36 +199,36 @@
199 199  * QueryRegistrationRequest
200 200  * QueryRegistrationResponse
201 201  
202 -The Data Registration Service allows [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] conformant files and web-accessible databases containing published data and [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] to be registered in the [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]]. The registration process MAY validate the content of the [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] or metadata-sets, and MAY extract a concise [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the contents in terms of (% style="color:#e74c3c" %)concept(%%) values (e.g., values of the data [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], metadata [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]), or entire keys, and storing this as a record in the registry to enable discovery of the original [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] or metadata-set. These are called (% style="color:#e74c3c" %)Constraints(%%) in the [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]].
202 +The Data Registration Service allows SDMX conformant files and web-accessible databases containing published data and reference metadata to be registered in the SDMX Registry. The registration process MAY validate the content of the datasets or metadata-sets, and MAY extract a concise representation of the contents in terms of concept values (e.g., values of the data attribute, dimension, metadata attribute), or entire keys, and storing this as a record in the registry to enable discovery of the original dataset or metadata-set. These are called Constraints in the SDMX-IM.
203 203  
204 204  The Data Registration Service MAY validate the following, subject to the access control mechanism implemented in the Registry:
205 205  
206 -* that the data/metadata provider is allowed to register the [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] or metadataset;
207 -* that the content of the [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] or metadataset meets the validation (% style="color:#e74c3c" %)constraints(%%). This is dependent upon such (% style="color:#e74c3c" %)constraints(%%) being defined in the structural repository and which reference the relevant [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]], [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]], Metadata Provider, [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], Metadata [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]];
208 -* that a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] exists – this would necessitate the registration service querying the service to determine its existence;
209 -* that a simple [[data source>>doc:sdmx:Glossary.Data source.WebHome]] exists (i.e., a file accessible at a URL);
210 -* that the correct [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] is used by the registered data;
211 -* that the [[components>>doc:sdmx:Glossary.Component.WebHome]] ([[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]], [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]], [[Measures>>doc:sdmx:Glossary.Measure.WebHome]]) are consistent with the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]];
212 -* that the valid [[representations>>doc:sdmx:Glossary.Representation.WebHome]] of the (% style="color:#e74c3c" %)concepts(%%) to which these [[components>>doc:sdmx:Glossary.Component.WebHome]] correspond conform to the definition in the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]].
206 +* that the data/metadata provider is allowed to register the dataset or metadataset;
207 +* that the content of the dataset or metadataset meets the validation constraints. This is dependent upon such constraints being defined in the structural repository and which reference the relevant Dataflow, Metadataflow, Data Provider, Metadata Provider, Data Structure Definition, Metadata Structure Definition, Provision Agreement, Metadata Provision Agreement;
208 +* that a queryable data source exists – this would necessitate the registration service querying the service to determine its existence;
209 +* that a simple data source exists (i.e., a file accessible at a URL);
210 +* that the correct Data Structure Definition is used by the registered data;
211 +* that the components (Dimensions, Attributes, Measures) are consistent with the Data Structure Definition;
212 +* that the valid representations of the concepts to which these components correspond conform to the definition in the Data Structure Definition.
213 213  
214 -The Registration has an action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] which takes one of the following values:
214 +The Registration has an action attribute which takes one of the following values:
215 215  
216 216  (% style="width:893.835px" %)
217 -|(% style="width:241px" %)**Action [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Value**|(% style="width:650px" %)**Behaviour**
217 +|(% style="width:241px" %)**Action Attribute Value**|(% style="width:650px" %)**Behaviour**
218 218  |(% style="width:241px" %)Append|(% style="width:650px" %)Add this registration to the registry
219 219  |(% style="width:241px" %)Replace|(% style="width:650px" %)Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request
220 220  |(% style="width:241px" %)Delete|(% style="width:650px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
221 221  
222 -The Registration has three Boolean [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] which may be present to determine how an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] compliant [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] or metadataset indexing application must index the [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] or metadatasets upon registration. The indexing application behaviour is as follows:
222 +The Registration has three Boolean attributes which may be present to determine how an SDMX compliant dataset or metadataset indexing application must index the datasets or metadatasets upon registration. The indexing application behaviour is as follows:
223 223  
224 224  (% style="width:896.835px" %)
225 -|**Boolean [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]**|(% style="width:712px" %)**Behaviour if Value is “true”**
225 +|**Boolean Attribute**|(% style="width:712px" %)**Behaviour if Value is “true”**
226 226  |indexTimeSeries|(% style="width:712px" %)A compliant indexing application must index all the time series keys
227 227  |indexDataSet|(% style="width:712px" %)(((
228 -A compliant indexing application must index the range of actual (present) values for each [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] of the [[Dataset>>doc:sdmx:Glossary.Data set.WebHome]].
229 -Note that for data this requires much less storage than full key indexing, but this method cannot guarantee that a specific combination of [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values (the Key) is actually present in the [[Dataset>>doc:sdmx:Glossary.Data set.WebHome]]
228 +A compliant indexing application must index the range of actual (present) values for each dimension of the Dataset.
229 +Note that for data this requires much less storage than full key indexing, but this method cannot guarantee that a specific combination of Dimension values (the Key) is actually present in the Dataset
230 230  )))
231 -|indexReportingPeriod|(% style="width:712px" %)A compliant indexing application must index the [[time period>>doc:sdmx:Glossary.Time period.WebHome]] range(s) for which data are present in the [[Dataset>>doc:sdmx:Glossary.Data set.WebHome]].
231 +|indexReportingPeriod|(% style="width:712px" %)A compliant indexing application must index the time period range(s) for which data are present in the Dataset.
232 232  
233 233  === 5.2.5 Data Discovery ===
234 234  
... ... @@ -239,55 +239,55 @@
239 239  
240 240  === 5.2.6 Subscription and Notification ===
241 241  
242 -The [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] and [[Notification>>doc:sdmx:Glossary.Notification.WebHome]] Service implements the following Registry Interfaces:
242 +The Subscription and Notification Service implements the following Registry Interfaces:
243 243  
244 244  * SubmitSubscriptionRequest
245 245  * SubmitSubscriptionResponse
246 246  * NotifyRegistryEvent
247 247  
248 -The data sharing paradigm relies upon the consumers of data and metadata being able to pull information from [[data providers>>doc:sdmx:Glossary.Data provider.WebHome]]’ dissemination systems. For this to work efficiently, a [[data consumer>>doc:sdmx:Glossary.Data consumer.WebHome]] needs to know when to pull data, i.e., when something has changed in the registry (e.g., a [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] has been updated and re-registered). Additionally, [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] systems may also want to know if a new [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], or [[Code List>>doc:sdmx:Glossary.Code list.WebHome]] has been added. The [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] and [[Notification>>doc:sdmx:Glossary.Notification.WebHome]] Service comprises two parts: [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] management, and [[notification>>doc:sdmx:Glossary.Notification.WebHome]].
248 +The data sharing paradigm relies upon the consumers of data and metadata being able to pull information from data providers’ dissemination systems. For this to work efficiently, a data consumer needs to know when to pull data, i.e., when something has changed in the registry (e.g., a dataset has been updated and re-registered). Additionally, SDMX systems may also want to know if a new Data Structure Definition, or Code List has been added. The Subscription and Notification Service comprises two parts: subscription management, and notification.
249 249  
250 -[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] management involves a user submitting a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request which contains:
250 +Subscription management involves a user submitting a subscription request which contains:
251 251  
252 -* a query or (% style="color:#e74c3c" %)constraint(%%) expression in terms of a filter which defines the events for which the user is interested (e.g., new data for a specific [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], or for a domain [[category>>doc:sdmx:Glossary.Category.WebHome]], or changes to a [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]).
253 -* a list of URIs or endpoints to which an XML [[notification>>doc:sdmx:Glossary.Notification.WebHome]] message can be sent. Supported endpoint types will be email (mailto and HTTP POST (a normal http:~/~/ address);
254 -* request for a list of submitted [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]];
255 -* deletion of a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]];
252 +* a query or constraint expression in terms of a filter which defines the events for which the user is interested (e.g., new data for a specific dataflow, or for a domain category, or changes to a Data Structure Definition).
253 +* a list of URIs or endpoints to which an XML notification message can be sent. Supported endpoint types will be email (mailto~:) and HTTP POST (a normal http:~/~/ address);
254 +* request for a list of submitted subscriptions;
255 +* deletion of a subscription;
256 256  
257 -[[Notification>>doc:sdmx:Glossary.Notification.WebHome]] requires that the [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository and the provisioning [[metadata repository>>doc:sdmx:Glossary.Metadata repository.WebHome]] monitor any event which is of interest to a user (the object of a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request query), and to issue an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[notification>>doc:sdmx:Glossary.Notification.WebHome]] document to the endpoints specified in the relevant [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]].
257 +Notification requires that the structural metadata repository and the provisioning metadata repository monitor any event which is of interest to a user (the object of a subscription request query), and to issue an SDMX notification document to the endpoints specified in the relevant subscriptions.
258 258  
259 259  === 5.2.7 Registry Behaviour ===
260 260  
261 -The following table defines the behaviour of the [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] for the various Registry Interface messages. It should be noted, though, that as of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0, an extended versioning scheme newly including semantic versioning is foreseen for all [[Maintainable Artefacts>>doc:sdmx:Glossary.Maintainable artefact.WebHome]]. Moreover, while the old versioning scheme is allowed, given there is no more a "final" flag, there is no way guaranteeing the consistency across (% style="color:#e74c3c" %)version(%%) of a Maintainable, unless semantic versioning is used.
261 +The following table defines the behaviour of the SDMX Registry for the various Registry Interface messages. It should be noted, though, that as of SDMX 3.0, an extended versioning scheme newly including semantic versioning is foreseen for all Maintainable Artefacts. Moreover, while the old versioning scheme is allowed, given there is no more a "final" flag, there is no way guaranteeing the consistency across version of a Maintainable, unless semantic versioning is used.
262 262  
263 -Given the above, the behaviour described in the following table concerns either draft [[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] using semantic versioning or any [[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] using the old versioning scheme. Nevertheless, in the case of semantic versioning the registry must respect the versioning rules when performing the actions below. For example, it is not possible to replace a non-draft [[Artefact>>doc:sdmx:Glossary.Artefact.WebHome]] that follows semantic versioning, unless a newer (% style="color:#e74c3c" %)version(%%) is introduced according to the semantic versioning rules. Furthermore, even when draft [[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] are submitted, the registry has to verify semantic versioning is respected against the previous non-draft (% style="color:#e74c3c" %)versions(%%). It is worth noting that the rules for semantic versioning and replacing or maintaining semantically versioned [[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] applies to externally shared [[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]. This means that any system may internally perform any change within a (% style="color:#e74c3c" %)version(%%) of an [[Artefact>>doc:sdmx:Glossary.Artefact.WebHome]], until the latter is shared outside of that system or becomes public. Then (as also explained in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”) the [[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] must adhere to the Semantic Versioning rules.
263 +Given the above, the behaviour described in the following table concerns either draft Artefacts using semantic versioning or any Artefacts using the old versioning scheme. Nevertheless, in the case of semantic versioning the registry must respect the versioning rules when performing the actions below. For example, it is not possible to replace a non-draft Artefact that follows semantic versioning, unless a newer version is introduced according to the semantic versioning rules. Furthermore, even when draft Artefacts are submitted, the registry has to verify semantic versioning is respected against the previous non-draft versions. It is worth noting that the rules for semantic versioning and replacing or maintaining semantically versioned Artefacts applies to externally shared Artefacts. This means that any system may internally perform any change within a version of an Artefact, until the latter is shared outside of that system or becomes public. Then (as also explained in the SDMX Standards Section 6 “Technical Notes”) the Artefacts must adhere to the Semantic Versioning rules.
264 264  
265 265  (% style="width:982.835px" %)
266 266  |(% style="width:217px" %)**Interface**|(% style="width:763px" %)**Behaviour**
267 267  |(% style="width:217px" %)All|(% style="width:763px" %)(((
268 -1. If the action is set to “replace” (or a [[maintainable Artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]] is PUT or POSTed) then the entire contents of the existing maintainable object in the Registry MUST be replaced by the object submitted.
268 +1. If the action is set to “replace” (or a maintainable Artefact is PUT or POSTed) then the entire contents of the existing maintainable object in the Registry MUST be replaced by the object submitted.
269 269  1. Cross referenced structures MUST exist in either the submitted document (in Structures or Structure Location) or in the registry to which the request is submitted.
270 -1. If the action is set to “delete” (or a [[maintainable Artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]] is DELETEd) then the Registry MUST verify that the object can be deleted. In order to qualify for deletion, the object must:
270 +1. If the action is set to “delete” (or a maintainable Artefact is DELETEd) then the Registry MUST verify that the object can be deleted. In order to qualify for deletion, the object must:
271 271  
272 -a) Be a draft (% style="color:#e74c3c" %)version(%%).
272 +a) Be a draft version.
273 273  b) Not be explicitly{{footnote}}With semantic versioning, it is allowed to reference a range of artefacts, e.g., a DSD referencing a Codelist with version 1.2.3+ means all patch versions greater than 1.2.3. This means that deleting 1.2.4draft does not break integrity of the aforementioned DSD.{{/footnote}} referenced from any other object in the Registry.
274 274  
275 -4) The semantic versioning rules in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] documentation MUST be obeyed.
275 +4) The semantic versioning rules in the SDMX documentation MUST be obeyed.
276 276  )))
277 277  |(% style="width:217px" %)Structure submission|(% style="width:763px" %)(((
278 -Structures are submitted at the (% style="color:#e74c3c" %)level(%%) of the [[Maintainable Artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]] and the behaviour in “All” above is therefore at the (% style="color:#e74c3c" %)level(%%) of the [[Maintainable Artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]].
278 +Structures are submitted at the level of the Maintainable Artefact and the behaviour in “All” above is therefore at the level of the Maintainable Artefact.
279 279  )))
280 -|(% style="width:217px" %)SubmitRegistrationRequest|(% style="width:763px" %)If the datasource is a file (simple datasource) then the file MAY be retrieved and indexed according to the Boolean [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] set in the Registration. For a queryable datasource the Registry MAY validate that the source exists and can accept an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] data query.
280 +|(% style="width:217px" %)SubmitRegistrationRequest|(% style="width:763px" %)If the datasource is a file (simple datasource) then the file MAY be retrieved and indexed according to the Boolean attributes set in the Registration. For a queryable datasource the Registry MAY validate that the source exists and can accept an SDMX data query.
281 281  
282 282  = 6 Identification of SDMX Objects =
283 283  
284 284  == 6.1 Identification, Versioning, and Maintenance ==
285 285  
286 -All major classes of the [[SDMX Information model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]] inherit from one of:
286 +All major classes of the SDMX Information model inherit from one of:
287 287  
288 288  * //**IdentifiableArtefact**// – this gives an object the ability to be uniquely identified (see following section on identification), to have a user-defined URI, and to have multi-lingual annotations.
289 289  * //**NameableArtefact**// – this has all of the features of //IdentifiableArtefact// plus the ability to have a multi-lingual name and description.
290 -* //**VersionableArtefact**// – this has all of the above features plus a (% style="color:#e74c3c" %)version(%%) number, according to the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”, and a validity period.
290 +* //**VersionableArtefact**// – this has all of the above features plus a version number, according to the SDMX versioning rules in SDMX Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”, and a validity period.
291 291  * //**MaintainableArtefact**// – this has all of the above features, plus registry and structure URIs, and an association to the maintenance organisation of the object.
292 292  
293 293  === 6.1.1 Identification, Naming, Versioning, and Maintenance Model ===
... ... @@ -294,9 +294,9 @@
294 294  
295 295  [[image:SDMX 3.1 Section 5_en_4a9b2cfc.jpg||height="688" width="587"]]
296 296  
297 -**Figure 5: Class diagram of fundamental [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] in the [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]**
297 +**Figure 5: Class diagram of fundamental artefacts in the SDMX-IM**
298 298  
299 -The table below shows the identification and related data [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] to be stored in a registry for objects that are one of:
299 +The table below shows the identification and related data attributes to be stored in a registry for objects that are one of:
300 300  
301 301  * //Annotable//
302 302  * //Identifiable//
... ... @@ -304,13 +304,15 @@
304 304  * //Versionable//
305 305  * //Maintainable//
306 306  
307 -(% style="width:1038.83px" %)
308 -|(% colspan="2" %)**Object Type**|(% colspan="2" %)**Data [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]**|(% colspan="2" %)**Status**|(% colspan="2" %)**Data type**|(% colspan="2" %)**Notes**
307 +(% style="width:1306.83px" %)
308 +|(% colspan="2" %)**Object Type**|(% colspan="2" %)**Data Attributes**|(% colspan="2" %)**Status**|(% colspan="2" %)**Data type**|(% colspan="2" %)**Notes**
309 309  |(% colspan="2" rowspan="4" %)//Annotable//|(% colspan="2" %)AnnotationTitle|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
310 310  |(% colspan="2" %)AnnotationType|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
311 311  |(% colspan="2" %)AnnotationURN|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
312 312  |(% colspan="2" %)(((
313 -AnnotationText in the form of InternationalString
313 +AnnotationText in the form of
314 +
315 +InternationalString
314 314  )))|(% colspan="2" %)C|(% colspan="2" %) |(% colspan="2" %)This can have languagespecific variants
315 315  |(% colspan="2" rowspan="4" %)//Identifiable//|(% colspan="2" %)All content as for //Annotable// plus|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
316 316  |(% colspan="2" %)id|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)
... ... @@ -317,13 +317,19 @@
317 317  |(% colspan="2" %)uri|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
318 318  |(% colspan="2" %)urn|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)Although the urn is computable and therefore may not be submitted or stored physically, the Registry must return the urn for each object, and must be able to service a query on an object referenced solely by its urn.
319 319  |(% colspan="2" rowspan="3" %)//Nameable//|(% colspan="2" %)(((
320 -All content as for //Identifiable// plus
322 +All content as for
323 +
324 +//Identifiable// plus
321 321  )))|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
322 322  |(% colspan="2" %)(((
323 -Name in the form of InternationalString
327 +Name in the form of
328 +
329 +InternationalString
324 324  )))|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)This can have language specific variants.
325 325  |(% colspan="2" %)(((
326 -Description in the form of InternationalString
332 +Description in the form of
333 +
334 +InternationalString
327 327  )))|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)This can have language specific variants.
328 328  |(% colspan="2" rowspan="4" %)//Versionable//|(% colspan="2" %)(((
329 329  All content as for
... ... @@ -330,40 +330,42 @@
330 330  
331 331  //Identifiable// plus
332 332  )))|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
333 -|(% colspan="2" %)(% style="color:#e74c3c" %)version|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)This is the (% style="color:#e74c3c" %)version(%%) number according to [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules.
341 +|(% colspan="2" %)version|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)This is the version number according to SDMX versioning rules.
334 334  |(% colspan="2" %)validFrom|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %)
335 335  |(% colspan="2" %)validTo|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %)
336 336  |(% colspan="2" %)//Maintainable//|(% colspan="2" %)All content as for //Versionable// plus|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
337 -|(% colspan="2" %) |(% colspan="2" %)[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]|(% colspan="2" %)C|(% colspan="2" %)boolean|(% colspan="2" %)Value of “true” indicates that the actual resource is held outside of this registry. The actual reference is given in the registry URI or the structureURL, each of which must return a valid [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] file.
345 +|(% colspan="2" %) |(% colspan="2" %)isExternalReference|(% colspan="2" %)C|(% colspan="2" %)boolean|(% colspan="2" %)Value of “true” indicates that the actual resource is held outside of this registry. The actual reference is given in the registry URI or the structureURL, each of which must return a valid SDMX-ML file.
338 338  |(% colspan="2" %) |(% colspan="2" %)serviceURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the service that can be queried for this resource.
339 339  |(% colspan="2" %) |(% colspan="2" %)structureURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the resource.
340 340  |(% colspan="2" %) |(% colspan="2" %)(Maintenance) organisationId|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)The object must be linked to a maintenance organisation, i.e., Agency or Metadata Provider.
341 341  
342 -**Table 1: Common [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]] of Object Types**
350 +**Table 1: Common Attributes of Object Types**
343 343  
344 344  == 6.2 Unique identification of SDMX objects ==
345 345  
346 346  === 6.2.1 Agencies and Metadata Providers ===
347 347  
348 -The [[Maintenance Agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] is maintained in an [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]] which itself is a sub class of Organisation Scheme – this is shown in the class diagram below.
356 +The Maintenance Agency in SDMX is maintained in an Agency Scheme which itself is a sub class of Organisation Scheme – this is shown in the class diagram below.
349 349  
350 350  [[image:SDMX 3.1 Section 5_en_67b3555e.jpg||height="313" width="554"]]
351 351  
352 -**Figure 6: [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]] Model**
360 +**Figure 6: Agency Scheme Model**
353 353  
354 -The Agency in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] is extremely important. The Agency Id system used in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] is an nlevel structure. The top (% style="color:#e74c3c" %)level(%%) of this structure is maintained by [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]. Any Agency in this top (% style="color:#e74c3c" %)level(%%) can declare sub agencies and any sub agency can also declare sub agencies. The [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]] has a fixed id and (% style="color:#e74c3c" %)version(%%) ((% style="color:#e74c3c" %)version(%%) ‘1.0’) and is never declared explicitly in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object identification mechanism.
362 +The Agency in SDMX is extremely important. The Agency Id system used in SDMX is an nlevel structure. The top level of this structure is maintained by SDMX. Any Agency in this top level can declare sub agencies and any sub agency can also declare sub agencies. The Agency Scheme has a fixed id and version (version ‘1.0’) and is never declared explicitly in the SDMX object identification mechanism.
355 355  
356 -In order to achieve this [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] adopts the following rules:
364 +In order to achieve this SDMX adopts the following rules:
357 357  
358 -* Agencies are maintained in an [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]] (which is a sub class of Organisation Scheme).
359 -* The agency of the [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]] must also be declared in a (different) [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]].
360 -* The “top-(% style="color:#e74c3c" %)level(%%)” agency is [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] and maintains the “top-(% style="color:#e74c3c" %)level(%%)[[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]].
361 -* Agencies registered in the top-(% style="color:#e74c3c" %)level(%%) scheme can themselves maintain a single [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]]. Agencies in these second-tier schemes can themselves maintain a single [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]] and so on.
362 -* The AgencyScheme has a fixed (% style="color:#e74c3c" %)version(%%), i.e., ‘1.0’, hence it is an exception from the Semantic Versioning that other [[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] follow.
366 +* Agencies are maintained in an Agency Scheme (which is a sub class of Organisation Scheme).
367 +* The agency of the Agency Scheme must also be declared in a (different) Agency Scheme.
368 +* The “top-level” agency is SDMX and maintains the “top-level” Agency Scheme.
369 +* Agencies registered in the top-level scheme can themselves maintain a single Agency Scheme. Agencies in these second-tier schemes can themselves maintain a single Agency Scheme and so on.
370 +* The AgencyScheme has a fixed version, i.e., ‘1.0’, hence it is an exception from the Semantic Versioning that other Artefacts follow.
363 363  * There can be only one AgencyScheme maintained by any one Agency. It has a fixed id of AGENCIES.
364 -* The /[[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] of Organisation is not inherited by [[Maintenance Agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] – thus each [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]] is a flat list of [[Maintenance Agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]].
365 -* The format of the agency identifier is agencyID.agencyID etc. The top-(% style="color:#e74c3c" %)level(%%) agency in this identification mechanism is the agency registered in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[agency scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]]. In other words, [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] is not a part of the hierarchical ID structure for agencies. However, [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] is, itself, a [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] and is contained in the top-(% style="color:#e74c3c" %)level(%%) [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]].
366 366  
373 +• The /hierarchy of Organisation is not inherited by Maintenance Agency – thus each Agency Scheme is a flat list of Maintenance Agencies.
374 +
375 +• The format of the agency identifier is agencyID.agencyID etc. The top-level agency in this identification mechanism is the agency registered in the SDMX agency scheme. In other words, SDMX is not a part of the hierarchical ID structure for agencies. However, SDMX is, itself, a maintenance agency and is contained in the top-level Agency Scheme.
376 +
367 367  This supports a hierarchical structure of agencyID.
368 368  
369 369  An example is shown below.
... ... @@ -372,14 +372,14 @@
372 372  
373 373  **Figure 7: Example of Hierarchic Structure of Agencies**
374 374  
375 -The following organizations maintain an [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]].
385 +The following organizations maintain an Agency Scheme.
376 376  
377 -* [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] – contains Agencies AA, BB
387 +* SDMX – contains Agencies AA, BB
378 378  * AA – contains Agencies CC, DD
379 379  * BB – contains Agencies CC, DD
380 380  * DD – Contains Agency EE
381 381  
382 -Each agency is identified by its full [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] excluding [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]].
392 +Each agency is identified by its full hierarchy excluding SDMX.
383 383  
384 384  e.g., the id of EE as an agencyID is AA.DD.EE
385 385  
... ... @@ -387,35 +387,35 @@
387 387  
388 388  **Figure 8: Example Showing Use of Agency Identifiers**
389 389  
390 -Each of these [[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]] has an identical [[Code list>>doc:sdmx:Glossary.Code list.WebHome]] with the Id CL_BOP. However, each is uniquely identified by means of the hierarchic agency structure.
400 +Each of these maintenance agencies has an identical Code list with the Id CL_BOP. However, each is uniquely identified by means of the hierarchic agency structure.
391 391  
392 -Following the same principles, the Metadata Provider is the maintenance organisation for a special subset of [[Maintainable Artefacts>>doc:sdmx:Glossary.Maintainable artefact.WebHome]], i.e., the Metadatasets; the latter are the containers of [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] combined with a target that those metadata refer to.
402 +Following the same principles, the Metadata Provider is the maintenance organisation for a special subset of Maintainable Artefacts, i.e., the Metadatasets; the latter are the containers of reference metadata combined with a target that those metadata refer to.
393 393  
394 394  === 6.2.2 Universal Resource Name (URN) ===
395 395  
396 396  ==== 6.2.2.1 Introduction ====
397 397  
398 -To provide interoperability between [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]]/Repositories in a distributed network environment, it is important to have a scheme for uniquely identifying (and thus accessing) all first-class (Identifiable) [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]] objects. Most of these unique identifiers are composite (containing [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]], or parent object identifiers), and there is a need to be able to construct a unique reference as a single string. This is achieved by having a globally unique identifier called a universal resource name (URN) which is generated from the actual identification [[components>>doc:sdmx:Glossary.Component.WebHome]] in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-RR APIs. In other words, the URN for any [[Identifiable Artefact>>doc:sdmx:Glossary.Identifiable artefact.WebHome]] is constructed from its [[component>>doc:sdmx:Glossary.Component.WebHome]] identifiers (agency, id, (% style="color:#e74c3c" %)version(%%) etc.).
408 +To provide interoperability between SDMX Registry/Repositories in a distributed network environment, it is important to have a scheme for uniquely identifying (and thus accessing) all first-class (Identifiable) SDMX-IM objects. Most of these unique identifiers are composite (containing maintenance agency, or parent object identifiers), and there is a need to be able to construct a unique reference as a single string. This is achieved by having a globally unique identifier called a universal resource name (URN) which is generated from the actual identification components in the SDMX-RR APIs. In other words, the URN for any Identifiable Artefact is constructed from its component identifiers (agency, id, version etc.).
399 399  
400 400  ==== 6.2.2.2 URN Structure //__Case Rules for URN__// ====
401 401  
402 402  For the URN, all parts of the string are case sensitive. The generic structure of the URN is as follows:
403 403  
404 -SDMXprefix.[[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]-package-name.class-name=agencyid:maintainedobjectid(maintainedobject-(% style="color:#e74c3c" %)version(%%)).*containerobject-id.object-id
414 +SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobjectid(maintainedobject-version).*containerobject-id.object-id
405 405  
406 406  ~* this can repeat and may not be present (see explanation below)
407 407  
408 -Note that in the [[SDMX Information Model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]] there are no concrete [[Versionable Artefacts>>doc:sdmx:Glossary.Versionable artefact.WebHome]] that are not a [[Maintainable Artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]]. For this reason, the only (% style="color:#e74c3c" %)version(%%) information that is allowed is for the maintainable object.
418 +Note that in the SDMX Information Model there are no concrete Versionable Artefacts that are not a Maintainable Artefact. For this reason, the only version information that is allowed is for the maintainable object.
409 409  
410 -The [[Maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] identifier is separated from the [[maintainable artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]] identifier by a colon ‘:’. All other identifiers in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] URN syntax are separated by a period ‘.’. The (% style="color:#e74c3c" %)version(%%) information is encapsulated in parentheses ‘()’ and adheres to the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules, as explained in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning.
420 +The Maintenance agency identifier is separated from the maintainable artefact identifier by a colon ‘:’. All other identifiers in the SDMX URN syntax are separated by a period ‘.’. The version information is encapsulated in parentheses ‘()’ and adheres to the SDMX versioning rules, as explained in SDMX Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning.
411 411  
412 412  ==== 6.2.2.3 Explanation of the generic structure ====
413 413  
414 414  In the explanation below the actual object that is the target of the URN is called the **actual object**.
415 415  
416 -**SDMXPrefix**: urn:[[sdmx>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:org
426 +**SDMXPrefix**: urn:sdmx:org
417 417  
418 -**[[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]-package-name**: [[sdmx>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]].infomodel.package=
428 +**SDMX-IM-package-name**: sdmx.infomodel.package=
419 419  
420 420  The packages are:
421 421  
... ... @@ -423,13 +423,13 @@
423 423  
424 424  **maintainable-object-id** is the identifier of the maintainable object. This will always be present as all identifiable objects are either a maintainable object or contained in a maintainable object.
425 425  
426 -**maintainable-object-(% style="color:#e74c3c" %)version(%%)** is the (% style="color:#e74c3c" %)version(%%), according to the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules, of the maintainable object and is enclosed in parentheses ‘()’, which are always present.
436 +**maintainable-object-version** is the version, according to the SDMX versioning rules, of the maintainable object and is enclosed in parentheses ‘()’, which are always present.
427 427  
428 -**container-object-id** is the identifier of an intermediary object that contains the actual object which the URN is identifying. It is not mandatory as many actual objects do not have an intermediary container object. For instance, a [[Code>>doc:sdmx:Glossary.Code.WebHome]] is in a maintained object (Codelist) and has no intermediary container object, whereas a MetadataAttribute has an intermediary container object (MetadataAttributeDescriptor) and may have an intermediary container object, which is its parent MetadataAttribute. For this reason, the container object id may repeat, with each repetition identifying the object at the next-lower (% style="color:#e74c3c" %)level(%%) in its [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]. Note that if there is only a single containing object in the model then it is NOT included in the URN structure. This applies to AttributeDescriptor, DimensionDescriptor, and MeasureDescriptor where there can be only one such object and this object has a fixed id. Therefore, whilst each of these has a URN, the id of the AttributeDescriptor, DimensionDescriptor, and MeasureDescriptor is not included when the actual object is a DataAttribute or a [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]/ TimeDimension, or a Measure.
438 +**container-object-id** is the identifier of an intermediary object that contains the actual object which the URN is identifying. It is not mandatory as many actual objects do not have an intermediary container object. For instance, a Code is in a maintained object (Codelist) and has no intermediary container object, whereas a MetadataAttribute has an intermediary container object (MetadataAttributeDescriptor) and may have an intermediary container object, which is its parent MetadataAttribute. For this reason, the container object id may repeat, with each repetition identifying the object at the next-lower level in its hierarchy. Note that if there is only a single containing object in the model then it is NOT included in the URN structure. This applies to AttributeDescriptor, DimensionDescriptor, and MeasureDescriptor where there can be only one such object and this object has a fixed id. Therefore, whilst each of these has a URN, the id of the AttributeDescriptor, DimensionDescriptor, and MeasureDescriptor is not included when the actual object is a DataAttribute or a Dimension/ TimeDimension, or a Measure.
429 429  
430 -Note that although a [[Code>>doc:sdmx:Glossary.Code.WebHome]] can have a parent [[Code>>doc:sdmx:Glossary.Code.WebHome]] and a (% style="color:#e74c3c" %)Concept(%%) can have a parent (% style="color:#e74c3c" %)Concept(%%) these are maintained in a flat structure and therefore do not have a containerobject-id.
440 +Note that although a Code can have a parent Code and a Concept can have a parent Concept these are maintained in a flat structure and therefore do not have a containerobject-id.
431 431  
432 -For example, the sequence is agency:DSDid((% style="color:#e74c3c" %)version(%%)).DimensionId and not agency:DSDid((% style="color:#e74c3c" %)version(%%)).DimensionDescriptorId.DimensionId.
442 +For example, the sequence is agency:DSDid(version).DimensionId and not agency:DSDid(version).DimensionDescriptorId.DimensionId.
433 433  
434 434  object-id is the identifier of the actual object unless the actual object is a //Maintainable// object. If present it is always the last id and is not followed by any other character.
435 435  
... ... @@ -437,60 +437,60 @@
437 437  
438 438  __Actual object is a maintainable__
439 439  
440 -SDMXPrefix.[[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid((% style="color:#e74c3c" %)version(%%))
450 +SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version)
441 441  
442 442  __Actual object is contained in a maintained object with no intermediate containing object__
443 443  
444 -SDMXPrefix.[[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid((% style="color:#e74c3c" %)version(%%)).object-id
454 +SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version).object-id
445 445  
446 446  __Actual object is contained in a maintained object with an intermediate containing object__
447 447  
448 -SDMXPrefix.[[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid((% style="color:#e74c3c" %)version(%%)).contained-object-id.object-id
458 +SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version).contained-object-id.object-id
449 449  
450 450  __Actual object is contained in a maintained object with no intermediate containing__ __object but__ __the object type itself is hierarchical__
451 451  
452 -In this case the object id may not be unique in itself but only within the context of the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]. In the general syntax of the URN all intermediary objects in the structure (with the exception, of course, of the maintained object) are shown as a contained object. An example here would be a [[Category>>doc:sdmx:Glossary.Category.WebHome]] in a CategoryScheme. The [[Category>>doc:sdmx:Glossary.Category.WebHome]] is hierarchical, and all intermediate [[Categories>>doc:sdmx:Glossary.Category.WebHome]] are shown as a contained object. The example below shows the generic structure for CategoryScheme/ [[Category>>doc:sdmx:Glossary.Category.WebHome]]/ [[Category>>doc:sdmx:Glossary.Category.WebHome]].
462 +In this case the object id may not be unique in itself but only within the context of the hierarchy. In the general syntax of the URN all intermediary objects in the structure (with the exception, of course, of the maintained object) are shown as a contained object. An example here would be a Category in a CategoryScheme. The Category is hierarchical, and all intermediate Categories are shown as a contained object. The example below shows the generic structure for CategoryScheme/ Category/ Category.
453 453  
454 -SDMXPrefix.[[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid((% style="color:#e74c3c" %)version(%%)).contained-object-id.object-id
464 +SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version).contained-object-id.object-id
455 455  
456 456  Actual object is contained in a maintained object with an intermediate containing object and the object type itself is hierarchical
457 457  
458 -In this case the generic syntax is the same as for the example above as the parent object is regarded as a containing object, even if it is of the same type. An example here is a MetadataAttribute where the contained objects are MetadataAttributeDescriptor (first contained object id) and MetadataAttribute (subsequent contained object ids). The example below shows the generic structure for [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]/ MetadataAttributeDescriptor/ MetadataAttribute/ MetadataAttribute
468 +In this case the generic syntax is the same as for the example above as the parent object is regarded as a containing object, even if it is of the same type. An example here is a MetadataAttribute where the contained objects are MetadataAttributeDescriptor (first contained object id) and MetadataAttribute (subsequent contained object ids). The example below shows the generic structure for MSD/ MetadataAttributeDescriptor/ MetadataAttribute/ MetadataAttribute
459 459  
460 -SDMXPrefix.[[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid((% style="color:#e74c3c" %)version(%%)).contained-object-id.contained-object-id contained-objectid.object-id
470 +SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version).contained-object-id.contained-object-id contained-objectid.object-id
461 461  
462 462  //__**Concrete Examples of the URN Structure**__//
463 463  
464 -The [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] CRED_EXT_DEBT of legacy (% style="color:#e74c3c" %)version(%%) 2.1 maintained by the toplevel Agency TFFS would have the URN:
474 +The Data Structure Definition CRED_EXT_DEBT of legacy version 2.1 maintained by the toplevel Agency TFFS would have the URN:
465 465  
466 -urn:[[sdmx>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:org.[[sdmx>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]].infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(2.1)
476 +urn:sdmx:org.sdmx.infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(2.1)
467 467  
468 -The URN for a [[code>>doc:sdmx:Glossary.Code.WebHome]] for Argentina maintained by ISO in the [[code list>>doc:sdmx:Glossary.Code list.WebHome]] CL_3166A2 of semantic (% style="color:#e74c3c" %)version(%%) 1.0.0 would be:
478 +The URN for a code for Argentina maintained by ISO in the code list CL_3166A2 of semantic version 1.0.0 would be:
469 469  
470 -urn:[[sdmx>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:org.[[sdmx>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]].infomodel.codelist.[[Code>>doc:sdmx:Glossary.Code.WebHome]]=ISO:CL_3166A2(1.0.0).AR
480 +urn:sdmx:org.sdmx.infomodel.codelist.Code=ISO:CL_3166A2(1.0.0).AR
471 471  
472 -The URN for a [[category>>doc:sdmx:Glossary.Category.WebHome]] (id of 1) which has parent [[category>>doc:sdmx:Glossary.Category.WebHome]] (id of 2) maintained by [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] in the [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] SUBJECT_MATTER_DOMAINS of the semantic extended (% style="color:#e74c3c" %)version(%%) 1.0.0draft would be:
482 +The URN for a category (id of 1) which has parent category (id of 2) maintained by SDMX in the category scheme SUBJECT_MATTER_DOMAINS of the semantic extended version 1.0.0draft would be:
473 473  
474 -urn:[[sdmx>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:org.[[sdmx>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]].infomodel.categoryscheme.[[Category>>doc:sdmx:Glossary.Category.WebHome]]=[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:SUBJECT_MATT ER_DOMAINS(1.0.0-draft).1.2
484 +urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:SUBJECT_MATT ER_DOMAINS(1.0.0-draft).1.2
475 475  
476 -The URN for a Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] maintained by [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] in the [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] CONTACT_METADATA of semantic (% style="color:#e74c3c" %)version(%%) 1.0.0 where the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] of the Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is CONTACT_DETAILS/CONTACT_NAME would be:
486 +The URN for a Metadata Attribute maintained by SDMX in the MSD CONTACT_METADATA of semantic version 1.0.0 where the hierarchy of the Metadata Attribute is CONTACT_DETAILS/CONTACT_NAME would be:
477 477  
478 -urn:[[sdmx>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:org.[[sdmx>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]].infomodel.metadatastructure.MetadataAttribute=[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]: CONTACT_METADATA(1.0.0).CONTACT_DETAILS.CONTACT_NAME
488 +urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataAttribute=SDMX: CONTACT_METADATA(1.0.0).CONTACT_DETAILS.CONTACT_NAME
479 479  
480 -The TFFS defines ABC as a sub-Agency of TFFS then the URN of a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] maintained by ABC and identified as EXTERNAL_DEBT of semantic (% style="color:#e74c3c" %)version(%%) 1.0.0 would be:
490 +The TFFS defines ABC as a sub-Agency of TFFS then the URN of a Dataflow maintained by ABC and identified as EXTERNAL_DEBT of semantic version 1.0.0 would be:
481 481  
482 -urn:[[sdmx>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:org.[[sdmx>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]].infomodel.datastructure.[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]=TFFS.ABC:EXTERNAL_ DEBT(1.0.0)
492 +urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=TFFS.ABC:EXTERNAL_ DEBT(1.0.0)
483 483  
484 -The [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-RR MUST support this globally unique identification scheme. The [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-RR MUST be able to create the URN from the individual identification [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] submitted and to transform the URN to these identification [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. The identification [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] are:
494 +The SDMX-RR MUST support this globally unique identification scheme. The SDMX-RR MUST be able to create the URN from the individual identification attributes submitted and to transform the URN to these identification attributes. The identification attributes are:
485 485  
486 -* **Identifiable and [[Nameable Artefacts>>doc:sdmx:Glossary.Nameable artefact.WebHome]]**: id (in some cases this id may be hierarchic)
487 -* **[[Maintainable Artefacts>>doc:sdmx:Glossary.Maintainable artefact.WebHome]]**: id, (% style="color:#e74c3c" %)version(%%), agencyId
496 +* **Identifiable and Nameable Artefacts**: id (in some cases this id may be hierarchic)
497 +* **Maintainable Artefacts**: id, version, agencyId
488 488  
489 -The [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-RR MUST be able to resolve the unique identifier of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] and to produce an [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] rendering of that [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] if it is located in the Registry.
499 +The SDMX-RR MUST be able to resolve the unique identifier of an SDMX artefact and to produce an SDMX-ML rendering of that artefact if it is located in the Registry.
490 490  
491 491  === 6.2.3 Table of SDMX-IM Packages and Classes ===
492 492  
493 -The table below lists all of the packages in the [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]] together with the concrete classes that are in these packages and whose objects have a URN.
503 +The table below lists all of the packages in the SDMX-IM together with the concrete classes that are in these packages and whose objects have a URN.
494 494  
495 495  (% style="width:750.835px" %)
496 496  |(% style="width:222px" %)**Package**|(% style="width:526px" %)**URN class name (model class name where this is different)**
... ... @@ -507,9 +507,9 @@
507 507  |(% style="width:222px" %) |(% style="width:526px" %)
508 508  |(% style="width:222px" %)datastructure|(% style="width:526px" %)AttributeDescriptor
509 509  |(% style="width:222px" %) |(% style="width:526px" %)DataAttribute
510 -|(% style="width:222px" %) |(% style="width:526px" %)[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]
520 +|(% style="width:222px" %) |(% style="width:526px" %)Dataflow
511 511  |(% style="width:222px" %) |(% style="width:526px" %)DataStructure (DataStructureDefinition)
512 -|(% style="width:222px" %) |(% style="width:526px" %)[[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]
522 +|(% style="width:222px" %) |(% style="width:526px" %)Dimension
513 513  |(% style="width:222px" %) |(% style="width:526px" %)DimensionDescriptor
514 514  |(% style="width:222px" %) |(% style="width:526px" %)GroupDimensionDescriptor
515 515  |(% style="width:222px" %) |(% style="width:526px" %)Measure
... ... @@ -527,7 +527,7 @@
527 527  (((
528 528  (% style="width:751.835px" %)
529 529  |(% style="width:221px" %)**Package**|(% style="width:528px" %)**URN class name (model class name where this is different)**
530 -|(% style="width:221px" %) |(% style="width:528px" %)[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]
540 +|(% style="width:221px" %) |(% style="width:528px" %)Metadataflow
531 531  |(% style="width:221px" %) |(% style="width:528px" %)MetadataSet
532 532  |(% style="width:221px" %) |(% style="width:528px" %)
533 533  |(% style="width:221px" %)process|(% style="width:528px" %)Process
... ... @@ -538,7 +538,7 @@
538 538  |(% style="width:221px" %) |(% style="width:528px" %)MetadataConstraint
539 539  |(% style="width:221px" %) |(% style="width:528px" %)MetadataProvisionAgreement
540 540  |(% style="width:221px" %) |(% style="width:528px" %)ProvisionAgreement
541 -|(% style="width:221px" %) |(% style="width:528px" %)[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]
551 +|(% style="width:221px" %) |(% style="width:528px" %)Subscription
542 542  |(% style="width:221px" %) |(% style="width:528px" %)
543 543  |(% style="width:221px" %)structuremapping|(% style="width:528px" %)CategorySchemeMap
544 544  |(% style="width:221px" %) |(% style="width:528px" %)ConceptSchemeMap
... ... @@ -547,22 +547,22 @@
547 547  |(% style="width:221px" %) |(% style="width:528px" %)RepresentationMap
548 548  |(% style="width:221px" %) |(% style="width:528px" %)StructureMap
549 549  |(% style="width:221px" %) |(% style="width:528px" %)
550 -|(% style="width:221px" %)codelist|(% style="width:528px" %)[[Code>>doc:sdmx:Glossary.Code.WebHome]]
560 +|(% style="width:221px" %)codelist|(% style="width:528px" %)Code
551 551  |(% style="width:221px" %) |(% style="width:528px" %)Codelist
552 552  |(% style="width:221px" %) |(% style="width:528px" %)HierarchicalCode
553 -|(% style="width:221px" %) |(% style="width:528px" %)[[Hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]
563 +|(% style="width:221px" %) |(% style="width:528px" %)Hierarchy
554 554  |(% style="width:221px" %) |(% style="width:528px" %)HierarchyAssociation
555 -|(% style="width:221px" %) |(% style="width:528px" %)(% style="color:#e74c3c" %)Level
565 +|(% style="width:221px" %) |(% style="width:528px" %)Level
556 556  |(% style="width:221px" %) |(% style="width:528px" %)ValueList
557 557  |(% style="width:221px" %) |(% style="width:528px" %)
558 558  |(% style="width:221px" %)categoryscheme|(% style="width:528px" %)Categorisation
559 -|(% style="width:221px" %) |(% style="width:528px" %)[[Category>>doc:sdmx:Glossary.Category.WebHome]]
569 +|(% style="width:221px" %) |(% style="width:528px" %)Category
560 560  |(% style="width:221px" %) |(% style="width:528px" %)CategoryScheme
561 561  |(% style="width:221px" %) |(% style="width:528px" %)ReportingCategory
562 562  |(% style="width:221px" %) |(% style="width:528px" %)ReportingTaxonomy
563 563  |(% style="width:221px" %)**Package**|(% style="width:528px" %)**URN class name (model class name where this is different)**
564 564  |(% style="width:221px" %) |(% style="width:528px" %)
565 -|(% style="width:221px" %)conceptscheme|(% style="width:528px" %)(% style="color:#e74c3c" %)Concept
575 +|(% style="width:221px" %)conceptscheme|(% style="width:528px" %)Concept
566 566  |(% style="width:221px" %) |(% style="width:528px" %)ConceptScheme
567 567  |(% style="width:221px" %) |(% style="width:528px" %)
568 568  |(% style="width:221px" %)transformation|(% style="width:528px" %)CustomType
... ... @@ -582,40 +582,40 @@
582 582  |(% style="width:221px" %) |(% style="width:528px" %)
583 583  )))
584 584  
585 -**Table 2: [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]] Packages and Contained Classes**
595 +**Table 2: SDMX-IM Packages and Contained Classes**
586 586  
587 587  === 6.2.4 URN Identification components of SDMX objects ===
588 588  
589 -The table below describes the identification [[components>>doc:sdmx:Glossary.Component.WebHome]] for all [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] object types that have identification. Note the actual [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] are all ‘id’ but have been prefixed by their class name or multiple class names to show navigation, e.g., ‘conceptSchemeAgencyId’ is really the ‘Id’ [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] of the Agency class that is associated to the ConceptScheme.
599 +The table below describes the identification components for all SDMX object types that have identification. Note the actual attributes are all ‘id’ but have been prefixed by their class name or multiple class names to show navigation, e.g., ‘conceptSchemeAgencyId’ is really the ‘Id’ attribute of the Agency class that is associated to the ConceptScheme.
590 590  
591 591  Note that for brevity the URN examples omit the prefix (classnames in italics indicate maintainable objects, keywords in bold indicate fixed value) All URNs have the prefix:
592 592  
593 -urn:[[sdmx>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]].org.[[sdmx>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]].infomodel.{package}.{classname}=
603 +urn:sdmx.org.sdmx.infomodel.{package}.{classname}=
594 594  
595 595  (% style="width:1272.83px" %)
596 -|(% style="width:289px" %)**Classname**|(% style="width:600px" %)**Ending URN pattern**|(% style="width:383px" %)**Example**
597 -|(% style="width:289px" %)Agency{{footnote}}The object must be linked to a maintenance organisation, i.e., Agency or Metadata Provider.{{/footnote}}|(% style="width:600px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|(% style="width:383px" %)ECB:**AGENCIES**(**1.0**).AA
598 -|(% style="width:289px" %)//AgencyScheme//|(% style="width:600px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**)|(% style="width:383px" %)ECB:**AGENCIES**(**1.0**)
599 -|(% style="width:289px" %)//Categorisation//|(% style="width:600px" %)categorisationAgencyId:categoris(% style="color:#000000" %)ationId(version)|(% style="width:383px" %)IMF:cat001(1.0.0)
600 -|(% style="width:289px" %)[[Category>>doc:sdmx:Glossary.Category.WebHome]]|(% style="width:600px" %)categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|(% style="width:383px" %)IMF:SDDS(1.0.0):level_1_category.level_2_category …
601 -|(% style="width:289px" %)//CategoryScheme//|(% style="width:600px" %)categorySchemeAgencyId:categorySchemeId(versi on)|(% style="width:383px" %)IMF:SDDS(1.0.0)
606 +|(% style="width:290px" %)**Classname**|(% style="width:649px" %)**Ending URN pattern**|(% style="width:332px" %)**Example**
607 +|(% style="width:290px" %)Agency^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^|(% style="width:649px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|(% style="width:332px" %)ECB:**AGENCIES**(**1.0**).AA
608 +|(% style="width:290px" %)//AgencyScheme//|(% style="width:649px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**)|(% style="width:332px" %)ECB:**AGENCIES**(**1.0**)
609 +|(% style="width:290px" %)//Categorisation//|(% style="width:649px" %)categorisationAgencyId:categorisationId(version)|(% style="width:332px" %)IMF:cat001(1.0.0)
610 +|(% style="width:290px" %)Category|(% style="width:649px" %)categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|(% style="width:332px" %)IMF:SDDS(1.0.0):level_1_category.level_2_category …
611 +|(% style="width:290px" %)//CategoryScheme//|(% style="width:649px" %)categorySchemeAgencyId:categorySchemeId(versi on)|(% style="width:332px" %)IMF:SDDS(1.0.0)
602 602  
603 -|(% style="width:292px" %)**Classname**|(% style="width:595px" %)**Ending URN pattern**|(% style="width:794px" %)**Example**
604 -|(% style="width:292px" %)//CategorySchemeMap//|(% style="width:595px" %)(((
605 -(% style="color:#000000" %)catSchemeMapAgencyId:catSchemeMapId(version)
606 -)))|(% style="width:794px" %)SDMX:EUROSTAT_SUBJECT_DOMAIN(1.0.0)
607 -|(% style="width:292px" %)[[Code>>doc:sdmx:Glossary.Code.WebHome]]|(% style="width:595px" %)(% style="color:#000000" %)codeListAgencyId:codelistId(version).codeId|(% style="width:794px" %)SDMX:CL_FREQ(1.0.0).Q
608 -|(% style="width:292px" %)//Codelist//|(% style="width:595px" %)(% style="color:#000000" %)codeListAgencyId:codeListId(version)|(% style="width:794px" %)SDMX:CL_FREQ(1.0.0)
609 -|(% style="width:292px" %)ComponentMap|(% style="width:595px" %)(% style="color:#000000" %)structureMapAgencyId:structureMap(version).com ponentMapId|(% style="width:794px" %)SDMX:BOP_STRUCTURES(1.0.0).REF_AREA_TO_COUNT RY
610 -|(% style="width:292px" %)(% style="color:#e74c3c" %)Concept|(% style="width:595px" %)(% style="color:#000000" %)conceptSchemeAgencyId:conceptSchemeId(versio n).conceptId|(% style="width:794px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0).FREQ
611 -|(% style="width:292px" %)//ConceptScheme//|(% style="width:595px" %)(% style="color:#000000" %)conceptSchemeAgencyId:conceptSchemeId(versio n)|(% style="width:794px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0)
612 -|(% style="width:292px" %)//ConceptSchemeMap//|(% style="width:595px" %)(((
613 -(% style="color:#000000" %)conceptSchemeMapAgencyId:conceptSchemeMap Id(version)
614 -)))|(% style="width:794px" %)SDMX:CONCEPT_MAP(1.0.0)
615 -|(% style="width:292px" %)CustomType|(% style="width:595px" %)(% style="color:#000000" %)customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|(% style="width:794px" %)ECB: CUSTOM_TYPE_SCHEME(1.0.0).CUSTOM_TYPE_1
616 -|(% style="width:292px" %)//CustomTypeScheme//|(% style="width:595px" %)(% style="color:#000000" %)customTypeSchemeAgencyId customTypeSchemeId(version)|(% style="width:794px" %)ECB:CUSTOM_TYPE_SCHEME(1.0.0)
617 -|(% style="width:292px" %)DataAttrribute|(% style="width:595px" %)(% style="color:#000000" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dataAttributeId|(% style="width:794px" %)TFFS:EXT_DEBT(1.0.0).OBS_STATUS
618 -|(% style="width:292px" %)//DataConstraint//|(% style="width:595px" %)(% style="color:#000000" %)dataConstraintAgencyId:dataConstraintId(version)|(% style="width:794px" %)TFFS:CREDITOR_DATA_CONTENT(1.0.0)
613 +|(% style="width:292px" %)**Classname**|(% style="width:647px" %)**Ending URN pattern**|(% style="width:742px" %)**Example**
614 +|(% style="width:292px" %)//CategorySchemeMap//|(% style="width:647px" %)(((
615 +catSchemeMapAgencyId:catSchemeMapId(version)
616 +)))|(% style="width:742px" %)SDMX:EUROSTAT_SUBJECT_DOMAIN(1.0.0)
617 +|(% style="width:292px" %)Code|(% style="width:647px" %)codeListAgencyId:codelistId(version).codeId|(% style="width:742px" %)SDMX:CL_FREQ(1.0.0).Q
618 +|(% style="width:292px" %)//Codelist//|(% style="width:647px" %)codeListAgencyId:codeListId(version)|(% style="width:742px" %)SDMX:CL_FREQ(1.0.0)
619 +|(% style="width:292px" %)ComponentMap|(% style="width:647px" %)structureMapAgencyId:structureMap(version).com ponentMapId|(% style="width:742px" %)SDMX:BOP_STRUCTURES(1.0.0).REF_AREA_TO_COUNT RY
620 +|(% style="width:292px" %)Concept|(% style="width:647px" %)conceptSchemeAgencyId:conceptSchemeId(versio n).conceptId|(% style="width:742px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0).FREQ
621 +|(% style="width:292px" %)//ConceptScheme//|(% style="width:647px" %)conceptSchemeAgencyId:conceptSchemeId(versio n)|(% style="width:742px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0)
622 +|(% style="width:292px" %)//ConceptSchemeMap//|(% style="width:647px" %)(((
623 +conceptSchemeMapAgencyId:conceptSchemeMap Id(version)
624 +)))|(% style="width:742px" %)SDMX:CONCEPT_MAP(1.0.0)
625 +|(% style="width:292px" %)CustomType|(% style="width:647px" %)customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|(% style="width:742px" %)ECB: CUSTOM_TYPE_SCHEME(1.0.0).CUSTOM_TYPE_1
626 +|(% style="width:292px" %)//CustomTypeScheme//|(% style="width:647px" %)customTypeSchemeAgencyId customTypeSchemeId(version)|(% style="width:742px" %)ECB:CUSTOM_TYPE_SCHEME(1.0.0)
627 +|(% style="width:292px" %)DataAttrribute|(% style="width:647px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dataAttributeId|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0).OBS_STATUS
628 +|(% style="width:292px" %)//DataConstraint//|(% style="width:647px" %)dataConstraintAgencyId:dataConstraintId(version)|(% style="width:742px" %)TFFS:CREDITOR_DATA_CONTENT(1.0.0)
619 619  
620 620  |(% style="width:294px" %)**Classname**|(% style="width:645px" %)**Ending URN pattern**|(% style="width:742px" %)**Example**
621 621  |(% style="width:294px" %)DataConsumer|(% style="width:645px" %)dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**).dataConsumerId|(% style="width:742px" %)SDMX:**DATA_CONSUMERS**(**1.0**).CONSUMER_1
... ... @@ -622,15 +622,15 @@
622 622  |(% style="width:294px" %)//DataConsumerScheme//|(% style="width:645px" %)(((
623 623  dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**)
624 624  )))|(% style="width:742px" %)SDMX:**DATA_CONSUMERS**(**1.0**)
625 -|(% style="width:294px" %)//[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]//|(% style="width:645px" %)(% style="color:#000000" %)dataflowAgencyId:dataflowId(version)|(% style="width:742px" %)TFFS:CRED_EXT_DEBT(1.0.0)
635 +|(% style="width:294px" %)//Dataflow//|(% style="width:645px" %)dataflowAgencyId:dataflowId(version)|(% style="width:742px" %)TFFS:CRED_EXT_DEBT(1.0.0)
626 626  |(% style="width:294px" %)DataProvider|(% style="width:645px" %)(((
627 -(% style="color:#000000" %)dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**).dataProviderId
637 +dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**).dataProviderId
628 628  )))|(% style="width:742px" %)SDMX:**DATA_PROVIDERS**(**1.0**).PROVIDER_1
629 629  |(% style="width:294px" %)//DataProviderScheme//|(% style="width:645px" %)(((
630 -(% style="color:#000000" %)dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**)
640 +dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**)
631 631  )))|(% style="width:742px" %)SDMX:**DATA_PROVIDERS**(**1.0**)
632 -|(% style="width:294px" %)//DataStructure//|(% style="width:645px" %)(% style="color:#000000" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version)|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0)
633 -|(% style="width:294px" %)[[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]|(% style="width:645px" %)(% style="color:#000000" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dimensionId|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0).FREQ
642 +|(% style="width:294px" %)//DataStructure//|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version)|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0)
643 +|(% style="width:294px" %)Dimension|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dimensionId|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0).FREQ
634 634  |(% style="width:294px" %)(((
635 635  DimensionDescriptor
636 636  
... ... @@ -638,9 +638,9 @@
638 638  
639 639  AttributeDescriptor
640 640  )))|(% style="width:645px" %)(((
641 -dataStructureDefinitionAgencyId:dataStructureDef initionId((% style="color:#000000" %)version)(%%).componentListId
651 +dataStructureDefinitionAgencyId:dataStructureDef initionId(version).componentListId
642 642  
643 -where the componentListId is the name of the class (there is only one occurrence of each in the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]])
653 +where the componentListId is the name of the class (there is only one occurrence of each in the Data Structure Definition)
644 644  )))|(% style="width:742px" %)(((
645 645  TFFS:EXT_DEBT(1.0.0).DimensionDescriptor
646 646  
... ... @@ -648,75 +648,75 @@
648 648  
649 649  TFFS:EXT_DEBT(1.0.0).AttributeDescriptor
650 650  )))
651 -|(% style="width:294px" %)GroupDimensionDescriptor|(% style="width:645px" %)(% style="color:#000000" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).groupDimensionDescriptorId|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0).SIBLING
652 -|(% style="width:294px" %)HierarchicalCode|(% style="width:645px" %)(% style="color:#000000" %)hierarchyAgencyId:hierarchyId(version).hierarchica lCode.hierarchicalCode|(% style="width:742px" %)UNESCO:H-C-GOV(1.0.0).GOV_CODE1.GOV_CODE1_1
661 +|(% style="width:294px" %)GroupDimensionDescriptor|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).groupDimensionDescriptorId|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0).SIBLING
662 +|(% style="width:294px" %)HierarchicalCode|(% style="width:645px" %)hierarchyAgencyId:hierarchyId(version).hierarchica lCode.hierarchicalCode|(% style="width:742px" %)UNESCO:H-C-GOV(1.0.0).GOV_CODE1.GOV_CODE1_1
653 653  
654 654  |**Classname**|(% style="width:644px" %)**Ending URN pattern**|(% style="width:743px" %)**Example**
655 -|//[[Hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]//|(% style="width:644px" %)(% style="color:#000000" %)hierarchyAgencyId:hierarchyId(version)|(% style="width:743px" %)UNESCO:H-C-GOV(1.0.0)
656 -|//HierarchyAssociation//|(% style="width:644px" %)(% style="color:#000000" %)hierarchyAssociationAgencyId:hierarchyAssociatio nId(version)|(% style="width:743px" %)UNESCO:CL_EXP_SOURCE(1.0.0)
657 -|(%%)(% style="color:#e74c3c" %)Level|(% style="width:644px" %)(% style="color:#000000" %)hierarchyAgencyId:hierarchyId(version).level|(% style="width:743px" %)UNESCO:H-C-GOV(1.0.0).LVL1
658 -|Measure|(% style="width:644px" %)(% style="color:#000000" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).measureId|(% style="width:743px" %)TFFS:EXT_DEBT(1.0.0).OBS_VALUE
665 +|//Hierarchy//|(% style="width:644px" %)hierarchyAgencyId:hierarchyId(version)|(% style="width:743px" %)UNESCO:H-C-GOV(1.0.0)
666 +|//HierarchyAssociation//|(% style="width:644px" %)hierarchyAssociationAgencyId:hierarchyAssociatio nId(version)|(% style="width:743px" %)UNESCO:CL_EXP_SOURCE(1.0.0)
667 +|Level|(% style="width:644px" %)hierarchyAgencyId:hierarchyId(version).level|(% style="width:743px" %)UNESCO:H-C-GOV(1.0.0).LVL1
668 +|Measure|(% style="width:644px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).measureId|(% style="width:743px" %)TFFS:EXT_DEBT(1.0.0).OBS_VALUE
659 659  |MetadataAttribute|(% style="width:644px" %)(((
660 -(% style="color:#000000" %)msdAgencyId:msdId(version).metadataAttributeId.
670 +msdAgencyId:msdId(version).metadataAttributeId.
661 661  
662 -(% style="color:#000000" %)metadataAttributeId
672 +metadataAttributeId
663 663  )))|(% style="width:743px" %)IMF:SDDS_MSD(1.0.0).COMPILATION.METHOD
664 -|MetadataAttributeDescriptor|(% style="width:644px" %)(% style="color:#000000" %)msdAgencyId:msdId(version).metadataAttributeDe scriptorId|(% style="width:743px" %)IMF:SDDS_MSD(1.0.0).MetadataAttributeDescriptor
665 -|//MetadataConstraint//|(% style="width:644px" %)(% style="color:#000000" %)metadataConstraintAgencyId:metadataConstraintI d(version)|(% style="width:743px" %)TFFS:CREDITOR_METADATA_CONTENT(1.0.0)
666 -|//[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]//|(% style="width:644px" %)(% style="color:#000000" %)metadataflowAgencyId:metadataflowId(version)|(% style="width:743px" %)IMF:SDDS_MDF(1.0.0)
667 -|MetadataProvider|(% style="width:644px" %)(% style="color:#000000" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**).metadataProviderId|(% style="width:743px" %)SDMX:**METADATA_PROVIDERS**(**1.0**).MD_PROVIDER_1
668 -|//MetadataProviderScheme//|(% style="width:644px" %)(% style="color:#000000" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**)|(% style="width:743px" %)SDMX:**METADATA_PROVIDERS**(**1.0**)
669 -|//MetadataProvisionAgreement//|(% style="width:644px" %)(% style="color:#000000" %)metadataProvisionAgreementAgencyId:metadataP rovisionAgreementId(version)|(% style="width:743px" %)IMF:SDDS_MDF_AB(1.0.0)
670 -|//MetadataSet//|(% style="width:644px" %)(% style="color:#000000" %)metadataProviderId:metadataSetId(version)|(% style="width:743px" %)MD_PROVIDER:METADATASET(1.0.0)
671 -|//MetadataStructure//|(% style="width:644px" %)(% style="color:#000000" %)msdAgencyId:msdId(version)|(% style="width:743px" %)IMF:SDDS_MSD(1.0.0)
674 +|MetadataAttributeDescriptor|(% style="width:644px" %)msdAgencyId:msdId(version).metadataAttributeDe scriptorId|(% style="width:743px" %)IMF:SDDS_MSD(1.0.0).MetadataAttributeDescriptor
675 +|//MetadataConstraint//|(% style="width:644px" %)metadataConstraintAgencyId:metadataConstraintI d(version)|(% style="width:743px" %)TFFS:CREDITOR_METADATA_CONTENT(1.0.0)
676 +|//Metadataflow//|(% style="width:644px" %)metadataflowAgencyId:metadataflowId(version)|(% style="width:743px" %)IMF:SDDS_MDF(1.0.0)
677 +|MetadataProvider|(% style="width:644px" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**).metadataProviderId|(% style="width:743px" %)SDMX:**METADATA_PROVIDERS**(**1.0**).MD_PROVIDER_1
678 +|//MetadataProviderScheme//|(% style="width:644px" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**)|(% style="width:743px" %)SDMX:**METADATA_PROVIDERS**(**1.0**)
679 +|//MetadataProvisionAgreement//|(% style="width:644px" %)metadataProvisionAgreementAgencyId:metadataP rovisionAgreementId(version)|(% style="width:743px" %)IMF:SDDS_MDF_AB(1.0.0)
680 +|//MetadataSet//|(% style="width:644px" %)metadataProviderId:metadataSetId(version)|(% style="width:743px" %)MD_PROVIDER:METADATASET(1.0.0)
681 +|//MetadataStructure//|(% style="width:644px" %)msdAgencyId:msdId(version)|(% style="width:743px" %)IMF:SDDS_MSD(1.0.0)
672 672  
673 673  |(% style="width:296px" %)**Classname**|(% style="width:646px" %)**Ending URN pattern**|(% style="width:739px" %)**Example**
674 -|(% style="width:296px" %)NamePersonalisation|(% style="width:646px" %)(% style="color:#000000" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|(% style="width:739px" %)ECB:PSN_SCHEME(1.0.0).PSN1234
675 -|(% style="width:296px" %)//NamePersonalisationScheme//|(% style="width:646px" %)(% style="color:#000000" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|(% style="width:739px" %)ECB:PSN_SCHEME(1.0.0)
676 -|(% style="width:296px" %)//OrganisationSchemeMap//|(% style="width:646px" %)(% style="color:#000000" %)orgSchemeMapAgencyId:orgSchemeMapId(versio n)|(% style="width:739px" %)SDMX:AGENCIES_PROVIDERS(1.0.0)
677 -|(% style="width:296px" %)OrganisationUnit|(% style="width:646px" %)(% style="color:#000000" %)organisationUnitSchemeAgencyId:organisationUni tSchemeId(version).organisationUnitId|(% style="width:739px" %)ECB:ORGANISATIONS(1.0.0).1F
678 -|(% style="width:296px" %)//OrganisationUnitScheme//|(% style="width:646px" %)(% style="color:#000000" %)organisationUnitSchemeAgencyId:organisationUni tSchemeId(version)|(% style="width:739px" %)ECB:ORGANISATIONS(1.0.0)
679 -|(% style="width:296px" %)//Process//|(% style="width:646px" %)(% style="color:#000000" %)processAgencyId:processId{version)|(% style="width:739px" %)BIS:PROCESS1(1.0.0)
684 +|(% style="width:296px" %)NamePersonalisation|(% style="width:646px" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|(% style="width:739px" %)ECB:PSN_SCHEME(1.0.0).PSN1234
685 +|(% style="width:296px" %)//NamePersonalisationScheme//|(% style="width:646px" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|(% style="width:739px" %)ECB:PSN_SCHEME(1.0.0)
686 +|(% style="width:296px" %)//OrganisationSchemeMap//|(% style="width:646px" %)orgSchemeMapAgencyId:orgSchemeMapId(versio n)|(% style="width:739px" %)SDMX:AGENCIES_PROVIDERS(1.0.0)
687 +|(% style="width:296px" %)OrganisationUnit|(% style="width:646px" %)organisationUnitSchemeAgencyId:organisationUni tSchemeId(version).organisationUnitId|(% style="width:739px" %)ECB:ORGANISATIONS(1.0.0).1F
688 +|(% style="width:296px" %)//OrganisationUnitScheme//|(% style="width:646px" %)organisationUnitSchemeAgencyId:organisationUni tSchemeId(version)|(% style="width:739px" %)ECB:ORGANISATIONS(1.0.0)
689 +|(% style="width:296px" %)//Process//|(% style="width:646px" %)processAgencyId:processId{version)|(% style="width:739px" %)BIS:PROCESS1(1.0.0)
680 680  |(% style="width:296px" %)ProcessStep|(% style="width:646px" %)(((
681 -(% style="color:#000000" %)processAgencyId:processId(version).processStepId.
691 +processAgencyId:processId(version).processStepId.
682 682  
683 -(% style="color:#000000" %)processStepId
693 +processStepId
684 684  )))|(% style="width:739px" %)BIS:PROCESS1(1.0.0).STEP1.STEP1_1
685 -|(% style="width:296px" %)//ProvisionAgreement//|(% style="width:646px" %)(% style="color:#000000" %)provisionAgreementAgencyId:provisionAgreement Id(version)|(% style="width:739px" %)TFFS:CRED_EXT_DEBT_AB(1.0.0)
695 +|(% style="width:296px" %)//ProvisionAgreement//|(% style="width:646px" %)provisionAgreementAgencyId:provisionAgreement Id(version)|(% style="width:739px" %)TFFS:CRED_EXT_DEBT_AB(1.0.0)
686 686  |(% style="width:296px" %)ReportingCategory|(% style="width:646px" %)(((
687 -(% style="color:#000000" %)reportingTaxonomyAgencyId:
697 +reportingTaxonomyAgencyId:
688 688  
689 -(% style="color:#000000" %)reportingTaxonomyId(version).reportingCategoryI d.reportingCategoryId
699 +reportingTaxonomyId(version).reportingCategoryI d.reportingCategoryId
690 690  )))|(% style="width:739px" %)IMF:REP_1(1.0.0):LVL1_REP_CAT.LVL2_REP_CAT
691 -|(% style="width:296px" %)//ReportingTaxonomy//|(% style="width:646px" %)(% style="color:#000000" %)reportingTaxonomyAgencyId:reportingTaxonomyI d(version)|(% style="width:739px" %)IMF:REP_1(1.0.0)
692 -|(% style="width:296px" %)//ReportingTaxonomyMap//|(% style="width:646px" %)repTaxonomyAgencyId:repTaxonomyId((% style="color:#e74c3c" %)version(%%))|(% style="width:739px" %)[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:RT_MAP(1.0.0)
701 +|(% style="width:296px" %)//ReportingTaxonomy//|(% style="width:646px" %)reportingTaxonomyAgencyId:reportingTaxonomyI d(version)|(% style="width:739px" %)IMF:REP_1(1.0.0)
702 +|(% style="width:296px" %)//ReportingTaxonomyMap//|(% style="width:646px" %)repTaxonomyAgencyId:repTaxonomyId(version)|(% style="width:739px" %)SDMX:RT_MAP(1.0.0)
693 693  
694 694  |(% style="width:297px" %)**Classname**|(% style="width:647px" %)**Ending URN pattern**|(% style="width:737px" %)**Example**
695 -|(% style="width:297px" %)//RepresentationMap//|(% style="width:647px" %)repMapAgencyId:repMapId((% style="color:#e74c3c" %)version(%%))|(% style="width:737px" %)[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:REF_AREA_MAPPING(1.0.0)
696 -|(% style="width:297px" %)Ruleset|(% style="width:647px" %)rulesetSchemeAgencyId rulesetSchemeId((% style="color:#e74c3c" %)version(%%)) rulesetId|(% style="width:737px" %)ECB:RULESET_23(1.0.0).SET111
697 -|(% style="width:297px" %)//RulesetScheme//|(% style="width:647px" %)rulesetSchemeAgencyId rulesetSchemeId((% style="color:#e74c3c" %)version(%%))|(% style="width:737px" %)ECB:RULESET_23(1.0.0)
698 -|(% style="width:297px" %)//StructureMap//|(% style="width:647px" %)structureMapAgencyId:structureMap((% style="color:#e74c3c" %)version(%%))|(% style="width:737px" %)[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:BOP_STRUCTURES(1.0.0)
699 -|(% style="width:297px" %)[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]|(% style="width:647px" %)(((
700 -The [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] is not itself an [[Identifiable Artefact>>doc:sdmx:Glossary.Identifiable artefact.WebHome]] and therefore it does not follow the rules for URN structure.
705 +|(% style="width:297px" %)//RepresentationMap//|(% style="width:647px" %)repMapAgencyId:repMapId(version)|(% style="width:737px" %)SDMX:REF_AREA_MAPPING(1.0.0)
706 +|(% style="width:297px" %)Ruleset|(% style="width:647px" %)rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|(% style="width:737px" %)ECB:RULESET_23(1.0.0).SET111
707 +|(% style="width:297px" %)//RulesetScheme//|(% style="width:647px" %)rulesetSchemeAgencyId rulesetSchemeId(version)|(% style="width:737px" %)ECB:RULESET_23(1.0.0)
708 +|(% style="width:297px" %)//StructureMap//|(% style="width:647px" %)structureMapAgencyId:structureMap(version)|(% style="width:737px" %)SDMX:BOP_STRUCTURES(1.0.0)
709 +|(% style="width:297px" %)Subscription|(% style="width:647px" %)(((
710 +The Subscription is not itself an Identifiable Artefact and therefore it does not follow the rules for URN structure.
701 701  The name of the URN is registryURN There is no pre-determined format.
702 -)))|(% style="width:737px" %)This cannot be generated by a common mechanism as [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]], although maintainable in the sense that they can be submitted and deleted, are not mandated to be created by a [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] and have no versioning mechanism. It is therefore the responsibility of the target registry to generate a unique Id for the [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]], and for the application creating the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] to store the registry URN that is returned from the registry in the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] response message.
703 -|(% style="width:297px" %)TimeDimension|(% style="width:647px" %)(% style="color:#000000" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).timeDimensionId|(% style="width:737px" %)TFFS:EXT_DEBT(1.0.0).TIME_PERIOD
704 -|(% style="width:297px" %)Transformation|(% style="width:647px" %)(% style="color:#000000" %)transformationSchemeAgencyId transformationSchemeId(version) transformationId|(% style="width:737px" %)ECB:TRANSFORMATION_SCHEME(1.0.0).TRANS_1
705 -|(% style="width:297px" %)//TransformationScheme//|(% style="width:647px" %)(% style="color:#000000" %)transformationSchemeAgencyId transformationSchemeId(version)|(% style="width:737px" %)ECB: TRANSFORMATION_SCHEME(1.0.0)
712 +)))|(% style="width:737px" %)This cannot be generated by a common mechanism as subscriptions, although maintainable in the sense that they can be submitted and deleted, are not mandated to be created by a maintenance agency and have no versioning mechanism. It is therefore the responsibility of the target registry to generate a unique Id for the Subscription, and for the application creating the subscription to store the registry URN that is returned from the registry in the subscription response message.
713 +|(% style="width:297px" %)TimeDimension|(% style="width:647px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).timeDimensionId|(% style="width:737px" %)TFFS:EXT_DEBT(1.0.0).TIME_PERIOD
714 +|(% style="width:297px" %)Transformation|(% style="width:647px" %)transformationSchemeAgencyId transformationSchemeId(version) transformationId|(% style="width:737px" %)ECB:TRANSFORMATION_SCHEME(1.0.0).TRANS_1
715 +|(% style="width:297px" %)//TransformationScheme//|(% style="width:647px" %)transformationSchemeAgencyId transformationSchemeId(version)|(% style="width:737px" %)ECB: TRANSFORMATION_SCHEME(1.0.0)
706 706  |(% style="width:297px" %)**Classname**|(% style="width:647px" %)**Ending URN pattern**|(% style="width:737px" %)**Example**
707 707  |(% style="width:297px" %)Transition|(% style="width:647px" %)(((
708 -(% style="color:#000000" %)processAgencyId:processId(version).processStepId.
718 +processAgencyId:processId(version).processStepId.
709 709  transitionId
710 710  )))|(% style="width:737px" %)BIS:PROCESS1(1.0.0).STEP1.TRANSITION1
711 -|(% style="width:297px" %)UserDefinedOperator|(% style="width:647px" %)(% style="color:#000000" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|(% style="width:737px" %)ECB:OS_CALC(1.2.0).OS267
712 -|(% style="width:297px" %)//UserDefinedOperatorScheme//|(% style="width:647px" %)(% style="color:#000000" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|(% style="width:737px" %)ECB:OS_CALC(1.2.0)
713 -|(% style="width:297px" %)//ValueList//|(% style="width:647px" %)(% style="color:#000000" %)valuelistAgencyId:valuelistId(version)|(% style="width:737px" %)[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:VLIST(1.0.0)
714 -|(% style="width:297px" %)VtlCodelistMapping|(% style="width:647px" %)(% style="color:#000000" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|(% style="width:737px" %)ECB:CLIST_MP(2.0.0).ABZ
715 -|(% style="width:297px" %)VtlConceptMapping|(% style="width:647px" %)(% style="color:#000000" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|(% style="width:737px" %)ECB:CLIST_MP(1.0.0).XYA
716 -|(% style="width:297px" %)VtlDataflowMapping|(% style="width:647px" %)(% style="color:#000000" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|(% style="width:737px" %)ECB:CLIST_MP(1.0.0).MOQ
717 -|(% style="width:297px" %)//VtlMappingScheme//|(% style="width:647px" %)(% style="color:#000000" %)vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|(% style="width:737px" %)ECB:CLIST_MP(2.0.0)
721 +|(% style="width:297px" %)UserDefinedOperator|(% style="width:647px" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|(% style="width:737px" %)ECB:OS_CALC(1.2.0).OS267
722 +|(% style="width:297px" %)//UserDefinedOperatorScheme//|(% style="width:647px" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|(% style="width:737px" %)ECB:OS_CALC(1.2.0)
723 +|(% style="width:297px" %)//ValueList//|(% style="width:647px" %)valuelistAgencyId:valuelistId(version)|(% style="width:737px" %)SDMX:VLIST(1.0.0)
724 +|(% style="width:297px" %)VtlCodelistMapping|(% style="width:647px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|(% style="width:737px" %)ECB:CLIST_MP(2.0.0).ABZ
725 +|(% style="width:297px" %)VtlConceptMapping|(% style="width:647px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|(% style="width:737px" %)ECB:CLIST_MP(1.0.0).XYA
726 +|(% style="width:297px" %)VtlDataflowMapping|(% style="width:647px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|(% style="width:737px" %)ECB:CLIST_MP(1.0.0).MOQ
727 +|(% style="width:297px" %)//VtlMappingScheme//|(% style="width:647px" %)vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|(% style="width:737px" %)ECB:CLIST_MP(2.0.0)
718 718  
719 -**Table 3: Table of identification components for SDMX Identifiable Artefacts**
729 +5**Table 3: Table of identification components for SDMX Identifiable Artefacts**
720 720  
721 721  = 7 Implementation Notes =
722 722  
... ... @@ -724,88 +724,90 @@
724 724  
725 725  === 7.1.1 Introduction ===
726 726  
727 -The [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] must have the ability to support agencies in their role of defining and disseminating [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]. These [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] include [[data structure definitions>>doc:sdmx:Glossary.Data structure definition.WebHome]], [[code lists>>doc:sdmx:Glossary.Code list.WebHome]], (% style="color:#e74c3c" %)concepts(%%) etc. and are fully defined in the [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]. An authenticated agency may submit valid [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] definitions which must be stored in the registry. Note that the term “[[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]]” refers as a general term to all structural [[components>>doc:sdmx:Glossary.Component.WebHome]] ([[Data Structure Definitions>>doc:sdmx:Glossary.Data structure definition.WebHome]], [[Metadata Structure Definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], [[Code Lists>>doc:sdmx:Glossary.Code list.WebHome]], [[Concept Schemes>>doc:sdmx:Glossary.Concept scheme.WebHome]], etc.)
737 +The SDMX Registry must have the ability to support agencies in their role of defining and disseminating structural metadata artefacts. These artefacts include data structure definitions, code lists, concepts etc. and are fully defined in the SDMX-IM. An authenticated agency may submit valid structural metadata definitions which must be stored in the registry. Note that the term “structural metadata” refers as a general term to all structural components (Data Structure Definitions, Metadata Structure Definitions, Code Lists, Concept Schemes, etc.)
728 728  
729 -At a minimum, [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] definitions may be submitted to and queried from the registry via an HTTP/HTTPS POST in the form of one of the [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] messages for [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] and the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful API for structure queries. The message may contain all [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] items for the whole registry, [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] items for one [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]], or individual [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] items.
739 +At a minimum, structural metadata definitions may be submitted to and queried from the registry via an HTTP/HTTPS POST in the form of one of the SDMX-ML messages for structural metadata and the SDMX RESTful API for structure queries. The message may contain all structural metadata items for the whole registry, structural metadata items for one maintenance agency, or individual structural metadata items.
730 730  
731 -[[Structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] items
741 +Structural metadata items
732 732  
733 -* may only be modified by the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] which created them;
743 +* may only be modified by the maintenance agency which created them;
734 734  * may only be deleted by the agency which created them;
735 735  * may not be deleted if they are referenced from other constructs in the Registry.
736 736  
737 -The (% style="color:#e74c3c" %)level(%%) of granularity for the maintenance of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[Structural Metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] objects in the registry is the [[Maintainable Artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]]. Especially for [[Item Schemes>>doc:sdmx:Glossary.Item scheme.WebHome]], though, partial maintenance may be performed, i.e., at the (% style="color:#e74c3c" %)level(%%) of the Item, by submitting an [[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] with the 'isPartial' flag set and a reduced set of Items.
747 +The level of granularity for the maintenance of SDMX Structural Metadata objects in the registry is the Maintainable Artefact. Especially for Item Schemes, though, partial maintenance may be performed, i.e., at the level of the Item, by submitting an Item Scheme with the 'isPartial' flag set and a reduced set of Items.
738 738  
739 -The following table lists the [[Maintainable Artefacts>>doc:sdmx:Glossary.Maintainable artefact.WebHome]].
749 +The following table lists the Maintainable Artefacts.
740 740  
741 741  (% style="width:825.835px" %)
742 -|(% colspan="2" style="width:455px" %)**[[Maintainable Artefacts>>doc:sdmx:Glossary.Maintainable artefact.WebHome]]**|(% style="width:367px" %)**Content**
752 +|(% colspan="2" style="width:455px" %)**Maintainable Artefacts**|(% style="width:367px" %)**Content**
743 743  |(% style="width:160px" %)**Abstract Class**|(% style="width:295px" %)**Concrete Class**|(% style="width:367px" %)
744 -|(% style="width:160px" %)[[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]]|(% style="width:295px" %)Codelist|(% style="width:367px" %)[[Code>>doc:sdmx:Glossary.Code.WebHome]]
745 -|(% style="width:160px" %) |(% style="width:295px" %)[[Concept Scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]]|(% style="width:367px" %)(% style="color:#e74c3c" %)Concept
746 -|(% style="width:160px" %) |(% style="width:295px" %)[[Category Scheme>>doc:sdmx:Glossary.Category scheme.WebHome]]|(% style="width:367px" %)[[Category>>doc:sdmx:Glossary.Category.WebHome]]
747 -|(% style="width:160px" %) |(% style="width:295px" %)[[Organisation Unit Scheme>>doc:sdmx:Glossary.Organisation unit scheme.WebHome]]|(% style="width:367px" %)Organisation Unit
748 -|(% style="width:160px" %) |(% style="width:295px" %)[[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]]|(% style="width:367px" %)Agency
749 -|(% style="width:160px" %) |(% style="width:295px" %)[[Data Provider Scheme>>doc:sdmx:Glossary.Data provider scheme.WebHome]]|(% style="width:367px" %)[[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]]
754 +|(% style="width:160px" %)Item Scheme|(% style="width:295px" %)Codelist|(% style="width:367px" %)Code
755 +|(% style="width:160px" %) |(% style="width:295px" %)Concept Scheme|(% style="width:367px" %)Concept
756 +|(% style="width:160px" %) |(% style="width:295px" %)Category Scheme|(% style="width:367px" %)Category
757 +|(% style="width:160px" %) |(% style="width:295px" %)Organisation Unit Scheme|(% style="width:367px" %)Organisation Unit
758 +|(% style="width:160px" %) |(% style="width:295px" %)Agency Scheme|(% style="width:367px" %)Agency
759 +|(% style="width:160px" %) |(% style="width:295px" %)Data Provider Scheme|(% style="width:367px" %)Data Provider
750 750  |(% style="width:160px" %) |(% style="width:295px" %)Metadata Provider Scheme|(% style="width:367px" %)Metadata Provider
751 -|(% style="width:160px" %) |(% style="width:295px" %)[[Data Consumer Scheme>>doc:sdmx:Glossary.Data consumer scheme.WebHome]]|(% style="width:367px" %)[[Data Consumer>>doc:sdmx:Glossary.Data consumer.WebHome]]
752 -|(% style="width:160px" %) |(% style="width:295px" %)Reporting Taxonomy|(% style="width:367px" %)Reporting [[Category>>doc:sdmx:Glossary.Category.WebHome]]
761 +|(% style="width:160px" %) |(% style="width:295px" %)Data Consumer Scheme|(% style="width:367px" %)Data Consumer
762 +|(% style="width:160px" %) |(% style="width:295px" %)Reporting Taxonomy|(% style="width:367px" %)Reporting Category
753 753  |(% style="width:160px" %) |(% style="width:295px" %)Transformation Scheme|(% style="width:367px" %)Transformation
754 754  |(% style="width:160px" %) |(% style="width:295px" %)Custom Type Scheme|(% style="width:367px" %)Custom Type
755 755  |(% style="width:160px" %) |(% style="width:295px" %)Name Personalisation Scheme|(% style="width:367px" %)Name Personalisation
756 -|(% style="width:160px" %) |(% style="width:295px" %)[[Vtl>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] Mapping Scheme|(% style="width:367px" %)[[Vtl>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] Codelist Mapping [[Vtl>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] (% style="color:#e74c3c" %)Concept(%%) Mapping
766 +|(% style="width:160px" %) |(% style="width:295px" %)Vtl Mapping Scheme|(% style="width:367px" %)Vtl Codelist Mapping Vtl Concept Mapping
757 757  |(% style="width:160px" %) |(% style="width:295px" %)Ruleset Scheme|(% style="width:367px" %)Ruleset
758 758  |(% style="width:160px" %) |(% style="width:295px" %)User Defined Operator Scheme|(% style="width:367px" %)User Defined Operator
759 759  |(% style="width:160px" %)Enumerated List|(% style="width:295px" %)ValueList|(% style="width:367px" %)Value Item
760 -|(% style="width:160px" %)Structure|(% style="width:295px" %)[[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]|(% style="width:367px" %)(((
761 -[[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] Descriptor
762 -Group [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] Descriptor
763 -[[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]
764 -Time [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]
765 -[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Descriptor
766 -Data [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]
770 +|(% style="width:160px" %)Structure|(% style="width:295px" %)Data Structure Definition|(% style="width:367px" %)(((
771 +Dimension Descriptor
772 +Group Dimension Descriptor
773 +Dimension
774 +Time Dimension
775 +Attribute Descriptor
776 +Data Attribute
767 767  Measure Descriptor
768 768  Measure
769 769  )))
770 -|(% style="width:160px" %) |(% style="width:295px" %)[[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]|(% style="width:367px" %)Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Descriptor Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]
771 -|(% style="width:160px" %)Structure Usage|(% style="width:295px" %)[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]|(% style="width:367px" %)
772 -|(% style="width:160px" %) |(% style="width:295px" %)[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]|(% style="width:367px" %)
780 +|(% style="width:160px" %) |(% style="width:295px" %)Metadata Structure Definition|(% style="width:367px" %)Metadata Attribute Descriptor Metadata Attribute
781 +|(% style="width:160px" %)Structure Usage|(% style="width:295px" %)Dataflow|(% style="width:367px" %)
782 +|(% style="width:160px" %) |(% style="width:295px" %)Metadataflow|(% style="width:367px" %)
773 773  |(% style="width:160px" %)None|(% style="width:295px" %)Process|(% style="width:367px" %)Process Step
774 -|(% style="width:160px" %)None|(% style="width:295px" %)Structure (% style="color:#e74c3c" %)Map|(% style="width:367px" %)(((
775 -[[Component>>doc:sdmx:Glossary.Component.WebHome]] (% style="color:#e74c3c" %)Map(%%)
776 -Epoch (% style="color:#e74c3c" %)Map(%%)
777 -Date Pattern (% style="color:#e74c3c" %)Map
784 +|(% style="width:160px" %)None|(% style="width:295px" %)Structure Map|(% style="width:367px" %)(((
785 +Component Map
786 +
787 +Epoch Map
788 +
789 +Date Pattern Map
778 778  )))
779 -|(% style="width:160px" %)None|(% style="width:295px" %)[[Representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)Map|(% style="width:367px" %)[[Representation>>doc:sdmx:Glossary.Representation.WebHome]] Mapping
780 -|(% style="width:160px" %)[[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] (% style="color:#e74c3c" %)Map|(% style="width:295px" %)Organisation Scheme (% style="color:#e74c3c" %)Map|(% style="width:367px" %)Item (% style="color:#e74c3c" %)Map
781 -|(% style="width:160px" %) |(% style="width:295px" %)[[Concept Scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] (% style="color:#e74c3c" %)Map|(% style="width:367px" %)Item (% style="color:#e74c3c" %)Map
782 -|(% style="width:160px" %) |(% style="width:295px" %)[[Category Scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] (% style="color:#e74c3c" %)Map|(% style="width:367px" %)Item (% style="color:#e74c3c" %)Map
783 -|(% style="width:160px" %) |(% style="width:295px" %)Reporting Taxonomy (% style="color:#e74c3c" %)Map|(% style="width:367px" %)Item (% style="color:#e74c3c" %)Map
784 -|(% style="width:160px" %)None|(% style="width:295px" %)[[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]]|(% style="width:367px" %)
785 -|(% style="width:160px" %)None|(% style="width:295px" %)Metadata [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]]|(% style="width:367px" %)
786 -|(% style="width:160px" %)None|(% style="width:295px" %)[[Hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]|(% style="width:367px" %)Hierarchical [[Code>>doc:sdmx:Glossary.Code.WebHome]]
787 -|(% style="width:160px" %)None|(% style="width:295px" %)[[Hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] Association|(% style="width:367px" %)
791 +|(% style="width:160px" %)None|(% style="width:295px" %)Representation Map|(% style="width:367px" %)Representation Mapping
792 +|(% style="width:160px" %)Item Scheme Map|(% style="width:295px" %)Organisation Scheme Map|(% style="width:367px" %)Item Map
793 +|(% style="width:160px" %) |(% style="width:295px" %)Concept Scheme Map|(% style="width:367px" %)Item Map
794 +|(% style="width:160px" %) |(% style="width:295px" %)Category Scheme Map|(% style="width:367px" %)Item Map
795 +|(% style="width:160px" %) |(% style="width:295px" %)Reporting Taxonomy Map|(% style="width:367px" %)Item Map
796 +|(% style="width:160px" %)None|(% style="width:295px" %)Provision Agreement|(% style="width:367px" %)
797 +|(% style="width:160px" %)None|(% style="width:295px" %)Metadata Provision Agreement|(% style="width:367px" %)
798 +|(% style="width:160px" %)None|(% style="width:295px" %)Hierarchy|(% style="width:367px" %)Hierarchical Code
799 +|(% style="width:160px" %)None|(% style="width:295px" %)Hierarchy Association|(% style="width:367px" %)
788 788  |(% style="width:160px" %)None|(% style="width:295px" %)Categorisation|(% style="width:367px" %)
789 -|(% style="width:160px" %)(% style="color:#e74c3c" %)Constraint|(% style="width:295px" %)Data (% style="color:#e74c3c" %)Constraint|(% style="width:367px" %)DataKeySet
801 +|(% style="width:160px" %)Constraint|(% style="width:295px" %)Data Constraint|(% style="width:367px" %)DataKeySet
790 790  |(% style="width:160px" %) |(% style="width:295px" %) |(% style="width:367px" %)CubeRegion
791 -|(% style="width:160px" %)(% style="color:#e74c3c" %)Constraint|(% style="width:295px" %)Metadata (% style="color:#e74c3c" %)Constraint|(% style="width:367px" %)MetadataTargetRegion
803 +|(% style="width:160px" %)Constraint|(% style="width:295px" %)Metadata Constraint|(% style="width:367px" %)MetadataTargetRegion
792 792  
793 793  **Table 4: Table of Maintainable Artefacts for Structural Definition Metadata**
794 794  
795 795  === 7.1.2 Item Scheme, Structure ===
796 796  
797 -The [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] included in the structural definitions are:
809 +The artefacts included in the structural definitions are:
798 798  
799 -* All types of [[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]] (Codelist, [[Concept Scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]], [[Category Scheme>>doc:sdmx:Glossary.Category scheme.WebHome]], Organisation Scheme, [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]], [[Data Provider Scheme>>doc:sdmx:Glossary.Data provider scheme.WebHome]], Metadata Provider Scheme, [[Data Consumer Scheme>>doc:sdmx:Glossary.Data consumer scheme.WebHome]], [[Organisation Unit Scheme>>doc:sdmx:Glossary.Organisation unit scheme.WebHome]], Transformation Scheme, Name Personalisation Scheme, Custom Type Scheme, [[Vtl>>doc:sdmx:Glossary.Validation and transformation language.WebHome]] Mapping Scheme, Ruleset Scheme, User Defined Operator Scheme)
800 -* All types of Enumerated List (ValueList){{footnote}}Note that Codelist is also an EnumeratedList.{{/footnote}}
801 -* All types of Structure ([[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]])
802 -* All types of Structure Usage ([[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]])
811 +* All types of Item Scheme (Codelist, Concept Scheme, Category Scheme, Organisation Scheme, Agency Scheme, Data Provider Scheme, Metadata Provider Scheme, Data Consumer Scheme, Organisation Unit Scheme, Transformation Scheme, Name Personalisation Scheme, Custom Type Scheme, Vtl Mapping Scheme, Ruleset Scheme, User Defined Operator Scheme)
812 +* All types of Enumerated List (ValueList)^^[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]](%%)^^
813 +* All types of Structure (Data Structure Definition, Metadata Structure Definition)
814 +* All types of Structure Usage (Dataflow, Metadataflow)
803 803  
804 804  === 7.1.3 Structure Usage ===
805 805  
806 806  ==== 7.1.3.1 Structure Usage: Basic Concepts ====
807 807  
808 -The Structure Usage defines, in its concrete classes of [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] and [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]], which flows of data and metadata use which specific Structure, and importantly for the support of data and metadata discovery, the Structure Usage can be linked to one or more [[Category>>doc:sdmx:Glossary.Category.WebHome]] in one or more [[Category Scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] using the Categorisation mechanism. This gives the ability for an application to discover data and metadata by “drilling down” the [[Category Schemes>>doc:sdmx:Glossary.Category scheme.WebHome]].
820 +The Structure Usage defines, in its concrete classes of Dataflow and Metadataflow, which flows of data and metadata use which specific Structure, and importantly for the support of data and metadata discovery, the Structure Usage can be linked to one or more Category in one or more Category Scheme using the Categorisation mechanism. This gives the ability for an application to discover data and metadata by “drilling down” the Category Schemes.
809 809  
810 810  ==== 7.1.3.2 Structure Usage Schematic ====
811 811  
... ... @@ -819,63 +819,65 @@
819 819  
820 820  **Figure 10: SDMX-IM of links from Structure Usage to Category**
821 821  
822 -In addition to the maintenance of the [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] and the [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]], the following links must be maintained in the registry:
834 +In addition to the maintenance of the Dataflow and the Metadataflow, the following links must be maintained in the registry:
823 823  
824 -* [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] to Data Structure Definition
825 -* [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] to Metadata Structure Definition
836 +1.
837 +1*. Dataflow to Data Structure Definition
838 +1*. Metadataflow to Metadata Structure Definition
826 826  
827 827  The following links may be created by means of a Categorisation
828 828  
829 -* Categorisation to [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] and [[Category>>doc:sdmx:Glossary.Category.WebHome]]
830 -* Categorisation to [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] and [[Category>>doc:sdmx:Glossary.Category.WebHome]]
842 +1.
843 +1*. Categorisation to Dataflow and Category
844 +1*. Categorisation to Metadataflow and Category
831 831  
832 832  == 7.2 Data and Metadata Provisioning ==
833 833  
834 834  === 7.2.1 Provisioning Agreement: Basic concepts ===
835 835  
836 -Data/Metadata provisioning defines a framework in which the provision of different types of statistical data and metadata by various data/metadata providers can be specified and controlled. This framework is the basis on which the existence of data can be made known to the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-enabled community and hence the basis on which data can subsequently be discovered. Such a framework can be used to regulate the data content to facilitate the building of intelligent applications. It can also be used to facilitate the processing implied by service (% style="color:#e74c3c" %)level(%%) agreements, or other provisioning agreements in those scenarios that are based on legal directives. Additionally, quality and [[timeliness>>doc:sdmx:Glossary.Timeliness.WebHome]] metadata can be supported by this framework which makes it practical to implement information supply chain monitoring.
850 +Data/Metadata provisioning defines a framework in which the provision of different types of statistical data and metadata by various data/metadata providers can be specified and controlled. This framework is the basis on which the existence of data can be made known to the SDMX-enabled community and hence the basis on which data can subsequently be discovered. Such a framework can be used to regulate the data content to facilitate the building of intelligent applications. It can also be used to facilitate the processing implied by service level agreements, or other provisioning agreements in those scenarios that are based on legal directives. Additionally, quality and timeliness metadata can be supported by this framework which makes it practical to implement information supply chain monitoring.
837 837  
838 838  Note that the term “data provisioning” here includes both the provisioning of data and metadata.
839 839  
840 -Although the [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] directly supports the data-sharing “pull” model, it is also useful in “push” exchanges (bilateral and gateway scenarios), or in a dissemination environment. It should be noted, too, that in any exchange scenario, the registry functions as a repository of structural metadata.
854 +Although the Provision Agreement directly supports the data-sharing “pull” model, it is also useful in “push” exchanges (bilateral and gateway scenarios), or in a dissemination environment. It should be noted, too, that in any exchange scenario, the registry functions as a repository of structural metadata.
841 841  
842 842  === 7.2.2 Provisioning Agreement Model – pull use case ===
843 843  
844 -An organisation which publishes statistical data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] and wishes to make it available to an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] enabled community is called a [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]]. In terms of the [[SDMX Information Model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]], the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] is maintained in a [[Data Provider Scheme>>doc:sdmx:Glossary.Data provider scheme.WebHome]].
858 +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.
845 845  
846 846  [[image:SDMX 3.1 Section 5_en_5a16c7fe.jpg||height="455" width="551"]]
847 847  
848 848  **Figure 11: SDMX-IM of the Data Provider**
849 849  
850 -Note that the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] does not inherit the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] association. The diagram below shows a logical schematic of the data model classes required to maintain [[provision agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]].
864 +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.
851 851  
852 852  [[image:SDMX 3.1 Section 5_en_b08fd1a2.jpg||height="299" width="533"]]
853 853  
854 854  **Figure 12: Schematic of the Provision Agreement**
855 855  
856 -The diagram below is a logical [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of the data required in order to maintain [[Provision Agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]].
870 +The diagram below is a logical representation of the data required in order to maintain Provision Agreements.
857 857  
858 858  [[image:SDMX 3.1 Section 5_en_c63d10ab.jpg||height="246" width="579"]]
859 859  
860 860  **Figure 13: Logical class diagram of the information contained in the Provision Agreement**
861 861  
862 -A [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] is [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]]. Each [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] must reference a [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] or Metadata Provider and a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] or [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] Definition. The Data/Metadata Provider and the [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]/[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] must exist already in order to set up a Metadata Provision or [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]].
876 +A Provision Agreement is structural metadata. Each Provision Agreement must reference a Data Provider or Metadata Provider and a Dataflow or Metadataflow Definition. The Data/Metadata Provider and the Dataflow/Metadataflow must exist already in order to set up a Metadata Provision or Provision Agreement.
863 863  
864 864  == 7.3 Data and Metadata Constraints ==
865 865  
866 866  === 7.3.1 Data and Metadata Constraints: Basic Concepts ===
867 867  
868 -(% style="color:#e74c3c" %)Constraints(%%) are, effectively, lists of the valid or actual content of data and metadata. (% style="color:#e74c3c" %)Constraints(%%) can be used to specify a subset of the theoretical content of [[data set>>doc:sdmx:Glossary.Data set.WebHome]] or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] which can be derived from the specification of the [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] or [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. A (% style="color:#e74c3c" %)Constraint(%%) can comprise a list of keys or a list of content (usually [[code>>doc:sdmx:Glossary.Code.WebHome]] values) of a specific [[component>>doc:sdmx:Glossary.Component.WebHome]] such as a [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]].
882 +Constraints are, effectively, lists of the valid or actual content of data and metadata. Constraints can be used to specify a subset of the theoretical content of data set or metadata set which can be derived from the specification of the DSD or MSD. A Constraint can comprise a list of keys or a list of content (usually code values) of a specific component such as a dimension or attribute.
869 869  
870 -(% style="color:#e74c3c" %)Constraints(%%) comprise the specification of subsets of key or [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] values that are to be provided for a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] or [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]], or directly attached to a [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] or [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]. This is important metadata because, for example, the full range of possibilities which is implied by the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] (e.g., the complete set of valid keys is the Cartesian product of all the values in the [[code lists>>doc:sdmx:Glossary.Code list.WebHome]] for each of the [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]) is often more than is intended to be supplied according to a specific [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]].
884 +Constraints comprise the specification of subsets of key or attribute values that are to be provided for a Dataflow or Metadataflow, or directly attached to a Data Structure Definition or Metadata Structure Definition. This is important metadata because, for example, the full range of possibilities which is implied by the Data Structure Definition (e.g., the complete set of valid keys is the Cartesian product of all the values in the code lists for each of the Dimensions) is often more than is intended to be supplied according to a specific Dataflow.
871 871  
872 -Often a [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] will not be able to provide data for all key combinations, either because the combination itself is not meaningful, or simply because the provider does not have the data for that combination. In this case the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] could constrain the [[data source>>doc:sdmx:Glossary.Data source.WebHome]] (at the (% style="color:#e74c3c" %)level(%%) of the [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] or the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]]) by supplying metadata that defines the key combinations or cube regions that are available. This is done by means of a (% style="color:#e74c3c" %)Constraint(%%). The (% style="color:#e74c3c" %)Constraint(%%) is also used to define a [[code list>>doc:sdmx:Glossary.Code list.WebHome]] subset which is used to populate a partial [[code list>>doc:sdmx:Glossary.Code list.WebHome]], and in generating a schema for data reporters to validate their [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] against.
886 +Often a Data Provider will not be able to provide data for all key combinations, either because the combination itself is not meaningful, or simply because the provider does not have the data for that combination. In this case the Data Provider could constrain the data source (at the level of the Provision Agreement or the Data Provider) by supplying metadata that defines the key combinations or cube regions that are available. This is done by means of a Constraint. The Constraint is also used to define a code list subset which is used to populate a partial code list, and in generating a schema for data reporters to validate their datasets against.
873 873  
874 -Furthermore, it is often useful to define subsets or views of the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] which restrict values in some [[code lists>>doc:sdmx:Glossary.Code list.WebHome]], especially where many such subsets restrict the same [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. Such a view is called a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], and there can be one or more defined for any [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]].
888 +Furthermore, it is often useful to define subsets or views of the Data Structure Definition which restrict values in some code lists, especially where many such subsets restrict the same Data Structure Definition. Such a view is called a Dataflow, and there can be one or more defined for any Data Structure Definition.
875 875  
876 -Whenever data is published or made available by a [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]], it must conform to a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] (and hence to a [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]). The [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] is thus a means of enabling content based processing.
890 +Whenever data is published or made available by a Data Provider, it must conform to a Dataflow (and hence to a Data Structure Definition). The Dataflow is thus a means of enabling content based processing.
877 877  
878 -In addition, DataAvailabilityConstraints can be extremely useful in a data visualisation system, such as dissemination of statistics on a website. In such a system a Cube Region can be used to specify the [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] [[codes>>doc:sdmx:Glossary.Code.WebHome]] that actually exist in a [[data source>>doc:sdmx:Glossary.Data source.WebHome]] (these can be used to build relevant selection tables).
892 +In addition, DataAvailabilityConstraints can be extremely useful in a data visualisation system, such as dissemination of statistics on a website. In such a system a Cube Region can be used to specify the Dimension codes that actually exist in a data source (these can be used to build relevant selection tables).
879 879  
880 880  === 7.3.2 Data and Metadata Constraints: Schematic ===
881 881  
... ... @@ -889,27 +889,27 @@
889 889  
890 890  **Figure 15: Logical class diagram showing inheritance between and reference to constrainable artefacts**
891 891  
892 -Logical class diagram showing inheritance between and reference to constrainable artefacts.
906 +Logical class diagram showing inheritance between and reference to constrainable artefacts
893 893  
894 -The class diagram above shows that [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]], Metadata Provider, [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]], [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], Metadata [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], Data Structure.
908 +The class diagram above shows that Data Provider, Metadata Provider, Dataflow, Metadataflow, Provision Agreement, Metadata Provision Agreement, Data Structure
895 895  
896 -Definition, [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] are all concrete sub-classes of Constrainable [[Artefact>>doc:sdmx:Glossary.Artefact.WebHome]] and can therefore have Data (% style="color:#e74c3c" %)Constraints(%%) specified. Note that the actual (% style="color:#e74c3c" %)Constraint(%%) as submitted is associated to the reference classes defines in the (% style="color:#e74c3c" %)Constraint(%%) Attachment.
910 +Definition, Metadata Structure Definition are all concrete sub-classes of Constrainable Artefact and can therefore have Data Constraints specified. Note that the actual Constraint as submitted is associated to the reference classes defines in the Constraint Attachment.
897 897  
898 -these are used to refer to the classes to which the (% style="color:#e74c3c" %)Constraint(%%) applies.
912 +these are used to refer to the classes to which the Constraint applies.
899 899  
900 -The content of the (% style="color:#e74c3c" %)Constraint(%%) can be found in the [[SDMX Information Model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]] document.
914 +The content of the Constraint can be found in the SDMX Information Model document.
901 901  
902 902  == 7.4 Data Registration ==
903 903  
904 904  === 7.4.1 Basic Concepts ===
905 905  
906 -A [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] has published a new [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] conforming to an existing [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] (and hence [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]). This is implemented as either a web-accessible SDMXML file, or in a database which has a web-services interface capable of responding to an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful query with an [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] data stream.
920 +A Data Provider has published a new dataset conforming to an existing Dataflow (and hence Data Structure Definition). This is implemented as either a web-accessible SDMXML file, or in a database which has a web-services interface capable of responding to an SDMX RESTful query with an SDMX-ML data stream.
907 907  
908 -The [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] wishes to make this new data available to one or more data collectors in a “pull” scenario, or to make the data available to [[data consumers>>doc:sdmx:Glossary.Data consumer.WebHome]]. To do this, the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] registers the new [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] with one or more [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] conformant registries that have been configured with structural and provisioning metadata. In other words, the registry “knows” the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] and “knows” what [[data flows>>doc:sdmx:Glossary.Dataflow.WebHome]] the [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] has agreed to make available.
922 +The Data Provider wishes to make this new data available to one or more data collectors in a “pull” scenario, or to make the data available to data consumers. To do this, the Data Provider registers the new dataset with one or more SDMX conformant registries that have been configured with structural and provisioning metadata. In other words, the registry “knows” the Data Provider and “knows” what data flows the data provider has agreed to make available.
909 909  
910 910  The same mechanism can be used to report or make available a metadata set.
911 911  
912 -[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-RR supports [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] registration via the Registration Request, which can be created by the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] (giving the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] maximum control). The registry responds to the registration request with a registration response which indicates if the registration was successful. In the event of an error, the error messages are returned as a registry exception within the response.
926 +SDMX-RR supports dataset registration via the Registration Request, which can be created by the Data Provider (giving the Data Provider maximum control). The registry responds to the registration request with a registration response which indicates if the registration was successful. In the event of an error, the error messages are returned as a registry exception within the response.
913 913  
914 914  === 7.4.2 The Registration Request ===
915 915  
... ... @@ -921,7 +921,7 @@
921 921  
922 922  ==== 7.4.2.2 Registration Request Model ====
923 923  
924 -The following UML diagram shows the composition of the registration request. Each request is made up of one or more Registrations, one per [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] to be registered. The Registration can optionally have information, which has been extracted from the Registration:
938 +The following UML diagram shows the composition of the registration request. Each request is made up of one or more Registrations, one per dataset to be registered. The Registration can optionally have information, which has been extracted from the Registration:
925 925  
926 926  * validFrom
927 927  * validTo
... ... @@ -929,7 +929,7 @@
929 929  
930 930  The last updated date is useful during the discovery process to make sure the client knows which data is freshest.
931 931  
932 -The Registration has an action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] which takes one of the following values:
946 +The Registration has an action attribute which takes one of the following values:
933 933  
934 934  (((
935 935  |(% style="width:224px" %)**Action Attribute Value**|(% style="width:1457px" %)**Behaviour**
... ... @@ -942,15 +942,15 @@
942 942  
943 943  **Figure 17: Logical Class Diagram of Registration of Data and Metadata**
944 944  
945 -The //QueryDatasource// is an abstract class that represents a [[data source>>doc:sdmx:Glossary.Data source.WebHome]], which can understand an API query (i.e., a RESTful query – RESTDatasource) and respond appropriately. Each [[data source>>doc:sdmx:Glossary.Data source.WebHome]] inherits the dataURL from //Datasource//, and the //QueryDatasource// has an additional URL to locate the specification of the service (specURL) to describe how to access it. All other supported protocols are assumed to use the SimpleDatasource URL.
959 +The //QueryDatasource// is an abstract class that represents a data source, which can understand an API query (i.e., a RESTful query – RESTDatasource) and respond appropriately. Each data source inherits the dataURL from //Datasource//, and the //QueryDatasource// has an additional URL to locate the specification of the service (specURL) to describe how to access it. All other supported protocols are assumed to use the SimpleDatasource URL.
946 946  
947 -A SimpleDatasource is used to reference a physical [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] file that is available at a URL.
961 +A SimpleDatasource is used to reference a physical SDMX-ML file that is available at a URL.
948 948  
949 -The RegistrationRequest has an action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] which defines whether this is a new (append) or updated (replace) Registration, or that the Registration is to be deleted (delete). The id is only provided for the replace and delete actions, as the Registry will allocate the unique id of the (new) Registration.
963 +The RegistrationRequest has an action attribute which defines whether this is a new (append) or updated (replace) Registration, or that the Registration is to be deleted (delete). The id is only provided for the replace and delete actions, as the Registry will allocate the unique id of the (new) Registration.
950 950  
951 -The Registration includes [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] that state how a SimpleDatasource is to be indexed when registered. The Registry registration process must act as follows:
965 +The Registration includes attributes that state how a SimpleDatasource is to be indexed when registered. The Registry registration process must act as follows:
952 952  
953 -Information in the [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] is extracted and made available via the availability REST API as documented here:
967 +Information in the dataset is extracted and made available via the availability REST API as documented here:
954 954  
955 955  https:~/~/github.com/sdmx-twg/sdmx-rest/blob/master/doc/availability.md
956 956  
... ... @@ -957,24 +957,24 @@
957 957  (((
958 958  (% style="width:918.835px" %)
959 959  |**Indexing Required**|(% style="width:745px" %)**Registration Process Activity**
960 -|indexTimeSeries|(% style="width:745px" %)Extract all the [[series keys>>doc:sdmx:Glossary.Series key.WebHome]] and create a KeySet(s) Constraint.
961 -|indexDataSet|(% style="width:745px" %)Extract all the [[codes>>doc:sdmx:Glossary.Code.WebHome]] and other content of the Key value of the [[Series Key>>doc:sdmx:Glossary.Series key.WebHome]] in a [[Data Set>>doc:sdmx:Glossary.Data set.WebHome]] and create one or more Cube Regions containing [[Member Selections>>doc:sdmx:Glossary.Member selection.WebHome]] of [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] [[Components>>doc:sdmx:Glossary.Component.WebHome]] of the (% style="color:#e74c3c" %)Constraints(%%) model in the [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]], and the associated Selection Value.
974 +|indexTimeSeries|(% style="width:745px" %)Extract all the series keys and create a KeySet(s) Constraint.
975 +|indexDataSet|(% style="width:745px" %)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.
962 962  |indexReportingPeriod|(% style="width:745px" %)(((
963 -This applies only to a registered __[[dataset>>doc:sdmx:Glossary.Data set.WebHome]]__.
964 -Extract the Reporting Begin and Reporting End from the Header of the Message containing the [[data set>>doc:sdmx:Glossary.Data set.WebHome]], and create a [[Reference Period>>doc:sdmx:Glossary.Reference period.WebHome]] constraint.
977 +This applies only to a registered __dataset__.
978 +Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint.
965 965  )))
966 966  |indexAttributes|(% style="width:745px" %)(((
967 967  **Data Set**
968 -Extract the content of the [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Values in a [[Data Set>>doc:sdmx:Glossary.Data set.WebHome]] and create one or more Cube Regions containing [[Member Selections>>doc:sdmx:Glossary.Member selection.WebHome]] of Data [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] [[Components>>doc:sdmx:Glossary.Component.WebHome]] of the (% style="color:#e74c3c" %)Constraints(%%) model in the SDMXIM, and the associated Selection Value
982 +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
969 969  
970 970  **Metadata Set**
971 -Indicate the presence of a Reported [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] by creating one or more Cube Regions containing [[Member Selections>>doc:sdmx:Glossary.Member selection.WebHome]] of Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] [[Components>>doc:sdmx:Glossary.Component.WebHome]] of the (% style="color:#e74c3c" %)Constraints(%%) model in the
985 +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
972 972  )))
973 973  |**Indexing Required**|(% style="width:745px" %)**Registration Process Activity**
974 -| |(% style="width:745px" %)[[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]. Note that the content is not stored in the Selection Value.
988 +| |(% style="width:745px" %)SDMX-IM. Note that the content is not stored in the Selection Value.
975 975  )))
976 976  
977 -(% style="color:#e74c3c" %)Constraints(%%) that specify the contents of a //QueryDatasource// are submitted to the Registry via the structure submission service (i.e., the RESTful API).
991 +Constraints that specify the contents of a //QueryDatasource// are submitted to the Registry via the structure submission service (i.e., the RESTful API).
978 978  
979 979  The Registration must reference the ProvisionAgreement to which it relates.
980 980  
... ... @@ -982,9 +982,9 @@
982 982  
983 983  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 SubmitRegistration class has a status field, which is either set to “Success”, “Warning” or “Failure”.
984 984  
985 -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>>doc:sdmx:Glossary.Data set.WebHome]] or query service.
999 +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 or query service.
986 986  
987 -The RegistrationResponse returns set of registration status (one for each registration submitted) in terms of a StatusMessage (this is common to all Registry responses) that indicates success or failure. In the event of registration failure, a set of MessageText are returned, giving the error messages that occurred during registration. It is entirely possible when registering a batch of [[datasets>>doc:sdmx:Glossary.Data set.WebHome]], that the response will contain some successful and some failed statuses. The logical model for the RegistrationResponse is shown below:
1001 +The RegistrationResponse returns set of registration status (one for each registration submitted) in terms of a StatusMessage (this is common to all Registry responses) that indicates success or failure. In the event of registration failure, a set of MessageText 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 RegistrationResponse is shown below:
988 988  
989 989  [[image:SDMX 3.1 Section 5_en_cdba03b5.jpg||height="371" width="579"]]
990 990  
... ... @@ -992,11 +992,11 @@
992 992  
993 993  == 7.5 Subscription and Notification Service ==
994 994  
995 -The contents of the [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]]/Repository will change regularly: new [[code lists>>doc:sdmx:Glossary.Code list.WebHome]] and key families will be published and new [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] and metadata-sets will be registered. To obviate the need for users to repeatedly query the registry to see when new information is available, a mechanism is provided to allow users to be notified when these events happen.
1009 +The contents of the SDMX Registry/Repository will change regularly: new code lists and key families will be published and new datasets and metadata-sets will be registered. To obviate the need for users to repeatedly query the registry to see when new information is available, a mechanism is provided to allow users to be notified when these events happen.
996 996  
997 -A user can submit a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] in the registry that defines which events are of interest, and either an email and/or an HTTP address to which a [[notification>>doc:sdmx:Glossary.Notification.WebHome]] of qualifying events will be delivered. The [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] will be identified in the registry by a URN, which is returned to the user when the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] is created. If the user wants to delete the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] at a later point, the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] URN is used as identification. [[Subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] have a validity period expressed as a date range (startDate, endDate) and the registry may delete any expired [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]], and will notify the subscriber on expiry.
1011 +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.
998 998  
999 -When a registry/repository [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is modified, any [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] 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>>doc:sdmx:Glossary.Subscription.WebHome]]. This is called a “[[notification>>doc:sdmx:Glossary.Notification.WebHome]]”.
1013 +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”.
1000 1000  
1001 1001  === 7.5.1 Subscription Logical Class Diagram ===
1002 1002  
... ... @@ -1006,19 +1006,19 @@
1006 1006  
1007 1007  === 7.5.2 Subscription Information ===
1008 1008  
1009 -Regardless of the type of registry/repository events being observed, a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] always contains:
1023 +Regardless of the type of registry/repository events being observed, a subscription always contains:
1010 1010  
1011 -1. A set of URIs describing the end-points to which [[notifications>>doc:sdmx:Glossary.Notification.WebHome]] must be sent if the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] is activated. The URIs can be either mailto~: or http: protocol. In the former case an email [[notification>>doc:sdmx:Glossary.Notification.WebHome]] is sent; in the latter an HTTP POST [[notification>>doc:sdmx:Glossary.Notification.WebHome]] is sent.
1012 -1. A user-defined identifier, which is returned in the response to the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request. This helps with asynchronous processing and is NOT stored in the Registry.
1013 -1. A validity period which defines both when the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] becomes active and expires. The subscriber may be sent a [[notification>>doc:sdmx:Glossary.Notification.WebHome]] on expiration of the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]].
1025 +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.
1026 +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.
1027 +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.
1014 1014  1. A selector which specifies which type of events are of interest. The set of event types is:
1015 1015  
1016 1016  (((
1017 1017  (% style="width:1061.83px" %)
1018 1018  |**Event Type**|(% style="width:660px" %)**Comment**
1019 -|STRUCTURAL_REPOSITORY_EVENTS|(% style="width:660px" %)Life-cycle changes to [[Maintainable Artefacts>>doc:sdmx:Glossary.Maintainable artefact.WebHome]] in the [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository.
1020 -|DATA_REGISTRATION_EVENTS|(% style="width:660px" %)Whenever a published [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] is registered. This can be either a SDMXML data file or an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] conformant database.
1021 -|METADATA_REGISTRATION_EVENTS|(% style="width:660px" %)Whenever a published metadataset is registered. This can be either a SDMXML [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] file or an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] conformant database.
1033 +|STRUCTURAL_REPOSITORY_EVENTS|(% style="width:660px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1034 +|DATA_REGISTRATION_EVENTS|(% style="width:660px" %)Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
1035 +|METADATA_REGISTRATION_EVENTS|(% style="width:660px" %)Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
1022 1022  |ALL_EVENTS|(% style="width:660px" %)All events of the specified EventType
1023 1023  )))
1024 1024  
... ... @@ -1080,20 +1080,20 @@
1080 1080  
1081 1081  === 7.5.4 Structural Repository Events ===
1082 1082  
1083 -Whenever a [[maintainable artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]] ([[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], [[concept scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]], codelist, [[metadata structure definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]], etc.) is added to, deleted from, or modified in the [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, a [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] event is triggered. [[Subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] may be set up to monitor all such events, or focus on specific [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] such as a [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]].
1097 +Whenever a maintainable artefact (data structure definition, concept scheme, codelist, metadata structure definition, category scheme, etc.) is added to, deleted from, or modified in the structural metadata repository, a structural metadata event is triggered. Subscriptions may be set up to monitor all such events, or focus on specific artefacts such as a Data Structure Definition.
1084 1084  
1085 1085  === 7.5.5 Registration Events ===
1086 1086  
1087 -Whenever a [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] or metadata-set is registered a registration event is created. A [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] may be observing all data or metadata registrations, or it may focus on specific registrations as shown in the table below:
1101 +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:
1088 1088  
1089 1089  (((
1090 1090  (% style="width:1082.83px" %)
1091 1091  |(% style="width:230px" %)**Selector**|(% style="width:850px" %)**Comment**
1092 -|(% style="width:230px" %)DataProvider|(% style="width:850px" %)Any [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] registered by the specified dataprovider will activate the notification.
1093 -|(% style="width:230px" %)ProvisionAgreement|(% style="width:850px" %)Any [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] for the agreement will activate the notification.
1094 -|(% style="width:230px" %)[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]|(% style="width:850px" %)Any [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] for the specified [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] will activate the notification.
1095 -|(% style="width:230px" %)DataStructureDefinition|(% style="width:850px" %)Any [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] for those [[dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]] that are based on the specified [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] will activate the notification
1096 -|(% style="width:230px" %)Category|(% style="width:850px" %)Any [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] registered for those [[dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]], [[provision agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]] that are categorised by the category.
1106 +|(% style="width:230px" %)DataProvider|(% style="width:850px" %)Any datasets registered by the specified dataprovider will activate the notification.
1107 +|(% style="width:230px" %)ProvisionAgreement|(% style="width:850px" %)Any datasets for the agreement will activate the notification.
1108 +|(% style="width:230px" %)Dataflow|(% style="width:850px" %)Any datasets for the specified dataflow will activate the notification.
1109 +|(% style="width:230px" %)DataStructureDefinition|(% style="width:850px" %)Any datasets for those dataflows that are based on the specified Data Structure Definition will activate the notification
1110 +|(% style="width:230px" %)Category|(% style="width:850px" %)Any datasets registered for those dataflows, provision agreements that are categorised by the category.
1097 1097  )))
1098 1098  
1099 1099  The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration.
... ... @@ -1106,25 +1106,31 @@
1106 1106  
1107 1107  **Figure 20: Logical Class Diagram of the Notification**
1108 1108  
1109 -A [[notification>>doc:sdmx:Glossary.Notification.WebHome]] is an XML document that is sent to a user via email or http POST whenever a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] is activated. It is an asynchronous one-way message.
1123 +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.
1110 1110  
1111 -Regardless of the registry [[component>>doc:sdmx:Glossary.Component.WebHome]] that caused the event to be triggered, the following common information is in the message:
1125 +Regardless of the registry component that caused the event to be triggered, the following common information is in the message:
1112 1112  
1113 1113  * Date and time that the event occurred
1114 -* The URN of the [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] that caused the event
1115 -* The URN of the [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] that produced the [[notification>>doc:sdmx:Glossary.Notification.WebHome]]
1128 +* The URN of the artefact that caused the event
1129 +* The URN of the Subscription that produced the notification
1116 1116  * Event Action: Add, Replace, or Delete.
1117 1117  
1118 -Additionally, supplementary information may be contained in the [[notification>>doc:sdmx:Glossary.Notification.WebHome]] as detailed below.
1132 +Additionally, supplementary information may be contained in the notification as detailed below.
1119 1119  
1120 1120  === 7.6.2 Structural Event Component ===
1121 1121  
1122 -The [[notification>>doc:sdmx:Glossary.Notification.WebHome]] will contain the MaintainableArtefact that triggered the event in a form similar to the [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] structural message (using elements from that namespace).
1136 +The notification will contain the MaintainableArtefact that triggered the event in a form similar to the SDMX-ML structural message (using elements from that namespace).
1123 1123  
1124 1124  === 7.6.3 Registration Event Component ===
1125 1125  
1126 -The [[notification>>doc:sdmx:Glossary.Notification.WebHome]] will contain the Registration.
1140 +The notification will contain the Registration.
1127 1127  
1128 1128  ----
1129 1129  
1144 +[[2>>path:#sdfootnote2anc||name="sdfootnote2sym"]] The identification of an Agency in the URN structure for the maintainable object is by means of the agencyId. The AgencyScheme is not identified as SDMX has a mechanism for identifying an Agency uniquely by its Id. Note that this Id may be hierarchical. For example, a sub-agency of IMF is referred like this:
1145 +
1146 +IMF.SubAgency1
1147 +
1148 +[[3>>path:#sdfootnote3anc||name="sdfootnote3sym"]] Note that Codelist is also an EnumeratedList.
1149 +
1130 1130  {{putFootnotes/}}