department-of-veterans-affairs / va.gov-team

Public resources for building on and in support of VA.gov. Visit complete Knowledge Hub:
https://depo-platform-documentation.scrollhelp.site/index.html
281 stars 197 forks source link

Research In-Progress Forms on vets-api #65580

Closed oddball-lindsay closed 7 months ago

oddball-lindsay commented 12 months ago

Issue Description

We need to understand how in-progress forms are created, managed and saved in the vets-api. This will allow us to develop a robust mechanism for users to save and resume their form submissions when searching for representatives.

We suspect the vets-api system may be using something like the following to save form information:

Here's the related frontend ticket - https://app.zenhub.com/workspaces/accredited-representation-management-team-64d0dc51d3e8f4788ac6ef96/issues/gh/department-of-veterans-affairs/va.gov-team/65581


Tasks

Acceptance Criteria

cosu419 commented 8 months ago

The majority of the vets-api work here is configuring pre-fill, which is a simple API call to populate pre-existing form data. Here are the steps involved:

  1. Add application pre-fill to the ALL_FORMS object in the form_profile file
  2. In the same file, adjust the FORM_ID_TO_CLASS object and map our new pre-fill application to its corresponding FormProfile
  3. Create FormProfile file that defines a metadata object that holds the version, the pre-fill boolean, and the returnUrl
  4. Create a Form_Profile_Mapping file for the data that should be pre-filled
  5. In the vets-api settings.yml file, update relevant pre-fill boolean settings
  6. Add a test which includes the list of prefilled IDs