[ORD-5.1.1] List view

[Albina-J]

Sub-tasks:

• [FE] Config dataset view page layout #39
• [BE] Get dataset info #40
• [BE] Pagination for list of reactions #41
• [FE] List view #42
• [UX] Add reaction to a dataset button #101
• [FE] Add reaction to a dataset button #102
• [FE] Edit Dataset name #104

User Story # ORD-5.1.1

2. Revision History

Version	Date	Description
V1.0	09.10.2024	From Discovery Report: The system should provide list view for displaying reactions within the dataset to enhance data representation and analysis.
V2.0	12.10.2024	The updates based on the feedback from user: updated Pic.1., part 4, 5, 7, 10
V3.0	17.10.2024	Updates on AC4 and Assumptions based on Ben's comments
V4.0	18.10.2024	Added AC5-7, UI elements, and Questions based on RCS3 on 17.12.2024

3. User Story

AS A user,
I WANT the system to provide a list view for displaying reactions within the dataset,
SO THAT I can easily browse, analyze, and compare reactions.

4. Acceptance Criteria

User Role	AC#	GIVEN	WHEN	THEN
User (ORD all dataset group members)	1	Reactions are present in the dataset	The user clicks and opens any dataset	Inside any dataset view page the system displays the reactions in a list view. (Pic. 1)
User (ORD all dataset group members)	2	There are multiple reactions in a list view	The user scrolls through the list	The user can view each reaction’s summary data (Pic. 3 - Ben's comment).
User (ORD all dataset group members)	3	No reactions are present in the dataset	The user accesses the dataset	The system displays a message indicating no reactions are available. (Pic. 2)
User (ORD all dataset group members)	4	The user wants to copy a hyperlink or ID of a Reaction or a Dataset and is viewing the list of reactions in this dataset	The user navigates to the Dataset or Reaction ID's adjacent "Copy" button and clicks on it, chooses either ID or hyperlink	The system successfully copies the hyperlink or ID to clipboard.
User (ORD all dataset group members)	5	The user wants to see the dataset size (number of reactions)	The user navigates to the Dataset Reactions heading (Pic. 1).	The system always shows the number near Dataset Reactions heading that indicates the number of reactions in the dataset (number is not live updated).
User (ORD Admin or Editor in the group)	6	The user wants to edit the name and description of the dataset	The user navigates to the edit button and clicks on it, the modal is shown with the dataset name / description text that can be modified (Pic. 3).	The User modifies the text and saves the changes or cancels them.
User (ORD Admin or Editor in the group)	7	The user wants to add a new reaction to this dataset	The user navigates to the "+Reaction" button and clicks on it.	The system redirects the user to reaction creation page (Functionality of +Reaction button and Reaction creation page would be developed in the next sprints when Reaction Section 6 will be worked out).

Pic. 1

---

Pic. 2

---

Pic. 3 (EDIT DATASET NAME AND DESCRIPTION)

5. Images

6. Mockups link

https://www.figma.com/design/c7M9fhVn278ei9rkepI2Sm/UX-UI-Open-Reaction-Database?node-id=1136-64849&node-type=frame&t=ru1m91LgwBclVl6u-11

7. User Interaction and Design

#	Name	Type	Description
1	Reactions Data List	List	List displaying various columns such as reaction ID, conditions, etc. (*USER to provide the exact information)
2	Data Scrolling	Interaction	Ability to scroll through data in the list view, including horizontal (for reactions) and vertical (for all document) scrolling
3	No Data Message	Text Display	A clear and concise message displayed in the area where reactions are normally shown, indicating that no reactions are available in the dataset.
4	Dataset name / description edit	Button	A button to allow the user to edit the name or description of the dataset.
5	Dataset name / description modal	Modal	A modal where the text can be edited.
6	Save	Button	A button to save the dataset's name and description changes.
7	Cancel	Button	A button to cancel the dataset's name and description changes.
8	Copy button	Button	A button to allow the user to copy the link to dataset and reactions.
9	+Reaction button	Button	A button to allow the user to start creating the new reaction.

8. Non-functional Requirements (OUT OF MVP SCOPE)

• Performance: The list view should be capable of handling large datasets with many reactions (up to 1000).
• Performance: Loading new page with next parts of reactions list should be performed within a maximum of 3 seconds.
• Scalability (NFR-4): The system should be planned for potential increases in user load up to 50 concurrent users.

9. Assumptions

• The list view is available for the specific dataset group members only. The users outside of this specific group are not able to view the dataset [ORD-11.1]
• The user has basic familiarity with navigating the data or can easily orient themselves based on user-friendly design.
• The reaction data is well-organized and structured to fit into the list format effectively.
• The links to each individual reaction that open the reaction separately with all details will be active after the section 6. Reaction Create/Edit is worked out (next Sprints).
• Hyperlinks will be copied for the datasets and for reactions the hyperlinks will be dummies and will become available after the section 6. Reaction Create/Edit is worked out (next Sprints).

10. Dependencies

Description	Dependent On

11. Out of Scope

#	Description	User Story
1	The initial focus would be on implementing a simplified version of the list view, without displaying the reaction. The reaction view (with all molecular structures) would be added later as a part of the MVP in the subsequent sprints.	#53
2	Functionality of +Reaction button and Reaction creation page would be developed in the next sprints when Reaction Section 6 will be worked out.	ORD-6.1

12. Questions

#	Question	Address to Whom	Answer
1	What are the specific columns or data elements beyond reaction ID that need to be included in the list view?	User	Molecular structures and boxed information there are acceptable (to be done later in ORD-5.1.2.1). Generally, for other parameters, static fields are permissible. Additionally, include in this view yield and the date of last update. Ben has provided the list of parameters to be included (Slack message: Pic.3)
2	Should we save the reaction name as it is in current format or should be change for more readable format?	user	The ORD ID name is not always a required field, so we could implement a copy button for the reaction ID. For the DOI, if available, it should be added. For the Reaction ID we will display the reaction with an internal index, or, where available (ex. researcher added custom lab notebook ID), we will display an identifier with a custom type if the reaction has one.
3	Is it important to fit all the reaction (all molecules) at one page or it is not critical?	user	Aim for demonstrating the full reaction but horizontal scrolls are ok to use for large reactions.
4	Is the current view of dataset ok for layout configuration?	user	Confirmed with user that is acceptable
5	Copy button for reactions and dataset should only have hyperlink?	user	Yes
6	Edit name and description of the dataset - need to add in MVP or Full?	user	in MVP
7	Size of reaction can be added in MVP (not large amount of work), so just to confirm with User?	user	Confirmed to be ok

Pic. 3

[bdeadman]

Acceptance criteria 4.4 - when the user copies the dataset_id or reaction_id it would be helpful if this copied it as a hyperlink to the dataset or reaction page, with the text label being the dataset_id or reaction_id. In the case of the reaction_id this could be a dummy link until you get the reaction view setup.

Not discussed so far, but acceptance criteria 3.4 (what happens when there are no reactions) makes me realise that we are missing a "Add...", "Create..." or "New Reaction" button at the top of the list. It only needs to be one of these options.

Otherwise it looks good when you take into account the comments already copied from Slack. I have noted that the pictorial reaction representation will be done in a later sprint - this makes sense. As I mentioned yesterday, it will be the same as what we need to develop for the reaction view.

[daniil-sloboda]

Waiting for clarification from Steven regarding reaction summary display

[yauhen-karmyzau]

Reaction summary and provenance will be updated in scope of #183