Connect to OnePageCrm Data in CloverDX (formerly CloverETL)

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Transfer OnePageCrm data using the visual workflow in the CloverDX data integration tool.

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

Connect to OnePageCrm as a JDBC Data Source

  1. Create the connection to OnePageCrm 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 OnePageCrm Profile on disk (e.g. C:\profiles\OnePageCrm.apip). Next, set the ProfileSettings connection property to the connection string for OnePageCrm (see below).

    OnePageCrm API Profile Settings

    In your OnePageCRM account, go to Apps and Integrations > API (Developer Access) > Configuration to find your User ID and API Key.

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the OnePageCrm 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\OnePageCrm.apip;ProfileSettings='User=your_user_id;Password=your_api_key';

Query OnePageCrm 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 OnePageCrm JDBC data source from the drop-down menu.
  3. Enter the SQL query. For example:
    SELECT Id, ContactId FROM Actions WHERE Status = 'done'

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

Ready to get started?

Connect to live data from OnePageCrm with the API Driver

Connect to OnePageCrm