|
This online help file is for EFT Server version 6.2.x. For other versions of EFT Server, please refer to http://help.globalscape.com/help/index.html. (If the Index and Contents are hidden, click Show Contents pane in the top left corner of this topic.) |
Enumerations and constants are use in concert with the methods and properties.
Enumerations allow you to associate constant values with names.
Constants store values that do not vary throughout the execution of the API.
For example, the enumeration EventActionType allows you specify an Event Rule Action by name using constants (e.g., DownloadAction or PGPAction ).
The following enumerations and constants are available in EFT Server 6.2 and later:
|
The following enumerations and constants are available in EFT Server 6.1 and later:
|
The following enumerations and constants are available in EFT Server 5.2 and later:
|
The AdminAccountType enumeration allows you to specify the type of EFT Server administrator account:
typedef enum {
EFTAccount = 0, // EFT Server-managed account
LocalComputerAccount = 1, // User account on EFT server computer
ADAccount = 2 // AD account
} AdminAccountType;
The AdminLoginType enumeration allows you to specify the way an EFT Server administrator connects to server:
typedef enum {
EFTLogin = 0, // With EFT Server-managed admin login and password (legacy style)
IWALogin = 1, // With currently logged user credentials
// (Integrated Windows Authentication, IWA;
// for AD and local computer accounts)
NetLogon = 2 // With Windows login and password
// (for AD and local computer accounts)
} AdminLoginType;
The AS2ContentType enumeration allows you to specify the type of the document to send for AS2 Send operation.
typedef enum {
X12 = 0, // EDI objects (ASC X12)
EDIFACT = 1, // Message in EDIFACT format
XML = 2, // XML
EDIConsent = 3, // EDI objects
Binary = 4, // Binary
Plaintext = 5 // Plaintext
} AS2ContentType;
The AS2ReceiptDelivery enumeration allows you to specify the receipt delivery mechanism for AS2 Send operation.
typedef enum {
Sync = 0, // HTTP, synchronous
Async = 1 // HTTP, asynchronous
} AS2ReceiptDelivery;
The AS2ReceiptPolicy enumeration allows you to specify the type of the receipt required for AS2 Send operation.
typedef enum {
NoReceipt = 0, // No receipt required
UnsignedReceipt = 1, // unsigned receipt required
SignedReceipt = 2, // Signed receipt required
} AS2ReceiptPolicy;
The AutobanSensitivity enumeration allows you to specify the sensitivity for the Flood/Hammer Autoban setting (for Denial of Service attacks).
typedef enum {
SensitivityOff = 0, // Autoban is off
SensitivityVeryLow = 1, // Very low sensitivity
SensitivityLow = 2, // Low sensitivity
SensitivityMedium = 3, // Medium sensitivity
SensitivityHigh = 4, // High sensitivity
SensitivityVeryHigh = 5 // Very high sensitivity
} AutobanSensitivity;
Equals (0x01) – Equals
Less (0x02) – Less
LessOrEquals (0x04) – Less or equal
Contains (0x08) – Contains
Match (0x10) – Match (for file name matching with template such as ‘*.exe’ etc)
MemberOf (0x20) – Member of
OneOf (0x40) – One of
StartsWith (0x80) – Starts with
typedef enum {
CommandAction = 0x01, // Execute Command action
MailAction = 0x02, // Send E-mail action
UploadAction = 0x04, // Copy/Move File action
DownloadAction = 0x08, // Download File action
PGPAction = 0x20, // PGP action
StopAction = 0x40, // Stop action
CleanupAction = 0x80, // Cleanup action
ReportAction = 0x100, // Generate Report action
AS2SendAction = 0x200, // Send File via AS2 action (version 6.1 and later)
AWTaskAction = 0x400, // Execute AW Task action (version 6.1 and later)
BackupAction = 0x800 // Backup Server Configuration action (version 6.1 and later)
} EventActionType;
ActionStatement (0) – Action statement
IfStatement (1) – Conditional statement
Server Events
OnTimer (0x1001) – Timer
OnServer_LogRotate (0x1002) – Log rotated
OnServer_ServiceStop (0x1003) – Service stopped
OnServer_Service_Start (0x1004) – Service started
Monitor_Folder (0x1005) – Folder monitoring
OnMonitor_Folder_Failed (0x1006) – Folder monitoring failed
Site Events
OnSiteStarted (0x2001) – Site started
OnSiteStopped (0x2002) – Site stopped
Connection Events
Connection_Connect (0x3001) – Client connected
Connection_ConnectFailed (0x3002) – Client connection failed
OnClientDisconnected (0x3003) – Client disconnected
Client Events
OnClientDisabled (0x4001) – Client disabled
OnClientQuotaExceeded (0x4002) – Client’s disk quota exceeded
OnClientLoggedOut (0x4003) – Client logged out
OnClientLoggedIn (0x4004) – Client logged in
OnClientLoginFailed (0x4005) – Client login failed
OnClientPasswordChanged (0x4006) – Client’s password is changed
OnClientCreated (0x4007) – New client created
File System Events
OnFileDeleted (0x5001) – File deleted
OnFileUpload (0x5002) – File uploaded
BeforeFileDownload (0x5003) – Before file download
OnFileDownload (0x5004) – File downloaded
OnFileRenamed (0x5005) – File renamed
OnFolderCreated (0x5006) – New folder created
OnFolderDeleted (0x5007) – Folder deleted
OnUploadFailed (0x5009) – File upload failed
OnDownloadFailed (0x500A) – File download failed
OnChangeFolder (0x500B) – Client changed their current folder
OnFileMoved (0x500C) – File moved
OnVerifiedUploadSuccess (0x500D) – Verified file upload succeeded
OnVerifiedUploadFailure (0x500E) – Verified file upload failed
OnVerifiedDownloadSuccess (0x500F) – Verifies file download succeeded
OnVerifiedDownloadFailure (0x5010) – Verified file download failed
LogicalOr (0) – OR
LogicalAnd (1) – AND
AD = 2
EFT = 0
INTEGRATED = 1
The PGPCompressionLevel enumeration allows you to specify the compression level for PGP encryption operation.
typedef enum {
NoCompression = 0, // No compression
CompressionLevel1 = 1, // Level 1 (least compression, fastest)
CompressionLevel2 = 2, // Level 2
CompressionLevel3 = 3, // Level 3
CompressionLevel4 = 4, // Level 4
CompressionLevel5 = 5, // Level 5
CompressionLevel6 = 6, // Level 6 (medium compression, default)
CompressionLevel7 = 7, // Level 7
CompressionLevel8 = 8, // Level 8
CompressionLevel9 = 9 // Level 9 (max compression, default)
} PGPCompressionLevel;
The PGPOperation enumeration allows you specify the PGP operation to perform on a file.
typedef enum {
Encrypt = 0, // Encrypt file with PGP key
EncryptAndSign = 1, // Encrypt + Sign file (version 6.1 and later)
Sign = 2, // Sign file (version 6.1 and later)
SDA = 3, // Create Self-decrypting archive (version 6.1 and later)
Decrypt = 4, // Decrypt PGP-encrypted file
} PGPOperation;
Refer to Determining Operation for PGP Event Action (Operation).
The PGPSigningHash enumeration allows you to specify the hash algorithm for a PGP signing operation.
typedef enum {
MD5Hash = 0, // MD5
SHA1Hash = 1, // SHA1
RIPEMD160Hash = 2, // RIPEMD-160
SHA256Hash = 3, // SHA-256
SHA384Hash = 4, // SHA-384
SHA512Hash = 5 // SHA-512
} PGPSigningHash;
The PredefinedReportPeriod enumeration allows you to specify one of the predefined reporting periods for Generate Report operation.
typedef enum {
AllDates = 0, // Report for all dates
MonthToDate = 1, // Report for a month before reporting day
QuarterToDate = 2, // Report for a quarter before reporting day
YearToDate = 3, // Report for a year before reporting day
CurrentWeek = 4, // Report for the current week
CurrentMonth = 5, // Report for the current month
CurrentQuarter = 6, // Report for the current quarter
CurrentYear = 7, // Report for the current year
LastWeek = 8, // Report for the last week
LastMonth = 9, // Report for the last month
LastQuarter = 10, // Report for the last quarter
LastYear = 11, // Report for the last year
Last30Days = 12, // Report for the last 30 days
Last12Months = 13 // Report for the last 12 months
Today = 14, // Report for the current day (version 6.2 and later)
Yesterday = 15, // Report for the previous day (version 6.2 and later)
Last24Hours = 16, // Report for the last 24 hours (version 6.2 and later)
} PredefinedReportPeriod;
The Recurrence enumeration allows you to specify the frequency of an Event Rule trigger.
Custom (0) – Hourly
Daily (1) – Daily
Weekly (2) – Weekly
Monthly (3) – Monthly
Yearly (4) – Yearly
OneTime (5) – Trigger only once
The RegistrationState enumeration allows you to specify the EFT Server module registration status.
typedef enum {
Registered = 0, // Module is full registered
Evaluation = 1, // Module is in trial period
Expired = 2 // Module is not registered
} RegistrationState;
The ReportFilterOperator enumeration allows you to specify the report filter operator for Generate Report operation.
typedef enum {
NoFilter = -1, // No filter
EqualFilter = 0, // <Field> is equal <Value>
NotEqualFilter = 1, // <Field> is not equal <Value>
LessFilter = 2, // <Field> is less than <Value>
LessOrEqualFilter = 3, // <Field> is less than or Equal <Value>
GreaterFilter = 4, // <Field> is greater than <Value>
GreaterOrEqualFilter = 5, // <Field> is greater than or equal
// <Value>
ContainsFilter = 6, // <Field> contains <Value>
StartsWithFilter = 7 // <Field> starts with <Value>
} ReportFilterOperator;
The ReportFiltersCombiningOperator enumeration allows you to specify the way of combining of two report filters for Generate Report operation.
typedef enum {
NoCombining = -1, // No combining, use only first filter
AndCombining = 0, // Output rows must meet both filters
OrCombining = 1 // Output rows must met one of the filters
} ReportFiltersCombiningOperator;
The ReportFormat enumeration allows you to specify the report format for Generate Report operation.
typedef enum {
HTMLFormat = 0, // HTML
PDFFormat = 1, // PDF
VPFormat = 2 // VP (native to Component One reporting component)
} ReportFormat;
The ReportPeriodType enumeration allows you to specify the type of reporting period for Generate Report operation.
typedef enum {
Predefined = 0, // One of
predefined periods
(see // PredefinedReportPeriod enum, below)
Range = 1 // ‘From - To’ range
} ReportPeriodType;
The ServerModule enumeration allows you specify EFT Server or one of its modules.
typedef enum {
EFTServer = 0, // EFT Server
SSHModule = 1, // SSH Module
HTTPModule = 2, // HTTP Module
WTCModule = 4, // WTC Module
ARModule = 5, // ARM
PGPModule = 6, // PGP Module
HSModule = 7, // HSM
AS2Module = 8, // AS2 Module
AWModule = 9, // AW Module
DMZGWModule = 10, // DMZ Gateway (this enum is available in EFT Server v6.2 and later)
} ServerModule;