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

HsGetValue

Data sources: Oracle Analytics Cloud - Essbase, Oracle Planning and Budgeting Cloud, Oracle Enterprise Planning and Budgeting Cloud, Oracle Financial Consolidation and Close Cloud, Oracle Tax Reporting Cloud, Oracle Enterprise Performance Reporting Cloud

Description

HsGetValue retrieves data from the data source for selected members of a dimension.

When HsGetValue retrieves no data, the value specified for the #NoData/Missing Label replacement option is used (see Table 20-5).

When users select Refresh or Refresh All, only HsGetValue is called. When users select Submit, HsSetValue is called first, and HsGetValue is then called only if HsSetValue returns successfully.

The HsGetValue function supports the use of one attribute dimensions and member when connected to these data sources:

  • Essbase

  • Oracle Analytics Cloud - Essbase

  • Oracle Planning and Budgeting Cloud

  • Oracle Enterprise Planning and Budgeting Cloud

  • Oracle Financial Consolidation and Close Cloud

  • Oracle Tax Reporting Cloud

Syntax

Private connection:

HsGetValue("PrivateConnectionName","POV")

Shared connection:

HsGetValue("WSFN|ProviderType|Server|Application|Database","POV")

For detailed syntax information, see Creating Functions Manually.

Example without Attribute

In this example, HsGetValue returns the value from the HFM01 application for the default POV.

Private connection:

HsGetValue("HFM01";"Scenario#Actual;Year#2004;Period#July;View#YTD;
Entity#UnitedStates.Connecticut;Value#USD;Account#Sales;ICP#[ICP 
None];Custom1#GolfBalls;Custom2#Customer2;Custom3#[None];
Custom4#Increases")

Shared connection:

HsGetValue("WSFN|HFM|hfm_svr|HFM01|HFM01";"Scenario#Actual;Year#2004;Period#July;
View#YTD;Entity#UnitedStates.Connecticut;Value#USD;Account#Sales;ICP#[ICP 
None];Custom1#GolfBalls;Custom2#Customer2;Custom3#[None];Custom4#Increases")

Example with Attribute

In this example, HsGetValue returns the value from the Vision application, Plan1 database, and the POV includes an attribute dimension and member, Entity_Regions#NA_Reg.

Note:

HsGetValue supports only one attribute dimension and member per function.

Private connection:

HsGetValue("Vision","Account#Amount","Period#Jan","Years#2017","Scenario#Annual Contract","Version#Final","Entity#AR02-Argentina-IS_Adjustments","Package#Depreciation","Currency#Local Currency","Entity_Regions#NA_Reg")

Shared connection:

HsGetValue("WSFN|HP|serviceURL|Vision|Plan1","Account#Amount","Period#Jan","Years#2017","Scenario#Annual Contract","Version#Final","Entity#AR02-Argentina-IS_Adjustments","Package#Depreciation","Currency#Local Currency","Entity_Regions#NA_Reg")