[ResponseOps][Reporting] Scheduled report flyout UI by umbopepato · Pull Request #222135 · elastic/kibana

umbopepato · 2025-05-31T09:05:22Z

Summary

Important

This PR is targeting the scheduled-reports-ui feature branch, where the backend changes from the scheduled-reports branch are temporarily integrated while waiting for #221028 to be merged (see the squashed [TMP] ... commit message).

Implements the flyout UI for the creation and read-only viewing of scheduled reports (exports).

Known issues

Console error due to compressed attribute wrongly forwarded by form-hook-lib to DOM element (this is likely a form lib issue):
Email validation errors accumulate instead of replacing the previous one (again looks like a fom lib issue):
https://github.com/user-attachments/assets/f2dc7a46-a3a9-465d-b8a1-3187b200f9b9

Screenshots

Health API error:

Health API loading state:

Health API success with some missing prerequisites:

Form validation:

Success toast:

Failure toast:

Print format toggle:

Missing notifications email connector callout:

References

Closes #216321
Stacked on #220535

elasticmachine · 2025-06-18T10:58:08Z

Pinging @elastic/response-ops (Team:ResponseOps)

ymao1

Comments from verification:

License

running with a basic license, I can see the Schedule Reports button in Discover. scheduled reporting is not available in basic even though single CSV exports is. We should hide the button
same comment about basic license and Schedule Report button in Lens. We allow CSV exports through lens but should not allow scheduling reports
export button for Dashboard correctly hidden for basic license 👍

Email notifications

email option correctly disabled when notifications are not properly configured 👍
email only allows setting to option. do we want to allow setting cc and bcc addresses?
if I click Schedule without filling in an email address, I get a validation error in the to field and an error toast is shown. The schedule button is disabled and shows a loading spinner. Filling out the to field does not reenable the schedule button.

Security or API keys turned off

when ES security is false or API keys are disabled, we show the Schedule export button but open a flyout that just shows an error. The Schedule button on the flyout is still enabled and an error toast shows up if you click it. Do we want to just show a disabled Schedule export button in the dropdown and skip opening the flyout altogether?

Scheduling

seems to me that the now date is set when the flyout is opened, not when the request is made, so let's say you open the flyout at 8:00, mess around with the options and don't click the schedule button until 8:03. The schedule will be set to recur (daily/weekly/monthly) at 8:00.
could we show the HH:MM time when scheduling? right now it says Repeats every Wednesday. Could we have it say Repeats every Wednesday at 08:00?

umbopepato · 2025-06-18T14:05:11Z

Thanks for taking a look Ying! I still haven't had time to update the description and add comments but itm about these points:

License

running with a basic license, I can see the Schedule Reports button in Discover. scheduled reporting is not available in basic even though single CSV exports is. We should hide the button

same comment about basic license and Schedule Report button in Lens. We allow CSV exports through lens but should not allow scheduling reports

export button for Dashboard correctly hidden for basic license 👍

I thought the prerequisiteCheck was removed by the new share plugin extension point, it turns out it's not (I was just trying to add it in the wrong place)! I added back the license check, which according to the conversation on licensing you had with Tia on Slack seems like it's license.type !== 'basic'? If it's more nuanced let me know and I can update it.

Email notifications

email only allows setting to option. do we want to allow setting cc and bcc addresses?

I know the notification object of the schedule API has more options but the mockups only show a To field so I concentrated on that one. @tiamliu and @joana-cps probably wanted to start from a simple configuration and add the other recipient fields in the future?

if I click Schedule without filling in an email address, I get a validation error in the to field and an error toast is shown. The schedule button is disabled and shows a loading spinner. Filling out the to field does not reenable the schedule button.

My bad! I removed an intermediate component level last minute to remove a hack to adapt to the new share API and missed a form.validate() call. Fixed!

Security or API keys turned off

when ES security is false or API keys are disabled, we show the Schedule export button but open a flyout that just shows an error. The Schedule button on the flyout is still enabled and an error toast shows up if you click it. Do we want to just show a disabled Schedule export button in the dropdown and skip opening the flyout altogether?

~~This is a bit tricky since the health API call would need to be moved outside or React (and thus React Query) and in a check function that is not async... Let me see what I can do.~~
Edit: done ✅

Scheduling

seems to me that the now date is set when the flyout is opened, not when the request is made, so let's say you open the flyout at 8:00, mess around with the options and don't click the schedule button until 8:03. The schedule will be set to recur (daily/weekly/monthly) at 8:00.

This is something we discussed in a meeting last Friday with @tiamliu. If I remember correctly the point was not confusing the user with a preview that doesn't correspond to the actual time used for scheduling (I have to pass a start date right away to the recurrence form, and all suggestions will be based on that date, but then the real schedule would be based on a different time - when executing the request - that the user doesn't have visibility on). I know it's not ideal and I'm open to all possibilities.

could we show the HH:MM time when scheduling? right now it says Repeats every Wednesday. Could we have it say Repeats every Wednesday at 08:00?

~~Sure, I'll extend the preview generator.~~
Edit: done ✅

umbopepato · 2025-06-19T15:46:27Z

src/platform/packages/shared/response-ops/recurring-schedule-form/types.ts

  customFrequency?: RecurrenceFrequency;
  byweekday?: Record<string, boolean>;
  bymonth?: string;
+  bymonthweekday?: string;


These are needed to be able to view previously created scheduled reports since they (still) don't have a start date, which was used to compute all this information

umbopepato · 2025-06-19T15:49:18Z

...ck/platform/plugins/private/reporting/public/management/components/responsive_form_group.tsx

+ * A collapsible version of EuiDescribedFormGroup. Use the `narrow` prop
+ * to obtain a vertical layout suitable for smaller forms
+ */
+export const ResponsiveFormGroup = ({


EuiDescribedFormGroup seemed the perfect component for the groups with titles, but it doesn't have a column version, so I added one here. If we ever need to expand this form in a standalone page, we could use narrow = false and get an expanded UX

FWIW I did it this way

kibana/src/platform/packages/shared/response-ops/alerts-delete/components/descriptive_form_group.tsx

Line 66 in b759ebb

css={css`

, which should be responsive by default

Ah that's nice! We could propose Eui to integrate your solution in the original one 🙂

umbopepato · 2025-06-19T15:49:55Z

.../platform/plugins/private/reporting/public/management/components/scheduled_report_flyout.tsx

+  onClose,
+}: ScheduledReportFlyoutProps) => {
+  return (
+    <EuiFlyout size="m" maxWidth={500} paddingSize="l" ownFocus={true} onClose={onClose}>


We need this layer because the export menu controls the rendering of the outer flyout layer, but we have to open it too in the Reports page

jcger · 2025-06-20T08:51:54Z

...m/plugins/private/reporting/public/management/components/scheduled_report_flyout_content.tsx

+            iconType="error"
+            color="danger"
+          >
+            <p>{i18n.UNMET_REPORTING_PREREQUISITES_MESSAGE}</p>


could we add more info for easier debug?

This was a temporary text, but I moved the prerequisites check before registering the schedule export button altogether so you shouldn't be able to open it and see this error at all. I kept it just for extra safety, I'll ask docs to have a look and suggest a better message

jcger · 2025-06-20T08:54:35Z

...m/plugins/private/reporting/public/management/components/scheduled_report_flyout_content.tsx

+        onClose();
+      }
+    } catch (e) {
+      // Keep the flyout open in case of schedule error


should we also console.error(e) to make it easier to debug?

jcger · 2025-06-20T09:18:56Z

x-pack/platform/plugins/private/reporting/public/management/utils.ts

    [JOB_STATUS.WARNINGS, JOB_STATUS.FAILED].some((status) => job.status === status)
  );
 };
+


I see no tests for these new functions, but they seem complex enough to have some

jcger · 2025-06-20T09:20:01Z

x-pack/platform/plugins/private/reporting/public/management/validators/emails_validator.ts

+import { getInvalidEmailAddress, getNotAllowedEmailAddress } from '../translations';
+import type { ScheduledReport } from '../../types';
+
+export const getEmailsValidator =


we also might need to test this

jcger · 2025-06-20T09:21:27Z

x-pack/platform/plugins/private/reporting/public/plugin.ts

      );
    }

+    import('./management/integrations/scheduled_report_share_integration').then(


what's the reason for this being imported dynamically? just curious

When imported statically it broke the page load bundle size limit for reporting, see
https://buildkite.com/elastic/kibana-pull-request/builds/309752/summary/annotations?jid=01978228-643a-4d7d-810e-4cd9e2596513

joana-cps

The Reporting page link should point to the reporting page with the exports tab selected. Currently, it is pointing to the schedules tab, and we are not listing the reports there.

Can you also make it open in a new browser tab?

joana-cps

It feels weird to see the Exports sections in the View schedule information read-only flyout, especially when we display the callout about the email connector.
Should we hide this section altogether if 'Send by email' is off?

joana-cps

The Daily behaviour is strange. If we display the days of the week, they should all be selected by default when the user selects Daily. Otherwise, even though I select Daily only friday is selected and a report is exported as "Repeats every Friday at xxx".

joana-cps

Inconsistent icon for CSV export. Since the documents icon will be deprecated, let's use tableDensityExpanded for CSV and document for PDF.

umbopepato · 2025-06-20T14:26:43Z

The `Reporting page` link should point to the reporting page with the exports tab selected. Currently, it is pointing to the schedules tab, and we are not listing the reports there.
Can you also make it open in a new browser tab?

This is because in this PR I don't have the other tab, this can be done when integrating the flyout with the list page

joana-cps · 2025-06-20T14:49:21Z

Email notifications

email only allows setting to option. do we want to allow setting cc and bcc addresses?

I know the notification object of the schedule API has more options but the mockups only show a To field so I concentrated on that one. @tiamliu and @joana-cps probably wanted to start from a simple configuration and add the other recipient fields in the future?

Yes, it was a decision made in the first design review to keep it simple in the first version.

umbopepato · 2025-06-20T14:56:47Z

The `Daily` behaviour is strange. If we display the days of the week, they should all be selected by default when the user selects `Daily`. Otherwise, even though I select `Daily` only friday is selected and a report is exported as "Repeats every Friday at xxx".

Good point! That part of the form is also shared with MWs though so let's maybe track this as a separate improvement?

ymao1 · 2025-06-20T15:08:14Z

...gins/private/reporting/public/management/integrations/scheduled_report_share_integration.tsx

+      if (!license) {
+        return false;
+      }
+      return license.type !== 'basic';


We added an allowlist for licenses here: f5f9d9d Not sure if you can reuse.

I couldn't import the list from there since it's marked as server code so I moved it to the common folder, hope it's fine 🙂

src/platform/plugins/shared/share/public/index.ts

eokoneyo · 2025-06-23T07:03:28Z

Inconsistent icon for CSV export. Since the documents icon will be deprecated, let's use tableDensityExpanded for CSV and document for PDF.

I have a PR for this here (the CSV part at least)

Co-authored-by: Eyo O. Eyo <7893459+eokoneyo@users.noreply.github.com>

elasticmachine · 2025-06-23T08:45:45Z

💚 Build Succeeded

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`reporting`	163	200	+37

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`@kbn/reporting-common`	97	98	+1
`@kbn/reporting-public`	103	106	+3
`share`	87	90	+3
total			+7

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`alerting`	92.0KB	93.7KB	+1.6KB
`fleet`	1.8MB	1.8MB	+52.0B
`reporting`	110.7KB	142.2KB	+31.5KB
total			+33.2KB

Public APIs missing exports

Total count of every type that is part of your API that should be exported but is not. This will cause broken links in the API documentation system. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats exports for more detailed information.

id	before	after	diff
`share`	15	21	+6

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`reporting`	50.8KB	52.9KB	+2.1KB
`share`	51.7KB	51.7KB	+26.0B
total			+2.1KB

Unknown metric groups

API count

id	before	after	diff
`@kbn/reporting-common`	107	108	+1
`@kbn/reporting-public`	110	113	+3
`share`	153	156	+3
total			+7

async chunk count

id	before	after	diff
`reporting`	4	6	+2

ESLint disabled in files

id	before	after	diff
`reporting`	0	1	+1

ESLint disabled line counts

id	before	after	diff
`reporting`	5	6	+1

Total ESLint disabled count

id	before	after	diff
`reporting`	5	7	+2

History

💔 Build #311264 failed bc6aa0c
💔 Build #311013 failed 03d14c9
💚 Build #310779 succeeded ff6ff75
💔 Build #310638 failed 7ff7bdb
💔 Build #310622 failed d7b861c

umbopepato force-pushed the 216321-scheduled-reports-flyout branch from 4dd68c2 to 0d3db10 Compare May 31, 2025 18:56

umbopepato force-pushed the 216321-scheduled-reports-flyout branch from f11a696 to a296181 Compare June 17, 2025 16:10

umbopepato changed the base branch from main to scheduled-reports-ui June 17, 2025 16:10

umbopepato force-pushed the 216321-scheduled-reports-flyout branch from a296181 to 51e811c Compare June 17, 2025 16:48

umbopepato changed the title ~~[ResponseOps][Reporting] Draft scheduled report flyout UI~~ [ResponseOps][Reporting] Scheduled report flyout UI Jun 17, 2025

umbopepato force-pushed the scheduled-reports-ui branch from d5b5d9a to 8abc15d Compare June 18, 2025 08:02

umbopepato force-pushed the 216321-scheduled-reports-flyout branch from 51e811c to 4d63748 Compare June 18, 2025 08:25

umbopepato added release_note:skip Skip the PR/issue when compiling release notes backport:skip This PR does not require backporting Team:ResponseOps Platform ResponseOps team (formerly the Cases and Alerting teams) t// labels Jun 18, 2025

umbopepato marked this pull request as ready for review June 18, 2025 10:58

umbopepato requested review from a team as code owners June 18, 2025 10:58

ymao1 added ci:cloud-deploy Create or update a Cloud deployment ci:cloud-persist-deployment Persist cloud deployment indefinitely labels Jun 18, 2025

ymao1 reviewed Jun 18, 2025

View reviewed changes

umbopepato requested a review from a team as a code owner June 18, 2025 16:42

umbopepato force-pushed the 216321-scheduled-reports-flyout branch 2 times, most recently from 4b7a882 to 623c801 Compare June 19, 2025 06:40

umbopepato requested review from a team as code owners June 19, 2025 06:40

js-jankisalvi mentioned this pull request Jun 19, 2025

[ResponseOps] [Reporting] Allow users to see scheduled reports list #224354

Merged

1 task

umbopepato force-pushed the scheduled-reports-ui branch from 8abc15d to 4805aee Compare June 19, 2025 13:37

umbopepato requested review from a team as code owners June 19, 2025 13:37

umbopepato commented Jun 19, 2025

View reviewed changes

umbopepato added 5 commits June 19, 2025 17:59

Catch schedule report errors

04cc893

Fix last Dashboard and Discover functional tests

9673dbf

Fix wrong page object method call

4b87914

More functional test fixes

7ff7bdb

Even more functional test fixes

ff6ff75

jcger approved these changes Jun 20, 2025

View reviewed changes

joana-cps reviewed Jun 20, 2025

View reviewed changes

ymao1 reviewed Jun 20, 2025

View reviewed changes

umbopepato and others added 5 commits June 20, 2025 17:16

Filter share items by ones that support scheduling

95c706a

Change csv export icon type

e9bf5cd

Log schedule errors to console

77e387a

Check license against allowlist

aab40a3

[CI] Auto-commit changed files from 'node scripts/notice'

03d14c9

eokoneyo reviewed Jun 23, 2025

View reviewed changes

src/platform/plugins/shared/share/public/index.ts Outdated Show resolved Hide resolved

umbopepato and others added 4 commits June 23, 2025 09:11

Fix circular TS proj dependency

03d256f

Combine import and export of useShareTypeContext into a single statement

0981e53

Co-authored-by: Eyo O. Eyo <7893459+eokoneyo@users.noreply.github.com>

[CI] Auto-commit changed files from 'node scripts/yarn_deduplicate'

bc6aa0c

Fix type error

bc68511

umbopepato mentioned this pull request Jun 24, 2025

[ReponseOps][Reporting] Allow users to schedule reports and view schedules list #224849

Merged

4 tasks

Conversation

umbopepato commented May 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Known issues

Screenshots

References

Uh oh!

elasticmachine commented Jun 18, 2025

Uh oh!

ymao1 left a comment

Choose a reason for hiding this comment

Uh oh!

umbopepato commented Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joana-cps left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joana-cps left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joana-cps left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joana-cps left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

umbopepato commented Jun 20, 2025

Uh oh!

joana-cps commented Jun 20, 2025

Uh oh!

umbopepato commented Jun 20, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

umbopepato Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

eokoneyo commented Jun 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

elasticmachine commented Jun 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

💚 Build Succeeded

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Public APIs missing exports

umbopepato commented May 31, 2025 •

edited

Loading

umbopepato commented Jun 18, 2025 •

edited

Loading

joana-cps left a comment •

edited

Loading

joana-cps left a comment •

edited

Loading

joana-cps left a comment •

edited

Loading

joana-cps left a comment •

edited

Loading

umbopepato Jun 20, 2025 •

edited

Loading

eokoneyo commented Jun 23, 2025 •

edited

Loading

elasticmachine commented Jun 23, 2025 •

edited

Loading