Define your model

You have to define a class inheriting from queue.job.

class MyModuleJob(models.Model):
   _name = 'my_module.job'
   _inherit = 'queue.job'

   method = fields.Selection([
      ('foo', 'Method doing foo'),
      ('bar', 'Method doing bar')
   ])

   def foo(self):
      """Execute the job `foo`.
      This could be a button method, a cron method, etc.
      """
      pass

   def bar(self):
      """Execute the job `bar`.
      This could be a button method, a cron method, etc.
      """
      pass

Execution of queue

You have to define a cron to check queue periodically, eg. each 5 minutes:

<record id="some_external_api_queue" model="ir.model.export.template">
   <field name="name">Some external API</field>
   <field name="model_id" ref="my_module.model_my_module_job" />
   <field name="method">execute_call</field>
   <field name="filter_type">method</field>
   <field name="filter_method">filter_jobs</field>
   <field name="unique" eval="False" />
   <field name="new_thread" eval="False" />
   <field name="one_at_a_time" eval="True" />
</record>

<record id="ir_cron_some_external_api_queue" model="ir.cron">
   <field name="name">Some external API - Manage queue</field>
   <field name="user_id" ref="base.user_root" />
   <field name="interval_number">5</field>
   <field name="interval_type">minutes</field>
   <field name="numbercall">-1</field>
   <field name="priority">10</field>
   <field name="nextcall" eval="time.strftime('%Y-%m-%d %H:00:00')" />
   <field name="model_id" ref="my_module.model_my_module_job" />
   <field name="code">model.execute_cron()</field>
   <field name="state">code</field>
</record>

<record id="some_external_api_queue" model="ir.model.export.template">
   <field name="cron_id" ref="ir_cron_some_external_api_queue" />
</record>

Consult jobs enqueued

You have to define views and actions to see your jobs.

Following code displays pending and error jobs by default:

<record id="view_job_form" model="ir.ui.view">
   <field name="name">my_module.job.form</field>
   <field name="model">my_module.job</field>
   <field name="arch" type="xml">
      <form>
         <header>
            <field name="state" widget="statusbar"/>
         </header>
         <sheet>
            <group col="1">
               <field name="method"/>
            </group>
            <group col="6">
               <field name="max_tries"/>
               <field name="tries"/>
               <field name="total_tries"/>
            </group>
            <group>
               <field name="status_code"/>
               <field name="result"/>
            </group>
         </sheet>
      </form>
   </field>
</record>

<record id="view_job_tree" model="ir.ui.view">
   <field name="name">my_module.job.tree</field>
   <field name="model">my_module.job</field>
   <field name="arch" type="xml">
      <tree string="Jobs" decoration-danger="state=='error'"
            decoration-success="state=='done'"
            decoration-muted="state=='canceled'">
         <field name="method" />
         <field name="state" />
         <field name="status_code" />
         <field name="create_date" />
         <field name="execute_date" />
         <field name="total_tries" />
      </tree>
   </field>
</record>

<record id="view_job_search" model="ir.ui.view">
   <field name="name">my_module.job.search</field>
   <field name="model">my_module.job</field>
   <field name="arch" type="xml">
      <search>
         <field name="method" />
         <filter name="filter_canceled" string="Canceled"
            domain="[('state', '=', 'canceled')]" />
         <filter name="filter_done" string="Done"
            domain="[('state', '=', 'done')]" />
         <filter name="filter_error" string="Error"
            domain="[('state', '=', 'error')]" />
         <filter name="filter_pending" string="Pending"
            domain="[('state', '=', 'pending')]" />
         <filter name="groupby_state" string="State"
            context="{'group_by': 'state'}" />
         <filter name="groupby_status_code" string="Status code"
            context="{'group_by': 'status_code'}" />
      </search>
   </field>
</record>

<record id="action_jobs_view" model="ir.actions.act_window">
   <field name="name">Some external API</field>
   <field name="type">ir.actions.act_window</field>
   <field name="res_model">my_mobule.job</field>
   <field name="view_mode">tree,form</field>
   <field name="context">{
      'search_default_filter_pending': 1,
      'search_default_filter_error': 1
   }</field>
</record>

<menuitem id="menu_wsqueue_jobs_some_external_api"
   action="action_jobs_view" parent="smile_wsqueue.menu_wsqueue_jobs" />

Authors

• Smile SA

Contributors

• Paul JOANNON
• Isabelle RICHARD

Maintainers

This module is maintained by the Smile SA.

Since 1991 Smile has been a pioneer of technology and also the European expert in open source solutions.

This module is part of the odoo-addons project on GitHub.

You are welcome to contribute.