Calendaring: Generate Suggested Term

cholly75 commented 6 months ago

As a Court user, so that creating a new term is as easy as possible, I need DAWSON to use its data to provide me with suggested term calendar sessions in a way that allows collaboration to happen.

Pre-Conditions

Acceptance Criteria

Petitions clerks, Case Services Supervisors and Clerk of the Court users can click a button to invoke the "Create Term" workflow
Create Term workflow allows the user to input a trial term, name, and start/end date
Output of the Create Term workflow is a downloaded spreadsheet (preference would be XLSX) that calculates the trial sessions that should be scheduled for the term, based on ruleset (see UX comments below for ruleset, see notes for example template)
- Columns: weeks in the date range specified (labeled w/ date of the Monday of each week)
- Rows: cities
- Final Row: No. of Sessions that week (totaling number of sessions in a given column)
- Cells: Type of trial session (small, regular, hybrid) scheduled for that week
Any already scheduled New/Calendared Special trial sessions are incorporated into the calculation/spreadsheet output
NO trial sessions are scheduled/created in this operation - this is strictly generation and download of a spreadsheet
Spreadsheet filename = [TermName].whatever

Notes

Reminders.pdf

Tasks

Test Cases

Story Definition of Ready (updated on 12/23/22)

The following criteria must be met in order for the user story to be picked up by the Flexion development team. The user story must:

[ ] Is framed in business/user need, the value has been addressed.
[ ] Includes acceptance criteria
[ ] Has been refined
[ ] Pre conditions have been satisfied.

Process: Flexion developers and designers will test if the story meets acceptance criteria and test cases in Flexion dev and staging environments (“standard testing”). If additional acceptance criteria or testing scenarios are discovered while the story is in progress, a new story should be created, added to the backlog and prioritized by the product owner.

Definition of Done (Updated 5-19-22)

Product Owner

[ ] Acceptance criteria have been met and validated on the Court's migration environment
[ ] Add scenario to testing document, if applicable (https://docs.google.com/spreadsheets/d/1FUHKC_YrT-PosaWD5gRVmsDzI1HS_U-8CyMIb-qX9EA/edit?usp=sharing)

UX

[ ] Business test scenarios have been refined to meet all acceptance criteria
[ ] Usability has been validated
[ ] Wiki has been updated (if applicable)
[ ] Story has been tested on a mobile device (for external users only)

Engineering

[ ] Automated test scripts have been written, including visual tests for newly added PDFs.
[ ] Field level and page level validation errors (front-end and server-side) integrated and functioning.
[ ] Verify that language for docket record for internal users and external users is identical.
[ ] New screens have been added to pa11y scripts.
[ ] All new functionality verified to work with keyboard and macOS voiceover https://www.apple.com/voiceover/info/guide/_1124.html.
[ ] READMEs, other appropriate docs, and swagger/APIs fully updated.
[ ] UI should be touch optimized and responsive for external only (functions on supported mobile devices and optimized for screen sizes as required).
[ ] Interactors should validate entities before calling persistence methods.
[ ] Code refactored for clarity and to remove any known technical debt.
[ ] If new docket entries have been added as seed data to efcms-local.json, 3 local s3 files corresponding to that docketEntryId have been added to web-api/storage/fixtures/s3/noop-documents-local-us-east-1
[ ] Acceptance criteria for the story has been met.
[ ] If there are special instructions in order to deploy into the next environment, add them as a comment in the story.
[ ] If the work completed for the story requires a reindex without a migration, or any other special deploy steps, apply these changes to the following flexion branches:
- [ ] experimental1
- [ ] experimental2
- [ ] experimental3
- [ ] experimental4
- [ ] experimental5
- [ ] experimental6
- [ ] develop
[ ] Reviewed by UX on a deployed environment.
[ ] Reviewed by PO on a deployed environment. Can be deployed to the Court's test environment if prod-like data is required. Otherwise deployed to any experimental environment.
[ ] Deployed to the Court's staging environment.

katiecissell commented 2 months ago

UX Notes:

Please see Figma file for full comments

A new link is added to the trial sessions page. It is visible regardless of what tab you are viewing. Only Petitions clerks, Case Services Supervisors and Clerk of the Court will see the link.

When the link is clicked a modal appears.

When create term is clicked, Dawson will create a .xlsx or .csv file (depending on the engineers feedback when they pick this ticket up.) The file will create a calendar of the term and divide the eligible cases for each location into sessions. It will also respect additional rules outlined in the figma file. A loading state will be used while Dawson creates this file. When its done, the file will be downloaded to the user's computer/browser.

No specials or hybrid S's will be generated by this calendar. (existing specials already scheduled will show)

Hardcoded Session creation rules:

ttlenard commented 1 month ago

Test Cases

1) Petitions Clerk accesses the Trial Sessions Page; new link that says, "Create Term" displays to the left of the Trial Session Planning Report link at the top of the page.

Log in as a Petitions Clerk
Click on the Trial Sessions Header

Expected Results:

[ ] NEW FUNCTIONALITY - There is a new link for "Create Term" to the left of the Trial Session Planning report link.
[ ] NEW FUNCTIONALITY - Link is selected when a user tabs through the screen

2) Petitions Clerk clicks on the "Create Term" link; new modal displays.

Continuing from the previous test
Click on the Create Term link

Expected Results:

[ ] NEW FUNCTIONALITY - A new modal displays that matches the mockup
[ ] NEW FUNCTIONALITY - Clicking close in the upper right closes the modal and the user is navigated back to the Trial Sessions Screen
[ ] NEW FUNCTIONALITY - Clicking on the Cancel button closes the modal and the user is navigated back to the Trial Sessions Screen.
[ ] NEW FUNCTIONALITY - Clicking on the Create Term button without entering in any data displays validation errors to the user (see mocks).
[ ] NEW FUNCTIONALITY - Clicking on the Trial Term dropdown displays the next three terms (terms should not be in the past)
[ ] NEW FUNCTIONALITY - Clicking on the calendar icon displays a calendar picker; user is unable to select a date in the past on the picker.
[ ] NEW FUNCTIONALITY - If a user manually inputs a date in the past, a validation error is displayed.
[ ] NEW FUNCTIONALITY - If a user manually types in a date in an incorrect format (not MM/DD/YYYY), a validation error is displayed

3) Petitions Clerk adds in valid data into the modal; Clicks Create Term button; User sees a loading screen.

Continuing from the previous test
Input all valid data
Click Create Term button

Expected Results:

[ ] NEW FUNCTIONALITY - Screen displays the loading screen to the user. (Dev discretion on if it is the async progress bar or the spinner on the screen)

4) Loading screen completes; Document is downloaded to the user's computer.

Continuing from the previous test
Loading screen completes

Expected Results:

[ ] NEW FUNCTIONALITY - Windows explorer (or similar) displays for the user to select where on their device that they would like to save a xlsx document (dev discretion on if it is xlsx or csv).
[ ] NEW FUNCTIONALITY - File name for the document is [TermName].xlxs

5) Petitions Clerk opens the file; reviews generated Spreadsheet of the Term that was created.

Continuing from the previous test
Open the document and review the data

Expected Results:

[ ] NEW FUNCTIONALITY - Top row displays "Week Of"
[ ] NEW FUNCTIONALITY - Next row is the header row that includes "City" in the first column, followed by a horizontal list of weeks (labeled with the date of the Monday of each week) depending on the term dates that were input in the modal
[ ] NEW FUNCTIONALITY - First column includes a list of Trial cities in alphabetical order
[ ] NEW FUNCTIONALITY - Last row is titled No. of Sessions, and includes the total number of sessions in each column
[ ] NEW FUNCTIONALITY - Generated sessions for regular display in Green
[ ] NEW FUNCTIONALITY - Generated sessions for small display in Blue
[ ] NEW FUNCTIONALITY - Generated sessions for Hybrid display in Purple
[ ] NEW FUNCTIONALITY - Any already calendared Special sessions that fall within the selected Term are displayed on the correct week and are Orange.

6) Petitions clerk pulls a Trial Session Planning Report; Using the data from that report, compare the results in the Generated Suggested Term spreadsheet with the data on the planning report.

Continuing from the previous test
Review the suggested sessions for each week/city based on the eligible Regular and small cases, and if sessions have been scheduled at the location in the previous terms.

Expected Results:

[ ] NEW FUNCTIONALITY - For all weeks in the term, there is a maximum of 6 sessions per week (this includes any already scheduled special sessions)
[ ] NEW FUNCTIONALITY - For any location, there is a maximum of 5 sessions per location (this includes any already scheduled special sessions)
[ ] NEW FUNCTIONALITY - For a location that has less than 40 regular cases, a regular session is NOT created
[ ] NEW FUNCTIONALITY - For a location that has 40 or more regular cases, a regular session may be created
[ ] NEW FUNCTIONALITY - For a location that has more than 140 regular cases, 2 regular sessions may be created
[ ] NEW FUNCTIONALITY - For a location that has less than 40 small cases, a small session is NOT created
[ ] NEW FUNCTIONALITY - For a location that has 40 or more small cases, a small session may be created
[ ] NEW FUNCTIONALITY - For a location that has more than 165 small cases, 2 small sessions may be created
[ ] NEW FUNCTIONALITY - For a location that has 40 or more regular cases, a regular session may be created
[ ] NEW FUNCTIONALITY - For a location that has at least 50 small + regular cases combined, a hybrid session may be created
[ ] NEW FUNCTIONALITY - For a location that has not had any sessions calendared in the previous two terms, any session type (small, reg, hybrid) must be created. This session will be created regardless of it there are a minimum number of cases.

*DEV QUESTION - If I generated multiple suggested terms, will there be a different result each time? Is there randomization involved in generating the data? If yes, we will want to repeat test case 6 and 7 to ensure that the rules still apply even when the placement of suggested terms is random.

7) Petitions Clerk unblocks a number of cases for a few locations; re-runs the trial session planning report; Generates a new suggested term; results in the spreadsheet reflect the changes and sessions are suggested appropriately.

Continuing from the previous test
Pull the blocked cases report
Unblock a number of cases for a requested trial locations
Next, generate a trial session planning report to see the changes in the eligible case numbers
Next, Generate a suggested term
Review the suggested sessions for each week/city based on the eligible regular and small cases, and if sessions have been scheduled at the location in the previous terms.

Expected Results

[ ] NEW FUNCTIONALITY - All of the test cases from test case 6 pass
[ ] NEW FUNCTIONALITY - The city that you unblocked multiple cases in may have a different result in the suggested term spreadsheet.

8) Regression test to ensure that no sessions are actually created.

As a petitions clerk, navigate to the Trial Sessions tab
Review the existing sessions (new/open)

Expected Results:

[ ] No new sessions were created when generated the suggested term spreadsheet.

9) Repeat all of the tests with the following users:

[ ] Clerk of the Court
[ ] Case Services Supervisor

TomElliottFlexion commented 2 days ago

New Rules: - Prioritize larger of small vs regular set of eligible cases

Apply same rule to hybrid (leftover) sessions
(Don't worry about it yet: Low volume cities should not be prioritized)

flexion / ef-cms