bcgov / bcgov/lcfs

LCFS - Allocation agreement form (outside compliance reporting)

Open
#3,476 0 comments 0 reactions 0 assignees View on GitHub
Compliance Reporting Medium Story
Dominant language
Python
Stars
6
Forks
6
Avg merge
2d 7h
Merged PRs (30d)
87

Description

**Description**
Create a second version of the **Allocation Agreement** form that functions outside from the compliance reporting workflow.

This version will be accessible via a new tab on the main **Compliance reporting** index page and will serve as both an index of existing agreements and an interface to add or edit new ones.

**Wireframes**

<[BCeID Allocation agreement form](https://preview.uxpin.com/e0e2f15fc1b52987fd0287ad8c8103452dd16d60#/pages/216070458)>

<[IDIR Allocation agreement form](https://preview.uxpin.com/e0e2f15fc1b52987fd0287ad8c8103452dd16d60#/pages/216180827)>

Use the existing Allocation Agreement form layout as a base.
Minor changes are outlined below — see mockup.

**Purpose and Benefit to User**
To allow organizations to manage allocation agreements separate from compliance reporting.
This supports early entry and maintenance of agreements before report creation, ensuring allocation data is accurate and available for linking to charging sites and FSE records.

**Acceptance Criteria**
- [ ] Add a new tab named **“Allocation agreements”** to the main **Compliance reporting** index page.
- Tab should appear **between** the existing **“Compliance reporting”** and **“Manage charging sites”** tabs.
- [ ] This new tab should display an **index of existing allocation agreements**.
- [ ] Provide the ability to **add** and **edit** agreements from this view.
- [ ] Display modified top intro text for this standalone version:
> “Allocation agreements must be entered before adding charging sites and FSE that you have been allocated responsibility for.”
> (Followed by the existing intro text from the report version.)
- [ ] Rename the **“Save and return to report”** button to **“Save and return”** on this version only.
- [ ] Ensure all standard validation and form logic remain consistent with the existing report-integrated version.
- [ ] Ensure navigation returns to the standalone index after saving.

**Development Checklist**
- [ ] Duplicate and adapt the existing Allocation agreement form component.
- [ ] Implement routing and navigation for the new **Allocation agreements** tab.
- [ ] Add data loading and management logic to handle agreements outside report context.
- [ ] Apply conditional text and button label changes specific to this version.
- [ ] Ensure shared data model and backend logic support agreements created from either entry point.
- [ ] Test for correct behavior in both IDIR and BCeID environments.
- [ ] Validate permissions — only authorized roles can access or modify agreements.
- [ ] Please ensure accessibility requirements are WCAG 2.2 compliant.

**Notes**
- All agreement records should remain visible to their originating organization across both entry points.
- This version supports pre-report data setup and avoids dependency on a report being in progress.
- Allocation agreements expire after 3 years (section 10 of general reg)

Contributor guide

Open the contributing guide

Research direction

Start by locating the existing Allocation Agreement form and the main Compliance reporting index, then compare their current behavior with the linked BCeID and IDIR wireframes. The work is done when the standalone tab supports listing, adding, editing, validation, permissions, and navigation for both environments without changing the report-integrated version.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
full-stack
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.