bcgov / bcgov/foi-flow

Correspondence Log View

Open
#349 2 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 a FOI Analyst
* I want to be able to have a correspondence log
* so that it's easier to see if a communication has been completed and sent or is still in it's draft (unsent) form

**Assumptions & Scope**
User has privileges to view Correspondence Log, will be on the Log.

Assumption: Email details are pulled and stored from the exchange server. Correspondence log will only display emails relevant to the request.

**Dependencies? What is the impact of this dependency? (If so, link dependency in the ticket, make it visible in a team´s backlog)**
Correspondence log is dependent on how we are storing emails #139

What is in and not in scope?

**Acceptance Criteria**

**Scenario 1: Correspondence Log Landing Page**
* GIVEN I am on the review request page
* WHEN I select the Correspondence Log button on the left navigation banner
* THEN I will be directed to the correspondence log page
* AND The Correspondence Log will be shown as selected with a white cutout
https://jacklyn808742.invisionapp.com/console/share/3W2O64AP5C/657932457
* AND The default view for the correspondence log shall be for sent emails.

**Scenario 2: Sent Email View**
* GIVEN I am on the Correspondence log, with the default view of sent emails
* THEN Any emails sent shall be displayed, to a maximum of 20 emails
* AND The rows will display the "To" field (who the email was sent to), the subject line, and the date sent
* AND the emails will be ordered with the latest sent email at the top
* AND there will be an active toggle to switch pages when there are more than 20 emails

**Scenario 3: Toggle from Sent to Drafts**
* GIVEN ... I am on the Correspondence Log page, the "Sent" radio button is selected by default and shows all sent emails
https://jacklyn808742.invisionapp.com/console/share/3W2O64AP5C/657932457
* WHEN ... I click on the "Drafts" radio button
* THEN ... the correspondence log view changes to only show email messages saved as drafts.

**Scenario 4: Draft Email View**
* GIVEN I am on the Correspondence log, with the radio button selected for draft emails
* THEN Any saved draft emails shall be displayed, to a maximum of 20 emails
* AND The rows will display the "To" field (who the email will be sent to), the subject line, and the date sent (only displaying mm/dd/yy for drafts since it is not sent)
* AND the emails will be ordered with the latest draft email at the top
* AND there will be an active toggle to switch page when there are more than 20 draft emails.

**Scenario 5: Toggle from Drafts to Sent**
* GIVEN ... I am on the Correspondence Log page, and the "Draft" radio button is selected
https://jacklyn808742.invisionapp.com/console/share/3W2O64AP5C/657932458
* WHEN ... I click on the "Sent" radio button
* THEN ... the correspondence log view changes to display all sent emails.

**Scenario 6: Draft Count Shown Next to Radio Button**
* GIVEN I am on the correspondence log page
* WHEN a draft has been saved
* THEN the count of number of saved drafts shall appear next to the drafts radio icon
https://jacklyn808742.invisionapp.com/console/share/3W2O64AP5C/657932457

...

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

**Design**
https://jacklyn808742.invisionapp.com/console/share/3W2O64AP5C/657932510

**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 reviewing dependency issue #139 and the linked InVision designs, then inspect the review request page and how emails are stored. Done means the Correspondence Log supports sent and draft views, sorting, 20-item pagination, draft counts, navigation, and the acceptance scenarios, with tests covering the behavior.

Written by the indexing model from the issue text.

Assessment

Domain
full-stack
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.