System use case specification maintain environmental licenses - ESG-Project/documentation GitHub Wiki


Identification	UC06
Use case	Maintain environmental licenses
Actors	Administrator, Technician
Stakeholders and interests	Consulting company: Ability to maintain the environmental licenses of each project.
Pre-conditions	User is logged into the system as an administrator or technician; Has at least one registered client; Has at least one registered project.
Minimum guarantees	System prevents duplicate records.
Success guarantees	User performs any CRUD manipulation or renewal of licenses.
Business rules	BR02.

Main Success Scenario

User Action	System Response
1. This use case begins when the user selects the option to list licenses of a project	2. The system displays the list of registered licenses linked to the project
3. The user accesses the option to register a new license	4. The system displays the license registration form
5. The user fills in the license information indicating whether it is a renewal or not	6. The system validates the input
7. The user selects the save option	8. The system validates all information and saves the license data
	9. The system confirms the successful registration of the license

User Action	System Response
1. The user accesses the option to edit a license	2. The system displays the license information in an editable form
3. The user modifies the license's information	4. The system validates the changes
5. The user selects the save option	6. The system validates all information and updates the license data
	7. The system confirms the successful update of the license

User Action	System Response
1. The user accesses the option to delete a license	2. The system displays a confirmation dialog
3. The user confirms the deletion	4. The system verifies if the license can be deleted
	5. The system removes the license data
	6. The system confirms the successful deletion of the license

User Action	System Response
	1. The system detects that the license has associated records (e.g., documents, conditions)
	2. The system displays an error message explaining why the license cannot be deleted
	3. The system returns to the licenses list

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

User Action	System Response
	1. The system detects invalid or missing information
	2. The system displays an error message to the user
3. The user corrects the information and resubmits	4. The system validates the corrected information and returns to step 6 of the Main Success Scenario

License Information: Must include license number, type, issue date, expiration date, status, and project association.
Duplicate Prevention: The system must check for existing licenses with similar information before saving.
Data Validation: All license information must be validated according to business rules.
Access Control: Only authorized users can modify license information based on their role.
Audit Trail: The system must maintain a history of all changes made to license records.
Soft Delete: When a license is deleted, its information should be archived rather than permanently removed.
Search Functionality: The system must provide search and filter capabilities for the licenses list.
Status Management: The system must support different license statuses (Active, Expired, Pending Renewal).
Project Association: Each license must be associated with a valid project.
Document Management: The system must support attaching and managing related documents.
Notification System: The system must notify users about upcoming license expirations and renewals.
Renewal Process: The system must support the license renewal process with appropriate workflows.
Condition Tracking: The system must track and manage license conditions and requirements.
Compliance Monitoring: The system must monitor license compliance status.