SFTP Receiver

How to Configure a SFTP Receive Location with the BizTalk Server Administration Console

To configure the receive location by using the BizTalk Server Administration console, use the following procedure:

NOTE: 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 receive location variables for a SFTP receive location:

1. In the BizTalk Server Administration console, expand BizTalk Server Administration, expand BizTalk Group, expand Applications, and then expand the application you want to create a receive location in.
2. In the left pane, click the Receive Port node. Then in the right pane, right-click the receive port that is associated with an existing receive location or that you want to associate with a 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 double-click an existing receive location or click New to create a new receive location.
4. In the Receive Location Properties dialog box, in the Transport section next to Type, select nsoftware.SFTP v4 from the drop-down list, and then click Configure to configure the transport properties for the receive location.
5. In the nsoftware.SFTP v4 Transport Properties dialog box, you will find the following properties:

   AfterConnect	A set of FTP-style commands to be executed immediately after connecting to the SSHHost . Type: xs:string    Default Value: ""
   AfterGet	A set of FTP-style commands to be executed after the download. Type: xs:string    Default Value: ""
   BeforeGet	A set of FTP-style commands to be executed before the download. Type: xs:string    Default Value: ""
   DeleteMode	Controls if and when the remote file is deleted after download. Type: xs:int    Default Value: 0
   ErrorThreshold	The maximum number of errors before the adapter shuts down. Type: xs:int    Default Value: 5
   FileMask	Indicates the type of files to download from the SSH server. Type: xs:string    Default Value: "*.*"
   Firewall	A set of properties related to firewall access. Type: Firewall    Default Value: null
   MaxBatchSize	The maximum size, in MB, of the current batch (0 indicates no limit). Type: xs:int    Default Value: 0
   MaxFileCount	The maximum number of files in the current batch (0 indicates no limit). Type: xs:int    Default Value: 10
   MaxFileSize	The maximum size, in MB, of a file in the current batch (0 indicates no limit). Type: xs:int    Default Value: 0
   MaxThreads	The maximum number of threads that the adapter may consume. Type: xs:int    Default Value: 20
   Other	Defines a set of configuration settings to be used by the adapter. Type: xs:string    Default Value: ""
   PersistentConnection	Instructs the adapter whether to keep the connection to the server open. Type: bool    Default Value: false
   PollingInterval	The amount of time, in seconds, between download attempts. Type: xs:int    Default Value: 60
   ReceivedFileDate	The date of the remote file received by the SFTP adapter. Type: xs:string    Default Value: ""
   ReceivedFileName	The name of the remote file received by the SFTP adapter. Type: xs:string    Default Value: ""
   ReceivedFilePath	The remote path of the file received by the SFTP adapter. Type: xs:string    Default Value: ""
   ReceivedFileSize	The size of the remote file received by the SFTP adapter. Type: xs:int    Default Value: 0
   ReceivedFileSSHUser	The SSH user name used by the SFTP adapter when downloading the remote file. Type: xs:string    Default Value: ""
   RemotePath	The current path on the SSH server. Type: xs:string    Default Value: ""
   RequeueEndpoints	Whether to requeue receive endpoints if the polling interval has not been reached. Type: bool    Default Value: false
   RuntimeLicense	Specifies the adapter runtime license key. Type: xs:string    Default Value: ""
   SSHAcceptServerHostKey	Instructs the adapter to accept the server host key that matches the supplied key. Type: Certificate    Default Value: null
   SSHAuthMode	The type of authentication used by the adapter. Type: xs:int    Default Value: 2
   SSHCert	The certificate to use for client authentication during the SSH handshake. Type: Certificate    Default Value: null NOTE: The digital id must have a private key associated with it.
   SSHCompressionAlgorithms	A comma-separated list of compression algorithms allowed for this connection. Type: xs:string    Default Value: "none"
   SSHHost	The address of the SSH host. Type: xs:string    Default Value: "" NOTE: This property must have a value.
   SSHPassword	The password for SSH password-based authentication. Type: baf:Password    Default Value: ""
   SSHPort	The port on the SSH server where the SSH service is running; by default, 22. Type: xs:int    Default Value: 22
   SSHUser	The username for SSH authentication. Type: xs:string    Default Value: ""
   SSOAffiliate	Specifies the name of the SSO Affiliate Application.. Type: baf:SSOList    Default Value: ""
   TempPath	A temporary local directory where data can be stored before the adapter processes it. Type: xs:string    Default Value: ""
   Timeout	A timeout for the adapter. Type: xs:int    Default Value: 60
   TransportLog	Tells the adapter where and how to report information about its operations. Type: Log    Default Value: null
   URI	The Uniform Resource Identifier (URI) of the send port or receive location. Type: xs:string    Default Value: ""

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.