Model and capture local enrollment events

[angela-tran]

As we roll out the in-person eligibility and enrollment feature, we'd like to implement a basic enrollment log to support reporting or auditing requests from agencies -- in a way that is not tied to an external service.

Since Django already provides a framework for modeling this data, we can start simply by:

• Creating a new Django model like EnrollmentEvent
• Creating and saving an instance of this model when enrollment succeeds (digital and in-person)

Acceptance Criteria

EnrollmentEvent

• Django model defined in the usual benefits/core/models.py with migrations
• Fields
  • id (pk): UUIDField with default configured
  • agency: ForeignKey to TransitAgency
  • flow: ForeignKey to EnrollmentFlow
  • method: TextField with choices=["digital", "in_person"]
  • verified_by: TextField
  • enrollment_datetime: DateTimeField with default to the current datetime when the model instance is created
  • expiration_datetime: DateTimeField
• All fields are required, except for expiration_datetime
• All fields are read-only for all users (in production)
• Model instances can be created, viewed, and deleted by superuser (except in production, where they are read-only)
• Model instances can be viewed by STAFF_GROUP_NAME members in all environments, and added/changed in non-production environments
• No other permissions for this model for any user
• Implement __str__ for default Admin display to output the enrollment_datetime

Implementation

• When a user successfully enrolls via the Benefits app interface, code creates and saves an EnrollmentEvent:
  • agency: the agency from the user's session
  • flow: the flow from the user's session
  • method: "digital"
  • verified_by depends on the value of uses_claims_verification
    • True: flow.claims_provider.client_name
    • False: flow.eligibility_api_url
  • expiration_datetime: calculated enrollment expiry, if any
• When a user successfully enrolls via the In-person interface, code creates and saves an EnrollmentEvent:
  • agency: the agency from the user's session
  • flow: the flow from the user's session
  • method: "in_person"
  • verified_by: f"{user.first_name} {user.last_name}" from the currently logged-in agency user
  • expiration_datetime: calculated enrollment expiry, if any

Additional context

[thekaveman]

We're not going to work on this right now for the MVP of the in-person eligibility and enrollment feature.

[thekaveman]

We'll come back to this feature later and specify it in more detail.

[thekaveman]

Updated this ticket to describe just modeling and capturing the data for a local enrollment log.

We'll come back to visualizing and reporting on this data later.