A report widget displays the calculation of a predefined report. You can only add a report widget for an existing YouTrack report. You cannot create a new report directly in the dashboard widget. You can add report widgets for the reports that you have created or that have been shared with you.
Report widgets support all of the report types that can be created in the Reports area in YouTrack with the exception of the Gantt Chart. Reports that are displayed as charts on an agile board are not supported, however, you can create separate Burndown and Cumulative Flow reports with similar settings and add them to your dashboards.
To add a report widget to the Dashboard:
- Click the Add widget button on the Dashboard.
- From the drop-down list, select Report.
- A card is added to the dashboard with the title Add widget from existing report.
- Click the link to expand the extra settings. The following options are available:
- Enter an optional widget title.
- Set a custom refresh rate for the widget, in seconds. The default refresh rate for a report widget is 10 minutes (600 seconds).
- Select a report on the card. To limit the list of reports, enter text in the input field.
- 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.
If you want to add a report that is not available in the reports list of the widget, create a new report. For detailed instructions, see Working with Reports.
Refreshing Report 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 does not 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 is refreshed.
For 'quick reports' that do not 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.