Skip to content

Latest commit

 

History

History
90 lines (61 loc) · 4.64 KB

README.rdoc

File metadata and controls

90 lines (61 loc) · 4.64 KB

Highrise Contact

This is a radiant extension that allows you to hookup a contact form and submit the form to a highrise account.

INSTALL:

This extension is not registered with the radiant extension site, so you must install it manually.

Here is more information on how to install an extension manually: github.com/radiant/radiant/wiki/installing-extensions

DEPENDENCIES:

If you use the optional SYSTEM NOTE feature you will need to to include the ‘ruport’ gem.

USAGE:

Once installed you need to set your highrise authentication token and company subdomain. The extension adds a settings tab that you can enter those values. You can optionally also specify the user and task category that you want tasks assigned to.

On one of your pages you need to include the following tag: <r:highrise-contact />

This will create a form for you to submit contact information to highrise. (Yes it really is that easy.)

If the contact exists (by email) then we ignore the contact fields and load the contact already in Highrise. If the contact does not exist (by email) then we add it with all the provided contact information.

What fields and how it is put into highrise is affected by the contact_type parameter: There are four variations on the forms that you can use.

FORM TYPES

<r:highrise-contact contact_type='select_type' />

This will provide a drop down with "Existing Customer" or "Prospective Customer" in it
If the users chooses Existing Customer then then it will behave as Web Support below.
If the users chooses Prospective Customer then then it will behave as 'Web Lead' below.
Note: You can not set the task subject when you chose this contact type.

<r:highrise-contact contact_type='Web Lead' />

This causes the form to create a web lead and a task on the person or address if provided
This will create highrise note on the contact and a task for the contact.
The contact will be tagged 'Web Lead'

<r:highrise-contact contact_type='Web Opt In' />

This causes the form to simply put the user into highrise and tag them as Web Opt In
This will create a highrise contact with a tag 'Web Opt In'

FORM OPTIONS

<r:highrise-contact return_url='/some_thank_you_page' error_url='/some_error_page'/>

Sets the error and return page urls.  Defaults to '/' for both.  These SHOULD be filled in espeically the error_url.
Recommend that you provide some other means to contact you on the error page.

<r:highrise-contact form_instructions="Please <span class='highlighter'>fill in and submit</span> the form below and we will contact you by phone or email. Required fields are indicated by the red star (<span class='required_field'>*</span>):"/>

Allows you to set the form instructions.

<r:highrise-contact privacy_statement='* We respect your privacy. &nbsp;Your information will not be shared without your permission.'/>

Allows you to set the form privacy statement.

<r:highrise-contact task_subject='Please followup'/>

You can optionally set the task subject by passing task_subject. (Applies only to Support and Lead types.)

<r:highrise-contact show_additional_info='true'/>

Additional info displays the fields:  street, city, state, zip and country

<r:highrise-contact button_text='Send my info'/>

  Changes the form submit button text.

You can optionally set any highrise tags you want by passing them:
These will be set either on the person or the address if provided
<tt><r:highrise-contact tags='Tag1,Tag2'/></tt>
If you provide tags then the default tags for the contact_type will NOT be set. (The default tag is the same as the contact_type.)

SYSTEM NOTE

You can optionally pass a query parameter named ‘system_note’ that may contain two levels of information. This will be lightly formatted and added as an additional note to the highrise contact.

Example URL: url?system_note=Ubuntu&system_note[id]=Intel64&system_note[name]=Intel® Core(TM) i7 CPU&system_note[speed]=2673

Formatted Note: ------------------------------------------------------------------------ | Label | Value | ------------------------------------------------------------------------ | Os | Ubuntu | | Cpu Id | Intel | | Cpu Name | Intel® Core(TM) i7 CPU | | Cpu Speed | 2673 | ------------------------------------------------------------------------