How to Configure an FTP Send Port

[Unless specifically noted, the content in this topic applies to BizTalk Server 2013 and 2013 R2.]

You can set FTP send port adapter variables in the BizTalk Server Administration console. If properties are not set for the send port, the default send handler values that are set in the BizTalk Server Administration console are used.

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

noteNote
The FTP adapter 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 variables for an FTP send port

  1. In the BizTalk Server Administration console, create a new send port or double-click an existing send port to modify it. For more information, see How to Create a Send Port. Configure all of the send port options, and in the Transport section of the General page, specify FTP for the Type option.

  2. On the General page, in the Transport section, click the Configure button next to Type.

  3. In the FTP Transport Properties dialog box, do the following:

     

    Use this To do this

    Address

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

    Mode

    Select 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

    Password

    Specify the password for the firewall.

    Port

    Specify the port for the firewall.

    Valid values: 1 through 65535 inclusively

    Default value: 21

    Type

    Select the type of firewall deployed.

    Valid values: Socks 4, Socks 5, None

    Default value: None

    User

    Specify the user name for the firewall.

    Account

    Optional. Specify the account name for the FTP server. This option is and use of this property is discouraged.

    After Put

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

    Allocate Storage

    Specify whether to allocate storage space for legacy host systems. This option is provided for backward compatibility.

    Valid values: No and Yes

    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.

    noteNote
    QUIT command is not supported before the file PUT.

    Folder

    Specify the location to move the files to on the FTP server.

    Log

    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.

    Password

    Specify the password to log on to the FTP server.

    Port

    Specify the port address for the FTP server.

    Default value: 21

    Representation

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

    Valid values: binary or ASCII

    Default value: binary

    Server

    Specify the server name or IP address of the FTP server.

    SSO Affiliate

    Specify the Enterprise Single Sign-On affiliate application.

    Target File Name

    Specify an alternative name for the file. Retaining the default name guarantees unique message names for each message sent.

    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.

    noteNote
    This property is applicable only if the Use SSL property is 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

    Connection Limit

    Specify the maximum number of concurrent FTP connections that can be opened to the server. A value of 0 means no limit.

    Default value: 0

    noteNote
    This property replaces the registry entry that was used in earlier versions of BizTalk Server to govern the connection limit. BizTalk Server ignores the registry entry used to control the connection limit.

    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.

    noteNote
    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.

  4. Click OK and OK again to save settings.

See Also

© 2014 Microsoft Corporation. All rights reserved.

Community Additions

Show: