Viewing Workable Data in RAD Studio Data Explorer

Embarcadero RAD Studio provides a development environment for Delphi and C++Builder applications. With the CData ODBC Driver for Workable, you gain access to live Workable data within RAD Studio, abstracting the data into tables, views, and stored procedures that can be used to both retrieve Workable data. This article will walk through connecting to Workable using the Data Explorer.

Configure a Connection to Workable

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

Connecting to Workable Data Using Data Explorer

You can create a simple application for displaying Workable data by utilizing the CData FireDAC Components for Workable and a new VCL Forms Application:

1. Open the Data Explorer in RAD Studio and expand FireDAC.
2. Right-click the ODBC Data Source node in the Data Explorer.
3. Click Add New Connection.
4. Enter a name for the connection.
5. In the FireDAC Connection Editor that appears, set the DataSource property to the name of the ODBC DSN for Workable.
6. Back in the Data Explorer, expand the views for the connection.

7. Create a new VCL Forms application and drag a view (for example: Accounts) onto the form.

   
8. Select the AccountsView object on the form and set the Active property to true.

9. Right-click on the object, bind visually, and link everything (*) to a new control (TStringGrid).

   

10. Arrange the TStringGrid on the form and run the application to see the Accounts data.

    

Related Articles

Below you can find other articles for using the CData ODBC Driver with RAD Studio, Delphi, and C++ Builder.

• DataBind Controls to Workable Data in C++Builder
• DataBind Controls to Workable Data in Delphi
• Build a Simple VCL Application for Workable Data