Wiki source code of SDMX 3.0 Standards. Section 5. Registry Specification: Logical Functionality

Version 41.3 by Elena on 2025/06/18 11:45

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