SugarCRM SupportProduct GuidesSugar MarketSugar Market CRM Integration GuideSugarCRM
Sugar Market was formerly known as Salesfusion.

SugarCRM

Overview

This guide describes how to integrate Sugar Market with SugarCRM, including configuring, syncing, and using data mappings. Please review Integration Overview: All CRM Types before proceeding with this page.

Topics

This guide includes the following topics:

For the current list of SugarCRM versions that Sugar Market supports, refer to the Sugar Market Supported Platforms page. 

How Sugar Market Entities Integrate with SugarCRM

This section explains how the following Sugar Market entities will integrate with your SugarCRM instance:

Please refer to the Configuring the SugarCRM Connector section for more information on configuring the settings for these integrations.

Emails

When Sugar Market has captured the delivery status of an email recipient, the respective record in SugarCRM will be updated according to the push settings in the connector configuration. The two email push options are to create an Email Activity record or a Task record in SugarCRM.

Push Sent Email to SugarCRM Email Record

This option contains the Opens and Clicks count and displays from whom the email was sent and the name of the campaign. This is a good option if you do not want to clutter up the Task section.

1

Push Sent Email to SugarCRM Task Record

This option does not include Opens and Clicks counts but is a good option if your Sales team is active in the Activity History.

2

Landing Pages

When Sugar Market has captured a landing page completion, a landing page completion is added to the respective record in SugarCRM's Landing Pages custom entity. The landing page name and completed date for each landing page completion are displayed here.

3

Click the Preview icon next to the landing page to view additional detail on the landing page completion.

4

Web Activity

When Sugar Market has captured cookied web activity for a lead or contact, the respective record in SugarCRM will be updated according to the push settings in the connector configuration. The web activity push options are to create a Web Activity record or a Task record in SugarCRM.

Push Web Activity to SugarCRM Web Activity Record

This option, which is labeled "Push Web Activity to Custom Tables", allows you to see more information easily by compartmentalizing this data within the Web Activity table. Pushing the activity to the custom web activity entity in SugarCRM will also keep your Activity History from getting cluttered with lots of web activity.

5

Click the preview icon next to the activity to view additional detail.
6

Push Web Activity to SugarCRM Task Record

This option, which is labeled "Push Web Activity to Activity History", is useful if your team is most active in the Task module. Click into any of these activities to display additional detail regarding the web activity.

7

Tasks

When a Task record is created in Sugar Market, you can push those as Open Activities to the corresponding SugarCRM record. This setting is labeled "Allow Sugar Market to Create Tasks".

8

Events

After a Sugar Market Event has occurred, all registered and attended contact and lead records are updated in SugarCRM with the event information inserted into the custom Event Management entity. This displays events for which the record registered and attended. This setting is labeled "Allow Sugar Market to Push Event Data". 

9

Clicking the preview icon displays additional information about the event.

10

Target Lists

Sugar Market can sync down members of SugarCRM campaigns into a distribution list, which can then be used as an include or exclude list in Sugar Market campaigns. This setting is labeled "Pull Target Lists to Distribution Lists".

11

Notes regarding syncing SugarCRM campaign lists:

  • If the records do not already exist in the database (in the Contact table), Sugar Market will not sync them into the Sugar Market distribution list.
  • Sugar Market distribution lists do not contain duplicate emails.
  • Sugar Market distribution lists do not contain blank or invalid emails.

About the Buyer's Journey Integration

The Buyer's Journey integration allows you to view the entire lifecycle of a prospect's marketing activity. As part of the Sugar Market installation, your Sales team has access to the invaluable marketing journey, which is located in your contact and lead records directly in SugarCRM. Simply click the Sugar Market button in a Contact or Lead record in SugarCRM to display a drawer that contains the Buyer's Journey integration.

 SM IG sugarbuyersjourney

Please refer to the Sugar Market User Guide for more information about the Buyer's Journey Integration in Sugar Market.

Installing Sugar Market

There are three steps to the Sugar Market installation:

If you are upgrading from a previous version of Sugar Market, please uninstall the old version before performing the installation.

Installing the Sugar Market Module

  1. Download the correct Sugar Market module installation file from the Installation Files section of this guide.
  2. Log into SugarCRM and upload the Sugar Market module. Please refer to the SugarCRM Module Loader documentation for information on uploading modules.

Configuring the Sugar Market Module in SugarCRM

After installing Sugar Market, configure the Sugar Market connector in SugarCRM. Please refer to the SugarCRM Connector documentation for more information on configuring connectors.

  1. In SugarCRMnavigate to the Administration page > System > Connectors.
    SM IG sugar connectors
  2. Click the Set Connector Properties button.
    SM IG sugar setconnect
  3. On the Sugar Market tab add the following information, and then click the Save button:
    • Organization Name: Add the Organization Name with a Unique ID generated on the Sugar Market Connector Settings page. Please refer to the Configuring the SugarCRM Connector section of this guide for more details.
    • Sugar Market Iframe URL: Copy and paste the following URL exactly (the bracketed text is not variable): https://iframe.salesfusion.com?orgId={orgId}&recordId={recordId}&crmType={crmType}&userId={userId}
      SM IG sugar connectset
  4. On the Connector Settings page, click the Enable Connectors button.
    SM IG sugar enableconnect
  5. On the Sugar Market tab, drag Accounts, Contacts, and Leads to the Enabled list, and then click the Save button.
    SugarCRM EnableConnectors

 

Running System Repairs

After installing Sugar Market, we recommend you run the following system repairs. Please refer to the Repair documentation in the SugarCRM Administration Guide for more information.

  1. In SugarCRM, navigate to the Administration page > System > Repair.
    SM IG sugar repair
  2. Click the Quick Repair and Rebuild link.
  3. After the repair is complete, click the Clear Additional Cache link.
    SM IG repairandclear

Upgrading the Sugar Market Module

If you are upgrading to the newest version of Sugar Market, you must first uninstall the sf_Salesfusion module by following these steps:

  1. Log in to Sugar CRM and navigate to the Administration page > Developer Tools > Module Loader.
  2. Click the Uninstall button next to the sf_SalesFusion module.
    SugarCRM Uninstall
  3. On the Ready to Uninstall page, select the "Do Not Remove Tables" option, and then click the Commit button. 
  4. Navigate to the Administration page > System > Repair.
  5. On the Repair page, click the Quick Repair and Rebuild link.
  6. Proceed to the steps in the Installing Sugar Market section.

Configuring the SugarCRM Connector

Your Sugar Market CRM Connector provides access to set up and modify your password access, sync preferences, and a timetable of the last completed sync with your CRM. To access the connector, log in to your Sugar Market account and navigate to User Menu > Administration View External Connectors > SugarCRM.
SM IG sugarcrm connector menu

Complete the following steps to configure the connector:

  1. Connect Sugar Market to SugarCRM
  2. Enter the Web Services and Organization Information
  3. Set up your sync preferences

Connecting Sugar Market to SugarCRM

Identify the Sugar username and password that Sugar Market will use to sync with your CRM. You may create a new user or a pre-existing user since SugarCRM allows for concurrent logins. It is important to note that all records created or updated by the sync will be attributed to the syncing user; therefore, the syncing user must have the necessary permissions to read and update all records you want to sync with Sugar Market.

  • Username: The Sugar CRM username that will authenticate via your web services.
  • Password: The password for the above user.

SM IG Sugar saveconnex

After entering the credentials as mentioned above, click the Save Connection button.

Web Services and Organization Information

Complete the SugarCRM connection information to tell Sugar Market how to connect to your instance of SugarCRM. 

  • Unique Organization Id: This is a Sugar Market-generated GUID, unique to your organization, which is used in calls to Sugar Market from your CRM.
  • Web Service URL: The URL for your SugarCRM's web service endpoint http://sugar.domain.tld/rest/v10/.
  • Default User for New Leads: The user assigned as the default (catchall) owner of a new lead when it is pushed up to SugarCRM and the user does not already exist in SugarCRM (the user only exists in Sugar Market). When the user does not already exist in SugarCRM, Sugar Market assigns the defined user in this setting as the lead record owner. The user name only populates this list after the initial sync is complete.
  • Authenticate via LDAP: Allows Sugar Market to negotiate with SugarCRM systems that authenticate against LDAP.
  • Sync Dates: No Action Needed - this table will show you the last time Sugar Market has synced with your CRM. These will be updated once we have completed the initial integration.

SM IG Sugar webservice

After entering the SugarCRM connection information, click the Save Profile button.

Setting Up Sync Preferences

Set up your syncing preferences. This includes what information you want Sugar Market to sync down and what information you want Sugar Market to update and create, among other preferences. See the full explanation of each item below.
SM IG sugar pull

Pull Data (Sync from CRM)

Pull Accounts

Whether or not Sugar Market should sync down Accounts from Sugar CRM.

Pull Contacts

Whether or not Sugar Market should sync down Contacts from Sugar CRM.

Pull Leads

Whether or not Sugar Market should sync down Leads from Sugar CRM.

Pull Opportunities

Whether or not Sugar Market should sync down Opportunities from Sugar CRM.

Pull Target Lists to Distribution Lists

Whether or not Sugar Market should sync down Target Lists from Sugar CRM. Target Lists that were created via the sync will not be pulled into distribution lists in Sugar Market since this results in many duplicates.

Pull Picklist Values

Whether or not Sugar Market will sync down the picklist values from Sugar, and keep those lists updated as values are added or removed. This will allow these picklists to be used in landing page questions or selected in a dropdown on the contact card. Note: Sugar Market picklists are not restrictive, so values outside of the picklist values will still be allowed.

Push Data (Sync to CRM)

Allow Updates to Lead and Contact Records

Allow Sugar Market to push updated values to Lead and Contact records in SugarCRM

Allow the creation of New Leads

Allow Sugar Market to create new Leads in SugarCRM.

Allow the creation of New Contacts

Allow Sugar Market to create new Contacts in SugarCRM. Associated accounts will also be created and updated.

Allow updating of mapped Score fields

Allow Sugar Market to push Scoring values to SugarCRM, as mapped by Scoring Profiles

Allow Updating of Unsubscribe Status

Allow Sugar Market to update the Unsubscribe status of Lead and Contact records in SugarCRM

Allow the creation of New Opportunities

Allow Sugar Market to create new Opportunity records in SugarCRM, as directed by Scoring Profiles

Push Sent Email

Choose where, if at all, Sugar Market should push Sent Email records. The options are:

  • Disabled: Do not push Sent Email records.
  • To Completed Task: Sent Emails will be pushed to SugarCRM as a completed Activity record, with references to the corresponding Lead/Contact.
  • To Email Module: Sent Emails will be pushed to the native Email Module, with references to the corresponding Lead/Contact.

Push Unique Email Opens

Choose where, if at all, Sugar Market should push Email Open records. The available options are filtered based on the selection made in the Push Sent Email setting:

  • Disabled: Do not push Opened Email records.
  • To Completed Task: Opened Emails will be pushed to CRM as a completed Activity record, with references to the corresponding Lead/Contact.
  • To Email Module: Opened Emails will be pushed to the native Email Module, with references to the corresponding Lead/Contact.

Push Unique Email Clicks

Choose where, if at all, Sugar Market should push Email Click records. The available options are filtered based on the selection made in the Push Sent Email setting:

  • Disabled: Do not push Clicked Email records.
  • To Completed Task: Clicked Emails will be pushed to CRM as a completed Activity record, with references to the corresponding Lead/Contact.
  • To Email Module: Clicked Emails will be pushed to the native Email Module, with references to the corresponding Lead/Contact.

Push Web Activity

Choose where, if at all, Sugar Market should push Web Activity records. The options are:

  • Disabled: Do not push Web Activity records.
  • Activity History: Web Activities will be pushed to SugarCRM as a completed Activity record, with references to the corresponding Account/Lead/Contact.
  • Sugar Market Custom Tables: Web Activities will be pushed to the Sugar Market-specific Web Activity entity, with references to the corresponding Lead/Contact.

Allow Sugar Market to create Tasks

Allow Sugar Market to create Activity records in SugarCRM from Tasks created in Sugar Market. Tasks must have an assigned user.

Allow Sugar Market to update the Delivery Status and Delivery Message

Direct Sugar Market to push the Delivery Status Message to a specific Lead/Contact field in SugarCRM. A custom field will need to be created on the Lead/Contact table in SugarCRM.

Map Delivery Message (reason) to

When "Allow Sugar Market to update the Delivery Status and Delivery Message" is enabled, select the field from the dropdown list to which the message should be mapped in SugarCRM.

Push Sugar Market Last Activity

Allows Sugar Market to push the Sugar Market Last Activity date of a record to a custom field in SugarCRM. This field shows the record's last interaction date.

Push Campaigns and Email Statistics to Campaign and Campaign Targets

Maintain Campaign statistics to the Campaign Log in SugarCRM.

Allow Sugar Market to push Dialog completion data

Direct Sugar Market to track Landing Page completions in the Sugar Market-specific Dialogs entity, with references to the corresponding Lead/Contact.

Allow Sugar Market to push Event data

Direct Sugar Market to track Event statistics in the Sugar Market-specific Events entity, with references to the corresponding Lead/Contact.

Recycle Bin: Reconcile deleted Contact and Lead records from your CRM

This feature records the deletion of Lead and Contact records in SugarCRM and deletes the same records from Sugar Market. This feature is helpful for compliance with data privacy regulations such as GDPR since the process eliminates the need to separately delete a lead/contact from Sugar Market when it is deleted in SugarCRM. 

Recycle Bin: Keep records but disconnect them from CRM

This option keeps the deleted Leads and Contact records in Sugar Market but disassociates them from their previous parent record in SugarCRM

Post-sync cleanup reports

These optional reports can be configured to run at the completion of every Data sync cycle, to identify and remove (from Sugar Market) Lead and Contact records that meet certain criteria.

SugarCRM Mappings

This section describes how the fields from your SugarCRM instance map to Sugar Market's internal CRM. This is important for knowing what fields to map to in a landing page and in identifying how data flows between Sugar Market and SugarCRM.

Data Mapping for Accounts
SugarCRM Sugar Market
-- AccountID (primary key)
Sugar's Account ID (primary key) ID
Name AccountName
Assigned_user_id (foreign key) OwnerID (foreign key)
billing_address_street BillingStreet
billing_address_city BillingCity
billing_address_state BillingState
billing_address_postalcode BillingZip
billing_address_country BillingCountry
shipping_address_street ShippingStreet
shipping_address_city ShippingCity
shipping_address_state ShippingState
shipping_address_postalcode ShippingZip
shipping_address_country ShippingCountry
phone_office Phone
phone_fax Fax
industry Industry
description Description
rating Rating
ownership Ownership
account_type Type
sic_code SIC
ticker_symbol Ticker
website URL
employees Employees
Data Mapping for Contacts and Leads
SugarCRM Sugar Market
-- ContactID (primary key)
Sugar's Contact ID (primary key) ID
Account_id (foreign key) AccountID (foreign key)
Assigned_user_id (foreign key) OwnerID (foreign key)
-- CRMType (Differentiates between Contact and Lead)
-- CreatedDate
-- LastUpdate
Date_entered ExternalCRMCreatedDate
Date_modified ExternalCRMUpdatedDate
First_name FirstName
Last_name LastName
Email1 Email
Email_opt_out OpOut
(Does not map) Source
Title Title
Phone_work PhoneNumber
Phone_mobile MobilePhone
Primary_address_street MailingStreet
Primary_address_street2 MailingStreet2
Primary_address_city MailingCity
Primary_address_state MailingState
Primary_address_postalcode MailingZip
Primary_address_country MailingCountry

Note: Sugar Market only has a Contact table that we use to pull down Sugar's Contact and Lead table into. We differentiate Contacts and Leads by the Sugar Market's CRMType field.

Data Mapping for Opportunities
SugarCRM Sugar Market
-- OpportunityID (primary key)
Sugar's Opportunity ID (primary key) ID
Account_id (foreign key) AccountID (foreign key)
Assigned_user_id (foreign key) OwnerID (foreign key)
Lead_source LeadSource
Description Description
Name OpportunityName
Sales_stage Stage
Date_Closed ClosingDate
Amount_usdollar Amount
Data Mapping for Users
SugarCRM Sugar Market
-- UserID (primary key)
Sugar's user ID (primary key) ID
Email1 Email
First_name First_name
Last_name Last_name
User_name Username
Full_name Name
Phone_work PhoneNumber
Phone_mobile Cell
Address_street Address1
Address_city City
Address_state State
Address_postalcode Zip
Address_country Country
Address_title JobTitle
Data Mapping for Activities

Push Only - Sugar Market's Task to SugarCRM's Activity

SugarCRM Sugar Market
-- TaskID (primary key)
Sugar's Activity ID (primary key) ID
Sugar's Contact ID (foreign key) ContactID (foreign key)
Date_Start DueDate
Date_due DueDate
Description Descriptiontext
Name Subject
Status Status
Priority Priority

Sugar Market Fields Sync to SugarCRM

The following table provides descriptions of Sugar Market fields that are pushed to SugarCRM. 

Module Field Description
Campaigns Bounced_c The number of bounced emails in the campaign
Delivered_c The number of delivered emails in the campaign
Forwards_c The number of emails forwarded in the campaign
Notreported_c The number of emails not clicked, not opened, or not delivered in the campaign
Peoplewhoclicked_c Not currently used
Peoplewhoopened_c Not currently used
Postdate_c The date that the campaign was sent, in yyyy-mm-dd format
Sent_c The number of emails sent in the campaign
Social_c Not currently used
Totalclicks_c The number of clicks in the campaign
Totalopens_c The number of opens in the campaign
Unopened_c The number of emails unopened in the campaign; calculated as the number delivered, minus the number opened
Unsubscribed_c The number of people who unsubscribed from emails in this campaign
Contacts Sf_lastactivity_default_c The datetime of the last activity in Sugar Market for this contact
Emails Salesfusionemail_c Identifies whether the specified email is from Sugar Market or not. All emails pushed from Sugar Market will have a value of 1.
Leads Sf_lastactivity_default_c The datetime of the last activity in Sugar Market for this lead
Prospects Clicked_c The number of clicks that the prospect has made for the most recent email sent to said prospect
Deliverymessage_c Delivery message for the most recent email sent to the prospect
Deliverystatus_c Delivery status for the most recent email sent to the prospect
Forms_c Not currently used
Friendforward_c Identifies whether the prospect has forwarded the most recent email through the "forward to a friend" button
Opened_c The number of times that the prospect has opened the most recent email sent to said prospect
Unsub_c Identifies whether the prospect has unsubscribed from the most recent email received

Installation Files

The following downloads are available for Sugar Market's Connector for SugarCRM:

SugarCRM Version1 Hosting Environment OS Database PHP Version Download Link
Sugar 9.0, 10.0, 10.1, 10.2, 10.3 (SugarCloud) Linux, Windows MySQL2 7.3 Connector for SugarCRM on MySQL V1.3.1
Sugar 9.0, 10.0, 10.1, 10.2, 10.3 Windows MSSQL2 7.3 Connector for SugarCRM on MSSQL V1.3.1

Please refer to the Sugar Market Supported Platforms page for the current list of SugarCRM versions that Sugar Market supports.

Sugar Market only connects to SugarCRM when the backend database is MSSQL or MySQL; other databases are not supported (e.g. Oracle, DB2).

Module Patch Notes

The following patch notes apply to the current releases of Sugar Market's Connector for SugarCRM:

MySQL Database

  • Sugar Market Module V1.3.1 for SugarCRM 8.0, 9.0, 9.1, 9.3, 10.0, 10.1
    • Increased iframe height from 420 px to 585px.
  • Sugar Market Module V1.3 for SugarCRM 8.0, 9.0, 9.1, 9.3, 10.0, 10.1
    • Updated the manifest file for PHP V7.3 compatibility.
    • Resolved warnings and notices reproduced in the log files.
  • Sugar Market Module V1.2 for SugarCRM 8.0, 9.0, 9.1, 9.3 - 10.0
    • Resolved issues to allow custom entities in the bundle to continue syncing web activity, landing page, and event activity with SugarCRM 10.0.
  • Sugar Market Module V1.1 for SugarCRM 8.0, 9.0, 9.1, 9.3 - Q4 2019
    • Updated favicon.ico to a .png that was preventing some installs from installing.
  • Sugar Market Module V1.0 for SugarCRM 8.0, 9.0, 9.1 - Q4 2019
    • Rebranded Module to reflect new Sugar Market branding.
    • Restarted versioning for bundles and to match versioning for Windows and Linux offerings.

Microsoft SQL Server (MSSQL) Database

  • Sugar Market Module V1.3.1 for SugarCRM 8.0, 9.0, 9.1, 9.3, 10.0, 10.1
    • Increased iframe height from 420 px to 585px.
  • Sugar Market Module V1.3 for SugarCRM 8.0, 9.0, 10.0
    • Updated the manifest file for PHP V7.3 compatibility.
    • Resolved warnings and notices reproduced in the log files.
  • Sugar Market Module V1.2 for SugarCRM 8.0, 9.0, 9.1, 9.3 - 10.0
    • Resolved issues to allow custom entities in the bundle to continue syncing web activity, landing page, and event activity with SugarCRM 10.0.
  • Sugar Market Module V1.1.1 for SugarCRM 8.0, 9.0 - Q1 2020
    • Resolved an issue that affected some customers unable to execute the Quick Repair & Rebuild feature after installing Sugar Market due to a mismatch query.
  • Sugar Market Module V1.1 for SugarCRM 8.0, 9.0 - Q4 2019
    • Updated favicon.ico to a .png that was preventing some installs from installing.
  • Sugar Market Module V1.0 for SugarCRM 8.0, 9.0 - Q4 2019
    • Rebranded Module to reflect new Sugar Market branding.
    • Restarted versioning for bundles and to match versioning for Windows and Linux offerings.

Last modified: 2021-04-09 14:43:40