Connecting Bold BI to Azure DevOps data source

Bold BI dashboard designer supports connecting Azure DevOps web services through REST API.

Choose Azure DevOps data source

To configure the Azure DevOps data source, follow the below steps:

  1. Click the Data Sources button in the configuration panel to add a new data connection.

    Data source icon

  2. Click CREATE NEW to launch a new connection from the connection panel.
  3. Select the Azure DevOps connection in the connection panel.

    Choose data source

NOTE

You can also create a data source from the home page by clicking the Data Sources menu from left menu panel and Create Data Source from the data sources page.

Choose data source

Authentication with Azure DevOps

Use the following steps to authenticate with Azure DevOps web service:

  1. Click the data source, you will be prompted with a login window. Enter the credentials of your Azure DevOps account to authorize.
  2. Click Allow in the authorization window to accept the scopes requested by Bold BI dashboards.

    NOTE

    If the permission is denied, the account will not be accessible from the dashboard.

  3. Set a name to identify the account and click Next.
  4. You have now successfully authorized your connection. Click Connect to continue with the data source connection.
  5. To connect via already connected account, refer Connected Accounts.

NOTE

To connect to another account, click Connect New Account.

Connect to Azure DevOps

Create Azure DevOps data source

After successful authentication, the NEW DATA SOURCE configuration panel opens. Follow the below steps to create Azure DevOps data source:

In Azure DevOps, fetch data through Boards (choosing one from the Board Items) or Raw Query (REST endpoints).

Fetch data based on board items

  1. Enter a name and description (optional) for the data source.
  2. Enter your Account name and Team Project name.
  3. Select one of the Board Items from dropdown list. The options are based on categories in work items like Tasks, Bugs, and Stories.

    Configuration

  4. In Max Rows, enter the maximum number of rows to be fetched from the Azure DevOps data source. This value is used to fetch the data from Azure DevOps data source via pagination.
  5. Choose a time interval for Refresh Settings using the combo box to trigger the Rest API request periodically to keep the data in sync with Bold BI dashboard.

Fetch data using Raw Query

  1. Enter a name and description (optional) for the data source.
  2. Enter a valid Azure DevOps REST API endpoint in the URL textbox. Refer to the Azure DevOps API documentation for more details.

    Example: https://dev.azure.com/<:Account>/_apis/projects

    NOTE

    With this you can extract data from other Azure DevOps services - Azure Pipelines, Azure Repos, Azure Test Plans, Azure Artifacts with the endpoint prepared.

  3. Choose a time interval for Refresh Settings using the combo box to trigger the Rest API request periodically to keep the data in sync with Bold BI dashboard.
  4. Select GET method for the REST API in Method combo box.

You can also edit the connection information set here using the Edit Connection option.

Additional information

Max Rows Most of the REST APIs return only fewer data on a single API request. To pull the amount of data you need, set a value in this field. Pagination is handled internally and will fetch the amount of data you need.
Refresh Settings Period of time before next refresh call is triggered. This will automatically trigger a call for the API configured in the data source to keep the data up to date. If you do not want to sync your new data, choose ‘Never’.

NOTE

Raw Query option returns only the default records per query.

Setting up the URL

  1. Login to Azure DevOps.
  2. Get the Account name from listed accounts under My Organization.

    AccountName

  3. Replace <:Account> in the URL with the account name from the above step.

Sample queries

Projects

https://dev.azure.com/TestAccount/_apis/projects

Test Plans

https://dev.azure.com/MyOrganization/TestProject/_apis/testplan/plans

Builds

https://dev.azure.com/MyOrganization/TestProject/_apis/build/builds

Preview and Data import

  • Click Preview & Connect to connect with the configurations set.
  • The Choose Schema(s) dialog opens. The schema represents the key fields of JSON data retrieved from Azure DevOps Rest API request. This dialog displays a list of schemas in treeview and its corresponding values in grid for preview. Select required schema(s) from treeview to use in designer and click Connect.

    Preview

  • Now, the data design view page with selected table schema opens. Drag and drop the table.
    Query Editor

  • Click Save to save the data source with a relevant name.

Connected accounts for OAuth data sources

If you have already logged into the account and authenticated with web data source, the account information will be listed here. You can select one of the accounts or connect to a new account by clicking the Connect New Account button.

OAuth

You can edit, delete, and re-authorize this account from the Connected Accounts page.

Manage Accounts

Blog Post - https://www.boldbi.com/blog/monitoring-azure-devops-project-performance

Data Transformation - https://help.syncfusion.com/bold-bi/visualize-data/joining-table

Editing a Data Connection - https://help.syncfusion.com/bold-bi/editing-a-data-connection

Dashboard Designer Walk Through - https://help.syncfusion.com/bold-bi/dashboard-designer-walk-through

Azure DevOps Integration - https://www.boldbi.com/integrations/azure-devops