{"id":8718,"date":"2024-07-24T05:38:17","date_gmt":"2024-07-24T05:38:17","guid":{"rendered":"https:\/\/www.infinitivehost.com\/knowledge-base\/?p=8718"},"modified":"2024-08-23T09:40:43","modified_gmt":"2024-08-23T09:40:43","slug":"step-by-step-guide-to-creating-custom-modules-in-vtiger-crm-6-5","status":"publish","type":"post","link":"https:\/\/www.infinitivehost.com\/knowledge-base\/step-by-step-guide-to-creating-custom-modules-in-vtiger-crm-6-5\/","title":{"rendered":"Step-by-Step Guide to Creating Custom Modules in Vtiger CRM 6.5"},"content":{"rendered":"
<\/span> 2,221<\/span> Views<\/span><\/div>\n

Creating a custom modules in Vtiger CRM 6.5 involves several steps, including setting up the module directory, creating necessary files, defining module components, and installing the module. Below are detailed steps to guide you through the process:<\/p>\n\n\n\n

Step 1: Set Up the Module Directory<\/h3>\n\n\n\n
    \n
  1. Navigate to the Modules Directory:<\/strong>
    Go to the modules<\/code> directory in your Vtiger CRM installation path.<\/li>\n\n\n\n
  2. Create a New Directory:<\/strong>
    Create a new directory for your custom module. For example, if your module is named “CustomModule”, create a directory named CustomModule<\/code>.<\/li>\n<\/ol>\n\n\n\n

    Step 2: Create the Manifest File (manifest.xml)<\/h3>\n\n\n\n
      \n
    1. Create a manifest.xml File:<\/strong>
      In your module directory (modules\/CustomModule<\/code>), create a file named manifest.xml<\/code>. This file defines the module metadata.<\/li>\n<\/ol>\n\n\n\n
         <module>\n       <name>CustomModule<\/name>\n       <label>Custom Module<\/label>\n       <parent>Settings<\/parent>\n       <type>entity<\/type>\n       <version>1.0<\/version>\n       <isentitytype>true<\/isentitytype>\n       <initfunction>CustomModule_init<\/initfunction>\n       <entityfieldname>custommodule_name<\/entityfieldname>\n       <entityidfield>custommoduleid<\/entityidfield>\n       <tables>\n           <table>\n               <name>vtiger_custommodule<\/name>\n               <sql>CREATE TABLE vtiger_custommodule (\n                   custommoduleid INT NOT NULL AUTO_INCREMENT,\n                   custommodule_name VARCHAR(255),\n                   PRIMARY KEY (custommoduleid)\n               );<\/sql>\n           <\/table>\n       <\/tables>\n       <blocks>\n           <block>\n               <label>LBL_CUSTOMMODULE_INFORMATION<\/label>\n               <fields>\n                   <field>\n                       <columnname>custommodule_name<\/columnname>\n                       <uitype>2<\/uitype>\n                       <typeofdata>V~M<\/typeofdata>\n                       <label>LBL_CUSTOMMODULE_NAME<\/label>\n                   <\/field>\n               <\/fields>\n           <\/block>\n       <\/blocks>\n   <\/module><\/mark><\/code><\/code><\/pre>\n\n\n\n
      Step 3: Define Module Components<\/h3>\n\n\n\n
        \n
      1. Module Class:<\/strong>
        Create a PHP file named CustomModule.php<\/code> in your module directory. This file defines the module class.<\/li>\n<\/ol>\n\n\n\n
           <?php\n   class CustomModule extends CRMEntity {\n       public $table_name = 'vtiger_custommodule';\n       public $table_index = 'custommoduleid';\n       public $customFieldTable = Array('vtiger_custommodulecf', 'custommoduleid');\n       public $tab_name = Array('vtiger_crmentity', 'vtiger_custommodule', 'vtiger_custommodulecf');\n       public $tab_name_index = Array(\n           'vtiger_crmentity' => 'crmid',\n           'vtiger_custommodule' => 'custommoduleid',\n           'vtiger_custommodulecf' => 'custommoduleid'\n       );\n       public $list_fields = Array (\n           'Custom Module Name' => Array('custommodule', 'custommodule_name'),\n       );\n       public $list_fields_name = Array (\n           'Custom Module Name' => 'custommodule_name',\n       );\n       public $list_link_field = 'custommodule_name';\n       public $search_fields = Array(\n           'Custom Module Name' => Array('custommodule', 'custommodule_name'),\n       );\n       public $search_fields_name = Array (\n           'Custom Module Name' => 'custommodule_name',\n       );\n       public $popup_fields = Array ('custommodule_name');\n       public $def_basicsearch_col = 'custommodule_name';\n       public $def_detailview_recname = 'custommodule_name';\n       public $mandatory_fields = Array('custommodule_name');\n       public $default_order_by = 'custommodule_name';\n       public $default_sort_order='ASC';\n   }<\/mark><\/code><\/code><\/pre>\n\n\n\n
          \n
        1. Language File:<\/strong>
          Create a language file in languages\/en_us\/CustomModule.php<\/code> to define the language strings for your module.<\/li>\n<\/ol>\n\n\n\n
             <?php\n   $languageStrings = array(\n       'CustomModule' => 'Custom Module',\n       'SINGLE_CustomModule' => 'Custom Module',\n       'LBL_CUSTOMMODULE_INFORMATION' => 'Custom Module Information',\n       'LBL_CUSTOMMODULE_NAME' => 'Custom Module Name',\n   );<\/mark><\/code><\/code><\/pre>\n\n\n\n
          Step 4: Install the Module<\/h3>\n\n\n\n
            \n
          1. Zip the Module Directory:<\/strong>
            Compress the CustomModule<\/code> directory into a .zip<\/code> file.<\/li>\n\n\n\n
          2. Upload the Module:<\/strong><\/li>\n<\/ol>\n\n\n\n