Create an SFTP source connection in the UI

This tutorial provides steps to create an SFTP source connection using the Adobe Experience Platform UI.

Get started

This tutorial requires a working understanding of the following components of Platform:

IMPORTANT
It is recommended to avoid newlines or carriage returns when ingesting JSON objects with an SFTP source connection. To work around the limitation, use a single JSON object per line and use multi-lines for ensuing files.

If you already have a valid SFTP connection, you may skip the remainder of this document and proceed to the tutorial on configuring a dataflow.

Gather required credentials

Read the SFTP authentication guide for detailed steps on how to retrieve your authentication credentials.

Connect to your SFTP server

In the Platform UI, select Sources from the left navigation bar to access the Sources workspace. The Catalog screen displays a variety of sources with which you can create an account.

You can select the appropriate category from the catalog on the left-hand side of your screen. Alternatively, you can find the specific source you wish to work with using the search option.

Under the Cloud storage category, select SFTP and then select Add data.

The Experience Platform sources catalog with the SFTP source selected.

The Connect to SFTP page appears. On this page, you can either use new credentials or existing credentials.

Existing account

To connect an existing account, select the FTP or SFTP account you want to connect with, then select Next to proceed.

A list of existing SFTP accounts on the Experience Platform UI.

New account

TIP
  • Once created, you cannot change the authentication type of an SFTP base connection. To change the authentication type, you must create a new base connection.

  • SFTP supports an RSA or DSA type OpenSSH key. Ensure that your key file content starts with "-----BEGIN [RSA/DSA] PRIVATE KEY-----" and ends with "-----END [RSA/DSA] PRIVATE KEY-----". If the private key file is a PPK-format file, use the PuTTY tool to convert from PPK to OpenSSH format.

If you are creating a new account, select New account, and then provide a name and an optional description for your new SFTP account.

The new account screen for SFTP

The SFTP source supports both basic authentication and authentication via SSH public key.

Basic authentication

To use basic authentication, select Password and then provide the appropriate values for the following credentials:

  • host
  • port
  • username
  • password

During this step, you can also configure your max concurrent connections, define your folder path, and enable or disable chunking for your SFTP server. When finished, select Connect to source and allow for a few moments for the connection to establish.

For more information on authentication, read the guide on gathering required credentials for SFTP.

The new account screen for the SFTP source using basic authentication

SSH public key authentication

To use SSH public key-based credentials, select SSH public key and then provide the appropriate values for the following credentials:

  • host
  • port
  • username
  • private key content
  • passphrase

During this step, you can also configure your max concurrent connections, define your folder path, and enable or disable chunking for your SFTP server. When finished, select Connect to source and allow for a few moments for the connection to establish.

For more information on authentication, read the guide on gathering required credentials for SFTP.

The new account screen for the SFTP source using SSH public key.

Next steps

By following this tutorial, you have established a connection to your SFTP account. You can now continue on to the next tutorial and configure a dataflow to bring data from your cloud storage into Platform.

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089