SugarCRM Integration

Owned by Valerio Ciotta
Last updated: May 10, 2022 by XCALLY Knowledge (Unlicensed)
6 min read

How it works

   SugarCRM integration is used to automatically open a SugarCRM call for every call according the conditions (Queue, Call status or Outbound) set in the trigger.

The SugarCRM call will be populated with information about the call and displayed for the agent in the SugarCRM environment.

The following are list of things you have to do to make the integration work:

  1. Create SugarCRM account
  2. Create a configuration for the account
  3. Create a trigger (Tools → Triggers), set the conditions you want to trigger the integration and add integrations action (for info see Voice Triggers) by selecting SugarCRM integration, the SugarCRM account you have configured and the configuration you want to use. 
  4. Login agent in SugarCRM and Motion

Every time there is an outgoing/incoming call, the trigger conditions are checked and a SugarCRM call is created and assigned to the agent managing the call if the conditions are met.


When an agent manages a call, the agent will first be searched in SugarCRM by Full Name and then assigned to the task only if the agent account is found.

Otherwise, the call will be assigned to the SugarCRM administrator account used in Motion-SugarCRM integration.



This integration works also with Suite CRM!

On this page:







Any interaction occurred through this integration can be searched by the Agent from the list by:

  • contact's phone_home
  • user_name





If all the configurations are properly configured, the sugarCRM call will be opened as shown below.

Please check the version of your SugarCRM instance. Our SugarCRM integration is working correctly and it’s tested with SugarCRM version greater then 6.5.xhttp://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_7.6/API/Web_Services/API_Versioning/



Important configuration Hints

In order to create and assign tasks to agents properly, you have to make sure:


  • Agent Username in the SugarCRM profile is exactly the same as Agent Username in Motion, like shown in the images below

  • the Agent is logged in XCALLY Motion Phonebar, XCALLY Motion web interface and SugarCRM web interface
  • the Agent enables the browser pop-ups, when he/she receives the first call



The SugarCRM Accounts Section

The SugarCRM Accounts Section is under the Integrations Menu:


Create a SugarCRM Account

To create a new SugarCRM Account click on 



Enter the following details and click on Add SugarCRM Account

  • Username: same as a SugarCRM Administrator Account
  • URI: your SugarCRM URL
  • Password: same password as a SugarCRM Administrator Account
  • Motion or Proxy IP Address: written in <protocol>://<ipaddress>[:<port>] form. It is required to use the Recording URL in the sugarCRM call Configuration.   Example: https://X.Y.Z.W   
  • Description (optional)     


After the Account is created, you can view it in the list of accounts, edit the account parameters and remove the account. You can verify if the account credentials are correct by clicking on Test SugarCRM Account.

Edit a SugarCRM Account

Find the account from the accounts list and Click on Edit SugarCRM Account.  

You will see two tabs: Account and Configurations. In the Accounts tab, you can modify the account parameters and in the Configurations tab, you can create, update or delete SugarCRM configurations. 


Create a SugarCRM Configuration

A SugarCRM configuration is used to design the content of the SugarCRM call (Subject, Description and Fields) that is created and displayed for the agent managing calls. You can create multiple configurations for a single SugarCRM Account and use them in different triggers. In this way, you will be able to use different call layout for outbound and inbound calls.

To create a new configuration, edit the SugarCRM account, go under configurations tab and click on 

The configuration will be created with default Subject and Description settings that you can simply use without any modification.

You can also edit the configuration and customize the Subject, Description and Fields of the SugarCRM call according to your needs.


The default Subject and Description settings depends on the type of configuration. For example, the default subject configuration for Queue Type is [XCALLY Ticket] Queue calleridnum while for Outbound Type it's [XCALLY Ticket] Outbound Call destcalleridnum.

Configuration changes are automatically applied, without any service restart.

You can use Motion Standard Variables or Custom Variables in the configuration.

Subjects


By default, you will find the following three fields already configured

  • the String [XCALLY Ticket]
  • the Queue Variable
  • the Caller number Variable

You can add more than one field in the Subject and all fields will be joined by the blank space.

Use button to add a new fields. New fields are added at the end of the field list.

You can insert 3 different type of fields:

  1. String: static string e.g. [XCALLY Ticket]
  2. Variable: Motion System Variable e.g. queue or calleridnum
  3. Custom Variable: dynamic variable created under Tools > Variables

Descriptions



You can add more than one fields in the Description. All fields will be joined by new line.

Use button to add a new fields. New fields will be added at the end of the field list.


You can insert two different type of fields:


  1. String: static string e.g. *** Call Info ***
  2. Key Value: name-value item in the form name: value


where the first field is a static string (e.g. Caller Number) and the second field could be filled with the following:


  • String: static string
  • Variable: System Variable like Caller Number
  • Custom Variable: dynamic variable created under  Tools > Variables

The colon character in the Key Value type is automatically added by the system

Fields



You can add more than one field.

In the drop-down list you can find the complete list of fields available in your SugarCRM account: Standard and Custom Ticket fields.

Choose the field from the list (Standard or Custom):

and define the Type:

  • String: static string (you must insert it)
  • Variable: a System Variable (choose it from the list: e.g. Queue, uniqueid, calleridnum, etc.)
  • Custom Variable: one of the dynamic variables (created under Tools > Variables)
  • Picklist: choose among the list of the integrated Application Fields. You can only select one of the predefined values available for that field (if any).



Create a Trigger 

It is mandatory to create a trigger to make the SugarCRM integration work. Go to Tools -> Triggers Section and click on New Trigger.



Enter the trigger Name, select Voice Channel and click on Add Trigger. 

Edit the trigger to define the trigger's Conditions and Actions.


Do not forget to set the trigger's status ON.

Add Trigger Conditions

You can use properties like Queue, Call status or outbound to define the conditions you want to trigger the SugarCRM integration. The conditions show in the following figure means that the integration will be active for Calls in Sales Queue and when the call is answered. For more information on trigger conditions, take a look at Voice Trigger Conditions.


Add Trigger Action

To execute the SugarCRM integration when the conditions are met, click on Add Action and select Integrations and SugarCRM. You can then select one of the the SugarCRM account you have created and the configuration you want to use.