Epic: Data usage increment 1

[jadudm]

Definitions

• ARO: Audit resolution official. A federal employee who uses audit submissions from the FAC in the course of their duties at a grant-making agency.

Engineering stories

Preview Give feedback

1. Build MVP audit search front-end #2369
   eng +1
   
2. Add Form and (stubbed) View for search #2423
   eng +1
   
3. Implement View for search #2424
   eng +1
   
4. Implement server side Search Form validation #2432
   eng +1
5. Update search template to display form validation errors #2434
   eng +1
6. Update tabular search template to render search results #2425
   eng +1
7. Implement summary view of individual search pages
8. Implement View for getting individual submission details
9. Determine how header/nav will work w.r.t. search #2340
   design product +2
10. Add View for downloading XLSX files #2629
    eng +1
    
11. Search: inexact matches on name fields #2642
    +0
12. XLSX download view #2626
    +0
13. Make name search queries use LIKE semantics #2637
    eng +1
    
14. Summary Updates #2605
    +0
    

The original design ticket follows below. The engineering stories above stemmed from that work.

---

At a glance

In order to conduct oversight of federal dollars
as an ARO in an agency
I want a search interface and the ability to download audit info

Our first increment regarding search will focus on the needs of federal users. The interface will cover a core set of search features, and we will iterate on the functionality with users, federal and public.

Our first increment will ONLY return audits for which is_public is true.

Work at a glance

Preview Give feedback

1. Discuss mocks with users for final check on design before implementation.
2. Reflect findings/reflections out as acceptance scenarios on the epic #2274
   UX design +2
   
3. Develop Figma mocks to communicate initial design to front-end engineers
4. Document intended behavior of search fields #2275
   product +1
   
5. Mock up summary view for search results (find ticket w James P mockup) #2295
   design +1
   

Acceptance Criteria (as AROs)

We use DRY behavior-driven development wherever possible.

Scenario: I want to find everything for my agency

Given I enter my ALN (e.g. 14)
when I hit search
...

then...

Preview Give feedback

1. all the reports with that ALN in federal_awards with that agency number are returned

Scenario: I want to find everything my agency is cognizant for.

Given An agency number/name
when I select it from the list and choose "cognizant" from the dropdown

then...

Preview Give feedback

1. only reports that have that agency number as cognizant will be returned

Scenario: I want to see what came in for my agency in the past week.

Given That I enter an agency number (e.g. 14) or multiple ALNs (e.g. 92.123 and 92.456) in the ALN box
when I include a date range

then...

Preview Give feedback

1. All report IDs with those ALNs in federal_awards will be returned
2. Those results will be filtered on the fac_accepted_date inclusively. Meaning, if someone enters 9/1 and 9/7, we will include the end dates.

Additional scenarios:

1. As an AARO I want to search and download all audits submitted under my agencies ALN# within the last five business days so that I can export the results into my tracking spreadsheet which compares the results to my previous week’s search and identify new submissions.
2. As an AARO I want to search by UEI# for the last five years of audits from a single auditee so that I can review their history of findings before issuing their MDL.
3. As an AARO I want to search for a tribal auditee’s name using only the first three letters so that I can view results that include spelling variations within the name field
4. As an AARO Supervisor I want to search for all entities that my agency is cognizant for so that I can identify outstanding audits from these entities and assign them to my team for resolution.

Shepherd

• Design shepherd:
• Engineering shepherd:

Background

We are implementing the following in the first increment.

• UEI/EINs (multiple)
• CFDA/ALN: Either a two-digit number (14) which means "everything for agency number 14) or 14.XYZ, where the extension is one of our valid extensions.
• Accepted date range
• Audit year ('16-'23): checkboxes
• "Name search" (auditee, auditor, entity)
• Cog/over

We OR values together within a field. For example, if you check multiple audit years, then we say (2023 OR 2022 OR 2021); same with the ALN list and EIN/UEI list.

We AND values together between the fields. Meaning we search for the contents of the ALN box AND the contents of the date range.

Security Considerations

Required per CM-4.

Sketch

We're thinking we'll try implementing A and then changing B.

Tasks

Preview Give feedback

1. [something we'll definitely have to do]

---

Process checklist

Sketch

• Design designs all the things
• Engineering engineers all the things

Definition of Done

Triage

If not likely to be important in the next quarter...

• Archived from the board

Otherwise...

• Has a clear story statement
• Design or Engineering accepts that it belongs in their respective backlog

Design Backlog

• Has clearly stated/testable acceptance criteria
• Meets the design Definition of Ready [citation needed]
• A design shepherd has been identified

Design In Progress

• Meets the design Definition of Done [citation needed]

Design Review Needed

• Necessary outside review/sign-off was provided

Design Done

• Presented in a sprint review
• Includes screenshots or references to artifacts

If no engineering is necessary

• Tagged with the sprint where it was finished
• Archived

Engineering Backlog

• Has clearly stated/testable acceptance criteria
• Has a sketch or list of tasks
• Can reasonably be done in a few days (otherwise, split this up!)

Engineering Available

• There's capacity in the In Progress column
• An engineering shepherd has been identified

Engineering In Progress

• Meets acceptance criteria
• Meets QASP conditions

If there's UI...

• Screen reader - Listen to the experience with a screen reader extension, ensure the information presented in order
• Keyboard navigation - Run through acceptance criteria with keyboard tabs, ensure it works.
• Text scaling - Adjust viewport to 1280 pixels wide and zoom to 200%, ensure everything renders as expected. Document 400% zoom issues with USWDS if appropriate.

Engineering Blocked

• Blocker removed/resolved

Engineering Review Needed

• Outside review/sign-off was provided

Engineering Done

• Presented in a sprint review
• Includes screenshots or references to artifacts
• Tagged with the sprint where it was finished
• Archived