Last modified by Helena on 2025/09/10 11:19

From version 8.1
edited by Artur
on 2025/05/27 15:51
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
Content
... ... @@ -4,35 +4,37 @@
4 4  
5 5  == 16.1 Scope ==
6 6  
7 -The scope of this Chapter is to show the [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] interactions with the Registry, database, and [[metadata repository>>doc:sdmx:Glossary.Metadata repository.WebHome]] for the use case scenario outlined in Chapter 3. The scenario is repeated below.
7 +The scope of this Chapter is to show the SDMX-ML interactions with the Registry, database, and metadata repository for the use case scenario outlined in Chapter 3. The scenario is repeated below.
8 8  
9 -The [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] examples used are (% style="color:#e74c3c" %)version(%%) 2.1.
9 +The SDMX-ML examples used are version 2.1.
10 10  
11 11  == 16.2 Scenario ==
12 12  
13 -This scenario is the dissemination of data and related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] using [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] web services. It shows how the data, [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]], and [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] are used to build a web dissemination system.
13 +This scenario is the dissemination of data and related reference metadata using SDMX web services. It shows how the data, reference metadata, and structural metadata are used to build a web dissemination system.
14 14  
15 +(% style="text-align: center;" %)
15 15  [[image:image-20250318221512-1.jpeg||data-xwiki-image-style-alignment="center"]]
16 16  
17 17  (% style="text-align: center;" %)
18 -**{{id name="image_47"/}}Figure 47: Process flow of an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Web Data Dissemination System**
19 +**{{id name="image_47"/}}Figure 47: Process flow of an SDMX Web Data Dissemination System**
19 19  
20 20  (% style="width:753.446px" %)
21 21  |**Process**|(% style="width:670px" %)**Description**
22 -|1|(% style="width:670px" %)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.
23 -|2|(% style="width:670px" %)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
24 -|3|(% style="width:670px" %)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)
25 -|3|(% style="width:670px" %)These choices are logical choices, built from the [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] selections.
26 -|5|(% style="width:670px" %)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]].
27 -|6|(% style="width:670px" %)[[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]].
28 -|7|(% style="width:670px" %)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.
23 +|1|(% style="width:670px" %)Retrieve the DSD from a structural metadata source (e.g. an SDMX Registry), and create database tables.
24 +|2|(% style="width:670px" %)Read an SDMX data set file and load the data into the database
25 +|3|(% style="width:670px" %)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)
26 +|3|(% style="width:670px" %)These choices are logical choices, built from the dimension selections.
27 +|5|(% style="width:670px" %)The logical choice is formatted as an SDMX data query. This is passed to the Data Base which responds with an SDMX data set.
28 +|6|(% style="width:670px" %)Reference metadata relevant to the data returned is retrieved from a metadata repository.
29 +|7|(% style="width:670px" %)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.
29 29  
30 30  == 16.3 Structural Metadata ==
31 31  
32 32  === 16.3.1 Schematic ===
33 33  
34 -The following [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] and provisioning metadata is used in the scenario.
35 +The following structural metadata and provisioning metadata is used in the scenario.
35 35  
37 +(% style="text-align: center;" %)
36 36  [[image:image-20250318221512-2.jpeg||data-xwiki-image-style-alignment="center"]]
37 37  
38 38  (% style="text-align: center;" %)
... ... @@ -40,28 +40,24 @@
40 40  
41 41  === 16.3.2 Data Structure Definition ===
42 42  
43 -For the reasons of clarity a sub set of the contents of the [[Code Lists>>doc:sdmx:Glossary.Code list.WebHome]] and [[Concept Schemes>>doc:sdmx:Glossary.Concept scheme.WebHome]] are used in this example, and only a few of the [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]] are used.
45 +For the reasons of clarity a sub set of the contents of the Code Lists and Concept Schemes are used in this example, and only a few of the DSD Attributes are used.
44 44  
45 -(% class="wikigeneratedid" id="HDimensions" %)
46 -**Dimensions**
47 +===== **Dimensions** =====
47 47  
48 48  (% style="text-align: center;" %)
49 49  [[image:image-20250318221512-3.jpeg]]** **
50 50  
51 -(% class="wikigeneratedid" id="HAttributes" %)
52 -**Attributes**
52 +===== **Attributes** =====
53 53  
54 54  (% style="text-align: center;" %)
55 55  [[image:image-20250318221512-4.jpeg]]** **
56 56  
57 -(% class="wikigeneratedid" id="HGroup" %)
58 -**Group**
57 +===== **Group** =====
59 59  
60 60  (% style="text-align: center;" %)
61 61  [[image:image-20250318221512-5.jpeg]]** **
62 62  
63 -(% class="wikigeneratedid" id="HPrimaryMeasure" %)
64 -**Primary Measure**
62 +===== **Primary Measure** =====
65 65  
66 66  (% style="text-align: center;" %)
67 67  [[image:image-20250318221512-6.jpeg]]** **
... ... @@ -70,30 +70,28 @@
70 70  
71 71  === 16.4.1 Create Data Base ===
72 72  
71 +(% style="text-align: center;" %)
73 73  [[image:image-20250318221512-7.jpeg||data-xwiki-image-style-alignment="center"]]
74 74  
75 75  (% style="text-align: center;" %)
76 76  **{{id name="image_49"/}}Figure 49: User Case - Create Database Tables from DSD**
77 77  
78 -The following [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] is extracted from the Registry using the REST query
79 -http:~/~/[ ws-entry-point]/DataStructure_ECB/ECB_EXR1
77 +The following SDMX-ML is extracted from the Registry using the REST query http:~/~/[ ws-entry-point]/DataStructure_ECB/ECB_EXR1
80 80  
81 -(% class="wikigeneratedid" id="HDimensions" %)
82 -**Dimensions**
79 +===== Dimensions =====
83 83  
81 +(% style="text-align: center;" %)
84 84  [[image:image-20250318221512-8.jpeg||data-xwiki-image-style-alignment="center"]]
85 85  
86 86  Note that for brevity only the XML of the FREQ and TIME_PERIOD are shown in full.
87 87  
88 -(% class="wikigeneratedid" id="HNotes" %)
89 -**Notes**
86 +===== **Notes** =====
90 90  
91 -1. A [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] can state its position in the key, but the actual sequence is defined by the sequence in the i.e. the inferred sequence in the  takes precedence over the value of the position attribute.
92 -1. This [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] is converted from (% style="color:#e74c3c" %)version(%%) 2.0. The (% style="color:#e74c3c" %)version(%%) 2.0 (% style="color:#e74c3c" %)Concepts(%%) were standalone in the form  <Concept agencyID=”ECB” version=”1.0”/>
93 -1. The standalone (% style="color:#e74c3c" %)concept(%%) is not supported in 2.1 and any standalone (% style="color:#e74c3c" %)concept(%%) is placed in a [[Concept Scheme>>doc:sdmx:Glossary.Concept scheme.WebHome]] with the Id “STANDALONE_CONCEPT_SCHEME” of the (% style="color:#e74c3c" %)version(%%) corresponding to the (% style="color:#e74c3c" %)version(%%) of the original standalone (% style="color:#e74c3c" %)concept(%%).
88 +1. A Dimension can state its position in the key, but the actual sequence is defined by the sequence in the <DimensionList> i.e. the inferred sequence in the <DimensionList> takes precedence over the value of the position attribute.
89 +1. This DSD is converted from version 2.0. The version 2.0 Concepts were standalone in the form  <Concept agencyID=”ECB” version=”1.0”/>
90 +1. The standalone concept is not supported in 2.1 and any standalone concept is placed in a Concept Scheme with the Id “STANDALONE_CONCEPT_SCHEME” of the version corresponding to the version of the original standalone concept.
94 94  
95 -(% class="wikigeneratedid" id="HGroup-1" %)
96 -**Group**
92 +===== **Group** =====
97 97  
98 98  (% style="text-align: center;" %)
99 99  [[image:image-20250318221512-9.jpeg]]** **
... ... @@ -100,43 +100,42 @@
100 100  
101 101  **Notes:**
102 102  
103 -1. A Group in (% style="color:#e74c3c" %)version(%%) 2.1 plays the same role as it does in (% style="color:#e74c3c" %)version(%%) 2.0 except that it does not group Series in the [[data set>>doc:sdmx:Glossary.Data set.WebHome]]. The Group in (% style="color:#e74c3c" %)version(%%) 2.1 is used solely as a mechanism to attach [[Attributes>>doc:sdmx:Glossary.Attribute.WebHome]] in the [[data set>>doc:sdmx:Glossary.Data set.WebHome]].
104 -1. The Group in (% style="color:#e74c3c" %)version(%%) 2.1 is retained for compatibility with (% style="color:#e74c3c" %)version(%%) 2.0 and for avoiding repetition in the new [[Attribute Relationship>>doc:sdmx:Glossary.Attribute relationship.WebHome]] construct which is introduced in (% style="color:#e74c3c" %)version(%%) 2.1.
99 +1. A Group in version 2.1 plays the same role as it does in version 2.0 except that it does not group Series in the data set. The Group in version 2.1 is used solely as a mechanism to attach Attributes in the data set.
100 +1. The Group in version 2.1 is retained for compatibility with version 2.0 and for avoiding repetition in the new Attribute Relationship construct which is introduced in version 2.1.
105 105  
106 -(% class="wikigeneratedid" id="HAttributes" %)
107 -**Attributes**
102 +===== Attributes =====
108 108  
104 +(% style="text-align: center;" %)
109 109  [[image:image-20250318221512-10.jpeg||data-xwiki-image-style-alignment="center"]]
110 110  
107 +(% style="text-align: center;" %)
111 111  [[image:image-20250318221512-11.jpeg||data-xwiki-image-style-alignment="center"]]
112 112  
113 -Note that for brevity only the XML of the [[DECIMALS>>doc:sdmx:Glossary.Decimals.WebHome]] (relationship to a group) COLLECTION (relationship to a set of [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]) and OBS_CONF (relationship to the Primary [[Measure>>doc:sdmx:Glossary.Measure.WebHome]]) are shown in full.
110 +Note that for brevity only the XML of the DECIMALS (relationship to a group) COLLECTION (relationship to a set of Dimensions) and OBS_CONF (relationship to the Primary Measure) are shown in full.
114 114  
115 -(% class="wikigeneratedid" id="HNotes-1" %)
116 -**Notes**
112 +===== **Notes** =====
117 117  
118 -1. The [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] has a relationship to either a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] of one or more [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] as described in Chapter 4.
119 -1. [[DECIMALS>>doc:sdmx:Glossary.Decimals.WebHome]] has a relationship to a Group with the Id of Group.
120 -1. COLLECTION has a relationship to a set of [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] – in this case this is, in reality, the [[series key>>doc:sdmx:Glossary.Series key.WebHome]] as this has been converted from (% style="color:#e74c3c" %)version(%%) 2.0. It is possible for an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] to have a relationship with just one, a few, or all of the [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]].
121 -1. OBS_CONF has a relationship with the Primary [[Measure>>doc:sdmx:Glossary.Measure.WebHome]].
114 +1. The Attribute has a relationship to either a data set of one or more Dimensions as described in Chapter 4.
115 +1. DECIMALS has a relationship to a Group with the Id of Group.
116 +1. COLLECTION has a relationship to a set of Dimensions – in this case this is, in reality, the series key as this has been converted from version 2.0. It is possible for an attribute to have a relationship with just one, a few, or all of the Dimensions.
117 +1. OBS_CONF has a relationship with the Primary Measure.
122 122  
123 -(% class="wikigeneratedid" id="HMeasure" %)
124 -**Measure**
119 +===== **Measure** =====
125 125  
121 +(% style="text-align: center;" %)
126 126  [[image:image-20250318221512-12.jpeg||data-xwiki-image-style-alignment="center"]]
127 127  
128 -A typical database schema that can be set up using this [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] is shown below.
124 +A typical database schema that can be set up using this DSD is shown below.
129 129  
130 -(% class="wikigeneratedid" id="HSeriesKeyTable" %)
131 -**Series Key Table**
126 +===== **Series Key Table** =====
132 132  
128 +(% style="text-align: center;" %)
133 133  [[image:image-20250318221902-34.png||data-xwiki-image-style-alignment="center"]]
134 134  
135 135  (% style="text-align: center;" %)
136 136  **{{id name="image_50"/}}Figure 50: Relational Table Structure created from a DSD Dimensions and Related Attributes**
137 137  
138 -(% class="wikigeneratedid" id="HGroup201CGroup201DTable" %)
139 -**Group “Group” Table**
134 +===== **Group “Group” Table** =====
140 140  
141 141  (% style="text-align: center;" %)
142 142  [[image:image-20250318221512-13.jpeg]]** **
... ... @@ -144,9 +144,9 @@
144 144  (% style="text-align: center;" %)
145 145  **{{id name="image_51"/}}Figure 51: Relational Table Structure created from a DSD Group and Related Attributes**
146 146  
147 -(% class="wikigeneratedid" id="HObservation" %)
148 -**Observation**
142 +===== **Observation** =====
149 149  
144 +(% style="text-align: center;" %)
150 150  [[image:image-20250318221512-14.jpeg||data-xwiki-image-style-alignment="center"]]
151 151  
152 152  (% style="text-align: center;" %)
... ... @@ -154,42 +154,43 @@
154 154  
155 155  === 16.4.2 Load Database ===
156 156  
152 +(% style="text-align: center;" %)
157 157  [[image:image-20250318221512-15.jpeg||data-xwiki-image-style-alignment="center"]]
158 158  
159 159  (% style="text-align: center;" %)
160 160  **{{id name="image_53"/}}Figure 53: Loading an SDMX Dataset into a Database **
161 161  
162 -The following is an extract from the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[dataset>>doc:sdmx:Glossary.Data set.WebHome]].
158 +The following is an extract from the SDMX dataset.
163 163  
160 +(% style="text-align: center;" %)
164 164  [[image:image-20250319123255-1.png||data-xwiki-image-style-alignment="center"]]
165 165  
163 +(% style="text-align: center;" %)
166 166  [[image:image-20250319123339-2.png||data-xwiki-image-style-alignment="center"]]
167 167  
168 168  Note that this is a sub set of the actual data message.
169 169  
170 -(% class="wikigeneratedid" id="HNotes-2" %)
171 -**Notes**
168 +===== **Notes** =====
172 172  
173 -1. The reference to the [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] is given in the message header and given a local structureId
174 -1. The local structureId ([[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]]) is referenced from the [[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]
175 -1. A Group does not contain Series in (% style="color:#e74c3c" %)version(%%) 2.1: it is used solely to declare attributes
176 -1. The first in the first has an OBS_VALUE of “NaN”. This is an XML expression that declared a value of “not a number”, thus allowing a “missing value” to be declared.
177 -1. A [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] can contain observations from different frequencies.
170 +1. The reference to the DSD is given in the message header and given a local structureId
171 +1. The local structureId (DSD) is referenced from the DataSet
172 +1. A Group does not contain Series in version 2.1: it is used solely to declare attributes
173 +1. The first <Obs> in the first <Series> has an OBS_VALUE of “NaN”. This is an XML expression that declared a value of “not a number”, thus allowing a “missing value” to be declared.
174 +1. A dataset can contain observations from different frequencies.
178 178  
179 179  The diagrams below show the database content based on the schema created.
180 180  
181 -(% class="wikigeneratedid" id="HSeriesKeyTable-1" %)
182 -**Series Key Table**
178 +===== **Series Key Table** =====
183 183  
180 +(% style="text-align: center;" %)
184 184  [[image:image-20250318221512-16.jpeg||data-xwiki-image-style-alignment="center"]]
185 185  
186 -(% class="wikigeneratedid" id="HGroupTable" %)
187 -**Group Table**
183 +===== **Group Table** =====
188 188  
185 +(% style="text-align: center;" %)
189 189  [[image:image-20250318221512-17.jpeg||data-xwiki-image-style-alignment="center"]]
190 190  
191 -(% class="wikigeneratedid" id="HObservationTable" %)
192 -**Observation Table**
188 +===== **Observation Table** =====
193 193  
194 194  (% style="text-align: center;" %)
195 195  [[image:image-20250318221512-18.jpeg]]** **
... ... @@ -200,31 +200,36 @@
200 200  
201 201  The following registration is submitted to the Registry.
202 202  
199 +(% style="text-align: center;" %)
203 203  [[image:image-20250318221512-19.jpeg||data-xwiki-image-style-alignment="center"]]
204 204  
205 -The [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] web service of the database can now be searched for in the Registry.
202 +The SDMX web service of the database can now be searched for in the Registry.
206 206  
207 207  === 16.4.4 Retrieve and Visualise Category Scheme and Dataflows ===
208 208  
206 +(% style="text-align: center;" %)
209 209  [[image:image-20250318221512-20.jpeg||data-xwiki-image-style-alignment="center"]]
210 210  
211 211  (% style="text-align: center;" %)
212 212  **{{id name="image_54"/}}Figure 54: Building a Search Screen from Structural Metadata**
213 213  
214 -The following REST query will return the [[Category Scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] and Categorisations that reference any of the [[Categories>>doc:sdmx:Glossary.Category.WebHome]] in the scheme.
212 +The following REST query will return the Category Scheme and Categorisations that reference any of the Categories in the scheme.
215 215  
216 216  [[http:~~/~~/ ~[ws-entry-point~]/categoryscheme/ECB/SDW_ECONOMIC_CONCEPTS/1.0?references=parents>>http:// [ws-entry-point]/categoryscheme/ECB/SDW_ECONOMIC_CONCEPTS/1.0?references=parents||rel="noopener noreferrer" target="_blank"]]
217 217  
216 +(% style="text-align: center;" %)
218 218  [[image:image-20250318221512-21.jpeg||data-xwiki-image-style-alignment="center"]]
219 219  
219 +(% style="text-align: center;" %)
220 220  [[image:image-20250318221512-22.jpeg||data-xwiki-image-style-alignment="center"]]
221 221  
222 -The application will now retrieve the [[Dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]] in the list of Categorisations – in this case there is only one – effective exchange rates.
222 +The application will now retrieve the Dataflows in the list of Categorisations – in this case there is only one – effective exchange rates.
223 223  
224 -The following REST query will return the [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]].
224 +The following REST query will return the dataflow.
225 225  
226 226  [[http:~~/~~/ ~[ws-entry-point~]/dataflow/ECB/2034482/1.0>>http:// [ws-entry-point]/dataflow/ECB/2034482/1.0||rel="noopener noreferrer" target="_blank"]]
227 227  
228 +(% style="text-align: center;" %)
228 228  [[image:image-20250318221512-23.jpeg||data-xwiki-image-style-alignment="center"]]
229 229  
230 230  The actual choreography of the query application is dependent upon the implementation but the following is assumed for this example.
... ... @@ -231,40 +231,40 @@
231 231  
232 232  1. Query application queries the Registry for the Provision Agreement.
233 233  1. Query application queries the Registry for data Registrations.
234 -1. If there is a [[data source>>doc:sdmx:Glossary.Data source.WebHome]] registered then the [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] is displayed and can be selected.
235 +1. If there is a data source registered then the dataflow is displayed and can be selected.
235 235  
236 -The following REST query will return any [[provision agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]] referenced from the [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]
237 +The following REST query will return any provision agreements referenced from the dataflow
237 237  
238 238  [[http:~~/~~/~[ws-entry-point~]/dataflow/ECB/2034482/1.0?references=provisionagreement>>http://[ws-entry-point]/dataflow/ECB/2034482/1.0?references=provisionagreement||rel="noopener noreferrer" target="_blank"]]
239 239  
241 +(% style="text-align: center;" %)
240 240  [[image:image-20250318221512-24.jpeg||data-xwiki-image-style-alignment="center"]]
241 241  
242 -(% class="wikigeneratedid" id="HNotes-3" %)
243 -**Notes**
244 +===== **Notes** =====
244 244  
245 -~1. The contains the same identification information as the individual [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] in the tag in the context of the <Dataflow> and tags (the <Dataflow> identifies that the is a DataStructure).
246 +~1. The <URN> contains the same identification information as the individual attributes in the <Ref> tag in the context of the <Dataflow> and <Structure> tags (the <Dataflow> identifies that the <Structure> is a DataStructure).
246 246  
247 -The following REST query will return the [[Data Provider Scheme>>doc:sdmx:Glossary.Data provider scheme.WebHome]] that contains the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] connected to the [[Provision Agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]]. Note that this is not necessary in order to query for the data unless the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]] contains information required by the query application (such as the name of the [[Data Provider>>doc:sdmx:Glossary.Data provider.WebHome]]).
248 +The following REST query will return the Data Provider Scheme that contains the Data Provider connected to the Provision Agreement. Note that this is not necessary in order to query for the data unless the Data Provider contains information required by the query application (such as the name of the Data Provider).
248 248  
249 249  [[http:~~/~~/~[ws-entry-point~]/dataprovider/ECB>>http://[ws-entry-point]/dataprovider/ECB||rel="noopener noreferrer" target="_blank"]]
250 250  
251 -(% class="wikigeneratedid" id="HNotes-4" %)
252 -**Notes**
252 +===== **Notes** =====
253 253  
254 -1.
254 +~1. As an Agency can have only one Data Provider Scheme and this has a mandatory Id of DATA_PROVIDER_SCHEME and must be version 1.0 there is no need to specify any other parameters to the REST query.
255 255  
256 -As an Agency can have only one [[Data Provider Scheme>>doc:sdmx:Glossary.Data provider scheme.WebHome]] and this has a mandatory Id of DATA_PROVIDER_SCHEME and must be (% style="color:#e74c3c" %)version(%%) 1.0 there is no need to specify any other parameters to the REST query.
256 +This returns the following as part of the Data Provider Scheme.
257 257  
258 -This returns the following as part of the [[Data Provider Scheme>>doc:sdmx:Glossary.Data provider scheme.WebHome]].
259 -
258 +(% style="text-align: center;" %)
260 260  [[image:image-20250318221512-25.jpeg||data-xwiki-image-style-alignment="center"]]
261 261  
262 -The following Registry query will return the REST [[data source>>doc:sdmx:Glossary.Data source.WebHome]] referenced in a Registration for the Provision Agreement
261 +The following Registry query will return the REST data source referenced in a Registration for the Provision Agreement
263 263  
263 +(% style="text-align: center;" %)
264 264  [[image:image-20250318221512-26.jpeg||data-xwiki-image-style-alignment="center"]]
265 265  
266 266  The response from this query is:
267 267  
268 +(% style="text-align: center;" %)
268 268  [[image:image-20250318221512-27.jpeg||data-xwiki-image-style-alignment="center"]]
269 269  
270 270  The query application now has the details of the web service to call when making a query, and it also knows that the query expected uses the REST interface.
... ... @@ -271,38 +271,41 @@
271 271  
272 272  [[http:~~/~~/~[ws-entry-point~] /~[RESTParameters~]>>http://[ws-entry-point] /[RESTParameters||rel="noopener noreferrer" target="_blank"]]]
273 273  
274 -Where [ws-entry-point] is the URL of the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] web service and [RESTParameters] are the query parameters.
275 +Where [ws-entry-point] is the URL of the SDMX web service and [RESTParameters] are the query parameters.
275 275  
276 276  The application can now visualize the information it has retrieved from the Registry in a way that is meaningful to the user. An example visualization is shown below.
277 277  
279 +(% style="text-align: center;" %)
278 278  [[image:image-20250318221512-28.jpeg||data-xwiki-image-style-alignment="center"]]
279 279  
280 280  (% style="text-align: center;" %)
281 281  **{{id name="image_55"/}}Figure 55: Example Query Screen Built from SDMX Category Scheme and Dataflows**
282 282  
283 -The user will select the [[Category>>doc:sdmx:Glossary.Category.WebHome]] and this then shows the [[Dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]] that are available and which have data available for query (i.e. there is a Registration). There can be many such [[Dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]] but in this example there is only one.
285 +The user will select the Category and this then shows the Dataflows that are available and which have data available for query (i.e. there is a Registration). There can be many such Dataflows but in this example there is only one.
284 284  
285 285  === 16.4.5 Build Dimension Selection and Logical Query ===
286 286  
289 +(% style="text-align: center;" %)
287 287  [[image:image-20250318221512-29.jpeg||data-xwiki-image-style-alignment="center"]]
288 288  
289 -Clicking on the [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] will cause the query application to query the Registry for the [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] associated to the [[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]. The [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] and the relevant [[codes>>doc:sdmx:Glossary.Code.WebHome]] associated with the [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] are then shown for detailed data selections.
292 +Clicking on the Dataflow will cause the query application to query the Registry for the DSD associated to the Dataflow. The Dimensions and the relevant codes associated with the Dimensions are then shown for detailed data selections.
290 290  
294 +(% style="text-align: center;" %)
291 291  [[image:image-20250318221512-30.jpeg||data-xwiki-image-style-alignment="center"]]
292 292  
293 293  (% style="text-align: center;" %)
294 294  **{{id name="image_56"/}}Figure 56: Selection Screen build from SDMX DSD**
295 295  
296 -The user can click on each of the [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] and the relevant [[code>>doc:sdmx:Glossary.Code.WebHome]] selections are displayed. Note that in the example above the application is assumed to have queries for all the keys so that it can process them in order to grey-out the [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] selections for which there is no data. These are greyed-out based on the current selections in the other [[Dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]. This shows the importance of content (% style="color:#e74c3c" %)constraints(%%) in a web dissemination system, as they can be used to guide the user to make only the selections that will return data. The same result can be achieved if these (% style="color:#e74c3c" %)constraints(%%) are available for query (e.g. in a Registry), but this is a less effective way of processing if the contenrts of the database are dynamic.
300 +The user can click on each of the Dimensions and the relevant code selections are displayed. Note that in the example above the application is assumed to have queries for all the keys so that it can process them in order to grey-out the Dimension selections for which there is no data. These are greyed-out based on the current selections in the other Dimensions. This shows the importance of content constraints in a web dissemination system, as they can be used to guide the user to make only the selections that will return data. The same result can be achieved if these constraints are available for query (e.g. in a Registry), but this is a less effective way of processing if the contenrts of the database are dynamic.
297 297  
298 298  === 16.4.6 Query Database ===
299 299  
304 +(% style="text-align: center;" %)
300 300  [[image:image-20250318221512-31.jpeg||data-xwiki-image-style-alignment="center"]]
301 301  
302 -The logical query of the user is converted to an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] query and sent to the Data Web Service of the data publisher. The Data Web Service may also query the [[Metadata Repository>>doc:sdmx:Glossary.Metadata repository.WebHome]] in order to return both data and related metadata to the user application. The Data Web Service may also require [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] ([[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] and [[MSD>>doc:sdmx:Glossary.Metadata structure definition.WebHome]] and related [[Code Lists>>doc:sdmx:Glossary.Code list.WebHome]] and (% style="color:#e74c3c" %)Concepts(%%)) from the [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] repository, in this example this an [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]].
307 +The logical query of the user is converted to an SDMX query and sent to the Data Web Service of the data publisher. The Data Web Service may also query the Metadata Repository in order to return both data and related metadata to the user application. The Data Web Service may also require structural metadata (DSD and MSD and related Code Lists and Concepts) from the structural metadata repository, in this example this an SDMX Registry.
303 303  
304 -(% class="wikigeneratedid" id="HDataQueryLogicalSelections" %)
305 -**Data Query Logical Selections**
309 +===== **Data Query Logical Selections** =====
306 306  
307 307  (% style="width:551.446px" %)
308 308  |(% style="width:261px" %)**Dimension**|(% style="width:286px" %)**Values**
... ... @@ -313,17 +313,18 @@
313 313  |(% style="width:261px" %)EXR_SUFFIX|(% style="width:286px" %)A
314 314  |(% style="width:261px" %)Time|(% style="width:286px" %)Jan 2008-Dec 2010
315 315  
316 -(% class="wikigeneratedid" id="HRESTQuery" %)
317 -**REST Query**
320 +===== **REST Query** =====
318 318  
319 319  [[http:~~/~~/ws-entry-point/data/2034482/M.Z26+Z28.EUR+CZK+DKK.DFC0+EN00+A /ECB?startPeriod=2008-01&endPeriod=2010-12&detail=dataonly>>http://ws-entry-point/data/2034482/M.Z26+Z28.EUR+CZK+DKK.DFC0+EN00+A /ECB?startPeriod=2008-01&endPeriod=2010-12&detail=dataonly||rel="noopener noreferrer" target="_blank"]]
320 320  
321 321  === 16.4.7 Visualise the Resultant Data Set ===
322 322  
326 +(% style="text-align: center;" %)
323 323  [[image:image-20250318221512-32.jpeg||data-xwiki-image-style-alignment="center" height="310" width="346"]]
324 324  
325 -The returned data and metadata can be presented to the user in many ways – tables, graphs, charts, (% style="color:#e74c3c" %)maps(%%) etc. [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] does not support visualization directly but it is possible to define roles for a [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] and [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] in the [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]]. For instance, it is possible to assign a role of “Geography” or “[[Title>>doc:sdmx:Glossary.Title.WebHome]]” or “[[Measure>>doc:sdmx:Glossary.Measure.WebHome]] Unit” etc. which will aid a data visualization service to present this information in a meaningful way to the user.
329 +The returned data and metadata can be presented to the user in many ways – tables, graphs, charts, maps etc. SDMX does not support visualization directly but it is possible to define roles for a Dimension and Attribute in the DSD. For instance, it is possible to assign a role of “Geography” or “Title” or “Measure Unit” etc. which will aid a data visualization service to present this information in a meaningful way to the user.
326 326  
331 +(% style="text-align: center;" %)
327 327  [[image:image-20250318221512-33.jpeg||data-xwiki-image-style-alignment="center"]]
328 328  
329 329  (% style="text-align: center;" %)