# dashboard

The dashboard is the control center for analysis. It gives a visual, customizable display of the development progress and quality.

Add up to 30 widgets to a single dashboard view or the Overview tabs in the , , and Pipelines modules to suit your product and team needs.

## Set up the dashboard

In the banner, click the menu button and select Dashboard. You can also select the Overview tab in the , , or Pipelines modules.

To set up the dashboard:

1. In the toolbar, click the Add Widget button.
2. In the Widget Gallery, select a category and a widget within the category, or click Add custom graph. Use the tabs in the Widget Editor to set up and configure your widget.

   If you are not sure which widget to use, read the widget description to see which questions this widget helps answer.

3. Click Add to Dashboard. adds the widget at the bottom of the dashboard.

   Repeat as necessary to suit your needs.

4. In the toolbar, click the Dashboard layout button and select the necessary layout. Drag and drop widgets as needed.

maintains the specific widgets and layout between sessions.

To clear the widgets on the dashboard and start again, click the Clear Dashboard button.

When the top section of a layout is empty, you will see a large gap enabling you to drag widgets easily into the section. If you plan to leave it empty, you might want to consider using a different layout.

## Configure widget data settings

After you have set up the Dashboard widgets, you need to configure the data settings for each widget.

To configure the data settings:

1. In the widget's right corner, click the vertical ellipsis and select Configure.

   If you want to duplicate a current widget configuration as a starting point, in the widget menu, select Duplicate. adds a widget named Copy of <Widget Name>.

2. On the General tab, select the graph type and update the name and description as needed. For non-Agile graphs, select Current Status or Status Over Time.

3. On the Scope tab, define the scope of the data to display, including:

   - Workspace

     These are workspaces from which should compile the graph's data. To use this field, the workspace must be associated with a shared space.

     Enterprise edition: Using this field, you can define dashboard widgets that display cross-workspace information.

     Select All my workspaces to compile data from all workspaces in which you are a member. The Workspace field is not supported for agile graphs, such as the Burn Up, Burn Down, Edit Release Forecast, and Cumulative Flow graphs.

   - Item type

     The available items depend on the widget you are configuring. Expand the drop down for details.

     Item types

     Item type | Description
     --- | ---
     Tests | Includes all subtypes of tests - manual tests, automated tests, Gherkin tests, BDD scenarios and test suites. For details on the testing frameworks and test types available in , see Testing and Manual testing flow.
     Last runs | Includes only the last runs of all types of runs (manual run, automated run, suite run, Gherkin automated run). Popular use case: status and coverage analysis based on selected program, release, milestone, environment. For details on how Octane identifies runs as last runs see Run manual and Gherkin tests.
     Test run history (automated) | Includes all historic automated runs of automated tests, Gherkin tests, and BDD scenarios. The trends of failure ratio is a popular use case. For details see Trigger automated test runs in your testing framework.
     Test run history (manual) | Includes all manual runs of manual tests, Gherkin tests and BDD scenarios. Tracking manual run progress is a popular use case.
     Test run history (suites) | Includes all suite runs. For details see Plan and run test suites.
     Pipeline run | Includes all pipeline runs, which represent the builds of all root jobs that were defined as pipelines. For details see Automated testing flow (pipelines).

   - Phases (for cycle time graphs)

     For the end phase, you cannot select any phase that precedes the start phase, as defined for your workflow.

   - Release
   - Sprint
   - Milestone

4. For trend-based graphs (Status Over Time), specify a time frame:

   Time frame | Details
   --- | ---
   Without a release specified | If you select: The All <items> up to now option, the graph contains every item of the selected type from the beginning of your project until now. A specific period, the scope (last 24 hours, last 7 days, and so on) means last <time period> up to now. For example, the Last week means the previous week until now.
   With a release specified | If you select: All <items> up to now, the graph includes the selected item type from the beginning of the specified release until now. Release period, the graph includes the selected item type from the start date to the end date of the release. All <items> up to end of release, the graph includes items created or updated from the beginning of the project until the end of the release. All <items> from start of release up to now, the graph includes items created or updated from the start date of the release until now.

   When using trend-based graphs (for example, Burn Up or Burn Down charts), if one of the sprints includes a day with a clock change, the graph tooltips exclude the day, week, or month with the time change. The excluded period depends on the scope you set in the graph configuration.

   For example, if a sprint includes the day the clock switches to Daylight Savings time, the tooltips exclude this day, week, or month.

5. On the Scope tab, define additional conditions for filtering dashboard widgets.

   For example, if you only want to show defects that had a phase age of 60 days or more, add a Days in phase filter and specify Greater than 60.

   If you select more than one workspace in the Workspaces field, filters display the fields common to all selected workspaces. Certain reference fields (such as Application Modules or Features) are not available for use in cross-workspace graph filters.

   If you update the workspaces that are selected or open the same graph in a different workspace, clears the existing filters. For details, see Filter.

6. On the Display tab:

   1. Choose the desired graph format and its related options. For details, see Dashboard displays.

   2. Select the field to display in the x-axis.

      In summary widgets, the x-axis can display date fields that are properties of items in a scope, for example Closed on, Creation time, or Started. You can also select user-defined fields of the Date and Time type. Aggregate the date values per days, weeks, or months.

      Note: Date fields are not available for cross-fields.

   3. For the y-axis, select whether you want to display the sum or count of the x-axis values.

      In summary widgets, the y-axis can also display an average of the x-axis values.

      For a sum or average, you also need to select a unit, such as Estimated hours, Invested hours, and so forth.

   4. Choose a Group by item by which to group the results.

7. Click Save.

   updates the graph according to your selections.

To export data with full report data as if it were a graph, independent of the grid filtering settings, click the vertical ellipsis in the widget's upper-right corner, and click Export to Excel.

## Dashboard displays

lets you choose from several display types, depending on the widget type.

In the General page, you select the graph type: Current Status, a summary graph, or Status Over Time, a trend-based graph. The dialog box will only display the available graphs for the selected graph type.

| Bar graph (vertical) | For all graph types, a standard bar graph.
| Bar graph - per group | For trend-based graphs only, a vertical bar graph separated by group.
| Bar graph (horizontal) | For summary graphs only, a horizontal bar graph.
<<<<<<< .mine ||||||| .r136124 ======= >>>>>>> .r136127 | Pie chart | For summary graphs only, a color coded pie chart with a legend above the chart describing the segments of the pie.
| Number chart | For summary graphs, the graph shows the widget value as an integer. You can choose to display a count, sum, or average of the item's values. To apply color coding to the number, enable the Use conditional color ranges option, and specify a range. For example, for a widget showing defects, you can designate red as the color for a count of 25 or more defects.
| Line graph | For trend-based graphs, a standard color-coded line graph displays the field values.
| Area graph | For trend-based graphs, an area graph displays the data, indicating the ratios by color.
| Grid | For summary graphs, each graph source, such as defects or tests, has default columns defined, which you can change as needed. The grid limit is the maximum number of rows displayed, from 0 (no limit) to 100, by default 25 rows. When setting up a grid, you can select up to two fields for sorting. These fields correspond to the X-axis and Group by fields of graphs. If you select a field that cannot be used for sorting, a message appears in a tooltip next to the field name. On certain grids, depending on the source type, you can drill down into the grid rows to view full entity details. Enterprise edition: Grid widgets can display cross-workspace information. For example, you can show the defects with highest severity from all workspaces in a shared space.
| Accessible tabular format | For all graph types, this option displays the data in a table.

In some of the graphs you can enable additional options:

- Double height. Displays a widget in an extra-long vertical format. By default, grids are displayed as double-height.

- Include empty columns. For Summary type graphs, this option includes data from features or application modules with no associated or assigned items.

  In summary widgets based on date fields, this option adds columns for dates that have no data to display. For example, you can configure the widget to display Closed on date for defects. In this case, empty columns with no defects closed on that date will be displayed, in addition to the columns with data.

- Show trend of changes. For trend-based graphs, this option counts all status changes in a given time frame—not just the final state of each entity. For example, if you want to see how many defects were opened and closed in each day, giving you a picture of the overall trend. You can use the Defect daily injection days/weeks graph to see how many defects were opened and closed by your team, over a two-week period.

  Note: When aggregating by weeks, the number for each date on the graph represents how many records were at the end of the week that started on the start date.

## Use dashboard widgets for analysis

After you add and configure widgets, use them to perform in-depth analysis:

View more details | For the different sections in a graph, hover over the section to see a tooltip with details:
Summary widgets: drill down to referenced items | You can drill down to the referenced items, such as features or application modules, by clicking a graph section or table data. View items in a grid or in a smart list. You can sort, filter, group by, and search for items. In a grid view, you can add or remove columns. Note: For trend-based graphs, drill down to the referenced items is not available.
Hide/Show data | Click an item in the widget's legend to show or hide data in the widget. Example: In the widget on the left, we clicked New and Ready for R&D to hide features that are not yet ready to be documented. On the right, the items are hidden, and you can see that the widget items are not selected.
Read values along the timeline | For trend-based graphs, drag the mouse along the trend line to see a period-by-period detail:

## Save and share dashboards

You can save a dashboard as a favorite. This allows you to maintain several dashboards, and lets you share them with other members of your workspace. You can also create public links to dashboards that you can share outside .

For details, see Favorites.

## Export widget data and graphs

You can export the summary widget data to an .xlsx file, and the graph image to a .png file. The export options are not available for non-summary widgets.

To export the widget data and graph:

1. In the graph's upper-right corner, click the vertical ellipsis .
2. Select one of the following:

Export type | Description
--- | ---
Export to Excel | The widget data is downloaded to your computer as an .xlsx file. The file contains two sheets: Data: Lists the details of all the widget items similar to a grid view. Summary: Displays the data as it is presented in the widget, using the x-axis, y-axis, and grouping values. The Summary sheet also contains a live widget graph. Note: For tabular widgets, the Summary sheet contains only the tabular data.
Export Image | The widget graph is downloaded to your computer as a .png file. Note: The Export Image option is only available for summary widgets with graphs.

- Dashboard widgets description
- Analyze release progress and quality
- Analyze product quality