Last modified by Helena on 2025/09/10 11:19

From version 29.2
edited by Helena
on 2025/05/16 14:06
Change comment: There is no comment for this version
To version 21.3
edited by Helena
on 2025/05/15 14:08
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -107,7 +107,7 @@
107 107  
108 108  Notifying interested parties of newly published or re-published data, reference metadata or changes in structural metadata involves:
109 109  
110 -* registry support of a subscription-based notification service which sends an email or notifies an HTTP address announcing all published data that meets the criteria contained in the subscription request.
110 + registry support of a subscription-based notification service which sends an email or notifies an HTTP address announcing all published data that meets the criteria contained in the subscription request.
111 111  
112 112  == {{id name="_Toc93838"/}}3.5 Discovery ==
113 113  
... ... @@ -166,8 +166,9 @@
166 166  
167 167  The registry interfaces are invoked in one of two ways:
168 168  
169 -1. The interface is the name of the root node of the SDMX-ML document
170 -1. The interface is invoked as a child element of the RegistryInterface message where the RegistryInterface is the root node of the SDMX-ML document.
169 +*
170 +*1. The interface is the name of the root node of the SDMX-ML document
171 +*1. The interface is invoked as a child element of the RegistryInterface message where the RegistryInterface is the root node of the SDMX-ML document.
171 171  
172 172  In addition to these interfaces the registry must support a mechanism for submitting and querying for structural metadata. This is detailed in sections 5.2.2 and 5.2.3.
173 173  
... ... @@ -183,11 +183,11 @@
183 183  
184 184  === {{id name="_Toc93847"/}}5.2.2 Structure Submission Service ===
185 185  
186 -The registry must support a mechanism for submitting structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: [[__https:~~/~~/github.com/sdmx-twg/sdmx-rest__>>https://https:github.comsdmx-twgsdmx-rest]]). In order for the architecture to be scalable, the finest-grained piece of structural metadata that can be processed by the SDMX-RR is a MaintainableArtefact, with the exception of Item Schemes, where changes at an Item level is also possible (see next section on the SDMX Information Model).
187 +The registry must support a mechanism for submitting structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: __[[https:~~/~~/github.com/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[twg/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[rest>>url:https://github.com/sdmx-twg/sdmx-rest]]__[[)>>url:https://github.com/sdmx-twg/sdmx-rest]]. In order for the architecture to be scalable, the finest-grained piece of structural metadata that can be processed by the SDMX-RR is a MaintainableArtefact, with the exception of Item Schemes, where changes at an Item level is also possible (see next section on the SDMX Information Model).
187 187  
188 188  === {{id name="_Toc93848"/}}5.2.3 Structure Query Service ===
189 189  
190 -The registry must support a mechanism for querying for structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: [[__https:~~/~~/github.com/sdmx-twg/sdmx-rest__>>https://https:github.comsdmx-twgsdmx-rest]]). The registry response to this query mechanism is the SDMX Structure message, which has as its root node:
191 +The registry must support a mechanism for querying for structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: __[[https:~~/~~/github.com/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[twg/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[rest>>url:https://github.com/sdmx-twg/sdmx-rest]]__ [[)>>url:https://github.com/sdmx-twg/sdmx-rest]]. The registry response to this query mechanism is the SDMX Structure message, which has as its root node:
191 191  
192 192  * Structure
193 193  
... ... @@ -243,22 +243,23 @@
243 243  * that the components (Dimensions, Attributes, Measures, Metadata Attributes, etc.) are consistent with the Data Structure Definition or Metadata Structure Definition;
244 244  * that the valid representations of the concepts to which these components correspond conform to the definition in the Data Structure Definition or Metadata Structure Definition. The Registration has an action attribute which takes one of the following values:
245 245  
246 -(% style="width:755.294px" %)
247 -|(% style="width:187px" %)**Action Attribute Value**|(% style="width:566px" %)**Behaviour**
248 -|(% style="width:187px" %)Append|(% style="width:566px" %)Add this registration to the registry
249 -|(% style="width:187px" %)Replace|(% style="width:566px" %)Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request
250 -|(% style="width:187px" %)Delete|(% style="width:566px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
247 +|**Action Attribute Value**|**Behaviour**
248 +|Append|Add this registration to the registry
249 +|Replace|Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request
250 +|Delete|Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
251 251  
252 252  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:
253 253  
254 -(% style="width:759.294px" %)
255 -|(% style="width:191px" %)**Boolean Attribute**|(% style="width:565px" %)**Behaviour if Value is “true”**
256 -|(% style="width:191px" %)indexTimeSeries|(% style="width:565px" %)A compliant indexing application must index all the time series keys (for a Dataset registration) or metadata target values (for a Metadataset registration)
257 -|(% style="width:191px" %)indexDataSet|(% style="width:565px" %)(((
258 -A compliant indexing application must index the range of actual (present) values for each dimension of the Dataset (for a Dataset registration) or the range of actual (present) values for each Metadata Attribute which takes an enumerated value.
254 +|**Boolean Attribute**|**Behaviour if Value is “true”**
255 +|indexTimeSeries|A compliant indexing application must index all the time series keys (for a Dataset registration) or metadata target values (for a Metadataset registration)
256 +|indexDataSet|(((
257 +A compliant indexing application must index the range of actual
258 +
259 +(present) values for each dimension of the Dataset (for a Dataset registration) or the range of actual (present) values for each Metadata Attribute which takes an enumerated value.
260 +
259 259  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
260 260  )))
261 -|(% style="width:191px" %)indexReportingPeriod|(% style="width:565px" %)A compliant indexing application must index the time period range(s) for which data are present in the Dataset. The validity period of the Metadatasets may also be indexed.
263 +|indexReportingPeriod|A compliant indexing application must index the time period range(s) for which data are present in the Dataset. The validity period of the Metadatasets may also be indexed.
262 262  
263 263  === {{id name="_Toc93850"/}}5.2.5 Data and Reference Metadata Discovery ===
264 264  
... ... @@ -280,7 +280,7 @@
280 280  Subscription management involves a user submitting a subscription request which contains:
281 281  
282 282  * 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).
283 -* 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);
285 +* 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);
284 284  * request for a list of submitted subscriptions;
285 285  * deletion of a subscription;
286 286  
... ... @@ -292,9 +292,8 @@
292 292  
293 293  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.
294 294  
295 -(% style="width:757.294px" %)
296 -|(% style="width:188px" %)**Interface**|(% style="width:542px" %)**Behaviour**
297 -|(% style="width:188px" %)All|(% style="width:542px" %)(((
297 +|**Interface**|**Behaviour**
298 +|All|(((
298 298  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.
299 299  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.
300 300  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:
... ... @@ -301,13 +301,14 @@
301 301  
302 302  a) Be a draft version.
303 303  )))
304 -|(% style="width:188px" %)**Interface**|(% style="width:542px" %)**Behaviour**
305 -|(% style="width:188px" %) |(% style="width:542px" %)(((
306 -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.4-draft does not break integrity of the aforementioned DSD.{{/footnote}} referenced from any other object in the Registry.
305 +|**Interface**|**Behaviour**
306 +| |(((
307 +b) Not be explicitly^^[[(% class="wikiinternallink wikiinternallink" %)^^1^^>>path:#sdfootnote1sym||name="sdfootnote1anc"]](%%)^^ referenced from any other object in the Registry.
308 +
307 307  4) The semantic versioning rules in the SDMX documentation MUST be obeyed.
308 308  )))
309 -|(% style="width:188px" %)Structure submission|(% style="width:542px" %)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.
310 -|(% style="width:188px" %)SubmitRegistrationRequest|(% style="width:542px" %)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.
311 +|Structure submission|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.
312 +|SubmitRegistrationRequest|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.
311 311  
312 312  = {{id name="_Toc93853"/}}6 Identification of SDMX Objects =
313 313  
... ... @@ -328,42 +328,43 @@
328 328  
329 329  The table below shows the identification and related data attributes to be stored in a registry for objects that are one of:
330 330  
331 -* //nnotable//
333 +* //Annotable//
332 332  * //Identifiable//
333 333  * //Nameable//
334 334  * //Versionable//
335 335  * //Maintainable//
336 336  
339 +:
340 +
337 337  (((
338 -(% style="width:1052.29px" %)
339 -|**Object Type**|(% style="width:241px" %)**Data Attributes**|(% style="width:156px" %)**Status**|**Data type**|(% style="width:457px" %)**Notes**
340 -|(% rowspan="4" %)//Annotable//|(% style="width:241px" %)AnnotationTitle|(% style="width:156px" %)C|string|(% style="width:457px" %)
341 -|(% style="width:241px" %)AnnotationType|(% style="width:156px" %)C|string|(% style="width:457px" %)
342 -|(% style="width:241px" %)AnnotationURN|(% style="width:156px" %)C|string|(% style="width:457px" %)
343 -|(% style="width:241px" %)AnnotationText in the form of InternationalString|(% style="width:156px" %)C| |(% style="width:457px" %)This can have languagespecific variants
344 -|(% rowspan="4" %)//Identifiable//|(% style="width:241px" %)All content as for //Annotable// plus|(% style="width:156px" %) | |(% style="width:457px" %)
345 -|(% style="width:241px" %)id|(% style="width:156px" %)M|string|(% style="width:457px" %)
346 -|(% style="width:241px" %)uri|(% style="width:156px" %)C|string|(% style="width:457px" %)
347 -|(% style="width:241px" %)urn|(% style="width:156px" %)C|string|(% style="width:457px" %)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.
348 -|(% rowspan="3" %)//Nameable//|(% style="width:241px" %)All content as for //Identifiable// plus|(% style="width:156px" %) | |(% style="width:457px" %)
349 -|(% style="width:241px" %)Name in the form of InternationalString|(% style="width:156px" %)M|string|(% style="width:457px" %)This can have language specific variants.
350 -|(% style="width:241px" %)Description in the form of InternationalString|(% style="width:156px" %)C|string|(% style="width:457px" %)This can have language specific variants.
351 -|(% rowspan="4" %)//Versionable//|(% style="width:241px" %)All content as for //Identifiable// plus|(% style="width:156px" %) | |(% style="width:457px" %)
352 -|(% style="width:241px" %)version|(% style="width:156px" %)M|string|(% style="width:457px" %)This is the version number according to SDMX versioning rules.
353 -|(% style="width:241px" %)validFrom|(% style="width:156px" %)C|Date/time|(% style="width:457px" %)
354 -|(% style="width:241px" %)validTo|(% style="width:156px" %)C|Date/time|(% style="width:457px" %)
355 -|//Maintainable//|(% style="width:241px" %)All content as for //Versionable// plus|(% style="width:156px" %) | |(% style="width:457px" %)
356 -| |(% style="width:241px" %)isExternalReference|(% style="width:156px" %)C|boolean|(% style="width:457px" %)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.
357 -| |(% style="width:241px" %)serviceURL|(% style="width:156px" %)C|string|(% style="width:457px" %)The url of the service that can be queried for this resource.
358 -| |(% style="width:241px" %)structureURL|(% style="width:156px" %)C|string|(% style="width:457px" %)The url of the resource.
359 -| |(% style="width:241px" %)(Maintenance) organisationId|(% style="width:156px" %)M|string|(% style="width:457px" %)The object must be linked to a maintenance organisation, i.e., Agency or Metadata Provider.
342 +|**Object Type**|**Data Attributes**|**Status**|**Data type**|**Notes**
343 +|(% rowspan="4" %)//Annotable//|AnnotationTitle|C|string|
344 +|AnnotationType|C|string|
345 +|AnnotationURN|C|string|
346 +|AnnotationText in the form of InternationalString|C| |This can have languagespecific variants
347 +|(% rowspan="4" %)//Identifiable//|All content as for //Annotable// plus| | |
348 +|id|M|string|
349 +|uri|C|string|
350 +|urn|C|string|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.
351 +|(% rowspan="3" %)//Nameable//|All content as for //Identifiable// plus| | |
352 +|Name in the form of InternationalString|M|string|This can have language specific variants.
353 +|Description in the form of InternationalString|C|string|This can have language specific variants.
354 +|(% rowspan="4" %)//Versionable//|All content as for //Identifiable// plus| | |
355 +|version|M|string|This is the version number according to SDMX versioning rules.
356 +|validFrom|C|Date/time|
357 +|validTo|C|Date/time|
358 +|//Maintainable//|All content as for //Versionable// plus| | |
359 +| |isExternalReference|C|boolean|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.
360 +| |serviceURL|C|string|The url of the service that can be queried for this resource.
361 +| |structureURL|C|string|The url of the resource.
362 +| |(Maintenance) organisationId|M|string|The object must be linked to a maintenance organisation, i.e., Agency or Metadata Provider.
360 360  )))
361 361  
362 362  **Table 1: Common Attributes of Object Types**
363 363  
364 -== {{id name="_Toc93856"/}}6.2 Unique identification of SDMX objects ==
367 +=== {{id name="_Toc93856"/}}6.2 Unique identification of SDMX objects ===
365 365  
366 -=== {{id name="_Toc93857"/}}6.2.1 Agencies and Metadata Providers ===
369 +===== {{id name="_Toc93857"/}}6.2.1 Agencies and Metadata Providers =====
367 367  
368 368  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.
369 369  
... ... @@ -405,8 +405,32 @@
405 405  
406 406  An example of this is shown in the XML snippet below:
407 407  
408 -[[image:1747307906944-697.png]]
411 +**<str:Codelists>**
409 409  
413 +**<str:Codelist id="CL_FREQ" agencyID="SDMX" version="1.0.0">**
414 +
415 +**<com:Name xml:lang="en">Standard frequency Codelist</com:Name>**
416 +
417 +**</str:Codelist>**
418 +
419 +**<str:Codelist id="CL_FREQ" agencyID="AA" version="1.0.0">**
420 +
421 +**<com:Name xml:lang="en">Codelist maintained by agency AA</com:Name>**
422 +
423 +**</str:Codelist>**
424 +
425 +**<str:Codelist id="CL_FREQ" agencyID="AA.CC" version="1.0.0">**
426 +
427 +**<com:Name xml:lang="en">Codelist maintained by the AA unit CC</com:Name>**
428 +
429 +**</str:Codelist>**
430 +
431 +**<str:Codelist id="CL_FREQ" agencyID="BB.CC" version="1.0.0">**
432 +
433 +**<com:Name xml:lang="en">Codelist maintained by the BB unit CC</com:Name>**
434 +
435 +**</str:Codelist>**
436 +
410 410  **Figure 8: Example Showing Use of Agency Identifiers**
411 411  
412 412  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.
... ... @@ -413,16 +413,14 @@
413 413  
414 414  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.
415 415  
416 -=== {{id name="_Toc93858"/}}6.2.2 Universal Resource Name (URN) ===
443 +===== {{id name="_Toc93858"/}}6.2.2 Universal Resource Name (URN) =====
417 417  
418 -==== 6.2.2.1 Introduction ====
445 +**6.2.2.1 Introduction**
419 419  
420 420  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.).
421 421  
422 -==== 6.2.2.2 URN Structure ====
449 +**6.2.2.2 URN Structure //__Case Rules for URN__//**//&nbsp;//
423 423  
424 -===== **//__Case Rules for URN__//** =====
425 -
426 426  For the URN, all parts of the string are case sensitive. The generic structure of the URN is as follows:
427 427  
428 428  SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobjectid(maintainedobject-version).*containerobject-id.object-id
... ... @@ -433,7 +433,7 @@
433 433  
434 434  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.
435 435  
436 -==== 6.2.2.3 Explanation of the generic structure ====
461 +**6.2.2.3 Explanation of the generic structure**
437 437  
438 438  In the explanation below the actual object that is the target of the URN is called the **actual object**.
439 439  
... ... @@ -443,32 +443,10 @@
443 443  
444 444  The packages are:
445 445  
446 -base
471 +base codelist conceptscheme datastructure categoryscheme registry metadatastructure process structuremapping transformation
447 447  
448 -codelist
473 +**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. **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. **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.
449 449  
450 -conceptscheme
451 -
452 -datastructure
453 -
454 -categoryscheme
455 -
456 -registry
457 -
458 -metadatastructure
459 -
460 -process
461 -
462 -structuremapping
463 -
464 -transformation
465 -
466 -**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.
467 -
468 -**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.
469 -
470 -**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.
471 -
472 472  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.
473 473  
474 474  For example, the sequence is agency:DSDid(version).DimensionId and not agency:DSDid(version).DimensionDescriptorId.DimensionId.
... ... @@ -475,7 +475,7 @@
475 475  
476 476  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.
477 477  
478 -===== //__**Generic Examples of the URN Structure**__// =====
481 +//__**Generic Examples of the URN Structure**__//
479 479  
480 480  __Actual object is a maintainable__
481 481  
... ... @@ -501,7 +501,7 @@
501 501  
502 502  SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version).contained-object-id.contained-object-id contained-objectid.object-id
503 503  
504 -===== //__**Concrete Examples of the URN Structure**__// =====
507 +//__**Concrete Examples of the URN Structure**__//
505 505  
506 506  The Data Structure Definition CRED_EXT_DEBT of legacy version 2.1 maintained by the toplevel Agency TFFS would have the URN:
507 507  
... ... @@ -530,86 +530,85 @@
530 530  
531 531  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.
532 532  
533 -=== {{id name="_Toc93859"/}}6.2.3 Table of SDMX-IM Packages and Classes ===
536 +===== {{id name="_Toc93859"/}}6.2.3 Table of SDMX-IM Packages and Classes =====
534 534  
535 535  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.
536 536  
537 -(% style="width:651.294px" %)
538 -|(% style="width:134px" %)**Package**|(% style="width:502px" %)**URN class name (model class name where this is different)**
539 -|(% style="width:134px" %)base|(% style="width:502px" %)Agency
540 -|(% style="width:134px" %) |(% style="width:502px" %)AgencyScheme
541 -|(% style="width:134px" %) |(% style="width:502px" %)DataConsumer
542 -|(% style="width:134px" %) |(% style="width:502px" %)DataConsumerScheme
543 -|(% style="width:134px" %) |(% style="width:502px" %)DataProvider
544 -|(% style="width:134px" %) |(% style="width:502px" %)DataProviderScheme
545 -|(% style="width:134px" %) |(% style="width:502px" %)MetadataProvider
546 -|(% style="width:134px" %) |(% style="width:502px" %)MetadataProviderScheme
547 -|(% style="width:134px" %) |(% style="width:502px" %)OrganisationUnit
548 -|(% style="width:134px" %) |(% style="width:502px" %)OrganisationUnitScheme
549 -|(% style="width:134px" %)datastructure|(% style="width:502px" %)AttributeDescriptor
550 -|(% style="width:134px" %) |(% style="width:502px" %)DataAttribute
551 -|(% style="width:134px" %) |(% style="width:502px" %)Dataflow
552 -|(% style="width:134px" %) |(% style="width:502px" %)DataStructure (DataStructureDefinition)
553 -|(% style="width:134px" %) |(% style="width:502px" %)Dimension
554 -|(% style="width:134px" %) |(% style="width:502px" %)DimensionDescriptor
555 -|(% style="width:134px" %) |(% style="width:502px" %)GroupDimensionDescriptor
556 -|(% style="width:134px" %) |(% style="width:502px" %)Measure
557 -|(% style="width:134px" %) |(% style="width:502px" %)MeasureDescriptor
558 -|(% style="width:134px" %) |(% style="width:502px" %)TimeDimension
559 -|(% style="width:134px" %) |(% style="width:502px" %)
560 -|(% style="width:134px" %)metadatastructure|(% style="width:502px" %)MetadataAttribute
561 -|(% style="width:134px" %) |(% style="width:502px" %)MetadataAttributeDescriptor
562 -|(% style="width:134px" %) |(% style="width:502px" %)MetadataStructure MetadataStructureDefinition)
563 -|(% style="width:134px" %) |(% style="width:502px" %)Metadataflow
564 -|(% style="width:134px" %) |(% style="width:502px" %)MetadataSet
565 -|(% style="width:134px" %) |(% style="width:502px" %)
566 -|(% style="width:134px" %)process|(% style="width:502px" %)Process
567 -|(% style="width:134px" %) |(% style="width:502px" %)ProcessStep
568 -|(% style="width:134px" %) |(% style="width:502px" %)Transition
569 -|(% style="width:134px" %) |(% style="width:502px" %)
570 -|(% style="width:134px" %)registry|(% style="width:502px" %)DataConstraint
571 -|(% style="width:134px" %) |(% style="width:502px" %)MetadataConstraint
572 -|(% style="width:134px" %) |(% style="width:502px" %)MetadataProvisionAgreement
573 -|(% style="width:134px" %) |(% style="width:502px" %)ProvisionAgreement
574 -|(% style="width:134px" %) |(% style="width:502px" %)Subscription
575 -|(% style="width:134px" %) |(% style="width:502px" %)
576 -|(% style="width:134px" %)structuremapping|(% style="width:502px" %)CategorySchemeMap
577 -|(% style="width:134px" %) |(% style="width:502px" %)ConceptSchemeMap
578 -|(% style="width:134px" %) |(% style="width:502px" %)OrganisationSchemeMap
579 -|(% style="width:134px" %) |(% style="width:502px" %)ReportingTaxonomyMap
580 -|(% style="width:134px" %) |(% style="width:502px" %)RepresentationMap
581 -|(% style="width:134px" %) |(% style="width:502px" %)StructureMap
582 -|(% style="width:134px" %) |(% style="width:502px" %)
583 -|(% style="width:134px" %)codelist|(% style="width:502px" %)Code
584 -|(% style="width:134px" %) |(% style="width:502px" %)Codelist
585 -|(% style="width:134px" %) |(% style="width:502px" %)HierarchicalCode
586 -|(% style="width:134px" %) |(% style="width:502px" %)Hierarchy
587 -|(% style="width:134px" %) |(% style="width:502px" %)HierarchyAssociation
588 -|(% style="width:134px" %) |(% style="width:502px" %)Level
589 -|(% style="width:134px" %) |(% style="width:502px" %)ValueList
590 -|(% style="width:134px" %) |(% style="width:502px" %)
591 -|(% style="width:134px" %)categoryscheme|(% style="width:502px" %)Categorisation
592 -|(% style="width:134px" %) |(% style="width:502px" %)Category
593 -|(% style="width:134px" %) |(% style="width:502px" %)CategoryScheme
594 -|(% style="width:134px" %) |(% style="width:502px" %)ReportingCategory
595 -|(% style="width:134px" %) |(% style="width:502px" %)ReportingTaxonomy
596 -|(% style="width:134px" %)conceptscheme|(% style="width:502px" %)Concept
597 -|(% style="width:134px" %) |(% style="width:502px" %)ConceptScheme
598 -|(% style="width:134px" %) |(% style="width:502px" %)
599 -|(% style="width:134px" %)transformation|(% style="width:502px" %)CustomType
600 -|(% style="width:134px" %) |(% style="width:502px" %)CustomTypeScheme
601 -|(% style="width:134px" %) |(% style="width:502px" %)NamePersonalisation
602 -|(% style="width:134px" %) |(% style="width:502px" %)NamePersonalisationScheme
603 -|(% style="width:134px" %) |(% style="width:502px" %)Ruleset
604 -|(% style="width:134px" %) |(% style="width:502px" %)RulesetScheme
605 -|(% style="width:134px" %) |(% style="width:502px" %)Transformation
606 -|(% style="width:134px" %) |(% style="width:502px" %)TransformationScheme
607 -|(% style="width:134px" %) |(% style="width:502px" %)UserDefinedOperator
608 -|(% style="width:134px" %) |(% style="width:502px" %)UserDefinedOperatorScheme
609 -|(% style="width:134px" %) |(% style="width:502px" %)VtlCodelistMapping
610 -|(% style="width:134px" %) |(% style="width:502px" %)VtlConceptMapping
611 -|(% style="width:134px" %) |(% style="width:502px" %)VtlDataflowMapping
612 -|(% style="width:134px" %) |(% style="width:502px" %)VtlMappingScheme
540 +|**Package**|**URN class name (model class name where this is different)**
541 +|base|Agency
542 +| |AgencyScheme
543 +| |DataConsumer
544 +| |DataConsumerScheme
545 +| |DataProvider
546 +| |DataProviderScheme
547 +| |MetadataProvider
548 +| |MetadataProviderScheme
549 +| |OrganisationUnit
550 +| |OrganisationUnitScheme
551 +|datastructure|AttributeDescriptor
552 +| |DataAttribute
553 +| |Dataflow
554 +| |DataStructure (DataStructureDefinition)
555 +| |Dimension
556 +| |DimensionDescriptor
557 +| |GroupDimensionDescriptor
558 +| |Measure
559 +| |MeasureDescriptor
560 +| |TimeDimension
561 +| |
562 +|metadatastructure|MetadataAttribute
563 +| |MetadataAttributeDescriptor
564 +| |MetadataStructure MetadataStructureDefinition)
565 +| |Metadataflow
566 +| |MetadataSet
567 +| |
568 +|process|Process
569 +| |ProcessStep
570 +| |Transition
571 +| |
572 +|registry|DataConstraint
573 +| |MetadataConstraint
574 +| |MetadataProvisionAgreement
575 +| |ProvisionAgreement
576 +| |Subscription
577 +| |
578 +|structuremapping|CategorySchemeMap
579 +| |ConceptSchemeMap
580 +| |OrganisationSchemeMap
581 +| |ReportingTaxonomyMap
582 +| |RepresentationMap
583 +| |StructureMap
584 +| |
585 +|codelist|Code
586 +| |Codelist
587 +| |HierarchicalCode
588 +| |Hierarchy
589 +| |HierarchyAssociation
590 +| |Level
591 +| |ValueList
592 +| |
593 +|categoryscheme|Categorisation
594 +| |Category
595 +| |CategoryScheme
596 +| |ReportingCategory
597 +| |ReportingTaxonomy
598 +|conceptscheme|Concept
599 +| |ConceptScheme
600 +| |
601 +|transformation|CustomType
602 +| |CustomTypeScheme
603 +| |NamePersonalisation
604 +| |NamePersonalisationScheme
605 +| |Ruleset
606 +| |RulesetScheme
607 +| |Transformation
608 +| |TransformationScheme
609 +| |UserDefinedOperator
610 +| |UserDefinedOperatorScheme
611 +| |VtlCodelistMapping
612 +| |VtlConceptMapping
613 +| |VtlDataflowMapping
614 +| |VtlMappingScheme
613 613  
614 614  **Table 2: SDMX-IM Packages and Contained Classes**
615 615  
... ... @@ -621,118 +621,136 @@
621 621  
622 622  urn:sdmx.org.sdmx.infomodel.{package}.{classname}=
623 623  
624 -(% style="width:1311.29px" %)
625 -|(% style="width:252px" %)**Classname**|(% style="width:639px" %)**Ending URN pattern**|(% style="width:418px" %)**Example**
626 -|(% style="width:252px" %)Agency{{footnote}}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: IMF.SubAgency1{{/footnote}}|(% style="width:639px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|(% style="width:418px" %)ECB:**AGENCIES**(**1.0**).AA
627 -|(% style="width:252px" %)//AgencyScheme//|(% style="width:639px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**)|(% style="width:418px" %)ECB:**AGENCIES**(**1.0**)
628 -|(% style="width:252px" %)//Categorisation//|(% style="width:639px" %)categorisationAgencyId:categorisationId(version)|(% style="width:418px" %)IMF:cat001(1.0.0)
629 -|(% style="width:252px" %)Category|(% style="width:639px" %)categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|(% style="width:418px" %)IMF:SDDS(1.0.0):level_1_category.level_2_category …
630 -|(% style="width:252px" %)//CategoryScheme//|(% style="width:639px" %)categorySchemeAgencyId:categorySchemeId(versi on)|(% style="width:418px" %)IMF:SDDS(1.0.0)
626 +|**Classname**|**Ending URN pattern**|**Example**
627 +|Agency^^[[(% class="wikiinternallink wikiinternallink" %)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^|agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|ECB:**AGENCIES**(**1.0**).AA
628 +|//AgencyScheme//|agencySchemeAgencyId:**AGENCIES**(**1.0**)|ECB:**AGENCIES**(**1.0**)
629 +|//Categorisation//|categorisationAgencyId:categorisationId(version)|IMF:cat001(1.0.0)
630 +|Category|categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|IMF:SDDS(1.0.0):level_1_category.level_2_category …
631 +|//CategoryScheme//|categorySchemeAgencyId:categorySchemeId(versi on)|IMF:SDDS(1.0.0)
631 631  
632 -|(% style="width:250px" %)**Classname**|(% style="width:639px" %)**Ending URN pattern**|(% style="width:1049px" %)**Example**
633 -|(% style="width:250px" %)//CategorySchemeMap//|(% style="width:639px" %)(((
634 -catSchemeMapAgencyId:catSchemeMapId(version)
635 -)))|(% style="width:1049px" %)SDMX:EUROSTAT_SUBJECT_DOMAIN(1.0.0)
636 -|(% style="width:250px" %)Code|(% style="width:639px" %)codeListAgencyId:codelistId(version).codeId|(% style="width:1049px" %)SDMX:CL_FREQ(1.0.0).Q
637 -|(% style="width:250px" %)//Codelist//|(% style="width:639px" %)codeListAgencyId:codeListId(version)|(% style="width:1049px" %)SDMX:CL_FREQ(1.0.0)
638 -|(% style="width:250px" %)ComponentMap|(% style="width:639px" %)structureMapAgencyId:structureMap(version).com ponentMapId|(% style="width:1049px" %)SDMX:BOP_STRUCTURES(1.0.0).REF_AREA_TO_COUNT RY
639 -|(% style="width:250px" %)Concept|(% style="width:639px" %)conceptSchemeAgencyId:conceptSchemeId(versio n).conceptId|(% style="width:1049px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0).FREQ
640 -|(% style="width:250px" %)//ConceptScheme//|(% style="width:639px" %)conceptSchemeAgencyId:conceptSchemeId(versio n)|(% style="width:1049px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0)
641 -|(% style="width:250px" %)//ConceptSchemeMap//|(% style="width:639px" %)(((
633 +|**Classname**|**Ending URN pattern**|**Example**
634 +|//CategorySchemeMap//|(((
635 +catSchemeMapAgencyId:catSchemeMapId(version
636 +
637 +)
638 +)))|SDMX:EUROSTAT_SUBJECT_DOMAIN(1.0.0)
639 +|Code|codeListAgencyId:codelistId(version).codeId|SDMX:CL_FREQ(1.0.0).Q
640 +|//Codelist//|codeListAgencyId:codeListId(version)|SDMX:CL_FREQ(1.0.0)
641 +|ComponentMap|structureMapAgencyId:structureMap(version).com ponentMapId|SDMX:BOP_STRUCTURES(1.0.0).REF_AREA_TO_COUNT RY
642 +|Concept|conceptSchemeAgencyId:conceptSchemeId(versio n).conceptId|SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0).FREQ
643 +|//ConceptScheme//|conceptSchemeAgencyId:conceptSchemeId(versio n)|SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0)
644 +|//ConceptSchemeMap//|(((
642 642  conceptSchemeMapAgencyId:conceptSchemeMap
646 +
643 643  Id(version)
644 -)))|(% style="width:1049px" %)SDMX:CONCEPT_MAP(1.0.0)
645 -|(% style="width:250px" %)CustomType|(% style="width:639px" %)customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|(% style="width:1049px" %)ECB: CUSTOM_TYPE_SCHEME(1.0.0).CUSTOM_TYPE_1
646 -|(% style="width:250px" %)//CustomTypeScheme//|(% style="width:639px" %)customTypeSchemeAgencyId customTypeSchemeId(version)|(% style="width:1049px" %)ECB:CUSTOM_TYPE_SCHEME(1.0.0)
647 -|(% style="width:250px" %)DataAttrribute|(% style="width:639px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dataAttributeId|(% style="width:1049px" %)TFFS:EXT_DEBT(1.0.0).OBS_STATUS
648 -|(% style="width:250px" %)//DataConstraint//|(% style="width:639px" %)dataConstraintAgencyId:dataConstraintId(version)|(% style="width:1049px" %)TFFS:CREDITOR_DATA_CONTENT(1.0.0)
648 +)))|SDMX:CONCEPT_MAP(1.0.0)
649 +|CustomType|customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|ECB: CUSTOM_TYPE_SCHEME(1.0.0).CUSTOM_TYPE_1
650 +|//CustomTypeScheme//|customTypeSchemeAgencyId customTypeSchemeId(version)|ECB:CUSTOM_TYPE_SCHEME(1.0.0)
651 +|DataAttrribute|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dataAttributeId|TFFS:EXT_DEBT(1.0.0).OBS_STATUS
652 +|//DataConstraint//|dataConstraintAgencyId:dataConstraintId(version)|TFFS:CREDITOR_DATA_CONTENT(1.0.0)
649 649  
650 -|(% style="width:248px" %)**Classname**|(% style="width:643px" %)**Ending URN pattern**|(% style="width:1047px" %)**Example**
651 -|(% style="width:248px" %)DataConsumer|(% style="width:643px" %)dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**).dataConsumerId|(% style="width:1047px" %)SDMX:**DATA_CONSUMERS**(**1.0**).CONSUMER_1
652 -|(% style="width:248px" %)//DataConsumerScheme//|(% style="width:643px" %)(((
653 -dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**)
654 -)))|(% style="width:1047px" %)SDMX:**DATA_CONSUMERS**(**1.0**)
655 -|(% style="width:248px" %)//Dataflow//|(% style="width:643px" %)dataflowAgencyId:dataflowId(version)|(% style="width:1047px" %)TFFS:CRED_EXT_DEBT(1.0.0)
656 -|(% style="width:248px" %)DataProvider|(% style="width:643px" %)(((
657 -dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**).dataProviderId
658 -)))|(% style="width:1047px" %)SDMX:**DATA_PROVIDERS**(**1.0**).PROVIDER_1
659 -|(% style="width:248px" %)//DataProviderScheme//|(% style="width:643px" %)(((
660 -dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**)
661 -)))|(% style="width:1047px" %)SDMX:**DATA_PROVIDERS**(**1.0**)
662 -|(% style="width:248px" %)//DataStructure//|(% style="width:643px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version)|(% style="width:1047px" %)TFFS:EXT_DEBT(1.0.0)
663 -|(% style="width:248px" %)Dimension|(% style="width:643px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dimensionId|(% style="width:1047px" %)TFFS:EXT_DEBT(1.0.0).FREQ
664 -|(% style="width:248px" %)(((
654 +|**Classname**|**Ending URN pattern**|**Example**
655 +|DataConsumer|dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**).dataConsumerId|SDMX:**DATA_CONSUMERS**(**1.0**).CONSUMER_1
656 +|//DataConsumerScheme//|(((
657 +dataConsumerSchemeAgencyId:**DATA_CONSUME**
658 +
659 +**RS**(**1.0**)
660 +)))|SDMX:**DATA_CONSUMERS**(**1.0**)
661 +|//Dataflow//|dataflowAgencyId:dataflowId(version)|TFFS:CRED_EXT_DEBT(1.0.0)
662 +|DataProvider|(((
663 +dataProviderSchemeAgencyId:**DATA_PROVIDERS**(
664 +
665 +**1.0**).dataProviderId
666 +)))|SDMX:**DATA_PROVIDERS**(**1.0**).PROVIDER_1
667 +|//DataProviderScheme//|(((
668 +dataProviderSchemeAgencyId:**DATA_PROVIDERS**(
669 +
670 +**1.0**)
671 +)))|SDMX:**DATA_PROVIDERS**(**1.0**)
672 +|//DataStructure//|dataStructureDefinitionAgencyId:dataStructureDef initionId(version)|TFFS:EXT_DEBT(1.0.0)
673 +|Dimension|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dimensionId|TFFS:EXT_DEBT(1.0.0).FREQ
674 +|(((
665 665  DimensionDescriptor
676 +
666 666  MeasureDescriptor
678 +
667 667  AttributeDescriptor
668 -)))|(% style="width:643px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).componentListId where the componentListId is the name of the class (there is only one occurrence of each in the Data Structure Definition)|(% style="width:1047px" %)(((
680 +)))|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).componentListId where the componentListId is the name of the class (there is only one occurrence of each in the Data Structure Definition)|(((
669 669  TFFS:EXT_DEBT(1.0.0).DimensionDescriptor
682 +
670 670  TFFS:EXT_DEBT(1.0.0).MeasureDescriptor
684 +
671 671  TFFS:EXT_DEBT(1.0.0).AttributeDescriptor
672 672  )))
673 -|(% style="width:248px" %)GroupDimensionDescriptor|(% style="width:643px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).groupDimensionDescriptorId|(% style="width:1047px" %)TFFS:EXT_DEBT(1.0.0).SIBLING
674 -|(% style="width:248px" %)HierarchicalCode|(% style="width:643px" %)hierarchyAgencyId:hierarchyId(version).hierarchica lCode.hierarchicalCode|(% style="width:1047px" %)UNESCO:H-C-GOV(1.0.0).GOV_CODE1.GOV_CODE1_1
687 +|GroupDimensionDescriptor|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).groupDimensionDescriptorId|TFFS:EXT_DEBT(1.0.0).SIBLING
688 +|HierarchicalCode|hierarchyAgencyId:hierarchyId(version).hierarchica lCode.hierarchicalCode|UNESCO:H-C-GOV(1.0.0).GOV_CODE1.GOV_CODE1_1
675 675  
676 -|(% style="width:248px" %)**Classname**|(% style="width:646px" %)**Ending URN pattern**|(% style="width:1044px" %)**Example**
677 -|(% style="width:248px" %)//Hierarchy//|(% style="width:646px" %)hierarchyAgencyId:hierarchyId(version)|(% style="width:1044px" %)UNESCO:H-C-GOV(1.0.0)
678 -|(% style="width:248px" %)//HierarchyAssociation//|(% style="width:646px" %)hierarchyAssociationAgencyId:hierarchyAssociatio nId(version)|(% style="width:1044px" %)UNESCO:CL_EXP_SOURCE(1.0.0)
679 -|(% style="width:248px" %)Level|(% style="width:646px" %)hierarchyAgencyId:hierarchyId(version).level|(% style="width:1044px" %)UNESCO:H-C-GOV(1.0.0).LVL1
680 -|(% style="width:248px" %)Measure|(% style="width:646px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).measureId|(% style="width:1044px" %)TFFS:EXT_DEBT(1.0.0).OBS_VALUE
681 -|(% style="width:248px" %)MetadataAttribute|(% style="width:646px" %)(((
690 +|**Classname**|**Ending URN pattern**|**Example**
691 +|//Hierarchy//|hierarchyAgencyId:hierarchyId(version)|UNESCO:H-C-GOV(1.0.0)
692 +|//HierarchyAssociation//|hierarchyAssociationAgencyId:hierarchyAssociatio nId(version)|UNESCO:CL_EXP_SOURCE(1.0.0)
693 +|Level|hierarchyAgencyId:hierarchyId(version).level|UNESCO:H-C-GOV(1.0.0).LVL1
694 +|Measure|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).measureId|TFFS:EXT_DEBT(1.0.0).OBS_VALUE
695 +|MetadataAttribute|(((
682 682  msdAgencyId:msdId(version).metadataAttributeId.
697 +
683 683  metadataAttributeId
684 -)))|(% style="width:1044px" %)IMF:SDDS_MSD(1.0.0).COMPILATION.METHOD
685 -|(% style="width:248px" %)MetadataAttributeDescriptor|(% style="width:646px" %)msdAgencyId:msdId(version).metadataAttributeDe scriptorId|(% style="width:1044px" %)IMF:SDDS_MSD(1.0.0).MetadataAttributeDescriptor
686 -|(% style="width:248px" %)//MetadataConstraint//|(% style="width:646px" %)metadataConstraintAgencyId:metadataConstraintI d(version)|(% style="width:1044px" %)TFFS:CREDITOR_METADATA_CONTENT(1.0.0)
687 -|(% style="width:248px" %)//Metadataflow//|(% style="width:646px" %)metadataflowAgencyId:metadataflowId(version)|(% style="width:1044px" %)IMF:SDDS_MDF(1.0.0)
688 -|(% style="width:248px" %)MetadataProvider|(% style="width:646px" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**).metadataProviderId|(% style="width:1044px" %)SDMX:**METADATA_PROVIDERS**(**1.0**).MD_PROVIDER_1
689 -|(% style="width:248px" %)//MetadataProviderScheme//|(% style="width:646px" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**)|(% style="width:1044px" %)SDMX:**METADATA_PROVIDERS**(**1.0**)
690 -|(% style="width:248px" %)//MetadataProvisionAgreement//|(% style="width:646px" %)metadataProvisionAgreementAgencyId:metadataP rovisionAgreementId(version)|(% style="width:1044px" %)IMF:SDDS_MDF_AB(1.0.0)
691 -|(% style="width:248px" %)//MetadataSet//|(% style="width:646px" %)metadataProviderId:metadataSetId(version)|(% style="width:1044px" %)MD_PROVIDER:METADATASET(1.0.0)
692 -|(% style="width:248px" %)//MetadataStructure//|(% style="width:646px" %)msdAgencyId:msdId(version)|(% style="width:1044px" %)IMF:SDDS_MSD(1.0.0)
699 +)))|IMF:SDDS_MSD(1.0.0).COMPILATION.METHOD
700 +|MetadataAttributeDescriptor|msdAgencyId:msdId(version).metadataAttributeDe scriptorId|IMF:SDDS_MSD(1.0.0).MetadataAttributeDescriptor
701 +|//MetadataConstraint//|metadataConstraintAgencyId:metadataConstraintI d(version)|TFFS:CREDITOR_METADATA_CONTENT(1.0.0)
702 +|//Metadataflow//|metadataflowAgencyId:metadataflowId(version)|IMF:SDDS_MDF(1.0.0)
703 +|MetadataProvider|metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**).metadataProviderId|SDMX:**METADATA_PROVIDERS**(**1.0**).MD_PROVIDER_1
704 +|//MetadataProviderScheme//|metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**)|SDMX:**METADATA_PROVIDERS**(**1.0**)
705 +|//MetadataProvisionAgreement//|metadataProvisionAgreementAgencyId:metadataP rovisionAgreementId(version)|IMF:SDDS_MDF_AB(1.0.0)
706 +|//MetadataSet//|metadataProviderId:metadataSetId(version)|MD_PROVIDER:METADATASET(1.0.0)
707 +|//MetadataStructure//|msdAgencyId:msdId(version)|IMF:SDDS_MSD(1.0.0)
693 693  
694 -|(% style="width:248px" %)**Classname**|(% style="width:629px" %)**Ending URN pattern**|(% style="width:1061px" %)**Example**
695 -|(% style="width:248px" %)NamePersonalisation|(% style="width:629px" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|(% style="width:1061px" %)ECB:PSN_SCHEME(1.0.0).PSN1234
696 -|(% style="width:248px" %)//NamePersonalisationScheme//|(% style="width:629px" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|(% style="width:1061px" %)ECB:PSN_SCHEME(1.0.0)
697 -|(% style="width:248px" %)//OrganisationSchemeMap//|(% style="width:629px" %)orgSchemeMapAgencyId:orgSchemeMapId(versio n)|(% style="width:1061px" %)SDMX:AGENCIES_PROVIDERS(1.0.0)
698 -|(% style="width:248px" %)OrganisationUnit|(% style="width:629px" %)organisationUnitSchemeAgencyId:organisationUnitSchemeId(version).organisationUnitId|(% style="width:1061px" %)ECB:ORGANISATIONS(1.0.0).1F
699 -|(% style="width:248px" %)//OrganisationUnitScheme//|(% style="width:629px" %)organisationUnitSchemeAgencyId:organisationUni tSchemeId(version)|(% style="width:1061px" %)ECB:ORGANISATIONS(1.0.0)
700 -|(% style="width:248px" %)//Process//|(% style="width:629px" %)processAgencyId:processId{version)|(% style="width:1061px" %)BIS:PROCESS1(1.0.0)
701 -|(% style="width:248px" %)ProcessStep|(% style="width:629px" %)(((
709 +|**Classname**|**Ending URN pattern**|**Example**
710 +|NamePersonalisation|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|ECB:PSN_SCHEME(1.0.0).PSN1234
711 +|//NamePersonalisationScheme//|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|ECB:PSN_SCHEME(1.0.0)
712 +|//OrganisationSchemeMap//|orgSchemeMapAgencyId:orgSchemeMapId(versio n)|SDMX:AGENCIES_PROVIDERS(1.0.0)
713 +|OrganisationUnit|organisationUnitSchemeAgencyId:organisationUni tSchemeId(version).organisationUnitId|ECB:ORGANISATIONS(1.0.0).1F
714 +|//OrganisationUnitScheme//|organisationUnitSchemeAgencyId:organisationUni tSchemeId(version)|ECB:ORGANISATIONS(1.0.0)
715 +|//Process//|processAgencyId:processId{version)|BIS:PROCESS1(1.0.0)
716 +|ProcessStep|(((
702 702  processAgencyId:processId(version).processStepId.
718 +
703 703  processStepId
704 -)))|(% style="width:1061px" %)BIS:PROCESS1(1.0.0).STEP1.STEP1_1
705 -|(% style="width:248px" %)//ProvisionAgreement//|(% style="width:629px" %)provisionAgreementAgencyId:provisionAgreement Id(version)|(% style="width:1061px" %)TFFS:CRED_EXT_DEBT_AB(1.0.0)
706 -|(% style="width:248px" %)ReportingCategory|(% style="width:629px" %)(((
720 +)))|BIS:PROCESS1(1.0.0).STEP1.STEP1_1
721 +|//ProvisionAgreement//|provisionAgreementAgencyId:provisionAgreement Id(version)|TFFS:CRED_EXT_DEBT_AB(1.0.0)
722 +|ReportingCategory|(((
707 707  reportingTaxonomyAgencyId:
724 +
708 708  reportingTaxonomyId(version).reportingCategoryI d.reportingCategoryId
709 -)))|(% style="width:1061px" %)IMF:REP_1(1.0.0):LVL1_REP_CAT.LVL2_REP_CAT
710 -|(% style="width:248px" %)//ReportingTaxonomy//|(% style="width:629px" %)reportingTaxonomyAgencyId:reportingTaxonomyI d(version)|(% style="width:1061px" %)IMF:REP_1(1.0.0)
711 -|(% style="width:248px" %)//ReportingTaxonomyMap//|(% style="width:629px" %)repTaxonomyAgencyId:repTaxonomyId(version)|(% style="width:1061px" %)SDMX:RT_MAP(1.0.0)
726 +)))|IMF:REP_1(1.0.0):LVL1_REP_CAT.LVL2_REP_CAT
727 +|//ReportingTaxonomy//|reportingTaxonomyAgencyId:reportingTaxonomyI d(version)|IMF:REP_1(1.0.0)
728 +|//ReportingTaxonomyMap//|repTaxonomyAgencyId:repTaxonomyId(version)|SDMX:RT_MAP(1.0.0)
712 712  
713 -|(% style="width:247px" %)**Classname**|(% style="width:649px" %)**Ending URN pattern**|(% style="width:1042px" %)**Example**
714 -|(% style="width:247px" %)//RepresentationMap//|(% style="width:649px" %)repMapAgencyId:repMapId(version)|(% style="width:1042px" %)SDMX:REF_AREA_MAPPING(1.0.0)
715 -|(% style="width:247px" %)Ruleset|(% style="width:649px" %)rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|(% style="width:1042px" %)ECB:RULESET_23(1.0.0).SET111
716 -|(% style="width:247px" %)//RulesetScheme//|(% style="width:649px" %)rulesetSchemeAgencyId rulesetSchemeId(version)|(% style="width:1042px" %)ECB:RULESET_23(1.0.0)
717 -|(% style="width:247px" %)//StructureMap//|(% style="width:649px" %)structureMapAgencyId:structureMap(version)|(% style="width:1042px" %)SDMX:BOP_STRUCTURES(1.0.0)
718 -|(% style="width:247px" %)Subscription|(% style="width:649px" %)(((
730 +|**Classname**|**Ending URN pattern**|**Example**
731 +|//RepresentationMap//|repMapAgencyId:repMapId(version)|SDMX:REF_AREA_MAPPING(1.0.0)
732 +|Ruleset|rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|ECB:RULESET_23(1.0.0).SET111
733 +|//RulesetScheme//|rulesetSchemeAgencyId rulesetSchemeId(version)|ECB:RULESET_23(1.0.0)
734 +|//StructureMap//|structureMapAgencyId:structureMap(version)|SDMX:BOP_STRUCTURES(1.0.0)
735 +|Subscription|(((
719 719  The Subscription is not itself an Identifiable Artefact and therefore it does not follow the rules for URN structure.
737 +
720 720  The name of the URN is registryURN There is no pre-determined format.
721 -)))|(% style="width:1042px" %)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.
722 -|(% style="width:247px" %)TimeDimension|(% style="width:649px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).timeDimensionId|(% style="width:1042px" %)TFFS:EXT_DEBT(1.0.0).TIME_PERIOD
723 -|(% style="width:247px" %)Transformation|(% style="width:649px" %)transformationSchemeAgencyId transformationSchemeId(version) transformationId|(% style="width:1042px" %)ECB:TRANSFORMATION_SCHEME(1.0.0).TRANS_1
724 -|(% style="width:247px" %)//TransformationScheme//|(% style="width:649px" %)transformationSchemeAgencyId transformationSchemeId(version)|(% style="width:1042px" %)ECB: TRANSFORMATION_SCHEME(1.0.0)
725 -|(% style="width:247px" %)Transition|(% style="width:649px" %)(((
739 +)))|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.
740 +|TimeDimension|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).timeDimensionId|TFFS:EXT_DEBT(1.0.0).TIME_PERIOD
741 +|Transformation|transformationSchemeAgencyId transformationSchemeId(version) transformationId|ECB:TRANSFORMATION_SCHEME(1.0.0).TRANS_1
742 +|//TransformationScheme//|transformationSchemeAgencyId transformationSchemeId(version)|ECB: TRANSFORMATION_SCHEME(1.0.0)
743 +|**Classname**|**Ending URN pattern**|**Example**
744 +|Transition|(((
726 726  processAgencyId:processId(version).processStepId.
746 +
727 727  transitionId
728 -)))|(% style="width:1042px" %)BIS:PROCESS1(1.0.0).STEP1.TRANSITION1
729 -|(% style="width:247px" %)UserDefinedOperator|(% style="width:649px" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|(% style="width:1042px" %)ECB:OS_CALC(1.2.0).OS267
730 -|(% style="width:247px" %)//UserDefinedOperatorScheme//|(% style="width:649px" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|(% style="width:1042px" %)ECB:OS_CALC(1.2.0)
731 -|(% style="width:247px" %)//ValueList//|(% style="width:649px" %)valuelistAgencyId:valuelistId(version)|(% style="width:1042px" %)SDMX:VLIST(1.0.0)
732 -|(% style="width:247px" %)VtlCodelistMapping|(% style="width:649px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|(% style="width:1042px" %)ECB:CLIST_MP(2.0.0).ABZ
733 -|(% style="width:247px" %)VtlConceptMapping|(% style="width:649px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|(% style="width:1042px" %)ECB:CLIST_MP(1.0.0).XYA
734 -|(% style="width:247px" %)VtlDataflowMapping|(% style="width:649px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|(% style="width:1042px" %)ECB:CLIST_MP(1.0.0).MOQ
735 -|(% style="width:247px" %)//VtlMappingScheme//|(% style="width:649px" %)vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|(% style="width:1042px" %)ECB:CLIST_MP(2.0.0)
748 +)))|BIS:PROCESS1(1.0.0).STEP1.TRANSITION1
749 +|UserDefinedOperator|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|ECB:OS_CALC(1.2.0).OS267
750 +|//UserDefinedOperatorScheme//|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|ECB:OS_CALC(1.2.0)
751 +|//ValueList//|valuelistAgencyId:valuelistId(version)|SDMX:VLIST(1.0.0)
752 +|VtlCodelistMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|ECB:CLIST_MP(2.0.0).ABZ
753 +|VtlConceptMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|ECB:CLIST_MP(1.0.0).XYA
754 +|VtlDataflowMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|ECB:CLIST_MP(1.0.0).MOQ
755 +|//VtlMappingScheme//|vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|ECB:CLIST_MP(2.0.0)
736 736  
737 737  **Table 3: Table of identification components for SDMX Identifiable Artefacts**
738 738  
... ... @@ -740,7 +740,7 @@
740 740  
741 741  === {{id name="_Toc93862"/}}7.1 Structural Definition Metadata ===
742 742  
743 -=== {{id name="_Toc93863"/}}7.1.1 Introduction ===
763 +===== {{id name="_Toc93863"/}}7.1.1 Introduction =====
744 744  
745 745  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.)
746 746  
... ... @@ -756,79 +756,90 @@
756 756  
757 757  The following table lists the Maintainable Artefacts.
758 758  
759 -(% style="width:881.294px" %)
760 -|(% colspan="2" style="width:522px" %)**Maintainable Artefacts**|(% style="width:490px" %)**Content**
761 -|(% style="width:198px" %)**Abstract Class**|(% style="width:324px" %)**Concrete Class**|(% style="width:490px" %)
762 -|(% style="width:198px" %)Item Scheme|(% style="width:324px" %)Codelist|(% style="width:490px" %)Code
763 -|(% style="width:198px" %) |(% style="width:324px" %)Concept Scheme|(% style="width:490px" %)Concept
764 -|(% style="width:198px" %) |(% style="width:324px" %)Category Scheme|(% style="width:490px" %)Category
765 -|(% style="width:198px" %) |(% style="width:324px" %)Organisation Unit Scheme|(% style="width:490px" %)Organisation Unit
766 -|(% style="width:198px" %) |(% style="width:324px" %)Agency Scheme|(% style="width:490px" %)Agency
767 -|(% style="width:198px" %) |(% style="width:324px" %)Data Provider Scheme|(% style="width:490px" %)Data Provider
768 -|(% style="width:198px" %) |(% style="width:324px" %)Metadata Provider Scheme|(% style="width:490px" %)Metadata Provider
769 -|(% style="width:198px" %) |(% style="width:324px" %)Data Consumer Scheme|(% style="width:490px" %)Data Consumer
770 -|(% style="width:198px" %) |(% style="width:324px" %)Reporting Taxonomy|(% style="width:490px" %)Reporting Category
771 -|(% style="width:198px" %) |(% style="width:324px" %)Transformation Scheme|(% style="width:490px" %)Transformation
772 -|(% style="width:198px" %) |(% style="width:324px" %)Custom Type Scheme|(% style="width:490px" %)Custom Type
773 -|(% style="width:198px" %) |(% style="width:324px" %)Name Personalisation Scheme|(% style="width:490px" %)Name Personalisation
774 -|(% style="width:198px" %) |(% style="width:324px" %)Vtl Mapping Scheme|(% style="width:490px" %)Vtl Codelist Mapping Vtl Concept Mapping
775 -|(% style="width:198px" %) |(% style="width:324px" %)Ruleset Scheme|(% style="width:490px" %)Ruleset
776 -|(% style="width:198px" %) |(% style="width:324px" %)User Defined Operator Scheme|(% style="width:490px" %)User Defined Operator
777 -|(% style="width:198px" %)Enumerated List|(% style="width:324px" %)ValueList|(% style="width:490px" %)Value Item
778 -|(% style="width:198px" %)Structure|(% style="width:324px" %)Data Structure Definition|(% style="width:490px" %)(((
779 +|(% colspan="2" %)**Maintainable Artefacts**|**Content**
780 +|**Abstract Class**|**Concrete Class**|
781 +|Item Scheme|Codelist|Code
782 +| |Concept Scheme|Concept
783 +| |Category Scheme|Category
784 +| |Organisation Unit Scheme|Organisation Unit
785 +| |Agency Scheme|Agency
786 +| |Data Provider Scheme|Data Provider
787 +| |Metadata Provider Scheme|Metadata Provider
788 +| |Data Consumer Scheme|Data Consumer
789 +| |Reporting Taxonomy|Reporting Category
790 +| |Transformation Scheme|Transformation
791 +| |Custom Type Scheme|Custom Type
792 +| |Name Personalisation Scheme|Name Personalisation
793 +| |Vtl Mapping Scheme|Vtl Codelist Mapping Vtl Concept Mapping
794 +| |Ruleset Scheme|Ruleset
795 +| |User Defined Operator Scheme|User Defined Operator
796 +|Enumerated List|ValueList|Value Item
797 +|Structure|Data Structure Definition|(((
779 779  Dimension Descriptor
799 +
780 780  Group Dimension Descriptor
801 +
781 781  Dimension
803 +
782 782  Time Dimension
805 +
783 783  Attribute Descriptor
807 +
784 784  Data Attribute
809 +
785 785  Measure Descriptor
811 +
786 786  Measure
787 787  )))
788 -|(% style="width:198px" %) |(% style="width:324px" %)Metadata Structure Definition|(% style="width:490px" %)Metadata Attribute Descriptor Metadata Attribute
789 -|(% style="width:198px" %)Structure Usage|(% style="width:324px" %)Dataflow|(% style="width:490px" %)
790 -|(% style="width:198px" %) |(% style="width:324px" %)Metadataflow|(% style="width:490px" %)
791 -|(% style="width:198px" %)None|(% style="width:324px" %)Process|(% style="width:490px" %)Process Step
792 -|(% style="width:198px" %)None|(% style="width:324px" %)Structure Map|(% style="width:490px" %)(((
814 +| |Metadata Structure Definition|Metadata Attribute Descriptor Metadata Attribute
815 +|Structure Usage|Dataflow|
816 +| |Metadataflow|
817 +|None|Process|Process Step
818 +|None|Structure Map|(((
793 793  Component Map
820 +
794 794  Epoch Map
822 +
795 795  Date Pattern Map
796 796  )))
797 -|(% style="width:198px" %)None|(% style="width:324px" %)Representation Map|(% style="width:490px" %)Representation Mapping
798 -|(% style="width:198px" %)Item Scheme Map|(% style="width:324px" %)Organisation Scheme Map|(% style="width:490px" %)Item Map
799 -|(% style="width:198px" %) |(% style="width:324px" %)Concept Scheme Map|(% style="width:490px" %)Item Map
800 -|(% style="width:198px" %) |(% style="width:324px" %)Category Scheme Map|(% style="width:490px" %)Item Map
801 -|(% style="width:198px" %) |(% style="width:324px" %)Reporting Taxonomy Map|(% style="width:490px" %)Item Map
802 -|(% style="width:198px" %)None|(% style="width:324px" %)Provision Agreement|(% style="width:490px" %)
803 -|(% style="width:198px" %)None|(% style="width:324px" %)Metadata Provision Agreement|(% style="width:490px" %)
804 -|(% style="width:198px" %)None|(% style="width:324px" %)Hierarchy|(% style="width:490px" %)Hierarchical Code
805 -|(% style="width:198px" %)None|(% style="width:324px" %)Hierarchy Association|(% style="width:490px" %)
806 -|(% style="width:198px" %)None|(% style="width:324px" %)Categorisation|(% style="width:490px" %)
825 +|None|Representation Map|Representation Mapping
826 +|Item Scheme Map|Organisation Scheme Map|Item Map
827 +| |Concept Scheme Map|Item Map
828 +| |Category Scheme Map|Item Map
829 +| |Reporting Taxonomy Map|Item Map
830 +|None|Provision Agreement|
831 +|None|Metadata Provision Agreement|
832 +|None|Hierarchy|Hierarchical Code
833 +|None|Hierarchy Association|
834 +|None|Categorisation|
807 807  
808 808  **Table 4: Table of Maintainable Artefacts for Structural Definition Metadata**
809 809  
810 -=== {{id name="_Toc93864"/}}7.1.2 Item Scheme, Structure ===
838 +===== {{id name="_Toc93864"/}}7.1.2 Item Scheme, Structure =====
811 811  
812 812  The artefacts included in the structural definitions are:
813 813  
814 -* 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)
815 -* All types of Enumerated List (ValueList){{footnote}}Note that Codelist is also an EnumeratedList.{{/footnote}}
816 -* All types of Structure (Data Structure Definition, Metadata Structure Definition)
817 -* All types of Structure Usage (Dataflow, Metadataflow)
842 +• 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)
818 818  
819 -=== {{id name="_Toc93865"/}}7.1.3 Structure Usage ===
844 + All types of Enumerated List (ValueList)^^[[(% class="wikiinternallink wikiinternallink" %)^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]](%%)^^
820 820  
821 -==== 7.1.3.1 Structure Usage: Basic Concepts ====
846 + All types of Structure (Data Structure Definition, Metadata Structure Definition)
822 822  
848 +• All types of Structure Usage (Dataflow, Metadataflow)
849 +
850 +===== {{id name="_Toc93865"/}}7.1.3 Structure Usage =====
851 +
852 +**7.1.3.1 Structure Usage: Basic Concepts**
853 +
823 823  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.
824 824  
825 -==== 7.1.3.2 Structure Usage Schematic ====
856 +**7.1.3.2 Structure Usage Schematic**
826 826  
827 827  [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_52097ab5.jpg||height="246" width="438"]]
828 828  
829 829  **Figure 9: Schematic of Linking the Data and Metadata Flows to Categories and Structure Definitions**
830 830  
831 -==== 7.1.3.3 Structure Usage Model ====
862 +**7.1.3.3 Structure Usage Model**
832 832  
833 833  [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_302cc1a2.jpg||height="548" width="578"]]
834 834  
... ... @@ -844,9 +844,9 @@
844 844  * Categorisation to Dataflow and Category
845 845  * Categorisation to Metadataflow and Category
846 846  
847 -== {{id name="_Toc93866"/}}7.2 Data and Metadata Provisioning ==
878 +=== {{id name="_Toc93866"/}}7.2 Data and Metadata Provisioning ===
848 848  
849 -=== {{id name="_Toc93867"/}}7.2.1 Provisioning Agreement: Basic concepts ===
880 +===== {{id name="_Toc93867"/}}7.2.1 Provisioning Agreement: Basic concepts =====
850 850  
851 851  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.
852 852  
... ... @@ -854,7 +854,7 @@
854 854  
855 855  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.
856 856  
857 -=== {{id name="_Toc93868"/}}7.2.2 Provisioning Agreement Model – pull use case ===
888 +===== {{id name="_Toc93868"/}}7.2.2 Provisioning Agreement Model – pull use case =====
858 858  
859 859  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.
860 860  
... ... @@ -876,9 +876,9 @@
876 876  
877 877  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.
878 878  
879 -== {{id name="_Toc93869"/}}7.3 Data and Metadata Constraints ==
910 +=== {{id name="_Toc93869"/}}7.3 Data and Metadata Constraints ===
880 880  
881 -=== {{id name="_Toc93870"/}}7.3.1 Data and Metadata Constraints: Basic Concepts ===
912 +===== {{id name="_Toc93870"/}}7.3.1 Data and Metadata Constraints: Basic Concepts =====
882 882  
883 883  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.
884 884  
... ... @@ -942,14 +942,17 @@
942 942  
943 943  The Registration has an action attribute which takes one of the following values:
944 944  
976 +:
977 +
945 945  (((
946 -(% style="width:761.294px" %)
947 -|(% style="width:196px" %)**Action Attribute Value**|(% style="width:561px" %)**Behaviour**
948 -|(% style="width:196px" %)Append|(% style="width:561px" %)Add this Registration to the registry
949 -|(% style="width:196px" %)Replace|(% style="width:561px" %)(((
950 -Replace the existing Registration with identified by the id in the Registration of the SubmitRegistrationRequest
979 +|**Action Attribute Value**|**Behaviour**
980 +|Append|Add this Registration to the registry
981 +|Replace|(((
982 +Replace the existing Registration with identified by the id in the
983 +
984 +Registration of the SubmitRegistrationRequest
951 951  )))
952 -|(% style="width:196px" %)Delete|(% style="width:561px" %)Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest
986 +|Delete|Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest
953 953  )))
954 954  
955 955  [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_bc1dcdec.jpg||height="575" width="579"]]
... ... @@ -966,20 +966,27 @@
966 966  
967 967  Information in the data or metadata set is extracted and placed in one or more //Constraint//s (see the //Constraint// model in the SDMX Information Model – Section 2 of the SDMX Standards). The information to be extracted is indicated by the Boolean values set on the ProvisionAgreement or MetadataProvisionAgreement as shown in the table below.
968 968  
1003 +:
1004 +
969 969  (((
970 -(% style="width:678.294px" %)
971 -|**Indexing Required**|(% style="width:504px" %)**Registration Process Activity**
972 -|indexTimeSeries|(% style="width:504px" %)Extract all the series keys and create a KeySet(s) Constraint.
973 -|indexDataSet|(% style="width:504px" %)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.
974 -|indexReportingPeriod|(% style="width:504px" %)(((
1006 +|**Indexing Required**|**Registration Process Activity**
1007 +|indexTimeSeries|Extract all the series keys and create a KeySet(s) Constraint.
1008 +|indexDataSet|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.
1009 +|indexReportingPeriod|(((
975 975  This applies only to a registered __dataset__.
1011 +
976 976  Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint.
977 977  )))
978 -|**Indexing Required**|(% style="width:504px" %)**Registration Process Activity**
979 -|indexAttributes|(% style="width:504px" %)(((
1014 +|**Indexing Required**|**Registration Process Activity**
1015 +|indexAttributes|(((
980 980  **Data Set**
981 -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
1017 +
1018 +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
1019 +
1020 +SDMXIM, and the associated Selection Value
1021 +
982 982  **Metadata Set**
1023 +
983 983  Indicate the presence of a Reported Attribute by creating one or more Cube Regions containing Member Selections of Metadata Attribute Components of the Constraints model in the SDMX-IM. Note that the content is not stored in the Selection Value.
984 984  )))
985 985  )))
... ... @@ -988,7 +988,7 @@
988 988  
989 989  The Registration must reference the ProvisionAgreement or MetadataProvisionAgreement to which it relates.
990 990  
991 -=== {{id name="_Toc93876"/}}7.4.3 Registration Response ===
1032 +===== {{id name="_Toc93876"/}}7.4.3 Registration Response =====
992 992  
993 993  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”.
994 994  
... ... @@ -1018,18 +1018,20 @@
1018 1018  
1019 1019  Regardless of the type of registry/repository events being observed, a subscription always contains:
1020 1020  
1021 -1. 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.
1062 +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.
1022 1022  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.
1023 1023  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.
1024 1024  1. A selector which specifies which type of events are of interest. The set of event types is:
1025 1025  
1067 +:
1068 +::
1069 +
1026 1026  (((
1027 -(% style="width:856.294px" %)
1028 -|(% style="width:320px" %)**Event Type**|(% style="width:532px" %)**Comment**
1029 -|(% style="width:320px" %)STRUCTURAL_REPOSITORY_EVENTS|(% style="width:532px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1030 -|(% style="width:320px" %)DATA_REGISTRATION_EVENTS|(% style="width:532px" %)Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
1031 -|(% style="width:320px" %)METADATA_REGISTRATION_EVENTS|(% style="width:532px" %)Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
1032 -|(% style="width:320px" %)ALL_EVENTS|(% style="width:532px" %)All events of the specified EventType
1071 +|**Event Type**|**Comment**
1072 +|STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1073 +|DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
1074 +|METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
1075 +|ALL_EVENTS|All events of the specified EventType
1033 1033  )))
1034 1034  
1035 1035  === {{id name="_Toc93880"/}}7.5.3 Wildcard Facility ===
... ... @@ -1096,14 +1096,15 @@
1096 1096  
1097 1097  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:
1098 1098  
1142 +:
1143 +
1099 1099  (((
1100 -(% style="width:1126.29px" %)
1101 -|(% style="width:382px" %)**Selector**|(% style="width:740px" %)**Comment**
1102 -|(% style="width:382px" %)DataProvider & MetadataProvider|(% style="width:740px" %)Any datasets or metadata sets registered by the specified data or metadata provider will activate the notification.
1103 -|(% style="width:382px" %)ProvisionAgreement & MetadataProvisionAgreement|(% style="width:740px" %)Any datasets or metadata sets registered for the agreement will activate the notification.
1104 -|(% style="width:382px" %)Dataflow & Metadataflow|(% style="width:740px" %)Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
1105 -|(% style="width:382px" %)DataStructureDefinition & MetadataStructureDefinition|(% style="width:740px" %)Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will activate the notification
1106 -|(% style="width:382px" %)Category|(% style="width:740px" %)Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category.
1145 +|**Selector**|**Comment**
1146 +|DataProvider & MetadataProvider|Any datasets or metadata sets registered by the specified data or metadata provider will activate the notification.
1147 +|ProvisionAgreement & MetadataProvisionAgreement|Any datasets or metadata sets registered for the agreement will activate the notification.
1148 +|Dataflow & Metadataflow|Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification.
1149 +|DataStructureDefinition & MetadataStructureDefinition|Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will activate the notification
1150 +|Category|Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category.
1107 1107  )))
1108 1108  
1109 1109  The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration.
... ... @@ -1135,6 +1135,10 @@
1135 1135  
1136 1136  The notification will contain the Registration.
1137 1137  
1138 -----
1182 +[[1>>path:#sdfootnote1anc||name="sdfootnote1sym"]] 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.
1139 1139  
1140 -{{putFootnotes/}}
1184 +[[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:
1185 +
1186 +IMF.SubAgency1
1187 +
1188 +[[3>>path:#sdfootnote3anc||name="sdfootnote3sym"]] Note that Codelist is also an EnumeratedList.
1747307906944-697.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -37.9 KB
Content
SUZ.Methodology.Code.MethodologyClass[0]