470 likes | 658 Views
SuitePort from AppJetty is a self service customer portal plugin for SuiteCRM with a PHP based front end interface and SuiteCRM as the backend system. To Know More About Theme: https://www.appjetty.com/suitecrm-customer-portal.htm
E N D
INSTALLATIONGUIDE TABLEOFCONTENTS Introduction 1BenefitsofCustomerPortal 1Prerequisites 1Installation 2SuiteCRMPlug-inInstallation 2Plug-inConfiguration 3SuiteCRMConfigurationSettings 3PortalConfigurationSettings 10FrontSideInstructions 13ContactUs 23 SuitePort-Customer PortalforSuiteCRM Version:1.0.1 SuiteCRMCompatibility SuiteCRM:7.4.*to7.9
INSTALLATIONGUIDE:SuitePort-CustomerPortalforSuiteCRM • Introduction • SuitePort–CustomerPortalforSuiteCRMisaselfservicecustomerportalsolutionthatusesaphpbasedfrontendframeworkandSuiteCRMasthebackendsystempoweringtheportalandallitsdata.Asportalusers,yourcustomerswillgetadedicateddashboardandcangetaccesstoandupdateallrelevantdataofaccounts, • contacts,meetings,calls,cases,etcfromyourSuiteCRMsystem.Itwillsimplifyandreduceyourtaskofcommunicatingwithyourcustomersthroughothermeans. • BenefitsofCustomerPortal • SuitePort–CustomerPortalforSuiteCRMwillprovideyouthefollowingbenefits: • InteractiveDashboardwithrecentrecordsandquickaccessicons • Assignaccessiblerolesforeachmodule • Sign-updirectlyfromtheportal • Casecommentingoption • Calendarviewforallscheduledactivities • Addactivitiesdirectlyfromcalendar • AcceptorDeclineQuotesfromPortal,DownloadQuotesfromPortalinPDFformat. • Prerequisites • FollowingpointsmustbefollowedbeforestartingInstallation: • YoushouldloginasanAdministratorinSuiteCRM. • CheckthatyourSuiteCRMInstanceiscompatibleforCustomerPortal. • YoumusthaveavalidLicenseKeyProvidedbyAppJetty. • IfyouareinstallingCustomerPortalthenmakesurethereshouldnotbeanyolderversionofCustomerPortalPlug-inalreadyinstalledonSuiteCRM.Ifthereisanythenyoushouldhavetouninstallthatplug-infirst. • ServerRequirements: • HTTPServer.Forexample:Apache.Havingmod_rewriteisOn • PHP5.6.0orgreater(includingPHP7.1). • mbstringPHPextensionenabled • intlPHPextensionenabled • DatabaseRequirements-MySQL(5.1.10orgreater) www.appjetty.com
INSTALLATIONGUIDE:SuitePort-CustomerPortalforSuiteCRM Installation SuiteCRMPlug-inInstallation • Tostartwiththeinstallation,Log-inasAdministratorintoSuiteCRM.Administrationpageandclickon͚ModuleLoader͛toinstallthepackage. Navigate tothe • BrowsetheSuiteCRMPackagezipfileandclickon͚Upload͛ button. • Afteruploadingthepackage,clickon͚IŶstall͛buttontoinstallthepackage. www.appjetty.com
INSTALLATIONGUIDE:SuitePort-CustomerPortalforSuiteCRM • Clickon͚Coŵŵit͛ buttontofinishtheinstallation.Aftersuccessfulinstallationyoucansee • ͚CustoŵerPortal͛Plug-ininInstalledplug-inlistonModuleLoaderpage. • Now,needtorepairyourSuiteCRMInstance.Forthat,navigatetoAdministrationpageandclickon͚Repair͛ link,thenclickon͚QuickRepairandRebuild͛ link. • Plug-inConfiguration • SuiteCRMConfigurationSettings • Getactivationkey • GettheactivationkeyfromtheOrderConfirmationMail.OR • LogintoyourAppJettyaccountthengotodownloadableoptionsandcopytheactivationkeyfortheCustomerPortalplug-in. • Note:ApplicableonlyifpurchasedfromAppJetty. • Activateyourplug-in • Aftersuccessfulpackageinstallation,youneedtovalidateyourlicenseandconfigureyourPortal. • Log-intoyourSuiteCRMasadminandgotoAdministratorPage.Youcanseethe͚CustomerPortal͛sectiononthispage. www.appjetty.com
INSTALLATIONGUIDE:SuitePort-CustomerPortalforSuiteCRM • Nowclickon͚LiĐeŶseCoŶfiguratioŶ͛link,thiswillre-directyoutoPortalConfigurationpage. • EnteryourlicenseactivationkeyprovidedbyAppJetty.Validateyourlicensebyclickingthe • ͚Validate͛button. • SetPortalLayout • ToavailSuiteCRMmodulesintoyourportal,itismandatorytosetPortalLayoutsforeachaccessiblemodule.CustomerPortalplug-inprovidesfacilitytosetPortalLayoutsforAccounts,Calls,Meetings,Notes,Cases,DocumentsandQuotesmodulefromSuiteCRM. www.appjetty.com
INSTALLATIONGUIDE:SuitePort-CustomerPortalforSuiteCRM • ToSetPortallayoutsnavigatetoAdministration->ConfigurePortallayout.SelectyourdesiredModuleforLayoutsettingfromthedropdown. • SetlayoutsforEditview,DetailviewandListview.Draganddropfieldsfromleftcolumntotheright.Afterpopulatingthelayout,clickon͚Saǀe͛buttontosavethelayout. • SetModuleAccessibilityforPortalUsers • CustomerportalprovidesfeaturetomanageSuiteCRM Module͛saĐĐessiďilitLJfoƌtheiƌWoƌdPƌess portalusers.YoucandecideaccessofwhichmoduleshouldbeprovidedtowhichcustomerbyWordPressUserGroupmodule. www.appjetty.com
INSTALLATIONGUIDE:SuitePort-CustomerPortalforSuiteCRM • Clickon͚Custoŵer Portal User Group͛ linkandyouwillberedirectedtotheWordPressUserGƌoupModule͛sListVieǁ.Here,youcansee͚Default͛WordPressUserGroupalreadyexistinthelist.Usercannotdeletethis͚Default͛grouprecord. • Adminusercancreatedifferent͚User Group͛anddefineaccessiblemodulesforthatgroup. • Note:BLJdefault͚Default͛groupwillbeassignedtoanewlycreatedcontactrecord. • SetDynamicaccessrightsforPortalUsers. • CustomerportalprovidesfeaturetomanageSuiteCRMModule͛s aĐĐessiďilitLJfoƌtheiƌPortalusers.YoucandecideaccessofwhichmoduleshouldbeprovidedtowhichcustomerbyPortalUserGroupmodule. www.appjetty.com
INSTALLATIONGUIDE:SuitePort-CustomerPortalforSuiteCRM • Clickon͚CustoŵerPortalUserGroup͛ linkandyouwillberedirectedtothePortalUserGroupModule͛sListVieǁ.Heƌe,LJouĐaŶsee͞Default͟PortalUserGroupinthelist.Usercannotdeletethis͚Default͛grouprecord. • AdŵiŶĐaŶĐƌeatediffeƌeŶt ͞CustomerPortalUserGroup͟ toprovideaccesstocertaindefinedmodules.Admincanalsosetdynamicaccessrightsforeachaccessiblemodule. • Toprovidedynamicaccessrightstoportalusers,createaPortalUserGroupandsaveit.YouwillgetalistofPortalenabledmodules. • Todisableamoduleselect͚Disaďle͛optionfromthestatusdropdown.Toprovidedynamicaccessrightsof͚Create͛,͚Edit͛and͚Delete͛checktheboxesagainsteachenabledmodule. www.appjetty.com
INSTALLATIONGUIDE:SuitePort-CustomerPortalforSuiteCRM • SetUsernameandPasswordFieldsinContactsLayout • Whenyouinstallthispackageusernameandpasswordbothfieldsarecreatedincontactsmodule.ConfirmthatUsernameandPasswordfieldsareaddedtorecordview.IfyoucannotseeUsernameandPasswordfieldinrecordvieworcreateview,thenyoumayhavetosetthesefieldsinRecordlayouts. • ForthatGotoAdministrator->Studio->Contacts->Layouts->RecordandDraganddropthosefieldsinRecordViewandclickon͚SaveandDeploy͛ button. • SuiteadmincansetthePortalcredentialsforacontactandallowaccessofportaltothatcontact.Bydefaultthe͚EŶaďlePortal͛checkboxwillbeenabledforanewlycreatedcontact. • Uncheckthe͚EŶaďlePortal͛checkboxtodisabletheportalaccessibilitytoanyuser. www.appjetty.com
INSTALLATIONGUIDE:SuitePort-CustomerPortalforSuiteCRM www.appjetty.com
INSTALLATIONGUIDE:SuitePort-CustomerPortalforSuiteCRM • PortalConfigurationSettings • Followbelowstepstoconfigureportalwithyourserver. • Note:Skipthebelowstepsifyourinstallationisalreadydone. • 1.ExtractCustomer-Portal-v1.zipfileinyoursystem. • 2.UploadallfilestoyourserverwithFTPORcpanel. • Createafreshdatabaseinyourmysqlserver. • Findcustomer_portal_db.sqlfileincustomer_portalfolderandimportsameinyourdatabase. • Forconfigurationsettings,Navigatetoyourportaldirectory/config/app.phpfileandopenitineditor. • Afteropeningoffilemovetolineno.58andfind͚APP_URL͛,͚ADMIN_URL͛,͚FRONT_URL͛ aŶd͚DISPLAY_IMAGE͛variables. • Ifyourportalisinsubdirectorythenyouhavetoprovidesubdirectoryfoldernameafterhost.Pleaseupdateabovementionedvariableswithsame(if • needed) • Ifyourportalisonrootdirectorythennoneedtochangeanything. • Nowmovetolineno.252andfinddatabaseconfigurationdetailshere. • Nowaddyourdatabasedetailshereasbelow.'host'=>'Yourhostdetail', • 'username'=>'Yourdatabaseusername', • 'password'=>'Yourdatabasepassword','database'=>'Yourdatabasename', • YoucanloginintopoƌtaladŵiŶǁithaddiŶg͚/adŵiŶ͛attheeŶdofLJouƌpoƌtaldiƌeĐtoƌLJaŶd • pressentertonavigateforadminpanel. • 9.Usebelowcredentialstologinintosystemadmin:Username:admin@admin.com • Password:A1234567 • Oncelogin,youcanupdatecredentialsfromyourprofilepage. • AllDone!Portalisreadytouse. • FollowusermanualguidetogetconnectedtoCRMandmakeportalavailabletoyourcustomers. • Oncetoabovementionedstepsarecompletedandinstallationisdone,Logintoyourportaladminside. www.appjetty.com 10
INSTALLATIONGUIDE:SuitePort-CustomerPortalforSuiteCRM • SelectappropriateSuiteCRMversiontoconnectwithyourSuiteCRMInstance. • EnteryourSuiteCRMinstanceURLandSuiteCRMAdmincredentials(UsernameandPassword). • Usercanaddappropriateportalnameandlogo. www.appjetty.com
INSTALLATIONGUIDE:SuitePort-CustomerPortalforSuiteCRM • Therearealsovariousotherportallayoutoptionsonthispagelikeoptiontochangetheme,changecolorformeetingsortheme. • Youcanalsochoosethemultiplemodulesforlistingtheirrecentactivitiesondashboard. www.appjetty.com
INSTALLATIONGUIDE:SuitePort-CustomerPortalforSuiteCRM • FrontSideInstructions • AftercompletingallconfigurationsatSuiteCRMandportalforCustomerPortalplug-in,Customercansign-uporlogintoCustomerPortalandaccessSuiteCRMmodulesinPortal. • Login: • Directlylogintotheportalusingyourportalcredentials. www.appjetty.com
INSTALLATIONGUIDE:SuitePort-CustomerPortalforSuiteCRM • SignUp: • Customercansign-uptothePortalbyclickingon͚SigŶUp͛linkontheLoginPage.Clickingthislinkwillredirectcustomertosignuppageasbelow. • Anewusercandirectlysign-upfromthePortal.Thecredentialswillbeverifiedtocheckwhetheranycustomerhasbeenregisteredwithsameusernameandemailaddress.IfanysuchuserdoesnotexistinthesystemthenauserwillbecreatedinPortalandSuiteCRMContactsmodule. • Oncesigned-upfromthePortal,UsercandirectlylogintothePortalandcanalsoaccesshisPortalAccountwithouthavingtologinagain. • Note:AlƌeadLJedžistiŶgĐustoŵeƌsǁoŶ͛tgettheaĐĐessfoƌCustoŵeƌ PoƌtalautoŵatiĐallLJoninstallation. • OnSignup,itwillcheckifanycustomerisregisteredwithsameusernameandemailaddress.IfnosuchuserexistsinthesystemthenitwillcreatearecordintheSuiteCRM͛sCoŶtaĐtsŵodule.Aftersuccessfulregistrationuserwillberedirectedtotheloginpage.NowusercanlogintoportalwiththeirUsernameandPassword. www.appjetty.com
INSTALLATIONGUIDE:SuitePort-CustomerPortalforSuiteCRM • ForgotPassword: • Poƌtal useƌĐaŶƌetƌieǀetheiƌlogiŶpassǁoƌdusiŶgthe͚Foƌgot Passǁoƌd͛ liŶk. CliĐkoŶ͚Foƌgot Passǁoƌd͛liŶkaŶdeŶteƌtheuseƌŶaŵeaŶdeŵailaddƌess.CliĐkoŶ͚Suďŵit͛ďuttoŶtoƌeĐeiǀeapasswordontheregisteredemailaddress. www.appjetty.com
INSTALLATIONGUIDE:SuitePort-CustomerPortalforSuiteCRM • PortalDashboard: • Quicklyaccessanymoduleusingthemoduleicons.Portaladmincansettheaccessibilitytorecentlyaddedrecordsforportalusers.Accordinglythosemoduleswiththeirrecentrecordswillbedisplayedonthedashboard. • Dashboardalsoincludesrecentactivities. www.appjetty.com
INSTALLATIONGUIDE:SuitePort-CustomerPortalforSuiteCRM • ListView: • Navigatetoanymoduletoviewthelistofrecordsinthatmodule.Searcharecordfromthelistview,deleteitorupdateit. • Toaddanewrecordinthemoduleclickonthe͚Add͛button. www.appjetty.com
INSTALLATIONGUIDE:SuitePort-CustomerPortalforSuiteCRM • AddRecord: • AddanewrecordinamodulefromtheportalanditwillgetreflectedintheSuiteCRM. www.appjetty.com
INSTALLATIONGUIDE:SuitePort-CustomerPortalforSuiteCRM • DetailPage: • Clickonthe͚Vieǁ͛buttonfromtheListViewandviewthedetailsofarecord.Youcaneditthatrecordordeleteitfromthedetailview. www.appjetty.com
INSTALLATIONGUIDE:SuitePort-CustomerPortalforSuiteCRM • CalendarPage: • VieworaddCallsandMeetingsfromthecalendarforaparticulardate. www.appjetty.com 20
INSTALLATIONGUIDE:SuitePort-CustomerPortalforSuiteCRM • ViewQuotes,InvoicesandContracts: • VieworDownloadQuotes,InvoicesandContractsaddedbyadminfromSuiteCRMsideinPortal. • TodownloadthePDFversionofQuotes,InvoicesorContractsclickonthedownloadiconunder • ͚AĐtioŶs͛column. • AcceptorDeclineQuotefromPortal: • Abuttontoacceptordeclinethequotewillappearinthedetailviewofaquotewhenitreaches • ͞ĐoŶfiƌŵed͟ stage. • OŶĐliĐkiŶg͞AĐĐept͟ ďuttoŶtheƋuotestageĐhaŶges to͞ClosedAĐĐepted͟ aŶdoŶĐliĐkiŶg • ͞DeĐliŶe͟ ďuttoŶtheƋuotestageĐhaŶgesto͞ClosedDead͟. • Note:Thiscannotbechangedagainfromtheportal. www.appjetty.com
INSTALLATIONGUIDE:SuitePort-CustomerPortalforSuiteCRM • KnowledgeBase: • AccesstheKnowledgeBasemoduleofSuiteCRMfromportaltoviewquestionandanswersbasedoncategory. www.appjetty.com
INSTALLATIONGUIDE:SuitePort-CustomerPortalforSuiteCRM ContactUs Wesimplifyyourbusiness,offeruniquebusinesssolutionindigitalwebandITlandscapes. LiveChat • Tickets • Raiseticketsforyourspecificquestion! • GetinstantsupportwithourLiveChat. • Sendanemailtosupport@appjetty.comoryoucanlogintoyouraccount@www.appjetty.comandclickonMySupport • Visitourproductpageat:https://www.appjetty.com/suitecrm-customer-portal.htmandclickontheLiveChatbuttonforinstantsupport. Ticketsonyouraccountdashboard,togetanswerstoyourspecificquestions. Customization: IfyouwouldliketocustomizeordiscussaboutadditionalfeatureforCustomerPortal,pleasewriteto sales@appjetty.com www.appjetty.com