Ess Properties

The following properties are available on EssProperties objects, which appear as expandable sub-properties of the objects that use them.

Misc

Property Type Default Description

AliasTable

string

Default

The name of the alias table from which aliases are obtained. The alias table is used only when the UseAliases setting is true.

See also: UseAliases

AncestorOnTop

bool

false

Controls whether an ancestor member is positioned at the top of the related child members.

AutoSortRows

bool

false

Used in conjunction with Free Form retrieval mode. When set to True, Essbase retrieves data in symmetric rows that are sorted based on the order specified in the database outline.

DatalessNavigation
displayed as NavigateWithoutData

bool

false

Controls whether the Essbase operations are performed without returning any data.

NavigateWithoutData is only applicable when UpdateMode is false.

DisplayUnknownMembers

bool

true

Sets or returns a flag that indicates whether unknown members are displayed in the grid data.

DrillLevel
displayed as ZoomLevel

DrillingLevel

EssProperties.DrillingLevel.NextLevel

Indicates the depth of data that is retrieved relative to the selected member(s) by a Zoom In operation.

NextLevel — Retrieves data for all the children.

AllLevels — Retrieves data for all descendants.

BottomLevel — Retrieves data for the lowest level of members in the dimension.

SameLevel — Retrieves data for all members at the same level.

SameGeneration — Retrieves data for all members of the same generation.

CalcLevel — Retrieves data for all members defined in the formula of the selected member(s). The formula can be a member equation or a consolidation to the parent.

EmptyGridError

bool

false

Controls whether the server returns the empty grid error when both SuppressMissing and SuppressZeros are enabled and the operation would result in no rows.

HybridAnalysisEnabled
displayed as EnableHybridAnalysis

bool

false

Controls whether Hybrid Analysis is enabled for Essbase operations. If enabled, members from a Hybrid Analysis relational source are displayed.

IncludeSelection

bool

true

Controls whether the selected member is retained along with the other members retrieved by a Zoom In operation.

IndentStyle
displayed as Indentation

IndentationStyle

EssProperties.IndentationStyle.Totals

Indicates the indentation of member names.

None — Prevents indentation of any member names.

SubItems — Left-justifies ancestors and indents descendants.

Totals — Left-justifies descendants and indents ancestors.

LatestMemberName

string

Indicates the name of the member to use as the latest time period for dynamic time series retrievals.

MissingTextString
displayed as MissingLabel

string

#Missing

The string used for missing values by Essbase operations.

NoAccessString
displayed as NoAccessLabel

string

#NoAccess

The string used for data to which the user has no access during Essbase operations.

RepeatMemberNames
displayed as RepeatMemberLabels

bool

false

Controls whether member names are repeated in data retrieved by Essbase operations.

RetrievalMode

EssbaseRetrievalMode

EssbaseRetrievalMode.AdvancedInterpretation

Controls whether a retrieve operation is performed in Advanced Interpretation, Free Form, or Template Retrieve mode.

SelectedGroup
displayed as RemoveUnselectedGroups

bool

false

Controls whether a Zoom In, Zoom Out, Keep Only, or Remove Only operation removes all dimension groups that are not in the selected group.

SelectionOnly
displayed as WithinSelectedGroup

bool

false

Controls whether a Zoom In, Zoom Out, Keep Only, or Remove Only operation is applied only to the dimension of the selected member(s).

WithinSelectedGroup is only applicable when the sheet contains two or more dimensions of data down a sheet as rows or across a sheet as columns.

SendBlanksAsMissing

bool

false

Controls whether blanks are replaced with the missing string by a Send operation.

SendLevelZeroOnly

bool

false

Controls whether only level zero member combinations are sent to the database during update operations.

SendZerosAsMissing

bool

false

Controls whether zeros are replaced with the missing string by a Send operation.

SpecifyLatestMember
displayed as LatestTimePeriod

bool

false

Controls whether the LatestMemberName is used by dynamic time series retrievals.

StrictMode

bool

false

Controls whether an Essbase operation is performed when unknown members are detected.

When StrictMode is set to True and unknown members are detected, the unknown members are reported in the client.

SuppressMissing
displayed as SuppressMissingRows

bool

false

Controls whether rows that contain missing values are retrieved by Essbase operations.

SuppressMissingRows is only applicable when RetainOnRetrieval is false.

SuppressUnderscores
displayed as SuppressUnderscoreCharacters

bool

false

Controls whether rows that contain underscore characters are retrieved by Essbase operations.

SuppressZeros
displayed as SuppressZeroRows

bool

false

Controls whether rows that contain zeros are retrieved by Essbase operations.

SuppressZeroRows is only applicable when RetainOnRetrieval is false.

UpdateMode

bool

false

Controls whether the corresponding database area is locked when data is retrieved. If true, the database area is locked.

UpdateMode is only applicable when NavigateWithoutData is false.

UseAliases

bool

false

Controls whether aliases are displayed instead of member names. If true, the AliasTable specifies the name of the alias table used to obtain the aliases.

See also: AliasTable

UseBlankAsMissingTextString
displayed as UseBlankAsMissingLabel

bool

false

Indicates whether a missing value is represented as a blank cell instead of as the MissingLabel. When UseBlankAsMissingLabel is True, the MissingLabel is ignored.

UseBothForRowDimensions
displayed as UseMemberNamesAndAliasesForRowDimensions

bool

false

Controls whether both the member name and alias are displayed for each row dimension member.

UseSmartLists

bool

false

Sets or returns a flag that indicates that SmartList values instead of numbers for enabled members. Valid for Essbase version 11 and higher.

UseSmartLists_ShowDropDownList

bool

false

When using SmartLists (i.e. UseSmartLists is True), controls whether a dropdown list of the SmartList (Test List) mapping names is displayed for a data cell associated with a SmartList.