Tools¶

Administrative utilities and diagnostic tools for system management and troubleshooting.

The Tools module provides administrators with diagnostic and monitoring capabilities to maintain system health, track operations, manage background tasks, and troubleshoot issues.

Navigation: Admin → Tools

What You'll Access¶

🔍 Diagnostics

System health checks and diagnostic reports

💳 Payment Attempts

Failed/retry payment tracking and recovery

📧 POS Emails

Track sent emails and email status

✉️ Email Testing

Test email configuration and delivery

⏱️ Background Tasks

Job queue and scheduled task monitoring

🚀 Features

Feature flags and experimental features

📋 Recipes

System templates and configuration templates

Documents in This Section¶

🔍 Diagnostics

System health checks, diagnostic reports, connection testing, and performance metrics. Identify and troubleshoot system issues with detailed diagnostic data.

Read: Diagnostics →

💳 Payment Attempts

Track failed and retrying payment transactions. Review payment errors, retry failed payments, and monitor payment processing health.

Read: Payment Attempts →

📧 POS Emails

Monitor all emails sent from the POS system. Track delivery status, view sent emails, retry failed deliveries, and troubleshoot email issues.

Read: POS Emails →

✉️ Email Testing

Test email configuration and delivery. Send test emails to verify SMTP/Gmail/Office 365 setup works correctly before enabling production emails.

Read: Email Testing →

⏱️ Background Tasks

Monitor job queue and scheduled tasks. Track background job execution, view logs, retry failed jobs, and manage task scheduling.

Read: Background Tasks →

🚀 Features

Enable/disable feature flags and experimental features. Test new functionality before general release and control feature availability.

Read: Features →

📋 Recipes

System templates and configuration recipes for common scenarios. Quick setup templates for standard configurations and deployments.

Read: Recipes →

Common Tool Tasks¶

Troubleshooting System Issues¶

Check Diagnostics - Run diagnostic report
Review System Health - Connection and performance status
Check Email Status - If emails not working
Review Background Tasks - If jobs not running
Check Payment Attempts - If payments failing

Testing Configuration¶

Email Testing - Test SMTP/Gmail/Office 365
Send Test Payments - If available
Run Diagnostics - Verify system health
Check Logs - Background tasks and operations

Monitoring Operations¶

Payment Attempts - Monitor failed/retrying payments
POS Emails - Track email delivery
Background Tasks - Monitor scheduled jobs
Diagnostics - Regular health checks

Tool Access Permissions¶

Most tools require System Admin or Manager permissions:

Diagnostics - Admin/Manager (read-only)
Payment Attempts - Admin/Manager
POS Emails - Admin/Manager
Email Testing - Admin
Background Tasks - Admin (read-only mostly)
Features - Admin only
Recipes - Admin only

Best Practices¶

✅ Check diagnostics regularly
✅ Monitor payment attempts for failures
✅ Track email delivery status
✅ Test configuration before enabling
✅ Monitor background task execution
✅ Review feature flags before enabling
✅ Document any issues found
✅ Keep logs for troubleshooting
✅ Test new features in staging
✅ Monitor system health proactively

Tool Integration¶

Tools work together:

Email Issues → Use Email Testing to verify → Check POS Emails for status
Payment Issues → Review Payment Attempts → Check Diagnostics for connection issues
Job Failures → Monitor Background Tasks → Check Diagnostics for system issues
New Features → Enable in Features → Test in staging → Monitor performance