Save Consult for Public Body
- 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 save a consult without redactions
* So that I can consult with a public body(s) on pages in an FOI request
**Assumptions & Scope**
What are the assumptions for this story?
- For release 8.0, the ministry will not have access to the Records Review app. In future ministry coordinators may need to create their own consults.
- Consults are independent of request state
- Consult packages will only include pages flagged with the Consult flag (a page can have more than one public body flagged for consult)
- Each public body consulted will get there own PDF
- If a page is flagged with more than one public body, the page will be included in all of the consult PDFs for each public body flagged
- All Consults will be saved as PDF documents (one of each public body) in Object Storage.
- Best practice is a clean copy. The PDF document(s) will include NO comments, highlights or annotations.
- The PDF document(s) will be viewable in the redaction app.
What is IN scope?
Saving the Consult(s) in Object Storage.
What is NOT in scope?
Flagging pages as a consult (#3564)
Creating a redline or final records package and other functionality in the 'Create Records Package' dropdown is covered in #3437, #3231
**Acceptance Criteria**
**Scenario 1: Inactive "Consult Public Body"**
* GIVEN no pages in a records package have been flagged for a Consult
* WHEN the IAO analyst clicks on the "Create Records Package" Dropdown
* THEN there will be inactive and greyed out "Consult Public Body" option in the dropdown
**Scenario 2: Active 'Consult Public Body''**
* GIVEN pages in a records package have been flagged for a Consult
* WHEN the IAO analyst clicks on the "Create Records Package" dropdown
* THEN the "Consult Public Body" option will be clickable
* AND the "Redline for Sign Off" will not be clickable
* AND the "Final Package for Applicant" will not be clickable
**Scenario 3: Click "Consult Public Body"**
* GIVEN the "Create Records Package" dropdown is open
* WHEN the IAO analyst clicks the active "Consult Public Body"
* THEN a modal will open with the message, "Are you sure want to create a consult. A PDF will be created for each public body selected."
* AND a "Create Consult" and "Cancel" button will be available
**Scenario 4: Click "Cancel" button**
* GIVEN an analyst is on the "Consult Public Body" modal
* WHEN the IAO analyst clicks the "Cancel" button
* THEN a modal will close
* AND the analyst will remain in the redaction app
* AND no Consult Public Body PDF(s) will be saved
**Scenario 5: Click "Create Consult" button**
* GIVEN an analyst is on the "Consult Public Body" modal
* WHEN the IAO analyst clicks the "Create Consult" button
* THEN a modal will close
* AND a green success toast will appear when the save is complete
* AND the analyst will remain in the redaction app
* AND the analyst will see the created Consult PDF(s) in the redaction app so they can review if needed (if there are multiple consultees, each consultee will have their own Consult PDF in the Organize By pane)
* AND a Consult PDF for each public body with all pages flagged by that public body will be saved in Object Storage
* AND the Consult PDF will contain NO redactions
* AND the Consult PDF will contain no comments or annotations of any kind
**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
Research direction
Start at the redaction app's Create Records Package dropdown and the Object Storage save flow; the issue names no files or tests. Trace how Consult-flagged pages and public bodies are represented, then verify the acceptance scenarios: separate clean PDFs are saved for each public body, appear in the redaction app, and contain no redactions, comments, highlights, or annotations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cloud, full-stack
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100