System use case specification maintain system parameters - ESG-Project/documentation GitHub Wiki

← Home / Requirements / System Use Cases / System Use Cases Specification

Identification	UC13
Use case	Maintain system parameters
Actors	Administrator
Stakeholders and interests	Consulting company: Ability to update and manage system parameters such as vehicle consumption, fuel price, and tax rates.
Pre-conditions	User is logged into the system as an administrator; System has access to relevant data storage for parameters.
Minimum guarantees	System prevents invalid parameter entries.
Success guarantees	Administrator successfully updates and saves system parameters.

Main Success Scenario

User Action	System Response
1. This use case begins when the administrator accesses their profile area	2. The system displays the administrator's profile options
3. The administrator navigates to the system parameters section	4. The system displays the current parameters (e.g., vehicle consumption, fuel price, tax rates)
5. The administrator selects a parameter to update	6. The system displays the parameter's current value in an editable form
7. The administrator enters the new value for the parameter	8. The system validates the input
9. The administrator saves the updated parameter	10. The system validates the value and updates the parameter in the database
	11. The system confirms the update to the administrator

Alternative Flows

2a Invalid parameter value entered

User Action	System Response
	1. The system detects an invalid value
	2. The system displays an error message to the administrator
3. The administrator corrects the value and resubmits	4. The system validates the corrected value and returns to step 8 of the Main Success Scenario

3b Administrator cancels the update

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

Special Requirements

• Parameter Types: The system must support different types of parameters.
• Value Validation: Each parameter must have specific validation rules based on its type and purpose.
• Access Control: Only administrators can modify system parameters.
• Audit Trail: The system must maintain a history of all parameter changes with timestamp and user information.
• Default Values: The system must maintain default values for all parameters.
• Parameter Groups: Parameters must be organized into logical groups for easier management.
• Parameter Documentation: Each parameter must have associated documentation explaining its purpose and usage.