SugarCRM Customer Portal for WordPress - CRMJetty · INSTALLATION GUIDE: SugarCRM Customer Portal...

INSTALLATION GUIDE

SugarCRM Customer

Portal for WordPress

Version: 3.2.0

WordPress Compatibility

WordPress: 4.0 to 5.2.2

SugarCRM Compatibility

Community Edition: 6.5* to 6.5.26

Professional Edition: 6.5* to 9.1.0

Enterprise Edition: 6.5* to 9.1.0

TABLE OF CONTENTS

Introduction .................................................. 1

Benefits of Customer Portal .......................... 1

Prerequisites ................................................. 1

Installation ..................................................... 2

SugarCRM Plug-in Installation ....................... 2

WordPress Manual Plug-in installation ......... 3

Plug-in Configuration .................................... 5

SugarCRM Configuration Settings ................. 5

WordPress Configuration Settings .............. 16

User Redirection Configuration ................... 20

Module Ordering ......................................... 21

Convert CRM contacts to Portal Users ........ 22

Tawk.to Chat Plugin Installation .................. 27

Contact Us ................................................... 33

INSTALLATION GUIDE: SugarCRM Customer Portal for WordPress

BIZ/UMP/G1 Public 1

Introduction

The SugarCRM Customer Portal plugin will help your customers to use several SugarCRM modules in their WP interface, which can be defined from CRM. The plugin integrates Accounts, Contacts, Calls, Meetings, Notes, Cases, Documents and Quotes module of SugarCRM to your WP interface. It will simplify and reduce your task of communicating with your customers through any other means. Your customers would be able to update all the above modules on their own.

Benefits of Customer Portal If you are user of SugarCRM, you can manage your WordPress customers better by integrating SugarCRM and WordPress platforms and connecting your WP users with your SugarCRM system. The SugarCRM Customer Portal will provide you the following benefits:

• Single sign-in for WordPress user account and portal

• Interactive Dashboard with recent records and quick access icons

• WordPress Multisite Support

• Create WordPress user groups and assign accessible roles for each module

• Sign-up directly from the portal, which will also create a contact record in SugarCRM

• Case commenting option

• Tawk. To Chat Plugin Integration. Capture chat conversations in SugarCRM

• Calendar view for all scheduled activities.

• Accept or Decline Quotes from Portal

• Download Quotes from Portal in PDF format.

• Global search across all module.

• Get Latest updates through notifications.

• Charts for cases and quotes module to view their status.

• Access Knowledge Base without Login.

• Generate proposal from product catalogue and convert to quote.

Prerequisites

Follow the points given below before you start installing:

• You should login as an Administrator in SugarCRM.

• Check that your SugarCRM Instance is compatible for Customer Portal.

• You must have a valid License Key Provided by CRMJetty.

• If you are installing Customer Portal, then make sure there should not be any other Customer Portal already installed on Sugar CRM. If there is any then you should have to uninstall that plug-in first.

• If you are having same portal's older version than upgrade it.

• Check your WordPress portal has compatibility with Customer Portal.


BIZ/UMP/G1 Public 2

• You should be able to login as an admin in your WordPress portal site.

• Make sure that Customer Portal Plugins related files has proper file permissions. As per the SugarCRM Install and upgrade guideline, we advise you to give 755 recursive file permissions to custom and modules directory of your CRM instance.

Installation

• On purchase of customer portal from CRMJetty, you will receive a zip. Once you extract the zip you

will get two zip i.e. one for CRM(SugarCRM) and other one for CMS(WordPress).

SugarCRM Plug-in Installation

• To start with the installation, Log-in as Administrator into SugarCRM. Navigate to the Administration

page and click on ‘Module Loader’ to install the package.

• Browse the SugarCRM Package zip file and click on ‘Upload’ button.

• After uploading the package, click on ‘Install’ button to install the package.


BIZ/UMP/G1 Public 3

• Click on ‘Commit’ button to finish the installation. After successful installation you can see

‘sugarcrm - customer-portal’ Plug-in in Installed plug-in list on Module Loader page.

• Now, need to repair your SugarCRM 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 Plugins module. Here you can see

the Add New Button. Click on ‘Add New’ button which will redirect you to Add Plugins Page.

• Click on ‘Upload Plugin’ button. Browse the WP-Plugin-Package zip and Install the Plugin.


BIZ/UMP/G1 Public 4

• Go to Installed Plugins screen. Here, you can see SugarCRM Customer Portal plugin was successfully

installed. But still it’s Inactive.

• Click on ‘Activate’ to activate this newly installed plugin.


BIZ/UMP/G1 Public 5

Plug-in Configuration

SugarCRM Configuration Settings

Get activation key

• Get the activation key from the Order Confirmation Mail. OR

• Login to your 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 SugarCRM 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.


BIZ/UMP/G1 Public 6

• 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 SugarCRM

based on Contact creation. When any contact is created in SugarCRM, 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 SugarCRM.

http://store.biztechconsultancy.com/


BIZ/UMP/G1 Public 7

Set Portal Layout

• To avail SugarCRM 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 SugarCRM.

• To Set Portal layouts navigate to Administration - > Configure Portal layout. Select your desired

User Group and respective module for Layout setting from the dropdown.

• Set layouts for Edit view, Detail view and List view. Drag and drop fields from left column to the

right. After populating the layout, click on ‘Save’ button to save the layout.

• Besides every field in layout there is one settings option which help you to add help tip and portal

label for your portal field.


BIZ/UMP/G1 Public 8

• After populating the layout, click on ‘Save’ button to save the layout.

• You can also navigate to “Mass Settings” option from portal layout page.

• It provides you to manage various field settings, which are listed below: -

o Help tip: This attribute will be shown as a tooltip regarding respective field in portal.

o Read-only: This attribute will restrict user to edit respective field’s value.

o Required: This attribute will allow user to make fields mandatory.

Note: You can only make fields mandatory if they are not default required fields from CRM.

o Label: This attribute will hold CRM label value but if user wants customized label for

portal, this attribute is helpful.


BIZ/UMP/G1 Public 9

Set Module Accessibility for Portal Users • Customer Portal provides feature to manage SugarCRM Module’s accessibility for their WordPress

portal users. You can decide access of which module should be provided to which customer by

WordPress User Group module.

• Click on ‘Customer Portal User Group’ link and you will be redirected to the WordPress User Group

Module’s List View. Here, you can see ‘Default’ WordPress User Group already exist in the list. User

cannot delete this ‘Default’ group record.

• Admin can create different ‘User Group’ and define accessible modules for that group.

Note: By default, ‘Default’ group will be assigned to a newly created contact record.

• You can also define advance configuration for different user groups for the features like case

deflection and Calendar accessibility.


BIZ/UMP/G1 Public 10

• While creating cases from portal “Case deflection” helps you customers to find the probable

solutions. If no relevant solutions are found, then customer can proceed to add the case.

• It will search a solution for the enabled “Case Deflection Categories” (which belongs to

Knowledgebase Categories of CRM). So, on enabling “Case deflection” you will be settings

categories to be search while finding a solution.

Note: Case Deflection will only work if Knowledge Base module is enabled and Category is selected.

• You can also enable calendar only for specific user groups.

Note: Calendar will only be enabled if Calls or Meeting module is enabled.

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, you can see ‘Knowledge Base’ sub-panel.



• Select the articles or create the new one which you want to display on portal end. These articles will

get accessible for this particular user group customers. You can also enable/disable portal visible

option from the detail view of article.

Set Dynamic access rights for Portal Users.

• Customer portal provides feature to manage SugarCRM Module’s accessibility for their WordPress

portal users. You can decide access of which module should be provided to which customer by

WordPress User Group module.

• Click on ‘Customer Portal User Group’ link and you will be redirected to the WordPress User Group

Module’s List View. Here, you can see “Default” WordPress User Group in the list. User cannot

delete this ‘Default’ group record.



• Admin can create different “Customer Portal User Group” to provide access to certain defined

modules. Admin can also set dynamic access rights for each accessible module.

• To provide dynamic access rights to portal users, create a WordPress User Group and save it. You

will get a list of Portal enabled modules.

• To disable a module, select ‘Disable’ option from the status dropdown. To provide dynamic access

rights of ‘Create’, ‘Edit’ and ‘Delete’ check the boxes against each enabled module.



Set Sub-Panel Accessibility for Portal Users.

• Customer portal provides feature to manage SugarCRM 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.

• To provide sub-panel access rights to portal users, create a WordPress User Group and save it. You

will get a list of Portal enabled modules.

• Check the last box provided for sub-panel’s visibility in portal.



Note: For calls and meetings module, if you want to get data listed in sub-panel then you need to make then “Portal Visible”. Follow below steps to make call or meeting portal visible. • Navigate to detail view of call or meetings which you want to make “portal visible”.



• Click on Edit option from detail view to edit call or meeting.

• From Portal visibility tab check the box to make call or meeting portal visible and view them in sub-

panel.

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 fields in record view or create view, 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.

• Sugar 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

Single Site Settings

• Go to WordPress Admin part and click on ‘Customer Portal’ and configure SugarCRM portal setting

options.

• Select appropriate name for your portal.

• Enter your CRM instance URL and CRM Admin credentials (Username and Password).

• You can enable/disable registration for portal. If this box is unchecked, new user cannot sign up

from portal.

• 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.

• You can also choose a template from the dropdown menu.



Note: Choose ‘Full Width Page’ template for existing theme header and footer.

• You can also add re-captcha option for login, signup and forgot password page to protect your

website from spam and abuse.



• Add reCaptcha Site Key and reCaptcha Secret Key, then configure for pages and save it.

Note: Get details to generate reCaptcha Site Key and reCaptcha Secret Key, navigate Here. We support

reCaptcha v2.0

Multi-site Settings

• 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.

https://developers.google.com/recaptcha/intro



• 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

Module Ordering

• To set the order of module click "Customer Portal -> Module Ordering" it will navigate to Module

ordering page.

• Now Drag and Drop modules for reordering and save updated order.

• It will reflect the same order in portal dashboard and drawer.



Approval and Verification for Portal Users

• If you want to provide access for portal only to them who is approved by 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 in portal when that language is selected on

portal end.

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 action’s 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 Customer 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.

Tawk.to Chat Plugin Installation

• To install Tawk.to chat plugin, navigate to Plugins and click on the ‘Add New’ button which will

redirect you to Add Plugins Page.

• Now, search for Tawk.to Live Chat plugin. Install and activate the plugin in your WordPress account.



• After activating the plugin, navigate to the settings page of tawk.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’ button. This would

enable the chat widget in your portal.

• Here, you will find an API Key, which you need to enter in your SugarCRM instance to save chat

transcripts.

• Copy the API Key and navigate to Admin page from your SugarCRM account.

• Now, configure inbound email in CRM to create cases for each chat transcript. To configure inbound

email, navigate to Emails -> 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 ‘General Configuration’ link. This would open up Portal Chat Configuration, Email template

for new registration user in portal and Portal Chart Configuration settings page.



• Paste the tawk.to API key here and click on ‘Save’ button. Once the plug-in is configured at both

the ends, you can start chatting with the Portal Users.

• Select appropriate email template from drop-down for New Registered User and Forgot

Password.

• If appropriate template is not available, click on "Create" to design your own email template and

you can even select any template from drop-down and click "Edit" to make changes as per your

requirement.

• Configure charts for "Case" and "Quotes" modules to keep track of status.



• You can also set auto delete notification period. So that after the period notification will be automatically

deleted.

• Select default language for portal. So, by default portal will work on that selected language.



Contact Us We simplify your business, offer unique business solution in digital web and IT landscapes.

Customization: If you would like to customize or discuss about additional feature for Customer Portal, please write to

[email protected]

Live Chat

• Get instant support with our Live Chat.

• Visit our product page at:

https://www.crmjetty.com/sugarcrm-wordpress-customer-portal.htm and click on the Live Chat button for instant support.

Tickets

• Raise tickets for your specific question!

• Send an email to [email protected] Or

you can login to your account @

www.crmjetty.com and click on My Support

Tickets on your account dashboard, to get

answers to your specific questions.

mailto:[email protected]

https://www.crmjetty.com/sugarcrm-wordpress-customer-portal.htm

https://www.crmjetty.com/sugarcrm-wordpress-customer-portal.htm

mailto:[email protected]

http://www.crmjetty.com/

Date post:	20-Jun-2020
Category:	Documents
Upload:	others
View:	3 times
Download:	0 times