Website Support for Perfex CRM
Version: 1.0.0
Author: Cloudmill
Support:
1. Introduction
Website Support is a powerful visual feedback tool designed for web agencies and developers. It allows your clients to submit feedback, bug reports, and change requests directly from their own website. With integrated screenshot capabilities, the module automatically creates organized support tickets in your Perfex CRM, complete with technical browser metadata.
2. Installation
Core Module Installation
1. Log in to your Perfex CRM Admin Panel and navigate to: Setup → Modules
2. Click Upload Module and select: website_support.zip
3. Click **Activate** to enable the module.
Automated Server Configuration
Upon activation, the module attempts to automatically add CSRF exclusions to your `application/config/config.php` file. This is required for the external widget to communicate with your CRM.
If your configuration file is not writable, you must manually add the following lines to the the bottom of your `application/config/config.php` file.
// website_support_csrf_exclude
$config['csrf_exclude_uris'][] = 'website_support/feedback_api/submit';
$config['csrf_exclude_uris'][] = 'website_support/feedback_api/widget(.*)';
3. Global Widget Settings
Before creating tokens, configure the default look and feel of the widget via Support > Website Support > Widget Settings.
Appearance
Accent Color: Choose a color that matches your brand or the client's website.
Logo: Upload a logo or provide a URL to display in the widget header.
Text Color: Switch between Light (white) and Dark (black) for optimal contrast on your accent color.
Custom Text: Override the default labels for the floating button (Trigger), header title, and introduction message.
Button Styling & Position
Positioning: Place the button in any corner (Top/Bottom, Left/Right) with pixel-perfect offsets.
Styling: Customize the font size, border radius (e.g., "50px" for a pill shape), and padding.
Default Ticket Behavior
Global Defaults: Set a default department, priority, and assigned staff member. These will be used if not specified otherwise in a specific token.
Screenshots: Enable or disable the screenshot feature globally. You can also choose if the "Include screenshot" checkbox should be checked by default.
4. Token Management
Tokens act as the "bridge" between a client's website and your CRM. Each token is tied to a specific project and domain.
Creating a Token
1. Go to Support > Website Support and click Create New Token.
2. Project: Select the project this feedback should be linked to.
3. Allowed Domain: Enter the full URL of the client's site (e.g., `https://clientwebsite.com`). Requests from other domains will be blocked.
4. Default Contact: (Optional) Select a contact person. If selected, the widget will pre-select this sender. If left empty, visitors must enter their name and email manually.
5. Require Login: If enabled, the widget only appears if the visitor is logged into your Perfex Client Portal.
The JS Snippet
Once a token is saved, a unique JS Snippet is generated. Copy this code and paste it just before the closing `</body>` tag on the client's website.
5. CMS Plugins
To make integration even easier, we provide dedicated plugins for popular CMS platforms.
WordPress Plugin
1. Install the Cloudmill - Website Support plugin on the client's WordPress site.
2. Go to Settings > Website Support.
3. Paste your Perfex CRM URL and the API Token.
4. Use the Visibility Controls to show the widget only to specific User Roles (e.g., 'Administrator' or 'Editor'), Users or on specific environments (Frontend vs. Backend).
Joomla Plugin
1. Install the plg_system_websitesupport extension via the Joomla System Dashboard.
2. Enable the plugin and paste your Perfex CRM URL and the API Token.
3. Set the Access Level or use the plugin settings to restrict the widget to specific User Groups or Users.
6. Using the Widget
When a visitor clicks the feedback button on the client's site:
1. Subject & Message: The user describes the issue.
2. Screenshot: Include Screenshots in your Ticket
3. Technical Meta: The widget automatically collects the User Agent, Resolution, Viewport size, and current URL.
Processing Feedback in Perfex
New submissions appear as standard tickets in your CRM.
Attachments: Screenshots are automatically added to the ticket.
Browser Info Tab: A dedicated tab appears in the Ticket View showing all technical metadata, helping your developers reproduce bugs faster without asking the client for their browser version.
7. Use Case Examples
Scenario A: Bug Reporting during Development
Link a token to an internal "Development" project. Give your client the WordPress plugin and restrict visibility to 'Administrators'. The client can navigate the site and "snag" bugs as they find them. Each report becomes a ticket assigned to your lead developer.
Scenario B: Support for Live Websites
Create a token for a live project with Require Login disabled. Place the snippet on the client's "Contact" page. Visitors can now send visual feedback about broken links or styling issues, which are routed to your "Support" department.
Scenario C: Managed Maintenance
Use the Default Staff setting in the token configuration to ensure that all feedback from a specific high-priority client is automatically assigned to their dedicated Account Manager.