Debtbase User Guide
Comprehensive step-by-step guides for all Debtbase workflows and tasks.
Quick Navigation
Getting Started
First-Time Login
- 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
- Create Your Account
- Enter a secure password (minimum 8 characters)
- Confirm your password
- Read and accept the terms of service
- Click "Create Account"
- 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"
- 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
- Navigate to Jobs
- Click "Jobs" in the sidebar
- Or press
GthenJ(keyboard shortcut)
- Start New Job Creation
- Click the "New Job" button in the top right
- Or press
Cwhile on the jobs page
- 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
- Save the Job
- Click "Create Job"
- You'll be redirected to the job details page
- Job reference will be displayed at the top
- Next Steps
- Upload vehicle photos (if available)
- Add first attendance record
- Update status as work progresses
Recording a Site Visit (Attendance)
- Open the Job
- Navigate to Jobs
- Click on the relevant job
- Or search for job reference
- Add Attendance
- Scroll to the "Attendances" section
- Click "Add Attendance"
- 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
- Save Attendance
- Click "Add Attendance"
- Attendance will appear in the timeline
- Most recent attendance shown first
- 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
- Navigate to Job Files
- Open the relevant job
- Click the "Files" tab
- Or click "Upload Files" button
- Select Files to Upload
- Click "Choose Files" or drag files into upload area
- Select multiple photos at once
- Supported formats: JPG, PNG, PDF
- Categorize Each Photo
- Vehicle Front, Vehicle Rear, Driver Side, Passenger Side, VIN Plate, Odometer, Damage Closeup
- Add Descriptions (Optional)
- Describe what's shown in the photo
- Note any damage or special conditions
- Reference attendance or date
- Upload Files
- Click "Upload All"
- Progress bar shows upload status
- Files appear in job files list when complete
- Verify Upload
- Click on a photo to preview
- Verify correct category assignment
- Edit description if needed
Managing Chattels (Personal Property)
- Access Chattel Management
- Open the relevant job
- Navigate to "Chattels" section
- Click "Add Chattel"
- Describe the Item
- Item Description: Detailed description
- Quantity: Number of items
- Estimated Value: Approximate value in dollars
- Condition: New, Used, Damaged, etc.
- Photograph the Item
- Take clear photos of the chattel
- Include any identifying marks
- Show overall condition
- Upload Chattel Photos
- Click "Add Photos"
- Select photos from device
- Photos automatically linked to chattel item
- Save Chattel Record
- Click "Save Chattel"
- Item appears in chattels list
- Repeat for additional items
- Generate Chattel Inventory
- Click "Print Inventory" (future feature)
- Complete list for legal notification
- Provide to debtor per legal requirements
Completing a Job
- Verify All Documentation
- All attendances recorded
- Vehicle photos uploaded
- Chattels inventoried
- Client notifications sent
- All dates filled in
- 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)
- Add Final Notes
- Summary of outcome
- Any issues encountered
- Client satisfaction
- Recommendations for similar jobs
- Mark for Invoicing (if applicable)
- Check "Ready for Invoice"
- Verify all billable items documented
- Add invoice notes if needed
- Save Completed Job
- Click "Save Changes"
- Job moves to completed jobs list
- Generates final timeline
- Generate Reports (if needed)
- Export job details
- Print job summary
- Send to client
Client Management Workflows
Adding a New Client
- Navigate to Clients
- Click "Clients" in sidebar
- Or press
GthenC
- Create New Client
- Click "New Client" button
- Or press
C
- 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
- Upload Client Documents (Optional)
- Master service agreement
- Rate sheet
- Special handling procedures
- Insurance certificates
- Save Client
- Click "Create Client"
- Client appears in clients list
- Can now be selected when creating jobs
Updating Client Information
- Locate the Client
- Navigate to Clients
- Search for client name or reference
- Click on client to view details
- Edit Client Information
- Click "Edit Client" button
- Or press
E
- Make Changes
- Update any fields that changed
- Add notes about why information changed
- Update "Last Verified" date
- Save Changes
- Click "Save Changes"
- Changes logged in audit trail
- Client record updated
Viewing Client Job History
- Open Client Details
- Navigate to Clients
- Click on the client
- View Associated Jobs
- Scroll to "Jobs" section
- See all jobs for this client
- Sorted by most recent first
- Filter Jobs
- Filter by Status (Active, Completed, On Hold)
- Filter by Date Range
- Search by job reference
- View Job Details
- Click any job to see full details
- Use back button to return to client
- Generate Client Reports
- Click "Export Client Jobs"
- Select date range
- Choose format (CSV, Excel)
- Download report
Agent Management Workflows
Adding a New Agent
- Navigate to Agents
- Click "Agents" in sidebar
- Or press
GthenA
- Create New Agent
- Click "New Agent" button
- 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
- Add Licensing Information
- License Type, License Number, Issuing State/Authority, Issue Date, Expiration Date, Upload license copy
- Upload Agent Documents
- Professional license, Insurance certificate, Background check, Training certifications, Signed agreement
- Save Agent
- Click "Create Agent"
- Agent available for job assignment
Tracking License Expiration
- View All Agents
- Navigate to Agents
- Look for expiration warnings (red badges)
- Check License Status
- Click on agent with expiring license
- View license expiration date
- Note renewal requirements
- Request Renewal
- Send renewal reminder to agent
- Set follow-up date
- Add note to agent record
- Update License Information
- When new license received, click "Edit Agent"
- Update license information
- Upload new license copy
- Remove expiration warning
- Generate License Report
- Click "Reports" → "Agent Licenses"
- Filter by expiration date
- Export list of upcoming expirations
- Plan proactive renewals
Assigning Jobs to Agents
- Review Agent Availability
- Navigate to Agents
- Check current assignments
- View geographic coverage
- 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
- Notify Agent
- System sends automatic notification (future)
- Or manually notify agent via phone/email
- Provide job reference and details
- Monitor Progress
- Check agent's active jobs
- Review attendance records
- Follow up on overdue assignments
File Management Workflows
Uploading Multiple Files
- Navigate to File Upload
- Click "Files" in sidebar
- Click "Upload Files" button
- Or press
GthenF
- Select Files
- Click "Choose Files" or drag files
- Select multiple files at once
- Can select up to 20 files simultaneously
- Configure Upload
- For each file: Select Category, Choose Entity Type, Select specific entity, Add description
- 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
- Upload All Files
- Review file list
- Click "Upload All"
- Monitor progress
- Wait for confirmation
- Verify Uploads
- Check file browser
- Verify correct categorization
- Verify correct entity linking
Finding a Specific File
- Access File Browser
- Click "Files" in sidebar
- Use Search
- Enter filename or partial name
- Or search by description
- Results update as you type
- Filter Results
- Filter by Category, Entity Type, Upload Date, Uploaded By
- Narrow Results
- Combine multiple filters
- Sort by date, name, or size
- Use advanced search (future)
- Open File
- Click on file to preview
- Click "Download" to save locally
- Click "View Details" for metadata
Organizing Files by Category
- Review Uncategorized Files
- Navigate to Files
- Filter by "Uncategorized" or "General Documents"
- Review list of files needing categorization
- Recategorize Files
- Click on file, Click "Edit Details", Select appropriate category, Add description if missing, Save changes
- Bulk Categorization
- Select multiple files (checkbox)
- Click "Bulk Actions"
- Choose "Set Category"
- Select category, Apply to all selected
- Verify Organization
- Browse by category
- Check each category has appropriate files
- Review entity links
- Ensure no orphaned files
Security Administration
Managing IP Access Control
security.manage permission (Super Admin only).- Access Security Settings
- Click "Security" in sidebar
- Select "Access Control List" tab
- 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"
- 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"
- Enable Whitelist Enforcement
- Toggle "Enforce Admin Whitelist"
- Warning: Admin panel only accessible from whitelisted IPs
- Ensure your current IP is whitelisted first!
- Test Access Control
- Verify blacklisted IPs cannot access
- Verify whitelisted IPs can access admin
- Document changes in audit log
Managing User Sessions
security.manage permission (Super Admin only).- View Active Sessions
- Navigate to Security → Sessions
- See all logged-in users
- Filter by activity window
- Identify Session to Terminate
- Review user list, Check IP addresses, Look for suspicious patterns
- Force Single User Logout
- Click on user in session list
- Click "Kill Session"
- Confirm action
- Enter reason: "Account compromise suspected"
- User immediately logged out
- 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
- 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
- Access Audit Log
- Navigate to Security → Audit Log
- Filter by Date Range
- Select start date, Select end date, Click "Apply Filter"
- Filter by User
- Select user from dropdown
- See all actions by that user
- 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
- Review Audit Details
- Click on any audit entry
- See full details: Who performed action, What changed, When it occurred, Why, IP address and device
- Export Audit Log
- Click "Export"
- Select date range
- Choose format (CSV, Excel, PDF)
- Save for compliance records
User Management
Inviting a New User
security.manage permission (Super Admin only).- Navigate to User Management
- Click "User Management" in sidebar
- Select "Invitations" tab
- Create New Invitation
- Click "Invite User"
- Enter email address
- Verify email is correct
- Assign Role
- Select role from dropdown: Super Admin, Admin, Supervisor, Agent, Viewer, Client Manager
- Set Expiration (Optional)
- Default: 30 days
- Adjust if needed
- Leave blank for no expiration
- Add Note (Optional)
- Why user is being invited, Department or team, Start date
- Send Invitation
- Click "Send Invitation"
- Invitation email sent immediately
- Invitation appears in "Pending" list
- 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
- Navigate to User Management
- Click "User Management"
- Select "User Roles" tab
- Find the User
- Search for user by name or email
- Click on user to view details
- View Current Roles
- See all roles currently assigned
- Review effective permissions
- Assign Additional Role
- Click "Assign Role"
- Select role from dropdown
- Add scope (optional, JSON format)
- Add reason: "Promotion to supervisor"
- Click "Assign"
- Remove Role
- Find role in user's role list
- Click "Remove"
- Confirm action
- Add reason: "Role no longer needed"
- Verify Changes
- Check user's effective permissions
- Test user can access expected features
- Review audit log entry
Managing Permission Overrides
- Navigate to User Management
- Select "Permission Overrides" tab
- Find User
- Search for user
- Click to view current overrides
- Grant Permission Override
- Click "Grant Permission"
- Select permission from list
- Add reason: "Temporary access for project"
- Set expiration (optional)
- Click "Grant"
- Deny Permission Override
- Click "Deny Permission"
- Select permission from list
- Add reason: "Restrict deletion capability"
- Click "Deny"
- Review All Overrides
- See list of all overrides for user
- Green = Granted override, Red = Denied override
- Review expiration dates
- Remove Override
- Click "Remove" next to override
- Confirm action
- Add reason
- User reverts to role-based permissions
Reports & Analytics
Generating a Job Report
- Navigate to Dashboard
- Click "Dashboard" in sidebar
- Or press
GthenD
- Select Report Type
- Click "Reports" → "Job Report"
- Configure Report Parameters
- Date Range: This Week, This Month, Last Month, Custom Range
- Filters: Status, Result, Client, Agent
- Preview Report
- Click "Preview"
- Review data in table format
- Verify filters applied correctly
- Customize Columns (Optional)
- Click "Customize Columns"
- Select which fields to include
- Reorder columns by dragging
- Export Report
- Click "Export"
- Choose format: CSV, Excel, PDF
- Download begins automatically
- Save Report Template (Future)
- Click "Save Template"
- Name template: "Monthly Client Report"
- Use template for future reports
Viewing Dashboard Statistics
- Access Dashboard
- Log in to Debtbase
- Dashboard loads automatically
- Or click "Dashboard" in sidebar
- Review Key Metrics
- Total Jobs, Active Jobs, Completed This Month, Total Clients, Active Agents, Files Uploaded, Storage Used
- View Recent Activity
- Recent job updates, Recent file uploads, Recent user actions
- Click any item to view details
- Check Trends
- Job completion rate graph, Jobs by status pie chart, Activity over time line graph
- Compare to previous periods
- Quick Actions
- Create new job, Upload files, Search jobs
- All accessible from dashboard
Personal Settings
Updating Your Profile
- Access Settings
- Click profile icon (top right)
- Select "Settings"
- Or press
GthenS
- Update Profile Information
- Full Name, Phone Number, Bio/Description
- Click "Save Changes"
- Change Profile Photo
- Click "Upload Photo"
- Select image file (JPG, PNG)
- Crop if needed, Click "Save"
- Photo appears in header
- 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
- Navigate to Settings
- Click profile icon → Settings
- Select "Security" tab
- 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
- Save New Password
- Click "Change Password"
- You'll be logged out
- Log in with new password
- Update Password Manager
- Save new password in your password manager
- Verify you can log in
Switching Themes
- Quick Theme Toggle
- Click sun/moon icon in header
- Theme switches immediately
- Preference saved automatically
- Theme Settings
- Navigate to Settings → Appearance
- Select theme: Light Mode, Dark Mode, Auto (follows system preference)
- Click "Save"
- Verify Theme
- Check all pages render correctly
- Report any display issues to admin
Troubleshooting
Cannot Log In
Problem: Login page shows "Invalid credentials"
Solutions:
- Verify email address is correct
- Check caps lock is off
- Reset password: Click "Forgot Password", Enter email, Follow reset link in email
- Contact administrator if account may be deactivated
Missing Permissions
Problem: Cannot see expected menu items or buttons
Solutions:
- Check your assigned role
- Contact administrator to request permission
- Review your effective permissions in Settings
- Verify you're logged in with correct account
File Upload Fails
Problem: File upload shows error or hangs
Solutions:
- Check file size (max 50MB)
- Check file type is supported
- Check internet connection
- Try again with different browser
- Contact administrator if problem persists
Cannot Find Job/Client/Agent
Problem: Search returns no results
Solutions:
- Check spelling
- Try partial search (first few characters)
- Check filters are not too restrictive
- Browse full list instead of searching
- 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