SugarChimp User Guide

This guide will walk you through all of the steps needed to get SugarChimp installed into Sugar and setup to sync with MailChimp. Please read this guide carefully, and as always, we're here to help. Let us know if you have any questions along the way.

To Update SugarChimp

If you already have SugarChimp installed but you want to update it, please follow the following steps. If you are starting from scratch, please skip these steps.

1. Download the latest package from your orders page
2. Upload and install the new package using Module Loader. Do NOT uninstall the current version of SugarChimp.
3. All of your previous settings will be maintained, and you can continue to use SugarChimp normally.

Let's get started!

After starting your trial, follow these steps to get SugarChimp up and running:

NOTE: If you are hosting your own Sugar instance, please make sure you are running PHP 5.3 or higher. Also, please make sure that PHP Notices are turned off in your php.ini (error_reporting = E_ALL & ~E_NOTICE)

Installing SugarChimp

1. Go to your SugarCRM and login as an admin user.
2. Go to "Admin" > "Module Loader"
3. Upload the zip package
4. Click install, agree to the terms and continue. It will take a couple minutes to install.
5. You should now be redirected to SugarChimp’s Welcome Screen.

NOTE: If the installation stops at 80% and you are using Sugar 7.*, go to Sugar > Admin > Search and click "Schedule System Index". When the system index finishes, go back to Sugar > Admin > Module Loader and install SugarChimp again. If it does not install properly, please let us know and we will help.

 

NOTE: If you are not redirected, you can get here by going to Admin > SugarChimp Configuration (Towards the bottom of the page)

Step 1: Pre-Checks

When you’re ready to get started, SugarChimp will begin by checking your system for compatibility. There are four essentials that SugarChimp checks to ensure proper functionality. They are:

• You are running PHP 5.3 or greater
• cURL is enabled
• MailChimp can communicate with your Sugar instance
• Your Sugar Scheduler is active and running

SugarChimp will give you instructions based on your results. Most people will see Box 1, and continue to Step 2. Here are the descriptions of what all you might see:

Box 1: Everything is Working!	Box 2: One or more Requirements are not met!	Box 3: Recheck Failed!
Next: Press to go to Step 2!	Follow the Onscreen Guides and Links to help fix the errors. After the errors have been addressed, try the ‘ReCheck’ button to see if everything is functioning properly.	Recheck: You can check your system as many times as you need! Support: Email <[e-mail]> if you are unable to get your system working. Next: If you choose to continue, SugarChimp will not work as intended. It is always recommended to come back and ensure SugarChimp is completely compatible before using the integration.

Step 2: SugarChimp License Key Validation

On Step 2, you will validate your SugarChimp License through SugarOutfitters. You will see step by step instructions on screen for how to validate your license. If you attempt to Validate an inappropriate key, SugarChimp will alert you that the Validation was unsuccessful.

Once the License Key is successfully validated, you can continue to Step 3!

Step 3: MailChimp API Key

On Step 3, you will install your MailChimp Account’s API key. Copy and paste it into the box and hit Validate.

	If you have not yet created your MailChimp Account Click on the ‘Create one now.’ link. Follow these instructions to start your free MailChimp Account
	If you do not know how to find your API Key Click on the ‘Where can I find my API key?’ link Follow those instructions to copy your API key, and paste it in the box Once the API Key is successfully installed, you can continue to Step 4 to Sync your first List!

Once the API Key is successfully installed, you can continue to Step 4 to Sync your first List!

NOTE: SugarChimp can only install 1 MailChimp Account at a time. (You can change accounts at any time)

Step 4: Sync a List

4-1. Select a Sugar Target List

Here you will select a Target List in Sugar for your MailChimp subscribers. Based on how you are currently using Sugar and MailChimp, you have some options:

If you have Target Lists in Sugar
	Option 1: Start with a List you’ve already created Select your list from the dropdown box Advance to step2 of the syncing process
	Option 2: Start with a Blank List Select “Create New Sugar List” from the dropdown box Name the new list Choose ‘Create’ to create the new Target List in Sugar Advance to step2 of the syncing process

If you had no Target Lists in Sugar
	SugarChimp automatically creates a Target List for you called “Master SugarChimp List” Then, it selects this list and advances to step2 of the syncing process!

4-2. Select a MailChimp List

Here you will select the List that will hold your subscribers in MailChimp. Based on how you are currently using Sugar and MailChimp, you have some options:

If you have MailChimp Lists

Option 1: Start with a List you’ve already created

1. Select your list from the dropdown box

2. If your List has subscribers on it already, you will need to choose rather or not to bring them into Sugar using this Check box.

NOTE: This will not create duplicates in Sugar. All matching Contacts, Targets, and Leads will be brought onto the Target List.

Option 2: Start with a Blank List

1. Select “Create New MailChimp List” from the dropdown box
2. Name the new list
3. Choose ‘Create’ to create the new list in MailChimp

If you had no lists in MailChimp
	SugarChimp automatically creates a list for you in MailChimp called “Master SugarChimp List” Then, it selects this list from the dropdown menu

Once you see green arrows between your Sugar Target List and your MailChimp List, you can continue to step 3 to choose who you want on this list!

4-3.Choose Who to Sync from Sugar

This step is all about saving you time and effort by allowing SugarChimp to automate your list management. By keeping your Target List up to date for you, you will never have to worry about having the correct people in MailChimp. Your available options for this step depend on your current SugarChimp Plan. Here is how the breakdown looks by plan:

You can choose to send whoever you want from Sugar to MailChimp from your Contacts, Targets, and Leads. Some companies send all of their Sugar Contacts, Targets, and Leads to MailChimp. Others may send all of their Leads, a select group of Contacts, but no Targets. Each module is handled individually by SugarChimp. Select the options that best fit your needs for each Module: Contacts, Targets, and Leads.

NOTE: Options shown using Contacts, but you can set up how to manage Targets and Leads as well

Sync Manually

Features:
SugarChimp will not add Contacts to the Target List automatically Allows you to add and remove from the target list manually, or by some other workflow Only option available to the Basic Plan

Sync All Automatically

Features:
SugarChimp will add all Contacts to the Target List automatically Includes any Contacts that are created in the future Available to the Pro and Ultimate Plans

Sync using Custom Filters Custom

Filters is a very useful option for automation. For example, whenever a new lead comes into the system have them automatically added to your marketing lists based on simple or complex rules.

Features:	Buttons
Create detailed filters for exactly who should be on your list Constantly checks your Contacts against the filters to see if anyone needs to be added or removed from your list Available to the Ultimate Plan Only		Test Filters: Runs the current filters to see how many Contacts would be added to the list.
		Add Filter: Adds a new empty filter
		Remove Filter: Removes the filter that corresponds to the button
		Join Type: Set whether ALL filters must match (AND) or just one filter must match (OR)

To Create Filters:

1. Choose a field to filter on from the dropdown menu
2. Based on the field, choose an operand for the filter
3. Set the value(s) that must be met for a Contact to get on the list
4. If more filters are needed, press the Add Filter button
5. Repeat steps 1-4 as many times as necessary

Sync using Custom SQL

Features:
For Advanced Users Only! Constantly checks your Contacts against the sql to see if anyone needs to be added or removed from your list Create custom SQL based on our Custom SQL Guide Available to the Ultimate Plan Only

4-4. Choose how to handle new subscribers from MailChimp

As you successfully use MailChimp, new subscribers will be added to your Lists either manually, by importing, or through a webform. When this happens, SugarChimp will create this person inside of Sugar for you (unless they already exist). You choose how you would like to add new subscribers to Sugar: as Contacts, Targets, or Leads. Once you have chosen, Save and Sync will save these list settings and start the sync process! Congratulations, you're installed and setup!

OK, now it's time to:

1. Stretch your legs
2. High-Five your neighbor
3. Take a 15 minute power nap
4. Grab a coffee
5. Sit back down

Because we're not through yet!

To get the most out of SugarChimp, there are a few more helpful steps you will want to take:

1. View your Campaign Summaries
2. View your Subscriber Activities
3. Setup your MailChimp List Dashlet or Connector
4. Sync more Fields between Sugar and MailChimp