FTP sender

FTP sender

The FTP sender sends a file to the given FTP server.

After writing the file, the original message is passed along to the next service/producer.

As you select sFTP as FTP Type, the following extra fields will be added to the form.

In the table below, you will find an explanation of these properties. All attributes with a ‘*’ are mandatory.

There are three FTP types, FTP, SFTP (FTP over SSH) and FTPS (FTP over SSL). The SFTP attributes can only be used for SFTP connections. The other attributes are used for all FTP types.




By default, we fill this out with the technical ‘tag’, followed by a serial number. Changing the name is optional.


Set this value to true, if you want this service to be enabled.

FTP Type

Specify which type of FTP you want to use. You can choose from FTP SFTP or FTPS. The default is FTP.

FTP Host*

FTP server hostname.

FTP Port

FTP server port. We use port 21 (FTP) or 22 (SFTP). The default is 21.

FTP User-Name*

FTP server username.

FTP Password

FTP server password.

FTP Mode

FTP server mode, either Active or Passive. Only available in FTP Mode!

FTP FileType

FTP server File-type, either ASCII, Binary or EBCDIC.

FTP Buffer-Size

FTP buffer size.

Remote Directory

Remote directory path on FTP server.

Remote Directory From Header

This header specifies remote directory path.

Remote File Separator

Specify file separator character. The default is “/” .

MessagePart In

Name of the MessagePart in a ConnectMessage where the content of the file is being stored.

MessagePart Out

Name of the MessagePart to which the content should be written.

File-Name Extension

Expand the file name with this extension. The default is ‘.xml’.

File Name From Header

Use the content of this header attribute as the file name. File-consumer and FTP-consumer will set the original file name in then header attribute file_name. The default header attribute for file_name is connectmessageID.


The indicated message part will be serialized to disk if possible. Combination of messagepart=ALL and serialize=true will serialize ConnectMessage to disk.


Select TRUE to automatically create remote directory on server.


Select true to use the temporary filename.

Strict Reply

Enable or disable Strict Reply Parsing. If true, it requires the 3 digit code be followed by space and some text. If false, only the 3 digit code is required.


When using sFTP

SFTP Private-Key

Specify location of SFTP private key file. Must be in URL form using the file: , http: or classpath: prefix.

SFTP Private-Key Pass-Phrase

Passphrase for SFTP private key file.

SFTP Server Alive Countmax

The amount of server alive messages, that can be sent without a reply, before being disconnected.

SFTP Server Alive Interval

This is the interval in milliseconds between two server alive messages.

SFTP Socket Time-Out

SFTP socket time-out. 0 means no time-out.

SFTP Key Exchange



Description of the specific service. This is for documentation purposes.


Advanced option 

Serialize will only appear when in Advanced mode.

Attribute Description
Serialize The indicated message part will be serialized to disk if possible. Combination of messagepart=ALL and serialize=true will serialize ConnectMessage to disk.


The (S)FTP(S) consumers use some form of authentication to connect to the server. By default a Username and Password need to be provided and are used in configuration to connect to a server. To connect to a server using Username and Password, please fill in the information in the Username and Password fields. For SFTP connections Private Key files are also supported. If you want to use a private key file to connect to a SFTP server, please specify this Private Key file and leave the Password field blank. This will connect to SFTP using the specified Private Key file. If both Private Key and Password fields are blank, this will result in an exception.

SFTP Private Keys

In order to user Private Keys for SFTP connections, please make sure you have a readable Base64 encoded Private Key file ready for use. You can upload your Private Key file to your Interface, by adding it to your Resources. From here you can drag and drop the Private Key file into the Private Key file configuration field. You can also configure a Private Key file manually from a filesystem. You can specify the location of the Private Key file by providing the URL to the required file using either file:[path/to/file] for local filesystems.

Overrideable Properties

When configuring a (s)FTP(s) Producer, Service or Command Gateway you may override certain properties at runtime by specifying certain headers. The properties you can override at runtime are:

  • Username by specifying ftp_username
  • Password by specifying ftp_password
  • Host by specifying ftp_host
  • Port by specifying ftp_port

When one or more of these properties are present in the ConnectMessage's Headers, the configured setting will be overridden at runtime.

FTPS with implicit encryption

As of version 3.5.0, if you choose implicit FTPS you can set the field Implicit TLS to true. This field will appear only if you choose FTPS. The other field is Session Reuse, this field tells you if you want to reuse the TLS session of this FTPS session.


Attribute Descrioption
Session Reuse This indicates the reuse of the TLS session when connecting over FTPS
Implicit TLS Enable implicit FTPS TLS

SSH Security information

Please see the page SSH Security Information

Memory usages and Java Heap Space errors

When requesting files from a server, keep track on the size of these files. When transfering filles you need approximately 10 times the amount of memory available to the ConnectAgent. If you do not have this amount of memory available, you will get a Java Heap Space Error.