Analyze Sugar CRM Data in R



Create data visualizations and use high-performance statistical functions to analyze Sugar CRM data in Microsoft R Open.

Access Sugar CRM data with pure R script and standard SQL. You can use the CData ODBC Driver for Sugar CRM and the RODBC package to work with remote Sugar CRM data in R. By using the CData Driver, you are leveraging a driver written for industry-proven standards to access your data in the popular, open-source R language. This article shows how to use the driver to execute SQL queries to Sugar CRM data and visualize Sugar CRM data in R.

Install R

You can complement the driver's performance gains from multi-threading and managed code by running the multithreaded Microsoft R Open or by running R linked with the BLAS/LAPACK libraries. This article uses Microsoft R Open (MRO).

Connect to Sugar CRM as an ODBC Data Source

Information for connecting to Sugar CRM follows, along with different instructions for configuring a DSN in Windows and Linux environments.

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.

Windows

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.

Linux

If you are installing the CData ODBC Driver for Sugar CRM in a Linux environment, the driver installation predefines a system DSN. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties.

/etc/odbc.ini

[CData SugarCRM Source] Driver = CData ODBC Driver for Sugar CRM Description = My Description User = MyUser Password = MyPassword URL = MySugarCRMAccountURL CacheMetadata = True

For specific information on using these configuration files, please refer to the help documentation (installed and found online).

Load the RODBC Package

To use the driver, download the RODBC package. In RStudio, click Tools -> Install Packages and enter RODBC in the Packages box.

After installing the RODBC package, the following line loads the package:

library(RODBC)

Note: This article uses RODBC version 1.3-12. Using Microsoft R Open, you can test with the same version, using the checkpoint capabilities of Microsoft's MRAN repository. The checkpoint command enables you to install packages from a snapshot of the CRAN repository, hosted on the MRAN repository. The snapshot taken Jan. 1, 2016 contains version 1.3-12.

library(checkpoint) checkpoint("2016-01-01")

Connect to Sugar CRM Data as an ODBC Data Source

You can connect to a DSN in R with the following line:

conn <- odbcConnect("CData SugarCRM Source")

Schema Discovery

The driver models Sugar CRM APIs as relational tables, views, and stored procedures. Use the following line to retrieve the list of tables:

sqlTables(conn)

Execute SQL Queries

Use the sqlQuery function to execute any SQL query supported by the Sugar CRM API.

accounts <- sqlQuery(conn, "SELECT Name, AnnualRevenue FROM Accounts", believeNRows=FALSE, rows_at_time=1)

You can view the results in a data viewer window with the following command:

View(accounts)

Plot Sugar CRM Data

You can now analyze Sugar CRM data with any of the data visualization packages available in the CRAN repository. You can create simple bar plots with the built-in bar plot function:

par(las=2,ps=10,mar=c(5,15,4,2)) barplot(accounts$AnnualRevenue, main="Sugar CRM Accounts", names.arg = accounts$Name, horiz=TRUE)

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.