To connect and automate Oracle Planning and Budget Cloud Service (PBCS) or Enterprise Planning and Budget Cloud Service (EPBCS) as part of a chain, add a step with an Oracle PBCS connection command. For example:
- Exchange data
- Execute business rules
- Generate reports
- Run Data Manager jobs
- Bi-directionally convert the native Simplified User Interface (SUI) format to standard comma-separated values (CSV)
To enable these commands, an IT admin first creates an Oracle PBCS connector.
Clear cube
To delete specific data from input and reporting cubes using the settings specified in a Clear Cube job, add a Clear Cube command.
Note: This command doesn't delete the application definition in the relational tables.
Properties
Property |
Detail |
Job name |
Enter the name of the Clear Cube job with the settings to use. |
Outputs
None
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed without warnings |
Convert CSV to Planning file format
To convert a CSV file into the native Planning file format, add a Convert CSV to Planning File Format command.
Properties
Property |
Detail |
Source |
Enter the CSV file to convert to the Planning file format. |
Delimiter |
Select the delimiter used in Source. |
Final column order |
List the columns in the order they should appear in the Planning file format output, such as Entity, OFS_Volume, OFS_ASP, Point-of-View, Data Load Cube Name. |
Target column (sparse DIM) |
Enter the column that represents the sparse dimension; typically, Entity . |
Driver columns (dense DIM) |
List the names of the driver columns. The number of columns must match the number of columns that will precede the Point-of-View column in the Planning file format output. Per the previous example, OFS_Volume, OFS_AS . |
POV columns |
List the names of the columns to add to the Point-of-View column in the Planning file format output, such as Plan Element, Product, Market, Year, Scenario, Version, Currency, Period. |
Plan type |
Enter the name of the PBCS or EPBCS plan type. |
Outputs
Output |
Output type |
Planning file output |
File |
Planning file output records |
Integer |
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
Convert Planning file format to CSV
To convert the native Planning file format to a CSV output, add a Convert Planning File Format to CSV command.
Properties
Property |
Detail |
Source |
Enter the Planning file format file to convert to CSV. |
Delimiter |
Select the delimiter to use in the CSV output. |
POV fields |
List the column names for each part of the Point-of-View. The number of fields must match the number of elements in the Planning file format file's Point-of-View. |
Keep plan type |
To insert the plan type as the first column of the CSV output, check this box. |
Outputs
Output |
Output type |
Converted CSV output |
File |
Converted CSV records |
Integer |
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
Copy file between instances
To copy a file from a source environment to the current target environment, add a Copy File Between Instances command. For example, use this command to copy a file from a test environment to the production environment.
Properties
Property |
Detail |
Source file name |
Enter the name of the file to copy. |
Source user name |
Enter the username for the source environment. |
Source instance password |
Enter the password for the source environment.
Note: Alternatively, enter the password file generated by EPM Automate in Source password file.
|
Source password file |
Enter the password file for the source environment.
Note: Alternatively, enter the password directly in Source instance password.
|
Source URL |
Enter the URL of the source environment. |
Target file name |
Enter the name for the copied file in the target environment. |
Outputs
None
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
Copy snapshot
To migrate—or clone—an environment by copying a snapshot from a source environment to the current target environment, add a Copy Snapshot command. For example, use this command to copy a snapshot from a test environment to a production environment.
Properties
Property |
Detail |
Snapshot name |
Enter the name of the snapshot to copy. |
Source user name |
Enter the username for the source environment. |
Source instance password |
Enter the password for the source environment.
Note: Alternatively, enter the password file generated by EPM Automate in Source password file.
|
Source password file |
Enter the password file for the source environment, generated by EPM Automate.
Note: Alternatively, enter the password directly in Source instance password.
|
Source URL |
Enter the URL of the source environment. |
Source domain |
Enter the domain of the source environment. |
Outputs
None
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
Copy from Object Storage
To copy a file or backup snapshot from Oracle Object Storage Cloud to the Oracle Enterprise Performance Management (EPM) Cloud environment, add a Copy from Object Storage command.
Note: To use this command, set up an integration user in the Oracle Object Storage Cloud environment to copy from, and note its authentication credentials.
Properties
Property |
Detail |
URL |
Enter the URL of the object to copy from Object Storage Cloud, including its namespace and bucket. For example:
https://objectstorage.region.oraclecloud.com/v1/object-storage-namespace/bucket/filename
|
User name |
Enter the username of the Object Storage Cloud integration user. |
Password |
Enter the password for the Object Storage Cloud integration user. |
Target file |
Enter the target file name—with path—of the downloaded object, such as ArtifactSnapshot_25_Dec_2020.zip or inbox/File_new.txt . |
Outputs
None
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
Copy to Object Storage
To copy a file or backup snapshot from the outbox to Oracle Object Storage Cloud, add a Copy to Object Storage command. For example, use this command to:
- Transfer Oracle EPM Cloud artifacts to Object Storage Cloud without a local download.
- Retain EPM Cloud artifacts for longer than the EPM Cloud environment's default retention period.
Note: To use this command, set up an integration user in the Oracle Object Storage Cloud environment to copy to, and note its authentication credentials.
Properties
Property |
Detail |
URL |
Enter the URL of the Object Storage Cloud environment to copy to, including its namespace and bucket. For example:
https://objectstorage.region.oraclecloud.com/v1/object-storage-namespace/bucket/filename
|
User name |
Enter the username of the Object Storage Cloud integration user. |
Password |
Enter the password for the Object Storage Cloud integration user. |
File path |
Enter the file name—with path—of the object to copy to Object Storage Cloud, such as ArtifactSnapshot.zip or outbox/File.txt . |
Outputs
None
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
Delete file
To delete a file or application snapshot from the default upload location, a Data Management folder, or profitinbox/profitoutbox, add a Delete File command.
Properties
Property |
Detail |
File name |
Enter the name of the file to delete. If not in the default upload location, include the path to the file's location. |
Outputs
None
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
Download file
To download a file from an environment, add a Download File command.
Properties
Property |
Detail |
File name |
Enter the name of the file to download. If not in the standard location, include the path to the file's location. |
Automatically unzip |
To automatically unzip the file for use as an output, check this box. If the ZIP file contains more than one file, its content won't be unzipped. |
Outputs
Output |
Output type |
Downloaded file |
File |
Downloaded file size |
Integer |
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
Export data
To export application data into a ZIP file using the export data settings—including a file name—specified in an Export Data job, add an Export Data command. The exported data file is stored in the default download location, from where you can download it to your computer.
Properties
Property |
Detail |
Job name |
Enter the name of the Export Data job with the settings to use. |
File name |
Enter the name of the export file. |
Outputs
Output |
Output type |
Export file name |
String |
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
Export mapping
To export the mapping rules of a specific dimension or location to create a mapping rule file, add an Export Mapping command.
Properties
Property |
Detail |
Dimension |
Enter the source dimension to export the mappings from. To export mappings from all dimensions, enter ALL . |
File name |
Enter the unique name for the mapping file, and a location within the outbox. |
Export location |
Enter the Data Management location to export mapping rules for. |
Outputs
Output |
Output type |
Export mapping log file name |
String |
Export mapping file name |
String |
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
Export metadata
To export metadata into a a file using the settings specified for an Export Metadata job, add an Export Metadata command.
Properties
Property |
Detail |
Job name |
Enter the name of the Export Metadata job defined in the application. |
File name |
Enter the name for the ZIP file to export the metadata into. |
Outputs
Output |
Output type |
Export metadata file name |
String |
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
Export security
To export the security records or access control list (ACL) records for specific users or groups, add an Export Security command.
Properties
Property |
Detail |
File name |
Enter the name of the output file. To automatically generate the file name, leave blank. |
Job name |
To export records based on the settings specified for a job, enter its name. |
Users to export |
To export records for users, enter them as a list. To export records for groups, leave blank. |
Groups to export |
To export records for groups, enter them as a list. To export records for users, leave blank. |
Outputs
Output |
Output type |
Export security file name |
String |
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
Export snapshot
To repeat a previously performed export operation to create a snapshot of Migration content, add an Export Snapshot command.
Properties
Property |
Detail |
Snapshot name |
Enter the name of the snapshot to export. |
Outputs
None
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
Get substitution variable
To retrieves the values of substitution variables, add a Get Substitution Variable command.
Properties
Property |
Detail |
Cube |
Enter the cube to retrieve the substitution variable from. To retrieve substitution variables at the application level, enter ALL . |
Variable name |
Enter the name of the substitution variable to retrieve. |
Outputs
Output |
Output type |
Substitution variable JSON |
JSON |
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
Import data
To imports data from a file into the application using the settings specified in an Import Data job, add an Import Data command.
Properties
Property |
Detail |
Job name |
Enter the name of the Import Data job defined in the application. |
File name |
Enter the name of the file that contains the data to import. |
Error file |
Enter the name of the file to store any import errors, with an extension of .zip .
Note: If the file name doesn't include an extension of .zip , the command automatically appends one.
|
Outputs
Output |
Output type |
Error file |
File |
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
Import mapping
To import mappings for a mapping import file previously uploaded to the service, add an Import Mapping command.
Properties
Property |
Detail |
File name |
Enter the name of file to import mappings for. |
Dimension |
Enter the name of the dimension to import mappings into. To import all mappings included in the file to their appropriate dimensions, select ALL . |
Import location |
Enter the Data Management location to load mapping rules for. |
Import mode |
Select how to handle existing mapping rules during the import:
- To clear existing mapping rules before importing, select Replace.
- To add new mapping rules to existing rules, select Merge.
|
Validation mode |
To validate target members against the application, check this box. |
Outputs
Output |
Output type |
Import mapping log file name |
String |
Import mapping file name |
String |
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
Import metadata
To import metadata into the application using the settings specified in an Import Metadata job, add an Import Metadata command.
Properties
Property |
Detail |
Job name |
Enter the name of the Import Metadata job defined in the application. |
File name |
Enter the name of the ZIP file that contains the metadata to import. |
Outputs
None
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
Import security
To import metadata into the application using the settings specified in an Import Metadata job, add an Import Security command. With this command, you can import security metadata across a range of application objects including Forms, Rules, Tasklists, Dimensions, and Management Reports.
Properties
Property |
Detail |
Job name |
Enter the name of the job with the settings to use to import data, such as ImportSecurity. |
File name |
Enter the name of the CSV file in the Planning Cloud repository with the access control list (ACL) records to import. |
Clear existing |
To replace existing access permissions with imported access permissions, check this box. |
Error file name |
To export any error messages related to the import, such as for troubleshooting, enter the name of the file in the Planning Cloud repository that contains error messages. |
Outputs
None
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
Import snapshot
To import the contents of a snapshot into the service environment, add an Import Snapshot command.
Properties
Property |
Detail |
Snapshot name |
Enter the name of the snapshot. The snapshot must be in the default upload location. |
New default password |
Enter the default password to assign new users created in the identity domain. The password must meet the minimum identity domain password requirements. |
Reset password |
To require new users to change the password at their first login, check this box. |
Outputs
None
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
List files
To list the files in the default location, Data Management folders, and profitinbox/profitoutbox, add a List Files command.
Note: This command doesn't list Migration snapshots.
Properties
Property |
Detail |
Filter |
Enter the filter criteria of the files to return. To return all files that match the pattern, use the glob syntax, such as *.csv . |
Outputs
Output |
Output type |
PBCS files |
Array |
PBCS files CSV |
File |
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
Merge data slices
To merge incremental data slices of an aggregate storage (ASO) cube, add a Merge Data Slices command. With this command, you can merge all incremental data slices into the main database slice or a single slice without changing the main database.
Properties
Property |
Detail |
Job name |
Enter the name to use with the job execution. By default, Merge Data Slices. |
Cube name |
Enter the name of the ASO cube with the data slices to merge. |
Keep zero cells |
Select whether to keep cells with the value of zero. |
Merge slice type |
Select how to merge incremental data slices:
- allIncrementalSlicesInMain, to merge into the main database slice
- allIncrementalSlicesInOneIncremental, to merge into a single slice without changing the main database
|
Outputs
None
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
Optimize aggregation
To improve the performance of aggregate storage (ASO) cubes, add an Optimize Aggregation command to enable query tracking or execute an aggregation process. An aggregation process deletes existing aggregated views and generates optimized views based on collected query tracking data. When you execute an aggregation process, you can also:
- Specify the maximum disk space for the resulting files
- Base the view selection on user querying patterns
Note: Before you execute an aggregation process, first enable query tracking to track statistics on the ASO cube, and allow sufficient time to collect user querying patterns.
Properties
Property |
Detail |
Job name |
Enter the name to use with the job execution. By default, Optimize Aggregation. |
Cube name |
Enter the name of the ASO cube to optimize. |
type |
Select how to optimize aggregation:
- EnableQueryTracking, to enable query tracking
- ExecuteAggregationProcess, to execute an aggregation process
|
Use query data |
If Type is ExecuteAggregationProcess, select whether to select views to aggregate based on collected user querying patterns. |
Growth size ratio |
If Type is ExecuteAggregationProcess, enter the maximum disk space of the aggregated database as a real number, such as 1.01. By default, the aggregated database growth has no limit. |
Include alternate rollups |
If Type is ExecuteAggregationProcess, select whether to include secondary hierarchies (with default level usage) in the view selection. |
Outputs
None
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
Refresh cube
To refresh the application cube, add a Refresh Cube command.
Properties
Property |
Detail |
Job name |
Enter the name of the job defined in the application. |
Outputs
None
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
Restart
To restart the environment, add a Restart command.
Note: Use this command only if you observe severe performance degradation or receive error messages indicating that the environment is unusable.
Properties
Property |
Detail |
Comment |
Enter the comment to associate with the Restart job. |
Outputs
None
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
Run business rule
To launch a business rule or ruleset, add a Run Business Rule command.
Properties
Property |
Detail |
Rule name |
Enter the name of the business rule, exactly as defined in the environment. |
Rule parameters |
Enter the runtime parameters—and their values—required to execute the business rule (optional). |
Outputs
None
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
Run daily maintenance
To start the daily service maintenance process immediately, rather than waiting for the scheduled daily maintenance window, add a Run Daily Maintenance command.
Properties
None
Outputs
None
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
Run Data Management batch
To execute a Data Management batch, add a Run Data Management Batch command.
Properties
Property |
Detail |
Batch name |
Enter the name of the batch to execute, as defined in Data Management. |
Outputs
Output |
Output type |
Run batch log file name |
String |
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
Run Data Management report
To create a Data Management report and store it in the outbox or reports folder, add a Run Data Management Report command.
Properties
Property |
Detail |
Report name |
Enter the name of the Data Management report template to use to generate the report. |
Report format |
Select the output format of the report. |
Report parameters |
Enter the report parameters and their values, depending on the report to generate. |
Outputs
Output |
Output type |
Data Management report log file name |
String |
Data Management report file name |
String |
Exit Codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
Run Data Management rule
To execute a Data Management data load rule based on the start and end period and import or export options specified, add a Run Data Management Rule command.
Properties
Property |
Detail |
Rule name |
Enter the name of the data load rule defined in Data Management. |
Start period |
Enter the first period—as defined in Data Management period mapping—to load data for. |
End period |
For a multi-period load, enter the last period—as defined in Data Management period mapping—to load data for. For a single-period load, enter the same period as Start period. |
File name |
Enter the name of the file to import. The file must be available in the inbox folder or a folder within it. To import the data contained in the file name specified in the load data rule, leave blank. |
Import mode |
Select how to import data into Data Management. |
Export mode |
Select how to export data into the application. |
Outputs
Output |
Output type |
Run data rule log file name |
String |
Run data rule file name |
String |
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
Run plan type map
To copy data from a block storage database to an aggregate storage database or another block storage based on the settings specified in a Plan Type Map job, add a Run Plan Type Map command.
Properties
Property |
Detail |
Job name |
Enter the name of the Plan Type Map job defined in the application. |
Clear data |
To remove data in the target database before copying, check this box. |
Outputs
None
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
Set login level
To set the login level for an application, add a Set Login Level command.
Properties
Property |
Detail |
Login level |
Select the login level to set. |
Job name |
Enter the name of the job to execute. If no job is defined, leave blank. |
Outputs
None
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
Set substitution variables
To create or update substitution variables at the application or cube level, add a Set Substitution Variables command.
Note: You can't use this command to set multiple values or functions for substitution variables.
Properties
Property |
Detail |
Cube |
Enter the cube—such as Plan1, Plan2 —to create or update the substitution variable for. To set or update the substitution variable at the application level, enter ALL . |
Variables |
Enter a mapping of variables and their values. If the variable doesn't exist, it will be created. |
Outputs
None
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
Upload file
To upload a file containing data, metadata, rule definitions, dimension definitions, mapped transactions, templates, or backup snapshots, add an Upload File command.
Properties
Property |
Detail |
Upload file |
Enter the file to upload. |
Upload name |
Enter the name to upload the file as. To use the same name as Upload file, leave blank. |
File path |
Enter the path to where to upload the file to (optional). |
Overwrite |
To overwrite an existing file on the server, check this box. |
Outputs
Output |
Output type |
Uploaded file size |
Integer |
Uploaded records |
Integer |
Exit Codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
User audit report
To generate a user audit report as a CSV file and store it in the default download location, add a User Audit Report command.
Properties
Property |
Detail |
Report name |
Enter the name of the report file. |
From date |
Enter the start date—in YYYY-MM-DD format— of the period to generate the audit report for. |
To date |
Enter the end date—in YYYY-MM-DD format— of the period to generate the audit report for. |
Outputs
Output |
Output type |
User audit report file name |
String |
Exit Codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |
User provisioning report
To generate a provisioning report as a CSV file and store it in the default download location, add a User Provisioning Report command.
Properties
Property |
Detail |
File name |
Enter the name of the provisioning report file to create. |
Outputs
Output |
Output type |
Provisioning report file name |
String |
Exit codes
Code |
Type |
Detail |
0 |
Success |
Success |
1 |
Error |
Invalid arguments |
2 |
Error |
General failure |
10 |
Warning |
Command completed with warnings |