How to Configure an FTP Send Handler


You can set FTP send handler properties in the BizTalk Server Administration console. You use these send handler properties as the send port configuration values if properties are not set on the individual FTP send port.


Each host can have only one send handler associated with it.


The FTP adapter available with the previous releases of BizTalk Server provides atomic file transfer only for binary mode. With BizTalk Server 2013 R2, the FTP adapter is enhanced to support atomic file transfer for ASCII mode also. For more information see Enhancements to the FTP Adapter.


The FTP adapter in BizTalk Server 2013 R2 supports reading and writing data from a secure FTP server. The adapter provides support for file transfer from an FTP server over Secure Sockets Layer (SSL)/Transport Level Security (TLS). For more information see Enhancements to the FTP Adapter.

To configure an FTP send handler

  1. Click Start, point to All Programs, point to Microsoft BizTalk Server 2013 R2, and then click BizTalk Server Administration.

  2. In the BizTalk Server Administration console, expand BizTalk Server Administration, expand BizTalk Group, expand Platform Settings, and then expand Adapters.

  3. In the expanded adapter list, select FTP, and then in the right pane, double-click the send handler.

  4. In the Adapter Handler Properties dialog box, in the Host name drop-down list, select the host with which the send handler will be associated, and then click Properties.

  5. In the FTP Transport Properties dialog box, do the following.

    Use this

    To do this

    Maximum Files

    Specify the maximum number of files per BizTalk Server batch.

    Valid values: 1 through 200 inclusive

    Default value: 50


    Specify the address of the firewall, either a DNS name or an IP address.


    Specify the mode in which the adapter connects to the FTP server.

    Valid values: Passive and Active

    In active mode, the FTP server connects to a port opened by the FTP adapter. In passive mode, the FTP adapter connects to a port opened by the FTP server.

    Default value: Active


    Specify the password for the firewall.


    Specify the port for the firewall.

    Valid values: 1 through 65535 inclusively

    Default values: 21


    Specify the type of firewall deployed.

    Valid values: Socks 4, Socks 5, None

    Default value: None


    Specify the user name for the firewall.


    Optional. Specify the account name for the FTP server.

    After Put

    Specify the FTP command to run after the file PUT. Separate commands with a semicolon (;).

    Allocate Storage

    Specify whether to allocates storage space for some legacy host systems.

    Valid values: Yes and No

    Default value: No

    Before Put

    Specify the FTP commands to run before the file PUT, such as commands to change default values on the FTP server. Separate commands with a semicolon (;). No open command is required.


    QUIT command is not supported before the file PUT.


    Specify the location to save a copy of a log file. Use this file to diagnose error conditions when sending or receiving files through FTP adapter.


    Specify the password to log on to the FTP server.


    Select how FTP adapter sends data, either as binary or as ASCII.

    Valid values: binary and ASCII

    Default value: binary

    Target File Name

    Specify the pattern for the destination file name.

    Default value: %MessageID%.xml

    User Name

    Specify the user name to log on to the FTP server.

    Client Certificate Hash

    Specify the SHA1 hash of the client certificate that must be used in the Secure Sockets Layer (SSL) negotiation.

    Based on this hash, the client certificate is picked up from the personal store of the user account under which the BizTalk host instance is running.

    FTPS Connection Mode

    Specify the mode of SSL connection made to the FTPS server.

    Valid values: Implicit or Explicit

    Default value: Explicit

    Use Data Protection

    Specify this as Yes if the adapter must use SSL encryption when it sends and receives data files from the FTPS server. Specify this as No for the adapter to send and receive data files as plaintext.


    This property is applicable only when the Use SSL property has been set to Yes.

    Valid values: Yes or No

    Default value: Yes

    Use SSL

    Specify whether the FTP adapter must use SSL to communicate with the FTPS server.

    Valid values: Yes or No

    Default value: No

    Temporary Folder

    Specify the location for a temporary folder on the FTP server. The file is first uploaded here and then moved to the destination FTP folder. In case of transfer failure, the adapter restarts the file upload in ASCII mode of transfer and resumes in binary mode of transfer.


    If the file transfer is atomic between the temporary location and the relevant location on the FTP server, then the file upload is also atomic.

  6. Click OK.

  7. Select the Make this the default handler check box to make this the default send handler.

  8. Click OK and then click OK again.

Community Additions