Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ORD-6.1.1] Create new Reaction. Import from a File #133

Open
2 tasks done
Albina-J opened this issue Jan 9, 2025 · 0 comments · Fixed by #227
Open
2 tasks done

[ORD-6.1.1] Create new Reaction. Import from a File #133

Albina-J opened this issue Jan 9, 2025 · 0 comments · Fixed by #227
Assignees
Labels
Front-end Ticket for front-end development.

Comments

@Albina-J
Copy link

Albina-J commented Jan 9, 2025

User Story # ORD-6.1.1

2. Revision History

Version Date Description
V1.0 30.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.

3. User Story

AS A user,
I WANT to be able to create reactions by importing them from an externally located file,
SO THAT I can add the reaction to the dataset easily with prefilled information without having to create each one from scratch.

4. Acceptance Criteria

User Role AC# GIVEN WHEN THEN
User (Admin or Editor) 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 (Admin or Editor) 2 The dropdown with 4 options to create reaction is open. The user selects the "Import from File" option The system opens a new modal with Attach file field (with a written alert of max upload size 15 MB and small informative text under it to mention the allowed file formats (.binpb, .txtpb, and .json)).
User (Admin or Editor) 3 A new modal with Attach file field is open The user clicks on that field The system opens the user's local download folder with the ability to navigate to other folders to choose the file to attach. The system allows attachment of .binpb, .txtpb, and .json (as well as old .pb or .pbtxt - for user's convenience) file types of max 15 MB size
User (Admin or Editor) 4 User selected the file to import The file's size is up to 15 MB and one of the allowed formats The system uploads the file and displays the successfully uploaded file name. The user then clicks on "Import Reaction" or "Cancel" to save or not the action and to close the modal to be redirected to the imported reaction (for "Import Reaction) or to dataset view (for "Cancel").
User (Admin or Editor) 5 User selected the file to import The file's size is more than 15 MB or some error during the uploading process occurs The system shows a notification informing the user about that.
User (Admin or Editor) 6 User imported the file and navigated back to the Dataset view page The user observes the dataset list The system updates the dataset list view with this new reaction and when this reaction is opened it is shown in the same format as other reactions ORD-6.0.
Image
Image

5. Mockups link

https://www.figma.com/design/c7M9fhVn278ei9rkepI2Sm/UX-UI-Open-Reaction-Database?node-id=1690-965&t=bfaMjw9QQeadlkdF-11

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).
2 Import Modal Modal A modal dialog that opens to allow the user to import reaction data from a file.
3 Attach Field Field A field within the Import modal used to initiate the import of a reaction from a file (with a written alert of max upload size 15 MB).
4 File Upload Success Indicator Text An indicator displaying the file name, confirming successful file upload.
5 Error Notification Notification A notification that alerts the user if a file is over the size limit or if an error occurs during the upload.
6 "Import Reaction" Button Button Button used to initiate the reaction importing action.
7 "Cancel" Button Button Button used to cancel any actions in that modal.
8 Supported File Formats Text Text Small informative text under the Attach file field mentioning the allowed file formats ( .binpb, .txtpb, and .json).

7. Non-functional Requirements

  • 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 the necessary permissions to perform any actions 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
The Create from scratch option in +Reaction was covered in ORD-6.1 ORD-6.1

10. Out of Scope

# Description User Story
1 2 other options to create the reaction: Enumerate, Create from Template will be developed in the next sprints in MVP ORD-6.14; 6.1.2

11. Questions

# Question Address to Whom Answer
1 What file type should be uploaded? dev team/user .binpb, .txtpb, and .json
2 Any size limitations? dev team/user 15 MB (to be adjusted later if needed)
3 16.01.2025 Clarify if we should allow the old file formats (.pb, .pbtxt) to be uploaded as well besides new ones ( .binpb, .txtpb, .json)? Note: .pb - works if renamed to .binp but txt does not work user Not high priority can push to later - but should probably allow users to work with old formats. If working easy - add. Renaming of the UI elements to include old formats is not needed, as users should be encouraged to use new formats.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Front-end Ticket for front-end development.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants