Register / Login

How to Setup the S2 Form Processor: For Highrise®

PDFPrint

In this tutorial I'm 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

I'm going to assume that you've already downloaded the S2 form processor and generated a license key for your domain. If you haven't purchased, be sure to check out our free 15-day trial.

1. Upload the files to your website root directory

Using a ftp program of your choice upload the "s2_form_highrise" folder to the root directory of your website. In my case I'm uploading it to the /public_html folder in my hosting account.

2. Setup your configuration file

In the /s2_form_highrise directory you will find a file called config.php. This has the configuration settings necessary for the form processor to work. Let take a closer look at the configuration settings.

1. Enter your license information. You can generate a license for your domain by logging in to the stringtwo.com website and clicking on the Purchased Licenses tab on the right sidebar.

$conf['license_key'] = "6fb3f192a65367c5c17f356abcd0f130";

2. Use Captcha. If you plan on using the optional captcha anti-spam feature in your form you can set this value to 'true'.

$conf['use_captcha'] = false;

3. Highrise Settings. Your Highrise url and API token.

$conf['complete_highrise_url'] = "https://YOURCOMPANY.highrisehq.com/";
$conf['highrise_token'] = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";

4. The path to the page you want to display on a successful form submit.

$conf['url_on_successful_submit'] = "http://path_to_thank_you_file/thank_you.php";

5. You can create a note in Highrise using the entire form data or just the data not assigned to Highrise fields. Some people prefer to have the entire form data listed as a note rather that just the form entries that don't relate to a Highrise field. To use all form entries as a note change the value to 'true'.

$conf['full_form_note'] = false;

6. Setup your SMTP mail server settings. The form processor will send you a confirmation email each time the form is submitted. Optionally it will send a response to the contact as well.

$conf['smtp_host'] = "your.mailserver.com";
$conf['use_authenication'] = true;
$conf['smtp_username'] = "username";
$conf['smtp_password'] = "password";

7. Confirmation email settings. You can send confirmation emails to 1 - 3 email addresses.

$conf['subject'] = "Contact Form Email";
$conf['conf_email_address_to_1'] = " This e-mail address is being protected from spambots. You need JavaScript enabled to view it ";
$conf['conf_email_address_to_2'] = "";
$conf['conf_email_address_to_3'] = "";
$conf['conf_email_from_name'] = "Your Company Name";
$conf['conf_email_address_from'] = " This e-mail address is being protected from spambots. You need JavaScript enabled to view it ";

8. Email to client settings. Optionally you can set the form to email the client with a custom message and custom signature. To send an email to the client on submit set the value to 'true'.

$conf['send_email_to_contact'] = false;
conf['contact_email_from'] = "Your Company Name";
$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'] = "Your Company Name";
$conf['contact_email_signature_line_2'] = " This e-mail address is being protected from spambots. You need JavaScript enabled to view it ";
$conf['contact_email_signature_line_3'] = "ph. 555-555-1212";
$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.

3. Test configuration settings

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

s2_config_test

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.

4. Setup the contact form

JavaScript is disabled!
To display this content, you need a JavaScript capable browser.

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. In your html

tag edit action="" so that it includes the following path:

/s2_form_highrise/process.php

So your form tag will look similar to the following:

<form action="/s2_form_highrise/process.php" method="post">

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="">
<input type="text" name="law_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 added as a note for the contact.

5. 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" style="color:red;">Wrong answer, please try anti-spam again</p>

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

value="http://full_return_path_to_your_form">

The captcha_error and captcha_question can be and html tag you choose to use but the id attribute must equal captcha_error and captcha_question.

3. Add the following below your closing form tag

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

6. 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="prospects, web form">

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.

Online Store


List All Products





Lost Password?
Forgot your username?
No account yet? Register

Official PayPal Seal

StringTwo Blog

Popular Forum Topics

StringTwo @Twitter

Basic authentication is not supported