Manage Workable Data in DBArtisan as a JDBC Source

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

Integrate Workable Data into DBArtisan Projects

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

   Using API Key Authentication

   Workable uses API key authentication to control access to the API. To obtain an API Key:

   1. Log in to your Workable account.
   2. Navigate to Settings > Integrations > API Access Tokens.
   3. Click "Generate API Token".
   4. Copy the generated token.

   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 Workable API Key.
   • Subdomain: Set this to your Workable account subdomain. For example, if your Workable URL is acmeinc.workable.com, then the Subdomain is 'acmeinc'.

   Example Connection String

   Profile=C:\profiles\Workable.apip;ProfileSettings='AuthScheme=APIKey;APIKey=my_api_key;Subdomain=acmeinc';
   

   Built-in Connection String Designer

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

6. Finish the wizard to connect to Workable data. Workable entities are displayed in the Datasource Explorer.

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