VOOZH about

URL: https://www.cdata.com/kb/tech/workable-ado-devexpress.rst

⇱ DataBind Workable Data to the DevExpress Data Grid


DataBind Workable Data to the DevExpress Data Grid

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use the CData API Driver for ADO.NET with the DevExpress Windows Forms and Web controls to provide Workable data to a chart.

The CData API Driver for ADO.NET incorporates conventional ADO.NET data access components compatible with third-party controls. You can adhere to the standard ADO.NET data binding procedures to establish two-way access to real-time data through UI controls. This article will demonstrate the utilization of CData components for data binding with DevExpress UI Controls (Windows Forms and Web controls), specifically binding to a chart that visualizes live data.

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

Windows Forms Controls

The code below shows how to populate a DevExpress chart with Workable data. The APIDataAdapter binds to the Series property of the chart control. The Diagram property of the control defines the x- and y-axes as the column names.

using (APIConnection connection = new APIConnection(
"Profile=C:\profiles\Workable.apip;ProfileSettings='AuthScheme=APIKey;APIKey=my_api_key;Subdomain=acmeinc';")) {
 APIDataAdapter dataAdapter = new APIDataAdapter(
 "SELECT , FROM Accounts WHERE = ''", connection);
 
 DataTable table = new DataTable();
 dataAdapter.Fill(table);
 DevExpress.XtraCharts.Series series = new DevExpress.XtraCharts.Series();
 chartControl1.Series.Add(series);
 series.DataSource = table;
 series.ValueDataMembers.AddRange(new string[] { "" });
 series.ArgumentScaleType = DevExpress.XtraCharts.ScaleType.Qualitative;
 series.ArgumentDataMember = "";
 series.ValueScaleType = DevExpress.XtraCharts.ScaleType.Numerical;
 chartControl1.Legend.Visibility = DevExpress.Utils.DefaultBoolean.False;
 ((DevExpress.XtraCharts.SideBySideBarSeriesView)series.View).ColorEach = true; 
}
👁 The complete code example and the resulting chart.

Web Controls

The code below shows how to populate a DevExpress Web control with Workable data. The APIDataAdapter binds to the Series property of the chart; the Diagram property defines the x- and y-axes as the column names.

using DevExpress.XtraCharts;

using (APIConnection connection = new APIConnection(
"Profile=C:\profiles\Workable.apip;ProfileSettings='AuthScheme=APIKey;APIKey=my_api_key;Subdomain=acmeinc';"))
{
 APIDataAdapter APIDataAdapter1 = new APIDataAdapter("SELECT , FROM Accounts WHERE = ''", connection);
 DataTable table = new DataTable();
 APIDataAdapter1.Fill(table);
 DevExpress.XtraCharts.Series series = new Series("Series1", ViewType.Bar);
 WebChartControl1.Series.Add(series);
 series.DataSource = table;
 series.ValueDataMembers.AddRange(new string[] { "" });
 series.ArgumentScaleType = ScaleType.Qualitative;
 series.ArgumentDataMember = "";
 series.ValueScaleType = ScaleType.Numerical;
 ((DevExpress.XtraCharts.SideBySideBarSeriesView)series.View).ColorEach = true;
}
👁 An ASP.NET application created with the ADO.NET Provider and the DevExpress Web Forms control. (Salesforce is shown.)