Manage AgileCRM Data in DBArtisan as a JDBC Source

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

Integrate AgileCRM Data into DBArtisan Projects

Follow the steps below to register AgileCRM 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.

   Start by setting the Profile connection property to the location of the AgileCRM Profile on disk (e.g. C:\profiles\Agilecrm.apip). Next, set the ProfileSettings connection property to the connection string for AgileCRM (see below).

   AgileCRM API Profile Settings

   Log in to AgileCRM and go to Admin Settings > Developers & API > REST API to find your API key. Your domain is the subdomain from your AgileCRM account URL.

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.api.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:api:Profile=C:\profiles\Agilecrm.apip;ProfileSettings='APIKey=your_api_key;Domain=your_domain;User=your_email';

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

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