System Cleanup Module Documentation
Table of Contents
- Module Overview (Technical)
- Module Overview (Commercial/Business)
- Module Overview (End User/Administrator)
- Configuration Sections
- Settings Reference
- Common Scenarios & Examples
- Limitations & Important Notes
- Troubleshooting Tips
- Glossary
---
1. Module Overview (Technical)
What Is System Cleanup?
System Cleanup is a maintenance module that automatically removes old system files and data to free up storage space. It supports per-tenant configuration for CDR, recordings, voicemails, SMS, and log events.
Architecture
Key Tables
| Table | Purpose |
|---|---|
public.cleanup_settings | Per-tenant config |
Key Files
| File | Description |
|---|---|
modules/systemCleanup/ | Frontend module |
2. Module Overview (Commercial/Business)
Business Value
System Cleanup provides automated storage management:
| Without Cleanup | With Cleanup | |
|---|---|---|
| Storage fills up | Auto-managed | |
| Manual deletion | Scheduled jobs | |
| Compliance risk | Retention policies | |
| Server slowdown | Optimized storage |
Use Cases
- Storage Management
- Automated cleanup
- Compliance
- Data lifecycle
- Cost Control
- Optimize space
- Performance
- Less I/O load
Feature Highlights
| Feature | Benefit | |
|---|---|---|
| Per-Tenant | Individual policies | |
| Multiple Types | CDR, recordings, etc. | |
| Schedule | Daily/weekly/monthly | |
| Short Recordings | Remove useless files | |
| Audio Conversion | Save space | |
| Execute Now | Manual trigger |
3. Module Overview (End User/Administrator)
What Can You Do?
- Configure cleanup per tenant
- Set retention days for each data type
- Delete short recordings
- Schedule automatic cleanup
- Convert recordings to save space
- Run cleanup manually
- Enable/disable cleanup jobs
System Cleanup - Tenant List
Cleanup Settings
Quick Tips
TIP
Leave Empty: Leave days empty to keep all records.TIP
Short Recordings: Set to 3 seconds to remove empty recordings.WARNING
Permanent Deletion: Deleted data cannot be recovered!---
4. Configuration Sections
Data Type Settings
| Field | Description | |
|---|---|---|
| Delete Oldest CDR | CDR retention (days) | |
| Delete Oldest Recordings | Recording retention | |
| Delete Oldest Voicemails | Voicemail retention | |
| Delete Short Recordings | Min duration (seconds) | |
| Delete Oldest Log Events | Log retention | |
| Delete Oldest SMS | SMS retention |
Schedule Settings
| Field | Description | |
|---|---|---|
| Enabled | Job on/off | |
| Schedule | Run frequency |
Audio Settings
| Field | Description | |
|---|---|---|
| Convert Recordings | Enable conversion | |
| Audio Quality | Conversion quality |
5. Settings Reference
Schedule Options
| Option | Description | |
|---|---|---|
| None | Manual only | |
| Daily | Run every day | |
| Weekly | Run every week | |
| Monthly | Run every month |
Audio Quality Options
| Quality | Bitrate | Use Case | |
|---|---|---|---|
| Good (16k) | 16 kbps | Maximum space saving | |
| High (32k) | 32 kbps | Balance quality/size | |
| Lossless (WAV) | Original | Keep quality |
Retention Guidelines
| Data Type | Minimum | Typical | Compliance | |
|---|---|---|---|---|
| CDR | 30 days | 90 days | 1-7 years | |
| Recordings | 30 days | 90 days | Per policy | |
| Voicemails | 30 days | 60 days | 30-90 days | |
| Log Events | 7 days | 30 days | Per policy | |
| SMS | 30 days | 90 days | Per policy |
Storage Impact
| Data Type | Size Impact | Cleanup Benefit | |
|---|---|---|---|
| Recordings | Largest | Highest savings | |
| CDR | Medium | Faster queries | |
| Voicemails | Medium | Good savings | |
| Logs | Small | Improved performance | |
| SMS | Small | Minor savings |
6. Common Scenarios & Examples
Scenario 1: Standard Cleanup Policy
- Select tenant
- Enable = ✓
- Schedule = Daily
- CDR = 90 days
- Recordings = 30 days
- Voicemails = 60 days
- Short recordings = 3 seconds
- Save
Scenario 2: Compliance (Keep Long)
- CDR = 365 days (1 year)
- Recordings = 365 days
- Voicemails = 90 days
- Short recordings = 0 (keep all)
- Schedule = Weekly
- Save
Scenario 3: Space Emergency
- CDR = 30 days (minimum)
- Recordings = 7 days (aggressive)
- Voicemails = 30 days
- Short recordings = 5 seconds
- Convert Recordings = ✓
- Audio Quality = Good (16k)
- Save
- Execute Now
Scenario 4: Convert Without Deleting
- CDR = (leave empty)
- Recordings = (leave empty)
- Convert Recordings = ✓
- Audio Quality = High (32k)
- Save
- Only converts, no deletions
---
7. Limitations & Important Notes
Technical Notes
NOTE
Per-Tenant: Each tenant has separate settings.NOTE
Schedule Time: Usually runs at 2:00 AM.CAUTION
Irreversible: Deleted data cannot be recovered!Best Practices
- Backup First: Ensure backups before aggressive cleanup
- Start Conservative: Begin with longer retention
- Monitor Storage: Watch disk usage trends
- Test Execute: Run Execute Now to verify
- Compliance Check: Verify retention requirements
Data Types Explained
| Data Type | What It Is | |
|---|---|---|
| CDR | Call Detail Records (metadata) | |
| Recordings | Audio files of calls | |
| Voicemails | User voicemail messages | |
| Log Events | System and audit logs | |
| SMS | Text messages (if enabled) |
8. Troubleshooting Tips
Common Issues
| Symptom | Possible Cause | Solution | |
|---|---|---|---|
| Disk still full | Short retention | Reduce days | |
| Job not running | Disabled | Enable cleanup | |
| Wrong files deleted | Wrong settings | Check config | |
| Slow cleanup | Many files | Wait or schedule |
Check Storage
Check Cleanup Status
---
9. Glossary
| Term | Definition | |
|---|---|---|
| CDR | Call Detail Records | |
| Retention | How long to keep data | |
| Cleanup | Automatic deletion | |
| Conversion | Change audio format | |
| Execute Now | Manual cleanup run |
Lua Script Status ℹ️
Maintenance Module
| Component | Status |
|---|---|
| System Cleanup | ℹ️ Data maintenance - no Lua handler required |
---
Documentation last updated: January 2026