OFTP Adapter

The OFTP Adapter adds OFTP send and receive capabilities to your BizTalk Server.

Remarks

The OFTP, or Odette File Transfer Protocol, Adapter adds a complete OFTP client to your BizTalk Server that enables it with file download and upload capability.

OFTP Receive Adapter

The OFTP Receive Adapter requires certain server properties be set. You must set the OFTPServer property to the remote location of the desired OFTP server. You may also set an OFTPPort if the server is not set to the default protocol port. For client authorization, you must set the ClientSSIDCode, ClientSFIDCode, and ClientPassword properties. And, for server authentication, you must set the ServerSSIDCode, ServerSFIDCode, and ServerPassword properties.

The adapter will connect to the OFTP server every PollingInterval and download all files in the server's outgoing queue, and submit these to the BizTalk Message Engine as individual messages.

OFTP Send Adapter

The OFTP Send Adapter also requires certain server properties be set. You must set the OFTPServer property to the remote location of the desired OFTP server. You may also set an OFTPPort if the server is not set to the default protocol port. For client authorization, you must set the ClientSSIDCode, ClientSFIDCode, and ClientPassword properties. And, for server authentication, you must set the ServerSSIDCode, ServerSFIDCode, and ServerPassword properties.

The adapter will connect to the OFTP server whenever it has a message to send. The adapter will attempt to upload the file to the server. It uses the name specified by VirtualFileName when sending to the server. If this is not specified, the temporary filename will be used.

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.


Certificate	The private key certificate.
ClientPassword	The client's password.
ClientSFIDCode	Client's SFID code.
ClientSSIDCode	The client's SSID code.
ErrorThreshold	The maximum number of errors before the adapter shuts down.
Firewall	A set of properties related to firewall access.
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 adapter may consume.
OFTPPort	The port for the OFTP service (default is 3305).
OFTPServer	The domain name or IP address of the OFTP server.
Other	Defines a set of configuration settings to be used by the adapter.
PollingInterval	The amount of time, in seconds, between download attempts.
ReceivedFileDate	The date of the remote file received by the OFTP adapter.
ReceivedFileName	The name of the remote file received by the OFTP adapter.
ReceivedFileSize	The size of the remote file received by the OFTP adapter.
RecipientCert	The recipient certificate of the message.
RequeueEndpoints	Whether to requeue receive endpoints if the polling interval has not been reached.
RuntimeLicense	Specifies the adapter runtime license key.
SecureAuthentication	Whether or not the adapter should perform secure odette authentication.
ServerPassword	The server's password.
ServerSFIDCode	Server's SFID code.
ServerSSIDCode	The server's SSID code.
SSLAcceptServerCert	Instructs the adapter to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to use for client authentication during the SSL handshake.
TempPath	A temporary directory where data can be stored before the adapter processes it.
Timeout	A timeout for the adapter.
TransportLog	Tells the adapter where and how to report information about its operations.
URI	The Uniform Resource Identifier (URI) of the send port or receive location.
UseSSL	Use SSL to access the OFTPServer .
Version	Which version of the OFTP protocol the component is using.

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.


Certificate	The private key certificate.
ClientPassword	The client's password.
ClientSFIDCode	Client's SFID code.
ClientSSIDCode	The client's SSID code.
Compress	Whether or not to compress the outgoing file.
ConnectionLifetime	Instructs the adapter whether or not to leave the connection to the server open.
EncryptionAlgorithm	The encryption algorithm.
Firewall	A set of properties related to firewall access.
MaxPersistentConnections	The maximum number of simultaneous persistent connections when sending.
MaxRecordSize	The maximum length of a given record.
MaxThreads	The maximum number of threads that the adapter may consume.
MaxTransmissionBatchSize	The maximum number of messages that can be sent in a single batch.
OFTPPort	The port for the OFTP service (default is 3305).
OFTPServer	The domain name or IP address of the OFTP server.
Other	Defines a set of configuration settings to be used by the adapter.
RecipientCert	The recipient certificate of the message.
RuntimeLicense	Specifies the adapter runtime license key.
SecureAuthentication	Whether or not the adapter should perform secure odette authentication.
ServerPassword	The server's password.
ServerSFIDCode	Server's SFID code.
ServerSSIDCode	The server's SSID code.
SignedReceipt	Whether or not to require signed receipts.
SSLAcceptServerCert	Instructs the adapter to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to use for client authentication during the SSL handshake.
TempPath	A temporary directory where data can be stored before the adapter processes it.
Timeout	A timeout for the adapter.
TransmitBatchMode	How the transmitter processes batches.
TransportLog	Tells the adapter where and how to report information about its operations.
URI	The Uniform Resource Identifier (URI) of the send port or receive location.
UseSSL	Use SSL to access the OFTPServer .
Version	Which version of the OFTP protocol the component is using.
VirtualFileDate	The date/time stamp for the virtual file.
VirtualFileFormat	The structure of the outgoing file.
VirtualFileName	The virtual file name.
VirtualFileSecurityLevel	The level of security for the outgoing file.

Configuration Settings

The following is a list of configuration settings for the adapter with short descriptions. Click on the links for further details.


OverwriteTempFiles	Whether to overwrite files in the directory specified by TempPath.
ReceivedFileNameFormat	The name format of received files.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
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.
UseManagedSecurityAPI	Tells the adapter whether or not to use the system security libraries or a managed implementation.
PersistedConnectionTimeout	How long to leave a persisted connection alive.