Using OpenERP Workbench

The page describes how to use of OpenERP Workbench to help the building the OpenERP application.

OpenERP Workbench is an utility helping developers to test and revise the query for retrieving data from OpenERP server. To access the OpenERP Workbench, go to menu admin/settings/openerp and the expand the Database Workbench field set at the bottom of the page.

There are 5 parameters you will need to supply to retrieve the data as described below:

1. Model Name - the drop-down list with all of the data model available on the OpenERP server. You simply select the model you want to test.
2. Fields - you may enter the list of field names, separated with comma (,) and no quote is required. For example, if you wish to retrieve the field name and amount from the OpenERP server, just enter name, amount here. If no field name is supplied here, all fields in the model will be retrieved. Note that the id is a default field and always included in the result.
3. Filter Options - this is the most complex part of the OpenERP Workbench. It allows you to filter the result with the conditions (or Domain in OpenERP's term). The conditions is an array that will be supplied to the OpenERP internal query builder, therefore, using the same syntax and functions as the PostgreSQL where clause but splitting into tuples. Followings are some examples of the conditions:
   

   array('price', '=', '100);
   array('price', '>=', 100);
   array('id', 'in', array(1, 2, 3, 4, 100));
   array('name', 'ilike', '%openerp%');
   ...
   

4. Offset - offset (starting row) to apply to the query
5. Limit - maximum number of row(s) to be retrieved