Ready to get started?

Connect to live data from Klipfolio with the API Driver

Connect to Klipfolio

Connect to Klipfolio Data in CloverDX (formerly CloverETL)



Transfer Klipfolio data using the visual workflow in the CloverDX data integration tool.

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

Connect to Klipfolio as a JDBC Data Source

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

    Klipfolio API Profile Settings

    In order to authenticate to Klipfolio, you'll need to provide your API Key. You can generate an API key from the Klipfolio Dashboard app through either the My Profile page or from Users if you are an administrator (you must have the user.manage permission). Set the API Key in the ProfileSettings property to connect.

    Built-in Connection String Designer

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

Query Klipfolio 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 Klipfolio JDBC data source from the drop-down menu.
  3. Enter the SQL query. For example: SELECT Id, Name FROM DataSources WHERE IsDynamic = 'true'

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