Oracle PCMCS Commands

To connect and automate Oracle® Profitability and Cost Management Cloud Service (PCMCS) as part of a chain, add a step that includes an Oracle PCMCS connection command. For example:

  • Interact with Point-of-View (POV) and dimension data and templates
  • Load and download files
  • Run business rules and data manager jobs
  • Bi-directionally convert the native Simplified User Interface (SUI) format to standard comma-separated values (CSV)

Apply Data Grants

Refreshes the data grants—which control access to Essbase® data slices— so they match the data grants defined in Oracle PCMCS

Inputs

None

Outputs

None

Exit Codes

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

Clear POV

Clears model artifacts and data from a POV combination or a data region within the POV in an application

Inputs

Input Detail
POV Group Member Enter the POV group member to clear model artifacts and data for
Query Name Enter name of a query already existing in the application to use to clear a region within the given POV. If you enter a query name, do not select the Clear Manage Rule, Clear Allocated Values, or Clear Adjustment Values inputs.
String Delimiter The string delimiter for POV group members. By default, _.
Clear Manage Rule To clear the program rule details, check this box. If the Query Name input is provided, do not check this box.
Clear Input Data To clear input data, check this box
Clear Allocated Values To clear allocation values, check this box. If the Query Name input is provided, do not check this box.
Clear Adjustment Values To clear adjustment values, check this box. If the Query Name input is provided, do not check this box.

Outputs

None

Exit Codes

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

Convert CSV to the Native Oracle EPM Cloud Format

Converts a CSV file to the native Oracle Enterprise Performance Management (EPM) Cloud—or SUI—format

Inputs

Input Detail
Source Enter the CSV file to convert to the Oracle EPM Cloud or SUI format
Delimiter Select the delimiter used in the Source input/td>
Final Column Order List the columns in the order they should appear in the Oracle EPM Cloud 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 Data) 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 Oracle EPM Cloud format output. Per the previous example, OFS_Volume, OFS_ASP.
POV Columns List the names of the columns to add to the Point-of-View column in the Oracle EPM Cloud format output, such as Plan Element, Product, Market, Year, Scenario, Verion, Currency, Period
Plan Type Enter the name of the Oracle PCMCS plan type

Outputs

Output Output Type
Native Oracle EPM Output File
Number of Records Integer

Exit Codes

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

Convert the Native Oracle EPM Cloud Format to CSV

Converts the native Oracle EPM Cloud format into a CSV output

Inputs

Input Detail
Source Enter the Oracle EPM Cloud format file to convert to CSV
Delimiter Select the delimiter to use in the CSV output
POV Columns List the column names for each part of the Point-of-View. The number of fields must match the number of elements in the source Oracle EPM Cloud format file's POV.
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 POV

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

Inputs

Input Detail
Source POV Member Group Enter the source POV member group to copy data from
Destination POV Member Group Enter the POV member group to copy data to
Model View Name Enter the name of the data slice to copy from the source POV to the target POV
String Delimiter The delimiter used in the POV values. By default, _.
Copy Rule Details To copy the program rule details, check this box
Copy Input Data To copy input data, check this box
Create Destination POV To create the target POV if it doesn't exist, check this box

Outputs

None

Exit Codes

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

Copy Snapshot

Migrates—or clones—an environment by copying a snapshot from a source environment to the current target environment, such as from a test environment to a production environment

Inputs

Input Detail
Snapshot Name Enter the name of the snapshot
Source User Name Enter the username for the source environment
Source Instance Password Enter the password for the source environment. Or, in the Source Password File input, enter a password file generated by epmautomate.
Source Password File Enter the password file for the source environment, generated by epmautomate. Or, enter the password directly in the Source Instance Password input.
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

Delete File

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

Inputs

Input 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

Delete POV

Deletes model artifacts and Essbase cube data from a POV

Inputs

Input Detail
POV Name Enter the name of the POV to delete

Outputs

None

Exit Codes

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

Download File

Downloads a file from an environment

Inputs

Input Detail
POV 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
Downloaded Records Integer

Exit Codes

Code Type Detail
0 Success Success
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 Success
1 Error Invalid arguments
2 Error General failure

Export Mapping

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

Inputs

Input 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 File String

Exit Codes

Code Type Detail
0 Success Success
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 Detail
File Name Enter the name of the query output file to export. This file will be stored in the application's outbox and can subsequently be downloaded.
Query Name Enter the name of the query defined in the application. To export all Essbase data belonging to the application, leave blank.
Export Only Level 0 To have the query retrieve data at the lowest granularity, check this box. Ignored if Query Name input is blank.

Outputs

Output Output Type
Export Query Results 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

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

Inputs

Input 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

Export Template

Exports an application as a template into a ZIP file

Inputs

Input Detail
File Name Enter the name of the template file. The file will be stored in the profitoutbox folder within the application and can be downloaded.

Outputs

Output Output Type
Export Template File Name String

Exit Codes

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

Import Mapping

Imports mappings for a mapping import file previously uploaded to the service

Inputs

Input Detail
File Name Enter the name of the 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 appropriate dimensions, enter 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 Snapshot

Imports the contents of a snapshot into the service environment

Inputs

Input 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

Import Template

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

Inputs

Input Detail
File Name Enter the name of the template file. This file must be in the profitinbox folder.
Description Enter the user comment for the application import
Overwrite To overwrite an application if another with the same name already exists, check this box

Outputs

None

Exit Codes

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

List Files

Lists the files in the default location, Data Management folders, and profitinbox/profitoutbox

Inputs

Input Detail
Filter Enter the filter criteria for the files to return. To return all files that match the pattern, use the glob syntax, such as *.csv.

Outputs

Output Output Type
PCMCS Files Array
PCMCS 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

Load Data

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

Inputs

Input Detail
Data File Name Enter the name of the data load file. This file must be in the profitinbox folder.
Data Load File Select how to handle existing data
Clear All Data To clear existing data in the application cube, check this box

Outputs

None

Exit Codes

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

Load Dimension Data

Loads dimension metadata from a file in profitinbox into an application

Inputs

Input Detail
Data File Name Enter the name of the data load file with the dimension metadata. This file must be in the profitinbox folder.

Outputs

None

Exit Codes

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

Restart

Restarts the environment

Inputs

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

Runs calculations in an application. With this command, you can run calcuations using rules in a model POV against data in another data POV without copying rules across the POVs.

Inputs

Input Detail
POV Group Member Enter the model POV group member with the rules to use for calculations. Used for both the model and data POVs if the Data POV Name input is blank.
Data POV Name Enter the data POV group member to run calculations for. If set, select All Rules in the Execution Type input.
Execution Type Select the rule execution type. If the Data POV Name input is provided, select All Rules.
Subset Start Enter the starting sequence number for the rule set
Subset End Enter the ending sequence number for the rule set
Rule Name If the Execution Type input is Single Rule, enter the name of the rule
Rule Set Name If the Execution Type input is Single Rule, enter the name of the rule set
Comment Enter the user comment
String Delimiter Enter the string delimiter for the POV group members
Clear Calculated To clear the calculation data, check this box
Optimize for Reporting To optimize calculations for reporting, check this box

Outputs

None

Exit Codes

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

Run Daily Maintenance

Starts the daily service maintenance process immediately, rather than waiting for the scheduled daily maintenance window

Inputs

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

Executes a Data Management batch

Inputs

Input Detail
Batch Name Enter the name of the batch 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

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

Inputs

Input 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. The list of required parameters depends on the report to generate.

Outputs

Output Output Type
Data Management Report Log File Name String
Data Management Report File Name File

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

Executes a Data Management data load rule based on the start and end period and import or export options specified

Inputs

Input Detail
Rule Name Enter the name of the data load rule defined in Data Management
Start Period Enter the first period to load data for, as defined in Data Management period mapping
End Period For multi-period load, enter the last period to load data for, as defined in Data Management period mapping. For single-period load, enter the same period as the Start Period input.
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 File

Exit Codes

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

Upload File

Uploads a file containing data, metadata, rule definitions, dimension definitions, mapped transactions, tempaltes, or backup snapshots

Inputs

Input Detail
Upload File Enter the file to upload
Upload Name Enter the name to upload the file as. To use the same name as the Upload File input, 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

Generates a user audit report as a CSV file, and stores it in the default download location

Inputs

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

User Provisioning Report

Generates a provisioning report as a CSV file, and stores it in the default download location

Inputs

Input 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