Skip to content

Veteran CRM

Sunghyoun Kim edited this page May 14, 2022 · 4 revisions

Overview

The Veteran Info CRM allows admins to view and manage Veterans in their chapter and superadmins to manage all veterans. This is the primary source of individual veteran information for admins.

Backend

In the database, the tables that are directly accessed and modified by the APIs, and stores relevant information are: client_users and UserInfo.

  • client_users Table: Types of information specific to veterans include name, email, role_id and chapter_id. The role_id dictates the level of privilege that the user has (0: veteran, 1: admin, 2: superadmin). Since the Veteran CRM only views veterans, the rows will only be populated by users with role_id 0. The role_id is also relevant in determining the views that the admin will have. Admins of role_id 1 will only be able to access veterans with the same chapter_id, while superadmins of role_id 2, will be able to access all veterans regardless of which chapter they are in.
  • UserInfo Table: Types of information specific to volunteers include applicant_phone, curr_level, demographic, income, referral and outgoing. The curr_level column is the level of the veterans ranging from 1-4. The referral and outgoing columns represent the incoming and outgoing referral of the veteran. When updating, the referrals are chosen from a selection of partners from the partners database.

Functionality

The functionality of the CRM include creating or adding, updating, and deleting veterans, querying veterans based on keywords on relevant attributes, and downloading the queried results as a CSV file.

Frontend

Search filtering

The Veteran CRM offers many ways to filter the veterans. To search for veterans who's attribute matches a certain criteria, use the selection tab on the left of the search bar to select a specific attribute, then type a keyword and press enter to create a search filter. It will appear underneath the search bar. You may combine search filters to narrow down your selection. However, you may not use multiple search filters on the same attribute. You may notice also that clicking on 3 dots on the column header and selecting the filter option gives you the ability to filter the crm. However, this is not recommended as the CRM uses server-side loading and this method will only filter the rows which have already been loaded.

Pagination

The Veteran CRM has pagination options of 5, 10, and 25. You may select this option in the CRM toolbar. To navigate the pages, use the arrows next to the page indicator.

Veteran Creation

To create a new veteran, click on the Create Veteran button on the left of your CRM toolbar. In the popup, you may specify the name and email of the new veteran. After creation, an sign up email is sent to the given email to create an account for the veteran. In addition, a new row will be created representing the veteran. The information of this veteran may be edited, however, it will be overwritten by the veteran upon sign up.

Veteran Deletion

To delete veterans, select the veterans by clicking on the checkboxes on the left, then click the Delete Veterans button on the right of your CRM. A confirmation popup will list the relevant veterans. Deleting a veteran will delete all related data.

Updating data

To update a value, enter edit mode on a cell by double-clicking or pressing enter while selecting a cell. Enter the desired the value, and the press enter or click away to exit edit mode. Each column has a unique validation parameter such as a valid email, numeric values, a valid phone number etc. Violating this validation parameter will result in an error message and failure to update. Once the desired changes have been made, press the Apply changes button on the top of your CRM toolbar to persist the changes.

WARNING

Updating the chapter of a veteran as a chapter admin will result in the veteran being sent to another chapter, and thus no longer appearing in your CRM.

Exporting Data

To export data as a csv, click the Export as csv button on the right of your CRM toolbar. Keep in mind that the exported data not only includes the data that appears on your CRM, but all veterans based on your current search filters.