EFT API REFERENCE. v7.0.3 and earlier

Transcription

1 EFT API REFERENCE v7.0.3 and earlier

2 GlbalSCAPE, Inc. (GSB) Crprate Headquarters Address: 4500 Lckhill-Selma Rad, Suite 150, San Antni, TX (USA) Sales: (210) Sales (Tll Free): (800) Technical Supprt: (210) Web Supprt: GlbalSCAPE, Inc. All Rights Reserved Octber 14, 2014

3 Table f Cntents Using the Applicatin Prgramming Interface (API)... 7 What's New in the API?... 7 Mdified Remtely Administering EFT Using the API Cpying Required DLL Files t the Remte Cmputer Using the API (with Examples) Using the API Scripting Standards Difference between VARIANT_BOOL and SFTPAdvBl Script Examples Hw D the IP Access/Ban Methds and Prperties Wrk? Interface Reference ICIActinStatement - Actin Statement Interface ICIActinStatements - Actin Statements Interface ICIADAuthManagerSettings - Active Directry Authenticatin Manager Settings Interface IAdhcMessage - Ad Hc Message Interface ICIAdminAccunt - Administratr Accunt Interface ICIAdminPermissin - Administratr Permissin Interface ICIAdvancedWrkflwParams - Advanced Wrkflw Parameters Interface ICIAS2InbundSettings - AS2 Inbund Settings Interface ICIAS2OutbundSettings - AS2 Outbund Settings Interface ICIAS2SendActinParams - AS2 Send Actin Parameters Interface ICIAS2TransactinInf - AS2 Transactin Infrmatin Interface ICIAudit - Audit Interface ICIAutbanIPAccessRule Interface ICIAWTaskActinParams - Autmated Wrkflw Event Actin Parameters Interface ICIBackupActinParams - Backup Actin Parameters Interface ICIBackupArchiveInf - Backup Archive Infrmatin Interface ICIBannedIP Interface ICICertInf - Certificate Infrmatin Interface ICICleanupActinParams - CleanUp Actin Parameters Interface ICIClientSettings - Client Settings Interface ICICmmandActinParams - Cmmand Actin Parameters Interface ICICmmandSettings - Cmmand Settings Interface ICICmplexPasswrdSettings - Cmplex Passwrd Settings Interface iii

4 EFT API Reference ICICmpundCnditin - Cmpund Cnditin Interface ICICnnectedUser - Cnnected User Interface ICICntentIntegrityCntrlActinParams ICICntentIntegrityCntrlPrfile ICIDMZGateway - DMZ Gateway Interface ICIDwnladActinParams - Dwnlad Actin Parameters Interface Prperties ICIEventActin - Event Actin Interface ICIEventActins - Event Actins Interface ICIEventInf - Event Infrmatin Interface ICIEventRuleParams - Event Rule Parameters Interface ICIEventRule - Event Rule Interface ICIEventRules - Event Rules Interface ICIEventRuleStatement - Event Rule Statement Interface ICIFlderMnitrEventRuleParams - Flder Mnitr Event Rule Parameters Interface ICIGSAuthManagerSettings - Glbalscape Authenticatin Manager Settings Interface ICIIfStatement - If Statement Interface ICIHighAvailabilityParams Interface ICILDAPAuthManagerSettings - LDAP Authenticatin Manager Settings Interface ICIMailActinParams - Mail Actin Parameters Interface ICIManualIPAccessRule Interface ICINewUserData Interface ICIODBCAuthManagerSettings - ODBC Authenticatin Manager Settings Interface ICIPermissin - Permissin Interface ICIPgpActinParams - OpenPGP Actin Interface ICIPGPKeyInf - OpenPGP Key Infrmatin Interface ICIReprtActinParams - Reprt Actin Parameters Interface ICIReprtInf - Reprt Infrmatin Interface ICIResetPasswrdSettings - Reset Passwrd Settings Interface ICIRundRbinEventRuleSchedulingParams Interface ISATMessage ICIServer - Server Interface ICISimpleCnditin - Simple Cnditin Interface ICISite - Single-Site Interface ICISiteBackupInf - Site Backup Infrmatin Interface ICISites - Multi-Site Interface ICISSHKeyInf - SSH Key Infrmatin Interface ICIStpActinParams - Stp Actin Parameters Interface iv

5 Table f Cntents ICITimerEventRuleParams - Timer Event Rule Parameters Interface ICITimerEventRuleParams in Previus Versins ICITransferActinParams - Transfer Actin Parameters Interface ICIUpladActinParams - Uplad Actin Parameters Interface ICIWindwsEventLgActinParams - Windws Event Lg Actin Parameters Interface Enum Reference Index v

6 EFT API Reference vi

7 Using the Applicatin Prgramming Interface (API) The Enhanced File Transfer (EFT ) platfrm's API allws yu t interact with EFT at a cmmand line r in scripts. This reference des nt teach yu hw t write scripts; it is simply a reference t describe the interfaces, prperties, methds, and enumeratins used in the API. This reference assumes yu knw hw t create and execute a script. Few examples are prvided; if yu need assistance creating scripts, GlbalSCAPE Prfessinal Services can create custm scripts fr yu. The SFTPCOMInterface.CIServer class is the class that an applicatin can use directly. T start using the SFTP interface, create the SFTPCOMInterface.CIServer class bject, and then apply the methds and prperties in the bject. (If yu d nt understand what it means t "create the SFTPCOMInterface.CIServer class bject," Glbalscape Prfessinal Services can create custm scripts fr yu.) The interfaces are a way t instantiate an bject f that type. Fr example: Set SFTPServer = CreateObject("SFTPCOMInterface.CIServer") (CIServer implements the ICIServer interface.) T find the interface, methd, r prperty that yu need t use in yur script, use the Search feature in this reference t lcate wrds r phrases (surrunded by qutatin marks) within the cntent f the tpics. (e.g., "certificate" yields ~50 tpics; "certificate cuntry" yields ~12 tpics.) Fr script examples, refer t Script Examples. Refer t the fllwing Web sites fr helpful infrmatin regarding scripting: VBScript Run-time Errrs - Reference f run-time errrs. VBScript Syntax Errrs - Reference f syntax errrs Micrsft Windws Script Technlgies - Lists the Windws script technlgies and describes the functinality included in each technlgy. Be sure t heavily dcument/cmment yur script. Adding descriptive cmments t yur script nw will remind yu and thers f the purpse f the script, and makes it easier t brrw sectins f script t use later in ther scripts. A year frm nw, when yu dn't even remember writing the script, yu'll be glad yu added cmments! This guide is intended as a supplement t the EFT user guide. Fr an understanding f the cncepts in this supplement, please refer t that guide. What's New in the API? Each new versin f the API ffers imprved prgrammatic cntrl ver EFT. If yu are upgrading EFT, be sure t read the descriptins at the links belw and update yur scripts accrdingly. If necessary, Glbalscape Prfessinal Services can assist yu with writing scripts fr yur unique envirnment. Included belw are details f what is new in this versin as well as what has changed in the API in previus versins. T assist yu with updating yur scripts, yu can als refer t the Knwledgebase article at which prvides a cmparisn f changes frm v6.0 t present. New in Versin ICIServer HACnfiguratinDefaultNdeList allws yu t create a default nde list t execute Event Rules. ICIHighAvalailabilityParams DefaultNdeList is the list f 1 r mre ndes wh are designated t execute Event Rules. Yu can still specify ndes within the Event Rule. 7

8 EFT API Reference The fllwing prperties, methds, enums, and interfaces were added t supprt the antivirus/dlp (ICAP) functinality in Event Rules: Added methds and prperties t ICIServer AddCntentIntegrityCntrlPrfiile, CntentIntegrityCntrlPrfileList, DeleteCntentIntegrityCntrlPrfile, GetCntentIntegrityCntrlPrfile, TestCntentIntegrityCntrlPrfile, and UpdateCntentIntegrityCntrlPrfile Added enums: IcapMde, IcapMaxScanSizeUnits Edited enum: EventActinType nw includes CntentIntegrityCntrl Added ICICntentIntegrityCntrlPrfile and ICCntentIntegrityCntrlActinParams interfaces New in Versin 7 The fllwing prperties, methds, and enumeratins have been added/mdified: ICIServer ARMHealCnnectin, ARMNtifyOnDiscnnect, ARMNtifyOnRecnnect, and ARMRecnnectPerid prperties were added fr the new Auditing and Reprting Mdule database healing mechanism. ICIServer LimitLginAttempts, LckutPerid, MaxInvalidLginAttempts, InvalidAttemptsPerid, InactiveAccuntsRemving, MaxInactiveAccuntPerid prperties were added t view r change administratr Accunt Security Settings. ICIBackupArchiveInf ARMHealCnnectin, ARMNtifyOnDiscnnect, ARMNtifyOnRecnnect, and ARMRecnnectPerid prperties were added fr the new Auditing and Reprting Mdule database healing mechanism. ICITransferActinParams DeleteSurceFileIfMveSkipped prperty was added t allw yu t specify whether a surce file shuld be remved if the transfer was skipped. ICISite DefaultSettingsLevel prperty sets a given template as the default. Yu can als use the prperty t find ut which template is currently specified as the default. ICISite CreateSettingsLevel methd was mdified t allw yu t specify a Settings Level as the default Settings Level when yu create it. Numerus interfaces, prperties, methds, and enums specific t active-active/high availability clustering were added: Prperties added t the ICIServer Interface New ICIHighAvailabilityParams interface Methds added t the ICIEventRule Interface New EventRuleSchedulingAlgrithm Enum New ICIRundRbinEventRuleSchedulingParams Interface New in Versin ICISite - Single-Site Interface prperties added t enable the Mbile Transfer Client and t set security ptins. New in Versin 6.5 The fllwing prperties, methds, and enumeratin have been added/mdified: ICIServer::DiscnnectDueTTimeut and ICIServer::DiscnnectDueTTimeutPerid prperties enable and set the timeut perid t discnnect the administratin interface frm EFT after administratr inactivity. 8

9 What's New in the API? ICISite::SFTPEncding prperty retrieves/specifies the transfer encding mde fr SFTP. ICISite::FTPEncding prperty retrieves/specifies the transfer encding mde fr FTP and FTPS. ICISite::AdvancedWrkflwsCunt read-nly prperty retrieves the ttal number f Advanced Wrkflws defined n the Site. ICISite::GetAdvancedWrkflwIndex methd retrieves the zer-based index f the Advanced Wrkflw with given name. ICISite::GetAdvancedWrkflwParams methd retrieves Advanced Wrkflw parameters. ICISite::SetAdvancedWrkflwParams methd changes Advanced Wrkflw parameters. ICISite::AddAdvancedWrkflw methd creates a new Advanced Wrkflw n the Site. ICISite::RemveAdvancedWrkflw methd remves an Advanced Wrkflw frm the Site. ICITransferActinParams::TransferEncding prperty retrieves/specifies the transfer encding mde fr client transfer (uplad/dwnlad) actins. IAdhcMessage interface, ICIAudit interface, ISATMessage interface, and the ICIAudit::AuditSAT and ICIAudit::AuditAdhc methds were added t accmmdate changes with the EFT-Mail Express integratin. TransferEncdingType enum specifies the transfer encding mde (Aut, ASCII, UTF-8). EventPrperty enum - TimeStampPrecise retrieves/specifies the time f an Event t millisecnds and FlderMnitrFailureReasn allws yu t specify/retrieve the reasn the Flder Mnitr rule failed. EventType enum - added OnClientDeleted and OnClientEnabled values. ICIFlderMnitrEventRuleParams::PllInterval prperty retrieves/specifies the plling interval value fr flder mnitr event rule. ICIFlderMnitrEventRuleParams::PllIntervalType prperty retrieves/specifies the plling interval type fr Flder Mnitr Event Rule. FlderMnitrPllIntervalType enum specifies Flder Mnitr plling by secnds, minutes, r hurs. ICIAdvancedWrkflwParams interface was added t supprt Advanced Wrkflws cnfiguratin; retrieves/specifies Advanced Wrkflw. ICIAdvancedWrkflwParams::Cde prperty retrieves/specifies the surce cde f Advanced Wrkflw. ICIAdvancedWrkflwParams::DateCreated read-nly prperty retrieves/specifies the time when the Advanced Wrkflw was created. ICIAdvancedWrkflwParams::Descriptin prperty retrieves/specifies the descriptin f Advanced Wrkflw. ICIAdvancedWrkflwParams::LgMde prperty retrieves/specifies the debug lgging mde f the Advanced Wrkflw ICIAdvancedWrkflwParams::Name prperty retrieves/specifies the name f Advanced Wrkflw. AWLgMde enum represents different Advanced Wrkflw debug lgging mdes ICIAdvancedWrkflwParams:: TimeutSecnds prperty retrieves/specifies the maximal duratin (in secnds) f the Advanced Wrkflw executin after which it is frcedly terminated by EFT (value f 0 means n timeut ). 9

10 EFT API Reference New CIAdvancedWrkflwParams c-class was added t supprt creatin f Advanced Wrkflws. C-class implements ICIAdvancedWrkflwParams interface. New in Versin API Event Type enums OnClientDeleted and OnClientEnabled were added fr EFT's User Accunt Enabled and User Accunt Deleted Event Rule triggers. New in Versin The EnableCAC methd was added t the ICISite interface. New in Versin 6.4 Mdified Interfaces: ICIFlderMnitrEventRuleParams: ICIServer: ICISite: ArchiveSubFlderName PllIntervalSecnds UseFileSystemNtificatins UseInteractiveLgn UsePeridicDirectryPll ListenIPs BanIPFrInvalidLginAttempts BanIPFrInvalidLginAttemptsWithExistingUsername DefaultPGPKeyID DefaultPGPKeyPassphrase GetSFTPAccess GetUserSettingsLevel InvalidLginAttemptsCuntTBanIP ListenIPs MaxInvalidLginAttemptsPeridTBanIP SetDefaultPGPKey ICISiteBackupInf: ICISites: ListenIPs NewListenIPs AddADSiteEx AddLDAPSiteEx AddLcalSiteEx AddNTLMSiteEx 10

11 What's New in the API? AddODBCSiteEx AddSite AddSiteEx ICITransferActinParams RenameAfterTransfer RenameAfterTransferT TreatMissingSurceAsSuccess ICIWindwsEventLgActinParams Mdified Enums: EventID Added EPRT and EPSV t the FTPDataCnnectinMde enum. New in Versin 6.3 Numerus interfaces were added and many interfaces have new, mdified, r remved members t give yu imprved prgrammatic cntrl ver EFT. If yu are upgrading t EFT v6.3 and using any f the remved r mdified members in yur scripts, be sure t read the descriptins at the links and update yur scripts accrdingly. GlbalSCAPE Prfessinal Services can assist yu with writing scripts fr yur unique envirnment. In v6.3, the fllwing interfaces were added r mdified: Mdified: Added: ICIClientSettings - Client Settings Interface Methds and Prperties ICIDwnladActinParams - Dwnlad Actin Parameters Interface Prperties ICIServer - Server Interface ICISite - Single-Site Management ICISites - Multi-Site Management ICITimerEventRuleParams - Timer Event Rule Parameters Interface ICIPermissin - VFS Permissin Interface ICIUpladActinParams - Uplad Actin Parameters Interface Prperties ICIADAuthManagerSettings - Active Directry Authenticatin Manager Settings Interface ICIAdminAccunt - Administratr Accunt Interface ICIAdminPermissin - Administratr Permissin Interface ICIAS2InbundSettings - AS2 Inbund Settings Interface ICIAS2OutbundSettings - AS2 Outbund Settings Interface ICIAS2TransactinInf - AS2 Transactin Infrmatin Interface ICIBackupArchiveInf - Backup Archive Infrmatin Interface ICICmplexPasswrdSettings - Cmplex Passwrd Settings Interface ICICnnectedUser - Cnnected User Interface 11

12 EFT API Reference ICIDMZGateway - DMZ Gateway Interface ICIGSAuthManagerSettings - GlbalSCAPE Authenticatin Manager Settings Interface ICILDAPAuthManagerSettings - LDAP Authenticatin Manager Settings Interface ICINewUserData Interface (added in v6.3.8) ICIOCBCAuthManagerSettings - ODBC Authenticatin Manager Settings Interface ICIResetPasswrdSettings - Reset Passwrd Settings Interface ICISiteBackupInf - Site Backup Infrmatin Interface ICITransferActinParams - Transfer Actin Parameters Interface ICIWindwsEventLgActinParams - Windws Event Lg Actin Parameters Interface New in v6.2 In v6.2, the fllwing methds, prperties, parameters, and enumeratrs were added, mdified, r remved. If yu are using any f these in yur scripts, be sure t read the descriptins and update yur scripts accrdingly. Server Interface (ICIServer) methds: Added CnnectEx - Allws administratr t lgin t EFT using the new admin credential types (IWA r Windws admin) Updated the ICIServer interface RemveServerAdminAccunt methd t accmmdate the new types f admin accunts. Single-Site Interface (ICISite) prperties: AllwChangePasswrd - allws yu t retrieve r specify whether Site users are allwed t change their passwrds. FrcePasswrdResetOnInitialLgin - Frces all users n the Site t change their passwrd n initial lgin. Client Settings Interface (ICIClientSettings) methds: GetFrcePasswrdResetOnInitialLgin - Returns true if client has already changed the passwrd (client will nt be frced t change the passwrd). SetFrcePasswrdResetOnInitialLgin - Frces the user t change the passwrd nly if GetFrcePasswrdResetOnInitialLgin is false. Enums and Cnstants LginType - AD, EFT, and INTEGRATED ServerMdule - Added DMZGWMdule registratin PredefinedReprtPerid - Added Last24Hurs, Tday, and Yesterday AdminAccuntType enumeratin - Allws yu t specify the type f EFT administratr accunt AdminLginType enumeratin - Allws yu t specify the way an EFT administratr cnnects t server: 12

13 What's New in the API? New in v6.1 Methds, prperties, parameters, and enumeratrs that were added, mdified, r remved in EFT v6.1 are listed in the tables belw. Refer t the specific methd, prperty, parameter, r enumeratin tpic fr mre infrmatin. Mdified The fllwing methds, prperties, and enumeratins were mdified. If yu are using any f these in yur scripts, be sure t read the descriptins and update yur scripts accrdingly. ICISites Interface Add AddADSite AddLDAPSite AddLcalSite AddNTLMSite AddODBCSite Item ICISite interface AddCertificateTTrusted IsStarted ICIClientSettings interface The first utput parameter ( Is inherited ) type f multiple ICIClientSettings Get methds was changed frm Blean t VARIANT. This prvides the pssibility f using this parameter in VBS which des nt allw utput parameters f nn-variant types. GetAllwAnyPwd GetAllwMODEZ GetAllwNp GetAllwXCRC GetAppletEnabled GetChangePwd GetClearFTP GetClearHTTP GetDwnladsPerSessin GetEnableAccunt GetEnableTimeOut GetEnableDiskQuta GetFTPS GetHasDwnladsPerSessin GetHasMaxDwnladSize GetHasMaxIPs GetHasMaxSpeed GetHasMaxUpladSize GetHasMaxUsers GetHasPwdRetries GetHasUpladsPerSessin GetHmeDir GetHmeDirIsRt GetHTTPS GetIncrrectPasswrdAttempts GetLimitLginAttempts GetLckutNtDisable GetLginMsg GetMaxDwnladSize GetMaxIPs GetMaxSpace GetMaxSpeed 13

14 EFT API Reference GetMaxUpladSize GetMaxUsers GetPwdRetries GetSFTP GetSftpAuthenticatinType GetSSHKeyID GetTimeOut ICIEventRule Interface GetParams SetParams AddIfStatement ICIEventActin Interface GetParams SetParams ICIIfStatement Interface IfSectin ElseSectin Cnditin ICIPgpActinParams interface Sign KeyIDs ICIReprtActinParams interface CustmDate DateFrmat FilterAndOr FilterOperatr1 and FilterOperatr2 ReprtFileFrmat The fllwing enumeratins were mdified: EventActinType enumeratin PGPOperatin enumeratin Added GetUpladsPerSessin GetUsedSpace GetSSLAuthenticatinType GetSSLKeyID SetHmeDir SetIncrrectPasswrdAttempts SetLckutNtDisable The fllwing methds, prperties, and parameters were added. ICIAS2SendActinParams-AS2 Send Actin Parameters Interface Prperties LcalPath ClientPrfile UseClientPrfile DeleteSurceFile 14

15 What's New in the API? Hst PartnerCertificatePath Prt AS2ID RemtePath PartnerAS2ID User ReceiptPlicy Passwrd ReceiptDelivery Subject TimeutSec CntentType RetriesCunt Cmpress RetryDelaySec Encrypt AsyncReceiptTimeutMin Sign AWTaskActinParams - Autmated Wrkflw Task Event Actin Parameters TaskName ICIBackupActinParams - Backup Actin Parameters Flder ICIClientSettings - Client Settings Interface Methds and Prperties GetLimitAccessByIP IsActivityPeridLimited IsPasswrdAgeLimited SetLimitAccessByIP ICICmmandSettings - Cmmand Settings Interface LgPath ICIEventInf - Event Infrmatin Interface Name Type ICIPgpActinParams - OpenPGP Actin Interface ASCIIArmredOutput CmpressinLevel SignatureInSeparateFile SigningHash SDAPasswrd ICIReprtInf - Reprt Infrmatin Interface Name DefinitinPath ICIServer - Server Interface AvailableEvents AvailablePGPKeys AvailableReprts 15

16 EFT API Reference GenerateReprt AvailableSSHKeys ImprtSSHKey MduleRegistratinState RemveSSHKey SetSSLCertificate ICISite - Single-Site Management AutbanSensitivity SetSSLCertificate Remved The fllwing methds and parameters were remved. ICIClientSettings - Client Settings Interface Methds and Prperties GetAllwAnyPwd GetAnnymusLgin GetHmeIP GetHmeIPString SetAllwAnyPwd SetAnnymusLgin SetHmeIP SetHmeIPString SetIncrrectPasswrdAttempts ICIEventRule - Event Rule Interface Params ICIEventActin - Event Actin Interface Prperties Params ICIPgpActinParams - OpenPGP Actin Interface Sign ICIReprtActinParams - Reprt Actin Parameters Interface Name Path ICIServer - Server Interface AreLingeringTransactins IsDBCnnected ICITimerEventRuleParams - Timer Event Rule Parameters Interface LastPremature LastTime 16

17 Remtely Administering EFT Using the API Yu can remtely administer EFT using the API, but yu must first cpy the applicable DLL files t a flder n the remte cmputer and register SFTPCOMInterface.DLL n the remte cmputer using regsvr32 (described belw). Remte administratin is nt allwed after the trial expires if yu d nt activate the sftware. Befre yu can cnnect frm the remte Administratr, yu must cnfigure the Server. Yu must d this lcally, n the EFT cmputer. Befre attempting t cnnect t a remte EFT, first be sure that the remte EFT service is running, and that it allws remte administratin. If yu have cnfigured remte administratin, but are unable t cnnect t EFT, ne r mre f the fllwing culd be preventing the cnnectin: The IP address f the cmputer n which yu are attempting t cnnect t EFT is listed in the Remte Administratin Ban IP list. Yur SSL certificate is expired r invalid. Remte administratin is nt enabled. The remte administratin prt value has changed. EFT s IP address has changed since the last lgin. The firewall settings f the cmputer n which EFT is installed are blcking the cnnectin. There is a versin mismatch between yur administratin interface and the EFT service yu are trying t administer. The administratr accunt with which yu are attempting the remte cnnectin des nt have access permissin t EFT. Netwrk errrs Cpying Required DLL Files t the Remte Cmputer Administering EFT remtely requires that yu cpy the fllwing DLL files frm the EFT cmputer t the cmputer that will be making the remte COM calls (depending n yur needs, as indicated belw). Required by the COM API. These files are installed n the EFT cmputer in C:\Prgram Files(x86)\Cmmn Files\GlbalSCAPE\SFTPCOMInterface: atl100.dll mfc100.dll mfc100u.dll msvcp100.dll msvcr100.dll SFTPCOMInterface.dll (Yu must register this file n the remte cmputer.*) Required by the COM API and the SSL implementatin. These DLLs are required anytime COM cnnects t EFT, even when the Require SSL fr remte administratin check bx is nt selected in the administratin interface. These files are installed n the EFT Server cmputer in C:\Prgram Files(x86)\Cmmn Files\GlbalSCAPE\SFTPCOMInterface: SSL.dll SSLFips.dll 17

18 EFT API Reference GSCrypt.dll GSCrypt.dll.sha1 Required t create r administer SSH Keys via COM. These files can be fund installed n EFT in the install directry f EFT, by default C:\Prgram Files(x86)\GlbalSCAPE\EFT Server Enterprise: Sftp.dll sftp FIPS.dll cryptpp.dll *All DLL files shuld be cpied t the same flder as the SFTPCOMInterface.dll and shuld nt be mved after the SFTPCOMInterface.dll is registered using regsvr32.exe, as described belw: T register SFTPCOMInterface.dll In the directry n the remte cmputer t which yu cpied the abve files, run regsvr32. Fr example, type: Regsvr32.exe SFTPCOMInterface.dll Fr mre infrmatin abut the Registratin Tl, refer t Explanatin f Regsvr32 usage and errr messages n the Micrsft Supprt site. Belw are several facts t cnsider regarding remte administratin: SSL certificates cannt be created r managed remtely. Yu are prhibited frm creating certificates fr EFT while remtely administering EFT because this actin can create a security breach. Any certificates yu create remain n the cmputer n which yu created them, unless yu take steps t deliver and assciate these files with anther cmputer. Organizatins cmplying with the PCI DSS are required t use SSL fr remte administratin. If yu attempt t allw remte administratin n a High Security Site, a message warns yu that this setting vilates PCI DSS 2.3, and allws yu t cntinue with reasn r disable the feature. File brwse peratins are disabled fr remte administratin. Yu can, hwever, type a path that is relevant t the EFT cmputer (nt the remte interface). Yu are able t brwse fr a Settings Template flder, because yu are brwsing the VFS, nt the physical flders. When the trial perid has expired, all remte cnnectins are disallwed. Yu cannt cnfigure remte administratin remtely. Yu must cnfigure the lcal cnnectin befre yu can cnfigure a remte cnnectin. Fr remte Active Directry cnnectins, the cnnecting accunt must have access t the cmputer n which EFT is installed. Yu shuld restrict remte administratin t ne r mre knwn static IP addresses. By default, all IP addresses are granted remte access t EFT. EFT allws yu t grant access t nly ne specific IP address r a range f IP addresses, r deny access t ne specific address r a range f addresses. Fr cmmand-line lgin, the EFT listening IP address must be set t a specific IP address, nt All Incming. Remte administratin must be cnfigured and EFT must be in the same dmain as the cmputer frm which yu are attempting t lg in. If yu are lgged in t EFT remtely, yur username and passwrd are passed t the Windws System Services n the cmputer running EFT. The accunt that yu lg n with must have administrative rights t make any changes t the Glbalscape EFT service running n that cmputer. 18

19 Interface Reference If yu are using SQL Express as yur database, yu may nt be able t generate a reprt remtely, unless the cnnecting accunt is a trusted SQL Server cnnectin (e.g., if SQL Server and the remte cmputer are in the same dmain, r if SQL Server is cnfigured t allw "mixed authenticatin.") When bjects are created, added, remved, mdified, enabled, disabled, started, r stpped remtely, the actin is lgged t the database and reprted in the Administratr Actins Lg. The EFT variable fr remte EFT cnnectins is %CONNECTION.REMOTE_IP%. Using the API (with Examples) This sectin prvides general guidance and examples t demnstrate cmmn f uses f the API. Using the API T start using the API, create the SFTPCOMInterface.CIServer class bject, and then apply the methds and prperties in the bject. Fr example: Set SFTPServer = WScript.CreateObject("SFTPCOMInterface.CIServer") ' Get rule's statement with index 0 Belw is the general sequence: 1. Add a COM library reference t yur prject (e.g., Slutin Explrer => Right click n References => Add Reference => COM tab => SFTPCOMInterface 1.0 Type Library ) 2. Add a using directive t yur surces: using SFTPCOMINTERFACELib; 3. Create the Server bject: CIServer server = new CIServer(); 4. Cnnect t EFT: server.cnnect("server_hst", Server_prt, "Admin_lgin", "Admin_Passwrd"); 5. Retrieve/mdify sites, cmmands, users, event rules, and s n. Fr example, t deal with Event Actin statements ( If statement and Actin statement), determine their exact types and then cast t it: ICIEventRule rule = ; if (((ICIEventRuleStatement)rule.Statement(0)).type == EventRuleStatementType.ActinStatement) { ICIActinStatement actinstatement = (ICIActinStatement)rule.Statement(0); // manipulate with actin } else { ICIIfStatement ifstatement = (ICIIfStatement)rule.Statement(0); // manipulate with cnditin } MORE INFORMATION The API des nt allw changing Event Rules if the change vilates the Rule s integrity (invariant): Yu cannt use an Actin/Cnditin if it is frbidden fr this Event (e.g., the AS2 Send Actin is frbidden fr On Server Stpped events). 19

20 EFT API Reference Yu cannt change a Cnditin s value/peratr if the value/peratr is incnsistent with the Cnditin (e.g., If Server Status Cnditin des nt allw the Is One Of peratr). Yu cannt change an Actin s parameters if new nes are incnsistent (e.g., 'actin.params = PGPParams where PGPParams cntains an empty file path r incnsistent pair, Operatin = Encrypt + Empty Key ID list ). Scripting Standards As yu identify tasks that yu can perfrm with scripts, yu will quickly have a large cllectin f scripts that yu want t save, share with ther administratrs, and reuse. Fr ease f use and maintenance, yu shuld develp a scripting standard that all administratrs fllw when creating and editing scripts in the cllectin. Fllwing a standard style allws any administratr t pen a script, knw its purpse, and make any necessary custmizatin. When yu view/create scripts in Ntepad, it is very difficult t separate cmments frm cde. Fllwing a standard scripting/cding style will make yur scripts easier t read. There are als many tls (e.g., EditPlus) that display the varius cmpnents in different clrs, making reading easier. Belw are sme suggestins fr scripting standards. Cmment sectin at the tp f the script that cntains the script's name, authr, creatin date, mdified date, mdified by, descriptin (its purpse), and requirements/dependencies f the script (e.g., AD-specific, EFT Enterprise nly), if any. Cmments befre each subsectin stating the purpse f the sectin Cmments regarding where the data r result is stred/cmes frm (e.g., writes the result t the Windws Event Viewer; appears in EFT Admin Actins reprt) Cding cnventins might include naming cnventins fr bjects, variables, and prcedures; cmmenting cnventins; and text frmatting and indenting guidelines The example belw shws a basic header and cmmented subsectins. 1 ' FILE: SetPermissin 2 ' CREATED: 13 OCT 2004 RTO 3 ' PURPOSE: Creates a user, creates sme virtual flders, and sets varius permissins. 4 ' DEPENDENCIES: Be sure t edit the script fr yur cnnectins parameters 5 ' (Admin ID, Passwrd, Prt, Server...). 6 ' ==================================== 7 Private Sub Cmmand1_Click() 8 9 Set SFTPServer = CreateObject("SFTPCOMInterface.CIServer") 'instantiate EFT COM Object ' ===================================== 13 ' Initialize cnnectin parameters 14 ' ===================================== Dim sadminid, sadminpassrd, sadminserver, Sites, Site 17 sadminid = "eft" 'change this t yur admin username 18 sadminpasswrd = "eftserver" 'change this t yur admin passwrd 19 sadminprt = "1100" 'change this t yur admin prt 20 sadminserver = " " 'change this t the IP address fr the admin cnnectin t the Server 21 20

21 Interface Reference Difference between VARIANT_BOOL and SFTPAdvBl In EFT, a check bx can be selected (usually TRUE) r cleared (usually FALSE) in the user accunt, inherited frm its Settings Template, r inherited frm the Site. Fr this reasn, the API needs the crrespnding functins: VARIANT_BOOL and SFTPAdvBl. VARIANT_BOOL has nly tw pssible values: VARIANT_FALSE(0) VARIANT_TRUE(-1) SFTPAdvBl has three pssible values: abfalse = 0 abinherited = -2 abtrue = 1 When a script calls a functin and wants t knw the state (enabled/disabled) f that value, the result is either -1 (selected) r 0 (cleared). VARIANT_BOOL cannt return infrmatin abut the inheritance f that value, nly whether it is selected r cleared. Hwever, a check bx setting can be inherited (TRUE) and cleared (FALSE). Fr these functins, SFTPAdvBl is used instead f VARIANT_BOOL. All three pssible check bx states are stred in SFTPAdvBl: typedef enum { abfalse = 0, abtrue = 1, abinherited = -2 } SFTPAdvBl; S t make the state inherited, (-2) shuld be called. Anther parameter, pinherited, is similar t VARIANT_BOOL, but declared as a VARIANT due t VB limitatins. pinherited is -1(VARIANT_TRUE) when pval was inherited frm the upper level and 0(VARIANT_FALSE) when it is nt inherited. Script Examples The fllwing scripts prvide examples t guide yu in yur wn script design. Each script is named per its functin. Fr example, the CnfigureAdminUser script can be used t cnfigure an administrative user accunt. If yu d nt have the sftware t pen r edit CS r VBS files, yu can pen the script in a text editr t review the script fr details f hw it wrks and edit it. If yu need help with custm scripts, cntact Glbalscape Prfessinal Services. Never use these scripts as is! These scripts are just examples. Yu must edit the scripts t reflect yur envirnment (user accunts, passwrds, paths, prts, and s n). Each f the scripts described belw is available in a ZIP file. The scripts are rganized in the ZIP file by hw it is t be used. (e.g., CreatUsers.cs is in the Users flder.) D nt duble-click the script file t pen it. Duble-clicking will cause it t execute. Instead, right-click the file then click Open with and select yur text editr f chice, r save it with a TXT extensin, edit it in a text editr, and then save it with the CS r VBS extensin. Test a cnnectin t the ARM database - These scripts use the ICIServer ARMTestCnnectin and ARMRecnnect methds. ARM.cs ARM.vbs Specify ARM parameters, restre cnfiguratin (frm a backup), and then start the service - These scripts use ICIServer BackupServerCnfiguratin, GetBackupArchiveInf, RestreServerCnfiguratinEx methds (and thers). 21

22 EFT API Reference Backup.cs Backup.vbs BackupEx.cs BackupEx.vbs Cnfigure a specific Site - These scripts use ICISite methds such as SetAllwFXP t retrieve r set a specified Site's settings. CnfigureSite.cs CnfigureSite.vbs Cnfigure a user accunt - These scripts use ICISite, ICIClientSettings, and ICIResetPasswrdSettings methds t retrieve r set user accunt settings. CnfigureUser.cs CnfigureUser.vbs Create an administratr accunt - These scripts use ICISite, ICIClientSettings, and ICIResetPasswrdSettings methds t retrieve r set user accunt settings. CreateAdminUser.cs CreateAdminUser.vbs Cnfigure an administratr user accunt - These scripts use ICIAdminAccunt and ICIAdminPermissin methds t cnfigure an administratr accunt. CnfigureAdminUser.cs CnfigureAdminUser.vbs Create a Site - These scripts use the ICISites AddLcalSite methd t create a new site n the server. CreateSite.cs CreateSite.vbs Create 1,000 users (fr testing purpses) - These scripts use the ICISite CreateUserEx methd t create 1,000 users. CreateUsers.cs CreateUsers.vbs Create an Event Rule - These scripts use ICIFlderMnitrEventRuleParams, ICIEventRule, ICIDwnladActinParams, ICIUpladActinParams, ICITimerEventRuleParams, and ICIAWTaskActinParams methds t create Event Rules n the Site. EventRuleCreatin.cs OnTimerEventRuleCreatin.vbs OnTimerEventRuleFrAwe.vbs Retrieve Trusted Certificate ID, descriptin, and cmmn name fr a Site - These scripts use the ICISite GetTrustedCertificates methd. GetCertInf.cs GetCertInf.vbs 22

23 Interface Reference Cnfigure an ODBC Site - These scripts use the ICIODBCAuthManagerSettings RefreshIntervalMinutes and UserDatabaseCnnectinString methds, and ICISite SetAMParams methd (and thers) t create an ODBC-authenticated Site. ODBCAuthOptins.cs ODBCAuthOptins.vbs Imprt PGP key - These scripts use the ICIServer ImprtSSHKey and thers t imprt a PGP key int the server. PGP.cs PGP.vbs Delete a Site frm the Server - These scripts use the ICISites Item methd t specify and then remve a Site. RemveSite.cs RemveSite.vbs Specify IP address access n a Site - These scripts use the AddIPAccessRule and GetAllwedMasks methds. ServerIPBanEntry.cs ServerIPBanEntry.vbs Retrieve a user s IP address access - These scripts use the ICIClientSettings AddIPAccessRule methd. UserIPBanEntry.cs UserIPBanEntry.vbs Retrieve Server statistics (uptime, prperties, last mdified time, last mdified by accunt) - These scripts use the ICIServer LastMdifiedBy and LastMdifiedTime prperties. ServerStats.cs ServerStats.vbs Retrieve Site statistics (last mdified time, last mdified by accunt) - These scripts use the ICISite LastMdifiedBy and LastMdifiedTime prperties. SiteStats.cs SiteStats.vbs Exprt each SSH key and re-imprt them with an altered name, create list, add all available keys t a user, assign all keys in the list t the user - These scripts use the ICIServer AvailableSSHKeys and ICIClientSettings SetSSHKeyIDs methds (and thers) t imprt and assign an SSH key t a user. SSH.cs SSH.vbs Create a User Settings Template - These scripts use ICISite methds GetUserSettings, GetSettingsLevelSettings, and thers, and ICIResetPasswrdSettings methds t create and cnfigure a User Settings Template. UserSettingsTemplates.cs Retrieve user accunt statistics (last mdified time, last mdified by accunt, whether accunt is lcked) - These scripts use the ICIClientSettings methds and prperties. 23

24 EFT API Reference UserStats.cs UserStats.vbs Retrieve VFS settings fr all flders fr a particular Site - These scripts use the ICISite methds GetFlderList, GetFlderPermissins, IsVirtualFlder, IsEncrypted (and thers) t retrieve VFS settings fr the Site. VFS.cs VFS.vbs Retrieve and update Windws authenticatin ptins fr an Active Directry site - These scripts use the ICIADAuthManagerSettings prperties. WindwsAuthOptins.cs WindwsAuthOptins.vbs Hw D the IP Access/Ban Methds and Prperties Wrk? Several interfaces, methds, prperties, and an enum can be used t retrieve and set IP addresses that are denied r allwed access. The diagram and descriptin belw describe hw the interfaces, methds, prperties, and enum all wrk tgether. Scrll dwn t Related Tpics fr links t the IP-related interfaces, methds, prperties, and enum. Fr an example f an IP ban access script, refer t Script Examples: UserIPBanEntry. The ICIServer, ICISite, r ICIClientSettings interfaces each prvide a GetIPAccess() methd t retrieve an array (list) f IP access rules, regardless f hw thse rules were created, whether autmatically due t aut-ban, r manually with deny/allw assigned t an IP address. The array f IP rules returned by GetIPAccess() will be different depending n whether yu invke the methd under the ICIServer, ICISite, r ICIClientSettings interface. ICIIPAccessRule is the parent interface fr managing IP access rules. It returns the IP access rule type (manual r aut) fr a given rule in the array f IP rules btained using GetIPAccess(). The available types are 0 fr aut-banned IPs, 1 fr manually added IPs (which culd be banned r allwed). Tw interfaces inherit frm ICIIPAccessRule: ICIManualIPAccessRule and ICIAutbanIPAccessRule. ICIManualIPAccessRule is used t btain the prperties f an IP rule that was manually added t the IP access rule set. Thse prperties include the IP address, whether the IP is allwed r denied, and the date the IP was added t the IP access rule set. ICIAutbanIPAccessRule is used t btain an array f autmatically banned IPs as a subset f the entire array f IP access rules. After yu have the ICIAutbanIPAccessRule array, yu use ICIBannedIP t btain the prperties fr each f thse aut-banned IP rules, including the IP address, the date banned, whether the ban is permanent r temprary ban, the ban expiratin (if applicable), and ban reasn. 24

25 Interface Reference 25

26 EFT API Reference Related Tpics ICIAutbanIPAccessRule - Prvides the Autban IP access rule BannedIPs prperty ICIBannedIP - Represents an entry in an IP address autban list ICIClientSettings AddIPAccessRule - Adds allwed (true) r denied (false) IP mask fr the client GetIPAccessRules - Retrieves an array f client/template IP Access rules GetLimitAccessByIP - Determines if the IP Access Restrictin List is enabled n the Settings Template r user accunt IPAccessAllwedDefault - Set r retrieve whether user r Settings Template IP access settings allw r deny access by default (if n rule match) MveIPAccessRule - Change allwed IP access rule psitin ICIManualIPAccessRule - Represents an IP address access rule that was added manually ICIServer ICISite AddIPAccessRule - Adds allwed r denied IP mask fr administratin GetAdminIPs - Retrieve an array f IP addresses fr the cmputer n which the Server is running GetIPAccessRules - Retrieve an array f administratin IP address access rules GetLcalIP - Given an index, retrieves a Lcal IP address IPAccessAllwedDefault - Retrieve r specify the default IP Access restrictin list ListenIP - Retrieve r specify the server's IP address ListenIPs - Retrieve r specify the IP addresses n which the server listens MveIPAccessRule - Change allwed administratin IP access rule psitin. RemveIPAccessRule - Remve allwed r denied IP mask fr administratin UnbanIP - Remve denied IP mask frm Autban list fr administratin AddIPAccessRule - Adds allwed r denied IP mask fr the Site AutBanIPsPermanently - Retrieve r specify whether t autmatically ban IP addresses permanently BanIPFrInvalidLginAttempts - Retrieve r specify whether t ban an IP address after excessive invalid lgin attempts with existing username and wrng passwrd. BanIPFrInvalidLginAttemptsWithExistingUsername - When banning an IP address fr invalid lgin attempts, specify whether t cunt incrrect username and crrect username + incrrect passwrd r nly incrrect username attempts. BanIPOnDOS - Retrieve r specify whether t ban an IP address after excessive invalid cmmands GetIP - Retrieves the index f the Site Listen IP GetIPAccessRules - Retrieves an array f allwed IP masks. IPAccessAllwedDefault - Retrieve r specify whether IP access is allwed by default ListenIPs - Retrieve r specify the IP addresses n which the Site listens 26

27 Interface Reference MveIPAccessRule - Change allwed r denied IP mask psitin fr the Site RemveIPAccessRule - Remve allwed r denied IP mask fr the Site SetIP - Changes the index f Listen IP UnbanIP - Remves denied IP mask frm the Autban list fr the Site IPAccessRuleType enum Interface Reference The interfaces in the API are listed in this sectin in alphabetical rder. See als: Enum Reference. ICIActinStatement - Actin Statement Interface ICIActinStatements - Actin Statements Interface ICIADAuthManagerSettings - Active Directry Authenticatin Manager Settings Interface IAdhcMessage - Ad Hc Message Interface ICIAdminAccunt - Administratr Accunt Interface ICIAdminPermissin - Administratr Permissin Interface ICIAdvancedWrkflwParams - Advanced Wrkflw Parameters Interface ICIAS2InbundSettings - AS2 Inbund Settings Interface ICIAS2OutbundSettings - AS2 Outbund Settings Interface ICIAS2SendActinParams - AS2 Send Actin Parameters Interface ICIAS2TransactinInf - AS2 Transactin Infrmatin Interface ICIAudit - Audit Interface ICIAutbanIPAccessRule Interface ICIAWTaskActinParams - Autmated Wrkflw Task Event Actin Parameters Interface ICIBackupActinParams - Backup Actin Parameters ICIBackupArchiveInf - Backup Archive Infrmatin Interface ICIBannedIP Interface ICICertInf - Certificate Infrmatin Interface ICICleanupActinParams - Cleanup Actin Parameters ICIClientSettings - Client Settings Interface Methds and Prperties ICICmmandActinParams - Cmmand Actin Parameters Interface ICICmmandSettings - Cmmand Settings Interface ICICmplexPasswrdSettings - Cmplex Passwrd Settings Interface ICICmpundCnditin - Cmpund Cnditin Interface ICICnnectedUser - Cnnected User Interface ICIDMZGateway - DMZ Gateway Interface ICIDwnladActinParams - Dwnlad Actin Parameters Interface Prperties 27

28 EFT API Reference ICIEventActin - Event Actin Interface Prperties ICIEventActins - Event Actins Interface Methds ICIEventInf - Event Infrmatin Interface ICIEventRule - Event Rule Interface ICIEventRuleParams - Event Rule Parameters Interface ICIEventRules - Event Rules Interface ICIEventRuleStatement - Event Rule Statement Interface ICIFlderMnitrEventRuleParams - Flder Mnitr Event Rule Parameters Interface ICIGSAuthManagerSettings - GlbalSCAPE Authenticatin Manager Settings Interface ICIIfStatement - If Statement Interface ICILDAPAuthManagerSettings - LDAP Authenticatin Manager Settings Interface ICIMailActinParams - Mail Actin Parameters Interface ICIManualIPAccessRule Interface ICINewUserData Interface ICIOCBCAuthManagerSettings - ODBC Authenticatin Manager Settings Interface ICIPermissin - VFS Permissin Interface ICIPgpActinParams - OpenPGP Actin Interface ICIPGPKeyInf - OpenPGP Key Infrmatin Interface ICIReprtActinParams - Reprt Actin Parameters Interface ICIReprtInf - Reprt Infrmatin Interface ICIResetPasswrdSettings - Reset Passwrd Settings Interface ISATMessage ICIServer - Server Interface ICISimpleCnditin - Simple Cnditin Interface ICISite - Single-Site Management ICISiteBackupInf - Site Backup Infrmatin Interface ICISites - Multi-Site Interface ICISSHKeyInf - SSH Key Infrmatin Interface ICIStpActinParams - Stp Actin Parameters Interface ICITimerEventRuleParams - Timer Event Rule Parameters Interface ICITransferActinParams - Transfer Actin Parameters Interface ICIUpladActinParams - Uplad Actin Parameters Interface Prperties ICIWindwsEventLgActinParams - Windws Event Lg Actin Parameters Interface 28

29 Interface Reference ICIActinStatement - Actin Statement Interface The ICIActinStatement interface allws yu t make changes t the Event Rule settings. (See als ICIBackupActinParams - Backup Actin Parameters.) interface ICIActinStatement : ICIEventRuleStatement If ActinStatement.Actin.Type = BackupActin Then Set BackupParams = ActinStatement.Actin.Params Mdify backup parameters and assign them back t the actin... ActinStatement.Actin.Params = BackupParams End If "Functin" indicates that the member is a methd; "Prperty" indicates that it is a prperty. Functin Actin() As Object Retrieves r specifies the actin. HRESULT Actin( [ut, retval] IDispatch** ppdispactin); EFT v5.2 and later Functin FailSectin() As Object Retrieves r specifies what ccurs if the Event Rule fails. HRESULT FailSectin( [ut, retval] IDispatch** ppdispactins); EFT v5.2 and later Prperty type As EventRuleStatementType (read-nly); Retrieves r specifies the type f Event Rule statement (actin r cnditinal). EFT v5.2 and later ICIActinStatements - Actin Statements Interface The ICIActinStatements interface allws yu t make changes t the Event Rule settings. interface ICIActinStatements : IDispatch "Functin" and "Sub" indicate that the member is a methd. Methds Functin Add(lIndex As Lng, pdispactinparams As Object) As Object Adds actin statement at specified psitin. HRESULT Add( [in] lng lindex, [in] IDispatch* pdispactinparams, [ut, retval] IDispatch** ppdispactinstatement); EFT v5.2 and later Functin Cunt() As Lng Retrieves a number f listed actin statements. 29

30 EFT API Reference HRESULT Cunt( [ut, retval] lng* plcunt); EFT v5.2 and later Sub Delete(lIndex As Lng) Deletes actin statement by index. HRESULT Delete( [in] lng lindex); EFT v5.2 and later Functin Item(lIndex As Lng) As Object Retrieves r specifies an actin statement bject by index. (Refer t ICIActinStatement interface.) HRESULT Item( [in] lng lindex, [ut, retval] IDispatch** ppdispactinstatement); EFT v5.2 and later ICIADAuthManagerSettings - Active Directry Authenticatin Manager Settings Interface Use the ICIADAuthManagerSettings interface t specify Active Directry authenticatin settings n a Site. interface ICIADAuthManagerSettings : IDispatch { VARIANT_BOOL equals VARIANT_TRUE(-1) when it is true and VARIANT_FALSE(0) when it is false. See als: Difference Between VARIANT_BOOL and SFTPAdvBl ICISites - Multi-Site Management T see a sample script, refer t Script Examples. Scrll dwn t see the dialg bx equivalents. Fr an example using these prperties, refer t the Windws Authenticatin script in Script Examples. Prperties Prperty AssignHmeFlderFrmUserPrfile As Blean Retrieves r specifies whether t create a virtual flder using the user's hme flder in the user's AD prfile r t create a physical flder under the Site rt flder using the user's username. HRESULT AssignHmeFlderFrmUserPrfile( [ut, retval] VARIANT_BOOL* pval); HRESULT AssignHmeFlderFrmUserPrfile( [in] VARIANT_BOOL newval); TRUE(-1) =Virtual flder; FALSE(0) =Physical flder Prperty Dmain As String Retrieves r specifies the dmain name f the AD server. HRESULT Dmain( 30

31 Interface Reference [ut, retval] BSTR* pval); HRESULT Dmain( [in] BSTR newval); Prperty Grup As String Retrieves r specifies the Grup t use fr Windws authenticatin (Everyne r a specific grup). HRESULT Grup( [ut, retval] BSTR* pval); HRESULT Grup( [in] BSTR newval); Prperty LgnAttribute As ADAuthManagerLgnAttribute Retrieves r specifies which user attribute t use fr the lgn name. HRESULT LgnAttribute( [ut, retval] ADAuthManagerLgnAttribute* pval); HRESULT LgnAttribute( [in] ADAuthManagerLgnAttribute newval); Prperty RefreshIntervalMinutes As Lng Retrieves r specifies the number f minutes between refreshing the user database. HRESULT RefreshIntervalMinutes( [ut, retval] LONG* pval); HRESULT RefreshIntervalMinutes( [in] LONG newval); Prperty SkipDmainPrefix As Blean Retrieves r specifies whether t add the dmain prefix t the flder name. HRESULT SkipDmainPrefix( [ut,retval] VARIANT_BOOL* pval); HRESULT SkipDmainPrefix( [in] VARIANT_BOOL newval); TRUE(-1) = Skip dmain prefix; FALSE(0) =D nt skip dmain prefix MsgBx "Skip dmain prefix: " & CStr(ADAM.SkipDmainPrefix) ADAM.SkipDmainPrefix = False Prperty Type As ADAuthManagerType Retrieves r specifies whether t use an AD server r lcal system accunt fr Windws authenticatin. HRESULT Type( [ut, retval] ADAuthManagerType* pval); HRESULT Type( 31

32 EFT API Reference [in] ADAuthManagerType newval); Dialg Bx Equivalents The ICIADAuthManagerSettings interface prperties crrelate t the fllwing fields and cntrls in the EFT administratin interface: IAdhcMessage - Ad Hc Message Interface This interface is used as an input parameter t ICIAudit t lg ad hc transfer activity frm Mail Express t recrd "ad hc" prtcl activity and trigger file-uplad/dwnlad Event Rules. Prperties Prperty BytesTransferred As Signed Duble Lng Retrieves the number f bytes transferred. HRESULT BytesTransferred([in] LONGLONG newval); HRESULT BytesTransferred([ut, retval] LONGLONG *pval); EFT v6.5 and later Prperty DisplayName As String Retrieves the display name f the agent respnsible fr the transfer. HRESULT DisplayName([in] BSTR newval); HRESULT DisplayName([ut, retval] BSTR *pval); EFT v6.5 and later Prperty Address As String Retrieves the address f the agent respnsible fr the transfer. HRESULT Address([in] BSTR newval); HRESULT Address([ut, retval] BSTR *pval); EFT v6.5 and later 32

33 Interface Reference Prperty ExternalRef As String Retrieves the reference identifier within the ad hc database. HRESULT ExternalRef([in] BSTR newval); HRESULT ExternalRef([ut, retval] BSTR *pval); EFT v6.5 and later Prperty FileSize As Signed Duble Lng Retrieves the size f the item transferred. HRESULT FileSize([in] LONGLONG newval); HRESULT FileSize([ut, retval] LONGLONG *pval); EFT v6.5 and later Prperty IsDispatchEvent As Blean Retrieves whether an event shuld be dispatched fr this transfer. HRESULT IsDispatchEvent([in] VARIANT_BOOL newval); HRESULT IsDispatchEvent([ut, retval] VARIANT_BOOL *pval); EFT v6.5 and later Prperty IsUplad As Blean Retrieves the whether the adhc transfer was inbund r utbund. HRESULT IsUplad([in] VARIANT_BOOL newval); HRESULT IsUplad([ut, retval] VARIANT_BOOL *pval); EFT v6.5 and later Prperty LcalAddr As Blean Retrieves the address f the service facilitating the transfer. HRESULT LcalAddr([in] BSTR newval); HRESULT LcalAddr([ut, retval] BSTR *pval); EFT v6.5 and later Prperty LcalPrt As Int Retrieves the prt f the service facilitating the transfer. HRESULT LcalPrt([in] INT newval); HRESULT LcalPrt([ut, retval] INT *pval); EFT v6.5 and later Prperty PhysicalDirectry As String Retrieves the physical directry f the item transferred. HRESULT PhysicalDirectry([in] BSTR newval); HRESULT PhysicalDirectry([ut, retval] BSTR *pval); EFT v6.5 and later Prperty PhysicalFileName As String Retrieves the physical filename f the item transferred. HRESULT PhysicalFileName([in] BSTR newval); HRESULT PhysicalFileName([ut, retval] BSTR *pval); EFT v6.5 and later 33

34 EFT API Reference Prperty PhysicalPath As String Retrieves the physical path f the item transferred. HRESULT PhysicalPath([in] BSTR newval); HRESULT PhysicalPath([ut, retval] BSTR *pval); EFT v6.5 and later Prperty RemteAddr As String Retrieves the address f the agent respnsible fr the transfer. HRESULT RemteAddr([in] BSTR newval); HRESULT RemteAddr([ut, retval] BSTR *pval); EFT v6.5 and later Prperty RemtePrt As Int Retrieves the prt f the agent respnsible fr the transfer. HRESULT RemtePrt([in] INT newval); HRESULT RemtePrt([ut, retval] INT *pval); EFT v6.5 and later Prperty SiteName As String Retrieves the Site n which the ad hc transfer ccurred. HRESULT SiteName([in] BSTR newval); HRESULT SiteName([ut, retval] BSTR *pval); EFT v6.5 and later Prperty Timestamp As Date Retrieves the timestamp f the ad hc transfer. HRESULT Timestamp([in] DATE newval) HRESULT Timestamp([ut, retval] DATE *pval); EFT v6.5 and later Prperty UserName As String Retrieves the username f the agent respnsible fr the transfer. HRESULT UserName([in] BSTR newval); HRESULT UserName([ut, retval] BSTR *pval); EFT v6.5 and later Prperty VirtualDirectry As String Retrieves the virtual directry f the item transferred. HRESULT VirtualDirectry([in] BSTR newval); HRESULT VirtualDirectry([ut, retval] BSTR *pval); EFT v6.5 and later Prperty VirtualFileName As String Retrieves the virtual filename f the item transferred. HRESULT VirtualFileName([in] BSTR newval); HRESULT VirtualFileName([ut, retval] BSTR *pval); EFT v6.5 and later 34

35 Interface Reference Prperty VirtualPath As String Retrieves the virtual path f the item transferred. HRESULT VirtualPath([in] BSTR newval); HRESULT VirtualPath([ut, retval] BSTR *pval); EFT v6.5 and later ICIAdminAccunt - Administratr Accunt Interface The ICIAdminAccunt interface is used t view, add, r remve permissins n administratr accunts. See als ICIAdminPermissin - Administratr Permissin Interface. interface ICIAdminAccunt : IDispatch "Functin" and "Sub" indicate that the member is a methd; "Prperty" indicates that it is a prperty. Members Sub AddPermissin(pIAdminPermissin As Object) Adds permissin t an administratr accunt. AddPermissin( [in] IDispatch* piadminpermissin); Admin.AddPermissin COMPerm Functin GetPermissin(nIndex As DWrd) As Object Fr an example using this methd, refer t the RetrieveAdminUser script in Script Examples. See als GetPermissinsCunt, belw. Retrieves the permissin n an administratr accunt. HRESULT GetPermissin( [in] ULONG nindex, [ut, retval] IDispatch** piadminpermissin); Set AdminPerm = Admin.GetPermissin(0) Example (C#): CIAdminPermissin permissin = (CIAdminPermissin)admin.GetPermissin((uint)i); Functin GetPermissinsCunt() As DWrd Fr an example using this methd, refer t the RetrieveAdminUser script in Script Examples. See als GetPermissin, abve. Retrieves the number f permissins n an administratr accunt. GetPermissinsCunt( [ut, retval] ULONG* pval); npermcunt = Admin.GetPermissinsCunt() 35

36 EFT API Reference Example (C#): fr (int i = 0; i < admin.getpermissinscunt(); i++) Prperty Lgin As String, read-nly Fr an example using this prperty, refer t the RetrieveAdminUser script in Script Examples. Retrieves the username f the accunt. HRESULT Lgin( [ut, retval] BSTR* pval); MsgBx "Admin lgin: " & Admin.Lgin Example (C#): Retrieving (admin inf): Cnsle.WriteLine(string.Frmat("Admin user [{0}] has the fllwing permissins:", admin.lgin)); Specifying (admin accunt): ICIAdminAccunt adminuser = (ICIAdminAccunt)m_server.CreateAdmin("Test_Administratr", "Tester!1", AdminAccuntType.EFTAccunt, false); Cnsle.WriteLine(string.Frmat("Admin lgin {0} created.", adminuser.lgin)); Sub RemveAllPermissins() Remves all administratr permissins. RemveAllPermissins(); Admin.RemveAllPermissins() Sub RemvePermissin(pIAdminPermissin As Object) Remves an administratr permissin. RemvePermissin( [in] IDispatch* piadminpermissin); Admin.RemvePermissin COMPerm Sub RemvePermissinByIndex(nIndex As DWrd) Remves a permissin by index. RemvePermissinByIndex( [in] ULONG nindex); Admin.RemvePermissinByIndex 0 36

37 Interface Reference Prperty type As AdminAccuntType read-nly Retrieves whether the accunt is an EFTr-managed accunt, lcal user accunt, r an AD accunt. HRESULT Type( [ut, retval] AdminAccuntType* pval); Cnst EFTAccunt = 0 Cnst LcalCmputerAccunt = 1 Cnst ADAccunt = 2 if EFTAccunt = Admin.Type then MsgBx "It is GS admin" end if ICIAdminPermissin - Administratr Permissin Interface The ICIAdminPermissin interface is used t retrieve access and permissin infrmatin abut an administratr accunt. See als ICIAdminAccunt - Administratr Accunt Interface. interface ICIAdminPermissin : IDispatch Prperties Prperty Permissin As AdminPermissinsPlicy Retrieves r specifies the permissin n an administratr accunt. HRESULT Permissin( [ut,retval]adminpermissinsplicy* pval); HRESULT Permissin(AdminPermissinsPlicy newval); if ServerManagement = AdminPerm.Permissin then MsgBx "It is server admin." end if Prperty SiteName As String Retrieves the Site name(s) fr SiteManagement, STManagement, UserCreatin and ChangePasswrd permissins. HRESULT SiteName( [ut,retval]bstr* pval); HRESULT SiteName(BSTR newval); strsitename = AdminPerm.SiteName AdminPerm.SiteName = "MySite" Prperty TemplateName As String 37

38 EFT API Reference Retrieve/specifies the Settings Template name fr STManagement, UserCreatin, and ChangePasswrd permissins. HRESULT TemplateName( [ut,retval]bstr* pval); HRESULT TemplateName(BSTR newval); strstname = AdminPerm.TemplateName AdminPerm.TemplateName = "My Settings Template" ICIAdvancedWrkflwParams - Advanced Wrkflw Parameters Interface The ICIAdvancedWrkflwParams interface allws yu t create/mdify/retrieve Advanced Wrkflw cnfiguratin. Edit wrkflw idxaw = site.getadvancedwrkflwindex( My Wrkflw ) if idxaw <> -1 Then Set AWparams = site.getadvancedwrkflwparams(idxaw) Change AWparams prperties... and apply changes site.setadvancedwrkflwparams idxaw, AWparams End If The CIAdvancedWrkflwParams c-class supprts the creatin f Advanced Wrkflws, and implements the ICIAdvancedWrkflwParams interface. set AWParams = CreateObject("SFTPCOMInterface.CIAdvancedWrkflwParams")...setup wrkflw parameters site.addadvancedwrkflw(awparams) Prperties Prperty Cde Retrieves r specifies the surce cde f Advanced Wrkflw. HRESULT Cde([ut, retval] BSTR *pval); HRESULT Cde([in] BSTR newval); MsgBx AWparams.Cde Let sme_cde_frm_file be a cntent f a file prduced by AW Task Builder AWparams.Cde = sme_cde_frm_file 38

39 Interface Reference EFT v6.5 and later Prperty DateCreated (Read-nly) Retrieves the time when the Advanced Wrkflw was created. HRESULT DateCreated([ut, retval] DATE *pval); MsgBx Task was created: & CStr(AWparams.DateCreated) EFT v6.5 and later Prperty Descriptin Retrieves r specifies the descriptin f Advanced Wrkflw. HRESULT Descriptin([ut, retval] BSTR *pval); HRESULT Descriptin([in] BSTR newval); MsgBx AWparams.Descriptin Mark as updated AWparams.Descriptin = AWparams.Name & (updated) EFT v6.5 and later Prperty LgMde (See AWLgMde enum.) Retrieves r specifies the debug lgging mde f the Advanced Wrkflw HRESULT LgMde([ut, retval] AWLgMde *pval); HRESULT LgMde([in] AWLgMde newval); If AWparams.LgMde = 0 Then n lgging... End If Turn n mst detailed lgging AWparams.LgMde = 3 EFT v6.5 and later Prperty Name Retrieves r specifies the name f Advanced Wrkflw. HRESULT Name([ut, retval] BSTR *pval); HRESULT Name([in] BSTR newval); MsgBx AWparams.Name 39

40 EFT API Reference Mark as updated AWparams.Name = AWparams.Name & (updated) EFT v6.5 and later Prperty TimeutSecnds Retrieves r specifies the maxim duratin (in secnds) f the Advanced Wrkflw executin after which it is frcibly terminated by EFT. (Value f 0 means "n timeut".) HRESULT TimeutSecnds([ut, retval] lng *pval); HRESULT TimeutSecnds([in] lng newval); If AWparams.TimeutSecnds = 0 Then n timeut... End If Set max duratin f wrkflw executin t 2 minutes AWparams.TimeutSecnds = 120 EFT v6.5 and later Dialg Bx Equivalents ICIAS2InbundSettings - AS2 Inbund Settings Interface The ICIAS2InbundSettings interface is used t define the AS2 inbund (retrieve) transactin settings fr a partner accunt. See als ICIAS2OutbundSettings - AS2 Outbund Settings Interface, ICIAS2SendActinParams - AS2 Send Actin Parameters Interface, and ICIAS2TransactinInf - AS2 Transactin Infrmatin Interface. interface ICIAS2InbundSettings : IDispatch See als: Difference Between VARIANT_BOOL and SFTPAdvBl ICIAS2OutbundSettings ICIAS2SendActinParams ICIAS2TransactinInf ICIClientSettings::AS2InbundSettings prperty 40

41 Interface Reference "Sub" indicates that the member is a methd; "Prperty" indicates that it is a prperty. Members Prperty AS2ID As String Retrieves r specifies a unique AS2-T ID that EFT will accept frm this partner s inbund messages. HRESULT AS2ID( [ut, retval] BSTR* pval); HRESULT AS2ID( [in] BSTR newval); MsgBx "My AS2 ID is: " & AS2I.AS2ID AS2I.AS2ID = "my_as2_id" Prperty AuthenticatinType As AS2AuthenticatinType Retrieves r specifies whether the client is authenticating with username and passwrd r using Message Level Security (MLS). HRESULT AuthenticatinType( [ut, retval] AS2AuthenticatinType* pval); HRESULT AuthenticatinType( [in] AS2AuthenticatinType newval); if AS2AuthTypeUsernameAndPasswrd = AS2I.AuthenticatinType then MsgBx "Usename and passwrd" end if AS2I.AuthenticatinType = AS2AuthTypeMsgLevelSecurity Prperty DubleCntentPlicy As AS2DubleCntentPlicy Retrieves r specifies verwrite, numerate, r reject AS2 transactins where the file is a duplicate f an existing file already residing in the uplad directry. HRESULT DubleCntentPlicy( [ut, retval] AS2DubleCntentPlicy* pval); HRESULT DubleCntentPlicy( [in] AS2DubleCntentPlicy newval); if AS2DubleCntentPlicyOverwrite = AS2I.DubleCntentPlicy then MsgBx "Overwrite" end if 41

42 EFT API Reference AS2I.DubleCntentPlicy = AS2DubleCntentPlicyReject Prperty DubleMsgIDPlicy As AS2DubleMsgIDPlicy Retrieves r specifies whether t accept r reject AS2 transactins with duplicate Message IDs. If an incming request has the same Message ID and the same paylad as a prir incming message, EFT sends the exact same respnse frm that prir transactin back t the client, and des nt extract r prcess the paylad (that is, discards the paylad, des nt save t file system, des nt trigger Event Rules, etc.). If an incming request has the same Message ID, but the paylad is different, EFT prcesses r discards the message based n the cnfiguratin prvided by the user. HRESULT DubleMsgIDPlicy( [ut, retval] AS2DubleMsgIDPlicy* pval); HRESULT DubleMsgIDPlicy( [in] AS2DubleMsgIDPlicy newval); if AS2DubleMsgIDPlicyAccept = AS2I.DubleMsgIDPlicy then MsgBx "Accept" end if AS2I.DubleMsgIDPlicy = AS2DubleMsgIDPlicyReject Prperty EFTIDMismatchPlicy As AS2IDMismatchPlicy Retrieves r specifies accept r reject AS2 transactins where the cnnecting partner s AS2-T ID des nt match EFT AS2 identifier defined fr that partner in that partner s AS2 Inbund tab. HRESULT EFTIDMismatchPlicy( [ut, retval] AS2IDMismatchPlicy* pval); HRESULT EFTIDMismatchPlicy( [in] AS2IDMismatchPlicy newval); if AS2IDMismatchPlicyAccept = AS2I.EFTIDMismatchPlicy then MsgBx "Accept." end if AS2I.EFTIDMismatchPlicy = AS2IDMismatchPlicyReject Prperty EncryptMissingPlicy As AS2EncryptMissingPlicy Retrieves r specifies whether EFT will Accept r Reject the transactin if it is nt encrypted. HRESULT EncryptMissingPlicy( [ut, retval] AS2EncryptMissingPlicy* pval); HRESULT EncryptMissingPlicy( [in] AS2EncryptMissingPlicy newval); 42

43 Interface Reference if AS2EncryptMissingPlicyAccept = AS2I.EncryptMissingPlicy then MsgBx "accept" end if AS2I.EncryptMissingPlicy = AS2EncryptMissingPlicyReject Functin GetFailureCmmand() As Object Retrieve ICICmmandActinParams interface, which specified a custm cmmand t ccur upn failure. HRESULT GetFailureCmmand( [ut, retval] IDispatch** ppdispcmmandparams); Set Cmd = AS2O.GetFailureCmmand() Functin GetFailure () As Object Retrieves the ICIMailActinParams interface, which specified ntificatin parameters that will be send after failure transactin happened. HRESULT GetFailure ( [ut, retval] IDispatch** ppdisp params); Set MailParams = AS2O.GetFailure () Functin GetSuccessCmmand() As Object Retrieve ICICmmandActinParams interface, which specified a custm cmmand t ccur upn successful transactin. HRESULT GetSuccessCmmand( [ut, retval] IDispatch** ppdispcmmandparams); Set Cmd = AS2O.GetSuccessCmmand() Functin GetSuccess () As Object Retrieve the ICIMailActinParams interface, which specified ntificatin parameters that will be sent after successful transactin happened. HRESULT GetSuccess ( [ut, retval] IDispatch** ppdisp params); Set MailParams = AS2O.GetSuccess () Prperty MDNAsyncSendTimeutSec As Lng 43

44 EFT API Reference Retrieves r specifies the timeut perid after which an asynchrnus MDN send attempt shall be cnsidered a failure if n respnse is received frm the remte server. Range: 0-600, 60 secnds is the default. 0 = n timeut. HRESULT MDNAsyncSendTimeutSec( [ut, retval] LONG* pval); HRESULT MDNAsyncSendTimeutSec( [in] LONG newval); MsgBx "MDN send timut is: " & CStr(AS2I.MDNSendTimeutSec) AS2I.MDNSendTimeutSec = 50 Prperty MDNSendRetriesCunt As Lng (In v6.3.0, it was "MDNSendAttemptRetries") Retrieves r specifies number f time t attempt t send MDN. Range: 0 (n retry) t 999; 10 is the default. HRESULT MDNSendRetriesCunt( [ut, retval] LONG* pval); HRESULT MDNSendRetriesCunt( [in] LONG newval); MsgBx "MDN send retries is: " & CStr(AS2I.MDNSendRetriesCunt) AS2I.MDNSendRetriesCunt = 40 Prperty MDNSendRetryDelaySec As Lng Retrieves r specifies retry interval. Range: 0 (n wait) t secnds; 30 secnds is the default. HRESULT MDNSendRetryDelaySec( [ut, retval] LONG* pval); HRESULT MDNSendRetryDelaySec( [in] LONG newval); MsgBx "MDN retry delays is: " & CStr(AS2I.MDNSendRetryDelaySec) AS2I.MDNSendRetryDelaySec = 120 EFT v6.3.1 and later Prperty MveReceivedDataTFlder As String Retrieves r specifies a flder in which t save received data. HRESULT MveReceivedDataTFlder( 44

45 Interface Reference [ut, retval] BSTR* pval); HRESULT MveReceivedDataTFlder( [in] BSTR newval); MsgBx "Destinatin flder is: " & AS2I.MveReceivedDataTFlder AS2I.MveReceivedDataTFlder = "C:\DestFlder" Prperty PartnerCertificatePath As String Retrieves r specifies the AS2 certificate t be used fr verifying signed messages. HRESULT PartnerCertificatePath( [ut, retval] BSTR* pval); HRESULT PartnerCertificatePath( [in] BSTR newval); MsgBx "AS2 partner certificate path: " & CStr(AS2I.PartnerCertificatePath) AS2I.PartnerCertificatePath = "C:\Certs\Ivan.crt" Prperty PartnerAS2ID As String Retrieves r specifies yur AS2 partner id. Used t identify the AS2-Frm ID fr inbund messages emanating frm partners. HRESULT PartnerAS2ID( [ut, retval] BSTR* pval); HRESULT PartnerAS2ID( [in] BSTR newval); MsgBx "My AS2 partner ID is: " & AS2I.PartnerAS2ID AS2I. PartnerAS2ID = "my_as2_partner_id" Prperty PartnerIDMismatchPlicy As AS2IDMismatchPlicy Retrieves r specifies accept r reject AS2 transactins where the cnnecting partner s AS2- Frm ID des nt match the AS2 identifier defined fr that partner. HRESULT PartnerIDMismatchPlicy( [ut, retval] AS2IDMismatchPlicy* pval); HRESULT PartnerIDMismatchPlicy( [in] AS2IDMismatchPlicy newval); 45

46 EFT API Reference if AS2IDMismatchPlicyAccept = AS2I.PartnerIDMismatchPlicy then MsgBx "Accept." end if AS2I.PartnerIDMismatchPlicy = AS2IDMismatchPlicyReject Prperty RenameFilesT As String Retrieves r specifies string that appends filename t path using specified variables. Preserve filename if undefined. HRESULT RenameFilesT( [ut, retval] BSTR* pval); HRESULT RenameFilesT( [in] BSTR newval); MsgBx "Rename files t: " & AS2I.RenameFilesT AS2I.RenameFilesT = "" Sub SetFailureCmmand(pdispCmmandParams As Object) Specify ICICmmandActinParams interface, which specified a custm cmmand t ccur upn failed send. HRESULT SetFailureCmmand( IDispatch* pdispcmmandparams); AS2O.SetFailureCmmand Cmd Sub SetFailure (psidp Params As Object) Use the ICIMailActinParams interface t specified ntificatin parameters that will be sent after failure transactin happened. HRESULT SetFailure ( IDispatch* pdisp params); AS2O.SetFailure MailParams Sub SetSuccessCmmand(psidpCmmandParams As Object) Specify the ICICmmandActinParams interface, which specified a custm cmmand t ccur upn successful transactin. HRESULT SetSuccessCmmand( IDispatch* pdispcmmandparams); AS2O.SetSuccessCmmand Cmd 46

47 Interface Reference Sub SetSuccess (psidp Params As Object) Use the ICIMailActinParams interface t specify ntificatin parameters that will be send after successful transactin happened. HRESULT SetSuccess ( IDispatch* pdisp params); AS2O.SetSuccess MailParams Prperty SignatureMissingPlicy As AS2SignatureMissingPlicy Retrieves r specifies whether EFT will accept r reject the transactin if it is nt signed. HRESULT SignatureMissingPlicy( [ut, retval] AS2SignatureMissingPlicy* pval); HRESULT SignatureMissingPlicy( [in] AS2SignatureMissingPlicy newval); if AS2SignatureMissingPlicyAccept = AS2I.SignatureMissingPlicy then MsgBx "accept" end if AS2I.SignatureMissingPlicy = AS2SignatureMissingPlicyReject Prperty SkipHTTPCntinue As Blean Retrieves r specifies "cntinue" ptin. "100 Cntinue" is a part f the HTTP prtcl and means "Everything is OK fr nw, cntinue this transactin." Many AS2 servers use it t avid timeuts. It is the client sftware's respnsibility t prcess this reply prperly (just skip until 200 OK r real HTTP errr is received). If the client des nt prcess the reply crrectly, yu can turn ff the "100 Cntinue" respnse. If yur AS2 partner receives multiple MDN failures when sending t EFT in HTTPS, turn ff the "100 Cntinue" reply. HRESULT SkipHTTPCntinue( [ut, retval] VARIANT_BOOL* pval); HRESULT SkipHTTPCntinue( [in] VARIANT_BOOL newval); MsgBx "Skip cntinue: " & CStr(AS2I.SkipHTTPCntinue) AS2I.SkipHTTPCntinue = False 47

48 EFT API Reference Dialg Bx Equivalents ICIAS2OutbundSettings - AS2 Outbund Settings Interface The ICIAS2OutbundSettings interface is used t define the AS2 utbund (send) transactin settings fr a partner accunt. interface ICIAS2OutbundSettings : IDispatch See als: Difference Between VARIANT_BOOL and SFTPAdvBl ICIAS2InbundSettings - AS2 Inbund Settings Interface, ICIAS2SendActinParams - AS2 Send Actin Parameters Interface ICIAS2TransactinInf - AS2 Transactin Infrmatin Interface ICIClientSettings::AS2OutbundSettings prperty "Sub" indicates that the member is a methd; "Prperty" indicates that it is a prperty. Members Prperty AS2ID As String 48

49 Interface Reference Specifies r retrieves the AS2 ID f the file sender. HRESULT AS2ID( [ut, retval] BSTR* pval); HRESULT AS2ID( [in] BSTR newval); Example (VBScript) MsgBx "My AS2 ID is: " & AS2O.AS2ID AS2O.AS2ID = "my_as2_id" Prperty AsyncReceiptTimeutMin As Lng Specifies r retrieves the maximum wait time (in minutes) fr asynchrnus AS2 receipt. This prperty is applicable nly if asynchrnus receipt is requested (i.e., ReceiptPlicy prperty is nt set t NReceipt and ReceiptDelivery prperty is set t Async). [ut, retval] LONG* pval); HRESULT AsyncReceiptTimeutMin( [in] LONG newval); MsgBx "AS2 asynchrnus receipt timeut: " & CStr(AS2O.AsyncReceiptTimeutMin) AS2O.AsyncReceiptTimeutMin = 6000 Prperty Cmpress As Blean Specifies r retrieves whether an AS2 file will be cmpressed befre sending. HRESULT Cmpress( [ut, retval] VARIANT_BOOL* pval); HRESULT Cmpress( [in] VARIANT_BOOL newval); MsgBx "AS2 cmpress message: " & CStr(AS2O.Cmpress) AS2O.Cmpress = False Prperty CntentType As AS2CntentType Specifies r retrieves cntent type f AS2 message t send. HRESULT CntentType( [ut,retval] AS2CntentType* pval); HRESULT CntentType( [in] AS2CntentType newval); 49

50 EFT API Reference if XML = AS2O.CntentType then MsgBx "AS2 cntent type: XML" end if AS2O.CntentType = Plaintext Prperty DeleteSurceFile As Blean Specifies r retrieves whether surce file will be remved after successful delivery t AS2 partner. HRESULT DeleteSurceFile( [ut, retval] VARIANT_BOOL* pval); HRESULT DeleteSurceFile( [in] VARIANT_BOOL newval); MsgBx "AS2 delete surce file: " & AS2O.DeleteSurceFile AS2O.DeleteSurceFile = False Prperty Encrypt As Blean Specifies r retrieves whether an AS2 message will be encrypted with the AS2 partner certificate. HRESULT Encrypt( [ut, retval] VARIANT_BOOL* pval); HRESULT Encrypt( [in] VARIANT_BOOL newval); MsgBx "AS2 encrypt message: " & CStr(AS2O.Encrypt) AS2O.Encrypt = True Prperty FileExcludeMask As String Specifies r retrieves which f the files must NOT be sent using the file mask. HRESULT FileExcludeMask( [ut, retval] BSTR* pval); HRESULT FileExcludeMask( [in] BSTR newval); MsgBx "AS2 exclude mask is: " & AS2O.FileExcludeMask 50

51 Interface Reference AS2O.FileExcludeMask = "*.*" Prperty FileIncludeMask As String Specifies r retrieves which f the files must be sent using the file mask. HRESULT FileIncludeMask( [ut, retval] BSTR* pval); HRESULT FileIncludeMask( [in] BSTR newval); MsgBx "AS2 include mask is: " & AS2O.FileIncludeMask AS2O.FileIncludeMask = "*.* " Functin GetFailureCmmand() As Object Retrieve ICICmmandActinParams interface, which specified the custm cmmand t ccur upn failure. HRESULT GetFailureCmmand( [ut, retval] IDispatch** ppdispcmmandparams); Set Cmd = AS2O.GetFailureCmmand() Functin GetFailure () As Object Retrieves the ICIMailActinParams interface, which specified ntificatin parameters that will be sent after the failed transactin happens. HRESULT GetFailure ( [ut, retval] IDispatch** ppdisp params); Set MailParams = AS2O.GetFailure () Functin GetSuccessCmmand() As Object Retrieves ICICmmandActinParams interface, which specified a custm cmmand t ccur upn successful transactin. HRESULT GetSuccessCmmand( [ut, retval] IDispatch** ppdispcmmandparams); Set Cmd = AS2O.GetSuccessCmmand() Functin GetSuccess () As Object 51

52 EFT API Reference Retrieves the ICIMailActinParams interface, which specified ntificatin parameters that will be sent after successful transactin happened. HRESULT GetSuccess ( [ut, retval] IDispatch** ppdisp params); Set MailParams = AS2O.GetSuccess () Prperty Hst As String Specifies r retrieves the remte hst t which yu are sending an AS2 file, and the prtcl prefix, r If n prtcl prefix is specified, plain HTTP prtcl will be used. HRESULT Hst( [ut, retval] BSTR* pval); HRESULT Hst( [in] BSTR newval); MsgBx "AS2 destinatin hst: " & AS2O.Hst AS2O.Hst = " " Prperty MailbxPath As String (EFT v nly; see RemtePath.) Retrieves r specifies a destinatin directry path. HRESULT MailbxPath( [ut, retval] BSTR* pval); HRESULT MailbxPath( [in] BSTR newval); MsgBx "AS2 destinatin path: " & AS2O.MailbxPath AS2O.MailbxPath = "/" EFT v nly (see RemtePath) Prperty MessageSendAttemptRetries As Lng (EFT v nly; Remved in EFT v6.3.1; See Retries Cunt.) Retrieves r specifies the number f message send attempts retries. HRESULT MessageSendAttemptRetries( [ut, retval] LONG* pval); HRESULT MessageSendAttemptRetries( [in] LONG newval); 52

53 Interface Reference MsgBx "AS2 retries cunt is: " & CStr(AS2O.MessageSendAttemptRetries) AS2O.MessageSendAttemptRetries = 80 EFT v nly; Remved in EFT v6.3.1 Prperty MessageSendAttemptTimeut As Lng (EFT v nly; Remved in EFT v6.3.1; See SendAttemptDelayBetweenRetries) HRESULT MessageSendAttemptTimeut( [ut, retval] LONG* pval); HRESULT MessageSendAttemptTimeut( [in] LONG newval); MsgBx "AS2 Timeut is: " & CStr(AS2O.MessageSendAttemptTimeut) AS2O.MessageSendAttemptTimeut = 10 EFT v nly; Remved in EFT v6.3.1 Prperty MnitredHtFlder As String Specifies r retrieves the mnitred ht flder path. Newly created/added files will be sent in the AS2 message. HRESULT MnitredHtFlder( [ut, retval] BSTR* pval); HRESULT MnitredHtFlder( [in] BSTR newval); MsgBx "AS2 ht flder: " & AS2O.MnitredHtFlder AS2O.MnitredHtFlder = "C:\HtFlder " Prperty PartnerAS2ID As String Specifies r retrieves the AS2 ID f the AS2 partner t which yu are sending an AS2 file. HRESULT PartnerAS2ID( [ut, retval] BSTR* pval); HRESULT PartnerAS2ID( [in] BSTR newval); MsgBx "Her AS2 ID is: " & AS2O.PartnerAS2ID AS2O.PartnerAS2ID = "her_as2_id" Prperty PartnerCertificatePath As String 53

54 EFT API Reference Specifies r retrieves the path t the AS2 partner certificate fr AS2 message encrypting. HRESULT PartnerCertificate( [ut, retval] BSTR* pval); HRESULT PartnerCertificatePath( [in] BSTR newval); MsgBx "AS2 partner certificate path: " & CStr(AS2O.PartnerCertificatePath) AS2O.PartnerCertificatePath = "C:\Certs\Ivan.crt" Prperty Passwrd As String Specifies r retrieves the passwrd used fr authenticatin n the AS2 Server t which yu are sending an AS2 file. HRESULT Passwrd( [ut, retval] BSTR* pval); HRESULT Passwrd( [in] BSTR newval); MsgBx "AS2 passwrd: " & AS2O.Passwrd AS2O.Passwrd = "swrdfish" Prperty Prt As Lng Specifies r retrieves the remte prt. HRESULT Prt( [ut, retval] LONG* pval); HRESULT Prt( [in] LONG newval); MsgBx "AS2 destinatin prt: " & AS2O.Prt AS2O.rt = 80 Prperty PrxyHstName As String Specifies r retrieves the prxy hst. HRESULT PrxyHstName( [ut, retval] BSTR* pval); HRESULT PrxyHstName( [in] BSTR newval); 54

55 Interface Reference MsgBx "Prxy hstname is: " & AS2O.PrxyHstName AS2O.PrxyHstName = " " Prperty PrxyPasswrd As String Specifies r retrieves the prxy passwrd. HRESULT PrxyPasswrd( [ut, retval] BSTR* pval); HRESULT PrxyPasswrd( [in] BSTR newval); MsgBx "Prxy passwrd is: " & AS2O.PrxyPasswrd AS2O.PrxyPasswrd = "swrdfish" Prperty PrxyPrt As Lng Specifies r retrieves the prxy prt. HRESULT PrxyPrt( [ut, retval] LONG* pval); HRESULT PrxyPrt( [in] LONG newval); MsgBx "Prxy prt is: " & CStr(AS2O.PrxyPrt) AS2O.PrxyPrt = 8080 Prperty PrxyType As AS2PrxyType Specifies r retrieves the prxy type. HRESULT PrxyType( [ut, retval] AS2PrxyType* pval); HRESULT PrxyType( [in] AS2PrxyType newval); if AS2PrxyHTTP = AS2O.PrxyType then MsgBx "AS2 using HTTP prxy" end if AS2O.PrxyType = AS2PrxyDMZ 55

56 EFT API Reference Prperty PrxyUserName As String Specifies r retrieves the prxy username. HRESULT PrxyUserName( [ut, retval] BSTR* pval); HRESULT PrxyUserName( [in] BSTR newval); MsgBx "Prxy user name is: " & AS2O.PrxyUserName AS2O.PrxyUserName = "User_1" Prperty ReceiptDelivery As AS2ReceiptDelivery Specifies r retrieves the mechanism f receipt delivery required fr an AS2 message. This prperty is applicable nly if ReceiptPlicy prperty is nt set t NReceipt. HRESULT ReceiptDelivery( [ut, retval] AS2ReceiptDelivery* pval); HRESULT ReceiptDelivery( [in] AS2ReceiptDelivery newval); if Sync = AS2O.ReceiptDelivery then MsgBx "Synchrnus" end if AS2O.ReceiptDelivery = Async Prperty ReceiptPlicy As AS2ReceiptPlicy Specifies r retrieves the type f the receipt required fr an AS2 message. HRESULT ReceiptPlicy( [ut, retval] AS2ReceiptPlicy* pval); HRESULT ReceiptPlicy( [in] AS2ReceiptPlicy newval); if NReceipt = AS2O.ReceiptPlicy then MsgBx "D nt request a receipt" end if AS2O.ReceiptPlicy = UnsignedReceipt Prperty RemtePath As String 56

57 Interface Reference Retrieve/specify a destinatin directry path. HRESULT RemtePath( [ut, retval] BSTR* pval); HRESULT RemtePath( [in] BSTR newval); MsgBx "AS2 destinatin path: " & AS2O.RemtePath AS2O.RemtePath = "/" EFT v6.3.1 and later Prperty RetriesCunt As Lng Specifies r retrieves the remte path t which yu are sending an AS2 file. HRESULT RetriesCunt( [ut, retval] LONG* pval); HRESULT RetriesCunt( [in] LONG newval); MsgBx "AS2 retries cunt is: " & CStr(AS2O.RetriesCunt) AS2O.RetriesCunt = 80 EFT v6.3.1 and later Prperty RetryDelaySec As Lng Specifies r retrieves the interval between successive sending retries (in secnds) when a send fails. This prperty is applicable nly if RetriesCunt prperty is nt set t 0. HRESULT RetryDelaySec( [ut, retval] LONG* pval); HRESULT RetryDelaySec( [in] LONG newval); MsgBx "AS2 delay between retries: " & CStr(AS2O.RetryDelaySec) AS2O.RetryDelaySec = 60 EFT v6.3.1 and later Prperty SendAttemptDelayBetweenRetries As Lng Retrieves r specifies the delay between retries, in secnds. HRESULT SendAttemptDelayBetweenRetries( [ut, retval] LONG* pval); HRESULT SendAttemptDelayBetweenRetries( [in] LONG newval); 57

58 EFT API Reference MsgBx "AS2 delay between retries: " & CStr(AS2O.SendAttemptDelayBetweenRetries) AS2O.SendAttemptDelayBetweenRetries = 60 EFT v6.3.0 Sub SetFailureCmmand(pdispCmmandParams As Object) Specifies ICICmmandActinParams interface, which specified a custm cmmand t ccur upn failed. HRESULT SetFailureCmmand( IDispatch* pdispcmmandparams); AS2O.SetFailureCmmand Cmd Sub SetFailure (pdisp ParamsAs Object) Specifies the ICIMailActinParams interface fr ntificatin parameters that will be sent after a failed transactin. HRESULT SetFailure ( IDispatch* pdisp params); AS2O.SetFailure MailParams Sub SetSuccessCmmand(pdispCmmandParams As Object) Specifies the ICICmmandActinParams interface, which specified a custm cmmand t ccur upn successful transactin. HRESULT SetSuccessCmmand( IDispatch* pdispcmmandparams); AS2O.SetSuccessCmmand Cmd Sub SetSuccess (pdisp Params As Object) Specifies the ICIMailActinParams interface fr ntificatin parameters that will be sent after a successful transactin. HRESULT SetSuccess ( IDispatch* pdisp params); AS2O.SetSuccess MailParams Prperty Sign As Blean Specifies r retrieves whether an AS2 message will be signed with the certificate specified in the Site s AS2 Settings. 58

59 Interface Reference HRESULT Sign( [ut, retval] VARIANT_BOOL* pval); HRESULT Sign( [in] VARIANT_BOOL newval); MsgBx "AS2 sign message: " & CStr(AS2O.Sign) AS2O.Sign = True Prperty Subject As String Specifies r retrieves the AS2 message subject. HRESULT Subject( [ut, retval] BSTR* pval); HRESULT Subject( [in] BSTR newval); MsgBx "AS2 message subject: " & AS2O.Subject AS2O.Subject = "Sme subject " Prperty TimeutSec As Lng Specifies r retrieves the timeut (in secnds) while sending a file. HRESULT TimeutSec( [ut, retval] LONG* pval); HRESULT TimeutSec( [in] LONG newval); MsgBx "AS2 Timeut is: " & CStr(AS2O.TimeutSec) AS2O.TimeutSec = 10 EFT v6.3.1 and later Prperty UsePrxy As Blean Specifies r retrieves whether the prxy will be used when sending a file. HRESULT UsePrxy( [ut, retval] VARIANT_BOOL* pval); HRESULT UsePrxy( [in] VARIANT_BOOL newval); MsgBx "AS2 using prxy: " & CStr(AS2O.UsePrxy) 59

60 EFT API Reference AS2O.UsePrxy = False Prperty User As String Specifies r retrieves the username fr authenticatin n the AS2 Server t which yu are sending an AS2 file. HRESULT User( [ut, retval] BSTR* pval); HRESULT Username( [in] BSTR newval); MsgBx "AS2 user: " & AS2O.User AS2O.User = "User_1" EFT v6.3.1 and later Dialg Bx Equivalents 60

61 Interface Reference ICIAS2SendActinParams - AS2 Send Actin Parameters Interface The ICIAS2SendActinParams interface allws yu t create, mdify, and retrieve AS2 Send File Event Rule Actins. (Dialg bx equivalents appear belw the table.) See als ICIAS2InbundSettings - AS2 Inbund Settings Interface, ICIAS2OutbundSettings - AS2 Outbund Settings Interface, and ICIAS2TransactinInf - AS2 Transactin Infrmatin Interface. interface ICIAS2SendActinParams : IDispatch If ActinStatement.Actin.Type = AS2SendActin Then Set AS2SendParams = ActinStatement.Actin.Params Mdify AS2 Send File parameters and assign them back t the actin ActinStatement.Actin.Params = AS2SendParams End If The CIAS2SendActinParams c-class supprts creatin f the Send AS2 File Event Actin. The cclass implements the ICIAS2SendActinParams interface. Set AS2Params = CreateObject("SFTPCOMInterface.CIAS2SendActinParams") Setup Send AS2 File parameters... Rule.AddActinStatement(0, AS2Params) Members Prperty AS2ID As String Specifies r retrieves the AS2 ID f the file sender. HRESULT AS2ID([ut, retval] BSTR* pval); HRESULT AS2ID([in] BSTR newval); Examples MsgBx "Send message as " & AS2SendParams.AS2ID & " AS2 identifier" AS2SendParams.AS2ID = "EFT : User1" 61

62 EFT API Reference EFT v6.1 and later Prperty AsyncReceiptTimeutMin As Lng This prperty is applicable nly if asynchrnus receipt is requested (i.e., ReceiptPlicy prperty is nt set t NReceipt and ReceiptDelivery prperty is set t Async). Specifies r retrieves the maximum wait time (in minutes) fr asynchrnus AS2 receipt. HRESULT AsyncReceiptTimeutMin([ut, retval] lng* pval); HRESULT AsyncReceiptTimeutMin([in] lng newval); If AS2SendParams.AsyncReceiptTimeutMin < 60 Then MsgBx Asynchrnus receipt waiting perid is t shrt End If AS2SendParams.AsyncReceiptTimeutMin = days EFT v6.1 and later Prperty ClientPrfile As String Specifies r retrieves the username f AS2 partner whse AS2 Outbund Prfile will be used fr this AS2 Send peratin. HRESULT ClientPrfile([ut, retval] BSTR* pval); HRESULT ClientPrfile([in] BSTR newval); If AS2SendParams.UseClientPrfile Then MsgBx AS2SendParams.ClientPrfile & " s AS2 prfile will be used" End If AS2SendParams.UseClientPrfile = True AS2SendParams.ClientPrfile = "Sme_User" EFT v6.1 and later Prperty Cmpress As Blean Specifies r retrieves whether an AS2 file will be cmpressed befre sending. HRESULT Cmpress([ut, retval] VARIANT_BOOL* pval); HRESULT Cmpress([in] VARIANT_BOOL newval); If Nt AS2SendParams.Cmpress Then MsgBx "Sending large files withut cmpressin is time-cnsuming!" End If AS2SendParams.Cmpress = True EFT v6.1 and later Prperty CntentType As AS2CntentType 62

63 Interface Reference Specifies r retrieves cntent type f AS2 message t send. HRESULT CntentType([ut, retval] AS2CntentType* pval); HRESULT CntentType([in] AS2CntentType newval); If AS2SendParams.CntentType = Binary Then MsgBx "File type: Binary" End If AS2SendParams.CntentType = Plaintext EFT v6.1 and later Prperty DeleteSurceFile As Blean Specifies r retrieves whether surce file will be remved after successful delivery t AS2 partner. HRESULT DeleteSurceFile([ut, retval] VARIANT_BOOL* pval); HRESULT DeleteSurceFile([in] VARIANT_BOOL newval); If AS2SendParams.DeleteSurceFile Then MsgBx "Warning! Surce file will be remved after delivery!" End If AS2SendParams.DeleteSurceFile = True EFT v6.1 and later Prperty Encrypt As Blean Specifies r retrieves whether an AS2 message will be encrypted with the AS2 partner certificate. HRESULT Encrypt([ut, retval] VARIANT_BOOL* pval); HRESULT Encrypt([in] VARIANT_BOOL newval); If Nt AS2SendParams.Encrypt Then MsgBx "Sending data withut encryptin is nt secure!" End If AS2SendParams.Encrypt = True EFT v6.1 and later Prperty Hst As String Specifies r retrieves the remte hst t which yu are sending an AS2 file, and the prtcl prefix, r If n prtcl prefix is specified, plain HTTP prtcl will be used. HRESULT Hst([ut, retval] BSTR* pval); HRESULT Hst([in] BSTR newval); 63

64 EFT API Reference MsgBx "The file will be sent t " & AS2SendParams.Hst AS2SendParams.Hst = " EFT v6.1 and later Prperty LcalPath As String Specifies r retrieves lcal path f the file t send. HRESULT LcalPath([ut, retval] BSTR* pval); HRESULT LcalPath([in] BSTR newval); MsgBx AS2SendParams.LcalPath & " file will be sent" AS2SendParams.LcalPath = "%FS.PATH%" EFT v6.1 and later Prperty PartnerAS2ID As String Specifies r retrieves the AS2 ID f the AS2 partner t which yu are sending an AS2 file. HRESULT PartnerAS2ID([ut, retval] BSTR* pval); HRESULT PartnerAS2ID([in] BSTR newval); MsgBx "Send message t " & AS2SendParams.PartnerAS2ID & " partner" AS2SendParams.PartnerAS2ID = "Jhn Smith" EFT v6.1 and later Prperty PartnerCertificatePath As String Specifies r retrieves the path t the AS2 partner certificate fr AS2 message encrypting. HRESULT PartnerCertificatePath([ut, retval] BSTR* pval); HRESULT PartnerCertificatePath([in] BSTR newval); MsgBx "Encrypt message with " & AS2SendParams.PartnerCertificatePath AS2SendParams.PartnerCertificatePath = "C:\Partner.pem" EFT v6.1 and later Prperty Passwrd As String Specifies r retrieves the passwrd used fr authenticatin n the AS2 Server t which yu are sending an AS2 file. 64

65 Interface Reference HRESULT Passwrd([ut, retval] BSTR* pval); HRESULT Passwrd([in] BSTR newval); shttpcredentials = AS2SendParams.User & ":" & AS2SendParams.Passwrd AS2SendParams.Passwrd = "Passwrd1" EFT v6.1 and later Prperty Prt As Lng Specifies r retrieves the remte prt. HRESULT Prt([ut, retval] lng* pval); HRESULT Prt([in] lng newval); If (AS2SendParams.Prt <> 80) And (AS2SendParams.Prt <> 443) Then MsgBx "Are yu sure yu want t use nn-standard HTTP prt?" End If AS2SendParams.Prt = 443 EFT v6.1 and later Prperty ReceiptDelivery As AS2ReceiptDelivery This prperty is applicable nly if ReceiptPlicy prperty, belw, is nt set t NReceipt. Specifies r retrieves the mechanism f receipt delivery required fr an AS2 message. (Refer t AS2ReceiptDelivery enumeratin fr available mechanisms.) HRESULT ReceiptDelivery([ut, retval] AS2ReceiptDelivery* pval); HRESULT ReceiptDelivery([in] AS2ReceiptDelivery newval); If (AS2SendParams.ReceiptPlicy <> NReceipt) _ And (AS2SendParams.ReceiptDelivery = Async) Then MsgBx "Are yu ready t wait fr receipt fr several days?" End If AS2SendParams.ReceiptDelivery = Sync EFT v6.1 and later Prperty ReceiptPlicy As AS2ReceiptPlicy Specifies r retrieves the type f the receipt required fr AS2 message. (Refer t AS2ReceiptPlicy enumeratin fr available receipt types). HRESULT ReceiptPlicy([ut, retval] AS2ReceiptPlicy* pval); HRESULT ReceiptPlicy([in] AS2ReceiptPlicy newval); 65

66 EFT API Reference If AS2SendParams.ReceiptPlicy <> SignedReceipt Then MsgBx "Request signed receipt t authenticate AS2 partner!" End If AS2SendParams.ReceiptPlicy = SignedReceipt EFT v6.1 and later Prperty RemtePath As String Specifies r retrieves the remte path t which yu are sending an AS2 file. HRESULT RemtePath([ut, retval] BSTR* pval); HRESULT RemtePath([in] BSTR newval); surl = AS2Params.Hst & ":" & CStr(AS2Params.Prt) & AS2Params.RemtePath AS2SendParams.RemtePath = "/AS2.aspx" EFT v6.1 and later Prperty RetriesCunt As Lng Specifies r retrieves the maximum amunt f sending retries in the case f failure (timeut, netwrk errrs, etc.); 0 means n retry if failed. HRESULT RetriesCunt([ut, retval] lng* pval); HRESULT RetriesCunt([in] lng newval); If AS2SendParams.RetriesCunt = 0 Then MsgBx "Are yu sure n retry is needed fr sending failures?" End If AS2SendParams.RetriesCunt = 5 Try anther 5 times if fails t send EFT v6.1 and later Prperty RetryDelaySec As Lng Specifies r retrieves the interval between successive sending retries (in secnds) in the case f sending failure. This prperty is applicable nly if RetriesCunt prperty is nt set t 0. HRESULT RetryDelaySec([ut, retval] lng* pval); HRESULT RetryDelaySec([in] lng newval); MsgBx "Will wait fr " & AS2Params.RetryDelaySec " secnds befre resend" 66

67 Interface Reference AS2SendParams.RetryDelaySec = 60 1 minute EFT v6.1 and later Prperty Sign As Blean Specifies r retrieves whether an AS2 message will be signed with the certificate specified in the Site's AS2 settings. HRESULT Sign([ut, retval] VARIANT_BOOL* pval); HRESULT Sign([in] VARIANT_BOOL newval); If Nt AS2SendParams.Sign Then MsgBx "Unsigned message will nt allw partner t authenticate yu!" End If AS2SendParams.Sign = True EFT v6.1 and later Prperty Subject As String Specifies r retrieves the AS2 message subject. HRESULT Subject([ut, retval] BSTR* pval); HRESULT Subject([in] BSTR newval); MsgBx "Message Subject: " & AS2SendParams.Subject AS2SendParams.Subject = "Requested client list attached" EFT v6.1 and later Prperty TimeutSec As Lng Specifies r retrieves the timeut (in secnds) while sending the file. HRESULT TimeutSec([ut, retval] lng* pval); HRESULT TimeutSec([in] lng newval); MsgBx "Send Timeut: " & CStr(AS2SendParams.TimeutSec) & " secnds" AS2SendParams.TimeutSec = minutes EFT v6.1 and later Prperty UseClientPrfile As Blean Specifies r retrieves whether a whle AS2 Outbund Prfile f certain EFT client will be used fr this AS2 Send peratin. Otherwise, yu must explicitly specify each AS2 Send parameter. (Refer als t the ClientPrfile prperty.) HRESULT UseClientPrfile([ut, retval] VARIANT_BOOL* pval); HRESULT UseClientPrfile([in] VARIANT_BOOL newval); 67

68 EFT API Reference If Nt AS2SendParams.UseClientPrfile Then Specify each AS2 Send parameter End If AS2SendParams.UseClientPrfile = True EFT v6.1 and later Prperty User As String Specifies r retrieves the username fr authenticatin n the AS2 Server t which yu are sending an AS2 file. HRESULT User([ut, retval] BSTR* pval); HRESULT User([in] BSTR newval); MsgBx "Will send the file using " & AS2SendParams.User & " accunt" AS2SendParams.User = "User1" EFT v6.1 and later 68

69 Interface Reference Dialg Bx Equivalents ICIAS2TransactinInf - AS2 Transactin Infrmatin Interface The ICIAS2TransactinInf interface is used t retrieve infrmatin abut an AS2 transactin. See als ICIAS2OutbundSettings - AS2 Outbund Settings Interface, ICIAS2InbundSettings - AS2 Inbund Settings Interface, and ICIAS2SendActinParams - AS2 Send Actin Parameters Interface. interface ICIAS2TransactinInf : IDispatch { Prperties Prperty Directin As AS2TransactinDirectin read-nly Retrieves the directin f a transactin. HRESULT Directin([ut, retval] AS2TransactinDirectin* pval); AS2TransactinDirectin: AS2TransDirectinInbund = 0 AS2TransDirectinOutbund = 1 if AS2TransDirectinOutBund = AS2T.Directin then 69

70 EFT API Reference MsgBx "Outbund." end if Prperty File As String read-nly Retrieves the name f file transferred. HRESULT File([ut, retval] BSTR* pval); MsgBx "AS2 file name: " & AS2T.File Prperty Frm As String read-nly Retrieves the alias f the sender f the AS2 message. HRESULT Frm([ut, retval] BSTR* pval); MsgBx "AS2 sender: " & AS2T.Frm Prperty MessageID As String read-nly Retrieves the message ID frm an AS2 header. HRESULT MessageID([ut, retval] BSTR* pval); MsgBx "AS2 message ID: " & AS2T.MessageID Prperty Path As String read-nly Retrieves the file path lcal inbx r utbx. HRESULT Path([ut, retval] BSTR* pval); MsgBx "AS2 file path: " & AS2T.Path Prperty RemteHst As String read-nly Retrieves the hst address f the sender (Inbund)/receiver (Outbund). HRESULT RemteHst([ut, retval] BSTR* pval); MsgBx "AS2 remte hst address: " & AS2T.RemteHst Prperty Status As AS2TransactinStatus read-nly Retrieves the status f an AS2 transactin. HRESULT Status([ut, retval] AS2TransactinStatus* pval); Cnst AS2TransactinInPrgress = 0 70

71 Interface Reference Cnst AS2TransactinSuccess = 1 Cnst AS2TransactinFailedCanResend = 2 Cnst AS2TransactinFailedNResend = 3 Cnst AS2TransactinOkSendMDNFailed = 4 if AS2TransactinSuccess = AS2T.Status then MsgBx AS2 transactin success. end if Prperty Time As Date read-nly Retrieves the date/time last recrded status fr the transactin. HRESULT Time([ut, retval] DATE* pval); MsgBx "AS2 Date/Time: " & CStr(AS2T.Time) Prperty T As String read-nly Retrieves the alias f the receiver f the AS2 message. HRESULT T([ut, retval] BSTR* pval); MsgBx "AS2 receiver: " & AS2T.T Prperty TransactinID As String read-nly Retrieves the ID f an AS2 transactin. HRESULT TransactinID([ut, retval] BSTR* pval); MsgBx "AS2 transactin ID: " & AS2T.TransactinID ICIAudit - Audit Interface Use the ICIAudit interface t lg audit infrmatin related t ad hc transfers. (Use the ICIServer : Auditr methd t retrieve the ICIAudit interface.) interface ICIAudit : IDispatch "Sub" indicates that the member is a methd. Methds Sub AuditAdhc(msg As AdhcMessage) Audit/event-prcess an ad hc file transfer. HRESULT AuditAdhc([in] IAdhcMessage *msg); EFT v6.5 and later Sub AuditSAT(msg As SATMessage) Audit a new SAT transactin thrugh ARM. (Called by Mail Express; similar t AuditSATTransactin, but als prvides an explicit timestamp fr when the event ccurs.) 71

72 EFT API Reference HRESULT AuditSAT([in] ISATMessage *msg); EFT v6.5 and later Sub AuditSAT ( As String, Type As Lng, TransGUID As String) Auditing a SAT in ARM. HRESULT AuditSAT ( [in] BSTR , [in] LONG Type, [in] BSTR TransGUID); EFT Server v6.0 and later Sub AuditSATFile(FileName As String, FileSize As Signed Duble Lng, TransGUID As String) Auditing a SAT file in ARM. HRESULT AuditSATFile( [in] BSTR FileName, [in] LONGLONG FileSize, [in] BSTR TransGUID); EFT Server v6.0 and later Sub AuditSATTransactin(Frm As String, Subject As String, Bdy As String, TempUserName As String, TempPasswrd As String, SiteName As String, ExpireDays As Lng, TransGUID As String, Reserved1 As String, Reserved2 As String) Auditing a new SAT transactin thrugh ARM (called by SAT mdule). HRESULT AuditSATTransactin([in] BSTR Frm, [in] BSTR Subject, [in] BSTR Bdy, [in] BSTR TempUserName, [in] BSTR TempPasswrd, [in] BSTR SiteName, [in] LONG ExpireDays, [in] BSTR TransGUID, [in] BSTR Reserved1, [in] BSTR Reserved2); EFT Server v6.0 and later ICIAutbanIPAccessRule Interface This interface prvides the Autban IP access rule BannedIPs prperty. rules = Site.GetIPAccessRules() Fr Each key In rules If key.type = 0 Then WScript.ech "AutBan" autban = key.bannedips Fr Each key2 In autban WScript.ech "Address " & CStr(key2.address) WScript.ech "Banned " & CStr(key2.banned) WScript.ech "Permanently " & CStr(key2.permanently) WScript.ech "Expires " & CStr(key2.expires) WScript.ech "Reasn " & CStr(key2.reasn) Next End if Next 72

73 Interface Reference Prperties Prperty BannedIPs As Variant read-nly HRESULT BannedIPs( [ut, retval] VARIANT* pvarbannedips); EFT v6.3.0 and later Prperty type As IPAccessRuleType read-nly HRESULT type( [ut, retval] IPAccessRuleType* pval); Related Tpics EFT v6.3.0 and later ICIBannedIP - Represents an entry in an IP address autban list ICIClientSettings AddIPAccessRule - Adds allwed (true) r denied (false) IP mask fr the client GetIPAccessRules - Retrieves an array f client/template IP Access rules GetLimitAccessByIP - Determines if the IP Access Restrictin List is enabled n the Settings Template r user accunt IPAccessAllwedDefault - Set r retrieve whether user r Settings Template IP access settings allw r deny access by default (if n rule match) MveIPAccessRule - Change allwed IP access rule psitin ICIManualIPAccessRule - Represents an IP address access rule that was added manually ICIServer ICISite AddIPAccessRule - Adds allwed r denied IP mask fr administratin GetAdminIPs - Retrieve an array f IP addresses fr the cmputer n which the Server is running GetIPAccessRules - Retrieve an array f administratin IP address access rules GetLcalIP - Given an index, retrieves a Lcal IP address IPAccessAllwedDefault - Retrieve r specify the default IP Access restrictin list ListenIP - Retrieve r specify the server's IP address ListenIPs - Retrieve r specify the IP addresses n which the server listens MveIPAccessRule - Change allwed administratin IP access rule psitin. RemveIPAccessRule - Remve allwed r denied IP mask fr administratin UnbanIP - Remve denied IP mask frm Autban list fr administratin AddIPAccessRule - Adds allwed r denied IP mask fr the Site AutBanIPsPermanently - Retrieve r specify whether t autmatically ban IP addresses permanently 73

74 EFT API Reference BanIPFrInvalidLginAttempts - Retrieve r specify whether t ban an IP address after excessive invalid lgin attempts with existing username and wrng passwrd. BanIPFrInvalidLginAttemptsWithExistingUsername - When banning an IP address fr invalid lgin attempts, specify whether t cunt incrrect username and crrect username + incrrect passwrd r nly incrrect username attempts. BanIPOnDOS - Retrieve r specify whether t ban an IP address after excessive invalid cmmands GetIP - Retrieves the index f the Site Listen IP GetIPAccessRules - Retrieves an array f allwed IP masks. IPAccessAllwedDefault - Retrieve r specify whether IP access is allwed by default ListenIPs - Retrieve r specify the IP addresses n which the Site listens MveIPAccessRule - Change allwed r denied IP mask psitin fr the Site RemveIPAccessRule - Remve allwed r denied IP mask fr the Site SetIP - Changes the index f Listen IP UnbanIP - Remves denied IP mask frm the Autban list fr the Site IPAccessRuleType enum ICIAWTaskActinParams - Autmated Wrkflw Event Actin Parameters Interface Use ICIAWTaskActinParams::TaskName t create, mdify, retrieve, and execute Autmated Wrkflw Engine (AWE) Event Rule Actins. interface ICIAWTaskActinParams : IDispatch Examples (VBScript): If ActinStatement.Actin.Type = AWTaskActin Then Set AWTaskParams = ActinStatement.Actin.Params Mdify AW Task parameters and assign them back t the actin... ActinStatement.Actin.Params = AWTaskParams End If The CIAWTaskActinParams c-class supprts creatin f the AWE Task Event Actin. The c-class implements ICIAWTaskActinParams interface. Set AWTaskParams = CreateObject("SFTPCOMInterface.CIAWTaskActinParams") Setup AW task parameters... Rule.AddActinStatement(0, AWTaskParams) MsgBx AWTaskParams.TaskName & " task will be executed" AWTaskParams.TaskName = "Sample - SNMP Get" "Functin" and "Sub" indicate that the member is a methd; "Prperty" indicates that it is a prperty. 74

75 Interface Reference Members Sub AddVariable(bstrVarName As String, bstrvarvalue As String) Adds new variable HRESULT AddVariable( [in] BSTR bstrvarname, [in] BSTR bstrvarvalue); AWT.AddVariable "Variable_0", "Value_0" Functin GetVariableName(nIndex As Lng) As String Retrieves a variable name by index. HRESULT GetVariableName( [in] LONG nindex, [ut,retval] BSTR* pval); MsgBx "Variable name at 0 index is: " & CStr(AWT.GetVariableName(0)) Functin GetVariableValue(nIndex As Lng) As String Retrieves a variable value by index. HRESULT GetVariableValue( [in] LONG nindex, [ut,retval] BSTR* pval); MsgBx "Variable value at 0 index is: " & CStr(AWT.GetVariableValue(0)) Sub RemveVariable(nIndex As Lng) Remve variable by index. HRESULT RemveVariable( [in] LONG nindex); AWT.RemveVariable 0 Sub SetVariable(nIndex As Lng, bstrvarname As String, bstrvarvalue As String) Set new variable name and value by index HRESULT SetVariable( [in] LONG nindex, [in] BSTR bstrvarname, [in] BSTR bstrvarvalue); AWT.AddVariable 1, "NewName", "NewValue" 75

76 EFT API Reference Prperty TaskName As String Retrieve r specify the name f an AWE task (wrkflw) t execute. HRESULT TaskName( [ut, retval] BSTR* pval); HRESULT TaskName( [in] BSTR newval); EFT v6.1 and later Prperty VariablesCunt As Lng read-nly Retrieves the number f variables. HRESULT VariablesCunt( [ut, retval] LONG* pval); MsgBx "Variable cunt is: " & AWT.VariablesCunt ICIBackupActinParams - Backup Actin Parameters Interface Use ICIBackupActinParams::Flder t create, mdify, and retrieve the Backup Server Cnfiguratin Event Rule Actin. (See als ICIActinStatement - Actin Statement Interface.) interface ICIBackupActinParams : IDispatch Members Prperty Flder As String Retrieve r specify the path t the flder t stre the backup archive. HRESULT Flder([ut, retval] BSTR* pval); HRESULT Flder([in] BSTR newval); EFT v6.1 and later Examples (VBScript): If ActinStatement.Actin.Type = BackupActin Then Set BackupParams = ActinStatement.Actin.Params Mdify backup parameters and assign them back t the actin... ActinStatement.Actin.Params = BackupParams End If The CIBackupActinParams c-class supprts the creatin f the Backup Server Cnfiguratin Event Rule Actin. The c-class implements ICIBackupActinParams interface. Set BackupParams = CreateObject("SFTPCOMInterface.CIBackupActinParams") Setup backup parameters... Rule.AddActinStatement(0, BackupParams) MsgBx "Cnfiguratin snapsht will be stred in " & BackupParams.Flder BackupParams.Flder = "C:\Temp" 76

77 Interface Reference ICIBackupArchiveInf - Backup Archive Infrmatin Interface Use the ICIBackupArchiveInf interface members t retrieve r specify backup infrmatin. Fr details f backing up r restring EFT Server, refer t Backing Up r Restring Server Cnfiguratin in the EFT Server dcumentatin. interface ICIBackupArchiveInf : IDispatch "Sub" indicates that the member is a methd; "Prperty" indicates that it is a prperty. Members Prperty ARMAuthenticatinType As ARMAuthenticatinType Retrieves r specifies audit database authenticatin type SQL server authenticatin r Windws authenticatin. HRESULT ARMAuthenticatinType([ut, retval] ARMAuthenticatinType* pval); HRESULT ARMAuthenticatinType([in] ARMAuthenticatinType newval); If WindwsAuthenticatin = Backup.ARMAuthenticatinType Then ' End If Backup.ARMAuthenticatinType = SQLServerAuthenticatin Prperty ARMDatabaseName As String Retrieves r specifies ARM database name. HRESULT ARMDatabaseName([ut, retval] BSTR *pval); HRESULT ARMDatabaseName([in] BSTR newval); MsgBx "ARM database name is: " & Backup.ARMDatabaseName Backup.ARMDatabaseName = "EFTDB" Prperty ARMDatabaseType As ARMDatabaseType Retrieves r specifies audit database type. HRESULT ARMDatabaseType([ut, retval] ARMDatabaseType* pval); HRESULT ARMDatabaseType([in] ARMDatabaseType newval); If Oracle = Backup.ARMDatabaseType Then ' End If 77

78 EFT API Reference Backup.ARMDatabaseType = SQLServer Prperty ARMFailureAuditFlder As String Retrieves r specifies flder t save auditing data when the database has an errr. HRESULT ARMFailureAuditFlder([ut, retval] BSTR* pval); HRESULT ARMFailureAuditFlder([in] BSTR newval) Auditflder = Backup.ARMFailureAuditFlder Backup.ARMFailureAuditFlder = "C:\sme_flder" Prperty ARMFailure List As String Retrieves r specifies a failure ntificatin list f s. The prperty is a string with the fllwing frmat: == recipient_name<addr@server.dmain> addr@server.dmain _list :== ; _list e HRESULT ARMFailure List([ut, retval] BSTR* pval); HRESULT ARMFailure List([in] BSTR newval); str list = Backup.ARMFailure List If str list <> "" Then str list = str list + "; " End If str list = str list + "NewRecipientName<SmeAddr@Sm Server.cm>" Backup.ARMFailure List = str list Prperty ARMHealCnnectin As Blean Enables r disables the ARM cnnectin healing mechanism. HRESULT ARMHealCnnectin([ut, retval] VARIANT_BOOL *pval); HRESULT ARMHealCnnectin([in] VARIANT_BOOL newval); If MyBackupArchiveInf.ARMHealCnnectin Then Healing cnnectin mechanism is enabled End If MyBackupArchiveInf.ARMHealCnnectin = False Healing cnnectin mechanism have disabled EFT v6.6 and later Prperty ARMNtifyOnDiscnnect As Blean 78

79 Interface Reference Enables r disables ntificatin abut ARM database discnnect (recipients defined in ARMFailure List). HRESULT ARMNtifyOnDiscnnect([ut, retval] VARIANT_BOOL *pval); HRESULT ARMNtifyOnDiscnnect([in] VARIANT_BOOL newval); If MyBackupArchiveInf.ARMNtifyOnDiscnnect Then Ntify n ARM database discnnect is enabled End If MyBackupArchiveInf.ARMNtifyOnDiscnnect = False Ntify n ARM database discnnect have disabled EFT v6.6 and later Prperty ARMNtifyOnRecnnect As Blean Enables r disables ntificatin abut ARM database recnnect (recipients defined in ARMFailure List). HRESULT ARMNtifyOnRecnnect([ut, retval] VARIANT_BOOL *pval); HRESULT ARMNtifyOnRecnnect([in] VARIANT_BOOL newval); If MyBackupArchiveInf.ARMNtifyOnRecnnect Then Ntify n ARM database Recnnect is enabled End If MyBackupArchiveInf.ARMNtifyOnRecnnect = False Ntify n ARM database recnnect have disabled EFT v6.6 and later Prperty ARMPasswrd As String Retrieves r specifies ARM database passwrd. HRESULT ARMPasswrd([ut, retval] BSTR *pval); HRESULT ARMPasswrd([in] BSTR newval); MsgBx "ARM database passwrd is: " & Backup.ARMPasswrd Backup.ARMPasswrd = "swrdfish" Prperty ARMRecnnectPerid As DWrd Retrieve r specify the recnnect perid t ARM database. If a database errr ccurs and ARMHealCnnectin is enabled, then EFT tries t recnnect t the database every ARMRecnnectPerid secnds, frm 7 secnds t 86,400 secnds (24 hurs). 79

80 EFT API Reference HRESULT ARMRecnnectPerid([ut, retval] LONG *pval); HRESULT ARMRecnnectPerid([in] LONG newval); MsgBx Recnnect perid: & CStr(MyBackupArchiveInf.ARMRecnnectPerid) MyBackupArchiveInf.ARMRecnnectPerid = 60 every ne minute EFT v6.6 and later Prperty ARMServerName As String Retrieves r specifies database hst address. HRESULT ARMServerName([ut, retval] BSTR *pval); HRESULT ARMServerName([in] BSTR newval); MsgBx "ARM database hst address is: " & Backup.ARMServerName Backup.ARMServerName = " " Prperty ARMStpAuditingOnErrr As Blean Retrieves r specifies server behavir in case f database errr. If ARMStpAuditingOnErrr is true, then after database errr, audit will stp. Otherwise, auditing will be cntinued in the flder specified by the ARMFailureAuditFlder prperty. HRESULT ARMStpAuditingOnErrr([ut, retval] VARIANT_BOOL* pval); HRESULT ARMStpAuditingOnErrr([in] VARIANT_BOOL newval); If Backup.ARMStpAuditingOnErrr Then ' End If Backup.ARMStpAuditingOnErrr = true Prperty ARMUserName As String Retrieves r specifies database user name. HRESULT ARMUserName([ut, retval] BSTR *pval); HRESULT ARMUserName([in] BSTR newval); MsgBx "ARM database username is: " & Backup.ARMUserName Backup.ARMUserName = "User_1" 80

81 Interface Reference Prperty BackupArchivePath As String read-nly Retrieves path t the backup archive file. HRESULT BackupArchivePath([ut, retval] BSTR* pval); MsgBx "File backup archive path: " & Backup.BackupArchivePath Prperty CreatedBy As String read-nly Retrieves administratr accunt name that created the backup. HRESULT CreatedBy([ut, retval] BSTR* pval); MsgBx "Backup created by: " & Backup.CreatedBy Prperty CreatinTime As Date read-nly Retrieves backup creatin time. HRESULT CreatinTime([ut, retval] DATE* pval); MsgBx "Backup created: " & Backup.CreatinTime Prperty EnableARM As Blean Retrieves r specifies enable/disable ARM. HRESULT EnableARM([ut, retval] VARIANT_BOOL *pval); HRESULT EnableARM([in] VARIANT_BOOL newval); MsgBx "ARM is enabled: " & CStr(Backup.EnableARM) Backup.EnableARM = True Functin GetSiteBackupInf(nIndex As Lng) As Object Retrieves ICISiteBackupInf interface by index. HRESULT GetSiteBackupInf([in] LONG nindex, [ut, retval] IDispatch** pval); Set SiteBackupInf = Backup.GetSiteBackupInf(0) Sub SetSiteBackupInf(newVal As Object) Specifies Site backup infrmatin. HRESULT SetSiteBackupInf([in] IDispatch* newval); 81

82 EFT API Reference Backup.SetSiteBackupInf SiteBackupInf Prperty SitesCunt As Lng read-nly Retrieves number f Sites in the backup archive. HRESULT SitesCunt([ut, retval] LONG* pval); MsgBx "Sites cunt: " & CStr(Backup.SitesCunt) Prperty type As String read-nly Retrieves string representatin f backup type. HRESULT Type([ut, retval] BSTR* pval); MsgBx "Backup type: " & Backup.Type ICIBannedIP Interface The ICIBannedIP interface represents an entry in an IP address autban list. rules = Site.GetIPAccessRules() Fr Each key In rules If key.type = 0 Then WScript.ech "AutBan" autban = key.bannedips Fr Each key2 In autban WScript.ech "Address " & CStr(key2.address) WScript.ech "Banned " & CStr(key2.banned) WScript.ech "Permanently " & CStr(key2.permanently) WScript.ech "Expires " & CStr(key2.expires) WScript.ech "Reasn " & CStr(key2.reasn) Next End if Next Members Prperty Address As String (read-nly) Retrieves a string f banned IP addresses HRESULT Address( [ut, retval] BSTR* pbzaddress); EFT v6.3.0 and later Prperty Banned As Date (read-nly) Retrieves the date an IP address was added t the ban list. 82

83 Interface Reference HRESULT Banned( [ut, retval] DATE* pdbanned); EFT v6.3.0 and later Prperty Expires As Date (read-nly) Retrieves the date the ban expires. HRESULT Expires( [ut, retval] DATE* pdexpires); EFT v6.3.0 and later Prperty Permanently As Blean (read-nly) Retrieves whether the ban is permanent (True r False). HRESULT Permanently( [ut, retval] VARIANT_BOOL* pbpermanently); EFT v6.3.0 and later Prperty Reasn As String (read-nly) Retrieves the reasn the IP address was banned. HRESULT Reasn( [ut, retval] BSTR* pbzreasn); Related Tpics EFT v6.3.0 and later ICIAutbanIPAccessRule - Prvides the Autban IP access rule BannedIPs prperty ICIClientSettings AddIPAccessRule - Adds allwed (true) r denied (false) IP mask fr the client GetIPAccessRules - Retrieves an array f client/template IP Access rules GetLimitAccessByIP - Determines if the IP Access Restrictin List is enabled n the Settings Template r user accunt IPAccessAllwedDefault - Set r retrieve whether user r Settings Template IP access settings allw r deny access by default (if n rule match) MveIPAccessRule - Change allwed IP access rule psitin ICIManualIPAccessRule - Represents an IP address access rule that was added manually ICIServer AddIPAccessRule - Adds allwed r denied IP mask fr administratin GetAdminIPs - Retrieve an array f IP addresses fr the cmputer n which the Server is running GetIPAccessRules - Retrieve an array f administratin IP address access rules GetLcalIP - Given an index, retrieves a Lcal IP address IPAccessAllwedDefault - Retrieve r specify the default IP Access restrictin list 83

84 EFT API Reference ICISite ListenIP - Retrieve r specify the server's IP address ListenIPs - Retrieve r specify the IP addresses n which the server listens MveIPAccessRule - Change allwed administratin IP access rule psitin. RemveIPAccessRule - Remve allwed r denied IP mask fr administratin UnbanIP - Remve denied IP mask frm Autban list fr administratin AddIPAccessRule - Adds allwed r denied IP mask fr the Site AutBanIPsPermanently - Retrieve r specify whether t autmatically ban IP addresses permanently BanIPFrInvalidLginAttempts - Retrieve r specify whether t ban an IP address after excessive invalid lgin attempts with existing username and wrng passwrd. BanIPFrInvalidLginAttemptsWithExistingUsername - When banning an IP address fr invalid lgin attempts, specify whether t cunt incrrect username and crrect username + incrrect passwrd r nly incrrect username attempts. BanIPOnDOS - Retrieve r specify whether t ban an IP address after excessive invalid cmmands GetIP - Retrieves the index f the Site Listen IP GetIPAccessRules - Retrieves an array f allwed IP masks. IPAccessAllwedDefault - Retrieve r specify whether IP access is allwed by default ListenIPs - Retrieve r specify the IP addresses n which the Site listens MveIPAccessRule - Change allwed r denied IP mask psitin fr the Site RemveIPAccessRule - Remve allwed r denied IP mask fr the Site SetIP - Changes the index f Listen IP UnbanIP - Remves denied IP mask frm the Autban list fr the Site IPAccessRuleType enum ICICertInf - Certificate Infrmatin Interface Certificates are digital identificatin dcuments that allw bth servers and clients t authenticate each ther. Server certificates cntain infrmatin abut yur cmpany and the rganizatin that issued the certificate (such as Verisign r Thawte) while client certificates cntain infrmatin abut the user and the rganizatin that signed the certificate. (Dialg bx equivalents are shwn belw the table.) interface ICICertInf : IDispatch Members Prperty Descriptin As String read-nly Retrieves the descriptin f a certificate. HRESULT Descriptin([ut, retval] BSTR *pval); EFT v6.0 and later Prperty ID As Lng read-nly Retrieves the ID f a certificate. HRESULT ID([ut, retval] lng *pval); 84

85 Interface Reference EFT v6.0 and later Prperty IssuerCName As String read-nly Retrieves the issuer's cmmn name n a certificate. HRESULT IssuerCName([ut, retval] BSTR *pval); EFT v6.0 and later Prperty IssuerCuntry As String read-nly Retrieves the cuntry f a certificate's issuer. HRESULT IssuerCuntry([ut, retval] BSTR *pval); EFT v6.0 and later Prperty IssuerOneLine As String read-nly Retrieves all f the Issuer infrmatin (rganizatin + unit + cmmn name + cuntry) cncatenated in ne line. HRESULT IssuerOneLine([ut, retval] BSTR *pval); EFT v6.0 and later Prperty IssuerOrg As String read-nly Retrieves the rganizatin that issued the certificate. HRESULT IssuerOrg([ut, retval] BSTR *pval); EFT v6.0 and later Prperty IssuerUnit As String read-nly Retrieves the unit f a certificate's issuer. HRESULT IssuerUnit([ut, retval] BSTR *pval); EFT v6.0 and later Prperty NtAfter As String read-nly Retrieves the certificate's expiratin date. HRESULT NtAfter([ut, retval] BSTR *pval); EFT v6.0 and later Prperty NtBefre As String read-nly Retrieves the first date the certificate became valid. HRESULT NtBefre([ut, retval] BSTR *pval); EFT v6.0 and later Prperty SubjectCName As String read-nly Retrieves the certificate subject's cmmn name. HRESULT SubjectCName([ut, retval] BSTR *pval); EFT v6.0 and later Prperty SubjectCuntry As String read-nly Retrieves the cuntry f a certificate's subject. HRESULT SubjectCuntry([ut, retval] BSTR *pval); EFT v6.0 and later 85

86 EFT API Reference Prperty SubjectOneLine As String read-nly Retrieves all f the Subject inf (rganizatin + unit + cmmn name + cuntry) cncatenated in ne line. HRESULT SubjectOneLine([ut, retval] BSTR *pval); EFT v6.0 and later Prperty SubjectOrg As String read-nly Retrieves the rganizatin that is the subject f a certificate. HRESULT SubjectOrg([ut, retval] BSTR *pval); EFT v6.0 and later Prperty SubjectUnit As String read-nly Retrieves a certificate subject's unit. HRESULT SubjectUnit([ut, retval] BSTR *pval); EFT v6.0 and later Dialg Bx Equivalents The dialg bx belw is labeled with sme f the prperties that are available via the API. ICICleanupActinParams - CleanUp Actin Parameters Interface In EFT Enterprise, yu can cnfigure an EFT Event Rule t clean up a specified flder at regularly scheduled intervals. The Cleanup in Flder Actin is available nly with the On Timer Server event. At the interval that yu specify, EFT cmpares the filter parameters f the Cleanup Actin t the files in the designated flder, then determines the creatin time f the file and deletes ("cleans up") files that match the cleanup parameters. Fr example, if yu specify t cleanup files that are lder than 7 days named dailyreprt*.dc in the flder D:\WrkFlder\Sales\Daily Reprts, any Micrsft Wrd files in that flder with dailyreprt in the file name are deleted. interface ICICleanupActinParams : IDispatch 86

87 Interface Reference Members Prperty DaysTKeepFiles As Lng Retrieves r specifies the number f days t keep files prir t cleanup. HRESULT DaysTKeepFiles([ut, retval] lng *pval); HRESULT DaysTKeepFiles([in] lng newval); Example: cleanupparams.daystkeepfiles = 14 'Remve files lder than 2 weeks EFT v6.0 and later Prperty ExcludeFileMask As Blean Retrieves r specifies whether the FileMask prperty specifies files t remve r exclude frm cleanup (e.g., remve all the files except fr thse matching FileMask). HRESULT ExcludeFileMask([ut, retval] VARIANT_BOOL *pval); HRESULT ExcludeFileMask([in] VARIANT_BOOL newval); Example: cleanupparams.excludefilemask = False 'Remve nly files matching FileMask during cleanup True = Include; False = Exclude EFT v6.0 and later Prperty FileMask As String Retrieves r specifies the files t remve r keep, depending n ExcludeFileMask prperty value. HRESULT FileMask([ut, retval] BSTR *pval); HRESULT FileMask([in] BSTR newval); Example: cleanupparams.filemask = "*.txt" EFT v6.0 and later Prperty Flder As String Retrieves r specifies the flder t cleanup. HRESULT Flder([ut, retval] BSTR *pval); HRESULT Flder([in] BSTR newval); Example: cleanupparams.flder = "C:\EFT\Flder_t_cleanup" EFT v6.0 and later Prperty Recursive As Blean Retrieves r specifies whether t cleanup all subflders recursively. HRESULT Recursive([ut, retval] VARIANT_BOOL *pval); HRESULT Recursive([in] VARIANT_BOOL newval) Example: cleanupparams.recursive = False True = Include; False = Exclude 87

88 EFT API Reference EFT v6.0 and later Dialg Bx Equivalents The ICICleanupActinParams interface prperties crrelate t the fllwing fields and cntrls in the EFT administratin interface: ICIClientSettings - Client Settings Interface The ICIClientSettings interface displays the user prperties defined fr a user in EFT. interface ICIClientSettings : IDispatch Use the ICISite interface GetUserSettings r GetSettingsLevelSettings methds t manage user accunt r Settings Template cnfiguratin. Example Set User = Site.GetUserSettings(aUsr(j)) Set 0SettingsLevel = Site.GetSettingsLevelSettings("Default Settings") Once yu btain a handle t the user r Settings Template cnfiguratin, yu can Get r Set permissins fr that user r Settings Template. See als: Difference Between VARIANT_BOOL and SFTPAdvBl Scrll dwn t see the dialg bx equivalents. Example f using the Custm prperty Jump t: C E F G I L M P R S U Members Prperty AccuntCreatinTime As Date Retrieves date the user accunt was created. HRESULT AccuntCreatinTime( [ut, retval] DATE* pval); MsgBx "Accunt creatin time: " & CStr(ClientSettings.AccuntCreatinTime) 88

89 Interface Reference Sub AddIPAccessRule(bstrMask As String, ballw As Blean, [nruleps As Lng]) Fr an example using this methd, refer t the ServerIPBanEntry script in Script Examples. See als the fllwing interfaces: ICIAutbanIPAccessRule Interface ICIBannedIP Interface ICIIPAccessRule Interface ICIManualIPAccessRule Interface Adds allwed (true) r denied (false) IP mask fr the client. HRESULT AddIPAccessRule( [in] BSTR bstrmask, [in] VARIANT_BOOL ballw, [in] lng nruleps); Example (C#): VARIANT_BOOL equals TRUE(-1) when it is allwed and FALSE(0) when it is denied client.addipaccessrule(" ", true, 0); EFT v5.1.1 and later Prperty AS2InbundSettings As CIAS2InbundSettings Retrieves user accunt's AS2 inbund settings. HRESULT AS2InbundSettings( [ut,retval] IDispatch** psttg); (v ) [ut,retval] ICIAS2InbundSettings** psttg); Set AS2InbundSettings = ClientSettings.AS2InbundSettings Prperty AS2OutbundSettings As CIAS2OutbundSettings Retrieves user accunt's AS2 utbund settings. HRESULT AS2OutbundSettings( [ut,retval] IDispatch** psttg); (v ) Set AS2OutbundSettings = ClientSettings.AS2OutbundSettings Functin AS2TestOutbundPrfile() As AS2OutbundPrfileStatus Tests user accunt's AS2 utbund prfile and returns status. HRESULT AS2TestOutbundPrfile( [ut,retval] AS2OutbundPrfileStatus* pval); if AS2StatusOk = ClientSettings.AS2TestOutbundPrfile then MsgBx Success. else MsgBx Sme ging wrng. end if 89

90 EFT API Reference Prperty Cmment As String Retrieve cmments fr a user accunt: HRESULT Cmment( [ut, retval] BSTR *pval); HRESULT Cmment( [in] BSTR newval); All versins Prperty Custm1 As String; Prperty Custm2 As String; Prperty Custm3 As String (See the example.) Retrieve the custm fields f a user accunt. HRESULT Custm1( [ut, retval] BSTR *pval); HRESULT Custm1( [in] BSTR newval); EFT v5.0.1 and later Prperty As String Retrieve a user's address. HRESULT ( [ut, retval] BSTR *pval); HRESULT ( [in] BSTR newval); All versins Prperty Fax As String Retrieve a user's fax number. HRESULT Fax( [ut, retval] BSTR *pval); HRESULT Fax( [in] BSTR newval); All versins Sub FrcePasswrdChange() Frces the user t change the accunt passwrd n the next lgin. HRESULT FrcePasswrdChange(); EFT v6.0 and later Prperty FullName As String Retrieve a user's full name. HRESULT FullName( [ut, retval] BSTR *pval); HRESULT FullName( [in] BSTR newval); All versins Functin GetAllwCOMB(pInherited) As Blean (Fr infrmatin abut using the COMB cmmand with EFT, refer t Allwing Multipart Transfers (COMB Cmmand) in the EFT Server User Guide.) 90

91 Interface Reference Retrieve whether the COMB cmmand is allwed. HRESULT GetAllwCOMB( [ut] VARIANT *pinherited, [ut,retval] VARIANT_BOOL *pval); VARIANT_BOOL equals TRUE(-1) when it is allwed and FALSE(0) when it is nt allwed. benabled = ClientSettings.GetAllwCOMB(bInherited) MsgBx "Enabled: " & CStr(bEnabled) & " Inherited: " & CStr(bInherited) Functin GetAllwFXP(pInherited) As Blean Retrieve whether FXP (site-t-site transfer) is allwed. HRESULT GetAllwFXP( [ut] VARIANT *pinherited, [ut,retval] VARIANT_BOOL *pval); VARIANT_BOOL equals TRUE(-1) when it is allwed and FALSE(0) when it is nt allwed. benabled = ClientSettings.GetAllwFXP(bInherited) MsgBx "Enabled: " & CStr(bEnabled) & " Inherited: " & CStr(bInherited) Functin GetAllwMODEZ([pInherited]) As Blean Determine if "Allw MODE Z" is enabled fr the user r Settings Template. Yu can als pass in an ptinal BOOLEAN variable as a parameter t this functin; when the functin returns, this ptinal parameter cntains the INHERITED status f this feature. HRESULT GetAllwMODEZ( [ut, ptinal] VARIANT *pinherited, [ut, retval] VARIANT_BOOL *pval); All versins Functin GetAllwNp([pInherited]) As Blean Check if a user is allwed t use the NOOP cmmand t keep a cnnectin pen. HRESULT GetAllwNp( [ut, ptinal] VARIANT *pinherited, [ut, retval] VARIANT_BOOL *pval); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled All versins Functin GetAllwXCRC([pInherited]) As Blean Retrieve whether a user is allwed t send the XCRC cmmand t cnfirm successful transfer. HRESULT GetAllwXCRC( [ut, ptinal] VARIANT *pinherited, [ut, retval] VARIANT_BOOL *pval); VARIANT_BOOL equals True(-1) = Enabled; False (0) = Disabled All versins Functin GetAppletEnabled([pInherited]) As Blean Fr an example using this methd, refer t the GetCertInf script in Script Examples. 91

92 EFT API Reference Retrieve whether Web Transfer Client is allwed fr a user r Settings Template. HRESULT GetAppletEnabled( [ut, ptinal]variant *pinherited, [ut, retval] VARIANT_BOOL *pval); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled Example fr v6.1 and later: If Client.AppletEnabled(isInherited) And isinherited Then MsgBx "WTC is allwed fr client because it is allwed fr Settings Template" End If EFT v3.5.1 and later Functin GetAS2Inbund([pInherited]) As Blean Retrieve whether AS2 inbund transactins are enabled fr the user r Settings Template. HRESULT GetAS2Inbund( [ut, ptinal] VARIANT* pinherited, [ut, retval] VARIANT_BOOL* pval); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled benabled = ClientSettings.GetAS2Inbund(bInherited) MsgBx "Enabled: " & CStr(bEnabled) & " Inherited: " & CStr(bInherited) Functin GetAS2Outbund([pInherited]) As Blean Retrieve whether AS2 utbund transactins are enabled fr the user r Settings Template. HRESULT GetAS2Outbund( [ut, ptinal] VARIANT* pinherited, [ut, retval] VARIANT_BOOL* pval); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled benabled = ClientSettings.GetAS2Outbund(bInherited) MsgBx "Enabled: " & CStr(bEnabled) & " Inherited: " & CStr(bInherited) Functin GetChangePwd([pInherited]) As Blean Determine if users can change their passwrds. HRESULT GetChangePwd( [ut, ptinal] VARIANT *pinherited, [ut, retval] VARIANT_BOOL *pval); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled All versins Functin GetClearFTP([pInherited]) As Blean Determine if a user accunt can make cnnectins using insecure FTP. HRESULT GetClearFTP( [ut, ptinal] VARIANT *pinherited, [ut, retval] VARIANT_BOOL *pval); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled 92

93 Interface Reference All versins Functin GetClearHTTP([pInherited]) As Blean Determine if a user accunt can make cnnectins using insecure HTTP. HRESULT GetClearHTTP( [ut, ptinal] VARIANT *pinherited, [ut, retval] VARIANT_BOOL *pval); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled All versins Functin GetCmplexPasswrdSettings() As CICmplexPasswrdSettings Retrieve cmplex passwrd settings fr a user r Settings Template. HRESULT GetCmplexPasswrdSettings( [ut, retval] IDispatch** ppicmplexpasswrdsettings); (v ) Set CmplexPwdSettings = ClientSettings.GetCmplexPasswrdSettings() Functin GetDescriptin() As String Retrieve the descriptin fr a user r User Settings Template. HRESULT GetDescriptin( [ut, retval] BSTR *prp); All versins Functin GetDwnladsPerSessin([pInherited]) As Lng Determine the maximum number f dwnlads a user is permitted per sessin. HRESULT GetDwnladsPerSessin( [ut, ptinal] VARIANT *pinherited, [ut, retval] lng *pval); All versins Functin GetEnableAccunt([pInherited]) As Blean Determine if a user accunt r Settings Template is enabled. HRESULT GetEnableAccunt( [ut, ptinal] VARIANT *pinherited, [ut, retval] VARIANT_BOOL *pval); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled All versins Functin GetEnableDiskQuta([pInherited]) As Blean Determine if a user accunt's hme flder space is restricted. HRESULT GetEnableDiskQuta( [ut, ptinal] VARIANT *pinherited, [ut, retval] VARIANT_BOOL *pval); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled All versins Functin GetEnablePasswrdHistry([pInherited]) As Blean 93

94 EFT API Reference Determine if passwrd reuse is allwed. HRESULT GetEnablePasswrdHistry( [ut, ptinal] VARIANT *pinherited, [ut, retval] VARIANT_BOOL *pval); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled benable = ClientSettings.GetEnablePasswrdHistry(bInherited) Functin GetEnableTimeOut([pInherited]) As Blean Determine if a user will be timed ut after their cnnectin is inactive t lng. HRESULT GetEnableTimeOut( [ut, ptinal] VARIANT *pinherited, [ut, retval] VARIANT_BOOL *pval); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled All versins Functin GetExpiratinDate(dDate) As Blean Determine whether an expiratin date is set fr a particular user accunt. (Set the expiratin date with SetExpiratinDate.) HRESULT GetExpiratinDate( [ut]variant *ddate, [ut, retval] VARIANT_BOOL *pval); Example: VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled suser = "q" sexpiratindate = "Never" If Site.GetUserSettings(sUser).GetExpiratinDate(expiratinDate) Then sexpiratindate = CStr(expiratinDate) End If MsgBx "Accunt " & suser & " expiratin date: " & sexpiratindate All versins Functin GetExpiratinDateAsVariant() As Variant Determine the expiratin date fr a particular user accunt, set with SetExpiratinDate. HRESULT GetExpiratinDateAsVariant( [ut, retval]variant *ddate); Example: Dim struser: struser = "test" set UserSettings = Site.GetUserSettings(strUser) dtaccexpdate = UserSettings.GetExpiratinDateAsVariant() WScript.Ech ("dtaccexpdate = " & dtaccexpdate) EFT v4.3.4 and later Functin GetFrcePasswrdResetOnInitialLgin([pInherited]) As Blean 94

95 Interface Reference Retrieve r specify whether the ptin t frce the user t change their passwrd n next lgin is n. If the ptin allwing this client t change their passwrd is nt inherited (i.e., is set t value ther than abinherited), this ptin verride the Site s FrcePasswrdResetOnInitialLgin value. If the ptin is ON, it des nt mean the user will necessarily be frced t change the passwrd n next lgin, because the user s passwrd might be already changed since the admin had switched the ptin frm OFF t ON. T uncnditinally frce the user t change passwrd n next lgin, use ICIClientSettings::FrcePasswrdChange methd. HRESULT GetFrcePasswrdResetOnInitialLgin( [ut, ptinal] VARIANT *pinherited, [ut, retval] VARIANT_BOOL *pval); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled client.setchangepwd abtrue verride Allw change passwrd ptin first client.setfrcepasswrdresetoninitiallgin False If client.getfrcepasswrdresetoninitiallgin(isinherited) Then If isinherited Then MsgBx "The ptin t reset passwrd is turned n frm site" End If End If EFT v6.2 and later Functin GetFTPS([pInherited]) As Blean Retrieve whether access is enabled fr a client. HRESULT GetFTPS( [ut, ptinal] VARIANT *pinherited, [ut, retval] VARIANT_BOOL *pval); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled EFT v6.0 and later Functin GetHasDwnladsPerSessin([pInherited]) As Blean Determine if there is a maximum number f files a user is allwed t dwnlad per sessin. HRESULT GetHasDwnladsPerSessin( [ut, ptinal] VARIANT *pinherited, [ut, retval] VARIANT_BOOL *pval); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled All versins Functin GetHasMaxDwnladSize([pInherited]) As Blean Determine if there is a maximum file size a user is allwed t dwnlad. HRESULT GetHasMaxDwnladSize( [ut, ptinal] VARIANT *pinherited, [ut, retval] VARIANT_BOOL *pval); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled All versins Functin GetHasMaxIPs([pInherited]) As Blean 95

96 EFT API Reference Determine if user r Settings Template has a maximum number f allwed cncurrent cnnectins frm same IP. HRESULT GetHasMaxIPs( [ut, ptinal] VARIANT *pinherited, [ut, retval] VARIANT_BOOL *pval); VARIANT_BOOL equals True(-1) = Unlimited; False(0) = Limited All versins Functin GetHasMaxSpeed([pInherited]) As Blean Determine if a user accunt has a maximum allwed transfer speed. HRESULT GetHasMaxSpeed( [ut, ptinal] VARIANT *pinherited, [ut, retval] VARIANT_BOOL *pval); VARIANT_BOOL equals True(-1) =Maximum; False(0) = Nt the maximum All versins Functin GetHasMaxUpladSize([pInherited]) As Blean Determine if there is a maximum file size a user is allwed t uplad. HRESULT GetHasMaxUpladSize( [ut, ptinal] VARIANT *pinherited, [ut, retval] VARIANT_BOOL *pval); VARIANT_BOOL equals True(-1) = Maximum; False(0) = Nt the maximum All versins Functin GetHasMaxUsers([pInherited]) As Blean Determine if a user accunt has a maximum number f allwed cncurrent cnnectins HRESULT GetHasMaxUsers( [ut, ptinal] VARIANT *pinherited, [ut, retval] VARIANT_BOOL *pval); VARIANT_BOOL equals True(-1) = Maximum; False(0) = Nt maximum All versins Functin GetHasPwdRetries([pInherited]) As Blean Determine if a user accunt will be disabled after trying t many bad passwrds in a rw. HRESULT GetHasPwdRetries( [ut, ptinal] VARIANT *pinherited, [ut, retval] VARIANT_BOOL *pval); VARIANT_BOOL equals True(-1) = Maximum; False(0) = Nt maximum GetHasPwdRetries and SetHasPwdRetries are related t an ld "disable accunt after X lgin attempts" feature, which became bslete when the PCI-enhanced feature "disable/lckut accunt after X lgin attempts in X minute perid" was intrduced. These methds were left in the.dll fr cmpatibility with ld scripts. All versins Functin GetHasUpladsPerSessin([pInherited]) As Blean Determine if there is a maximum number f files a user is allwed t uplad per sessin. HRESULT GetHasUpladsPerSessin( [ut, ptinal] VARIANT *pinherited, [ut, retval] VARIANT_BOOL *pval); 96

97 Interface Reference VARIANT_BOOL equals True(-1) = Maximum; False(0) = Nt maximum All versins Functin GetHmeDir([pInherited]) As Blean Determine if the user r User Settings Template can have a separate hme flder. HRESULT GetHmeDir( [ut, ptinal] VARIANT *pinherited, [ut, retval] VARIANT_BOOL *pval); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled If client.gethmedir Then MsgBx "Client has separate hme flder" End If All versins Functin GetHmeDirIsRt([pInherited]) As Blean Determine if a user accunt hme flder is set as the user's default rt flder. HRESULT GetHmeDirIsRt( [ut, ptinal] VARIANT *pinherited, [ut, retval] VARIANT_BOOL *pval); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled All versins Functin GetHmeDirString() As String Retrieve the path t a user r User Settings Template hme flder. HRESULT GetHmeDirString( [ut, retval] BSTR *prp); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled All versins Functin GetHTTPS([pInherited]) As Blean Retrieve whether access is enabled fr a client. HRESULT GetHTTPS( [ut, ptinal] VARIANT *pinherited, [ut, retval] VARIANT_BOOL *pval); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled EFT v6.0 and later Functin GetInactiveAccuntsMnitring([pInherited]) As Blean Retrieve whether inactive accunts are disabled/remved after days f inactivity. HRESULT GetInactiveAccuntsMnitring( [ut, ptinal] VARIANT* pinherited, [ut, retval] VARIANT_BOOL* pval); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled benable = ClientSettings.GetInactiveAccuntsMnitring(bInherited) 97

98 EFT API Reference Functin GetIncrrectPasswrdAttempts() As Lng Retrieve hw many times a user has tried t cnnect with incrrect lg in infrmatin. HRESULT GetIncrrectPasswrdAttempts( [ut, retval] lng *pval); All versins Functin GetIPAccessRules() As Variant See als the fllwing interfaces: ICIAutbanIPAccessRule Interface ICIBannedIP Interface ICIIPAccessRule Interface ICIManualIPAccessRule Interface ICIServer - Server Interface : GetIPAccessRules ICISite - Single-Site Interface : GetIPAccessRules Retrieves an array f client/template IP Access rules. HRESULT GetIPAccessRules( [ut, retval] VARIANT *amasks); The fllwing script wuld retrieve a list f all IP addresses that have been banned autmatically fr a user r Settings template. rules = ClientSettings.GetIPAccessRules() Fr Each key In rules If key.type = 0 Then WScript.ech "AutBan" End if If key.type = 1 Then WScript.ech "Manual " + key.address End if Next Functin GetLimitAccessByIP([pInherited]) As Blean Determines if the IP Access Restrictin List is enabled n the Settings Template r user accunt. HRESULT GetLimitAccessByIP( [ut, ptinal] VARIANT *pinherited, [ut, retval] VARIANT_BOOL *pval); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled If client.getlimitaccessbyip Then MsgBx "client s Limit Access by IP is n" End If EFT v6.1 and later Functin GetLimitLginAttempts([pInherited]) As Blean Retrieve whether recgnize whether client will be penalized if he repeatedly tries t lgin with incrrect passwrd. HRESULT GetLimitLginAttempts( 98

99 Interface Reference [ut, ptinal] VARIANT *pinherited, [ut, retval] VARIANT_BOOL *pval); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled EFT v5.1.1 and later Functin GetLckutNtDisable([pInherited]) As Blean Determine if accunt lckut is enabled fr a user. HRESULT GetLckutNtDisable( [ut, ptinal] VARIANT *pinherited, [ut, retval] VARIANT_BOOL *pval); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled EFT v5.1.1 and later Functin GetLginMsg() As Lng Determine if the server uses the default lg in message, adds a custm string t the default message, replaces the default message with a custm string, r if the server uses n lgin message. HRESULT GetLginMsg( [ut, retval] lng *pval); If client.getlginmsg = 3 Then MsgBx "N lgin banner will be shwn fr the client" End If What is the difference between a cnnectin banner and a lgin message? EFT displays a cnnectin banner immediately after a client cnnects via FTP, befre requesting the lgin credentials. After the client prvides the lgin credentials and the credentials are authenticated, EFT displays a lgin banner. The default lgin banner is Lgin OK, prceed. At the Settings Template level, yu can specify the fllwing alternatives: use default ( Lgin OK, prceed. ) banner, append smething t default ( Lgin OK, prceed. ) banner, use its wn banner, and shw n banner at all. At the user accunt level, yu can specify the fllwing alternatives: use default (the ne frmed at the Settings Template level) banner, append smething t default (the ne frmed at Settings Template level) banner, use its wn banner, and shw n banner at all. All versins Functin GetLginMsgString() As String Retrieve a lgin message. HRESULT GetLginMsgString( [ut, retval] BSTR *prp); All versins Functin GetMaxDwnladSize([pInherited]) As Lng Determine the maximum file size, in kilbytes, a user is allwed t dwnlad. HRESULT GetMaxDwnladSize( [ut, ptinal] VARIANT *pinherited, [ut, retval] lng *pval); All versins Functin GetMaxIPs([pInherited]) As Lng 99

100 EFT API Reference Determine the number f cncurrent cnnectins allwed frm the same IP address. HRESULT GetMaxIPs( [ut, ptinal] VARIANT *pinherited, [ut, retval] lng *pval); All versins Functin GetMaxSpace([pInherited]) As Lng Determine the amunt f space a user can use in a hme flder. HRESULT GetMaxSpace( [ut, ptinal] VARIANT *pinherited, [ut, retval] lng *pval); All versins Functin GetMaxSpeed([pInherited]) As Lng Retrieve, in kilbytes per secnd, the maximum transfer speed allwed fr an accunt r Settings Template. HRESULT GetMaxSpeed( [ut, ptinal] VARIANT *pinherited, [ut, retval] lng *pval); All versins Functin GetMaxUpladSize([pInherited]) As Lng Retrieve, in kilbytes, the maximum file size a user is allwed t uplad. HRESULT GetMaxUpladSize( [ut, ptinal] VARIANT *pinherited, [ut, retval] lng *pval); All versins Functin GetMaxUsers([pInherited]) As Lng Retrieve the maximum number f cncurrent cnnectins allwed fr an accunt r Settings Template. HRESULT GetMaxUsers( [ut, ptinal] VARIANT *pinherited, [ut, retval] lng *pval); All versins Functin GetPwdRetries([pInherited]) As Lng Retrieve the number f times a user can try t cnnect with an incrrect passwrd. HRESULT GetPwdRetries( [ut, ptinal] VARIANT *pinherited, [ut, retval] lng *pval); All versins Functin GetRequireStrngPasswrds([pInherited]) As Blean Retrieve whether strng (cmplex) passwrds are required. HRESULT GetRequireStrngPasswrds( [ut, ptinal] VARIANT* pinherited, [ut, retval] VARIANT_BOOL* pval); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled 100

101 Interface Reference benabled = ClientSettings.GetRequireStrngPasswrds(bInherited) MsgBx "Enabled: " & CStr(bEnabled) & " Inherited: " & CStr(bInherited) Functin GetResetPasswrdSettings() As CIResetPasswrdSettings Fr an example using this methd, refer t the GetCertInf script in Script Examples. Retrieve passwrd reset settings. HRESULT GetResetPasswrdSettings( [ut, retval] IDispatch** ppiresetpasswrdsettings); (v ) Set ResetPwdSettings = ClientSettings.GetResetPasswrdSettings() Functin GetSFTP([pInherited]) As Blean Retrieve whether access is enabled fr a client. True = Access enabled; False = Access disabled. HRESULT GetSFTP( [ut, ptinal] VARIANT *pinherited, [ut, retval] VARIANT_BOOL *pval); Example: VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled Dim struser:struser = "test" set UserSettings = Site.GetUserSettings(strUser) bisftpenabled = UserSettings.GetSFTP() WScript.Ech ("bisftpenabled="& bisftpenabled) All versins Functin GetSftpAuthenticatinType([pInherited]) As String Retrieve the SFTP authenticatin type fr the client. HRESULT GetSftpAuthenticatinType( [ut, ptinal] VARIANT *pinherited, [ut, retval] BSTR *pval); Example: Dim struser:struser = "test" Set UserSettings = Site.GetUserSettings(strUser) Dim strsftpenabled: strsftpenabled=false UserSettings.GetSFTPAuthenticatinType(strSFTPEnabled) Dim strtype: strtype = UserSettings.GetSFTPAuthenticatinType() WScript.Ech "SFTP Enabled: " & strsftpenabled WSCript.Ech "SFTP Passwrd type: " & strtype All versins Functin GetSSHKeyID([pInherited]) As Lng See als: ExprtSSHKey (in the Server interface) SetSSHKeyID GetSSHKeyIDs (belw) Retrieve the SFTP (SSH) certificate ID fr the client. HRESULT GetSSHKeyID( 101

102 EFT API Reference [ut, ptinal] VARIANT *pinherited, [ut, retval] lng *pval); Example: Fr Each keyid In ClientSettings.GetSSHKeyIDs(bInherited) MsgBx "Key id: " & CStr(keyId) Next All versins Functin GetSSHKeyIDs([pInherited]) As Variant See als ExprtSSHKey (in the Server interface) SetSSHKeyIDs GetSSHKeyID (abve) Retrieves the list f SSH Key IDs assigned t this client HRESULT GetSSHKeyIDs( [ut, ptinal] VARIANT *pinherited, [ut, retval] VARIANT* pval); Example Assign keys with ID = 1, 2, 3, 4, 5, 6, 7, and 8 t Test_user, then get all keys: Set Client = Site.GetUserSettings("Test_user") Client.SetSSHKeyIDs Array(1, 2, 3, 4, 5, 7, 8) Dim allkeys keys = Client.GetSSHKeyIDs Fr Each keyid in Keys allkeys = allkeys & vbnewline & CStr(keyID) Next MsgBx allkeys Expected result is message bx with 1, 2, 3, 4, 5, 6, 7, 8 Functin GetSSLAuthenticatinType([pInherited]) As String Retrieve the SSL authenticatin type fr the client. HRESULT GetSSLAuthenticatinType( [ut, ptinal] VARIANT *pinherited, [ut, retval] BSTR *pval); Example: Dim struser:struser = "test" Set UserSettings = Site.GetUserSettings(strUser) Dim strsslenabled: strsslenabled=false UserSettings.GetSSLAuthenticatinType(strSSLEnabled) Dim strtype: strtype = UserSettings.GetSSLAuthenticatinType() WScript.Ech "SSL Enabled: " & strsslenabled WSCript.Ech "SSL Passwrd type: " & strtype EFT v5.1 and later Functin GetSSLKeyID([pInherited]) As Lng Retrieve the SSL key ID fr the client. HRESULT GetSSLKeyID( [ut, ptinal] VARIANT *pinherited, 102

103 Interface Reference [ut, retval] lng *pval); Example: Dim struser:struser = "test" Set UserSettings = Site.GetUserSettings(strUser) Dim strsslenabled: strsslenabled=false UserSettings.GetSSLKeyID(strSSLEnabled) Dim strtype: strtype = UserSettings.GetSSLKeyID() WScript.Ech "SSL Enabled: " & strsslenabled WSCript.Ech "SSL Passwrd type: " & strtype EFT v5.1 and later Functin GetTimeOut([pInherited]) As Lng Retrieve the number f secnds the Server will allw a user's cnnectin t be inactive befre clsing the cnnectin. HRESULT GetTimeOut( [ut, ptinal] VARIANT *pinherited, [ut, retval] lng *pval); All versins Functin GetTwFactrAuthenticatin([pInherited]) As Blean Retrieve whether tw-factr authenticatin is enabled fr the user r Settings Template. HRESULT GetTwFactrAuthenticatin( [ut, ptinal] VARIANT* pinherited, [ut, retval] VARIANT_BOOL* pval); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled btfa = ClientSettings.GetTwFactrAuthenticatin(bInherited) Functin GetUpladsPerSessin([pInherited]) As Lng Determine the maximum number f uplads a user is permitted per sessin. HRESULT GetUpladsPerSessin( [ut, ptinal] VARIANT *pinherited, [ut, retval] lng *pval); All versins Functin GetUsedSpace() As Lng Determine the amunt f disk space, in kilbytes, a user has used in a hme flder. HRESULT GetUsedSpace( [ut, retval] lng *pval); MsgBx "Client data ccupy " & client.getusedspace & " KB" All versins Prperty ID As Lng Retrieve a user r Settings Template ID. HRESULT ID( [ut,retval] LONG* pid); 103

104 EFT API Reference Example: MsgBx "Client id: " & CStr(ClientSettings.ID) Prperty InvalidAttemptsPerid(pDate) As Lng Specify r retrieve user invalid lgin attempts critical perid. HRESULT InvalidAttemptsPerid([ut, retval] lng *pval); HRESULT InvalidAttemptsPerid([in] lng newval); EFT v6.1 and later Prperty IPAccessAllwedDefault As Blean Specify r retrieve whether user r Settings Template IP access settings allw r deny access by default (if n rule match). HRESULT IPAccessAllwedDefault( [ut, retval] VARIANT_BOOL *pval); HRESULT IPAccessAllwedDefault( [in] VARIANT_BOOL newval); VARIANT_BOOL equals True(-1) = Allw; False(0) = Deny EFT v5.1.1 and later Prperty IsCnnected As Blean read-nly Retrieve whether the client is cnnected. (Client nly, nt fr user grup.) HRESULT IsCnnected([ut, retval] VARIANT_BOOL* pval); VARIANT_BOOL equals True(-1) = Cnnected; False(0) = Nt cnnected if True = ClientSettings.IsCnnected then MsgBx "Cnnected." end if Functin IsInactivityPeridLimited(pDate) As Blean Retrieve whether client accunt has limited maximum inactivity perid and what the perid end date is. HRESULT IsInactivityPeridLimited( [ut] VARIANT* pdate, [ut,retval] VARIANT_BOOL* plimited); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled If Client.IsInactivityPeridLimited(date) Then MsgBx "Client will be sanctined (remved r disabled)" &_ "if it cntinues be inactive befre " & CStr(date) End If Prperty IsLcked As Blean Retrieve whether accunt is lcked. HRESULT IsLcked( [ut, retval] VARIANT_BOOL* pval); 104

105 Interface Reference VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled if False = ClientSettings.IsLcked then MsgBx "Nt lcked." end if Functin IsPasswrdAgeLimited(pDate) As Blean Retrieve whether the user accunt passwrd will expire and, if s, the expiratin date. HRESULT IsPasswrdAgeLimited( [ut] VARIANT* pdate, [ut,retval] VARIANT_BOOL* plimited); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled If Client.IsPasswrdAgeLimited(date) Then MsgBx "Client Passwrd will expire " & CStr(date) End If EFT v6.1 and later Prperty LastCnnectinTime As Date Retrieve date and time user last cnnected t the server. HRESULT LastCnnectinTime( [ut, retval] DATE* pval); MsgBx "Last cnnectin time: " & CStr(ClientSettings.LastCnnectinTime) Prperty LastMdificatinTime As Date Retrieve date and time user accunt was last mdified. HRESULT LastMdificatinTime( [ut, retval] DATE* pval); MsgBx "Last mdificatin time: " & CStr(ClientSettings.LastMdificatinTime) Prperty LastMdifiedBy As String Retrieve administratr accunt name that last mdified this user accunt. HRESULT LastMdifiedBy( [ut, retval] BSTR* pval); MsgBx "Last mdified by: " & CStr(ClientSettings.LastMdifiedBy) Prperty LckutPerid As Lng Retrieve the length f time a user's accunt is lcked ut after invalid lgin attempts. HRESULT LckutPerid( 105

106 EFT API Reference [ut, retval] lng *pval); HRESULT LckutPerid( [in] lng newval); EFT v5.1.1 and later Prperty MaxInactivePerid As Lng Retrieve the number f days f inactivity befre accunt is disabled r remved. HRESULT MaxInactivePerid( [ut,retval] LONG* pval); HRESULT MaxInactivePerid( [in] LONG newval); MsgBx "Inactive perid is: " & CStr(ClientSettings.MaxInactivePerid) ClientSettings.MaxInactivePerid = 90 Prperty MaxInvalidLginAttempts As Lng Retrieve the maximum number f invalid lgin attempts a client can make t a Site. HRESULT MaxInvalidLginAttempts( [ut, retval] lng *pval); HRESULT MaxInvalidLginAttempts( [in] lng newval); EFT v5.1.1 and later Sub MveIPAccessRule(nRulePsFrm As Lng nrulepst As Lng) See als the fllwing interfaces: ICIAutbanIPAccessRule Interface ICIBannedIP Interface ICIIPAccessRule Interface ICIManualIPAccessRule Interface Change allwed IP access rule psitin. HRESULT MveIPAccessRule( [in] lng nrulepsfrm, [in] lng nrulepst); VARIANT_BOOL True(-1) = Enabled; False(0) = Disabled ClientSettings.MveIPAccessRule(1,2) Prperty Pager As String View a user's pager number. HRESULT Pager( [ut, retval] BSTR *pval); HRESULT Pager( [in] BSTR newval); 106

107 Interface Reference EFT v5.0 and later Prperty PasswrdHistrySize As Lng Retrieves number f previus passwrds prhibited frm reuse. HRESULT PasswrdHistrySize( [ut,retval] LONG* pval); HRESULT PasswrdHistrySize(LONG newval); MsgBx "Passwrd histry size: " & CStr(ClientSettings.PasswrdHistrySize) ClientSettings.PasswrdHistrySize = 8 Prperty Phne As String Retrieve a user's telephne number. HRESULT Phne( [ut, retval] BSTR *pval); HRESULT Phne( [in] BSTR newval); EFT v5.0 and later Prperty RemveInactiveAccunts As Blean Specifies whether inactive accunts are remved. HRESULT RemveInactiveAccunts( [ut, retval] VARIANT_BOOL* pval); HRESULT RemveInactiveAccunts(VARIANT_BOOL newval); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled if False = ClientSettings.RemveInactiveAccunts then MsgBx "Disable" else MsgBx "Remve" end if ClientSettings.RemveInactiveAccunts = True Sub RemveIPAccessRule(nRulePs As Lng) See als the fllwing interfaces: ICIAutbanIPAccessRule Interface ICIBannedIP Interface ICIIPAccessRule Interface ICIManualIPAccessRule Interface Remve the IP access rule. 107

108 EFT API Reference HRESULT RemveIPAccessRule( [in] lng nruleps); ClientSettings.RemveIPAccessRule(0) EFT v5.1.1 and later Functin ResetPasswrd() As Blean Retrieve whether a user can reset the accunt passwrd. HRESULT ResetPasswrd( [ut,retval] VARIANT_BOOL* pbsuccess); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled if False = ClientSettings.ResetPasswrd() then MsgBx "Reset user passwrd failed." end if Sub SetAllwCOMB(val As SFTPAdvBl) Specify whether COMB cmmand is allwed. HRESULT SetAllwCOMB(SFTPAdvBl val); SFTPAdvBl abfalse = 0 abinherited = -2 abtrue = 1 ClientSettings.SetAllwCOMB abtrue Sub SetAllwFXP(val As SFTPAdvBl) Specify whether site-t-site transfers are allwed. HRESULT SetAllwFXP(SFTPAdvBl val); SFTPAdvBl abfalse = 0 abinherited = -2 abtrue = 1 ClientSettings.SetAllwCOMB abfalse Sub SetAllwMODEZ(val As SFTPAdvBl) Specify whether Allw Mde Z fr the client ON r OFF. HRESULT SetAllwMODEZ( [in] SFTPAdvBl val); SFTPAdvBl abfalse = 0 abinherited =

109 Interface Reference abtrue = 1 All versins Sub SetAllwNp(val As SFTPAdvBl) Allw a user t send the NOOP cmmand t keep a cnnectin pen. Use the same methd t prhibit the user frm sending the NOOP cmmand. HRESULT SetAllwNp( [in] SFTPAdvBl val); SFTPAdvBl abfalse = 0 abinherited = -2 abtrue = 1 All versins Sub SetAllwXCRC(val As SFTPAdvBl) Allw a user t send the XCRC cmmand t cnfirm transfers. Use the same methd t prhibit the user frm sending the XCRC cmmand. HRESULT SetAllwXCRC( [in] SFTPAdvBl val); SFTPAdvBl abfalse = 0 abinherited = -2 abtrue = 1 All versins Sub SetAppletEnabled(val As SFTPAdvBl) Specify EFT Web Transfer Client applet access setting fr a user r Settings Template. HRESULT SetAppletEnabled( [in]sftpadvbl val); SFTPAdvBl abfalse = 0 abinherited = -2 abtrue = 1 Example, setting the state: slsettings = SetSettingsLevelSettings("Default Settings") benabled = slsettings.setappletenabled( binherited ) EFT v3.5.1 and later Sub SetAS2Inbund(val As SFTPAdvBl) Specify whether AS2 Inbund is enabled fr the user r Settings Template. HRESULT SetAS2Inbund( [in] SFTPAdvBl val); SFTPAdvBl abfalse = 0 abinherited = -2 abtrue = 1 ClientSettings.SetAS2Inbund abinherited 109

110 EFT API Reference Sub SetAS2Outbund(val As SFTPAdvBl) Specify whether AS2 Outbund is enabled fr the user r Settings Template. HRESULT SetAS2Outbund( [in] SFTPAdvBl val); SFTPAdvBl abfalse = 0 abinherited = -2 abtrue = 1 ClientSettings.SetAS2Outbund abtrue Sub SetChangePwd(val As SFTPAdvBl) Allw a user t change passwrds. Use the same methd t prhibit the user frm changing passwrds. HRESULT SetChangePwd( [in] SFTPAdvBl val); SFTPAdvBl abfalse = 0 abinherited = -2 abtrue = 1 All versins Sub SetClearFTP(val As SFTPAdvBl) Allw a user t cnnect using insecure FTP. Use the same methd t prhibit the user frm making insecure FTP cnnectins. HRESULT SetClearFTP( [in] SFTPAdvBl val); SFTPAdvBl abfalse = 0 abinherited = -2 abtrue = 1 All versins Sub SetClearHTTP(val As SFTPAdvBl) Allw a user accunt t make cnnectins using insecure HTTP. HRESULT SetClearHTTP( [in]sftpadvbl val); SFTPAdvBl abfalse = 0 abinherited = -2 abtrue = 1 EFT v4.3.4 and EFT v5.1 and later Sub SetCmplexPasswrdSettings(pICmplexPasswrdSettings As CICmplexPasswrdSettings) 110

111 Interface Reference Specify cmplex passwrd settings fr a user r Settings Template. HRESULT SetCmplexPasswrdSettings( [in] IDispatch* picmplexpasswrdsettings); ( ) ClientSettings.SetCmplexPasswrdSettings CmplexPwdSettings Sub SetDescriptin(bstrVal As String) Prvide a descriptin fr a user r Settings Template. HRESULT SetDescriptin( [in] BSTR bstrval); All versins Sub SetDwnladsPerSessin(val As Lng) Specify the maximum number f dwnlads a user is permitted per sessin. HRESULT SetDwnladsPerSessin( [in] lng val); All versins Sub SetEnableAccunt(val As SFTPAdvBl) Enable a user accunt r Settings Template. HRESULT SetEnableAccunt( [in] SFTPAdvBl val); SFTPAdvBl abinherited = -2 abfalse = 0 abtrue = 1 Yu need t btain a handle t the specific user r Settings Template frm ICISite's GetUserSettings methd r ICISite's GetSettingsLevelSettings methd befre yu can perfrm an actin upn that user r Settings Template. Belw is a sample cde snippet using PHP that demnstrates this technique: <?php // first create server bject $Server = new COM("SFTPCOMInterface.CIServer") r die("unable t instantiate Server"); // cnnect t server $Server->Cnnect("lcalhst",1000,"admin","admin"); // get handle t list f sites $Sites = $Server->Sites(); // chse yur site. On mst ne-site systems this will be "0" $MySite = $Sites->Item(0); // Pull the settings fr the user that yu want. $Settings = $MySite->GetUserSettings("juser"); // enable r disable r inherit. // Enable is 1. Disable is 0. Inherit is -2 // Ntice that yu apply this t the settings fr the user that yu just pulled $Settings->SetEnableAccunt(1); 111

112 EFT API Reference // Be sure t apply the settings r else nthing will really change $Server->ApplyChanges(); // clse the cnnectin. $Server->Clse();?> All versins Sub SetEnableDiskQuta(val As SFTPAdvBl) Limit the amunt f space a user can use in a hme flder. HRESULT SetEnableDiskQuta( [in] SFTPAdvBl val); SFTPAdvBl abfalse = 0 abinherited = -2 abtrue = 1 All versins Sub SetEnablePasswrdHistry(val As SFTPAdvBl) Specifies whether Prhibit reuse f previus passwrds is enabled. HRESULT SetEnablePasswrdHistry(SFTPAdvBl val); SFTPAdvBl abfalse = 0 abinherited = -2 abtrue = 1 ClientSettings.SetEnablePasswrdHistry abtrue Sub SetEnableTimeOut(val As SFTPAdvBl) Enable the timeut feature fr a user r Settings Template. HRESULT SetEnableTimeOut( [in] SFTPAdvBl val); SFTPAdvBl abfalse = 0 abinherited = -2 abtrue = 1 All versins Sub SetExpiratinDate(dDate, benable As Blean) Specify the expiratin date fr a particular user accunt. Use GetExpiratinDate t determine whether the expiratin date is set. When passing values t COM methds, VARIANTS are preferred t STRING values. HRESULT SetExpiratinDate( [in] VARIANT *ddate, [in]variant_bool benable); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled PHP 5 example (uses a VARIANT rather than a STRING t set the expiratin date): $expiredate = "05/15/2005"; $enableexpiratin = 1; 112

113 Interface Reference $vtdate = new VARIANT($expiredate, VT_DATE); $UserSettings->SetExpiratinDate($expiredate, $enableexpiratin); Set client_settings = Site.GetUserSettings("testuser") client_settings.setexpiratindate CDate(FrmatDateTime("15/05/2005")),True All versins Sub SetFrcePasswrdResetOnInitialLgin(val As Blean) Retrieve r specify whether the ptin t frce the user t change their passwrd n next lgin is n. If the ptin allwing this client t change their passwrd is nt inherited (i.e., is set t value ther than abinherited), this ptin verrides Site s Frce Passwrd Reset On Initial Lgin prperty value. Please nte if the ptin is ON, it des nt mean the user will necessarily be frced t change the passwrd n next lgin, because the user s passwrd might be already changed since the admin had switched the ptin frm OFF t ON. T uncnditinally frce the user t change passwrd n next lgin, use ICIClientSettings::FrcePasswrdChange methd. HRESULT SetFrcePasswrdResetOnInitialLgin( [in] VARIANT_BOOL val); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled client.setchangepwd abtrue verride Allw change passwrd ptin first client.setfrcepasswrdresetoninitiallgin False If client.getfrcepasswrdresetoninitiallgin(isinherited) Then If isinherited Then MsgBx "The ptin t reset passwrd is turned n frm site" End If End If EFT v6.2 and later Sub SetFTPS(val As SFTPAdvBl) Enable r disable FTPS access fr a user accunt. HRESULT SetFTPS( [in] SFTPAdvBl val); SFTPAdvBl abfalse = 0 abinherited = -2 abtrue = 1 EFT v6.x and later Sub SetHasDwnladsPerSessin(val As SFTPAdvBl) Limit a user t a maximum number f dwnlads per sessin. HRESULT SetHasDwnladsPerSessin( [in] SFTPAdvBl val); SFTPAdvBl abfalse = 0 abinherited = -2 abtrue = 1 113

114 EFT API Reference All versins Sub SetHasMaxDwnladSize(val As SFTPAdvBl) Limit a user t a maximum dwnlad size. HRESULT SetHasMaxDwnladSize( [in] SFTPAdvBl val); SFTPAdvBl abfalse = 0 abinherited = -2 abtrue = 1 All versins Sub SetHasMaxIPs(val As SFTPAdvBl) Limit the maximum number f cncurrent cnnectins frm the same IP address. HRESULT SetHasMaxIPs([in] SFTPAdvBl val); SFTPAdvBl abfalse = 0 abinherited = -2 abtrue = 1 All versins Sub SetHasMaxSpeed(val As SFTPAdvBl) Limit a user t a maximum transfer speed. Use the same methd t turn ff the limit. HRESULT SetHasMaxSpeed( [in] SFTPAdvBl val); SFTPAdvBl abfalse = 0 abinherited = -2 abtrue = 1 All versins Sub SetHasMaxUpladSize(val As SFTPAdvBl) Limit a user t a maximum uplad size. HRESULT SetHasMaxUpladSize( [in] SFTPAdvBl val); SFTPAdvBl abfalse = 0 abinherited = -2 abtrue = 1 All versins Sub SetHasMaxUsers(val As SFTPAdvBl) Limit a user t a maximum number f cncurrent cnnectins. HRESULT SetHasMaxUsers( [in] SFTPAdvBl val); SFTPAdvBl abfalse = 0 abinherited =

115 Interface Reference abtrue = 1 All versins Sub SetHasPwdRetries(val As SFTPAdvBl) Disable an accunt if a user enters bad passwrds t many times in a rw. Use the same methd t allw an unlimited number f bad passwrds. HRESULT SetHasPwdRetries( [in] SFTPAdvBl val); SFTPAdvBl abfalse = 0 abinherited = -2 abtrue = 1 All versins Sub SetHasUpladsPerSessin(val As SFTPAdvBl) Limit a user t a maximum number f uplads per sessin. HRESULT SetHasUpladsPerSessin( [in] SFTPAdvBl val); SFTPAdvBl abfalse = 0 abinherited = -2 abtrue = 1 All versins Sub SetHmeDir(val As SFTPAdvBl) Specify the hme flder fr a user accunt. HRESULT SetHmeDir( [in] SFTPAdvBl val); SFTPAdvBl abfalse = 0 abinherited = -2 abtrue = 1 client.sethmedir abinherited 'use hme flder frm Settings Template All versins Sub SetHmeDirIsRt(val As SFTPAdvBl) Set a user's hme flder as the user's default rt flder. HRESULT SetHmeDirIsRt( [in] SFTPAdvBl val); SFTPAdvBl abfalse = 0 abinherited = -2 abtrue = 1 All versins Sub SetHmeDirString(bstrVal As String) Set the path t a user r User Settings Template hme flder. 115

116 EFT API Reference HRESULT SetHmeDirString( [in] BSTR bstrval); All versins Sub SetHTTPS(val As SFTPAdvBl) Allw a user accunt r Settings Template t cnnect ver HTTPS. HRESULT SetHTTPS( [in] SFTPAdvBl val); SFTPAdvBl abfalse = 0 abinherited = -2 abtrue = 1 EFT v6.0 and later Sub SetInactiveAccuntsMnitring(val As SFTPAdvBl) Fr an example using this methd, refer t the GetCertInf script in Script Examples. Specify whether an inactive accunt is remved/disabled. HRESULT SetInactiveAccuntsMnitring(SFTPAdvBl val); ClientSettings.SetInactiveAccuntsMnitring abfalse SFTPAdvBl abfalse = 0 abinherited = -2 abtrue = 1 Example (C#): //Set inactivity mnitring usersettings.remveinactiveaccunts = true; usersettings.maxinactiveperid = 30; usersettings.setinactiveaccuntsmnitring(sftpadvbl.abtrue); Sub SetLimitAccessByIP(val As SFTPAdvBl) Specify whether Limit Access by IP is n fr the Settings Template r user accunt. HRESULT SetLimitAccessByIP( [in] SFTPAdvBl val); SFTPAdvBl abfalse = 0 abinherited = -2 abtrue = 1 client.setlimitaccessbyip abinherit Example (VBScript); assigns IP address t a client as an allwed IP address: client.addipaccessrule " ", True 'Assign 'Allwed 'IP EFT v6.1 and later Sub SetLimitLginAttempts(val As SFTPAdvBl) 116

117 Interface Reference Specify whether client will be penalized if he repeatedly tries t lgin with incrrect passwrd. HRESULT SetLimitLginAttempts( [in] SFTPAdvBl val); SFTPAdvBl abfalse = 0 abinherited = -2 abtrue = 1 EFT v5.1.1 and later Sub SetLckutNtDisable(val As Blean) Enable accunt lckut fr a user. HRESULT SetLckutNtDisable( [in] VARIANT_BOOL val); VARIANT_BOOL equals True(-1) = Enabled; False(0) = Disabled client.setlckutntdisable False EFT v5.1.1 and later Sub SetLginMsg(val As Lng) Specify whether the client is presented with the default lg in message, a custm string added t the default message, a custm string in place f the default, r uses n lg in message. HRESULT SetLginMsg( [in] lng val); Values 0 = Use default 1 = Add t default 2 = Replace default 3 = Nne All versins Sub SetLginMsgString(bstrVal As String) Create a lgin message. HRESULT SetLginMsgString( [in] BSTR bstrval); All versins Sub SetMaxDwnladSize(val As Lng) Specify the maximum file size, in kilbytes, a user is permitted dwnlad. HRESULT SetMaxDwnladSize( [in] lng val); All versins Sub SetMaxIPs(val As Lng) Specify the number f cncurrent cnnectins allwed frm the same IP address. HRESULT SetMaxIPs( [in] lng val); All versins 117

118 EFT API Reference Sub SetMaxSpace(val As Lng) Specify the amunt f space, in kilbytes, a user can use in a hme flder. HRESULT SetMaxSpace( [in] lng val); All versins Sub SetMaxSpeed(val As Lng) Specify the speed at which an accunt r Settings Template can transfer file. HRESULT SetMaxSpeed( [in] lng val); All versins Sub SetMaxUpladSize(val As Lng) Specify the maximum file size, in kilbytes, a user is permitted uplad. HRESULT SetMaxUpladSize( [in] lng val); All versins Sub SetMaxUsers(val As Lng) Specify the maximum number f cncurrent cnnectins a user can make, either fr an individual accunt r thrugh a Settings Template. HRESULT SetMaxUsers( [in] lng val); All versins Sub SetPwdRetries(val As Lng) Specify the maximum number f times a user can try t cnnect t the server with incrrect lg in infrmatin. HRESULT SetPwdRetries( [in] lng val); All versins Sub SetRequireStrngPasswrds(val As SFTPAdvBl) Specify whether Enfrce strng passwrds is enabled. HRESULT SetRequireStrngPasswrds( [in] SFTPAdvBl val); SFTPAdvBl abfalse = 0 abinherited = -2 abtrue = 1 ClientSettings.SetRequireStrngPasswrds abfalse Sub SetResetPasswrdSettings(pIResetPasswrdSettings As CIResetPasswrdSettings) Fr an example using this methd, refer t the GetCertInf script in Script Examples. Specify passwrd reset settings. 118

119 Interface Reference HRESULT SetResetPasswrdSettings( [in] IDispatch* piresetpasswrdsettings); (v ) ClientSettings.SetResetPasswrdSettings ResetPwdSettings Example (C#): //Change reset passwrd settings CIResetPasswrdSettings resetpswdsettings = usersettings.getresetpasswrdsettings(); resetpswdsettings.maxpasswrdagedays = 10; resetpswdsettings.send befreexpiratin = false; resetpswdsettings.send upnexpiratin = false; resetpswdsettings.daysprirpasswrdexpiratintreminduser = 1; usersettings.setresetpasswrdsettings(resetpswdsettings); Sub SetSFTP(val As SFTPAdvBl) Enable r disable SFTP access fr a client. The Site must be restarted fr the change t take effect; the SetSFTP methd returns TRUE. HRESULT SetSFTP( [in] SFTPAdvBl val); SFTPAdvBl abfalse = 0 abinherited = -2 abtrue = 1 Example: Dim struser:struser = "test" set UserSettings = Site.GetUserSettings(strUser) UserSettings.SetSFTP abtrue All versins Sub SetSftpAuthenticatinType(val As String) Specify set the authenticatin type fr the client. HRESULT SetSftpAuthenticatinType( [in] BSTR val); Values inherited passwrd key bth either (v6.3 and later) Example: Dim struser:struser = "test" set UserSettings = Site.GetUserSettings(strUser) UserSettings.SetSFTPAuthenticatinType ("passwrd") All versins Sub SetSSHKeyID(val As Lng) See als: ExprtSSHKey (in the Server interface) 119

120 EFT API Reference GetSSHKeyID Specify the SFTP (SSH) certificate ID fr the client. HRESULT SetSSHKeyID( [in] lng val); Example: Dim struser:struser = "test" set UserSettings = Site.GetUserSettings(strUser) UserSettings.SetSSHKeyID(1) All versins Sub SetSSHKeyIDs(val) See als ExprtSSHKey (in the Server interface) GetSSHKeyIDs Fr an example using this methd, refer t the SSH script in Script Examples. Assigns the list f SSH Key IDs t this client. HRESULT SetSSHKeyIDs( [in] VARIANT val); Assign keys with ID = 1, 2, 3, 4, 5, 6, 7, and 8 t Test_user, then get all keys: Set Client = Site.GetUserSettings("Test_user") Client.SetSSHKeyIDs Array(1, 2, 3, 4, 5, 7, 8) Dim allkeys keys = Client.GetSSHKeyIDs Fr Each keyid in Keys allkeys = allkeys & vbnewline & CStr(keyID) Next MsgBx allkeys Example (C#): Expected result is message bx with 1, 2, 3, 4, 5, 6, 7, 8 Assign keys in a list t a client: usersettings.setsshkeyids(keyids.tarray()); Sub SetSSLAuthenticatinType(val As String) Specify the SSL authenticatin type fr the client. HRESULT SetSSLAuthenticatinType( [in] BSTR val); Example: Dim struser:struser = "test" Set UserSettings = Site.SetUserSettings(strUser) Dim strsslenabled: strsslenabled=false UserSettings.SetSSLAuthenticatinType(strSSLEnabled) Dim strtype: strtype = UserSettings.SetSSLAuthenticatinType() WScript.Ech "SSL Enabled: " & strsslenabled WSCript.Ech "SSL Passwrd type: " & strtype EFT v5.1 and later 120

121 Interface Reference Sub SetSSLKeyID(val As Lng) Specify the SSL Key ID used by a client. HRESULT SetSSLKeyID( [in] lng val); Example: Dim struser:struser = "test" Set UserSettings = Site.GetUserSettings(strUser) Dim strsslenabled: strsslenabled=false UserSettings.SetSSLKeyID(strSSLEnabled) Dim strtype: strtype = UserSettings.SetSSLKeyID() WScript.Ech "SSL Enabled: " & strsslenabled WSCript.Ech "SSL Passwrd type: " & strtype EFT v5.1 and later Sub SetTimeOut(val As Lng) Specify the number f secnds the Server will wait befre clsing a user's inactive cnnectin. HRESULT SetTimeOut( [in] lng val); All versins Sub SetTwFactrAuthenticatin(val As SFTPAdvBl) Specify whether t use tw-factr authenticatin fr passwrd management. HRESULT SetTwFactrAuthenticatin( [in] SFTPAdvBl val); SFTPAdvBl abfalse = 0 abinherited = -2 abtrue = 1 ClientSettings.SetTwFactrAuthenticatin abfalse Sub SetUpladsPerSessin(val As Lng) Specify the maximum number f uplads a user is permitted per sessin. SetUpladsPerSessin( [in] lng val); All versins Dialg Bx Equivalents The ICIClientSettings interface methds and prperties crrelate t the fllwing fields and cntrls in the EFT administratin interface: User Accunt Details Prperties User accunt details include the user's full name, phne, , fax, and pager, and can include custm fields and cmments. Yu can view/set the user accunt details in the administratin interface n the user's General tab by clicking Accunt Details. The dialg bx belw is labeled with sme f the parameters that are available in the ICIClientSettings interface 121

122 EFT API Reference User Accunt General Settings.. 122

123 Interface Reference User Cnnectin Limits User Cnnectin Prtcls User SFTP Authenticatin Optins 123

124 EFT API Reference User FTP Security Settings User IP Access Ban List User Lgin Security Optins 124

125 Interface Reference User Security and Passwrd Settings User Transfer Limits Settings User cnnectin limits in the API include getting/setting the number f uplads and dwnlad per sessin and maximum uplad and dwnlad sizes. The dialg bx belw, available frm the user's Cnnectins tab, is labeled with sme f the transfer limits parameters that are available in the ICIClientSettings interface. Example f using the Custm prperty // efttestcustmfields.js // CREATED: 24 May 2007 // Script t cnfirm use f EFT5 Custm Fields prperties f a CClientSettings in Javascript thrugh API. // var args = WScript.Arguments; if ( args.length < 5 ) { WScript.Ech("Usage: efttestcustmfields <eft hst> <eft prt> <userid> <passwrd> <user id>\n"); WScript.Ech("Example: cscript efttestcustmfields.js admin admin f\n"); WScript.Quit(1); 125

126 EFT API Reference } var shst = args(0); var iprt = args(1); var suser = args(2); var spass = args(3); var saccuntname = args(4); var server = new ActiveXObject("SFTPCOMInterface.CIServer"); WScript.Ech("Cnnecting..."); server.cnnect(shst, iprt, suser, spass); WScript.Ech("Cnnected!"); var site = server.sites().sitebyid(1); // fr simplicity, assume first site var Settings = site.getusersettings(saccuntname); WScript.Ech("Obtained user settings fr user accunt '" + Settings.FullName + "' with hme directry: " + Settings.GetHmeDirString() ); WScript.Ech("Custm1='" + Settings.Custm1 + "'"); WScript.Ech("Custm2='" + Settings.Custm2 + "'"); WScript.Ech("Custm3='" + Settings.Custm3 + "'"); // Nw set the custm fields t new values WScript.Ech("\nSetting new values..."); Settings.Custm1 = "Randm=" + Math.flr((65535*Math.randm())) + " [" + (new Date()).tLcaleString() + "]"; Settings.Custm2 = "Randm=" + Math.flr((65535*Math.randm())) + " [" + (new Date()).tLcaleString() + "]"; Settings.Custm3 = "Randm=" + Math.flr((65535*Math.randm())) + " [" + (new Date()).tLcaleString() + "]"; server.applychanges(); // Nw REQUERY t CONFIRM the custm fields are the new values WScript.Ech("Requerying values..."); var Settings = site.getusersettings(saccuntname); WScript.Ech("\nObtained NEW user settings fr user accunt '" + Settings.FullName + "' with hme directry: " + Settings.GetHmeDirString() ); WScript.Ech("Custm1='" + Settings.Custm1 + "'"); WScript.Ech("Custm2='" + Settings.Custm2 + "'"); WScript.Ech("Custm3='" + Settings.Custm3 + "'"); server.clse(); WScript.Ech("\nDne"); WScript.Quit(0); ICICmmandActinParams - Cmmand Actin Parameters Interface The ICICmmandActinParams interface allws yu t make changes t the settings f Execute Cmmand Event Actin. (Access the ICICmmandActinParams interface with ICIEventActin when its Type prperty returns CmmandActin). interface ICICmmandActinParams : IDispatch Example: If actin.type = 1 then 'CmmandActin Set cmmandparams = actin.params EndIf Prperties Prperty Cmmand As String 126

127 Interface Reference Retrieves r specifies cmmand t execute. HRESULT Cmmand( [ut, retval] BSTR *pval); HRESULT Cmmand( [in] BSTR newval); Example: cmmandparams.cmmand = "My_cmmand" EFT v5.2 and later Prperty Parameters As String Retrieves r specifies parameters required t execute cmmand. HRESULT Parameters( [ut, retval] BSTR *pval); HRESULT Parameters( [in] BSTR newval); Example: cmmandparams.parameters = "D:\MyFlder\MyScript.vbs A -B" EFT v5.2 and later Prperty WrkingFlder As String Retrieves r specifies wrking directry, if different frm executable path. HRESULT WrkingFlder( [ut, retval] BSTR *pval); HRESULT WrkingFlder( [in] BSTR newval); Example: cmmandparams.wrkingflder = "D:\MyFlder" EFT v5.2 and later Dialg Bx Equivalents The dialg bx belw is labeled with the prperties that are available via the API. 127

128 EFT API Reference ICICmmandSettings - Cmmand Settings Interface Cmmands can execute prgrams, scripts, r batch files with r withut cmmand line arguments. Cmmands can be invked directly by a user frm their client (if permitted by the Server administratr) r as an autmated actin frm the Server s Event Rules. When the Event Rule is triggered, the Server executes the specified custm Cmmand. T cnfigure the Server t execute Cmmands, yu first create the cmmand, then add the cmmand t an Event Rule. The ICICmmandSettings interface allws yu t make changes t the settings f a Site's custm Cmmands. Access the ICICmmandSettings interface with the ICISite : GetCmmandSettings methd. When yu change a custm cmmand with the ICICmmandSettings interface, yu must call ICIServer's ApplyChanges methd fr the changes t take effect. interface ICICmmandSettings : IDispatch Example Set cs = s.getcmmandsettings(acmmands(i)) "Functin" and "Sub" indicate that the member is a methd; "Prperty" indicates that it is a prperty. Members Sub AddUserPermissin(bstrUser As String) Adds user t list f users r Settings Templates wh are permitted t execute the cmmand. HRESULT AddUserPermissin([in] BSTR bstruser); All versins Prperty Descriptin As String Retrieves r specifies the descriptin f a cmmand. 128

129 Interface Reference HRESULT Descriptin([ut, retval] BSTR *pval); HRESULT Descriptin([in] BSTR newval); All versins Prperty EnablePrcessTimeOut As Blean Retrieves r specifies whether prcess timeut is enabled. HRESULT EnablePrcessTimeOut([ut, retval] VARIANT_BOOL *pval); HRESULT EnablePrcessTimeOut([in] VARIANT_BOOL newval); TRUE=Enabled; FALSE=Disabled All versins Prperty Executable As String Retrieves r specifies the name f file executed with the cmmand. HRESULT Executable([ut, retval] BSTR *pval); HRESULT Executable([in] BSTR newval); All versins Functin GetUserPermissins() As Variant Retrieves an array f users r Settings Templates wh have permissin t execute the cmmand. HRESULT GetUserPermissins([ut, retval] VARIANT *ausers); All versins Prperty IsEnabled As Blean Retrieves r specifies whether cmmand is enabled. HRESULT IsEnabled([ut, retval] VARIANT_BOOL *pval); HRESULT IsEnabled([in] VARIANT_BOOL newval); TRUE=Enabled; FALSE=Disabled All versins Prperty LgPath As String Retrieves r specifies the path t the lg fr the cmmand. HRESULT LgPath([ut, retval] BSTR *pval); HRESULT LgPath([in] BSTR newval); Examples (VBScript): lgpath = Cmmand.LgPath Cmmand.LgPath = "C:\" & Cmmand.Name & ".lg" EFT v6.1 and later Prperty MinNumOfParams As Lng Retrieves r specifies the minimum number f parameters required t execute the cmmand. HRESULT MinNumOfParams([ut, retval] lng *pval); HRESULT MinNumOfParams([in] lng newval); All versins Prperty MinNumOfParamsMsg As String 129

130 EFT API Reference Retrieves r changes the message sent when the wrng number f parameters is prvided t execute a cmmand. HRESULT MinNumOfParamsMsg([ut, retval] BSTR *pval); HRESULT MinNumOfParamsMsg([in] BSTR newval); All versins Prperty Name As String Retrieves r specifies the name f the cmmand. (D nt cnfuse with Executable.) HRESULT Name([ut, retval] BSTR *pval); HRESULT Name([in] BSTR newval); All versins Prperty Parameters As String Retrieves r specifies the list f parameters required t execute cmmand. HRESULT Parameters([ut, retval] BSTR *pval); HRESULT Parameters([in] BSTR newval); All versins Prperty PrcessTimeOut As Lng Retrieves r specifies the number f secnds t befre timeut if cmmand fails t execute. HRESULT PrcessTimeOut([ut, retval] lng *pval); HRESULT PrcessTimeOut([in] lng newval); All versins Prperty RedirectOutputTClient As Blean Retrieve r specify whether t redirect utput t the client. HRESULT RedirectOutputTClient([ut, retval] VARIANT_BOOL *pval); HRESULT RedirectOutputTClient([in] VARIANT_BOOL newval); TRUE=Enabled; FALSE=Disabled All versins Prperty RedirectOutputTLg As Blean Retrieves r specifies whether t redirect utput t the lg. HRESULT RedirectOutputTLg([ut, retval] VARIANT_BOOL *pval); HRESULT RedirectOutputTLg([in] VARIANT_BOOL newval); TRUE=Enabled; FALSE=Disabled All versins Sub RemveUserPermissin(bstrUser As String) Remves a user r Settings Template frm list f users r Settings Templates wh are permitted t execute the cmmand. HRESULT RemveUserPermissin([in] BSTR bstruser); All versins Prperty RequireParams As Blean Retrieves r specifies whether parameters are required t execute the cmmand. HRESULT RequireParams([ut, retval] VARIANT_BOOL *pval); HRESULT RequireParams([in] VARIANT_BOOL newval); 130

131 Interface Reference TRUE=Require parameters; FALSE=D nt require parameters All versins Dialg Bx Equivalents The ICICmmandSettings interface methds and prperties crrelate t the fllwing fields and cntrls in the EFT administratin interface. (The FTP Custm Cmmand Specific dialg bx appears when yu click Cnfigure.) 131

132 EFT API Reference ICICmplexPasswrdSettings - Cmplex Passwrd Settings Interface The ICICmplexPasswrdSettings interface is used t specify cmplex passwrd settings, such as minimum passwrd length. interface ICICmplexPasswrdSettings : IDispatch{ See als: Difference Between VARIANT_BOOL and SFTPAdvBl Scrll dwn t see the dialg bx equivalents. ICIServer::GetCmplexPasswrdSettings, ICIServer::SetCmplexPasswrdSettings; ICISite::GetCmplexPasswrdSettings, ICISite::SetCmplexPasswrdSettings; ICIClientSettings::GetCmplexPasswrdSettings, and ICIClientSettings::SetCmplexPasswrdSettings methds Members Prperty MaxRepeatingCharacters As Lng Retrieves r specifies the maximum number f repeating characters allwed. HRESULT MaxRepeatingCharacters([ut, retval] LONG* pval); HRESULT MaxRepeatingCharacters([in] LONG newval); 132

133 Interface Reference MsgBx "Max repeating characters: " & CStr(CPS.MaxRepeatingCharacters) CPS.MaxRepeatingCharacters = 3 Prperty MaxUsernameCharactersInPasswrd As Lng Retrieves r specifies the maximum number f username characters allwed in passwrds. HRESULT MaxUsernameCharactersInPasswrd([ut, retval] LONG* pval); HRESULT MaxUsernameCharactersInPasswrd([in] LONG newval); MsgBx "Max username characters: " & CStr(CPS.MaxUsernameCharactersInPasswrd) CPS.MaxUsernameCharactersInPasswrd = 4 Prperty MinCharCategriesInPasswrd As Lng Retrieves r specifies the minimum number f character categries in passwrds. HRESULT MinCharCategriesInPasswrd([ut, retval] LONG* pval); HRESULT MinCharCategriesInPasswrd([in] LONG newval); MsgBx "Minimal character categries in passwd is: " & CStr(CPS.MinCharCategriesInPasswrd) CPS.MinCharCategriesInPasswrd = 3 Prperty MinPasswrdLength As Lng Retrieves r specifies the minimum passwrd length. HRESULT MinPasswrdLength([ut, retval] LONG* pval); HRESULT MinPasswrdLength([in] LONG newval); MsgBx "Minimal passwrd length is: " & CStr(CPS.MinPasswrdLength) CPS.MinPasswrdLength = 8 Prperty PasswrdDictinaryPath As String Retrieves r specifies the path t the dictinary file. HRESULT PasswrdDictinaryPath([ut, retval] BSTR* pval); HRESULT PasswrdDictinaryPath([in] BSTR newval); 133

134 EFT API Reference MsgBx "Dictinary path is: " & CPS.PasswrdDictinaryPath CPS.PasswrdDictinaryPath = "C:\dictinary.txt" Prperty PrhibitDictinaryWrdsInPasswrd As Blean Retrieves r specifies whether dictinary wrds are prhibited in passwrds. HRESULT PrhibitDictinaryWrdsInPasswrd([ut, retval] VARIANT_BOOL* pval); HRESULT PrhibitDictinaryWrdsInPasswrd([in] VARIANT_BOOL newval); MsgBx "Prhibit dictinary is enable: " & CStr(CPS.PrhibitDictinaryWrdsInPasswrd) CPS.PrhibitDictinaryWrdsInPasswrd = True Prperty PrhibitReverseDictinaryWrdsInPasswrd As Blean Retrieves r specifies whether reverse dictinary wrds are prhibited in passwrds. HRESULT PrhibitReverseDictinaryWrdsInPasswrd([ut, retval] VARIANT_BOOL* pval); HRESULT PrhibitReverseDictinaryWrdsInPasswrd([in] VARIANT_BOOL newval); MsgBx "Prhibit reverse dictinary is enable: " & CStr(CPS.PrhibitReverseDictinaryWrdsInPasswrd) CPS.PrhibitReverseDictinaryWrdsInPasswrd = True Prperty RequireDigitsInPasswrd As Blean Retrieves r specifies whether digits are required in passwrds. HRESULT RequireDigitsInPasswrd([ut, retval] VARIANT_BOOL* pval); HRESULT RequireDigitsInPasswrd([in] VARIANT_BOOL newval); MsgBx "Digits is required: " & CStr(CPS.RequireDigitsInPasswrd) CPS.RequireDigitsInPasswrd = False Prperty RequireLwerCaseInPasswrd As Blean Retrieves r specifies whether lwercase is required in passwrds. HRESULT RequireLwerCaseInPasswrd([ut, retval] VARIANT_BOOL* pval); 134

135 Interface Reference HRESULT RequireLwerCaseInPasswrd([in] VARIANT_BOOL newval); MsgBx "Lwer case is required: " & CStr(CPS.RequireLwerCaseInPasswrd) CPS.RequireLwerCaseInPasswrd = False Prperty RequireNnAlphaNumericInPasswrd As Blean Retrieves r specifies whether nn-alphanumeric characters are required in passwrds. HRESULT RequireNnAlphaNumericInPasswrd([ut, retval] VARIANT_BOOL* pval); HRESULT RequireNnAlphaNumericInPasswrd([in] VARIANT_BOOL newval); MsgBx "Nn-alphanumeric is required: " & CStr(CPS.RequireNnAlphaNumericInPasswrd) CPS.RequireNnAlphaNumericInPasswrd = True Prperty RequireUpperCaseInPasswrd As Blean Retrieves r specifies whether uppercase is required in passwrds. HRESULT RequireUpperCaseInPasswrd([ut, retval] VARIANT_BOOL* pval); HRESULT RequireUpperCaseInPasswrd([in] VARIANT_BOOL newval); MsgBx "Upper case is required: " & CStr(CPS.RequireUpperCaseInPasswrd) CPS.RequireUpperCaseInPasswrd = False Dialg Bx Equivalents The ICICmplexPasswrdSettings interface members crrelate t the fllwing fields and cntrls in the EFT administratin interface. (Select the "Enfrce strng passwrds" check bx.) 135

136 EFT API Reference ICICmpundCnditin - Cmpund Cnditin Interface The ICICmpundCnditin interface allws yu t make changes t the Event Rule Cnditin settings. (See als ICISimpleCnditin - Simple Cnditin Interface.) interface ICICmpundCnditin : IDispatch "Functin" and "Sub" indicate that the member is a methd; "Prperty" indicates that it is a prperty. Members Functin Add(prperty As EventPrperty, p As CnditinOperatr, varvalue, bnt As Blean) As Object Add a cmpund Cnditin. HRESULT Add( [in] EventPrperty prperty, [in] CnditinOperatr p, [in] VARIANT varvalue, [in] VARIANT_BOOL bnt, [ut, retval] IDispatch** ppdispsimplecnditin); EFT v5.2 and later Functin Cunt() As Lng Retrieve the number f listed cnditins. HRESULT Cunt( [ut, retval] lng *plcunt); EFT v5.2 and later Sub Delete(lIndex As Lng) Deletes a Cnditin. HRESULT Delete( [in] lng lindex); EFT v5.2 and later Functin Item(lIndex As Lng) As Object 136

137 Interface Reference Retrieves a simple cnditin bject by index. HRESULT Item( [in] lng lindex, [ut, retval] IDispatch** ppdispsimplecnditin); EFT v5.2 and later Prperty Operatr As LgicalOperatr Retrieves r specifies a lgical peratin used in calculating the cmpund cnditin result (gruping f simple cnditin items). HRESULT Operatr( [ut, retval] LgicalOperatr *pval); HRESULT Operatr( [in] LgicalOperatr newval); EFT v5.2 and later ICICnnectedUser - Cnnected User Interface The ICICnnectedUser interface is used t retrieve infrmatin abut cnnected users. See als the ICISite::CnnectedUsers prperty. interface ICICnnectedUser : IDispatch "Functin" indicates that the member is a methd; "Prperty" indicates that it is a prperty. Members Prperty CnnectedAt As Date read-nly Retrieves the date/time the user cnnected. HRESULT CnnectedAt( [ut,retval] DATE* pval); MsgBx "Cnnected at: " & CU.CnnectedAt Prperty CnnectinType As String read-nly Retrieves the type f cnnectin (e.g., FTP, HTTP, HTTPS, SFTP). HRESULT CnnectinType( [ut,retval] BSTR* pval); MsgBx "Cnnectin type: " & CU.CnnectinType Prperty DataCnnectin As String read-nly Retrieves the data cnnectin state ("N data cnnectin.", "RETRieving file", "STORing file", "RETRieving flder listing", and "N/A"). HRESULT DataCnnectin( [ut,retval] BSTR* pval); MsgBx "Data cnnectin state: " & CU.DataCnnectin 137

138 EFT API Reference Prperty FileName As String read-nly Retrieves the filename currently dwnlading/uplading. HRESULT FileName( [ut,retval] BSTR* pval); MsgBx "File name:" & CStr(CU.FileName) Prperty FileSize As Signed Duble Lng read-nly Retrieves the file size f the file currently dwnlading. HRESULT FileSize( [ut,retval] LONGLONG* pval); MsgBx "File size: " & CStr(CU.FileSize) Prperty ID As Lng read-nly Retrieves the cnnectin ID. HRESULT ID( [ut, retval] LONG* pval); MsgBx "ID: " & CU.ID Prperty IP As String read-nly Retrieves the user's cnnecting IP address. HRESULT IP( [ut,retval] BSTR* pval); MsgBx "IP: " & CU.IP Prperty Lg As String Retrieves the name f the transfer lg. HRESULT Lg( [ut,retval] BSTR* pval); MsgBx "Lg: " & CU.Lg Prperty Lgin As String read-nly Retrieves the username. 138

139 Interface Reference HRESULT Lgin( [ut, retval] BSTR* pval); MsgBx "User: " & CU.Lgin Prperty Structure As String read-nly Retrieves data cnnectin structure ( File r N/A ). HRESULT Structure( [ut,retval] BSTR* pval); MsgBx "Structure: " & CU.Structure Prperty TransferMde As String read-nly Retrieves the transfer mde. (Pssible values are "stream" r "N/A") HRESULT TransferMde( [ut,retval] BSTR* pval); MsgBx "Structure: " & CU.Structure Prperty TransferredSize As Signed Duble Lng read-nly Retrieves the transferred size in bytes. HRESULT TransferredSize( [ut,retval] LONGLONG* pval); MsgBx "Transferred size: " & CStr(CU.TransferredSize) Prperty TransferTime As Lng read-nly Retrieves the transfer time in secnds. HRESULT TransferTime( [ut,retval] LONG* pval); MsgBx "Transfer time: " & CStr(CU.TransferTime) Prperty type As String read-nly Retrieves the mde f cnnectin ("ASCII, "IMAGE, "EBCDIC"). Only fr FTP, FTPS explicit, FTPS implicit cnnectins; fr thers it returns "N/A." HRESULT Type( [ut,retval] BSTR* pval); MsgBx "Type: " & CU.Type 139

140 EFT API Reference Dialg Bx Equivalents The ICICnnectedUser interface members crrelate t the fllwing fields and cntrls in the EFT administratin interface. (EFT Enterprise v6.3 is shwn in illustratin; the prperties are the same in later versins.) ICICntentIntegrityCntrlActinParams The ICICntentIntegrityCntrlActinParams refers t the Cntent Integrity Cntrl dialg bx used in the Scan file using Cntent Integrity Cntrl Actin in Event Rules. Prperties Prperty AdHcPrfile As Object (accessing this prperty n an ICICntentIntegrityCntrlActinParams bject that uses a preset prfile will cause the script t fail. HRESULT AdHcPrfile([ut, retval] IDispatch** prfile); HRESULT AdHcPrfile([in] IDispatch* prfile); EFT v7.0.3 Prperty File As String HRESULT File([ut, retval] BSTR *pval); HRESULT File([in] BSTR newval); EFT v7.0.3 Prperty PrfileName As String HRESULT PrfileName([ut, retval] BSTR *pval); HRESULT PrfileName([in] BSTR newval); EFT v

141 Interface Reference Related Tpics ICICntentIntegrityCntrlPrfile ICIServer - Server Interface: AddCntentIntegrityCntrlPrfile CntentIntegrityCntrlPrfileList DeleteCntentIntegrityCntrlPrfile GetCntentIntegrityCntrlPrfile TestCntentIntegrityCntrlPrfile UpdateCntentIntegrityCntrlPrfile ICICntentIntegrityCntrlPrfile The ICICntentIntegrityCntrlPrfile interface is used t define Cntent Integrity Cntrl prfiles used in the Scan file using Cntent Integrity Cntrl Actin in Event Rules. Many f these settings depend n the settings n the ICAP server. (Yu can als define an "ad hc" prfile when defining the Event Rule.) Prperties Prperty AuditRespnseHeaders As String HRESULT AuditRespnseHeaders([ut, retval] BSTR *pval); HRESULT AuditRespnseHeaders([in] BSTR newval); EFT v7.0.3 Prperty AuditRespnseHeadersEnabled As Lng HRESULT AuditRespnseHeadersEnabled([ut, retval] BOOL *pval); HRESULT AuditRespnseHeadersEnabled([in] BOOL newval); EFT v7.0.3 Prperty Hst As String HRESULT Hst([ut, retval] BSTR *pval); HRESULT Hst([in] BSTR newval); EFT v7.0.3 Prperty IcapMde As IcapMde HRESULT IcapMde([ut, retval] IcapMde *pval); HRESULT IcapMde([in] IcapMde newval); (See als the IcapMde enum.) EFT v7.0.3 Prperty MaxScanSize As Lng HRESULT MaxScanSize([ut, retval] lng *pval); HRESULT MaxScanSize([in] lng newval); EFT v7.0.3 Prperty MaxScanSizeEnabled As Lng HRESULT MaxScanSizeEnabled([ut, retval] BOOL *pval); HRESULT MaxScanSizeEnabled([in] BOOL newval); 141

142 EFT API Reference EFT v7.0.3 Prperty MaxScanSizeUnits As IcapMaxScanSizeUnits HRESULT MaxScanSizeUnits([ut, retval] IcapMaxScanSizeUnits *pval); HRESULT MaxScanSizeUnits([in] IcapMaxScanSizeUnits newval); (See als the IcapMaxScanSizeUnits enum.) EFT v7.0.3 Prperty Name As String HRESULT Name([ut, retval] BSTR *pval); HRESULT Name([in] BSTR newval); EFT v7.0.3 Prperty Path As String HRESULT Path([ut, retval] BSTR *pval); HRESULT Path([in] BSTR newval); EFT v7.0.3 Prperty Prt As Lng HRESULT Prt([ut, retval] lng *pval); HRESULT Prt([in] lng newval); EFT v7.0.3 Prperty RespnseParsingRespnseBdyText As String HRESULT RespnseParsingRespnseBdyText([ut, retval] BSTR *pval); HRESULT RespnseParsingRespnseBdyText([in] BSTR newval); EFT v7.0.3 Prperty RespnseParsingRespnseHeadersText As String HRESULT RespnseParsingRespnseHeadersText([ut, retval] BSTR *pval); HRESULT RespnseParsingRespnseHeadersText([in] BSTR newval); EFT v7.0.3 Prperty VilatinIsNnBlcking As Blean HRESULT VilatinIsNnBlcking([ut, retval] VARIANT_BOOL *pval); HRESULT VilatinIsNnBlcking([in] VARIANT_BOOL newval); EFT v

143 Interface Reference Dialg Bx Equivalents Script Examples Adding / Updating a Prfile ''''''''''''''''''''''''' ''Add prfile ''''''''''''''''''''''''' Set newprfile = WScript.CreateObject("SFTPCOMInterface.CICntentIntegrityCntrlPrfile") newprfile.name = "test3" newprfile.hst = "lcalhst3" newprfile.prt = "3333" //... SFTPServer.AddCntentIntegrityCntrlPrfile newprfile ''''''''''''''''''''''''' ''Update prfile ''''''''''''''''''''''''' newprfile.hst = "newhst" i = SFTPServer.GetCntentIntegrityCntrlPrfile("test3") SFTPServer.UpdateCntentIntegrityCntrlPrfile newprfile, i Lping Thrugh the Prfile List and Printing Basic Infrmatin prfiles = SFTPServer.CntentIntegrityCntrlPrfileList Fr Each prfile In prfiles WScript.Ech "Prfile: " & prfile.name & "; Hst: " & prfile.hst & "; Prt: " & prfile.prt Next 143

144 EFT API Reference Building the Actin Parameters, Using Ad Hc Prfiles Set CICActinParams = WScript.CreateObject("SFTPCOMInterface.CICntentIntegrityCntrlActinParams") ''This ActinParams is nw linked t Prfile1 in the server list CICActinParams.PrfileName = "Prfile1" CICActinParams.File = "File" ''Setting an Ad Hc Prfile Set adhcprfile = WScript.CreateObject("SFTPCOMInterface.CICntentIntegrityCntrlPrfile") adhcprfile.hst = "lcalhst3" adhcprfile.prt = "2222" CICActinParams.AdHcPrfile = adhcprfile ''If we set the prfile name t a saved prfile and then try t get the ad hc prfile prperty, we'll get an errr CICActinParams.PrfileName = "Prfile1" Set AdHcPrfile = CICActinParams.AdHcPrfile Related Tpics CntentIntegrityCntrl enum (EventActinType) IcapMde enum IcapMaxScanSizeUnits enum ICICntentIntegrityCntrlActinParams ICIDMZGateway - DMZ Gateway Interface Use the ICIDMZGateway interface t edit the DMZ Gateway cnfiguratin in EFT. See als the ICISite::DMZGateway prperty. interface ICIDMZGateway : IDispatch Prperties Prperty AllwPASVMde As Blean (In v6.3.0, it was "AssignPASVMde") Retrieves r specifies whether t enable PASV mde. HRESULT AllwPASVMde([ut,retval] VARIANT_BOOL* pval); HRESULT AllwPASVMde(VARIANT_BOOL newval); MsgBx Passive mde allw: & CStr(GW.AllwPASVMde) GW.AllwPASVMde = True Prperty Enable As Blean Retrieves r specifies whether t enable DMZ Gateway. HRESULT Enable([ut,retval] VARIANT_BOOL* pval); HRESULT Enable([in] VARIANT_BOOL newval); Example (VB Script): 144

145 Interface Reference MsgBx DMZ Gateway is enabled: & CStr(GW.Enable) GW.Enable = False Prperty FTPPrt As Lng Retrieves r specifies the FTP prt. HRESULT FTPPrt([ut,retval] LONG* pval); HRESULT FTPPrt([in] LONG newval); MsgBx FTP prt fr external cnnectins: & CStr(GW.FTPPrt) GW.FTPPrt = 21 Prperty FTPSExplPrt As Lng Retrieves r specifies the FTPS explicit prt. HRESULT FTPSExplPrt([ut,retval] LONG* pval); HRESULT FTPSExplPrt([in] LONG newval); MsgBx FTPS explicit prt fr external cnnectins: & CStr(GW.FTPSExplPrt) GW.FTPSExplPrt = 21 Prperty FTPSImplPrt As Lng Retrieves r specifies the FTP implicit prt. HRESULT FTPSImplPrt([ut,retval] LONG* pval); HRESULT FTPSImplPrt([in] LONG newval) MsgBx FTPS implicit prt fr external cnnectins: & CStr(GW.FTPSImplPrt) GW.FTPSImplPrt = 990 Prperty GatewayIP As String Retrieves r specifies the DMZ Gateway IP address. HRESULT GatewayIP([ut,retval] BSTR* pval); HRESULT GatewayIP([in] BSTR newval); 145

146 EFT API Reference MsgBx DMZ Gateway IP is: & GW.GatewayIP GW.GatewayIP = Prperty GatewayPrt As Lng Retrieves r specifies the prt n which the DMZ Gateway cmmunicates with EFT. HRESULT GatewayPrt([ut,retval] LONG* pval); HRESULT GatewayPrt([in] LONG newval); MsgBx DMZ Gateway prt is: & CStr(GW.GatewayPrt) GW.GatewayPrt = Prperty HTTPPrt As Lng Retrieves r specifies the HTTP prt. HRESULT HTTPPrt([ut,retval] LONG* pval); HRESULT HTTPPrt([in] LONG newval); MsgBx HTTP prt fr external cnnectins: & CStr(GW.HTTP) GW.HTTP = 80 Prperty HTTPSPrt As Lng Retrieves r specifies the HTTPS prt. HRESULT HTTPSPrt([ut,retval] LONG* pval); HRESULT HTTPSPrt([in] LONG newval); MsgBx HTTPS prt fr external cnnectins: & CStr(GW.HTTPS) GW.HTTPS = 443 Prperty PASVListenIP As Lng Retrieves r specifies the PASV IP address. HRESULT PASVListenIP([ut,retval] BSTR* pval); HRESULT PASVListenIP([in] BSTR newval); 146

147 Interface Reference MsgBx Passive mde listening IP: & GW.PASVListenIP GW.PASVListenIP = Prperty PASVPrtMax As Lng Retrieves r specifies the upper end f the PASV prt range. HRESULT PASVPrtMax([ut,retval] LONG* pval); HRESULT PASVPrtMax([in] LONG newval); MsgBx Lwer bund f prt range is: & CStr(GW.PASVPrtMax) GW.PASVPrtMax = Prperty PASVPrtMin As Lng Retrieves r specifies the lwer end f the PASV prt range. HRESULT PASVPrtMin([ut,retval] LONG* pval); HRESULT PASVPrtMin([in] LONG newval); MsgBx Lwer bund f prt range is: & CStr(GW.PASVPrtMin) GW.PASVPrtMin = Prperty RuteFTP As Blean Retrieves r specifies whether t enable FTP. HRESULT RuteFTP([ut,retval] VARIANT_BOOL* pval); HRESULT RuteFTP([in] VARIANT_BOOL newval); if True = GW.RuteFTP then MsgBx FTP is ruting. end if GW.RuteFTP = False Prperty RuteFTPSExpl As Blean Retrieves r specifies whether t enable FTPS explicit. 147

148 EFT API Reference HRESULT RuteFTPSExpl([ut,retval] VARIANT_BOOL* pval); HRESULT RuteFTPSExpl([in] VARIANT_BOOL newval); if True = GW.RuteFTPSExpl then MsgBx FTPS explicit is ruting. end if GW.RuteFTPSExpl = False Prperty RuteFTPSImpl As Blean Retrieves r specifies whether t enable FTPS implicit. HRESULT RuteFTPSImpl([ut,retval] VARIANT_BOOL* pval); HRESULT RuteFTPSImpl([in] VARIANT_BOOL newval); if True = GW.RuteFTPSImpl then MsgBx FTPS implicit is ruting. end if GW.RuteFTPSImpl = False Prperty RuteHTTP As Blean Retrieves r specifies whether t enable HTTP. HRESULT RuteHTTP([ut,retval] VARIANT_BOOL* pval); HRESULT RuteHTTP([in] VARIANT_BOOL newval); if True = GW.RuteHTTP then MsgBx HTTP is ruting. end if GW.RuteHTTP = False Prperty RuteHTTPS As Blean Retrieves r specifies whether t enable HTTPS. HRESULT RuteHTTPS([ut,retval] VARIANT_BOOL* pval); HRESULT RuteHTTPS([in] VARIANT_BOOL newval); if True = GW.RuteHTTPS then MsgBx HTTPS is ruting. end if 148

149 Interface Reference GW.RuteHTTPS = False Prperty RuteSFTP As Blean Retrieves r specifies whether t enable SFTP. HRESULT RuteSFTP([ut,retval] VARIANT_BOOL* pval); HRESULT RuteSFTP([in] VARIANT_BOOL newval); if True = GW.RuteSFTP then MsgBx SFTP is ruting. end if GW.RuteSFTP = False Prperty SFTPPrt As Lng Retrieves r specifies the SFTP prt. HRESULT SFTPPrt([ut,retval] LONG* pval); HRESULT SFTPPrt([in] LONG newval); MsgBx SFTP prt fr external cnnectins: & CStr(GW.SFTP) GW.SFTP = 22 Dialg Bx Equivalents The ICIDMZGateway interface prperties crrelate t the fllwing fields and cntrls in the EFT administratin interface: 149

150 EFT API Reference ICIDwnladActinParams - Dwnlad Actin Parameters Interface Prperties The ICIDwnladActinParams interface (derived frm ICITransferActinParams defining client peratin parameters) allws yu t make changes t the Event Rule settings. interface ICIDwnladActinParams : ICITransferActinParams Refer t ICITransferActinParams - Transfer Actin Parameters Interface fr details f the methds and prperties. ICIEventActin - Event Actin Interface The ICIEventActin interface allws yu t make changes t the Event Rule Actin settings. interface ICIEventActin : IDispatch "Functin" and "Sub" indicate that the member is a methd; "Prperty" indicates that it is a prperty. Members Functin GetParams() As Object Retrieves the event actin parameters. HRESULT GetParams([ut, retval] IDispatch** ppdispparams); EFT v6.1 and later Sub SetParams(pdispParams As Object) Specifies the event actin parameters. 150

151 Interface Reference HRESULT SetParams([in] IDispatch* pdispparams); EFT v6.1 and later Prperty type As EventActinType read-nly HRESULT Type([ut, retval] EventActinType *pval); Related Tpics EFT v5.2 and later ICIEventActins - Event Actins Interface ICIEventInf - Event Infrmatin Interface ICIEventRuleParams - Event Rule Parameters Interface ICIEventRule - Event Rule Interface ICIEventRules - Event Rules Interface ICIEventRuleStatement - Event Rule Statement Interface ICIEventActins - Event Actins Interface The ICIEventActins interface allws yu t make changes t the Event Rule Actin settings. interface ICIEventActins : IDispatch "Functin" and "Sub" indicate that the member is a methd. Members Functin Add(lIndex As Lng, pdispparams As Object) As Object Adds an event actin at specified psitin. HRESULT Add( [in] lng lindex, [in] IDispatch* pdispparams, [ut, retval] IDispatch** ppdispactin); EFT v5.2 and later Functin Cunt() As Lng Retrieves a number f listed event actins. HRESULT Cunt( [ut, retval] lng* plcunt); EFT v5.2 and later Sub Delete(lIndex As Lng) Deletes event actin by index. HRESULT Delete( [in] lng lindex); EFT v5.2 and later Functin Item(lIndex As Lng) As Object Retrieves r specifies an event actin bject by index. (Refer t ICIEventActin interface.) HRESULT Item( [in] lng lindex, 151

152 EFT API Reference [ut, retval] IDispatch** ppdispactin); Related Tpics EFT v5.2 and later ICIEventActin - Event Actin Interface ICIEventInf - Event Infrmatin Interface ICIEventRuleParams - Event Rule Parameters Interface ICIEventRule - Event Rule Interface ICIEventRules - Event Rules Interface ICIEventRuleStatement - Event Rule Statement Interface ICIEventInf - Event Infrmatin Interface The ICIEventInf interface is used t retrieve infrmatin abut EFT s events. (Als refer t ICIServer::AvailableEvents prperty.) The interface prvides the set f read-nly prperties. interface ICIEventInf : IDispatch Prperties Prperty Name As String read-nly Specifies the name f the event. HRESULT Name([ut, retval] BSTR* pval); MsgBx "Event: " & Event.Name EFT v6.1 and later Prperty type As EventType read-nly Specfies the type f event. HRESULT Type([ut, retval] EventType* pval); If Event.Type = OnTimer Then MsgBx "Event type: Timer" End If Related Tpics EFT v6.1 and later ICIEventActin - Event Actin Interface ICIEventInf - Event Infrmatin Interface ICIEventRuleParams - Event Rule Parameters Interface ICIEventRule - Event Rule Interface ICIEventRules - Event Rules Interface ICIEventRuleStatement - Event Rule Statement Interface 152

153 Interface Reference ICIEventRuleParams - Event Rule Parameters Interface Use the ICIEventRuleParams interface t make changes t the Event Rule Cnditin settings. interface ICIEventRuleParams : IDispatch Members Prperty Descriptin As String Fr an example using this prperty, refer t the EventRuleCreatin script in Script Examples. Retrieves r specifies the descriptin f the Event Rule. HRESULT Descriptin([ut, retval] BSTR *pval); HRESULT Descriptin([in] BSTR newval); Example (C#): bjparams.descriptin = "This is a test event rule"; EFT v5.2 and later Prperty Enabled As Blean Fr an example using this prperty, refer t the EventRuleCreatin script in Script Examples. Retrieves r specifies whether the Event Rule is enabled. HRESULT Enabled([ut, retval] VARIANT_BOOL *pval); HRESULT Enabled([in] VARIANT_BOOL newval); Example (C#): bjparams.enabled = true; EFT v5.2 and later Prperty Name As String Fr an example using this prperty, refer t the EventRuleCreatin script in Script Examples. Retrieves r specifies the name f the Event Rule. HRESULT Name([ut, retval] BSTR *pval); HRESULT Name([in] BSTR newval); Example (C#): bjparams.name = "TestEventRule"; Related Tpics EFT v5.2 and later ICIEventActin - Event Actin Interface ICIEventActins - Event Actins Interface ICIEventInf - Event Infrmatin Interface ICIEventRule - Event Rule Interface ICIEventRules - Event Rules Interface ICIEventRuleStatement - Event Rule Statement Interface ICIEventRule - Event Rule Interface Use the ICIEventRule interface t make changes t the Event Rule settings. 153

154 EFT API Reference interface ICIEventRule : IDispatch Examples (VBScript): 'Add "If File name matches "*.txt" r "*.exe"" cnditin: cnd = Rule.AddIfStatement(0, FileName, Match, Array("*.txt", "*.exe")) Set Params = Rule.GetParams 'rename rule Set Params = Rule.GetParams Params.Name = Params.Name & "_renamed" Rule.SetParams Params "Functin" and "Sub" indicate that the member is a methd. Methds Functin AddActinStatement(lIndex As Lng, pdispparams As Object) As Object Fr an example using this methd, refer t the EventRuleCreatin script in Script Examples. Adds an Actin statement at a specified psitin. HRESULT AddActinStatement( [in] lng lindex, [in] IDispatch* pdispparams, [ut, retval] IDispatch** ppdispactinstatement); Example (C#): rule.addactinstatement(rule.statementscunt(), eventlgactinparams); EFT v5.2 and later Functin AddIfStatement(lIndex As Lng, prperty As EventPrperty, p As CnditinOperatr, varcnditinvalue, bnt As Blean) As Object Adds an If-statement at a specified psitin. HRESULT AddIfStatement( [in] lng lindex, [in] EventPrperty prperty, [in] CnditinOperatr p, [in] VARIANT varcnditinvalue, [in] VARIANT_BOOL bnt, [ut, retval] IDispatch** ppdispifstatement); EFT v5.2 and later Sub DeleteStatement(lIndex As Lng) Delete Event Rule s statement by index. HRESULT DeleteStatement( [in] lng lindex); EFT v5.2 and later Functin GetHASchedulingParams() As Object HRESULT GetHASchedulingParams([ut, retval] IDispatch** ppdisp); EFT v7.0 and later Sub SetHASchedulingParams(newVal As Object) HRESULT SetHASchedulingParams([in] IDispatch* newval); EFT v7.0 and later 154

155 Interface Reference Functin GetParams() As Object Retrieves Event Rule s parameters. The actual bject depends n the Event Rule s type. (Refer t ICIEventRuleParams, ICITimerEventRuleParams, ICIFlderMnitrEventRuleParams interfaces.) HRESULT GetParams( [ut, retval] IDispatch* *pval); EFT v6.2 and later Sub SetParams(newVal As Object) Specifies an Event Rule s parameters. HRESULT SetParams( [in] IDispatch* newval); EFT v6.2 and later Functin Statement(lIndex As Lng) As Object Retrieves a statement bject by index. (Refer t ICIEventRuleStatement interface.) HRESULT Statement( [in] lng lindex, [ut, retval] IDispatch** ppdispstatement); EFT v5.2 and later Functin StatementsCunt() As Lng Fr an example using this methd, refer t the EventRuleCreatin script in Script Examples. Retrieves the number f listed statements. HRESULT StatementsCunt( [ut, retval] lng* plcunt); Example (C#): rule.addactinstatement(rule.statementscunt(), eventlgactinparams); Related Tpics EFT v5.2 and later ICIEventActin - Event Actin Interface ICIEventActins - Event Actins Interface ICIEventInf - Event Infrmatin Interface ICIEventRuleParams - Event Rule Parameters Interface ICIEventRules - Event Rules Interface ICIEventRuleStatement - Event Rule Statement Interface ICIEventRules - Event Rules Interface The ICIEventRules interface allws yu t make changes t the Event Rule settings. interface ICIEventRules : IDispatch "Functin" and "Sub" indicate that the member is a methd. 155

156 EFT API Reference Methds Functin Add(lIndex As Lng, pdispparams As Object) As Object Add an Event Rule at a specified psitin. HRESULT Add( [in]lng lindex, [in] IDispatch* pdispparams, [ut, retval] IDispatch** ppdispnewrule); EFT v5.2 and later Functin Cunt() As Lng Retrieves the number f Event Rules. HRESULT Cunt( [ut, retval] lng* plcunt); EFT v5.2 and later Sub Delete(lIndex As Lng) Deletes an Event Rule by index. HRESULT Delete( [in] lng lindex); EFT v5.2 and later Functin Find(strName As String) As Object Find an Event Rule by name. HRESULT Find( [in] BSTR strname, [ut, retval] IDispatch **ppdisp); EFT v5.2 and later Functin Item(lIndex As Lng) As Object Retrieves r specifies an Event Rule bject by index. (Refer t ICIEventRule interface.) HRESULT Item( [in] lng lindex, [ut, retval] IDispatch **ppdisprule); Related Tpics EFT v5.2 and later ICIEventActin - Event Actin Interface ICIEventActins - Event Actins Interface ICIEventInf - Event Infrmatin Interface ICIEventRuleParams - Event Rule Parameters Interface ICIEventRule - Event Rule Interface ICIEventRuleStatement - Event Rule Statement Interface ICIEventRuleStatement - Event Rule Statement Interface Use the ICIEventRuleStatement interface t make changes t the Event Rule settings. interface ICIEventRuleStatement : IDispatch 156

157 Interface Reference Prperty Prperty type Retrieves the Event Rule Statement type.. HRESULT Type([ut, retval] EventRuleStatementType *pval); EventRuleStatementType ActinStatement = 0 IfStatement = 1 Related Tpics EFT v6.0 and later ICIEventActin - Event Actin Interface ICIEventActins - Event Actins Interface ICIEventInf - Event Infrmatin Interface ICIEventRuleParams - Event Rule Parameters Interface ICIEventRule - Event Rule Interface ICIEventRules - Event Rules Interface ICIFlderMnitrEventRuleParams - Flder Mnitr Event Rule Parameters Interface The ICIFlderMnitrEventRuleParams interface allws yu t make changes t the Event Rule settings. interface ICIFlderMnitrEventRuleParams : ICIEventRuleParams Prperties Prperty AddTimestampTArchivedFileNames As Blean Retrieves r specifies whether t include a timestamp in names f archived files. HRESULT AddTimestampTArchivedDuplicates( [ut, retval] VARIANT_BOOL *pval); HRESULT AddTimestampTArchivedDuplicates( [in] VARIANT_BOOL newval); EFT v6.4 and later Prperty ArchiveLeftvers As Blean Retrieves r specifies whether t archive the file that has triggered the Flder Mnitr Event if the file is present in the mnitred flder after the Event Rule is cmpleted. HRESULT ArchiveLeftvers( [ut, retval] VARIANT_BOOL *pval); HRESULT ArchiveLeftvers( [in] VARIANT_BOOL newval); EFT v6.4 and later Prperty ArchiveSubFlderName As String Retrieves r specifies the name f the subflder int which files are mved during Flder Sweep peratins. If this prperty is null, n pst prcessing is perfrmed. 157

158 EFT API Reference HRESULT ArchiveSubFlderName( [ut, retval] BSTR *pval); HRESULT ArchiveSubFlderName( [in] BSTR newval); (Fr details f using "Flder Sweep" in Event Rules, refer t the EFT dcumentatin.) EFT v6.4 and later Prperty CheckHealth As Blean Retrieves r specifies whether Check health f netwrk share is enabled fr a Flder Mnitr rule. HRESULT CheckHealth([ut, retval] VARIANT_BOOL *pval); HRESULT CheckHealth([in] VARIANT_BOOL newval); EFT v5.2 and later Prperty CheckHealthInterval As Lng Retrieves r specifies hw ften t check the health f the netwrk share if CheckHealth (abve) is enabled. HRESULT CheckHealthInterval([ut, retval] lng *pval); HRESULT CheckHealthInterval([in] lng newval); EFT v5.2 and later Prperty Descriptin As String Descriptin f the event. HRESULT Descriptin([ut, retval] BSTR *pval); HRESULT Descriptin([in] BSTR newval); EFT v5.2 and later Prperty Enabled As Blean Determine whether the Event Rule is enabled. HRESULT Enabled([ut, retval] VARIANT_BOOL *pval); HRESULT Enabled([in] VARIANT_BOOL newval); EFT v5.2 and later Prperty IncludeSubflders As Blean Retrieves r specifies whether t include subflders when mnitring the path. HRESULT IncludeSubflders([ut, retval] VARIANT_BOOL *pval); HRESULT IncludeSubflders([in] VARIANT_BOOL newval); EFT v5.2 and later Prperty Name As String Name f the event. HRESULT Name([ut, retval] BSTR *pval); HRESULT Name([in] BSTR newval); EFT v5.2 and later Prperty Passwrd As String Retrieves r specifies the passwrd used in the Flder Mnitr rule. HRESULT Passwrd( [ut, retval] BSTR *pval); 158

159 Interface Reference [in] BSTR newval); MsgBx CStr(RuleParams.Passwrd) RuleParams.Passwrd = "asd@#!" EFT v6.3.1 and later Prperty Path As String Retrieves r specifies the path t the flder t mnitr. HRESULT Path([ut, retval] BSTR *pval); HRESULT Path([in] BSTR newval); EFT v5.2 and later Prperty PllInterval Retrieves r specifies the plling interval value fr Flder Mnitr rule. HRESULT PllInterval([ut, retval] lng *pval); HRESULT PllInterval([in] lng newval); If EventParams.PllInterval = 0 Then d smething End If set plling interval value t 10 hurs fr FlderMnitr event EventParams.PllIntervalType = 2 hurs EventParams.PllInterval = 10 EFT v6.5 and later Prperty PllIntervalSecnds As Lng Retrieves r specifies pll interval used in the Flder Mnitr rule. HRESULT PllIntervalSecnds( [ut, retval] lng *pval); HRESULT PllIntervalSecnds( [in] lng newval); EFT v6.4 and later Prperty PllIntervalType See als FlderMnitrPllIntervalType enum. Retrieves r specifies the plling interval type fr Flder Mnitr rule. HRESULT PllIntervalType([ut, retval] FlderMnitrPllIntervalType *pval); HRESULT PllIntervalType([in] FlderMnitrPllIntervalType newval); If EventParams.PllIntervalType = 0 Then Secnds 159

160 EFT API Reference End If set plling interval type t hurs fr FlderMnitr event EventParams.PllIntervalType = 2 EFT v6.5 and later Prperty UseAlternateCredentials As Blean Retrieves r specifies whether t use alternate credentials. HRESULT UseAlternateCredentials( [ut, retval] VARIANT_BOOL *pval); [in] VARIANT_BOOL newval); MsgBx CStr(RuleParams.UseAlternateCredentials) RuleParams.UseAlternateCredentials = False EFT v6.3.1 and later Prperty UseFileSystemNtificatins As Blean Retrieves r specifies whether the file system ntificatins must be used when triggering mnitr flder. HRESULT UseFileSystemNtificatins( [ut, retval] VARIANT_BOOL *pval); HRESULT UseFileSystemNtificatins( [in] VARIANT_BOOL newval); EFT v6.4 and later Prperty UseInteractiveLgn As Blean Retrieves r specifies whether the interactive lgn must be used in the mnitr flder rule. HRESULT UseInteractiveLgn( [ut, retval] VARIANT_BOOL *pval); HRESULT UseInteractiveLgn( [in] VARIANT_BOOL newval); TRUE = nt enabled (the Require Active Directry dmain trust relatinship check bx is nt selected) FALSE = enabled (check bx selected). EFT v6.4 and later Prperty UsePeridicDirectryPll As Blean Retrieves r specifies whether peridic directry pll must be used in the Mnitr Flder Rule. HRESULT UsePeridicDirectryPll( [ut, retval] VARIANT_BOOL *pval); HRESULT UsePeridicDirectryPll( [in] VARIANT_BOOL newval); EFT v6.4 and later Prperty Username As String Retrieves r specifies the username used in the Flder Mnitr rule. 160

161 Interface Reference HRESULT Username( [ut, retval] BSTR *pval); [in] BSTR newval); MsgBx CStr(RuleParams.Username) RuleParams.Username = "User" EFT v6.3.1 and later Dialg Bx Equivalents ICIGSAuthManagerSettings - Glbalscape Authenticatin Manager Settings Interface Use the ICIGSAuthManagerSettings interface t edit Glbalscape authenticatin manager settings. See als ICISites - Multi-Site Management. interface ICIGSAuthManagerSettings : IDispatch Prperties Prperty RefreshIntervalMinutes As Lng Retrieves r specifies the user database refresh frequency. HRESULT RefreshIntervalMinutes([ut, retval] LONG* pval); 161

162 EFT API Reference HRESULT RefreshIntervalMinutes([in] LONG newval); Prperty UserDatabasePath As String Retrieves r sets the path t the user database. HRESULT UserDatabasePath([ut, retval] BSTR* pval); HRESULT UserDatabasePath([in] BSTR newval); Dialg Bx Equivalents The ICIGSAuthManagerSettings interface prperties crrelate t the fllwing fields and cntrls in the EFT administratin interface: ICIIfStatement - If Statement Interface The ICIIfStatement interface allws yu t make changes t the Event Rule settings. See als ICIEventRule : AddIfStatement. interface ICIIfStatement : ICIEventRuleStatement Prperties Prperty Cnditin As Object read-nly Retrieves the Cnditin bject. (Refer t ICICmpundCnditin interface.) HRESULT Cnditin( [ut, retval] IDispatch** ppdispcmpundcnditin); EFT v5.2 and later Prperty ElseSectin As Object read-nly Retrieves the Actin statements in Else-sectin. (Refer t ICIActinStatements interface.) HRESULT ElseSectin( [ut, retval] IDispatch** ppdispactinstatements); EFT v5.2 and later Prperty IfSectin As Object read-nly Retrieves the Actin statements in Else-sectin. (Refer t ICIActinStatements interface.) HRESULT IfSectin( [ut, retval] I ICIHighAvailabilityParams Interface The ICIHighAvailabilityParams interface cntains parameters defined fr a high availability deplyment. 162

163 Interface Reference Prperty CherenceQueue As String HRESULT CherenceQueue([ut, retval] BSTR *pval); HRESULT CherenceQueue([in] BSTR newval); Prperty DefaultNdeList Allws yu t specify ne r mre ndes that will execute Event Rules. This list can be verridden in the Event Rules. HRESULT DefaultNdeList([ut, retval] VARIANT *pval); HRESULT DefaultNdeList([in] VARIANT pval); Prperty Enabled As Blean HRESULT Enabled([ut, retval] VARIANT_BOOL *pval); HRESULT Enabled([in] VARIANT_BOOL newval); Prperty EventQueue As String HRESULT EventQueue([ut, retval] BSTR *pval); HRESULT EventQueue([in] BSTR newval); Prperty MulticastAddress As String HRESULT MulticastAddress([ut, retval] BSTR *pval); HRESULT MulticastAddress([in] BSTR newval); Prperty MulticastPrtAs Lng HRESULT MulticastPrt([ut, retval] lng *pval); HRESULT MulticastPrt([in] lng newval); Prperty SharedCnfiguratinPath As String HRESULT SharedCnfiguratinPath([ut, retval] BSTR* pval); HRESULT SharedCnfiguratinPath([in] BSTR newval); ICILDAPAuthManagerSettings - LDAP Authenticatin Manager Settings Interface The LDAP Authenticatin Manager Settings interface members are listed belw. See als ICISites - Multi- Site Management. interface ICILDAPAuthManagerSettings : IDispatch Fr an example using these prperties, refer t the Windws Authenticatin script in Script Examples. Members Prperty AdditinalUserSettingsPath As String Retrieves r specifies the path t the user database. HRESULT AdditinalUserSettingsPath([ut, retval] BSTR* pval); HRESULT AdditinalUserSettingsPath([in] BSTR newval); Prperty BaseDN As String Retrieves r specifies the BaseDN. HRESULT BaseDN([ut, retval] BSTR* pval); HRESULT BaseDN([in] BSTR newval); 163

164 EFT API Reference Prperty ChaseReferrals As Blean Retrieves r specifies whether t enable chase referrals. HRESULT ChaseReferrals([ut, retval] VARIANT_BOOL* pval); HRESULT ChaseReferrals([in] VARIANT_BOOL newval); Prperty LDAPVersin As LDAPVersin Retrieves r specifies the LDAP versin. HRESULT LDAPVersin([ut, retval] LDAPVersin* pval); HRESULT LDAPVersin([in] LDAPVersin newval); Prperty LginAttribute As String Retrieves r specifies the lgin attribute. HRESULT LginAttribute([ut, retval] BSTR* pval); HRESULT LginAttribute([in] BSTR newval); Prperty PageSizeEntries As Lng Retrieves r specifies the search page size. HRESULT PageSizeEntries([ut, retval] LONG* pval); HRESULT PageSizeEntries([in] LONG newval); Prperty Prt As Lng Retrieves r specifies the LDAP server prt. HRESULT Prt([ut, retval] LONG* pval); HRESULT Prt([in] LONG newval); Prperty RefreshIntervalMinutes As Lng Retrieves r specifies hw ften t refresh the user database. HRESULT RefreshIntervalMinutes([ut, retval] LONG* pval); HRESULT RefreshIntervalMinutes([in] LONG newval); Prperty SearchAttributes As String Retrieves r specifies the search attributes. HRESULT SearchAttributes([ut, retval] BSTR* pval); HRESULT SearchAttributes([in] BSTR newval); Prperty SearchScpe As LDAPSearchScpe Retrieves r specifies the search scpe. HRESULT SearchScpe([ut, retval] LDAPSearchScpe* pval); HRESULT SearchScpe([in] LDAPSearchScpe newval); 164

165 Interface Reference Prperty Server As String Retrieves r specifies the LDAP server hst name. HRESULT Server([ut, retval] BSTR* pval); HRESULT Server([in] BSTR newval); Prperty ServerPasswrd As String Retrieves r specifies the passwrd fr Simple authenticatin. HRESULT ServerPasswrd([ut, retval] BSTR* pval); HRESULT ServerPasswrd([in] BSTR newval); Prperty ServerUserName As String Retrieves r specifies the username fr Simple authenticatin. HRESULT ServerUserName([ut, retval] BSTR* pval); HRESULT ServerUserName([in] BSTR newval); Prperty TimeutSecnds As Lng Retrieves r specifies the timeut in secnds. HRESULT TimeutSecnds([ut, retval] LONG* pval); HRESULT TimeutSecnds([in] LONG newval); Prperty UsePageCntrl As Blean Retrieves r specifies whether t cntrl the search page size. HRESULT UsePageCntrl([ut, retval] VARIANT_BOOL* pval); HRESULT UsePageCntrl([in] VARIANT_BOOL newval); Prperty UserFilter As String Retrieves r specifies the user filter. HRESULT UserFilter([ut, retval] BSTR* pval); HRESULT UserFilter([in] BSTR newval); Prperty UseSSL As Blean Retrieves r specifies whether t use SSL fr LDAP authenticatin. HRESULT UseSSL([ut, retval] VARIANT_BOOL* pval); HRESULT UseSSL([in] VARIANT_BOOL newval); Dialg Bx Equivalents The ICILDAPAuthManagerSettings interface prperties crrelate t the fllwing fields and cntrls in the EFT administratin interface: 165

166 EFT API Reference ICIMailActinParams - Mail Actin Parameters Interface Yu can create an ntificatin actin fr Event Rule and AS2 Transactin success/failure ntificatins. On Sites using AD Authenticatin, EFT must have "Lg On as a dmain user" permissin in rder fr ntificatins t wrk. The ICIMailActinParams interface allws yu t make changes t the MailActin settings. Access the ICIMailActinParams interface with ICIEventActin when its EventActinType prperty returns MailActin. interface ICIMailActinParams : IDispatch Example: If actin.type = 2 then 'MailActin Set mailparams = actin.params EndIf VB script example: 166

167 Interface Reference 'Add Mail actin t the cnditinal statement's IF sectin Set IfEventActinParams = CreateObject("SFTPCOMInterface.CIBackupActinParams") IfEventActinParams.TOAddresses = fbar@cm;" IfEventActinParams.Subject = "Subj" IfEventActinParams.Template = "<b>text</b>" Set pmailactin = pifstatement.ifsectin.add(0, MailActin, IfEventActinParams) Prperties Prperty BCCAddresses As String Retrieves r specifies BCC addresses. HRESULT BCCAddresses([ut, retval] BSTR *pval); HRESULT BCCAddresses([in] BSTR newval); mailparams.bccaddresses = "rb@glbalscape.cm;f@bar.cm;" EFT v5.2 and later Prperty Bdy As String Fr an example using this prperty, refer t the EventRuleCreatin script in Script Examples. Retrieves r specifies the bdy f the message. HRESULT Bdy([ut, retval] BSTR *pval); HRESULT Bdy([in] BSTR newval); mailparams.bdy = "<HTML>This message was sent t yu autmatically by the GlbalSCAPE EFT</HTML>" Example (C#): mail.bdy = "Test "; EFT v5.2 and later Prperty CCAddresses As String Retrieves r specifies CC addresses. HRESULT CCAddresses([ut, retval] BSTR *pval); HRESULT CCAddresses([in] BSTR newval); mailparams.ccaddresses = "rb@glbalscape.cm;f@bar.cm;" EFT v5.2 and later Prperty CpyTClient As Blean Retrieves r specifies whether t send a cpy t the sender. HRESULT CpyTClient([ut, retval] VARIANT_BOOL *pval); HRESULT CpyTClient([in] VARIANT_BOOL newval); mailparams. CpyTClient = True EFT v5.2 and later Prperty CustmFrmAddress As String Retrieves r specifies custm a FROM address. (See UseCustmFrmAddress belw.) 167

168 EFT API Reference HRESULT CustmFrmAddress([ut, retval] BSTR *pval); HRESULT CustmFrmAddress([in] BSTR newval); FROMAddr = Server.SMTPSenderAddr 'default If MailParams.UseCustmFrmAddress Then FROMAddr = MailParams.CustmFrmAddress End If MailParams.UseCustmFrmAddress = True MailParams.CustmFrmAddress = "custm_ @smtpserver.rg" EFT v6.1 and later Prperty Subject As String Fr an example using this prperty, refer t the EventRuleCreatin script in Script Examples. Retrieves r specifies the subject line f the message. HRESULT Subject([ut, retval] BSTR *pval); HRESULT Subject([in] BSTR newval); mailparams.subject = "Imprtant! Need t talk" Example (C#): mail.subject = "Test"; EFT v5.2 and later Prperty TOAddresses As String Fr an example using this prperty, refer t the EventRuleCreatin script in Script Examples. Retrieves r specifies the TO addresses. HRESULT TOAddresses([ut, retval] BSTR *pval); HRESULT TOAddresses([in] BSTR newval); mailparams.toaddresses = "rb@glbalscape.cm;f@bar.cm;" Example (C#): mail.toaddresses = "yur @yurdmain.cm"; EFT v5.2 and later Prperty UseCustmFrmAddress As Blean Retrieves r specifies whether t use a custm FROM address. (See CustmFrmAddress abve.) HRESULT UseCustmFrmAddress([ut, retval] VARIANT_BOOL *pval); HRESULT UseCustmFrmAddress([in] VARIANT_BOOL newval); FROMAddr = Server.SMTPSenderAddr 'default If MailParams.UseCustmFrmAddress Then FROMAddr = MailParams.CustmFrmAddress 168

169 Interface Reference End If MailParams.UseCustmFrmAddress = False EFT v6.1 and later ICIManualIPAccessRule Interface The ICIManualIPAccessRule interface represents an IP address access rule that was added manually. rules = Server.GetIPAccessRules() Fr Each key In rules If key.type = 0 Then WScript.ech "AutBan" End if If key.type = 1 Then WScript.ech "Manual " + key.address WScript.ech "Added " + key.added WScript.ech "Allw " + key.allw End if Next Members Prperty Allw As Blean (read-nly) Retrieves whether the IP access rule is a permissin r ban. HRESULT Allw( [ut, retval] VARIANT_BOOL* pballw); EFT v6.3.0 and later Prperty Address As String (read-nly) Retrieves the IP address. HRESULT Address( [ut, retval] BSTR* pbzaddress); EFT v6.3.0 and later Prperty Added As Date (read-nly) Retrieves the date when the IP access rule was added. HRESULT Added( [ut, retval] DATE* pdadded); EFT v6.3.0 and later Prperty type As IPAccessRuleType (read-nly) Retrieves the type f the rule. HRESULT type( [ut, retval] IPAccessRuleType* pval); EFT v6.3.0 and later 169

170 EFT API Reference Related Tpics ICIAutbanIPAccessRule - Prvides the Autban IP access rule BannedIPs prperty ICIBannedIP - Represents an entry in an IP address autban list ICIClientSettings ICIServer ICISite AddIPAccessRule - Adds allwed (true) r denied (false) IP mask fr the client GetIPAccessRules - Retrieves an array f client/template IP Access rules GetLimitAccessByIP - Determines if the IP Access Restrictin List is enabled n the Settings Template r user accunt IPAccessAllwedDefault - Set r retrieve whether user r Settings Template IP access settings allw r deny access by default (if n rule match) MveIPAccessRule - Change allwed IP access rule psitin AddIPAccessRule - Adds allwed r denied IP mask fr administratin GetAdminIPs - Retrieve an array f IP addresses fr the cmputer n which the Server is running GetIPAccessRules - Retrieve an array f administratin IP address access rules GetLcalIP - Given an index, retrieves a Lcal IP address IPAccessAllwedDefault - Retrieve r specify the default IP Access restrictin list ListenIP - Retrieve r specify the server's IP address ListenIPs - Retrieve r specify the IP addresses n which the server listens MveIPAccessRule - Change allwed administratin IP access rule psitin. RemveIPAccessRule - Remve allwed r denied IP mask fr administratin UnbanIP - Remve denied IP mask frm Autban list fr administratin AddIPAccessRule - Adds allwed r denied IP mask fr the Site AutBanIPsPermanently - Retrieve r specify whether t autmatically ban IP addresses permanently BanIPFrInvalidLginAttempts - Retrieve r specify whether t ban an IP address after excessive invalid lgin attempts with existing username and wrng passwrd. BanIPFrInvalidLginAttemptsWithExistingUsername - When banning an IP address fr invalid lgin attempts, specify whether t cunt incrrect username and crrect username + incrrect passwrd r nly incrrect username attempts. BanIPOnDOS - Retrieve r specify whether t ban an IP address after excessive invalid cmmands GetIP - Retrieves the index f the Site Listen IP GetIPAccessRules - Retrieves an array f allwed IP masks. IPAccessAllwedDefault - Retrieve r specify whether IP access is allwed by default ListenIPs - Retrieve r specify the IP addresses n which the Site listens MveIPAccessRule - Change allwed r denied IP mask psitin fr the Site 170

171 Interface Reference RemveIPAccessRule - Remve allwed r denied IP mask fr the Site SetIP - Changes the index f Listen IP UnbanIP - Remves denied IP mask frm the Autban list fr the Site IPAccessRuleType enum ICINewUserData Interface The ICINewUserData used with the ICISite CreateUserEx2 prperty t create a new user accunt and include all f the user details. Prperties Prperty CreateHmeFlder Specifies whether the accunt's hme flder is the default rt flder. HRESULT CreateHmeFlder([ut, retval] VARIANT_BOOL *pval); HRESULT CreateHmeFlder([in] VARIANT_BOOL newval); EFT v6.3.8 and later Prperty Descriptin Specifies the accunt descriptin. HRESULT Descriptin([ut, retval] BSTR *pval); HRESULT Descriptin([in] BSTR newval); EFT v6.3.8 and later Prperty Specifies the address f the accunt. HRESULT ([ut, retval] BSTR *pval); HRESULT ([in] BSTR newval); EFT v6.3.8 and later Prperty FullName Specifies the full name f the user. HRESULT FullName([ut, retval] BSTR *pval); HRESULT FullName([in] BSTR newval); EFT v6.3.8 and later Prperty FullPermissinsFrHmeFlder Specifies whether the user has FULL permissins in the hme flder. HRESULT FullPermissinsFrHmeFlder([ut, retval] VARIANT_BOOL *pval); HRESULT FullPermissinsFrHmeFlder([in] VARIANT_BOOL newval); EFT v6.3.8 and later Prperty Lgin Specifies the accunt username. HRESULT Lgin([ut, retval] BSTR *pval); HRESULT Lgin([in] BSTR newval); EFT v6.3.8 and later Prperty Passwrd 171

172 EFT API Reference Specifies the accunt passwrd. HRESULT Passwrd([ut, retval] BSTR *pval); HRESULT Passwrd([in] BSTR newval); EFT v6.3.8 and later Prperty PasswrdType Specifies the passwrd type: Standard - A plain text passwrd is required. Annymus - Any passwrd, including nthing, allws an annymus cnnectin. Annymus (Frce ) - Any well-frmed address is the passwrd OTP S/KEY MD4 - Used fr lgging in t an OTP-enabled server. OTP S/KEY MD5 - Used fr lgging in t an OTP-enabled server. HRESULT PasswrdType([ut, retval] lng *pval); HRESULT PasswrdType([in] lng newval); EFT v6.3.8 and later Prperty SettingsLevel Specifies the Settings Level t which this accunt belngs. HRESULT SettingsLevel([ut, retval] BSTR *pval); HRESULT SettingsLevel([in] BSTR newval); EFT v6.3.8 and later Prperty TwFactrAuthenticatin Specifies whether RADIUS/RSA is enabled, disabled, r inherited. HRESULT TwFactrAuthenticatin([ut, retval] SFTPAdvBl *pval); HRESULT TwFactrAuthenticatin([in] SFTPAdvBl newval); EFT v6.3.8 and later ICIODBCAuthManagerSettings - ODBC Authenticatin Manager Settings Interface The ODBC Authenticatin Manager Settings interface members are listed belw. See als ICISites - Multi-Site Management. interface ICIODBCAuthManagerSettings : IDispatch{ Fr an example using these prperties, refer t the ODBC Authenticatin script in Script Examples. Prperties Prperty RefreshIntervalMinutes As Lng Retrieves r specifies hw ften t refresh the user database. HRESULT RefreshIntervalMinutes([ut, retval] LONG* pval); HRESULT RefreshIntervalMinutes([in] LONG newval); EFT Server v6.3 and later Prperty UserDatabaseCnnectinString As String Retrieves r specifies the string used t cnnect t the user database. 172

173 Interface Reference HRESULT UserDatabaseCnnectinString([ut, retval] BSTR* pval); HRESULT UserDatabaseCnnectinString([in] BSTR newval); EFT Server v6.3 and later Dialg Bx Equivalents The ICIODBCAuthManagerSettings interface prperties crrelate t the fllwing fields and cntrls in the EFT administratin interface: ICIPermissin - Permissin Interface The VFS permissins can be viewed/set in the administratin interface n the VFS tab. The ICIPermissin interface represents the permissins fr flders. Obtain it by using the GetFlderPermissins methd f the ICISite interface. Yu can als use the GetBlankPermissin methd t start with n permissins. Changing prperties in the IPermissin interface has n effect until yu call the ICISite::SetPermissin methd. Refer t the ICISite::SetPermissin methd fr an example. interface IPermissin : IDispatch Example: aperm = s.getflderpermissins("\pub\") Set p = s.getblankpermissin("\pub\", "Administrative") Prperties Prperty Client As String read-nly Retrieves the client name. HRESULT Client([ut, retval] BSTR *pval); All versins Prperty DirCreate As Blean Retrieves r specifies whether the accunt has "create directry" permissin. HRESULT DirCreate([ut, retval] VARIANT_BOOL *pval); HRESULT DirCreate([in] VARIANT_BOOL newval); True = Allwed; False = Prhibited All versins Prperty DirDelete As Blean Retrieves r specifies whether the accunt has "delete directry" permissin. HRESULT DirDelete([ut, retval] VARIANT_BOOL *pval); HRESULT DirDelete([in] VARIANT_BOOL newval); 173

174 EFT API Reference True = Allwed; False = Prhibited All versins Prperty DirList As Blean Retrieves r specifies whether the accunt has "directry list" permissin. HRESULT DirList([ut, retval] VARIANT_BOOL *pval); HRESULT DirList([in] VARIANT_BOOL newval); True = Allwed; False = Prhibited All versins Prperty DirShwHidden As Blean Retrieves r specifies whether the accunt has "shw hidden directry" permissin. HRESULT DirShwHidden([ut, retval] VARIANT_BOOL *pval); HRESULT DirShwHidden([in] VARIANT_BOOL newval); True = Displayed; False = Hidden Yu must allw flder listing (DirList) befre yu can chse t hide r display hidden files. All versins Prperty DirShwInList As Blean Retrieves r specifies whether the accunt has "shw directry in list" permissin. HRESULT DirShwInList([ut, retval] VARIANT_BOOL *pval); HRESULT DirShwInList([in] VARIANT_BOOL newval); True = Displayed; False = Hidden Yu must allw flder listing (DirList) befre yu can chse t hide r display read-nly files. All versins Prperty DirShwReadOnly As Blean Retrieves r specifies whether the accunt has "shw read nly" directry permissin. HRESULT DirShwReadOnly([ut, retval] VARIANT_BOOL *pval); HRESULT DirShwReadOnly([in] VARIANT_BOOL newval); True = Displayed; False = Hidden Yu must allw flder listing (DirList) befre yu can chse t hide r display read-nly files. All versins Prperty FileAppend As Blean Retrieves r specifies whether the accunt has "append file" permissin. HRESULT FileAppend([ut, retval] VARIANT_BOOL *pval); HRESULT FileAppend([in] VARIANT_BOOL newval); True = Allwed; False = Prhibited All versins Prperty FileDelete As Blean Retrieves r specifies whether the accunt has "delete file" permissin. HRESULT FileDelete([ut, retval] VARIANT_BOOL *pval); HRESULT FileDelete([in] VARIANT_BOOL newval); True = Allwed; False = Prhibited 174

175 Interface Reference All versins Prperty FileDwnlad As Blean Retrieves r specifies whether the accunt has "dwnlad file" permissin. HRESULT FileDwnlad([ut, retval] VARIANT_BOOL *pval); HRESULT FileDwnlad([in] VARIANT_BOOL newval); True = Allwed; False = Prhibited All versins Prperty FileRename As Blean Retrieves r specifies whether the accunt has "rename file" permissin. HRESULT FileRename([ut, retval] VARIANT_BOOL *pval); HRESULT FileRename([in] VARIANT_BOOL newval); True = Allwed; False = Prhibited All versins Prperty FileUplad As Blean Retrieves r specifies whether the accunt has "uplad file" permissin. HRESULT FileUplad([ut, retval] VARIANT_BOOL *pval); HRESULT FileUplad([in] VARIANT_BOOL newval); True = Allwed; False = Prhibited All versins Prperty Flder As String read-nly Retrieves the flder name. HRESULT Flder([ut, retval] BSTR *pval); All versins Prperty InheritedFrm As String read-nly Retrieves Settings Template r Site inherited frm. If this permissins isn t inherited, then InheritedFrm = Flder. HRESULT InheritedFrm([ut, retval] BSTR *pval); MsgBx "Flder: " & Perm.Flder & " inherited permissin frm: " & Perm.InheritedFrm Prperty IsGrup As Blean read-nly Retrieves TRUE if this is a grup permissin. HRESULT IsGrup([ut, retval] VARIANT_BOOL* pval); MsgBx "Is permissin grup: " & CStr(Perm.IsGrup) Prperty IsInherited As Blean read-nly Retrieves TRUE if it is inherited. 175

176 EFT API Reference HRESULT IsInherited([ut, retval] VARIANT_BOOL* pval); MsgBx "Is inherited: " & CStr(Perm.IsInherited) Dialg Bx Equivalents The illustratin belw is labeled with the methds that are available in the Permissin interface. Difference between DirList and DirShwInList Permissin Within the VFS system, the DirList file permissin and the DirShwInList flder permissin can cnfuse users as t the intended peratin f the server. At first glance, it wuld appear that DirList refers t the ability t see files in the directry and DirShwInList wuld refer t the ability t see flders in the directry, but this is incrrect. The DirList file permissin refers t the user s ability t retrieve a directry listing frm the Server. If this ptin is enabled, the user is able t see a list f files in the directry. If it is disabled, n files r directries will be visible. The DirShwInList permissin is a bit mre cmplex in that the permissin crrespnds t whether r nt the directry will shw up when a directry listing is retrieved in the parent directry. The interactin between inheritance and this setting can therefre lead t a bit f cnfusin. Let s use the fllwing flder structure as an example: 176

177 Interface Reference If yu select the flder Alex and disable the DirShwInList permissin fr flder Jane, then when user Jane navigates t the /Usr/ directry and retrieves a directry listing, the flder Alex will NOT appear in her directry listing. T cmplicate matters, hwever, Jane still has access t the flder and if smene tells her t manually navigate t that flder she will still be able t perfrm actins within the Alex flder (prvided she has apprpriate permissins). In this scenari, by default, when user Jane retrieves a directry listing frm within the flder Alex, she will nly see a list f files in the flder; she will nt see any subflders in the flder. Why? Because the subflders (incming, utging, and shared) have all inherited the disabled DirShwInList setting! Summary: The DirList permissin applies t bth files and flders in the current flder. The DirShwInList permissin applies t the visibility f the current flder in its parent directry. Default inheritance rules will nt allw the display f subflders f a DirShwInList-disabled flder. ICIPgpActinParams - OpenPGP Actin Interface The ICIPgpActinParams interface allws yu t make changes t the OpenPGP Event Actin settings. Access the ICIPgpActinParams interface with the ICIEventActin Params prperty (when its Type prperty returns PGPActin). interface ICIPgpActinParams : IDispatch Example: If actin.type = 32 then PGPActin Set pgpparams = actin.params EndIf Prperties Prperty ASCIIArmredOutput As Blean Retrieves r specifies whether ASCII Armred Output is specified. HRESULT ASCIIArmredOutput([ut, retval] VARIANT_BOOL* pval); HRESULT ASCIIArmredOutput([in] VARIANT_BOOL newval); EFT v6.1 and later Prperty CmpressinLevel As PGPCmpressinLevel Retrieves r specifies the PGP cmpressin level. HRESULT CmpressinLevel([ut, retval] PGPCmpressinLevel* pval); HRESULT CmpressinLevel([in] PGPCmpressinLevel newval); EFT v6.1 and later Prperty FilePath As String 177

178 EFT API Reference Retrieves r specifies the file path. HRESULT FilePath([ut, retval] BSTR *pval); HRESULT FilePath([in] BSTR newval); EFT v5.2 and later Prperty KeyIDs As Variant Retrieves r specifies an array f key IDs. HRESULT KeyIDs([ut, retval] VARIANT *pval); HRESULT KeyIDs([in] VARIANT newval); EFT v5.2 and later Prperty Operatin As PGPOperatin Retrieves r specifies the PGP peratin. HRESULT Operatin([ut, retval] PGPOperatin *pval); HRESULT Operatin([in] PGPOperatin newval); EFT v5.2 and later Prperty PassPhrase As String Retrieves r specifies the passphrase. HRESULT Passphrase([ut, retval] BSTR *pval); HRESULT Passphrase([in] BSTR newval); EFT v5.2 and later Prperty SDAPasswrd As String Retrieves r specifies the SDA passwrd. HRESULT SDAPasswrd([ut, retval] BSTR *pval); HRESULT SDAPasswrd([in] BSTR newval); EFT v6.1 and later Prperty SignatureInSeparateFile As Blean Retrieves r specifies whether a signature in a separate file is specified. HRESULT SignatureInSeparateFile([ut, retval] VARIANT_BOOL* pval); HRESULT SignatureInSeparateFile([in] VARIANT_BOOL newval); EFT v6.1 and later Prperty SigningHash As PGPSigningHash Retrieves r specifies the PGP signing hash. HRESULT SigningHash([ut, retval] PGPSigningHash* pval); HRESULT SigningHash([in] PGPSigningHash newval); EFT v6.1 and later Prperty SignKeyID As String Retrieves r specifies the signing key ID. HRESULT SignKeyID([ut, retval] BSTR *pval); HRESULT SignKeyID([in] BSTR newval); EFT v5.2 and later 178

179 Interface Reference Dialg Bx Equivalents The dialg bx belw is labeled with the parameters that are available in the interface. ICIPGPKeyInf - OpenPGP Key Infrmatin Interface Use the ICIPGPKeyInf interface t retrieve infrmatin abut EFT s PGP keys. Yu cannt create r cnfigure PGP keys with this interface. interface ICIPGPKeyInf : IDispatch (T make changes t the OpenPGP Event Actin settings, refer t ICIPgpActinParams - OpenPGP Actin Interface. See als the ICIServer::AvailablePGPKeys prperty). Prperties Prperty CreatinDate As Date read-nly Retrieves the date the key was created. HRESULT CreatinDate([ut, retval] DATE* pval); EFT v6.1 and later Prperty Descriptin As String read-nly Retrieves the descriptin f the key. HRESULT Descriptin([ut, retval] BSTR* pval); EFT v6.1 and later Prperty ExpiratinDate As Date read-nly Retrieves the expiratin date f the key. 179

180 EFT API Reference HRESULT ExpiratinDate([ut, retval] DATE* pval); EFT v6.1 and later Prperty ID As String read-nly Retrieves the ID f the key. HRESULT ID([ut, retval] BSTR* pval); EFT v6.1 and later Prperty Name As String read-nly Retrieves the name f the key. HRESULT Name([ut, retval] BSTR* pval); EFT v6.1 and later Prperty NeverExpires As Blean read-nly Retrieves whether the key never expires. HRESULT NeverExpires([ut, retval] VARIANT_BOOL* pval); EFT v6.1 and later Prperty Private As Blean read-nly Retrieves whether the key is a private key. HRESULT Private([ut, retval] VARIANT_BOOL* pval); EFT v6.1 and later Prperty Size As Lng read-nly Retrieves the size f the key. HRESULT Size([ut, retval] lng* pval); EFT v6.1 and later Dialg Bx Equivalents The dialg bx belw is labeled with the parameters that are available in the interface. 180

181 Interface Reference ICIReprtActinParams - Reprt Actin Parameters Interface The ICIReprtActinParams interface allws yu t make changes t reprt actins in Event Rules. interface ICIReprtActinParams : IDispatch Prperties Prperty CustmDate As PredefinedReprtPerid Retrieves r specifies a predefined reprt perid. HRESULT CustmDate([ut, retval] PredefinedReprtPerid *pval); HRESULT CustmDate([in] PredefinedReprtPerid newval); Example: If ReprtParams.CustmDate = AllDates Then MsgBx "All-time reprt will be generated" End If ReprtParams.CustmDate = Last12Mnths EFT v5.2 and later Prperty DateFrmat As ReprtPeridType Retrieves r specifies the reprt perid (predefined r a FROM-TO range). HRESULT DateFrmat([ut, retval] ReprtPeridType *pval); HRESULT DateFrmat([in] ReprtPeridType newval); Example: If ReprtParams.DateFrmat = Predefined Then MsgBx "Predefined reprt range is used" End If 181

182 EFT API Reference ReprtParams.DateFrmat = Range EFT v5.2 and later Prperty FilterAndOr As ReprtFiltersCmbiningOperatr Retrieves r specifies a filter. HRESULT FilterAndOr([ut, retval] ReprtFiltersCmbiningOperatr *pval); HRESULT FilterAndOr([in] ReprtFiltersCmbiningOperatr newval); Example: If ReprtParams.FilterAndOr = NCmbining Then MsgBx "Please specify an peratr t cmbine reprt filters." End If ReprtParams.FilterAndOr = AndCmbining EFT v5.2 and later Prperty FilterField1 As String Retrieves r specifies a filter. HRESULT FilterField1([ut, retval] BSTR *pval); HRESULT FilterField1([in] BSTR newval); EFT v5.2 and later Prperty FilterField2 As String Retrieves r specifies a filter. HRESULT FilterField2([ut, retval] BSTR *pval); HRESULT FilterField2([in] BSTR newval); EFT v5.2 and later Prperty FilterOperatr1 As ReprtFilterOperatr Retrieves r specifies a filter peratr. HRESULT FilterOperatr1([ut, retval] ReprtFilterOperatr *pval); HRESULT FilterOperatr1([in] ReprtFilterOperatr newval); Example: If ReprtParams.FilterOperatr1 = NFilter Then MsgBx "Please specify a filter fr the reprt." End If ReprtParams.FilterOperatr2 = CntainsFilter EFT v5.2 and later Prperty FilterOperatr2 As ReprtFilterOperatr Retrieves r specifies a filter peratr. HRESULT FilterOperatr2([ut, retval] ReprtFilterOperatr *pval); HRESULT FilterOperatr2([in] ReprtFilterOperatr newval); 182

183 Interface Reference EFT v5.2 and later Prperty FilterValue1 As String Retrieves r specifies a filter value. HRESULT FilterValue1([ut, retval] BSTR *pval); HRESULT FilterValue1([in] BSTR newval); EFT v5.2 and later Prperty FilterValue2 As String Retrieves r specifies a filter value. HRESULT FilterValue2([ut, retval] BSTR *pval); HRESULT FilterValue2([in] BSTR newval); EFT v5.2 and later Prperty FrmDate As Variant Retrieves r specifies the FROM date fr the reprt. HRESULT FrmDate([ut, retval] VARIANT *pval); HRESULT FrmDate([in] VARIANT newval); EFT v5.2 and later Prperty OptinalParameters As String Retrieves r specifies ptinal parameters used t generate the reprt. HRESULT OptinalParameters([ut, retval] BSTR *pval); HRESULT OptinalParameters([in] BSTR newval); EFT v5.2 and later Prperty Reprt As Object Retrieves r specifies a reprt. HRESULT Reprt([ut, retval] IDispatch** pval); HRESULT Reprt([in] IDispatch* newval); EFT v6.1 and later Prperty ReprtFileFrmat As ReprtFrmat Retrieves r specifies the reprt frmat. HRESULT ReprtFileFrmat([ut, retval] ReprtFrmat *pval); HRESULT ReprtFileFrmat([in] ReprtFrmat newval); Example: If ReprtParams.ReprtFileFrmat = HTMLFrmat Then MsgBx "Reprt will be generated in HTML frmat" End If ReprtParams.ReprtFileFrmat = PDFFrmat EFT v5.2 and later Prperty TDate As Variant Retrieves r specifies the date fr the reprt. HRESULT TDate([ut, retval] VARIANT *pval); 183

184 EFT API Reference HRESULT TDate([in] VARIANT newval); EFT v5.2 and later Dialg Bx Equivalents ICIReprtInf - Reprt Infrmatin Interface ICIReprtInf interface is used t retrieve infrmatin abut EFT s reprts. (Als refer t ICIServer::AvailableReprts prperty). The interface prvides the set f read-nly prperties. The Name and DefinitinPath prperties tgether allw yu t identify the reprt amng ther reprts. (Nte that ne definitin file can cntain definitins f multiple reprts and the same reprt name can be used fr different reprts in different definitin files.) interface ICIReprtInf : IDispatch MsgBx "Reprt: " & Reprt.Name & "(" & Reprt.DefinitinPath & ")" Prperties Prperty DefinitinPath As String read-nly Retrieves the path t the reprt definitin file. HRESULT DefinitinPath([ut, retval] BSTR* pval); EFT Server v6.1 and later Prperty Name As String read-nly Retrieves the name f the reprt. HRESULT Name([ut, retval] BSTR* pval); EFT Server v6.1 and later ICIResetPasswrdSettings - Reset Passwrd Settings Interface Use the ICIResetPasswrdSettings interface t cnfigure passwrd reset details. (Use ICISite::GetResetPasswrdSettings and ICISite::SetResetPasswrdSettings t retrieve and set the passwrd settings fr a Site.) interface ICIResetPasswrdSettings : IDispatch { See als see ICISite::GetResetPasswrdSettings, ICISite::SetResetPasswrdSettings; ICIClientSettings::GetResetPasswrdSettings, ICIClientSettings::SetResetPasswrdSettings. Prperties Prperty DaysPrirPasswrdExpiratinTRemindUser As Lng 184

185 Interface Reference Fr an example using this prperty, refer t the GetCertInf script in Script Examples. Retrieves r specifies the number f days prir t expiratin t ntify the user. If "0" is specified, n ntificatin is sent. (Equivalent t the check bx in the dialg bx nt being selected.) HRESULT DaysPrirPasswrdExpiratinTRemindUser([ut,retval] LONG* pval); HRESULT DaysPrirPasswrdExpiratinTRemindUser([in] LONG newval); MsgBx "Remind befre expiratin: " & CStr(RPS.DaysPrirPasswrdExpiratinTRemindUser) RPS.DaysPrirPasswrdExpiratinTRemindUser = 3 Prperty MaxPasswrdAgeDays As Lng Fr an example using this prperty, refer t the GetCertInf script in Script Examples. Retrieves r specifies the number f days at which t expire the passwrd. If "0" is specified, the passwrd des nt expire. (Equivalent t the check bx in the dialg bx nt being selected.) HRESULT MaxPasswrdAgeDays([ut,retval] LONG* pval); HRESULT MaxPasswrdAgeDays([in] LONG newval); MsgBx "Max passwrd age is: " & CStr(RPS.MaxPasswrdAgeDays) RPS.MaxPasswrdAgeDays = 100 Prperty Send BefreExpiratin As Blean Fr an example using this prperty, refer t the GetCertInf script in Script Examples. Retrieves r specifies whether t send an ntificatin befre the passwrd expires. HRESULT Send BefreExpiratin([ut,retval] VARIANT_BOOL* pval); HRESULT Send BefreExpiratin([in] VARIANT_BOOL newval); MsgBx "Send befre expiratin: " & CStr(RPS.Send BefreExpiratin) RPS.Send BefreExpiratin = False Prperty Send UpnExpiratin As Blean Fr an example using this prperty, refer t the GetCertInf script in Script Examples. Retrieves r specifies whether t send an when the passwrd expires. HRESULT Send UpnExpiratin([ut,retval] VARIANT_BOOL* pval); HRESULT Send UpnExpiratin([in] VARIANT_BOOL newval); 185

186 EFT API Reference MsgBx "Send n expiratin: " & CStr(RPS.Send UpnExpiratin) RPS.Send UpnExpiratin = False Dialg Bx Equivalents The ICIResetPasswrdSettings interface prperties crrelate t the fllwing fields and cntrls in the EFT administratin interface: ICIRundRbinEventRuleSchedulingParams Interface The ICIRundRbinEventRuleSchedulingParams interface prvides the methds and prperties used fr scheduling the "rund rbin" prcess fr Event Rules in a high availability, active-active cluster. Sub Add(newVal As String) HRESULT Add([in] BSTR newval); Functin Cunt() As Lng HRESULT Cunt([ut, retval] lng* plcunt); Sub Delete(lIndex As Lng) HRESULT Delete([in] lng lindex); Functin Item(lIndex As Lng) As String HRESULT Item([in] lng lindex, [ut, retval] BSTR *pval); ISATMessage This interface is used as an input parameter t ICIAudit t lg ad hc transfer activity. This is cnceptually equivalent t the parameter list used in ICIAudit::AuditSATTransactin. Prperties Prperty Bdy As String Retrieves r specifies the bdy f the accmpanying the transfer. HRESULT Bdy([ut, retval] BSTR *pval); HRESULT Bdy([in] BSTR newval); 186

187 Interface Reference EFT v6.5 and later Prperty ExpireDays As Int Retrieves r specifies the number f days that the transfer will be accessible. HRESULT ExpireDays([ut, retval] INT *pval); HRESULT ExpireDays([in] INT newval); EFT v6.5 and later Prperty Frm As String Retrieves r specifies the address f the user respnsible fr the transfer. HRESULT Frm([ut, retval] BSTR *pval); HRESULT Frm([in] BSTR newval); EFT v6.5 and later Prperty Reserved1 As String Retrieves r specifies the field reserved t recrd additinal data assciated with a transfer. HRESULT Reserved1([ut, retval] BSTR *pval); HRESULT Reserved1([in] BSTR newval); EFT v6.5 and later Prperty Reserved2 As String Retrieves r specifies the field reserved t recrd additinal data assciated with a transfer. HRESULT Reserved2([ut, retval] BSTR *pval); HRESULT Reserved2([in] BSTR newval); EFT v6.5 and later Prperty SiteName As String Retrieves r specifies the name f the site under which the transfer ccurred. HRESULT SiteName([ut, retval] BSTR *pval); HRESULT SiteName([in] BSTR newval); EFT v6.5 and later Prperty Subject As String Retrieves r specifies the subject line f accmpanying the transfer. HRESULT Subject([ut, retval] BSTR *pval); HRESULT Subject([in] BSTR newval); EFT v6.5 and later Prperty TempPasswrd As String Retrieves r specifies the passwrd f the accunt created t hld the transferred files. HRESULT TempPasswrd([ut, retval] BSTR *pval); HRESULT TempPasswrd([in] BSTR newval); EFT v6.5 and later Prperty TempUserName As String Retrieves r specifies the accunt created t hld the transferred files. HRESULT TempUserName([ut, retval] BSTR *pval); HRESULT TempUserName([in] BSTR newval); EFT v6.5 and later 187

188 EFT API Reference Prperty Timestamp As Date Retrieves the timestamp the ad hc transfer ccurred. HRESULT Timestamp([ut, retval] DATE *pval); HRESULT Timestamp([in] DATE newval); EFT v6.5 and later Prperty TransGUID As String Retrieves r specifies the GUID used t crrelate this transfer with recipients and files. HRESULT TransGUID([ut, retval] BSTR *pval); HRESULT TransGUID([in] BSTR newval); EFT v6.5 and later ICIServer - Server Interface Use the ICIServer interface t manage the Server and access the Server's attributes. interface ICIServer : IDispatch GetAdminIPs is a list f all IP addresses assigned t the EFT cmputer. ListenIP is a deprecated prperty frm previus versins in which EFT's administrative subsystem listened n nly ne IP address; instead use ListenIPs in v6.4 and later. CreateAutmatinAdmin is almst the same as CreateAdmin in that it creates an EFT-managed administratr accunt. The difference is that an autmated administratr s riginal passwrd is nt reset upn first cnnectin regardless f administratr passwrd plicy. An autmated administratr accunt is created nly via the API, perates via the API, and des nt require an initial passwrd change. Jump t: ARM B C D E G H I K L LOG M P R S SMTP T U Dialg Bx Equivalents Members (listed alphabetically) Prperty ActiveDwnlads As Lng read-nly Retrieves the number f active dwnlads. HRESULT ActiveDwnlads( [ut, retval] LONG* pval); MsgBx Active dwnlads & CStr(Server.ActiveDwnlads) Prperty ActiveUplads As Lng read-nly Retrieves the number f active uplads. HRESULT ActiveUplads( [ut, retval] LONG* pval); MsgBx Active uplads & CStr(Server.ActiveUplads) Sub AddCntentIntegrityCntrlPrfile(pPrfile As Object) Adds a new prfile t use with an ICAP (antivirus and DLP) server. 188

189 Interface Reference HRESULT AddCntentIntegrityCntrlPrfile([in] IDispatch* pprfile); EFT and later Sub AddIPAccessRule (bstrmask As String, ballw As Blean, nruleps As Lng) See als GetIPAccessRules and RemveIPAccessRule, and the fllwing interfaces: ICIAutbanIPAccessRule Interface ICIBannedIP Interface ICIIPAccessRule Interface ICIManualIPAccessRule Interface Adds allwed r denied IP mask fr administratin. HRESULT AddIPAccessRule( [in] BSTR bstrmask, [in] VARIANT_BOOL ballw, [in] lng nruleps) //psitin in list (0 is first) Server.AddIPAccessRule(" ", false, 2) Prperty AdminAccunts As Variant read-nly Fr an example using this prperty, refer t the RetrieveAdminUser script in Script Examples. See als ICIAdminPermissin - Administratr Permissin Interface and ICIAdminAccunt - Administratr Accunt Interface. Retrieves an array f administratr accunts. HRESULT AdminAccunts( [ut,retval] VARIANT* pval); Fr Each admin In Server.AdminAccunts MsgBx admin.lgin Next Example (C#): bject[] accunts = (bject[])m_server.adminaccunts; Prperty AdminPrt As Lng Retrieves r specifies the prt used fr remte administratin cnnectins t administer the Server. Yu must restart the server t apply any change t the server administratr prt. HRESULT AdminPrt( [ut, retval] lng *pval); HRESULT AdminPrt( [in] lng newval); All versins Prperty AllwClearCmmandChannel As Blean Allws r prhibits a clear cmmand channel n the server. HRESULT AllwClearCmmandChannel( [ut, retval] VARIANT_BOOL *pval); HRESULT AllwClearCmmandChannel( 189

190 EFT API Reference [in] VARIANT_BOOL newval); Server.AllwClearCmmandChannel = true EFT v5.0.1 and later Prperty AllwRemteAdministratin As Blean Allws r prhibits remte administratin f the server. HRESULT AllwRemteAdministratin([ut, retval] VARIANT_BOOL *pval); HRESULT AllwRemteAdministratin([in] VARIANT_BOOL newval); All versins Prperty AllwUnprtectedDataChannel As Blean Allws r prhibits an unprtected data channel n the server fr the FTP Prtcl. HRESULT AllwUnprtectedDataChannel( [ut, retval] VARIANT_BOOL *pval); HRESULT AllwUnprtectedDataChannel( [in] VARIANT_BOOL newval); Server. AllwUnprtectedDataChannel = true EFT v5.0.1 and later Sub ApplyChanges() Applies changes t cnfirm and set changes yu have made. (Any "Set" r "Write" methd applies the change made immediately.) HRESULT ApplyChanges(); All versins; des nt apply t HA ndes Prperty ARMAuthenticatinType As ARMAuthenticatinType Fr an example using this prperty, refer t the BackupEx script in Script Examples. Retrieves r specifies the type f database authenticatin, SQL r Windws HRESULT ARMAuthenticatinType( [ut, retval] ARMAuthenticatinType* pval); HRESULT ARMAuthenticatinType( [in] ARMAuthenticatinType newval) If WindwsAuthenticatin = Server.ARMAuthenticatinType Then ' sme cde End If Server.ARMAuthenticatinType = SQLServerAuthenticatin Prperty ARMDatabaseName As String Fr an example using this methd, refer t the BackupEx script in Script Examples. Retrieves r specifies the Auditing and Reprting database name. 190

191 Interface Reference HRESULT ARMDatabaseName( [ut, retval] BSTR *pval); HRESULT ARMDatabaseName( [in] BSTR newval); Dim strdbname: strdbname = Server.ARMDatabaseName WScript.Ech "ARM Database: " & strdbname All versins Prperty ARMDatabaseType As ARMDatabaseType Retrieves r specifies the database type. HRESULT ARMDatabaseType( [ut, retval] ARMDatabaseType* pval); HRESULT ARMDatabaseType( [in] ARMDatabaseType newval); If Oracle = Server.ARMDatabaseType Then ' sme cde End If Server.ARMDatabaseType = SQLServer Prperty ARMFailureAuditFlder As String Retrieves r specifies the flder used fr lgging ARM audit failures. HRESULT ARMFailureAuditFlder( [ut, retval] BSTR* pval); HRESULT ARMFailureAuditFlder( [in] BSTR newval); Auditflder = Server.ARMFailureAuditFlder Server.ARMFailureAuditFlder = "C:\sme_flder" Prperty ARMFailure List As String Retrieves r specifies a list f s that are ntified f ARM failure. HRESULT ARMFailure List( [ut, retval] BSTR* pval); HRESULT ARMFailure List( [in] BSTR newval); str list = Server.ARMFailure List If str list <> "" Then str list = str list + "; " End If 191

192 EFT API Reference str list = str list + "NewRecipientName<SmeAddr@Sm Server.cm>" Server.ARMFailure List = str list Prperty ARMHealCnnectin As Blean Enable r disable ARM healing cnnectin mechanism. HRESULT ARMHealCnnectin([ut,retval] VARIANT_BOOL* pval); HRESULT ARMHealCnnectin([in] VARIANT_BOOL newval); If MyServer.ARMHealCnnectin Then Healing cnnectin mechanism is enabled End If MyServer.ARMHealCnnectin = False Healing cnnectin mechanism have disabled EFT v6.6 and later Prperty ARMNtifyOnDiscnnect As Blean Enable r disable ntify n ARM database discnnect by sending an t the recipients defined n ARMFailure List. HRESULT ARMNtifyOnDiscnnect([ut,retval] VARIANT_BOOL* pval); HRESULT ARMNtifyOnDiscnnect([in] VARIANT_BOOL newval); If MyServer.ARMNtifyOnDiscnnect Then Ntify n ARM database discnnect is enabled End If MyServer.ARMNtifyOnDiscnnect = False Ntify n ARM database discnnect is disabled EFT v6.6 and later Prperty ARMNtifyOnRecnnect As Blean Enable r disable ntify n ARM database recnnect by sending an t the recipients defined n ARMFailure List. HRESULT ARMNtifyOnRecnnect([ut,retval] VARIANT_BOOL* pval); HRESULT ARMNtifyOnRecnnect([in] VARIANT_BOOL newval); If MyServer.ARMNtifyOnRecnnect Then Ntify n ARM database Recnnect is enabled End If 192

193 Interface Reference MyServer.ARMNtifyOnRecnnect = False Ntify n ARM database recnnect have disabled EFT v6.6 and later Prperty ARMPasswrd As String Fr an example using this methd, refer t the BackupEx script in Script Examples. Retrieves r specifies the passwrd fr lgging in t the ARM Database. HRESULT ARMPasswrd( [ut, retval] BSTR *pval); HRESULT ARMPasswrd( [in] BSTR newval); Example: Dim strnewpasswrd: strnewpasswrd = "newpasswrd" Server.ARMPasswrd = strnewpasswrd All versins Functin ARMRecnnect() As Blean Specify whether ARM shuld recnnect after discnnectin. HRESULT ARMRecnnect( [ut,retval] VARIANT_BOOL* pval); If Nt Server.ARMRecnnect() Then MsgBx "Recnnectin failed." End If Prperty ARMRecnnectPerid As DWrd Retrieves r specifies the perid t recnnect t the ARM database. If a database errr ccurs and the ARM healing mechanism is enabled, then EFT tries t recnnect t the database every ARMRecnnectPerid secnds. The ARMRecnnectPerid can be set frm 7 t secnds (24 hurs). The default is 7 secnds. HRESULT ARMRecnnectPerid([ut,retval] ULONG* pval); HRESULT ARMRecnnectPerid([in] ULONG newval); MsgBx Recnnect perid: & CStr(MyServer.ARMRecnnectPerid) MyServer.ARMRecnnectPerid = 60 every ne minute EFT v6.6 and later Prperty ARMServerName As String Fr an example using this methd, refer t the BackupEx script in Script Examples. Retrieves r specifies the name f the server n which the Auditing and Reprting database is lcated. HRESULT ARMServerName( [ut, retval] BSTR *pval); HRESULT ARMServerName( [in] BSTR newval); 193

194 EFT API Reference Dim strservername: strservername = Server.ARMServerName Server. ARMServerName = "lcalhst\glbalscape" All versins Prperty ARMStpAuditingOnErrr As Blean Retrieves r specifies whether ARM shuld stp auditing when it encunters an errr. HRESULT ARMStpAuditingOnErrr( [ut, retval] VARIANT_BOOL* pval); HRESULT ARMStpAuditingOnErrr( [in] VARIANT_BOOL newval); If Server.ARMStpAuditingOnErrr Then ' sme cde End If Server.ARMStpAuditingOnErrr = True Functin ARMTestCnnectin() As Blean Fr an example using this methd, refer t the ARM script in Script Examples. Retrieves r specifies whether t test the ARM cnnectin. HRESULT ARMTestCnnectin([ut,retval] VARIANT_BOOL* pval); If Nt Server.ARMTestCnnectin() Then MsgBx "Database is unavailable!" End If Prperty ARMUserName As String Fr an example using this prperty, refer t the BackupEx script in Script Examples. Retrieves r specifies the username used t cnnect t the Auditing and Reprting database. HRESULT ARMServerName( [ut, retval] BSTR *pval); HRESULT ARMServerName( [in] BSTR newval); Dim strusername : strusername = Server.ARMUserName Server. ARMUserName = "admin" All versins Functin Auditr() As CIAudit Retrieves r specifies lg audit infrmatin in the Auditing and Reprting Mdule (ARM) related t the Secure Ad Hc Transfer mdule. HRESULT Auditr( [ut,retval] ICIAudit** ppauditr); 194

195 Interface Reference EFT v6.0 and later Prperty AutSave As Blean Used fr better perfrmance in special cases and available nly fr COM admin sessins. When ICIServer::AutSave is FALSE settings changes d nt save in the TE and yu have t call ICIServer::ApplyChanges manually. When ICIServer::AutSave is TRUE every settings change is saved (usual behavir). HRESULT AutSave( [ut, retval] VARIANT_BOOL *pval); HRESULT AutSave( [in] VARIANT_BOOL newval); MsgBx "Aut save mde: " & CStr(Server.AutSave) SFTPServer.AutSave = FALSE Dim strname strname = "User_ " kbase = 1 kadd = Fr j = kbase T kadd Site.CreateUserEx strname+cstr(j),cstr(j),0,cstr(j),cstr(j),true,false, "Default settings" Next SFTPServer.AutSave = TRUE Wscript.ech "Saving Settings..." SFTPServer.ApplyChanges Wscript.ech "Saved " EFT v and later; des nt apply t HA ndes Prperty AvailableEvents As Variant read-nly Retrieve a list f the Events defined n EFT. Its value is a variant cntaining the array f ICIEventInf. HRESULT AvailableEvents( [ut, retval] VARIANT* pval); Fr Each event In Server.AvailableEvents MsgBx event.name & " event is available" Next EFT v6.1 and later Prperty AvailablePGPKeys As Variant read-nly Retrieve a list f EFT s PGP Keys. Its value is a variant cntaining the array f ICIPGPKeyInf HRESULT AvailablePGPKeys( [ut, retval]variant* pval); Fr Each key In Server.AvailablePGPKeys MsgBx key.name & " key is available" Next EFT v6.1 and later 195

196 EFT API Reference Prperty AvailableReprts As Variant read-nly See als ICIReprtInf - Reprt Infrmatin Interface. Retrieve a list f the reprts available n EFT. Its value is a variant cntaining the array f the ICIReprtInf. HRESULT AvailableReprts( [ut, retval] VARIANT* pval); Fr Each reprt In Server.AvailableReprts MsgBx reprt.name & " reprt is available" Next EFT v6.1 and later Prperty AvailableSSHKeys As Variant read-nly Fr an example using this prperty, refer t the SSH script in Script Examples. Retrieve a list f SSH public keys available fr EFT. Its value is a variant cntaining the array f ICISSHKeyInf. HRESULT AvailableSSHKeys( [ut, retval] VARIANT* pval); Fr Each key In Server.AvailableSSHKeys MsgBx "Key " & key.name & "(" & key.fingerprint & ") is available" Next Example (C#): keyidlist = (bject[])m_server.availablesshkeys; EFT v6.1 and later Prperty AverageSpeed As Lng read-nly Retrieve the average transfer speed f the server. HRESULT AverageSpeed( [ut, retval] LONG* pval); Example (VBScirpt): MsgBx "Average speed is " & CStr(Server.AverageSpeed) & "KB/s" Sub BackupServerCnfiguratin(bstrFilePath As String) Fr an example using this methd, refer t the Backup script in Script Examples. Retrieves r specifies the path at which t save server backup files. HRESULT BackupServerCnfiguratin( [in] BSTR bstrfilepath); Server.BackupServerCnfiguratin "C:\lastbackup.bak" Prperty CertificateFilePath As String Retrieves r specifies the path t the server's certificate files. 196

197 Interface Reference HRESULT CertificateFilePath( [ut, retval] BSTR *pval); HRESULT CertificateFilePath( [in] BSTR newval); All versins Sub ChangeAdminPasswrd(bstrAdminUser As String, bstrnewpasswrd As String) Change the passwrd fr an administratr accunt n the server. HRESULT ChangeAdminPasswrd( [in] BSTR bstradminuser, [in] BSTR bstrnewpasswrd); Server.ChangeAdminPasswrd( "subadmin", "newpasswrd") EFT and later Prperty CipherList As String Refer t "Using Ciphers fr Inbund SSL Cnnectins" in the EFT dcumentatin fr a cmplete list f allwed ciphers and hw t prperly frmat the cipher string. Retrieves r specifies the cipher list. HRESULT CipherList( [ut, retval] BSTR *pval); HRESULT CipherList( [in] BSTR newval); Examples (VBScript): Dim strcipherlist: strcipherlist = Server.CipherList Dim strnewlist strnewlist = "ALL:!EXPORT:!LOW" SFTPServer.CipherList = strnewlist Dim strcipherlist: strcipherlist = SFTPServer.CipherList WScript.Ech strcipherlist CipherList must be delimited by cln ( : ). Fr example, "AES256-SHA:CAMELLIA256-SHA:DES-CBC3-SHA:AES128-SHA:IDEA-CBC-SHA:RC4-MD5" EFT v5.0.1 and later Sub Clse() Fr an example using this methd, refer t the Backup script r GetCertInf script in Script Examples. Clse the COM administrative cnnectin t the server. HRESULT Clse(); All versins Prperty CnfiguratinFilePath As String Retrieves r specifies the path t the cnfiguratin files. HRESULT CnfiguratinFilePath( [ut, retval] BSTR* pval); HRESULT CnfiguratinFilePath( [in] BSTR newval); 197

198 EFT API Reference MsgBx "Server setting flder is " & server. CnfiguratinFilePath Server.CnfiguratinFilePath = "C:\sme_flder " Server.StpServerService(" ") Server.StartServerService(" ") Sub Cnnect(Hst As String, nprt As Lng, Lgin As String, Passwrd As String) Fr an example using this methd, refer t the Backup script r GetCertInf script in Script Examples. Cnnect t the lcal r remte server as the administratr. (In EFT v6.2 and later, use CnnectEx t cnnect using an IWA r Windws administratr lgin.) HRESULT Cnnect( [in] BSTR Hst, [in] lng nprt, [in] BSTR Lgin, [in] BSTR Passwrd); Dim Server As CIServer 'assumes the SFTPCOMInterface Type Library is referenced by the VB IDE Dim Site As CISite 'instantiates the ISite interface Dim Sites As CISites 'instantiates the ISites interface txtserver = " " 'lcal IP address f server txtprt = "1000" 'admin prt txtusername = "Admin" 'admin username txtpasswrd = "mypass" 'admin passwrd On Errr Resume Next 'verify it culd cnnect k Server.Cnnect txtserver, txtprt, txtusername, txtpasswrd 'nw cnnect using supplied infrmatin If Err.Number <> 0 Then MsgBx "Errr cnnecting t '" & txtserver & ":" & txtprt & "' -- " & Err.Descriptin & " [" & CStr(Err.Number) & "]", vbinfrmatin, "Errr" 'all this n ne line! End If Set Sites = Server.Sites 'nw retrieve the list f sites in the server Set Site = Sites.Item(0) 'Instantiate the first and nly, site (nte, this script assumes nly ne site present) 'cntinue rest f cde... All versins Prperty CnnectedUsersNumber As Lng read-nly Retrieve the number f users cnnected t the Server. HRESULT CnnectedUsersNumber( [ut, retval] BSTR *pval); Dim icnnecteduses: icnnectedusers = Server.CnnectedUsersNumber EFT and later Sub CnnectEx(Hst As String, nprt As Lng, nlgintype As AdminLginType, Lgin As String, Passwrd As String) Lg in t EFT using Integrated Windws Authenticatin (IWA) r Windws administratr lgin credentials. 198

199 Interface Reference HRESULT CnnectEx(/* [in]*/ BSTR Hst, /* [in]*/ lng nprt, /* [in]*/ AdminLginType nlgintype, /* [in]*/ BSTR Lgin, /* [in]*/ BSTR Passwrd); AdminLginType EFTLgin = 0, // With EFT-managed admin lgin and passwrd (legacy style) IWALgin = 1, // With currently lgged user credentials // (Integrated Windws Authenticatin, IWA; // fr AD and lcal cmputer accunts) NetLgn = 2 // With Windws lgin and passwrd // (fr AD and lcal cmputer accunts) Examples (VBScript): IWA: SFTPServer.CnnectEx "EFTServer", 1100, IWALgin, "", "" NetLgin: SFTPServer.CnnectEx "lcalhst", 1100, 2, txtusername, txtpasswrd Lgging in using lcal cmputer lgin r dmain lgin: //... server.cnnectex " ", 1100, IWALgin, "", "" //... server.cnnectex " ", 1100, NetLgn, "PC1\user", "User'sLcalPasswrd" //... server.cnnectex " ", 1100, NetLgn, "DM1\user", "User'sDmainPasswrd" EFT v6.2 and later Prperty CntentIntegrityCntrlPrfileList As Variant HRESULT CntentIntegrityCntrlPrfileList([ut, retval] VARIANT *pval); EFT v7.0.3 and later Functin CreateAdmin(bstrNewAdmin As String, bstrpasswrd As String, atype As AdminAccuntType, vbgrup As Blean) As Object Fr an example using this methd, refer t the CreateAdminUser script in Script Examples. Create an administratr accunt n EFT. HRESULT CreateAdmin( [in] BSTR bstrnewadmin, [in] BSTR bstrpasswrd, [in] AdminAccuntType atype, [in] VARIANT_BOOL vbgrup, [ut,retval] IDispatch** padminaccunt); Set AdminAccunt = server.createadmin("admin", "swrdfish", EFTAdmin, False) Example (C#): ICIAdminAccunt adminuser = (ICIAdminAccunt)m_server.CreateAdmin("Test_Administratr", "Tester!1", AdminAccuntType.EFTAccunt, false); Functin CreateAutmatinAdmin(bstrNewAdmin As String, bstrpasswrd As String) As Object 199

200 EFT API Reference Create an autmatin administratr accunt. This accunt des nt require a passwrd change, regardless f passwrd security settings; the accunt is intended fr use in an autmated system that des nt lgin via the administratin interface. (N UI equivalent; fr API nly.) HRESULT CreateAutmatinAdmin( [in] BSTR bstrnewadmin, // admin name [in] BSTR bstrpasswrd, //admin passwrd [ut,retval] IDispatch** padminaccunt); //ICIAdmin Accunt Set admin = Server.CreateAutmatinAdmin("admin", "pass") EFT v6.3.1 and later Functin CreateCmplexPasswrd(bstrUserName As String) As String Create a cmplex passwrd. HRESULT CreateCmplexPasswrd( [in] BSTR bstrusername, [ut, retval] BSTR *bstrpasswrd); pass = Server.CreateCmplexPasswrd ("user") EFT v6.3.1 and later Functin CreatePGPKey(bstrFullName As String, bstr address As String, dtexpiratindate As Date, nkeytype As PGPKeyType, nkeycipher As PGPKeyCipher, ulkeysize As DWrd, bstrpassphrase As String) As String Create a PGPKey n EFT. HRESULT CreatePGPKey( [in] BSTR bstrfullname, [in] BSTR bstr address, [in] DATE dtexpiratindate, [in] PGPKeyType nkeytype, [in] PGPKeyCipher nkeycipher, [in] ULONG ulkeysize, [in] BSTR bstrpassphrase, [ut,retval] BSTR* pval); PGPKeyType PGPKeyType_DSS = 0 PGPKeyType_RSA = 1 PGPKeyType_RSALegacy = 2 PGPKeyCipher PGPKeyCipher_IDEA = 0 PGPKeyCipher_3DES = 1 PGPKeyCipher_CAST5 = 2 PGPKeyCipher_AES128 = 3 PGPKeyCipher_AES192 = 4 PGPKeyCipher_AES256 = 5 PGPKeyCipher_TWOFISH = 6 strkeyid = Server.CreatePGPKey("Ivan Ivanuch", "ipetrv@mail.cm", expdate, PGPKeyType_RSA, PGPKeyCipher_IDEA, 1024, "passwrd") MsgBx "New key id is " & strkeyid 200

201 Interface Reference Sub CreateSSHKey(nKeyBits As Lng, bstrpasswrd As String, bstrprivatekeyfile As String, bstrpublickeyfile As String, vbcmfrmat As Blean, nsiteid As Lng, bstrcpyt As String) Create an SSH Key n EFT. HRESULT CreateSSHKey( [in] LONG nkeybits, [in] BSTR bstrpasswrd, [in] BSTR bstrprivatekeyfile, [in] BSTR bstrpublickeyfile, [in] VARIANT_BOOL vbcmfrmat, [in] LONG nsiteid, [in] BSTR bstrcpyt); Server.CreateSSHKey 1024, "passphrase", "C:\Private", "C:\Public.pub", False, 0, "" Sub CreateSSLCertificate(bstrKeyFile As String, bstrreqfile As String, bstrcertfile As String, bstrpasswrd As String, bstrcuntryname As String, bstrstateorprvincename As String, bstrlcalityname As String, bstrorganizatinname As String, bstrorganizatinalunitname As String, bstrcmmnname As String, bstr address As String, nbits As Lng, ndays As Lng, CertFrmat As CertificateFrmat, PrivateKeyFrmat As CertificateFrmat, nsiteid As Lng, vbusecert As Blean, vbmaketrusted As Blean) This methd des nt create a new path. That is, if yu use "c:\test\cert.key" as the path and c:\test desn t exist, the functin appears t cmplete withut errr and n file/directry is created. Als, if executed frm a nn-lcal system, there is n feedback that executin f the functin has been blcked fr security reasns; it simply (silently) fails. Create an SSL certificate n EFT. HRESULT CreateSSLCertificate( [in] BSTR bstrkeyfile, [in] BSTR bstrreqfile, [in] BSTR bstrcertfile, [in] BSTR bstrpasswrd, [in] BSTR bstrcuntryname, [in] BSTR bstrstateorprvincename, [in] BSTR bstrlcalityname, [in] BSTR bstrorganizatinname, [in] BSTR bstrorganizatinalunitname, [in] BSTR bstrcmmnname, [in] BSTR bstr address, [in] LONG nbits, [in] LONG ndays, [in] CertificateFrmat CertFrmat, [in] CertificateFrmat PrivateKeyFrmat, [in] LONG nsiteid, [in] VARIANT_BOOL vbusecert, [in] VARIANT_BOOL vbmaketrusted); Server.CreateSSLCertificate "C:\Cert.key", "C:\Cert.csr", "C:\Cert.crt", "passphrase", "RU", "Perm", "Perm", "MIA", "6", "q", "petrenk@mail.cm", 1024, 21, PEM, PEM, 0, False, False Prperty DefaultPllTimeut As Lng 201

202 EFT API Reference Retrieves r specifies the default value fr the user database refresh interval (set t "never" by default). HRESULT DefaultPllTimeut([ut, retval] LONG* pval); HRESULT DefaultPllTimeut([in] LONG newval); Interval = Server.DefaultPllTimeut Server.DefaultPllTimeut = -1 Sub DeleteCntentIntegrityCntrlPrfile(pPrfileName As String) HRESULT DeleteCntentIntegrityCntrlPrfile([in] BSTR pprfilename); (See als the ICICntentIntegrityCntrlActinParams PrfileName prperty.) EFT v7.0.3 and later Prperty DiscnnectDueTTimeut As Blean (On a PCI DSS-enabled accunt, disabling the timeut is nt allwed.) Enables/disables the timeut t discnnect the administratin interface frm EFT after administratr inactivity. HRESULT DiscnnectDueTTimeut([ut, retval] VARIANT_BOOL* pval); HRESULT DiscnnectDueTTimeut(VARIANT_BOOL newval); If Server.DiscnnectDueTTimeut = VARIANT_TRUE Then Admin timeut enabled End If disable admin timeut Server.DiscnnectDueTTimeut = VARIANT_FALSE EFT v6.5 and later Prperty DiscnnectDueTTimeutPerid As Lng (On a PCI DSS-enabled accunt, setting a timeut lnger than 15 minutes is nt allwed.) Set the timeut (in minutes) after administratr inactivity t discnnect the administratin interface frm EFT (and lg ut the administratr accunt). Remark: Only values frm 1 t 9999 are accepted HRESULT DiscnnectDueTTimeutPerid([ut,retval] LONG* pval); HRESULT DiscnnectDueTTimeutPerid([in] LONG newval); If Server.DiscnnectDueTTimeutPerid = 15 Then There is 15 minutes admin timeut perid End If 202

203 Interface Reference set admin timeut perid t 5 minutes Server.DiscnnectDueTTimeutPerid = 5 EFT v6.5 and later Prperty EnableARM As Blean Fr an example using this prperty, refer t the BackupEx script in Script Examples. Enable r disable Auditing and Reprting, r evaluate status f Auditing and Reprting. HRESULT EnableARM( [ut, retval] VARIANT_BOOL *pval); HRESULT EnableARM( [in] VARIANT_BOOL newval); Dim barmstatus: barmstatus = Server.EnableARM T set the state: Server.EnableARM = false All versins Sub ExprtPGPKey(bstrKeyId As String, vbincludeprivate As Blean, bstrfilename As String) Exprt an Open PGP Key. HRESULT ExprtPGPKey( [in] BSTR bstrkeyid, [in] VARIANT_BOOL vbincludeprivate, [in] BSTR bstrfilename); Server.ExprtPGPKey "0x ", False, "C:\PGP\pgpkey.asc" Sub ExprtSSHKey(lKeyID As Lng, bzkeyfilepath As String) Fr an example using this methd, refer t the SSH script in Script Examples. Exprt an SSH key. HRESULT ExprtSSHKey( [in] LONG lkeyid, [in] BSTR bzkeyfilepath); Server.ExprtSSHKey nkeyid, "C:\SSHKeys\key.pub" Example (C#): m_server.exprtsshkey(key.id, keypath); Sub GenerateReprt(pdispReprtParams As Object, bzreprtpath As String) Generate an EFT reprt. HRESULT GenerateReprt( IDispatch* pdispreprtparams, // [in] ICIReprtActinParams interface // cntaining reprt parameters BSTR bzgeneratedreprtpath); // [in] Lcal file t put the reprt t 203

204 EFT API Reference Set ReprtParams = CreateOb-ject("SFTPCOMInterface.CIReprtActinParams") 'Setup reprt name, filters, perid '... ReprtParams.ReprtFileFrmat = PDFFrmat Server.GenerateReprt(ReprtParams, "C:\Reprt\Reprt.pdf") EFT v6.1 and later Functin GetAdminIPs() As Variant Retrieve an array f IP addresses fr the cmputer n which EFT is running. The IP addresses can be used as LISTENING IP addresses fr administratin r prtcl services. HRESULT GetAdminIPs( [ut,retval] VARIANT* pvar); Dim arips : arips = Server.GetAdminIPs() fr i = LBund(arIPS) t UBund(arIPS) WScript.Ech CStr(i) & " - " & arips(i) next EFT v4.3.4 and later Functin GetBackupArchiveInf(bstrFilePath As String, nlgintype As AdminLginType, bstrlgin As String, bstrpasswrd As String) As CIBackupArchiveInf Retrieves r specifies the backup archive infrmatin. HRESULT GetBackupArchiveInf( [in] BSTR bstrfilepath, [in] AdminLginType nlgintype, [in] BSTR bstrlgin, [in] BSTR bstrpasswrd, [ut,retval] IDispatch** pval); Set BackupSettings = Server.GetBackupArchiveInf("C:\backup.bak", EFTLgin, "admin", "swrdfish") Functin GetCmplexPasswrdSettings() As CICmplexPasswrdSettings Retrieve cmplex passwrd settings. HRESULT GetCmplexPasswrdSettings( [ut, retval] IDispatch** ppicmplexpasswrdsettings); Set PwdSettings = Server.GetCmplexPasswrdSettings() Functin GetCntentIntegrityCntrlPrfile(prfileName As String) As Lng HRESULT GetCntentIntegrityCntrlPrfile([in] BSTR prfilename, [ut, retval] lng *prfileindex); EFT v7.0.3 and later Functin GetHighAvailabilityParams() As Object HRESULT GetHighAvailabilityParams([ut, retval] IDispatch** ppdispparams); EFT v7.0 and later 204

205 Interface Reference Functin GetIPAccessRules() As Variant See als AddIPAccessRule, RemveIPAccessRule, MveIPAccessRule methds, and the fllwing interfaces: ICIAutbanIPAccessRule Interface ICIBannedIP Interface ICIManualIPAccessRule Interface ICIClientSettings : GetIPAccessRules ICISite : GetIPAccessRules Retrieve an array f administratin IP address access rules. HRESULT GetIPAccessRules( [ut, retval] VARIANT *amasks); rules = Server.GetIPAccessRules() Fr Each key In rules If key.type = 0 Then WScript.ech "AutBan" End if If key.type = 1 Then WScript.ech "Manual " + key.address End if Next Functin GetLcalIP(nIP As Lng) As String Given an index, retrieves a Lcal IP address. HRESULT GetLcalIP( [in] lng nip, [ut, retval] BSTR *prp); All versins Functin GetLcalTime() As String Retrieve EFT's lcal time. HRESULT GetLcalTime( [ut, retval] BSTR *ptime); All versins Sub GetPGPKeyringSettings(pPublicPath As String, pprivatepath As String) Fr an example using this methd, refer t the PGP script in Script Examples. Retrieve the OpenPGP Keyring settings. HRESULT GetPGPKeyringSettings( [ut] VARIANT* ppublicpath, [ut] VARIANT* pprivatepath); Server.GetPGPKeyringSettings strpublickeyring, strprivatekeyring Example (C#): m_server.imprtsshkey(@"c:\sshkey.pub"); bject publicpath = new bject(); 205

206 EFT API Reference bject privatepath = new bject(); m_server.getpgpkeyringsettings(ut publicpath, ut privatepath); Functin GetServerAdminCunt() As Lng Retrieve a cunt f administratr accunts defined n EFT. HRESULT GetServerAdminCunt( [ut,retval] lng* lcunt); Dim i : i = Server.GetServerAdminCunt() Prperty HACherenceQueue As String HRESULT HACherenceQueue([ut, retval] BSTR *pval); EFT v7.0 and later Prperty HACnfiguratinDefaultNdeList As Variant Allws yu t specify ne r mre ndes as the default t execute Event Rules. This list can be verridden in the Event Rules. HRESULT HACnfiguratinDefaultNdeList([ut, retval] VARIANT *pval); HRESULT HACnfiguratinDefaultNdeList([in] VARIANT pval); EFT v7.0.2 and later Prperty HACnfiguratinFilePath As String HRESULT HACnfiguratinFilePath([ut, retval] BSTR* pval); EFT v7.0 and later Prperty HAEnabled As Blean HRESULT HAEnabled([ut, retval] VARIANT_BOOL *pval); EFT v7.0 and later Prperty HAEventQueue As String HRESULT HAEventQueue([ut, retval] BSTR *pval); EFT v7.0 and later Prperty HAFailureNtificatin As String HRESULT HAFailureNtificatin ([ut, retval] BSTR *pval); EFT v7.0 and later Prperty HAMulticastAddress As String HRESULT HAMulticastAddress([ut, retval] BSTR *pval); EFT v7.0 and later Prperty HAMulticastPrt As Lng HRESULT HAMulticastPrt([ut, retval] lng *pval); EFT v7.0 and later Sub ImprtPGPKey(bstrKey As String, bstrkeyfile As String) Imprt an OpenPGP key. 206

207 Interface Reference HRESULT ImprtPGPKey( [in] BSTR bstrkeypath, [ut, retval] BSTR* pnewkeyid); KeyId = Server.ImprtPGPKey("C:\PGP\pgpkey.asc") Functin ImprtSSHKey(bstrKeyPath As String) As Lng Fr an example using this methd, refer t the PGP script r SSH script in Script Examples. Imprt an SSH public key. Unlike ther SSL certificate-related methds dealing with files, the key t imprt must be lcated n the cmputer running COM, nt n the cmputer running EFT. This difference reflects EFT administratin interface behavir. HRESULT ImprtSSHKey( [in] BSTR bstrkeypath, // Public key path (n the cmputer running COM) [ut, retval] lng *plid);// ID f the key imprted (can be used t assign the key t client) Client.SetSftpAuthenticatinType "key" keyid = Server.ImprtSSHKey("C:\client.pub") Client.SetSSHKeyID keyid Example (C#): m_server.imprtsshkey(@"c:\sshkey.pub"); bject publicpath = new bject(); bject privatepath = new bject(); m_server.getpgpkeyringsettings(ut publicpath, ut privatepath); Example (C#): int keyid = m_server.imprtsshkey(keypath); EFT v6.1 and later Prperty InactiveAccuntsRemving As Blean Enable r disable remve inactive administratr accunts feature. HRESULT InactiveAccuntsRemving([ut, retval] VARIANT_BOOL *pval); HRESULT InactiveAccuntsRemving([in] VARIANT_BOOL newval); If MyServer.InactiveAccuntsRemving Then Inactive accunts will be remved End If MyServer.InactiveAccuntsRemving = False Inactive admin accunt wn t be remved. EFT v6.6 and later Prperty InvalidAttemptsPerid As Lng 207

208 EFT API Reference Retrieves r specifies the time perid during which will be calculating invalid lgin attempts. Measured in minutes. Limitatin: 1 <= InvalidAttemptsPerid <= 99 HRESULT InvalidAttemptsPerid([ut, retval] LONG *pval); HRESULT InvalidAttemptsPerid([in] LONG newval); MsgBx "Invalid attempts perid: " & CStr(MyServer.InvalidAttemptsPerid) MyServer.InvalidAttemptsPerid = 18 EFT v6.6 and later Prperty IPAccessAllwedDefault As Blean Retrieves r specifies the default IP Access restrictin list. HRESULT IPAccessAllwedDefault( [ut, retval] VARIANT_BOOL *pval); HRESULT IPAccessAllwedDefault( [in] VARIANT_BOOL newval); True = All IP addresses are allwed except thse specified False = All IP addresses are denied except thse specified All versins Functin IsServerServiceStarted(bstrHst As String) As Blean Determine if the EFT Server service is started. HRESULT IsServerServiceStarted( [in] BSTR bstrhst, [ut,retval] VARIANT_BOOL* pvresult); If Nt Server.IsServerServiceStarted(" ") Then Server.StartServerService(" ") End If Prperty IsStarted As Blean read-nly Determine if the EFT Server service is started. HRESULT IsStarted( [ut, retval] VARIANT_BOOL* pval); If Nt Server.IsStarted Then Server.Start() End If Prperty KeyFilePath As String Retrieves r specifies the file path fr EFT's private key files. HRESULT KeyFilePath( [ut, retval] BSTR *pval); HRESULT KeyFilePath( [in] BSTR newval); 208

209 Interface Reference All versins Prperty LastMdifiedBy As String read-nly See als LastMdifiedTime, belw. Fr an example using this prperty, refer t the ServerStats script in Script Examples. Retrieve the name f the user wh last mdified EFT. HRESULT LastMdifiedBy( [ut, retval] BSTR* pval); MsgBx "Last mdified by " & Server.LastMdifiedBy Example (C#): string lastmdifiedby = m_server.lastmdifiedby; string lastmdifiedtime = m_server.lastmdifiedtime.tstring("mm/dd/yyyy HH:mm:ss"); Cnsle.WriteLine(string.Frmat("EFT prperties Last Mdified: {0} by {1}", lastmdifiedtime, lastmdifiedby)); Prperty LastMdifiedTime As Date read-nly See als LastMdifiedBy, abve. Fr an example using this prperty, refer t the ServerStats script in Script Examples. Retrieve the date and time when EFT was last mdified. HRESULT LastMdifiedTime( [ut, retval] DATE* pval); MsgBx "Mdificatin time is " & CStr(Server.LastMdifiedTime) Example (C#): string lastmdifiedby = m_server.lastmdifiedby; string lastmdifiedtime = m_server.lastmdifiedtime.tstring("mm/dd/yyyy HH:mm:ss"); Cnsle.WriteLine(string.Frmat("EFT prperties Last Mdified: {0} by {1}", lastmdifiedtime, lastmdifiedby)); Prperty LimitLginAttempts As Blean Enable r disable lckut administratr accunts after incrrect lgin attempts feature. HRESULT LimitLginAttempts([ut, retval] VARIANT_BOOL *pval); HRESULT LimitLginAttempts([in] VARIANT_BOOL newval); If MyServer.LimitLginAttempts Then feature is enabled End If MyServer.LimitLginAttempts = False feature is disabled 209

210 EFT API Reference EFT v6.6 and later Prperty ListenIP As Lng In versin 6.4 and later, use ListenIPs, belw, instead. Retrieves r specifies EFT's IP address. HRESULT ListenIP( [ut, retval] lng *pval); HRESULT ListenIP( [in] lng newval); All versins Prperty ListenIPs As Variant Replaces ListenIP, abve. Retrieves r specifies the IP addresses n which EFT listens. HRESULT ListenIPs( [ut, retval] VARIANT* pval); HRESULT ListenIPs( [in] VARIANT newval); EFT v6.4 and later Prperty LckutPerid As Lng Retrieves r specifies the lckut perid fr administratr accunts after incrrect lgin attempts. Measured in minutes. Limitatin: 30, 60, r 90 HRESULT LckutPerid([ut, retval] LONG *pval); HRESULT LckutPerid([in] LONG newval); MsgBx "Lckut Perid: " & CStr(MyServer.LckutPerid) MyServer.LckutPerid = 60 EFT v6.6 and later Prperty LgMde As LgMde Retrieves r specifies whether t use standard r verbse lgging. HRESULT LgMde( [ut, retval] LgMde* pval); HRESULT LgMde( [in] LgMde newval); If LgMdeStandard = Server.LgMde ' sme cde End If Server.LgMde = LgMdeVerbse Prperty LgPath As String 210

211 Interface Reference Retrieves r specifies the file path t EFT's lg. Yu must restart the EFT Server service t cmplete any changes t the lg path. HRESULT LgPath( [ut, retval] BSTR *pval); HRESULT LgPath( [in] BSTR newval); lgpath = Server.LgPath Server.LgPath = "C:\Lgs\server.lg" All versins Prperty LgRtatin As Int Retrieves r specifies the amunt f time befre a new lg is started. Yu can chse frm n rtatin r three different lengths f time. Yu must restart the EFT Server service t cmplete any change t the lg rtatin perid. HRESULT LgRtatin( [ut, retval] int *pval); HRESULT LgRtatin( [in] int newval); Values 0 = Never 1 = Daily 2 = Weekly 3 = Mnthly All versins Prperty LgType As Int Retrieves r specifies EFT's lg frmat. Yu can chse n lg, r yu can chse t generate a lg in ne f three frmats. Yu must restart the EFT Server service fr any changes t the lg frmat t take effect. HRESULT LgType( [ut, retval] int *pval); HRESULT LgType( [in] int newval); Values 2 - W3C Extended Lg File Frmat 3 - Micrsft IIS Lg File Frmat 4 - NCSA Cmmn Lg File Frmat 5 - N Lg All versins Prperty MaxInactiveAccuntPerid As Lng Retrieves r specifies the perid f time after which inactive administratr accunt will be remved. Measured in days. Limitatin: 1 <= invalidattemptsperid <=365 HRESULT MaxInactiveAccuntPerid([ut, retval] LONG *pval); HRESULT MaxInactiveAccuntPerid([in] LONG newval); 211

212 EFT API Reference MsgBx "Inactive accunt perid" & CStr(MyServer.MaxInactiveAccuntPerid) MyServer.MaxInactiveAccuntPerid = 14 tw weeks EFT v6.6 and later Prperty MaxInvalidLginAttempts As Lng Retrieves r specifies the max lgin attempts fr administratr accunts befre it will be lcked. Limitatin: 1 <= MaxInvalidLginAttempts <= 99 HRESULT MaxInvalidLginAttempts([ut, retval] LONG *pval); HRESULT MaxInvalidLginAttempts([in] LONG newval); MsgBx "Max attempts: " & CStr(MyServer.MaxInvalidLginAttempts) MyServer.MaxInvalidLginAttempts = 10 EFT v6.6 and later Functin MduleRegistratinState(m As ServerMdule) As RegistratinState Retrieves the registratin status f EFT mdules. HRESULT MduleRegistratinState( [in] ServerMdule m, [ut, retval] RegistratinState* prs); If Server.MduleRegistratinState(EFTServer) = Expired Then MsgBx "EFT is nt registered" End If EFT v6.1 and later Sub MveIPAccessRule(nRulePsFrm As Lng, nrulepst As Lng) See als GetIPAccessRules, RemveIPAccessRule, and AddIPAccessRule See als the fllwing interfaces: ICIAutbanIPAccessRule Interface ICIBannedIP Interface ICIIPAccessRule Interface ICIManualIPAccessRule Interface Changes allwed administratin IP access rule psitin. HRESULT MveIPAccessRule( [in] lng nrulepsfrm, //initial psitin [in] lng nrulepst); //new psitin Server.MveIPAccessRule(1,2) 212

213 Interface Reference Prperty PassPhrase As String Retrieves r specifies an SSL certificate private key passphrase. HRESULT PassPhrase( [ut, retval] BSTR *pval); HRESULT PassPhrase( [in] BSTR newval); All versins Sub RefreshSettings() Updates the COM bject with the latest set f data frm EFT. Fr example, when yu use Site.FrceSynchrnizeUserDatabase, yu must use the RefreshSettings methd after waiting a suitable amunt f time fr the database synchrnizatin t cmplete. If a call t any COM methd thrws an "MX Errr: 52 (0x )", this means that the COM bject needs t invke RefreshSettings. HRESULT RefreshSettings(); All versins Sub RemveIPAccessRule (nruleps As Lng) See als GetIPAccessRules, AddIPAccessRule, and MveIPAccessRule, and the fllwing interfaces: ICIAutbanIPAccessRule Interface ICIBannedIP Interface ICIIPAccessRule Interface ICIManualIPAccessRule Interface Remves an allwed r denied IP mask fr administratin. HRESULT RemveIPAccessRule( [in] lng nruleps); //psitin Server.RemveIPAccessRule(0) Sub RemvePGPKey(bstrKeyId As String) Remves OpenPGP Key frm EFT. HRESULT RemvePGPKey( [in] BSTR bstrkeyid); Server.RemvePGPKey "0x " Sub RemveServerAdminAccunt(bstrAdminUser As String, [accunttype As AdminAccuntType = 0]) Remves an administratr accunt frm EFT. HRESULT RemveServerAdminAccunt( [in] BSTR bstradminuser, [in, defaultvalue(eftaccunt)] AdminAccuntType accunttype); 213

214 EFT API Reference Versin 6.1: Server.RemveServerAdminAccunt("subadmin"); Versin 6.2 and later: An ptinal parameter was added t ICIServer::RemveServerAdminAccunt methd t allw specifying the type f administratr accunt t remve (EFT-managed by default): Server.RemveServerAdminAccunt "Admin1", ADAccunt EFT and later Sub RemveSSHKey(lID As Lng) Fr an example using this methd, refer t the SSH script in Script Examples. Remves an SSH public key frm EFT. HRESULT RemveSSHKey( [in] lng lid); // key ID Fr Each key In Server.AvailableSSHKeys 'remve all keys Server.RemveSSHKey key.id Next Example (C#): m_server.remvesshkey(key.id); EFT v6.1 and later Sub RenameSSHKey(lID As Lng, bstrnewname As String) Fr an example using this methd, refer t the SSH script in Script Examples. Renames an SSH Key. HRESULT RenameSSHKey( [in] LONG lid, [in] BSTR bstrnewname); Fr Each key In Server.AvailableSSHKeys If key.name = "Masha" Then Server.RenameSSHKey key.id, "Maria" End If Next Example (C#): m_server.renamesshkey(keyid, string.frmat("{0}_new", key.name)); Prperty RequireStrngPasswrds As Blean Retrieves r specifies whether strng, cmplex passwrds are required. HRESULT RequireStrngPasswrds( [ut, retval] VARIANT_BOOL *pval); HRESULT RequireStrngPasswrds( [in] VARIANT_BOOL newval); Example (VBScript) MsgBx "Cmplex passwrds fr admins: " & CStr(Server.RequireStrngPasswrds) 214

215 Interface Reference Server.RequireStrngPasswrds = False Sub RestreServerCnfiguratin(bstrFilePath As String, nlgintype As AdminLginType, bstrlgin As String, bstrpasswrd As String) Restres a backed up EFT cnfiguratin. HRESULT RestreServerCnfiguratin( [in] BSTR bstrfilepath, [in] AdminLginType nlgintype, [in] BSTR bstrlgin, [in] BSTR bstrpasswrd); Retrieve backup infrmatin with GetBackupArchiveInf. Server.RestreServerCnfiguratin "C:\lastbackup.bak", EFTLgin, "admin", "passwrd" Sub RestreServerCnfiguratinEx(pVal As CIBackupArchiveInf) Fr an example using this methd, refer t the Backup script in Script Examples. Restres EFT cnfiguratin. HRESULT RestreServerCnfiguratinEx( [in] IDispatch* pval); Retrieve backup infrmatin with GetBackupArchiveInf. Server.RestreServerCnfiguratinEx BackupSettings Sub SetCmplexPasswrdSettings(pICmplexPasswrdSettings As CICmplexPasswrdSettings) Changes cmplex passwrd settings. HRESULT SetCmplexPasswrdSettings( [in]idispatch** picmplexpasswrdsettings); Retrieves cmplex passwrd settings with GetCmplexPasswrdSettings. Set PwdSettings = Server.GetCmplexPasswrdSettings() PwdSettings.MinPasswrdLength = 8 Server.SetCmplexPasswrdSettings(PwdSettings) Sub SetHighAvailabilityParams(pdispParams As Object) HRESULT SetHighAvailabilityParams([in] IDispatch* pdispparams); EFT v7.0 and later Sub SetHighAvailabilitySettings(bEnabled As Blean, multicastaddress As String, multicastprt As Lng, cherencequeue As String, eventqueue As String, hacnfigpath As String) 215

216 EFT API Reference HRESULT SetHighAvailabilitySettings([in] VARIANT_BOOL benabled, [in] BSTR multicastaddress, [in] lng multicastprt, [in] BSTR cherencequeue, [in] BSTR eventqueue, [in] BSTR hacnfigpath, [in] BSTR failurentificatin ); EFT v7.0 and later Sub SetPGPKeyringSettings(newPublicKeyring As String, newprivatekeyring As String) Fr an example using this methd, refer t the PGP script in Script Examples. Changes OpenPGP Keyring settings. HRESULT SetPGPKeyringSettings( [in] BSTR newpublickeyring, [in] BSTR newprivatekeyring); Retrieve OpenPGP Keyring settings with GetPGPKeyringSettings. Server.SetPGPKeyringSettings "C:\PGP\pubrign.pgp", "C:\PGP\secring.pgp" Example (C#): m_server.imprtsshkey(@"c:\sshkey.pub"); bject publicpath = new bject(); bject privatepath = new bject(); m_server.getpgpkeyringsettings(ut publicpath, ut privatepath); Sub SetSSLCertificate(bzCertFilePath As String, bzkeyfilepath As String, bzpassphrase As String) Specifies the SSL certificate fr serving secure administratin cnnectins HRESULT SetSSLCertificate( [in] BSTR bzcertfilepath, // Certificate path [in] BSTR bzkeyfilepath, // Certificate private key path [in] BSTR bzpassphrase); // Certificate private key passwrd Server.SetSSLCertificate "C:\admin.crt", "C:\admin.key", "admin_passwd" EFT v6.1 and later Sub SignSSLCertificate(bstrRequest As String, bstrservcert As String, bstrprivatekey As String, bstrpass As String, bstroutcert As String, ndays As Lng) Signs an SSL certificate (Only fr PEM frmat) HRESULT SignSSLCertificate( [in] BSTR bstrrequest, [in] BSTR bstrservcert, [in] BSTR bstrprivatekey, [in] BSTR bstrpass, [in] BSTR bstroutcert, [in] LONG ndays); Functin Sites() As CISites Fr an example using this methd, refer t the ServerIPBanEntry r RemveSite script in Script Examples. 216

217 Interface Reference Retrieves a list f Sites and pen the ICISites interface. Yu can subsequently use the ICISites Item methd t retrieve a pinter t a particular Site. This methd returns a pinter t an ICISites interface. HRESULT Sites( [ut, retval] ICISites** prp); Dim Server As CIServer 'assumes the SFTPCOMInterface Type Library is referenced by the VB IDE Dim Site As CISite 'instantiates the ISite interface Dim Sites As CISites 'instantiates the ISites interface 'insert cnnectin rutines here 'nw retrieve the list f sites and then set a pinter t the first ne Set Sites = Server.Sites 'nw retrieve the list f sites in the server Set Site = Sites.Item(0) 'cntinue rest f cde... Example (C#): CISites sites = m_server.sites(); All versins Prperty SMTPAddressBk As String Retrieves r specifies a list f addresses in the SMTP address bk. HRESULT SMTPAddressBk( [ut, retval] BSTR* pval); HRESULT SMTPAddressBk( [in] BSTR newval); str list = Server.SMTPAddressBk If str list <> "" Then str list = str list + "; " End If str list = str list + NewRecipientName<SmeAddr@SmeServer.cm> Server.SMTPAddressBk = str list Prperty SMTPLgin As String Retrieves r specifies the username fr the server used by EFT fr event ntificatins, if authenticatin is required. HRESULT SMTPLgin( [ut, retval] BSTR *pval); HRESULT SMTPLgin( [in] BSTR newval); All versins Prperty SMTPPasswrd As String Retrieves r specifies the passwrd fr the server used by EFT fr event ntificatins, if authenticatin is required. HRESULT SMTPPasswrd( [ut, retval] BSTR *pval); HRESULT SMTPPasswrd( [in] BSTR newval); All versins 217

218 EFT API Reference Prperty SMTPPrt As Lng Retrieves r specifies the prt number fr cnnectin t the SMTP server used by EFT fr event ntificatins. HRESULT SMTPPrt( [ut, retval] lng *pval); HRESULT SMTPPrt( [in] lng newval); All versins Prperty SMTPRecipientAddr As String Retrieves r specifies the address f the recipient ntificatins sent by EFT. HRESULT SMTPRecipientAddr( [ut, retval] BSTR *pval); HRESULT SMTPRecipientAddr( [in] BSTR newval); All versins Prperty SMTPRecipientName As String Retrieves r specifies the administratr name fr ntificatins sent by EFT. HRESULT SMTPRecipientName( [ut, retval] BSTR *pval); HRESULT SMTPRecipientName( [in] BSTR newval); All versins Prperty SMTPSenderAddr As String Retrieves r specifies the administratr address fr ntificatins sent by EFT. HRESULT SMTPSenderAddr( [ut, retval] BSTR *pval); HRESULT SMTPSenderAddr( [in] BSTR newval); All versins Prperty SMTPSenderName As String Retrieves r specifies the Frm name used in ntificatins sent by EFT. HRESULT SMTPSenderName( [ut, retval] BSTR *pval); HRESULT SMTPSenderName( [in] BSTR newval); All versins Prperty SMTPServer As String Retrieves r specifies the address fr the server used by EFT fr sending event ntificatins. HRESULT SMTPServer( [ut, retval] BSTR *pval); HRESULT SMTPServer( [in] BSTR newval); All versins Prperty SMTPUseAuthenticatin As Blean 218

219 Interface Reference Retrieves r specifies whether the SMTP server requires authenticatin. HRESULT SMTPUseAuthenticatin( [ut, retval] VARIANT_BOOL* pval); HRESULT SMTPUseAuthenticatin( [in] VARIANT_BOOL newval); Examples (VBScript): If Server.SMTPUseAuthenticatin Then ' sme cde End If Server.SMTPUseAuthenticatin = False Prperty SSHFIPSEnabled As Blean Retrieves r specifies whether FIPS SSH is enabled. Requires EFT restart. HRESULT SSHFIPSEnabled( [ut, retval] VARIANT_BOOL* pval); HRESULT SSHFIPSEnabled( [in] VARIANT_BOOL newval); Prperty SSLFIPSEnabled As Blean Retrieves r specifies whether FIPS SSL is enabled. Requires EFT restart. HRESULT SSLFIPSEnabled( [ut, retval] VARIANT_BOOL* pval); HRESULT SSLFIPSEnabled( [in] VARIANT_BOOL newval); If Server.SSLFIPSEnabled Then MsgBx "SSL FIPS enabled" End If Server.SSLFIPSEnabled = False Prperty SSLVersinMask As Int Retrieves r specifies the SSL versin mask. HRESULT SSLVersinMask( [ut, retval] int *pval); HRESULT SSLVersinMask( [in] int newval); Dim iversinmask: iversinmask = Server.SSLVersinMask WScript.Ech "Versin Mask: " & iversinmask EFT v5.0.1 and later 219

220 EFT API Reference Sub Start() Starts the server. HRESULT Start(vid); Server.Start() Functin StartServerService(bstrHst As String) As Blean Fr an example using this prperty, refer t the Backup script in Script Examples. Starts EFT Server service. HRESULT StartServerService( [in] BSTR bstrhst, //empty string means lcalhst [ut,retval] VARIANT_BOOL* pvresult); // True=OK; False=errr If Server.StartServerService(" ") Then MsgBx "EFT Service has started. " End If Example (C#): m_server.startserverservice("lcalhst"); Prperty StartTime As Date read-nly Retrieves the date and time when EFT was started. HRESULT StartTime( [ut, retval] DATE* pval); MsgBx "Start date is " & Server.StartTime Sub Stp() Stps the server. HRESULT Stp(vid); Server.Stp() Functin StpServerService(bstrHst As String) As Blean Stps EFT Server service. HRESULT StpServerService( [in] BSTR bstrhst, //empty string means lcalhst [ut,retval] VARIANT_BOOL* pvresult); // True=OK; False=errr If Server.StpServerService(" ") Then MsgBx "EFT Service has stpped." End If 220

221 Interface Reference Functin TestCntentIntegrityCntrlPrfile(pPrfile As Object) As Blean HRESULT TestCntentIntegrityCntrlPrfile([in] IDispatch* pprfile, [ut, retval] VARIANT_BOOL* pval); EFT v7.0.3 and later Sub UnbanIP(bstrMask As String) Remves denied IP mask frm Autban list fr administratin. (Des nt remve manually banned IPs. Use RemveIPAccessRule instead.) HRESULT UnbanIP( [in] BSTR bstrmask); //mask t remve Server.UnbanIP(" ") Sub UpdateCntentIntegrityCntrlPrfile(pPrfile As Object) HRESULT UpdateCntentIntegrityCntrlPrfile([in] IDispatch* pprfile); EFT v7.0.3 and later Prperty Uptime As ULONG (read-nly) Fr an example using this prperty, refer t the ServerStats script in Script Examples. Retrieves uptime f EFT, in secnds. HRESULT Uptime( [ut, retval] ULONG* pval); MsgBx "Server up time is " & CStr(Server.Uptime) & " secnds " Example (C#): secnds = m_server.uptime; minutes = secnds / 60; //Calculate minutes secnds = secnds % 60; //leftver secnds after taking minutes ut hurs = minutes / 60; //Calculate hurs minutes = minutes % 60; //leftver minutes after taking hurs ut days = hurs / 24; //Calculate days hurs = hurs % 24; //leftver hurs after taking days ut Cnsle.WriteLine(string.Frmat("EFT Uptime: {0} day(s) {1} hur(s) {2} minute(s) {3} secnd(s)", days, hurs, minutes, secnds)); Prperty UseSSLFrAdministratin As Blean Enables r disables SSL fr the administratin scket cnnectin. Yu must restart EFT t apply changes. HRESULT UseSSLFrAdministratin( [ut, retval] VARIANT_BOOL *pval); HRESULT UseSSLFrAdministratin( [in] VARIANT_BOOL newval); All versins Prperty UseUTCInListings As Blean 221

222 EFT API Reference Retrieves r specifies whether t use UTC in directry listings r use the lcal server time. HRESULT UseUTCInListings([ut, retval] VARIANT_BOOL* pval); HRESULT UseUTCInListings([in] VARIANT_BOOL newval); True=UTC; False=lcal server time. If Server.UseUTCInListings Then ' sme cde here Else ' anther cde here End If Server.UseUTCInListings = False Dialg Bx Equivalents The ICIServer interface prperties and methds crrelate t the fllwing fields and cntrls in the EFT administratin interface. Server Administratin Methds and Prperties The illustratin f the Server nde's Administratin tab belw is labeled with sme f the methds and prperties that are available in the ICIServer interface. (Nt all methds and prperties are represented in the GUIs.) 222

223 Interface Reference Administratr Accunt Security Settings Server ARM and Lg Methds and Prperties The illustratin f the Server nde's Lgs tab belw is labeled with sme f the methds and prperties that are available in the ICIServer interface. 223

224 EFT API Reference Server General Methds and Prperties Server IP Access Rules 224

225 Interface Reference Server OpenPGP Keyring Methds and Prperties Server Security Methds and Prperties The ICIServer interface allws yu t manage the Server, including the Server's security settings. In the administratin interface, yu can view/edit these settings n the Server's Security tab. The illustratin f the Server nde's Security tab belw is labeled with sme f the methds and prperties that are available in the ICIServer interface. 225

226 EFT API Reference Server SMTP Methds and Prperties The ICIServer interface allws yu t manage the Server, including the Server's SMTP settings. The illustratins f the Server nde's SMTP tab belw is labeled with sme f the methds and prperties that are available in the ICIServer interface. Server SSH Key Manager Methds and Prperties Server SSL Certificate Settings The ICIServer interface allws yu t manage the Server's SSL Certificate fr remte administratin cnnectins. In the administratin interface, yu can access the SSL certificate settings n the Administratin tab by clicking Cnfigure next t the Require SSL fr remte administratin check bx. 226

227 Interface Reference ICISimpleCnditin - Simple Cnditin Interface The ICISimpleCnditin interface allws yu t make changes t the Event Rule Cnditin settings. (See als ICICmpundCnditin - Cmpund Cnditin Interface.) interface ICISimpleCnditin : IDispatch Prperties Prperty Nt As Blean Retrieves r specifies whether NOT is used in the Cnditin. HRESULT Nt([ut, retval] VARIANT_BOOL *pval); HRESULT Nt([in] VARIANT_BOOL newval); EFT v5.2 and later Prperty Operatr As CnditinOperatr Retrieves r specifies the cnditin peratr as CnditinOperatr. HRESULT Operatr([ut, retval] CnditinOperatr *pval); HRESULT Operatr([in] CnditinOperatr newval); EFT v5.2 and later Prperty prperty As EventPrperty read-nly Retrieve the prperty as EventPrperty. HRESULT Prperty([ut, retval] EventPrperty *pval); EFT v5.2 and later Prperty Value As Variant Retrieves r specifies the value assciated with the Cnditin. HRESULT Value([ut, retval] VARIANT *pval); HRESULT Value([in] VARIANT newval); EFT v5.2 and later ICISite - Single-Site Interface The ICISite interface represents an individual Site. (Refer t ICISites - Multi-Site Management t view/make changes t all f the Sites at nce r t create a new Site.) Fr example: Set Site = Sites.Item(0) interface ICISite : IDispatch 227

228 EFT API Reference Scrll dwn fr dialg bx equivalents. Members Prperty AccuntManagementPath As String (read nly) In the EFT administratin interface, this prperty is enabled n the Site's Cnnectin tab. Retrieves the accunt management URL at which users can reset their passwrds via HTTPS. Yu must restart the Site fr the change t take effect. (Refer t Stp and Start belw.) HRESULT AccuntManagementPath( [ut, retval] BSTR* pval); MsgBx "Accunt management ver https path is: " & CStr(Site.AccuntManagementPath) Functin AddAdvancedWrkflw(pdisplParams As Object) As Lng Adds new Advanced Wrkflw t this Site. HRESULT AddAdvancedWrkflw( [in] IDispatch* pdisplparams, // AW params // as ICIAdvancedWrkflwParams* l[ut, retval] lng* plindex);// zer-based index f created AW set AWParams = CreateObject("SFTPCOMInterface.CIAdvancedWrkflwParams")...setup wrkflw site.addadvancedwrkflw(awparams) EFT v6.5 and later Functin AddCertificateTTrusted(lID As Lng) As Lng Mves a pending certificate t trusted. HRESULT AddCertificateTTrusted( [in] lng lid, [ut, retval] lng *lnewid); 'Lp thrugh pending certificates 'and assign certificate t a client 'if the certificate cmmn name 'cincides with client's full name Fr Each pid in Site.GetPendingCertificates If Site.GetPendingCertificateInf(pID).SubjectCName = C.FullName Then tid = Site.AddCertificateTTrusted(pID) C.SetSSLAuthenticatinType "key" C.SetSSLKeyID tid End If Next All versins Sub AddIPAccessRule(bstrMask As String, ballw As Blean, nruleps As Lng) See als the fllwing interfaces: ICIAutbanIPAccessRule Interface ICIBannedIP Interface ICIIPAccessRule Interface 228

229 Interface Reference ICIManualIPAccessRule Interface Adds allwed r denied IP mask fr the Site. HRESULT AddIPAccessRule( [in] BSTR bstrmask, [in] VARIANT_BOOL ballw, [in] lng nruleps); Site.AddIPAccessRule(" ", false, 2) All versins Sub AddUserTPermissinGrup(bstrUser As String, bstrgrup As String) Adds a user t a permissin grup. HRESULT AddUserTPermissinGrup( [in] BSTR bstruser, [in] BSTR bstrgrup); All versins Prperty AdvancedWrkflwsCunt As Lng Retrieves the ttal cunt f site's Advanced Wrkflws. HRESULT AdvancedWrkflwsCunt([ut, retval] lng* plvalue); If Site.AdvancedWrkflwsCunt = 0 Then Site has n Advanced Wrkflws End If EFT v6.5 and later Prperty AllwChangePasswrd As Blean Allws yu t Retrieves r specifies whether Site users are allwed t change their passwrds. The value can be verridden at the Settings Template r user accunt level. HRESULT AllwChangePasswrd( [ut, retval] VARIANT_BOOL *pval); HRESULT AllwChangePasswrd( [in] VARIANT_BOOL val); Examples (VBScript): If Site.AllwChangePasswrd Then Site.FrcePasswrdResetOnInitialLgin = True End If If Site.AllwChangePasswrd = False EFT v6.2 and later Prperty Allw LginCredentials As Blean Retrieves r specifies whether allw lgin credentials t be sent in s. If Allw LginCredentials is enabled, LginCredentialsMde retrieves hw they are sent (username and passwrd in the same , separate s, r username nly). HRESULT Allw LginCredentials( [ut, retval] VARIANT_BOOL* pval); 229

230 EFT API Reference HRESULT Allw LginCredentials( [in] VARIANT_BOOL newval); TRUE= lgin credentials; FALSE=D nt lgin credentials if False = Site.Allw LginCredentials then MsgBx "Disabled" End If Site.Allw LginCredentials = True Prperty AllwUPVariables As Blean Retrieves r specifies whether t allw username and passwrds credentials as variables in Event Rules. HRESULT AllwUPVariables( [ut, retval] VARIANT_BOOL* pval); HRESULT AllwUPVariables( [in] VARIANT_BOOL newval); if False = Site.AllwUPVariables then MsgBx "Disabled" End If Site.AllwUPVariables = True Prperty AS2AccuntManagementPath As String (read nly) Retrieves URL fr AS2 accunt management. HRESULT AS2AccuntManagementPath( [ut, retval] BSTR* pval); MsgBx "AS2 management path is: " & Site.AS2AccuntManagementPath Prperty AS2Certificate As String Retrieves r specifies AS2 certificate path. HRESULT AS2Certificate( [ut, retval] BSTR* pval); HRESULT AS2Certificate( [in] BSTR newval); MsgBx "AS2 certificate is: " & Site.AS2Certificate 230

231 Interface Reference Site.AS2Certificate = "C:\MyCerts\AS2Cert.crt" Prperty AS2Identifier As String Retrieves r specifies the AS2 identifier. HRESULT AS2Identifier( [ut, retval] BSTR* pval); HRESULT AS2Identifier( [in] BSTR newval); MsgBx "AS2 identifier is: " & Site.AS2Identifier Site.AS2Identifier = "my_as2_id" Prperty AS2Passphrase As String Retrieves r specifies the AS2 passphrase. HRESULT AS2Passphrase( [ut, retval] BSTR* pval); HRESULT AS2Passphrase( [in] BSTR newval); MsgBx "AS2 passphrase is: " & Site.AS2Passphrase Site.AS2Passphrase = "new_passphrase" Prperty AS2PrivateKey As String Retrieves r specifies the AS2 private key. HRESULT AS2PrivateKey( [ut, retval] BSTR* pval); HRESULT AS2PrivateKey( [in] BSTR newval); MsgBx "AS2 certificate is: " & Site.AS2PrivateKey Site.AS2PrivateKey = "C:\MyCerts\AS2Cert.crt" Sub AssignEventRuleCustmCmmandWrkingFlder(bstrCustmCmmandName As String, bstrwrkingflder As String) Updates all instances f a given custm cmmand in the event rule list t have a specified wrking flder. 231

232 EFT API Reference HRESULT AssignEventRuleCustmCmmandWrkingFlder( [in] BSTR bstrcustmcmmandname, [in] BSTR bstrwrkingflder); Dim strcmmandname: strcmmandname = "RunScript" Dim strnewwrkingflder: strnewwrkingflder = "C:\Script\flder" Site.AssignEventRuleCustmCmmandWrkingFlder(strCmmandName, strnewwrkingflder) EFT v4.3.4 and later Prperty AssignFullPermissinsFrHmeFlder As Blean In the EFT administratin interface, this prperty is enabled n the Site's Security tab, in the Accunt Security area. Retrieves whether new users have full permissins in their hme flders, and t either grant r deny users full permissins t their hme flders. True = Granted (check bx selected); False = Denied (check bx cleared). The AutCreateHmeFlder prperty must be set t TRUE befre yu can use this prperty. If yu d nt grant users full permissins t their hme flders, they will inherit permissins frm their grups. HRESULT AssignFullPermissinsFrHmeFlder( [ut, retval] VARIANT_BOOL *pval); [in] VARIANT_BOOL newval); All versins Prperty AutBanIPsPermanently As Blean Retrieves r specifies whether t autmatically ban IP addresses permanently. HRESULT AutBanIPsPermanently( [ut, retval] VARIANT_BOOL *pval); HRESULT AutBanIPsPermanently( [in] VARIANT_BOOL newval); True=Permanently; False=Temprarily All versins Prperty AutbanSensitivity As AutbanSensitivity Retrieves r specifies autban sensitivity. HRESULT AutbanSensitivity( [ut, retval] AutbanSensitivity *pval); HRESULT AutbanSensitivity( [in] AutbanSensitivity newval); : If Site.AutbanSensitivity <> SensitivityOff Then MsgBx "Fld/Hammer Autban is n fr the site" End If Site.AutbanSensitivity = SensitivityVeryHigh EFT v6.1 and later Prperty AutCreateHmeFlder As Blean 232

233 Interface Reference In the EFT administratin interface, this prperty is enabled n the Site's Security tab, in the Accunt Security area. Retrieves whether the Site will autmatically create a hme flder fr users, and t either enable r disable the autmatic flder creatin. HRESULT AutCreateHmeFlder( [ut, retval] VARIANT_BOOL *pval); [in] VARIANT_BOOL newval); True = Enabled; False = Disabled The AutCreateHmeFlder prperty must be set t TRUE befre yu can use the AssignFullPermissinsFrHmeFlder prperty. If yu d nt grant users full permissins t their hme flders, they will inherit permissins frm their grups. All versins Prperty AverageSpeed As Lng (read nly) Retrieves the average uplad/dwnlad speed n the Site. HRESULT AverageSpeed( [ut, retval] LONG* pval); MsgBx "Average speed: " & CStr(Site.AverageSpeed) Prperty BanIPFrInvalidLginAttempts As Blean When banning an IP address fr invalid lgin attempts, specify whether t cunt incrrect username and crrect username + incrrect passwrd r nly incrrect username attempts. HRESULT BanIPFrInvalidLginAttempts( [ut, retval] VARIANT_BOOL* pval); HRESULT BanIPFrInvalidLginAttempts( [in] VARIANT_BOOL newval); TRUE = Cunt bth 'incrrect username' and 'crrect username + incrrect passwrd' FALSE = Cunt nly incrrect username attempts EFT v6.4 and later Prperty BanIPFrInvalidLginAttemptsWithExistingUsername As Blean Retrieves r specifies whether t ban an IP address after excessive invalid lgin attempts with existing username and wrng passwrd. HRESULT BanIPFrInvalidLginAttemptsWithExistingUsername( [ut, retval] VARIANT_BOOL* pval); HRESULT BanIPFrInvalidLginAttemptsWithExistingUsername( [in] VARIANT_BOOL newval); EFT v6.4 and later Prperty BanIPOnDOS As Blean Retrieves r specifies whether t ban an IP address after excessive invalid cmmands. HRESULT BanIPOnDOS( [ut, retval] VARIANT_BOOL *pval); HRESULT BanIPOnDOS( [in] VARIANT_BOOL newval); True=Enabled; False=Disabled 233

234 EFT API Reference All versins Prperty BlckAntiTimeOut As Blean Retrieves r specifies whether t blck anti-timeut schemes (NOOP). HRESULT BlckAntiTimeOut( [ut, retval] VARIANT_BOOL *pval); HRESULT BlckAntiTimeOut( [in] VARIANT_BOOL newval); True = Blcked; False = Allwed All versins Prperty BlckSiteTSite As Blean Retrieves r specifies whether t blck Site-t-Site (FXP) transfers. HRESULT BlckSiteTSite( [ut, retval] VARIANT_BOOL *pval); HRESULT BlckSiteTSite( [in] VARIANT_BOOL newval); True = Blcked; False = Allwed All versins Functin CancelTransfer(bstrPath As String) As Blean Clse all HTTP sckets that uplad/dwnlad (including POST uplad) a file specified by the path parameter. Nte that this is nt effective fr FTP r SFTP. HRESULT CancelTransfer( [in] BSTR bstrpath, [ut, retval] VARIANT_BOOL *psuccess); EFT v4.3.4 and later Sub ChangeUserPasswrd(bstrUser As String, bstrpwd As String, npwdtype As Int) Changes a user's passwrd and passwrd type. HRESULT ChangeUserPasswrd( [in] BSTR bstruser, [in] BSTR bstrpwd, [in] int npwdtype); PwdType 0 = Regular (hashed) 1 = Annymus (regular with empty passwrd) 2 = Annymus (require as passwrd) 3 = OTP-MD4 4 = OTP-MD5 5 = Literal (n hash) - Fr use when imprting shadw passwrds frm a *nix passwrd file. The frmat must fllw: $1$*$* Fr example, user: test, passwrd: test wuld be: site.changeuserpasswrd "test", "$1$Bn3YdWKv$.BS3Qb2UQTV4SmV1JNN.w/", 5 DES-frmat passwrds are nt supprted. These are passwrd frmats withut the salt defined, that is, withut the $1$. All versins Prperty CnnectedUsers As Variant (read nly) See als ICICnnectedUser - Cnnected User Interface. Retrieves an array f users currently cnnected t the Site. 234

235 Interface Reference HRESULT CnnectedUsers( [ut, retval] VARIANT* pval); Fr Each u In Site.CnnectedUsers MsgBx "User: " & u.lgin Next Prperty CnnectMessage As String Retrieves r specifies the cnnect message. HRESULT CnnectMessage([ut, retval] BSTR *pval); HRESULT CnnectMessage([in] BSTR newval); All versins Functin CreateCmmand(bstrName As String) As CICmmandSettings Creates a new cmmand. HRESULT CreateCmmand( [in] BSTR bstrname, [ut, retval] ICICmmandSettings **prp); All versins Functin CreateCmplexPasswrd([bstrUserName]) As String Creates a cmplex passwrd that meets the cmplexity criteria specified fr the site. HRESULT CreateCmplexPasswrd( [in, ptinal] VARIANT bstrusername, [ut, retval] BSTR *bstrpasswrd); The fllwing example generates a passwrd that adheres t the cmplexity plicy enfrced fr an existing user: Dim strnewpasswrd strnewpasswrd = UserSettings.CreateCmplexPasswrd("test") WScript.Ech "New Passwrd: " strnewpasswrd Call UserSettings.ChangeUserPasswrd("test", strnewpasswrd, 1) This example illustrates hw t btain a passwrd frm the Server that meets the cmplexity requirements fr the Settings Template that is cnfigured as the default fr the Site, which is useful when creating new users: Dim strnewpasswrd strnewpasswrd = UserSettings.CreateCmplexPasswrd() WScript.Ech "New Passwrd: " strnewpasswrd Call UserSettings.CreateUser("test", strnewpasswrd, 0, "New User Descriptin") EFT v5.0.1 and later Functin CreateCmplexPasswrdEx([bstrUserName], [bstrsettingslevel]) As String Creates a cmplex passwrd that meets the cmplexity criteria specified fr the Settings Template. HRESULT CreateCmplexPasswrdEx( [in, ptinal] VARIANT bstrusername, [in, ptinal] VARIANT bstrsettingslevel, [ut, retval] BSTR *bstrpasswrd); 235

236 EFT API Reference strpass = Site.CreateCmplexPasswrdEx("","") Sub CreatePermissinGrup(bstrName As String) Creates a new permissin grup. HRESULT CreatePermissinGrup( [in] BSTR bstrname); All versins Permissin Grups cntrl user access t files and flders. Sub CreatePhysicalFlder(bstrNewFlder As String) Given a relative path, creates a new physical flder. (Use frward slashes instead f back slashes.) HRESULT CreatePhysicalFlder( [in] BSTR bstrnewflder); Call Object.CreatePhysicalFlder("/flderpath/") 'anther example: MySite.CreatePhysicalFlder("/Usr/jsmith/") 'Nte that backslashes "\" will nt wrk: MySite.CreatePhysicalFlder("\Usr\jsmith\") <--will fail! All versins Sub CreateSettingsLevel(bstrName As String, bstrdescriptin As String), [bsetasdefault As Blean = 0]) Creates a Settings Template. The "BOOL bmakedefault" parameter allws yu t specify whether the new Settings Template is the default template. When the "BOOL bmakedefault" parameter is nt used, the Settings Template is nt made the default. HRESULT CreateSettingsLevel( [in] BSTR bstrname, [in] BSTR bstrdescriptin), [IN] BOOL bmakedefault); All versins Sub CreateUser(bstrLgin As String, bstrpwd As String, npwdtype As Int, bstrdescriptin As String, [abtwfactrauthenticatin As SFTPAdvBl = -2]) The CreateUser methd will fail if a simple passwrd is prvided when enfrce cmplex passwrds is enabled in EFT. Fr example, the fllwing will fail if enfrce cmplex passwrds is enabled in EFT: Site.CreateUser "tuser1", "testpasswrd", 0 "New User" Fr the methd t wrk, yu must d ne f the fllwing: Disable enfrcement f cmplex passwrds. Prvide a cmplex passwrd. Fr example: Site.CreateUser "test", "$1$Bn3YdWKv$.BS3Qb2UQTV4SmV1JNN.w/", 0, "New User" Call the CreateCmplexPasswrd methd and use the resulting string in the CreateUser methd. Fr example (in pseud cde): struserpass = UserSettings.CreateCmplexPasswrd() Site.CreateUser "test", struserpass, 0, "New User" See als: Difference between VARIANT_BOOL and SFTPAdvBl 236

237 Interface Reference Creates a user with the default values. (The CreateUser methd creates users with the default values.) HRESULT CreateUser( [in] BSTR bstrlgin, [in] BSTR bstrpwd, [in] int npwdtype, [in] BSTR bstrdescriptin, [in, defaultvalue(abinherited)] SFTPAdvBl abtwfactrauthenticatin); SFTPAdvBl abinherited = -2 (&HFFFFFFFE) abfalse = 0 abtrue = 1 PwdType 0 = Regular (hashed) 1 = Annymus (regular with empty passwrd) 2 = Annymus (require as passwrd) 3 = OTP-MD4 4 = OTP-MD5 5 = Literal (n hash) - Fr use when imprting shadw passwrds frm a *nix passwrd file. The frmat must fllw: $1$*$* Fr example, user: test, passwrd: test wuld be: site.changeuserpasswrd "test", "$1$Bn3YdWKv$.BS3Qb2UQTV4SmV1JNN.w/", 5 DES-frmat passwrds are nt supprted. These are passwrd frmats withut the salt defined, that is, withut the $1$. All versins Sub CreateUserEx(bstrLgin As String, bstrpwd As String, npwdtype As Int, bstrdescriptin As String, bstrfullname As String, bcreatehmeflder As Blean, bfullpermissinsfrhmeflder As Blean, [bstrsettingslevel As String], [abtwfactrauthenticatin As SFTPAdvBl = -2]) See als: Difference between VARIANT_BOOL and SFTPAdvBl Fr an example using this methd, refer t the CreateUsers script in Script Examples. The CreateUserEx methd will fail if a simple passwrd is prvided when enfrce cmplex passwrds is enabled in EFT. Fr example, the fllwing will fail if enfrce cmplex passwrds is enabled in EFT: Site.CreateUserEx "tuser1", "testpasswrd", 0 "New User" Fr the methd t wrk, yu must d ne f the fllwing: Disable enfrcement f cmplex passwrds. Prvide a cmplex passwrd. Fr example: Site.CreateUserEx "test", "$1$Bn3YdWKv$.BS3Qb2UQTV4SmV1JNN.w/", 0, "New User" Call the CreateCmplexPasswrd methd and use the resulting string in the CreateUserEx methd. Fr example (in pseud cde): struserpass = UserSettings.CreateCmplexPasswrd() Site.CreateUserEx "test", struserpass, 0, "New User" Creates a user and allws yu t set values fr all parameters. (The CreateUserEx methd allws yu t set values fr all parameters.) HRESULT CreateUserEx( [in] BSTR bstrlgin, 237

238 EFT API Reference [in] BSTR bstrpwd, [in] int npwdtype, [in] BSTR bstrdescriptin, [in] BSTR bstrfullname, [in] VARIANT_BOOL bcreatehmeflder, [in] VARIANT_BOOL bfullpermissinsfrhmeflder, [in, ptinal] BSTR bstrsettingslevel, [in, defaultvalue(abinherited)] SFTPAdvBl abtwfactrauthenticatin); SFTPAdvBl abinherited = -2 (&HFFFFFFFE) abfalse = 0 abtrue = 1 PwdType 0 = Regular (hashed) 1 = Annymus (regular with empty passwrd) 2 = Annymus (require as passwrd) 3 = OTP-MD4 4 = OTP-MD5 5 = Literal (n hash) - Fr use when imprting shadw passwrds frm a *nix passwrd file. The frmat must fllw: $1$*$* Fr example, user: test, passwrd: test wuld be: site.changeuserpasswrd "test", "$1$Bn3YdWKv$.BS3Qb2UQTV4SmV1JNN.w/", 5 Example (C#): DES-frmat passwrds are nt supprted. These are passwrd frmats withut the salt defined, that is, withut the $1$. selectedsite.createuserex(j.tstring(),j.tstring(),0,j.tstring(),j.tstring(),tru e, false,"default settings", SFTPAdvBl.abFalse); All versins Sub CreateUserEx2(pdispParams As Object) Refer t ICINewUserData Interface fr details. Creates a new user and includes all f the user/client details, including the address; ensures that the address is available if an Event Rules is cnfigured t send an t the user. HRESULT CreateUserEx2 ([in] IDispatch* pdispparams); EFT v6.3.8 and later Sub CreateVirtualFlder(bstrNewFlder As String, bstrtarget As String) Given a relative path and a physical target path, creates a new virtual flder. HRESULT CreateVirtualFlder( [in] BSTR bstrnewflder, [in] BSTR bstrtarget), [in, defaultvalue(-1)] VARIANT_BOOL bchecktarget); (This was added fr 6.3.8) Call Site.CreateVirtualFlder("/pub/temp/", "C:\Temp\") All versins Prperty DataSanitizatinMethd As DataSanitizatinMethd Retrieves r specifies the data sanitizatin methd. HRESULT DataSanitizatinMethd( 238

239 Interface Reference [ut, retval] DataSanitizatinMethd* pval); HRESULT DataSanitizatinMethd( [in] DataSanitizatinMethd newval); if DataSanitizatinNWipe = Site.DataSanitizatinMethd then MsgBx "N wipe methd is specified" End If Site.DataSanitizatinMethd = DataSanitizatinPseudrandmData Sub DecryptFlder(bstrFlder As String, vbresursively As Blean) Specifies whether t decrypt a flder. HRESULT DecryptFlder( [in] BSTR bstrflder, [in] VARIANT_BOOL vbresursively); Site.DecryptFlder "/sme_flder", True Prperty DefaultPGPKeyID As String (read-nly) See als SetDefaultPGPKey Retrieves the default PGP Key ID r empty string if Site has nt default key. HRESULT DefaultPGPKeyID( [ut, retval] BSTR* pval); EFT v6.4 and later Prperty DefaultPGPKeyPassphrase As String (read-nly) See als SetDefaultPGPKey Retrieves the default PGP Key passphrase. HRESULT DefaultPGPKeyPassphrase( [ut, retval] BSTR* pval); EFT. v6.4 and later Prperty DefaultSettingsLevel as String Retrieves r specifies which template is currently selected as the default. HRESULT DefaultSettingsLevel( [ut, retval] BSTR* bstrname); HRESULT DefaultSettingsLevel( [in] BSTR bstrname); EFT v6.6 and later Sub DisableInheritPermissins(bstrFlder As String, bremveperm As Blean) Disable Inherit permissins n a specified flder. 239

240 EFT API Reference HRESULT DisableInheritPermissins( [in] BSTR bstrflder, [in] VARIANT_BOOL bremveperm); TRUE=Disabled; FALSE=Enabled Site.DisableInheritPermissins "/sme_flder", False Sub DisableSFTP() Disables SFTP access n the Site. HRESULT DisableSFTP(vid); EFT v6.1 and later Prperty DiscnnectOnDOS As Blean Retrieves r specifies whether t discnnect a user after a certain number f invalid cmmands. HRESULT DiscnnectOnDOS( [ut, retval] VARIANT_BOOL *pval); HRESULT DiscnnectOnDOS( [in] VARIANT_BOOL newval); True=Enabled; False=Disabled All versins Prperty DMZCnnected As Blean (read nly) Retrieves whether the Site is cnnected t DMZ Gateway. HRESULT DMZCnnected( [ut, retval] VARIANT_BOOL* pval); if True = Site.DMZCnnected then MsgBx "DMZ is cnnected." else MsgBx DMZ is nt cnnected. end if Prperty DMZGateway As Object read-nly Retrieves the prperties f the DMZ Gateway with CIDMZGateway. HRESULT DMZGateway( [ut, retval] IDispatch** prp); Set DMZ = Site.DMZGateway Functin DesUsernameExist(bstrUserName As String) As Blean Retrieves r specifies whether a username exists. HRESULT DesUsernameExist( [in] BSTR bstrusername, [ut, retval] VARIANT_BOOL *bexist); 240

241 Interface Reference True=Exists; False=Des nt exist Prperty DOSLimit As Lng Retrieves r specifies the number f cnsecutive invalid cmmands that will cause the Site t discnnect a user. HRESULT DOSLimit( [ut, retval] lng *pval); HRESULT DOSLimit( [in] lng newval); All versins Prperty LginCredentialsMde As LginCredentialsMde If Allw LginCredentials is enabled, LginCredentialsMde retrieves hw they are sent (username and passwrd in the same , separate s, r username nly). HRESULT LginCredentialsMde( [ut, retval] LginCredentialsMde* pval); HRESULT LginCredentialsMde( [in] LginCredentialsMde newval); if CredentialsBth = Site. LginCredentialsMde then MsgBx "Username and passwrd tgether." End If Site. LginCredentialsMde = CredentialsUsernameOnly Prperty EnableAccuntManagementOverHTTPS As Blean (The Accunt Management (change passwrd) page is nt available when CAC is enabled.) Retrieves r specifies whether accunt management ver HTTPS is enabled. Yu must restart the Site fr the change t take effect. (Refer t Stp and Start belw.) HRESULT EnableAccuntManagementOverHTTPS( [ut, retval] VARIANT_BOOL* pval); HRESULT EnableAccuntManagementOverHTTPS( [in] VARIANT_BOOL newval); True = Enabled; False = Disabled MsgBx "AS2 managing ver https is enabled: " & CStr(Site.EnableAccuntManagementOverHTTPS) Site.EnableAccuntManagementOverHTTPS = True Prperty EnableAS2 As Blean Retrieves r specifies whether AS2 is enabled n the Site. 241

242 EFT API Reference HRESULT EnableAS2( [ut, retval] VARIANT_BOOL* pval); HRESULT EnableAS2( [in] VARIANT_BOOL newval); True = Enabled; False = Disabled if False = Site.EnableAS2 then MsgBx "Disable" else MsgBx "Remve" end if Site.EnableAS2 = True Prperty EnableCAC As Blean (The Accunt Management (change passwrd) page is nt available when CAC is enabled.) Retrieves r specifies whether CAC is enabled n the Site. (Cmmn Access Card (CAC) Authenticatin is available in EFT Enterprise with the High Security mdule n LDAP Sites with SSL (HTTPS r FTPS) enabled.) HRESULT EnableCAC([ut, retval] VARIANT_BOOL* pval); HRESULT EnableCAC([in] VARIANT_BOOL newval); EFT v6.4.3 and later Sub EnableInheritPermissins(bstrFlder As String, bremveperm As Blean) Enables Inherit permissins n a specified flder. HRESULT EnableInheritPermissins( [in] BSTR bstrflder, [in] VARIANT_BOOL bremveperm); TRUE=Enabled; FALSE=Disabled Site.EnableInheritPermissins "/sme_flder", False Prperty EnableMTC As Blean Enables MTC n a Site. HRESULT EnableMTC([ut, retval] VARIANT_BOOL* pval); HRESULT EnableMTC([in] VARIANT_BOOL newval); EFT v and later Prperty EnablePasswrdHistry As Blean Retrieves r specifies whether passwrd histry is enabled. HRESULT EnablePasswrdHistry([ut, retval] VARIANT_BOOL* pval); HRESULT EnablePasswrdHistry([in] VARIANT_BOOL newval); TRUE=Passwrd histry is enabled; FALSE=Passwrd histry is nt enabled. 242

243 Interface Reference if False = Site.EnablePasswrdHistry then MsgBx "Passwrd histry is disabled" End If Site.EnablePasswrdHistry = True Prperty EnablePGPLgging As Blean Retrieves r specifies whether OpenPGP lgging is enabled. HRESULT EnablePGPLgging( [ut, retval] VARIANT_BOOL* pval); HRESULT EnablePGPLgging( [in] VARIANT_BOOL newval); TRUE=Enabled; FALSE=Disabled MsgBx "PGP lgging: " & CStr(Site.EnablePGPLgging) Site.EnablePGPLgging = False Prperty EnablePrtRange As Blean Retrieves r specifies whether t enable the PASV prt range. HRESULT EnablePrtRange( [ut, retval] VARIANT_BOOL *pval); [in] VARIANT_BOOL newval); True = Enabled; False = Disabled All versins Sub EnableSFTP(SFTPKeyFile As String, SFTPKeyPassphrase As String) Enables SFTP access n the Site. Specify the SFTPKeyFile and SFTPKeyPassphrase. HRESULT EnableSFTP( BSTR SFTPKeyFile, BSTR SFTPKeyPassphrase); EFT v6.1 and later Prperty EnableWebServices As Blean Retrieves r specifies whether Web Services is enabled. Yu must restart the Site fr the change t take effect. (Refer t Stp and Start belw.) HRESULT EnableWebServices( [ut, retval] VARIANT_BOOL* pval); HRESULT EnableWebServices( [in] VARIANT_BOOL newval); True = Enabled; False = Disabled 243

244 EFT API Reference MsgBx "SFTP prt: " & CStr(Site.SFTPPrt) Site.SFTPPrt = 40 Sub EncryptFlder(bstrFlder As String, vbresursively As Blean) Specifies whether flder is encrypted. HRESULT EncryptFlder( [in] BSTR bstrflder, [in] VARIANT_BOOL vbresursively); Site.EncryptFlder "/sme_flder", True Functin EventRules(type As EventType) As Object Fr an example using this methd, refer t the EventRuleCreatin script in Script Examples. Retrieves the list f Event Rules f a certain type (e.g., all Timer Event Rules). HRESULT EventRules( [in] EventType type, [ut, retval] IDispatch** ppdisprules); Set timerrules = site.eventrules (&H1001) 'Retrieve all the Timer event rules Example (C#): CIEventRules rules = (CIEventRules)site.EventRules(EventType.MnitrFlder); EFT v5.2 and later Prperty ExitMessage As String Retrieves r specifies exit message. HRESULT ExitMessage( [ut, retval] BSTR *pval); HRESULT ExitMessage( [in] BSTR newval); All versins Functin ExprtTrustedCertificate(lID As Lng) As String Exprts a trusted certificate. HRESULT ExprtTrustedCertificate( [in] lng lid, [ut, retval] BSTR *bstrcertdata); All versins Prperty FrcePasswrdResetOnInitialLgin As Blean Retrieves r specifies whether the ptin t frce users t change their passwrd upn next lgin is turned n. The value can be verridden in the Settings Template r user accunt by the ICIClientSettings::SetChangePwd methd. If the ptin is ON, it des nt mean the user will be necessary frced t change passwrd n next lgin, because the user s passwrd might have been changed since yu switched the ptin frm OFF t ON in the administratin interface. HRESULT FrcePasswrdResetOnInitialLgin( 244

245 Interface Reference [ut, retval] VARIANT_BOOL *pval); HRESULT FrcePasswrdResetOnInitialLgin( [in] VARIANT_BOOL val); If Nt Site.FrcePasswrdResetOnInitialLgin Then MsgBx "Reset passwrd is turned ff fr this site" End If Site.FrcePasswrdResetOnInitialLgin = False Site.FrcePasswrdResetOnInitialLgin = True 'switching frm OFF t ON 'will frce all users t 'change passwrd n next lgin '(if nt verridden at lwer levels) EFT v6.2 and later Sub FrceSynchrnizeUserDatabase() Launches (asynchrnusly) the user database synchrnizatin thread in EFT (equivalent t clicking View > Refresh User Database). This methd des nt change the client's COM bject. Yu must use the methd Server.RefreshSettings after waiting a suitable amunt f time fr the database synchrnizatin t cmplete. HRESULT FrceSynchrnizeUserDatabase(); All versins Prperty FTPEncding as string Refer t TransferEncdingType in the Enum Reference. Retrieves r specifies the transfer encding mde fr FTP and FTPS. TransferEncdingUTF8 and TransferEncdingASCII are the nly valid values fr this prperty. HRESULT FTPEncding([ut, retval] TransferEncdingType* pval); HRESULT FTPEncding([in] TransferEncdingType newval); If Site.FTPEncding = 2 Then ASCII mde End If set ASCII mde fr SFTP Site.FTPEncding = 2 EFT v6.5 and later Prperty FTPSExplicitPrt As Lng Retrieves FTPS explicit prt. Yu must restart the Site fr the change t take effect. (Refer t Stp and Start belw.) HRESULT FTPSExplicitPrt( [ut, retval] LONG* pval); HRESULT FTPSExplicitPrt( [in] LONG newval); 245

246 EFT API Reference MsgBx "FTPS explicit prt: " & CStr(Site.FTPSExplicitPrt) Site.FTPSExplicitPrt = 40 Prperty FTPSImplicitPrt As Lng Retrieves FTPS implicit prt. Yu must restart the Site fr the change t take effect. (Refer t Stp and Start belw.) HRESULT FTPSImplicitPrt( [ut, retval] LONG* pval); HRESULT FTPSImplicitPrt( [in] LONG newval); MsgBx "FTPS implicit prt: " & CStr(Site.FTPSImplicitPrt) Site.FTPSImplicitPrt = 40 Functin GetAdvancedWrkflwIndex (bzname As String) As Lng Retrieves the zer-based index f the Advanced Wrkflw with the given name. HRESULT GetAdvancedWrkflwIndex( [in] BSTR bzname, // AW name [ut, retval] lng* plindex); // zer-based index f the AW // r -1 if nt fund Example (VBScript idxaw = site.getadvancedwrkflwindex( My Wrkflw ) if idxaw -1 Then Wrk with wrkflw via its index End If EFT v6.5 and later Functin GetAdvancedWrkflwParams(lIndex As Lng) As Object (See als SetAdvancedWrkflwParams) Given Advanced Wrkflw zer-based index, retrieves the Wrkflw's parameters. HRESULT GetAdvancedWrkflwParams([in] lng lindex, [ut, retval] IDispatch** ppdisplparams); Display the name in message fr each wrkflw Fr idxaw = 0 t site.advancedwrkflwscunt - 1 Set AWparams = site.getadvancedwrkflwparams(idxaw) MsgBx AWparams.Name Next EFT v6.5 and later Functin GetAllwCOMB() As Blean 246

247 Interface Reference (Fr infrmatin abut using the COMB cmmand with EFT, refer t Allwing Multipart Transfers (COMB Cmmand) in the EFT User Guide.) Fr an example using this methd, refer t the CnfigureSite script in Script Examples. Retrieves whether users n the Site are allwed t send the COMB cmmand fr multipart transfers. HRESULT GetAllwCOMB([ut, retval] VARIANT_BOOL *pval); True = Enabled; False = Disabled if False = Site.GetAllwCOMB() then MsgBx "Disallwed" end if Example (C#): if (selectedsite.getallwcomb()) Functin GetAllwFXP() As Blean Fr an example using this methd, refer t the CnfigureSite script in Script Examples. Retrieves whether users n the Site are allwed t perfrm site-t-site (FXP) transfers. HRESULT GetAllwFXP([ut, retval] VARIANT_BOOL *pval); True = Enabled; False = Disabled if False = Site.GetAllwFXP() then MsgBx "Disallwed" end if Example (C#): if (selectedsite.getallwfxp()) Functin GetAllwNp() As Blean Retrieves whether users n the Site are allwed t use the NOOP cmmand t keep a cnnectin pen. HRESULT GetAllwNp([ut, retval] VARIANT_BOOL *pval); True = Enabled; False = Disabled if False = Site.GetAllwNp() then MsgBx "Disallwed" end if All versins Functin GetAllwXCRC() As Blean Retrieves whether users n the Site are allwed t send the XCRC cmmands t cnfirm successful transfer. HRESULT GetAllwXCRC([ut, retval] VARIANT_BOOL *pval); True = Enabled; False = Disabled 247

248 EFT API Reference if False = Site.GetAllwXCRC() then MsgBx "Disallwed" end if All versins Functin GetAMParams() As Object Fr an example using this methd, refer t the Windws Authenticatin script in Script Examples. Retrieves authenticatin manager (AM) parameters. HRESULT GetAMParams( [ut,retval] IDispatch** pval) Set AMParams = Site.GetAMParams() Functin GetAS2Transactins(vbShwSuccesses As Blean, vbshwfailures As Blean, vbshwinprgress As Blean, bstrmessageidfilter As String, bstrfilenamefilter As String, llastdays As Lng) As Variant Retrieves AS2 transactins. HRESULT GetAS2Transactins( [in] VARIANT_BOOL vbshwsuccesses, [in] VARIANT_BOOL vbshwfailures, [in] VARIANT_BOOL vbshwinprgress, [in] BSTR bstrmessageidfilter, [in] BSTR bstrfilenamefilter, [in] LONG llastdays, [ut,retval] VARIANT* ptransinf); Fr Each trans In Site.GetAS2Transactins(True, True, True, "*", "*", 7) MsgBx "Transactin id: " & trans.transactinid Next Functin GetAuthManagerID() As Lng Retrieves the Site's authenticatin manager ID (GS Auth, NT/AD, r ODBC). HRESULT GetAuthManagerID( [ut, retval] lng *prp); All versins Functin GetAwaitingCertsPath() As String Retrieves the Awaiting Certificate file path. HRESULT GetAwaitingCertsPath( [ut, retval] BSTR *prp); All versins Functin GetBlankPermissin(bstrFlder As String, bstrclient As String) As Permissin After yu have defined the permissins, yu must use the SetPermissn methd t apply the changes yu have made. Given Flder and Client creates a blank permissin. 248

249 Interface Reference HRESULT GetBlankPermissin( [in] BSTR bstrflder, [in] BSTR bstrclient, [ut, retval] IPermissin **ppermissin); All versins Functin GetCertFilePath() As String Retrieves the Site certificate file path. HRESULT GetCertFilePath( [ut, retval] BSTR *prp); All versins Functin GetCheckClientCert() As Blean Determines if the server requires certificates frm users cnnecting via implicit SSL. If the Server requires certificates, the GetCheckClientCert methd returns a value f TRUE. HRESULT GetCheckClientCert( [ut, retval] VARIANT_BOOL *prp); All versins Functin GetCmmands() As Variant Retrieves an array f cmmand names. HRESULT GetCmmands( [ut, retval] VARIANT *acmmands); All versins Functin GetCmmandSettings(bstrCmmand As String) As CICmmandSettings Given a cmmand name retrieves its settings. HRESULT GetCmmandSettings( [in] BSTR bstrcmmand, [ut, retval] ICICmmandSettings **prp); All versins Functin GetCmplexPasswrdSettings() As Object Retrieve cmplex passwrd settings HRESULT GetCmplexPasswrdSettings( [ut, retval] IDispatch** ppicmplexpasswrdsettings); (v ) Set PwdSettings = Site.GetCmplexPasswrdSettings() Functin GetCnnectedCunt() As Lng Retrieves number f users cnnected t the Site. HRESULT GetCnnectedCunt( [ut, retval] lng* prp); All versins Functin GetCnnectedUsers() As Variant Retrieves an array f cnnected users. HRESULT GetCnnectedUsers([ut, retval] VARIANT* pval); 249

250 EFT API Reference dim arcnnectedusers: Site.GetCnnectedUsers() Fr icunt = LBund(arCnnectedUsers) T UBund(arCnnectedUsers) WScript.Ech arcnnectedusers(icunt) Next EFT v4.3.4 and later Functin GetDwnladCunt() As Lng Retrieves the number f active dwnlads. HRESULT GetDwnladCunt( [ut, retval] lng *pcnt); All versins Functin GetDwnladSpeed() As Lng Retrieves the dwnlad speed f a Site. HRESULT GetDwnladSpeed( [ut, retval] lng *pspeed); All versins Functin GetFlderList(bstrFlderAlias As String) As String Fr an example f using this methd, refer t the VFS script in Script Examples. Given a flder alias, retrieves a list f its subflders (physical and virtual) separated with 0D0A (line return). HRESULT GetFlderList( [in] BSTR bstrflderalias, [ut, retval] BSTR *prp); :Bin Pub Usr" Each flder that appears in the flder list MIGHT have a trailing character t indicate smething special abut that flder. The cln character (:) is used t dente that a flder is EFS encrypted. If yu need t use the subflder name in yur script r prgram, parse ut the cln character. The duble qutatin mark (") is used t dente that the flder has subflders. If yu need t use the subflder name in yur script r prgram, parse ut the duble qutatin mark. Fr example, CISite.GetFlderList( "/" ) might return smething like: Where: Example (C#): The cln : in frnt f Bin indicates that the flder is EFS encrypted. The qutatin mark " at the end f Usr indicates that the flder has subflders. The absence f a cln r qutatin mark after Pub indicates that it is nt EFS encrypted and des nt have subflders. string flderlist = site.getflderlist(vfaliasrt); All versins Functin GetFlderPermissins(bstrFlder As String) As Variant 250

251 Interface Reference See als ICIPermissin - VFS Permissin Interface. Fr an example f using this methd, refer t the VFS script in Script Examples. Retrieves an array f flder permissins (including inherited). HRESULT GetFlderPermissins( [in] BSTR bstrflder, [ut, retval] VARIANT *apermissins); Dim arpermissins: arpermissins = Site.GetFlderPermissins("/usr/test") Fr icunt = LBund(arPermissins) T UBund(arPermissins) Set Permissin = arpermissins(icunt) WScript.Ech Permissin.Flder & " - " & Permissin.Client Next Example (C#): Permissin[] flderpermissins = (Permissin[])site.GetFlderPermissins(flderPath); freach (Permissin perm in (bject[])site.getflderpermissins(flderpath)) { Cnsle.Write(" " + perm.client.padright(16, ' ')); Cnsle.Write((perm.IsGrup)? "grup " : "user "); Cnsle.Write((perm.IsInherited)? "Yes " : "N "); Cnsle.Write(perm.InheritedFrm); Cnsle.WriteLine(); } All versins Functin GetFTPAccess() As Blean Returns TRUE if FTP access is enabled. HRESULT GetFTPAccess( [ut, retval] VARIANT_BOOL *prp); True = Access enabled; False = Access disabled All versins Functin GetHTTPAccess() As Blean Returns TRUE if HTTP access is enabled. HRESULT GetHTTPAccess( [ut, retval] VARIANT_BOOL *prp); True = Access enabled; False = Access disabled EFT v4.3.4 and later Functin GetHTTPPrt() As Lng Retrieves the HTTP prt number f the Site. HRESULT GetHTTPPrt( [ut, retval] lng *prp); EFT v4.3.4 and later Functin GetHTTPSAccess() As Blean Returns TRUE if HTTPS access is enabled. HRESULT GetHTTPSAccess( [ut, retval] VARIANT_BOOL *prp); 251

252 EFT API Reference True = Access enabled; False = Access disabled EFT v4.3.4 and later Functin GetHTTPSPrt() As Lng Retrieves the HTTP prt number f the Site. HRESULT GetHTTPSPrt([ut, retval] lng *prp); EFT v4.3.4 and later Functin GetIP() As Lng Retrieves the index f the Site Listen IP HRESULT GetIP( [ut, retval] lng *prp); All versins Functin GetIPAccessRules() As Variant See als the fllwing interfaces: ICIAutbanIPAccessRule Interface ICIBannedIP Interface ICIIPAccessRule Interface ICIManualIPAccessRule Interface Retrieves an array f allwed IP masks. HRESULT GetIPAccessRules( [ut, retval] VARIANT *amasks); rules = Site.GetIPAccessRules() Fr Each key In rules If key.type = 0 Then WScript.ech "AutBan" End if If key.type = 1 Then WScript.ech "Manual " + key.address End if Next Functin GetKeyFilePath() As String Retrieves the Site SSL private key file path. HRESULT GetKeyFilePath( [ut, retval] BSTR *prp); All versins Functin GetPassPhrase() As String Retrieves the Site SSL Private key passphrase. HRESULT GetPassPhrase( [ut, retval] BSTR *prp); All versins Functin GetPendingCertificateInf(lID As Lng) As CICertInf 252

253 Interface Reference Given an ID, retrieves a pending certificate inf. HRESULT GetPendingCertificateInf( [in] lng lid, [ut, retval] ICICertInf **prp); All versins Functin GetPendingCertificates() As Variant Retrieves a list f pending certificate IDs. HRESULT GetPendingCertificates( [ut, retval] VARIANT *acerts); All versins Functin GetPermissinGrupList(bstrGrup As String) As Variant Retrieves an array f permissin grups. HRESULT GetPermissinGrupList( [in] BSTR bstrgrup, [ut, retval] VARIANT *ausers); Dim arusers: arusers = Site.GetPermissinGrupList("Administrative") Fr icunt = LBund(arUsers) T UBund(arUsers) WScript.Ech arusers(icunt) Next All versins Functin GetPermissinGrups() As Variant Retrieves an array f permissin grups. (Permissin Grups cntrl user access t files and flders.) HRESULT GetPermissinGrups( [ut, retval] VARIANT *agrups); All versins Functin GetPermissinGrupsOfUser(bstrUser As String) As Variant Given a user accunt, retrieve its permissin grups. HRESULT GetPermissinGrupsOfUser( [in] BSTR bstruser, [ut, retval] VARIANT *agrups); All versins Functin GetPermPathsList(bstrOptins As String) As String Returns a list f all paths that have a unique set f permissins. (All ther paths, which are nt included in the set returned by this call, inherit the permissins as set in their parent.) HRESULT GetPermPathsList( [in] BSTR bstroptins, [ut, retval] BSTR *prp); Supprted value fr bstroptins is -d (decrate rphans) When specified, a flder that exists in the Virtual File System (VFS), but whse physical path des nt exist, will be decrated with a trailing asterisk (*). EFT v6.3.1 and later Functin GetPhysicalPath(bstrFlderAlias As String) As String 253

254 EFT API Reference Transfrms a virtual path t physical ne. HRESULT GetPhysicalPath( [in] BSTR bstrflderalias, [ut, retval] BSTR *pbstrphysicalpath); Msgbx Site.GetPhysicalPath("/Usr") Returns a message bx displaying the physical path, such as: EFT v5.2.5 and later Functin GetPrt() As Lng Retrieves the prt number f the Site. HRESULT GetPrt( [ut, retval] lng *prp); All versins Functin GetResetPasswrdSettings() As Object Use ICISite::GetResetPasswrdSettings and ICISite::SetResetPasswrdSettings t retrieve and set the passwrd settings fr a Site. Retrieves the passwrd reset settings. HRESULT GetResetPasswrdSettings( [ut, retval] ICIResetPasswrdSettings** ppiresetpasswrdsettings); (v ) [ut, retval] IDispatch** ppiresetpasswrdsettings); (v6.3.8 and later) Set PwdSettings = Site.GetResetPasswrdSettings() Functin GetRtFlder() As String Retrieves the rt flder fr an individual site. HRESULT GetRtFlder( [ut, retval] BSTR *prp); All versins Functin GetSettingsLevels() As Variant Fr an example using this methd, refer t the UserSettingsTemplates script in Script Examples. Retrieves an array f User Settings Templates. HRESULT GetSettingsLevels( [ut, retval] VARIANT *alevels); Example (C#): CIClientSettings usersettings = selectedsite.getusersettings(username); bject settingslevels = selectedsite.getsettingslevels(); All versins 254

255 Interface Reference Functin GetSettingsLevelSettings(bstrGrup As String) As CIClientSettings Given a Settings Template name retrieves its settings. HRESULT GetSettingsLevelSettings( [in] BSTR bstrgrup, [ut, retval] ICIClientSettings **prp); All versins Functin GetSettingsLevelUsers(bstrGrup As String) As Variant Fr an example using this methd, refer t the UserSettingsTemplates script in Script Examples. Given a Settings Template, retrieves an array f its users. HRESULT GetSettingsLevelUsers( [in] BSTR bstrgrup, [ut, retval] VARIANT *ausers); Example (C#): CIClientSettings usersettings = selectedsite.getusersettings(username); bject settingslevels = selectedsite.getsettingslevels(); All versins Functin GetSFTPAccess() As Blean Returns TRUE if SFTP access is enabled. HRESULT GetSFTPAccess( [ut, retval] VARIANT_BOOL* pbval); EFT v6.4 and later Functin GetSSHKeyFilePath() As String Retrieves SSH key file path. HRESULT GetSSHKeyFilePath( [ut, retval] BSTR *prp); EFT v4.3.4 and later Functin GetSSLAuth() As Blean Returns TRUE if SSL authenticatin is enabled. HRESULT GetSSLAuth( [ut, retval] VARIANT_BOOL *prp); True = Enabled; False = Disabled All versins Functin GetSSLImp() As Blean Returns TRUE if SSL implicit is enabled. HRESULT GetSSLImp( [ut, retval] VARIANT_BOOL *prp); True = Enabled; False = Disabled All versins Functin GetStartTime() As String Retrieves the time the Site was started. HRESULT GetStartTime( 255

256 EFT API Reference [ut, retval] BSTR *bstrstarttime); All versins Functin GetTrustedCertificateInf(lID As Lng) As CICertInf Fr an example using this methd, refer t the GetCertInf script in Script Examples. Given an ID, retrieves a trusted certificate inf. HRESULT GetTrustedCertificateInf( [in] lng lid, [ut, retval] ICICertInf **prp); All versins Functin GetTrustedCertificates() As Variant Fr an example using this methd, refer t the GetCertInf script in Script Examples. Retrieves a list f trusted certificate IDs. HRESULT GetTrustedCertificates( [ut, retval] VARIANT *acerts); All versins Functin GetTrustedCertsPath() As String Retrieves the Trusted Certificate file path. HRESULT GetTrustedCertsPath( [ut, retval] BSTR *prp); All versins Functin GetUpladCunt() As Lng Retrieves the number f active uplads. HRESULT GetUpladCunt( [ut, retval] lng *pcnt); All versins Functin GetUpladSpeed() As Lng Retrieves the uplad speed f a site. HRESULT GetUpladSpeed( [ut, retval] lng *pspeed); All versins Functin GetUsers() As Variant Fr an example using this methd, refer t the ServerIPBanEntry script in Script Examples. Retrieves an array f users. HRESULT GetUsers( [ut, retval] VARIANT *ausers); Example (C#): bject[] users = (bject[])selectedsite.getusers(); All versins Functin GetUserSettings(bstrUser As String) As CIClientSettings 256

257 Interface Reference Fr an example using this methd, refer t the GetCertInf, ServerIPBanEntry, CnfigureUser, r UserSettingsTemplates script in Script Examples. Given a username, retrieves its settings. HRESULT GetUserSettings( [in] BSTR bstruser, [ut, retval] ICIClientSettings **prp); Site.GetUserSettings("kmarsh") GetUserSettings is case insensitive. That is, in many nn-windws envirnments KMarsh and kmarsh are tw different usernames and case matters. With this methd, KMarsh, KMARSH, and kmarsh are all the same user accunt. Examples (C#): ICIClientSettings client = selectedsite.getusersettings((string)users[0]); CIClientSettings usersettings = selectedsite.getusersettings(username); bject settingslevels = selectedsite.getsettingslevels(); All versins Functin GetUserSettingsLevel(bstrUser As String) Given a user, retrieves its settings template. HRESULT GetUserSettingsLevel( [in] BSTR bzuser, [ut, retval] BSTR* pbzsettingslevel); EFT v6.4 and later Functin GetVirtualFlderList (bstroptins As String) As String Returns a list f all paths in the VFS that represent virtual flders. Fllw with GetPhysicalPath t find ut which physical flder the virtual flder represents. HRESULT GetVirtualFlderList( [in] BSTR bstroptins, [ut, retval] BSTR *prp); bstroptins is included t supprt the pssible additin f functinality in later versins. Currently, this ptin is ignred. EFT v6.3.1 and later Prperty HasMaxCncurrentLgins As Blean Retrieves r specifies whether the site has maximum cncurrent lgins enabled. HRESULT HasMaxCncurrentLgins( [ut, retval] VARIANT_BOOL *pval); HRESULT HasMaxCncurrentLgins( [in] VARIANT_BOOL newval); True=Enabled; False=Disabled Prperty HasMaxCnnectinsPerAccunt As Blean Retrieves r specifies whether the Site has a maximum cncurrent scket cnnectins enabled. HRESULT HasMaxCnnectinsPerAccunt( [ut, retval] VARIANT_BOOL *pval); HRESULT HasMaxCnnectinsPerAccunt( 257

258 EFT API Reference [in] VARIANT_BOOL newval); True=Enabled; False=Disabled All versins Prperty HasMaxIPPerAccunt As Blean Retrieves r specifies whether the Site has maximum cnnectins frm same IP enabled. HRESULT HasMaxIPPerAccunt( [ut, retval] VARIANT_BOOL *pval); HRESULT HasMaxIPPerAccunt( [in] VARIANT_BOOL newval); True=Enabled; False=Disabled All versins Prperty HasMaxSpeed As Blean Retrieves r specifies whether the Site has a maximum transfer speed enabled. HRESULT HasMaxSpeed( [ut, retval] VARIANT_BOOL *pval); HRESULT HasMaxSpeed( [in] VARIANT_BOOL newval); True=Enabled; False=Disabled All versins Prperty HasMaxUsers As Blean Retrieves r specifies whether the Site has the maximum cnnectins per user enabled. HRESULT HasMaxUsers( [ut, retval] VARIANT_BOOL *pval); HRESULT HasMaxUsers( [in] VARIANT_BOOL newval) True=Enabled; False=Disabled All versins Prperty HTTPDmain As String Retrieves r specifies the Site's dmain name fr HTTP access. Yu must restart the Site fr the change t take effect. (Refer t Stp and Start belw.) HRESULT HTTPDmain( [ut, retval] BSTR* pval); HRESULT HTTPDmain( [in] BSTR newval); MsgBx "Current http dmain: " & Site.HTTPDmain Site.HTTPDmain = "lcalhst" Prperty ID As Lng Retrieves read-nly versin f the Site ID. HRESULT ID( 258

259 Interface Reference [ut, retval] lng *pval); All versins Functin ImprtTrustedCertificate(bstrCertPath As String) As Lng Imprts a trusted certificate. HRESULT ImprtTrustedCertificate( [in] BSTR bstrcertpath, [ut, retval] lng * lid); All versins Prperty InactiveAccuntsMnitring As Blean Fr an example using this prperty, refer t the CnfigureSite script in Script Examples. Retrieves r specifies whether inactive accunts are mnitred. HRESULT InactiveAccuntsMnitring( [ut, retval] VARIANT_BOOL* pval); HRESULT InactiveAccuntsMnitring( [in] VARIANT_BOOL newval); if False = Site.InactiveAccuntsMnitring then MsgBx "Disabled" End If Site.InactiveAccuntsMnitring = True Example (C#): selectedsite.inactiveaccuntsmnitring = true; Prperty InvalidAttemptsPerid As Lng Retrieves r specifies the length f time fr "Lck ut / disable accunt after N invalid lgin attempts during time perid" ptin. HRESULT InvalidAttemptsPerid( [ut, retval] lng *pval); HRESULT InvalidAttemptsPerid( [in] lng newval); Site.InvalidAttemptsPerid = 30 EFT v5.1.1 and later Prperty InvalidLginAttemptsCuntTBanIP As Lng Retrieves r specifies the number f lgin attempts after which t ban the IP address. HRESULT InvalidLginAttemptsCuntTBanIP( [ut, retval] lng* pval); HRESULT InvalidLginAttemptsCuntTBanIP( [in] lng newval); EFT v6.4 and later Prperty IPAccessAllwedDefault As Blean 259

260 EFT API Reference Retrieves r specifies whether IP access is allwed by default. HRESULT IPAccessAllwedDefault( [ut, retval] VARIANT_BOOL *pval); HRESULT IPAccessAllwedDefault( [in] VARIANT_BOOL newval); True = Allwed; False = Denied All versins Functin IsEncrypted(bstrFlder As String) As Blean (Was "IsFlderEncrypted" in v6.2.31) Fr an example f using this methd, refer t the VFS script in Script Examples. Retrieves r specifies whether a specified flder is encrypted. HRESULT IsEncrypted( [in] BSTR bstrflder, [ut,retval] VARIANT_BOOL* pbresult); if False = Site.IsEncrypted("/sme_flder") then MsgBx "Nt encrypted." end if Example (C#): Cnsle.Write(" Is encrypted with EFS: "); Cnsle.WriteLine(site.IsEncrypted(flderPath)? "Yes" : "N"); Functin IsFlderInherited(bstrFlder As String) As Blean Retrieves r specifies whether a specified flder is inherited. HRESULT IsFlderInherited( [in] BSTR bstrflder, [ut,retval] VARIANT_BOOL* vbresult); if False = Site.IsFlderInherited("/sme_flder") then MsgBx "Nt inherited" end if EFT v and later Functin IsFlderVirtual(bstrFlderAlias As String) As Blean Fr an example f using this methd, refer t the VFS script in Script Examples. Retrieves r specifies whether a specified flder is a virtual flder. HRESULT IsFlderVirtual( [in] BSTR bstrflderalias, [ut,retval] VARIANT_BOOL* pbres); Examples (VBScript): if True = Site.IsFlderVirtual("/sme_flder") then MsgBx "/sme_flder is virtual." end if Example (C#): Cnsle.Write(" Is virtual: "); 260

261 Interface Reference Cnsle.WriteLine(site.IsFlderVirtual(flderPath)? "Yes" : "N"); EFT v and later Prperty IsStarted As Blean T start r stp a Site via the API, refer t: Start Stp Retrieves TRUE if the Site is started, FALSE if it is nt started. HRESULT IsStarted( [ut, retval] VARIANT_BOOL *pval); If Nt Site.IsStarted Then Site.Start End If All versins Functin KickUser(nUserID As Lng) As Blean Frcibly lgs a user ff f the Site. HRESULT KickUser( [in] lng nuserid, [ut, retval] VARIANT_BOOL *psuccess); Dim bresult: bresult = Site.KickUser(1) If bresult Then WScript.Ech "User discnnected successfully." Else WScript.Ech "Failed t discnnect the user." End If EFT v4.3.4 and later Prperty LastMdifiedBy As String (read nly) Retrieves username f accunt that last mdified the Site. HRESULT LastMdifiedBy( [ut, retval] BSTR* pval); MsgBx "Last mdified by " & CStr(Site.LastMdifiedBy) Prperty LastMdifiedTime As Date (read nly) Retrieves the date that the Site was last mdified. HRESULT LastMdifiedTime( [ut, retval] DATE* pval); MsgBx "Last mdified time " & CStr(Site.LastMdifiedTime) Prperty LimitLginAttempts As Blean 261

262 EFT API Reference Retrieves r specifies whether the number f lgin attempts is limited. HRESULT LimitLginAttempts( [ut, retval] VARIANT_BOOL *pval); HRESULT LimitLginAttempts( [in] VARIANT_BOOL newval); True=Enabled; False=Disabled EFT v5.1.1 and later Prperty ListenIPs As Variant Retrieves r specifies the IP addresses n which the server listens. HRESULT ListenIPs( [ut, retval] VARIANT* pval); HRESULT ListenIPs( [in] VARIANT newval); EFT v6.4 and later Prperty LckutNtDisable As Blean Retrieves r specifies whether accunt lckut is nt disabled. HRESULT LckutNtDisable( [ut, retval] VARIANT_BOOL *pval); HRESULT LckutNtDisable( [in] VARIANT_BOOL newval); True=Lckut is nt disabled; False=Lckut is disabled EFT v5.1.1 and later Prperty LckutPerid As Lng Retrieves r specifies the lckut perid value. Values are 30, 60, r 90 minutes. HRESULT LckutPerid( [ut, retval] lng *pval); HRESULT LckutPerid( [in] lng newval); EFT v5.1.1 and later Prperty MaxCncurrentCnnectins As Lng Retrieves r specifies the maximum cncurrent cnnectins value. HRESULT MaxCncurrentCnnectins( [ut, retval] lng *pval); HRESULT MaxCncurrentCnnectins( [in] lng newval); All versins Prperty MaxCncurrentLgins As Lng Retrieves r specifies the maximum cncurrent lgins value. HRESULT MaxCncurrentLgins( [ut, retval] LONG *pval); HRESULT MaxCncurrentLgins( [in] LONG newval); Secure Server, All versins ; Prperty MaxCnnectinsFrmSameIP As Lng Retrieves r specifies the maximum cnnectins frm the same IP address value. 262

263 Interface Reference HRESULT MaxCnnectinsFrmSameIP( [ut, retval] lng *pval); HRESULT MaxCnnectinsFrmSameIP( [in] lng newval); All versins Prperty MaxCnnectinsPerUser As Lng Retrieves r specifies the maximum scket cnnectins per user value. HRESULT MaxCnnectinsPerUser( [ut, retval] lng *pval); HRESULT MaxCnnectinsPerUser( [in] lng newval); All versins Prperty MaxInactivePerid As Lng Fr an example using this prperty, refer t the GetCertInf, CnfigureSite, r CnfigureUser script in Script Examples. Retrieves r specifies the maximum inactive perid value. HRESULT MaxInactivePerid( [ut, retval] LONG* pval); HRESULT MaxInactivePerid( [in] LONG newval); MsgBx "Inactive perid is: " & CStr(Site.MaxInactivePerid) Site.MaxInactivePerid = 90 Example (C#): selectedsite.maxinactiveperid = 30; Prperty MaxInvalidLginAttempts As Lng Retrieves r specifies the maximum invalid lgin attempts value. HRESULT MaxInvalidLginAttempts( [ut, retval] lng *pval); HRESULT MaxInvalidLginAttempts( [in] lng newval); EFT v5.1.1 and later Prperty MaxInvalidLginAttemptsPeridTBanIP As Lng Retrieves r specifies the perid during which t cunt invalid lgin attempts. HRESULT MaxInvalidLginAttemptsPeridTBanIP( [ut, retval] lng* pval); HRESULT MaxInvalidLginAttemptsPeridTBanIP( [in] lng newval); EFT v6.4 and later Prperty MaxTransferSpeed As Lng Retrieves r specifies the maximum transfer speed limit. 263

264 EFT API Reference HRESULT MaxTransferSpeed( [ut, retval] lng *pval); HRESULT MaxTransferSpeed( [in] lng newval); All versins Sub MveIPAccessRule(bstrMask As String, ballw As Blean, nruleps As Lng) See als the fllwing interfaces: ICIAutbanIPAccessRule Interface ICIBannedIP Interface ICIIPAccessRule Interface ICIManualIPAccessRule Interface Changes allwed r denied IP mask psitin fr the Site. HRESULT MveIPAccessRule( [in] lng nrulepsfrm, [in] lng nrulepst); Site.MveIPAccessRule(1,2) Sub MveUserTSettingsLevel(bstrUser As String, bstrgrup As String) Mves a user t anther Settings Template. HRESULT MveUserTSettingsLevel( [in] BSTR bstruser, [in] BSTR bstrgrup); All versins Prperty MTCAllwFileCaching As Blean Turns n r ff filt caching fr the Mbile Transfer Client. HRESULT MTCAllwFileCaching([in] VARIANT_BOOL newval); HRESULT MTCAllwFileCaching([ut, retval] VARIANT_BOOL* pval); EFT v and later Prperty MTCAllwFileOpening As Blean Turns n r ff ability t pen files in external apps fr the Mbile Transfer Client. HRESULT MTCAllwFileOpening([in] VARIANT_BOOL newval); HRESULT MTCAllwFileOpening([ut, retval] VARIANT_BOOL* pval); EFT v and later Prperty MTCAllwFileSharing As Blean Turns n r ff file sharing fr the Mbile Transfer Client. HRESULT MTCAllwFileSharing([in] VARIANT_BOOL newval); HRESULT MTCAllwFileSharing([ut, retval] VARIANT_BOOL* pval); EFT v and later Prperty MTCAllwSavingOffline As Blean Turns n r ff saving files ffline fr the Mbile Transfer Client. 264

265 Interface Reference HRESULT MTCAllwSavingOffline([in] VARIANT_BOOL newval); HRESULT MTCAllwSavingOffline([ut, retval] VARIANT_BOOL* pval); EFT v and later Prperty MTCAllwSavingPasswrds As Blean Turns n r ff saving Mbile Transfer Client prfile passwrds n the device fr the Mbile Transfer Client HRESULT MTCAllwSavingPasswrds([in] VARIANT_BOOL newval); HRESULT MTCAllwSavingPasswrds([ut, retval] VARIANT_BOOL* pval); EFT v and later Prperty Name As String Retrieves the name f the Site. HRESULT Name( [ut, retval] BSTR *pval); All versins Prperty ODBCSettings As String Cntains all auth manager settings in the frm f string (attributes are separated with semiclns). HRESULT ODBCSettings( [ut, retval] BSTR *pval); HRESULT ODBCSettings( [in] BSTR newval); Fr example, the lgn name attribute fr an AD\NTLM site is represented by the "ATTR=N" substring. N = 0, 1, 2, r 3: 0 = "NT4 Accunt Name" 1 = "Display Name" 2 = "User Principal Name" 3 = "Cmmn Name" EFT v4.3.4 and later Prperty PasswrdHistrySize As Lng Retrieves r specifies the number f previus passwrds t save in histry. HRESULT PasswrdHistrySize( [ut, retval] LONG* pval); HRESULT PasswrdHistrySize( [in] LONG newval); MsgBx "Passwrd histry size is: " & CStr(Site.PasswrdHistrySize) Site.PasswrdHistrySize = 5 Prperty PASVListenIP As Lng Retrieves r specifies the PASV listening IP address. HRESULT PASVListenIP( [ut, retval] lng *pval); 265

266 EFT API Reference HRESULT PASVListenIP( [in] lng newval); All versins Prperty PASVPrtMax As Lng Retrieves r specifies the maximum end f the PASV listening prt range. HRESULT PASVPrtMax( [ut, retval] lng *pval); HRESULT PASVPrtMax( [in] lng newval); All versins Prperty PASVPrtMin As Lng Retrieves r specifies the minimum end f the PASV listening prt range. HRESULT PASVPrtMin( [ut, retval] lng *pval); HRESULT PASVPrtMin( [in] lng newval); All versins Prperty PGPLgFilePath As String Retrieves r specifies the lg file path. HRESULT PGPLgFilePath( [ut, retval] BSTR* pval); HRESULT PGPLgFilePath( [in] BSTR newval); MsgBx "PGP lg file path: " & Site.PGPLgFilePath Site.PGPLgFilePath = "C:\PGP\lgfile.txt" Prperty PGPLgLevel As PGPLgLevel Retrieves r specifies the OpenPGP lgging level. HRESULT PGPLgLevel( [ut, retval] PGPLgLevel* pval); HRESULT PGPLgLevel( [in] PGPLgLevel newval); PGPLgLevel PGPLgLevelStandard = 0 PGPLgLevelVerbse = 1 if PGPLgLevelStandard = Site.PGPLgLevel MsgBx "PGP lg level is standard." End If 266

267 Interface Reference Site.PGPLgLevel = PGPLgLevelVerbse Prperty RadiusCnnectinRetriesCunt As Lng Retrieves r specifies the number f cnnectins retries allwed t cnnect t the RADIUS server. HRESULT RadiusCnnectinRetriesCunt( [ut, retval] lng* pval); HRESULT RadiusCnnectinRetriesCunt( [in] lng newval); Site.RadiusCnnectinRetriesCunt = 2 Prperty RadiusNasIdentifier As String Retrieves r specifies the NAS identifier f the RADIUS server. HRESULT RadiusNasIdentifier( [ut, retval] BSTR* pval); HRESULT RadiusNasIdentifier( [in] BSTR newval); MsgBx "NAS identifier: " & CStr(Site.RadiusNasIdentifier) Prperty RadiusServerName As String Retrieves r specifies the name f the RADIUS server. HRESULT RadiusServerName( [ut, retval] BSTR* pval); HRESULT RadiusServerName( [in] BSTR newval); MsgBx "Radius server name: " & CStr(Site. RadiusServerName) Prperty RadiusServerPrt As Lng Retrieves r specifies the prt number f the RADIUS server. HRESULT RadiusServerPrt( [ut, retval] lng* pval); HRESULT RadiusServerPrt( [in] lng newval); Site. RadiusServerPrt = 1645 Prperty RadiusSharedSecret As String Retrieves r specifies the shared secret f the RADIUS server. HRESULT RadiusSharedSecret( [ut, retval] BSTR* pval); HRESULT RadiusSharedSecret( 267

268 EFT API Reference [in] BSTR newval); MsgBx "Radius shared secret: " & CStr(Site. RadiusSharedSecret) Prperty RadiusTimeut As Lng Retrieves r specifies the timeut fr cnnectin attempts t the RADIUS server in millisecnds. HRESULT RadiusTimeut( [ut, retval] lng* pval); HRESULT RadiusTimeut( [in] lng newval); Site.RadiusTimeut = Prperty RedirectHTTPtHTTPS As Blean Retrieves r specifies whether t redirect all HTTP traffic t HTTPS. Yu must restart the Site fr the change t take effect. (Refer t Stp and Start belw.) HRESULT RedirectHTTPtHTTPS( [ut, retval] VARIANT_BOOL* pval); HRESULT RedirectHTTPtHTTPS( [in] VARIANT_BOOL newval); True = Enabled; False = Disabled MsgBx "Redirecting is enabled: " & CStr(Site.RedirectHTTPtHTTPS) Site.EnableAccuntManagementOverHTTPS = True Sub RemapVirtualFlder(bstrVFSFlder As String, bstrtarget As String) Updates an existing virtual flder path t pint t a specified physical flder. HRESULT RemapVirtualFlder( [in] BSTR bstrvfsflder, [in] BSTR bstrtarget); var bresult = Site.RemapVirtualFlder( "/usr/name", \\\\filer01\\hme\\name") var bresult = Site.RemapVirtualFlder "/MyVirtualFlder", "c:\testflder" EFT v4.3.4 and later Sub Remve() Fr an example using this methd, refer t the RemveSite script in Script Examples. Remves the Site. After remval, the Site bject is n lnger valid. HRESULT Remve(); Example (C#): sitetremve.remve(); 268

269 Interface Reference All versins Sub RemveAdvancedWrkflw(lIndex As Lng) Given the Advanced Wrkflw zer-based index, remves the Wrkflw frm this site HRESULT RemveAdvancedWrkflw( [in] lng lindex); // zer-based index if the AW t remve Remve wrkflw by name idxaw = site.getadvancedwrkflwindex( My Wrkflw ) if idxaw -1 Then site.remveadvancedwrkflw idxaw End If EFT v6.5 and later Sub RemveCmmand(bstrName As String) Remves a cmmand. HRESULT RemveCmmand( [in] BSTR bstrname); All versins Sub RemveFlder(bstrFlder As String) Remves a flder. HRESULT RemveFlder( [in] BSTR bstrflder); All versins Prperty RemveInactiveAccunts As Blean Fr an example using this prperty, refer t the GetCertInf, CnfigureSite, r CnfigureUser script in Script Examples. Retrieves r specifies whether t remve inactive accunts. HRESULT RemveInactiveAccunts( [ut, retval] VARIANT_BOOL* pval); HRESULT RemveInactiveAccunts( [in] VARIANT_BOOL newval); See als InactiveAccuntsMnitring. if False = Site.RemveInactiveAccunts then MsgBx "Disable" else MsgBx "Remve" end if Site.RemveInactiveAccunts = True Example (C#): selectedsite.remveinactiveaccunts = true; 269

270 EFT API Reference Sub RemveIPAccessRule(nRulePs As Lng) See als the fllwing interfaces: ICIAutbanIPAccessRule Interface ICIBannedIP Interface ICIIPAccessRule Interface ICIManualIPAccessRule Interface Remves allwed r denied IP mask fr the Site. HRESULT RemveIPAccessRule( [in] lng nruleps); Site.RemveIPAccessRule(0) All versins Sub RemvePendingCertificate(lID As Lng) Remves a pending certificate. HRESULT RemvePendingCertificate( [in] lng lid); All versins Sub RemvePermissin(bstrFlder As String, bstrclient As String) Given Flder and Client remves the permissin. HRESULT RemvePermissin( [in] BSTR bstrflder, [in] BSTR bstrclient); All versins Sub RemvePermissinGrup(bstrName As String) Remves a permissin grup. HRESULT RemvePermissinGrup( [in] BSTR bstrname); All versins Sub RemveSettingsLevel(bstrName As String) Remves a Settings Template. HRESULT RemveSettingsLevel( [in] BSTR bstrname); All versins Sub RemveTrustedCertificate(lID As Lng) Remves a trusted certificate. HRESULT RemveTrustedCertificate( [in] lng lid); All versins Sub RemveUser(bstrLgin As String) Remves a user. 270

271 Interface Reference HRESULT RemveUser( [in] BSTR bstrlgin); All versins Sub RemveUserFrmPermissinGrup(bstrUser As String, bstrgrup As String) Remves a user frm a permissin grup. HRESULT RemveUserFrmPermissinGrup( [in] BSTR bstruser, [in] BSTR bstrgrup); All versins Sub RenameFlder(bstrSrcFlder As String, bstrdstflder As String) Renames a flder. HRESULT RenameFlder( [in] BSTR bstrsrcflder, [in] BSTR bstrdstflder); All versins Sub RenamePermissinGrup(bstrOldName As String, bstrnewname As String) Renames a permissin grup. HRESULT RenamePermissinGrup( [in] BSTR bstroldname, [in] BSTR bstrnewname); All versins Sub RenameSettingsLevel(bstrOldName As String, bstrnewname As String) Renames a Settings Template. HRESULT RenameSettingsLevel( [in] BSTR bstroldname, [in] BSTR bstrnewname); All versins Sub RenameUser(bstrOldName As String, bstrnewname As String) Renames a user. HRESULT RenameUser( [in] BSTR bstroldname, [in] BSTR bstrnewname); All versins Prperty RequireStrngPasswrds As Blean Retrieves r specifies whether strng (cmplex) passwrds are required. HRESULT RequireStrngPasswrds( [ut, retval] VARIANT_BOOL* pval); HRESULT RequireStrngPasswrds( [in] VARIANT_BOOL newval); TRUE=Enfrce strng passwrds; FALSE=D nt enfrce strng passwrds MsgBx "Strng passwrds fr site: " & CStr(Site.RequireStrngPasswrds) 271

272 EFT API Reference Site.RequireStrngPasswrds = False Sub ResetSubFlders(bstrFlder As String) Resets subflders t default permissins. HRESULT ResetSubFlders( [in] BSTR bstrflder); Site.ResetSubFlder "/sme_flder" Prperty RSACnfiguratinPath Retrieves the path t the RSA cnfiguratin file. HRESULT RSACnfiguratinPath( [ut, retval] BSTR* pval); HRESULT RSACnfiguratinPath( [in] BSTR newval); MsgBx "RSA cnfig path: " & Site.RSACnfiguratinPath Site.RSACnfiguratinPath = "C:\RSACnfig\SDCnf.rec" Sub SetAdvancedWrkflwParams(lIndex As Lng, pdisplparams As Object) (See als GetAdvancedWrkflwParams) Given Advanced Wrkflw zer-based index, changes the Wrkflw's parameters HRESULT SetAdvancedWrkflwParams( [in] lng lindex, // zer-based index f the AW [in] IDispatch* pdisplparams); // AW parameters // as ICIAdvancedWrkflwParams* Rename wrkflw idxaw = site.getadvancedwrkflwindex( My Wrkflw ) if idxaw -1 Then Set AWparams = site.getadvancedwrkflwparams(idxaw) AWparams.Name = My Wrkflw new name site.setadvancedwrkflwparams idxaw, AWparams End If EFT v6.5 and later Sub SetAllwCOMB(newVal As Blean) Specifies whether users n the Site are allwed t use multi-part transfers (the COMB cmmand) fr FTP transfers. HRESULT SetAllwCOMB([in] VARIANT_BOOL newval); 272

273 Interface Reference Site.SetAllwCOMB True Sub SetAllwFXP(newVal As Blean) Specifies whether users n the Site are allwed t use site-t-site transfers (FXP) fr FTP transfers. HRESULT SetAllwFXP([in] VARIANT_BOOL newval); Site.SetAllwFXP True Sub SetAllwNp(newVal As Blean) Specifies whether users n the Site are allwed t use client anti-timeut measures (the NOOP cmmand) fr FTP transfers. HRESULT SetAllwNp([in] VARIANT_BOOL newval); Site.SetAllwNp True Sub SetAllwXCRC(newVal As Blean) Specifies whether users n the Site are allwed t use integrity checking (the XCRC cmmand) fr FTP transfers. HRESULT SetAllwXCRC([in] VARIANT_BOOL newval); Site.SetAllwXCRC True Sub SetAMParams(newVal As Object) Fr an example using this methd, refer t the Windws Authenticatin script in Script Examples. Specifies authenticatin manager (AM) parameters. HRESULT SetAMParams( [in] IDispatch* newval); Example (VBScript) Set AMParams = Site.GetAMParams() AMParams.RefreshIntervalMinutes = 10 Site.SetAMParams(AMParams) Functin SetCertFilePath(newVal As String) As Blean Changes the certificate file path and returns TRUE if the Site has t be restarted. (Refer t Stp and Start belw.) HRESULT SetCertFilePath( [in] BSTR newval, [ut, retval] VARIANT_BOOL *pneedrestart); All versins Functin SetCheckClientCert(newVal As Blean) As Blean 273

274 EFT API Reference Enables r disables the requirement f certificates n an implicit SSL Site. If yu must restart the Server fr the change t take effect the SetCheckClientCert methd returns a value f TRUE. (Refer t Stp and Start belw.) HRESULT SetCheckClientCert( [in] VARIANT_BOOL newval, [ut, retval] VARIANT_BOOL *pneedrestart); All versins Sub SetCmplexPasswrdSettings(pICmplexPasswrdSettings As Object) Specifies cmplex passwrd settings. HRESULT SetCmplexPasswrdSettings( [in] IDispatch* picmplexpasswrdsettings); (v ) [in] ICIResetPasswrdSettings* piresetpasswrdsettings); (v6.3.8 and later) Set PwdSettings = Site.GetCmplexPasswrdSettings() PwdSettings.MinPasswrdLength = 8 Site.SetCmplexPasswrdSettings(PwdSettings) Sub SetDefaultPGPKey(bzKeyID As String, bzpassphrase As String) See als DefaultPGPKeyID and DefaultPGPKeyPassphrase. Specifies the default PGP Key and passphrase. Specify an empty string fr the key t assign "n key." HRESULT SetDefaultPGPKey( [in] BSTR bzkeyid, [in] BSTR bzpassphrase); EFT v6.4 and later Functin SetFTPAccess(newVal As Blean) As Blean Enables r disables FTP access and returns TRUE if the Site has t be restarted. (Refer t Stp and Start belw.) HRESULT SetFTPAccess( [in] VARIANT_BOOL newval, [ut, retval] VARIANT_BOOL *pneedrestart); True = Access enabled; False = Access disabled All versins Functin SetHTTPAccess(newVal As Blean) As Blean Enables r disables HTTP access and returns TRUE if the Site has t be restarted. (Refer t Stp and Start belw.) HRESULT SetHTTPAccess( [in] VARIANT_BOOL newval, [ut, retval] VARIANT_BOOL *pneedrestart); True = Access enabled; False = Access disabled EFT v4.3.4 and later Functin SetHTTPPrt(newVal As Lng) As Blean Changes the HTTP prt number f the Site and returns TRUE if the Site has t be restarted. (Refer t Stp and Start belw.) HRESULT SetHTTPPrt( 274

275 Interface Reference [in] lng newval, [ut, retval] VARIANT_BOOL *pneedrestart); EFT v4.3.4 and later Functin SetHTTPSAccess(newVal As Blean) As Blean Enables r disables HTTPS access and returns TRUE if the Site has t be restarted. (Refer t Stp and Start belw.) HRESULT SetHTTPSAccess( [in] VARIANT_BOOL newval, [ut, retval] VARIANT_BOOL *pneedrestart); EFT v4.3.4 and later Functin SetHTTPSPrt(newVal As Lng) As Blean Changes the HTTPS prt number f the Site and returns TRUE if the Site has t be restarted. (Refer t Stp and Start belw.) HRESULT SetHTTPSPrt( [in] lng newval, [ut, retval] VARIANT_BOOL *pneedrestart); EFT v4.3.4 and later Functin SetIP(newVal As Lng) As Blean Changes the index f Listen IP and returns TRUE if the Site has t be restarted. (Refer t Stp and Start belw.) HRESULT SetIP( [in] lng newval, [ut, retval] VARIANT_BOOL *pneedrestart); All versins Functin SetKeyFilePath(newVal As String) As Blean Changes the Site's SSL private key file path and returns TRUE if the Site has t be restarted. (Refer t Stp and Start belw.) HRESULT SetKeyFilePath( [in] BSTR newval, [ut, retval] VARIANT_BOOL *pneedrestart); All versins Functin SetPassPhrase(newVal As String) As Blean Changes the Site's SSL private key passphrase and returns TRUE if the Site has t be restarted. (Refer t Stp and Start belw.) HRESULT SetPassPhrase( [in] BSTR newval, [ut, retval] VARIANT_BOOL *pneedrestart); All versins Sub SetPermissin(pPermissin As Permissin, [bremveotherpermissins As Blean]) Refer t ICIPermissin - VFS Permissin Interface fr the available permissin prperties. Adds a new permissin r changes an existing ne. HRESULT SetPermissin( [in] IPermissin *ppermissin, [in, ptinal] VARIANT_BOOL bremveotherpermissins); 275

276 EFT API Reference If yu want t set permissins n a flder fr a user and remve all ther permissins, pass TRUE t the secnd parameter f setpermissin(). This will REMOVE all ther permissins frm a flder (that is, break the inheritance). Fr example, set perm = Site.GetBlankPermissin( "/usr/f", "f" ) perm.filedelete = True perm.fileuplad = True perm.filedwnlad = False Site.SetPermissin( perm, True ) All versins Functin SetPrt(newVal As Lng) As Blean Changes the prt number and returns TRUE if the Site has t be restarted. (Refer t Stp and Start belw.) HRESULT SetPrt( [in] lng newval, [ut, retval] VARIANT_BOOL *pneedrestart); All versins Sub SetResetPasswrdSettings(pIResetPasswrdSettings As Object) Use ICISite::GetResetPasswrdSettings and ICISite::SetResetPasswrdSettings t retrieve and set the passwrd settings fr a Site. Specifies passwrd reset settings. HRESULT SetResetPasswrdSettings( [in] ICIResetPasswrdSettings* piresetpasswrdsettings); (v ) [in] IDispatch* piresetpasswrdsettings); (v6.3.8 and later) Set PwdSettings = Site.GetResetPasswrdSettings() PwdSettings.MaxPasswrdAgeDays = 8 Site.SetResetPasswrdSettings(PwdSettings) Functin SetRtFlder(newVal As String) As Blean Changes the rt flder f the site and returns TRUE if the site has t be restarted. (Refer t Stp and Start belw.) HRESULT SetRtFlder( [in] BSTR newval, [ut, retval] VARIANT_BOOL *pneedrestart); All versins Functin SetSSHKeyFilePath(newVal As String) As Blean Changes the SSH Certificate file path and returns TRUE if the Site has t be restarted. (Refer t Stp and Start belw.) HRESULT SetSSHKeyFilePath( [in] BSTR newval, [ut, retval] VARIANT_BOOL *pneedrestart); Dim bneedrestart: bneedrestart = Site.SetSSHKeyFilePath("C:\Keys\Key.pvk") 276

277 Interface Reference If bneedrestart Then Call Site.Stp() Call Site.Start() End If EFT and later Functin SetSSLAuth(newVal As Blean) As Blean Enables r disables SSL authenticatin and returns TRUE if the Site has t be restarted. (Refer t Stp and Start belw.) HRESULT SetSSLAuth( [in] VARIANT_BOOL newval, [ut, retval] VARIANT_BOOL *pneedrestart); All versins Sub SetSSLCertificate(bzCertFilePath As String, bzkeyfilepath As String, bzpassphrase As String) Specifies the Site's SSL certificate file path, key file path, and passphrase. HRESULT SetSSLCertificate( [in] BSTR bzcertfilepath, [in] BSTR bzkeyfilepath, [in] BSTR bzpassphrase); Site.SetSSLCertificate "C:\MySite.crt", "C:\ MySite.key", "My-Site_passwd" EFT v6.1 and later Functin SetSSLImp(newVal As Blean) As Blean Enables r disables SSLImp and returns TRUE if the Site has t be restarted. (Refer t Stp and Start belw.) HRESULT SetSSLImp( [in] VARIANT_BOOL newval, [ut, retval] VARIANT_BOOL *pneedrestart); All versins Prperty SFTPEncding as string Refer t TransferEncdingType in the Enum Reference. Retrieves r specifies the transfer encding mde fr SFTP. TransferEncdingUTF8 and TransferEncdingASCII are the nly valid values fr this prperty. HRESULT SFTPEncding([ut, retval] TransferEncdingType* pval); HRESULT SFTPEncding([in] TransferEncdingType newval); If Site.SFTPEncding = 1 Then UTF-8 mde End If set UTF-8 mde fr SFTP Site.SFTPEncding = 1f EFT v6.5 and later 277

278 EFT API Reference Prperty SFTPEncdingAlgrithms As String Retrieves the allwed ciphers. Yu must restart the Site fr changes t take effect. HRESULT SFTPEncdingAlgrithms( [ut, retval] BSTR* pval); HRESULT SFTPEncdingAlgrithms( [in] BSTR newval); MsgBx "SFTP ciphers: " & Site.SFTPEncdingAlgrithms Site.SFTPEncdingAlgrithms = "twfish256-cbc,twfish-cbc,twfish128-cbc,blwfishcbc" Prperty SFTPIdentificatinCmment As String Retrieves the SFTP cmments. Yu must restart the Site fr changes t take effect. (Refer t Stp and Start belw.) HRESULT SFTPIdentificatinCmment( [ut, retval] BSTR* pval); HRESULT SFTPIdentificatinCmment( [in] BSTR newval); MsgBx "SFTP cmments: " & Site.SFTPIdentificatinCmment Site.SFTPIdentificatinCmment = "GlbalSCAPE" Prperty SFTPKeyFile As String Retrieves the path t the SFTP key. Yu must restart the Site fr changes t take effect. (Refer t Stp and Start belw.) HRESULT SFTPKeyFile( [ut, retval] BSTR* pval); HRESULT SFTPKeyFile( [in] BSTR newval); MsgBx "SFTP private key file is: " & Site.SFTPKeyFile Site.SFTPKeyFile = "C:\SFTPPriveteKeys\key1" Prperty SFTPKeyPassphrase As String Retrieves the SFTP key passphrase. Yu must restart the Site fr changes t take effect. (Refer t Stp and Start belw.) HRESULT SFTPKeyPassphrase( 278

279 Interface Reference [ut, retval] BSTR* pval); HRESULT SFTPKeyPassphrase( [in] BSTR newval); MsgBx "SFTP private key passphrase is: " & Site.SFTPKeyPassphrase Site.SFTPKeyPassphrase = "new_passphrase" Prperty SFTPMacAlgrithms As String Retrieves the list f allwed MAC algrithms. Yu must restart the Site fr changes t take effect. (Refer t Stp and Start belw.) HRESULT SFTPMacAlgrithms( [ut, retval] BSTR* pval); HRESULT SFTPMacAlgrithms( [in] BSTR newval); MsgBx "SFTP MAC algriphms: " & Site.SFTPMacAlgrithms Site.SFTPMacAlgrithms = "hmac-sha1,hmac-md5,hmac-sha1-96,hmac-md5-96" Prperty SFTPPrt As Lng Retrieves r specifies the SFTP prt number. Yu must restart the Site fr the change t take effect. (Refer t Stp and Start belw.) HRESULT SFTPPrt( [ut, retval] LONG* pval); HRESULT SFTPPrt( [in] LONG newval); MsgBx "SFTP prt: " & CStr(Site.SFTPPrt) Site.SFTPPrt = 40 Prperty SFTPPublicKeyBlb As String (read nly) Retrieves the SFTP public key blb. HRESULT SFTPPublicKeyBlb( [ut, retval] BSTR* pval); MsgBx "SFTP public key blb: " & Site.SFTPPublicKeyBlb 279

280 EFT API Reference Prperty SFTPSftwareVersin As String Retrieves the SFTP sftware versin. Yu must restart the Site fr changes t take effect. (Refer t Stp and Start belw.) HRESULT SFTPSftwareVersin( [ut, retval] BSTR* pval); HRESULT SFTPSftwareVersin( [in] BSTR newval); MsgBx "SFTP sftware: " & Site.SFTPSftwareVersin Site.SFTPSftwareVersin = "1.82_sshlib" Sub Start() Starts the Site. HRESULT Start(); All versins Sub Stp() Stps the Site. HRESULT Stp(); All versins Prperty TwFactrAuthenticatin TwFactrAuthenticatinMde Retrieves r specifies the tw-factr authenticatin mde. HRESULT TwFactrAuthenticatin( [ut, retval] TwFactrAuthenticatinMde* pval); HRESULT TwFactrAuthenticatin( [in] TwFactrAuthenticatinMde newval); Sub UnbanIP(bstrMask As String) (read nly) Remves denied IP mask frm the Autban list fr the Site. (Des nt remve manually banned IPs. Use RemveIPAccessRule instead.) HRESULT UnbanIP( [in] BSTR bstrmask //mask t remve ); Site.UnbanIP(" ") Prperty UnderPCIDSS As Blean (read nly) Returns VARIANT_TRUE if the Site is under PCI DSS plicy. Used t query the Site t determine if it is a strict security/pci DSS-enabled Site. HRESULT UnderPCIDSS( [ut, retval] VARIANT_BOOL * pval); 280

281 Interface Reference MsgBx "Under PCIDSS: " & CStr(Site.UnderPCIDSS) EFT v6.3.1 and later Functin UnlckUser(bstrUserName As String) As Blean Retrieves whether a user accunt is lcked and unlck the accunt. HRESULT UnlckUser( [in] BSTR bstrusername, [ut, retval] VARIANT_BOOL *psuccess); TRUE=Unlcked; FALSE=Lcked if False = Site.UnlckUser("User1") then MsgBx "Cannt unlck user." End if Prperty UseDynamicPGPLgFile Retrieves r specifies whether t use dynamic lg file. HRESULT UseDynamicPGPLgFile( [ut, retval] VARIANT_BOOL* pval); HRESULT UseDynamicPGPLgFile( [in] VARIANT_BOOL newval); MsgBx "PGP uses dynamic lg file:" & CStr(Site.UseDynamicPGPLgFile) Site.UseDynamicPGPLgFile = true Prperty UserLimitMessage As String Retrieves r specifies user limit message. HRESULT UserLimitMessage( [in] BSTR newval); [ut, retval] BSTR *pval); All versins Prperty UsersDefined As Lng (read nly) Retrieves the number f user accunts defined n the Site. HRESULT UsersDefined( [ut, retval] LONG* pval) MsgBx "Users cunt: " & CStr(Site.UsersDefined) Functin ValidatePasswrd(bstrUser As String, bstrpwd As String) As Blean Validates a user's passwrd. HRESULT ValidatePasswrd( [in] BSTR bstruser, 281

282 EFT API Reference [in] BSTR bstrpwd, [ut, retval] VARIANT_BOOL *bvalid); If Site.ValidatePasswrd( "test", "pass") Then WScript.Ech "Valid passwrd" End If EFT v3.5.1 and later Prperty VFSFilter As String Retrieves r specifies list f banned file types. HRESULT VFSFilter( [ut, retval] BSTR *pval); [in] BSTR newval); All versins Prperty WTCSessinsActive As Lng (read nly) Retrieves the number f active WTC sessins in use. HRESULT WTCSessinsActive( [ut, retval] LONG* pval); MsgBx "WTC sessins cunt: " & CStr(Site.WTCSessinsActive) Prperty WTCSessinsRemaining As Lng (read nly) Retrieves the number f WTC sessins available. HRESULT WTCSessinsRemaining( [ut, retval] LONG* pval); MsgBx "WTC sessins remaining: " & CStr(Site.WTCSessinsRemaining) Dialg Bx Equivalents The ICISite interface prperties and methds crrelate t the fllwing fields and cntrls in the EFT administratin interface. 282

283 Interface Reference Site General Settings Site RADIUS Settings The ICISite RADIUS authenticatin prperties crrelate t the fllwing fields and cntrls in the EFT administratin interface: Site RSA Cnfiguratin Setting 283

284 EFT API Reference Site ODBC Settings The ODBCSettings prperty crrelates t the Use this user attribute as lgn name setting in the Windws Authenticatin Optins dialg bx. Other substrings appearing in the string depend n settings in the Windws Authenticatin Optins dialg bx. Fr example, if Create a virtual flder pinting t the user's hme flder as defined in his/her AD prfile is selected, the "CreateVirtualHF=1" substring is present in the ODBCSettings string; if Create a physical flder under the site rt flder using the user's lgin name is selected, the "CreateVirtualHF=1" substring is nt present in the ODBCSettings string. Site Listener Settings (Cnnectins Tab) 284

285 Interface Reference Site Cnnectin Limits Site IP Access Rules Site Anti-fld/Hammer Settings 285

286 EFT API Reference Site AS2 Settings 286

287 Interface Reference Site FTP Settings 287

288 EFT API Reference Site Security Settings Site Banned File Types The Site data security settings can be viewed r set in the administratin interface n the Site's Security tab. 288

289 Interface Reference Site Lgin Security Optins Site OpenPGP Security Settings 289

290 EFT API Reference Site SFTP Settings Site SSL Certificate Settings These parameters als can be viewed/set in the Administratr interface n the Cnnectins tab f the Site. 290

291 Interface Reference Site Grups Mbile Transfer Client Security ICISiteBackupInf - Site Backup Infrmatin Interface Use ICISiteBackupInf interface t retrieve infrmatin abut a Site that has been backed up. interface ICISiteBackupInf : IDispatch { See als the ICIBackupArchiveInf::GetSiteBackupInf, ICIBackupArchiveInf::SetSiteBackupInf methds. Members Prperty AuthManagerDataBase As String Retrieves r specifies the path t the authenticatin manager user database. 291

292 EFT API Reference HRESULT AuthManagerDataBase([ut, retval] BSTR* pval); HRESULT AuthManagerDataBase([in] BSTR newval); MsgBx "Site auth manager database: " & BackupSiteInf.AuthManagerDataBase BackupSiteInf.AuthManagerDataBase = "C:\Dcuments and Settings\All Users\Applicatin Data\GlbalSCAPE\EFT Enterprise\MySite.aud" Prperty AuthManagerID As String Retrieves r specifies the authenticatin manager ID. HRESULT AuthManagerID([ut, retval] BSTR* pval); HRESULT AuthManagerID([in] BSTR newval); MsgBx "Site auth manager: " & BackupSiteInf.AuthManagerID BackupSiteInf.AuthManagerID = "LOCAL" Prperty DMZAddress As String Retrieves r specifies the DMZ Gateway IP address. HRESULT DMZAddress([ut,retval] BSTR* pval); HRESULT DMZAddress([in] BSTR newval); MsgBx "DMZ IP: " & BackupSiteInf.DMZAddress BackupSiteInf.DMZAddress = " " Prperty DMZEnabled As Blean Retrieves r specifies whether the DMZ Gateway is enabled. HRESULT DMZEnabled([ut,retval] VARIANT_BOOL* pval); HRESULT DMZEnabled([in] VARIANT_BOOL newval); TRUE=Enabled; FALSE=Disabled MsgBx "DMZ enabled: " & CStr(BackupSiteInf.DMZEnabled) BackupSiteInf.DMZEnabled = True 292

293 Interface Reference Prperty DMZPrt As Lng Retrieves r specifies the DMZ Gateway prt number. HRESULT DMZPrt([ut,retval] LONG* pval); HRESULT DMZPrt([in] LONG newval); MsgBx "DMZ prt: " & BackupSiteInf.DMZPrt BackupSiteInf.DMZPrt = 8888 Prperty ListenIP As String read-nly Retrieve the listener IP f the backed-up Site. HRESULT ListenIP([ut, retval] BSTR* pval); MsgBx "Old listen IP is: " & BackupSiteInf.ListenIP Prperty ListenIPs As Variant Retrieves r specifies the IP addresses n which the server listens. HRESULT ListenIPs( [ut, retval] VARIANT* pval); HRESULT ListenIPs( [in] VARIANT newval); EFT v6.4 and later Prperty NewListenIP As Variant Retrieves r specifies the new listen IP address. HRESULT NewListenIP([ut, retval] BSTR* pval); HRESULT NewListenIP([in] BSTR newval); MsgBx "New listen IP is: " & BackupSiteInf.NewListenIP NewListenIP = " " Prperty NewListenIPs As String Retrieves r specifies multiple new listen IP addresses. HRESULT NewListenIPs( [ut, retval] VARIANT* pval); HRESULT NewListenIPs( [in] VARIANT newval); EFT v6.4 and later 293

294 EFT API Reference Prperty RestreSite As Blean Retrieves r specifies whether yu need t restre the Site. HRESULT RestreSite([ut, retval] VARIANT_BOOL* pval); HRESULT RestreSite([in] VARIANT_BOOL newval); TRUE=Enabled; FALSE=Disabled brestre = BackupSiteInf.RestreSite BackupSiteInf.RestreSite = True Prperty RestreVFS As Blean Retrieves r specifies whether t restre the VFS permissins and flders. HRESULT RestreVFS([ut, retval] VARIANT_BOOL* pval); HRESULT RestreVFS([in] VARIANT_BOOL newval); TRUE=Enabled; FALSE=Disabled brestre = BackupSiteInf.RestreVFS BackupSiteInf.RestreVFS = True Prperty RtFlder As String Retrieves r specifies the path t the rt flder. HRESULT RtFlder([ut, retval] BSTR* pval); HRESULT RtFlder([in] BSTR newval); MsgBx "Site rt flder is: " & BackupSiteInf.RtFlder BackupSiteInf.RtFlder = "F:\ " Prperty SiteName As String read-nly Retrieve the Site name. HRESULT SiteName([ut, retval] BSTR* pval); MsgBx "Site name is: " & BackupSiteInf.SiteName 294

295 Interface Reference ICISites - Multi-Site Interface Use the ICISites interface t create new Sites r t retrieve infrmatin abut the Sites n the Server. (See als ICISite - Single-Site Management fr details abut an individual Site.) interface ICISites : IDispatch Methds Functin Add(bstrName As String, bstrrtflder As String, namid As Int, bstramdb As String, bencryptpasswrds As Blean, nip As Int, nprt As Lng, bcreatehmeflder As Blean, bpermhmeflder As Blean, bautstart As Blean, bcreateftpflders As Blean) As CISite See als AddEx and AddSite. Creates a new Site. HRESULT Add( [in] BSTR bstrname, [in] BSTR bstrrtflder, [in] int namid, [in] BSTR bstramdb, [in] VARIANT_BOOL bencryptpasswrds, [in] int nip, [in] lng nprt, [in] VARIANT_BOOL bcreatehmeflder, [in] VARIANT_BOOL bpermhmeflder, [in] VARIANT_BOOL bautstart, [in] VARIANT_BOOL bcreateftpflders, [ut, retval] ICISite** prp); bstrname - New site name bstrrtflder - Site rt flder, as a full path fr example, "c:\inetpub\eftrt\new site" namid - Authenticatin manager identifier; this must be a number between 0 and 3 (inclusive), as fllws: 0 : Glbalscape EFT Authenticatin (prprietary flat file with an ".aud" extensin) 1 : NTLM/Active Directry Authenticatin 2 : ODBC Authenticatin 3 : LDAP Authenticatin bstramdb - Authenticatin manager database cnfiguratin string. This is specific t the Authenticatin Manager chsen by the namid parameter. NT: "NTLM=1;(DC=<<dmain cntrller name>>;)(group=<<grup name>>;)" AD: ";(DC=<<dmain cntrller name>>;)(group=<<grup name>>;)" ODBC: "<<dsn cnnectin string>>" LOCAL: "<<path t AUD file>>" LDAP: "LDAPDB=<<path t AUD file>>;ldapserver=<<hst>>;ldapport=<<prt>>; BASEDN="<<base dn fr users>>;userfilter=<<user query filter>>;userattribute=<<lgn attribute>>;ssl={0 1};(USERNAME=<<ldap simple bind username>>;password=<<ldap simple bind passwrd>>;)" 295

296 EFT API Reference bencryptpasswrds - TRUE = database shuld cntain encrypted passwrds. This applies nly t ODBC Authenticatin sites, and determines if passwrd in the database are t be cnsidered ne-way hashed passwrds r stred as plain-text in the clumns (useful if yu have external prcesses manipulating rws in the database). nip - Index f the site IP address. A "0" value means "all incming." A number greater than 0 refers t the index in the IP Address list fr all addresses n the cmputer. nprt - Prt number f the site bcreatehmeflder - TRUE means that a hme flder fr new site users shuld be created bpermhmeflder - TRUE means that new site users shuld be granted full permissins in their hme flders bautstart - TRUE means that the site shuld start autmatically. All versins Functin AddADSite(bstrName As String, bstrrtflder As String, bstrdmaincntext As String, bstrallwgrup As String, nip As Int, nprt As Lng, bcreatehmeflder As Blean, bpermhmeflder As Blean, bautstart As Blean, bcreateftpflders As Blean) As CISite See ICIADAuthManagerSettings - Active Directry Authenticatin Manager Settings Interface fr AD-specific settings. See als AddADSiteEx, belw. Creates an AD-authenticated Site. HRESULT AddADSite( [in] BSTR bstrname, [in] BSTR bstrrtflder, [in] BSTR bstrdmaincntext, [in]bstr bstrallwgrup, [in] int nip, lng nprt, [in] VARIANT_BOOL bcreatehmeflder, [in] VARIANT_BOOL bpermhmeflder, [in] VARIANT_BOOL bautstart, [in] VARIANT_BOOL bcreateftpflders, [ut, retval] ICISite** prp); bstrname - New Site name, e.g., "AD Site" bstrrtflder - Site rt flder, e.g., "C:\sites\AD" bstrdmainname - Default dmain cntext fr Active Directry, e.g., "" (required, but can be null) bstrallwgrup - Grup name, e.g., "" (required, but can be null) nip - Index f the Site IP address, e.g., 0 nprt - Prt number f the Site, e.g., 21 bcreatehmeflder - TRUE means that a hme flder fr new Site users shuld be created bpermhmeflder - TRUE means that new Site users shuld be granted full permissins in their hme flders bautstart - TRUE means that the Site shuld start autmatically bcreateftpflders - TRUE means t create standard FTP flders (Usr, Bin, Incming, Pub) (v6.1 and later.) 296

297 Interface Reference Set Site = Sites.AddADSite("AD Site", "C:\sites\AD", "", "", 0, 21, True, True, True, True) All versins Functin AddADSiteEx(bstrName As String, bstrrtflder As String, bstrdmaincntext As String, bstrallwgrup As String, IP, nprt As Lng, bcreatehmeflder As Blean, bpermhmeflder As Blean, bautstart As Blean, bcreateftpflders As Blean) As CISite Creates a new AD site, extended versin, fr multiple listening IPs. HRESULT AddADSiteEx( [in] BSTR bstrname, [in] BSTR bstrrtflder, [in] BSTR bstrdmaincntext, [in] BSTR bstrallwgrup, [in] VARIANT IP, lng nprt, [in] VARIANT_BOOL bcreatehmeflder, [in] VARIANT_BOOL bpermhmeflder, [in] VARIANT_BOOL bautstart, [in] VARIANT_BOOL bcreateftpflders, [ut, retval] ICISite** prp); EFT v6.4 and later Functin AddEx (bzname As String, bzrtflder As String, pdispauthmanagersettings As Object, lip As Int, lprt As Lng, bcreatehmeflder As Blean, bfullpermissinfrhmeflder As Blean, bautstart As Blean, bcreateftpflders As Blean) As CISite Creates a new Site. HRESULT AddEx( [in] BSTR bzname, [in] BSTR bzrtflder, [in] IDispatch* pdispauthmanagersettings, [in] int lip, [in] lng lprt, [in] VARIANT_BOOL bcreatehmeflder, [in] VARIANT_BOOL bfullpermissinfrhmeflder, [in] VARIANT_BOOL bautstart, [in] VARIANT_BOOL bcreateftpflders, [ut,retval] ICISite** pnewsite); Functin AddLDAPSite(bstrName As String, bstrrtflder As String, bstrdmaincntext As String, nip As Int, nprt As Lng, bcreatehmeflder As Blean, bpermhmeflder As Blean, bautstart As Blean, bcreateftpflders As Blean) As CISite See ICILDAPAuthManagerSettings - LDAP Authenticatin Manager Settings Interface fr LDAPspecific settings. See als AddLDAPSiteEx, belw. Creates an LDAP-authenticated Site. HRESULT AddLDAPSite( [in] BSTR bstrname, [in] BSTR bstrrtflder, [in] BSTR bstrdmaincntext, [in] int nip, lng nprt, [in] VARIANT_BOOL bcreatehmeflder, [in] VARIANT_BOOL bpermhmeflder, [in] VARIANT_BOOL bautstart, 297

298 EFT API Reference [in] VARIANT_BOOL bcreateftpflders, [ut, retval] ICISite** prp); bstrname - New site name bstrrtflder - Site rt flder bstrdmaincntext - A semicln-separated list f name/value pairs that defines the LDAP dmain cmpnents. (See Cnfiguratin Ntes belw fr details f hw t cmpse this string.) bstrallwgrup - LDAP grup name (nt used in v6.1) nip - Index f the site IP address nprt - Prt number f the site bcreatehmeflder - TRUE means that a hme flder fr new site users shuld be created bpermhmeflder - TRUE means that new site users shuld be granted full permissins in their hme flders bautstart - TRUE means that the site shuld start autmatically bcreateftpflders - TRUE means t create standard FTP flders (Usr, Bin, Incming, Pub) (v6.1 and later) Yu can als call Add(), setting "3" as the namid parameter t create an LDAP site. Cnfiguratin Ntes The bstrdmaincntext string must be cmpsed prperly t define the parameters f the LDAP Site. The syntax is a semicln-separated list f name/value pairs that defines the LDAP ptins. The entire string is: LDAPSERVER={IP r Hstname fr LDAP server};ldapport={prt n LDAP server};basedn={base dn fr users};userfilter={filter fr LDAP query t return users};userattribute={what user attribute t use as client lgin};type={1 fr annymus bind, 0 fr simple bind};username={cn f the user t bind as fr querying users};password={passwrd fr that user};ldapdb={path t AUD file};ssl={0 fr n SSL, 1 fr SSL};USESEARCHSCOPE={1 t set search scpe, 0 therwise};searchscope={search scpe: 0 => base, 1 => ne level, =>subtree};usesearchsizelimit={1 t verride search page size, 0 therwise};searchsizelimit={new search page size};usetimeout={1 t use timeut, 0 therwise};timeout={timeut in secnds};useversion={1 t use specific versin, therwise 0};VERSION={LDAP versin (2 r 3)};USEPAGECONTROL={1 t use LDAP server side page cntrl, 0 therwise};usereferrals={1 t turn n referral changing; 0 therwise};usesearchattributes={1 t select attributes; 0 therwise };SEARCHATTRIBUTES={search attributes}; Yu d nt have t include the entire string. Any ptins frm USESEARCHSCOPE t the end can be mitted and EFT will use the default values. EFT ignres the TYPE attribute; it is nly used here t set the radi buttn n the LDAP Authenticatin Optins dialg bx. (type all n ne line withut spaces; shwn with line breaks belw fr readability): Set Site = Sites.AddLDAPSite("LDAP Site", "C:\sites\LDAP", "", 0, 21, True, True, True, True) LDAPSERVER=fileserver; LDAPPORT=389; BASEDN=dc=s5develpment,dc=lcal;USERFILTER=(bjectClass=persn); USERATTRIBUTE=cn; 298

299 Interface Reference TYPE=0; USERNAME=cn=Ivan Smithe,cn=users,dc=develpment,dc=lcal; PASSWORD=XXX; LDAPDDB=C:\EFT AppData\MySite.aud;SSL=0; USESEARCHSCOPE=1; SEARCHSCOPE=2; USESEARCHSIZELIMIT=1; SEARCHSIZELIMIT=1000; USETIMEOUT=1; TIMEOUT=60; USEVERSION=1; VERSION=3; USEPAGECONTROL=1; USEREFERRALS=0; USESEARCHATTRIBUTES=1; SEARCHATTRIBUTES=mail, ,name,cn; EFT v4.3.4 and later Functin AddLDAPSiteEx(bstrName As String, bstrrtflder As String, bstrdmaincntext As String, IP, nprt As Lng, bcreatehmeflder As Blean, bpermhmeflder As Blean, bautstart As Blean, bcreateftpflders As Blean) As CISite Creates a new AD Site, extended versin fr multiple listening IP addresses. HRESULT AddLDAPSiteEx( in] BSTR bstrname, [in] BSTR bstrrtflder, [in] BSTR bstrdmaincntext, [in] VARIANT IP, lng nprt, [in] VARIANT_BOOL bcreatehmeflder, [in] VARIANT_BOOL bpermhmeflder, [in] VARIANT_BOOL bautstart, [in] VARIANT_BOOL bcreateftpflders, [ut, retval] ICISite** prp); EFT v6.4 and later Functin AddLcalSite(bstrName As String, bstrrtflder As String, bstrfilepath As String, nip As Int, nprt As Lng, bcreatehmeflder As Blean, bpermhmeflder As Blean, bautstart As Blean, bcreateftpflders As Blean) As CISite Fr an example using this methd, refer t the CreateSite script in Script Examples. See als AddLcalSiteEx, belw. Creates a new unauthenticated Site and retrieve the Site's ICISite interface. HRESULT AddLcalSite( [in] BSTR bstrname, [in] BSTR bstrrtflder, [in] BSTR bstrfilepath, [in] int nip, [in] lng nprt, [in] VARIANT_BOOL bcreatehmeflder, [in] VARIANT_BOOL bpermhmeflder, [in] VARIANT_BOOL bautstart, [in] VARIANT_BOOL bcreateftpflders, [ut, retval] ICISite** prp); bstrname - New site name bstrrtflder - Site rt flder bstrfilepath - Path t the file that will cntain user data nip - Index f the Site IP address 299

300 EFT API Reference nprt - Prt number f the Site bcreatehmeflder - TRUE = hme flder fr new Site users shuld be created bpermhmeflder - TRUE = new Site users shuld be granted full permissins in their hme flders bautstart - TRUE = Site shuld start autmatically bcreateftpflders - TRUE = create standard FTP flders (Usr, Bin, Incming, Pub) (v6.1 and later) Set Site = Sites.AddLcalSite("Lcal Site", "C:\sites\Lcal",_ "C:\sites\Lcal.aud", 0, 21, True, True, True, True) Example (C#): CISite newsite and Settings\All Users\Applicatin Data\GlbalSCAPE\EFT Enterprise\MySite.aud", 0, 21, true, true, true, true); All versins Functin AddLcalSiteEx(bstrName As String, bstrrtflder As String, bstrfilepath As String, IP, nprt As Lng, bcreatehmeflder As Blean, bpermhmeflder As Blean, bautstart As Blean, bcreateftpflders As Blean) As CISite Creates a new GS Site, extended versin fr multiple listening IP addresses. HRESULT AddLcalSiteEx( [in] BSTR bstrname, [in] BSTR bstrrtflder, [in] BSTR bstrfilepath, [in] VARIANT IP, [in] lng nprt, [in] VARIANT_BOOL bcreatehmeflder, [in] VARIANT_BOOL bpermhmeflder, [in] VARIANT_BOOL bautstart, [in] VARIANT_BOOL bcreateftpflders, [ut, retval] ICISite** prp); EFT v6.4 and later Functin AddNTLMSite(bstrName As String, bstrrtflder As String, bstrdmainname As String, bstrallwgrup As String, nip As Int, nprt As Lng, bcreatehmeflder As Blean, bpermhmeflder As Blean, bautstart As Blean, bcreateftpflders As Blean) As CISite See ICIADAuthManagerSettings - Active Directry Authenticatin Manager Settings Interface fr Windws-specific ptins. See als AddNTLMSiteEx, belw. Creates an NTLM-authenticated Site. HRESULT AddNTLMSite( [in] BSTR bstrname, [in] BSTR bstrrtflder, [in] BSTR bstrdmainname, [in] BSTR bstrallwgrup, [in] int nip, [in] lng nprt, [in] VARIANT_BOOL bcreatehmeflder, [in] VARIANT_BOOL bpermhmeflder, [in] VARIANT_BOOL bautstart, [in] VARIANT_BOOL bcreateftpflders, 300

301 Interface Reference [ut, retval] ICISite** prp); bstrname - New site name bstrrtflder - Site rt flder bstrdmainname - NT dmain name bstrallwgrup - NT grup name nip - Index f the site IP address nprt - Prt number f the site bcreatehmeflder - TRUE = hme flder fr new site users shuld be created bpermhmeflder - TRUE = new site users shuld be granted full permissins in their hme flders bautstart - TRUE = site shuld start autmatically bcreateftpflders - TRUE =create standard FTP flders (Usr, Bin, Incming, Pub) (v6.1 and later) Set Site = Sites.AddNTLMSite("NTLM Site", "C:\sites\NTLM", "", 0, 21, True, True, True, True) All versins Functin AddNTLMSiteEx(bstrName As String, bstrrtflder As String, bstrdmainname As String, bstrallwgrup As String, IP, nprt As Lng, bcreatehmeflder As Blean, bpermhmeflder As Blean, bautstart As Blean, bcreateftpflders As Blean) As CISite Creates a new NT Site, extended versin fr multiple listening IP addresses. HRESULT AddNTLMSiteEx( [in] BSTR bstrname, [in] BSTR bstrrtflder, [in] BSTR bstrdmainname, [in] BSTR bstrallwgrup, [in] VARIANT IP, [in] lng nprt, [in] VARIANT_BOOL bcreatehmeflder, [in] VARIANT_BOOL bpermhmeflder, [in] VARIANT_BOOL bautstart, [in] VARIANT_BOOL bcreateftpflders, [ut, retval] ICISite** prp); EFT v6.4 and later Functin AddODBCSite(bstrName As String, bstrrtflder As String, bstrdsn As String, bencryptpasswrds As Blean, nip As Int, nprt As Lng, bcreatehmeflder As Blean, bpermhmeflder As Blean, bautstart As Blean, bcreateftpflders As Blean) As CISite See ICIOCBCAuthManagerSettings - ODBC Authenticatin Manager Settings Interface fr ODBC-specific settings. See als AddODBCSiteEx, belw. Creates an ODBC-authenticated Site. HRESULT AddODBCSite( [in] BSTR bstrname, [in] BSTR bstrrtflder, 301

302 EFT API Reference [in] BSTR bstrdsn, [in] VARIANT_BOOL bencryptpasswrds, [in] int nip, [in] lng nprt, [in] VARIANT_BOOL bcreatehmeflder, [in] VARIANT_BOOL bpermhmeflder, [in] VARIANT_BOOL bautstart, [in] VARIANT_BOOL bcreateftpflders, [ut, retval] ICISite** prp); bstrname - New site name bstrrtflder - Site rt flder bstrdsn - Database DSN bencryptpasswrds - TRUE = database shuld cntain encrypted passwrds nip - Index f the site IP address nprt - Prt number f the site bcreatehmeflder - TRUE = hme flder fr new site users shuld be created bpermhmeflder - TRUE= new site users shuld be granted full permissins in their hme flders bautstart - TRUE = site shuld start autmatically bcreateftpflders - TRUE = create standard FTP flders (Usr, Bin, Incming, Pub) (v6.1 and later) Set Site = Sites.AddODBCSite("ODBC Site", "C:\sites\ODBC", "mydsn;", True, 0, 21, True, True, True, True) All versins Functin AddODBCSiteEx(bstrName As String, bstrrtflder As String, bstrdsn As String, bencryptpasswrds As Blean, IP, nprt As Lng, bcreatehmeflder As Blean, bpermhmeflder As Blean, bautstart As Blean, bcreateftpflders As Blean) As CISite Creates a new ODBC Site, extended versin fr multiple listening IP addresses. HRESULT AddODBCSiteEx( [in] BSTR bstrname, [in] BSTR bstrrtflder, [in] BSTR bstrdsn, [in] VARIANT_BOOL bencryptpasswrds, [in] VARIANT IP, [in] lng nprt, [in] VARIANT_BOOL bcreatehmeflder, [in] VARIANT_BOOL bpermhmeflder, [in] VARIANT_BOOL bautstart, [in] VARIANT_BOOL bcreateftpflders, [ut, retval] ICISite** prp); EFT v6.4 and later Functin AddSite(bstrName As String, bstrrtflder As String, namid As Int, bstramdb As String, bencryptpasswrds As Blean, IP, nprt As Lng, bcreatehmeflder As Blean, bpermhmeflder As Blean, bautstart As Blean, bcreateftpflders As Blean) As CISite Creates a new site. HRESULT AddSite( [in] BSTR bstrname, [in] BSTR bstrrtflder, 302

303 Interface Reference [in] int namid, [in] BSTR bstramdb, [in] VARIANT_BOOL bencryptpasswrds, [in] VARIANT IP, [in] lng nprt, [in] VARIANT_BOOL bcreatehmeflder, [in] VARIANT_BOOL bpermhmeflder, [in] VARIANT_BOOL bautstart, [in] VARIANT_BOOL bcreateftpflders, [ut, retval] ICISite** prp); EFT v6.4 and later Functin AddSiteEx(bzName As String, bzrtflder As String, pdispauthmanagersettings As Object, IP, lprt As Lng, bcreatehmeflder As Blean, bfullpermissinfrhmeflder As Blean, bautstart As Blean, bcreateftpflders As Blean) As CISite Creates a new Site, extended versin fr multiple listening IP addresses. HRESULT AddSiteEx( [in] BSTR bzname, [in] BSTR bzrtflder, [in] IDispatch* pdispauthmanagersettings, [in] VARIANT IP, [in] lng lprt, [in] VARIANT_BOOL bcreatehmeflder, [in] VARIANT_BOOL bfullpermissinfrhmeflder, [in] VARIANT_BOOL bautstart, [in] VARIANT_BOOL bcreateftpflders, [ut,retval] ICISite** pnewsite); EFT v6.4 and later Functin Cunt() As Lng Returns the number f Sites defined. HRESULT Cunt( [ut, retval] lng* prp); All versins Functin Item(nIndex As Lng) As CISite Fr an example using this methd, refer t the CreateSite r RemveSite script in Script Examples. Returns an item by index. The Index value must be between 0 and (Cunt-1). HRESULT Item( [in] lng nindex, [ut, retval] ICISite** prp); Set Sites = Server.Sites 'Retrieve list f sites Set Site = Sites.Item(0) 'Instantiate the first ne Example (C#): CISite site = sites.item(i); All versins Functin SiteByID(ID As Lng) As CISite Retrieves the prperties f a Site by ID. HRESULT SiteByID( [in] lng ID, 303

304 EFT API Reference [ut, retval] ICISite** prp); All versins ICISSHKeyInf - SSH Key Infrmatin Interface Use the ICISSHKeyInf interface t retrieve infrmatin abut EFT s SSH public keys. The interface prvides the set f read-nly prperties. (Refer als t the ICIServer::AvailableSSHKeys prperty.) interface ICISSHKeyInf : IDispatch{ Members Prperty Fingerprint As String read-nly Retrieves the fingerprint f the SSH key. HRESULT Fingerprint([ut, retval] BSTR* pval); EFT v6.1 and later Prperty ID As Lng read-nly Retrieves the ID f the SSH key. HRESULT ID([ut, retval] lng* pval); EFT v6.1 and later Prperty Name As String read-nly Retrieves the name f the SSH key. HRESULT Name([ut, retval] BSTR* pval); EFT v6.1 and later Examples (VBScript): MsgBx "Key: " & key.name & "(" & key.fingerprint & ")" Client.SetSSHKeyID key.id ICIStpActinParams - Stp Actin Parameters Interface The ICIStpActinParams interface allws yu t enable/disable the Stp Prcessing Actin in Event Rules. interface ICIStpActinParams : IDispatch Members Prperty Actin As StpType Retrieves r specifies the type f stp. HRESULT Actin([ut, retval] StpType *pval); HRESULT Actin([in] StpType newval); EFT v5.2 and later Prperty Enabled As Blean Specifies whether the stp is enabled. HRESULT Enabled([ut, retval] VARIANT_BOOL *pval); HRESULT Enabled([in] VARIANT_BOOL newval); 304

305 Interface Reference EFT v5.2 and later Dialg Bx Equivalents ICITimerEventRuleParams - Timer Event Rule Parameters Interface Use ICITimerEventRuleParams t make changes t Timer Event Rule settings. (See als ICIEventRuleParams - Event Rule Parameters Interface.) interface ICITimerEventRuleParams : ICIEventRuleParams Members Prperty DailyDayPerid As Lng Retrieves r specifies the recurrence in days (e.g., every 5 days). HRESULT DailyDayPerid([ut, retval] lng *pval); HRESULT DailyDayPerid([in] lng newval); Prperty DailyEveryWeekDay As Blean Retrieves r specifies whether the even recurs every weekday r every <n> days. HRESULT DailyEveryWeekDay([ut, retval] VARIANT_BOOL *pval); HRESULT DailyEveryWeekDay([in] VARIANT_BOOL newval); True= Every weekday; False= Every <n> days. Use DailyDayPerid t specify the <n> days value. Prperty DateEndEnabled As Blean Retrieves r specifies whether an end date is specified. HRESULT DateEndEnabled([ut, retval] VARIANT_BOOL *pval); HRESULT DateEndEnabled([in] VARIANT_BOOL newval); Prperty DateTimeEnd As Variant Retrieves r specifies the date and time the event is t stp recurring; lcal t the server. (Cmbines end date and end time values.) HRESULT DateTimeEnd([ut, retval] VARIANT *pval); HRESULT DateTimeEnd([in] VARIANT newval); Prperty DateTimeStart As Variant Fr an example using this prperty, refer t the EventRuleCreatin script in Script Examples. Retrieves r specifies the date and time the event is t start; lcal t the server. HRESULT DateTimeStart([ut, retval] VARIANT *pval); HRESULT DateTimeStart([in] VARIANT newval); Use in every Timer rule t specify the date and time the event is t start. 305

306 EFT API Reference Example (C#): bjparams.datetimestart = new DateTime(2011, 1, 1, 0, 0, 1); Prperty HlidayCalendar As String Retrieves r specifies a hliday calendar. HRESULT HlidayCalendar([ut, retval] BSTR*pVal) HRESULT HlidayCalendar([in] BSTR newval); Prperty MnthlyDayPerid As Lng Retrieves r specifies a specific day f the mnth the event is t ccur. HRESULT MnthlyDayPerid([ut, retval] lng *pval); HRESULT MnthlyDayPerid([in] lng newval); Prperty MnthlyFixedDay As Blean Retrieves r specifies whether the event ccurs n the same day every mnth. HRESULT MnthlyFixedDay([ut, retval] VARIANT_BOOL *pval); HRESULT MnthlyFixedDay([in] VARIANT_BOOL newval); True= A specific day f the mnth (e.g., n the 21st every 3 mnths); False= The first, secnd, third, furth, r last weekday f the mnth (e.g., The first Mnday f the mnth). Prperty MnthlyMnthPerid As Lng Retrieves r specifies the mnthly frequency f the event (e.g., every 3 mnths). HRESULT MnthlyMnthPerid([ut, retval] lng *pval); HRESULT MnthlyMnthPerid([in] lng newval); Prperty MnthlyRelativeWeekday As Relatin Retrieves r specifies whether the event ccurs n the first, secnd, third, furth, r last day f the perid (e.g., the first Sunday f the mnth). HRESULT MnthlyRelativeWeekday([ut, retval] Relatin *pval); HRESULT MnthlyRelativeWeekday([in] Relatin newval); Prperty MnthlyWeekday As Weekday Retrieves r specifies the day f the week the event is t ccur. HRESULT MnthlyWeekday([ut, retval] Weekday *pval); HRESULT MnthlyWeekday([in] Weekday newval); Prperty Recurrence As Recurrence Fr an example using this prperty, refer t the EventRuleCreatin script in Script Examples. Retrieves r specifies the frequency with which the Timer event is t ccur (hurly, daily, weekly, mnthly, yearly, nce). HRESULT Recurrence([ut, retval] Recurrence *pval); 306

307 Interface Reference HRESULT Recurrence([in] Recurrence newval); Example (C#): bjparams.recurrence = Recurrence.Recurrence_Once; EFT v5.2 and later Prperty RepeatEnabled As Blean Retrieves r specifies whether the event is t repeat. HRESULT RepeatEnabled([ut, retval] VARIANT_BOOL *pval); HRESULT RepeatEnabled([in] VARIANT_BOOL newval); Prperty RepeatPattern As RepeatPattern Retrieves r specifies the recurrence patter (e.g., every 4 hurs). HRESULT RepeatPattern([ut, retval] RepeatPattern *pval); HRESULT RepeatPattern([in] RepeatPattern newval); Prperty RepeatRate As Lng Retrieves r specifies the frequency the event is t recur. HRESULT RepeatRate([ut, retval] lng *pval); HRESULT RepeatRate([in] lng newval); Prperty RundayCalendar As String Retrieves r specifies a custm calendar. HRESULT RundayCalendar([ut, retval] BSTR *pval); HRESULT RundayCalendar([in] BSTR newval); Prperty TimeEndEnabled As Blean Retrieves r specifies whether end time is enabled. HRESULT TimeEndEnabled([ut, retval] VARIANT_BOOL *pval); HRESULT TimeEndEnabled([in] VARIANT_BOOL newval); Prperty WeeklyFriday As Blean Retrieves r specifies every week n Friday. HRESULT WeeklyFriday([ut, retval] VARIANT_BOOL *pval); HRESULT WeeklyFriday([in] VARIANT_BOOL newval); Prperty WeeklyMnday As Blean Retrieves r specifies every week n Mnday. HRESULT WeeklyMnday([ut, retval] VARIANT_BOOL *pval); HRESULT WeeklyMnday([in] VARIANT_BOOL newval); Prperty WeeklySaturday As Blean 307

308 EFT API Reference Retrieves r specifies every week n Saturday. HRESULT WeeklySaturday([ut, retval] VARIANT_BOOL *pval); HRESULT WeeklySaturday([in] VARIANT_BOOL newval); Prperty WeeklySunday As Blean Retrieves r specifies every week n Sunday. HRESULT WeeklySunday([ut, retval] VARIANT_BOOL *pval); HRESULT WeeklySunday([in] VARIANT_BOOL newval); Prperty WeeklyThursday As Blean Retrieves r specifies every week n Thursday. HRESULT WeeklyThursday([ut, retval] VARIANT_BOOL *pval); HRESULT WeeklyThursday([in] VARIANT_BOOL newval); Prperty WeeklyTuesday As Blean Retrieves r specifies every week n Tuesday. HRESULT WeeklyTuesday([ut, retval] VARIANT_BOOL *pval); HRESULT WeeklyTuesday([in] VARIANT_BOOL newval); Prperty WeeklyWednesday As Blean Retrieves r specifies every week n Wednesday. HRESULT WeeklyWednesday([ut, retval] VARIANT_BOOL *pval); HRESULT WeeklyWednesday([in] VARIANT_BOOL newval); Prperty WeeklyWeekPerid As Lng Retrieves r specifies a frequency in weeks (e.g., every 2 weeks). HRESULT WeeklyWeekPerid([ut, retval] lng *pval); HRESULT WeeklyWeekPerid([in] lng newval); Prperty YearlyDayPerid As Lng Retrieves r specifies a frequency (e.g., every 7 days). HRESULT YearlyDayPerid([ut, retval] lng *pval); HRESULT YearlyDayPerid([in] lng newval); Prperty YearlyFixedDay As Blean Retrieves r specifies a specific day (e.g., Every December 31 r the last Saturday f December).. HRESULT YearlyFixedDay([ut, retval] VARIANT_BOOL *pval); HRESULT YearlyFixedDay([in] VARIANT_BOOL newval); Prperty YearlyMnth As Mnth 308

309 Interface Reference Retrieves r specifies the mnth (e.g., Every December 31 r the last Saturday f December). HRESULT YearlyMnth([ut, retval] Mnth *pval); HRESULT YearlyMnth([in] Mnth newval); Prperty YearlyRelativeWeekday As Relatin Retrieves r specifies whether the day is the first, secnd, third, furth, r last day f the week. HRESULT YearlyRelativeWeekday([ut, retval] Relatin *pval); HRESULT YearlyRelativeWeekday([in] Relatin newval); Prperty YearlyWeekday As Weekday Retrieves r specifies a day f the week. HRESULT YearlyWeekday([ut, retval] Weekday *pval); HRESULT YearlyWeekday([in] Weekday newval); ICITimerEventRuleParams in Previus Versins If yu have Timer rules defined in previus versins f COM, nte that the Timer event trigger has had majr imprvements in v6.3 and later; therefre, the API's TimerEventRuleParams interface has als undergne many changes. (Refer t "Scheduler (Timer) Event" in the EFT dcumentatin fr details f hw this Event is used in the administratin interface r scrll dwn t see hw the methds and prperties crrelate t the interface fields and ptins.) The cnstants in the Recurrence enumeratin were changed, and "Recurrence_Calendar" was added: Custm (0) was changed t Recurrence_Cntinually = 0; The Event starts at a specified (future) date and time and repeats every <n> Hurs, Minutes, r Secnds. Daily (1) was changed t Recurrence_Daily = 1; The Event runs every <n> days r every weekday, starting at a specified date and time, and ending n a specified date and time r repeating every <n> hurs, minutes, r secnds. Yu can als exclude certain hlidays and/r end the recurrence f the event at a specified date and time. Weekly (2) was changed t Recurrence_Weekly = 2; The Event runs every <n> weeks n a specified day(s) f the week, starting at a specified date and time and ending n a specified date and time r repeating every <n> hurs, minutes, r secnds. Yu can als exclude certain hlidays and/r end the recurrence f the event at a specified date and time. Mnthly (3) was changed t Recurrence_Mnthly = 3; The Event runs n the <n> day f every <n> mnth(s) r the <nth> day f the week f <n> mnth(s) starting at a specified date and time and ending n a specified date and time r repeating every <n> hurs, minutes, r secnds. Yu can als exclude certain hlidays and/r end the recurrence f the event at a specified date and time. Yearly (4) was changed t Recurrence_Yearly = 4; The Event runs every <mnth> <day> r n the <n> <day f the week> f <mnth> starting at a specified date and time and ending n a specified date and time r repeating every <n> hurs, minutes, r secnds. Yu can als exclude certain hlidays and/r end the recurrence f the event at a specified date and time. OneTime (5) was changed t Recurrence_Once = 5; The Event runs ne time at a specified date and time, and never repeats. 309

310 EFT API Reference Recurrence_Calendar = 6 as added; The timer uses the calendar t get the next run day. This value shuld nt be directly set t the Recurrence prperty f the TimerEventRuleParams bject. Instead, if yu want t use the run calendar in yur timer, set the calendar name t the RundayCalendar prperty, then the Recurrence is autmatically set t the Recurence_Calendar value. Yu can als exclude certain hlidays and/r end the recurrence f the event at a specified date and time. The fllwing prperties in the TimerEventRuleParams interface were remved r renamed in EFT v6.3: CustmPerid DayIndex DayOfMnth DayPerid FixedDate MnthIndex MnthPerid TimeStart WeekDayIndex Weekdays WeekPerid The fllwing prperties, enumeratrs, and cnstants in the TimerEventRuleParams interface were added in EFT Server v6.3: DailyDayPerid As Lng DailyEveryWeekDay As Blean DateEndEnabled As Blean DateTimeEnd As Variant DateTimeStart As Variant HlidayCalendar As String MnthlyDayPerid As Lng MnthlyFixedDay As Blean MnthlyMnthPerid As Lng MnthlyRelativeWeekday As Relatin: Relatin_First Relatin_Secnd Relatin_Third Relatin_Furth Relatin_Last RepeatEnabled As Blean RepeatPattern As RepeatPattern: RepeatHurs 310

311 Interface Reference RepeatMinutes RepeatSecnds RepeatRate As Lng RundayCalendar As String MnthlyWeekday As Weekday: Weekday_Day = 7 Weekday_Friday = 5 Weekday_Mnday = 1 Weekday_Saturday = 6 Weekday_Sunday = 0 Weekday_Thursday = 4 Weekday_Tuesday = 2 Weekday_Wednesday = 3 Weekday_Weekday = 8 Weekday_Weekendday = 9 TimeEndEnabled As Blean WeeklyFriday As Blean WeeklyMnday As Blean WeeklySaturday As Blean WeeklySunday As Blean WeeklyThursday As Blean WeeklyTuesday As Blean WeeklyWednesday As Blean WeeklyWeekPerid As Lng YearlyDayPerid As Lng YearlyFixedDay As Blean YearlyMnth As Mnth: Mnth_January = 0 Mnth_February = 1 Mnth_March = 2 Mnth_April = 3 Mnth_May = 4 Mnth_June = 5 Mnth_July = 6 Mnth_August = 7 Mnth_September = 8 311

312 EFT API Reference Mnth_Octber = 9 Mnth_Nvember = 10 Mnth_December = 11 YearlyRelativeWeekday As Relatin: Relatin_First Relatin_Secnd Relatin_Third Relatin_Furth Relatin_Last YearlyWeekday As Weekday Dialg Bx Equivalents The ICITimerEventRuleParams interface prperties and methds crrelate t the fllwing fields and cntrls in the EFT administratin interface. 312

313 Interface Reference ICITransferActinParams - Transfer Actin Parameters Interface The ICITransferActinParams interface allws yu t make changes t transfer-related Events, such as when a file is upladed r dwnladed. ICITransferActinParams is a tp level IDispatch interface. ICIUpladActinParams and ICIDwnladActinParams are subclasses that inherit frm the parent ICITransferActinParams IDispatch interface. interface ICITransferActinParams : IDispatch Fr an example using these prperties, refer t the EventRuleCreatin script in Script Examples. Prperties Prperty AutLgin As Blean Retrieves r specifies whether t autmatically lgin. HRESULT AutLgin([ut, retval] VARIANT_BOOL *pval); HRESULT AutLgin([in] VARIANT_BOOL newval); EFT v5.2 and later Prperty CnnectinRetryAttempts As Lng Retrieves r specifies the number f times the server will attempt t establish a cnnectin if there are cnnectin prblems (e.g., the netwrk is unavailable). HRESULT CnnectinRetryAttempts([ut, retval] LONG *pval); HRESULT CnnectinRetryAttempts([in] LONG newval); EFT v and later 313

314 EFT API Reference Prperty CnnectinTimeutSecnds As Lng Retrieves r specifies the number f secnds t wait befre cnnectin times ut. HRESULT CnnectinTimeutSecnds([ut, retval] LONG *pval); HRESULT CnnectinTimeutSecnds([in] LONG newval); EFT v and later Prperty DeleteSurceFile As Blean Retrieves r specifies whether t delete the surce file after transfer is cmplete. HRESULT DeleteSurceFile([ut, retval] VARIANT_BOOL *pval); HRESULT DeleteSurceFile([in] VARIANT_BOOL newval); EFT v5.2.5 and later Prperty DeleteSurceFileIfMveSkipped As Blean Retrieves r specifies whether the surce file shuld be deleted when an fflad (mve) r dwnlad was skipped due t an existing identical destinatin file. HRESULT DeleteSurceFileIfMveSkipped([ut, retval] VARIANT_BOOL *pval); HRESULT DeleteSurceFileIfMveSkipped([in] VARIANT_BOOL newval); If UpladParams.DeleteSurceFileIfMveSkipped Then Delete is specified End If set D nt delete surce file if mve is skipped DwnladParams.DeleteSurceFileIfMveSkipped = False EFT v6.6 and later Prperty FTPDataCnnectinMde As FTPDataCnnectinMde Retrieves r specifies the FTP data cnnectin mde: FTPMde_PORT (0) When Prt mde is selected, EFT pens an additinal prt and tells the remte server t cnnect t <IP:PORT> t establish a data cnnectin. This is useful when the server is behind a firewall that clses all unnecessary prts. If yu select this mde, specify the prt range frm which the client will chse. FTPMde_PASV (1) When PASV mde is selected, EFT tells the remte server t prvide <IP:PORT> t which EFT can cnnect t establish a data cnnectin. This is useful when a client is behind a firewall that clses all unnecessary prts. Helps avid cnflicts with security systems. FTPMde_Aut (2) EFT initially makes cnnectins in PASV mde. If the PASV cnnectin fails, EFT attempts t cnnect in PORT mde autmatically. HRESULT FTPDataCnnectinMde([ut, retval] FTPDataCnnectinMde *pval); HRESULT FTPDataCnnectinMde([in] FTPDataCnnectinMde newval); EFT v and later Prperty FTPDataCnnectinPrtMax As Lng Retrieves r specifies the upper end f the prt range. HRESULT FTPDataCnnectinPrtMax([ut, retval] LONG *pval); HRESULT FTPDataCnnectinPrtMax([in] LONG newval); 314

315 Interface Reference EFT v and later Prperty FTPDataCnnectinPrtMin As Lng Retrieves r specifies the lwer end f the prt range. HRESULT FTPDataCnnectinPrtMin([ut, retval] LONG *pval); HRESULT FTPDataCnnectinPrtMin([in] LONG newval); EFT v and later Prperty FTPSClearCmmandChannel As Blean Retrieves r specifies whether EFT sends FTP cmmands in clear text. Only available nly when FTPS is specified. HRESULT FTPSClearCmmandChannel([ut, retval] VARIANT_BOOL *pval); HRESULT FTPSClearCmmandChannel([in] VARIANT_BOOL newval); EFT v and later Prperty FTPSClearDataChannel As Blean Retrieves r specifies whether EFT transfers files withut encryptin. Only available nly when FTPS is specified. HRESULT FTPSClearDataChannel([ut, retval] VARIANT_BOOL *pval); HRESULT FTPSClearDataChannel([in] VARIANT_BOOL newval); EFT v and later Prperty Hst As String Retrieves r specifies the hst address. HRESULT Hst([ut, retval] BSTR *pval); HRESULT Hst([in] BSTR newval); EFT v5.2 and later Prperty LcalPath As String Retrieves r specifies the lcal path. HRESULT LcalPath([ut, retval] BSTR *pval); HRESULT LcalPath([in] BSTR newval); EFT v5.2 and later Prperty MaxCncurrentThreads As Lng Retrieves r specifies the maximum number f cncurrent threads. HRESULT MaxCncurrentThreads([ut, retval] LONG *pval); HRESULT MaxCncurrentThreads([in] LONG newval); EFT v and later Prperty OverwriteType As TransferOverwriteType Retrieves r specifies the transfer verwrite type. HRESULT OverwriteType([ut, retval] TransferOverwriteType *pval); HRESULT OverwriteType([in] TransferOverwriteType newval); if TransferOTOverwrite = TA.OverwriteType then MsgBx "OverwriteType: Always verwrite" end if 315

316 EFT API Reference TA.OverwriteType = TransferOTSmart Prperty Passwrd As String Retrieves r specifies the passwrd. HRESULT Passwrd([ut, retval] BSTR *pval); HRESULT Passwrd([in] BSTR newval); EFT v5.2 and later Prperty Prt As Lng Retrieves r specifies the prt. HRESULT Prt([ut, retval] lng *pval); HRESULT Prt([in] lng newval); EFT v5.2 and later Prperty PreserveFileTime As Blean Retrieves r specifies whether t keep a file's time stamp that same n the lcal cmputer as n the remte server. Use ICIDwnladActinParams::PreserveTimeStamp t keep a dwnladed file's time stamp the same n the lcal cmputer as it is n the remte server. Use ICIUpladActinParams::PreserveTimeStamp t keep an upladed file's time stamp the same n EFT as it is n the lcal cmputer. (Nt applicable t SFTP.) HRESULT PreserveFileTime([ut, retval] VARIANT_BOOL *pval); HRESULT PreserveFileTime([in] VARIANT_BOOL newval); EFT v and later Prperty PrivateKeyPasswrd As String Retrieves r specifies the private key passwrd. HRESULT PrivateKeyPasswrd([ut, retval] BSTR *pval); HRESULT PrivateKeyPasswrd([in] BSTR newval); EFT v6.0 and later Prperty PrivateKeyPath As String Retrieves r specifies the private key path. HRESULT PrivateKeyPath([ut, retval] BSTR *pval); HRESULT PrivateKeyPath([in] BSTR newval); EFT v6.0 and later Prperty Prtcl As NetwrkPrtcl Retrieves r specifies the netwrk prtcl. HRESULT Prtcl([ut, retval] NetwrkPrtcl *pval); HRESULT Prtcl([in] NetwrkPrtcl newval); EFT v5.2 and later Prperty PrxyAdvCustmCmds As String (In v6.3.0, the "y" in "Prxy" was missing. Please update yur scripts accrdingly.) Retrieves r specifies whether t use prxy cmmands. 316

317 Interface Reference HRESULT PrxyAdvCustmCmds([ut, retval] BSTR *pval); HRESULT PrxyAdvCustmCmds([in] BSTR newval); MsgBx "Custm cmmands is: " & TA.PrxyAdvCustmCmds TA.PrxyAdvCustmCmds = "" Prperty PrxyAdvSeparatr As String (In v6.3.0, the "y" in "Prxy" was missing. Please update yur scripts accrdingly.) Retrieves r/specifies separatr fr username and Site name in case f PrxyAuthUserAtSite authenticatin. HRESULT PrxyAdvSeparatr([ut, retval] BSTR *pval); HRESULT PrxyAdvSeparatr([in] BSTR newval); PrxyAuthenticatinType PrxyAuthCustm = 5 PrxyAuthOpenSite = 4 PrxyAuthSite = 1 PrxyAuthUserAtSite = 0 PrxyAuthUserPassAcct = 3 PrxyAuthUserWithLgn = 2 if PrxyAuthSite = TA.PrxyAdvAuthenticatinType then ' sme cde end if TA.PrxyAdvAuthenticatinType = PrxyAuthUserWithLgn Prperty PrxyAuthenticatinType As PrxyAuthenticatinType (In v , this prperty was PrxyAdvAuthenticatinType. Please update yur scripts accrdingly.) Retrieves r specifies the prxy authenticatin type. HRESULT PrxyAuthenticatinType([ut, retval] PrxyAuthenticatinType *pval); HRESULT PrxyAuthenticatinType([in] PrxyAuthenticatinType newval); if PrxyAuthSite = TA.PrxyAuthenticatinType then ' sme cde end if TA.PrxyAdvAuthenticatinType = PrxyAuthUserWithLgn 317

318 EFT API Reference Prperty PrxyHstName As String Retrieves r specifies the prxy hst name r IP address. HRESULT PrxyHstName([ut, retval] BSTR *pval); HRESULT PrxyHstName([in] BSTR newval); MsgBx "Prxy hst is: " & TA.PrxyHstName TA.PrxyHstName = " " Prperty PrxyPasswrd As String Retrieves r specifies the prxy passwrd. HRESULT PrxyPasswrd([ut, retval] BSTR *pval); HRESULT PrxyPasswrd([in] BSTR newval); MsgBx "Prxy user name is: " & TA.PrxyPasswrd TA.PrxyPasswrd = "swrdfish" Prperty PrxyPrt As Lng Retrieves r specifies the prxy prt. HRESULT PrxyPrt([ut, retval] LONG *pval); HRESULT PrxyPrt([in] LONG newval); MsgBx "Prxy prt is: " & TA.PrxyPrt TA.PrxyPrt = 8080 Prperty PrxyType As PrxyType Retrieves r specifies the prxy type. NOTE: Yu must set CIUpladActinParams.UsePrxy = true befre yu set the CIUpladActinParams.prxyType prperty, HRESULT PrxyType([ut, retval] PrxyType *pval); HRESULT PrxyType([in] PrxyType newval); if PrxyTypeDMZ = TA.PrxyType then MsgBx "DMZ prxy is selected." 318

319 Interface Reference end if TA.PrxyType = PrxyTypeHTTP Prperty PrxyUserName As String Retrieves r specifies the prxy user name. HRESULT PrxyUserName([ut, retval] BSTR *pval); HRESULT PrxyUserName([in] BSTR newval); MsgBx "Prxy user name is: " & TA.PrxyUserName TA.PrxyUserName = "User_1" Prperty PublicKeyPath As String Retrieves r specifies the public key path. HRESULT PublicKeyPath([ut, retval] BSTR *pval); HRESULT PublicKeyPath([in] BSTR newval); EFT v6.0 and later Prperty RemtePath As String Retrieves r specifies the remte path. HRESULT RemtePath([ut, retval] BSTR *pval); HRESULT RemtePath([in] BSTR newval); EFT v5.2 and later Prperty RenameAfterTransfer As Blean Specify whether t rename a file after it is transferred. HRESULT RenameAfterTransfer( [ut, retval] VARIANT_BOOL *pval); HRESULT RenameAfterTransfer( [in] VARIANT_BOOL newval); EFT v6.4 and later Prperty RenameAfterTransferT As String Specify a new name fr a transferred file. HRESULT RenameAfterTransferT( [ut, retval] BSTR *pval); HRESULT RenameAfterTransferT( [in] BSTR newval); EFT v6.4 and later Prperty RetryDelaySecnds As Lng Specify the number f secnds t wait befre retrying a failed transfer. HRESULT RetryDelaySecnds([ut, retval] LONG *pval); HRESULT RetryDelaySecnds([in] LONG newval); 319

320 EFT API Reference EFT v and later Prperty SOCKSHstName As String Retrieves r specifies the SOCKS hst name. HRESULT SOCKSHstName([ut, retval] BSTR *pval); HRESULT SOCKSHstName([in] BSTR newval); MsgBx "SOCKS server hst name is: " & TA.SOCKSHstName TA.SOCKSHstName = " " Prperty SOCKSPasswrd As String Retrieves r specifies the SOCKS passwrd. HRESULT SOCKSPasswrd([ut, retval] BSTR *pval); HRESULT SOCKSPasswrd([in] BSTR newval); MsgBx "Use SOCKS5 passwrd: " & TA.SOCKSPasswrd TA.SOCKSPasswrd = "swrdfish" Prperty SOCKSPrt As Lng Retrieves r specifies the SOCKS prt. HRESULT SOCKSPrt([ut, retval] LONG *pval); HRESULT SOCKSPrt([in] LONG newval); MsgBx "SOCKS server prt is: " & CStr(TA.SOCKSPrt) TA.SOCKSPrt = 1080 Prperty SOCKSType As SOCKSType Retrieves r specifies the type f SOCKS server. HRESULT SOCKSType([ut, retval] SOCKSType *pval); HRESULT SOCKSType([in] SOCKSType newval); if SOCKS5 = TA.SOCKSType then MsgBx "SOCKS 5" end if 320

321 Interface Reference TA.SOCKSType = SOCKS4 Prperty SOCKSUseAuthenticatin As Blean Retrieves r specifies whether t use authenticatin n a SOCKS server. HRESULT SOCKSUseAuthenticatin([ut, retval] VARIANT_BOOL *pval); HRESULT SOCKSUseAuthenticatin([in] VARIANT_BOOL newval); MsgBx "Use SOCKS5 authenticatin: " & CStr(TA.SOCKSUseAuthenticatin) TA.SOCKSUseAuthenticatin = False Prperty SOCKSUserName As String Retrieves r specifies the SOCKS username when SOCKS HRESULT SOCKSUserName([ut, retval] BSTR *pval); HRESULT SOCKSUserName([in] BSTR newval); MsgBx "Use SOCKS5 user name: " & TA.SOCKSUserName TA.SOCKSUserName = "User_1" Prperty TextFileTypes As String Retrieves r specifies the file types that will be transferred and text files (ASCII). HRESULT TextFileTypes([ut, retval] BSTR *pval); HRESULT TextFileTypes([in] BSTR newval); EFT v and later Prperty TransferEncding As TransferEncdingType Retrieves r specifies the transfer encding mde fr client transfer (uplad/dwnlad) Actins. HRESULT TransferEncding([ut, retval] TransferEncdingType *pval); HRESULT TransferEncding([in] TransferEncdingType newval); If UpladParams.TransferEncding = 0 Then Aut-detect End If set Aut-detect mde fr Dwnlad actin DwnladParams.TransferEncding = 0 321

322 EFT API Reference EFT v6.5 and later Prperty TreatMissingSurceAsSuccess As Blean Specify whether a missing surce file is treated as a success (TRUE) r failure (FALSE). HRESULT TreatMissingSurceAsSuccess( [ut, retval] VARIANT_BOOL *pval); HRESULT TreatMissingSurceAsSuccess( [in] VARIANT_BOOL newval); EFT v6.4 and later Prperty UsePrxy As Blean Retrieves r specifies whether t use a prxy server fr the transfer. NOTE: Yu must set CIUpladActinParams.UsePrxy = true befre yu set the CIUpladActinParams.prxyType prperty, HRESULT UsePrxy([ut, retval] VARIANT_BOOL *pval); HRESULT UsePrxy([in] VARIANT_BOOL newval); if True = TA.UserPrxy then MsgBx "Prxy is using." end if TA.UserPrxy = False Prperty User As String Retrieves r specifies username. HRESULT User([ut, retval] BSTR *pval); HRESULT User([in] BSTR newval); EFT v5.2 and later Prperty UseSOCKS As Blean Retrieves r specifies whether t use SOCKS. HRESULT UseSOCKS([ut, retval] VARIANT_BOOL *pval); HRESULT UseSOCKS([in] VARIANT_BOOL newval); MsgBx "Using SOCKS: " & CStr(TA.UseSOCKS) TA.UseSOCKS = False Prperty ValidateIntegrity As Blean Specify that EFT shuld duble check binary files t ensure the files dwnladed cmpletely and crrectly. (Nt applicable t SFTP.) HRESULT ValidateIntegrity([ut, retval] VARIANT_BOOL *pval); HRESULT ValidateIntegrity([in] VARIANT_BOOL newval); 322

323 Interface Reference EFT v and later Dialg Bx Equivalents The ICITransferActinParams interface prperties and methds crrelate t the fllwing fields and cntrls in the EFT administratin interface. Advanced Optins Several API prperties were intrduced in EFT v with which yu can specify the advanced ptins in a File Dwnlad r File Offlad Event Rule Actin. (T view the Advanced Optins dialg bx in the EFT administratin interface, in the File Dwnlad Cnfiguratin wizard r the File Offlad Cnfiguratin wizard, click Advanced.) 323

324 EFT API Reference Cpy/Mve Actin Wizard 324

325 Interface Reference ICIUpladActinParams - Uplad Actin Parameters Interface The ICIUpladActinParams interface (derived frm ICITransferActinParams defining client peratin parameters) allws yu t make changes t the Event Rule settings. interface ICIUpladActinParams : ICITransferActinParams Refer t ICITransferActinParams - Transfer Actin Parameters Interface fr details f the methds and prperties. ICIWindwsEventLgActinParams - Windws Event Lg Actin Parameters Interface The ICIWindwsEventLgActinParams interface prperties are listed belw. interface ICIWindwsEventLgActinParams : IDispatch Prperties Prperty Descriptin As String Retrieves r specifies the descriptin. HRESULT Descriptin([ut, retval] BSTR* pval); HRESULT Descriptin([in] BSTR newval); MsgBx "Event is: " & WEL.Descriptin WEL.Descriptin = "Sme event" Prperty EventID as Lng Retrieves r specifies the event lg ID. HRESULT EventID([ut, retval) LONG* pval); HRESULT EventID([in] LONG newval); EFT v6.4 and later Prperty type As EventLgType Retrieves r specifies the event lg type. HRESULT Type([ut, retval] EventLgType* pval); HRESULT Type([in] EventLgType newval); Example (C#): eventlgactinparams.type = EventLgType.EventErrr; if EventInfrmatin = WEL.Type then ' end if 325

326 EFT API Reference WEL.Type = EventErrr Dialg Bx Equivalents 326