Changes for page 13 Data Provisioning
Last modified by Helena on 2025/09/10 11:19
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Tags
-
... ... @@ -1,1 +1,0 @@ 1 -Artefact|Data provider|Data set|Data source|Dataflow|Metadata repository|Metadata set|Metadataflow|Provision agreement|Reference metadata|SDMX Information Model|SDMX Registry|Statistical data and metadata exchange - Content
-
... ... @@ -1,75 +7,78 @@ 1 -{{box title="**Contents**"}} 2 -{{toc/}} 3 -{{/box}} 4 - 5 -== 13.1 Class Diagram == 6 - 7 7 **Figure 44: Relationship and inheritance class diagram of data/metadata provisioning** 8 8 9 -== 13.2 Explanation of the Diagram == 3 +=== 13.2 Explanation of the Diagram === 10 10 11 -=== 13.2.1 Narrative === 5 +==== 13.2.1 Narrative ==== 12 12 13 -This sub model links many [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]in the[[SDMX-IM>>doc:sdmx:Glossary.SDMXInformationModel.WebHome]]andis pivotal to an[[SDMX>>doc:sdmx:Glossary.Statisticaldata andmetadataexchange.WebHome]] metadataregistry, 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.7 +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 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>>doc:sdmx:Glossary.Datasource.WebHome]](either physical data and[[metadata sets>>doc:sdmx:Glossary.Metadataset.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.SDMXRegistry.WebHome]]Interface document. (Section 5 of the[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]Standards).9 +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 16 17 -A ProvisionAgreement / MetadataProvisionAgreement links the [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]]that defines how data / metadata are structured and classified (//StructureUsage//) to the DataProvider / MetadataProvider. By means of a data registration, it references the //Datasource// (data only), whether this be an[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]] conformant file on a website (SimpleDatasource) or a database service capable of supporting an[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]query and responding with an[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]] conformant document (//QueryDatasource//).11 +A ProvisionAgreement / MetadataProvisionAgreement links the artefact that defines how data / metadata are structured and classified (//StructureUsage//) to the DataProvider / MetadataProvider. By means of a data registration, it references the //Datasource// (data only), 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 18 19 -The //StructureUsage//, which has concrete classes of [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]and[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]identifies the corresponding DataStructureDefinition or13 +The //StructureUsage//, which has concrete classes of Dataflow and Metadataflow identifies the corresponding DataStructureDefinition or 20 20 21 21 MetadataStructureDefinition, and, via Categorisation, can link to one or more Category(s) 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 22 23 -The SimpleDatasource links to the actual [[DataSet>>doc:sdmx:Glossary.Dataset.WebHome]] 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.Dataset.WebHome]].Additional information about the content of the SimpleDatasource is stored in the registry in terms of a(% style="color:#e74c3c" %)//Constraint//(%%)(see 12.3) for the Registration.17 +The SimpleDatasource links to the actual DataSet 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. Additional information about the content of the SimpleDatasource is stored in the registry in terms of a //Constraint// (see 12.3) for the Registration. 24 24 25 -The //QueryDatasource// is an abstract class that represents a [[data source>>doc:sdmx:Glossary.Data source.WebHome]], which can understand an[[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]RESTful query (RESTDatasource) and respond appropriately. Each of these different //Datasource//s inherit the dataURL from //Datasource//, and the //QueryDatasource// has an additional URL, the specURL, to locate the specification of the service (i.e., the open API specification for RESTDatasource), which describes how to access it. All other supported protocols are assumed to use the SimpleDatasource URL.19 +The //QueryDatasource// is an abstract class that represents a data source, which can understand an SDMX RESTful query (RESTDatasource) and respond appropriately. Each of these different //Datasource//s inherit the dataURL from //Datasource//, and the //QueryDatasource// has an additional URL, the specURL, to locate the specification of the service (i.e., the open API specification for RESTDatasource), which describes how to access it. All other supported protocols are assumed to use the SimpleDatasource URL. 26 26 27 -The diagram below shows in schematic way the essential navigation through the [[SDMX>>doc:sdmx:Glossary.Statisticaldata and metadata exchange.WebHome]]structural[[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]that eventually link to a data or metadata registration{{footnote}}Provider Scheme, Provider, Provision Agreementand Registered source refer bothto data and reference metadata.{{/footnote}}.21 +The diagram below shows in schematic way the essential navigation through the SDMX structural artefacts that eventually link to a data or metadata registration[[^^~[1~]^^>>path:#_ftn1]]. 28 28 29 29 [[image:1749246752523-973.jpeg]] 30 30 31 31 **Figure 45: Schematic of the linking of structural metadata to data and metadata registration** 32 32 33 -=== 13.2.2 Definitions === 27 +==== 13.2.2 Definitions ==== 34 34 35 -(% style="width:971.835px" %) 36 -|**Class**|(% style="width:185px" %)**Feature**|(% style="width:569px" %)**Description** 37 -|//StructureUsage//|(% style="width:185px" %)((( 29 +|**Class**|**Feature**|**Description** 30 +|//StructureUsage//|((( 38 38 Abstract class: 32 + 39 39 Sub classes are: 40 -[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] 41 -[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] 42 -)))|(% style="width:569px" %)This is described in the Base. 43 -| |(% style="width:185px" %)controlledBy|(% style="width:569px" %)Association to the [[Provision Agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]] that comprise the metadata related to the provision of data. 44 -|DataProvider|(% style="width:185px" %) |(% style="width:569px" %)See Organisation Scheme. 45 -| |(% style="width:185px" %)hasAgreement|(% style="width:569px" %)Association to the [[Provision Agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]] for which the provider supplies data or metadata. 46 -| |(% style="width:185px" %)+source|(% style="width:569px" %)Association to a [[data source>>doc:sdmx:Glossary.Data source.WebHome]], which can process a data query. 47 -|MetadataProvider|(% style="width:185px" %) |(% style="width:569px" %)See Organisation Scheme. 48 -| |(% style="width:185px" %)hasAgreement|(% style="width:569px" %)Association to the Metadata [[Provision Agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]] for which the provider supplies data or metadata. 49 -| |(% style="width:185px" %)+source|(% style="width:569px" %)Association to a metadata source, which can process a metadata query. 50 -|ProvisionAgreement|(% style="width:185px" %) |(% style="width:569px" %)Links the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] to the relevant Structure Usage (i.e., the [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]) for which the provider supplies data. The agreement may constrain the scope of the data that can be provided, by means of a DataConstraint. 51 -| |(% style="width:185px" %)+source|(% style="width:569px" %)Association to a [[data source>>doc:sdmx:Glossary.Data source.WebHome]], which can process a data query. 52 -|MetadataProvisionAgreement|(% style="width:185px" %) |(% style="width:569px" %)Links the Metadata Provider to the relevant Structure Usage (i.e., the [[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]) for which the provider supplies metadata. The agreement may constrain the scope of the metadata that can be provided, by means of a MetadataConstraint. 53 -| |(% style="width:185px" %)+source|(% style="width:569px" %)Association to [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] source, which can process a metadata query. 54 -|//Datasource//|(% style="width:185px" %)((( 34 + 35 + Dataflow 36 + 37 +Metadataflow 38 +)))|This is described in the Base. 39 +| |controlledBy|Association to the Provision Agreements that comprise the metadata related to the provision of data. 40 +|DataProvider| |See Organisation Scheme. 41 +| |hasAgreement|Association to the Provision Agreements for which the provider supplies data or metadata. 42 +| |+source|Association to a data source, which can process a data query. 43 +|MetadataProvider| |See Organisation Scheme. 44 +| |hasAgreement|Association to the Metadata Provision Agreements for which the provider supplies data or metadata. 45 +| |+source|Association to a metadata source, which can process a metadata query. 46 +|ProvisionAgreement| |Links the Data Provider to the relevant Structure Usage (i.e., the Dataflow) for which the provider supplies data. The agreement may constrain the scope of the data that can be provided, by means of a DataConstraint. 47 +| |+source|Association to a data source, which can process a data query. 48 +|MetadataProvisionAgr eement| |Links the Metadata Provider to the relevant Structure Usage (i.e., the Metadataflow) for which the provider supplies metadata. The agreement may constrain the scope of the metadata that can be provided, by means of a MetadataConstraint. 49 +| |+source|Association to reference metadata source, which can process a metadata query. 50 +|//Datasource//|((( 55 55 Abstract class 56 -Sub classes are: 52 + 53 + Sub classes are: 54 + 57 57 SimpleDatasource 56 + 58 58 //QueryDatasource// 59 -)))| (% style="width:569px" %)Identification of the location or service from where data or[[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]]can be obtained.60 -| | (% style="width:185px" %)+sourceURL|(% style="width:569px" %)The URL of the data or[[reference metadata>>doc:sdmx:Glossary.Referencemetadata.WebHome]]source (a file or a web service).61 -|SimpleDatasource| (%style="width:185px" %)|(% style="width:569px" %)An[[SDMX>>doc:sdmx:Glossary.Statisticaldataand metadata exchange.WebHome]] [[dataset>>doc:sdmx:Glossary.Dataset.WebHome]]accessible as a file at a URL.62 -|//QueryDatasource//|( % style="width:185px" %)(((58 +)))|Identification of the location or service from where data or reference metadata can be obtained. 59 +| |+sourceURL|The URL of the data or reference metadata source (a file or a web service). 60 +|SimpleDatasource| |An SDMX dataset accessible as a file at a URL. 61 +|//QueryDatasource//|((( 63 63 Abstract class Inherits from: 64 -//Datasource// 63 + 64 + //Datasource// 65 + 65 65 Sub classes are: 66 -RESTDatasource 67 -)))|(% style="width:569px" %)A [[data source>>doc:sdmx:Glossary.Data source.WebHome]], which can process a data query. 68 -|RESTDatasource|(% style="width:185px" %) |(% style="width:569px" %)A [[data source>>doc:sdmx:Glossary.Data source.WebHome]] that is accessible via a RESTful web services interface. 69 -| |(% style="width:185px" %)+specificationURL|(% style="width:569px" %)Association to the URL for the specification of the web service. 70 -|Registration|(% style="width:185px" %) |(% style="width:569px" %)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 registration document. 71 71 72 ----- 68 + RESTDatasource 69 +)))|A data source, which can process a data query. 70 +|RESTDatasource| |A data source that is accessible via a RESTful web services interface. 71 +| |+specificationURL|Association to the URL for the specification of the web service. 72 +|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 registration document. 73 73 74 74 75 -{{putFootnotes/}} 75 + 76 +---- 77 + 78 +[[~[1~]>>path:#_ftnref1]] Provider Scheme, Provider, Provision Agreement and Registered source refer both to data and reference metadata.