Deployment for Devs

Rafael Fernandes — Wed, 07 May 2025 13:41:49 GMT

Current Revision posted to Dev Tutorials by Rafael Fernandes on 5/7/2025 1:41:49 PM

Deployment

Where you plan to deploy Sugar code is the biggest factor in determining how Sugar code should be deployed and how your project should be managed.

Are you working on a Sugar project for an on-premise Sugar implementation? Are you working on a custom module that you plan on distributing through SugarCRM Marketplace? Are you planning a solely REST API integration? The answers to these questions guide how you should develop and deploy Sugar code

Sugar on-site projects: Develop these customizations using the exact version and flavor of Sugar that you plan to use in production.
SugarCloud projects: Develop these customizations on the latest available version of Sugar for the particular flavor the customer has purchased.
Custom modules or integrations: If you plan on distributing your customization to many Sugar customers via SugarCRM Marketplace or channel partners, design your customization with Sugar's cloud service in mind.
- Sugar's cloud service is more restrictive than our on-site installs regarding supported customizations.
- Customizations designed for Sugar's cloud service can be supported in Sugar on-site instances, but the inverse is not always true.

When deploying code into production, it is important to make sure you've abided by SugarCRM's Developer Policy. For the particulars on SugarCloud restrictions, please refer to the SugarCloud Policy Guide.

Packaging / Module Loadable Packages

If you plan on distributing Sugar custom code, then you must package your customization as a Module Loadable Package (a .zip file that includes all custom code along with a manifest file). It is easy to write a script to build a module loadable package either from custom directory content or by extracting customizations out of a development environment

Tips and Tricks

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:

You're up and running, but don't stop now - this is just the beginning of your journey.

Now it's time to Sell your Work.

Deployment for Devs

Alex Nassi — Fri, 07 Feb 2025 16:38:26 GMT

Revision 15 posted to Dev Tutorials by Alex Nassi on 2/7/2025 4:38:26 PM

Deployment

Where you plan to deploy Sugar code is the biggest factor in determining how Sugar code should be deployed and how your project should be managed.

Are you working on a Sugar project for an on-premise Sugar implementation? Are you working on a custom module that you plan on distributing through SugarOutfitters? Are you planning a solely REST API integration? The answers to these questions guide how you should develop and deploy Sugar code

Sugar on-site projects: Develop these customizations using the exact version and flavor of Sugar that you plan to use in production.
SugarCloud projects: Develop these customizations on the latest available version of Sugar for the particular flavor the customer has purchased.
Custom modules or integrations: If you plan on distributing your customization to many Sugar customers via SugarOutfitters or channel partners, design your customization with Sugar's cloud service in mind.
- Sugar's cloud service is more restrictive than our on-site installs regarding supported customizations.
- Customizations designed for Sugar's cloud service can be supported in Sugar on-site instances, but the inverse is not always true.

Packaging / Module Loadable Packages

Tips and Tricks

You're up and running, but don't stop now - this is just the beginning of your journey.

Now it's time to Sell your Work.

Deployment for Devs

Rafael Fernandes — Thu, 22 Aug 2024 15:02:47 GMT

Revision 14 posted to Dev Tutorials by Rafael Fernandes on 8/22/2024 3:02:47 PM

Deployment

Where you plan to deploy Sugar code is the biggest factor in determining how Sugar code should be deployed and how your project should be managed.

Sugar on-site projects: Develop these customizations using the exact version and flavor of Sugar that you plan to use in production.
SugarCloud projects: Develop these customizations on the latest available version of Sugar for the particular flavor the customer has purchased.
Custom modules or integrations: If you plan on distributing your customization to many Sugar customers via SugarOutfitters or channel partners, design your customization with Sugar's cloud service in mind.
- Sugar's cloud service is more restrictive than our on-site installs regarding supported customizations.
- Customizations designed for Sugar's cloud service can be supported in Sugar on-site instances, but the inverse is not always true.

Packaging / Module Loadable Packages

Tips and Tricks

You're up and running, but don't stop now - this is just the beginning of your journey.

Now it's time to Sell your Work.

Deployment for Devs

Rafael Fernandes — Thu, 08 Feb 2024 14:36:10 GMT

Revision 13 posted to Dev Tutorials by Rafael Fernandes on 2/8/2024 2:36:10 PM

Deployment

Where you plan to deploy Sugar code is the biggest factor in determining how Sugar code should be deployed and how your project should be managed.

Sugar on-site projects: Develop these customizations using the exact version and flavor of Sugar that you plan to use in production.
SugarCloud projects: Develop these customizations on the latest available version of Sugar for the particular flavor the customer has purchased.
Custom modules or integrations: If you plan on distributing your customization to many Sugar customers via SugarOutfitters or channel partners, design your customization with Sugar's cloud service in mind.
- Sugar's cloud service is more restrictive than our on-site installs regarding supported customizations.
- Customizations designed for Sugar's cloud service can be supported in Sugar on-site instances, but the inverse is not always true.

Packaging / Module Loadable Packages

Tips and Tricks

You're up and running, but don't stop now - this is just the beginning of your journey.

Now it's time to Sell your Work.

Deployment for Devs

Rafael Fernandes — Thu, 17 Nov 2022 19:46:39 GMT

Revision 12 posted to Dev Tutorials by Rafael Fernandes on 11/17/2022 7:46:39 PM

Deployment

Where you plan to deploy Sugar code is the biggest factor in determining how Sugar code should be deployed and how your project should be managed.

Sugar on-site projects: Develop these customizations using the exact version and flavor of Sugar that you plan to use in production.
SugarCloud projects: Develop these customizations on the latest available version of Sugar for the particular flavor the customer has purchased.
Custom modules or integrations: If you plan on distributing your customization to many Sugar customers via SugarOutfitters or channel partners, design your customization with Sugar's cloud service in mind.
- Sugar's cloud service is more restrictive than our on-site installs regarding supported customizations.
- Customizations designed for Sugar's cloud service can be supported in Sugar on-site instances, but the inverse is not always true.

Packaging / Module Loadable Packages

Tips and Tricks

You're up and running, but don't stop now - this is just the beginning of your journey.

Now it's time to Sell your Work.

Deployment for Devs

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

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

Deployment

Where you plan to deploy Sugar code is the biggest factor in determining how Sugar code should be deployed and how your project should be managed.

Sugar on-site projects: Develop these customizations using the exact version and flavor of Sugar that you plan to use in production.
SugarCloud projects: Develop these customizations on the latest available version of Sugar for the particular flavor the customer has purchased.
Custom modules or integrations: If you plan on distributing your customization to many Sugar customers via SugarOutfitters or channel partners, design your customization with Sugar's cloud service in mind.
- Sugar's cloud service is more restrictive than our on-site installs regarding supported customizations.
- Customizations designed for Sugar's cloud service can be supported in Sugar on-site instances, but the inverse is not always true.

Packaging / Module Loadable Packages

Tips and Tricks

You're up and running, but don't stop now - this is just the beginning of your journey.

Now it's time to Sell your Work.

Deployment for Devs

Alex Nassi — Thu, 04 Aug 2022 04:47:29 GMT

Revision 10 posted to Dev Tutorials by Alex Nassi on 8/4/2022 4:47:29 AM

Deployment

Where you plan to deploy Sugar code is the biggest factor in determining how Sugar code should be deployed and how your project should be managed.

Sugar on-site projects: Develop these customizations using the exact version and flavor of Sugar that you plan to use in production.
SugarCloud projects: Develop these customizations on the latest available version of Sugar for the particular flavor the customer has purchased.
Custom modules or integrations: If you plan on distributing your customization to many Sugar customers via SugarOutfitters or channel partners, design your customization with Sugar's cloud service in mind.
- Sugar's cloud service is more restrictive than our on-site installs regarding supported customizations.
- Customizations designed for Sugar's cloud service can be supported in Sugar on-site instances, but the inverse is not always true.

Packaging / Module Loadable Packages

Tips and Tricks

You're up and running, but don't stop now - this is just the beginning of your journey.

Now it's time to Sell your Work.

Deployment for Devs

Alex Nassi — Thu, 04 Aug 2022 04:38:44 GMT

Revision 9 posted to Dev Tutorials by Alex Nassi on 8/4/2022 4:38:44 AM

Deployment

Where you plan to deploy Sugar code is the biggest factor in determining how Sugar code should be deployed and how your project should be managed.

Sugar on-site projects: Develop these customizations using the exact version and flavor of Sugar that you plan to use in production.
SugarCloud projects: Develop these customizations on the latest available version of Sugar for the particular flavor the customer has purchased.
Custom modules or integrations: If you plan on distributing your customization to many Sugar customers via SugarOutfitters or channel partners, design your customization with Sugar's cloud service in mind.
- Sugar's cloud service is more restrictive than our on-site installs regarding supported customizations.
- Customizations designed for Sugar's cloud service can be supported in Sugar on-site instances, but the inverse is not always true.

Packaging / Module Loadable Packages

Tips and Tricks

You're up and running, but don't stop now - this is just the beginning of your journey.

Now it's time to Sell your Work.

Deployment for Devs

Alex Nassi — Thu, 04 Aug 2022 04:37:12 GMT

Revision 8 posted to Dev Tutorials by Alex Nassi on 8/4/2022 4:37:12 AM

Deployment

Where you plan to deploy Sugar code is the biggest factor in determining how Sugar code should be deployed and how your project should be managed.

Sugar on-site projects: Develop these customizations using the exact version and flavor of Sugar that you plan to use in production.
SugarCloud projects: Develop these customizations on the latest available version of Sugar for the particular flavor the customer has purchased.
Custom modules or integrations: If you plan on distributing your customization to many Sugar customers via SugarOutfitters or channel partners, design your customization with Sugar's cloud service in mind.
- Sugar's cloud service is more restrictive than our on-site installs regarding supported customizations.
- Customizations designed for Sugar's cloud service can be supported in Sugar on-site instances, but the inverse is not always true.

Packaging / Module Loadable Packages

Tips and Tricks

You're up and running, but don't stop now - this is just the beginning of your journey.

Now it's time to Sell your Work.

Deployment for Devs

Matt Marum — Thu, 21 Jul 2022 18:52:52 GMT

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

Deployment

Where you plan to deploy Sugar code is the biggest factor in determining how Sugar code should be deployed and how your project should be managed.

Sugar on-site projects : Develop these customizations using the exact version and flavor of Sugar that you plan to use in production.
SugarCloud projects : Develop these customizations on the latest available version of Sugar for the particular flavor the customer has purchased.
Custom modules or integrations : If you plan on distributing your customization to many Sugar customers via SugarOutfitters or channel partners, design your customization with Sugar's cloud service in mind.
- Sugar's cloud service is more restrictive than our on-site installs regarding supported customizations.
- A customization designed for Sugar's cloud service can be supported in Sugar on-site instances, but the inverse is not always true.

Packaging / Module Loadable Packages

Tips and Tricks

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

Deployment for Devs

Rafael Fernandes — Tue, 12 Jul 2022 13:30:13 GMT

Revision 6 posted to Dev Tutorials by Rafael Fernandes on 7/12/2022 1:30:13 PM

Deployment

Where you plan to deploy Sugar code is the biggest factor in determining how Sugar code should be deployed and how your project should be managed.

Sugar on-site projects : Develop these customizations using the exact version and flavor of Sugar that you plan to use in production.
SugarCloud projects : Develop these customizations on the latest available version of Sugar for the particular flavor the customer has purchased.
Custom modules or integrations : If you plan on distributing your customization to many Sugar customers via SugarOutfitters or channel partners, design your customization with Sugar's cloud service in mind.
- Sugar's cloud service is more restrictive than our on-site installs regarding supported customizations.
- A customization designed for Sugar's cloud service can be supported in Sugar on-site instances, but the inverse is not always true.

For more information on Sugar's cloud service restrictions, please refer to the SugarCloud Policy Guide.

Packaging / Module Loadable Packages

Tips and Tricks

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

Deployment for Devs

Rafael Fernandes — Tue, 12 Jul 2022 13:27:51 GMT

Revision 5 posted to Dev Tutorials by Rafael Fernandes on 7/12/2022 1:27:51 PM

Deployment

Where you plan to deploy Sugar code is the biggest factor in determining how Sugar code should be deployed and how your project should be managed.

Sugar on-site projects : Develop these customizations using the exact version and flavor of Sugar that you plan to use in production.
SugarCloud projects : Develop these customizations on the latest available version of Sugar for the particular flavor the customer has purchased.
Custom modules or integrations : If you plan on distributing your customization to many Sugar customers via SugarOutfitters or channel partners, design your customization with Sugar's cloud service in mind.
- Sugar's cloud service is more restrictive than our on-site installs regarding supported customizations.
- A customization designed for Sugar's cloud service can be supported in Sugar on-site instances, but the inverse is not always true.

For more information on Sugar's cloud service restrictions, please refer to the SugarCloud Policy Guide.

Packaging / Module Loadable Packages

Tips and Tricks

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

Deployment for Devs

Rafael Fernandes — Tue, 12 Jul 2022 13:23:29 GMT

Revision 4 posted to Dev Tutorials by Rafael Fernandes on 7/12/2022 1:23:29 PM

Deployment

Where you plan to deploy Sugar code is the biggest factor in determining how Sugar code should be deployed and how your project should be managed.

Sugar on-site projects : Develop these customizations using the exact version and flavor of Sugar that you plan to use in production.
SugarCloud projects : Develop these customizations on the latest available version of Sugar for the particular flavor the customer has purchased.
Custom modules or integrations : If you plan on distributing your customization to many Sugar customers via SugarOutfitters or channel partners, design your customization with Sugar's cloud service in mind.
- Sugar's cloud service is more restrictive than our on-site installs regarding supported customizations.
- A customization designed for Sugar's cloud service can be supported in Sugar on-site instances, but the inverse is not always true.

For more information on Sugar's cloud service restrictions, please refer to the SugarCloud Policy Guide.

Packaging / Module Loadable Packages

Tips and Tricks

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

Deployment for Devs

Rafael Fernandes — Mon, 11 Jul 2022 19:50:31 GMT

Revision 3 posted to Dev Tutorials by Rafael Fernandes on 7/11/2022 7:50:31 PM

TODO

Packaging / Module Loadable Packages

Module Loadable Package, or in short, MLPs are used by Module Loader when installing customizations, plugins, language packs, and hotfixes, and other customizations into a Sugar instance. Module loadable packages rely on a manifest.php file to define the basic properties and installation steps for the package.

Delivery and Deployment

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

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 Sell your Work.

Deployment for Devs

Rafael Fernandes — Fri, 08 Jul 2022 17:59:06 GMT

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

TODO

Packaging / Module Loadable Packages

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.

Delivery and Deployment

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.

Deployment for Devs

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

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

Whether starting from scratch or reinventing yourself, this phase is critical to insuring you set a vision and lay the foundation for the future.

Download our GROW Get Started Workbook for detailed plans and worksheets to help you get going. You'll also find additional resources below such as email templates and learning plans to use in your rollout.

Define your Vision

You’ll never reach your destination if you don’t have a clear view of where you are heading. Your vision should be your guiding light throughout your Adoption planning.

When defining your vision consider:
- Your organization's broader strategy, goals, and objectives
- The impact on employee and customer experiences
- What is driving the need for change
- Business capabilities and outcomes

Use the Vision Planning Worksheet in our GROW Get Started Workbook to help define your vision.

Build your Team

People are a key component of successful adoption. Building a core team to support your efforts during roll-out is critical. Review our Build Your Adoption Team download to learn more about each role, then use our Team Planning Worksheet in the GROW Get Started Workbook to identify key players in your organization.

Key players include:

C-Level Business Executive Sponsor
IT Executive Sponsor
Program Manager/Success Owner
Training Lead
Communications Lead
User Council
Departmental Program Ambassadors/Champions
IT Members

Define your Adoption Plan

Your adoption plan is just as important as your overall project plan and should run along side your technology implementation efforts. As you define the phases of your project, align with the following adoption plan phases:

Drive Awareness
Ready your Team
Deploy
Assess & Iterate

Use our Adoption Planning Worksheet in the GROW Get Started Workbook to begin planning your next steps.

Adoption Plan Phases:

Drive Awareness

Raise general awareness through actions and messaging
Engage executive leadership to endorse and promote
Communicate key business benefits
Set expectations regarding usage

Ready Your Team

Prepare teams to operate in the new environment through an understanding of change impacts
Coach users to complete requirements prior to launch
Educate users on functionality with formal education and on-going tips and tricks
Ambassador/Champion Teams & Execs promote goals and solicit feedback

Deploy

Facilitate interactive communication to gather feedback and address questions
Celebrate benefits and wins through participation in sharing of success stories
Reinforce desired behavior through continued executive endorsement and user education

Assess & Iterate

Drive sustained adoption with regular post-deployment touchpoints
Reporting and publicizing progress using usage analysis and adoption metrics
Promote new functionality including major communication campaigns to support key functions

Resources & Downloads

Use the additional resources and downloads below to further support your adoption efforts as your work through the GROW Adoption Framework.

Workbook	GROW Get Started Workbook Build Your Adoption Team Guide
Additional Resources	User Adoption Playbook Optimizing User Adoption Series Optimizing User Adoption Part 1 - Impediments to User Adoption Optimizing User Adoption Part 2 - Creating Well-defined Business Objectives Optimizing User Adoption Part 3 - Building Your Team Optimizing User Adoption Part 4 - Applying Change Management Optimizing User Adoption Part 5 - Measuring, Reporting, Iterating, Adjusting Blog: 9 Steps to a Successful CRM Go-Live Webinar: CRM Blueprint Series - User Adoption eBook: Managing Through Change: The Key Role Managers Play in User Adoption Quick Video Tutorials Data Quality Best Practices CX Assessment
Templates	Adoption Planning Workshop Presentation Project Kickoff Communication Examples Project Update Communication Examples Change Readiness Assessment Template (Long Form) Change Readiness Assessment Template (Short Form) Sample FAQ's Ambassador/Champion Kickoff Template Sugar Connect Adoption Plan & Communication Templates

Learning Plans

Below you'll find links to Learning Plans that contain our recommended courseware for your Sugar solutions at this phase in your adoption journey. Review them yourself or use them to create training plans for your teams to help support your rollout and adoption efforts.

Market	Sell	Serve
Register now	Register now	Register now
Connect	Discover
Learn more	Learn more