Skip to content

Commit 8012414

Browse files
committed
Remaining reports work, user management
1 parent 2e77efe commit 8012414

File tree

5 files changed

+72
-43
lines changed

5 files changed

+72
-43
lines changed

docs/user_guide/bank/asking_for_changes.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
READY FOR REVIEW
12
# Asking for changes
23

34
We welcome ideas for how Human Essentials can support your work better.

docs/user_guide/bank/reports_annual_survey.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
DRAFT USER GUIDE
1+
READY FOR REVIEW
22
## Annual Survey
33
The annual survey contains information useful for completing the NDBN or Alliance for Period Supplies annual survey, but also for grant writing.
44
Each year's annual survey becomes available January 1 of the following year.
@@ -24,14 +24,14 @@ You can also extract the report to a csv file by clicking "Export Report" (B)
2424

2525
### Calculation notes
2626

27-
1/ We are in the process of changing the calculations so that items in kits appear in the totals for each value.
28-
At time of writing, the # of disposable and cloth diapers distributed include any diapers in kits, and period supplies also include period supplies in kits, but adult incontinence, and other do not.
29-
At time of writing, purchased/donated supplies do not include any kit purchases/donations. ( We only know of one bank that currently has kits donated.)
27+
1/ We are in the process of changing the calculations so that Items in Kits appear in the totals for each value.
28+
At time of writing, the # of disposable and cloth diapers distributed include any diapers in Kits, and period supplies also include period supplies in Kits, but adult incontinence and other do not.
29+
At time of writing, purchased/donated supplies do not include any Kit Purchases/Donations. ( We only know of one bank that currently has kits donated.)
3030

31-
2/ % donated / purchased is based on the number of items acquired, not the number of items distributed.
31+
2/ % donated / purchased is based on the number of Items acquired, not the number of Items distributed.
3232

3333
3/ How we calculate per person values:
34-
If you have entered a non-zero value for an [item](inventory_items.md#editing-an-item) in the quantity per individual field, we use that value. Otherwise, we assume 50 of the item per individual.
34+
If you have entered a non-zero value for an [Item](inventory_items.md#editing-an-item) in the quantity per individual field, we use that value. Otherwise, we assume 50 of the Item per individual.
3535

3636

3737

docs/user_guide/bank/reports_distributions_by_county.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
DRAFT USER GUIDE
1+
READY FOR REVIEW
22
# Distributions by County Report
33

44

55
![distributions_by_county_default_view](images/reports/reports_distributions_by_county_1.png)
66

7-
This report shows the total items and estimated total market value of the distributed items for the time period.
7+
This report shows the total items and estimated total market value of the distributed Items for the time period.
88

99
We use the area served information entered in each partner's [profile](pm_partner_profiles.md) to allocate the items that have been distributed to them. If that information has not been provided, the items you've distributed are put into the 'Unspecified' category.
1010

1111

12-
**N.B.** If you are using kits, please note that this treats each kit as an item, rather than counting the items within the kits separately.
12+
**N.B.** If you are using Kits, please note that this treats each Kit as an item, rather than counting the items within the Kits separately.
1313

1414
If you want to see a time period other than the default of 60 days prior to 30 days forward from today, change the date range and click "Filter". We recommend you use the little pop-up gizmo to enter your date range, as the format of the date range is very fussy.
1515

docs/user_guide/bank/reports_trends.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
DRAFT USER GUIDE
1+
READY FOR REVIEW
22
# Trends Reports
3-
The trends reports (one each for Distributions, Donations, and Purchases) give you a picture of the activity on any item over the last 12 months.
3+
The trends reports (one each for Distributions, Donations, and Purchases) give you a picture of the activity on any Item over the last 12 months.
44

55
The examples below will use the Distributions - Trends report, but everything is basically the same for Donations- Trends and Purchases - Trends.
66

@@ -13,19 +13,19 @@ This will bring up a blank "Monthly" Distributions report, like so:
1313

1414
![Blank trends report](images/reports/reports_trends_1.png)
1515

16-
To see the activity on a particular item, click on that item. You can click on as many as you want -- if, for instance, you want compare the distributions of multiple sizes, you can do that -- but in general, fewer will be better.
16+
To see the activity on a particular Item, click on that Item. You can click on as many as you want -- if, for instance, you want compare the Distributions of multiple sizes, you can do that -- but in general, fewer will be better.
1717

1818
(Our test data only has very recent data in it, so you'll see more bars, unless of course, you are a brand new bank!)
1919

2020
![trends report with 2 items](images/reports/reports_trends_2.png)
2121

22-
You can also hover over any month to see the numerical levels for the chosen items for that month.
22+
You can also hover over any month to see the numerical levels for the chosen Items for that month.
2323

2424
![trends report with breakout](images/reports/reports_trends_3.png)
2525

26-
To clear the items - either click on them again, or click "Deselect All"
26+
To clear the Items - either click on them again, or click "Deselect All"
2727

28-
You can click "Select All" to see *all* the items, but that will produce a very busy visual.
28+
You can click "Select All" to see *all* the Items. That will produce a very busy visual, indeed.
2929

3030

3131

Lines changed: 56 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,84 @@
1-
DRAFT USER GUIDE
1+
READY FOR REVIEW
22
# User Management
33

4-
The bank organization admin users can manage both the staff who have access to humanessentials at the bank, and at each of the bank's partners.
5-
The partners can manage their own users as well, but it is sometimes necessary for the bank to be able to add a user at the partner agency due to staff turnover.
4+
The bank organization admin Users can manage both the staff who have access to humanessentials.app at the bank, and at each of the bank's Partners.
5+
The Partners can manage their own Users as well, but it is sometimes necessary for the bank to be able to add a User at the Partner due to staff turnover.
66

77
### How do I know what access I have?
88
If you look at the left-hand menu, and you see, down at the bottom, a section "My Organization", then you have admin access.
9-
Otherwise, if you see "Donations", you have bank user access.
10-
If, instead, you see "My Profile", you are signed in as a partner.
11-
[TODO: Annotated screen shots]
9+
Otherwise, if you see "Donations", you have bank User access.
10+
![annotated screenshot showing where "Donations" and "My Organization" are in the menu](images/user_management/user_access_admin_and_user.png)
11+
If, instead, you see "My Profile", you are currently signed in as a Partner.
12+
![annotated screenshot showing where "My Profile" shows for a partner User"](images/user_management/user_access_partner.png)
1213

1314
## Managing Bank staff access
14-
To manage bank staff, you must be signed in as a user with admin rights.
15+
To manage bank staff, you must be signed in as a User with admin rights.
1516

16-
### Adding a user
17-
To add a user, sign in as someone who has bank admin access, then click on "My Organization" in the left-hand menu.
17+
### Adding a User
18+
To add a User, sign in as someone who has bank admin access, then click on "My Organization" in the left-hand menu.
1819
Scroll down to the bottom of that page. You will see a section labelled "Users".
19-
Check that the user is not already listed, then click on the "Invite User to this Organization" button in the bottom-right corner of the page.
20+
Check that the User is not already listed, then click on the "Invite User to this Organization" button in the bottom-right corner of the page.
2021

21-
[TODO: More Screenshots]
22+
![navigation to invite new User](images/user_management/user_invite_new_bank_user.png)
2223

23-
In the window that pops up, add the user's name and email, then click "Invite User".
24+
In the window that pops up, add the User's name and email, then click "Invite User".
2425

2526
An email like the following will be sent to that email:
26-
![Email that goes to the invited user, with button to start password process](images/user_management/user_invite_email.png)
27+
![Email that goes to the invited User, with button to start password process](images/user_management/user_invite_email.png)
2728

28-
When the new user clicks "Accept Invitation", they will be prompted to set their password. Once they do, they will have bank user level access to the system.
29-
### Deleting a user
29+
When the new User clicks "Accept Invitation", they will be prompted to set their password. Once they do, they will have bank User level access to the system.
30+
### Deleting a User
3031

3132
When someone leaves your organization, you will want to remove their access to humanessentials. To do that,
32-
sign in as someone who has bank admin access, then click on "My Organization" in the left-hand menu.
33-
Scroll down to the bottom of that page. You will see a section labelled "Users".
34-
Find the user you wish to delete.
35-
*If* they had admin access, you will first need to demote them to user, by clicking their "Demote to User" button.
36-
Then, click the "Actions" button beside their name, and then click "Remove User".
33+
sign in as someone who has bank admin access, then
3734

38-
### Giving a user admin access
39-
To promote a user to have admin access,
35+
(1) click on "My Organization" in the left-hand menu.
36+
(2) Scroll down to the bottom of that page. You will see a section labelled "Users".
37+
Find the User you wish to delete.
38+
39+
*If* they had admin access, you will first need to demote them to User, by clicking their "Demote to User" button.
40+
41+
Then, (3) click the "Actions" button beside their name, and
42+
(4) click "Remove User".
43+
44+
45+
![Steps to delete a User (who is not an admin)](images/user_management/user_delete_bank_user.png)
46+
47+
Click "OK" on the confirmation screen.
48+
49+
50+
### Giving a User admin access
51+
To promote a User to have admin access,
52+
(1) click on "My Organization" in the left-hand menu.
53+
(2) Scroll down to the bottom of that page. You will see a section labelled "Users".
54+
Find the User you wish to promote.
55+
56+
Then, (3) click the "Actions" button beside their name, and
57+
(4) Click "Promote to Admin"
58+
59+
60+
![Steps to promote a User to admin](images/user_management/user_promote_bank_user.png)
61+
62+
63+
Click "OK" on the confirmation screen.
64+
65+
66+
### Removing admin access from a User.
67+
68+
To remove admin access from a User, sign in as someone who has bank admin access, then (1) click on "My Organization" in the left-hand menu.
69+
(2) Scroll down to the bottom of that page. You will see a section labelled "Users".
70+
Find the User you wish to remove admin access from. (3) Click the "Demote to User" button beside their name and email.
71+
72+
Click "OK" on the confirmation screen.
4073

41-
[TODO: Write this once it is fixed!]
4274

43-
### Removing admin access from a user.
4475

45-
To remove admin access from a user, sign in as someone who has bank admin access, then click on "My Organization" in the left-hand menu.
46-
Scroll down to the bottom of that page. You will see a section labelled "Users".
47-
Find the user you wish to remove admin access from. Click the "demote to user" button beside their name and email.
4876

4977
### *Help! Our admin quit and we don't have the access we need!*
5078
Send a note to info@humanessentials.app explaining the situation. We review that email on Sunday mornings.
5179
You might be able to get faster turnaround by reaching out on the human essentials slack.
5280

5381
## Managing Partner access
54-
See [Administering partner users](pm_partner_user_admin.md)
82+
See [Administering Partner Users](pm_partner_user_admin.md)
5583

5684
[Prior: Activity graph](reports_activity_graph.md) [Next: Account Management](account_management.md)

0 commit comments

Comments
 (0)