Ready to get started?

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

Download Now

Connect to Sugar CRM Data in CloverDX (formerly CloverETL)

Transfer Sugar CRM data using the visual workflow in the CloverDX data integration tool.

The CData JDBC Driver for Sugar CRM enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Sugar CRM as sources and destinations. In this article, you will use the JDBC Driver for Sugar CRM to set up a simple transfer into a flat file. The CData JDBC Driver for Sugar CRM enables you to use the data transformation components in CloverDX (formerly CloverETL) to work with Sugar CRM as sources and destinations. In this article, you will use the JDBC Driver for Sugar CRM to set up a simple transfer into a flat file.

Connect to Sugar CRM as a JDBC Data Source

  1. Create the connection to Sugar CRM data. In a new CloverDX graph, right-click the Connections node in the Outline pane and click Connections -> Create Connection. The Database Connection wizard is displayed.
  2. Click the plus icon to load a driver from a JAR. Browse to the lib subfolder of the installation directory and select the cdata.jdbc.sugarcrm.jar file.
  3. Enter the JDBC URL.

    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.

    A typical JDBC URL is below:

    jdbc:sugarcrm:User=MyUser;Password=MyPassword;URL=MySugarCRMAccountURL;CacheMetadata=True;

Query Sugar CRM Data with the DBInputTable Component

  1. Drag a DBInputTable from the Readers selection of the Palette onto the job flow and double-click it to open the configuration editor.
  2. In the DB connection property, select the Sugar CRM JDBC data source from the drop-down menu.
  3. Enter the SQL query. For example: SELECT Name, AnnualRevenue FROM Accounts

Write the Output of the Query to a UniversalDataWriter

  1. Drag a UniversalDataWriter from the Writers selection onto the jobflow.
  2. Double-click the UniversalDataWriter to open the configuration editor and add a file URL.
  3. Right-click the DBInputTable and then click Extract Metadata.
  4. Connect the output port of the DBInputTable to the UniversalDataWriter.
  5. In the resulting Select Metadata menu for the UniversalDataWriter, choose the Accounts table. (You can also open this menu by right-clicking the input port for the UniversalDataWriter.)
  6. Click Run to write to the file.