Mdx Essbase View Properties

The text that appears on the view tab or title bar after the view builds or refreshes. If no value is specified, the CaptionBeforeBuild value is used. If no CaptionBeforeBuild value is specified, the view name is used.

The value can be tokenized, which allows the caption to reflect the current context. For example, if the view has selectors and the CaptionAfterBuild contains a token for each of the selectors, the caption after the view is built or refreshed reflects the selections represented by the view data.

See also: CaptionBeforeBuild

The text that appears on the view tab or title bar when the view is opened and before the view builds for the first time. If no value is specified, the view name is used as the caption.

The value can be tokenized.

See also: CaptionAfterBuild

false

Controls whether only a single instance of the view can be opened by the user from the view selector. When the setting is True, only a single instance is allowed. When the user attempts to open another instance of the view from the view selector, the existing view’s window is activated.

false

Controls whether the view can be saved by a user. If true, the Save View As and Save View button tools are enabled.

false

Controls whether a saved view can be shared by the owner.

AllowSharing is only applicable when AllowSave is true.

See also: AllowSave

false

Controls whether the view automatically builds when opened.

If true, the view automatically builds, but only if the view is buildable. Whether or not the view is buildable is based on the view state. For instance, if a view has selectors and each selector has a selection, the view is buildable.

false

Controls whether the Adhoc or Script Essbase view emulates the classic Excel AddIn.

When the mode is disabled, the Dodeca framework maintains detailed information about the members and data retrieved from Essbase, which is used to determine the appropriate operations for a given cell as well as provide context information that is used for intelligent navigation. This provides a more structured ad hoc experience, but is not as freeform as the Excel AddIn.

When the mode is enabled, the user is able to copy a range of data into the grid or open an existing workbook from the file system, then immediately perform operations such as zooming or pivoting without having to first perform a retrieve. Essbase operations can be performed on a selected range. Multiple workbooks can be open within the view.

PasteOption.All

Controls whether formulas, formats, and/or values are pasted into a worksheet when the Ctrl+V or the Shift+Insert keys are pressed to initiate the paste.

When the PastePolicy is None, no paste operation is performed.

true

Controls whether operations that support it are executed asynchronously.

false

Controls whether multiple Essbase and SQL operations such as retrieves and sends will be performed concurrently.

EvenValuesTo24.Four

Controls the maximum number of concurrent Essbase and SQL operations allowed by this view.

true

Controls whether the Linked Objects Browser dialog appears when a user double-clicks the left mouse button in a data cell.

For an Excel Essbase view or Essbase universal range, see also: DataCellDoubleClickPolicy

true

Controls whether the user is allowed to initiate an Essbase Pivot operation. If true, a pivot operation can be initiated by pressing the right mouse button in a member cell, and then holding and dragging the mouse to a destination cell. The Pivot button tool can also be used to pivot a member. The tool is enabled when the AllowPivot setting is true.

For an Excel Essbase view, pivoting is not allowed when the RetainOnRetrieval setting is true or when the active worksheet contains named retrieve ranges and AllowEssbaseOperationsOnRetrieveRange is false.

For an Essbase universal range, pivoting is not allowed when the RetainOnRetrieval setting is true or AllowEssbaseOperationsOnRetrieveRange is false.

false

Controls whether the user is allowed to update Essbase data by posting changes to the database. If true, the Send button tool is enabled.

For an Excel Essbase view, see also: SendPolicy For an Essbase universal range, see also: RetrieveAndSendPolicy

EssbaseViewBase.AllLROTypesMask

Controls the LRO (linked reporting object) types available in the Linked Objects Browser dialog.

See also: AllowLROs

For an Excel Essbase view or Essbase universal range, see also: DataCellDoubleClickPolicy

false

Controls whether named ranges are automatically added for the Essbase page, row, column, and data areas when any Essbase operation is performed that retrieves data. These operations include retrieve, pivot, zoom in, zoom out, remove only, and keep only.

The names of the ranges are Ess.PageHeaderRange, Ess.RowHeaderRange, Ess.ColumnHeaderRange, and Ess.DataRange.

For an Excel Essbase view that contains named retrieve ranges, such as Ess.Retrieve.Range.1, the sub-range names are given an extension to uniquely identify and associate the sub-ranges with the retrieve range. The extension is based on the retrieve range identifier. For example, if the named retrieve range is Ess.Retrieve.Range.1, the sub-range names are Ess.PageHeaderRange.1, Ess.RowHeaderRange.1, Ess.ColumnHeaderRange.1, and Ess.DataRange.1.

For an Essbase universal range, the sub-range names use the universal range’s SheetRangeName as the extension. For example, if the SheetRangeName is SampleBasic, the sub-range names are Ess.PageHeaderRange.SampleBasic, Ess.RowHeaderRange.SampleBasic, Ess.ColumnHeaderRange.SampleBasic, and Ess.DataRange.SampleBasic.

The named ranges can be used by the view’s workbook script to format the page, row, column, and/or data areas after an Essbase operation is performed.

false

Controls whether an Essbase retrieve is automatically performed after Essbase data is updated.

Performing the retrieve ensures that the information that is maintained internally represents the members and data contained by the view. So, for example, if the user pastes data from another source into the view, then performs a send operation,

The text displayed on the chart control pane title bar and tab. The value can contain tokens.

ChartCaption is only applicable if the view user-interface contains a chart control.

The collection of components that are added to the view upon initialization. Component configurations define properties for component plugins that interact with this view.

English (United States)

When the CulturePolicy is set to UseSpecifiedCulture, the CultureName setting specifies the name of the culture used by the view.

CulturePolicy.UseSpecifiedCulture

Controls whether the culture associated with the view is the culture specifed by the CultureName setting or is the culture of the client operating system. The culture determines the list separator used when Excel formulas are evaluated. It also determines the culture-specific formatting used for Essbase numeric data values. For instance, the decimal symbol for the English (Unitied States) culture is a period; whereas, the decimal symbol for the French (France) culture is a comma.

In Excel formulas that contain a function, the function arguments are separated by either a comma or a semicolon. The list separator that is defined by the regional settings associated with the culture is used as the function argument separator in Excel formulas.

Any Excel formulas entered into the grid control by the user or through a workbook script must use the culture’s list separator.

For an Excel Essbase view , the formulas that are in the Excel template are automatically converted to use the specified culture’s list separator as the function argument separator.

The Excel formulas used in workbook scripts must use the culture’s list separator as the argument separator explicitly. For example, if a workbook script uses the Address function, the row and column numbers must be separated by a comma when the CultureName is English (United States) and a semicolon when the CultureName is French (France).

Alternatively, the @SEP function can be used to create a workbook script that is culture-neutral. For example, =Address(ROW()@SEP()COL())

AdhocDataCellDoubleClickPolicy.ShowLinkedObjectsBrowser

Controls what happens when the user double-clicks an Essbase data cell with the left mouse button.

ShowLinkedObjectsBrowser - The Linked Objects Browser is displayed, if any Linked Reporting Objects (LROs) exist for the data cell and the AllowLROs setting is true. This is the default.

ShowDrillthroughReportBrowser - If one or more native Essbase drillthrough reports are defined for the data cell’s contributing members, the Drillthrough Report Browser is displayed, allowing the user to select and execute a report. This requires an Essbase server that supports native drillthrough reports (Essbase 21c or higher).

The Essbase connection ID used to look up the connection metadata that defines the Essbase connection settings for the Essbase view or for the Essbase universal range.

The object type ID of the login service that obtains the credentials used to sign on to the Dodeca Essbase service.

false

Controls whether the ability to undo and redo ad hoc operations is enabled.

AdhocOperationUndoRedoEnabled is only applicable when the ExcelAddInMode is enabled.

false

Controls whether a user’s Essbase option settings are used instead of the Essbase option settings that are defined for this view, which are represented by the EssProperties settings.

When used in conjunction with the AllowedUserEssbaseOptions setting, you can also control which Essbase options a user is allowed to set.

See also: EssProperties, AllowedUserEssbaseOptions

Controls the Essbase options that a user is allowed to set.

When AllowUserEssbaseOptions is true, the AllowedUserEssbaseOptions setting can be used to restrict the options a user is able to set. AllowedUserEssbaseOptions controls which options are displayed on the Essbase Options dialog. Any option that cannot be set by the user is obtained from the view’s EssProperties settings.

See also: AllowUserEssbaseOptions, EssProperties

false

Controls whether the width of the columns is automatically set to the minimum width necessary to display the data.

Defines the option settings used for Essbase-related operations.

See also: AllowUserEssbaseOptions

EssbaseOptionsContextScope.Global

Controls the caching of the user’s Essbase Options settings. The cache is used to initialize the settings when a view is opened.

None — The user’s settings are not cached. When the view is opened, the settings are assigned a default value based on the EssProperties settings. Any changes made to the settings by the user are applied while the view is open, but are not cached.

Global — The user’s settings are shared by all views configured with a global context. Any changes made to the settings by the user are applied to the current view and to other views that are subsequently opened that are also configured with a UserEssbaseOptionsContext of Global.

ByView — The user’s settings only apply to instances of this view. When the view is opened, the settings are initialized to the settings most recently used by an instance of this view.

ByLabel — The user’s settings are shared by all views configured with a ByLabel context and assigned the same label as this view. Any changes made to the settings by the user are applied to the current view and to other views that are subsequently opened that are also configured with a UserEssbaseOptionsContext of ByLabel with the same UserEssbaseOptionsContextLabel.

UserEssbaseOptionsContext is only applicable when AllowUserEssbaseOptions is true.

See also: AllowUserEssbaseOptions, UserEssbaseOptionsContextLabel

The context label used when the UserEssbaseOptionsContextLabel is set to ByLabel. Views that are assigned the same label share the user’s Essbase Options settings.

See also: UserEssbaseOptionsContext

ExcelFileFormat.OpenXMLWorkbook

Controls the default format of the output Excel file when the view is saved to an Excel file.

The view is saved as an Excel file by the Save As Excel, Open In Excel, and Send to Mail Recipient as Excel Attachment tools.

Excel8 - The Biff 8 file format, which is the default file format of Excel 97, Excel 2000, Excel 2002 (XP) and Excel 2003. The file extension used for the Excel8 file format is .xls.

OpenXMLWorkbook - Open XML file format of Excel 2007. The file extension used for the OpenXMLWorkbook file format is .xlsx.

false

Controls whether the Excel file is encrypted when the user saves the view as an Excel file, exports the view to an Excel file, opens the view in Excel, or sends an email with the view attached as an Excel file. A password is required to encrypt the Excel file, and is obtained from the user.

true

Controls whether the user is allowed to customize the auto-calculate functions that are displayed in the Status bar. When AutoCalculateAllowCustomize is True, the user can open the AutoCalculate menu by clicking the right mouse button in the Status bar.

true

Controls whether the auto-calculate function results are displayed in the Status bar and whether the AutoCalculate menu is displayed when the user clicks the right mouse button in the Status bar.

Controls which auto-calculate function results are displayed in the Status bar by default.

As in Excel, the auto-calculate feature provides a way to see the results of the following calculation functions as applied to the selected range of cells:

Average - Finds the average of the numerical values. Count - Counts the cells that contain a value. Numerical Count - Counts the cells that contain a numerical value. Min - Finds the smallest numerical value. Max - Finds the largest numerical value. Sum - Adds the numerical values.

true

Controls whether the grid lines are visible.

true

Controls whether the row and column headers are visible.

true

Controls whether sheet tabs are visible.

The alias table name used for the query.

false

Controls whether the query returns data values along with the members or members only. When True, no data values are returned.

The ID of the Essbase Script metadata instance that defines the MDX query used to generate the view data. If both the MdxQueryString and the MdxQueryID are specified, the MdxQueryID is used.

true

Controls whether data to which the user has no access is suppressed.

The MDX query used to generate the view data. If both the MdxQueryString and the MdxQueryID are specified, the MdxQueryID is used.

EssMdxQuery.Axis.RowsColumnsAndPages

Controls which axis results are returned by the dodeca-essbase service.

EssMdxQuery.IdentifierType.Name

Controls whether member names, aliases, or unique names are returned by the query.

false

Controls whether cell attributes are returned with the query results.

true

Controls whether the row member labels are repeated.

The Notes property can be used by developers to record information related to the view, such as notes about the design, history of changes, etc.

Configures the selectors for the view, including the order the selectors are displayed in the toolbar as well as the following settings for each selector:

Optional — Controls whether a selection is optional or required.

MultiSelect — Controls whether the user is allowed to select multiple items or only a single item. If checked, multiple items can be selected.

Caption — An optional caption that overrides the default caption defined for the selector.

Selector List — The selector list that defines 1) how the list of selectable items is generated and 2) the user-interface control used to display the items. If no selector list is specified, the default selector list defined for the selector is used.

Last Used Item Context — Controls the caching of the item(s) selected when the view is built or refreshed. Refer to the SelectorLastUsedItemContext for additional information.

LastUsedItemContextLabel — The context label used when the Last Used Item Context is set to ByLabel.

Connection Policy — For a selector that requires a connection to generate the list of selectable items, the connection policy controls whether the selector uses the view’s connection or uses a specified connection.

Connection Settings —  When the connection policy is UseSpecifiedConnection, the connection settings identify and configure the connection.

SelectorControlUIDisplayMode.DockedControl

Controls whether a docked pane or a modal dialog contains the user-interface control that displays the selectable items. The setting is only applicable to selectors that display the items in a user-interface control, such as a treeview or listbox, when the user clicks the 'Show' button on the selector tool.

DockedControl — Displays a pane that contains the user-interface control. The pane is docked the first time the user clicks the 'Show' button. The docked location is specified by the SelectorDockedControlLocation. If multiple selector user-interface controls are docked, each is displayed as a separate tab in the pane.

LockedDockedControl — Same as a DockedControl, except that the user cannot move the control to a different docked location.

ModalDialog — Displays a modal dialog that contains the user-interface control. The dialog is displayed each time the user clicks the 'Show' button, and must be closed by the user.

See also: SelectorDockedControlLocation

DockedControlGroupStyle.Tabbed

The layout of the group of dockable selector user-interface controls. The setting is only applicable when the SelectorControlDisplayMode is set to DockedControl.

Tabbed - Each selector control is displayed as a tabbed window within the group. Only the content of the selector control that is displayed in the active tab is visible.

Stacked - The selector controls are displayed as stacked tiles.

SlidingHeaders - Each selector control is represented by a button and only the content of the active selector control is visible. A selector control is activated by pressing its button.

SideBySide - The selector controls displayed as side-by-side tiles.

The combination of the SelectorDockedControlLocation and SelectorDockedControlGroupStyle settings determines the location and layout of the selector controls.

See also: SelectorControlUIDisplayMode, SelectorDockedControlLocation

DockedControlLocation.Right

The initial docked location for dockable selector user-interface controls. The setting is only applicable when the SelectorControlDisplayMode is set to DockedControl.

See also: SelectorControlUIDisplayMode

LastUsedItemContextScope.BySelector

Controls the caching of the item(s) selected when the view is built or refreshed. The cache is used to determine the default selected item(s) for the selectors that are assigned a selector list with a DefaultSelectionPolicy of LastUsedItem.

BySelector — The cache is shared by all views configured with the BySelector context.

BySelectorList — The cache is shared by all views configured with the BySelectorList context.

ByView — The cache is used only by this view.

ByLabel — The cache is shared by all views configured with the ByLabel context and assigned the same SelectorLastUsedItemContextLabel as this view.

See also: SelectorLastUsedItemContextLabel

The context label used when the SelectorLastUsedItemContext is set to ByLabel. Views that are assigned the same label share the same default selections.

See also: SelectorLastUsedItemContext

StatusBarContentAlignment.Center

Controls the alignment of the progress text within the progress text area on the status bar.

ProgressTextAlign is only applicable when ShowStatusBar is true.

See also: ShowStatusBar, ShowProgressText

true

Controls whether the progress text is displayed in the status bar. ShowProgressText is only applicable when ShowStatusBar is true.

See also: ShowStatusBar, ProgressTextAlign

true

Controls whether the status bar is displayed in the view window.

See also: ShowStatusIcon, ShowStatusText, ShowProgressText, ProgressTextAlign

true

Controls whether the status icon is displayed in the status bar. ShowStatusIcon is only applicable when ShowStatusBar is true.

See also: ShowStatusBar, ShowStatusText

true

Controls whether a status icon is displayed on the view window tab.

true

Controls whether the status text is displayed in the status bar. ShowStatusText is only applicable when ShowStatusBar is true.

See also: ShowStatusBar, ShowStatusIcon

Ready to Build

The text displayed in the status bar to indicate the view is buildable as determined by the view state. For instance, a view that has selectors is typically considered buildable when each selector has a selected item.

Cancelled

The text displayed in the status bar to indicate the view was cancelled.

Error

The text displayed in the status bar to indicate a view operation failed.

Information

The text displayed in the status bar to indicate that the status details contain information. The details are displayed when the Details button is clicked.

Not Ready to Build

The text displayed in the status bar to indicate the view is not buildable as determined by the view state.

Ready

The text displayed in the status bar to indicate a view operation is complete.

Selection Changed

The text displayed in the status bar to indicate a selection changed.

Waiting for Essbase Login

The text displayed in the status bar to indicate the view is waiting for an Essbase login.

Waiting for Server Response

The text displayed in the status bar to indicate the view is waiting for a response from the server.

Warning

The text displayed in the status bar to indicate that the status details contain a warning. The details are displayed when the Details button is clicked.

Working

The text displayed in the status bar to indicate a view operation is processing.

The token definitions assigned to the view. The view tokens along with the application tokens and, if applicable, selector tokens are used during token replacement.

The key of the PopupMenuTool to use as the context menu for the grid control. Any popup menu tool that is defined in the toolbars configuration assigned as the ViewToolbarsConfigurationID can be used as the grid context menu.

See also: ViewToolbarsConfigurationID

The ID of the toolbars configuration that defines the view-specific menus and tools. At run-time, the menus and tools are merged with the application menus and tools.

See also: ViewToolbarsConfigurationID

The key of the PopupMenuTool displayed when the sheet tab area of the grid control is clicked with the right mouse button. Although any popup menu tool that is defined in the toolbars configuration assigned as the ViewToolbarsConfigurationID can be specified as the sheet context menu, only a popup menu tool that contains any of the tools with the following keys should be used: InsertSheetContextMenuButton, DeleteSheetContextMenuButton, and RenameSheetContextMenuButton. The SheetContextMenu is a standard popup menu tool that contains these tools and can be imported into a toolbars configuration.

See also: ViewToolbarsConfigurationID

false

Controls whether a formula bar is displayed along the top of the grid. The formula bar contains a dropdown list of range names for the workbook and the active worksheet. It also contains an area that displays the constant value or formula stored in the active cell, and can be used to enter or edit values or formulas in cells.

The ID of the toolbars configuration that defines the view-specific menus and tools displayed within the view window.

See also: MergeableToolbarsConfigurationID

The object type ID of the Windows form that contains the user-interface controls used to display the view data.

This is a required setting.

The caption for the View Help window.

SelectorControlUIDisplayMode.DockedControl

Controls whether a docked window or a modal dialog contains the view help.

DockedControl — Displays a docked window that contains the view help. The window is docked the first time the window is displayed. The DockedControlLocation indicates along which side the window is located.

LockedDockedControl — Same as a DockedControl, except that the user cannot move the window to a different docked location.

ModalDialog — Displays a modal dialog that contains the view help. The dialog is displayed each time the user clicks the 'View Help' button, and must be closed by the user.

true

Whether to display the View Help dockable window when the view is opened.

DockedControlLocation.Right

When the DisplayMode is DockedControl or LockedDockedControl, indicates the initial docked location for the view help window.

The ID and version of the RTF binary artifact that contains the help content.

Most of the rich text formatting is supported in the View Help control, including font sizes, colors, underlines, strike-throughs, italics, bolding, and highlights as well as bulleted and numbered lists, paragraph alignment, indentation, and images.

Custom functionality in the View Help content includes: - A Worksheet Navigation Link navigates to a specified address in the workbook. The link address is GoTo|<worksheet address>, such as GoTo|'Product Analysis'!$C$10. - A Tool Click Link triggers a click action for a specified tool key. The link address is ToolClick|<tool key>, such as ToolClick|SaveView. The tool can be visible or hidden. - Workbook script functions can be included in the content. - Tokens can be included in the content.

The workbook script functions and tokens are resolved when the control is opened, and, if the RefreshOnViewBuild view setting is True, also when the view builds.

false

Whether to refresh the View Help after the view is built.

Indicates the ID of the workbook script executed by the view.