- <%= @organization.name %> has approved your application.
+ You have been approved to make requests for essentials to <%= @organization.name %>.
<%= link_to "Check out your dashboard", partners_dashboard_url %>
diff --git a/app/views/partner_mailer/application_approved.text.erb b/app/views/partner_mailer/application_approved.text.erb
index 41f5def28e..776fcf75e9 100644
--- a/app/views/partner_mailer/application_approved.text.erb
+++ b/app/views/partner_mailer/application_approved.text.erb
@@ -1,5 +1,5 @@
Hi <%= @partner.name %>
-<%= @organization.name %> has approved your application.
+You have been approved to make requests for essentials to <%= @organization.name %>.
Check out your dashboard: <%= partners_dashboard_url %>
diff --git a/app/views/partners/profiles/_actions.html.erb b/app/views/partners/profiles/_actions.html.erb
new file mode 100644
index 0000000000..05ef380746
--- /dev/null
+++ b/app/views/partners/profiles/_actions.html.erb
@@ -0,0 +1,31 @@
+<%# locals: (partner:) %>
+
+
+
+ <%= pf.input :essentials_use, label: "How Are Essentials (e.g. diapers, period supplies) Used In Your Program?", as: :text, class: "form-control" %>
+
+
+
+ <%= pf.input :receives_essentials_from_other, label: "Do You Receive Essentials From Other Sources?", class: "form-control" %>
+
+<% end %>
diff --git a/app/views/partners/profiles/step/_population_served_form.html.erb b/app/views/partners/profiles/step/_population_served_form.html.erb
new file mode 100644
index 0000000000..e42e1298fd
--- /dev/null
+++ b/app/views/partners/profiles/step/_population_served_form.html.erb
@@ -0,0 +1,58 @@
+<%= f.fields_for :profile, profile do |pf| %>
+
+ <%= pf.input :income_requirement_desc, label: "Clients Have An Income Requirement to Work With You?",
+ as: :radio_buttons, class: "form-control", wrapper: :input_group,
+ wrapper_html: {class: "form-yesno"}, input_html: {class: "radio-yesno"} %>
+
+
+
+ <%= pf.input :income_verification, label: "Do You Verify The Income Of Your Clients?",
+ as: :radio_buttons, class: "form-control", wrapper: :input_group,
+ wrapper_html: {class: "form-yesno"}, input_html: {class: "radio-yesno"} %>
+
<%= link_to 'Change my password', edit_password_url(@resource, reset_password_token: @token) %>
-
For security reasons these invitations expire. This invitation will expire in 8 hours or if a new password reset is triggered.
+
For security reasons these invitations expire. This invitation will expire in 6 hours or if a new password reset is triggered.
If your invitation has an expired message, go <%= link_to "here", new_user_password_url %> and enter your email address to reset your password.
If you didn't request this, please ignore this email.
Your password won't change until you access the link above and create a new one.
diff --git a/bin/lint b/bin/lint
index fa2178887a..daed34265e 100755
--- a/bin/lint
+++ b/bin/lint
@@ -1,4 +1,16 @@
#!/bin/bash
-bundle exec rubocop -A
-bundle exec erblint --lint-all -a
+# Note: Any arguments passed in will be passed along to rubocop or erb_lint
+#
+# Example to only lint Rails models:
+# $ bin/lint app/models
+#
+echo "Running rubocop"
+bundle exec rubocop -A $@
+
+echo "Running erb_lint"
+if [ $# -eq 0 ]; then # If no arguments are supplied check all files
+ bundle exec erb_lint --lint-all -a
+else # otherwise pass those arguments along (likely a specific file or folder)
+ bundle exec erb_lint $@ -a
+fi
diff --git a/clock.rb b/clock.rb
index 5fad7b561a..b19137dd1c 100644
--- a/clock.rb
+++ b/clock.rb
@@ -31,9 +31,10 @@ module Clockwork
end
every(4.hours, "Backup prod DB to Azure blob storage", if: lambda { |_| Rails.env.production? }) do
- rake = Rake.application
- rake.init
- rake.load_rakefile
- rake["backup_db_rds"].invoke
+ BackupDbRds.run
+ end
+
+ every(1.day, "Send reminder emails", at: "12:00", if: lambda { |_| Rails.env.production? }) do
+ ReminderDeadlineJob.perform_later
end
end
diff --git a/config/application.rb b/config/application.rb
index 783b8c2f02..bd3480a205 100644
--- a/config/application.rb
+++ b/config/application.rb
@@ -19,7 +19,6 @@ class Application < Rails::Application
config.load_defaults 7.0
config.legacy_connection_handling = false
config.action_dispatch.return_only_media_type_on_content_type = false
- config.exceptions_app = routes
config.active_job.queue_adapter = :delayed_job
diff --git a/config/boot.rb b/config/boot.rb
index d2ebcbca6b..988a5ddc46 100644
--- a/config/boot.rb
+++ b/config/boot.rb
@@ -1,4 +1,4 @@
ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
require "bundler/setup" # Set up gems listed in the Gemfile.
-# require 'bootsnap/setup' # Speed up boot time by caching expensive operations.
+require "bootsnap/setup" # Speed up boot time by caching expensive operations.
diff --git a/config/brakeman.ignore b/config/brakeman.ignore
index ac55cf67be..225ff60f53 100644
--- a/config/brakeman.ignore
+++ b/config/brakeman.ignore
@@ -1,5 +1,28 @@
{
"ignored_warnings": [
+ {
+ "warning_type": "Command Injection",
+ "warning_code": 14,
+ "fingerprint": "5dd8c58cca239b1a2527f25255c49c8800a31e5ec8cb8e31e14003fc435dd677",
+ "check_name": "Execute",
+ "message": "Possible command injection",
+ "file": "app/jobs/backup_db_rds.rb",
+ "line": 11,
+ "link": "https://brakemanscanner.org/docs/warning_types/command_injection/",
+ "code": "system(\"PGPASSWORD='#{ENV[\"DIAPER_DB_PASSWORD\"]}' pg_dump -Fc -v --host=#{ENV[\"DIAPER_DB_HOST\"]} --username=#{ENV[\"DIAPER_DB_USERNAME\"]} --dbname=#{ENV[\"DIAPER_DB_DATABASE\"]} -f #{\"#{Time.current.strftime(\"%Y%m%d%H%M%S\")}.rds.dump\"}\")",
+ "render_path": null,
+ "location": {
+ "type": "method",
+ "class": "BackupDbRds",
+ "method": "s(:self).run"
+ },
+ "user_input": "ENV[\"DIAPER_DB_PASSWORD\"]",
+ "confidence": "Medium",
+ "cwe_id": [
+ 77
+ ],
+ "note": ""
+ },
{
"warning_type": "Dynamic Render Path",
"warning_code": 15,
@@ -7,7 +30,7 @@
"check_name": "Render",
"message": "Render path contains parameter value",
"file": "app/controllers/static_controller.rb",
- "line": 25,
+ "line": 20,
"link": "https://brakemanscanner.org/docs/warning_types/dynamic_render_path/",
"code": "render(template => \"static/#{params[:name]}\", {})",
"render_path": null,
@@ -18,29 +41,12 @@
},
"user_input": "params[:name]",
"confidence": "Medium",
- "note": ""
- },
- {
- "warning_type": "SQL Injection",
- "warning_code": 0,
- "fingerprint": "db8503246322c7079274c6aa7e68675a336b4d8dd4fb9c2bb6c566545b139c8a",
- "check_name": "SQL",
- "message": "Possible SQL injection",
- "file": "config/initializers/postgres.rb",
- "line": 9,
- "link": "https://brakemanscanner.org/docs/warning_types/sql_injection/",
- "code": "connection.select_all(\"select pg_terminate_backend(pg_stat_activity.pid) from pg_stat_activity where datname='#{configuration_hash[:database]}' AND state='idle';\")",
- "render_path": null,
- "location": {
- "type": "method",
- "class": "PostgreSQLDatabaseTasks",
- "method": "drop"
- },
- "user_input": "configuration_hash[:database]",
- "confidence": "Medium",
+ "cwe_id": [
+ 22
+ ],
"note": ""
}
],
- "updated": "2021-04-24 20:03:05 -0700",
- "brakeman_version": "4.10.1"
+ "updated": "2024-11-24 10:40:00 -0500",
+ "brakeman_version": "6.2.1"
}
diff --git a/config/initializers/devise.rb b/config/initializers/devise.rb
index 3951cd3f08..4772210d83 100644
--- a/config/initializers/devise.rb
+++ b/config/initializers/devise.rb
@@ -12,7 +12,7 @@
# Configure the e-mail address which will be shown in Devise::Mailer,
# note that it will be overwritten if you use your own mailer class
# with default "from" parameter.
- config.mailer_sender = '"Human Essentials" '
+ config.mailer_sender = '"[DO NOT REPLY] Human Essentials" '
# Configure the class responsible to send e-mails.
config.mailer = "CustomDeviseMailer"
@@ -120,7 +120,7 @@
# The period the generated invitation token is valid, after
# this period, the invited resource won't be able to accept the invitation.
# When invite_for is 0 (the default), the invitation won't expire.
- # config.invite_for = 2.weeks
+ config.invite_for = 2.weeks
# Number of invitations users can send.
# - If invitation_limit is nil, there is no limit for invitations, users can
diff --git a/config/locales/devise_invitable.en.yml b/config/locales/devise_invitable.en.yml
index 7d5fc7c09c..ba47068d82 100644
--- a/config/locales/devise_invitable.en.yml
+++ b/config/locales/devise_invitable.en.yml
@@ -21,7 +21,7 @@ en:
hello: "Hello %{email}"
someone_invited_you: "Someone has invited you to %{url}, you can accept it through the link below."
accept: "Accept invitation"
- accept_until: "This invitation will be due in %{due_date}."
+ accept_until: "This invitation will expire at %{due_date} GMT or if a new password reset is triggered."
ignore: "If you don't want to accept the invitation, please ignore this email. \nYour account won't be created until you access the link above and set your password."
time:
formats:
diff --git a/config/routes.rb b/config/routes.rb
index 7a6c552856..161941480f 100644
--- a/config/routes.rb
+++ b/config/routes.rb
@@ -86,9 +86,6 @@ def set_up_flipper
end
end
- match "/404", to: "errors#not_found", via: :all
- match "/500", to: "errors#internal_server_error", via: :all
-
resources :users do
get :switch_to_role, on: :collection
post :partner_user_reset_password, on: :collection
diff --git a/db/migrate/20240315190152_add_type_to_requests.rb b/db/migrate/20240315190152_add_type_to_requests.rb
new file mode 100644
index 0000000000..335f3908bc
--- /dev/null
+++ b/db/migrate/20240315190152_add_type_to_requests.rb
@@ -0,0 +1,5 @@
+class AddTypeToRequests < ActiveRecord::Migration[7.0]
+ def change
+ add_column :requests, :request_type, :string
+ end
+end
diff --git a/db/migrate/20241106184508_remove_excess_kit_village_diaper_bank.rb b/db/migrate/20241106184508_remove_excess_kit_village_diaper_bank.rb
new file mode 100644
index 0000000000..55c0badcab
--- /dev/null
+++ b/db/migrate/20241106184508_remove_excess_kit_village_diaper_bank.rb
@@ -0,0 +1,6 @@
+class RemoveExcessKitVillageDiaperBank < ActiveRecord::Migration[7.1]
+ def change
+ return unless Rails.env.production?
+ Kit.find(204).destroy
+ end
+end
diff --git a/db/migrate/20241112184800_fix_invalid_distribution_event20241112.rb b/db/migrate/20241112184800_fix_invalid_distribution_event20241112.rb
new file mode 100644
index 0000000000..e2a8f13943
--- /dev/null
+++ b/db/migrate/20241112184800_fix_invalid_distribution_event20241112.rb
@@ -0,0 +1,12 @@
+class FixInvalidDistributionEvent20241112 < ActiveRecord::Migration[7.1]
+ def change
+ return unless Rails.env.production?
+
+ # We are not sure why yet, but this org was able to create a distribution
+ # that put them at a negative inventory. Later playback of the events with
+ # validation turned on then raised it as an error. For now we are deleting
+ # the distribution and event directly.
+ Event.where(id: 42075, eventable_type: 'Distribution', eventable_id: 78924).first.destroy
+ Distribution.find(78924).destroy
+ end
+end
diff --git a/db/migrate/20241204111437_cleanup_invalid_partner_profiles.rb b/db/migrate/20241204111437_cleanup_invalid_partner_profiles.rb
new file mode 100644
index 0000000000..1b21236aeb
--- /dev/null
+++ b/db/migrate/20241204111437_cleanup_invalid_partner_profiles.rb
@@ -0,0 +1,61 @@
+class CleanupInvalidPartnerProfiles < ActiveRecord::Migration[7.1]
+ def up
+ # ActiveRecord::Base.logger = Logger.new(STDOUT)
+ invalid_profiles = Partners::Profile.all.reject(&:valid?)
+
+ return if !invalid_profiles.present?
+
+ invalid_profiles.each do |profile|
+ # address invalid social media section
+
+ unless (profile.website.present? ||
+ profile.twitter.present? ||
+ profile.facebook.present? ||
+ profile.instagram.present? ||
+ profile.no_social_media_presence ||
+ profile.partner.partials_to_show.exclude?("media_information"))
+ profile.no_social_media_presence = true
+ end
+
+ # address no request types set
+
+ unless(profile.enable_quantity_based_requests || profile.enable_individual_requests || profile.enable_child_based_requests)
+ profile.enable_quantity_based_requests = profile.partner.organization.enable_quantity_based_requests
+ profile.enable_individual_requests = profile.partner.organization.enable_individual_requests
+ profile.enable_child_based_requests = profile.partner.organization.enable_child_based_requests
+ end
+
+
+
+ # address bad pickup email
+
+ unless profile.valid?
+ # if profile is not valid at this point, it is a bad pickup email
+
+ pick_up = profile.pick_up_email
+ pick_up.downcase!
+ pick_up.strip!
+ if pick_up == "none" or pick_up == "na" or pick_up == "n/a" or pick_up == "see above"
+ profile.pick_up_email = ""
+ else
+ profile.pick_up_email.gsub!("/",",")
+ profile.pick_up_email.gsub!(";",",")
+ profile.pick_up_email.gsub!(" or ", ", ")
+ profile.pick_up_email.gsub!(" and ", ", ")
+ profile.pick_up_email.gsub!(" & ", ", ")
+ end
+
+ if(!profile.valid?) ## If we can't fix the email, append it to the name so we don't lose the information aspect
+ profile.pick_up_name += ", email: " + profile.pick_up_email
+ profile.pick_up_email = ""
+ end
+ end
+
+ profile.save!
+
+ end
+ end
+ def down
+ # irreversible
+ end
+end
diff --git a/db/migrate/20241204133041_remove_index_on_name_from_counties_table.rb b/db/migrate/20241204133041_remove_index_on_name_from_counties_table.rb
new file mode 100644
index 0000000000..d4fbc1e3c6
--- /dev/null
+++ b/db/migrate/20241204133041_remove_index_on_name_from_counties_table.rb
@@ -0,0 +1,7 @@
+class RemoveIndexOnNameFromCountiesTable < ActiveRecord::Migration[7.1]
+ disable_ddl_transaction!
+
+ def change
+ remove_index :counties, :name, algorithm: :concurrently
+ end
+end
diff --git a/db/migrate/20241204133506_remove_index_on_organization_id_from_events_table.rb b/db/migrate/20241204133506_remove_index_on_organization_id_from_events_table.rb
new file mode 100644
index 0000000000..94e4b37745
--- /dev/null
+++ b/db/migrate/20241204133506_remove_index_on_organization_id_from_events_table.rb
@@ -0,0 +1,7 @@
+class RemoveIndexOnOrganizationIdFromEventsTable < ActiveRecord::Migration[7.1]
+ disable_ddl_transaction!
+
+ def change
+ remove_index :events, :organization_id, algorithm: :concurrently
+ end
+end
diff --git a/db/migrate/20241204133715_remove_index_on_user_id_from_users_roles_table.rb b/db/migrate/20241204133715_remove_index_on_user_id_from_users_roles_table.rb
new file mode 100644
index 0000000000..ef7cd0f0a1
--- /dev/null
+++ b/db/migrate/20241204133715_remove_index_on_user_id_from_users_roles_table.rb
@@ -0,0 +1,7 @@
+class RemoveIndexOnUserIdFromUsersRolesTable < ActiveRecord::Migration[7.1]
+ disable_ddl_transaction!
+
+ def change
+ remove_index :users_roles, :user_id, algorithm: :concurrently
+ end
+end
diff --git a/db/schema.rb b/db/schema.rb
index a185dea300..69dade3cbe 100644
--- a/db/schema.rb
+++ b/db/schema.rb
@@ -10,7 +10,7 @@
#
# It's strongly recommended that you check this file into your version control system.
-ActiveRecord::Schema[7.1].define(version: 2024_10_02_205346) do
+ActiveRecord::Schema[7.1].define(version: 2024_12_04_133715) do
# These are extensions that must be enabled in order to support this database
enable_extension "plpgsql"
@@ -202,7 +202,6 @@
t.datetime "updated_at", null: false
t.enum "category", default: "US_County", null: false, enum_type: "category"
t.index ["name", "region"], name: "index_counties_on_name_and_region", unique: true
- t.index ["name"], name: "index_counties_on_name"
t.index ["region"], name: "index_counties_on_region"
end
@@ -298,7 +297,6 @@
t.bigint "user_id"
t.string "group_id"
t.index ["organization_id", "event_time"], name: "index_events_on_organization_id_and_event_time"
- t.index ["organization_id"], name: "index_events_on_organization_id"
t.index ["user_id"], name: "index_events_on_user_id"
end
@@ -712,6 +710,7 @@
t.datetime "discarded_at", precision: nil
t.text "discard_reason"
t.integer "partner_user_id"
+ t.string "request_type"
t.index ["discarded_at"], name: "index_requests_on_discarded_at"
t.index ["distribution_id"], name: "index_requests_on_distribution_id", unique: true
t.index ["organization_id"], name: "index_requests_on_organization_id"
@@ -812,7 +811,6 @@
t.bigint "role_id"
t.index ["role_id"], name: "index_users_roles_on_role_id"
t.index ["user_id", "role_id"], name: "index_users_roles_on_user_id_and_role_id"
- t.index ["user_id"], name: "index_users_roles_on_user_id"
end
create_table "vendors", force: :cascade do |t|
diff --git a/db/seeds.rb b/db/seeds.rb
index 55c5a3d308..27b35ce2e8 100644
--- a/db/seeds.rb
+++ b/db/seeds.rb
@@ -19,26 +19,12 @@ def random_record_for_org(org, klass)
# Script-Global Variables
# ----------------------------------------------------------------------------
-# Initial starting qty for our test organizations
-base_items = File.read(Rails.root.join("db", "base_items.json"))
-items_by_category = JSON.parse(base_items)
-
# ----------------------------------------------------------------------------
# Base Items
# ----------------------------------------------------------------------------
-items_by_category.each do |category, entries|
- entries.each do |entry|
- BaseItem.find_or_create_by!(name: entry["name"], category: category, partner_key: entry["key"])
- end
-end
-
-# Create global 'Kit' base item
-BaseItem.find_or_create_by!(
- name: 'Kit',
- category: 'kit',
- partner_key: 'kit'
-)
+require 'seeds'
+Seeds.seed_base_items
# ----------------------------------------------------------------------------
# NDBN Members
@@ -51,32 +37,62 @@ def random_record_for_org(org, klass)
# ----------------------------------------------------------------------------
pdx_org = Organization.find_or_create_by!(short_name: "diaper_bank") do |organization|
- organization.name = "Pawnee Diaper Bank"
- organization.street = "P.O. Box 22613"
- organization.city = "Pawnee"
- organization.state = "Indiana"
+ organization.name = "Pawnee Diaper Bank"
+ organization.street = "P.O. Box 22613"
+ organization.city = "Pawnee"
+ organization.state = "Indiana"
organization.zipcode = "12345"
- organization.email = "info@pawneediaper.org"
+ organization.email = "info@pawneediaper.org"
end
Organization.seed_items(pdx_org)
sf_org = Organization.find_or_create_by!(short_name: "sf_bank") do |organization|
- organization.name = "SF Diaper Bank"
- organization.street = "P.O. Box 12345"
- organization.city = "San Francisco"
- organization.state = "CA"
+ organization.name = "SF Diaper Bank"
+ organization.street = "P.O. Box 12345"
+ organization.city = "San Francisco"
+ organization.state = "CA"
organization.zipcode = "90210"
- organization.email = "info@sfdiaperbank.org"
+ organization.email = "info@sfdiaperbank.org"
end
Organization.seed_items(sf_org)
+sc_org = Organization.find_or_create_by!(short_name: "sc_bank") do |organization|
+ organization.name = "Second City Essentials Bank"
+ organization.street = Faker::Address.street_address
+ organization.city = Faker::Address.city
+ organization.state = Faker::Address.state_abbr
+ organization.zipcode = Faker::Address.zip_code
+ organization.email = "info@scdiaperbank.org"
+end
+Organization.seed_items(sc_org)
+
+# The list of organizations that will have donations, purchases, requests, distributions,
+# and the records those rely on generated.
+complete_orgs = [pdx_org, sc_org]
+
# At least one of the items is marked as inactive
-Organization.all.each do |org|
+Organization.all.find_each do |org|
org.items.order(created_at: :desc).last.update(active: false)
end
+def seed_random_item_with_name(organization, name)
+ base_items = BaseItem.all.map(&:to_h)
+ base_item = Array.wrap(base_items).sample
+ base_item[:name] = name
+ organization.seed_items(base_item)
+end
+
+# Add a couple unique items based on random base items named after the sc_bank
+# so it will be clear if they are showing up where they aren't supposed to be
+4.times do |index|
+ seed_random_item_with_name(sc_org, "Second City Item ##{index + 1}")
+end
+
+# Keep a list of these unique items so its easy to use them for later records
+sc_org_unique_items = sc_org.items.where("name ilike ?", "%Second City Item #%")
+
# Assign a value to some organization items to verify totals are working
-Organization.all.each do |org|
+Organization.all.find_each do |org|
org.items.where(value_in_cents: 0).limit(10).each do |item|
item.update(value_in_cents: 100)
end
@@ -86,18 +102,20 @@ def random_record_for_org(org, klass)
# Request Units
# ----------------------------------------------------------------------------
-%w(pack box flat).each do |name|
- Unit.create!(organization: pdx_org, name: name)
-end
+complete_orgs.each do |org|
+ %w[pack box flat].each do |name|
+ Unit.create!(organization: org, name: name)
+ end
-pdx_org.items.each_with_index do |item, i|
- if item.name == 'Pads'
- %w(box pack).each { |name| item.request_units.create!(name: name) }
- elsif item.name == 'Wipes (Baby)'
- item.request_units.create!(name: 'pack')
- elsif item.name == 'Kids Pull-Ups (5T-6T)'
- %w(pack flat).each do |name|
- item.request_units.create!(name: name)
+ org.items.each_with_index do |item, i|
+ if item.name == "Pads"
+ %w[box pack].each { |name| item.request_units.create!(name: name) }
+ elsif item.name == "Wipes (Baby)"
+ item.request_units.create!(name: "pack")
+ elsif item.name == "Kids Pull-Ups (5T-6T)"
+ %w[pack flat].each do |name|
+ item.request_units.create!(name: name)
+ end
end
end
end
@@ -106,8 +124,8 @@ def random_record_for_org(org, klass)
# Item Categories
# ----------------------------------------------------------------------------
-Organization.all.each do |org|
- ['Diapers', 'Period Supplies', 'Adult Incontinence'].each do |letter|
+Organization.all.find_each do |org|
+ ["Diapers", "Period Supplies", "Adult Incontinence"].each do |letter|
FactoryBot.create(:item_category, organization: org, name: "Category #{letter}")
end
end
@@ -116,19 +134,19 @@ def random_record_for_org(org, klass)
# Item < - > ItemCategory
# ----------------------------------------------------------------------------
-Organization.all.each do |org|
+Organization.all.find_each do |org|
# Added `nil` to randomly choose to not categorize items sometimes via sample
item_category_ids = org.item_categories.map(&:id) + [nil]
org.items.each do |item|
- item.update_column(:item_category_id, item_category_ids.sample)
+ item.update(item_category_id: item_category_ids.sample)
end
end
# ----------------------------------------------------------------------------
# Partner Group & Item Categories
# ----------------------------------------------------------------------------
-Organization.all.each do |org|
+Organization.all.find_each do |org|
# Setup the Partner Group & their item categories
partner_group_one = FactoryBot.create(:partner_group, organization: org)
@@ -150,18 +168,20 @@ def random_record_for_org(org, klass)
# ----------------------------------------------------------------------------
[
- { email: 'superadmin@example.com', organization_admin: false, super_admin: true },
- { email: 'org_admin1@example.com', organization_admin: true, organization: pdx_org },
- { email: 'org_admin2@example.com', organization_admin: true, organization: sf_org },
- { email: 'user_1@example.com', organization_admin: false, organization: pdx_org },
- { email: 'user_2@example.com', organization_admin: false, organization: sf_org },
- { email: 'test@example.com', organization_admin: false, organization: pdx_org, super_admin: true },
- { email: 'test2@example.com', organization_admin: true, organization: pdx_org }
+ {email: "superadmin@example.com", organization_admin: false, super_admin: true},
+ {email: "org_admin1@example.com", organization_admin: true, organization: pdx_org},
+ {email: "org_admin2@example.com", organization_admin: true, organization: sf_org},
+ {email: "second_city_admin@example.com", organization_admin: true, organization: sc_org},
+ {email: "user_1@example.com", organization_admin: false, organization: pdx_org},
+ {email: "user_2@example.com", organization_admin: false, organization: sf_org},
+ {email: "second_city_user@example.com", organization_admin: false, organization: sc_org},
+ {email: "test@example.com", organization_admin: false, organization: pdx_org, super_admin: true},
+ {email: "test2@example.com", organization_admin: true, organization: pdx_org}
].each do |user_data|
user = User.create(
email: user_data[:email],
- password: 'password!',
- password_confirmation: 'password!'
+ password: "password!",
+ password_confirmation: "password!"
)
if user_data[:organization]
@@ -181,15 +201,17 @@ def random_record_for_org(org, klass)
# Donation Sites
# ----------------------------------------------------------------------------
-[
- { name: "Pawnee Hardware", address: "1234 SE Some Ave., Pawnee, OR 12345" },
- { name: "Parks Department", address: "2345 NE Some St., Pawnee, OR 12345" },
- { name: "Waffle House", address: "3456 Some Bay., Pawnee, OR 12345" },
- { name: "Eagleton Country Club", address: "4567 Some Blvd., Eagleton, OR 12345" }
-].each do |donation_option|
- DonationSite.find_or_create_by!(name: donation_option[:name]) do |donation|
- donation.address = donation_option[:address]
- donation.organization = pdx_org
+complete_orgs.each do |org|
+ [
+ {name: "#{org.city} Hardware", address: "1234 SE Some Ave., #{org.city}, #{org.state} 12345"},
+ {name: "#{org.city} Parks Department", address: "2345 NE Some St., #{org.city}, #{org.state} 12345"},
+ {name: "Waffle House", address: "3456 Some Bay., #{org.city}, #{org.state} 12345"},
+ {name: "Eagleton Country Club", address: "4567 Some Blvd., Eagleton, #{org.state} 12345"}
+ ].each do |donation_option|
+ DonationSite.find_or_create_by!(address: donation_option[:address]) do |donation|
+ donation.name = donation_option[:name]
+ donation.organization = org
+ end
end
end
@@ -238,39 +260,51 @@ def random_record_for_org(org, klass)
status: :approved,
email: "approved_2@example.com",
notes: note.sample
+ },
+ {
+ name: "Second City Senior Center",
+ email: "second_city_senior_center@example.com",
+ status: :approved,
+ quota: 500,
+ notes: note.sample,
+ organization: sc_org
}
].each do |partner_option|
p = Partner.find_or_create_by!(partner_option) do |partner|
- partner.organization = pdx_org
+ partner.organization = if partner_option.key?(:organization)
+ partner_option[:organization]
+ else
+ pdx_org
+ end
- if partner_option[:name] == "Second Street Community Outreach"
- partner.partner_group = pdx_org.partner_groups.find_by(name: 'Group 2')
+ partner.partner_group = if partner_option[:name] == "Second Street Community Outreach"
+ pdx_org.partner_groups.find_by(name: "Group 2")
else
- partner.partner_group = pdx_org.partner_groups.first
+ partner.organization.partner_groups.first
end
end
- profile = Partners::Profile.create!({
- essentials_bank_id: p.organization_id,
- partner_id: p.id,
- address1: Faker::Address.street_address,
- address2: "",
- city: Faker::Address.city,
- state: Faker::Address.state_abbr,
- zip_code: Faker::Address.zip,
- website: Faker::Internet.domain_name,
- zips_served: Faker::Address.zip,
- executive_director_name: Faker::Name.name,
- executive_director_email: p.email,
- executive_director_phone: Faker::PhoneNumber.phone_number,
- primary_contact_name: Faker::Name.name,
- primary_contact_email: Faker::Internet.email,
- primary_contact_phone: Faker::PhoneNumber.phone_number,
- primary_contact_mobile: Faker::PhoneNumber.phone_number,
- pick_up_name: Faker::Name.name,
- pick_up_email: Faker::Internet.email,
- pick_up_phone: Faker::PhoneNumber.phone_number
- })
+ Partners::Profile.create!({
+ essentials_bank_id: p.organization_id,
+ partner_id: p.id,
+ address1: Faker::Address.street_address,
+ address2: "",
+ city: Faker::Address.city,
+ state: Faker::Address.state_abbr,
+ zip_code: Faker::Address.zip,
+ website: Faker::Internet.domain_name,
+ zips_served: Faker::Address.zip,
+ executive_director_name: Faker::Name.name,
+ executive_director_email: p.email,
+ executive_director_phone: Faker::PhoneNumber.phone_number,
+ primary_contact_name: Faker::Name.name,
+ primary_contact_email: Faker::Internet.email,
+ primary_contact_phone: Faker::PhoneNumber.phone_number,
+ primary_contact_mobile: Faker::PhoneNumber.phone_number,
+ pick_up_name: Faker::Name.name,
+ pick_up_email: Faker::Internet.email,
+ pick_up_phone: Faker::PhoneNumber.phone_number
+ })
user = ::User.create!(
name: Faker::Name.name,
@@ -298,7 +332,7 @@ def random_record_for_org(org, klass)
# Skip creating records that they would have created after
# they've accepted the invitation
#
- next if p.status == 'uninvited'
+ next if p.status == "uninvited"
families = (1..Faker::Number.within(range: 4..13)).to_a.map do
Partners::Family.create!(
@@ -373,7 +407,7 @@ def random_record_for_org(org, klass)
dates_generator = DispersedPastDatesGenerator.new
- Faker::Number.within(range: 32..56).times do
+ Faker::Number.within(range: 32..56).times do |index|
date = dates_generator.next
partner_request = ::Request.new(
@@ -385,7 +419,7 @@ def random_record_for_org(org, klass)
updated_at: date
)
- pads = p.organization.items.find_by(name: 'Pads')
+ pads = p.organization.items.find_by(name: "Pads")
new_item_request = Partners::ItemRequest.new(
item_id: pads.id,
quantity: Faker::Number.within(range: 10..30),
@@ -394,7 +428,7 @@ def random_record_for_org(org, klass)
partner_key: pads.partner_key,
created_at: date,
updated_at: date,
- request_unit: 'pack'
+ request_unit: "pack"
)
partner_request.item_requests << new_item_request
@@ -419,6 +453,24 @@ def random_record_for_org(org, klass)
}
end
+ # Guarantee that there is a request for the items unique to the Second City Bank
+ if (p.organization == sc_org) && (index < 4)
+ unique_item = sc_org_unique_items[index]
+ # Make sure we don't violate item request uniqueness if the unique_item was
+ # randomly selected already
+ if !partner_request.item_requests.any? { |item_request| item_request.item_id == unique_item.id }
+ partner_request.item_requests << Partners::ItemRequest.new(
+ item_id: unique_item.id,
+ quantity: Faker::Number.within(range: 10..30),
+ children: [],
+ name: unique_item.name,
+ partner_key: unique_item.partner_key,
+ created_at: date,
+ updated_at: date
+ )
+ end
+ end
+
partner_request.save!
end
end
@@ -439,6 +491,18 @@ def random_record_for_org(org, klass)
inventory.warehouse_type = StorageLocation::WAREHOUSE_TYPES[1]
inventory.square_footage = 20_000
end
+StorageLocation.find_or_create_by!(name: "Second City Bulk Storage") do |inventory|
+ inventory.address = "#{Faker::Address.street_address}, #{sc_org.city}, #{sc_org.state} #{sc_org.zipcode}"
+ inventory.organization = sc_org
+ inventory.warehouse_type = StorageLocation::WAREHOUSE_TYPES[0]
+ inventory.square_footage = 10_000
+end
+StorageLocation.find_or_create_by!(name: "Second City Main Bank (Office)") do |inventory|
+ inventory.address = "#{Faker::Address.street_address}, #{sc_org.city}, #{sc_org.state} #{sc_org.zipcode}"
+ inventory.organization = sc_org
+ inventory.warehouse_type = StorageLocation::WAREHOUSE_TYPES[1]
+ inventory.square_footage = 20_000
+end
inactive_storage = StorageLocation.find_or_create_by!(name: "Inactive Storage Location") do |inventory|
inventory.address = "Unknown"
@@ -461,79 +525,81 @@ def random_record_for_org(org, klass)
)
end
end
-Organization.all.each { |org| SnapshotEvent.publish(org) }
-
-# Set minimum and recomended inventory levels for items at the Pawnee Diaper Bank Organization
-half_items_count = (pdx_org.items.count/2).to_i
-low_items = pdx_org.items.left_joins(:inventory_items)
- .select('items.*, SUM(inventory_items.quantity) AS total_quantity')
- .group('items.id')
- .order('total_quantity')
- .limit(half_items_count)
-
-min_qty = low_items.first.total_quantity
-max_qty = low_items.last.total_quantity
+Organization.all.find_each { |org| SnapshotEvent.publish(org) }
+
+# Set minimum and recomended inventory levels for the complete organizations
+# Only set inventory levels for the half of each org's items with the lowest stock
+complete_orgs.each do |org|
+ half_items_count = (org.items.count / 2).to_i
+ low_items = org.items.left_joins(:inventory_items)
+ .select("items.*, SUM(inventory_items.quantity) AS total_quantity")
+ .group("items.id")
+ .order("total_quantity")
+ .limit(half_items_count).to_a
+
+ min_qty = low_items.first.total_quantity
+ max_qty = low_items.last.total_quantity
+
+ # Ensure at least one of the items unqiue to the Second City Bank has minimum
+ # and recommended quantities set
+ if (org == sc_org) && !(low_items & sc_org_unique_items).any?
+ low_items << sc_org_unique_items.last
+ end
-low_items.each do |item|
- min_value = rand((min_qty / 10).floor..(max_qty/10).ceil) * 10
- recomended_value = rand((min_value/10).ceil..1000) * 10
- item.update(on_hand_minimum_quantity: min_value, on_hand_recommended_quantity: recomended_value)
+ low_items.each do |item|
+ min_value = rand((min_qty / 10).floor..(max_qty / 10).ceil) * 10
+ recomended_value = rand((min_value / 10).ceil..1000) * 10
+ item.update(on_hand_minimum_quantity: min_value, on_hand_recommended_quantity: recomended_value)
+ end
end
-# ----------------------------------------------------------------------------
-# Product Drives
-# ----------------------------------------------------------------------------
-
-[
- {
- name: 'Pamper the Poopsies',
- start_date: Time.current,
- organization: pdx_org
- }
-].each { |drive| ProductDrive.create! drive }
-
-# ----------------------------------------------------------------------------
-# Product Drive Participants
-# ----------------------------------------------------------------------------
-
-[
- { business_name: "A Good Place to Collect Diapers",
- contact_name: "fred",
- email: "good@place.is",
- organization: pdx_org },
- { business_name: "A Mediocre Place to Collect Diapers",
- contact_name: "wilma",
- email: "ok@place.is",
- organization: pdx_org }
-].each { |participant| ProductDriveParticipant.create! participant }
-
-# ----------------------------------------------------------------------------
-# Product Drives
-# ----------------------------------------------------------------------------
-
-[
- { name: "First Product Drive",
- start_date: 3.years.ago,
- end_date: 3.years.ago,
- organization: sf_org },
- { name: "Best Product Drive",
- start_date: 3.weeks.ago,
- end_date: 2.weeks.ago,
- organization: sf_org },
- { name: "Second Best Product Drive",
- start_date: 2.weeks.ago,
- end_date: 1.week.ago,
- organization: pdx_org }
-].each { |product_drive| ProductDrive.find_or_create_by! product_drive }
-
-# ----------------------------------------------------------------------------
-# Manufacturers
-# ----------------------------------------------------------------------------
-
-[
- { name: "Manufacturer 1", organization: pdx_org },
- { name: "Manufacturer 2", organization: pdx_org }
-].each { |manu| Manufacturer.find_or_create_by! manu }
+# Reload, since some of the items in sc_org_unique_items will have been altered
+sc_org_unique_items.reload
+
+complete_orgs.each do |org|
+ # ----------------------------------------------------------------------------
+ # Product Drives
+ # ----------------------------------------------------------------------------
+
+ [
+ {name: "First Product Drive",
+ start_date: 3.years.ago,
+ end_date: 3.years.ago,
+ organization: org},
+ {name: "Best Product Drive",
+ start_date: 3.weeks.ago,
+ end_date: 2.weeks.ago,
+ organization: org},
+ {name: "Second Best Product Drive",
+ start_date: 2.weeks.ago,
+ end_date: 1.week.ago,
+ organization: org}
+ ].each { |product_drive| ProductDrive.find_or_create_by! product_drive }
+
+ # ----------------------------------------------------------------------------
+ # Product Drive Participants
+ # ----------------------------------------------------------------------------
+
+ [
+ {business_name: "A Good Place to Collect Diapers",
+ contact_name: "fred",
+ email: "good@place.is",
+ organization: org},
+ {business_name: "A Mediocre Place to Collect Diapers",
+ contact_name: "wilma",
+ email: "ok@place.is",
+ organization: org}
+ ].each { |participant| ProductDriveParticipant.create! participant }
+
+ # ----------------------------------------------------------------------------
+ # Manufacturers
+ # ----------------------------------------------------------------------------
+
+ [
+ {name: "Manufacturer 1", organization: org},
+ {name: "Manufacturer 2", organization: org}
+ ].each { |manu| Manufacturer.find_or_create_by! manu }
+end
# ----------------------------------------------------------------------------
# Line Items
@@ -553,10 +619,10 @@ def seed_quantity(item_name, organization, storage_location, quantity)
AdjustmentCreateService.new(adjustment).call
end
-items_by_category.each do |_category, entries|
+JSON.parse(File.read(Rails.root.join("db", "base_items.json"))).each do |_category, entries|
entries.each do |entry|
- seed_quantity(entry['name'], pdx_org, inv_arbor, entry['qty']['arbor'])
- seed_quantity(entry['name'], pdx_org, inv_pdxdb, entry['qty']['pdxdb'])
+ seed_quantity(entry["name"], pdx_org, inv_arbor, entry["qty"]["arbor"])
+ seed_quantity(entry["name"], pdx_org, inv_pdxdb, entry["qty"]["pdxdb"])
end
end
@@ -565,19 +631,19 @@ def seed_quantity(item_name, organization, storage_location, quantity)
# ----------------------------------------------------------------------------
[
- { value: "10037867880046", name: "Kids (Size 5)", quantity: 108 },
- { value: "10037867880053", name: "Kids (Size 6)", quantity: 92 },
- { value: "10037867880039", name: "Kids (Size 4)", quantity: 124 },
- { value: "803516626364", name: "Kids (Size 1)", quantity: 40 },
- { value: "036000406535", name: "Kids (Size 1)", quantity: 44 },
- { value: "037000863427", name: "Kids (Size 1)", quantity: 35 },
- { value: "041260379000", name: "Kids (Size 3)", quantity: 160 },
- { value: "074887711700", name: "Wipes (Baby)", quantity: 8 },
- { value: "036000451306", name: "Kids Pull-Ups (4T-5T)", quantity: 56 },
- { value: "037000862246", name: "Kids (Size 4)", quantity: 92 },
- { value: "041260370236", name: "Kids (Size 4)", quantity: 68 },
- { value: "036000407679", name: "Kids (Size 4)", quantity: 24 },
- { value: "311917152226", name: "Kids (Size 4)", quantity: 82 },
+ {value: "10037867880046", name: "Kids (Size 5)", quantity: 108},
+ {value: "10037867880053", name: "Kids (Size 6)", quantity: 92},
+ {value: "10037867880039", name: "Kids (Size 4)", quantity: 124},
+ {value: "803516626364", name: "Kids (Size 1)", quantity: 40},
+ {value: "036000406535", name: "Kids (Size 1)", quantity: 44},
+ {value: "037000863427", name: "Kids (Size 1)", quantity: 35},
+ {value: "041260379000", name: "Kids (Size 3)", quantity: 160},
+ {value: "074887711700", name: "Wipes (Baby)", quantity: 8},
+ {value: "036000451306", name: "Kids Pull-Ups (4T-5T)", quantity: 56},
+ {value: "037000862246", name: "Kids (Size 4)", quantity: 92},
+ {value: "041260370236", name: "Kids (Size 4)", quantity: 68},
+ {value: "036000407679", name: "Kids (Size 4)", quantity: 24},
+ {value: "311917152226", name: "Kids (Size 4)", quantity: 82}
].each do |item|
BarcodeItem.find_or_create_by!(value: item[:value]) do |barcode|
barcode.item = pdx_org.items.find_by(name: item[:name])
@@ -586,68 +652,90 @@ def seed_quantity(item_name, organization, storage_location, quantity)
end
end
-# ----------------------------------------------------------------------------
-# Donations
-# ----------------------------------------------------------------------------
-
dates_generator = DispersedPastDatesGenerator.new
-# Make some donations of all sorts
-20.times.each do
- source = Donation::SOURCES.values.sample
- # Depending on which source it uses, additional data may need to be provided.
- donation = Donation.new(source: source,
- storage_location: StorageLocation.active_locations.sample,
- organization: pdx_org,
- issued_at: dates_generator.next)
- case source
- when Donation::SOURCES[:product_drive]
- donation.product_drive = ProductDrive.first
- donation.product_drive_participant = random_record_for_org(pdx_org, ProductDriveParticipant)
- when Donation::SOURCES[:donation_site]
- donation.donation_site = random_record_for_org(pdx_org, DonationSite)
- when Donation::SOURCES[:manufacturer]
- donation.manufacturer = random_record_for_org(pdx_org, Manufacturer)
- end
+complete_orgs.each do |org|
+ # ----------------------------------------------------------------------------
+ # Donations
+ # ----------------------------------------------------------------------------
+
+ # Make some donations of all sorts
+ 20.times.each do |index|
+ source = Donation::SOURCES.values.sample
+ # Depending on which source it uses, additional data may need to be provided.
+ donation = Donation.new(
+ source: source,
+ storage_location: org.storage_locations.active_locations.sample,
+ organization: org,
+ issued_at: dates_generator.next
+ )
+ case source
+ when Donation::SOURCES[:product_drive]
+ donation.product_drive = org.product_drives.find_by(name: "Best Product Drive")
+ donation.product_drive_participant = random_record_for_org(org, ProductDriveParticipant)
+ when Donation::SOURCES[:donation_site]
+ donation.donation_site = random_record_for_org(org, DonationSite)
+ when Donation::SOURCES[:manufacturer]
+ donation.manufacturer = random_record_for_org(org, Manufacturer)
+ end
- rand(1..5).times.each do
- donation.line_items.push(LineItem.new(quantity: rand(250..500), item: random_record_for_org(pdx_org, Item)))
- end
- DonationCreateService.call(donation)
-end
+ rand(1..5).times.each do
+ donation.line_items.push(LineItem.new(quantity: rand(250..500), item: random_record_for_org(org, Item)))
+ end
-# ----------------------------------------------------------------------------
-# Distributions
-# ----------------------------------------------------------------------------
-dates_generator = DispersedPastDatesGenerator.new
+ # Guarantee that there are at least a few donations for the items unique to the Second City Bank
+ if (org == sc_org) && (index < 4)
+ donation.line_items.push(LineItem.new(quantity: rand(250..500), item: sc_org_unique_items[index]))
+ end
-inventory = InventoryAggregate.inventory_for(pdx_org.id)
-# Make some distributions, but don't use up all the inventory
-20.times.each do
- issued_at = dates_generator.next
+ DonationCreateService.call(donation)
+ end
- storage_location = StorageLocation.active_locations.sample
- stored_inventory_items_sample = inventory.storage_locations[storage_location.id].items.values.sample(20)
- delivery_method = Distribution.delivery_methods.keys.sample
- shipping_cost = delivery_method == "shipped" ? (rand(20.0..100.0)).round(2).to_s : nil
- distribution = Distribution.new(
- storage_location: storage_location,
- partner: random_record_for_org(pdx_org, Partner),
- organization: pdx_org,
- issued_at: issued_at,
- created_at: 3.days.ago(issued_at),
- delivery_method: delivery_method,
- shipping_cost: shipping_cost,
- comment: 'Urgent'
- )
+ # ----------------------------------------------------------------------------
+ # Distributions
+ # ----------------------------------------------------------------------------
+
+ inventory = InventoryAggregate.inventory_for(org.id)
+ # Make some distributions, but don't use up all the inventory
+ 20.times.each do |index|
+ issued_at = dates_generator.next
+
+ storage_location = org.storage_locations.active_locations.sample
+ stored_inventory_items_sample = inventory.storage_locations[storage_location.id].items.values.sample(20)
+ delivery_method = Distribution.delivery_methods.keys.sample
+ shipping_cost = (delivery_method == "shipped") ? rand(20.0..100.0).round(2).to_s : nil
+ distribution = Distribution.new(
+ storage_location: storage_location,
+ partner: random_record_for_org(org, Partner),
+ organization: org,
+ issued_at: issued_at,
+ created_at: 3.days.ago(issued_at),
+ delivery_method: delivery_method,
+ shipping_cost: shipping_cost,
+ comment: "Urgent"
+ )
+
+ stored_inventory_items_sample.each do |stored_inventory_item|
+ distribution_qty = rand(stored_inventory_item.quantity / 2)
+ if distribution_qty >= 1
+ distribution.line_items.push(LineItem.new(quantity: distribution_qty,
+ item_id: stored_inventory_item.item_id))
+ end
+ end
- stored_inventory_items_sample.each do |stored_inventory_item|
- distribution_qty = rand(stored_inventory_item.quantity / 2)
- if distribution_qty >= 1
- distribution.line_items.push(LineItem.new(quantity: distribution_qty,
- item_id: stored_inventory_item.item_id))
+ # Guarantee that there are at least a few distributions for the items unique to the Second City Bank
+ if (org == sc_org) && (index < 4)
+ unique_item_id = sc_org_unique_items[index].id
+ distribution_qty = rand(storage_location.item_total(unique_item_id) / 2)
+ distribution.line_items.push(
+ LineItem.new(
+ quantity: distribution_qty,
+ item_id: unique_item_id
+ )
+ )
end
+
+ DistributionCreateService.new(distribution).call
end
- DistributionCreateService.new(distribution).call
end
# ----------------------------------------------------------------------------
@@ -655,18 +743,18 @@ def seed_quantity(item_name, organization, storage_location, quantity)
# ----------------------------------------------------------------------------
BroadcastAnnouncement.create(
- user: User.find_by(email: 'superadmin@example.com'),
+ user: User.find_by(email: "superadmin@example.com"),
message: "This is the staging /demo server. There may be new features here! Stay tuned!",
link: "https://example.com",
- expiry: Date.today + 7.days,
+ expiry: Time.zone.today + 7.days,
organization: nil
)
BroadcastAnnouncement.create(
- user: User.find_by(email: 'org_admin1@example.com'),
+ user: User.find_by(email: "org_admin1@example.com"),
message: "This is the staging /demo server. There may be new features here! Stay tuned!",
link: "https://example.com",
- expiry: Date.today + 10.days,
+ expiry: Time.zone.today + 10.days,
organization: pdx_org
)
@@ -675,20 +763,22 @@ def seed_quantity(item_name, organization, storage_location, quantity)
# ----------------------------------------------------------------------------
# Create some Vendors so Purchases can have vendor_ids
-Vendor.create(
- contact_name: Faker::FunnyName.two_word_name,
- email: Faker::Internet.email,
- phone: Faker::PhoneNumber.cell_phone,
- comment: Faker::Lorem.paragraph(sentence_count: 2),
- organization_id: pdx_org.id,
- address: "#{Faker::Address.street_address} #{Faker::Address.city}, #{Faker::Address.state_abbr} #{Faker::Address.zip_code}",
- business_name: Faker::Company.name,
- latitude: rand(-90.000000000...90.000000000),
- longitude: rand(-180.000000000...180.000000000),
- created_at: (Time.zone.today - rand(15).days),
- updated_at: (Time.zone.today - rand(15).days),
-)
-4.times do
+complete_orgs.each do |org|
+ Vendor.create(
+ contact_name: Faker::FunnyName.two_word_name,
+ email: Faker::Internet.email,
+ phone: Faker::PhoneNumber.cell_phone,
+ comment: Faker::Lorem.paragraph(sentence_count: 2),
+ organization_id: org.id,
+ address: "#{Faker::Address.street_address} #{Faker::Address.city}, #{Faker::Address.state_abbr} #{Faker::Address.zip_code}",
+ business_name: Faker::Company.name,
+ latitude: rand(-90.000000000...90.000000000),
+ longitude: rand(-180.000000000...180.000000000),
+ created_at: (Time.zone.today - rand(15).days),
+ updated_at: (Time.zone.today - rand(15).days)
+ )
+end
+3.times do
Vendor.create(
contact_name: Faker::FunnyName.two_word_name,
email: Faker::Internet.email,
@@ -700,7 +790,7 @@ def seed_quantity(item_name, organization, storage_location, quantity)
latitude: rand(-90.000000000...90.000000000),
longitude: rand(-180.000000000...180.000000000),
created_at: (Time.zone.today - rand(15).days),
- updated_at: (Time.zone.today - rand(15).days),
+ updated_at: (Time.zone.today - rand(15).days)
)
end
@@ -708,7 +798,8 @@ def seed_quantity(item_name, organization, storage_location, quantity)
# Purchases
# ----------------------------------------------------------------------------
-suppliers = %w(Target Wegmans Walmart Walgreens)
+suppliers = %w[Target Wegmans Walmart Walgreens]
+amount_items = %w[period_supplies diapers adult_incontinence other]
comments = [
"Maecenas ante lectus, vestibulum pellentesque arcu sed, eleifend lacinia elit. Cras accumsan varius nisl, a commodo ligula consequat nec. Aliquam tincidunt diam id placerat rutrum.",
"Integer a molestie tortor. Duis pretium urna eget congue porta. Fusce aliquet dolor quis viverra volutpat.",
@@ -717,27 +808,47 @@ def seed_quantity(item_name, organization, storage_location, quantity)
dates_generator = DispersedPastDatesGenerator.new
-25.times do
- purchase_date = dates_generator.next
- storage_location = StorageLocation.active_locations.sample
- vendor = random_record_for_org(pdx_org, Vendor)
- purchase = Purchase.new(
- purchased_from: suppliers.sample,
- comment: comments.sample,
- organization_id: pdx_org.id,
- storage_location_id: storage_location.id,
- amount_spent_in_cents: rand(200..10_000),
- issued_at: purchase_date,
- created_at: purchase_date,
- updated_at: purchase_date,
- vendor_id: vendor.id
- )
+complete_orgs.each do |org|
+ 25.times do |index|
+ purchase_date = dates_generator.next
+ storage_location = org.storage_locations.active_locations.sample
+ vendor = random_record_for_org(org, Vendor)
+ purchase = Purchase.new(
+ purchased_from: suppliers.sample,
+ comment: comments.sample,
+ organization_id: org.id,
+ storage_location_id: storage_location.id,
+ issued_at: purchase_date,
+ created_at: purchase_date,
+ updated_at: purchase_date,
+ vendor_id: vendor.id,
+ amount_spent_on_period_supplies_cents: rand(0..5_000),
+ amount_spent_on_diapers_cents: rand(0..5_000),
+ amount_spent_on_adult_incontinence_cents: rand(0..5_000),
+ amount_spent_on_other_cents: rand(0..5_000)
+ )
+
+ purchase.amount_spent_in_cents = amount_items.map { |i| purchase.send("amount_spent_on_#{i}_cents") }.sum
- rand(1..5).times do
- purchase.line_items.push(LineItem.new(quantity: rand(1..1000),
- item_id: pdx_org.item_ids.sample))
+ rand(1..5).times do
+ purchase.line_items.push(
+ LineItem.new(quantity: rand(1..1000),
+ item_id: org.item_ids.sample)
+ )
+ end
+
+ # Guarantee that there are at least a few purchases for the items unique to the Second City Bank
+ if (org == sc_org) && (index < 4)
+ purchase.line_items.push(
+ LineItem.new(
+ quantity: rand(1..1000),
+ item_id: sc_org_unique_items[index].id
+ )
+ )
+ end
+
+ PurchaseCreateService.call(purchase)
end
- PurchaseCreateService.call(purchase)
end
# ----------------------------------------------------------------------------
@@ -747,18 +858,19 @@ def seed_quantity(item_name, organization, storage_location, quantity)
Flipper::Adapters::ActiveRecord::Feature.find_or_create_by(key: "new_logo")
Flipper::Adapters::ActiveRecord::Feature.find_or_create_by(key: "read_events")
Flipper.enable(:read_events)
-
+Flipper::Adapters::ActiveRecord::Feature.find_or_create_by(key: "partner_step_form")
+Flipper.enable(:partner_step_form)
# ----------------------------------------------------------------------------
# Account Requests
# ----------------------------------------------------------------------------
# Add some Account Requests to fill up the account requests admin page
-[{ organization_name: "Telluride Diaper Bank", website: "TDB.com", confirmed_at: nil },
- { organization_name: "Ouray Diaper Bank", website: "ODB.com", confirmed_at: nil },
- { organization_name: "Canon City Diaper Bank", website: "CCDB.com", confirmed_at: nil },
- { organization_name: "Golden Diaper Bank", website: "GDB.com", confirmed_at: (Time.zone.today - rand(15).days) },
- { organization_name: "Westminster Diaper Bank", website: "WDB.com", confirmed_at: (Time.zone.today - rand(15).days) },
- { organization_name: "Lakewood Diaper Bank", website: "LDB.com", confirmed_at: (Time.zone.today - rand(15).days) }].each do |account_request|
+[{organization_name: "Telluride Diaper Bank", website: "TDB.com", confirmed_at: nil},
+ {organization_name: "Ouray Diaper Bank", website: "ODB.com", confirmed_at: nil},
+ {organization_name: "Canon City Diaper Bank", website: "CCDB.com", confirmed_at: nil},
+ {organization_name: "Golden Diaper Bank", website: "GDB.com", confirmed_at: (Time.zone.today - rand(15).days)},
+ {organization_name: "Westminster Diaper Bank", website: "WDB.com", confirmed_at: (Time.zone.today - rand(15).days)},
+ {organization_name: "Lakewood Diaper Bank", website: "LDB.com", confirmed_at: (Time.zone.today - rand(15).days)}].each do |account_request|
AccountRequest.create(
name: Faker::Name.unique.name,
email: Faker::Internet.unique.email,
@@ -813,7 +925,7 @@ def seed_quantity(item_name, organization, storage_location, quantity)
# ----------------------------------------------------------------------------
# Counties
# ----------------------------------------------------------------------------
-Rake::Task['db:load_us_counties'].invoke
+Rake::Task["db:load_us_counties"].invoke
# ----------------------------------------------------------------------------
# Partner Counties
@@ -830,16 +942,15 @@ def seed_quantity(item_name, organization, storage_location, quantity)
profile = partner.profile
num_counties_for_partner = Faker::Number.within(range: 1..10)
remaining_percentage = 100
- share_ceiling = 100/num_counties_for_partner #arbitrary, so I can do the math easily
+ share_ceiling = 100 / num_counties_for_partner # arbitrary, so I can do the math easily
county_index = 0
county_ids_for_this_partner = county_ids.sample(num_counties_for_partner)
county_ids_for_this_partner.each do |county_id|
- client_share = 0
- if county_index == num_counties_for_partner - 1
- client_share = remaining_percentage
+ client_share = if county_index == num_counties_for_partner - 1
+ remaining_percentage
else
- client_share = Faker::Number.within(range:1..share_ceiling)
+ Faker::Number.within(range: 1..share_ceiling)
end
Partners::ServedArea.create(
@@ -848,21 +959,25 @@ def seed_quantity(item_name, organization, storage_location, quantity)
client_share: client_share
)
county_index += 1
- remaining_percentage = remaining_percentage - client_share
+ remaining_percentage -= client_share
end
end
# ----------------------------------------------------------------------------
# Transfers
# ----------------------------------------------------------------------------
+from_id, to_id = pdx_org.storage_locations.active_locations.limit(2).pluck(:id)
+quantity = 5
+inventory = View::Inventory.new(pdx_org.id)
+# Ensure storage location has enough of item for transfer to succeed
+item = inventory.items_for_location(from_id).find { _1.quantity > quantity }.db_item
+
transfer = Transfer.new(
comment: Faker::Lorem.sentence,
organization_id: pdx_org.id,
- from_id: pdx_org.id,
- to_id: sf_org.id,
- line_items: [
- LineItem.new(quantity: 5, item: pdx_org.items.first)
- ]
+ from_id: from_id,
+ to_id: to_id,
+ line_items: [ LineItem.new(quantity: quantity, item: item) ]
)
TransferCreateService.call(transfer)
@@ -870,12 +985,33 @@ def seed_quantity(item_name, organization, storage_location, quantity)
# Users invitation status
# ----------------------------------------------------------------------------
# Mark users `invitation_status` as `accepted`
-#
+#
# Addresses and resolves issue #4689, which can be found in:
# https://github.com/rubyforgood/human-essentials/issues/4689
-User.where(invitation_token: nil).each do |user|
+User.where(invitation_token: nil).find_each do |user|
user.update!(
invitation_sent_at: Time.current,
invitation_accepted_at: Time.current
)
-end
\ No newline at end of file
+end
+
+# Guarantee that at least one of the items unique to the Second City Bank has an
+# inventory less than the recommended quantity.
+item_to_make_scarce = sc_org_unique_items.where("on_hand_recommended_quantity > ?", 0).first
+sc_org.storage_locations.each do |location|
+ num_on_hand = location.item_total(item_to_make_scarce.id)
+ if num_on_hand > item_to_make_scarce.on_hand_recommended_quantity
+ num_to_remove = item_to_make_scarce.on_hand_recommended_quantity - 1 - num_on_hand
+ adjustment = sc_org.adjustments.create!(
+ comment: "Ensuring example of item below recommended inventory",
+ storage_location: location,
+ user: User.with_role(:org_admin, sc_org).first
+ )
+ adjustment.line_items = [LineItem.new(
+ quantity: num_to_remove,
+ item: item_to_make_scarce,
+ itemizable: adjustment
+ )]
+ AdjustmentCreateService.new(adjustment).call
+ end
+end
diff --git a/docs/user_guide/bank/account_management.md b/docs/user_guide/bank/account_management.md
index 4ea7fa1792..d1db436693 100644
--- a/docs/user_guide/bank/account_management.md
+++ b/docs/user_guide/bank/account_management.md
@@ -1,26 +1,29 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
# Account Management
## Logging out
You can log out be clicking your name in the top right corner, then clicking 'Log out'.
-[TODO: Navigational screenshot]
-
+
## Account settings
You can change your name, email, and password in account settings. Any of these changes will need your current password.
Click your name in the top right corner, then "Account Settings"
-[TODO: Navigational screenshot]
+
Provide your updated information, including your current password, then click save.
If you want to change your password, you can do it here -- click the Change Password section to show the new password and confirmation fields.
-[TODO: screen shot]
-[TODO: Actually test this out. *I've* never used it.]
+
-Then click save.
+hen click save.
## My organization
-If you are an org admin, you can also manage your organization and users through the top-right menu. This goes to the same screen as clicking on "My Organization" in the left-hand menu. For details, see [Customization](getting_started_customization.md) and [User Management](user_management.md)
-[TODO: Add switching to partner ]
+If you are an org admin, you can also manage your organization and users through the top-right menu, by clicking on your name, then "My Organization"
+
+This goes to the same screen as clicking on "My Organization" in the left-hand menu. For details, see [Customization](getting_started_customization.md#basic-information) and [User Management](user_management.md)
+
+## Switching to another role
+You may have an id that works with multiple banks, or, more commonly, with a bank and a Partner. To switch between these, click on your name in the top right corner, then the name of the organizaation (bank or Partner) that you want to switch to.
+
diff --git a/docs/user_guide/bank/asking_for_changes.md b/docs/user_guide/bank/asking_for_changes.md
index 808d004570..3d6e70f7eb 100644
--- a/docs/user_guide/bank/asking_for_changes.md
+++ b/docs/user_guide/bank/asking_for_changes.md
@@ -1,3 +1,4 @@
+READY FOR REVIEW
# Asking for changes
We welcome ideas for how Human Essentials can support your work better.
diff --git a/docs/user_guide/bank/community_donation_sites.md b/docs/user_guide/bank/community_donation_sites.md
index 9071f62690..8b6b71bad7 100644
--- a/docs/user_guide/bank/community_donation_sites.md
+++ b/docs/user_guide/bank/community_donation_sites.md
@@ -1,23 +1,24 @@
+READY FOR REVIEW
# Donation Sites
-Donation sites are places where people drop off donations.
+Donation Sites are places where people drop off Donations.
-## The donation site list
+## The Donation Site list
You can manage the sites' information on the "Donation Sites" page under the "Community" section.
-Previously recorded information about donation sites appears on this page including the name of the donation site name, address, contact name, e-mail and phone number.
+Previously recorded information about Donation Sites appears on this page including the name of the Donation Site name, address, contact name, e-mail and phone number.
### Adding a Donation Site
-Create a new site by populating the donation site, address, contact name, e-mail and phone fields and clicking the "Create" button.
+Create a new site by populating the Donation Site, address, contact name, e-mail and phone fields and clicking the "Create" button.
-Note that the donation site and address fields are mandatory while the contact name, email and phone are optional.
+Note that the Donation Site and address fields are mandatory while the contact name, email and phone are optional.
-You can also use the "+ New Donation Site" button which renders a form for you to fill in details of a new donation site.
+You can also use the "+ New Donation Site" button which renders a form for you to fill in details of a new Donation Site.
@@ -26,19 +27,19 @@ After saving the site's details there will be a new row on the Donation Sites pa
## Viewing Donation Site information
-Clicking on the "view" button beside a donation site will show detailed information for that site, including the donation site name, address, contact name, e-mail, phone number, storage location. It also shows a list of the donations for that site including the quantity of items and variety of items. You can drill down to see the full details of each donation by clicking "View donation details".
+Clicking on the "view" button beside a Donation Site will show detailed information for that site, including the Donation Site name, address, contact name, e-mail, phone number, storage location. It also shows a list of the Donations for that site including the quantity of items and variety of items. You can drill down to see the full details of each Donation by clicking "View Donation details".
## Editing Donation Site information
-Clicking on the "Edit" button beside a donation site in the donation site list lets you edit the name, address, contact name, email and phone number.
+Clicking on the "Edit" button beside a Donation Site in the Donation Site list lets you edit the name, address, contact name, email and phone number.
## Deactivating a Donation Site
-Use the "Deactivate" button to delete information about a donation site that is no longer active.
+Use the "Deactivate" button to hide a Donation Site that is no longer active.
##### (NB) at time of writing there is no way for you to undo this.
@@ -46,7 +47,7 @@ Use the "Deactivate" button to delete information about a donation site that is
## Exporting Donation Sites
-You can export the active donation sites by clicking on the "Export Donation Sites" button. This will provide a .csv file containing the name, address, and contact information for each active donation site.
+You can export the active Donation Sites by clicking on the "Export Donation Sites" button. This will provide a .csv file containing the name, address, and contact information for each active Donation Site.
diff --git a/docs/user_guide/bank/community_manufacturers.md b/docs/user_guide/bank/community_manufacturers.md
index 61c3011dfc..9e036d9005 100644
--- a/docs/user_guide/bank/community_manufacturers.md
+++ b/docs/user_guide/bank/community_manufacturers.md
@@ -1,25 +1,26 @@
+READY FOR REVIEW
# Manufacturers
-The Manufacturers page under the "Community" section lets you track donations from manufacturers.
+The Manufacturers page under the "Community" section lets you manage your Manufacturers and track donations from them.
-It shows the name and total items donated by a manufacturer.
+It shows the name and total Items donated by a Manufacturer.
### Adding a manufacturer
-Click on the "+ New Manufacturer" button, to add the manufacturer's name.
+Click on the "+ New Manufacturer" button, to add the Manufacturer's name.
-## Viewing manufacturer information
+## Viewing Manufacturer information
-Click on "View" for more details about the manufacturer which shows the date of each donation, volume (total items in the donation), and lets you view the full details of each donation.
+Click on "View" for more details about the Manufacturer which shows the date of each donation, volume (total items in the donation), and lets you view the full details of each donation.
## Editing manufacturer information
-Click the "Edit" button to edit the manufacturer's name.
+Click the "Edit" button to edit the Manufacturer's name.
[Prior: Vendors](community_vendors.md)[Next: Exports](exports.md)
\ No newline at end of file
diff --git a/docs/user_guide/bank/community_product_drive_participants.md b/docs/user_guide/bank/community_product_drive_participants.md
index 48e00f18a7..a4f2b39051 100644
--- a/docs/user_guide/bank/community_product_drive_participants.md
+++ b/docs/user_guide/bank/community_product_drive_participants.md
@@ -1,12 +1,13 @@
+READY FOR REVIEW
# Product Drive Participants
-If you conduct product drives, the product drive participants list lets you manage the participant's contact information and see their donation history.
+If you conduct Product Drives, the Product Drive Participants list lets you manage the participant's contact information and see their Donation history.
-To manage product drive participants, click on "Product Drive Participants" under the "Community" section.
+To manage Product Drive Participants, click on "Product Drive Participants" under the "Community" section.
-This page lists some basic details from all previously entered product drive participants -- business, contact, phone email, and total items, letting you drill down to more information, or to edit each participant's information.
+This page lists some basic details from all previously entered Product Drive Participants -- business, contact, phone email, and total items, letting you drill down to more information, or to edit each participant's information.
## Adding participants
@@ -16,13 +17,12 @@ To add a new participant, click on the "+ New Product Drive Participant" button,
After saving the participant's details there will be a new row in the Product Drive Participants page.
-You can also add new participants "on the fly" as you enter the donations, through the [New Donation](essentials_donations.md) page.
+You can also add new participants "on the fly" as you enter the donations, through the [New Donation](essentials_donations.md#new-donations) page.
-[TODO: link to new donations ]
## Viewing participant information
-Click on "View" for more details about the product drive participant which also shows the date of each donation, volume, and donations details.
+Click on "View" for more details about the Product Drive Participant which also shows the date of each Donation, volume, and Donation details.
@@ -34,7 +34,7 @@ Click the "Edit" button to edit the participant's details.
## Exporting participants
-You can export all the participants by clicking on the "Export Product Drive Paticipants" button.
+You can export all the participants by clicking on the "Export Product Drive Participants" button.
Currently we are not providing all the participants' details in the export.
diff --git a/docs/user_guide/bank/community_product_drives.md b/docs/user_guide/bank/community_product_drives.md
index 25d4eaf939..2b22258a70 100644
--- a/docs/user_guide/bank/community_product_drives.md
+++ b/docs/user_guide/bank/community_product_drives.md
@@ -1,65 +1,57 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
# Product Drives
-Many banks hold seasonal or one-off events where they are seeking donations. In Human Essentials, Product drives help manage those events by providing a way to link specific donations to the events.
+Many banks hold seasonal or one-off events where they are seeking Donations. In Human Essentials, Product Drives help manage those events by providing a way to link specific Donations to the events.
-[TODO: For consistency, I would remove 'New Product Drive' from the lhs, and change "All Product Drives" to "Product Drives]
+## Product Drives list
+To see all your Product Drives, click on "Community", then "All Product Drives" in the left-hand menu.
-## Product drives list
-To see all your product drives, click on "Community", then "All Product Drives" in the left-hand menu.
+
-This presents a filterable list of all your product drives, including the following fields:
+
+This presents a filterable list of all your Product Drives, including the following fields:
- Product Drive Name
- Start Date
- End Date (this is optional)
- Held Virtually?
- Quantity of Items
- Variety of Items
-- In-Kind Value (TODO: Fix spelling in header)
+- In-Kind Value
- Actions (only view at the moment)
-The list initially shows all the product drives starting in the current year.
-
-[TODO: NAvigation screenshot]
-
-
+The list initially shows all the Product Drives that are at least partly in our default period of 60 days past to 30 days in the future.
-[TODO: Is that right, or is it all product drives that are at least partly in the current year? It probably should be the latter]
-
-### Filtering you product drives list
-The product drives list is filterable by any of the following.
-- Product drive name
-- Item category
+### Filtering your Product Drives list
+The Product Drives list is filterable by any of the following.
+- Product Drive name
+- Item Category
- Date range (by starting date)
-[TODO: confirm how the date range works.]
-
Provide the information you want to filter by, then click "Filter". Clicking "Clear Filters" will return the list to its defaults.
-## Adding a product drive
-To add a product drive, either:
+## Adding a Product Drive
+To add a Product Drive, either:
a) click "Community", then "New Product Drive" in the left hand menu, or
b) click "+New Product Drive" in the Product Drives list
-[TODO: Navigation screenshot]
+
-Either will bring up this screen, which contains all the fields you can specify for a new product drive:
+Either will bring up this screen, which contains all the fields you can specify for a new Product Drive:
- Name
- Start Date
- End Date (this is optional)
- Product Drive is Virtual? (check this if it's a virtual drive)
-[TODO: Screenshot]
-[TODO: Styling of "Create product drive" -- button should be white on green]
+
-## Viewing your product drive
-To view a specific product drive, click the "View" button beside it in the product drives list.
-[TODO: Navigational Screenshot]
-[TODO: Screenshot]
-This will bring up the product drive view, which includes informtation about both the donations for the product drive, and the participants in the drive, in addition to the basic information about the product drive itself.
+## Viewing a Product Drive
+To view a specific Product Drive, click the "View" button beside it in the Product Drives list.
+
+
+This will bring up the Product Drive view, which includes information about both the Donations for the Product Drive, and the participants in the drive, in addition to the basic information about the drive itself.
+
Basic info:
- Name
- Start Date
- End Date
-[TODO: Move the "Make a correction" button up to below the basic information, not below the donations]
Information about each donation:
- Donation ID -- this is a number the system applies to each donation
- Product Drive Participant
@@ -72,25 +64,27 @@ For each product drive participant associated with this product drive:
- Phone
- Email
- Address
-- Items for this Drive (number of items for this drive)
+- Items for this drive (number of Items for this drive)
- Total Items (for all drives)
- Comment
-You can also make a correction to your product drive or delete it from this page.
+You can also make a correction to your Product Drive or delete it from this page.
+
+[!CAUTION] DO NOT DELETE your Product Drive if it has Donations in it. It will not go well. We have an outstanding issue to block you doing that.
-#### NB -- DO NOT DELETE your product drive if it has donations in it. It will not go well.
+## Modifying your Product Drive
+If you want to edit the base information in a Product Drive, you can do that by clicking "Community", then "All Product Drives" in the left-hand menu, then clicking "View" beside the product drive you wish to modify, and then clicking "Make a correction".
+
-## Modifying your product drive
-If you want to edit the base information in a product drive, you can do that by clicking "Community", then "All Product Drives" in the left-hand menu, then clicking "View" beside the product drive you wish to modify, and then clicking "Make a correction".
-This will bring up the basic information for your product drive, You can rename it, change the dates, or change whether it is a virtual drive.
-Then click "Update Product drive" to save your changes.
+This will bring up the basic information for your Product Drive, You can rename it, change the dates, or change whether it is a virtual drive.
+Then click "Update Product Drive" to save your changes.
-[TODO: Screenshot]
+
-## Exporting product drives
-To export your currently filtered product drives, click "Export product drives" on the Product Drives List
+## Exporting Product Drives
+To export your currently filtered Product Drives, click "Export Product Drives" on the Product Drives List
+
-[TODO: Navigation Screenshot]
[Prior: Transfers](inventory_transfers.md)
[Next: Product Drive Participants](community_product_drive_participants.md)
\ No newline at end of file
diff --git a/docs/user_guide/bank/community_vendors.md b/docs/user_guide/bank/community_vendors.md
index 35d18a5988..8d7fb96253 100644
--- a/docs/user_guide/bank/community_vendors.md
+++ b/docs/user_guide/bank/community_vendors.md
@@ -1,43 +1,40 @@
+READY FOR REVIEW
# Vendors
-The vendors list lets you manage vendor contact information and view your purchases from each. To access it, click on "Vendors" under the "Community" section.
+The Vendors list lets you manage Vendor contact information and view your Purchases from each Vendor. To access it, click on "Vendors" under the "Community" section.
-This page shows all previously entered vendors -- business name, contact name, phone, email, and total items -- and lets you view or edit them.
+This page shows all previously entered Vendors -- business name, contact name, phone, email, and total items -- and lets you view or edit them.
-## Adding vendors
+## Adding Vendors
-To add a new vendor, click on the "+ New Vendor" button, add their details including the business name, contact name, phone, email, and address.
+To add a new Vendor, click on the "+ New Vendor" button, add their details including the business name (mandatory), contact name, phone, email, and address.
-
+
-You must enter at least one of business name or contact name. We recommend that you enter the business name, as this is used when selecting the vendor on entering purchases.
+
-
+After saving the Vendor's details there will be a new row in the Vendors page.
-After saving the vendor's details there will be a new row in the Vendors page.
+You can also add a new Vendor "on the fly" as you enter the Purchases, through the [New Purchase](essentials_purchases.md#entering-a-new-purchase) page.
-You can also add a new vendor "on the fly" as you enter the purchases, through the [New Purchase](essentials_purchases.md) page.
+## Viewing Vendor information
-[TODO: link to New Purchase section of essentials purchases]
-
-## Viewing vendor information
-
-Click on "View" for more details about the vendor which also shows the date of each purchase, volume (total items in the purchase), and lets you view the full details of each purchase.
+Click on "View" for more details about the Vendor which also shows the date of each Purchase, volume (total items in the Purchase), and lets you view the full details of each Purchase.
## Editing vendors
-Click the "Edit" button to edit the vendor's contact information.
+Click the "Edit" button to edit the Vendor's contact information.
## Exporting vendors
-You can export all the vendors by clicking on the "Export Vendors" button.
-Currently we are only providing the vendors' contact information in the export.
+You can export all the Vendors by clicking on the "Export Vendors" button.
+Currently we are only providing the Vendors' contact information in the export.
diff --git a/docs/user_guide/bank/essentials_dashboard.md b/docs/user_guide/bank/essentials_dashboard.md
index 02fb21ab7d..c21988c405 100644
--- a/docs/user_guide/bank/essentials_dashboard.md
+++ b/docs/user_guide/bank/essentials_dashboard.md
@@ -1,29 +1,28 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
# Your Dashboard
When you log in, your initial screen will be a dashboard with information that is useful on a daily basis for most banks.
If you haven't finished setting up your bank in the system, the "getting started" steps (as described in an earlier section) will appear.
-Otherwise, there are 4 sections to the dashboard: announcements, outstanding requests, partner approvals, and bank-wide low inventory.
+Otherwise, there are 4 sections to the dashboard: Announcements, Outstanding Requests, Partner Approvals, and Bank-wide Low Inventory.
#### Announcements
-This section is announcements from the human resources team. This is where we tell you what changes there have been in the latest release, and let everyone know about any significant issues with the system that affect everybody (with workarounds, if we can.)
+This section contains announcements from the Human Essentials team. This is where we tell you what changes there have been in the latest release, and let everyone know about any significant issues with the system that affect everybody (with workarounds, if we can.)
Look for new info here every Monday - as we put out new releases most Sunday mornings.
#### Outstanding Requests
This is pretty much what it sounds like - a list of the requests from your partners that have not yet been fulfilled. You can bring up the details of each request by clicking on the date.
-
#### Partner Approvals
-This lists the partner profiles that have been submitted for approval. Partners can not submit requests until they have been approved. To review the application, click on the "Review Applicant's Profile" button beside the partner in the Action column. For more details on that, see [Approving a partner](pm_approving_a_partner.md)
+This lists the Partner Profiles that have been submitted for approval. Partners can not submit requests until they have been approved. To review the application, click on the "Review Applicant's Profile" button beside the partner in the Action column. For more details on that, see [Approving a partner](pm_approving_a_partner.md)
#### Bank-wide Low Inventory
-This lists items whose *bank-wide* inventory has fallen below the recommended or minimum quantity levels you have set on the items. If the item's level in inventory across the bank has fallen below the minimum quantity, it will appear in red.
+This lists Items whose *bank-wide* inventory has fallen below the recommended or minimum quantity levels you have set on the items. If the item's level in inventory across the bank has fallen below the minimum quantity, it will appear in red.
-For help on setting those levels, see [Inventory Items](inventory_items.md). If you haven't set those levels, the items will not appear on this list, even if you have no inventory.
+For help on setting those levels, see [Inventory Items](inventory_items.md). If you haven't set those levels, the Items will not appear on this list, even if you have no inventory.
[Prior: User management](getting_started_user_management.md) [Next: Donations](essentials_donations.md)
\ No newline at end of file
diff --git a/docs/user_guide/bank/essentials_distributions.md b/docs/user_guide/bank/essentials_distributions.md
index b992451cf7..1d05dd47e3 100644
--- a/docs/user_guide/bank/essentials_distributions.md
+++ b/docs/user_guide/bank/essentials_distributions.md
@@ -1,61 +1,68 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
+
# Distributions
Distributions are where you record what you allocate to your partner agencies.
Some things to know:
-* Once you save a distribution, those items are allocated to the partner, and are no longer part of your inventory in the system.
-* If you are accepting requests from partners, you initiate the distribution by "fulfilling" the partner request. (see [Requests](essentials_requests.md))
-
-## Seeing a list of your distributions
-To view a list of your distributions, click on 'Distributions' in the left hand menu. This brings up a list of all your distributions for the current year. You can change what distributions are displayed using the distribution filters at the top of the list.
+* Once you save a Distribution, those items are allocated to the Partner, and are no longer part of your inventory in the system.
+* If you are accepting Requests from partners, you initiate the Distribution by "fulfilling" the Partner's Request. (see [Requests](essentials_requests.md#fulfilling-a-request))
+## Seeing a list of your Distributions
+To view a list of your Distributions, click on 'Distributions' in the left hand menu. This brings up a list of all your Distributions for the default period of 60 days in the past, 30 days in the future. You can change what Distributions are displayed using the filters at the top of the list.
+
-### Filtering the distribution list
+### Filtering the Distribution list
-[TODO: Insert mini screenshot of just the filtration section here]
+Your Distribution list may grow to the point that you really need to be able to narrow things down to find a particular Distribution.
-When you have been using human essentials for a few months, your distribution list may grow to the point that you really need to be able to narrow things down to find a particular distribution.
+To help with that, you can filter the Distribution list by several aspects: Item, Item Category, Partner, source inventory (i.e. Storage Location), status, and date range.
+If you pick several things, you will get only the Distributions that match all of them.
-To help with that, you can filter the distribution list by several aspects: item, item category, partner, source inventory (i.e. storage location) and distribution status, and date range.
-If you pick several things, you will get only the distributions that match all of them.
+
-Except for date range, all the filters are specified by picking from a drop-down list as follows
-Item: all active items (TODO: Confirm -- is it just active or are the inactives there too?). This will filter to only the distributions that contained that item.
-Item category: Item categories (as specified in [Items & Inventory | Item Categories](inventory_items.md)) [TODO: point right to categories section]. This will filter the list to the distributions that contain items that are in the chosen item category.
-Partner: This will filter the lists to just the distributions to the chosen partner.
-Source Inventory: This will limit the list to the distributions from the chosen storage location.
-Status: Distributions can be Scheduled or Complete. This will limit the list to those with the given status.
-Date range: This is based on the "Distribution date and time" field, ignoring the time. Date range is selected using a little calendar gizmo with several presets, or by typing the date range into the field. We highly recommend using the calendar gizmo instead of typing in the field, as the text field is very particular as to the format - we have a few people experiencing mismatches there every month.
+Except for date range, all the filters are specified by picking from a drop-down list as follows:
+- Item: all of your bank's Items. This will filter to only the distributions that contain that Item.
+- Item Category: Item Categories (as specified in [Items & Inventory | Item Categories](inventory_items.md)). This will filter the list to the distributions that contain items that are in the chosen item category.
+- Partner: This will filter the lists to just the distributions to the chosen partner.
+- Source Inventory: This will limit the list to the distributions from the chosen storage location.
+- Status: Distributions can be Scheduled or Complete. This will limit the list to those with the given status.
+- Date range: This is based on the "Distribution date and time" field, ignoring the time. Date range is selected using a little calendar gizmo with several presets, or by typing the date range into the field. We highly recommend using the calendar gizmo instead of typing in the field, as the text field is very particular as to the format - we have a few people experiencing mismatches there every month.
-When you have have selected your filters, press "Filter" to do the filtering. If you still have too many distributions showing, you can add another filter to narrow it down further.
+When you have have selected your filters, press "Filter" to do the filtering. If you still have too many Distributions showing, you can add another filter to narrow it down further.
-Clicking "Clear filters" will blank out the filters that are drop-down selection, and revert the date range to the current year.
+Clicking "Clear filters" will blank out the filters that are drop-down selection, and revert the date range to the default period.
## New Distribution
-To enter a new distribution, click on "New Distribution" in the Distributions list.
+To enter a new Distribution, click on "New Distribution" in the Distributions list.
-Here, you will enter some information about the whole distribution, then add the all the items that make it up.
+Here, you will enter some information about the whole Distribution, then add the all the items that make it up.
The fields include:
- Partner (mandatory)
- Distribution date and time -- this is defaulted to midnight of the current day. If you want to change it (if, for example, you have a specific time you are scheduling the pickup for), we recommend you use the little calendar gizmo at the right of the field.
- [question: does send email reminder the day before appear based on an organization flag?]
+
- Send email reminder the day before --> causes an email to be sent the day before
- [question: what happens if we check this and it's today?]
-- Agency representative - for information only [TODO: is this defaulted from the chosen partner? It could be.. but do we?]
+
+- Agency representative - for information only. This is defaulted to the email of the person who sent the request.
- Delivery method -- we default this to pickup because it's the most common across banks.
-- From storage location: The storage location the distribution is coming from. Obviously mandatory.
+- From storage location: The storage location the distribution is coming from. Mandatory.
- Comment
- All the items:
-- For each item:
- - If you have set up barcodes for items, you can just boop the item in. Otherwise, select the item from the list, and enter the quantity
- - [TODO: Totally rewrite this bit for packs]
-## Exporting Distributions
-To export your distributions, click "Export Distributions" on the distributions view. This will include all the top-level information, and a column [or more, if you use custom units] for each item in the distribution, in alphabetic order. It will include all the distributions within the filter you have already applied.
-[TODO: add navigational screenshot and sample csv]
+ - For each item:
+ - If you have set up Barcodes for Items, you can just 'boo'p' the item in. Otherwise, select the Item from the list, and enter the quantity
+ ## Exporting Distributions
+To export your Distributions, click "Export Distributions" on the distributions view.
+
+
+
+This will include all the top-level information, and a column [or more, if you use custom units] for each Item in the distribution, in alphabetic order. It will include all the Distributions within the filter you have already applied.
+
+
## Viewing a Distribution
-To view a distribution, click "view" beside it in the distributions view.
+To view a Distribution, click "view" beside it in the distributions view.
+
+
This includes the following fields:
- distribution id (for our reference for support) ,
- Source location (the storage location the inventory came from),
@@ -63,26 +70,43 @@ This includes the following fields:
- Delivery method (pickup delivery or shipped),
- Shipping cost (if shipped),
- Comments, and
-- the current status.
- [TODO: add screenhot of view]
- [TODO: check -- do we use "state" throughout -- I feel like we probably use "status"]
+- the current status, as well as
+- a breakdown of the items in the view including
+ - Item name
+ - Value per Item
+ - Total value
+ - Quantity
+ - Package count (only if you have defined a package size for the Item)
+
+
+
+You can mark the Distribution "complete", or make a correction (which brings up the edit page, below) from this page.
+
## Editing a Distribution
-To edit a distribution, click on "Edit" beside the distribution in the list, or on "Make a Correction" in the view.
+To edit a Distribution, click on "Edit" beside the Distribution in the list, or on "Make a Correction" in the view.
+
+
+[!NOTE] When you edit a Distribution -- if is was in the past, you will see a warning to that effect -- because we assumed that you wouldn't normally need to change the Distribution once it had been put together! Some banks will add things when the Partners come to pick up the distributions, based on additional needs and/or supply opportunities.
+However, We will give you a stern warning if there has been an Audit since the Distribution was entered, and you may be prevented from changing some Distribution information (such as the storage location), because we just don't know how to handle some of those cases.
-If the distribution is in the past, you will see a warning to that effect -- because we assumed that you wouldn't normally need to change the distribution once it had gone out the door!
-We will give you a stern warning if there has been an audit since the distribution was entered, and you may be prevented from changing some distribution information (such as the storage location), because we just don't know how to handle some of those cases.
-[TODO: More writing about the PACKS version]
-[TODO: screenshot]
+
## Printing a Distribution
-Printing a distribution produces an invoice-like page that can be used as a packing slip.
+Printing a Distribution produces an invoice-like page that can be used as a packing slip.
+
+
+
-It is somewhat configurable -- there are options on your [Organization](getting_started_customization.md) page to allow you to: a) add a place for a signature, or b) hide certain columns in the printout.
-[TODO: point that at the exact location in the document]
+This is the same pdf that is emailed to the Partner when a new Distribution is saved.
+[!NOTE] The partner does not get a new email when you edit a Distribution, so you may want to print the Distribution to send them in that case.
-Please note that your logo (also configurable on the organization, above) is included on this printout -- we strongly advice keeping it fairly small, as a large logo will just be resized anyway, and will potentially break this function.
+The printout is somewhat configurable -- there are options on your [Organization](getting_started_customization.md#customizing-the-distribution-printout) page to allow you to: a) add a place for a signature, or b) hide certain columns in the printout.
+
+Please note that your logo (also configurable on the [Organization](getting_started_customization.md#logo) ) is included on this printout -- we strongly advice keeping it fairly small, as a large logo will just be resized anyway, and will potentially break this function.
## Reclaiming a Distribution
-What do you do if, for some reason, the distribution that was entered was not picked up? You can reclaim it, adding the items back into your inventory.
-To do this, click "Reclaim" beside the distribution in question.
-NOTE: You can not reverse a reclaim. If you do it by accident, you will have to re-enter the distribution.
+What do you do if, for some reason, the Distribution that was entered was not picked up? You can reclaim it, adding the items back into your inventory.
+To do this, click "Reclaim" beside the Distribution in question, and cliock "Ok" in the confirmation screen that appears.
+
+[!WARN] You can not reverse a reclaim. If you reclaim by accident, you will have to re-enter the Distribution. If that happens, you should be able to grab the Item quantities from the [History Report](reports_history.md), but we don't retain the rest of the information.
+
[Prior: Requests](essentials_requests.md)[Next: Pick Ups and Deliveries](essentials_pick_ups.md)
\ No newline at end of file
diff --git a/docs/user_guide/bank/essentials_donations.md b/docs/user_guide/bank/essentials_donations.md
index d1feb1f0f2..0737967741 100644
--- a/docs/user_guide/bank/essentials_donations.md
+++ b/docs/user_guide/bank/essentials_donations.md
@@ -1,24 +1,25 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
+
# Donations
-Donations are obviously one of the most important elements of an essential bank's operations, being the primary way most banks get the goods to distribute to their partners to help folk.
+Donations are obviously one of the most important elements of an Essential Bank's operations, being the primary way most banks get the goods to distribute to their partners to help folk.
-In Human Essentials you enter in-kind donations by specifying where they came from, where they are being stored, and how many of each item are included. You can also record monetary or mixed donations.
+In Human Essentials you enter in-kind donations by specifying where they came from, where they are being stored, and how many of each item are included. You can also record monetary or mixed Donations.
-## Seeing all your donations
+## Seeing all your Donations
-To view a list of all your donations, click on 'Donations', then "All Donations" in the left-hand menu,
+To view a list of all your Donations, click on 'Donations', then "All Donations" in the left-hand menu, This defaults to a list of the donations made in the default period of 60 days in the past to 30 days in the future.
-This screen includes a filter so you can narrow down your search to a particular donation, and some basic information on each donation:
-- Source -- Whether this comes from a [Product Drive](product_drives.md), Manufacturer, Donation Site, or Miscellaneous Donation
-- Date -- The date of the donation
-- Details -- this depends on the source -- it is the name of the product drive, or manufacturer, or donation site
-- Storage location -- where you are stored the goods from this donation.
-- Quantity of items -- total quantity of the items in the donation.
+This screen includes a filter so you can narrow down your search for a Donation, and some basic information on each Donation:
+- Source -- Whether this comes from a [Product Drive](product_drives.md), [Manufacturer](community_manufacturers.md), [Donation Site](community_donation_sites.md), or Miscellaneous Donation
+- Date -- The date of the Donation
+- Details -- this depends on the source -- it is the name of the Product drive, or Manufacturer, or Donation site
+- Storage location -- where the goods from this Donation are stored.
+- Quantity of items -- total quantity of the Items in the Donation.
- Money raised - in dollars.
-- In Kind value -- this is calculated by multiplying the number of each item by the current fair market value of that item (entered in [Inventory | Items](inventory_items.md) )
+- In-Kind value -- this is calculated by multiplying the quantity of each Item by the current fair market value of that Item (entered in [Inventory | Items](inventory_items.md) )
- Comments
- Actions - you can view or print donations from this screen. Other actions are available on the view screen.
@@ -27,82 +28,84 @@ This screen includes a filter so you can narrow down your search to a particular
-When you have been using human essentials for a few months, your donation list may grow to the point that you really need to be able to narrow things down to find a particular donation.
+When you have been using Human Essentials for a few months, your Donation list may grow to the point that you want to narrow things down to find a particular donation quickly.
-To help with that, you can filter the donation list by several aspects: storage location, source, product drive, product drive participant, manufacturer, donation site, and date range.
+To help with that, you can filter the Donation list by several aspects: Storage Location, source, Product Drive, Product Drive Participant, Manufacturer, Donation Site, and date range.
Except for date range, all the filters are specified by picking from a drop-down list.
-Date range is selected using a little calendar gizmo with several presets. We highly recommend using the calendar gizmo instead of typing in the field, as the text field is very particular as to the format - we have a few people experiencing mismatches there every month.
+Date range is selected using a little calendar gizmo with several presets. We recommend using the calendar gizmo instead of typing in the field, as the text field is very particular as to the format - we have a few people experiencing mismatches there every month.
-When you have have selected your filters, press "Filter" to do the filtering. If you still have too many donations showing, you can add another filter to narrow it down further.
+When you have have selected your filters, press "Filter" to do the filtering. If you still have too many Donations showing, you can add another filter to narrow it down further.
-Clicking "Clear filters" will blank out the filters that are drop-down selection, and revert the date range to the current year.
+Clicking "Clear filters" will blank out the filters that are drop-down selection, and revert the date range to the default period.
## New Donations
-To enter a new donation, click "Donations", then "New Donation" on the left hand menu, or click the +New Donation button on the Donations list.
+To enter a new Donation, click "Donations", then "New Donation" on the left hand menu, or click the +New Donation button on the Donations list.
-Here you can enter all the information for your donation:
+Here you can enter all the information for your Donation:
- Source
- - What kind of donation this is. You have a choice of product drive, donation site, manufacturer or misc. donation. If you pick anything but misc. donation, you will be prompted for more details.
+ - What kind of Donation this is. You have a choice of Product Drive, Donation Site, Manufacturer or Misc. Donation. If you pick anything but Misc. Donation, you will be prompted for more details.
- Storage Location
- Money raised in dollars (optional)
- Comment (optional)
- Issued On
- - This is the date that the donation was made. Note that inventory changes happen as of when you enter the information. They are not back-dated.
-- Items in this donation
- - If you have set up [barcodes ](inventory_barcodes.md) for the items you are receiving, you can use your barcode reader to enter your items. Otherwise, pick the item from "Choose an item", and enter the number of that item in "Quantity".
- - Click "add another item" as needed to get room for more items.
+ - This is the date that the Donation was made. Note that inventory changes happen as of when you enter the information. They are not back-dated.
+- Items in this Donation
+ - If you have set up [barcodes ](inventory_barcodes.md) for theIitems you are receiving, you can use your barcode reader to enter your Items. Otherwise, pick the Item from "Choose an item", and enter the number of that Item in "Quantity".
+ - Click "Add Another Item" as needed to get room for more Items.
When you are finished entering your information, click 'Save'.
### Information entered in Donations
#### Source
-Here you specify what kind of source the donation originated from.
+Here you specify what kind of source the Donation originated from.
For Product Drive, Manufacturer, or Donation Site, you will further specify the specific source.
##### *Product Drive
-If you specify Product drive, you'll also need to specify the particular drive and participant for the donation -- but you can enter them "on the fly", here. You can view summaries for the product drives in [Product Drives](product_drives.md), and manage the contact info for a product drive participant under [Community | Product Drive Participants](community_product_drive_participants.md).
+If you specify Product drive, you'll also need to specify the particular drive and participant for the Donation -- but you can enter them "on the fly", here. You can view summaries for the Product Drives in [Product Drives](product_drives.md), and manage the contact info for a Product Drive Participant under [Community | Product Drive Participants](community_product_drive_participants.md).
##### *Donation Site
Donation Site is meant to capture the concept of any place you have a more-or-less permanent place people can drop off donations at, such as your main office, or community locations such as fire halls, etc.
-You can see the donations for each donation site and manage their contact information under [Community|Donation Sites](community_donation_sites.md). Unlike product drives, you can't create a new donation site 'on the fly' through the fields here.
-
+You can see the Donations for each Donation Site and manage their contact information under [Community|Donation Sites](community_donation_sites.md). Unlike Product Drives, you can't create a new Donation Site 'on the fly' through the fields here
##### *Manufacturer
-This is for the donations that come straight from the manufacturer. You can view the total donations and a donation breakdown for each manufacturer under [Community | Manufacturers](community_manufacturers.md)
+This is for the donations that come straight from a Manufacturer. You can view a breakdown of the Donations for each Manufacturer under [Community | Manufacturers](community_manufacturers.md)
##### *Misc. Donation
-Misc. Donation is a catch-all for any donation without an identified source.
+Misc. Donation is a catch-all for any Donation without an identified source.
#### Storage Location
-Pick the storage location the donation is going to. If it will be split among multiple locations, you can either enter separate donations, or enter the donation using one location, then use the [Inventory | Transfers] function to move the appropriate inventory to other locations.
+Pick the Storage Location the Donation is going to. If it will be split among multiple locations, you can either enter separate Donations, or enter the Donation using one location, then use the [Inventory | Transfers] function to move the appropriate inventory to other locations.
#### Money raised in dollars
-Self explanatory. This number is used in the Annual Survey, and the Donations - Summary report as well as being shown in the main Donations page.
+This number is used in the Annual Survey, and the Donations - Summary report as well as being shown in the main Donations page.
#### Issued On
-This is the date we use for any and all date filtering that you might do on donations. It is meant to be the date that you received the donation. It defaults to the current date.
+This is the date we use for any and all date filtering that you might do on Donations. It is meant to be the date that you received the Donation. It defaults to the current date.
#### Items in this donation
-There are a couple of ways to get items into the donation quickly:
-(1)You can "bloop" a barcode in to get your items into the system -- that requires some initial setup, as detailed in [Inventory | Barcodes] or (2) You can pick the item from the drop-down of all *active* items in your system, and enter the quantity of that item.
+There are a couple of ways to get Items into the donation quickly:
+(1) You can "bloop" a barcode -- that requires some initial setup, as detailed in [Inventory | Barcodes], or
+(2) You can pick the item from the drop-down of all *active* items in your system, and enter the quantity of that item.
+
In either case, you can click "Add Another Item" (3) to open up another item for entry, or "Remove" (4) if you've added too many!
-The quantity here is meant to be individual items (e.g. diapers), rather than packs. The reason behind this is that, ultimately, your reporting will be based on the number of individual items, and package size is inconsistent across manufacturers.
-Note: If you make two entries with the same item, they will be added together when you view them later.
+The quantity here is meant to be individual items (e.g. diapers), rather than packs. The reason behind this is that, ultimately, your reporting will be based on the number of individual items, and package size is inconsistent across brands.
+
+Note: If you make two entries with the same Item, they will be added together when you view them later.
-When you are done entering your items, click "Save". Barring any errors, this will return you to the "All Donations" page
+When you are done entering your Items, click "Save". Barring any errors, this will return you to the "All Donations" page
-## Viewing the details of a donation
-To view the details of a donation, click on the "View" button beside the donation on the All Donations page.
+## Viewing the details of a Donation
+To view the details of a Donation, click on the "View" button beside the donation on the All Donations page.
-Here you'll see the donation, including:
+Here you'll see the Donation, including:
- Date
- Source
- Donation Site
@@ -115,26 +118,26 @@ Here you'll see the donation, including:
- Total in-kind value
- Comment
-You can make a correction, to delete the donation, to print it. You can also start a new distribution from this page. (This is a convenience for banks that distribute the bulk of their donations immediately, and don't fulfill partner requests.)
+You can make a correction, or delete the Donation, or print it. You can also start a new Distribution from this page. (This is a convenience for banks that distribute the bulk of their Donations immediately, and don't fulfill Partner Requests.)
-## Editing a donation
-Donations shouldn't need to be updated very often -- you usually have all the information you need when you enter them the first time. Differences in the physical count, or new information may occasion a need for a correction, though. If you need to correct a donation, you first "View" it (see above), then "Make a Correction"
+## Editing a Donation
+Donations shouldn't need to be updated very often -- you usually have all the information you need when you enter them the first time. Differences in the physical count, or new information may occasion a need for a correction, though. If you need to correct a Donation, you first "View" it (see above), then "Make a Correction"
-Here, you can change all the information on the donation, including adding and removing items.
+Here, you can change all the information on the Donation, including adding and removing items.
-##### Note that changes you make to the levels of items will take effect as of the date you made the changes. They will not be back-dated to the "issued on" date
+##### Note that changes you make to the levels of Items will take effect as of the date you made the changes. They will not be back-dated to the "issued on" date
-##### Note also that donations do not currently work well with kits. We have an open issue for this.
+##### Note also that Donations do not currently work well with Kits. We have an open issue for this.
-## Deleting a donation
-Hopefully you won't need to delete a donation - but it's certainly possible that you might have entered a duplicate. Should you need to delete the donation, "View" it from the All Donations page, then click 'Delete'. You'll be asked to confirm your decision. Use this with extreme caution - because you won't be able to undelete it!
+## Deleting a Donation
+Hopefully you won't need to delete a Donation - but it's certainly possible that you might have entered a duplicate. Should you need to delete the donation, "View" it from the All Donations page, then click 'Delete'. You'll be asked to confirm your decision. Use this with extreme caution - because you won't be able to undelete it!
-## Printing a donation
-You can print a single donation by either viewing it, then clicking print, or just clicking "Print" beside it on the All Donations page. The printout is meant to be useful for parallel record keeping, or as the basis for a tax receipt.
+## Printing a Donation
+You can print a single Donation by either viewing it, then clicking print, or just clicking "Print" beside it on the All Donations page. The printout is meant to be useful for parallel record keeping, or as the basis for a tax receipt.
[Prior: Dashboard](essentials_dashboard.md)[Next: Purchases](essentials_purchases.md)
\ No newline at end of file
diff --git a/docs/user_guide/bank/essentials_pick_ups.md b/docs/user_guide/bank/essentials_pick_ups.md
index c1a9e7da9f..b5cc6a81c4 100644
--- a/docs/user_guide/bank/essentials_pick_ups.md
+++ b/docs/user_guide/bank/essentials_pick_ups.md
@@ -1,3 +1,4 @@
+READY FOR REVIEW
# Pick Ups & Deliveries Calendar
Pick Ups & Deliveries shows scheduled and completed distributions in a calendar format on a monthly basis.
@@ -6,18 +7,18 @@ Click on "Pick Ups & Deliveries" in the left-hand menu to view the calendar.
-Click on any scheduled distribution to view details on all the distributions for that day.
-The Distribution Schedule page shows details including the Partner,the time of distribution, source inventory, the total number of items, and the status of the distribution.
+Click on any scheduled Distribution to view details on all the Distributions for that day.
+The Distribution Schedule page shows details including the Partner,the time of Distribution, Storage Location, the total number of items, and the status of the Distribution.
Once the partner has the distributed goods, clicking "Distribution Complete" changes the status of the distribution from "Scheduled" to "Complete", so you can track what is still in your hands and what is with your partners in the community. It does not, at this time, remove it from the calendar.
-Click "View" for details on the distribution's source location, agency representative, delivery method, shipping cost, comments, and state. This also shows a list of items included in the distribution.
+Click "View" for details on the Distribution's source Storage Location, agency representative, delivery method, shipping cost, comments, and state. This also shows a list of items included in the Distribution.
-If you want to print the details of the distribution to use as a contents list or receipt, click on "Print".
+If you want to print the details of the Distribution to use as a contents list or receipt, click on "Print".
## Sync Pick Ups & Deliveries Calendar with Google Calendar
@@ -32,7 +33,7 @@ Then, open your Google Calendar. On Google Calendar, in the "Other calendars" s
Select "From URL"and paste the URL you copied in the "URL of calendar" section and click on "Add Calendar"
-
+
Events from the Human Essentials Pick Ups & Deliveries Calendar should be accessible to you on Google Calendar when the sync is complete.
diff --git a/docs/user_guide/bank/essentials_purchases.md b/docs/user_guide/bank/essentials_purchases.md
index 618b209133..26002188c0 100644
--- a/docs/user_guide/bank/essentials_purchases.md
+++ b/docs/user_guide/bank/essentials_purchases.md
@@ -1,67 +1,105 @@
-
-DRAFT USER GUIDE
+READY FOR REVIEW
# Purchases
-The other major way we add to inventory in human essentials is through purchases.
+The other major way we add to inventory in human essentials is through Purchases.
-In Human Essentials you enter in-kind donations by specifying the vendor, where they are being stored, and how many of each item are included.
+In Human Essentials you enter Purchases by specifying the Vendor, where they are being stored, and how many of each Item are included.
-## Seeing all your purchases
+## Seeing all your Purchases
-To view a list of all your purchases, click on 'Purchases', then "All Purchases" in the left-hand menu,
+To view a list of all your Purchases, click on 'Purchases', then "All Purchases" in the left-hand menu,
-[TODO: Insert navigational screenshot here.]
+
-This screen includes filters so you can narrow down your search to a particular purchase, and some basic information on each purchase:
-- Purchases from - the vendor you purchased the goods from
-- Storage location -- where you are stored the goods from this purchase.
+This screen includes filters so you can narrow down your search to a particular Purchase, and some basic information on each Purchase:
+- Purchases from - the Vendor you purchased the goods from
+- Storage location -- where you are stored the goods from this Purchase.
- Comments
-- Quantity of items -- the total number of items in the purchase
-- Variety of items -- the number of different items in the purchase
+- Quantity of items -- the total number of Items in the Purchase
+- Variety of items -- the number of different Items in the Purchase
- Amount spent (in dollars)
-- FMV -- this is the Fair Market Value of the purchase using to the current fair market value of the items in it. Fair Market Value can be entered on the item in [Inventory | Items](inventory_items.md) [TODO: Make that point to the appropriate section witin inventory items once we have it written]
-- Actions - you can view more details on each purchase from this screen.
+- FMV -- this is the Fair Market Value of the Purchase using the current fair market value of the Items in it. Fair Market Value can be entered on the item in [Inventory | Items](inventory_items.md)
+- Actions - you can view more details on each Purchase from this screen.
### Filters
-You can filter your purchases by single storage location , by single vendor, or by purchase date range.
+You can filter your Purchases by single Storage Location , by Single vendor, or by date range.
+
+
+The Vendors and Storage Locations are selected using drop-down lists of all your bank's Storage Locations / Vendors.
+Date range is selected using a little calendar gizmo with several presets. We highly recommend using the calendar gizmo instead of typing in the field, as the text field is very particular as to the format - we have a few people experiencing problems there every month.
+Once you have selected your values, click Filter to make the list conform to your selection. To reset the selection, just click "Clear Filters". This will set the list to all the Purchases from the current calendar year.
-[TODO: mini screenshot of filter section]
-The vendors and storage locations are selected using drop-down lists of all the storage locations / vendors.
-Date range is selected using a little calendar gizmo with several presets. We highly recommend using the calendar gizmo instead of typing in the field, as the text field is very particular as to the format - we have a few people experiencing mismatches there every month.
-Once you have selected your values, click Filter to make the list conform to your selection. To reset the selection, just click "Clear Filters". This will set the list to all the purchases from the current calendar year.
+## Entering a new Purchase
+To enter a new Purchase, you can either click "Purchases | New Purchase" on the left hand menu, or click the +New Purchase button on the Purchases list
+
-## Entering a new purchase
-To enter a new purchase, you can either click "Purchases | New Purchase" on the left hand menu, or click the +New Purchase button on the Purchases list
-[TODO: Navigational screenhot]
-[TODO: screenshot of new purchase screen]
+
Enter the following information (starred items are mandatory):
### Vendor *
-Select the vendor from a drop-down list of all your vendors, but if you choose "Not Listed", you can enter a new vendor on the fly. You have to enter at least one of the business name and contact name, but we recommend both (there is a current issue where only the business name shows up on dropdowns)
-[TODO: screenshot of NewVendor form]
+Select the Vendor from a drop-down list of all your vendors. If you choose "Not Listed", you can enter a new vendor on the fly. The Business Name is mandatory.
### Storage Location *
Select the storage location from a drop-down list of all your active storage locations.
-### Purchase Total *, and broken down purchase totals
-The purchase total has to be greater than 0, and it should equal the sum of the 4 fields that break down the purchase into categories. These are used in the Annual Survey report.
+### Purchase Total *, and broken down Purchase totals
+The Purchase total has to be greater than 0, and it should equal the sum of the 4 fields that break down the Purchase into categories:
+- Amount spent on diapers,
+- Amount spent on adult incontinence,
+- Amount spent on period supplies, and
+- Amount spent on other.
+
+These are used in the Annual Survey report.
### Comment
-Self explanatory, we hope? This shows up on the all purchases list [TODO: update this if we have included it into the purchase details]
+This is optional.
### Purchase date
-This should be the date the purchase was made - it is defaulted to today's date. This is used for filtering, but also for what year the purchase is included in for the annual survey.
-### Items in this purchase
-There are a couple of ways to get items into the purchase quickly:
+This should be the date the Purchase was made - it is defaulted to today's date. This is used for filtering, but also for what year the Purchase is included in for the annual survey.
+### Items in this Purchase
+There are a couple of ways to get items into the Purchase quickly:
(1)You can "bloop" a barcode in to get your items into the system -- that requires some initial setup, as detailed in [Inventory | Barcodes] or (2) You can pick the item from the drop-down of all *active* items in your system, and enter the quantity of that item.
In either case, you can click "Add Another Item" (3) to open up another item for entry, or "Remove" (4) if you've added too many!
-The quantity here is meant to be individual items (e.g. diapers), rather than packs. The reason behind this is that, ultimately, your reporting will be based on the number of individual items, and package size is inconsistent across manufacturers.
+The quantity here is meant to be individual items (e.g. diapers), rather than packs. The reason behind this is that, ultimately, your reporting will be based on the number of individual items, and package size is inconsistent across brands.
Note: If you make two entries with the same item, they will be added together when you view them later.
-When you are done entering your items, click "Save". Barring any errors, this will return you to the "All Purchases" page
+When you are done entering your Items, click "Save". Barring any errors, this will return you to the "All Purchases" page
+
+## Viewing a Purchase
+To view Purchase details, click the "View" button beside the Purchase on the All Purchases list.
+[ Navigational screenshot for view Purchase](images/essentials/purchases/essential_purchases_4.png)
+This brings up a page with the Purchase's details, including all the information you entered and the entry date. From here you can make a correction to the Purchase or delete it.
+
+
+## Editing a Purchase
+Editing a Purchase should be relatively rare, but it happens. To edit a Purchase, view it (see above), then click "Make a correction". This brings up the same screen as you used to enter the info -- make your changes and click save.
+
+
+
+Note that any quantity changes will be reflected in inventory as of the day you make the changes, not the Purchase date.
+
+## Deleting a Purchase
+If, somehow, you have entered a Purchase in error, you can delete it by viewing it, then clicking Delete, and then "OK". This is a permanent deletion -- you can't undo it.
+
+
+
+
+You'll be asked to confirm that you want to *permanently* remove the Purchase. Click OK to confirm.
+
+## Exporting your Purchases
+You can export your Purchases from the "All Purchases" screen, above, by clicking "Export Purchases".
+
+This creates a .csv file containing all the information for each of the Purchases in your filtered list.
+It includes:
+- "Purchases from" - the vendor
+- Storage Location
+- Purchased Date
+- Quantity of Items (total number of items bought)
+- Variety of Items (how many different kinds of items were bought)
+- Amount Spent
+- Spent on Diapers
+- Spent on Adult Incontinence
+- Spent on Period Supplies
+- Spent on Other
+- Comment
+- For each Item in your bank (whether it was purchased or not), in alphabetical order
+ - the quantity of that Item that was purchased
-## Viewing a purchase
-To view a single purchase, click the "View" button beside it on the All Purchases list.
-## Editing a purchase
-Editing a purchase should be relatively rare, but it happens. To Edit a purchase, view it (see above), then click "Make a correction"
-## Deleting a purchase
-If, somehow, you have entered a purchase in error, you can delete it by viewing it, then clicking Delete, and then "OK". This is a permanent deletion -- you can't undo it.
-## Exporting your purchases
-You can export your purchases from the "All Purchases" screen, above. This creates a .csv file containing all the information for each of the purchases in your filtered list.
+
[Prior: Donations](essentials_donations.md)[Next: Requests](essentials_requests.md)
\ No newline at end of file
diff --git a/docs/user_guide/bank/essentials_requests.md b/docs/user_guide/bank/essentials_requests.md
index 83f4b2d75e..faeaeb1b7c 100644
--- a/docs/user_guide/bank/essentials_requests.md
+++ b/docs/user_guide/bank/essentials_requests.md
@@ -1,4 +1,4 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
#Requests
Requests are how you get the information on what items the partners need. (You may think of them as orders.)
@@ -6,35 +6,32 @@ The unfulfilled ones appear in your dashboard, but you can also manage them in t
For a more fulsome description of how the whole shebang works, see [Partner Management -- Request Distribution Cycle](pm_request_distribution_cycle.md).
-## Seeing your unfulfilled requests
-We show the unfulfilled requests in two places -- on the [dashboard](essentials_dashboard.md), and as part of the requests list, which you access by clicking "Requests" in the left hand menu.
-[TODO: insert navigational/request list screenshot]
+## Seeing your unfulfilled Requests
+We show the unfulfilled Requests in two places -- on the [dashboard](essentials_dashboard.md), and as part of the Requests list, which you access by clicking "Requests" in the left hand menu.
+
-On the request list, the requests are in order by the status (with pending first, then started, then fulfilled), then reverse chronological by date
-You can view or cancel any request by usin gthe buttons under "Actions"
-To see a list of requests, click on "Requests" in the left hand menu
+On the Request list, the Requests are in order by the status (with pending first, then started, then fulfilled), then reverse chronological by date
+You can view or cancel any Request by using the buttons under "Actions"
+To see a list of Requests, click on "Requests" in the left hand menu
-This list is defaulted to a date range of the current year, all items, all partners, and all statuses, ordered by
-status, then reverse date (i.e. newest first).
+This list is defaulted to a date range of the 60 days in the past to 30 days in the future (though there will be no future-dated Requests), all items, all partners, and all statuses, ordered by
+status, then reverse chronological (i.e. newest first).
The list contains:
-- Date -- the date the request was entered by the partner
-- Request was sent by -- the name of the partner that sent the request
-- Request sender -- the user that sent the request [TODO: Double check that we aren't just using the partner email here]
-- #of items (request limit) -- the number of items in the request, and, if you have entered it, the quota for the partner (see [Partners](getting_started_partners.md)[TODO: Point right to the quota section]
-[TODO: What is the impact of packs on this?]
-- Comments -- the comments the partner entered on the request
+- Date -- the date the Request was entered by the partner
+- Request was sent by -- the name of the partner that sent the Request
+- Request sender -- the user that sent the Request
+- #of Items (Request limit) -- the number of items in the Request, and, if you have entered it, the quota for the partner (see [Partners](getting_started_partners.md)
+- Comments -- the comments the partner entered on the Request
- Status
- pending -- haven't started fulfilling it yet
- started -- have started fulfilling, but haven't saved the resulting distribution
- - fulfilled -- have created the distribution for this request
- - discarded -- have cancelled the request
-- and the actions you can take on that request
-[TODO: Is it also sorted further by partner name? or something else?]
-[TODO: Update when we get the default date change in.]
-
-### Filtering your requests
-You can filter the request list by:
+ - fulfilled -- have created the distribution for this Request
+ - discarded -- have cancelled the Request
+- and the actions you can take on that Request
+
+### Filtering your Requests
+You can filter the Request list by:
- Item
- Partner
- Status
@@ -44,70 +41,77 @@ Fill in the fields with the values you want to filter by, then click "filter"
To reset to the defaults, click "Clear Filters"
## Product totals
-You can find out how much of each product you'll need to fulfill the current filtered open (pending and started) requests by clicking "Calculate Product Totals".
-This takes into account the current filters.
-[TODO: Navigational screenshot]
-[TODO: Screenshot of result]
-
-# Viewing a request
-To view a given request, click "View" beside it in the request list.
-[TODO: Navigational screenshot]
-[TODO: result screenshot]
-This brings up details of the request including:
-- partner
-- date the request was sent
-- who sent the request
-- request status
-- comments
-- and, for each item in the request:
+You can find out how much of each product you'll need to fulfill the current filtered open (pending and started) Requests by clicking "Calculate Product Totals".
+
+
+This brings up a scrollable list showing the quantity of each Item you need to fulfill the Requests. It takes into account the current filters. Click the "x" in the top right corner of the list to close it.
+
+
+## Viewing a Request
+To view a given Request, click "View" beside it in the Request list.
+
+This brings up details of the Request including:
+- Partner
+- Date the Request was sent
+- Who sent the Request
+- Request status
+- Comments
+- and, for each Item in the Request:
- Item
- Quantity
- - If you are using custom units, those custom units will appear here.
- - Total Inventory (across all storage locations)
-At the bottom of the screen are buttons letting you start to fulfill the request, or to cancel it.
-
-# Fulfilling a request
-To fulfill a request, bring up the request list by clicking on "Requests" in the left-hand menu, then click on "view" beside the request, then scroll to the bottom of that screen and click "Fulfill request".
-That will bring you into a screen that allows you to specify the details for the distribution based on that request -- you'll see a notice "request started".
+ - If you are using [custom units](special_custom_units.md), those custom units will appear here.
+ - Total Inventory (across all Storage Locations)
+At the bottom of the screen are buttons letting you start to fulfill the Request, or to cancel it.
+
+
+## Fulfilling a Request
+To fulfill a Request, bring up the Request list by clicking on "Requests" in the left-hand menu, then click on "view" beside the request, then scroll to the bottom of that screen and click "Fulfill request".
+That will bring you into a screen that allows you to specify the details for the distribution based on that Request -- you'll see a notice "request started".
Fill in the remaining needed information. The fields include:
- Partner (It would be rare indeed to change this)
-- [TODO: should it be unchangeable?]
- Distribution date and time (the scheduled pickup delivery or shipment date)
- Send email reminder the day before?
-- Agency representative (defaulted to the user who sent the request)
+- Agency representative (defaulted to the user who sent the Request)
- Delivery method
- Pick up,
- Delivery, or
- Shipped
- Shipping cost (if the delivery method is shipped)
-- From storage location (if you have chosen a default location for the partner, or for your organization, this will be filled in)
+- From Storage Location (if you have chosen a default location for the Partner, or for your organization, this will be filled in)
- Comment
-- For each item in the request
- - The item
- - When you have chosen the storage location, the quantity of this item that is available at that storage location will appear here in parentheses.
+- For each Item in the Request
+ - The Item
+ - When you have chosen the Storage Location, the quantity of this Item that is available at that Storage Location will appear here in parentheses.
- A field for the quantity to be distributed
- the requested amount.
- - For any item that has custom units (See custom units in [Getting Started -- Customization](getting_started_customization.md) [TODO: Point right at the custom units section]
- - If you are using custom units, the units the partner chose will appear here as well.
-You can remove any item by clicking the associated "remove" button, and you can add more items, by clicking the "Add Another Item" button.
+ - For any Item that has [custom units](special_custom_units.md), this will show both the amount and the unit
+You can remove any Item by clicking the associated "remove" button, and you can add more iIems, by clicking the "Add Another Item" button.
-When you have finished filling in the information, save the distribution by clicking the "save" button
-The partner will be sent an email letting them know that their request has been fulfilled.
-[TODO: include sample email]
-# Cancelling a request
+When you have finished filling in the information, save the Distribution by clicking the "save" button.You'll see a page showing the details of the Distribution.
+
+If you have set the [Partner](getting_started_partners.md) to receive emails for distributions and reminders from the system
+the partner will be sent an email letting them know that their Request has been fulfilled. This will contain the text you have [customized](getting_started_customization.md), with an attachment showing the details of the distribution.
+
+
+## Cancelling a Request
+To cancel a Request from the Requests list, click the "cancel" button beside it.
+
+You can also cancel a Request from the single Request view by clicking the "cancel" button at the bottom of that page.
-To cancel a request from the requests list, click the "cancel" button beside it. You can also cancel a request from the single request view by clicking the "cancel" button at the bottom of that page.
-[TODO: NAvigational screenshots]
In either case,
-You will be prompted to provide a reason for the cancellation, which will be sent in an email to the partner.
-[TODO: Screenshot]
-[TODO: Is it just sent to the user who sent the request, or to the partner email and the user who sent the request?]
-
-[TODO: Sample email]
-# Exporting requests
-To export the requests from the request list, click "Export requests"
-[TODO: Navigational email]
-This will create a .csv file with the following information for each filtered request:
+You will be prompted to provide a reason for the cancellation.
+
+
+The Partner will receive an email notifying them of the cancellation.
+
+
+NOTE: This email goes to the Partner, rather than to the User who sent the request.
+
+
+## Exporting Requests
+To export the Requests from the Request list, click "Export Requests"
+
+This will create a .csv file with the following information for each filtered Request:
- Date
- Requestor (partner)
- Status
@@ -115,6 +119,16 @@ This will create a .csv file with the following information for each filtered re
- the quantity requested
Note: If you use custom units, there will be a column for each item/unit that is available to be requested.
+## Printing unfulfilled Request picklists
+
+Finally, you can also print "picklists" for your unfulfilled Requests.
+This function produces a printable pdf file showing all the items requested for each of your unfulfilled Requests
+
+Click "Print Unfulfilled Picklists" on your Requests list.
+
+Here is a sample picklist:
+
+
[Prior: Purchases](essentials_purchases.md) [Next: Distributions](essentials_distributions.md)
diff --git a/docs/user_guide/bank/exports.md b/docs/user_guide/bank/exports.md
index 33a870947f..0b6c529d63 100644
--- a/docs/user_guide/bank/exports.md
+++ b/docs/user_guide/bank/exports.md
@@ -1,44 +1,38 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
# Exports
-[TODO: Screenshots throughout, if we need them]
There are several exports available to allow you to use the information from the application in other apps.
These all export files in .csv format, which is importable by all common spreadsheet programs.
Many of these can be filtered down to the information you might need for a specific communication need.
The exports available include (in alphabetical order):
-- adjustments
-- annual survey
-- barcode items
-- distributions
-- donations
-- donation sites
-- items
-- partners
-- product drives
-- product drive participants
-- purchases
-- requests
-- storage locations
-- transfers
-- vendors
-
-## Adjustments
-[TODO: The adjustments export needs to be better to be actually useful]
+- Adjustments
+- Annual Survey
+- Barcode Items
+- Distributions
+- Donations
+- Donation Sites
+- Items
+- Partners
+- Product Drives
+- Product Drive Participants
+- Purchases
+- Requests
+- Storage Locations
+- Transfers
+- Vendors
+
+## Adjustments
+
### Navigating to export adjustments
Click "Inventory", then "Inventory Adjustments" in the left-hand menu. Then click "Export Adjustments",
### Contents of adjustment export
Creation date, Organization, Storage Area, Comment, # of changes.
-### Notes:
-We have improving the adjustments export to include the changes made in each adjustment on our todo list. We'll also remove the organization as redundant information.
-
-Please reach out if this is a priority for you.
-
+[! NOTE] We have improving the adjustments export to include the changes made in each adjustment on our todo list. We'll also remove the organization as redundant information. Please reach out if this is a priority for you.
## Annual Survey
-[TODO: Raise question -- shouldn't this be an export *across* years?]
### Navigating to export annual survey
Click "Reports", then "Annual Survey" in the left-hand menu. Then click the year of the report you want to export. Then click "Export Report."
### Contents of annual report export
@@ -48,24 +42,24 @@ For more information on these, please see the [Annual Survey Report](reports_ann
- Disposable diapers distributed,
- Cloth diapers distributed,
- Average monthly disposable diapers distributed,
-- Total product drives,
+- Total Product Drives,
- Disposable diapers collected from drives,
- Cloth diapers collected from drives,
-- Money raised from product drives,
-- Total product drives (virtual),
-- Money raised from product drives (virtual),
+- Money raised from Product Drives,
+- Total Product Drives (virtual),
+- Money raised from Product Drives (virtual),
- Disposable diapers collected from drives (virtual),
- Cloth diapers collected from drives (virtual),
- Disposable diapers donated,
- % disposable diapers donated,
- % cloth diapers donated,
-- Disposable diapers purchased,
-- % disposable diapers purchased,
-- % cloth diapers purchased,
+- Disposable diapers Purchased,
+- % disposable diapers Purchased,
+- % cloth diapers Purchased,
- Money spent purchasing diapers,
- Purchased from,
-- Vendors diapers purchased through,
-- Total storage locations,
+- Vendors diapers Purchased through,
+- Total Storage Locations,
- Total square footage,
- Largest storage site type,
- Adult incontinence supplies distributed,
@@ -92,13 +86,13 @@ For more information on these, please see the [Annual Survey Report](reports_ann
- Total children served,
- Repackages diapers?,
- Monthly diaper distributions?,
-- % difference in yearly donations,
+- % difference in yearly Donations,
- % difference in total money donated,
-- % difference in disposable diaper donations
+- % difference in disposable diaper Donations
## Barcode Items
-### Navigating to export barcode items
+### Navigating to export barcode Items
Click "Inventory" then "Barcode Items" in the left-hand menu. Then click "Export Barcode Items."
-### Contents of barcode items export
+### Contents of barcode Items export
For each Barcode Item:
- Item Type,
- Quantity in the Box,
@@ -107,13 +101,13 @@ For each Barcode Item:
### Navigating to export distributions
Click "Distributions" in the left hand menu. Click the "Export Distributions" button.
### Filtering the distributions export
-The distributions export shows the same distributions as are in the main distributions page, and the filtering works the same way.
+The Distributions export shows the same Distributions as are in the main Distributions page, and the filtering works the same way.
Before clicking the export button, you can filter by any of:
- date range (we recommend you use the calendar-style selection rather than typing it in, as the format is a bit fussy.)
-- item
-- item category
-- partner
-- source inventory (i.e. storage location)
+- Item
+- Item Category
+- Partner
+- source inventory (i.e. Storage Location)
- status (i.e. scheduled or complete)
Specify the filtration you want, then click "filter".
@@ -131,18 +125,16 @@ For each of the distributions in the filtered list:
- State,
- Agency Representative,
- Comments,
-- and the quantity in the distribution for each of your bank's items.
+- and the quantity in the distribution for each of your bank's Items.
-Note: This includes inactive items as well as active ones.
-[TODO: confirm that that statement is accurate]
+[!NOTE] This includes inactive Items as well as active ones.
## Donations
-
-### Navigating to export donations
+### Navigating to export Donations
Click "Donations", then "All Donations" in the left hand menu, then click 'Export Donations'.
-### Filtering the donations export
-The donations export shows the same donations as are in the main donations page, and the filtering works the same way.
+### Filtering the Donations export
+The Donations export shows the same Donations as are in the main Donations page, and the filtering works the same way.
You can filter by any of:
- Storage Location
- Source (i.e. Manufacturer, Product Drive, or Misc. Donation)
@@ -153,41 +145,54 @@ You can filter by any of:
When you have selected your filters, click "Filter", then "Export Donations"
-### Contents of the donations export
-For each of the donations in the filtered list:
+### Contents of the Donations export
+For each of the Donations in the filtered list:
- Source
- Date (this is the date you enter in the donation, rather than the date it was put into the system)
-- Details (this is the manufacturer name or the product drive)
+- Details (this is the manufacturer name or the Product Drive)
- Storage Location,
-- Quantity of Items (the total quantity of items)
-- Variety of Items (the number of different items)
+- Quantity of Items (the total quantity of Items)
+- Variety of Items (the number of different Items)
- In-Kind Value,
- Comments,
-- and the quantity of each of your organization's items in the donations.
+- and the quantity of each of your organization's Items in the Donations.
## Donation Sites
-The donation sites export is not yet implemented. If this is a priority for you, please reach out.
+### Navigating to export Donation Sites
+Click "Community", then "Donation Sites" in the left hand menu. Then click "Export Donation Sites"
+### Contents of the Donation Sites export
+For each active Donation Site:
+- site name
+- address
+- contact name
+- e-mail
+- phone
+
+
+
+
+
+
## Items
-### Navigating to export items
+### Navigating to export Items
Click "Inventory", then "Items & Inventory" in the left hand menu. Then click "Export Items"
-### Filtering the item export
-By default, the export will contain all active items.
-You can filter it differently by only including the items for a specific base item,
-or by also including inactive items.
+### Filtering the Item export
+By default, the export will contain all active Items.
+You can filter it differently by only including the Items for a specific base Item,
+or by also including inactive Items.
Select what you wish to filter by,than click "Filter".
-### Contents of the item export
-For each filtered item, the export includes:
+### Contents of the Item export
+For each filtered Item, the export includes:
- Name,
-- Barcodes (each barcode associated with that item),
+- Barcodes (each barcode associated with that Item),
- Base Item,
- Quantity (across your entire bank)
## Partners
The partners export contains high level information about the partner. It does not contain the information in the partner profile.
-[TODO: Do we neeed a partner profile export?]
### Navigating to export partners
Click "Partner Agencies", then "All Partners" in the left-hand menu. Then click "Export Partner Agencies"
### Filtering the partner export
@@ -198,11 +203,9 @@ You can export different groups of partners by clicking the partner filters whic
- Awaiting review
- Approved
- Error
-- - (TODO: Check if error is a current thing, or perhaps a relic of the two db system?)
- Recertification required
- Decactivated
- Active
-[TODO: add contents]
### Partner Export contents
For each partner in the filtered list:
@@ -220,19 +223,19 @@ For each partner in the filtered list:
- Notes
## Product Drives
-### Navigating to export product drives
+### Navigating to export Product Drives
Click 'Community', then 'All Product Drives' in the left hand menu, then click "Export Product Drives"
-### Filtering the product drives
-The product drives can be filtered by
+### Filtering the Product Drives
+The Product Drives can be filtered by
- name,
-- item category, and
+- Item category, and
- date range.
-It is defaulted to all drives, this year. [TODO: This will need updating when we change the default timespan]
+It is defaulted to all drives that overlap the default time period of 60 days back, 30 days forward.
To filter the export, make your selections, then click "Filter" before clicking "Export Product Drives".
### Product Drive Export content
-For each filtered product drive, the export will contain:
+For each filtered Product Drive, the export will contain:
- Product Drive Name,
- Start Date,
- End Date,
@@ -240,10 +243,10 @@ For each filtered product drive, the export will contain:
- Quantity of Items,
- Variety of Items,
- In Kind Value, and
-- the quantity donated for each item in alphabetical order.
+- the quantity donated for each Item in alphabetical order.
-
## Product Drive Participants
-### Navigating to export product drive participants
+### Navigating to export Product Drive participants
Click 'Community', then 'Product Drive Participants' in the left hand menu, then click "Export Product Drive Participants"
### Product Drive Participant Export content
- Business Name,
@@ -251,24 +254,22 @@ Click 'Community', then 'Product Drive Participants' in the left hand menu, the
- Phone,
- Email,
- Total Diapers
- - The title for this should be Total Items, as that is what is shown.
- - [TODO: initialize issue for this discrepency]
+ - The title for this should be Total Items, as that is what is shown. We have an issue in the queue to fix that
## Purchases
-### Navigating to export purchases
+### Navigating to export Purchases
Click 'Purchases', then 'All Purchases' in the left hand menu. Then click "Export Purchases"
-### Filtering exported purchases
-You can filter the purchases by:
+### Filtering exported Purchases
+You can filter the Purchases by:
- Storage location
- Vendor
- Purchase date
-The default is all storage locations and vendors, and the current year
-[TODO: update this when we change to 60 days prior, 30 days forward]
+The default is all Storage Locations and vendors, and the default period of 60 days prior, 30 days forward from today's date.
Make your selection and click "Filter" before clicking "Export Purchases"
### Content of Purchases Export
-For each purchase in the filtered list:
-- Purchases from (the vendor name) (TODO: Shouldn't this be Purchased from, or Vendor?)
+For each Purchase in the filtered list:
+- Purchases from (the Vendor name)
- Storage Location,
- Purchased Date,
- Quantity of Items,
@@ -279,72 +280,69 @@ For each purchase in the filtered list:
- Spent on Period Supplies,
- Spent on Other,
- Comment, and
-- the quantity of each item included in the purchase.
+- the quantity of each Item included in the Purchase.
## Requests
-### Navigating to export requests
+### Navigating to export Requests
Click 'Requests' in the left-hand menu, then "Export Requests"
-### Filtering exported requests
-You can filter the exported requests by the following:
+### Filtering exported Requests
+You can filter the exported Requests by the following:
- Item
- Partner
- Status (Pending, Started, Fulfilled, Discarded)
- Date Range
Make your selection, then click 'Filter' before clicking 'Export Requests'
-The default is all requests in the current year
-
-(TODO: update the default if we get to that before this is published)
+The default is all Requests in the last 60 days
-### Contents of requests export
-For each filtered request,
+### Contents of Requests export
+For each filtered Request,
- Date,
- Requestor (i.e. partner)
- Status, and
-- the quantity of each item requested.
- - Note: If you have packs enabled (upcoming feature), there will be a column for each unit that you have enabled for each item. Otherwise, one column per item.
+- the quantity of each Item requested.
+ - Note: If you have packs enabled (upcoming feature), there will be a column for each unit that you have enabled for each Item. Otherwise, one column per Item.
## Storage Locations
-### Navigating to export storage locations
+### Navigating to export Storage Locations
Click "Inventory", then "Storage Locations" in the left-hand menu. Then click "Export Storage Locations"
### Filtering exported Storage Locations
-You can filter the exported list by Item. This will give all storage locations that have ever had that item, *not* those with current inventory.
-(Note: including inactive is currently broken)
-[TODO: Write up including inactive]
-[TODO: Check that by item filter works for export storage location]
-The default is all active storage locations.
-[TODO: IT looks like the export doesn't include the inactive when selected.]
+You can filter the exported list by Item. This will give all Storage Locations that have ever had that Item, *not* just those with current inventory.
+(Note: including inactive Storage Locations is not working at time of writing)
+
+The default is all active Storage Locations.
+
Make your selections, then click "Filter" before clicking "Export Storage Locations"
-### Contents of storage location exports
-For each storage location in the filtered list:
+### Contents of Storage Location exports
+For each Storage Location in the filtered list:
- Name,
- Address,
- Square Footage,
- Warehouse Type,
- Total Inventory, and
-- Quantity for each of the organization's items.
+- Quantity for each of the organization's Items.
## Transfers
-### Navigating to export transfers
+### Navigating to export Transfers
Click "Inventory", then "Transfers" in the left-hand menu. Then click "Export Storage Locations"
-### Filtering exported transfers
-You can filter the transfers by:
+### Filtering exported Transfers
+You can filter the Transfers by:
- From location
- To location
- date range.
- - Note that this is the date the transfer was entered in the system, which may or may not be when it happened.
+ - Note that this is the date the Transfer was entered in the system, which may or may not be when it happened.
-The default is all the transfers for the current year (Note: we are soon changing this to 60 days prior, 30 days forward from today).
+The default is all the Transfers for the period of 60 days prior, 30 days forward from today.
Make you selection and click 'Filter' before clicking "Export Transfers".
-### Contents of transfers exports
-For each selected transfer:
+### Contents of Transfers export
+For each selected Transfer:
- From,
- To,
- Comment,
- Total Moved
-- (TODO: Really? This should have the total moved for each item. Make an issue to make it so.)
+[! NOTE] We have an issue in the queue to provide the total moved for each Item.
## Vendors
### Navigating to Export Vendors
diff --git a/docs/user_guide/bank/getting_started_access_levels.md b/docs/user_guide/bank/getting_started_access_levels.md
index e4703f9533..2b017c4484 100644
--- a/docs/user_guide/bank/getting_started_access_levels.md
+++ b/docs/user_guide/bank/getting_started_access_levels.md
@@ -1,4 +1,4 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
# Levels of Access
There are 4 different levels of access in the system:
@@ -7,45 +7,43 @@ There are 4 different levels of access in the system:
3. Partner
4. Super Admin
-(We are currently discussing adding a user who is restricted to a specific location, but we don't have it yet)
+(We are currently discussing adding a User who is restricted to a specific location, but we don't have it yet)
## Organization Admin
-Organization Admins are the top-level user at your essentials bank. They can do everything an Organization User (see below) can do, plus:
+Organization Admins are the top-level User at your essentials bank. They can do everything an Organization User (see below) can do, plus:
-- Administer the users for your bank ( see [User Management](getting_started_user_management.md))
-- Administer the users for your partners ( see [Partner User Management](pm_partner_user_admin.md))
-- Finalize audits (see [Audits](inventory_audits.md))
+- Administer the Users for your bank ( see [User Management](getting_started_user_management.md))
+- Administer the Users for your partners ( see [Partner User Management](pm_partner_user_admin.md))
+- Finalize Audits (see [Audits](inventory_audits.md))
- Customize organization settings( see [Customization](getting_started_customization.md))
## Organization User
This is your basic user for your bank -- they can do all the data entry except for those things reserved for the Organization Admin, above. Organization Users have the right to:
-- Enter donations, purchases, distributions
-- Fulfil requests
-- View pickup and delivery calendars
+- Enter Donations, Purchases, Distributions
+- Fulfil Requests
+- View Pickup and Delivery calendars
- Administer Partners (excluding partner user management)
- Perform Audit data entry (finalization is reserved for the Organization Admin)
-- Manage the Community information
+- Manage the community information (Donation Sites, Product Drives, Product Drive Participants, Manufacturers)
- View all the bank-level reports
## Partner
-Partner users' access is, of course, limited to the scope of the Partner they belong to.
+A Partner User's access is, of course, limited to the scope of the Partner they belong to.
Within that scope, they can:
-- Edit their partner profile
-- Submit requests (if the Partner has been approved)
-- View their distributions
-- Administer families and children (only if they are allowed to make Child Requests (this can be limited by the Org Admin, see [Customization](getting_started_customization.md) )) (note, the other user types cannot see this information)
+- Edit their Partner profile
+- Submit Requests (if the Partner has been approved)
+- View their Distributions
+- Administer Families and Children (only if they are allowed to make Child Requests (this can be limited by the Org Admin, see [Customization](getting_started_customization.md) )) (note, the other user types cannot see this information)
## Super Admin
This bit is for information only -- A limited number of Human Essentials staff have a superadmin role that allows us to perform the following duties:
- Review and approve Account requests
- Make system-wide announcements
- Administer users (we need it because every once in awhile, the organization admin for a bank will leave without promoting someone else to that role.)
-- Administer "Base Items"
+- Administer Base Items
- Administer the list of NDBN members
- Administer some organization settings
-[TODO: Raise the question of whether we *should* be administering most of this -- we don't have rights to change any of the more recently added values on the org.]
-
[Prior: Customization](getting_started_customization.md)[Next: User Management](getting_started_user_management.md)
\ No newline at end of file
diff --git a/docs/user_guide/bank/getting_started_choices.md b/docs/user_guide/bank/getting_started_choices.md
index 673420e169..66f18524d9 100644
--- a/docs/user_guide/bank/getting_started_choices.md
+++ b/docs/user_guide/bank/getting_started_choices.md
@@ -1,8 +1,6 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
-This page is a work in progress until we are all done.
-
-# Some up front things to think about
+# Some Things to Think about before Getting Started
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.
diff --git a/docs/user_guide/bank/getting_started_customization.md b/docs/user_guide/bank/getting_started_customization.md
index 9f3a239b6d..28fceedd3f 100644
--- a/docs/user_guide/bank/getting_started_customization.md
+++ b/docs/user_guide/bank/getting_started_customization.md
@@ -1,46 +1,55 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
# Organization information and customization
-Every essentials bank has its own way of doing things.
+Every Essentials Bank has its own way of doing things.
With that in mind, there are a number of things you can tweak.
This is done through "My Organization".
Only organization admins have access to this area.
## Getting to the organization edit
-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".
+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".
+
+
This brings up a view of the organization settings. It shows everything we are going to talk about for the rest of this section, as well as the users (more on them in the next section)
+
Scroll down until you see an Edit button. Click it.
-You should now be in a screen that is titled "Editing [Your bank name]"
+
+
+
+You should now be in a screen that is titled "Editing [Your bank name]". Change the information to suit your organization's needs and then click the "save" button at the bottom
+
+
Here's all the fields, with a bit about the implications of each one:
-## Basic Information
-### Name
-The name of your essentials bank. This appears in the headings on most screens, and will appear on printouts (such as the distribution printout many banks use as a packing slip), and most reports.
+## Basic Information
+#### Name
+The name of your Essentials Bank. This appears in the headings on most screens, and will appear on printouts (such as the distribution printout many banks use as a packing slip), and most reports.
-### Short name
+#### Short name
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.
-### NDBN membership
-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.
-This is included on the Annual survey report. That's the only effect.
+#### NDBN membership
+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.
+This is included on the Annual Survey report. That's the only effect.
-### Url
-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.
+#### Url
+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.
-### Email
-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 and the annual survey [TODO: Confirm each of those.]
+#### Email
+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.
-### Address
-Your essential bank's primary address. This is shown on the distribution and donation printouts, and the annual survey [TODO: Confirm annual survey]
+#### Address
+Your Essential Bank's primary address. This is shown on the distribution and Donation printouts.
+------------
## Reminder Emails (optional)
You can opt, on a partner by partner basis, to have reminder emails sent.
-There is also a check-box on the partner that must be checked for the partner to get these emails.
+There is also a check-box on the Partner that must be checked for the Partner to get these emails.
The text of this email will be:
@@ -48,7 +57,7 @@ The text of this email will be:
Hello [Partner's name],
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]
-if you would like to receive a distribution next month.
+if you would like to receive a Distribution next month.
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.
@@ -60,20 +69,21 @@ if you have any questions about this!
-### Reminder day (Day of month an e-mail reminder is sent to partners to submit requests)
- [TODO: This will need updating with the day of week/day of month update]At this point, we send those emails once a month on the day of the month you indicate here.
+#### Reminder day (Day of month an e-mail reminder is sent to partners to submit Requests)
+At this point, we send those emails once a month on the day of the month you indicate here.
If you do not pick a day, no reminder emails are sent.
-### Deadline day (Final day of the month to submit requests)
+#### Deadline day (Final day of the month to submit Requests)
This day will be included in the reminder email message,
+----------
-## Default Intake Location
+#### Default Intake Location
-This is the default storage location for donations and purchases.
-If you specify this, it will be pre-populated as the storage location when you are adding new donations or purchases.
+This is the default storage location for Donations and Purchases.
+If you specify this, it will be pre-populated as the storage location when you are adding new Donations or Purchases.
-## Partner Profile Sections
+#### Partner Profile Sections
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.
This field lets you specify which of the sub-sections of that form will be used.
The Agency Information subsection is always included.
@@ -88,92 +98,120 @@ The sections are:
- Agency Distribution Information
- Attached Documents
-## Default Storage Location
+#### Default Storage Location
-The bank-wide default storage location for donations and purchases.
-You can also specify a different default storage location on any partner, which will override this default.
-If you specify a default storage location, it will be pre-populated as the storage location when you are adding new distributions.
+The bank-wide default Storage Location for Donations and Purchases.
+You can also specify a different default Storage Location on any Partner, which will override this default.
+If you specify a default Storage Location, it will be pre-populated as the Storage Location when you are adding new Distributions.
-## Custom Partner Invitation Message
-[TODO: Ensure that this is working!]
+#### Custom Partner Invitation Message
+[!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.
-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.
+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.
If you do not specify a message, the invitation will contain:
-Hello [partner's email]
+Hello [Partner's email]
You've been invited to become a partner with Pawnee Diaper Bank!
-Please click the link below to accept your invitation and create an account and you'll be able to begin requesting distributions.
+[Customer Partner Invitation Message If Present]
+
+Please click the link below to accept your invitation and create an account and you'll be able to begin requesting Distributions.
-Please contact [bank's email] if you are encountering any issues.
+Please contact [Bank's email] if you are encountering any issues.
+
+[Accept Invitation button]
-Accept Invitation
For security reasons these invitations expire. This invitation will expire in 8 hours or if a new password reset is triggered.
If your invitation has an expired message, go here(link to the log in page) and enter your email address to reset your password.
Feel free to ignore this email if you are not interested or if you feel it was sent by mistake.
+----------
+## Questions for the Annual Survey
+These two fields are only here to be reported on the Annual Survey.
-## Questions for the annual survey
-These fields are only here to be reported on the annual survey.
-
-### Does your bank repackage essentials?
-### Does your bank distribute monthly
+#### Does your Bank repackage essentials?
+#### Does your Bank distribute monthly
-## Custom Units
+-----------
-NOTE: This is not yet implemented as of Oct 12, 2024.
+#### Custom Units
-The number of items throughout the bank's view of the system is the number of units (e.g. diapers), but
-partners often think in terms of packs of diapers. Because banks were getting a lot of partners requesting the number of packs of diapers, instead of the number of diapers, we have introduced the ability for banks to allow the partners to request other units (e.g. packs)
+NOTE: This is not yet implemented as of Oct 12, 2024. We expect it to be implemented before this guide is launched.
-This deserves a page of it's own - but in short, you can specify units here, that you can add to your items. The partners then can ask for, say, 'packs' of diapers. You will still have to translate those to the number of items when distributing
-Because there is a lot of variety in pack size across brands.
+This is a special topic that has its own guide page [here](special_custom_units.md).
-[TODO: This is actually a good candidate for a video showing the whole process]
+----------
-## Controlling what kind of request a partner can make
+## Controlling what kind of Requests a Partner can make
-There are three different ways a partner can request essentials -- a "Child based" request, a request by number of individuals, and a straight quantity-based request. Some banks want to limit which requests the partners can make, in order to minimize partner confusion.
-These three fields allow you to control which requests the partners can use.
-If you allow more than one kind, the partner can also limit their own.
-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.
+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.
+These three fields allow you to control which Requests the Partners can use.
+If you allow more than one kind, the Partner can also limit their own.
+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.
-### Enable partners to make child-based requests
-### Enable partners to make requests for individuals?
-### Enable partners to make quantity-based requests?
+#### Enable partners to make child-based Requests
+#### Enable partners to make Requests for individuals?
+#### Enable partners to make quantity-based Requests?
-## Customizing the distribution printout
-There are four fields that allow you to tweak the appearance of the distribution printout
+----------
+## Customizing the Distribution printout
+There are four fields that allow you to tweak the appearance of the Distribution printout
-### Show Year-to-date values on the distribution printout?
+### Show Year-to-date values on the Distribution printout?
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.
-### Include Signature Lines on Distribution Printout
-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.
+### Include Signature Lines on Distribution printout
+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.
### Hide both value columns
-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.
-Note: Hiding this also hides the corresponding values on the single donation printout.
-### Hide the package column on distribution receipts?
-This hides the packages column on the distribution printout (4, below). Because different brands of essentials use different size packages, this
-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))
+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.
+Note: Hiding this also hides the corresponding values on the single Donation printout.
+### Hide the package column on Distribution receipts?
+This hides the packages column on the Distribution printout (4, below). Because different brands of essentials use different size packages, this
+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))
+
+
-
+--------
-## Use One Step Invite and Approve partner process?
-Partners can't submit requests until they are approved by the bank.
+#### Use One Step Invite and Approve partner process?
+Partners can't submit Requests until they are approved by the bank.
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).
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.
-## Distribution Email Content
-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.
-You can customize this quite a bit! [TODO: expand. Maybe provide a real life example.]
+#### Distribution Email Content
+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.
+You can customize this quite a bit!
+
+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.
+
+Here's a real-life example (except for the URL)
+
+------
+
+%{partner_name},
+
+Your essentials request has been approved and you can find attached to this email a copy of the distribution you will be receiving.
+
+Your distribution has been set to be %{delivery_method} on %{distribution_date}.
+
+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!
+
+See you soon!
+
+%{comment}
+
+-----
+
+
+
+
-## Logo
+#### Logo
-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 performace -- the 763 x 188 size is a good guideline.
+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.
[Prior: Inventory](getting_started_inventory.md) [Next: Adding your Staff - levels of access](getting_started_access_levels.md)
\ No newline at end of file
diff --git a/docs/user_guide/bank/getting_started_donation_sites.md b/docs/user_guide/bank/getting_started_donation_sites.md
index c34205f5a5..596de249f5 100644
--- a/docs/user_guide/bank/getting_started_donation_sites.md
+++ b/docs/user_guide/bank/getting_started_donation_sites.md
@@ -1,15 +1,15 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
# Donation Sites
-A donation site represents a drop-off location for donations.
-The information regarding a donation site is mainly for your reference. There are, at time of writing, no automated emails that go to the donation sites' contacts.
-Note that you can filter your donation list ( see [Donations](essentials_donations.md)) by donation site.
+A Donation Site represents a drop-off location for donations.
+The information regarding a Donation Site is mainly for your reference. There are, at time of writing, no automated emails that go to the donation sites' contacts.
+Note that you can filter your Donation list ( see [Donations](essentials_donations.md)) by Donation Site.
-## Adding a single donation site
-If you are following along in the "getting started", you'll have reached stage 3 "Donation Sites". You can add a single donation site by clicking on "Add a Donation Site".
-
-This will take you to the new donation site screen, where you can provide the basic information for your side. Click save when done:
-
+## Adding a single Donation Site
+If you are following along in the "getting started", you'll have reached stage 3 "Donation Sites". You can add a single Donation Site by clicking on "Add a Donation Site".
+
+This will take you to the new Donation Site screen, where you can provide the basic information for your side. Click save when done:
+
-To add more donation sites, or if you are in a different place in the process, see the full entry on [Donation Sites](community_donation_sites.md).
+To add more Donation Sites, or if you are in a different place in the process, see the full entry on [Donation Sites](community_donation_sites.md).
[Prior: Partners](getting_started_partners.md)[Next: Inventory](getting_started_inventory.md)
\ No newline at end of file
diff --git a/docs/user_guide/bank/getting_started_inventory.md b/docs/user_guide/bank/getting_started_inventory.md
index 4b31e63c3f..a2c062824c 100644
--- a/docs/user_guide/bank/getting_started_inventory.md
+++ b/docs/user_guide/bank/getting_started_inventory.md
@@ -1,32 +1,31 @@
-DRAFT USER GUIDE
-# Getting started -- inventory
-When we set up your organization, we provide a default set of items ranging from adult briefs to kids (newborn)
+READY FOR REVIEW
+# Getting started -- Inventory
+When we set up your organization, we provide a default set of Items ranging from adult briefs to kids (newborn)
to tampons. You can modify this list at any time, through the [Inventory Items](inventory_items.md) feature.
This section of the guide will take you through a couple of ways to get your initial inventory in.
-[TODO: Rewrite once we have audits available as a starting strategy]
+## Adding a past Donation
+One easy way to get your current inventory set up is to just enter a Donation per Storage Location with all of the current inventory, and put a
+comment on it to indicate that this was your starting inventory. The values you enter there will be included in your Donation reports for the year,
+so if you don't want that, either backdate the Donation to the previous year or use the Inventory Adjustments method, below.
-[TODO: Really -- this should just be Audits front and center -- but that's not how the system works atm]
+To enter a past Donation, simply click on the "Add past Donation" button, which takes you to the New Donation screen, which is described in a lot of detail [here](essentials_donations.md)
-## Adding a past donation
-One easy way to get your current inventory set up is to just enter a donation per storage location with all of the current inventory, and put a
-comment on it to indicate that this was your starting inventory. The values you enter there will be included in your donation reports for the year,
-so if you don't want that, either backdate the donation to the previous year or use the inventory adjustments method, below.
+
-To enter a past donation, simply click on the "Add past donation" button, which takes you to the New Donation screen, which is described in a lot of detail [here](essentials_donations.md)
-
-
-
-## Adding a past purchase
+## Adding a past Purchase
Similarly, if you've started your bank with a purchase of goods, you might want to enter the details as a purchase. The values you enter here will be included in your purchase reports for the year chosen.
-
-## Inventory adjustment
-Another (some say superior) way to set up your bank is through inventory adjustments. This has the advantage of keeping your initial
-inventory, however it was acquired, out of donation and purchase reports. The details on entering an inventory adjustment can be found [here](inventory_adjustments.md)
+
+## Inventory Adjustment
+Another (some say superior) way to set up your bank is through Inventory Adjustments. This has the advantage of keeping your initial
+inventory, however it was acquired, out of Donation and Purchase reports. The details on entering an Inventory Adjustment can be found [here](inventory_adjustments.md)
-[Prior: Donation Sites](getting_started_donation_sites.md) [Next: Customization and other organizational-level info](getting_started_customization.md)
-[TODO: Will need to update this when we remove Donation Sites from Getting Started ]
+
+
+
+
+[Prior: Donation Sites](getting_started_donation_sites.md) [Next: Customization and other organizational-level info](getting_started_customization.md)
\ No newline at end of file
diff --git a/docs/user_guide/bank/getting_started_partners.md b/docs/user_guide/bank/getting_started_partners.md
index 07d660f8fb..a279864ad6 100644
--- a/docs/user_guide/bank/getting_started_partners.md
+++ b/docs/user_guide/bank/getting_started_partners.md
@@ -1,28 +1,34 @@
-DRAFT USER GUIDE
-# Getting started -- partners
+READY FOR REVIEW
+# Getting Started -- Partner Management
-## Things you need to know about partners before deciding how you are handling them
+## Things You need to know about Partners before deciding how you are handling them
-1/ You need to have your partners in the system to be able to record distributions to them.
+1/ You need to have your Partners in the system to be able to record distributions to them.
-2/ However, if you're not ready to have your partners make requests yet, that's ok -- you can put them in the system without inviting them. You'll still be able to record what you are distributing to them.
+2/ However, if you're not ready to have your Partners make Requests yet, that's ok -- you can put them in the system without inviting them. You'll still be able to record what you are distributing to them.
-3/ You can import all your partners at once. You can only import partners once, though -- this is a precaution to make sure we don't accidently create duplicates.
+3/ You can import all your Partners at once. You can only import Partners once, though -- this is a precaution to make sure we don't accidently create duplicates.
-4/ The usual way to handle bringing on partners to be able to make requests is to invite them, then have them fill in their profile before approving them, so that you get the information from them that your bank needs for grants, etc. However, if that's not how you want to work, it is also possible to invite and approve them in one step.
+4/ The usual way to handle bringing on Partners to be able to make Requests is to invite them, then have them fill in their profile before approving them, so that you get the information from them that your bank needs for grants, etc. However, if that's not how you want to work, it is also possible to invite and approve them in one step.
-5/ A lot of banks set up a partner as a proxy for their direct distribution. This is allowed, and you can switch back and forth between being a bank and a partner with the same login
+5/ A lot of Banks set up a Partner as a proxy for their direct distribution to people in need. This is allowed, and you can switch back and forth between being a Bank and a Partner with the same login
-6/ You can group partners, and allow those groups to request different sets of items (One thing some banks use this for is handling grants that are geographically constrained.)
-## Adding a single partner
-Click on the "Add a Partner" button on your "Getting started" screen
-(you can also click on "Partner Agencies", then "All Partners", then "Add a Partner")
+6/ You can group Partners, and allow those Partber Groups to request different sets of items (One thing some banks use this for is handling grants that are geographically constrained.)
-
-Further details on adding a partner can be found [here](pm_adding_a_partner.md)
+## Importing Partners
-## Importing partners
For details on how to do a bulk import of your partners, please click [here](pm_importing_partners.md)
+## Adding a single Partner
+For your first partner, you can Click on the "Add a Partner" button in your "Getting Started" portion of you dashboard.
+
+
+
+
+For any subsequent Partners, please click on "Partner Agencies", then "All Partners", then "Add a Partner")
+
+
+Further details on adding a partner can be found [here](pm_adding_a_partner.md)
+
[Prior: Storage Locations](getting_started_storage_locations.md)[Next: Donation sites](getting_started_donation_sites.md)
\ No newline at end of file
diff --git a/docs/user_guide/bank/getting_started_storage_locations.md b/docs/user_guide/bank/getting_started_storage_locations.md
index a00613cbfe..e7639bf861 100644
--- a/docs/user_guide/bank/getting_started_storage_locations.md
+++ b/docs/user_guide/bank/getting_started_storage_locations.md
@@ -1,4 +1,4 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
# Getting Started -- Storage Locations
A bank can have multiple storage locations -- these range from warehouses down to space in people's houses. You need at least one storage location in the system.
diff --git a/docs/user_guide/bank/getting_started_user_management.md b/docs/user_guide/bank/getting_started_user_management.md
index 30b04c749a..1655bceba7 100644
--- a/docs/user_guide/bank/getting_started_user_management.md
+++ b/docs/user_guide/bank/getting_started_user_management.md
@@ -1,33 +1,33 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
# Essentials Bank User Administration
-If you're not the sole worker at your essentials bank, you'll likely want other staff to have some access to Human Essentials.
+If you're not the sole worker at your Essentials Bank, you'll likely want other staff to have some access to Human Essentials.
-Note that only people with admin status can administer users, and that partners are administered on a partner-by-partner basis (see [Partner User Admin](pm_partner_user_admin.md)).
+Note that only people with admin status can administer Users, and that Partners are administered on a partner-by-partner basis (see [Partner User Admin](pm_partner_user_admin.md)).
-To manage the rights for your essentials bank users:
+To manage the rights for your Essentials Bank's Users:
-Click on the My Organisation view, then scroll down to the bottom. There is a user administration section there.
+Click on the My Organisation view, then scroll down to the bottom. There is a User administration section there.
-You can also manage the users in your partners, see [Administering partner users](pm_partner_user_admin.md)
+You can also manage the Users in your partners, see [Administering Partner Users](pm_partner_user_admin.md)
+
-
-
-## Inviting new users
+## Inviting new Users
Clicking "Invite User to this Organization" will open a popup where you will enter the name and email of the user. Once you click "Invite User", they will receive an email with a link to follow to set up their password.
-Please note that this link expires. If they don't click on the link in time, the workaround is for them to go to the login screen (http::/human_essentials.app) and click on "reset password".
+Please note that this link expires. If they don't click on the link in time, the workaround is for them to go to the login screen (http::/human_essentials.app) and click on "Reset Password".
-## Promote a user to admin
-To promote a user to admin, just click on the "actions" button beside their information, and then click on "Promote to Admin"
-
+## Promote a User to admin
+To promote a User to admin, just click on the "actions" button beside their information, and then click on "Promote to Admin"
+
## Demote an admin
-To remove a admin's admin rights, just click on the "Demote to User" button beside their information.
-This is a necessary step if you want to remove their rights entirely. [TODO: Discuss if this really is necessary -- shouldn't we be able to do this as one step?]
+To remove an admin's admin rights, just click on the "Demote to User" button beside their information.
+This is a necessary step if you want to remove their rights entirely.
+
Also note that you can't demote yourself. This reduces the risk of leaving the bank without an admin accidentally!
## Remove a user
diff --git a/docs/user_guide/bank/images/account_management/account_management_account_settings.png b/docs/user_guide/bank/images/account_management/account_management_account_settings.png
new file mode 100644
index 0000000000..808dfba651
Binary files /dev/null and b/docs/user_guide/bank/images/account_management/account_management_account_settings.png differ
diff --git a/docs/user_guide/bank/images/account_management/account_management_account_settings_navigation.png b/docs/user_guide/bank/images/account_management/account_management_account_settings_navigation.png
new file mode 100644
index 0000000000..fe2c47c94b
Binary files /dev/null and b/docs/user_guide/bank/images/account_management/account_management_account_settings_navigation.png differ
diff --git a/docs/user_guide/bank/images/account_management/account_management_logout.png b/docs/user_guide/bank/images/account_management/account_management_logout.png
new file mode 100644
index 0000000000..d220846bf9
Binary files /dev/null and b/docs/user_guide/bank/images/account_management/account_management_logout.png differ
diff --git a/docs/user_guide/bank/images/account_management/account_management_my_organization.png b/docs/user_guide/bank/images/account_management/account_management_my_organization.png
new file mode 100644
index 0000000000..b1437a1a89
Binary files /dev/null and b/docs/user_guide/bank/images/account_management/account_management_my_organization.png differ
diff --git a/docs/user_guide/bank/images/community/product_drives/community_product_drives_add.png b/docs/user_guide/bank/images/community/product_drives/community_product_drives_add.png
new file mode 100644
index 0000000000..ec7b355f9b
Binary files /dev/null and b/docs/user_guide/bank/images/community/product_drives/community_product_drives_add.png differ
diff --git a/docs/user_guide/bank/images/community/product_drives/community_product_drives_add_navigation.png b/docs/user_guide/bank/images/community/product_drives/community_product_drives_add_navigation.png
new file mode 100644
index 0000000000..2aecd0648d
Binary files /dev/null and b/docs/user_guide/bank/images/community/product_drives/community_product_drives_add_navigation.png differ
diff --git a/docs/user_guide/bank/images/community/product_drives/community_product_drives_export_navigation.png b/docs/user_guide/bank/images/community/product_drives/community_product_drives_export_navigation.png
new file mode 100644
index 0000000000..ee30090202
Binary files /dev/null and b/docs/user_guide/bank/images/community/product_drives/community_product_drives_export_navigation.png differ
diff --git a/docs/user_guide/bank/images/community/product_drives/community_product_drives_modify.png b/docs/user_guide/bank/images/community/product_drives/community_product_drives_modify.png
new file mode 100644
index 0000000000..0ae10b59ee
Binary files /dev/null and b/docs/user_guide/bank/images/community/product_drives/community_product_drives_modify.png differ
diff --git a/docs/user_guide/bank/images/community/product_drives/community_product_drives_modify_navigation.png b/docs/user_guide/bank/images/community/product_drives/community_product_drives_modify_navigation.png
new file mode 100644
index 0000000000..4b544b4933
Binary files /dev/null and b/docs/user_guide/bank/images/community/product_drives/community_product_drives_modify_navigation.png differ
diff --git a/docs/user_guide/bank/images/community/product_drives/community_product_drives_navigation.png b/docs/user_guide/bank/images/community/product_drives/community_product_drives_navigation.png
new file mode 100644
index 0000000000..4fab821627
Binary files /dev/null and b/docs/user_guide/bank/images/community/product_drives/community_product_drives_navigation.png differ
diff --git a/docs/user_guide/bank/images/community/product_drives/community_product_drives_view.png b/docs/user_guide/bank/images/community/product_drives/community_product_drives_view.png
new file mode 100644
index 0000000000..903639f549
Binary files /dev/null and b/docs/user_guide/bank/images/community/product_drives/community_product_drives_view.png differ
diff --git a/docs/user_guide/bank/images/community/product_drives/community_product_drives_view_navigation.png b/docs/user_guide/bank/images/community/product_drives/community_product_drives_view_navigation.png
new file mode 100644
index 0000000000..a27b9c93ad
Binary files /dev/null and b/docs/user_guide/bank/images/community/product_drives/community_product_drives_view_navigation.png differ
diff --git a/docs/user_guide/bank/images/essentials/distributions/essentials_distribution_print_navigation.png b/docs/user_guide/bank/images/essentials/distributions/essentials_distribution_print_navigation.png
new file mode 100644
index 0000000000..496460f6d8
Binary files /dev/null and b/docs/user_guide/bank/images/essentials/distributions/essentials_distribution_print_navigation.png differ
diff --git a/docs/user_guide/bank/images/essentials/distributions/essentials_distributions_edit.png b/docs/user_guide/bank/images/essentials/distributions/essentials_distributions_edit.png
new file mode 100644
index 0000000000..c79115e206
Binary files /dev/null and b/docs/user_guide/bank/images/essentials/distributions/essentials_distributions_edit.png differ
diff --git a/docs/user_guide/bank/images/essentials/distributions/essentials_distributions_edit_navigation.png b/docs/user_guide/bank/images/essentials/distributions/essentials_distributions_edit_navigation.png
new file mode 100644
index 0000000000..556f54f09d
Binary files /dev/null and b/docs/user_guide/bank/images/essentials/distributions/essentials_distributions_edit_navigation.png differ
diff --git a/docs/user_guide/bank/images/essentials/distributions/essentials_distributions_export_navigation.png b/docs/user_guide/bank/images/essentials/distributions/essentials_distributions_export_navigation.png
new file mode 100644
index 0000000000..f753b1c06b
Binary files /dev/null and b/docs/user_guide/bank/images/essentials/distributions/essentials_distributions_export_navigation.png differ
diff --git a/docs/user_guide/bank/images/essentials/distributions/essentials_distributions_export_sample.png b/docs/user_guide/bank/images/essentials/distributions/essentials_distributions_export_sample.png
new file mode 100644
index 0000000000..3a9680b20c
Binary files /dev/null and b/docs/user_guide/bank/images/essentials/distributions/essentials_distributions_export_sample.png differ
diff --git a/docs/user_guide/bank/images/essentials/distributions/essentials_distributions_filter.png b/docs/user_guide/bank/images/essentials/distributions/essentials_distributions_filter.png
new file mode 100644
index 0000000000..c2e2c433a5
Binary files /dev/null and b/docs/user_guide/bank/images/essentials/distributions/essentials_distributions_filter.png differ
diff --git a/docs/user_guide/bank/images/essentials/distributions/essentials_distributions_navigation.png b/docs/user_guide/bank/images/essentials/distributions/essentials_distributions_navigation.png
new file mode 100644
index 0000000000..a7285b17d7
Binary files /dev/null and b/docs/user_guide/bank/images/essentials/distributions/essentials_distributions_navigation.png differ
diff --git a/docs/user_guide/bank/images/essentials/distributions/essentials_distributions_printout.png b/docs/user_guide/bank/images/essentials/distributions/essentials_distributions_printout.png
new file mode 100644
index 0000000000..162aac34e0
Binary files /dev/null and b/docs/user_guide/bank/images/essentials/distributions/essentials_distributions_printout.png differ
diff --git a/docs/user_guide/bank/images/essentials/distributions/essentials_distributions_view.png b/docs/user_guide/bank/images/essentials/distributions/essentials_distributions_view.png
new file mode 100644
index 0000000000..ac224d279f
Binary files /dev/null and b/docs/user_guide/bank/images/essentials/distributions/essentials_distributions_view.png differ
diff --git a/docs/user_guide/bank/images/essentials/distributions/essentials_distributions_view_navigation.png b/docs/user_guide/bank/images/essentials/distributions/essentials_distributions_view_navigation.png
new file mode 100644
index 0000000000..2dcd52ad77
Binary files /dev/null and b/docs/user_guide/bank/images/essentials/distributions/essentials_distributions_view_navigation.png differ
diff --git a/docs/user_guide/bank/images/essentials/purchases/essentials_purchaces_view.png b/docs/user_guide/bank/images/essentials/purchases/essentials_purchaces_view.png
new file mode 100644
index 0000000000..e26beb4601
Binary files /dev/null and b/docs/user_guide/bank/images/essentials/purchases/essentials_purchaces_view.png differ
diff --git a/docs/user_guide/bank/images/essentials/purchases/essentials_purchases_1.png b/docs/user_guide/bank/images/essentials/purchases/essentials_purchases_1.png
new file mode 100644
index 0000000000..366d41af33
Binary files /dev/null and b/docs/user_guide/bank/images/essentials/purchases/essentials_purchases_1.png differ
diff --git a/docs/user_guide/bank/images/essentials/purchases/essentials_purchases_2.png b/docs/user_guide/bank/images/essentials/purchases/essentials_purchases_2.png
new file mode 100644
index 0000000000..ae38483afb
Binary files /dev/null and b/docs/user_guide/bank/images/essentials/purchases/essentials_purchases_2.png differ
diff --git a/docs/user_guide/bank/images/essentials/purchases/essentials_purchases_3.png b/docs/user_guide/bank/images/essentials/purchases/essentials_purchases_3.png
new file mode 100644
index 0000000000..b8d49247a9
Binary files /dev/null and b/docs/user_guide/bank/images/essentials/purchases/essentials_purchases_3.png differ
diff --git a/docs/user_guide/bank/images/essentials/purchases/essentials_purchases_4.png b/docs/user_guide/bank/images/essentials/purchases/essentials_purchases_4.png
new file mode 100644
index 0000000000..1ef9d3c69d
Binary files /dev/null and b/docs/user_guide/bank/images/essentials/purchases/essentials_purchases_4.png differ
diff --git a/docs/user_guide/bank/images/essentials/purchases/essentials_purchases_delete_navigation.png b/docs/user_guide/bank/images/essentials/purchases/essentials_purchases_delete_navigation.png
new file mode 100644
index 0000000000..ee68a23666
Binary files /dev/null and b/docs/user_guide/bank/images/essentials/purchases/essentials_purchases_delete_navigation.png differ
diff --git a/docs/user_guide/bank/images/essentials/purchases/essentials_purchases_edit_navigation.png b/docs/user_guide/bank/images/essentials/purchases/essentials_purchases_edit_navigation.png
new file mode 100644
index 0000000000..0cb7c63f77
Binary files /dev/null and b/docs/user_guide/bank/images/essentials/purchases/essentials_purchases_edit_navigation.png differ
diff --git a/docs/user_guide/bank/images/essentials/purchases/essentials_purchases_export_navigation.png b/docs/user_guide/bank/images/essentials/purchases/essentials_purchases_export_navigation.png
new file mode 100644
index 0000000000..ceb233f3c2
Binary files /dev/null and b/docs/user_guide/bank/images/essentials/purchases/essentials_purchases_export_navigation.png differ
diff --git a/docs/user_guide/bank/images/essentials/requests/essentials_requests_cancel_confirm.png b/docs/user_guide/bank/images/essentials/requests/essentials_requests_cancel_confirm.png
new file mode 100644
index 0000000000..2fff9e9b1f
Binary files /dev/null and b/docs/user_guide/bank/images/essentials/requests/essentials_requests_cancel_confirm.png differ
diff --git a/docs/user_guide/bank/images/essentials/requests/essentials_requests_cancel_email.png b/docs/user_guide/bank/images/essentials/requests/essentials_requests_cancel_email.png
new file mode 100644
index 0000000000..21dcd05e02
Binary files /dev/null and b/docs/user_guide/bank/images/essentials/requests/essentials_requests_cancel_email.png differ
diff --git a/docs/user_guide/bank/images/essentials/requests/essentials_requests_cancel_navigation.png b/docs/user_guide/bank/images/essentials/requests/essentials_requests_cancel_navigation.png
new file mode 100644
index 0000000000..c88d13ef3d
Binary files /dev/null and b/docs/user_guide/bank/images/essentials/requests/essentials_requests_cancel_navigation.png differ
diff --git a/docs/user_guide/bank/images/essentials/requests/essentials_requests_export_navigation.png b/docs/user_guide/bank/images/essentials/requests/essentials_requests_export_navigation.png
new file mode 100644
index 0000000000..dd2573b9de
Binary files /dev/null and b/docs/user_guide/bank/images/essentials/requests/essentials_requests_export_navigation.png differ
diff --git a/docs/user_guide/bank/images/essentials/requests/essentials_requests_navigation.png b/docs/user_guide/bank/images/essentials/requests/essentials_requests_navigation.png
new file mode 100644
index 0000000000..17bfcd5c59
Binary files /dev/null and b/docs/user_guide/bank/images/essentials/requests/essentials_requests_navigation.png differ
diff --git a/docs/user_guide/bank/images/essentials/requests/essentials_requests_picklist.png b/docs/user_guide/bank/images/essentials/requests/essentials_requests_picklist.png
new file mode 100644
index 0000000000..66f2ef5ce7
Binary files /dev/null and b/docs/user_guide/bank/images/essentials/requests/essentials_requests_picklist.png differ
diff --git a/docs/user_guide/bank/images/essentials/requests/essentials_requests_print_picklists_navigation.png b/docs/user_guide/bank/images/essentials/requests/essentials_requests_print_picklists_navigation.png
new file mode 100644
index 0000000000..70d0b6531e
Binary files /dev/null and b/docs/user_guide/bank/images/essentials/requests/essentials_requests_print_picklists_navigation.png differ
diff --git a/docs/user_guide/bank/images/essentials/requests/essentials_requests_product_totals.png b/docs/user_guide/bank/images/essentials/requests/essentials_requests_product_totals.png
new file mode 100644
index 0000000000..17b0492843
Binary files /dev/null and b/docs/user_guide/bank/images/essentials/requests/essentials_requests_product_totals.png differ
diff --git a/docs/user_guide/bank/images/essentials/requests/essentials_requests_product_totals_navigation.png b/docs/user_guide/bank/images/essentials/requests/essentials_requests_product_totals_navigation.png
new file mode 100644
index 0000000000..7cc05de46c
Binary files /dev/null and b/docs/user_guide/bank/images/essentials/requests/essentials_requests_product_totals_navigation.png differ
diff --git a/docs/user_guide/bank/images/essentials/requests/essentials_requests_view.png b/docs/user_guide/bank/images/essentials/requests/essentials_requests_view.png
new file mode 100644
index 0000000000..446d4a2252
Binary files /dev/null and b/docs/user_guide/bank/images/essentials/requests/essentials_requests_view.png differ
diff --git a/docs/user_guide/bank/images/essentials/requests/essentials_requests_view_navigation.png b/docs/user_guide/bank/images/essentials/requests/essentials_requests_view_navigation.png
new file mode 100644
index 0000000000..0bccf9ee49
Binary files /dev/null and b/docs/user_guide/bank/images/essentials/requests/essentials_requests_view_navigation.png differ
diff --git a/docs/user_guide/bank/images/getting_started/customization/gs_customization_navigation_1.png b/docs/user_guide/bank/images/getting_started/customization/gs_customization_navigation_1.png
new file mode 100644
index 0000000000..6f76807640
Binary files /dev/null and b/docs/user_guide/bank/images/getting_started/customization/gs_customization_navigation_1.png differ
diff --git a/docs/user_guide/bank/images/getting_started/customization/gs_customization_navigation_2.png b/docs/user_guide/bank/images/getting_started/customization/gs_customization_navigation_2.png
new file mode 100644
index 0000000000..be763b50ad
Binary files /dev/null and b/docs/user_guide/bank/images/getting_started/customization/gs_customization_navigation_2.png differ
diff --git a/docs/user_guide/bank/images/getting_started/customization/gs_customization_top_of_edit.png b/docs/user_guide/bank/images/getting_started/customization/gs_customization_top_of_edit.png
new file mode 100644
index 0000000000..27d071231a
Binary files /dev/null and b/docs/user_guide/bank/images/getting_started/customization/gs_customization_top_of_edit.png differ
diff --git a/docs/user_guide/bank/images/getting_started/partners/gs_just_starting_step_2.png b/docs/user_guide/bank/images/getting_started/partners/gs_just_starting_step_2.png
index 778466ff43..9598d80585 100644
Binary files a/docs/user_guide/bank/images/getting_started/partners/gs_just_starting_step_2.png and b/docs/user_guide/bank/images/getting_started/partners/gs_just_starting_step_2.png differ
diff --git a/docs/user_guide/bank/images/getting_started/partners/gs_just_starting_step_2_import.png b/docs/user_guide/bank/images/getting_started/partners/gs_just_starting_step_2_import.png
new file mode 100644
index 0000000000..e64d52a79d
Binary files /dev/null and b/docs/user_guide/bank/images/getting_started/partners/gs_just_starting_step_2_import.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_adjustments_navigation.png b/docs/user_guide/bank/images/inventory/inventory_adjustments_navigation.png
new file mode 100644
index 0000000000..06c92d8d04
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_adjustments_navigation.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_adjustments_new.png b/docs/user_guide/bank/images/inventory/inventory_adjustments_new.png
new file mode 100644
index 0000000000..deb49e6f67
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_adjustments_new.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_adjustments_new_navigation.png b/docs/user_guide/bank/images/inventory/inventory_adjustments_new_navigation.png
new file mode 100644
index 0000000000..ca213f0f5f
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_adjustments_new_navigation.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_adjustments_result.png b/docs/user_guide/bank/images/inventory/inventory_adjustments_result.png
new file mode 100644
index 0000000000..60cfe3654c
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_adjustments_result.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_adjustments_view.png b/docs/user_guide/bank/images/inventory/inventory_adjustments_view.png
new file mode 100644
index 0000000000..efd05b0452
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_adjustments_view.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_adjustments_view_navigation.png b/docs/user_guide/bank/images/inventory/inventory_adjustments_view_navigation.png
new file mode 100644
index 0000000000..a7a5889ae6
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_adjustments_view_navigation.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_audits_confirm.png b/docs/user_guide/bank/images/inventory/inventory_audits_confirm.png
new file mode 100644
index 0000000000..19c34c52bc
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_audits_confirm.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_audits_delete.png b/docs/user_guide/bank/images/inventory/inventory_audits_delete.png
new file mode 100644
index 0000000000..d207862c06
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_audits_delete.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_audits_finalize.png b/docs/user_guide/bank/images/inventory/inventory_audits_finalize.png
new file mode 100644
index 0000000000..b522c2a847
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_audits_finalize.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_audits_new.png b/docs/user_guide/bank/images/inventory/inventory_audits_new.png
new file mode 100644
index 0000000000..1fa99625a6
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_audits_new.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_audits_new_navigation.png b/docs/user_guide/bank/images/inventory/inventory_audits_new_navigation.png
new file mode 100644
index 0000000000..5726e239d2
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_audits_new_navigation.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_audits_progress.png b/docs/user_guide/bank/images/inventory/inventory_audits_progress.png
new file mode 100644
index 0000000000..5326a7357d
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_audits_progress.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_audits_resume.png b/docs/user_guide/bank/images/inventory/inventory_audits_resume.png
new file mode 100644
index 0000000000..26adff2cd5
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_audits_resume.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_audits_view_navigation.png b/docs/user_guide/bank/images/inventory/inventory_audits_view_navigation.png
new file mode 100644
index 0000000000..13815aef3e
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_audits_view_navigation.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_barcodes_delete.png b/docs/user_guide/bank/images/inventory/inventory_barcodes_delete.png
new file mode 100644
index 0000000000..8705dcd980
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_barcodes_delete.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_barcodes_edit_navigation.png b/docs/user_guide/bank/images/inventory/inventory_barcodes_edit_navigation.png
new file mode 100644
index 0000000000..ede92711f3
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_barcodes_edit_navigation.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_barcodes_export.png b/docs/user_guide/bank/images/inventory/inventory_barcodes_export.png
new file mode 100644
index 0000000000..0d120f436b
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_barcodes_export.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_barcodes_export_navigation.png b/docs/user_guide/bank/images/inventory/inventory_barcodes_export_navigation.png
new file mode 100644
index 0000000000..7d142b8883
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_barcodes_export_navigation.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_barcodes_navigation.png b/docs/user_guide/bank/images/inventory/inventory_barcodes_navigation.png
new file mode 100644
index 0000000000..c9c81e3fea
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_barcodes_navigation.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_barcodes_new.png b/docs/user_guide/bank/images/inventory/inventory_barcodes_new.png
new file mode 100644
index 0000000000..c33b6b10fa
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_barcodes_new.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_barcodes_new_navigation.png b/docs/user_guide/bank/images/inventory/inventory_barcodes_new_navigation.png
new file mode 100644
index 0000000000..262d0fb458
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_barcodes_new_navigation.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_category_view_navigation.png b/docs/user_guide/bank/images/inventory/inventory_category_view_navigation.png
new file mode 100644
index 0000000000..4873969384
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_category_view_navigation.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_item_category_edit.png b/docs/user_guide/bank/images/inventory/inventory_item_category_edit.png
new file mode 100644
index 0000000000..9ff789024f
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_item_category_edit.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_item_category_edit_navigation.png b/docs/user_guide/bank/images/inventory/inventory_item_category_edit_navigation.png
new file mode 100644
index 0000000000..bb0d387814
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_item_category_edit_navigation.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_item_category_navigation.png b/docs/user_guide/bank/images/inventory/inventory_item_category_navigation.png
new file mode 100644
index 0000000000..26cfbc9bbc
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_item_category_navigation.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_item_category_new.png b/docs/user_guide/bank/images/inventory/inventory_item_category_new.png
new file mode 100644
index 0000000000..39003ff592
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_item_category_new.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_item_category_new_navigation.png b/docs/user_guide/bank/images/inventory/inventory_item_category_new_navigation.png
new file mode 100644
index 0000000000..e8a2fad3f0
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_item_category_new_navigation.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_item_category_view.png b/docs/user_guide/bank/images/inventory/inventory_item_category_view.png
new file mode 100644
index 0000000000..945675e236
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_item_category_view.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_item_location_navigation.png b/docs/user_guide/bank/images/inventory/inventory_item_location_navigation.png
new file mode 100644
index 0000000000..278396c755
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_item_location_navigation.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_items_delete_vs_deactivate.png b/docs/user_guide/bank/images/inventory/inventory_items_delete_vs_deactivate.png
new file mode 100644
index 0000000000..d78691b263
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_items_delete_vs_deactivate.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_items_edit.png b/docs/user_guide/bank/images/inventory/inventory_items_edit.png
new file mode 100644
index 0000000000..9ebbaac008
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_items_edit.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_items_edit_navigation.png b/docs/user_guide/bank/images/inventory/inventory_items_edit_navigation.png
new file mode 100644
index 0000000000..5c2b7d5a3a
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_items_edit_navigation.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_items_inventory_navigation.png b/docs/user_guide/bank/images/inventory/inventory_items_inventory_navigation.png
new file mode 100644
index 0000000000..c3fb4a32c9
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_items_inventory_navigation.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_items_kits_navigation.png b/docs/user_guide/bank/images/inventory/inventory_items_kits_navigation.png
new file mode 100644
index 0000000000..f29b286b07
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_items_kits_navigation.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_items_navigation.png b/docs/user_guide/bank/images/inventory/inventory_items_navigation.png
new file mode 100644
index 0000000000..dc90155680
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_items_navigation.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_items_reactivation.png b/docs/user_guide/bank/images/inventory/inventory_items_reactivation.png
new file mode 100644
index 0000000000..010790aac7
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_items_reactivation.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_items_view.png b/docs/user_guide/bank/images/inventory/inventory_items_view.png
new file mode 100644
index 0000000000..d1567ac51a
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_items_view.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_items_view_navigation.png b/docs/user_guide/bank/images/inventory/inventory_items_view_navigation.png
new file mode 100644
index 0000000000..d56e463308
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_items_view_navigation.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_kits_allocation.png b/docs/user_guide/bank/images/inventory/inventory_kits_allocation.png
new file mode 100644
index 0000000000..63cdd3b643
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_kits_allocation.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_kits_allocation_post_save.png b/docs/user_guide/bank/images/inventory/inventory_kits_allocation_post_save.png
new file mode 100644
index 0000000000..1ccbbde49f
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_kits_allocation_post_save.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_kits_deactivate.png b/docs/user_guide/bank/images/inventory/inventory_kits_deactivate.png
new file mode 100644
index 0000000000..c36e44b3b5
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_kits_deactivate.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_kits_modify_allocation_navigation.png b/docs/user_guide/bank/images/inventory/inventory_kits_modify_allocation_navigation.png
new file mode 100644
index 0000000000..f55a09dbc0
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_kits_modify_allocation_navigation.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_kits_new.png b/docs/user_guide/bank/images/inventory/inventory_kits_new.png
new file mode 100644
index 0000000000..a024516285
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_kits_new.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_kits_new_navigation.png b/docs/user_guide/bank/images/inventory/inventory_kits_new_navigation.png
new file mode 100644
index 0000000000..8fbac6773b
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_kits_new_navigation.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_kits_reactivate.png b/docs/user_guide/bank/images/inventory/inventory_kits_reactivate.png
new file mode 100644
index 0000000000..4a24f518f2
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_kits_reactivate.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_storage_location_reactivation.png b/docs/user_guide/bank/images/inventory/inventory_storage_location_reactivation.png
new file mode 100644
index 0000000000..6165c8cae0
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_storage_location_reactivation.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_storage_location_view_inventory.png b/docs/user_guide/bank/images/inventory/inventory_storage_location_view_inventory.png
new file mode 100644
index 0000000000..7878d14224
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_storage_location_view_inventory.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_storage_locations_add.png b/docs/user_guide/bank/images/inventory/inventory_storage_locations_add.png
new file mode 100644
index 0000000000..bd760f4c81
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_storage_locations_add.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_storage_locations_add_navigation.png b/docs/user_guide/bank/images/inventory/inventory_storage_locations_add_navigation.png
new file mode 100644
index 0000000000..bdb92ad663
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_storage_locations_add_navigation.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_storage_locations_coming_in.png b/docs/user_guide/bank/images/inventory/inventory_storage_locations_coming_in.png
new file mode 100644
index 0000000000..95b7abf013
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_storage_locations_coming_in.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_storage_locations_going_out.png b/docs/user_guide/bank/images/inventory/inventory_storage_locations_going_out.png
new file mode 100644
index 0000000000..e7f3cf78fe
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_storage_locations_going_out.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_storage_locations_navigation.png b/docs/user_guide/bank/images/inventory/inventory_storage_locations_navigation.png
new file mode 100644
index 0000000000..c638a559ad
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_storage_locations_navigation.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_transfers_delete.png b/docs/user_guide/bank/images/inventory/inventory_transfers_delete.png
new file mode 100644
index 0000000000..1569ef9760
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_transfers_delete.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_transfers_export.png b/docs/user_guide/bank/images/inventory/inventory_transfers_export.png
new file mode 100644
index 0000000000..0cdaf2eb68
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_transfers_export.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_transfers_export_navigation.png b/docs/user_guide/bank/images/inventory/inventory_transfers_export_navigation.png
new file mode 100644
index 0000000000..13c59c2543
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_transfers_export_navigation.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_transfers_navigation.png b/docs/user_guide/bank/images/inventory/inventory_transfers_navigation.png
new file mode 100644
index 0000000000..0debdd6700
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_transfers_navigation.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_transfers_new.png b/docs/user_guide/bank/images/inventory/inventory_transfers_new.png
new file mode 100644
index 0000000000..a299c286a7
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_transfers_new.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_transfers_new_navigation.png b/docs/user_guide/bank/images/inventory/inventory_transfers_new_navigation.png
new file mode 100644
index 0000000000..7ee84b394f
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_transfers_new_navigation.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_transfers_view.png b/docs/user_guide/bank/images/inventory/inventory_transfers_view.png
new file mode 100644
index 0000000000..6bfdf738df
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_transfers_view.png differ
diff --git a/docs/user_guide/bank/images/inventory/inventory_transfers_view_navigation.png b/docs/user_guide/bank/images/inventory/inventory_transfers_view_navigation.png
new file mode 100644
index 0000000000..3df0e467f7
Binary files /dev/null and b/docs/user_guide/bank/images/inventory/inventory_transfers_view_navigation.png differ
diff --git a/docs/user_guide/bank/images/partners/partners_add.png b/docs/user_guide/bank/images/partners/partners_add.png
new file mode 100644
index 0000000000..555e2bf576
Binary files /dev/null and b/docs/user_guide/bank/images/partners/partners_add.png differ
diff --git a/docs/user_guide/bank/images/partners/partners_add_navigation.png b/docs/user_guide/bank/images/partners/partners_add_navigation.png
new file mode 100644
index 0000000000..0cd2810d54
Binary files /dev/null and b/docs/user_guide/bank/images/partners/partners_add_navigation.png differ
diff --git a/docs/user_guide/bank/images/partners/partners_approving_1.png b/docs/user_guide/bank/images/partners/partners_approving_1.png
new file mode 100644
index 0000000000..d4c7656b99
Binary files /dev/null and b/docs/user_guide/bank/images/partners/partners_approving_1.png differ
diff --git a/docs/user_guide/bank/images/partners/partners_approving_2.png b/docs/user_guide/bank/images/partners/partners_approving_2.png
new file mode 100644
index 0000000000..3f7364b083
Binary files /dev/null and b/docs/user_guide/bank/images/partners/partners_approving_2.png differ
diff --git a/docs/user_guide/bank/images/partners/partners_deactivate_1.png b/docs/user_guide/bank/images/partners/partners_deactivate_1.png
new file mode 100644
index 0000000000..23c3a5cfe8
Binary files /dev/null and b/docs/user_guide/bank/images/partners/partners_deactivate_1.png differ
diff --git a/docs/user_guide/bank/images/partners/partners_deactivate_2.png b/docs/user_guide/bank/images/partners/partners_deactivate_2.png
new file mode 100644
index 0000000000..a1b5349744
Binary files /dev/null and b/docs/user_guide/bank/images/partners/partners_deactivate_2.png differ
diff --git a/docs/user_guide/bank/images/partners/partners_edit.png b/docs/user_guide/bank/images/partners/partners_edit.png
new file mode 100644
index 0000000000..346c1ad912
Binary files /dev/null and b/docs/user_guide/bank/images/partners/partners_edit.png differ
diff --git a/docs/user_guide/bank/images/partners/partners_edit_navigation.png b/docs/user_guide/bank/images/partners/partners_edit_navigation.png
new file mode 100644
index 0000000000..9dfe5cd389
Binary files /dev/null and b/docs/user_guide/bank/images/partners/partners_edit_navigation.png differ
diff --git a/docs/user_guide/bank/images/partners/partners_invitation_email.png b/docs/user_guide/bank/images/partners/partners_invitation_email.png
new file mode 100644
index 0000000000..a6cd89553c
Binary files /dev/null and b/docs/user_guide/bank/images/partners/partners_invitation_email.png differ
diff --git a/docs/user_guide/bank/images/partners/partners_inviting.png b/docs/user_guide/bank/images/partners/partners_inviting.png
new file mode 100644
index 0000000000..f043c06a72
Binary files /dev/null and b/docs/user_guide/bank/images/partners/partners_inviting.png differ
diff --git a/docs/user_guide/bank/images/partners/partners_inviting_and_approving.png b/docs/user_guide/bank/images/partners/partners_inviting_and_approving.png
new file mode 100644
index 0000000000..0b30c3c953
Binary files /dev/null and b/docs/user_guide/bank/images/partners/partners_inviting_and_approving.png differ
diff --git a/docs/user_guide/bank/images/partners/partners_profile_edit_navigation_1.png b/docs/user_guide/bank/images/partners/partners_profile_edit_navigation_1.png
new file mode 100644
index 0000000000..119aff6db3
Binary files /dev/null and b/docs/user_guide/bank/images/partners/partners_profile_edit_navigation_1.png differ
diff --git a/docs/user_guide/bank/images/partners/partners_profile_edit_navigation_2.png b/docs/user_guide/bank/images/partners/partners_profile_edit_navigation_2.png
new file mode 100644
index 0000000000..edd3dd613b
Binary files /dev/null and b/docs/user_guide/bank/images/partners/partners_profile_edit_navigation_2.png differ
diff --git a/docs/user_guide/bank/images/partners/partners_recertification.png b/docs/user_guide/bank/images/partners/partners_recertification.png
new file mode 100644
index 0000000000..685d4320e7
Binary files /dev/null and b/docs/user_guide/bank/images/partners/partners_recertification.png differ
diff --git a/docs/user_guide/bank/images/partners/partners_recertification_email.png b/docs/user_guide/bank/images/partners/partners_recertification_email.png
new file mode 100644
index 0000000000..c567b5f5b5
Binary files /dev/null and b/docs/user_guide/bank/images/partners/partners_recertification_email.png differ
diff --git a/docs/user_guide/bank/images/partners/partners_review_application_from_dashboard.png b/docs/user_guide/bank/images/partners/partners_review_application_from_dashboard.png
new file mode 100644
index 0000000000..15465c5f51
Binary files /dev/null and b/docs/user_guide/bank/images/partners/partners_review_application_from_dashboard.png differ
diff --git a/docs/user_guide/bank/images/partners/partners_review_application_navigation.png b/docs/user_guide/bank/images/partners/partners_review_application_navigation.png
new file mode 100644
index 0000000000..b04bfd3732
Binary files /dev/null and b/docs/user_guide/bank/images/partners/partners_review_application_navigation.png differ
diff --git a/docs/user_guide/bank/images/partners/partners_user_management.png b/docs/user_guide/bank/images/partners/partners_user_management.png
new file mode 100644
index 0000000000..c7caa08ec9
Binary files /dev/null and b/docs/user_guide/bank/images/partners/partners_user_management.png differ
diff --git a/docs/user_guide/bank/images/partners/partners_user_management_navigation_1.png b/docs/user_guide/bank/images/partners/partners_user_management_navigation_1.png
new file mode 100644
index 0000000000..4d2301e081
Binary files /dev/null and b/docs/user_guide/bank/images/partners/partners_user_management_navigation_1.png differ
diff --git a/docs/user_guide/bank/images/partners/partners_user_management_navigation_2.png b/docs/user_guide/bank/images/partners/partners_user_management_navigation_2.png
new file mode 100644
index 0000000000..a9c809edeb
Binary files /dev/null and b/docs/user_guide/bank/images/partners/partners_user_management_navigation_2.png differ
diff --git a/docs/user_guide/bank/images/partners/partners_viewing_and_reactivating_deactivated.png b/docs/user_guide/bank/images/partners/partners_viewing_and_reactivating_deactivated.png
new file mode 100644
index 0000000000..3379c686a4
Binary files /dev/null and b/docs/user_guide/bank/images/partners/partners_viewing_and_reactivating_deactivated.png differ
diff --git a/docs/user_guide/bank/images/reports/reports_summary_distributions.png b/docs/user_guide/bank/images/reports/reports_summary_distributions.png
new file mode 100644
index 0000000000..aed7914403
Binary files /dev/null and b/docs/user_guide/bank/images/reports/reports_summary_distributions.png differ
diff --git a/docs/user_guide/bank/images/reports/reports_summary_donations.png b/docs/user_guide/bank/images/reports/reports_summary_donations.png
new file mode 100644
index 0000000000..72bf7feca0
Binary files /dev/null and b/docs/user_guide/bank/images/reports/reports_summary_donations.png differ
diff --git a/docs/user_guide/bank/images/reports/reports_summary_purchases.png b/docs/user_guide/bank/images/reports/reports_summary_purchases.png
new file mode 100644
index 0000000000..3bec6bfbf9
Binary files /dev/null and b/docs/user_guide/bank/images/reports/reports_summary_purchases.png differ
diff --git a/docs/user_guide/bank/images/user_management/user_access_admin_and_user.png b/docs/user_guide/bank/images/user_management/user_access_admin_and_user.png
new file mode 100644
index 0000000000..94d0f6cbf2
Binary files /dev/null and b/docs/user_guide/bank/images/user_management/user_access_admin_and_user.png differ
diff --git a/docs/user_guide/bank/images/user_management/user_access_partner.png b/docs/user_guide/bank/images/user_management/user_access_partner.png
new file mode 100644
index 0000000000..6925b22c3c
Binary files /dev/null and b/docs/user_guide/bank/images/user_management/user_access_partner.png differ
diff --git a/docs/user_guide/bank/images/user_management/user_delete_bank_user.png b/docs/user_guide/bank/images/user_management/user_delete_bank_user.png
new file mode 100644
index 0000000000..1d90118273
Binary files /dev/null and b/docs/user_guide/bank/images/user_management/user_delete_bank_user.png differ
diff --git a/docs/user_guide/bank/images/user_management/user_demote_admin.png b/docs/user_guide/bank/images/user_management/user_demote_admin.png
new file mode 100644
index 0000000000..35fd7f804f
Binary files /dev/null and b/docs/user_guide/bank/images/user_management/user_demote_admin.png differ
diff --git a/docs/user_guide/bank/images/user_management/user_invite_new_bank_user.png b/docs/user_guide/bank/images/user_management/user_invite_new_bank_user.png
new file mode 100644
index 0000000000..58080d69b0
Binary files /dev/null and b/docs/user_guide/bank/images/user_management/user_invite_new_bank_user.png differ
diff --git a/docs/user_guide/bank/images/user_management/user_promote_bank_user.png b/docs/user_guide/bank/images/user_management/user_promote_bank_user.png
new file mode 100644
index 0000000000..d93e0452e9
Binary files /dev/null and b/docs/user_guide/bank/images/user_management/user_promote_bank_user.png differ
diff --git a/docs/user_guide/bank/intro_i.md b/docs/user_guide/bank/intro_i.md
index 88f4b34ef4..27819b9ad2 100644
--- a/docs/user_guide/bank/intro_i.md
+++ b/docs/user_guide/bank/intro_i.md
@@ -1,10 +1,8 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
-# Is Human Essentials right for you? (what we help with and what we don't)
-## Human Essentials is a free system for essentials banks
-Human Essentials is for essentials banks -- by which we mean organizations that distribute essentials (diapers, period products, etc) to other organizations that work directly with people in need.
-
-If you *only* deal directly with people in need, this is probably not the system for you.
+# Is Human Essentials Right for You? (What We Help with and What We Don't)
+## Human Essentials is a free system for Essentials Banks
+Human Essentials is for Essentials Banks -- by which we mean organizations that distribute essentials (diapers, period products, etc) to other organizations that work directly with people in need.
## We are an all-volunteer organization
@@ -12,26 +10,27 @@ We can offer this system for free because we are an all-volunteer organization.
sponsors who provide funding or in-kind services for the servers that the system runs on, but changes/support can take time.
## What we help with
-- managing your partners
- - gathering the information about your partners that you need
- - your request / distribution cycle (partner agencies can provide requests to you through the system, and you fulfill them)
- - monthly reminders to the partners re request deadlines
- - calendar that shows when you've scheduled pickups and deliveries
+- managing your Partners
+ - gathering the information about your Partners that you need
+ - your Request / Distribution cycle (Partners can provide requests to you through the system, and you fulfill them)
+ - monthly reminders to the Partners re Request deadlines
+ - calendar that shows when you've scheduled Pickups and Deliveries
- inventory
- - when you record donations, purchases, and distributions, your inventory record is automatically adjusted as of the date/time you enter the information
- - audits and inventory adjustments
- - handles multiple storage locations
- - making up kits for distribution from existing inventory (this is mostly used by our period supply focused banks)
+ - when you record Donations, Purchases, and Distributions (to Partners), your Inventory record is automatically adjusted as of the date/time you enter the information
+ - Audits and Inventory Adjustments
+ - handles multiple Storage Locations
+ - making up Kits for distribution from existing Inventory (this is mostly used by our period supply focused banks)
- community management
- - keeping track of your donation sites, product drives (and participants)
+ - keeping track of your Donation sites, Product Drives (and Product Drive Participants)
- reporting
- yearly report with much of the information the NDBN annual survey requires drawn from your activity in the system
- itemized distribution breakdown over time
- trend reporting
+
## Things we don't help with
- general business needs (like payroll and office supplies and the like)
- volunteer coordination
- donor tax receipts
-- direct distribution -- there are some things that help with that in the partner side, and some banks run a partner for their direct distribution, but it is not our strength.
+- direct distribution -- there are some things that help with that in the Partner side, and some banks run a Partner for their direct distribution practice, but it is not our strength.
[Next: Support](intro_ii.md)
\ No newline at end of file
diff --git a/docs/user_guide/bank/intro_ii.md b/docs/user_guide/bank/intro_ii.md
index 0d0ed0d1fb..0f65d18eb5 100644
--- a/docs/user_guide/bank/intro_ii.md
+++ b/docs/user_guide/bank/intro_ii.md
@@ -1,12 +1,10 @@
-DRAFT USER GUIDE
-
+READY FOR REVIEW
# Support
There are a few ways to get support -- some are better than others.
-## For banks:
+## For Banks:
### Slack
-We highly recommend that you become a member of the human essentials Slack. Here's a link to an invite: https://human-essential.slack.com/join/shared_invite/zt-bfa8tymd-d8Ks3Mq000COcRe~nfs~zg#/shared-invite/email
-
+We highly recommend that you become a member of the Human Essentials Slack. Here's a link to an invite: https://human-essential.slack.com/join/shared_invite/zt-bfa8tymd-d8Ks3Mq000COcRe~nfs~zg#/shared-invite/email
It's a good place to ask about how other banks *actually* use the system
-- any workarounds for things that don't 100% match how the system is set up.
@@ -24,6 +22,13 @@ You can email info@humanessentials.app. We generally look at these about once
We hold a stakeholder circle the first Wednesday of every month at 6:00pm Eastern Time. There will be other banks there, plus a couple members of the Human Essentials team.
We publish the zoom, and (when we remember) in the Announcements in Human Essentials.
+
+### Keeping up-to-date with changes
+We release changes to the system most weeks on Sundays between 10am and noon Eastern time (the system will be down for a short period when we do). When we do, we put up an announcment in the system, which you will see on your [dashboard](essentials_dashboard.md). We also record them in a newsletter at: https://ruby-for-good.gitbook.io/human-essentials-news
+
+
+
+
## For partners:
We recommend that the partners seek support through the banks. Each bank has their own particular way of doing things, and the development team doesn't want to mess that up.
diff --git a/docs/user_guide/bank/inventory_adjustments.md b/docs/user_guide/bank/inventory_adjustments.md
index 0f382dc3a3..fa6fdd35e7 100644
--- a/docs/user_guide/bank/inventory_adjustments.md
+++ b/docs/user_guide/bank/inventory_adjustments.md
@@ -1,35 +1,41 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
# Inventory Adjustments
-Inventory adjustments are an alternative way to record known differences in the inventory without going through the audit process.
-They don't require the two step process that an audit does, but are entered as adjustments, rather than as the actual inventory levels.
+Inventory adjustments are an alternative way to record known differences in the inventory without going through the Audit process.
+They don't require the two step process that an Audit does, but are entered as adjustments, rather than as the actual inventory levels.
-Note that inventory adjustments are permanent -- if you need to reverse them, you have to enter an adjustment in the other direction.
+Note that Inventory Adjustments are permanent -- if you need to reverse them, you have to enter an adjustment in the other direction.
-Unlike the audit, there is no review step. The changes to inventory are made immediately.
+Unlike the Audit, there is no review step. The changes to inventory are made immediately.
-You can not edit inventory adjustments.
-
-[TODO: Who can make these?]
+You can not edit Inventory Adjustments.
## The inventory adjustment page
-You can manage your inventory adjustments through the inventory adjustment page. Click on "Inventory" in the left-hand menu, then "Imventry Adjustments"
+You can manage your Inventory Adjustments through the inventory adjustment page. Click on "Inventory" in the left-hand menu, then "Inventory Adjustments"
+
## Making an inventory adjustment
-To enter a new inventory adjustment, click on "New adjustment"
-[TODO: Screenshot]
-Choose the storage location, add any notes you have in the comments section, and, for each item you are adjusting, enter either a number greater than 0 to increase the inventory, or a number less than zero to decrease it.
+
+To enter a new inventory adjustment, click on "New Adjustment"
+
+This brings up the page for entering Inventory Adjustments:
+
+
+Choose the Storage Location, add any notes you have in the comments section, and, for each item you are adjusting, enter either a number greater than 0 to increase the inventory, or a number less than zero to decrease it.
Click save to finish entering the adjustment. This will change the inventory levels on those items.
-[TODO: Screenshot of result]
+In this sample there are both negative adjustments (showing in red, with "Removed") and positive adjustments (showing in green, with "Added)
-## Viewing inventory adjustments
+
-You can see the details of old inventory adjustments by clicking 'View' beside the adjustment
+## Viewing Inventory Adjustments
+You can see the details of old Inventory Adjustments by clicking 'View' beside the adjustment
+
+
[Prior: Barcode Items](inventory_barcodes.md) [Next: Transfers](inventory_transfers.md)
diff --git a/docs/user_guide/bank/inventory_audits.md b/docs/user_guide/bank/inventory_audits.md
index c5ab91943e..fff466324d 100644
--- a/docs/user_guide/bank/inventory_audits.md
+++ b/docs/user_guide/bank/inventory_audits.md
@@ -1,67 +1,81 @@
-Draft User Guide
+READY FOR REVIEW
# Audits
-When you do an inventory count, you'll want to set the inventory in each storage location to the physical count. That's what the Audits function is for.
+When you do an inventory count, you'll want to set the inventory in each Storage Location to the physical count. That's what the Audits function is for.
-The big thing you need to remember is that Audits have to be 'finalized' by an organization admin before they update the inventory, so don't record any activity after the physical count until the audit is finalized.
+The big thing you need to remember is that Audits have to be 'finalized' by an organization admin before they update the inventory, so don't record any activity after the physical count until the Audit is finalized.
## Starting an Audit
Click on "Inventory", then "Inventory Audit" in the left hand menu, then "+New Audit".
-[TODO: Screenshot]
+
-This brings up the new audit page.
-Specify the storage location, then each item you have counted, along with its quantity.
-Note that you can do partial audits. Any item you don't specify during the audit will keep its current quantity in the inventory.
+This brings up the new Audit page.
-[TODO: Screenshot]
+
+
+Specify the Storage Location, then each Item you have counted, along with its quantity.
+
+[!NOTE] You can do partial Audits. Any Item you don't specify during the Audit will keep its current quantity in the inventory.
-Clicking "Confirm Audit" and clicking "OK" in answer to "Are you sure?" will set the status to "confirmed" - that is ready for the org admin to review and "finalize" - so that should be done when you are finished your counts and have checked that you entered the right numbers.
Clicking "Save Progress" saves what you have done, but you can come back and continue entering.
-You *must* choose a storage location to save progress.
+You *must* choose a Storage Location to save progress.
+
+Clicking "Confirm Audit" and clicking "OK" in answer to "Are you sure?" will set the status to "confirmed" - that is ready for the org admin to review and "finalize" - so that should be done when you are finished your counts and have checked that you entered the right numbers.
-When you save progress, you'll see this page, which shows the progess of the audit. Anything you haven't counted has a red background, and is noted as "Not Audited".
+When you save progress, you'll see this page, which shows the progress of the Audit. Anything you haven't counted has a red background, and is noted as "Not Audited".
-[TODO: Screenshot]
+
-You will be able to return to this page from the list of audits (Inventory | Inventory Audit).
+You will be able to return to this page from the list of Audits (Inventory | Inventory Audit).
The Audit Quantity is the amount that you entered, and the Quantity in Records is the amount that is currently recorded as being in your inventory.
You have two options from this page: Resume Audit and Delete Audit, which we treat below.
## Resuming an Audit
-When you want to continue entering your counts, you can resume your audit by going to the Audits page (Inventory | Inventory Audit). You'll see the audit you are working on listed with a status of "In Progress". Click "View" to bring up the details on that audit.
+When you want to continue entering your counts, you can resume your Audit by going to the Audits page (Inventory | Inventory Audit). You'll see the Audit you are working on listed with a status of "In Progress". Click "View" to bring up the details on that Audit.
-[TODO: Screenshot]
+
Scroll to the bottom of the page, and click "Resume Audit"
-[TODO: Screenshot]
+
-This will bring up the new audit form you were working on, and you can continue to enter more items.
+This will bring up the new Audit form you were working on, and you can continue to enter more Items.
-You can "Save Progress" again, or you can "Confirm Audit", and click "OK" in answer to "Are you sure?" to set the audit for approval (or "Finalizing") by a user with organization admin privileges.
+You can "Save Progress" again, or you can "Confirm Audit", and click "OK" in answer to "Are you sure?" to set the Audit for approval (or "Finalizing") by a user with organization admin privileges.
+
+## Confirming an Audit
+When you are entering an Audit, and have completed the counts for that Audit, you confirm it. This indicates that the counts for the Audit are done, and available for final review before being set in stone.
+
+This step is here so that a bank can have users without admin access enter the counts, but have a final check (the "Finalize" step, below) before the inventory levels are permanently changed.
+
+On the Audit entry screen, scroll to the bottom and click 'Confirm Audit'. There is a detailed confirmation window with instructions for next steps.
+
+
## Finalizing an Audit
-Once an audit had been confirmed, it must be finalized before any inventory changes will take place. Finalizing can only be done by someone with organization admin privileges.
+Once an Audit had been confirmed, it must be finalized before any inventory changes will take place. Finalizing can only be done by someone with organization admin privileges.
To Finalize an Audit, sign in as an organization admin, Click Inventory, then Inventory Audit.
-[TODO: Screenshot]
+Select the "View" beside the Audit, review it, and if all is correct, scroll down to the bottom and click "Finalize". Then, if you are sure, click "OK" to confirm.
-Select the "View" beside the audit, review it, and if all is correct, scroll down to the bottom and click "Finalize". Then, if you are sure, click "OK" to confirm.
+[!NOTE] You will only see "Finalize" if the Audit has been confirmed.
-[TODO: Screenshot]
+[!WARN] **** THIS PERMANENTLY CHANGES THE LEVELS OF INVENTORY AND CANNOT BE UNDONE. *******
-##### **** N.B. THIS CHANGES THE LEVELS OF INVENTORY AND CANNOT BE UNDONE. *******
+
-Now, when you view the audit, the quantity in records will match the audit quantity -- until you enter more activity.
+Now, when you view the Audit, the quantity in records will match the Audit quantity -- until you enter more activity.
## Deleting an Audit
-If the audit is in error and has not been finalized, you can delete it.
-From the Audits page (Inventory | Inventory Audit), click "View" beside the audit you wish to delete, then scroll to the bottom, click "Delete Audit", and "OK" to confirm. This is not reversible.
+If the Audit has not been finalized, you can delete it.
+From the Audits page (Inventory | Inventory Audit), click "View" beside the Audit you wish to delete, then scroll to the bottom, click "Delete Audit", and "OK" to confirm.
+[!WARN] This cannot be undone
+
-[TODO: Screenshot]
+
[Prior: Storage Locations](inventory_storage_locations.md)
[Next: Kits](inventory_kits.md)
\ No newline at end of file
diff --git a/docs/user_guide/bank/inventory_barcodes.md b/docs/user_guide/bank/inventory_barcodes.md
index 4872fe8f50..1d8aba6967 100644
--- a/docs/user_guide/bank/inventory_barcodes.md
+++ b/docs/user_guide/bank/inventory_barcodes.md
@@ -1,43 +1,47 @@
-Not yet written
+DRAFT USER GUIDE
# Barcodes
## Introduction to Barcodes
-You can set up Human Essentials to enable reading barcodes for input of items when entering donations, purchases, and distributions.
+You can set up Human Essentials to enable reading Barcodes for input of Items when entering Donations, Purchases, and Distributions.
[TODO: Hoping to get a paragraph or two from Scott on:
-- barcode readers
-- making your own barcodes
+- Barcode readers
+- making your own Barcodes
]
## The Barcodes page
-You can reach the barcodes page, where you will administer your organizations barcodes, by clicking "Inventory", then "Barcode Items"
+You can reach the Barcodes page, where you will administer your organizations Barcodes, by clicking "Inventory", then "Barcode Items"
-[TODO: Screenshot]
+
-[TODO: Check - is this an admin only thing?]
+### Getting a Barcode font for printing your own Barcodes
+You can download a font file for printing Barcode labels from the Barcodes page by clicking the button "Download Barcode Font"
+This can be used with MS Word on Windows, or with Pages on Apple machines. Consult the help on those for installation.
-### Getting a barcode font for printing your own barcodes
-You can download a font file for printing barcode labels from the barcodes page by clicking the button "Download Barcode Font"
-This can be used with MS Word on Windows, or with Pages on Apple machines[TODO: Verify]
+### Making a new Barcode
+To add a Barcode to the system, click the "+New Barcode" button on the Barcodes page.
-### Making a new barcode
-To add a barcode to the system, click the "+New Barcode" button on the barcodes page.
+
+This will bring up a simple form that allows you to specify the quantity of the Item, select the Item and enter the Barcode - either as a number, or by using a Barcode reader.
-[TODO: Screenshot]
-This will bring up a simple form that allows you to specify the quantity of the item, select the item and enter the barcode - either as a number, or by using a barcode reader.
+
+
+[TODO: Question for Scott -- is this "boopable"? I suspect it is, but I don't want to claim it is if it isn't].
-[TODO: Question -- is this "boopable? I suspect it is, but I don't want to claim it is if it isn't].
Enter those three fields and click "Save"
-### Changing a barcode
-Should you need to edit this barcode information, you can do so by clicking 'Edit' beside the barcode you need to update.
-[TODO: Screenshot]
-### Deleting a barcode
-To delete a barcode you are no longer using, click "Delete" beside the barcode, and confirm by clicking "OK".
-[TODO: Screenshot]
-### Exporting barcodes
-To export a list of the barcodes, just click "Export barcodes" on the barcodes page.
+### Changing a Barcode
+Should you need to edit this Barcode information, you can do so by clicking 'Edit' beside the Barcode you need to update.
+
+### Deleting a Barcode
+To delete a Barcode you are no longer using, click "Delete" beside the Barcode, and confirm by clicking "OK".
+
+### Exporting Barcodes
+To export a list of the Barcodes, just click "Export Barcodes" on the Barcodes page.
+
+
+
[Prior: Audits](inventory_audits.md) [Next: Adjustments](inventory_adjustments.md)
\ No newline at end of file
diff --git a/docs/user_guide/bank/inventory_items.md b/docs/user_guide/bank/inventory_items.md
index fb0cd4831e..5bf3918fa9 100644
--- a/docs/user_guide/bank/inventory_items.md
+++ b/docs/user_guide/bank/inventory_items.md
@@ -1,150 +1,168 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
# Items
## Introduction
-Your bank is initialized with a basic set of items that contains many common product types that essentials banks distribute. These items represent the stock you have for distribution. Here is the current default list:
-
-[TODO: Bulletize this list.]
-
-Adult Briefs (Large/X-Large),
-Adult Briefs (Medium/Large),
-Adult Briefs (Small/Medium),
-Adult Briefs (XS/Small),
-Adult Briefs (XXL),
-Adult Briefs (XXS),
-Adult Briefs (XXXL),
-Adult Cloth Diapers (Large/XL/XXL),
-Adult Cloth Diapers (Small/Medium),
-Adult Incontinence Pads,
-Bed Pads (Cloth),
-Bed Pads (Disposable),
-Bibs (Adult & Child),
-Cloth Diapers (AIO's/Pocket),
-Cloth Diapers (Covers),
-Cloth Diapers (Plastic Cover Pants),
-Cloth Diapers (Prefolds & Fitted),
-Cloth Inserts (For Cloth Diapers),
-Cloth Potty Training Pants/Underwear,
-Cloth Swimmers (Kids),
-Diaper Rash Cream/Powder,
-Disposable Inserts,
-Kids (Newborn),
-Kids (Preemie),
-Kids (Size 1),
-Kids (Size 2),
-Kids (Size 3),
-Kids (Size 4),
-Kids (Size 5),
-Kids (Size 6),
-Kids (Size 7),
-Kids L/XL (60-125 lbs),
-Kids Pull-Ups (2T-3T),
-Kids Pull-Ups (3T-4T),
-Kids Pull-Ups (4T-5T),
-Kids Pull-Ups (5T-6T),
-Kids S/M (38-65 lbs),
-Liners (Incontinence),
-Liners (Menstrual),
-Other,
-Pads,
-Swimmers,
-Tampons,
-Underpads (Pack),
-Wipes (Adult),
-Wipes (Baby)
-
-
-
-
-[TODO: "Kit" is a base item, and it is in the "new" bank on staging. Is it one of the items that is initialized? Shouldn't be, IMO]
-
-
-"Under the hood" each of these basic items belongs to a particular reporting category used for the annual survey, such as disposable diapers, cloth diapers, kits (which are made up of other items), cloth diapers, and other.
-
-You can add more items, basing them off our base item list, and customize them. The things you can do include:
- - hiding them from your partners (useful if, say, you only distribute kits, but get donations of materials that go into the kits)
+Your bank is initialized with a basic set of Items that contains many common product types that essentials banks distribute. These Items represent the stock you have for distribution. Here is the current default list:
+
+- Adult Briefs (Large/X-Large),
+- Adult Briefs (Medium/Large),
+- Adult Briefs (Small/Medium),
+- Adult Briefs (XS/Small),
+- Adult Briefs (XXL),
+- Adult Briefs (XXS),
+- Adult Briefs (XXXL),
+- Adult Cloth Diapers (Large/XL/XXL),
+- Adult Cloth Diapers (Small/Medium),
+- Adult Incontinence Pads,
+- Bed Pads (Cloth),
+- Bed Pads (Disposable),
+- Bibs (Adult & Child),
+- Cloth Diapers (AIO's/Pocket),
+- Cloth Diapers (Covers),
+- Cloth Diapers (Plastic Cover Pants),
+- Cloth Diapers (Prefolds & Fitted),
+- Cloth Inserts (For Cloth Diapers),
+- Cloth Potty Training Pants/Underwear,
+- Cloth Swimmers (Kids),
+- Diaper Rash Cream/Powder,
+- Disposable Inserts,
+- Kids (Newborn),
+- Kids (Preemie),
+- Kids (Size 1),
+- Kids (Size 2),
+- Kids (Size 3),
+- Kids (Size 4),
+- Kids (Size 5),
+- Kids (Size 6),
+- Kids (Size 7),
+- Kids L/XL (60-125 lbs),
+- Kids Pull-Ups (2T-3T),
+- Kids Pull-Ups (3T-4T),
+- Kids Pull-Ups (4T-5T),
+- Kids Pull-Ups (5T-6T),
+- Kids S/M (38-65 lbs),
+- Liners (Incontinence),
+- Liners (Menstrual),
+- Other,
+- Pads,
+- Swimmers,
+- Tampons,
+- Underpads (Pack),
+- Wipes (Adult), and
+- Wipes (Baby)
+
+"Under the hood" each of these basic Items belongs to a particular reporting category used for the annual survey, such as disposable diapers, cloth diapers, Kits (which are made up of other Items), cloth diapers, and other.
+
+You can add more Items, basing them off our base Item list, and customize them. The things you can do include:
+ - hiding them from your Partners (useful if, for example, you only distribute Kits, but get donations of materials that go into the Kits)
- grouping them into categories (you can limit which categories groups of partners can access)
- adding minimum and recommended bank-wide inventory levels (which enable warnings, and drive the low inventory list in your dashboard)
- - creating [kits](inventory_kits.md) that will contain items (the inventory levels will show the items that are yet not in the kits)
- - remove the items from your lists on a go-forward basis.
- -
-[TODO: links pointing to each of these things]
+ - creating [Kits](inventory_kits.md) that will contain Items (the inventory levels show the Items that are yet not in the Kits)
+ - remove an Item from your lists on a go-forward basis.
## The Items & Inventory Views
-
-This is a multi-tabbed view - you have several angles to look at your items and bank-wide inventory (if you want to see everything that's in a particular storage location, that's under [Storage Locations](inventory_storage_locations.md))
+To bring up your Items & Inventory view, click "Inventory", then "Items & Inventory" in the left-hand menu.
+
+This brings up a multi-tabbed view - you have several different ways to look at your Items and bank-wide inventory (if you want to see everything that's in a particular Storage Location, that's under [Storage Locations](inventory_storage_locations.md))
### Item List
-This shows all of your items, and allows you access to view/edit/and delete them.
-[ToDo: screenshot]
-#### Viewing an item
-Clicking "View" will bring up details on the item, including all the things you can change, and a breakdown of the inventory at each location you currently have stock at.
-[ToDo: screenshot]
+This shows all of your Items, and allows you access to view/edit/and delete them.
+#### Viewing an Item
+Clicking "View" will bring up details on the Item, including all the things you can change, and a breakdown of the inventory at each location you currently have stock at.
+
+
+
The fields are:
-- Base item -- this is the "base item" for this item -- which determines what section it is in for the Annual Survey. You can also search by base item (at this time)
-- Category -- this is a category you define (see Item Categories, below
--
-- [TODO: put the link in])
--
-- Value per Item -- this is currently shown in cents (there is a request to change it to dollars in our list). This is used for any "Fair Market Value" values -- including on donation and distribution printouts.
-Note: We only have one 'value per item' per item -- so it's always the current fair market value not the historical. If provided, this is used for the value column on the distribution and donation printouts (unless you hide those columns when [customizing your bank](getting_started_customization.md))
-- Quantity per individual -- This is used for two things: 1/ If you have enabled "request by individual" for your partners (and they use it), this is the number of items that will be in their request per individual they request for. (so, if it's 25, and they indicate 3 individuals, you will receive a request for 75 of that item). It is also used in the annual survey for the estimated people served -- we take the total of the item that was distributed, and divide it by this number to get the number of people helped. **NOTE** We use 50 for this if you don't give a value.
-- On hand minimum quantity -- This is a bank-wide on-hand minimum quantity of the item -- being below this triggers the item appearing in your low inventory report in red.
+- Base Item -- this is the "Base Item" for this Item -- which determines what section it is in for the Annual Survey. You can also search by Base Item (at this time)
+- Category -- this is a category you define (see [Item Categories](inventory_items.md#item-categories), below
+- Value per Item -- this is currently shown in cents (there is a request to change it to dollars in our list). It is used for any "Fair Market Value" calculations -- including on donation and distribution printouts.
+[!NOTE] We only have one 'Value per Item' per Item -- so it's always the current fair market value not the historical. If provided, this is used for the value column on the distribution and donation printouts (unless you hide those columns when [customizing your bank](getting_started_customization.md))
+- Quantity per individual -- This is used for two things:
+ - If you have enabled "request by individual" for your partners (and they use it), this is the number of Items that will be in their request per individual they request for. (so, if it's 25, and they indicate 3 individuals, you will receive a request for 75 of that Item).
+ - It is also used in the annual survey for the estimated people served -- we take the total of the Item that was distributed, and divide it by this number to get the number of people helped.
+ - [!NOTE] We use 50 for this calculation in the annual survey if you don't give a value.
+- On hand minimum quantity -- This is a bank-wide on-hand minimum quantity of the Item -- being below this triggers the Item appearing in your low inventory report in red.
- On hand recommended quantity -- This is the amount you want to have on hand -- if you don't have this, it will appear in the low inventory list on your dashboard, just not in red.
-- Package size -- If you use this, the calculated number of packages for the item will appear on the distribution printout, unless you hide it when [customizing your bank](getting_started_customization.md).
-- Item visible to partners -- This is useful if you have items that you do not want the partners directly requesting. Uses include: items you don't get very often, of items you only have because they are going into kits you haven't assembled yet. You can uncheck this to hide those items from all your partners.
-#### Editing an item
-Clicking "Edit" beside an item on the item list lets you edit the item definition, with the fields as described above. **NOTE*: Value per item is in dollars on this screen.
-#### Deleting vs Deactivating an item
-The button "delete" will only appear beside an item if there hasn't been any activity on it at all.
+- Package size -- If you use this, the calculated number of packages for the Item will appear on the distribution printout, unless you hide it when [customizing your bank](getting_started_customization.md).
+- Item visible to partners -- This is useful if you have Items that you do not want the partners directly requesting. Uses include: Items you don't get very often, or Items you only have because they are going into kits you haven't assembled yet. You can uncheck this to hide those Items from all your partners.
+#### Filtering your item list
+The most common thing you'll when filtering your item list is to include inactive items. If you have deactivated an item, but are going to offer it again, you'll need to check the "Also include inactive Items" box in the filter, and then click "Filter" to show it, so that you can reactivate it.
-The button "deactivate" will appear if there has been activity. But it will be greyed out unless your bank-wide level of inventory on that item is 0.
-Deactivating an item removes it whenever you are entering a new distribution/donation/purchase/transfer/audit, and removes it from the partner's new requests.
-### Item Categories
+#### Editing an Item
+Clicking "Edit" beside an Item on the Item list lets you edit the Item definition, with the fields as described above.
+
+
+[!NOTE] Value per Item is in dollars on this screen.
-Item categories are largely used for limiting the items specific [Partner Groups](pm_partner_groups.md) can see, though you can also filter distributions by them. This tab shows all the item categories you have, allowing you to view and edit each one, as well as enter new ones.
+#### Adding a new Item
+To add a new Item, click the "+ New Item" button on this page. It will bring up the same page as "Editing an Item", above (only, of course, with none of the fields completed).
-**Note: Each item can only belong to one category **
+#### Deleting or Deactivating an Item
+The button "delete" will appear beside an Item if there hasn't been any activity on it at all. (A) Deleting an Item is permanent
-[TODO: Question - why do we not filter Donations, Requests, or Purchases by them? ]
+The button "deactivate" will appear if there has been activity. But it will be greyed out unless your bank-wide level of inventory on that Item is 0. (B))
+Deactivating an Item removes it whenever you are entering a new distribution/donation/purchase/transfer/audit, and removes it from the partner's new requests.
+You can still see deactivated items in most reports, and can include them in your filtered lists.
-[TODO: Screenshot]
-#### Adding a new item category
-To add a new item category, Click on Inventory, then Items & Inventory, then the Item Categories tab, then the "Add Item Category" button.
+
-Enter a unique Category Name, and a suitable description, then click Save.
+#### Reactivating an Item
+To reactivate an Item, you'll need to
+(1) click "Also include inactive Items"
+(2) click "Filter", then
+(3) click "Restore" beside the Item you wish to reactivate.
-#### Viewing an item category
-All the information about an item category is in the list of all of them, but you can also manage the items in the category through the view. To view an item category, you click on Inventory, then Items & Inventory, then the Item Categories tab, then the "View" button.
-[TODO: Screenshot]
+Click 'Ok' on the confirmation screen that appears.
-You can also remove items from the category by clicking "Remove from category" beside the item. This will hide them from any partner groups that have this category.
+
-#### Editing an item category
-[TODO: "Update Record on this isn't our usual terminology -- should be Edit Item Category -- add that to the inbox]
+### Item Categories
-To edit the name and description of an item category, To view an item category, you click on Inventory, then Items & Inventory, then the Item Categories tab, then the "Edit" button beside the category you wish to edit.
-[TODO: Screenshot]
+Item categories are largely used for limiting the Items specific [Partner Groups](pm_partner_groups.md) can see, though you can also filter distributions by them. This tab shows all the Item categories you have, allowing you to view and edit each one, as well as enter new ones.
-Update the category name (still needs to be unique) and category description, and click save. This will take you to the item category view [Add pointer to above], which lets you change the items in the category.
+[!NOTE] Each Item can only belong to one Item Category
-### Items, Quantity and Location tab
+To view your Item Categories, click the "Item Categories" tab on the Items & Inventory page.
-[TODO: We should highlight the bank-wide ones that are below the minimum. Add that to the inbox ]
+
+#### Adding a new Item category
+To add a new Item category, Click on Inventory, then Items & Inventory, then the Item Categories tab, then the "Add Item Category" button.
+
+
+This brings up the new Item Category page
+
+
+Enter a unique Category Name, and a suitable description, then click Save.
+
+#### Viewing an Item Category
+All the information about an Item category is in the list, but you can also manage the Items in the category through the view. To view an Item category, you click on Inventory, then Items & Inventory, then the Item Categories tab, then the "View" button.
+
+
+
+You can also remove Items from the category by clicking "Remove from category" beside the Item. This will hide them from any partner groups that have this category.
+
+#### Editing an Item category
+To edit the name and description of an Item category, To edit an Item category, you click on Inventory, then Items & Inventory, then the Item Categories tab, then the "Edit" button beside the category you wish to edit.
+
+
+
+Update the category name (still needs to be unique) and category description, and click save. This will take you to the Item category view [Add pointer to above], which lets you change the Items in the category.
+
+### Items, Quantity and Location tab
-This tab shows all the item inventory across all the storage locations, along with each item's minimum quantity, recommended quantity, and bank-wide quantity.
+This tab shows all the Item inventory across all the storage locations, along with each Item's minimum quantity, recommended quantity, and bank-wide quantity.
-[TODO: Screenshot]
+
### Item Inventory tab
-This tab shows the bank-wide inventory for each item. Clicking the + beside the item name will show the breakdown of that inventory by storage area.
+This tab shows the bank-wide inventory for each Item. Clicking the + beside the Item name will show the breakdown of that inventory by storage area.
-[TODO: Raise the question of whether we really need both the Items, Quantity and Location tab at a Stakeholder's circle.]
+
### Kits tab
-This shows the same information as the main [Kits](inventory_kits.md) view.
+This shows the same information as the main [Kits](inventory_kits.md) list.
+
-[TODO: Note the filter does not work on this view. Add to inbox.]
[Prior: Partner Announcements](pm_announcements.md)[Next: Storage Locations](inventory_storage_locations.md)
diff --git a/docs/user_guide/bank/inventory_kits.md b/docs/user_guide/bank/inventory_kits.md
index f78c4c35da..a83411d766 100644
--- a/docs/user_guide/bank/inventory_kits.md
+++ b/docs/user_guide/bank/inventory_kits.md
@@ -1,80 +1,84 @@
-USER GUIDE DRAFT
+READY FOR REVIEW
# Kits
-Many banks distribute kits -- the classic example is a package that contains different types of menstrual supplies (e.g. pads, tampons, wipes).
+Many banks distribute Kits -- the classic example is a package that contains different types of menstrual supplies (e.g. pads, tampons, wipes).
-What the kits feature lets you do is to manage your inventory of what goes into the kits versus what is in the kits.
+What the Kits feature lets you do is to manage your inventory of what goes into the Kits versus what is in the Kits.
-Working with kits has two steps -- creating the kit and allocating kits
+Working with Kits has two steps -- creating the Kit and allocating Kits
-## Creating versus allocating kits
+## Creating versus allocating Kits
-Creating a kit is defining what is in a kit -- so it's saying that, for example, a period kit will contain 8 tampons and 4 pads.
+Creating a Kit is defining what is in a Kit -- so it's saying that, for example, a period Kit will contain 8 tampons and 4 pads.
-Allocating kits is akin to assembling kits -- when you create the physical kits from the supplies you have, you then allocate those kits in the system.
+Allocating Kits is akin to assembling Kits -- when you create the physical Kits from the supplies you have, you then allocate those Kits in the system.
-In our example of a kit with 8 tampons and 4 pads, if you allocate 10 kits, you are going to be reducing your inventory of pads by 40 and your inventory of tampons by 80, but increasing your inventory of period kits by 10.
+In our example of a Kit with 8 tampons and 4 pads, if you allocate 10 Kits, you are going to be reducing your inventory of pads by 40 and your inventory of tampons by 80, but increasing your inventory of period Kits by 10.
-Then you distribute those period kits.
+Then you distribute those period Kits.
-## Creating a kit
+## Creating a Kit
-***NB: You can't edit a kit -- once you've defined it, it's set in stone. So do be careful! ***
+[!WARN] You can't edit a Kit -- once you've defined it, it's set in stone. So do be careful!
-To create a kit, click on "Inventory", then "Kits" in your left hand menu. This brings up a page that shows all your current kits.
+To create a Kit, click on "Inventory", then "Kits" in your left hand menu. This brings up a page that shows all your current Kits.
Then click the "+New Kit" button on the right hand side of the page.
-[TODO: Screenshot]
+
This brings up the "New Kit" form, which has the following info:
-[TODO: Screenshot]
-- Name: This is the item name for the kit -- what it will appear as in the drop-down lists and in any reports
-- Item is Visible to Partners? Check this if you allow partners to order the kit.
-Note: If you need to control which partners can request a kit, you'll need to put it in a category, through the Item page, after creation, and use partner groups to control which partners can request the item.
-[TODO: link to the Edit Item section]
-- Value for kit: This is the Fair Market Value for the kit. We don't sum up the items within the kits for FMV calculations.
-- Items in this kit:
- You can enter multiple items, adding each item with the following
- - Barcode Entry -- if you have already entered [Barcode Items](inventory_barcodes.md), you can just "boop" the item into the kit.
+
+- Name: This is the Item name for the Kit -- what it will appear as in the drop-down lists and in any reports
+- Item is Visible to Partners? Check this if you allow Partners to order the Kit.
+[!INFO] If you need to control which Partners can request a Kit, you'll need to put it in a category once you've defined it, through the Item page, after creation, and use Partner Groups to control which Partners can request the Item.
+[(see Editing an Item)](inventory_items.md#editing-an-item), [Item Categories](inventory_items.md#item-categories) and [Partner Groups](pm_partner_groups.md)
+- Value for Kit: This is the Fair Market Value for the Kit. We don't sum up the Items within the Kits for FMV calculations.
+- Items in this Kit:
+ You can enter multiple Items, adding each Item with the following
+ - Barcode Entry -- if you have already entered [Barcode Items](inventory_barcodes.md), you can just "boop" the Item into the Kit.
OR
- - Choose an item from the list of all [Items](inventory_items.md) you have, and add the quantity of the item that will be in the kit.
+ - Choose an Item from the list of all [Items](inventory_Items.md) you have, and add the quantity of the Item that will be in the Kit.
-To add the rest of your items, click "+Add Another Item." If you need to remove an item, click "Remove" under it.
+To add the rest of your Items, click "+Add Another Item." If you need to remove an Item, click "Remove" under it.
-Once you are satisfied with the definition of your kit, click "Save". This will return you to the kits screen, where you'll see your new kit.
+Once you are satisfied with the definition of your Kit, click "Save". This will return you to the Kits screen, where you'll see your new Kit.
-## Allocating kits
+## Allocating Kits
-Once you have created your kit, you can allocate it. This represents assembling kits from their components, and will reduce the inventory of those items appropriately.
+Once you have created your Kit, you can allocate it. This represents assembling Kits from their components, and will reduce the inventory of those Items appropriately.
-From the Kits page (Inventory | Kits), click "Modify Allocation" on your kit
-[TODO: Screenshot]
+From the Kits page (Inventory | Kits), click "Modify Allocation" on your Kit
+
+
This takes you to the Kit Allocation page
-This lists your current on-hand quantity for each storage location you have kits in, and lets you change the allocation.
+This lists your current on-hand quantity for each storage location you have Kits in, and lets you change the allocation.
+
+Pick the Storage Location (A) and the amount you want to increase the Kits by (B). When you put a number in the "Change Kit quantity ", you'll see what effect the allocation will have on your inventory.
-Pick the storage location (A) and the amount you want to increase the kits by (B). When you put a number in the "Change kit quantity ", you'll see what effect the allocation will have on your inventory.
+
-[TODO: Screenshot]
+[!NOTE] you can also 'deallocate' Kits if need be, by putting a negative number in the "Change Kit quantity by" field. When you deallocation Kits, the contents will be returned to the appropriate Items' inventory.
-Note: you can also 'deallocate' kits if need be, by putting a negative number in the "Change kit quantity by" field. When you deallocation kits, the contents will be returned to the appropriate items' inventory.
+Then click "Save". The system will check if there are enough of each component Item in the storage location. If there isn't, it will give you an error. If there is, it will adjust the inventory appropriately, and return to this screen, which will reflect the new on-hand quantity.
-Then click "Save". The system will check if there are enough of each component item in the storage location. If there isn't, it will give you an error. If there is, it will adjust the inventory appropriately, and return to this screen, which will reflect the new on-hand quantity.
+
-[TODO: Screenshot]
+## Deactivating a Kit
-## Deactivating a kit
+If you are no longer using a Kit, you can deactivate it - which will remove it from the dropdowns, and from the Kits page (you can always see it by clicking the "show inactive" in the filter, then clicking "Filter")
-If you are no longer using a kit, you can deactivate it - which will remove it from the dropdowns, and from the Kits page (you can always see it by clicking the "show inactive" in the filter, then clicking "Filter")
+You can only deactivate a Kit if it has no allocations. To deactivate a Kit, click the "Deactivate" button beside it in the Kits page, and then click "OK" to confirm.
-You can only deactivate a kit if it has no allocations. To deactivate a kit, click the "Deactivate" button beside it in the Kits page, and then click "OK" to confirm.
+
-## Reactivating a kit
+## Reactivating a Kit
-To reactivate a kit, go to the Kits page (Inventory | Kits).
-Then click "Show Inactive" and "Filter". This will show the Inactive kits.
-Then click "Reactivate" beside the kit you wish to reactivate and click "OK" to confirm.
+To reactivate a Kit, go to the Kits page (Inventory | Kits).
+Then click "Show Inactive" and "Filter". This will show the Inactive Kits.
+Then click "Reactivate" beside the Kit you wish to reactivate and click "OK" to confirm.
+
[Prior: Audits](inventory_audits.md)
[Next: Barcodes](inventory_barcodes.md)
diff --git a/docs/user_guide/bank/inventory_storage_locations.md b/docs/user_guide/bank/inventory_storage_locations.md
index d4502565de..3e81537029 100644
--- a/docs/user_guide/bank/inventory_storage_locations.md
+++ b/docs/user_guide/bank/inventory_storage_locations.md
@@ -1,65 +1,60 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
# Storage Locations
-You need at least one storage location. Each donation and purchase increases the inventory in a storage location, and each distribution is made from the inventory in a storage location.
+You need at least one Storage Location. Each Donation and Purchase increases the inventory in a Storage Location, and each distribution is made from the inventory in a Storage Location.
-## Storage location summary page
-To get to the storage location summary page, click "Inventory", then "Storage Locations"
-[TODO: Screenshot]
-This shows all your storage locations, and allows you to navigate to view, edit, or possibly deactivate each one.
+## Storage Location summary page
+To get to the Storage Location summary page, click "Inventory", then "Storage Locations" in the left-hand menu
+
+This shows all your Storage Locations, and allows you to navigate to view, edit, or possibly deactivate each one.
-## Adding a storage location
-To add a storage location, click "New Storage Location" on the storage location summary page.
-The square footage and storage site type information are used in the annual survey report.
-[TODO: Is the address used anywhere? (Distribution printout? maybe? Maybe available for the distribution email?)]
-[TODO: Speak intelligently on how the time zone is used]
-[TODO: Screenshot]
+
+## Adding a Storage Location
+To add a Storage Location, click "New Storage Location" on the Storage Location summary page.
+
+
+This brings up the New Storage Location page
+
+- Name is mandatory, and is used in drop-downs throughout the system to indicate the Storage Location
+- Address is also mandatory, but is information only.
+- Square Footage is used in the annual survey report
+- Warehouse Type is used in the annual survey report
+- Time Zone is used with the pickup and deliveries calendar, particularly with allowing you to sync your pickups calendar with Google Calendar
## Storage location view
-To view a storage location, click the "View" button beside it in the storage location summary page.
+To view a Storage Location, click the "View" button beside it in the Storage Location summary page.
The view has three tabs: Inventory, Inventory Coming In, and Inventory Going Out
### Inventory
-Here you see the current levels of inventory for the chosen storage location. You can see the inventory levels for past dates by choosing the date in "Show Inventory at Date" and clicking "View"
+Here you see the current levels of inventory for the chosen Storage Location. You can see the inventory levels for past dates by choosing the date in "Show Inventory at Date" and clicking "View"
That shows the inventory at the beginning of the day.
-[TODO: Screenshot]
+
### Inventory Coming In
-This shows the sum of all the inventory coming in ([Purchases](essentials_purchases.md), [Donations](essentials_donations.md), [Adjustments](inventory_adjustments.md), [Transfers](inventory_transfers.md), and [positive changes for kit allocations.deallocations](inventory_kits.md)) for the given storage location for all time
-
-[TODO: Check that that is exactly what it is doing]
-
-[TODO: Would this be more useful with a date range, and is that feasible?]
+This shows the sum of all the inventory coming in ([Purchases](essentials_purchases.md), [Donations](essentials_donations.md), [Adjustments](inventory_adjustments.md), [Transfers](inventory_transfers.md), and [positive changes for kit allocations.deallocations](inventory_kits.md)) for the given Storage Location for all time
-[TODO: Screenshot]
+
### Inventory Going Out
-This shows the sum of all the inventory going out ([Distributions](essentials_purchases.md), [Adjustments](inventory_adjustments.md), and [Transfers](inventory_transfers.md), and [positive changes for kit allocations.deallocations](inventory_kits.md)) for the given storage location for all time
-
-[TODO: Check that that is exactly what it is doing]
-
-[TODO: Would this be more useful with a date range, and is that feasible?]
-
-[TODO: Screenshot]
-
-## Editing a storage location
-You can edit your storage location (though it seems a very rare event), by clicking "Edit" beside the storage location in the Storage Location Summary Page.
-The same fields are as available as for your new storage locations. Make your updates and click save.
+This shows the sum of all the inventory going out ([Distributions](essentials_purchases.md), [Adjustments](inventory_adjustments.md), and [Transfers](inventory_transfers.md), and [positive changes for kit allocations.deallocations](inventory_kits.md)) for the given Storage Location for all time
-## Deactivating a storage location
-You can only deactivate a storage location if the inventory for all its items is 0.
-To deactivate the storage location, click "Deactivate" beside it on the storage location summary screen, then click "OK" to confirm.
-[TODO: Screenshot]
+
+## Editing a Storage Location
+You can edit your Storage Location (though it seems a very rare event), by clicking "Edit" beside the Storage Location in the Storage Location Summary Page.
+The same fields are as available as for [New Storage Locations](inventory_storage_locations.md). Make your updates and click save.
-## Reactivating a storage location
-If you need to reactivate a storage location that was deactivated, go to the storage locations summary screen (Inventory | Storage Locations), then click "include inactive storage locations", then Filter.
-This will include inactive storage locations in the list. Find the storage location you want to use again and clic "Reactivate" beside it.
-[TODO: Screenshot]
+## Deactivating a Storage Location
+You can only deactivate a Storage Location if the inventory for all its items is 0.
+To deactivate the Storage Location, click "Deactivate" beside it on the Storage Location summary screen, then click "OK" to confirm.
+## Reactivating a Storage Location
+If you need to reactivate a Storage Location that was deactivated, go to the Storage Locations summary screen (Inventory | Storage Locations), then click "include inactive Storage Locations", then Filter.
+This will include inactive Storage Locations in the list. Find the Storage Location you want to use again and clic "Reactivate" beside it.
+
diff --git a/docs/user_guide/bank/inventory_transfers.md b/docs/user_guide/bank/inventory_transfers.md
index 477c4bd0f2..f2cb79083c 100644
--- a/docs/user_guide/bank/inventory_transfers.md
+++ b/docs/user_guide/bank/inventory_transfers.md
@@ -1,54 +1,59 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
# Transfers
-If you have multiple storage locations, sometimes you have to move inventory between them.
-[TODO: Throughout - doublecheck what requires org_admin, vs what needs org user]
+If you have multiple Storage Locations, sometimes you have to move inventory between them.
## Working with Transfers
-To start working with transfers, click "Inventory", then "Transfers" in the left-hand menu.
-That will bring up the transfers page, which lists all your past transfers in chronological order. From here you can make a new transfer, add a transfer, view the details of a past transfer or delete it.
-You can filter the transfers based on source (From), destination(to), and date.
+To start working with Transfers, click "Inventory", then "Transfers" in the left-hand menu.
+That will bring up the Transfers page, which lists all your past Transfers in chronological order.
+
-[TODO: Screenshot]
-## Adding a transfer
-To add a transfer, click the "+New Transfer" button on the transfers page. That will bring up this screen.
+You can filter the Transfers based on source (From), destination(to), and date.
+From here you can make a new Transfer, add a Transfer, view the details of a past Transfer or delete it.
-[TODO: Screenshot]
+## Adding a Transfer
+To add a Transfer, click the "+New Transfer" button on the Transfers page.
+
+That will bring up the New Inventory Transfer page.
+
-Specify where the items being moved are coming from, in "From Storage Location," and where they are going to in "To storage location".
+Specify where the Items being moved are coming from, in "From Storage Location," and where they are going to in "To Storage Location".
-The Comment field is a good place to note the reason for the transfer, but you can leave it blank.
+The Comment field is a good place to note the reason for the Transfer, but you can leave it blank.
-Then select the item and quantity for each item that is being transferred. If you have [barcodes](inventory_barcodes.md) set up, you can use your barcode reader to "boop" in the materials being transfered.
+Then select the Item and quantity for each Item that is being Transferred. If you have [barcodes](inventory_barcodes.md) set up, you can use your barcode reader to "boop" in the materials being Transfered.
-When you are done, click "Save". The system will check that you have enough inventory in "From" to cover the transfer. If so, the inventory changes will take place immediately.
+When you are done, click "Save". The system will check that you have enough inventory in "From" to cover the Transfer. If so, the inventory changes will take place immediately.
-[TODO: Make clear on each item where it might be unclear when the inventory changes happen. Probably should write something in the intro for that too]
+## Viewing the details of a Transfer
+To view the details of a Transfer, click the "view" button beside it in the Transfers list.
-## Viewing the details of a transfer
-To view the details of a transfer, click the "view" button beside it in the transfers list.
+
+This lists all the Items in the Transfer, and how much was transferred, as well as your comment.
+
+## Deleting a Transfer
-[TODO: Screenshot]
+This should not happen very often!
-This lists all the items in the transfer, and how much was transferred, as well as your comment.
+To delete a Transfer, click the "delete" button beside the Transfer.
+[Delete Transfer navigation](images/inventory/inventory_transfers_delete.png)
-## Deleting a transfer
-
-To delete a transfer, click the "delete" button beside the transfer, and press "OK" to confirm.
-This check that the inventory levels in the two storage locations will allow the change. If they will, it will roll back the inventory changes that were made when you entered the transfer.
+Then press "OK" to confirm.
+This will check that the inventory levels in the two Storage Locations will allow the change. If they will, it will roll back the inventory changes that were made when you entered the Transfer.
##### ** N.B. This is not undoable ***
----
-Note: If you do delete the wrong transfer, you don't have to panic, but it will be a hassle. You can find a record of any transfer made since September 2024 in the "History" Report to grab the numbers and re-enter it. The inventory changes in that case will be as of the date you re-enter, though.
+[!NOTE] If you do delete the wrong Transfer, you can find a record of any Transfer made since September 2024 in the "History" Report. There you can find the amount transferred for each Item, so that you could re-enter them. The inventory changes in that case will be as of the date you re-enter, though.
----
-## Exporting transfers
-To export a list of the transfers, click "Export Transfers" on the transfers page
-[TODO: Screenshot]
-[TODO : screenshot of sample export]
+## Exporting Transfers
+To export a list of the Transfers, click "Export Transfers" on the Transfers page
+
+
+The details in the export are lacking -- it doesn't show each Item, but only the total.
+
-The details in the export are lacking -- it doesn't show each item, but only the total.
-[TODO: Add a better export to the Things to do]
+(Expanding it to include the Items transferred is a task on our things to do. Please [reach out](intro_ii.md)) if this is a high priority for you.)
[Prior: Adjustments](inventory_adjustments.md) [Next: Product Drives](community_product_drives.md)
\ No newline at end of file
diff --git a/docs/user_guide/bank/pm_adding_a_partner.md b/docs/user_guide/bank/pm_adding_a_partner.md
index 3444f7b6e0..795bed78cf 100644
--- a/docs/user_guide/bank/pm_adding_a_partner.md
+++ b/docs/user_guide/bank/pm_adding_a_partner.md
@@ -1,27 +1,31 @@
-# 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". Then, fill in the following information, and click "Add Partner Agency".
-
-##### Note: This just sets up the partner so you can distribute to them. It does *not* notify or invite the partner -- that is a separate step.
+READY FOR REVIEW
+# 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". Then, fill in the following information, and click "Add Partner Agency".
+
+
+[!NOTE] This just sets up the Partner so you can distribute to them. It does *not* notify or invite the Partner -- that is a separate step.
### Name (mandatory)
-This is the name of the agency. It will appear in dropdowns for you to select when filtering requests or distributions, or when entering a new distribution.
+This is the name of the agency. It will appear in dropdowns for you to select when filtering Requests or Distributions, or when entering a new Distribution.
### E-mail(mandatory)
-This is the primary contact for the partner. Any system emails regarding the partner [TODO: list examples] will be sent to this address.
-### Default storage location
-Choosing a default storage location here is a short-cut that will automatically fill in the source location in the distribution that is started when you fulfill a request from this partner. (Don't worry, you can change it.)
+This is the primary contact for the Partner. Any system emails regarding the Partner, such as notifications of Distributions or reminders of Request deadlines, will be sent to this address.
+### Default Storage Location
+Choosing a default Storage Location here is a short-cut that will automatically fill in the Storage Location when you fulfill a Request from this Partner. (Don't worry, you can change it.)
### Group
-What group, if any, does the partner belong to. Groups are very handy if you want to, say, allow only specific groups to be able to request certain items. For more details see [Partner Groups](pm_partner_groups.md)
-[TODO: Check what happens if none is chosen, but there are groups. Does the partner get to request nothing or everything?]
+What Partner Group, if any, does the Partner belong to. Partner Groups are very handy if you want to, say, allow only certain Partners to be able to request some Items. For more details see [Partner Groups](pm_partner_groups.md)
+
+[!NOTE] If you use Partner Groups, please note that any Partners that do not belong to a Partner Group will be able to choose from all the Items. So if you need to restrict certain Items to a specific group, then you're going to have to have all your Partners belonging to some Partner Group
+[!NOTE] Partners who belong to Partner Groups can *only* choose the Items that have the Item Categories specified for their Partner Group.
-### Do you want this partner to receive emails for distributions and reminders from the system?
-Hopefully this is self-explanatory, but also see the questions about customizing reminders in [your organization](getting_started_customization.md)
+### Do you want this Partner to receive emails for Distributions and Reminders from the system?
+See also the questions about customizing reminders in [your organization](getting_started_customization.md)
### Quota
-This is an information-only quota -- it is meant to be total items per request. We give a friendly "are you sure you wanted to order that much?" kind of warning on the partner's confirmation screen if they over order, but there is *no* actual enforcement. If entered, this value is also displayed in your view of the requests.
+This is an information-only quota -- it is meant to be total Items per request. We give a friendly "are you sure you wanted to order that much?" kind of warning on the partner's confirmation screen if they over order, but there is *no* actual enforcement. If entered, this value is also displayed in your view of the requests.
### Notes
-Bank-only [TODO: Double-check -- i'm 95% sure that's right] notes about the partner.
+Bank-only notes about the Partner.
### Documents
-Documents concerning the partner -- bank only [TODO: double check]
+Documents concerning the Partner -- bank only
[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 76deb1ded6..faa3e8d2e2 100644
--- a/docs/user_guide/bank/pm_announcements.md
+++ b/docs/user_guide/bank/pm_announcements.md
@@ -1,37 +1,33 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
+# Partner Announcements
-# 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.
-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.
+You can add multiple Announcements, with links to additional information, and either have an expiry date or delete them when they are no longer useful. The Announcements will be shown in reverse chronological order, by time entered.
-You can add multiple announcements, with links to additional information, and either have an expiry date or delete them when they are no longer useful. The announcments will be shown in reverse chronological order
+## How to create an Announcement
-[TODO: confirm that there isn't something odd, like the ones with expiries showing first]
-
-## 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.
+Click on "Partner Agencies" in the left hand menu, then "Partner Announcement". This will bring up a list of all your partner Announcements.
-Click the "New Announcements" button to bring up a form for a new announcement
+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".]
Here you can fill in
-- Up to 500 characters for your announcement.
+- 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.]
+- 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.
-Then, as soon as you click "Broadcast announcement", the partners will see it when they log in.
+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"
+## Changing an Announcement
+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.
+## 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 dd97f8b0c5..5685509fc5 100644
--- a/docs/user_guide/bank/pm_approving_a_partner.md
+++ b/docs/user_guide/bank/pm_approving_a_partner.md
@@ -1,39 +1,38 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
+# Approving Partners
-[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.]
+There are three paths in to reviewing a Partner's information before approving them to make Requests:
-# Approving partners
+1/ There is a list of Partners awaiting approvals on the dashboard. To start the approval process, click "Review Application";
-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]
+or
-2/ Click "Partner Agencies" and "All Partners" in the left-hand menu, then "Review Application" beside the partner.
+2/ Click "Partner Agencies" and "All Partners" in the left-hand menu, then "Review Applicant's Profile" 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]
+or
+
+3/ Click "Partner Agencies" and "All Partners" in the left-hand menu, then click the Partner's name. Scroll down to view the Partner Profile information, and click "Approve Partner" if it has what is needed.
-----------------------------------
-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.
+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.
-[TODO: Link should go to the part of partner profiles that lists all the fields]
+See [Partner profiles](pm_partner_profiles.md#viewing-a-partner-profile) for details on the Partner Profile.
-Once you have reviewed the partner's info, and want to approve them to make requests, click the "Approve Partner " button.
+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"
+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
index 53f0a37cac..4c64aa70a8 100644
--- a/docs/user_guide/bank/pm_editing_a_partner.md
+++ b/docs/user_guide/bank/pm_editing_a_partner.md
@@ -1,19 +1,23 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
-# Editing a partner
+# Editing a Partner
-Note - this is editing a partner's basic information, not their [profile](pm_partner_profiles.md)
+Note - this is editing a Partner's basic information, not their [Partner Profile](pm_partner_profiles.md). What's the difference? The basic Partner information is what you enter when you are initially creating the Partner, whereas the Partner Profile contains a high level of detail that can be entered by the Partners themselves.
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:
+That will bring up this screen. Click "Edit Partner Information" to bring up the Partner edit screen:
-[TODO: Screenshot]
+
-Click "Edit Partner Information" to bring up this screen:
+This is the same selection of information you provided when you initially added the partner.
+
+
-[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 f44ddaa43d..c2193cb85c 100644
--- a/docs/user_guide/bank/pm_importing_partners.md
+++ b/docs/user_guide/bank/pm_importing_partners.md
@@ -1,9 +1,9 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
# 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.
+**N.B.** We've set up importing partners as a process you 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.
+To import partners, you will need a .csv (comma-separated variable) 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.)
@@ -12,14 +12,13 @@ You will see a pop-up with a "Download example CSV" button (A) on it. Clicking
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.
+You can edit this in your favourite spreadsheet program, or just as a text file. But you need to save it as a .csv 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.
+If you see "Partners were imported successfully!", that's good! 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 9b6f2feee3..88edbca4a7 100644
--- a/docs/user_guide/bank/pm_inviting_a_partner.md
+++ b/docs/user_guide/bank/pm_inviting_a_partner.md
@@ -1,59 +1,61 @@
-Draft User Guide
-# Inviting a partner
+READY FOR REVIEW
+# Inviting a Partner
-Before a partner can make requests, they have to be invited and approved.
+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,
+These links expire in a couple of weeks, 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.
+There are two options for enabling Partners to Request.
The first, default, option is:
-1/ You invite the partner.
+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).
+3/ They then sign in and go into their "My Organization", update whatever 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.
+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.
+1/ You invite and approve the Partner.
2/ They click on the link and set up their password.
-3/ They can now make requests.
+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
+information you do need from your Partners which can impact your grant-writing and
your annual reports.
-# How to invite a partner
+# 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.
+2/ Find the Partner you wish to invite.
+3/ Click on the "Invite" 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).
+# How to invite and approve a Partner
+First, make sure that you have "Use one-step Partner invite 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.
+2/ Find the Partner you wish to invite and approve.
+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 000e7b3847..25af1aa11c 100644
--- a/docs/user_guide/bank/pm_making_a_partner_inactive.md
+++ b/docs/user_guide/bank/pm_making_a_partner_inactive.md
@@ -1,35 +1,35 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
-# Making a partner inactive
+# 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")
+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:
+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.
+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?
+You'll see a message that the Partner is successfully deactivated, and they will not appear in the default All Partners list.
-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.
+Note that if there has never been any activity for the Partner at all, you will be prompted to delete instead. This is permanent.
-[TODO: screenshot]
+## But what if I need to see them?
-## Can I reactivate them?
+If you need to see the information for a deactivated Partner, go to the All Partners list, and click on the "Deactivated" link (see A, below).
+This will bring up a list of all the deactivated Partners. You can then click on them to view their information.
-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.
+
+## Can I reactivate them?
-[TODO: screenshot]
+Yes. Bring up the list of deactivated Partners, then click on the "Reactivate" (B, above) button beside the partner. Click "Ok" on the confirmation window that pops up.
-This will bring them up in the same status as they were when you deactivated them.
+This will restore them to the same status as 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
index 1cfb695e12..73b3854c94 100644
--- a/docs/user_guide/bank/pm_other_information.md
+++ b/docs/user_guide/bank/pm_other_information.md
@@ -1,14 +1,11 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
-There are a few other things with partners that didn't fit into any of the sections above:
+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.
+1/ You can see the Families served, Children served and zipcodes served, when you view a partner
+- 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 Profile
+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
index d7d977f6d3..e4c5eeba60 100644
--- a/docs/user_guide/bank/pm_partner_groups.md
+++ b/docs/user_guide/bank/pm_partner_groups.md
@@ -1,42 +1,41 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
# 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)
+- 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.]
+Partner Groups allow you to manage that. They allow you to set the item categories (see [Item Categories](inventory_items.md)) that a Partner Group can request
-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.
+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 Partner Groups,
+4/ Then assign a Partner Group to the Partners on an individual basis -- you may want to set up your groups before adding your partners.
-# Adding a partner group
+# 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"
-
+
This will bring up a form like this (the categories will be different):
-
+
## 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.
+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 must 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
+The Partners who are in this Partner 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.
+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]
+If a Partner is not in a Partner Group, they can request any item that is visible to partners.
+If a Partner is not in a Partner Group, they will receive reminder emails, if those emails have been set up on an organization level
[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 e1a5ecd1bb..a5dfb00dfd 100644
--- a/docs/user_guide/bank/pm_partner_profiles.md
+++ b/docs/user_guide/bank/pm_partner_profiles.md
@@ -1,22 +1,22 @@
-DRAFT USER GUIDE
-
-[TODO: Screenshots throughout. Waiting for Partner Profiles rework.]
+READY FOR REVIEW
# 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.
+[!NOTE] We are in progress of reworking the Partner Profiles. In the interest of not duplicating effort, we have not included the screenshots in this section until that is ready for launch.
+
+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).
+There is a *lot* of information in the profiles, 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
+## 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.
+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 saved 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."
+# Viewing a Partner 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 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:
@@ -58,7 +58,7 @@ Sometimes, a large agency may have a separate address for a specific program or
### 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:
+*If* the bank chooses to ask for this information, the Partner must fill in at least one of the fields:
- Website
- Facebook
@@ -66,8 +66,6 @@ This provides a place for the agency to indicate their major communication outle
- Instagram
- No Social Media Presence
-
-
### Agency Stability
This section is about the maturity of the agency.
@@ -100,12 +98,12 @@ How does the agency get its funding?
### 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.
+At this time, this only covers U.S. counties and equivalents. We believe the list covers *all* of the U.S, including some areas that are not tecnically 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"
+You start out with space for 1 county, but can add more with the "Add Another County button"
### Population Served
This section has only two questions:
@@ -113,7 +111,7 @@ This section has only two questions:
- 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.
+This section is comprised of questions about the race/ethnicity of the client base and the poverty level of the Partner's client base.
There is no check on whether the numbers add up to 100 -- because there may be overlap.
### Race/Ethnicity:
@@ -132,7 +130,8 @@ Contact information for the head of the agency:
- Executive Director Phone
- Executive Director Email
-- [TODO: Check if this is ever used for outgoing email]
+This is for your information only. It is not used for any emails.
+
### Primary Contact
Contact information for your bank's primary contact
- Primary Contact Name
@@ -140,17 +139,14 @@ Contact information for your bank's primary contact
- 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.]
+This is for your information only. It is not used for any emails.
### 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?]
-
+The Pick up person will receive an email (as well as the person who made the Request) when a Distribution is scheduled, if the Distribution type is "Pick up"
- Pick Up Person Name
- Pick Up Person's Phone #
-- Pick Up Person's Email
-Note this can be multiple, comma-separated emails.
+- Pick Up Person's Email
+ - This can be multiple, comma-separated emails.
### Agency Distribution Information
This section is about the agency's practices when distributing to their clients.
@@ -160,14 +156,14 @@ This section is about the agency's practices when distributing to their clients.
- 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.
+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.
+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 there, 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
+[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
index a1f3de7bd2..a40c13dac1 100644
--- a/docs/user_guide/bank/pm_partner_reactivation.md
+++ b/docs/user_guide/bank/pm_partner_reactivation.md
@@ -1,4 +1,4 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
# Partner reactivation
@@ -10,7 +10,7 @@ This will bring up a list of all the deactivated partners. You can then click on
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.
diff --git a/docs/user_guide/bank/pm_partner_statuses.md b/docs/user_guide/bank/pm_partner_statuses.md
index afddbe08d8..be107cc517 100644
--- a/docs/user_guide/bank/pm_partner_statuses.md
+++ b/docs/user_guide/bank/pm_partner_statuses.md
@@ -1,35 +1,46 @@
-DRAFT USER GUIDE
-# Partner statuses (what can partners do when)
+READY FOR REVIEW
+# Partner statuses (what can Partners do when)
-As an essential bank, you distribute materials (diapers, period products, etc.) to your partners who interface with the people in need of the items.
+As an Essentials Bank, you distribute materials (diapers, period products, etc.) to your Partners who interface with the people in need of the items.
-Depending on factors like how well-established your processes are and the capabilities of your partners, you might or might not allow/require your patners to make requests to get materials distributed to them.
+Depending on factors like how well-established your processes are and the capabilities of your Partners, you might or might not allow/require your Partners to make Requests to get materials distributed to them.
-There are three partner statuses, which have different impacts on how you interact with your partners.
+There are three Partner statuses, which have different impacts on how you interact with your Partners.
## Uninvited
-You can add partners without inviting them to the system. In this case, you can make distributions to them in the system. The partners can not sign in to the system, and so will not directly provide the information in the partner profile. This is the status of imported partners.
-The partners will still get emails regarding deadlines and distributions (assuming you have set them up to do so) [TODO: expand -- what are the conditions under which partners get which emails -- ]
-[TODO: Check: do we have an add and invite on the import, or just add]
+You can add Partners without inviting them to the system. In this case, you can make Distributions to them in the system. The Partners can not sign in to the system, and so will not directly provide the information in the Partner Profile. This is the status of freshly imported Partners.
+The Partners will still get emails regarding deadlines and Distributions (assuming you have set them up to do so through your bank's [customization](getting_started_customization.md#reminder-emails-optional) and any [Partner Groups](pm_partner_groups.md#do-you-want-to-send-deadline-reminders-to-them-every-month) they belong to.
+
+If you import your Partners, they will be imported as Uninvited.
+
## Invited
-Once you invite a partner, an email goes out to the to allow them to provide a password. [TODO: Details of email] They will then have access to the partner profile. They cannot, however, make requests.
+Once you invite a Partner, we set up the Partner's email as a user, send an email to allow them to provide a password, and set their status to
+"Invited".
+
+Sample email:
+
+
+
+If you use the "Invite and Approve" option, the Partner's status will be "Approved"
+
+Invited Partners have access to the Partner Profile. They cannot, however, make Requests.
-The 'standard' sequence is for the partners to fill in some information in the partner profile, then "request approval" of the bank. The bank then reviews the information provided, and either approves, or asks for changes.
+The 'standard' sequence is for the Partners to fill in some information in the Partner Profile, then "Submit for Approval" of the bank. The bank then reviews the information provided, and either approves, or asks for changes.
-However, many banks get the information from their partners in other ways. Some, for instance, will fill in the information themselves while on a call with the partner.
+However, many banks get the information from their Partners in other ways. Some, for instance, will fill in the information themselves while on a call with the Partner.
## Awaiting review
-Once a partner has been invited, they will use the "edit my organization" function in their view of the system to provide the information. After saving the screen, they can "submit for approval" - which changes the status to "Awaiting review. This partner will now appear on your dashboard, in the "Partner Approvals" section. The partner will not be able to make requests until they are approved.
+Once a Partner has been invited, they will use the "Edit my Profile" function in their view of the system to provide the information. They can save their progress, and then "save and review", then "submit for approval" - which changes the status to "Awaiting review. This Partner will now appear on your dashboard, in the "Partner Approvals" section. The Partner will not be able to make Requests until they are approved.
## Approved
-Approved partners can make requests.
-Note: There is no system-required information for partner approval -- you can approve them as soon as they are invited.
+Approved Partners can make Requests.
+Note: There is no system-required information for Partner approval -- you can approve them as soon as they are invited.
## Recertification Required
-In order to keep your partner information up to date, you may (usually on an annual basis) require your partners to review and revise their profile information. The main reason to do this is to ensure you have up to date information for contact and for grant writing. Until the partner submits the updated information and you approve it, they will not be able to enter requests in the system.
-Please note that the partner can update this information at any time -- you don't have to use this to allow them to update their info.
+In order to keep your Partner information up to date, you may (usually on an annual basis) require your Partners to review and revise their Profile information. The main reason to do this is to ensure you have up to date information for contact and for grant writing. Until the Partner submits the updated information and you approve it, they will not be able to enter Requests in the system.
+Please note that the Partner can update this information at any time -- you don't have to use this to allow them to update their information.
[Prior: The Request/distribution cycle](pm_request_distribution_cycle.md)
-[Next: importing partners](pm_importing_partners.md)
+[Next: importing Partners](pm_importing_partners.md)
diff --git a/docs/user_guide/bank/pm_partner_user_admin.md b/docs/user_guide/bank/pm_partner_user_admin.md
index f0a0dea0a0..a0d975fd83 100644
--- a/docs/user_guide/bank/pm_partner_user_admin.md
+++ b/docs/user_guide/bank/pm_partner_user_admin.md
@@ -1,18 +1,20 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
-# Administering partner users
+# 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.)
+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?
+## 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.
+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.
-[TODO: Navigation screenshots]
+
+Then click "Manage Users" near the top of that screen.
+
-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).
+This will bring you to a list of Users for that Partner. Here you can invite new Users, start a reset password process (B) (they will receive an email with a link to reset their password), or remove access to that Partner from the User(C).
-[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
+[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 7a4fb6d12b..2f50f79ad5 100644
--- a/docs/user_guide/bank/pm_request_distribution_cycle.md
+++ b/docs/user_guide/bank/pm_request_distribution_cycle.md
@@ -1,34 +1,34 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
# 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.
+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.
+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.
+For clarity - you can make Distributions without Requests.
-So, how does this work?
+So, how does working with Requests from Partners work?
-1/ The partner fills in a request form on the system and saves it.
+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.
+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.
+3/ This Request 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)
+4/ You view the Request, and click "Fulfill Request" (you also 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.
+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.
+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.
+9/ You can mark the Distribution as complete. This is not required, but provides a way to focus on just the upcoming ones.
+
+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.
-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: Partner statuses](pm_partner_statuses.md)
diff --git a/docs/user_guide/bank/pm_requesting_recertification.md b/docs/user_guide/bank/pm_requesting_recertification.md
index 13c6f38c9e..5f5eee95f7 100644
--- a/docs/user_guide/bank/pm_requesting_recertification.md
+++ b/docs/user_guide/bank/pm_requesting_recertification.md
@@ -1,23 +1,40 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
# 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.
+From time to time, perhaps annually, you may want to confirm that the information your Partner has provided is still correct. That is what "request recertification" is for.
+[!WARN] Once you request recertification, the Partner will not be able to enter Requests until you have approved them again!!
-#### *** 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, and their status will change to "Recertification required".
-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".
+Here is the text of that email
-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".
+---------
+Hi [Partner name]
-[TODO: provide screenshot -- that screen is likely to change before the end of writing.]
+It's time to update your agency information!
-This will change the status of the partner to "Recertification required".
+Please log in to your account at http://humanessentials.app/users/sign_in
-Once they have made their changes, you can [approve](pm_approving_a_partner.md) them again, which will restore their ability to make requests.
+If no information has changed, please click Update.
+If any information has changed, please amend it on the form and then click Update.
-(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)
+If you have any questions please contact [Bank name] at [Bank email]
+
+Thank you and have a great day!
+
+----------
+
+
+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".
+
+
+
+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 Pequests.
+
+[!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 1b46320234..58b164565a 100644
--- a/docs/user_guide/bank/readme.md
+++ b/docs/user_guide/bank/readme.md
@@ -1,6 +1,6 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
-This user guide is meant for users of the human essentials app at essentials banks. As of October 25, 2024, it is a work in progress. If you are interested in helping out, please reach out to @cielf.
+This user guide is meant for users of Human Essentials at essentials banks. As of November 2, 2024, it is a work in progress. If you are interested in helping out, please reach out to @cielf.
1. Introduction
1. [Is Human Essentials right for you?](intro_i.md) (what we help with and what we don't)
@@ -64,6 +64,9 @@ This user guide is meant for users of the human essentials app at essentials ban
2. [Distributions by county](reports_distribution_by_county.md)
3. [Manufacturer donations](reports_manufacturers_donations.md)
4. [Activity graph](reports_activity_graph.md)
+ 5. [History](reports_history.md)
8. [User management](user_management.md)
9. [Account Management](account_management.md)
10. [But I need to do something different!](asking_for_changes.md)
+11. Special Topics
+ 1. [Custom Units](special_custom_units.md)
diff --git a/docs/user_guide/bank/reports_activity_graph.md b/docs/user_guide/bank/reports_activity_graph.md
index b54dd70e4b..ec6677f79f 100644
--- a/docs/user_guide/bank/reports_activity_graph.md
+++ b/docs/user_guide/bank/reports_activity_graph.md
@@ -1,13 +1,13 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
# Activity Graph Report
-This report is merely a visual representation of the number of items processed over a time period.
+This report is merely a visual representation of the number of Items processed over a time period.
-If you want to see a time period other than the current year, change the date range and click "Filter". Note, we recommend you use the little pop-up gizmo to enter your date range, as the format of the date range is very fussy.
+If you want to see a time period other than the default period of 60 days prior to 30 days forward from today, change the date range and click "Filter". Note, we recommend you use the little pop-up gizmo to enter your date range, as the format of the date range is very fussy.
[Back to Manufacturers Donations](reports_manufacturers_donations.md)
-[Next: User Management](user_management.md)
+[Next: History](reports_history.md)
diff --git a/docs/user_guide/bank/reports_annual_survey.md b/docs/user_guide/bank/reports_annual_survey.md
index f9702437f3..5c066d8d8c 100644
--- a/docs/user_guide/bank/reports_annual_survey.md
+++ b/docs/user_guide/bank/reports_annual_survey.md
@@ -1,4 +1,4 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
## 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 year.
@@ -24,15 +24,15 @@ You can also extract the report to a csv file by clicking "Export Report" (B)
### Calculation notes
-1/ We are in the process of changing the calculations so that items in kits appear in the totals for each value.
-At time of writing, the # of disposable and cloth diapers distributed include any diapers in kits, but period supplies, adult incontinence, and other do not.
-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.)
+1/ We are in the process of changing the calculations so that Items in Kits appear in the totals for each value.
+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.
+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.)
-2/ % donated / purchased is based on the number of items acquired, not the number of items distributed.
+2/ % donated / purchased is based on the number of Items acquired, not the number of Items distributed.
3/ How we calculate per person values:
- If you have entered a non-zero value for an [item](inventory_items.md) in the quantity per individual field, we use that value. Otherwise, we assume 50 of the item per individual.
-[TODO: When inventory_items.md is written, point the above link to the right place in it.]
+ 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.
+
[Prior: Trends](reports_trends.md) [Next: Distributions by County](reports_distributions_by_county.md)
\ No newline at end of file
diff --git a/docs/user_guide/bank/reports_distributions_by_county.md b/docs/user_guide/bank/reports_distributions_by_county.md
index 3768c9151e..6851229eb9 100644
--- a/docs/user_guide/bank/reports_distributions_by_county.md
+++ b/docs/user_guide/bank/reports_distributions_by_county.md
@@ -1,17 +1,17 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
# Distributions by County Report
-This report shows the total items and estimated total market value of the distributed items for the time period.
+This report shows the total items and estimated total market value of the distributed Items for the time period.
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.
-**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.
+**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.
-If you want to see a time period other than the current year, 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.
+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.
diff --git a/docs/user_guide/bank/reports_history.md b/docs/user_guide/bank/reports_history.md
new file mode 100644
index 0000000000..678e777dc9
--- /dev/null
+++ b/docs/user_guide/bank/reports_history.md
@@ -0,0 +1,9 @@
+READY FOR REVIEW
+
+# History Report
+This is mainly used for troubleshooting by the Human Essentials team. You are unlikely to need it in your day-to-day work.
+
+It contains a record of every change that was made affecting inventory since we put it in in late 2024.
+
+[Prior: Activity graph](reports_activity_graph.md)
+[Next: User Management](user_management.md)
\ No newline at end of file
diff --git a/docs/user_guide/bank/reports_itemized_reports.md b/docs/user_guide/bank/reports_itemized_reports.md
index a8cdc7c483..fc8888c280 100644
--- a/docs/user_guide/bank/reports_itemized_reports.md
+++ b/docs/user_guide/bank/reports_itemized_reports.md
@@ -1,17 +1,17 @@
-DRAFT USER GUIDE!
+READY FOR REVIEW
# Itemized Reports
-The itemized reports break down the inventory by item over a given time period. There are itemized reports for donations and for distributions.
-The following will use the itemized report for distributions, but the itemized report for donations basically works the same way.
+The itemized reports break down the inventory by Item over a given time period. There are itemized reports for Donations and for Distributions.
+The following will use the itemized report for Distributions, but the itemized report for Donations basically works the same way.
To show this report, click on "Reports" in the left-hand menu, then "Distributions - Itemized"
-The initial view that comes up will show the items distributed during the current calendar year.
-[TODO: Check if the filtration here is on issued_at or on the date of the line items]
+The initial view that comes up will show the Items distributed during the default period of 60 days prior to, 30 days forward from today.
+This is based on the "issued at" date, so even if you edit your distribution after the fact, any changes will be kept with that date.
-If the amount on hand is less than the minimum quantity you provided for that item (see [Items](inventory_items.md)), then the on hand amount will be highlighted in red.
+If the amount on hand is less than the minimum quantity you provided for that Item (see [Items](inventory_items.md)), then the on hand amount will be highlighted in red.
You can change the timeframe that this report covers in the usual way -- use the gizmo that will appear if you click on the date range at the top of the report to set the dates, then click "Filter"
diff --git a/docs/user_guide/bank/reports_manufacturers_donations.md b/docs/user_guide/bank/reports_manufacturers_donations.md
index 7cb31abc49..dcbeb7ad83 100644
--- a/docs/user_guide/bank/reports_manufacturers_donations.md
+++ b/docs/user_guide/bank/reports_manufacturers_donations.md
@@ -1,5 +1,4 @@
-DRAFT USER GUIDE
-
+READY FOR REVIEW
# Manufacturers Donations Report
To access this report, click 'Reports", then "Donations - Manufacturers"
@@ -7,18 +6,17 @@ To access this report, click 'Reports", then "Donations - Manufacturers"
-This shows the number of items donated by manufacturers over the indicated time period (default current year), as well as the top manufacturers donating in that time period.
-[TODO: Confirm -- is this true -- or is this still broken?]
+This shows the number of items donated by Manufacturers over the indicated time period (default 60 days prior to 30 days forward from today), as well as the top Manufacturers donating in that time period.
-From here, you can click on the listed manufacturers to see a breakdown of their donations.
+From here, you can click on the listed Manufacturers to see a breakdown of their Donations.
-Or enter a new donation (by clicking on "New Donation", naturally.)
+Or enter a new Donation (by clicking on "New Donation", naturally.)
-Or see all donations for the time period, by clicking on 'See more...'
+Or see all Donations for the time period, by clicking on 'See more...'
-If you want to see a time period other than the current year, 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.
+If you want to see a time period other than the default, 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.
-
+
[Back to Distributions by County](reports_distributions_by_county.md)
diff --git a/docs/user_guide/bank/reports_summary_reports.md b/docs/user_guide/bank/reports_summary_reports.md
index 8e8cc2c451..21840ffdbf 100644
--- a/docs/user_guide/bank/reports_summary_reports.md
+++ b/docs/user_guide/bank/reports_summary_reports.md
@@ -1,27 +1,30 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
# Summary Reports
There are 3 Summary reports - one each for Distributions, Donations, and Purchases
-These each allow you to quickly get the number of items dealt with in a timeframe, plus links to recent activity
+These each allow you to quickly get the number of Items dealt with in a timeframe, plus links to recent activity
## Distribution Summary
-This gives the number of items distributed -- initially year-to-date, but you can filter by whatever date range you wish. This filtering works against the "issued_at" date on the distribution, rather than the date it was entered.
+This gives the number of Items distributed -- initially for the last 60 days (and 30 days forward), but you can filter by whatever date range you wish. This filtering works against the "issued_at" date on the Distribution, rather than the date it was entered.
-The report also gives the number of items that are in distributions that have an "issued at" in the future.
+The report also gives the number of Items that are in Distributions that have an "issued at" in the future.
-The "recent distributions" section shows recently entered distributions that match the date filter. That is, whether or not a distribution shows here is based on the filter, but the order depends on when it was entered -- latest first.
-[TODO: Marked up Screenshots]
+The "Recent Distributions" section shows recently entered Distributions that match the date filter. That is, whether or not a Distribution shows here is based on the filter, but the order depends on when it was entered -- latest first.
+
+
## Donation Summary
This is quite similar to the Distribution summary, above.
-This gives the number of items donated -- initially year-to-date, but you can filter by whatever date range you wish. This filtering works against the "issued on" date on the distribution, rather than the date it was entered.
+
+This gives the number of Items donated -- initially for the last 60 days, but you can filter by whatever date range you wish. This filtering works against the "issued on" date on the Donation, rather than the date it was entered.
It also gives the total of monetary donations recorded in the system for that period
-The "recent donations" section shows recently entered donations that match the date filter. That is, whether or not a donation shows here is based on the filter, but the order depends on when it was entered -- latest first.
-[TODO: Marked up Screenshots]
+The "Recent Donations" section shows recently entered Donations that match the date filter. That is, whether or not a donation shows here is based on the filter, but the order depends on when it was entered -- latest first.
+
+
## Purchase Summary
-This merely gives the amount spent during the period, along with recently entered purchases that match the date filter. The filter works on the issued on date, but the ordering is by the creation date of the purchase.
-[TODO: Marked up Screenshots]
+This presents the amounts spent during the period, along with recently entered Purchases that match the date filter. The filter works on the issued on date, but the ordering is by the creation date of the Purchase, newest first.
+
[Prior: Exports](exports.md)[Next: Itemized reports](reports_itemized_reports.md)
\ No newline at end of file
diff --git a/docs/user_guide/bank/reports_trends.md b/docs/user_guide/bank/reports_trends.md
index 76dddd8735..e327afcd37 100644
--- a/docs/user_guide/bank/reports_trends.md
+++ b/docs/user_guide/bank/reports_trends.md
@@ -1,6 +1,6 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
# Trends Reports
-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.
+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.
The examples below will use the Distributions - Trends report, but everything is basically the same for Donations- Trends and Purchases - Trends.
@@ -13,19 +13,19 @@ This will bring up a blank "Monthly" Distributions report, like so:
-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.
+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.
(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!)
-You can also hover over any month to see the numerical levels for the chosen items for that month.
+You can also hover over any month to see the numerical levels for the chosen Items for that month.
-To clear the items - either click on them again, or click "Deselect All"
+To clear the Items - either click on them again, or click "Deselect All"
-You can click "Select All" to see *all* the items, but that will produce a very busy visual.
+You can click "Select All" to see *all* the Items. That will produce a very busy visual, indeed.
diff --git a/docs/user_guide/bank/special_custom_units.md b/docs/user_guide/bank/special_custom_units.md
new file mode 100644
index 0000000000..fd76900b95
--- /dev/null
+++ b/docs/user_guide/bank/special_custom_units.md
@@ -0,0 +1,16 @@
+READY FOR REVIEW
+# Coming Soon -- Custom Units (opt-in feature)
+
+The number of items throughout the bank's view of the system is the number of units (e.g. diapers), but
+Partners often think in terms of packs of diapers. Because Banks were getting a lot of partners requesting the number of packs of diapers, instead of the number of diapers, we are introducing the ability for banks to allow the partners to request other units (e.g. packs)
+
+In short, you'll be able to add custom units that they partners can request. The partners then can ask for, say, 'packs' of diapers. You will still have to translate those to the number of items when distributing, because there is a lot of variety in pack size across brands.
+
+
+When this is ready for release, we will update this page, but to preview:
+[!NOTE] None of the following steps are available yet.
+- A bank that wishes to use custom units will add those units on their organization page
+- Then, for any Items that will use the custom units (you are not going to have the same units for car seats and diapers), you add them to that Item
+- At that point, the Partners will see a slightly different screen that will have them pick between "units" and the custom units (say, "packs")
+- When the bank sees the request, they will see the units that were chosen, but have to enter the total quantity for that item (in our example, the number of diapers)
+- The units the partner chose will show wherever we are showing the requested amounts (e.g. when viewing the request, when calculating Product Totals, when fulfilling the request, and in the pdf that is attached to their Distribution email.
diff --git a/docs/user_guide/bank/user_management.md b/docs/user_guide/bank/user_management.md
index 4a2215762e..2e3844e284 100644
--- a/docs/user_guide/bank/user_management.md
+++ b/docs/user_guide/bank/user_management.md
@@ -1,56 +1,84 @@
-DRAFT USER GUIDE
+READY FOR REVIEW
# User Management
-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.
-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.
+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.
+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.
### How do I know what access I have?
If you look at the left-hand menu, and you see, down at the bottom, a section "My Organization", then you have admin access.
-Otherwise, if you see "Donations", you have bank user access.
-If, instead, you see "My Profile", you are signed in as a partner.
-[TODO: Annotated screen shots]
+Otherwise, if you see "Donations", you have bank User access.
+
+If, instead, you see "My Profile", you are currently signed in as a Partner.
+
## Managing Bank staff access
-To manage bank staff, you must be signed in as a user with admin rights.
+To manage bank staff, you must be signed in as a User with admin rights.
-### Adding a user
-To add a user, sign in as someone who has bank admin access, then click on "My Organization" in the left-hand menu.
+### Adding a User
+To add a User, sign in as someone who has bank admin access, then click on "My Organization" in the left-hand menu.
Scroll down to the bottom of that page. You will see a section labelled "Users".
-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.
+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.
-[TODO: More Screenshots]
+
-In the window that pops up, add the user's name and email, then click "Invite User".
+In the window that pops up, add the User's name and email, then click "Invite User".
An email like the following will be sent to that email:
-
+
-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.
-### Deleting a user
+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.
+### Deleting a User
When someone leaves your organization, you will want to remove their access to humanessentials. To do that,
-sign in as someone who has bank admin access, then click on "My Organization" in the left-hand menu.
-Scroll down to the bottom of that page. You will see a section labelled "Users".
-Find the user you wish to delete.
-*If* they had admin access, you will first need to demote them to user, by clicking their "Demote to User" button.
-Then, click the "Actions" button beside their name, and then click "Remove User".
+sign in as someone who has bank admin access, then
-### Giving a user admin access
-To promote a user to have admin access,
+(1) click on "My Organization" in the left-hand menu.
+(2) Scroll down to the bottom of that page. You will see a section labelled "Users".
+Find the User you wish to delete.
+
+*If* they had admin access, you will first need to demote them to User, by clicking their "Demote to User" button.
+
+Then, (3) click the "Actions" button beside their name, and
+(4) click "Remove User".
+
+
+
+
+Click "OK" on the confirmation screen.
+
+
+### Giving a User admin access
+To promote a User to have admin access,
+(1) click on "My Organization" in the left-hand menu.
+(2) Scroll down to the bottom of that page. You will see a section labelled "Users".
+Find the User you wish to promote.
+
+Then, (3) click the "Actions" button beside their name, and
+(4) Click "Promote to Admin"
+
+
+
+
+
+Click "OK" on the confirmation screen.
+
+
+### Removing admin access from a User.
+
+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.
+(2) Scroll down to the bottom of that page. You will see a section labelled "Users".
+Find the User you wish to remove admin access from. (3) Click the "Demote to User" button beside their name and email.
+
+Click "OK" on the confirmation screen.
-[TODO: Write this once it is fixed!]
-### Removing admin access from a user.
-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.
-Scroll down to the bottom of that page. You will see a section labelled "Users".
-Find the user you wish to remove admin access from. Click the "demote to user" button beside their name and email.
### *Help! Our admin quit and we don't have the access we need!*
Send a note to info@humanessentials.app explaining the situation. We review that email on Sunday mornings.
You might be able to get faster turnaround by reaching out on the human essentials slack.
## Managing Partner access
-See [Administering partner users](pm_partner_user_admin.md)
+See [Administering Partner Users](pm_partner_user_admin.md)
-[Prior: Activity graph](reports_activity_graph.md) [Next: Account Management](account_management.md)
\ No newline at end of file
+[Prior: History](reports_history.md) [Next: Account Management](account_management.md)
\ No newline at end of file
diff --git a/docs/user_guide/style_guide.md b/docs/user_guide/documentation_style_guide.md
similarity index 68%
rename from docs/user_guide/style_guide.md
rename to docs/user_guide/documentation_style_guide.md
index a4ab6c9357..ec3af4a1a2 100644
--- a/docs/user_guide/style_guide.md
+++ b/docs/user_guide/documentation_style_guide.md
@@ -8,11 +8,11 @@ We want to do a final pass to make everything consistent with the style guide be
## Capitalization
### Headings
-The first letter of a heading is capitalized. After that,use lower case except for nouns that are always capitalized (see below)
-### Objects in the app
+In documentaion, use title case for the main header for each page, then use sentence case (see this page as an example).
+### When quoting the system
Match the text to what is in the application. For instance, if a button says "Manage Product drives". That being said, if there is something in the app that is inconsistent, let's get that fixed.
-### Always capitalize
-Essentially, if it has a view in Human Essentials, capitalize it
+### Otherwise, always capitalize
+Essentially, if you are referring to an object that has a view in Human Essentials, capitalize it
- Bank
- Partner
- Account
@@ -25,6 +25,12 @@ Essentially, if it has a view in Human Essentials, capitalize it
- Request
- Inventory
- Audit
+
+Also :
+- Human Essentials
+- Essentials Bank
+
## Hyphenation
left-hand menu
in-kind value
+email, not e-mail
diff --git a/lib/seeds.rb b/lib/seeds.rb
new file mode 100644
index 0000000000..f5cd4537ce
--- /dev/null
+++ b/lib/seeds.rb
@@ -0,0 +1,21 @@
+module Seeds
+ def self.seed_base_items
+ # Initial starting qty for our test organizations
+ base_items = File.read(Rails.root.join("db", "base_items.json"))
+ items_by_category = JSON.parse(base_items)
+
+ items_by_category.each do |category, entries|
+ entries.each do |entry|
+ BaseItem.find_or_create_by!(
+ name: entry["name"],
+ category: category,
+ partner_key: entry["key"],
+ updated_at: Time.zone.now,
+ created_at: Time.zone.now
+ )
+ end
+ end
+ # Create global 'Kit' base item
+ KitCreateService.find_or_create_kit_base_item!
+ end
+end
diff --git a/lib/tasks/backup_db_rds.rake b/lib/tasks/backup_db_rds.rake
index b226f6398e..272bd8ef9d 100644
--- a/lib/tasks/backup_db_rds.rake
+++ b/lib/tasks/backup_db_rds.rake
@@ -1,10 +1,11 @@
desc "Update the development db to what is being used in prod"
task :backup_db_rds => :environment do
- system("echo Performing dump of the database.")
+ logger = Logger.new(STDOUT)
+ logger.info("Performing dump of the database.")
current_time = Time.current.strftime("%Y%m%d%H%M%S")
- system("echo Copying of the database...")
+ logger.info("Copying the database...")
backup_filename = "#{current_time}.rds.dump"
system("PGPASSWORD='#{ENV["DIAPER_DB_PASSWORD"]}' pg_dump -Fc -v --host=#{ENV["DIAPER_DB_HOST"]} --username=#{ENV["DIAPER_DB_USERNAME"]} --dbname=#{ENV["DIAPER_DB_DATABASE"]} -f #{backup_filename}")
@@ -16,6 +17,6 @@ task :backup_db_rds => :environment do
storage_access_key: account_key
)
- system("echo Uploading #{backup_filename}")
+ logger.info("Uploading #{backup_filename}")
blob_client.create_block_blob("backups", backup_filename, File.read(backup_filename))
end
diff --git a/lib/tasks/create_inventory_in_out_daily_view.rake b/lib/tasks/create_inventory_in_out_daily_view.rake
deleted file mode 100644
index acb078f7fc..0000000000
--- a/lib/tasks/create_inventory_in_out_daily_view.rake
+++ /dev/null
@@ -1,55 +0,0 @@
-# Getting the daily version as we monitor the difference between inventory in/out and inventory problem.
-# Use -- bring down a local copy of production, then rake create_inventory_in_out_daily_view
-# -- sum the differences, then compare to previous pull. If the sum of differences has changed
-# -- then there has been "inventory drift" in the non-kit items since the last pull
-# -- This was meant to be a daily pull, but has been paused while some known issues are addressed.
-require 'csv'
-task :create_inventory_in_out_daily_view => :environment do
- # Create a big ol' report that is the inventory levels of all the items on all the storage locations.
- # Let's organize it by organization
-
- headers = ["Organization ID","Organization Name", "Storage Location ID", "Storage Location Name", "Item ID", "Item Name", "Inventory In", "Inventory Out", "Expected", "Current Inventory", "Diff", "Inventory item created", "Inventory Item last updated"]
-
- file = "#{Rails.root}/public/inventory_check_#{Time.now}.csv"
- CSV.open(file, 'w', write_headers: true, headers:headers) do |writer|
- organizations = Organization.alphabetized
- organizations.each do |org|
- puts "#{org.id}, #{org.name}"
- storage_locations = org.storage_locations.active_locations.order(:name)
- storage_locations.each do |loc|
- puts "#{org.id}, #{org.name}, #{loc.id}, #{loc.name}"
- line_items_in = ItemsInQuery.new(organization: org, storage_location: loc).call
- line_items_out = ItemsOutQuery.new(organization: org, storage_location: loc).call
- inventory = loc.inventory_items
- line_items_in.each do |line_in|
- in_item_id = line_in.item_id
- in_quantity = line_in.quantity
- line_out = line_items_out.where(item_id: in_item_id).first
- if(line_out.nil?)
- out_quantity = 0
- else
- out_quantity = line_out.quantity
- end
- expected = in_quantity - out_quantity
- inventory_item = inventory.where(item_id: in_item_id).first
- if inventory_item.nil?
- inventory_quantity = 0
- difference = expected - inventory_quantity
- writer << [org.id, org.name, loc.id, loc.name, in_item_id, line_in.item.name, in_quantity, out_quantity, expected, inventory_quantity, difference, "N/A","N/A"]
- else
- inventory_quantity = inventory_item.quantity
- difference = expected - inventory_quantity
- writer << [org.id, org.name, loc.id, loc.name, in_item_id, line_in.item.name, in_quantity, out_quantity, expected, inventory_quantity, difference, inventory_item.created_at, inventory_item.updated_at]
- end
-
-
- # puts "#{org.id}, #{org.name}, #{loc.id}, #{loc.name}, #{in_item_id}, #{line_in.item.name}, #{in_quantity},#{out_quantity}, #{expected}, #{inventory_quantity},#{difference}"
-
- end
-
- end
- end
-
- end
-
-end
\ No newline at end of file
diff --git a/lib/tasks/create_no_kit_daily_view.rake b/lib/tasks/create_no_kit_daily_view.rake
deleted file mode 100644
index 1727ae694c..0000000000
--- a/lib/tasks/create_no_kit_daily_view.rake
+++ /dev/null
@@ -1,80 +0,0 @@
-#Getting the daily version as we monitor the difference between inventory in/out and inventory problem. Version without kits
-# Use -- bring down a local copy of production, then rake create_no_kit_daily_view
-# -- sum the differences, then compare to previous pull. If the sum of differences has changed
-# -- then there has been "inventory drift" in the non-kit items since the last pull
-# -- This was meant to be a daily pull, but has been paused while some known issues are addressed.
-require 'csv'
-task :create_no_kit_item_daily_view => :environment do
- # Create a big ol' report that is the inventory levels of all the items on all the storage locations.
- # Let's organize it by organization
-
- headers = ["Organization ID","Organization Name", "Storage Location ID", "Storage Location Name", "Item ID", "Item Name", "Inventory In", "Inventory Out", "Expected", "Current Inventory", "Diff", "Inventory item created", "Inventory Item last updated"]
-
- file = "#{Rails.root}/public/nki_inventory_check_#{Time.now}.csv"
-CSV.open(file, 'w', write_headers: true, headers:headers) do |writer|
- organizations = Organization.alphabetized
- organizations.each do |org|
- puts "#{org.id}, #{org.name}"
- storage_locations = org.storage_locations.active_locations.order(:name)
- storage_locations.each do |loc|
- puts "#{org.id}, #{org.name}, #{loc.id}, #{loc.name}"
- line_items_in = ItemsInQuery.new(organization: org, storage_location: loc).call
- line_items_out = ItemsOutQuery.new(organization: org, storage_location: loc).call
- inventory = loc.inventory_items
- line_items_in.each do |line_in|
- next if item_is_in_a_kit?(org, line_in)
- next if item_is_a_kit?(org, line_in)
- in_item_id = line_in.item_id
- in_quantity = line_in.quantity
- line_out = line_items_out.where(item_id: in_item_id).first
- if(line_out.nil?)
- out_quantity = 0
- else
- out_quantity = line_out.quantity
- end
- expected = in_quantity - out_quantity
- inventory_item = inventory.where(item_id: in_item_id).first
- if inventory_item.nil?
- inventory_quantity = 0
- difference = expected - inventory_quantity
- writer << [org.id, org.name, loc.id, loc.name, in_item_id, line_in.item.name, in_quantity, out_quantity, expected, inventory_quantity, difference, "N/A","N/A"]
- else
- inventory_quantity = inventory_item.quantity
- difference = expected - inventory_quantity
- puts "writing out #{org.name} #{in_item_id} #{line_in.item.name}"
- writer << [org.id, org.name, loc.id, loc.name, in_item_id, line_in.item.name, in_quantity, out_quantity, expected, inventory_quantity, difference, inventory_item.created_at, inventory_item.updated_at]
- end
-
-
- # puts "#{org.id}, #{org.name}, #{loc.id}, #{loc.name}, #{in_item_id}, #{line_in.item.name}, #{in_quantity},#{out_quantity}, #{expected}, #{inventory_quantity},#{difference}"
-
- end
-
- end
- end
-
-end
-
-end
-
-def item_is_in_a_kit?(org, li)
- kits = Kit.where(organization: org)
- kits.each do |kit|
- items = kit.items
- items.each do |item|
- if item.id == li.item_id
- puts "item #{item.id} #{item.name} is in a kit"
- return true
- end
- end
- end
- false
-end
-
-def item_is_a_kit?(org, li)
- if(li.item.kit_id)
- puts "item #{li.item.id} #{li.item.name} is a kit"
- return true
- end
- false
-end
\ No newline at end of file
diff --git a/lib/tasks/initiate_reminder_deadline_job.rake b/lib/tasks/initiate_reminder_deadline_job.rake
deleted file mode 100644
index 45d3a10779..0000000000
--- a/lib/tasks/initiate_reminder_deadline_job.rake
+++ /dev/null
@@ -1,7 +0,0 @@
-desc "This task is called by the Heroku scheduler add-on to initiate the ReminderDeadlineJob periodically"
-task :initiate_reminder_deadline_job => :environment do
- puts "Initiating the Reminder Deadline job"
- ReminderDeadlineJob.perform_now
-
- puts "Done!"
-end
diff --git a/public/403.html b/public/403.html
index e3af451eb5..63ffb8baf6 100644
--- a/public/403.html
+++ b/public/403.html
@@ -1,66 +1,220 @@
-
+
- The page you were looking for is forbidden (403)
-
-
+
+
+
+
+