Projects:POS/Openbravo POS Developer Guide
This guide refers to the Openbravo POS 2.30 version and next versions. This document is oriented to developers and advanced users of Openbravo POS with some development skills that wants to inspect the source code and make modifications.
Obtaining the sources
Since 2.30 we have changed our software version control system from Subversion to Mercurial. It is not possible any more to get the latest sources from Openbravo's servers using Subversion. You should install a Mercurial client to achieve that. However our servers are synchronized with SourceForge's servers all the time so it means you will be able to obtain sources from SourceFogre in the old way
Sources from Openbravo using Mercurial
To obtain the sources a Mercurial client is required. You can read the Mercurial manual prepared for Openbravo's developers. You only need to read the section to obtain the latest sources and updating.
To obtain(checkout in svn) a clone of the repository you should type the following commands:
To check if there are any updates type the following:
If there are any changes you can update your clone typing:
One of advantages using Mercurial than Subversion is availability to review locally the logs of any changes:
Obtaining the sources of the stable version
To download the sources of the latest stable version or a previous version go to the download page and get the sources http://sourceforge.net/project/showfiles.php?group_id=127939. Once downloaded uncompress it to the desired folder.
Build from the sources
To build the Openbravo POS sources you need ant. Ant is a build tool used by Openbravo POS to compile and package the distribution files from the sources.
The binary and source packages can both be obtained executing the following instruction from the folder you downloaded or checked out the sources:
There are other ant targets if you only need one specific package:
To obtain the package openbravopos.jar execute the following instruction:
To obtain the binary distribution package execute:
To obtain the sources distribution package execute:
Notes: All the packages created by the build process are located in the subfolder build/dist.
Build installers from sources
To build installers of Openbravo POS follow the tutorial.
Edit the sources using the Netbeans IDE
Netbeans is the preferred java IDE to develop Openbravo POS because the Swing components of Openbravo POS have been developed with the visual editor of Netbeans, and in this edition is stored in *.form files that only Netbeans is able to interpret.
You can download Netbeans from http://www.netbeans.org. And there is a quick guide to develop with Netbeans here http://www.netbeans.org/kb/60/java/quickstart.html.
To create a new Netbeans project with the Openbravo sources, open Netbeans and select New project... to open the new project wizard, select Java Project with Existing Sources and press Next.
In the following step select the project name and the folder where the Netbeans project files will be stored and press Next. Do not select the same folder you downloaded or checked out the sources.
In the following step select the source folders. Add the folders locales, reports, src-beans, src-data, src-erp, and src-pos. In this step you can press Finish.
The next step is to add the libraries needed to build and execute Openbravo POS. Open the Properties... dialog of the project and in the libraries section add all the *.jar files of the folder lib.
Now you have ready a Netbeans project configured than you can edit, build and test. To execute and debug Openbravo POS you need also to select the main class of the project. Open the Properties... dialog and in the run section Openbravo select com.openbravo.pos.forms.StartPOS as the Main Class and press OK.
Edit the sources using the Eclipse IDE
If your favorite java IDE is Eclipse you can use it to develop Openbravo POS. You will only miss the visual edition of the swing components created with Netbeans. In this case you must take into account that if you modify the java code generated by Netbeans, then the Netbeans user will not have in sync your modifications and may overwrite it the next time.
The Eclipse project files are included in the source packages. To create new Eclipse project is very easy, open Eclipse and select Import... to open the import project wizard, select Existing projects into workspace and press Next.
In the following step select the root folder of the Openbravo POS sources and press Finish.
Now you have ready your Eclipse project. To execute it, select the project run it as a Java application and select the com.openbravo.pos.forms.StartPOS as the main class.
Edit the PDA module sources using the Netbeans IDE
You can download Netbeans from http://www.netbeans.org. To work with PDA module Netbeans must be fitted with JEE.
To create a new Netbeans project with the Openbravo sources, open Netbeans and select New project... to open the new project wizard, select Web Application with Existing Sources and press Next.
In the following step select the src-pda folder that has been downloaded within the trunk. Then set a name and the folder where the Netbeans project files will be stored and press Next. Do not select the same folder you downloaded or checked out the sources.
In the following step select server that will manage our application. Select Java EE 5 and choose a context path i.e.pda that will be used to call the application within an url. Then you can press Next.
The next step is about sources. Web Pages Folder is a folder where all web pages are stored it can be find with the rest of the sources in the trunk. WEB-INF Content contains files to make the pda module working on the server. In Libraries Folder are all needed libraries to build and execute Openbravo POS PDA module. At the end the source package must be added as it is shown on a picture. Then Finish button should be pressed to finish building a new project with existing sources.
The last thing needed to run the project is a database driver library. The same connector as in Openbravo POS must be added to the PDA module. In this case this is mysql-connector-java-5.1.5.jar
To add the connector go into Properties of the pda project and then to Libraries and add the jar file. After finding the connector Ok can be pressed and the project is ready to edit, build and test.