OFTP Tasks

Properties   Configuration Settings  

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.

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 task will connect to the OFTP server 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.

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 task 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.

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.

CertificateThe private key certificate.
ClientPasswordThe client's password.
ClientSFIDCodeClient's SFID code.
ClientSSIDCodeThe client's SSID code.
FirewallA set of properties related to firewall access.
LocalDirectoryThe directory on the local machine where files are downloaded.
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during task execution.
OFTPPortThe port for the OFTP service (default is 3305).
OFTPServerThe domain name or IP address of the OFTP server.
OFTPVersionWhich version of the OFTP protocol the component is using.
OtherDefines a set of configuration settings to be used by the task.
OverwriteWhether or not the task should overwrite files during transfer.
RecipientCertThe recipient certificate of the message.
RuntimeLicenseSpecifies the task runtime license key.
SecureAuthenticationWhether or not the task should perform secure odette authentication.
ServerPasswordThe server's password.
ServerSFIDCodeServer's SFID code.
ServerSSIDCodeThe server's SSID code.
SSLAcceptServerCertInstructs the task to unconditionally accept the server certificate that matches the supplied certificate.
SSLAcceptServerCertAcceptAnyTells the task to accept any server certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
TimeoutA timeout for the task.
UseSSLUse 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.

CertificateThe private key certificate.
ClientPasswordThe client's password.
ClientSFIDCodeClient's SFID code.
ClientSSIDCodeThe client's SSID code.
CompressWhether or not to compress the outgoing file.
EncryptionAlgorithmThe encryption algorithm.
FirewallA set of properties related to firewall access.
LocalFileThe path to a local file for upload.
LogFileThe file to write logging information to at runtime.
LogModeWhat information gets logged during task execution.
MaxRecordSizeThe maximum length of a given record.
OFTPPortThe port for the OFTP service (default is 3305).
OFTPServerThe domain name or IP address of the OFTP server.
OFTPVersionWhich version of the OFTP protocol the component is using.
OtherDefines a set of configuration settings to be used by the task.
RecipientCertThe recipient certificate of the message.
RuntimeLicenseSpecifies the task runtime license key.
SecureAuthenticationWhether or not the task should perform secure odette authentication.
ServerPasswordThe server's password.
ServerSFIDCodeServer's SFID code.
ServerSSIDCodeThe server's SSID code.
SignedReceiptWhether or not to require signed receipts.
SSLAcceptServerCertInstructs the task to unconditionally accept the server certificate that matches the supplied certificate.
SSLAcceptServerCertAcceptAnyTells the task to accept any server certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
TimeoutA timeout for the task.
UseSSLUse SSL to access the OFTPServer .
VirtualFileDateThe date/time stamp for the virtual file.
VirtualFileFormatThe structure of the outgoing file.
VirtualFileNameThe virtual file name.
VirtualFileSecurityLevelThe 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.

OverwriteTempFilesWhether to overwrite files in the directory specified by TempPath.
ReceivedFileNameFormatThe name format of received files.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLSecurityFlagsFlags that control certificate verification.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLSNamedGroupsThe supported (EC)DHE groups.
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 task whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
/n software Tasks for SSIS - Version 20.0 [Build 7723]