EssbaseReport

Run an Essbase report.

The following overloads are available:

Overload Name Description
ServerBased Run an Essbase report that is defined on the server and write the output to a worksheet.
TextBased Run an Essbase report that is defined by the ReportSpec argument and write the output to a worksheet.

ServerBased

Run an Essbase report that is defined on the server and write the output to a worksheet.

Argument Description
SpecifySheetBy Select how to specify which worksheet to select while the method is being executed.
This option is limited one of the following values: <blank> SheetName SheetNumber AllSheets
SheetSpec Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty.
Address The address to have in context when the defined name is added.
CellByCell Whether the method is executed on a cell-by-cell basis or just once.
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> FALSE TRUE
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> FALSE TRUE
ReportScript The name (server-side) of the report script to run.
DoTokenReplacement Whether to do token replacement on the script text before executing it.
Specify one of the following values or an arbitrary value: <blank> FALSE TRUE
StartCell The address of the cell used as the location of the first row and column of the query results.
OutputRangeName The defined name to create for the range that contains the query results.
ConnectionID The ID of the Essbase Connection to use for the report.
Username The username to use for the Essbase connection. Leave empty if defaulting to the current login.
Password The password to use for the Essbase connection. Leave empty if defaulting to the current login.
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
DisplayUnknownMembers Controls whether unknown members are displayed in the grid.
Specify one of the following values or an arbitrary value: <blank> FALSE TRUE
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> FALSE TRUE
IncludeAttributes Controls whether an additional retrieve occurs to obtain member attributes on calulated and member cells.
Specify one of the following values or an arbitrary value: <blank> FALSE TRUE
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> None SubItems Totals
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> FALSE TRUE
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> FALSE TRUE
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> FALSE TRUE
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> FALSE TRUE
SuppressUnderscoreCharacters Controls whether rows that contain underscore characters are retrieved by Essbase operations.
Specify one of the following values or an arbitrary value: <blank> FALSE TRUE
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> FALSE TRUE
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> FALSE TRUE
UseMemberNamesAndAliasesForRows Controls whether both the member name and alias are displayed for each row dimension member.
Specify one of the following values or an arbitrary value: <blank> FALSE TRUE

TextBased

Run an Essbase report that is defined by the ReportSpec argument and write the output to a worksheet.

Argument Description
SpecifySheetBy Select how to specify which worksheet to select while the method is being executed.
This option is limited one of the following values: <blank> SheetName SheetNumber AllSheets
SheetSpec Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty.
Address The address to have in context when the defined name is added.
CellByCell Whether the method is executed on a cell-by-cell basis or just once.
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> FALSE TRUE
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> FALSE TRUE
ReportScriptID The ID of the Essbase Script that represents the report script to run.
ReportSpec The text of the report script to run.
DoTokenReplacement Whether to do token replacement on the script text before executing it.
Specify one of the following values or an arbitrary value: <blank> FALSE TRUE
StartCell The address of the cell used as the location of the first row and column of the query results.
OutputRangeName The defined name to create for the range that contains the query results.
ConnectionID The ID of the Essbase Connection to use for the report.
Username The username to use for the Essbase connection. Leave empty if defaulting to the current login.
Password The password to use for the Essbase connection. Leave empty if defaulting to the current login.
SynchronizeCharts Whether to synchronize the chart, if any, associated with the retrieve range.
Specify one of the following values or an arbitrary value: <blank> FALSE TRUE
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
DisplayUnknownMembers Controls whether unknown members are displayed in the grid.
Specify one of the following values or an arbitrary value: <blank> FALSE TRUE
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> FALSE TRUE
IncludeAttributes Controls whether an additional retrieve occurs to obtain member attributes on calulated and member cells.
Specify one of the following values or an arbitrary value: <blank> FALSE TRUE
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> None SubItems Totals
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> FALSE TRUE
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> FALSE TRUE
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> FALSE TRUE
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> FALSE TRUE
SuppressUnderscoreCharacters Controls whether rows that contain underscore characters are retrieved by Essbase operations.
Specify one of the following values or an arbitrary value: <blank> FALSE TRUE
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> FALSE TRUE
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> FALSE TRUE
UseMemberNamesAndAliasesForRows Controls whether both the member name and alias are displayed for each row dimension member.
Specify one of the following values or an arbitrary value: <blank> FALSE TRUE