Essbase Tool Configuration

The Essbase Tool provides 9 comprehensive operation types covering every aspect of Oracle Essbase automation. Each tool below lists all configurable parameters.

1. Calculation Tool

Execute Essbase calculation scripts with dynamic parameter substitution. Run existing server-side calc scripts or define inline calculations.

Parameter	Description	Required
Connection	Essbase connection object (encrypted credentials)	Yes
Application	Essbase application name	Yes
Database	Essbase database (cube) name	Yes
Calc Script	Calculation script name on server or inline script	Yes
Script Parameters	Dynamic substitution variable values	No

2. Dimension Build Tool

Build or update Essbase dimensions from file or SQL data sources. Update hierarchies, add members, and restructure outlines automatically.

Parameter	Description	Required
Connection	Essbase connection object	Yes
Application	Essbase application name	Yes
Database	Essbase database name	Yes
Rules File	Dimension build rules file on the Essbase server	Yes
Data Source	File path or SQL connection for source data	Yes
Source Type	File or SQL	Yes

3. Load Data Tool

Load data into Essbase from files or SQL sources. Supports BSO and ASO storage types with options to clear data before loading.

Parameter	Description	Required
Connection	Essbase connection object	Yes
Application	Essbase application name	Yes
Database	Essbase database name	Yes
Rules File	Load rules file (optional for free-form loads)	No
Data Source	File path or SQL connection for source data	Yes
Source Type	File or SQL	Yes
Clear Option	None, All Data, or Specific Region	No
Clear Region	MDX or calc expression defining the region to clear	No
Delete Aggregates	Remove aggregated data before loading	No
Storage Type	BSO or ASO specific loading options	No

4. Export Data Tool

Export data from Essbase cubes at various levels of detail. Choose between all data, zero-level (leaf), or input-level exports.

Parameter	Description	Required
Connection	Essbase connection object	Yes
Application	Essbase application name	Yes
Database	Essbase database name	Yes
Export Level	All, Zero-Level, or Input-Level	Yes
Output File	Destination file path for exported data	Yes
Columnar Output	Export in columnar (spreadsheet-like) format	No (default: no)

5. Report Tool

Execute Essbase report scripts to generate formatted output. Supports dynamic parameter substitution for flexible reporting.

Parameter	Description	Required
Connection	Essbase connection object	Yes
Application	Essbase application name	Yes
Database	Essbase database name	Yes
Report Script	Report script name on server or inline script	Yes
Script Parameters	Dynamic substitution values for the report	No
Output File	Destination file for report output	Yes

6. MaxL Tool

Execute MaxL administration statements against Essbase. InTouch handles login and logout automatically so you can focus on the commands.

Parameter	Description	Required
Connection	Essbase connection object	Yes
MaxL Statement	MaxL command(s) to execute	Yes
Auto Login	Automatically handle login/logout session management	No (default: yes)

7. Start Application Tool

Start an Essbase application and optionally enable user access. Use in workflows to bring applications online before data loads or calculations.

Parameter	Description	Required
Connection	Essbase connection object	Yes
Application	Essbase application name to start	Yes
Enable Access	Enable user access after application starts	No (default: yes)

8. Stop Application Tool

Gracefully stop an Essbase application. Typically used before backup operations or maintenance windows.

Parameter	Description	Required
Connection	Essbase connection object	Yes
Application	Essbase application name to stop	Yes
Disable Access	Disable user access before stopping	No (default: yes)

9. Update Variables Tool

Update Essbase substitution variables programmatically. Automate period rolls, scenario changes, and other variable updates that drive calculations and reports.

Parameter	Description	Required
Connection	Essbase connection object	Yes
Application	Essbase application name	Yes
Variables	List of variable name/value pairs to set	Yes
Scope	Application-level or database-level variable scope	No (default: application)