View source | Discuss this page | Page history | Printable version    | Latest revision

WizardNewFields/User guide

(First step: create a new tab or specify an existing tab)
(How to create a new tab)
Line 64: Line 64:
* The after tab is used to position the new tab in the correct place in the Tabs bar.
* The after tab is used to position the new tab in the correct place in the Tabs bar.
-
==How to create a new tab==
+
==How to create new fields==
 +
Once you have created a new record in the Window tab of the Easy Extensible Attributes module (either to create a new tab, or to extend an existing tab), the next step is to specify the new fields you want to create.
 +
 
 +
To do this, you need to create one record in the "Fields" tab for every field you want to add to the tab.
 +
 
==How to change an already created object==
==How to change an already created object==
==How to remove created objects==
==How to remove created objects==

Revision as of 12:10, 22 February 2010

Contents

Users manual

Purpose of the module

One of the most common development activities in Openbravo is to create a new tab which allows the user to add, modify and delete new information into the database, or to add additional fields to existing tabs. Following Openbravo's Model Driven Development, these processes require the user to create Application Dictionary components for each tab and field he wants to add. The creation of these objects can sometimes be difficult, as lots of properties need to be specified, and some concepts that need to be taken into account, such as Modularity Naming Rules, can be complicated to some non-advanced users.

Moreover, these processes also require the user to add database physical objects (tables and columns) which correspond to the added tabs and fields. These objects are normally created directly through the Database Management System, and not through Openbravo, and this involves an additional step that can also be very difficult to non-advanced users.

The main purpose of this module is to centrallize all the information which is needed for these two common processes, and to greatly simplify the whole process. This module will therefore allow the user to:

And after that, it will:

High level summary of the whole process

All the functionalities which the Easy Extensible Attributes module provides can be accessed through one single window: the Easy Extensible Attributes window, which can be found in General Setup/Application.

The process the user needs to follow to create or to extend new tabs has several steps. This is a short description of every one of them:

These are the steps you need to follow to create the tabs and fields. In the subsequent sections of this guide we will explain each one more in detail.

Initial requirement: Creating a module

This module creates Application Dictionary and database physical objects. As you know, the correct way to create these objects is to use a module which will contain them. Therefore, the main requirement to use this module is to have your own customization module.

You can choose to create the module manually through the application, or you can use the built-in tool to do so.

Creating the module manually has the advantage that you can choose your own name, javapackage, dbprefix, ... However, if you do it this way you must make sure that you create the module correctly. This means that you must make sure that:

If you want to use the built-in tool, you just have to select the "Create standard module" checkbox that appears just beside the Module menu, in the Easy Extensible Attributes window.

Createmodule.png

Specially for new users, it's recommended to use the built-in tool to create the module.

First step: create a new tab or specify an existing tab

The first main step in the process is to create a new entry in the Easy Extensible Attributes window. In this record, you specify:

If you choose to extend a tab, you will need to specify the existing tab you want to extend:

ExtendTab.png

and after selecting the correct tab, you are done with this step, and you can continue with the next one.

If instead you want to create a new tab, you need to provide a little bit more information:

NewTab.png

How to create new fields

Once you have created a new record in the Window tab of the Easy Extensible Attributes module (either to create a new tab, or to extend an existing tab), the next step is to specify the new fields you want to create.

To do this, you need to create one record in the "Fields" tab for every field you want to add to the tab.

How to change an already created object

How to remove created objects