Document toolboxDocument toolbox

On-Premise CRM Solution CTI Deployment Guide

Preface

This document provides deployment details of the Web CTI Connector for on-premise MS Dynamics CRM 

Prerequisites

Following are the prerequisites for the deployment of the Javascript CTI Toolbar.

  1. Dynamics 365 should be installed. 
  2. The user must have administrative rights 
  3. Download and install the Generic Connector.
  4. (Optional) Install Generic Connector patch 4.0.1. Extract the RAR file and run the EXE file on the Generic Connector server.

Install Javascript CTI Toolbar for MS Dynamics CRM 

Javascript CTI Toolbar is a CTI Toolbar for any web-based CRM. Follow these steps to install the Javascript CTI Toolbar inside MS Dynamics CRM.

  1. Download the following zip archives from the below links:
    1. EF_Cti_Toolbar (Download Link)
    2. EF_Cti_Toolbar_U(Download Link)
  2. Log in CRM using admin credentials
  3. Go to Settings → Solutions
  4. Import downloaded “EF_Cti_Toolbar ” Solution.
  5. From the import solution window, Select solution package  “EF_Cti_Toolbar” and click on next
  6. On solution, information window click on next.
  7. On the import options page, click to import, it will import the solution inside the CRM.
  8. After the solution is imported successfully, click on close to close the window.
  9. Repeat the same process to install the “EF_Cti_Toolbar_U” solution.
  10. Go to the Dashboard of Dynamics CRM. EF CTI Toolbar should be visible on the top right corner.




Configuration

Configurations are saved in an EF_Cti_Toolbar_U solution. 

  1. Go to solution “EF_Cti_Toolbar_U”
  2. Open the config.js web resource
  3. It will be the same as below figure
  4. Update the configurations.
  5. If single sign-on is enable, then must update the agent_field_name,agent_field_password and agent_field_extension. These fields should contain ids of the fields created in this step.
  6. Save web resource and then publish it.

Configure Single Sign-On (SSO)

Customize the user entity to configure Single sign-on (SSO) with MS CRM. It allows a configured CRM user to be logged in as a contact center agent upon login to MS CRM. 

Follow these steps to customize the user entity.

  1. Go to setting→ security→ users
  2. Load customize entity page as shown below 
  3. Select fields and click on new to create a new field
  4. In-display name enter “Agent Id” and click on save & close
  5. Repeat the same process to add the “Password” and “Extension” fields.
  6. Add the ids of these fields in the configuration file as mentioned in configuration step 5.
  7. Now open the main form window.
  8. Add the fields in the user information area from the field explorer, click on save to save the form and then publish it.
  9. Go to settings→ users→ New. 
  10. The form should contain all the new fields as shown below.

Configure Click-to-Call

Follow the steps to configure click to call on the Account page.

  1. Open account entity page from Service→ Accounts.
  2. Load customizes entity as shown in the below figure.
  3. Select from the left navigation and open the main form from the list. 
  4. In the newly opened window, load “Form Properties”.
  5. Inside the Form Properties window,  Click on add and add new_click2callOnForm.js web resource.
  6. Now inside the Form Properties window, the Event Handlers section add the file new_click2callonForm.js and add the function “hello” OnLoad event of the form.
  7. Click OK, this will close the Form Properties window.
  8. On Account Form window, click save and then click publish, then close all windows and reload crm dashboard page.

CRM Configurations for Security Roles

User should have 

  1. Customer Service Representatives role 
  2. Rights for activity creation
  3. Appropriate rights for creating, modifying and appending all those entities against which activity is created i.e. (Lead, Account, Contact)

Install and Configure Log Server

Log server is used to write web connector logs in a file on the server. Follow these steps to install log server.

  1. Download log server from link.
  2. Right-click on EF_log_server.jar file and open with WinRAR.
  3. Go to the config folder and open config.properties
  4. Set the values in ActiveMQ_URL_1 and ActiveMQ_URL_2
  5. Save the file and update the archive folder
  6. Double click on InstallLogServer.bat. It will install a windows service
  7. Go to services and make sure that EFLogServer is running.