ICIClientSettings Interface

The ICIClientSettings interface displays the user properties defined for a user in EFT.

interface ICIClientSettings : IDispatch

Use the ICISite interface GetUserSettings or GetSettingsLevelSettings methods to manage user account or Settings Template configuration.

Example:

Set oUser = oSite.GetUserSettings(aUsr(j))

Set 0SettingsLevel = oSite.GetSettingsLevelSettings("Default Settings")

Once you obtain a handle to the user or Settings Template configuration, you can Get or Set permissions for that user or Settings Template.

See also:

Difference Between VARIANT_BOOL and SFTPAdvBool

Scroll down to see the dialog box equivalents; Refer to Workspaces Settings for details of Settings Template and user Workspaces settings.

Example of using the Custom property

Jump to: C  E  F  G  I  L  M  P  R  S  U

Dialog Box Equivalents

The ICIClientSettings interface methods and properties correlate to the following fields and controls in the EFT administration interface:

User Account Details Properties

User account details include the user's full name, phone, e-mail, fax, and pager, and can include custom fields and comments. You can view/set the user account details in the administration interface on the user's General tab by clicking Account Details.

The dialog box below is labeled with some of the parameters that are available in the ICIClientSettings interface

.

User Account General Settings

User Connection Limits

User Connection Protocols

User SFTP Authentication Options

User FTP Security Settings

User IP Access Ban List

User Login Security Options

 

User Security and Password Settings

In 7.3.6 and earlier:

In 7.3.7 and later:

User Transfer Limits Settings

User connection limits in the API include getting/setting the number of uploads and download per session and maximum upload and download sizes. The dialog box below, available from the user's Connections tab, is labeled with some of the transfer limits parameters that are available in the ICIClientSettings interface.

Example of using the Custom property

// eftTestCustomFields.js

// CREATED: 24 May 2007

// Script to confirm use of EFT5 Custom Fields properties of a CClientSettings in Javascript through API.

//

 

var args = WScript.Arguments;

if ( args.length < 5 )

{

 WScript.Echo("Usage: eftTestCustomFields <eft host> <eft port> <userid> <password> <user id>\n");

 WScript.Echo("Example:  cscript eftTestCustomFields.js 192.168.20.101 1100 admin admin foo\n");

 WScript.Quit(1);

}

var sHost = args(0);

var iPort = args(1);

var sUser = args(2);

var sPass = args(3);

var sAccountName = args(4);

 

var server = new ActiveXObject("SFTPCOMInterface.CIServer");

WScript.Echo("Connecting...");

server.Connect(sHost, iPort, sUser, sPass);

WScript.Echo("Connected!");

var site = server.Sites().SiteByID(1); // for simplicity, assume first site

var oSettings = site.GetUserSettings(sAccountName);

 

WScript.Echo("Obtained user settings for user account '" + oSettings.FullName + "' with home directory: " + oSettings.GetHomeDirString() );

WScript.Echo("Custom1='" + oSettings.Custom1 + "'");

WScript.Echo("Custom2='" + oSettings.Custom2 + "'");

WScript.Echo("Custom3='" + oSettings.Custom3 + "'");

 

// Now set the custom fields to new values

WScript.Echo("\nSetting new values...");

oSettings.Custom1 = "Random=" + Math.floor((65535*Math.random())) + " [" + (new Date()).toLocaleString() + "]";

oSettings.Custom2 = "Random=" + Math.floor((65535*Math.random())) + " [" + (new Date()).toLocaleString() + "]";

oSettings.Custom3 = "Random=" + Math.floor((65535*Math.random())) + " [" + (new Date()).toLocaleString() + "]";

 

server.ApplyChanges();

 

// Now REQUERY to CONFIRM the custom fields are the new values

WScript.Echo("Requerying values...");

var oSettings = site.GetUserSettings(sAccountName);

WScript.Echo("\nObtained NEW user settings for user account '" + oSettings.FullName + "' with home directory: " + oSettings.GetHomeDirString() );

WScript.Echo("Custom1='" + oSettings.Custom1 + "'");

WScript.Echo("Custom2='" + oSettings.Custom2 + "'");

WScript.Echo("Custom3='" + oSettings.Custom3 + "'");

 

server.Close();

 

WScript.Echo("\nDone");

WScript.Quit(0);