Skip to main content
Version: Release 23.3

Configure Custom Dashboards

You can create custom dashboards with the most relevant data for your team and share them with others in your organization. Custom dashboards give you the flexibility to focus on a small dataset or a specific topic such as security.

You can also create and add custom tiles to your dashboard.

important

The Create dashboard permission is required to create dashboards. For more information, see Grant the Create dashboard permission section on this page. Users with this permission can create dashboards.

Both the editor and viewer role is required to modify dashboards. Users with these roles can view and edit dashboards but not create them. This role is set by the dashboard owner when configuring a dashboard; see Create a dashboard section on this page.

The viewer role provides view only access to a dashboard. Users with this role can view but not modify a dashboard. This role is set by the dashboard owner when configuring a dashboard; see Create a dashboard section on this page.

Grant the Create dashboard permission

To allow users to create a dashboard:

  1. From the navigation bar, click **Settings > Users and Permissions.
  2. From the navigation pane, under Users and Permissions group, click Permissions.
  3. Under the Roles section, add the user or user group name beside the Create dashboard action.

Dashboards

Create a dashboard

To create a dashboard:

  1. From the navigation pane, click Dashboards under Reports group.
  2. From the navigation pane, under Dashboards, click Add custom dashboard.
  3. Depending on the type of dashboard you would like to create, hover over one of the following templates, and click Select:
    • Blank template: A template without preconfigured tiles.
    • Deployments template: A template with preconfigured deployments tiles.
    • Release statistics template: A template with preconfigured release tiles.
note

Deployment and Release statistics templates are only available in Release 8.5 and later.

  1. In the Name field, add a unique name for the dashboard.
  2. In the Columns field, define the number of columns that will be used in the dashboard grid.
  3. Decide if Auto refresh is enabled or disabled. If enabled, specify the refresh interval in minutes. Auto refresh functionality will refresh the whole dashboard periodically, clearing the cache.
  4. In the Dashboard owner field, define which user or user group owns the dashboard.
note

A dashboard owner has modify and delete permissions. A dashboard can be assigned to one owner only.

  1. In the Viewers field, define which users or user roles can view the dashboard.
  2. In the Editors field, define which users or user roles can edit the dashboard.
  3. Click Save.

Delete a dashboard

To delete a dashboard:

  1. From the navigation pane, under Custom dashboards, select the dashboard you wish to delete.
  2. On the top right of the screen, click Configure dashboard.
  3. Click Delete dashboard.
note

Only the dashboard owner or a user with the create dashboard permission can delete a dashboard.

Edit a dashboard

To edit a dashboard:

  1. From the navigation pane, under Custom dashboards, select the dashboard the dashboard you wish to edit.
  2. On the top right of the screen, click Configure dashboard.
  3. Click Edit properties.
  4. Edit the dashboard properties.
  5. Click Save.

Add a tile to a dashboard

To add a tile to a dashboard:

  1. Select a dashboard.
  2. Click Configure dashboard.
  3. Click Add tiles.
  4. Choose a tile and click Add.
note

See tiles description for a detailed description of all available tiles.

Configure a tile

To configure a tile:

  1. Select a dashboard.
  2. Click Configure dashboard.
  3. Hover over a tile.
  4. Click Gear icon.
  5. Edit the tile properties.
  6. Click Save.

Add a filter to a tile

Filters can be applied to certain tiles, these are referred to as reporting tiles.

Filter types are:

  • Parent folder: Filter release data based on a specific parent folder name.
  • Source templates: Filter release data based on specific source template names.
  • Release tags: Filter release data based on specific release tags.

To add a filter to a tile:

  1. Select a dashboard.

  2. Click Configure dashboard.

  3. Hover over a tile.

  4. Click Gear icon.

  5. Edit the tile properties.

    5.1. To display only particular period data in the tile, use the Time period dropdown and select the required option:

    • Last 30 days

    • Last 3 months

    • Last 6 months

    • Last year

    • Range.

      Note: To choose the dates you wish, select the Range option from the dropdown and provide the From and To dates by clicking on the Set date.

      Range filter in tile

  6. Click + Add filter.

    • To filter data based on specific parent folder names:
      • Click Select filter and select Parent folder.
      • In the blank field under matches, enter parent folder names.
note

This filter returns data from a direct parent only. If you want to return data that is from more than one parent folder, add all folder names.

  • To filter data based on specific release status:
    • Click Select filter and select Release Status.
    • In the blank field under matches, enter release names.
  • To filter data based on specific source template names:
    • Click Select filter and select Source template.
    • In the blank field under matches, enter source template names.
  • To filter databased on specific release tags:
    • Click Select filter and select Release tags.
    • In the field under contains all, select a logical operator.
      Two logical operators are available on the release tags filter:
      • Select contains all to return release data that has all of the specified tags. If data items do not have all of the specified tags no data will be returned.
        Or
      • Click contains any to return release data that has any of the mentioned tags.
      • In the blank field under the logical operator, enter tag names.
  1. Click Save.

Move a tile

To move a tile:

  1. Select a dashboard.
  2. Click Configure dashboard.
  3. Hover over a tile and click Move icon.
  4. Drag the tile to a new location on the grid.

Delete a tile

To delete a tile:

  1. Select a dashboard.
  2. Click Configure dashboard.
  3. Hover over a tile and click Delete icon.

Resize a tile and customize the dashboard layout

Tiles can span multiple columns and roles. This makes it easier to view metrics on large data sets.

To resize a title or customize the layout:

  1. Hover over the left, right, or bottom edge of any tile. A two sided arrow will appear.
  2. Click and drag the tile until it covers the desired area.