Ready to get started?

Learn more about the CData JDBC Driver for Sugar or download a free trial:

Download Now

ETL Sugar CRM in Oracle Data Integrator

This article shows how to transfer Sugar CRM data into a data warehouse using Oracle Data Integrator.

Leverage existing skills by using the JDBC standard to read and write to Sugar CRM: Through drop-in integration into ETL tools like Oracle Data Integrator (ODI), the CData JDBC Driver for Sugar CRM connects real-time Sugar CRM data to your data warehouse, business intelligence, and Big Data technologies.

JDBC connectivity enables you to work with Sugar CRM just as you would any other database in ODI. As with an RDBMS, you can use the driver to connect directly to the Sugar CRM APIs in real time instead of working with flat files.

This article walks through a JDBC-based ETL -- Sugar CRM to Oracle. After reverse engineering a data model of Sugar CRM entities, you will create a mapping and select a data loading strategy -- since the driver supports SQL-92, this last step can easily be accomplished by selecting the built-in SQL to SQL Loading Knowledge Module.

Install the Driver

To install the driver, copy the driver JAR and .lic file, located in the installation folder, into the ODI userlib directory:

On Unix: ~/.odi/oracledi/userlib On Windows: %APPDATA%\Roaming\odi\oracledi\userlib

Restart ODI to complete the installation.

Reverse Engineer a Model

Reverse engineering the model retrieves metadata about the driver's relational view of Sugar CRM data. After reverse engineering, you can query real-time Sugar CRM data and create mappings based on Sugar CRM tables.

  1. In ODI, connect to your repository and click New -> Model and Topology Objects.
  2. On the Model screen of the resulting dialog, enter the following information:
    • Name: Enter SugarCRM.
    • Technology: Select Generic SQL.
    • Logical Schema: Enter SugarCRM.
    • Context: Select Global.
  3. On the Data Server screen of the resulting dialog, enter the following information:
    • Name: Enter SugarCRM.
    • Driver List: Select Oracle JDBC Driver.
    • Driver: Enter cdata.jdbc.sugarcrm.SugarCRMDriver
    • URL: Enter the JDBC URL containing the connection string.

      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.

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the Sugar CRM JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.sugarcrm.jar

      Fill in the connection properties and copy the connection string to the clipboard.

      Below is a typical connection string:

      jdbc:sugarcrm:User=MyUser;Password=MyPassword;URL=MySugarCRMAccountURL;CacheMetadata=True;
  4. On the Physical Schema screen, enter the following information:
    • Schema (Schema): Enter SugarCRM.
    • Schema (Work Schema): Enter SugarCRM.
  5. In the opened model click Reverse Engineer to retrieve the metadata for Sugar CRM tables.

Edit and Save Sugar CRM Data

After reverse engineering you can now work with Sugar CRM data in ODI. To edit and save Sugar CRM data, expand the Models accordion in the Designer navigator, right-click a table, and click Data. Click Refresh to pick up any changes to the data. Click Save Changes when you are finished making changes.

Create an ETL Project

Follow the steps below to create an ETL from Sugar CRM. You will load Accounts entities into the sample data warehouse included in the ODI Getting Started VM.

  1. Open SQL Developer and connect to your Oracle database. Right-click the node for your database in the Connections pane and click new SQL Worksheet.

    Alternatively you can use SQLPlus. From a command prompt enter the following:

    sqlplus / as sysdba
  2. Enter the following query to create a new target table in the sample data warehouse, which is in the ODI_DEMO schema. The following query defines a few columns that match the Accounts table in Sugar CRM: CREATE TABLE ODI_DEMO.TRG_ACCOUNTS (ANNUALREVENUE NUMBER(20,0),Name VARCHAR2(255));
  3. In ODI expand the Models accordion in the Designer navigator and double-click the Sales Administration node in the ODI_DEMO folder. The model is opened in the Model Editor.
  4. Click Reverse Engineer. The TRG_ACCOUNTS table is added to the model.
  5. Right-click the Mappings node in your project and click New Mapping. Enter a name for the mapping and clear the Create Empty Dataset option. The Mapping Editor is displayed.
  6. Drag the TRG_ACCOUNTS table from the Sales Administration model onto the mapping.
  7. Drag the Accounts table from the Sugar CRM model onto the mapping.
  8. Click the source connector point and drag to the target connector point. The Attribute Matching dialog is displayed. For this example, use the default options. The target expressions are then displayed in the properties for the target columns.
  9. Open the Physical tab of the Mapping Editor and click ACCOUNTS_AP in TARGET_GROUP.
  10. In the ACCOUNTS_AP properties, select LKM SQL to SQL (Built-In) on the Loading Knowledge Module tab.

You can then run the mapping to load Sugar CRM data into Oracle.