SuiteCRM for Developers


This book is no longer available for sale.

SuiteCRM for Developers

Getting started with developing for SuiteCRM

About the Book

Owing to the fact that is open source, mature and highly customisable SuiteCRM is a perfect system for tailoring to your processes.

However maturity and customisability can lead to complexity. It can be tough to know where, when and how to make changes and customisations.

Enter SuiteCRM for Developers. SuiteCRM for developers is a guide to developing with SuiteCRM. It covers creating customisations, packages and third party integrations.

About the Author

Jim Mackin
Jim Mackin

Jim Mackin is a Software Engineer working for a SalesAgility, the company behind SuiteCRM. He writes mainly in PHP and JavaScript but also has forays into Python when no-one is looking.

He graduated in 2008 from Edinburgh University with a Bachelors of Engineering in Software Engineering and has been programming professionally since then.

When not coding he is trying not to get choked or thrown on the Judo mat.

He lives in Scotland with his beautiful and long suffering wife Anna.

He can be found online at

Table of Contents

  • 1. Introduction
    • What is SuiteCRM
    • This book
    • Reading this book
    • Setting up SuiteCRM
    • Initial Tweaks
  • 2. SuiteCRM Directory Structure
  • 3. Working with Beans
    • BeanFactory
    • SugarBean
    • Searching for beans
    • Accessing fields
    • Related beans
  • 4. Vardefs
    • What are Vardefs
    • Defining Vardefs
    • Location
    • Customising
  • 6. Metadata
    • Intro
    • Location
    • Customising
    • Different metadata
  • 7. Controllers
    • Customising controllers
  • 8. Entry Points
    • Creating an entry point
  • 9. Language Strings
    • Module Strings
    • Application Strings
    • Application List Strings
    • Why and when to customise
    • Usage
  • 10. Config
    • The config files
    • Using config options
  • 11. Logging
    • Logging messages
    • Logging output
    • Log levels
  • 12. Logic Hooks
    • Intro
    • Types
    • Application Hooks
    • User Hooks
    • Module Hooks
    • Job Queue Hooks
    • Implementing
    • Tips
  • 13. Scheduled Tasks
    • Intro
    • Scheduler
    • Job Queue
    • Debugging
  • 14. Extension Framework
    • Introduction
    • Standard Extensions
    • Custom Extensions
  • 15. Module Installer
    • manifest.php
    • Types
  • 16. API
    • Using the API
    • Adding custom API methods
  • 17. Best Practices
    • Development instances
    • Version control
    • Backup
    • Be upgrade safe
    • Use appropriate log levels
    • Long running logic hooks
    • Minimise SQL
    • SQL Use
    • Entry check
    • Redirect after post
  • 18. Performance Tweaks
    • Server
    • Indexes
    • Config Changes
  • 19. Further Resources
    • SuiteCRM Website
    • External SuiteCRM Resources
    • SugarCRM Resources
    • Technical Links
    • Other Links
  • 20. Appendix A - Code Examples
    • Metadata
    • Module Installer
  • 21. Appendix B - API Methods
    • Methods

The Leanpub 60 Day 100% Happiness Guarantee

Within 60 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.

Now, this is technically risky for us, since you'll have the book or course files either way. But we're so confident in our products and services, and in our authors and readers, that we're happy to offer a full money back guarantee for everything we sell.

You can only find out how good something is by trying it, and because of our 100% money back guarantee there's literally no risk to do so!

So, there's no reason not to click the Add to Cart button, is there?

See full terms...

80% Royalties. Earn $16 on a $20 book.

We pay 80% royalties. That's not a typo: you earn $16 on a $20 sale. If we sell 5000 non-refunded copies of your book or course for $20, you'll earn $80,000.

(Yes, some authors have already earned much more than that on Leanpub.)

In fact, authors have earnedover $12 millionwriting, publishing and selling on Leanpub.

Learn more about writing on Leanpub

Free Updates. DRM Free.

If you buy a Leanpub book, you get free updates for as long as the author updates the book! Many authors use Leanpub to publish their books in-progress, while they are writing them. All readers get free updates, regardless of when they bought the book or how much they paid (including free).

Most Leanpub books are available in PDF (for computers) and EPUB (for phones, tablets and Kindle). The formats that a book includes are shown at the top right corner of this page.

Finally, Leanpub books don't have any DRM copy-protection nonsense, so you can easily read them on any supported device.

Learn more about Leanpub's ebook formats and where to read them

Write and Publish on Leanpub

You can use Leanpub to easily write, publish and sell in-progress and completed ebooks and online courses!

Leanpub is a powerful platform for serious authors, combining a simple, elegant writing and publishing workflow with a store focused on selling in-progress ebooks.

Leanpub is a magical typewriter for authors: just write in plain text, and to publish your ebook, just click a button. (Or, if you are producing your ebook your own way, you can even upload your own PDF and/or EPUB files and then publish with one click!) It really is that easy.

Learn more about writing on Leanpub