Build Dashboards with CircleCI Data in Dundas BI

The CData ODBC Driver for CircleCI enables access to live data from CircleCI under the ODBC standard, allowing you work with CircleCI data in a wide variety of BI, reporting, and ETL tools and directly, using familiar SQL queries. This article shows how to connect to CircleCI data as a generic ODBC Data Provider and create charts, reports, and dashboards based on CircleCI data in Dundas BI.

Connect to CircleCI Data

1. If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can configure the DSN using the built-in Microsoft ODBC Data Source Administrator. This is also the last step of the driver installation. See the "Getting Started" chapter in the Help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.
   
   

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

   When you configure the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

2. Open the Dundas BI interface, open the menu, and click New Data Connector.
3. Configure the Dundas BI Data Connector:
   • Name the Data Connector.
   • Select "ODBC generic" as the Data Provider.
   • Check the "Use System DSN" checkbox.
   • Select the appropriate System DSN.
   

Add CircleCI Data to a Dashboard

You are now ready to create a dashboard with CircleCI data.

1. Navigate to the Home page.
2. Click Explore Data.

3. Expand the appropriate Data Connector.
4. Drag the relevant data from the Connector to the panel.
   • You can select an entire "table" to add, but you may need to remove Measures/Rows from the Metric Set to build an appropriate visualization. Alternatively, you can select only the fields you wish to include in the visualization.
   • With the fields selected, you can add any filters or conditions on the Measures and Rows, further customizing the visualization.

5. Click Re-visualize from the menu bar and select the appropriate visualization for the data.

6. Click Add To New Dashboard to add the visualization to a new dashboard.

7. Configure the dashboard, creating dynamic visualizations of CircleCI data.