In this tutorial we're going to walk you through the necessary steps of setting up a form to work with Highrise and show you just how easy the process really is.

We've provided a lot of detail here, but typical setup takes 15-30 minutes

1. Download and Unzip the software

Make sure you've downloaded the demo software or full version. Once downloaded, unzip the file to reveal all of the files.

2. Make sure your config.php file exists

Look in the /s2form folder that was in the zip file. If you're installing the demo, the config.php file is already there. If you are installing the full version and skipped the demo then simply rename config-sample.php to config.php.

3. Edit config.php to input your settings

In the /s2form directory you should now find a file called config.php. Use a text editor of your choice to edit this file. This file has the configuration settings necessary for the form processor to work. Let take a closer look at the settings.

When editing the config.php file be careful to keep your edits within the quotation marks.

HIGHRISE API SETTINGS

/**
* Description: Highrise url - Your company Highrise url
* Value: Your company Highrise url
* Default: example
* Note: If your using ssl in your Highrise account make sure you use https rather than http. The
* trailing slash on your url is necessary ex: https://yourcompany.highrisehq.com/
*
*/
$conf['complete_highrise_url'] = "https://your_highrise_url.highrisehq.com/";

/**
* Description: Highrise API token
* Value: API token issued by Highrise
* Default: example
* Note: Login to Highrise -> My Info -> User Account -> Reveal Authentication Token
*
*/
$conf['highrise_token'] = "3xxxxxxxxxc141cdxxx12xxxxxxxxxxxxxxx477";

/**
* Description: Add a task to your Highrise Account
* Value: true or false
* Default: false
* Note: Creates a followup task for the next day in Highrise when the contact information is added
*
*/
$conf['add_task'] = false;

/**
* Description: Add a note to your Highrise Account with all the form field data including fields
* that may not be compatible with Highries fields. Essentially a summary of your form data added
* as a note in Highrise.
* Value: true or false
* Default: true
*
*/
$conf['full_form_note'] = true;

GENERAL FORM SETTINGS

/**
* Description: Page to open after your form was submitted successfully
* Value: Full path to your success page
* Default: example
* Example: http://www.yourdomain.com/thankyou.html
*/
$conf['url_on_successful_submit'] = "http://path_to_thank_you_file/thank_you.php";

/**
* Description: Use Captcha - Adds captcha functionality to your forms
* Value: true of false
* Default: false
*
*/
$conf['use_captcha'] = false;

E-MAIL SETTINGS (Optional)

/**
* Mail settings are entirely optional. You can use the following settings to send an email to
* the contact that filled out the form, a conformation to yourself/company or both.
*
* Note: Setting up SMTP settings can be tricky. Make sure you have the username and password
* for your email account if authentication is necessary. Check with your ISP for more details.
* If your using Google mail we have provided the host settings you will just need to add your
* username and password.
*/

/**
* Description: Use Email - Do you want to use email confirmations
* Value: true or false
* Default: false
* Note: Only conformation email to self are available in the trial version
*
*/
$conf['use_email'] = false;

/**
* Description: SMTP host - the host account that your will use to send email from.
* Value: Your SMTP host data from your ISP
* Default: example
* Note: If using gmail set value to ssl://smtp.gmail.com
*
*/
$conf['smtp_host'] = "mail.yourdomain.com";

/**
* Description: SMTP Authentication - Some ISP's will require you to use authentication when using their mail server.
* Value: true or false
* Default: false
*
*/
$conf['use_authenication'] = false;

/**
* Description: SMTP Username and Password - Required if above setting for authentication is set to true.
* Value: username and password value from your ISP's SMTP server
* Default: ""
*
*/
$conf['smtp_username'] = "my_email_username";
$conf['smtp_password'] = "my_email_password";

/**
* Description: SMTP Port - Some ISP's require outgoing mail to be sent using a specific port
* Value: ISP SMTP outgoing mail port
* Default: 25
*
* Note: If using gmail set port to 465
*/
$conf['smtp_port'] = 25;

CONFIRMATION EMAIL TO SELF

/**
* Description: Conformation email to self - Emails sent to you when the form is submitted
* Value: send_email_to_self - enable this feature true or false
* Value: subject - custom subject
* Value: conf_email_from_name - From name that will appear on email
* Value: conf_email_from - From email address
* Value: conf_email_to - To email address
*
* Note: All values are required
*/
$conf['send_email_to_self'] = false;
$conf['subject'] = "You have a new lead";
$conf['conf_email_from_name'] = "My Web Form";
$conf['conf_email_from'] = " This e-mail address is being protected from spambots. You need JavaScript enabled to view it ";
$conf['conf_email_to'] = " This e-mail address is being protected from spambots. You need JavaScript enabled to view it ";

CONFIRMATION EMAIL TO LEAD

/**
* Description: Conformation email to lead - sends email to lead that filled out the form
* Value: send_email_to_contact - enable this feature true or false
* Value: subject - custom subject
* Value: contact_email_from - From name that will appear on email
* Value: return_email_address - From email address - return email address
* Value: contact_email_subject - custom subject
* Value: contact_email_body - message to send to lead
* Value: contact_email_signature_line - up to 5 custom signature lines for the email
* Value: conf_email_to - To email address
* Not available in trial version
*
*/
$conf['send_email_to_contact'] = false;
$conf['contact_email_from'] = "My Company";
$conf['return_email_address'] = " This e-mail address is being protected from spambots. You need JavaScript enabled to view it ";
$conf['contact_email_subject'] = "Thank you for you request";
$conf['contact_email_body'] = "Thank you for your request. We will contact you as soon as possible.";
$conf['contact_email_signature_line_1'] = "John Smith";
$conf['contact_email_signature_line_2'] = "StringTwo Software";
$conf['contact_email_signature_line_3'] = " This e-mail address is being protected from spambots. You need JavaScript enabled to view it ";
$conf['contact_email_signature_line_4'] = "";
$conf['contact_email_signature_line_5'] = "";

And that is all there is to the configuration. In the next step we will check to make sure our configuration settings are working properly.

4. Upload the s2form directory to your website root directory

Using a ftp program of your choice upload the "s2form" folder to the root directory of your website. In our case we're uploading it to the /public_html folder in our hosting account. Sometimes this is called something else, like /www.

5. Test configuration settings

In a web browser navigate to http://your_web_site/s2form/test.php. If your setting are working properly you will see the following screen:

It will also send a test email to the confirmation email address in your config.php file. If something is not set up properly it will show you on the screen. Make the appropriate changes to your config.php file and reload the page.

6. Setup the contact form

Adobe Flash Player not installed or older than 9.0.115!

We are now ready to setup our form so the information is sent to Highrise. This is a really simple process.

1. Edit the path for the form action attribute so that it points to /s2form/process.php. In your html

For Example

<form action="/s2form/process.php" method="post" accept-charset="utf-8">

To add fields that will be entered into Highrise simply replace the name="" attribute of the input field with our reserved Highrise tags. For example if I wanted to add first name and last name that will be entered into the corresponding Highrise fields I would add the following to my form:

<input type="text" name="first_name" value="">

and

<input type="text" name="last_name" value="">

Our form processor currently supports the following Highrise fields:

*name(automatically parses out the first and last name), first_name, last_name, title, company, phone, email, website, tags

All other form fields that are not one of the Highrise supported tags will be parsed and can be added as a note for the contact if you've enabled that option.

7. Add captcha to your form (optional)

Our form processor has built in captcha functionality. When captcha is enabled a random question will be generated and placed into your form. If the captcha question is answered incorrectly the user will be returned to the form with the fields populated with the previous values and an custom error message for the incorrect captcha answer.

To enable captcha complete the following steps:

1. In your config.php set use captcha to true.

$conf['use_captcha'] = true;

2. Add the following to your form where you want the captcha question displayed:

<label for="captcha" id="captcha_question"></label>
<input type="text" name="" value="" id="captcha">

3. Add the following to your form where you want the captcha error displayed and replace the message with your custom error message:

<p id="captcha_error">Captcha test failed. Please try again.</p>

Add the following anywhere in your form and replace the value="" with the full url back to the form:

3. Add the following below your closing form tag

<script type="text/JavaScript" src="/s2form/captcha.js"></script>

8. Using Tags (optional)

You can add tags to you contact in Highrise directly from your form. Simply add the following field anywhere in your form:

<input type="hidden" name="tags" value="prospect, web form, contact page">

You can have as many tags as you like. Tags must be in the value attribute and separated by commas.

Now that we have gone through the entire process you should have a better understanding of how to set up our S2 form processor for Highrise. It may seem long in this detailed explanation but the entire process usually takes between 15 and 30 minutes. If you have any additional questions regarding the installation please post to our forums. We value your input and look forward to hearing from you.