New window creation tutorial

10th may 2006 Revision 0.91

Visit us at www.openbravo.com

Table of Contents
I. Introduction........................................................................................................................ 3 II. Create new tables in the racle database....................................................................... ! penbravo #R$ dictionary.............................................. % penbravo menu............................................................. 11 III. Re"ister the new tables in the V. (in)in" a new window to the

IV. Creatin" a new &indow.................................................................................................. '

newwindow*tutorial + ,ay 10- 2006

2.1%

I.Introduction

I.

Introduction
penbravo is a pure web+based e/tended #R$ 0or 1,#s 21mall and ,idsi3e #nterprises4. 5he e/tended #R$ solution includes basic CR, 2Customer Relationship ,ana"ement4 and 6I 26usiness Intelli"ence4 and a broad ran"e o0 standard 0unctionalities such as purchasin"- warehousin"- pro7ects- manu0acturin" and sales mana"ement- 0inancial mana"ement and much more. penbravo is in production in companies spannin" several industries- includin" distributionservices and manu0acturin". 5he aim o0 this tutorial is to show how to create a new application window in penbravo #R$. 8s an e/ample- we use a new window that allows us to introduce in0ormation about documents. 5his tutorial assumes that you already have installed and runnin" #R$. penbravo

newwindow*tutorial.odt + ,ay 10- 2006

3.1%

II.

Create new tables in the Oracle database

9irst you have to create the new tables in the database en"ine that penbravo uses as bac)end 2currently only racle is supported4. :ou can use racle 1;(<$lus application provided with your standard racle pac)a"e. nce the 1;(<$lus is started- you are as)ed to lo" in. I0 you have used the de0ault penbravo con0i"uration parameters durin" the installation- use 58= as >username?- 58= as a >password? and RC( as a host name. :ou "et now 1;( prompt that allows you to introduce 1;( statements directly. 9or this e/ample- we type the 0ollowin" 1;( statement to create the documents table that we use in this tutorial@

CREATE TABLE DOCUMENTS ( DOCUMENTS_ID NUMBER(10) NOT NULL, AD_CLIENT_ID NUMBER(10) NOT NULL, AD_ORG_ID NUMBER(10) NOT NULL, ISACTIVE CHAR(1 BYTE) DEFAULT 'Y' NOT NULL, CREATED DATE DEFAULT SYSDATE NOT NULL, CREATEDBY NUMBER(10) NOT NULL, UPDATED DATE DEFAULT SYSDATE NOT NULL, UPDATEDBY NUMBER(10) NOT NULL, NAME NVARCHAR2(60) NOT NULL, LASTEDITED DATE NOT NULL, DOCSIZE NUMBER(15) NOT NULL );

nce e/ecuted- a new table called >=ocuments? is created in

racle.

&hen de0inin" your own tables- it is always necessary to consider that@ :ou always need to de0ine the 8=*Client*I=- 8=* r"*I=- Is8ctiveCreated- Created6y- Apdated and Apdated6y 0ields as shown in the sample. 5his 0ields are used internally by pen6ravo #R$. 5he primary )ey o0 the table is not shown in the application at any momentthere0ore althou"h in the e/ample >B8,#? and >(815#=I5#=? 0ields could 0orm a ma7or )ey- we use an e/tra 0ield that is an uniCue identi0ier- is this case = CA,#B51*I=. It is recommended to name the primary )ey 0ield usin" the name o0 the table plus the *I= su00i/.

newwindow*tutorial.odt + ,ay 10- 2006

!.1%

III.

Register the new tables in the Openbravo ERP dictionary

Bow you have to re"ister the newly created database tables in the penbravo #R$ dictionary. 5o achieve this- 0irst lo" into penbravo usin" an account with access to the 1ystem 8dministration role. Bow- "o to the >5able and Column? option in the >8pplication directory? menu. 1elect the >Bew Record? icon 2 4 0rom the toolbar. 5he 0ollowin" 0orm is displayed@

Dere there is a description o0 the main 0ields o0 this 0orm@

Name. =e0ines the name which penbravo uses to name the de0ined database table into the 8pplication =ictionary. escription. Eives a small description to the table dictionary. !elp"Comments@ =e0ines the te/t that is displayed in the help &indow. # Table name@ =e0ines the database table name that we have previously created in the database en"ine. Entity type. 5he type o0 entity. 9or our own tables- we should use >user maintained?.
%.1%

newwindow*tutorial.odt + ,ay 10- 2006

In our e/ample- the name 0ield is >=ocuments?- the =6 table name is >= CA,#B51? also- and the entity type is set to >user maintained?. nce you have 0illed up all the details you should store the new table de0inition usin" the save icon 2 4 0rom the toolbar. Bow- press the button >Create columns 0rom =6? to create the entries needed to de0ine the entries in the columns. &hen the creation process is 0inished- you will be in0ormed o0 the number o0 columns that have been added into the application dictionary. In the >column? tab o0 this 0orm you can see all the columns de0ined 0or the table that we are introducin" and customi3e the properties 0or each column.

I0 you want to see a list o0 all the created columns you can clic) the Relation icon 2 4.

newwindow*tutorial.odt + ,ay 10- 2006

6.1%

newwindow*tutorial.odt + ,ay 10- 2006

'.1%

I$.

Creating a new %indow

In order to create a new window you 0irst should lo" into penbravo usin" an account with access to the 1ystem 8dministration role. Eo to the >&indow- 5ab 9ield? option under the >1ystem 8dmin? menu and select the >Bew Record? icon 2 4 0rom the toolbar. 5he 0ollowin" 0orm is displayed@

Dere there is a description o0 the main 0ields o0 the window 0orm de0inition@

Name. =e0ines the name which

penbravo uses to name this window.

escription. Eives a small description to the window. !elp"Comments@ =e0ines the te/t that is displayed in the help &indow.

In our e/ample- the name 0ield is >Aser documents?. nce you have 0illed up all the details you should store the new window de0inition usin" the save icon 2 4 0rom the toolbar. Bow- you can select the >5ab? option- and you "et the 0ollowin" 0orm@

newwindow*tutorial.odt + ,ay 10- 2006

F.1%

Dere there is a description o0 the main 0ields o0 the tab 0orm de0inition@

Name. =e0ines the name which

penbravo uses to name this tab.

escription. Eives a small description to the window. !elp"Comments@ =e0ines the te/t that is displayed in the help &indow. Table. #stablishes a relation between this tab and the database table.

In our e/ample- the name 0ield is >=ocuments? and we select the table name >=ocuments?. nce you have 0illed up all the details you should store the new tab de0inition usin" the save icon 2 4 0rom the toolbar. Bow- press the button >Create 0ields?. &hen the creation process is 0inished- you will be in0ormed o0 the number o0 0ields that have been added into the dictionary. :ou can loo) the 0ields that have been created clic)in" the >9ield? tab.

newwindow*tutorial.odt + ,ay 10- 2006

9.1%

:ou can customi3e the created 0ields usin" the 0ield tab. to customi3e the 0ollowin" 0orm will be displayed@

nce- you select the 0ield

newwindow*tutorial.odt + ,ay 10- 2006

10.1%

Dere there is a description o0 the main 0ields o0 the columns 0orm de0inition@

Name. =e0ines the name which

penbravo uses to name this 0ield.

escription. Eives a small description to the 0ield. !elp"Comments@ =e0ines the te/t that is displayed in the help &indow. Table. #stablishes a relation between this tab and the database table.

9inally- to end the process we have to associate the window that we have created to the table de0inition that we previously did. &e have to "o to the >5able and column? option under the >1ystem 8dmin? menu and select the 5able tab. #dit the >=ocuments? table and associate the window >document? to this table de0inition- as seen in the 0ollowin" screen capture.

newwindow*tutorial.odt + ,ay 10- 2006

11.1%

newwindow*tutorial.odt + ,ay 10- 2006

12.1%

$.

&in'ing a new window to the Openbravo menu

In order to lin) a new window to the penbravo menu you 0irst should lo" into penbravo usin" an account with access to the 1ystem 8dministration role. Eo to the >1ystem Rules? option under the >Eeneral Rules? menu and select the option >,enu?. Bow- select the >Bew Record? icon 2 4 0rom the toolbar. :ou "et the 0ollowin" 0orm@

Dere there is a description o0 the main 0ields o0 the ,enu 0orm de0inition@

Name. =e0ines the name which

penbravo uses to name this menu.

escription. Eives a small description to the menu. (ction. Indicates the action that this menu should e/ecute when selected. %indow")orm"Process"Tas'"Report"%or'#ench"%or'flow. the name o0 the resource associated to the action. Indicates

In our e/ample- the name 0ield is >=ocuments?- the action is >&indow? and the >&indow? 0ield is >Aser documents?. nce you have 0illed up all the details you should store the new menu de0inition

newwindow*tutorial.odt + ,ay 10- 2006

13.1%

usin" the save icon 2 4 0rom the toolbar. Bow- you have to assi"n the new menu entry to the current menu hierarchy. Ase the tree icon 2 4 0rom the toolbar. 5he 0ollowin" 0orm is displayed.

Bow- you have to clic) on the menu entry to which you want to associate the newly created menu entry- while the button on the top is selected. Chec) the lower radio button and clic) on the recently created window icon. 9inally chec) the >Is child? chec) bo/ and clic) on the >8ssi"n? button.

newwindow*tutorial.odt + ,ay 10- 2006

1!.1%

penbravo 1.(. 2006

5his wor) is licensed under the Creative Commons 8ttribution+1hare8li)e 2.% 1pain (icense. 5o view a copy o0 this license- visit http@..creativecommons.or".licenses.by+sa.2.%.es. or send a letter to Creative Commons- %%9 Bathan 8bbott &ay- 1tan0ord- Cali0ornia 9!30%- A18. 8s attribution to the ori"inal author- any redistribution o0 this wor) or any derivative wor) must maintain this copyri"ht notice and- visibly on all its pa"es- the penbravo lo"o. 5he most updated copy o0 this wor) may be obtained at http@..www.openbravo.com.docs.

newwindow*tutorial.odt + ,ay 10- 2006

1%.1%