SFTP Transmitter

Setting the SFTP Adapter Configuration Properties for a Dynamic Send Port

A dynamic send port does not provide any transport configuration options in BizTalk Explorer because it is expected that these properties will be provided with the context properties associated with the message. These properties can be set in a custom pipeline or in an orchestration. To set message configuration properties in an orchestration you can do the following:

• Add a Construct Message shape to your orchestration.
• Configure the Construct Message shape to construct a new message. (for example Message_2)
• Add a Message Assignment shape to the Construct Message shape.
• Add code to the Message Assignment shape to initialize the message that you constructed and to set the appropriate configuration properties for the message.

Configuring the SFTP Send Port with the BizTalk Server Administration Console

To configure the send port by using the BizTalk Server Administration console, use the following procedure:

To configure variables for a SFTP 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 specify nsoftware.SFTP v4 for the Type option in the Transport section of the General tab.
2. On the General tab, in the Transport section, click the Configure button next to Type.
3. In the nsoftware.SFTP v4 Transport Properties dialog box, use the following properties to:

   
   

   AfterConnect	A set of FTP-style commands to be executed immediately after connecting to the SSHHost . Type: xs:string    Default Value: ""
   AfterPut	A set of FTP-style commands to be executed after the upload. Type: xs:string    Default Value: ""
   Append	Whether or not the adapter should append data to the RemoteFile . Type: bool    Default Value: false
   BeforePut	A set of FTP-style commands to be executed before the upload. Type: xs:string    Default Value: ""
   ConnectionLifetime	Instructs the adapter whether or not to leave the connection to the server open. Type: xs:int    Default Value: 0
   Firewall	A set of properties related to firewall access. Type: Firewall    Default Value: null
   MaxPersistentConnections	The maximum number of simultaneous persistent connections when sending. Type: xs:int    Default Value: 1
   MaxThreads	The maximum number of threads that the adapter may consume. Type: xs:int    Default Value: 20
   MaxTransmissionBatchSize	The maximum number of messages that can be sent in a single batch. Type: xs:int    Default Value: 1
   Other	Defines a set of configuration settings to be used by the adapter. Type: xs:string    Default Value: ""
   Overwrite	Whether or not the adapter should overwrite files during transfer. Type: bool    Default Value: false
   RemoteFile	The name of the destination file on the SSH server for uploading. Type: xs:string    Default Value: "%SourceFileName%" NOTE: This property must be specified.
   RemotePath	The current path on the SSH server. Type: xs:string    Default Value: ""
   RemoteTempPath	A temporary directory on the server to store files before moving them to RemotePath . Type: xs:string    Default Value: ""
   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 be specified.
   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: ""
   Timeout	A timeout for the adapter. Type: xs:int    Default Value: 60
   TransmitBatchMode	How the transmitter processes batches. Type: xs:int    Default Value: 0
   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: ""

4. Click OK and OK again to save settings.