OFTPClient Class

Properties   Methods   Events   Configuration Settings   Errors  

The OFTPClient class implements the Odette File Transfer Protocol.

Syntax

class ipworksedi.OFTPClient

Remarks

The OFTPClient component may be used to send and receive OFTP files to and from an OFTP server.

Receiving Files

The OFTPClient receive_files function requires certain server properties be set. You must set the remote_host property to the remote location of the desired OFTP server. You may also set a remote_port if the server is not set to the default protocol port. For client authorization, you must set the client_ssid_code, client_sfid_code, and client_password properties. And, for server authentication, you must set the server_ssid_code, server_sfid_code, and server_password properties.

The class 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 download_directory. The class creates a default location on the local machine based on the values of the download_directory and the Virtual Filename as received from the server. If a different location is preferred, you may set the LocalFile parameter of the on_start_transfer event.

Sending Files

The OFTPClient send_file function requires the same server and authentication properties to be set as the receive_files function.

The class 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.