FTP or FTP/s or SFTP (inbound)
A traditional and open protocol, FTP is an acronym for File Transfer Protocol.
An FTP Transport is used to connect to an FTP server or service over the internet or local network.
To receive files from the remote FTP server or service, you configure the FTP Transport with the appropriate details to enable you to connect to the remote service, so that any files that match your requirements can be retrieved.
The Inbound Transport will always activate with a particular File Connection, and it is the properties of this File Connection that determine the filter for matching files.
The FTP Transport can be used to make FTP, FTP/S, and SFTP connections.
While SFTP has no relation to the FTP protocol technically, it is often confused with FTP and for simplicity sake we have combined the two protocols. For SFTP, select the button for SSH Settings.
Fields
Field Name | Description |
|---|---|
Description | A friendly name for the FTP Transport. This is the name that the Transport will be known as throughout the configuration. You should enter something meaningful to help you easily recognise the Transport. |
FTP Host | The domain name or IP address of the remote FTP server or service. |
FTP Port | The port that the remote FTP service is listening on. A default value will automatically display. |
User Name | A user name to access and connect to the remote FTP server or service. |
Password | A password for the above user. This will not be displayed on screen. |
File Directory | The directory on the FTP server that will be read from, and will be written into. |
Control Timeout | Time out period on the FTP control channel, in seconds. |
Transfer Timeout | Time out period on the FTP data channel, in seconds. A zero (0) means to wait forever. |
Secure the data channel when using SSL | This option is only available if SSL Settings are saved against this Transport. |
Use clear command channel after SSL authentication | This option is only available if SSL Settings are saved against this Transport. |
Use LIST command instead of NLST | Tick this box to use the LIST command instead of NLST. Some servers return errors when using NLST and no files match the filter. Select this option if you are getting errors when downloading and the server has no files. It should not error but simply cancel. |
Use Passive FTP | Uses passive FTP connection mode. This is recommended. Untick to use active connections. |
After download | Select your after download action from the drop-down list of available options. |
Method | Select either ASCII or BINARY mode for sending data. The default is BINARY which should be attempted as the first choice. |
Buttons
Button Name | Description |
|---|---|
Save | Click to Save any changes you have made. All changes will be lost if you do not click the Save button. |
Cancel | Click to Cancel any changes you have made. |
Delete | Click to Delete this particular Transport. You will be asked to confirm your choice. |
Test Transport | Click to test the connection to the remote FTP service. This is a live test. You need to select the File Connection that will be used to filter the files and receive any files into. This will cause the transport to run and download any files that exist on the remote FTP service. See below for further details. |
SSH Settings | Click to edit the SSH settings used when making the connection to the FTP Transport. Select this button for SFTP. For information regarding this button, please refer to SSH Settings. |
SSL Settings | Click to edit the SSL settings used when making the connection to the FTP Transport. Click this button for TLS. For information regarding this button, please refer to SSL Settings (Email Settings) . |
Test Transport
Once all details have been entered as required, click on this button to test the connection to the remote FTP server or service.
You need to select the File Connection that will be used to filter the files, and to provide detail of the directories to be used to receive any files into.
Test Transport is a live test and will cause the transport to run, downloading any files that exist on the remote FTP service.
A pop-up Test Transport window will appear - select the appropriate File Connection from the drop-down list.
Click Run to perform the test, and Cancel to quit without testing.