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 table shown below.
  2. Log into SugarCRM and upload the Sugar Market module. Please refer to the SugarCRM Module Loader documentation for information on uploading modules.
SugarCRM Version1 Hosting Environment OS Database PHP Version Download Link
Sugar 10.0, 10.3, 11.0, 11.1.0 (SugarCloud) Linux, Windows MySQL2 7.3 Connector for SugarCRM on MySQL V1.3.3
Sugar 10.0, 10.3, 11.0 Windows MSSQL2 7.3 Connector for SugarCRM on MSSQL V1.3.3

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).

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 Sugar Market module by following these steps:

  1. Log in to SugarCRM and navigate to the Administration page > Developer Tools > Module Loader.
  2. Click the Uninstall button next to the Sugar Market 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

The SugarCRM Connector provides access to set up and modify your password access and sync preferences.

To access the connector:

  1. Log in to your Sugar Market account and navigate to User Menu > Administration View.
    SM IG sugarmenu
  2. In the External Connectors section, select SugarCRM > Settings.
    SM IG sugarcrm connector menu

Complete the following steps to configure the connector:

  1. Connect Sugar Market to SugarCRM.
  2. Inform your Implementation Consultant that your connection settings have been completed and verified. Your Implementation Consultant will then enable the initial sync of your data.
  3. Set up your sync preferences.
  4. Set up your sync filters (optional).

Connecting Sugar Market to SugarCRM

The first step in configuring your Sugar Market Connector is to let Sugar Market know how to connect to your instance of SugarCRM. These steps must be completed before you can set your sync preferences.

  1. Complete the following fields:
    • Unique Key: This is a Sugar Market-generated GUID, unique to your organization, which is used in calls to Sugar Market from your CRM.
    • SugarCRM Instance URL: The URL for your SugarCRM's web service endpoint http://sugar.domain.tld/rest/v10/.
    • CRM Username: Identify the Sugar CRM username 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. 
    • CRM Password: The password for the above user.
  2. After entering the SugarCRM connection information, click the Test Login button to validate the syncing user credentials. If the credentials are not valid, then you cannot save the connection information.
  3. Click the Save Connection Information button.

SM IG Sugar saveconnex

Setting Up Sync Preferences

Setting up your syncing preferences includes determining what information you want Sugar Market to sync down from SugarCRM and what information you want Sugar Market to update and create in SugarCRM, and corresponding settings as described in the sections below.

Click the section heading bars to expand or collapse sections on the page:
SM IG Sugar expand

Setting Your Sync Data

To identify the data you want to sync between Sugar Market and SugarCRM:

  1. In the "Default user for new records" field, select the name of the Sugar Market user to be 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. User names only populate this list after the initial sync is complete.
    SM IG sugar pull
  2. Select the desired settings for data to be pulled from SugarCRM.
    SM IG Sugar pulloptions
  3. Set the desired settings for data to be pushed from Sugar Market to SugarCRM, and then click the Save button at the bottom of the section.
    SM IG Sugar pushoptions

Pull Data (Sync from CRM)

Pull Target Lists to Distribution Lists

When selected, Sugar Market will sync down Target Lists from SugarCRM. 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

When selected, Sugar Market will sync down the picklist values from SugarCRM, 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.

Pull Leads

When selected, Sugar Market will sync down Lead records from SugarCRM.

Pull Contacts

When selected, Sugar Market will sync down Contact records from SugarCRM.

Pull Accounts

When selected, Sugar Market will sync down Account records from SugarCRM.

Pull Opportunities

When selected, Sugar Market will sync down Opportunity records from SugarCRM.

Push Data (Sync to CRM)

Push Sent Email

Where Sugar Market will 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 Email Opens

Where Sugar Market will push unique 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 Email Clicks

Where Sugar Market will push unique 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

Where Sugar Market will 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 the Creation of New . . .

When selected, Sugar Market will push the record type(s) as new records in SugarCRM. For Contact records,  associated Account records will also be created and updated.

Allow Updates to Lead and Contact Records

When selected, Sugar Market will push updated values to Lead and Contact records in SugarCRM.

Allow updating of Mapped Score Fields

When selected, Sugar Market will push Scoring values to SugarCRM, as mapped by Scoring Profiles.

Allow updating of Unsubscribe Status

When selected, Sugar Market will update the Unsubscribe status of Lead and Contact records in SugarCRM.

Allow Sugar Market to create Tasks

When selected, Sugar Market will create Activity records in SugarCRM from Tasks created in Sugar Market. Tasks must have an assigned user.

Allow Sugar Market to Push Email Statistics to Campaigns and Campaign Targets

When selected, Campaign statistics will be pushed from Sugar Market to SugarCRM's Campaign Log.

Allow Sugar Market to push Form completion data

When selected, Sugar Market will push form completions to SugarCRM, with references to the corresponding Lead/Contact record.

Allow Sugar Market to Push Event Data

When selected, Sugar Market will push Event statistics to SugarCRM, with references to the corresponding Lead/Contact record.

Allow Sugar Market to update the Delivery Status and Delivery Message

When selected, Sugar Market will push the Delivery Status Message to a custom Lead/Contact field in SugarCRM. 

Map Delivery Message (reason) to

When "Allow Sugar Market to update the Delivery Status and Delivery Message" is enabled, this field is where the message will be mapped in SugarCRM.

Push Sugar Market Last Activity

The custom field in SugarCRM where Sugar Market will push records' Last Activity date. 

Identifying Sync Time Settings

Records are synced between Sugar Market and SugarCRM according to the schedule identified on the Integration Overview page. If you do not want to sync your data between the hours of 9:00 PM and 6:00 AM Eastern time, then select the checkbox in the Sync Time Settings section, and then click the Save button.
SM IG Sugar3

Selecting Database Integrity Settings

We strongly suggest you work with your Client Services Representative to configure the settings in the Database Integrity section.
SM IG Sugar4

To select database integrity settings, select the desired options as described below, and then click the Save button at the bottom of the section.

  • 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. 
  • 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 Lead and Contact records from Sugar Market that meet certain criteria. Records will not be removed from SugarCRM. Available reports were built with the viewAccountContact view with a filter of CRMType = "Contact" or "Lead".

Setting CRM Sync Alert Contacts

To have automated sync alert emails sent to specific users, identify the email addresses in the Alerts section, and then click the Save button.
SM IG Sugar alerts

Setting Up Sync Filters

Sync Filters allow you to choose which records to sync from SugarCRM into Sugar Market based on fields that match specific criteria. Sync Filters define the records that sync from SugarCRM into Sugar Market; they do not define the records that sync from Sugar Market back to SugarCRM.

After setting up your sync preferences, complete the steps in this section to set up sync filters. If you do not set up any sync filters, then all records in core tables will sync from SugarCRM into Sugar Market. Since Sync Filters define the records that are syncing down from SugarCRM, it is important to consider these settings carefully and to test before using the filters.

Note: Sync filters are at the record level, not at the field level.

To set up sync filters:

  1. Confirm you have allowlisted the IP addresses identified in the Integration Overview. These are required for sync filters to be enabled.
  2. Navigate to the Sync Filtering tab of the SugarCRM Settings page.
  3. From the Sugar Sell Module dropdown, select the module in which you want to select fields to sync to Sugar Market, and then click the Build Filter button.
    SM CRM sugar buildfilter
  4. In the Sync Filtering popup dialog, click the pencil icon to set specific conditions.
    SM CRM sugar syncfilter
  5. To identify the field to be synced from SugarCRM, select a field from the Field list by scrolling or using type ahead. Do not set up sync filters for non-database fields.
  6. Set the conditions for the selected field by selecting an operator and identifying the value to match (e.g. Billing State Equals TX).
  7. To set additional conditions to be combined with or evaluated against the condition you just set, click the AND or OR button based on the type of logic desired (e.g. Billing State Equals TX and Industry Equals Banking). Repeat this step as many times as desired.
    SM CRM sugar syncfilter2
  8. To create a separate field grouping within the selected SugarCRM module, click the AND or OR button at the bottom of the dialog, and then repeat the steps outlined above.
    SM CRM sugar syncfilter3
  9. Click the Save button when all filter conditions for the selected module are complete.
  10. To set filter conditions for fields in other SugarCRM modules, repeat from Step 2 with the desired module.

Testing Sync Filters

After all filter conditions are set as desired, you can perform a test to help you determine if your filters are set as expected. The test returns a preview of up to twenty records that will be synced over from SugarCRM with the filters as currently defined.

Note: While testing sync filters is not a required step, it is strongly recommended to ensure the expected results are returned. 

To test sync filters:

  1. Click the Run Test Sync button on the Sync Filtering tab.
    SM CRM sugar testsync
  2. Results display with default fields. Click the field labels to remove fields from the displayed results, or use type ahead to locate and add additional fields.
    SM CRM sugar testsync2
  3. Use the Search field to locate specific records. Partial keywords will return results for string fields, but full keywords need to be used to locate records for multi-select and checkbox fields.
  4. If the results are not as desired, then return to the sync filters settings to review your conditions.

Viewing Sync Results

After the sync between Sugar Market and SugarCRM has started, use the Sync Dashboard to view results. Please refer to the Sugar Market User Guide for more information on using the Sync Dashboard. 

Last modified: 2021-07-27 14:49:46