|
Classic file types are no longer available for use as of January 2021. You can transition your classic files or download a PDF. Learn More

Workiva Support Center

Oracle Essbase commands

Oracle Essbase commands

  • Last updated on

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
Compatibility Notice: Workiva has tested and validated this connector exclusively with versions 11.1.2.2.x, 11.1.2.3, 11.1.2.4, and 11.2. Workiva cannot guarantee that this connector will operate as desired with untested versions.

To enable these commands, an IT admin first creates an Oracle Essbase connector.

ASO/BSO export to tabular

To export aggregate storage option (ASO) or block storage option (BSO) data to a tabular file, add an ASO/BSO export to tabular command.

Properties

Property Detail
Application Enter the name of the Essbase application.
Database Enter the Essbase database to export from.
Export file name Enter the absolute file path of the data on the Essbase server to export.
Data level For BSO data, select whether to export all data or only Level 1 or input data.
Headers To include a header row in the tabular output, list the headers for the columns.
Use columns To use columns in the tabular export, check this box.

Outputs

Output Output type
Tabular file File

Exit codes

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

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
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
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

Exit codes

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
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
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.

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 from a file or text, add an Execute calculation script command.

Tip: To execute a large script, provide it as a file. For example, upload it as a workspace resource, or select the output of a Handlebars command earlier in the chain.

Properties

Property Detail
Application Enter the name of the Essbase application.
Database Enter the name of the Essbase database.
Script file Select the script file to execute. Alternatively, enter the script as text in Script text.
Script text Enter the text of the calculation script to execute. Alternatively, enter the script as a file in Script file.

Outputs

Output Output type
Calc script output File

Exit codes

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

Execute MaxL

To run a MaxL script, add an Execute MaxL Script command.

Oracle removed support for this command in version 12.2.1.0. If you use this command with Essbase version 12.2.1.0 or later, the command could fail and cause your chain to stop. Before using this command, please verify your Oracle Essbase version to ensure it's compatible. (See Oracle® Essbase Readme Release 12.2.1.0.0 (2016).)

Properties

Property Detail
Script file Select the MaxL script file to execute. Alternatively, enter the script as text in Script text.
Script text Enter the text of the MaxL script to execute. Alternatively, enter the script as a file in Script file.

Outputs

Output Output type
MaxL script output File

Exit codes

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

Execute report script

To execute a report script as a file or text, add an Execute report script command. 

Properties

Property Detail
Application Enter the name of Essbase application.
Database Enter the name of Essbase database.
Report script file Select the report script file to execute. Alternatively, enter the script as text in Script text. 
Script text Enter the text of the report script to execute. Alternatively, enter the script as a file in Report script file.

Outputs

Output Output type
Report script output File

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 source.
External password Enter the password for a data load external source.

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. Optional 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 To rename the uploaded file, enter its new name.
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
To manage on-premise Oracle Essbase® cubes as part of a chain, add a step that includes an Oracle Essbase connection ...