Each new version of the COM API offers improved programmatic control over EFT Server. If you are upgrading EFT Server, be sure to read the descriptions at the links below and update your scripts accordingly. If necessary, GlobalSCAPE Professional Services can assist you with writing scripts for your unique environment.
Included below are details of what is new in this version as well as what has changed in the COM API in previous versions. To assist you with updating your scripts, you can also refer to the Knowledgebase article at http://kb.globalscape.com/KnowledgebaseArticle10860.aspx which provides a comparison of changes from v6.0 to present.
The following properties, methods, and enumeration have been added/modified:
ICIServer::DisconnectDueToTimeout and ICIServer::DisconnectDueToTimeoutPeriod properties enable and set the timeout period to disconnect the administration interface from EFT Server after administrator inactivity.
ICISite::SFTPEncoding property retrieves/specifies the transfer encoding mode for SFTP.
ICISite::FTPEncoding property retrieves/specifies the transfer encoding mode for FTP and FTPS.
ICISite::AdvancedWorkflowsCount read-only property retrieves the total number of Advanced Workflows defined on the Site.
ICISite::GetAdvancedWorkflowIndex method retrieves the zero-based index of the Advanced Workflow with given name.
ICISite::GetAdvancedWorkflowParams method retrieves Advanced Workflow parameters.
ICISite::SetAdvancedWorkflowParams method changes Advanced Workflow parameters.
ICISite::AddAdvancedWorkflow method creates a new Advanced Workflow on the Site.
ICISite::RemoveAdvancedWorkflow method removes an Advanced Workflow from the Site.
ICITransferActionParams::TransferEncoding property retrieves/specifies the transfer encoding mode for client transfer (upload/download) actions.
IAdhocMessage interface, ICIAudit interface, ISATMessage interface, and the ICIAudit::AuditSAT and ICIAudit::AuditAdhoc methods were added to accommodate changes with the EFT Server-Mail Express integration.
TransferEncodingType enum specifies the transfer encoding mode (Auto, ASCII, UTF-8).
EventProperty enum - TimeStampPrecise retrieves/specifies the time of an Event to milliseconds and FolderMonitorFailureReason allows you to specify/retrieve the reason the Folder Monitor rule failed.
EventType enum - added OnClientDeleted and OnClientEnabled values.
ICIFolderMonitorEventRuleParams::PollInterval property retrieves/specifies the polling interval value for folder monitor event rule.
ICIFolderMonitorEventRuleParams::PollIntervalType property retrieves/specifies the polling interval type for Folder Monitor Event Rule.
FolderMonitorPollIntervalType enum specifies Folder Monitor polling by seconds, minutes, or hours.
ICIAdvancedWorkflowParams interface was added to support Advanced Workflows configuration; retrieves/specifies Advanced Workflow.
ICIAdvancedWorkflowParams::Code property retrieves/specifies the source code of Advanced Workflow.
ICIAdvancedWorkflowParams::DateCreated read-only property retrieves/specifies the time when the Advanced Workflow was created.
ICIAdvancedWorkflowParams::Description property retrieves/specifies the description of Advanced Workflow.
ICIAdvancedWorkflowParams::LogMode property retrieves/specifies the debug logging mode of the Advanced Workflow
ICIAdvancedWorkflowParams::Name property retrieves/specifies the name of Advanced Workflow.
AWLogMode enum represents different Advanced Workflow debug logging modes
ICIAdvancedWorkflowParams:: TimeoutSeconds property retrieves/specifies the maximal duration (in seconds) of the Advanced Workflow execution after which it is forcedly terminated by EFT Server (value of 0 means “no timeout”).
New CIAdvancedWorkflowParams co-class was added to support creation of Advanced Workflows. Co-class implements ICIAdvancedWorkflowParams interface.
COM API Event Type enums OnClientDeleted and OnClientEnabled were added for EFT Server's User Account Enabled and User Account Deleted Event Rule triggers.
The EnableCAC method was added to the ICISite interface.
Added EPRT and EPSV to the FTPDataConnectionMode enum.
Numerous interfaces were added and many interfaces have new, modified, or removed members to give you improved programmatic control over EFT Server. If you are upgrading to EFT Server v6.3 and using any of the removed or modified members in your scripts, be sure to read the descriptions at the links and update your scripts accordingly. GlobalSCAPE Professional Services can assist you with writing scripts for your unique environment.
In v6.3, the following interfaces were added or modified:
ICINewUserData Interface (added in v6.3.8)
In v6.2, the following methods, properties, parameters, and enumerators were added, modified, or removed. If you are using any of these in your scripts, be sure to read the descriptions and update your scripts accordingly.
Server Interface (ICIServer) methods:
Added ConnectEx - Allows administrator to login to EFT Server using the new admin credential types (IWA or Windows admin)
Updated the ICIServer interface RemoveServerAdminAccount method to accommodate the new types of admin accounts.
Single-Site Interface (ICISite) properties:
AllowChangePassword - allows you to retrieve or specify whether Site users are allowed to change their passwords.
ForcePasswordResetOnInitialLogin - Forces all users on the Site to change their password on initial login.
GetForcePasswordResetOnInitialLogin - Returns true if client has already changed the password (client will not be forced to change the password).
SetForcePasswordResetOnInitialLogin - Forces the user to change the password only if GetForcePasswordResetOnInitialLogin is false.
LoginType - AD, EFT, and INTEGRATED
ServerModule - Added DMZGWModule registration
PredefinedReportPeriod - Added Last24Hours, Today, and Yesterday
AdminAccountType enumeration - Allows you to specify the type of EFT Server administrator account
AdminLoginType enumeration - Allows you to specify the way an EFT Server administrator connects to server:
Methods, properties, parameters, and enumerators that were added, modified, or removed in EFT Server v6.1 are listed in the tables below. Refer to the specific method, property, parameter, or enumeration topic for more information.
The following methods, properties, and enumerations were modified. If you are using any of these in your scripts, be sure to read the descriptions and update your scripts accordingly.
The first output parameter (“Is inherited”) type of multiple ICIClientSettings “Get” methods was changed from Boolean to VARIANT. This provides the possibility of using this parameter in VBS which does not allow output parameters of non-variant types.
FilterOperator1 and FilterOperator2
The following enumerations were modified:
The following methods, properties, and parameters were added.
ICIAS2SendActionParams-AS2 Send Action Parameters Interface Properties
AWTaskActionParams - Automated Workflow Task Event Action Parameters
ICIBackupActionParams - Backup Action Parameters
The following methods and parameters were removed.