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
Note: The Oracle Essbase connector supports versions 11.1.2.2.x, 11.1.2.3, 11.1.2.4, and 11.2.
To enable these commands, an IT admin first creates an Oracle Essbase connector.
Clear Data
To clear data from a given database, add a Clear Data command.
Properties
| Property |
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 Data to Clear 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
To create a copy of an application, add a Copy Application command.
Properties
| Property |
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 |
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Copy Database
To create a copy of a database, add a Copy Database command.
Properties
| Property |
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 |
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Database Access
To grant a user group access privileges within a database, add a Database Access command.
Properties
| Property |
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
| Code |
Type |
Detail |
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Database Info
To retrieve information and recent queries from the database, add a Database Info command.
Properties
| Property |
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 |
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Delete File
To delete a file on the server, add a Delete File command.
Properties
| Property |
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 |
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Display Session
To retrieve information about the current session, add a Display Session command.
Properties
| Property |
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
To download a file from the server, add a Download File command.
Properties
| Property |
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
To remove a lock from a given database, add a Drop Lock command.
Properties
| Property |
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
To execute a calculation script, add an Execute Calculation Script command.
Properties
| Property |
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
To execute a MaxL script from a file, add an Execute MaxL command.
Properties
| Property |
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
To execute a report script, add an Execute Report Script command.
Properties
| Property |
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
To export data from a given database, add an Export Data command.
Properties
| Property |
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
To grant a user execute privileges for a given calculation, add a Grant Execute command.
Properties
| Property |
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
To list the available applications on the Essbase server, add a List Applications command.
Properties
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
To list the available databases for a given application, add a List Databases command.
Properties
| Property |
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
To list the files for a given application or database, add a List Files command.
Properties
| Property |
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
To list the filters for a given application and database, add a List Filters command.
Properties
| Property |
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
To list the locks for a given application and database, add a List Locks command.
Properties
| Property |
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
To list the variables for a given application or database, add a List Variables command.
Properties
| Property |
Detail |
| Variable Location |
Select whether the variable's set at the Application, Database, or Global level |
| Application |
If Variable Location is Application or Database, enter the name of Essbase application |
| Database |
If Variable Location 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
To load data from a file on the server, add a Load Data from File command.
Properties
| Property |
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
To load data from a SQL source, add a Load Data from SQL command.
Properties
| Property |
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
To load metadata from a file on the server, add a Load Metadata command.
Properties
| Property |
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 |
MDX Query
To execute a multidimensional expressions (MDX) query, add an MDX Query command.
Properties
| Property |
Detail |
| Query Text |
Enter the text of the MDX query. No semicolon (;) is required at the end.
Note: This is optional if Query File is provided.
|
| Query File |
Upload the MDX script as a file.
Note: This is optional if Query Text is provided.
|
| Application |
Enter the name of the Essbase application. |
| Database |
Enter the name of the Essbase database. |
| Member Identifier |
Select whether to identify members in the query results by name, alias, or unique name. |
| Preserve Tuples |
To retain any tuples—or groupings of data—from the query in its CSV output, check this box. |
| Tuple Delimiter |
If Preserve Tuples is checked, enter the delimiter used to separate tuples. |
| Remove Header |
To not include a header in the MDX query CSV, check this box. |
Outputs
| Output |
Output Type |
| MDX Query CSV |
File |
| MDX Query Record Count |
Integer |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Manage Application
To start, stop, or manage connections to a given application, add a Manage Application command.
Properties
| Property |
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
To start or stop a given database, add a Manage Database command.
Properties
| Property |
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
To create, update, or delete a variable, add a Manage Variable command.
Properties
| Property |
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
To set a calculation script to be the default calculation, add a Set Default Calculation command.
Properties
| Property |
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
To upload a file to the server, add an Upload File command.
Properties
| Property |
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 |