Files
desk-moloni/docs/QUICK_START.md
Emanuel Almeida c19f6fd9ee fix(perfexcrm module): align version to 3.0.1, unify entrypoint, and harden routes/views
- Bump DESK_MOLONI version to 3.0.1 across module
- Normalize hooks to after_client_* and instantiate PerfexHooks safely
- Fix OAuthController view path and API client class name
- Add missing admin views for webhook config/logs; adjust view loading
- Harden client portal routes and admin routes mapping
- Make Dashboard/Logs/Queue tolerant to optional model methods
- Align log details query with existing schema; avoid broken joins

This makes the module operational in Perfex (admin + client), reduces 404s,
and avoids fatal errors due to inconsistent tables/methods.
2025-09-11 17:38:45 +01:00

3.1 KiB

🚀 Desk-Moloni Quick Start Guide

5-Minute Setup

Step 1: Installation (2 minutes)

# Upload module to Perfex CRM
1. Upload desk_moloni folder to /modules/
2. Set permissions: chmod -R 755 modules/desk_moloni/
3. Go to Setup → Modules in admin panel
4. Find "Desk-Moloni Integration v3.0" and click **Install**

Step 2: Configuration (2 minutes)

1. Go to Desk-Moloni → Configuration
2. Enter your Moloni API credentials:
   - Client ID: [your_moloni_client_id]
   - Client Secret: [your_moloni_secret] 
   - Company ID: [your_company_id]
3. Click "Test Connection" ✅
4. Click "Save Configuration" 💾

Step 3: First Sync (1 minute)

1. Go to Desk-Moloni → Dashboard
2. Click "Sync Now" button
3. Watch real-time progress! 📊
4. Done! ✨

🔑 Getting API Credentials

From Moloni Dashboard:

  1. Login to moloni.pt
  2. Go to Configurações → API
  3. Create new application:
    • Name: "Perfex CRM Integration"
    • Redirect URI: https://your-perfex.com/admin/desk_moloni/oauth/callback
  4. Copy Client ID and Client Secret

Verification Checklist

After installation, verify:

  • Module appears in admin sidebar
  • Configuration page loads without errors
  • API connection test passes
  • Dashboard shows sync statistics
  • No PHP errors in logs

🔧 Common Issues & Quick Fixes

"Connection Failed"

Solution: Check API credentials in Configuration
→ Verify Client ID, Secret, and Company ID
→ Test connection again

"Permission Denied"

Solution: Check user permissions
→ Go to Setup → Staff
→ Edit user role
→ Enable "Desk-Moloni" permissions

"Module Not Found"

Solution: Check file permissions
→ chmod -R 755 modules/desk_moloni/
→ Refresh modules page

🎯 What's Next?

Immediate Actions:

  1. Configure Sync Settings - Set automatic sync frequency
  2. Map Entities - Configure client/product mappings
  3. Test Workflows - Try creating a client → sync to Moloni

Advanced Setup:

  • Real-time Sync: Enable webhooks for instant updates
  • Custom Fields: Map additional Perfex fields
  • Bulk Operations: Import/export large datasets

📞 Need Help?

Documentation

Debug Mode

// Add to config.php for detailed logs
$config['desk_moloni_debug'] = true;

Support


🎉 Success!

Your Desk-Moloni integration is now ready!

Clients created in Perfex will automatically sync to Moloni, and invoices generated will be seamlessly integrated between both systems.

Next: Explore the Dashboard to monitor sync operations and performance metrics.


Generated by Desk-Moloni v3.0 - Built with ❤️ by Descomplicar®