Ready to get started?

Download a free trial of the Sugar ODBC Driver to get started:

 Download Now

Learn more:

Sugar Icon Sugar ODBC Driver

The Sugar ODBC Driver is a powerful tool that allows you to connect with live Sugar account data, directly from any applications that support ODBC connectivity.

Access CRM data like you would a database - read, write, and update Leads, Contacts, Opportunities, Accounts, etc. through a standard ODBC Driver interface.

Create an SAP BusinessObjects Universe on the CData ODBC Driver for Sugar CRM



Provide connectivity to Sugar CRM data through an SAP BusinessObjects universe.

This article shows how to create and publish an SAP BusinessObjects universe on the CData ODBC Driver for Sugar CRM. You will connect to Sugar CRM data from the Information Design Tool as well as the Web Intelligence tool.

Connect to Sugar CRM as an ODBC Data Source

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

When you configure the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

Create an ODBC Connection to Sugar CRM Data

This section shows how to create a connection to the Sugar CRM ODBC data source in the Information Design Tool. After you create a connection, you can analyze data or create a BusinessObjects universe.

  1. Right-click your project and click New -> New Relational Connection.

  2. In the wizard that is displayed, enter a name for the connection.
  3. Select Generic -> Generic ODBC datasource -> ODBC Drivers and select the DSN.

  4. Finish the wizard with the default values for connection pooling and custom parameters.

Analyze Sugar CRM Data in the Information Design Tool

In the Information Design Tool, you can use both published and local ODBC connections to browse and query data.

  1. In the Local Projects view, double-click the connection (the .cnx file) to open the Sugar CRM data source.

  2. On the Show Values tab, you can load table data and enter SQL queries. To view table data, expand the node for the table, right-click the table, and click Show Values. Values will be displayed in the Raw Data tab.

  3. On the Analysis tab, you can drag and drop columns onto the axes of a chart.

Publish the Local Connection

To publish the universe to the CMS, you additionally need to publish the connection.

  1. In the Local Projects view, right-click the connection and click Publish Connection to a Repository.

  2. Enter the host and port of the repository and connection credentials.

  3. Select the folder where the connection will be published.

  4. In the success dialog that results, click Yes to create a connection shortcut.

Create a Universe on the ODBC Driver for Sugar CRM

You can follow the steps below to create a universe on the ODBC driver for Sugar CRM. The universe in this example will be published to a repository, so it uses the published connection created in the previous step.

  1. In the Information Design Tool, click File->New Universe.

  2. Select your project.

  3. Select the option to create the universe on a relational data source.

  4. Select the shortcut to the published connection.

  5. Enter a name for the Data Foundation.

  6. Import tables and columns that you want to access as objects.

  7. Enter a name for the Business Layer.

Publish the Universe

You can follow the steps below to publish the universe to the CMS.

  1. In the Local Projects view, right-click the business layer and click Publish -> To a Repository.

  2. In the Publish Universe dialog, enter any integrity checks before importing.

  3. Select or create a folder on the repository where the universe will be published.

Query Sugar CRM Data in Web Intelligence

You can use the published universe to connect to Sugar CRM in Web Intelligence.

  1. Open Web Intelligence from the BusinessObjects launchpad and create a new document.

  2. Select the Universe option for the data source.

  3. Select the Sugar CRM universe. This opens a Query Panel. Drag objects to the Result Objects pane to use them in the query.