SugarClub
SugarClub
  • User
  • Site
  • Search
  • User
  • Groups & Discussions
    Groups & Discussions
    • Product Forums
      Product-focused Q&A, discussions, best practices, fixes, and help
      Product Forums
      • Sugar Market
      • Sugar Sell & Enterprise
      • Sugar Serve
      • sales-i
    • User Groups
      Professional, Industry, Language
    • Get Involved
      Learn how to become a Raving Fan
    • Social Club
      Live, interactive, virtual meetups with other Sugar customers and Sugar’s Subject Matter experts!
    • Leadership Lounge
      Network with fellow organizational leaders, ask questions, and share insights
    • Developers
      Visit DevClub, the SugarClub group for Sugar Developers
      Developers
      • DevClub
      • Mobile Developers
      • Developer Builds
        Supplemental access level required. Inquiries: developers@sugarcrm.com
    • Additional Groups (Access Required)
      Groups that require special access will be displayed here. Contact sugarclub@sugarcrm.com for assistance. Click here to see all groups
      Additional Groups (Access Required)
      • SugarCloud Platform
  • Product Information
    Product Information
    • Release Central
      Find release-specific content to prepare for your next Sugar update
    • Documentation & Resources
      Looking to expand your Sugar knowledge? Explore our in-depth documentation and other helpful resources!
    • Product Update Blogs
      Updates about each Sugar product
    • Customer Stories »
      Case Studies by SugarCRM
  • Training & Certification
    Training & Certification
    • Training & Certification Home
      Live & On-Demand classes, Quick Videos, Sugar Certifications, and more!
    • Quick Videos
      Short videos about using Sugar
    • Event Recordings
      Recordings from SugarU Live Webinars and Sugar Market Academy
    • My SugarU Dashboard »
    • SugarU News & Updates
  • Adoption
    Adoption
    • Grow Adoption Framework
      Get started on your adoption journey and review the adoption resources from SugarCRM
  • Calendar
  • News
    News
    • Sugar News
    • SugarCRM.com News »
    • Dev Blog
    • SugarCRM Marketplace Blog
  • Help
    Help
    • Welcome to Sugar!
      New to Sugar? Get started here!
    • SugarClub Help & Instructions
      Learn more about SugarClub and find answers to questions about this site
    • New to SugarClub?
      Start your community journey here
    • Technical Support
      Sugar's support resources
      Technical Support
      • Case Portal »
        Access the SugarCRM Case Portal
      • Working with Sugar Support »
        Find out more about engaging with the SugarCRM Support team
      • SugarCloud Information
        Find information about SugarCloud service updates and site status. Contact sugarclub@sugarcrm.com to request access
  • More from Sugar
    More from Sugar
    • DevClub
    • PartnerClub
    • Support
    • SugarOutfitters Marketplace
    • sugarcrm.com
  • DevClub
  • PartnerClub
  • Support
  • Marketplace
  • sugarcrm.com
DevClub
DevClub
Dev Tutorials Integrations for Devs
Click here to join this group and curate your SugarClub experience.
  • -On-Boarding Framework
    • -Developer
      • On-Boarding for Devs
      • Low Code No Code for Devs
      • Integrations for Devs
      • Customization for Devs
      • Deployment for Devs
      • Sell your Work for Devs
    • +Product Developers
  • +Customization Guides
  • +Modern UI Technical Guide
  • +Automated PHP Compatibility Tool
  • +Customization Best Practices in Sugar
  • How to write code for SugarCloud webinar Q&A
  • HOW TO: enforce ACL on Tags
  • Remove custom fields created via package installation
  • Sugar Developer Tools
  • Tutorial:  How to register custom platforms in Sugar instances via Platform extension
  • Adding a google reCAPTCHA in a Web-to-Lead form
  • Sugar Developer Blog Style Guide

You are currently reviewing an older revision of this page.

  • History View current version

Integrations for Devs

Integrating with Sugar

The extension framework, defined in ./ModuleInstall/extensions.php, provides the capability to modify Sugar metadata such as vardefs and layouts in a safe way that supports installing, uninstalling, enabling, and disabling without interfering with other customizations.

  • Extension Framework
  • Create or override a Sidecar Layout
  • Create or override a View
  • Add logic to a field prior to render
  • Add or override vardefs (variables) definitions
  • Add or override subpanel definitions
  • Add new modules through code
  • Resetting Modules to default settings

Best Practices

The Logic Hook framework allows you to append actions to system events such as when creating, editing, and deleting records. Logic hook definitions can pertain to a specific module or to the entire application. Either way, you must decide if the logic hook definition will be implemented as an extension of or directly to the module or application.

  • Module Extension Hooks allow a developer to define hook actions that will be executed for the specified events in a given module
  • Application Extension Hooks allow a developer to define hook actions that will be executed for all specified application-level events using the extension framework
  • Web Logic Hooks Web logic hooks let administrators post record and event information to a specified URL when certain sugar events take place
  • Preventing Infinite Loops with Logic Hooks
  • Comparing Bean Properties Between Logic Hooks
  • Application Hooks Events
  • Module Hooks Events
  • User Hooks Events
  • Job Queue Events
  • API Hooks Events

Performance Tips and Tricks

The Studio and Module Builder section includes topics covering creating, modifying, and troubleshooting custom fields, relationships, dropdown lists, and modules via Sugar's Studio and Module Builder tools:

  • Best Practices When Building Custom Modules
  • Understanding Module Builder's Functions
  • Creating a Custom Module With Module Builder
  • Add ActionButtons to your records
  • Creating a Dropdown Field
  • Creating Dependent Dropdown Lists
  • Creating Relationship between Modules
  • Creating Role-Based Record Views
  • Creating Role-Based Dropdown Lists
  • Editing a Module's Layouts
  • Adding a Google Map to a Module

SugarBPM - Advanced Workflow

SugarBPMTm enables administrators to streamline common business processes by managing approvals, sales processes, call triaging, and more. SugarBPM is an easy-to-use business process management (BPM) and workflow tool that adds advanced BPM functionality to Sugar.

The SugarBPM suite features an extensive toolbox of modules that provide the ability to easily create digital forms and map out robust workflows using a drag-and-drop interface.

  • Prerequisites
    • Basic knowledge of process design is required.
    • Basic knowledge of process standards such as BPMN is preferred. BPMN is a flowchart-based notation used to define business processes within an organization.
    • You should know which business processes you want to automate in Sugar.
  • SugarBPM Overview
  • Introduction to Business Process Automation via SugarBPM
  • Getting Started With SugarBPM for Sugar Serve
  • Using SugarBPM to Notify a Team or User on Record Creation
  • Understanding Email Direction in Process Definitions
  • Understanding Round Robin Activities vs. Round Robin Actions

You're up and running, but don't stop now - this is just the beginning of your journey. Now it's time to Customizations.