bcgov / bcgov/lcfs

LCFS - Implement volume of eligible renewable fuel retained input (Line 6 of the report summary)

Open
#734 1 comment 0 reactions 0 assignees View on GitHub
Compliance Reporting Medium Story
Dominant language
Python
Stars
6
Forks
6
Avg merge
2d 4h
Merged PRs (30d)
87

Description

![Image](https://github.com/bcgov/lcfs/assets/156380046/50055db1-8ca9-4e33-9fd8-43d8f9f23618)

**Description:**
Add functionality to report the volume of eligible renewable fuel retained (up to 5% of the obligations calculated on Line 4) for each fuel class (Gasoline, Diesel, Jet Fuel) in the compliance report summary. This includes a free text field for user input, restricted to positive number values, and conditional display based on the balance in cells G2, D2, and J2.

*Important* TFRS displays a formula showing how much volume the user can report based on the amount input in Line 4 x 0.05 for each fuel class (Gas, Diesel, Jet). It will not be possible to replicate this in the LCFS Portal because of the new structure of the table to include all 3 classes, but maybe we could restrict values entered in each cell by no more than 5% of the value in line 4. This validation choice will require further discussion and will be dealt with in a different card.

**Wireframe:** [link](https://preview.uxpin.com/da68049c0af15edd7ce4e47e4bee431fed40c30d#/pages/178083833?mode=m)

**Purpose and Benefit to User:**
To allow users to report retained renewable fuel volumes, ensuring compliance with the regulation and facilitating accurate tracking of surplus renewable fuel for future compliance periods.

**Acceptance Criteria:**
- [ ] Given I am a BCeID user, When I view the compliance report summary, then I see free text fields for reporting retained fuel volumes for each fuel class in cells G6, D6, and J6.
- [ ] Given I am a BCeID user, When I input retained fuel volumes, then the fields only accept positive number values.
- [ ] Given I am a BCeID user, When I view the compliance report, then the free text fields for retained fuel volumes are only visible if cells G2, D2, and J2 do not show a balance of zero.

**Development Checklist:**
- [ ] Add free text fields for user input in cells G6, D6, and J6, restricted to positive number values.
- [ ] Implement conditional logic to display the free text fields only if cells G2, D2, and J2 do not show a balance of zero.
- [ ] Ensure that the text fields are user-friendly and clearly labeled.
- [ ] Test the conditional visibility and input restrictions to ensure correct functionality.

**Notes:**
- Confirm the data validation rules for positive number values.

Contributor guide

Open the contributing guide

Research direction

Start by locating the compliance report summary and compare it with the linked wireframe. Implement fields for retained volumes in G6, D6, and J6, with positive-number validation and visibility controlled by the corresponding G2, D2, and J2 balances. Done means the acceptance criteria and conditional input tests pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.