Using FTP Adapters with Ensemble
Settings for the FTP Outbound Adapter
[Home] [Back] 
InterSystems: The power behind what matters   
Class Reference   
Search:    

Provides reference information for settings of the FTP outbound adapter, EnsLib.FTP.OutboundAdapter.
Summary
The outbound FTP adapter has the following settings:
Group Settings
Basic Settings FTP Server, FTP Port, Credentials, File Path
SFTP Settings SFTP Append Client Mode, SFTPPublicKeyFile, SFTPPrivateKeyFile
Connection Settings SSL Configuration, UsePASV, Stay Connected, Connect Timeout
Additional Settings Overwrite, Charset
The remaining settings are common to all business operations. For information, see Settings for All Business Operations in Configuring Ensemble Productions.
Charset
Specifies the desired character set for the output file. Ensemble automatically translates the characters to this character encoding. See Charset in Settings for the FTP Inbound Adapter.”
Connect Timeout
Number of seconds to wait on each attempt to connect to the FTP server. The default is 5 seconds.
Credentials
Identifies an Ensemble credentials entry that can authorize a connection to the FTP server. See Credentials in Settings for the FTP Inbound Adapter.”
File Path
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 provided.
FTP Port
Identifies the TCP port on the FTP server to connect to. The default value is 21.
FTP Server
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.
Overwrite
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.
SFTP Append Client Mode
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 and Overwrite 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.
Note:
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.
SFTPPrivateKeyFile
File path to a file containing the SSH private key certificate.
SFTPPublicKeyFile
File path to a file containing the SSH public key certificate.
SSL Config
Either the name of an existing client SSL/TLS configuration to use to authenticate this connection or !SFTP to use an SFTP server. If you specify the name of an existing SSL/TLS configuration, choose a client rather than a server SSL/TLS configuration, because the adapter initiates the communication. See SSL Config in Settings for the FTP Inbound Adapter.”
Stay Connected
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.
UsePASV
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.