FAQs in this section
How do I create a Custom module in Vtiger CRM?
Table of Contents
Creating a module involves the following steps:
Step 1: Accessing the Module Management settings
Step 2: Specifying module properties
Step 3: Creating blocks and fields
Step 4: Choosing columns for your default lists
Step 5: Creating relationships with other modules
Step 1: Accessing the Module Management settings
Step 2: Specifying module properties
Step 3: Creating blocks and fields
Step 4: Choosing columns for your default lists
Step 5: Creating relationships with other modules
Step 1: Accessing the Module Management Settings
Follow these steps to access module management settings:- Log in to the CRM.
- Click the User Menu on the top right corner of the screen.
- Click Settings. You will land on the Settings page.
- Look for the Module Management section.
- 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.- Enter or select the following information to add information for the new module:
- Module Label - Specify the module name. For example, Workforce
- 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.
- Select App Category - Select the app under which you want to create the module. For instance, you can create Workforce under Projects.
- Record Identifier - Specify the label by which you want to identify the module’s records. For example, Workforce Records are identified by Workforce Name.
- Click the Create button.
Step 3: Creating Blocks and Fields
- 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.
- Click the +Add Custom Field button in the newly created block.
- Select the Field type. For example, Phone for a phone number, Text for a name, etc.
- Enter the Label name.
- Enter Min characters allowed.
- Enter Max characters allowed.
- Enter a default value for the field.
- Set the field properties:
- Mandatory Field - If enabled, entering a value for the field becomes mandatory.
- +Quick Create - The field becomes available under Quick Create if enabled.
- Key Field View - If enabled, the field appears in the Key Fields section of a contact’s Summary View.
- Header View -If enabled, the field appears in the Header section of a contact’s Summary View.
- Mass Edit - If enabled, you can perform a mass edit action on the field.
- Click Save. A success message will appear.
- Click the Next button.
Step 4: Choose the Default Filter
- Click on the space provided under Choose columns and order (Max 16).
- Select fields from the list to add to the List View.
- Click the Next button.
Step 5: Build a relationship between the custom module and other modules
- Click the +Add Relationship button (on the left, under the tabs).
- Choose the module you want to create a relationship with from the Select related module drop-down.
- Considering the example above, you must choose Projects from the drop-down. Projects become the related module.
- Pick a relationship type under Select relationship type.
- Specify the names of the related and custom module field or tab that must appear in the module’s records.
- Click Save.
Was this FAQ helpful?
0
out of
3
found this helpful.
Comments 0
Be the first to comment