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

WizardNewFields/User guide

(How to change an already created object)
(Purpose of the module)
Line 13: Line 13:
* Create all the necessary objects in the database (both application dictionary objects and database physical objects) automatically, through a process that is triggered by a single user click.
* Create all the necessary objects in the database (both application dictionary objects and database physical objects) automatically, through a process that is triggered by a single user click.
* Allow the user to initiate the rebuild of the system, which will complete the process (this is necessary to compile the newly created and the modified windows again)
* Allow the user to initiate the rebuild of the system, which will complete the process (this is necessary to compile the newly created and the modified windows again)
 +
 +
==High level summary of the whole process==
 +
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:
 +
* ''Create or specify the module to extend'': The new objects will be created inside a module which needs to be created by the user. The next section in this user manual will cover this topic
 +
* ''Create a new record in the Easy Extendable attributes window'': In this record, you specify whether you want to create a new tab, or extend an existing tab. If you want to create a new tab, you need to provide some additional information.
 +
* ''Create new records in the Field tab of the Easy Extendable Attributes window'': In this tab, you need to create a new record for each additional field you want to create.
 +
* ''Apply the changes to the Application Dictionary'': This process is called from a button in the Easy Extensible Attributes window, in the "Window" tab, and creates all the objects in the Application Dictionary and all the physical database objects.
 +
* ''Rebuild the system'': This final step involves recompiling the application and restarting tomcat. This can also be called directly from the Easy Extensible Attributes window.
 +
 +
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 requirements==
==Initial requirements==

Revision as of 11:24, 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

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 requirements

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. 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

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:

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

How to add fields to an existing tab

How to create a new tab

How to change an already created object

How to remove created objects