To manage on-premise Oracle Essbase® cubes as part of a chain, add a step that includes an Oracle Essbase connection command. For example:
- Load and extract data
- Execute calculations
- Manage system settings
Connection Properties
To enable these commands, an IT admin first creates an Oracle Essbase connection and configures its credentials and properties. The connection interacts with Oracle Essbase versions 11.x and greater via the published Java API.
| Input |
Detail |
| User Name |
Enter the Essbase username |
| Password |
Enter the Essbase password |
| Instance URL |
Enter the base URL of the Essbase instance. This is likely an IP address preceded by the proper protocol, such as http://100.0.0.1; or the URL for your Analytic Provider Services (APS), such as http://100.0.01:19000. |
| Cluster Name |
Enter the name of the Essbase cluster to connect to, such as the default EssbaseCluster |
| Java API Path |
Enter the full path to the directory containing the Essbase JAR files. By default, these files install in your Essbase directory, and the path contains EssbaseJavaAPI\VERSION.
Note: If the GroundRunner is on the same server as Oracle Essbase, enter the folder location of the client JAR files. If a different server, copy the JAR files to a new folder on the server hosting the GroundRunner, and enter the path to that folder.
|
Note: All sensitive credentials are automatically encrypted and stored at 2,048-bit encryption.
Essbase JAR Files
Oracle Essbase requires access to these client JAR files:
ess_es_server.jaress_japi.jaress_maxl.jar
You can find these files where your Essbase is installed; by default:
- For Windows®,
C:\Oracle\Middleware\EPMSystem11R1\common\EssbaseJavaAPI\11.1.2.0\lib
- For Linux®,
/User/<username>/Oracle/Middleware/EPMSystem11R1/common/EssbaseJavaAPI/11.1.2.0/lib
Clear Data
Clears data from a given database
Inputs
| Input |
Detail |
| Application |
Enter the name of the Essbase application |
| Database |
Enter the Essbase database to clear data from |
| Data to Clear |
Select whether to clear all or only partial data |
| Clear Data Expression |
If the Data to Clear input is Partial, enter the multidimensional expression (MDX) to specify the region to clear |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Copy Application
Creates a copy of an application
Inputs
| Input |
Detail |
| Application |
Enter the name of the Essbase application |
| Destination Application |
Enter the name of the new application to create |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Copy Database
Creates a copy of a database
Inputs
| Input |
Detail |
| Application |
Enter the name of the Essbase application |
| Database |
Enter the name of the Essbase database to copy |
| Destination Application |
Enter the name of the new application to create the new database in |
| Destination Database |
Enter the name of the new database to create from the copy |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Database Access
Grants a user group access privileges within a database
Inputs
| Input |
Detail |
| Application |
Enter the name of the Essbase application |
| Database |
Enter the name of the Essbase database to grant access to |
| User Group |
Enter the name of the user group to access the database |
| Access Type |
Select the type of access to grant |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Database Info
Retrieves information and recent queries from the database
Inputs
| Input |
Detail |
| Application |
Enter the name of the Essbase application |
| Database |
Enter the name of the Essbase database to get information from |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Delete File
Deletes a file on the server
Inputs
| Input |
Detail |
| Application |
Enter the name of the Essbase application |
| Database |
Enter the name of the Essbase database to delete the file from |
| File |
Enter the name of the file to delete |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Display Session
Retrieves information about the current session
Inputs
| Input |
Detail |
| Application |
Enter the name of the Essbase application |
| Database |
Enter the name of the Essbase database to retrieve session information from |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Download File
Downloads a file from the server
Inputs
| Input |
Detail |
| Application |
Enter the name of the Essbase application |
| Database |
Enter the name of the Essbase database to download the file from |
| File |
Enter the name of the file to download |
Outputs
| Output |
Output Type |
| Essbase Downloaded File |
File |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Drop Lock
Removes a lock from a given database
Inputs
| Input |
Detail |
| Application |
Enter the name of the Essbase application |
| Database |
Enter the name of the Essbase database to remove the lock from |
| File |
Enter the name of the file to download |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Execute Calculation Script
Executes a calculation script
Inputs
| Input |
Detail |
| Application |
Enter the name of the Essbase application |
| Database |
Enter the name of the Essbase database |
| Script File |
Enter the name of the calculation script file to execute |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Execute MaxL
Executes a MaxL script from a file
Inputs
| Input |
Detail |
| Script File |
Enter the name of the MaxL script file to execute |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Execute Report Script
Executes a report script
Inputs
| Input |
Detail |
| Application |
Enter the name of Essbase application |
| Database |
Enter the name of Essbase database |
| Script File |
Enter the name of the report script file to execute |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Export Data
Exports data from a given database
Inputs
| Input |
Detail |
| Application |
Enter the name of Essbase application |
| Database |
Enter the name of Essbase database |
| Export File Name |
Enter the name of the file to export the data to |
| Data Level |
Select the level of data to export |
| Use Columns |
To use columns in the data export, check this box |
Outputs
| Output |
Output Type |
| Export Data File Name |
String |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Grant Execute
Grants a user execute privileges for a given calculation
Inputs
| Input |
Detail |
| Application |
Enter the name of Essbase application |
| Database |
Enter the name of Essbase database |
| Calc Name |
Enter the name of the calculation to grant access to |
| Access User |
Enter the username to access the calculation |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
List Applications
Lists the available applications on the Essbase server
Inputs
None
Outputs
| Output |
Output Type |
| Essbase Applications |
Array |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
List Databases
Lists the available databases for a given application
Inputs
| Input |
Detail |
| Application |
Enter the name of Essbase application |
Outputs
| Output |
Output Type |
| Essbase Databases |
Array |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
List Files
Lists the files for a given application or database
Inputs
| Input |
Detail |
| Application |
Enter the name of Essbase application |
| Database |
Enter the name of Essbase database |
| File Type |
Select the type of file to search for |
| Filter |
To further refine the results, filter using glob syntax, such as list* for files that start with "list" |
Outputs
| Output |
Output Type |
| Essbase Files |
Array |
| Essbase Files CSV |
File |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
List Filters
Lists the filters for a given application and database
Inputs
| Input |
Detail |
| Application |
Enter the name of Essbase application |
| Database |
Enter the name of Essbase database |
Outputs
| Output |
Output Type |
| Essbase Filters |
Array |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
List Locks
Lists the locks for a given application and database
Inputs
| Input |
Detail |
| Application |
Enter the name of Essbase application |
| Database |
Enter the name of Essbase database |
Outputs
| Output |
Output Type |
| Essbase Locks |
Array |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
List Variables
Lists the variables for a given application or database
Inputs
| Input |
Detail |
| Variable Location |
Select whether the variable's set at the Application, Database, or Global level |
| Application |
If Variable Location input is Application or Database, enter the name of Essbase application |
| Database |
If Variable Location input is Database, enter the name of Essbase database |
Outputs
| Output |
Output Type |
| Essbase Variables |
Array |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Load Data from File
Loads data from a file on the server
Inputs
| Input |
Detail |
| Application |
Enter the name of Essbase application |
| Database |
Enter the name of Essbase database |
| Data File |
Enter the name of the data file on the server to load |
| Rule File |
Enter the rule file for loading data. Optional if the data can load as-is. |
| Abort on Error |
To abort an operation on error, check this box |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Load Data from SQL
Loads data from a SQL source
Inputs
| Input |
Detail |
| Application |
Enter the name of Essbase application |
| Database |
Enter the name of Essbase database |
| Rule File |
Enter the name of the rules file in the OLAP server. For example, for the rules file Data.rul in the OLAP server's app/cube directory, enter Data. |
| Abort on Error |
To abort an operation on error, check this box |
| External Username |
Enter the username for a data load external soruce |
| External Password |
Enter the password for a data load external soruce |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Load Metadata
Loads metadata from a file on the server
Inputs
| Input |
Detail |
| Application |
Enter the name of Essbase application |
| Database |
Enter the name of Essbase database |
| Data File |
Enter the name of the data file on the server to load |
| Rule File |
Enter the name of the rule file for loading data. Optionaly if data can load as-is. |
| Force |
To force the load without verifying the outline, check this box |
Outputs
| Output |
Output Type |
| Metadata Load Error File |
File |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Manage Application
Starts, stops, or manages connections to a given application
Inputs
| Input |
Detail |
| Application |
Enter the name of Essbase application |
| Action |
Select the action to take |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Manage Database
Starts or stops a given database
Inputs
| Input |
Detail |
| Application |
Enter the name of Essbase application |
| Database |
Enter the name of Essbase database |
| Action |
Select the action to take |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Manage Variable
Creates, updates, or deletes a variable
Inputs
| Input |
Detail |
| Variable Location |
Select whether the variable's set at the Application, Database, or Global level |
| Action |
Select the action to take |
| Variable Name |
Enter the name of the variable to modify |
| Variable Value |
Enter the name of the variable to set. To delete the variable, leave blank. |
| Application |
If the Variable Location input is Application or Database, enter the name of the Essbase application |
| Database |
If the Variable Location input is Database, enter the name of the Essbase database |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Set Default Calculation
Sets a calculation script to be the default calculation
Inputs
| Input |
Detail |
| Application |
Enter the name of the Essbase application |
| Database |
Enter the name of the Essbase database |
| Script File |
Enter the name of the calculation script to make default |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Upload File
Uploads a file to the server
Inputs
| Input |
Detail |
| Application |
Enter the name of the Essbase application |
| Database |
Enter the name of the Essbase database |
| File |
Enter the source file to upload |
| Upload Name |
Enter the new name of the file upon upload (optional) |
| Overwrite |
To overwrite a file already on the server, check this box |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Troubleshooting
No output received when running a command
If an Essbase command executes but the output is blank, install a compatible Java Runtime Environment (JRE), such as Oracle JRE 1.8.x.
Receive a Java "No Class Found" error
If you receive "Exception in thread "main" [] false} stdErr="java.lang.NoClassDefFoundError: com/essbase/api/base/EssException"", verify the JAR files are properly installed and configured in the connection.
Can't connect to Provider Server
If you receive "Error: com.essbase.api.base.EssException: Cannot connect to Provider Server. Make sure the signon parameters are correct and the Provider Server is running. Error authenticating with Essbase: Cannot connect to Provider Server. Make sure the signon parameters are correct and the Provider Server is running.":
- Ensure the specified server name is correct and is the provider server. Use the IP address and port number of your Essbase server only if they're on the same operating environment.
- Ensure that the specified port number is correct. By default, the port for APS is
19000.
Can't connect to Online Analytical Processing (OLAP) Service
If you receive "Error: com.essbase.api.base.EssException: Cannot connect to olap service. Cannot connect to Essbase Server. Error:Essbase Error(1042003): Network Error [11001]: Failed to retrieve name information for [Essbase-Cluster1] Error authenticating with Essbase: Cannot connect to olap service. Cannot connect to Essbase Server. Error:Essbase Error(1042003): Network Error [11001]: Failed to retrieve name information for [Essbase-Cluster1]", ensure the connection's Cluster Name is correct.