YouTrack Server 2024.3 Help

Reports Widgets

A Reports widget displays the calculation of a predefined YouTrack report. You can only add a Reports widget for an existing YouTrack report. You can't create a new report directly in the dashboard widget. You can add Reports widgets for reports that you've created or that have been shared with you.

Report widgets support all the report types that can be created in the Reports area in YouTrack except the Gantt Chart and the Timesheet Report. Reports that are displayed as charts on an agile board are not supported by the report widget, but you can always create separate Burndown and Cumulative Flow reports with similar settings and add them to your dashboards.

If you want to display a report not supported by this widget, you may be able to use another widget instead.

To add a report widget to the Dashboard:

  1. Click Dashboards in the main navigation menu.

  2. Select a dashboard for the widget.

  3. Click the Add widget button on the dashboard.

  4. From the drop-down list, select Reports.

    • The configuration dialog for the new widget opens.

  5. Enter an optional widget title.

  6. Set a custom refresh rate for the widget, in seconds. The default refresh rate for a report widget is 10 minutes (600 seconds).

  7. Select a report from the list. To filter the list of reports, enter text in the Search reports input field.

    Report widget settings
  8. Click the Create widget button.

    • The report widget is added to the dashboard.

    • If you didn't specify a title, the title of the card is set to the name of the selected report.

    Report widget saved

If you want to add a report that is not available in the list of the widget, create a new report. For detailed instructions, see Working with Reports.

Working with a Report Widget

When you add a Report widget to your dashboard, the selected report is displayed on the dashboard.

The dashboard widget displays an updated version of the report when the report is edited and the widget refreshes.

This widget is for report viewing only. Changes to reports can't be made with this widget.

Click the More menu in the corner of the widget to expand a list of available actions.

Action

Description

Share link

Opens a dialog with a link that can be copied and shared with teammates.

  • When a user pastes this link into the address bar in their web browser, the shared widget is added to their current dashboard. This can either be the dashboard that they're currently viewing in YouTrack or the dashboard that they most recently accessed.

  • If the person with whom you shared the widget doesn't have permission to view the data that is used in the widget, the widget is empty.

Clone widget

Creates a duplicate of the widget on your dashboard.

Move to another dashboard...

Opens a dialog with a drop-down menu of available dashboards. Select a new dashboard for the widget and click Move. The widget is removed from the current dashboard and moves to the selected dashboard.

Edit...

Modify the settings of the widget.

Remove

Opens a dialog. Click Delete to permanently remove the widget.

About

Opens a new YouTrack page in the web browser to the details section of the widget in Apps.

Refreshing Reports Widgets

The widget content is refreshed according to the custom refresh rate, when set. Otherwise, the widget is refreshed every 10 minutes.

For reports widgets, this doesn't recalculate the report. The report is recalculated according to the report parameters. For example, if a report is set to recalculate daily, the report widget is refreshed every 10 minutes. When the report is recalculated according to the report parameters, the widget displays the updated report the next time the dashboard refreshes.

For "quick reports" that don't have recalculation period settings, the widget recalculates the data for the report every 10 minutes.

To manually recalculate a report in a widget, click the refresh icon in the title bar.

Reports Widget Example

You're a project owner and want to see a cumulative report of your project by issue State. You want to have a convenient display of this existing report on your dashboard.

To create a Reports widget to display a cumulative report on a dashboard:

  1. Click Dashboards in the main navigation menu.

  2. Select a dashboard for the widget.

  3. Click the Add widget button on the dashboard.

  4. From the drop-down list, select Reports.

    • The configuration dialog for the new widget opens.

  5. Enter an descriptive widget title.

  6. Set a custom refresh rate for the widget, in seconds.

    In this example, the default refresh rate of 10 minutes (600 seconds) is used.

  7. Select a report from the list.

    In this example, the cumulative report is titled Web Cumulative Flow.

    Report widget settings
  8. Click the Create widget button.

The Web Cumulative Flow report is added to your dashboard.

Report widget example
Last modified: 27 November 2024