Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

LCFS - Organizational details in compliance reports #1694

Open
15 tasks
airinggov opened this issue Jan 14, 2025 · 0 comments
Open
15 tasks

LCFS - Organizational details in compliance reports #1694

airinggov opened this issue Jan 14, 2025 · 0 comments
Assignees
Labels
Compliance Reporting High High priority ticket but not critical at this time Story User story

Comments

@airinggov
Copy link
Collaborator

airinggov commented Jan 14, 2025

Description:
Enhance compliance and supplemental reports to capture and store organizational details as snapshot data at the time of report creation. The snapshot data must remain immutable, ensuring it is not affected by subsequent updates to the organization's profile. The captured details include:

  • Legal name of organization
  • Operating name of organization (defaults to Legal name if null)
  • Phone number
  • Email address
  • Address for service
  • Address in B.C. (defaults to Address for service if null)

Addresses (that are comprised of multiple fields in the company profile) can be saved as a single concatenated field.

If any of these fields are null, prevent the report from being submitted. Display the word 'Required' in red where the value should be.

The information is saved in a new table and is no longer linked to the main organizational profile. A pencil icon allows the user to update these details in text boxes with a save button for inline editing.

The Edited flag is added when the BCeID user click Save on the edit form.

Wireframe: <Prototype>

  • Display organization details in text boxes when the pencil icon is clicked, along with a save button for inline updates.

Purpose and benefit to user:
This feature ensures compliance with legal reporting requirements by preserving organizational details as they were at the time of report creation. It prevents data inconsistencies caused by future updates to the organization's profile, providing an accurate historical record.

Acceptance Criteria:

  • Organizational details are retrieved from the main profile when a draft report is created.
  • Captured details include:
    • Legal name of organization
    • Operating name of organization (defaults to Legal name if null)
    • Phone number
    • Email address
    • Address for service
    • Address in B.C. (defaults to Address for service if null)
  • The details are saved in a new, independent table linked to the report.
  • Organizational details are no longer linked to the main profile after saving.
  • A pencil icon enables the display of these details in editable text boxes with a save button.
  • Updates made through the text boxes are saved inline without affecting the organization's main profile.

Development Checklist:

  • Create a new database table to store snapshot organization details for each report.
  • Implement logic to retrieve and save the required details at the time of draft creation.
  • Add default fallback logic for Operating name and Address in B.C.
  • Implement a UI component with a pencil icon to enable inline editing of organizational details.
  • Ensure changes made in the inline editor are saved only to the report-specific data in the new table.
  • Thorough testing:
    • Validate data retrieval and default fallback logic.
    • Test the immutability of stored snapshot data after organizational profile updates.
    • Verify the inline editing feature and save functionality.

Notes:

  • This feature must comply with legal requirements for data immutability.
  • Coordinate with the UI/UX team to ensure seamless integration of the inline editing functionality.
  • Communicate this change to any teams responsible for downstream systems dependent on organizational details.
@airinggov airinggov added Compliance Reporting High High priority ticket but not critical at this time Story User story labels Jan 14, 2025
@dhaselhan dhaselhan self-assigned this Jan 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Compliance Reporting High High priority ticket but not critical at this time Story User story
Projects
None yet
Development

No branches or pull requests

2 participants