Users (Dashboard)
Access prerequisites
- Permission (module):
viewUsers - License/Feature: None.
- Menu container: GENERAL → Dashboard group
What it is / when to use
Analytical panel (read-only) of the user base. Shows the total number of registrations and the composition of the base by account type (Legal Entity × Individual), nationality (Brazilians × Foreigners) and how many have a digital account (banking). Also includes a query for registrations by period. Use it to track base growth and customer profile.
Prerequisites
- Permission:
viewUsersin the role (dual permission — CPM enum + DB module). - License/Feature: None.
- Dependencies on other screens: Loads the user list (
AccountService.getUsers).
Step by step
- Open the Dashboard → Users menu.
- Wait for the cards and charts to load.
- (Optional) Set a start date and end date and click Search to see the number of registrations in the period (total, Brazilians, foreigners).
Filters and columns
| Indicator / Chart / Filter | What it shows | Data source |
|---|---|---|
| Number of users | Total registrations | users.length |
| Number of companies | Accounts with account_type == '1' (Legal Entity) | filter |
| Number of individuals | Accounts with account_type == '0' (Individual) | filter |
| Brazilians / Foreigners | No passport = Brazilian; with passport = foreigner | presence of the passport field |
| With digital account | Users with bankingAccount | filter |
| Account type (pie) | Legal Entity × Individual | totals |
| Nationalities (pie) | Brazilian × Foreign | totals |
| Monthly registrations (bar) | Total per registration month | grouped by month of the when field |
| Start date / End date | Interval for the registrations-by-period query | sent to getQtyUsersByPeriod (CPM-UserController); the Search button is disabled if the start date is later than the end date |
Business rules / caveats
Attention
- Nationality is inferred from the passport: the panel considers "foreigner" every user who has a
passportfilled in, and "Brazilian" the rest. It is not an explicit nationality field. - Period filter validation: the Search button is blocked when the start date is later than the end date.
- Error ≠ zero: an error page indicates a failure reading the user base, not an empty base.