Sugarcrm

SUGAR DEVELOPER GUIDE
VERSION 6.2.0

Sugar Developer Guide – 6.2.0

Sugar Developer Guide Version 6.2.0, 2011
Copyright © 2004-2011 SugarCRM Inc. www.sugarcrm.com

This document is subject to change without notice. License This work is licensed under the Creative Commons Attribution-Noncommercial-No Derivative Works 3.0 License (“License”). To view a copy of this license, visithttp://www.creativecommons.org/licenses/bync-nd/3.0/ or send a letter to Creative Commons, 171 Second Street, Suite 300, San Francisco, California, 94105, USA. Disclaimer Your Warranty, Limitations of liability and Indemnity are expressly stated in the License. Please refer to the License for the specific language governing these rights and limitations Trademarks All SugarCRM logos in thisdocument are registered trademarks of SugarCRM Inc. See the SugarCRM trademark policies at http://www.sugarcrm.com/crm/open-source/trademark-information.html for more information on how SugarCRM trademarks can be used.

2

Table of Contents
Preface ____________________________________________________________

________ 10
About thisGuide_______________________________________________________

___________ 10 Audience ____________________________________________________________

____________ 10 Overview____________________________________________________

____________________ 10 Core Features ____________________________________________________________

________ 11 Related Documentation ____________________________________________________________

12

Chapter 1:SugarCRM Overview ________________________________________________ 13
Platform Overview ____________________________________________________________

____ 13 Application Framework Overview ____________________________________________________ 13 Module Framework Overview _______________________________________________________ 17 User Interface Framework Overview_________________________________________________ 20 Extension Framework Overview _____________________________________________________ 20 Sugar Dashlets Overview ___________________________________________________________ 20 Web Services Overview ____________________________________________________________

20 Cloud Connectors/External API overview ______________________________________________ 21

Chapter 2Application Framework _______________________________________________ 22
Entry Points ____________________________________________________________

_________ 22 Upgrade implications ____________________________________________________________

__ 22

File Caching ____________________________________________________________

_____ 23 Sugar Dashlets____________________________________________________________

__ 24
Sugar Dashlet files ____________________________________________________________

____ 24 Templating ____________________________________________________________

__________ 25 Categories ____________________________________________________________

___________ 25 Sugar Dashlet base class ___________________________________________________________ 25Sugar Dashlets JavaScript__________________________________________________

_________ 25

Browser JavaScript ___________________________________________________________ 26
Accessing Language Pack Strings _____________________________________________________ 26 Quicksearch ____________________________________________________________

_________ 26 3

ACL____________________________________________________________

___________ 27 Scheduler ____________________________________________________________

______ 28 Databases ____________________________________________________________

______ 28 Indexes ____________________________________________________________

________ 29 Primary Keys, Foreign Keys, and GUIDs __________________________________________ 29 Logger...