Analyze Workable Data in Infragistics Reveal

Reveal is a data visualization solution provided by Infragistics and can be paired with the CData API Server to build dynamic dashboards from live Workable data. The CData API Server generates an OData API for Workable, which is natively consumable in Reveal. In this article, we walk through connecting to Workable in API Server and connecting to the API Server from Infragistics Reveal to create a simple dashboard.

Connect to Workable from API Server

CData API Server uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

1. Open API Server and click Settings -> Connection -> Add Connection
2. Select "Workable"
3. Enter the necessary authentication properties to connect to Workable.

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

   

Add Workable Resource Definitions in API Server

After connecting to Workable, create Resources, which represent API endpoints for Workable data.

1. Click Settings -> Resources -> Add Resource
2. Select the Workable connection
3. Select the table you wish to retrieve and click Next
4. (Optional) Edit the resource to select specific fields and more
5. Save the settings

Add an API Server User

Create a User to connect to Workable from Reveal through API Server.

1. Click Settings -> Users
2. Click Add
3. Configure a User with access to the Workable Connection and Resource(s)

(Optional) Configure Cross-Origin Resource Sharing (CORS)

When accessing and connecting to multiple different domains from an application such as Ajax, there is a possibility of violating the limitations of cross-site scripting. In that case, configure the CORS settings in Settings -> Server.

• Enable cross-origin resource sharing (CORS): ON
• Allow all domains without '*': ON
• Access-Control-Allow-Methods: GET, PUT, POST, OPTIONS
• Access-Control-Allow-Headers: Authorization

Save the changes to the settings.

Create a Dashboard in Reveal

With the API Server configured, we can visualize Workable data in Reveal.

1. Log into Reveal and click Dashboards -> New
2. Click Data Source -> OData Feed
3. Specify the API Server API endpoint URL, for example: https://serverurl/api.rsc
4. Select Generic Credentials and specify the API Server username and authentication token
5. Select the entity you wish to visualize
6. Select fields and choose a chart type

More Information & Free Trial

At this point, you have created a simple dashboard from live Workable data. For more information on creating OData feeds from Workable (and more than 150 other sources), visit the API Server page. Download a free, 30-day trial and start working live Workable data in tools that consume OData APIs.