Export Dashboard to Scheduled Reports #24019

chippison · 2026-01-28T00:57:48Z

Description

DEV-19806

We want to add in a functionality to export the current dashboard into a Scheduled Report. This will attempt to map dashboard widgets with reports available to be scheduled.

This will not be a perfect 1-1 relationship between dashboard widget and scheduled reports and there will be some widgets that will not be mapped to a report. The user will be informed/notified about the missing dashboard widgets in an infoobox that will show everytime we export a dashboard.

This will cover 3 JIRA issues:
https://innocraft.atlassian.net/browse/DEV-19804
https://innocraft.atlassian.net/browse/DEV-19805
https://innocraft.atlassian.net/browse/DEV-19806

Acceptance Criteria:

A new link is added under the Dashboard selector menu, in the section “Manage this dashboard”
- The link label is: “Export this dashboard”
- The link is positioned as the first item in the section, above “Reset dashboard”
- The link is visible to all users, including:
  - View users
  - Users without write permissions
  - Anonymous users (eg. demo environments)
Clicking the link
- Works for authenticated users with at least View access
- Redirects unauthenticated users to the login flow as per existing behaviour
Clicking “Export this dashboard” redirects the user to Create and Schedule a report
Matomo (in the Dashboard plugin controller) will automatically map:
- Dashboard widgets → report list.
Widgets without a corresponding report are excluded from the export configuration
- Example: “About Matomo” widgets
When the user lands on the Create and Schedule a report page via this dashboard link:
- A new info box is displayed at the top of the page
- This info box is only shown when coming from a dashboard export action
- Proposed text in the JIRA issue DEV-19806
Report configuration defaults
- Report description
  - Automatically pre-filled
  - Editable by the user
  - Proposed text in the JIRA issue DEV-19806
- Report selection
  - All reports that match widgets from the dashboard are pre-selected
  - Reports that do not match a widget remain unselected

Checklist

[✔] I have understood, reviewed, and tested all AI outputs before use
[✔] All AI instructions respect security, IP, and privacy rules

Review

…not logged in

…mDimensions

…unning/calling multiple functions to get report index

…nstead of json of its widgets. We will just make an ajax request to grab needed data on ManageScheduledReport.vue

…and we only call this when dashboardId is present in the URL

…of it being done on the index action of controller

…h unmapped widgets

…ses yet

…t follow our default pattern

…apper as this is relevant here;

…tMapper as this is relevant here;

… exported as we know these do not show reports

…atomoLoader component

…-19806

…e sure we return an array with complete keys

chippison · 2026-01-28T20:41:07Z

plugins/Dashboard/vue/src/DashboardSettings/DashboardSettings.vue

+        ...MatomoUrl.urlParsed.value,
+      } as QueryParameters;
+
+      delete query.category;


This is just to clear off unrelated parameters in the URL and hash

…r the refresh instead of before so that we can clearly see the notification for save and update

chippison · 2026-01-29T00:08:11Z

plugins/Dashboard/vue/src/DashboardSettings/DashboardSettings.vue

+
+      hash.idDashboard = dashboardId;
+      delete hash.category;
+      delete hash.subcategory;


…if the Ajax call is rejected or errors out

chippison added this to the 5.7.0 milestone Jan 28, 2026

chippison and others added 29 commits January 28, 2026 14:02

adding link to export dashboard

8478ec9

rebase branch with 5.x-dev

16db504

grabbing dashboard widgets as well as redirecting to login page when …

1fb197c

…not logged in

rebasing

7db1a3e

making widget report mapper be able to handle CustomReports and Custo…

c61c889

…mDimensions

refactoring widget mapper so that we use only 1 function instead of r…

63d8eea

…unning/calling multiple functions to get report index

refactoring so that we only pass in dashboardId to ScheduledReports i…

e6a0b28

…nstead of json of its widgets. We will just make an ajax request to grab needed data on ManageScheduledReport.vue

adding in new API so that we can grab widget-report mapping via AJAX …

def7ed5

…and we only call this when dashboardId is present in the URL

cleaning up code since we are using AJAX to grab the mapping instead …

6073d68

…of it being done on the index action of controller

rebuilt ScheduledReports minified files

4181e81

Build vue files

729ab5a

removed unused files

8ade744

showing info message enumerating the widgets that are not mapped

44f71b1

adding built files and an integration test to test report mapping wit…

4947f2d

…h unmapped widgets

removing manual overrides for now, since we don't have any special ca…

8816c3e

…ses yet

adding new mapping function for edge case widgets-reports which do no…

68b00f1

…t follow our default pattern

adding new mapping function for getting event widgets

953097b

adding the dashboard name to the returned values from the API

280f00e

adding infobox to inform the user about the exported dashboard

297bbd5

adding some tests

0ad41d0

rebuild js files after rebase

b5af8f3

refactoring getting of widget names by id function into WidgetReportM…

34893e5

…apper as this is relevant here;

refactoring extracting widgetid from layout function into WidgetRepor…

959f5b8

…tMapper as this is relevant here;

adding a blacklist of widgets that we can disregard/ignore from being…

2e44296

… exported as we know these do not show reports

adding/updating test

f194d87

removed use of jquery; removing unused code

fc63fc1

simplifying API to get widgetreport map

0665462

refactoring ManageScheduledReport.vue so that we only need to use 1 M…

c7668ed

…atomoLoader component

update built files

fc83902

chippison force-pushed the dev-19806 branch from 17a5cc4 to fc83902 Compare January 28, 2026 01:03

innocraft-automation and others added 5 commits January 28, 2026 01:17

Build vue files

0a5a506

fixed some phpcs errors

4864f8f

Merge remote-tracking branch 'refs/remotes/origin/dev-19806' into dev…

ea48823

…-19806

fixing issue with loader not disappearing after loading the page. mad…

acdd611

…e sure we return an array with complete keys

fixing test error; updating expected screenshot

41b3869

chippison commented Jan 28, 2026

View reviewed changes

chippison and others added 5 commits January 29, 2026 09:48

updating how ManageScheduledReport shows notification to show it afte…

38b47bc

…r the refresh instead of before so that we can clearly see the notification for save and update

Build vue files

7aca3fc

refactoring so that we use more consistent naming of dashboard id

3868dac

rebuilding dist

c7b0b04

updating screenshots

95d9af5

chippison modified the milestones: 5.7.0, 5.8.0 Jan 29, 2026

chippison commented Jan 29, 2026

View reviewed changes

chippison marked this pull request as ready for review January 29, 2026 00:37

chippison requested a review from a team January 29, 2026 00:37

chippison added 4 commits February 9, 2026 18:58

removed duplicated translation key

1ee6cca

adding a check that key exists in array before accessing it

4ca4e24

refactored so that we fix the race condition that was found earlier

dbaf916

fixing issue where createReport function is not called or never runs …

997e348

…if the Ajax call is rejected or errors out

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Export Dashboard to Scheduled Reports #24019

Export Dashboard to Scheduled Reports #24019

chippison commented Jan 28, 2026 •

edited

Loading

Uh oh!

chippison Jan 28, 2026

Uh oh!

chippison Jan 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

2 participants

Uh oh!

Export Dashboard to Scheduled Reports #24019

Are you sure you want to change the base?

Export Dashboard to Scheduled Reports #24019

Conversation

chippison commented Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Acceptance Criteria:

Checklist

Review

Uh oh!

chippison Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

chippison Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

2 participants

chippison commented Jan 28, 2026 •

edited

Loading