Openbravo Forge End of Life Notice

Dear Openbravo Forge User,

Because of continued very low usage we decided to stop the following services on 31st of August 2017:

In case of question: webmaster "at" openbravo.com
View source | Discuss this page | Page history | Printable version   

WizardNewFields/User guide

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, 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 two different windows: the Easy Extensible Attributes window, which can be found in General Setup/Application, or the Easy Extensible Attributes for developers, which can be found in Application Dictionary.

You should use the first window if you are a user which doesn't want to be bothered by advanced development concepts such as modularity. The second window is designed for developers, and allows you to specify a development module in which the new Application Dictionary will be added (the first one automatically creates a customization module, and adds the objects there).

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.


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.

Newfields.png

You can follow two main paths when creating a field:

If you select one of the field templates, the name and the field type of the field will be automatically set up for you. The basic options in a field are:

The Show Details check activates several additional options for the field:

Newfieldsact.png

Data behaviour

Field behaviour


Important note: Every tab you create needs an identifier field. This means that one of your fields must have the "Used as record identifier" property checked.

Applying the changes to the Application Dictionary

After you've created one record for every field you want to create, you are ready to apply the changes to the Application Dictionary. To do this, return to the "Window" tab in the Easy Extensible Attributes window, and click on the "Apply changes to the Application Dictionary" button.

Applychanges.png

This process will create the new application dictionary objects and database physical objects according to the information you provided in the previous steps.

Rebuilding the system

After the changes were applied to the application dictionary, the system needs to be rebuilt. This can be done directly also in the "Window" tab of the Easy Extensible Attributes window, by clicking in the "Rebuild system" button.

Rebuildsystem.png

After you have rebuilt the system, and restarted Tomcat, the modifications you've made should be fully available in your system (the fields you've added and/or your new tabs should be available in Openbravo).

Basically, at this point, you're done!

How to change an already created object

After you've run the "Apply changes to application dictionary" process, the objects have been created in the database. However, you can still modify them. If you want to do it, you can just modify any property in the "Window" or "Field" tabs in the Easy Extensible Attributes window, and click on the "Apply changes to application dictionary" button again. The objects will be updated to reflect your changes.

How to remove created objects

After you've run the "Apply changes to application dictionary" process, the objects have been created in the Application Dictionary. If, for some reason, you want to remove them, there is a way. The records in both the "Window" tab and the "Field" tab of the Easy Extensible Attributes window have an Active property. If you uncheck this property, and click again on the "Apply changes to application dictionary" button, the related objects will be removed from the Application Dictionary. If you check the property and run the process again, the objects will be recreated.

Retrieved from "http://forge.openbravo.com/plugins/mwiki/index.php/WizardNewFields/User_guide"

This page has been accessed 16,698 times. This page was last modified on 20 May 2010, at 11:19. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.