Integrating with SugarCRM

To integrate Spectrum Technology Platform with SugarCRM, you must install the supporting databases and dataflows on the Spectrum Technology Platform server, and deploy Spectrum on your SugarCRM. Once you do this, users of SugarCRM will have access to address validation, geocoding, and duplicate detection functionality from within SugarCRM.

Before you begin:

Entities Supported:

You can validate and geocode the addresses of the entities:
  • Accounts
  • Contacts
  • Leads

Supported SugarCRM Versions

SugarCRM 7.7.1.1

Browse to the the folder Sugar CRM DQ Objects\sugarcrm in the Spectrum Technology Platform installation package and copy the file PreciselySugarCRMConnector.zip to any location on your SugarCRM server.

  1. If you are using Spectrum Technology Platform for address validation or geocoding, install the databases required to perform address validation and geocoding and define database resources for each database.
    Note: If you are using Spectrum Technology Platform for duplicate detection only, you can skip this step.

    You must give the database resources these names:

    Database Required Name for Database Resource
    Enterprise Geocoding - Canada Database IGEO_CAN
    Enterprise Geocoding - U.S. Database EGM_US
    Universal Addressing - Canada Database Canada
    Universal Addressing - Loqate Database Loqate
    Universal Addressing - U.S. Database UAM_US
    Note: You must install the Delivery Point Validation (DPV) data and the Residential Delivery Indicator (RDI) data in order to perform DPV and RDI processing on U.S. addresses.
  2. Import the SugarCRM module dataflows into your Spectrum Technology Platform server.
    1. On the Spectrum Technology Platform server, open this folder:
      SpectrumDirectory\server\modules\sugarcrm
      Note: This folder is only available if you have installed the SugarCRM module.
    2. As mentioned in the table below, copy the applicable dataflow files to the import folder:

      SpectrumDirectory\server\import

      If you have installed this set of modules Copy these dataflow files to the import folder
      Advanced Matching

      GenerateMatchKey.df
      GenerateMatchScore.df
      GenerateSearchKey.Consonant.df
      GenerateSearchKey.df
      GenerateSearchKey.Metaphone.df
      GenerateSearchKey.Substring.df

      Universal Addressing without Loqate

      ValidateAddresswithCandidates_UAM.df

      Universal Addressing without Loqate
      Enterprise Geocoding

      ValidateAddressWithCandidates_UAM_EGM.df

      Universal Addressing with Loqate

      ValidateAddressWithCandidates_UAM_Loqate.df

      Universal Addressing with Loqate
      Enterprise Geocoding

      SugarCRMValidateAddressAndGenerateMatchKey.df

      ValidateAddressWithCandidates_UAM_Loqate_EGM.df

      Universal Addressing, Loqate only

      ValidateAddressWithCandidates_Loqate.df

      Universal Addressing, Loqate only
      Enterprise Geocoding

      ValidateAddressWithCandidates_Loqate_EGM.df

      Enterprise Geocoding

      GeocodeUSAddressWithCandidates.df
  3. Import the Precisely SugarCRM module into your SugarCRM system.
    1. Log in to SugarCRM as an administrator.
    2. In the profile drop-down menu at the top right corner, click Admin.
    3. In this Administration screen, in the Developer Tools section, click Module Loader.
      The Module Loader screen opens.
    4. If you are integrating your SugarCRM system with Spectrum Technology Platform for the first time, you must upload the SugarCRM Connector of your SugarCRM system:
      1. Upload the ZIP file PreciselySugarCRMConnector.zip of Spectrum copied earlier to the system, using the file uploader field in the centre of the page.
      2. Click Upload.
      3. Click Confirm. An entry for the Precisely package now shows in the bottom grid.
    5. Once the Precisely package is uploaded into the system, or if it has been uploaded previously into your SugarCRM system but is uninstalled:
      1. Click Install against the Precisely package entry in the bottom grid on the Module Loader screen.
      2. On the License screen, select Accept, then click Commit.
    6. In the profile drop-down menu at the top right corner, click Admin.
    7. In this Administration screen, in the System section, click Repair.
      The Repair screen opens.
    8. Click Quick Repair and Build.
      The existing SugarCRM configurations are rebuilt to incorporate the custom Objects and Object Layouts imported with the SugarCRM Connector. The logs are displayed.
Spectrum's SugarCRM Connector is now successfully integrated with your SugarCRM system.

The menu item Administration > Precisely Service Configuration is now available.