> ## Documentation Index
> Fetch the complete documentation index at: https://domoinc-openapi-sync-dataflows.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# SugarCRM Connector

## Intro

SugarCRM produces the web application Sugar, a customer relationship management system that is available in both open-source and commercial open-source applications. You can use Domo's SugarCRM connector to retrieve data about employees, notifications, records by module, and more. To learn more about the SugarCRM API, visit their website. ([http://support.sugarcrm.com/Document...ces/index.html](http://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_7.8/Integration/Web_Services/index.html "http://support.sugarcrm.com/Documentation/Sugar_Developer/Sugar_Developer_Guide_7.8/Integration/Web_Services/index.html") ).

The SugarCRM connector is a "Cloud App" connector, meaning it retrieves data stored in the cloud. In the Data Center, you can access the connector page for this and other Cloud App connectors by clicking **Cloud App** in the toolbar at the top of the window.

You connect to your SugarCRM account in the Data Center. This topic discusses the fields and menus that are specific to the SugarCRM connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in [Adding a DataSet Using a Data Connector](/s/article/360042926274 "Adding a DataSet Using a Data Connector").

<table class="mt-responsive-table" data-aura-rendered-by="33:195;a"><tbody><tr><td class="mt-noheading" colspan="1" rowspan="1"><p><b> Primary Use Cases </b></p></td><td class="mt-noheading" colspan="1" rowspan="1"><ul><li><p> Lead management </p></li><li><p> Pipeline management </p></li><li><p> Sales management </p></li><li><p> Customer relationship management </p></li></ul></td></tr><tr><td class="mt-noheading" colspan="1" rowspan="1"><p><b> Primary Metrics </b></p></td><td class="mt-noheading" colspan="1" rowspan="1"><ul><li><p> Leads </p></li><li><p> MQL </p></li><li><p> SAO </p></li><li><p> Closed Deals </p></li><li><p> Won Deals </p></li><li><p> Average Deal Size </p></li><li><p> Open Opportunities </p></li></ul></td></tr><tr><td class="mt-noheading" colspan="1" rowspan="1"><p><b> Primary Company Roles </b></p></td><td class="mt-noheading" colspan="1" rowspan="1"><p> Marketing, sales </p></td></tr><tr><td class="mt-noheading" colspan="1" rowspan="1"><p><b> Average Implementation Time </b></p></td><td class="mt-noheading" colspan="1" rowspan="1"><p> 10-15 hours </p></td></tr><tr><td class="mt-noheading" colspan="1" rowspan="1"><p><b> Ease of Use (on a 1-to-10 scale with 1 being easiest) </b></p></td><td class="mt-noheading" colspan="1" rowspan="1"><p> 5 </p></td></tr></tbody></table>

## Prerequisites

To connect to your company SugarCRM instance and create a DataSet, you must have the following:

* The host URL for your company's SugarCRM instance
* Your SugarCRM username and password
* Your SugarCRM client ID (which you can find in the SugarCRM Admin page under **OAuth Keys**; sugar is the default client ID for API access)

## Connecting to Your SugarCRM Account

This section enumerates the options in the **Credentials** and **Details** panes in the SugarCRM Connector page. The components of the other panes in this page, **Scheduling** and **Name & Describe Your DataSet**, are universal across most connector types and are discussed in greater length in [Adding a DataSet Using a Data Connector](/s/article/360042926274 "Adding a DataSet Using a Data Connector").

## Credentials Pane

This pane contains fields for entering credentials to connect to your SugarCRM account. The following table describes what is needed for each field:

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:195;a"><thead><tr><th colspan="1" rowspan="1"><p> Field/Menu </p></th><th colspan="1" rowspan="1"><p> Description </p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><p> Username </p></td><td colspan="1" rowspan="1"><p> Enter your SugarCRM username. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Password </p></td><td colspan="1" rowspan="1"><p> Enter your SugarCRM password. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Host </p></td><td colspan="1" rowspan="1"><p> Enter the host URL for your company's SugarCRM instance. For example: <span class="nowiki"><span class="mt-font-courier-new"><a href="https://domo.sugarondemand.com" rel="noopener" target="_blank"> [https://domo.sugarondemand.com](https://domo.sugarondemand.com) </a></span></span></p></td></tr><tr><td colspan="1" rowspan="1"><p> Client ID </p></td><td colspan="1" rowspan="1"><p> Enter your SugarCRM client ID (<span class="mt-font-courier-new"> sugar </span> is the default client ID for API access). </p></td></tr></tbody></table>

Once you have entered valid SugarCRM credentials, you can use the same account any time you go to create a new SugarCRM DataSet. You can manage connector accounts in the Accounts tab in the Data Center. For more information about this tab, see [Managing User Accounts for Connectors](/s/article/360042926054 "Managing User Accounts for Connectors").

## Details Pane

This pane contains a primary **Report** menu, along with various other menus that may or may not appear depending on your selected report.

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:195;a"><thead><tr><th colspan="1" rowspan="1"><p> Menu </p></th><th colspan="1" rowspan="1"><p> Description </p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><p> Report </p></td><td colspan="1" rowspan="1"><p> Select a SugarCRM report. The following reports are available: </p><table border="1" cellpadding="1" cellspacing="1"><tbody><tr><td colspan="1" rowspan="1"><p> Dashboards </p></td><td colspan="1" rowspan="1"><p> Returns the authenticated user's dashboards. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Employees </p></td><td colspan="1" rowspan="1"><p> Returns a list of employees. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Notifications </p></td><td colspan="1" rowspan="1"><p> Returns a list of notifications. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Records by Module </p></td><td colspan="1" rowspan="1"><p> Returns a list of records for the selected module. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Users </p></td><td colspan="1" rowspan="1"><p> Returns a list of users. </p></td></tr></tbody></table><p /></td></tr><tr><td colspan="1" rowspan="1"><p> Select the Module </p></td><td colspan="1" rowspan="1"><p> Select the module with data you want to extract. If your module is not listed, enter the name of the desired module in the <b> Module Name </b> field. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Module Name (Optional) </p></td><td colspan="1" rowspan="1"><p> If your desired module is not listed in the module list, enter the name here. This name is case-sensitive. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Select the Fields </p></td><td colspan="1" rowspan="1"><p> Select the fields to retrieve for each record. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Additional Field Names to Retrieve </p></td><td colspan="1" rowspan="1"><p> Enter a comma-separated list of names of additional fields you want to retrieve. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Deleted Records </p></td><td colspan="1" rowspan="1"><p> Select <b> Yes </b> to import deleted records in your report; otherwise select <b> No </b>. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Select the Date Filter </p></td><td colspan="1" rowspan="1"><p> Select the date field you want to filter data on. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Duration </p></td><td colspan="1" rowspan="1"><p> Select whether you want to pull data for a specific date or a date range. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Report Date </p></td><td colspan="1" rowspan="1"><p> Select whether the report data is for a specific date or for a relative number of days back from today. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Select Specific Date </p></td><td colspan="1" rowspan="1"><p> Select the date for the report. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Days Back </p></td><td colspan="1" rowspan="1"><p> Enter the number of past days that should appear in the report. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Start Date </p></td><td colspan="1" rowspan="1"><p> Specify whether the first date in your date range is a specific or relative date. You select the last date in your range in <b> End Date </b>. </p></td></tr><tr><td colspan="1" rowspan="1"><p> End Date </p></td><td colspan="1" rowspan="1"><p> Specify whether the second date in your date range is a specific or relative date. You select the first date in your range in <b> Start Date </b>. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Select Specific Start Date </p></td><td colspan="1" rowspan="1"><p> Select the first date in your date range. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Select Specific End Date </p></td><td colspan="1" rowspan="1"><p> Select the second date in your date range. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Days Back to Start From </p></td><td colspan="1" rowspan="1"><p> Enter the number of the farthest day back that should be represented in the report. Combine with <b> Days Back to End At </b> to create a range of represented days. </p><p> For example, if you entered <span class="mt-font-courier-new"> 10 </span> for <b> Days Back to Start From </b> and <span class="mt-font-courier-new"> 5 </span> for <b> Days Back to End At </b>, the report would contain data for 10 days ago up until 5 days ago. </p></td></tr><tr><td colspan="1" rowspan="1"><p> Days Back to End At </p></td><td colspan="1" rowspan="1"><p> Enter the number of the most recent day back that should be represented in the report. Combine with <b> Days Back to Start From </b> to create a range of represented days. </p><p> For example, if you entered <span class="mt-font-courier-new"> 10 </span> for <b> Days Back to Start From </b> and <span class="mt-font-courier-new"> 5 </span> for <b> Days Back to End At </b>, the report would contain data for 10 days ago up until 5 days ago. </p></td></tr></tbody></table>

## Other Panes

For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see [a DataSet Using a Data Connector](/s/article/360042926274 "Adding a DataSet Using a Data Connector").
