|
|
## Module Designer
|
|
|
|
|
|
Module Designer allows you to create or extend functionality of a module within CRM.
|
|
|
|
|
|
[[_TOC_]]
|
|
|
|
|
|
### Module Types
|
|
|
|
|
|
Modules can be classified into 3 types.
|
|
|
|
|
|
|
|
|
#### Entity Module
|
|
|
|
|
|
Follows standard convention to store, retrieve, filter and establish relationships between other entity module records. Workflows, Reporting, sharing and profile access control is automatically enabled based on the assigned user of record.
|
|
|
|
|
|
Example: Contacts, Organizations, Deals, Cases etc…
|
|
|
|
|
|
|
|
|
#### Extension Module
|
|
|
|
|
|
Modules that bring functionality without necessarily binding to standard record conventions are named as extension modules. Usually they provide in-app specific functionality that works with user accessible entity module records. Access to records is possible through VTAP Runtime.
|
|
|
|
|
|
Example: Reports, Dashboard etc…
|
|
|
|
|
|
|
|
|
#### Embed Module
|
|
|
|
|
|
Allows embedding external applications or web-page inside CRM.
|
|
|
|
|
|
|
|
|
### Customizer
|
|
|
|
|
|
Module Designer offers IDE through which you can develop custom code for building functionality.
|
|
|
|
|
|
Through customizer IDE you will be able to create and customize the following
|
|
|
|
|
|
|
|
|
#### Component
|
|
|
|
|
|
Comprises of one or more UI elements together providing specific functionality on the page.
|
|
|
|
|
|
Example: Menu, Oneview Widgets
|
|
|
|
|
|
_Naming Convention_
|
|
|
|
|
|
Component names follow core product convention for runtime binding. The format of is as follows:
|
|
|
|
|
|
MODULENAME_Component_COMPNAME
|
|
|
|
|
|
For example if you have a component with name "CustomButton" then component name will be Contacts_Component_CustomButton. For more details about the component and its structure click [here](https://extend.vtiger.com/vtap/documentation/wikis/VTAP-Runtime#vtapcomponent).
|
|
|
|
|
|
<table>
|
|
|
<tr>
|
|
|
<td>MODULENAME
|
|
|
</td>
|
|
|
<td colspan="2" >Module where you are defining the component from.
|
|
|
</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>COMPNAME
|
|
|
</td>
|
|
|
<td>Name of the component.
|
|
|
</td>
|
|
|
<td>Ex: BasicButton
|
|
|
</td>
|
|
|
</tr>
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
#### Page
|
|
|
|
|
|
Comprises of one or more Components having custom client-side runtime behaviour.
|
|
|
|
|
|
|
|
|
#### TAP Scripts
|
|
|
|
|
|
Enables you to extend functionality of standard pages or components by subscribing to the event hooks and reacting to the triggers at runtime.
|
|
|
|
|
|
|
|
|
#### TAP Styles
|
|
|
|
|
|
Enables you to customize the look & feel of client components or pages in the CRM.
|
|
|
|
|
|
To add custom scripts, pages and components you need to use VTAP Runtime object. It allows you to interact with Vtiger user interface and add custom behaviors. Learn more about it [here](https://extend.vtiger.com/vtap/documentation/wikis/VTAP-Runtime). |