Table of Contents

Connections

Commands

Connections

Oracle EDMCS

Basic authentication to the EDMCS instance

Inputs

Input

Type

Detail

Notes

User Name

TextField

EDMCS username

Password

TextField

EDMCS password

Service Name

TextField

Name of the Oracle Cloud service instance to which you are connecting

Identity Domain

TextField

Your Oracle Cloud Domain (comes after the service name in the URL, i.e. servicename-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)

Commands

Convert Generational File to Parent-Child

Convert a generational data structure into parent-child format

Inputs

Input

Type

Detail

Notes

Input File

FileField

File to be converted

Delimiter

DropdownField

Delimiter for input file

Has Header

BooleanField

Whether or not the CSV file contains a header record

Has Aliases

BooleanField

Select this option when the generational file has an alias that needs to be preserved after the parent value (i.e. your file has columns of Parent, Alias, Child, Alias, etc)

Outputs

Output

Output Type

Notes

Converted Parent-Child File

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

2

Error

General failure

Convert Parent-Chid File

Convert a parent/child data structure (aka “ragged”) into a “ragged generational” format or a “balanced format”

Inputs

Input

Type

Detail

Notes

Input File

FileField

File to be converted

Delimiter

DropdownField

Delimiter for input file

Hierarchy Type

DropdownField

Type of hierarchy to which the file will be converted

Parent Column Name

TextField

Name of the column that contains the "parent" values

Child Column Name

TextField

Name of the column that contains the "child" values

Outputs

Output

Output Type

Notes

Hierarchy File

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

2

Error

General failure

Copy File Between Instances

Copies a file from an environment (source) to the current environment (target); for example from a test environment to a production environment.

Inputs

Input

Type

Detail

Notes

Source File Name

TextField

File to be copied

Source user name

TextField

Source instance user name

Source instance password

TextField

Encrypted 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 encrypted password directly via the source instance password field.

Source URL

TextField

URL of the source instance

Target File Name

TextField

Destination file name for the copied file

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

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 Request

Create a new Oracle EDMCS Request

Inputs

Input

Type

Detail

Notes

View Name

TextField

Name of the view in which the request will be created

Title

TextField

Request title

Description

TextField

Request description (optional)

Notes

TextField

Request notes (optional)

Overwrite

BooleanField

If a request exists with the same title, overwrite it and create a new request

Outputs

Output

Output Type

Notes

Request ID

String

Request JSON

Json

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

2

Error

General failure

Create Request Items from File

Adds items to an EDMCS request given an upload file

Inputs

Input

Type

Detail

Notes

File

FileField

File to use in creating request items

Request Title

TextField

EDMCS Request title

Sheet Names

ArrayField

Request sheet names

Outputs

Output

Output Type

Notes

Updated Request JSON

Json

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 Dimension Mapping to Connection

Exports a dimension mapping into a CSV file

Inputs

Input

Type

Detail

Notes

Application Name

TextField

Name of the application that contains the dimension

Dimension Name

TextField

Name of dimension to be exported

Connection Name

TextField

Name of connection to which the dimension will be exported

File Name

TextField

The target file name to export the dimension mapping to

Mapping Location

TextField

The mapping location to export

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

2

Error

General failure

Export Dimension Mapping to File

Exports a dimension mapping into a CSV file

Inputs

Input

Type

Detail

Notes

Application Name

TextField

Name of the application that the dimension belongs to

Dimension Name

TextField

Name of dimension to export

File Name

TextField

The target file name to export the dimension mapping to

Mapping Location

TextField

The mapping location to export

Outputs

Output

Output Type

Notes

Export Mapping File

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

2

Error

General failure

Export Dimension to Connection

Export a dimension in Oracle EDMCS to an existing connection

Inputs

Input

Type

Detail

Notes

Application Name

TextField

Name of the application that contains the dimension to be exported

Dimension Name

TextField

Name of dimension to be exported

Connection Name

TextField

Name of connection to which the dimension will be exported

File Name

TextField

The target file name to export the dimension mapping to

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

2

Error

General failure

Export Dimension to File

Exports a dimension from Oracle EDMCS to a downloadable CSV file

Inputs

Input

Type

Detail

Notes

Application Name

TextField

Name of the application that contains the dimension to be exported

Dimension Name

TextField

Name of dimension to export

File Name

TextField

The target file name to export the dimension mapping to

Parent Name

TextField

Optional: When filtering, specify the name of the parent. The resulting file will only include descendants of this parent member

Parent Column Name

TextField

Optional: When filtering, specify the name of the column that contains the parent on which you are filtering

Outputs

Output

Output Type

Notes

Export Dimension File

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

2

Error

General failure

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

Extract Dimension Viewpoint

Extracts a dimension viewpoint to a file

Inputs

Input

Type

Detail

Notes

Application Name

TextField

Name of the application that contains the dimension to be extracted

Dimension Name

TextField

Name of dimension to extract

File Name

TextField

Name of the file to which the dimension viewpoint will be extracted. This file will be created in your EDMCS instance and downloaded as part of the execution of this command if you did not specify a Connection

Extract Name

TextField

The name of the extract

Connection Name

TextField

Optional: When specified, this command will extract to the specified Connection instead of a file.

Outputs

Output

Output Type

Notes

Dimension Viewpoint Export

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

2

Error

General failure

Get Applications

List available Oracle EDMCS applications and returns metadata about the applications including dimensions.

Inputs

None

Outputs

Output

Output Type

Notes

Applications List

Array

Applications JSON File

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

2

Error

General failure

Get Connections

List available connections for an Oracle EDMCS application

Inputs

Input

Type

Detail

Notes

Application Name

TextField

Name of the Application that contains the relevant connections

Outputs

Output

Output Type

Notes

Connections List

Array

Connections JSON File

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

2

Error

General failure

Get Dimension Mappings

List available mappings for an Oracle EDMCS dimension

Inputs

Input

Type

Detail

Notes

Application Name

TextField

Name of the dimension's application

Dimension Name

TextField

Name of dimension that contains desired mappings

Outputs

Output

Output Type

Notes

Dimension Mappings JSON

Json

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

2

Error

General failure

Get Request

Gets the metadata of an Oracle EDMCS Request

Inputs

Input

Type

Detail

Notes

Request Title

TextField

Title of the desired request

Outputs

Output

Output Type

Notes

Request JSON

Json

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

2

Error

General failure

Get Requests

Returns a list of all the requests the user has access to

Inputs

None

Outputs

Output

Output Type

Notes

Requests List

Array

Requests JSON File

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

2

Error

General failure

Get Views

Returns a list of all the views the user has access to

Inputs

None

Outputs

Output

Output Type

Notes

Views List

Array

Views JSON File

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

2

Error

General failure

Import Dimension by Name

Imports a dimension into Oracle EDMCS by Dimension Name

Inputs

Input

Type

Detail

Notes

File Name

TextField

Name of the file to import. File should be in the staging area or the specified connection.

Application Name

TextField

Name of the application that contains the relevant dimension

Dimension Name

TextField

Name of the dimension to which data will be imported

Import Option

DropdownField

Option for Reset/Replace/Merge on Import. Default value is Replace.

Connection Name

TextField

The name of the connection where the import file is read from. If not supplied, the import file is read from the staging area.

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

2

Error

General failure

Import Dimension from Connection

Imports a dimension into Oracle EDMCS from an existing connection

Inputs

Input

Type

Detail

Notes

Application Name

TextField

Name of the application that contains the relevant dimension

Connection Name

TextField

Name of connection from which the dimension will be imported

Dimension Name

TextField

Name of the dimension that will receive the import

File Name

TextField

The name of the file to import from at the given connection

Reset Dimension

BooleanField

Set to true to reset the dimension prior to import

Import Option

DropdownField

If reset dimension is false, use this value as the import option. Default is Replace.

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

2

Error

General failure

Import Dimension from File

Imports a dimension into Oracle EDMCS from an uploaded CSV file

Inputs

Input

Type

Detail

Notes

File

FileField

File to import

Application Name

TextField

Name of the application that contains the relevant dimension

Dimension Name

TextField

Name of the dimension to which data will be imported

Reset Dimension

BooleanField

Set to true to reset the dimension prior to import

Import Option

DropdownField

If reset dimension is false, use this value as the import option. Default is Replace.

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

EDMCS Files

Array

EDMCS 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

Update Request Status

Updates the status of an Oracle EDMCS Request

Inputs

Input

Type

Detail

Notes

Request Title

TextField

Title of the request to be updated

Status

DropdownField

Status to which the request will be updated

Outputs

Output

Output Type

Notes

Updated Request JSON

Json

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

Chunk Size

NumberField

The file is uploaded in chunks, and you can tweak the chunk size here. The default is 50

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

Upload File to Staging

Uploads a file to the staging area.

Inputs

Input

Type

Detail

Notes

Upload File

FileField

File to be uploaded

File Name

TextField

File name to use for saving. If blank, will use same name as the file.

Outputs

Output

Output Type

Notes

Uploaded file size

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

Upload Request File

Uploads a file as an attachment to a request

Inputs

Input

Type

Detail

Notes

Request ID

TextField

ID of request to which the file will uploaded

Upload File

FileField

File to be uploaded

Outputs

Output

Output Type

Notes

Request File Upload URL

String

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

Invalid arguments

2

Error

General failure

Did this answer your question?