1. Working with Oracle Smart View for Office
  2. Functions
  3. Function Descriptions
  4. HsGetVariable

HsGetVariable

Describes the Smart View function, HsGetVariable.

Data source types: Oracle Analytics Cloud - Essbase

Description

HsGetVariable retrieves the associated value for a substitution variable.

You cannot use HsGetVariable with Smart Slices.

Syntax

HsGetVariable can use the default connection name, a private connection name, a shared connection, or an Excel named range on a multiple-range grid, as follows:

  • Default connection: HsGetVariable("substitution variable name")

  • Private connection: HsGetVariable("PrivateConnectionName","substitution variable name")

  • Shared connection: HsGetVariable("WSFN|ProviderType|Server|Application|Database","substitution variable name")

  • URL connection: HsGetVariable("URLFN|URL|Server|Application|Database","substitution variable name")

  • Named range on a multiple-range grid: HsGetVariable("range name","substitution variable name")

For detailed syntax information, see Creating Functions Manually.

Examples

  • Default connection: HsGetVariable("CurMonth")

  • Private connection: HsGetVariable("myprivateconnection_Sample_Basic","CurMonth")

  • Shared connection: HsGetVariable("WSFN|Essbase|esbsvr|Sample|Basic","CurMonth"

  • URL connection: HsGetVariable("URLFN|https://<servername:port>/aps/SmartView|<servername:port>|Application|Database","substitution variable name")

  • Named range: HsGetVariable("myprivateconnection_Sample_Basic","CurMonth")

Note:

An ampersand (&) is generally used to refer to a substitution variable, but is optional in this function.

Note:

HsGetVariable does not support non-ASCII variable values.