Last modified by Helena on 2025/09/10 11:19
Summary
-
Page properties (3 modified, 0 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 -SDMX S TANDARDS:SECTION51 +SDMX 3.0 Standards. Section 5. SDMX registry specification: logical functionality and logical interfaces - Parent
-
... ... @@ -1,0 +1,1 @@ 1 +Methodology.WebHome - Content
-
... ... @@ -14,69 +14,69 @@ 14 14 15 15 = 1 Introduction = 16 16 17 -The business vision for [[SDMX>>doc: xwiki:Glossary.Statistical data and metadata exchange.WebHome]] envisages the promotion of a “data sharing” model to facilitate low-cost, high-quality [[statistical data and metadata exchange>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]]. Data sharing reduces the reporting burden of organisations by allowing them to publish data once and let their counterparties “pull” data and related metadata as required. The scenario is based on:17 +The business vision for [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] envisages the promotion of a “data sharing” model to facilitate low-cost, high-quality [[statistical data and metadata exchange>>doc:Glossary.Statistical data and metadata exchange.WebHome]]. Data sharing reduces the reporting burden of organisations by allowing them to publish data once and let their counterparties “pull” data and related metadata as required. The scenario is based on: 18 18 19 -* the availability of an abstract information model capable of supporting time series and cross-sectional data, [[structural metadata>>doc: xwiki:Glossary.Structural metadata.WebHome]], and [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] ([[SDMX-IM>>doc:xwiki:Glossary.SDMX Information Model.WebHome]])20 -* standardised XML and JSON schemas for the [[SDMX-ML>>doc: xwiki:Glossary.SDMX-ML.WebHome]] and [[SDMX-JSON>>doc:xwiki:Glossary.SDMX-JSON.WebHome]] formats derived from the model (XSD, JSON)19 +* the availability of an abstract information model capable of supporting time series and cross-sectional data, [[structural metadata>>doc:Glossary.Structural metadata.WebHome]], and [[reference metadata>>doc:Glossary.Reference metadata.WebHome]] ([[SDMX-IM>>doc:Glossary.SDMX Information Model.WebHome]]) 20 +* standardised XML and JSON schemas for the [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]] and [[SDMX-JSON>>doc:Glossary.SDMX-JSON.WebHome]] formats derived from the model (XSD, JSON) 21 21 * the use of web-services technology (XML, JSON, Open API) 22 22 23 -Such an architecture needs to be well organised, and the [[SDMX Registry>>doc: xwiki:Glossary.SDMX Registry.WebHome]]/Repository (SDMXRR) is tasked with providing structure, organisation, and maintenance and query interfaces for most of the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] [[components>>doc:xwiki:Glossary.Component.WebHome]] required to support the data sharing vision.23 +Such an architecture needs to be well organised, and the [[SDMX Registry>>doc:Glossary.SDMX Registry.WebHome]]/Repository (SDMXRR) is tasked with providing structure, organisation, and maintenance and query interfaces for most of the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] [[components>>doc:Glossary.Component.WebHome]] required to support the data sharing vision. 24 24 25 -However, it is important to emphasise that the [[SDMX>>doc: xwiki:Glossary.Statistical data and metadata exchange.WebHome]]-RR provides support for the submission and retrieval of all [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] and provisioning metadata. Therefore, the Registry not only supports the data-sharing scenario, but this metadata is also vital in order to provide support for data and metadata reporting/collection, and dissemination scenarios.25 +However, it is important to emphasise that the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-RR provides support for the submission and retrieval of all [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] and provisioning metadata. Therefore, the Registry not only supports the data-sharing scenario, but this metadata is also vital in order to provide support for data and metadata reporting/collection, and dissemination scenarios. 26 26 27 -Standard formats for the exchange of aggregated statistical data and metadata as prescribed in [[SDMX>>doc: xwiki:Glossary.Statistical data and metadata exchange.WebHome]] v3.0 are envisaged to bring benefits to the statistical community because data reporting and dissemination processes can be made more efficient.27 +Standard formats for the exchange of aggregated statistical data and metadata as prescribed in [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] v3.0 are envisaged to bring benefits to the statistical community because data reporting and dissemination processes can be made more efficient. 28 28 29 -As organisations migrate to [[SDMX>>doc: xwiki:Glossary.Statistical data and metadata exchange.WebHome]] enabled systems, many XML, JSON (and conventional) [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] will be produced (e.g., Data Structure, Metadata Structure, [[Code List>>doc:xwiki:Glossary.Code list.WebHome]] and (% style="color:#2ecc71" %)Concept(%%) definitions – often collectively called [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] – XML schemas generated from [[data structure definitions>>doc:xwiki:Glossary.Data structure definition.WebHome]], XSLT stylesheets for transformation and display of data and metadata, terminology references, etc.). The [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] model supports interoperability, and it is important to be able to discover and share these [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] between parties in a controlled and organized way.29 +As organisations migrate to [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] enabled systems, many XML, JSON (and conventional) [[artefacts>>doc:Glossary.Artefact.WebHome]] will be produced (e.g., Data Structure, Metadata Structure, [[Code List>>doc:Glossary.Code list.WebHome]] and (% style="color:#e74c3c" %)Concept(%%) definitions – often collectively called [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] – XML schemas generated from [[data structure definitions>>doc:Glossary.Data structure definition.WebHome]], XSLT stylesheets for transformation and display of data and metadata, terminology references, etc.). The [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] model supports interoperability, and it is important to be able to discover and share these [[artefacts>>doc:Glossary.Artefact.WebHome]] between parties in a controlled and organized way. 30 30 31 31 This is the role of the registry. 32 32 33 -With the fundamental [[SDMX>>doc: xwiki:Glossary.Statistical data and metadata exchange.WebHome]] standards in place, a set of architectural standards are needed to address some of the processes involved in [[statistical data and metadata exchange>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]], with an emphasis on maintenance, retrieval and sharing of the [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]]. In addition, the architectural standards support the registration and discovery of data and referential metadata.33 +With the fundamental [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] standards in place, a set of architectural standards are needed to address some of the processes involved in [[statistical data and metadata exchange>>doc:Glossary.Statistical data and metadata exchange.WebHome]], with an emphasis on maintenance, retrieval and sharing of the [[structural metadata>>doc:Glossary.Structural metadata.WebHome]]. In addition, the architectural standards support the registration and discovery of data and referential metadata. 34 34 35 -These architectural standards address the ‘how’, rather than the ‘what’, and are aimed at enabling existing [[SDMX>>doc: xwiki:Glossary.Statistical data and metadata exchange.WebHome]] standards to achieve their mission. The architectural standards address registry services, which initially comprise:35 +These architectural standards address the ‘how’, rather than the ‘what’, and are aimed at enabling existing [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] standards to achieve their mission. The architectural standards address registry services, which initially comprise: 36 36 37 -* [[structural metadata>>doc: xwiki:Glossary.Structural metadata.WebHome]] repository37 +* [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] repository 38 38 * data and metadata registration 39 39 * query 40 40 41 -The registry services outlined in this specification are designed to help the [[SDMX>>doc: xwiki:Glossary.Statistical data and metadata exchange.WebHome]] community manage the proliferation of [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] assets and to support data sharing for reporting and dissemination.41 +The registry services outlined in this specification are designed to help the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] community manage the proliferation of [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] assets and to support data sharing for reporting and dissemination. 42 42 43 43 = {{id name="_Toc93832"/}}2 Scope and Normative Status = 44 44 45 -The scope of this document is to specify the logical interfaces for the [[SDMX registry>>doc: xwiki:Glossary.SDMX Registry.WebHome]] in terms of the functions required and the data that may be present in the function call, and the behaviour expected of the registry.45 +The scope of this document is to specify the logical interfaces for the [[SDMX registry>>doc:Glossary.SDMX Registry.WebHome]] in terms of the functions required and the data that may be present in the function call, and the behaviour expected of the registry. 46 46 47 47 In this document, functions and behaviours of the Registry Interfaces are described in four ways: 48 48 49 49 * in text 50 50 * with tables 51 -* with UML diagrams excerpted from the [[SDMX Information Model>>doc: xwiki:Glossary.SDMX Information Model.WebHome]] ([[SDMX-IM>>doc:xwiki:Glossary.SDMX Information Model.WebHome]])52 -* with UML diagrams that are not a part of the [[SDMX-IM>>doc: xwiki:Glossary.SDMX Information Model.WebHome]] but are included here for clarity and to aid implementations (these diagrams are clearly marked as “Logical Class Diagram ...”)51 +* with UML diagrams excerpted from the [[SDMX Information Model>>doc:Glossary.SDMX Information Model.WebHome]] ([[SDMX-IM>>doc:Glossary.SDMX Information Model.WebHome]]) 52 +* with UML diagrams that are not a part of the [[SDMX-IM>>doc:Glossary.SDMX Information Model.WebHome]] but are included here for clarity and to aid implementations (these diagrams are clearly marked as “Logical Class Diagram ...”) 53 53 54 54 Whilst the introductory section contains some information on the role of the registry, it is assumed that the reader is familiar with the uses of a registry in providing shared metadata across a community of counterparties. 55 55 56 -Note that chapters 5 and 6 below contain normative rules regarding the Registry Interface and the identification of registry objects. Further, the minimum standard for access to the registry is via a REST interface (HTTP or HTTPS), as described in the appropriate sections. The [[notification>>doc: xwiki:Glossary.Notification.WebHome]] mechanism must support e-mail and HTTP/HTTPS protocols as described. Normative registry interfaces are specified in the [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] specification (Section 3 of the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Standard). All other sections of this document are informative.56 +Note that chapters 5 and 6 below contain normative rules regarding the Registry Interface and the identification of registry objects. Further, the minimum standard for access to the registry is via a REST interface (HTTP or HTTPS), as described in the appropriate sections. The [[notification>>doc:Glossary.Notification.WebHome]] mechanism must support e-mail and HTTP/HTTPS protocols as described. Normative registry interfaces are specified in the [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]] specification (Section 3 of the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Standard). All other sections of this document are informative. 57 57 58 -Note that although the term “authorised user” is used in this document, the [[SDMX>>doc: xwiki:Glossary.Statistical data and metadata exchange.WebHome]] standards do not define an access control mechanism. Such a mechanism, if required, must be chosen and implemented by the registry software provider.58 +Note that although the term “authorised user” is used in this document, the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] standards do not define an access control mechanism. Such a mechanism, if required, must be chosen and implemented by the registry software provider. 59 59 60 60 = {{id name="_Toc93833"/}}3 Scope of the SDMX Registry/Repository = 61 61 62 62 == {{id name="_Toc93834"/}}3.1 Objective == 63 63 64 -The objective of the [[SDMX registry>>doc: xwiki:Glossary.SDMX Registry.WebHome]]/repository is, in broad terms, to allow organisations to publish statistical data and [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] in known formats such that interested third parties can discover these data and interpret them accurately and correctly. The mechanism for doing this is twofold:64 +The objective of the [[SDMX registry>>doc:Glossary.SDMX Registry.WebHome]]/repository is, in broad terms, to allow organisations to publish statistical data and [[reference metadata>>doc:Glossary.Reference metadata.WebHome]] in known formats such that interested third parties can discover these data and interpret them accurately and correctly. The mechanism for doing this is twofold: 65 65 66 -1. To maintain and publish [[structural metadata>>doc: xwiki:Glossary.Structural metadata.WebHome]] that describes the structure and valid content of data and [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] sources such as databases, [[metadata repositories>>doc:xwiki:Glossary.Metadata repository.WebHome]], [[data sets>>doc:xwiki:Glossary.Data set.WebHome]], [[metadata sets>>doc:xwiki:Glossary.Metadata set.WebHome]]. This [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] enables software applications to understand and to interpret the data and [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] in these sources.67 -1. To enable applications, organisations, and individuals to share and to discover data and [[reference metadata>>doc: xwiki:Glossary.Reference metadata.WebHome]]. This facilitates data and [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] dissemination by implementing the data sharing vision of [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]].66 +1. To maintain and publish [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] that describes the structure and valid content of data and [[reference metadata>>doc:Glossary.Reference metadata.WebHome]] sources such as databases, [[metadata repositories>>doc:Glossary.Metadata repository.WebHome]], [[data sets>>doc:Glossary.Data set.WebHome]], [[metadata sets>>doc:Glossary.Metadata set.WebHome]]. This [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] enables software applications to understand and to interpret the data and [[reference metadata>>doc:Glossary.Reference metadata.WebHome]] in these sources. 67 +1. To enable applications, organisations, and individuals to share and to discover data and [[reference metadata>>doc:Glossary.Reference metadata.WebHome]]. This facilitates data and [[reference metadata>>doc:Glossary.Reference metadata.WebHome]] dissemination by implementing the data sharing vision of [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]. 68 68 69 69 == {{id name="_Toc93835"/}}3.2 Structural Metadata == 70 70 71 -Setting up [[structural metadata>>doc: xwiki:Glossary.Structural metadata.WebHome]] and the exchange context (referred to as “data provisioning”) involves the following steps for [[maintenance agencies>>doc:xwiki:Glossary.Maintenance agency.WebHome]]:71 +Setting up [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] and the exchange context (referred to as “data provisioning”) involves the following steps for [[maintenance agencies>>doc:Glossary.Maintenance agency.WebHome]]: 72 72 73 -* agreeing and creating a specification of the structure of the data (called a [[Data Structure Definition>>doc: xwiki:Glossary.Data structure definition.WebHome]] or [[DSD>>doc:xwiki:Glossary.Data structure definition.WebHome]] in this document but also known as “key family”), which defines the [[dimensions>>doc:xwiki:Glossary.Dimension.WebHome]], [[measures>>doc:xwiki:Glossary.Measure.WebHome]] and [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]] of a [[dataset>>doc:xwiki:Glossary.Data set.WebHome]] and their valid value set;74 -* if required, defining a subset or view of a [[DSD>>doc: xwiki:Glossary.Data structure definition.WebHome]] which allows some restriction of content called a “[[dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] definition”;75 -* agreeing and creating a specification of the structure of [[reference metadata>>doc: xwiki:Glossary.Reference metadata.WebHome]] ([[Metadata Structure Definition>>doc:xwiki:Glossary.Metadata structure definition.WebHome]]) which defines the metadata [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]] and their presentational arrangement in a Metadataset or as part of a [[Dataset>>doc:xwiki:Glossary.Data set.WebHome]], and their valid values and content;76 -* if required, defining a subset or view of an [[MSD>>doc: xwiki:Glossary.Metadata structure definition.WebHome]] which allows some restriction of content called a “[[metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]]”;77 -* defining which subject matter domains (specified as a [[Category Scheme>>doc: xwiki:Glossary.Category scheme.WebHome]]) are related to the [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] and [[Metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]] to enable browsing;73 +* agreeing and creating a specification of the structure of the data (called a [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]] or [[DSD>>doc:Glossary.Data structure definition.WebHome]] in this document but also known as “key family”), which defines the [[dimensions>>doc:Glossary.Dimension.WebHome]], [[measures>>doc:Glossary.Measure.WebHome]] and [[attributes>>doc:Glossary.Attribute.WebHome]] of a [[dataset>>doc:Glossary.Data set.WebHome]] and their valid value set; 74 +* if required, defining a subset or view of a [[DSD>>doc:Glossary.Data structure definition.WebHome]] which allows some restriction of content called a “[[dataflow>>doc:Glossary.Dataflow.WebHome]] definition”; 75 +* agreeing and creating a specification of the structure of [[reference metadata>>doc:Glossary.Reference metadata.WebHome]] ([[Metadata Structure Definition>>doc:Glossary.Metadata structure definition.WebHome]]) which defines the metadata [[attributes>>doc:Glossary.Attribute.WebHome]] and their presentational arrangement in a Metadataset or as part of a [[Dataset>>doc:Glossary.Data set.WebHome]], and their valid values and content; 76 +* if required, defining a subset or view of an [[MSD>>doc:Glossary.Metadata structure definition.WebHome]] which allows some restriction of content called a “[[metadataflow>>doc:Glossary.Metadataflow.WebHome]]”; 77 +* defining which subject matter domains (specified as a [[Category Scheme>>doc:Glossary.Category scheme.WebHome]]) are related to the [[Dataflow>>doc:Glossary.Dataflow.WebHome]] and [[Metadataflow>>doc:Glossary.Metadataflow.WebHome]] to enable browsing; 78 78 * defining one or more lists of Data and Metadata Providers; 79 -* defining which Data/Metadata Providers have agreed to publish a given [[Dataflow>>doc: xwiki:Glossary.Dataflow.WebHome]]/[[Metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]] – this is called a [[Provision Agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]] or Metadata [[Provision Agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]], respectively.79 +* defining which Data/Metadata Providers have agreed to publish a given [[Dataflow>>doc:Glossary.Dataflow.WebHome]]/[[Metadataflow>>doc:Glossary.Metadataflow.WebHome]] – this is called a [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]] or Metadata [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]], respectively. 80 80 81 81 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_28806f51.jpg||height="539" width="443"]] 82 82 ... ... @@ -85,20 +85,20 @@ 85 85 86 86 Note that in Figure 1 (but also most of the relevant subsequent figures) terms that include both data and metadata have been used. For example: 87 87 88 -* Structure Definition: refers to Data Structure Definition (DSD) and Metadata Structure Definition (MSD) 89 -* Flow: refers to Dataflow and Metadataflow 90 -* Provision Agreement: refers to Provision Agreement (for data) and Metadata Provision Agreement 91 -* Provider Scheme: refers to Data Provider Scheme and Metadata Provider Scheme 92 -* Provider: refers to Data Provider and Metadata Provider 88 +* Structure Definition: refers to [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]] ([[DSD>>doc:Glossary.Data structure definition.WebHome]]) and [[Metadata Structure Definition>>doc:Glossary.Metadata structure definition.WebHome]] (MSD) 89 +* Flow: refers to [[Dataflow>>doc:Glossary.Dataflow.WebHome]] and [[Metadataflow>>doc:Glossary.Metadataflow.WebHome]] 90 +* [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]]: refers to [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]] (for data) and Metadata [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]] 91 +* Provider Scheme: refers to [[Data Provider Scheme>>doc:Glossary.Data provider scheme.WebHome]] and Metadata Provider Scheme 92 +* Provider: refers to [[Data Provider>>doc:Glossary.Data provider.WebHome]] and Metadata Provider 93 93 94 -In that context, the term “Metadata” refers to reference metadata. 94 +In that context, the term “Metadata” refers to [[reference metadata>>doc:Glossary.Reference metadata.WebHome]]. 95 95 96 96 == {{id name="_Toc93836"/}}3.3 Registration == 97 97 98 -Publishing the data and reference metadata involves the following steps for a Data/Metadata Provider: 98 +Publishing the data and [[reference metadata>>doc:Glossary.Reference metadata.WebHome]] involves the following steps for a Data/Metadata Provider: 99 99 100 -* making the reference metadata and data available in SDMX-ML/JSON conformant data files or databases (which respond to an SDMX query with data). The data and reference metadata files or databases must be web accessible, and must conform to an agreed Dataflow or Metadataflow (Data Structure Definition or Metadata Structure Definition subset); 101 -* registering the existence of published reference metadata and data files or databases with one or more SDMX registries. 100 +* making the [[reference metadata>>doc:Glossary.Reference metadata.WebHome]] and data available in [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]]/JSON conformant data files or databases (which respond to an [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] query with data). The data and [[reference metadata>>doc:Glossary.Reference metadata.WebHome]] files or databases must be web accessible, and must conform to an agreed [[Dataflow>>doc:Glossary.Dataflow.WebHome]] or [[Metadataflow>>doc:Glossary.Metadataflow.WebHome]] ([[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]] or [[Metadata Structure Definition>>doc:Glossary.Metadata structure definition.WebHome]] subset); 101 +* registering the existence of published [[reference metadata>>doc:Glossary.Reference metadata.WebHome]] and data files or databases with one or more [[SDMX registries>>doc:Glossary.SDMX Registry.WebHome]]. 102 102 103 103 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_1edb9829.jpg||height="407" width="553"]] 104 104 ... ... @@ -106,17 +106,17 @@ 106 106 107 107 == {{id name="_Toc93837"/}}3.4 Notification == 108 108 109 -Notifying interested parties of newly published or re-published data, reference metadata or changes in structural metadata involves: 109 +Notifying interested parties of newly published or re-published data, [[reference metadata>>doc:Glossary.Reference metadata.WebHome]] or changes in [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] involves: 110 110 111 -* registry support of a subscription-based notification service which sends an email or notifies an HTTP address announcing all published data that meets the criteria contained in the subscription request. 111 +* registry support of a [[subscription>>doc:Glossary.Subscription.WebHome]]-based [[notification>>doc:Glossary.Notification.WebHome]] service which sends an email or notifies an HTTP address announcing all published data that meets the criteria contained in the [[subscription>>doc:Glossary.Subscription.WebHome]] request. 112 112 113 113 == {{id name="_Toc93838"/}}3.5 Discovery == 114 114 115 -Discovering published data and reference metadata involves interaction with the registry to fulfil the following logical steps that would be carried out by a user interacting with a service that itself interacts with the registry and an SDMX-enabled data or reference metadata resource: 115 +Discovering published data and [[reference metadata>>doc:Glossary.Reference metadata.WebHome]] involves interaction with the registry to fulfil the following logical steps that would be carried out by a user interacting with a service that itself interacts with the registry and an [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-enabled data or [[reference metadata>>doc:Glossary.Reference metadata.WebHome]] resource: 116 116 117 -* optionally browsing a subject matter domain category scheme to find Dataflows (and hence Data Structure Definitions) and Metadataflows which structure the type of data and/or reference metadata being sought; 118 -* build a query, in terms of the selected Data Structure Definition or Metadata Structure Definition, which specifies what data are required and submitting this to a service that can query an SDMX registry which will return a list of (URLs of) data and reference metadata files and databases which satisfy the query; 119 -* processing the query result set and retrieving data and/or reference metadata from the supplied URLs. 117 +* optionally browsing a subject matter domain [[category scheme>>doc:Glossary.Category scheme.WebHome]] to find [[Dataflows>>doc:Glossary.Dataflow.WebHome]] (and hence [[Data Structure Definitions>>doc:Glossary.Data structure definition.WebHome]]) and [[Metadataflows>>doc:Glossary.Metadataflow.WebHome]] which structure the type of data and/or [[reference metadata>>doc:Glossary.Reference metadata.WebHome]] being sought; 118 +* build a query, in terms of the selected [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]] or [[Metadata Structure Definition>>doc:Glossary.Metadata structure definition.WebHome]], which specifies what data are required and submitting this to a service that can query an [[SDMX registry>>doc:Glossary.SDMX Registry.WebHome]] which will return a list of (URLs of) data and [[reference metadata>>doc:Glossary.Reference metadata.WebHome]] files and databases which satisfy the query; 119 +* processing the query result set and retrieving data and/or [[reference metadata>>doc:Glossary.Reference metadata.WebHome]] from the supplied URLs. 120 120 121 121 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_1f4779f4.jpg||height="328" width="554"]] 122 122 ... ... @@ -126,7 +126,7 @@ 126 126 127 127 == {{id name="_Toc93840"/}}4.1 Architectural Schematic == 128 128 129 -The architecture of the SDMX registry/repository is derived from the objectives stated above. It is a layered architecture that is founded by a structural metadata repository which supports a provisioning metadata repository which supports the registry services. These are all supported by the SDMX-ML schemas. Applications can be built on top of these services which support the reporting, storage, retrieval, and dissemination aspects of the statistical lifecycle as well as the maintenance of the structural metadata required to drive these applications. 129 +The architecture of the [[SDMX registry>>doc:Glossary.SDMX Registry.WebHome]]/repository is derived from the objectives stated above. It is a layered architecture that is founded by a [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] repository which supports a provisioning [[metadata repository>>doc:Glossary.Metadata repository.WebHome]] which supports the registry services. These are all supported by the [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]] schemas. Applications can be built on top of these services which support the reporting, storage, retrieval, and dissemination aspects of the statistical lifecycle as well as the maintenance of the [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] required to drive these applications. 130 130 131 131 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_99c4cc7e.jpg||height="325" width="553"]] 132 132 ... ... @@ -134,18 +134,18 @@ 134 134 135 135 == {{id name="_Toc93841"/}}4.2 Structural Metadata Repository == 136 136 137 -The basic layer is that of a structural metadata service which supports the lifecycle of SDMX structural metadata artefacts such as Maintenance Agencies, Data Structure Definitions, Metadata Structure Definitions, Provision Agreements, Processes etc. This layer is supported by the Structure Submission and Query Service. 137 +The basic layer is that of a [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] service which supports the lifecycle of [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] [[artefacts>>doc:Glossary.Artefact.WebHome]] such as [[Maintenance Agencies>>doc:Glossary.Maintenance agency.WebHome]], [[Data Structure Definitions>>doc:Glossary.Data structure definition.WebHome]], [[Metadata Structure Definitions>>doc:Glossary.Metadata structure definition.WebHome]], [[Provision Agreements>>doc:Glossary.Provision agreement.WebHome]], Processes etc. This layer is supported by the Structure Submission and Query Service. 138 138 139 -Note that the SDMX REST API supports all of the SDMX structural artefacts. The only structural artefacts that are not yet supported are: 139 +Note that the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] REST API supports all of the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] structural [[artefacts>>doc:Glossary.Artefact.WebHome]]. The only structural [[artefacts>>doc:Glossary.Artefact.WebHome]] that are not yet supported are: 140 140 141 141 * Registration of data and metadata sources 142 -* Subscription and Notification 142 +* [[Subscription>>doc:Glossary.Subscription.WebHome]] and [[Notification>>doc:Glossary.Notification.WebHome]] 143 143 144 -As of the initial version of SDMX 3.0 no messages are defined to support these artefacts; hence, users may need to use SDMX 2.1 Registry Interface messages, instead. 144 +As of the initial (% style="color:#e74c3c" %)version(%%) of [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 no messages are defined to support these [[artefacts>>doc:Glossary.Artefact.WebHome]]; hence, users may need to use [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] 2.1 Registry Interface messages, instead. 145 145 146 146 == {{id name="_Toc93842"/}}4.3 Provisioning Metadata Repository == 147 147 148 -The function of this repository is to support the definition of the structural metadata that describes the various types of data-store which model SDMX-conformant databases or files, and to link to these data sources. These links can be specified for a data/metadata provider, for a specific data or metadata flow. In the SDMX model this is called the Provision or Metadata Provision Agreement. 148 +The function of this repository is to support the definition of the [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] that describes the various types of data-store which model [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-conformant databases or files, and to link to these [[data sources>>doc:Glossary.Data source.WebHome]]. These links can be specified for a data/metadata provider, for a specific data or [[metadata flow>>doc:Glossary.Metadataflow.WebHome]]. In the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] model this is called the Provision or Metadata [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]]. 149 149 150 150 This layer is supported by the Data and Metadata Registration Service. 151 151 ... ... @@ -156,25 +156,25 @@ 156 156 The Registry Interfaces are: 157 157 158 158 * Notify Registry Event 159 -* Submit Subscription Request 160 -* Submit Subscription Response 159 +* Submit [[Subscription>>doc:Glossary.Subscription.WebHome]] Request 160 +* Submit [[Subscription>>doc:Glossary.Subscription.WebHome]] Response 161 161 * Submit Registration Request 162 162 * Submit Registration Response 163 163 * Query Registration Request 164 164 * Query Registration Response 165 -* Query Subscription Request 166 -* Query Subscription Response 165 +* Query [[Subscription>>doc:Glossary.Subscription.WebHome]] Request 166 +* Query [[Subscription>>doc:Glossary.Subscription.WebHome]] Response 167 167 168 168 The registry interfaces are invoked in one of two ways: 169 169 170 -1. The interface is the name of the root node of the SDMX-ML document 171 -1. The interface is invoked as a child element of the RegistryInterface message where the RegistryInterface is the root node of the SDMX-ML document. 170 +1. The interface is the name of the root node of the [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]] document 171 +1. The interface is invoked as a child element of the RegistryInterface message where the RegistryInterface is the root node of the [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]] document. 172 172 173 -In addition to these interfaces the registry must support a mechanism for submitting and querying for structural metadata. This is detailed in sections 5.2.2 and 5.2.3. 173 +In addition to these interfaces the registry must support a mechanism for submitting and querying for [[structural metadata>>doc:Glossary.Structural metadata.WebHome]]. This is detailed in sections 5.2.2 and 5.2.3. 174 174 175 -All these interactions with the Registry – with the exception of NotifyRegistryEvent – are designed in pairs. The first document, the one which invokes the SDMX-RR interface, is a “Request” document. The message returned by the interface is a “Response” document. 175 +All these interactions with the Registry – with the exception of NotifyRegistryEvent – are designed in pairs. The first document, the one which invokes the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-RR interface, is a “Request” document. The message returned by the interface is a “Response” document. 176 176 177 -It should be noted that all interactions are assumed to be synchronous, with the exception of Notify Registry Event. This document is sent by the SDMX-RR to all subscribers whenever an even occurs to which any users have subscribed. Thus, it does not conform to the requestresponse pattern, because it is inherently asynchronous. 177 +It should be noted that all interactions are assumed to be synchronous, with the exception of Notify Registry Event. This document is sent by the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-RR to all subscribers whenever an even occurs to which any users have subscribed. Thus, it does not conform to the requestresponse pattern, because it is inherently asynchronous. 178 178 179 179 == {{id name="_Toc93845"/}}5.2 Registry Services == 180 180 ... ... @@ -184,42 +184,42 @@ 184 184 185 185 === {{id name="_Toc93847"/}}5.2.2 Structure Submission Service === 186 186 187 -The registry must support a mechanism for submitting structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: [[__https:~~/~~/github.com/ sdmx-twg/sdmx-rest__>>https://https:github.comsdmx-twgsdmx-rest]]). In order for the architecture to be scalable, the finest-grained piece of structural metadata that can be processed by the SDMX-RR is a MaintainableArtefact, with the exception of Item Schemes, where changes at an Item level is also possible (see next section on the SDMX Information Model).187 +The registry must support a mechanism for submitting [[structural metadata>>doc:Glossary.Structural metadata.WebHome]]. This mechanism can be the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] REST interface for [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] (this is defined in the corresponding GitHub project, dedicated to the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] REST API: [[__https:~~/~~/github.com/__>>https://https:github.comsdmx-twgsdmx-rest]][[sdmx>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-twg/[[sdmx>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-rest). In order for the architecture to be scalable, the finest-grained piece of [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] that can be processed by the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-RR is a MaintainableArtefact, with the exception of [[Item Schemes>>doc:Glossary.Item scheme.WebHome]], where changes at an Item (% style="color:#e74c3c" %)level(%%) is also possible (see next section on the [[SDMX Information Model>>doc:Glossary.SDMX Information Model.WebHome]]). 188 188 189 189 === {{id name="_Toc93848"/}}5.2.3 Structure Query Service === 190 190 191 -The registry must support a mechanism for querying for structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: [[__https:~~/~~/github.com/ sdmx-twg/sdmx-rest__>>https://https:github.comsdmx-twgsdmx-rest]]). The registry response to this query mechanism is the SDMX Structure message, which has as its root node:191 +The registry must support a mechanism for querying for [[structural metadata>>doc:Glossary.Structural metadata.WebHome]]. This mechanism can be the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] REST interface for [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] (this is defined in the corresponding GitHub project, dedicated to the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] REST API: [[__https:~~/~~/github.com/__>>https://https:github.comsdmx-twgsdmx-rest]][[sdmx>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-twg/[[sdmx>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-rest). The registry response to this query mechanism is the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Structure message, which has as its root node: 192 192 193 193 * Structure 194 194 195 -The SDMX structural artefacts that may be queried are: 195 +The [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] structural [[artefacts>>doc:Glossary.Artefact.WebHome]] that may be queried are: 196 196 197 -* data flows and metadata flows 198 -* data structure definitions and metadata structure definitions 199 -* code lists 197 +* [[data flows>>doc:Glossary.Dataflow.WebHome]] and [[metadata flows>>doc:Glossary.Metadataflow.WebHome]] 198 +* [[data structure definitions>>doc:Glossary.Data structure definition.WebHome]] and [[metadata structure definitions>>doc:Glossary.Metadata structure definition.WebHome]] 199 +* [[code>>doc:Glossary.Code.WebHome]] lists 200 200 * value lists 201 -* concept schemes 201 +* (% style="color:#e74c3c" %)concept(%%) schemes 202 202 * reporting taxonomies 203 -* provision agreements and metadata provision agreements 203 +* [[provision agreements>>doc:Glossary.Provision agreement.WebHome]] and metadata [[provision agreements>>doc:Glossary.Provision agreement.WebHome]] 204 204 * structure maps 205 -* representation map 205 +* [[representation>>doc:Glossary.Representation.WebHome]] map 206 206 * organisation scheme map 207 -* concept scheme map 208 -* category scheme map 207 +* (% style="color:#e74c3c" %)concept(%%) scheme map 208 +* [[category>>doc:Glossary.Category.WebHome]] scheme map 209 209 * reporting taxonomy map 210 210 * processes 211 211 * hierarchies 212 -* constraints 213 -* category schemes 214 -* categorisations and categorised objects (examples are categorised data flows and metadata flows, data structure definitions, metadata structure definitions, provision agreements registered data sources and metadata sources) 215 -* organisation schemes (agency scheme, data provider scheme, data consumer scheme, organisation unit scheme) 212 +* (% style="color:#e74c3c" %)constraints 213 +* [[category>>doc:Glossary.Category.WebHome]] schemes 214 +* categorisations and categorised objects (examples are categorised [[data flows>>doc:Glossary.Dataflow.WebHome]] and [[metadata flows>>doc:Glossary.Metadataflow.WebHome]], [[data structure definitions>>doc:Glossary.Data structure definition.WebHome]], [[metadata structure definitions>>doc:Glossary.Metadata structure definition.WebHome]], [[provision agreements>>doc:Glossary.Provision agreement.WebHome]] registered [[data sources>>doc:Glossary.Data source.WebHome]] and metadata sources) 215 +* organisation schemes ([[agency scheme>>doc:Glossary.Agency scheme.WebHome]], [[data provider scheme>>doc:Glossary.Data provider scheme.WebHome]], [[data consumer scheme>>doc:Glossary.Data consumer scheme.WebHome]], organisation unit scheme) 216 216 217 -Due to the VTL implementation the other structural metadata artefacts that may be queried are: 217 +Due to the [[VTL>>doc:Glossary.Validation and transformation language.WebHome]] implementation the other [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] [[artefacts>>doc:Glossary.Artefact.WebHome]] that may be queried are: 218 218 219 219 * Transformation schemes 220 220 * Custom type schemes 221 221 * Name personalisation schemes 222 -* VTL mapping schemes 222 +* [[VTL>>doc:Glossary.Validation and transformation language.WebHome]] mapping schemes 223 223 * Ruleset schemes 224 224 * User defined operator schemes 225 225 ... ... @@ -232,17 +232,17 @@ 232 232 * QueryRegistrationRequest 233 233 * QueryRegistrationResponse 234 234 235 -The Data and Metadata Registration Service allows SDMX conformant files and webaccessible databases containing published data and reference metadata to be registered in the SDMX Registry. The registration process MAY validate the content of the datasets or metadatasets, and MAY extract a concise representation of the contents in terms of concept values (e.g., values of the data attribute, dimension, metadata attribute), or entire keys, and storing this as a record in the registry to enable discovery of the original dataset or metadata-set. These are called Constraints in the SDMX-IM. 235 +The Data and Metadata Registration Service allows [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] conformant files and webaccessible databases containing published data and [[reference metadata>>doc:Glossary.Reference metadata.WebHome]] to be registered in the [[SDMX Registry>>doc:Glossary.SDMX Registry.WebHome]]. The registration process MAY validate the content of the [[datasets>>doc:Glossary.Data set.WebHome]] or metadatasets, and MAY extract a concise [[representation>>doc:Glossary.Representation.WebHome]] of the contents in terms of (% style="color:#e74c3c" %)concept(%%) values (e.g., values of the data [[attribute>>doc:Glossary.Attribute.WebHome]], [[dimension>>doc:Glossary.Dimension.WebHome]], metadata [[attribute>>doc:Glossary.Attribute.WebHome]]), or entire keys, and storing this as a record in the registry to enable discovery of the original [[dataset>>doc:Glossary.Data set.WebHome]] or metadata-set. These are called (% style="color:#e74c3c" %)Constraints(%%) in the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-IM. 236 236 237 237 The Data and Metadata Registration Service MAY validate the following, subject to the access control mechanism implemented in the Registry: 238 238 239 -* that the data/metadata provider is allowed to register the dataset or metadataset; 240 -* that the content of the dataset or metadataset meets the validation constraints. This is dependent upon such constraints being defined in the structural repository and which reference the relevant Dataflow, Metadataflow, Data Provider, Metadata Provider, Data Structure Definition, Metadata Structure Definition, Provision Agreement, Metadata Provision Agreement; 241 -* that a queryable data source exists – this would necessitate the registration service querying the service to determine its existence; 242 -* that a simple data source exists (i.e., a file accessible at a URL); 243 -* that the correct Data Structure Definition or Metadata Structure Definition is used by the registered data; 244 -* that the components (Dimensions, Attributes, Measures, Metadata Attributes, etc.) are consistent with the Data Structure Definition or Metadata Structure Definition; 245 -* that the valid representations of the concepts to which these components correspond conform to the definition in the Data Structure Definition or Metadata Structure Definition. The Registration has an action attribute which takes one of the following values: 239 +* that the data/metadata provider is allowed to register the [[dataset>>doc:Glossary.Data set.WebHome]] or metadataset; 240 +* that the content of the [[dataset>>doc:Glossary.Data set.WebHome]] or metadataset meets the validation (% style="color:#e74c3c" %)constraints(%%). This is dependent upon such (% style="color:#e74c3c" %)constraints(%%) being defined in the structural repository and which reference the relevant [[Dataflow>>doc:Glossary.Dataflow.WebHome]], [[Metadataflow>>doc:Glossary.Metadataflow.WebHome]], [[Data Provider>>doc:Glossary.Data provider.WebHome]], Metadata Provider, [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]], [[Metadata Structure Definition>>doc:Glossary.Metadata structure definition.WebHome]], [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]], Metadata [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]]; 241 +* that a queryable [[data source>>doc:Glossary.Data source.WebHome]] exists – this would necessitate the registration service querying the service to determine its existence; 242 +* that a simple [[data source>>doc:Glossary.Data source.WebHome]] exists (i.e., a file accessible at a URL); 243 +* that the correct [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]] or [[Metadata Structure Definition>>doc:Glossary.Metadata structure definition.WebHome]] is used by the registered data; 244 +* that the [[components>>doc:Glossary.Component.WebHome]] ([[Dimensions>>doc:Glossary.Dimension.WebHome]], [[Attributes>>doc:Glossary.Attribute.WebHome]], [[Measures>>doc:Glossary.Measure.WebHome]], Metadata [[Attributes>>doc:Glossary.Attribute.WebHome]], etc.) are consistent with the [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]] or [[Metadata Structure Definition>>doc:Glossary.Metadata structure definition.WebHome]]; 245 +* that the valid [[representations>>doc:Glossary.Representation.WebHome]] of the (% style="color:#e74c3c" %)concepts(%%) to which these [[components>>doc:Glossary.Component.WebHome]] correspond conform to the definition in the [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]] or [[Metadata Structure Definition>>doc:Glossary.Metadata structure definition.WebHome]]. The Registration has an action [[attribute>>doc:Glossary.Attribute.WebHome]] which takes one of the following values: 246 246 247 247 (% style="width:755.294px" %) 248 248 |(% style="width:187px" %)**Action Attribute Value**|(% style="width:566px" %)**Behaviour** ... ... @@ -250,16 +250,16 @@ 250 250 |(% style="width:187px" %)Replace|(% style="width:566px" %)Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request 251 251 |(% style="width:187px" %)Delete|(% style="width:566px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request 252 252 253 -The Registration has three Boolean attributes which may be present to determine how an SDMX compliant dataset or metadataset indexing application must index the datasets or metadatasets upon registration. The indexing application behaviour is as follows: 253 +The Registration has three Boolean [[attributes>>doc:Glossary.Attribute.WebHome]] which may be present to determine how an [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] compliant [[dataset>>doc:Glossary.Data set.WebHome]] or metadataset indexing application must index the [[datasets>>doc:Glossary.Data set.WebHome]] or metadatasets upon registration. The indexing application behaviour is as follows: 254 254 255 255 (% style="width:759.294px" %) 256 256 |(% style="width:191px" %)**Boolean Attribute**|(% style="width:565px" %)**Behaviour if Value is “true”** 257 -|(% style="width:191px" %)indexTimeSeries|(% style="width:565px" %)A compliant indexing application must index all the time series keys (for a Dataset registration) or metadata target values (for a Metadataset registration) 257 +|(% style="width:191px" %)indexTimeSeries|(% style="width:565px" %)A compliant indexing application must index all the time [[series keys>>doc:Glossary.Series key.WebHome]] (for a [[Dataset>>doc:Glossary.Data set.WebHome]] registration) or metadata target values (for a Metadataset registration) 258 258 |(% style="width:191px" %)indexDataSet|(% style="width:565px" %)((( 259 -A compliant indexing application must index the range of actual (present) values for each dimension of the Dataset (for a Dataset registration) or the range of actual (present) values for each Metadata Attribute which takes an enumerated value. 260 -Note that for data this requires much less storage than full key indexing, but this method cannot guarantee that a specific combination of Dimension values (the Key) is actually present in the Dataset 259 +A compliant indexing application must index the range of actual (present) values for each [[dimension>>doc:Glossary.Dimension.WebHome]] of the [[Dataset>>doc:Glossary.Data set.WebHome]] (for a [[Dataset>>doc:Glossary.Data set.WebHome]] registration) or the range of actual (present) values for each Metadata [[Attribute>>doc:Glossary.Attribute.WebHome]] which takes an enumerated value. 260 +Note that for data this requires much less storage than full key indexing, but this method cannot guarantee that a specific combination of [[Dimension>>doc:Glossary.Dimension.WebHome]] values (the Key) is actually present in the [[Dataset>>doc:Glossary.Data set.WebHome]] 261 261 ))) 262 -|(% style="width:191px" %)indexReportingPeriod|(% style="width:565px" %)A compliant indexing application must index the time period range(s) for which data are present in the Dataset. The validity period of the Metadatasets may also be indexed. 262 +|(% style="width:191px" %)indexReportingPeriod|(% style="width:565px" %)A compliant indexing application must index the [[time period>>doc:Glossary.Time period.WebHome]] range(s) for which data are present in the [[Dataset>>doc:Glossary.Data set.WebHome]]. The validity period of the Metadatasets may also be indexed. 263 263 264 264 === {{id name="_Toc93850"/}}5.2.5 Data and Reference Metadata Discovery === 265 265 ... ... @@ -270,54 +270,54 @@ 270 270 271 271 === {{id name="_Toc93851"/}}5.2.6 Subscription and Notification === 272 272 273 -The Subscription and Notification Service implements the following Registry Interfaces: 273 +The [[Subscription>>doc:Glossary.Subscription.WebHome]] and [[Notification>>doc:Glossary.Notification.WebHome]] Service implements the following Registry Interfaces: 274 274 275 275 * SubmitSubscriptionRequest 276 276 * SubmitSubscriptionResponse 277 277 * NotifyRegistryEvent 278 278 279 -The data sharing paradigm relies upon the consumers of data and metadata being able to pull information from data providers’ dissemination systems. For this to work efficiently, a data consumer needs to know when to pull data, i.e., when something has changed in the registry (e.g., a dataset has been updated and re-registered). Additionally, SDMX systems may also want to know if a new Data Structure Definition, Code List or Metadata Structure Definition has been added. The Subscription and Notification Service comprises two parts: subscription management, and notification. 279 +The data sharing paradigm relies upon the consumers of data and metadata being able to pull information from [[data providers>>doc:Glossary.Data provider.WebHome]]’ dissemination systems. For this to work efficiently, a [[data consumer>>doc:Glossary.Data consumer.WebHome]] needs to know when to pull data, i.e., when something has changed in the registry (e.g., a [[dataset>>doc:Glossary.Data set.WebHome]] has been updated and re-registered). Additionally, [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] systems may also want to know if a new [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]], [[Code List>>doc:Glossary.Code list.WebHome]] or [[Metadata Structure Definition>>doc:Glossary.Metadata structure definition.WebHome]] has been added. The [[Subscription>>doc:Glossary.Subscription.WebHome]] and [[Notification>>doc:Glossary.Notification.WebHome]] Service comprises two parts: [[subscription>>doc:Glossary.Subscription.WebHome]] management, and [[notification>>doc:Glossary.Notification.WebHome]]. 280 280 281 -Subscription management involves a user submitting a subscription request which contains: 281 +[[Subscription>>doc:Glossary.Subscription.WebHome]] management involves a user submitting a [[subscription>>doc:Glossary.Subscription.WebHome]] request which contains: 282 282 283 -* a query or constraint expression in terms of a filter which defines the events for which the user is interested (e.g., new data for a specific dataflow, or for a domain category, or changes to a Data Structure Definition). 284 -* a list of URIs or endpoints to which an XML notification message can be sent. Supported endpoint types will be email (mailto~: ) and HTTP POST (a normal http:~/~/ address); 283 +* a query or (% style="color:#e74c3c" %)constraint(%%) expression in terms of a filter which defines the events for which the user is interested (e.g., new data for a specific [[dataflow>>doc:Glossary.Dataflow.WebHome]], or for a domain [[category>>doc:Glossary.Category.WebHome]], or changes to a [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]]). 284 +* a list of URIs or endpoints to which an XML [[notification>>doc:Glossary.Notification.WebHome]] message can be sent. Supported endpoint types will be email (mailto~: ) and HTTP POST (a normal http:~/~/ address); 285 285 * request for a list of submitted subscriptions; 286 -* deletion of a subscription; 286 +* deletion of a [[subscription>>doc:Glossary.Subscription.WebHome]]; 287 287 288 -Notification requires that the structural metadata repository and the provisioning metadata repository monitor any event which is of interest to a user (the object of a subscription request query), and to issue an SDMX notification document to the endpoints specified in the relevant subscriptions. 288 +[[Notification>>doc:Glossary.Notification.WebHome]] requires that the [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] repository and the provisioning [[metadata repository>>doc:Glossary.Metadata repository.WebHome]] monitor any event which is of interest to a user (the object of a [[subscription>>doc:Glossary.Subscription.WebHome]] request query), and to issue an [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] [[notification>>doc:Glossary.Notification.WebHome]] document to the endpoints specified in the relevant subscriptions. 289 289 290 290 === {{id name="_Toc93852"/}}5.2.7 Registry Behaviour === 291 291 292 -The following table defines the behaviour of the SDMX Registry for the various Registry Interface messages. It should be noted, though, that as of SDMX 3.0, an extended versioning scheme newly including semantic versioning is foreseen for all Maintainable Artefacts. Moreover, while the old versioning scheme is allowed, given there is no more a "final" flag, there is no way guaranteeing the consistency across version of a Maintainable, unless semantic versioning is used. 292 +The following table defines the behaviour of the [[SDMX Registry>>doc:Glossary.SDMX Registry.WebHome]] for the various Registry Interface messages. It should be noted, though, that as of [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] 3.0, an extended versioning scheme newly including semantic versioning is foreseen for all [[Maintainable Artefacts>>doc:Glossary.Maintainable artefact.WebHome]]. Moreover, while the old versioning scheme is allowed, given there is no more a "final" flag, there is no way guaranteeing the consistency across (% style="color:#e74c3c" %)version(%%) of a Maintainable, unless semantic versioning is used. 293 293 294 -Given the above, the behaviour described in the following table concerns either draft Artefacts using semantic versioning or any Artefacts using the old versioning scheme. Nevertheless, in the case of semantic versioning the registry must respect the versioning rules when performing the actions below. For example, it is not possible to replace a non-draft Artefact that follows semantic versioning, unless a newer version is introduced according to the semantic versioning rules. Furthermore, even when draft Artefacts are submitted, the registry has to verify semantic versioning is respected against the previous non-draft versions. It is worth noting that the rules for semantic versioning and replacing or maintaining semantically versioned Artefacts applies to externally shared Artefacts. This means that any system may internally perform any change within a version of an Artefact, until the latter is shared outside of that system or becomes public. Then (as also explained in the SDMX Standards Section 6 “Technical Notes”) the Artefacts must adhere to the Semantic Versioning rules. 294 +Given the above, the behaviour described in the following table concerns either draft [[Artefacts>>doc:Glossary.Artefact.WebHome]] using semantic versioning or any [[Artefacts>>doc:Glossary.Artefact.WebHome]] using the old versioning scheme. Nevertheless, in the case of semantic versioning the registry must respect the versioning rules when performing the actions below. For example, it is not possible to replace a non-draft [[Artefact>>doc:Glossary.Artefact.WebHome]] that follows semantic versioning, unless a newer (% style="color:#e74c3c" %)version(%%) is introduced according to the semantic versioning rules. Furthermore, even when draft [[Artefacts>>doc:Glossary.Artefact.WebHome]] are submitted, the registry has to verify semantic versioning is respected against the previous non-draft (% style="color:#e74c3c" %)versions(%%). It is worth noting that the rules for semantic versioning and replacing or maintaining semantically versioned [[Artefacts>>doc:Glossary.Artefact.WebHome]] applies to externally shared [[Artefacts>>doc:Glossary.Artefact.WebHome]]. This means that any system may internally perform any change within a (% style="color:#e74c3c" %)version(%%) of an [[Artefact>>doc:Glossary.Artefact.WebHome]], until the latter is shared outside of that system or becomes public. Then (as also explained in the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”) the [[Artefacts>>doc:Glossary.Artefact.WebHome]] must adhere to the Semantic Versioning rules. 295 295 296 296 (% style="width:757.294px" %) 297 297 |(% style="width:188px" %)**Interface**|(% style="width:542px" %)**Behaviour** 298 298 |(% style="width:188px" %)All|(% style="width:542px" %)((( 299 -1. If the action is set to “replace” (or a maintainable Artefact is PUT or POSTed) then the entire contents of the existing maintainable object in the Registry MUST be replaced by the object submitted. 299 +1. If the action is set to “replace” (or a [[maintainable Artefact>>doc:Glossary.Maintainable artefact.WebHome]] is PUT or POSTed) then the entire contents of the existing maintainable object in the Registry MUST be replaced by the object submitted. 300 300 1. Cross referenced structures MUST exist in either the submitted document (in Structures or Structure Location) or in the registry to which the request is submitted. 301 -1. If the action is set to “delete” (or a maintainable Artefact is DELETEd) then the Registry MUST verify that the object can be deleted. In order to qualify for deletion, the object must: 301 +1. If the action is set to “delete” (or a [[maintainable Artefact>>doc:Glossary.Maintainable artefact.WebHome]] is DELETEd) then the Registry MUST verify that the object can be deleted. In order to qualify for deletion, the object must: 302 302 303 -a) Be a draft version. 303 +a) Be a draft (% style="color:#e74c3c" %)version(%%). 304 304 ))) 305 305 |(% style="width:188px" %) |(% style="width:542px" %)((( 306 306 b) Not be explicitly{{footnote}}With semantic versioning, it is allowed to reference a range of artefacts, e.g., a DSD referencing a Codelist with version 1.2.3+ means all patch versions greater than 1.2.3. This means that deleting 1.2.4-draft does not break integrity of the aforementioned DSD.{{/footnote}} referenced from any other object in the Registry. 307 -4) The semantic versioning rules in the SDMX documentation MUST be obeyed. 307 +4) The semantic versioning rules in the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] documentation MUST be obeyed. 308 308 ))) 309 -|(% style="width:188px" %)Structure submission|(% style="width:542px" %)Structures are submitted at the level of the Maintainable Artefact and the behaviour in “All” above is therefore at the level of the Maintainable Artefact. 310 -|(% style="width:188px" %)SubmitRegistrationRequest|(% style="width:542px" %)If the datasource is a file (simple datasource) then the file MAY be retrieved and indexed according to the Boolean attributes set in the Registration. For a queryable datasource the Registry MAY validate that the source exists and can accept an SDMX data query. 309 +|(% style="width:188px" %)Structure submission|(% style="width:542px" %)Structures are submitted at the (% style="color:#e74c3c" %)level(%%) of the [[Maintainable Artefact>>doc:Glossary.Maintainable artefact.WebHome]] and the behaviour in “All” above is therefore at the (% style="color:#e74c3c" %)level(%%) of the [[Maintainable Artefact>>doc:Glossary.Maintainable artefact.WebHome]]. 310 +|(% style="width:188px" %)SubmitRegistrationRequest|(% style="width:542px" %)If the datasource is a file (simple datasource) then the file MAY be retrieved and indexed according to the Boolean [[attributes>>doc:Glossary.Attribute.WebHome]] set in the Registration. For a queryable datasource the Registry MAY validate that the source exists and can accept an [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] data query. 311 311 312 312 = {{id name="_Toc93853"/}}6 Identification of SDMX Objects = 313 313 314 314 == {{id name="_Toc93854"/}}6.1 Identification, Versioning, and Maintenance == 315 315 316 -All major classes of the SDMX Information model inherit from one of: 316 +All major classes of the [[SDMX Information model>>doc:Glossary.SDMX Information Model.WebHome]] inherit from one of: 317 317 318 318 * //**IdentifiableArtefact**// – this gives an object the ability to be uniquely identified (see following section on identification), to have a user-defined URI, and to have multi-lingual annotations. 319 319 * //**NameableArtefact**// – this has all of the features of //IdentifiableArtefact// plus the ability to have a multi-lingual name and description. 320 -* //**VersionableArtefact**// – this has all of the above features plus a version number, according to the SDMX versioning rules in SDMX Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”, and a validity period. 320 +* //**VersionableArtefact**// – this has all of the above features plus a (% style="color:#e74c3c" %)version(%%) number, according to the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules in [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”, and a validity period. 321 321 * //**MaintainableArtefact**// – this has all of the above features, plus registry and structure URIs, and an association to the maintenance organisation of the object. 322 322 323 323 === {{id name="_Toc93855"/}}6.1.1 Identification, Naming, Versioning, and Maintenance Model === ... ... @@ -326,7 +326,7 @@ 326 326 327 327 **Figure 5: Class diagram of fundamental artefacts in the SDMX-IM** 328 328 329 -The table below shows the identification and related data attributes to be stored in a registry for objects that are one of: 329 +The table below shows the identification and related data [[attributes>>doc:Glossary.Attribute.WebHome]] to be stored in a registry for objects that are one of: 330 330 331 331 * //nnotable// 332 332 * //Identifiable// ... ... @@ -349,11 +349,11 @@ 349 349 |(% style="width:241px" %)Name in the form of InternationalString|(% style="width:156px" %)M|string|(% style="width:457px" %)This can have language specific variants. 350 350 |(% style="width:241px" %)Description in the form of InternationalString|(% style="width:156px" %)C|string|(% style="width:457px" %)This can have language specific variants. 351 351 |(% rowspan="4" %)//Versionable//|(% style="width:241px" %)All content as for //Identifiable// plus|(% style="width:156px" %) | |(% style="width:457px" %) 352 -|(% style="width:241px" %)version|(% style="width:156px" %)M|string|(% style="width:457px" %)This is the version number according to SDMX versioning rules. 352 +|(% style="width:241px" %)(% style="color:#e74c3c" %)version|(% style="width:156px" %)M|string|(% style="width:457px" %)This is the (% style="color:#e74c3c" %)version(%%) number according to [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules. 353 353 |(% style="width:241px" %)validFrom|(% style="width:156px" %)C|Date/time|(% style="width:457px" %) 354 354 |(% style="width:241px" %)validTo|(% style="width:156px" %)C|Date/time|(% style="width:457px" %) 355 355 |//Maintainable//|(% style="width:241px" %)All content as for //Versionable// plus|(% style="width:156px" %) | |(% style="width:457px" %) 356 -| |(% style="width:241px" %)isExternalReference|(% style="width:156px" %)C|boolean|(% style="width:457px" %)Value of “true” indicates that the actual resource is held outside of this registry. The actual reference is given in the registry URI or the structureURL, each of which must return a valid SDMX-ML file. 356 +| |(% style="width:241px" %)isExternalReference|(% style="width:156px" %)C|boolean|(% style="width:457px" %)Value of “true” indicates that the actual resource is held outside of this registry. The actual reference is given in the registry URI or the structureURL, each of which must return a valid [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]] file. 357 357 | |(% style="width:241px" %)serviceURL|(% style="width:156px" %)C|string|(% style="width:457px" %)The url of the service that can be queried for this resource. 358 358 | |(% style="width:241px" %)structureURL|(% style="width:156px" %)C|string|(% style="width:457px" %)The url of the resource. 359 359 | |(% style="width:241px" %)(Maintenance) organisationId|(% style="width:156px" %)M|string|(% style="width:457px" %)The object must be linked to a maintenance organisation, i.e., Agency or Metadata Provider. ... ... @@ -365,26 +365,26 @@ 365 365 366 366 === {{id name="_Toc93857"/}}6.2.1 Agencies and Metadata Providers === 367 367 368 -The Maintenance Agency in SDMX is maintained in an Agency Scheme which itself is a sub class of Organisation Scheme – this is shown in the class diagram below. 368 +The [[Maintenance Agency>>doc:Glossary.Maintenance agency.WebHome]] in [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] is maintained in an [[Agency Scheme>>doc:Glossary.Agency scheme.WebHome]] which itself is a sub class of Organisation Scheme – this is shown in the class diagram below. 369 369 370 370 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_c71516c5.jpg||height="313" width="554"]] 371 371 372 372 **Figure 6: Agency Scheme Model** 373 373 374 -The Agency in SDMX is extremely important. The Agency Id system used in SDMX is an nlevel structure. The top level of this structure is maintained by SDMX. Any Agency in this top level can declare sub agencies and any sub agency can also declare sub agencies. The Agency Scheme has a fixed id and version (version ‘1.0’) and is never declared explicitly in the SDMX object identification mechanism. 374 +The Agency in [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] is extremely important. The Agency Id system used in [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] is an nlevel structure. The top (% style="color:#e74c3c" %)level(%%) of this structure is maintained by [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]. Any Agency in this top (% style="color:#e74c3c" %)level(%%) can declare sub agencies and any sub agency can also declare sub agencies. The [[Agency Scheme>>doc:Glossary.Agency scheme.WebHome]] has a fixed id and (% style="color:#e74c3c" %)version(%%) ((% style="color:#e74c3c" %)version(%%) ‘1.0’) and is never declared explicitly in the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] object identification mechanism. 375 375 376 -In order to achieve this SDMX adopts the following rules: 376 +In order to achieve this [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] adopts the following rules: 377 377 378 -* Agencies are maintained in an Agency Scheme (which is a sub class of Organisation Scheme). 379 -* The agency of the Agency Scheme must also be declared in a (different) Agency Scheme. 380 -* The “top-level” agency is SDMX and maintains the “top-level” Agency Scheme. 381 -* 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. 382 -* The AgencyScheme has a fixed version, i.e., ‘1.0’, hence it is an exception from the Semantic Versioning that other Artefacts follow. 378 +* Agencies are maintained in an [[Agency Scheme>>doc:Glossary.Agency scheme.WebHome]] (which is a sub class of Organisation Scheme). 379 +* The agency of the [[Agency Scheme>>doc:Glossary.Agency scheme.WebHome]] must also be declared in a (different) [[Agency Scheme>>doc:Glossary.Agency scheme.WebHome]]. 380 +* The “top-(% style="color:#e74c3c" %)level(%%)” agency is [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] and maintains the “top-(% style="color:#e74c3c" %)level(%%)” [[Agency Scheme>>doc:Glossary.Agency scheme.WebHome]]. 381 +* Agencies registered in the top-(% style="color:#e74c3c" %)level(%%) scheme can themselves maintain a single [[Agency Scheme>>doc:Glossary.Agency scheme.WebHome]]. Agencies in these second-tier schemes can themselves maintain a single [[Agency Scheme>>doc:Glossary.Agency scheme.WebHome]] and so on. 382 +* The AgencyScheme has a fixed (% style="color:#e74c3c" %)version(%%), i.e., ‘1.0’, hence it is an exception from the Semantic Versioning that other [[Artefacts>>doc:Glossary.Artefact.WebHome]] follow. 383 383 * There can be only one AgencyScheme maintained by any one Agency. It has a fixed id of AGENCIES. 384 -* The /hierarchy of Organisation is not inherited by Maintenance Agency – thus each Agency Scheme is a flat list of Maintenance Agencies. 385 -* 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. 384 +* The /hierarchy of Organisation is not inherited by [[Maintenance Agency>>doc:Glossary.Maintenance agency.WebHome]] – thus each [[Agency Scheme>>doc:Glossary.Agency scheme.WebHome]] is a flat list of Maintenance Agencies. 385 +* The format of the agency identifier is agencyID.agencyID etc. The top-(% style="color:#e74c3c" %)level(%%) agency in this identification mechanism is the agency registered in the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] [[agency scheme>>doc:Glossary.Agency scheme.WebHome]]. 386 386 387 -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. 387 +In other words, [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] is not a part of the hierarchical ID structure for agencies. However, [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] is, itself, a [[maintenance agency>>doc:Glossary.Maintenance agency.WebHome]] and is contained in the top-(% style="color:#e74c3c" %)level(%%) [[Agency Scheme>>doc:Glossary.Agency scheme.WebHome]]. 388 388 389 389 This supports a hierarchical structure of agencyID. 390 390 ... ... @@ -392,14 +392,16 @@ 392 392 393 393 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_eaceb05e.jpg||height="251" width="432"]] 394 394 395 -**Figure 7: Example of Hierarchic Structure of Agencies ** The following organizations maintain an Agency Scheme.395 +**Figure 7: Example of Hierarchic Structure of Agencies ** 396 396 397 +The following organizations maintain an Agency Scheme. 398 + 397 397 * SDMX – contains Agencies AA, BB 398 398 * AA – contains Agencies CC, DD 399 399 * BB – contains Agencies CC, DD 400 400 * DD – Contains Agency EE 401 401 402 -Each agency is identified by its full hierarchy excluding SDMX. 404 +Each agency is identified by its full [[hierarchy>>doc:Glossary.Hierarchy.WebHome]] excluding SDMX. 403 403 404 404 e.g., the id of EE as an agencyID is AA.DD.EE 405 405 ... ... @@ -409,29 +409,30 @@ 409 409 410 410 **Figure 8: Example Showing Use of Agency Identifiers** 411 411 412 -Each of these maintenance agencies has an identical Code list with the Id CL_BOP. However, each is uniquely identified by means of the hierarchic agency structure. 414 +Each of these [[maintenance agencies>>doc:Glossary.Maintenance agency.WebHome]] has an identical [[Code list>>doc:Glossary.Code list.WebHome]] with the Id CL_BOP. However, each is uniquely identified by means of the hierarchic agency structure. 413 413 414 -Following the same principles, the Metadata Provider is the maintenance organisation for a special subset of Maintainable Artefacts, i.e., the Metadatasets; the latter are the containers of reference metadata combined with a target that those metadata refer to. 416 +Following the same principles, the Metadata Provider is the maintenance organisation for a special subset of [[Maintainable Artefacts>>doc:Glossary.Maintainable artefact.WebHome]], i.e., the Metadatasets; the latter are the containers of [[reference metadata>>doc:Glossary.Reference metadata.WebHome]] combined with a target that those metadata refer to. 415 415 416 416 === {{id name="_Toc93858"/}}6.2.2 Universal Resource Name (URN) === 417 417 418 418 ==== 6.2.2.1 Introduction ==== 419 419 420 -To provide interoperability between SDMX Registry/Repositories in a distributed network environment, it is important to have a scheme for uniquely identifying (and thus accessing) all first-class (Identifiable) SDMX-IM objects. Most of these unique identifiers are composite (containing maintenance agency, or parent object identifiers), and there is a need to be able to construct a unique reference as a single string. This is achieved by having a globally unique identifier called a universal resource name (URN) which is generated from the actual identification components in the SDMX-RR APIs. In other words, the URN for any Identifiable Artefact is constructed from its component identifiers (agency, id, version etc.). 422 +To provide interoperability between [[SDMX Registry>>doc:Glossary.SDMX Registry.WebHome]]/Repositories in a distributed network environment, it is important to have a scheme for uniquely identifying (and thus accessing) all first-class (Identifiable) [[SDMX-IM>>doc:Glossary.SDMX Information Model.WebHome]] objects. Most of these unique identifiers are composite (containing [[maintenance agency>>doc:Glossary.Maintenance agency.WebHome]], or parent object identifiers), and there is a need to be able to construct a unique reference as a single string. This is achieved by having a globally unique identifier called a universal resource name (URN) which is generated from the actual identification [[components>>doc:Glossary.Component.WebHome]] in the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-RR APIs. In other words, the URN for any [[Identifiable Artefact>>doc:Glossary.Identifiable artefact.WebHome]] is constructed from its [[component>>doc:Glossary.Component.WebHome]] identifiers (agency, id, (% style="color:#e74c3c" %)version(%%) etc.). 421 421 422 422 ==== 6.2.2.2 URN Structure ==== 423 423 424 -===== **//__Case Rules for URN__//** ===== 426 +(% class="wikigeneratedid" id="HCaseRulesforURN" %) 427 +**//__Case Rules for URN__//** 425 425 426 426 For the URN, all parts of the string are case sensitive. The generic structure of the URN is as follows: 427 427 428 -SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobjectid(maintainedobject-version).*containerobject-id.object-id 431 +SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobjectid(maintainedobject-(% style="color:#e74c3c" %)version(%%)).*containerobject-id.object-id 429 429 430 430 ~* this can repeat and may not be present (see explanation below) 431 431 432 -Note that in the SDMX Information Model there are no concrete Versionable Artefacts that are not a Maintainable Artefact. For this reason, the only version information that is allowed is for the maintainable object. 435 +Note that in the [[SDMX Information Model>>doc:Glossary.SDMX Information Model.WebHome]] there are no concrete [[Versionable Artefacts>>doc:Glossary.Versionable artefact.WebHome]] that are not a [[Maintainable Artefact>>doc:Glossary.Maintainable artefact.WebHome]]. For this reason, the only (% style="color:#e74c3c" %)version(%%) information that is allowed is for the maintainable object. 433 433 434 -The Maintenance agency identifier is separated from the maintainable artefact identifier by a colon ‘:’. All other identifiers in the SDMX URN syntax are separated by a period ‘.’. The version information is encapsulated in parentheses ‘()’ and adheres to the SDMX versioning rules, as explained in SDMX Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning. 437 +The [[Maintenance agency>>doc:Glossary.Maintenance agency.WebHome]] identifier is separated from the [[maintainable artefact>>doc:Glossary.Maintainable artefact.WebHome]] identifier by a colon ‘:’. All other identifiers in the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] URN syntax are separated by a period ‘.’. The (% style="color:#e74c3c" %)version(%%) information is encapsulated in parentheses ‘()’ and adheres to the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules, as explained in [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning. 435 435 436 436 ==== 6.2.2.3 Explanation of the generic structure ==== 437 437 ... ... @@ -456,13 +456,13 @@ 456 456 457 457 **maintainable-object-id** is the identifier of the maintainable object. This will always be present as all identifiable objects are either a maintainable object or contained in a maintainable object. 458 458 459 -**maintainable-object-version** is the version, according to the SDMX versioning rules, of the maintainable object and is enclosed in parentheses ‘()’, which are always present. 462 +**maintainable-object-(% style="color:#e74c3c" %)version(%%)** is the (% style="color:#e74c3c" %)version(%%), according to the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules, of the maintainable object and is enclosed in parentheses ‘()’, which are always present. 460 460 461 -**container-object-id** is the identifier of an intermediary object that contains the actual object which the URN is identifying. It is not mandatory as many actual objects do not have an intermediary container object. For instance, a Code is in a maintained object (Codelist) and has no intermediary container object, whereas a MetadataAttribute has an intermediary container object (MetadataAttributeDescriptor) and may have an intermediary container object, which is its parent MetadataAttribute. For this reason, the container object id may repeat, with each repetition identifying the object at the next-lower level in its hierarchy. Note that if there is only a single containing object in the model then it is NOT included in the URN structure. This applies to AttributeDescriptor, DimensionDescriptor, and MeasureDescriptor where there can be only one such object and this object has a fixed id. Therefore, whilst each of these has a URN, the id of the AttributeDescriptor, DimensionDescriptor, and MeasureDescriptor is not included when the actual object is a DataAttribute or a Dimension/ TimeDimension, or a Measure. 464 +**container-object-id** is the identifier of an intermediary object that contains the actual object which the URN is identifying. It is not mandatory as many actual objects do not have an intermediary container object. For instance, a [[Code>>doc:Glossary.Code.WebHome]] is in a maintained object (Codelist) and has no intermediary container object, whereas a MetadataAttribute has an intermediary container object (MetadataAttributeDescriptor) and may have an intermediary container object, which is its parent MetadataAttribute. For this reason, the container object id may repeat, with each repetition identifying the object at the next-lower (% style="color:#e74c3c" %)level(%%) in its [[hierarchy>>doc:Glossary.Hierarchy.WebHome]]. Note that if there is only a single containing object in the model then it is NOT included in the URN structure. This applies to AttributeDescriptor, DimensionDescriptor, and MeasureDescriptor where there can be only one such object and this object has a fixed id. Therefore, whilst each of these has a URN, the id of the AttributeDescriptor, DimensionDescriptor, and MeasureDescriptor is not included when the actual object is a DataAttribute or a Dimension/ TimeDimension, or a Measure. 462 462 463 -Note that although a Code can have a parent Code and a Concept can have a parent Concept these are maintained in a flat structure and therefore do not have a containerobject-id. 466 +Note that although a [[Code>>doc:Glossary.Code.WebHome]] can have a parent [[Code>>doc:Glossary.Code.WebHome]] and a (% style="color:#e74c3c" %)Concept(%%) can have a parent (% style="color:#e74c3c" %)Concept(%%) these are maintained in a flat structure and therefore do not have a containerobject-id. 464 464 465 -For example, the sequence is agency:DSDid(version).DimensionId and not agency:DSDid(version).DimensionDescriptorId.DimensionId. 468 +For example, the sequence is agency:DSDid((% style="color:#e74c3c" %)version(%%)).DimensionId and not agency:DSDid((% style="color:#e74c3c" %)version(%%)).DimensionDescriptorId.DimensionId. 466 466 467 467 object-id is the identifier of the actual object unless the actual object is a //Maintainable// object. If present it is always the last id and is not followed by any other character. 468 468 ... ... @@ -470,56 +470,56 @@ 470 470 471 471 __Actual object is a maintainable__ 472 472 473 -SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version) 476 +SDMXPrefix.[[SDMX-IM>>doc:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid((% style="color:#e74c3c" %)version(%%)) 474 474 475 475 __Actual object is contained in a maintained object with no intermediate containing object__ 476 476 477 -SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version).object-id 480 +SDMXPrefix.[[SDMX-IM>>doc:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid((% style="color:#e74c3c" %)version(%%)).object-id 478 478 479 479 __Actual object is contained in a maintained object with an intermediate containing object__ 480 480 481 -SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version).contained-object-id.object-id 484 +SDMXPrefix.[[SDMX-IM>>doc:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid((% style="color:#e74c3c" %)version(%%)).contained-object-id.object-id 482 482 483 483 __Actual object is contained in a maintained object with no intermediate containing__ __object but__ __the object type itself is hierarchical__ 484 484 485 -In this case the object id may not be unique in itself but only within the context of the hierarchy. In the general syntax of the URN all intermediary objects in the structure (with the exception, of course, of the maintained object) are shown as a contained object. An example here would be a Category in a CategoryScheme. The Category is hierarchical, and all intermediate Categories are shown as a contained object. The example below shows the generic structure for CategoryScheme/ Category/ Category. 488 +In this case the object id may not be unique in itself but only within the context of the [[hierarchy>>doc:Glossary.Hierarchy.WebHome]]. In the general syntax of the URN all intermediary objects in the structure (with the exception, of course, of the maintained object) are shown as a contained object. An example here would be a [[Category>>doc:Glossary.Category.WebHome]] in a CategoryScheme. The [[Category>>doc:Glossary.Category.WebHome]] is hierarchical, and all intermediate [[Categories>>doc:Glossary.Category.WebHome]] are shown as a contained object. The example below shows the generic structure for CategoryScheme/ [[Category>>doc:Glossary.Category.WebHome]]/ [[Category>>doc:Glossary.Category.WebHome]]. 486 486 487 -SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version).contained-object-id.object-id 490 +SDMXPrefix.[[SDMX-IM>>doc:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid((% style="color:#e74c3c" %)version(%%)).contained-object-id.object-id 488 488 489 489 Actual object is contained in a maintained object with an intermediate containing object and the object type itself is hierarchical 490 490 491 -In this case the generic syntax is the same as for the example above as the parent object is regarded as a containing object, even if it is of the same type. An example here is a MetadataAttribute where the contained objects are MetadataAttributeDescriptor (first contained object id) and MetadataAttribute (subsequent contained object ids). The example below shows the generic structure for MSD/ MetadataAttributeDescriptor/ MetadataAttribute/ MetadataAttribute 494 +In this case the generic syntax is the same as for the example above as the parent object is regarded as a containing object, even if it is of the same type. An example here is a MetadataAttribute where the contained objects are MetadataAttributeDescriptor (first contained object id) and MetadataAttribute (subsequent contained object ids). The example below shows the generic structure for [[MSD>>doc:Glossary.Metadata structure definition.WebHome]]/ MetadataAttributeDescriptor/ MetadataAttribute/ MetadataAttribute 492 492 493 -SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version).contained-object-id.contained-object-id contained-objectid.object-id 496 +SDMXPrefix.[[SDMX-IM>>doc:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid((% style="color:#e74c3c" %)version(%%)).contained-object-id.contained-object-id contained-objectid.object-id 494 494 495 495 ===== //__**Concrete Examples of the URN Structure**__// ===== 496 496 497 -The Data Structure Definition CRED_EXT_DEBT of legacy version 2.1 maintained by the toplevel Agency TFFS would have the URN: 500 +The [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]] CRED_EXT_DEBT of legacy (% style="color:#e74c3c" %)version(%%) 2.1 maintained by the toplevel Agency TFFS would have the URN: 498 498 499 499 urn:sdmx:org.sdmx.infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(2.1) 500 500 501 -The URN for a code for Argentina maintained by ISO in the code list CL_3166A2 of semantic version 1.0.0 would be: 504 +The URN for a [[code>>doc:Glossary.Code.WebHome]] for Argentina maintained by ISO in the [[code list>>doc:Glossary.Code list.WebHome]] CL_3166A2 of semantic (% style="color:#e74c3c" %)version(%%) 1.0.0 would be: 502 502 503 503 urn:sdmx:org.sdmx.infomodel.codelist.Code=ISO:CL_3166A2(1.0.0).AR 504 504 505 -The URN for a category (id of 1) which has parent category (id of 2) maintained by SDMX in the category scheme SUBJECT_MATTER_DOMAINS of the semantic extended version 1.0.0draft would be: 508 +The URN for a [[category>>doc:Glossary.Category.WebHome]] (id of 1) which has parent [[category>>doc:Glossary.Category.WebHome]] (id of 2) maintained by [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] in the [[category scheme>>doc:Glossary.Category scheme.WebHome]] SUBJECT_MATTER_DOMAINS of the semantic extended (% style="color:#e74c3c" %)version(%%) 1.0.0draft would be: 506 506 507 507 urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:SUBJECT_MATT ER_DOMAINS(1.0.0-draft).1.2 508 508 509 -The URN for a Metadata Attribute maintained by SDMX in the MSD CONTACT_METADATA of semantic version 1.0.0 where the hierarchy of the Metadata Attribute is CONTACT_DETAILS/CONTACT_NAME would be: 512 +The URN for a Metadata [[Attribute>>doc:Glossary.Attribute.WebHome]] maintained by [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] in the [[MSD>>doc:Glossary.Metadata structure definition.WebHome]] CONTACT_METADATA of semantic (% style="color:#e74c3c" %)version(%%) 1.0.0 where the [[hierarchy>>doc:Glossary.Hierarchy.WebHome]] of the Metadata [[Attribute>>doc:Glossary.Attribute.WebHome]] is CONTACT_DETAILS/CONTACT_NAME would be: 510 510 511 511 urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataAttribute=SDMX: CONTACT_METADATA(1.0.0).CONTACT_DETAILS.CONTACT_NAME 512 512 513 -The TFFS defines ABC as a sub-Agency of TFFS then the URN of a Dataflow maintained by ABC and identified as EXTERNAL_DEBT of semantic version 1.0.0 would be: 516 +The TFFS defines ABC as a sub-Agency of TFFS then the URN of a [[Dataflow>>doc:Glossary.Dataflow.WebHome]] maintained by ABC and identified as EXTERNAL_DEBT of semantic (% style="color:#e74c3c" %)version(%%) 1.0.0 would be: 514 514 515 515 urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=TFFS.ABC:EXTERNAL_ DEBT(1.0.0) 516 516 517 -The SDMX-RR MUST support this globally unique identification scheme. The SDMX-RR MUST be able to create the URN from the individual identification attributes submitted and to transform the URN to these identification attributes. The identification attributes are: 520 +The [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-RR MUST support this globally unique identification scheme. The [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-RR MUST be able to create the URN from the individual identification [[attributes>>doc:Glossary.Attribute.WebHome]] submitted and to transform the URN to these identification [[attributes>>doc:Glossary.Attribute.WebHome]]. The identification [[attributes>>doc:Glossary.Attribute.WebHome]] are: 518 518 519 -* **Identifiable and Nameable Artefacts**: id (in some cases this id may be hierarchic) 520 -* **Maintainable Artefacts**: id, version, agencyId 522 +* **Identifiable and [[Nameable Artefacts>>doc:Glossary.Nameable artefact.WebHome]]**: id (in some cases this id may be hierarchic) 523 +* **[[Maintainable Artefacts>>doc:Glossary.Maintainable artefact.WebHome]]**: id, (% style="color:#e74c3c" %)version(%%), agencyId 521 521 522 -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. 525 +The [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-RR MUST be able to resolve the unique identifier of an [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] [[artefact>>doc:Glossary.Artefact.WebHome]] and to produce an [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]] rendering of that [[artefact>>doc:Glossary.Artefact.WebHome]] if it is located in the Registry. 523 523 524 524 === {{id name="_Toc93859"/}}6.2.3 Table of SDMX-IM Packages and Classes === 525 525 ... ... @@ -606,7 +606,7 @@ 606 606 607 607 === {{id name="_Toc93860"/}}6.2.4 URN Identification components of SDMX objects === 608 608 609 -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. 612 +The table below describes the identification [[components>>doc:Glossary.Component.WebHome]] for all [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] object types that have identification. Note the actual [[attributes>>doc:Glossary.Attribute.WebHome]] are all ‘id’ but have been prefixed by their class name or multiple class names to show navigation, e.g., ‘conceptSchemeAgencyId’ is really the ‘Id’ [[attribute>>doc:Glossary.Attribute.WebHome]] of the Agency class that is associated to the ConceptScheme. 610 610 611 611 Note that for brevity the URN examples omit the prefix (classnames in italics indicate maintainable objects, keywords in bold indicate fixed value) All URNs have the prefix: 612 612 ... ... @@ -699,7 +699,7 @@ 699 699 |(% style="width:229px" %)Subscription|(% style="width:645px" %)((( 700 700 The Subscription is not itself an Identifiable Artefact and therefore it does not follow the rules for URN structure. 701 701 The name of the URN is registryURN There is no pre-determined format. 702 -)))|(% style="width:1015px" %)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. 705 +)))|(% style="width:1015px" %)This cannot be generated by a common mechanism as [[subscriptions>>doc:Glossary.Subscription.WebHome]], although maintainable in the sense that they can be submitted and deleted, are not mandated to be created by a [[maintenance agency>>doc:Glossary.Maintenance agency.WebHome]] and have no versioning mechanism. It is therefore the responsibility of the target registry to generate a unique Id for the [[Subscription>>doc:Glossary.Subscription.WebHome]], and for the application creating the [[subscription>>doc:Glossary.Subscription.WebHome]] to store the registry URN that is returned from the registry in the [[subscription>>doc:Glossary.Subscription.WebHome]] response message. 703 703 |(% style="width:229px" %)TimeDimension|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).timeDimensionId|(% style="width:1015px" %)TFFS:EXT_DEBT(1.0.0).TIME_PERIOD 704 704 |(% style="width:229px" %)Transformation|(% style="width:645px" %)transformationSchemeAgencyId transformationSchemeId(version) transformationId|(% style="width:1015px" %)ECB:TRANSFORMATION_SCHEME(1.0.0).TRANS_1 705 705 |(% style="width:229px" %)//TransformationScheme//|(% style="width:645px" %)transformationSchemeAgencyId transformationSchemeId(version)|(% style="width:1015px" %)ECB: TRANSFORMATION_SCHEME(1.0.0) ... ... @@ -723,85 +723,85 @@ 723 723 724 724 === {{id name="_Toc93863"/}}7.1.1 Introduction === 725 725 726 -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.) 729 +The [[SDMX Registry>>doc:Glossary.SDMX Registry.WebHome]] must have the ability to support agencies in their role of defining and disseminating [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] [[artefacts>>doc:Glossary.Artefact.WebHome]]. These [[artefacts>>doc:Glossary.Artefact.WebHome]] include [[data structure definitions>>doc:Glossary.Data structure definition.WebHome]], [[code lists>>doc:Glossary.Code list.WebHome]], (% style="color:#e74c3c" %)concepts(%%) etc. and are fully defined in the [[SDMX-IM>>doc:Glossary.SDMX Information Model.WebHome]]. An authenticated agency may submit valid [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] definitions which must be stored in the registry. Note that the term “[[structural metadata>>doc:Glossary.Structural metadata.WebHome]]” refers as a general term to all structural [[components>>doc:Glossary.Component.WebHome]] ([[Data Structure Definitions>>doc:Glossary.Data structure definition.WebHome]], [[Metadata Structure Definitions>>doc:Glossary.Metadata structure definition.WebHome]], [[Code Lists>>doc:Glossary.Code list.WebHome]], [[Concept Schemes>>doc:Glossary.Concept scheme.WebHome]], etc.) 727 727 728 -At a minimum, structural metadata definitions may be submitted to and queried from the registry via an HTTP/HTTPS POST in the form of one of the SDMX-ML messages for structural metadata and the SDMX RESTful API for structure queries. The message may contain all structural metadata items for the whole registry, structural metadata items for one maintenance agency, or individual structural metadata items. 731 +At a minimum, [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] definitions may be submitted to and queried from the registry via an HTTP/HTTPS POST in the form of one of the [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]] messages for [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] and the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] RESTful API for structure queries. The message may contain all [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] items for the whole registry, [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] items for one [[maintenance agency>>doc:Glossary.Maintenance agency.WebHome]], or individual [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] items. 729 729 730 -Structural metadata items 733 +[[Structural metadata>>doc:Glossary.Structural metadata.WebHome]] items 731 731 732 -* may only be modified by the maintenance agency which created them; 735 +* may only be modified by the [[maintenance agency>>doc:Glossary.Maintenance agency.WebHome]] which created them; 733 733 * may only be deleted by the agency which created them; 734 734 * may not be deleted if they are referenced from other constructs in the Registry. 735 735 736 -The level of granularity for the maintenance of SDMX Structural Metadata objects in the registry is the Maintainable Artefact. Especially for Item Schemes, though, partial maintenance may be performed, i.e., at the level of the Item, by submitting an Item Scheme with the 'isPartial' flag set and a reduced set of Items. 739 +The (% style="color:#e74c3c" %)level(%%) of granularity for the maintenance of [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] [[Structural Metadata>>doc:Glossary.Structural metadata.WebHome]] objects in the registry is the [[Maintainable Artefact>>doc:Glossary.Maintainable artefact.WebHome]]. Especially for [[Item Schemes>>doc:Glossary.Item scheme.WebHome]], though, partial maintenance may be performed, i.e., at the (% style="color:#e74c3c" %)level(%%) of the Item, by submitting an [[Item Scheme>>doc:Glossary.Item scheme.WebHome]] with the 'isPartial' flag set and a reduced set of Items. 737 737 738 -The following table lists the Maintainable Artefacts. 741 +The following table lists the [[Maintainable Artefacts>>doc:Glossary.Maintainable artefact.WebHome]]. 739 739 740 740 (% style="width:881.294px" %) 741 741 |(% colspan="2" style="width:522px" %)**Maintainable Artefacts**|(% style="width:490px" %)**Content** 742 742 |(% style="width:198px" %)**Abstract Class**|(% style="width:324px" %)**Concrete Class**|(% style="width:490px" %) 743 -|(% style="width:198px" %)Item Scheme|(% style="width:324px" %)Codelist|(% style="width:490px" %)Code 744 -|(% style="width:198px" %) |(% style="width:324px" %)Concept Scheme|(% style="width:490px" %)Concept 745 -|(% style="width:198px" %) |(% style="width:324px" %)Category Scheme|(% style="width:490px" %)Category 746 -|(% style="width:198px" %) |(% style="width:324px" %)Organisation Unit Scheme|(% style="width:490px" %)Organisation Unit 747 -|(% style="width:198px" %) |(% style="width:324px" %)Agency Scheme|(% style="width:490px" %)Agency 748 -|(% style="width:198px" %) |(% style="width:324px" %)Data Provider Scheme|(% style="width:490px" %)Data Provider 746 +|(% style="width:198px" %)[[Item Scheme>>doc:Glossary.Item scheme.WebHome]]|(% style="width:324px" %)Codelist|(% style="width:490px" %)[[Code>>doc:Glossary.Code.WebHome]] 747 +|(% style="width:198px" %) |(% style="width:324px" %)[[Concept Scheme>>doc:Glossary.Concept scheme.WebHome]]|(% style="width:490px" %)(% style="color:#e74c3c" %)Concept 748 +|(% style="width:198px" %) |(% style="width:324px" %)[[Category Scheme>>doc:Glossary.Category scheme.WebHome]]|(% style="width:490px" %)[[Category>>doc:Glossary.Category.WebHome]] 749 +|(% style="width:198px" %) |(% style="width:324px" %)[[Organisation Unit Scheme>>doc:Glossary.Organisation unit scheme.WebHome]]|(% style="width:490px" %)Organisation Unit 750 +|(% style="width:198px" %) |(% style="width:324px" %)[[Agency Scheme>>doc:Glossary.Agency scheme.WebHome]]|(% style="width:490px" %)Agency 751 +|(% style="width:198px" %) |(% style="width:324px" %)[[Data Provider Scheme>>doc:Glossary.Data provider scheme.WebHome]]|(% style="width:490px" %)[[Data Provider>>doc:Glossary.Data provider.WebHome]] 749 749 |(% style="width:198px" %) |(% style="width:324px" %)Metadata Provider Scheme|(% style="width:490px" %)Metadata Provider 750 -|(% style="width:198px" %) |(% style="width:324px" %)Data Consumer Scheme|(% style="width:490px" %)Data Consumer 751 -|(% style="width:198px" %) |(% style="width:324px" %)Reporting Taxonomy|(% style="width:490px" %)Reporting Category 753 +|(% style="width:198px" %) |(% style="width:324px" %)[[Data Consumer Scheme>>doc:Glossary.Data consumer scheme.WebHome]]|(% style="width:490px" %)[[Data Consumer>>doc:Glossary.Data consumer.WebHome]] 754 +|(% style="width:198px" %) |(% style="width:324px" %)Reporting Taxonomy|(% style="width:490px" %)Reporting [[Category>>doc:Glossary.Category.WebHome]] 752 752 |(% style="width:198px" %) |(% style="width:324px" %)Transformation Scheme|(% style="width:490px" %)Transformation 753 753 |(% style="width:198px" %) |(% style="width:324px" %)Custom Type Scheme|(% style="width:490px" %)Custom Type 754 754 |(% style="width:198px" %) |(% style="width:324px" %)Name Personalisation Scheme|(% style="width:490px" %)Name Personalisation 755 -|(% style="width:198px" %) |(% style="width:324px" %)Vtl Mapping Scheme|(% style="width:490px" %)Vtl Codelist Mapping Vtl Concept Mapping 758 +|(% style="width:198px" %) |(% style="width:324px" %)[[Vtl>>doc:Glossary.Validation and transformation language.WebHome]] Mapping Scheme|(% style="width:490px" %)[[Vtl>>doc:Glossary.Validation and transformation language.WebHome]] Codelist Mapping [[Vtl>>doc:Glossary.Validation and transformation language.WebHome]] (% style="color:#e74c3c" %)Concept(%%) Mapping 756 756 |(% style="width:198px" %) |(% style="width:324px" %)Ruleset Scheme|(% style="width:490px" %)Ruleset 757 757 |(% style="width:198px" %) |(% style="width:324px" %)User Defined Operator Scheme|(% style="width:490px" %)User Defined Operator 758 758 |(% style="width:198px" %)Enumerated List|(% style="width:324px" %)ValueList|(% style="width:490px" %)Value Item 759 -|(% style="width:198px" %)Structure|(% style="width:324px" %)Data Structure Definition|(% style="width:490px" %)((( 760 -Dimension Descriptor 761 -Group Dimension Descriptor 762 -Dimension 763 -Time Dimension 764 -Attribute Descriptor 765 -Data Attribute 762 +|(% style="width:198px" %)Structure|(% style="width:324px" %)[[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]]|(% style="width:490px" %)((( 763 +[[Dimension>>doc:Glossary.Dimension.WebHome]] Descriptor 764 +Group [[Dimension>>doc:Glossary.Dimension.WebHome]] Descriptor 765 +[[Dimension>>doc:Glossary.Dimension.WebHome]] 766 +Time [[Dimension>>doc:Glossary.Dimension.WebHome]] 767 +[[Attribute>>doc:Glossary.Attribute.WebHome]] Descriptor 768 +Data [[Attribute>>doc:Glossary.Attribute.WebHome]] 766 766 Measure Descriptor 767 767 Measure 768 768 ))) 769 -|(% style="width:198px" %) |(% style="width:324px" %)Metadata Structure Definition|(% style="width:490px" %)Metadata Attribute Descriptor Metadata Attribute 770 -|(% style="width:198px" %)Structure Usage|(% style="width:324px" %)Dataflow|(% style="width:490px" %) 771 -|(% style="width:198px" %) |(% style="width:324px" %)Metadataflow|(% style="width:490px" %) 772 +|(% style="width:198px" %) |(% style="width:324px" %)Metadata Structure Definition|(% style="width:490px" %)Metadata [[Attribute>>doc:Glossary.Attribute.WebHome]] Descriptor Metadata [[Attribute>>doc:Glossary.Attribute.WebHome]] 773 +|(% style="width:198px" %)Structure Usage|(% style="width:324px" %)[[Dataflow>>doc:Glossary.Dataflow.WebHome]]|(% style="width:490px" %) 774 +|(% style="width:198px" %) |(% style="width:324px" %)[[Metadataflow>>doc:Glossary.Metadataflow.WebHome]]|(% style="width:490px" %) 772 772 |(% style="width:198px" %)None|(% style="width:324px" %)Process|(% style="width:490px" %)Process Step 773 -|(% style="width:198px" %)None|(% style="width:324px" %)Structure Map|(% style="width:490px" %)((( 774 -Component Map 775 -Epoch Map 776 -Date Pattern Map 776 +|(% style="width:198px" %)None|(% style="width:324px" %)Structure (% style="color:#e74c3c" %)Map|(% style="width:490px" %)((( 777 +[[Component>>doc:Glossary.Component.WebHome]] (% style="color:#e74c3c" %)Map(%%) 778 +Epoch (% style="color:#e74c3c" %)Map(%%) 779 +Date Pattern (% style="color:#e74c3c" %)Map 777 777 ))) 778 -|(% style="width:198px" %)None|(% style="width:324px" %)Representation Map|(% style="width:490px" %)Representation Mapping 779 -|(% style="width:198px" %)Item Scheme Map|(% style="width:324px" %)Organisation Scheme Map|(% style="width:490px" %)Item Map 780 -|(% style="width:198px" %) |(% style="width:324px" %)Concept Scheme Map|(% style="width:490px" %)Item Map 781 -|(% style="width:198px" %) |(% style="width:324px" %)Category Scheme Map|(% style="width:490px" %)Item Map 782 -|(% style="width:198px" %) |(% style="width:324px" %)Reporting Taxonomy Map|(% style="width:490px" %)Item Map 783 -|(% style="width:198px" %)None|(% style="width:324px" %)Provision Agreement|(% style="width:490px" %) 784 -|(% style="width:198px" %)None|(% style="width:324px" %)Metadata Provision Agreement|(% style="width:490px" %) 785 -|(% style="width:198px" %)None|(% style="width:324px" %)Hierarchy|(% style="width:490px" %)Hierarchical Code 786 -|(% style="width:198px" %)None|(% style="width:324px" %)Hierarchy Association|(% style="width:490px" %) 781 +|(% style="width:198px" %)None|(% style="width:324px" %)[[Representation>>doc:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)Map|(% style="width:490px" %)[[Representation>>doc:Glossary.Representation.WebHome]] Mapping 782 +|(% style="width:198px" %)[[Item Scheme>>doc:Glossary.Item scheme.WebHome]] (% style="color:#e74c3c" %)Map|(% style="width:324px" %)Organisation Scheme (% style="color:#e74c3c" %)Map|(% style="width:490px" %)Item (% style="color:#e74c3c" %)Map 783 +|(% style="width:198px" %) |(% style="width:324px" %)[[Concept Scheme>>doc:Glossary.Concept scheme.WebHome]] (% style="color:#e74c3c" %)Map|(% style="width:490px" %)Item (% style="color:#e74c3c" %)Map 784 +|(% style="width:198px" %) |(% style="width:324px" %)[[Category Scheme>>doc:Glossary.Category scheme.WebHome]] (% style="color:#e74c3c" %)Map|(% style="width:490px" %)Item (% style="color:#e74c3c" %)Map 785 +|(% style="width:198px" %) |(% style="width:324px" %)Reporting Taxonomy (% style="color:#e74c3c" %)Map|(% style="width:490px" %)Item (% style="color:#e74c3c" %)Map 786 +|(% style="width:198px" %)None|(% style="width:324px" %)[[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]]|(% style="width:490px" %) 787 +|(% style="width:198px" %)None|(% style="width:324px" %)Metadata [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]]|(% style="width:490px" %) 788 +|(% style="width:198px" %)None|(% style="width:324px" %)[[Hierarchy>>doc:Glossary.Hierarchy.WebHome]]|(% style="width:490px" %)Hierarchical [[Code>>doc:Glossary.Code.WebHome]] 789 +|(% style="width:198px" %)None|(% style="width:324px" %)[[Hierarchy>>doc:Glossary.Hierarchy.WebHome]] Association|(% style="width:490px" %) 787 787 |(% style="width:198px" %)None|(% style="width:324px" %)Categorisation|(% style="width:490px" %) 788 788 789 -**Table 4: Table of Maintainable Artefacts for Structural Definition Metadata** 792 +**Table 4: Table of [[Maintainable Artefacts>>doc:Glossary.Maintainable artefact.WebHome]] for Structural Definition Metadata** 790 790 791 791 === {{id name="_Toc93864"/}}7.1.2 Item Scheme, Structure === 792 792 793 -The artefacts included in the structural definitions are: 796 +The [[artefacts>>doc:Glossary.Artefact.WebHome]] included in the structural definitions are: 794 794 795 -* 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) 798 +* All types of [[Item Scheme>>doc:Glossary.Item scheme.WebHome]] (Codelist, [[Concept Scheme>>doc:Glossary.Concept scheme.WebHome]], [[Category Scheme>>doc:Glossary.Category scheme.WebHome]], Organisation Scheme, [[Agency Scheme>>doc:Glossary.Agency scheme.WebHome]], [[Data Provider Scheme>>doc:Glossary.Data provider scheme.WebHome]], Metadata Provider Scheme, [[Data Consumer Scheme>>doc:Glossary.Data consumer scheme.WebHome]], [[Organisation Unit Scheme>>doc:Glossary.Organisation unit scheme.WebHome]], Transformation Scheme, Name Personalisation Scheme, Custom Type Scheme, [[Vtl>>doc:Glossary.Validation and transformation language.WebHome]] Mapping Scheme, Ruleset Scheme, User Defined Operator Scheme) 796 796 * All types of Enumerated List (ValueList){{footnote}}Note that Codelist is also an EnumeratedList.{{/footnote}} 797 -* All types of Structure (Data Structure Definition, Metadata Structure Definition) 798 -* All types of Structure Usage (Dataflow, Metadataflow) 800 +* All types of Structure ([[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]], Metadata Structure Definition) 801 +* All types of Structure Usage ([[Dataflow>>doc:Glossary.Dataflow.WebHome]], [[Metadataflow>>doc:Glossary.Metadataflow.WebHome]]) 799 799 800 800 === {{id name="_Toc93865"/}}7.1.3 Structure Usage === 801 801 802 802 ==== 7.1.3.1 Structure Usage: Basic Concepts ==== 803 803 804 -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. 807 +The Structure Usage defines, in its concrete classes of [[Dataflow>>doc:Glossary.Dataflow.WebHome]] and [[Metadataflow>>doc:Glossary.Metadataflow.WebHome]], which flows of data and metadata use which specific Structure, and importantly for the support of data and metadata discovery, the Structure Usage can be linked to one or more [[Category>>doc:Glossary.Category.WebHome]] in one or more [[Category Scheme>>doc:Glossary.Category scheme.WebHome]] using the Categorisation mechanism. This gives the ability for an application to discover data and metadata by “drilling down” the [[Category Schemes>>doc:Glossary.Category scheme.WebHome]]. 805 805 806 806 ==== 7.1.3.2 Structure Usage Schematic ==== 807 807 ... ... @@ -815,29 +815,29 @@ 815 815 816 816 **Figure 10: SDMX-IM of links from Structure Usage to Category** 817 817 818 -In addition to the maintenance of the Dataflow and the Metadataflow, the following links must be maintained in the registry: 821 +In addition to the maintenance of the [[Dataflow>>doc:Glossary.Dataflow.WebHome]] and the [[Metadataflow>>doc:Glossary.Metadataflow.WebHome]], the following links must be maintained in the registry: 819 819 820 -* Dataflow to Data Structure Definition 821 -* Metadataflow to Metadata Structure Definition 823 +* [[Dataflow>>doc:Glossary.Dataflow.WebHome]] to Data Structure Definition 824 +* [[Metadataflow>>doc:Glossary.Metadataflow.WebHome]] to Metadata Structure Definition 822 822 823 823 The following links may be created by means of a Categorisation 824 824 825 -* Categorisation to Dataflow and Category 826 -* Categorisation to Metadataflow and Category 828 +* Categorisation to [[Dataflow>>doc:Glossary.Dataflow.WebHome]] and Category 829 +* Categorisation to [[Metadataflow>>doc:Glossary.Metadataflow.WebHome]] and Category 827 827 828 828 == {{id name="_Toc93866"/}}7.2 Data and Metadata Provisioning == 829 829 830 830 === {{id name="_Toc93867"/}}7.2.1 Provisioning Agreement: Basic concepts === 831 831 832 -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. 835 +Data/Metadata provisioning defines a framework in which the provision of different types of statistical data and metadata by various data/metadata providers can be specified and controlled. This framework is the basis on which the existence of data can be made known to the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-enabled community and hence the basis on which data can subsequently be discovered. Such a framework can be used to regulate the data content to facilitate the building of intelligent applications. It can also be used to facilitate the processing implied by service (% style="color:#e74c3c" %)level(%%) agreements, or other provisioning agreements in those scenarios that are based on legal directives. Additionally, quality and [[timeliness>>doc:Glossary.Timeliness.WebHome]] metadata can be supported by this framework which makes it practical to implement information supply chain monitoring. 833 833 834 834 Note that the term “data provisioning” here includes both the provisioning of data and metadata. 835 835 836 -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. 839 +Although the [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]] directly supports the data-sharing “pull” model, it is also useful in “push” exchanges (bilateral and gateway scenarios), or in a dissemination environment. It should be noted, too, that in any exchange scenario, the registry functions as a repository of structural metadata. 837 837 838 838 === {{id name="_Toc93868"/}}7.2.2 Provisioning Agreement Model – pull use case === 839 839 840 -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. 843 +An organisation which publishes statistical data or [[reference metadata>>doc:Glossary.Reference metadata.WebHome]] and wishes to make it available to an [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] enabled community is called a [[Data Provider>>doc:Glossary.Data provider.WebHome]]. In terms of the [[SDMX Information Model>>doc:Glossary.SDMX Information Model.WebHome]], the [[Data Provider>>doc:Glossary.Data provider.WebHome]] is maintained in a [[Data Provider Scheme>>doc:Glossary.Data provider scheme.WebHome]]. 841 841 842 842 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_ec727775.jpg||height="455" width="551"]] 843 843 ... ... @@ -849,29 +849,29 @@ 849 849 850 850 **Figure 12: Schematic of the Provision Agreement** 851 851 852 -The diagram below is a logical representation of the data required in order to maintain Provision Agreements. 855 +The diagram below is a logical [[representation>>doc:Glossary.Representation.WebHome]] of the data required in order to maintain [[Provision Agreements>>doc:Glossary.Provision agreement.WebHome]]. 853 853 854 854 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_7b3d291a.jpg||height="246" width="579"]] 855 855 856 856 **Figure 13: Logical class diagram of the information contained in the Provision Agreement** 857 857 858 -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. 861 +A [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]] is [[structural metadata>>doc:Glossary.Structural metadata.WebHome]]. Each [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]] must reference a [[Data Provider>>doc:Glossary.Data provider.WebHome]] or Metadata Provider and a [[Dataflow>>doc:Glossary.Dataflow.WebHome]] or [[Metadataflow>>doc:Glossary.Metadataflow.WebHome]] Definition. The Data/Metadata Provider and the [[Dataflow>>doc:Glossary.Dataflow.WebHome]]/[[Metadataflow>>doc:Glossary.Metadataflow.WebHome]] must exist already in order to set up a Metadata Provision or [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]]. 859 859 860 860 == {{id name="_Toc93869"/}}7.3 Data and Metadata Constraints == 861 861 862 862 === {{id name="_Toc93870"/}}7.3.1 Data and Metadata Constraints: Basic Concepts === 863 863 864 -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. 867 +(% 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:Glossary.Data set.WebHome]] or [[metadata set>>doc:Glossary.Metadata set.WebHome]] which can be derived from the specification of the [[DSD>>doc:Glossary.Data structure definition.WebHome]] or [[MSD>>doc:Glossary.Metadata structure definition.WebHome]]. A (% style="color:#e74c3c" %)Constraint(%%) can comprise a list of keys or a list of content (usually [[code>>doc:Glossary.Code.WebHome]] values) of a specific [[component>>doc:Glossary.Component.WebHome]] such as a [[dimension>>doc:Glossary.Dimension.WebHome]] or [[attribute>>doc:Glossary.Attribute.WebHome]]. 865 865 866 -Constraints comprise the specification of subsets of key or attribute values that are contained in a data source, or is 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 actually present in any specific data source, or more than is intended to be supplied according to a specific Dataflow. 869 +(% style="color:#e74c3c" %)Constraints(%%) comprise the specification of subsets of key or [[attribute>>doc:Glossary.Attribute.WebHome]] values that are contained in a [[data source>>doc:Glossary.Data source.WebHome]], or is to be provided for a [[Dataflow>>doc:Glossary.Dataflow.WebHome]] or [[Metadataflow>>doc:Glossary.Metadataflow.WebHome]], or directly attached to a [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]] or [[Metadata Structure Definition>>doc: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: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:Glossary.Code list.WebHome]] for each of the [[Dimensions>>doc:Glossary.Dimension.WebHome]]) is often more than is actually present in any specific [[data source>>doc:Glossary.Data source.WebHome]], or more than is intended to be supplied according to a specific [[Dataflow>>doc:Glossary.Dataflow.WebHome]]. 867 867 868 -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. 871 +Often a [[Data Provider>>doc: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:Glossary.Data provider.WebHome]] could constrain the [[data source>>doc:Glossary.Data source.WebHome]] (at the (% style="color:#e74c3c" %)level(%%) of the [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]] or the [[Data Provider>>doc: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:Glossary.Code list.WebHome]] subset which is used to populate a partial [[code list>>doc:Glossary.Code list.WebHome]]. 869 869 870 -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. 873 +Furthermore, it is often useful to define subsets or views of the [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]] which restrict values in some [[code lists>>doc:Glossary.Code list.WebHome]], especially where many such subsets restrict the same [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]]. Such a view is called a [[Dataflow>>doc:Glossary.Dataflow.WebHome]], and there can be one or more defined for any [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]]. 871 871 872 -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. 875 +Whenever data is published or made available by a [[Data Provider>>doc:Glossary.Data provider.WebHome]], it must conform to a [[Dataflow>>doc:Glossary.Dataflow.WebHome]] (and hence to a [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]]). The [[Dataflow>>doc:Glossary.Dataflow.WebHome]] is thus a means of enabling content based processing. 873 873 874 -In addition, Constraints 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), and the Key Set can be used to specify the keys that exist in a data source (these can be used to guide the user to select only those Dimension code values that will return data based on the Dimension values already selected). 877 +In addition, (% style="color:#e74c3c" %)Constraints(%%) 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:Glossary.Dimension.WebHome]] [[codes>>doc:Glossary.Code.WebHome]] that actually exist in a [[data source>>doc:Glossary.Data source.WebHome]] (these can be used to build relevant selection tables), and the Key Set can be used to specify the keys that exist in a [[data source>>doc:Glossary.Data source.WebHome]] (these can be used to guide the user to select only those [[Dimension>>doc:Glossary.Dimension.WebHome]] [[code>>doc:Glossary.Code.WebHome]] values that will return data based on the [[Dimension>>doc:Glossary.Dimension.WebHome]] values already selected). 875 875 876 876 === {{id name="_Toc93871"/}}7.3.2 Data and Metadata Constraints: Schematic === 877 877 ... ... @@ -887,21 +887,21 @@ 887 887 888 888 Logical class diagram showing inheritance between and reference to constrainable artefacts 889 889 890 -The class diagram above shows that Data Provider, Metadata Provider, Dataflow, Metadataflow, Provision Agreement, Metadata Provision Agreement, Data Structure Definition, Metadata Structure Definition, Simple Datasource and REST Datasource (via the abstract Query Datasource) are all concrete sub-classes of Constrainable Artefact and can therefore have Constraints specified. Note that the actual Constraint as submitted is associated to the reference classes which inherit from ConstrainableRef: these are used to refer to the classes to which the Constraint applies. 893 +The class diagram above shows that [[Data Provider>>doc:Glossary.Data provider.WebHome]], Metadata Provider, [[Dataflow>>doc:Glossary.Dataflow.WebHome]], [[Metadataflow>>doc:Glossary.Metadataflow.WebHome]], [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]], Metadata [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]], [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]], [[Metadata Structure Definition>>doc:Glossary.Metadata structure definition.WebHome]], Simple Datasource and REST Datasource (via the abstract Query Datasource) are all concrete sub-classes of Constrainable [[Artefact>>doc:Glossary.Artefact.WebHome]] and can therefore have (% style="color:#e74c3c" %)Constraints(%%) specified. Note that the actual (% style="color:#e74c3c" %)Constraint(%%) as submitted is associated to the reference classes which inherit from ConstrainableRef: these are used to refer to the classes to which the (% style="color:#e74c3c" %)Constraint(%%) applies. 891 891 892 -The content of the Constraint can be found in the SDMX Information Model document. 895 +The content of the (% style="color:#e74c3c" %)Constraint(%%) can be found in the [[SDMX Information Model>>doc:Glossary.SDMX Information Model.WebHome]] document. 893 893 894 894 == {{id name="_Toc93873"/}}7.4 Data and Metadata Registration == 895 895 896 896 === {{id name="_Toc93874"/}}7.4.1 Basic Concepts === 897 897 898 -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. 901 +A [[Data Provider>>doc:Glossary.Data provider.WebHome]] has published a new [[dataset>>doc:Glossary.Data set.WebHome]] conforming to an existing [[Dataflow>>doc:Glossary.Dataflow.WebHome]] (and hence [[Data Structure Definition>>doc: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:Glossary.Statistical data and metadata exchange.WebHome]] RESTful query with an [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]] data stream. 899 899 900 -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. 903 +The [[Data Provider>>doc: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:Glossary.Data consumer.WebHome]]. To do this, the [[Data Provider>>doc:Glossary.Data provider.WebHome]] registers the new [[dataset>>doc:Glossary.Data set.WebHome]] with one or more [[SDMX>>doc: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:Glossary.Data provider.WebHome]] and “knows” what [[data flows>>doc:Glossary.Dataflow.WebHome]] the [[data provider>>doc:Glossary.Data provider.WebHome]] has agreed to make available. 901 901 902 -The same mechanism can be used to report or make available a metadata set. 905 +The same mechanism can be used to report or make available a [[metadata set>>doc:Glossary.Metadata set.WebHome]]. 903 903 904 -SDMX-RR supports dataset and metadata set registration via the Registration Request, which can be created by the Data/Metadata 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. 907 +[[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-RR supports [[dataset>>doc:Glossary.Data set.WebHome]] and [[metadata set>>doc:Glossary.Metadata set.WebHome]] registration via the Registration Request, which can be created by the Data/Metadata Provider (giving the [[Data Provider>>doc: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. 905 905 906 906 === {{id name="_Toc93875"/}}7.4.2 The Registration Request === 907 907 ... ... @@ -913,7 +913,7 @@ 913 913 914 914 ==== 7.4.2.2 Registration Request Model ==== 915 915 916 -The following UML diagram shows the composition of the registration request. Each request is made up of one or more Registrations, one per dataset or metadata set to be registered. The Registration can optionally have information, which has been extracted from the Registration: 919 +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:Glossary.Data set.WebHome]] or [[metadata set>>doc:Glossary.Metadata set.WebHome]] to be registered. The Registration can optionally have information, which has been extracted from the Registration: 917 917 918 918 * validFrom 919 919 * validTo ... ... @@ -921,7 +921,7 @@ 921 921 922 922 The last updated date is useful during the discovery process to make sure the client knows which data is freshest. 923 923 924 -The Registration has an action attribute which takes one of the following values: 927 +The Registration has an action [[attribute>>doc:Glossary.Attribute.WebHome]] which takes one of the following values: 925 925 926 926 ((( 927 927 (% style="width:761.294px" %) ... ... @@ -937,35 +937,35 @@ 937 937 938 938 **Figure 17: Logical Class Diagram of Registration of Data and Metadata** 939 939 940 -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. 943 +The //QueryDatasource// is an abstract class that represents a [[data source>>doc:Glossary.Data source.WebHome]], which can understand an API query (i.e., a RESTful query – RESTDatasource) and respond appropriately. Each [[data source>>doc: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. 941 941 942 -A SimpleDatasource is used to reference a physical SDMX-ML file that is available at a URL. 945 +A SimpleDatasource is used to reference a physical [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]] file that is available at a URL. 943 943 944 -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. 947 +The RegistrationRequest has an action [[attribute>>doc: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. 945 945 946 -The Registration includes attributes that state how a SimpleDatasource is to be indexed when registered. The Registry registration process must act as follows: 949 +The Registration includes [[attributes>>doc:Glossary.Attribute.WebHome]] that state how a SimpleDatasource is to be indexed when registered. The Registry registration process must act as follows: 947 947 948 -Information in the data or metadata set is extracted and placed in one or more //Constraint//s (see the //Constraint// model in the SDMX Information Model – Section 2 of the SDMX Standards). The information to be extracted is indicated by the Boolean values set on the ProvisionAgreement or MetadataProvisionAgreement as shown in the table below. 951 +Information in the data or [[metadata set>>doc:Glossary.Metadata set.WebHome]] is extracted and placed in one or more (% style="color:#e74c3c" %)//Constraint//(%%)s (see the (% style="color:#e74c3c" %)//Constraint//(%%) model in the [[SDMX Information Model>>doc:Glossary.SDMX Information Model.WebHome]] – Section 2 of the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Standards). The information to be extracted is indicated by the Boolean values set on the ProvisionAgreement or MetadataProvisionAgreement as shown in the table below. 949 949 950 950 ((( 951 951 (% style="width:678.294px" %) 952 952 |**Indexing Required**|(% style="width:504px" %)**Registration Process Activity** 953 -|indexTimeSeries|(% style="width:504px" %)Extract all the series keys and create a KeySet(s) Constraint. 954 -|indexDataSet|(% style="width:504px" %)Extract all the codes and other content of the Key value of the Series Key in a Data Set and create one or more Cube Regions containing Member Selections of Dimension Components of the Constraints model in the SDMX-IM, and the associated Selection Value. 956 +|indexTimeSeries|(% style="width:504px" %)Extract all the [[series keys>>doc:Glossary.Series key.WebHome]] and create a KeySet(s) (% style="color:#e74c3c" %)Constraint(%%). 957 +|indexDataSet|(% style="width:504px" %)Extract all the [[codes>>doc:Glossary.Code.WebHome]] and other content of the Key value of the [[Series Key>>doc:Glossary.Series key.WebHome]] in a [[Data Set>>doc:Glossary.Data set.WebHome]] and create one or more Cube Regions containing [[Member Selections>>doc:Glossary.Member selection.WebHome]] of [[Dimension>>doc:Glossary.Dimension.WebHome]] [[Components>>doc:Glossary.Component.WebHome]] of the (% style="color:#e74c3c" %)Constraints(%%) model in the [[SDMX-IM>>doc:Glossary.SDMX Information Model.WebHome]], and the associated Selection Value. 955 955 |indexReportingPeriod|(% style="width:504px" %)((( 956 -This applies only to a registered __dataset__. 957 -Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint. 959 +This applies only to a registered __[[dataset>>doc:Glossary.Data set.WebHome]]__. 960 +Extract the Reporting Begin and Reporting End from the Header of the Message containing the [[data set>>doc:Glossary.Data set.WebHome]], and create a [[Reference Period>>doc:Glossary.Reference period.WebHome]] (% style="color:#e74c3c" %)constraint(%%). 958 958 ))) 959 959 |**Indexing Required**|(% style="width:504px" %)**Registration Process Activity** 960 960 |indexAttributes|(% style="width:504px" %)((( 961 -**Data Set** 962 -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 963 -**Metadata Set** 964 -Indicate the presence of a Reported Attribute by creating one or more Cube Regions containing Member Selections of Metadata Attribute Components of the Constraints model in the SDMX-IM. Note that the content is not stored in the Selection Value. 964 +**[[Data Set>>doc:Glossary.Data set.WebHome]]** 965 +Extract the content of the [[Attribute>>doc:Glossary.Attribute.WebHome]] Values in a [[Data Set>>doc:Glossary.Data set.WebHome]] and create one or more Cube Regions containing [[Member Selections>>doc:Glossary.Member selection.WebHome]] of Data [[Attribute>>doc:Glossary.Attribute.WebHome]] [[Components>>doc:Glossary.Component.WebHome]] of the (% style="color:#e74c3c" %)Constraints(%%) model in the SDMXIM, and the associated Selection Value 966 +**[[Metadata Set>>doc:Glossary.Metadata set.WebHome]]** 967 +Indicate the presence of a Reported [[Attribute>>doc:Glossary.Attribute.WebHome]] by creating one or more Cube Regions containing [[Member Selections>>doc:Glossary.Member selection.WebHome]] of Metadata [[Attribute>>doc:Glossary.Attribute.WebHome]] [[Components>>doc:Glossary.Component.WebHome]] of the (% style="color:#e74c3c" %)Constraints(%%) model in the [[SDMX-IM>>doc:Glossary.SDMX Information Model.WebHome]]. Note that the content is not stored in the Selection Value. 965 965 ))) 966 966 ))) 967 967 968 -Constraints that specify the contents of a //QueryDatasource// are submitted to the Registry via the structure submission service (i.e., the RESTful API). 971 +(% 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). 969 969 970 970 The Registration must reference the ProvisionAgreement or MetadataProvisionAgreement to which it relates. 971 971 ... ... @@ -973,9 +973,9 @@ 973 973 974 974 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”. 975 975 976 -If the registration has succeeded, a Registration will be returned – this holds the Registry-allocated Id of the newly registered //Datasource// plus a //Datasource// holding the URL to access the dataset, metadataset, or query service. 979 +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:Glossary.Data set.WebHome]], metadataset, or query service. 977 977 978 -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: 981 +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:Glossary.Data set.WebHome]], that the response will contain some successful and some failed statuses. The logical model for the RegistrationResponse is shown below: 979 979 980 980 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_6c58dd9b.jpg||height="371" width="579"]] 981 981 ... ... @@ -997,86 +997,86 @@ 997 997 998 998 === {{id name="_Toc93879"/}}7.5.2 Subscription Information === 999 999 1000 -Regardless of the type of registry/repository events being observed, a subscription always contains: 1003 +Regardless of the type of registry/repository events being observed, a [[subscription>>doc:Glossary.Subscription.WebHome]] always contains: 1001 1001 1002 -1. set of URIs describing the end-points to which notifications must be sent if the subscription is activated. The URIs can be either mailto~: or http: protocol. In the former case an email notification is sent; in the latter an HTTP POST notification is sent. 1003 -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. 1004 -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. 1005 +1. set of URIs describing the end-points to which [[notifications>>doc:Glossary.Notification.WebHome]] must be sent if the [[subscription>>doc:Glossary.Subscription.WebHome]] is activated. The URIs can be either mailto~: or http: protocol. In the former case an email [[notification>>doc:Glossary.Notification.WebHome]] is sent; in the latter an HTTP POST [[notification>>doc:Glossary.Notification.WebHome]] is sent. 1006 +1. A user-defined identifier, which is returned in the response to the [[subscription>>doc:Glossary.Subscription.WebHome]] request. This helps with asynchronous processing and is NOT stored in the Registry. 1007 +1. A validity period which defines both when the [[subscription>>doc:Glossary.Subscription.WebHome]] becomes active and expires. The subscriber may be sent a [[notification>>doc:Glossary.Notification.WebHome]] on expiration of the [[subscription>>doc:Glossary.Subscription.WebHome]]. 1005 1005 1. A selector which specifies which type of events are of interest. The set of event types is: 1006 1006 1007 1007 ((( 1008 1008 (% style="width:856.294px" %) 1009 1009 |(% style="width:320px" %)**Event Type**|(% style="width:532px" %)**Comment** 1010 -|(% style="width:320px" %)STRUCTURAL_REPOSITORY_EVENTS|(% style="width:532px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository. 1011 -|(% style="width:320px" %)DATA_REGISTRATION_EVENTS|(% style="width:532px" %)Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database. 1012 -|(% style="width:320px" %)METADATA_REGISTRATION_EVENTS|(% style="width:532px" %)Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database. 1013 +|(% style="width:320px" %)STRUCTURAL_REPOSITORY_EVENTS|(% style="width:532px" %)Life-cycle changes to [[Maintainable Artefacts>>doc:Glossary.Maintainable artefact.WebHome]] in the [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] repository. 1014 +|(% style="width:320px" %)DATA_REGISTRATION_EVENTS|(% style="width:532px" %)Whenever a published [[dataset>>doc:Glossary.Data set.WebHome]] is registered. This can be either a SDMXML data file or an [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] conformant database. 1015 +|(% style="width:320px" %)METADATA_REGISTRATION_EVENTS|(% style="width:532px" %)Whenever a published metadataset is registered. This can be either a SDMXML [[reference metadata>>doc:Glossary.Reference metadata.WebHome]] file or an [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] conformant database. 1013 1013 |(% style="width:320px" %)ALL_EVENTS|(% style="width:532px" %)All events of the specified EventType 1014 1014 ))) 1015 1015 1016 1016 === {{id name="_Toc93880"/}}7.5.3 Wildcard Facility === 1017 1017 1018 -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: 1021 +[[Subscription>>doc:Glossary.Subscription.WebHome]] [[notification>>doc:Glossary.Notification.WebHome]] supports wildcarded identifier [[components>>doc:Glossary.Component.WebHome]] URNs, which are identifiers which have some or all of their [[component>>doc:Glossary.Component.WebHome]] parts replaced by the wildcard character `*`. Identifier [[components>>doc:Glossary.Component.WebHome]] comprise: 1019 1019 1020 1020 * agencyID 1021 1021 * id 1022 1022 * version 1023 1023 1024 -Examples of wildcarded identifier components for an identified object type of Codelist are shown below: 1027 +Examples of wildcarded identifier [[components>>doc:Glossary.Component.WebHome]] for an identified object type of Codelist are shown below: 1025 1025 1026 1026 AgencyID = * 1027 1027 Id = * 1028 1028 Version = * 1029 1029 1030 -This subscribes to all Codelists of all versions for all agencies. 1033 +This subscribes to all Codelists of all (% style="color:#e74c3c" %)versions(%%) for all agencies. 1031 1031 1032 1032 AgencyID = AGENCY1 1033 1033 Id = CODELIST1 1034 1034 Version = * 1035 1035 1036 -This subscribes to all versions of Codelist CODELIST1 maintained by the agency AGENCY1. 1039 +This subscribes to all (% style="color:#e74c3c" %)versions(%%) of Codelist CODELIST1 maintained by the agency AGENCY1. 1037 1037 1038 1038 AgencyID = AGENCY1 1039 1039 Id = * 1040 1040 Version = * 1041 1041 1042 -This subscribes to all versions of all Codelist objects maintained by the agency AGENCY1. 1045 +This subscribes to all (% style="color:#e74c3c" %)versions(%%) of all Codelist objects maintained by the agency AGENCY1. 1043 1043 1044 1044 AgencyID = * 1045 1045 Id = CODELIST1 1046 1046 Version = * 1047 1047 1048 -This subscribes to all versions of Codelist CODELIST1 maintained by any agency. 1051 +This subscribes to all (% style="color:#e74c3c" %)versions(%%) of Codelist CODELIST1 maintained by any agency. 1049 1049 1050 -Note that if the subscription is to the latest stable version then this can be achieved by the + character, i.e.: 1053 +Note that if the [[subscription>>doc:Glossary.Subscription.WebHome]] is to the latest stable (% style="color:#e74c3c" %)version(%%) then this can be achieved by the + character, i.e.: 1051 1051 1052 1052 Version = + 1053 1053 1054 -A subscription to the latest version (whether stable, draft or non-versioned) can be achieved by the ~~character, i.e.:1057 +A [[subscription>>doc:Glossary.Subscription.WebHome]] to the latest (% style="color:#e74c3c" %)version(%%) (whether stable, draft or non-versioned) can be achieved by the character, i.e.: 1055 1055 1056 1056 Version = ~~ 1057 1057 1058 -A subscription to the latest stable version within major version 2 starting with version 2.3.1 can be achieved by adding the + character after the minor version number, i.e.: 1061 +A [[subscription>>doc:Glossary.Subscription.WebHome]] to the latest stable (% style="color:#e74c3c" %)version(%%) within major (% style="color:#e74c3c" %)version(%%) 2 starting with (% style="color:#e74c3c" %)version(%%) 2.3.1 can be achieved by adding the + character after the minor (% style="color:#e74c3c" %)version(%%) number, i.e.: 1059 1059 1060 1060 Version = 2.3+.1 1061 1061 1062 -The complete SDMX versioning syntax can be found in the SDMX Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”. 1065 +The complete [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] versioning syntax can be found in the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”. 1063 1063 1064 1064 === {{id name="_Toc93881"/}}7.5.4 Structural Repository Events === 1065 1065 1066 -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. 1069 +Whenever a [[maintainable artefact>>doc:Glossary.Maintainable artefact.WebHome]] ([[data structure definition>>doc:Glossary.Data structure definition.WebHome]], [[concept scheme>>doc:Glossary.Concept scheme.WebHome]], codelist, [[metadata structure definition>>doc:Glossary.Metadata structure definition.WebHome]], [[category scheme>>doc:Glossary.Category scheme.WebHome]], etc.) is added to, deleted from, or modified in the [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] repository, a [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] event is triggered. [[Subscriptions>>doc:Glossary.Subscription.WebHome]] may be set up to monitor all such events, or focus on specific [[artefacts>>doc:Glossary.Artefact.WebHome]] such as a [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]]. 1067 1067 1068 1068 === {{id name="_Toc93882"/}}7.5.5 Registration Events === 1069 1069 1070 -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: 1073 +Whenever a [[dataset>>doc:Glossary.Data set.WebHome]] or metadata-set is registered a registration event is created. A [[subscription>>doc:Glossary.Subscription.WebHome]] may be observing all data or metadata registrations, or it may focus on specific registrations as shown in the table below: 1071 1071 1072 1072 ((( 1073 1073 (% style="width:1126.29px" %) 1074 1074 |(% style="width:382px" %)**Selector**|(% style="width:740px" %)**Comment** 1075 -|(% style="width:382px" %)DataProvider & MetadataProvider|(% style="width:740px" %)Any datasets or metadata sets registered by the specified data or metadata provider will activate the notification. 1076 -|(% style="width:382px" %)ProvisionAgreement & MetadataProvisionAgreement|(% style="width:740px" %)Any datasets or metadata sets registered for the agreement will activate the notification. 1077 -|(% style="width:382px" %)Dataflow & Metadataflow|(% style="width:740px" %)Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification. 1078 -|(% style="width:382px" %)DataStructureDefinition & MetadataStructureDefinition|(% style="width:740px" %)Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will activate the notification 1079 -|(% style="width:382px" %)Category|(% style="width:740px" %)Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category. 1078 +|(% style="width:382px" %)DataProvider & MetadataProvider|(% style="width:740px" %)Any [[datasets>>doc:Glossary.Data set.WebHome]] or [[metadata sets>>doc:Glossary.Metadata set.WebHome]] registered by the specified data or metadata provider will activate the notification. 1079 +|(% style="width:382px" %)ProvisionAgreement & MetadataProvisionAgreement|(% style="width:740px" %)Any [[datasets>>doc:Glossary.Data set.WebHome]] or [[metadata sets>>doc:Glossary.Metadata set.WebHome]] registered for the agreement will activate the notification. 1080 +|(% style="width:382px" %)[[Dataflow>>doc:Glossary.Dataflow.WebHome]] & [[Metadataflow>>doc:Glossary.Metadataflow.WebHome]]|(% style="width:740px" %)Any [[datasets>>doc:Glossary.Data set.WebHome]] or [[metadata sets>>doc:Glossary.Metadata set.WebHome]] registered for the specified [[dataflow>>doc:Glossary.Dataflow.WebHome]] (or [[metadataflow>>doc:Glossary.Metadataflow.WebHome]]) will activate the notification. 1081 +|(% style="width:382px" %)DataStructureDefinition & MetadataStructureDefinition|(% style="width:740px" %)Any [[datasets>>doc:Glossary.Data set.WebHome]] or [[metadata sets>>doc:Glossary.Metadata set.WebHome]] registered for those [[dataflows>>doc:Glossary.Dataflow.WebHome]] (or [[metadataflows>>doc:Glossary.Metadataflow.WebHome]]) that are based on the specified [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]] will activate the notification 1082 +|(% style="width:382px" %)[[Category>>doc:Glossary.Category.WebHome]]|(% style="width:740px" %)Any [[datasets>>doc:Glossary.Data set.WebHome]] or [[metadata sets>>doc:Glossary.Metadata set.WebHome]] registered for those [[dataflows>>doc:Glossary.Dataflow.WebHome]], [[metadataflows>>doc:Glossary.Metadataflow.WebHome]], [[provision agreements>>doc:Glossary.Provision agreement.WebHome]] that are categorised by the [[category>>doc:Glossary.Category.WebHome]]. 1080 1080 ))) 1081 1081 1082 1082 The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration. ... ... @@ -1089,24 +1089,24 @@ 1089 1089 1090 1090 **Figure 20: Logical Class Diagram of the Notification** 1091 1091 1092 -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. 1095 +A [[notification>>doc:Glossary.Notification.WebHome]] is an XML document that is sent to a user via email or http POST whenever a [[subscription>>doc:Glossary.Subscription.WebHome]] is activated. It is an asynchronous one-way message. 1093 1093 1094 -Regardless of the registry component that caused the event to be triggered, the following common information is in the message: 1097 +Regardless of the registry [[component>>doc:Glossary.Component.WebHome]] that caused the event to be triggered, the following common information is in the message: 1095 1095 1096 1096 * Date and time that the event occurred 1097 -* The URN of the artefact that caused the event 1098 -* The URN of the Subscription that produced the notification 1100 +* The URN of the [[artefact>>doc:Glossary.Artefact.WebHome]] that caused the event 1101 +* The URN of the [[Subscription>>doc:Glossary.Subscription.WebHome]] that produced the [[notification>>doc:Glossary.Notification.WebHome]] 1099 1099 * Event Action: Add, Replace, or Delete. 1100 1100 1101 -Additionally, supplementary information may be contained in the notification as detailed below. 1104 +Additionally, supplementary information may be contained in the [[notification>>doc:Glossary.Notification.WebHome]] as detailed below. 1102 1102 1103 1103 === {{id name="_Toc93885"/}}7.6.2 Structural Event Component === 1104 1104 1105 -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). 1108 +The [[notification>>doc:Glossary.Notification.WebHome]] will contain the MaintainableArtefact that triggered the event in a form similar to the [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]] structural message (using elements from that namespace). 1106 1106 1107 1107 === {{id name="_Toc93886"/}}7.6.3 Registration Event Component === 1108 1108 1109 -The notification will contain the Registration. 1112 +The [[notification>>doc:Glossary.Notification.WebHome]] will contain the Registration. 1110 1110 1111 1111 ---- 1112 1112