USER MANUAL. SuiteCRM Customer Portal for Joomla TABLE OF CONTENTS. Version: 2.0

Transcription

1 USER MANUAL 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 SuiteCRM Customer Portal for Joomla Joomla Configuration Settings Front Side Instructions Contact Us Version: 2.0 Joomla Compatibility: Joomla: 3.x SuiteCRM Compatibility: SuiteCRM: 7.4. * to *

2 Introduction SuiteCRM Customer Portal plugin will help your customers to use several SuiteCRM modules in their Joomla interface, which you can define from the admin front. The plugin integrates Accounts, Contacts, Calls, Meetings, Notes, Cases, Documents, and Quotes modules 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 user of SuiteCRM, you can 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 scheduled activities View all updated data reflected in your SuiteCRM dashboard whenever your customers make any update from the portal. Prerequisites Follow the below given points 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 CRMJetty. If you are installing Customer Portal, make sure there is no older version of Customer Portal Pluginstalled on your SuiteCRM. In case there is, you might have to uninstall that plug-in first. Check if your Joomla portal is compatible with Customer Portal. You should be able to login as an admin in your Joomla portal site BIZ/UMP/G1 Public 1

3 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. BIZ/UMP/G1 Public 2

4 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, you 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. BIZ/UMP/G1 Public 3

5 Click on Upload & Install. After the plugin has been uploaded and installed successfully, navigate to Extension -> Manage as plugins are not enabled by default. To enable the plugin, find the plugin from the list, select and enable it. BIZ/UMP/G1 Public 4

6 Plug-in Configuration SuiteCRM Configuration Settings Get activation key Get the activation key from the Order Confirmation Mail. OR Login to your account. Thereafter, 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 SuiteCRM as Admin and go to Administrator Page. You can see the Customer Portal section on this page. Now click on License Configuration link and will re-direct you to Portal Configuration page. Enter the license activation key provided by CRMJetty. Validate your license by clicking the Validate button. BIZ/UMP/G1 Public 5

7 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. BIZ/UMP/G1 Public 6

8 To set Portal Layouts, navigate to Administration -> Configure Portal layout. Select your desired Module for Layout setting from the dropdown. Set layouts for Edit, Detail and List Views. Drag and drop fields from left column to the right. After populating the layout, click on Save button to save the layout. 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 cannot delete this Default group record. Admin user can create different User Group and define accessible modules for that group. BIZ/UMP/G1 Public 7

9 Note: By default, Default group will be assigned to a newly created contact record. If any group is deleted, then all assigned records are auto assigned to Primary Group. Set Dynamic access rights 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 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. BIZ/UMP/G1 Public 8

10 To provide dynamic access rights to portal users, create a Joomla 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 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. BIZ/UMP/G1 Public 9

11 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. Generate Mass Credentials: Generate portal credentials for already created CRM contacts and convert these contacts to Portal Users from SuiteCRM in a single click. An will be sent to these users with their Portal credentials. BIZ/UMP/G1 Public 10

12 To generate mass credentials, navigate to contacts module. Select contacts and click on Convert to Portal Contacts. Note: If there is no mail address or it is already a converted contact then it will not be converted to portal contact. Once the contacts are converted to portal users, admin can export the list of converted portal contacts as a CSV file. General Portal Configuration General portal configuration allows you to configure Joomla URL for template of new registration user in portal. For adding URL navigate to admin -> General Portal Configuration. Add Joomla portal URL and select template for newly registered user and forgot password. You can also create new template or edit the existing one. BIZ/UMP/G1 Public 11

13 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. 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. BIZ/UMP/G1 Public 12

14 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. BIZ/UMP/G1 Public 13

15 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. BIZ/UMP/G1 Public 14

16 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 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. BIZ/UMP/G1 Public 15

17 On Sign up, it will check if any customer is registered with same username and 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 address. Click on Submit button and you will receive your password on your . BIZ/UMP/G1 Public 16

18 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. BIZ/UMP/G1 Public 17

19 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. BIZ/UMP/G1 Public 18

20 Add Record: Add a new record in a module from the portal and it will get reflected in the SuiteCRM. BIZ/UMP/G1 Public 19

21 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. BIZ/UMP/G1 Public 20

22 Calendar Page: You can view Phone Calls and Meetings on calendar for particular a date with time. BIZ/UMP/G1 Public 21

23 Contact Us We simplify your business, offer unique business solution in digital web and IT landscapes. Live Chat Get instant support with our Live Chat. Visit our product page at: and click on the Live Chat button for instant support. Tickets Raise tickets for your specific question! Send an to or you can login to your and click on My Support Tickets on your account dashboard, to get answers to your specific questions. Customization: If you would like to customize or discuss about additional feature for Customer Portal, please write to sales@crmjetty.com BIZ/UMP/G1 Public 22