Last modified by Helena on 2025/09/10 11:19
Summary
-
Page properties (4 modified, 0 added, 0 removed)
-
Attachments (0 modified, 1 added, 0 removed)
-
Objects (0 modified, 1 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 -SDMX S TANDARDS: SECTION51 +SDMX 3.0 Standards 3.0: SDMX registry specification: logical functionality and logical interfaces - Parent
-
... ... @@ -1,0 +1,1 @@ 1 +Methodology.WebHome - Tags
-
... ... @@ -1,0 +1,1 @@ 1 +Artefact|Attribute|Category scheme|Code list|Component|Data set|Data structure definition|Dataflow|Dimension|Maintenance agency|Measure|Metadata repository|Metadata set|Metadata structure definition|Metadataflow|Notification|Provision agreement|Reference metadata|SDMX Information Model|SDMX Registry|SDMX-JSON|SDMX-ML|Statistical data and metadata exchange|Structural metadata - Content
-
... ... @@ -2,7 +2,8 @@ 2 2 {{toc/}} 3 3 {{/box}} 4 4 5 -= Revision History = 5 +(% class="wikigeneratedid" id="HRevisionHistory" %) 6 +**Revision History** 6 6 7 7 ((( 8 8 (% style="width:838.294px" %) ... ... @@ -13,69 +13,69 @@ 13 13 14 14 = 1 Introduction = 15 15 16 -The business vision for SDMX envisages the promotion of a “data sharing” model to facilitate low-cost, high-quality statistical data and metadata exchange. 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: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 17 18 -* the availability of an abstract information model capable of supporting time series and cross-sectional data, structural metadata, and reference metadata (SDMX-IM) 19 -* standardised XML and JSON schemas for the SDMX-ML and SDMX-JSON 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: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) 20 20 * the use of web-services technology (XML, JSON, Open API) 21 21 22 -Such an architecture needs to be well organised, and the SDMX Registry/Repository (SDMXRR) is tasked with providing structure, organisation, and maintenance and query interfaces for most of the SDMX components required to support the data sharing vision. 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 23 24 -However, it is important to emphasise that the SDMX-RR provides support for the submission and retrieval of all SDMX structural metadata 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: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 25 26 -Standard formats for the exchange of aggregated statistical data and metadata as prescribed in SDMX 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: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 27 28 -As organisations migrate to SDMX enabled systems, many XML, JSON (and conventional) artefacts will be produced (e.g., Data Structure, Metadata Structure, Code List and Concept definitions – often collectively called structural metadata – XML schemas generated from data structure definitions, XSLT stylesheets for transformation and display of data and metadata, terminology references, etc.). The SDMX model supports interoperability, and it is important to be able to discover and share these artefacts between parties in a controlled and organized way. 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 29 30 30 This is the role of the registry. 31 31 32 -With the fundamental SDMX standards in place, a set of architectural standards are needed to address some of the processes involved in statistical data and metadata exchange, with an emphasis on maintenance, retrieval and sharing of the structural metadata. In addition, the architectural standards support the registration and discovery of data and referential metadata. 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 33 34 -These architectural standards address the ‘how’, rather than the ‘what’, and are aimed at enabling existing SDMX 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:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] standards to achieve their mission. The architectural standards address registry services, which initially comprise: 35 35 36 -* structural metadata repository 37 +* [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] repository 37 37 * data and metadata registration 38 38 * query 39 39 40 -The registry services outlined in this specification are designed to help the SDMX community manage the proliferation of SDMX 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: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 41 42 42 = {{id name="_Toc93832"/}}2 Scope and Normative Status = 43 43 44 -The scope of this document is to specify the logical interfaces for the SDMX registry 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: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 45 46 46 In this document, functions and behaviours of the Registry Interfaces are described in four ways: 47 47 48 48 * in text 49 49 * with tables 50 -* with UML diagrams excerpted from the SDMX Information Model (SDMX-IM) 51 -* with UML diagrams that are not a part of the SDMX-IM 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: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 ...”) 52 52 53 53 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. 54 54 55 -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 mechanism must support e-mail and HTTP/HTTPS protocols as described. Normative registry interfaces are specified in the SDMX-ML specification (Section 3 of the SDMX 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: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 56 57 -Note that although the term “authorised user” is used in this document, the SDMX 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: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 58 59 59 = {{id name="_Toc93833"/}}3 Scope of the SDMX Registry/Repository = 60 60 61 61 == {{id name="_Toc93834"/}}3.1 Objective == 62 62 63 -The objective of the SDMX registry/repository is, in broad terms, to allow organisations to publish statistical data and reference metadata 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: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 64 65 -1. To maintain and publish structural metadata that describes the structure and valid content of data and reference metadata sources such as databases, metadata repositories, data sets, metadata sets. This structural metadata enables software applications to understand and to interpret the data and reference metadata in these sources. 66 -1. To enable applications, organisations, and individuals to share and to discover data and reference metadata. This facilitates data and reference metadata dissemination by implementing the data sharing vision of SDMX. 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]]. 67 67 68 68 == {{id name="_Toc93835"/}}3.2 Structural Metadata == 69 69 70 -Setting up structural metadata and the exchange context (referred to as “data provisioning”) involves the following steps for maintenance agencies: 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 71 72 -* agreeing and creating a specification of the structure of the data (called a Data Structure Definition or DSD in this document but also known as “key family”), which defines the dimensions, measures and attributes of a dataset and their valid value set; 73 -* if required, defining a subset or view of a DSD which allows some restriction of content called a “dataflow definition”; 74 -* agreeing and creating a specification of the structure of reference metadata (Metadata Structure Definition) which defines the metadata attributes and their presentational arrangement in a Metadataset or as part of a Dataset, and their valid values and content; 75 -* if required, defining a subset or view of an MSD which allows some restriction of content called a “metadataflow”; 76 -* defining which subject matter domains (specified as a Category Scheme) are related to the Dataflow and Metadataflow to enable browsing; 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; 77 77 * defining one or more lists of Data and Metadata Providers; 78 -* defining which Data/Metadata Providers have agreed to publish a given Dataflow/Metadataflow – this is called a Provision Agreement or Metadata Provision Agreement, respectively. 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 79 80 80 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_28806f51.jpg||height="539" width="443"]] 81 81 ... ... @@ -84,20 +84,20 @@ 84 84 85 85 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: 86 86 87 -* Structure Definition: refers to Data Structure Definition (DSD) and Metadata Structure Definition (MSD) 88 -* Flow: refers to Dataflow and Metadataflow 89 -* Provision Agreement: refers to Provision Agreement (for data) and Metadata Provision Agreement 90 -* Provider Scheme: refers to Data Provider Scheme and Metadata Provider Scheme 91 -* Provider: refers to Data Provider and Metadata Provider 88 +* Structure Definition: refers to [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] ([[DSD>>doc:xwiki:Glossary.Data structure definition.WebHome]]) and [[Metadata Structure Definition>>doc:xwiki:Glossary.Metadata structure definition.WebHome]] (MSD) 89 +* Flow: refers to [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] and [[Metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]] 90 +* [[Provision Agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]]: refers to [[Provision Agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]] (for data) and Metadata [[Provision Agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]] 91 +* Provider Scheme: refers to [[Data Provider Scheme>>doc:xwiki:Glossary.Data provider scheme.WebHome]] and Metadata Provider Scheme 92 +* Provider: refers to [[Data Provider>>doc:xwiki:Glossary.Data provider.WebHome]] and Metadata Provider 92 92 93 -In that context, the term “Metadata” refers to reference metadata. 94 +In that context, the term “Metadata” refers to [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]]. 94 94 95 95 == {{id name="_Toc93836"/}}3.3 Registration == 96 96 97 -Publishing the data and reference metadata involves the following steps for a Data/Metadata Provider: 98 +Publishing the data and [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] involves the following steps for a Data/Metadata Provider: 98 98 99 -* 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); 100 -* registering the existence of published reference metadata and data files or databases with one or more SDMX registries. 100 +* making the [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] and data available in [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]]/JSON conformant data files or databases (which respond to an [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] query with data). The data and [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] files or databases must be web accessible, and must conform to an agreed [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] or [[Metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]] ([[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] or [[Metadata Structure Definition>>doc:xwiki:Glossary.Metadata structure definition.WebHome]] subset); 101 +* registering the existence of published [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] and data files or databases with one or more [[SDMX registries>>doc:xwiki:Glossary.SDMX Registry.WebHome]]. 101 101 102 102 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_1edb9829.jpg||height="407" width="553"]] 103 103 ... ... @@ -105,17 +105,17 @@ 105 105 106 106 == {{id name="_Toc93837"/}}3.4 Notification == 107 107 108 -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:xwiki:Glossary.Reference metadata.WebHome]] or changes in [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] involves: 109 109 110 -* registry support of a subscription-based notification service which sends an email or notifies an HTTP address announcing all published data that meets the criteria contained in the subscription request. 111 +* registry support of a [[subscription>>doc:xwiki:Glossary.Subscription.WebHome]]-based [[notification>>doc:xwiki: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:xwiki:Glossary.Subscription.WebHome]] request. 111 111 112 112 == {{id name="_Toc93838"/}}3.5 Discovery == 113 113 114 -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:xwiki: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:xwiki:Glossary.Statistical data and metadata exchange.WebHome]]-enabled data or [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] resource: 115 115 116 -* 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; 117 -* 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; 118 -* 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:xwiki:Glossary.Category scheme.WebHome]] to find [[Dataflows>>doc:xwiki:Glossary.Dataflow.WebHome]] (and hence [[Data Structure Definitions>>doc:xwiki:Glossary.Data structure definition.WebHome]]) and [[Metadataflows>>doc:xwiki:Glossary.Metadataflow.WebHome]] which structure the type of data and/or [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] being sought; 118 +* build a query, in terms of the selected [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] or [[Metadata Structure Definition>>doc:xwiki:Glossary.Metadata structure definition.WebHome]], which specifies what data are required and submitting this to a service that can query an [[SDMX registry>>doc:xwiki:Glossary.SDMX Registry.WebHome]] which will return a list of (URLs of) data and [[reference metadata>>doc:xwiki: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:xwiki:Glossary.Reference metadata.WebHome]] from the supplied URLs. 119 119 120 120 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_1f4779f4.jpg||height="328" width="554"]] 121 121 ... ... @@ -125,7 +125,7 @@ 125 125 126 126 == {{id name="_Toc93840"/}}4.1 Architectural Schematic == 127 127 128 -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:xwiki: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:xwiki:Glossary.Structural metadata.WebHome]] repository which supports a provisioning [[metadata repository>>doc:xwiki:Glossary.Metadata repository.WebHome]] which supports the registry services. These are all supported by the [[SDMX-ML>>doc:xwiki: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:xwiki:Glossary.Structural metadata.WebHome]] required to drive these applications. 129 129 130 130 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_99c4cc7e.jpg||height="325" width="553"]] 131 131 ... ... @@ -133,18 +133,18 @@ 133 133 134 134 == {{id name="_Toc93841"/}}4.2 Structural Metadata Repository == 135 135 136 -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:xwiki:Glossary.Structural metadata.WebHome]] service which supports the lifecycle of [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] such as [[Maintenance Agencies>>doc:xwiki:Glossary.Maintenance agency.WebHome]], [[Data Structure Definitions>>doc:xwiki:Glossary.Data structure definition.WebHome]], [[Metadata Structure Definitions>>doc:xwiki:Glossary.Metadata structure definition.WebHome]], [[Provision Agreements>>doc:xwiki:Glossary.Provision agreement.WebHome]], Processes etc. This layer is supported by the Structure Submission and Query Service. 137 137 138 -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:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] REST API supports all of the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] structural [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]]. The only structural [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] that are not yet supported are: 139 139 140 140 * Registration of data and metadata sources 141 -* Subscription and Notification 142 +* [[Subscription>>doc:xwiki:Glossary.Subscription.WebHome]] and [[Notification>>doc:xwiki:Glossary.Notification.WebHome]] 142 142 143 -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:#2ecc71" %)version(%%) of [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 no messages are defined to support these [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]]; hence, users may need to use [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] 2.1 Registry Interface messages, instead. 144 144 145 145 == {{id name="_Toc93842"/}}4.3 Provisioning Metadata Repository == 146 146 147 -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:xwiki:Glossary.Structural metadata.WebHome]] that describes the various types of data-store which model [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]]-conformant databases or files, and to link to these [[data sources>>doc:xwiki:Glossary.Data source.WebHome]]. These links can be specified for a data/metadata provider, for a specific data or [[metadata flow>>doc:xwiki:Glossary.Metadataflow.WebHome]]. In the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] model this is called the Provision or Metadata [[Provision Agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]]. 148 148 149 149 This layer is supported by the Data and Metadata Registration Service. 150 150 ... ... @@ -155,25 +155,25 @@ 155 155 The Registry Interfaces are: 156 156 157 157 * Notify Registry Event 158 -* Submit Subscription Request 159 -* Submit Subscription Response 159 +* Submit [[Subscription>>doc:xwiki:Glossary.Subscription.WebHome]] Request 160 +* Submit [[Subscription>>doc:xwiki:Glossary.Subscription.WebHome]] Response 160 160 * Submit Registration Request 161 161 * Submit Registration Response 162 162 * Query Registration Request 163 163 * Query Registration Response 164 -* Query Subscription Request 165 -* Query Subscription Response 165 +* Query [[Subscription>>doc:xwiki:Glossary.Subscription.WebHome]] Request 166 +* Query [[Subscription>>doc:xwiki:Glossary.Subscription.WebHome]] Response 166 166 167 167 The registry interfaces are invoked in one of two ways: 168 168 169 -1. The interface is the name of the root node of the SDMX-ML document 170 -1. The interface is invoked as a child element of the RegistryInterface message where the RegistryInterface is the root node of the SDMX-ML document. 170 +1. The interface is the name of the root node of the [[SDMX-ML>>doc:xwiki: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:xwiki:Glossary.SDMX-ML.WebHome]] document. 171 171 172 -In addition to these interfaces the registry must support a mechanism for submitting and querying for structural metadata. This is detailed in sections 5.2.2 and 5.2.3. 173 +In addition to these interfaces the registry must support a mechanism for submitting and querying for [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]]. This is detailed in sections 5.2.2 and 5.2.3. 173 173 174 -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:xwiki:Glossary.Statistical data and metadata exchange.WebHome]]-RR interface, is a “Request” document. The message returned by the interface is a “Response” document. 175 175 176 -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:xwiki: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. 177 177 178 178 == {{id name="_Toc93845"/}}5.2 Registry Services == 179 179 ... ... @@ -183,42 +183,42 @@ 183 183 184 184 === {{id name="_Toc93847"/}}5.2.2 Structure Submission Service === 185 185 186 -The registry must support a mechanism for submitting structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: __[[https:~~/~~/github.com/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[twg/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[rest>>url:https://github.com/sdmx-twg/sdmx-rest]]__[[)>>url:https://github.com/sdmx-twg/sdmx-rest]]. In order for the architecture to be scalable, the finest-grained piece of structural metadata that can be processed by the SDMX-RR is a MaintainableArtefact, with the exception of Item Schemes, where changes at an Item level is also possible (see next section on the SDMX Information Model).187 +The registry must support a mechanism for submitting [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]]. This mechanism can be the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] REST interface for [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] (this is defined in the corresponding GitHub project, dedicated to the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] REST API: [[__https:~~/~~/github.com/__>>https://https:github.comsdmx-twgsdmx-rest]][[sdmx>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]]-twg/[[sdmx>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]]-rest). In order for the architecture to be scalable, the finest-grained piece of [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] that can be processed by the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]]-RR is a MaintainableArtefact, with the exception of [[Item Schemes>>doc:xwiki:Glossary.Item scheme.WebHome]], where changes at an Item (% style="color:#2ecc71" %)level(%%) is also possible (see next section on the [[SDMX Information Model>>doc:xwiki:Glossary.SDMX Information Model.WebHome]]). 187 187 188 188 === {{id name="_Toc93848"/}}5.2.3 Structure Query Service === 189 189 190 -The registry must support a mechanism for querying for structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: __[[https:~~/~~/github.com/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[twg/sdmx>>url:https://github.com/sdmx-twg/sdmx-rest]][[->>url:https://github.com/sdmx-twg/sdmx-rest]][[rest>>url:https://github.com/sdmx-twg/sdmx-rest]]__[[)>>url:https://github.com/sdmx-twg/sdmx-rest]]. The registry response to this query mechanism is the SDMX Structure message, which has as its root node:191 +The registry must support a mechanism for querying for [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]]. This mechanism can be the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] REST interface for [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] (this is defined in the corresponding GitHub project, dedicated to the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] REST API: [[__https:~~/~~/github.com/__>>https://https:github.comsdmx-twgsdmx-rest]][[sdmx>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]]-twg/[[sdmx>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]]-rest). The registry response to this query mechanism is the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Structure message, which has as its root node: 191 191 192 192 * Structure 193 193 194 -The SDMX structural artefacts that may be queried are: 195 +The [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] structural [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] that may be queried are: 195 195 196 -* data flows and metadata flows 197 -* data structure definitions and metadata structure definitions 198 -* code lists 197 +* [[data flows>>doc:xwiki:Glossary.Dataflow.WebHome]] and [[metadata flows>>doc:xwiki:Glossary.Metadataflow.WebHome]] 198 +* [[data structure definitions>>doc:xwiki:Glossary.Data structure definition.WebHome]] and [[metadata structure definitions>>doc:xwiki:Glossary.Metadata structure definition.WebHome]] 199 +* [[code>>doc:xwiki:Glossary.Code.WebHome]] lists 199 199 * value lists 200 -* concept schemes 201 +* (% style="color:#2ecc71" %)concept(%%) schemes 201 201 * reporting taxonomies 202 -* provision agreements and metadata provision agreements 203 +* [[provision agreements>>doc:xwiki:Glossary.Provision agreement.WebHome]] and metadata [[provision agreements>>doc:xwiki:Glossary.Provision agreement.WebHome]] 203 203 * structure maps 204 -* representation map 205 +* [[representation>>doc:xwiki:Glossary.Representation.WebHome]] map 205 205 * organisation scheme map 206 -* concept scheme map 207 -* category scheme map 207 +* (% style="color:#2ecc71" %)concept(%%) scheme map 208 +* [[category>>doc:xwiki:Glossary.Category.WebHome]] scheme map 208 208 * reporting taxonomy map 209 209 * processes 210 210 * hierarchies 211 -* constraints 212 -* category schemes 213 -* 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) 214 -* organisation schemes (agency scheme, data provider scheme, data consumer scheme, organisation unit scheme) 212 +* (% style="color:#2ecc71" %)constraints 213 +* [[category>>doc:xwiki:Glossary.Category.WebHome]] schemes 214 +* categorisations and categorised objects (examples are categorised [[data flows>>doc:xwiki:Glossary.Dataflow.WebHome]] and [[metadata flows>>doc:xwiki:Glossary.Metadataflow.WebHome]], [[data structure definitions>>doc:xwiki:Glossary.Data structure definition.WebHome]], [[metadata structure definitions>>doc:xwiki:Glossary.Metadata structure definition.WebHome]], [[provision agreements>>doc:xwiki:Glossary.Provision agreement.WebHome]] registered [[data sources>>doc:xwiki:Glossary.Data source.WebHome]] and metadata sources) 215 +* organisation schemes ([[agency scheme>>doc:xwiki:Glossary.Agency scheme.WebHome]], [[data provider scheme>>doc:xwiki:Glossary.Data provider scheme.WebHome]], [[data consumer scheme>>doc:xwiki:Glossary.Data consumer scheme.WebHome]], organisation unit scheme) 215 215 216 -Due to the VTL implementation the other structural metadata artefacts that may be queried are: 217 +Due to the [[VTL>>doc:xwiki:Glossary.Validation and transformation language.WebHome]] implementation the other [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] that may be queried are: 217 217 218 218 * Transformation schemes 219 219 * Custom type schemes 220 220 * Name personalisation schemes 221 -* VTL mapping schemes 222 +* [[VTL>>doc:xwiki:Glossary.Validation and transformation language.WebHome]] mapping schemes 222 222 * Ruleset schemes 223 223 * User defined operator schemes 224 224 ... ... @@ -231,35 +231,34 @@ 231 231 * QueryRegistrationRequest 232 232 * QueryRegistrationResponse 233 233 234 -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:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] conformant files and webaccessible databases containing published data and [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] to be registered in the [[SDMX Registry>>doc:xwiki:Glossary.SDMX Registry.WebHome]]. The registration process MAY validate the content of the [[datasets>>doc:xwiki:Glossary.Data set.WebHome]] or metadatasets, and MAY extract a concise [[representation>>doc:xwiki:Glossary.Representation.WebHome]] of the contents in terms of (% style="color:#2ecc71" %)concept(%%) values (e.g., values of the data [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]], [[dimension>>doc:xwiki:Glossary.Dimension.WebHome]], metadata [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]]), or entire keys, and storing this as a record in the registry to enable discovery of the original [[dataset>>doc:xwiki:Glossary.Data set.WebHome]] or metadata-set. These are called (% style="color:#2ecc71" %)Constraints(%%) in the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]]-IM. 235 235 236 236 The Data and Metadata Registration Service MAY validate the following, subject to the access control mechanism implemented in the Registry: 237 237 238 -* that the data/metadata provider is allowed to register the dataset or metadataset; 239 -* 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; 240 -* that a queryable data source exists – this would necessitate the registration service querying the service to determine its existence; 241 -* that a simple data source exists (i.e., a file accessible at a URL); 242 -* that the correct Data Structure Definition or Metadata Structure Definition is used by the registered data; 243 -* that the components (Dimensions, Attributes, Measures, Metadata Attributes, etc.) are consistent with the Data Structure Definition or Metadata Structure Definition; 244 -* that the valid representations of the concepts to which these components correspond conform to the definition in the Data Structure Definition or Metadata Structure Definition. The Registration has an action attribute which takes one of the following values: 239 +* that the data/metadata provider is allowed to register the [[dataset>>doc:xwiki:Glossary.Data set.WebHome]] or metadataset; 240 +* that the content of the [[dataset>>doc:xwiki:Glossary.Data set.WebHome]] or metadataset meets the validation (% style="color:#2ecc71" %)constraints(%%). This is dependent upon such (% style="color:#2ecc71" %)constraints(%%) being defined in the structural repository and which reference the relevant [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]], [[Metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]], [[Data Provider>>doc:xwiki:Glossary.Data provider.WebHome]], Metadata Provider, [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]], [[Metadata Structure Definition>>doc:xwiki:Glossary.Metadata structure definition.WebHome]], [[Provision Agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]], Metadata [[Provision Agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]]; 241 +* that a queryable [[data source>>doc:xwiki: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:xwiki:Glossary.Data source.WebHome]] exists (i.e., a file accessible at a URL); 243 +* that the correct [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] or [[Metadata Structure Definition>>doc:xwiki:Glossary.Metadata structure definition.WebHome]] is used by the registered data; 244 +* that the [[components>>doc:xwiki:Glossary.Component.WebHome]] ([[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]], [[Attributes>>doc:xwiki:Glossary.Attribute.WebHome]], [[Measures>>doc:xwiki:Glossary.Measure.WebHome]], Metadata [[Attributes>>doc:xwiki:Glossary.Attribute.WebHome]], etc.) are consistent with the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] or [[Metadata Structure Definition>>doc:xwiki:Glossary.Metadata structure definition.WebHome]]; 245 +* that the valid [[representations>>doc:xwiki:Glossary.Representation.WebHome]] of the (% style="color:#2ecc71" %)concepts(%%) to which these [[components>>doc:xwiki:Glossary.Component.WebHome]] correspond conform to the definition in the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] or [[Metadata Structure Definition>>doc:xwiki:Glossary.Metadata structure definition.WebHome]]. The Registration has an action [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] which takes one of the following values: 245 245 246 -|**Action Attribute Value**|**Behaviour** 247 -|Append|Add this registration to the registry 248 -|Replace|Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request 249 -|Delete|Delete the existing Registration identified by the id in the Registration of the Submit Registration Request 247 +(% style="width:755.294px" %) 248 +|(% style="width:187px" %)**Action Attribute Value**|(% style="width:566px" %)**Behaviour** 249 +|(% style="width:187px" %)Append|(% style="width:566px" %)Add this registration to the registry 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 +|(% style="width:187px" %)Delete|(% style="width:566px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request 250 250 251 -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:xwiki:Glossary.Attribute.WebHome]] which may be present to determine how an [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] compliant [[dataset>>doc:xwiki:Glossary.Data set.WebHome]] or metadataset indexing application must index the [[datasets>>doc:xwiki:Glossary.Data set.WebHome]] or metadatasets upon registration. The indexing application behaviour is as follows: 252 252 253 -|**Boolean Attribute**|**Behaviour if Value is “true”** 254 -|indexTimeSeries|A compliant indexing application must index all the time series keys (for a Dataset registration) or metadata target values (for a Metadataset registration) 255 -|indexDataSet|((( 256 -A compliant indexing application must index the range of actual 257 - 258 -(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. 259 - 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 255 +(% style="width:759.294px" %) 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>>doc:xwiki:Glossary.Series key.WebHome]] (for a [[Dataset>>doc:xwiki:Glossary.Data set.WebHome]] registration) or metadata target values (for a Metadataset registration) 258 +|(% style="width:191px" %)indexDataSet|(% style="width:565px" %)((( 259 +A compliant indexing application must index the range of actual (present) values for each [[dimension>>doc:xwiki:Glossary.Dimension.WebHome]] of the [[Dataset>>doc:xwiki:Glossary.Data set.WebHome]] (for a [[Dataset>>doc:xwiki:Glossary.Data set.WebHome]] registration) or the range of actual (present) values for each Metadata [[Attribute>>doc:xwiki: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:xwiki:Glossary.Dimension.WebHome]] values (the Key) is actually present in the [[Dataset>>doc:xwiki:Glossary.Data set.WebHome]] 261 261 ))) 262 -|indexReportingPeriod|A compliant indexing application must index the time period range(s) for which data are present in the Dataset. The validity period of the Metadatasets may also be indexed. 262 +|(% style="width:191px" %)indexReportingPeriod|(% style="width:565px" %)A compliant indexing application must index the [[time period>>doc:xwiki:Glossary.Time period.WebHome]] range(s) for which data are present in the [[Dataset>>doc:xwiki: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,55 +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:xwiki:Glossary.Subscription.WebHome]] and [[Notification>>doc:xwiki: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:xwiki:Glossary.Data provider.WebHome]]’ dissemination systems. For this to work efficiently, a [[data consumer>>doc:xwiki: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:xwiki:Glossary.Data set.WebHome]] has been updated and re-registered). Additionally, [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] systems may also want to know if a new [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]], [[Code List>>doc:xwiki:Glossary.Code list.WebHome]] or [[Metadata Structure Definition>>doc:xwiki:Glossary.Metadata structure definition.WebHome]] has been added. The [[Subscription>>doc:xwiki:Glossary.Subscription.WebHome]] and [[Notification>>doc:xwiki:Glossary.Notification.WebHome]] Service comprises two parts: [[subscription>>doc:xwiki:Glossary.Subscription.WebHome]] management, and [[notification>>doc:xwiki:Glossary.Notification.WebHome]]. 280 280 281 -Subscription management involves a user submitting a subscription request which contains: 281 +[[Subscription>>doc:xwiki:Glossary.Subscription.WebHome]] management involves a user submitting a [[subscription>>doc:xwiki: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:#2ecc71" %)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:xwiki:Glossary.Dataflow.WebHome]], or for a domain [[category>>doc:xwiki:Glossary.Category.WebHome]], or changes to a [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]]). 284 +* a list of URIs or endpoints to which an XML [[notification>>doc:xwiki: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:xwiki: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:xwiki:Glossary.Notification.WebHome]] requires that the [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] repository and the provisioning [[metadata repository>>doc:xwiki:Glossary.Metadata repository.WebHome]] monitor any event which is of interest to a user (the object of a [[subscription>>doc:xwiki:Glossary.Subscription.WebHome]] request query), and to issue an [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] [[notification>>doc:xwiki: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:xwiki:Glossary.SDMX Registry.WebHome]] for the various Registry Interface messages. It should be noted, though, that as of [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] 3.0, an extended versioning scheme newly including semantic versioning is foreseen for all [[Maintainable Artefacts>>doc:xwiki: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:#2ecc71" %)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:xwiki:Glossary.Artefact.WebHome]] using semantic versioning or any [[Artefacts>>doc:xwiki: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:xwiki:Glossary.Artefact.WebHome]] that follows semantic versioning, unless a newer (% style="color:#2ecc71" %)version(%%) is introduced according to the semantic versioning rules. Furthermore, even when draft [[Artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] are submitted, the registry has to verify semantic versioning is respected against the previous non-draft (% style="color:#2ecc71" %)versions(%%). It is worth noting that the rules for semantic versioning and replacing or maintaining semantically versioned [[Artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] applies to externally shared [[Artefacts>>doc:xwiki:Glossary.Artefact.WebHome]]. This means that any system may internally perform any change within a (% style="color:#2ecc71" %)version(%%) of an [[Artefact>>doc:xwiki:Glossary.Artefact.WebHome]], until the latter is shared outside of that system or becomes public. Then (as also explained in the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”) the [[Artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] must adhere to the Semantic Versioning rules. 295 295 296 -|**Interface**|**Behaviour** 297 -|All|((( 298 -1. If the action is set to “replace” (or a maintainable Artefact is PUT or POSTed) then the entire contents of the existing maintainable object in the Registry MUST be replaced by the object submitted. 296 +(% style="width:757.294px" %) 297 +|(% style="width:188px" %)**Interface**|(% style="width:542px" %)**Behaviour** 298 +|(% style="width:188px" %)All|(% style="width:542px" %)((( 299 +1. If the action is set to “replace” (or a [[maintainable Artefact>>doc:xwiki: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. 299 299 1. Cross referenced structures MUST exist in either the submitted document (in Structures or Structure Location) or in the registry to which the request is submitted. 300 -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:xwiki: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: 301 301 302 -a) Be a draft version. 303 +a) Be a draft (% style="color:#2ecc71" %)version(%%). 303 303 ))) 304 -|**Interface**|**Behaviour** 305 -| |((( 306 -b) Not be explicitly^^[[(% class="wikiinternallink wikiinternallink" %)^^1^^>>path:#sdfootnote1sym||name="sdfootnote1anc"]](%%)^^ referenced from any other object in the Registry. 307 - 308 -4) The semantic versioning rules in the SDMX documentation MUST be obeyed. 305 +|(% style="width:188px" %) |(% style="width:542px" %)((( 306 +b) Not be explicitly{{footnote}}With semantic versioning, it is allowed to reference a range of artefacts, e.g., a DSD referencing a Codelist with version 1.2.3+ means all patch versions greater than 1.2.3. This means that deleting 1.2.4-draft does not break integrity of the aforementioned DSD.{{/footnote}} referenced from any other object in the Registry. 307 +4) The semantic versioning rules in the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] documentation MUST be obeyed. 309 309 ))) 310 -|Structure submission|Structures are submitted at the level of the Maintainable Artefact and the behaviour in “All” above is therefore at the level of the Maintainable Artefact. 311 -|SubmitRegistrationRequest|If the datasource is a file (simple datasource) then the file MAY be retrieved and indexed according to the Boolean attributes set in the Registration. For a queryable datasource the Registry MAY validate that the source exists and can accept an SDMX data query. 309 +|(% style="width:188px" %)Structure submission|(% style="width:542px" %)Structures are submitted at the (% style="color:#2ecc71" %)level(%%) of the [[Maintainable Artefact>>doc:xwiki:Glossary.Maintainable artefact.WebHome]] and the behaviour in “All” above is therefore at the (% style="color:#2ecc71" %)level(%%) of the [[Maintainable Artefact>>doc:xwiki: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:xwiki: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:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] data query. 312 312 313 313 = {{id name="_Toc93853"/}}6 Identification of SDMX Objects = 314 314 315 315 == {{id name="_Toc93854"/}}6.1 Identification, Versioning, and Maintenance == 316 316 317 -All major classes of the SDMX Information model inherit from one of: 316 +All major classes of the [[SDMX Information model>>doc:xwiki:Glossary.SDMX Information Model.WebHome]] inherit from one of: 318 318 319 319 * //**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. 320 320 * //**NameableArtefact**// – this has all of the features of //IdentifiableArtefact// plus the ability to have a multi-lingual name and description. 321 -* //**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:#2ecc71" %)version(%%) number, according to the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules in [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”, and a validity period. 322 322 * //**MaintainableArtefact**// – this has all of the above features, plus registry and structure URIs, and an association to the maintenance organisation of the object. 323 323 324 324 === {{id name="_Toc93855"/}}6.1.1 Identification, Naming, Versioning, and Maintenance Model === ... ... @@ -327,66 +327,65 @@ 327 327 328 328 **Figure 5: Class diagram of fundamental artefacts in the SDMX-IM** 329 329 330 -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:xwiki:Glossary.Attribute.WebHome]] to be stored in a registry for objects that are one of: 331 331 332 -* // Annotable//331 +* //nnotable// 333 333 * //Identifiable// 334 334 * //Nameable// 335 335 * //Versionable// 336 336 * //Maintainable// 337 337 338 -: 339 - 340 340 ((( 341 -|**Object Type**|**Data Attributes**|**Status**|**Data type**|**Notes** 342 -|(% rowspan="4" %)//Annotable//|AnnotationTitle|C|string| 343 -|AnnotationType|C|string| 344 -|AnnotationURN|C|string| 345 -|AnnotationText in the form of InternationalString|C| |This can have languagespecific variants 346 -|(% rowspan="4" %)//Identifiable//|All content as for //Annotable// plus| | | 347 -|id|M|string| 348 -|uri|C|string| 349 -|urn|C|string|Although the urn is computable and therefore may not be submitted or stored physically, the Registry must return the urn for each object, and must be able to service a query on an object referenced solely by its urn. 350 -|(% rowspan="3" %)//Nameable//|All content as for //Identifiable// plus| | | 351 -|Name in the form of InternationalString|M|string|This can have language specific variants. 352 -|Description in the form of InternationalString|C|string|This can have language specific variants. 353 -|(% rowspan="4" %)//Versionable//|All content as for //Identifiable// plus| | | 354 -|version|M|string|This is the version number according to SDMX versioning rules. 355 -|validFrom|C|Date/time| 356 -|validTo|C|Date/time| 357 -|//Maintainable//|All content as for //Versionable// plus| | | 358 -| |isExternalReference|C|boolean|Value of “true” indicates that the actual resource is held outside of this registry. The actual reference is given in the registry URI or the structureURL, each of which must return a valid SDMX-ML file. 359 -| |serviceURL|C|string|The url of the service that can be queried for this resource. 360 -| |structureURL|C|string|The url of the resource. 361 -| |(Maintenance) organisationId|M|string|The object must be linked to a maintenance organisation, i.e., Agency or Metadata Provider. 338 +(% style="width:1052.29px" %) 339 +|**Object Type**|(% style="width:241px" %)**Data Attributes**|(% style="width:156px" %)**Status**|**Data type**|(% style="width:457px" %)**Notes** 340 +|(% rowspan="4" %)//Annotable//|(% style="width:241px" %)AnnotationTitle|(% style="width:156px" %)C|string|(% style="width:457px" %) 341 +|(% style="width:241px" %)AnnotationType|(% style="width:156px" %)C|string|(% style="width:457px" %) 342 +|(% style="width:241px" %)AnnotationURN|(% style="width:156px" %)C|string|(% style="width:457px" %) 343 +|(% style="width:241px" %)AnnotationText in the form of InternationalString|(% style="width:156px" %)C| |(% style="width:457px" %)This can have languagespecific variants 344 +|(% rowspan="4" %)//Identifiable//|(% style="width:241px" %)All content as for //Annotable// plus|(% style="width:156px" %) | |(% style="width:457px" %) 345 +|(% style="width:241px" %)id|(% style="width:156px" %)M|string|(% style="width:457px" %) 346 +|(% style="width:241px" %)uri|(% style="width:156px" %)C|string|(% style="width:457px" %) 347 +|(% style="width:241px" %)urn|(% style="width:156px" %)C|string|(% style="width:457px" %)Although the urn is computable and therefore may not be submitted or stored physically, the Registry must return the urn for each object, and must be able to service a query on an object referenced solely by its urn. 348 +|(% rowspan="3" %)//Nameable//|(% style="width:241px" %)All content as for //Identifiable// plus|(% style="width:156px" %) | |(% style="width:457px" %) 349 +|(% style="width:241px" %)Name in the form of InternationalString|(% style="width:156px" %)M|string|(% style="width:457px" %)This can have language specific variants. 350 +|(% style="width:241px" %)Description in the form of InternationalString|(% style="width:156px" %)C|string|(% style="width:457px" %)This can have language specific variants. 351 +|(% rowspan="4" %)//Versionable//|(% style="width:241px" %)All content as for //Identifiable// plus|(% style="width:156px" %) | |(% style="width:457px" %) 352 +|(% style="width:241px" %)(% style="color:#2ecc71" %)version|(% style="width:156px" %)M|string|(% style="width:457px" %)This is the (% style="color:#2ecc71" %)version(%%) number according to [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules. 353 +|(% style="width:241px" %)validFrom|(% style="width:156px" %)C|Date/time|(% style="width:457px" %) 354 +|(% style="width:241px" %)validTo|(% style="width:156px" %)C|Date/time|(% style="width:457px" %) 355 +|//Maintainable//|(% style="width:241px" %)All content as for //Versionable// plus|(% style="width:156px" %) | |(% style="width:457px" %) 356 +| |(% style="width:241px" %)isExternalReference|(% style="width:156px" %)C|boolean|(% style="width:457px" %)Value of “true” indicates that the actual resource is held outside of this registry. The actual reference is given in the registry URI or the structureURL, each of which must return a valid [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] file. 357 +| |(% style="width:241px" %)serviceURL|(% style="width:156px" %)C|string|(% style="width:457px" %)The url of the service that can be queried for this resource. 358 +| |(% style="width:241px" %)structureURL|(% style="width:156px" %)C|string|(% style="width:457px" %)The url of the resource. 359 +| |(% style="width:241px" %)(Maintenance) organisationId|(% style="width:156px" %)M|string|(% style="width:457px" %)The object must be linked to a maintenance organisation, i.e., Agency or Metadata Provider. 362 362 ))) 363 363 364 364 **Table 1: Common Attributes of Object Types** 365 365 366 -== ={{id name="_Toc93856"/}}6.2 Unique identification of SDMX objects ===364 +== {{id name="_Toc93856"/}}6.2 Unique identification of SDMX objects == 367 367 368 -=== =={{id name="_Toc93857"/}}6.2.1 Agencies and Metadata Providers =====366 +=== {{id name="_Toc93857"/}}6.2.1 Agencies and Metadata Providers === 369 369 370 -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:xwiki:Glossary.Maintenance agency.WebHome]] in [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] is maintained in an [[Agency Scheme>>doc:xwiki:Glossary.Agency scheme.WebHome]] which itself is a sub class of Organisation Scheme – this is shown in the class diagram below. 371 371 372 372 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_c71516c5.jpg||height="313" width="554"]] 373 373 374 374 **Figure 6: Agency Scheme Model** 375 375 376 -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:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] is extremely important. The Agency Id system used in [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] is an nlevel structure. The top (% style="color:#2ecc71" %)level(%%) of this structure is maintained by [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]]. Any Agency in this top (% style="color:#2ecc71" %)level(%%) can declare sub agencies and any sub agency can also declare sub agencies. The [[Agency Scheme>>doc:xwiki:Glossary.Agency scheme.WebHome]] has a fixed id and (% style="color:#2ecc71" %)version(%%) ((% style="color:#2ecc71" %)version(%%) ‘1.0’) and is never declared explicitly in the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] object identification mechanism. 377 377 378 -In order to achieve this SDMX adopts the following rules: 376 +In order to achieve this [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] adopts the following rules: 379 379 380 -* Agencies are maintained in an Agency Scheme (which is a sub class of Organisation Scheme). 381 -* The agency of the Agency Scheme must also be declared in a (different) Agency Scheme. 382 -* The “top-level” agency is SDMX and maintains the “top-level” Agency Scheme. 383 -* 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. 384 -* 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:xwiki:Glossary.Agency scheme.WebHome]] (which is a sub class of Organisation Scheme). 379 +* The agency of the [[Agency Scheme>>doc:xwiki:Glossary.Agency scheme.WebHome]] must also be declared in a (different) [[Agency Scheme>>doc:xwiki:Glossary.Agency scheme.WebHome]]. 380 +* The “top-(% style="color:#2ecc71" %)level(%%)” agency is [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] and maintains the “top-(% style="color:#2ecc71" %)level(%%)” [[Agency Scheme>>doc:xwiki:Glossary.Agency scheme.WebHome]]. 381 +* Agencies registered in the top-(% style="color:#2ecc71" %)level(%%) scheme can themselves maintain a single [[Agency Scheme>>doc:xwiki:Glossary.Agency scheme.WebHome]]. Agencies in these second-tier schemes can themselves maintain a single [[Agency Scheme>>doc:xwiki:Glossary.Agency scheme.WebHome]] and so on. 382 +* The AgencyScheme has a fixed (% style="color:#2ecc71" %)version(%%), i.e., ‘1.0’, hence it is an exception from the Semantic Versioning that other [[Artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] follow. 385 385 * There can be only one AgencyScheme maintained by any one Agency. It has a fixed id of AGENCIES. 386 -* The /hierarchy of Organisation is not inherited by Maintenance Agency – thus each Agency Scheme is a flat list of Maintenance Agencies. 387 -* 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:xwiki:Glossary.Maintenance agency.WebHome]] – thus each [[Agency Scheme>>doc:xwiki: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:#2ecc71" %)level(%%) agency in this identification mechanism is the agency registered in the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] [[agency scheme>>doc:xwiki:Glossary.Agency scheme.WebHome]]. 388 388 389 -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:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] is not a part of the hierarchical ID structure for agencies. However, [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] is, itself, a [[maintenance agency>>doc:xwiki:Glossary.Maintenance agency.WebHome]] and is contained in the top-(% style="color:#2ecc71" %)level(%%) [[Agency Scheme>>doc:xwiki:Glossary.Agency scheme.WebHome]]. 390 390 391 391 This supports a hierarchical structure of agencyID. 392 392 ... ... @@ -394,70 +394,50 @@ 394 394 395 395 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_eaceb05e.jpg||height="251" width="432"]] 396 396 397 -**Figure 7: Example of Hierarchic Structure of Agencies ** The following organizations maintain an Agency Scheme.395 +**Figure 7: Example of Hierarchic Structure of Agencies ** 398 398 397 +The following organizations maintain an Agency Scheme. 398 + 399 399 * SDMX – contains Agencies AA, BB 400 400 * AA – contains Agencies CC, DD 401 401 * BB – contains Agencies CC, DD 402 402 * DD – Contains Agency EE 403 403 404 -Each agency is identified by its full hierarchy excluding SDMX. 404 +Each agency is identified by its full [[hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] excluding SDMX. 405 405 406 406 e.g., the id of EE as an agencyID is AA.DD.EE 407 407 408 408 An example of this is shown in the XML snippet below: 409 409 410 - **<str:Codelists>**410 +[[image:1747307906944-697.png]] 411 411 412 -**<str:Codelist id="CL_FREQ" agencyID="SDMX" version="1.0.0">** 413 - 414 -**<com:Name xml:lang="en">Standard frequency Codelist</com:Name>** 415 - 416 -**</str:Codelist>** 417 - 418 -**<str:Codelist id="CL_FREQ" agencyID="AA" version="1.0.0">** 419 - 420 -**<com:Name xml:lang="en">Codelist maintained by agency AA</com:Name>** 421 - 422 -**</str:Codelist>** 423 - 424 -**<str:Codelist id="CL_FREQ" agencyID="AA.CC" version="1.0.0">** 425 - 426 -**<com:Name xml:lang="en">Codelist maintained by the AA unit CC</com:Name>** 427 - 428 -**</str:Codelist>** 429 - 430 -**<str:Codelist id="CL_FREQ" agencyID="BB.CC" version="1.0.0">** 431 - 432 -**<com:Name xml:lang="en">Codelist maintained by the BB unit CC</com:Name>** 433 - 434 -**</str:Codelist>** 435 - 436 436 **Figure 8: Example Showing Use of Agency Identifiers** 437 437 438 -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:xwiki:Glossary.Maintenance agency.WebHome]] has an identical [[Code list>>doc:xwiki:Glossary.Code list.WebHome]] with the Id CL_BOP. However, each is uniquely identified by means of the hierarchic agency structure. 439 439 440 -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:xwiki:Glossary.Maintainable artefact.WebHome]], i.e., the Metadatasets; the latter are the containers of [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] combined with a target that those metadata refer to. 441 441 442 -=== =={{id name="_Toc93858"/}}6.2.2 Universal Resource Name (URN) =====418 +=== {{id name="_Toc93858"/}}6.2.2 Universal Resource Name (URN) === 443 443 444 - **6.2.2.1 Introduction**420 +==== 6.2.2.1 Introduction ==== 445 445 446 -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:xwiki: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:xwiki:Glossary.SDMX Information Model.WebHome]] objects. Most of these unique identifiers are composite (containing [[maintenance agency>>doc:xwiki: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:xwiki:Glossary.Component.WebHome]] in the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]]-RR APIs. In other words, the URN for any [[Identifiable Artefact>>doc:xwiki:Glossary.Identifiable artefact.WebHome]] is constructed from its [[component>>doc:xwiki:Glossary.Component.WebHome]] identifiers (agency, id, (% style="color:#2ecc71" %)version(%%) etc.). 447 447 448 - **6.2.2.2 URN Structure//__Case Rules for URN__//**// //424 +==== 6.2.2.2 URN Structure ==== 449 449 426 +===== **//__Case Rules for URN__//** ===== 427 + 450 450 For the URN, all parts of the string are case sensitive. The generic structure of the URN is as follows: 451 451 452 -SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobjectid(maintainedobject-version).*containerobject-id.object-id 430 +SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobjectid(maintainedobject-(% style="color:#2ecc71" %)version(%%)).*containerobject-id.object-id 453 453 454 454 ~* this can repeat and may not be present (see explanation below) 455 455 456 -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. 434 +Note that in the [[SDMX Information Model>>doc:xwiki:Glossary.SDMX Information Model.WebHome]] there are no concrete [[Versionable Artefacts>>doc:xwiki:Glossary.Versionable artefact.WebHome]] that are not a [[Maintainable Artefact>>doc:xwiki:Glossary.Maintainable artefact.WebHome]]. For this reason, the only (% style="color:#2ecc71" %)version(%%) information that is allowed is for the maintainable object. 457 457 458 -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. 436 +The [[Maintenance agency>>doc:xwiki:Glossary.Maintenance agency.WebHome]] identifier is separated from the [[maintainable artefact>>doc:xwiki:Glossary.Maintainable artefact.WebHome]] identifier by a colon ‘:’. All other identifiers in the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] URN syntax are separated by a period ‘.’. The (% style="color:#2ecc71" %)version(%%) information is encapsulated in parentheses ‘()’ and adheres to the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules, as explained in [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning. 459 459 460 - **6.2.2.3 Explanation of the generic structure**438 +==== 6.2.2.3 Explanation of the generic structure ==== 461 461 462 462 In the explanation below the actual object that is the target of the URN is called the **actual object**. 463 463 ... ... @@ -467,291 +467,277 @@ 467 467 468 468 The packages are: 469 469 470 -base codelist conceptscheme datastructure categoryscheme registry metadatastructure process structuremapping transformation 448 +base 449 +codelist 450 +conceptscheme 451 +datastructure 452 +categoryscheme 453 +registry 454 +metadatastructure 455 +process 456 +structuremapping 457 +transformation 471 471 472 -**maintainable-object-id** is the identifier of the maintainable object. This will always be present as all identifiable objects are either a maintainable object or contained in a maintainable object. **maintainable-object-version** is the version, according to the SDMX versioning rules, of the maintainable object and is enclosed in parentheses ‘()’, which are always present. **container-object-id** is the identifier of an intermediary object that contains the actual object which the URN is identifying. It is not mandatory as many actual objects do not have an intermediary container object. For instance, a Code is in a maintained object (Codelist) and has no intermediary container object, whereas a MetadataAttribute has an intermediary container object (MetadataAttributeDescriptor) and may have an intermediary container object, which is its parent MetadataAttribute. For this reason, the container object id may repeat, with each repetition identifying the object at the next-lower level in its hierarchy. Note that if there is only a single containing object in the model then it is NOT included in the URN structure. This applies to AttributeDescriptor, DimensionDescriptor, and MeasureDescriptor where there can be only one such object and this object has a fixed id. Therefore, whilst each of these has a URN, the id of the AttributeDescriptor, DimensionDescriptor, and MeasureDescriptor is not included when the actual object is a DataAttribute or a Dimension/ TimeDimension, or a Measure.459 +**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. 473 473 474 - Note thatalthougha Codecan haveaparentCodeand aConcept canhavea parentConceptthesearemaintained inaflatstructureandthereforedonothaveacontainerobject-id.461 +**maintainable-object-(% style="color:#2ecc71" %)version(%%)** is the (% style="color:#2ecc71" %)version(%%), according to the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules, of the maintainable object and is enclosed in parentheses ‘()’, which are always present. 475 475 476 - For example,the sequence is agency:DSDid(version).DimensionId and not agency:DSDid(version).DimensionDescriptorId.DimensionId.463 +**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:xwiki: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:#2ecc71" %)level(%%) in its [[hierarchy>>doc:xwiki: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. 477 477 465 +Note that although a [[Code>>doc:xwiki:Glossary.Code.WebHome]] can have a parent [[Code>>doc:xwiki:Glossary.Code.WebHome]] and a (% style="color:#2ecc71" %)Concept(%%) can have a parent (% style="color:#2ecc71" %)Concept(%%) these are maintained in a flat structure and therefore do not have a containerobject-id. 466 + 467 +For example, the sequence is agency:DSDid((% style="color:#2ecc71" %)version(%%)).DimensionId and not agency:DSDid((% style="color:#2ecc71" %)version(%%)).DimensionDescriptorId.DimensionId. 468 + 478 478 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. 479 479 480 -//__**Generic Examples of the URN Structure**__// 471 +===== //__**Generic Examples of the URN Structure**__// ===== 481 481 482 482 __Actual object is a maintainable__ 483 483 484 -SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version) 475 +SDMXPrefix.[[SDMX-IM>>doc:xwiki:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid((% style="color:#2ecc71" %)version(%%)) 485 485 486 486 __Actual object is contained in a maintained object with no intermediate containing object__ 487 487 488 -SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version).object-id 479 +SDMXPrefix.[[SDMX-IM>>doc:xwiki:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid((% style="color:#2ecc71" %)version(%%)).object-id 489 489 490 490 __Actual object is contained in a maintained object with an intermediate containing object__ 491 491 492 -SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version).contained-object-id.object-id 483 +SDMXPrefix.[[SDMX-IM>>doc:xwiki:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid((% style="color:#2ecc71" %)version(%%)).contained-object-id.object-id 493 493 494 494 __Actual object is contained in a maintained object with no intermediate containing__ __object but__ __the object type itself is hierarchical__ 495 495 496 -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. 487 +In this case the object id may not be unique in itself but only within the context of the [[hierarchy>>doc:xwiki: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:xwiki:Glossary.Category.WebHome]] in a CategoryScheme. The [[Category>>doc:xwiki:Glossary.Category.WebHome]] is hierarchical, and all intermediate [[Categories>>doc:xwiki:Glossary.Category.WebHome]] are shown as a contained object. The example below shows the generic structure for CategoryScheme/ [[Category>>doc:xwiki:Glossary.Category.WebHome]]/ [[Category>>doc:xwiki:Glossary.Category.WebHome]]. 497 497 498 -SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version).contained-object-id.object-id 489 +SDMXPrefix.[[SDMX-IM>>doc:xwiki:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid((% style="color:#2ecc71" %)version(%%)).contained-object-id.object-id 499 499 500 500 Actual object is contained in a maintained object with an intermediate containing object and the object type itself is hierarchical 501 501 502 -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 493 +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:xwiki:Glossary.Metadata structure definition.WebHome]]/ MetadataAttributeDescriptor/ MetadataAttribute/ MetadataAttribute 503 503 504 -SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version).contained-object-id.contained-object-id contained-objectid.object-id 495 +SDMXPrefix.[[SDMX-IM>>doc:xwiki:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid((% style="color:#2ecc71" %)version(%%)).contained-object-id.contained-object-id contained-objectid.object-id 505 505 506 -//__**Concrete Examples of the URN Structure**__// 497 +===== //__**Concrete Examples of the URN Structure**__// ===== 507 507 508 -The Data Structure Definition CRED_EXT_DEBT of legacy version 2.1 maintained by the toplevel Agency TFFS would have the URN: 499 +The [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] CRED_EXT_DEBT of legacy (% style="color:#2ecc71" %)version(%%) 2.1 maintained by the toplevel Agency TFFS would have the URN: 509 509 510 -urn:sdmx:org.sdmx.infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(2.1) 501 + urn:sdmx:org.sdmx.infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(2.1) 511 511 512 -The URN for a code for Argentina maintained by ISO in the code list CL_3166A2 of semantic version 1.0.0 would be: 503 +The URN for a [[code>>doc:xwiki:Glossary.Code.WebHome]] for Argentina maintained by ISO in the [[code list>>doc:xwiki:Glossary.Code list.WebHome]] CL_3166A2 of semantic (% style="color:#2ecc71" %)version(%%) 1.0.0 would be: 513 513 514 -urn:sdmx:org.sdmx.infomodel.codelist.Code=ISO:CL_3166A2(1.0.0).AR 505 + urn:sdmx:org.sdmx.infomodel.codelist.Code=ISO:CL_3166A2(1.0.0).AR 515 515 516 -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: 507 +The URN for a [[category>>doc:xwiki:Glossary.Category.WebHome]] (id of 1) which has parent [[category>>doc:xwiki:Glossary.Category.WebHome]] (id of 2) maintained by [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] in the [[category scheme>>doc:xwiki:Glossary.Category scheme.WebHome]] SUBJECT_MATTER_DOMAINS of the semantic extended (% style="color:#2ecc71" %)version(%%) 1.0.0draft would be: 517 517 518 -urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:SUBJECT_MATT ER_DOMAINS(1.0.0-draft).1.2 509 + urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:SUBJECT_MATT ER_DOMAINS(1.0.0-draft).1.2 519 519 520 -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: 511 +The URN for a Metadata [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] maintained by [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] in the [[MSD>>doc:xwiki:Glossary.Metadata structure definition.WebHome]] CONTACT_METADATA of semantic (% style="color:#2ecc71" %)version(%%) 1.0.0 where the [[hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] of the Metadata [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] is CONTACT_DETAILS/CONTACT_NAME would be: 521 521 522 -urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataAttribute=SDMX: CONTACT_METADATA(1.0.0).CONTACT_DETAILS.CONTACT_NAME 513 + urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataAttribute=SDMX: CONTACT_METADATA(1.0.0).CONTACT_DETAILS.CONTACT_NAME 523 523 524 -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: 515 +The TFFS defines ABC as a sub-Agency of TFFS then the URN of a [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] maintained by ABC and identified as EXTERNAL_DEBT of semantic (% style="color:#2ecc71" %)version(%%) 1.0.0 would be: 525 525 526 -urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=TFFS.ABC:EXTERNAL_ DEBT(1.0.0) 517 + urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=TFFS.ABC:EXTERNAL_ DEBT(1.0.0) 527 527 528 -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: 519 +The [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]]-RR MUST support this globally unique identification scheme. The [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]]-RR MUST be able to create the URN from the individual identification [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]] submitted and to transform the URN to these identification [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]]. The identification [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]] are: 529 529 530 -* **Identifiable and Nameable Artefacts**: id (in some cases this id may be hierarchic) 531 -* **Maintainable Artefacts**: id, version, agencyId 521 +* **Identifiable and [[Nameable Artefacts>>doc:xwiki:Glossary.Nameable artefact.WebHome]]**: id (in some cases this id may be hierarchic) 522 +* **[[Maintainable Artefacts>>doc:xwiki:Glossary.Maintainable artefact.WebHome]]**: id, (% style="color:#2ecc71" %)version(%%), agencyId 532 532 533 -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. 524 +The [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]]-RR MUST be able to resolve the unique identifier of an [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] and to produce an [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] rendering of that [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] if it is located in the Registry. 534 534 535 -=== =={{id name="_Toc93859"/}}6.2.3 Table of SDMX-IM Packages and Classes =====526 +=== {{id name="_Toc93859"/}}6.2.3 Table of SDMX-IM Packages and Classes === 536 536 537 537 The table below lists all of the packages in the SDMX-IM together with the concrete classes that are in these packages and whose objects have a URN. 538 538 539 -|**Package**|**URN class name (model class name where this is different)** 540 -|base|Agency 541 -| |AgencyScheme 542 -| |DataConsumer 543 -| |DataConsumerScheme 544 -| |DataProvider 545 -| |DataProviderScheme 546 -| |MetadataProvider 547 -| |MetadataProviderScheme 548 -| |OrganisationUnit 549 -| |OrganisationUnitScheme 550 -|datastructure|AttributeDescriptor 551 -| |DataAttribute 552 -| |Dataflow 553 -| |DataStructure (DataStructureDefinition) 554 -| |Dimension 555 -| |DimensionDescriptor 556 -| |GroupDimensionDescriptor 557 -| |Measure 558 -| |MeasureDescriptor 559 -| |TimeDimension 560 -| | 561 -|metadatastructure|MetadataAttribute 562 -| |MetadataAttributeDescriptor 563 -| |MetadataStructure MetadataStructureDefinition) 564 -| |Metadataflow 565 -| |MetadataSet 566 -| | 567 -|process|Process 568 -| |ProcessStep 569 -| |Transition 570 -| | 571 -|registry|DataConstraint 572 -| |MetadataConstraint 573 -| |MetadataProvisionAgreement 574 -| |ProvisionAgreement 575 -| |Subscription 576 -| | 577 -|structuremapping|CategorySchemeMap 578 -| |ConceptSchemeMap 579 -| |OrganisationSchemeMap 580 -| |ReportingTaxonomyMap 581 -| |RepresentationMap 582 -| |StructureMap 583 -| | 584 -|codelist|Code 585 -| |Codelist 586 -| |HierarchicalCode 587 -| |Hierarchy 588 -| |HierarchyAssociation 589 -| |Level 590 -| |ValueList 591 -| | 592 -|categoryscheme|Categorisation 593 -| |Category 594 -| |CategoryScheme 595 -| |ReportingCategory 596 -| |ReportingTaxonomy 597 -|conceptscheme|Concept 598 -| |ConceptScheme 599 -| | 600 -|transformation|CustomType 601 -| |CustomTypeScheme 602 -| |NamePersonalisation 603 -| |NamePersonalisationScheme 604 -| |Ruleset 605 -| |RulesetScheme 606 -| |Transformation 607 -| |TransformationScheme 608 -| |UserDefinedOperator 609 -| |UserDefinedOperatorScheme 610 -| |VtlCodelistMapping 611 -| |VtlConceptMapping 612 -| |VtlDataflowMapping 613 -| |VtlMappingScheme 530 +(% style="width:651.294px" %) 531 +|(% style="width:134px" %)**Package**|(% style="width:502px" %)**URN class name (model class name where this is different)** 532 +|(% style="width:134px" %)base|(% style="width:502px" %)Agency 533 +|(% style="width:134px" %) |(% style="width:502px" %)AgencyScheme 534 +|(% style="width:134px" %) |(% style="width:502px" %)DataConsumer 535 +|(% style="width:134px" %) |(% style="width:502px" %)DataConsumerScheme 536 +|(% style="width:134px" %) |(% style="width:502px" %)DataProvider 537 +|(% style="width:134px" %) |(% style="width:502px" %)DataProviderScheme 538 +|(% style="width:134px" %) |(% style="width:502px" %)MetadataProvider 539 +|(% style="width:134px" %) |(% style="width:502px" %)MetadataProviderScheme 540 +|(% style="width:134px" %) |(% style="width:502px" %)OrganisationUnit 541 +|(% style="width:134px" %) |(% style="width:502px" %)OrganisationUnitScheme 542 +|(% style="width:134px" %)datastructure|(% style="width:502px" %)AttributeDescriptor 543 +|(% style="width:134px" %) |(% style="width:502px" %)DataAttribute 544 +|(% style="width:134px" %) |(% style="width:502px" %)Dataflow 545 +|(% style="width:134px" %) |(% style="width:502px" %)DataStructure (DataStructureDefinition) 546 +|(% style="width:134px" %) |(% style="width:502px" %)Dimension 547 +|(% style="width:134px" %) |(% style="width:502px" %)DimensionDescriptor 548 +|(% style="width:134px" %) |(% style="width:502px" %)GroupDimensionDescriptor 549 +|(% style="width:134px" %) |(% style="width:502px" %)Measure 550 +|(% style="width:134px" %) |(% style="width:502px" %)MeasureDescriptor 551 +|(% style="width:134px" %) |(% style="width:502px" %)TimeDimension 552 +|(% style="width:134px" %) |(% style="width:502px" %) 553 +|(% style="width:134px" %)metadatastructure|(% style="width:502px" %)MetadataAttribute 554 +|(% style="width:134px" %) |(% style="width:502px" %)MetadataAttributeDescriptor 555 +|(% style="width:134px" %) |(% style="width:502px" %)MetadataStructure MetadataStructureDefinition) 556 +|(% style="width:134px" %) |(% style="width:502px" %)Metadataflow 557 +|(% style="width:134px" %) |(% style="width:502px" %)MetadataSet 558 +|(% style="width:134px" %) |(% style="width:502px" %) 559 +|(% style="width:134px" %)process|(% style="width:502px" %)Process 560 +|(% style="width:134px" %) |(% style="width:502px" %)ProcessStep 561 +|(% style="width:134px" %) |(% style="width:502px" %)Transition 562 +|(% style="width:134px" %) |(% style="width:502px" %) 563 +|(% style="width:134px" %)registry|(% style="width:502px" %)DataConstraint 564 +|(% style="width:134px" %) |(% style="width:502px" %)MetadataConstraint 565 +|(% style="width:134px" %) |(% style="width:502px" %)MetadataProvisionAgreement 566 +|(% style="width:134px" %) |(% style="width:502px" %)ProvisionAgreement 567 +|(% style="width:134px" %) |(% style="width:502px" %)Subscription 568 +|(% style="width:134px" %) |(% style="width:502px" %) 569 +|(% style="width:134px" %)structuremapping|(% style="width:502px" %)CategorySchemeMap 570 +|(% style="width:134px" %) |(% style="width:502px" %)ConceptSchemeMap 571 +|(% style="width:134px" %) |(% style="width:502px" %)OrganisationSchemeMap 572 +|(% style="width:134px" %) |(% style="width:502px" %)ReportingTaxonomyMap 573 +|(% style="width:134px" %) |(% style="width:502px" %)RepresentationMap 574 +|(% style="width:134px" %) |(% style="width:502px" %)StructureMap 575 +|(% style="width:134px" %) |(% style="width:502px" %) 576 +|(% style="width:134px" %)codelist|(% style="width:502px" %)Code 577 +|(% style="width:134px" %) |(% style="width:502px" %)Codelist 578 +|(% style="width:134px" %) |(% style="width:502px" %)HierarchicalCode 579 +|(% style="width:134px" %) |(% style="width:502px" %)Hierarchy 580 +|(% style="width:134px" %) |(% style="width:502px" %)HierarchyAssociation 581 +|(% style="width:134px" %) |(% style="width:502px" %)Level 582 +|(% style="width:134px" %) |(% style="width:502px" %)ValueList 583 +|(% style="width:134px" %) |(% style="width:502px" %) 584 +|(% style="width:134px" %)categoryscheme|(% style="width:502px" %)Categorisation 585 +|(% style="width:134px" %) |(% style="width:502px" %)Category 586 +|(% style="width:134px" %) |(% style="width:502px" %)CategoryScheme 587 +|(% style="width:134px" %) |(% style="width:502px" %)ReportingCategory 588 +|(% style="width:134px" %) |(% style="width:502px" %)ReportingTaxonomy 589 +|(% style="width:134px" %)conceptscheme|(% style="width:502px" %)Concept 590 +|(% style="width:134px" %) |(% style="width:502px" %)ConceptScheme 591 +|(% style="width:134px" %) |(% style="width:502px" %) 592 +|(% style="width:134px" %)transformation|(% style="width:502px" %)CustomType 593 +|(% style="width:134px" %) |(% style="width:502px" %)CustomTypeScheme 594 +|(% style="width:134px" %) |(% style="width:502px" %)NamePersonalisation 595 +|(% style="width:134px" %) |(% style="width:502px" %)NamePersonalisationScheme 596 +|(% style="width:134px" %) |(% style="width:502px" %)Ruleset 597 +|(% style="width:134px" %) |(% style="width:502px" %)RulesetScheme 598 +|(% style="width:134px" %) |(% style="width:502px" %)Transformation 599 +|(% style="width:134px" %) |(% style="width:502px" %)TransformationScheme 600 +|(% style="width:134px" %) |(% style="width:502px" %)UserDefinedOperator 601 +|(% style="width:134px" %) |(% style="width:502px" %)UserDefinedOperatorScheme 602 +|(% style="width:134px" %) |(% style="width:502px" %)VtlCodelistMapping 603 +|(% style="width:134px" %) |(% style="width:502px" %)VtlConceptMapping 604 +|(% style="width:134px" %) |(% style="width:502px" %)VtlDataflowMapping 605 +|(% style="width:134px" %) |(% style="width:502px" %)VtlMappingScheme 614 614 615 615 **Table 2: SDMX-IM Packages and Contained Classes** 616 616 617 617 === {{id name="_Toc93860"/}}6.2.4 URN Identification components of SDMX objects === 618 618 619 -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. 611 +The table below describes the identification [[components>>doc:xwiki:Glossary.Component.WebHome]] for all [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] object types that have identification. Note the actual [[attributes>>doc:xwiki: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:xwiki:Glossary.Attribute.WebHome]] of the Agency class that is associated to the ConceptScheme. 620 620 621 621 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: 622 622 623 623 urn:sdmx.org.sdmx.infomodel.{package}.{classname}= 624 624 625 -|**Classname**|**Ending URN pattern**|**Example** 626 -|Agency^^[[(% class="wikiinternallink wikiinternallink" %)^^2^^>>path:#sdfootnote2sym||name="sdfootnote2anc"]](%%)^^|agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|ECB:**AGENCIES**(**1.0**).AA 627 -|//AgencyScheme//|agencySchemeAgencyId:**AGENCIES**(**1.0**)|ECB:**AGENCIES**(**1.0**) 628 -|//Categorisation//|categorisationAgencyId:categorisationId(version)|IMF:cat001(1.0.0) 629 -|Category|categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|IMF:SDDS(1.0.0):level_1_category.level_2_category … 630 -|//CategoryScheme//|categorySchemeAgencyId:categorySchemeId(versi on)|IMF:SDDS(1.0.0) 631 - 632 -|**Classname**|**Ending URN pattern**|**Example** 633 -|//CategorySchemeMap//|((( 634 -catSchemeMapAgencyId:catSchemeMapId(version 635 - 636 -) 637 -)))|SDMX:EUROSTAT_SUBJECT_DOMAIN(1.0.0) 638 -|Code|codeListAgencyId:codelistId(version).codeId|SDMX:CL_FREQ(1.0.0).Q 639 -|//Codelist//|codeListAgencyId:codeListId(version)|SDMX:CL_FREQ(1.0.0) 640 -|ComponentMap|structureMapAgencyId:structureMap(version).com ponentMapId|SDMX:BOP_STRUCTURES(1.0.0).REF_AREA_TO_COUNT RY 641 -|Concept|conceptSchemeAgencyId:conceptSchemeId(versio n).conceptId|SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0).FREQ 642 -|//ConceptScheme//|conceptSchemeAgencyId:conceptSchemeId(versio n)|SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0) 643 -|//ConceptSchemeMap//|((( 617 +(% style="width:1419.29px" %) 618 +|(% style="width:227px" %)**Classname**|(% style="width:645px" %)**Ending URN pattern**|(% style="width:543px" %)**Example** 619 +|(% style="width:227px" %)Agency{{footnote}}The identification of an Agency in the URN structure for the maintainable object is by means of the agencyId. The AgencyScheme is not identified as SDMX has a mechanism for identifying an Agency uniquely by its Id. Note that this Id may be hierarchical. For example, a sub-agency of IMF is referred like this: IMF.SubAgency1{{/footnote}}|(% style="width:645px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|(% style="width:543px" %)ECB:**AGENCIES**(**1.0**).AA 620 +|(% style="width:227px" %)//AgencyScheme//|(% style="width:645px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**)|(% style="width:543px" %)ECB:**AGENCIES**(**1.0**) 621 +|(% style="width:227px" %)//Categorisation//|(% style="width:645px" %)categorisationAgencyId:categorisationId(version)|(% style="width:543px" %)IMF:cat001(1.0.0) 622 +|(% style="width:227px" %)Category|(% style="width:645px" %)categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|(% style="width:543px" %)IMF:SDDS(1.0.0):level_1_category.level_2_category … 623 +|(% style="width:227px" %)//CategoryScheme//|(% style="width:645px" %)categorySchemeAgencyId:categorySchemeId(versi on)|(% style="width:543px" %)IMF:SDDS(1.0.0) 624 +|(% style="width:227px" %)//CategorySchemeMap//|(% style="width:645px" %)((( 625 +catSchemeMapAgencyId:catSchemeMapId(version) 626 +)))|(% style="width:543px" %)SDMX:EUROSTAT_SUBJECT_DOMAIN(1.0.0) 627 +|(% style="width:227px" %)Code|(% style="width:645px" %)codeListAgencyId:codelistId(version).codeId|(% style="width:543px" %)SDMX:CL_FREQ(1.0.0).Q 628 +|(% style="width:227px" %)//Codelist//|(% style="width:645px" %)codeListAgencyId:codeListId(version)|(% style="width:543px" %)SDMX:CL_FREQ(1.0.0) 629 +|(% style="width:227px" %)ComponentMap|(% style="width:645px" %)structureMapAgencyId:structureMap(version).com ponentMapId|(% style="width:543px" %)SDMX:BOP_STRUCTURES(1.0.0).REF_AREA_TO_COUNT RY 630 +|(% style="width:227px" %)Concept|(% style="width:645px" %)conceptSchemeAgencyId:conceptSchemeId(versio n).conceptId|(% style="width:543px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0).FREQ 631 +|(% style="width:227px" %)//ConceptScheme//|(% style="width:645px" %)conceptSchemeAgencyId:conceptSchemeId(versio n)|(% style="width:543px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0) 632 +|(% style="width:227px" %)//ConceptSchemeMap//|(% style="width:645px" %)((( 644 644 conceptSchemeMapAgencyId:conceptSchemeMap 645 - 646 646 Id(version) 647 -)))|SDMX:CONCEPT_MAP(1.0.0) 648 -|CustomType|customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|ECB: CUSTOM_TYPE_SCHEME(1.0.0).CUSTOM_TYPE_1 649 -|//CustomTypeScheme//|customTypeSchemeAgencyId customTypeSchemeId(version)|ECB:CUSTOM_TYPE_SCHEME(1.0.0) 650 -|DataAttrribute|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dataAttributeId|TFFS:EXT_DEBT(1.0.0).OBS_STATUS 651 -|//DataConstraint//|dataConstraintAgencyId:dataConstraintId(version)|TFFS:CREDITOR_DATA_CONTENT(1.0.0) 652 - 653 -|**Classname**|**Ending URN pattern**|**Example** 654 -|DataConsumer|dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**).dataConsumerId|SDMX:**DATA_CONSUMERS**(**1.0**).CONSUMER_1 655 -|//DataConsumerScheme//|((( 656 -dataConsumerSchemeAgencyId:**DATA_CONSUME** 657 - 658 -**RS**(**1.0**) 659 -)))|SDMX:**DATA_CONSUMERS**(**1.0**) 660 -|//Dataflow//|dataflowAgencyId:dataflowId(version)|TFFS:CRED_EXT_DEBT(1.0.0) 661 -|DataProvider|((( 662 -dataProviderSchemeAgencyId:**DATA_PROVIDERS**( 663 - 664 -**1.0**).dataProviderId 665 -)))|SDMX:**DATA_PROVIDERS**(**1.0**).PROVIDER_1 666 -|//DataProviderScheme//|((( 667 -dataProviderSchemeAgencyId:**DATA_PROVIDERS**( 668 - 669 -**1.0**) 670 -)))|SDMX:**DATA_PROVIDERS**(**1.0**) 671 -|//DataStructure//|dataStructureDefinitionAgencyId:dataStructureDef initionId(version)|TFFS:EXT_DEBT(1.0.0) 672 -|Dimension|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dimensionId|TFFS:EXT_DEBT(1.0.0).FREQ 673 -|((( 635 +)))|(% style="width:543px" %)SDMX:CONCEPT_MAP(1.0.0) 636 +|(% style="width:227px" %)CustomType|(% style="width:645px" %)customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|(% style="width:543px" %)ECB: CUSTOM_TYPE_SCHEME(1.0.0).CUSTOM_TYPE_1 637 +|(% style="width:227px" %)//CustomTypeScheme//|(% style="width:645px" %)customTypeSchemeAgencyId customTypeSchemeId(version)|(% style="width:543px" %)ECB:CUSTOM_TYPE_SCHEME(1.0.0) 638 +|(% style="width:227px" %)DataAttrribute|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dataAttributeId|(% style="width:543px" %)TFFS:EXT_DEBT(1.0.0).OBS_STATUS 639 +|(% style="width:227px" %)//DataConstraint//|(% style="width:645px" %)dataConstraintAgencyId:dataConstraintId(version)|(% style="width:543px" %)TFFS:CREDITOR_DATA_CONTENT(1.0.0) 640 +|(% style="width:229px" %)DataConsumer|(% style="width:645px" %)dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**).dataConsumerId|(% style="width:543px" %)SDMX:**DATA_CONSUMERS**(**1.0**).CONSUMER_1 641 +|(% style="width:229px" %)//DataConsumerScheme//|(% style="width:645px" %)((( 642 +dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**) 643 +)))|(% style="width:543px" %)SDMX:**DATA_CONSUMERS**(**1.0**) 644 +|(% style="width:229px" %)//Dataflow//|(% style="width:645px" %)dataflowAgencyId:dataflowId(version)|(% style="width:543px" %)TFFS:CRED_EXT_DEBT(1.0.0) 645 +|(% style="width:229px" %)DataProvider|(% style="width:645px" %)((( 646 +dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**).dataProviderId 647 +)))|(% style="width:543px" %)SDMX:**DATA_PROVIDERS**(**1.0**).PROVIDER_1 648 +|(% style="width:229px" %)//DataProviderScheme//|(% style="width:645px" %)((( 649 +dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**) 650 +)))|(% style="width:543px" %)SDMX:**DATA_PROVIDERS**(**1.0**) 651 +|(% style="width:229px" %)//DataStructure//|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version)|(% style="width:543px" %)TFFS:EXT_DEBT(1.0.0) 652 +|(% style="width:229px" %)Dimension|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dimensionId|(% style="width:543px" %)TFFS:EXT_DEBT(1.0.0).FREQ 653 +|(% style="width:229px" %)((( 674 674 DimensionDescriptor 675 - 676 676 MeasureDescriptor 677 - 678 678 AttributeDescriptor 679 -)))|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).componentListId where the componentListId is the name of the class (there is only one occurrence of each in the Data Structure Definition)|((( 657 +)))|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).componentListId where the componentListId is the name of the class (there is only one occurrence of each in the Data Structure Definition)|(% style="width:543px" %)((( 680 680 TFFS:EXT_DEBT(1.0.0).DimensionDescriptor 681 - 682 682 TFFS:EXT_DEBT(1.0.0).MeasureDescriptor 683 - 684 684 TFFS:EXT_DEBT(1.0.0).AttributeDescriptor 685 685 ))) 686 -|GroupDimensionDescriptor|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).groupDimensionDescriptorId|TFFS:EXT_DEBT(1.0.0).SIBLING 687 -|HierarchicalCode|hierarchyAgencyId:hierarchyId(version).hierarchica lCode.hierarchicalCode|UNESCO:H-C-GOV(1.0.0).GOV_CODE1.GOV_CODE1_1 688 - 689 -|**Classname**|**Ending URN pattern**|**Example** 690 -|//Hierarchy//|hierarchyAgencyId:hierarchyId(version)|UNESCO:H-C-GOV(1.0.0) 691 -|//HierarchyAssociation//|hierarchyAssociationAgencyId:hierarchyAssociatio nId(version)|UNESCO:CL_EXP_SOURCE(1.0.0) 692 -|Level|hierarchyAgencyId:hierarchyId(version).level|UNESCO:H-C-GOV(1.0.0).LVL1 693 -|Measure|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).measureId|TFFS:EXT_DEBT(1.0.0).OBS_VALUE 694 -|MetadataAttribute|((( 662 +|(% style="width:229px" %)GroupDimensionDescriptor|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).groupDimensionDescriptorId|(% style="width:543px" %)TFFS:EXT_DEBT(1.0.0).SIBLING 663 +|(% style="width:229px" %)HierarchicalCode|(% style="width:645px" %)hierarchyAgencyId:hierarchyId(version).hierarchica lCode.hierarchicalCode|(% style="width:543px" %)UNESCO:H-C-GOV(1.0.0).GOV_CODE1.GOV_CODE1_1 664 +|(% style="width:206px" %)//Hierarchy//|(% style="width:645px" %)hierarchyAgencyId:hierarchyId(version)|(% style="width:543px" %)UNESCO:H-C-GOV(1.0.0) 665 +|(% style="width:206px" %)//HierarchyAssociation//|(% style="width:645px" %)hierarchyAssociationAgencyId:hierarchyAssociatio nId(version)|(% style="width:543px" %)UNESCO:CL_EXP_SOURCE(1.0.0) 666 +|(% style="width:206px" %)Level|(% style="width:645px" %)hierarchyAgencyId:hierarchyId(version).level|(% style="width:543px" %)UNESCO:H-C-GOV(1.0.0).LVL1 667 +|(% style="width:206px" %)Measure|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).measureId|(% style="width:543px" %)TFFS:EXT_DEBT(1.0.0).OBS_VALUE 668 +|(% style="width:206px" %)MetadataAttribute|(% style="width:645px" %)((( 695 695 msdAgencyId:msdId(version).metadataAttributeId. 696 - 697 697 metadataAttributeId 698 -)))|IMF:SDDS_MSD(1.0.0).COMPILATION.METHOD 699 -|MetadataAttributeDescriptor|msdAgencyId:msdId(version).metadataAttributeDe scriptorId|IMF:SDDS_MSD(1.0.0).MetadataAttributeDescriptor 700 -|//MetadataConstraint//|metadataConstraintAgencyId:metadataConstraintI d(version)|TFFS:CREDITOR_METADATA_CONTENT(1.0.0) 701 -|//Metadataflow//|metadataflowAgencyId:metadataflowId(version)|IMF:SDDS_MDF(1.0.0) 702 -|MetadataProvider|metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**).metadataProviderId|SDMX:**METADATA_PROVIDERS**(**1.0**).MD_PROVIDER_1 703 -|//MetadataProviderScheme//|metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**)|SDMX:**METADATA_PROVIDERS**(**1.0**) 704 -|//MetadataProvisionAgreement//|metadataProvisionAgreementAgencyId:metadataP rovisionAgreementId(version)|IMF:SDDS_MDF_AB(1.0.0) 705 -|//MetadataSet//|metadataProviderId:metadataSetId(version)|MD_PROVIDER:METADATASET(1.0.0) 706 -|//MetadataStructure//|msdAgencyId:msdId(version)|IMF:SDDS_MSD(1.0.0) 707 - 708 -|**Classname**|**Ending URN pattern**|**Example** 709 -|NamePersonalisation|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|ECB:PSN_SCHEME(1.0.0).PSN1234 710 -|//NamePersonalisationScheme//|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|ECB:PSN_SCHEME(1.0.0) 711 -|//OrganisationSchemeMap//|orgSchemeMapAgencyId:orgSchemeMapId(versio n)|SDMX:AGENCIES_PROVIDERS(1.0.0) 712 -|OrganisationUnit|organisationUnitSchemeAgencyId:organisationUni tSchemeId(version).organisationUnitId|ECB:ORGANISATIONS(1.0.0).1F 713 -|//OrganisationUnitScheme//|organisationUnitSchemeAgencyId:organisationUni tSchemeId(version)|ECB:ORGANISATIONS(1.0.0) 714 -|//Process//|processAgencyId:processId{version)|BIS:PROCESS1(1.0.0) 715 -|ProcessStep|((( 671 +)))|(% style="width:543px" %)IMF:SDDS_MSD(1.0.0).COMPILATION.METHOD 672 +|(% style="width:206px" %)MetadataAttributeDescriptor|(% style="width:645px" %)msdAgencyId:msdId(version).metadataAttributeDe scriptorId|(% style="width:543px" %)IMF:SDDS_MSD(1.0.0).MetadataAttributeDescriptor 673 +|(% style="width:206px" %)//MetadataConstraint//|(% style="width:645px" %)metadataConstraintAgencyId:metadataConstraintI d(version)|(% style="width:543px" %)TFFS:CREDITOR_METADATA_CONTENT(1.0.0) 674 +|(% style="width:206px" %)//Metadataflow//|(% style="width:645px" %)metadataflowAgencyId:metadataflowId(version)|(% style="width:543px" %)IMF:SDDS_MDF(1.0.0) 675 +|(% style="width:206px" %)MetadataProvider|(% style="width:645px" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**).metadataProviderId|(% style="width:543px" %)SDMX:**METADATA_PROVIDERS**(**1.0**).MD_PROVIDER_1 676 +|(% style="width:206px" %)//MetadataProviderScheme//|(% style="width:645px" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**)|(% style="width:543px" %)SDMX:**METADATA_PROVIDERS**(**1.0**) 677 +|(% style="width:206px" %)//MetadataProvisionAgreement//|(% style="width:645px" %)metadataProvisionAgreementAgencyId:metadataP rovisionAgreementId(version)|(% style="width:543px" %)IMF:SDDS_MDF_AB(1.0.0) 678 +|(% style="width:206px" %)//MetadataSet//|(% style="width:645px" %)metadataProviderId:metadataSetId(version)|(% style="width:543px" %)MD_PROVIDER:METADATASET(1.0.0) 679 +|(% style="width:206px" %)//MetadataStructure//|(% style="width:645px" %)msdAgencyId:msdId(version)|(% style="width:543px" %)IMF:SDDS_MSD(1.0.0) 680 +|(% style="width:227px" %)NamePersonalisation|(% style="width:527px" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|(% style="width:545px" %)ECB:PSN_SCHEME(1.0.0).PSN1234 681 +|(% style="width:227px" %)//NamePersonalisationScheme//|(% style="width:527px" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|(% style="width:545px" %)ECB:PSN_SCHEME(1.0.0) 682 +|(% style="width:227px" %)//OrganisationSchemeMap//|(% style="width:527px" %)orgSchemeMapAgencyId:orgSchemeMapId(versio n)|(% style="width:545px" %)SDMX:AGENCIES_PROVIDERS(1.0.0) 683 +|(% style="width:227px" %)OrganisationUnit|(% style="width:527px" %)organisationUnitSchemeAgencyId:organisationUnitSchemeId(version).organisationUnitId|(% style="width:545px" %)ECB:ORGANISATIONS(1.0.0).1F 684 +|(% style="width:227px" %)//OrganisationUnitScheme//|(% style="width:527px" %)organisationUnitSchemeAgencyId:organisationUni tSchemeId(version)|(% style="width:545px" %)ECB:ORGANISATIONS(1.0.0) 685 +|(% style="width:227px" %)//Process//|(% style="width:527px" %)processAgencyId:processId{version)|(% style="width:545px" %)BIS:PROCESS1(1.0.0) 686 +|(% style="width:227px" %)ProcessStep|(% style="width:527px" %)((( 716 716 processAgencyId:processId(version).processStepId. 717 - 718 718 processStepId 719 -)))|BIS:PROCESS1(1.0.0).STEP1.STEP1_1 720 -|//ProvisionAgreement//|provisionAgreementAgencyId:provisionAgreement Id(version)|TFFS:CRED_EXT_DEBT_AB(1.0.0) 721 -|ReportingCategory|((( 689 +)))|(% style="width:545px" %)BIS:PROCESS1(1.0.0).STEP1.STEP1_1 690 +|(% style="width:227px" %)//ProvisionAgreement//|(% style="width:527px" %)provisionAgreementAgencyId:provisionAgreement Id(version)|(% style="width:545px" %)TFFS:CRED_EXT_DEBT_AB(1.0.0) 691 +|(% style="width:227px" %)ReportingCategory|(% style="width:527px" %)((( 722 722 reportingTaxonomyAgencyId: 723 - 724 724 reportingTaxonomyId(version).reportingCategoryI d.reportingCategoryId 725 -)))|IMF:REP_1(1.0.0):LVL1_REP_CAT.LVL2_REP_CAT 726 -|//ReportingTaxonomy//|reportingTaxonomyAgencyId:reportingTaxonomyI d(version)|IMF:REP_1(1.0.0) 727 -|//ReportingTaxonomyMap//|repTaxonomyAgencyId:repTaxonomyId(version)|SDMX:RT_MAP(1.0.0) 728 - 729 -|**Classname**|**Ending URN pattern**|**Example** 730 -|//RepresentationMap//|repMapAgencyId:repMapId(version)|SDMX:REF_AREA_MAPPING(1.0.0) 731 -|Ruleset|rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|ECB:RULESET_23(1.0.0).SET111 732 -|//RulesetScheme//|rulesetSchemeAgencyId rulesetSchemeId(version)|ECB:RULESET_23(1.0.0) 733 -|//StructureMap//|structureMapAgencyId:structureMap(version)|SDMX:BOP_STRUCTURES(1.0.0) 734 -|Subscription|((( 694 +)))|(% style="width:545px" %)IMF:REP_1(1.0.0):LVL1_REP_CAT.LVL2_REP_CAT 695 +|(% style="width:227px" %)//ReportingTaxonomy//|(% style="width:527px" %)reportingTaxonomyAgencyId:reportingTaxonomyI d(version)|(% style="width:545px" %)IMF:REP_1(1.0.0) 696 +|(% style="width:227px" %)//ReportingTaxonomyMap//|(% style="width:527px" %)repTaxonomyAgencyId:repTaxonomyId(version)|(% style="width:545px" %)SDMX:RT_MAP(1.0.0) 697 +|(% style="width:229px" %)//RepresentationMap//|(% style="width:645px" %)repMapAgencyId:repMapId(version)|(% style="width:215px" %)SDMX:REF_AREA_MAPPING(1.0.0) 698 +|(% style="width:229px" %)Ruleset|(% style="width:645px" %)rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|(% style="width:215px" %)ECB:RULESET_23(1.0.0).SET111 699 +|(% style="width:229px" %)//RulesetScheme//|(% style="width:645px" %)rulesetSchemeAgencyId rulesetSchemeId(version)|(% style="width:215px" %)ECB:RULESET_23(1.0.0) 700 +|(% style="width:229px" %)//StructureMap//|(% style="width:645px" %)structureMapAgencyId:structureMap(version)|(% style="width:215px" %)SDMX:BOP_STRUCTURES(1.0.0) 701 +|(% style="width:229px" %)Subscription|(% style="width:645px" %)((( 735 735 The Subscription is not itself an Identifiable Artefact and therefore it does not follow the rules for URN structure. 736 - 737 737 The name of the URN is registryURN There is no pre-determined format. 738 -)))|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. 739 -|TimeDimension|dataStructureDefinitionAgencyId:dataStructureDef initionId(version).timeDimensionId|TFFS:EXT_DEBT(1.0.0).TIME_PERIOD 740 -|Transformation|transformationSchemeAgencyId transformationSchemeId(version) transformationId|ECB:TRANSFORMATION_SCHEME(1.0.0).TRANS_1 741 -|//TransformationScheme//|transformationSchemeAgencyId transformationSchemeId(version)|ECB: TRANSFORMATION_SCHEME(1.0.0) 742 -|**Classname**|**Ending URN pattern**|**Example** 743 -|Transition|((( 704 +)))|(% style="width:1015px" %)This cannot be generated by a common mechanism as [[subscriptions>>doc:xwiki: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:xwiki: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:xwiki:Glossary.Subscription.WebHome]], and for the application creating the [[subscription>>doc:xwiki:Glossary.Subscription.WebHome]] to store the registry URN that is returned from the registry in the [[subscription>>doc:xwiki:Glossary.Subscription.WebHome]] response message. 705 +|(% style="width:229px" %)TimeDimension|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).timeDimensionId|(% style="width:1015px" %)TFFS:EXT_DEBT(1.0.0).TIME_PERIOD 706 +|(% style="width:229px" %)Transformation|(% style="width:645px" %)transformationSchemeAgencyId transformationSchemeId(version) transformationId|(% style="width:1015px" %)ECB:TRANSFORMATION_SCHEME(1.0.0).TRANS_1 707 +|(% style="width:229px" %)//TransformationScheme//|(% style="width:645px" %)transformationSchemeAgencyId transformationSchemeId(version)|(% style="width:1015px" %)ECB: TRANSFORMATION_SCHEME(1.0.0) 708 +|(% style="width:229px" %)Transition|(% style="width:645px" %)((( 744 744 processAgencyId:processId(version).processStepId. 745 - 746 746 transitionId 747 -)))|BIS:PROCESS1(1.0.0).STEP1.TRANSITION1 748 -|UserDefinedOperator|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|ECB:OS_CALC(1.2.0).OS267 749 -|//UserDefinedOperatorScheme//|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|ECB:OS_CALC(1.2.0) 750 -|//ValueList//|valuelistAgencyId:valuelistId(version)|SDMX:VLIST(1.0.0) 751 -|VtlCodelistMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|ECB:CLIST_MP(2.0.0).ABZ 752 -|VtlConceptMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|ECB:CLIST_MP(1.0.0).XYA 753 -|VtlDataflowMapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|ECB:CLIST_MP(1.0.0).MOQ 754 -|//VtlMappingScheme//|vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|ECB:CLIST_MP(2.0.0) 711 +)))|(% style="width:1015px" %)BIS:PROCESS1(1.0.0).STEP1.TRANSITION1 712 +|(% style="width:229px" %)UserDefinedOperator|(% style="width:645px" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|(% style="width:1015px" %)ECB:OS_CALC(1.2.0).OS267 713 +|(% style="width:229px" %)//UserDefinedOperatorScheme//|(% style="width:645px" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|(% style="width:1015px" %)ECB:OS_CALC(1.2.0) 714 +|(% style="width:229px" %)//ValueList//|(% style="width:645px" %)valuelistAgencyId:valuelistId(version)|(% style="width:1015px" %)SDMX:VLIST(1.0.0) 715 +|(% style="width:229px" %)VtlCodelistMapping|(% style="width:645px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|(% style="width:1015px" %)ECB:CLIST_MP(2.0.0).ABZ 716 +|(% style="width:229px" %)VtlConceptMapping|(% style="width:645px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|(% style="width:1015px" %)ECB:CLIST_MP(1.0.0).XYA 717 +|(% style="width:229px" %)VtlDataflowMapping|(% style="width:645px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|(% style="width:1015px" %)ECB:CLIST_MP(1.0.0).MOQ 718 +|(% style="width:229px" %)//VtlMappingScheme//|(% style="width:645px" %)vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|(% style="width:1015px" %)ECB:CLIST_MP(2.0.0) 755 755 756 756 **Table 3: Table of identification components for SDMX Identifiable Artefacts** 757 757 ... ... @@ -759,134 +759,123 @@ 759 759 760 760 === {{id name="_Toc93862"/}}7.1 Structural Definition Metadata === 761 761 762 -=== =={{id name="_Toc93863"/}}7.1.1 Introduction =====726 +=== {{id name="_Toc93863"/}}7.1.1 Introduction === 763 763 764 -The SDMX Registry must have the ability to support agencies in their role of defining and disseminating structural metadata artefacts. These artefacts include data structure definitions, code lists, concepts etc. and are fully defined in the SDMX-IM. An authenticated agency may submit valid structural metadata definitions which must be stored in the registry. Note that the term “structural metadata” refers as a general term to all structural components (Data Structure Definitions, Metadata Structure Definitions, Code Lists, Concept Schemes, etc.) 728 +The [[SDMX Registry>>doc:xwiki:Glossary.SDMX Registry.WebHome]] must have the ability to support agencies in their role of defining and disseminating [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]]. These [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] include [[data structure definitions>>doc:xwiki:Glossary.Data structure definition.WebHome]], [[code lists>>doc:xwiki:Glossary.Code list.WebHome]], (% style="color:#2ecc71" %)concepts(%%) etc. and are fully defined in the [[SDMX-IM>>doc:xwiki:Glossary.SDMX Information Model.WebHome]]. An authenticated agency may submit valid [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] definitions which must be stored in the registry. Note that the term “[[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]]” refers as a general term to all structural [[components>>doc:xwiki:Glossary.Component.WebHome]] ([[Data Structure Definitions>>doc:xwiki:Glossary.Data structure definition.WebHome]], [[Metadata Structure Definitions>>doc:xwiki:Glossary.Metadata structure definition.WebHome]], [[Code Lists>>doc:xwiki:Glossary.Code list.WebHome]], [[Concept Schemes>>doc:xwiki:Glossary.Concept scheme.WebHome]], etc.) 765 765 766 -At a minimum, structural metadata definitions may be submitted to and queried from the registry via an HTTP/HTTPS POST in the form of one of the SDMX-ML messages for structural metadata and the SDMX RESTful API for structure queries. The message may contain all structural metadata items for the whole registry, structural metadata items for one maintenance agency, or individual structural metadata items. 730 +At a minimum, [[structural metadata>>doc:xwiki: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:xwiki:Glossary.SDMX-ML.WebHome]] messages for [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] and the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] RESTful API for structure queries. The message may contain all [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] items for the whole registry, [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] items for one [[maintenance agency>>doc:xwiki:Glossary.Maintenance agency.WebHome]], or individual [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] items. 767 767 768 -Structural metadata items 732 +[[Structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] items 769 769 770 -* may only be modified by the maintenance agency which created them; 734 +* may only be modified by the [[maintenance agency>>doc:xwiki:Glossary.Maintenance agency.WebHome]] which created them; 771 771 * may only be deleted by the agency which created them; 772 772 * may not be deleted if they are referenced from other constructs in the Registry. 773 773 774 -The level of granularity for the maintenance of SDMX Structural Metadata objects in the registry is the Maintainable Artefact. Especially for Item Schemes, though, partial maintenance may be performed, i.e., at the level of the Item, by submitting an Item Scheme with the 'isPartial' flag set and a reduced set of Items. 738 +The (% style="color:#2ecc71" %)level(%%) of granularity for the maintenance of [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] [[Structural Metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] objects in the registry is the [[Maintainable Artefact>>doc:xwiki:Glossary.Maintainable artefact.WebHome]]. Especially for [[Item Schemes>>doc:xwiki:Glossary.Item scheme.WebHome]], though, partial maintenance may be performed, i.e., at the (% style="color:#2ecc71" %)level(%%) of the Item, by submitting an [[Item Scheme>>doc:xwiki:Glossary.Item scheme.WebHome]] with the 'isPartial' flag set and a reduced set of Items. 775 775 776 -The following table lists the Maintainable Artefacts. 740 +The following table lists the [[Maintainable Artefacts>>doc:xwiki:Glossary.Maintainable artefact.WebHome]]. 777 777 778 -|(% colspan="2" %)**Maintainable Artefacts**|**Content** 779 -|**Abstract Class**|**Concrete Class**| 780 -|Item Scheme|Codelist|Code 781 -| |Concept Scheme|Concept 782 -| |Category Scheme|Category 783 -| |Organisation Unit Scheme|Organisation Unit 784 -| |Agency Scheme|Agency 785 -| |Data Provider Scheme|Data Provider 786 -| |Metadata Provider Scheme|Metadata Provider 787 -| |Data Consumer Scheme|Data Consumer 788 -| |Reporting Taxonomy|Reporting Category 789 -| |Transformation Scheme|Transformation 790 -| |Custom Type Scheme|Custom Type 791 -| |Name Personalisation Scheme|Name Personalisation 792 -| |Vtl Mapping Scheme|Vtl Codelist Mapping Vtl Concept Mapping 793 -| |Ruleset Scheme|Ruleset 794 -| |User Defined Operator Scheme|User Defined Operator 795 -|Enumerated List|ValueList|Value Item 796 -|Structure|Data Structure Definition|((( 797 -Dimension Descriptor 798 - 799 -Group Dimension Descriptor 800 - 801 -Dimension 802 - 803 -Time Dimension 804 - 805 -Attribute Descriptor 806 - 807 -Data Attribute 808 - 742 +(% style="width:881.294px" %) 743 +|(% colspan="2" style="width:522px" %)**Maintainable Artefacts**|(% style="width:490px" %)**Content** 744 +|(% style="width:198px" %)**Abstract Class**|(% style="width:324px" %)**Concrete Class**|(% style="width:490px" %) 745 +|(% style="width:198px" %)[[Item Scheme>>doc:xwiki:Glossary.Item scheme.WebHome]]|(% style="width:324px" %)Codelist|(% style="width:490px" %)[[Code>>doc:xwiki:Glossary.Code.WebHome]] 746 +|(% style="width:198px" %) |(% style="width:324px" %)[[Concept Scheme>>doc:xwiki:Glossary.Concept scheme.WebHome]]|(% style="width:490px" %)(% style="color:#2ecc71" %)Concept 747 +|(% style="width:198px" %) |(% style="width:324px" %)[[Category Scheme>>doc:xwiki:Glossary.Category scheme.WebHome]]|(% style="width:490px" %)[[Category>>doc:xwiki:Glossary.Category.WebHome]] 748 +|(% style="width:198px" %) |(% style="width:324px" %)[[Organisation Unit Scheme>>doc:xwiki:Glossary.Organisation unit scheme.WebHome]]|(% style="width:490px" %)Organisation Unit 749 +|(% style="width:198px" %) |(% style="width:324px" %)[[Agency Scheme>>doc:xwiki:Glossary.Agency scheme.WebHome]]|(% style="width:490px" %)Agency 750 +|(% style="width:198px" %) |(% style="width:324px" %)[[Data Provider Scheme>>doc:xwiki:Glossary.Data provider scheme.WebHome]]|(% style="width:490px" %)[[Data Provider>>doc:xwiki:Glossary.Data provider.WebHome]] 751 +|(% style="width:198px" %) |(% style="width:324px" %)Metadata Provider Scheme|(% style="width:490px" %)Metadata Provider 752 +|(% style="width:198px" %) |(% style="width:324px" %)[[Data Consumer Scheme>>doc:xwiki:Glossary.Data consumer scheme.WebHome]]|(% style="width:490px" %)[[Data Consumer>>doc:xwiki:Glossary.Data consumer.WebHome]] 753 +|(% style="width:198px" %) |(% style="width:324px" %)Reporting Taxonomy|(% style="width:490px" %)Reporting [[Category>>doc:xwiki:Glossary.Category.WebHome]] 754 +|(% style="width:198px" %) |(% style="width:324px" %)Transformation Scheme|(% style="width:490px" %)Transformation 755 +|(% style="width:198px" %) |(% style="width:324px" %)Custom Type Scheme|(% style="width:490px" %)Custom Type 756 +|(% style="width:198px" %) |(% style="width:324px" %)Name Personalisation Scheme|(% style="width:490px" %)Name Personalisation 757 +|(% style="width:198px" %) |(% style="width:324px" %)[[Vtl>>doc:xwiki:Glossary.Validation and transformation language.WebHome]] Mapping Scheme|(% style="width:490px" %)[[Vtl>>doc:xwiki:Glossary.Validation and transformation language.WebHome]] Codelist Mapping [[Vtl>>doc:xwiki:Glossary.Validation and transformation language.WebHome]] (% style="color:#2ecc71" %)Concept(%%) Mapping 758 +|(% style="width:198px" %) |(% style="width:324px" %)Ruleset Scheme|(% style="width:490px" %)Ruleset 759 +|(% style="width:198px" %) |(% style="width:324px" %)User Defined Operator Scheme|(% style="width:490px" %)User Defined Operator 760 +|(% style="width:198px" %)Enumerated List|(% style="width:324px" %)ValueList|(% style="width:490px" %)Value Item 761 +|(% style="width:198px" %)Structure|(% style="width:324px" %)[[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]]|(% style="width:490px" %)((( 762 +[[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] Descriptor 763 +Group [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] Descriptor 764 +[[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] 765 +Time [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] 766 +[[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] Descriptor 767 +Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] 809 809 Measure Descriptor 810 - 811 811 Measure 812 812 ))) 813 -| |Metadata Structure Definition|Metadata Attribute Descriptor Metadata Attribute 814 -|Structure Usage|Dataflow| 815 -| |Metadataflow| 816 -|None|Process|Process Step 817 -|None|Structure Map|((( 818 -Component Map 819 - 820 -Epoch Map 821 - 822 -Date Pattern Map 771 +|(% style="width:198px" %) |(% style="width:324px" %)Metadata Structure Definition|(% style="width:490px" %)Metadata [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] Descriptor Metadata [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] 772 +|(% style="width:198px" %)Structure Usage|(% style="width:324px" %)[[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]]|(% style="width:490px" %) 773 +|(% style="width:198px" %) |(% style="width:324px" %)[[Metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]]|(% style="width:490px" %) 774 +|(% style="width:198px" %)None|(% style="width:324px" %)Process|(% style="width:490px" %)Process Step 775 +|(% style="width:198px" %)None|(% style="width:324px" %)Structure (% style="color:#2ecc71" %)Map|(% style="width:490px" %)((( 776 +[[Component>>doc:xwiki:Glossary.Component.WebHome]] (% style="color:#2ecc71" %)Map(%%) 777 +Epoch (% style="color:#2ecc71" %)Map(%%) 778 +Date Pattern (% style="color:#2ecc71" %)Map 823 823 ))) 824 -|None|Representation Map|Representation Mapping 825 -|Item Scheme Map|Organisation Scheme Map|Item Map 826 -| |Concept Scheme Map|Item Map 827 -| |Category Scheme Map|Item Map 828 -| |Reporting Taxonomy Map|Item Map 829 -|None|Provision Agreement| 830 -|None|Metadata Provision Agreement| 831 -|None|Hierarchy|Hierarchical Code 832 -|None|Hierarchy Association| 833 -|None|Categorisation| 780 +|(% style="width:198px" %)None|(% style="width:324px" %)[[Representation>>doc:xwiki:Glossary.Representation.WebHome]] (% style="color:#2ecc71" %)Map|(% style="width:490px" %)[[Representation>>doc:xwiki:Glossary.Representation.WebHome]] Mapping 781 +|(% style="width:198px" %)[[Item Scheme>>doc:xwiki:Glossary.Item scheme.WebHome]] (% style="color:#2ecc71" %)Map|(% style="width:324px" %)Organisation Scheme (% style="color:#2ecc71" %)Map|(% style="width:490px" %)Item (% style="color:#2ecc71" %)Map 782 +|(% style="width:198px" %) |(% style="width:324px" %)[[Concept Scheme>>doc:xwiki:Glossary.Concept scheme.WebHome]] (% style="color:#2ecc71" %)Map|(% style="width:490px" %)Item (% style="color:#2ecc71" %)Map 783 +|(% style="width:198px" %) |(% style="width:324px" %)[[Category Scheme>>doc:xwiki:Glossary.Category scheme.WebHome]] (% style="color:#2ecc71" %)Map|(% style="width:490px" %)Item (% style="color:#2ecc71" %)Map 784 +|(% style="width:198px" %) |(% style="width:324px" %)Reporting Taxonomy (% style="color:#2ecc71" %)Map|(% style="width:490px" %)Item (% style="color:#2ecc71" %)Map 785 +|(% style="width:198px" %)None|(% style="width:324px" %)[[Provision Agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]]|(% style="width:490px" %) 786 +|(% style="width:198px" %)None|(% style="width:324px" %)Metadata [[Provision Agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]]|(% style="width:490px" %) 787 +|(% style="width:198px" %)None|(% style="width:324px" %)[[Hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]]|(% style="width:490px" %)Hierarchical [[Code>>doc:xwiki:Glossary.Code.WebHome]] 788 +|(% style="width:198px" %)None|(% style="width:324px" %)[[Hierarchy>>doc:xwiki:Glossary.Hierarchy.WebHome]] Association|(% style="width:490px" %) 789 +|(% style="width:198px" %)None|(% style="width:324px" %)Categorisation|(% style="width:490px" %) 834 834 835 -**Table 4: Table of Maintainable Artefacts for Structural Definition Metadata** 791 +**Table 4: Table of [[Maintainable Artefacts>>doc:xwiki:Glossary.Maintainable artefact.WebHome]] for Structural Definition Metadata** 836 836 837 -=== =={{id name="_Toc93864"/}}7.1.2 Item Scheme, Structure =====793 +=== {{id name="_Toc93864"/}}7.1.2 Item Scheme, Structure === 838 838 839 -The artefacts included in the structural definitions are: 795 +The [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] included in the structural definitions are: 840 840 841 -• 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) 797 +* All types of [[Item Scheme>>doc:xwiki:Glossary.Item scheme.WebHome]] (Codelist, [[Concept Scheme>>doc:xwiki:Glossary.Concept scheme.WebHome]], [[Category Scheme>>doc:xwiki:Glossary.Category scheme.WebHome]], Organisation Scheme, [[Agency Scheme>>doc:xwiki:Glossary.Agency scheme.WebHome]], [[Data Provider Scheme>>doc:xwiki:Glossary.Data provider scheme.WebHome]], Metadata Provider Scheme, [[Data Consumer Scheme>>doc:xwiki:Glossary.Data consumer scheme.WebHome]], [[Organisation Unit Scheme>>doc:xwiki:Glossary.Organisation unit scheme.WebHome]], Transformation Scheme, Name Personalisation Scheme, Custom Type Scheme, [[Vtl>>doc:xwiki:Glossary.Validation and transformation language.WebHome]] Mapping Scheme, Ruleset Scheme, User Defined Operator Scheme) 798 +* All types of Enumerated List (ValueList){{footnote}}Note that Codelist is also an EnumeratedList.{{/footnote}} 799 +* All types of Structure ([[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]], Metadata Structure Definition) 800 +* All types of Structure Usage ([[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]], [[Metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]]) 842 842 843 - •Alltypes of EnumeratedList(ValueList)^^[[(%class="wikiinternallink wikiinternallink"%)^^3^^>>path:#sdfootnote3sym||name="sdfootnote3anc"]](%%)^^802 +=== {{id name="_Toc93865"/}}7.1.3 Structure Usage === 844 844 845 - •Alltypes ofStructure(Data StructureDefinition, Metadata StructureDefinition)804 +==== 7.1.3.1 Structure Usage: Basic Concepts ==== 846 846 847 - •All types of Structure Usage(Dataflow,Metadataflow)806 +The Structure Usage defines, in its concrete classes of [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] and [[Metadataflow>>doc:xwiki: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:xwiki:Glossary.Category.WebHome]] in one or more [[Category Scheme>>doc:xwiki: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:xwiki:Glossary.Category scheme.WebHome]]. 848 848 849 -==== ={{id name="_Toc93865"/}}7.1.3 Structure Usage =====808 +==== 7.1.3.2 Structure Usage Schematic ==== 850 850 851 -**7.1.3.1 Structure Usage: Basic Concepts** 852 - 853 -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. 854 - 855 -**7.1.3.2 Structure Usage Schematic** 856 - 857 857 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_52097ab5.jpg||height="246" width="438"]] 858 858 859 859 **Figure 9: Schematic of Linking the Data and Metadata Flows to Categories and Structure Definitions** 860 860 861 - **7.1.3.3 Structure Usage Model**814 +==== 7.1.3.3 Structure Usage Model ==== 862 862 863 863 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_302cc1a2.jpg||height="548" width="578"]] 864 864 865 865 **Figure 10: SDMX-IM of links from Structure Usage to Category** 866 866 867 -In addition to the maintenance of the Dataflow and the Metadataflow, the following links must be maintained in the registry: 820 +In addition to the maintenance of the [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] and the [[Metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]], the following links must be maintained in the registry: 868 868 869 -* Dataflow to Data Structure Definition 870 -* Metadataflow to Metadata Structure Definition 822 +* [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] to Data Structure Definition 823 +* [[Metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]] to Metadata Structure Definition 871 871 872 872 The following links may be created by means of a Categorisation 873 873 874 -* Categorisation to Dataflow and Category 875 -* Categorisation to Metadataflow and Category 827 +* Categorisation to [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] and Category 828 +* Categorisation to [[Metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]] and Category 876 876 877 -== ={{id name="_Toc93866"/}}7.2 Data and Metadata Provisioning ===830 +== {{id name="_Toc93866"/}}7.2 Data and Metadata Provisioning == 878 878 879 -=== =={{id name="_Toc93867"/}}7.2.1 Provisioning Agreement: Basic concepts =====832 +=== {{id name="_Toc93867"/}}7.2.1 Provisioning Agreement: Basic concepts === 880 880 881 -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. 834 +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:xwiki: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:#2ecc71" %)level(%%) agreements, or other provisioning agreements in those scenarios that are based on legal directives. Additionally, quality and [[timeliness>>doc:xwiki:Glossary.Timeliness.WebHome]] metadata can be supported by this framework which makes it practical to implement information supply chain monitoring. 882 882 883 883 Note that the term “data provisioning” here includes both the provisioning of data and metadata. 884 884 885 -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. 838 +Although the [[Provision Agreement>>doc:xwiki: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. 886 886 887 -=== =={{id name="_Toc93868"/}}7.2.2 Provisioning Agreement Model – pull use case =====840 +=== {{id name="_Toc93868"/}}7.2.2 Provisioning Agreement Model – pull use case === 888 888 889 -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. 842 +An organisation which publishes statistical data or [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] and wishes to make it available to an [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] enabled community is called a [[Data Provider>>doc:xwiki:Glossary.Data provider.WebHome]]. In terms of the [[SDMX Information Model>>doc:xwiki:Glossary.SDMX Information Model.WebHome]], the [[Data Provider>>doc:xwiki:Glossary.Data provider.WebHome]] is maintained in a [[Data Provider Scheme>>doc:xwiki:Glossary.Data provider scheme.WebHome]]. 890 890 891 891 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_ec727775.jpg||height="455" width="551"]] 892 892 ... ... @@ -898,29 +898,29 @@ 898 898 899 899 **Figure 12: Schematic of the Provision Agreement** 900 900 901 -The diagram below is a logical representation of the data required in order to maintain Provision Agreements. 854 +The diagram below is a logical [[representation>>doc:xwiki:Glossary.Representation.WebHome]] of the data required in order to maintain [[Provision Agreements>>doc:xwiki:Glossary.Provision agreement.WebHome]]. 902 902 903 903 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_7b3d291a.jpg||height="246" width="579"]] 904 904 905 905 **Figure 13: Logical class diagram of the information contained in the Provision Agreement** 906 906 907 -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. 860 +A [[Provision Agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]] is [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]]. Each [[Provision Agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]] must reference a [[Data Provider>>doc:xwiki:Glossary.Data provider.WebHome]] or Metadata Provider and a [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] or [[Metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]] Definition. The Data/Metadata Provider and the [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]]/[[Metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]] must exist already in order to set up a Metadata Provision or [[Provision Agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]]. 908 908 909 -== ={{id name="_Toc93869"/}}7.3 Data and Metadata Constraints ===862 +== {{id name="_Toc93869"/}}7.3 Data and Metadata Constraints == 910 910 911 -=== =={{id name="_Toc93870"/}}7.3.1 Data and Metadata Constraints: Basic Concepts =====864 +=== {{id name="_Toc93870"/}}7.3.1 Data and Metadata Constraints: Basic Concepts === 912 912 913 -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. 866 +(% style="color:#2ecc71" %)Constraints(%%) are, effectively, lists of the valid or actual content of data and metadata. (% style="color:#2ecc71" %)Constraints(%%) can be used to specify a subset of the theoretical content of [[data set>>doc:xwiki:Glossary.Data set.WebHome]] or [[metadata set>>doc:xwiki:Glossary.Metadata set.WebHome]] which can be derived from the specification of the [[DSD>>doc:xwiki:Glossary.Data structure definition.WebHome]] or [[MSD>>doc:xwiki:Glossary.Metadata structure definition.WebHome]]. A (% style="color:#2ecc71" %)Constraint(%%) can comprise a list of keys or a list of content (usually [[code>>doc:xwiki:Glossary.Code.WebHome]] values) of a specific [[component>>doc:xwiki:Glossary.Component.WebHome]] such as a [[dimension>>doc:xwiki:Glossary.Dimension.WebHome]] or [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]]. 914 914 915 -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. 868 +(% style="color:#2ecc71" %)Constraints(%%) comprise the specification of subsets of key or [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] values that are contained in a [[data source>>doc:xwiki:Glossary.Data source.WebHome]], or is to be provided for a [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] or [[Metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]], or directly attached to a [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] or [[Metadata Structure Definition>>doc:xwiki: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:xwiki: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:xwiki:Glossary.Code list.WebHome]] for each of the [[Dimensions>>doc:xwiki:Glossary.Dimension.WebHome]]) is often more than is actually present in any specific [[data source>>doc:xwiki:Glossary.Data source.WebHome]], or more than is intended to be supplied according to a specific [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]]. 916 916 917 -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. 870 +Often a [[Data Provider>>doc:xwiki: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:xwiki:Glossary.Data provider.WebHome]] could constrain the [[data source>>doc:xwiki:Glossary.Data source.WebHome]] (at the (% style="color:#2ecc71" %)level(%%) of the [[Provision Agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]] or the [[Data Provider>>doc:xwiki: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:#2ecc71" %)Constraint(%%). The (% style="color:#2ecc71" %)Constraint(%%) is also used to define a [[code list>>doc:xwiki:Glossary.Code list.WebHome]] subset which is used to populate a partial [[code list>>doc:xwiki:Glossary.Code list.WebHome]]. 918 918 919 -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. 872 +Furthermore, it is often useful to define subsets or views of the [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] which restrict values in some [[code lists>>doc:xwiki:Glossary.Code list.WebHome]], especially where many such subsets restrict the same [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]]. Such a view is called a [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]], and there can be one or more defined for any [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]]. 920 920 921 -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. 874 +Whenever data is published or made available by a [[Data Provider>>doc:xwiki:Glossary.Data provider.WebHome]], it must conform to a [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] (and hence to a [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]]). The [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] is thus a means of enabling content based processing. 922 922 923 -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). 876 +In addition, (% style="color:#2ecc71" %)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:xwiki:Glossary.Dimension.WebHome]] [[codes>>doc:xwiki:Glossary.Code.WebHome]] that actually exist in a [[data source>>doc:xwiki: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:xwiki:Glossary.Data source.WebHome]] (these can be used to guide the user to select only those [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] [[code>>doc:xwiki:Glossary.Code.WebHome]] values that will return data based on the [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] values already selected). 924 924 925 925 === {{id name="_Toc93871"/}}7.3.2 Data and Metadata Constraints: Schematic === 926 926 ... ... @@ -936,21 +936,21 @@ 936 936 937 937 Logical class diagram showing inheritance between and reference to constrainable artefacts 938 938 939 -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. 892 +The class diagram above shows that [[Data Provider>>doc:xwiki:Glossary.Data provider.WebHome]], Metadata Provider, [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]], [[Metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]], [[Provision Agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]], Metadata [[Provision Agreement>>doc:xwiki:Glossary.Provision agreement.WebHome]], [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]], [[Metadata Structure Definition>>doc:xwiki:Glossary.Metadata structure definition.WebHome]], Simple Datasource and REST Datasource (via the abstract Query Datasource) are all concrete sub-classes of Constrainable [[Artefact>>doc:xwiki:Glossary.Artefact.WebHome]] and can therefore have (% style="color:#2ecc71" %)Constraints(%%) specified. Note that the actual (% style="color:#2ecc71" %)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:#2ecc71" %)Constraint(%%) applies. 940 940 941 -The content of the Constraint can be found in the SDMX Information Model document. 894 +The content of the (% style="color:#2ecc71" %)Constraint(%%) can be found in the [[SDMX Information Model>>doc:xwiki:Glossary.SDMX Information Model.WebHome]] document. 942 942 943 943 == {{id name="_Toc93873"/}}7.4 Data and Metadata Registration == 944 944 945 945 === {{id name="_Toc93874"/}}7.4.1 Basic Concepts === 946 946 947 -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. 900 +A [[Data Provider>>doc:xwiki:Glossary.Data provider.WebHome]] has published a new [[dataset>>doc:xwiki:Glossary.Data set.WebHome]] conforming to an existing [[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] (and hence [[Data Structure Definition>>doc:xwiki: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:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] RESTful query with an [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] data stream. 948 948 949 -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. 902 +The [[Data Provider>>doc:xwiki: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:xwiki:Glossary.Data consumer.WebHome]]. To do this, the [[Data Provider>>doc:xwiki:Glossary.Data provider.WebHome]] registers the new [[dataset>>doc:xwiki:Glossary.Data set.WebHome]] with one or more [[SDMX>>doc:xwiki: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:xwiki:Glossary.Data provider.WebHome]] and “knows” what [[data flows>>doc:xwiki:Glossary.Dataflow.WebHome]] the [[data provider>>doc:xwiki:Glossary.Data provider.WebHome]] has agreed to make available. 950 950 951 -The same mechanism can be used to report or make available a metadata set. 904 +The same mechanism can be used to report or make available a [[metadata set>>doc:xwiki:Glossary.Metadata set.WebHome]]. 952 952 953 -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. 906 +[[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]]-RR supports [[dataset>>doc:xwiki:Glossary.Data set.WebHome]] and [[metadata set>>doc:xwiki:Glossary.Metadata set.WebHome]] registration via the Registration Request, which can be created by the Data/Metadata Provider (giving the [[Data Provider>>doc:xwiki: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. 954 954 955 955 === {{id name="_Toc93875"/}}7.4.2 The Registration Request === 956 956 ... ... @@ -962,7 +962,7 @@ 962 962 963 963 ==== 7.4.2.2 Registration Request Model ==== 964 964 965 -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: 918 +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:xwiki:Glossary.Data set.WebHome]] or [[metadata set>>doc:xwiki:Glossary.Metadata set.WebHome]] to be registered. The Registration can optionally have information, which has been extracted from the Registration: 966 966 967 967 * validFrom 968 968 * validTo ... ... @@ -970,19 +970,16 @@ 970 970 971 971 The last updated date is useful during the discovery process to make sure the client knows which data is freshest. 972 972 973 -The Registration has an action attribute which takes one of the following values: 926 +The Registration has an action [[attribute>>doc:xwiki:Glossary.Attribute.WebHome]] which takes one of the following values: 974 974 975 -: 976 - 977 977 ((( 978 -|**Action Attribute Value**|**Behaviour** 979 -|Append|Add this Registration to the registry 980 -|Replace|((( 981 -Replace the existing Registration with identified by the id in the 982 - 983 -Registration of the SubmitRegistrationRequest 929 +(% style="width:761.294px" %) 930 +|(% style="width:196px" %)**Action Attribute Value**|(% style="width:561px" %)**Behaviour** 931 +|(% style="width:196px" %)Append|(% style="width:561px" %)Add this Registration to the registry 932 +|(% style="width:196px" %)Replace|(% style="width:561px" %)((( 933 +Replace the existing Registration with identified by the id in the Registration of the SubmitRegistrationRequest 984 984 ))) 985 -|Delete|Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest 935 +|(% style="width:196px" %)Delete|(% style="width:561px" %)Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest 986 986 ))) 987 987 988 988 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_bc1dcdec.jpg||height="575" width="579"]] ... ... @@ -989,52 +989,45 @@ 989 989 990 990 **Figure 17: Logical Class Diagram of Registration of Data and Metadata** 991 991 992 -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. 942 +The //QueryDatasource// is an abstract class that represents a [[data source>>doc:xwiki:Glossary.Data source.WebHome]], which can understand an API query (i.e., a RESTful query – RESTDatasource) and respond appropriately. Each [[data source>>doc:xwiki: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. 993 993 994 -A SimpleDatasource is used to reference a physical SDMX-ML file that is available at a URL. 944 +A SimpleDatasource is used to reference a physical [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] file that is available at a URL. 995 995 996 -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. 946 +The RegistrationRequest has an action [[attribute>>doc:xwiki: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. 997 997 998 -The Registration includes attributes that state how a SimpleDatasource is to be indexed when registered. The Registry registration process must act as follows: 948 +The Registration includes [[attributes>>doc:xwiki:Glossary.Attribute.WebHome]] that state how a SimpleDatasource is to be indexed when registered. The Registry registration process must act as follows: 999 999 1000 -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. 950 +Information in the data or [[metadata set>>doc:xwiki:Glossary.Metadata set.WebHome]] is extracted and placed in one or more (% style="color:#2ecc71" %)//Constraint//(%%)s (see the (% style="color:#2ecc71" %)//Constraint//(%%) model in the [[SDMX Information Model>>doc:xwiki:Glossary.SDMX Information Model.WebHome]] – Section 2 of the [[SDMX>>doc:xwiki: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. 1001 1001 1002 -: 1003 - 1004 1004 ((( 1005 - |**IndexingRequired**|**Registration Process Activity**1006 -| indexTimeSeries|Extractalltheserieskeysandcreate a KeySet(s) Constraint.1007 -|index DataSet|Extract all thecodesand othercontentof theKeyvalueof theSeriesKeyin a Data Setand createone or more Cube Regions containingMemberSelectionsofDimension Componentsof theConstraints model in the SDMX-IM, and the associated Selection Value.1008 -|index ReportingPeriod|(((1009 - This appliesonly to aregistered__dataset__.1010 - 1011 -Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint. 953 +(% style="width:678.294px" %) 954 +|**Indexing Required**|(% style="width:504px" %)**Registration Process Activity** 955 +|indexTimeSeries|(% style="width:504px" %)Extract all the [[series keys>>doc:xwiki:Glossary.Series key.WebHome]] and create a KeySet(s) (% style="color:#2ecc71" %)Constraint(%%). 956 +|indexDataSet|(% style="width:504px" %)Extract all the [[codes>>doc:xwiki:Glossary.Code.WebHome]] and other content of the Key value of the [[Series Key>>doc:xwiki:Glossary.Series key.WebHome]] in a [[Data Set>>doc:xwiki:Glossary.Data set.WebHome]] and create one or more Cube Regions containing [[Member Selections>>doc:xwiki:Glossary.Member selection.WebHome]] of [[Dimension>>doc:xwiki:Glossary.Dimension.WebHome]] [[Components>>doc:xwiki:Glossary.Component.WebHome]] of the (% style="color:#2ecc71" %)Constraints(%%) model in the [[SDMX-IM>>doc:xwiki:Glossary.SDMX Information Model.WebHome]], and the associated Selection Value. 957 +|indexReportingPeriod|(% style="width:504px" %)((( 958 +This applies only to a registered __[[dataset>>doc:xwiki:Glossary.Data set.WebHome]]__. 959 +Extract the Reporting Begin and Reporting End from the Header of the Message containing the [[data set>>doc:xwiki:Glossary.Data set.WebHome]], and create a [[Reference Period>>doc:xwiki:Glossary.Reference period.WebHome]] (% style="color:#2ecc71" %)constraint(%%). 1012 1012 ))) 1013 -|**Indexing Required**|**Registration Process Activity** 1014 -|indexAttributes|((( 1015 -**Data Set** 1016 - 1017 -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 1018 - 1019 -SDMXIM, and the associated Selection Value 1020 - 1021 -**Metadata Set** 1022 - 1023 -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. 961 +|**Indexing Required**|(% style="width:504px" %)**Registration Process Activity** 962 +|indexAttributes|(% style="width:504px" %)((( 963 +**[[Data Set>>doc:xwiki:Glossary.Data set.WebHome]]** 964 +Extract the content of the [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] Values in a [[Data Set>>doc:xwiki:Glossary.Data set.WebHome]] and create one or more Cube Regions containing [[Member Selections>>doc:xwiki:Glossary.Member selection.WebHome]] of Data [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] [[Components>>doc:xwiki:Glossary.Component.WebHome]] of the (% style="color:#2ecc71" %)Constraints(%%) model in the SDMXIM, and the associated Selection Value 965 +**[[Metadata Set>>doc:xwiki:Glossary.Metadata set.WebHome]]** 966 +Indicate the presence of a Reported [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] by creating one or more Cube Regions containing [[Member Selections>>doc:xwiki:Glossary.Member selection.WebHome]] of Metadata [[Attribute>>doc:xwiki:Glossary.Attribute.WebHome]] [[Components>>doc:xwiki:Glossary.Component.WebHome]] of the (% style="color:#2ecc71" %)Constraints(%%) model in the [[SDMX-IM>>doc:xwiki:Glossary.SDMX Information Model.WebHome]]. Note that the content is not stored in the Selection Value. 1024 1024 ))) 1025 1025 ))) 1026 1026 1027 -Constraints that specify the contents of a //QueryDatasource// are submitted to the Registry via the structure submission service (i.e., the RESTful API). 970 +(% style="color:#2ecc71" %)Constraints(%%) that specify the contents of a //QueryDatasource// are submitted to the Registry via the structure submission service (i.e., the RESTful API). 1028 1028 1029 1029 The Registration must reference the ProvisionAgreement or MetadataProvisionAgreement to which it relates. 1030 1030 1031 -=== =={{id name="_Toc93876"/}}7.4.3 Registration Response =====974 +=== {{id name="_Toc93876"/}}7.4.3 Registration Response === 1032 1032 1033 1033 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”. 1034 1034 1035 -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. 978 +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:xwiki:Glossary.Data set.WebHome]], metadataset, or query service. 1036 1036 1037 -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: 980 +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:xwiki:Glossary.Data set.WebHome]], that the response will contain some successful and some failed statuses. The logical model for the RegistrationResponse is shown below: 1038 1038 1039 1039 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_6c58dd9b.jpg||height="371" width="579"]] 1040 1040 ... ... @@ -1056,97 +1056,86 @@ 1056 1056 1057 1057 === {{id name="_Toc93879"/}}7.5.2 Subscription Information === 1058 1058 1059 -Regardless of the type of registry/repository events being observed, a subscription always contains: 1002 +Regardless of the type of registry/repository events being observed, a [[subscription>>doc:xwiki:Glossary.Subscription.WebHome]] always contains: 1060 1060 1061 -1. Aset of URIs describing the end-points to which notifications must be sent if the subscription is activated. The URIs can be either mailto~: or http: protocol. In the former case an email notification is sent; in the latter an HTTP POST notification is sent.1062 -1. A 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. 1063 -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. 1004 +1. set of URIs describing the end-points to which [[notifications>>doc:xwiki:Glossary.Notification.WebHome]] must be sent if the [[subscription>>doc:xwiki:Glossary.Subscription.WebHome]] is activated. The URIs can be either mailto~: or http: protocol. In the former case an email [[notification>>doc:xwiki:Glossary.Notification.WebHome]] is sent; in the latter an HTTP POST [[notification>>doc:xwiki:Glossary.Notification.WebHome]] is sent. 1005 +1. A user-defined identifier, which is returned in the response to the [[subscription>>doc:xwiki:Glossary.Subscription.WebHome]] request. This helps with asynchronous processing and is NOT stored in the Registry. 1006 +1. A validity period which defines both when the [[subscription>>doc:xwiki:Glossary.Subscription.WebHome]] becomes active and expires. The subscriber may be sent a [[notification>>doc:xwiki:Glossary.Notification.WebHome]] on expiration of the [[subscription>>doc:xwiki:Glossary.Subscription.WebHome]]. 1064 1064 1. A selector which specifies which type of events are of interest. The set of event types is: 1065 1065 1066 -: 1067 -:: 1068 - 1069 1069 ((( 1070 -|**Event Type**|**Comment** 1071 -|STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository. 1072 -|DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database. 1073 -|METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database. 1074 -|ALL_EVENTS|All events of the specified EventType 1010 +(% style="width:856.294px" %) 1011 +|(% style="width:320px" %)**Event Type**|(% style="width:532px" %)**Comment** 1012 +|(% style="width:320px" %)STRUCTURAL_REPOSITORY_EVENTS|(% style="width:532px" %)Life-cycle changes to [[Maintainable Artefacts>>doc:xwiki:Glossary.Maintainable artefact.WebHome]] in the [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] repository. 1013 +|(% style="width:320px" %)DATA_REGISTRATION_EVENTS|(% style="width:532px" %)Whenever a published [[dataset>>doc:xwiki:Glossary.Data set.WebHome]] is registered. This can be either a SDMXML data file or an [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] conformant database. 1014 +|(% style="width:320px" %)METADATA_REGISTRATION_EVENTS|(% style="width:532px" %)Whenever a published metadataset is registered. This can be either a SDMXML [[reference metadata>>doc:xwiki:Glossary.Reference metadata.WebHome]] file or an [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] conformant database. 1015 +|(% style="width:320px" %)ALL_EVENTS|(% style="width:532px" %)All events of the specified EventType 1075 1075 ))) 1076 1076 1077 1077 === {{id name="_Toc93880"/}}7.5.3 Wildcard Facility === 1078 1078 1079 -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: 1020 +[[Subscription>>doc:xwiki:Glossary.Subscription.WebHome]] [[notification>>doc:xwiki:Glossary.Notification.WebHome]] supports wildcarded identifier [[components>>doc:xwiki:Glossary.Component.WebHome]] URNs, which are identifiers which have some or all of their [[component>>doc:xwiki:Glossary.Component.WebHome]] parts replaced by the wildcard character `*`. Identifier [[components>>doc:xwiki:Glossary.Component.WebHome]] comprise: 1080 1080 1081 1081 * agencyID 1082 1082 * id 1083 1083 * version 1084 1084 1085 -Examples of wildcarded identifier components for an identified object type of Codelist are shown below: 1026 +Examples of wildcarded identifier [[components>>doc:xwiki:Glossary.Component.WebHome]] for an identified object type of Codelist are shown below: 1086 1086 1087 1087 AgencyID = * 1088 - 1089 1089 Id = * 1090 - 1091 1091 Version = * 1092 1092 1093 -This subscribes to all Codelists of all versions for all agencies. 1032 +This subscribes to all Codelists of all (% style="color:#2ecc71" %)versions(%%) for all agencies. 1094 1094 1095 1095 AgencyID = AGENCY1 1096 - 1097 1097 Id = CODELIST1 1098 - 1099 1099 Version = * 1100 1100 1101 -This subscribes to all versions of Codelist CODELIST1 maintained by the agency AGENCY1. 1038 +This subscribes to all (% style="color:#2ecc71" %)versions(%%) of Codelist CODELIST1 maintained by the agency AGENCY1. 1102 1102 1103 1103 AgencyID = AGENCY1 1104 - 1105 1105 Id = * 1106 - 1107 1107 Version = * 1108 1108 1109 -This subscribes to all versions of all Codelist objects maintained by the agency AGENCY1. 1044 +This subscribes to all (% style="color:#2ecc71" %)versions(%%) of all Codelist objects maintained by the agency AGENCY1. 1110 1110 1111 1111 AgencyID = * 1112 - 1113 1113 Id = CODELIST1 1114 - 1115 1115 Version = * 1116 1116 1117 -This subscribes to all versions of Codelist CODELIST1 maintained by any agency. 1050 +This subscribes to all (% style="color:#2ecc71" %)versions(%%) of Codelist CODELIST1 maintained by any agency. 1118 1118 1119 -Note that if the subscription is to the latest stable version then this can be achieved by the + character, i.e.: 1052 +Note that if the [[subscription>>doc:xwiki:Glossary.Subscription.WebHome]] is to the latest stable (% style="color:#2ecc71" %)version(%%) then this can be achieved by the + character, i.e.: 1120 1120 1121 1121 Version = + 1122 1122 1123 -A subscription to the latest version (whether stable, draft or non-versioned) can be achieved by the ~~character, i.e.:1056 +A [[subscription>>doc:xwiki:Glossary.Subscription.WebHome]] to the latest (% style="color:#2ecc71" %)version(%%) (whether stable, draft or non-versioned) can be achieved by the character, i.e.: 1124 1124 1125 1125 Version = ~~ 1126 1126 1127 -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.: 1060 +A [[subscription>>doc:xwiki:Glossary.Subscription.WebHome]] to the latest stable (% style="color:#2ecc71" %)version(%%) within major (% style="color:#2ecc71" %)version(%%) 2 starting with (% style="color:#2ecc71" %)version(%%) 2.3.1 can be achieved by adding the + character after the minor (% style="color:#2ecc71" %)version(%%) number, i.e.: 1128 1128 1129 1129 Version = 2.3+.1 1130 1130 1131 -The complete SDMX versioning syntax can be found in the SDMX Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”. 1064 +The complete [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] versioning syntax can be found in the [[SDMX>>doc:xwiki:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”. 1132 1132 1133 1133 === {{id name="_Toc93881"/}}7.5.4 Structural Repository Events === 1134 1134 1135 -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. 1068 +Whenever a [[maintainable artefact>>doc:xwiki:Glossary.Maintainable artefact.WebHome]] ([[data structure definition>>doc:xwiki:Glossary.Data structure definition.WebHome]], [[concept scheme>>doc:xwiki:Glossary.Concept scheme.WebHome]], codelist, [[metadata structure definition>>doc:xwiki:Glossary.Metadata structure definition.WebHome]], [[category scheme>>doc:xwiki:Glossary.Category scheme.WebHome]], etc.) is added to, deleted from, or modified in the [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] repository, a [[structural metadata>>doc:xwiki:Glossary.Structural metadata.WebHome]] event is triggered. [[Subscriptions>>doc:xwiki:Glossary.Subscription.WebHome]] may be set up to monitor all such events, or focus on specific [[artefacts>>doc:xwiki:Glossary.Artefact.WebHome]] such as a [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]]. 1136 1136 1137 1137 === {{id name="_Toc93882"/}}7.5.5 Registration Events === 1138 1138 1139 -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: 1072 +Whenever a [[dataset>>doc:xwiki:Glossary.Data set.WebHome]] or metadata-set is registered a registration event is created. A [[subscription>>doc:xwiki:Glossary.Subscription.WebHome]] may be observing all data or metadata registrations, or it may focus on specific registrations as shown in the table below: 1140 1140 1141 -: 1142 - 1143 1143 ((( 1144 -|**Selector**|**Comment** 1145 -|DataProvider & MetadataProvider|Any datasets or metadata sets registered by the specified data or metadata provider will activate the notification. 1146 -|ProvisionAgreement & MetadataProvisionAgreement|Any datasets or metadata sets registered for the agreement will activate the notification. 1147 -|Dataflow & Metadataflow|Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification. 1148 -|DataStructureDefinition & MetadataStructureDefinition|Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will activate the notification 1149 -|Category|Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category. 1075 +(% style="width:1126.29px" %) 1076 +|(% style="width:382px" %)**Selector**|(% style="width:740px" %)**Comment** 1077 +|(% style="width:382px" %)DataProvider & MetadataProvider|(% style="width:740px" %)Any [[datasets>>doc:xwiki:Glossary.Data set.WebHome]] or [[metadata sets>>doc:xwiki:Glossary.Metadata set.WebHome]] registered by the specified data or metadata provider will activate the notification. 1078 +|(% style="width:382px" %)ProvisionAgreement & MetadataProvisionAgreement|(% style="width:740px" %)Any [[datasets>>doc:xwiki:Glossary.Data set.WebHome]] or [[metadata sets>>doc:xwiki:Glossary.Metadata set.WebHome]] registered for the agreement will activate the notification. 1079 +|(% style="width:382px" %)[[Dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] & [[Metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]]|(% style="width:740px" %)Any [[datasets>>doc:xwiki:Glossary.Data set.WebHome]] or [[metadata sets>>doc:xwiki:Glossary.Metadata set.WebHome]] registered for the specified [[dataflow>>doc:xwiki:Glossary.Dataflow.WebHome]] (or [[metadataflow>>doc:xwiki:Glossary.Metadataflow.WebHome]]) will activate the notification. 1080 +|(% style="width:382px" %)DataStructureDefinition & MetadataStructureDefinition|(% style="width:740px" %)Any [[datasets>>doc:xwiki:Glossary.Data set.WebHome]] or [[metadata sets>>doc:xwiki:Glossary.Metadata set.WebHome]] registered for those [[dataflows>>doc:xwiki:Glossary.Dataflow.WebHome]] (or [[metadataflows>>doc:xwiki:Glossary.Metadataflow.WebHome]]) that are based on the specified [[Data Structure Definition>>doc:xwiki:Glossary.Data structure definition.WebHome]] will activate the notification 1081 +|(% style="width:382px" %)[[Category>>doc:xwiki:Glossary.Category.WebHome]]|(% style="width:740px" %)Any [[datasets>>doc:xwiki:Glossary.Data set.WebHome]] or [[metadata sets>>doc:xwiki:Glossary.Metadata set.WebHome]] registered for those [[dataflows>>doc:xwiki:Glossary.Dataflow.WebHome]], [[metadataflows>>doc:xwiki:Glossary.Metadataflow.WebHome]], [[provision agreements>>doc:xwiki:Glossary.Provision agreement.WebHome]] that are categorised by the [[category>>doc:xwiki:Glossary.Category.WebHome]]. 1150 1150 ))) 1151 1151 1152 1152 The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration. ... ... @@ -1159,29 +1159,25 @@ 1159 1159 1160 1160 **Figure 20: Logical Class Diagram of the Notification** 1161 1161 1162 -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. 1094 +A [[notification>>doc:xwiki:Glossary.Notification.WebHome]] is an XML document that is sent to a user via email or http POST whenever a [[subscription>>doc:xwiki:Glossary.Subscription.WebHome]] is activated. It is an asynchronous one-way message. 1163 1163 1164 -Regardless of the registry component that caused the event to be triggered, the following common information is in the message: 1096 +Regardless of the registry [[component>>doc:xwiki:Glossary.Component.WebHome]] that caused the event to be triggered, the following common information is in the message: 1165 1165 1166 1166 * Date and time that the event occurred 1167 -* The URN of the artefact that caused the event 1168 -* The URN of the Subscription that produced the notification 1099 +* The URN of the [[artefact>>doc:xwiki:Glossary.Artefact.WebHome]] that caused the event 1100 +* The URN of the [[Subscription>>doc:xwiki:Glossary.Subscription.WebHome]] that produced the [[notification>>doc:xwiki:Glossary.Notification.WebHome]] 1169 1169 * Event Action: Add, Replace, or Delete. 1170 1170 1171 -Additionally, supplementary information may be contained in the notification as detailed below. 1103 +Additionally, supplementary information may be contained in the [[notification>>doc:xwiki:Glossary.Notification.WebHome]] as detailed below. 1172 1172 1173 1173 === {{id name="_Toc93885"/}}7.6.2 Structural Event Component === 1174 1174 1175 -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). 1107 +The [[notification>>doc:xwiki:Glossary.Notification.WebHome]] will contain the MaintainableArtefact that triggered the event in a form similar to the [[SDMX-ML>>doc:xwiki:Glossary.SDMX-ML.WebHome]] structural message (using elements from that namespace). 1176 1176 1177 1177 === {{id name="_Toc93886"/}}7.6.3 Registration Event Component === 1178 1178 1179 -The notification will contain the Registration. 1111 +The [[notification>>doc:xwiki:Glossary.Notification.WebHome]] will contain the Registration. 1180 1180 1181 - [[1>>path:#sdfootnote1anc||name="sdfootnote1sym"]] With semantic versioning, it is allowed to reference a range of artefacts, e.g., a DSD referencing a Codelist with version 1.2.3+ means all patch versions greater than 1.2.3. This means that deleting 1.2.4draft does not break integrity of the aforementioned DSD.1113 +---- 1182 1182 1183 -[[2>>path:#sdfootnote2anc||name="sdfootnote2sym"]] The identification of an Agency in the URN structure for the maintainable object is by means of the agencyId. The AgencyScheme is not identified as SDMX has a mechanism for identifying an Agency uniquely by its Id. Note that this Id may be hierarchical. For example, a sub-agency of IMF is referred like this: 1184 - 1185 -IMF.SubAgency1 1186 - 1187 -[[3>>path:#sdfootnote3anc||name="sdfootnote3sym"]] Note that Codelist is also an EnumeratedList. 1115 +{{putFootnotes/}}
- 1747307906944-697.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +XWiki.helena - Size
-
... ... @@ -1,0 +1,1 @@ 1 +37.9 KB - Content
- SUZ.Methodology.Code.MethodologyClass[0]
-