Table Of Content

SuiteCRM for Developers Getting started with developing for SuiteCRM Jim Mackin ©2015 Jim Mackin Tweet This Book! PleasehelpJimMackinbyspreadingthewordaboutthisbookonTwitter! Thesuggestedhashtagforthisbookis#SuiteCRMForDevelopers. Findoutwhatotherpeoplearesayingaboutthebookbyclickingonthislinktosearchforthis hashtagonTwitter: https://twitter.com/search?q=#SuiteCRMForDevelopers Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 WhatisSuiteCRM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Thisbook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 Readingthisbook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 SettingupSuiteCRM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 InitialTweaks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 2. SuiteCRMDirectoryStructure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 3. WorkingwithBeans . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 BeanFactory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 SugarBean . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Searchingforbeans . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Accessingfields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Relatedbeans . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 4. Vardefs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 WhatareVardefs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 DefiningVardefs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 5. Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Customising . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 6. Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Intro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Customising . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Differentmetadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 7. Controllers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Customisingcontrollers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 8. EntryPoints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 Creatinganentrypoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 CONTENTS 9. LanguageStrings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 ModuleStrings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 ApplicationStrings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 ApplicationListStrings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 Whyandwhentocustomise . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 10.Config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 Theconfigfiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 Usingconfigoptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 11.Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 Loggingmessages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 Loggingoutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 Loglevels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 12.LogicHooks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 Intro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 ApplicationHooks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 UserHooks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 ModuleHooks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 JobQueueHooks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 Implementing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 13.ScheduledTasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Intro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Scheduler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 JobQueue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 Debugging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 14.ExtensionFramework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 StandardExtensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 CustomExtensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 15.ModuleInstaller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 manifest.php . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 16.API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 UsingtheAPI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 AddingcustomAPImethods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 CONTENTS 17.BestPractices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 Developmentinstances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 Versioncontrol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 Backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 Beupgradesafe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Useappropriateloglevels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Longrunninglogichooks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 MinimiseSQL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 SQLUse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 Entrycheck . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 Redirectafterpost . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 18.PerformanceTweaks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 Indexes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 ConfigChanges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 19.FurtherResources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 SuiteCRMWebsite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 ExternalSuiteCRMResources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 SugarCRMResources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 TechnicalLinks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 OtherLinks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 20.AppendixA-CodeExamples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 ModuleInstaller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 21.AppendixB-APIMethods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 1. Introduction What is SuiteCRM The story of SuiteCRM¹ starts with SugarCRM. SugarCRM was founded in 2004 and consisted of anopensourceversion(calledCommunityEdition)andvariouspaidforversions.Howevertrouble started brewing when it appeared that SugarCRM would not be releasing a Community Edition of SugarCRM7andwouldbeprovidinglimited,ifany,updatestotheCommunityEdition. EnterSuiteCRM.SalesAgilityforkedCommunityEditiontocreateSuiteCRMandalsoaddedvarious opensourcepluginstoaddimprovedfunctionality. This book Thisbookisintendedfordeveloperswhoarefamiliar(oratleastacquainted)withusingSuiteCRM butwanttoperformtheirowncustomisations.SuiteCRMisalargeandmaturepieceofsoftwareso it is impractical for a book to cover all aspects of the software. I’ve tried to add the most important partswhichshouldallowyoutomakethechangesyouneedin99%ofsituations.Thereisafurther resourceschapterattheendofthisbooktohelpoutinthose1%ofcases.Withthatbeingsaidifyou feel thereis anything important I haveleft out (orworse,anything incorrect in the book) please let meknow.IcanbecontactedatJSMackin.co.uk². Reading this book Each chapter in this book is intended to be self contained so the reader can jump to interesting chapters.Wherethereissomeoverlapthisisusuallyindicatedwithlinkstotherelevantchapters. Somepartsofthisbookmayrefertofilepathsorotherpartsofcodethatcanhaveavariablevalue, forexamplecontrollernamescontainthemodulenameorafilewithanarbitraryname.Inthiscase these will be marked in the form <TheModuleName>, <TheFileName> or something else suitable. In thesecasesyoucansubstitutesomethingappropriate(suchasAccountsorMyNewFile). Setting up SuiteCRM Inthisbookwe’llbeusingSuiteCRMv7.1.5whichisthelatestattimeofwriting.Foruptodatever- sionsoftheinstallationinstructionsseetheSuiteCRMwikiatsuitecrm.com/wiki/index.php/Installation³. ¹https://www.suitecrm.com ²http://www.jsmackin.co.uk ³https://suitecrm.com/wiki/index.php/Installation 1 Introduction 2 Website The SuiteCRM installer can be found at SuiteCRM.com⁴. I would recommend SuiteCRM MAX as I prefertostartwithafullinterfaceandcustomiseitasneeded. GitHub SuiteCRM is also available on GitHub⁵ at github.com/salesagility/SuiteCRM⁶. Each SuiteCRM versionistaggedsoyoucaneasilygrabtheversionyouneed. Initial Tweaks After the initial install there are a few tweaks you may want to make on an instance you are developing on. These changes should improve your development flow and productivity as well as helpidentifyissuesiftheyoccur. Developer Mode SuiteCRMwillcachevariousfilesthatitprocesses,suchasSmartytemplates.Developermodewill turn off some of the caching so that changes to files will be seen immediately (though this isn’t always the case - as is the case with extensions). This can be enabled either through the config file orviatheGeneralsettingspageinsideadmin. Log Level The default log level of SuiteCRM isfatal. This is a good default for production instances but you maywanttoincreasethelogleveltoinfoordebug.Thiswillmakethelogoutputmoreverboseso, should anything go wrong, you’ll have something to refer to. See the chapter on logging for more information. Display errors You’ll also want to turn off display errors. Unfortunately at the moment SuiteCRM has various notices and warnings out of the box. With display_errors on this can sometimes cause AJAX pagesandthelinktobreak. WiththisbeingsaidyoushouldbecheckingthePHPerrorlogsorselectivelyenabling display_errorstoensurethatthecodeyouarecreatingisnotcreatingadditionalnotices,warnings orerrors. ⁴https://suitecrm.com/ ⁵http://github.com ⁶https://github.com/salesagility/SuiteCRM Introduction 3 XDebug XDebug⁷ is a PHP extension which provides profiling and debugging capabilities to PHP. This can massively improve developer productivity by simplifying development and, particularly, tracking downanyissues.SeetheXDebugsiteforinformationonXDebug. ⁷http://xdebug.org 2. SuiteCRM Directory Structure cache Contains cache files used by SuiteCRM including compiled smarty templates, grouped vardefs,minifiedandgroupedJavaScript.Somemodulesandcustommodulesmayalsostore (temporary)modulespecificinfohere. custom ContainsuseranddevelopercustomisationstoSuiteCRM.AlsocontainssomeSuiteCRMcode tomaintaincompatibilitywithSugarCRM.Howeverthisislikelytochangeinthefuture. data StorestheclassesandfilesusedtodealwithSugarBeansandtheirrelationships. examples Contains a few basic examples of lead capture and API usage. However these are very outdated. include ContainsthebulkofnonmoduleandnondataSuiteCRMcode. install CodeusedbytheSuiteCRMinstaller. jssource ThejssourcefoldercontainstheunminifiedsourceofsomeoftheJavaScriptfilesusedwithin SuiteCRM. metadata Stores relationship metadata for the various stock SuiteCRM modules. This should not be confused with module metadata which contains information on view, dashlet and search definitions. mobile StorescodefortheQuickCRM¹mobileapp. ModuleInstall Codeforthemoduleinstaller. modules ContainsthecodeforanystockorcustomSuiteCRMmodules. ¹http://www.quickcrm.fr 4

ebook img

SuiteCRM for Developers PDF

137 Pages·2016·0.685 MB·English
by  Jim Mackin
#
Save to my drive
Quick download
Download

Download SuiteCRM for Developers PDF Free - Full Version

by Jim Mackin| 2016| 137 pages| 0.685| English

Download SuiteCRM for Developers by Jim Mackin in PDF format completely FREE. No registration required, no payment needed. Get instant access to this valuable resource on PDFdrive.to!

Free Download PDF

About SuiteCRM for Developers

No description available for this book.

Detailed Information

Author:Jim Mackin
Publication Year:2016
ISBN:1449058
Pages:137
Language:English
File Size:0.685
Format:PDF
Price:FREE
Download Free PDF

Safe & Secure Download - No registration required

Why Choose PDFdrive for Your Free SuiteCRM for Developers Download?

  • 100% Free: No hidden fees or subscriptions required for one book every day.
  • No Registration: Immediate access is available without creating accounts for one book every day.
  • Safe and Secure: Clean downloads without malware or viruses
  • Multiple Formats: PDF, MOBI, Mpub,... optimized for all devices
  • Educational Resource: Supporting knowledge sharing and learning

Free Books Similar to SuiteCRM for Developers

Frequently Asked Questions

Is it really free to download SuiteCRM for Developers PDF?

Yes, on https://PDFdrive.to you can download SuiteCRM for Developers by Jim Mackin completely free. We don't require any payment, subscription, or registration to access this PDF file. For 3 books every day.

How can I read SuiteCRM for Developers on my mobile device?

After downloading SuiteCRM for Developers PDF, you can open it with any PDF reader app on your phone or tablet. We recommend using Adobe Acrobat Reader, Apple Books, or Google Play Books for the best reading experience.

Is this the full version of SuiteCRM for Developers?

Yes, this is the complete PDF version of SuiteCRM for Developers by Jim Mackin. You will be able to read the entire content as in the printed version without missing any pages.

Is it legal to download SuiteCRM for Developers PDF for free?

https://PDFdrive.to provides links to free educational resources available online. We do not store any files on our servers. Please be aware of copyright laws in your country before downloading.

The materials shared are intended for research, educational, and personal use in accordance with fair use principles.

We use cookies

We use cookies to ensure you get the best browsing experience on our website. By clicking "Accept Cookies", you agree that we can store cookies on your device in accordance with our Terms and Privacy.