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

From version 21.8
edited by Helena
on 2025/06/08 16:32
Change comment: There is no comment for this version
To version 22.14
edited by Helena
on 2025/06/08 17:03
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -163,9 +163,8 @@
163 163  
164 164  The registry interfaces are invoked in one of two ways:
165 165  
166 -*
167 -*1. The interface is the name of the root node of the SDMX-ML document
168 -*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.
166 +1. The interface is the name of the root node of the SDMX-ML document
167 +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 169  
170 170  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.
171 171  
... ... @@ -181,15 +181,15 @@
181 181  
182 182  === 5.2.2 Structure Submission Service ===
183 183  
184 -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).
183 +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).
185 185  
186 186  === 5.2.3 Structure Query Service ===
187 187  
188 -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:
187 +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:
189 189  
190 - Structure
189 +* Structure
191 191  
192 -The SDMX structural artefacts that may be queried are defined in the SDMX structure web service specification which is compatible with this release of the standard __[[https:~~/~~/github.com/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]][[->>url:https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]][[twg/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]][[->>url:https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]][[rest/blob/master/doc/structures.md>>url:https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]]__[[url:https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]]
191 +The SDMX structural artefacts that may be queried are defined in the SDMX structure web service specification which is compatible with this release of the standard __[[https:~~/~~/github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md>>https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]] __[[https:~~/~~/github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md>>https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]]
193 193  
194 194  === 5.2.4 Data and Reference Metadata Registration Service ===
195 195  
... ... @@ -271,7 +271,7 @@
271 271  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:
272 272  
273 273  a) Be a draft version.
274 -b) Not be explicitly^^[[(% class="wikiinternallink wikiinternallink wikiinternallink" %)^^1^^>>path:#sdfootnote1sym||name="sdfootnote1anc"]](%%)^^ referenced from any other object in the Registry.
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.
275 275  
276 276  4) The semantic versioning rules in the SDMX documentation MUST be obeyed.
277 277  )))
... ... @@ -305,47 +305,40 @@
305 305  * //Versionable//
306 306  * //Maintainable//
307 307  
308 -| |(% colspan="2" %)**Object Type**|(% colspan="2" %)**Data Attributes**|(% colspan="2" %)**Status**|(% colspan="2" %)**Data type**|(% colspan="2" %)**Notes**
309 -| |(% colspan="2" rowspan="4" %)//Annotable//|(% colspan="2" %)AnnotationTitle|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
310 -| |(% colspan="2" %)AnnotationType|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
311 -| |(% colspan="2" %)AnnotationURN|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
312 -| |(% colspan="2" %)(((
313 -AnnotationText in the form of
314 -
315 -InternationalString
307 +(% style="width:1038.83px" %)
308 +|(% colspan="2" %)**Object Type**|(% colspan="2" %)**Data Attributes**|(% colspan="2" %)**Status**|(% colspan="2" %)**Data type**|(% colspan="2" %)**Notes**
309 +|(% colspan="2" rowspan="4" %)//Annotable//|(% colspan="2" %)AnnotationTitle|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
310 +|(% colspan="2" %)AnnotationType|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
311 +|(% colspan="2" %)AnnotationURN|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
312 +|(% colspan="2" %)(((
313 +AnnotationText in the form of InternationalString
316 316  )))|(% colspan="2" %)C|(% colspan="2" %) |(% colspan="2" %)This can have languagespecific variants
317 -| |(% colspan="2" rowspan="4" %)//Identifiable//|(% colspan="2" %)All content as for //Annotable// plus|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
318 -| |(% colspan="2" %)id|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)
319 -| |(% colspan="2" %)uri|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
320 -| |(% 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.
321 -| |(% colspan="2" rowspan="3" %)//Nameable//|(% colspan="2" %)(((
322 -All content as for
323 -
324 -//Identifiable// plus
315 +|(% colspan="2" rowspan="4" %)//Identifiable//|(% colspan="2" %)All content as for //Annotable// plus|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
316 +|(% colspan="2" %)id|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)
317 +|(% colspan="2" %)uri|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)
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 +|(% colspan="2" rowspan="3" %)//Nameable//|(% colspan="2" %)(((
320 +All content as for //Identifiable// plus
325 325  )))|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
326 -| |(% colspan="2" %)(((
327 -Name in the form of
328 -
329 -InternationalString
322 +|(% colspan="2" %)(((
323 +Name in the form of InternationalString
330 330  )))|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)This can have language specific variants.
331 -| |(% colspan="2" %)(((
332 -Description in the form of
333 -
334 -InternationalString
325 +|(% colspan="2" %)(((
326 +Description in the form of InternationalString
335 335  )))|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)This can have language specific variants.
336 -| |(% colspan="2" rowspan="4" %)//Versionable//|(% colspan="2" %)(((
328 +|(% colspan="2" rowspan="4" %)//Versionable//|(% colspan="2" %)(((
337 337  All content as for
338 338  
339 339  //Identifiable// plus
340 340  )))|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
341 -| |(% colspan="2" %)version|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)This is the version number according to SDMX versioning rules.
342 -| |(% colspan="2" %)validFrom|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %)
343 -| |(% colspan="2" %)validTo|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %)
344 -|(% colspan="2" rowspan="5" %)//Maintainable//|(% colspan="2" %)All content as for //Versionable// plus|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %) |
345 -|(% 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.|
346 -|(% colspan="2" %)serviceURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the service that can be queried for this resource.|
347 -|(% colspan="2" %)structureURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the resource.|
348 -|(% 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.|
333 +|(% colspan="2" %)version|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)This is the version number according to SDMX versioning rules.
334 +|(% colspan="2" %)validFrom|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %)
335 +|(% colspan="2" %)validTo|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %)
336 +|(% colspan="2" %)//Maintainable//|(% colspan="2" %)All content as for //Versionable// plus|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %)
337 +|(% 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 +|(% 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 +|(% colspan="2" %) |(% colspan="2" %)structureURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the resource.
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.
349 349  
350 350  **Table 1: Common Attributes of Object Types**
351 351  
... ... @@ -369,11 +369,9 @@
369 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 370  * The AgencyScheme has a fixed version, i.e., ‘1.0’, hence it is an exception from the Semantic Versioning that other Artefacts follow.
371 371  * There can be only one AgencyScheme maintained by any one Agency. It has a fixed id of AGENCIES.
364 +* The /hierarchy of Organisation is not inherited by Maintenance Agency – thus each Agency Scheme is a flat list of Maintenance Agencies.
365 +* 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.
372 372  
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 -
377 377  This supports a hierarchical structure of agencyID.
378 378  
379 379  An example is shown below.
... ... @@ -384,14 +384,11 @@
384 384  
385 385  The following organizations maintain an Agency Scheme.
386 386  
387 -• SDMX – contains Agencies AA, BB
377 +* SDMX – contains Agencies AA, BB
378 +* AA – contains Agencies CC, DD
379 +* BB – contains Agencies CC, DD
380 +* DD – Contains Agency EE
388 388  
389 -• AA – contains Agencies CC, DD
390 -
391 -• BB – contains Agencies CC, DD
392 -
393 -• DD – Contains Agency EE
394 -
395 395  Each agency is identified by its full hierarchy excluding SDMX.
396 396  
397 397  e.g., the id of EE as an agencyID is AA.DD.EE
... ... @@ -404,13 +404,13 @@
404 404  
405 405  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.
406 406  
407 -===== {{id name="_Toc90807"/}}6.2.2 Universal Resource Name (URN) =====
394 +=== 6.2.2 Universal Resource Name (URN) ===
408 408  
409 -**6.2.2.1 Introduction**
396 +==== 6.2.2.1 Introduction ====
410 410  
411 411  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.).
412 412  
413 -**6.2.2.2 URN Structure //__Case Rules for URN__//**// //
400 +==== 6.2.2.2 URN Structure //__Case Rules for URN__// ====
414 414  
415 415  For the URN, all parts of the string are case sensitive. The generic structure of the URN is as follows:
416 416  
... ... @@ -422,7 +422,7 @@
422 422  
423 423  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.
424 424  
425 -**6.2.2.3 Explanation of the generic structure**
412 +==== 6.2.2.3 Explanation of the generic structure ====
426 426  
427 427  In the explanation below the actual object that is the target of the URN is called the **actual object**.
428 428  
... ... @@ -501,103 +501,103 @@
501 501  
502 502  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.
503 503  
504 -===== {{id name="_Toc90808"/}}6.2.3 Table of SDMX-IM Packages and Classes =====
491 +=== 6.2.3 Table of SDMX-IM Packages and Classes ===
505 505  
506 506  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.
507 507  
508 -|**Package**|**URN class name (model class name where this is different)**
509 -|base|Agency
510 -| |AgencyScheme
511 -| |DataConsumer
512 -| |DataConsumerScheme
513 -| |DataProvider
514 -| |DataProviderScheme
515 -| |MetadataProvider
516 -| |MetadataProviderScheme
517 -| |OrganisationUnit
518 -| |OrganisationUnitScheme
519 -| |
520 -|datastructure|AttributeDescriptor
521 -| |DataAttribute
522 -| |Dataflow
523 -| |DataStructure (DataStructureDefinition)
524 -| |Dimension
525 -| |DimensionDescriptor
526 -| |GroupDimensionDescriptor
527 -| |Measure
528 -| |MeasureDescriptor
529 -| |TimeDimension
530 -| |
531 -|metadatastructure|MetadataAttribute
532 -| |MetadataAttributeDescriptor
533 -| |(((
495 +(% style="width:750.835px" %)
496 +|(% style="width:222px" %)**Package**|(% style="width:526px" %)**URN class name (model class name where this is different)**
497 +|(% style="width:222px" %)base|(% style="width:526px" %)Agency
498 +|(% style="width:222px" %) |(% style="width:526px" %)AgencyScheme
499 +|(% style="width:222px" %) |(% style="width:526px" %)DataConsumer
500 +|(% style="width:222px" %) |(% style="width:526px" %)DataConsumerScheme
501 +|(% style="width:222px" %) |(% style="width:526px" %)DataProvider
502 +|(% style="width:222px" %) |(% style="width:526px" %)DataProviderScheme
503 +|(% style="width:222px" %) |(% style="width:526px" %)MetadataProvider
504 +|(% style="width:222px" %) |(% style="width:526px" %)MetadataProviderScheme
505 +|(% style="width:222px" %) |(% style="width:526px" %)OrganisationUnit
506 +|(% style="width:222px" %) |(% style="width:526px" %)OrganisationUnitScheme
507 +|(% style="width:222px" %) |(% style="width:526px" %)
508 +|(% style="width:222px" %)datastructure|(% style="width:526px" %)AttributeDescriptor
509 +|(% style="width:222px" %) |(% style="width:526px" %)DataAttribute
510 +|(% style="width:222px" %) |(% style="width:526px" %)Dataflow
511 +|(% style="width:222px" %) |(% style="width:526px" %)DataStructure (DataStructureDefinition)
512 +|(% style="width:222px" %) |(% style="width:526px" %)Dimension
513 +|(% style="width:222px" %) |(% style="width:526px" %)DimensionDescriptor
514 +|(% style="width:222px" %) |(% style="width:526px" %)GroupDimensionDescriptor
515 +|(% style="width:222px" %) |(% style="width:526px" %)Measure
516 +|(% style="width:222px" %) |(% style="width:526px" %)MeasureDescriptor
517 +|(% style="width:222px" %) |(% style="width:526px" %)TimeDimension
518 +|(% style="width:222px" %) |(% style="width:526px" %)
519 +|(% style="width:222px" %)metadatastructure|(% style="width:526px" %)MetadataAttribute
520 +|(% style="width:222px" %) |(% style="width:526px" %)MetadataAttributeDescriptor
521 +|(% style="width:222px" %) |(% style="width:526px" %)(((
534 534  MetadataStructure
535 535  
536 536  (MetadataStructureDefinition)
537 537  )))
538 538  
539 -:
540 -
541 541  (((
542 -|**Package**|**URN class name (model class name where this is different)**
543 -| |Metadataflow
544 -| |MetadataSet
545 -| |
546 -|process|Process
547 -| |ProcessStep
548 -| |Transition
549 -| |
550 -|registry|DataConstraint
551 -| |MetadataConstraint
552 -| |MetadataProvisionAgreement
553 -| |ProvisionAgreement
554 -| |Subscription
555 -| |
556 -|structuremapping|CategorySchemeMap
557 -| |ConceptSchemeMap
558 -| |OrganisationSchemeMap
559 -| |ReportingTaxonomyMap
560 -| |RepresentationMap
561 -| |StructureMap
562 -| |
563 -|codelist|Code
564 -| |Codelist
565 -| |HierarchicalCode
566 -| |Hierarchy
567 -| |HierarchyAssociation
568 -| |Level
569 -| |ValueList
570 -| |
571 -|categoryscheme|Categorisation
572 -| |Category
573 -| |CategoryScheme
574 -| |ReportingCategory
575 -| |ReportingTaxonomy
576 -|**Package**|**URN class name (model class name where this is different)**
577 -| |
578 -|conceptscheme|Concept
579 -| |ConceptScheme
580 -| |
581 -|transformation|CustomType
582 -| |CustomTypeScheme
583 -| |NamePersonalisation
584 -| |NamePersonalisationScheme
585 -| |Ruleset
586 -| |RulesetScheme
587 -| |Transformation
588 -| |TransformationScheme
589 -| |UserDefinedOperator
590 -| |UserDefinedOperatorScheme
591 -| |VtlCodelistMapping
592 -| |VtlConceptMapping
593 -| |VtlDataflowMapping
594 -| |VtlMappingScheme
595 -| |
528 +(% style="width:751.835px" %)
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
531 +|(% style="width:221px" %) |(% style="width:528px" %)MetadataSet
532 +|(% style="width:221px" %) |(% style="width:528px" %)
533 +|(% style="width:221px" %)process|(% style="width:528px" %)Process
534 +|(% style="width:221px" %) |(% style="width:528px" %)ProcessStep
535 +|(% style="width:221px" %) |(% style="width:528px" %)Transition
536 +|(% style="width:221px" %) |(% style="width:528px" %)
537 +|(% style="width:221px" %)registry|(% style="width:528px" %)DataConstraint
538 +|(% style="width:221px" %) |(% style="width:528px" %)MetadataConstraint
539 +|(% style="width:221px" %) |(% style="width:528px" %)MetadataProvisionAgreement
540 +|(% style="width:221px" %) |(% style="width:528px" %)ProvisionAgreement
541 +|(% style="width:221px" %) |(% style="width:528px" %)Subscription
542 +|(% style="width:221px" %) |(% style="width:528px" %)
543 +|(% style="width:221px" %)structuremapping|(% style="width:528px" %)CategorySchemeMap
544 +|(% style="width:221px" %) |(% style="width:528px" %)ConceptSchemeMap
545 +|(% style="width:221px" %) |(% style="width:528px" %)OrganisationSchemeMap
546 +|(% style="width:221px" %) |(% style="width:528px" %)ReportingTaxonomyMap
547 +|(% style="width:221px" %) |(% style="width:528px" %)RepresentationMap
548 +|(% style="width:221px" %) |(% style="width:528px" %)StructureMap
549 +|(% style="width:221px" %) |(% style="width:528px" %)
550 +|(% style="width:221px" %)codelist|(% style="width:528px" %)Code
551 +|(% style="width:221px" %) |(% style="width:528px" %)Codelist
552 +|(% style="width:221px" %) |(% style="width:528px" %)HierarchicalCode
553 +|(% style="width:221px" %) |(% style="width:528px" %)Hierarchy
554 +|(% style="width:221px" %) |(% style="width:528px" %)HierarchyAssociation
555 +|(% style="width:221px" %) |(% style="width:528px" %)Level
556 +|(% style="width:221px" %) |(% style="width:528px" %)ValueList
557 +|(% style="width:221px" %) |(% style="width:528px" %)
558 +|(% style="width:221px" %)categoryscheme|(% style="width:528px" %)Categorisation
559 +|(% style="width:221px" %) |(% style="width:528px" %)Category
560 +|(% style="width:221px" %) |(% style="width:528px" %)CategoryScheme
561 +|(% style="width:221px" %) |(% style="width:528px" %)ReportingCategory
562 +|(% style="width:221px" %) |(% style="width:528px" %)ReportingTaxonomy
563 +|(% style="width:221px" %)**Package**|(% style="width:528px" %)**URN class name (model class name where this is different)**
564 +|(% style="width:221px" %) |(% style="width:528px" %)
565 +|(% style="width:221px" %)conceptscheme|(% style="width:528px" %)Concept
566 +|(% style="width:221px" %) |(% style="width:528px" %)ConceptScheme
567 +|(% style="width:221px" %) |(% style="width:528px" %)
568 +|(% style="width:221px" %)transformation|(% style="width:528px" %)CustomType
569 +|(% style="width:221px" %) |(% style="width:528px" %)CustomTypeScheme
570 +|(% style="width:221px" %) |(% style="width:528px" %)NamePersonalisation
571 +|(% style="width:221px" %) |(% style="width:528px" %)NamePersonalisationScheme
572 +|(% style="width:221px" %) |(% style="width:528px" %)Ruleset
573 +|(% style="width:221px" %) |(% style="width:528px" %)RulesetScheme
574 +|(% style="width:221px" %) |(% style="width:528px" %)Transformation
575 +|(% style="width:221px" %) |(% style="width:528px" %)TransformationScheme
576 +|(% style="width:221px" %) |(% style="width:528px" %)UserDefinedOperator
577 +|(% style="width:221px" %) |(% style="width:528px" %)UserDefinedOperatorScheme
578 +|(% style="width:221px" %) |(% style="width:528px" %)VtlCodelistMapping
579 +|(% style="width:221px" %) |(% style="width:528px" %)VtlConceptMapping
580 +|(% style="width:221px" %) |(% style="width:528px" %)VtlDataflowMapping
581 +|(% style="width:221px" %) |(% style="width:528px" %)VtlMappingScheme
582 +|(% style="width:221px" %) |(% style="width:528px" %)
596 596  )))
597 597  
598 598  **Table 2: SDMX-IM Packages and Contained Classes**
599 599  
600 -===== {{id name="_Toc90809"/}}6.2.4 URN Identification components of SDMX objects =====
587 +=== 6.2.4 URN Identification components of SDMX objects ===
601 601  
602 602  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.
603 603  
... ... @@ -605,67 +605,56 @@
605 605  
606 606  urn:sdmx.org.sdmx.infomodel.{package}.{classname}=
607 607  
608 -|**Classname**|**Ending URN pattern**|**Example**
609 -|Agency^^[[(% class="wikiinternallink wikiinternallink wikiinternallink" %)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^|agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|ECB:**AGENCIES**(**1.0**).AA
610 -|//AgencyScheme//|agencySchemeAgencyId:**AGENCIES**(**1.0**)|ECB:**AGENCIES**(**1.0**)
611 -|//Categorisation//|categorisationAgencyId:categorisationId(version)|IMF:cat001(1.0.0)
612 -|Category|categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|IMF:SDDS(1.0.0):level_1_category.level_2_category …
613 -|//CategoryScheme//|categorySchemeAgencyId:categorySchemeId(versi on)|IMF:SDDS(1.0.0)
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:categorisationId(version)|(% style="width:383px" %)IMF:cat001(1.0.0)
600 +|(% style="width:289px" %)Category|(% 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)
614 614  
615 -|**Classname**|**Ending URN pattern**|**Example**
616 -|//CategorySchemeMap//|(((
617 -catSchemeMapAgencyId:catSchemeMapId(version
603 +|(% style="width:292px" %)**Classname**|(% style="width:595px" %)**Ending URN pattern**|(% style="width:794px" %)**Example**
604 +|(% style="width:292px" %)//CategorySchemeMap//|(% style="width:595px" %)(((
605 +catSchemeMapAgencyId:catSchemeMapId(version)
606 +)))|(% style="width:794px" %)SDMX:EUROSTAT_SUBJECT_DOMAIN(1.0.0)
607 +|(% style="width:292px" %)Code|(% style="width:595px" %)codeListAgencyId:codelistId(version).codeId|(% style="width:794px" %)SDMX:CL_FREQ(1.0.0).Q
608 +|(% style="width:292px" %)//Codelist//|(% style="width:595px" %)codeListAgencyId:codeListId(version)|(% style="width:794px" %)SDMX:CL_FREQ(1.0.0)
609 +|(% style="width:292px" %)ComponentMap|(% style="width:595px" %)structureMapAgencyId:structureMap(version).com ponentMapId|(% style="width:794px" %)SDMX:BOP_STRUCTURES(1.0.0).REF_AREA_TO_COUNT RY
610 +|(% style="width:292px" %)Concept|(% style="width:595px" %)conceptSchemeAgencyId:conceptSchemeId(versio n).conceptId|(% style="width:794px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0).FREQ
611 +|(% style="width:292px" %)//ConceptScheme//|(% style="width:595px" %)conceptSchemeAgencyId:conceptSchemeId(versio n)|(% style="width:794px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0)
612 +|(% style="width:292px" %)//ConceptSchemeMap//|(% style="width:595px" %)(((
613 +conceptSchemeMapAgencyId:conceptSchemeMap Id(version)
614 +)))|(% style="width:794px" %)SDMX:CONCEPT_MAP(1.0.0)
615 +|(% style="width:292px" %)CustomType|(% style="width:595px" %)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" %)customTypeSchemeAgencyId customTypeSchemeId(version)|(% style="width:794px" %)ECB:CUSTOM_TYPE_SCHEME(1.0.0)
617 +|(% style="width:292px" %)DataAttrribute|(% style="width:595px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dataAttributeId|(% style="width:794px" %)TFFS:EXT_DEBT(1.0.0).OBS_STATUS
618 +|(% style="width:292px" %)//DataConstraint//|(% style="width:595px" %)dataConstraintAgencyId:dataConstraintId(version)|(% style="width:794px" %)TFFS:CREDITOR_DATA_CONTENT(1.0.0)
618 618  
619 -)
620 -)))|SDMX:EUROSTAT_SUBJECT_DOMAIN(1.0.0)
621 -|Code|codeListAgencyId:codelistId(version).codeId|SDMX:CL_FREQ(1.0.0).Q
622 -|//Codelist//|codeListAgencyId:codeListId(version)|SDMX:CL_FREQ(1.0.0)
623 -|ComponentMap|structureMapAgencyId:structureMap(version).com ponentMapId|SDMX:BOP_STRUCTURES(1.0.0).REF_AREA_TO_COUNT RY
624 -|Concept|conceptSchemeAgencyId:conceptSchemeId(versio n).conceptId|SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0).FREQ
625 -|//ConceptScheme//|conceptSchemeAgencyId:conceptSchemeId(versio n)|SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0)
626 -|//ConceptSchemeMap//|(((
627 -conceptSchemeMapAgencyId:conceptSchemeMap
628 -
629 -Id(version)
630 -)))|SDMX:CONCEPT_MAP(1.0.0)
631 -|CustomType|customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|ECB: CUSTOM_TYPE_SCHEME(1.0.0).CUSTOM_TYPE_1
632 -|//CustomTypeScheme//|customTypeSchemeAgencyId customTypeSchemeId(version)|ECB:CUSTOM_TYPE_SCHEME(1.0.0)
633 -|DataAttrribute|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dataAttributeId|TFFS:EXT_DEBT(1.0.0).OBS_STATUS
634 -|//DataConstraint//|dataConstraintAgencyId:dataConstraintId(version)|TFFS:CREDITOR_DATA_CONTENT(1.0.0)
635 -
636 -|**Classname**|**Ending URN pattern**|**Example**
637 -|DataConsumer|dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**).dataConsumerId|SDMX:**DATA_CONSUMERS**(**1.0**).CONSUMER_1
638 -|//DataConsumerScheme//|(((
639 -dataConsumerSchemeAgencyId:**DATA_CONSUME**
640 -
641 -**RS**(**1.0**)
642 -)))|SDMX:**DATA_CONSUMERS**(**1.0**)
643 -|//Dataflow//|dataflowAgencyId:dataflowId(version)|TFFS:CRED_EXT_DEBT(1.0.0)
644 -|DataProvider|(((
645 -dataProviderSchemeAgencyId:**DATA_PROVIDERS**(
646 -
647 -**1.0**).dataProviderId
648 -)))|SDMX:**DATA_PROVIDERS**(**1.0**).PROVIDER_1
649 -|//DataProviderScheme//|(((
650 -dataProviderSchemeAgencyId:**DATA_PROVIDERS**(
651 -
652 -**1.0**)
653 -)))|SDMX:**DATA_PROVIDERS**(**1.0**)
654 -|//DataStructure//|dataStructureDefinitionAgencyId:dataStructureDef initionId(version)|TFFS:EXT_DEBT(1.0.0)
655 -|Dimension|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dimensionId|TFFS:EXT_DEBT(1.0.0).FREQ
656 -|(((
620 +|(% style="width:294px" %)**Classname**|(% style="width:645px" %)**Ending URN pattern**|(% style="width:742px" %)**Example**
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 +|(% style="width:294px" %)//DataConsumerScheme//|(% style="width:645px" %)(((
623 +dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**)
624 +)))|(% style="width:742px" %)SDMX:**DATA_CONSUMERS**(**1.0**)
625 +|(% style="width:294px" %)//Dataflow//|(% style="width:645px" %)dataflowAgencyId:dataflowId(version)|(% style="width:742px" %)TFFS:CRED_EXT_DEBT(1.0.0)
626 +|(% style="width:294px" %)DataProvider|(% style="width:645px" %)(((
627 +dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**).dataProviderId
628 +)))|(% style="width:742px" %)SDMX:**DATA_PROVIDERS**(**1.0**).PROVIDER_1
629 +|(% style="width:294px" %)//DataProviderScheme//|(% style="width:645px" %)(((
630 +dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**)
631 +)))|(% style="width:742px" %)SDMX:**DATA_PROVIDERS**(**1.0**)
632 +|(% style="width:294px" %)//DataStructure//|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version)|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0)
633 +|(% style="width:294px" %)Dimension|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dimensionId|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0).FREQ
634 +|(% style="width:294px" %)(((
657 657  DimensionDescriptor
658 658  
659 659  MeasureDescriptor
660 660  
661 661  AttributeDescriptor
662 -)))|(((
640 +)))|(% style="width:645px" %)(((
663 663  dataStructureDefinitionAgencyId:dataStructureDef initionId(version).componentListId
664 664  
665 -where the componentListId is the name of the class (there is only one occurrence of each in the
666 -
667 -Data Structure Definition)
668 -)))|(((
643 +where the componentListId is the name of the class (there is only one occurrence of each in the Data Structure Definition)
644 +)))|(% style="width:742px" %)(((
669 669  TFFS:EXT_DEBT(1.0.0).DimensionDescriptor
670 670  
671 671  TFFS:EXT_DEBT(1.0.0).MeasureDescriptor
... ... @@ -672,83 +672,81 @@
672 672  
673 673  TFFS:EXT_DEBT(1.0.0).AttributeDescriptor
674 674  )))
675 -|GroupDimensionDescriptor|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).groupDimensionDescriptorId|TFFS:EXT_DEBT(1.0.0).SIBLING
676 -|HierarchicalCode|hierarchyAgencyId:hierarchyId(version).hierarchica lCode.hierarchicalCode|UNESCO:H-C-GOV(1.0.0).GOV_CODE1.GOV_CODE1_1
651 +|(% style="width:294px" %)GroupDimensionDescriptor|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).groupDimensionDescriptorId|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0).SIBLING
652 +|(% 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
677 677  
678 -|**Classname**|**Ending URN pattern**|**Example**
679 -|//Hierarchy//|hierarchyAgencyId:hierarchyId(version)|UNESCO:H-C-GOV(1.0.0)
680 -|//HierarchyAssociation//|hierarchyAssociationAgencyId:hierarchyAssociatio nId(version)|UNESCO:CL_EXP_SOURCE(1.0.0)
681 -|Level|hierarchyAgencyId:hierarchyId(version).level|UNESCO:H-C-GOV(1.0.0).LVL1
682 -|Measure|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).measureId|TFFS:EXT_DEBT(1.0.0).OBS_VALUE
683 -|MetadataAttribute|(((
654 +|**Classname**|(% style="width:644px" %)**Ending URN pattern**|(% style="width:743px" %)**Example**
655 +|//Hierarchy//|(% style="width:644px" %)hierarchyAgencyId:hierarchyId(version)|(% style="width:743px" %)UNESCO:H-C-GOV(1.0.0)
656 +|//HierarchyAssociation//|(% style="width:644px" %)hierarchyAssociationAgencyId:hierarchyAssociatio nId(version)|(% style="width:743px" %)UNESCO:CL_EXP_SOURCE(1.0.0)
657 +|Level|(% style="width:644px" %)hierarchyAgencyId:hierarchyId(version).level|(% style="width:743px" %)UNESCO:H-C-GOV(1.0.0).LVL1
658 +|Measure|(% style="width:644px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).measureId|(% style="width:743px" %)TFFS:EXT_DEBT(1.0.0).OBS_VALUE
659 +|MetadataAttribute|(% style="width:644px" %)(((
684 684  msdAgencyId:msdId(version).metadataAttributeId.
685 685  
686 686  metadataAttributeId
687 -)))|IMF:SDDS_MSD(1.0.0).COMPILATION.METHOD
688 -|MetadataAttributeDescriptor|msdAgencyId:msdId(version).metadataAttributeDe scriptorId|IMF:SDDS_MSD(1.0.0).MetadataAttributeDescriptor
689 -|//MetadataConstraint//|metadataConstraintAgencyId:metadataConstraintI d(version)|TFFS:CREDITOR_METADATA_CONTENT(1.0.0)
690 -|//Metadataflow//|metadataflowAgencyId:metadataflowId(version)|IMF:SDDS_MDF(1.0.0)
691 -|MetadataProvider|metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**).metadataProviderId|SDMX:**METADATA_PROVIDERS**(**1.0**).MD_PROVIDER_1
692 -|//MetadataProviderScheme//|metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**)|SDMX:**METADATA_PROVIDERS**(**1.0**)
693 -|//MetadataProvisionAgreement//|metadataProvisionAgreementAgencyId:metadataP rovisionAgreementId(version)|IMF:SDDS_MDF_AB(1.0.0)
694 -|//MetadataSet//|metadataProviderId:metadataSetId(version)|MD_PROVIDER:METADATASET(1.0.0)
695 -|//MetadataStructure//|msdAgencyId:msdId(version)|IMF:SDDS_MSD(1.0.0)
663 +)))|(% style="width:743px" %)IMF:SDDS_MSD(1.0.0).COMPILATION.METHOD
664 +|MetadataAttributeDescriptor|(% style="width:644px" %)msdAgencyId:msdId(version).metadataAttributeDe scriptorId|(% style="width:743px" %)IMF:SDDS_MSD(1.0.0).MetadataAttributeDescriptor
665 +|//MetadataConstraint//|(% style="width:644px" %)metadataConstraintAgencyId:metadataConstraintI d(version)|(% style="width:743px" %)TFFS:CREDITOR_METADATA_CONTENT(1.0.0)
666 +|//Metadataflow//|(% style="width:644px" %)metadataflowAgencyId:metadataflowId(version)|(% style="width:743px" %)IMF:SDDS_MDF(1.0.0)
667 +|MetadataProvider|(% style="width:644px" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**).metadataProviderId|(% style="width:743px" %)SDMX:**METADATA_PROVIDERS**(**1.0**).MD_PROVIDER_1
668 +|//MetadataProviderScheme//|(% style="width:644px" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**)|(% style="width:743px" %)SDMX:**METADATA_PROVIDERS**(**1.0**)
669 +|//MetadataProvisionAgreement//|(% style="width:644px" %)metadataProvisionAgreementAgencyId:metadataP rovisionAgreementId(version)|(% style="width:743px" %)IMF:SDDS_MDF_AB(1.0.0)
670 +|//MetadataSet//|(% style="width:644px" %)metadataProviderId:metadataSetId(version)|(% style="width:743px" %)MD_PROVIDER:METADATASET(1.0.0)
671 +|//MetadataStructure//|(% style="width:644px" %)msdAgencyId:msdId(version)|(% style="width:743px" %)IMF:SDDS_MSD(1.0.0)
696 696  
697 -|**Classname**|**Ending URN pattern**|**Example**
698 -|NamePersonalisation|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|ECB:PSN_SCHEME(1.0.0).PSN1234
699 -|//NamePersonalisationScheme//|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|ECB:PSN_SCHEME(1.0.0)
700 -|//OrganisationSchemeMap//|orgSchemeMapAgencyId:orgSchemeMapId(versio n)|SDMX:AGENCIES_PROVIDERS(1.0.0)
701 -|OrganisationUnit|organisationUnitSchemeAgencyId:organisationUni tSchemeId(version).organisationUnitId|ECB:ORGANISATIONS(1.0.0).1F
702 -|//OrganisationUnitScheme//|organisationUnitSchemeAgencyId:organisationUni tSchemeId(version)|ECB:ORGANISATIONS(1.0.0)
703 -|//Process//|processAgencyId:processId{version)|BIS:PROCESS1(1.0.0)
704 -|ProcessStep|(((
673 +|(% style="width:296px" %)**Classname**|(% style="width:646px" %)**Ending URN pattern**|(% style="width:739px" %)**Example**
674 +|(% style="width:296px" %)NamePersonalisation|(% style="width:646px" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|(% style="width:739px" %)ECB:PSN_SCHEME(1.0.0).PSN1234
675 +|(% style="width:296px" %)//NamePersonalisationScheme//|(% style="width:646px" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|(% style="width:739px" %)ECB:PSN_SCHEME(1.0.0)
676 +|(% style="width:296px" %)//OrganisationSchemeMap//|(% style="width:646px" %)orgSchemeMapAgencyId:orgSchemeMapId(versio n)|(% style="width:739px" %)SDMX:AGENCIES_PROVIDERS(1.0.0)
677 +|(% style="width:296px" %)OrganisationUnit|(% style="width:646px" %)organisationUnitSchemeAgencyId:organisationUni tSchemeId(version).organisationUnitId|(% style="width:739px" %)ECB:ORGANISATIONS(1.0.0).1F
678 +|(% style="width:296px" %)//OrganisationUnitScheme//|(% style="width:646px" %)organisationUnitSchemeAgencyId:organisationUni tSchemeId(version)|(% style="width:739px" %)ECB:ORGANISATIONS(1.0.0)
679 +|(% style="width:296px" %)//Process//|(% style="width:646px" %)processAgencyId:processId{version)|(% style="width:739px" %)BIS:PROCESS1(1.0.0)
680 +|(% style="width:296px" %)ProcessStep|(% style="width:646px" %)(((
705 705  processAgencyId:processId(version).processStepId.
706 706  
707 707  processStepId
708 -)))|BIS:PROCESS1(1.0.0).STEP1.STEP1_1
709 -|//ProvisionAgreement//|provisionAgreementAgencyId:provisionAgreement Id(version)|TFFS:CRED_EXT_DEBT_AB(1.0.0)
710 -|ReportingCategory|(((
684 +)))|(% style="width:739px" %)BIS:PROCESS1(1.0.0).STEP1.STEP1_1
685 +|(% style="width:296px" %)//ProvisionAgreement//|(% style="width:646px" %)provisionAgreementAgencyId:provisionAgreement Id(version)|(% style="width:739px" %)TFFS:CRED_EXT_DEBT_AB(1.0.0)
686 +|(% style="width:296px" %)ReportingCategory|(% style="width:646px" %)(((
711 711  reportingTaxonomyAgencyId:
712 712  
713 713  reportingTaxonomyId(version).reportingCategoryI d.reportingCategoryId
714 -)))|IMF:REP_1(1.0.0):LVL1_REP_CAT.LVL2_REP_CAT
715 -|//ReportingTaxonomy//|reportingTaxonomyAgencyId:reportingTaxonomyI d(version)|IMF:REP_1(1.0.0)
716 -|//ReportingTaxonomyMap//|repTaxonomyAgencyId:repTaxonomyId(version)|SDMX:RT_MAP(1.0.0)
690 +)))|(% style="width:739px" %)IMF:REP_1(1.0.0):LVL1_REP_CAT.LVL2_REP_CAT
691 +|(% style="width:296px" %)//ReportingTaxonomy//|(% style="width:646px" %)reportingTaxonomyAgencyId:reportingTaxonomyI d(version)|(% style="width:739px" %)IMF:REP_1(1.0.0)
692 +|(% style="width:296px" %)//ReportingTaxonomyMap//|(% style="width:646px" %)repTaxonomyAgencyId:repTaxonomyId(version)|(% style="width:739px" %)SDMX:RT_MAP(1.0.0)
717 717  
718 -|**Classname**|**Ending URN pattern**|**Example**
719 -|//RepresentationMap//|repMapAgencyId:repMapId(version)|SDMX:REF_AREA_MAPPING(1.0.0)
720 -|Ruleset|rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|ECB:RULESET_23(1.0.0).SET111
721 -|//RulesetScheme//|rulesetSchemeAgencyId rulesetSchemeId(version)|ECB:RULESET_23(1.0.0)
722 -|//StructureMap//|structureMapAgencyId:structureMap(version)|SDMX:BOP_STRUCTURES(1.0.0)
723 -|Subscription|(((
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(version)|(% style="width:737px" %)SDMX:REF_AREA_MAPPING(1.0.0)
696 +|(% style="width:297px" %)Ruleset|(% style="width:647px" %)rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|(% style="width:737px" %)ECB:RULESET_23(1.0.0).SET111
697 +|(% style="width:297px" %)//RulesetScheme//|(% style="width:647px" %)rulesetSchemeAgencyId rulesetSchemeId(version)|(% style="width:737px" %)ECB:RULESET_23(1.0.0)
698 +|(% style="width:297px" %)//StructureMap//|(% style="width:647px" %)structureMapAgencyId:structureMap(version)|(% style="width:737px" %)SDMX:BOP_STRUCTURES(1.0.0)
699 +|(% style="width:297px" %)Subscription|(% style="width:647px" %)(((
724 724  The Subscription is not itself an Identifiable Artefact and therefore it does not follow the rules for URN structure.
725 -
726 726  The name of the URN is registryURN There is no pre-determined format.
727 -)))|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.
728 -|TimeDimension|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).timeDimensionId|TFFS:EXT_DEBT(1.0.0).TIME_PERIOD
729 -|Transformation|transformationSchemeAgencyId transformationSchemeId(version) transformationId|ECB:TRANSFORMATION_SCHEME(1.0.0).TRANS_1
730 -|//TransformationScheme//|transformationSchemeAgencyId transformationSchemeId(version)|ECB: TRANSFORMATION_SCHEME(1.0.0)
731 -|**Classname**|**Ending URN pattern**|**Example**
732 -|Transition|(((
702 +)))|(% 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.
703 +|(% style="width:297px" %)TimeDimension|(% style="width:647px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).timeDimensionId|(% style="width:737px" %)TFFS:EXT_DEBT(1.0.0).TIME_PERIOD
704 +|(% style="width:297px" %)Transformation|(% style="width:647px" %)transformationSchemeAgencyId transformationSchemeId(version) transformationId|(% style="width:737px" %)ECB:TRANSFORMATION_SCHEME(1.0.0).TRANS_1
705 +|(% style="width:297px" %)//TransformationScheme//|(% style="width:647px" %)transformationSchemeAgencyId transformationSchemeId(version)|(% style="width:737px" %)ECB: TRANSFORMATION_SCHEME(1.0.0)
706 +|(% style="width:297px" %)**Classname**|(% style="width:647px" %)**Ending URN pattern**|(% style="width:737px" %)**Example**
707 +|(% style="width:297px" %)Transition|(% style="width:647px" %)(((
733 733  processAgencyId:processId(version).processStepId.
734 -
735 735  transitionId
736 -)))|BIS:PROCESS1(1.0.0).STEP1.TRANSITION1
737 -|UserDefinedOperator|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|ECB:OS_CALC(1.2.0).OS267
738 -|//UserDefinedOperatorScheme//|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|ECB:OS_CALC(1.2.0)
739 -|//ValueList//|valuelistAgencyId:valuelistId(version)|SDMX:VLIST(1.0.0)
740 -|VtlCodelistMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|ECB:CLIST_MP(2.0.0).ABZ
741 -|VtlConceptMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|ECB:CLIST_MP(1.0.0).XYA
742 -|VtlDataflowMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|ECB:CLIST_MP(1.0.0).MOQ
743 -|//VtlMappingScheme//|vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|ECB:CLIST_MP(2.0.0)
710 +)))|(% style="width:737px" %)BIS:PROCESS1(1.0.0).STEP1.TRANSITION1
711 +|(% style="width:297px" %)UserDefinedOperator|(% style="width:647px" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|(% style="width:737px" %)ECB:OS_CALC(1.2.0).OS267
712 +|(% style="width:297px" %)//UserDefinedOperatorScheme//|(% style="width:647px" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|(% style="width:737px" %)ECB:OS_CALC(1.2.0)
713 +|(% style="width:297px" %)//ValueList//|(% style="width:647px" %)valuelistAgencyId:valuelistId(version)|(% style="width:737px" %)SDMX:VLIST(1.0.0)
714 +|(% style="width:297px" %)VtlCodelistMapping|(% style="width:647px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|(% style="width:737px" %)ECB:CLIST_MP(2.0.0).ABZ
715 +|(% style="width:297px" %)VtlConceptMapping|(% style="width:647px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|(% style="width:737px" %)ECB:CLIST_MP(1.0.0).XYA
716 +|(% style="width:297px" %)VtlDataflowMapping|(% style="width:647px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|(% style="width:737px" %)ECB:CLIST_MP(1.0.0).MOQ
717 +|(% style="width:297px" %)//VtlMappingScheme//|(% style="width:647px" %)vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|(% style="width:737px" %)ECB:CLIST_MP(2.0.0)
744 744  
745 -5**Table 3: Table of identification components for SDMX Identifiable Artefacts**
719 +**Table 3: Table of identification components for SDMX Identifiable Artefacts**
746 746  
747 -= {{id name="_Toc90810"/}}7 Implementation Notes =
721 += 7 Implementation Notes =
748 748  
749 -=== {{id name="_Toc90811"/}}7.1 Structural Definition Metadata ===
723 +== 7.1 Structural Definition Metadata ==
750 750  
751 -===== {{id name="_Toc90812"/}}7.1.1 Introduction =====
725 +=== 7.1.1 Introduction ===
752 752  
753 753  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.)
754 754  
... ... @@ -764,46 +764,40 @@
764 764  
765 765  The following table lists the Maintainable Artefacts.
766 766  
767 -|(% colspan="2" %)**Maintainable Artefacts**|**Content**
768 -|**Abstract Class**|**Concrete Class**|
769 -|Item Scheme|Codelist|Code
770 -| |Concept Scheme|Concept
771 -| |Category Scheme|Category
772 -| |Organisation Unit Scheme|Organisation Unit
773 -| |Agency Scheme|Agency
774 -| |Data Provider Scheme|Data Provider
775 -| |Metadata Provider Scheme|Metadata Provider
776 -| |Data Consumer Scheme|Data Consumer
777 -| |Reporting Taxonomy|Reporting Category
778 -| |Transformation Scheme|Transformation
779 -| |Custom Type Scheme|Custom Type
780 -| |Name Personalisation Scheme|Name Personalisation
781 -| |Vtl Mapping Scheme|Vtl Codelist Mapping Vtl Concept Mapping
782 -| |Ruleset Scheme|Ruleset
783 -| |User Defined Operator Scheme|User Defined Operator
784 -|Enumerated List|ValueList|Value Item
785 -|Structure|Data Structure Definition|(((
741 +(% style="width:825.835px" %)
742 +|(% colspan="2" style="width:455px" %)**Maintainable Artefacts**|(% style="width:367px" %)**Content**
743 +|(% style="width:160px" %)**Abstract Class**|(% style="width:295px" %)**Concrete Class**|(% style="width:367px" %)
744 +|(% style="width:160px" %)Item Scheme|(% style="width:295px" %)Codelist|(% style="width:367px" %)Code
745 +|(% style="width:160px" %) |(% style="width:295px" %)Concept Scheme|(% style="width:367px" %)Concept
746 +|(% style="width:160px" %) |(% style="width:295px" %)Category Scheme|(% style="width:367px" %)Category
747 +|(% style="width:160px" %) |(% style="width:295px" %)Organisation Unit Scheme|(% style="width:367px" %)Organisation Unit
748 +|(% style="width:160px" %) |(% style="width:295px" %)Agency Scheme|(% style="width:367px" %)Agency
749 +|(% style="width:160px" %) |(% style="width:295px" %)Data Provider Scheme|(% style="width:367px" %)Data Provider
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|(% style="width:367px" %)Data Consumer
752 +|(% style="width:160px" %) |(% style="width:295px" %)Reporting Taxonomy|(% style="width:367px" %)Reporting Category
753 +|(% style="width:160px" %) |(% style="width:295px" %)Transformation Scheme|(% style="width:367px" %)Transformation
754 +|(% style="width:160px" %) |(% style="width:295px" %)Custom Type Scheme|(% style="width:367px" %)Custom Type
755 +|(% style="width:160px" %) |(% style="width:295px" %)Name Personalisation Scheme|(% style="width:367px" %)Name Personalisation
756 +|(% style="width:160px" %) |(% style="width:295px" %)Vtl Mapping Scheme|(% style="width:367px" %)Vtl Codelist Mapping Vtl Concept Mapping
757 +|(% style="width:160px" %) |(% style="width:295px" %)Ruleset Scheme|(% style="width:367px" %)Ruleset
758 +|(% style="width:160px" %) |(% style="width:295px" %)User Defined Operator Scheme|(% style="width:367px" %)User Defined Operator
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|(% style="width:367px" %)(((
786 786  Dimension Descriptor
787 -
788 788  Group Dimension Descriptor
789 -
790 790  Dimension
791 -
792 792  Time Dimension
793 -
794 794  Attribute Descriptor
795 -
796 796  Data Attribute
797 -
798 798  Measure Descriptor
799 -
800 800  Measure
801 801  )))
802 -| |Metadata Structure Definition|Metadata Attribute Descriptor Metadata Attribute
803 -|Structure Usage|Dataflow|
804 -| |Metadataflow|
805 -|None|Process|Process Step
806 -|None|Structure Map|(((
770 +|(% style="width:160px" %) |(% style="width:295px" %)Metadata Structure Definition|(% style="width:367px" %)Metadata Attribute Descriptor Metadata Attribute
771 +|(% style="width:160px" %)Structure Usage|(% style="width:295px" %)Dataflow|(% style="width:367px" %)
772 +|(% style="width:160px" %) |(% style="width:295px" %)Metadataflow|(% style="width:367px" %)
773 +|(% style="width:160px" %)None|(% style="width:295px" %)Process|(% style="width:367px" %)Process Step
774 +|(% style="width:160px" %)None|(% style="width:295px" %)Structure Map|(% style="width:367px" %)(((
807 807  Component Map
808 808  
809 809  Epoch Map
... ... @@ -810,44 +810,44 @@
810 810  
811 811  Date Pattern Map
812 812  )))
813 -|None|Representation Map|Representation Mapping
814 -|Item Scheme Map|Organisation Scheme Map|Item Map
815 -| |Concept Scheme Map|Item Map
816 -| |Category Scheme Map|Item Map
817 -| |Reporting Taxonomy Map|Item Map
818 -|None|Provision Agreement|
819 -|None|Metadata Provision Agreement|
820 -|None|Hierarchy|Hierarchical Code
821 -|None|Hierarchy Association|
822 -|None|Categorisation|
823 -|Constraint|Data Constraint|DataKeySet
824 -| | |CubeRegion
825 -|Constraint|Metadata Constraint|MetadataTargetRegion
781 +|(% style="width:160px" %)None|(% style="width:295px" %)Representation Map|(% style="width:367px" %)Representation Mapping
782 +|(% style="width:160px" %)Item Scheme Map|(% style="width:295px" %)Organisation Scheme Map|(% style="width:367px" %)Item Map
783 +|(% style="width:160px" %) |(% style="width:295px" %)Concept Scheme Map|(% style="width:367px" %)Item Map
784 +|(% style="width:160px" %) |(% style="width:295px" %)Category Scheme Map|(% style="width:367px" %)Item Map
785 +|(% style="width:160px" %) |(% style="width:295px" %)Reporting Taxonomy Map|(% style="width:367px" %)Item Map
786 +|(% style="width:160px" %)None|(% style="width:295px" %)Provision Agreement|(% style="width:367px" %)
787 +|(% style="width:160px" %)None|(% style="width:295px" %)Metadata Provision Agreement|(% style="width:367px" %)
788 +|(% style="width:160px" %)None|(% style="width:295px" %)Hierarchy|(% style="width:367px" %)Hierarchical Code
789 +|(% style="width:160px" %)None|(% style="width:295px" %)Hierarchy Association|(% style="width:367px" %)
790 +|(% style="width:160px" %)None|(% style="width:295px" %)Categorisation|(% style="width:367px" %)
791 +|(% style="width:160px" %)Constraint|(% style="width:295px" %)Data Constraint|(% style="width:367px" %)DataKeySet
792 +|(% style="width:160px" %) |(% style="width:295px" %) |(% style="width:367px" %)CubeRegion
793 +|(% style="width:160px" %)Constraint|(% style="width:295px" %)Metadata Constraint|(% style="width:367px" %)MetadataTargetRegion
826 826  
827 827  **Table 4: Table of Maintainable Artefacts for Structural Definition Metadata**
828 828  
829 -===== {{id name="_Toc90813"/}}7.1.2 Item Scheme, Structure =====
797 +=== 7.1.2 Item Scheme, Structure ===
830 830  
831 831  The artefacts included in the structural definitions are:
832 832  
833 833  * 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)
834 -* All types of Enumerated List (ValueList)^^[[(% class="wikiinternallink wikiinternallink wikiinternallink" %)^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]](%%)^^
802 +* All types of Enumerated List (ValueList){{footnote}}Note that Codelist is also an EnumeratedList.{{/footnote}}
835 835  * All types of Structure (Data Structure Definition, Metadata Structure Definition)
836 836  * All types of Structure Usage (Dataflow, Metadataflow)
837 837  
838 -===== {{id name="_Toc90814"/}}7.1.3 Structure Usage =====
806 +=== 7.1.3 Structure Usage ===
839 839  
840 -**7.1.3.1 Structure Usage: Basic Concepts**
808 +==== 7.1.3.1 Structure Usage: Basic Concepts ====
841 841  
842 842  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.
843 843  
844 -**7.1.3.2 Structure Usage Schematic**
812 +==== 7.1.3.2 Structure Usage Schematic ====
845 845  
846 846  [[image:SDMX 3.1 Section 5_en_9b750e13.jpg||height="246" width="438"]]
847 847  
848 848  **Figure 9: Schematic of Linking the Data and Metadata Flows to Categories and Structure Definitions**
849 849  
850 -**7.1.3.3 Structure Usage Model**
818 +==== 7.1.3.3 Structure Usage Model ====
851 851  
852 852  [[image:SDMX 3.1 Section 5_en_1c94cbe.jpg||height="548" width="578"]]
853 853  
... ... @@ -855,19 +855,17 @@
855 855  
856 856  In addition to the maintenance of the Dataflow and the Metadataflow, the following links must be maintained in the registry:
857 857  
858 -1.
859 -1*. Dataflow to Data Structure Definition
860 -1*. Metadataflow to Metadata Structure Definition
826 +* Dataflow to Data Structure Definition
827 +* Metadataflow to Metadata Structure Definition
861 861  
862 862  The following links may be created by means of a Categorisation
863 863  
864 -1.
865 -1*. Categorisation to Dataflow and Category
866 -1*. Categorisation to Metadataflow and Category
831 +* Categorisation to Dataflow and Category
832 +* Categorisation to Metadataflow and Category
867 867  
868 -=== {{id name="_Toc90815"/}}7.2 Data and Metadata Provisioning ===
834 +== 7.2 Data and Metadata Provisioning ==
869 869  
870 -===== {{id name="_Toc90816"/}}7.2.1 Provisioning Agreement: Basic concepts =====
836 +=== 7.2.1 Provisioning Agreement: Basic concepts ===
871 871  
872 872  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.
873 873  
... ... @@ -875,7 +875,7 @@
875 875  
876 876  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.
877 877  
878 -===== {{id name="_Toc90817"/}}7.2.2 Provisioning Agreement Model – pull use case =====
844 +=== 7.2.2 Provisioning Agreement Model – pull use case ===
879 879  
880 880  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.
881 881  
... ... @@ -897,67 +897,67 @@
897 897  
898 898  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.
899 899  
900 -=== {{id name="_Toc90818"/}}7.3 Data and Metadata Constraints ===
866 +== 7.3 Data and Metadata Constraints ==
901 901  
902 -===== {{id name="_Toc90819"/}}7.3.1 Data and Metadata Constraints: Basic Concepts =====
868 +=== 7.3.1 Data and Metadata Constraints: Basic Concepts ===
903 903  
904 -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.
870 +(% 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]].
905 905  
906 -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.
872 +(% 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]].
907 907  
908 -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.
874 +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.
909 909  
910 -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.
876 +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]].
911 911  
912 -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.
878 +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.
913 913  
914 -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).
880 +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).
915 915  
916 -===== {{id name="_Toc90820"/}}7.3.2 Data and Metadata Constraints: Schematic =====
882 +=== 7.3.2 Data and Metadata Constraints: Schematic ===
917 917  
918 918  [[image:SDMX 3.1 Section 5_en_28d0cadc.jpg||height="326" width="580"]]
919 919  
920 920  **Figure 14: Schematic of the Constraint and the Artefacts that can be constrained**
921 921  
922 -===== {{id name="_Toc90821"/}}7.3.3 Data and Metadata Constraints: Model =====
888 +=== 7.3.3 Data and Metadata Constraints: Model ===
923 923  
924 924  [[image:SDMX 3.1 Section 5_en_a3184f6a.jpg||height="298" width="579"]]
925 925  
926 926  **Figure 15: Logical class diagram showing inheritance between and reference to constrainable artefacts**
927 927  
928 -Logical class diagram showing inheritance between and reference to constrainable artefacts
894 +Logical class diagram showing inheritance between and reference to constrainable artefacts.
929 929  
930 -The class diagram above shows that Data Provider, Metadata Provider, Dataflow, Metadataflow, Provision Agreement, Metadata Provision Agreement, Data Structure
896 +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.
931 931  
932 -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.
898 +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.
933 933  
934 -these are used to refer to the classes to which the Constraint applies.
900 +these are used to refer to the classes to which the (% style="color:#e74c3c" %)Constraint(%%) applies.
935 935  
936 -The content of the Constraint can be found in the SDMX Information Model document.
902 +The content of the (% style="color:#e74c3c" %)Constraint(%%) can be found in the [[SDMX Information Model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]] document.
937 937  
938 -=== {{id name="_Toc90822"/}}7.4 Data Registration ===
904 +== 7.4 Data Registration ==
939 939  
940 -===== {{id name="_Toc90823"/}}7.4.1 Basic Concepts =====
906 +=== 7.4.1 Basic Concepts ===
941 941  
942 -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.
908 +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.
943 943  
944 -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.
910 +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.
945 945  
946 946  The same mechanism can be used to report or make available a metadata set.
947 947  
948 -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.
914 +[[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.
949 949  
950 -===== {{id name="_Toc90824"/}}7.4.2 The Registration Request =====
916 +=== 7.4.2 The Registration Request ===
951 951  
952 -**7.4.2.1 Registration Request Schematic**
918 +==== 7.4.2.1 Registration Request Schematic ====
953 953  
954 954  [[image:SDMX 3.1 Section 5_en_293a2ea6.jpg||height="337" width="554"]]
955 955  
956 956  **Figure 16: Schematic of the Objects Concerned with Registration**
957 957  
958 -**7.4.2.2 Registration Request Model**
924 +==== 7.4.2.2 Registration Request Model ====
959 959  
960 -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:
926 +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:
961 961  
962 962  * validFrom
963 963  * validTo
... ... @@ -965,15 +965,13 @@
965 965  
966 966  The last updated date is useful during the discovery process to make sure the client knows which data is freshest.
967 967  
968 -The Registration has an action attribute which takes one of the following values:
934 +The Registration has an action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] which takes one of the following values:
969 969  
970 -:
971 -
972 972  (((
973 -|**Action Attribute Value**|**Behaviour**
974 -|Append|Add this Registration to the registry
975 -|Replace|Replace the existing Registration with identified by the id in the Registration of the SubmitRegistrationRequest
976 -|Delete|Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest
937 +|(% style="width:224px" %)**Action Attribute Value**|(% style="width:1457px" %)**Behaviour**
938 +|(% style="width:224px" %)Append|(% style="width:1457px" %)Add this Registration to the registry
939 +|(% style="width:224px" %)Replace|(% style="width:1457px" %)Replace the existing Registration with identified by the id in the Registration of the SubmitRegistrationRequest
940 +|(% style="width:224px" %)Delete|(% style="width:1457px" %)Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest
977 977  )))
978 978  
979 979  [[image:SDMX 3.1 Section 5_en_90b3c64a.jpg||height="434" width="579"]]
... ... @@ -980,95 +980,87 @@
980 980  
981 981  **Figure 17: Logical Class Diagram of Registration of Data and Metadata**
982 982  
983 -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.
947 +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.
984 984  
985 -A SimpleDatasource is used to reference a physical SDMX-ML file that is available at a URL.
949 +A SimpleDatasource is used to reference a physical [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] file that is available at a URL.
986 986  
987 -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.
951 +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.
988 988  
989 -The Registration includes attributes that state how a SimpleDatasource is to be indexed when registered. The Registry registration process must act as follows:
953 +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:
990 990  
991 -Information in the dataset is extracted and made available via the availability REST API as documented here:
955 +Information in the [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] is extracted and made available via the availability REST API as documented here:
992 992  
993 993  https:~/~/github.com/sdmx-twg/sdmx-rest/blob/master/doc/availability.md
994 994  
995 -:
996 -
997 997  (((
998 -|**Indexing Required**|**Registration Process Activity**
999 -|indexTimeSeries|Extract all the series keys and create a KeySet(s) Constraint.
1000 -|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.
1001 -|indexReportingPeriod|(((
1002 -This applies only to a registered __dataset__.
1003 -
1004 -Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint.
960 +(% style="width:918.835px" %)
961 +|**Indexing Required**|(% style="width:745px" %)**Registration Process Activity**
962 +|indexTimeSeries|(% style="width:745px" %)Extract all the [[series keys>>doc:sdmx:Glossary.Series key.WebHome]] and create a KeySet(s) Constraint.
963 +|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.
964 +|indexReportingPeriod|(% style="width:745px" %)(((
965 +This applies only to a registered __[[dataset>>doc:sdmx:Glossary.Data set.WebHome]]__.
966 +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.
1005 1005  )))
1006 -|indexAttributes|(((
968 +|indexAttributes|(% style="width:745px" %)(((
1007 1007  **Data Set**
970 +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
1008 1008  
1009 -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
1010 -
1011 1011  **Metadata Set**
1012 -
1013 -Indicate the presence of a Reported Attribute by creating one or more Cube Regions containing Member Selections of Metadata Attribute
1014 -
1015 -Components of the Constraints model in the
973 +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
1016 1016  )))
1017 -|**Indexing Required**|**Registration Process Activity**
1018 -| |SDMX-IM. Note that the content is not stored in the Selection Value.
975 +|**Indexing Required**|(% style="width:745px" %)**Registration Process Activity**
976 +| |(% style="width:745px" %)[[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]. Note that the content is not stored in the Selection Value.
1019 1019  )))
1020 1020  
1021 -Constraints that specify the contents of a //QueryDatasource// are submitted to the Registry via the structure submission service (i.e., the RESTful API).
979 +(% 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).
1022 1022  
1023 1023  The Registration must reference the ProvisionAgreement to which it relates.
1024 1024  
1025 -===== {{id name="_Toc90825"/}}7.4.3 Registration Response =====
983 +=== 7.4.3 Registration Response ===
1026 1026  
1027 1027  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”.
1028 1028  
1029 -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.
987 +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.
1030 1030  
1031 -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:
989 +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:
1032 1032  
1033 1033  [[image:SDMX 3.1 Section 5_en_cdba03b5.jpg||height="371" width="579"]]
1034 1034  
1035 1035  **Figure 18: Logical class diagram showing the registration response**
1036 1036  
1037 -=== {{id name="_Toc90826"/}}7.5 Subscription and Notification Service ===
995 +== 7.5 Subscription and Notification Service ==
1038 1038  
1039 -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.
997 +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.
1040 1040  
1041 -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.
999 +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.
1042 1042  
1043 -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”.
1001 +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]]”.
1044 1044  
1045 -===== {{id name="_Toc90827"/}}7.5.1 Subscription Logical Class Diagram =====
1003 +=== 7.5.1 Subscription Logical Class Diagram ===
1046 1046  
1047 1047  [[image:SDMX 3.1 Section 5_en_1433df5d.jpg||height="680" width="587"]]
1048 1048  
1049 1049  **Figure 19: Logical Class Diagram of the Subscription**
1050 1050  
1051 -===== {{id name="_Toc90828"/}}7.5.2 Subscription Information =====
1009 +=== 7.5.2 Subscription Information ===
1052 1052  
1053 -Regardless of the type of registry/repository events being observed, a subscription always contains:
1011 +Regardless of the type of registry/repository events being observed, a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] always contains:
1054 1054  
1055 -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.
1056 -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.
1057 -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.
1013 +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.
1014 +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.
1015 +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]].
1058 1058  1. A selector which specifies which type of events are of interest. The set of event types is:
1059 1059  
1060 -:
1061 -::
1062 -
1063 1063  (((
1064 -|**Event Type**|**Comment**
1065 -|STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1066 -|DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
1067 -|METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
1068 -|ALL_EVENTS|All events of the specified EventType
1019 +(% style="width:1061.83px" %)
1020 +|**Event Type**|(% style="width:660px" %)**Comment**
1021 +|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.
1022 +|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.
1023 +|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.
1024 +|ALL_EVENTS|(% style="width:660px" %)All events of the specified EventType
1069 1069  )))
1070 1070  
1071 -===== {{id name="_Toc90829"/}}7.5.3 Wildcard Facility =====
1027 +=== 7.5.3 Wildcard Facility ===
1072 1072  
1073 1073  Subscription notification supports wildcarded identifier components URNs, which are identifiers which have some or all of their component parts replaced by the wildcard character `*`. Identifier components comprise:
1074 1074  
... ... @@ -1124,58 +1124,53 @@
1124 1124  
1125 1125  The complete SDMX versioning syntax can be found in the SDMX Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”.
1126 1126  
1127 -===== {{id name="_Toc90830"/}}7.5.4 Structural Repository Events =====
1083 +=== 7.5.4 Structural Repository Events ===
1128 1128  
1129 -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.
1085 +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]].
1130 1130  
1131 -===== {{id name="_Toc90831"/}}7.5.5 Registration Events =====
1087 +=== 7.5.5 Registration Events ===
1132 1132  
1133 -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:
1089 +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:
1134 1134  
1135 -:
1136 -
1137 1137  (((
1138 -|**Selector**|**Comment**
1139 -|DataProvider|Any datasets registered by the specified dataprovider will activate the notification.
1140 -|ProvisionAgreement|Any datasets for the agreement will activate the notification.
1141 -|Dataflow|Any datasets for the specified dataflow will activate the notification.
1142 -|DataStructureDefinition|Any datasets for those dataflows that are based on the specified Data Structure Definition will activate the notification
1143 -|Category|Any datasets registered for those dataflows, provision agreements that are categorised by the category.
1092 +(% style="width:1082.83px" %)
1093 +|(% style="width:230px" %)**Selector**|(% style="width:850px" %)**Comment**
1094 +|(% style="width:230px" %)DataProvider|(% style="width:850px" %)Any [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] registered by the specified dataprovider will activate the notification.
1095 +|(% style="width:230px" %)ProvisionAgreement|(% style="width:850px" %)Any [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] for the agreement will activate the notification.
1096 +|(% 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.
1097 +|(% 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
1098 +|(% 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.
1144 1144  )))
1145 1145  
1146 1146  The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration.
1147 1147  
1148 -== {{id name="_Toc90832"/}}7.6 Notification ==
1103 +== 7.6 Notification ==
1149 1149  
1150 -==== {{id name="_Toc90833"/}}7.6.1 Logical Class Diagram ====
1105 +=== 7.6.1 Logical Class Diagram ===
1151 1151  
1152 1152  [[image:SDMX 3.1 Section 5_en_8bc1b889.jpg||height="379" width="579"]]
1153 1153  
1154 1154  **Figure 20: Logical Class Diagram of the Notification**
1155 1155  
1156 -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.
1111 +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.
1157 1157  
1158 -Regardless of the registry component that caused the event to be triggered, the following common information is in the message:
1113 +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:
1159 1159  
1160 1160  * Date and time that the event occurred
1161 -* The URN of the artefact that caused the event
1162 -* The URN of the Subscription that produced the notification
1116 +* The URN of the [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] that caused the event
1117 +* The URN of the [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] that produced the [[notification>>doc:sdmx:Glossary.Notification.WebHome]]
1163 1163  * Event Action: Add, Replace, or Delete.
1164 1164  
1165 -Additionally, supplementary information may be contained in the notification as detailed below.
1120 +Additionally, supplementary information may be contained in the [[notification>>doc:sdmx:Glossary.Notification.WebHome]] as detailed below.
1166 1166  
1167 -==== {{id name="_Toc90834"/}}7.6.2 Structural Event Component ====
1122 +=== 7.6.2 Structural Event Component ===
1168 1168  
1169 -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).
1124 +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).
1170 1170  
1171 -==== {{id name="_Toc90835"/}}7.6.3 Registration Event Component ====
1126 +=== 7.6.3 Registration Event Component ===
1172 1172  
1173 -The notification will contain the Registration.
1128 +The [[notification>>doc:sdmx:Glossary.Notification.WebHome]] will contain the Registration.
1174 1174  
1175 -[[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.
1130 +----
1176 1176  
1177 -[[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:
1178 -
1179 -IMF.SubAgency1
1180 -
1181 -[[3>>path:#sdfootnote3anc||name="sdfootnote3sym"]] Note that Codelist is also an EnumeratedList.
1132 +{{putFootnotes/}}