Debtbase User Guide

Comprehensive step-by-step guides for all Debtbase workflows and tasks.

Getting Started

First-Time Login

Prerequisite: You must have received an invitation email from your administrator.
  1. Claim Your Invitation
    • Click the link in your invitation email
    • You'll be redirected to the invitation claim page
    • Verify your email address is displayed correctly
  2. Create Your Account
    • Enter a secure password (minimum 8 characters)
    • Confirm your password
    • Read and accept the terms of service
    • Click "Create Account"
  3. Complete Your Profile
    • You'll be logged in automatically
    • Click your profile icon in the top right
    • Select "Settings"
    • Fill in your profile information: Full name, Phone number, Bio (optional), Profile photo (optional)
    • Click "Save Changes"
  4. Explore the Dashboard
    • You'll see the main dashboard with key statistics
    • Navigation sidebar on the left shows available sections
    • Your available sections depend on your assigned role

Job Management Workflows

Creating a New Job

Use Case: A new repossession has been assigned to your company.
  1. Navigate to Jobs
    • Click "Jobs" in the sidebar
    • Or press G then J (keyboard shortcut)
  2. Start New Job Creation
    • Click the "New Job" button in the top right
    • Or press C while on the jobs page
  3. Enter Job Information

    Basic Information:

    • Job Reference: Enter client's reference number or leave blank for auto-generation
    • Client: Select from dropdown (must exist first)
    • Agent: Assign to a field agent
    • Job Type: Select service type and location
    • Status: Usually "Pending" for new jobs

    Dates:

    • Assignment Date: When job was assigned (defaults to today)
    • Expected Completion: Target completion date (optional)

    Instructions:

    • Special Instructions: Any specific requirements or warnings
    • Client Notes: Information from the client
    • Internal Notes: Team communication
  4. Save the Job
    • Click "Create Job"
    • You'll be redirected to the job details page
    • Job reference will be displayed at the top
  5. Next Steps
    • Upload vehicle photos (if available)
    • Add first attendance record
    • Update status as work progresses

Recording a Site Visit (Attendance)

Use Case: Field agent visited the debtor's location.
  1. Open the Job
    • Navigate to Jobs
    • Click on the relevant job
    • Or search for job reference
  2. Add Attendance
    • Scroll to the "Attendances" section
    • Click "Add Attendance"
  3. Enter Attendance Details
    • Date & Time: When the visit occurred
    • Attendance Type: Select from dropdown (Initial Visit, Follow-up, Final Attempt, Surveillance)
    • Attendance Result: What happened (Vehicle Found, Vehicle Recovered, Not Home, Wrong Address, Payment Arranged)
    • Notes: Detailed description of the visit
  4. Save Attendance
    • Click "Add Attendance"
    • Attendance will appear in the timeline
    • Most recent attendance shown first
  5. Update Job Status
    • If status changed (e.g., vehicle recovered), click "Edit Job"
    • Update Status to "Completed"
    • Set Result to "Vehicle Recovered"
    • Update completion date
    • Click "Save Changes"

Uploading Vehicle Photos

Use Case: Document vehicle condition at time of recovery.
  1. Navigate to Job Files
    • Open the relevant job
    • Click the "Files" tab
    • Or click "Upload Files" button
  2. Select Files to Upload
    • Click "Choose Files" or drag files into upload area
    • Select multiple photos at once
    • Supported formats: JPG, PNG, PDF
  3. Categorize Each Photo
    • Vehicle Front, Vehicle Rear, Driver Side, Passenger Side, VIN Plate, Odometer, Damage Closeup
  4. Add Descriptions (Optional)
    • Describe what's shown in the photo
    • Note any damage or special conditions
    • Reference attendance or date
  5. Upload Files
    • Click "Upload All"
    • Progress bar shows upload status
    • Files appear in job files list when complete
  6. Verify Upload
    • Click on a photo to preview
    • Verify correct category assignment
    • Edit description if needed

Managing Chattels (Personal Property)

Use Case: Vehicle contains personal belongings that must be inventoried.
  1. Access Chattel Management
    • Open the relevant job
    • Navigate to "Chattels" section
    • Click "Add Chattel"
  2. Describe the Item
    • Item Description: Detailed description
    • Quantity: Number of items
    • Estimated Value: Approximate value in dollars
    • Condition: New, Used, Damaged, etc.
  3. Photograph the Item
    • Take clear photos of the chattel
    • Include any identifying marks
    • Show overall condition
  4. Upload Chattel Photos
    • Click "Add Photos"
    • Select photos from device
    • Photos automatically linked to chattel item
  5. Save Chattel Record
    • Click "Save Chattel"
    • Item appears in chattels list
    • Repeat for additional items
  6. Generate Chattel Inventory
    • Click "Print Inventory" (future feature)
    • Complete list for legal notification
    • Provide to debtor per legal requirements

Completing a Job

Use Case: Job has reached final resolution.
  1. Verify All Documentation
    • All attendances recorded
    • Vehicle photos uploaded
    • Chattels inventoried
    • Client notifications sent
    • All dates filled in
  2. Update Job Details
    • Click "Edit Job"
    • Set Status to "Completed"
    • Set Result: Vehicle Recovered, Payment Arranged, Unable to Locate, Other resolution
    • Enter Completion Date
    • Enter delivery destination (if applicable)
  3. Add Final Notes
    • Summary of outcome
    • Any issues encountered
    • Client satisfaction
    • Recommendations for similar jobs
  4. Mark for Invoicing (if applicable)
    • Check "Ready for Invoice"
    • Verify all billable items documented
    • Add invoice notes if needed
  5. Save Completed Job
    • Click "Save Changes"
    • Job moves to completed jobs list
    • Generates final timeline
  6. Generate Reports (if needed)
    • Export job details
    • Print job summary
    • Send to client

Client Management Workflows

Adding a New Client

Use Case: Your company starts working with a new client.
  1. Navigate to Clients
    • Click "Clients" in sidebar
    • Or press G then C
  2. Create New Client
    • Click "New Client" button
    • Or press C
  3. Enter Client Information

    Basic Details: Client Name, Client Reference, ACL Number

    Contact Information: Primary Contact Name, Phone Number, Email Address, Fax Number

    Address: Street Address, City, State, ZIP, Country

    Billing Address (if different): Check "Different Billing Address" and enter billing address details

    Preferences: Invoicing Frequency, Invoice Delivery Method, Payment Terms, Special Instructions

  4. Upload Client Documents (Optional)
    • Master service agreement
    • Rate sheet
    • Special handling procedures
    • Insurance certificates
  5. Save Client
    • Click "Create Client"
    • Client appears in clients list
    • Can now be selected when creating jobs

Updating Client Information

Use Case: Client changes contact information or preferences.
  1. Locate the Client
    • Navigate to Clients
    • Search for client name or reference
    • Click on client to view details
  2. Edit Client Information
    • Click "Edit Client" button
    • Or press E
  3. Make Changes
    • Update any fields that changed
    • Add notes about why information changed
    • Update "Last Verified" date
  4. Save Changes
    • Click "Save Changes"
    • Changes logged in audit trail
    • Client record updated

Viewing Client Job History

Use Case: Review all jobs for a specific client.
  1. Open Client Details
    • Navigate to Clients
    • Click on the client
  2. View Associated Jobs
    • Scroll to "Jobs" section
    • See all jobs for this client
    • Sorted by most recent first
  3. Filter Jobs
    • Filter by Status (Active, Completed, On Hold)
    • Filter by Date Range
    • Search by job reference
  4. View Job Details
    • Click any job to see full details
    • Use back button to return to client
  5. Generate Client Reports
    • Click "Export Client Jobs"
    • Select date range
    • Choose format (CSV, Excel)
    • Download report

Agent Management Workflows

Adding a New Agent

Use Case: Hiring a new field agent.
  1. Navigate to Agents
    • Click "Agents" in sidebar
    • Or press G then A
  2. Create New Agent
    • Click "New Agent" button
  3. Enter Agent Information

    Personal Details: Full Name, Agent Reference/ID, Phone Number, Email Address, Physical Address

    Employment: Employment Status, Start Date, Employment Type

    Emergency Contact: Emergency Contact Name, Phone, Relationship

  4. Add Licensing Information
    • License Type, License Number, Issuing State/Authority, Issue Date, Expiration Date, Upload license copy
  5. Upload Agent Documents
    • Professional license, Insurance certificate, Background check, Training certifications, Signed agreement
  6. Save Agent
    • Click "Create Agent"
    • Agent available for job assignment

Tracking License Expiration

Use Case: Ensure all agents maintain current licenses.
  1. View All Agents
    • Navigate to Agents
    • Look for expiration warnings (red badges)
  2. Check License Status
    • Click on agent with expiring license
    • View license expiration date
    • Note renewal requirements
  3. Request Renewal
    • Send renewal reminder to agent
    • Set follow-up date
    • Add note to agent record
  4. Update License Information
    • When new license received, click "Edit Agent"
    • Update license information
    • Upload new license copy
    • Remove expiration warning
  5. Generate License Report
    • Click "Reports" → "Agent Licenses"
    • Filter by expiration date
    • Export list of upcoming expirations
    • Plan proactive renewals

Assigning Jobs to Agents

Use Case: Distribute work among field agents.
  1. Review Agent Availability
    • Navigate to Agents
    • Check current assignments
    • View geographic coverage
  2. Create or Edit Job
    • Go to Jobs → New Job (or edit existing)
    • In "Agent" field, select appropriate agent
    • Consider: Agent location vs job location, Agent availability, Agent specialties, Current workload
  3. Notify Agent
    • System sends automatic notification (future)
    • Or manually notify agent via phone/email
    • Provide job reference and details
  4. Monitor Progress
    • Check agent's active jobs
    • Review attendance records
    • Follow up on overdue assignments

File Management Workflows

Uploading Multiple Files

Use Case: Bulk upload documentation for multiple jobs.
  1. Navigate to File Upload
    • Click "Files" in sidebar
    • Click "Upload Files" button
    • Or press G then F
  2. Select Files
    • Click "Choose Files" or drag files
    • Select multiple files at once
    • Can select up to 20 files simultaneously
  3. Configure Upload
    • For each file: Select Category, Choose Entity Type, Select specific entity, Add description
  4. Bulk Settings (Optional)
    • If all files same category: Set category once, Apply to all files
    • If all for same entity: Set entity once, Apply to all files
  5. Upload All Files
    • Review file list
    • Click "Upload All"
    • Monitor progress
    • Wait for confirmation
  6. Verify Uploads
    • Check file browser
    • Verify correct categorization
    • Verify correct entity linking

Finding a Specific File

Use Case: Locate a document uploaded weeks ago.
  1. Access File Browser
    • Click "Files" in sidebar
  2. Use Search
    • Enter filename or partial name
    • Or search by description
    • Results update as you type
  3. Filter Results
    • Filter by Category, Entity Type, Upload Date, Uploaded By
  4. Narrow Results
    • Combine multiple filters
    • Sort by date, name, or size
    • Use advanced search (future)
  5. Open File
    • Click on file to preview
    • Click "Download" to save locally
    • Click "View Details" for metadata

Organizing Files by Category

Use Case: Ensure all files properly categorized for easy retrieval.
  1. Review Uncategorized Files
    • Navigate to Files
    • Filter by "Uncategorized" or "General Documents"
    • Review list of files needing categorization
  2. Recategorize Files
    • Click on file, Click "Edit Details", Select appropriate category, Add description if missing, Save changes
  3. Bulk Categorization
    • Select multiple files (checkbox)
    • Click "Bulk Actions"
    • Choose "Set Category"
    • Select category, Apply to all selected
  4. Verify Organization
    • Browse by category
    • Check each category has appropriate files
    • Review entity links
    • Ensure no orphaned files

Security Administration

Managing IP Access Control

Use Case: Restrict or allow access from specific IP addresses.
Prerequisite: Must have security.manage permission (Super Admin only).
  1. Access Security Settings
    • Click "Security" in sidebar
    • Select "Access Control List" tab
  2. Add IP to Blacklist
    • Click "Add to Blacklist"
    • Enter IP address or CIDR range
    • Add reason: "Suspicious activity detected"
    • Set expiration (optional)
    • Click "Add to Blacklist"
  3. Add IP to Admin Whitelist
    • Click "Admin Whitelist" tab
    • Click "Add IP"
    • Enter IP address or CIDR range
    • Add description: "Office network"
    • Click "Add to Whitelist"
  4. Enable Whitelist Enforcement
    • Toggle "Enforce Admin Whitelist"
    • Warning: Admin panel only accessible from whitelisted IPs
    • Ensure your current IP is whitelisted first!
  5. Test Access Control
    • Verify blacklisted IPs cannot access
    • Verify whitelisted IPs can access admin
    • Document changes in audit log

Managing User Sessions

Use Case: Force logout a compromised account or clear all sessions.
Prerequisite: Must have security.manage permission (Super Admin only).
  1. View Active Sessions
    • Navigate to Security → Sessions
    • See all logged-in users
    • Filter by activity window
  2. Identify Session to Terminate
    • Review user list, Check IP addresses, Look for suspicious patterns
  3. Force Single User Logout
    • Click on user in session list
    • Click "Kill Session"
    • Confirm action
    • Enter reason: "Account compromise suspected"
    • User immediately logged out
  4. Global Kill Switch (Emergency)
    • Click "Kill All Sessions"
    • Confirm action (requires re-confirmation)
    • Enter reason: "Security incident"
    • All users logged out immediately
    • Only super admins can log back in
  5. Review Login Log
    • Navigate to Security → Login Log
    • Review who was logged out
    • Check for re-login attempts
    • Monitor for continued suspicious activity

Reviewing Audit Logs

Use Case: Investigate security-related changes or compliance audit.
  1. Access Audit Log
    • Navigate to Security → Audit Log
  2. Filter by Date Range
    • Select start date, Select end date, Click "Apply Filter"
  3. Filter by User
    • Select user from dropdown
    • See all actions by that user
  4. Filter by Action Type
    • Select action type: Role Created/Updated/Deleted, Permission Granted/Revoked, User Role Assigned/Revoked, IP Added/Removed, Session Terminated, Configuration Changed
  5. Review Audit Details
    • Click on any audit entry
    • See full details: Who performed action, What changed, When it occurred, Why, IP address and device
  6. Export Audit Log
    • Click "Export"
    • Select date range
    • Choose format (CSV, Excel, PDF)
    • Save for compliance records

User Management

Inviting a New User

Use Case: Add a new employee to the system.
Prerequisite: Must have security.manage permission (Super Admin only).
  1. Navigate to User Management
    • Click "User Management" in sidebar
    • Select "Invitations" tab
  2. Create New Invitation
    • Click "Invite User"
    • Enter email address
    • Verify email is correct
  3. Assign Role
    • Select role from dropdown: Super Admin, Admin, Supervisor, Agent, Viewer, Client Manager
  4. Set Expiration (Optional)
    • Default: 30 days
    • Adjust if needed
    • Leave blank for no expiration
  5. Add Note (Optional)
    • Why user is being invited, Department or team, Start date
  6. Send Invitation
    • Click "Send Invitation"
    • Invitation email sent immediately
    • Invitation appears in "Pending" list
  7. Track Invitation Status
    • Check "Pending Invitations" list
    • See when invitation was sent, if claimed
    • Resend if needed
    • Cancel if user no longer joining

Assigning Roles to Existing Users

Use Case: Promote user or change their access level.
  1. Navigate to User Management
    • Click "User Management"
    • Select "User Roles" tab
  2. Find the User
    • Search for user by name or email
    • Click on user to view details
  3. View Current Roles
    • See all roles currently assigned
    • Review effective permissions
  4. Assign Additional Role
    • Click "Assign Role"
    • Select role from dropdown
    • Add scope (optional, JSON format)
    • Add reason: "Promotion to supervisor"
    • Click "Assign"
  5. Remove Role
    • Find role in user's role list
    • Click "Remove"
    • Confirm action
    • Add reason: "Role no longer needed"
  6. Verify Changes
    • Check user's effective permissions
    • Test user can access expected features
    • Review audit log entry

Managing Permission Overrides

Use Case: Grant or deny specific permission to a user regardless of role.
  1. Navigate to User Management
    • Select "Permission Overrides" tab
  2. Find User
    • Search for user
    • Click to view current overrides
  3. Grant Permission Override
    • Click "Grant Permission"
    • Select permission from list
    • Add reason: "Temporary access for project"
    • Set expiration (optional)
    • Click "Grant"
  4. Deny Permission Override
    • Click "Deny Permission"
    • Select permission from list
    • Add reason: "Restrict deletion capability"
    • Click "Deny"
  5. Review All Overrides
    • See list of all overrides for user
    • Green = Granted override, Red = Denied override
    • Review expiration dates
  6. Remove Override
    • Click "Remove" next to override
    • Confirm action
    • Add reason
    • User reverts to role-based permissions

Reports & Analytics

Generating a Job Report

Use Case: Create summary of all jobs for a specific time period.
  1. Navigate to Dashboard
    • Click "Dashboard" in sidebar
    • Or press G then D
  2. Select Report Type
    • Click "Reports" → "Job Report"
  3. Configure Report Parameters
    • Date Range: This Week, This Month, Last Month, Custom Range
    • Filters: Status, Result, Client, Agent
  4. Preview Report
    • Click "Preview"
    • Review data in table format
    • Verify filters applied correctly
  5. Customize Columns (Optional)
    • Click "Customize Columns"
    • Select which fields to include
    • Reorder columns by dragging
  6. Export Report
    • Click "Export"
    • Choose format: CSV, Excel, PDF
    • Download begins automatically
  7. Save Report Template (Future)
    • Click "Save Template"
    • Name template: "Monthly Client Report"
    • Use template for future reports

Viewing Dashboard Statistics

Use Case: Quick overview of current operations.
  1. Access Dashboard
    • Log in to Debtbase
    • Dashboard loads automatically
    • Or click "Dashboard" in sidebar
  2. Review Key Metrics
    • Total Jobs, Active Jobs, Completed This Month, Total Clients, Active Agents, Files Uploaded, Storage Used
  3. View Recent Activity
    • Recent job updates, Recent file uploads, Recent user actions
    • Click any item to view details
  4. Check Trends
    • Job completion rate graph, Jobs by status pie chart, Activity over time line graph
    • Compare to previous periods
  5. Quick Actions
    • Create new job, Upload files, Search jobs
    • All accessible from dashboard

Personal Settings

Updating Your Profile

Use Case: Keep your contact information current.
  1. Access Settings
    • Click profile icon (top right)
    • Select "Settings"
    • Or press G then S
  2. Update Profile Information
    • Full Name, Phone Number, Bio/Description
    • Click "Save Changes"
  3. Change Profile Photo
    • Click "Upload Photo"
    • Select image file (JPG, PNG)
    • Crop if needed, Click "Save"
    • Photo appears in header
  4. Update Email Address
    • Enter new email, Confirm new email
    • Verification email sent
    • Click link in email to confirm
    • Email updated after confirmation

Changing Your Password

Use Case: Regular password rotation for security.
  1. Navigate to Settings
    • Click profile icon → Settings
    • Select "Security" tab
  2. Change Password
    • Enter current password
    • Enter new password
    • Confirm new password
    • Password requirements: Minimum 8 characters, At least one uppercase letter, At least one number, At least one special character
  3. Save New Password
    • Click "Change Password"
    • You'll be logged out
    • Log in with new password
  4. Update Password Manager
    • Save new password in your password manager
    • Verify you can log in

Switching Themes

Use Case: Prefer dark mode for evening work or light mode for daytime.
  1. Quick Theme Toggle
    • Click sun/moon icon in header
    • Theme switches immediately
    • Preference saved automatically
  2. Theme Settings
    • Navigate to Settings → Appearance
    • Select theme: Light Mode, Dark Mode, Auto (follows system preference)
    • Click "Save"
  3. Verify Theme
    • Check all pages render correctly
    • Report any display issues to admin

Troubleshooting

Cannot Log In

Problem: Login page shows "Invalid credentials"

Solutions:

  1. Verify email address is correct
  2. Check caps lock is off
  3. Reset password: Click "Forgot Password", Enter email, Follow reset link in email
  4. Contact administrator if account may be deactivated

Missing Permissions

Problem: Cannot see expected menu items or buttons

Solutions:

  1. Check your assigned role
  2. Contact administrator to request permission
  3. Review your effective permissions in Settings
  4. Verify you're logged in with correct account

File Upload Fails

Problem: File upload shows error or hangs

Solutions:

  1. Check file size (max 50MB)
  2. Check file type is supported
  3. Check internet connection
  4. Try again with different browser
  5. Contact administrator if problem persists

Cannot Find Job/Client/Agent

Problem: Search returns no results

Solutions:

  1. Check spelling
  2. Try partial search (first few characters)
  3. Check filters are not too restrictive
  4. Browse full list instead of searching
  5. Verify entity exists (may be deleted)

Tips & Best Practices

Job Management

  • Always photograph vehicle before moving
  • Document everything in notes
  • Update job status immediately after changes
  • Use consistent naming for job references
  • Complete chattels inventory before release

File Management

  • Use descriptive filenames before uploading
  • Categorize files immediately upon upload
  • Take high-quality photos (well-lit, in focus)
  • Include VIN in all vehicle photo sets
  • Regular file cleanup (delete duplicates)

Security

  • Use strong, unique passwords
  • Never share login credentials
  • Log out when leaving workstation
  • Report suspicious activity immediately
  • Review your login history periodically

Efficiency

  • Learn keyboard shortcuts
  • Use filters to find information faster
  • Set up common templates (future)
  • Batch similar tasks together
  • Keep profile information current

For feature details, see Features Guide.
For technical information, see Architecture Documentation.
Last Updated: January 2026