Add charts to a dashboard

VSTS | TFS 2018 | TFS 2017 | TFS 2015.1

Note

Adding charts to a dashboard is not a supported feature in TFS 2013, instead, you can pin items to a team homepage. Consider upgrading to the latest TFS version to get access to the widget catalog and multiple team dashboards.

You can add the charts described in this topic to a dashboard from their corresponding functional page, such as Builds, Releases, or Queries.

Note

Adding charts to a dashboard is requires TFS 2015.1 or later version. For TFS 2015, you can pin items to a team homepage. Consider upgrading to the latest TFS version to get access to the widget catalog and multiple team dashboards.

Prerequistes

You must be a team admin to add a chart to a team dashboard or homepage, or be granted permissions to manage a dashboard. Or, if you're a member of the Project Administrators group, you can add charts to any team's dashboards or home page.

Add a build history chart

Each time a build is run, it logs information about the build, including the run time, errors and warnings, and whether it successfully completed or failed.

Note

You can also add this chart to a team dashboard from the widget catalog.

  1. Select your team context and then open Build and Release>Builds to add a build history chart to a team dashboard. (Requires TFS 2015.1 or later version).

    Add a build summary chart to a dashboard

    If you aren't a team administrator, get added as one. The Add to dashboard menu selection is disabled when you don't have permissions to add it to the dashboards of the selected team context.

  2. Build summary charts look like this:

    Add a test plan chart to a dashboard

    Hover over a bar to view build information and run time. Click a bar to go to the build summary page.

Add a release summary chart

Each time a release is deployed, it logs information about the release to each of its environments. You can add a release tile to your team dashboard to monitor release progress and gain quick access to each release. (Requires TFS 2017.1 or later versions).

Note

You can also add this chart to a team dashboard from the widget catalog.

  1. Select your team context and then open Build and Release>Releases to add a release definition chart to a team dashboard.

    Add a Release pipeline chart to a dashboard

    If you aren't a team administrator, get added as one. The Add to dashboard menu selection is disabled when you don't have permissions to add it to the dashboards of the selected team context.

  2. Release pipeline charts show the success (green), in progress (blue), cancellation (red), or non-deployment (grey) to an environment for the current and last four releases:

    Release pipeline tile

Add a test status or result chart

As you create and run tests, you can track your status by defining lightweight charts of test plans and test results.

Note

You can also add a Chart for test plans widget to a dashboard.

  1. Select your team context, make sure you're a team admin, and if you haven't yet created the dashboard, do that now.

  2. Open Test>Test Plans and then Charts and select the dashboard to add the test chart to.

    Add a test plan chart to a dashboard

Add a test quality trend chart

You can add trends to the dashboard of the failures and duration of those tests that were run as part of a build.

Note

You can also add a test result trend chart widget to a dashboard.

Requires TFS 2017.2 or later version.

  1. Select your team context, make sure you're a team admin, and if you haven't yet created the dashboard, do that now.

  2. Open a build summary for a build pipeline to which you've added tests, open the Tests page, and click the bar chart for either Test failures or Test duration.

    Add a test plan chart to a dashboard

  3. Click the Actions icon Actions menu and choose the dashboard to add the chart to.

    Open Actions menu and select dashboard

    Learn more about reviewing automated test results after a build.

Add a work item query or chart

You add work item queries and charts to a dashboard from the Queries page. Queries and charts must be associated with queries under the Shared queries folder.

Note

You can also add a work item query chart widget to a team dashboard.

  1. First, make sure you have selected your team context. Only those dashboards created for a team appear in the context menu for each query or chart. Switch team context as needed.

  2. If you aren't a team administrator, get added as one. Only team and project admins can add and customize team dashboards.

  3. If you haven't yet created the dashboard, do that now.

  4. From the charts Actions menu, choose the team dashboard.

    Chart context menu, add to a dashboard

    You can only add charts associated with shared queries. Charts associated with queries under My Queries folder won't display the add to dashboard option.

Add a markdown file to a dashboard

Open the Markdown file defined in your repository and make sure you are in your team context.

Click Add to dashboard, and then choose the team dashboard to add the markdown file to. As you update the Markdown file, changes will automatically appear on the dashboard upon refresh. See Dashboards for more info.

Requires TFS 2015.2 or later version.

Web portal, Code, README file, Add Markdown page to a dashboard

System-generated work tracking charts

There are a number of system-generated charts that you can access from the web portal, but can't add to a dashboard. However, you may find a comparable widget listed in the widget catalog that tracks the same or similar data which you can add to the dashboard. These include: