What's New in the API?

Each new version of the API offers improved programmatic control over EFT COM API. If you are upgrading EFT COM API, 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 API in previous versions.

NOTE: This reference covers all versions of EFT. Please take note of the EFT versions that a COM API member applies to, and use this topic to determine whether you need to update your scripts accordingly. For example, in v8.0.0.38, several Server interface methods and properties were deprecated, as shown below.

Changes in v8.2

New Features

Enums:

GoogleDriveMatchingFileNamePolicy (Overwrite, Skip, Enumerate)
CloudProviderType_GoogleDrive
VirtualFolderType_GoogleDriveStorage
CompressTimeStamp
Added new FileSystemProperties

New Interfaces:

Added properties to the ICICompressActionParams Interface
Added methods to the ICISite - Single Interface for propagating event rules.
Added methods GetGoogleDriveParams and SetGoogleDriveParams to the following Interfaces:

Changes in v8.1.0.9 - 8.1.0.x

New Features

Interfaces:

ICINewSite Interface- Contains properties for a new site (SiteName, SiteRoot, etc.)
ICIAdvancedWorkflowFolder Interface - Folders used to organize Advanced Workflow tasks

Enums:

HAUpgradeNodeState

ICIServer methods:

BeginHAUpgrade
EndHAUpgrade
GetHAUpgradeState
SSLCertSendEmailUponExpiration
SSLCertSendEmailPriorExpiration
SSLCertDaysPriorExpiration
SSLCertEmailRecipients
SSLCertSendEmailCopyToAssociatedUser

ICISites properties and methods:

CreateSite - creates a new site, new version
GetNewSite - retrieves interface to create a site

ICISite properties and methods:

AdvancedWorkflowFolders
GetFolderUploadQuotaPolicy
GetSiteRoot - retrieves Site root
SetFolderUploadQuotaPolicy
SetSiteRoot - Changes Site Root and returns TRUE if the site has to be restarted
SSLCertSendEmailUponExpiration
SSLCertSendEmailPriorExpiration
SSLCertDaysPriorExpiration
SSLCertEmailRecipients
SSLCertSendEmailCopyToAssociatedUser

ICISiteBackupInfo interface properties:

GetSiteRoot - Retrieves Site root
SetSiteRoot - Sets Site Root

ICIAWSS3VirtualFolderTarget property:

CloudProviderType

ICIAzureVirtualFolderTarget property:

CloudProviderType

Enhancements

Added TByte to SizeUnits enum

Changes in v8.0.7

New Features

Added ServerModule enums to activate modules:

Const EnterpriseActionsModule (v8.0.7 and later)
Const FTPModule (v8.0.7 and later)
Const RemoteAgentModule (v8.0.7 and later)
Const SecureFormsModule (v8.0.7 and later)

Changes in v8.0.6

New Features

Added ICIServer interface CloseServerService method
Added ICISite interface PGP properties:

PGPSendEmailExpirationCopyToAssociatedUser
PGPSendEmailPriorExpiration
PGPSendEmailUponExpiration
PGPEmailExpirationRecipientsList
PGPTimePriorExpirationInDays

Added ICIPGPKeyInfo interface property: UsageFlags
Added ICIAbortUserOperationActionParams interface
Added ICIEncryptedFolder properties:
- EncryptionKey
- KeyAlias
Added Event Type enums:
- OnAS2Test,
- OnAS2AsyncResend,
- OnWorkspaceExpired,
- OnSecureMessageComposed = 0xa001,
- OnSecureMessageSent,
- OnSecureMessageNotSent,
- OnSecureMessageViewed,
- OnSecureMessageAttachmentBeforeDownload,
- OnSecureMessageAttachmentAfterDownload
Added EventActionType enum:

AbortUserOperationAction = 536870912 (&H20000000)

Enhancements:

Renamed EventType enum BeforeWorkspaceDeleted renamed to OnWorkspaceBeforeDelete

Changes in v8.0.5, April 30, 2021

Removed:

ICIFileActionParams properties: Contents, Encoding, ExclusionMasks, IncludeSubdirsFlag, NewNameMask, Operation, Path, OverwriteOption, UseExclusionMasksFlag (functionality moved to new File Action interfaces, listed below)

Added interfaces:

Added properties:

ICIFileActionParams: added GetParams and SetParams, and changed type to Type
SFTP algorthm-related properties in ICIServer Interface
ICISite Interface:

ICIAWTaskActionParams interface, added WaitUntilCompletes
ICICommandActionParams Interface, added WaitUntilCompletes
ICIMailActionParams interface, added WaitUntilCompletes
ICICallSubroutineActionParams, added WaitUntilCompletes
ICIContentIntegrityControlProfile Interface, added several new properties
ICIGDPRSettings Interface, added EncryptionPDKey property

Added enums:

ChecksumAlgorithm (CRC32, MD5, SHA1, SHA256, SHA384, SAH512)
FileOperationType, added FileChecksum, FileConcatenate, FileDelete, FileRead, FileRename, FileWrite
IcapErrorsPolicy
MatchingFileOption (append, skip, overwrite, numerate, fail)
RESTInvocation, added to EventType
RESTInvocationAuthType
RESTInvocationVerifyType
SyncDirectionType
SyncOverwriteType
SynchronizeAction, added to EventAction Type

Changes in v8.0.4

ICIServer:

CreateSSHKey and CreateSSHKeyRemotely; changed nKeyBits to nKeyParams

ICISite:

CreateSSHKeyPair, changed changed KeyBits to KeyParams
Added the following methods:

Added the following properties:

ICIClientSettingInterface, added the following functions:

ICIEventRule, added the AddLoopDatasetStatement method
ICIActionStatements, added the following methods:

Added the ICILoopDatasetStatement interface, with the following methods:

AddActionStatement
AddIfStatement
AddLoopDatasetStatement
DeleteStatement
GetParams and SetParams
StatementsCount
Statement

Added ICICsvExportActionParams and ICICsvImportActionParams
Added ICIGetListingActionParams Interface
Added ICILoopDatasetStatement Interface
Added ICILoopDatasetStatementParams Interface
Added ICIUploadForm interface
Added ICIUploadFormElement interface
Added ICITwilioSmsProviderProfile interface
In the ICISimpleCondition interface, added the UseRegex property.
Enums added:

MFA type to specify whether to use email, SMS or either for second authentication
LoopDatasetStatement to EventRuleStatementType enum
LoopOrderType, used in the ICILoopDatasetStatementParams LoopOrder property
GetListingAction, LoopBreakAction, CsvImportAction, and CsvExportAction to EventActionType
FileDateFormat
UploadFormComType
UploadFormElementComType

Changes in v8.0.2.10

WorkspacesOAIPasscodeProtectionType enum, used in the ICISite property, WorkspacesOAIPasscodeProtection to specify whether the EFT administrator requires a passcode, does not required, or is chosen by the email sender

Changes in v8.0.1

Added enums, properties, and methods to support the Azure Data Lake Storage, Azure Key Vault, and Secrets module functionality in EFT. (For details of the Azure Data Lake Storage, Azure Key Vault, and Secrets module functionality, please refer to the EFT administration help contents.)

Enums:

SecretsModuleType
CloudProviderType_AzureDataLakeStorageGen2

Properties in ICISiteInterface:

OverrideVFSCredentialsEnable
OverrideVFSCredentialsLogin
OverrideVFSCredentialsPassword
SecretsModuleClientID
SecretsModuleClientSecret
SecretsModuleType
SecretsModuleURL

Methods in ICICloudStorageMonitorEventRuleParams:

GetAzureDLSgen2GeneralParams
SetAzureDLSgen2GeneralParams

Changes in v8.0.0.38

In the ICIServer interface, added:

defaultvalue and Reason parameter to AddIPAccessRule
UTF8Logs property

In the ICISite interface, added

defaultvalue and Reason parameter to AddIPAccessRule method
PGP Key properties and methods:

Added PGPLogLevelDebug to the ICISite Interface PGPLogLevel property.
SSH Key properties and methods:

Privacy-related changes:

Workspaces Properties and methods:

Content Integrity Control profile management methods and properties

In the ICIClientSettings interface, added:

defaultvalue and Reason parameter to AddIPAccessRule
GetGDPRPrivacyPolicyConsentStatus, SetGDPRPrivacyPolicyConsentStatus
GetGDPRSubjectStatus, SetGDPRSubjectStatus
GetGDPRTermsOfServiceConsentStatus, SetGDPRTermsOfServiceConsentStatus
ResetAllFieldAttributeDefaults
CompanyName
Duns
Mobile
PartnerId

In the ICISSHKeyInfo interface, added HasPrivate property
In the ICIManualIPAccessRule interface, added Reason property
Interfaces added for new Event Rule Actions:

Interfaces added for GDPR, privacy policy, and terms of service features:

Enums:

In the AdminAccountType enum, added ADGroupAccount
In the AdminPermissionsPolicy enum, added ManagePersonalData
In the EventType enum, added EventRuleSubroutine
In the EventActionType enum, added:

DefineVariableAction
RunPowerShellScriptAction
CallSubroutineAction

In the EventProperty enum, added:

FileExtension
ClientGDPRSubjectStatus
ClientGDPRConsentStatus
ClientGDPRReason
ClientGDPRRightExercised

New ClientDataField enum
New GDPRTermsofServiceMode enum
New GDPRPrivacyPolicyMode enum
New GDPRSubjectStatus enum
New GDPRPrivacyPolicyConsentStatus enum
New GDPRTermsOfServiceConsentStatus enum
In UserAccountActionType enum, added:

EnableAccount
PersonalDataDeleteFields
PersonalDataResetToDefaults
PersonalDataSetEnabled
PersonalDataSetModifiable
PersonalDataSetVisible
SetEUDataSubjectStatus
SetPrivacyPolicyConsent
SetTermsOfServiceConsent

NOTE: The ICIServer Interface methods and properties below are deprecated and no longer work (return E_NOTIMPL error). Instead use the similar Site-level methods and properties.

Methods:

CreatePGPKey
RemovePGPKey
ImportPGPKey
ExportPGPKey
GetPGPKeyringSettings
SetPGPKeyringSettings
ImportSSHKey
RemoveSSHKey
RenameSSHKey
ExportSSHKey

Properties:

AvailablePGPKeys
AvailableSSHKeys (deprecated in v8)

The ICISite Interface methods and properties below are deprecated and no longer work (return E_NOTIMPL error):

Methods:

GetSSHKeyFilePath
SetSSHKeyFilePath

Properties:

SFTPKeyFile
SFTPKeyFile

ISATMessage and IAdhocMessage interfaces do not apply to EFT v8 and later

Changes in v7.4.13

NewEnums:

UserAccountActionType (EventActionType)
CleanupTimestampType

New Interfaces:

New Properties and Methods:

ICICleanupActionParams interface::FileTimestampType (uses CleanupTimestampType enum)
ICILDAPAuthManagerSettings interface::AutoCreateSettingsTemplate and SettingsTemplateAttributes
ICISite Interface:

Changes in v7.4.11

Enums:

ICIServer interface:

CreateSSHKeyRemotely method

ICISite interface:

ICIAS2OutboundSettings interface:

CustomHeaders property

ICIAS2InboundSettings interface:

MICAlgorithm property

AS2SendActionParamsinterface:

UseProxy

ICIConnectionProfileParams interface:

GUID property

Changes in v7.4.9

ICISite interface:

Enums:

AS2InboundSettingsinterface:

AS2OutboundSettingsinterface:

AS2SendActionParamsinterface:

Changes in v7.4.7

Added to Server interface:

WebAdminEnabled property
WebAdminPort property
ForceAdminResetPasswordOnInitialLogin property

Added to Site interface:

Workspaces settings
Added to ICIConnectionProfileParams

type property
CloudProviderType property
GetAWSS3GeneralParams and SetAWSS3GeneralParams
GetAzureBlobGeneralParams and etAzureBlobGeneralParams

Added Enum:

Changes in v7.4.5

Added new Enums:

EventActionType enums, CloudUploadAction, and CloudDownloadAction
ConnectionProfileType
AWSS3AuthType
AWSS3EncryptionType
AWSS3MatchingFileNamePolicy
AWSS3Region
AWSS3StorageClass
AzureBlobAuthType
AzureBlobMatchingFileNamePolicy
CloudProviderType

Added new properties to the ICIConnectionProfileParams interface for the cloud
Added a new property to the ICIAS2SendActionParams interface
Added PortAsString property to the ICITransferActionParams interface
Added new interfaces:

Changes in v7.4.2

Added ICIServerVersion interface GetServerVersion property to get the version of EFT you are using
Added ICIAddressBook interface, property, and methods for the Workspaces Drop-Off portal address book
In the ICISite interface, added multiple methods and properties relevant to Workspaces
In the ICIServer interface, added:

In the Client Settings interface, added:

GetForcePasswordResetOnNextLogin

In the enum reference:

In the ICIComplexPasswordSettings

RequireUnicodeInPassword

Changes in v7.3.9

Added CIC and MTC modules to the ServerModule enum

Changes in v7.3.8

Added a COM API method to retrieve the GUID using the site name

Changes in v7.3.7

In the ICIServer interface, added ARMConnectionStatus property
In the ICISite interface, added:

In the ICIComplexPasswordSettings interface, added RequireUnicodeInPassword property
Added ICIServerVersion interface and the GetServerVersion property to get the version of EFT you are using.

Changes in v7.3.6

In the ICIServer interface:

Added SMTPUseImplicitTLS and SendTestEmail to support new SMTP features in EFT
Added CreateSSLCertificateRemotely and SignSSLCertificateRemotely

In the ICISite interface:

Added SendPortalPath property to the Workspaces Settings properties

Changes in v7.3.3

Added new enums for WebSSO and Workspaces
Added new Server properties for WebSSO and Workspaces
Added new Site properties and methods for WebSSO and Workspaces
Added new Client methods for Workspaces.

Changes in v7.3.2

New Properties for ICIServer interface for WTC licensing change from concurrent licenses to client access licenses
ICIServerNodeInfo ModuleLicenseCount() was renamed to TotalModuleLicenseCount() to reflect the license change

Changes in v7.3

In the ICIServerNodeInfo interface, the ActiveWTCSessions property was added.
In the ICIDMZGateway interface, the following properties were added:
- AccelerationPort
- EnableHTTPSAcceleration
In the ICIServerNodeSiteInfo interface, three DMZ Gateway-specific properties were added.

Changes in v7.2.1

Added ServerNodeSiteState enum
Added ServerInfo property to ICIServer interface
Added ICIServerInfo interface
Added ICIServerNodeInfo interface
Added ICIServerNodeSiteInfo interface
Added Transfer Properties to the Event Property enum

Changes in v7.2

The following operations were added to accommodate new features in EFT v7.2:

New/updated:

ICIAdminID interface
ICICommandSettings::GetACL and SetACL
ICICompressActionParams interface
ICIConnectionProfileParams
ICIEventRule interface—new methods and properties
ICIFileActionParams
ICIFolderActionParams
ICITransferActionParams::ConnectionProfileName
ICISimpleCondition interface—new methods
ICISite interface—new methods

New/updated ENUMs:

AdminPermissionsPolicy - EventRulesManagement
ERChangeLog - enables/disables the Event Rules change log
EventActionType - CompressAction, FileAction, FolderAction, WebServiceAction
EventProperty - TransactionID, HttpQueryString, HttpHeadersList, ContextVariable
FileEncodingType
FileOperationType
FileOverwriteOptions
CompressFormat
CompressMethod
CompressOperation
CompressOverwritePolicy

Changes in v7.1.1

In the ICITransferActionParams interface, the following properties were added:

TrustedPublicKeyPath
PreTransferCommandType
PreTransferCommandParam
PostTransferCommandType
PostTransferCommandParam

Added PrePostTransferCommand enum
Removed the EventProperty enum WSUserRemovalReason
Added ICISSLVersion and ICISSLVersions interfaces to support updated SSL libraries.
Added ICIServer::AvailableSSLVersions method for use in the ICISSLVersions interface.

Changes in v7.1

Many objects were added for the new Workspaces feature:

Added to the EventType enum
- OnWorkspaceCreated = 0x7001,
- OnWorkspaceDeleted,
- BeforeWorkspaceDeleted,
- OnWorkspaceUserInvited,
- OnWorkspaceUserJoins,
- OnWorkspaceUserRemoved
Added to the EventProperty enum
- // Workspace properties
- WSVirtualPath = 7000
- WSPhysicalPath
- WSName
- WSParticipants
- WSOwner
- WSUserName
- WSUserPermissions
- WSUserEmail
- WSUserAccountExists
- WSUserRemovalReason (removed in v7.1.1)
Added to ICISite - Single-Site Interface:
Properties:
- EnableWorkspaces
- EnableWorkspacesExternalUsers
Added the ICIWorkspaces interface:
Added the ICIWorkspacesPermissions interface
Added the UseSearchAttributes property to the ICILDAPAuthManagerSettings interface.

Changes in v7.0.3

ICIServer HAConfigurationDefaultNodeList allows you to create a default node list to execute Event Rules.
ICIHighAvalailabilityParams DefaultNodeList is the list of 1 or more nodes who are designated to execute Event Rules. You can still specify nodes within the Event Rule.

The following properties, methods, enums, and interfaces were added to support the antivirus/DLP (ICAP) functionality in Event Rules:

Added methods and properties to ICIServer AddContentIntegrityControlPorfiile, ContentIntegrityControlProfileList, DeleteContentIntegrityControlProfile, GetContentIntegrityControlProfile, TestContentIntegrityControlProfile, and UpdateContentIntegrityControlProfile
Added enums: IcapMode, IcapMaxScanSizeUnits
Edited enum: EventActionType now includes ContentIntegrityControl
Added ICIContentIntegrityControlProfile and ICContentIntegrityControlActionParams interfaces

Changes in v7

The following properties, methods, and enumerations have been added/modified:

ICIServer ARMHealConnection, ARMNotifyOnDisconnect, ARMNotifyOnReconnect, and ARMReconnectPeriod properties were added for the new Auditing and Reporting Module database healing mechanism.
ICIServer LimitLoginAttempts, LockoutPeriod, MaxInvalidLoginAttempts, InvalidAttemptsPeriod, InactiveAccountsRemoving, MaxInactiveAccountPeriod properties were added to view or change administrator Account Security Settings.
ICIBackupArchiveInfo ARMHealConnection, ARMNotifyOnDisconnect, ARMNotifyOnReconnect, and ARMReconnectPeriod properties were added for the new Auditing and Reporting Module database healing mechanism.
ICITransferActionParams DeleteSourceFileIfMoveSkipped property was added to allow you to specify whether a source file should be removed if the transfer was skipped.
ICISite DefaultSettingsLevel property sets a given template as the default. You can also use the property to find out which template is currently specified as the default.
ICISite CreateSettingsLevel method was modified to allow you to specify a Settings Level as the default Settings Level when you create it.

Numerous interfaces, properties, methods, and enums specific to active-active/high availability clustering were added:

Properties added to the ICIServer Interface
New ICIHighAvailabilityParams interface
Methods added to the ICIEventRule Interface
New EventRuleSchedulingAlgorithm Enum
New ICIRoundRobinEventRuleSchedulingParams Interface

Copyright © Fortra, LLC and its group of companies.
All trademarks and registered trademarks are the property of their respective owners.
8.1 | 202404030947 | April 2024