OFTP Adapter
Properties Configuration Settings
The OFTP Component 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.
If you want to use secure authentication with encryption to and from the server, set SecureAuthentication to True, set the Certificate property to a certificate containing your private key, and set the RecipientCert property to the server's public certificate.
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.
If you want to use secure authentication with encryption to and from the server, set SecureAuthentication to True, set the Certificate property to a certificate containing your private key, and set the RecipientCert property to the server's public certificate.
The adapter will connect to the OFTP server whenever it has a message to send and 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 component 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 component 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 component. |
| PollingInterval | The amount of time, in seconds, between download attempts. |
| ReceivedFileDate | The date of the remote file received by the OFTP component. |
| ReceivedFileName | The name of the remote file received by the OFTP component. |
| ReceivedFileSize | The size of the remote file received by the OFTP component. |
| RecipientCert | The recipient certificate of the message. |
| RequeueEndpoints | Whether to requeue receive endpoints if the polling interval has not been reached. |
| RuntimeLicense | Specifies the component runtime license key. |
| SecureAuthentication | Whether or not the component should perform secure odette authentication. |
| ServerPassword | The server's password. |
| ServerSFIDCode | Server's SFID code. |
| ServerSSIDCode | The server's SSID code. |
| 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. |
| TempPath | A temporary directory where data can be stored before the component processes it. |
| Timeout | A timeout for the component. |
| 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. |
| 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 component 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 component 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 component. |
| RecipientCert | The recipient certificate of the message. |
| RuntimeLicense | Specifies the component runtime license key. |
| SecureAuthentication | Whether or not the component 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 component 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 component processes it. |
| Timeout | A timeout for the component. |
| 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. |
| 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. |
| 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. |