We are proud to share our inclusion in the 2024 Gartner Magic Quadrant for Data Integration Tools. We believe this recognition reflects the differentiated business outcomes CData delivers to our customers.
Get the Report →How to connect to SuiteCRM Data in DBVisualizer
Integrate SuiteCRM data with visual data analysis tools and data connection wizards in DBVisualizer
The CData JDBC Driver for SuiteCRM implements JDBC standards to provide connectivity to SuiteCRM data in applications ranging from business intelligence tools to IDEs. This article shows how to establish a connection to SuiteCRM data in DBVisualizer and use the table editor to edit and save SuiteCRM data.
Create a New Driver Definition for SuiteCRM Data
Follow the steps below to use the Driver Manager to provide connectivity to SuiteCRM data from DBVisualizer tools.
- In DBVisualizer, click Tools -> Driver Manager.
- Click the plus sign "" to create a new driver.
- Select "Custom" as the template.
- On the Driver Settings tab:
- Set Name to a user-friendly name (e.g. "CData SuiteCRM Driver")
- Set URL Format to jdbc:suitecrm:
- In Driver artifacts and jar files (jars are loaded in order from top):
- Click the plus sign "" -> "Add Files"
- Navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\)
- Select the JAR file (cdata.jdbc.SuiteCRM.jar) and click "Open"
- The Driver Class should populate automatically. If not, select class (cdata.jdbc.suitecrm.SuiteCRMDriver).

Define the Connection to the JDBC Data Source
Close the "Driver Manager" and follow the steps below to save connection properties in the JDBC URL.
- In the "Databases" tab, click the plus sign "" and select the driver you just created.
In the "Connection" section, set the following options:
- Database Type: If you selected the wizard option, the database type is automatically detected. If you selected the "No Wizard" option, select the Generic or Auto Detect option in the Database Type menu.
- Driver Type: Select the driver you just created.
Database URL: Enter the full JDBC URL. The syntax of the JDBC URL is jdbc:suitecrm: followed by the connection properties in a semicolon-separated list of name-value pairs.
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.
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.
When you configure the JDBC URL, 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.
A typical connection string is below:
jdbc:suitecrm:URL=http://mySuiteCRM.com;User=myUser;Password=myPassword;
- NOTE: Database Userid and Database Password correspond with the User and Password properties for SuiteCRM.
- On the Connection tab, click Connect.
To browse through tables exposed by the SuiteCRM JDBC Driver, right-click a table and click "Open in New Tab."
To execute SQL queries, use the SQL Commander tool: Click SQL Commander -> New SQL Commander. Select the Database Connection, Database, and Schema from the available menus.
See the "Supported SQL" chapter in the help documentation for more information on the supported SQL. See the "Data Model" chapter for table-specific information.
