Difference between revisions of "FXLDataLookup and FXLDataPeriod Functions"

From Fusion Registry Wiki
Jump to navigation Jump to search
(FXLDataPeriod Formula)
(FXLDataPeriod Formula)
Line 64: Line 64:
 
FXLDataPeriod scans an existing root grid on a specified worksheet and returns the SDMX period(s) available in that grid, either the minimum, the maximum, or both, depending on the mode you pass.
 
FXLDataPeriod scans an existing root grid on a specified worksheet and returns the SDMX period(s) available in that grid, either the minimum, the maximum, or both, depending on the mode you pass.
  
Syntax
+
===== Syntax =====
 
FXLDataPeriod(sheetName, [what], [errorMessages])
 
FXLDataPeriod(sheetName, [what], [errorMessages])
 +
 +
===== Parameters =====
 +
'''sheetName''' - The worksheet containing the root grid with the expected header/layout
 +
'''what'''
 +
* OPTIONAL, Defaults to BOTH
 +
* MIN - returns the first period
 +
* MAX - returns the last period
 +
* BOTH - returns both the first and last periods
 +
'''errorMessages'''
 +
* OPTIONAL, Defaults to FALSE
 +
* TRUE/FALSE. When TRUE, returns descriptive messages (e.g., “Grid Not Found”).
 +
 +
=== FXLDataLookup Examples ===

Revision as of 22:46, 22 January 2026

Introduced in H1.3.0.03 (January 2026).

Fusion XL Data - FXLDataLookup and FXLDataPeriod Formulas

Context

To date, FXLData has been used primarily to generate data cubes in Excel from a Fusion Registry by applying user‑defined selection criteria. The add‑in issues SDMX REST queries to the Fusion Registry and renders the results as a structured grid, typically one series per row (time across columns) or one series per column, so analysts can work with a familiar worksheet layout.

Problem

The current workflow is geared to building full grids/cubes from Fusion Registry; getting a single value or a small ad‑hoc slice often means running a broader query and then indexing/filtering the filled grid, which adds unnecessary steps for simple asks.

Solution

2 New Formulas have been introduced:

  • FXLDataLookup retrieves targeted measures directly from an existing root grid, returning a single value, short list, or small table. It also supports simple arithmetic, period wildcards, optional auto‑refresh, and explicit error messages.
  • FXLDataPeriod returns the minimum and/or maximum SDMX periods found on a specified root grid so lookups can use dataset bounds without manual date handling (with sheet‑not‑found error handling).

FXLDataLookup Formula

FXLDataLookup reads values from an existing root grid on a specified worksheet and returns the measures for the given series key(s) and period(s) as a

  • single value
  • short list
  • or small table

depending on how many items and periods you pass.

Syntax

FXLDataLookup(items, periods, sheetName, [autoRefresh], [errorMessages])

Parameters

items

  • A single series key (text)
  • a range of keys
  • or an expression combining series keys and numbers with supported operators.

periods

  • A single period
  • a range of periods
  • a wildcard (e.g., "2001*")

sheetName - The worksheet containing the root grid with the expected header/layout [autoRefresh]

  • OPTIONAL, Defaults to FALSE
  • TRUE/FALSE. When TRUE, forces updates only if Excel is not in automatic calculation mode.

[errorMessages]

  • OPTIONAL, Defaults to FALSE
  • TRUE/FALSE. When TRUE, returns descriptive messages (e.g., “Key Not Found”, “Non‑numeric Value”, “Divide By Zero”, “Invalid Power”, “Parse Error”).
Supported Operators - items parameter

Arithmetic

  • + (add)
  • - (subtract)
  • * (multiply)
  • / (divide)
  • ^ (power)
  • Standard arithmetic precedence applies;
  • parentheses can be used to control evaluation order

Unary signs:

  • leading -
  • and + are supported

Exponent constraint: for ^, the right‑hand exponent must be numeric, either a literal or a cell reference to a numeric value; using a series key on the right‑hand side raises Invalid Power. The left‑hand/base may be a series key.

Wildcards - periods parameter

Period wildcards let you pass a pattern like "2001*"; the function returns that period and all later periods already present in the referenced root grid (e.g., 2001, 2002, 2003).

FXLDataPeriod Formula

FXLDataPeriod scans an existing root grid on a specified worksheet and returns the SDMX period(s) available in that grid, either the minimum, the maximum, or both, depending on the mode you pass.

Syntax

FXLDataPeriod(sheetName, [what], [errorMessages])

Parameters

sheetName - The worksheet containing the root grid with the expected header/layout what

  • OPTIONAL, Defaults to BOTH
  • MIN - returns the first period
  • MAX - returns the last period
  • BOTH - returns both the first and last periods

errorMessages

  • OPTIONAL, Defaults to FALSE
  • TRUE/FALSE. When TRUE, returns descriptive messages (e.g., “Grid Not Found”).

FXLDataLookup Examples