Customization for Devs

Alex Nassi — Fri, 07 Feb 2025 16:36:05 GMT

Current Revision posted to Dev Tutorials by Alex Nassi on 2/7/2025 4:36:05 PM

Extensions

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.

Logic Hooks / System Events

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

Batch Jobs

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

How To's

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 Deployment.

Customization for Devs

Rafael Fernandes — Thu, 08 Feb 2024 14:22:35 GMT

Revision 22 posted to Dev Tutorials by Rafael Fernandes on 2/8/2024 2:22:35 PM

Extensions

Logic Hooks / System Events

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

Batch Jobs

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

How To's

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.

Customization for Devs

Rafael Fernandes — Tue, 06 Feb 2024 20:18:19 GMT

Revision 21 posted to Dev Tutorials by Rafael Fernandes on 2/6/2024 8:18:19 PM

Extensions

Logic Hooks / System Events

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

Batch Jobs

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

How To's

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.

Customization for Devs

Rafael Fernandes — Tue, 13 Sep 2022 16:16:25 GMT

Revision 20 posted to Dev Tutorials by Rafael Fernandes on 9/13/2022 4:16:25 PM

Extensions

Logic Hooks / System Events

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

Batch Jobs

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

How To's

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.

Customization for Devs

Rafael Fernandes — Tue, 13 Sep 2022 16:01:49 GMT

Revision 19 posted to Dev Tutorials by Rafael Fernandes on 9/13/2022 4:01:49 PM

Extensions

Logic Hooks / System Events

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

Batch Jobs

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

How To's

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.

Customization for Devs

Rafael Fernandes — Wed, 07 Sep 2022 18:24:52 GMT

Revision 18 posted to Dev Tutorials by Rafael Fernandes on 9/7/2022 6:24:52 PM

Extensions

Logic Hooks / System Events

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

Batch Jobs

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

How To's

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 Application Footer
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.

Customization for Devs

Alex Nassi — Fri, 05 Aug 2022 17:45:09 GMT

Revision 17 posted to Dev Tutorials by Alex Nassi on 8/5/2022 5:45:09 PM

Extensions

Logic Hooks / System Events

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

Batch Jobs

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

How To's

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 Application Footer
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.

Customization for Devs

Alex Nassi — Wed, 03 Aug 2022 23:07:35 GMT

Revision 16 posted to Dev Tutorials by Alex Nassi on 8/3/2022 11:07:35 PM

Extensions

Logic Hooks / System Events

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

Batch Jobs

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

How To's

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 Application Footer
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.

Customization for Devs

Alex Nassi — Wed, 03 Aug 2022 23:06:54 GMT

Revision 15 posted to Dev Tutorials by Alex Nassi on 8/3/2022 11:06:54 PM

Extensions

Logic Hooks / System Events

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

Batch Jobs

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

HOWTOs

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 Application Footer
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.

Customization for Devs

Matt Marum — Thu, 21 Jul 2022 18:50:35 GMT

Revision 14 posted to Dev Tutorials by Matt Marum on 7/21/2022 6:50:35 PM

Extensions

Logic Hooks / System Events

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

Batch Jobs

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

HOWTOs

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 allows 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 Application Footer
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 to Deployments.

Customization for Devs

Rafael Fernandes — Tue, 12 Jul 2022 12:47:32 GMT

Revision 13 posted to Dev Tutorials by Rafael Fernandes on 7/12/2022 12:47:32 PM

Extensions

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.

Logic Hooks / System Events

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

Batch Jobs

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

HOWTOs

In this section you will find few real world examples on 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 allows 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 Application Footer
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 to Deployments.

Customization for Devs

Rafael Fernandes — Fri, 08 Jul 2022 16:00:38 GMT

Revision 12 posted to Dev Tutorials by Rafael Fernandes on 7/8/2022 4:00:38 PM

Extensions

Logic Hooks / System Events

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

Batch Jobs

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

HOWTOs

In this section you will find few real world examples on 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 allows 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 Application Footer
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 to Deployments.

Customization for Devs

Rafael Fernandes — Fri, 08 Jul 2022 15:42:17 GMT

Revision 11 posted to Dev Tutorials by Rafael Fernandes on 7/8/2022 3:42:17 PM

Extensions

Logic Hooks / System Events

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

Batch Jobs

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

HOWTOs

In this section you will find few real world examples on 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 allows a user to apply as many "tags" as they choose on any record they want to categorize
Adding Buttons to the Application Footer
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 to Deployments.

Customization for Devs

Rafael Fernandes — Fri, 08 Jul 2022 15:39:14 GMT

Revision 10 posted to Dev Tutorials by Rafael Fernandes on 7/8/2022 3:39:14 PM

Extensions

Logic Hooks / System Events

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

Batch Jobs

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

HOWTOs

In this section you will find few real world examples on 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 allows a user to apply as many "tags" as they choose on any record they want to categorize
Adding Buttons to the Application Footer
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 to Deployments.

Customization for Devs

Rafael Fernandes — Fri, 08 Jul 2022 15:19:26 GMT

Revision 9 posted to Dev Tutorials by Rafael Fernandes on 7/8/2022 3:19:26 PM

Extensions

Logic Hooks / System Events

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

Batch Jobs

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

HOWTOs

In this section you will find few real world examples on 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 allows a user to apply as many "tags" as they choose on any record they want to categorize
Adding Buttons to the Application Footer
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 to Deployments.

Customization for Devs

Rafael Fernandes — Fri, 08 Jul 2022 15:18:37 GMT

Revision 8 posted to Dev Tutorials by Rafael Fernandes on 7/8/2022 3:18:37 PM

Extensions

Logic Hooks / System Events

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

Batch Jobs

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

HOWTOs

In this section you will find few real world examples on 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 allows a user to apply as many "tags" as they choose on any record they want to categorize
Adding Buttons to the Application Footer
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 to Customizations.

Customization for Devs

Rafael Fernandes — Fri, 08 Jul 2022 14:45:48 GMT

Revision 7 posted to Dev Tutorials by Rafael Fernandes on 7/8/2022 2:45:48 PM

Extensions

Logic Hooks / System Events

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

Studio and Module Builder

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:

SugarBPM - Advanced Workflow

SugarBPM™ 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.

Customization for Devs

Rafael Fernandes — Fri, 08 Jul 2022 14:22:07 GMT

Revision 6 posted to Dev Tutorials by Rafael Fernandes on 7/8/2022 2:22:07 PM

Extensions

Logic Hooks / System Events

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
Application Hooks Events
Module Hooks Events
User Hooks Events
Job Queue Events
API Hooks Events

Studio and Module Builder

SugarBPM - Advanced Workflow

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.

Customization for Devs

Rafael Fernandes — Fri, 08 Jul 2022 14:20:57 GMT

Revision 5 posted to Dev Tutorials by Rafael Fernandes on 7/8/2022 2:20:57 PM

Extensions

Logic Hooks / System Events

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
Application Hooks Events
Module Hooks Events
User Hooks Events
Job Queue Events
API Hooks Events

Studio and Module Builder

SugarBPM - Advanced Workflow

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.

Customization for Devs

Rafael Fernandes — Fri, 08 Jul 2022 14:18:37 GMT

Revision 4 posted to Dev Tutorials by Rafael Fernandes on 7/8/2022 2:18:37 PM

Extensions

Logic Hooks / System Events

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
Application Hooks Events
Module Hooks Events
User Hooks Events
Job Queue Events
API Hooks Events

Studio and Module Builder

SugarBPM - Advanced Workflow

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.

Customization for Devs

Rafael Fernandes — Thu, 30 Jun 2022 19:27:40 GMT

Revision 3 posted to Dev Tutorials by Rafael Fernandes on 6/30/2022 7:27:40 PM

Extensions

Developer Tools

The Developer Tools section of Sugar's Admin page contains various configuration menus that help you customize your instance to best suit your organization's needs. Developer Tools allow you to edit the look, feel, and functionality of your instance, including adding fields, changing layouts, adding automated processes, and creating entirely new modules.

Studio enables administrators to customize stock or custom modules
Module Builder enables administrators to create, deploy, and maintain custom modules
Module Loader is used to import packages into Sugar that make changes to core files
Rename Modules, Administrators can easily rename modules
SugarBPM enables administrators to streamline common business processes
Sugar Portal is a powerful tool that allows Sugar users to interact with customers
Advanced Configuration, Sugar comes with many different ways to configure your system to best meet your needs
Data Privacy Guide
User Interface, Sidecar, Navigations, Home, Search

Studio and Module Builder

SugarBPM - Advanced Workflow

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