Installation & User Guide

Transcription

1 CRM Internet Gateway Installation & User Guide

2 Copyright 2008 KWizCom Corporation. All rights reserved. Company Headquarters KWizCom 148 Castle Rock Dr. Richmond Hill, Ontario L4C 5K5, Canada Web site: Sales Telephone:

3 Table of Contents Introduction... 4 Overview... 5 Installation... 8 Software prerequisites 8 Installation Procedure 9 Post Installation 11 Component Activation Administrator Guide Introduction 14 CIG Web Service module configuration 15 CIG CRM module configuration 21 FAQ What does CRM Internet Gateway do? 34 How is CRM Internet Gateway licensed? 34 Version Release Notes Version History 35 Technical Support

4 Introduction KWizCom CRM-Internet Gateway (CIG) enables you to trigger Dynamics CRM 4.0 entity creation (New case, New lead etc.), upon form submitting in other systems. This way you can easily connect for example your Contact Us form on your Internet web site, to new leads that should be created in your Dynamics CRM 4.0 sales system. This document provides all the information needed to install, evaluate and deploy this KWizCom product: Product overview Installation guide Component activation Administrator guide FAQ Version release notes 4

5 Overview Easily integrate your web site forms (or any other web system) to Microsoft CRM 4.0! KWizCom CRM Internet Gateway (CIG) is a Microsoft Dynamics CRM 4.0 compatible component that allows you to easily integrate any web-based system to Microsoft Dynamics CRM for automatic creation of any CRM entity. CRM Internet Gateway enables organizations to: Link multiple web systems forms to Dynamics CRM. Automatically create any type of CRM entity (case, lead, customer etc.). Run Workflow rules in Dynamics CRM. So, how it works? The CRM Internet Gateway includes 2 modules: 5

6 CIG Web Service Module - This module captures submitted forms (HTTP Post requests) on Web systems (for example: Contact Us form that visitors fill and submit on Internet web sites). CIG Web Service manages a queue of all submitted forms and provides a web interface that enables CIG CRM module to ask for these forms data. CIG CRM Module - This module is installed on the Microsoft CRM server. It connects to CIG Web Service using HTTP/s protocol and retrieves all new submitted forms. For each form (according to pre-defined settings), it creates a new Dynamics CRM entity (Lead, Customer, any other entity) and fills it with the appropriate data. This architecture enables organizations implement any requested integration scenario of Dynamics CRM with internal/external web systems in the most secured and reliable way! CRM Internet Gateway includes a powerful configuration utility that enables implementers to map between various web forms and Dynamics CRM entities that should be created automatically. 6

7 The CRM Internet Gateway documentation includes full details regarding the installation and configuration (Available in Downloads section). Key Features & Benefits Feature Connect any forms from any Web system, implemented in any technology (.NET. java, PHP, ASP, whatever). Powerful configuration utility, enabling implementers to map various web forms to any requested CRM entities. User mapping utility enables to map several non- CRM users, to a selected Dynamics CRM user, i.e: expose Dynamics CRM to non-crm users (and save CAL s) Standard edition 7

8 Installation Software prerequisites Server Requirements CIG Web Service Module 1. Windows Server 2003 with IIS 2..NET Framework 2 CIG CRM Module 1. Dynamics CRM 4.0 Server REMARK: You can install both modules on the Dynamics CRM server for a single-server configuration. This installation guide assumes you have 2 separate servers for the CIG web service module (that can be installed for example on an external server) and the CIG CRM module (that must be installed on the CRM server). 8

9 Installation Procedure 1. Download CIG latest version from KWizCom web site. 2. Log in as local admin to your server. 3. Unzip the KWizCom CRM Internet Connector zip file on your server. 4. Double-click the.msi file in order to begin the installation. 5. In the Select installation type choose what components you wish to install: Install CIG Web server components Choose this option to install the needed components for creating an internet web site that can connect to your CIG CRM component. This can be installed on the CRM server or on a remote web server. Install CIG CRM server components Choose this option to install the needed components to connect CIG with your organization s CRM. This can be installed only on your CRM server. 9

10 6. Follow the instructions on the screen and finish the installation wizard: 10

11 Post Installation 1. After completion of the installation, you will see a new KWizCom entry in Windows Start -> All Programs -> KWizCom > CRM Internet Gateway containing the following programs: About CRM Internet Gateway Display General Information about the component. Activate CRM Internet Gateway This utility enables you (the SharePoint Administrator) to activate the downloaded evaluation version. CRM Internet Gateway Administrator s Guide Link to user-guide document (.PDF). CRM Internet Gateway Settings This utility enables an administrator to configure the CRM Internet Connector s settings. 11

12 Component Activation KWizCom components are available for evaluation prior to purchase. This way you can try our components and verify that they indeed meet your needs. An evaluation version for each KWizCom component contains all features of the component's production version. The only difference is that an evaluation version is time-limited, and will operate for a period of one month. Once you decide to order a KWizCom component, you will need to follow the following steps: 1. Order the component on the KWizCom website 2. Send us the installed evaluation version's product Code (you will see the product Code on the "About" product page: Product Code Please use the Activation Request web form, on KWizCom web site 12

13 to send us your product code. 3. Get the component activation key this key will be sent to you by once your order is processed. 4. Activate your installed evaluation version - click Start > All Programs > KWizCom > CRM Internet Connector> Activate CRM Internet Connector 13

14 Administrator Guide Introduction CRM Internet Connector (CIG) includes 2 modules: 1. CIG Web Service module this module captures submitted forms on defined web applications, and provides a Web Service API that enables retrieving this data by HTTP protocol. 2. CIG CRM module this module is implemented as a windows service that retrieves the new forms data from CIG Web Service module and for each form (according to its data) it creates the appropriate Dynamics CRM instance (Lead, Case, Campaign etc.) This section describes the configuration settings of each of these modules. 14

15 CIG Web Service module configuration 1. Go to CIG start menu and click CRM Internet Gateway Settings 2. In the WEB Server tab you will find the settings for the CIG Web Service module. 3. For every submitted form on your web site/s, the CIG Web Service module stores an XML file (later on retrieved by the CIG CRM module). These XML files are stored in folders according to their state: a. New New submitted forms, still not retrieved by the CIG CRM module. b. InProgress Forms that are being retrieved by the CIG CRM module. c. Errors Errors occurred during the process of a form. 15

16 d. Archive A new CRM entity instance was successfully created in the CRM according to the submitted form. 4. You can configure the folders the web site uses in this window. 5. At the Location text box, enter the URL where you want the wizard to create your internet web site that will expose the CIG Web Service functionality. 6. Click Create to create and test your web site. 7. You will see a confirmation message stating your web site was created correctly. 8. Open IIS Manager (start -> run -> inetmgr) 9. Right click Sample Account Form.aspx and choose Browse 16

17 10.An internet explorer should open and show this sample form: 11.If you get and error page, such as the following please review next steps for changing ASP version to ASP.NET 2. If your page loads correctly, you can skip the next step. 17

18 12.In case you got an error, this is most likely the cause of wrong ASP.NET version. To correct this error please follow these steps: a. In IIS Manager, right click the CIG application and choose properties 18

19 b. In Virtual Directory tab, make sure your selected application is ASP.NET 2.0 only application pool, and that it is not used in another web site that runs a different version of ASP.NET 19

20 c. In ASP.NET tab, make sure that the selected ASP.NET version is 2.x.x d. Click OK and try to browse to the test page again. 20

21 CIG CRM module configuration 13. When you are done with your web server settings, move over to CIG CRM module config tab 14. In configurations update your SMTP server name, from and to address. 15. In folders, you can change the default folders where the CIG CRM module stores the form XML files that it retrieves from the CIG Web Service module. CIG to CRM user mapping 16. You can map your web site/s forms users on your CIG web site into one or more CRM users. 21

22 17. This allows you to add several User Alias that you will be able to use later on when you create CIG ASPX Forms (see: Create custom forms in ) 18. To do so follow these instructions: a. Click on WebUsersToCRMUsers... next to the (Collection) value b. In the popup that appears you will have 1 user mapping made for you as an example: 22

23 c. Set the domain, password and user name to the real CRM user credentials. d. Set the user alias as the CIG web site s form user you wish to submit to CRM as that user. 23

24 Connection to CIG Web Service module 19. To configure the CIG CRM module to connect to the CIG Web Service module (that does not have to be on the same machine), use the Web Request Settings configuration section. 20. You can set up the CIG Web Site URL, the interval (in minutes) for the requests for updates, and the user credentials to run the requests under. 24

25 CRM entities configuration 21. Last, you will have to configure Entities mapping between the CRM and your CIG web service forms. a. Click on the... next to the Entities definition b. In the popup that opened you will have a sample entity binding for Accounts 25

26 c. First, under Entity Settings choose the entity this form definition relates to. d. Under Form Settings set up the FormName to a unique form name (we will use it late on in our web site) e. You can use one entity definition with several ASPX forms, as long as all these forms specify the same FormName value. f. In Form Fields you can add mappings from your web form to CRM entity fields. g. Click on... near Form Fields to add and edit field bindings: i. In Form Field choose the name of the field in your ASPX form. ii. In Entity Field choose EntityFIeldName from the list of fields in current entity iii. In FieldType select the field type. h. TBD export to excel 26

27 Expose entities to web site 22. Exposing CRM entities to you web site is composed from 2 steps: a. Adding CRM entity definitions to CIG (see: 27

28 b. CRM entities configuration) c. Creating ASPX forms in CIG web site to handle these entities (see: Create custom forms in ) Create custom forms in your web site/s 23. After you configured CRM entities in CIG CRM configuration you now can create your custom form page (one or more) that you will expose to your users. 24. You will have to keep at hand the following information from the CIG entity configuration screen: a. The FormName you selected in the set up screen b. The FormFieldName and type for each of the FormFields you configured for this entity 25. You can create a web forms in any required web application/site, implemented in any required technology. You just have to make sure these form perform a POST HTTP request to the appropriate address, and include the correct form field names. 28

29 The following example demonstrates how to create a web form in ASP.NET: a. Go to C:\Program Files\KWizCom\CRM Internet Gateway\WEB on CIG web site. b. Make a copy of SampleAccountForm.aspx into a new file (say EntityXForm.aspx ) c. Open the new ASPX page for edit using notepad or other text editors. d. Edit and modify the FormName in the following lines (Replace SampleAccount with your form name: <form id="sampleaccount" method="post" action="[url of CIG web site]/createentity.aspx?redirecturl=sampleaccountform.asp x"> And in: <INPUT id=" formname" type="hidden" name=" formname" value="sampleaccount"> 26. Set up the CRM users this form allows to submit as: a. Your form can run as one specific CRM user, or you can allow your users to choose between several CRM users to work under. b. Simply add this HTML to allow your users to choose between user1 and user2. <SELECT id=" useralias" name=" useralias"> <OPTION value="" selected></option> <OPTION value="user1">run as user1</option> <OPTION value="user2">run as user2</option> </SELECT> c. Note: user1 and user2 were defined earlier in CIG to CRM user mapping 27. The rest of the HTML is pretty simple and dynamic you can change everything as long as you keep to the following rules: d. For every FormFieldName you set up create an input control with the ID and the NAME set to the FormFieldName 29

30 e. For a text field named inacountname add the following HTML: <INPUT id="inacountname" type="text" name="inacountname"> f. For a choice field named selindustrycode, add the following HTML: <SELECT id="selcontact" name="selcontact"> <OPTION value="" selected></option> <OPTION value="mike Peterson">Mike Peterson</OPTION> <OPTION value="jill Garassy">Jill Garassy</OPTION> </SELECT> g. For a yes/no field named chdonotphone add the following HTML: <INPUT id="chdonotphone" type="checkbox" name="chdonotphone"> 30

31 Monitoring Once you finished all configuration you still need to check that the service do update the CRM with changes in your web site, right? For every failed job an will be sent to the address you specified in the CIG configuration screen like this: There you will get all details about the errors and a log file (saved on the server) that may help you (and mostly us) to understand the error. Most common error is no access for the service to CRM. This can be done when you did not define correct user mapping for some forms, and when the CIG service does not have permissions to update the CRM. To check the service permissions 1. Open Services console in Administrative Tools 31

32 2. Find KWizCom CIG service 3. Right click -> properties on the service 32

33 4. Update the user credentials here to a user that has access to CRM 5. Click OK and restart the service. To check CIG user to CRM user mapping 1. Open the CRM settings form 33

34 2. Check Web Users to CRM Users configuration 3. Check user configuration in Request Data section: 34

35 FAQ What does CRM Internet Gateway do? The CRM Internet Gateway (CIG) enables non-crm users to use existing/new web forms in web applications/sites in order to update information in Dynamics CRM. Example: You can use CIG to automatically create a new Lead in Dynamics CRM whenever a guest fills the Contact Us web form in your company web site. How is CRM Internet Gateway licensed? The CRM Internet Gateway (CIG) requires a license for every Dynamics CRM server (per-server license). 35

36 Version Release Notes Primary Software Version Base version Release date July Sub-Modules Module Version n/a n/a Version History CR # Description Version , July Support CRM

37 Technical Support You can obtain technical support using any of the following methods: The KWizCom Web site The KWizCom website at contains the most updated valuable information, including: Answers to frequently asked questions (FAQ's) about our products usability and technical questions. Product updates, which provide you with bug fixes and new features. The Web Form For technical support through the Internet, please fill in our support web form on our web site 37