Skip to main content

Add an FTP, SFTP, or FTPS destination

Learn how to send data to FTP, SFTP, and FTPS servers from Productsup.

Introduction

Most exports in Productsup can send data to FTP, SFTP, and FTPS servers:

  • FTP (File Transfer Protocol) is a standard communication protocol for transferring and exchanging files between a server and a client. FTP often uses plain-text authentication via standard login data, such as username and password. If configured so, FTP can enable users to connect to servers anonymously.

  • SFTP (SSH File Transfer Protocol) is a data transfer protocol for exchanging data between a server and a client that uses a secure channel, such as SSH, and is accessible to authenticated users only.

  • FTPS (File Transfer Protocol Secure or File Transfer Protocol SSL) is an extension of the standard FTP that supports Transport Layer Security (TLS). When using FTPS, a client and a server establish a traditional FTP connection and then use port 21 to establish an additional SSL connection before authenticating users or transferring data.

  • FTPS Implicit is an older method of securing FTP connections that uses port 990 to establish an SSL connection between a server and a client before authenticating users or transferring data.

Most of the time, the requirements of your export channel system determine the needed server type.

Note

Our export destinations don't support the inclusion of basic auth within FTP, SFTP, or FTPS URLs, such as ftp://[user[:password]@]host[:port]/[url-path]. Instead, each destination contains individual fields for the URL Host, Directory, Username, and Password.

Prerequisites

Before setting up the needed destination in Productsup, you should:

  1. Decide whether you want to use an FTP, SFTP, or FTPS server. This influences the destination you should choose.

  2. Get the login credentials for your server:

    1. If your export channel requires using their server to upload data, get the host and user credentials from your export channel.

    2. If you can send data to your export channel using third-party FTP servers, you can use an FTP server hosted by Productsup. Go to FTP Accounts from your organization's main menu to create an FTP server and set up its credentials. See Create an FTP server hosted by Productsup.

      FTP Accounts

      Note

      The FTP Accounts feature is available to admin users only. You may need to contact your organization's admin to create a new FTP server or get the credentials of an existing one.

Set up the FTP Server destination

Tip

Choose the FTP Server destination if you created a Productsup-hosted server in FTP Accounts or if you need to send data to a third-party FTP server. A proxy option is available with this destination.

  1. Go to Exports from your site's main menu and select an export from the list to open the export setup page. If your site doesn't have the needed export yet, select ADD EXPORT to find and add an export.

  2. On the export setup page, select Add Destination, choose FTP Server from the drop-down list, give it a name, and then select Save.

    ftp_server_destination.png

  3. On the destination setup page, provide your server host in FTP Host.

    Tip

    If you want Productsup to connect to your FTP server using a proxy, make sure your FTP host starts with proxyftp://.

    ftp_server_setup.png

  4. Enter your server credentials in FTP User and FTP Password.

  5. If you want to send your data to a specific folder on your FTP server, provide the path to the desired folder in FTP Directory. By default, the platform sends your data to the root folder.

  6. Toggle the Passive Mode button to choose the desired type of FTP connection.

    If you turn this option On, the platform uses the passive FTP mode for data transfer letting the client connect to the server, which is more suitable for scenarios featuring a firewall. If you leave this option Off, the platform uses the active FTP mode letting the server connect to the client using port 20.

    Note

    For the command channel between the client and the FTP server, the platform uses port 21.

    See Active vs. Passive FTP Simplified for the differences between the two modes.

  7. If you want the platform to add an empty .fin file to your FTP server every time it successfully finishes uploading data to the server, toggle Write a .fin file after the upload finished successfully to On.

    To specify a different extension for this file, enter it in Fin Filename (default "fin"). The default full name of the file is {export-file-name-with-extension}.fin. If you provide a different extension in Fin Filename (default "fin"), the full name of the file will use the pattern {export-file-name-with-extension}.{provided-extension}.

    The platform automatically deletes the old .fin file when a new data upload starts.

  8. Toggle Active to On to activate the destination.

  9. Select Save.

  10. When your data is ready for export, select Run in the top-right corner of your page to let the platform import, process, and send your data to the destinations of all active exports in your site.

    If you want to run only the export where you added your FTP destination, you should:

    1. Select Import to let the site import and process your data.

    2. Go to Exports, select the needed export, and choose Export this export.

      Export this export button from the export setup page

  11. Once the site finishes the export, you can use a desktop app like Cyberduck or FileZilla to log into your FTP server and check the uploaded files. If everything is as expected, you can let your export channel system start an import from the FTP server.

    Tip

    If you used an FTP server hosted by Productsup, you need to copy your FTP server link and user credentials and paste them into the import settings of your export channel system. The server link is ftp://ftp.productsup.com/. You can find your user credentials in FTP Accounts.

Set up the SFTP Server destination

Tip

Choose the SFTP Server destination if you need to send data to a third-party SFTP server. A proxy option is available with this destination.

  1. Go to Exports from your site's main menu and select an export from the list to open the export setup page. If your site doesn't have the needed export yet, select ADD EXPORT to find and add an export.

  2. On the export setup page, select Add Destination, choose SFTP Server from the drop-down list, give it a name, and then select Save.

    sftp_server_destination.png

  3. On the destination setup page, provide your SFTP server host in Host.

    sftp_server_setup.png

  4. Enter your SFTP server credentials in Username and Password.

  5. In Port, enter the number of the port that the platform should use to establish a connection with your SFTP server. By default, the platform uses port 22.

  6. If you want to send your data to a specific folder on your SFTP server, provide the path to the desired folder in Directory. By default, the platform sends your data to the root folder.

  7. If you want the platform to add an empty .fin file to your SFTP server every time it successfully finishes uploading data to the server, toggle Write a .fin file after the upload finished successfully to On.

    To specify a different name and extension for this file, enter them in Fin file name and Fin file extension (default "fin"). The default full name of the file is {export-file-name-with-extension}.fin. If you provide a different name and extension, the full name of the file will use the pattern {provided-name}.{provided-extension}.

    The platform automatically deletes the old .fin file when a new data upload starts.

  8. Toggle Proxy to On if you want the platform to use a proxy to connect to your SFTP server.

    See Enable Download Proxy for a list of IPs you need to whitelist so that Productsup can send data to the server via a proxy.

  9. Toggle Active to On to activate the destination.

  10. Select Save.

  11. When your data is ready for export, select Run in the top-right corner of your page to let the platform import, process, and send your data to the destinations of all active exports in your site.

    If you want to run only the export where you added your SFTP destination, you should:

    1. Select Import to let the site import and process your data.

    2. Go to Exports, select the needed export, and choose Export this export.

      Export this export button from the export setup page

  12. Once the site finishes the export, you can use a desktop app like Cyberduck or FileZilla to log into your SFTP server and check the uploaded files. If everything is as expected, you can let your export channel system start an import from the SFTP server.

Set up the destination SFTP/FTP/FTPS Server (with optional proxy)

Tip

Choose the destination SFTP/FTP/FTPS Server (with optional proxy) if you need to send data to an FTPS server or if you want to provide more advanced settings for your server connection than possible via the FTP Server and SFTP Server destinations. A proxy option is available with this destination.

  1. Go to Exports from your site's main menu and select an export from the list to open the export setup page. If your site doesn't have the needed export yet, select ADD EXPORT to find and add an export.

  2. On the export setup page, select Add Destination, choose SFTP/FTP/FTPS Server (with optional proxy) from the drop-down list, give it a name, and then select Save.

    SFTP_FTP_FTPS_Server_destination.png

  3. On the destination setup page, select the needed server protocol in Protocol. The available options are:

    • FTP

    • FTPS

    • SFTP

    • FTPS Implicit

  4. Provide your server host in Host. Leave out prefixes, such as ftp://, sftp://, or ftps://.

  5. In Port, enter the number of the port that the platform should use to establish a connection with your server. If you leave this blank, the platform uses the default port of the chosen protocol. For example, port 22 for SFTP connections and port 21 for FTP connections.

  6. Enter your server credentials in Username and Password. Or provide your base64-encoded private SSH key in SSH Key must be (PEM format, RSA, ECDSA, or Ed25519, blank passphrase) instead of the password.

  7. If you want to send your data to a specific folder on your server, provide the path to the desired folder in Directory. By default, the platform sends your data to the root folder.

  8. Toggle the Passive Mode button to choose the desired type of server connection.

    If you turn this option On, the platform uses the passive mode for data transfer letting the client connect to the server, which is more suitable for scenarios featuring a firewall. If you leave this option Off, the platform uses the active mode letting the server connect to the client.

  9. Define the platform's behavior in case of server failure or inactivity.

    In Timeout, enter the number of seconds the platform should wait before considering a request failed due to server inactivity. By default, the platform waits for 300 seconds.

    In Max Retries on Failure, enter the number of new attempts the platform should automatically make in case of request failure. By default, the platform retries sending data 3 times.

  10. If you want the platform to add an empty .fin file to your server every time it successfully finishes uploading data to the server, provide the desired name and extension for this file in Fin File Name and Fin File Extension. If you don't want the platform to create such a file on your server, leave Fin File Name empty.

    If you provide a desired name and extension for the .fin file, the full name of the file will use the pattern {provided-name}.{provided-extension}.

    The platform automatically deletes the old .fin file when a new data upload starts.

    Note

    The default input in Fin File Name is {{ file_name }}. The default input in Fin File Extension is fin. This makes the default full name of the file {export-file-name-without-extension}.fin.

    If you enter {{ base_file_name }} in Fin File Name and keep fin as the extension, the full name of the file will be {export-file-name-with-extension}.fin.

  11. Toggle Proxy to On if you want the platform to use a proxy to connect to your server.

    See Enable Download Proxy for a list of IPs you need to whitelist so that Productsup can send data to the server via a proxy.

  12. Toggle Enable ssh dss/rsa host key algorithms to On if your SFTP server uses the deprecated SSH-RSA or SSH-DSS host key algorithms. Use this option only if our support team suggests it.

  13. Toggle Active to On to activate the destination.

  14. Select Save.

  15. When your data is ready for export, select Run in the top-right corner of your page to let the platform import, process, and send your data to the destinations of all active exports in your site.

    If you want to run only the export where you added your destination, you should:

    1. Select Import to let the site import and process your data.

    2. Go to Exports, select the needed export, and choose Export this export.

      Export this export button from the export setup page

  16. Once the site finishes the export, you can use a desktop app like Cyberduck or FileZilla to log into your server and check the uploaded files. If everything is as expected, you can let your export channel system start an import from the server.

In this section: