Version 5.1

Table of Contents

Preface

About this Guide

Audience

Overview

Core Features

Sales Management

Marketing Automation

Collaboration

News Service

Administration

Interface Consolidation

What’s New in 5.1

Enhanced Emails Functionality

Enhanced Import Functionality

Creating Relationships Between Modules

Embedding Links and IFrames in a Layout

Locking Down the Upgrade Wizard

Locking Down the Module Loader

Related Documentation

Chapter 1 SugarCRM Overview

Platform Overview

Application Framework Overview

Directory Structure

Key Concepts

Application Concepts

Files

Variables

Entry Points

Module Framework Overview

User Interface Framework Overview

Extension Framework Overview

Sugar Dashlets Overview

Web Services Overview

Chapter 2 Application Framework

Entry Points

File Caching

Sugar Dashlets

Sugar Dashlet Files

Templating

Categories

Sugar Dashlet Base Class

Sugar Dashlets JavaScript

Browser JavaScript

Accessing Language Pack Strings

Quicksearch

ACL

Scheduler

Databases

Indexes

Primary Keys, Foreign Keys, and GUIDs

Logger

Logger Level

Log File Name

Log File Extension

Log File Date Format

Max Log File Size

Max Number of Log Files

Log Rotation

Web Services

Test Connection

SugarSoap Login

Get the Current User ID

Get a list of records for a module

Get the values of a record

Set the values for a record

Get the fields for a module

Logout

SugarSoap Examples

Logging in via SOAP and getting a Sugar user's GUID

Inserting a Lead via SOAP calls using PHP

Chapter 3 Module Framework

Overview

User Interface Framework

Model-View-Controller (MVC) Overview

SugarCRM MVC Implementation

Model

Controller

View

Metadata Framework

Background

Application Metadata

Module Metadata

SearchForm Metadata

DetailView and EditView Metadata

SugarField Widgets

File Structure

Implementation

SugarFields Widgets Reference

Metadata Framework Summary

Vardefs

Dictionary Array

Fields Array

Indices Array

Relationships Array

Many-to-Many Relationships

Subpanels

One-to-Many Relationships

Many-to-Many Relationships

Relationship Metadata

Layout Defs

Shortcuts

Chapter 4 Customizing Sugar

Introduction

Tips & Pitfalls

Making upgrade-safe customizations

Installing Third-Party Modules

Naming Your Custom Modules

Be Familiar with Object Oriented Programming

Use Developer Mode when Customizing the User Interface

The Custom Directory

Vardefs

Master Directories

Production Directories

Description

Languages

Master Directories

Production Directories

Description

Shortcuts

Master Directories

Production Directories

Description

Layoutdefs

Master Directories

Production Directories

Description

Module Builder

Creating New Modules

Understanding Object Templates

Editing Module Fields

Editing Module Layouts

Building Relationships

Publishing and Uploading Packages

Adding Custom Logic using Code

Logic Hooks

Custom Bean files

Using the New Module

Module Loader

Manifest Overview

Installdef Definition

Upgrade Definition

Sample Manifest

Business Logic Hooks

Hook Definition

$hook_version

$hook_array

Available Hooks

Application hooks

Module hooks

Hooks for Users module

Options array

Packaging Custom Logic Hooks

Using Custom Logic Hooks

Tips & Pitfalls

User Interface Customizations

Custom Grouping of Values

Custom Buttons

Creating New Custom Displays

Overriding the View

Creating a Custom SugarField

Adding QuickSearch to a Custom Field

Tips & Pitfalls

Grouping Required Fields Together

Displaying data on EditViews with a read-only ACL setting

The field value specified in metadata does not appear

The field value specified in metadata does not appear but is in vardefs.php

Creating New Sugar Dashlets

Custom Sugar Dashlets

Packaging Custom Sugar Dashlets

Refreshing the Sugar Dashlet Cache

Creating Custom Chart Dashlets

Creating New Themes

Overview

Steps to Create a New Theme

Packaging Custom Themes

Example Theme Manifest File

Tips & Pitfalls

Pick your Canvas

Replace All

Check your work

Personalize your theme

Adding Multiple Languages

Add a Language

Creating Language Packs