Connect to AgileCRM Data in CloverDX (formerly CloverETL)

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

Connect to AgileCRM as a JDBC Data Source

1. Create the connection to AgileCRM 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.api.jar file.
3. Enter 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.

   

   A typical JDBC URL is below:

   jdbc:api:Profile=C:\profiles\Agilecrm.apip;ProfileSettings='APIKey=your_api_key;Domain=your_domain;User=your_email';

Query AgileCRM 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 AgileCRM JDBC data source from the drop-down menu.
3. Enter the SQL query. For example:

   SELECT Id, Name FROM Campaigns WHERE IsDisabled = 'false'

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 Campaigns table. (You can also open this menu by right-clicking the input port for the UniversalDataWriter.)
6. Click Run to write to the file.