bcgov / bcgov/lcfs

LCFS - Create the Evidence Requirements table

Open
#4,846 0 comments 0 reactions 1 assignee Claimed by @AlexZorkin View on GitHub
Initiative Agreements Medium Task
Dominant language
Python
Stars
6
Forks
6
Avg merge
2d 7h
Merged PRs (30d)
87

Description

**Describe the task**
Create a new Evidence Requirements table to support evidence requirements associated with Designated Actions. A single Designated Action may contain multiple Evidence Requirements used to define submission requirements for proponents and support analyst review activities. It should support Change Log type supplemental amendments, (Change Orders).

- Initiative agreement
-- Designated action
--- **Evidence requirement**
---- Evidence submission

**Purpose**
Evidence Requirements provide the structure for documenting the individual requirements that proponents must satisfy for a Designated Action. The table will also provide a location for analysts to record assessment findings and support future evidence submission, review, attachment, comment, and workflow functionality.

**Acceptance Criteria**
- [ ] Create an Evidence Requirements table.
- [ ] The table contains a unique primary key.
- [ ] The table contains a foreign key relationship to the Designated Actions table.
- [ ] A single Designated Action can be associated with multiple Evidence Requirements.
- [ ] Evidence Requirements include a Description field.
- [ ] Evidence Requirements include an Analyst Review field.
- [ ] The Analyst Review field supports long-form text entry.
- [ ] Evidence Requirements can be displayed in a defined order for a Designated Action.
- [ ] Evidence Requirements can be created, edited, and deactivated.
- [ ] Evidence Requirements support audit fields:
- Created By
- Created Date
- Updated By
- Updated Date
- [ ] Evidence Requirements support Active/Inactive status for soft deletion.
- [ ] Database relationships enforce referential integrity with the Designated Actions table.
- [ ] Table structure supports future attachment associations.
- [ ] Table structure supports future comment and history functionality.
- [ ] Table structure supports future evidence review workflow enhancements without requiring significant redesign.

**Additional context**
- Suggested fields:
- EvidenceRequirementId (PK)
- DesignatedActionId (FK)
- RequirementNumber
- Description
- AnalystReview
- IsActive
- CreatedBy
- CreatedDate
- UpdatedBy
- UpdatedDate
- Evidence Requirements represent the individual requirements associated with a Designated Action.
- Agreement notes (e.g., Note 1, Note 2) should be stored as Evidence Requirements where applicable.
- Analysts may provide substantial review findings and should not be limited to short text entries.
- Future enhancements may include attachments, comments, review statuses, workflow actions, and structured review outcomes.

evidence requirements

DA_ID
Evidence_Requirements_ID
Evidence_Type
Evidence_Requirements_Number
Evidence_Requirements_Description
Evidence_Requirements_Changelog
Created_Date
Created_By
Updated_Date
Updated_By

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.