SuiteCRM – Customer Portal
SuitePort_SuiteCRM WordPress Customer Portal
SuiteCRM: 7.4.* to 7.12.* , 8.0.* to 8.1
WordPress: 4.0 to 5.9.3
SuiteCRM Installation & Configuration
You need to install the “Customer Portal” module into SuiteCRM and WordPress.
On purchase of the customer portal from CRMJetty, you will receive one zip. Once you extract the zip you will get two zip i.e. one for CRM (SuiteCRM) and another one for CMS (WordPress).
SuiteCRM Plug-in Installation
To start with the installation, Log-in as Administrator into SuiteCRM. Navigate to the Administration page and click on ‘Module Loader’ to install the package. 
Browse the SuiteCRM Package zip file and click on ‘Upload’ button. 
After uploading the package, click on ‘Install’ button to install the package.
Click on ‘Commit’ button to finish the installation. After successful installation, you can see ‘WordPress Customer Portal’ Plug-in in Installed plug-in list on Module Loader page. 
Now, need to repair your SuiteCRM Instance. For that, navigate to Administration page and click on ‘Repair’ link, then click on ‘Quick Repair and Rebuild’ link.
WordPress Manual Plug-in installation
Login to your WordPress portal from wp-admin and navigate to the plugin module. Here you can see the Add New Button. Click on the ‘Add New’ button which will redirect you to Add Plugins Page. 
Click on ‘Upload Plugin’ Browse the WP-Plugin-Package zip and Install the Plugin. 
Click on ‘Choose File’ to activate this newly installed plugin. 
Go to the Installed plugins screen. Here, you can see SuiteCRM Customer Portal Plugin was successfully installed. But still, it’s Inactive. 
Click on ‘Activate Plugin’ to activate this newly installed plugin.
SuiteCRM Configuration Settings
Get activation key
Get the activation key from the Order Confirmation Mail. OR
Login to your CRMJetty account then go to downloadable options and copy the activation key for the Customer Portal plug-in.
Note: Applicable only if purchased from CRMJetty.
Activate your plug-in
After successful package installation, you need to validate your license and configure your Portal.
Log-in to your SuiteCRM as admin and go to Administrator Page. You can see the ‘Customer Portal’ section on this page.
Now click on ‘License Configuration’ link, this will re-direct you to Portal Configuration page.
Enter your license activation key provided by CRMJetty. Validate your license by clicking the ‘Validate’ button.
WordPress Portal URL Configuration
Customer Portal plug-in provides a functionality to create WordPress users from the SuiteCRM based on Contact creation. When any contact is created in SuiteCRM, you can also provide that contact an access to the portal.
For this WordPress URL must be configured. To configure the URL go to Administrator Page and click on ‘License Configuration’. Select WordPress from the dropdown, enter your WordPress Portal URL and click on ‘Save’ button.
Note: WordPress portal URL configuration is mandatory for Portal user creation or for receiving notification from SuiteCRM.
SuiteCRM Configuration for Portal Users
You can configure and setup the customer portal for the portal users as per your requirement.
Configure Module Accessibility for Portal Users
The customer portal provides feature to manage SuiteCRM Module’s accessibility for their WordPress portal users. Navigate to “Admin -> Customer Portal”. Click on “Portal Module Configuration”.
You will get the list of default and custom modules. Just need to drag and drop to make them enabled for portal users. You can decide access of which module should be provided to which customer by WordPress User Group module.
Create/View Portal User Group
To create or view the Portal user group, navigate to: Admin -> Admin -> Customer Portal User Group. 
Click on ‘Customer Portal User Group’ to create a Portal User Group and you will be redirected to the ‘WordPress User Group’ Module’s List View. 
Here, you can see ‘Default’ WordPress User Group already exists in the list. User cannot delete this ‘Default’ group record. Admin user can create different ‘User Groups’ and define accessible modules for that group.
Note: By default, ‘Default’ group will be assigned to a newly created contact record.
On the left panel, by clicking on ‘Create Portal User Group’, you can create a User Group with Description.
After inserting ‘Group Name’ & ‘Description’, Save it.
You can tick the ‘Is Primary Group’ option if you want to select this User Group as Primary Group. 
Note: Only one User Group can be selected as ‘Primary Group’.
By clicking on the Group Name from the list, the detail page will be opened as shown below.
Under the “Portal Access Module List”, you will get the Relationship Type to define the relationship of the selected user group. You can select either Contact based, or Account based.
If you select Contacts, the portal user will get the data that is directly related to the Contact. But if you select Account, the portal user will get the data that is related to Contact’s Account.
Relationship selection is provided to select the relationship for the module with contacts or accounts. The relationship of the modules will be changed as per the selection of the Relationship Type. 
Enable the Modules from here and give the rights for Create/Edit/Delete/Subpanels by ticking the options to your customers.
It means the user will get the access to the module as per your settings.
Set Sub-Panel Accessibility for Portal Users
The customer portal provides feature to manage SuiteCRM Sub-panel’s accessibility for their WordPress ‘Portal Users’. You can decide access of sub-panel should be provided to which customer by ‘WordPress User Group’ module. 
The data in the subpanels will be loaded based on the relationship with the selected Relation Type, either “Contact based” or “Account-based”. ‘Tick’ the last option to provide sub-panel’s visibility to your customers in the portal.
Note: For ‘Calls’ and ‘Meetings’ modules, if you want to get data listed in the sub-panel then you need to make the Portal Visible.
 Navigate to the detailed view of calls or meetings which you want to make “portal visible”.  Click on Action -> Edit option from detail view to edit call or meeting.
From Portal, the visibility tab checks the box to make call or meeting portal visible and view them in sub-panel.
Note: If ‘Calls’ or ‘Meeting’ is already created, you can tick the Portal Visible option from its detail view.
You can also define advance configurations to different user groups like Case deflection, Knowledge Base Category and Calendar accessibility.
While creating cases from portal, Case deflection feature helps your customers to find the probable solutions before adding any Case. If no relevant solutions are found, then customer can proceed ahead by adding a new case.
For that, you should ‘Enable’ the Case Deflection Once you’ve enabled case deflection option, you need to select the Case Deflection Categories.
Based on the categories you will select, the customers searching for a query will be shown solutions from those particular categories.
Note: Case Deflection will only work if ‘Knowledge Base’ module is enabled, and ‘Category’ is selected.
Calendar: You can also enable calendar only for specific user groups.
Note: Calendar can only be enabled if Calls or Meeting module is enabled.
Set Portal Layout
To avail SuiteCRM modules into your WordPress portal, it is mandatory to set Portal Layouts for each accessible module. Customer Portal plug-in provides facility to set Portal Layouts for Accounts, Contacts, Calls, Meetings, Notes, Cases, Documents, and Quotes module from SuiteCRM.
To create or view the Portal user group, navigate to Admin -> Admin -> Customer Portal Layout. 
You will see the Configure Portal Layout option to set and configure the layout for the customer portal. By clicking on the “Configure Portal Layout”, you will be redirected to the Portal layout Settings. Select the desired user Group and respective Module to set the layout accordingly.
Set layouts for Edit view, Detail view, and List view. Drag and drop fields from the left column to the right. 
> Portal Field Properties Settings
By clicking on the Portal Field Properties Settings (setting icon), you can set the Field Properties and Conditional Settings for the different Modules. 
Portal Field Properties
Now, click on the Portal Field Properties option to set the “Portal Label” and “Help Tip” for the different fields of the selected module. 
It provides you to manage various field settings, which are listed below:
– Portal Label: Insert the desired ‘label’ of the field so portal users can easily recognize the fields.
– Help tip: This attribute will be shown as a tooltip regarding the respective field in the portal.
– Required: This attribute will allow users to make fields mandatory.
– Read-only: This attribute will restrict users to edit the respective field’s value.
– Searchable: Portal users can filter the records as per the search option. If you want to add the field in the search option in the portal, check the checkbox of that field as ‘Searchable’.
Note: You can only make fields mandatory if they are not default required fields from CRM.
The conditional statement is the point where workflow divides into two branches. With the help of conditional statements, you can set the conditions to view the specific data in the customer portal. 
You can configure the Field Visibility and Conditional Field by defining the hide/show for other fields. If Field B depends upon Field A and you want to display the “Field B” based on the selection of the ”Field A”, you can define this conditional visibility for the fields under Advance Field Management.
Now, by clicking on the “Conditional Settings”, you will see the ADD STATEMENT button if you are configuring the Conditional Settings for the first time. 
From the Conditional Settings, you can set the condition to make the visibility of the field on the customer portal side.
By clicking on the ADD STATEMENT, you can configure the Field Visibility conditional for the field’s value as follows:
– Field for visibility: Select the field for which you want to apply the condition.
– Portal Required: Switch ON to make the field required in the portal.
– Default field visibility: Switch ON to hide the selected field in “Field for Visibility” in the portal by default.
Note: You can only make fields mandatory if they are not default required fields from CRM.
Show above field when following criteria matches:
– Conditional Field: Select the field of visibility. 
– Matching Category: Select any one Matching Category from “Any” and “All”. 
If you select the “Any” Matching category then the customized condition will be applied if any value is selected in the “Options” field.
But, if you select the “All” Matching category then the customized condition will only apply if all the values are selected as configured in the “Options” field.
– Options: Select the options to match the criteria for which you want to set the condition. After configuring the conditions, click on the Save button to save the conditions.
Similarly, you can also add another new condition by clicking on the “Add Statement” button.
Note: After configuring the portal layouts in the SuiteCRM or WordPress, you must log in again to the portal to check the updates.
Knowledge Base articles accessibility
Set Knowledge Base articles accessibility for Portal Users.
To set knowledge base articles accessibility, navigate to Customer Portal User Group settings.
Click on ‘Customer Portal User Group’ link and you will be redirected to the User Group Module’s List View. Here, by scrolling down, you can see ‘Knowledge Base’ sub-panel.
Select the articles or create the new ones which you want to display on portal end.
These articles will get accessible for this particular user group customers. You can also enable/disable the articles from the “portal visible” option from the detail view of article.
‘Check’ the Portal Visible option and select the Status as ‘Public’ to enable it for the Portal Users.
Knowledge Base article can be instantly useful for portal users to resolve any query.
You can also create a Knowledge Base article and give the access as per Portal User Groups.
Set Username and Password Fields in Contacts Layout
When you install this package, username and password; both fields are created in contacts module. Confirm that Username and Password fields are added to record view. If you cannot see Username and Password field in record view or create view, then you may have to set these fields in Record layouts.
For that, Go to Administrator -> Studio -> Contacts -> Layouts -> Record and Drag and drop those fields in Record View and click on ‘Save and Deploy’ button.
Suite Admin can set the Portal credentials for a contact and allow access of portal to that contact. By default, the ‘Enable Portal’ checkbox will be enabled for a newly created contact.
Uncheck the ‘Enable Portal’ checkbox to disable the portal accessibility to any user.
WordPress Configuration Settings
Twak.to Chat Plugin Installation
To install Twak.to chat plugin, navigate to Plugins and click on the ‘Add New’ button which will redirect you to Add Plugins Page. 
Now, search for Twak.to Live Chat plugin. Install and activate the plugin in your WordPress account.
After activating the plugin, navigate to the settings page of twak.to. To create a tawk.to account, sign in to the account.  Select a property and widget from here. 
Navigate to tawk.to dashboard and configure your email. To configure mail notifications, navigate to ‘Admin’ from tawk.to dashboard and click on ‘Mail Notifications’. 
Click on ‘Use selected widget’ button to enable chat widget in your portal. 
Mention the email to which you wish to send all the chat transcripts.
Now, navigate to Property Settings and enter your Portal URL and click on ‘Save’ This would enable the chat widget in your portal.
Here, you will find an API Key, which you need to enter in your SuiteCRM instance to save chat transcripts. 
Copy the API Key and navigate to the Admin page from your SuiteCRM account.
Now, configure inbound email in CRM to create cases for each chat transcript. To configure inbound email, navigate to Profile ->Emails Settings – > Settings -> Mail Accounts. 
Click on ‘Add’ button to set up your mail account. Fill up your Email account details and click on ‘Done to finish setup. Once your mail account is added navigate to Chat Configuration from Admin Area. 
Click on ‘Chat Configuration’ link. This would open up Portal Chat Configuration Page. 
Paste the tawk.to API key here and click on ‘Save’ Once the plug-in is configured at both ends, you can start chatting with the Portal Users.
Select appropriate email template from the drop-down for New Registered User and Forgot Password.
If the appropriate template is not available, click on “Create” to design your own email template. You can even select any template from the drop-down and click “Edit” to make changes as per your requirement.
You can also set an auto-delete notification period. So that after the defined period, notifications will be automatically deleted.
Select the default language for the portal. So, by default, the portal will work on that selected language.
Single Site Settings
Go to WordPress admin side and click on ‘Customer Portal’ and configure SuiteCRM portal setting options. 
Select an appropriate name for your portal. Enter your CRM instance URL and CRM Admin credentials (Username and Password). 
You can enable/disable registration for the portal. If this box is unchecked, a new user cannot sign-up from the portal.
In General Settings, you can set the number of records you want to display per page, set Portal Logo, and Mobile Portal Menu Tile. 
You can allow users to have a single sign-in for WordPress Account and Portal. To enable the single sign-in feature, check the ‘Single Sign-In’ check box.
You can also choose a template from the dropdown menu.
Note: Choose the ‘Full-Width Page’ template for the existing theme header and footer.
You can select the Theme Color and select color for Calendar activities like Calls, Meetings, Task. 
Select the relevant page for different activities. 
You can also add a re-captcha option for login, signup, and forgot password pages to protect your website from spam and abuse. 
Add re-Captcha Site Key and re-Captcha Secret Key, then configure for pages and save it.
Note: To get details for generating re-Captcha Site Key and re-Captcha Secret Key, navigate here. We support re-Captcha v2.0
If you have multiple sites in WordPress, you can provide access of portal to all sites. All websites will be listed under ‘My Sites’ tab in your WordPress Admin Account.
To configure Portal for multiple sites, navigate to ‘Network Admin’ and click on ‘Customer Portal’. You can manage all the general configurations for Portal from Network Admin.
Check the ‘Multi-site Sign-in’ check box to allow user to login from any other sub-site.
Check the ‘Multiple Domain Site’ check box to enable portal for websites with multiple domains.
You can configure portal for all sub-sites separately. To configure portal for a sub-site, navigate to that particular site from ‘My Sites’ tab.
Now, click on ‘Customer Portal’ tab on the left side panel. This will take you to the portal configuration page of that particular sub-site.
In addition to general portal settings, you can allow users to have a single sign-in for WordPress Account and Portal. To enable single sign-in feature, check the ‘Single Sign-In’ check box.
To disable portal for this particular sub-site, check the ‘Disable Portal’ checkbox.
Note: If you have not configured portal for each sub-site separately, then all configurations set in the Network Admin will be considered as default.
User Redirection Configuration
Network admin or Sub-site Admin can redirect any user to other website’s portal.
To redirect a user to any other website, navigate to Network Admin > Dashboard > Users.
This will take you to the Users list page. Click on ‘Edit’ link under the user you wish to redirect to other websites portal.
This will redirect you to the user edit page. Navigate to ‘Account Management’ section and choose a website from the dropdown.
Upon next login User will be redirected to the selected sites’ portal.
Note: User Redirection is only for Multisite WordPress Account.
Approval and Verification for Portal Users
If you want to provide access for the portal only to those who are approved by the admin, then navigate to WordPress Admin Panel -> Customer Portal Settings Page. 
Tick the checkbox to enable user approval flow. Now, whenever a portal user registers from portal. They will be added to Contacts module in CRM with pending status.
Now you can apply advance filter on contact’s approval status and get the list of pending contacts for approval. 
Now you can apply advance filter on contacts and get the list of pending contacts for approval. To approve contacts, select such contacts from the filtered contacts’ list view and click on the Actions dropdown. Now, select ‘Approve For Portal’ option from the dropdown. 
This will convert pending CRM Contacts to portal users and a list of imported contacts will be displayed. 
While approval it will also send an email to portal users notifying that they are approved and can access the portal.
Instead of mass contacts approval, you can also navigate to the detail view of any contacts and approve them by changing the approval status from portal user information tab. 
Note: Once the contact is approved, you cannot change the approval status of that contacts.
If verification flow is enabled. They need to verify their account then only they can proceed further for login. 
Multi Language Support for Portal Users
Customer portal provides multi-language support to collaboratively work online across organizational, geographical and overcome language barriers.
You need to set message for portal to work with different languages. For setting messages, navigate to Admin -> Developer Tools -> Drop Down Editor.
From drop down editor you will find “customer_portal_app_msgs” tab. From there you can set message for individual languages.
Select language and add messages. It will be reflected on the portal when that language is selected by the portal user.
Note: Default language can be set from CRM view “General Portal Configuration” and if no language is selected it will take from CRM enabled languages.
Convert CRM contacts to Portal Users
To provide access to Portal for already existing CRM contacts, select such contacts from the contacts’ list view and click on the actions dropdown.
Now select ‘Convert to Portal Contacts’ option from the dropdown.
This will convert CRM Contacts to portal users and a list of imported contacts will be displayed.
Click on ‘Export Converted’ button to export the list of converted users. This will export the list of converted users to a .csv file.
Now to create WordPress Users, import the csv file in WordPress Portal. To import the file in WordPress, navigate to Employee Portal >> Import Users
Click on ‘Choose File’ button and upload the csv file. Now, click on ‘Import’ button to import the contacts.
On importing the file, new WordPress users will be created and if ‘Send User Mail?’ checkbox is checked then users will receive a mail notification along with their credentials.
SuiteCRM Customer Portal (Frontend)
After completing all configurations at SuiteCRM and WordPress portal for Customer Portal plugin, Customer can sign-up or login to Customer Portal and access SuiteCRM modules as the assigned Portal user group.
Login, Sign up & Forgot Password
Directly login to the portal using your portal credentials.
If two-step authentication is enabled, then portal users will receive an OTP in email. Enter valid OTP and it will allow portal users to access interface.
Note: OTP is valid for 30 minutes. If not used, then portal user needs to resend OTP and get new OTP.
Customer can sign-up to the WordPress Portal by clicking on ‘Sign Up Now!’ link on the Login Page. On clicking this link will redirect customer to sign up page as below.
A new user can directly sign-up from the Portal. The credentials will be verified to check whether any customer has been registered with same username and email address. If any such user does not exist in the system, then a user will be created in WordPress and SuiteCRM Contacts module.
As soon as the portal user is created, a verification link will be sent to user on registered email address. If user have not verified the link, they will not be able to login from portal.
Once signed-up from the Portal and have done email verification, User can directly login to the Portal and can also access his WordPress Account without having to login again.
Note: Already existing customers on both sides (WordPress and Suite) won’t get the access for Customer Portal automatically on installation.
When any user registers in the portal, an account will be automatically created with the entered username.
Portal user can retrieve their login password using the ‘Forgot Password’ Click on ‘Forgot Password’ option and enter your username and email address. Click on ‘Submit’ button and you will receive your password on your email.
Dashboard includes recent activities and today’s schedule for viewing your whole day schedule.
WordPress admin can set the accessibility to recently added records for portal users. Accordingly, those modules with their recent records will be displayed on the dashboard.
Quickly access top modules by clicking “View More”. It will also display charts for cases and quotes module to view their status.
As the admin has selected the “Relation Type” from the SuiteCRM side in the Portal user group configuration, you will get either Contact based, or Account-based modules’ data.
Suppose the admin has selected Account as “Relation Type”, the details will be loaded on the dashboard will be loaded based on the relationship with the account. 
You can also search the data globally from the portal or you can select the module from the drop-down to search from any specific module.
You will get the global search result of data or the selected module will be loaded as per the module’s relationship with the selected “Relation Type”, either Contact based, or Account-based.
Note: For the Note, Meeting, and Call modules, the data will be loaded based on the relationship with the account and portal logged in Contact’s Accounts.
Suppose admin has selected Contact based as “Relation Type”, the details will be loaded on the dashboard will be loaded based on the relationship with the contact. 
Navigate to Case By clicking on ‘Case’ (‘View’ icon), the details page will be redirected. By scrolling down, the customer will find the sub-panel.
Here you will get the data in the sub-panel based on the relationship with the “Relation Type”, either Contact based, or Account based.
By clicking on any subpanel, the customer can see the record which is created by the Admin.
Click on the record (or ‘View’ Icon), the customer can see the details view of that record.
Note: Only those ‘Calls’ and ‘Meetings’ will be visible in sub panel which are made portal visible from SuiteCRM.
Portal Users get an option to set their required dashboard preference from the Customer Portal. To set preferences, they can click on the “Preferences” option from the profile drop-down menu.
They can enable/disable preferences for the dashboard as per requirements from the listing.
Note: When the customer will log in, they can see the preference as the admin has set.
By scrolling down in Dashboard Preferences, your customers can set the preferences for the Notification.  Customers can set the ‘Notification Preferences’ of modules. They can tick the module for Create & Status Change
Create: If you perform any actions, the customers will get the notification if they are in that User Group. g. if new meeting is created by you, the customer will get notification related to the meeting.
Status Change: If Status is changed by you, they will get notification.
By clicking on the Notification ‘icon’, the customers will get the notification with the highlighted details as shown above image. 
By clicking on the View All option, the customers can see all the notification in detail. 
The ‘Delete’ option is also given if the portal user want to delete any notification. You can also delete the unwanted notification from the list. Select notifications and click on “Delete” button or click on “Delete All” button if you want to clear the notification list. 
You can also apply filtering on notifications for various parameters as mentioned below: 
Type: Notifications are generated on basically three type i.e. on create, on status change and on case updates. So, you can apply filter and view specific type of notification list.
Module: Choose module to view module-specific notifications.
Start Date and End Date: Choose dates to view in between notifications for that particular day, week, month or year.
By using feedback section, a portal user can add feedback.
The user will have to add a subject and description for feedback and then click on submit button to save. It will get related to this particular contact in CRM. So, in contacts you will get sub-panel of feedback where there will be a list of feedbacks added by that portal user.
Portal user can also add multiple feedbacks from portal as and when require.
If you have enabled the Calendar option from the SuiteCRM Configuration, the Calendar will be displayed to your portal users.
By clicking on it, the calls and meetings records can be seen on the calendar as per the records date with time by your customers.
Click on any date and schedule activity as per your requirement.
You can create proposal with the required products and services.
Once the proposal is created, user can edit or delete that proposal only if it is in “Pending” state.
Admin can convert the proposal to quote by “Convert to Quotes” option.
Note: Proposal cannot be changed once the proposal is converted or declined by admin.
Once the quotes are converted, they will also be listed in detail view of corresponding proposal.
If you have added any Custom Module and enabled as well from the CRM side for the customer portal, your customer will get the custom module and add/edit/check the records as per the accessibility rights.
As per your portal layout settings for list view / detail view, you will get the layout with the details. You will also get the Dynamic Dropdown option if you added that fields.
Once twak.to plugin is successfully configured, you can start chatting with your portal users using the chat widget.
The chats can be monitored from the twak.to dashboard. Once the chat is completed, a transcript of that chat will be generated and sent to the configured email address.
Also, a case will be generated in the CRM with the chat transcript which can be related to a concerned user.
We simplify your business, offer unique business solution in digital web and IT landscapes.
Get instant support with our Live Chat.
Visit our product page at: https://www.crmjetty.com/suitecrm-wordpress-customer-portal.htm and click on the Live Chat button for instant support.
Raise tickets for your specific question!
If you would like to customize or discuss about additional feature for Customer Portal, please write to [email protected]