FTP Adapter Configuration Properties

 

The following table lists the configuration properties that you can set for an FTP adapter receive location:

Property nameTypeDescriptionRestrictionsComments
uriVT_BSTRSpecify the full path of the location monitored by the receive location.The URI for a send port or receive location cannot exceed 256 characters.None
serverAddressVT_BSTRSpecify the server name or IP address of the FTP server.NoneNone
serverPortVT_BSTRSpecify the TCP port over which to communicate with the target FTP server.NoneNone
userNameVT_BSTRSpecify the user name that is used to access the FTP server.NoneNone
passwordVT_BSTRSpecify the password that is used to access the FTP server.This value is always masked when exporting a binding file. This property must be manually populated with the password before importing the binding file into the target BizTalk Server configuration.None
fileMaskVT_BSTRSpecify the file mask filter to use when transmitting files.NoneNone
targetFolderVT_BSTRSpecify the polling location on the FTP server.NoneNone
commandLogFilenameVT_BSTRSpecify the location to save a copy of the log file.NoneYou use this file to diagnose error conditions when sending or receiving files through the FTP adapter.
representationTypeVT_BSTRSelect how FTP adapter receives the data.Valid values are:

- Binary
- ASCII
The default value is Binary.
spoolingFolderVT_BSTRSpecify the location for a temporary folder on the FTP server. You use this to guarantee recovery from a transfer failure.NoneNone
receiveDataTimeOutVT_BSTRSpecify the time in milliseconds before the receive call will abort. This is used to prevent a slow server from causing the receive location to hang.NoneThe default value is 90000.
maximumBatchSizeVT_BSTRSpecify the maximum number of bytes per BizTalk Server batch.NoneNone
maximumNumberOfFilesVT_BSTRSpecify the maximum number of files per BizTalk Server batch.NoneNone
passiveModeVT_BSTRSpecify the mode in which the adapter connects to the FTP server.Valid values are:

- Passive
- Active
The default value is Active.
useNLSTVT_BSTRSpecify this as Yes to retrieve only file names instead of the default system-defined file listing.Valid values are:

- Yes
- No
The default value is No.
beforeGetVT_BSTRSpecify the FTP commands to execute before the file GET.Separate commands with a semicolon (;) Note: QUIT command is not supported before the file GET.None
afterGetVT_BSTRSpecify the FTP commands to execute after the file GET.Separate commands with a semicolon (;)None
firewallTypeVT_BSTRSpecify the type of firewall deployed.Valid values are:

- None
- Socks 4
- Socks 5
The default value is None.
firewallAddressVT_BSTRSpecify the address of the firewall (DNS name or IP address).NoneNone
firewallPortVT_BSTRSpecify the port for the firewall.Valid values are from 1 to 65535.The default value is 21.
firewallUserNameVT_BSTRSpecify the user name for the firewall.NoneNone
firewallPasswordVT_BSTRSpecify the password for the firewall.NoneNone
pollingUnitOfMeasureVT_BSTRSpecify the type of units for the pollingInterval property.Valid values are:

- Seconds
- Minutes
- Hours
- Days
The default value is Seconds.
pollingIntervalVT_BSTRSpecify the interval value for polling this location.NoneTo continuously poll, set this value to 0.

The default value is 60.
redownloadIntervalVT_BSTRSpecify the interval in seconds after which FTP adapter will download the file again.This property is applicable only if both deleteAfterDownload and enableTimeComparison properties are set to No.A value of -1 indicates that the adapter will not download the file again.

The default value is -1.
ssoAffiliateApplicationVT_BSTRSpecify the Single-Sign-On (SSO) affiliate application.NoneNone
errorThresholdVT_BSTRSpecify the number of errors that BizTalk Server can encounter before the location is disabled.NoneThe default value is 10.
maxFileSizeVT_BSTRSpecify the maximum downloadable file size, in megabytes.NoneA value of 0 indicates no limit on the file size.

The default value is 100.
useSslVT_BSTRSpecify this as Yes if the FTP adapter must use SSL when communicating with the FTPS server.Valid values are:

- Yes
- No
The default value is No.
useDataProtectionVT_BSTRSpecify this as Yes if the FTP adapter must use SSL encryption when sending and receiving files to and from the FTPS server.This property is valid if the useSsl property is set to Yes.

Valid values are:

- Yes
- No
The default value is Yes.
ftpsConnModeVT_BSTRSpecify the mode of SSL connection made to the FTPS server.Valid values are:

- Explicit
- Implicit
The default value is Explicit.
clientCertificateHashVT_BSTRSpecify the SHA1 hash of the client certificate that must be used in the SSL negotiation.NoneBased 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.
deleteAfterDownloadVT_BSTRSpecify this as Yes if the adapter must delete the file from the FTP server after the download is complete.Valid values are:

- Yes
- No
The default value is Yes.
enableTimeComparisonVT_BSTRSpecify this as Yes if the adapter must download a file again when there is a change in the file’s timestamp.This property is valid only when deleteAfterDownload is set to No.

The target FTP server must support MDTM command for this feature.

Valid values are:

- Yes
- No
The default value is No.

The following code shows the format of the string you use to set the properties:

<CustomProps><AdapterConfig vt="8"><Config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><uri>ftp://localhost:21/in/*.xml</uri><serverAddress>localhost</serverAddress><serverPort>21</serverPort><userName>domain\testuser</userName><password>******</password><fileMask>*.xml</fileMask><targetFolder>in</targetFolder><commandLogFilename>c:\temp\realftplog.txt</commandLogFilename><representationType>binary</representationType><maximumBatchSize>0</maximumBatchSize><maximumNumberOfFiles>0</maximumNumberOfFiles><passiveMode>False</passiveMode><firewallType>NoFirewall</firewallType><firewallPort>21</firewallPort><pollingUnitOfMeasure>Seconds</pollingUnitOfMeasure><pollingInterval>5</pollingInterval><errorThreshold>10</errorThreshold><maxFileSize>5000</maxFileSize><useSsl>False</useSsl><useDataProtection>True</useDataProtection><ftpsConnMode>Explicit</ftpsConnMode><clientCertificateHash>‎bc 32 2c a9 22 75 6a 3f e4 f7 a9 b1 b3 3a 24 20 23 53 68 49</clientCertificateHash><deleteAfterDownload>True</deleteAfterDownload><enableTimeComparison>False</enableTimeComparison></Config></AdapterConfig></CustomProps>  

The following table lists the configuration properties that you can set for an FTP adapter send port:

Property nameTypeDescriptionRestrictionsComments
uriVT_BSTRSpecify the full path of the location to send data to.The URI for a send port or receive location cannot exceed 256 characters.None
serverAddressVT_BSTRSpecify the address of the firewall, either a DNS name or an IP address.NoneNone
serverPortVT_BSTRSpecify the port address for the FTP server.NoneThe default value is 21.
userNameVT_BSTRSpecify the user name to log on to the FTP server.NoneNone
passwordVT_BSTRSpecify the password to log on to the FTP server.This value is always masked when exporting a binding file. This property must be manually populated with the password before importing the binding file into the target BizTalk Server configuration.None
accountNameVT_BSTRSpecify the account name for the FTP server.OptionalNone
targetFolderVT_BSTRSpecify the location to move the files to on the FTP server.NoneNone
targetFileNameVT_BSTRSpecify an alternative name for the file. Retaining the default name will guarantee unique message names for each message sent.NoneThe default value is %MessageID%.xml.
commandLogFilenameVT_BSTRSpecify the location to save a copy of the log file. Use the log file to diagnose error conditions when sending or receiving files through FTP server.NoneNone
representationTypeVT_BSTRSelect how FTP sends the data, either as binary or as ASCII.Valid values are:

- binary
- ASCII
The default value is binary.
beforePutVT_BSTRSpecify 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 (;). Note: QUIT command is not supported before the file PUT.No open command is required.
afterPutVT_BSTRSpecify the FTP commands to run after the file PUT.Separate commands with a semicolon (;).None
allocateStorageVT_BSTRSpecify whether to allocate storage space for legacy host systems.Valid values are:

- Yes
- No
The default value is No.
spoolingFolderVT_BSTRSpecify the location for a temporary folder on the FTP server. You use this to guarantee recovery from a transfer failure if the transfer mode is binary. If the transfer mode is ASCII, the adapter restarts the upload.NoneNone
connectionLimitVT_BSTRSpecify the maximum number of concurrent FTP connections that can be opened to the server.NoneA value of 0 means no limit.
passiveModeVT_BSTRSpecify whether to use passive mode or active mode.Valid values are:

- True (passive mode)
- False (active mode)
The default value is False (active mode).
firewallTypeVT_BSTRSelect the type of firewall deployed.Valid values are:

- Socks 4
- Socks 5
- None
The default value is None.
firewallAddressVT_BSTRSpecify the address of the firewall, either a DNS name or an IP address.NoneNone
firewallPortVT_BSTRSpecify the port for the firewall.Valid values are from 1 to 65535.The default value is 21.
firewallUserNameVT_BSTRSpecify the user name for the firewall.NoneNone
firewallPasswordVT_BSTRSpecify the password for the firewall.This value is always masked when exporting a binding file. This property must be manually populated with the password before importing the binding file into the target BizTalk Server configuration.None
ssoAffiliateApplicationVT_BSTRSpecify the Single-Sign-On (SSO) affiliate application.NoneNone
useSslVT_BSTRSpecify this as Yes if the FTP adapter must use SSL when communicating with the FTPS server.Valid values are:

- Yes
- No
The default value is No.
useDataProtectionVT_BSTRSpecify this as Yes if the FTP adapter must use SSL encryption when sending and receiving files to and from the FTPS server.This property is valid if useSsL is set to Yes.

Valid values are:

- Yes
- No
The default value is Yes.
ftpsConnModeVT_BSTRSpecify the mode of SSL connection made to the FTPS server.Valid values are:

- Explicit
- Implicit
The default value is Explicit.
clientCertificateHashVT_BSTRSpecify the SHA1 hash of the client certificate that must be used in the SSL negotiation.NoneBased 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.

The following code shows the format of the string you use to set the properties:

<CustomProps><AdapterConfig vt="8"><Config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><serverAddress>TestServer</serverAddress><serverPort>21</serverPort><userName>testuser</userName><password>******</password><accountName>testuser</accountName><targetFolder>output</targetFolder><targetFileName>%MessageID%.xml</targetFileName><commandLogFilename>c:\logfile\ftpsendlog.txt</commandLogFilename><representationType>binary</representationType><beforePut>CDW dir</beforePut><afterPut>CDUP </afterPut><allocateStorage>False</allocateStorage><spoolingFolder>tempfolder</spoolingFolder><connectionLimit>0</connectionLimit><passiveMode>False</passiveMode><firewallType>Socks4</firewallType><firewallAddress>TestServer</firewallAddress><firewallPort>21</firewallPort><firewallUserName>domain\testuser</firewallUserName><firewallPassword>******</firewallPassword><useSsl>False</useSsl><useDataProtection>True</useDataProtection><ftpsConnMode>Explicit</ftpsConnMode><clientCertificateHash>‎bc 32 2c a9 22 75 6a 3f e4 f7 a9 b1 b3 3a 24 20 23 53 68 49</clientCertificateHash><uri>ftp://TestServer:21/output/%MessageID%.xml</uri></Config></AdapterConfig></CustomProps>  

System_CAPS_ICON_note.jpg Note

When specifying TransportTypeData configuration data for an adapter built using the Adapter Framework, all the name/value pairs that are used must be stored into the <AdapterConfig> element. Since the <AdapterConfig> element specifies the VT_BSTR (vt="8") data type then the < > characters in the data must be escaped.

Community Additions

ADD
Show: