FTP Adapter Property Schema and Properties


The following table contains the properties in the FTP adapter property schema.

Namespace: http://schemas.microsoft.com/BizTalk/2003/ftp-properties

RepresentationTypexs:stringSpecifies how the FTP adapter sends data.

 Valid values: binary or ASCII
SSOAffiliateApplicationxs:stringSpecifies the Enterprise Single Sign-On affiliate application to use on the FTP send port.
UserNamexs:stringSpecifies the user name to log on to the FTP server when sending messages.
Passwordxs:stringSpecifies the password to use when logging on to the FTP server when sending messages.
BeforePutxs:stringSpecifies 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.
AfterPutxs:stringSpecifies the FTP commands to run after the file PUT. Separate commands with a semicolon (;).
ReceivedFileNamexs:stringSpecifies the full name of the file from which the FTP adapter reads the message.
MaxConnectionsxs:unsignedIntSpecifies the maximum number of concurrent FTP connections that can be opened to the server. A value of 0 means no limit.
CommandLogFileNamexs:stringSpecifies the location to save a copy of a log file that can be used to diagnose error conditions when sending or receiving files through FTP.
AllocateStoragexs:booleanThis option is deprecated in BizTalk Server and use of this property is discouraged.
PassiveModexs:booleanSpecifies the mode in which the adapter connects to the FTP server.

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.

If PassiveMode is false then the adapter connects to the FTP server using Active mode. The default value for this property is false.
SpoolingFolderxs:stringSpecifies the location for a temporary folder on the FTP server. You use this to ensure recovery from a transfer failure.
UseSslxs:booleanSpecifies whether the FTP adapter must use SSL to communicate with the FTPS server.
UseDataProtectionxs:booleanSpecifies whether SSL encryption is used for file transfers. Choose true if the adapter must use SSL encryption when it sends and receives data files from the FTPS server. Choose false for the adapter to send and receive data files as plaintext.
FtpsConnectionModexs:stringSpecifies the mode of SSL connection made to the FTPS server.

 Valid Values: Implicit or Explicit
ClientCertificateHashxs:stringSpecifies 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.

Configuring the FTP Adapter

Best practices and recommendations for the FTP Adapter

FTP Adapter

Community Additions