Odoo Help


Open ERP v7 - How do I execute a wizard via XML RPC?

Sam Davey
on 8/9/13, 1:21 PM 5,826 views

I'm integrating a PHP application with OpenErp and I am able to easily hook up via XMLRPC. Given the GTK client used to operate via XMLRPC (pre v7) its no surprise that i can achieve nearly anything through XMLRPC.

I've got the simple operations sorted; create, search, read etc. I can run any particular method using the execute call and i can trigger workflows using exec_workflow.

The missing part of the jigsaw is wizards. I can see that wizards changed in OpenERP 7.0 from wizards into TransientModels. I can also find info about how the 'wizard' operation in XMLRPC has been deprecated in OpenERP version 7 and I once saw that it is now part of the relevant objects orm although I can't find that article now.

But I can't find any examples or information about how to execute a wizard in OpenERP version 7 via XMLRPC.

The actual wizard I want to run is linked to the button 'Return Products' which is on a Delivery Order once it has been delivered.

How can I mimic the web client User Interface process of pressing the 'Return Products' button and filling in the corresponding form that pops up?

Does anyone have any examples to achieve this? Any programming language will do, I'll port it into PHP myself once I know how it works.

Sam Davey
On 8/15/13, 7:32 PM

I'm not surprised no one has answered this. There is no magic 'run wizard' XMLRPC call. It's a series of calls.

As per the documentation "Everything done in the GTK or web client in OpenERP is through XML/RPC webservices. Start openERP GTK client using ./openerp-client.py -l debug_rpc (or debug_rpc_answer) then do what you want in the GTK client and watch your client logs, you will find out the webservice signatures."

I was thrown by this as I can't use the client with version 7. But of course the web client essentially does exactly the sae thing as the GTK client so I just needed to turn on debugging on the server and watch the logs for the webservice signatures.

So to do this you just add "log_level = debug_rpc_answer" to your server config file (openerp-server.conf in my instance)

Once I'd done that I could see what was going on and replicated it in PHP.

I'm not going to go into detail here. If you need to do the same then you just need to get to 'debug_rpc_answer' and start analysing the webservice signatures.

But for completeness the process looks like this

  • Fill in the context for the call
  • Call default_get to get the data for the wizard
  • Alter the data as needed then call create, this creates an object in memory and returns an identifier for it
  • In my case I then call 'create_returns' which converts the in memory object into the corresponing incoming shipment record

Heres how it looks although I've stripped out some bits

// First build the context of the request, i.e. in my case the Delivery Order I am creating a return for
$activeId = 7;

$args = array(

$context = array(
    "context" => array(
        'active_id'=> $activeId,
        'active_ids'=> array($activeId),
        'active_model'=> 'stock.picking.out',
        contact_display'=> 'partner_address',
        'default_type'=> 'out',
        'lang'=> 'en_GB',
        'search_disable_custom_filters'=> True,
        'tz'=> 'Europe/London',
        'uid'=> 1,

// Call 'default_get' which returns all the data that gets filled in the UI when you click 'Return Products'

$results = $client->call('execute_kw', array($dbName, $user, $pwd, 'stock.return.picking', 'default_get', $args, $context));

$previousMoves = $results['product_return_moves'];

// Do stuff with previousMoves to build the actual productReturnMoves needed
... omitted for brevity ...

$args = array(
            'invoice_state' => 'none',
            'product_return_moves' => $productReturnMoves,

$results = $client->call('execute_kw', array($dbName, $user, $pwd, 'stock.return.picking', 'create', $args, $context));

// An identifier for this 'in memory' (TransientModel) object is returned
$wizardId = $results;

// Call the method that converts the 'in memory' (TransientModel) object into corresponding object
$args = array(

$blank = array();

$results = $client->call('execute_kw', array($dbName, $user, $pwd, 'stock.return.picking', 'create_returns', $args, $blank));

Easy... Or not... depending on how impressed or frustrated you are feeling about OpenERP today :-)

Thanks for sharing your answer :) Wizards are just temporary models to work on other models - so best to look at what the wizard does (eg create a incoming shipping order when you click on "return products"). I usually figure out what the code does and then try and reproduce it with RPC, but checking the rpc log is a good idea!

Timothy Solomon
on 7/22/14, 7:04 AM

Your Answer

Please try to give a substantial answer. If you wanted to comment on the question or answer, just use the commenting tool. Please remember that you can always revise your answers - no need to answer the same question twice. Also, please don't forget to vote - it really helps to select the best questions and answers!

About This Community

This platform is for beginners and experts willing to share their Odoo knowledge. It's not a forum to discuss ideas, but a knowledge base of questions and their answers.


Odoo Training Center

Access to our E-learning platform and experience all Odoo Apps through learning videos, exercises and Quizz.

Test it now

Question tools

0 follower(s)


Asked: 8/9/13, 1:21 PM
Seen: 5826 times
Last updated: 3/16/15, 8:10 AM