Skip to Content

Wiki source code of 11 Data Provisioning

Last modified by Artur on 2025/09/10 11:19
Show last authors
1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 == {{id name="_Toc371071"/}}11.1 Class Diagram ==
6
7 [[image:SDMX_2-1_SECTION_2_InformationModel_2020-07_d7e39650.png||height="693" width="555"]]
8
9 **Figure 41: Relationship and inheritance class diagram of data provisioning**
10
11 == {{id name="_Toc371072"/}}11.2 Explanation of the Diagram ==
12
13 === {{id name="_Toc371073"/}}11.2.1 Narrative ===
14
15 This sub model links many [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] in the [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]] and is pivotal to an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] metadata registry, as all of the [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] in this sub model must be accessible to an application that is responsible for data and metadata registration or for an application that requires access to the data or metadata.
16
17 Whilst a registry contains all of the metadata depicted on the diagram above, the classes in the grey shaded area are specific to a registry based scenario where [[data sources>>doc:sdmx:Glossary.Data source.WebHome]] (either physical data and [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]] or databases and [[metadata repositories>>doc:sdmx:Glossary.Metadata repository.WebHome]]) are registered. More details on how these classes are used in a registry scenario can be found in the [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Interface document. (Section 5 of the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Standards).
18
19 A ProvisionAgreement links the [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] that defines how data and metadata are structured and classified (//StructureUsage//) to the DataProvider, and, by means of a data or metadata registration, it references the Datasource (this can be data or metadata), whether this be an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] conformant file on a website (SimpleDatasource) or a database service capable of supporting an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] query and responding with an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] conformant document (//QueryDatasource//).
20
21 The //StructureUsage//, which has concrete classes of DataflowDefinition and MetadataflowDefinition identifies the corresponding DataStructureDefinition or MetadataStructureDefinition, and, via Categorisation, can link to one or more [[Category>>doc:sdmx:Glossary.Category.WebHome]] in a CategoryScheme such as a subject matter domain scheme, by which the //StructureUsage// can be classified. This can assist in drilling down from subject matter domains to find the data or metadata that may be relevant.
22
23 The SimpleDatasource links to the actual [[DataSet>>doc:sdmx:Glossary.Data set.WebHome]] or MetadataSet on a website (this is shown on the diagram as a dependency called “references”). The sourceURL is obtained during the registration process of the [[DataSet>>doc:sdmx:Glossary.Data set.WebHome]] or the MetadataSet. Additional information about the content of the SimpleDatasource is stored in the registry in terms of a ContentConstraint (see 10.3) for the Registration.
24
25 The QueryDatasource is an abstract class that represents a [[data source>>doc:sdmx:Glossary.Data source.WebHome]] which can understand an [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] query (SOAPDatasource) or RESTful query (RESTDatasource) and respond appropriately. Each of these different Datasources inherit the dataURL from Datasource, and the QueryDatasource has an additional URL to locate a WSDL or WADL document to describe how to access it. All other supported protocols are assumed to use the SimpleDatasource URL.
26
27 The diagram below shows in schematic way the essential navigation through the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] structural [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] that eventually link to a data or metadata registration.
28
29 [[image:SDMX_2-1_SECTION_2_InformationModel_2020-07_c6141d32.jpg||height="416" width="554"]]
30
31 **Figure 42: Schematic of the linking of [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] to data and metadata registration**
32
33 === {{id name="_Toc371074"/}}11.2.2 Definitions ===
34
35 (((
36 (% style="width:1173.29px" %)
37 |(% style="width:227px" %)**Class**|(% style="width:271px" %)**Feature**|(% style="width:634px" %)**Description**
38 |(% style="width:227px" %)//StructureUsage//|(% style="width:271px" %)(((
39 Abstract class:
40 Sub classes are:
41 DataflowDefinition
42 MetadataflowDefinition
43 )))|(% style="width:634px" %)This is described in the Base.
44 |(% style="width:227px" %) |(% style="width:271px" %)controlledBy|(% style="width:634px" %)Association to the [[Provision Agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]] that comprise the metadata related to the provision of data.
45 |(% style="width:227px" %)DataProvider|(% style="width:271px" %) |(% style="width:634px" %)See Organisation Scheme.
46 |(% style="width:227px" %) |(% style="width:271px" %)hasAgreement|(% style="width:634px" %)Association to the [[Provision Agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]] for which the provider supplies data or metadata.
47 |(% style="width:227px" %) |(% style="width:271px" %)+source|(% style="width:634px" %)Association to a data or metadata source which can process a data or metadata query.
48 |(% style="width:227px" %)ProvisionAgreement|(% style="width:271px" %) |(% style="width:634px" %)Links the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] to the relevant Structure Usage (e.g. [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] Definition or [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] Definition) for which the provider supplies data or metadata The agreement may constrain the scope of the data or metadata that can be provided, by means of a Constraint.
49 |(% style="width:227px" %) |(% style="width:271px" %)+source|(% style="width:634px" %)Association to a data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] source which can process a data or metadata query.
50 |(% style="width:227px" %)//Datasource//|(% style="width:271px" %)(((
51 Abstract class:
52 Sub classes are:
53 SimpleDatasource
54 //WebServices
55 Datasource//
56 )))|(% style="width:634px" %)Identification of the location or service from where data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] can be obtained.
57 |(% style="width:227px" %) |(% style="width:271px" %)+sourceURL|(% style="width:634px" %)The URL of the data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] source (a file or a web service).
58 |(% style="width:227px" %)SimpleDatasource|(% style="width:271px" %) |(% style="width:634px" %)An [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] [[data set>>doc:sdmx:Glossary.Data set.WebHome]] accessible as a file at a URL.
59 |(% style="width:227px" %)//WebServices Datasource//|(% style="width:271px" %)(((
60 Abstract class:
61 Inherits from:
62 //Datasource//
63 Sub classes are:
64 RESTDatasource
65 SOAPDatasource
66 )))|(% style="width:634px" %)A data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] source which can process a data or metadata query.
67 |(% style="width:227px" %)RESTDatasource|(% style="width:271px" %) |(% style="width:634px" %)A data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] source that is accessible via a RESTful web services interface.
68 |(% style="width:227px" %) |(% style="width:271px" %) |(% style="width:634px" %)A data or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] source that conforms to a SOAP web service interface.
69 |(% style="width:227px" %)SOAPDatasource|(% style="width:271px" %)+WSDLURL|(% style="width:634px" %)Association to the URL of the Web Service Definition Language (SOAP) or Web Service Application Language (REST) profile of the web service.
70 |(% style="width:227px" %)Registration|(% style="width:271px" %) |(% style="width:634px" %)This is not detailed here but is shown as the link between the [[SDMX-IM>>doc:sdmx:Glossary.SDMX Information Model.WebHome]] and the Registry Service API. It denotes a data or metadata registration document.
71 )))