VOOZH about

URL: https://www.cdata.com/kb/tech/workable-odbc-dbartisan.rst

⇱ Connect to Workable Data in DBArtisan

Connect to Workable Data in DBArtisan

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use wizards in DBArtisan to configure Workable data as a data source.

The CData ODBC 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 an data source for Workable in DBArtisan and execute queries. You can then edit data visually and execute standard SQL.

Integrate Workable Data into DBArtisan Projects

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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';

You can then 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 ODBC.
  3. Enter a name for the data source and select the DSN. 👁 The DSN of the data source to be registered. (Salesforce is shown.)
  4. Finish the wizard to connect to Workable data. Workable entities are displayed in the Datasource Explorer. 👁 The Datasource Explorer. (Salesforce is shown.)

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.

👁 The results of a query. (Salesforce is shown.)