[ORD-9.4.2] Enumeration Process & Progress bar

[Albina-J]

User Story # ORD-9.4.2

2. Revision History

Version	Date	Description
V1.0	29.01.2025	From high level estimations xlsx: ORD-9.4.2 Implement enumeration progress status API & progress bar display

3. User Story

AS A user,
I WANT to be able to observe real-time status updates for the enumeration process in a progress bar,
SO THAT I can have a clear view of how far the process has advanced and track the progress of large or
complex data enumerations.

4. Acceptance Criteria (*TO BE FINALIZED)

User Role	AC#	GIVEN	WHEN	THEN
User	1	Enumeration sidebar was filled with all mandatory data	User pressed "Enumerate" button and successfully initiated the process	The system performs the process of Enumeration that creates multiple reactions by merging two objects: existing reaction enumeration template marked with variable placeholders and a CSV input table containing new data for these placeholders. This feature allows users to efficiently generate several reaction records in bulk, streamlining the workflow and reducing manual data entry for large sets of reactions.
User	2	Enumeration sidebar was filled with all mandatory data	User pressed "Enumerate" button and successfully initiated the process	The system shows the progress bar with the number of expected reactions to be made, completion percentage toward that, and estimated remaining time, indicating the status of reactions being processed and enumerated. The progress bar should also have "Please Note" section with the following information for users: "Please wait until the enumeration process is complete and do not close this page to avoid data loss. Should you encounter any issues during the enumeration, please contact us at [email protected]"
User	3	Enumeration was successfully initiated	Progress bar is being showed by the system and user clicks there on "x"	The system shows the confirmation modal prompting user to confirm the stop of enumeration action with "Ok" or "Cancel" buttons. Text on modal: "Please confirm that you want to stop the Enumeration process. Be aware that no data will be saved if the Enumeration is not fully completed."
User	4	Enumeration was successfully initiated	Invalid reactions were generated or some reactions failed and were not created during the process	The overall process of Enumeration is not failed, just the cases of failed reaction generation are flagged to user in the Enumeration Summary. Summary to be developed in ORD-9.4.1. User would be able to observe invalid reactions (with all errors and warnings) on the newly created dataset page after the enumeration is finished and all reactions went through validation.

Pic. 1

5. User Interaction and Design

UI Elements Description (*TO BE FINALIZED)

Name	Type	Description
Progress Bar	Visual Indicator	A dynamic display on the screen that shows the completion percentage and estimated time remaining for the enumeration process.
"Please Note" Section	Section	A designated area on the progress bar that provides additional information or warnings about the enumeration process.
Information Message	Text Display	Provided within the "Please Note" section, giving users advice and contact details in case of a browser timeout during large enumerations.
"x" Button on Progress Bar	Button	A clickable element on the progress bar that allows the user to initiate the termination of the enumeration process.
Confirmation Modal	Modal	A pop-up window that appears when the user clicks the "x" button, prompting confirmation to stop the enumeration process.
"Ok" Button	Button	A button within the modal that the user can click to confirm and proceed with stopping the enumeration process.
"Cancel" Button	Button	A button within the modal that allows the user to cancel the action and continue the enumeration process.
Confirmation Text	Text	Text displayed in the modal conveying the implications of stopping the enumeration process, specifically regarding data retention.

6. 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.

7. Assumptions

• Users have a basic understanding of template and enumeration process.
• This feature covers [ORD-13.3 Enumeration performance Implement asynchronous enumeration]
• Enumeration is done in bulk (all reaction are added together in bulk)

8. Dependencies

• Dependent on Template availability (Developed in [ORD-5.5] Save Reaction as Template)
• Dependent on Setting Variables on Template function [ORD-9.3] Prepare the Template for Enumeration
• Dependent on Enumeration process [ORD-9.5] Enumerate function

9. Out of Scope

#	Description	User Story

10. Questions

#	Question	Address to Whom	Answer