OSF INTEGRATOR for. Integration Guide

Transcription

1 OSF INTEGRATOR for DEMANDWARE and MICROSOFT DYNAMICS CRM 2013 Integration Guide

2 Table of Contents 1 Summary Component Overview Functional Overview Integration components Use cases Compatibility Implementation Guide Demandware cartridge Setup Configuration Microsoft Dynamics CRM 2013 solution Setup Registration Testing Security Roles Uninstall the CRM solution Operations, Maintenance Release History Pg. 2 17

3 1 Summary OSF Integrator for Demandware and Microsoft Dynamics CRM 2013 is an integration plug-in that enables customer and order data from the Demandware Commerce platform to be automatically synchronized into Microsoft Dynamics CRM Intended audience This document is intended for technical personnel who will be setting up and integrating Microsoft Dynamics CRM connector with the Demandware ecommerce platform. 2 Component Overview 2.1 Functional Overview This integration tool enables users to: View customer records directly in Microsoft Dynamics CRM View order data directly in Microsoft Dynamics CRM Access custom view and reports in Microsoft Dynamics CRM Analyse online Customer activity 2.2 Integration components In order to use the plugin, it is mandatory to install and configure two solutions, each on their specific platform (Demandware and Microsoft Dynamics CRM): 1. Demandware cartridge 2. Microsoft Dynamics CRM manage solution The Demandware cartridge can be downloaded from: OSF website: The Microsoft Dynamics CRM solution can be downloaded from OSF website, by accessing this URL and completing the sign up form: Pg. 3 17

4 After registering via our website, the user will receive an containing: A unique license key and an Organization ID that permit the use of the trial version A link for user to download the CRM managed solution and a link to download the Demandware cartridge A link for user to download the Integration Guide and a link to the User Manual 2.3 Use cases Import newly created records (customers or orders) from Demandware to Microsoft Dynamics CRM Import existing modified records (customers or orders) from Demandware to Microsoft Dynamics CRM Compatibility Based and tested on Demandware version 15.2 and Microsoft Dynamics CRM Implementation Guide 3.1 Demandware cartridge Pg. 4 17

5 This cartridge enables a Demandware-based store to use the OSF Demandware to Microsoft Dynamics CRM plug-in. After installation of the cartridge, the user needs to configure certain items in Demandware to make the integration work. Dynamics connector integration has the following main cartridge: - int_osfintegrator_connector This cartridge has pipelines that can be called to get the list of Orders and Customers Setup Import the int_dynamics_connector cartridge into Demandware, using an FTP client (like bitkinex, for instance). 1. Open FTP client Bitkinex 2. Right-click on Http/WebDAV new Http/WebDAV 3. Insert the address of your Demandware organization (for instance test.dw.demandware.net), then Enter 4. Insert server address (test.dw.demandware.net), choose security https, and add username and password (from your Demandware account); press OK 5. Right click on the new http/webnav Browse Yes 6. Right click on the / directory Change directory insert /on/demandware.servlet/webdav/sites/cartridges/version1/ 7. Browse on your computer for int_osfintegrator_connector directory and copy it on the server Import the custom site Preferences into Demandware Business Manager 1. Log into the Demandware Business Manager 2. Click Administration Sites development Import & Export 3. Click Upload 4. Browse for the meta_data_osfintegrator_connector.xml click Upload 5. Click the <<Back button at the bottom of the page 6. Click Import 7. Select the meta_data_osfintegrator_connector.xml from the list below 8. Click Next 9. When validation is complete, click Next Pg. 5 17

6 The following attributes will be added (by the meta data) to System objects: Order : o osfintegratorid (String) o osfintegratoridlastmodified (Date+Time) Profile : o osfintegratorid (String) o osfintegratoridlastmodified (Date+Time) The following attributes will be added (by the meta data) to System object SitePreferences, and thus will be available in Custom site preferences: osfintegratorconnectoruser (String) osfintegratorconnectorpassword (String) Append int_osfintegrator_connector to the Effective Cartridge Path After you have imported the int_osfintegrator_connector cartridge into your workspace and uploaded it to your Demandware instance, you must add int_osfintegrator_connector to the cartridge search path for each site that will use the Demandware to Dynamics connector integration. 1. Click Administration Sites Manage Sites 2. Select the site from the list 3. Click on the Settings tab 4. Append :int_osfintegrator_connector to the end of each path, separated with a colon 5. Click Apply For example, if the cartridge search path is: app_storefront_example then this step changes it to: app_storefront_example:int_osfintegrator_connector Pg. 6 17

7 3.1.2 Configuration Credentials To set up the Dynamics connector integration cartridge, the following information is required: the user name and the password which will be used by Dynamics as credentials for authentication when a request is made. 1. In Business Manager, go to Site Site Preferences Custom Preferences DynamicsConnector 2. Fill the values for Dynamics Connector User and Dynamics Connector Password 3. Click Apply 4. These values have to be setup in Microsoft Dynamics CRM Configuration page, also please see the chapter 3.2 Microsoft Dynamics CRM 2013 solution The following image shows the custom site preferences settings in the Demandware Business Manager: 3.2 Microsoft Dynamics CRM 2013 solution OSF Integrator for Demandware and Microsoft Dynamics CRM 2013 plug-in can be installed on both versions of Dynamics CRM: Pg. 7 17

8 - on-premise version - on-line version (including Microsoft Dynamics CRM On-line integrated with Office 365 version) Setup The first step to installing any managed solution in Microsoft Dynamics CRM 2013 is to locate the file you want to install and then download and place on your computer. Log in to your Microsoft Dynamics CRM 2013 instance, as a System Administrator or System Customizer. For this, you must have the administrative privileges. Navigate to Settings > Solutions and click on Import. The next window that opens will let you browse the solution you are importing choose the file and click Next. Pg. 8 17

9 You can choose to View solution package details, which displays the Solution attributes and components. Pg. 9 17

10 In the next window, check the Activate all Processes checkbox. (THIS IS VERY IMPORTANT OR THE SOLUTION WILL NOT EXECUTE CORRECTLY) and select Next. A green progress bar will display the advancement of the import process, as in the image below. Pg

11 When the import is complete, a summary screen of the solution components is displayed as shown in the "Successful Import Dialog" figure below. The yellow bar along the top indicates that your solution has been imported successfully. Click Close. This whole process can take a few minutes, so please be patient and allow it to finish. Pg

12 3.2.2 Registration The next step is to set up the OSF Integrator credentials, Demandware credentials and Microsoft Dynamics CRM 2013 credentials. To perform this task, please go to Settings / OSF Demandware Integrator / Configuration screen and complete all of the fields from all tabs: Pg

13 1. License Key and Organization ID will be provided to you via together with the links for downloading the solutions. An important feature provided in addition to this plugin is the Initial Import of pre-existing data. For more information regarding the Initial Import, please refer to the document OSF Initial Import. 2. Demandware Credentials these credentials are used to log in to the Demandware account 3. Microsoft Dynamics CRM 2013 credentials these credentials are those used to log in to the Microsoft Dynamics account Another important aspect is the type of Microsoft Dynamics CRM account. If your organization is using Microsoft Dynamics CRM Online integrated with Office 365, you must check the appropriate option, as it is displayed below: Please press the Edit button and for every tab complete all fields with the necessary information; then press Save. Wait until all of the information is checked and validated. Pg

14 3.3 Testing To test and see if OSF Integrator for Demandware and Microsoft Dynamics CRM 2013 solution was installed and working properly, please follow these steps: 1. Go to Settings / Customization / OSF Demandware Integrator / Activity Log screen 2. Check if a Sync Task has run (Finish date field will be populated) 3. After a SyncTask is completed, customer and order data (new and/or updated) should be available in Dynamics CRM. 4. In order to see the last customers synchronized, please go to Sales / Accounts / New DW Accounts created in the last 24 hours 5. A list containing the newest accounts created will be displayed 6. For checking the orders, please go to Sales / Orders / New DW SO s created in the last 24 hours 7. A list containing the newest orders created will be displayed Pg

15 8. These lists are also displayed on the DW Dashboard; in order to see the Dashboard, please go to Workplace / Dashboards / DW Dashboard. 9. You can also check each record created (account or order) to see if the data synchronized is identical to the data from Demandware. 3.4 Security Roles Users who require access to OSF Integrator for Demandware and Microsoft Dynamics CRM 2013 need the Demandware ecommerce security role assigned to their Microsoft Dynamics account. System Administrators will perform this operation (Settings / System / Administration / Users). There are two custom security roles: - Demandware ecommerce Integration Administrator - Demandware ecommerce Integration User 3.5 Uninstall the CRM solution In order to uninstall the plug-in, please perform the following steps: Pg

16 1. In Microsoft Dynamics CRM 2013, navigate to Settings tab 2. Select Solutions 3. In the Solutions list, select the OSF Integrator for Demandware and Microsoft Dynamics CRM 2013 solution and hit the Delete button 4. Confirm the deletion and the plug-in will be removed from the system 4 Operations, Maintenance Support Support can be reached via at info@osf-commerce.com. Pg

17 5 Release History Version number Date Description March 2013 Initial release March 2015 Re-certification Pg