[go: up one dir, main page]
Menu ▾ ▴

Home

Pieter van der Merwe billrobo

Welcome to the OpenERP Java Report Helper project.

The software is currently in Beta.

Overview

The aim of this project is to provide a library that can be embedded into Java software to provide OpenERP reporting functionality by reading OpenERP objects through the OpenERP XMLRPC interface.

The library consists of two layers:

  1. User interface layer.
  2. Data extraction layer.

The two layers are loosely coupled. A configuration object, called the OpenERPConfiguration, is used to pass data between the two layers. A user may decide to use the data layer only and build their own user interface or use the one provided with the library.

User Interface

The user interface creates an OpenERPConfiguration object that is passed to the data extraction layer. It is not mandatory to use the user interface provided and a user may decide to build their own user interface to create an OpenERPConfiguration object.

The user interface is developed using Java Swing as a single JPanel that needs to be added to a container.

Data layer

The data layer uses an OpenERPConfiguration object for instructions on what data to collect from an OpenEPRP server. It makes use of the OpenERP Java Api to communicate with the OpenERP server. OpenERPJavaAPI currently makes use of XMLRPC.

Current Functionality

Data can be collected using two methods:

  1. Standard search with filters
  2. Custom function

The standard search functionality makes use of the object search method on OpenERP to retrieve data. Objects can be joined together to provide data from parent or child objects. For example you can select fields from account.invoice and account.invoice.line. The two objects will be joined together and you will get a result row for every invoice line combined with the invoice header details. There is no limit to the number of levels you can join together.

A user can also define filters on any object that forms part of the query to restrict results.

Custom function

Any function can be called on any object behind the OpenERP server as long as the function returns an array of dictionaries. The function must have the signature function_name(self, cr, uid, *param). Parameters as defined in the OpenERPConfiguration are passed from the data layer to the custom function.

Current Use

It is currently being used by a Pentaho Report Designer plugin that is in development.

Getting Started

Have a look at the examples page to get started.

The OpenERP Java Report Helper relies on the OpenERP Java Api. You need to download the api and it's dependencies.

For convenience, all dependencies are included in the examples download.

Source

Source code can be found on GitHub. Please fork the project and make a pull request if you want to contribute to the project.

Project Sponsors

De Bortoli Wines Pty Limited, Australia

Project administrators:

Project Admins: