Sugar Developer Guide Version 5.1

Directory Structure

SugarCRM code resides in various directories within the Sugar installation. The structure of the directories within the Sugar application consists of the following root level directories:

•

cache: Various cache files written to the file system to minimize database accesses and store user interface templates created from metadata. Also files uploaded into the application such as Note Attachments or Documents reside in this directory (refer to ‘upload_dir’ parameter in the config.php file) which means that this is an active cache directory and not all files can be deleted from this directory.

•	custom: Stores upgrade-safe customizations such as custom field definitions, user interface layouts and business logic hooks.

•	data: Key system files are located here, most notably the SugarBean base class which controls the default application logic for all business objects in Sugar.

•	include: Many Sugar utility functions are located here as well as other libraries that Sugar utilizes as part of its operations. Most notably in this directory is the utils.php file that contains all of the most widely used utility functions.

•	metadata: This file contains relationship metadata for all many-to-many data relationships between the business objects.

•	modules: This folder contains all modules in the system. Custom modules installed through the Module Loader exist here as well.