Home  >   Articles   >  Module Management - Module Builder
Articles in this section

Module Management - Module Builder

Create custom modules, add custom blocks and fields, and create relationships with other modules using Vtiger's Module Builder.
18 Dec, 2023 - Updated 7 months ago
Table of Contents


Did you know you can create custom modules in Vtiger CRM? 

Yes, you heard that right! No matter what kind of business you own, you can build custom modules to store the kind of information that you like.

Sounds exciting, doesn’t it? So channelize the developer in you and read on for details.


Let us begin by learning what a module is. 

Technically, a module is a set of independent units that have similar characteristics. A CRM module is something alike. It is a set of records that store a particular type of information.

Here is an example to give you a clear understanding. 

A famous tradeshow is being held at a nearby convention center. You participate in the tradeshow, where you set up a counter to showcase your products. Interested prospects leave their name and contact details in a register to get a demo of your products.

Now, instead of using the register, you can store the name and contact details in a CRM record. And you can create this record in the Leads module of Vtiger CRM.

Similarly, you can have different modules for different types of information. Because customizability is one of Vtiger CRM’s core possibilities, you can create custom modules as per your business requirements. 

Now that we have an idea about modules, let us learn how to create one.

Creating a Module

Creating a module involves five steps.

  1. Accessing the Module Management settings
  2. Specifying the module properties
  3. Creating blocks and fields
  4. Choosing columns for your default lists
  5. Creating relationships with other modules

We’ll look at all the five steps in detail, but before that, let’s look at an example of a module.

Consider that your company has acquired a new project, and you need to assign a special workforce to it. You can create a module called Workforce under the Projects app. The workforce will contain records of all the team members working on the new project.


Note: You can create custom modules only if you are an Admin user.


Now, let’s understand the procedure!

Follow these steps to create a module:

Step 1: Access the Module Builder

In this step, we’ll learn how to view the Module Builder in the CRM.

  1. Log in to the CRM.
  1.  Click the User Menu on the top right corner of the screen.
  2. Click the Settings button. You will land on the Settings page. 
  1.  Look for the Module Management section.
  2. Click Module Builder.

Step 2: Specify the Module Properties

To build a module, you must specify its basic details.  

  1.  Enter the following information:
    1. Module Label - Specify the module name. For example, Workforce
    2. Singular Module Label - Specify the module name in the singular form. For example, if the module name is Contacts, then Contact is its singular form. The singular form of Workforce is Workforce.
    3. Select App Category - Select the app under which you want to create the module. For instance, you can create Workforce under Projects.
    4. Record Identifier - Specify the label by which you want to identify the module’s records. For example, Workforce Records are identified by Workforce Name.
  2. Click the Create button.

Step 3: Create Blocks and Fields 


Note: Some fields are provided by default in the Basic Information block. You can also create custom fields and blocks if needed.

  1. Click the +Add Block button to create a new block. An Add Block window opens. ​​​​​​
    • Enter the Block Name.
    • Select Add After from the drop-down. Choose the existing block, after which you want to add the new block. 
    • Click Save.
  1. Click the +Add Custom Field button in the newly created block. ​​​​​​
    1. Select the Field type. For example, Phone for a phone number, Text for a name, etc.
    2. Enter the Label name
    3. Enter Min characters allowed.
    4. Enter Max characters allowed.
    5. Enter a default value for the field.
    6. Set the field properties:​​​​​​
      1. Mandatory Field - If enabled, entering a value for the field becomes mandatory.
      2. +Quick Create - The field becomes available under Quick Create if enabled. 
      3. Key Field View - If enabled, the field appears in the Key Fields section of a contact’s Summary View.
      4. Header View -If enabled, the field appears in the Header section of a contact’s Summary View.
      5. Mass Edit - If enabled, you can perform a mass edit action on the field.
  2. Click Save. A success message will appear.
  1.  Click the Next button.

Step 4: Choose the Default Filter

In this step, you must choose the columns that will appear by default in the module's List View. 

  1.  Click on the space provided under Choose columns and order (Max 16).
  2. Select fields from the list to add to the List View.
  3. Click the Next button. 

Step 5: Build a relationship between the custom module and other modules 

To create a link between records in different modules, you must build a relationship between the modules.

  1.  Click the +Add Relationship button (on the left, under the tabs). 
  1.  Choose the module with which you want to create a relationship from the Select related module drop-down.
    1. Considering the example above, you must choose Projects from the drop-down. Projects become the related module.
  2. Pick a relationship type under Select relationship type.
  3.  Specify the names of the related and custom module fields/tabs that must appear in the modules’ records. (You will get more clarity on this in the next section.)
  4. Click Save.

We have detailed information on the need to create relationships between modules, different types of relationships, and the procedure to follow. To learn about it,  click here.

Deleting a Module

You can delete only custom modules. Deleting a custom module does not affect the existing modules.

Note: You can delete a module only if you are an Admin user.


Follow these steps to delete a custom module:

  1. Log in to the CRM.
  2. Click the User Menu on the top right corner of the screen.
  3. Click Settings. You will land on the Settings page.
  4. Look for the Module Management section.
  1. Click Modules.
  2. Look for the desired module on the Modules page.
  3. Hover over the module's More icon (three dots).
  4. Click the Delete option.
  1. Click Yes to confirm.

Note: You have the delete option only for custom modules, not system ones.

      Was this article helpful?
      2  out of  8  found this helpful.
      Comments 0
      Be the first to comment
      © Copyright 2023 Vtiger. All rights reserved.