Manage Klipfolio Data in DBArtisan as a JDBC Source

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

Integrate Klipfolio Data into DBArtisan Projects

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

   Below is a typical connection string:

   jdbc:api:Profile=C:\profiles\Klipfolio.apip;ProfileSettings='APIKey=your_api_key';
6. Finish the wizard to connect to Klipfolio data. Klipfolio entities are displayed in the Datasource Explorer.

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