Menu ▾ ▴

CreatingANewEntityModule

Federico

Creating a new Entity Module

vtlib simplifies creation of new vteddy modules. Developers can use vtlib to develop vteddy modules that add new functionality to vteddy. These modules can then be packaged for easy installation by the Module Manager.

NOTE: In this document we will explain the process of creating a new module by building an example 'InstalledBase' Module.

The following are important steps that should be followed to get a basic working module. The backend section covers database level changes for the module, and the frontend section covers the UI files.

Backend

  • Step 1: Create module instance, create database tables, and add it to Menu.

  • Step 2: Add UI blocks for the module.

  • Step 3: Add fields and associate it to blocks. Set at-least one field as entity identifier.

  • Step 4: Create default list view and additional filters (make sure to create a filter named All which is the default filter).

  • Step 5: Create Related List (to show in the ''More information'' tab).

  • Step 6: Setting Sharing Access Rules.

  • Step 7: Setting Module Tools options (i.e., Import/Export).

FrontEnd

  • Step 8: Creating Module directory and files.

Additional Options

  • Module Templates (to customize Form, List View, and Settings UI )
  • Module Settings (to allow administrators to configure your module)
  • Module Events (only available in vteddy version 5.1)

These steps are explained in detail in the course of this section.

We are using the example module 'InstalledBase' to explain the use of vtlib APIs.

About InstalledBase Module

It will have the ability to create, edit, delete installedbase records. You can create Custom Filters for the Listview, which displays the list of payslip instances.

We shall associate this module with the Tools menu.