SugarPort -Customer Portal for Sugar CRM€¦ · Sugar CRM Plug-in Installation • To start with the installation, Log-in as Administrator into Sugar CRM. Navigate to the Administration

USER MANUAL

SugarPort -Customer

Portal for Sugar CRM

Version: 1.1.0

Sugar CRM Compatibility

Community Edition: 6.5* to 6.5.25

Professional Edition: 6.5* to 7.9.0.1

Enterprise Edition: 6.5* to 7.9.0.1

TABLE OF CONTENTS

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

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

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

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

Sugar CRM Plug-in Installation .................... 2

Plug-in Configuration ....................................... 3

Sugar CRM Configuration Settings .............. 3

Portal Configuration Settings ...................... 8

Front Side Instructions .................................. 10

Contact Us ...................................................... 20

USER MANUAL: SugarPort - Customer Portal for Sugar CRM

www.appjetty.com 1

Introduction

SugarPort – Customer Portal for Sugar CRM is a self-service customer portal solution that uses a php based front end framework and Sugar CRM 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 Sugar CRM system. It will simplify and reduce your task of communicating with your customers through other means.

Benefits of Customer Portal

SugarPort – Customer Portal for Sugar CRM 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

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

• Check that your Sugar CRM 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 Sugar CRM. If there is any then you should have to uninstall that plug-in first.

Portal 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 2

Installation

Sugar CRM Plug-in Installation

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

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

• Browse the Sugar CRM 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 ‘Sugar

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


www.appjetty.com 3

• Now, need to repair your Sugar CRM Instance. For that, navigate to Administration page and click

on ‘Repair’ link, then click on ‘Quick Repair and Rebuild’ link.

Plug-in Configuration

Sugar CRM 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 Sugar CRM as admin and go to Administrator Page. You can see the ‘Customer

Portal’ section on this page.


www.appjetty.com 4

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

Set Portal Layout

• To avail Sugar CRM 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,

Contacts, Calls, Meetings, Notes, Cases, Documents and Quotes module from Sugar CRM.

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

Module for Layout setting from the dropdown.

http://store.biztechconsultancy.com/


www.appjetty.com 5

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

Set Dynamic access rights for Portal Users.

• Customer portal provides feature to manage Sugar CRM Module’s accessibility for their portal

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

User Group module.

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

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

this ‘Default’ group record.


www.appjetty.com 6

• Admin can create different User Groups 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 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 7

Set Username and Password Fields in Contacts Layout

• When you install this package username and password 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, 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.

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


www.appjetty.com 8

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.2.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’ and

‘DISPLAY_IMAGE’ variables.

a. 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)

b. If your portal is on root directory then no need to change anything.

7. Now move to line no. 252 and find database configuration details here.

a. 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 portal admin with adding ‘/admin’ at the end of your portal directory and

press enter to navigate for admin panel.

9. Use below credentials to login into system admin

Username: [email protected]

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. {your_domain}/admin


www.appjetty.com 9

• Select appropriate Sugar CRM version to connect with your Sugar CRM Instance.

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

• You can add appropriate portal name and logo.

• There are also various other portal layout options on this page like option to change theme,

change color for activities in calendar.

• You can also choose multiple modules for listing their recent activities as well as top modules on

dashboard.


www.appjetty.com 10

Front Side Instructions

After completing all configurations at Sugar CRM and portal for Customer Portal plug-in, Customer can

sign-up or login to Customer Portal and access Sugar CRM modules in Portal.

Login:

• Directly login to the portal using your portal credentials.


www.appjetty.com 11

Sign Up:

• Customer can sign-up to the Portal by clicking on ‘Sign 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 Sugar CRM 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: Already existing customers won’t get the access for Customer Portal automatically 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 Sugar CRM’s Contacts module.

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 12

Forgot Password:

• Portal user can retrieve their login password using the ‘Forgot Password’ link. Click on ‘Forgot

Password’ link and enter the username and email address. Click on ‘Submit’ button to receive a

password on the registered email address.


www.appjetty.com 13

Portal Dashboard:

• Quickly access any data from dashboard. 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 as well as top modules.


www.appjetty.com 14

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 15

Add Record:

• Add a new record in a module from the portal and it will get reflected in the Sugar CRM.


www.appjetty.com 16

Detail Page:

• Click on the ‘View’ 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 17

Calendar Page:

• View or add Calls and Meetings from the calendar for a particular date.


www.appjetty.com 18

View or Download Quotes from Portal:

• View or Download Quotes added by admin from Sugar CRM side in Portal.

• To download the PDF version of Quotes, click on the download icon under ‘Actions’ 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

“confirmed” stage.

• On clicking “Accept” button the quote stage changes to “Closed Accepted” and on clicking

“Decline” button the quote stage changes to “Closed Dead”.

Note: This cannot be reverted again from the portal.


www.appjetty.com 19

Knowledge Base:

• Access the Knowledge Base module of Sugar CRM from portal to view question and answers based

on category.


www.appjetty.com 20

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/sugarcrm-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/sugarcrm-customer-portal.htm

https://www.appjetty.com/sugarcrm-customer-portal.htm

mailto:[email protected]

https://www.appjetty.com/