Version 5.5.0

Table of Contents

Preface

About this Guide

Audience

Overview

Core Features

What’s New in 5.5.0

Related Documentation

Chapter 1 SugarCRM Overview

Platform Overview

Application Framework Overview

Directory Structure

Key Concepts

Entry Points

Module Framework Overview

User Interface Framework Overview

Extension Framework Overview

Sugar Dashlets Overview

Web Services Overview

Cloud Connectors Overview

Chapter 2 Application Framework

Entry Points

Upgrade Implications

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

SOAP

REST

API Definitions

Versioning

Core Calls

Sample Request For User Login

Extensibility in Upgrade Safe Manner

SOAP Errors

Support WS-I 1.0Basic profile for WSDL

SugarSoap Examples

Cloud Connectors Framework

Introduction

Factories

Sources

Formatters

Chapter 3 Module Framework

Overview

User Interface Framework

Model-View-Controller (MVC) Overview

SugarCRM MVC Implementation

Metadata Framework

Background

Application Metadata

Module Metadata

SearchForm Metadata

DetailView and EditView Metadata

SugarField Widgets

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

The Custom Directory

Vardefs

Languages

Shortcuts

Layoutdefs

Global Links

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

Using the New Module

Module Loader

Manifest Overview

Installdef Definition

Upgrade Definition

Module Loader Restrictions

Sample Manifest

Business Logic Hooks

Hook Definition

Available Hooks

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

Creating New Sugar Dashlets

Custom Sugar Dashlets

Creating Custom Chart Dashlets

Themes

Theme Directory Structure

Theme Development

Changing a Theme

Creating a New Theme

Element Reference Guide

Packaging Custom Themes

Tips & Pitfalls

Adding Multiple Languages

Add a Language

Creating Language Packs

Creating a Connector

Dynamic Teams

Database Changes

Team Security

Overview

Team Sets

Primary Team

TeamSetLink

Printing to PDF

SugarPDF Architecture

The custom directory

Adding New PDF Templates

Steps

Smarty

How to Add a New Font (without Font Manager)

How to Add More Configurations to PDF Settings

Creating a Portal API User