To connect and automate Oracle® Account Reconciliation Cloud Service (ARCS) as part of a chain, add a step with an Oracle ARCS connection command. For example:
- Import balances, transactions, rules, or exchange data
- Execute business rules
- Generate reports
- Run Data Manager jobs
- Convert Oracle ARCS's native Enterprise Performance Management (EPM) Cloud format to and from standard comma-separated values (CSV)
To enable these commands, an IT admin first creates an Oracle ARCS connector.
Change period status
To set a specific period status, use a Change Period Status command.
Properties
| Property |
Detail |
| Period |
Enter the name of the period in Oracle ARCS. |
| Status |
Select the desired status of the period. |
Outputs
None
Exit Codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |
Convert CSV to Oracle EPM Cloud format
To convert a CSV file into the native Oracle EPM Cloud—or Simplified User Interface (SUI)—format, use a Convert CSV to Oracle EPM Cloud Format command.
Properties
| Property |
Detail |
| Source |
Enter the CSV file to convert to the Oracle EPM Cloud format. |
| Delimiter |
Select the delimiter used in Source. |
| Final column order |
List the columns in the order to use 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 DIM) |
List the names of the driver columns. The number of columns must match the number of columns that precede the Point-of-View column in the Oracle EPM Cloud format output. Per the previous example, OFS_Volume and 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, Version, Currency, Period
|
| Plan type |
Enter the name of the Planning and Budgeting Cloud Service (PBCS) or Enterprise Planning and Budgeting Cloud Service (EPBCS) 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 Oracle EMP Cloud format to CSV
To convert the native Oracle EMP Cloud format to a CSV output, use a Convert Oracle EMP Cloud Format to CSV command.
Inputs
Properties
| Property |
Detail |
| Source |
Enter the Oracle EPM Cloud format file to convert to CSV. |
| Delimiter |
Select the delimiter to use in the CSV output. |
| POV fields |
List the column names for each part of the Point-of-View. The number of fields must match the number of elements in the Oracle EPM Cloud format file's Point-of-View. |
| Keep plan type |
To insert the plain type as the first column of the resulting CSV, 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 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.
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 directly 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 by copying a snapshot from a source environment to the current target environment, use a Copy Snapshot command. For example, use this command to copy a snapshot from a test environment to the production environment.
Properties
| Property |
Detail |
| Snapshot name |
Enter the name of the snapshot 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 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 |
| 10 |
Warning |
Command completed with warnings |
Create reconciliations
To copy profiles to a specified period, use a Create Reconciliations command.
Properties
| Property |
Detail |
| Period |
Enter the name of period in Oracle ARCS. |
| Filter |
Enter the name of the saved public filter. To copy all applicable profiles, leave blank. |
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 proftinbox/profitoutbox, use a Delete File command.
Properties
| Property |
Detail |
| File name |
Enter the name of file to delete. If other than the default upload location, also include the path to the file. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |
Download a file
To download a file from an environment, use a Download a File command.
Properties
| Property |
Detail |
| File name |
Enter the name of file to download. This can contain a path to the file's location, if not the default upload location. |
| Automatically unzip |
To automatically unzip the file for use as an output (if applicable), check this box. If the ZIP file contains multiple files, the 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 mapping
To export 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 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 mappings 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 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 |
Import balances
To use Data Management to import balances from a data load definition, use an Import Balances command.
Properties
| Property |
Detail |
| Period |
Enter the name of the period in ARCS. |
| Data load definition |
Enter an existing data load definition in Oracle ARCS. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |
Import mappings
To import mappings from a mapping report file previously uploaded to the service, use an Import Mappings command.
Properties
| Property |
Detail |
| File name |
Enter the name of the ZIP file to export metadata into. |
| Dimension |
Enter the name of the dimension to import the mappings into. To import all mappings inclued in the file to their appropriate dimensions, enter ALL. |
| Import location |
Enter the Data Management location to load the mapping rules for. |
| Import mode |
Select how to handle existing mapping rules during the import:
- To clear the existing rules before importing the mappings, select Replace.
- To add new mapping rules to the 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 pre-mapped balances
To import pre-mapped balance data from a file in ARCS, use an Import Pre-Mapped Balances command.
Properties
| Property |
Detail |
| Period |
Enter the name of the period in ARCS. |
| Currency bucket |
Select the currency bucket. |
| File name |
Enter the name of the CSV file in ARCS containing the data to import. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |
Import pre-mapped balances into Transaction Matching
To import pre-mapped balances data from a file in ARCS repository into Transaction Matching for a specific data source, use an Import Pre-Mapped Balances into Transaction Matching command.
Properties
| Property |
Detail |
| Data source |
Enter the identifier of the data source associated with Reconciliation Type. |
| Reconciliation type |
Enter the reconciliation type defined in ARCS. |
| File name |
Enter the name of the CSV file in ARCS containing the balances to import. |
| Date format |
Optionally, enter the format of the date fields included in the balance import file, as DD-MMM-YYYY. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |
Import pre-mapped transactions
To import pre-mapped transactions from a CSV file in ARCS, use an Import Pre-Mapped Transactions command.
Properties
| Property |
Detail |
| Period |
Enter the name of the period in ARCS. |
| Transaction type |
Enter the type of transactions to import. |
| Date format |
Enter the format of the date fields, such as MM-DD-YYYY. |
| File name |
Enter the name of the CSV file in ARCS containing the data to import. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |
Import pre-Mapped transactions into Transaction Matching
To import pre-mapped transactions data from a file in ARCS repository into Transaction Matching for a specific data source, use an Import Pre-Mapped Transactions into Transaction Matching command.
Properties
| Property |
Detail |
| Data source |
Enter the identifier of the data source associated with Reconciliation Type. |
| Reconciliation type |
Enter the reconciliation type defined in ARCS. |
| File name |
Enter the name of the CSV file in ARCS containing the transactions to import. |
| Date format |
Optionally, enter the format of the date fields included in the transactions import file, as DD-MMM-YYYY. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |
Import profiles
To import new profile dimensions from a CSV file in ARCS, use an Import Profiles command.
Properties
| Property |
Detail |
| Period |
Enter the name of the period in ARCS. |
| Profile type |
Select the type of profile to import. |
| Import type |
Select the type of import. |
| Date format |
Enter the format of the date fields, such as MM-DD-YYYY. |
| File name |
Enter the name of the CSV file in ARCS containing the data to import. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |
Import rates
To import currency rates from a CSV file in ARCS, use an Import Rates command.
Properties
| Property |
Detail |
| Period |
Enter the name of the period in ARCS. |
| Rate type |
Select the pre-defined type of currency rate to import. |
| Import type |
Select the type of import. |
| File name |
Enter the name of the CSV file in ARCS containing the data to import. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |
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 to new users created in the identity domain.
The password must meet the minimum identity requirements.
|
| Reset password |
To require users to change their password at the first sign-in, 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 of the files to return. To return all files that match the pattern, use the glob syntax, such as *.csv. |
Outputs
| Output |
Output Type |
| PBCS files |
Array |
| PBCS 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 |
Restart
If you observe severe performance degradation or receive error messages indicating the environment is unusable, use a Restart command to restart the environment.
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 Auto Match
To run the Auto Match process to match transactions using the rules defined by a Service Administrator, use a Run Auto Match command.
Properties
| Property |
Detail |
| Reconciliation type ID |
Enter the text ID of the reconciliation type to auto-match. |
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 instead of waiting for the scheduled daily maintenance window, use the 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, use 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 |
Array |
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/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 report's output format. |
| Report parameters |
Enter the report's parameters and their value, depending 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 period and end period and specified import or export options, 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—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, 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 |
Set demo dates
To rename demo periods in Oracle ARCS to be consistent with the specified date, use a Set Demo Dates command.
Note: To identify demo periods, the command resets dates for all reconciliations that have associated Demo Code attribute values of setdemodate or setdemodatenostatuschange.
Properties
| Property |
Detail |
| Date |
Enter the date to base the renamed periods on, in the YYYY-MM-DD format. To reset reconciliations to the current date, leave blank. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |
Upload file
To upload a file, use an Upload File command. For example, use this command to upload files containing:
- Data and metadata
- Rule definitions
- Dimension definitions
- Mapped transactions
- Templates
- Backup snapshots
Properties
| Property |
Detail |
| Upload file |
Enter the file to upload. |
| Upload name |
Enter the name of the file upon upload. To use the same name as Upload File, leave blank. |
| File path |
Optionally, enter the path 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 and store it in the default download location, use the User Audit Report command.
Properties
| Property |
Detail |
| Report name |
Enter the name of the report file to create. |
| From date |
Enter the start date of the period to generate the report for, in YYYY-MM-DD format. |
| To date |
Enter the end date of the period to generate the report for, in YYYY-MM-DD format. |
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 generates 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 |