{"id":8684,"date":"2024-07-10T06:06:51","date_gmt":"2024-07-10T06:06:51","guid":{"rendered":"https:\/\/www.infinitivehost.com\/knowledge-base\/?p=8684"},"modified":"2024-08-23T08:09:43","modified_gmt":"2024-08-23T08:09:43","slug":"create-custom-module-in-vtiger7-with-vtlib-step-by-step-guide","status":"publish","type":"post","link":"https:\/\/www.infinitivehost.com\/knowledge-base\/create-custom-module-in-vtiger7-with-vtlib-step-by-step-guide\/","title":{"rendered":"Create Custom Module in vTiger7 with vtlib: Step-by-Step Guide"},"content":{"rendered":"
<\/span> 1,961<\/span> Views<\/span><\/div>\n

Creating a custom module in vTiger7 using vtlib involves several steps. Here is a step-by-step guide to help you through the process:<\/p>\n\n\n\n

Step 1: Set Up Your Environment<\/h3>\n\n\n\n
    \n
  1. Backup<\/strong>: Always take a backup of your current vTiger instance, including the database.<\/li>\n\n\n\n
  2. Environment<\/strong>: Ensure you have a working vTiger 7 instance and access to the server.<\/li>\n<\/ol>\n\n\n\n

    Step 2: Create the Basic Structure<\/h3>\n\n\n\n
      \n
    1. Folder Structure<\/strong>: Navigate to modules<\/code> directory in your vTiger installation and create a new folder for your custom module. For example, if your module is named “CustomModule”, create a folder named CustomModule<\/code>.<\/li>\n\n\n\n
    2. Module File<\/strong>: Inside your CustomModule<\/code> folder, create a file named CustomModule.php<\/code>. This file will contain the class for your module.<\/li>\n<\/ol>\n\n\n\n

      Step 3: Define the Module Class<\/h3>\n\n\n\n

      In CustomModule.php<\/code>, define your module class:<\/p>\n\n\n\n

      <?php\n\ninclude_once 'modules\/Vtiger\/CRMEntity.php';\n\nclass CustomModule extends CRMEntity {\n    public $table_name = 'vtiger_custommodule';\n    public $table_index= 'custommoduleid';\n\n    \/\/ Define the mandatory table for supporting custom fields.\n    public $customFieldTable = Array('vtiger_custommodulecf', 'custommoduleid');\n\n    \/\/ Define the list of tables related to this module.\n    public $tab_name = Array('vtiger_crmentity', 'vtiger_custommodule', 'vtiger_custommodulecf');\n\n    public $tab_name_index = Array(\n        'vtiger_crmentity' => 'crmid',\n        'vtiger_custommodule' => 'custommoduleid',\n        'vtiger_custommodulecf'=>'custommoduleid'\n    );\n\n    public $list_fields = Array (\n        'Custom Field' => Array('custommodule', 'customfield'),\n        'Assigned To' => Array('crmentity','smownerid')\n    );\n\n    public $list_fields_name = Array (\n        'Custom Field' => 'customfield',\n        'Assigned To' => 'assigned_user_id'\n    );\n\n    public $list_link_field = 'customfield';\n\n    public $search_fields = Array(\n        'Custom Field' => Array('custommodule', 'customfield')\n    );\n\n    public $search_fields_name = Array (\n        'Custom Field' => 'customfield'\n    );\n\n    public $popup_fields = Array ('customfield');\n\n    public $def_basicsearch_col = 'customfield';\n\n    public $def_detailview_recname = 'customfield';\n\n    public $mandatory_fields = Array('customfield', 'assigned_user_id');\n\n    public $default_order_by = 'customfield';\n    public $default_sort_order='ASC';\n}\n?><\/mark><\/code><\/code><\/pre>\n\n\n\n
      Step 4: Create the Installation Script<\/h3>\n\n\n\n
      Create an installation script to register your module. Create a file named manifest.xml<\/code> in the CustomModule<\/code> directory:<\/p>\n\n\n\n
      <?xml version=\"1.0\"?>\n<module>\n    <name>CustomModule<\/name>\n    <label>Custom Module<\/label>\n    <parent>Tools<\/parent>\n    <version>1.0<\/version>\n    <type>entity<\/type>\n    <php_version>5.2<\/php_version>\n    <dependencies>\n        <vtiger_version>7.0<\/vtiger_version>\n    <\/dependencies>\n    <tables>\n        <table>\n            <name>vtiger_custommodule<\/name>\n            <engine>InnoDB<\/engine>\n            <fields>\n                <field>\n                    <name>custommoduleid<\/name>\n                    <type>int<\/type>\n                    <nullable>false<\/nullable>\n                    <key>PRI<\/key>\n                    <extra>auto_increment<\/extra>\n                <\/field>\n                <field>\n                    <name>customfield<\/name>\n                    <type>varchar<\/type>\n                    <nullable>false<\/nullable>\n                    <length>255<\/length>\n                <\/field>\n            <\/fields>\n        <\/table>\n        <table>\n            <name>vtiger_custommodulecf<\/name>\n            <engine>InnoDB<\/engine>\n            <fields>\n                <field>\n                    <name>custommoduleid<\/name>\n                    <type>int<\/type>\n                    <nullable>false<\/nullable>\n                    <key>PRI<\/key>\n                <\/field>\n            <\/fields>\n        <\/table>\n    <\/tables>\n<\/module><\/mark><\/code><\/code><\/pre>\n\n\n\n
      Step 5: Install the Module<\/h3>\n\n\n\n
        \n
      1. Upload the Folder<\/strong>: Upload your CustomModule<\/code> folder to the modules<\/code> directory of your vTiger installation.<\/li>\n\n\n\n
      2. Install via vtiger<\/strong>: Log in to vTiger as an administrator, go to the Module Management section, and use the “Import Module” feature to upload and install your CustomModule<\/code>.<\/li>\n<\/ol>\n\n\n\n
        Step 6: Configure the Module<\/h3>\n\n\n\n
          \n
        1. Create Fields<\/strong>: Use the Layout Editor in vTiger to add fields to your module as needed.<\/li>\n\n\n\n
        2. Permissions<\/strong>: Set permissions for roles to access the new module.<\/li>\n<\/ol>\n\n\n\n
          Step 7: Test Your Module<\/h3>\n\n\n\n
            \n
          1. Verify Installation<\/strong>: Check that the module appears in the CRM and that you can create, view, edit, and delete records.<\/li>\n\n\n\n
          2. Debug<\/strong>: If there are any issues, check the vTiger.log<\/code> and PHP error logs<\/code> for troubleshooting.<\/li>\n<\/ol>\n\n\n\n
            This guide provides the basic steps to create and register a custom module in vTiger 7. Depending on your specific requirements, you may need to add more customizations and functionalities.<\/p>\n\n\n\n
            Conclusion<\/h2>\n\n\n\n
            All the best mentioned guides help you to easily create a custom module in Vtiger solutions with the help of vtlib. If you follow all the steps properly, then you can successfully create a custom module. For all this, it is very necessary to take backups of everything. If you want to get the best vtiger hosting solutions<\/strong><\/mark><\/a>, then you must find out the best service providers like Infinitive Host to get budget-friendly solutions.<\/p>\n","protected":false},"excerpt":{"rendered":"
            1,961 Views Creating a custom module in vTiger7 using vtlib involves several steps. Here is a step-by-step guide to help you through the process: Step 1: Set Up Your Environment Step 2: Create the Basic Structure Step 3: Define the Module Class In CustomModule.php, define your module class: Step 4: Create the Installation Script Create […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"inline_featured_image":false,"footnotes":""},"categories":[204],"tags":[83,112,13,87,162],"class_list":["post-8684","post","type-post","status-publish","format-standard","hentry","category-vtiger-solutions","tag-cpanel","tag-cpaneltutorial","tag-server","tag-web-hosting","tag-whm"],"_links":{"self":[{"href":"https:\/\/www.infinitivehost.com\/knowledge-base\/wp-json\/wp\/v2\/posts\/8684","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.infinitivehost.com\/knowledge-base\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.infinitivehost.com\/knowledge-base\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.infinitivehost.com\/knowledge-base\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.infinitivehost.com\/knowledge-base\/wp-json\/wp\/v2\/comments?post=8684"}],"version-history":[{"count":2,"href":"https:\/\/www.infinitivehost.com\/knowledge-base\/wp-json\/wp\/v2\/posts\/8684\/revisions"}],"predecessor-version":[{"id":8889,"href":"https:\/\/www.infinitivehost.com\/knowledge-base\/wp-json\/wp\/v2\/posts\/8684\/revisions\/8889"}],"wp:attachment":[{"href":"https:\/\/www.infinitivehost.com\/knowledge-base\/wp-json\/wp\/v2\/media?parent=8684"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.infinitivehost.com\/knowledge-base\/wp-json\/wp\/v2\/categories?post=8684"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.infinitivehost.com\/knowledge-base\/wp-json\/wp\/v2\/tags?post=8684"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}