VOOZH about

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

⇱ DataBind CircleCI Data to the DevExpress Data Grid


DataBind CircleCI 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 CircleCI 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

CircleCI uses personal API tokens to authenticate API requests. To generate a personal API token, log in to your CircleCI account, navigate to User Settings > Personal API Tokens, and click Create New Token. Copy the token value immediately as it is only shown once.

After setting the following connection properties, you are ready to connect:

  • AuthScheme: Set this to APIKey.
  • APIKey: Set this to your CircleCI personal API token.

Example connection string:

Profile=C:\profiles\CircleCI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_api_token';

Windows Forms Controls

The code below shows how to populate a DevExpress chart with CircleCI 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\CircleCI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_api_token';")) {
 APIDataAdapter dataAdapter = new APIDataAdapter(
 "SELECT , FROM Artifacts WHERE ProjectSlug = 'github/MyOrg/my-repo'", 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 CircleCI 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\CircleCI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_personal_api_token';"))
{
 APIDataAdapter APIDataAdapter1 = new APIDataAdapter("SELECT , FROM Artifacts WHERE ProjectSlug = 'github/MyOrg/my-repo'", 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.)