HsGetSheetInfo

Applies to: Planning, Planning Modules, Financial Consolidation and Close, Tax Reporting, Oracle Essbase

Description

HsGetSheetInfo retrieves information about the current sheet, one property at a time. The following sheet properties can be retrieved and displayed in the sheet.

Table 17-2 HsGetSheetInfo Details

String Equivalent Sheet Information

Last Retrieved

The date and time that the last refresh was performed on the sheet

Sheet Type

Form, Ad hoc, Multiple grid ad hoc, Function, or Smart Form

Server

The server to which the sheet is connected

Application

The application to which the sheet is connected

Cube

The cube to which the sheet is connected

URL

The URL to which the sheet is connected

Alias Table

The current alias table

Provider

The data source type to which the sheet is connected

Display of the following sheet properties is not supported:

  • User
  • Friendly Name
  • Description
  • Provider URL

Syntax

HsGetSheetInfo("<string equivalent>")

For detailed syntax information, see Syntax Guidelines.

Example 17-6 Basic Example

In this example, HsGetSheetInfo tells you whether the sheet contains a Form, Ad hoc, Multiple grid ad hoc, Function, or Smart Form.

HsGetSheetInfo("Sheet Type")

Notes

  • If you enter an invalid sheet property, the function returns a "Not Applicable" value.
  • In a multiple-grid ad hoc sheet, HsGetSheetInfo always displays information related to the first inserted grid. If you use the Last Retrieved property to find the date and time when the last refresh was performed on the sheet, the HsGetSheetInfo function displays the time when the first grid was retrieved, even though the second grid was the one that was last retrieved on the sheet. However, you can launch the Sheet Information dialog to see the correct last retrieved time or refresh the sheet one more time to get the consistent time.
  • In case of multiple-grid ad hoc sheets having grids from multiple connections, the HsGetSheetInfo function retrieves sheet property only for the first connection, irrespective of the connection that is currently active on the sheet.

    For example, if you have two ad hoc grids from two different connections on a multiple-grid ad hoc sheet and you use the URL property, the HsGetSheetInfo function displays the connection URL only for the grid that was first connected on the sheet.

  • With cell styles enabled for an ad hoc grid, if you change a sheet property that you have added using the HsGetSheetInfo function, the function cell appears dirty. For example, if you change the URL sheet property added on the sheet to Cube, the function cell refreshes to display the cube name, but it appears dirty. In such case, click Refresh to remove the dirty background color.