bcgov / bcgov/foi-flow

Export Request Details/Comments/Fees/Contact Applicant, Attachments

Open
#2,435 16 comments 0 reactions 0 assignees View on GitHub
Story
Dominant language
Python
Stars
8
Forks
2
Avg merge
14h 34m
Merged PRs (30d)
46

Description

* As an IAO analyst
* I want to easily export all parts of a request
* so that I can more easily respond to requests for details of a request

**Assumptions & Scope**
What are the assumptions for this story?

* This story will cover the use case for someone to be able to export all parts of a request in a streamlined way - this will include comments, the request details themselves, attachments, fees, contact applicant log, and request description history.

* Rules for attachment download will be the same as for the export attachment button in the attachment log (ie: restrictions on user role)

* The export should produce a .zip file that contains a PDF of the request details, a PDF of the comments, and the attachments, emails sent to applicants including attachments, and CFR Digital versions.

What is IN scope?
* Export of all details of a request, excluding the records themselves

What is NOT in scope?

**Acceptance Criteria**

**Scenario 1: Export all Files **
* GIVEN an IAO user is on the request page
* WHEN they click on the "Export Request" button
* THEN a modal will pop up, with a message asking what parts of the request the user wants to export, with an Export button and cancel button
* AND there will be a list of checkbox options: "Request comments"; "Request Details", "CFR Forms", "Contact Applicant Log" and; "Request Attachments"
* AND all boxes will be checked by default

**Scenario 2: Export Button**
* GIVEN a user is on the export request modal
* WHEN at least one checkbox is activated
* THEN the Export button will be active

**Scenario 3: Activate Export Button**
* GIVEN a user is on the export request modal
* AND the export button is active
* WHEN the export button is clicked
* THEN checked boxes will export as a .zip file

**Scenario 4: Cancel back to request page**
* GIVEN a user is on the export request modal
* WHEN the cancel button is clicked
* THEN the modal will close

**Scenario 5: Zip File Contents**
* GIVEN a user has exported the request details
* WHEN they open the Zip File
* THEN any items that have been selected will appear as separate PDFs

**Dependencies? What is the impact of this dependency? (If so, link dependency in the ticket, make it visible in a team´s backlog)**

**Validation Rules? (If yes, list here)**

**Design**
@JHarrietha-AOT - I will connect with you when we are back to put in a new design for this

**Definition of Ready**

1. [ ] Is there a well articulated User Story?
2. [ ] Is there Acceptance Criteria that covers all scenarios (happy/sad paths)?
3. [ ] If there is a user interface, is there a design?
4. [ ] Does the user story need user research/validation?
5. [ ] Does this User Story needs stakeholder approval?
6. [ ] Design / Solution accepted by Product Owner
7. [ ] Is this user story small enough to be completed in a Sprint? Should it be split?
8. [ ] Are the dependencies known/ understood? (technical, business, regulatory/policy)
9. [ ] Has the story been estimated?

**Definition of Done**

1. [ ] Passes developer unit tests
2. [ ] Passes peer code review
3. [ ] If there's a user interface, passes UX assurance
4. [ ] Passes QA of Acceptance Criteria with verification in Dev and Test
5. [ ] Confirm Test cases built and succeeding
6. [ ] No regression test failures
7. [ ] Test coverage acceptable by Product Owner
8. [ ] Ticket ready to be merged to master or story branch
9. [ ] Developer to list Config changes/ Update documents and designs
10. [ ] Can be demoed in Sprint Review
11. [ ] Tagged as part of a Release
12. [ ] Feature flagged if required
13. [ ] Change Management activities done?

Contributor guide

Open the contributing guide

Research direction

Start from the request page and the proposed "Export Request" modal described in the acceptance criteria; no source files or tests are identified in the issue. Confirm the replacement design and dependencies before implementation. Done means users can select export sections and receive a ZIP containing the selected PDFs and permitted attachments, with cancel and validation behavior covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
full-stack
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.