bcgov / bcgov/entity

3.2 - Preview Uploaded Supporting Documents

Open
#29,583 8 comments 0 reactions 1 assignee Claimed by @ethantspitt View on GitHub
Assets MHR Must Have UX
Dominant language
JavaScript
Stars
23
Forks
62
Avg merge
24m
Merged PRs (30d)
1

Description

**Priority (MoSCoW):** Must
**Persona:** Registry Analyst
**Value:** Analysts can view all supporting documents attached to a filing request digitally, instead of relying on mailed-in packages.

---

## User Story
As a **Registry Analyst**, I want to **view all uploaded supporting documents for a filing request**, so that **I can confirm the filer has provided supporting information without using paper files**.

---

## Context
- **Where:** Filing Request Details view (Epic 1).
- **Before:** Analysts relied on paper submissions or scanned copies.
- **After:** Analysts can view uploaded supporting documents directly in the system.
- **Policy fit (BA to confirm links):**
- **MHA s.8(1):** Registrar must file if record appears to comply.
**How this story meets it:** Documents support compliance review by being available for inspection.

---

## UX/UI link (Design-owned)
Figma: https://www.figma.com/design/rbiPKU4yAW8PqDDjFRBVKQ/Intake-Queue?node-id=2513-2118&t=G0Uu0wdcSJVmg76m-4
---

---

## MVP Boundary (story-level; PO-owned)
- **In:**
- Display list of all documents uploaded to the filing request.
- Support inline viewing of common file types (PDF, JPG, PNG, DOCX).
- Show metadata: filename, file type, size, upload date.
- **Out:**
- Mark as Reviewed controls.
- Notes linked to document issues.
- Audit trail of document review.
- Automatic validation or discrepancy highlighting.
- Document AI or auto-extraction.

---

## Acceptance Criteria (PO-owned; user-observable)
- [ ] Analyst sees a list of documents attached to a filing request.
- [ ] List shows filename, type, size, and upload date.
- [ ] Supported file types (PDF, JPG, PNG, DOCX) open in a side panel or modal.
- [ ] If no documents exist, show “No documents uploaded.”
- [ ] **Unavailable:** If documents cannot load, show “Documents unavailable. Please try again later.”
- [ ] **Accessibility:** Document list and viewer are keyboard accessible, focus visible, and AT announces filenames and metadata.

---

## BA — please cover
- [x] Business & validation rules (filled from PO draft — see below)
- [x] Error wording + edge cases (filled)
- [x] Data & authoritative sources (filled)
- [x] Constraints/NFRs (filled)
- [x] Accessibility basics (filled)
- [ ] Policy references (confirm links)

---

## Policy references (BA to confirm)
- Manufactured Home Act — s.8(1): *Registrar must file if record appears to comply.* [Link](https://www.bclaws.gov.bc.ca/civix/document/id/complete/statreg/03075_01)
- FOIPPA: Uploaded documents are staff-only, confidential records.

---

## Business & Validation Rules (MVP)
- Only supported file types (PDF, JPG, PNG, DOCX) can be opened inline.
- Documents display in a side panel or modal.
- Each document shows metadata: filename, file type, size, upload date.
- Documents are **read-only** in MVP — no mark-as-reviewed, no notes, no audit trail.
- If no documents are uploaded, show “No documents uploaded.”

---

## Error & Unavailable wording -- will ensure that lawyers don't submit unless they include supporting docs
- **No documents:** “No documents uploaded.”
- **Unavailable:** “Documents unavailable. Please try again later.”
- **Corrupt file:** Show filename with “Unavailable” note.

---

## Data & authoritative sources
- **Source of truth:** DRS (Document Registry Service).
- MHR filing request record links to associated document IDs in DRS.

---

## Constraints/NFRs
- Document list should load within 3 seconds under expected volumes.
- FOIPPA guardrails: all documents are staff-only, never public.
- Viewer must support files up to system’s max size (BA to confirm).

---

## Accessibility basics
- Document list and viewer must be fully keyboard navigable.
- AT must announce filenames, file type, and size.
- Visible focus indicators.

---

## BA Prompts
- Confirm if metadata must also display **uploader name**.
- Confirm if **file size** must always be displayed.
- Confirm how **large files** (e.g., >50MB) should be handled (inline preview vs. download only).
- Confirm if any **non-standard formats** (e.g., TIFF) need to be supported in MVP.

---

## BA — Prep (quick checklist)
- [ ] **Where on the page?** Filing Request Details → Documents section.
- [ ] **Who can do it?** Registry Analysts (view-only).
- [ ] **Names we use:** “Supporting Documents.”
- [ ] **What choices are available?** None (read-only).
- [ ] **After save:** Not applicable.
- [ ] **If it can’t load:** “Documents unavailable. Please try again later.”
- [ ] **Accessibility basics:** Keyboard path, AT announces doc names/metadata.
- [ ] **User flow diagram:** Update & link.

---

## BA — Edge cases
| Edge case | Trigger | User sees | Continue? |
|-----------|---------|-----------|-----------|
| No documents | None uploaded | “No documents uploaded.” | Yes |
| Service down | DRS unavailable | “Documents unavailable. Please try again later.” | No |
| Corrupt file | File reference invalid | Filename + “Unavailable” note | Yes |

---

## BA — Gherkin
**Scenario: View Documents**
- Given I open a filing request
- Then I see a list of uploaded documents with metadata

**Scenario: No Documents**
- Given no documents are uploaded
- Then I see “No documents uploaded.”

**Scenario: Supported File Preview**
- Given a document is PDF/JPG/PNG/DOCX
- When I click the file
- Then it opens inline in a panel/modal

**Scenario: Service Down**
- Given DRS is unavailable
- Then I see “Documents unavailable. Please try again later.”

**Scenario: Corrupt File**
- Given a file reference is broken
- Then I see the filename with “Unavailable” note

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.