FTP upload

Table of Contents

    FTP Upload

    This producer writes content from the input ConnectMessage to a remote file on a FTP server.

    In the table below, you will find an explanation about 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.


    Check this box if you want this producer to be enabled.

    FTP Type

    Here, you can choose the type of FTP communication. You can choose from FTP SFTP or FTPS. By default this is set to FTP.

    FTP Host*

    Here, you can define the FTP server’s URL

    FTP Port

    In this property, you can define the FTP’s port number. By default, depending your FTP type, we use port 21 (FTP) or 22 (SFTP).

    FTP Username*

    Here, you put the username on the FTP server.

    FTP Password

    Here, you can define the password, corresponding with the username.

    FTP Mode

    Indicate here whether the FTP has to be in active or passive mode. You can choose between Active (0) or Passive (2). By default this is set to Active.

    FTP FileType

    Here, you can decide the type of file. You can choose between ASCII (0), EBCDIC (1) or Binary (2). By default ASCII is used.

    FTP Buffer-Size

    Here you can define the FTP buffersize. The default value is 10000.

    Remote Directory

    With this property, you can define the path to the remote directory, right after logging in. By default, the root will be used, which is defined at the FTP server.

    Remote Directory From Header

    Here, you can give the name of the MessageProperty, where a reference to the remote directory is located. With this you can dynamically specify this location.

    You can specify this property through a Header-Enricher.

    Remote File Separator

    In this property, you can specify the kind of separator that will be used to display the paths. By default, “/” will be used.


    This is the name of the MessagePart from the ConnectMessage, which content is written to the file. If ALL-XML is entered here, all MessageParts are written to the file. By default, the name “msgprt0” will be used.

    File-Name Extension

    Here, you can define the files’ extension. By default ‘.xml’ is used

    File-Name From Header

    Name of the header property in the ConnectMessage which is used to generate the filename. If you enter file_name, the original file  name is used. By default a unique ID is used.

    Auto-Create Remote Directory

    Automatically create the given directory on the FTP server if it does not exist yet. This can for instance happen when the FTP server is set so the location needs to exist before writing. By default this functionality is turned off (‘false’).

    Use Temporary File-Name

    Use a temporary filename for uploading the files to an FTP server.

    By default this option is set to ‘false’.

    Session Reuse


    This indicates the reusing of TLS session when connecting to FTPS. Defaults to true. Only available when using FTPS.

    SFTP Private-Key

    This is a reference to the file with the private key.

    SFTP Private-Key Pass-Phrase

    This is the password corresponding to private key.

    SFTP Server Alive Countmax

    Here, you can define 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

    Here, you can define a socket timeout. The default value is ‘0’, which means there’s no timeout.

    SFTP Key Exchange

    SFTP Key Exchange configuration for SSH Client. When a specific set of cipher keys is required you can override it here. You may also use the system-wide property -D sftpKexConfiguration=''

    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.




    Copyright © 2019 ConnectPlaza.   For pricing, account management and more go to https://www.connectplaza.com

    About Connectplaza

    Si components version:   

    Lorem ipsum delore set

    Lorem ipsum delore set

    Window size is not optimal. Please enlarge for optimal experience

    No connection

    No response from the server. This window will automaticly disappear by an valid connection