How to integrate Metabase with Sugar CRM Data

Metabase is an open source data visualization tool that allows users to create interactive dashboards. When paired with CData Connect AI, users can easily create visualizations and dashboards linked to live Sugar CRM data. This article describes how to connect to Sugar CRM and build a simple visualization using Sugar CRM data.

CData Connect provides a pure cloud-to-cloud interface for Sugar CRM, allowing you to easily integrate with live Sugar CRM data in Metabase — without replicating the data. Connect looks exactly like a SQL Server database to Metabase and uses optimized data processing out of the box to push all supported SQL operations (filters, JOINs, etc) directly to Sugar CRM, leveraging server-side processing to quickly return Sugar CRM data.

Configure Sugar CRM Connectivity for Metabase

Connectivity to Sugar CRM from Metabase is made possible through CData Connect AI. To work with Sugar CRM data from Metabase, we start by creating and configuring a Sugar CRM connection.

1. Log into Connect AI, click Sources, and then click Add Connection
👁 Adding a Connection

2. Select "Sugar CRM" from the Add Connection panel
👁 Selecting a data source

3. Enter the necessary authentication properties to connect to Sugar CRM.

   The User and Password properties, under the Authentication section, must be set to valid SugarCRM user credentials. This will use the default OAuth token created to allow client logins. OAuthClientId and OAuthClientSecret are required if you do not wish to use the default OAuth token.

   You can generate a new OAuth consumer key and consumer secret in Admin -> OAuth Keys. Set the OAuthClientId to the OAuth consumer key. Set the OAuthClientSecret to the consumer secret.

   Additionally, specify the URL to the SugarCRM account.

   Note that retrieving SugarCRM metadata can be expensive. It is advised that you store the metadata locally as described in the "Caching Metadata" chapter of the help documentation.

   👁 Configuring a connection (Salesforce is shown)
   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add Sugar CRM Connection page and update the User-based permissions. 👁 Updating permissions
   

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create. 👁 Creating a new PAT
   
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to Sugar CRM data from Metabase.

Connect to CData Connect AI from Metabase

After creating the connection in Connect AI, navigate to your Metabase instance. Use the SQL Server interface to connect to Connect AI.

1. Navigate to the administration screen (Settings -> Admin) and click "Add Database" from the "Databases" tab 👁 Adding a new database connection to Metabase.
   
2. Configure the connection to Connect AI and click "Save"
   • Database type: Select "SQL Server"
   • Name: Name the connection (e.g. "Sugar CRM (Connect AI)")
   • Host: tds.cdata.com
   • Port: 14333
   • Database name: The name of the connection you just created (e.g. SugarCRM1)
   • Username: A Connect AI username (e.g. [email protected])
   • Password: The PAT previously created
   • Click to Use a secure connection (SSL)
   👁 Configuring the connection to Connect AI.
   

Execute Sugar CRM Data with Metabase

Once you configure the connection to Connect AI, you can query Sugar CRM and build visualizations.

1. Use the "Write SQL" tool to retrieve the Sugar CRM data 👁 Click the 'Write SQL' button.
   
2. Write a SQL query based on the Sugar CRM connection in CData Connect AI, e.g.
   
   

   SELECT Name, AnnualRevenue FROM Accounts

   👁 Collected data (Salesforce is shown).
   
3. Navigate to the "Visualization" screen, choose a visualization, and configure the visualization 👁 Collected data (Salesforce is shown).
   

More Information & Free Trial

At this point, you have built a simple visualization from Sugar CRM data in Metabase. You can continue to work with live Sugar CRM data in Metabase just like you would any SQL Server database. For more information on creating a live connection to Sugar CRM (and more than 100 other data sources), visit the Connect AI page. Sign up for a free trial and start working with live Sugar CRM data in Metabase today.