FXLData() - Revision history

Grahamcassidy at 13:09, 30 July 2025

2025-07-30T13:09:04Z

Grahamcassidy at 12:33, 30 July 2025

2025-07-30T12:33:03Z

Grahamcassidy at 09:59, 30 July 2025

2025-07-30T09:59:12Z

Vmurrell: Vmurrell moved page =FXLData() to FXLData() without leaving a redirect: looks better

2024-07-22T12:28:06Z

Vmurrell moved page =FXLData() to FXLData() without leaving a redirect: looks better

Vmurrell at 12:12, 22 July 2024

2024-07-22T12:12:26Z

Vmurrell: Created page with "Category:Functions Reference FXLData ==FXLData()== By default ƒ_''x'' =FXLData() returns a horizontal time-series dataset, one series per row with time spannin..."

2024-07-22T12:02:51Z

Created page with "Category:Functions Reference FXLData ==FXLData()== By default ƒ''x'' =FXLData() returns a horizontal time-series dataset, one series per row with time spannin..."

New page

[[Category:Functions Reference FXLData]]
==FXLData()==
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 [[#Dimension at Observation|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]'' )

{| class="wikitable" style="width:70%;"
|-
! !!style=max-width:4em | Argument!! style=max-width:4em | Description !! style=max-width:4em | Examples !! style=max-width:4em | Required?
|-
| 1||RegUrl|| The base URL of the Fusion Registry service || <nowiki>https://demo.metadatatechnology.com/FusionRegistry</nowiki> || style="background-color:pink;" |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 || style="background-color:pink;" | Mandatory
|-
| 3||Expression || Options: 1. A [[Series Key|series key]] 2. A dataflow and series key expression <dataflow>/<series key> 3. A [[Anatomy_of_the_Data_Browser#Series_List_From_Series_Basket|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)||style="background-color:pink;" | Mandatory
|-
| 4||MaxSeries || The maximum number of series to return || 1000 || Optional Defaults to 100 series
|-
| 5||RestArguments || Additional [[Data_Query_Web_Service#Extended_HTTP_Query_Parameters|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 Time Formats|SDMX standard time format]] || 2010-06-12 2010 || Optional Defaults to the start of the available data
|-
| 7||EndPeriod || The end period in [[SDMX Time Formats|SDMX standard time format]] || 2010-06-12 2010 || Optional Defaults to the end of the available data
|-
| 8||Labels || Component labels <code>id</code> - IDs only <code>name</code> - names only <code>both</code> - both IDs and names || both || Optional Defaults to <code>id</code>
|-
| 9||IncludeHeader || Boolean <code>TRUE</code> includes component labels at the head of each column and shows metrics <code>FALSE</code> component labels and metrics are ommitted|| FALSE || Optional Defaults to <code>TRUE</code>
|-
| 10||IncludeSeriesKey || Boolean <code>TRUE</code> adds a calculated dimension 'series' with the series key as the value <code>FALSE</code> series keys are not included in the dataset || FALSE || Optional Defaults to <code>TRUE</code>
|-
| 11||IncludeBreakdown || Boolean Controls whether a breakdown of the dataset's components is shown. <code>TRUE</code> includes dimensions. Attributes are also shown if the IncludeAttributes argument is TRUE. <code>FALSE</code> no components are included || TRUE || Optional Defaults to <code>TRUE</code>
|-
| 12||IncludeAttributes || Boolean <code>TRUE</code> includes series attributes in the component breakdown <code>FALSE</code> excludes attributes|| FALSE || Optional Defaults to <code>TRUE</code>
|}

'''''Example:'''''
=fxldata("https://demo11.metadatatechnology.com/FusionRegistry","WB,WDI_POVERTY,1.0","..AUS+CHN+FJI",200,,,,"id",TRUE,FALSE,TRUE,FALSE)

@@ Line 41: / Line 41: @@
 | 12||IncludeAttributes || Boolean<br><code>TRUE</code> includes series attributes in the component breakdown<br><code>FALSE</code> excludes attributes|| FALSE || Optional<br>Defaults to <code>TRUE</code>
 |-
-| 13||TimeFormatFrequencyId || Text<br>If the optional TimeFormatFrequencyId argument is set to <code>'D'</code>, the plugin will convert TIME_PERIOD values to a daily format—provided the original frequency is less granular than daily|| D || Optional<br>Defaults to the underlying time format if not used.</code>
+| 13||TimeFormatFrequencyId || Text<br>If the optional TimeFormatFrequencyId argument is set to <code>'D'</code>, the plugin will convert TIME_PERIOD values to a daily format—provided the original frequency is less granular than daily|| D || Optional<br>Defaults to the underlying time format if not used</code>
 |-
 | 14||DataflowName|| DataflowName is an optional setting that isn’t intended to be changed by the user. When present, it helps improve the user experience on the wizard's edit screen|| n/a || Optional

@@ Line 11: / Line 11: @@
 '''Syntax'''<br>
-<small>=<strong>FXLData</strong>( ''RegUrl , Dataflow , Expression , [MaxSeries] , [RestArguments] , [StartPeriod] , [EndPeriod] , [Labels] , [IncludeHeader] , [IncludeSeriesKey] , [IncludeBreakdown] , [IncludeAttributes]'' )</small>
+<small>=<strong>FXLData</strong>( ''RegUrl , Dataflow , Expression , [MaxSeries] , [RestArguments] , [StartPeriod] , [EndPeriod] , [Labels] , [IncludeHeader] , [IncludeSeriesKey] , [IncludeBreakdown] , [IncludeAttributes], [TimeFormatFrequencyId], [DataflowName]'' )</small>
 {| class="wikitable" style="width:70%;"

← Older revision		Revision as of 12:12, 22 July 2024
Line 1:		Line 1:
	[[Category:Functions Reference FXLData]]		[[Category:Functions Reference FXLData]]
−	~~==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]].

@@ Line 40: / Line 40: @@
 |-
 | 12||IncludeAttributes || Boolean<br><code>TRUE</code> includes series attributes in the component breakdown<br><code>FALSE</code> excludes attributes|| FALSE || Optional<br>Defaults to <code>TRUE</code>
 |}
 '''''Example:'''''
   =fxldata("https://demo11.metadatatechnology.com/FusionRegistry","WB,WDI_POVERTY,1.0","..AUS+CHN+FJI",200,,,,"id",TRUE,FALSE,TRUE,FALSE)

← Older revision	Revision as of 12:28, 22 July 2024
(No difference)