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
To enable these commands, an IT admin first creates an Oracle Analytics Cloud connector.
Build dimension
To load dimensions to a cube, add a Build Dimension command.
Properties
| Property |
Detail |
| Application |
Enter the OAC application to load to. |
| Database |
Enter the OAC database—or cube—to load to. |
| 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
To calculate a cube, add a Calculation Script command.
Properties
| Property |
Detail |
| Application |
Enter the OAC application. |
| Database |
Enter the OAC database—or cube—to calculate. |
| 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
To clear data from a cube, add a Clear Data command.
Properties
| Property |
Detail |
| Application |
Enter the OAC application to clear data in. |
| Database |
Enter the OAC database—or cube—to clear data in. |
| Option |
Select the keyword specifying what to clear. |
| Region |
Enter the multidimensional expression (MDX) that specifies the region to clear. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Create variable
To create a substitution variable defined at the application or cube scope, add a Create Variable command.
Properties
| Property |
Detail |
| Application |
Enter the OAC application to create the variable in. To create the variable at the cube scope, leave blank. |
| Database |
Enter the database—or cube—to create the variable in. To create the variable at the application scope, leave blank. |
| Name |
Enter the name of the variable to create. |
| Value |
Enter the value of the variable to create. |
Outputs
| Output |
Output type |
| Created variable |
JSON |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Delete file
To remove cube artifacts from the application, database, or user home directory, add a Delete File command.
Properties
| Property |
Detail |
| Application |
Enter the OAC application to delete from. |
| Database |
Enter the OAC database—or cube—to delete 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 |
Delete variable
To delete a substitution variable defined at the application or cube scope, add a Delete Variable command.
Properties
| Property |
Detail |
| Application |
Enter the OAC application to delete from. To delete a variable defined at the cube scope, leave blank. |
| Database |
Enter the database—or cube—to delete from. To delete a variable defined at the application scope, leave blank. |
| File |
Enter the name of the variable to delete. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Deploy
To create a cube from a Microsoft Excel® workbook, add a Deploy command.
Properties
| Property |
Detail |
| Application |
Enter the OAC application to create the cube in. |
| Database |
Enter the name of the database—or cube—to create.
|
| 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
To download cube artifacts from an Essbase® instance to a local directory, add a Download File command.
Properties
| Property |
Detail |
| Application |
Enter the OAC application to download from. |
| Database |
Enter the database—or cube—to download from. |
| 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
To run a Multidimensional Expressions (MDX) script, add an Execute MDX Script command.
Properties
| Property |
Detail |
| Application |
Enter the OAC application to run the script in. |
| Database |
Enter the OAC database—or cube—to run the script in. |
| Script |
Enter the name of the script file to run, with an .msh extension. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Execute MaxL script
To run a MaxL script, add an Execute MaxL Script command.
Properties
| Property |
Detail |
| Application |
Enter the OAC application to run the script in. |
| Database |
Enter the OAC database—or cube—to run the script in. |
| Script |
Enter the name of the script file to run, with an .msh extension. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Execute report script
To return outputs generated by executing a report script specification file, add an Execute report script command.
Note: This command requires Essbase version 21c (version 21.1) or higher.
Properties
| Property |
Detail |
| Application |
Enter the OAC application to run the script in. |
| Database |
Enter the OAC database—or cube—to run the script in. Only compatible with Essbase version 21c or higher. |
| Script |
Enter the name of the script file to run, with an .msh extension. |
| Lock for update |
Locks all blocks accessed by the report specification. Disabled by default. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
Export metadata
To export dimension metadata in a tabular, parent-child hierarchical format, add an Export Metadata command.
Properties
| Property |
Detail |
| Application |
Enter the name of the OAC application to export from. |
| Database |
Enter the name of the OAC database—or cube—to export from. |
| 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 |
Get variable
To retrieve a substitution variable defined at the application or cube scope, add a Get Variable command.
Properties
| Property |
Detail |
| Application |
Enter the OAC application with the variable to retrieve. To retrieve a variable defined at the cube scope, leave blank. |
| Database |
Enter the database—or cube—with the variable to retrieve. To retrieve a variable defined at the application scope, leave blank. |
| Name |
Enter the name of the variable to retrieve. |
Outputs
| Output |
Output type |
| Variable |
JSON |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |
LCM export
To back up cube artifacts to a Lifecycle Management (LCM) ZIP file, add an LCM Export command.
Properties
| Property |
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
To restore cube artifacts from a Lifecycle Management (LCM) ZIP file, add an LCM Import command.
Properties
| Property |
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
To list the applications that exist on an instance of OAC Essbase®, add a List Applications command.
Properties
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
To list the databases within a given application, add a List Databases command.
Properties
| Property |
Detail |
| Application |
Enter the OAC application with the databases to list. |
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
To list cube artifacts that exist on a given instance, add a List Files command.
Properties
| Property |
Detail |
| Application |
Enter the OAC application with the files to list. To list files from the home directory on the cloud service, leave blank. |
| Database |
Enter the name of the database—or cube—with the files to list (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
To list Essbase security filters, add a List Filters command.
Properties
| Property |
Detail |
| Application |
Enter the name of the OAC application with the filters to list. |
| Database |
Enter the name of the database with the filters to list. |
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
To list any locked data blocks or cube-related objects, add a List Locks command.
Properties
| Property |
Detail |
| Application |
Enter the name of the OAC application with the locked objects to list. |
| Database |
Enter the name of the database—or cube—with the locked objects to list. |
| 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
To list the substitution variables defined at the application or cube scope, add a List Variables command.
Properties
| Property |
Detail |
| Application |
Enter the name of the application with the variables to list. To list variables defined at the cube scope, leave blank. |
| Database |
Enter the name of the database—or cube—with the variables to list. To list variables defined at the application scope, leave blank. |
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
To load data to a cube, add a Load Data command.
Properties
| Property |
Detail |
| Application |
Enter the name of the OAC application to load to. |
| Database |
Enter the name of the database—or cube—to load to. |
| 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
To start an OAC application or database, add a Start command.
Properties
| Property |
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
To stop an OAC application or database, add a Stop command.
Properties
| Property |
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 |
Update variable
To update a substitution variable defined at the application or cube scope, add an Update Variable command.
Properties
| Property |
Detail |
| Application |
Enter the name of the OAC application with the variable to update. To update a variable defined at the cube scope, leave blank. |
| Database |
Enter the name of the database—or cube—with the variable to update. To update a variable defined at the application scope, leave blank. |
| Name |
Enter the name of the variable to update. |
| Value |
Enter the new value of the variable. |
Outputs
| Output |
Output type |
| Updated variable |
JSON |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 3 |
Error |
General failure |