Enums

Enumerators, or "enums," are constants or variables used within methods and properties. For example, in the ICIBackupArchiveInfo and ICIServer Interface, the ARMDatabaseType enum is used to specify whether the ARM database is Oracle or SQL Server.

Below is an alphabetical reference for the enums used in the EFT COM API.

Jump to: C D E F G H I L M N P R S T U V W

ADAuthManagerLogonAttribute (v6.3 and later)

Used in the ICIADAuthManagerSettings LogonAttribute property.

NT4AccountName = 0
UserPrincipalName = 2
DisplayName = 1
CommonName = 3

ADAuthManagerType (v6.3 and later)

Used in the ICIADAuthManagerSettings type property.

AuthManagerAD = 0
AuthManagerNTLM = 1

AdminAccountType (v6.1 and later)

Used to specify the type of EFT administrator account in the ICIAdminAccount type property, and the ICIServer CreateAdmin, CreateAdminID, and RemoveServerAdminAccount methods.

EFTAccount = 0
LocalComputerAccount = 1
ADAccount = 2
ADGroupAccount = 3 (added in v8)

AdminLoginType (v6.1 and later)

Used to specify the way an EFT administrator connects to the server in the ICIServer ConnectEx, GetBackupArchiveInfo, and RestoreServerConfigurationEx methods.

EFTLogin = 0
IWALogin = 1
NetLogon = 2

AdminPermissionsPolicy (v6.1 and later)

Used in the ICIAdminPermissionPermission property.

ServerManagement = 0; Server administrator; full control
SiteManagement = 1; Site administrator; full control except over server settings
STManagement = 2; Settings Template administrator; control over assigned template and users belonging to that template
UserCreation = 3; User administrator; create and disable users and change passwords
ChangePassword = 4; Change password administrator; disable users and change passwords
COMManagement = 5; Can manage server using the API
ReportManagement = 6; Can run and edit reports
EventRulesManagement = 7; Can manage Event Rules (EFT v7.2 and later)
ManagePersonalData = 8 (added in v8)
RestManagement = 9; Can manage server using REST API (EFT v8.2.7)

AgeRestrictionsType (v8 and later)

Used in the ICIGDPRSettings Interface AgeRestrictions property.

AgeRestrictions_Unknown,
AgeRestrictions_EFT,
AgeRestrictions_External,
AgeRestrictions_Other,
AgeRestrictions_NotApplicable

ARMAuthenticationType (v6.3 and later)

Used in the ICIBackupArchiveInfo and ICIServer - Server Interface ARMAuthenticationType properties to specify the ARM database authentication type.

WindowsAuthentication = 0
SQLServerAuthentication = 1

ARMDatabaseType (v6.3 and later)

Used in the ICIBackupArchiveInfo and ICIServer - Server Interface ARMDatabaseType properties to specify the ARM database type.

Oracle = 0; Oracle database
SQLServer = 1; SQL Server database

AS2AuthenticationType (v6.3 and later)

Used in the ICIAS2InboundSettings AuthenticationType property used to specify the AS2 authentication mechanism.

AS2AuthTypeUsernameAndPassword = 0
AS2AuthTypeMsgLevelSecurity = 1

AS2ContentType (v6.1 and later)

Used to specify the type of the document to send in the ICIAS2OutboundSettings and ICIAS2SendActionParamsContentType properties.

X12 = 0
EDIConsent = 3
EDIFACT = 1
Binary = 4
XML = 2
Plaintext = 5

AS2DoubleContentPolicy (v6.3 and later)

Used in the ICIAS2InboundSettings DoubleContentPolicy property to specify the AS2 duplicate contents policy.

AS2DoubleContentPolicyOverwrite = 0
AS2DoubleContentPolicyNumerate = 1
AS2DoubleContentPolicyReject = 2

AS2DoubleMsgIDPolicy (v6.3 and later)

Used in the ICIAS2InboundSettings DoubleMsgIDPolicy property to specify the AS2 duplicate message ID policy.

AS2DoubleMsgIDPolicyAccept = 0
AS2DoubleMsgIDPolicyReject = 1

AS2EncryptionAlgorithm (v7.4.9 and later)

Used in the ICIAS2OutboundSettings EncryptionAlgorithm property to specify allowed encryption algorithms.

Const Encryption_3DES = 0
Const Encryption_DES = 1
Const Encryption_AESCBC128 = 2
Const Encryption_AESCBC192 = 3
Const Encryption_AESCBC256 = 4

AS2EncryptMissingPolicy (v6.3 and later)

Used in the ICIAS2InboundSettings EncryptMissingPolicy property.

AS2EncryptMissingPolicyAccept = 0
AS2EncryptMissingPolicyReject = 1

AS2IDMismatchPolicy (v6.3 and later)

Used in the ICIAS2InboundSettings EFTIDMismatchPolicy and PartnerIDMismatchPolicy properties to specify the mismatch policy.

AS2IDMismatchPolicyAccept = 0
AS2IDMismatchPolicyReject = 1

AS2MICHash (v7.4.11 and later)

MDN_AS_REQUESTED = 0,
MDN_AS_REQUESTED_OR_SHA1,
MDN_SHA1,
MDN_MD5,
MDN_None,
MDN_SHA_256
MDN_SHA_384,
MDN_SHA_512,
MDN_SHA_224,
MDN_AS_REQUESTED_OR_SHA256,

AS2OutboundProfileStatus (v6.3 and later)

Used in the ICIClientSettings AS2TestOutboundProfile method to retrieve the result for AS2 Test Outbound Profile operation.

AS2StatusOk = 0
AS2StatusVerifyMDNFailed = 4
AS2StatusNotRegistered = 1
AS2StatusDatabaseFailure = 5
AS2StatusCreateRequestFailed = 2
AS2StatusUnexpectedError = 6
AS2StatusSendDataFailed = 3

AS2ProxyType (v6.3 and later)

Used in the ICIAS2OutboundSettings ProxyType property to specify the AS2 proxy type.

AS2ProxyDMZ = 0
AS2ProxyHTTP = 1

AS2ReceiptDelivery (v6.1 and later)

Used to specify the receipt delivery mechanism in the ICIAS2OutboundSettings and ICIAS2SendActionParamsReceiptDelivery property.

Sync = 0
Async = 1

AS2ReceiptPolicy (v6.1 and later)

Used to specify the type of the receipt required in the ICIAS2OutboundSettings and ICIAS2SendActionParamsReceiptPolicy property.

NoReceipt = 0
UnsignedReceipt = 1
SignedReceipt = 2

AS2SignatureAlgorithm (v7.4.9 and later)

The AS2SignatureAlgorithm enum is used in the ICIAS2OutboundSettings SignatureAlgorithm property.

Signature_MD5 = 1
Signature_SHA1 = 0
Signature_SHA_224 = 5
Signature_SHA_256 = 2
Signature_SHA_384 = 3
Signature_SHA_512 = 4

AS2SignatureMissingPolicy (v6.3 and later)

Used in the ICIAS2InboundSettingsSignatureMissingPolicy property to specify the AS2 signature-missing policy.

AS2SignatureMissingPolicyAccept = 0
AS2SignatureMissingPolicyReject = 1

AS2TransactionDirection (v6.3 and later)

Used in the ICIAS2TransactionInfo InterfaceDirection property to retrieve the direction of an AS2 transaction.

AS2TransDirectionInbound = 0
AS2TransDirectionOutbound = 1

AS2TransactionStatus (v6.3 and later)

Used in the ICIAS2TransactionInfo InterfaceStatus property to retrieve the status of an AS2 transaction.

AS2TransactionInProgress = 0
AS2TransactionSuccess = 1
AS2TransactionFailedCanResend = 2
AS2TransactionFailedNoResend = 3
AS2TransactionOkSendMDNFailed = 4

AutobanSensitivity (v6.1 and later)

Used to specify the sensitivity for Flood/Hammer Autoban settings in the ICISite Interface AutobanSensitivity property.

SensitivityOff = 0
SensitivityVeryLow = 1
SensitivityLow = 2
SensitivityMedium = 3
SensitivityHigh = 4
SensitivityVeryHigh = 5

AWLogMode (v6.5 and later)

AWLogMode enumeration represents different Advanced Workflow debug logging modes (see also ICIAdvancedWorkflowParams::LogMode).

AWLogNone = 0; no logging
AWLogMinimal = 1; minimal logging
AWLogNormal = 2; normal logging
AWLogVerbose = 3; verbose logging

AWSS3AuthType (v7.4.6 and later)

Used in the ICICloudAWSS3GeneralParams interface.

AWSS3AuthType_Anonymous = 0,
AWSS3AuthType_Standard = 1

AWSS3BucketAccessStyle (v7.4.6 and later)

Const AWSS3BucketAccessStyle_PathStyle = 1
Const AWSS3BucketAccessStyle_VirtualHostedStyle = 0

AWSS3EncryptionType (v7.4.6 and later)

Used in the ICICloudAWSS3GeneralParams interface.

AWSS3EncryptionType_None = 0,
AWSS3EncryptionType_Server = 1
AWSS3EncryptionType_Client = 2

AWSS3MatchingFileNamePolicy (v7.4.6 and later)

Used in the ICICloudAWSS3UploadParams and ICICloudAWSS3DownloadParams interfaces.

AWSS3MatchingFileNamePolicy_Overwrite = 0
AWSS3MatchingFileNamePolicy_Skip = 1
AWSS3MatchingFileNamePolicy_Numerate = 2

AWSS3Region (v7.4.6 only; Refer to ICICloudAWSS3GeneralParams.Region property for v7.4.7 and later)

Used in the ICICloudAWSS3GeneralParams interface

AWSS3Region_UsEast1 = 0,
AWSS3Region_UsEast2 = 1
AWSS3Region_UsWest1 = 2
AWSS3Region_UsWest2 = 3
AWSS3Region_EuWest1 = 4
AWSS3Region_EuWest2 = 5
AWSS3Region_EuWest3 = 14
AWSS3Region_EuCentral1 = 6
AWSS3Region_ApNortheast1 = 7
AWSS3Region_ApNortheast2 = 8
AWSS3Region_ApSouth1 = 9
AWSS3Region_ApSoutheast1 = 10
AWSS3Region_ApSoutheast2 = 11
AWSS3Region_SaEast1 = 12
AWSS3Region_CaCentral1 = 13

AWSS3StorageClass (v7.4.6 and later)

Used in the ICICloudAWSS3GeneralParams interface.

AWSS3StorageClass_Standard = 0
AWSS3StorageClass_StandardIA = 1
AWSS3StorageClass_ReducedRedunancy = 2

AzureBlobAuthType (v7.4.6 and later)

Used in the ICICloudAzureBlobGeneralParams interface.

AzureBlobAuthType_Anonymous = 0
AzureBlobAuthType_SharedKey = 1
AzureBlobAuthType_SASToken = 2 (added in 7.4.9)

AzureBlobMatchingFileNamePolicy (v7.4.6 and later)

Used in the ICICloudAzureBlobUploadParams and ICICloudAzureBlobDownloadParams interfaces.

AzureBlobMatchingFileNamePolicy_Overwrite = 0
AzureBlobMatchingFileNamePolicy_Skip = 1
AzureBlobMatchingFileNamePolicy_Numerate = 2

CaptchaType (v7.4.2 and later)

Used in the ICISite interface WorkspacesDropOffCaptchaType property to specify the type of CAPTCHA to use.

CaptchaType_None = 0,
CaptchaType_Standard = 1,
CaptchaType_reCAPTCHA = 2

CertificateFormat (v6.3 and later)

Used in the ICIServer Interface CreateSSLCertificate method to specify the certificate and private key format.

PEM = 0; PEM (ASCII) encoded *.crt, *.key
DER = 1; DER (binary public / private key) *.cer, *.der
PKCS7 = 2; PKCS#7 P7B public key *.p7
PKCS12 = 3; PKCS#12 (PFX combined) *.pfx

ChecksumAlgorithm (v8.0.5 and later)

Used in the ICIFileActionsChecksumParams to specify the algorithm used.

ChecksumCRC32 = 0,
ChecksumMD5 = 1,
ChecksumSHA1 = 2,
ChecksumSHA256 = 3,
ChecksumSHA384 = 4,
ChecksumSHA512 = 5

CleanupTimestampType

CleanupTimestampType_Created
CleanupTimestampType_Modified
CleanupTimestampType_CreatedAndModified

ClientDataField (added in v8)

Used in the ICISite interface GetClientDataField method.

ClientDataFieldId_Comments = 13
ClientDataFieldId_CompanyName = 2
ClientDataFieldId_Custom1 = 10
ClientDataFieldId_Custom2 = 11
ClientDataFieldId_Custom3 = 12
ClientDataFieldId_Description = 4
ClientDataFieldId_Duns = 8
ClientDataFieldId_Email = 0
ClientDataFieldId_Fax = 6
ClientDataFieldId_FullName = 1
ClientDataFieldId_Mobile = 3
ClientDataFieldId_Pager = 7
ClientDataFieldId_PartnerId = 9
ClientDataFieldId_Phone = 5

CloudProviderType (v7.4.6 and later)

Used in the ICICloudTransferActionParams, ICIConnectionProfileParams, and ICICloudTransferActionParams interfaces.

CloudProviderType_AWSS3 = 0
CloudProviderType_AzureBlob = 1
CloudProviderType_AWSS3Compatible = 2
CloudProviderType_AzureDataLakeStorageGen2 = 3
CloudProviderType_GoogleDrive = 4

CloudStorageMonitorScanIntervalUnitType (v7.4.6 and later)

COMSISeconds = 0
COMSIMinutes = 1
COMSIHours = 2

CompressFormat (v7.2 and later)

Used in the ICICompressActionParams interface, Format property.

AutoDetect = 0
Bzip2 = 4
Gzip = 3
SevenZip = 2
Tar = 5
TarAndGzip = 6
Zip = 1
ZCompress = 7

CompressMethod (v7.2 and later)

Used in the ICICompressActionParams interface, Method property.

BZIP_2 = 4
COPY = 6
DEFAULT = 0
DEFLATE = 1
DELTA = 5
LZCCOMPRESS = 8
LZMA = 3
LZMA_2 = 7
PPMd = 2

CompressOperation (v7.2 and later)

Used in the ICICompressActionParams interface, Operation property.

Compress = 0
Decompress = 1

CompressOverwritePolicy (v7.2 and later)

Used in the ICICompressActionParams interface, OverwritePolicy property.

Never = 0
Always = 1
IfNewer = 2

CompressTimestamp (v8.2 and later)

CompressTimestampType_Created
CompressTimestampType_Modified
CompressTimestampType_CreatedAndModified

ConditionsForConsent (v8 and later)

Used in the ICIGDPRSettings Interface ConditionsForConsent property.

ConditionsForConsent_Unknown,
ConditionsForConsent_EFT,
ConditionsForConsent_External,
ConditionsForConsent_Other,
ConditionsForConsent_NotApplicable

ConditionOperator (v6.1 and later)

Used in the ICICompoundCondition Interface Add method, the ICIEventRule Interface AddIfStatement method, and the ICISimpleCondition Interface Operator property

Contains = 8
Equals = 1
ExistAt (added in v7.2) = 1024
Greater (added in v6.3.1) = 256
GreaterOrEquals (added in v6.3.1) = 512
Less = 2
LessOrEquals = 4
Match = 16
MemberOf = 32
OneOf = 64
StartsWith = 128

ConnectionProfileType (v7.4.6 and later)

Used in the ICIConnectionProfileParams interface.

Protocol = 0
Cloud = 1

DataSanitizationMethod (v6.3 and later)

Used in the ICISite Interface DataSanitizationMethod property to specify the data wiping technique.

DataSanitizationNoWipe = 0; Windows standard – no wipe
DataSanitizationPseudorandomData = 1; Pseudorandom data
DataSanitization3PassDoD = 2; 3-pass DoD 5220.22-M

DiagLoggingER (7.4 and later)

Used in the ICIServer interface, DiagLoggingER is used in the Event Rule transfer log.

DiagLoggingER_None = 0
DiagLoggingER_FailuresOnly = 1

DirectCollectionType (v8 and later)

Used in the ICIGDPRSettings interface DirectCollection property.

DirectCollection_Unknown,
DirectCollection_EFT,
DirectCollection_External,
DirectCollection_Other,
DirectCollection_NotApplicable

DPOAssignedType (v8 and later)

Used in the ICIGDPRSettings interface DPOAssignedType property.

DPOAssigned_ConfiguredByEFT
DPOAssigned_Other,
DPOAssigned_NotApplicable

EMailLoginCredentialsMode (v6.3 and later)

Used in the ICISite Interface EMailLoginCredentialsMode property used to specify how to e-mail users their login credentials.

EMailCredentialsBoth = 0; e-mail both username and password together
EMailCredentialsSeparate = 1; e-mail the username and password in separate e-mails
EMailCredentialsUsernameOnly = 2; e-mail the username only

EncryptedPDType (v8 and later)

Used in the ICIGDPRSettings interface EncryptedPDType property. (PD=Personal Data)

EncryptedPD_NotEncrypted,
EncryptedPD_Encrypted,
EncryptedPD_CompensatingControl,
EncryptedPD_NotApplicable

ERChangeLog (v7.2 and later)

ERChangeLog is used in the ICIServer interface in the EventRuleChangeLog property. The Event Rule Change Log must be enabled on the Server before changes will appear in the Change Log.

ERChangeLog_Off = 0
ERChangeLog_Optional = 1
ERChangeLog_Mandatory = 2

EventActionType (v6.0 and later)

Used in the ICIEventAction Interface type property.

AbortUserOperationAction (added in v8.0.6)
AS2SendAction = 512 (added in v6.1)
AWTaskAction = 1024 (added in v6.1)
BackupAction = 2048 (added in v6.1)
CallSubroutineAction = 16777216 (&H1000000) (added in v8.0)
CleanupAction = 128
CloudUploadAction = 0x80000 (added in 7.4.4)
CloudDownloadAction = 0x100000 (added in 7.4.4)
CommandAction = 1
CompressAction = 0x10000 (added v7.2)
ContentIntegrityControl = 8192 (added v7.0.3)
CsvExportAction = 0x10000000 (added v8.0.4)
CsvImportAction = 0x8000000 (added v8.0.4)
DefineVariableAction = 4194304 (&H400000 (added in v8)
DownloadAction = 8
FileAction = 0x8000 (added v7.2)
FolderAction = 0x4000 (added v7.2)
GetListingAction = 0x2000000 (added v8.0.4)
LoopBreakAction = 0x4000000 (added v8.0.4)
MailAction = 2
PGPAction = 32
ReportAction = 256
RunPowerShellScriptAction = 8388608 (&H800000) (added in v8)
StopAction = 64
SynchronizeAction = 0x10 (v8.0.5)
UploadAction = 4
UserAccountAction = 0x200000 (added v7.4.13)
WebServiceAction = 0x40000 (added v.7.2)
WindowsEventLog = 4096 (added in v6.3.0)

EventLogType (v6.3 and later)

Used in the ICIWindowsEventLogActionParams Interface type property to specify the event log type in the "Write to Windows Event Log" action.

EventInformation = 0
EventWarning = 1
EventError = 2

EventProperty (v6.1 and later)

Used in the ICICompoundCondition Interface Add method, ICIEventRule Interface AddIfStatement method, and ICISimpleCondition Interface.

AS2 Properties:

AS2Direction = 6009; BOOL; AS2 Direction
AS2Host = 6005; STRING; AS2 Host
AS2ID = 6011; STRING; AS2 EFT ID
AS2MessageID = 6004; STRING; AS2 Message ID
AS2Payload = 6000; STRING; AS2 Payload
AS2MDN = 6001; STRING; AS2 MDN
AS2LocalMIC = 6002; STRING; AS2 Local MIC
AS2RemoteMIC = 6003; STRING; AS2 Remote MIC
AS2TransactionError = 6006; STRING; AS2 Transaction Error
AS2TransactionResult = 6007; STRING; AS2 Transaction Result
AS2TransactionVerbose = 6008; STRING; AS2 Transaction Verbose
AS2PartnerID = 6010; STRING; AS2 Partner ID
AS2TypeOfContent = 6012; INT; AS2 Content Type

Advanced Workflow Properties (7.4.7 and later):

AWTaskName = 12000
AWLogPath
AWErrorCode
AWErrorDescription
AWErrorLine
AWResultCode
AWResultDescription
AWExecutionTimeMilliseconds

Context Variable properties (v7.2 and later):

ContextVariable = 8000; STRING

Data Types:

INT = Any signed 32-bit integer: -1, 100, -123123, 6547474
DWORD = Any unsigned 32-bit integer: 0, 1, 98765
STRING = Any string: "Hello", "world"
IP = IP or IP mask: "127.0.0.1", "192.168.*.*", "1-100.1-100.1-100.1-100"
PATH = Physical path: "d:\folder1\", "e:\file.txt"
BOOL = Boolean value: VARIANT_TRUE, VARIANT_FALSE
VPATH = Virtual path: "/Usr/User1/", "/etc/tmp"
LIST = List of strings or paths: See STRING or PATH
ULONGLONG = Unsigned 64-bit integer: 123123123123

Client Properties:

ClientLogin = 4000; LIST; Logon Name
ClientPassword = 4001; LIST; Logon Password
ClientAccessGroup = 4002; LIST; User Groups
ClientEnabled = 4003; BOOL; Account Enabled
ClientSettingsLevel = 4004; INT; Settings Template (Value comes from the ICIClientSettings.ID property of the Settings Template.)
ClientFullName = 4005; STRING; Full Name
ClientDescription = 4006; STRING; Description
ClientComment = 4007; STRING; Comment
ClientEMail = 4008; STRING; Email Address
ClientPhone = 4009; STRING; Phone Number
ClientPager = 4010; STRING; Pager Number
ClientFax = 4011; STRING; Fax Number
ClientHomeFolder = 4012; VPATH; Home Folder
ClientHomeFolderIsRoot = 4013; BOOL; Home folder is root
ClientQuotaMax = 4014; INT; Quota Max
ClientQuotaUsed = 4015; INT; Quota Used
ClientInvalidLoginAttempts = 4016; DWORD; Invalid login attempts
ClientCanChangePassword = 4017; BOOL; User can change password
ClientIP = 4018; IP; Home IP
ClientSSLAllowed = 4019; BOOL; User can connect using SSL
ClientFTPAllowed = 4020; BOOL; User can connect using FTP
ClientSFTPAllowed = 4021; BOOL; User can connect using SFTP
ClientLastLogin = 4022; STRING; Last Login Date
ClientPasswordExpiration = 4023; STRING; Password Expiration Date
ClientMustResetPasswordAtFirstLogin = 4024; BOOL; User Must Change Password at Next Login
ClientAccountExpirationDate = 4025; STRING; Account Expiration Date
ClientAccountLocked = 4026; BOOL; Account Locked Out
ClientCustomField1 = 4027; STRING; Custom Field 1
ClientCustomField2 = 4028; STRING; Custom Field 2
ClientCustomField3 = 4029; STRING; Custom Field 3
ClientGDPREUSubjectStatus = 13000 (&H32C8) (added in v8; used in Event Rules)
ClientGDPRPPConsentStatus = 13001 (&H32C9) (added in v8 used in Event Rules)
ClientGDPRTOSConsentStatus = 13002 (&H32CA) (added in v8; used in Event Rules)
GDPRRightExercised = 13003 (&H32CB) (added in v8; used in Event Rules)
GDPRRightExercisedArticleID = 13004 (&H32CC) (added in v8; used in Event Rules)
GDPRReasonGiven = 13005 (&H32CD) (added in v8; used in Event Rules)

Connection Properties:

LocalIP = 3000; IP; Local IP
RemoteIP = 3001; IP; Remote IP
LocalPort = 3002; DWORD; Local Port
RemotePort = 3003; DWORD; RemotePort
Protocol = 3004; INT; Protocol
WebTransferClientConnection = 3005; BOOL
HttpQueryString = 3006; STRING (v7.2 and later)
HttpHeadersList = 3007; STRING (v7.2 and later)

File System Properties:

VirtualPath = 5000; LIST of VPATH; Virtual Path
PhysicalPath = 5001; LIST of PATH; Physical Path
DestinationVirtualPath = 5002; LIST of VPATH; Virtual Destination Path
DestinationPhysicalPath = 5003; LIST of PATH; Physical Destination Path
FolderName = 5004; LIST of PATH; Physical Folder Name
FileName = 5005; LIST of PATH; File Name
DestinationFolderName = 5006; LIST of PATH; Physical Destination Folder Name
DestinationFileName = 5007; LIST of PATH; Destination File Name
FileCRC = 5012; DWORD; File CRC
FileCreationDate = 5009; STRING; File Creation Date
FileCreationTime = 5010; STRING; File Creation Time
FileExtension = 5022 (&H139E) (added in v8)
FileSize = 5011; ULONGLONG; File Size
FolderOperation = 5008; STRING; File Change

Values:

rename
added
removed

ReportPath = 5013; STRING; Report File
ReportContent = 5014; STRING; Report Content
ReportFileName = 5015; STRING; Report File Name (v6.3.1 and later)
VirtualFolderName = 5016; STRING; Virtual Folder Name (v6.3.1 and later)
BaseFileName = 5017; STRING; The Base File Name is the portion of the filename to the left of the right-most period. The Base File Name was provided as a way to support rename. For example, if a file is downloaded as: SomeFile.ext.tmp, the Base File Name is: SomeFile.ext.
FileFolderExists = 5018; BOOL; Whether file or folder exists. (v7.2 and later)
CompressedPhysicalPath = 5019; STRING; Physical path of the file resulting from a compression action. (v7.2 and later)
FolderExists (v8.2 and later)
FileCreationDateTimeISO8601 (v8.2 and later)
FileModificationDateTimeISO8601 (v8.2 and later)
VirtualDirectoryName (v8.2 and later)

General Properties:

Time = 1; STRING; Event Time
Name = 2; STRING; Event Name
Reason = 3; INT; Event Reason
TimeStamp = 4; STRING; Event Time Stamp
DateStamp = 5; STRING; Event Date Stamp
MonitorFolderStatus = 6; STRING; Folder Monitor Health
EventName = 7; STRING; Event Full Name
TimeStampPrecise (v6.5 and later) = 8; STRING; Event Time Stamp, including milliseconds
FolderMonitorFailureReason (v6.5 and later) = 9; STRING; Folder Monitor Failure Reason
TransactionID = 10; STRING (v7.2 and later)

Server Properties:

ServerRunning = 1000; BOOL; Server Running
ServerLogOldName = 1001; PATH; Old Log File Name
ServerLogNewName = 1002; PATH; New Log File Name
ServerLogOldPath = 1003; PATH; Old Log File Path
ServerLogNewPath = 1004; PATH; New Log File Path
ServerLogType (v6.4 and later) = 1005; DWORD; Log File Format

Values:

2 = W3C Extended Log File Format
3 = Microsoft IIS Log File Format
4 = NCSA Common Log File Format
5 = No Log

ServerLogFolder = 1006; PATH; Log Location
ServerServerNodeName = 1007; STRING; Node Name

Site Properties:

SiteRunning = 2000; BOOL; Site Running
SiteName = 2001; STRING; Site name
SiteAccountManagementURL = 2002; STRING; Account Management URL
SiteDMZAddress
SiteDMZPort

Transfer properties (v7.2.1 and later):

TransferRate = 9000; ULONGLONG; Speed of transfer in Kbps (total bytes/total seconds)
TransferBytes = 9001; ULONGLONG; Number of bytes transferred.
TransferSeconds = 9002; ULONGLONG; Duration of transfer in seconds.

Workspace Properties

WSName = 7002
WSOwner = 7004
WSOwnerEmail (v7.2.1) = 7009
WSParticipants= 7003
WSPhysicalPath = 7001
WSUserAccountExists = 7008
WSUserEmail = 7007
WSUserName = 7005
WSUserPermissions = 7006
WSUserRemovalReason = 7009 (removed in v7.1.0; refer to ICISite - Single-Site Interface::RemoveWorkspace instead)
WSVirtualPath = 7000

EventReason (v6.3 and later)

EventReason allows you to specify the reason for a triggered event. It is a value type for Event Conditions (e.g., If event reason is "transfer failed due to file is of banned type," do this; otherwise, do that for On Upload Failed Event Rule). It can also be used in condition values:

ICIEventRule.AddIfStatement - creating new IF statement with "If Event Reason is equal to XXX" condition: Event Property is "Reason," value is one of EventReason enum
ICICompoundCondition.Add - (adding "If Event Reason is equal to XXX" condition to existing IF statement: Event Property is "Reason," value is one of EventReason enum
ICISimpleCondition.Value - retrieving/modifying "XXX" in existing "If Event Reason is equal to XXX" condition: value is one of EventReason enum.
Reasons:

ConnectFailedCertRejected (added v8)
ConnectFailedBannedIP = 11
ConnectFailedRestrictedIP = 10
ConnectFailedTooManyConnectionsPerIP = 9
ConnectFailedTooManyConnectionsPerSite = 8
DisconnectedByAdmin = 18
DisconnectedByConnection = 12
DisconnectedByError = 15
DisconnectedByIPBan = 16
DisconnectedByPasswordRetry = 17
DisconnectedByRequest = 13
DisconnectedByTimeout = 14
EmptyReason (added in v8)
FolderMonitorHealthFailed = 25
IPBannedByUserAccountAction (added in v8)
IPBannedDOS = 28
IPBannedDOSTemporary (added in v8)
IPBannedInvalidPassword = 29
IPBannedInvalidUsername = 30
IPBannedTooManyInvalidCommands (added in v8)
LoginFailedAccoundLocked = 27 (the "d" is not a typo)
LoginFailedAccountDisabled = 2
LoginFailedPasswordNotAccepted = 1 (in v6.3.0.57, the "t" in "Accepted" is missing)
LoginFailedProtocolNotSupported = 6
LoginFailedRestrictedIP = 7
LoginFailedTooManyConnectionPerUser = 4
LoginFailedTooManyConnectionsPerIP = 5
LoginFailedTooManyConnectionsPerSite = 3
TransferFailedAborted = 21
TransferFailedAccessDenied = 20
TransferFailedBannedFile = 19
TransferFailedConnectionClosed = 22
TransferFailedFileNotFound = 23
TransferFailedQuotaExceeded = 24
TransferFailedXCRCCheckFailed = 26

EventRuleSchedulingAlgorithm (v7.0 and v7.0.1)

RoundRobinEventRuleSchedulingAlgorithm = 1

EventRuleStatementType (v6.0 and later)

Used in the ICIActionStatement Interfacetype property, the ICIIfStatement Interfacetype property, and the ICILoopDatasetStatement type property.

ActionStatement = 0
IfStatement = 1
LoopDatasetStatement = 2 (added in EFT v8.0.4)

EventType (v6.0 and later)

Used to specify the type of event trigger ICISite Interface EventRules method and the ICIEventInfo Interface and ICIEventRuleStatement Interfacetype properties.

BeforeFileDownload = 20483 (&H5003)
BeforeWorkspaceDeleted = 28675 (&H7003) (EFT v7.1- v8.0.5; renamed to OnWorkspaceBeforeDelete)
EventRuleSubroutine = 36865 (&H9001) (EFT v8 and later)
MonitorFolder = 4101 (&H1005)
OnAS2InboundTransactionSucceeded = 24577 (&H6001) (v6.3.0 and later; "On" added in 6.3.) = 24577; AS2 Inbound Transaction Succeeded
OnAS2InboundTransactionFailed = 24578 (&H6002) (v6.3.0 and later; "On" added in 6.3.1) = 24578; AS2 Inbound Transaction Failed
OnAS2OutboundTransactionSucceeded = 24579 (&H6003) (v6.3.0 and later; "On" added in 6.3.1) = 24579; AS2 Outbound Transaction Succeeded
OnAS2OutboundTransactionFailed = 24580 (&H6004) (v6.3.0 and later; "On" added in 6.3.1) = 24580; AS2 Outbound Transaction Failed
OnChangeFolder = 20491 (&H500B) Folder Changed
OnClientConnected = 12289 (&H3001) = 12289; User Connected
OnClientConnectionFailed = 12290; User Connect Failed
OnClientCreated = 16391 (&H4007); New User Created
OnClientDeleted = 16393 (&H4009) (v6.4.5 and later) = 16393; User Account Deleted
OnClientDisabled = 16385 (&H4001) = 16385; User Account Disabled
Const OnClientDisconnected = 12291 (&H3003); User Disconnected
OnClientEnabled = 16394 (&H400A) (v6.4.5 and later) = 16394; User Account Enabled
OnClientLocked = 16392 (&H4008) (v6.1.0 and later) = 16392; User Account Locked
OnClientLoggedIn = 16388 (&H4004); User Logged in
OnClientLoggedOut = 16387 (&H4003); User Logged out
OnClientLoginFailed = 16389 (&H4005); User Login Failed
OnClientPasswordChanged = 16390 (&H4006); User Password Changed
OnClientQuotaExceeded = 16386 (&H4002); User Quota Exceeded
OnCloudStorageMonitor = (&H8001) (added v7.4.6)
OnDownloadFailed = 20490 (&H500A) ; Download Failed
OnFileDeleted = 20481 (&H5001); File Deleted
OnFileDownload = 20484 (&H5004); File Downloaded
OnFileMoved = 20492 (&H500C); File Moved
OnFileRenamed = 20485 (&H5005); File Renamed
OnFileUpload = 20482 (&H5002); File Uploaded
OnFolderCreated = 20486 (&H5006); Folder Created
OnFolderDeleted = 20487 (&H5007); Folder Deleted
OnGDPRRightExercised (added in v8)
OnIPAddedToBanList = 8195 (&H2003) (v6.3.0 and later); IP Added to Ban List
OnLogRotate = 4098 (&H1002); Log Rotated
OnMonitorFolderFailed = 4102 (&H1006); Folder Monitor Failed
OnSecureMessageAttachmentAfterDownload
OnSecureMessageAttachmentBeforeDownload
OnSecureMessageComposed
OnSecureMessageNotSent
OnSecureMessageSent
OnSecureMessageViewed
OnServiceStarted = 4100 (&H1004); Service Started
OnServiceStopped = 4099 (&H1003); Service Stopped

OnSiteStarted = 8193 (&H2001); Site Started
OnSiteStopped = 8194 (&H2002); Site Stopped
OnTimer = 4097 (&H1001); Scheduler (Timer) Event
OnUploadFailed = 20489 (&H5009); Upload Failed
OnVerifiedUploadFailure = 20494 (&H500E); Verified Upload Failed
OnVerifiedUploadSuccess = 20493 (&H500D); Verified Upload Succeeded
OnVerifiedDownloadFailure = 20496 (&H5010); Verified Download Failed
OnVerifiedDownloadSuccess = 20495 (&H500F); Verified Download Succeeded
OnWorkspaceBeforeDelete (added v8.0.6; formerly BeforeWorkspaceDeleted )
OnWorkspaceCreated = 28673 (&H7001) (added v7.1)
OnWorkspaceDeleted = 28674 (&H7002) (added v7.1)
OnWorkspaceExpired
OnWorkspaceUserInvited = 28676 (&H7004) (added v7.1)
OnWorkspaceUserJoins = 28677 (&H7005) (added v7.1)
OnWorkspaceUserRemoved = 28678 (&H7006) (added v7.1)
RESTInvocation = 0x9002 (added v8.0.5)

FileDateFormat (added v8.0.4)

Used in ICIGetListingActionParams FileDateFormat property.

FileDateFormat_Default,
FileDateFormat_Epoch,
FileDateFormat_ISO8601

FileEncodingType (v7.2 and later)

Used in the ICIFileActionParams Interface Encoding property.

ANSI = 0 (v7.2 - 8.0.4.x)
UTF8 = 1 (v7.2 - 8.0.4.x)
Unicode = 2 (v7.2 - 8.0.4.x)
UnicodeBigEndian = 3 (v7.2 - 8.0.4.x)
EncodingANSI = 0 (v8.0.5 and later)
EncodingUTF8 = 1 (v8.0.5 and later)
EncodingUnicode = 2 (v8.0.5 and later)
EncodingUnicodeBigEndian = 3 (v8.0.5 and later)

FileOperationType (v7.2 and later)

Used in the ICIFileActionParams Interface Operation property.

FileRead=0 (v8.0.5 and later)
FileWrite=1 (v8.0.5 and later)
FileRename=2 (v8.0.5 and later)
FileDelete=3 (v8.0.5 and later)
FileConcatenate=4 (v8.0.5 and later)
FileChecksum = 5 (v8.0.5 and later)
FileCreate = 0 (v7.2 - v8.0.4)
FileRename = 1 (v7.2 - v8.0.4)
FileDelete = 2 (v7.2 - v8.0.4)

FileOverwriteOptions (v7.2 and later)

Used in the ICIFileActionParams Interface OverwriteOption property.

Overwrite = 0
Numerate = 1
Skip = 2

FolderMonitorPollIntervalType (v6.5 and later)

Used to specify Folder Monitor polling by seconds, minutes, or hours.

FMPISeconds = 0; use seconds
FMPIMinutes = 1; use minutes
FMPIHours = 2; use hours

FolderOperationType (v7.2 and later)

Used in the ICIFolderActionParams Interface Operation property.

FolderCreate = 0
FolderRename = 1
FolderDelete = 2

FTPDataConnectionMode (v6.2.18 and later)

Used in the ICITransferActionParams Interface FTPDataConnectionMode property used to specify the mode of FTP data connection.

FTPMode_Auto = 2
FTPMode_EPRT (EFT v6.4 and later) = 3
FTPMode_EPSV (EFT v6.4 and later) = 4
FTPMode_PASV = 1
FTPMode_PORT = 0

GDPRPrivacyPolicyConsentStatus (added in v8)

Used in ICIClientSettings::Get/SetGDPRPrivacyPolicyConsentStatus method.

PPConsent_Unknown,
PPConsent_Granted_implicit,
PPConsent_Granted_explicit,
PPConsent_Denied,
PPConsent_Rescinded,

GDPRPrivacyPolicyMode (added in v8)

Used in ICIPrivacyPolicy::Mode property.

GDPRPrivacyPolicyMode_Disabled,
GDPRPrivacyPolicyMode_Shown,
GDPRPrivacyPolicyMode_ConsentRequired

GDPRTermsOfServiceConsentStatus (added in v8)

Used in ICIClientSettings::GetGDPRTermsOfServiceConsentStatus.

ToSConsent_Unknown,
ToSConsent_Agreed_implicit,
ToSConsent_Agreed_explicit,
ToSConsent_Disagreed,
ToSConsent_Withdrawn

GDPRTermsofServiceMode (added in v8)

Used in ICITermsOfService::Mode property.

GDPRTermsOfServiceMode_Disabled,
GDPRTermsOfServiceMode_Implied,
GDPRTermsOfServiceMode_Mandatory

GDPRSubjectStatus (added in v8)

Used in ICIClientSettings::Get/SetGDPRSubjectStatus method.

Subject_Unknown,
Subject_Yes,
Subject_No,

GoogleDriveMatchingFileNamePolicy

GoogleDriveMatchingFileNamePolicy_Overwrite = 0
GoogleDriveMatchingFileNamePolicy_Skip = 1
GoogleDriveMatchingFileNamePolicy_Numerate = 2

HADeploymentScenario (added in v7.4)

HAAwsSnsSqsDeploymentScenario = 1
HAMsmqDeploymentScenario = 0

HAUpgradeNodeState (added in v8.1)

Used with ICIServer method GetHAUpgradeNodeState.

NewNode
NotInUpgrade
OldNode

IcapErrorsPolicy (v8.0.5 and later)

Used in the ICIContentIntegrityControlProfile interface.

Fail = 0
Continue = 1

IcapMaxScanSizeUnits (v7.0.3 and later)

Used in the ICIContentIntegrityControlProfile interface

ScanSizeBytes = 0
ScanSizeKBytes = 1
ScanSizeMBytes = 2
ScanSizeGBytes = 3

ICAPMode (v7.0.3 and later)

Used in theICIContentIntegrityControlProfile.

REQMOD
RESPMOD

IndirectCollectionType (v8 and later)

Used in the ICIGDPRSettings Interface IndirectCollection property.

IndirectCollection_Unknown,
IndirectCollection_EFT,
IndirectCollection_External,
IndirectCollection_Other,
IndirectCollection_NotApplicable

IPAccessRuleType (v6.3 and later)

Server.GetIPAccessRules, Site.GetIPAccessRules, and Client.GetIPAccessRules return the array of ICIIPAccessRule (which can be either Manual or Autoban); ICIAutobanIPAccesRule.BannedIPs is the array of ICIBannedIP. All are read-only properties; to modify IP Access, use the corresponding methods of Server, Site, or Client (Move, Remove, Unban, etc).

AutobanIPRule = 0
ManualIPRule = 1

Example (VBScript):

rules = oServer.GetIPAccessRules()
For Each key In rules
If key.type = 0 Then
WScript.echo "AutoBan"
End if
If key.type = 1 Then
WScript.echo "Manual " + key.address
End if
Next

LawfulnessOfProcessingType (v8 and later)

Used in the ICIGDPRSettings Interface LawfulnessOfProcessingType property.

LawfulnessOfProcessing_Unknown,
LawfulnessOfProcessing_DataSubjectConsent,
LawfulnessOfProcessing_Contractual
LawfulnessOfProcessing_Other,
LawfulnessOfProcessing_NoPD,
LawfulnessOfProcessing_NotApplicable

LDAPSearchScope (v6.3 and later)

Used in the ICILDAPAuthManagerSettings Interface SearchScope property.

Scope_Base = 0
Scope_OneLevel = 1
Scope_Subtree = 2

LDAPVersion (v6.3 and later)

Used in the ICILDAPAuthManagerSettings Interface LDAPVersion property.

LDAP_Version2 = 2
LDAP_Version3 = 3

LimitedAccessType (v8 and later)

Used in the ICIGDPRSettings Interface LimitedAccessType property.

LimitedAccess_ConfiguredByEFT
LimitedAccess_CompensatingControl,
LimitedAccess_NotApplicable

LogicalOperator (v6.1 and later)

Used in the ICICompoundCondition Interface Operator property.

LogicalOr = 0
LogicalAnd = 1

LogMode (v6.3 and later)

Used in the ICIServer Interface LogMode property to specify the logging mode.

LogModeStandard = 0
LogModeVerbose = 1

LoopOrderType (v8.0.4 and later)

Used in the ICILoopDatasetStatementParams interface to specify loop order in ICILoopDatasetStatementParams LoopOrder property.

LoopOrderType_Original,
LoopOrderType_Ascending,
LoopOrderType_Descending

MaterialScopeType (v8 and later)

Used in the ICIGDPRSettings Interface.

MaterialScope_Unknown = 0
MaterialScope_InScope = 1
MaterialScope_NotInScope = 2

MatchingFileOption (v8.0.5 and later)

MatchingFileAppend = 0,
MatchingFileSkip = 1,
MatchingFileNumerate = 2,
MatchingFileOverwrite = 3,
MatchingFileFail = 4

MFAType (v8.0.4 and later)

Used in the WorkspacesMfaType property.

MfaType-email
MfaType_sms
MfaTpe_eitiher

Month (v6.3 and later)

Used in the ICITimerEventRuleParams Interface YearlyMonth property.

Month_January = 0
Month_February = 1
Month_March = 2
Month_April = 3
Month_May = 4
Month_June = 5
Month_July = 6
Month_August = 7
Month_September = 8
Month_October = 9
Month_November = 10
Month_December = 11

NecessityType (v8 and later)

Used in the ICIGDPRSettings Interface Necessity property.

Necessity_ConfiguredByEFT
Necessity_Other,
Necessity_NotApplicable

NetworkProtocol (v6.1 and later)

Used in the ICITransferActionParams Interface Protocol property.

ProtocolLocal = -1
ProtocolFTP = 0
ProtocolFTPS = 1
ProtocolFTPSExpl = 2
ProtocolSFTP = 3
ProtocolHTTP = 4
ProtocolHTTPS = 5
ProtocolFTPSAuthTLS = 8

PGPCompressionLevel (v6.1 and later)

Used to specify the compression level for a PGP encryption operation in the ICIPgpActionParams Interface CompressionLevel property.

NoCompression = 0
CompressionLevel1 = 1
CompressionLevel2 = 2
CompressionLevel3 = 3
CompressionLevel4 = 4
CompressionLevel5 = 5
CompressionLevel6 = 6
CompressionLevel7 = 7
CompressionLevel8 = 8
CompressionLevel9 = 9

PGPKeyCipher (v6.3 and later)

Used in the ICIServer Interface CreatePGPKey method (prior to v8) and ICISite Interface CreatePGPKey method (added in v8) to specify the PGP key cipher.

PGPKeyCipher_IDEA = 0
PGPKeyCipher_3DES = 1
PGPKeyCipher_CAST5 = 2
PGPKeyCipher_AES128 = 3
PGPKeyCipher_AES192 = 4
PGPKeyCipher_AES256 = 5
PGPKeyCipher_TWOFISH = 6

PGPKeyType (v6.3 and later)

Used in the ICIServer Interface CreatePGPKey method (prior to v8) and ICISite Interface CreatePGPKey method (added in v8) to specify the PGP key type.

PGPKeyType_DSS = 0
PGPKeyType_RSA = 1
PGPKeyType_RSALegacy = 2

PGPLogLevel (v6.3 and later)

Used in the ICISite Interface PGPLogLevel property to specify the PGP module log level.

PGPLogLevelStandard = 0
PGPLogLevelVerbose = 1
PGPLogLevelDebug (added in v8)

PGPOperation (v6.0 and later)

Used to specify the PGP operation to perform on a file in the ICIPgpActionParams Interface Operation property.

Encrypt = 0
EncryptAndSign = 1 (added in v6.1)
Sign = 2 (added in v6.1)
SDA = 3 (added in v6.1)
Decrypt = 4 (added in v6.1)
DecryptAndVerify = 5 (added in v6.3)
VerifyOnly = 6 (added in v6.3)

PGPSigningHash (v6.1 and later)

Used to specify the hash algorithm for a PGP signing operation in the ICIPgpActionParams Interface SigningHash property.

MD5Hash = 0
SHA1Hash = 1
RIPEMD160Hash = 2
SHA256Hash = 3
SHA384Hash = 4
SHA512Hash = 5

PredefinedReportPeriod (v6.1 and later)

Used to specify one of the predefined reporting periods in the ICIReportActionParams Interface CustomDate property.

AllDates = 0
MonthToDate = 1
QuarterToDate = 2
YearToDate = 3
CurrentWeek = 4
CurrentMonth = 5
CurrentQuarter = 6
CurrentYear = 7
LastWeek = 8
LastMonth = 9
LastQuarter = 10
LastYear = 11
Last30Days = 12
Last12Months = 13
Today = 14 (added in v6.2.3)
Yesterday = 15 (added in v6.2.3)
Last24Hours = 16 (added in v6.2.3)

PrePostTransferCommand (v7.1.1 and later)

Used in the TransferActionParams interface.

None = 0
CreateFolder = 1
RemoveFolder = 2
RenameFile = 3
Delfile = 4
MainframeSupport = 5

ProcessingPrinciplesType (v8 and later)

Used in the ICIGDPRSettings Interface ProcessingPrinciples property.

ProcessingPrinciples_Unknown,
ProcessingPrinciples_NoMet,
ProcessingPrinciples_Met,
ProcessingPrinciples_NotInScope

ProxyAuthenticationType (v6.2.31 and later)

Used in the ICITransferActionParams Interface ProxyAuthenticationType property used to specify the proxy authentication type.

ProxyAuthUserAtSite = 0
ProxyAuthSite = 1
ProxyAuthUserWithLogon = 2
ProxyAuthUserPassAcct = 3
ProxyAuthOpenSite = 4
ProxyAuthCustom = 5

ProxyType (v6.2.31 and later)

Used in the ICITransferActionParams Interface, ICIDownloadActionParams Interface, and ICIUploadActionParams Interface ProxyType property used to specify the type of Proxy.

ProxyTypeFTP = 1
ProxyTypeHTTP = 2
ProxyTypeDMZ = 3

PurposeType (v8 and later)

Used in the ICIGDPRSettings Interface Purpose property.

Purpose_ConfiguredByEFT
Purpose_Other,
Purpose_NotApplicable

Recurrence (v6.3 and later)

Used in the ICITimerEventRuleParams Interface Recurrence property.

Recurrence_Continually = 0
Recurrence_Daily = 1
Recurrence_Weekly = 2
Recurrence_Monthly = 3
Recurrence_Yearly = 4
Recurrence_Once = 5
Recurrence_Calendar = 6

RegistrationState (v6.1 and later)

Used in the ICIServer Interface ModuleRegistrationState method to retrieve EFT module registration status. Used with the ServerModule enumerators.

Registered = 0
Evaluation = 1
Expired = 2

Relation (v6.3 and later)

Used in the ICITimerEventRuleParams Interface MonthlyRelativeWeekday and YearlyRelativeWeekday properties to specify the relation of one weekday to the month or year (e.g., first weekday of the month, last weekday of the year).

Relation_First = 0; first weekday
Relation_Second = 1; second weekday
Relation_Third = 2; third weekday
Relation_Fourth = 3; fourth weekday
Relation_Last = 4; last weekday

RepeatPattern (v6.3 and later)

Used in the ICITimerEventRuleParams Interface RepeatPattern property to specify a pattern for Timer Event Rules (e.g., repeats every hour, repeats every 30 minutes, etc.).

RepeatHours = 0
RepeatMinutes = 1
RepeatSeconds = 2

ReportFilterOperator (v6.1 and later)

Used to specify a report filter operator in the ICIReportActionParams Interface FilterOperator1 and FilterOperator2 properties.

NoFilter = -1
EqualFilter = 0
NotEqualFilter = 1
LessFilter = 2
LessOrEqualFilter = 3
GreaterFilter = 4
GreaterOrEqualFilter = 5
ContainsFilter = 6
StartsWithFilter = 7

ReportFiltersCombiningOperator (v6.1 and later)

Used to specify the way of combining two report filters in the ICIReportActionParams Interface FilterAndOr property.

NoCombining = -1
AndCombining = 0
OrCombining = 1

ReportFormat (v6.1 and later)

Used to specify the report format in the ICIReportActionParams Interface ReportFileFormat property.

HTMLFormat = 0
PDFFormat = 1
VPFormat = 2

ReportPeriodType (v6.1 and later)

Used to specify a type of reporting period (range or predefined) in the ICIReportActionParams Interface DateFormat property.

Predefined = 0
Range = 1

RESTInvocationAuthType (v8.0.5 an later)

Used in the ICIRESTInvocationAuthParams interface.

RIAT_None = 0,
RIAT_PGsClient = 1,
RIAT_TokenSecret = 2,
RIAT_PowerShellScript = 3

RESTInvocationVerifyType (v8.0.5 and later)

Used in the ICIRESTInvocationVerifyParams interface.

RIVT_None = 0,
RIVT_PowerShellScript = 1

RightStateType (v8 and later)

Used in the ICIGDPRSettings Interface RightOfAccess, RightToBeForgotten, RightToExport, RightToObject, RightToRectify, and RightToRestrict properties.

RightState_Unknown,
RightState_ViaWTC,
RightState_UponRequest,
RightState_Other,
RightState_NotApplicable

RightToBeNotifiedStateType (v8 and later)

Used in the ICIGDPRSettings Interface RightToBeNotified property.

RightToBeNotifiedState_Unknown,
RightToBeNotifiedState_ViaEventRules,
RightToBeNotifiedState_UponRequest,
RightToBeNotifiedState_Other,
RightToBeNotifiedState_NotApplicable

RiskAssessmentType (v8 and later)

Used in the ICIGDPRSettings Interface RiskAssessment property.

RiskAssessment_EFTGeneratedDPIAReport,
RiskAssessment_Other,
RiskAssessment_NotApplicable

RiskMitigationType (v8 and later)

Used in the ICIGDPRSettings Interface RiskMitigation property.

RiskMitigation_ConfiguredByEFT
RiskMitigation_Other,
RiskMitigation_NotApplicable

SecretsModuleType (v8.0.1 and later)

SecretsModuleType_LocalPasswordsStorage,
SecretsModuleType_AzureKeyVault,
SecretsModuleType_AzureKeyVaultManagedIdentities

ServerModule (v6.1 and later)

Used in the ICIServer Interface ModuleRegistrationState method to retrieve an EFT module state. Used with the RegistrationState enumerator.

Const EFTServer = 0
Const SSHModule = 1
Const HTTPModule = 2
Const WTCModule = 3
Const ARModule = 4
Const PGPModule = 5
Const HSModule = 6 (In v7.4.7 and later, this is for the ASM (in Enterprise) or the ESM (in Express)
Const AS2Module = 7
Const AWModule = 8
Const DMZGWModule = 9
Const FolderMonitorEventModule = 10 (v7.2.2 and later)
Const TimerEventModule = 11 (v7.2.2 and later)
Const FileTransferClientModule = 12 (v7.2.2 and later)
Const WorkspacesModule = 13 (v7.2.3 and later)
Const AccelerateModule = 14 (v7.3 and later)
Const AAMModule = 15 (v7.3.3 and later)
Const MTCModule = 16 (v7.3.9 and v7.4.7 and later)
Const CICModule = 17 (v7.3.9 and v7.4.7 and later)
Const CCMModule = 18 (v7.3.9 and v7.4.7 and later)
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)

ServerNodeSiteState (v7.2.1 and later)

Used for the ICIServerNodeSiteInfo Interface State property to specify state of cluster node.

SiteIsRunning = 0
SiteIsStopped = 1
SiteFailedToStart = 2

SFTPAdvBool (v6.0 and later)

Used in numerous properties and methods. Difference between VARIANT_BOOL and SFTPAdvBool.

abFalse = 0
abTrue = 1
abInherited = -2

SizeUnits (v7.4.2 and later)

Used in the ICISite interface SetWorkspacesDropOffMaxMessageSize method.

SizeUnits_MByte = 0,
SizeUnits_GByte = 1
Size_Units_TByte = 2 (added v8.1)

SMTPAuthType (8.2 and later)

SMTPAuthType_Off,
SMTPAuthType_Login,
SMTPAuthType_XOAuth2

SOCKSType (v6.2.31 and later)

Used in the ICIDownloadActionParams Interface Properties ICITransferActionParams Interface, and ICIUploadActionParams InterfaceSOCKSType property to specify the SOCKS proxy type for a transfer action.

SOCKSNone = -1
SOCKS4 = 0
SOCKS5 = 1

StopType (v6.1 and later)

Used in the ICIStopActionParams InterfaceAction property.

StopRule = 2
StopEvent = 4
StopRuleAndEvent = 6

SuppressForgotPasswordMode (v7.4.11 and later)

Allows you to suppress the ability for users to reset their password for all domains, only internal domains, or only external domains.

SuppressForgotPasswordMode_AllDomain,
SuppressForgotPasswordMode_OnlyInternalDomain,
SuppressForgotPasswordMode_OnlyExternalDomain

SyncDirectionType (v8.0.5 and later)

Used in the ICISynchronizeActionParams interface to specify whether to mirror locally or remotely.

SyncDT_MirrorRemote,
SyncDT_MirrorLocal

SyncOverwriteType (v8.0.5 and later)

Used in the ICISynchronizeActionParams interface to specify whether to overwrite, skip by file size, or skip by file size and time.

SyncOT_UseOverwrite,
SyncOT_SkipByFileSize,
SyncOT_SkipByFileSizeAndTime

TerritorialScopeType (v8 and later)

Used in the ICIGDPRSettings Interface TerritorialScope property.

TerritorialScope_Unknown,
TerritorialScope_InUnion,
TerritorialScope_NotInUnion,
TerritorialScope_InScope,
TerritorialScope_NotInScope

TimeUnits (v7.3.3 and later)

The TimeUnits enum is used in the ICISite interface Get/SetWorkspacesMacDuration and Get/SetWorkspacesMacOAIDuration methods.

TimeUnits_Minute = 0,
TimeUnits_Hour = 1,
TimeUnits_Day = 2,
TimeUnits_Week = 3,
TimeUnits_Month = 4,
TimeUnits_Year = 5

TransferEncodingType (v6.5 and later)

Allows you to specify transfer encoding mode. Used in the ICISite interface SFTPEncoding and FTPEncoding properties, and the ICITransferActionParams interface TransferEncoding property.

TransferEncodingAutoDetect = 0; Automatically detect encoding
TransferEncodingUTF8 = 1; Use UTF-8 encoding
TransferEncodingASCII = 2; Use ASCII encoding

TransferOverwriteType (v6.2.31 and later)

Used in the ICIDownloadActionParams Interface, ICITransferActionParams Interface, and ICIUploadActionParams InterfaceOverwriteType property used to specify how to replace files that have the same names when transferring files.

TransferOTOverwrite = 0; Always overwrite
TransferOTSkip = 1; Never overwrite
TransferOTSmart = 2; Check CRC; if CRCs are equal, skip, otherwise, overwrite
TransferOTNumerate = 3; Create new file with same name plus a number

TransferSafeguardsType (v8)

Used in the ICIGDPRSettings Interface TransferSafeguards property.

TransferSafeguards_ConfiguredByEFT,
TransferSafeguards_Other,
TransferSafeguards_NotApplicable

TransparentInformationType (v8 and later)

Used in the ICIGDPRSettings InterfaceTransparentInformation property.

TransparentInformation_Unknown,
TransparentInformation_EFT,
TransparentInformation_External,
TransparentInformation_Other,
TransparentInformation_NotApplicable

TwoFactorAuthenticationMode (v6.3 and later)

Used in the ICISite InterfaceTwoFactorAuthentication property to specify special authentication mode for Site users.

TwoFactorAuth_None = 0
TwoFactorAuth_RADIUS = 1
TwoFactorAuth_RSA = 2

UploadFormComType (v8.0.4 and later)

Used in the ICIUploadForm interface type property to define when to show the Upload Form, for each file upload or once for batch upload.

UploadFormComType_File,
UploadFormComType_Batch

UploadFormElementComType (v8.0.4 and later)

Used in the ICIUploadFormElement interface type property to define the form element type .

UploadFormElementComType_String,
UploadFormElementComType_Multistring,
UploadFormElementComType_Dropdown,
UploadFormElementComType_Radio,
UploadFormElementComType_Toggle

UserAccountActionType (7.4.13 and later)

Used in ICIUserAccountActionParams to specify property action.

BanAccountIPPermanently
BanAccountIPTemporarily
DeleteAccount
DeleteAccountRetainVFS
DisableAccount
EnableAccount = 7 (added in v8);
KickUser
LockAccountForNMinutes
PersonalDataDeleteFields = 8 (added in v8)
PersonalDataResetToDefaults = 12 (added in v8)
PersonalDataSetEnabled = 9 (added in v8)
PersonalDataSetModifiable = 10 (added in v8)
PersonalDataSetVisible = 11 (added in v8)
SetEUDataSubjectStatus = 15 (added in v8)
SetPrivacyPolicyConsent = 13 (added in v8)
SetTermsOfServiceConsent = 14 (added in v8)

VirtualFolderType (8.0.6 and later)

VirtualFolderType_None = 0,
VirtualFolderType_PhysicalFolder = 1,
VirtualFolderType_AWSS3Storage = 2,
VirtualFolderType_AzureStorage = 3,
VirtualFolderType_ConnectionProfile = 4
VirtualFolderType_GoogleDriveStorage = 5

WebServiceVerbType (v7.2 and later)

Used in the ICIWebServiceActionParams interface Verb property.

VerbGet = 0
VerbPost = 1
VerbPut= 2
VerbDel = 3

WebSSONameOrAttribute (v7.3.3 and later)

WebSSONameId = 0,
WebSSOAttribute = 1

WebSSONameOrAttributeIdentifierFormat (v7.3.3 and later)

Unspecified = 0
EmailAddress = 1
X509SubjectName = 2
WindowsDomainQualifiedName = 3
KerberosPrincipalName = 4
EntityIdentifier = 5
URIReference = 6
Basic = 7

Weekday (v6.3 and later)

Used in the ICITimerEventRuleParams InterfaceMonthlyWeekday and YearlyWeekday properties to specify the day of the week.

Weekday_Sunday = 0
Weekday_Monday = 1
Weekday_Tuesday = 2
Weekday_Wednesday = 3
Weekday_Thursday = 4
Weekday_Friday = 5
Weekday_Saturday = 6
Weekday_Day = 7
Weekday_Weekday = 8
Weekday_Weekendday = 9

Weekdays (v6.1 - 6.2.31; replaced with Weekday, above)

Used in the ICITimerEventRuleParams InterfaceMonthlyWeekday and YearlyWeekday properties to specify the day of the week.

Sunday = 0
Monday = 1
Tuesday = 2
Wednesday = 3
Thursday = 4
Friday = 5
Saturday = 6

WorkspacesOAIPasscodeProtectionType (v8.0.2)

WorkspacesOAIPasscodeProtection_Required = 0
WorkspacesOAIPasscodeProtection_NotRequired = 1
WorkspacesOAIPasscodeProtection_SenderChooses = 2

WorkspacesOAISharingModeType (v7.3.3 and later)

This enum is used in the ICISite interface WorkspacesOAISharingMode property.

WorkspacesOAISharingMode_Users = 0,
WorkspacesOAISharingMode_UsersGuests = 1,
WorkspacesOAISharingMode_UsersGuestsAnonymous = 2

WorkspacesParticipationlessAccountPolicy (v7.4.6 and later)

Used in the ICISite interface WorkspacesGAParticipationlessAccountPolicy property.

Const WorkspacesParticipationlessAccountPolicy_Disable = 0
Const WorkspacesParticipationlessAccountPolicy_DeleteAccountOnly = 1
Const WorkspacesParticipationlessAccountPolicy_DeleteAccountAndHF = 2

WorkspacesSecureMessageBodyPolicy (v7.4.6 and later)

WorkspacesSecureMessageBodyPolicy_AlwaysSecure = 0
WorkspacesSecureMessageBodyPolicy_NeverSecure = 1
WorkspacesSecureMessageBodyPolicy_UserChoice = 2

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