FTP Adapter
Properties Configuration Settings
The FTP Component adds SSL-enabled FTP send and receive capabilities to your BizTalk Server.
Remarks
The FTP Adapter adds a complete FTP client to your BizTalk Server and enables it with plaintext or SSL-secured file download and upload capability.
FTP Receive Adapter
A single property must be set: FTPServer. You may also set an FTPPort if the server is not set to the default protocol port. If your FTP server requires authentication, you should set the User, Password and/or Account properties. If you wish to enable SSL, you can turn it on by setting an appropriate SSLCert and SSLStartMode as well as supplying an SSLAcceptServerCert.
The adapter will connect to the FTP server every PollingInterval and list the directory specified by RemotePath. All files that match the FileMask will be downloaded and submitted to the BizTalk Message Engine as individual messages. In order to guarantee that files are not downloaded multiple times, you may set the DeleteMode. If you wish to do any other PRE- or POST-GET operation, you can specify them as scripts through the BeforeGet and AfterGet properties, respectively.
FTP Send Adapter
Two properties must be set: FTPServer and a RemoteFile. If your server does not operate on the default FTP port, you will need to specify the correct port via FTPPort. For servers that do not allow anonymous uploads, you may also need to set User, Password, and/or Account. To enable SSL, you should select a client SSLCert and a SSLAcceptServerCert as well as an SSLStartMode.
The adapter will connect to the FTP server whenever it has a message to send. The adapter will attempt to upload to the specified RemotePath. In order to prevent parallel processing by another application before your upload is complete, you may need to set a temporary extension via TemporaryUploadExtension. If Overwrite is set to True, the adapter will delete or overwrite remote files as necessary to complete the operation.
If you wish to do any other PRE- or POST-PUT operation, you can specify them as scripts through the BeforePut and AfterPut properties, respectively.
Please refer to the section on adapter configuration for a description of how to configure receive locations and send ports for this adapter.
Receiver Property List
The following is the full list of the properties of the receiver adapter with short descriptions. Click on the links for further details.
| AfterConnect | A set of FTP commands to be executed immediately after connecting to the FTPServer . |
| AfterGet | A set of FTP commands to be executed after the GET. |
| BeforeGet | A set of FTP commands to be executed before the GET. |
| DeleteMode | Controls if and when the remote file is deleted after download. |
| ErrorThreshold | The maximum number of errors before the component shuts down. |
| FileMask | Indicates the type of files to download from the FTP server. |
| Firewall | A set of properties related to firewall access. |
| FTPPort | The port for the FTP service (default is 21). |
| FTPServer | The domain name or IP address of the FTP server. |
| MaxBatchSize | The maximum size, in MB, of the current batch (0 indicates no limit). |
| MaxFileCount | The maximum number of files in the current batch (0 indicates no limit). |
| MaxFileSize | The maximum size, in MB, of a file in the current batch (0 indicates no limit). |
| MaxThreads | The maximum number of threads that the component may consume. |
| Other | Defines a set of configuration settings to be used by the component. |
| Passive | Controls whether to direct the server into passive mode. Recommended if behind a firewall. |
| Password | The password for login. |
| PersistentConnection | Instructs the component whether to keep the connection to the server open. |
| PollingInterval | The amount of time, in seconds, between download attempts. |
| ReceivedFileDate | The date of the remote file received by the FTP component. |
| ReceivedFileName | The name of the remote file received by the FTP component. |
| ReceivedFilePath | The remote path of the file received by the FTP component. |
| ReceivedFileSize | The size of the remote file received by the FTP component. |
| ReceivedFileUser | The user name used by the FTP component when downloading the remote file. |
| RemotePath | The current path in the FTP server. |
| RequeueEndpoints | Whether to requeue receive endpoints if the polling interval has not been reached. |
| RuntimeLicense | Specifies the component runtime license key. |
| SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLCert | The certificate to use for client authentication during the SSL handshake. |
| SSLStartMode | Determines how the component starts the SSL negotiation. |
| SSOAffiliate | Specifies the name of the SSO Affiliate Application. |
| TempPath | A temporary local directory where data can be stored before the component processes it. |
| Timeout | A timeout for the component. |
| TransferMode | The transfer mode (ASCII or Binary). If the value is 0 (default), the initial server mode will be used. |
| TransportLog | Tells the component where and how to report information about its operations. |
| URI | The Uniform Resource Identifier (URI) of the send port or receive location. |
| User | The user id for login. |
| UseSimpleDirList | Instructs the component to issue the NLST command instead of LIST. |
Sender Property List
The following is the full list of the properties of the sender adapter with short descriptions. Click on the links for further details.
| AfterConnect | A set of FTP commands to be executed immediately after connecting to the FTPServer . |
| AfterPut | A set of FTP commands to be executed after the PUT. |
| Append | Whether or not the component should append data to the RemoteFile . |
| BeforePut | A set of FTP commands to be executed before the PUT. |
| ConnectionLifetime | Instructs the component whether or not to leave the connection to the server open. |
| Firewall | A set of properties related to firewall access. |
| FTPPort | The port for the FTP service (default is 21). |
| FTPServer | The domain name or IP address of the FTP server. |
| MaxPersistentConnections | The maximum number of simultaneous persistent connections when sending. |
| MaxThreads | The maximum number of threads that the component may consume. |
| MaxTransmissionBatchSize | The maximum number of messages that can be sent in a single batch. |
| Other | Defines a set of configuration settings to be used by the component. |
| Overwrite | Whether or not the component should overwrite files during transfer. |
| Passive | Controls whether to direct the server into passive mode. Recommended if behind a firewall. |
| Password | The password for login. |
| RemoteFile | The name of the destination file on the FTP server for uploading. |
| RemotePath | The current path in the FTP server. |
| RemoteTempPath | A temporary directory on the server to store files before moving them to RemotePath . |
| RuntimeLicense | Specifies the component runtime license key. |
| SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLCert | The certificate to use for client authentication during the SSL handshake. |
| SSLStartMode | Determines how the component starts the SSL negotiation. |
| SSOAffiliate | Specifies the name of the SSO Affiliate Application. |
| Timeout | A timeout for the component. |
| TransferMode | The transfer mode (ASCII or Binary). If the value is 0 (default), the initial server mode will be used. |
| TransmitBatchMode | How the transmitter processes batches. |
| TransportLog | Tells the component where and how to report information about its operations. |
| URI | The Uniform Resource Identifier (URI) of the send port or receive location. |
| User | The user id for login. |
| UseSimpleDirList | Instructs the component to issue the NLST command instead of LIST. |
Configuration Settings
The following is a list of configuration settings for the adapter with short descriptions. Click on the links for further details.
| Account | The user account to login with. |
| AutoSelectDataIP | Automatically select the data connection IP. |
| CheckFileExists | Whether to check if the remote file exists before uploading. |
| DeleteAfterDownload | If set to true, deletes the file after download. |
| DeleteOnSuspend | Specifies whether files may be deleted from server when message is suspended. |
| DeleteOnUploadError | Whether to delete the remote file when an error occurs after upload begins. |
| DirEntryPattern | Allows the use of regular expressions to parse non-standard directory entry formats. |
| Download | If set to true, the send component will download files instead of upload. |
| DownloadCacheFile | When set, only new files will be downloaded from the server. |
| DownloadCacheFileDuration | The number of minutes that a file name will remain in the download cache. |
| DownloadSingleFile | If set to true, the send component will download a file instead of upload. |
| EnableFileDetailsComparison | Whether the receive component should consider metadata differences when deciding whether to download a file again. |
| ExcludeMask | Instructs the component to exclude some files when downloading. |
| IgnoreEmptyFiles | Instructs the component to ignore empty files when downloading. |
| ListDirectory | If set to true, the send component will list the directory instead of upload. |
| LocalFile | Specifies the local file to upload or download. |
| MaxFilesPerPollingInterval | The maximum number of files that will be downloaded from the server during a single poll. |
| ModeZCompressionLevel | Used to specify the level of compression used. |
| MonitorFileGrowth | Specifies whether the adapter checks for file growth before downloading. |
| PortRange | Allows the specification of a port range the component listens to. |
| RenameMode | The condition under which RenameTo is used. |
| RenameTo | A filename to which RemoteFile will be renamed. |
| ReusePISSLSessionInDI | Whether the PI SSL session will be reused for the DI connection. |
| ReuseSSLSessionInDI | Whether the SSL session will be reused for the DI connection. |
| TemporaryDownloadExtension | An extension to be appended during download. |
| TemporaryUploadExtension | An extension to be appended during upload. |
| UseClearCommandChannel | Allows for the Clear Command Channel (CCC) command. |
| UseClearDataChannel | Allows for the PROT C command. |
| UseEPSV | Allows extended passive mode. |
| UseFSwitch | Specifies whether or not the -F parameter is used when listing directory contents. |
| UseMLSD | Uses listings for machine processing. |
| UseModeZ | Allows compression to be used when transferring data. |
| UseProtWhenImplicit | Sends PROT P to the server. |
| UseRemoteHostAddressForPassive | Instructs the component to use the FTPServer in passive mode. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| SSLSecurityFlags | Flags that control certificate verification. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
| TLS12SupportedGroups | The supported groups for ECC. |
| TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
| TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
| TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |