Revenue Engine AI for SuiteCRM

Getting started

• Introduction
• Release Notes
• FAQ
• Install / Upgrade Guide
• User Guide
• Admin Guide

Install / Upgrade Guide

Revenue Engine AI installs in under 5 minutes using the native SuiteCRM Module Loader — no configuration or database changes required.

Before You Begin

Ensure your environment meets the following:

• SuiteCRM Version: 7.x (7.12 and above) or 8.x
• PHP Version: 7.4 or higher
• User Role: Administrator access required
• Permissions: Write access to custom/ and modules/ directories

Note: The installer includes a PHP version check and will block installation if requirements are not met.

Installation Steps

1. Download the latest RevenueEngineAI.zip package.
2. Log into your SuiteCRM instance as an Administrator.
3. Navigate to Admin → Module Loader.
4. Click "Choose File" and select the ZIP file.
5. Click "Upload".
6. Click "Install" and confirm when prompted.

Automatic Setup

During installation, the system will automatically:

• Run Quick Repair and Rebuild
• Register navigation entries
• Deploy required assets
• Validate package integrity

No manual steps are required after installation.

Post-Install Verification

After installation, verify the following:

• Revenue Engine AI is visible in the navigation or profile menu
• The dashboard loads without errors
• No missing UI components or broken assets

If all checks pass, installation is complete.

Optional: Activate License

1. Open Revenue Engine AI → Settings
2. Enter your License Key
3. Click Save

Note: License validation requires administrator access and an active internet connection.

Optional: Configure AI (Bring Your Own Key)

Supported providers:

• Google Gemini (free tier available via aistudio.google.com)
• OpenAI
• Anthropic Claude

To configure:

1. Go to Settings → AI Configuration
2. Enter your API key
3. Save settings

Note: Your API key is stored only in your browser and is never sent to Zybroz servers. When AI insights are generated, your pipeline data is sent directly from your browser to your chosen AI provider (Gemini, OpenAI, or Anthropic).

Accessing Revenue Engine AI

You can access the dashboard from:

• Profile Menu: Top-right user menu → Revenue Engine AI
• Admin Panel: Admin → Revenue Engine AI → Open Dashboard
• Home Dashlet: Home → Add Dashlet → Revenue Engine AI

Note: Revenue Engine AI does not appear in the main top navigation bar. This is intentional — adding it to the SuiteCRM module list causes compatibility issues with SuiteCRM 8.x.

Upgrade Guide

Upgrading preserves all settings and data.

Steps

1. Download the latest version ZIP file
2. Navigate to Admin → Module Loader
3. Upload the new package
4. Click Install

SuiteCRM will automatically handle the upgrade process.

What Happens During Upgrade

• Existing configuration is preserved
• License key remains intact
• No database schema changes are made
• New features and fixes are applied

Upgrade Best Practices

• Take a full backup before upgrading
• Test in a staging environment for production systems
• Clear browser cache after upgrade if UI changes are not visible

Troubleshooting

Module not visible after install

• Go to Admin → Repair → Quick Repair and Rebuild
• Clear browser cache

Dashboard not loading

• Check browser console for errors
• Verify assets were deployed correctly
• Reinstall the package if necessary

License not validating

• Verify correct license key format (REAI-XXXXXXXX-XXXXXXXXXXXXXXXX)
• Ensure internet connectivity from the browser
• Confirm administrator permissions

Installation fails

• Verify PHP version (must be 7.4 or higher)
• Check file permissions on custom/ and modules/ directories
• Ensure the ZIP file is not corrupted

Safe Installation

Revenue Engine AI uses a passive-safe architecture:

• No database schema changes
• No impact on core SuiteCRM modules
• Clean uninstall support
• No modification of existing CRM data

Estimated Installation Time

• Upload and install: approximately 2 minutes
• First load: approximately 1 minute
• Optional setup: approximately 2 minutes

Total: approximately 5 minutes

Next Steps

After installation, open the dashboard and an onboarding wizard will guide you through initial setup.