LCFS - Forecasting Report
- Dominant language
- Python
- Stars
- 6
- Forks
- 6
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 87
Description
**Description:**
Create a new version of the compliance report called a **Forecast Report**. This report is intended for planning and forecasting purposes only and is restricted to one Forecast Report per supplier and one per government (IDIR) user. The Forecast Report will be a simplified version of the compliance report with reduced functionality, limited schedules, and a streamlined summary. Data will be stored separately from standard compliance reports and may optionally be used to seed future compliance reports.
**Wireframe:**
To be provided.
**Purpose and benefit to user:**
Allows users to model and forecast compliance outcomes across different reporting years without impacting official compliance reports. Users can explore how changes to calculation logic or CI values by year affect results and reuse forecast data when creating a new compliance report.
**Acceptance Criteria:**
- A new report type named **Forecast Report** is available in the system.
- Only one Forecast Report can exist per supplier.
- IDIR users can create one Forecast Report per government user.
- Forecast Reports exclude:
- Processing actions
- Supplier information
- Attachments
- History and assessment messaging
- Commenting features
- Forecast Reports include only the four main schedules.
- FSE and allocation agreement information is not available in Forecast Reports.
- The Summary section:
- Calculates only direct values from the included schedules
- Excludes credit balances, transactions, and unrelated summary lines (e.g., lines 6–9)
- Uses explicitly defined line numbers only
- A Year Select control allows users to change the reporting year and view recalculated results based on year-specific calculation logic and CI values.
- Schedule data autosaves as per existing behavior but is stored in a separate set of database tables specific to Forecast Reports.
- Forecast Report data can be used to seed a new Compliance Report via:
- Direct export, or
- Download/upload mechanism.
**Development Checklist:**
- [ ] Add new Forecast Report report type and enforce one-per-supplier constraint
- [ ] Remove processing, assessment, messaging, commenting, supplier info, and attachment functionality
- [ ] Limit available schedules to the four main schedules only
- [ ] Implement simplified Summary calculations with explicit line inclusion
- [ ] Add Year Select control and apply year-based calculation logic
- [ ] Create separate persistence layer/tables for Forecast Report data
- [ ] Implement export or download/upload capability to seed Compliance Reports
- [ ] Add permissions and validation to prevent misuse as an official submission
**Notes:**
- Forecast Reports are non-submittable and must not be confused with official Compliance Reports.
- Line numbers included in the Summary will be finalized and documented separately.
- Reuse of Forecast data into Compliance Reports should not automatically create or submit a report.
**Notes**
- This report should behave like a sandbox and must not integrate with credit transactions, existing compliance reports, or reporting workflows.
- When line numbers for the summary calculations are finalized, update the summary logic accordingly.
Contributor guide
Research direction
No files, tests, or entry points are identified. Start by resolving the missing wireframe and final summary line numbers, then define the report type, persistence, permissions, schedules, year selection, and export scope before implementation. Done means all listed acceptance criteria are met without affecting official Compliance Reports.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- databases, full-stack
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100