Add charts and widgets to a dashboard

Last Update: 5/23/2017

Team Services | TFS 2017 | TFS 2015.1-2015.3

Widgets smartly format data to provide access to easily consumable data. You add widgets to your team dashboards to gain visibility into the status and trends occurring as you develop your software project.

Each widget provides access to a chart, user-configurable information, or a set of links that open a feature or function.

You can add one or more charts or widgets to your dashboard. You add several widgets at a time simply by selecting each one. See Dashboards, Manage dashboards to determine the permissions you need to add and remove widgets from a dashboard.

IMPORTANT

Feature availability: You can access the widget catalog from the web portal for Team Services or TFS 2015.1 or later version. The widget catalog provides widgets for all tiles supported in previous releases of TFS for the team homepage. For on-premises TFS 2015, you can add select charts to the team home page using the Pin to home page feature.

To determine the platform and version you're on, see Provide product and content feedback, Platforms and version support.

Add a widget to a dashboard

For Team Services and TFS 2015.1 and later versions, you can add a widget to a dashboard.

NOTE

Widget images may vary depending on which platform you access. This topic shows images that appear in Team Services. However, the widget title and functionality described in this topic are valid for both Team Services and TFS. For example, dashboard edit mode controls shown below are valid for Team Services and TFS 2015.2 and later version. Some functionality differs when you connect to TFS 2015.1 or earlier versions.

Click Edit dashboard icon to modify a dashboard. Click add a widget icon to add a widget to the dashboard.

The widget catalog describes all the available widgets, many of which are scoped to the selected team context.

NOTE

Feature availability: For Team Services and TFS 2017 and later versions, you can drag and drop a widget from the catalog onto the dashboard.

Configure a widget

To configure a widget, add the widget to a dashboard and then click the configure icon configure icon.

Work item chart unconfigured widget

Click the delete icon to remove the tile from the dashboard.

Once you've configured the widget, you can edit it by opening the actions menu.

Edit configured widget

Add charts to a dashboard

All charts listed in the following table are available from Team Services and TFS 2017.1. You can add them to a dashboard from the widget catalog or directly from the Build, Release, Test, or Work hubs. For TFS 2015. and earlier versions, some charts require you to add them to a team dashboard from the hub.

Chart TFS 2015 TFS 2015.1 TFS 2015.2 TFS 2017.1
Build history chart 1 checkmark checkmark checkmark
Release summary chart 1 checkmark
Test status or result chart 2 checkmark checkmark checkmark checkmark
Test quality trend chart 1 checkmark checkmark
Work item query 2 checkmark checkmark checkmark checkmark
Work item query chart 2 checkmark checkmark checkmark checkmark
  1. These charts are configured by the system. You can't edit them.
  2. These charts are user-configurable.
NOTE

Required permissions: 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

NOTE

Feature availability: This chart is supported from Team Services and TFS 2015.1 and later versions. With Team Services and later versions of TFS, you can also add it to a team dashboard from the widget catalog.

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.

  1. Select your team context and then open the Build hub to add a build history chart to a team dashboard.

    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

NOTE

Feature availability: This chart is supported from Team Services and TFS 2017.1 and later versions. You can also add it to a team dashboard from the widget catalog.

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.

  1. Select your team context and then open the Release hub to add a release definition chart to a team dashboard.

    Add a Release definition 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 definition 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 definition tile

Add a test status or result chart

NOTE

Feature availability: This feature is supported from Team Services and TFS 2015.

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

  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 the Test hub charts page and select the dashboard to add the test chart to.

    Add a test plan chart to a dashboard

Add a test quality trend chart

NOTE

Feature availability: This chart is supported from Team Services and TFS 2015.2 or later versions. From Team Services and TFS 2017 and later versions, you can add a test result trend chart widget to a team dashboard.

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

  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 definition 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

NOTE

Feature availability: This feature is supported from Team Services or TFS 2015. With Team Services, you can add a work item query chart widget to a team dashboard.

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.

  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

NOTE

Feature availability: Adding a Markdown file to a team dashboard is available from Team Services and the web portal for TFS 2015.3 and later versions.

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.

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

Markdown widgets

Use these widgets to support your team and stakeholders by adding information such as:

  • Team goals
  • Provide links to team backlogs or boards, metrics, or other items located in a network share such as a OneNote, SharePoint site or wiki pages
  • Important dates or target deadlines

Here's an example:

Web portal, Sample Markdown widget

NOTE

Links to documents on file shares using file:// are not supported on Team Services or TFS 2017.1 and later versions. This restriction has been implemented for security purposes.

For information on how to specify relative links from a Welcome page or Markdown widget, see Source control relative links.

To edit a markdown widget, you must be a team admin or a member of the Project Administrators group. To be added as a team admin, go here.

To learn more about charts and dashboards, see the following topics:

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:

Switch team project or team focus

Several features depend on the team project or team that you have selected. For example, dashboards, backlogs, and board views will change depending on the context selected.

For example, when you add a work item, the system references the default area and iteration paths defined for the team context. Work items you add from the team dashboard (new work item widget) and queries page are assigned the team default iteration. Work items you add from a team backlog or board, are assigned the team default backlog iteration. To change team defaults, see Set team defaults.

Also, several hubs enable you to set team favorites. The favorites you set and see are dependent on the team context you've chosen.

You navigate to your team context from the top navigation bar. The method changes slightly depending on the platform/version you work from.

NOTE

Feature availability: The Account Landing Page feature is in preview mode for Team Services and enabled for all users from web portal for TFS 2017.1 and later versions. To learn more about this feature, see Work effectively from your account hub. To enable or disable the feature, see Enable preview features.

You can switch your team focus to a team project or team you've recently viewed from the team project/team drop-down menu. If you don't see the team or team project you want, click Browse… to browse all team projects and teams. Your selection will open the Dashboard hub for the team project/team.

To access your account hub, click the Team Services icon Team Services icon. If you haven't yet enabled the Account Landing Page, you'll be taken to the account home page.

To go directly to the project vision and status page, choose the project home icon from the drop-down menu, for example, project home icon.

Choose another team from the team project menu

To switch your team focus to a team project or team you've recently viewed, hover over the Team Services icon Team Services icon and choose from the drop-down menu of options. If you don't see the team or team project you want, choose Browse… to browse all team projects and teams. Your selection will open the project vision and status page for the team project.

To access your account hub, click the Team Services icon Team Services icon. If you haven't yet enabled the Account Landing Page, you'll be taken to the account home page.

Choose another team from the team project menu

Open the team project/team drop-down menu and select the team project/team that you've recently visited. If you don't see the team or team project you want, choose Browse all to browse all team projects and teams.

Choose another team from the team project menu

Open the team project/team drop-down menu and select the team project/team that you've recently visited. If you don't see the team or team project you want, choose Browse all to browse all team projects and teams.

Choose another team from the team project menu

Marketplace widgets

You may find additional widgets of interest from the Marketplace.

If your account or project collection administrator disables a marketplace widget, you'll see the following image:

Disabled widget extension notification

To regain access to it, request your admin to reinstate or reinstall the widget.

Widget size

Some widgets are pre-sized and can't be changed. Others are configurable through their configuration dialog.

For example, the Chart for work items widget allows you to select an area size ranging from 2 x 2 to 4 x 4 (tiles).

Change widget size

Extensibility

Using the REST API service, you can create a dashboard widget. To learn more about the REST APIs for dashboards and widgets, see Dashboards (API).

Provide feedback

We welcome your feedback.

Send suggestions on UserVoice, and follow us on Twitter @VSTeam.

See also our comprehensive feedback and support page.