To connect to Oracle® Financial Consolidation & Close Cloud Service (FCCS) as part of a chain, add a step with an Oracle FCCS connection command. For example:
- Upload or download files
- Run business rules and data manager jobs
- Automate administrative functions
- Bi-directionally convert the native Simplified User Interface (SUI) format of Oracle Planning and Budget Cloud Service (PBCS) and Enterprise Planning and Budget Cloud Service (EBPCS) to standard comma-separated values (CSV)
To enable these commands, an IT admin first creates an Oracle FCCS connector.
Tip: Since Oracle FCCS uses Essbase®, exporting from a dynamically-calculated member may result in a poor extract because the data only exists on a query. We recommend you only export data from stored, non-dynamic members.
Convert CSV to Planning file format
To convert a comma-separated values (CSV) file into the native Planning file format, use a Convert CSV to Planning File Format command.
Equivalent API call:
Properties
| Property | Detail |
|---|---|
| Source file | Enter the CSV file to convert to the Planning file format. |
| Delimiter | Select the delimiter used in Source File. |
| SUI columns |
List the columns in the order they should appear in the Planning file format output, such as |
| Target column (spare 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 precede the Point-of-View (POV) column in the Planning file format output. Per the prior example, OFS_Volume and OFS_ASP. |
| POV columns |
List the names of the columns to add to the POV column in the Planning file format output, such as |
| FCCS type | Enter the name of the FCCS type. |
Outputs
| Output | Output type |
|---|---|
| Planning file format | 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 into a CSV output, use a Convert Planning File Format to CSV command.
Equivalent API call:
Properties
| Property | Detail |
|---|---|
| Source file | Enter the Planning file format file to convert to the CSV output. |
| Delimiter | Select the delimiter to use in the CSV output. |
| POV fields | List the column names for each part of the POV. The number of fields must match the number of elements in the Planning file format file's POV. |
| Keep FCCS type | To insert the FCCS type as the first column of the CSV output, check this box. |
Outputs
| Output | Output type |
|---|---|
| Converted CSV file | 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, use a Copy File Between Instances command. For example, use this command to copy a file from a test environment to the production environment.
Equivalent API call:
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 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, use a Copy Snapshot command to copy a snapshot of a source environment to the current target environment. For example, use this command to copy a snapshot from a test environment to the production environment.
Equivalent API call:
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. 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 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 |
Delete file
To delete a file or application snapshot from the default upload location, a Data Management folder, or from profitinbox/profitoutbox, use a Delete File command.
Equivalent API call:
Properties
| Property | Detail |
|---|---|
| File name | Enter the name of the file to delete. If other than the default upload location, include the path to the file. |
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, use a Download File command.
Equivalent API call:
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. |
| Automatically unzip | To automatically unzip the file for user as an output, check this box. If the ZIP file contains more than one file, its contents won't unzip. |
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 |
Export data
To export base-level application data into a ZIP file based on the settings specified in an Export Data job, use an Export Data command. The command stores the exported data file in the default download location, where you can download it to your computer.
Equivalent API call:
Properties
| Property | Detail |
|---|---|
| Job name | Enter the name of the Export Data job with the export data 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 mapping rules of a specific dimension or location to create a mapping rule file, use an Export Mapping command.
Equivalent API call:
Properties
| Property | Detail |
|---|---|
| Dimension | Enter the source dimension to export 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 file based on the settings specified in an Export Metadata job, use an Export Metadata command.
Equivalent API call:
Properties
| Property | Detail |
|---|---|
| Job name | Enter the name of the Export Metadata job with the export settings to use. |
| File name | Enter the name of the ZIP file to export 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 snapshot
To repeat a previously performed Export operation to create a snapshot of Migration content, use an Export Snapshot command.
Equivalent API call:
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 retrieve the values of substitution variables, use a Get Substitution Variable command.
Equivalent API call:
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 import data from a file into the application based on the settings specified in an Import Data job, use an Import Data command.
Equivalent API call:
Properties
| Property | Detail |
|---|---|
| Job name | Enter the name of the Import Data job with the import data settings to use. |
| File name | Enter the name of the ZIP file to import data from. |
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 mapping
To import mappings from a mapping import file previously uploaded to the service, use an Import Mapping command.
Equivalent API call:
Properties
| Property | Detail |
|---|---|
| File name | Enter the name of the mapping import file with the mappings to import. |
| Dimension | Enter the name of the dimension to import the mappings into. To import all mappings included in the file to their 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:
|
| 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 based on the settings specified in an Import Metadata job, use an Import Metadata command.
Equivalent API call:
Properties
| Property | Detail |
|---|---|
| Job name | Enter the name of the Import Metadata job with the import data settings to use. |
| File name | Enter the name of the ZIP file to import metadata from. |
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, use an Import Snapshot command.
Equivalent API call:
Properties
| Property | Detail |
|---|---|
| Snapshot name | Enter the name of the snapshot to import the contents of. The snapshot must be in the default upload location. |
| New default password | Enter the default password to assign to 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 supplemental data
To import supplemental data from a CSV file into the application, use an Import Supplemental Data command.
Equivalent API call:
Properties
| Property | Detail |
|---|---|
| File name | Enter the name of the CSV file—available in the default upload location—that contains properly-formatted supplemental data. |
| Data set name | Enter the name of the data set to import the supplemental data into. |
| Year | Enter the year to deploy the data set for. |
| Period name | Enter the name of the period to deploy the data to. |
| Scenario name | Enter the name of the scenario to deploy the data to. |
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.
Equivalent API call:
Properties
| Property | Detail |
|---|---|
| Filter | Enter the filter criteria of the files to return. To return all files that match the pattern provided, use the glob syntax, such as *.csv. |
Outputs
| Output | Output type |
|---|---|
| FCCS files | Array |
| FCCS 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 |
Refresh cube
To refresh the application cube, use a Refresh Cube command.
Equivalent API call:
Properties
| Property | Detail |
|---|---|
| Job name | Enter the name of a 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, use a Restart command.
Note: Use this command only if you observe severe performance degradation, or if you receive error messages indicating that the environment is unusable.
Equivalent API call:
Properties
| Property | Detail |
|---|---|
| Comment | Enter the comment to associate to 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, use a Run Business Rule command.
Equivalent API call:
Properties
| Property | Detail |
|---|---|
| Rule name | Enter the name of a 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, use a Run Daily Maintenance command.
Equivalent API call:
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, use a Run Data Management Batch command.
Equivalent API call:
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 batch report, use a Run Data Management Report command. The command stores the batch report in the outbox/reports folder.
Equivalent API call:
Properties
| Property | Detail |
|---|---|
| Report name | Enter the name of the Data Management report template to use to generate the report. |
| Report format | Select the format of the report output. |
| 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 | 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 periods, and import or export the specified options, use a Run Data Management Rule command.
Equivalent API call:
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 data 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 data from. This 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 to 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, use a Run Plan Type Map command. This command uses the settings specified in a Plan Type Map job.
Equivalent API call:
Properties
| Property | Detail |
|---|---|
| Job name | Enter the name of the Plan Type Map job with the settings to use. |
| Clear data | To remove data in the target database before copying the data, 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 substitution variables
To create or update substitution variables at the application or cube level, use a Set Substitution Variables command.
Note: This command can't set multiple values or functions for substitution variables.
Equivalent API call:
Properties
| Property | Detail |
|---|---|
| Cube | Enter the cube—such as Plan1, Plan2— to create or update the substitution variable for. To set or update substitution variables at the application level, enter ALL. |
| Variables | Enter a mapping of variables and their values. If the variable doesn't exist, it's 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, use an Upload File command. Use this command to upload files containing:
- Data and metadata
- Rule definitions
- Dimension definitions
- Mapped transactions
- Templates
- Backup snapshots
Equivalent API call:
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. |
| 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, use a User Audit Report command. The command stores the audit report in the default download location.
Equivalent API call:
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, use a User Provisioning Report command. The command stores the provisioning report in the default download location.
Equivalent API call:
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 |
Related articles
Articles related to this page.