You can interact with the GlobalSCAPE Secure FTP Server directly from your own custom applications using any COM enabled programming language such as Visual Basic (VB), Java, C++, and many others. You can create a script from the development IDE of your choice. To create a new script file, you need to have some familiarity with programming concepts and, ideally, some experience with a COM enabled programming language.
This article defines the COM Interface of the GlobalSCAPE Secure FTP Server. The COM interface consists of:
If you set up secure remote administration, you will not be able to use the COM interface from remote machines.
Due to the wide range of scripts that GlobalSCAPE Secure FTP Server is able to accommodate we are unable to offer technical support on individual scripts other than what is available in the help files and online Knowledge Base.
If you are having trouble with your script, try to perform the desired action manually, using the GlobalSCAPE Secure FTP Server Administrator Interface. If you cannot, then troubleshoot that problem first and then re-try your script.
If you move or copy the SFTPCOMInterface.dll file from the GlobalSCAPE Secure FTP Server program file, you will also need to move or copy the SSL.dll file to the same location to use the COM interface for any SSL connections or functions.
If you are able to perform the desired actions, and in the desired sequence when using the Administrator Interface, then the problem is not with the FTP Server. The next thing to do is to troubleshoot your script line by line.
If you use the COM interface from a remote machine, your administrator password will be sent over in plain text over the network you are using.
The SFTPCOMInterface.CIServer class is the only SFTPCOMServer class that user applications use directly. To start using the SFTP COM interface a user application should create the SFTPCOMInterface.CIServer class object, and then use its methods and properties.
Set SFTPServer = CreateObject("SFTPCOMInterface.CIServer")
CIServer implements the ICIServer interface.
Use the ICIServer interface to access and manage Secure FTP Server and its attributes
Use the ICISites interface to list all sites, to add sites, and to find individual sites on the server.
It can be obtained by using the Sites method of the ICIServer interface.
Set Sites = SFTPServer.Sites
Use the ICISite interface to manage individual FTP sites on the server. It can be obtained by using the Item and SiteByID methods of the ICISites interface.
Set Site = Sites.Item(0)
Use the IPermission interface to set and manage folder permissons. Use the ICISite::GetFolderPermissions method to get folder permissions.
aPerm = s.GetFolderPermissions("\pub\")
Use the ICISite::GetBlankPermission method to get blank folder permissions.
Set p = s.GetBlankPermission("\pub\"), "Administrative")
Once you have changed properties with IPermission you must call the ICISite::SetPermission method to apply your changes or create new folder permissions.
Use the ICIClientSettings interface to manage client user or client group settings. Use the ICISite::GetGroupSettings method to access the interface.
Set gs = s.GetGroupSettings(s_gr)
or use the ICISite::GetUserSettings method.
Set us = s.GetUserSettings(aUsr(j))
When you call methods or change properties of the ICIClientSettings interface, you must call ICIServer's ApplyChanges method in order for the changes to take effect.
Use the ICICommandSettings interface to create or manage site custom commands. Use the ICISite::GetCommandSettings method to access the interface.
Set cs = s.GetCommandSettings(aCommands(i))
When you make changes with the ICICommandSettings interface the changes take effect immediately. You do not need to explicitly apply the changes.
Use the ICICertInfo interface to obtain information about certificates. Use the ICISite::GetTrustedCertificateInfo method or the ICISite::GetPendingCertificateInfo method to access the interface.
Set ci = s.GetTrustedCertificateInfo(aCerts(i))
Set ci = s.GetPendingCertificateInfo(aCerts(i))
All the properties of the ICICertInfo interface are read only.