Help Desk

Submit a ticket My Tickets
Welcome
Login

Oracle PCMCS Command Reference

The Oracle PCMCS BizApp includes commands for interacting with POV and dimension data, templates, and a variety of administrative functions

Connections

Oracle PCMCS

Basic authentication connection to PCMCS

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 PCMCS application

Commands

Apply Data Grants

Refreshes the data grants, which control access to Essbase data slices, so that they match the data grants defined in an Oracle Profitability and Cost Management Cloud application

Inputs

None

Outputs

None

Exit Codes

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

Clear POV

Clears model artifacts and data from a Point of View (POV) combination or a data region within the POV in an application.

Inputs

Input Type Detail Notes
POV Group Member TextField The POV group member for which to clear model artifacts sand data
Query Name TextField A query name already existing within the application; used to clear a region within the given POV. Note: If this field is used, Clear Manage Rule, Clear Allocated Values, and Clear Adjustment Values must not be selected
String Delimiter TextField String delimiter for POV group members. Defaults to underscore ("_")
Clear Manage Rule BooleanField To clear the program rule details or not
Clear Input Data BooleanField To clear input data or not
Clear Allocated Values BooleanField To clear allocation values or not
Clear Adjustment Values BooleanField To clear adjustment values or not

Outputs

None

Exit Codes

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

Convert ASO to Tabular

Converts an ASO export file in native format to a tabular file

Inputs

Input Type Detail Notes
ASO Export File FileField ASO Export file in native format
LCM Export File FileField The application's LCM Export zip file. Note: You'll only need to export the metadata of your application, as this file is used to determine the dimensions and members of your application

Outputs

Output Output Type Notes
CSV Output File File

Exit Codes

Code Type Detail
0 Success Command succeeded
1 Error General failure

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.
Type TextField Name of the PCMCS 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 PCMCS Type BooleanField When selected, inserts the PCMCS 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 POV

Copies the model artifacts and Essbase cube data from a source POV to a destination POV.

Inputs

Input Type Detail Notes
Source POV Member Group TextField Source POV member group from which data will be copied
Destination POV Member Group TextField Destination POV member group to which data will be copied
Model View Name TextField The name of the data slice that is to be copied from the source POV to the target POV
String Delimiter TextField Specifies the delimiter used in POV values. Defaults to underscore ("_")
Copy Rule Details BooleanField Whether to copy the program rule details
Copy Input Data BooleanField Whether to copy input data
Create Destination POV BooleanField Whether to create the target POV if it does not exist

Outputs

None

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

Delete POV

Deletes model artifacts and Essbase cube data from a POV

Inputs

Input Type Detail Notes
POV Name TextField Name of the POV to be deleted

Outputs

None

Exit Codes

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

Deploy Cube

Deploy or redeploy the calculation cube for a selected Profitability and Cost Management application

Inputs

Input Type Detail Notes
Keep data BooleanField Specify whether to preserve existing data
Replace Cube BooleanField Specify whether to replace existing cube. Note:Both Keep data and Replace cube cannot be true at the same time.
Comment TextField Any user comments

Outputs

Output Output Type Notes
Job Response Json

Exit Codes

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

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

Enable Application

Enables a PCMCS application

Inputs

None

Outputs

None

Exit Codes

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

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 Query Results

Runs a query defined in an application and exports the results into a text file

Inputs

Input Type Detail Notes
File Name TextField Name of the query output file to be exported. This file will be stored in the application's outbox and can subsequently be downloaded
Query Name TextField OPTIONAL: Query that is defined in the application. Do not specify a query name if you want to export all Essbase data belonging to the application
Export Only Level 0 BooleanField Whether the data retrieved by the query should be at the lowest granularity. This parameter is ignored if you are exporting all application data
Rounding Precision (Decimal Places) NumberField The number of decimal places to round to.

Outputs

Output Output Type Notes
Export Query Results File Name String

Exit Codes

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

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

Export Template

Exports an application as a template into a .zip file. The exported file is stored in "profitoutbox" within the application

Inputs

Input Type Detail Notes
File Name TextField Name for the template file. NOTE: This file will be stored in the "profitoutbox" folder within the application and can be subsequently downloaded

Outputs

Output Output Type Notes
Export Template File Name String

Exit Codes

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

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 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

Import Template

Creates an application structure by importing from a template file that exists in profitinbox

Inputs

Input Type Detail Notes
File Name TextField Name for the template file. NOTE: This file must be present in the profitinbox folder
Description TextField User comment for the application import
Overwrite BooleanField Whether to override an application if one already exists with same name

Outputs

None

Exit Codes

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

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

Load Data

Load data into a calculation cube using a file available in profitinbox

Inputs

Input Type Detail Notes
Data File Name TextField Specifies a data load file. Note: This file must be available in "profitinbox" in your Oracle Cloud application
Data Load Value DropdownField Specifies how to handle existing data
Clear All Data BooleanField Specifies whether to clear existing data in the application cube

Outputs

None

Exit Codes

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

Load Dimension Data

Loads dimension metadata from a file in profitinbox into an application

Inputs

Input Type Detail Notes
Data File Name TextField Specifies a dimension metadata load file. Note: This file must be available in "profitinbox" in your Oracle Cloud application

Outputs

None

Exit Codes

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

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 Calc

Runs calculations in an application. Using this command, you can run calculations using rules in a Model POV against data in a different Data POV without copying rules across POVs.

Inputs

Input Type Detail Notes
POV Group Member TextField The model POV group member from which the rules will be used for calculations. If Data POV Name is not passed, this value is used as both model and data POV
Data POV Name TextField The data POV group member for which to run calculations. Note: Execution type of "All Rules" must be set when this field is specified
Execution Type DropdownField Rule execution type
Subset Start TextField Rule Set starting sequence number
Subset End TextField Rule Set ending sequence number
Rule Name TextField Rule name. Note: Can only be used when Execution Type is set to "Single Rule"
Rule Set Name TextField Rule Set name. Note: Can only be used when Execution Type is set to "Single Rule"
Comment TextField User comment
String Delimiter TextField String delimiter for POV group members
Clear Calculated BooleanField Whether to clear the calculation data
Optimize for Reporting BooleanField Whether to optimize calculations for reporting

Outputs

None

Exit Codes

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

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

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
Chunk Size NumberField The file is uploaded in chunks, and you can tweak the chunk size here. The default is 50

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.