28
CMCRM Implementation Guide Implementation Guide Applications A/S All rights reserved All products mentioned in this document may be registered trademarks. Applications A/S reserves the right to change this document without notice. All content, guidelines and recommendations in this document should be regarded as preminary. Applications A/S cannot be held responsible for the correctness of the information and/or any damage or loss following the instructions or guidelines specified. All mentioned materials and installation files of the product CMCRM are the intellectual property of Applications A/S. Reproduction is illegal without an explicit written consent from Applications A/S.

Campaign Monitor / Dynamics CRM integration: Implementation Guide

Embed Size (px)

DESCRIPTION

Use this guide to get an overview on how to install and configure the integration components for CMCRM: Campaign Monitor integration with Microsoft Dynamics CRM

Citation preview

Page 1: Campaign Monitor / Dynamics CRM integration: Implementation Guide

CMCRM Implementation Guide Implementation Guide

Applications A/S

All rights reserved

All products mentioned in this document may be registered trademarks. Applications A/S reserves the right to change this document without notice. All content, guidelines and recommendations in this document should be regarded as preminary. Applications A/S cannot be held responsible for the correctness of the information and/or any damage or loss following the instructions or guidelines specified. All mentioned materials and installation files of the product CMCRM are the intellectual property of Applications A/S. Reproduction is illegal without an explicit written consent from Applications A/S.

Page 2: Campaign Monitor / Dynamics CRM integration: Implementation Guide

2 | P a g e

Contents

About this document ..................................................................................................................................................... 4

Intended audience ..................................................................................................................................................... 4

Preparation to use this guide .................................................................................................................................... 4

Document revisions ................................................................................................................................................... 4

Installation: Steps to complete ...................................................................................................................................... 5

Feedback .................................................................................................................................................................... 5

Step 1: Prepare the installation files .............................................................................................................................. 6

Prerequisites .............................................................................................................................................................. 6

Copy the files ............................................................................................................................................................. 6

Finishing the step ....................................................................................................................................................... 6

Step 2: Export vital CRM Customization files................................................................................................................. 7

Prerequisites .............................................................................................................................................................. 7

Export the customization files ................................................................................................................................... 7

Unzip and rename the files ........................................................................................................................................ 7

Step 3: Install the CMCRM Website ............................................................................................................................... 8

Prerequisites .............................................................................................................................................................. 8

Extract the Website installation files ......................................................................................................................... 8

Step 4: Modify and import the Customization files ....................................................................................................... 9

Import the cmcrm-entities.xml file ............................................................................................................................ 9

Import the cmcrm-isv.config.xml file ....................................................................................................................... 10

Modify the ISV_Original.xml file .............................................................................................................................. 10

Modify the Campaign Monitor URL for two of the four buttons ........................................................................ 11

Save and import the file ...................................................................................................................................... 11

Modify and import the SiteMap_Original.xml file ................................................................................................... 13

Save and import the file ...................................................................................................................................... 13

Publish all the customizations ................................................................................................................................. 15

Activating custom menus and toolbars ............................................................................................................... 15

Step 5: Install and configure the CMCRM Service ....................................................................................................... 16

Prerequisites ............................................................................................................................................................ 16

Extract the CMCRM Service installation files ........................................................................................................... 16

Start the CMCRM Service Controller ....................................................................................................................... 18

Configuring the CMCRM Service Controller ................................................................................................................ 19

Configuring the Campaign Monitor Settings ........................................................................................................... 19

Configuring the Dynamics CRM Settings ................................................................................................................. 20

Integration Settings ............................................................................................................................................. 20

Page 3: Campaign Monitor / Dynamics CRM integration: Implementation Guide

3 | P a g e

Configuring the Service Settings .............................................................................................................................. 22

Other settings ...................................................................................................................................................... 22

Configuring licence information .............................................................................................................................. 23

Changing your licence .......................................................................................................................................... 23

Using CMCRM from Microsoft CRM ............................................................................................................................ 24

Managing Campaigns............................................................................................................................................... 24

Linking a CRM campaign with Campaign Monitor ............................................................................................... 24

Removing a linked campaign ............................................................................................................................... 25

Creating a Campaign Monitor Campaign from Microsoft CRM ........................................................................... 25

Managing Marketing Lists........................................................................................................................................ 26

Linking a marketing list with Campaign Monitor ................................................................................................. 26

Removing the link to a marketing list .................................................................................................................. 26

Creating a new subscriber list in Campaign Monitor from Microsoft CRM ......................................................... 27

Synchronizing custom fields between Microsoft CRM and Campaign Monitor .................................................. 27

Installation Notes......................................................................................................................................................... 28

How to determine the Application Pool for the CRM Website ............................................................................... 28

Page 4: Campaign Monitor / Dynamics CRM integration: Implementation Guide

4 | P a g e

About this document

This document will guide you throw all the steps nessasary to install and configure CMCRM. You should have all your login information, license keys, etc. ready when going throw the steps.

Intended audience You should know how system customization works in Dynamics CRM and also know how to retrieve API keys and Client ID’s from Campaign Monitor. You will need to have login credentials for the server where CMCRM should be installed as well as system customization credentials to the CRM system

Preparation to use this guide

Have the following list of items prepared to use in the appropriate steps:

Your license key for CMCRM

Your Campaign Monitor API Key

Your Campaign Monitor Client ID

A Windows logon with Administrator permissions for the server where CMCRM is installed

A Windows logon to use with the CMCRM Windows service, which is a Microsoft CRM user as well, with the read/write permissions to the following entities in Dynamics CRM:

o Marketing List o Campaign o Campaign Response o Custom Field (new custom entity installed with CMCRM)

Document revisions

Revision Approved Date Change log

1 April 2, 2010 First version for the BETA

2 April 22, 2010 Removed all BETA information

Changes to support the steps needed for the RTM version of the product

3 May 19, 2010 Added the revision history to the document.

Added the encoded API Key for the Free Edition to the document (step 2B under the CMCRM Service Controller section)

Page 5: Campaign Monitor / Dynamics CRM integration: Implementation Guide

5 | P a g e

Installation: Steps to complete

The following tasks are necessary to complete the setup of CMCRM:

1. Copy the installation files to the CRM Server

2. Backup vital CRM Custmization files This step will enable to reverse the installation and get back to the original state

3. Install the CMCRM Website This will prepare the UI for the CMCRM solution

4. Modify and import the CRM Customization files This will enable the User Interface in Microsoft CRM

5. Install and configure the CMCRM Service on the CRM Server This will enable the integration services for the CMCRM Solution

That’s it! You are now ready to integrate CampaignMonitor with Microsoft Dynamics CRM

Feedback Registered re-sellers can use our customer support system to report any issues or feature requests on: http://www.casewatch.dk.

If you have any issues with the use of CMCRM application, the setup or this documentation, please don’t hesitate to contact us:

Contact us on Twitter: http://twitter.com/appldev

Contact us on our Website: http://www.applications.dk

Contact our Development department directly on: [email protected] (Please put “CMCRM” in the subject line).

Page 6: Campaign Monitor / Dynamics CRM integration: Implementation Guide

6 | P a g e

Step 1: Prepare the installation files

Prerequisites

Update Rollup 6 or newer must be installed on the Server

The user you use to install CMCRM should also be a CRM User with “System Customizer” privileges, and privileges to read/write in the registry on the installation server.

Copy the files Create a folder on the CRM Server named “Backup files”

Extract all the files from the cmcrm-installation.zip file into the folder

Finishing the step All files needed are now placed in the “Backup folder” folder. The folder now contains the following files:

Cmcrm-sitemap.xml The XML File contains the Campaign Monitor sitemap navigation

Cmcrm-isv.config.xml The XML file contains all the UI Customization for Microsoft CRM

Cmcrm-entities.xml The XML File contains customizations (new custom fields, values and UI) for the entities “Campaign”, “Campaign Response”, “Marketing List” and “CustomField”

CMCRMWebsite-x86.zip & CMCRMWebsite-x64.zip This Zip file contains the installation files for the CMCRM Website extensions in the CRM UI.

CMCRMService-x86.zip & CMCRMService-x64.zip These files contain the installation of the cmcrm service enabling the integration services between CampaignMonitor and Microsoft CRM

Page 7: Campaign Monitor / Dynamics CRM integration: Implementation Guide

7 | P a g e

Step 2: Export vital CRM Customization files

Prerequisites

You must complete step 1 in order to proceed

Export the customization files 1. Start the CRM Web client 2. Choose Settings Customization 3. Click Export Customizations 4. Select “ISV.Config” from the list and press Export Selected Customizations 5. When prompted press Save, choose the “Backup files” folder from installation step 1, and write

“ISV_Original.zip” as the file name 6. Press OK 7. Choose Settings Customization 8. Click Export Customizations 9. Select “Sitemap.xml” from the list and press Export Selected Customizations 10. When prompted press Save, choose the “Backup files” folder from installation step 1, and write

“SiteMap_Original.zip” as the file name 11. Press OK 12. Choose Settings Customization 13. Click Export Customizations 14. Select the following entities from the list (use the CTRL key to select more than one entity):

a. Campaign b. Campaign Response c. Marketing List

15. When prompted press Save, choose the “Backup files” folder from installation step 1, and write “Entities_Original.zip” as the file name

16. Press OK

Unzip and rename the files 17. Extract the file “Customizations.xml” in ISV_Original.zip and rename it “ISV_Original.xml” 18. Extract the file “Customizations.xml” in SiteMap_Original.zip and rename it

“SiteMap_Original.xml” 19. Extract the file “Customizations.xml” in Entities_Original.zip and rename it

“Entities_Original.xml”

Page 8: Campaign Monitor / Dynamics CRM integration: Implementation Guide

8 | P a g e

Step 3: Install the CMCRM Website

Prerequisites

You must complete step 2 in order to proceed

Extract the Website installation files 1. Extract the files:

a. If your CRM server is based on the 32-bit Windows Server platform, extract all files in the CMCRMWebsite-x86.zip file to a sub-folder called CMCRMWebsite-x86 (The suggested folder if you use the Windows builtin ZIP functionality)

b. If your CRM server is based on the 64-bit Windows Server platform, extract all files in the CMCRMWebsite-x64.zip file to a sub-folder called CMCRMWebsite-x64 (The suggested folder if you use the Windows builtin ZIP functionality)

2. Double-click on the file Setup.exe

3. Press Next on the first installation step:

4. Select the CRM Website and be sure to also select the correct application pool that the CRM website uses. Press Next to continue:

Read the “How to determine the Application Pool for the CRM Website” chapter for more information.

5. Click Next to begin installation

6. Click Close to finish the installation

Page 9: Campaign Monitor / Dynamics CRM integration: Implementation Guide

9 | P a g e

Step 4: Modify and import the Customization files

Import the cmcrm-entities.xml file 1. Start the CRM Web client (if not already started)

2. Choose Settings Customization

3. Click Import Customizations

4. Click on the Browse button and select the “cmcrm-entities.xml” file from the “Backup files”

folder.

5. Click Upload. The list is now shows the customizations to be imported:

6. Click on the More Actions menu and select Import all customizations.

7. Click OK to the warning dialog:

8. Click OK when the import has finished:

You have now imported the changes to the CRM entities

Page 10: Campaign Monitor / Dynamics CRM integration: Implementation Guide

10 | P a g e

Import the cmcrm-isv.config.xml file

READ CAREFULLY: BE AWARE OF EXISTING CUSTOMIZATIONS

The cmcrm-isv.config.xml file contains customizations for two entities: campaign and list. Be aware that existing customizations for these entities can exist in the ISV_Original.xml file. You can search for <entity name=”campaign”> and <entity name=”campaign”> in the file to locate any existing customizations. If other customizations are present, you need to merge the Toolbar and Button tags from the cmcrm-isv.config.xml file into the existing customizations in the ISV_Original.xml file, in stead of just copying the entire contents in step 4 below

Modify the ISV_Original.xml file 1. Open the ISV_Original.xml file in notepad or another XML editor 2. Open the cmcrm-isv.config.xml file in notepad or anoter XML editor 3. Locate the <Entities> Tag in the ISV_Original.xml file 4. Copy the contents between the <Entities> and </Entities> tags (marked in yellow) from the

cmcrm-isv.config.xml file into the ISV_Original.xml file, just below the <Entities> Tag in the file:

<Entities>

<Entity name="campaign">

<ToolBar ValidForCreate="0" ValidForUpdate="1">

<Button AvailableOffline="false" Url="/ISV/CMCRM/SelectCM.aspx"

PassParams="1" WinParams="dialogHeight:525px; dialogWidth:615px" WinMode="1">

<Titles>

<Title LCID="1033" Text="Link with Campaign Monitor" />

<Title LCID="1030" Text="Forbind med Campaign Monitor" />

</Titles>

<ToolTips>

<ToolTip LCID="1033" Text="Creates a link between Microsoft CRM and a

selected campaign in Campaign Monitor. Campaign statistics will be downloaded

automatically" />

<ToolTip LCID="1030" Text="Opretter en forbindelse mellem Microsoft CRM

og en valgt kampagne i Campaign Monitor. Kampagnestatistikker downloaded herefter

automatisk" />

</ToolTips>

</Button>

<!--

Replace http://crm.applications.dk with the URL to Campaign Monitor that is

used for your account

-->

<Button AvailableOffline="false"

Url="http://crm.applications.dk/createSend/step1.aspx" PassParams="0" WinMode="0"

ValidForCreate="1">

<Titles>

<Title LCID="1033" Text="Create CM Campaign" />

<Title LCID="1030" Text="Opret CM Kampagne" />

</Titles>

<ToolTips>

<ToolTip LCID="1033" Text="Opens a new window that allows you to create

a new Campaign before linking the Campaign to Microsoft Dynamics CRM" />

<ToolTip LCID="1030" Text="Åbner et nyt vindue hvor du kan oprette en ny

kampagne før du forbinder kampagnen til Microsoft Dynamics CRM" />

</ToolTips>

</Button>

</ToolBar>

</Entity>

<Entity name="list">

<ToolBar ValidForCreate="0" ValidForUpdate="1">

<Button AvailableOffline="false" Url="/ISV/CMCRM/SelectCM.aspx"

PassParams="1" WinParams="dialogHeight:525px; dialogWidth:615px" WinMode="1">

Page 11: Campaign Monitor / Dynamics CRM integration: Implementation Guide

11 | P a g e

<Titles>

<Title LCID="1033" Text="Link with Campaign Monitor" />

<Title LCID="1030" Text="Forbind med Campaign Monitor" />

</Titles>

<ToolTips>

<ToolTip LCID="1033" Text="Creates a link between Microsoft CRM and a

selected list in Campaign Monitor. Subscribers will automatically be synchronized" />

<ToolTip LCID="1030" Text="Opretter en forbindelse mellem Microsoft CRM

og en valgt liste i Campaign Monitor. Abonnenter vil automatisk blive synkroniseret" />

</ToolTips>

</Button>

<!--

Replace http://crm.applications.dk with the URL to Campaign Monitor that is

used for your account

-->

<Button AvailableOffline="false"

Url="http://crm.applications.dk/subscribers/createList.aspx" PassParams="0" WinMode="0"

ValidForCreate="1">

<Titles>

<Title LCID="1033" Text="Create CM Subscriber list" />

<Title LCID="1030" Text="Opret CM abonnentliste" />

</Titles>

<ToolTips>

<ToolTip LCID="1033" Text="Opens a new window that allows you to create

a new subscriber list before linking the list to Microsoft Dynamics CRM" />

<ToolTip LCID="1030" Text="Åbner et nyt vindue hvor du kan oprette en

abonnentliste før du forbinder listen til Microsoft Dynamics CRM" />

</ToolTips>

</Button>

</ToolBar>

</Entity> </Entities>

Modify the Campaign Monitor URL for two of the four buttons You can skip this step if you are using the Free Edition of CMCRM that is bound to the Campaign Monitor URL http://crm.applications.dk. If you are using the Agency edition of CMCRM with your own Campaign Monitor account, you also need to modify the URL for Campaign Monitor for two of the four buttons. Follow step 5-6 below:

5. Locate the two buttons with a remark before them in the file:

6. Replace the “http://crm.applications.dk” part with the URL you use for your Campaign Monitor account

Save and import the file 7. Save the modified file as ISV_Modified.xml in the “Backup Files” folder

8. Start the CRM Web client (if not already started)

9. Choose Settings Customization

10. Click Import Customizations

Page 12: Campaign Monitor / Dynamics CRM integration: Implementation Guide

12 | P a g e

11. Click on the Browse button and select the “ISV_Modified.xml” file from the “Backup files” folder.

12. Click Upload. The list is now shows the customizations to be imported:

13. Click on the More Actions menu and select Import all customizations.

14. Click OK to the warning dialog:

15. Click OK when the import has finished:

You have now imported the UI Changes for CMCRM. Two new buttons has been added on the Marketing List form and the Campaign Form:

Page 13: Campaign Monitor / Dynamics CRM integration: Implementation Guide

13 | P a g e

Modify and import the SiteMap_Original.xml file

READ CAREFULLY: IMPORTANT INFORMATION REGARDING THE CRM SITEMAP

The Sitemap is an XML file containing the main navigation for the CRM system (eg. The modules and links shown in the left side of the CRM Web client). If you import a sitmap file that contains navigational errors, the CRM system will not be able to start up correctly at all. You then need to import your Sitemap_Original.xml file, to regain the functionality before correcting the errors

1. Open the Sitemap_Original.xml file in notepad or another XML editor 2. Open the cmcrm-sitemap.xml file in notepad or anoter XML editor 3. Copy the contents between the <SiteMap> and </SiteMap> tags (marked in yellow) from the

cmcrm-sitemap.xml file:

<Area Id="CampaignMonitor" ShowGroups="true" Icon="/ISV/CMCRM/mail_earth_24x24.gif">

<Titles>

<Title LCID="1033" Title="Campaign Monitor" />

<Title LCID="1030" Title="Campaign Monitor" />

</Titles>

<Group Id="CampaignMonitorExtensions">

<Titles>

<Title LCID="1033" Title="Campaign Monitor" />

<Title LCID="1030" Title="Campaign Monitor" />

</Titles>

<SubArea Id="cm_nav_conts" Entity="contact" />

<SubArea Id="cm_nav_leads" Entity="lead" />

<SubArea Id="cm_nav_lists" Entity="list" />

<SubArea Id="nav_campaigns" Entity="campaign" Url="/MA/home_camps.aspx" />

</Group>

<Group Id="cm_admin">

<Titles>

<Title LCID="1033" Title="Administration" />

<Title LCID="1030" Title="Administration" />

</Titles>

<SubArea Id="cm_customfield" Entity="cm_customfield" />

</Group>

</Area>

4. Place the copied area in your Sitemap_original.xml file, where you want to Campaign Monitor Area to be shown in the CRM Web Client. In the example below, the Campaign monitor area is placed just before the “Settings” area:

Save and import the file 1. Save the modified file as Sitemap_Modified.xml in the “Backup Files” folder

2. Start the CRM Web client (if not already started)

Page 14: Campaign Monitor / Dynamics CRM integration: Implementation Guide

14 | P a g e

3. Choose Settings Customization

4. Click Import Customizations

5. Click on the Browse button and select the “Sitemap_Modified.xml” file from the “Backup files” folder.

6. Click Upload. The list is now shows the customizations to be imported:

7. Click on the More Actions menu and select Import all customizations.

8. Click OK to the warning dialog:

9. Click OK when the import has finished:

You have now imported the new navigation into your CRM system. When the CRM system is restarted the Campaign Monitor Area is now shown in the navigation:

Page 15: Campaign Monitor / Dynamics CRM integration: Implementation Guide

15 | P a g e

Publish all the customizations 1. Start the CRM Web client (if not already started)

2. Choose Settings Customization

3. Click Customize entities

4. Select More Actions and click on the Publish all customizations menu item:

All the customizations for the CRM system is now implemented.

Activating custom menus and toolbars If the CMCRM customizations are the first customizations to your system, you might need to Activate ISV Customizations. Follow the steps below to do this:

1. Start the CRM Web client (if not already started)

2. Choose Settings Administration

3. Click System Settings

4. Select the Customization tab in the settings dialog

5. Make sure the Web Client is among the selected values for active customization clients:

Page 16: Campaign Monitor / Dynamics CRM integration: Implementation Guide

16 | P a g e

Step 5: Install and configure the CMCRM Service

Prerequisites

You must complete step 4 in order to proceed

Have your Customer name and licence key ready

Have the name and password ready for a Windows user’s credentials that the service will run as. This user must also be a valid CRM user with write permissions for all entities in marketing module as well as reading the new entitiy

Extract the CMCRM Service installation files 7. Extract the files:

a. If your CRM server is based on the 32-bit Windows Server platform, extract all files in the CMCRMService-x86.zip file to a sub-folder called CMCRMService-x86 (The suggested folder if you use the Windows builtin ZIP functionality)

b. If your CRM server is based on the 64-bit Windows Server platform, extract all files in the CMCRMService-x64.zip file to a sub-folder called CMCRMService-x64 (The suggested folder if you use the Windows builtin ZIP functionality)

8. Double-click on the file Setup.exe

9. Press Next on the first installation step:

10. Choose an installation folder, or just press Next on the second installation step:

Page 17: Campaign Monitor / Dynamics CRM integration: Implementation Guide

17 | P a g e

11. Type the Customer Name and Licence Key that you have received with your installation files:

Note: You can also just press Next and enter the licence information directly in the CMCRM Configuration dialog.

12. Enter the URL for your CRM system and press Next:

Note: This is the same URL you use to access Microsoft CRM from your internet browser

13. Press Next to begin the installation:

14. Enter the credentials for the Windows account that will run the integration service, in the windows on the top left corner of the screen and press OK:

15. Press Finish to close the installation

Page 18: Campaign Monitor / Dynamics CRM integration: Implementation Guide

18 | P a g e

You have now installed the CMCRM Integration Service, responsible for transporting and synchronizing data between Campaign Monitor and your CRM system.

Start the CMCRM Service Controller 1. Click START 2. Click All Programs 3. Select the “CMCRM Service” group 4. Click on the CMCRM Service Controller application

If you did not enter any licence information during the installation of the CMCRM Integration Service, the following dialog will be shown:

You can now enter the information and press OK

Page 19: Campaign Monitor / Dynamics CRM integration: Implementation Guide

19 | P a g e

Configuring the CMCRM Service Controller

The CMCRM Service Controller is made up of four parts:

Campaign Monitor Settings These settings tells CMCRM how to access your Campaign Monitor account

Dynamics CRM Settings These settings tells CMCRM how to access your Dynamics CRM system and how the synchronization of data should be performed

Licence Information Here you can display and change your licence information for the product

Integration Service Settings Here you can start and stop the Windows Service directly from the Service Controller and determine how often the synchronization should be performed

Configuring the Campaign Monitor Settings

1. Enter the Client Id1 of the Campaign Monitor account you will be using:

a. Agency Edition: If you are the administrator of multiple clients from your Campaign Monitor account, you can retrieve this key by selecting the client and copying the key from the Client Settings

b. Free Edition: This key will be provided for you.

2. Enter the encoded version of the Campaign Monitor API Key: a. Agency Edition: If you are the administrator of the main Campaign Monitor account, you

do the following: i. Press the Create encoded key link. The following dialog will be shown:

ii. Copy and paste your Campaign Monitor API Key into the Api Key textbox

iii. Copy (CTRL + C) the entire contents in the Encoded Key textbox and press Close iv. Paste (Press CTRL + V) the encoded contents into the Api Key Textbox

b. Free Edition: Just copy and paste the encoded key (marked below in yellow) into the Api Key textbox: TURReFlXSXdOR1UzWWpFM01HTmhZMlF6TmpaaU9EZzNaVFZrWXpoa09EWT0=

1 If you are using Campaign Monitor through an agency, just ask for your “Client ID” key

Page 20: Campaign Monitor / Dynamics CRM integration: Implementation Guide

20 | P a g e

3. Test the integration settings by clicking the Test Integration Settings link. A dialog similar to the one below will be shown if the settings are correct:

Configuring the Dynamics CRM Settings

1. The CRM URL have automatically been filled out based on the URL you provided during the installation. You can, however, change the URL if you like, as long as you append the mandatory /MSCrmServices to the URL also.

2. If you have a multi-tenant / multi-organization installation of Microsoft CRM, you can select the Organization/database CMCRM should use for the integration. Click on the Load Organizations link, to reload the list, if you change the CRM Url.

Integration Settings Setting Description

Download Campaign Statistics Determines if the main campaign statistics should be downloaded from Campaign Monitor. If you do not select this option, campaign synchronization will be skipped and you will be be able to create campaign responses either.

Create Campaign Responses Determines if CMCRM should download the detailed history for each linked campaign (click-throughs, opens, bounced). If checked CMCRM will create a campaign response on each contact that opens, bounces or clicks a link in the synchronized campaigns

Synchronize Marketing Lists Determines if CMCRM should synchronize the subscriber data from Campaign Monitor with marketing Lists in Dynamics CRM

Synchronization Type There are two options for synchronizing subscriber data:

Page 21: Campaign Monitor / Dynamics CRM integration: Implementation Guide

21 | P a g e

Setting Description

One-Way: Subscriber data from Campaign will be downloaded to CRM

Two-way: Same as one-way, but data from Microsoft CRM will also be uploaded to Campaign Monitor.

Update CRM data from Campaign Monitor

If this setting is checked, CMCRM is allowed to update existing data on contacts and leads, from matched subscribers in Campaign Monitor. If you allow your subscribers to change their data (for example via. the preference center) but want to keep your CRM data intact – do not check this setting.

Update Campaign Monitor data from CRM

If this setting is checked, CMCRM is allowed to update the data on matched subscribers in campaign monitor, with data from Microsoft CRM.

Auto-Close Campaign responses In Microsoft CRM all activities, including the Campaign Response, are created with a status of “Open”. The CRM users are then manually responsible for closing the activities in the system. With CMCRM however, you can get a lot of open/active activities in your CRM system this way, therefore you have the option to let CMCRM close the campaign responses automatically when they are created/updated. That way all the responses will automatically be moved to the “Activity History” of the contact or lead in the system.

Campaign Reponse subject CMCRM creates a number of different campaign responses. This option determines what prefix CMCRM should use for the subject, when creating a new Campaign Response. This way, the activities created by CMCRM is also easy to find visually, when looking through accounts and leads

3. Select how CMCRM should person the data synchronization, by using the settings described above

4. Click the Test Integration Settings Link. If the Settings for accessing Microsoft CRM are correct, a dialog similar to the the following will be shown:

Page 22: Campaign Monitor / Dynamics CRM integration: Implementation Guide

22 | P a g e

Configuring the Service Settings

1. Select your synchronization interval (how often CMCRM should connect and synchronize data between the two systems

2. Press Start to start the Windows Service

Other settings Setting Description

Status Shows the status of the Windows Service running the integration

Last sync Shows the date/time of the last synchronization performed

Log all info in the event log If you check this option, the Service will log any internal information will also be logged. Note: You should only select this option when troubleshooting an installation

Page 23: Campaign Monitor / Dynamics CRM integration: Implementation Guide

23 | P a g e

Configuring licence information Click on the Display Licence Link to display the licence information for your installation. You can also see when your licence will expire (for demo & limited licences):

Changing your licence You can use the Enter / Change Licence link to enter a new licence code.

Page 24: Campaign Monitor / Dynamics CRM integration: Implementation Guide

24 | P a g e

Using CMCRM from Microsoft CRM

Managing Campaigns With CMCRM installed a new tab has been added to Microsoft CRM as well as two new toolbar buttons:

The fields in the Summary section are populated from Campaign Monitor each time the CMCRM Service runs a synchronization

The fields in the Administration section contains the name and Id of the linked campaign in Campaign Monitor. If you choose, you can have separate names for the campaigns in the two systems.

Linking a CRM campaign with Campaign Monitor 1. Create a new Campaign and press Save, or open an existing one:

2. Click on the Link with Campaign Monitor button. A list of all your campaigns in Campaign Monitor will be shown in a new window:

3. Select the campaign you want to connect, and press the Connect to Microsoft CRM button. A confirmation dialog will be shown when the link has been made:

Note: When returning to the Campaign window, you can press F5 to reload the Campaign details with the new linked information

Page 25: Campaign Monitor / Dynamics CRM integration: Implementation Guide

25 | P a g e

Removing a linked campaign 1. Open the Campaign you want to remove the link for

2. Click on the Link with Campaign Monitor Button:

3. Click on the Remove link button. An information dialog will be shown when the link has been removed:

Creating a Campaign Monitor Campaign from Microsoft CRM 1. Open an existing Campaign

2. Click on the Create CM Campaign button. A new browser window will open up, which allows you to

create a new campaign in Campaign Monitor:

Note: If you do not store your user credentials for Campaign Monitor, you will be directed to the Login page before re-directing to the Create Campaign page in Campaign Monitor

Page 26: Campaign Monitor / Dynamics CRM integration: Implementation Guide

26 | P a g e

Managing Marketing Lists With CMCRM installed a new tab has been added to Microsoft CRM as well as two new toolbar buttons:

The Information section contains the name, id and unsubscribe URL2 of the linked subscriber list in

Campaign Monitor

The Confirmation section contains information about the confirmation settings3 on the list in Campaign

Monitor

Linking a marketing list with Campaign Monitor 1. Create a new Marketing List (or open an existing one)

2. Click on the Link with Campaign Monitor button:

3. Click on the Connect to Microsoft CRM button. A confirmation dialog will be shown when the link has been made:

Removing the link to a marketing list 1. Open an existing linked marketing list

2. Click on the Link with Campaign Monitor button:

2 This information is not downloaded from Campaign Monitor in the version 1.x of CMCRM

3 This information is not downloaded from Campaign Monitor in the version 1.x of CMCRM

Page 27: Campaign Monitor / Dynamics CRM integration: Implementation Guide

27 | P a g e

3. Click on the Remove Link button. A confirmation dialog will be shown when the link has been removed:

Creating a new subscriber list in Campaign Monitor from Microsoft CRM 1. Open an existing Marketing List

2. Click on the Create CM Subscriber list button. A new browser window will open up, which allows

you to create a new subscriber list in Campaign Monitor:

Note: If you do not store your user credentials for Campaign Monitor, you will be directed to the Login page before re-directing to the Add a new list page in Campaign Monitor

Synchronizing custom fields between Microsoft CRM and Campaign Monitor 1. First, you need to create your custom fields in Campaign Monitor

2. Open the linked Marketing List in Microsoft CRM

3. Click on Custom Fields

4. Click New Custom Field:

a. Type the name of the attribute 4on the Contact/Lead entitiy you want to map the custom

field to, in the CRM Attribute textbox. b. Type the name of the custom field in the Campaign Monitor, including the hard brackets []

as you would in your email templates, in the Campaign monitor field textbox. c. Select the Data type from the list (the type of custom field you have created in Campaign

Monitor)

5. Click Save and Close to add the mapping between the fields

4 You can see the list of attribute names by selecting Settings Customization Customize entities

and opening either the Contact or lead entity

Page 28: Campaign Monitor / Dynamics CRM integration: Implementation Guide

28 | P a g e

Installation Notes

How to determine the Application Pool for the CRM Website Start the IIS 6.0 Manager on the server:

1. Click START 2. Select Administrative Tools 3. Click on the “Internet Information Services Manager (IIS)” Application 4. Expand the “Web sites” node 5. Right-Click on the “Microsoft Dynamics CRM” Website and select Properties 6. Click on the Home Directory tab. The Application Pool is listed at the buttom: