Search: 
Available in: EDI/AS2
OFTPClient Component [IP*Works! EDI V8]

Properties   Methods   Events   Configuration Settings  

The OFTPClient component implements the Odette File Transfer Protocol.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

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.

ClientPasswordThe client's password.
ClientSFIDCodeClient's SFID code.
ClientSSIDCodeThe client's SSID code.
ConnectedShows whether the component is connected.
DownloadDirectoryDownload directory.
FirewallA set of properties related to firewall access.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
OverwriteWhether or not the component should overwrite files during transfer.
RemoteHostThe domain name or IP address of the OFTP server.
RemotePortThe port for the OFTP service (default is 3305).
ServerPasswordThe server's password.
ServerSFIDCodeServer's SFID code.
ServerSSIDCodeThe server's SSID code.
VersionWhich version of the OFTP protocol the component is using.

Method List


The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

ConfigSets or retrieves a configuration setting.
LogoffLogoff from the OFTP server.
LogonLogon to the OFTP RemoteHost using the current client credentials.
ReceiveFilesReceive any files queued to be sent from the server.
SendFileSend 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.

EndTransferFired when a file finishes transferring.
ErrorInformation about errors during data delivery.
StartTransferFired when a document starts transferring.
TransferFired 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.

CodePageThe system code page used for Unicode to Multibyte translations (Windows/COM only).

| About | Privacy Policy | Terms of Use |
© Copyright 2008 /n software inc.