Executing Smart View Retrievals using VBA

When working with Hyperion systems, Smart View is a key tool used for reporting, as well as inputting data. It provides a valuable link between Hyperion and Excel, which allows users to retrieve data from the database straight into Excel with ease. Smart View functions are available through the Smart View toolbar and can be used with Essbase, HFM, Planning or Cloud connections.


Occasionally, it is necessary to perform Smart View functions behind the scenes using VBA code, rather than manually using the Smart View toolbar. For example, a spreadsheet which will refresh all the Essbase retrieval sheets on opening, so that users can view the most up to date data, without having to remember to refresh each of the retrieval sheets themselves.

This blog will be cover how to retrieve data using a Smart View refresh function in VBA. For more information about Smart View Excel VBA functions, go to the Oracle Hyperion Smart View Developers Guide. 

System Requirements

There are a couple of things which must be set up before Smart View functions can be called using VBA code. The first is that Smart View must be installed on the local machine which will be use to run the VBA code.

The second requirement is that the Smart View functions must be declared in the Excel spreadsheet. To do this:
  1. In Visual Basic Editor, select File > Import File.
  2. From the Import File dialog box, select the file smartview.bas located in your Oracle\SmartView\bin directory.
The file is copied into the module, allowing you to use any Smart View Excel VBA function in your program. This must be done in every excel file which will be referencing Smart View functions.

Refreshing a Retrieval Sheet

The function used to retrieve the latest data from Hyperion is HypMenuVRefresh(). This command is the equivalent of using the Refresh button on the Smart View Excel toolbar. 

The refresh function will use the last connection details that were used on that sheet and will ask the user to enter their login details for the first retrieval. Once a user has logged in, retrievals can be performed on multiple other sheets without having to login again.

Before the sheet can be refreshed using the HypMenuVRefresh function, the retrieval sheet must be set to visible (it is not possible to refresh a hidden sheet) and it must be the active sheet in the workbook. The last thing is to make sure that no ranges of cells are selected as this brings back an error. To do this, select a specific cell on the sheet (e.g. cell A1).

The following VBA procedure will perform a refresh of a specified retrieval sheet called Ess_Retrieve.

In the above code, if the refresh was unsuccessful, the status (sts variable) will return an error code and display an error message. If it was successful then the status is equal to 0.

If necessary, the retrieval sheet can be hidden again, by using code:



Comments

  1. Tuta30 September 2020 at 14:23

    Is there a way to perform that login via a macro first?

    ReplyDelete
    Replies
    1. Lydia Maksoud18 January 2021 at 05:22

      Yes you can login separately, before executing the refresh or other commands.

      This is documented well by Oracle here: https://docs.oracle.com/cd/E12825_01/epm.111/esb_apiref/frameset.htm?mavfauto.htm

      Delete
    2. Subhranil25 April 2021 at 02:25

      Hi Lydia, Is there any way to run the above code via 'cscript' or wscript. I am am trying to automate Alteryx command function to run cscript program but need help. Appreciate your help.

      Delete

Post a Comment

Popular posts from this blog

Loading multi-period row data files using Data Management

Image
The ability to load multi-period data with the Period and/or Year in the rows is not particularly new (since release 16.10), however it is something that most people seem to forget is possible in Data Management. This really is something worth remembering as it eliminates the need to either split the data files into one file per month or try to pivot the month into the columns. In order to set this up, let’s firstly look at how to add the Period and Year columns to the import format. Add the Period and Year columns using the Add -> Source Period Row dropdown, and input: The Source Column name – e.g. PERIOD The Field Number (file column) – e.g. 3 Any required expressions for that field  As these are Period/Year dimensions, the mappings are not held in the usual Data Load Mappings area. Instead they are configured in the Period Mappings , under the Source Mapping tab. Select the Source System as File to add a new mapping calendar for loading the data ...
Read more

Loading Actuals from Fusion ERP Cloud to PBCS

Image
If you’re looking to set up a data load of Actuals from ERP to PBCS and have heard this is an “Out of the box” integration, then good news! Not only is the OOTB connector included within PBCS Data Management but the integration is simple to setup and to schedule using EPM Automate. This blog will detail how to setup the ERP to PBCS connector in Data Management and some of the common errors found when running the data load. The first thing to know about this integration is that the data source is actually the ASO Essbase cube which sits underneath the Fusion ERP tables, holding the period Actuals values. This ERP Essbase cube is created using job ‘Create General Ledger Balances Cube’ when configuring the ERP system. This cube must be created before the integration can be set up correctly and can be accessed directly via Smart View for reconciliations. Set up the Source System As this is an Oracle built connector, it’s as simple as providing a name for the source system ...
Read more