Help Desk

Submit a ticket My Tickets
Welcome
Login

Oracle Essbase Command Reference

Essbase 11.x BizApp

Connections

Oracle Essbase

Oracle Essbase Java API connection

Inputs

Input Type Detail Notes
User Name TextField Essbase user name
Password TextField Essbase Password
Instance URL TextField The base URL of your Essbase Instance. In many cases, it may just be an IP address, proceeded by the proper protocol (i.e. http://100.0.0.1)
Cluster Name TextField Name of the Essbase cluster to which you are connecting. Essbase will call this "EssbaseCluster" by default.
Java API Path TextField The path to your Essbase JAR files. These files are installed by default in your Essbase directory, and the path will contain "EssbaseJavaAPI\VERSION". The full path to the directory containing the .jar files is required.
Embedded Mode Enabled BooleanField Enables extended outputs for calc scripts, MaxL, and session information. Do NOT enable this setting if your Essbase instance is running in embedded mode.

Commands

Clear Data

Clears data from a given database

Inputs

Input Type Detail Notes
Application TextField Essbase application
Database TextField Essbase database
Data to Clear DropdownField Option for clearing either all data or only partial data
Clear Data Expression TextField Optional - for clearing partial data only: MDX set expression which specifies the region to be cleared

Outputs

None

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
3 Error General failure

Copy Application

Creates a copy of an application

Inputs

Input Type Detail Notes
Application TextField Essbase application
Destination Application TextField Name of the new application to be created

Outputs

None

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
3 Error General failure

Copy Database

Creates a copy of a database

Inputs

Input Type Detail Notes
Application TextField Essbase application
Database TextField Name of the database to copy
Destination Application TextField Name of the new application in which the new database will be created
Destination Database TextField Name of the new database to be created from the copy

Outputs

None

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
3 Error General failure

Database Access

Grants a user group access privileges within a database

Inputs

Input Type Detail Notes
Application TextField Essbase application
Database TextField Essbase database
User group TextField User group for which access will be changed
Access Type DropdownField Type of access to be granted

Outputs

None

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
3 Error General failure

Database Info

Reveals information and recent queries from the database

Inputs

Input Type Detail Notes
Application TextField Essbase application
Database TextField Essbase database

Outputs

None

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
3 Error General failure

Delete File

Deletes a file on the server

Inputs

Input Type Detail Notes
Application TextField Essbase application
Database TextField Essbase database
File TextField File to be deleted

Outputs

None

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
3 Error General failure

Display Session

Reveals information about the current session

Inputs

Input Type Detail Notes
Application TextField Essbase application
Database TextField Essbase database

Outputs

Output Output Type Notes
Session output file File

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
3 Error General failure

Download File

Downloads a file from the server

Inputs

Input Type Detail Notes
Application TextField Essbase application
Database TextField Essbase database
File TextField File to be downloaded

Outputs

Output Output Type Notes
Essbase Downloaded File File

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
3 Error General failure

Drop Lock

Removes a lock from a given database

Inputs

Input Type Detail Notes
Application TextField Essbase application
Database TextField Essbase database

Outputs

None

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
3 Error General failure

Execute Calculation Script

Executes a calculation script

Inputs

Input Type Detail Notes
Application TextField Essbase application
Database TextField Essbase database
Script File TextField Calculation script file name. Optional if Script Text is specified
Script Text TextField Calculation script text. Optional if Script File is specified

Outputs

Output Output Type Notes
Calc Script Output File

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
3 Error General failure

Execute MaxL

Executes a MaxL script from a file

Inputs

Input Type Detail Notes
Script File FileField MaxL script file (must be a file). Optional if Script Text is specified
Script Text TextField MaxL script text (lines separated by a newline character). Optional if Script File is specified

Outputs

Output Output Type Notes
MaxL Output File File

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
3 Error General failure

Execute Report Script

Executes a report script

Inputs

Input Type Detail Notes
Application TextField Essbase application
Database TextField Essbase database
Report Script File FileField Report script file. Can exist locally or on the Essbase server under the specified database directory. Optional if Script Text is specified
Script Text TextField Report script text. Optional if Report Script File is specified

Outputs

Output Output Type Notes
Report Script Output File

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
3 Error General failure

Export Data

Exports data from a given database

Inputs

Input Type Detail Notes
Application TextField Essbase application
Database TextField Essbase database
Export File Name TextField Name of the file to which the data will be exported
Data Level DropdownField Level of data to be exported
Use columns BooleanField Use columns in data export

Outputs

Output Output Type Notes
Export Data File Name String

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
3 Error General failure

Grant Execute

Grants a user execute privileges for a given calculation

Inputs

Input Type Detail Notes
Application TextField Essbase application
Database TextField Essbase database
Calc Name TextField Calculation name
Access User TextField User name to be granted access

Outputs

None

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
3 Error General failure

List Applications

Lists the available applications on the Essbase server

Inputs

None

Outputs

Output Output Type Notes
Essbase Applications Array

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
3 Error General failure

List Databases

Lists the available databases for a given application

Inputs

Input Type Detail Notes
Application TextField Essbase application

Outputs

Output Output Type Notes
Essbase Databases Array

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
3 Error General failure

List Files

Lists the files for a given application or database

Inputs

Input Type Detail Notes
Application TextField Essbase application
Database TextField Essbase database
File Type DropdownField Restricts the search based on the type of file
Filter TextField Optional: A filter using glob syntax (i.e. list* for files starting with "list") to further refine the results

Outputs

Output Output Type Notes
Essbase Files Array
Essbase Files CSV File

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
3 Error General failure

List Filters

Lists the filters for a given application and database

Inputs

Input Type Detail Notes
Application TextField Essbase application
Database TextField Essbase database

Outputs

Output Output Type Notes
Essbase Filters Array

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
3 Error General failure

List Locks

Lists the locks for a given application and database

Inputs

Input Type Detail Notes
Application TextField Essbase application
Database TextField Essbase database

Outputs

Output Output Type Notes
Essbase Locks Array

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
3 Error General failure

List Variables

Lists the variables for a given application or database

Inputs

Input Type Detail Notes
Variable Location DropdownField The variable's location (i.e. if it is not set at the application level, then it is a global variable)
Application TextField Essbase application - Required if you are specifying an application or database variable
Database TextField Essbase database - Required if you are specified a database variable

Outputs

Output Output Type Notes
Essbase Variables Array

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
3 Error General failure

Load Data from File

Loads data from a file on the server

Inputs

Input Type Detail Notes
Application TextField Essbase application
Database TextField Essbase database
Data file FileField Name of the data file on the server to load (without extension)
Rule file TextField Rule file for loading data (without extension). Optional only if the data can be loaded as-is
Abort on error BooleanField Aborts operation on error

Outputs

None

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
3 Error General failure

Load Data from SQL

Loads data from a SQL source

Inputs

Input Type Detail Notes
Application TextField Essbase application
Database TextField Essbase database
Rule file TextField The rules file name in the olap server (without extension). For example, for the rules file named Data.rul in olap server's app/cube directory pass "Data"
Abort on error BooleanField Aborts operation on error
External Username TextField Username for the data load external source
External Password TextField Password for the data load external source

Outputs

None

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
3 Error General failure

Load Metadata

Loads metadata from a file on the server

Inputs

Input Type Detail Notes
Application TextField Essbase application
Database TextField Essbase database
Data File TextField Name of the data file on the server to load
Rule file TextField Rule file for loading metadata. Optional only if the data can be loaded as-is
Force BooleanField Force load without verifying the outline

Outputs

Output Output Type Notes
Metadata load error file File

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
3 Error General failure

MDX Query

Executes an MDX Query

Inputs

Input Type Detail Notes
Query Text TextField MDX query. Optional if Query File is specified - no semicolon is required at the end.
Query File FileField MDX script file. Optional if Query Text is specified
Application TextField Essbase Application
Database TextField Essbase Database
Member Identifier DropdownField Member Identifier for cells in query output
Preserve Tuples BooleanField When checked, this option prints your output CSV with tuples intact. This is useful when your query contains tuples in your column names.
Tuple Delimiter TextField The delimiter to use to separate tuples. This only applies if Preserve Tuples is checked.
Remove Header BooleanField When checked, the output CSV is produced without a header.

Outputs

Output Output Type Notes
MDX Query CSV File
MDX Query Record Count Integer

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
3 Error General failure

Manage Application

Starts, stops, or manages connections to a given application

Inputs

Input Type Detail Notes
Application TextField Essbase application
Action DropdownField Action to be taken

Outputs

None

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
3 Error General failure

Manage Database

Starts or stops a given database

Inputs

Input Type Detail Notes
Application TextField Essbase application
Database TextField Essbase database
Action DropdownField Action to be taken

Outputs

None

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
3 Error General failure

Manage Variable

Creates, updates, or deletes a variable

Inputs

Input Type Detail Notes
Variable Location DropdownField The variable's location (i.e. if it is not set at the application level, then it is a global variable)
Action DropdownField Action to be taken
Variable Name TextField Name of the variable to be modified
Variable Value TextField Value of the variable to be set. Leave blank if deleting variable
Application TextField Essbase application - Required if you are specifying an application or database variable
Database TextField Essbase database - Required if you are specified a database variable

Outputs

None

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
3 Error General failure

Set Default Calculation

Sets a calculation script to be the default calculation

Inputs

Input Type Detail Notes
Application TextField Essbase application
Database TextField Essbase database
Script File TextField Name of calculation script to be made default

Outputs

None

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
3 Error General failure

Upload File

Uploads a file to the server

Inputs

Input Type Detail Notes
Application TextField Essbase application
Database TextField Essbase database
File FileField Source file to be uploaded
Upload Name TextField Optional: Name of the file to be persisted on the server (in case it is different from the name of the file you are using)
Overwrite BooleanField When selected, overwrites an existing file already on the server

Outputs

None

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
3 Error General failure
B
Brian is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.