afh online documentation - part II (details)
Table Of Content
1. general settings section
1.1. admin login
1.2. admin password, confirm password
1.3. admin email
1.4. skip referer test
1.5. license code
2. form managment section
2.1. view
2.2. edit
2.3. delete
3. add new form
3.1. form title
3.2. form url
3.3. "thankyou" page
3.4. email address
3.5. email subject
3.6. accept attachment
3.7. file upload varible name
3.8. max attachment size
3.9. allowed attachment types
3.10. send back notification
3.11. message
3.12. excluded variables
3.13. transform names
3.14. IP address
3.15. HTTP_ACCEPT_LANGUAGE
3.16. HTTP_USER_AGENT
4. setup your online-form
general
That section of admin interface is used for defining general settings of the script, below we list all settings you may fond there.
admin login-
this login you will be prompted when using this script as administrator. It can not be changed. If you want to do so then request support.
admin password, confirm password-
these both fields are used for setting password to admn section of the script. When you logged ther for the first time you have to set this password in order to avoid unauthorized access to the script admin section. Both fields are look empty, but change their value only if you want to change password or set new one.
admin email-
this value used for automaticly generated error messages and for system notifications. If you want to change its value please visit this page to update your license inforamtion and get new license code.
skip referer test-
in order to define from what form request has been received script uses "referer" value of request data. Sometimes due to misconfiguration of the server software this test fails and therefore script not able to find form processing instructions. ONLY in this case you have to check this box, and call script in the following way:
<FORM ACTION="afh.php?xxxxxxxx" METHOD="POST">
....................
....................
....................
</FORM>
where xxxxxxxx is a form id that may be found in the form managment section and presents itself a set of numbers.
license code-
that's a license code you recieved when ordered AFH, please copy it and paste into this field, if registration is completed you will see "license okay" message, if not you will see following note " warning: not registered copy". Please be sure that your license code is up to date. Visit this page to update or get your license code.
form managment
that section of admin interface allows you to manage registered forms, i.e. edit their settings, update location and behaviour. There are three links you can use: "view", "edit", "delete":
view-
use this link to see the actual form, just in case you forgot what is that:) If you will try to test form in the opened window this will not work since you logged in as administrator and all child windows inherit this feature. Therefore if you would try you will see admin area instead of form submission results.
edit-
use this link in order to update or look at the current form settings. You can update any settings there, just keep requred fields filled.
delete-
use this link to delete form. You will be prompted twice in order to avoid mistakes since this action is not undoable and form data will be lost.
add form
this is one-page section which used to register new form, after successful submission form data will appear in the "manage forms" section.
form title-
is a name of your form, will be shown in the forms mangament area, also will be used by the script to generate email subject in case if you will not specify custom subject.
form url-
absolute url of the form to be registered, i.e. http://www.yourserver.com/form.html, you can just copy it from the address bar of your browser when you open form. This value will be used during form requests to process form values according to the settings you define.
"thankyou" page-
absolute url of the "thank you" page, i.e. http://www.yourserver.com/thankyou.html - script will redirect user to that page after successful form submission. You can put there start page of your site if you dont have "thank you" page.
email address-
email address you want to receive submitted form data. You can define multyple values separated by comma "," or semicolon ";". Like this: admin@site.com,webmaster@site.com
email subject-
optional. Its value will be used when sending form data to defined email address as a subject line. If you leave this value empty then "form title" value will be used to genearate subject line.
accept attachment-
optional. Check this box if you want to enable AFH to attach file to email using form file upload. Only one attachment per form supported now.
file upload varible name-
optional. Type here variable name used in HTML form code to upload files. Just copy and paste this name into text field. If empty, then script will assume that it's called "file".
If you intend to use script to accept muliple attachments, there's nothing extra to be set in the admin area of the form. But you have to modify HTML code like this:
<FORM ACTION="http://www.yourserver.com/afh.php" METHOD="POST">
....................
....................
....................
<input type="file" name="attachment[]">
<input type="file" name="attachment[]">
<input type="file" name="attachment[]">
so all file upload elements will be having the same name "attachment". This name you have to enter as a file upload variable name.
This is common mistake to give several file upload elements differnt names! Follow example above to make it working and then you can play around.
max attachment size-
Type here the maximium size of file in kilobytes that you want script to attach to email. If uploaded file size will be larger then this value then no file will be attached, but warning message will be added to the email and if "send back notification" feature is enabled then warning message will be added to back email.
allowed attachment types-
List here file types you want to accept in attachments, for example if you want to allow attaching only some image file types then type here following: gif;jpeg;png;psd. You can separate values by comma "," or semicolon ";"
send back notification-
optional. Check this box if you want script to send back notification to the user who submitted form. In order to have this feature work you have to include to your form text field called "email" so users will be able to type their email address.
message-
This is message that will be sent back to the users submitted that form if this feature would be enabled.
excluded variables-
optional. List names of form variables that you don't want to receive in email, that can be some service variables appeared during form design. You can define multyple values separated by comma "," or semicolon ";". Like this: submit,email
transform names-
optional. This feature can be used to transform variable names look. For example you receiving email with a form data containing following:
first_n: John
last_n: Silver
addr1: 115 W.Oakland St.
time1: 9am-10am
time2: 9pm-11pm
You can force script to transform variable names to more obvious by using this syntax:
old_name_to_transform->New name
I.e. for the example above you can use following:
first_n->First name
last_n->Last name
addr1->Address Line 1
time1->Time to reach 1
time2->Time to reach 2
and put it into "transform names" textbox. This will produse following result next time you will receive submitted data:
First name: John
Last name: Silver
Address Line 1: 115 W.Oakland St.
Time to reach 1: 9am-10am
Time to reach 2: 9pm-11pm
which looks more clear.
IP address-
optional. Check this box if you want for some reasons track user's IP address, you will get along with other form data in email.
HTTP_ACCEPT_LANGUAGE-
optional. This feature useful if you want to track user's setting of browser language - you may run international site and interested in this value.
HTTP_USER_AGENT-
optional. This will include user's browser information, this may be helpful if you want to know type of browser you visitors use.
setup your online form
This will take just a moment to make your online form working with AFH. Open your form in your favorite HTML editor and find following code section:
<FORM ACTION="something.cgi" METHOD="POST">
....................
....................
....................
Now all you need is to substitute something.cgi with the path of AFH script file on your server, i.e. like this:
<FORM ACTION="http://www.yourserver.com/afh.php" METHOD="POST">
....................
....................
....................
if you set afh script to skip referer test as described here, then apply neccesary changes as described.
Now upload updated form file back to the server.
If you still have any questions or something is described not good, feel free to contact us or refer to the FAQ section.