U-Upload Documentation

1 Overview

1.1 Introduction
1.2 Features
1.3 Version History
1.4 Known Issues

2 Installation

2.1 Deploying to a web server
2.2 Minimum configuration

3 Using U-Upload

3.1 Minimum System Requirements
3.2 User Interface
3.3 Running U-Upload
3.4 Directory browsing
3.5 Selecting files and directories
3.6 Uploading files

4 Configuring U-Upload

4.1 Connection parameters
4.2 Proxy parameters
4.3 Functionality related parameters
4.4 Color and Interface settings
4.5 Error URL parameters
4.6 Language settings and internationalization

5 Advanced Features

5.1 Advanced file filtering
5.2 Resuming broken or interrupted transfers
5.3 Loading U-Upload dynamically
5.4 Integrating U-Upload with your web application
5.5 Using the "autoupload" feature
5.6 Accessing U-Upload's functionality from JavaScript

6 Support

6.1 Frequently Asked Questions and Troubleshooting
6.2 Support forums
6.3 Phone, Email, and chat support


1 Overview

1.1 Introduction

U-Upload Pro is an FTP file upload applet with over 70 customizable parameters. Using U-Upload Pro's parameters, you can create fully customized, simple to use, file upload site for your users. To customize U-Upload Pro, you must edit "uuploadpro.js" with an HTML/text editor. You can then use the following tables as a guide to customizing each of U-Upload Pro's parameters.

Then add the following line to your HTML file:

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

You must also make sure that you either put uuploadpro .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.

Please also review the Readme and License files.

1.2 Features

The following is a list of the main features of U-Upload.

  • Progress dialog with cancel button
  • Specify the remote directory to which files will be sent
  • Change background color to match your site
  • Secure file transfer via UnlimitedFTP.Secure servlet
  • Upload of entire directories to an FTP server
  • Resume broken or user interrupted uploads
  • ZIP all files into a single ZIP archive
  • Automatically redirect to a new page after the upload is complete
  • Issue a SITE command before an upload
  • Convert each file into Macbinary format (on Mac)
  • Multilingual support
  • Encrypt user ID, password and server information
  • Socks Proxy Support

1.3 Version History

New features in version 1.6.2

  • Fixed scripting bug with browse() function
  • Scripting now works in Sun plugin

New features in version 1.6.1

  • added postURL parameter to allow HTTP POST of filenames
  • fixed bug with slow loading on some XP systems with Sun VM
  • add default file filter "All files (*.*)"
  • various interface improvements on OS X
  • various minor bug fixes

New features in version 1.6.0

  • "waitRetry" and "maxRetries" parameters greatly improved ability to recover from broken transfers resulting from network problems.
  • "enableResume" parameter lets you control how resuming is handled
  • new parameter "invertexclude" that turns exclude into an include feature
  • ability to convert accented characters to non-accented characters via "removeaccentsandquotes" parameter
  • ability to remove spaces via "removespaces" parameter
  • transfer progress is now shown for the overall transfer, not per file. "totalProgress" parameter toggles this feature on and off
  • new "sendLogsToURL" parameter makes applet POST the FTP session log to a URL you specify
  • new "siteCommandStor" parameter allows you to send a site command after each file is uploaded


New features in version 1.5.5

  • new "showservername" parameter to show/hide server name on connecting dialog
  • fixed bug with browser freezing on redirect if target is _self or _top (Mac OS 9 only)
  • added ability to set the delimiter, defaults to ;
  • setting textwidth to 0 hides text field
  • new "exclude" parameter lets you hide certain files and/or directories and drives
  • fixed bug with files being deleted in OS X 10.2 if macbinary is on

New features in version 1.5.4

  • Updated Applet certificate. We strongly suggest that you upgrade!
  • Users can now start in ROOT/HOME/DESKTOP directory on their local file system
  • MacBinary now works in OS X (up to 10.1)
  • New parameter showSizeAndDate on remote and local file lists
  • Fixed bug with starting local directory set to / on Windows
  • Fixed bug with macbin turning off autozip even in Windows
  • Fixed bug with password dialog when clicking cancel (caused NullPointerException)

New features in version 1.5.2

  • added enableResume parameter which has 3 values
  • true (allows resume and prompts the user if they wish to resume a transfer)
  • false(does not allow resume does not prompt the user if they wish to resume a transfer)
  • auto (automatically resumes transfers without prompting the user)
  • added appendFilesToURL parameter which may be true or false. If true, on completion of a successful transfer, the redirection url is called with the filenames appended in this fashion: http://<transferurl>/?<filesTransferredParameter>=<file
  • list delimited by; with path stripped>
  • added redirectFileNotExistURL & target so that if the file does not exist and this parameter is set one can redirect to a URL
  • now files can be chosen from different directories

1.4 Known Issues

None.

2 Installation

2.1 Deploying to a web server

  1. Extract the contents of uuploadpro.zip to your local hard disk using a zip utility
  2. Create a directory on your web server. For example /uupload.
  3. Upload all files extracted in Step 1. to the directory you created on the web server in Step 2. Important: When uploading files make sure that you upload files in binary mode.
  4. Go to test page located at the URL http://yourserver.com/uupload/index.html, where yourserver.com is replaced by your domain name. Example: http://www.utechsoft.com/uupload/index.html
  5. U-Upload has a minimum configuration requirement, which is described in Section 2.2
  6. To customize the Functionality of U-Upload, edit the file uuploadpro.js with a text editor such as Notepad. Each of the customizable parameters is defined below in Section 4
  7. Upload the new uuploadpro.js to your web server.

2.2 Minimum configuration

U-Upload requires a minimum configuration in order to function. You must setup the "server", "user" and "pass" parameters so U-Upload can connect to your FTP server and upload files. To do this you must edit uuploadpro.js with a text editor, and set the values to reflect your FTP server. For example:

// Connection related values

var server = "ftp.yourserver.com";
var port = "";
var user = "username";
var pass = "password";

Additional configuration parameters are described in Section 4

3 Using U-Upload

3.1 Minimum System Requirements

The minimum system requirements for using U-Upload are as follows:

Operating Systems: Windows 98/2000/XP/ME or Mac OS 8.x, 9.x, 10.x
Browser: Internet Explorer, Netscape Navigator, Opera. Mozilla, Safari
Browser Java VM: Java 1.1 or above enabled
FTP server (must be accessible from your machine)

3.2 User Interface

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


Fig. 3.1 The U-Upload interface

  1. List of selected files - Displays all of the files that have been selected
  2. Browse button -This button allows you to browse your computer and select files you wish to upload.
  3. Send button - This button will initiate the upload of the files that have been selected
  4. Status bar - This shows the current status of the U-Upload applet.

3.3 Running U-Upload

To load U-Upload, use your web browser to open the test page you uploaded during installation. See Deploying to a web server. Upon loading U-Upload 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 trust content from Unlimi-Tech Software Inc." checkbox in IE, or on the "Always" button if you use Sun's Java Plugin. This dialog ensures that U-Upload is a trusted application, and you wish to allow it to run with full permissions.

Fig. 3.2 Internet Explorer with Microsoft VM security warning

Fig 3.3 Sun Java Plugin security warning

 

Once you have accepted the certificate dialog, U-Upload will continue loading. Depending on how U-Upload was configured (See Configuring U-Upload ) it may automatically begin to upload files.

3.4 Directory browsing

When you click on the Browse button, U-Upload will display a dialog similar to the one displayed in Figure 3.4 below. 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 .

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 on your keyboard. Pressing Enter on a folder will automatically enter that folder for browsing. Pressing Enter with a file selected is equivilant to selecting a file and clicking the Open button.


Fig. 3.4 U-Upload browse dialog

3.5 Selecting files and directories

To select a file or folder, click on the item in the directory listing using your mouse. You may select a multiple of 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. When you have selected the files you wish to upload, click on the Open button. Mac OS 9.x users may use the left and right arrow buttons to select multiple files.

3.6 Uploading files

To upload the files you have selected, simply click on the "Upload" button and the file upload should be initiated. Depending on your configuration, you will see a progress dialog similar to the one in Figure 3.5 below. Once the upload is complete, depending on the configuration, U-Upload may redirect to another web page.


Fig. 3.5 Progress dialog

4 Configuring U-Upload

These settings can be configured in uuploadpro.js. Note that every time you change these settings, you will need to upload the modified uuploadpro.js file.

4.1 Connection parameters

These parameters control how U-Upload will establish the connection to the FTP server.

Connection related settings
server

The host name or IP address of the FTP server.

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

port

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

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

pass

The password for the FTP server account.

Default value: ""

user

The username for the FTP server account.

Default value: ""

passive

If set to "true", all data connections will be outgoing. U-Upload works through firewalls when this value is set to "true". If you are using an FTP proxy, set this value to "false".

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

encrypt

If set to "true" you must pass encrypted user/pass/server parameters to U-Upload, 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 U-Upload. 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"

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/uftp@unlimitedftp.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>"

connecttimeout

This value (in milliseconds) specifies how long U-Upload will try to connect to an FTP 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 U-Upload 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 U-Upload will try, if a transfer error occurs, to reconnect and resume the transfer.

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

useSerfo

If set to true, U-Upload will attempt to open an FTP connection through the Service Forwarding Agent at the URL specified by the "SerfoLocation" parameter below.

If set to auto, U-Upload will first attempt to open a regular FTP connection, and if it fails, it will retry through the Service Forwarding Agent at the URL specified by the "SerfoLocation" parameter below.

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

serfoLocation

The location of the Service Forwarding Agent servlet. Please consult SecureFTPInstall.txt for more information.

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

enableHTTPResume

When "userSerfo" is set to "true", this value allows you to force uploads to first be saved on the web server before being transferred to the FTP server. This is useful if your FTP server executes scripts or commands that rely on the STOR command. The default functionality, "enableHTTPResume" set to "true", is to stream files directly to your FTP server using a series of APPE commands rather than one STOR command. This may cause your FTP server to execute a script before the file is fully transferred.

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

4.2 Proxy settings

These parameters allow you to configure U-Upload to connect through a SOCKS4 or FTP proxy server. Please contact your network administrator or ISP to determine if you use a proxy server for FTP.

Proxy server related settings. (Internet Explorer Only)
autodetectproxy

If this value is set to "true", U-Upload will automatically attempt to detect Internet Explorer's Proxy setup and use it when connecting to FTP servers. This will detect both SOCKS 4 proxy settings, and FTP proxy settings.

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

socksproxy

If this value is set to "true", U-Upload will use the SOCKS proxy server and port specified by the "socksProxyHost" and "socksProxyPort" parameters.

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

socksProxyHost

SOCKS proxy server location.

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

socksProxyPort

SOCKS proxy server port.

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

ftpproxy

If this value is set to "true" and socksproxy is set to "false", U-Upload will use the FTP proxy server and port specified by the "ftpProxyHost" and "ftpProxyPort" parameters.

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

ftpProxyHost

FTP proxy server location.

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

ftpProxyPort

FTP proxy server port.

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

4.3 Functionality related settings

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

Functionality related settings

mode

Transfer method, can be set to either "data" or "macbin", the default is data. This parameter only works on the Mac OS platform. When the method is set to "macbin" U-Upload Pro will automatically encode each file into a Mac Binary format on MAC. MacBinary format is Internet friendly and allows all Mac files to be transferred to other platforms without any problems. IMPORTANT: "macbin" mode will automatically disable ZIP functions

NOTE: Macbinary will not function in OS X 10.2 or higher.

Default value: "data" (MacOS only)
Valid values: "data" or "macbin"

localdir

U-Upload will automatically browse this local directory when U-Upload "Browse..." button is pressed. Example would be "c:\\windows" on a Windows machine or "/etc" on Mac or Unix.

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

remotedir

U-Upload will automatically switch to this directory on the FTP server after a successful login. Example would be "/initialdir". Note that this directory must already exist, or must be specified to be created with the "createdirectoryonstartup" parameter.

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

exclude Allows you to exclude files or directories who's 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".

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

createdirectoryonstartup

This param specifies a remote directory that should be created when an FTP connection is established.

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

filefilterX

Where X = 1 to N. You can define as many file filters as you want to using this parameter, as long as each value X is distinct. Here are some examples:

var filefilter1 = "All Files (*.*)";
var filefilter2 = "HTML Files (*.htm,*.html)";
var filefilter3 = "Image files (*.gif,*.jpg,*.png,*.bmp)";

These parameters must be of this form to function properly. Notice there are no spaces between the extensions.

Default value: ""
Valid values: "<type name> (*.<extension1>, *.<extension2>, etc...)"

showdialogs

Toggles the status, and progress dialogs on and off.

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

maintainpathinfo

If this parameter is set to "true", all path info is maintained when files are uploaded. Otherwise the path info is not included.

NOTE: This feature will not work if you are using the "filesetrename" parameter.

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

autozip

If this parameter is set to "true", all selected files will be compressed using ZIP compression.

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

zipfilename

Used in conjunction with the "autozip" parameter, this parameter specifies the filename for the compressed archive.

Default value: "files.zip"
Valid values: <valid filename>

zippathinfo

If this parameter is set to "true", all path info is maintained in the zip archive. Otherwise the path info is not included.

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

confirmoverwrite

If this value is set to "true", U-Upload will prompt you if the file(s) already exist on the FTP server. You will have the choice to overwrite if you want to. If it is set to false, U-Upload will always overwrite.

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

callurlaftertransfer

U-Upload Pro will redirect to this URL when the transfer is complete and was successful.

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

callurlaftertransfertarget

Used in conjunction with callurlaftertransfer, this parameter specifies the target for the redirection.

Default value: "-self"
Valid values: "_top", "_blank", "_self", etc...

transfererrorurl

U-Upload Pro will redirect to this URL if an error occurred during the file transfer, or the network connection is terminated. This URL is also called if U-Upload has attempted to restart the transfer more than the number of tries specified by the "maxRetries" parameter.

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

transfererrorurltarget

Used in conjunction with transfererrorurl, this parameter specifies the target for the redirection.

Default value: "-self"
Valid values: "_top", "_blank", "_self", etc...

transfercancelurl

U-Upload Pro will redirect to this URL if the transfer is canceled.

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

transfercancelurltarget

Used in conjunction with transfercancelurl, this parameter specifies the target for the redirection.

Default value: "-self"
Valid values: "_top", "_blank", "_self", etc...

redirectfilenotexisturl

U-Upload Pro will redirect to this URL if, when the Send button is pressed, the selected file(s) do not exist.

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

redirectfilenotexisturltarget

Used in conjunction with redirectfilenotexisturl, this parameter specifies the target for the redirection.

Default value: "-self"
Valid values: "_top", "_blank", "_self", etc...

othererrorurl

U-Upload Pro will redirect to this URL if any other errors occur. This may include login or connections errors.

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

othererrorurltarget

Used in conjunction with othererrorurl, this parameter specifies the target for the redirection.

Default value: "-self"
Valid values: "_top", "_blank", "_self", etc...

site

This is an FTP Site command that will be performed immediately before the upload is initiated. This is useful for connecting to FTP server that require a specific file format to be specified before transferring. Setting this to a value of "help" would result in "SITE help" being sent to the FTP server.

Default value: ""
Valid values: "<valid FTP SITE command>"

autoupload

Used in conjunction with "fileset" parameter, if set to "true" U-Upload will automatically begin transferring the files specified in "fileset" once it loads.

NOTE: This parameter only works in licensed versions.

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

fileset

This parameter will add files to U-Upload as a semicolon delimited list of full paths to files. When used with the "autoupload" you can completely automate the upload of files. Here is an example:

fileset = "c:\\temp\\file1.exe;c:\\images\\image.jpg;d:\\Program Files\\file2.exe";

or on UNIX or Mac

fileset = "/home/joebloe/web/index.html;/tmp/image.jpg";

You can also specify a widcard value to only upload files of a certain type, for example:

fileset = "/home/joebloe/*.jpg;/tmp/*.gz";

Default value: ""
Valid values: <semicolon delimited list of file paths>

filesetrename

Used with the "fileset" parameter, this parameter allows you to rename files as they are transferred to the FTP server. A valid value for this parameter will be a semicolon delimited list of remote file names. Note: no path is required for these values as they will be stored in the directory specified in the "remotedir" parameter. Note that the number of values in the list must be equal to the number of values in the "fileset" parameter or this parameter will be ignored. It will also be ignored if you use wildcards in the fileset parameter. If this parameter is set, the "maintainpathinfo" parameter is automatically disabled. Here is an example usage:

filesetrename = "file1.exe;image.jpg;file2.exe";

Default value: ""
Valid values: <semicolon delimited list of filenames>

maxfiles

Uploads will be limited to this number of files. If left blank, there is not limit.

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

enableResume

This parameter allows you to control whether U-Upload 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", U-Upload will resume whenever possible without asking.

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

appendFilesToURL

If set to true, the files that were uploaded will be appended to the end of the URL specified in the "callurlaftertransfer" parameter. The parameter name will be specified by the "filesTransferredParameter" parameter. i.e.

If you uploaded the files c:\temp\file1.txt and c:\autoexec.bat and your "callurlaftertransfer" parameter was set to "http://www.unlimitedftp.ca/processfiles.jsp" the the following URL will be called after the transfer is complete:

http://www.unlimitedftp.ca/processfiles.jsp?filesTransferred=file1.txt;autoexec.bat

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

filesTransferredParameter

Specifies the name of the parameter used to pass the list of uploaded files to the "callurlaftertransfer" parameter.

Default value: "filesTransferred"
Valid values: "<URL friendly string>"

showsizeanddate

If set to true, the browse dialog will display the file name including the file size and date attribute. If set to false, only the file name will be displayed.

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

showservername

If set to false, the remote server domain or IP will not be shown in the connecting dialog.

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

Note: If this parameter is disabled, it is recommended that you change the DIALOG.BUSY.CONNECTING entry in the language file to "Connecting" instead of its default value of "Connecting To"

delimiter

This will be the delimiter for the files listed in the text field. Note that setting this parameter also effects the "fileset" parameter. The list of files specified in "fileset" must be delimited by the value specified in the "delimiter" parameter.

Default value: ";"
Valid values: "any character"

removeaccentsandquotes

If set to true, U-Upload will convert accented characters in a filename to non-accented characters.

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

removespaces

If set to true, U-Upload will replace all spaces in a filename to an underscore character.

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

browsenative

If set to true, U-Upload Pro will use a native file dialog, rather than the built in file dialog. This allows you to take advantage of the features native dialogs offer, thumbnails for example. However, due to a Java limitation, it will limit you to selecting one file at a time.

NOTE: The "showsizeanddate" parameter is automatically disabled if you set "browsenative" to "true"

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

useTempName

This parameter is used in conjunction with the "useSerfo". When uploading via UnlimitedFTP.Secure, files are broken into small pieces and uploaded and reassembled on the FTP server using the APPE command. Setting this parameter to "true" will cause the uploaded file to be stored under a temporary name until the upload is complete. At that time it is renamed to the original filename.

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

totalProgress

U-Upload 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"

siteCommandStor

Setting this parameter allows you to execute a custom SITE command after each file is uploaded. This parameter also accepts wildcards which are automatically replaced by the full path of the file that was just uploaded. Example:

var siteCommandStor = "processfile *";

This would result in U-Upload sending the following command to your FTP server after each file is uploaded:

SITE processfile /pathtofile/filename.txt

Default value: ""
Valid values: "<valid FTP SITE command>"

postURL

If set to a valid url, U-Upload will do an HTTP POST to the specified URL with a list of all uploaded files delimited by the delimiter as set.The url will also contain information regarding base directory and total size of all uploaded files onto the ftp server. The parameters will be called "f", "baseDir", and "totalSize" respectively.

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

sendLogsToURL

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

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

4.4 Color and Interface settings

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

Color and Interface settings

language

U-Upload 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 uuploadpro.jar, and uuploadpro.cab.

bgcolor

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

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

textwidth

The width of the text field in columns. Setting width to 0 hides text field

Default value: "15"
Valid values: "<integer value (in columns)>"

width

Width of the U-Upload applet.

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

height

Height of the U-Upload applet.

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

 

4.5 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 U-Upload.

Customizable Error Pages
errNavWin

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

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 U-Upload.

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 U-Upload.

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 U-Upload.

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 U-Upload.

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 U-Upload.

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 U-Upload.

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 U-Upload to run.

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

4.6 Language settings

U-Upload'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 U-Upload.

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 U-Upload with the value of "de".
  4. Upload lang_de.txt and the modified uuploadpro.js files to the web server directory that contains U-Upload.

Note: If no language parameter is provided then the default lang_en.txt file is used.

5 Advanced Features

5.1 Advanced file filtering

If you need to filter files by more than just extension, U-Upload Pro allows you to filter using wildcard expressions as well. U-Upload 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 1:

var exclude = "C:\\,temp,file*.txt";
var invertexclude = "true"; 

In this example, only files that match file*.txt will be displayed in the file list. Note that when you use this feature, you must explicitly list all drives, and directories you want to include.

Example 2:

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

In this example, all files will be shown except MP3s, EXEs, and the Program Files directory.

5.2 Resuming broken or interrupted transfers

U-Upload Pro has the ability to resume broken or cancelled transfers. If a transfer is interrupted due to network problems, depending on how you have set the "enableResume" parameter, U-Upload Pro will 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. This feature can be controlled with the "waitRetry", "maxRetries", and "enableResume" parameter. See Section 4.1

5.3 Loading U-Upload dynamically

In some cases, it may be desirable to load the U-Upload applet dynamically using JavaScript or using a server side scripting language such as JSP, PHP or ColdFusion. If this is the case, you may want to move the contents of uuploadpro.js into your dynamic page by cutting and pasting the entire source in between two <script> tags. You can then replace the variable values with values obtained from your dynamic page. Here is an example:

<% 
String username = "anonymous" ; 
String password = "uftp@nlimitedftp.com" ; 
String hostname = "ftp.sun.com" ; 
String port = "21" ; 
%> 
             
<script> 
// Connection related values 


var server = " <%= hostname %> " ; 
var port = " <%= port %> " ; 
var pass = " <%= password %> " ; 
var user = " <%= username %> " ; 
... 
               
</script>


5.4 Integrating U-Upload with your web application

Further to loading U-Upload dynamically, you may want to fully integrate U-Upload into your web application's workflow. To do this we provide a way to automatically upload an externally generated list of files, and redirect after the upload is complete. This allows you to use your own file selection mechanism, and simply use U-Upload as a means to move the files to your FTP server. There are 4 URLs you can use to redirect after uploads are complete. "callurlaftertransfer" , "transfererrorurl" , "transfercancelurl", "othererrorurl". All of these are described in Section 4.3. The autoupload feature is described in Section 5.5.


5.5 Using the "autoupload" feature

U-Upload provides an auto upload feature which allows you to automatically upload a list a files you pass to the applet via a parameter. It may also be desirable to set the applet's height and width to 0 since the interface will not be used. Here is an example:

var autoupload = "true";
var fileset = "c:\\temp\\file1.exe;c:\\My Documents\\file2.exe ";

The autoupload feature is only available when you install a license key. If you have need to use this feature in your development please email us and we will arrange for you to receive a trial key.


5.6 Accessing U-Upload's functionality from JavaScript

U-Upload Pro provides a scripting interface that allows you to access it's functionality from Javascript. This functionality only works in older Java VMs such as Microsoft's VM, and Netscape 4.x VM. For a complete guide on using this feature, please see scripting.txt

6 Support

6.1 Frequently Asked Questions and Troubleshooting

A comprehensive list of frequently asked questions can be found at http://www.utechsoft.com/uftp/faq.jsp


6.2 Support forums

Our support forums are available 24/7 and are a great place to get answers. http://www.utechsoft.com/cgi-bin/forums/YaBB.pl


6.3 Phone, email and chat support

Email : info@utechsoft.com (usual response time is1 business day)

Live chat : http://www.utechsoft.com/chat/index.jsp (available 9 - 5 Eastern Standard Time)

Phone: (613) 841-2439 (available 9 - 5 Eastern Standard Time)

 

 

Copyright © 2000 - 2004 Unlimi-Tech Software Inc. All right reserved.