Performing complex yet repetitive administrative tasks over a large enterprise can be very time consuming in a user interface. With scripting, you can automate tasks to save time and avoid user error. In 2004, GlobalSCAPE added a COM Application Programming Interface (API) to Secure FTP Server. Later that same year, COM API support was included in the first release of EFT Server. With this COM API support, you can interact with GlobalSCAPE's server products directly from your own custom applications using any COM-enabled programming language with the integrated development environment (IDE) of your choice. To create a new script file or program, you must have familiarity with programming concepts and, ideally, some experience with a COM-enabled programming language. This guide assumes you know how to create and execute a script and simply provides descriptions of the classes, methods, and properties in the GlobalSCAPE Server COM API. Few examples are provided; if you need assistance creating scripts, GlobalSCAPE Professional Services can create custom scripts for you.
|
|
Be sure to heavily document/comment your script. Adding descriptive comments to your script now will remind you and others of the purpose of the script, and makes it easier to borrow sections of script to use later in other scripts. A year from now, when you don't even remember writing the script, you'll be glad you added comments. |
To find the interface, method, or property that you need to use in your script
Look in the table of contents, which lists actions you might want to perform (e.g., Retrieving the File Path for Certificates (GetCertFilePath))
Use the Search feature in help or the PDF to locate words or phrases within the content of the topics. (e.g., "certificate" yields ~50 topics; "certificate country" yields ~12 topics)
Look in the Index tab of the help, which provides an alphabetical listing of every method and property in the COM API. (e.g., GetCertFilePath, GetChangePwd, GetCheckClientCert)
|
|
This guide is intended as a supplement to the EFT Server/Secure FTP Server user guides. For an understanding of the concepts in this supplement, please refer to those guides. |
The SFTPCOMInterface.CIServer class is the class that an application can use directly. To start using the SFTP COM interface, you create the SFTPCOMInterface.CIServer class object, and then apply the methods and properties in the object.
For example: Set SFTPServer = CreateObject("SFTPCOMInterface.CIServer")
CIServer implements the ICIServer interface.
For script examples, refer to Creating Scripts.
Refer to the following Web sites for helpful information regarding scripting:
VBScript Run-time Errors - Reference of run-time errors.
VBScript Syntax Errors - Reference of syntax errors
Microsoft Windows Script Technologies - Lists the Windows script technologies and describes the functionality included in each technology.
Server Interface (ICIServer) - Use the ICIServer interface to access and manage the Server and its attributes.
Multiple Sites Interface (ICISites) - 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.
Single-Site Interface (ICISite) - Use the ICISite interface to manage individual Sites on the server. It can be obtained by using the Item and SiteByID methods of the ICISites interface.
For example: Set Site = Sites.Item(0)
Permissions Interface Properties - Use the IPermission interface to set and manage folder permissions. Use ICISite::GetFolderPermissions to get folder permissions.
Audit Interface Methods - Use the ICIAudit interface to log a Secure Ad Hoc Transfer (SAT) email, file, or transaction. Use ICIServer Auditor to retrieve the Audit interface.
Client Settings Interface (ICIClientSettings) - Use the ICIClientSettings interface to manage client user or client group settings. Use ICISite::GetSettingsLevelSettings for group and ICISite::GetUserSettings for client.
Command Settings Interface (ICICommandSettings) - Use the ICICommandSettings interface to create or manage Site custom commands. Use ICISite::GetCommandSettings to access the interface.
Command Action Parameters Interface (ICICommandActionParams) - Use the ICICommandActionParams interface to retrieve or change parameters for custom Commands.
Certificate Information Interface (ICICertInfo) - Use the ICICertInfo interface to obtain information about certificates. Use ICISite::GetTrustedCertificateInfo or ICISite::GetPendingCertificateInfo to access the interface.
Mail Action Parameters Interface - (EFT Server 5.2 and later) Use the ICIMailActionParams interface to make changes to the MailAction settings, such as email subject, email body, and to addresses, CC addresses, and BCC addresses.
Cleanup Action Parameters Interface - (EFT Server 5.2 and later) Use the ICICleanupActionParams interface to make changes to the Cleanup in Folder Event Action settings.
OpenPGP Action Interface (ICIPgpActionParams) - (EFT Server 5.2 and later) Use the ICIPgpActionParams interface to make changes to the OpenPGP Event Action settings.
Event Rule Interfaces - (EFT Server 5.2 and later) Use the Event Rule interfaces to manage Event Rules and their Events, Actions, and Conditions.
