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

View a single CAN's event history / audit log #2680

Open
2 of 24 tasks
jonnalley opened this issue Aug 15, 2024 · 0 comments
Open
2 of 24 tasks

View a single CAN's event history / audit log #2680

jonnalley opened this issue Aug 15, 2024 · 0 comments
Assignees
Labels
design this is a design task Dev Backend Ready Backend, Pipeline, or other UX related work is refined, and ready for Developers Dev Frontend Ready Designers have created and finalized the designs, story has been refined, and ready for a Developer story A defined user story adhering to expected norms including a narrative user research this issue requires user research

Comments

@jonnalley
Copy link
Contributor

jonnalley commented Aug 15, 2024

User Story

As an OPRE staff member, I need to see the history of a CAN's creation and modifications so I can be aware of what changes have been made over its lifecycle.

Acceptance Criteria

  • For a given CAN, a user can view a history of the who, when, and what of the CAN's changes/audit log
  • WRT the "who", as with all data changes, being able to track not only the OPS user, but also remote IP address is required. See AU-7 and AU-7 (1)
  • Audit logs should be immutable (AU-9)

Tasks

UX

Dev

API
FE
  • Add component for CAN history to the CAN Details page
BE
  • Add MessageBus to handle triggers on OpsEvent #3199
  • Add CANHistory model
  • Add a record to CANHistory in the service layer for:
    • /can
    • /budget-line-items
    • /can-funding-received
    • /can-funding-details
    • /can-funding-budget
  • Add /can-history endpoint #3276
  • Add CANHistoryFormatter class responsible for formatting CANHistory records (used in the /can-history response)
  • Tech debt: Back port CANHistory solution to AgreementHistory

Definition of Done Checklist

  • UI works as designed (UX team)
  • Usability validated (UX team)
  • PR(s) have been merged to main
  • Design/tech debt eliminated
  • New design/tech debt documented (if applicable)
  • Build process updated
  • Documentation updated or added
  • Feature flags/toggles created

Additional Context & Resources

@jonnalley jonnalley added design this is a design task story A defined user story adhering to expected norms including a narrative user research this issue requires user research labels Aug 15, 2024
@jonnalley jonnalley changed the title Copy of View a single CAN's details View a single CAN's event history / audit log Aug 15, 2024
@jonnalley jonnalley added Dev Frontend Ready Designers have created and finalized the designs, story has been refined, and ready for a Developer Dev Backend Ready Backend, Pipeline, or other UX related work is refined, and ready for Developers labels Aug 15, 2024
@rajohnson90 rajohnson90 self-assigned this Jan 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design this is a design task Dev Backend Ready Backend, Pipeline, or other UX related work is refined, and ready for Developers Dev Frontend Ready Designers have created and finalized the designs, story has been refined, and ready for a Developer story A defined user story adhering to expected norms including a narrative user research this issue requires user research
Projects
None yet
Development

No branches or pull requests

6 participants