Add and manage dashboards

VSTS | TFS 2018 | TFS 2017 | TFS 2015.1

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.

Note

Multiple team dashboards and the widget catalog are available from TFS 2015.1 or later versions. For TFS 2015 and earlier versions, 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.

Note

For information on SharePoint dashboards, see Project portal dashboards.

Prerequisites

  • You must be a member of a team project. If you don't have a team project yet, create one in VSTS.
  • If you haven't been added as a team member, get added now.
  • Anyone with access to the team project, including stakeholders, can view dashboards.
  • To add, edit, or manage a team dashboard, you must be a team admin, a project admin, or have dashboard permissions. 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.

Prerequisites

  • You must be a member of a team project. If you don't have a team project yet, create one in an on-premises TFS.
  • If you haven't been added as a team member, get added now.
  • Anyone with access to the team project, including stakeholders, can view dashboards.
  • To add a widget to a team dashboard, you must be a team admin, a project admin, or have dashboard permissions. 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.

Prerequisites

Connect to the web portal for your team project

Open a browser window and choose the Dashboards hub.

Open the Dashboards hub

If you don't see the team or team project you want, click the project icon project icon to browse all team projects and teams.

Select a dashboard to view

All dashboards are associated with a team.

To enable the New Dashboard experience, see Enable preview features.

  1. From the Dashboards hub, open the selector and choose the Browse all dashboards option.

    Dashboards hub, Browse all dashboards option

  2. The Mine page shows your favorited dashboards, and all dashboards of teams that you belong to. The All page (shown below) lists all dashboards defined for the team project in alphabetical order. You can filter the list by team or by keyword.

    Dashboards hub, Browse all dashboards option

    Tip

    You can change the sort order of the list by clicking the column label. However, you can't change the column size of the displayed columns.

  3. To favorite a dashboard, hover over the dashboard and choose the star icon.

    Dashboards hub, Browse all dashboards option

    Favoriting a dashboard will cause it to appear on your Favorites page, and appear towards the top in the Dashboards selection menu.

The New Dashboard experience is only available from VSTS at this time.

Add and name your dashboard

Add a new dashboard as needed to support your team's needs. You can also edit and rename any existing dashboards associated with your team. All dashboards are associated with a team.

To enable the New Dashboard experience, see Enable preview features.

  1. From the Dashboards hub, open the selector and choose the plus icon New Dashboard option.

    Open the create a dashboard dialog

    If you don't see the plus icon New Dashboard option, then you're not a team admin for the currently selected team, or you don't have permissions to add and edit dashboards. Either switch the context to your team, or request you be added as a team admin.

  2. Enter the name of the dashboard and other information you want to capture.

    Create a dashboard dialog

    Choose Save.

  3. The widget catalog opens. You can add one or more widgets to the dashboard. You can then configure and resize each widget as needed.

  4. You can move the widgets around the dashboard to place them where you want them.

  5. When you're done making changes, choose Done Editing.

The New Dashboard experience is only available from VSTS at this time.

Manage dashboards, reorder and enable auto-refresh

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

  • To rename a dashboard, modify it's description, or change it's automatic refresh setting, open the dashboard, click the gear icon gear icon, and change the field options shown. Save your changes.

  • To delete a dashboard, open the All dashboards page, open the actions icon actions menu for the dashboard, and choose the Delete option.

    Delete a dashboard

  • To set permissions for a dashboard, choose the Security option. For details, see Set dashboard permissions.

The New Dashboard experience is only available from VSTS at this time.

Move or delete a widget from a dashboard

Note

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

Choose Edit dashboard icon to modify your dashboard.

You can then add widgets or drag tiles to reorder their sequence on the dashboard.

To remove a widget, click the actions icon actions icon and select the Delete option from the menu.

Delete a widget from a dashboard

When you're finished with your changes, choose Done Editing to exit dashboard editing.

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.

The New Dashboard experience is only available from VSTS at this time.

Try this next

As you can see, you can use team dashboards to provide guidance and keep your team in sync, providing visibility across your org about status, trends, and progress.

See these additional resources to help you support your team:

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).