bcgov / bcgov/foi-flow

Download Consults

Open
#3,570 4 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 be able to download the consult package
* so that I can give it (outside the system) to another pubic body for a consult

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

Consults will not include redactions, unless the IAO analyst has added a redaction to the consult PDF.

Should ministry coordinators be able to download a consult?

The Records log filters are independent of the download. Applying a filter (e.g.by a divisional, error, etc. tag) on the Records Log will have no impact on what is downloaded.

When downloading a Consult you will get a ZIP file with one consolidated PDF for each public body flagged for consultation. For example, if the record pages were flagged for consult by 4 public bodies then there will be 4 Consult PDFs in the ZIP file.

The ZIP file will NOT contain all the incompatible file types (i.e. non-PDFs), such as audio and GIS files.

What is IN scope?

Download the Consult packages

What is NOT in scope?

Saving the Consults (#3568)
Notifications when the Consult is ready will be a separate story

**Acceptance Criteria**

**Scenario 1: Active "Download for Consult""**
* GIVEN the analyst has already saved the Consult
* WHEN the analyst clicks the Download dropdown
* THEN the Download dropdown will open with 4 choices: Download for Consult, Download for Harms, Download Redline for Sign Off, Download Final Package
* AND the "Download for Consult" will be active

**Scenario 2: Click "Download for Consult""**
* GIVEN the analyst has already saved the Consult
* AND the analyst is on the Download dropdown
* WHEN the analyst clicks the active and "Download for Consult"
* THEN the download will be in progress
https://jacklyn808742.invisionapp.com/console/share/3W2O64AP5C/977423262

**Scenario 3: "Download Consult"**
* GIVEN the analyst has clicked "Download for Consult"
* WHEN the system completes creating the PDFs
* THEN PDF(s) will be exported in one consolidated, linear PDF for each public body organized by modified date
* AND the consolidated PDF(s) consults for each public body will be include in the ZIP file
* AND the ZIP file will download onto the users computer

**Scenario 4: Inactive "Download for Consult"**
* GIVEN the analyst has NOT saved the Consult
* WHEN the coordinator or analyst is on the Download dropdown
* THEN the "Download for Consult" will be inactive

**Scenario 5: Download Consult- changes to annotations/documents**
* GIVEN an IAO user has downloaded the Consult
* WHEN there have been changes made to the Consult, including redactions
* OR if pages have been added or removed
* AND the changes have been saved in the Records Review app with the Create Package Dropdown
* THEN the download to consult feature will revert to creating a new package, reflecting the changes to the records

**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**
@xxx - please link the Design here

**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 by tracing the Download dropdown and Create Package Dropdown in the Records Review app, using the acceptance scenarios as the behavior map. Verify saved-state gating, consolidated PDFs per public body, ZIP delivery, and package regeneration after annotations, redactions, or page changes; done means the listed scenarios pass.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.