Difference between revisions of "FXLData()"
(Created page with "Category:Functions Reference FXLData ==FXLData()== By default ƒ<sub>''x''</sub> =FXLData() returns a horizontal time-series dataset, one series per row with time spannin...") |
|||
Line 1: | Line 1: | ||
[[Category:Functions Reference FXLData]] | [[Category:Functions Reference FXLData]] | ||
− | |||
By default ƒ<sub>''x''</sub> =FXLData() returns a horizontal time-series dataset, one series per row with time spanning the columns i.e. time is the dimension at observation. A different dimension at observation can be chosen using the RestAuguments parameter - refer to the guidance [[#Dimension at Observation|below]]. | By default ƒ<sub>''x''</sub> =FXLData() returns a horizontal time-series dataset, one series per row with time spanning the columns i.e. time is the dimension at observation. A different dimension at observation can be chosen using the RestAuguments parameter - refer to the guidance [[#Dimension at Observation|below]]. | ||
Revision as of 04:12, 22 July 2024
By default ƒx =FXLData() returns a horizontal time-series dataset, one series per row with time spanning the columns i.e. time is the dimension at observation. A different dimension at observation can be chosen using the RestAuguments parameter - refer to the guidance below.
Use Case
This parameterised form is suitable for hard coding in a spreadsheet. Like all Excel functions, the arguments can be literal values, cell references or Excel expressions allowing the creation of complex data models. In its simplest form, only three arguments are required:
- The 'base URL' of the Fusion Registry to connect to
- The ID of the Dataflow
- A series key specifying which series to retrieve, or simply 'all' to retrieve all series
=fxldata("https://demo.metadatatechnology.com/FusionRegistry","WB,WDI_POVERTY","A")
By default, the number of series returned is capped at 100, but can be altered using the MaxSeries argument
Syntax
=FXLData( RegUrl , Dataflow , Expression , [MaxSeries] , [RestArguments] , [StartPeriod] , [EndPeriod] , [Labels] , [IncludeHeader] , [IncludeSeriesKey] , [IncludeBreakdown] , [IncludeAttributes] )
Argument | Description | Examples | Required? | |
---|---|---|---|---|
1 | RegUrl | The base URL of the Fusion Registry service | https://demo.metadatatechnology.com/FusionRegistry | Mandatory |
2 | Dataflow | Options: 1. The dataflow to query conforming to the SDMX REST specification for data queries 2. A blank string - in this case the Dataflow(s) to query must be specified as part of the Expression. |
EXR ECB,EXR,1.0 |
Mandatory |
3 | Expression | Options: 1. A series key 2. A dataflow and series key expression <dataflow>/<series key> 3. A JSON series basket expression which must be a cell reference and cannot be a literal value 4. The keyword 'all' to select all series in the dataset |
A A.CAD+HUF+INR...E all ECB,EXR,1.0/A.HUF...E C4 (cell reference) |
Mandatory |
4 | MaxSeries | The maximum number of series to return | 1000 | Optional Defaults to 100 series |
5 | RestArguments | Additional data REST query arguments intended for special use cases like adding calculated measures or changing the dimension at observation | round=3&calculatemeasure=THE_MEASURE;pch;mvavg,3&dimensionAtObservation=CURRENCY_DENOM | Optional |
6 | StartPeriod | The start period in SDMX standard time format | 2010-06-12 2010 |
Optional Defaults to the start of the available data |
7 | EndPeriod | The end period in SDMX standard time format | 2010-06-12 2010 |
Optional Defaults to the end of the available data |
8 | Labels | Component labelsid - IDs onlyname - names onlyboth - both IDs and names |
both | Optional Defaults to id
|
9 | IncludeHeader | BooleanTRUE includes component labels at the head of each column and shows metricsFALSE component labels and metrics are ommitted |
FALSE | Optional Defaults to TRUE
|
10 | IncludeSeriesKey | BooleanTRUE adds a calculated dimension 'series' with the series key as the valueFALSE series keys are not included in the dataset |
FALSE | Optional Defaults to TRUE
|
11 | IncludeBreakdown | Boolean Controls whether a breakdown of the dataset's components is shown. TRUE includes dimensions. Attributes are also shown if the IncludeAttributes argument is TRUE. FALSE no components are included |
TRUE | Optional Defaults to TRUE
|
12 | IncludeAttributes | BooleanTRUE includes series attributes in the component breakdownFALSE excludes attributes |
FALSE | Optional Defaults to TRUE
|
Example:
=fxldata("https://demo11.metadatatechnology.com/FusionRegistry","WB,WDI_POVERTY,1.0","..AUS+CHN+FJI",200,,,,"id",TRUE,FALSE,TRUE,FALSE)