The Radius Search module allows you to search your SugarCRM Contacts by supplying a starting City/State location and a radius value in miles. This tutorial will show you how to install the module and perform the initial setup on SugarCRM 6.0.

Section 1: Install the module

1.1 - Download and install the module using module loader.

Section 2: Obtain a Yahoo App ID

2.1 - Go to the new Geo Search admin panel
After installation, go to the main Admin Panel and scroll to the bottom. You will see a new panel. Select “Geo Search Settings”.

2.2 - This module uses a Yahoo API and requires a Yahoo login and a Yahoo App ID (both are free). If you do not already have one, click on the link in the Geo Search Panel to get one.

2.3 - Register for the App ID
Fill in the required fields and hit Continue. Your App ID will be display on the next page. For “Authentication method”, select “Generic”. Below is an example. Please fill in using your information.

2.4 - Enter ID in Sugar
Enter your Yahoo App ID in the Geo Search admin panel and save it.

2.5 - Update existing Contacts
For the feature to work, we need to update all current Contacts with their location information based on their primary city and state. The information is stored in new custom fields that were created during the installation process. Any new Contacts or changes to existing Contacts will be updated when the record is saved. Below is an example after updating.

Section 3: Add Radius Field to Search

Using Studio, we need to add the newly created (during install) radius field to the Search Layout for Contacts.

  * From the main Admin panel go to “Developer Tools” -> “Studio”
  * Select “Contacts” from the either the tree view or the icon in the middle panel.
  * Go to the “Layouts” editor
  * Select “Search”
  * You can add the field to either Basic or Advanced Search
  * From the “Hidden” list, locate “Radius” and drag to the “Default” list.
  * Hit “Save & Deploy”

Section 4: Usage

To perform a Radius Search, you will need to enter a starting City/State and the desired radius in the field you just added to the Search Panel. You can use the default City/State fields that come standard with Sugar and are used to search the Primary and Alternate addresses, or if you modified the Search Panel, the Primary City and State fields.

Purchase the Mobile Address module