[ORD-6.1] Create reaction from the scratch

[yauhen-karmyzau]

Tasks for analysis:

• [BA][ORD-6.1] Create reaction from the scratch #66
• [UX][ORD-6.1] Create reaction from the scratch #67
• [BE][ORD-6.1] Create empty reaction with ID #114

User Story # ORD-6.1

2. Revision History

Version	Date	Description
V1.0	20.12.2024	Discovery Phase: The system should allow users to create and manage reactions directly from the dataset page, with options such as Create from Scratch, Enumerate, Import from a File, and Create from Template. The user interface for the Empty Reaction Page should be designed to provide a seamless experience, supporting all reaction creation methods and offering intuitive navigation for users to build reactions efficiently.
V2.0	14.01.2025	Update of the Reaction ID in AC#3 based on the comment below.

3. User Story

AS A user,
I WANT to be able to create reactions from scratch directly from the dataset page,
SO THAT I can efficiently build and easily record reactions in a seamless and intuitive interface.

4. Acceptance Criteria

User Role	AC#	GIVEN	WHEN	THEN
User (ORD Admin or Editor in the group)	1	The user is on the dataset list view page	The user clicks on "+Reaction" dropdown button	The system opens a dropdown with 4 options: From Scratch, Enumerate, Import from File, From Template
User (ORD Admin or Editor in the group)	2	The dropdown with 4 options to create reaction is open.	The user selects the "From Scratch" option (Pic. 1)	The system opens a new page with Empty Reaction - a blank canvas where the user can start populating fields for new reaction (Pic. 2). The system also shows the newly created reaction in the list of Database and User can come back to editing it anytime.
User (ORD Admin or Editor in the group)	3	The Empty Reaction page is open	The system assigns the Reaction ID (of the type "reaction 1", "reaction 2" etc, similar to what is currently done in the contributions interface) to this new reaction (Pic. 2)	The system demonstrates this ID as a name of reaction initially (name changing will be available in "edit" button and is described in AC#4)
User (ORD Admin or Editor in the group)	4	The user is viewing Empty Reaction page	The user clicks either of these buttons: "Copy", "Download", ""Save as Template", "Edit", "Remove"	The system performs the respective actions as described in ORD-6.0
User (ORD Admin or Editor in the group)	5	The User is viewing Empty Reaction page	The User navigates and scrolls the page	The system shows consistent and intuitively understandable design, and displays the following empty parts available for populating: Preview - summary, Identifiers, Inputs, Setup, Conditions, Notes, Observations, Workups, Outcomes, and Provenance. (The functionality of all these parts (fields that can be filled in) to be developed in the next tickets ORD-6.1-6.8; 6.13-6.14).
User (ORD Admin or Editor in the group)	6	The User is populating and editing the Empty Reaction page	The User changes some fields in parts that are not opening in separate sidebar	The system automatically saves all the updates (exact Sections with these functionalities to be defined and developed in next tickets).

Pic. 1

---

Pic. 2

---

5. Mockups Links

• Dataset
• Reaction – Empty
• Modal / Rename Reaction
• Reaction – Deoxyfluorination

6. User Interaction and Design

#	Name	Type	Description
1	+Reaction dropdown	Dropdown	A dropdown to choose between 4 options for creating reactions (including create from scratch, Enumerate, Import from a File, Create from Template).
8	Empty Reaction Page	Page	A new, blank page where users can input details to create a new reaction from scratch.
10	Copy Button	Button	A button that provides options to copy either the reaction hyperlink or reaction ID to the clipboard.
11	Download Option	Dropdown	Allows users to choose a file format (.pb, .pbtxt, .json) and download.
12	Save as Template Button	Button	A placeholder button on the Empty Reaction Page, its full functionalities are planned to be developed at the end of the section.
13	Remove Button	Button	Button to delete the whole Reaction followed by a confirmation modal.
14	Confirmation Modal	Modal	Modal that requires user confirmation for irreversible actions like deletions.
15	Remove Button	Button	Button to confirm the deletion action.
16	Cancel Button	Button	Button to cancel the ongoing action and close the modal or sidebar.
17	Reaction name edit	Button	A button to allow the user to edit the name of a reaction.
18	Reaction name modal	Modal	A modal where the text can be edited.
19	Save	Button	A button to save the reaction's name changes.
20	Cancel	Button	A button to cancel the reaction's name changes.

7. Non-functional Requirements

• Performance: Reaction creation and management actions should be responsive, with all operations completing within 3 seconds to ensure a smooth user experience.
• Scalability (NFR-4): The system should be planned for potential increases in user load up to 50 concurrent users without performance degradation.
• Disaster Recovery (NFR-3): The system should have automated backups for the reactions information.

8. Assumptions

• Users have a basic understanding of chemical reactions and the data involved.
• Users have the necessary permissions to view and manage reactions as per RBAC and Groups Management (ORD-11.4.2 & ORD-11.1).
• Assumption is that user is on Edit mode to perform any modifications (View only mode in ORD-5.10 - to be implemented in later sprints).

9. Dependencies

Description	Dependent On
The "+Reaction" button was added in ORD-5.1.1, but without any functionality yet	ORD-5.1.1

10. Out of Scope

#	Description	User Story
1	Preview - summary, Identifiers, Inputs, Setup, Conditions, Notes, Observations, Workups, Outcomes, and Provenance. The functionality of all these parts (with fields that can be filled in) to be developed in the next tickets	ORD-6.1-6.8; 6.13-6.14)
2	Save as a Template button functionality to be developed in at the end of Reactions section and before Enumeration	ORD-5.5
2	3 other options to create the reaction: Enumerate, Import from a File, Create from Template will be developed in the next sprints in MVP	ORD-6.14

11. Questions

#	Question	Address to Whom	Answer
1	Duplicate - clone reaction - is it useful to be added in Full Scope?	user	Useful, not high priority (download - upload is workaround for now)
2	Is Edit button needed for reaction ID?	user/UI/UX	yes
3	Is Delete button needed for empty reaction?	user/UI/UX	yes

[bdeadman]

Acceptance criteria 3 - just assign a reaction id of the type "reaction 1", "reaction 2" etc, similar to what is currently done in the contributions interface. The hexadecimal id is only assigned when a dataset is submitted to the public ORD repository.