How to Configure an SFTP Receive Location


Updated: March 15, 2016

This section provides information on how to configure an SFTP Receive Location using the BizTalk Server Administration Console.


Before completing the following procedure you must have already added a one-way receive port. For more information, see How to Create a Receive Port.

To configure an SFTP receive location

  1. In the BizTalk Server Administration console, expand BizTalk Server Administration, expand BizTalk Group, expand Applications, and then expand the application under you want to create a receive location.

  2. In the left pane, click the Receive Ports node and in the right pane, right-click the receive port with which you want to associate the new receive location, and then click Properties.

  3. In the left pane of the Receive Port Properties dialog box, select Receive Locations, and in the right pane click New to create a new receive location.

  4. In the Receive Location Properties dialog box, in the Transport section, select SFTP from the Type drop-down list, and then click Configure to configure the transport properties for the receive location.

  5. In the SFTP Transport Properties dialog box, in the General tab, do the following:

    Use this

    To do this


    Specify the maximum number of concurrent connections that can be opened to the server.

    This setting is per server and per receive location. Consider the following scenarios:

    • There are two receive locations that have the same configuration property values, including the ConnectionLimit property set to the same value. For example, the property is set to 6. In this situation, there is one connection pool (with 6 available connections) that is used by both receive locations.

    • There are two receive locations configured with same configuration values, and have the ConnectionLimit property set to different values. For example, ReceiveLocation1 property is set to 6 and ReceiveLocation2 property is set to 5. In this situation, each receive location has its own connection pool with its own available connections. ReceiveLocation1 connection pool has 6 available connections. ReceiveLocation2 connection pool has 5 available connections.



    Specify the intervals at which the adapter will poll the server. To poll continuously, set this value to zero.

    Default value: Zero


    Specifies the unit in which the polling interval is specified, for example, Seconds, Minutes, Hours, or Days.

    Default value: Seconds

    Proxy (applicable to BizTalk Server 2013 R2 only)


    Specifies either the DNS name or the IP address of the proxy server.


    Specifies the password for the proxy server.


    Specifies the port for the proxy server.


    Specifies the protocol used by the proxy server.


    Specifies the username for the proxy server.



    If set to True, the receive location accepts any SSH public host key from the server. If set to False, the receive location uses the fingerprint of the server for authentication. You specify the fingerprint in the SSHServerHostKeyFingerPrint property.

    Default value: False


    Specifies the authentication method that the receive location uses for authenticating the client to the SSH Server. If set to Password, you must specify the value in the Password property. If set to PublicKeyAuthentication, you must specify the private key of the user in the PrivateKey property. If set to MultiFactorAuthentication you must provide Username with its Password and PrivateKey. Additionally, if the private key is protected by a password, specify the password as well for the PrivateKeyPassword property.

    Default value: Password

    Encryption Cypher (applicable to BizTalk Server 2013 R2 only)

    Specify the kind of encryption cipher.


    Specify the SFTP user password if you set the ClientAuthenticationMode to Password.


    Specify the private key for the SFTP user if you set the ClientAuthenticationMode to PublicKeyAuthentication.


    The private key file must be the specified .ppk file.


    Specify a private key password, if required for the key specified in the PrivateKey property.


    Specifies the fingerprint of the public host key for the SSH server.


    Specifies a username to log on to the SFTP server.

    SSH Server


    Specifies the file mask to use when retrieving files from a secure FTP server.


    Specifies the folder path on the secure FTP server from where the receive location can retrieve files.


    Specifies the port address for the secure FTP server on which the file transfer takes place.


    Specifies the server name or IP address of the secure FTP server.

  6. Click OK.

  7. Enter the appropriate values in the Receive Location Properties dialog box to complete the configuration of the receive location and click OK to save settings. For information about the Receive Locations Properties dialog box, see How to Create a Receive Location.

Community Additions