Wiki source code of SDMX STANDARDS: SECTION 5

Version 21.5 by Helena on 2025/05/15 14:09

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