Rapidly Develop Workable-Driven Apps with Active Query Builder

Write standard .NET to expose Workable data through an SQL interface: Active Query Builder helps developers write SQL interfaces; the CData ODBC Driver for Workable enables standards-based access to Workable. This integration uses the Microsoft ADO.NET Provider for ODBC as a bridge between the ODBC Driver and the Active Query Builder objects to build a visual SQL composer.

Connect to Workable as an ODBC Data Source

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.

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

Use SQL to Interact with Workable

Follow the steps below to create a WinForms visual query builder.

1. Open Active Query Builder for .NET WinForms.
2. In the new Windows Forms project go to the "File" menu and click "Connect..."
3. Under Database Connections, click "Add..."
4. Set your desired Connection Name (e.g. CData Workable), set Connection Type to "ODBC" and locate your previously configured DSN in the "User/System" DSN dropdown.
5. Click "OK" to save the new connection.
6. Back in the Database Connection wizard, select the newly created connection and click "OK."
7. Click "File" > "New Query" to create a QueryBuilder

You can now build queries visually: Double-click a table in the Columns Pane Area and an entity/relationship diagram is displayed in the Query Building Area. Columns that you select in the diagram are added to the query.