SuitePort - SuiteCRM Customer Portal for WordPress · PDF fileSuitePort - SuiteCRM Customer Portal for WordPress ... User Redirection is only for Multisite WordPress Account

USER MANUAL

SuitePort - SuiteCRM

Customer Portal for

WordPress

Version: 2.4.1

WordPress Compatibility

WordPress: 3.6.1 to 4.9.5

SuiteCRM Compatibility

SuiteCRM: 7.4.* to 7.10.2

TABLE OF CONTENTS

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

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

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

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

SuiteCRM Plug-in Installation ......................... 2

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

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

SuiteCRM Configuration Settings ................... 5

WordPress Configuration Settings ...............12

Module Ordering...........................................16

Convert CRM contacts to Portal Users ........18

Twak.to Chat Plugin Installation ...................20

Contact Us .....................................................28

USER MANUAL: SuitePort - SuiteCRM Customer Portal for WordPress

www.appjetty.com 1

Introduction

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

Benefits of Customer Portal Being a proud user of SuiteCRM you can now manage your WordPress customers better by integrating SuiteCRM and WordPress platforms and connecting your WP users with your SuiteCRM system. The SuiteCRM 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 SuiteCRM • Case commenting option

• Twak.to Chat Plugin Integration. Capture chat conversations in SuiteCRM

• Calendar view for all scheduled activities. Add activities directly from calendar.

• Accept or Decline Quotes from Portal

• Download Quotes from Portal in PDF format.

• Global search across all module.

• Quick Add records for specific modules.

• Download Quotes, Invoices and Contracts from Portal in PDF format.

• Access of knowledge Base without Login.

Prerequisites

Following points must be followed before starting Installation.

• You should login as an Administrator in SuiteCRM.

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

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

• If you are installing Customer Portal then make sure there should not be any older version of

Customer Portal Plug-in already installed on SuiteCRM. If there is any then you should have to

uninstall that plug-in first.

• Check your WordPress portal has compatibility with Customer Portal.

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


www.appjetty.com 2

Installation

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.


www.appjetty.com 3

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


www.appjetty.com 4

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


www.appjetty.com 5

Plug-in Configuration

SuiteCRM Configuration Settings

Get activation key

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

• Login to your AppJetty account then go to downloadable options and copy the activation key

for the Customer Portal plug-in.

Note: Applicable only if purchased from AppJetty.

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.


www.appjetty.com 6

• Now click on ‘License Configuration’ link, this will re-direct you to Portal Configuration page.

• Enter your license activation key provided by AppJetty. 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.


www.appjetty.com 7

Note: WordPress portal URL configuration is mandatory for Portal user creation from SuiteCRM.

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 Set Portal layouts navigate to Administration - > Configure Portal layout. Select your

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


www.appjetty.com 8

Set Module Accessibility for Portal Users • Customer portal provides feature to manage SuiteCRM 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 can not delete this ‘Default’ group record.

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


www.appjetty.com 9

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

Set Dynamic access rights for Portal Users.

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

can not delete this ‘Default’ group record.


www.appjetty.com 10

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


www.appjetty.com 11

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.


www.appjetty.com 12

WordPress Configuration Settings

Single Site Settings

• Go to WordPress admin side and click on ‘Customer Portal’ and configure SugarCRM portal

setting options.

• Select appropriate SugarCRM version to connect with your SugarCRM Instance.


www.appjetty.com 13

• Enter your SugarCRM instance URL and SugarCRM 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.


www.appjetty.com 14

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.

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


www.appjetty.com 15

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


www.appjetty.com 16

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


www.appjetty.com 17

Module Ordering

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

Module ordering page.


www.appjetty.com 18

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

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

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.


www.appjetty.com 19

• Now to create WordPress Users, import the csv file in WordPress Portal. To import the file in

WordPress, navigate to Employee Portal >> Import Users


www.appjetty.com 20

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

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.


www.appjetty.com 21

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


www.appjetty.com 22

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


www.appjetty.com 23

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


www.appjetty.com 24

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


www.appjetty.com 25


www.appjetty.com 26

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


www.appjetty.com 27

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


www.appjetty.com 28

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.appjetty.com/suitecrm-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.appjetty.com and click on My Support

Tickets on your account dashboard, to get

answers to your specific questions.

mailto:[email protected]

https://www.appjetty.com/suitecrm-wordpress-customer-portal.htm

https://www.appjetty.com/suitecrm-wordpress-customer-portal.htm

mailto:[email protected]

https://www.appjetty.com/