Do an Essbase retrieve.
| Overload Name | Description |
|---|---|
| Adhoc | Performs an Essbase retrieve operation for an Ad-hoc Essbase view. |
| General | Performs an Essbase retrieve operation for an Excel Essbase view. |
| Range | Performs an Essbase retrieve operation on a specific range for an Excel Essbase view. |
Performs an Essbase retrieve operation for an Ad-hoc Essbase view.
| Argument | Description |
|---|---|
| SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank>SheetNameSheetNumberAllSheets
|
| SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
| Address | The address of a range to select for the execution of the method. |
| CellByCell (8.0) | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
| ReverseOrder (8.0) | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
| MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| CellCondition (8.0) |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| EssbaseConnectionID | The Essbase connection ID. |
| ReplaceTokens |
Whether to do token replacement before the retrieve.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| SynchronizeCharts |
Whether to synchronize the chart, if any, associated with the retrieve range.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| AliasTableName | 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 |
| AutoAddRetrieveSubRanges (8.1) |
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. 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. If left blank the View's setting for AutoAddRetrieveSubRanges will be used.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| DisplayUnknownMembers |
Controls whether unknown members are displayed in the grid.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| EnableHybridAnalysis |
Controls whether Hybrid Analysis is enabled for Essbase operations. If enabled, members from a Hybrid Analysis relational source are displayed.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| Indentation |
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.
Specify one of the following values or an arbitrary value:
<blank>NoneSubItemsTotals
|
| MissingLabel | The string used for missing values by Essbase operations. |
| NavigateWithoutData |
Controls whether the Essbase operations are performed without returning any data. NavigateWithoutData is only applicable when UpdateMode is false.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| NoAccessLabel | The string used for data to which the user has no access during Essbase operations. |
| RepeatMemberLabels |
Controls whether member names are repeated in data retrieved by Essbase operations.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| RetrieveUpdateMode |
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.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| SuppressMissingRows |
Controls whether rows that contain missing values are retrieved by Essbase operations. SuppressMissingRows is only applicable when RetainOnRetrieval is false.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| SuppressUnderscoreCharacters |
Controls whether rows that contain underscore characters are retrieved by Essbase operations.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| SuppressZeroRows |
Controls whether rows that contain zeros are retrieved by Essbase operations. SuppressZeroRows is only applicable when RetainOnRetrieval is false.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| UseAliases |
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
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| UseMemberNamesAndAliasesForRows |
Controls whether both the member name and alias are displayed for each row dimension member. If left blank the View's setting for UseMemberNamesAndAliasesForRowDimensions will be used.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
Performs an Essbase retrieve operation for an Excel Essbase view.
| Argument | Description |
|---|---|
| SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank>SheetNameSheetNumberAllSheets
|
| SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
| Address (8.0) | The address of a range to select for the execution of the method. |
| CellByCell (8.0) | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
| ReverseOrder (8.0) | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
| MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| CellCondition (8.0) |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| RetrievePolicy |
Indicates whether only the active sheet, or all sheets, or all retrieve ranges should be retrieved when performing an Essbase retrieve operation.
Specify one of the following values or an arbitrary value:
<blank>NoneActiveSheetAllSheetsRetrieveRanges
|
| ReplaceTokens |
Whether to do token replacement before the retrieve.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| SynchronizeCharts |
Whether to synchronize the chart, if any, associated with the retrieve range.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| AliasTableName | 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 |
| AutoAddRetrieveSubRanges (8.1) |
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. 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. If left blank the View's setting for AutoAddRetrieveSubRanges will be used.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| DisplayUnknownMembers |
Controls whether unknown members are displayed in the grid.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| EnableHybridAnalysis |
Controls whether Hybrid Analysis is enabled for Essbase operations. If enabled, members from a Hybrid Analysis relational source are displayed.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| Indentation |
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.
Specify one of the following values or an arbitrary value:
<blank>NoneSubItemsTotals
|
| MissingLabel | The string used for missing values by Essbase operations. |
| NavigateWithoutData |
Controls whether the Essbase operations are performed without returning any data. NavigateWithoutData is only applicable when UpdateMode is false.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| NoAccessLabel | The string used for data to which the user has no access during Essbase operations. |
| RepeatMemberLabels |
Controls whether member names are repeated in data retrieved by Essbase operations.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| RetainFormulasOnRetrieval |
Whether formulas are retained within data ranges retrieved.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| RetrieveUpdateMode |
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.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| SuppressMissingRows |
Controls whether rows that contain missing values are retrieved by Essbase operations. SuppressMissingRows is only applicable when RetainOnRetrieval is false.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| SuppressUnderscoreCharacters |
Controls whether rows that contain underscore characters are retrieved by Essbase operations.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| SuppressZeroRows |
Controls whether rows that contain zeros are retrieved by Essbase operations. SuppressZeroRows is only applicable when RetainOnRetrieval is false.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| UseAliases |
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
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| UseMemberNamesAndAliasesForRows |
Controls whether both the member name and alias are displayed for each row dimension member. If left blank the View's setting for UseMemberNamesAndAliasesForRowDimensions will be used.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
Performs an Essbase retrieve operation on a specific range for an Excel Essbase view.
| Argument | Description |
|---|---|
| SpecifySheetBy |
Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value:
<blank>SheetNameSheetNumberAllSheets
|
| SheetSpec | Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty. |
| Address | The address of a range to select for the execution of the method. |
| CellByCell | Whether to execute the method on a cell-by-cell basis, or on the range specified by the address. |
| ReverseOrder | Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true. |
| MethodCondition |
If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| CellCondition |
If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| RangeName | The range to do the Essbase retrieve on. |
| EssbaseConnectionID | The Essbase connection ID. |
| ReplaceTokens |
Whether to do token replacement before the retrieve.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| SynchronizeCharts |
Whether to synchronize the chart, if any, associated with the retrieve range.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| AliasTableName | 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 |
| AutoAddRetrieveSubRanges (8.1) |
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. 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. If left blank the View's setting for AutoAddRetrieveSubRanges will be used.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| DisplayUnknownMembers |
Controls whether unknown members are displayed in the grid.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| EnableHybridAnalysis |
Controls whether Hybrid Analysis is enabled for Essbase operations. If enabled, members from a Hybrid Analysis relational source are displayed.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| Indentation |
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.
Specify one of the following values or an arbitrary value:
<blank>NoneSubItemsTotals
|
| MissingLabel | The string used for missing values by Essbase operations. |
| NavigateWithoutData |
Controls whether the Essbase operations are performed without returning any data. NavigateWithoutData is only applicable when UpdateMode is false.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| NoAccessLabel | The string used for data to which the user has no access during Essbase operations. |
| RepeatMemberLabels |
Controls whether member names are repeated in data retrieved by Essbase operations.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| RetainFormulasOnRetrieval |
Whether formulas are retained within data ranges retrieved.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| RetrieveUpdateMode |
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.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| SuppressMissingRows |
Controls whether rows that contain missing values are retrieved by Essbase operations. SuppressMissingRows is only applicable when RetainOnRetrieval is false.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| SuppressUnderscoreCharacters |
Controls whether rows that contain underscore characters are retrieved by Essbase operations.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| SuppressZeroRows |
Controls whether rows that contain zeros are retrieved by Essbase operations. SuppressZeroRows is only applicable when RetainOnRetrieval is false.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| UseAliases |
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
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| UseMemberNamesAndAliasesForRows |
Controls whether both the member name and alias are displayed for each row dimension member. If left blank the View's setting for UseMemberNamesAndAliasesForRowDimensions will be used.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|