Users and Clients by Location

1. What does this feature do? (High-Level Overview)

The Users and Clients by Location report gives authorized administrators a cross-location summary of how many active users and active clients are associated with each location. It helps operations teams compare staffing and client volume by location status without opening each location individually.

2. Who is this for? (Roles & Permissions)

• Superadmin / Admin: Can review the report when their role includes the required report permissions.
• Operations or administrative roles with view_employees and view_all_clients: Can open the report and review user/client counts by location.

Required permissions:

• view_employees - required to access employee/user counts.
• view_all_clients - required to access client counts.

3. Business Rules & Enforcements

• Rule 1: The report endpoint is protected by both view_employees and view_all_clients.
• Rule 2: The report is grouped by location and returns one row per location matching the selected location status.
• Rule 3: The default location status is Active.
• Rule 4: Available location status filters are Active, Inactive, and Stop.
• Rule 5: Client counts include clients with status active or activeRbtReplacement.
• Rule 6: User counts include only active users whose assignment to that location is also active.
• Rule 7: The report can be sorted by Location, Users, or Patients/Clients count.
• Rule 8: Results are paginated. The screen supports page sizes of 50, 100, and 200 rows.
• Rule 9: Clicking a location name opens that location’s edit/details page.

4. UI Placement

1. Reports portal > Admin section > Users and Patients by Location - report card that opens the screen.
2. Report screen (/reports/users-patients-by-location) - table titled Users and Clients by Location.
3. Location status filter - dropdown above the table for Active, Inactive, and Stop locations.
4. Report table - Location, Users, and Patients columns with sortable headers.
5. Pagination footer - shows the visible entry range and page navigation.

5. How-To Guide (Step-by-Step)

Scenario A: Review active user and client counts by location

1. Log in with a role that has view_employees and view_all_clients.
2. Open Reports.
3. In the Admin section, click Users and Patients by Location.
4. Leave Location status set to Active.
5. Review each row to compare the active users and active clients for each active location.
6. Use the table headers to sort by Location, Users, or Patients.
7. Click a location name if you need to open the location details page.

Scenario B: Review inactive or stopped locations

1. Open the Users and Clients by Location report.
2. Change Location status to Inactive or Stop.
3. Wait for the table to refresh.
4. Review the counts for locations in the selected status.
5. Use pagination if the selected status returns more rows than the current page size.

Scenario C: Navigate a larger report

1. Open the report and select the location status you need.
2. Use Previous, Next, or a page number to move through the results.
3. Sort the table before paging if you need to review highest or lowest counts first.
4. Use the entry range at the bottom of the table to confirm which rows are currently visible.

6. What happens if…? (Edge Cases / FAQ)

• Q: Why does a location show zero users?

  • A: The report counts only active users with an active assignment to that location. Inactive users or inactive location assignments are not included.

• Q: Why does the client count include clients that are not simply marked active?

  • A: The report also counts clients with the activeRbtReplacement status because they are still treated as active for this operational summary.

• Q: What happens if there are no locations for the selected status?

  • A: The table shows “No data available” and the total entry count is zero.