Engage - MS CRM Integration Installation and Setup Guide

Transcription

1 Engage - MS CRM Integration Installation and Setup Guide Published: January 2014 Copyright 2014 Silverpop Systems

2 Table of Contents 1 Introduction Engage MS CRM Integration Overview Engage MS CRM Integration Components Terminology List Requirements Supported Versions of Microsoft Dynamics CRM Installation Import privileges Clean Installation Upgrade General process Upgrading from to version Upgrading from to version Upgrading from to version Post-Installation Configuration Settings General Settings Proxy Adding Silverpop Integration to custom forms Copyright 2014 Silverpop Systems

3 1 Introduction 1.1 Engage MS CRM Integration Overview The purpose of this product is to combine the marketing functionality of the Silverpop Engage marketing solution with Microsoft Dynamics CRM. 1.2 Engage MS CRM Integration Components Engage MS CRM Integration product consists of: OnPremise solution for MS CRM On Premise deployment Online solution for MS CRM Online deployment Documentation 1.3 Terminology List There are a number of terms used in this guide that may not be familiar to you. Below you will find a list of basic terms and definitions that will help you identify elements of Engage MS CRM Integration product. Term Silverpop Engage CRM system Entity oauth Definition The Engage Marketing product is a dynamic platform to automate and optimize campaign management, while leveraging customer behavioral data A program that manages customer relationships such as Microsoft Dynamics CRM A representation of a business object in Microsoft Dynamics CRM or Silverpop Engage systems. Service to authenticate to Silverpop Engage Table 1: Terminology List Page 3 of 20

4 2 Requirements Before you import solution, please check if you Microsoft Dynamics CRM version is supported. 2.1 Supported Versions of Microsoft Dynamics CRM Solution supports MS CRM 2011 and MS CRM More detailed information about rollups is below. MS CRM RU1 RU2 RU3 RU4 RU5 RU6 RU7 RU No No No No No No No Yes MS CRM RU9 RU10 RU11 RU12 RU13 RU14 RU Yes Yes Yes Yes Yes Yes Yes MS CRM RTM 2013 Yes Page 4 of 20

5 3 Installation 3.1 Import privileges Both versions of Silverpop solution contain plugin for Microsoft Dynamics CRM, which should be registered with required permissions. Permission required only for OnPremise version. The user you re using to import solution should be added to Deployment Administrators. 3.2 Clean Installation Import solution to Microsoft Dynamics CRM where no Engage MS CRM Integration solutions were installed earlier. Import steps for OnPremise and Online solutions are the same. a. Go to Settings > Solutions in Microsoft Dynamics CRM. Important Keep in mind that to access Settings area in Microsoft Dynamics CRM you have to have System Administrator security role. b. Click Import button. Select solution file and click Next button. c. After solution is uploaded to the server it is possible to see solution version, change log and components by clicking on View solution package details button. Click Next. Page 5 of 20

6 d. Mark the checkbox Activate any processes and enable any SDK message processing steps included in the solution. e. Import starts and finishes successfully. Click Close. Page 6 of 20

7 3.3 Upgrade General process Import solution to Microsoft Dynamics CRM where one of the Engage MS CRM Integration solutions (OnPremise or Online) is already installed and have earlier version. Upgrade steps for OnPremise and Online solutions are the same. a. Go to Settings > Solutions in Microsoft Dynamics CRM. Important Keep in mind that to access Settings area in Microsoft Dynamics CRM you have to have System Administrator security role. b. Click Import button. Select solution file and click Next button. c. After solution is uploaded to the server CRM defines current version that is installed and version you re trying to upgrade. Page 7 of 20

8 d. Check Overwrite customization option and mark the checkbox Activate any processes and enable any SDK message processing steps included in the solution. Click Next. f. Import starts and finishes with warnings. Click Close. Page 8 of 20

9 3.3.2 Upgrading from to version This part of the document is related to Online version only. If you are upgrading from to version few additional steps are required. Since version Silverpop controls (SSE - Sync to Silverpop field, Contact Insight - iframe) are located only on Contacts /Leads default form called Information. Versions below had Silverpop controls for Contacts /Leads on the other form called Contact/Lead but not supported anymore. Note If you need to have Silverpop controls on any custom forms for Contact or Lead entity go to 4.2 section of this document. Important a. Go to Settings > Customizations in Microsoft Dynamics CRM. b. Click on Customize the System link. Keep in mind that to access Settings, Customizations or Customize the Systems area in Microsoft Dynamics CRM you have to have System Administrator security role. c. In opened window locate all available forms for Contact entity. Click on the Contact form. Page 9 of 20

10 d. Find Silverpop Integration section on the form, select it and click Remove ribbon button. Click OK to confirm deletion. e. Find Conflicts section on the form (if available, if not skip this step), select it and click Remove ribbon button. Click OK to confirm deletion. Important Check all the fields in Conflict section before delete it. You may need them for some other customizations or if you don t know keep them on the form by moving to the other section. Page 10 of 20

11 f. Click on Form Properties ribbon button. g. Remove all libraries that start with sp_ prefix. Click OK. h. Click Save then Publish button. Close the form. i. Repeat all the steps for the Lead form on the Lead entity. Page 11 of 20

12 3.3.3 Upgrading from to latest versions This part of the document is related to Online and OnPremise versions. If you are upgrading from to latest versions one additional step is required. Since version all application settings available in General Settings window. After upgrade is done all settings have to be set again (except host for SSE functionality should be in place). a. Go to Settings > Administrations in Microsoft Dynamics CRM. b. Click on Silverpop Integration button on the ribbon and click on General Settings. Important Keep in mind that to access Silverpop Integration in Microsoft Dynamics CRM you have to have Silverpop Admin security role. c. In opened window set Endpoint, Refresh Token, List Id and Host settings. To get the refresh token Login to Engage Go To Settings Organization Settings Application Account Access Click on Add Account Access *If access has already been set, but you can t locate the original with the token, then select the user and click on Revoke Account Access and proceed to generate a new token by clicking on Add Account Access Select the MS Dynamics Integration application Select the User Account that will communicate with Engage from Scribe Online and Microsoft Dynamics CRM. Adding a description is optional but usually preferred if multiple Engage Admins use the system and need to know why the user has the specified access. Page 12 of 20

13 An will be generated and sent the notification address of the user selected The will contain the token that needs to be added to CRM Upgrading from to version If you are upgrading an Online version make sure you did everything described in Also go through and update your applications settings again. This should be done for both online and on premise versions. Page 13 of 20

14 4 Post-Installation Configuration 4.1 Settings To finish the Silverpop Integration installation it s required to specify settings. Go to Settings > Administrations area. Click Credentials button on the ribbon. Important Note that to have access to Settings, Administration area in Microsoft Dynamics CRM you have to have System Administrator security role. Also to access Silverpop Credentials ribbon button you have to have System Administration or Silverpop Admin security role General Settings To communicate with Silverpop Engage system fields described below be specified. Endpoint endpoint OAuth service. (e.g. Refresh Token required by OAuth service. (see 3.3.3) List ID the id of the database in Silverpop Engage. Host endpoint to Silverpop API services. (e.g. **# is the POD number of your Engage environment. Page 14 of 20

15 4.1.2 Proxy Proxy Settings available only for OnPremise version. Enable Proxy enable/disable proxy option Proxy Address the address of the proxy server for your local domain ( Use Default Credentials not recommended to use. Obsolete will be removed soon. Proxy User Name user to access the proxy server Proxy Password password to access the proxy server Page 15 of 20

16 4.2 Adding Silverpop Integration to custom forms When the Silverpop solution is imported, only the main Information form of the Contact and Lead entities is updated to include the Silverpop Integration tab. Note If the form Security Role Settings is set to Display to Everyone, that is the form (one of the forms) that available for everyone. To Add the Silverpop Integration to a new default or custom form add the following to the form: a. Insert a One Column Tab which will include a Two Colum Section Page 16 of 20

17 b. Update the Tab Properties as displayed c. Expand the Field Explorer section to show all the fields and drag the Sync to Silverpop field to the Silverpop Integration tab. Page 17 of 20

18 d. Change Sync to Silverpop Field Properties as displayed. e. Select Silverpop Integration tab and click Web resource ribbon button. Page 18 of 20

19 f. Set new Web Resource Properties as displayed. Use lookup button to find sp_/contactinsight.htm web resource. Type the web resource Name carefully as displayed EngageIntegration (prefix WebResource_ should be added automatically), also uncheck checkbox Visible by default. Recommended Number of Rows value is 20. Click OK to create/save web resource. g. Click Form Properties ribbon button. Page 19 of 20

20 h. On the Events tab, Form Libraries area add sp_common.js web resource. In Event Handlers area select the OnLoad event and click Add button. In Handler Properties window specify the function name DisableField, enable function. In Parameters area add "sp_synctoengage" as described. Click OK twice. i. Click Save then Publish ribbon button to apply the changes. j. Repeat steps for needed form on the Lead entity. (if required) Page 20 of 20