Table of Contents

  1. Overview
    1. Introduction
    2. Features
  2. Installation
    1. Deploying to a web server
  3. Using the FileCatalyst Applet
    1. Minimum System Requirements
    2. User Interface
    3. Connecting to a FileCatalyst server
    4. Directory browsing
    5. Selecting files and directories
    6. Deleting files and directories
    7. Renaming files and directories
    8. Transferring files and directories
    9. Creating a directory
    10. Popup menu
  4. Configuring the FileCatalyst Applet
    1. Connection parameters
    2. FileCatalyst tuning
    3. Functionality related parameters
    4. Color settings
    5. User Interface parameters
    6. Error URL parameters
    7. Language settings and internationalization
  5. Advanced Features
    1. Hiding Connect, Disconnect, Help and About buttons
    2. Disabling individual buttons
    3. Customizing the help location
    4. Customizable right click options
    5. Advanced file filtering
    6. Resuming broken or interrupted transfers
  6. Support
    1. Online Support Options

 


1 Overview

1.a Introduction

To customize FileCatalyst applet, you must edit "fcappletscript.js" with an HTML/text editor. You can then use the following tables as a guide to customizing each of FileCatalyst's parameters.

Then add the following line to your HTML file:

<script language="javascript" src="fcappletscript.js"></script>

You must also make sure that you either put fcappletscript.js in the same directory as your page, or the src parameter reflects the location of the script file.

If you require further assistance with setup, or are interested in related products and customization services, please visit our website.

1.b Features

The following is a list of the main features of FileCatalyst.

  • Can run from any web page using Internet Explorer, Firefox, or Safari browsers
  • Can run from any browser with Java 1.4 or higher enabled.
  • Runs on many OS's including Windows, Linux, Mac 10.2 or higher, and any other platform with a Java 1.4 or higher VM
  • Local and Remote Directory browsing through a Windows-like interface.
  • The ability to transfer multiple files and/or directories and directory tree structures.
  • Smart file viewing in Windows. Files with certain file extensions automatically open in the default application.
  • File filtering allows you to configure FileCatalyst to view and transfer only files with specific extensions or file name.
  • Ability to limit browsing to initial directory and its sub-directories.
  • Incremental transfers
  • Resume broken transfers automatically
  • Recover from several types of transfer errors, with ability to specify number of retries.
  • Auto-upload/auto-download capabilities.
  • Progress dialog with transfer speed and cancel button.
  • Configurable display options.
  • Customizable right click file options

2 Installation

2.a Deploying to a web server

  1. Extract the contents of fc_applet.zip to your local hard disk using a zip utility
  2. Create a directory on your web server. For example /filecatalyst.
  3. Upload all files extracted in Step 1. to the directory you created on the web server in Step 2.
  4. Go to test page located at the URL http://yourserver.com/dir/index.html, where yourserver.com is replaced by your domain name. Example: http://www.utechsoft.com/FileCatalyst/index.html
  5. To customize the Functionality of FileCatalyst, edit the file fcappletscript.js with a text editor such as Notepad. Each of the customizable parameters is defined below in Section 4
  6. Upload the new fcappletscript.js to your web server.

3 Using FileCatalyst

3.a Minimum System Requirements

The minimum system requirements for using FileCatalyst are as follows:

  • Operating Systems: Windows 2000/XP/Vista, Mac OS 10.2 or higher, Linux, Unix
  • Browser: Internet Explorer, Safari, Firefox
  • Browser Java VM: Java 1.4 or above
  • FileCatalyst server (must be accessible from your machine)

3.b User Interface

Below is a screen shot of the FileCatalyst user interface. Depending on your Operating System and browser, as well as the parameters you have configured, your display may differ slightly.


The FileCatalyst Interface for Windows
  1. Current local directory - Displays the full path of your current local directory.
  2. Local toolbar - Buttons for performing actions on your local directory.
  3. Current remote directory - Displays the path of your current remote directory.
  4. Remote toolbar - Buttons for performing actions on your remote directory.
  5. Local file listing - Displays files and child folders in your current local directory.
  6. Upload / Download - these buttons initiate upload or download of selected files.
  7. Remote file listing - Displays files and child folders in your current remote directory.
  8. FileCatalyst message display - Displays messages sent to and received from the FileCatalyst server.
  9. Connect / Disconnect - Unless autoconnect is set to true, these buttons allow user to connect or disconnect.

The FileCatalyst Interface for OSX

3.c Connecting to a FileCatalyst Server

To load FileCatalyst applet, use your web browser to open the test page you uploaded during installation. See Deploying to a web server. Upon loading FileCatalyst a dialog will be presented similar to the one shown below asking you to confirm that you trust the certificate used to sign the applet. The dialog may vary depending on the browser you use. You must accept this dialog for the applet to continue loading. To avoid this dialog from being displayed each time you connect click on the "Always" button. This dialog ensures that FileCatalyst is a trusted application, and you wish to allow it to run with full permissions.


Java Plugin Security Warning in Windows
Security warning on Mac OSX Safari
Java Security Warning on MacOSX in Safari

Once you have accepted the certificate dialog, FileCatalyst will continue loading. Depending on how FileCatalyst was configured (See Configuring FileCatalyst) it may connect you to your FileCatalyst server automatically.

To connect manually, click on the "Connect" button. The following dialog (Fig. 3.4) will be displayed prompting you for hostname, port, username and password. If you wish to use an anonymous connection click on the "Anonymous" checkbox to generate an anonymous username and password. If you are behind a firewall or proxy server click the "Passive" checkbox. Click on the "Connect" button to connect to the FileCatalyst server.


Connect dialog Windows 7

Connect dialog OSX

Once a connection has been established the remote directory listing will be loaded with the files and directories from your FileCatalyst server.

3.d Directory browsing

The remote and local file list displays the files and folders in your current working directory. Folders are identified by the folder icon and files are identified by the file icon . To see the contents of a sub folder, double click on its icon. You may return to a parent folder by clicking on the parent folder icon . The parent folder icon is shown at the top of the remote and local lists at all times for easy access.

Directory browsing may also be done using the keyboard using the up/down arrows and the Enter key. You may quickly move the list to a file beginning with a certain letter by pressing the first letter of that file won your keyboard. Pressing enter on a folder will automatically enter that folder for browsing. Pressing enter with a file selected will initiate an upload or download depending on which list, local or remote, you are browsing.

FileCatalyst also provides quick access to the Desktop and My Documents folders on Windows, and the Home and Finder folders on Mac platform.

3.e Selecting files and directories

To select a file or folder, click on the item in the directory listing using your mouse. You may select multiple files by holding down the SHIFT key and selecting the first and last file in the desired range. Alternatively, you may select multiple items by holding the CTRL key and selecting each item using your mouse. You may also select all files in the current working directory by right clicking and choosing the "Select All" Option.

3.f Deleting files and directories

To delete one or more items in a directory listing, select the items you wish to delete and click on the Delete button or press the delete key on your keyboard. A confirmation dialog will be displayed asking you to confirm this action. Click Yes to confirm or No to abort this operation. Internet Explorer users will see the familiar Recycle bin dialog when they attempt to delete files from the local file system. These files will be recoverable after they are deleted. All other users who do not see the recycle bin dialog, will be deleting files permanently and they will not be recoverable. Please take care when deleting files or folders.


Delete dialog

3.g Renaming files and directories

To rename a file or directory, select the file you wish to rename and click the Rename button. The rename dialog will appear (Fig. 3.6) and will be pre-populated with the current file name. Type in the new name and click Ok to confirm or Cancel if you do not want to rename the file.


Rename dialog

3.h Transferring files and directories

To upload or download files and directories, select the items you wish to transfer and check that the proper transfer mode is selected. (See Setting transfer mode). To upload selected items from your local directory listing, click on the Upload button. To download selected items from your remote directory listing, click on the Download button.

Once you initiate a file transfer, a progress dialog will appear (Fig. 3.7) and display the percentage complete, the current rate of transfer, and the estimated time to completion. To cancel the transfer click the "Cancel" button. Canceling the transfer will not delete any files already transferred, unless you have enabled the "deleteOnCancel" parameter. If you restart the transfer, you will be prompted to resume any files that were not completed in the previous transfer.


Transfer progress Windows 7

Transfer progress OSX

3.i Creating a directory

To create a directory, click on the Mkdir button. A dialog will be displayed prompting you for the name of the new directory. Click the Ok button to create the directory.


Make directory dialog

FileCatalyst provides a convenient way to access various functions that are applicable to the files or folders that you have selected. To access these functions, simply select the file(s) and or folder(s) you wish to work with, and right click on them. You will be presented with a popup similar to the one below (Fig. 3.9) . The popup you see will vary if you click remote or local files or directories, and depending on how many files you select.


Popup menu options

Some of the options do the same as their Button counterpart. However, here is a description of the functions that are only in the right click popup menu.

Download/Upload As...

options will upload or download the selected file but will save it under the name you specify rather than using the current name of the file. This is useful if you know the filename already exists, and you do not wish to overwrite.

Open With...

is a Windows specific option that will allow you to choose the application with which you would like to Open the selected file.

Chmod (UNIX)

is a Unix specific command, and allows you to set the file permissions on files on your FileCatalyst server. This is sometimes required when you upload HTML pages for a website.

Command Prompt Here

will open a Windows Command prompt and automatically place you in the selected directory.

Windows Explorer Here

will open a Windows Explorer window and automatically place you in the selected directory.

Properties

will display the Filename, Size, and Last modified date of the selected file.

Select All

will select all files in the current working directory.

NOTE: To access the popup on Mac systems with a single button mouse, hold down the CTRL key when the mouse is clicked.

4 Configuring FileCatalyst

4.a Connection parameters

These parameters control how FileCatalyst will establish the connection to the FileCatalyst server. Please note that some parameters are only available in certain versions. The FileCatalyst version that supports the particular parameter is noted under the description of each parameter.

Connection related settings
server

The host name or IP address of the FileCatalyst server.

Default value: ""
Valid values: "<valid hostname or IP address>"

In FileCatalyst Webmail and Workflow, this parameter is set automatically

port

The port number of the FileCatalyst server. Usually the default FileCatalyst port is 21.

Default value: "21"
Valid values: "<valid port number>"

In FileCatalyst Webmail and Workflow, this parameter is set automatically

pass

The password for the FileCatalyst server account.

Default value: ""

In FileCatalyst Webmail and Workflow, this parameter is set automatically

user

The username for the FileCatalyst server account.

Default value: ""

In FileCatalyst Webmail and Workflow, this parameter is set automatically

passive

If set to "true", all data connections will be outgoing. FileCatalyst works through firewalls when this value is set to "true".

Default value: "true"
Valid values: "true", "false"

In FileCatalyst Webmail and Workflow, this parameter is set automatically

autoconnect

If this value is set to "true", FileCatalyst will automatically connect based on the connection credentials supplied in the above parameters. The default value is "false".

Default value: "false"
Valid values: "true", "false"

In FileCatalyst Webmail and Workflow, this parameter is set automatically

autoreconnect

If this value is set to "true", FileCatalyst will automatically ask the user if they would like to reconnect after a time-out has occurred, or they have been disconnected for some other reason. If "autoconnect" is set to true, it will log them directly in to the server. If not, the user will be presented with the Connect dialog, pre-populated with the connection info.

Default value: "true"
Valid values: "true", "false"

In FileCatalyst Webmail and Workflow, this parameter is set automatically

encrypt

If set to "true" you must pass encrypted user/pass/server parameters to FileCatalyst, which will decrypt them and perform the login. The encryption is based on a key value that is specified by the "ek" parameter below. To encrypt parameters you can use encrypt.html that was downloaded with FileCatalyst. This provides at least some measure of protection from prying eyes, and people who love to snoop through your HTML.

Although this seems very un-secure to include the encryption algorithm along with the applet, keep in mind this is only a way to hide login credentials from users who try to view the HTML source of your page. Determined hackers will easily be able to sniff the network to retrieve user and password info regardless of the encryption done in the HTML.

Default value: "false"
Valid values: "true", "false"

In FileCatalyst Webmail and Workflow, this parameter is set automatically

ek

This parameter works in conjunction with the "encrypt" parameter. This is the key that is used to encode/decode the string value you pass to the user, pass, and server parameters. Here is an example configuration. In this example, the server/user/pass strings are 192.168.1.100/anonymous/fc@FileCatalyst.com respectively. This illustrates how the parameters will look to anyone who inspects the connection values in your HTML:

var server = "8I7BLHN;8I8@5";
var port = "21";
var pass = "|vy&[)&yp*p&jx#((;j,t";
var user = "h~t$6!=$z";
var autoconnect = "true";
var autoreconnect = "true";
var passive = "true";
var encrypt = "true";
var ek = "encryptkey";

Default value: ""
Valid values: "<string value>"

In FileCatalyst Webmail and Workflow, this parameter is set automatically

connecttimeout

This value (in milliseconds) specifies how long FileCatalyst will try to connect to an FileCatalyst server before giving up and timing out.

Default value: "20000"
Valid values: "<integer value>"

sotimeout

This value (in milliseconds) specifies how long a data connection will wait to read data before giving up and timing out.

Default value: "-1" means no timeout
Valid values: "<integer value>"

waitRetry

This value (in milliseconds) specifies how long FileCatalyst will wait, if a transfer error occurs, before it tries to reconnect and resume the transfer.

Default value: "3000" (3 seconds)
Valid values: "<integer value>"

maxRetries

This value specifies how many times FileCatalyst will try, if a transfer error occurs, to reconnect and resume the transfer.

Default value: "1"
Valid values: "<integer value>"

4.b FileCatalyst Tuning

These parameters allow you to configure FileCatalyst to perform properly over your specific network conditions.

FileCatalyst tuning parameters
mode

Specifies protocol used to transfer files.

UDP -- Utilizes the FileCatalyst protocol for fast network transfers. Immune to latency on the network.

FTP -- Utilizes a passive multi-stream TCP connection (data ports). If failure occurs, protocol attempts a passive TCP connection (both control and data are sent through main transfer port). Fast transfers over LAN, slow transfers over WAN.

HTTP -- Data sent via HTTP posts to HTTP Servlet (default web port 80), where the data is captured reconstructed on the servlet and forwarded to the FileCatalyst server. Slower transfers, but able to navigate through most firewalls.

AUTO -- Protocol will attempt to transfer via UDP. If connections cannot be established, failover cascades to other protocols in this order to attempt a successful connections:

  1. UDP
  2. Passive TCP
  3. Port TCP
  4. HTTP (if http servletLocation is configured)

Default value: UDP
Valid values: AUTO, UDP, FTP, HTTP

In FileCatalyst Webmail and Workflow, this parameter is set automatically

servletLocation

HTTP Servlet location. Used in conjuction with the Unlimited FTP Servelet to allow HTTP transfers.

Default value: ""
Valid values: Network address for the HTTL servlet (example: "http://192.168.1.100:8080/uftps/ftpservlet")

In FileCatalyst Webmail and Workflow, this parameter is set automatically

servletUploadMultiplier

Adjusts the size of data passed into each HTTP post (n * 2048 bytes)

Default value: 2
Valid values: 1-10 (may be servlet limit)

blocksize

The block size in bytes

Default value: "4096000"
Valid values: "<integer value>"

In FileCatalyst Webmail and Workflow, this parameter is set automatically

unitsize

The packet size in bytes

Default value: "1024"
Valid values: "<integer value>"

In FileCatalyst Webmail and Workflow, this parameter is set automatically

numencoders

Specify the number of encoders for the FileCatalyst applet to use

Default value: "3"
Valid values: "<integer value>"

In FileCatalyst Webmail and Workflow, this parameter is set automatically

bandwidth

Target rate in kbps (including UDP and IP headers) to transmit

Default value: "10000"
Valid values: "<integer value>"

In FileCatalyst Webmail and Workflow, this parameter is set automatically

verifyIntegrity

If set to true the server will verify if file was corrupted during transfer

Default value: "false"
Valid values: "true", "false"

verifyIntegrityMode

If verifyIntegrity is set to "true", use this to choose between verifying after file transfer (0) or on the fly (1).

Default value: "0"
Valid values: "0", "1"

enableSSL

If set to true the applet will try to connect with SSL mode

Default value: "false"
Valid values: "true", "false"

In FileCatalyst Webmail and Workflow, this parameter is set automatically

keepFileAttributes

true/false will preserve the file modification date/time and
UNIX file permissions if applicable (default false)Default value: ""

Default value: "false"
Valid values: "true", "false"

congestionControl

If set to true, applet will start with a slow transfer speed and ramp up to a maximum. This is best used if you do not know your linespeed

Default value: "true"
Valid values: "true", "false"

In FileCatalyst Webmail and Workflow, this parameter is set automatically

startRate

Specifies the rate in Kbps at which transfer will start before ramping up to target bandwidth.

Default value: "384"
Valid values: "<integer value>"

In FileCatalyst Webmail and Workflow, this parameter is set automatically

congestionControlAggression

Specifies the congestion control aggression between 1 and 10. 1 is least aggressive and 10 is most aggressive.

Default value: "2"
Valid values: "<integer value between 1 and 10 >"

In FileCatalyst Webmail and Workflow, this parameter is set automatically

congestionControlStrategy

Specifies the congestion control Strategy (0 = RTT based and 1 = Loss based).

Default value: "0"
Valid values: "<integer value 0 or 1>"

In FileCatalyst Webmail and Workflow, this parameter is set automatically

numFTPStreams

When transferring in FTP mode, this specifies how many concurrent streams to use for data transfer

Default value: "3"
Valid values: "<integer value>"

In FileCatalyst Webmail and Workflow, this parameter is set automatically

incremental

If set to "true", files will be compared prior to transfer to check for duplicates. Based on the value of the "incrementalMode" variable, either the entire file will be sent again, or a file "delta" will be sent and applied.

Default value: "false"
Valid values: "true", "false"

incrementalMode

If incremental is set to "true", this variable determines whether the entire file is sent (0), or a file delta is sent (1). File deltas are partial files which are applied as a patch to the destination file in order to create a duplicate of the source.

Default value: "0"
Valid values: "0", "1"

useTempName

If set to "true", destination file will be transferred using a temporary file name, and only renamed after the transfer has completed.

Default value: "false"
Valid values: "true", "false"

useTempNameMode

If "useTempName" is true, determines whether temporary filenames use a prefix (0) or a suffix (1).

Default value: "0"
Valid values: "0", "1"

4.c Functionality related settings

These parameters determine how FileCatalyst will behave under certain circumstances after a connection is established. Please read the descriptions carefully before attempting to use these settings.

Functionality related Settings
ascbin

Can be either "asc","bin" or "auto", you can set the default file transfer mode. When this parameter is set to auto, FileCatalyst will set the transfer mode automatically by comparing the file extension to the list of file extensions specified in the "asciiextensions" parameter below.

Default value: "bin"
Valid values: "bin", "asc", "auto", and "macbin"(MacOS only)

showascbin

If this value is set to "true", FileCatalyst will hide the ASCII/BINARY or TEXT/DATA/MACBINARY radio buttons.

Default value: "false"
Valid values: "true", "false"

asciiextensions

Transfer all the files with these extensions in Ascii Mode. Used in conjunction with "ascbin" parameter when it is set to "auto".

Default value: ""
Valid values: "<comma delimited list of extensions>"

extensions

Only files with these extensions will be displayed/affected by FileCatalyst.

Default value: ""
Valid values: "<comma delimited list of extensions>"

exclude

Allows you to exclude files or directories whose names contain strings specified in this parameter. For example, if you wanted to exclude all files starting with the letters "re", exclude the Program Files directory, and also hide the D:\\ drive this parameter would be set like this: "*re*,Program Files,D:\\". This parameter also allows you to use wildcards to exclude files of a certain pattern. For example, to exclude files that are numbered file1_of_10.txt you could set this parameter to "file*_of_*.txt". See Section 5.d for more details.

Default value: ""
Valid values: "<comma delimited list of strings>"

invertExclude

If set to "true", FileCatalyst will treat the "exclude" parameter as an "include" parameter. See Section 5.5 for more details.

Default value: "false"
Valid values: "true", "false"

lockinitialdir

If set to "true", FileCatalyst locks the user to the initial directory, and its sub-directories, preventing the user from navigating up the hierarchy. This only applies to the remote directory.

Default value: "false"
Valid values: "true", "false"

In FileCatalyst Webmail and Workflow, this parameter is set automatically

localdir

FileCatalyst will automatically switch to this local directory when FileCatalyst initializes. Example would be "c:\\windows" or "/etc". There are also 3 special starting directories that are platform independent. They are"HOME", "DESKTOP" and "ROOT". Note that for Windows paths, you must use a double back slash to seperate paths. i.e. use \\ instead of \.

Default value: ""
Valid values: "<valid local directory>", "HOME", "DESKTOP", "ROOT"

remotedir

FileCatalyst will automatically switch to this directory on the FileCatalyst server after a successful login. Example would be "/initialdir".

Default value: ""
Valid values: "<valid remote directory>"

In FileCatalyst Webmail and Workflow, this parameter is set automatically

enableCookies

FileCatalyst will store cookies to remember the last site and username if this value is set to "true".

Default value: "true"
Valid values: "true", "false"

doubleClickTransfer

If this value is set to "true", double clicking on a file will initiate a transfer of the selected file(s).

Default value: "true"
Valid values: "true", "false"

confirmOverwrite

If this value is set to "true", FileCatalyst will prompt you if the file(s) already exist when a transfer is attempted. You will have the choice to overwrite if you want to. If it is set to false, FileCatalyst will always overwrite.

Default value: "true"
Valid values: "true", "false"

enablerightclick

If this value is set to false, users will not be able to right click on files and execute the available options for that file.

Default value: "true"
Valid values: "true", "false"

helpLocation

When the "Help" button is pressed, it will open a new browser window and is sent to the URL specified.

Default value: "documentation.html"
Valid values: "<valid URL>"

In FileCatalyst Webmail and Workflow, this parameter is set automatically

syncpriority

While using the "Sync" button, if a file exists on both the local and remote file system, this parameter determines which file is considered to be the master file. The other file will be overwritten. If the value is set to "local", any remote file that exists on the local side as well, will be overwritten by the local version.

Default value: "local"
Valid values: "local", "remote"

selectalllocal

All files in the initial local directory will be selected when FileCatalyst initializes.

Default value: ""
Valid values: "<valid local directory>"

selectallremote

All files in the initial remote directory will be selected when FileCatalyst connects successfully to an FileCatalyst server.

Default value: ""
Valid values: "<valid remote directory>"

selectfileremote

The specified file will be selected when FileCatalyst connects successfully to an FileCatalyst server.

Default value: ""
Valid values: "<valid filename>"

autoupload

Used in conjunction with "selectalllocal", this parameter allows you to automatically upload files. This parameter is only functional when FileCatalyst is licensed.

Default value: "false"
Valid values: "true", "false"

autodownload

Used in conjunction with "selectallremote", this parameter allows you to automatically download files. This parameter is only functional when FileCatalyst is licensed.

Default value: "false"
Valid values: "true", "false"

createdirectoryonconnect

This parameter specifies a remote directory that should be created when an FileCatalyst connection is established.

Default value: ""
Valid values: "<valid remote directory>"

In FileCatalyst Webmail and Workflow, this parameter is set automatically

showsizeanddate If set to true, the browse dialog will display file size and date attributes as well as just the file name.

Default value: "false"
Valid values: "true", "false"

deleteoncancel

If set to true, partially transferred files will automatically be deleted.

Default value: "false"
Valid values: "true", "false"

showSizeInKB

If set to true, and "showsizeanddate" is also set to true, sizes of files will be displayed in KB rather than in bytes.

Default value: "false"
Valid values: "true", "false"

hostsAllowed

This parameter allows you to limit the hosts and IPs FileCatalyst is allowed to connect to. You can list individual IPs/domains, or you can use wildcards to cover subdomains, subnets, etc... For example, "192.168.1.*,*.FileCatalyst.ca" would limit connections to any IP that starts with 192.168.1 and any subdomain of FileCatalyst.ca

Default value: ""
Valid values: "<comma delimited list of URLs, wildcards are allowed>"

confirmTransfer

If set to "true", FileCatalyst will prompt with a confirmation dialog before every upload or download to confirm the target directory.

Default value: "false"
Valid values: "true", "false"

totalProgress

FileCatalyst can show the progress of an entire upload, or progress of individual files. By default, the progress of the entire upload is shown.

Default value: "true"
Valid values: "true", "false"

enableResume

This parameter allows you to control whether FileCatalyst allows transfers to be resumed. It can be set to "true", the user will be prompted to resume is possible, "false", the user can not resume, and "auto", FileCatalyst will resume whenever possible without asking.

Default value: "true"
Valid values: "true", "false", "auto"

customFileOptions

This parameter allows you to customize the right click options for files in the remote list. See Section 5.5 for more details.

Default value: ""
Valid values: "<label1>|<valid URL1>,<label2>|<valid URL2>, etc... "

customDirOptions

This parameter allows you to customize the right click options for directories in the remote list. See Section 5.5 for more details.

Default value: ""
Valid values: "<label1>|<valid URL1>,<label2>|<valid URL2>, etc... "

sendLogsToURL

If set to a valid URL, FileCatalyst will do an HTTP POST to the specified URL with a log of the FileCatalyst session when the applet is exited (browser closed, or page unloaded). The POST will contain a parameter called "logs", and the value will be the FileCatalyst session log.

Default value: ""
Valid values: "<valid URL>"

In FileCatalyst Webmail and Workflow, this parameter is set automatically

preserveModificationTime

If set to "true", after each successful file upload, FileCatalyst will issue an MDTM command to synchronize the file's timestamp on the FileCatalyst server with the file's timestamp on the local file system.

NOTE: This feature is not supported on all FileCatalyst server software. Check your servers documentation for more information.

Default value: "false"
Valid values: "<valid URL>"

4.d Color settings

These parameters control the various colors of the FileCatalyst interface. They allow you to blend the color scheme of FileCatalyst with that of your existing web page.

Color Settings
background

Allows you to change the background of the applet using comma seperated, standard RGB (Red, Green, Blue) values. For example
white = 255,255,255

Default value: "255,255,255"
Valid values: "<valid RGB values between 0 and 255>"

buttonTextColorOnMouseOver

The color of the text on the buttons when the mouse moves over them.

Default value: "255,255,255"
Valid values: "<valid RGB values between 0 and 255>"

buttonTextColor

The color of the text on the buttons.

Default value: "0,0,0"
Valid values: "<valid RGB values between 0 and 255>"

buttonColorOnMouseOver

The background color of the buttons when the mouse moves over them.

Default value: "10,50,10"
Valid values: "<valid RGB values between 0 and 255>"

buttonbackground

The background color of the buttons.

Default value: "81,132,81"
Valid values: "<valid RGB values between 0 and 255>"

headerTextColor

The color of the local and remote list headers.

Default value: "0,0,255"
Valid values: "<valid RGB values between 0 and 255>"

headerBackgroundColor

The background color of the local and remote list headers.

Default value: <defaults to color specified in "background" parameter>
Valid values: "<valid RGB values between 0 and 255>"

drivesForegroundColor

The color of the drive selection combo box text in the Windows version of FileCatalyst.

Default value: "0,0,0"
Valid values: "<valid RGB values between 0 and 255>"

drivesBackgroundColor

The color of the drive selection combo box background in the Windows version of FileCatalyst.

Default value: "255,255,255"
Valid values: "<valid RGB values between 0 and 255>"

ascBinTextColor

The ASCII/BINARY (Windows/Unix) and TEXT/DATA/MACBINARY (Mac) radio buttons text.

Default value: "0,0,0"
Valid values: "<valid RGB values between 0 and 255>"

4.e Interface and Layout Settings

These parameters allow you to adjust, add, and remove various elements of FileCatalysts user interface. This allows you to add/remove various functions that you do not want the users of FileCatalyst to have access to.

Interface and Layout Settings
language

FileCatalyst allows you to customize the language of the text on the interface. To do this, edit the contents of "lang_en.txt" which is included in the download archive. Save the file with an appropriate language code. Example for French might be "lang_fr.txt". This parameter should then be set to "fr".

Default value: "en"
Valid values: "<language code>" - There must also be a file defined lang_<language code>.txt in the same directory as FileCatalyst.jar, and FileCatalyst.cab.

In FileCatalyst Webmail and Workflow, this parameter is set automatically

classicfilelist

FileCatalyst uses a custom file list that is sometimes slow on some platforms. If this becomes a problem, this value should be set to "true" and FileCatalyst will use a simplified file list with no icons or graphics. This option will only function on Mac OS 9, and in Netscape 4.x's default VM. Enabling this feature will override the "showsizeanddate" parameter on these platforms.

Default value: "false"
Valid values: "true", "false"

LocalOptions

If this value is set to "false" all of the local buttons will become invisible.

Default value: "true"
Valid values: "true", "false", list of 7 1's and 0'1

In FileCatalyst Webmail and Workflow, this parameter is set automatically

RemoteOptions

If this value is set to "false" all of the remote buttons will become invisible.

Default value: "true"
Valid values: "true", "false", list of 8 1's and 0'1

In FileCatalyst Webmail and Workflow, this parameter is set automatically

strechButtons

If set to true, buttons will be stretched to fit the size of the lists. Creates a more uniform looking interface. If set to false, the buttons will take their default size.

Default value: "true"
Valid values: "true", "false"

display

If this value is set to "false" the FileCatalyst message display will become invisible.

Default value: "true"
Valid values: "true", "false"

showhelpbutton

Setting this value to "false" will hide the "Help" button.

Default value: "true"
Valid values: "true", "false"

showputbutton

Setting this value to "false" will hide the "Upload" button.

Default value: "true"
Valid values: "true", "false"

In FileCatalyst Webmail and Workflow, this parameter is set automatically

showgetbutton

Setting this value to "false" will hide the "Download" button.

Default value: "true"
Valid values: "true", "false"

In FileCatalyst Webmail and Workflow, this parameter is set automatically

showsyncbutton

Setting this value to "false" will hide the "Sync" button.

Default value: "true"
Valid values: "true", "false"

showaboutbutton

Setting this value to "false" will hide the "About" button.

Default value: "true"
Valid values: "true", "false"

showconnectbutton

Setting this value to "false" will hide the "Connect" button.

Default value: "true"
Valid values: "true", "false"

In FileCatalyst Webmail and Workflow, this parameter is set automatically

showdisconnectbutton

Setting this value to "false" will hide the "Disconnect" button.

Default value: "true"
Valid values: "true", "false"

showlocallist

Setting this value to "false" will hide the local file list and all of the local buttons.

Default value: "true"
Valid values: "true", "false"

showremotelist

Setting this value to "false" will hide the remote file list and all of the remote buttons.

Default value: "true"
Valid values: "true", "false"

showlocaladdressbar

Setting this value to "false" will hide area above the local file list that displays the current path info.

Default value: "true"
Valid values: "true", "false"

showremoteaddressbar

Setting this value to "false" will hide area above the remote file list that displays the current path info.

Default value: "true"
Valid values: "true", "false"

remoteheader

Specifies the text to display above the remote file list when connected to an FileCatalyst server. Note that this value only has an effect if "autoconnect" is true, or if "showSiteName" is set to "false". Otherwise the site name selected by the user is shown as the remote header.

Default value: The hostname or IP of the remote server
Valid values: "Any text you want"

In FileCatalyst Webmail and Workflow, this parameter is set automatically

showFileInfoBar

If set to "true", FileCatalyst will display the Filename, Date, and Size of the currently selected file below the appropriate file list.

Default value: "false"
Valid values: "true", "false"

showStatusBar

If set to "true", FileCatalyst will display a status bar that indicated whether the client is currently connected/disconnected and whether the current connection is secure.

Default value: "false"
Valid values: "true", "false"

showTree

If set to false, the tree view of the remote list will be supressed and only contents of current directory will be shown.

Default value: "true"
Valid values: "true", "false"

enablekeyboardshortcuts

If set to "false", All keyboard shortcuts will be disabled.

Default value: "true"
Valid values: "true", "false"

width

Default value: "600"
Valid values: "<integer value (in pixels)>"

height

Default value: "480"
Valid values: "<integer value (in pixels)>"

4.f Error Page URLs

These parameters allow you to define your own error pages for different types of errors that can occur when a user attempts to load FileCatalyst.

Error Page URLs
errNavWin

This error page will be called when the user is running Windows, and their Netscape version is not sufficient to run FileCatalyst.

Default value: ""
Valid values: "<valid URL>"

errIEWin

This error page will be called when the user is running Windows, and their Internet Explorer version is not sufficient to run FileCatalyst.

Default value: ""
Valid values: "<valid URL>"

errIEWinVM

This error page will be called when the user is running Windows with Internet Explorer and the Microsoft VM for Java is not sufficient to run FileCatalyst.

Default value: ""
Valid values: "<valid URL>"

errNavUnix

This error page will be called when the user is running Unix, and their Netscape version is not sufficient to run FileCatalyst.

Default value: ""
Valid values: "<valid URL>"

errIEMac

This error page will be called when the user is running Mac OS, and their Internet Explorer version is not sufficient to run FileCatalyst.

Default value: ""
Valid values: "<valid URL>"

errNavMac

This error page will be called when the user is running Mac OS, and their Netscape version is not sufficient to run FileCatalyst.

Default value: ""
Valid values: "<valid URL>"

errOperaWin

This error page will be called when the user is running Opera browser, and the version is not sufficient to run FileCatalyst.

Default value: ""
Valid values: "<valid URL>"

rejectPermissionURL

This error page will be called when the user rejects the security certificate or does not grant the permissions required for FileCatalyst to run.

Default value: ""
Valid values: "<valid URL>"

In FileCatalyst Webmail and Workflow, this parameter is set automatically

4.g Language settings

FileCatalyst's language settings allow you to customize the text on the applet. This can be accomplished by modifying the text elements provided in the lang_en.txt file. Alternatively if you wish to provide support for multiple languages you may create a separate language file for each language you wish to support. Using this method you can dynamically load the language file based on the "language" parameter provided to FileCatalyst.

For example, if you wish to create a language file that contains the text elements for the German language then follow these steps:

  1. Copy the default lang_en.txt file to a new file named lang_de.txt
  2. Update the text element values in lang_de.txt providing the German equivalents.
  3. Adjust the language parameter of FileCatalyst with the value of "de".
  4. Upload lang_de.txt and the modified fcappletscript.js files to the web server directory that contains FileCatalyst.

Note: If no language parameter is provided then the default lang_en.txt file is used. If a custom language file is used, and it is missing any entries, the corresponding entries from the default file will be used.

5 Advanced Features

5.a Performing automatic login

You may login to an FileCatalyst server automatically by setting the autoconnect parameter to the applet to "true". You must also provide the server, port, user and pass parameters.

Example:

var server = "myserver.com";
var port = "21";
var user = "myusername";
var pass = "mypassword";
var autoconnect = "true";

5.b Disabling individual buttons

FileCatalyst allows you to enable/disable each of the buttons on the local and remote toolbar. The Local toolbar has 7 buttons and the Remote toolbar has 8. All buttons default to "on", and thus the default value for LocalOptions is "1,1,1,1,1,1,1" and the default value for RemoteOptions is "1,1,1,1,1,1,1,1" where each 1 means the corresponding button is on. In order to turn off an individual button, you must set its value to 0. For example, if you want to disable the Open, and MakeDir buttons on both the local and remote toolbars, you would set the values like this:

var LocalOptions = "1,0,1,1,1,1,0";
var RemoteOptions = "1,0,1,1,1,1,0,1";

When you remove buttons, the remaining buttons may appear stretched. To overcome this issue, try setting the "strechButtons" parameter to "false".

5.c Setting custom help file location

You may define a custom help file to be used when clicking on the "Help" button by passing the helplocation applet parameter with a value of the URL to the help file contents.

Example:

var helplocation = "help.html";

5.d Customizable right click options

FileCatalyst gives you the ability to define your own right click options on the Remote file list. You can specify separate options for both files and directories. You define both a label for the action in the right click popup, and a URL that will be called when the action is executed. FileCatalyst will call the specified URL, and append the parameter "uftpdiritem=/directory/file.txt" to the URL giving you the full path of the file in question on the FileCatalyst server. This will allow you to execute processes on specific files and directories.

Example:

var customFileOptions = "File Option | http://localhost/processfile.jsp";
var customDirOptions = "Directory Option | http://localhost/processdir.jsp"; 

In this case, when the user right clicks a file on the remote list, they will see "File Option" as an option on the popup. When clicked, FileCatalyst will call the specified URL with the selected path.

The format for these parameters is <label>|<url>, and you can define multiple options, by separating them with a comma. Here is an example:

var customFileOptions = "<label1>|<url1>,<label2>|<url3>,<label3>|<url3>"; 

5.e Advanced file filtering

If you need to filter files by more than just extension, FileCatalyst allows you to filter using wildcard expressions as well. FileCatalyst has a parameter called "exclude" which allows you to list expressions like file*.* or *.doc or even *file*.doc. This allows you to exclude all files that match any of the expressions you list. There is also an "invertexclude" parameter which allows you to only include the files that match the given expressions.

Example:

var exclude = "file*.txt";
var invertexclude = "true"; 

In this example, only files that match file*.txt will be displayed in the file list.

Example 2:

var exclude = "*.mp3, *.exe, Program Files ";
var invertexclude = "false"; 

In this example, all files will be shown except MP3's, EXE's, and the Program Files directory.

5.f Resuming broken or interrupted transfers

FileCatalyst has the ability to resume broken or cancelled transfers. If a transfer is interrupted due to network problems, FileCatalyst will automatically try to resume the transfer. If you cancel a transfer and wish to resume the transfer at a later time, simply select the file you wish to resume, and click Upload or Download. You will be prompted to resume the transfer if possible.

6 Support

6.a Chat and trouble tickets support

Browse our Knowledgebase for existing questions and solutions

Submit a Ticket for best response-time and proper tracking of individual issues.