Executes a custom Java service on the dodeca-essbase server using the specified arguments.
| Overload Name | Description |
|---|---|
| General | Executes a custom Java service on the dodeca-essbase server using the specified arguments. |
Executes a custom Java service on the dodeca-essbase server using the specified arguments.
| 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
|
| ServiceName |
The name of the custom service to execute on the dodeca-essbase server. The value must correspond to a custom entry in the dodeca-essbase service’s WEB-INF\classes\dodeca-essbase-actions.properties file, which maps the service name to the fully qualified Java class name that implements the service. |
| FunctionArgumentsXml | The XML containing the arguments to pass to the service. |
| IncludeConnectionXml |
Indicates whether the Essbase connection information is included in the Xml passed to the service. If TRUE, the Java class must subclass from EssOperation or one of its subclasses. The EssConnectionManager is automatically instanced and available to the subclass in a protected method overload.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| ConnectionID | The ID of the Essbase connection that contains the credentials to be used by the service. The ConnectionID is only used when IncludeConnectionXml is True. 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. |
| IncludeGridXml |
Indicates whether the grid data is included in the Xml passed to the service. If TRUE, the Java class must subclass from EssGridOperation. The EssConnectionManager is automatically instanced and available to the subclass in a protected method overload. The EssConnectionManager.getGridView() method also returns an IEssGridView object filled with the grid data passed to the server. By default, the IEssGridView does not contain numbers passed from client. To fill the grid with numeric cells sent from the client, override the protected EssGridOperation.isUpdate() method as follows:
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| ResultPropertyName | (Optional) The name of the workbook script property that receives the value of the result returned by the function. If the property data type is Boolean, the workbook script will attempt to convert the value to True or False; otherwise, the value is treated as a string. If the property does not exist, it is created. |
| ResultsDataCacheName | (Optional) The name of the DataCache that the result values can be written to when the result string represents tabular data where rows are newline delimited and columns are tab delimited. The first column value of each row is used as the row index. |
| ResultsDataCacheUseFirstColumnAsKey |
When the ResultsDataCacheName is specified, the argument indicates whether the first column value of each result row is used as the key for the corresponding data cache row. By default, the argument value is TRUE. The argument value can be set to FALSE when there is no need to lookup a row within the data cache or when the first column potentially contains duplicate values.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| BackgroundExecute | Controls whether the function is executed asynchronous. |
| Timeout | The numbers of seconds allowed to elapse before the execution of the function is timed out on the server. The default value of 0 indicates that no timeout is enforced. |
| CoverDuringExecute |
Controls whether the view is covered while the custom function is executing.
Specify one of the following values or an arbitrary value:
<blank>FALSETRUE
|
| ProgressTextServiceStarted | (Optional) The text string displayed as the progress text in the status bar before the service is started. If no value is specified, "Custom service started" is displayed as the progress text. |
| ProgressTextServiceCompleted | (Optional) The text string displayed as the progress text in the status bar after the service completes. If no value is specified, "Custom service completed" is displayed as the progress text. |