What's New in the COM API?

Methods, properties, parameters, and enumerators that were added, modified, or removed are listed in the tables below. Refer to the specific method, property, parameter, or enumeration topic for more information.

Modified

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.

ICISites interface

Methods and Properties	How It's Used
Add	Adding a Site (Add)
AddADSite	Adding an Active Directory Authenticated Site (AddADSite)
AddLDAPSite	Adding an LDAP Site (AddLDAPSite)
AddLocalSite	Adding a Local Site (AddLocalSite)
AddNTLMSite	Adding an NT Authenticated Site (AddNTLMSite)
AddODBCSite	Adding an ODBC-Authenticated Site (AddODBCSite)
Item	Retrieving a Site's COM Interface by Site Number (Item)

ICISite interface

Methods and Properties	How It's Used
AddCertificateToTrusted	Adding a Pending Certificate to the Trusted List (AddCerficateToTrusted)
IsStarted	Determining if a Site is Started (IsStarted)

ICIClientSettings interface

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.

Methods and Properties	How It's Used
GetAllowAnyPwd	Determining if Users Can Create Any Password (GetAllowAnyPwd)
GetAllowMODEZ	Determining if ModeZ is Allowed (GetAllowMODEZ)
GetAllowNoop	Determining if the NOOP Command is Allowed (GetAllowNoop)
GetAllowXCRC	Determining if the XCRC Command is Allowed (GetAllowXCRC)
GetAppletEnabled	Determining Web Transfer Client Access (GetAppletEnabled)
GetChangePwd	Determining if Users are Allowed to Change their Passwords (GetChangePwd)
GetClearFTP	Determining if Plain FTP Access is Allowed (GetClearFTP)
GetClearHTTP	Determining if Plain HTTP Access is Allowed (GetClearHTTP)
GetDownloadsPerSession	Retrieving a Download per Session Limit (GetDownloadsPerSession)
GetEnableAccount	Determining if a User Account or User Settings Level is Enabled (GetEnableAccount)
GetEnableTimeOut	Determining if a User Can be Timed Out (GetEnableTimeOut)
GetEnableDiskQuota	Determining if an Account has a Disk Quota (GetEnableDiskQuota)
GetFTPS	Viewing if FTPS is Enabled for a Client (GetFTPS)
GetHasDownloadsPerSession	Determining if a User has a Download per Session Limit (GetHasDownloadsPerSession)
GetHasMaxDownloadSize	Determining if a User has a Download Size Limit (GetHasMaxDownloadSize)
GetHasMaxIPs	Determining for an IP Connection Limit (GetHasMaxIPs)
GetHasMaxSpeed	Determining the Maximum Allowed Transfer Speed (GetMaxSpeed)
GetHasMaxUploadSize	Retrieving a User's Upload Size Limit (GetMaxUploadSize)
GetHasMaxUsers	Determining if the Number of Concurrent Connections is Limited for Users (GetHasMaxUsers)
GetHasPwdRetries	Determining Failed Password Limit (GetHasPwdRetries)
GetHasUploadsPerSession	Determining if a User has an Upload per Session Limit (GetHasUploadsPerSession)
GetHomeDir	Determining if Users Can Have a Home Folder (GetHomeDir)
GetHomeDirIsRoot	Determining if the Account Home Folder is the Default Root Folder (GetHomeDirIsRoot)
GetHTTPS	Viewing if HTTPS is Enabled for a Client (GetHTTPS)
GetIncorrectPasswordAttempts	Determining the Number of Failed Password Attempts (GetIncorrectPasswordAttempts)
GetLimitLoginAttempts	Retrieving Number of Login Attempts Allowed (GetLimitLoginAttempts)
GetLockoutNotDisable	Viewing Whether Account Lockout is Enabled for a User (GetLockoutNotDisable)
GetLoginMsg	Determining How Users' Login Message is Defined (GetLoginMsg)
GetMaxDownloadSize	Retrieving a User's Download Size Limit (GetMaxDownloadSize)
GetMaxIPs	Determining Number of Connections Allowed from the Same IP Address (GetMaxIPs)
GetMaxSpace	Determining the Disk Quota Size (GetMaxSpace)
GetMaxSpeed	Determining the Maximum Allowed Transfer Speed (GetMaxSpeed)
GetMaxUploadSize	Retrieving a User's Upload Size Limit (GetMaxUploadSize)
GetMaxUsers	Determining the Maximum Concurrent Connections Allowed per User (GetMaxUsers)
GetPwdRetries	Retrieving the Failed Password Limit (GetPwdRetries)
GetSFTP	Viewing if SFTP Access is Enabled for a Client (GetSFTP)
GetSftpAuthenticationType	Identifying the SFTP Authentication Type (GetSFTPAuthenticationType)
GetSSHKeyID	Retrieving the SFTP (SSH) Certificate ID (GetSSHKeyID)
GetTimeOut	Determining How Long a Connection can be Inactive (GetTimeOut)
GetUploadsPerSession	Retrieving a User's Upload per Session Limit (GetUploadsPerSession)
GetUsedSpace	Determining How Much Disk Space a User has Used (GetUsedSpace)
GetSSLAuthenticationType	Identifying the SSL Authentication Type (GetSSLAuthenticationType)
GetSSLKeyID	Identifying the SSL Key ID (GetSSLKeyID)
SetHomeDir	Allowing Users to Have a Home Folder (SetHomeDir)
SetIncorrectPasswordAttempts	Specifying the Number of Incorrect Password Attempts (SetIncorrectPasswordAttempts)
SetLockoutNotDisable	Setting Account Lockout for a User (SetLockoutNotDisable)

ICIEventRule Interface

Methods	How it's used
GetParams	Event Rule Interface (ICIEventRule)
SetParams
AddIfStatement

ICIEventAction Interface

Methods	How it's used
GetParams	Event Action Interface Properties (ICIEventAction)
SetParams	Event Action Interface Properties (ICIEventAction)

ICIIfStatement Interface

Properties and Methods	How it's used
IfSection	If Statement Interface (ICIIfStatement )
ElseSection
Condition

ICIPgpActionParams interface

Properties and Methods	How it's used
Sign	Determining whether to Sign Encrypted Data (Sign)
KeyIDs	Retrieving or Changing Keys to Encrypt/Decrypt Data (KeyIDs)

ICIReportActionParams interface

Properties and Methods	How it's used
CustomDate	Report Action Parameters Interface (ICIReportActionParams)
DateFormat
FilterAndOr
FilterOperator1 and FilterOperator2
ReportFileFormat

The following enumerations were modified:

Enumeration	How it's used
EventActionType enumeration	Enumerators and Constants
PGPOperation enumeration	Enumerators and Constants

Added

The following methods, properties, and parameters were added.

AS2 Send Action Parameters Interface (ICIAS2SendActionParams)

Parameter	How it's used
LocalPath	Specifying or Retrieving the Path to the File to Send
UseClientProfile	Specifying or Retrieving whether a Certain AS2 Outbound Profile is to be Used
ClientProfile	Specifying or Retrieving Username whose AS2 Outbound Profile is Used for this AS2 Send Operation
DeleteSourceFile	Specifying or Retrieving whether Source File will be Removed after Successful Delivery
Host	Specifying or Retrieving the Remote Host to which to Send the AS2 File
Port	Specifying or Retrieving the Remote Port to Send the AS2 File
RemotePath	Specifying or Retrieving the Path on AS2 Server to Send AS2 File
User	Specifying or Retrieving Username for Authentication on AS2 Server
Password	Specifying or Retrieving Authentication Password for Authentication on the AS2 Server
Subject	Specifying or Retrieving AS2 Message Subject
ContentType	Specifying or Retrieving the Type of AS2 File to Send
Compress	Specifying or Retrieving whether AS2 File will be Compressed before Sending
Encrypt	Specifying or Retrieving whether AS2 Message will be Encrypted with AS2 Partner Certificate
Sign	Specifying or Retrieving whether AS2 Message will be Signed with Site Certificate
PartnerCertificatePath	Specifying or Retrieving Path to AS2 Partner Certificate
AS2ID	Specifying or Retrieving the AS2 ID of File Sender
PartnerAS2ID	Specifying or Retrieving the AS2 ID of the AS2 Partner to which you are Send an AS2 File
ReceiptPolicy	Specifying or Retrieving Type of Receipt Required for AS2 Message
ReceiptDelivery	Specifying or Retrieving Mechanism of Receipt Delivery Required for AS2 Message
TimeoutSec	Specifying or Retrieving the Timeout while Sending AS2 File
RetriesCount	Specifying or Retrieving the Maximum Amount of Sending Retries in the Case of Failure
RetryDelaySec	Specifying or Retrieving the Interval between Sending Retries
AsyncReceiptTimeoutMin	Specifying or Retrieving Maximum Wait Time for Asynchronous AS2 Receipt

Automated Workflow Task Event Action Parameters (AWTaskActionParams)

Property	How it's used
TaskName	Automated Workflow Task Event Action Parameters Interface (AWTaskActionParams)

Backup Action Parameters (ICIBackupActionParams)

Property	How it's used
Folder	Backup Action Parameters (ICIBackupActionParams)

Client Settings Interface

Methods	How it's used
GetLimitAccessByIP	Retrieving Allowed IP Address (GetLimitAccessByIP)
IsActivityPeriodLimited	Determining whether a User Account's Inactivity Period is Limited (IsActivityPeriodLimited)
IsPasswordAgeLimited	Determining if or when Account Password is to Expire (IsPasswordAgeLimited)
SetLimitAccessByIP	Setting Allowed IP Address (SetLimitAccessByIP)

ICICommandSettings Interface

Property	How it's used
LogPath	Specifying or Retrieving the Command Log Path (LogPath)

Event Information Interface Properties (ICIEventInfo)

Property	How it's used
Name	Event Information Interface
Type	Event Information Interface

ICIPgpActionParams interface

Properties and Methods	How it's used
ASCIIArmoredOutput	Specifying or Retrieving PGP Action Output Encoded in Text Format (ASCIIArmoredOutput)
CompressionLevel	Specifying or Retrieving Compression Level for PGP Encryption Operation (CompressionLevel)
SignatureInSeparateFile	Specifying or Retrieving whether Signature will be Placed in Separate File (SignatureInSeparateFile)
SigningHash	Specifying or Retrieving Hash Algorithm for Signing (SigningHash)
SDAPassword	Specifying or Retrieving Password for SDA Operation

Report Information Interface Properties (ICIReportInfo)

Property	How it's used
Name	Report Information Interface
DefinitionPath	Report Information Interface

Server Interface Methods and Properties (ICIServer)

Properties and Methods	How It's Used
AvailableEvents	Retrieving a List of Available Events
AvailablePGPKeys	Retrieving a List of EFT Server's PGP Keys
AvailableReports	Retrieving a List of Available Reports
GenerateReport	Generating an EFT Server Report (GenerateReport)
AvailableSSHKeys	Retrieving List of Available SSH Keys (AvailableSSHKeys)
ImportSSHKey	Importing an SSH Public Key (ImportSSHKey)
ModuleRegistrationState	Retrieving the Registration status of an EFT Server Module (ModuleRegistrationState)
RemoveSSHKey	Removing an SSH Public Key from EFT Server (RemoveSSHKey)
SetSSLCertificate	Specifying SSL Certificate for Administrator Connections (SetSSLCertificate)

Site Interface Methods and Properties (ICISite)

Properties and Methods	How It's Used
AutobanSensitivity	Retrieving or Specifying the Auto-Ban Sensitivity (AutobanSensitivity)
SetSSLCertificate	Specifying the SSL Certificate for a Site (SetSSLCertificate)

Removed

The following methods and parameters were removed.

Client Settings Interface Methods (ICIClientSettings)

Method	How It's Used
GetAllowAnyPwd	Determining if Users Can Create Any Password (GetAllowAnyPwd)
GetAnonymousLogin	Viewing Anonymous Logins (GetAnonymousLogin)
GetHomeIP	Determining if Users are Restricted to a Specific IP Address (GetHomeIP)
GetHomeIPString	Retrieving Users' Home IP Address (GetHomeIPString)
SetAllowAnyPwd	Allowing Users to Create Any Password (SetAllowAnyPwd)
SetAnonymousLogin	Allowing or Prohibiting Anonymous Logins (SetAnonymousLogin)
SetHomeIP	Restricting Users to a Specific IP Address (SetHomeIP)
SetHomeIPString	Specifying Users' Home IP Address (SetHomeIPString)
SetIncorrectPasswordAttempts	Specifying the Number of Incorrect Password Attempts (SetIncorrectPasswordAttempts)

Event Rule Interface (ICIEventRule)

Method	How It's Used
Params	Event Rule Interface (ICIEventRule)

Event Action Interface (ICIEventAction)

Property	How It's Used
Params	Event Action Interface Properties (ICIEventAction)

PGP Action Parameters Interface (ICIPgpActionParams)

Property	How It's Used
Sign	Determining whether to Sign Encrypted Data (Sign)

Report Action Interface (ICIReportActionParams)

Property	How It's Used
Name	Report Action Parameters Interface (ICIReportActionParams)
Path	Report Action Parameters Interface (ICIReportActionParams)

Server Interface Methods (ICIServer)

Method	How It's Used
AreLingeringTransactions	Determining if Lingering Transactions Exist
IsDBConnected	Determining if Server is Connected to the ARM Database

Timer Event Rule Parameters Interface (CITimerEventRuleParams)

Paramters	How It's Used
LastPremature	Timer Event Rule Parameters Interface (ICITimerEventRuleParams)
LastTime

Did this topic solve your problem/answer your question?

- For the most up-to-date information regarding EFT Server and its modules;

- To view version history, updates, and activation instructions;

- To download a PDF of this user guide;

- And to search the Knowledge Base and User Forum,

Visit the GlobalSCAPE Support Center, http://www.globalscape.com/support .

Last modified: November 20, 2009