Petitions Clerk: Direct Scan of Paper filings, preview and associate with case

As a Petitions Clerk, in order to make sure the right document gets uploaded, I need the ability to scan paper documents directly into the system and review the document before it is associated with a case/docket entry.

The Court will continue to receive paper Petitions. As a result, Petitions Clerks will need the ability to get those paper documents into the system. The idea that a clerk would scan, save, and upload the document leaves a lot of room for error that the wrong document will be uploaded. Plus, it involves multiple steps. To avoid this, the Petitions Clerks will need the ability to directly scan a document into the system (#1066) and be provided a review feature (#1566) before doc is associated with case/docket entry

Pre-Conditions:

Petitions Clerk has paper filing

Acceptance Criteria:

we would need to apply a cover sheet
Petitions Clerk has the ability to scan paper documents directly into the system without having to perform a separate scan, save and upload function.
The Petitions Clerk can see that the document has been scanned successfully into the system
Petitions Clerk can preview the content of the document that was uploaded to confirm it's correct
Petitions Clerk can delete the document if it's incorrect or scanned poorly
upon submission, scans become associated with the case
Once associated with the case, the scanned petition is available for the Petitions Clerk to start the QC process.
~ Remove scan button once the scan is complete. we're going to keep this button for now~
Reduce chances of user accidentally clearing a scan

Notes:

~should we include CLAM AV virus scans for internal users as well? no~
Some documents require multiple scans (more than 50 pages) to create one document
Design note 6/10/19 - consider removing scan button once the document has been uploaded

Tasks:

In Trello: https://trello.com/b/hCZ0JD3v/efcms-one-team

Definition of Done (Updated 7-10-19)

Product Owner

[x] Acceptance criteria have been met

[x] Usability has been validated

Team

[x] Test scenarios to meet all acceptance criteria have been written (Jojo #2558)

Engineering

[x] Field level and page level validation errors (front-end and server-side) integrated and functioning (Cody #2596)
[x] New screens have been added to pa11y scripts
[x] All new functionality verified to work with keyboard and macOS voiceover https://www.apple.com/voiceover/info/guide/_1124.html (Matt #2582, #2592)
[x] READMEs, other appropriate docs, JSDocs and swagger/APIs fully updated (Matt #2631)
[x] UI should be touch optimized and responsive for external only (functions on supported mobile devices and optimized for screen sizes as required) (Matt)
[x] Module dependencies are up-to-date and are at the latest resolvable version (npm update) (JoJo #2630)
[x] Errors in Sonarcloud are fixed https://sonarcloud.io/organizations/flexion-github/projects (Matt #2600)
[x] Lambdas include CloudWatch logging of users, inputs and outputs (Matt #2594)
[x] Code refactored for clarity and to remove any known technical debt (Cody #2596)
[x] Deployed to the dev environment

Test Scenarios: Updated 8/2

Set-Up Flow

Petition clerk logs in
Navigates to Document QC
Selects “Create Case”
Sees “Case Information” page
Petition Document tab is selected by default
Scan radio button is selected by default

First Use - Install Flow

User is prompted to download and install scan utility software
Click download
Software downloads
User installs software to computer
User returns to Case Information page and refreshes

First Use - Cancel Install Flow

Sees prompt to download and install scan utility software
Clicks "X" to cancel download
Returns to Case Information page after install
Can upload documents but not scan

Select Scanner Flow

Clicks “Select Scanner” link
Sees modal window with list of available scanners
Selects a scanner
Clicks “OK”
Modal closes
Sees selected scanner name
“Select Scanner” link is hidden; “Change” link displays
Clicks "Cancel" / "Close"
Modal closes without action

Petition Upload Flow

Selects “Upload” radio button
User selects file from computer
Uploaded PDF displays in full pdf preview window

Add First Batch Flow

Selects “Scan” radio button
Loads scanner hopper
Clicks “Add batch” button
[Hopper scans documents]
Scan utility software may display a progress bar
[Hopper completes scan]
Sees “Batch 1” under Scanned Batches, no link
Sees batch page count in batch table (1 duplexed page counts as 2 scanned pages)
Sees “Rescan” button in batch table
Sees “Delete” button in batch table
Sees preview of Batch 1 pages, one page at a time
Uses batch preview navigation to verify scan is clean and clear

Hopper is Empty Flow

Clicks "Add batch" while hopper or flat-bed is empty
Sees Modal communicating the hopper / flat-bed is empty
Loads hopper
Clicks “Scan”
[Scan]
Clicks "Cancel" / "Close"
Modal closes without action

Preview Multiple Batches Flow

[scan Batch 1]
Batch 1 appears under Scanned Batches and displays in batch preview
Click "Add batch"
[scan Batch 2]
Batch 2 appears under Scanned Batches and displays in batch preview
Batch 1 text becomes a link
Clicks “Batch 1”
Sees Batch 1 in batch preview
Batch 1 text link removed (shown as selected)
Batch 2 text becomes a link
Uses navigation to view batch page-by-page
Clicks “Batch 2”
Sees Batch 2 in batch preview
Uses navigation to view batch page-by-page

Rescan a Batch Flow

Clicks “Rescan”
Sees Modal window requesting confirmation of desire to rescan batch
Clicks “Yes, rescan”
[Scan]
New scanned batch page count updates under Scanned Batches
New scanned batch images appear in batch preview
Clicks "No, cancel" / "Close"
Modal closes without action

Delete a Batch Flow (multiple batches)

Clicks “Delete”
Sees Modal requesting confirmation of desire to remove batch
Clicks “Yes, delete”
Modal closes
Selected batch is removed from Scanned Batches list
Batch order and naming remains persistent
Batch preview displays previous batch (if batch 2 was deleted, preview displays batch 1)
Previous batch displays as selected
Clicks "No, cancel" / "Close"
Modal closes without action

Delete a Batch Flow (single batches)

Clicks “Delete”
Sees Modal requesting confirmation of batch removal
Clicks “Yes, delete”
Modal closes
Selected batch is deleted
"None" appears in Scanned Batches section
Batch preview is hidden
Clicks "No, cancel" / "Close"
Modal closes without action

Create PDF Flow

[scan flow]
Click Create PDF
PDF is generated from scanned batches in numeric order of batches
Sees full PDF preview displays in preview panel
PDF is associated with document field and green check displays next to document name in H3 tabs
Sees “Delete PDF” button

Scan Another Document Flow

Click Document tab
[Scan flow]

Preview PDF for Another Document Flow

[scan or upload flow]
[scan another document or upload flow]
Click on Petition tab
Sees full PDF preview in preview panel for Petition
Sees “Delete PDF” button

Delete PDF Flow

[scan or upload flow]
[if scan flow then create PDF flow]
Click “Delete PDF“
Sees modal requesting confirmation of desire to delete PDF
Click "Yes, delete"
PDF is deleted and document returns to default state [no file attached]
Clicks "No, cancel" / "Close"
Modal closes without action

Complete Case Creation without Errors Flow

Clicks “Create Case” button
[no change to rest of current flow]

Complete Case Creation with Errors Flow - Metadata

Clicks “Create Case” button
[no change to error handling for metadata]

Complete Case Creation with Errors Flow - Petition is required

Clicks “Create Case ” button
Petition tab is selected
Sees error message to indicate petition is required

Cancels Case Creation Flow

Clicks “Cancel” button
Sees modal window requesting confirmation of desire to cancel case creation
[no change to current flow]

Scanning Error Flow

Sees Modal communicating scanning error
Clicks “OK”
Modal closes without action
Use Dynamsoft's own error modals where possible

Unfinished Scans Flow - Non Petition Document Not Finished

[scan flow]
Scanned batches exist for a document but PDF has not been generated
Clicks on “Create Case”
Sees Modal communicating that scanning has not been completed yet
Clicks “OK, discard scans”
Modal closes, unfinished scans are deleted
Form is submitted
[no change to rest of current flow]
Clicks "No, cancel" / "Close"
Modal closes without action

Unfinished Scans Flow - Petition Not Finished

Scanned batches for petition exist but PDF has not been generated
Clicks on “Create Case”
Petition tab is selected
Sees error message to indicate petition is required

Multiple Scan Sessions

[scan batch 1 for Petition]
Selects STIN tab
[scan batch 1 for STIN]
Selects RQT tab
[scan batch 1 for RQT]
Selects Petition tab
Sees batch 1 for petition under Scanned Batches
Sees Petition: batch 1 in batch preview
Selects STIN tab
Sees batch 1 for Petition under Scanned Batches
Sees STIN: batch 1 in batch preview
Selects RQT tab
Sees batch 1 for RQT under Scanned Batches
Sees RQT: batch 1 in batch preview

Petitions Clerk - Scanning for Petitions

Petitions Clerks may scan or upload petitions and petition-related documents into the system. This functionality adds a scanning utility to the system.

Case Information Page - First Use / No Scanner Selected

Clerks may scan or upload a document via the scan / upload utility panel ("Add Documents")
The "Petition" document is the only required document
"Petition" tab is selected by default
"Scan" radio option is selected by default
Users which have never used the Dynamsoft scan utility will be prompted with a modal to download and install the software to their computer and refresh the browser
The selected "Scanner" information will be set to "None" until a scanner has been selected
Clicking "Select Scanner" invokes the available scanners modal

Case Information Page - Upload Option

Clerks may choose to upload a document from their computer
Clerk may choose either scan or upload independently for each document tab

Case Information Page - Scan Option

Software must be installed in order to scan documents
The user may select a scanner from the available scanners list
Clicking "Select Scanner" or "Change" invokes the available scanner list in a modal
- Use bright blue hover color as specified in style guide
The name of the selected scanner appears in the "Add Document(s)" header
"Add Batch" displays when the software is installed and a scanner is selected
Clicking "Add Batch" triggers the scanner to begin scanning
Auto-feed tray is selected by default. If empty / unavailable, the scanner will use flat-bed

Modal - Available Scanners

Displays radio set of available scanners
May display more than one option for the same scanner by connection type
Scanners must be TWAIN compatible
Scanners must be attached to the computer and turned on to appear in the list
Petition Clerk may select the scanner they wish to use and click "Select"
"Cancel" / "Close" returns the user to the Case Information screen without taking action

Case Information - Scanned Batches and Preview

Each scan from the flat-bed or hopper will appear on screen as a "Batch"
Batch page count is available to user to confirm scanned page count matches expectation
"Rescan" allows user to replace the batch, invokes rescan batch conformation modal
"Delete" allows user to delete the batch, invokes delete batch confirmation modal
- Deleting a batch removes the batch from the list but does not re-number the batch list
"Add batch" allows user to add unlimited number of batches
Batches are limited only by the number of pages their scanner can handle at one time
- The court's limit is 250 pages per hopper
- The court's scanners are duplexed scanners
- 250 double sided pages produces 500 scanned pages
Batch 1 appears in the preview window
Clerk may page through the preview to ensure all pages are clean and clear
"Create PDF" flattens the batches into a single PDF file

Case Information - Adding More Scanned Batches

Subsequent batches appear in the Scanned Batches section
Batches which are being previewed are not linked
Batches which are not being previewed are linked
Clicking on a Batch number shows the batch in the preview window
The batches table is scrollable
Add batch button remains docked to the bottom of the pane

Case Information - Flattened PDF Preview

"Create PDF" flattens batches into a single PDF
View changes to a PDF viewer with the document loaded
Document is being rendered from memory and has not been uploaded to the system yet
"Delete" PDF allows the user to delete the entire PDF - invokes delete PDF confirmation modal
Deleting documents uploaded to optional doc types, such as the ODS, are re-set to optional
Green checkmark icon appears in document tab

Case Information - Error

When a required field has not been completed or a field has not been completed correctly, display an error message at the page and field level

Modal - Empty Hopper

Prompts user to add pages to the hopper if empty
"Scan" triggers the scanner

Modal - Rescan Batch

Prompts user to confirm their desire to rescan a batch
Display the relevant Batch number
"Yes, Scan" triggers the scanner

Modal - Delete Batch

Prompts user to confirm their desire to delete a batch
Display the relevant Batch number
"Yes, delete" removes the batch from the list, do not renumber batches

Modal - Delete PDF

Prompts user to confirm their desire to delete a PDF
"Yes, delete" removes the batch from the list, re-set the view to the scan / upload utility

Modal - Unfinished Scans

Prompts user to complete scanning if they attempt to create the case or cancel without generating a PDF of their scanned batches
"OK, discard scans" continues the action and discards the un-flattened scan batches

Modal - Generic Error

Informs user that an error has occurred
It is not possible for our system to identify what the error is
OK returns the user to the page without action

Note: It is possible the Dynamsoft utility will provide it's own error messaging and this can be discarded

Common issues with Dynamsoft scanning utility

The following issues have been noticed while working with dynamsoft scan utility. We should provide support documentation to the court on how to resolve these issues if they reoccur.

Product key is empty or invalid

Why it happens: Provided the license is current, this issue occurs when the cache on an individual computer does not have a valid key stored
Resolution: clear the browser cache, reload the page, and try again

Scanner is not showing up on available scanners list

Why it happens: the list of available scanners may be stored in the browser cache and may not be updated correctly.
Resolution: clear the browser cache, reload the page, and try again. Be sure the scanner is plugged in and turned on after clearing the cache and before reloading the page.

Scanner appears on available scanners list

Why it happens: Scanners may use more than one protocol. Each protocol may show up on the list as a separate scanner.
Resolution: Choose the TWAIN compatible option. Dynamsoft requires TWAIN compatible scanners.

Selecting flat bed or hopper source

The software is set to default to the auto-feed (multi-page) tray. If nothing is in the auto-feed tray, the software will fall back to the flat-bed.

PO review 8/8/19:

Green check fails to display by ODS in H3 tabs
Could not submit case -- got error -- discussed w/ Matt and Cody

flexion / ef-cms