Changes for page 16 Annex 6: Worked Use Case

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

From 4.3 to 4.2 From 6.1 to 5.1

From version 5.1

edited by Helena
on 2025/05/23 22:14

Change comment: There is no comment for this version

To version 4.3

edited by Helena
on 2025/05/23 22:10

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -99,8 +99,8 @@
  **Notes:**
--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]].
--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.
++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.
++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.
  (% class="wikigeneratedid" id="HAttributes" %)
  **Attributes**
@@ -109,15 +109,15 @@
  [[image:image-20250318221512-11.jpeg||data-xwiki-image-style-alignment="center"]]
--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.
++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.
  (% class="wikigeneratedid" id="HNotes-1" %)
  **Notes**
--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.
--1. [[DECIMALS>>doc:sdmx:Glossary.Decimals.WebHome]] has a relationship to a Group with the Id of Group.
--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]].
--1. OBS_CONF has a relationship with the Primary [[Measure>>doc:sdmx:Glossary.Measure.WebHome]].
++1. The Attribute has a relationship to either a data set of one or more Dimensions as described in Chapter 4.
++1. DECIMALS has a relationship to a Group with the Id of Group.
++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.
++1. OBS_CONF has a relationship with the Primary Measure.
  (% class="wikigeneratedid" id="HMeasure" %)
  **Measure**
@@ -124,7 +124,7 @@
  [[image:image-20250318221512-12.jpeg||data-xwiki-image-style-alignment="center"]]
--A typical database schema that can be set up using this [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] is shown below.
++A typical database schema that can be set up using this DSD is shown below.
  (% class="wikigeneratedid" id="HSeriesKeyTable" %)
  **Series Key Table**
@@ -158,7 +158,7 @@
  (% style="text-align: center;" %)
  **{{id name="image_53"/}}Figure 53: Loading an SDMX Dataset into a Database **
--The following is an extract from the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[dataset>>doc:sdmx:Glossary.Data set.WebHome]].
++The following is an extract from the SDMX dataset.
  [[image:image-20250319123255-1.png||data-xwiki-image-style-alignment="center"]]
@@ -169,11 +169,11 @@
  (% class="wikigeneratedid" id="HNotes-2" %)
  **Notes**
--1. The reference to the [[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]] is given in the message header and given a local structureId
--1. The local structureId ([[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]]) is referenced from the [[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]
--1. A Group does not contain Series in (% style="color:#e74c3c" %)version(%%) 2.1: it is used solely to declare attributes
--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.
--1. A [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] can contain observations from different frequencies.
++1. The reference to the DSD is given in the message header and given a local structureId
++1. The local structureId (DSD) is referenced from the DataSet
++1. A Group does not contain Series in version 2.1: it is used solely to declare attributes
++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.
++1. A dataset can contain observations from different frequencies.
  The diagrams below show the database content based on the schema created.
@@ -201,7 +201,7 @@
  [[image:image-20250318221512-19.jpeg||data-xwiki-image-style-alignment="center"]]
--The [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] web service of the database can now be searched for in the Registry.
++The SDMX web service of the database can now be searched for in the Registry.
  === 16.4.4 Retrieve and Visualise Category Scheme and Dataflows ===
@@ -210,7 +210,7 @@
  (% style="text-align: center;" %)
  **{{id name="image_54"/}}Figure 54: Building a Search Screen from Structural Metadata**
--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.
++The following REST query will return the Category Scheme and Categorisations that reference any of the Categories in the scheme.
  [[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"]]
@@ -218,9 +218,9 @@
  [[image:image-20250318221512-22.jpeg||data-xwiki-image-style-alignment="center"]]
--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.
++The application will now retrieve the Dataflows in the list of Categorisations – in this case there is only one – effective exchange rates.
--The following REST query will return the [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]].
++The following REST query will return the dataflow.
  [[http:~~/~~/ ~[ws-entry-point~]/dataflow/ECB/2034482/1.0>>http:// [ws-entry-point]/dataflow/ECB/2034482/1.0||rel="noopener noreferrer" target="_blank"]]
@@ -230,9 +230,9 @@
 . Query application queries the Registry for the Provision Agreement.
 . Query application queries the Registry for data Registrations.
--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.
++1. If there is a data source registered then the dataflow is displayed and can be selected.
--The following REST query will return any [[provision agreements>>doc:sdmx:Glossary.Provision agreement.WebHome]] referenced from the [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]
++The following REST query will return any provision agreements referenced from the dataflow
  [[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"]]
@@ -241,9 +241,9 @@
  (% class="wikigeneratedid" id="HNotes-3" %)
  **Notes**
--~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).
++~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).
--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]]).
++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).
  [[http:~~/~~/~[ws-entry-point~]/dataprovider/ECB>>http://[ws-entry-point]/dataprovider/ECB||rel="noopener noreferrer" target="_blank"]]
@@ -250,15 +250,13 @@
  (% class="wikigeneratedid" id="HNotes-4" %)
  **Notes**
--1.
++~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.
--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.
++This returns the following as part of the Data Provider Scheme.
--This returns the following as part of the [[Data Provider Scheme>>doc:sdmx:Glossary.Data provider scheme.WebHome]].
--
  [[image:image-20250318221512-25.jpeg||data-xwiki-image-style-alignment="center"]]
--The following Registry query will return the REST [[data source>>doc:sdmx:Glossary.Data source.WebHome]] referenced in a Registration for the Provision Agreement
++The following Registry query will return the REST data source referenced in a Registration for the Provision Agreement
  [[image:image-20250318221512-26.jpeg||data-xwiki-image-style-alignment="center"]]
@@ -270,7 +270,7 @@
  [[http:~~/~~/~[ws-entry-point~] /~[RESTParameters~]>>http://[ws-entry-point] /[RESTParameters||rel="noopener noreferrer" target="_blank"]]]
--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.
++Where [ws-entry-point] is the URL of the SDMX web service and [RESTParameters] are the query parameters.
  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.
@@ -279,13 +279,13 @@
  (% style="text-align: center;" %)
  **{{id name="image_55"/}}Figure 55: Example Query Screen Built from SDMX Category Scheme and Dataflows**
--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.
++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.
  === 16.4.5 Build Dimension Selection and Logical Query ===
  [[image:image-20250318221512-29.jpeg||data-xwiki-image-style-alignment="center"]]
--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.
++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.
  [[image:image-20250318221512-30.jpeg||data-xwiki-image-style-alignment="center"]]
@@ -292,13 +292,13 @@
  (% style="text-align: center;" %)
  **{{id name="image_56"/}}Figure 56: Selection Screen build from SDMX DSD**
--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.
++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.
  === 16.4.6 Query Database ===
  [[image:image-20250318221512-31.jpeg||data-xwiki-image-style-alignment="center"]]
--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]].
++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.
  (% class="wikigeneratedid" id="HDataQueryLogicalSelections" %)
  **Data Query Logical Selections**
@@ -321,7 +321,7 @@
  [[image:image-20250318221512-32.jpeg||data-xwiki-image-style-alignment="center" height="310" width="346"]]
--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.
++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.
  [[image:image-20250318221512-33.jpeg||data-xwiki-image-style-alignment="center"]]