Skip to Content
Last modified by Artur on 2025/09/12 15:31
From version 2.1
edited by Helena
on 2025/05/23 16:56
Change comment: There is no comment for this version
To version 1.2
edited by Artur
on 2025/05/20 14:28
Change comment: Update document after refactoring.

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.helena
1 +xwiki:XWiki.arturkryazhev
Content
... ... @@ -4,11 +4,11 @@
4 4  
5 5  == 3.1 Scope of this Chapter ==
6 6  
7 -In order to present a common theme throughout this User Guide a common set of use cases, a common scenario, and a common set of examples are used. This chapter specifies the use cases, scenario, and the example [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] used.
7 +In order to present a common theme throughout this User Guide a common set of use cases, a common scenario, and a common set of examples are used. This chapter specifies the use cases, scenario, and the example SDMX structural metadata used.
8 8  
9 9  == 3.2 Use Cases ==
10 10  
11 -[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] supports many use cases.
11 +SDMX supports many use cases.
12 12  
13 13  (% style="width:1268.45px" %)
14 14  |(% style="width:262px" %)**Use Case**|(% style="width:401px" %)(((
... ... @@ -16,73 +16,75 @@
16 16  
17 17  **Activity**
18 18  )))|(% style="width:601px" %)**Structural Metadata Requirements**
19 -|(% style="width:262px" %)Data Reporting|(% style="width:401px" %)Extract data from the source (database, file, spreadsheet)|(% style="width:601px" %)Access to [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]].
20 -|(% style="width:262px" %) |(% style="width:401px" %)Write an [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] or [[SDMX-EDI>>doc:sdmx:Glossary.SDMX-EDI.WebHome]] [[data set>>doc:sdmx:Glossary.Data set.WebHome]]|(% style="width:601px" %)Access to [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] and possibly [[code>>doc:sdmx:Glossary.Code.WebHome]] transformations and aggregations.
21 -|(% style="width:262px" %) |(% style="width:401px" %)Validate the [[data set>>doc:sdmx:Glossary.Data set.WebHome]]|(% style="width:601px" %)Access to the [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] or an XML schema derived from it.
19 +|(% style="width:262px" %)Data Reporting|(% style="width:401px" %)Extract data from the source (database, file, spreadsheet)|(% style="width:601px" %)Access to DSD.
20 +|(% style="width:262px" %) |(% style="width:401px" %)Write an SDMX-ML or SDMX-EDI data set|(% style="width:601px" %)Access to DSD and possibly code transformations and aggregations.
21 +|(% style="width:262px" %) |(% style="width:401px" %)Validate the data set|(% style="width:601px" %)Access to the DSD or an XML schema derived from it.
22 22  |(% style="width:262px" %)Load data into a database|(% style="width:401px" %)(((
23 -Read an [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] or [[SDMX-EDI>>doc:sdmx:Glossary.SDMX-EDI.WebHome]] [[data set>>doc:sdmx:Glossary.Data set.WebHome]].
23 +Read an SDMX-ML or SDMX-EDI data set.
24 24  
25 -Validate the [[data set>>doc:sdmx:Glossary.Data set.WebHome]].
25 +Validate the data set.
26 26  
27 27  Write data to database
28 -)))|(% style="width:601px" %)Access to [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] and possibly [[code>>doc:sdmx:Glossary.Code.WebHome]] transformations.
29 -|(% style="width:262px" %)Report [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]]|(% style="width:401px" %)Extract metadata from a database|(% style="width:601px" %)Access to [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]].
30 -|(% style="width:262px" %) |(% style="width:401px" %)Write [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]]|(% style="width:601px" %)Access to [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]].
31 -|(% style="width:262px" %) |(% style="width:401px" %)Validate [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]]|(% style="width:601px" %)Access to [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] or schema derived from it.
32 -|(% style="width:262px" %)Load [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] into a database (often called a [[metadata repository>>doc:sdmx:Glossary.Metadata repository.WebHome]])|(% style="width:401px" %)Read [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] metadata.|(% style="width:601px" %)Access to [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] and possibly [[code>>doc:sdmx:Glossary.Code.WebHome]] transformations.
33 -|(% style="width:262px" %) |(% style="width:401px" %)Write metadata to database|(% style="width:601px" %)Access to [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]].
28 +)))|(% style="width:601px" %)Access to DSD and possibly code transformations.
29 +|(% style="width:262px" %)Report reference metadata|(% style="width:401px" %)Extract metadata from a database|(% style="width:601px" %)Access to MSD.
30 +|(% style="width:262px" %) |(% style="width:401px" %)Write metadata set|(% style="width:601px" %)Access to MSD.
31 +|(% style="width:262px" %) |(% style="width:401px" %)Validate metadata set|(% style="width:601px" %)Access to MSD or schema derived from it.
32 +|(% style="width:262px" %)Load reference metadata into a database (often called a metadata repository)|(% style="width:401px" %)Read SDMX-ML metadata.|(% style="width:601px" %)Access to MSD and possibly code transformations.
33 +|(% style="width:262px" %) |(% style="width:401px" %)Write metadata to database|(% style="width:601px" %)Access to MSD.
34 34  |(% style="width:262px" %)Report data by means of the “pull” method|(% style="width:401px" %)(((
35 35  Extract data
36 36  
37 -Write [[data set>>doc:sdmx:Glossary.Data set.WebHome]]
37 +Write data set
38 38  
39 -Validate [[data set>>doc:sdmx:Glossary.Data set.WebHome]]
40 -)))|(% style="width:601px" %)Access to [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]]
39 +Validate data set
40 +)))|(% style="width:601px" %)Access to DSD
41 41  |(% style="width:262px" %) |(% style="width:401px" %)Place the file at a URL location|(% style="width:601px" %)
42 -|(% style="width:262px" %) |(% style="width:401px" %)Publish the existence of the [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] by means of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Registration|(% style="width:601px" %)[[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] in an [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]].
43 -|(% style="width:262px" %)Database Administration (automatic generation of database tables)|(% style="width:401px" %)Create database tables|(% style="width:601px" %)Access to [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]]
44 -|(% style="width:262px" %) |(% style="width:401px" %)Load database|(% style="width:601px" %)Access to [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]]
42 +|(% style="width:262px" %) |(% style="width:401px" %)Publish the existence of the dataset by means of an SDMX Registration|(% style="width:601px" %)Provision Agreement in an SDMX Registry.
43 +|(% style="width:262px" %)Database Administration (automatic generation of database tables)|(% style="width:401px" %)Create database tables|(% style="width:601px" %)Access to DSD
44 +|(% style="width:262px" %) |(% style="width:401px" %)Load database|(% style="width:601px" %)Access to DSD
45 45  |(% style="width:262px" %)(((
46 -Enable database to be compatible with [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Web
46 +Enable database to be compatible with SDMX Web
47 47  
48 48  Services
49 -)))|(% style="width:401px" %)Accept and process and [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] structure query|(% style="width:601px" %)Access to [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] such as [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]], [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], [[Metadata flow>>doc:sdmx:Glossary.Metadataflow.WebHome]], [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]], [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], (% style="color:#e74c3c" %)Constraint(%%), [[Category Scheme>>doc:sdmx:Glossary.Category scheme.WebHome]].
50 -|(% style="width:262px" %) |(% style="width:401px" %)Accept and process an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] data query|(% style="width:601px" %)Access to [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]].
51 -|(% style="width:262px" %) |(% style="width:401px" %)Write [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[data set>>doc:sdmx:Glossary.Data set.WebHome]]|(% style="width:601px" %)Access to [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]].
52 -|(% style="width:262px" %)Data Discovery|(% style="width:401px" %)Locate [[data source>>doc:sdmx:Glossary.Data source.WebHome]]|(% style="width:601px" %)[[Category Scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] and links to [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] and data Registration
53 -|(% style="width:262px" %)Data and Metadata Query and Visualisation|(% style="width:401px" %)Query an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] structural repository.|(% style="width:601px" %)Access to [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]].
54 -|(% style="width:262px" %) |(% style="width:401px" %)Create an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] query from the user selections|(% style="width:601px" %)Access to [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]].
55 -|(% style="width:262px" %) |(% style="width:401px" %)Access a [[metadata repository>>doc:sdmx:Glossary.Metadata repository.WebHome]] to extract referential metadata pertaining to the data.|(% style="width:601px" %)Access to [[code lists>>doc:sdmx:Glossary.Code list.WebHome]] and concepts.
56 -|(% style="width:262px" %) |(% style="width:401px" %)Transform the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] data and referential metadata into tables, graphs, charts etc|(% style="width:601px" %)Access to [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] and metadata [[code lists>>doc:sdmx:Glossary.Code list.WebHome]] and concepts.
49 +)))|(% style="width:401px" %)Accept and process and SDMX structure query|(% style="width:601px" %)Access to SDMX structural metadata such as DSD, MSD, Dataflow, Metadata flow, Data Provider, Provision Agreement, Constraint, Category Scheme.
50 +|(% style="width:262px" %) |(% style="width:401px" %)Accept and process an SDMX data query|(% style="width:601px" %)Access to DSD.
51 +|(% style="width:262px" %) |(% style="width:401px" %)Write SDMX data set|(% style="width:601px" %)Access to DSD.
52 +|(% style="width:262px" %)Data Discovery|(% style="width:401px" %)Locate data source|(% style="width:601px" %)Category Scheme and links to Dataflow, Provision Agreement and data Registration
53 +|(% style="width:262px" %)Data and Metadata Query and Visualisation|(% style="width:401px" %)Query an SDMX structural repository.|(% style="width:601px" %)Access to SDMX structural metadata.
54 +|(% style="width:262px" %) |(% style="width:401px" %)Create an SDMX query from the user selections|(% style="width:601px" %)Access to DSD.
55 +|(% style="width:262px" %) |(% style="width:401px" %)Access a metadata repository to extract referential metadata pertaining to the data.|(% style="width:601px" %)Access to code lists and concepts.
56 +|(% style="width:262px" %) |(% style="width:401px" %)Transform the SDMX data and referential metadata into tables, graphs, charts etc|(% style="width:601px" %)Access to DSD and metadata code lists and concepts.
57 57  
58 58  == 3.3 Scenario ==
59 59  
60 60  === 3.3.1 Web Dissemination Use Case ===
61 61  
62 -The use of web dissemination is the prime use case for this User Guide and the chapters in this guide follow this process flow. However, the topic of each chapter is relevant to more than this single use case of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]. For instance, a [[Data Structure Definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] is relevant to all use cases concerning data, and an [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] is relevant to virtually all use cases. The reason for choosing web dissemination of data and related metadata is twofold:
62 +The use of web dissemination is the prime use case for this User Guide and the chapters in this guide follow this process flow. However, the topic of each chapter is relevant to more than this single use case of SDMX. For instance, a Data Structure Definition is relevant to all use cases concerning data, and an SDMX Registry is relevant to virtually all use cases. The reason for choosing web dissemination of data and related metadata is twofold:
63 63  
64 -* this single use case uses many of the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] constructs
65 -* it is an increasingly popular use of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] as it enables organizations to build a self-updating dissemination system
64 +* this single use case uses many of the SDMX constructs
65 +* it is an increasingly popular use of SDMX as it enables organizations to build a self-updating dissemination system
66 66  
67 +(% style="text-align: center;" %)
67 67  [[image:SDMX_2-1_User_Guide_draft_0-1_html_4cced818dadfe93f.jpg||data-xwiki-image-style-alignment="center" height="409" width="576"]]
68 68  
69 69  (% style="text-align: center;" %)
70 -**{{id name="image_1"/}}Figure 1: Process flow of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Web Data Dissemination System**
71 +**{{id name="image_1"/}}Figure 1: Process flow of an SDMX Web Data Dissemination System**
71 71  
72 72  |**Process**|**Description**
73 -|1|Retrieve the [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] from a [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] source (e.g. an [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]]), and create database tables.
74 -|2|Read an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[data set>>doc:sdmx:Glossary.Data set.WebHome]] file and load the data into the database
75 -|3|Data discovery system continually synchronises its metadata with the [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] source. A user makes a data selection from choices built from the information held in an [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] ([[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] such as [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]], [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]], [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]], [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]], [[provision agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]] and data registration)
76 -|4|These choices are logical choices, built from the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] selections.
77 -|5|The logical choice is formatted as an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] data query. This is passed to the Data Base which responds with an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[data set>>doc:sdmx:Glossary.Data set.WebHome]].
78 -|6|[[Reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] relevant to the data returned is retrieved from a [[metadata repository>>doc:sdmx:Glossary.Metadata repository.WebHome]].
79 -|7|The data and metadata are passed to a visualization tool to display the data in tables, charts, graphs, (% style="color:#e74c3c" %)maps(%%) etc. Often a download is offered in various formats. The download options often include also the [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] or [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]].
74 +|1|Retrieve the DSD from a structural metadata source (e.g. an SDMX Registry), and create database tables.
75 +|2|Read an SDMX data set file and load the data into the database
76 +|3|Data discovery system continually synchronises its metadata with the structural metadata source. A user makes a data selection from choices built from the information held in an SDMX Registry (structural metadata such as category scheme, dataflow, DSD, data provider, provision agreements and data registration)
77 +|4|These choices are logical choices, built from the dimension selections.
78 +|5|The logical choice is formatted as an SDMX data query. This is passed to the Data Base which responds with an SDMX data set.
79 +|6|Reference metadata relevant to the data returned is retrieved from a metadata repository.
80 +|7|The data and metadata are passed to a visualization tool to display the data in tables, charts, graphs, maps etc. Often a download is offered in various formats. The download options often include also the DSD or MSD.
80 80  
81 81  === 3.3.2 Structural Metadata ===
82 82  
83 -The following [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] and provisioning metadata is used in the scenario.
84 +The following structural metadata and provisioning metadata is used in the scenario.
84 84  
85 -[[image:SDMX_2-1_User_Guide_draft_0-1_html_a35ea5c2f2cc1e43.jpg||data-xwiki-image-style-alignment="center" height="436" width="575"]]
86 +(% style="text-align: center;" %)
87 +[[image:SDMX_2-1_User_Guide_draft_0-1_html_a35ea5c2f2cc1e43.jpg||height="436" width="575"]]
86 86  
87 87  (% style="text-align: center;" %)
88 88  **{{id name="image_2"/}}Figure 2: Structural and Provisioning Metadata Used in the Scenario**