Manage SuiteCRM Data in DBArtisan as a JDBC Source

The CData JDBC Driver for SuiteCRM seamlessly integrates SuiteCRM data into database management tools like DBArtisan by enabling you to access SuiteCRM data as a database. This article shows how to create a JDBC source for SuiteCRM in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate SuiteCRM Data into DBArtisan Projects

Follow the steps below to register SuiteCRM data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory. 👁 The JDBC driver definition in the Register Datasource wizard. (Salesforce is shown.)
   
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   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.

   👁 Required JDBC connection properties in the Register Datasource wizard. (Salesforce is shown.)
   

   Below is a typical connection string:

   jdbc:suitecrm:URL=http://mySuiteCRM.com;User=myUser;Password=myPassword;

6. Finish the wizard to connect to SuiteCRM data. SuiteCRM entities are displayed in the Datasource Explorer.

You can now work with SuiteCRM data as you work with any other database. See the driver help documentation for more information on the queries supported by the SuiteCRM API.