Data Export - File Location (FTP / SFTP)

Overview
Setting Data Export to save the generated file to either an FTP or SFTP location

What is FTP / SFTP

FTP stands for "File Transfer Protocol". It is an Internet service specially designed to establish a connection to a particular Internet server (or computer), so that users are able to transfer files (download) to their computer or to transfer (upload) their own files to the server (computer). The FTP protocol also includes commands that can be used to execute operations on a remote computer; e.g., to show folder contents, change directories, create folders or delete files

SFTP stands for "Secure File Transfer Protocol". The Secure File Transfer Protocol ensures that data is securely transferred using a private and safe data stream. It is the standard data transmission protocol for use with the SSH2 protocol. WISE-FTP implements a reliable and user-friendly version of the client side of this protocol.

The SFTP protocol's main purpose is to transfer data, but it is also used to obtain general access to the FTP server's file system. The SFTP protocol runs on a secure channel - no clear text passwords or file data are transferred

  FTP settings configuration

  • Method
    • This will be set to FTP as the selected method for File Location
  • Server
    • The address for the location of the FTP server, eg: ftp://myserver.com
  • Port
    • The FTP protocol is handled using ports 20 and 21 by default.
  • User name
    • The username that is required when logging into the the FTP server, this will be provided by the server administrator
  • Password
    • The password to be used in conjunction with the username, this will be provided by the server administrator
  • File path
    • The directory structure on the FTP server in which the required file is to be located. Leading and trailing '/' characters are not required. This box will be populated automatically if the search box for file location / selection is used
  • File name
    • The name (including file extension) of the import file
    • The search box (Magnifying glass) can be used to browse your FTP server and select the file
    • File names can be made dynamic, such as adding the time the export ran to the file name, by using tags when the file name is specified. More information can be found here
  • Use SSL
    • A toggle switch OFF/ON to set an encrypted connection between your web server and Linnworks allowing for private information to be transmitted
    • The default state is OFF
    • Your FTP server administrator will inform you if this is required
  • Passive
    • A toggle switch OFF/ON to set the data transfer mode to either Passive or Active. Which one is required depends on how the client and server firewalls are set up.
    • The default state is ON
    • Your FTP server administrator will inform you if this is required
  • File address
    • This is auto-populated based on the Account / File path / File name settings
  • If file exists
    • Overwrite - Any data in the original file will be lost and overwritten with a new file
    • Append - The data in original file (if it exists) will be maintained and new data will be added to the end of the existing file
      • Please note that not all FTP servers will support appending to a file. If this is the case, a warning will be displayed when the credentials are tested. If this is the case, please use Overwrite instead

  SFTP settings configuration

The SFTP settings are mostly the same as the FTP settings detailed above, this section of the guide will only cover the modified / additional fields required by SFTP

  • Server
    • The address for the location of the SFTP server, eg: sftp://myserver.com
  • Port
    • The FTP protocol is handled using port 22 by default
  • Compression
    • A toggle switch OFF/ON to enable file compression. With this option enabled, data sent to from Linnworks is compressed before sending, and decompressed when received by the server. This can help to speed up file transfers, especially with low-bandwidth connections
    • The default state is OFF