bcgov / bcgov/foi-flow

Gathering Records Log - Embeds in Records

Open
#3,310 1 comment 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 Flex Team user
* I want all embedded records displayed
* so that I can see the relationship between records (i.e. this record is an embed of this record)

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

Attachments and embeds within records will be treated the same way.

Currently, embeds are found by a manual review. Embeds will be handled in another story, but require rank 2 deduplication to find the links embedded in the records.

Flex team wants all **embeds up to 5 layers** added to the Records log. Even if there is more than one layer there will be only one indent.

For example:
Record A has and embed in Record B; Record C is an embed of Record A.

Visually this would be displayed in the Records log like this:

Record A
> indent - Record B
> indent - Record C

What is IN scope?

Upload up to 5 layers of embeds

List embeds up to 5 layers on Records log.

What is NOT in scope?

Attached records are covered in #3293

**Acceptance Criteria**

**Scenario 1: Up to 5 layers of attachments**
* GIVEN a ministry coordinator uploads a batch of records
* WHEN the records contain attached records
* THEN up to 5 layers of attachments will be processed (i.e., uploaded, converted, deduplicated)

**Scenario 2: View attachments**
* GIVEN a ministry coordinator uploads a batch of records
* WHEN the records contain attached records
* THEN the attached records will be displayer with an indent under the next parent record (only need one indent even if there is more than one layer).
https://jacklyn808742.invisionapp.com/console/share/3W2O64AP5C/977423262

Contributor guide

Open the contributing guide

Research direction

The issue names no files or tests. Start by locating the record upload, deduplication, and Records log entry points, then trace how embedded records are represented and processed. Done means embeds are processed through five layers and appear under their parent in the Records log with one indent, while confirming the attachment/embed scope against #3293.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend, data
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.