Difference between revisions of "A beginners guide to Fusion Data Browser"

From Fusion Registry Wiki
Jump to navigation Jump to search
(→‎Manage Dataflows)
(→‎Functions available)
 
(71 intermediate revisions by the same user not shown)
Line 3: Line 3:
 
[[Category:FDB Functions]]
 
[[Category:FDB Functions]]
  
−
Before using this Guide, please ensure that Fusion Data Bowater has been installed, configured and that all the steps in this article have been considered.
+
=Overview=
 +
Is Fusion Data Browser installed? '''''Click the link''''' to read [[Fusion_Data_Browser| the Overview article and installation and configuration details]].
 +
 
  
−
==Overview==
 
 
Fusion Data Browser is a web tool for data consumers to explore the Fusion Registry data catalogue, create charts and tables, and download data.
 
Fusion Data Browser is a web tool for data consumers to explore the Fusion Registry data catalogue, create charts and tables, and download data.
  
Line 21: Line 22:
 
The image above shows the Fusion Data Browser is its initial state. There has been no activity so far. In order to start using the Browser, you must have data which has been published or registered.
 
The image above shows the Fusion Data Browser is its initial state. There has been no activity so far. In order to start using the Browser, you must have data which has been published or registered.
  
−
==Dataset Navigation==
+
=Dataset Navigation=
 +
<br>
  
 
[[File:Navigation1.png|800px]]
 
[[File:Navigation1.png|800px]]
  
−
===Series List===
+
==Series List==
 
In the example below you can see that Poverty has been selected from the Navigation panel and in the mid section you will see a list of series.
 
In the example below you can see that Poverty has been selected from the Navigation panel and in the mid section you will see a list of series.
 +
  
 
[[File:Poverty1.png|1000px]]
 
[[File:Poverty1.png|1000px]]
  
−
====Functions available ====
+
===Functions available ===
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 40: Line 43:
 
| Dataset Name || [[File:FDB DS Name.png|60px]] || Return to the Series List.
 
| Dataset Name || [[File:FDB DS Name.png|60px]] || Return to the Series List.
 
|-
 
|-
−
| Share || [[File:FDB Share.png|50px]]||Creates a URL of the Page or the Query. This URL can be opened directly or copied to the clipboard. You can use this feature to send the URL which can be opened by anyone with that URL. The source Registry must be running for an ‘outsider’ to view the query. You can learn more about Sharing URLs [[Data_Browser_Share_URL | Share URL]] in this article.
+
| Share || [[File:FDB Share.png|50px]]||Creates a URL of the Page or the Query. This URL can be opened directly or copied to the clipboard. You can use this feature to send the URL which can be opened by anyone with that URL. The source Registry must be running for an ‘outsider’ to view the query. You can learn more about Sharing URLs [[Data_Browser_Share_URL|in this article]].
 
|-
 
|-
−
| Save || [[File:FDB Save.png|50px]]|| This enables you to save a Query. You can learn more about Saving Queries [[Data_Browser_Configuration | Data Browser Configuration]] in this article.
+
| Save || [[File:FDB Save.png|50px]]|| This enables you to save a Query. You can learn more about Saving Queries [[Data_Browser_Queries | Data Browser Queries]] in this article.
 
|-
 
|-
 
| Series Basket|| [[File:FDB Series Basket.png|50px]]|| This enables you to save a selection of series to a new or existing basket. You can learn more about Series Baskets [[Series_Basket | in this article]].  
 
| Series Basket|| [[File:FDB Series Basket.png|50px]]|| This enables you to save a selection of series to a new or existing basket. You can learn more about Series Baskets [[Series_Basket | in this article]].  
Line 55: Line 58:
 
|}
 
|}
  
−
===Data Browser Table===
+
==Data Browser Table==
  
 
Clicking the [[File:FDB Table.png|50px]]  button will open up the Table View as shown in the example below.
 
Clicking the [[File:FDB Table.png|50px]]  button will open up the Table View as shown in the example below.
Line 61: Line 64:
 
[[File:Data_Browser_Table_View.png|1000px]]
 
[[File:Data_Browser_Table_View.png|1000px]]
  
−
====Functions available here====
+
===Functions available===
  
 
{| class="wikitable"
 
{| class="wikitable"
Line 87: Line 90:
 
|}
 
|}
  
−
==Saved Queries, Charts and Baskets==
+
=Search=
 +
The Data Browser provides a Free Text search and a Short Code search.
 +
 
 +
 
 +
[[File:FDB-Search.png|1000px]]
 +
 
 +
 
 +
You can learn more about the search function [[Search_Fusion_Data_Browser|in this article]].
 +
 
 +
=Saved Queries, Charts and Baskets=
 +
 
 +
==Saved Queries==
 +
In the example below, there are 3 saved queries for the Dataset Nutrition. To learn more about creating queries, please [[Data_Browser_Query| refer to this article]].
 +
 
 +
 
 +
[[File:FDB-saved-query1.png|700px]]
 +
 
 +
 
 +
Please note that these queries are Private (Local) queries and as such are only available to you as described in [[Data_Browser_-_Saved_User_Data| this article.]].
 +
 
 +
Once a Query has been saved, to run it, just click the link. This will open up the Series List with that relevant data.
 +
 
 +
Queries may not be edited, only deleted via the Management option Manage Saved Queries.
 +
 
 +
==Saved Charts==
 +
In the example below, there are 3 saved charts for the Dataset External Trade. One is a Tire Series Chart [[Data_Browser_Time_Series_Chart| click here to read more about Time Series charts]], the other two are Table Charts [[Data_Browser_Table|click here to read more about Table Charts]].
 +
 
 +
 
  
 +
[[File:FDB-saved-charts-1.png|700px]]
  
−
==Search==
 
  
 +
Please note that Charts  are Private (Local) and as such are only available to you as described in [[Data_Browser_-_Saved_User_Data| this article.]].
  
−
==Management options==
+
Once a Chart has been saved, to run it, just click the link. This will open up the Chart List with that relevant data.
 +
 
 +
Charts may not be edited, only deleted via the Management option Manage Saved Charts.
 +
 
 +
==Saved Series Baskets==
 +
In the example below, there is a saved query for the Dataset Poverty. To learn more about Series Baskets  please [[Series_Basket| refer to this article]].
 +
 
 +
 
 +
[[File:FDB-saved-series-basket-1.png|700px]]
 +
 
 +
 
 +
Please note that the Series Baskets are Private (Local) and as such are only available to you as described in [[Data_Browser_-_Saved_User_Data| this article.]].
 +
 
 +
Once a Basket has been saved, to run it, just click the link. This will open up the Series List with that relevant data.
 +
 
 +
Series Baskets can be added to (subject to the limitation of 200 series) or deleted via the Bin tool as shown below.
 +
 
 +
 
 +
[[File:FDB-delete series-basket-1.png|700px]]
 +
 
 +
 
 +
 
 +
=Management options=
  
 
These are available from the Blue menu button as shown below.
 
These are available from the Blue menu button as shown below.
  
−
[[File:FDB-Management Options-1.png|800.px]]
+
[[File:FDB-Management Options-1.png|1000px]]
  
−
===Login / Logout===
+
==Login / Logout==
 
This menu allows you to Login and Out however please note that if you are already logged into Fusion Registry when you open the Data Browser, you will be logged in automatically.  
 
This menu allows you to Login and Out however please note that if you are already logged into Fusion Registry when you open the Data Browser, you will be logged in automatically.  
  
Line 106: Line 159:
 
To use the options Manage Pre-Defined Queries and Managed Dataflows, you must be logged in as these are system wide features.
 
To use the options Manage Pre-Defined Queries and Managed Dataflows, you must be logged in as these are system wide features.
  
−
===Locale:en===
+
==Locale:en==
  
 
This option allows you to use any of the languages configured in the property files - you need to have the appropriate language identified in the siteconfig.json, for example:  
 
This option allows you to use any of the languages configured in the property files - you need to have the appropriate language identified in the siteconfig.json, for example:  
Line 115: Line 168:
 
You can learn more about languages [[Data_Browser_Locale|in this article]].
 
You can learn more about languages [[Data_Browser_Locale|in this article]].
  
−
===Saved Queries===
+
==Saved Queries==
 
When a query is saved, there is an option to save the query as Private (saved local) (this relates to User as described [[Data_Browser_-_Saved_User_Data|here]] or Public.
 
When a query is saved, there is an option to save the query as Private (saved local) (this relates to User as described [[Data_Browser_-_Saved_User_Data|here]] or Public.
  
 
This option allows you to manage (Delete) Local (Private) queries.
 
This option allows you to manage (Delete) Local (Private) queries.
 +
  
 
[[File:FDB Manage Local Query.png|800px]]
 
[[File:FDB Manage Local Query.png|800px]]
 +
  
 
To Manage Public Queries, you need to be logged in AND select the option Management option Pre-Defined Queries.
 
To Manage Public Queries, you need to be logged in AND select the option Management option Pre-Defined Queries.
  
−
===Saved Charts===
+
You can learn more about Data Browser Queries [[Data_Browser_Queries|here]].
 +
 
 +
==Saved Charts==
 +
Note that Table Charts and Time Series Charts are managed here.
 +
 
 
Charts are saved as Private, i.e., locally to the user as described in  [[Data_Browser_-_Saved_User_Data|this article]].
 
Charts are saved as Private, i.e., locally to the user as described in  [[Data_Browser_-_Saved_User_Data|this article]].
  
−
This option allows you to manage (Delete) Local Charts.
+
This option allows you to manage (Delete) Local Charts.  
  
−
[[File:FDB Manage Local Chart.png|800px]]
 
  
−
===Pre-Defined Queries===
+
[[File:FDB-Manage-Saved-Chart.png|800px]]
 +
 
 +
==Pre-Defined Queries==
 
This option is only available to a logged on user. You can read more about Pre-Defined Queries [[Data_Browser_Pre-Defined_Queries|in this article]].
 
This option is only available to a logged on user. You can read more about Pre-Defined Queries [[Data_Browser_Pre-Defined_Queries|in this article]].
 +
  
 
[[File:FDB Manage -pdq 1.png|800px]]
 
[[File:FDB Manage -pdq 1.png|800px]]
  
−
Options available:
 
  
−
====Delete====
+
'''Options available:'''
 +
 
 +
===Delete===
 
Use this option to delete the query for all users.
 
Use this option to delete the query for all users.
  
−
====Run Query====
+
===Run Query===
 
Use this option to run the query, it will open up the Series List (for that query).
 
Use this option to run the query, it will open up the Series List (for that query).
  
−
====Linked Categories====
+
===Linked Categories (PDQ)===
 
Pe-Defined Categories can appear on the dataset list as shown in the example below.
 
Pe-Defined Categories can appear on the dataset list as shown in the example below.
 +
  
 
[[File:FDB Manage -pdq 2.png|800px]]
 
[[File:FDB Manage -pdq 2.png|800px]]
 +
  
 
The Manage option Linked categories enables you to do this. First, select the Pre-Defined Query then click Linked Categories to display a list of all categories within any categorisation scheme available.
 
The Manage option Linked categories enables you to do this. First, select the Pre-Defined Query then click Linked Categories to display a list of all categories within any categorisation scheme available.
 +
  
 
[[File:FDB Manage -pdq 3.png|800px]]
 
[[File:FDB Manage -pdq 3.png|800px]]
 +
  
 
Select the Categorisation(s) to use then Save the changes. The Pre-Defined Query will appear on the Datasets list.
 
Select the Categorisation(s) to use then Save the changes. The Pre-Defined Query will appear on the Datasets list.
Line 157: Line 223:
 
Note, the Categories are also available to view, add or delete via Fusion the Registry Categorisations option. You can read more [[Category_Schemes_and_Categorisations|in this article]].
 
Note, the Categories are also available to view, add or delete via Fusion the Registry Categorisations option. You can read more [[Category_Schemes_and_Categorisations|in this article]].
  
−
===Manage Dataflows===
+
==Manage Dataflows==
  
 
The Manage Dataflows option enables you to specify how the Dataset is to appear in the Dataset list (in the same manner as the Pre-Defined Queries described above) and in the series list.
 
The Manage Dataflows option enables you to specify how the Dataset is to appear in the Dataset list (in the same manner as the Pre-Defined Queries described above) and in the series list.
  
−
====Series List====
+
===Series List===
  
 
[[File:FDB-Manage-Dataflow series list.png|800.px]]
 
[[File:FDB-Manage-Dataflow series list.png|800.px]]
 +
  
 
When you select Manage Dataflows a list of all Dataflows will appear, you can use the quick filter to find the one you want to manage.
 
When you select Manage Dataflows a list of all Dataflows will appear, you can use the quick filter to find the one you want to manage.
 +
  
 
[[File:FDB-Manage-Dataflow2.png|800px]]
 
[[File:FDB-Manage-Dataflow2.png|800px]]
Line 171: Line 239:
 
===Series Display===
 
===Series Display===
  
−
=====Textural options=====
+
====Textural options====
 
[[File:FDB-Manage dataflow-test.png|1200px]]
 
[[File:FDB-Manage dataflow-test.png|1200px]]
  
−
====Quick Filters Display====
+
===Quick Filters Display===
 
Three options are available:
 
Three options are available:
  
Line 188: Line 256:
 
[[File:FDB-Manage-Dataflow3.png|800px]]
 
[[File:FDB-Manage-Dataflow3.png|800px]]
  
−
====Decimal Places====
+
===Decimal Places===
 
There is no default so if you make any changes to this feature, you must specify a number of decimal places.
 
There is no default so if you make any changes to this feature, you must specify a number of decimal places.
  
 
When done, click Save. To see the changes, reload the Dataset.
 
When done, click Save. To see the changes, reload the Dataset.
 +
 +
===Linked Categories (DF)===
 +
 +
Linked Categories can appear on the dataset list as shown in the example below.
 +
 +
 +
[[File:FDB Manage -pdq 2.png|800px]]
 +
 +
 +
The Manage Dataflow option Linked categories enables you to do this. First, select the Dataflow then click Linked Categories to display a list of all categories within any categorisation scheme available.
 +
 +
[[File:FDB Manage -pdq 3.png|800px]]
 +
 +
 +
Select the Categorisation(s) to use then Save the changes. The Category will appear on the Datasets list.
 +
 +
Note, the Categories are also available to view, add or delete via Fusion the Registry Categorisations option. You can read more [[Category_Schemes_and_Categorisations|in this article]].
 +
 +
=Recent Activity=
 +
 +
Once you start using Fusion Data Browser, the welcome Panel is replaced by the Recent Activity panel.
 +
 +
[[File:FDB-Recent-Activity.png|1000px]]
 +
 +
This is User specific and shows details of Datasets which have been opened as well as Series Baskets.
 +
 +
Is is possible to clear this activity, for example, using Chrome, select Delete Browsing data then delete the Cookies as shown below.
 +
 +
[[File:FDB-Recent-Activity-clear.png|300px]]
 +
 +
 +
However, if you do this, '''the saved Queries, Charts and Series Baskets will also be deleted.'''
  
 
==Useful Articles==
 
==Useful Articles==
Line 209: Line 309:
  
 
[[Data_Browser_Pre-Defined_Queries|Pre-Defined Queries]]
 
[[Data_Browser_Pre-Defined_Queries|Pre-Defined Queries]]
 +
 +
[[Series_List| Fusion Data Browser Series List]]
 +
 +
[[Search_Fusion_Data_Browser|Search Fusion Data Browser]]

Latest revision as of 10:43, 14 October 2024


Overview

Is Fusion Data Browser installed? Click the link to read the Overview article and installation and configuration details.


Fusion Data Browser is a web tool for data consumers to explore the Fusion Registry data catalogue, create charts and tables, and download data.

Key areas.png

There are 4 key areas of functionality to consider:

  • Dataset Navigation
  • Saved Queries, Charts and Baskets
  • Search
  • Management options

However, before any of the other functions can be used, you must start with data.

The image above shows the Fusion Data Browser is its initial state. There has been no activity so far. In order to start using the Browser, you must have data which has been published or registered.

Dataset Navigation


Navigation1.png

Series List

In the example below you can see that Poverty has been selected from the Navigation panel and in the mid section you will see a list of series.


Poverty1.png

Functions available

Function Display Effect
Home FDB-Home.png This will return you to the Home page.
Dataset Name FDB DS Name.png Return to the Series List.
Share FDB Share.png Creates a URL of the Page or the Query. This URL can be opened directly or copied to the clipboard. You can use this feature to send the URL which can be opened by anyone with that URL. The source Registry must be running for an ‘outsider’ to view the query. You can learn more about Sharing URLs in this article.
Save FDB Save.png This enables you to save a Query. You can learn more about Saving Queries Data Browser Queries in this article.
Series Basket FDB Series Basket.png This enables you to save a selection of series to a new or existing basket. You can learn more about Series Baskets in this article.
Export Data FDB Download.png This enables you to Export the data. You can learn more about the Export options in this article.
Series List FDB Series List.png This button is only active if you have moved to the Table or Time series display. If you are using one of these, clicking the Series List button will return you to the list as displayed above. You can learn more about the Export options in this article.
Table FDB Table.png This button is active from the Series List and opens up the Data Browser Table which is explained further in this article.
Time Series FDB Time Series.png This button is active from Series List and opens up the Data Browser Time Series Chart which is explained further in this article.

Data Browser Table

Clicking the FDB Table.png button will open up the Table View as shown in the example below.

Data Browser Table View.png

Functions available

Function Display Effect
Save FDB Save.png This enables you to save a Chart. You can learn more about Saving Charts Data Browser Configuration in this article.
Export Data FDB Download.png This enables you to Export the data. You can learn more about the Export options in this article.
Calculations FDB Calculations.png This button enables you to perform Calculations, the Table view will be updated accordingly. You can learn more about Calculations Data Browser Table Calculations in this article
Dataset Period [[File:FDB Dataset Period.png|50px] This button allows you to define a start and end period and or specify the (last) number of observations to be displayed in the Data Table.
H1 FDB Table Title.png This button allows you to create a title, and a sub-title for a chart which will appear on the Table view. You can enter free text or use the lookup feature to obtain a title from components in the Data Structure.
Share FDB Share.png Creates a URL of the Page or the Query. This URL can be opened directly or copied to the clipboard. You can use this feature to send the URL which can be opened by anyone with that URL. The source Registry must be running for an ‘outsider’ to view the query. You can learn more about Sharing URLs Share URL in this article.
Series List FDB Series List.png This button is only active if you have moved to the Table or Time series display. If you are using one of these, clicking the Series List button will return you to the list as displayed above. You can learn more about the Export options in this article.
Table FDB Table.png This button is active from the Series List and opens up the Data Browser Table which is explained further in this article.
Time Series FDB Time Series.png This button is active from the Table and opens up the Data Browser Time Series Chart which is explained further in this article.

Search

The Data Browser provides a Free Text search and a Short Code search.


FDB-Search.png


You can learn more about the search function in this article.

Saved Queries, Charts and Baskets

Saved Queries

In the example below, there are 3 saved queries for the Dataset Nutrition. To learn more about creating queries, please refer to this article.


FDB-saved-query1.png


Please note that these queries are Private (Local) queries and as such are only available to you as described in this article..

Once a Query has been saved, to run it, just click the link. This will open up the Series List with that relevant data.

Queries may not be edited, only deleted via the Management option Manage Saved Queries.

Saved Charts

In the example below, there are 3 saved charts for the Dataset External Trade. One is a Tire Series Chart click here to read more about Time Series charts, the other two are Table Charts click here to read more about Table Charts.


FDB-saved-charts-1.png


Please note that Charts are Private (Local) and as such are only available to you as described in this article..

Once a Chart has been saved, to run it, just click the link. This will open up the Chart List with that relevant data.

Charts may not be edited, only deleted via the Management option Manage Saved Charts.

Saved Series Baskets

In the example below, there is a saved query for the Dataset Poverty. To learn more about Series Baskets please refer to this article.


FDB-saved-series-basket-1.png


Please note that the Series Baskets are Private (Local) and as such are only available to you as described in this article..

Once a Basket has been saved, to run it, just click the link. This will open up the Series List with that relevant data.

Series Baskets can be added to (subject to the limitation of 200 series) or deleted via the Bin tool as shown below.


FDB-delete series-basket-1.png


Management options

These are available from the Blue menu button as shown below.

FDB-Management Options-1.png

Login / Logout

This menu allows you to Login and Out however please note that if you are already logged into Fusion Registry when you open the Data Browser, you will be logged in automatically.

The Management Options Managing Saved Charts and Queries is a user related function as explained in this article and there is no need to Login.

To use the options Manage Pre-Defined Queries and Managed Dataflows, you must be logged in as these are system wide features.

Locale:en

This option allows you to use any of the languages configured in the property files - you need to have the appropriate language identified in the siteconfig.json, for example: 

  "Locales" : ["en", "he", "ru"],

And a corresponding language property file must exist: for example: Browser_lang_he.json

You can learn more about languages in this article.

Saved Queries

When a query is saved, there is an option to save the query as Private (saved local) (this relates to User as described here or Public.

This option allows you to manage (Delete) Local (Private) queries.


FDB Manage Local Query.png


To Manage Public Queries, you need to be logged in AND select the option Management option Pre-Defined Queries.

You can learn more about Data Browser Queries here.

Saved Charts

Note that Table Charts and Time Series Charts are managed here.

Charts are saved as Private, i.e., locally to the user as described in this article.

This option allows you to manage (Delete) Local Charts.


FDB-Manage-Saved-Chart.png

Pre-Defined Queries

This option is only available to a logged on user. You can read more about Pre-Defined Queries in this article.


FDB Manage -pdq 1.png


Options available:

Delete

Use this option to delete the query for all users.

Run Query

Use this option to run the query, it will open up the Series List (for that query).

Linked Categories (PDQ)

Pe-Defined Categories can appear on the dataset list as shown in the example below.


FDB Manage -pdq 2.png


The Manage option Linked categories enables you to do this. First, select the Pre-Defined Query then click Linked Categories to display a list of all categories within any categorisation scheme available.


FDB Manage -pdq 3.png


Select the Categorisation(s) to use then Save the changes. The Pre-Defined Query will appear on the Datasets list.

Note, the Categories are also available to view, add or delete via Fusion the Registry Categorisations option. You can read more in this article.

Manage Dataflows

The Manage Dataflows option enables you to specify how the Dataset is to appear in the Dataset list (in the same manner as the Pre-Defined Queries described above) and in the series list.

Series List

800.px


When you select Manage Dataflows a list of all Dataflows will appear, you can use the quick filter to find the one you want to manage.


FDB-Manage-Dataflow2.png

Series Display

Textural options

FDB-Manage dataflow-test.png

Quick Filters Display

Three options are available:

None No filters will be displayed on the Series List but you can use all the filters available to a specific Dataset via the Table view.

Include all Dimensions Every available option will be included. Note that attributes can only be used as filters via the Table view.

Pick Specific Dimension If you select this option, a list of available Dimensions will be displayed, you can select as shown below.

FDB-Manage-Dataflow3.png

Decimal Places

There is no default so if you make any changes to this feature, you must specify a number of decimal places.

When done, click Save. To see the changes, reload the Dataset.

Linked Categories (DF)

Linked Categories can appear on the dataset list as shown in the example below.


FDB Manage -pdq 2.png


The Manage Dataflow option Linked categories enables you to do this. First, select the Dataflow then click Linked Categories to display a list of all categories within any categorisation scheme available.

FDB Manage -pdq 3.png


Select the Categorisation(s) to use then Save the changes. The Category will appear on the Datasets list.

Note, the Categories are also available to view, add or delete via Fusion the Registry Categorisations option. You can read more in this article.

Recent Activity

Once you start using Fusion Data Browser, the welcome Panel is replaced by the Recent Activity panel.

FDB-Recent-Activity.png

This is User specific and shows details of Datasets which have been opened as well as Series Baskets.

Is is possible to clear this activity, for example, using Chrome, select Delete Browsing data then delete the Cookies as shown below.

FDB-Recent-Activity-clear.png


However, if you do this, the saved Queries, Charts and Series Baskets will also be deleted.

Useful Articles

Saving Data Browser Queries

Data Browser Export Functions

Share URL

Data Browser Table

Data Browser Time Series Chart

Calculations in the Data Table

Working with Queries

Pre-Defined Queries

Fusion Data Browser Series List

Search Fusion Data Browser

Retrieved from "https://wiki.sdmxcloud.org/index.php?title=A_beginners_guide_to_Fusion_Data_Browser&oldid=7311"