Run an Essbase calc.
| Overload Name | Description |
|---|---|
| DefaultCalc | Run the cube's default Calc. |
| General | Run an Essbase Calc. |
| ServerBased | Run Essbase Calc that is defined on the server. |
| TextBased | Run an Essbase Calc defined by the ScriptText argument. |
Run the cube's default Calc.
| 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
|
| BackgroundCalc | Whether the method is executed asynchronous. |
| ConnectionID | The ID of the Essbase Connection to use for the Calc. |
| 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. |
| CoverDuringCalc |
Controls whether the view is covered while the calc is running.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| ProgressTextStarted | (Optional) The text string displayed as the progress text in the status bar before the calc is run. If no value is specified, "Running Calc" is displayed as the progress text. |
| ProgressTextCompleted | (Optional) The text string displayed as the progress text in the status bar after the calc is completed. If no value is specified, "Calc completed" is displayed as the progress text. |
| ProgressTextFailed | (Optional) The text string displayed as the progress text in the status bar if the calc fails. If no value is specified, "Calc failed" is displayed as the progress text. |
| ErrorPropertyName | (Optional) The name of the workbook script property that receives the error message if the calc returns an exception. |
Run an Essbase Calc.
| 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
|
| ScriptName | The name (server-side) of the script to run. |
| CalcScriptID (7.3) | The ID of the Essbase Script that represents the calc script to run. |
| ScriptText | The text of the script to run. |
| BackgroundCalc | Whether the method is executed asynchronous. |
| AddLineIndex | The line number of the calc script to add a line at. Leave this argument empty to add at the end of the script. |
| AddLineText | A line of calc script text to add to the calc script. |
| 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
|
| ConnectionID | The ID of the Essbase Connection to use for the Calc. |
| 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. |
| CoverDuringCalc |
Controls whether the view is covered while the calc is running.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| ProgressTextStarted | (Optional) The text string displayed as the progress text in the status bar before the calc is run. If no value is specified, "Running Calc" is displayed as the progress text. |
| ProgressTextCompleted | (Optional) The text string displayed as the progress text in the status bar after the calc is completed. If no value is specified, "Calc completed" is displayed as the progress text. |
| ProgressTextFailed | (Optional) The text string displayed as the progress text in the status bar if the calc fails. If no value is specified, "Calc failed" is displayed as the progress text. |
| ErrorPropertyName | (Optional) The name of the workbook script property that receives the error message if the calc returns an exception. |
Run Essbase Calc that is defined on the server.
| 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
|
| ScriptName | The name (server-side) of the script to run. |
| RuntimeSubVars (7.7) |
(Optional) The runtime substitution variables that are used in a calculation script. The variables are specified as a delimited string of substitution variables and member pairs, such as currMarket="Florida";currScenario="Actual"; |
| 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
|
| BackgroundCalc | Whether the method is executed asynchronous. |
| ConnectionID | The ID of the Essbase Connection to use for the Calc. |
| 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. |
| CoverDuringCalc |
Controls whether the view is covered while the calc is running.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| ProgressTextStarted | (Optional) The text string displayed as the progress text in the status bar before the calc is run. If no value is specified, "Running Calc" is displayed as the progress text. |
| ProgressTextCompleted | (Optional) The text string displayed as the progress text in the status bar after the calc is completed. If no value is specified, "Calc completed" is displayed as the progress text. |
| ProgressTextFailed | (Optional) The text string displayed as the progress text in the status bar if the calc fails. If no value is specified, "Calc failed" is displayed as the progress text. |
| ErrorPropertyName | (Optional) The name of the workbook script property that receives the error message if the calc returns an exception. |
Run an Essbase Calc defined by the ScriptText argument.
| 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
|
| CalcScriptID (7.3) | The ID of the Essbase Script that represents the calc script to run. |
| ScriptText | The text of the script to run. |
| RuntimeSubVars (7.7) |
(Optional) The runtime substitution variables that are used in a calculation script. The variables are specified as a delimited string of substitution variables and member pairs, such as currMarket="Florida";currScenario="Actual"; |
| 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
|
| BackgroundCalc | Whether the method is executed asynchronous. |
| ConnectionID | The ID of the Essbase Connection to use for the Calc. |
| 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. |
| CoverDuringCalc |
Controls whether the view is covered while the calc is running.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| ProgressTextStarted | (Optional) The text string displayed as the progress text in the status bar before the calc is run. If no value is specified, "Running Calc" is displayed as the progress text. |
| ProgressTextCompleted | (Optional) The text string displayed as the progress text in the status bar after the calc is completed. If no value is specified, "Calc completed" is displayed as the progress text. |
| ProgressTextFailed | (Optional) The text string displayed as the progress text in the status bar if the calc fails. If no value is specified, "Calc failed" is displayed as the progress text. |
| ErrorPropertyName | (Optional) The name of the workbook script property that receives the error message if the calc returns an exception. |