Last modified by Artur on 2025/09/30 13:28
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -11,69 +11,69 @@ 11 11 12 12 = 1 Introduction = 13 13 14 -The business vision for [[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]] envisages the promotion of a “data sharing” model to facilitate low-cost, high-quality[[statistical data and metadata exchange>>doc:sdmx:Glossary.Statisticaldata 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:14 +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: 15 15 16 -* the availability of an abstract information model capable of supporting time series and cross-sectional data, [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]], and[[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]]([[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]])17 -* standardised XML and JSON schemas for the [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]]and[[SDMX-JSON>>doc:sdmx:Glossary.SDMX-JSON.WebHome]]formats derived from the model (XSD, JSON)16 +* the availability of an abstract information model capable of supporting time series and cross-sectional data, structural metadata, and reference metadata (SDMX-IM) 17 +* standardised XML and JSON schemas for the SDMX-ML and SDMX-JSON formats derived from the model (XSD, JSON) 18 18 * the use of web-services technology (XML, JSON, Open API) 19 19 20 -Such an architecture needs to be well organised, and the [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]]/Repository (SDMXRR) is tasked with providing structure, organisation, and maintenance and query interfaces for most of the[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]] [[components>>doc:sdmx:Glossary.Component.WebHome]]required to support the data sharing vision.20 +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. 21 21 22 -However, it is important to emphasise that the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-RR provides support for the submission and retrieval of all[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.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.22 +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. 23 23 24 -Standard formats for the exchange of aggregated statistical data and metadata as prescribed in [[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]v3.1 are envisaged to bring benefits to the statistical community because data reporting and dissemination processes can be made more efficient.24 +Standard formats for the exchange of aggregated statistical data and metadata as prescribed in SDMX v3.1 are envisaged to bring benefits to the statistical community because data reporting and dissemination processes can be made more efficient. 25 25 26 -As organisations migrate to [[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]] enabled systems, many XML, JSON (and conventional)[[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]will be produced (e.g., Data Structure, Metadata Structure,[[Code List>>doc:sdmx:Glossary.Codelist.WebHome]]and(% style="color:#e74c3c" %)Concept(%%)definitions – often collectively called[[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]]– XML schemas generated from[[data structure definitions>>doc:sdmx:Glossary.Data structure definition.WebHome]], XSLT stylesheets for transformation and display of data and metadata, terminology references, etc.). The[[SDMX>>doc:sdmx:Glossary.Statisticaldata andmetadata exchange.WebHome]] model supports interoperability, and it is important to be able to discover and share these[[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]between parties in a controlled and organized way.26 +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. 27 27 28 28 This is the role of the registry. 29 29 30 -With the fundamental [[SDMX>>doc:sdmx:Glossary.Statisticaldata 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:sdmx:Glossary.Statistical data and metadata exchange.WebHome]], with an emphasis on maintenance, retrieval and sharing of the[[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]].In addition, the architectural standards support the registration and discovery of data and referential metadata.30 +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. 31 31 32 -These architectural standards address the ‘how’, rather than the ‘what’, and are aimed at enabling existing [[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]standards to achieve their mission. The architectural standards address registry services, which initially comprise:32 +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: 33 33 34 -* [[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]]repository34 +* structural metadata repository 35 35 * data and metadata registration 36 36 * query 37 37 38 -The registry services outlined in this specification are designed to help the [[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]] community manage the proliferation of[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]] assets and to support data sharing for reporting and dissemination.38 +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. 39 39 40 40 = 2 Scope and Normative Status = 41 41 42 -The scope of this document is to specify the logical interfaces for the [[SDMX registry>>doc:sdmx:Glossary.SDMXRegistry.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.42 +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. 43 43 44 44 In this document, functions and behaviours of the Registry Interfaces are described in four ways: 45 45 46 46 * in text 47 47 * with tables 48 -* with UML diagrams excerpted from the [[SDMX Information Model>>doc:sdmx:Glossary.SDMXInformation Model.WebHome]]([[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]])49 -* with UML diagrams that are not a part of the [[SDMX-IM>>doc:sdmx:Glossary.SDMXInformation Model.WebHome]] but are included here for clarity and to aid implementations (these diagrams are clearly marked as “Logical Class Diagram ...”)48 +* with UML diagrams excerpted from the SDMX Information Model (SDMX-IM) 49 +* 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 ...”) 50 50 51 51 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. 52 52 53 -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:sdmx:Glossary.Notification.WebHome]]mechanism must support e-mail and HTTP/HTTPS protocols as described. Normative registry interfaces are specified in the[[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]]specification (Section 3 of the[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]Standard). All other sections of this document are informative.53 +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. 54 54 55 -Note that although the term “authorised user” is used in this document, the [[SDMX>>doc:sdmx:Glossary.Statisticaldata 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.55 +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. 56 56 57 57 = 3 Scope of the SDMX Registry/Repository = 58 58 59 59 == 3.1 Objective == 60 60 61 -The objective of the [[SDMX registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]]/repository is, in broad terms, to allow organisations to publish statistical data and[[reference metadata>>doc:sdmx:Glossary.Referencemetadata.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:61 +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: 62 62 63 -1. To maintain and publish [[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]] that describes the structure and valid content of data and[[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]]sources such as databases,[[metadata repositories>>doc:sdmx:Glossary.Metadata repository.WebHome]],[[data sets>>doc:sdmx:Glossary.Data set.WebHome]],[[metadata sets>>doc:sdmx:Glossary.Metadataset.WebHome]].This[[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]] enables software applications to understand and to interpret the data and[[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]]in these sources.64 -1. To enable applications, organisations, and individuals to share and to discover data and [[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]].This facilitates data and[[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]] dissemination by implementing the data sharing vision of[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]].63 +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. 64 +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. 65 65 66 66 == 3.2 Structural Metadata == 67 67 68 -Setting up [[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]] and the exchange context (referred to as “data provisioning”) involves the following steps for[[maintenance agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]]:68 +Setting up structural metadata and the exchange context (referred to as “data provisioning”) involves the following steps for maintenance agencies: 69 69 70 -* agreeing and creating a specification of the structure of the data (called a [[Data Structure Definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]] or[[DSD>>doc:sdmx:Glossary.Datastructure definition.WebHome]]inthis document but also known as “key family”), which defines the[[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]],[[measures>>doc:sdmx:Glossary.Measure.WebHome]]and[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]of a[[dataset>>doc:sdmx:Glossary.Dataset.WebHome]]and their valid value set;71 -* if required, defining a subset or view of a [[DSD>>doc:sdmx:Glossary.Datastructure definition.WebHome]]which allows some restriction of content called a “[[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]definition”;72 -* agreeing and creating a specification of the structure of [[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]]([[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]) which defines the metadata[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]and their presentational arrangement in a Metadataset or as part of a[[Dataset>>doc:sdmx:Glossary.Data set.WebHome]], and their valid values and content;73 -* if required, defining a subset or view of an [[MSD>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]]which allows some restriction of content called a “[[metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]”;74 -* defining which subject matter domains (specified as a [[Category Scheme>>doc:sdmx:Glossary.Category scheme.WebHome]]) are related to the[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]and[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]to enable browsing;70 +* 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; 71 +* if required, defining a subset or view of a DSD which allows some restriction of content called a “dataflow definition”; 72 +* 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; 73 +* if required, defining a subset or view of an MSD which allows some restriction of content called a “metadataflow”; 74 +* defining which subject matter domains (specified as a Category Scheme) are related to the Dataflow and Metadataflow to enable browsing; 75 75 * defining one or more lists of Data and Metadata Providers; 76 -* defining which Data/Metadata Providers have agreed to publish a given [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]/[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]– this is called a[[Provision Agreement>>doc:sdmx:Glossary.Provisionagreement.WebHome]] or Metadata[[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], respectively.76 +* defining which Data/Metadata Providers have agreed to publish a given Dataflow/Metadataflow – this is called a Provision Agreement or Metadata Provision Agreement, respectively. 77 77 78 78 [[image:SDMX 3.1 Section 5_en_c485399b.jpg||height="539" width="443"]] 79 79 ... ... @@ -81,20 +81,20 @@ 81 81 82 82 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: 83 83 84 -* Structure Definition: refers to [[Data Structure Definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]]([[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]]) and[[Metadata Structure Definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]]([[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]])85 -* Flow: refers to [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]and[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]86 -* [[Provision Agreement>>doc:sdmx:Glossary.Provisionagreement.WebHome]]: refers to[[Provision Agreement>>doc:sdmx:Glossary.Provisionagreement.WebHome]](for data) and Metadata[[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]]87 -* Provider Scheme: refers to [[Data Provider Scheme>>doc:sdmx:Glossary.Dataprovider scheme.WebHome]]and Metadata Provider Scheme88 -* Provider: refers to [[Data Provider>>doc:sdmx:Glossary.Dataprovider.WebHome]]and Metadata Provider84 +* Structure Definition: refers to Data Structure Definition (DSD) and Metadata Structure Definition (MSD) 85 +* Flow: refers to Dataflow and Metadataflow 86 +* Provision Agreement: refers to Provision Agreement (for data) and Metadata Provision Agreement 87 +* Provider Scheme: refers to Data Provider Scheme and Metadata Provider Scheme 88 +* Provider: refers to Data Provider and Metadata Provider 89 89 90 -In that context, the term “Metadata” refers to [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]].90 +In that context, the term “Metadata” refers to reference metadata. 91 91 92 92 == 3.3 Registration == 93 93 94 -Publishing the data and [[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]]involves the following steps for a Data/Metadata Provider:94 +Publishing the data and reference metadata involves the following steps for a Data/Metadata Provider: 95 95 96 -* making the [[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]] and data available in[[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]]/JSON conformant data files or databases (which respond to an[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]query with data). The data and[[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]]files or databases must be web accessible, and must conform to an agreed[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]or[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]([[Data Structure Definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]] or[[Metadata Structure Definition>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]]subset);97 -* registering the existence of published [[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]] and data files or databases with one or more[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]registries.96 +* 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); 97 +* registering the existence of published reference metadata and data files or databases with one or more SDMX registries. 98 98 99 99 [[image:SDMX 3.1 Section 5_en_6e468656.jpg||height="407" width="553"]] 100 100 ... ... @@ -102,17 +102,17 @@ 102 102 103 103 == 3.4 Notification == 104 104 105 -Notifying interested parties of newly published or re-published data, [[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]] or changes in[[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]]involves:105 +Notifying interested parties of newly published or re-published data, reference metadata or changes in structural metadata involves: 106 106 107 -• registry support of a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]-based[[notification>>doc:sdmx: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:sdmx:Glossary.Subscription.WebHome]]request.107 +• 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. 108 108 109 109 == 3.5 Discovery == 110 110 111 -Discovering published data and [[reference metadata>>doc:sdmx:Glossary.Referencemetadata.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:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-enabled data or[[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]]resource:111 +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: 112 112 113 -* optionally browsing a subject matter domain [[category scheme>>doc:sdmx:Glossary.Categoryscheme.WebHome]]to find[[Dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]](and hence[[Data Structure Definitions>>doc:sdmx:Glossary.Data structure definition.WebHome]]) and[[Metadataflows>>doc:sdmx:Glossary.Metadataflow.WebHome]]which structure the type of data and/or[[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]] being sought;114 -* build a query, in terms of the selected [[Data Structure Definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]] or[[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], which specifies what data are required and submitting this to a service that can query an[[SDMX registry>>doc:sdmx:Glossary.SDMXRegistry.WebHome]]which will return a list of (URLs of) data and[[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]]files and databases which satisfy the query;115 -* processing the query result set and retrieving data and/or [[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]]from the supplied URLs.113 +* 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; 114 +* 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; 115 +* processing the query result set and retrieving data and/or reference metadata from the supplied URLs. 116 116 117 117 [[image:SDMX 3.1 Section 5_en_6c6c7b74.jpg||height="328" width="554"]] 118 118 ... ... @@ -122,7 +122,7 @@ 122 122 123 123 == 4.1 Architectural Schematic == 124 124 125 -The architecture of the [[SDMX registry>>doc:sdmx: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:sdmx:Glossary.Structuralmetadata.WebHome]]repository which supports a provisioning[[metadata repository>>doc:sdmx:Glossary.Metadatarepository.WebHome]]which supports the registry services. These are all supported by the[[SDMX-ML>>doc:sdmx: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:sdmx:Glossary.Structuralmetadata.WebHome]]required to drive these applications.125 +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. 126 126 127 127 [[image:SDMX 3.1 Section 5_en_81e92e22.jpg||height="325" width="553"]] 128 128 ... ... @@ -130,18 +130,18 @@ 130 130 131 131 == 4.2 Structural Metadata Repository == 132 132 133 -The basic layer is that of a [[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]]service which supports the lifecycle of[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]] [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]such as[[Maintenance Agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]],[[Data Structure Definitions>>doc:sdmx:Glossary.Data structure definition.WebHome]],[[Metadata Structure Definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]],[[Provision Agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]], Processes etc. This layer is supported by the Structure Submission and Query Service.133 +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. 134 134 135 -Note that the [[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]REST API supports all of the[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]structural[[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]].The only structural[[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]that are not yet supported are:135 +Note that the SDMX REST API supports all of the SDMX structural artefacts. The only structural artefacts that are not yet supported are: 136 136 137 137 * Registration of data and metadata sources 138 -* [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]and[[Notification>>doc:sdmx:Glossary.Notification.WebHome]]138 +* Subscription and Notification 139 139 140 -As of the initial (% style="color:#e74c3c" %)version(%%)of[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]3.0 no messages are defined to support these[[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]; hence, users may need to use[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]2.1 Registry Interface messages, instead.140 +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. 141 141 142 142 == 4.3 Provisioning Metadata Repository == 143 143 144 -The function of this repository is to support the definition of the [[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]] that describes the various types of data-store which model[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-conformant databases or files, and to link to these[[data sources>>doc:sdmx:Glossary.Datasource.WebHome]].These links can be specified for a data/metadata provider, for a specific data or[[metadata flow>>doc:sdmx:Glossary.Metadataflow.WebHome]].In the[[SDMX>>doc:sdmx:Glossary.Statisticaldata andmetadata exchange.WebHome]] model this is called the Provision or Metadata[[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]].144 +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. 145 145 146 146 This layer is supported by the Data and Metadata Registration Service. 147 147 ... ... @@ -152,25 +152,25 @@ 152 152 The Registry Interfaces are: 153 153 154 154 * Notify Registry Event 155 -* Submit [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]Request156 -* Submit [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]Response155 +* Submit Subscription Request 156 +* Submit Subscription Response 157 157 * Submit Registration Request 158 158 * Submit Registration Response 159 159 * Query Registration Request 160 160 * Query Registration Response 161 -* Query [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]Request162 -* Query [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]Response161 +* Query Subscription Request 162 +* Query Subscription Response 163 163 164 164 The registry interfaces are invoked in one of two ways: 165 165 166 -1. The interface is the name of the root node of the [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]]document167 -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:sdmx:Glossary.SDMX-ML.WebHome]]document.166 +1. The interface is the name of the root node of the SDMX-ML document 167 +1. The interface is invoked as a child element of the RegistryInterface message where the RegistryInterface is the root node of the SDMX-ML document. 168 168 169 -In addition to these interfaces the registry must support a mechanism for submitting and querying for [[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]].This is detailed in sections 5.2.2 and 5.2.3.169 +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. 170 170 171 -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:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-RR interface, is a “Request” document. The message returned by the interface is a “Response” document.171 +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. 172 172 173 -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:sdmx: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.173 +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. 174 174 175 175 == 5.2 Registry Services == 176 176 ... ... @@ -180,15 +180,15 @@ 180 180 181 181 === 5.2.2 Structure Submission Service === 182 182 183 -The registry must support a mechanism for submitting [[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]].This mechanism can be the[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]REST interface for[[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]](this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: [[__https:~~/~~/github.com/sdmx-twg/sdmx-rest__>>https://https:github.comsdmx-twgsdmx-rest]]). In order for the architecture to be scalable, the finest-grained piece of[[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]] that can be processed by the[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-RR is a MaintainableArtefact, with the exception of[[Item Schemes>>doc:sdmx:Glossary.Item scheme.WebHome]], where changes at an Item(% style="color:#e74c3c" %)level(%%)is also possible (see next section on the[[SDMX Information Model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]).183 +The registry must support a mechanism for submitting structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: [[__https:~~/~~/github.com/sdmx-twg/sdmx-rest__>>https://https:github.comsdmx-twgsdmx-rest]]). In order for the architecture to be scalable, the finest-grained piece of structural metadata that can be processed by the SDMX-RR is a MaintainableArtefact, with the exception of Item Schemes, where changes at an Item level is also possible (see next section on the SDMX Information Model). 184 184 185 185 === 5.2.3 Structure Query Service === 186 186 187 -The registry must support a mechanism for querying for [[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]].This mechanism can be the[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]REST interface for[[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]](this is defined in the corresponding GitHub project, dedicated to the[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]REST API: [[__https:~~/~~/github.com/sdmx-twg/sdmx-rest__>>https://https:github.comsdmx-twgsdmx-rest]]). The registry response to this query mechanism is the[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]Structure message, which has as its root node:187 +The registry must support a mechanism for querying for structural metadata. This mechanism can be the SDMX REST interface for structural metadata (this is defined in the corresponding GitHub project, dedicated to the SDMX REST API: [[__https:~~/~~/github.com/sdmx-twg/sdmx-rest__>>https://https:github.comsdmx-twgsdmx-rest]]). The registry response to this query mechanism is the SDMX Structure message, which has as its root node: 188 188 189 189 * Structure 190 190 191 -The [[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]structural[[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]that may be queried are defined in the[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]structure web service specification which is compatible with this release of the standard __[[https:~~/~~/github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md>>https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]] __[[https:~~/~~/github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md>>https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]]191 +The SDMX structural artefacts that may be queried are defined in the SDMX structure web service specification which is compatible with this release of the standard __[[https:~~/~~/github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md>>https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]] __[[https:~~/~~/github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md>>https://github.com/sdmx-twg/sdmx-rest/blob/master/doc/structures.md]] 192 192 193 193 === 5.2.4 Data and Reference Metadata Registration Service === 194 194 ... ... @@ -199,36 +199,36 @@ 199 199 * QueryRegistrationRequest 200 200 * QueryRegistrationResponse 201 201 202 -The Data Registration Service allows [[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]] conformant files and web-accessible databases containing published data and[[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]]tobe registered in the[[SDMX Registry>>doc:sdmx:Glossary.SDMXRegistry.WebHome]].The registration process MAY validate the content of the[[datasets>>doc:sdmx:Glossary.Dataset.WebHome]] or metadata-sets, and MAY extract a concise[[representation>>doc:sdmx:Glossary.Representation.WebHome]]of the contents in terms of(% style="color:#e74c3c" %)concept(%%)values (e.g., values of the data[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]],[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]], metadata[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]), or entire keys, and storing this as a record in the registry to enable discovery of the original[[dataset>>doc:sdmx:Glossary.Dataset.WebHome]] or metadata-set. These are called(% style="color:#e74c3c" %)Constraints(%%)in the[[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]].202 +The Data Registration Service allows SDMX conformant files and web-accessible databases containing published data and reference metadata to be registered in the SDMX Registry. The registration process MAY validate the content of the datasets or metadata-sets, and MAY extract a concise representation of the contents in terms of concept values (e.g., values of the data attribute, dimension, metadata attribute), or entire keys, and storing this as a record in the registry to enable discovery of the original dataset or metadata-set. These are called Constraints in the SDMX-IM. 203 203 204 204 The Data Registration Service MAY validate the following, subject to the access control mechanism implemented in the Registry: 205 205 206 -* that the data/metadata provider is allowed to register the [[dataset>>doc:sdmx:Glossary.Dataset.WebHome]] or metadataset;207 -* that the content of the [[dataset>>doc:sdmx:Glossary.Dataset.WebHome]] or metadataset meets the validation(% style="color:#e74c3c" %)constraints(%%). This is dependent upon such(% style="color:#e74c3c" %)constraints(%%)being defined in the structural repository and which reference the relevant[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]],[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]],[[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]], Metadata Provider,[[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]],[[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]],[[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], Metadata[[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]];208 -* that a queryable [[data source>>doc:sdmx:Glossary.Datasource.WebHome]] exists – this would necessitate the registration service querying the service to determine its existence;209 -* that a simple [[data source>>doc:sdmx:Glossary.Datasource.WebHome]] exists (i.e., a file accessible at a URL);210 -* that the correct [[Data Structure Definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]] is used by the registered data;211 -* that the [[components>>doc:sdmx:Glossary.Component.WebHome]]([[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]],[[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]],[[Measures>>doc:sdmx:Glossary.Measure.WebHome]]) are consistent with the[[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]];212 -* that the valid [[representations>>doc:sdmx:Glossary.Representation.WebHome]]of the(% style="color:#e74c3c" %)concepts(%%)to which these[[components>>doc:sdmx:Glossary.Component.WebHome]]correspond conform to the definition in the[[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]].206 +* that the data/metadata provider is allowed to register the dataset or metadataset; 207 +* that the content of the dataset or metadataset meets the validation constraints. This is dependent upon such constraints being defined in the structural repository and which reference the relevant Dataflow, Metadataflow, Data Provider, Metadata Provider, Data Structure Definition, Metadata Structure Definition, Provision Agreement, Metadata Provision Agreement; 208 +* that a queryable data source exists – this would necessitate the registration service querying the service to determine its existence; 209 +* that a simple data source exists (i.e., a file accessible at a URL); 210 +* that the correct Data Structure Definition is used by the registered data; 211 +* that the components (Dimensions, Attributes, Measures) are consistent with the Data Structure Definition; 212 +* that the valid representations of the concepts to which these components correspond conform to the definition in the Data Structure Definition. 213 213 214 -The Registration has an action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]which takes one of the following values:214 +The Registration has an action attribute which takes one of the following values: 215 215 216 216 (% style="width:893.835px" %) 217 -|(% style="width:241px" %)**Action [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]Value**|(% style="width:650px" %)**Behaviour**217 +|(% style="width:241px" %)**Action Attribute Value**|(% style="width:650px" %)**Behaviour** 218 218 |(% style="width:241px" %)Append|(% style="width:650px" %)Add this registration to the registry 219 219 |(% style="width:241px" %)Replace|(% style="width:650px" %)Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request 220 220 |(% style="width:241px" %)Delete|(% style="width:650px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request 221 221 222 -The Registration has three Boolean [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]which may be present to determine how an[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]] compliant[[dataset>>doc:sdmx:Glossary.Dataset.WebHome]] or metadataset indexing application must index the[[datasets>>doc:sdmx:Glossary.Dataset.WebHome]] or metadatasets upon registration. The indexing application behaviour is as follows:222 +The Registration has three Boolean attributes which may be present to determine how an SDMX compliant dataset or metadataset indexing application must index the datasets or metadatasets upon registration. The indexing application behaviour is as follows: 223 223 224 224 (% style="width:896.835px" %) 225 225 |**Boolean Attribute**|(% style="width:712px" %)**Behaviour if Value is “true”** 226 226 |indexTimeSeries|(% style="width:712px" %)A compliant indexing application must index all the time series keys 227 227 |indexDataSet|(% style="width:712px" %)((( 228 -A compliant indexing application must index the range of actual (present) values for each [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]of the[[Dataset>>doc:sdmx:Glossary.Data set.WebHome]].229 -Note that for data this requires much less storage than full key indexing, but this method cannot guarantee that a specific combination of [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]values (the Key) is actually present in the[[Dataset>>doc:sdmx:Glossary.Data set.WebHome]]228 +A compliant indexing application must index the range of actual (present) values for each dimension of the Dataset. 229 +Note that for data this requires much less storage than full key indexing, but this method cannot guarantee that a specific combination of Dimension values (the Key) is actually present in the Dataset 230 230 ))) 231 -|indexReportingPeriod|(% style="width:712px" %)A compliant indexing application must index the [[time period>>doc:sdmx:Glossary.Timeperiod.WebHome]] range(s) for which data are present in the[[Dataset>>doc:sdmx:Glossary.Data set.WebHome]].231 +|indexReportingPeriod|(% style="width:712px" %)A compliant indexing application must index the time period range(s) for which data are present in the Dataset. 232 232 233 233 === 5.2.5 Data Discovery === 234 234 ... ... @@ -239,55 +239,55 @@ 239 239 240 240 === 5.2.6 Subscription and Notification === 241 241 242 -The [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]and[[Notification>>doc:sdmx:Glossary.Notification.WebHome]]Service implements the following Registry Interfaces:242 +The Subscription and Notification Service implements the following Registry Interfaces: 243 243 244 244 * SubmitSubscriptionRequest 245 245 * SubmitSubscriptionResponse 246 246 * NotifyRegistryEvent 247 247 248 -The data sharing paradigm relies upon the consumers of data and metadata being able to pull information from [[data providers>>doc:sdmx:Glossary.Data provider.WebHome]]’ dissemination systems. For this to work efficiently, a[[data consumer>>doc:sdmx:Glossary.Dataconsumer.WebHome]] needs to know when to pull data, i.e., when something has changed in the registry (e.g., a[[dataset>>doc:sdmx:Glossary.Dataset.WebHome]]has been updated and re-registered). Additionally,[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]systems may also want to know if a new[[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]], or[[Code List>>doc:sdmx:Glossary.Codelist.WebHome]]has been added. The[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]and[[Notification>>doc:sdmx:Glossary.Notification.WebHome]]Service comprises two parts:[[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]management, and[[notification>>doc:sdmx:Glossary.Notification.WebHome]].248 +The data sharing paradigm relies upon the consumers of data and metadata being able to pull information from data providers’ dissemination systems. For this to work efficiently, a data consumer needs to know when to pull data, i.e., when something has changed in the registry (e.g., a dataset has been updated and re-registered). Additionally, SDMX systems may also want to know if a new Data Structure Definition, or Code List has been added. The Subscription and Notification Service comprises two parts: subscription management, and notification. 249 249 250 - [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]management involves a user submitting a[[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]request which contains:250 +Subscription management involves a user submitting a subscription request which contains: 251 251 252 -* a query or (% style="color:#e74c3c" %)constraint(%%)expression in terms of a filter which defines the events for which the user is interested (e.g., new data for a specific[[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], or for a domain[[category>>doc:sdmx:Glossary.Category.WebHome]], or changes to a[[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]).253 -* a list of URIs or endpoints to which an XML [[notification>>doc:sdmx:Glossary.Notification.WebHome]]message can be sent. Supported endpoint types will be email (mailto and HTTP POST (a normal http:~/~/ address);254 -* request for a list of submitted [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]];255 -* deletion of a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]];252 +* a query or constraint expression in terms of a filter which defines the events for which the user is interested (e.g., new data for a specific dataflow, or for a domain category, or changes to a Data Structure Definition). 253 +* a list of URIs or endpoints to which an XML notification message can be sent. Supported endpoint types will be email (mailto~:) and HTTP POST (a normal http:~/~/ address); 254 +* request for a list of submitted subscriptions; 255 +* deletion of a subscription; 256 256 257 - [[Notification>>doc:sdmx:Glossary.Notification.WebHome]]requires that the[[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]]repository and the provisioning[[metadata repository>>doc:sdmx:Glossary.Metadatarepository.WebHome]] monitor any event which is of interest to a user (the object of a[[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]request query), and to issue an[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]] [[notification>>doc:sdmx:Glossary.Notification.WebHome]]document to the endpoints specified in the relevant[[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]].257 +Notification requires that the structural metadata repository and the provisioning metadata repository monitor any event which is of interest to a user (the object of a subscription request query), and to issue an SDMX notification document to the endpoints specified in the relevant subscriptions. 258 258 259 259 === 5.2.7 Registry Behaviour === 260 260 261 -The following table defines the behaviour of the [[SDMX Registry>>doc:sdmx:Glossary.SDMXRegistry.WebHome]]for the various Registry Interface messages. It should be noted, though, that as of[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]3.0, an extended versioning scheme newly including semantic versioning is foreseen for all[[Maintainable Artefacts>>doc:sdmx:Glossary.Maintainableartefact.WebHome]].Moreover, while the old versioning scheme is allowed, given there is no more a "final" flag, there is no way guaranteeing the consistency across(% style="color:#e74c3c" %)version(%%)of a Maintainable, unless semantic versioning is used.261 +The following table defines the behaviour of the SDMX Registry for the various Registry Interface messages. It should be noted, though, that as of SDMX 3.0, an extended versioning scheme newly including semantic versioning is foreseen for all Maintainable Artefacts. Moreover, while the old versioning scheme is allowed, given there is no more a "final" flag, there is no way guaranteeing the consistency across version of a Maintainable, unless semantic versioning is used. 262 262 263 -Given the above, the behaviour described in the following table concerns either draft [[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]using semantic versioning or any[[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]using the old versioning scheme. Nevertheless, in the case of semantic versioning the registry must respect the versioning rules when performing the actions below. For example, it is not possible to replace a non-draft[[Artefact>>doc:sdmx:Glossary.Artefact.WebHome]]that follows semantic versioning, unless a newer(% style="color:#e74c3c" %)version(%%)is introduced according to the semantic versioning rules. Furthermore, even when draft[[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]are submitted, the registry has to verify semantic versioning is respected against the previous non-draft(% style="color:#e74c3c" %)versions(%%). It is worth noting that the rules for semantic versioning and replacing or maintaining semantically versioned[[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]applies to externally shared[[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]].This means that any system may internally perform any change within a(% style="color:#e74c3c" %)version(%%)of an[[Artefact>>doc:sdmx:Glossary.Artefact.WebHome]], until the latter is shared outside of that system or becomes public. Then (as also explained in the[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]Standards Section 6 “Technical Notes”) the[[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]must adhere to the Semantic Versioning rules.263 +Given the above, the behaviour described in the following table concerns either draft Artefacts using semantic versioning or any Artefacts using the old versioning scheme. Nevertheless, in the case of semantic versioning the registry must respect the versioning rules when performing the actions below. For example, it is not possible to replace a non-draft Artefact that follows semantic versioning, unless a newer version is introduced according to the semantic versioning rules. Furthermore, even when draft Artefacts are submitted, the registry has to verify semantic versioning is respected against the previous non-draft versions. It is worth noting that the rules for semantic versioning and replacing or maintaining semantically versioned Artefacts applies to externally shared Artefacts. This means that any system may internally perform any change within a version of an Artefact, until the latter is shared outside of that system or becomes public. Then (as also explained in the SDMX Standards Section 6 “Technical Notes”) the Artefacts must adhere to the Semantic Versioning rules. 264 264 265 265 (% style="width:982.835px" %) 266 266 |(% style="width:217px" %)**Interface**|(% style="width:763px" %)**Behaviour** 267 267 |(% style="width:217px" %)All|(% style="width:763px" %)((( 268 -1. If the action is set to “replace” (or a [[maintainable Artefact>>doc:sdmx:Glossary.Maintainableartefact.WebHome]]is PUT or POSTed) then the entire contents of the existing maintainable object in the Registry MUST be replaced by the object submitted.268 +1. If the action is set to “replace” (or a maintainable Artefact is PUT or POSTed) then the entire contents of the existing maintainable object in the Registry MUST be replaced by the object submitted. 269 269 1. Cross referenced structures MUST exist in either the submitted document (in Structures or Structure Location) or in the registry to which the request is submitted. 270 -1. If the action is set to “delete” (or a [[maintainable Artefact>>doc:sdmx:Glossary.Maintainableartefact.WebHome]]is DELETEd) then the Registry MUST verify that the object can be deleted. In order to qualify for deletion, the object must:270 +1. If the action is set to “delete” (or a maintainable Artefact is DELETEd) then the Registry MUST verify that the object can be deleted. In order to qualify for deletion, the object must: 271 271 272 -a) Be a draft (% style="color:#e74c3c" %)version(%%).272 +a) Be a draft version. 273 273 b) Not be explicitly{{footnote}}With semantic versioning, it is allowed to reference a range of artefacts, e.g., a DSD referencing a Codelist with version 1.2.3+ means all patch versions greater than 1.2.3. This means that deleting 1.2.4draft does not break integrity of the aforementioned DSD.{{/footnote}} referenced from any other object in the Registry. 274 274 275 -4) The semantic versioning rules in the [[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]] documentation MUST be obeyed.275 +4) The semantic versioning rules in the SDMX documentation MUST be obeyed. 276 276 ))) 277 277 |(% style="width:217px" %)Structure submission|(% style="width:763px" %)((( 278 -Structures are submitted at the (% style="color:#e74c3c" %)level(%%)of the[[Maintainable Artefact>>doc:sdmx:Glossary.Maintainableartefact.WebHome]] and the behaviour in “All” above is therefore at the(% style="color:#e74c3c" %)level(%%)of the[[Maintainable Artefact>>doc:sdmx:Glossary.Maintainable artefact.WebHome]].278 +Structures are submitted at the level of the Maintainable Artefact and the behaviour in “All” above is therefore at the level of the Maintainable Artefact. 279 279 ))) 280 -|(% style="width:217px" %)SubmitRegistrationRequest|(% style="width:763px" %)If the datasource is a file (simple datasource) then the file MAY be retrieved and indexed according to the Boolean [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]set in the Registration. For a queryable datasource the Registry MAY validate that the source exists and can accept an[[SDMX>>doc:sdmx:Glossary.Statisticaldataand metadata exchange.WebHome]] dataquery.280 +|(% style="width:217px" %)SubmitRegistrationRequest|(% style="width:763px" %)If the datasource is a file (simple datasource) then the file MAY be retrieved and indexed according to the Boolean attributes set in the Registration. For a queryable datasource the Registry MAY validate that the source exists and can accept an SDMX data query. 281 281 282 282 = 6 Identification of SDMX Objects = 283 283 284 284 == 6.1 Identification, Versioning, and Maintenance == 285 285 286 -All major classes of the [[SDMX Information model>>doc:sdmx:Glossary.SDMXInformationModel.WebHome]] inherit from one of:286 +All major classes of the SDMX Information model inherit from one of: 287 287 288 288 * //**IdentifiableArtefact**// – this gives an object the ability to be uniquely identified (see following section on identification), to have a user-defined URI, and to have multi-lingual annotations. 289 289 * //**NameableArtefact**// – this has all of the features of //IdentifiableArtefact// plus the ability to have a multi-lingual name and description. 290 -* //**VersionableArtefact**// – this has all of the above features plus a (% style="color:#e74c3c" %)version(%%)number, according to the[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]versioning rules in[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”, and a validity period.290 +* //**VersionableArtefact**// – this has all of the above features plus a version number, according to the SDMX versioning rules in SDMX Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”, and a validity period. 291 291 * //**MaintainableArtefact**// – this has all of the above features, plus registry and structure URIs, and an association to the maintenance organisation of the object. 292 292 293 293 === 6.1.1 Identification, Naming, Versioning, and Maintenance Model === ... ... @@ -296,7 +296,7 @@ 296 296 297 297 **Figure 5: Class diagram of fundamental artefacts in the SDMX-IM** 298 298 299 -The table below shows the identification and related data [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]to be stored in a registry for objects that are one of:299 +The table below shows the identification and related data attributes to be stored in a registry for objects that are one of: 300 300 301 301 * //Annotable// 302 302 * //Identifiable// ... ... @@ -305,7 +305,7 @@ 305 305 * //Maintainable// 306 306 307 307 (% style="width:1038.83px" %) 308 -|(% colspan="2" %)**Object Type**|(% colspan="2" %)**Data [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]]**|(% colspan="2" %)**Status**|(% colspan="2" %)**Data type**|(% colspan="2" %)**Notes**308 +|(% colspan="2" %)**Object Type**|(% colspan="2" %)**Data Attributes**|(% colspan="2" %)**Status**|(% colspan="2" %)**Data type**|(% colspan="2" %)**Notes** 309 309 |(% colspan="2" rowspan="4" %)//Annotable//|(% colspan="2" %)AnnotationTitle|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %) 310 310 |(% colspan="2" %)AnnotationType|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %) 311 311 |(% colspan="2" %)AnnotationURN|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %) ... ... @@ -330,11 +330,11 @@ 330 330 331 331 //Identifiable// plus 332 332 )))|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %) 333 -|(% colspan="2" %) (% style="color:#e74c3c" %)version|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)This is the(% style="color:#e74c3c" %)version(%%)number according to[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]versioning rules.333 +|(% colspan="2" %)version|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)This is the version number according to SDMX versioning rules. 334 334 |(% colspan="2" %)validFrom|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %) 335 335 |(% colspan="2" %)validTo|(% colspan="2" %)C|(% colspan="2" %)Date/time|(% colspan="2" %) 336 336 |(% colspan="2" %)//Maintainable//|(% colspan="2" %)All content as for //Versionable// plus|(% colspan="2" %) |(% colspan="2" %) |(% colspan="2" %) 337 -|(% colspan="2" %) |(% colspan="2" %) [[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]|(% colspan="2" %)C|(% colspan="2" %)boolean|(% colspan="2" %)Value of “true” indicates that the actual resource is held outside of this registry. The actual reference is given in the registry URI or the structureURL, each of which must return a valid[[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]]file.337 +|(% colspan="2" %) |(% colspan="2" %)isExternalReference|(% colspan="2" %)C|(% colspan="2" %)boolean|(% colspan="2" %)Value of “true” indicates that the actual resource is held outside of this registry. The actual reference is given in the registry URI or the structureURL, each of which must return a valid SDMX-ML file. 338 338 |(% colspan="2" %) |(% colspan="2" %)serviceURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the service that can be queried for this resource. 339 339 |(% colspan="2" %) |(% colspan="2" %)structureURL|(% colspan="2" %)C|(% colspan="2" %)string|(% colspan="2" %)The url of the resource. 340 340 |(% colspan="2" %) |(% colspan="2" %)(Maintenance) organisationId|(% colspan="2" %)M|(% colspan="2" %)string|(% colspan="2" %)The object must be linked to a maintenance organisation, i.e., Agency or Metadata Provider. ... ... @@ -345,24 +345,24 @@ 345 345 346 346 === 6.2.1 Agencies and Metadata Providers === 347 347 348 -The [[Maintenance Agency>>doc:sdmx:Glossary.Maintenanceagency.WebHome]]in[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]is maintained in an[[Agency Scheme>>doc:sdmx:Glossary.Agencyscheme.WebHome]]which itself is a sub class of Organisation Scheme – this is shown in the class diagram below.348 +The Maintenance Agency in SDMX is maintained in an Agency Scheme which itself is a sub class of Organisation Scheme – this is shown in the class diagram below. 349 349 350 350 [[image:SDMX 3.1 Section 5_en_67b3555e.jpg||height="313" width="554"]] 351 351 352 352 **Figure 6: Agency Scheme Model** 353 353 354 -The Agency in [[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]is extremely important. The Agency Id system used in[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]is an nlevel structure. The top(% style="color:#e74c3c" %)level(%%)of this structure is maintained by[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]].Any Agency in this top(% style="color:#e74c3c" %)level(%%)can declare sub agencies and any sub agency can also declare sub agencies. The[[Agency Scheme>>doc:sdmx:Glossary.Agencyscheme.WebHome]] has a fixed id and(% style="color:#e74c3c" %)version(%%)((% style="color:#e74c3c" %)version(%%)‘1.0’) and is never declared explicitly in the[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]] object identification mechanism.354 +The Agency in SDMX is extremely important. The Agency Id system used in SDMX is an nlevel structure. The top level of this structure is maintained by SDMX. Any Agency in this top level can declare sub agencies and any sub agency can also declare sub agencies. The Agency Scheme has a fixed id and version (version ‘1.0’) and is never declared explicitly in the SDMX object identification mechanism. 355 355 356 -In order to achieve this [[SDMX>>doc:sdmx:Glossary.Statisticaldata andmetadata exchange.WebHome]] adopts the following rules:356 +In order to achieve this SDMX adopts the following rules: 357 357 358 -* Agencies are maintained in an [[Agency Scheme>>doc:sdmx:Glossary.Agencyscheme.WebHome]](which is a sub class of Organisation Scheme).359 -* The agency of the [[Agency Scheme>>doc:sdmx:Glossary.Agencyscheme.WebHome]] must also be declared in a (different)[[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]].360 -* The “top- (% style="color:#e74c3c" %)level(%%)” agency is[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]] and maintains the “top-(% style="color:#e74c3c" %)level(%%)”[[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]].361 -* Agencies registered in the top- (% style="color:#e74c3c" %)level(%%)scheme can themselves maintain a single[[Agency Scheme>>doc:sdmx:Glossary.Agencyscheme.WebHome]].Agencies in these second-tier schemes can themselves maintain a single[[Agency Scheme>>doc:sdmx:Glossary.Agencyscheme.WebHome]]and so on.362 -* The AgencyScheme has a fixed (% style="color:#e74c3c" %)version(%%), i.e., ‘1.0’, hence it is an exception from the Semantic Versioning that other[[Artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]follow.358 +* Agencies are maintained in an Agency Scheme (which is a sub class of Organisation Scheme). 359 +* The agency of the Agency Scheme must also be declared in a (different) Agency Scheme. 360 +* The “top-level” agency is SDMX and maintains the “top-level” Agency Scheme. 361 +* 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. 362 +* The AgencyScheme has a fixed version, i.e., ‘1.0’, hence it is an exception from the Semantic Versioning that other Artefacts follow. 363 363 * There can be only one AgencyScheme maintained by any one Agency. It has a fixed id of AGENCIES. 364 -* The / [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]of Organisation is not inherited by[[Maintenance Agency>>doc:sdmx:Glossary.Maintenanceagency.WebHome]]– thus each[[Agency Scheme>>doc:sdmx:Glossary.Agencyscheme.WebHome]]is a flat list of[[Maintenance Agencies>>doc:sdmx:Glossary.Maintenance agency.WebHome]].365 -* The format of the agency identifier is agencyID.agencyID etc. The top- (% style="color:#e74c3c" %)level(%%)agency in this identification mechanism is the agency registered in the[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]] [[agency scheme>>doc:sdmx:Glossary.Agencyscheme.WebHome]].In other words,[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]is not a part of the hierarchical ID structure for agencies. However,[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]is, itself, a[[maintenance agency>>doc:sdmx:Glossary.Maintenanceagency.WebHome]] and is contained in the top-(% style="color:#e74c3c" %)level(%%)[[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]].364 +* The /hierarchy of Organisation is not inherited by Maintenance Agency – thus each Agency Scheme is a flat list of Maintenance Agencies. 365 +* The format of the agency identifier is agencyID.agencyID etc. The top-level agency in this identification mechanism is the agency registered in the SDMX agency scheme. In other words, SDMX is not a part of the hierarchical ID structure for agencies. However, SDMX is, itself, a maintenance agency and is contained in the top-level Agency Scheme. 366 366 367 367 This supports a hierarchical structure of agencyID. 368 368 ... ... @@ -372,14 +372,14 @@ 372 372 373 373 **Figure 7: Example of Hierarchic Structure of Agencies** 374 374 375 -The following organizations maintain an [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]].375 +The following organizations maintain an Agency Scheme. 376 376 377 -* [[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]– contains Agencies AA, BB377 +* SDMX – contains Agencies AA, BB 378 378 * AA – contains Agencies CC, DD 379 379 * BB – contains Agencies CC, DD 380 380 * DD – Contains Agency EE 381 381 382 -Each agency is identified by its full [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]excluding[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]].382 +Each agency is identified by its full hierarchy excluding SDMX. 383 383 384 384 e.g., the id of EE as an agencyID is AA.DD.EE 385 385 ... ... @@ -387,27 +387,27 @@ 387 387 388 388 **Figure 8: Example Showing Use of Agency Identifiers** 389 389 390 -Each of these [[maintenance agencies>>doc:sdmx:Glossary.Maintenanceagency.WebHome]]has an identical[[Code list>>doc:sdmx:Glossary.Codelist.WebHome]]with the Id CL_BOP. However, each is uniquely identified by means of the hierarchic agency structure.390 +Each of these maintenance agencies has an identical Code list with the Id CL_BOP. However, each is uniquely identified by means of the hierarchic agency structure. 391 391 392 -Following the same principles, the Metadata Provider is the maintenance organisation for a special subset of [[Maintainable Artefacts>>doc:sdmx:Glossary.Maintainable artefact.WebHome]], i.e., the Metadatasets; the latter are the containers of[[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]]combined with a target that those metadata refer to.392 +Following the same principles, the Metadata Provider is the maintenance organisation for a special subset of Maintainable Artefacts, i.e., the Metadatasets; the latter are the containers of reference metadata combined with a target that those metadata refer to. 393 393 394 394 === 6.2.2 Universal Resource Name (URN) === 395 395 396 396 ==== 6.2.2.1 Introduction ==== 397 397 398 -To provide interoperability between [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]]/Repositories in a distributed network environment, it is important to have a scheme for uniquely identifying (and thus accessing) all first-class (Identifiable)[[SDMX-IM>>doc:sdmx:Glossary.SDMXInformation Model.WebHome]] objects. Most of these unique identifiers are composite (containing[[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]], or parent object identifiers), and there is a need to be able to construct a unique reference as a single string. This is achieved by having a globally unique identifier called a universal resource name (URN) which is generated from the actual identification[[components>>doc:sdmx:Glossary.Component.WebHome]]in the[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-RR APIs. In other words, the URN for any[[Identifiable Artefact>>doc:sdmx:Glossary.Identifiableartefact.WebHome]]is constructed from its[[component>>doc:sdmx:Glossary.Component.WebHome]]identifiers (agency, id,(% style="color:#e74c3c" %)version(%%)etc.).398 +To provide interoperability between SDMX Registry/Repositories in a distributed network environment, it is important to have a scheme for uniquely identifying (and thus accessing) all first-class (Identifiable) SDMX-IM objects. Most of these unique identifiers are composite (containing maintenance agency, or parent object identifiers), and there is a need to be able to construct a unique reference as a single string. This is achieved by having a globally unique identifier called a universal resource name (URN) which is generated from the actual identification components in the SDMX-RR APIs. In other words, the URN for any Identifiable Artefact is constructed from its component identifiers (agency, id, version etc.). 399 399 400 400 ==== 6.2.2.2 URN Structure //__Case Rules for URN__// ==== 401 401 402 402 For the URN, all parts of the string are case sensitive. The generic structure of the URN is as follows: 403 403 404 -SDMXprefix. [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]-package-name.class-name=agencyid:maintainedobjectid(maintainedobject-(% style="color:#e74c3c" %)version(%%)).*containerobject-id.object-id404 +SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobjectid(maintainedobject-version).*containerobject-id.object-id 405 405 406 406 ~* this can repeat and may not be present (see explanation below) 407 407 408 -Note that in the [[SDMX Information Model>>doc:sdmx:Glossary.SDMXInformation Model.WebHome]] there are no concrete[[Versionable Artefacts>>doc:sdmx:Glossary.Versionableartefact.WebHome]] that are not a[[Maintainable Artefact>>doc:sdmx:Glossary.Maintainableartefact.WebHome]].For this reason, the only(% style="color:#e74c3c" %)version(%%)information that is allowed is for the maintainable object.408 +Note that in the SDMX Information Model there are no concrete Versionable Artefacts that are not a Maintainable Artefact. For this reason, the only version information that is allowed is for the maintainable object. 409 409 410 -The [[Maintenance agency>>doc:sdmx:Glossary.Maintenanceagency.WebHome]]identifier is separated from the[[maintainable artefact>>doc:sdmx:Glossary.Maintainableartefact.WebHome]]identifier by a colon ‘:’. All other identifiers in the[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]URN syntax are separated by a period ‘.’. The(% style="color:#e74c3c" %)version(%%)information is encapsulated in parentheses ‘()’ and adheres to the[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]versioning rules, as explained in[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning.410 +The Maintenance agency identifier is separated from the maintainable artefact identifier by a colon ‘:’. All other identifiers in the SDMX URN syntax are separated by a period ‘.’. The version information is encapsulated in parentheses ‘()’ and adheres to the SDMX versioning rules, as explained in SDMX Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning. 411 411 412 412 ==== 6.2.2.3 Explanation of the generic structure ==== 413 413 ... ... @@ -423,13 +423,13 @@ 423 423 424 424 **maintainable-object-id** is the identifier of the maintainable object. This will always be present as all identifiable objects are either a maintainable object or contained in a maintainable object. 425 425 426 -**maintainable-object-version** is the (% style="color:#e74c3c" %)version(%%), according to the[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]versioning rules, of the maintainable object and is enclosed in parentheses ‘()’, which are always present.426 +**maintainable-object-version** is the version, according to the SDMX versioning rules, of the maintainable object and is enclosed in parentheses ‘()’, which are always present. 427 427 428 -**container-object-id** is the identifier of an intermediary object that contains the actual object which the URN is identifying. It is not mandatory as many actual objects do not have an intermediary container object. For instance, a [[Code>>doc:sdmx:Glossary.Code.WebHome]]is in a maintained object (Codelist) and has no intermediary container object, whereas a MetadataAttribute has an intermediary container object (MetadataAttributeDescriptor) and may have an intermediary container object, which is its parent MetadataAttribute. For this reason, the container object id may repeat, with each repetition identifying the object at the next-lower(% style="color:#e74c3c" %)level(%%)in its[[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]].Note that if there is only a single containing object in the model then it is NOT included in the URN structure. This applies to AttributeDescriptor, DimensionDescriptor, and MeasureDescriptor where there can be only one such object and this object has a fixed id. Therefore, whilst each of these has a URN, the id of the AttributeDescriptor, DimensionDescriptor, and MeasureDescriptor is not included when the actual object is a DataAttribute or a[[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]/ TimeDimension, or a Measure.428 +**container-object-id** is the identifier of an intermediary object that contains the actual object which the URN is identifying. It is not mandatory as many actual objects do not have an intermediary container object. For instance, a Code is in a maintained object (Codelist) and has no intermediary container object, whereas a MetadataAttribute has an intermediary container object (MetadataAttributeDescriptor) and may have an intermediary container object, which is its parent MetadataAttribute. For this reason, the container object id may repeat, with each repetition identifying the object at the next-lower level in its hierarchy. Note that if there is only a single containing object in the model then it is NOT included in the URN structure. This applies to AttributeDescriptor, DimensionDescriptor, and MeasureDescriptor where there can be only one such object and this object has a fixed id. Therefore, whilst each of these has a URN, the id of the AttributeDescriptor, DimensionDescriptor, and MeasureDescriptor is not included when the actual object is a DataAttribute or a Dimension/ TimeDimension, or a Measure. 429 429 430 -Note that although a [[Code>>doc:sdmx:Glossary.Code.WebHome]]can have a parent[[Code>>doc:sdmx:Glossary.Code.WebHome]]and a(% style="color:#e74c3c" %)Concept(%%)can have a parent(% style="color:#e74c3c" %)Concept(%%)these are maintained in a flat structure and therefore do not have a containerobject-id.430 +Note that although a Code can have a parent Code and a Concept can have a parent Concept these are maintained in a flat structure and therefore do not have a containerobject-id. 431 431 432 -For example, the sequence is agency:DSDid( (% style="color:#e74c3c" %)version(%%)).DimensionId and not agency:DSDid((% style="color:#e74c3c" %)version(%%)).DimensionDescriptorId.DimensionId.432 +For example, the sequence is agency:DSDid(version).DimensionId and not agency:DSDid(version).DimensionDescriptorId.DimensionId. 433 433 434 434 object-id is the identifier of the actual object unless the actual object is a //Maintainable// object. If present it is always the last id and is not followed by any other character. 435 435 ... ... @@ -437,60 +437,60 @@ 437 437 438 438 __Actual object is a maintainable__ 439 439 440 -SDMXPrefix. [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid((% style="color:#e74c3c" %)version(%%))440 +SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version) 441 441 442 442 __Actual object is contained in a maintained object with no intermediate containing object__ 443 443 444 -SDMXPrefix. [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid((% style="color:#e74c3c" %)version(%%)).object-id444 +SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version).object-id 445 445 446 446 __Actual object is contained in a maintained object with an intermediate containing object__ 447 447 448 -SDMXPrefix. [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid((% style="color:#e74c3c" %)version(%%)).contained-object-id.object-id448 +SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version).contained-object-id.object-id 449 449 450 450 __Actual object is contained in a maintained object with no intermediate containing__ __object but__ __the object type itself is hierarchical__ 451 451 452 -In this case the object id may not be unique in itself but only within the context of the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]].In the general syntax of the URN all intermediary objects in the structure (with the exception, of course, of the maintained object) are shown as a contained object. An example here would be a[[Category>>doc:sdmx:Glossary.Category.WebHome]]in a CategoryScheme. The[[Category>>doc:sdmx:Glossary.Category.WebHome]]is hierarchical, and all intermediate[[Categories>>doc:sdmx:Glossary.Category.WebHome]]are shown as a contained object. The example below shows the generic structure for CategoryScheme/[[Category>>doc:sdmx:Glossary.Category.WebHome]]/[[Category>>doc:sdmx:Glossary.Category.WebHome]].452 +In this case the object id may not be unique in itself but only within the context of the hierarchy. In the general syntax of the URN all intermediary objects in the structure (with the exception, of course, of the maintained object) are shown as a contained object. An example here would be a Category in a CategoryScheme. The Category is hierarchical, and all intermediate Categories are shown as a contained object. The example below shows the generic structure for CategoryScheme/ Category/ Category. 453 453 454 -SDMXPrefix. [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid((% style="color:#e74c3c" %)version(%%)).contained-object-id.object-id454 +SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version).contained-object-id.object-id 455 455 456 456 Actual object is contained in a maintained object with an intermediate containing object and the object type itself is hierarchical 457 457 458 -In this case the generic syntax is the same as for the example above as the parent object is regarded as a containing object, even if it is of the same type. An example here is a MetadataAttribute where the contained objects are MetadataAttributeDescriptor (first contained object id) and MetadataAttribute (subsequent contained object ids). The example below shows the generic structure for [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]/ MetadataAttributeDescriptor/ MetadataAttribute/ MetadataAttribute458 +In this case the generic syntax is the same as for the example above as the parent object is regarded as a containing object, even if it is of the same type. An example here is a MetadataAttribute where the contained objects are MetadataAttributeDescriptor (first contained object id) and MetadataAttribute (subsequent contained object ids). The example below shows the generic structure for MSD/ MetadataAttributeDescriptor/ MetadataAttribute/ MetadataAttribute 459 459 460 -SDMXPrefix. [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid((% style="color:#e74c3c" %)version(%%)).contained-object-id.contained-object-id contained-objectid.object-id460 +SDMXPrefix.SDMX-IM-package-name.classname=agencyid:maintained-objectid(version).contained-object-id.contained-object-id contained-objectid.object-id 461 461 462 462 //__**Concrete Examples of the URN Structure**__// 463 463 464 -The [[Data Structure Definition>>doc:sdmx:Glossary.Datastructure definition.WebHome]]CRED_EXT_DEBT of legacy(% style="color:#e74c3c" %)version(%%)2.1 maintained by the toplevel Agency TFFS would have the URN:464 +The Data Structure Definition CRED_EXT_DEBT of legacy version 2.1 maintained by the toplevel Agency TFFS would have the URN: 465 465 466 466 urn:sdmx:org.sdmx.infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(2.1) 467 467 468 -The URN for a [[code>>doc:sdmx:Glossary.Code.WebHome]]for Argentina maintained by ISO in the[[code list>>doc:sdmx:Glossary.Codelist.WebHome]]CL_3166A2 of semantic(% style="color:#e74c3c" %)version(%%)1.0.0 would be:468 +The URN for a code for Argentina maintained by ISO in the code list CL_3166A2 of semantic version 1.0.0 would be: 469 469 470 470 urn:sdmx:org.sdmx.infomodel.codelist.Code=ISO:CL_3166A2(1.0.0).AR 471 471 472 -The URN for a [[category>>doc:sdmx:Glossary.Category.WebHome]](id of 1) which has parent[[category>>doc:sdmx:Glossary.Category.WebHome]](id of 2) maintained by[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]in the[[category scheme>>doc:sdmx:Glossary.Categoryscheme.WebHome]]SUBJECT_MATTER_DOMAINS of the semantic extended(% style="color:#e74c3c" %)version(%%)1.0.0draft would be:472 +The URN for a category (id of 1) which has parent category (id of 2) maintained by SDMX in the category scheme SUBJECT_MATTER_DOMAINS of the semantic extended version 1.0.0draft would be: 473 473 474 474 urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:SUBJECT_MATT ER_DOMAINS(1.0.0-draft).1.2 475 475 476 -The URN for a Metadata [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]maintained by[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]in the[[MSD>>doc:sdmx:Glossary.Metadatastructure definition.WebHome]]CONTACT_METADATA of semantic(% style="color:#e74c3c" %)version(%%)1.0.0 where the[[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]of the Metadata[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]is CONTACT_DETAILS/CONTACT_NAME would be:476 +The URN for a Metadata Attribute maintained by SDMX in the MSD CONTACT_METADATA of semantic version 1.0.0 where the hierarchy of the Metadata Attribute is CONTACT_DETAILS/CONTACT_NAME would be: 477 477 478 478 urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataAttribute=SDMX: CONTACT_METADATA(1.0.0).CONTACT_DETAILS.CONTACT_NAME 479 479 480 -The TFFS defines ABC as a sub-Agency of TFFS then the URN of a [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]maintained by ABC and identified as EXTERNAL_DEBT of semantic(% style="color:#e74c3c" %)version(%%)1.0.0 would be:480 +The TFFS defines ABC as a sub-Agency of TFFS then the URN of a Dataflow maintained by ABC and identified as EXTERNAL_DEBT of semantic version 1.0.0 would be: 481 481 482 -urn:sdmx:org.sdmx.infomodel.datastructure. [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]=TFFS.ABC:EXTERNAL_ DEBT(1.0.0)482 +urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=TFFS.ABC:EXTERNAL_ DEBT(1.0.0) 483 483 484 -The [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-RR MUST support this globally unique identification scheme. The[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-RR MUST be able to create the URN from the individual identification[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]submitted and to transform the URN to these identification[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]].The identification[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]are:484 +The SDMX-RR MUST support this globally unique identification scheme. The SDMX-RR MUST be able to create the URN from the individual identification attributes submitted and to transform the URN to these identification attributes. The identification attributes are: 485 485 486 -* **Identifiable and [[Nameable Artefacts>>doc:sdmx:Glossary.Nameable artefact.WebHome]]**: id (in some cases this id may be hierarchic)487 -* ** [[Maintainable Artefacts>>doc:sdmx:Glossary.Maintainable artefact.WebHome]]**: id,(% style="color:#e74c3c" %)version(%%), agencyId486 +* **Identifiable and Nameable Artefacts**: id (in some cases this id may be hierarchic) 487 +* **Maintainable Artefacts**: id, version, agencyId 488 488 489 -The [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-RR MUST be able to resolve the unique identifier of an[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]] [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]]and to produce an[[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]]rendering of that[[artefact>>doc:sdmx:Glossary.Artefact.WebHome]]if it is located in the Registry.489 +The SDMX-RR MUST be able to resolve the unique identifier of an SDMX artefact and to produce an SDMX-ML rendering of that artefact if it is located in the Registry. 490 490 491 491 === 6.2.3 Table of SDMX-IM Packages and Classes === 492 492 493 -The table below lists all of the packages in the [[SDMX-IM>>doc:sdmx:Glossary.SDMXInformation Model.WebHome]] together with the concrete classes that are in these packages and whose objects have a URN.493 +The table below lists all of the packages in the SDMX-IM together with the concrete classes that are in these packages and whose objects have a URN. 494 494 495 495 (% style="width:750.835px" %) 496 496 |(% style="width:222px" %)**Package**|(% style="width:526px" %)**URN class name (model class name where this is different)** ... ... @@ -507,9 +507,9 @@ 507 507 |(% style="width:222px" %) |(% style="width:526px" %) 508 508 |(% style="width:222px" %)datastructure|(% style="width:526px" %)AttributeDescriptor 509 509 |(% style="width:222px" %) |(% style="width:526px" %)DataAttribute 510 -|(% style="width:222px" %) |(% style="width:526px" %) [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]510 +|(% style="width:222px" %) |(% style="width:526px" %)Dataflow 511 511 |(% style="width:222px" %) |(% style="width:526px" %)DataStructure (DataStructureDefinition) 512 -|(% style="width:222px" %) |(% style="width:526px" %) [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]512 +|(% style="width:222px" %) |(% style="width:526px" %)Dimension 513 513 |(% style="width:222px" %) |(% style="width:526px" %)DimensionDescriptor 514 514 |(% style="width:222px" %) |(% style="width:526px" %)GroupDimensionDescriptor 515 515 |(% style="width:222px" %) |(% style="width:526px" %)Measure ... ... @@ -527,7 +527,7 @@ 527 527 ((( 528 528 (% style="width:751.835px" %) 529 529 |(% style="width:221px" %)**Package**|(% style="width:528px" %)**URN class name (model class name where this is different)** 530 -|(% style="width:221px" %) |(% style="width:528px" %) [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]530 +|(% style="width:221px" %) |(% style="width:528px" %)Metadataflow 531 531 |(% style="width:221px" %) |(% style="width:528px" %)MetadataSet 532 532 |(% style="width:221px" %) |(% style="width:528px" %) 533 533 |(% style="width:221px" %)process|(% style="width:528px" %)Process ... ... @@ -538,7 +538,7 @@ 538 538 |(% style="width:221px" %) |(% style="width:528px" %)MetadataConstraint 539 539 |(% style="width:221px" %) |(% style="width:528px" %)MetadataProvisionAgreement 540 540 |(% style="width:221px" %) |(% style="width:528px" %)ProvisionAgreement 541 -|(% style="width:221px" %) |(% style="width:528px" %) [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]541 +|(% style="width:221px" %) |(% style="width:528px" %)Subscription 542 542 |(% style="width:221px" %) |(% style="width:528px" %) 543 543 |(% style="width:221px" %)structuremapping|(% style="width:528px" %)CategorySchemeMap 544 544 |(% style="width:221px" %) |(% style="width:528px" %)ConceptSchemeMap ... ... @@ -547,22 +547,22 @@ 547 547 |(% style="width:221px" %) |(% style="width:528px" %)RepresentationMap 548 548 |(% style="width:221px" %) |(% style="width:528px" %)StructureMap 549 549 |(% style="width:221px" %) |(% style="width:528px" %) 550 -|(% style="width:221px" %)codelist|(% style="width:528px" %) [[Code>>doc:sdmx:Glossary.Code.WebHome]]550 +|(% style="width:221px" %)codelist|(% style="width:528px" %)Code 551 551 |(% style="width:221px" %) |(% style="width:528px" %)Codelist 552 552 |(% style="width:221px" %) |(% style="width:528px" %)HierarchicalCode 553 -|(% style="width:221px" %) |(% style="width:528px" %) [[Hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]553 +|(% style="width:221px" %) |(% style="width:528px" %)Hierarchy 554 554 |(% style="width:221px" %) |(% style="width:528px" %)HierarchyAssociation 555 -|(% style="width:221px" %) |(% style="width:528px" %) (% style="color:#e74c3c" %)Level555 +|(% style="width:221px" %) |(% style="width:528px" %)Level 556 556 |(% style="width:221px" %) |(% style="width:528px" %)ValueList 557 557 |(% style="width:221px" %) |(% style="width:528px" %) 558 558 |(% style="width:221px" %)categoryscheme|(% style="width:528px" %)Categorisation 559 -|(% style="width:221px" %) |(% style="width:528px" %) [[Category>>doc:sdmx:Glossary.Category.WebHome]]559 +|(% style="width:221px" %) |(% style="width:528px" %)Category 560 560 |(% style="width:221px" %) |(% style="width:528px" %)CategoryScheme 561 561 |(% style="width:221px" %) |(% style="width:528px" %)ReportingCategory 562 562 |(% style="width:221px" %) |(% style="width:528px" %)ReportingTaxonomy 563 563 |(% style="width:221px" %)**Package**|(% style="width:528px" %)**URN class name (model class name where this is different)** 564 564 |(% style="width:221px" %) |(% style="width:528px" %) 565 -|(% style="width:221px" %)conceptscheme|(% style="width:528px" %) (% style="color:#e74c3c" %)Concept565 +|(% style="width:221px" %)conceptscheme|(% style="width:528px" %)Concept 566 566 |(% style="width:221px" %) |(% style="width:528px" %)ConceptScheme 567 567 |(% style="width:221px" %) |(% style="width:528px" %) 568 568 |(% style="width:221px" %)transformation|(% style="width:528px" %)CustomType ... ... @@ -586,36 +586,36 @@ 586 586 587 587 === 6.2.4 URN Identification components of SDMX objects === 588 588 589 -The table below describes the identification [[components>>doc:sdmx:Glossary.Component.WebHome]]for all[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]] object types that have identification. Note the actual[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]are all ‘id’ but have been prefixed by their class name or multiple class names to show navigation, e.g., ‘conceptSchemeAgencyId’ is really the ‘Id’[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]]of the Agency class that is associated to the ConceptScheme.589 +The table below describes the identification components for all SDMX object types that have identification. Note the actual attributes are all ‘id’ but have been prefixed by their class name or multiple class names to show navigation, e.g., ‘conceptSchemeAgencyId’ is really the ‘Id’ attribute of the Agency class that is associated to the ConceptScheme. 590 590 591 591 Note that for brevity the URN examples omit the prefix (classnames in italics indicate maintainable objects, keywords in bold indicate fixed value) All URNs have the prefix: 592 592 593 -urn: [[sdmx>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]].org.[[sdmx>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]].infomodel.{package}.{classname}=593 +urn:sdmx.org.sdmx.infomodel.{package}.{classname}= 594 594 595 595 (% style="width:1272.83px" %) 596 596 |(% style="width:289px" %)**Classname**|(% style="width:600px" %)**Ending URN pattern**|(% style="width:383px" %)**Example** 597 597 |(% style="width:289px" %)Agency{{footnote}}The object must be linked to a maintenance organisation, i.e., Agency or Metadata Provider.{{/footnote}}|(% style="width:600px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**).agencyId|(% style="width:383px" %)ECB:**AGENCIES**(**1.0**).AA 598 598 |(% style="width:289px" %)//AgencyScheme//|(% style="width:600px" %)agencySchemeAgencyId:**AGENCIES**(**1.0**)|(% style="width:383px" %)ECB:**AGENCIES**(**1.0**) 599 -|(% style="width:289px" %)//Categorisation//|(% style="width:600px" %)categorisationAgencyId:categoris (% style="color:#000000" %)ationId(version)|(% style="width:383px" %)IMF:cat001(1.0.0)600 -|(% style="width:289px" %) [[Category>>doc:sdmx:Glossary.Category.WebHome]]|(% style="width:600px" %)categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|(% style="width:383px" %)IMF:SDDS(1.0.0):level_1_category.level_2_category …599 +|(% style="width:289px" %)//Categorisation//|(% style="width:600px" %)categorisationAgencyId:categorisationId(version)|(% style="width:383px" %)IMF:cat001(1.0.0) 600 +|(% style="width:289px" %)Category|(% style="width:600px" %)categorySchemeAgencyId:categorySchemeId(versi on).categoryId.categoryId.categoryId etc.|(% style="width:383px" %)IMF:SDDS(1.0.0):level_1_category.level_2_category … 601 601 |(% style="width:289px" %)//CategoryScheme//|(% style="width:600px" %)categorySchemeAgencyId:categorySchemeId(versi on)|(% style="width:383px" %)IMF:SDDS(1.0.0) 602 602 603 603 |(% style="width:292px" %)**Classname**|(% style="width:595px" %)**Ending URN pattern**|(% style="width:794px" %)**Example** 604 604 |(% style="width:292px" %)//CategorySchemeMap//|(% style="width:595px" %)((( 605 - (% style="color:#000000" %)catSchemeMapAgencyId:catSchemeMapId(version)605 +catSchemeMapAgencyId:catSchemeMapId(version) 606 606 )))|(% style="width:794px" %)SDMX:EUROSTAT_SUBJECT_DOMAIN(1.0.0) 607 -|(% style="width:292px" %) [[Code>>doc:sdmx:Glossary.Code.WebHome]]|(% style="width:595px" %)(% style="color:#000000" %)codeListAgencyId:codelistId(version).codeId|(% style="width:794px" %)SDMX:CL_FREQ(1.0.0).Q608 -|(% style="width:292px" %)//Codelist//|(% style="width:595px" %) (% style="color:#000000" %)codeListAgencyId:codeListId(version)|(% style="width:794px" %)SDMX:CL_FREQ(1.0.0)609 -|(% style="width:292px" %)ComponentMap|(% style="width:595px" %) (%style="color:#000000" %)structureMapAgencyId:structureMap(version).com ponentMapId|(% style="width:794px" %)SDMX:BOP_STRUCTURES(1.0.0).REF_AREA_TO_COUNT RY610 -|(% style="width:292px" %) (% style="color:#e74c3c" %)Concept|(% style="width:595px" %)(% style="color:#000000" %)conceptSchemeAgencyId:conceptSchemeId(versio n).conceptId|(% style="width:794px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0).FREQ611 -|(% style="width:292px" %)//ConceptScheme//|(% style="width:595px" %) (% style="color:#000000" %)conceptSchemeAgencyId:conceptSchemeId(versio n)|(% style="width:794px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0)607 +|(% style="width:292px" %)Code|(% style="width:595px" %)codeListAgencyId:codelistId(version).codeId|(% style="width:794px" %)SDMX:CL_FREQ(1.0.0).Q 608 +|(% style="width:292px" %)//Codelist//|(% style="width:595px" %)codeListAgencyId:codeListId(version)|(% style="width:794px" %)SDMX:CL_FREQ(1.0.0) 609 +|(% style="width:292px" %)ComponentMap|(% style="width:595px" %)structureMapAgencyId:structureMap(version).com ponentMapId|(% style="width:794px" %)SDMX:BOP_STRUCTURES(1.0.0).REF_AREA_TO_COUNT RY 610 +|(% style="width:292px" %)Concept|(% style="width:595px" %)conceptSchemeAgencyId:conceptSchemeId(versio n).conceptId|(% style="width:794px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0).FREQ 611 +|(% style="width:292px" %)//ConceptScheme//|(% style="width:595px" %)conceptSchemeAgencyId:conceptSchemeId(versio n)|(% style="width:794px" %)SDMX:CROSS_DOMAIN_CONCEPTS(1.0.0) 612 612 |(% style="width:292px" %)//ConceptSchemeMap//|(% style="width:595px" %)((( 613 - (% style="color:#000000" %)conceptSchemeMapAgencyId:conceptSchemeMap Id(version)613 +conceptSchemeMapAgencyId:conceptSchemeMap Id(version) 614 614 )))|(% style="width:794px" %)SDMX:CONCEPT_MAP(1.0.0) 615 -|(% style="width:292px" %)CustomType|(% style="width:595px" %) (% style="color:#000000" %)customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|(% style="width:794px" %)ECB: CUSTOM_TYPE_SCHEME(1.0.0).CUSTOM_TYPE_1616 -|(% style="width:292px" %)//CustomTypeScheme//|(% style="width:595px" %) (% style="color:#000000" %)customTypeSchemeAgencyId customTypeSchemeId(version)|(% style="width:794px" %)ECB:CUSTOM_TYPE_SCHEME(1.0.0)617 -|(% style="width:292px" %)DataAttrribute|(% style="width:595px" %) (% style="color:#000000" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dataAttributeId|(% style="width:794px" %)TFFS:EXT_DEBT(1.0.0).OBS_STATUS618 -|(% style="width:292px" %)//DataConstraint//|(% style="width:595px" %) (% style="color:#000000" %)dataConstraintAgencyId:dataConstraintId(version)|(% style="width:794px" %)TFFS:CREDITOR_DATA_CONTENT(1.0.0)615 +|(% style="width:292px" %)CustomType|(% style="width:595px" %)customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|(% style="width:794px" %)ECB: CUSTOM_TYPE_SCHEME(1.0.0).CUSTOM_TYPE_1 616 +|(% style="width:292px" %)//CustomTypeScheme//|(% style="width:595px" %)customTypeSchemeAgencyId customTypeSchemeId(version)|(% style="width:794px" %)ECB:CUSTOM_TYPE_SCHEME(1.0.0) 617 +|(% style="width:292px" %)DataAttrribute|(% style="width:595px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dataAttributeId|(% style="width:794px" %)TFFS:EXT_DEBT(1.0.0).OBS_STATUS 618 +|(% style="width:292px" %)//DataConstraint//|(% style="width:595px" %)dataConstraintAgencyId:dataConstraintId(version)|(% style="width:794px" %)TFFS:CREDITOR_DATA_CONTENT(1.0.0) 619 619 620 620 |(% style="width:294px" %)**Classname**|(% style="width:645px" %)**Ending URN pattern**|(% style="width:742px" %)**Example** 621 621 |(% style="width:294px" %)DataConsumer|(% style="width:645px" %)dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**).dataConsumerId|(% style="width:742px" %)SDMX:**DATA_CONSUMERS**(**1.0**).CONSUMER_1 ... ... @@ -622,15 +622,15 @@ 622 622 |(% style="width:294px" %)//DataConsumerScheme//|(% style="width:645px" %)((( 623 623 dataConsumerSchemeAgencyId:**DATA_CONSUME RS**(**1.0**) 624 624 )))|(% style="width:742px" %)SDMX:**DATA_CONSUMERS**(**1.0**) 625 -|(% style="width:294px" %)// [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]//|(% style="width:645px" %)(% style="color:#000000" %)dataflowAgencyId:dataflowId(version)|(% style="width:742px" %)TFFS:CRED_EXT_DEBT(1.0.0)625 +|(% style="width:294px" %)//Dataflow//|(% style="width:645px" %)dataflowAgencyId:dataflowId(version)|(% style="width:742px" %)TFFS:CRED_EXT_DEBT(1.0.0) 626 626 |(% style="width:294px" %)DataProvider|(% style="width:645px" %)((( 627 - (% style="color:#000000" %)dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**).dataProviderId627 +dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**).dataProviderId 628 628 )))|(% style="width:742px" %)SDMX:**DATA_PROVIDERS**(**1.0**).PROVIDER_1 629 629 |(% style="width:294px" %)//DataProviderScheme//|(% style="width:645px" %)((( 630 - (% style="color:#000000" %)dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**)630 +dataProviderSchemeAgencyId:**DATA_PROVIDERS**(**1.0**) 631 631 )))|(% style="width:742px" %)SDMX:**DATA_PROVIDERS**(**1.0**) 632 -|(% style="width:294px" %)//DataStructure//|(% style="width:645px" %) (% style="color:#000000" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version)|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0)633 -|(% style="width:294px" %) [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]|(% style="width:645px" %)(% style="color:#000000" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dimensionId|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0).FREQ632 +|(% style="width:294px" %)//DataStructure//|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version)|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0) 633 +|(% style="width:294px" %)Dimension|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).dimensionId|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0).FREQ 634 634 |(% style="width:294px" %)((( 635 635 DimensionDescriptor 636 636 ... ... @@ -638,9 +638,9 @@ 638 638 639 639 AttributeDescriptor 640 640 )))|(% style="width:645px" %)((( 641 -dataStructureDefinitionAgencyId:dataStructureDef initionId( (% style="color:#000000" %)version)(%%).componentListId641 +dataStructureDefinitionAgencyId:dataStructureDef initionId(version).componentListId 642 642 643 -where the componentListId is the name of the class (there is only one occurrence of each in the [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]])643 +where the componentListId is the name of the class (there is only one occurrence of each in the Data Structure Definition) 644 644 )))|(% style="width:742px" %)((( 645 645 TFFS:EXT_DEBT(1.0.0).DimensionDescriptor 646 646 ... ... @@ -648,73 +648,73 @@ 648 648 649 649 TFFS:EXT_DEBT(1.0.0).AttributeDescriptor 650 650 ))) 651 -|(% style="width:294px" %)GroupDimensionDescriptor|(% style="width:645px" %) (% style="color:#000000" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).groupDimensionDescriptorId|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0).SIBLING652 -|(% style="width:294px" %)HierarchicalCode|(% style="width:645px" %) (% style="color:#000000" %)hierarchyAgencyId:hierarchyId(version).hierarchica lCode.hierarchicalCode|(% style="width:742px" %)UNESCO:H-C-GOV(1.0.0).GOV_CODE1.GOV_CODE1_1651 +|(% style="width:294px" %)GroupDimensionDescriptor|(% style="width:645px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).groupDimensionDescriptorId|(% style="width:742px" %)TFFS:EXT_DEBT(1.0.0).SIBLING 652 +|(% style="width:294px" %)HierarchicalCode|(% style="width:645px" %)hierarchyAgencyId:hierarchyId(version).hierarchica lCode.hierarchicalCode|(% style="width:742px" %)UNESCO:H-C-GOV(1.0.0).GOV_CODE1.GOV_CODE1_1 653 653 654 654 |**Classname**|(% style="width:644px" %)**Ending URN pattern**|(% style="width:743px" %)**Example** 655 -|// [[Hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]//|(% style="width:644px" %)(% style="color:#000000" %)hierarchyAgencyId:hierarchyId(version)|(% style="width:743px" %)UNESCO:H-C-GOV(1.0.0)656 -|//HierarchyAssociation//|(% style="width:644px" %) (% style="color:#000000" %)hierarchyAssociationAgencyId:hierarchyAssociatio nId(version)|(% style="width:743px" %)UNESCO:CL_EXP_SOURCE(1.0.0)657 -| (%%)(% style="color:#e74c3c" %)Level|(% style="width:644px" %)(% style="color:#000000" %)hierarchyAgencyId:hierarchyId(version).level|(% style="width:743px" %)UNESCO:H-C-GOV(1.0.0).LVL1658 -|Measure|(% style="width:644px" %) (% style="color:#000000" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).measureId|(% style="width:743px" %)TFFS:EXT_DEBT(1.0.0).OBS_VALUE655 +|//Hierarchy//|(% style="width:644px" %)hierarchyAgencyId:hierarchyId(version)|(% style="width:743px" %)UNESCO:H-C-GOV(1.0.0) 656 +|//HierarchyAssociation//|(% style="width:644px" %)hierarchyAssociationAgencyId:hierarchyAssociatio nId(version)|(% style="width:743px" %)UNESCO:CL_EXP_SOURCE(1.0.0) 657 +|Level|(% style="width:644px" %)hierarchyAgencyId:hierarchyId(version).level|(% style="width:743px" %)UNESCO:H-C-GOV(1.0.0).LVL1 658 +|Measure|(% style="width:644px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).measureId|(% style="width:743px" %)TFFS:EXT_DEBT(1.0.0).OBS_VALUE 659 659 |MetadataAttribute|(% style="width:644px" %)((( 660 - (% style="color:#000000" %)msdAgencyId:msdId(version).metadataAttributeId.660 +msdAgencyId:msdId(version).metadataAttributeId. 661 661 662 - (% style="color:#000000" %)metadataAttributeId662 +metadataAttributeId 663 663 )))|(% style="width:743px" %)IMF:SDDS_MSD(1.0.0).COMPILATION.METHOD 664 -|MetadataAttributeDescriptor|(% style="width:644px" %) (% style="color:#000000" %)msdAgencyId:msdId(version).metadataAttributeDe scriptorId|(% style="width:743px" %)IMF:SDDS_MSD(1.0.0).MetadataAttributeDescriptor665 -|//MetadataConstraint//|(% style="width:644px" %) (% style="color:#000000" %)metadataConstraintAgencyId:metadataConstraintI d(version)|(% style="width:743px" %)TFFS:CREDITOR_METADATA_CONTENT(1.0.0)666 -|// [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]//|(% style="width:644px" %)(% style="color:#000000" %)metadataflowAgencyId:metadataflowId(version)|(% style="width:743px" %)IMF:SDDS_MDF(1.0.0)667 -|MetadataProvider|(% style="width:644px" %) (% style="color:#000000" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**).metadataProviderId|(% style="width:743px" %)SDMX:**METADATA_PROVIDERS**(**1.0**).MD_PROVIDER_1668 -|//MetadataProviderScheme//|(% style="width:644px" %) (% style="color:#000000" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**)|(% style="width:743px" %)SDMX:**METADATA_PROVIDERS**(**1.0**)669 -|//MetadataProvisionAgreement//|(% style="width:644px" %) (% style="color:#000000" %)metadataProvisionAgreementAgencyId:metadataP rovisionAgreementId(version)|(% style="width:743px" %)IMF:SDDS_MDF_AB(1.0.0)670 -|//MetadataSet//|(% style="width:644px" %) (% style="color:#000000" %)metadataProviderId:metadataSetId(version)|(% style="width:743px" %)MD_PROVIDER:METADATASET(1.0.0)671 -|//MetadataStructure//|(% style="width:644px" %) (% style="color:#000000" %)msdAgencyId:msdId(version)|(% style="width:743px" %)IMF:SDDS_MSD(1.0.0)664 +|MetadataAttributeDescriptor|(% style="width:644px" %)msdAgencyId:msdId(version).metadataAttributeDe scriptorId|(% style="width:743px" %)IMF:SDDS_MSD(1.0.0).MetadataAttributeDescriptor 665 +|//MetadataConstraint//|(% style="width:644px" %)metadataConstraintAgencyId:metadataConstraintI d(version)|(% style="width:743px" %)TFFS:CREDITOR_METADATA_CONTENT(1.0.0) 666 +|//Metadataflow//|(% style="width:644px" %)metadataflowAgencyId:metadataflowId(version)|(% style="width:743px" %)IMF:SDDS_MDF(1.0.0) 667 +|MetadataProvider|(% style="width:644px" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**).metadataProviderId|(% style="width:743px" %)SDMX:**METADATA_PROVIDERS**(**1.0**).MD_PROVIDER_1 668 +|//MetadataProviderScheme//|(% style="width:644px" %)metadataProviderSchemeAgencyId:**METADATA_P ROVIDERS**(**1.0**)|(% style="width:743px" %)SDMX:**METADATA_PROVIDERS**(**1.0**) 669 +|//MetadataProvisionAgreement//|(% style="width:644px" %)metadataProvisionAgreementAgencyId:metadataP rovisionAgreementId(version)|(% style="width:743px" %)IMF:SDDS_MDF_AB(1.0.0) 670 +|//MetadataSet//|(% style="width:644px" %)metadataProviderId:metadataSetId(version)|(% style="width:743px" %)MD_PROVIDER:METADATASET(1.0.0) 671 +|//MetadataStructure//|(% style="width:644px" %)msdAgencyId:msdId(version)|(% style="width:743px" %)IMF:SDDS_MSD(1.0.0) 672 672 673 673 |(% style="width:296px" %)**Classname**|(% style="width:646px" %)**Ending URN pattern**|(% style="width:739px" %)**Example** 674 -|(% style="width:296px" %)NamePersonalisation|(% style="width:646px" %) (% style="color:#000000" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|(% style="width:739px" %)ECB:PSN_SCHEME(1.0.0).PSN1234675 -|(% style="width:296px" %)//NamePersonalisationScheme//|(% style="width:646px" %) (% style="color:#000000" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|(% style="width:739px" %)ECB:PSN_SCHEME(1.0.0)676 -|(% style="width:296px" %)//OrganisationSchemeMap//|(% style="width:646px" %) (% style="color:#000000" %)orgSchemeMapAgencyId:orgSchemeMapId(versio n)|(% style="width:739px" %)SDMX:AGENCIES_PROVIDERS(1.0.0)677 -|(% style="width:296px" %)OrganisationUnit|(% style="width:646px" %) (% style="color:#000000" %)organisationUnitSchemeAgencyId:organisationUni tSchemeId(version).organisationUnitId|(% style="width:739px" %)ECB:ORGANISATIONS(1.0.0).1F678 -|(% style="width:296px" %)//OrganisationUnitScheme//|(% style="width:646px" %) (% style="color:#000000" %)organisationUnitSchemeAgencyId:organisationUni tSchemeId(version)|(% style="width:739px" %)ECB:ORGANISATIONS(1.0.0)679 -|(% style="width:296px" %)//Process//|(% style="width:646px" %) (% style="color:#000000" %)processAgencyId:processId{version)|(% style="width:739px" %)BIS:PROCESS1(1.0.0)674 +|(% style="width:296px" %)NamePersonalisation|(% style="width:646px" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|(% style="width:739px" %)ECB:PSN_SCHEME(1.0.0).PSN1234 675 +|(% style="width:296px" %)//NamePersonalisationScheme//|(% style="width:646px" %)namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|(% style="width:739px" %)ECB:PSN_SCHEME(1.0.0) 676 +|(% style="width:296px" %)//OrganisationSchemeMap//|(% style="width:646px" %)orgSchemeMapAgencyId:orgSchemeMapId(versio n)|(% style="width:739px" %)SDMX:AGENCIES_PROVIDERS(1.0.0) 677 +|(% style="width:296px" %)OrganisationUnit|(% style="width:646px" %)organisationUnitSchemeAgencyId:organisationUni tSchemeId(version).organisationUnitId|(% style="width:739px" %)ECB:ORGANISATIONS(1.0.0).1F 678 +|(% style="width:296px" %)//OrganisationUnitScheme//|(% style="width:646px" %)organisationUnitSchemeAgencyId:organisationUni tSchemeId(version)|(% style="width:739px" %)ECB:ORGANISATIONS(1.0.0) 679 +|(% style="width:296px" %)//Process//|(% style="width:646px" %)processAgencyId:processId{version)|(% style="width:739px" %)BIS:PROCESS1(1.0.0) 680 680 |(% style="width:296px" %)ProcessStep|(% style="width:646px" %)((( 681 - (% style="color:#000000" %)processAgencyId:processId(version).processStepId.681 +processAgencyId:processId(version).processStepId. 682 682 683 - (% style="color:#000000" %)processStepId683 +processStepId 684 684 )))|(% style="width:739px" %)BIS:PROCESS1(1.0.0).STEP1.STEP1_1 685 -|(% style="width:296px" %)//ProvisionAgreement//|(% style="width:646px" %) (% style="color:#000000" %)provisionAgreementAgencyId:provisionAgreement Id(version)|(% style="width:739px" %)TFFS:CRED_EXT_DEBT_AB(1.0.0)685 +|(% style="width:296px" %)//ProvisionAgreement//|(% style="width:646px" %)provisionAgreementAgencyId:provisionAgreement Id(version)|(% style="width:739px" %)TFFS:CRED_EXT_DEBT_AB(1.0.0) 686 686 |(% style="width:296px" %)ReportingCategory|(% style="width:646px" %)((( 687 - (% style="color:#000000" %)reportingTaxonomyAgencyId:687 +reportingTaxonomyAgencyId: 688 688 689 - (% style="color:#000000" %)reportingTaxonomyId(version).reportingCategoryI d.reportingCategoryId689 +reportingTaxonomyId(version).reportingCategoryI d.reportingCategoryId 690 690 )))|(% style="width:739px" %)IMF:REP_1(1.0.0):LVL1_REP_CAT.LVL2_REP_CAT 691 -|(% style="width:296px" %)//ReportingTaxonomy//|(% style="width:646px" %) (% style="color:#000000" %)reportingTaxonomyAgencyId:reportingTaxonomyI d(version)|(% style="width:739px" %)IMF:REP_1(1.0.0)692 -|(% style="width:296px" %)//ReportingTaxonomyMap//|(% style="width:646px" %)repTaxonomyAgencyId:repTaxonomyId( (% style="color:#e74c3c" %)version(%%))|(% style="width:739px" %)[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:RT_MAP(1.0.0)691 +|(% style="width:296px" %)//ReportingTaxonomy//|(% style="width:646px" %)reportingTaxonomyAgencyId:reportingTaxonomyI d(version)|(% style="width:739px" %)IMF:REP_1(1.0.0) 692 +|(% style="width:296px" %)//ReportingTaxonomyMap//|(% style="width:646px" %)repTaxonomyAgencyId:repTaxonomyId(version)|(% style="width:739px" %)SDMX:RT_MAP(1.0.0) 693 693 694 694 |(% style="width:297px" %)**Classname**|(% style="width:647px" %)**Ending URN pattern**|(% style="width:737px" %)**Example** 695 -|(% style="width:297px" %)//RepresentationMap//|(% style="width:647px" %)repMapAgencyId:repMapId( (% style="color:#e74c3c" %)version(%%))|(% style="width:737px" %)[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:REF_AREA_MAPPING(1.0.0)696 -|(% style="width:297px" %)Ruleset|(% style="width:647px" %)rulesetSchemeAgencyId rulesetSchemeId( (% style="color:#e74c3c" %)version(%%))rulesetId|(% style="width:737px" %)ECB:RULESET_23(1.0.0).SET111697 -|(% style="width:297px" %)//RulesetScheme//|(% style="width:647px" %)rulesetSchemeAgencyId rulesetSchemeId( (% style="color:#e74c3c" %)version(%%))|(% style="width:737px" %)ECB:RULESET_23(1.0.0)698 -|(% style="width:297px" %)//StructureMap//|(% style="width:647px" %)structureMapAgencyId:structureMap( (% style="color:#e74c3c" %)version(%%))|(% style="width:737px" %)[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:BOP_STRUCTURES(1.0.0)699 -|(% style="width:297px" %) [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]|(% style="width:647px" %)(((700 -The [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]is not itself an[[Identifiable Artefact>>doc:sdmx:Glossary.Identifiableartefact.WebHome]] and therefore it does not follow the rules for URN structure.695 +|(% style="width:297px" %)//RepresentationMap//|(% style="width:647px" %)repMapAgencyId:repMapId(version)|(% style="width:737px" %)SDMX:REF_AREA_MAPPING(1.0.0) 696 +|(% style="width:297px" %)Ruleset|(% style="width:647px" %)rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|(% style="width:737px" %)ECB:RULESET_23(1.0.0).SET111 697 +|(% style="width:297px" %)//RulesetScheme//|(% style="width:647px" %)rulesetSchemeAgencyId rulesetSchemeId(version)|(% style="width:737px" %)ECB:RULESET_23(1.0.0) 698 +|(% style="width:297px" %)//StructureMap//|(% style="width:647px" %)structureMapAgencyId:structureMap(version)|(% style="width:737px" %)SDMX:BOP_STRUCTURES(1.0.0) 699 +|(% style="width:297px" %)Subscription|(% style="width:647px" %)((( 700 +The Subscription is not itself an Identifiable Artefact and therefore it does not follow the rules for URN structure. 701 701 The name of the URN is registryURN There is no pre-determined format. 702 -)))|(% style="width:737px" %)This cannot be generated by a common mechanism as [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]], although maintainable in the sense that they can be submitted and deleted, are not mandated to be created by a[[maintenance agency>>doc:sdmx:Glossary.Maintenanceagency.WebHome]] and have no versioning mechanism. It is therefore the responsibility of the target registry to generate a unique Id for the[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]], and for the application creating the[[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]to store the registry URN that is returned from the registry in the[[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]response message.703 -|(% style="width:297px" %)TimeDimension|(% style="width:647px" %) (% style="color:#000000" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).timeDimensionId|(% style="width:737px" %)TFFS:EXT_DEBT(1.0.0).TIME_PERIOD704 -|(% style="width:297px" %)Transformation|(% style="width:647px" %) (% style="color:#000000" %)transformationSchemeAgencyId transformationSchemeId(version) transformationId|(% style="width:737px" %)ECB:TRANSFORMATION_SCHEME(1.0.0).TRANS_1705 -|(% style="width:297px" %)//TransformationScheme//|(% style="width:647px" %) (% style="color:#000000" %)transformationSchemeAgencyId transformationSchemeId(version)|(% style="width:737px" %)ECB: TRANSFORMATION_SCHEME(1.0.0)702 +)))|(% style="width:737px" %)This cannot be generated by a common mechanism as subscriptions, although maintainable in the sense that they can be submitted and deleted, are not mandated to be created by a maintenance agency and have no versioning mechanism. It is therefore the responsibility of the target registry to generate a unique Id for the Subscription, and for the application creating the subscription to store the registry URN that is returned from the registry in the subscription response message. 703 +|(% style="width:297px" %)TimeDimension|(% style="width:647px" %)dataStructureDefinitionAgencyId:dataStructureDef initionId(version).timeDimensionId|(% style="width:737px" %)TFFS:EXT_DEBT(1.0.0).TIME_PERIOD 704 +|(% style="width:297px" %)Transformation|(% style="width:647px" %)transformationSchemeAgencyId transformationSchemeId(version) transformationId|(% style="width:737px" %)ECB:TRANSFORMATION_SCHEME(1.0.0).TRANS_1 705 +|(% style="width:297px" %)//TransformationScheme//|(% style="width:647px" %)transformationSchemeAgencyId transformationSchemeId(version)|(% style="width:737px" %)ECB: TRANSFORMATION_SCHEME(1.0.0) 706 706 |(% style="width:297px" %)**Classname**|(% style="width:647px" %)**Ending URN pattern**|(% style="width:737px" %)**Example** 707 707 |(% style="width:297px" %)Transition|(% style="width:647px" %)((( 708 - (% style="color:#000000" %)processAgencyId:processId(version).processStepId.708 +processAgencyId:processId(version).processStepId. 709 709 transitionId 710 710 )))|(% style="width:737px" %)BIS:PROCESS1(1.0.0).STEP1.TRANSITION1 711 -|(% style="width:297px" %)UserDefinedOperator|(% style="width:647px" %) (% style="color:#000000" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|(% style="width:737px" %)ECB:OS_CALC(1.2.0).OS267712 -|(% style="width:297px" %)//UserDefinedOperatorScheme//|(% style="width:647px" %) (% style="color:#000000" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|(% style="width:737px" %)ECB:OS_CALC(1.2.0)713 -|(% style="width:297px" %)//ValueList//|(% style="width:647px" %) (% style="color:#000000" %)valuelistAgencyId:valuelistId(version)|(% style="width:737px" %)[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:VLIST(1.0.0)714 -|(% style="width:297px" %)VtlCodelistMapping|(% style="width:647px" %) (% style="color:#000000" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|(% style="width:737px" %)ECB:CLIST_MP(2.0.0).ABZ715 -|(% style="width:297px" %)VtlConceptMapping|(% style="width:647px" %) (% style="color:#000000" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|(% style="width:737px" %)ECB:CLIST_MP(1.0.0).XYA716 -|(% style="width:297px" %)VtlDataflowMapping|(% style="width:647px" %) (% style="color:#000000" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|(% style="width:737px" %)ECB:CLIST_MP(1.0.0).MOQ717 -|(% style="width:297px" %)//VtlMappingScheme//|(% style="width:647px" %) (% style="color:#000000" %)vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|(% style="width:737px" %)ECB:CLIST_MP(2.0.0)711 +|(% style="width:297px" %)UserDefinedOperator|(% style="width:647px" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|(% style="width:737px" %)ECB:OS_CALC(1.2.0).OS267 712 +|(% style="width:297px" %)//UserDefinedOperatorScheme//|(% style="width:647px" %)userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|(% style="width:737px" %)ECB:OS_CALC(1.2.0) 713 +|(% style="width:297px" %)//ValueList//|(% style="width:647px" %)valuelistAgencyId:valuelistId(version)|(% style="width:737px" %)SDMX:VLIST(1.0.0) 714 +|(% style="width:297px" %)VtlCodelistMapping|(% style="width:647px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|(% style="width:737px" %)ECB:CLIST_MP(2.0.0).ABZ 715 +|(% style="width:297px" %)VtlConceptMapping|(% style="width:647px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|(% style="width:737px" %)ECB:CLIST_MP(1.0.0).XYA 716 +|(% style="width:297px" %)VtlDataflowMapping|(% style="width:647px" %)vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlDataflowMappingId|(% style="width:737px" %)ECB:CLIST_MP(1.0.0).MOQ 717 +|(% style="width:297px" %)//VtlMappingScheme//|(% style="width:647px" %)vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|(% style="width:737px" %)ECB:CLIST_MP(2.0.0) 718 718 719 719 **Table 3: Table of identification components for SDMX Identifiable Artefacts** 720 720 ... ... @@ -724,88 +724,90 @@ 724 724 725 725 === 7.1.1 Introduction === 726 726 727 -The [[SDMX Registry>>doc:sdmx:Glossary.SDMXRegistry.WebHome]] must have the ability to support agencies in their role of defining and disseminating[[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]] [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]].These[[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]include[[data structure definitions>>doc:sdmx:Glossary.Data structure definition.WebHome]],[[code lists>>doc:sdmx:Glossary.Code list.WebHome]],(% style="color:#e74c3c" %)concepts(%%)etc. and are fully defined in the[[SDMX-IM>>doc:sdmx:Glossary.SDMXInformation Model.WebHome]].An authenticated agency may submit valid[[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]] definitions which must be stored in the registry. Note that the term “[[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]]” refers as a general term to all structural[[components>>doc:sdmx:Glossary.Component.WebHome]]([[Data Structure Definitions>>doc:sdmx:Glossary.Data structure definition.WebHome]],[[Metadata Structure Definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]],[[Code Lists>>doc:sdmx:Glossary.Code list.WebHome]],[[Concept Schemes>>doc:sdmx:Glossary.Concept scheme.WebHome]], etc.)727 +The SDMX Registry must have the ability to support agencies in their role of defining and disseminating structural metadata artefacts. These artefacts include data structure definitions, code lists, concepts etc. and are fully defined in the SDMX-IM. An authenticated agency may submit valid structural metadata definitions which must be stored in the registry. Note that the term “structural metadata” refers as a general term to all structural components (Data Structure Definitions, Metadata Structure Definitions, Code Lists, Concept Schemes, etc.) 728 728 729 -At a minimum, [[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]] definitions may be submitted to and queried from the registry via an HTTP/HTTPS POST in the form of one of the[[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]]messages for[[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]] and the[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]RESTful API for structure queries. The message may contain all[[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]]items for the whole registry,[[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]]items for one[[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]], or individual[[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]]items.729 +At a minimum, structural metadata definitions may be submitted to and queried from the registry via an HTTP/HTTPS POST in the form of one of the SDMX-ML messages for structural metadata and the SDMX RESTful API for structure queries. The message may contain all structural metadata items for the whole registry, structural metadata items for one maintenance agency, or individual structural metadata items. 730 730 731 - [[Structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]]items731 +Structural metadata items 732 732 733 -* may only be modified by the [[maintenance agency>>doc:sdmx:Glossary.Maintenanceagency.WebHome]]which created them;733 +* may only be modified by the maintenance agency which created them; 734 734 * may only be deleted by the agency which created them; 735 735 * may not be deleted if they are referenced from other constructs in the Registry. 736 736 737 -The (% style="color:#e74c3c" %)level(%%)of granularity for the maintenance of[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]] [[Structural Metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]] objects in the registry is the[[Maintainable Artefact>>doc:sdmx:Glossary.Maintainableartefact.WebHome]].Especially for[[Item Schemes>>doc:sdmx:Glossary.Item scheme.WebHome]], though, partial maintenance may be performed, i.e., at the(% style="color:#e74c3c" %)level(%%)of the Item, by submitting an[[Item Scheme>>doc:sdmx:Glossary.Itemscheme.WebHome]]with the 'isPartial' flag set and a reduced set of Items.737 +The level of granularity for the maintenance of SDMX Structural Metadata objects in the registry is the Maintainable Artefact. Especially for Item Schemes, though, partial maintenance may be performed, i.e., at the level of the Item, by submitting an Item Scheme with the 'isPartial' flag set and a reduced set of Items. 738 738 739 -The following table lists the [[Maintainable Artefacts>>doc:sdmx:Glossary.Maintainable artefact.WebHome]].739 +The following table lists the Maintainable Artefacts. 740 740 741 741 (% style="width:825.835px" %) 742 742 |(% colspan="2" style="width:455px" %)**Maintainable Artefacts**|(% style="width:367px" %)**Content** 743 743 |(% style="width:160px" %)**Abstract Class**|(% style="width:295px" %)**Concrete Class**|(% style="width:367px" %) 744 -|(% style="width:160px" %) [[Item Scheme>>doc:sdmx:Glossary.Item scheme.WebHome]]|(% style="width:295px" %)Codelist|(% style="width:367px" %)[[Code>>doc:sdmx:Glossary.Code.WebHome]]745 -|(% style="width:160px" %) |(% style="width:295px" %) [[Concept Scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]]|(% style="width:367px" %)(% style="color:#e74c3c" %)Concept746 -|(% style="width:160px" %) |(% style="width:295px" %) [[Category Scheme>>doc:sdmx:Glossary.Category scheme.WebHome]]|(% style="width:367px" %)[[Category>>doc:sdmx:Glossary.Category.WebHome]]747 -|(% style="width:160px" %) |(% style="width:295px" %) [[Organisation Unit Scheme>>doc:sdmx:Glossary.Organisation unit scheme.WebHome]]|(% style="width:367px" %)Organisation Unit748 -|(% style="width:160px" %) |(% style="width:295px" %) [[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]]|(% style="width:367px" %)Agency749 -|(% style="width:160px" %) |(% style="width:295px" %) [[Data Provider Scheme>>doc:sdmx:Glossary.Data provider scheme.WebHome]]|(% style="width:367px" %)[[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]]744 +|(% style="width:160px" %)Item Scheme|(% style="width:295px" %)Codelist|(% style="width:367px" %)Code 745 +|(% style="width:160px" %) |(% style="width:295px" %)Concept Scheme|(% style="width:367px" %)Concept 746 +|(% style="width:160px" %) |(% style="width:295px" %)Category Scheme|(% style="width:367px" %)Category 747 +|(% style="width:160px" %) |(% style="width:295px" %)Organisation Unit Scheme|(% style="width:367px" %)Organisation Unit 748 +|(% style="width:160px" %) |(% style="width:295px" %)Agency Scheme|(% style="width:367px" %)Agency 749 +|(% style="width:160px" %) |(% style="width:295px" %)Data Provider Scheme|(% style="width:367px" %)Data Provider 750 750 |(% style="width:160px" %) |(% style="width:295px" %)Metadata Provider Scheme|(% style="width:367px" %)Metadata Provider 751 -|(% style="width:160px" %) |(% style="width:295px" %) [[Data Consumer Scheme>>doc:sdmx:Glossary.Data consumer scheme.WebHome]]|(% style="width:367px" %)[[Data Consumer>>doc:sdmx:Glossary.Data consumer.WebHome]]752 -|(% style="width:160px" %) |(% style="width:295px" %)Reporting Taxonomy|(% style="width:367px" %)Reporting [[Category>>doc:sdmx:Glossary.Category.WebHome]]751 +|(% style="width:160px" %) |(% style="width:295px" %)Data Consumer Scheme|(% style="width:367px" %)Data Consumer 752 +|(% style="width:160px" %) |(% style="width:295px" %)Reporting Taxonomy|(% style="width:367px" %)Reporting Category 753 753 |(% style="width:160px" %) |(% style="width:295px" %)Transformation Scheme|(% style="width:367px" %)Transformation 754 754 |(% style="width:160px" %) |(% style="width:295px" %)Custom Type Scheme|(% style="width:367px" %)Custom Type 755 755 |(% style="width:160px" %) |(% style="width:295px" %)Name Personalisation Scheme|(% style="width:367px" %)Name Personalisation 756 -|(% style="width:160px" %) |(% style="width:295px" %) [[Vtl>>doc:sdmx:Glossary.Validationand transformation language.WebHome]]Mapping Scheme|(% style="width:367px" %)[[Vtl>>doc:sdmx:Glossary.Validationand transformation language.WebHome]]Codelist Mapping[[Vtl>>doc:sdmx:Glossary.Validationand transformation language.WebHome]] (% style="color:#e74c3c" %)Concept(%%)Mapping756 +|(% style="width:160px" %) |(% style="width:295px" %)Vtl Mapping Scheme|(% style="width:367px" %)Vtl Codelist Mapping Vtl Concept Mapping 757 757 |(% style="width:160px" %) |(% style="width:295px" %)Ruleset Scheme|(% style="width:367px" %)Ruleset 758 758 |(% style="width:160px" %) |(% style="width:295px" %)User Defined Operator Scheme|(% style="width:367px" %)User Defined Operator 759 759 |(% style="width:160px" %)Enumerated List|(% style="width:295px" %)ValueList|(% style="width:367px" %)Value Item 760 -|(% style="width:160px" %)Structure|(% style="width:295px" %) [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]|(% style="width:367px" %)(((761 - [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]Descriptor762 -Group [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]Descriptor763 - [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]764 -Time [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]]765 - [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]Descriptor766 -Data [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]760 +|(% style="width:160px" %)Structure|(% style="width:295px" %)Data Structure Definition|(% style="width:367px" %)((( 761 +Dimension Descriptor 762 +Group Dimension Descriptor 763 +Dimension 764 +Time Dimension 765 +Attribute Descriptor 766 +Data Attribute 767 767 Measure Descriptor 768 768 Measure 769 769 ))) 770 -|(% style="width:160px" %) |(% style="width:295px" %) [[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]|(% style="width:367px" %)Metadata[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]Descriptor Metadata[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]]771 -|(% style="width:160px" %)Structure Usage|(% style="width:295px" %) [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]|(% style="width:367px" %)772 -|(% style="width:160px" %) |(% style="width:295px" %) [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]|(% style="width:367px" %)770 +|(% style="width:160px" %) |(% style="width:295px" %)Metadata Structure Definition|(% style="width:367px" %)Metadata Attribute Descriptor Metadata Attribute 771 +|(% style="width:160px" %)Structure Usage|(% style="width:295px" %)Dataflow|(% style="width:367px" %) 772 +|(% style="width:160px" %) |(% style="width:295px" %)Metadataflow|(% style="width:367px" %) 773 773 |(% style="width:160px" %)None|(% style="width:295px" %)Process|(% style="width:367px" %)Process Step 774 -|(% style="width:160px" %)None|(% style="width:295px" %)Structure (% style="color:#e74c3c" %)Map|(% style="width:367px" %)((( 775 -[[Component>>doc:sdmx:Glossary.Component.WebHome]] (% style="color:#e74c3c" %)Map(%%) 776 -Epoch (% style="color:#e74c3c" %)Map(%%) 777 -Date Pattern (% style="color:#e74c3c" %)Map 774 +|(% style="width:160px" %)None|(% style="width:295px" %)Structure Map|(% style="width:367px" %)((( 775 +Component Map 776 + 777 +Epoch Map 778 + 779 +Date Pattern Map 778 778 ))) 779 -|(% style="width:160px" %)None|(% style="width:295px" %) [[Representation>>doc:sdmx:Glossary.Representation.WebHome]](% style="color:#e74c3c" %)Map|(% style="width:367px" %)[[Representation>>doc:sdmx:Glossary.Representation.WebHome]]Mapping780 -|(% style="width:160px" %) [[Item Scheme>>doc:sdmx:Glossary.Itemscheme.WebHome]] (% style="color:#e74c3c" %)Map|(% style="width:295px" %)Organisation Scheme(% style="color:#e74c3c" %)Map|(% style="width:367px" %)Item(% style="color:#e74c3c" %)Map781 -|(% style="width:160px" %) |(% style="width:295px" %) [[Concept Scheme>>doc:sdmx:Glossary.Conceptscheme.WebHome]] (% style="color:#e74c3c" %)Map|(% style="width:367px" %)Item(% style="color:#e74c3c" %)Map782 -|(% style="width:160px" %) |(% style="width:295px" %) [[Category Scheme>>doc:sdmx:Glossary.Categoryscheme.WebHome]] (% style="color:#e74c3c" %)Map|(% style="width:367px" %)Item(% style="color:#e74c3c" %)Map783 -|(% style="width:160px" %) |(% style="width:295px" %)Reporting Taxonomy (% style="color:#e74c3c" %)Map|(% style="width:367px" %)Item(% style="color:#e74c3c" %)Map784 -|(% style="width:160px" %)None|(% style="width:295px" %) [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]]|(% style="width:367px" %)785 -|(% style="width:160px" %)None|(% style="width:295px" %)Metadata [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]]|(% style="width:367px" %)786 -|(% style="width:160px" %)None|(% style="width:295px" %) [[Hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]|(% style="width:367px" %)Hierarchical[[Code>>doc:sdmx:Glossary.Code.WebHome]]787 -|(% style="width:160px" %)None|(% style="width:295px" %) [[Hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]Association|(% style="width:367px" %)781 +|(% style="width:160px" %)None|(% style="width:295px" %)Representation Map|(% style="width:367px" %)Representation Mapping 782 +|(% style="width:160px" %)Item Scheme Map|(% style="width:295px" %)Organisation Scheme Map|(% style="width:367px" %)Item Map 783 +|(% style="width:160px" %) |(% style="width:295px" %)Concept Scheme Map|(% style="width:367px" %)Item Map 784 +|(% style="width:160px" %) |(% style="width:295px" %)Category Scheme Map|(% style="width:367px" %)Item Map 785 +|(% style="width:160px" %) |(% style="width:295px" %)Reporting Taxonomy Map|(% style="width:367px" %)Item Map 786 +|(% style="width:160px" %)None|(% style="width:295px" %)Provision Agreement|(% style="width:367px" %) 787 +|(% style="width:160px" %)None|(% style="width:295px" %)Metadata Provision Agreement|(% style="width:367px" %) 788 +|(% style="width:160px" %)None|(% style="width:295px" %)Hierarchy|(% style="width:367px" %)Hierarchical Code 789 +|(% style="width:160px" %)None|(% style="width:295px" %)Hierarchy Association|(% style="width:367px" %) 788 788 |(% style="width:160px" %)None|(% style="width:295px" %)Categorisation|(% style="width:367px" %) 789 -|(% style="width:160px" %) (% style="color:#e74c3c" %)Constraint|(% style="width:295px" %)Data(% style="color:#e74c3c" %)Constraint|(% style="width:367px" %)DataKeySet791 +|(% style="width:160px" %)Constraint|(% style="width:295px" %)Data Constraint|(% style="width:367px" %)DataKeySet 790 790 |(% style="width:160px" %) |(% style="width:295px" %) |(% style="width:367px" %)CubeRegion 791 -|(% style="width:160px" %) (% style="color:#e74c3c" %)Constraint|(% style="width:295px" %)Metadata(% style="color:#e74c3c" %)Constraint|(% style="width:367px" %)MetadataTargetRegion793 +|(% style="width:160px" %)Constraint|(% style="width:295px" %)Metadata Constraint|(% style="width:367px" %)MetadataTargetRegion 792 792 793 793 **Table 4: Table of Maintainable Artefacts for Structural Definition Metadata** 794 794 795 795 === 7.1.2 Item Scheme, Structure === 796 796 797 -The [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]included in the structural definitions are:799 +The artefacts included in the structural definitions are: 798 798 799 -* All types of [[Item Scheme>>doc:sdmx:Glossary.Itemscheme.WebHome]](Codelist,[[Concept Scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]],[[Category Scheme>>doc:sdmx:Glossary.Category scheme.WebHome]], Organisation Scheme,[[Agency Scheme>>doc:sdmx:Glossary.Agency scheme.WebHome]],[[Data Provider Scheme>>doc:sdmx:Glossary.Data provider scheme.WebHome]], Metadata Provider Scheme,[[Data Consumer Scheme>>doc:sdmx:Glossary.Data consumer scheme.WebHome]],[[Organisation Unit Scheme>>doc:sdmx:Glossary.Organisation unit scheme.WebHome]], Transformation Scheme, Name Personalisation Scheme, Custom Type Scheme,[[Vtl>>doc:sdmx:Glossary.Validationand transformation language.WebHome]]Mapping Scheme, Ruleset Scheme, User Defined Operator Scheme)801 +* 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) 800 800 * All types of Enumerated List (ValueList){{footnote}}Note that Codelist is also an EnumeratedList.{{/footnote}} 801 -* All types of Structure ( [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]],[[Metadata Structure Definition>>doc:sdmx:Glossary.Metadata structure definition.WebHome]])802 -* All types of Structure Usage ( [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]],[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]])803 +* All types of Structure (Data Structure Definition, Metadata Structure Definition) 804 +* All types of Structure Usage (Dataflow, Metadataflow) 803 803 804 804 === 7.1.3 Structure Usage === 805 805 806 806 ==== 7.1.3.1 Structure Usage: Basic Concepts ==== 807 807 808 -The Structure Usage defines, in its concrete classes of [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]and[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]], which flows of data and metadata use which specific Structure, and importantly for the support of data and metadata discovery, the Structure Usage can be linked to one or more[[Category>>doc:sdmx:Glossary.Category.WebHome]]in one or more[[Category Scheme>>doc:sdmx:Glossary.Categoryscheme.WebHome]]using the Categorisation mechanism. This gives the ability for an application to discover data and metadata by “drilling down” the[[Category Schemes>>doc:sdmx:Glossary.Category scheme.WebHome]].810 +The Structure Usage defines, in its concrete classes of Dataflow and Metadataflow, which flows of data and metadata use which specific Structure, and importantly for the support of data and metadata discovery, the Structure Usage can be linked to one or more Category in one or more Category Scheme using the Categorisation mechanism. This gives the ability for an application to discover data and metadata by “drilling down” the Category Schemes. 809 809 810 810 ==== 7.1.3.2 Structure Usage Schematic ==== 811 811 ... ... @@ -819,47 +819,47 @@ 819 819 820 820 **Figure 10: SDMX-IM of links from Structure Usage to Category** 821 821 822 -In addition to the maintenance of the [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]and the[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]], the following links must be maintained in the registry:824 +In addition to the maintenance of the Dataflow and the Metadataflow, the following links must be maintained in the registry: 823 823 824 -* [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]to Data Structure Definition825 -* [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]to Metadata Structure Definition826 +* Dataflow to Data Structure Definition 827 +* Metadataflow to Metadata Structure Definition 826 826 827 827 The following links may be created by means of a Categorisation 828 828 829 -* Categorisation to [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]and[[Category>>doc:sdmx:Glossary.Category.WebHome]]830 -* Categorisation to [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]and[[Category>>doc:sdmx:Glossary.Category.WebHome]]831 +* Categorisation to Dataflow and Category 832 +* Categorisation to Metadataflow and Category 831 831 832 832 == 7.2 Data and Metadata Provisioning == 833 833 834 834 === 7.2.1 Provisioning Agreement: Basic concepts === 835 835 836 -Data/Metadata provisioning defines a framework in which the provision of different types of statistical data and metadata by various data/metadata providers can be specified and controlled. This framework is the basis on which the existence of data can be made known to the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-enabled community and hence the basis on which data can subsequently be discovered. Such a framework can be used to regulate the data content to facilitate the building of intelligent applications. It can also be used to facilitate the processing implied by service(% style="color:#e74c3c" %)level(%%)agreements, or other provisioning agreements in those scenarios that are based on legal directives. Additionally, quality and[[timeliness>>doc:sdmx:Glossary.Timeliness.WebHome]]metadata can be supported by this framework which makes it practical to implement information supply chain monitoring.838 +Data/Metadata provisioning defines a framework in which the provision of different types of statistical data and metadata by various data/metadata providers can be specified and controlled. This framework is the basis on which the existence of data can be made known to the SDMX-enabled community and hence the basis on which data can subsequently be discovered. Such a framework can be used to regulate the data content to facilitate the building of intelligent applications. It can also be used to facilitate the processing implied by service level agreements, or other provisioning agreements in those scenarios that are based on legal directives. Additionally, quality and timeliness metadata can be supported by this framework which makes it practical to implement information supply chain monitoring. 837 837 838 838 Note that the term “data provisioning” here includes both the provisioning of data and metadata. 839 839 840 -Although the [[Provision Agreement>>doc:sdmx:Glossary.Provisionagreement.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.842 +Although the Provision Agreement directly supports the data-sharing “pull” model, it is also useful in “push” exchanges (bilateral and gateway scenarios), or in a dissemination environment. It should be noted, too, that in any exchange scenario, the registry functions as a repository of structural metadata. 841 841 842 842 === 7.2.2 Provisioning Agreement Model – pull use case === 843 843 844 -An organisation which publishes statistical data or [[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]] and wishes to make it available to an[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]] enabled community is called a[[Data Provider>>doc:sdmx:Glossary.Dataprovider.WebHome]].In terms of the[[SDMX Information Model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]], the[[Data Provider>>doc:sdmx:Glossary.Dataprovider.WebHome]] is maintained in a[[Data Provider Scheme>>doc:sdmx:Glossary.Data provider scheme.WebHome]].846 +An organisation which publishes statistical data or reference metadata and wishes to make it available to an SDMX enabled community is called a Data Provider. In terms of the SDMX Information Model, the Data Provider is maintained in a Data Provider Scheme. 845 845 846 846 [[image:SDMX 3.1 Section 5_en_5a16c7fe.jpg||height="455" width="551"]] 847 847 848 848 **Figure 11: SDMX-IM of the Data Provider** 849 849 850 -Note that the [[Data Provider>>doc:sdmx:Glossary.Dataprovider.WebHome]] does not inherit the[[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]]association. The diagram below shows a logical schematic of the data model classes required to maintain[[provision agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]].852 +Note that the Data Provider does not inherit the hierarchy association. The diagram below shows a logical schematic of the data model classes required to maintain provision agreements. 851 851 852 852 [[image:SDMX 3.1 Section 5_en_b08fd1a2.jpg||height="299" width="533"]] 853 853 854 854 **Figure 12: Schematic of the Provision Agreement** 855 855 856 -The diagram below is a logical [[representation>>doc:sdmx:Glossary.Representation.WebHome]]of the data required in order to maintain[[Provision Agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]].858 +The diagram below is a logical representation of the data required in order to maintain Provision Agreements. 857 857 858 858 [[image:SDMX 3.1 Section 5_en_c63d10ab.jpg||height="246" width="579"]] 859 859 860 860 **Figure 13: Logical class diagram of the information contained in the Provision Agreement** 861 861 862 -A [[Provision Agreement>>doc:sdmx:Glossary.Provisionagreement.WebHome]]is[[structural metadata>>doc:sdmx:Glossary.Structuralmetadata.WebHome]].Each[[Provision Agreement>>doc:sdmx:Glossary.Provisionagreement.WebHome]] must reference a[[Data Provider>>doc:sdmx:Glossary.Dataprovider.WebHome]]orMetadata Provider and a[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]or[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]Definition. The Data/Metadata Provider and the[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]/[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]must exist already in order to set up a Metadata Provision or[[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]].864 +A Provision Agreement is structural metadata. Each Provision Agreement must reference a Data Provider or Metadata Provider and a Dataflow or Metadataflow Definition. The Data/Metadata Provider and the Dataflow/Metadataflow must exist already in order to set up a Metadata Provision or Provision Agreement. 863 863 864 864 == 7.3 Data and Metadata Constraints == 865 865 ... ... @@ -1106,24 +1106,24 @@ 1106 1106 1107 1107 **Figure 20: Logical Class Diagram of the Notification** 1108 1108 1109 -A [[notification>>doc:sdmx:Glossary.Notification.WebHome]]is an XML document that is sent to a user via email or http POST whenever a[[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]is activated. It is an asynchronous one-way message.1111 +A notification is an XML document that is sent to a user via email or http POST whenever a subscription is activated. It is an asynchronous one-way message. 1110 1110 1111 -Regardless of the registry [[component>>doc:sdmx:Glossary.Component.WebHome]]that caused the event to be triggered, the following common information is in the message:1113 +Regardless of the registry component that caused the event to be triggered, the following common information is in the message: 1112 1112 1113 1113 * Date and time that the event occurred 1114 -* The URN of the [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]]that caused the event1115 -* The URN of the [[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]that produced the[[notification>>doc:sdmx:Glossary.Notification.WebHome]]1116 +* The URN of the artefact that caused the event 1117 +* The URN of the Subscription that produced the notification 1116 1116 * Event Action: Add, Replace, or Delete. 1117 1117 1118 -Additionally, supplementary information may be contained in the [[notification>>doc:sdmx:Glossary.Notification.WebHome]]as detailed below.1120 +Additionally, supplementary information may be contained in the notification as detailed below. 1119 1119 1120 1120 === 7.6.2 Structural Event Component === 1121 1121 1122 -The [[notification>>doc:sdmx:Glossary.Notification.WebHome]]will contain the MaintainableArtefact that triggered the event in a form similar to the[[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]]structural message (using elements from that namespace).1124 +The notification will contain the MaintainableArtefact that triggered the event in a form similar to the SDMX-ML structural message (using elements from that namespace). 1123 1123 1124 1124 === 7.6.3 Registration Event Component === 1125 1125 1126 -The [[notification>>doc:sdmx:Glossary.Notification.WebHome]]will contain the Registration.1128 +The notification will contain the Registration. 1127 1127 1128 1128 ---- 1129 1129