Difference between revisions of "FXLData Wizard"

From Fusion Registry Wiki
Jump to navigation Jump to search
(Guidance)
Line 26: Line 26:
 
* The '''Dataflow''' can be either just the source Dataflow's ID (e.g. EXR) provided that is unique, or the fully-qualified Dataflow identifier (e.g. ECB,EXR,1.0)
 
* The '''Dataflow''' can be either just the source Dataflow's ID (e.g. EXR) provided that is unique, or the fully-qualified Dataflow identifier (e.g. ECB,EXR,1.0)
 
* The Dataflow drop down provides an up to date list of all dataflows from the selected Fusion Registry that contain data
 
* The Dataflow drop down provides an up to date list of all dataflows from the selected Fusion Registry that contain data
* The '''Start Period''' and '''End Period''' select only observations between those dates which must be in [[SDMX Time Formats|SDMX time format]]
+
* The '''Start Period''' and '''End Period''' select only observations between those dates which must be in [[SDMX Time Formats|SDMX time format]] - both are optional
* If Start Period and / or End Period are not set, all available observations will be selected
+
* '''REST Args''' allows additional data [[Data Query Web Service|REST query arguments]] to be set such as rounding, calculated measures, dimension at observation and aggregations
 +
* The REST Args expression must follow the standard syntax for URL parameters using '&' as a separator , e.g. ''round=2&attributes=UNIT''
 +
* Favourite Rest Arg expressions can be saved and deleted using the '''+''' and '''-''' buttons - the '''?''' button provides help on the available arguments and their usage

Revision as of 01:45, 5 October 2021

An Excel ribbon bar tool for interactively building and editing FXLData functions

Overview

The FXLData Wizard is part of the FXLData add-in for Excel which provides a collection of functions for retrieving statistical data from a Fusion Registry directly into a worksheet.

The Wizard helps in the task of building and modifying =FXLData() and =FXLDataV() functions which take a number of parameters including the Fusion Registry to connect to, the Dataflow and a data query expression - typically an SDMX series key.

FXLData Wizard Ribbon.png

Installing the FXLData-add on Excel adds a FXLData menu option and the ƒx button to the ribbon which launches the Wizard.

  • Select a blank cell in the worksheet and launch the Wizard to create a new FXLData function.
  • Modify an existing =FXLData() or = FXLDataV() function by selecting the worksheet cell before launching the Wizard.

Wizard

FXLData Wizard Example with Annotations.jpg

Guidance

  • All parameters can take either a literal value (e.g. a number or a text string), a cell reference (e.g. A4) or an Excel formula (e.g. sum(A4,A6))
  • A parameter's result value is shown to the right which is just the literal, the contents of the referenced cell, or the result of the Excel formula
  • Red indicates the value is not valid
  • Use the Apply button to apply changes made in the Wizard to the worksheet
  • The FXLData function is refreshed automatically everytime the Apply button is clicked
  • The Registry URL is the base URL of the Fusion Registry data source - the same URL used to access the web user interface
  • Use the + and - buttons to add and remove favourite Fusion Registries from the drop down list - the Def button sets the default
  • The Dataflow can be either just the source Dataflow's ID (e.g. EXR) provided that is unique, or the fully-qualified Dataflow identifier (e.g. ECB,EXR,1.0)
  • The Dataflow drop down provides an up to date list of all dataflows from the selected Fusion Registry that contain data
  • The Start Period and End Period select only observations between those dates which must be in SDMX time format - both are optional
  • REST Args allows additional data REST query arguments to be set such as rounding, calculated measures, dimension at observation and aggregations
  • The REST Args expression must follow the standard syntax for URL parameters using '&' as a separator , e.g. round=2&attributes=UNIT
  • Favourite Rest Arg expressions can be saved and deleted using the + and - buttons - the ? button provides help on the available arguments and their usage