Getting Started with Your First SugarCRM Module using SugarStudio

Getting Started with your First SugarCRM Module using SugarStudio: Take a look at this perfect guide and learn everything you need to know about the First SugarCRM Module.




February 13, 2017





SugarCRM is one of the top customer relationship software to carry out amazing, innovative, and sales-driven automated relationships with your clients or customers. It lets you enable all the force-driven work in just easy steps. It lessens the burden of the overall effort and team management, as well as lead management

So, the customer will find relief and you do not have to worry about managing sales, invoices, lead generation, and personalized interaction.

I am about to guide you through the creation and deployment of your very first SugarCRM Module.  

Pre-requisites for Creating Your Own SugarCRM Module

Starting your very first SugarCRM module needs

  1. A web server (XAMPP as your local server).
  2. Go to HTTP://
  3. Install SugarCRM (I always prefer installing the community software download).
  4. Run Apache and MySQL.
  5. Check localhost/sugar (sugar is the folder under the htdoc/ directory.

Now, you are done with the pre-configuration.


Creating your First SugarCRM Module

After installing the configuration for your SugarCRM, fill in the necessary details for creating your account on the SugarCRM panel.

The necessary steps will be:

  • Login to the SugarCRM Dashboard




  • You will get the Admin Area.


admin tab.webp


  • In the admin tab, under the developer tool, click on ‘Module Builder.


admin tab 2.webp


  • Click 'New Package' (this will be your package for your module)




  • After filling in the necessary fields in the form, click 'Save'.

activities 3.webp

Click on the 'Add Module' button. Here you will have to add the module details that what is it all about, what are its features, and what type of module you want to build (it includes the type of module like basic, company, file issue, and sales)


loading page.webp

  1. Now, according to your requirement and need you can create fields, layouts, and other drag-and-drop type things to develop your module.
  2. This is how things will work and your module will be created by using the “Module Builder”. From the left panel, you can add you're relevant fields to the layout. That is under the module (sub-directory).


Let’s Make One Simple Module

The steps for creating a module for adding the simple fields are:

  1. Create fields by filling out the necessary details by filling out the form under the ‘Add Field’ response.

field response.webp


  1. Here is the list of fields that you can create in your custom module.

edit labels.png


  1. Now go to Layout under your Module, and create the layout by dragging and dropping the fields that you have created.

restore default.webp


  1. Under the Search directory, you can further adjust the layout.
  2. After doing all the layout options and operations. At the left panel of the dashboard, where the directory is shown, click on the name of the module that you have just created.
  3. By clicking the module,  options will be displayed on the right side of the screen like:



  1. Click on the ‘Deploy’ button, and your module will be deployed.
  2. Once done, click on the All tab and you will find your newly created module in the list of modules.

select a package.webp


  1. In this module, I have just created fields under a form and deployed them. Now click on the Module and enjoy using your SugarCRM module.



  1. The created instances are saved under the View “xModule” (that is the name of your module).


Other Way of Doing It

This is the whole process of how to create, develop and deploy the SugarCRM module. You can also make the package of your required functionality.

  1. Wrap up its Html, CSS, and PHP file in a folder in a zip file.
  2. Click on the new Module and just deploy it in the Admin area.
  3. Your Plugin/module is all set and you can use it.



This is the procedure about how you create and deploy your very first SugarCRM module/plugin using SugarStudio. We have PHP developers with experience in SugarCRM. We are providing the SugarCRM solutions, its customization, and all the service and maintenance for it.

Islamabad, Pakistan

Floor 2, Building 145, Civic Center Bahria Town Phase 4, Islamabad, Pakistan


1 squire armor road, windham, NH,03076

Saudi Arabia

7654 Prince Nawaf Street, Al Khobar, 34426

Kingdom Of Bahrain

No 851, Bldg No 2420, Rd No 2831, Seef District, Block 428