# Documentation Overview

##
The following is a description of each section of the UPLOADit documentation.

### Overview of Chapters

#### The following is an overview of the chapters in the UPLOADit documentation.

Chapter 1: Introduction, Installation, and Configuration
This chapter will introduce you to the UPLOADit plug-in, show you how to install the plug-in, and show you some of the Configuration Dialog settings.
Chapter 2: How to set up your Web Page Form

This chapter explains how to set up your web page form to allow your users to upload files to your computer.

Chapter 3: How to set up your UPLOADit FileMaker Script

This chapter explains how to set up a FileMaker script in your database that UPLOADit will run when a user uploads a file to your UPLOADit server.

Chapter 4: File Upload Example

This chapter explains the File Upload Example solution that comes with the UPLOADit plug-in. This example solution allows you to upload any type of file to your FileMaker Web folder, and then shows you a result page that allows you to view or download the file you uploaded.

Chapter 5: Image Import Example

This chapter explains the Image Import Example solution that comes with the UPLOADit plug-in. This example solution allows you to upload a GIF or JPEG image, which will be imported into a container field in the database, and then display a web page showing the image you uploaded.

Chapter 6: Resume Upload Example

This chapter explains the Resume Upload Example solution that comes with the UPLOADit plug-in. This example solution first asks a web user for their First and Last Name, and then allows them to upload a resume to the UPLOADit server. It places the user's resume in a folder named with their first name inside of a folder named with their last name.

Chapter 7: IP Address Checking
This chapter explains how UPLOADit checks IP addresses against the Allow and Deny IP lists you can define for your Realms.
Chapter 8: Credits & Contact Information

### Overview of Appendixes

#### The following is an overview of the appendixes in the UPLOADit documentation.

Upld-DefineRealmXML
Upld-DeleteRealm
Upld-File-Copy
Upld-File-CreateFolder
Upld-File-Delete
Upld-File-Exists
Upld-File-GetPathToDB
Upld-File-GetPathToFM
Upld-File-Move
Upld-File-Rename
Upld-File-Size
Upld-GetFieldValue
Upld-Port
Upld-Register
Upld-ReleaseClient
Upld-SetResultURL
Upld-StartServer
Upld-StopServer
Upld-Version
Appendix A: Functions
This appendix lists and describes all the UPLOADit functions available to your FileMaker scripts. Each function lists a few examples, related functions, and possible error responses.
Allowed IP Addresses
Database
Denied IP Addresses
Maximum File Count
Maximum File Size
Password
Realm Name
Result URL
Script
System Administrator's Email Address
Upload Path
UPLOADit Tag
When File Exists
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.
Understanding Error Responses
Appendix C: Function Error Responses
Blocked IP Address
Could Not Get File Name
Database/Script Problem
Disk Error
Error Receiving Data
File Error
File Error
File Error
File is too Large
File Stream Error
Invalid Content-Type
Malformed Authorization Header
Malformed Headers
Malformed Headers
Malformed Method
Malformed Request/Realm
Memory Error
Memory Error
Realm Not Found
Result URL Error
Too Many Files
Unauthorized
Unauthorized
Unknown Error
Unsupported HTTP Version
Unsupported Method
Appendix D: Browser Errors
This Appendix lists and describes the web page errors that UPLOADit will possibly send to your web browser when you try to upload files to it. Each of the errors below are categorized by the main error message. The description then contains the secondary (longer) error message followed by possible reasons for receiving the error.
Step 1
Step 2
Appendix E: UPLOADit Flow Chart
Following is general view of how a file gets from the browser to FileMaker.
CGI
Domain
Form
IP Address
Realm
TCP/IP Port
UPLOADit_Realms.xml
URL
Appendix F: Glossary
Here are several definitions that you may find helpful while reading the UPLOADit documentation.

### Overview of Figures

#### The following is an overview of the figures in the UPLOADit documentation.

#### Chapter 1

1.1 Installing on Macintosh
1.2 Installing on Windows
1.3 Configuration Dialog - Basics Tab
1.4 Configuration Dialog - Realms Tab
1.5 Configuration Dialog - About Tab

#### Chapter 2

2.1 Web Form Example Realm XML
2.2 Web Form Example HTML Page
2.3 Web Form Example Action Attribute
2.4 Web Form Example URL
2.5 Web Form Example HTML Page 2
2.6 Web Form Example Upld-GetFieldValue
2.7 Web Form Example Upld-GetFieldValue 2

#### Chapter 3

3.1 UPLOADit Script Example Realm XML
3.2 UPLOADit Script Example HTML Page
3.3 UPLOADit Script Example Script
3.4 UPLOADit Script Example Script with Find

#### Chapter 4

4.1 File Upload Example Start Server Result
4.2 File Upload Example URL
4.3 File Upload Example Start Server Script
4.4 File Upload Example Stop Server Script
4.5 File Upload Example UPLOADit Script
4.6 File Upload Example Result URL
4.7 File Upload Example Form Tag
4.8 File Upload Example Input Tags
4.9 File Upload Example thanks.htm CDML

#### Chapter 5

5.1 Image Import Example Start Server Result
5.2 Image Import Example URL
5.3 Image Import Example Start Server Script
5.4 Image Import Example Stop Server Script
5.5 Image Import Example UPLOADit Script
5.6 Image Import Example Realm XML
5.7 Image Import Example default.htm Form Tag
5.8 Image Import Example default.htm Input Tags
5.9 Image Import Example thanks.htm CDML

#### Chapter 6

6.1 Resume Upload Example Start Server Result
6.2 Resume Upload Example URL
6.3 Resume Upload Example Start Server Script
6.4 Resume Upload Example Stop Server Script
6.5 Resume Upload Example UPLOADit Script
6.6 Resume Upload Example Realm XML
6.7 Resume Upload Example default.htm Form
6.8 Resume Upload Example upload.htm Form Tag
6.9 Resume Upload Example upload.htm Form Action
6.10 Resume Upload Example upload.htm Input Tags
6.11 Resume Upload Example thanks.htm CDML

#### Chapter 7

7.1 Example UPLOADit_Realms.xml file with IP checking

#### Appendix C

C.1 Error Response Form
C.2 Error Response Example
C.3 Error Response Script