Business rules - ESG-Project/documentation GitHub Wiki

← Home / Requirements

This document provides an overview of the business rules that govern the system's behavior and operations. Each business rule is documented in detail in its respective specification file.

Business Rules List

ID Business Rule Description Status Priority
BR01 Technician CRUD Restriction Except for the administrator, users should not be able to modify or delete technician records. Active High
BR02 License Renewal Nearing or reaching the end of the validity of an environmental license, if the project has not yet ended, a license renewal protocol is initiated. Active High
BR03 Phytosociological Analysis Creation Analyses must be created exclusively from an existing Project page. Mandatory fields include Title, Coordinates, Collection Start Date, Plot Data, and Form Factor. Sampled Area must be auto-calculated unless justified. Active High
BR04 Analysis Viewing and Search Users can view analyses filtered by project, sorted and paginated. Search by Title or Description. Display message when no result is found. Active Medium
BR05 Phytosociological Analysis Editing Allows editing of fields such as Title, Description, Dates, and Plot Data. Validations from creation are reapplied. Active Medium
BR06 Phytosociological Analysis Deletion Deletion of an analysis is irreversible and requires explicit confirmation. Active Medium
BR07 Specimen Access and Management Specimens are only manageable when an analysis is selected and active. Access via "Species Data" tab for all operations. Active High
BR08 Specimen Addition Mandatory fields: Species, Plot, Height, and CBH(s). Optional: Family, Category, Coordinates, Observations. Includes validations and auto-calculation of DBH and Basal Area. Active High
BR09 New Species Creation Allows users to create species if not found. Requires Scientific and Family Names. Admins manage the list via a dedicated section. Active High
BR10 Batch Specimen Import Import via .xlsx or .csv using a standard template. Validates structure and content. Allows importing only valid entries and reviewing errors. Active High
BR11 Specimen Viewing Displays a table with key specimen attributes. Supports sorting, pagination, and filtering. Active Medium
BR12 Specimen Details Selecting a specimen reveals complete information including all measurements and metadata. Active Medium
BR13 Specimen Change Request Users can request updates for key fields with mandatory change comment. Requests have "Pending" or "For Review" status. Active High
BR14 Request Analysis (Admin/Mod) Admins can view all requests with filters. Displays original and requested values, user, date, and comment. Active Medium
BR15 Request Approval/Rejection Admins approve or reject requests. Approval updates data and history. Rejection requires reason. Active High
BR16 General Indicator Dashboard Dashboard available after data entry and calculations. Shows key analysis metrics and graphs in real-time. Active High
BR17 Detailed Forest Inventory Forest Inventory tab shows raw and aggregated statistics with filtering, pagination, and customizable views. Active High
BR18 Estimated Volume and Density After processing, displays volume and density estimations. Allows cubing model selection. Active High
BR19 Environmental Compensation Calculation Calculates financial and/or area-based compensation based on entered and derived data. Includes state-level rule support. Active High
BR19.1 Data Input for Compensation Inputs are auto-filled from analysis data but editable with mandatory justification. Includes vegetation, specimen, and location details. Active High
BR19.2 Compensation Calculation Logic Applies state/municipal rules for RFO, Equivalent Area, and Financial Compensation. Handles special species, abatement, and legal logic. Active High
BR19.3 Display of Compensation Results Displays compensation summaries and multiple graph types including bar, donut, stacked bar, radar. Active Medium
BR19.4 Handling Incomplete Data If required data is missing or invalid, display clear error messages and block calculation. Active High
BR20 Report Export Allows exporting of tables, reports, and graphs in multiple formats including .zip with all data. Active High

Business Rule Documentation Structure

Each business rule is documented in a separate file following this structure:

Field Description
Identification Unique identifier for the rule (BRxx)
Business rule Name of the business rule
Description Clear and concise description of the rule
Source Origin of the business rule
History Version history and important dates

Version Control

Version Date Author Changes
1.0 2024-04-26 System Initial version

Notes

  • All business rules must be reviewed and approved by stakeholders
  • Rules should be clear, unambiguous, and testable
  • Regular reviews should be conducted to ensure rules remain relevant
  • Each business rule has its own detailed specification document

Related Documents