Manage Zenefits Data in DBArtisan as a JDBC Source

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

Integrate Zenefits Data into DBArtisan Projects

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

   Zenefits API Profile Settings

   In order to authenticate to Zenefits, you'll need to provide your API Key. To create an API Key, from your account head over to Company Overview > Custom Integrations, then besides Rest API Access select Add Token. 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 Zenefits 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\Zenefits.apip;ProfileSettings='APIKey=my_api_token';
6. Finish the wizard to connect to Zenefits data. Zenefits entities are displayed in the Datasource Explorer.

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