Web Form Processor - Introduction

Installation Instructions

Form List

General Settings

Form page and validation rules

E-mail settings

File Storage

Database Storage

Custom Messages

Upload Settings

Validation rules

Mail settings

Banned IP addresses

Banned email addresses

Referrers

Change password

System configuration

Web Form Processor - Introduction

Web Form Processor is a tool that is used for processing custom forms created by customers in any HTML editor. The results of each form submissions can be emailed to an email address, saved to a data file or CSV file and exported to one or several databases.

The basic algorithm for working with the tool is very simple :

1. Add a new form and set it up according to your preferences.
2. Add pages to the form (if the form consists of several parts)
3. Add fields to the pages. The fields will be processed by Web Form Processor depending on the defined rules and requirements.
4. You can add fields by scanning the form at the specified URL (the option 'scan form') and mark the needed fields found by our system. Or set the fields manually, if no scanning is possible. Then select validation rules for each field.
5. Set up all the rest requirements for sending the submissions to email, database or text/CSV files, or calculation.
6. Configure the settings of banned lists if needed.
7. Go to the section 'HTML' in the 'Forms List' section, copy the code and put your modifications into the appropriate places within the HTML page (which was scanned)
8. The form is complete and functional.

Installation Instructions

1. Unpack the script and upload it to any directory on your server. It is recommended to create a separate folder for the script.
2. Change permissions on the folders, and on files.
   
   You can change file permissions (CHMOD) this way:
   1. If you use FAR as an ftp client, press Ctrl+A,
      set [x][x][x] [x][x][x] [x][x][x], press Ok;
   2. If you use WS_FTP:
      right click on file/folder->properties->ok
   
   Set write permissions on the following directories and files within Web Form Processor:
   • Folder 'cache' (CHMOD 777)
   • Folder 'database' (CHMOD 777) and all the files within the folder (CHMOD 666)
   • File 'log.txt' (CHMOD 666) located in the directory 'log/'
   • Folder 'uploaded' (CHMOD 777)
   • File 'config.php' (CHMOD 666) located in the system directory of Web Form Processor
3. Open your web browser and in the address line write the path to the script 'install.php', e.g. http://www.yourdomain.com/wfp/install.php, where 'yourdomain.com' is the name of your domain, 'wfp' is the name of the folder you put the script files.
4. Once you click Accept in the License Agreement window, you'll go directly to the installation process. The following page will be shown:

4. The installation script will automatically determine the full URL to the system and display it in the appropriate field. If by any means, the automatic detection was incorrect, you can make the changes manually.
5. Enter the administrator password that will be used for logging into the script administration interface. Press the button 'install' to continue the installation. If the script detects inappropriate permissions to the system directories and files or if the data is entered incorrectly, you'll see an error message. Go back and make the appropriate changes.
6. When the installation is complete, you will be directed to a page with the message about the successful installation. Click on the link to go to the login page to the administration part of the system. Enter the login 'admin' and the password entered on step 6.
7. Congratulations! The installation of your Web Form Processor is complete and the script is ready to use.

Form List

The section contains the list of all available forms.

Click 'Add Form' to add a new form.

The 'Action' column shows all the possible actions for your forms:

• To edit the form, click on the form name, 'Edit' or
• To add the HTML code for your form, click 'HTML' or
• To delete the form from the system, click 'Delete' or

General Settings

This page contains the general settings for your form.
Change form name Form Name is the value used to identify your form in the admin panel of Web Form Processor.
Success and Error Page Settings. The section specifies the URLs where to the users will be redirected after they submit the form.
The HTML page at the specified URL may contain texts arranged in substitution and calculation blocks (the format is the same as in the magic wizard's fields).
If the check box isn't checked in the fields, the system simply redirects browsers to the specified address (without substitutions). When the check box is true, the script will read the specified page, make substitutions and display in the user browser without further redirection.
Form validation indicates if your form uses field validation; in other words if improper data entered into the fields, users will see a corresponding error message. (see the section Validation rules below)
Image challenge specifies the use of the dynamic image code (CAPTCHA) in your form. Check 'Yes' if you want to protect the form from automatic submissions.
Check Referrers. If enabled, the script will check the referrer and block submissions from the banned referrer (URL) (see the section Referrers below for more information about referrers) Date and Time Settings specify the format for time and date that will be used in your form by default. You can set the default format for Date, Time, Time and Date and Time Zone.

Form page and validation rules

The section contains the list of pages and validation rules for each page's fields. You can use the pre-set validation rules or add your own rules (see the section 'Validation rules' below).

Click on the tab with page name to open the field validation settings of the page.

You can add the fields by scanning the form at the URL you specify in the field 'URL of the page' and press "Scan form". The page will be scanned and all available forms and fields will be listed below. Mark all the fields you need for the page and click 'Add fields'.

NOTE: the field must contain only correct the page's URL, because it is used to link form pages with each other. You must enter the URL if no form scanning is required.

The menu 'Add existing field' includes the fields there were added to pages last time or after they were scanned using the option 'Scan form' (see above).
To add custom fields, use the option Add custom field.

In the column 'Required Fields' you can set the required mark for the field. To make the field required, please select a check rule from the drop down menu next to the field name (the 'Validation rule' column).

To add a rule to the field, click 'Add rule' or . The list of validation rules consists of the script's standard rules package (standard) and the rules created by the administrator in the section Validation rules (see below).

NOTE: If you assign several validation rules for the field, they will be checked consequently using the IF condition. In other words, if at least one rule is met, the field will be validated.

To delete the field click 'Delete field' or

E-mail settings

The section consists of the settings for emails sent out after the form submissions.
Data Email Layout defines the layout for emails. Select 'Yes' to send form submissions via email. Click 'No' to disable the 'send to email' option.

When you choose the Default Layout, you will have the following options:

• set the 'To' email address
• define 'CC' and 'BCC' addresses
• set the 'From' email address
• specify the 'bounce email'

Click on the icon next the field to open the magic wizard. This will allow you to select the field that can be replaced with the corresponded field value from the form submission and to include the following mathematical operations to your form: add a calculation block - , add data - , extract - , divide - , multiply - and round -

When selecting an Own Layout in the Data Email Layout section you will see the following options:

• Set 'From' email address
• Set 'To' email address
• Specify Custom headers
• Define the Text layout

Click on the icon next to the field to open the magic wizard.

Press the button 'Add' to add another email template with its own fields to the Email Layout section. If you add several email templates, you can send emails with different settings and texts to different addressees. Thus, in Own Layout you can send several emails per one form submission, while using the Default layout only one email with a standard text will be sent (the text will include the names and input field values of the whole form).

When all the changes are made, click 'Save'. Click 'Cancel' to cancel the modifications.

File Storage

In this section you can enable/disable the option of file storage and define the type of form data storage. You can add the submitted data to a data file or save as a CSV file.

NOTE: The path to the file must be correct and the folder must have write permissions (CHMOD 666).

The form submission data can be saved as a separate file. The names will be generated automatically by adding prefixes to the existing file name, for instance, 00_filename.txt, 01_filename.txt. Also the option to append data to the existing file is available.

The blocks entered in the field Datafile Sequence like [%var_name%] will be substituted with the data from the submitted form, and the blocks like <% 10 + 20.10 %> will be replaced with calculations.

Database Storage

The section contains your database settings. You can select to store form submissions to a database here.

Click 'Add to Database' to add form input data to the database.
Form data can be exported to a database. MySQL, PostgreSQL and Oracle databases are supported. Make your choice in the field 'Choose the type of the database'
The fields 'database name' 'username', 'password' and 'Host'define the database access parameters.

For an Oracle database there are extra fields for settings - 'ORACLE_SID', 'ORACLE_HOME', 'TNS_ADMIN', that are placed in a separate Settings section.

The field 'Query' represents a query line for the selected database. You can add substitutions and calculations in this line and use the magic wizard option - click on

Custom Messages

You can define validation error messages in this section. If certain rules for the field validations are not met, Web Form Processor will show the messages you specify below.

The following validation messages are available:

• Error message for the "any symbols" validation rule
• Error message for the "letters only" validation rule
• Error message for the "digits only" validation rule
• Error message for the "digits and letters only" validation rule
• Error message for the "e-mail address" validation rule
• Error message for the "IP address" validation rule
• Error message for the "http link" validation rule
• Image challenge error
• Banned IP error
• Banned e-mail error
• Banned referrers error
• Error message displayed if the uploaded file exceeds the allowed file size
• Error message if the uploaded file has a banned extension
• Error message if the required field isn't specified

To add messages for custom rules go to the section Validation Rules (see below).

Upload Settings

The section contains the options for enabling/disabling file uploads, the limitations on Max FileSize, upload path and limitations on the file types.

NOTE: The path must exist (the folder must be defined correctly and it must have write permissions (CHMOD 666).

Validation rules

The section contains the list of custom validation rules.

To edit the existing validation rules, click 'Edit' or the icon next to the rule name.
To add a new validation rule, click on the button 'Add rule'.
You will have the following options:

Set a Rule name, define Regular expression and set the Error Message displayed when the rule isn't met.

To delete a rule, select the appropriate check box and press 'Delete'.

Mail settings

In this section you can specify the system global email settings.
To enable SMTP, click 'Yes'.
Enter below your SMTP hostname and port. If your SMTP server requires authentication, define your username/password.

Click 'Save' to save your settings.

Banned IP addresses

Here you can see the list of banned IP addresses and add new addresses that will not be allowed for your form submission.

To add new IP addresses to the banned list, click 'Edit'. List the IP addresses in the text area.
Separate the values with comma. Click 'Save'.
To clear the banned list, click 'Clean ban list'

Banned email addresses

The section contains the list of banned email addresses.
To clear the banned list, click 'Clean ban list'.

To add new email addresses to the banned list, click 'Edit'. In the text area list comma separated email addresses.

Referrers

Here you can see the list of the allowed referrers, where from visitors come to your web page.
To add / edit the allowed referrers, click 'Edit'.

If you selected 'Yes' next to the option 'Enable Referrers Check' in the General Settings section (see above), the script will check referrers and will not allow form submissions from the banned referrers.
Referrers must be specified as a full URL. To separate referrers, use comma ",".

To clean the list of referrers, press the button 'Clean list'.

Change password

This section allows you to change the administrator password.
Enter the current password and define the new one to enter the administration interface.

System configuration

This section defines the system global configurations.

The following sections are available:

Replace and Calculate Blocks Settings. You can change the default values for the following delimiters:

• block heading delimiter
• end block delimiter
• delimiter for calculation block heading
• delimiter for calculation block ending

Logging Settings. The feature allows you to enable / disable data logging and set up the path to a log file.

Other Settings. Here you can define the following:

• Delimiter for CSV files
• Submission ID size. Specify the number of characters for the ID
• Maximum file size for the uploaded files in Kilobytes

Oracle Database Settings. Define the following parameters for the Oracle database:

• Oracle SID
• Oracle home (location)
• TNS administrator