Skip to Content

Wiki source code of 11 Data Provisioning

Version 6.1 by Helena on 2025/05/22 10:44
Hide last authors
Helena 2.1 1 = {{id name="_Toc371070"/}}11 Data Provisioning =
2
3 == {{id name="_Toc371071"/}}11.1 Class Diagram ==
4
5 [[image:SDMX_2-1_SECTION_2_InformationModel_2020-07_d7e39650.png||height="693" width="555"]]
6
7 **Figure 41: Relationship and inheritance class diagram of data provisioning**
8
9 == {{id name="_Toc371072"/}}11.2 Explanation of the Diagram ==
10
11 === {{id name="_Toc371073"/}}11.2.1 Narrative ===
12
13 This sub model links many artefacts in the SDMX-IM and is pivotal to an SDMX metadata registry, as all of the artefacts 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.
14
15 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 (either physical data and metadata sets or databases and metadata repositories) are registered. More details on how these classes are used in a registry scenario can be found in the SDMX Registry Interface document. (Section 5 of the SDMX Standards).
16
17 A ProvisionAgreement links the artefact 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 conformant file on a website (SimpleDatasource) or a database service capable of supporting an SDMX query and responding with an SDMX conformant document (//QueryDatasource//).
18
19 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 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.
20
21 The SimpleDatasource links to the actual DataSet 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 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.
22
23 The QueryDatasource is an abstract class that represents a data source which can understand an SDMX-ML 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.
24
25 The diagram below shows in schematic way the essential navigation through the SDMX structural artefacts that eventually link to a data or metadata registration.
26
27 [[image:SDMX_2-1_SECTION_2_InformationModel_2020-07_c6141d32.jpg||height="416" width="554"]]
28
29 **Figure 42: Schematic of the linking of structural metadata to data and metadata registration**
30
31 === {{id name="_Toc371074"/}}11.2.2 Definitions ===
32
Helena 5.1 33 :
Helena 2.1 34
35 (((
36 |**Class**|**Feature**|**Description**
37 |//StructureUsage//|(((
38 Abstract class:
39
40 Sub classes are:
41
42 DataflowDefinition
43
44 MetadataflowDefinition
45 )))|This is described in the Base.
Helena 5.1 46 | |controlledBy//     //|Association to the Provision Agreements that comprise the metadata related to the provision of data.
47 |DataProvider| |See Organisation Scheme.
48 | |hasAgreement|Association to the Provision Agreements for which the provider supplies data or metadata.
49 | |+source|Association to a data or metadata source which can process a data or metadata query.
50 |ProvisionAgreement| |Links the Data Provider to the relevant Structure Usage (e.g. Dataflow Definition or Metadataflow 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.
51 | |+source|Association to a data or reference metadata source which can process a data or metadata query.
Helena 2.1 52 |//Datasource//|(((
53 Abstract class:
54
55 Sub classes are:
56
57 SimpleDatasource
58
59 //WebServices//
60
61 //Datasource//
62 )))|Identification of the location or service from where data or reference metadata can be obtained.
Helena 5.1 63 | |+sourceURL//     //|The URL of the data or reference metadata source (a file or a web service).
64 |SimpleDatasource| |An SDMX-ML data set accessible as a file at a URL.
Helena 2.1 65 |//WebServices Datasource//|(((
66 Abstract class:
67
68 Inherits from:
69
70 //Datasource//
71
72 Sub classes are:
73
74 RESTDatasource
75
76 SOAPDatasource
77 )))|A data or reference metadata source which can process a data or metadata query.
78 )))
79
80 |**Class**|**Feature**|**Description**
Helena 5.1 81 |RESTDatasource| |A data or reference metadata source that is accessible via a RESTful web services interface.
82 |SOAPDatasource| |A data or reference metadata source that conforms to a SOAP web service interface.
83 | |+WSDLURL|(((
Helena 2.1 84 Association to the URL of the Web Service
85
86 Definition Language (SOAP) or Web Service Application Language (REST) profile of the web service.
87 )))
Helena 5.1 88 |Registration| |This is not detailed here but is shown as the link between the SDMX-IM and the Registry Service API. It denotes a data or metadata registration document.