OFTPClient Component
Properties Methods Events Configuration Settings Errors
The OFTPClient component implements the Odette File Transfer Protocol.
Syntax
TibeOFTPClient
Remarks
The OFTPClient component may be used to send and receive OFTP files to and from an OFTP server.
Receiving Files
The OFTPClient ReceiveFiles function requires certain server properties be set. You must set the RemoteHost property to the remote location of the desired OFTP server. You may also set a RemotePort 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 component will connect to the OFTP server and download all files in the server's outgoing queue, and write these files to the directory specified by DownloadDirectory. The component creates a default location on the local machine based on the values of the DownloadDirectory and the Virtual Filename as received from the server. If a different location is preferred, you may set the LocalFile parameter of the StartTransfer event.
Sending Files
The OFTPClient SendFile function requires the same server and authentication properties to be set as the ReceiveFiles function.
The component will connect to the OFTP server and upload the file contained by the LocalFile parameter. It uses the name specified by VirtualFileName when sending to the server. If this is not specified, the filename of the local file is parsed and used as the virtual filename.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
CertEncoded | The certificate (PEM/base64 encoded). |
CertStore | The name of the certificate store for the client certificate. |
CertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
CertStoreType | The type of certificate store for this certificate. |
CertSubject | The subject of the certificate used for client authentication. |
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. |
Connected | Shows whether the component is connected. |
DownloadDirectory | Download directory. |
EncryptionAlgorithm | The encryption algorithm. |
FirewallAutoDetect | This property tells the component whether or not to automatically detect and use firewall system settings, if available. |
FirewallType | This property determines the type of firewall to connect through. |
FirewallHost | This property contains the name or IP address of firewall (optional). |
FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
FirewallPort | This property contains the TCP port for the firewall Host . |
FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
MaxRecordSize | The maximum length of a given record. |
Overwrite | Whether or not the component should overwrite files during transfer. |
RecipientCertEncoded | The certificate (PEM/base64 encoded). |
RecipientCertStore | The name of the certificate store for the client certificate. |
RecipientCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
RecipientCertStoreType | The type of certificate store for this certificate. |
RecipientCertSubject | The subject of the certificate used for client authentication. |
RemoteHost | The domain name or IP address of the OFTP server. |
RemotePort | The port for the OFTP service (default is 3305). |
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. |
SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertStore | The name of the certificate store for the client certificate. |
SSLCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
SSLCertStoreType | The type of certificate store for this certificate. |
SSLCertSubject | The subject of the certificate used for client authentication. |
Timeout | A timeout for the component. |
TrustedCertCount | The number of records in the TrustedCert arrays. |
TrustedCertEncoded | The certificate (PEM/base64 encoded). |
TrustedCertStore | The name of the certificate store for the client certificate. |
TrustedCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
TrustedCertStoreType | The type of certificate store for this certificate. |
TrustedCertSubject | The subject of the certificate used for client authentication. |
UseSSL | Use SSL to access the RemoteHost . |
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. |
VirtualFileSecurityLevel | The level of security for the file. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
ChangeDirection | Sends a Change Direction (CD) command. |
Config | Sets or retrieves a configuration setting. |
DoEvents | Processes events from the internal message queue. |
ExchangeCertificate | Exchange a certificate with the remote host. |
ImportTrustedCerts | Imports a list of trusted CA certificates. |
Interrupt | Interrupts the current action. |
Logoff | Logoff from the OFTP server. |
Logon | Logon to the OFTP RemoteHost using the current client credentials. |
ReceiveFiles | Receive any files queued to be sent from the server. |
Reset | Resets the state of the control. |
SendEndResponse | Sends an EERP/NERP asynchronously. |
SendFile | Send the specified file to the server. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
AcceptFile | Fired when the client receives a file. |
CertificateReceived | Fired when a certificate is received from the remote host. |
EndResponse | Fired every time an end response is received from the server. |
EndTransfer | Fired when a file finishes transferring. |
Error | Information about errors during data delivery. |
PITrail | Fired when any protocol level communication occurs. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
StartTransfer | Fired when a document starts transferring. |
Transfer | Fired while a document transfers (delivers document). |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
AcceptAnySFIDCode | Indicates that all SFID codes are acceptable. |
AllowRetry | Whether to send a retry indicator when rejecting a file. |
CertificateType | Specifies the type of certificate being supplied. |
ConnectionType | Specifies the type of connection that will be created. |
CreditCount | Specifies the credit value. |
DeleteOnError | Whether received files are deleted when there is an error during processing. |
DisconnectAfterEndSession | Determines if the connection is closed immediately after ending the session. |
EnforceProtocolVersion | Requires the server to support the same OFTP version. |
ExchangeBufferSize | Specifies the data exchange buffer size in bytes. |
ExchangeCertStoreType | Specifies the store type when loading a certificate to be exchanged. |
ExchangeCertSubject | The subject of the certificate being exchanged. |
FailOnUntrustedCert | Whether or not to throw an exception when untrusted certificates are used. |
FileDescription | Additional description information sent with the file. |
FileHashAlgorithm | The hash algorithm to use when sending a file. |
FireEndResponseOnSend | Determines if the EndResponse event is fired for outgoing EERP and NERPs. |
FollowRedirects | Determines behavior when importing trusted certificates and a HTTP redirect is returned. |
FriendlyLogFormat | Determines if a more friendly format is applied to PITrail event out. |
MaskSensitive | Masks passwords in logs. |
ReceiptHashAlgorithm | The receipt hash algorithm to request when sending a file. |
ReceivedFileDateTime | The datetime of the file being received. |
ReceivedFileDescription | Additional description information received with the file. |
ReceivedFileEncryptionAlg | The encryption algorithm used for the file being received. |
ReceivedFileName | Returns the name of the received file. |
ReceivedFileNameFormat | The name format of received files. |
ReceivedFileNameFormat | The name format of received files. |
RecipientCertificateType | Specifies the type of recipient certificate being supplied. |
Retry | Indicates whether the recipient allows the send to be retried. |
SendCDAfterEFPA | Specifies whether a CD is always sent after receiving an EFPA. |
TempPath | The path of a directory where temporary files will be created. |
TrustedCertsData | Specifies the source to be used when importing trusted certificates. |
VirtualFileDateFormat | The DateTime format of received files. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |