Skip to content

Latest commit

 

History

History
289 lines (174 loc) · 13.5 KB

add-charts-to-dashboard.md

File metadata and controls

289 lines (174 loc) · 13.5 KB
title titleSuffix description ms.custom ms.technology ms.topic ms.author author monikerRange ms.date
Add built-in charts to a team dashboard
Azure DevOps
Add system-generated charts or query-based charts to a team dashboard in Azure DevOps & Team Foundation Server
dashboards
devops-analytics
conceptual
kaelli
KathrynEE
>= tfs-2013
08/30/2019

Add charts to a dashboard

[!INCLUDE temp]

::: moniker range="tfs-2013"

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.
::: moniker-end

::: moniker range=">= azure-devops-2020" You can add the charts described in this article to a dashboard from their corresponding functional page, such as Analytics, Builds, Releases, or Queries. ::: moniker-end

::: moniker range=">= tfs-2015 < azure-devops-2020" You can add the charts described in this article to a dashboard from their corresponding functional page, such as Builds, Releases, or Queries. ::: moniker-end

Prerequisites

::: moniker range="azure-devops"

  • You must be a member of a project. If you don't have a project yet, create one.
  • You must have created the team dashboard to which you want to add a chart to.
  • If you haven't been added as a project member, get added now.
  • Anyone with access to a project, including stakeholders, can view dashboards.
  • To add, edit, or manage a team dashboard, you must have Basic access or greater and be a team admin, a project admin, or have dashboard permissions. In general, you need to be a member of the team to edit a team dashboard.

::: moniker-end

::: moniker range=">= tfs-2018 <= azure-devops-2020"

  • You must be a member of a project. If you don't have a project yet, create one.
  • You must have created the team dashboard to which you want to add a chart to.
  • If you haven't been added as a project member, get added now.
  • To add, edit, or manage a team dashboard, you must have Basic access or greater and be a team admin, a project admin, or have dashboard permissions. In general, you need to be a member of the team to edit a team dashboard. Request your current team or project admin to add you as a team admin.

::: moniker-end

::: moniker range="tfs-2015"

Note

Adding charts to a dashboard 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.

::: moniker-end

::: moniker range=">= tfs-2015 <= tfs-2017"

::: moniker-end

To learn more, see Default permissions and access for charts and dashboards.

In-context work tracking reports

::: moniker range=">= azure-devops-2020"

You can add each of the in-context Analytics reports to a dashboard.

  1. Simply open the report, choose the :::image type="icon" source="media/icons/actions-icon.png" border="false"::: actions icon and select Copy to Dashboard.

    [!div class="mx-imgBorder"]
    Analytics in-context report, Copy to dashboard

    To open a report, see Cumulate Flow Diagram, Velocity, or Sprint burndown.

  2. Choose the dashboard and choose OK.

    [!div class="mx-imgBorder"]
    Choose the dashboard and choose OK.

  3. (Optional) Open the dashboard and choose the :::image type="icon" source="media/icons/actions-icon.png" border="false"::: actions icon for the widget to configure the size or change other report properties.

::: moniker-end

::: moniker range=">= tfs-2015 < azure-devops-2020"

There are a number of in-context reports 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:

::: moniker-end

::: moniker range=">= tfs-2015 <= tfs-2018"

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 Pipelines>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:

    Build summary chart.

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

::: moniker-end

::: moniker range=">= tfs-2017"

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. ::: moniker-end

::: moniker range=">= azure-devops-2019"

Note

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

  1. Open Pipelines>Releases to add a release definition chart to a team dashboard.

    [!div class="mx-imgBorder"]
    Add a Release pipeline chart to a dashboard, new nav

  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

::: moniker-end

::: moniker range=">= tfs-2017 <= tfs-2018"

Note

You can also add this chart to a team dashboard from the widget catalog. Requires TFS 2017.1 or later versions.

  1. Open Pipelines>Releases to add a release definition chart to a team dashboard.

    Add a Release pipeline chart to a dashboard

  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

::: moniker-end

::: moniker range=">= tfs-2015 <= tfs-2018"

Add a manual 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.

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

    Select the dashboard to add the test chart to.
    ::: moniker-end

::: moniker range=">= tfs-2017 <= tfs-2018"

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. ::: moniker-end

::: moniker range=">= tfs-2017"

Note

You can also add a test result trend chart widget to a dashboard. ::: moniker-end

::: moniker range="tfs-2017"
Requires TFS 2017.2 or later version.
::: moniker-end

::: moniker range=">= tfs-2017"

  1. Select your team context, make sure you're a team admin.

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

    Add a test plan chart to a dashboard

  3. Open the :::image type="icon" source="media/icons/actions-icon.png" border="false"::: 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.

::: moniker-end

::: moniker range=">= tfs-2015"

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.
    ::: moniker-end

::: moniker range=">= tfs-2015 <= tfs-2018"

Add a markdown file to a dashboard

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

Choose 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.
::: moniker-end

::: moniker range="tfs-2015" Requires TFS 2015.2 or later version. ::: moniker-end

::: moniker range="> tfs-2015 <= tfs-2018"

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

::: moniker-end

Related articles

::: moniker range=">= azure-devops-2019"

::: moniker range=">= tfs-2015 <= tfs-2018"