anomaly-detection-dashboards-plugin icon indicating copy to clipboard operation
anomaly-detection-dashboards-plugin copied to clipboard

[UX] Edit forecast

Open xeniatup opened this issue 1 year ago • 0 comments

[UX META] OpenSearch Dashboards Forecasting Dev Ops Metrics [Proposal] Forecasting Dev Ops Metrics and Financial/Inventory Metrics

What solution would you like?

  • Forecast page serves both view and edit experiences. The layout is organized by using Described form groups in read-only or editable states respectively.
  • User can view and edit forecast configuration in “Configuration” tab that includes data source details and model parameters. User can view and edit forecast name, description and storage options in “Details” tab.
  • To turn the form into editable state user selects “Edit” in the top right corner of the tab content.
  • To be able to edit forecast in one of the states that are updating on every interval to produce a new datapoint or perform a check for the new data (“Running”, “Initializing test”, “Initializing forecast”, “Awaiting data to initialize forecast”, “Awaiting data to restart forecast”) user will stop or cancel forecast beforehand. Stopping forecast or cancelling awaiting data will transition the forecast into “Inactive” state.
  • If user selects “Cancel” to discard the changes or exit the edit mode, the forecast needs to be restarted (By selecting “Test” or “Start forecast”) to go into its initial state.
  • Changing forecast configuration will regenerate the visualization. This will not allow to display previously stored historical forecasts on the visualizations. User needs to be aware of this potential change while selecting to edit a forecast in “Awaiting data to restart” or “Running state”.
  • User might attempt a conflicting action while editing the forecast (examples: selecting an action from the header, navigating away from the page). In this cases a conflicting action modal will be displayed.

Screen 3.9: Stop forecast to edit modal dialog Screenshot 2023-07-29 at 6 56 58 PM

Stop/Cancel to edit modal dialog messaging

State Modal header Callout Message CTAs
Initializing test - both tabs Cancel initializing the test to edit? - You must cancel the test initialization before editing its configuration. After making changes to the forecast, restart the forecast.
  • Cancel and edit (primary)
  • Cancel
Initializing forecast - both tabs Cancel initializing the forecast to edit? - You must cancel the forecast initialization before editing its configuration. After making changes to the forecast, restart the forecast.
  • Cancel and edit (primary)
  • Cancel
Awaiting data to initialize forecast - both tabs Cancel forecast to edit? - You must cancel the forecast before editing its configuration. After making changes to the forecast, restart the forecast.
  • Cancel and edit (primary)
  • Cancel
Awaiting data to restart - Configuration tab Cancel forecast to edit? Editing forecast will wipe historical visualizationsChanging any of the data source or model parameters affects the forecast results and wipes out any historical forecast visualizations. You must cancel the forecast before editing its configuration. After making change to the forecast, restart the forecast.
  • Cancel and edit (primary)
  • Cancel
Awaiting data to restart - Details tab Cancel forecast to edit? - You must cancel the forecast before editing its configuration. After making changes to the forecast, restart the forecast.
  • Cancel and edit (primary)
  • Cancel
Running - Configuration tab Stop forecast to edit? Editing forecast will wipe historical visualizationsChanging any of the data source or model parameters affects the forecast results and wipes out any historical forecast visualizations. You must stop the forecast before editing its details. After making changes to the forecast, restart the forecast.
  • Stop and edit (primary)
  • Cancel
Running - Details tab Stop forecast to edit? - You must stop the forecast before editing its details. After making changes to the forecast, restart the forecast.
  • Stop and edit (primary)
  • Cancel

Screen 3.10: Configuration tab in read-only mode

Screenshot 2023-07-29 at 7 02 34 PM

Screen 3.11: Configuration tab in editable mode Screenshot 2023-07-29 at 7 03 37 PM

Screen 3.12: Details tab in read-only mode Screenshot 2023-07-20 at 12 59 50 PM

Screen 3.13: Details tab in editable mode Screenshot 2023-07-20 at 1 06 08 PM

State transitions for editing a forecast

Read-only state Editable state Configuration tab bottom bar buttons Details tab bottom bar buttons
Inactive Inactive
  • Update and test (primary)
  • Update
  • Cancel
Update (primary)Cancel
Inactive:stopped Inactive:stopped
  • Update and test (primary)
  • Update
  • Cancel
  • Update (primary)
  • Cancel
Awaiting data to initialize Inactive:stopped
  • Update and test (primary)
  • Update
  • Cancel
  • Update (primary)
  • Cancel
Awaiting data to restart Inactive:stopped
  • Update and test (primary)
  • Update
  • Cancel
  • Update (primary)
  • Cancel
Initializing test Inactive
  • Update and test (primary)
  • Update
  • Cancel
  • Update (primary)
  • Cancel
Initializing forecast Inactive
  • Update and test (primary)
  • Update
  • Cancel
  • Update (primary)
  • Cancel
Test complete Test complete
  • Update and test (primary)
  • Update
  • Cancel
  • Update (primary)
  • Cancel
Running Inactive: stopped
  • Update and test (primary)
  • Update
  • Cancel
  • Update (primary)
  • Cancel
Initializing forecast failed Initializing forecast failed
  • Update and test (primary)
  • Update
  • Cancel
  • Update (primary)
  • Cancel
Forecast failed Forecast failed
  • Update and test (primary)
  • Update
  • Cancel
  • Update (primary)
  • Cancel
Initializing test failed Initializing test failed
  • Update and test (primary)
  • Update
  • Cancel
  • Update (primary)
  • Cancel

Screen 3.14: Conflicting action modal

Screenshot 2023-07-20 at 1 10 30 PM

Delete forecast

User can delete a forecast from the Forecasts list view or from a forecast page. When user selects “Delete” button, the system displays the confirmation modal to avoid accidental deletion. For the running state and for initializing test or initializing forecast the confirmation modal contains a callout highlighting the state of the forecast. No cancelling or stopping is required to delete a forecast.

Screen 3.15: Delete forecast confirmation modal dialog. Screenshot 2023-07-25 at 4 47 11 PM

xeniatup avatar Jul 31 '23 19:07 xeniatup