To connect to Oracle® Enterprise Data Management Cloud Service (EDMCS) as part of a chain, add a step that includes an Oracle EDMCS connection command. For example:
- Import and export hierarchies
- Transform hiearchies to a balanced or generational format
- Automate the management of EDMCS
To enable these commands, an IT admin first creates an Oracle EDMCS connector.
Convert generational file to parent-child
To convert a generational data structure to a parent-child—also known as ragged—format, use a Convert generational file to parent-child command.
Properties
| Property |
Detail |
| Input file |
Enter the file to convert. |
| Delimiter |
Select the delimiter used in Input file. |
| Has header |
If Input file contains a header row, check this box. |
| Has aliases |
If Input file contains an alias to preserve after the parent or child value, such as columns of Parent,Alias or Child,Alias, check this box. |
Outputs
| Output |
Output type |
| Converted parent-child file |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |
Convert parent-child file
To convert a parent/child data structure into a ragged generational or balanced format, use a Convert parent-child file command.
Properties
| Property |
Detail |
| Input file |
Enter the file to convert. |
| Delimiter |
Select the delimiter used in Input File. |
| Hierarchy type |
Select the type of hierarchy to convert the file to. |
| Parent column name |
Enter the name of the column that contains the parent values. |
| Child column name |
Enter the name of the column that contains the child values. |
Outputs
| Output |
Output type |
| Hierarchy file |
File |
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 migrate. |
| 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 |
Create request
To creates a new Oracle EDMCS request, use a Create Request command.
Properties
| Property |
Detail |
| View name |
Enter the name of the view to create the request in. |
| Title |
Enter the request title. |
| Description |
Optionally, enter the request description. |
| Notes |
Optionally, enter the request notes. |
| Child column name |
Enter the name of the column that contains the child values. |
Outputs
| Output |
Output type |
| Request JSON |
JSON |
| Request ID |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |
Create request items from file
To add items in an upload file to an EDMCS request, use a Create Request Items From File command.
Properties
| Property |
Detail |
| Request title |
Enter the EDMCS request title. |
| Sheet names |
Enter the request sheet names. |
| File |
Enter the file to use to create the request items. |
Outputs
| Output |
Output type |
| Updated request JSON |
JSON |
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.
Properties
| Property |
Detail |
| File name |
Enter the name of the file to delete. If the file is not in the default upload location, include the path to its location. |
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 form an environment, use a Download file command.
Properties
| Property |
Detail |
| File name |
Enter the name of the file to download. If the file is not in the default upload location, include the path to its location. |
| Automatically unzip |
To automatically unzip the downloaded file for use as an output with a command later in the chain, check this box.
Note: If the ZIP file contains multiple files, it will remain zipped.
|
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 dimension mapping to connection
To export a dimension mapping into a comma-separated values (CSV) file, use an Export Dimension Mapping to Connection command.
Properties
| Property |
Detail |
| Application name |
Enter the name of the application that contains the dimension. |
| Dimension name |
Enter the name of the dimension to export. |
| Connection name |
Enter the name of the connection to export the dimension to. |
| File name |
Enter the target file name to export the dimension mapping to. |
| Mapping location |
Enter the mapping location to export. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |
Export dimension mapping to file
To export a dimension mapping into a CSV file, use an Export Dimension Mapping to File command.
Properties
| Property |
Detail |
| Application name |
Enter the name of the application that the dimension belongs to. |
| Dimension name |
Enter the name of the dimension to export. |
| File name |
Enter the target file name to export the dimension mapping to. |
| Mapping location |
Enter the mapping location to export. |
Outputs
| Output |
Output type |
| Export mapping file |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |
Export dimension to connection
To export a dimension in Oracle EDMCS to an existing connection, use an Export Dimension to Connection command.
Properties
| Property |
Detail |
| Application name |
Enter the name of the application that contains the dimension to export. |
| Dimension name |
Enter the name of the dimension to export. |
| Connection name |
Enter the name of the connection to export the dimension to. |
| File name |
Enter the target file name to export the dimension to. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |
Export dimension to file
To export a dimension in Oracle EDMCS to a downloadable CSV file, use an Export Dimension to File command.
Properties
| Property |
Detail |
| Application name |
Enter the name of the application that contains the dimension to export. |
| Dimension name |
Enter the name of the dimension to export. |
| File name |
Enter the target file name to export the dimension to. |
| Parent name |
To export only descendants of a parent member, enter the name of the parent. |
| Parent column name |
To export only descendants of a parent based on a column, enter the name of the column that contains the parent. |
Outputs
| Output |
Output type |
| Export dimension file |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |
Export snapshot
To repeat a previous 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 |
Extract dimension viewpoint
To extract a dimension viewpoint to a file or connection, use an Extract Dimension Viewpoint command.
Properties
| Property |
Detail |
| Application name |
Enter the name of the application that contains the dimension to extract. |
| Dimension name |
Enter the name of the dimension to extract. |
| File name |
Enter the name of the target file to extract the dimension to.
Note: If Connection name is blank, the command creates this file in your Oracle EDMCS instance and downloads it as an output.
|
| Extract name |
Enter the name of the extract. |
| Connection name |
To extract the dimension to a connection instead of a file, enter the connection's name. |
Outputs
| Output |
Output type |
| Dimension viewpoint export |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |
Get applications
To list the available Oracle EDMCS applications and retrieve their metadata, including dimensions, use a Get Applications command.
Properties
None
Outputs
| Output |
Output type |
| Applications list |
Array |
| Applications JSON file |
JSON |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |
Get connections
To list the available connections for an Oracle EDMCS application, use a Get Connections command.
Properties
| Property |
Detail |
| Application name |
Enter the name of the application that contains the connections to list. |
Outputs
| Output |
Output type |
| Connections list |
Array |
| Connections JSON file |
JSON |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |
Get dimension mappings
To list the available mappings for an Oracle EDMCS dimension, use a Get Dimension Mappings command.
Properties
| Property |
Detail |
| Application name |
Enter the name of the dimension's application. |
| Dimension name |
Enter the name of the dimension that contains the desired mappings. |
Outputs
| Output |
Output type |
| Dimension mappings JSON |
JSON |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |
Get request
To retrieve the metadata of an Oracle EDMCS request, use a Get Request command.
Properties
| Property |
Detail |
| Request title |
Enter the title of the desired request. |
Outputs
| Output |
Output type |
| Request JSON |
JSON |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |
Get requests
To list all requests the connector's integration user can access, use the Get Requests command.
Properties
None
Outputs
| Output |
Output type |
| Requests list |
Array |
| Requests JSON file |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |
Get views
To list all views the connector's integration user can access, use a Get Views command.
Properties
None
Outputs
| Output |
Output type |
| Views list |
Array |
| Views JSON file |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |
Import dimension by name
To import a dimension into Oracle EDMCS by its file name, use an Import dimension by name command.
Properties
| Property |
Detail |
| File name |
Enter the name of the file to import.
Note: The file imports from the Staging area or a connection.
|
| Application name |
Enter the name of the application that contains the dimension. |
| Dimension name |
Enter the name of the dimension to receive the import. |
| Import option |
Select whether to reset, replace, or merge the dimension upon import. |
| Connection name |
Enter the name of the connection to import the file from. To import from the Staging area, leave blank. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |
Import dimension from connection
To import a dimension into Oracle EDMCS from an existing connection, use an Import Dimension from Connection command.
Properties
| Property |
Detail |
| Application name |
Enter the name of the application that contains the dimension. |
| Connection name |
Enter the name of the connection to import the dimension from. |
| Dimension name |
Enter the name of the dimension to receive the import. |
| File name |
Enter the name of the file to import from at the given connection. |
| Reset dimension |
To reset the dimension prior to import, check this box. |
| Import option |
If Reset dimension is not checked, select whether to reset, replace, or merge the dimension upon import. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |
Import dimension from file
To import a dimension into Oracle EDMCS from an uploaded CSV or ZIP file, use an Import Dimension from File command.
Properties
| Property |
Detail |
| File |
Enter the file to import. |
| Application name |
Enter the name of the application that contains the dimension. |
| Dimension name |
Enter the name of the dimension to receive the import. |
| Reset dimension |
To reset the dimension prior to import, check this box. |
| Import option |
If Reset dimension is not checked, select whether to replace, merge, or reset the dimension upon 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 from the default upload location into the service environment, use an Import snapshot command.
Properties
| Property |
Detail |
| Snapshot name |
Enter the name of the snapshot to import. |
| New default password |
Enter the password to assign to new users created in the identity domain.
Note: The password must meet the minimum requirements for the identity domain.
|
| Reset password |
To require new users to change their password when they first sign in, 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 |
List files
To list the files at the default location, Data Management folders, and profitinbox/profitoutbox, use a List files command.
Note: This command does not list Migration snapshots.
Properties
| Property |
Detail |
| Filter |
Enter the criteria of the files to return. For example, use glob synax—such as *.csv—to return all files that match the pattern. |
Outputs
| Output |
Output type |
| EDMCS files |
Array |
| EDMCS 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 |
Update request status
To update the status of an Oracle EDMCS request, use an Update Request Status command.
Properties
| Property |
Detail |
| Request title |
Enter the title of the request to update. |
| Status |
Select the status to update the request to. |
| Transition with warning |
Enable this checkbox to bypass any custom validation failures with a WARNING severity and proceed to the next stage.
|
Outputs
| Output |
Output type |
| Updated request JSON |
JSON |
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 that contain:
- Data or metadata
- Rule or dimension definitions
- Mapped transactions
- Templates
- Backup snapshots
Properties
| Property |
Detail |
| Upload file |
Enter the file to upload. |
| Upload name |
Enter the name of the uploaded file. To keep the same name, leave blank. |
| File path |
Enter the path to where to upload the file. To use the default upload location, leave blank. |
| Overwrite |
To overwrite an existing file with the same name at the upload location, check this box. |
| Chunk size |
Enter the size of chunks used to upload the file. By default, 50. |
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 |
Upload file to staging
To upload a file to the Staging area, use an Upload file to staging command.
Properties
| Property |
Detail |
| Upload file |
Enter the file to upload. |
| File name |
Enter the name of the uploaded file. To keep the same name, leave blank. |
Outputs
| Output |
Output type |
| Uploaded file size |
Integer |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |
| 10 |
Warning |
Command completed with warnings |
Upload request file
To upload a file as an attachment to a request, use an Upload request file command.
Properties
| Property |
Detail |
| Request ID |
Enter the ID of the request to upload the file to. |
| Upload file |
Enter the file to upload. |
Outputs
| Output |
Output type |
| Request file upload URL |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
Invalid arguments |
| 2 |
Error |
General failure |