# Appendix B: Realm Tags

This appendix lists and describes all the UPLOADit Realm Settings you can define for your Realms. These settings can be used in the UPLOADit_Realms.xml file, the "Upld-DefineRealmXML" function, and the "Realms" tab of the Configuration Dialog.

## Allowed IP Addresses

The Allowed IP Addresses are a list of IP addresses that are allowed to connect to your UPLOADit server. If you have blocked a range of IP addresses, you can unblock certain IP addresses using these allowed IP addresses. You can unblock all IP addresses by using the word "all". You can unblock a single IP address by specifying that single IP address. You can unblock a range of IP addresses by specifying the starting IP address, followed by a dash ("-"), followed by the ending IP address. By default, all IP addresses are allowed to connect to your UPLOADit server. For more information on how UPLOADit determines if an IP address will be blocked, please see Chapter 7, "IP Address Checking". You can define a default list of allowed IP addresses for the plug-in to use if you have not defined a list of allowed IP addresses in your named realm.

### Example

<allowip>all</allowip>
<defaultallowip>172.16.0.25</defaultallowip>
<defaultallowip>192.168.0.50-192.168.0.100</defaultallowip>

### Related

Password
Maximum File Size
Maximum File Count
Denied IP Addresses

## Database

The Database value is the database that contains the script the plug-in needs to call when a user uploads a file to your UPLOADit server. If you define a database to use, the database must be open when a user uploads a file to your UPLOADit server. Otherwise, the plug-in will not be able to tell your database that a user has uploaded a file, and your database will not be able to release the user's web browser to redirect it to its final location. If this database is not open when a user tries to upload a file to your UPLOADit server, the user will receive an error web page telling them that the database is not open. You can define a default database for the plug-in to use if you have not defined a database in your named realm.

### Example

<database>mydb.fp5</database>
<defaultdatabase>UPLOADit.fp5</defaultdatabase>

### Related

Script

## Denied IP Addresses

The Denied IP Addresses are a list of IP addresses that are not allowed to connect to your UPLOADit server. If a user with one of these IP addresses tries to connect to your UPLOADit server, the plug-in will return an error web page to them telling them their IP address has been blocked. You can block all IP addresses by using the word "all". You can block a single IP address by specifying that single IP address. You can block a range of IP addresses by specifying the starting IP address, followed by a dash ("-"), followed by the ending IP address. If you block all IP addresses, or if you block a range of IP addresses, you can unblock certain IP addresses by specifying those IP addresses in the Allowed IP Addresses list. By default, all IP addresses are allowed to connect to your UPLOADit server. For more information on how UPLOADit determines if an IP address will be blocked, please see Chapter 7, "IP Address Checking". You can define a default list of denied IP addresses for the plug-in to use if you have not defined a list of denied IP addresses in your named realm.

### Example

<denyip>all</denyip>
<denyip>192.168.0.100</denyip>
<defaultdenyip>172.16.0.1-172.16.0.255</defaultdenyip>

### Related

Password
Maximum File Size
Maximum File Count
Allowed IP Addresses

## Maximum File Count

The Maximum File Count setting will be used by the plug-in to limit the number of files a user can upload in a single connection to your UPLOADit Server. If a user tries to upload more files than the maximum file count you define, the plug-in will return an error page to the user telling them that the number of files they tried to upload was greater than the allowed number. You can define a default maximum file count for the plug-in to use if you have not defined a maximum file count in your named realm.

### Example

<maxfilecount>5</maxfilecount>
<defaultmaxfilecount>2</defaultmaxfilecount>

### Related

Password
Maximum File Size
Denied IP Addresses
Allowed IP Addresses

## Maximum File Size

The Maximum File Size setting will be used by the plug-in to limit the size of files that a user can upload to your UPLOADit Server. If a user tries to upload a file larger than the maximum file size you define, the plug-in will return an error web page to the user telling them that the file they tried to upload was too large. This value is a number followed by three optional letters, "k", "m", and "g" which stand for "kilobyte", "megabyte", and "gigabyte" respectively. If you want to limit the file size to 256 bytes, you would specify "256". If you want to limit the file size to 16 kilobytes, you would specify either "16384" or simply "16k". If you want to limit the file size to 2 megabytes, you would specify either "2097152" or simply "2m", etc. You can define a default maximum file size for the plug-in to use if you have not defined a maximum file size in your named realm.

### Example

<maxfilesize>16k</maxfilesize>
<defaultmaxfilesize>2m</defaultmaxfilesize>

### Related

Password
Maximum File Count
Denied IP Addresses
Allowed IP Addresses

## Password

The Password value is used by the plug-in to present users with a standard Web Browser Password dialog to request a password to upload a file to your UPLOADit server. If you define a password for your realm, then when a user tries to upload a file to your UPLOADit server, their web browser will display a dialog asking for a username and password to access your server. They can put anything they want in the "User Name" field, but what they put in the "Password" field must match the password you have defined. (If want to know what the user entered into the "User Name" field, you can use the "Upld-GetFieldValue" function with the "UPLOADit_User" parameter.) You can define a default password for the plug-in to use if you have not defined a password in your named realm. (Note: The password will always be stored as plain text in the UPLOADit_Realms.xml file. When editing the realm with the UPLOADit Configuration Dialog, the password will be obscured by bullets.)

### Example

<password>secret</password>
<defaultpassword>test</defaultpassword>

### Related

Maximum File Size
Maximum File Count
Denied IP Addresses
Allowed IP Addresses

## Realm Name

The name of the Realm is what you use to differentiate between multiple realms that you have defined. Naming your realms allows you to have multiple realms for different users or groups of users to upload files to your UPLOADit server. The realm name is used in the Action parameter of your web form to tell your UPLOADit server what realm the form applies to, which dictates the rest of the realm settings, such as where to save the files on the hard drive. Realm names must be unique and are case-insensitive. While it is possible to include spaces and accented characters or other special characters in the name, it is best to use only letters and numbers in your realm name and exclude any spaces from the name.

### Example

<realm name="myrealm">

## Result URL

The Result URL is the URL (web address) that the plug-in will redirect the users' web browser to after they have uploaded a file (and after you have called the "Upld-ReleaseClient" function if you have a database and script defined for your realm). You can define a default result url for the plug-in to use if you have not defined a result url in your named realm.

### Example

<resulturl>http://www.yahoo.com/</resulturl>
<defaultresulturl>http://www.myserver.com/thankyou.htm</defaultresulturl>

## Script

The Script value is the script in your database the plug-in needs to call when a user uploads a file to your UPLOADit server. If you define a script to use, the script must exist in your database when a user uploads a file to your UPLOADit server. Otherwise, the plug-in will not be able to tell your database that a user has uploaded a file, and your database will not be able to release the user's web browser to redirect it to its final location. If the script is not defined in the database when a user tries to upload a file to your UPLOADit server, the user will receive an error web page telling them that the script could not be found in the database. You can define a default script for the plug-in to use if you have not defined a script in your named realm.

### Example

<script>UPLOADit</script>
<defaultscript>New File</defaultscript>

### Related

Database

## System Administrator's Email Address

The System Administrator's Email Address is used whenever the plug-in needs to return an error web page to the users' web browsers. If there is a problem uploading the file or if there is any other reason to return an error web page to the browser (like if the user's IP Address has been blocked), the System Administrator's Email Address is included in the error web page so that users can email somebody if they think they should not be getting the error or if they do not understand the error. You can define a default system administrator email address for the plug-in to use if you have not defined a system administrator email address in your named realm.

### Example

<sysadmin>webmaster@mydomain.com</sysadmin>
<defaultsysadmin>"John Doe" <john.doe@mydomain.com></defaultsysadmin>

## Upload Path

The Upload Path is the full path on your hard drive to the folder (directory) where files are placed when users upload them from their web browser. If the folder does not exist, the plug-in will create it when you start your UPLOADit server. You can define a default upload path for the plug-in to use if you have not defined an upload path in your named realm.

### Example

<path>/UPLOADit/</path>
<defaultpath>C:\UPLOADit\</defaultpath>

### Related

When File Exists

## UPLOADit Tag

The <UPLOADit> tag is the root tag for the XML document. This tag contains all the other UPLOADit xml tags and must appear in your XML file. This tag is the equivalent to the <HTML> tag in HTML files.

### Example

<UPLOADit>
...
</UPLOADit>

## When File Exists

The When File Exists value is used by the plug-in to determine what action to take when a user uploads a file with the same name as an existing file on your UPLOADit server. The three options you can select are "Make Unique", "Backup", and "Overwrite".

The "Make Unique" option will take the name of the newly uploaded file and append a number to the end making the file unique. For example, if there is an existing file named "image.jpg" on your server, and a user uploads a file with the name "image.jpg", the new file will be saved to your hard drive with the name "image1.jpg". If a second user uploads a file with the name "image.jpg", the new file will be saved to your hard drive with the name "image2.jpg", etc.

The "Backup" option will rename the existing file with the word "Backup" in it, and then save the newly uploaded file to your hard drive with the existing name. For example, if there is an existing file named "image.jpg" on your server, and a user uploads a file with the name "image.jpg", the existing file will be renamed to "image Backup.jpg", and the new file will be saved to your hard drive with the name "image.jpg". If a second user uploads a file with the name "image.jpg", the existing file be renamed to "image Backup1.jpg", and the new file will be saved to your hard drive with the name "image.jpg", etc.

The "Overwrite" option will simply overwrite the existing file with the newly uploaded file.

You can define a default when file exists value for the plug-in to use if you have not defined a when file exists value in your named realm.

### Example

<whenfileexists>make unique</whenfileexists>
<whenfileexists>backup</whenfileexists>
<defaultwhenfileexists>overwrite</defaultwhenfileexists>

### Related

Upload Path