Run a script on the server using a specified command line.
| Overload Name | Description |
|---|---|
| FileBased | Run a script on the server using the specified CommandLine. |
| TextBased | Run a script, specified as the ScriptText argument, on the server using the specified CommandLine. |
Run a script on the server using the specified CommandLine.
| 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
|
| ScriptTimeout | The numbers of seconds allowed to elapse before the script is timed out. The default value of 0 indicates that no timeout is enforced. |
| Filename | The name of the file to execute on the server using the CommandLine. For the TextBased overload, if not specified, a unique file name is generated. |
| Folder | The full path of the folder that contains the Filename. |
| CommandLine | The command line to execute on the server, which can optionally contain placeholders for the following parameters, which are replaced with the actual value at runtime: %directory% - The absolute path of the specified Folder, %filename% -- The absolute path of the specified Filename, %file.separator% - The file separator used by the server operating system, and the following Essbase connection parameters: %server%, %application%, %database%, %username%, %password%. |
| ConnectionID | The ID of the Essbase connection that contains the credentials to be used by script. For an Essbase view, the ConnectionID is optional. If not specified, the view's EssbaseConnectionID is used. For a non-Essbase view, the ConnectionID must be specified. |
| BackgroundExecute | Controls whether the method is executed asynchronous. |
| CoverDuringExecute |
Controls whether the view is covered while the script is running.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| ResultPropertyName | The name of the workbook script property that receives the value of the script execution result returned from the server. The value is either True, which indicates success, or False, which indicates an error occurred. |
| DetailsPropertyName | The name of the workbook script property that receives the value of the script execution details returned from the server. If the result is True, the details represent the value returned by the script to stdout. If the result if False, the details represent the value returned by the script to stderr. |
Run a script, specified as the ScriptText argument, on the server using the specified CommandLine.
| 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
|
| ScriptTimeout | The numbers of seconds allowed to elapse before the script is timed out. The default value of 0 indicates that no timeout is enforced. |
| ScriptText | The text of the script to run on the server. The ScriptText is written to a file and the file is executed using the CommandLine. |
| CommandLine | The command line to execute on the server, which can optionally contain placeholders for the following parameters, which are replaced with the actual value at runtime: %directory% - The absolute path of the specified Folder, %filename% -- The absolute path of the specified Filename, %file.separator% - The file separator used by the server operating system, and the following Essbase connection parameters: %server%, %application%, %database%, %username%, %password%. |
| Filename | The name of the file to execute on the server using the CommandLine. For the TextBased overload, if not specified, a unique file name is generated. |
| Folder | The full path of the folder that contains the Filename. |
| Extension | The extension appended to the file created on the server. |
| ConnectionID | The ID of the Essbase connection that contains the credentials to be used by script. For an Essbase view, the ConnectionID is optional. If not specified, the view's EssbaseConnectionID is used. For a non-Essbase view, the ConnectionID must be specified. |
| BackgroundExecute | Controls whether the method is executed asynchronous. |
| CoverDuringExecute |
Controls whether the view is covered while the script is running.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| ResultPropertyName | The name of the workbook script property that receives the value of the script execution result returned from the server. The value is either True, which indicates success, or False, which indicates an error occurred. |
| DetailsPropertyName | The name of the workbook script property that receives the value of the script execution details returned from the server. If the result is True, the details represent the value returned by the script to stdout. If the result if False, the details represent the value returned by the script to stderr. |