Configuring SFTP Connections

Prerequisites for Configuring SFTP Connections

SFTP Configuration enables you to configure and manage your own Secure File Transfer Protocol (SFTP) connections used for exports and report delivery. SFTP connections can be configured as global (all properties) or property-specific.

Note:

The SFTP URL must be added to the allow-list prior to being configured. Contact Oracle Customer Support at the following URL https://support.oracle.com.

Adding SFTP Configuration

1. From the side menu select Toolbox, select System Setup, and then SFTP Configuration.

2. Click New and complete the following:

   1. Context: Select a value from the list.

      1. Select Global to define a chain-level SFTP configuration available to all properties.

      2. Select Property to define a property-specific SFTP configuration.

   2. SFTP Code: Enter Unique SFTP Code you want to create, preferably with the following recommended format,

      1. When creating at Chain Level use CHAIN CODE+SFTP CODE.

      2. When creating at Property Level use PROP CODE+SFTP CODE.

   3. Description: Enter a description.

   4. Hostname: Enter the SFTP Server Hostname.

   5. Port Number: Enter the Port Number.

   6. Auth Type: Select a value from the list.

   7. Password: Enter to connect to SFTP using basic authentication details like user account and password details.

   8. Key: Enter to connect to SFTP using open authorization details like, OAuth Token URL and credential details. 

   9. Username: Enter the username.

   10. Private Key: Enter the private key.

   11. Public Key: Enter the public key.

   12. Folder Name: Enter the logical name for the specified folder path.

   13. Folder Path: Enter the folder path. 

3. Click Save.

Editing SFTP Configuration

1. From the side menu select Toolbox , select System Setup , and then SFTP Configuration.

2. Enter search criteria and click Search.

3. Select the SFTP in search result, click the vertical ellipsis Actions menu and select Edit.

   1. Update configuration.

   2. Inactive: Select the check box to set the SFTP connection inactive. Deselect the check box to activate.

4. Click Save.

Deleting SFTP Configuration

1. From the side menu select Toolbox, select System Setup, and then SFTP Configuration.

2. Enter search criteria and click Search.

3. Select the SFTP in search result, click vertical ellipsis Actions menu and select Delete.

4. Click Delete to confirm.

Validating SFTP Connectivity

1. From the side menu select Toolbox, select System Setup, and then SFTP Configuration.

2. Enter search criteria and click Search.

3. Select the SFTP Code in search results, click the vertical ellipsis Actions menu and select Validate.