Integrate SuiteCRM with External Services using SnapLogic

Ready to get started?

Download for a free trial:

Download Now

Learn more:

SuiteCRM JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with SuiteCRM account data including Leads, Contacts, Opportunities, Accounts, and more!



Use the CData JDBC Driver for SuiteCRM in SnapLogic to integrate SuiteCRM with External Services.

SnapLogic is an integration platform-as-a-service (iPaaS) that allows users to create data integration flows with no code. When paired with the CData JDBC Drivers, users get access to live data from more than 250+ SaaS, Big Data and NoSQL sources, including SuiteCRM, in their SnapLogic workflows.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live SuiteCRM data. When platforms issue complex SQL queries to SuiteCRM, the driver pushes supported SQL operations, like filters and aggregations, directly to SuiteCRM and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying lets you work with SuiteCRM data using native data types.

Connect to SuiteCRM in SnapLogic

To connect to SuiteCRM data in SnapLogic, download and install the CData SuiteCRM JDBC Driver. Follow the installation dialog. When the installation is complete, the JAR file can be found in the installation directory (C:/Program Files/CData/CData JDBC Driver for SuiteCRM/lib by default).

Upload the SuiteCRM JDBC Driver

After installation, upload the JDBC JAR file to a location in SnapLogic (for example, projects/Jerod Johnson) from the Manager tab.

Configure the Connection

Once the JDBC Driver is uploaded, we can create the connection to SuiteCRM.

  1. Navigate to the Designer tab
  2. Expand "JDBC" from Snaps and drag a "Generic JDBC - Select" snap onto the designer
  3. Click Add Account (or select an existing one) and click "Continue"
  4. In the next form, configure the JDBC connection properties:
    • Under JDBC JARs, add the JAR file we previously uploaded
    • Set JDBC Driver Class to cdata.jdbc.suitecrm.SuiteCRMDriver
    • Set JDBC URL to a JDBC connection string for the SuiteCRM JDBC Driver, for example: jdbc:suitecrm:URL=http://mySuiteCRM.com;User=myUser;Password=myPassword;RTK=XXXXXX;

      NOTE: RTK is a trial or full key. Contact our Support team for more information.

      Built-In Connection String Designer

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

      java -jar cdata.jdbc.suitecrm.jar

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

      The User and Password properties must be set to valid SuiteCRM user credentials. Additionally, specify the URL to the SuiteCRM application, for example http://suite.crm.com.

      Note that retrieving SuiteCRM metadata can be expensive. It is advised that you store the metadata locally as described in the Caching Metadata section of the data provider help documentation.

  5. After entering the connection properties, click "Validate" and "Apply"

Read SuiteCRM Data

In the form that opens after validating and applying the connection, configure your query.

  • Set Schema name to "SuiteCRM"
  • Set Table name to a table for SuiteCRM using the schema name, for example: "SuiteCRM"."Accounts" (use the drop-down to see the full list of available tables)
  • Add Output fields for each item you wish to work with from the table

Save the Generic JDBC - Select snap.

With connection and query configured, click the end of the snap to preview the data (highlighted below).

Once you confirm the results are what you expect, you can add additional snaps to funnel your SuiteCRM data to another endpoint.

Piping SuiteCRM Data to External Services

For this article, we will load data in a Google Spreadsheet. You can use any of the supported snaps, or even use a Generic JDBC snap with another CData JDBC Driver, to move data into an external service.

  1. Start by dropping a "Worksheet Writer" snap onto the end of the "Generic JDBC - Select" snap.
  2. Add an account to connect to Google Sheets
  3. Configure the Worksheet Writer snap to write your SuiteCRM data to a Google Spreadsheet

You can now execute the fully configured pipeline to extract data from SuiteCRM and push it into a Google Spreadsheet.

Piping External Data to SuiteCRM

As mentioned above, you can also use the JDBC Driver for SuiteCRM in SnapLogic to write data to SuiteCRM. Start by adding a Generic JDBC - Insert or Generic JDBC - Update snap to the dashboard.

  1. Select the existing "Account" (connection) or create a new one
  2. Configure the query:
    • Set Schema name to "SuiteCRM"
    • Set Table name to a table for SuiteCRM using the schema name, for example: "SuiteCRM"."Accounts" (use the drop-down to see the full list of available tables)
  3. Save the Generic JDBC - Insert/Update snap

At this point, you have configured a snap to write data to SuiteCRM, inserting new records or updating existing ones.

More Information & Free Trial

Using the CData JDBC Driver for SuiteCRM you can create a pipeline in SnapLogic for integrating SuiteCRM data with external services. For more information about connecting to SuiteCRM, check at our SuiteCRM connectivity page. Download a free, 30 day trial of the CData JDBC Driver for SuiteCRM and get started today.