RCDchannel Support Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Recruiter Integration Guide ======

The ChannelSUITE Recruiter function helps facilitate and organize your partner recruiting efforts. It provides a list of open “in process” partner recruit applications, along with useful features for collecting and organizing data on each recruit. When a recruit is approved, the data is used to create a new Partner record in channelADMIN, along with a new Location record and a new Contact record. Historical data for both approved and rejected recruit applications is available. 

==== Technical Overview ====

The approach is this: you supply a "Join our Partner Program" form on your website, and POST the form to our server.  The information entered on the form will then be stored and placed in the queue of prospective partners.  There are certain required fields (see "required fields" below) that we require in order to get the process started.  There are optional fields that are available to you if you want to capture extra information about the prospective partner (see "optional fields" below).  View [[RC-example| sample code here]] for a form that utilizes all fields available.  There are also required hidden fields that need to be added into the form in order for our server to be able to process the information.

==== Integration Steps ====
  - request a free directRecruitPost key from your channelSUITE account manager
  - include the necessary javascript files
  - set up form using specified field names and field IDs
  - add the hidden yourEmail field to the form to discourage spambots
  - set the form ACTION to send form submissions to your channelSUITE install
  - test the form using the built-in test mode
  - turn off test mode

more details on these steps are shown below

====Javascript Includes====

several javascript files are needed to set up client-side validation and the country-specific state/province select box. all the files can be loaded from the channelsuite server as shown, or if you prefer you can download the files and host them on your server. //Note: The stateProvinceMap technically contains dynamic data, but it only changes if support for states/provinces is added for an additional country in your channelsuite database, so in practice you may treat it as a static file.// 

add this in the <head> section of your html

<code html>
<!-- CHANNELSUITE REQUIRED -->
<script type="text/javascript" src="http://yourChannelsuiteURL/API/js/prototype.js"></script>
<script type="text/javascript" src="http://yourChannelsuiteURL/API/js/recruiterForm.js"></script>
<script type="text/javascript" src="http://yourChannelsuiteURL/API/js/stateProvinceMap.js.cgi"></script>
<script type="text/javascript" src="http://yourChannelsuiteURL/API/js/stateWidget.js"></script>
<!-- end CHANNELSUITE REQUIRED -->
</code>

====Form Contents====

=== REQUIRED fields ===

The following fields are required in order to create a prospective partner:

  * Company Name - the name of the company looking to become a partner
<code html>
<input value="" name="company_name" type="text" id="company_name">
</code> \\
  * First Name - the first name of the contact belonging to the company
<code html>
<input value="" name="contact_first_name" type="text" id="contact_first_name">
</code> \\
  * Last Name - the last name of the contact belonging to the company
<code html>
<input value="" name="contact_last_name" type="text" id="contact_last_name">
</code> \\
  * E-Mail - the e-mail address of the contact belonging to the company
<code html>
<input value="" name="contact_email" type="text" id="contact_email">
</code> \\
  * Phone - the phone of the contact belonging to the company
<code html>
<input value="" name="phone" type="text" id="phone">
</code> \\
  * Country - the country code for the country in which the prospective partner is located. See below for more information about standard country codes. //Note: the "onchange" event handler is only required if you use a state/province field in your form (recommended if you recruit in US or Canada)//
<code html>
<select id="countryCode" name="countryCode" onchange="stateWidgetCallback();">
  <option> tags go here, see below
</select>
</code> \\


=== OPTIONAL standard fields ===

Severeal standard fields are optional, and may be used to record more information about the prospective partner. You may also define your own fields (see the Custom Fields section below). The optional standard fields are:

  * Middle Name - the middle name of the contact belonging to the company
<code html>
<input value="" name="contact_middle_name" type="text">
</code> \\
  * Fax - the fax number of the contact belonging to the company
<code html>
<input value="" name="fax" type="text">
</code> \\
  * Gross Sales - the gross sales of the company
<code html>
<input value="" name="gross_sales" type="text">
</code> \\
  * Total Staff - how many staff members work for this prospective partner
<code html>
<input value="" name="total_staff" type="text">
</code> \\
  * Establish Year - what year was this prospective partner formed
<code html>
<input value="" name="establish_year" type="text">
</code> \\
  * Street 1 - street address of prospective partner
<code html>
<input value="" name="address_street1" type="text">
</code> \\
  * Street 2 - additional street address of prospective partner if needed
<code html>
<input value="" name="address_street2" type="text">
</code> \\
  * City - city of prospective partner
<code html>
<input value="" name="address_city" type="text">
</code> \\
  * State/Province - the code for the state or province of prospective partner. Leave an empty element with ID "statecell", this will be filled in dynamically by the stateWidget javascript. See below for more information on setting up the state/province codes.
<code html>
<span id="statecell"></span>
</code>
  * Postal Code - postal code of prospective partner
<code html>
<input value="" name="address_zip" type="text">
</code> \\
  * Total Locations - total number of locations for the prospective partner
<code html>
<input value="" name="total_locations" type="text">
</code> \\

=== REQUIRED hidden fields ===

The following hidden fields are required in order to save the information to the database:

  * directPostKey
    * The value of this field must match the directRecruitPost key assigned to you on the server. Please ask your account manager to get you a "Recruiter direct Post Key".
      <code html><input type="hidden" name="directPostKey" value="someRandomKey"></code>

=== OPTIONAL hidden field ===

The following hidden field is used for testing your form:

  * saveRecord
    * when this hidden field is set to 0, submitted form contents are echoed back to the screen and are NOT submitted to the channelsuite recruit database. if this field doesn't exist or is set to any value other than 0, the form is processed normally. 
      <code html><input id="saveRecord" name="saveRecord" value="0" type="hidden"></code>

=== CUSTOM fields ===

In the even that you want to capture more information than the fields outlined above, you can also add in your own custom fields which will be saved into the Comments field in the table.  Should you have two custom fields, namely: \\
<code html><input type="text" name="custom_1" value="Custom field 1"></code>
<code html><input type="text" name="new_field" value="A new field"></code>
The following will be appended to the Comments field: \\
custom_1: Custom field 1 \\
new_field: A new field \\ \\
The name of the field will be entered first, followed by a colon (:) and then the value the user entered.  Any of these extra fields will be added to the end of any existing Comments already entered.  A new line will separate multiple user defined custom fields.

=== Anti-spam: the yourEmail hidden field ===

Forms on public websites are often targets for "spambots" -- automated "spiders" that wander around the web looking for forms. The spambot puts its irrelevant message in whatever fields it can find, and submits the form in the hopes that the posted content will show up somewhere where it will be seen. These submissions would show up as bogus entries in your recruit database. Quite annoying. 

Spambots aren't very sophisticated, and they can be effectively defeated by using a "captcha", the most common example being to ask your users to type in the text from a distorted text image. This works, but it's irritating to your users. We're using a simpler method called a "honeypot". We  add a field to your form that users can't see, but that the spambots can't easily identify as a hidden field. The spambots will typically insert content into this field. If the field isn't empty, it's usually a spambot submission, and we reject it with an appropriate error message. It contains a label that instructs users of alternative browsers (handicapped-accessible screen readers, for example) to leave the field empty. This method is very effective, and causes no problems for legitimate users. 

To implement the honeypot, simply add the following hidden span containing the empty field yourEmail in your form:
<code html>
                          <span style="display:none;visibility:hidden;">
			     <label for="yourEmail">
			     Ignore this text box. It is used to detect spaambots.
			     If you enter anything into this text box, your submission
			     will be rejected.
			     </label>
			     <input type="text" name="yourEmail" size="1" value="" />
			  </span>
</code>

=== Setting Up the Country Code Select Box===

Channelsuite uses a normalized list of standard country codes. Using these same codes in the Recruit form allow us to easily convert recruit applications to Partner records after they've been processed and approved. The list of country codes used in your channelSUITE install can be found by running the "country list" API as described in [[api_helper_functions]]. Just copy and paste this list of html <option> tags (or a subset if you don't recruit globally) into the countryCode <select> container.

===Setting up the State/Province Code Select Box=== 

If you recruit in countries such as US and Canada where states or provinces are commonly used, you'll want to use the channelSUITE list of normalized stateProvinceCode values for that country. But this is even trickier than the countryCode select box, since the list of states/provinces is country-specific. The good news is, all the steps necessary to make this work have already been covered above:
  - load the stateProvinceMap and stateWidget javascript files
  - set the "onchange" on the countryCode field
  - provide a <span> or table cell with id="statecell" for the javascript to insert the state/province select box. 

Now your form will dynamically provide the correct state/province field options for the chosen country, based on the list of supported countries in your copy of the channelSUITE database.

====Testing Your Form====

set the hidden field saveRecord value=0 and submit. you should see the correct form values echoed back. make sure to check that the state/province field options look right for countries that use standard states or provinces (by default we support US, Canada, and Mexico, but you may request others). when you're ready to go live, change saveRecord to value=1.
RCDchannel Support Wiki

User Tools

Site Tools

Page Tools
