Using FTP Adapters in Productions
Settings for the FTP Outbound Adapter
Provides reference information for settings of the FTP outbound adapter, EnsLib.FTP.OutboundAdapter.
The outbound FTP adapter has the following settings:
||FTP Server, FTP Port, Credentials, File Path
||SFTP Append Client Mode, SFTPPublicKeyFile, SFTPPrivateKeyFile
||Protocol, SSL Configuration, SSL Check Server IdentityUsePASV, Stay Connected, Connect Timeout
Number of seconds to wait on each attempt to connect to the FTP server. The default is 5 seconds.
Full pathname of the directory on the FTP server in which to write files. This directory must exist, and it must be accessible using the Credentials
Identifies the TCP port on the FTP server to connect to. The default value is 21.
Identifies the FTP server to connect to. This can be the IP address or server name, as long as the domain host controller can resolve the name.
True or False. If True, and the output file exists, overwrite it. If False, and the output file exists, append to it. The default is True.
Indicates whether to use FTP (File Transfer Protocol) or SFTP (SSH File Transfer Protocol). If the protocol is FTP, it is possible to use the SSL Configuration
setting to configure FTP over SSL. If the protocol is SFTP, then:
setting should ordinarily be set to 22.
If you supply values for the SFTPPublicKeyFile
settings, the adapter attempts key pair authentication. It does this in conjunction with the username and password supplied via the Credentials
setting, using the password in the Credentials
as the passphrase for the private key. If you do not use the KeyFile
settings, the adapter attempts only username/password authentication based on the Credentials
In most cases, if this setting is blank, then FTP is used. However, if the value of the SSL Configuration
setting is !SFTP
, SFTP is used irrespective of the Protocol
Controls whether to use the SFTP server append (Server mode) or to emulate an append on the client (Client mode). Some SFTP servers do not support append access. If you are using a server that does not support append, select Client mode
and the FTP outbound adapter reads the file from the SFTP server, appends the data to the file and then sends the file back to the SFTP server overwriting the existing file. This setting is only meaningful if SSL Configuration
is set to !SFTP
is set to false.
A consequence of emulating an append is that if another process modifies the same file on the SFTP server between the time that the adapter reads the file and the time that it writes the file with the appended data, the updates from the other process are lost.
If you are unsure whether the SFTP server supports append access you can use a server append test that is accessible through a link on the SFTP Append Client Mode
popup help text.
File path to a file containing the SSH private key certificate.
File path to a file containing the SSH public key certificate.
You can use the Protocol
setting to use SFTP.
When connecting to an FTP server via SSL/TLS, the server name in the certificate must match the DNS name used to connect to the server. This match is based on the rules in section 3.1 of RFC 2818.
If a positive value, the adapter stays connected to the remote system for this number of seconds after completing an operation. A zero value means to disconnect immediately after every operation. The default of -1 means to stay permanently connected, even during idle times. Adapters are assumed idle at startup and therefore only auto-connect if they are configured with a value of -1.
Use Passive FTP mode: server returns a data port address and the client connects to it. Most firewalls are more tolerant of Passive mode FTP because both the control and data TCP connections are initiated by the client.