/n software Adapters for BizTalk
/n software Adapters for BizTalk
Questions / Feedback?

FTP Adapter

Properties   Configuration Settings  

The FTP Adapter 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 that enables it with plaintext or SSL-secured file download and upload capability.

FTP Receive Adapter

The FTP Receive Adapter requires that a single property 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

The FTP Send Adapter requires both an 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.

AccountThe user Account for login.
AfterConnectA set of FTP commands to be executed immediately after connecting to the FTPServer .
AfterGetA set of FTP commands to be executed after the GET.
BeforeGetA set of FTP commands to be executed before the GET.
DeleteModeControls if and when the remote file is deleted after download.
ErrorThresholdThe maximum number of errors before the adapter shuts down.
FileMaskIndicates the type of files to download from the FTP server.
FirewallA set of properties related to firewall access.
FTPPortThe port for the FTP service (default is 21).
FTPServerThe domain name or IP address of the FTP server.
MaxBatchSizeThe maximum size, in MB, of the current batch (0 indicates no limit).
MaxFileCountThe maximum number of files in the current batch (0 indicates no limit).
MaxFileSizeThe maximum size, in MB, of a file in the current batch (0 indicates no limit).
MaxThreadsThe maximum number of threads that the adapter may consume.
OtherDefines a set of configuration settings to be used by the adapter.
PassiveControls whether to direct the server into passive mode. Recommended if behind a firewall.
PasswordThe password for login.
PersistentConnectionInstructs the adapter whether to keep the connection to the server open.
PollingIntervalThe amount of time, in seconds, between download attempts.
ReceivedFileDateThe date of the remote file received by the FTP adapter.
ReceivedFileNameThe name of the remote file received by the FTP adapter.
ReceivedFilePathThe remote path of the file received by the FTP adapter.
ReceivedFileSizeThe size of the remote file received by the FTP adapter.
ReceivedFileUserThe user name used by the FTP adapter when downloading the remote file.
RemotePathThe current path in the FTP server.
RequeueEndpointsWhether to requeue receive endpoints if the polling interval has not been reached.
SSLAcceptServerCertInstructs the adapter to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
SSLStartModeDetermines how the adapter starts the SSL negotiation.
SSOAffiliateSpecifies the name of the SSO Affiliate Application..
TempPathA temporary local directory where data can be stored before the adapter processes it.
TimeoutA timeout for the adapter.
TransferModeThe transfer mode (ASCII or Binary). If the value is 0 (default), the initial server mode will be used.
TransportLogTells the adapter where and how to report information about its operations.
URIThe Uniform Resource Identifier (URI) of the send port or receive location.
UserThe user id for login.
UseSimpleDirListInstructs the adapter 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.

AccountThe user Account for login.
AfterConnectA set of FTP commands to be executed immediately after connecting to the FTPServer .
AfterPutA set of FTP commands to be executed after the PUT.
AppendWhether or not the adapter should append data to the RemoteFile .
BeforePutA set of FTP commands to be executed before the PUT.
ConnectionLifetimeInstructs the adapter whether or not to leave the connection to the server open.
FirewallA set of properties related to firewall access.
FTPPortThe port for the FTP service (default is 21).
FTPServerThe domain name or IP address of the FTP server.
MaxPersistentConnectionsThe maximum number of simultaneous persistent connections when sending.
MaxThreadsThe maximum number of threads that the adapter may consume.
MaxTransmissionBatchSizeThe maximum number of messages that can be sent in a single batch.
OtherDefines a set of configuration settings to be used by the adapter.
OverwriteWhether or not the adapter should overwrite files during transfer.
PassiveControls whether to direct the server into passive mode. Recommended if behind a firewall.
PasswordThe password for login.
RemoteFileThe name of the destination file on the FTP server for uploading.
RemotePathThe current path in the FTP server.
RemoteTempPathA temporary directory on the server to store files before moving them to RemotePath .
SSLAcceptServerCertInstructs the adapter to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
SSLStartModeDetermines how the adapter starts the SSL negotiation.
SSOAffiliateSpecifies the name of the SSO Affiliate Application..
TimeoutA timeout for the adapter.
TransferModeThe transfer mode (ASCII or Binary). If the value is 0 (default), the initial server mode will be used.
TransmitBatchModeHow the transmitter processes batches.
TransportLogTells the adapter where and how to report information about its operations.
URIThe Uniform Resource Identifier (URI) of the send port or receive location.
UserThe user id for login.
UseSimpleDirListInstructs the adapter 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.

AutoSelectDataIPAutomatically select the data connection IP.
DirEntryPatternAllows the use of regular expressions to parse non-standard directory entry formats.
DeleteOnSuspendSpecifies whether files may be deleted from server when message is suspended.
DownloadCacheFileWhen set, only new files will be downloaded from the server.
DownloadCacheFileDurationThe number of minutes that a file name will remain in the download cache.
EnableFileDetailsComparisonWhether the receive adapter should consider metadata differences when deciding whether to download a file again.
IgnoreEmptyFilesInstructs the adapter to ignore empty files when downloading.
MonitorFileGrowthSpecifies whether the adapter checks for file growth before downloading.
CheckFileExistsWhether to check if the remote file exists before uploading.
LocalFileSpecifies the local file to upload or download.
PortRangeAllows the specification of a port range the adapter listens to.
RenameToA filename to which RemoteFile will be renamed.
RenameModeThe condition under which RenameTo is used.
TemporaryDownloadExtensionAn extension to be appended during download.
TemporaryUploadExtensionAn extension to be appended during upload.
ReuseSSLSessionInDIWhether the SSL session will be reused for the DI connection.
ReusePISSLSessionInDIWhether the PI SSL session will be reused for the DI connection.
UseClearCommandChannelAllows for the Clear Command Channel (CCC) command.
UseClearDataChannelAllows for the PROT C command.
UseFSwitchSpecifies whether or not the -F parameter is used when listing directory contents.
UseMLSDUses listings for machine processing.
UseProtWhenImplicitSends PROT P to the server.
UseRemoteHostAddressForPassiveInstructs the adapter to use the FTPServer in passive mode.
UseModeZAllows compression to be used when transferring data.
ModeZCompressionLevelUsed to specify the level of compression used.
DownloadSingleFileIf set to true, the send adapter will download a file instead of upload.
DownloadIf set to true, the send adapter will download files instead of upload.
DeleteAfterDownloadIf set to true, deletes the file after download.
ListDirectoryIf set to true, the send adapter will list the directory instead of upload.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLSecurityFlagsFlags that control certificate verification.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLSNamedGroupsThe supported (EC)DHE groups.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelayWhether or not to delay when sending packets.
UseInternalSecurityAPITells the adapter whether or not to use the system security libraries or an internal implementation.
PersistedConnectionTimeoutHow long to leave a persisted connection alive.

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
/n software Adapters for BizTalk - Version 16.0 [Build 6659]