Connect to Respond.io Data in CloverDX (formerly CloverETL)

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

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

Connect to Respond.io as a JDBC Data Source

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

    Respondio API Profile Settings

    Respond.io uses API key authentication. To obtain an API key:

    1. Log in to your Respond.io account.
    2. Navigate to Settings in your workspace.
    3. Select Developer under the Integrations section.
    4. Copy the API key displayed on the page.

    After obtaining your API key, set the following connection properties:

    • AuthScheme: Set this to APIKey.

    Set the following in the ProfileSettings connection property:

    • APIKey: Set this to your Respond.io API key.

    Built-in Connection String Designer

    For assistance in constructing the JDBC URL, use the connection string designer built into the Respond.io 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.

    Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

    A typical JDBC URL is below:

    jdbc:api:Profile=C:\profiles\Respondio.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';
Required connection properties specified in the JDBC URL. (Salesforce is shown.)

Query Respond.io 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 Respond.io JDBC data source from the drop-down menu.
  3. Enter the SQL query. For example:
    SELECT Id, Email FROM Contacts WHERE Identifier = 'id:438180634'

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

Ready to get started?

Connect to live data from Respond.io with the API Driver

Connect to Respond.io