Home  >   Articles   >  Adding Custom Module
Articles in this section

Adding Custom Module

Lavanya R
4 Jun, 2024 - Updated 1 month ago
Table of Contents


With Vtiger CRM, you can utilize the Module Builder to create a customized module that suits your business requirements. It's a simple way to design a basic module. 

This feature allows you to add module properties, custom blocks, and fields, default filters to your custom module, and establish relationships with other modules.

Feature Availability

One Growth

One Pilot

One Professional

One Enterprise

Feature Availability

Adding Custom Module



Click here to learn more about Feature Limits.


The following are the benefits of Custom Modules:

Customize according to Business - Custom modules in Vtiger CRM allow you to align the CRM with your unique business processes and requirements.
Structure and organize data  - With a custom module, you can structure and organize data based on your business requirements.
Integration with existing modules - This allows cross-referencing and linking data between modules. It creates a comprehensive view of customer interactions, transactions, and other relevant information.

Creating a Custom Module

You can create custom modules from the Settings > Modules page. You can create one if your business has information that cannot be stored in the default Vtiger modules. 

Creating a module involves the following steps:

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

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


Step 1: Accessing the Module Management Settings

Follow these steps to access module management settings:

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

Step 2: Specifying the details for the new module

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

  1. Enter or select the following information to add information for the new module:
    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.

Once a module is created, you will be moved to the next section, Blocks, and Fields.

Step 3: Creating 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. For example, you can add under Basic Information, Address Details under Basic Information, etc. 

  1. Click the +Add Block button to create a new block. An Add Block window opens.
  1. Enter the Block Name.
  2. Select Add After from the drop-down. Choose the existing block, after which you want to add the new block. 
  3. 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.
  1. Click Save. A success message will appear.
  1. Click the Next button.

Step 4: Choose the Default Filter

The Default Filter allows you to choose the columns you want to appear in a module's List View.
In this step, you must choose the columns appearing 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 or tabs that must appear in the module’s records. 
  4. Click Save.

Creating a Relationship between Modules

We first need to land on the Relationships page to create a relationship.

Follow these steps to view the Relationships page:

  1. Log in to the CRM.
  2. Click the User Menu on the top right corner of the screen.
  3. Click the Settings button. You will land on the Settings page.
  4. Look for the Module Management section.
  1. Click Module Layouts & Fields.
  2. Select a module from the Select Module drop-down. You can pick one of the two modules you want to relate to.
  3. Click the Relationships tab.

Follow these steps to create a relationship: 

  1. Click the +Add Relationship button.
  1. Select the related module from the Select related module drop-down.
  2. Pick the relationship you want to create from the Select relationship type.
  3. Enter the field and tab names of the related records. 
  4. Click Save.
In CRM, you can not only create modules, but you can also create relationships between them and define different types of relationships. Click here to learn more. 

Deleting a Module

You can delete only custom modules. Deleting custom modules does not affect 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 your CRM account.
  2. Click the User Menu on the top right corner of the CRM screen.
  3. Click Settings.
  4. Go to 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.


Module Management - Creating Relationships Between Modules
Module Management - Module Builder

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