USER STORY: Agency Report Submission

[snyde664]

Full User Story

As an agency user, I want to upload and verify a quarterly CPF report, so I can be confident that my report is in the correct format the first time I submit it.

Action Plan

• [x] Initial design drafted
• [x] Initial acceptance criteria drafted
• [x] High level technical approach & feature flag use determined
• [x] Designs & Acceptance criteria finalized
• [x] Eng task breakout complete
• [ ] Assessment of whether partner training & communication actions are needed
• [ ] Acceptance criteria testing completed & passed in staging
• [ ] Feature flags enabled in production

Engineering Tasks

• [x] #132
• [x] #135
• [x] #136
• [ ] #137
• [x] #138
• [ ] #139
• [ ] #143
• [ ] #144
• [ ] #145

Archived Eng tasks

• Upload to S3 and kick-off validation

• 92

• 98

• Validation processing
• Upload Results page

Acceptance Criteria

Submit Workbook

• Given an Agency User is on the Uploads page, when they click the 'Submit Workbook' button, then it takes them to the upload workbook page:

• The upload workbook page should include:
  • a 'Reporting period' dropdown menu frozen on the tool's current reporting period
  • an 'Agency code' dropdown menu defaulted to the user's affiliated agency
  • a 'Workbook File' Choose File Upload button
  • a 'Notes' textbox
  • a 'Submit' button (all fields except for notes are required for upload)
• When a user clicks submit without having uploaded a workbook, the text 'Spreadsheet is required.' should appear in red under the Choose File Upload button.
• When a user clicks submit having uploaded a non-spreadsheet file, a red box with the text "Upload failed: Cannot parse XLSX from supplied data: Error: [filetype] Image File is not a spreadsheet" appears under the submit button.
• When a user clicks submit having uploaded a spreadsheet file, the upload is assigned a unique upload ID and is run through the validation process. The user is taken to upload's page (for the specific upload ID).

Upload validation

Upon submitting a workbook, the user is brought to the upload’s page. If the file has met all validation criteria, this will be the last step in the process. If the file has invalid criteria, the user can use the presented information to correct errors and upload the corrected file. The specific validations and errors and their acceptance criteria can be found here.

A valid upload page example:

An invalid upload page example:

• Regardless of status, the upload’s page includes a table titled 'Upload [upload ID] details:' with the following filled in rows:
  • File name
  • Reporting Period
  • Agency
  • EC code
  • Creation date and time, and user created by
  • Notes
  • validation status
  • If ‘Validated’, includes validation date and time, and user validated by
  • If ‘Not Validated’, just includes this status
  • buttons to:
  • 'Download File' - downloads the file onto the user's machine
    • Users from other orgs may use this to examine workbooks
  • 'Invalidate' - marks the file as invalidated
    • Removes the file from being included in audit and treasury reports
  • If the validation status is ‘Validated’,
    • 'Re-validate' - runs validation on the file again
    • User may use to check validations after a change has been made to the validation process, or to check that the workbook is the latest version
  • If the validation status is ‘Not Validated’,
    • 'Validate' - runs validation on the file again
    • User may use to check validations after a change has been made to the validation process, or to check that the workbook is the latest version
• If the uploaded file is valid, the page also includes:
  • a section titled "All from agency [agency name] EC Code [EC code] in period [reporting period]", with a subtitle of "The currently-displayed upload will be used for Treasury reporting."
  • Below this another table with columns:
  • '#' - the file ID
  • 'Uploaded' - date and time of upload
  • 'Validated - date and time of validation
• If the uploaded file is invalid, the page also includes:
  • a table titled 'Validation Results:' with the following columns:
  • '#' - issue number
  • 'Level' - 'Warning' or 'Error'
  • 'Message' - error specific message
  • 'Tab' - the tab in the spreadsheet where the error is located
  • 'Row' - the row in the spreadsheet where the error is located
  • 'Col' - the column in the spreadsheet where the error is located

Invalidate Button

Clicking the invalidate button invalidates the workbook. This means that it will not be included in treasury or audit reports. If the workbook was uploaded as a newer version of a workbook, then the latest valid version of the workbook will be the one used in treasury / audit reports. For example, if Agency ABC uploaded workbook X under category 1A that was a newer version of a prior valid uploaded workbook Y, then if workbook X is invalidated, workbook Y will be used in audit and treasury reporting.

[snyde664]

Annie to link relevant eng tasks

[ClaireValdivia]

@snyde664 this user story is looking good! one area to add to will be a table that describes some examples of what will show valid vs invalid values that we can use to test if the validations are working correctly