EssGetGlobalOption

Description

Gets individual Essbase workspace options.

Syntax

EssGetGlobalOption(item) 

Where item is a number that specifies what type of information you want. The item argument, return value, and return value type are shown in Table 25.

Table 25. Item Argument, Return Value, and Return Value Type

ItemReturn ValueType

1

Enable secondary button setting

Boolean

2

Enable double-clicking setting

Boolean

3

Enable FlashBack setting

Boolean

4

This setting is maintained for backward compatibility with previous Essbase releases.

Boolean

5

Specify message level setting:

  • 1 Info, Warning & Error messages

  • 2 Warning & Error messages only

  • 3 Error messages only

  • 4 No messages

Number

6

Enable display unknown members setting

Boolean 

7

Enable route messages to log setting

Boolean

8

Enable purge log setting

Boolean

9

Enable double-clicking to browse Linked Objects setting

Boolean

10

Display Member Select Save Dialog Box setting

Boolean

11

Enable Navigate Without Data

Boolean

Example

=EssGetGlobalOption(3)

returns TRUE if FlashBack is enabled or FALSE if it is not.

Note:

The value #NUM! is returned when item is missing or is not number 1 through 11.