Duplicate Lead Detective – Installation & Set Up Guide

Product Overview

This product will enable a Lead-based dashlet in Sugar that detects duplicate records from the Leads module by determining whether key data exists elsewhere within the system.

Installation Guide

Prerequisites

This product must be purchased via Sugashop. Check first that the product is compatible with your version of Sugar by looking up the Supported Versions information. To find out what your Sugar version is, navigate in your Sugar instance to the ‘About’ page in the top right-hand corner.
You need to have full Sugar System Administration access to complete the setup of this product in Sugar.

Product Download

• After purchase, download the .zip file of the installable custom package. The file can be found either
  • after purchase on the Sugashop Order Received page.
  • via the Confirmation Email sent to the Sugashop accounts’ email address.
  • via ‘My Account’ in the Sugashops’ Downloads page.
• There may be more than one downloadable .zip file as we support different Sugar versions. When downloading, select the file that is compatible with your Sugar version.
• Ensure the file has not been unzipped by your browser whilst downloading.

Product Installation

Prior to package installation, it is best practice to ensure that you have a fresh backup of your Sugar instance. Although this is not required, it is recommended whenever installing new extensions to your application.

Caution: As with any package installation, this will cause a system refresh and data being processed may be interrupted. We recommend you complete the installation at a time with low system usage.

If you are installing an updated version of your existing Sugashop product, ensure that any previously installed version of the package is uninstalled before installing an updated version in your Sugar instance. Please see the Uninstallation Guide for more information.

Steps:

1. Log into your Sugar instance as a System Administration user.
2. Navigate to the “Admin” page and access Module Loader.
3. Upload the installable .zip file by clicking on ‘Choose file’. Once the file has been selected, click on the ‘Upload’ button.
4. Once the file is uploaded, click the ‘Install’ button.
5. Select Commit to start the installation.
   Note: This may take a few minutes.
6. Sugar will redirect you to Module Loader after installation where you should now see your uploaded product in the list of installed packages.
   Note: Be patient and wait for all “Loading” messages to disappear.
7. Now the package is installed, it is best practice to perform a Quick Repair & Rebuild. Navigate to Admin > Repair, then select “Quick Repair & Rebuild”.
   Note: The Quick Repair & Rebuild process may take a few minutes.

If during the Installation of the Sugashop product you experience any unexpected behaviour, run the Rebuild JS Grouping Files and Clear Additional Cache.

Steps to Rebuild JS Grouping Files:

1. Navigate to the “Admin” page and access Repair.
2. Select Rebuild JS Grouping Files.

Steps to Clear Additional Cache:

1. Navigate to the “Admin” page and access Repair.
2. Select Clear Additional Cache.

Sugashop License Validation

Navigate to: Admin > Sugashop™ by Sugabyte – License Management > Select “Manage Licenses”.

Enter the License Key provided to you on purchase of the package. You can retrieve your license key from:

• the Order Received page when processing an order from Sugashop.
• via the Confirmation Email sent to the Sugashop accounts’ email address.
• via ‘My Account’ in the Sugashops’ License keys page. 

Enter your license key into the App License Key field then click on the Verify License button.

Duplicate Lead Detective Settings

Module Selection

A System Administration user can choose which modules to include in the Lead duplicate checks. The Sugar stock modules to choose from and selected by default are:

• Accounts
• Contacts
• Leads

In Sugar, navigate to: Admin > Sugashop™ by Sugabyte – Duplicate Lead Detective for SugarCRM > Duplicate Lead Detective Settings.

To remove a module, simply click the ‘x’ in the module name tag. Disabled modules will not be displayed in the Duplicate Lead Detective dashlet.

To enable a module, click into the field and choose a module from the dropdown list. 

Field Selection

Choose which fields should be enabled for duplicate checks and their importance on determining a duplication.

The following Sugar stock fields can be included in duplicate checks against your Lead record:

• Accounts: Account Name, Phone, Email
• Contacts: Contact Name, Phone, Email
• Leads: Contact Name, Account Name, Phone, Email

The ‘Contact Name‘ will cross-check the combination of Sugars’ stock First and Last Name.

The ‘Phone‘ will cross-check Sugars’ stock Phone-type fields.

The ‘Email‘ will cross-check Sugars’ stock Primary Email Address fields.

Note: The module and field labels above may differ in your system if these were modified.

Select the level of importance for each field on determining a duplication:

• Warning: Critical duplication identified.
• Caution: Less severe or coincidental duplication identified.
• Do Not Use: Excluded from duplicate checks.

By default, the Email will be marked as ‘Warning’, the remaining fields are marked as ‘Caution’. These will be displayed in the dashlet with a coloured label.

Uninstallation Guide

You may need to uninstall the existing version of your Sugashop product due to there being an updated package release or because your subscription has ended.

In the event that the package needs to be uninstalled from your Sugar instance(s), please follow the below listed steps.

Caution: As with any package uninstallation, this will cause a system refresh and data being processed may be interrupted. We recommend you complete the uninstall at a time with low system usage.

Uninstallation Steps

• Log into your Sugar instance as a System Administration user.
• Navigate to the “Admin” page and access Module Loader.
• Locate the installed extension by searching for the product name.
• Once you have located the extension, click the ‘Uninstall’ button.
• Select Commit to start the uninstallation.
  Note: This may take a few minutes.
• Sugar will confirm the successful uninstall. Click the “Back to Module Loader” button.
  Note: Be patient and wait for all “Loading” messages to disappear.
• Now the package is uninstalled, it is best practice to perform a Quick Repair & Rebuild.
  • Navigate to Admin > Repair, then select “Quick Repair & Rebuild”.
    Note: The Quick Repair & Rebuild process may take a few minutes.

This concludes the installation, set-up and uninstallation guide. For the end-user guide, please follow: