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)
To enable these commands, an IT admin first creates an Oracle PCMCS connector.
Apply data grants
To refresh the data grants—which control access to Essbase® data slices— so they match the data grants defined in Oracle PCMCS, use an Apply Data Grants command.
Properties
None
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |
Clear POV
To clear model artifacts and data from a POV combination or a data region within the POV in an application, use a Clear POV command.
Properties
| Property |
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 Clear manage rule, Clear allocated values, or Clear adjustment values. |
| String delimiter |
The string delimiter for POV group members. By default, _. |
| Clear manage rule |
To clear the program rule details, check this box. If Query name 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 Query name is provided, do not check this box. |
| Clear adjustment values |
To clear adjustment values, check this box. If Query name 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 ASO to tabular
To convert an aggregate storage (ASO) export file in its native format to a tabular file, use a Convert ASO to Tabular command. For example, use this command to share data with:
- Block Storage (BSO) Essbase cubes
- Relational databases
- Reporting applications like Tableau® or Microsoft Power BI®
Properties
| Property |
Detail |
| ASO export file |
Enter the ASO export file to convert. |
| LCM export file |
To determine the dimension and members of your application, enter a Life Cycle Management (LCM) Export ZIP file of its metadata. |
Outputs
| Output |
Output type |
| CSV output file |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
Convert CSV to the Planning file format
To convert a CSV file to the native Planning file format, use a Convert CSV to the Planning File Format command.
Properties
| Property |
Detail |
| Source |
Enter the CSV file to convert to the native 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 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 Planning file 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 Planning file format output, such as Plan Element, Product, Market, Year, Scenario, Verion, Currency, Period. |
| Type |
Enter the name of the Oracle PCMCS type. |
Outputs
| Output |
Output type |
| Planning file output |
File |
| Number of 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, use a Convert Planning File Format to CSV command.
Properties
| Property |
Detail |
| Source |
Enter the native Planning file format output to convert to CSV. |
| Delimiter |
Select the delimiter to use in Converted CSV output. |
| POV fields |
List the names of the columns for each part of the Point-of-View. The number of columns must match the number of elements in Source's Point-of-View. |
| Keep PCMCS type |
To insert the Oracle PCMCS type as the first column of Converted 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
To copy the model artifacts and Essbase cube data from a source POV to a destination POV, use the Copy POV command.
Properties
| Property |
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
To migrate—or clone—an environment by copying a snapshot from a source environment to the current target environment, use a Copy Snapshot command. For example, use this command to migrate from a test environment to a production environment.
Properties
| Property |
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 Source password file, enter a password file generated by EPM Automate. |
| Source password file |
Enter the password file for the source environment, generated by EPM Automate. Or, 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 |
Delete file
To delete a file or application snapshot from the default upload location, a Data Management folder, or profitinbox/profitoutbox, use a Delete File command. To delete a file from a location other than the default upload location, specify the file location.
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 |
Delete POV
To delete model artifacts and Essbase cube data from a POV, use a Delete POV command.
Properties
| Property |
Detail |
| POV name |
Enter the name of the POV to delete. |
| String delimiter |
The delimiter used in the POV values. |
Note: If a matching POV is not found, Oracle's error messaging will look something like this:
Error running command: Invalid dimension member group combination: '2009', 'January', 'Actual', 'null'.
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |
Deploy cube
To deploy a calculation cube for the selected Profitability and Cost Management application, use a Deploy Cube command.
Properties
| Property |
Detail |
| Keep data |
To preserve existing data, check this box. |
| Replace cube |
To replace an existing cube, check this box. |
| Comment |
Enter any comments about the cube or deployment. |
Note: Select either Keep data or Replace cube, not both.
Outputs
| Output |
Output type |
| Job Response |
JSON |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |
Download file
To download a file from an environment, use a Download File command.
Properties
| Property |
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
To enable a PCMCS application, use an Enable Application command.
Properties
None
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |
Export mapping
To export the mapping rules of a specific dimension or location to create a mapping rule file, use 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 |
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
To run a query defined in an application and export its results into a text file, use an Export Query Results command.
Properties
| Property |
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 is blank. |
| Rounding precision (decimal places) |
Enter the number of decimal places to round amounts to in the query results. |
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
To repeat a previously performed export operation to create a snapshot of Migration content, use 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 |
Export template
To export an application as a template into a ZIP file, use an Export Template command.
Properties
| Property |
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
To import mappings for a mapping import file previously uploaded to the service, use an Import Mapping command.
Properties
| Property |
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
To import the contents of a snapshot into the service environment, use 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 |
Import template
To create an application structure by importing from a template file that exists in profitinbox, use an Import Template command.
Properties
| Property |
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
To list the files in the default location, Data Management folders, and profitinbox/profitoutbox, use a List Files command.
Note: This command doesn't list Migration snapshots.
Properties
| Property |
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, use a Load Data command.
Properties
| Property |
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
To load dimension metadata from a file in profitinbox into an application, use a Load Dimension Data command.
Properties
| Property |
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
To restart the environment, use the 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 calc
To run calculations in an application, use a Run Calc command. With this command, you can run calculations using rules in a model POV against data in another data POV without copying rules across the POVs.
Properties
| Property |
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 Data POV Name is blank. |
| Data POV name |
Enter the data POV group member to run calculations for. If set, select All Rules in Execution Type. |
| Execution type |
Select the rule execution type. If Data POV Name 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 Execution Type is Single Rule, enter the name of the rule. |
| Rule set name |
If Execution Type 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
To start the daily service maintenance process immediately, rather than waiting for the scheduled daily maintenance window, use 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 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, use 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. 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
To execute a Data Management data load rule based on the start and end period and import or export options specified, use 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 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 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 |
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
To upload a file that contains data, metadata, rule definitions, dimension definitions, mapped transactions, templates, or backup snapshots, use 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, use 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 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
To generate a provisioning report as a CSV file and store it in the default download location, use 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 |