Skip to main content

Work with dashboards

Dashboards on our continuous testing platform are special containers, where users can create widgets.

To create and use dashboards, navigate to the "Dashboards" tab.

You can create a dashboard that will be visible on the current project.

Create dashboard​

To create a new dashboard, perform the following steps:

  1. Navigate to the "Dashboards" page and click "Add New Dashboard" button in the top right corner of the page.

  2. The "Add New Dashboard" popup will be opened.

  3. Enter a name for a new dashboard. The name should be between 3 to 55 characters long and unique for the user per the project. You can add the description for your dashboard as well.

  4. Click "Add" button. The new dashboard will be created.

Now you can add widgets to the dashboard.

Edit dashboard​

To edit a dashboard, perform the following steps:

  1. Navigate to "All Dashboards" page.

  2. Click the "Edit" icon in the top corner of the dashboard or click the name of the dashboard and click 'Edit' button in the header of the dashboard.

  3. The "Edit Dashboard" popup will be opened.

  4. Make the necessary changes and click "Update" button. The dashboard will be displayed with updates.

Delete dashboard​

To remove a dashboard from the project, perform the following steps:

  1. Click the "Delete" button in the top right corner of the dashboard.

  2. Click the "Delete" button on confirmation pop-up.

The dashboard and related widgets will be deleted from the system.

Dashboard cloning​

Dashboards simplify tracking key metrics and project performance. However, manually recreating the same dashboard for multiple projects can be time-consuming and inefficient.

With the dashboard cloning feature, you only need to create a reference dashboard once you have an instance deployed for your organization. You can then replicate this dashboard across projects without wasting effort on manually recreating the same sequence of widgets from scratch.

ReportPortal offers two ways to clone dashboards:

  • through the UI
  • via API

Permissions:
Any user in a project, regardless of their role, can use the dashboard cloning feature.
If a user has access to multiple projects, they can clone a dashboard to any of them.
An admin can perform dashboard cloning without being assigned to a specific project.

Dashboard cloning via UI​

Within a single project​

To duplicate dashboard via the UI within the same project:

  1. Log in to ReportPortal.
  2. Open Dashboards page.
  3. Click ‘Copy’ icon next to the desired dashboard.
  4. Select ‘Duplicate’ option from the dropdown menu.
  1. In the modal window, update the duplicated dashboard's name if necessary.
  1. Click ‘Duplicate’ button.

As a result:

  1. The dashboard will be copied along with all its widgets, maintaining the same order as in the initial dashboard.
  2. If you haven't specified a new name for the duplicated dashboard, the word ‘copy’ will be added to the name.
  1. The ‘Owner’ field will display the name of the user who duplicated the dashboard, rather than the name of the original creator.
  2. New filters will appear on the filters page.

From one project to another​

To copy dashboard configuration to another project:

  1. Log in to ReportPortal.
  2. Open Dashboards page.
  3. Click ‘Copy’ icon next to the desired dashboard.
  4. Select ‘Copy dashboard configuration to clipboard’ option from the dropdown menu.
  1. Open Dashboards page on another project.
  2. Click ‘Add New Dashboard’ button at the top of the page.
  1. Enter the name of a new dashboard.
  2. Click ‘Show dashboard configuration’ link.
  1. Click ‘Paste configuration’ button.
  1. Click ‘Add’ button.

As a result:

  1. The dashboard will be copied along with all its widgets, maintaining the same order as in the initial dashboard.
  1. If you haven't specified a new name for the dashboard, the word ‘copy’ will be added to the name.
  2. The ‘Owner’ field will display the name of the user who performed the dashboard configuration copying, rather than the name of the original dashboard creator.
  3. New filters will appear on the filters page.

Dashboard cloning via API​

To clone the dashboard configuration via API:

  1. Log in to ReportPortal.
  2. Open the API section on the bottom menu.
  1. Click on ‘Dashboard’ controller link.
  1. Expand /v1/{projectName}/dashboard/{dashboardId}/config endpoint.
  2. Click ‘Try it out’ button.
  1. Fill dashboard ID and project name fields.
  1. Click ‘Execute’ button.
  2. Copy dashboard configuration.

To add the copied dashboard configuration to another project via API:

  1. Expand /v1/{projectName}/dashboard/preconfigured endpoint.
  2. Click ‘Try it out’ button.
  1. Fill project name field.
  2. Specify new dashboard name in the Request body field.
  1. Paste copied dashboard configuration the Request body field instead of sample widgets.
  2. Click ‘Execute’ button.
important

Be careful with the JSON syntax.

Dashboard ID in the response corresponds to cloned dashboard.