user manual table of contents...user manual: suiteport - suitecrm customer portal for joomla 15...

USER MANUAL

SuitePort - SuiteCRM

Customer Portal for Joomla

Version: 1.1.0

Joomla Compatibility:

Joomla: 3.x

SuiteCRM Compatibility:

SuiteCRM: 7.4. * to 7.9

TABLE OF CONTENTS

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

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

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

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

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

Joomla Manual Plug-in installation................ 3

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

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

Joomla Configuration Settings .....................10

Front Side Instructions .................................12

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

USER MANUAL: SuitePort - SuiteCRM Customer Portal for Joomla

www.appjetty.com 1

Introduction

This “SuiteCRM Customer Portal” plugin will help your customers to use several SuiteCRM modules in their Joomla 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 Joomla customer interface. It will simplify and reduce your task of communicating with your Joomla 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 Joomla customers better by integrating SuiteCRM and Joomla platforms and connecting your Joomla users with your SuiteCRM system. The SuiteCRM Customer Portal will provide you the following benefits:

• Interactive Dashboard with recent records and quick access icons

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

• Case attachments

• Calendar view for all scheduled activities

• View all updated data reflected in your SuiteCRM dashboard whenever your customers make any

update from the portal.

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 Joomla portal has compatibility with Customer Portal.

• You should be able to login as an admin in your Joomla 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

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

Joomla Manual Plug-in installation

• Login to your Joomla portal from Joomla-dashboard and navigate to

Extensions -> Manage -> Install.

• Click on ‘Choose File’ and select the extension package or install from folder or install from URL by

entering the path.


www.appjetty.com 4

• Click on Upload & Install.

• After Plugin is Uploaded &Installed successfully navigate to Extension -> Manage as plugin are not

enabled by default.

• To enable the Plugin find the plugin from the list of plugin, Select the Plugin and Enable the 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 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.

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


www.appjetty.com 6

Set Portal Layout

• To avail SuiteCRM modules into your Joomla 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 7

Set Module Accessibility for Portal Users

• Customer portal provides feature to manage SuiteCRM Module’s accessibility for their Joomla

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

Joomla User Group module.

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

Module’s List View. Here, you can see “Default” Joomla 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 8

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

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 9


www.appjetty.com 10

Joomla Configuration Settings

• Go to Joomla dashboard and navigate to Components -> Customer Portal to configure Suite CRM

portal.

• To Configure enter your Suite CRM instance URL and Suite CRM admin credentials (Username and

Password).

• Select appropriate SuiteCRM version to connect with your Suite CRM Instance.


www.appjetty.com 11

• You can choose activities to be displayed on your portal dashboard from ‘Recent Activities On

Dashboard’. Also, you can set the user registration mail subject and message as per the

requirement, upload a logo image for your portal and set a portal name for your portal.

• There are also various other configuration options on this page like Records Per Page you wish to

display on main menu, Color for setting activities on calendar like calls and meetings. ‘Custom CSS’

option as per the need.


www.appjetty.com 12

Front Side Instructions

After completing all configurations at SuiteCRM and Joomla portal for Customer Portal plug-in,

Customer can sign-up or login to Customer Portal and access SuiteCRM modules as the assigned Portal

user group.

Login:

• Directly login to the portal using your portal credentials.


www.appjetty.com 13

Sign Up:

• Customer can sign-up to the Joomla Portal by clicking on ‘Sign Up Now!’ link on the Login Page.

On click 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 SuiteCRM Contacts module.

• Once signed-up from the Portal, User can directly login to the Portal and can also access his

Joomla Account without having to login again.

• Note: Already existing customers on both sides (Joomla and Suite) won’t get the access for

Customer Portal automatically on installation.


www.appjetty.com 14

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

After successful registration user will be redirected to the login page. Now user can login to portal

with their Username and Password.

Forgot Password:

• Portal user can retrieve their login password using the ‘Forgot Password’ option. 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.


www.appjetty.com 15

Portal Dashboard:

• Quickly access any module using the module icons. Joomla 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 on dashboard as well as top modules.


www.appjetty.com 16

List View:

• Navigate to any module and you will be able to see the list of records of that module. You can

search a record from the list view, delete it or update it.

• You can also add a new record to that module. To add a new record, 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 ‘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 19

Calendar Page:

• You can view Phone Calls and Meetings on calendar for particular a date with time.


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/suitecrm-Joomla-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-joomla-customer-portal.htm

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

mailto:[email protected]

https://www.appjetty.com/