Table of Contents

Connections

Commands

Connections

Oracle Analytics Cloud

OAC Connection with username, password, and URL

Inputs

Input

Type

Detail

Notes

User Name

TextField

OAC User Name

OAC Password

TextField

OAC Password

OAC Base URL

TextField

Your OAC instance URL. In the browser, this is the portion of the URL that ends with oraclecloud.com

Commands

Build Dimension

Loads dimensions to a cube

Inputs

Input

Type

Detail

Notes

Application

TextField

OAC Application

Database

TextField

OAC Database (cube)

Dimension file

TextField

Dimension build file name. You do not need to give a full path. Files are assumed to be in the relevant application or database directory

Rules file

TextField

Rules file name. You do not need to give a full path. Files are assumed to be in the relevant application or database directory

Restructure

DropdownField

Controls your preservation choices for the outline restructure.

Force

BooleanField

Force the dimension build without verifying the outline.

Outputs

Output

Output Type

Notes

Warning Log File

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

3

Error

General failure

Calculation Script

Calculates a cube

Inputs

Input

Type

Detail

Notes

Application

TextField

OAC Application

Database

TextField

OAC Database (cube)

Script file

TextField

Calculation script name. Must have .csc file extension. You do not need to give a full path. Files are assumed to be in the relevant application or database directory.

Outputs

Output

Output Type

Notes

Warning Log File

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

3

Error

General failure

Clear Data

Clears data from a cube

Inputs

Input

Type

Detail

Notes

Application

TextField

OAC Application

Database

TextField

OAC Database (cube)

Option

DropdownField

Optional. Keyword specifying what to clear

Region

TextField

MDX expression specifying the region to clear

Outputs

Output

Output Type

Notes

Warning Log File

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

3

Error

General failure

Create Variable

Create a substitution variable defined at the application or cube scope

Inputs

Input

Type

Detail

Notes

Application

TextField

Optional. Application name

Database

TextField

Optional. Database (cube) name

Name

TextField

The name of the variable

Value

TextField

The value of the variable

Outputs

Output

Output Type

Notes

Created Variable

Json

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

3

Error

General failure

Delete File

Removes cube artifacts from the application, database, or user home directory

Inputs

Input

Type

Detail

Notes

Application

TextField

Optional: OAC Application under which file lives. If application is not specified, will check the user directory

Database

TextField

Optional: OAC Database (cube) under which file lives.

File

TextField

Name of the file to delete

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

3

Error

General failure

Delete Variable

Delete a substitution variable defined at the application or cube scope

Inputs

Input

Type

Detail

Notes

Application

TextField

Optional. Application name

Database

TextField

Optional. Database (cube) name

Name

TextField

The name of the variable

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

3

Error

General failure

Deploy

Creates a cube from an Excel application workbook

Inputs

Input

Type

Detail

Notes

Application

TextField

Optional: Application name to be created. Will default to the name specified in workbook

Database

TextField

Optional: Database name to be created. Will default to the name specified in workbook

Excel Workbook

FileField

Name of the application workbook file. If you are referring to a file on the server, it must exist in the user's directory

Execute script

BooleanField

Optional. Execute calculation scripts, if the application workbook contains a calculation worksheet.

Create files

BooleanField

Optional. Create cube artifacts in the files directory on the cloud service instance.

Re-create application

BooleanField

Optional. Re-create the application, if it already exists.

Load data

BooleanField

Optional. Load data, if the application workbook contains a data worksheet. Otherwise, only metadata is imported into the cube.

Outputs

Output

Output Type

Notes

Warning Log File

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

3

Error

General failure

Download File

Downloads cube artifacts from an instance of Essbase to a local directory

Inputs

Input

Type

Detail

Notes

Application

TextField

Optional: OAC Application under which file lives. If application is not specified, will check the user directory

Database

TextField

Optional: OAC Database (cube) under which file lives.

File

TextField

Name of the file to download

Auto-unzip

BooleanField

Automatically un-zips the file contents. If more than one file is in the zip archive, this setting is ignored.

Outputs

Output

Output Type

Notes

Downloaded file

File

Download size

Integer

Number of lines

Integer

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

3

Error

General failure

Execute MDX Script

Runs a MDX script

Inputs

Input

Type

Detail

Notes

Application

TextField

Application name

Database

TextField

Database name

Script

TextField

Name of the script file to run. Must have the .msh extension.

Outputs

Output

Output Type

Notes

Warning Log File

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

3

Error

General failure

Execute MaxL Script

Runs a MaxL script

Inputs

Input

Type

Detail

Notes

Application

TextField

Application name

Database

TextField

Database name

Script

TextField

Name of the script file to run. Must have the .msh extension.

Outputs

Output

Output Type

Notes

Warning Log File

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

3

Error

General failure

Export Metadata

Exports dimension metadata in a tabular, parent-child format

Inputs

Input

Type

Detail

Notes

Application

TextField

Application name

Database

TextField

Database name

Dimension Name

TextField

Name of the dimension to be exported

Show Attributes

BooleanField

Optional: Show attributes along with the names of each member in the dimension. This adds significant time to the execution of the command; leave this unchecked if you only require the member names in parent-child format

Extended Attributes

BooleanField

Optional: Select this option if your members have more than 10 attributes (by default, only the first 10 are displayed)

Outputs

Output

Output Type

Notes

Metadata Export CSV

File

Members Count

Integer

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

3

Error

General failure

Get Variable

Get a substitution variable defined at the application or cube scope

Inputs

Input

Type

Detail

Notes

Application

TextField

Optional. Application name

Database

TextField

Optional. Database (cube) name

Name

TextField

The name of the variable

Outputs

Output

Output Type

Notes

Variable

Json

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

3

Error

General failure

LCM Export

Backs up cube artifacts to a Lifecycle Management (LCM) .zip file.

Inputs

Input

Type

Detail

Notes

Application

TextField

Optional: OAC Application under which file lives. If application is not specified, will check the user directory

Zip file name

TextField

Optional. Name of compressed file to hold backup files.

If specified, this is the name of the file created in the OAC Cloud instance.

Local directory

TextField

Optional: Local directory where file is stored. Leave blank if using as an output.

If specified, provide the directory and file name. For example \\Server_Name\Share_Directory\ExportName.zip

Number of threads

NumberField

Optional. Number of threads to spawn if using parallel export

Skip data

BooleanField

Do not include data in the backup

Overwrite

BooleanField

Overwrite existing backup file

Outputs

Output

Output Type

Notes

Export Zip File

File

Warning Log File

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

3

Error

General failure

LCM Import

Restores cube artifacts from a Lifecycle Management (LCM) .zip file.

Inputs

Input

Type

Detail

Notes

Zip file

FileField

Name of compressed file containing backup files

Overwrite

BooleanField

Overwrite existing LCM Export file on server. If not selected, command will throw an error if a zip file with the same name exists on the server.

Outputs

Output

Output Type

Notes

Warning Log File

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

3

Error

General failure

List Applications

Lists applications that exist on an instance of Oracle Analytics Cloud - Essbase

Inputs

None

Outputs

Output

Output Type

Notes

OAC Applications

Array

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

3

Error

General failure

List Databases

Lists the databases within a given application

Inputs

Input

Type

Detail

Notes

Application

TextField

OAC Application

Outputs

Output

Output Type

Notes

OAC Databases

Array

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

3

Error

General failure

List Files

Lists cube artifacts that exist on a given instance

Inputs

Input

Type

Detail

Notes

Application

TextField

Optional. Application name. If not provided, files from the user home directory on the cloud service are displayed.

Database

TextField

Optional. Database (cube) name

File type

DropdownField

Optional: Type of file to return

Filter

TextField

Filter the files returned using glob syntax (i.e. log_*.txt)

Outputs

Output

Output Type

Notes

OAC Files

Array

OAC Files as CSV

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

3

Error

General failure

List Filters

View a list of Essbase security filters

Inputs

Input

Type

Detail

Notes

Application

TextField

Application name

Database

TextField

Database name

Outputs

Output

Output Type

Notes

OAC Filters

Array

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

3

Error

General failure

List Locks

View any locked data blocks or cube-related objects

Inputs

Input

Type

Detail

Notes

Application

TextField

Application name

Database

TextField

Database name

Show object locks

BooleanField

Display locked files/artifacts.

Outputs

Output

Output Type

Notes

OAC Locks

Array

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

3

Error

General failure

List Variables

Lists substitution variables defined at the application or cube scope

Inputs

Input

Type

Detail

Notes

Application

TextField

Optional. Application name

Database

TextField

Optional. Database (cube) name

Outputs

Output

Output Type

Notes

OAC Variables

Json

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

3

Error

General failure

Load Data

Loads data to a cube

Inputs

Input

Type

Detail

Notes

Application

TextField

OAC Application

Database

TextField

OAC Database (cube)

Data file

TextField

Data load file name. You do not need to give a full path. Files are assumed to be in the relevant application or database directory.

Rules file

TextField

Rules file name. You do not need to give a full path. Files are assumed to be in the relevant application or database directory

Abort

BooleanField

Abort on failure

Outputs

Output

Output Type

Notes

Warning Log File

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

3

Error

General failure

10

Warning

There were warnings produced with the load.

Start

Starts an application or database

Inputs

Input

Type

Detail

Notes

Application

TextField

Application name

Database

TextField

Optional: Database name. If not specified, will start the application

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

3

Error

General failure

10

Warning

Application or database already started

Stop

Stops an application or database

Inputs

Input

Type

Detail

Notes

Application

TextField

Application name

Database

TextField

Optional: Database name. If not specified, will stop the application

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

3

Error

General failure

10

Warning

Application or database already stopped

Update Variable

Update a substitution variable defined at the application or cube scope

Inputs

Input

Type

Detail

Notes

Application

TextField

Optional. Application name

Database

TextField

Optional. Database (cube) name

Name

TextField

The name of the variable

Value

TextField

The value of the variable

Outputs

Output

Output Type

Notes

Updated Variable

Json

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

3

Error

General failure

Upload File

Uploads cube artifacts from a local directory to a given OAC instance

Inputs

Input

Type

Detail

Notes

Application

TextField

Optional: OAC Application. If application is not specified, will upload to user directory

Database

TextField

Optional: OAC Database. If database is not specified, will upload to application directory

File

FileField

The file to upload to your application, database, or user directory within OAC

Upload name

TextField

Optional: Use this field to set the name of the file to be uploaded (if you want it to be different from the name of the upload file)

Overwrite

BooleanField

Overwrites a file if it already exists on the server

Outputs

Output

Output Type

Notes

OAC Upload Size

Integer

OAC Uploaded Lines

Integer

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

3

Error

General failure

Did this answer your question?