OFTP Tasks

The OFTP Task adds OFTP send and receive capabilities to your SSIS Package.

Remarks

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

OFTP Receive Task

The OFTP Receive Task 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 task will connect to the OFTP server every PollingInterval and download all files in the server's outgoing queue, and submit these to the SSIS Package as individual messages.

OFTP Send Task

The OFTP Send Task 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 task will connect to the OFTP server whenever it has a message to send. The task 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.

Receiver Property List

The following is the full list of the properties of the receiver task 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.
Firewall	A set of properties related to firewall access.
LocalDirectory	The directory on the local machine where files are downloaded.
LogFile	The file to write logging information to at runtime.
LogMode	What information gets logged during task execution.
OFTPPort	The port for the OFTP service (default is 3305).
OFTPServer	The domain name or IP address of the OFTP server.
OFTPVersion	Which version of the OFTP protocol the component is using.
Other	Defines a set of configuration settings to be used by the task.
Overwrite	Whether or not the task should overwrite files during transfer.
RecipientCert	The recipient certificate of the message.
RuntimeLicense	Specifies the task runtime license key.
SecureAuthentication	Whether or not the task should perform secure odette authentication.
ServerPassword	The server's password.
ServerSFIDCode	Server's SFID code.
ServerSSIDCode	The server's SSID code.
SSLAcceptServerCert	Instructs the task to unconditionally accept the server certificate that matches the supplied certificate.
SSLAcceptServerCertAcceptAny	Tells the task to accept any server certificate.
SSLCert	The certificate to use for client authentication during the SSL handshake.
Timeout	A timeout for the task.
UseSSL	Use SSL to access the OFTPServer .

Sender Property List

The following is the full list of the properties of the sender task 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.
EncryptionAlgorithm	The encryption algorithm.
Firewall	A set of properties related to firewall access.
LocalFile	The path to a local file for upload.
LogFile	The file to write logging information to at runtime.
LogMode	What information gets logged during task execution.
MaxRecordSize	The maximum length of a given record.
OFTPPort	The port for the OFTP service (default is 3305).
OFTPServer	The domain name or IP address of the OFTP server.
OFTPVersion	Which version of the OFTP protocol the component is using.
Other	Defines a set of configuration settings to be used by the task.
RecipientCert	The recipient certificate of the message.
RuntimeLicense	Specifies the task runtime license key.
SecureAuthentication	Whether or not the task 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 task to unconditionally accept the server certificate that matches the supplied certificate.
SSLAcceptServerCertAcceptAny	Tells the task to accept any server certificate.
SSLCert	The certificate to use for client authentication during the SSL handshake.
Timeout	A timeout for the task.
UseSSL	Use SSL to access the OFTPServer .
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 task 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.
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.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLSNamedGroups	The supported (EC)DHE groups.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
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 task whether or not to use the system security libraries or an internal implementation.
PersistedConnectionTimeout	How long to leave a persisted connection alive.