Skip to content

Commit 4098b29

Browse files
committed
Finished organization
1 parent 9548603 commit 4098b29

File tree

1 file changed

+61
-38
lines changed

1 file changed

+61
-38
lines changed

docs/user_guide/bank/getting_started_customization.md

Lines changed: 61 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
DRAFT USER GUIDE
1+
READY FOR REVIEW
22

33
# Organization information and customization
44

@@ -9,7 +9,7 @@ Only organization admins have access to this area.
99

1010
## Getting to the organization edit
1111

12-
Scroll down to the bottom of the left-hand menu (you may have to collapse areas that you've opened)to the last item. Click on "My Organization".
12+
Scroll down to the bottom of the left-hand menu (you may have to collapse areas that you've opened) to the last option. Click on "My Organization".
1313

1414
![Navigation 1](images/getting_started/customization/gs_customization_navigation_1.png)
1515

@@ -34,17 +34,17 @@ The name of your Essentials Bank. This appears in the headings on most screens
3434
You don't change this -- we assigned it when we set it up -- it's here for reference for support calls if we need it.
3535

3636
#### NDBN membership
37-
This should be filled in already from your account request,but if it isn't, you can select it from the list. That list is updated on an irregular basis, so if you are an NDBN member, and you aren't on the list, let us know and we'll get a fresh list uploaded.
37+
This should be filled in already from your Account Request,but if it isn't, you can select it from the list. That list is updated on an irregular basis, so if you are an NDBN member, and you aren't on the list, let us know and we'll get a fresh list uploaded.
3838
This is included on the Annual Survey report. That's the only effect.
3939

4040
#### Url
41-
Your Essentials Bank's website address. This is mostly used during the account request process, so we can check if you are a good fit before you invest a lot of time and energy into the system.
41+
Your Essentials Bank's website address. This is mostly used during the Account Request process, so we can check if you are a good fit before you invest a lot of time and energy into the system.
4242

4343
#### Email
44-
Your Essential Bank's email address. This is shown to the partners on their help page, and is included in reminder emails, so please use an email that is monitored. This email is also included on distribution and donation printouts.
44+
Your Essential Bank's email address. This is shown to the partners on their help page, and is included in reminder emails, so please use an email that is monitored. This email is also included on Distribution and Donation printouts.
4545

4646
#### Address
47-
Your Essential Bank's primary address. This is shown on the distribution and donation printouts.
47+
Your Essential Bank's primary address. This is shown on the distribution and Donation printouts.
4848

4949
------------
5050
## Reminder Emails (optional)
@@ -57,7 +57,7 @@ The text of this email will be:
5757
Hello [Partner's name],
5858

5959
This is a friendly reminder that [Your bank's name] requires your human essentials requests to be submitted by [the deadline date, including month and year]
60-
if you would like to receive a distribution next month.
60+
if you would like to receive a Distribution next month.
6161

6262
Please log into Human Essentials at https://humanessentials.app before this date and submit your request if you are intending to submit an essentials request.
6363

@@ -69,19 +69,19 @@ if you have any questions about this!
6969

7070

7171

72-
#### Reminder day (Day of month an e-mail reminder is sent to partners to submit requests)
72+
#### Reminder day (Day of month an e-mail reminder is sent to partners to submit Requests)
7373
At this point, we send those emails once a month on the day of the month you indicate here.
7474
If you do not pick a day, no reminder emails are sent.
7575

76-
#### Deadline day (Final day of the month to submit requests)
76+
#### Deadline day (Final day of the month to submit Requests)
7777
This day will be included in the reminder email message,
7878

7979
----------
8080

8181
#### Default Intake Location
8282

83-
This is the default storage location for donations and purchases.
84-
If you specify this, it will be pre-populated as the storage location when you are adding new donations or purchases.
83+
This is the default storage location for Donations and Purchases.
84+
If you specify this, it will be pre-populated as the storage location when you are adding new Donations or Purchases.
8585

8686
#### Partner Profile Sections
8787
The [Partner Profile](pm_partner_profiles.md) is a very large form that includes a lot of information. You might not care about all of it.
@@ -102,10 +102,10 @@ The sections are:
102102

103103
The bank-wide default Storage Location for Donations and Purchases.
104104
You can also specify a different default Storage Location on any Partner, which will override this default.
105-
If you specify a default Storage Location, it will be pre-populated as the Storage Location when you are adding new distributions.
105+
If you specify a default Storage Location, it will be pre-populated as the Storage Location when you are adding new Distributions.
106106

107-
#### Custom Partner Invitation Message
108-
[TODO: Ensure that this is working!] [TODO: Get it fixed! Because it is not!]
107+
#### Custom Partner Invitation Message
108+
[!NOTE] The Custom Partner Invitation Message is currenty not working as advertised (as of November 13, 2024.). The current behavior is as if you did not enter anything here. We have fixing it on our "to do" list.
109109

110110
When you invite a Partner, they get an email. This field lets you specify the message you are sending to them. Just text -- we don't have any personalization capability for this email at this time.
111111

@@ -115,7 +115,7 @@ Hello [Partner's email]
115115

116116
You've been invited to become a partner with Pawnee Diaper Bank!
117117

118-
Please click the link below to accept your invitation and create an account and you'll be able to begin requesting distributions.
118+
Please click the link below to accept your invitation and create an account and you'll be able to begin requesting Distributions.
119119

120120
Please contact [Bank's email] if you are encountering any issues.
121121

@@ -144,49 +144,72 @@ This is a special topic that has its own guide page [here](special_custom_units.
144144

145145
----------
146146

147-
## Controlling what kind of Request a Partner can make
147+
## Controlling what kind of Requests a Partner can make
148148

149-
There are three different ways a Partner can request essentials -- a "Child based" Request, a Request by number of individuals, and a quantity-based Request. Some banks want to limit which requests the partners can make, in order to minimize partner confusion.
150-
These three fields allow you to control which requests the Partners can use.
149+
There are three different ways a Partner can request essentials -- a "Child based" Request, a Request by number of individuals, and a quantity-based Request. Some banks want to limit which Requests the partners can make, in order to minimize partner confusion.
150+
These three fields allow you to control which Requests the Partners can use.
151151
If you allow more than one kind, the Partner can also limit their own.
152-
Note that if any Partner limits themselves to a single type, you won't be able to remove that type. So, if you think you only want to allow quantity-based requests, doing that up front is a fine idea.
152+
Note that if any Partner limits themselves to a single type, you won't be able to remove that type. So, if you think you only want to allow quantity-based Requests, doing that up front is a fine idea.
153153

154-
#### Enable partners to make child-based requests
155-
#### Enable partners to make requests for individuals?
156-
#### Enable partners to make quantity-based requests?
154+
#### Enable partners to make child-based Requests
155+
#### Enable partners to make Requests for individuals?
156+
#### Enable partners to make quantity-based Requests?
157157

158158
----------
159159

160-
## Customizing the distribution printout
161-
There are four fields that allow you to tweak the appearance of the distribution printout
160+
## Customizing the Distribution printout
161+
There are four fields that allow you to tweak the appearance of the Distribution printout
162162

163-
164-
### Show Year-to-date values on the distribution printout?
163+
### Show Year-to-date values on the Distribution printout?
165164
Some banks don't want to show year-to-date values on the receipt (1, below) because their fiscal year is not the calendar year.
166-
### Include Signature Lines on Distribution Printout
167-
If "yes", this will include a space for someone from the bank and from the Partner to sign the distribution printout (2, below) - which can be useful as a receipt acknowledgement.
165+
### Include Signature Lines on Distribution printout
166+
If "yes", this will include a space for someone from the bank and from the Partner to sign the Distribution printout (2, below) - which can be useful as a receipt acknowledgement.
168167
### Hide both value columns
169-
The default is to show the in-kind value of the items on the receipt (3, below). Many banks don't need to show this information on the distribution printout.
170-
Note: Hiding this also hides the corresponding values on the single donation printout.
171-
### Hide the package column on distribution receipts?
172-
This hides the packages column on the distribution printout (4, below). Because different brands of essentials use different size packages, this
173-
column is useful mainly for banks that repackage their essentials into uniform package sizes. If you have a uniform package size, you can specify that on the item (see [Inventory Items](inventory_items.md))
168+
The default is to show the in-kind value of the Items on the receipt (3, below). Many banks don't need to show this information on the Distribution printout.
169+
Note: Hiding this also hides the corresponding values on the single Donation printout.
170+
### Hide the package column on Distribution receipts?
171+
This hides the packages column on the Distribution printout (4, below). Because different brands of essentials use different size packages, this
172+
column is useful mainly for banks that repackage their essentials into uniform package sizes. If you have a uniform package size, you can specify that on the Item (see [Inventory Items](inventory_items.md))
174173

175-
![distribution printout marked up with customizable sections](images/getting_started/customization/gs_customization_distribution_printout_customizable_sections.png)
174+
![Distribution printout marked up with customizable sections](images/getting_started/customization/gs_customization_distribution_printout_customizable_sections.png)
176175

177176
--------
178177

179178
#### Use One Step Invite and Approve partner process?
180-
Partners can't submit requests until they are approved by the bank.
179+
Partners can't submit Requests until they are approved by the bank.
181180
The full partner approval process requires the partner to fill in their profile and submit it for approval. Some banks handle that for their partners, gather the information through other means (such as a phone conversation).
182181
Checking this will change the process so that the partners are automatically approved when they are invited. Note that any invited partners that are not yet approved will still need to be approved by the bank.
183182

184183
#### Distribution Email Content
185-
Note that there is a checkbox on the partner for them to receive distribution emails. We recommend you do customize this content, as the default text is abrupt.
186-
You can customize this quite a bit! [TODO: expand. Maybe provide a real life example.]
184+
Note that there is a checkbox on the partner for them to receive Distribution emails. We recommend you do customize this content, as the default text is abrupt.
185+
You can customize this quite a bit!
186+
187+
Specifically, you can use the variables %{partner_name}, %{delivery_method}, %{distribution_date}, and %{comment} to include the partner's name, delivery method, distribution date, and comments sent in the email. You can also format the text, and attach files by using the buttons above the field.
188+
189+
Here's a real-life example (except for the URL)
190+
191+
------
192+
193+
%{partner_name},
194+
195+
Your essentials request has been approved and you can find attached to this email a copy of the distribution you will be receiving.
196+
197+
Your distribution has been set to be %{delivery_method} on %{distribution_date}.
198+
199+
Friendly reminder: don't forget to keep up with important updates at https://example.com. Subscribe there to get email notifications when updates are posted!
200+
201+
See you soon!
202+
203+
%{comment}
204+
205+
-----
206+
207+
208+
209+
187210

188211
#### Logo
189212

190-
The logo that you upload here will appear several places throughout the system, including on your distribution and donation printouts. Larger logos will impact your performance -- the 763 x 188 size is a good guideline.
213+
The logo that you upload here will appear several places throughout the system, including on your Distribution and Donation printouts. Larger logos will impact your performance -- the 763 x 188 size is a good guideline.
191214

192215
[Prior: Inventory](getting_started_inventory.md) [Next: Adding your Staff - levels of access](getting_started_access_levels.md)

0 commit comments

Comments
 (0)