Dashboards

Last Update: 7/14/2017

Team Services | TFS 2017 | TFS 2015.1-2015.3 | TFS 2015 | TFS 2013

NOTE

Feature availability: Multiple team dashboards and the widget catalog are available from Visual Studio Team Services and from the web portal for TFS 2015.1 or later version.

If you connect to an on-premises TFS running TFS 2015 or earlier version, you don't have access to multiple team dashboards. Instead, your home page serves as a single team dashboard For information on SharePoint dashboards, see Project portal dashboards.

Share progress and status with your team using configurable team dashboards. Dashboards provide easy-to-read, easy access, real-time information. At a glance, you can make informed decisions without having to drill down into other parts of your team project site.

The Overview page provides access to a default team dashboard which you can customize by adding, removing, or rearranging the tiles. Each tile corresponds to a widget that provides access to one or more features or functions.

Example dashboard

Anyone with access to the team project, including stakeholders, can view dashboards. However, only team admins can add or modify dashboards.

If you need to add a team first, see Multiple agile teams.

Add and name your dashboard

From the dashboards tab, click the plus icon and enter a dashboard name.

Add and name a dashboard

If you don't see the plus icon, then you're not a team admin for the currently selected team. Either switch the context to your team, or request you be added as a team admin.

With the dashboard selected, you can add widgets and charts to the dashboard. Or, you can add charts to a team dashboard from the Work, Build, or Test hubs.

Edit dashboard

NOTE

Feature availability: Dashboard edit mode controls shown appear from Team Services or TFS 2015.2 or later version. Some functionality differs when you connect to an application server running TFS 2015.1 or later version.

Add a widget

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

NOTE

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

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

TIP

When you're in dashboard edit mode, you can remove, rearrange, and configure widgets, as well as add new widgets. Once you leave edit mode, the widget tiles remain locked, reducing the chances of accidentally moving a widget.

Configure a widget

After you add the widget, you may need to configure it. For example, to configure the Query tile widget, click the Configure widget icon or the Actions icon to open the configuration dialog.

Query tile unconfigured widget

And then select the query and specify any rules you want. (For TFS 2015.1 and later versions, you can only specify the green and red flag limits.)

Team Services configuration dialog for query tile

Query tile configuration dialog

Add an item or a chart to your dashboard

You add an item to a dashboard from the code, work, and build pages.

First, make sure you have the team context selected from the Queries page to which you want to add a query or chart.

For example, select the context menu of a query that you want to add to the dashboard. This is the same as adding a query tile widget.

Add a shared query to a team dashboard

And, you can add a chart to a team dashboard in a similar way.

Add a chart to a team dashboard

Copy a widget

NOTE

Feature availability: This feature is currently only available from Team Services.

To copy a configured widget to another team dashboard, click the Actions icon actions icon and select Add to dashboard.

Copy a widget to another team dashboard

Move or delete a widget from a dashboard

NOTE

Just as you have to be a team or project admin to add items to a dashboard, you must have admin permissions to remove items.

Click Edit dashboard icon to modify your dashboard. You can then drag tiles to reorder their sequence on the dashboard.

To remove a widget, click the widget's Trash icon or Delete icon delete icons.

When you're finished with your changes, click Exit edit-dashboard-mode icon to exit dashboard editing.

Manage dashboards

NOTE

Feature availability: You can configure the auto-refresh setting for each dashboard on Team Services and for TFS 2015.2 and later versions. For Team Services and TFS 2017.1 and later versions, you can set dashboard permissions.

You can rename, reorder, or delete a dashboard. Also, you can enable auto-refresh, and the dashboard will automatically update every 5 minutes.

From Team Services and TFS 2017, you can also manage dashboard permissions.


To manage dashboards, click the configure icon wrench icon.

Open manage dashboards dialog

Reorder and auto-refresh

  1. Drag and drop the dashboards into the sequence you want them to appear.

    Manage dashboards - Team Services
  2. Click delete icon to delete a dashboard and then click Save.

  3. Select the Auto-refresh checkbox when you want the dashboard to refresh every five minutes.

Set permissions

From the Permissions tab you can grant or restrict permissions to your team members to edit and manage your team dashboards. The default setting provides all team members permissions to edit and manage dashboards.

Manage dashboards - permissions
  1. Click the gear icon gear icon to open manage dashboards.


    Open manage dashboards dialog - TFS web portal
  2. Drag and drop the dashboards into the sequence you want them to appear.

    Manage dashboards
  3. Click delete icon to delete a dashboard and then click Done.


  4. Select the Auto-refresh checkbox when you want the dashboard to refresh every five minutes.

    Feature availability: The Auto-refresh feature is available from TFS 2015 Update 2 or later version.

As you can see, you can use team dashboards to provide guidance and keep your team in sync, providing visibility across the org as to status, trends, and progress. See these additional resources to help you support your team:

Also, you can create a dashboard widget using the REST API service.

Required permissions

If you don't see the plus icon, then you don't have permission to edit your team dashboards. In general, you need to be a team admin for the currently selected team to edit dashboards. Request your current team or project admin to add you as a team admin.

If you work in Team Services, you can ask your team admin to change dashboard permissions to allow you and other team members to edit dashboards as described in Set permissions earlier in this topic.

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

Extensibility

Using the REST API service, you can add a dashboard.

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 @vsts.

See also our comprehensive feedback and support page.