1. Home
  2. SuiteCRM TeamPulse
  3. Getting Started & Admin C...
  4. TeamPulse for SuiteCRM: Install, License & Demo Mode Guide

TeamPulse for SuiteCRM: Install, License & Demo Mode Guide

The TeamPulse SuiteCRM installation process is the critical first step between raw CRM data and actionable behavioral coaching insights. This guide covers system requirements, step-by-step module upload, license activation, and how to toggle between Live Mode and Demo Mode.

For sales managers and administrators, the ability to switch between Live Mode and Demo Mode solves a primary pain point: the need for a safe environment to train users or verify features without exposing real-time performance data. This ensures that the transition to behavioral management is seamless, professional, and data-secure.

System Requirements

TeamPulse is built for high-velocity sales environments and requires a modern PHP stack to handle real-time scoring calculations.

Component Minimum Requirement
Platform SuiteCRM 7.10+ or 8.x
PHP Version 8.1 or higher
Database MySQL 5.7+ or MariaDB 10.3+
System Tasks Active SuiteCRM cron job (required for reports and AI cache)

Database Tables Installed

When the TeamPulse module is installed, it creates 7 persistent tables within the SuiteCRM database, plus a scheduler entry:

  • teampulse_config – Stores global settings, including AI keys, scoring weights, and the demo mode flag.
  • teampulse_cache – Stores AI summaries and scoring results to reduce database load.
  • teampulse_ai_queue – Manages asynchronous AI summary generation.
  • teampulse_journal – Stores manager coaching journal entries.
  • teampulse_actions – Stores coaching notes, kudos, and alerts sent to reps.
  • teampulse_schedules – Stores email report schedule configurations.
  • teampulse_schedule_log – Logs email report delivery history.
  • Scheduler Entry – Registers “TeamPulse – AI Summary & Cache Refresh” to run every 30 minutes.

License Status Definitions

The system identifies four primary license states, visible in Settings ? License:

  1. Licensed (Green Shield) – Valid key entered; all features and live data unlocked.
  2. Unlicensed (Red Shield) – No key present; the system enforces Demo Mode.
  3. Active (Dev Environment) – Automatically triggered on localhost or .local domains; bypasses license checks for development.
  4. Trial – A 30-day full-access state available via the SuiteCRM Store.

License validation is handled by LicenseService, which checks against the SuiteCRM Store API. Three plan keys are supported (monthly, yearly, one-time). An offline HMAC fallback is used when the Store API is unreachable.

Step-by-Step Installation

Phase 1: Module Upload

  1. Download – Obtain the ZIP file corresponding to your plan (Monthly, Yearly, or One-time) from the SuiteCRM Store.
  2. Upload – Log in as an Administrator and navigate to Admin ? Module Loader. Upload the ZIP file.
  3. Install – Click Install. The system will create the 7 custom tables and register the scheduler.
  4. Repair – Navigate to Admin ? Repair and run Quick Repair and Rebuild. This is mandatory to compile navigation extensions.
  5. Access – TeamPulse will appear in the top navigation bar under “ALL” or via the Profile icon dropdown.

Phase 2: License Activation

  1. Navigate to TeamPulse ? Settings ? License.
  2. Paste the license key provided in your purchase confirmation email.
  3. Click Activate. The system validates the key against the SuiteCRM Store API.
  4. Upon success, the status will change to “Licensed,” and the Demo Mode restriction is lifted.

Phase 3: Toggling Data Sources

In Settings ? General, you can control the Data Source Toggle:

  • Demo Mode – Loads 25 fictional reps across 3 teams (Midmarket, Enterprise, and SMB). Use this for training or when CRM data is not yet populated. No license is required for this mode.
  • Live Mode – Reads real CRM data (Calls, Meetings, Tasks, Opportunities). This requires a valid license. If no license is present, the toggle is blocked with an error message.

[Image Placeholder: Settings General tab showing Live/Demo Mode toggle and SuiteCRM API status badge]

First-Run Setup Wizard

On first access, TeamPulse launches a 5-step onboarding wizard:

  1. Welcome – Overview and prerequisites checklist.
  2. Connect – Verify the SuiteCRM API connection and confirm active user counts.
  3. Score Weights – Review the five behavioral scoring factors (read-only in v0.9.9; customization planned for v1.0).
  4. AI Setup – Choose between the built-in InsightEngine or a BYOK provider.
  5. Done – Launch TeamPulse with live or demo data.

You can re-run this wizard at any time using the Re-launch Setup Wizard button in Settings ? General.

Next Steps After Installation

  • Run a Data Audit – Navigate to Settings ? Debug and click Run Audit to verify that TeamPulse is correctly reading SuiteCRM user and activity counts.
  • Confirm Thresholds – The default “Stale” dashboard summary bar flags deals with no activity in 14 days. The “Stalled in Stage” threshold defaults to 30 days. Both align with typical enterprise sales cycles; confirm these match your team’s process in Settings ? Scoring Rules.

Troubleshooting / FAQ

Q: TeamPulse does not appear in the top navigation after installation.
A: This is usually because Quick Repair and Rebuild was skipped. Run the repair tool. If it still does not appear, go to Admin ? Display Modules and Subpanels, move TeamPulse to the “Displayed” column, and hard-refresh your browser (Ctrl+Shift+R).

Q: The General tab shows “SuiteCRM API: Unreachable.”
A: This indicates the PHP API is not responding. The most common cause is the module entry point not being registered. Run a Quick Repair and Rebuild. If the issue persists, check the error detail below the status badge for specific HTTP or parse errors.

Q: Can I use a Monthly license key on a Yearly-plan installation?
A: No. Each installable ZIP (Monthly, Yearly, One-Time) contains the validation logic for its specific plan only. Ensure the ZIP file used matches the license key purchased from the SuiteCRM Store.

How can we help?