Configure the SFTP Connection

How to configure the internal SFTP connection for file-based integrations.

The Secure Shell (SSH) File Transfer Protocol (SFTP) network protocol provides file access, file transfer, and file management. It is used to transfer management information over a VPN. The protocol assumes that the channel is secure and reliable, the server authenticated the client, and the protocol can identify the client.

Data is exchanged with other systems over an SFTP connection that acts as the file server.

Caution: For file-based integrations, make sure that SFTP and an SFTP folder are configured. Examples: Use WinSCP™ or Filezilla™.
Note: To configure and test connections, you must log in with a system administrator account.

Configure the internal account of the SFTP connection as follows:

Note: This topic describes how to configure an internal SFTP connection. To configure connection to an external SFTP account, see Transfer Files by External SFTP.
  1. Select Main Menu > Administration > Application Setup > Integrations Setup > Connections.
  2. Create, edit, or remove a connection:
    • Click Tap Create . Enter the Connection Name. Recommended: SFTP Server
    • Select a connection. Click Tap Edit .

      In Save Changes to, select one of the following:

      Save changes everywhere that the named entity is used. Entity: {ConnectionName}— Make the changes to all SFTP connections that have the same name.

      Save as a new named entity— Make a new SFTP connection.

    • Select a connection. Click Tap Delete . Click Tap Yes to confirm.
  3. Enter the internal Host. Example: sftp-{connectionname}.int.xfn.myukg.com
  4. Enter the Port for the internal SFTP account.
  5. In User, enter the username for the internal account.
  6. Enter the Password for the internal account.
  7. Click Tap Save.
  8. Test the connection
    1. Select the connection to the SFTP server.
    2. Click Tap Test .
    3. Wait for the status message.