Skip to content

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
    • Help
    • Submit feedback
    • Contribute to GitLab
  • Sign in
D
Documentation
  • Project
    • Project
    • Details
    • Activity
    • Releases
    • Cycle Analytics
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Charts
  • Issues 0
    • Issues 0
    • List
    • Board
    • Labels
    • Milestones
  • Merge Requests 0
    • Merge Requests 0
  • CI / CD
    • CI / CD
    • Pipelines
    • Jobs
    • Schedules
    • Charts
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Members
    • Members
  • Collapse sidebar
  • Activity
  • Graph
  • Charts
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
  • vtap
  • Documentation
  • Wiki
  • Module Designer

Module Designer

Last edited by Vikas May 27, 2021
Page history

Module Designer

Module Designer allows you to create or extend functionality of a module within CRM.

  • Module Designer
    • Module Types
      • Entity Module
      • Extension Module
      • Embed Module
    • Customizer
      • Component
      • Page
      • TAP Scripts
      • TAP Styles

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.

MODULENAME Module where you are defining the component from.
COMPNAME Name of the component. Ex: BasicButton

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.

Clone repository
  • API Designer
  • Core server resources
  • Module Designer
  • VTAP Javascript APIs
  • Home
More Pages

New Wiki Page

Tip: You can specify the full path for the new file. We will automatically create any missing directories.