Connectors

Using FTP, FTPS, and SFTP

File System

When a file needs to be exported or imported from the server hosting Web Central or a shared folder on the server, you can export or import from a file. Use the local file systems syntax to refer to the file.

FTP

In some cases, the file to read or write may be on a remote FTP server. In these cases, the Connector will process the file from the FTP server. To use FTP, simply specify the FTP Connection information in the FTP Configuration fields on the Connector Properties form.

FTPS (FTP over TLS)

If your FTP server is on a secure or encrypted port using TLS, you might have to specify a few additional Connector Parameters

{"useFtpOverTLS":"true", "clientCertificateFileName":"C:\\WebCentralInstall\\key\\myFtpsClientKey.ppk" "serverCertificateFileName":"C:\\WebCentralInstall\\key\\myFtpsServerKey.ppk", "clientKeyPassphrase":"AADSFLKJEEGF"}

In order to specify the use of FTPS, you must specify the first parameter, useFtpOverTLS; however, depending upon your server configuration, the other parameters may not be required.

SFTP

In addition to FTP support, the Connectors support the use of SSH-based FTP or SFTP. Do not confuse SFTP with FTPS; FTPS is simply FTP over TLS, whereas SFTP uses a different protocol (SSH) to communicate with the server. 

To use SFTP you must complete the FTP settings with the SFTP host information as shown below. Secure FTP should be set to Yes and an FTP Username should be specified. Typically, the FTP password is not required as a private/public key is usually used to authenticate.

In addition to the FTP settings shown above, you must specify the location of the SFTP private as a Connector Parameter in JSON format. The server will have the public key.

{"clientCertificateFileName":"C:\\WebCentralInstall\\keys\\mySftpKey.ppk"}

 

Parameter	Description	Example
useFtpOverTLS or useFtpOverSSL	When set to true, the connector will use FTPS, or in other words FTP over TLS.	{"useFtpOverTLS":"true", "clientCertificateFileName":"C:\\WebCentralInstall\\key\\myFtpsClientKey.ppk" "serverCertificateFileName":"C:\\WebCentralInstall\\key\\myFtpsServerKey.ppk", "clientKeyPassphrase":"AADSFLKJEEGF"}
uploadDocument	Uploads the file to the afm_docvers table.	{"uploadDocument":{ "table":"doc_templates", "value":"BLReport", "docField":"template", "comment":"Building Report"} }
clientCertificateFileName	The location of the client’s private key file, to prove to the FTPS server that Web Central is who the server expects it to be.	see useFtpOverTLS
serverCertificateFileName	The location of the server’s public key file, to verify the server is who they are expected to be.	see useFtpOverTLS
clientKeyPassphrase	The passphrase to access the client’s private key.	see useFtpOverTLS