Installation & Setup
Get the Sales Dashboard addon installed, licensed, and configured so your sales team can start tracking leads immediately.
Requirements
- WordPress 5.8 or higher
- PHP 8.2 or higher
- ToolDocs™ core plugin — must be installed and activated first
- A valid Sales Dashboard license key
Optional: The ToolDocs Advanced Analytics addon enables return-visit detection and session-based notification rules. Sales Dashboard works without it, but the “Inactive Return” notification rule type requires it.
Installation
- Upload the
tooldocs-sales-dashboardfolder to/wp-content/plugins/, or install via Plugins → Add New → Upload Plugin. - Make sure the ToolDocs core plugin is already activated.
- Activate Sales Dashboard from Plugins → Installed Plugins.
License Activation
- Navigate to the ToolDocs settings page in WordPress admin.
- Find the Sales Dashboard addon card.
- Enter your license key and click Activate.
Both the ToolDocs core license and the Sales Dashboard license must be active for the dashboard to function. Without an active license, the dashboard page loads but all data endpoints are blocked.
What Happens on Activation
The plugin automatically:
- Creates database tables for territory assignments, notification preferences, lead scores, score history, saved segments, notification rules, and notification logs.
- Creates two custom WordPress roles — Sales Manager (full dashboard access) and Sales Rep (territory-filtered access).
- Grants all Sales Dashboard capabilities to the Administrator role.
- Creates a private WordPress page at
/sales-dashboard/containing the[sales_dashboard]shortcode. This page is only visible to users with a sales role. - Sets default values for all plugin options (notifications, email template, lead scoring weights, retention periods).
- Schedules three background cron jobs — lead score recalculation (every 6 hours), daily score snapshots (midnight), and data cleanup (2:00 AM).
Roles & Capabilities
Sales Dashboard creates two WordPress roles with distinct permission levels:
Sales Manager
Full access to all dashboard features: viewing all leads, managing users, exporting data, managing territories, configuring settings, and viewing sales rep analytics.
Sales Rep
Can view leads and user details, but only for users within their assigned territory. Cannot access settings, territories, analytics, or hidden users.
Administrator
All Sales Dashboard capabilities are added to the built-in Administrator role on activation.
The dashboard page is created as a private WordPress page. Sales Dashboard automatically handles the read_private_pages capability for sales roles — you don’t need to grant it manually.
Accessing the Dashboard
After activation, the dashboard is available at yoursite.com/sales-dashboard/. Access behavior:
- Not logged in → redirected to the WordPress login page, then back to the dashboard after login.
- Logged in without a sales role → redirected to the home page.
- Logged in as Sales Rep, Sales Manager, or Administrator → dashboard loads normally.
Initial Configuration Checklist
- Assign territories — Go to the Locations page and map zip code prefixes or state/country combinations to sales reps.
- Review lead scoring weights — The defaults work for most setups, but adjust in Settings → Lead Scoring if your process values certain activities differently.
- Set up notification rules — Configure which events trigger email or webhook notifications.
- Customize the email template — Edit the notification email template in Settings → Email Template.
- Assign sales roles — Give your team members the Sales Manager or Sales Rep role from WordPress Users.