Help Desk

Submit a ticket My Tickets
Welcome
Login

Oracle PBCS & EPBCS Command Reference

The Oracle PBCS & EPBCS BizApp provides functionality to interact with PBCS to manage loading and downloading files, running business rules and data management commands, and many other administrative functions.

Connections

Oracle PBCS & EPBCS

Basic authentication connection to PBCS & EPBCS

Inputs

Input Type Detail Notes
Service Name TextField Name of the Oracle Cloud service to which you are connecting
Domain name TextField Oracle Cloud domain
Data Center TextField Data center in which your Oracle Cloud service resides. This can be found in the first part of the URL before oraclecloud.com (i.e. us2).
User Name TextField Oracle Cloud user name
Password TextField Oracle Cloud password
Application Name TextField Oracle PBCS / EPBCS application
Base URL (override) TextField The entire base URL of your Oracle Cloud instance. This should be used in cases where your instance does not conform to the normal URL structure.

Commands

Clear Cube

Deletes specific data from input and reporting cubes using the settings specified in a job of type clear cube. This command does not delete the application definition in the application’s relational tables

Inputs

Input Type Detail Notes
Job Name TextField Clear cube job name

Outputs

None

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 Error General failure
10 Warning Command completed with warnings

Convert CSV to Planning file format

Converts a CSV file into the native Planning file format

Inputs

Input Type Detail Notes
Source FileField CSV file to be converted to the native Planning file format
Delimiter DropdownField Source file delimiter
Final column order ArrayField List the columns in the order that the native Planning file format output should be in. For example: Entity, OFS_Volume, OFS_ASP, Point-of-View, Data Load Cube Name.
Target Column (Sparse Dim) TextField Column that represents the sparse dimension. Typically this parameter is Entity.
Driver Columns (Dense Dim) ArrayField List of the names of the driver columns. The number of columns here must match the number of columns that will precede the Point-of-View column in the resulting native Planning file format output. Using the prior example, this field would be: OFS_Volume and OFS_ASP.
POV Columns ArrayField List of the names of the columns that will be added to the Point-of-View column in the resulting Planning file format output. For example: Plan Element, Product, Market, Year, Scenario, Version, Currency, Period.
Plan Type TextField Name of the PBCS or EPBCS plan type.

Outputs

Output Output Type Notes
Planning file Output File
Planning file Output Records Integer

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 Error General failure

Convert Planning file format to CSV

Converts the native Planning file format into a CSV output

Inputs

Input Type Detail Notes
Source FileField The native Planning file format output to be converted to CSV output
Delimiter DropdownField Output file delimiter
POV Fields ArrayField List of the column names for each part of the Point-of-View. The number of fields listed here must match the number of elements in the native Planning file format file's Point-of-View.
Keep Plan Type BooleanField When selected, inserts the plan type as the first column of the resulting CSV

Outputs

Output Output Type Notes
Converted CSV Output File
Converted CSV Records Integer

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 Error General failure

Copy Snapshot

Migrates (clones) an environment by copying a snapshot from an environment (source) to the current environment (target); for example from a test environment to a production environment.

Inputs

Input Type Detail Notes
Snapshot Name TextField Snapshot name
Source user name TextField Source instance user name
Source instance password TextField Source instance password. Note: Can either provide a password or password file (which will have been previously generated by epmautomate)
Source password file FileField Source instance password file. This file can be generated by epmautomate, but you can also input the password directly via the source instance password field.
Source URL TextField URL of the source instance
Source Domain TextField Domain of the source instance

Outputs

None

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 Error General failure
10 Warning Command completed with warnings

Delete File

Deletes a file or application snapshot from the default upload location, a Data Management folder, or from profitinbox/profitoutbox. To delete a file from a location other than the default upload location, you must specify the file location.

Inputs

Input Type Detail Notes
File name TextField File to be deleted. This can contain a path to the file's location if it is not in the default upload location.

Outputs

None

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 Error General failure
10 Warning Command completed with warnings

Download File

Downloads a file from an environment

Inputs

Input Type Detail Notes
File name TextField Name of the file to be downloaded. If it is not in the standard location, this must contain the path to the file.
Automatically Unzip BooleanField Automatically unzips the file for use as an output (if applicable). If the zip file contains more than one file, the contents will not be unzipped

Outputs

Output Output Type Notes
Downloaded File File
Downloaded File Size Integer
Downloaded Records Integer

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 Error General failure
10 Warning Command completed with warnings

Export Data

Exports application data into a ZIP file using the export data settings, including file name, specified in a job of type export data. The exported data file is stored in the default download location from where you can download it to your computer

Inputs

Input Type Detail Notes
Job name TextField Export job name
File name TextField Export file name

Outputs

Output Output Type Notes
Export file name String

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 Error General failure
10 Warning Command completed with warnings

Export Mapping

Exports mapping rules of a specific dimension or location to create a mapping rule file

Inputs

Input Type Detail Notes
Dimension TextField Source dimension from which mappings are to be exported. Can specify ALL to export mappings from all dimensions
File name TextField Unique name for the mapping file and a location within the outbox
Export Location TextField Data Management location for which mapping rules should be exported.

Outputs

Output Output Type Notes
Export mapping log file name String
Export mapping file name String

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 Error General failure
10 Warning Command completed with warnings

Export Metadata

Exports metadata into a file using the settings specified in a job of type export metadata

Inputs

Input Type Detail Notes
Job Name TextField Name of an export metadata job defined in the application
File Name TextField Name of the ZIP file into which metadata is to be exported

Outputs

Output Output Type Notes
Export metadata file name String

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 Error General failure
10 Warning Command completed with warnings

Export Security

Exports the security records or access control list (ACL) records for specified users or groups

Inputs

Input Type Detail Notes
File name TextField Optional: Name of the file that will be generated. The name will be automatically created if this field is left blank
Job name TextField Optional: The name of the job defined to perform this export action
Users to Export ArrayField List of users to export. NOTE: If using the "Groups to Export" field, this must be left blank
Groups to Export ArrayField List of groups to export. NOTE: If using the "Users to Export" field, this must be left blank

Outputs

Output Output Type Notes
Export Security File Name String

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 Error General failure
10 Warning Command completed with warnings

Export Snapshot

Repeats a previously performed export operation to create a snapshot of Migration content.

Inputs

Input Type Detail Notes
Snapshot Name TextField Name of the snapshot to be exported

Outputs

None

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 Error General failure
10 Warning Command completed with warnings

Get Substitution Variable

Retrieves the values of substitution variables

Inputs

Input Type Detail Notes
Cube TextField The cube from which you want to retrieve the substitution variable. Use ALL to retrieve substitution variables at the application level.
Variable name TextField Name of the substitution variable to retrieve

Outputs

Output Output Type Notes
Substitution variable JSON Json

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 Error General failure
10 Warning Command completed with warnings

Import Data

Imports data from a file into the application using the import data settings specified in a job of type import data

Inputs

Input Type Detail Notes
Job Name TextField Name of the import data job in PBCS / EPBCS
File Name TextField Name of the file that contains the data to import

Outputs

None

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 Error General failure
10 Warning Command completed with warnings

Import Mapping

Imports mappings from a mapping import file, which was previously uploaded to the service

Inputs

Input Type Detail Notes
File Name TextField Name of the ZIP file into which metadata is to be exported
Dimension TextField Indicates the recipient of the mapping. Specify the name of the dimension into which mappings are to be imported or ALL to import all mappings included in the file to appropriate dimensions
Import Location TextField The Data Management location for which mapping rules should be loaded
Import Mode DropdownField Set to either REPLACE to clear existing mapping rules before importing mappings or MERGE to add new mapping rules to exiting rules
Validation Mode BooleanField Set to TRUE to validate target members against the application or FALSE to load the mapping file without running validations

Outputs

Output Output Type Notes
Import mapping log file name String
Import mapping file name String

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 Error General failure
10 Warning Command completed with warnings

Import Metadata

Imports metadata into the application using the import data settings specified in a job of type import metadata

Inputs

Input Type Detail Notes
Job Name TextField Name of an import metadata job defined in the application
File Name TextField Name of the ZIP file from which metadata is to be imported

Outputs

None

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 Error General failure
10 Warning Command completed with warnings

Import Snapshot

Imports the contents of a snapshot into the service environment

Inputs

Input Type Detail Notes
Snapshot Name TextField Name of the snapshot. Note: It must be in the default upload location
New default password TextField Default password that you want to assign to new users who are created in the identity domain. The password that you specify must meet the minimum identity domain password requirements
Reset password BooleanField Indicates whether the new user must change the password at the first log in. Unless this optional parameter is set to false, the new user will be forced to change the password at the first sign in.

Outputs

None

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 Error General failure
10 Warning Command completed with warnings

List Files

Lists the files in the default location, Data Management folders, and profitinbox/profitoutbox. This command does not list Migration snapshots

Inputs

Input Type Detail Notes
Filter TextField Filters the files to return. Can use the glob syntax (i.e. *.csv) to return all files that match the pattern provided

Outputs

Output Output Type Notes
PBCS Files Array
PBCS Files CSV File

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 Error General failure
10 Warning Command completed with warnings

Refresh Cube

Refreshes the application cube

Inputs

Input Type Detail Notes
Job Name TextField The name of a job defined in the application

Outputs

None

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 Error General failure
10 Warning Command completed with warnings

Restart

Restarts the environment. Use this command only when you observe severe performance degradation or if you receive error messages indicating that the environment is unusable

Inputs

Input Type Detail Notes
Comment TextField Comment to associate to the restart job

Outputs

None

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 Error General failure
10 Warning Command completed with warnings

Run Business Rule

Launches a business rule or ruleset

Inputs

Input Type Detail Notes
Rule Name TextField Name of a business rule exactly as it is defined in the environment
Rule Parameters MapField Optional runtime parameters and their values required to execute the business rule

Outputs

Output Output Type Notes
Business Rule Output String

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 Error General failure
10 Warning Command completed with warnings

Run Daily Maintenance

Starts the daily service maintenance process right away instead of waiting for the scheduled daily maintenance window

Inputs

None

Outputs

None

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 Error General failure
10 Warning Command completed with warnings

Run Data Management Batch

Executes a Data Management batch

Inputs

Input Type Detail Notes
Batch Name TextField Name of the batch defined in data management

Outputs

Output Output Type Notes
Run batch log file name String

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 Error General failure
10 Warning Command completed with warnings

Run Data Management Report

Creates a Data Management report and stores it in the outbox/reports folder

Inputs

Input Type Detail Notes
Report Name TextField Name of the Data Management report template to be used for generating the report
Report Format DropdownField Report output format
Report Parameters MapField Report parameters and their values. The list of required parameters depends on the report that you want to generate.

Outputs

Output Output Type Notes
Data management report log file name String
Data management report file name String

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 Error General failure
10 Warning Command completed with warnings

Run Data Management Rule

Executes a Data Management data load rule based on the start period and end period, and import or export options that you specify.

Inputs

Input Type Detail Notes
Rule Name TextField Name of a data load rule defined in Data Management
Start Period TextField First period for which data is to be loaded. This period name must be defined in Data Management period mapping.
End Period TextField For multi-period data load, the last period for which data is to be loaded. For single period load, enter the same period as start period. This period name must be defined in Data Management period mapping.
File Name TextField Optional file name. If you do not specify a file name, the data contained in the file name specified in the load data rule is imported. This file must be available in the inbox folder or in a folder within it
Import Mode DropdownField Determines how the data is imported into Data Management
Export Mode DropdownField Determines how the data is exported to the application

Outputs

Output Output Type Notes
Run data rule log file name String
Run data rule file name String

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 Error General failure
10 Warning Command completed with warnings

Run Plan Type Map

Copies data from a block storage database to an aggregate storage database or from a block storage to another block storage based on the settings specified in a job of type plan type map.

Inputs

Input Type Detail Notes
Job Name TextField Name of a job of type plan type map defined in the application
Clear Data BooleanField Optional setting that indicates whether the data in the target database should be removed before copying data

Outputs

None

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 Error General failure
10 Warning Command completed with warnings

Set Login Level

Sets the login level for an application

Inputs

Input Type Detail Notes
Login Level DropdownField The login level to be set
Job Name TextField Optional: The job name to be used for this job execution (can be left blank if no job is defined)

Outputs

None

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 Error General failure
10 Warning Command completed with warnings

Set Substitution Variables

Creates or updates substitution variables at application or cube level. You cannot use this command to set multiple values and/or functions for substitution variables.

Inputs

Input Type Detail Notes
Cube TextField The cube (for example, Plan1, Plan2) for which the substitution variable is created or updated. Use ALL instead of a cube name to set or update substitution variable at the application level
Variables MapField A mapping of variables and their values. If the variable does not exist it will be created.

Outputs

None

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 Error General failure
10 Warning Command completed with warnings

Upload File

Uploads a file. Use this command to upload files containing data, metadata, rule definitions, dimension definitions, mapped transactions, templates, and backup snapshots.

Inputs

Input Type Detail Notes
Upload File FileField File to be uploaded
Upload Name TextField Optional: Name under which file will be uploaded (can leave blank to use the name of the uploaded file)
File path TextField Optional: Path where file will be uploaded.
Overwrite BooleanField When selected, will overwrite an existing file on the server

Outputs

Output Output Type Notes
Uploaded file size Integer
Uploaded records Integer

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 Error General failure
10 Warning Command completed with warnings

User Audit Report

Generates a user audit report (.CSV file) and stores it in the default download location

Inputs

Input Type Detail Notes
Report Name TextField Name of the report file
From Date TextField Indicates the start date (in YYYY-MM-DD format) of the period for which the audit report is to be generated
To Date TextField Indicates the end date (in YYYY-MM-DD format) of the period for which the audit report is to be generated

Outputs

Output Output Type Notes
User audit report file name String

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 Error General failure
10 Warning Command completed with warnings

User Provisioning Report

Generates a provisioning report (.CSV file) and stores it in the default download location.

Inputs

Input Type Detail Notes
File Name TextField Name of the provisioning report file to be created

Outputs

Output Output Type Notes
Provisioning report file name String

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 Error General failure
10 Warning Command completed with warnings
B
Brian is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.