Skip to content

Commit

Permalink
Merge pull request #3386 from department-of-veterans-affairs/1722-sub…
Browse files Browse the repository at this point in the history
…mitted-info-pattern

Update for ".. keep a record of submitted info"
  • Loading branch information
humancompanion-usds authored Oct 23, 2024
2 parents 5958182 + 5696263 commit 4f4aa92
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 13 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -18,43 +18,68 @@ anchors:

### When to use this pattern

**When you are collecting information from users on a long form.** The pattern provides the user with a printable record of their submission. A printed record provides a reference for future use and helps to confirm a successful form submission.
**When you are collecting information from users on a long form.** The pattern provides the user with a printable record of their submission data. A printed record provides a reference for future use and helps to confirm a completed form was submitted to VA.

The pattern must display the name of the form, the date of the submission, a confirmation number, a copy of the data used in the form submission, and a task list outlining the next steps in the form submission process.


## Examples

### Confirmation page summary

{% include component-example.html alt="An example confirmation page containing a component that allows users to print the confirmation page." file="/images/patterns/help-users-to/keep-a-record-of-submitted-information/confirmation-page.png" caption="The 'Your application information' component provides a clear call-to-action for the user to 'Print this page'." width="75%" %}
{% include component-example.html alt="An example confirmation page showing a printable copy of their form status, a downloadable PDF, and s task list" file="/images/patterns/help-users-to/keep-a-record-of-submitted-information/confirmation-page-status.png" caption="The confirmation page provides a way for the user to 'Print this page', see their submission status and download a copy of their submission PDF. There is also a task list displaying known next steps." width="75%" %}

### Print preview of confirmation page summary

![print preview of confirmation page summary]({{ site.baseurl }}/images/patterns/help-users-to/keep-a-record-of-submitted-information/print-view-page1.png)
![print preview of confirmation page summary]({{ site.baseurl }}/images/patterns/help-users-to/keep-a-record-of-submitted-information/print-view-page2.png)
![print preview of confirmation page summary]({{ site.baseurl }}/images/patterns/help-users-to/keep-a-record-of-submitted-information/print-confirmation-status.png)

## How to design and build

### How this pattern works

* **Create a summary of submitted information.** Include a title for the summary page. An example message is: *Your application information*
* **Include a recap of submitted information.** Include the applicant's name and date of application.
* **Inform users to print the confirmation for their records.** Notify users that they can print or download their application information. An example message is: *You can print this confirmation page for your records. You can also download your completed application as a PDF.*
* **Create a summary of the action completed.** Include a success alert that accurately describes the action just completed. For example, for forms that have to travel through several systems before it gets to the system of record you can say, _Form submission started on Date_
* The alert should give a time frame for when the user should expect the next communication from VA about their form submision.
* The alert should also include a confirmation number.
* The alert should also include a link where they can go to check the status of the application. This may be a link to Claim Status Tool or My VA.
* **Include a copy of the submitted information.** Include a copy of the information submitted on the form. Be sure to mask out SSN, VA File number, and Alien Registration numbers on this copy.
* **Inform users to print the confirmation for their records.** Notify users that they can print this confirmation page.
* **Include a "Print this page" primary button.** A printed record provides a reference for future use. The "Print this page" button appears at the bottom of the summary page.
* **Include a link to download the completed application in PDF format.** The download link appears below the "Print this page" button.
* **Include a "What to expect next" task list.** (add more text here)

### Placement

The component that contains the prompt to print the confirmation page should appear under the Alert - Success component.
### Placement
The pattern should load at the top of the page beneath the h1 in this order
1. Form submission started alert
2. Coming soon: Download a PDF copy of the form
3. Information you submitted on this form accordion
4. Print this confirmation page
5. What to expect process list

### Components used in this pattern

* [Summary box]({{ site.baseurl }}/components/summary-box)
* [Button - Primary]({{ site.baseurl }}/components/button)
* [Link - Download]({{ site.baseurl }}/components/link/#download)
* [Alert]({{ site.baseurl}}/components/alert)
* [Link]({{ site.baseurl}}/components/link) (download?)
* [Accordion]({{ site.baseurl}}/components/accordion)
* [Button-Primary]({{ site.baseurl }}/components/button)
* [ProcessList-Status]({{ site.baseurl }}/components/process-list)

## When to consider something else
Forms that are submitted by unauthenticated users should not display links to claim status tool or My VA on the confirmation page as those submissions will not be immediately tracked or connected to a profile account.

If a user fills out a claim or benefit form unauthenticated or on paper, once VA associates the form with their record, it will show up in the Claim Status Tool.
This could take 7-10 days.

## Content considerations

Review the USWDS [Keep a record pattern](https://designsystem.digital.gov/patterns/complete-a-complex-form/keep-a-record/) for content considerations. The print styling differs between the VA and USWDS systems, but their high-level guidance is still relevant.

## Accessibility considerations

This pattern provides a copy of the submission in a collaspible and accessible accordion. When the page is printed, the information is also displayed even if the accordion is still closed. This helps make the page more accessible by providing a copy of the form submission outside of a PDF. A user may still save this page as a PDF, but we can't guarantee the individual accessibility methods of individual browsers and printer settings.


Review the USWDS [Keep a record pattern](https://designsystem.digital.gov/patterns/complete-a-complex-form/keep-a-record/#section_9) for accessibility considerations.

## Research findings
In [2024, VFF/MY VA Form Status Research](https://github.com/department-of-veterans-affairs/VA.gov-team-forms/blob/main/Product/2024-05%20VFF%20and%20My%20VA%20Form%20Submission%20Research/Research/Research%20Findings%20for%202024-05%20VFF%20and%20My%20VA%20Form%20Submission%20Research%20Study.md) found that a majority of Veterans indicated they would download a copy of their form submission. But, they were equally confused about the expiration date next to the PDF in My VA. Some findings are relevant to this pattern despite not yet being fully implemented.
- The majority of participants expressed a desire to download a copy of their form submission (10 of 12), and 5 of 12 participants also indicated they would want to print a copy of their form submission. With the option to download a PDF copy of the form they submitted, there was uncertainty about the significance of the date in the associated link. In My VA, the download link will only be available for 60 days due to data security concerns.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4f4aa92

Please sign in to comment.