First Name
Message subject
Enter your message

* Required Field

SugarCRM Tutorials : Custom Module Development - Helloworld Module

In this tutorial you will see how to develop a simple SugarCRM custom module, it provides a simple steps to create an installable SugarCRM module. We will not discuss about MVC, it is beyond the purpose of this document.

* Choose a name for your module for example Helloworld
* Create the module folder and name it Helloworld,

* Create the manifest file manifest.php [ For more detail about manifest file ]

* Create the directory application, under this directory create app_strings.php.

* Application strings contain the user interface labels displayed globally throughout the application.

* In Modules directory create the directory hw_helloworld (start the name of directory with hw, this is the module key)

* Create the folder language and under this folder create en_us.lang.php file

* These are strings used in the application.

* Create the file Forms.php this file contains functions to render specific JavaScript for validation performed during edits/saves. By default you can leave these empty and have them return ‘’;

* Create hw_helloworld.php file, this file contains bean class. In SugarCRM each module represents one table, and this table is represented by bean class which is derives from SugarBean class. SugarBean provides an interface to the database.

* Create the file vardefs.php: The Vardefs metadata file define fields attributes for the module. [ For more detail about Vardefs ]

* Create the file index.php

* Create a file from the directory

Now we will see how to install it

* Go to Admin -> Developer Tools
* Click on the Module Loader

* Browse to file and click Upload button

* Click on the Commit button

* If the module is installed successfully the screen above will be displayed

* Now you can access to module by clicking on the module's name in the menu and see the text Hello World !

Note: Please note that the source file of this article requires registration to download

Download the source code

Edit the file app_strings.php with your IDE .

Application strings contain the user interface labels displayed globally throughout the

application. Each language has its own application strings variables.


0 #13 Sorina 2013-12-16 16:03
Great article.
0 #12 Saming 2013-08-16 06:54
One example better than one book!

0 #11 Saming 2013-08-16 06:51
Thinks,good tutorials!

And I share with my tech friend!
0 #10 VK 2013-07-19 13:20
thank u so much
+1 #9 Vaishakhi 2012-12-01 14:19
Thank you so much :lol:
+1 #8 Emmanuel Cohen 2012-12-01 14:17
Thanks indeed for the article.
The best starter I've found for Sugar CRM!
+1 #7 Uli 2012-12-01 14:15
Oh Tnx :lol: I googled all day searching for something like this and do not find nothing!
0 #6 poova 2012-12-01 14:14
Oh Fine article ,i try to search abt this lot in internet but i couldnt ,thx for this post.
0 #5 znathan_Alone 2012-12-01 14:13
Thanks you!this is all I research this week!
0 #4 Thomas 2012-12-01 14:08
Hi Source Creativity !

Thanks for sharing this tutorial !
Do you know for which version the HelloWorld module was created ?
I wonder if the Hello World Module is compatible with SugarCRM 6.2.3

See you,

Add comment

Security code

Our solutions are listed on the AppExchange

Our solutions listed on the AppExchange