SuiteCRM Customer Portal

INSTALLATION GUIDE
Introduction 1
Benefits of Customer Portal 1
Prerequisites 1
Installation 2
SuiteCRM Plug-in Installation 2
Plug-in Configuration 3
SuiteCRM Configuration Settings 3
Portal Configuration Settings 10
Front Side Instructions 13
Contact Us 23
SuitePort -Customer
Portal for SuiteCRM
Version: 1.0.1
SuiteCRM Compatibility
SuiteCRM: 7.4.* to 7.9
TABLE OF CONTENTS

INSTALLATION GUIDE: SuitePort - Customer Portal for SuiteCRM
Introduction
SuitePort – Customer Portal for SuiteCRM is a self service customer portal solution that uses a php
based front end framework and SuiteCRM as the backend system powering the portal and all its data. As
portal users, your customers will get a dedicated dashboard and can get access to and update all
relevant data of accounts,
contacts, meetings, calls, cases, etc from your SuiteCRM system. It will simplify and reduce your task of
communicating with your customers through other means.
Benefits of Customer Portal
SuitePort – Customer Portal for SuiteCRM will provide you the following benefits:
 Interactive Dashboard with recent records and quick access icons
 Assign accessible roles for each module
 Sign-up directly from the portal
 Case commenting option
 Calendar view for all scheduled activities
 Add activities directly from calendar
 Accept or Decline Quotes from Portal, Download Quotes from Portal in PDF format.
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.
Server Requirements:
 HTTP Server. For example: Apache. Having mod_rewrite is On
 PHP 5.6.0 or greater (including PHP 7.1).
 mbstring PHP extension enabled
 intl PHP extension enabled
 Database Requirements - MySQL (5.1.10 or greater)
www.appjetty.com 1

Installation
SuiteCRM Plug-in Installation
 To start with the installation, Log-in as Administrator into SuiteCRM.
Administration page and click on ͚Module Loader͛ to install the package.
Navigate to the
 Browse the SuiteCRM Package zip file and click on ͚Upload͛ button.
 After uploading the package, click on ͚IŶstall͛ button to install the package.
www.appjetty.com 2

 Click on ͚Coŵŵit͛ button to finish the installation. After successful installation you can see
͚Custoŵer 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.
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 3

 Now click on ͚LiĐeŶse CoŶfiguratioŶ͛ 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.
Set Portal Layout
 To avail SuiteCRM modules into your portal, it is mandatory to set Portal Layouts for each
accessible module. Customer Portal plug-in provides facility to set Portal Layouts for Accounts,
Calls, Meetings, Notes, Cases, Documents and Quotes module from SuiteCRM.
www.appjetty.com 4

 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 ͚Saǀ e͛ button to save the layout.
Set Module Accessibility for Portal Users
 Customer portal provides feature to manage SuiteCRM Module͛s aĐĐessiďilitǇfoƌ theiƌ WoƌdPƌess
portal users. You can decide access of which module should be provided to which customer by
WordPress User Group module.
www.appjetty.com 5

 Click on ͚Custoŵer Portal User Group͛ link and you will be redirected to the WordPress User
Gƌoup Module͛s List Vieǁ . 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.
Note: BǇ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 aĐĐessiďilitǇ foƌ theiƌ Portal
users. You can decide access of which module should be provided to which customer by Portal
User Group module.
www.appjetty.com 6

 Click on ͚Custoŵer Portal User Group͛ link and you will be redirected to the Portal User Group
Module͛s List Vieǁ . Heƌe, Ǉou ĐaŶ see ͞Default͟ Portal User Group in the list. User can not delete
this ͚Default͛ group record.
 AdŵiŶ ĐaŶ Đƌeate diffeƌeŶt ͞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 Portal User Group and save it. You will
get a list of Portal enabled modules.
 To disable a module select ͚Disaďle͛ 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 7

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 ͚EŶaďle Portal͛ checkbox will be enabled for a newly created contact.
 Uncheck the ͚EŶaďle Portal͛ checkbox to disable the portal accessibility to any user.
www.appjetty.com 8

www.appjetty.com 9

Portal Configuration Settings
Follow below steps to configure portal with your server.
Note: Skip the below steps if your installation is already done.
1. Extract Customer-Portal-v1.zip file in your system.
2. Upload all files to your server with FTP OR cpanel.
3. Create a fresh database in your mysql server.
4. Find customer_portal_db.sql file in customer_portal folder and import same in your
database.
5. For configuration settings, Navigate to your portal directory/config/app.php file and open it
in editor.
6. After opening of file move to line no. 58 and find ͚APP_URL͛, ͚ADMIN_URL͛, ͚FRONT_URL͛
aŶd ͚DISPLAY_IMAGE͛ variables.
o If your portal is in sub directory then you have to provide subdirectory folder
name after host. Please update above mentioned variables with same (if
needed)
o If your portal is on root directory then no need to change anything.
3. Now move to line no. 252 and find database configuration details here.
o Now add your database details here as below.
'host' => 'Your host detail',
'username' => 'Your database username',
'password' => 'Your database password',
'database' => 'Your database name',
8. You can login into poƌtal adŵiŶ ǁ ith addiŶg ͚/adŵiŶ͛ at the eŶd of Ǉouƌpoƌtal diƌeĐtoƌǇaŶd
press enter to navigate for admin panel.
9. Use below credentials to login into system admin:
Username:admin@admin.com
Password: A1234567
10. Once login, you can update credentials from your profile page.
11. All Done! Portal is ready to use.
12. Follow user manual guide to get connected to CRM and make portal available to your
customers.
 Once to above mentioned steps are completed and installation is done, Login to your portal
admin side.
www.appjetty.com 10

 Select appropriate SuiteCRM version to connect with your SuiteCRM Instance.
 Enter your SuiteCRM instance URL and SuiteCRM Admin credentials (Username and Password).
 User can add appropriate portal name and logo.
www.appjetty.com 11

 There are also various other portal layout options on this page like option to change theme,
change color for meetings or theme.
 You can also choose the multiple modules for listing their recent activities on dashboard.
www.appjetty.com 12

Front Side Instructions
After completing all configurations at SuiteCRM and portal for Customer Portal plug-in, Customer can
sign-up or login to Customer Portal and access SuiteCRM modules in Portal.
Login:
 Directly login to the portal using your portal credentials.
www.appjetty.com 13

Sign Up:
 Customer can sign-up to the Portal by clicking on ͚SigŶ Up͛ link on the Login Page. 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 Portal and SuiteCRM Contacts module.
 Once signed-up from the Portal, User can directly login to the Portal and can also access his Portal
Account without having to login again.
Note: AlƌeadǇeǆistiŶg Đustoŵeƌs ǁ oŶ͛t get the aĐĐess foƌCustoŵeƌPoƌtal autoŵatiĐallǇon installation.
 On Sign up, it will check if any customer is registered with same username and email address. If no
such user exists in the system then it will create a record in the SuiteCRM͛s CoŶtaĐts ŵodule. After
successful registration user will be redirected to the login page. Now user can login to portal with
their Username and Password.
www.appjetty.com 14

Forgot Password:
 Poƌtal useƌ ĐaŶ ƌetƌieǀe theiƌ logiŶ passǁ oƌd usiŶg the ͚Foƌgot Passǁ oƌd͛ liŶk. CliĐk oŶ ͚Foƌgot
Passǁ oƌd͛ liŶk aŶd eŶteƌ the useƌŶaŵe aŶd eŵail addƌess. CliĐk oŶ ͚Suďŵit͛ ďuttoŶ to ƌeĐeiǀe a
password on the registered email address.
www.appjetty.com 15

Portal Dashboard:
 Quickly access any module using the module icons. Portal 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.
 Dashboard also includes recent activities.
www.appjetty.com 16

List View:
 Navigate to any module to view the list of records in that module. Search a record from the list
view, delete it or update it.
 To add a new record in the module click on the ͚Add͛ button.
www.appjetty.com 17

Add Record:
 Add a new record in a module from the portal and it will get reflected in the SuiteCRM.
www.appjetty.com 18

Detail Page:
 Click on the ͚Vieǁ ͛ button from the List View and view the details of a record. You can edit that
record or delete it from the detail view.
www.appjetty.com 19

Calendar Page:
 View or add Calls and Meetings from the calendar for a particular date.
www.appjetty.com 20

View Quotes, Invoices and Contracts:
 View or Download Quotes, Invoices and Contracts added by admin from SuiteCRM side in Portal.
 To download the PDF version of Quotes, Invoices or Contracts click on the download icon under
͚AĐtioŶs͛ column.
Accept or Decline Quote from Portal:
 A button to accept or decline the quote will appear in the detail view of a quote when it reaches
͞ĐoŶfiƌŵed͟ stage.
 OŶ ĐliĐkiŶg ͞AĐĐept͟ ďuttoŶ the Ƌuote stage ĐhaŶges to ͞Closed AĐĐepted͟ aŶd oŶ ĐliĐkiŶg
͞DeĐliŶe͟ ďuttoŶ the Ƌuote stage ĐhaŶges to ͞Closed Dead͟.
 Note: This cannot be changed again from the portal.
www.appjetty.com 21

Knowledge Base:
 Access the Knowledge Base module of SuiteCRM from portal to view question and answers based
on category.
www.appjetty.com 22

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
sales@appjetty.com
Live Chat
 Get instant support with our Live Chat.
 Visitour productpageat:
https://www.appjetty.com/suitecrm-customer-
portal.htm and clickontheLiveChatbuttonfor
instant support.
Tickets
 Raise tickets for your specific question!
 Send an email to support@appjetty.com or you
can login to your account @
www.appjetty.com and click onMy Support
Tickets on your account dashboard, to get
answers to your specific questions.
www.appjetty.com 23

SuiteCRM Customer Portal

Recommended

Recommended

More Related Content

What's hot

What's hot (20)

Similar to SuiteCRM Customer Portal

Similar to SuiteCRM Customer Portal (20)

More from AppJetty

More from AppJetty (20)

Recently uploaded

Recently uploaded (20)

SuiteCRM Customer Portal