diff --git a/Gemfile.lock b/Gemfile.lock index c8a029d17d..3d2da2e2a4 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -801,4 +801,4 @@ DEPENDENCIES webmock (~> 3.23) BUNDLED WITH - 2.5.16 + 2.5.19 diff --git a/docs/user_guide/bank/getting_started_choices.md b/docs/user_guide/bank/getting_started_choices.md new file mode 100644 index 0000000000..3f1d8107c3 --- /dev/null +++ b/docs/user_guide/bank/getting_started_choices.md @@ -0,0 +1,21 @@ +DRAFT USER GUIDE + +This page is a work in progress until we are all done. + +# Some up front things to think about + +Human Essentials is designed to help you manage your inventory and your relationship with partners, while also providing at least some information to help with your grant writing. + +Some questions that will help you when you are setting up Human Essentials. This is not a complete list. + +- Do you (your bank) want to start out immediately with my partners making requests, or do you want to just track our distributions for awhile first? +- Do you run on a monthly cycle, or more on an adhoc basis? +- What information do you need from our partners (see [Partner Profile](pm_partner_profiles.md) for what you *can* collect in the system - this is somewhat configurable)? +- Do you need to get all that information from your partners before they can enter requests? +- Do you have different groups of partners allowed to request different items? (if so, you'll want to look at [Partner Groups](pm_)) +- Who should have admin access? (See [Access Levels](getting_started_access_levels.md)) +- Do you repackage items into 'kits'? (common for period-focused banks) +- How do you want your partners requesting from you? (By # of individuals for each item, by quantity of each item, or by specific child (we don't recommend that unless they really have the need.) This is covered more in ["The Request Distribution Cycle"](pm_request_distribution_cycle.md)) +- If quantity, do you want to have our partners request in # of items, or in some other units (for instance packs, for diapers ) + +[TODO: This is a work in progress until we have completed everything else.] \ No newline at end of file diff --git a/docs/user_guide/bank/images/partners/partners_announcements_1.png b/docs/user_guide/bank/images/partners/partners_announcements_1.png new file mode 100644 index 0000000000..6ba970ddee Binary files /dev/null and b/docs/user_guide/bank/images/partners/partners_announcements_1.png differ diff --git a/docs/user_guide/bank/images/partners/partners_announcements_2.png b/docs/user_guide/bank/images/partners/partners_announcements_2.png new file mode 100644 index 0000000000..cffa85af84 Binary files /dev/null and b/docs/user_guide/bank/images/partners/partners_announcements_2.png differ diff --git a/docs/user_guide/bank/images/partners/partners_groups_1.png b/docs/user_guide/bank/images/partners/partners_groups_1.png new file mode 100644 index 0000000000..4192424224 Binary files /dev/null and b/docs/user_guide/bank/images/partners/partners_groups_1.png differ diff --git a/docs/user_guide/bank/images/partners/partners_groups_2.png b/docs/user_guide/bank/images/partners/partners_groups_2.png new file mode 100644 index 0000000000..9ace79c32d Binary files /dev/null and b/docs/user_guide/bank/images/partners/partners_groups_2.png differ diff --git a/docs/user_guide/bank/images/partners/partners_importing_1.png b/docs/user_guide/bank/images/partners/partners_importing_1.png new file mode 100644 index 0000000000..836b8cc912 Binary files /dev/null and b/docs/user_guide/bank/images/partners/partners_importing_1.png differ diff --git a/docs/user_guide/bank/images/partners/partners_importing_2.png b/docs/user_guide/bank/images/partners/partners_importing_2.png new file mode 100644 index 0000000000..86c99d66fe Binary files /dev/null and b/docs/user_guide/bank/images/partners/partners_importing_2.png differ diff --git a/docs/user_guide/bank/pm_adding_a_partner.md b/docs/user_guide/bank/pm_adding_a_partner.md index 569b4b5aff..5c8afddc99 100644 --- a/docs/user_guide/bank/pm_adding_a_partner.md +++ b/docs/user_guide/bank/pm_adding_a_partner.md @@ -1,2 +1,7 @@ # Adding a single partner To add a single partner, you can either Click on the "Add a Partner" button in the "Getting Started" section of your dashboard (if you are, indeed, just getting started), or click "Partner Agencies" in the left-hand menu, then "All Partners", then "New Partner Agency". +[TODO: Needs screenshots of navigation] + +This just sets up the partner in your bank so you can distribute to them. If you want them to be able to make requests, you'll need to [invite](pm_inviting_a_partner.md) them. + +[Prior - Importing Partners](pm_importing_partners.md) [Next - Partner Groups](pm_partner_groups.md) \ No newline at end of file diff --git a/docs/user_guide/bank/pm_announcements.md b/docs/user_guide/bank/pm_announcements.md index 7c00a56292..f9eb061b1f 100644 --- a/docs/user_guide/bank/pm_announcements.md +++ b/docs/user_guide/bank/pm_announcements.md @@ -1 +1,33 @@ -Not yet written \ No newline at end of file +DRAFT USER GUIDE + +# Partner announcements + +Partner announcements are a great way to let your partners know about temporary situations -- like when you need to put some limits on what you can give out of a particular size. Some banks also use them to point to other resources. +These announcements appear on the partner's dashboard, so they'll be there whenever the partner logs in. + +## How to create an announcement + +Click on "Partner Agencies" in the left hand menu, then "Partner Announcement". This will bring up a list of all your partner announcements. + +![all announcments screen](images/partners/partners_announcements_1.png) + +Click the "New Announcements" button to bring up a form for a new announcement + +[TODO: Also check that the "SEnt by" actually has meaning. As org_admin1, it just says "N/A".] +![new announcement screen](images/partners/partners_announcements_2.png) + +Here you can fill in +- Up to 500 characters for your announcement. +- a URL for more information (useful for pointing to resources on your site) +- an expiry date. This is optional - you can leave announcements up 'forever' if you want. The expiry date is the last day the announcement will be shown [TODO: confirm that it's not the first day it's *not* shown.] + +Then, as soon as you click "Broadcast announcement", the partners will see it when they log in. + +## Changing an announcment +Simply click "edit" in the actions column beside the announcement you want to change, make your changes, and click "Broadcast announcement" + +## Deleting an announcement +You may want to clear out your older announcements. You can click "delete" beside any announcement to remove it from your view. It also will be deleted from the partner's view, if it was not yet expired. + + +[Prior: Other partner information](pm_other_information.md) [Next: Inventory -- Items](inventory_items.md) diff --git a/docs/user_guide/bank/pm_approving_a_partner.md b/docs/user_guide/bank/pm_approving_a_partner.md index 7c00a56292..40f7667f1f 100644 --- a/docs/user_guide/bank/pm_approving_a_partner.md +++ b/docs/user_guide/bank/pm_approving_a_partner.md @@ -1 +1,36 @@ -Not yet written \ No newline at end of file +DRAFT USER GUIDE + + +[TODO: Upcoming change review -- terminology. I feel like these are going to be done before the first pass is through so I'm leaving the screenshots out for the nonce.] + +# Approving partners + +There are three paths in to reviewing a partner's information before approving them to make requests -- + +1/ There is a list of partners awaiting approvals on the dashboard. To start the approval process, click "Review Application"; + +[TODO: Screenshot] + +2/ Click "Partner Agencies" and "All Partners" in the left-hand menu, then "Review Application" beside the partner. + +[TODO: Screenshot] + +or +3/ Click "Partner Agencies" and "All Partners" in the left-hand menu, then click the partner name. Scroll down to see the partner profile information, which starts just below the "Approve Partner" button + +[TODO: Screenshot] + +---------------------------------- + +In any of these cases, you can view all the answers in the profile. If something needs changing, you can do it yourself by clicking the "Edit Information" button, or the partner can make the change. + +See [Partner profiles](partner_profiles.md) for details on the partner profile. +[TODO: Link should go to the part of partner profiles that lists all the fields] + +Once you have reviewed the partner's info, and want to approve them to make requests, click the "Approve Partner " button. +[TODO: Screenshot] + +You should see a "Partner Approved!" message, and the status of the partner will show as "Approved" +[TODO: Screenshot] + +[Prior - Partner Profiles](pm_partner_profiles.md) [Next - Requesting Recertification](pm_requesting_recertification.md) diff --git a/docs/user_guide/bank/pm_editing_a_partner.md b/docs/user_guide/bank/pm_editing_a_partner.md new file mode 100644 index 0000000000..53f0a37cac --- /dev/null +++ b/docs/user_guide/bank/pm_editing_a_partner.md @@ -0,0 +1,19 @@ +DRAFT USER GUIDE + +# Editing a partner + +Note - this is editing a partner's basic information, not their [profile](pm_partner_profiles.md) + +You can edit a partner's basic information by clicking [Partner Agencies] in the left-hand menu, then [All Partners], then click on the partner you want to work with. + +That will bring up this screen: + +[TODO: Screenshot] + +Click "Edit Partner Information" to bring up this screen: + +[TODO: Screenshot] + +Make your changes, and click "Update Partner" to save. + +[Prior: Partner Groups](pm_partner_groups.md)[Next: Inviting a partner](pm_inviting_a_partner.md) diff --git a/docs/user_guide/bank/pm_importing_partners.md b/docs/user_guide/bank/pm_importing_partners.md index 7c00a56292..f44ddaa43d 100644 --- a/docs/user_guide/bank/pm_importing_partners.md +++ b/docs/user_guide/bank/pm_importing_partners.md @@ -1 +1,25 @@ -Not yet written \ No newline at end of file +DRAFT USER GUIDE +# Importing partners + +**N.B.** We've set up importing partners as a process you can only run once to prevent accidental imports and writing over existing partners. + +To import partners, you will need a .csv file containing their information -- this will just be the partner business name and primary contact email. + +We do provide an example file -- to get it, click on "Partner Agencies", "All Partners", then "Import Partners". (If you are a brand-new bank you might have gotten here through the "Getting Started" instructions on the dashboard.) +![Navigation to import](images/partners/partners_importing_1.png) +You will see a pop-up with a "Download example CSV" button (A) on it. Clicking that will download an example file for partner uploads. +![Partners import popup screen with instructions and buttons for downloading example, choosing import file, and importing the CSV](images/partners/partners_importing_2.png) + +That file is named partners_template.csv, and you should be able to find it in your downloads directory. + +You can edit this in your favourite spreadsheet program, or just as a text file. + + +When you have the information completed, navigate back to that same pop-up ( click on "Partner Agencies", "All Partners", then "Import Partners" ) +Now, follow the instructions under "2. Upload your CSV file " -- click "Choose File" (B), and pick the .csv file you've edited. The file name will appear after the "Choose File" button. Then, click "Import CSV". + +If you see "Partners were imported successfully!", that's good! You should review the list of partners on that page to make sure that all of the partners were imported -- if there was a badly formatted email, that partner will not appear. +If you should get a "500" error, it most likely means that your file is not formatted properly. + +[Prior - The request/distribution cycle](pm_request_distribution_cycle.md) +[Next - Adding a partner](pm_adding_a_partner.md) \ No newline at end of file diff --git a/docs/user_guide/bank/pm_inviting_a_partner.md b/docs/user_guide/bank/pm_inviting_a_partner.md index 7c00a56292..9b6f2feee3 100644 --- a/docs/user_guide/bank/pm_inviting_a_partner.md +++ b/docs/user_guide/bank/pm_inviting_a_partner.md @@ -1 +1,59 @@ -Not yet written \ No newline at end of file +Draft User Guide +# Inviting a partner + +Before a partner can make requests, they have to be invited and approved. + +When they are invited, they will receive an email with a link so that they can set up their password. +These links expire[TODO: How long?], but if they don't respond in time, +you can direct them to use the "Forgot your password?" function on the sign-in page +(https://humanessentials.app/signin) to get a new link to set their password. + +## Invite or Invite-and-Approve? +There are two options for enabling partners to request. + +The first, default, option is: + +1/ You invite the partner. + +2/ They click on the link and set up their password. + +3/ They then sign in and go into their "My Organization", update the profile information you need (se [profile](pm_partner_profiles.md). + +4/ They submit it for your approval + +5/ You approve it (there may be some back and forth here!) + +6/ They can now make requests. + +If you choose "Use One step Partner invite and approve process?" in ["My Organization"](getting_started_customization.md), +then the sequence is: + +1/ You invite and approve the partner. + +2/ They click on the link and set up their password. + +3/ They can now make requests. + +The *disadvantage* to the second method is that it may be harder to extract any +information you do need from your partners which can impact your grant-writing and +your annual reports. + +# How to invite a partner + +1/ Click on "Partner Agencies" in the left hand menu, then "All Partners" +2/ Find the partner you wish to invite. +3/ Click on the "Invite and Approve" button for that partner. + +[TODO: Add screenshot] + +# How to invite and approve a partner +First, make sure that you have "Use one-step partner invate and approve process" chosen in ["My Organization"](getting_started_customization.md). +Then... + +1/ Click on "Partner Agencies" in the left hand menu, then "All Partners" +2/ Find the partner you wish to invite. +3/ Click on the "Invite and Approve" button for that partner. + +[TODO: Add screenshot] + +[Prior: Partner Groups ](pm_partner_groups.md) [ Next: Partner Profiles](pm_partner_profiles.md) diff --git a/docs/user_guide/bank/pm_making_a_partner_inactive.md b/docs/user_guide/bank/pm_making_a_partner_inactive.md index 7c00a56292..000e7b3847 100644 --- a/docs/user_guide/bank/pm_making_a_partner_inactive.md +++ b/docs/user_guide/bank/pm_making_a_partner_inactive.md @@ -1 +1,35 @@ -Not yet written \ No newline at end of file +DRAFT USER GUIDE + +# Making a partner inactive + +Unfortunately, sometimes a partner will cease operations. Should that occur, you can make them inactive. This does not remove their historical information, but they won't appear in your selections, or in the all partners list (unless you specifically choose "Deactivated") + +To deactivate a partner: + +Go to the All Partners list (click on "Partner Agencies", then "All Partners" in the left hand menu),then click on the partner name to bring up that partner's screen. + +[TODO: Screenshot] + +Then click on "Deactivate Partner". A confirmation screen will appear. Click "OK". + +[TODO: Screenshot] + +You'll see a message that the partner is successfully deactivated, and they will not appear in the all partners list. + +## But what if I need to see them? + +If you need to see their information, go to the all partners list, and click on the "Deactivated" link. +This will bring up a list of all the deactivated partners. You can then click on them to view their information. + +[TODO: screenshot] + +## Can I reactivate them? + +Yes. Bring up the list of deactivated partners, then click on the "Reactivate" button beside the partner. Click "Ok" on the confirmation window that pops up. + + +[TODO: screenshot] + +This will bring them up in the same status as they were when you deactivated them. + +[Prior: Requesting recertification](pm_requesting_recertification.md) [Next: reactivating a partner](pm_partner_reactivation.md) diff --git a/docs/user_guide/bank/pm_other_information.md b/docs/user_guide/bank/pm_other_information.md new file mode 100644 index 0000000000..1cfb695e12 --- /dev/null +++ b/docs/user_guide/bank/pm_other_information.md @@ -0,0 +1,14 @@ +DRAFT USER GUIDE + +There are a few other things with partners that didn't fit into any of the sections above: + +1/ You can see the families served, children served and zipcodes served +How do we get these numbers? +[TODO: confirm how we determine families, children, zipcode in this case] +- Families served -- if the partner is using child requests, this is a count of the families they have entered. +- Children served -- if the partner is using child requests, this is a count of active children (confirm), +- Zipcodes - these are directly from the zipcodes entered in the partner profiles +- [TODO: Should we also show counties served?] +2/ You can see the prior distributions for this partner, at the bottom of the view of the partner. + +[Prior: Administering partner users](pm_partner_user_admin.md)[Next: Partner announcements](pm_announcements.md) diff --git a/docs/user_guide/bank/pm_partner_groups.md b/docs/user_guide/bank/pm_partner_groups.md new file mode 100644 index 0000000000..d7d977f6d3 --- /dev/null +++ b/docs/user_guide/bank/pm_partner_groups.md @@ -0,0 +1,42 @@ +DRAFT USER GUIDE +# Partner Groups + +You may have reasons that some partners are treated differently than others. Reasons we've seen for this include: +- Some banks have 'tiers' of partners, where some partners have different rules about what and when they can request. +- Some banks have grants that are tied to specific geographic areas, and set up specific items for those grants (that only partners in those geographic areas can request) + +Partner groups allow you to manage that. They allow you to set the item categories (see [Item Categories](inventory_items.md)) that a group can request +[TODO: Point at the precise place in Inventory Items that that is at.] + +If you are going to use partner groups, you should +1/ Set up your item categories +2/ Assign items to them +3/ Set up the groups, +4/ Then assign a group to the partners on an individual basis -- so you may want to set up your groups before adding your partners. + +# Adding a partner group +In the left-hand menu, click on "Partner Agencies", then "All Partners". The Partner Agencies list will appear. There are two tabs in this list "Partners" and "Groups". Click on "Groups". +Then click on "New Partner Group" +![Navigation for adding a partner group](images/partners/partners_groups_1.png) +This will bring up a form like this (the categories will be different): +![New partner group form](images/partners/partners_groups_2.png) +## Fields in the partner group form +### Name +This is the name your bank will use to refer to the partner group. It is not visible to the partners, and is not used in any reports. It does have to be unique among your partner groups. +### Which Item Categories Can They Request? +This lists the item categories you entered (in (see [Item Categories](inventory_items.md))) + +The partners who are in this group will only be able to request the items in the categories you check here. Note that they will not be able +they will not be able to request any items that are not in a category + +For clarity - if you do not choose any categories, they will not be able to choose any items, so if you are using partner groups, you have to use item categories. + +### Do you want to send deadline reminders to them every month? +This works in conjunction with "Reminder day" and "Deadline day", which is set on an organization level (see [Getting Started - Customization](getting_started_customization.md)) + +# What if a partner isn't in a group? +If a partner is not in a group, they can request any item that is visible to partners. +If a partner is not in a group, they will receive reminder emails, if they have been set up on an organization level [TODO: double-check the code for that] + +[Prior - Adding a partner](pm_adding_a_partner.md) +[Next - Inviting a partner](pm_inviting_a_partner.md) \ No newline at end of file diff --git a/docs/user_guide/bank/pm_partner_profiles.md b/docs/user_guide/bank/pm_partner_profiles.md index 7c00a56292..489ccefcb4 100644 --- a/docs/user_guide/bank/pm_partner_profiles.md +++ b/docs/user_guide/bank/pm_partner_profiles.md @@ -1 +1,170 @@ -Not yet written \ No newline at end of file +DRAFT USER GUIDE + +[TODO: Screenshots throughout. Waiting for Partner Profiles rework.] + +# Partner Profiles + +Partner profiles allow you to gather and hold a lot of information about your partners that may be useful for meeting your regulatory requirements, managing their experience, and for grant-writing. + +There is a *lot* of information in the profile, and the information that is needed varies from bank to bank. Once you decide what information you need from your partners, you can set up the partner profiles to show the sections that you need, customizing it through ["My organization"](getting_started_customization.md). + +## How does a partner fill in and submit their profile + +In the partner's view of the system, they can click on "Edit My Profile" to fill in all the information you want. +Once they have save this, they will also see a "Submit for Approval" button. Clicking that changes their status to "Waiting for Approval", and makes them appear in your [dashboard](essentials_dashboard.md) list of partners waiting for approval, as well as making a "Review partner's application" button appear beside them in your view of all the partners. + +# Viewing a partner's profile +The partner's profile is viewable by clicking Partner Agencies in the left hand menu, then All Partners, then "view" beside the partner in question. Scroll down to "Partner Profile" +# Editing a partner's profile +You can edit a partner's profile clicking Partner Agencies in the left hand menu, then All Partners, then "view" beside the partner in question. Scroll down to "Partner Profile", then click "Edit Information." + +# The sections +The high level sections of the partner profile are: +- Agency Information (not configurable) +- Program / Delivery Address (if different) +- Media Information +- Agency Stability +- Organization Capacity +- Sources of Funding +- Area Served (County/Client Share %) +- Population Served +- Executive Director +- Primary Contact +- Pick up Person +- Race/Ethnicity of Client Base +- Agency Distribution Information +- Additional Documents +- Settings (not configurable) + +## Agency Information (not configurable) +This section contains basic agency information that most, if not all, partners will need to provide: +- Agency Name +- Agency Type +- Other Agency Type (i.e, details if "other" is chosen in Agency Type) +- 501(c)(3) IRS Determination Letter -- this is a file to upload said letter. +- Agency Mission +- Address +- City +- State +- Zip Code + +## Program / Delivery Address (if different) +Sometimes, a large agency may have a separate address for a specific program or for deliveries/shipping. +- Address +- City +- State +- Zip Code + +## Media Information +This provides a place for the agency to indicate their major communication outlets. + +*If* the bank chooses to ask for this information, the partner must fill in at least one of the fields: + +- Website +- Facebook +- Twitter (yes, we know it's called X now) +- Instagram +- No Social Media Presence + + + +## Agency Stability +This section is about the maturity of the agency. + +None of these fields are mandatory. + +- Year founded +- Form 990 +- Program Name(s) +- Program Description(s) +- Agency Age +- Evidence Based? +- Case Management +- How Are Essentials (e.g. diapers, period supplies) Used in Your Program? +- Do You Receive Essentials From Other Sources? +- Currently Providing Diapers? + +## Organization Capacity +This section has specific questions about the volume of the agency's needs. +- Client Capacity +- Storage Space (yes/no) +- Storage Space Description + +## Sources of Funding +How does the agency get its funding? +- Sources of Funding +- How do you currently obtain diapers? +- Essentials Budget +- Essentials Funding Source + +## Area Served (County/Client Share %) +This asks what county/county equivalents the agency serves and what proportion of their client share is in which area. + +At this time, this only covers U.S. counties. We believe the list covers *all* of the U.S, including some areas that are not counties. +Let us know if you need more! + +The sum of the client share has to be either 0 or 100, and the numbers have to be positive whole numbers. + +You start out with 1 county, but can add more with the "Add Another County button" + +## Population Served +This section has only two questions: +- Clients Have An Income Requirement to Work With You? +- Do You Verify The Income Of Your Clients? +- +## Race/Ethnicity of Client Base +This section is comprised of questions about the race/ethnicity of the client base and the poverty level of the client base. +There is no check on whether the numbers add up to 100 -- because there may be overlap. + +### Race/Ethnicity: +- % African American; % Caucasian; % Hispanic; % Asian; % American Indian; % Pacific Island; % Multi-racial; % Other +- Zip Codes Served + +### Poverty Information of those Served: +- % at FPL or Below (FPL is Federal Poverty Line) +- % above 1-2 times FPL +- % Greater than 2 times FPL +- % Poverty Unknown + +## Executive Director +Contact information for the head of the agency: +- Executive Director Name +- Executive Director Phone +- Executive Director Email +[TODO: Check if this is ever used for outgoing email] +## Primary Contact +Contact information for your bank's primary contact +- Primary Contact Name +- Primary Contact Phone +- Primary Contact Cell +- Primary Contact Email +[TODO: Check if 1/ Primary Contact email is defaulted on partner creation, and 2/ confirm that this is used for outgoing emails. Also what about multiple emails -- we need to either restrict to a single, or do the same thing as with the pickup person about them.] + +## Pick Up Person +The Pick Up person will receive an email when the distribution is scheduled. +[TODO: Check -- is it only on pickups, or do they get it for deliveries too?] + +- Pick Up Person Name +- Pick Up Person's Phone # +- Pick Up Person's Email +Note this can be multiple, comma-separated emails. + +## Agency Distribution Information +This section is about the agency's practices when distributing to their clients. +- Distribution Times +- New Client Times +- More Docs Required + - This is meant to be the documentation required for new clients + +## Additional Documents +This is a place to upload additional documents that you need from your partner. + +## Settings (not configurable) +Many banks restrict the partners to one kind of request (see [Customization](getting_started_customization.md)). If you don't, the partner can still simplify their request experience by unclicking the items that don't apply. +Only the options that you haven't already turned off will show up here, and at least one has to be checked. +- Enable Quantity-based Requests +- Enable Child-based Requests +- Enable Requests for Individuals + + +[Prior: inviting a partner](pm_inviting_a_partner.md) [Next: Approving a partner](pm_approving_a_partner.md) \ No newline at end of file diff --git a/docs/user_guide/bank/pm_partner_reactivation.md b/docs/user_guide/bank/pm_partner_reactivation.md new file mode 100644 index 0000000000..a1f3de7bd2 --- /dev/null +++ b/docs/user_guide/bank/pm_partner_reactivation.md @@ -0,0 +1,18 @@ +DRAFT USER GUIDE + +# Partner reactivation + +To reactivate a partner: + +Go to the all partners list, and click on the "Deactivated" link. +This will bring up a list of all the deactivated partners. You can then click on them to view their information. + +Then click on the "Reactivate" button beside the partner. Click "Ok" on the confirmation window that pops up. + + +[TODO: screenshot] + +This will bring them up in the same status as they were when you deactivated them. + + +[Prior: Making a partner inactive](pm_making_a_partner_inactive.md) [Next: administering partner users](pm_partner_user_admin.md) diff --git a/docs/user_guide/bank/pm_partner_user_admin.md b/docs/user_guide/bank/pm_partner_user_admin.md index 7c00a56292..f0a0dea0a0 100644 --- a/docs/user_guide/bank/pm_partner_user_admin.md +++ b/docs/user_guide/bank/pm_partner_user_admin.md @@ -1 +1,18 @@ -Not yet written \ No newline at end of file +DRAFT USER GUIDE + +# Administering partner users + +Partners can add users themselves, but occasionally a bank may need to step in and administer partner users (for instance, if the only person who uses the system leaves the partner.) + +## Where do you administer partner users? + +If you need to administer a partner's users, click on "Partner Agencies" in the left-hand menu, then "All Partners", +then click on the specific partner you want to administer, and then "Manage Users" near the top of that screen. + +[TODO: Navigation screenshots] + +This will bring you to a list of users for that partner. Here you can resend invitations (A), start a reset password process (B) (they will receive an email with a link to reset their password), Remove access to that partner from the user(C), or invite a new user to that partner (D). + +[TODO: Annotated screenshot for partner user admin screen] + +[Prior - Partner reactivation](pm_partner_reactivation.md) [Next: Other partner information](pm_other_information.md) \ No newline at end of file diff --git a/docs/user_guide/bank/pm_request_distribution_cycle.md b/docs/user_guide/bank/pm_request_distribution_cycle.md index 7c00a56292..a4c33f7e96 100644 --- a/docs/user_guide/bank/pm_request_distribution_cycle.md +++ b/docs/user_guide/bank/pm_request_distribution_cycle.md @@ -1 +1,36 @@ -Not yet written \ No newline at end of file +DRAFT USER GUIDE +# The Request/Distribution Cycle + +You can distribute materials to your partners as soon as you have them entered into the system. However, many banks find it useful to allow their partners to request products through the system. + +To allow partners to make requests, you will have to [invite](pm_inviting_a_partner.md) them, and [approve](pm_approving_a_partner.md) them, based on a [profile](pm_partner_profiles.md) they fill out and submit. There is a shortcut to do both at once. + +For clarity - you can make distributions without requests. + +So, how does this work? + +1/ The partner fills in a request form on the system and saves it. + +2/ They get an email confirming that the request has been sent to you. + +3/ This requests appears in the system in the following places: a) your [dashbboard](essentials_dashboard.md), under "Outstanding Requests", and in the [Requests](essentials_requests.md) view. + +4/ You view the request, and click "Fulfill request" (you so have the option of cancelling it) + +5/ That marks the request as "started" -- so other staff don't grab the same request to start working on it, and brings up a new [Distribution] for the partner, with the information we can pre-fill, pre-filled. + +6/ You fill in the rest of the information, and make any adjustments required. + +7/ Clicking "Save" creates the distribution in the system, adjusting the inventory, and sends an email to the partner with the details attached. They can also see the distribution in their "Upcoming Distributions" list. + +8/ You set aside the products for pick-up / deliver them / ship them + +9/ You can mark the distribution as complete. + +Please note that you can edit distributions (e.g. if you have more product come in before pickup). The partner does not get a new email if you do that.[TODO: Confirm] + + +[Prior: Pick ups and deliveries](essentials_pick_ups.md) [Next: importing partners](pm_importing_partners.md) + + + diff --git a/docs/user_guide/bank/pm_requesting_recertification.md b/docs/user_guide/bank/pm_requesting_recertification.md index 7c00a56292..13c6f38c9e 100644 --- a/docs/user_guide/bank/pm_requesting_recertification.md +++ b/docs/user_guide/bank/pm_requesting_recertification.md @@ -1 +1,23 @@ -Not yet written \ No newline at end of file +DRAFT USER GUIDE + +# Requesting Recertification + +From time to time, perhaps annually, you may want to confirm that the information your partner has provided is correct. That is what "request recertification" is for. + + +#### *** N.B. Once you request recertification, the partner will not be able to enter requests until you have approved them again!! *** + +If you request recertification from a partner, they will receive an email requesting that they update their information +[TODO: provide text of email], and their status will change to "Recertification required". + +To request recertification, go to the All Partners screen (click on "Partner Agencies", then "All Partners" in the left hand menu), then click the red "Request Recertification" button beside the partner. A confirmation window will pop up - check that you picked the right partner, and click "OK". + +[TODO: provide screenshot -- that screen is likely to change before the end of writing.] + +This will change the status of the partner to "Recertification required". + +Once they have made their changes, you can [approve](pm_approving_a_partner.md) them again, which will restore their ability to make requests. + +(Note: They have a "Submit for Approval" button, which would change their status to "Waiting for Approval", and make them appear in your dashboard, but you can bypass that step) + +[Prior -- Approving a partner](pm_approving_a_partner.md) [Next -- making a partner inactive ](pm_making_a_partner_inactive.md) diff --git a/docs/user_guide/bank/readme.md b/docs/user_guide/bank/readme.md index e6bd8a70a1..e9905ecd44 100644 --- a/docs/user_guide/bank/readme.md +++ b/docs/user_guide/bank/readme.md @@ -6,12 +6,13 @@ This user guide is meant for users of the human essentials app at essentials ban 1. [Is Human Essentials right for you?](intro_i.md) (what we help with and what we don't) 2. [Support](intro_ii.md) 2. Getting started - 1. [Storage Locations](getting_started_storage_locations.md) - 2. [Partner Agencies](getting_started_partners.md) - 3. [Donation sites](getting_started_donation_sites.md) - 4. [Inventory](getting_started_inventory.md) - 5. [Customization and other organization-level info](getting_started_customization.md) - 6. Adding your staff + 1. [Some choices you'll want to think about at the start. ](getting_started_choices.md) + 3. [Storage Locations](getting_started_storage_locations.md) + 3. [Partner Agencies](getting_started_partners.md) + 4. [Donation sites](getting_started_donation_sites.md) + 5. [Inventory](getting_started_inventory.md) + 6. [Customization and other organization-level info](getting_started_customization.md) + 7. Adding your staff 1. [Levels of access](getting_started_access_levels.md) 2. [User management](getting_started_user_management.md) 3. Everyday essentials @@ -23,16 +24,20 @@ This user guide is meant for users of the human essentials app at essentials ban 6. [Pick Ups and Deliveries](essentials_pick_ups.md) 4. Partner Management 1. [The request/distribution cycle](pm_request_distribution_cycle.md) - 2. [Adding a partner](pm_adding_a_partner.md) - 3. [Importing partners](pm_importing_partners.md) - 4. [Administering partner users](pm_partner_user_admin.md) - 4. The partner approval cycle + 2. [Importing partners](pm_importing_partners.md) + 3. [Adding a partner](pm_adding_a_partner.md) + 4. [Partner Groups](pm_partner_groups.md) + 5. [Editing a Partner](pm_editing partners.md) + 5. The partner approval cycle 1. [Inviting a partner](pm_inviting_a_partner.md) 2. [Partner profiles](pm_partner_profiles.md) 3. [Approving a partner](pm_approving_a_partner.md) 4. [Requesting recertification](pm_requesting_recertification.md) - 5. [Making a partner inactive](pm_making_a_partner_inactive.md) - 5. [Announcements](pm_announcements.md) + 6. [Making a partner inactive](pm_making_a_partner_inactive.md) + 7. [Reactivating a partner](pm_parter_reactivation.md) + 7. [Administering partner users](pm_partner_user_admin.md) + 8. [Other partner information](pm_other_information.md) + 9. [Announcements](pm_announcements.md) 5. Inventory 1. [Items](inventory_items.md) 2. [Storage Locations](inventory_storage_locations.md) diff --git a/docs/user_guide/bank/reports_annual_survey.md b/docs/user_guide/bank/reports_annual_survey.md index 71dd6e6b69..f9702437f3 100644 --- a/docs/user_guide/bank/reports_annual_survey.md +++ b/docs/user_guide/bank/reports_annual_survey.md @@ -1,7 +1,7 @@ DRAFT USER GUIDE ## Annual Survey The annual survey contains information useful for completing the NDBN or Alliance for Period Supplies annual survey, but also for grant writing. -Each year's annual survey becomes available January 1 of the following +Each year's annual survey becomes available January 1 of the following year. ## How to get the report diff --git a/docs/user_guide/pm_partner_other.md b/docs/user_guide/pm_partner_other.md new file mode 100644 index 0000000000..e69de29bb2