Enum Reference

Below is a reference for the various enums used in the COM API.

ADAuthManagerLogonAttribute (v6.3 and later)

Used in the ICIADAuthManagerSettings LogonAttribute property.

Name	Value	Name	Value
NT4AccountName	0	UserPrincipalName	2
DisplayName	1	CommonName	3

ADAuthManagerType (v6.3 and later)

Used in the ICIADAuthManagerSettings type property.

Name	Value
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 and RemoveServerAdminAccount methods.

Name	Value
EFTAccount	0
LocalComputerAccount	1
ADAccount	2

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.

Name	Value
EFTLogin	0
IWALogin	1
NetLogon	2

AdminPermissionsPolicy (v6.1 and later)

Used in the ICIAdminPermission Permission property.

Name	Value	Description
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 COM API
ReportManagement	6	Can run and edit reports

ARMAuthenticationType (v6.3 and later)

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

Name	Value
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.

Name	Value	Description
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.

Name	Value
AS2AuthTypeUsernameAndPassword	0
AS2AuthTypeMsgLevelSecurity	1

AS2ContentType (v6.1 and later)

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

Name	Value	Name	Value
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.

Name	Value
AS2DoubleContentPolicyOverwrite	0
AS2DoubleContentPolicyNumerate	1
AS2DoubleContentPolicyReject	2

AS2DoubleMsgIDPolicy (v6.3 and later)

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

Name	Value
AS2DoubleMsgIDPolicyAccept	0
AS2DoubleMsgIDPolicyReject	1

AS2EncryptMissingPolicy (v6.3 and later)

Used in the ICIAS2InboundSettings EncryptMissingPolicy property.

Name	Value
AS2EncryptMissingPolicyAccept	0
AS2EncryptMissingPolicyReject	1

AS2IDMismatchPolicy (v6.3 and later)

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

Name	Value
AS2IDMismatchPolicyAccept	0
AS2IDMismatchPolicyReject	1

AS2OutboundProfileStatus (v6.3 and later)

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

Name	Value	Name	Value
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.

Name	Value
AS2ProxyDMZ	0
AS2ProxyHTTP	1

AS2ReceiptDelivery (v6.1 and later)

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

Name	Value
Sync	0
Async	1

AS2ReceiptPolicy (v6.1 and later)

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

Name	Value
NoReceipt	0
UnsignedReceipt	1
SignedReceipt	2

AS2SignatureMissingPolicy (v6.3 and later)

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

Name	Value
AS2SignatureMissingPolicyAccept	0
AS2SignatureMissingPolicyReject	1

AS2TransactionDirection (v6.3 and later)

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

Name	Value
AS2TransDirectionInbound	0
AS2TransDirectionOutbound	1

AS2TransactionStatus (v6.3 and later)

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

Name	Value
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.

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

AWLogMode (v6.5 and later)

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

Name	Value	Description
AWLogNone	0	no logging
AWLogMinimal	1	minimal logging
AWLogNormal	2	normal logging
AWLogVerbose	3	verbose logging

CertificateFormat (v6.3 and later)

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

Name	Value	Description
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

ConditionOperator (v6.1 and later)

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

Name	Value	Name	Value
Equals	1	MemberOf	32
Less	2	OneOf	64
LessOrEquals	4	StartsWith	128
Contains	8	Greater (added in v6.3.1)	256
Match	16	GreaterOrEquals (add in v6.3.1)	512

DataSanitizationMethod (v6.3 and later)

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

Name	Value	Description
DataSanitizationNoWipe	0	Windows standard – no wipe
DataSanitizationPseudorandomData	1	Pseudorandom data
DataSanitization3PassDoD	2	3-pass DoD 5220.22-M

EMailLoginCredentialsMode (v6.3 and later)

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

Name	Value	Description
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

EventActionType (v6.0 and later)

Used in the ICIEventAction Interface type property.

Name	Value	Name	Value
CommandAction	1	CleanupAction	128
MailAction	2	ReportAction	256
UploadAction	4	AS2SendAction (added in v6.1)	512
DownloadAction	8	AWTaskAction (added in v6.1)	1024
PGPAction	32	BackupAction (added in v6.1)	2048
StopAction	64	WindowsEventLog (added in v6.3.0)	4096

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.

Name	Value
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.

Valid Values

The table below describes the data types used in the EventProperty enum

Data Type	Description	Examples of valid values
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

Category	Name	Value	Data Type	Description
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
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
	ServerLogTime (typo, v6.3 and prior) 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
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	Using Web Transfer Client
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
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
	FolderOperation	5008	STRING	File Change Values: rename added removed
	FileCreationDate	5009	STRING	File Creation Date
	FileCreationTime	5010	STRING	File Creation Time
	FileSize	5011	ULONGLONG	File Size
	FileCRC	5012	DWORD	File CRC
	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.
AS2 properties (added in v6.3.0)	AS2Payload	6000	STRING	AS2 Payload
	AS2MDN	6001	STRING	AS2 MDN
	AS2LocalMIC	6002	STRING	AS2 Local MIC
	AS2RemoteMIC	6003	STRING	AS2 Remote MIC
	AS2MessageID	6004	STRING	AS2 Message ID
	AS2Host	6005	STRING	AS2 Host
	AS2TransactionError	6006	STRING	AS2 Transaction Error
	AS2TransactionResult	6007	STRING	AS2 Transaction Result
	AS2TransactionVerbose	6008	STRING	AS2 Transaction Verbose
	AS2Direction	6009	BOOL	AS2 Direction
	AS2PartnerID	6010	STRING	AS2 Partner ID
	AS2ID	6011	STRING	AS2 EFT ID
	AS2TypeOfContent	6012	INT	AS2 Content Type

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).

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

EventRuleStatementType (v6.0 and later)

Used in the ICIActionStatement Interface type property and the ICIIfStatement Interface type property.

Name	Value
ActionStatement	0
IfStatement	1

EventType (v6.0 and later)

Used to specify the type of event trigger ICISite Interface EventRules method and the ICIEventInfo Interface and ICIEventRuleStatement - Event Rule Statement Interface type properties.

Name	Value	Event Rule Name
BeforeFileDownload	20483	Before Download
MonitorFolder	4101	Folder Monitor
OnAS2InboundTransactionSucceeded (v6.3.0 and later; "On" added in 6.3.)	24577	AS2 Inbound Transaction Succeeded
OnAS2InboundTransactionFailed (v6.3.0 and later; "On" added in 6.3.1)	24578	AS2 Inbound Transaction Failed
OnAS2OutboundTransactionSucceeded (v6.3.0 and later; "On" added in 6.3.1)	24579	AS2 Outbound Transaction Succeeded
OnAS2OutboundTransactionFailed (v6.3.0 and later; "On" added in 6.3.1)	24580	AS2 Outbound Transaction Failed
OnChangeFolder	20491	Folder Changed
OnClientConnected	12289	User Connected
OnClientConnectionFailed	12290	User Connect Failed
OnClientCreated	16391	New User Created
OnClientDeleted (v6.4.5 and later)	16393	User Account Deleted
OnClientDisabled	16385	User Account Disabled
OnClientDisconnected	12291	User Disconnected
OnClientEnabled (v6.4.5 and later)	16394	User Account Enabled
OnClientLocked (v6.1.0 and later)	16392	User Account Locked
OnClientLoggedIn	16388	User Logged in
OnClientLoggedOut	16387	User Logged out
OnClientLoginFailed	16389	User Login Failed
OnClientPasswordChanged	16390	User Password Changed
OnClientQuotaExceeded	16386	User Quota Exceeded
OnDownloadFailed	20490	Download Failed
OnFileDeleted	20481	File Deleted
OnFileDownload	20484	File Downloaded
OnFileMoved	20492	File Moved
OnFileRenamed	20485	File Renamed
OnFileUpload	20482	File Uploaded
OnFolderCreated	20486	Folder Created
OnFolderDeleted	20487	Folder Deleted
OnIPAddedToBanList (v6.3.0 and later)	8195	IP Added to Ban List
OnLogRotate	4098	Log Rotated
OnMonitorFolderFailed	4102	Folder Monitor Failed
OnServiceStarted	4100	Service Started
OnServiceStopped	4099	Service Stopped
OnSiteStarted	8193	Site Started
OnSiteStopped	8194	Site Stopped
OnTimer	4097	Scheduler (Timer) Event
OnUploadFailed = OnFolderDeleted + 2	20489	Upload Failed
OnVerifiedUploadFailure	20494	Verified Upload Failed
OnVerifiedUploadSuccess	20493	Verified Upload Succeeded
OnVerifiedDownloadFailure	20496	Verified Download Failed
OnVerifiedDownloadSuccess	20495	Verified Download Succeeded

FolderMonitorPollIntervalType (v6.5 and later)

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

Name	Value	Description
FMPISeconds	0	use seconds
FMPIMinutes	1	use minutes
FMPIHours	2	use hours

FTPDataConnectionMode (v6.2.18 and later)

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

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

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).

Name	Value
AutobanIPRule	0
ManualIPRule	1

LDAPSearchScope (v6.3 and later)

Used in the ICILDAPAuthManagerSettings Interface SearchScope property.

Name	Value
Scope_Base	0
Scope_OneLevel	1
Scope_Subtree	2

LDAPVersion (v6.3 and later)

Used in the ICILDAPAuthManagerSettings Interface LDAPVersion property.

Name	Value
LDAP_Version2	2
LDAP_Version3	3

LogicalOperator (v6.1 and later)

Used in the ICICompoundCondition Interface Operator property.

Name	Value
LogicalOr	0
LogicalAnd	1

LogMode (v6.3 and later)

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

Name	Value
LogModeStandatd	0
LogModeVerbose	1

Month (v6.3 and later)

Used in the ICITimerEventRuleParams Interface YearlyMonth property.

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

NetworkProtocol (v6.1 and later)

Used in the ICITransferActionParams Interface Protocol property.

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

PGPCompressionLevel (v6.1 and later)

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

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

PGPKeyCipher (v6.3 and later)

Used in the ICIServer Interface CreatePGPKey method to specify the PGP key cipher.

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

PGPKeyType (v6.3 and later)

Used in the ICIServer Interface CreatePGPKey method to specify the PGP key type.

Name	Value
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.

Name	Value
PGPLogLevelStandard	0
PGPLogLevelVerbose	1

PGPOperation (v6.0 and later)

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

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

PGPSigningHash (v6.1 and later)

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

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

PredefinedReportPeriod (v6.1 and later)

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

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

ProxyAuthenticationType (v6.2.31 and later)

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

Name	Value	Name	Value
ProxyAuthUserAtSite	0	ProxyAuthUserPassAcct	3
ProxyAuthSite	1	ProxyAuthOpenSite	4
ProxyAuthUserWithLogon	2	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.

Name	Value
ProxyTypeFTP	1
ProxyTypeHTTP	2
ProxyTypeDMZ	3

Recurrence (v6.3 and later)

Used in the ICITimerEventRuleParams Interface Recurrence property.

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

RegistrationState (v6.1 and later)

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

Name	Value
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).

Name	Value	Description
Relation_First	0	first
Relation_Second	1	second
Relation_Third	2	third
Relation_Fourth	3	fourth
Relation_Last	4	last

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.).

Name	Value	Description
RepeatHours	0	hours
RepeatMinutes	1	minutes
RepeatSeconds	2	second

ReportFilterOperator (v6.1 and later)

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

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

ReportFiltersCombiningOperator (v6.1 and later)

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

Name	Value
NoCombining	-1
AndCombining	0
OrCombining	1

ReportFormat (v6.1 and later)

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

Name	Value
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.

Name	Value
Predefined	0
Range	1

ServerModule (v6.1 and later)

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

Name	Value	Name	Value
EFTServer	0	PGPModule	5
SSHModule	1	HSModule	6
HTTPModule	2	AS2Module	7
WTCModule	3	AWModule	8
ARModule	4	DMZGWModule	9

SFTPAdvBool (v6.0 and later)

Used in numerous ICIClientSettings Interface "set' methods, and the ICISite Interface CreateUser and CreateUserEx methods. See also Difference between VARIANT_BOOL and SFTPAdvBool.

Name	Value
abFalse	0
abTrue	1
abInherited	-2

SOCKSType (v6.2.31 and later)

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

Name	Value	Description
SOCKSNone	-1	None
SOCKS4	0	SOCKS 4
SOCKS5	1	SOCKS 5

StopType (v6.1 and later)

Used in the ICIStopActionParams Interface Action property.

Name	Value
StopRule	2
StopEvent	4
StopRuleAndEvent	6

TransferEncodingType (v6.5 and later)

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

Name	Value	Description
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 Interface OverwriteType property used to specify how to replace files that have the same names when transferring files.

Name	Value	Description
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

TwoFactorAuthenticationMode (v6.3 and later)

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

Name	Value	Description
TwoFactorAuth_None	0	None
TwoFactorAuth_RADIUS	1	RADIUS
TwoFactorAuth_RSA	2	RSA

Weekday (v6.3 and later)

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

Name	Value	Description	Name	Value	Description
Weekday_Sunday	0	Sunday	Weekday_Friday	5	Friday
Weekday_Monday	1	Monday	Weekday_Saturday	6	Saturday
Weekday_Tuesday	2	Tuesday	Weekday_Day	7	Day
Weekday_Wednesday	3	Wednesday	Weekday_Weekday	8	Weekday
Weekday_Thursday	4	Thursday	Weekday_Weekendday	9	Weekend day

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

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

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

If this help topic did not help you, search the Knowledgebase or pose your question in the GlobalSCAPE User Forum.

For the most up-to-date information, to view version history, updates, and activation instructions; or to download a PDF of this user guide, visit the Support Center at http://www.globalscape.com/support.

Leave compliments or complaints regarding the help in the User Forum. At a minimum, please provide the topic title and why you needed help.

For information about GlobalSCAPE, visit www.globalscape.com, subscribe to our Secure Info Exchange blog, or follow us on Twitter.

Last modified: 19-Apr-13 at 11:34:10