Run an Essbase report.
| 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. |
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.
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
|
| 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>FALSETRUE
|
| 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>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
|
| AttributesPolicy (8.0) |
Controls whether the server performs a retrieve on the results returned by the script in order to obtain attributes for the member and data cells, which are then returned with the results to the client. When specified, the AttributesPolicy argument takes precedence over the deprecated Attributes argument. When the AttributesPolicy argument is not specified and the Attributes argument is specified, the Attributes argument is used, but the value is reversed as was the behavior prior to the deprecation of the Attributes argument. When neither argument is specified, attributes are returned. WARNING: Attributes should not be included if the report script suppresses page and column headings using {SUPPAGEHEADING} and {SUPCOLHEADING}.
Specify one of the following values or an arbitrary value:
<blank>IncludeAttributesNoAttributes
|
| IncludeAttributes (7.3) (Deprecated in: 8.0.0) |
Controls whether the server performs a retrieve on the results returned by the script in order to obtain attributes for the member and data cells, which are then returned with the results to the client.
Specify one of the following values or an arbitrary value:
The IncludeAttributes argument has been deprecated, since the value of the argument is reversed in the request sent to the server. The AttributesPolicy argument can be used instead to control whether member and data cell attributes are returned with the results.
<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
|
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.
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
|
| ReportScriptID (7.3) | 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>FALSETRUE
|
| 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>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 |
| 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
|
| AttributesPolicy (8.0) |
Controls whether the server performs a retrieve on the results returned by the script in order to obtain attributes for the member and data cells, which are then returned with the results to the client. When specified, the AttributesPolicy argument takes precedence over the deprecated Attributes argument. When the AttributesPolicy argument is not specified and the Attributes argument is specified, the Attributes argument is used, but the value is reversed as was the behavior prior to the deprecation of the Attributes argument. When neither argument is specified, attributes are returned. WARNING: Attributes should not be included if the report script suppresses page and column headings using {SUPPAGEHEADING} and {SUPCOLHEADING}.
Specify one of the following values or an arbitrary value:
<blank>IncludeAttributesNoAttributes
|
| IncludeAttributes (7.3) (Deprecated in: 8.0.0) |
Controls whether the server performs a retrieve on the results returned by the script in order to obtain attributes for the member and data cells, which are then returned with the results to the client.
Specify one of the following values or an arbitrary value:
The IncludeAttributes argument has been deprecated, since the value of the argument is reversed in the request sent to the server. The AttributesPolicy argument can be used instead to control whether member and data cell attributes are returned with the results.
<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
|