Help Desk

Submit a ticket My Tickets
Welcome
Login

Oracle ARCS Command Reference

The Oracle ARCS BizApp provides functionality for executing jobs related to importing balances, transactions, rules, and more

Connections

Oracle ARCS

Basic authentication connection to ARCS

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

Commands

Change Period Status

Set a specific period status

Inputs

Input Type Detail Notes
Period TextField Name of the period in ARCS
Status DropdownField Desired period status

Outputs

None

Exit Codes

Code Type Detail
0 Success Command completed successfully
1 Error Invalid arguments
2 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.
ARCS Type TextField Name of the ARCS 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 ARCS Type BooleanField When selected, inserts the ARCS 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 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

Create Reconciliations

Copies the profiles to a specified period

Inputs

Input Type Detail Notes
Period TextField Name of the period in ARCS
Filter TextField The name of a saved public filter. If you do not specify a saved filter, all applicable profiles will be copied

Outputs

None

Exit Codes

Code Type Detail
0 Success Command completed successfully
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 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

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

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

Import Balances

Uses Data Management to import balances data from a data load definition

Inputs

Input Type Detail Notes
Period TextField Name of the period in ARCS
Data Load Definition TextField An existing data load definition in Oracle Account Reconciliation Cloud

Outputs

None

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 Pre-Mapped Balances

Imports pre-mapped balance data from a file in ARCS

Inputs

Input Type Detail Notes
Period TextField Name of the period in ARCS
Balance Type DropdownField Balance type
Currency Bucket DropdownField Currency bucket
File Name TextField The name of the CSV file containing the data to be imported (must be in ARCS)

Outputs

None

Exit Codes

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

Import Pre-Mapped Balances into Transaction Matching

For a specific data source, imports pre-mapped balances data from a file in ARCS repository into Transaction Matching

Inputs

Input Type Detail Notes
Data Source TextField The identifier of the data source associated with the reconciliation type that you specified
Reconciliation Type TextField The reconciliation type defined in ARCS
File Name TextField The name of the CSV file containing details of the balances to import (must be in ARCS)
Date Format TextField (Optional) - Parameter that indicates the format of the date fields included in the balances import file. Currently, only DD-MMM-YYYY is supported

Outputs

None

Exit Codes

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

Import Pre-Mapped Transactions

Imports pre-mapped transactions from a CSV file in ARCS

Inputs

Input Type Detail Notes
Period TextField Name of the period in ARCS
Transaction Type DropdownField Transaction type
Date Format TextField Date format text string (i.e. MM-DD-YYY)
File Name TextField The name of the CSV file containing the data to be imported (must be in ARCS)

Outputs

None

Exit Codes

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

Import Pre-Mapped Transactions into Transaction Matching

For a specific data source, imports pre-mapped transactions data from a file in ARCS repository into Transaction Matching

Inputs

Input Type Detail Notes
Data Source TextField The identifier of the data source associated with the reconciliation type that you specified
Reconciliation Type TextField The reconciliation type defined in ARCS
File Name TextField The name of the CSV file containing details of the transactions to import (must be in ARCS)
Date Format TextField (Optional) - Parameter that indicates the format of the date fields included in the transactions import file. Currently, only DD-MMM-YYYY is supported

Outputs

None

Exit Codes

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

Import Profiles

Imports new profile definitions from a CSV file in ARCS

Inputs

Input Type Detail Notes
Period TextField Name of the period in ARCS
Profile Type DropdownField Profile Type
Import Type DropdownField Import type
Date Format TextField Date format text string (i.e. MM-DD-YYY)
File Name TextField The name of the CSV file containing the data to be imported (must be in ARCS)

Outputs

None

Exit Codes

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

Import Rates

Imports currency rates from a CSV file in ARCS

Inputs

Input Type Detail Notes
Period TextField Name of the period in ARCS
Rate Type TextField Pre-defined rate type
Import Type DropdownField Import type
File Name TextField The name of the CSV file containing the data to be imported (must be in ARCS)

Outputs

None

Exit Codes

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

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

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

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

Runs the Auto Match process to match transactions using the rules defined by a Service Administrator

Inputs

Input Type Detail Notes
Reconciliation Type ID TextField The Text ID of the Reconciliation type to be auto matched

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

Set Demo Dates

Renames the periods in Oracle Account Reconciliation Cloud to be consistent with the specified date. It also resets dates for all reconciliations that have associated Demo Code attribute values of "setdemodate" or "setdemodatenostatuschage"

Inputs

Input Type Detail Notes
Date TextField An optional date in YYYY-MM-DD format. Reconciliations are reset to the current date if you do not specify this value

Outputs

None

Exit Codes

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

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

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.