To connect and automate Oracle® Analytics Cloud (OAC) as part of a chain, add a step that includes an Oracle Analytics Cloud connection command. For example:
- Execute calculations
- Exchange and load data and commands to administer OAC
Connection Properties
To enable these commands, an IT admin first creates an Oracle Analytics Cloud connection and configures its credentials and properties. The connection interacts with OAC via the published REST API and doesn't require anything specialized except connectivity to OAC.
| Input |
Detail |
| User Name |
Enter the username for OAC |
| OAC Password |
Enter the password for OAC |
| OAC Base URL |
Enter the URL for the OAC environment. This is the portion of the URL that ends with oraclecloud.com. |
Note: All sensitive credentials are automatically encrypted and stored at 2,048-bit encryption.
Build Dimension
Loads dimensions to a cube
Inputs
| Input |
Detail |
| Application |
Enter the OAC application |
| Database |
Enter the OAC database, or cube
|
| Dimension File |
Enter the name of the dimension build file. The full path is unnecessary; files are assumed to be in the relevant application or database directory. |
| Rules File |
Enter the name of the rules file. The full path is unnecessary; files are assumed to be in the relevant application or database directory. |
| Restructure |
Select the preservation choice for the outline restructure |
| Force |
To force the dimension build without verifying the outline, check the box |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Calculation Script
Calculates a cube
Inputs
| Input |
Detail |
| Application |
Enter the OAC application |
| Database |
Enter the OAC database, or cube
|
| Script File |
Enter the name of the calculation script, with the .csc file extension. The full path is unnecessary; files are assumed to be in the relevant application or database directory. |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Clear Data
Clears data from a cube
Inputs
| Input |
Detail |
| Application |
Enter the OAC application |
| Database |
Enter the OAC database, or cube
|
| Option |
Select the keyword specifying what to clear |
| Region |
Enter the multidimensional expression (MDX) specifying the region to clear |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Delete File
Removes cube artifacts from the application, database, or user home directory
Inputs
| Input |
Detail |
| Application |
Enter the OAC application |
| Database |
Enter the OAC database, or cube
|
| 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 |
Deploy
Creates a cube from a Microsoft Excel® workbook
Inputs
| Input |
Detail |
| Application |
Enter the OAC application |
| Database |
Enter the OAC database, or cube
|
| Excel Workbook |
Enter the Excel workbook file to create the cube from. If referring to a file on the server, it must be in the user's directory. |
| Execute Script |
To execute any calculation scripts included in the workbook, check this box |
| Create Files |
To create cube artifacts in the files directory on the cloud service instance, check this box |
| Recreate Application |
To recreate the application if it already exists, check this box |
| Load Data |
To load data from a workbook that contains a data worksheet, check this box. Otherwise, the command imports only metadata into the cube. |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Download File
Downloads cube artifacts from an Essbase® instance to a local directory
Inputs
| Input |
Detail |
| Application |
Enter the OAC application |
| Database |
Enter the OAC database, or cube
|
| File |
Enter the name of the file to download |
| Auto-unzip |
To automatically unzip the file contents, check this box. Ignored if the ZIP file contains more than one file. |
Outputs
| Output |
Output Type |
| Downloaded File |
File |
| Downloaded File Size |
Integer |
| Downloaded Records |
Integer |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Execute MDX Script
Runs a MDX script
Inputs
| Input |
Detail |
| Application |
Enter the OAC application |
| Database |
Enter the OAC database, or cube
|
| Script |
Enter the name of the script file to run, with the .msh extension |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Execute MaxL Script
Runs a MaxL script
Inputs
| Input |
Detail |
| Application |
Enter the OAC application |
| Database |
Enter the OAC database, or cube
|
| Script |
Enter the name of the script file to run, with the .msh extension |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Export Metadata
Exports dimension metadata in a tabular, parent-child hierarchical format
Inputs
| Input |
Detail |
| Application |
Enter the name of the OAC application |
| Database |
Enter the name of the OAC database, or cube
|
| Dimension Name |
Enter the name of the dimension to export |
| Show Attributes |
To show attributes in addition to the names of each member in the dimension, check this box (optional). If you require only member names in a parent-child format, leave unchecked.
Note: Attributes may take significant time to export.
|
| Extended Attributes |
If members have more than 10 attributes, check this box (optional). By default, only the first 10 attributes appear. |
Outputs
| Output |
Output Type |
| Members Count |
Integer |
| Members Export CSV |
File |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
LCM Export
Backs up cube artifacts to a Lifecycle Management (LCM) ZIP file
Inputs
| Input |
Detail |
| Application |
Enter the OAC application where the file lives. To check the user directory, leave blank. |
| ZIP File Name |
Enter the name of the compressed file to hold the backup files (optional) |
| Local Directory |
Enter the local directory where the file is stored. If using as an output in another command, leave blank. |
| Number of Threads |
If using a parallel export, enter the number of threads to spawn (optional) |
| Skip Data |
To not include data in the backup, check this box |
| Overwrite |
To overwrite an existing backup file, check this box |
Outputs
| Output |
Output Type |
| Export ZIP File |
File |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
LCM Import
Restores cube artifacts from an LCM ZIP file
Inputs
| Input |
Detail |
| ZIP File Name |
Enter the name of the compressed file containing the backup files |
| Overwrite |
To overwrite an existing LCM Export file on the server, check this box. Otherwise, the command throws an error if a ZIP file with the same name already exists on the server. |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
List Applications
Lists applications that exist on an instance of OAC-Essbase
Inputs
None
Outputs
| Output |
Output Type |
| OAC Applications |
Array |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
List Databases
Lists the databases within a given application
Inputs
| Input |
Detail |
| Application |
Enter the OAC application |
Outputs
| Output |
Output Type |
| OAC Databases |
Array |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
List Files
Lists cube artifacts that exist on a given instance
Inputs
| Input |
Detail |
| Application |
Enter the OAC application. To list files from the home directory on the cloud service, leave blank. |
| Database |
Enter the name of the database, or cube (optional)
|
| File Type |
Select the type of file to return (optional) |
| Filter |
Enter the filter criteria of the files to return, using glob syntax such as log_*.txt
|
Outputs
| Output |
Output Type |
| OAC Files |
Array |
| OAC Files as CSV |
File |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
List Filters
Lists Essbase security filters
Inputs
| Input |
Detail |
| Application |
Enter the name of the OAC application |
| Database |
Enter the name of the database |
Outputs
| Output |
Output Type |
| OAC Filters |
Array |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
List Locks
Lists any locked data blocks or cube-related objects
Inputs
| Input |
Detail |
| Application |
Enter the name of the OAC application |
| Database |
Enter the name of the database |
| Show Object Locks |
To display locked files and artifacts, check this box |
Outputs
| Output |
Output Type |
| OAC Locks |
Array |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
List Variables
Lists substitution variables defined at the application or cube scope
Inputs
| Input |
Detail |
| Application |
Enter the name of the application (optional) |
| Database |
Enter the name of the database, or cube (optional) |
Outputs
| Output |
Output Type |
| OAC Variables |
JSON |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Load Data
Loads data to a cube
Inputs
| Input |
Detail |
| Application |
Enter the name of the OAC application |
| Database |
Enter the name of the database, or cube
|
| Data File |
Enter the name of the data load file. The full path is unnecessary; files are assumed to be in the relevant application or database directory. |
| Rules File |
Enter the name of the rules file. The full path is unnecessary; files are assumed to be in the relevant application or database directory. |
| Abort |
To abort the command on failure, check this box |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Start
Starts an application or database
Inputs
| Input |
Detail |
| Application |
Enter the name of the OAC application to start |
| Database |
Enter the name of the database—or cube—to start. To start the application, leave blank. |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
| 10 |
Error |
Application or database already started |
Stop
Stops an application or database
Inputs
| Input |
Detail |
| Application |
Enter the name of the OAC application to stop |
| Database |
Enter the name of the database—or cube—to stop. To stop the application, leave blank. |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
| 10 |
Error |
Application or database already stopped |
Upload File
Uploads cube artifacts from a local directory to a given OAC instance
Inputs
| Input |
Detail |
| Application |
Enter the name of the OAC application. To upload to the user directory, leave blank. |
| Database |
Enter the name of the database, or cube. To upload to the application directory, leave blank. |
| File |
Enter the file to upload to the application, database, or user directory. |
| Upload Name |
Enter the name to upload the file as. To use the same name as the File input, leave blank. |
| Overwrite |
To overwrite a file if it already exists on the server, check this box |
Outputs
| Output |
Output Type |
| OAC Upload Size |
Integer |
| OAC Uploaded Lines |
Integer |
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |