The extension framework 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
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
The Job Queue executes automated tasks in Sugar through a scheduler, which integrates with external UNIX systems and Windows systems to run jobs that are scheduled through those systems. Jobs are the individual runs of the specified function from a scheduler:
- Developer Office Hours dedicated to Sugar Batch Jobs with Sugar Experts Sharing experiences and best practices
- Job Queues executes automated tasks in Sugar
- Schedulers Sugar provides a Scheduler service that can execute predefined functions asynchronously on a periodic basis
- Creating Custom Schedulers
- Scheduler Jobs Jobs are the individual runs of the specified function from a scheduler
- Creating a Custom Job How to create and execute your own custom jobs.
- Queuing Logic Hook Actions enables you to send longer-running jobs such as sending emails
In this section, you will find a few real-world examples of how to enable and customize functionalities that makes Sugar better for your end-users and admins.
- Global Search how to customize the global search results
- Elasticsearch how Sugar integrates with Elasticsearch
- Duplicate Check framework provides the capability to alter how the system searches for duplicate records in the database when creating records
- Configuration Settings you can access the Sugar config (filesystem) settings by using this
- Administration Settings is used to manage settings stored in the database config table
- Tags allow a user to apply as many "tags" as they choose on any record they want to categorize
- Validation Constraints how to add validation constraints to your custom code
- Adding Buttons to the Record View
- Creating Custom Field Types
- Creating an Auto-Incrementing Field
- Dynamically Hiding Subpanels Based on Record Values
- Prepopulating the Compose Email View
You're up and running, but don't stop now - this is just the beginning of your journey.
Now it's time for Deployments.