System use case specification maintain commercial proposals - ESG-Project/documentation GitHub Wiki


Identification	UC15
Use case	Maintain commercial proposals for each client
Actors	Administrator, Technician
Stakeholders and interests	Consulting company: Ability to create, read, update, and delete detailed commercial proposals for each client.
Pre-conditions	User is logged into the system as an administrator or technician; System has access to relevant client and proposal data storage.
Minimum guarantees	System prevents invalid proposal entries.
Success guarantees	User successfully manages comprehensive commercial proposals for clients.

Main Success Scenario

User Action	System Response
1. This use case begins when the user selects a client to manage proposals	2. The system displays the list of commercial proposals for the selected client
3. The user selects to create a new proposal	4. The system displays the proposal creation form
5. The user enters the general information of the proposal (e.g., title)	6. The system validates the input
7. The user enters the adress of the proposal(Código de Endereçamento Postal(CEP) and, optionally, number, complement, latitude and longitude)	8. The system validates the adress
9. The user fills in the list of objectives	10. The system validates the objectives
11. The user specifies the list of investments by selecting products offered by the company or creating a new one and defining a value for each product	12. The system validates the investment list
13. The user defines the payment terms, including down payment, installment options, or a customized payment plan	14. The system validates the payment terms
15. The user sets the timelines for the start and end of activities for each deliverable product	16. The system validates the timelines
17. The user adds a descriptive text about exclusions	18. The system validates the exclusions text
19. The user lists documentation items	20. The system validates the documentation list
21. The user saves the proposal	22. The system validates all input and saves the proposal details in the database
	23. The system confirms the creation of the proposal to the user

User Action	System Response
1. The user cancels the action	2. The system returns to the proposals list without making any changes

User Action	System Response
	1. The system detects invalid input in the current section
	2. The system displays an error message to the user
3. The user corrects the input and resubmits	4. The system validates the corrected input

User Action	System Response
	1. The system detects invalid data in the complete proposal
	2. The system displays an error message to the user
3. The user corrects the invalid data and resubmits	4. The system validates the corrected data and saves the proposal

Investment List: Products must be selected from those registered by the administrator, with the option to define a value for each selected product.
Payment Terms: Must include options for down payment, installment plans, or customized payment methods.
Timelines: Must specify start and end dates for activities related to deliverable products.
Form Continuation: The user can exit the form at any point and must be able to return to the step where they left off.
Draft Saving: The system must allow saving proposals as drafts for later completion.
Validation Rules: All fields must be validated according to business rules before saving.
Auto-save: The system should automatically save changes every 5 minutes to prevent data loss.
Version Control: The system must maintain a history of changes made to each proposal.
Access Control: Only authorized users can modify proposals based on their role and permissions.
Search Functionality: Users must be able to search and filter proposals by client, status, and date.